-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
env.ml
1587 lines (1391 loc) · 50.5 KB
/
env.ml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
(***********************************************************************)
(* *)
(* OCaml *)
(* *)
(* Xavier Leroy, projet Cristal, INRIA Rocquencourt *)
(* *)
(* Copyright 1996 Institut National de Recherche en Informatique et *)
(* en Automatique. All rights reserved. This file is distributed *)
(* under the terms of the Q Public License version 1.0. *)
(* *)
(***********************************************************************)
(* Environment handling *)
open Cmi_format
open Config
open Misc
open Asttypes
open Longident
open Path
open Types
open Btype
let add_delayed_check_forward = ref (fun _ -> assert false)
let value_declarations : ((string * Location.t), (unit -> unit)) Hashtbl.t =
Hashtbl.create 16
(* This table is used to usage of value declarations. A declaration is
identified with its name and location. The callback attached to a
declaration is called whenever the value is used explicitly
(lookup_value) or implicitly (inclusion test between signatures,
cf Includemod.value_descriptions). *)
let type_declarations = Hashtbl.create 16
type constructor_usage = Positive | Pattern | Privatize
type constructor_usages =
{
mutable cu_positive: bool;
mutable cu_pattern: bool;
mutable cu_privatize: bool;
}
let add_constructor_usage cu = function
| Positive -> cu.cu_positive <- true
| Pattern -> cu.cu_pattern <- true
| Privatize -> cu.cu_privatize <- true
let constructor_usages () =
{cu_positive = false; cu_pattern = false; cu_privatize = false}
let used_constructors :
(string * Location.t * string, (constructor_usage -> unit)) Hashtbl.t
= Hashtbl.create 16
let prefixed_sg = Hashtbl.create 113
type error =
| Illegal_renaming of string * string * string
| Inconsistent_import of string * string * string
| Need_recursive_types of string * string
exception Error of error
module EnvLazy : sig
type ('a,'b) t
val force : ('a -> 'b) -> ('a,'b) t -> 'b
val create : 'a -> ('a,'b) t
val is_val : ('a,'b) t -> bool
end = struct
type ('a,'b) t = ('a,'b) eval ref
and ('a,'b) eval =
Done of 'b
| Raise of exn
| Thunk of 'a
let force f x =
match !x with
Done x -> x
| Raise e -> raise e
| Thunk e ->
try
let y = f e in
x := Done y;
y
with e ->
x := Raise e;
raise e
let is_val x =
match !x with Done _ -> true | _ -> false
let create x =
let x = ref (Thunk x) in
x
end
type summary =
Env_empty
| Env_value of summary * Ident.t * value_description
| Env_type of summary * Ident.t * type_declaration
| Env_exception of summary * Ident.t * exception_declaration
| Env_module of summary * Ident.t * module_type
| Env_modtype of summary * Ident.t * modtype_declaration
| Env_class of summary * Ident.t * class_declaration
| Env_cltype of summary * Ident.t * class_type_declaration
| Env_open of summary * Path.t
module EnvTbl =
struct
(* A table indexed by identifier, with an extra slot to record usage. *)
type 'a t = ('a * (unit -> unit)) Ident.tbl
let empty = Ident.empty
let nothing = fun () -> ()
let already_defined s tbl =
try ignore (Ident.find_name s tbl); true
with Not_found -> false
let add kind slot id x tbl =
let slot =
match slot with
| None -> nothing
| Some f ->
(fun () ->
let s = Ident.name id in
f kind s (already_defined s tbl)
)
in
Ident.add id (x, slot) tbl
let add_dont_track id x tbl =
Ident.add id (x, nothing) tbl
let find_same_not_using id tbl =
fst (Ident.find_same id tbl)
let find_same id tbl =
let (x, slot) = Ident.find_same id tbl in
slot ();
x
let find_name s tbl =
let (x, slot) = Ident.find_name s tbl in
slot ();
x
let find_all s tbl =
Ident.find_all s tbl
let fold_name f = Ident.fold_name (fun k (d,_) -> f k d)
let keys tbl = Ident.fold_all (fun k _ accu -> k::accu) tbl []
end
type type_descriptions =
constructor_description list * label_description list
type t = {
values: (Path.t * value_description) EnvTbl.t;
constrs: constructor_description EnvTbl.t;
labels: label_description EnvTbl.t;
types: (Path.t * (type_declaration * type_descriptions)) EnvTbl.t;
modules: (Path.t * module_type) EnvTbl.t;
modtypes: (Path.t * modtype_declaration) EnvTbl.t;
components: (Path.t * module_components) EnvTbl.t;
classes: (Path.t * class_declaration) EnvTbl.t;
cltypes: (Path.t * class_type_declaration) EnvTbl.t;
summary: summary;
local_constraints: bool;
gadt_instances: (int * TypeSet.t ref) list;
in_signature: bool;
}
and module_components =
(t * Subst.t * Path.t * Types.module_type, module_components_repr) EnvLazy.t
and module_components_repr =
Structure_comps of structure_components
| Functor_comps of functor_components
and structure_components = {
mutable comp_values: (string, (value_description * int)) Tbl.t;
mutable comp_constrs: (string, (constructor_description * int) list) Tbl.t;
mutable comp_labels: (string, (label_description * int) list) Tbl.t;
mutable comp_types:
(string, ((type_declaration * type_descriptions) * int)) Tbl.t;
mutable comp_modules:
(string, ((Subst.t * Types.module_type,module_type) EnvLazy.t * int)) Tbl.t;
mutable comp_modtypes: (string, (modtype_declaration * int)) Tbl.t;
mutable comp_components: (string, (module_components * int)) Tbl.t;
mutable comp_classes: (string, (class_declaration * int)) Tbl.t;
mutable comp_cltypes: (string, (class_type_declaration * int)) Tbl.t
}
and functor_components = {
fcomp_param: Ident.t; (* Formal parameter *)
fcomp_arg: module_type; (* Argument signature *)
fcomp_res: module_type; (* Result signature *)
fcomp_env: t; (* Environment in which the result signature makes sense *)
fcomp_subst: Subst.t; (* Prefixing substitution for the result signature *)
fcomp_cache: (Path.t, module_components) Hashtbl.t (* For memoization *)
}
let subst_modtype_maker (subst, mty) = Subst.modtype subst mty
let empty = {
values = EnvTbl.empty; constrs = EnvTbl.empty;
labels = EnvTbl.empty; types = EnvTbl.empty;
modules = EnvTbl.empty; modtypes = EnvTbl.empty;
components = EnvTbl.empty; classes = EnvTbl.empty;
cltypes = EnvTbl.empty;
summary = Env_empty; local_constraints = false; gadt_instances = [];
in_signature = false;
}
let in_signature env = {env with in_signature = true}
let diff_keys is_local tbl1 tbl2 =
let keys2 = EnvTbl.keys tbl2 in
List.filter
(fun id ->
is_local (EnvTbl.find_same_not_using id tbl2) &&
try ignore (EnvTbl.find_same_not_using id tbl1); false
with Not_found -> true)
keys2
let is_ident = function
Pident _ -> true
| Pdot _ | Papply _ -> false
let is_local (p, _) = is_ident p
let is_local_exn = function
| {cstr_tag = Cstr_exception (p, _)} -> is_ident p
| _ -> false
let diff env1 env2 =
diff_keys is_local env1.values env2.values @
diff_keys is_local_exn env1.constrs env2.constrs @
diff_keys is_local env1.modules env2.modules @
diff_keys is_local env1.classes env2.classes
(* Forward declarations *)
let components_of_module' =
ref ((fun env sub path mty -> assert false) :
t -> Subst.t -> Path.t -> module_type -> module_components)
let components_of_module_maker' =
ref ((fun (env, sub, path, mty) -> assert false) :
t * Subst.t * Path.t * module_type -> module_components_repr)
let components_of_functor_appl' =
ref ((fun f p1 p2 -> assert false) :
functor_components -> Path.t -> Path.t -> module_components)
let check_modtype_inclusion =
(* to be filled with Includemod.check_modtype_inclusion *)
ref ((fun env mty1 path1 mty2 -> assert false) :
t -> module_type -> Path.t -> module_type -> unit)
(* The name of the compilation unit currently compiled.
"" if outside a compilation unit. *)
let current_unit = ref ""
(* Persistent structure descriptions *)
type pers_struct =
{ ps_name: string;
ps_sig: signature;
ps_comps: module_components;
ps_crcs: (string * Digest.t) list;
ps_filename: string;
ps_flags: pers_flags list }
let persistent_structures =
(Hashtbl.create 17 : (string, pers_struct option) Hashtbl.t)
(* Consistency between persistent structures *)
let crc_units = Consistbl.create()
let check_consistency filename crcs =
try
List.iter
(fun (name, crc) -> Consistbl.check crc_units name crc filename)
crcs
with Consistbl.Inconsistency(name, source, auth) ->
raise(Error(Inconsistent_import(name, auth, source)))
(* Reading persistent structures from .cmi files *)
let read_pers_struct modname filename = (
let cmi = read_cmi filename in
let name = cmi.cmi_name in
let sign = cmi.cmi_sign in
let crcs = cmi.cmi_crcs in
let flags = cmi.cmi_flags in
let comps =
!components_of_module' empty Subst.identity
(Pident(Ident.create_persistent name))
(Mty_signature sign) in
let ps = { ps_name = name;
ps_sig = sign;
ps_comps = comps;
ps_crcs = crcs;
ps_filename = filename;
ps_flags = flags } in
if ps.ps_name <> modname then
raise(Error(Illegal_renaming(modname, ps.ps_name, filename)));
check_consistency filename ps.ps_crcs;
List.iter
(function Rectypes ->
if not !Clflags.recursive_types then
raise(Error(Need_recursive_types(ps.ps_name, !current_unit))))
ps.ps_flags;
Hashtbl.add persistent_structures modname (Some ps);
ps
)
let find_pers_struct name =
if name = "*predef*" then raise Not_found;
let r =
try Some (Hashtbl.find persistent_structures name)
with Not_found -> None
in
match r with
| Some None -> raise Not_found
| Some (Some sg) -> sg
| None ->
let filename =
try find_in_path_uncap !load_path (name ^ ".cmi")
with Not_found ->
Hashtbl.add persistent_structures name None;
raise Not_found
in
read_pers_struct name filename
let reset_cache () =
current_unit := "";
Hashtbl.clear persistent_structures;
Consistbl.clear crc_units;
Hashtbl.clear value_declarations;
Hashtbl.clear type_declarations;
Hashtbl.clear used_constructors;
Hashtbl.clear prefixed_sg
let reset_cache_toplevel () =
(* Delete 'missing cmi' entries from the cache. *)
let l =
Hashtbl.fold
(fun name r acc -> if r = None then name :: acc else acc)
persistent_structures []
in
List.iter (Hashtbl.remove persistent_structures) l;
Hashtbl.clear value_declarations;
Hashtbl.clear type_declarations;
Hashtbl.clear used_constructors;
Hashtbl.clear prefixed_sg
let set_unit_name name =
current_unit := name
(* Lookup by identifier *)
let rec find_module_descr path env =
match path with
Pident id ->
begin try
let (p, desc) = EnvTbl.find_same id env.components
in desc
with Not_found ->
if Ident.persistent id
then (find_pers_struct (Ident.name id)).ps_comps
else raise Not_found
end
| Pdot(p, s, pos) ->
begin match
EnvLazy.force !components_of_module_maker' (find_module_descr p env)
with
Structure_comps c ->
let (descr, pos) = Tbl.find s c.comp_components in
descr
| Functor_comps f ->
raise Not_found
end
| Papply(p1, p2) ->
begin match
EnvLazy.force !components_of_module_maker' (find_module_descr p1 env)
with
Functor_comps f ->
!components_of_functor_appl' f p1 p2
| Structure_comps c ->
raise Not_found
end
let find proj1 proj2 path env =
match path with
Pident id ->
let (p, data) = EnvTbl.find_same id (proj1 env)
in data
| Pdot(p, s, pos) ->
begin match
EnvLazy.force !components_of_module_maker' (find_module_descr p env)
with
Structure_comps c ->
let (data, pos) = Tbl.find s (proj2 c) in data
| Functor_comps f ->
raise Not_found
end
| Papply(p1, p2) ->
raise Not_found
let find_value =
find (fun env -> env.values) (fun sc -> sc.comp_values)
and find_type_full =
find (fun env -> env.types) (fun sc -> sc.comp_types)
and find_modtype =
find (fun env -> env.modtypes) (fun sc -> sc.comp_modtypes)
and find_class =
find (fun env -> env.classes) (fun sc -> sc.comp_classes)
and find_cltype =
find (fun env -> env.cltypes) (fun sc -> sc.comp_cltypes)
let find_type p env =
fst (find_type_full p env)
let find_type_descrs p env =
snd (find_type_full p env)
(* Find the manifest type associated to a type when appropriate:
- the type should be public or should have a private row,
- the type should have an associated manifest type. *)
let find_type_expansion ?level path env =
let decl = find_type path env in
match decl.type_manifest with
| Some body when decl.type_private = Public
|| decl.type_kind <> Type_abstract
|| Btype.has_constr_row body ->
(decl.type_params, body, may_map snd decl.type_newtype_level)
(* The manifest type of Private abstract data types without
private row are still considered unknown to the type system.
Hence, this case is caught by the following clause that also handles
purely abstract data types without manifest type definition. *)
| _ -> raise Not_found
(* Find the manifest type information associated to a type, i.e.
the necessary information for the compiler's type-based optimisations.
In particular, the manifest type associated to a private abstract type
is revealed for the sake of compiler's type-based optimisations. *)
let find_type_expansion_opt path env =
let decl = find_type path env in
match decl.type_manifest with
(* The manifest type of Private abstract data types can still get
an approximation using their manifest type. *)
| Some body -> (decl.type_params, body, may_map snd decl.type_newtype_level)
| _ -> raise Not_found
let find_modtype_expansion path env =
match find_modtype path env with
Modtype_abstract -> raise Not_found
| Modtype_manifest mty -> mty
let find_module path env =
match path with
Pident id ->
begin try
let (p, data) = EnvTbl.find_same id env.modules
in data
with Not_found ->
if Ident.persistent id then
let ps = find_pers_struct (Ident.name id) in
Mty_signature(ps.ps_sig)
else raise Not_found
end
| Pdot(p, s, pos) ->
begin match
EnvLazy.force !components_of_module_maker' (find_module_descr p env)
with
Structure_comps c ->
let (data, pos) = Tbl.find s c.comp_modules in
EnvLazy.force subst_modtype_maker data
| Functor_comps f ->
raise Not_found
end
| Papply(p1, p2) ->
raise Not_found (* not right *)
(* Lookup by name *)
exception Recmodule
let rec lookup_module_descr lid env =
match lid with
Lident s ->
begin try
EnvTbl.find_name s env.components
with Not_found ->
if s = !current_unit then raise Not_found;
let ps = find_pers_struct s in
(Pident(Ident.create_persistent s), ps.ps_comps)
end
| Ldot(l, s) ->
let (p, descr) = lookup_module_descr l env in
begin match EnvLazy.force !components_of_module_maker' descr with
Structure_comps c ->
let (descr, pos) = Tbl.find s c.comp_components in
(Pdot(p, s, pos), descr)
| Functor_comps f ->
raise Not_found
end
| Lapply(l1, l2) ->
let (p1, desc1) = lookup_module_descr l1 env in
let (p2, mty2) = lookup_module l2 env in
begin match EnvLazy.force !components_of_module_maker' desc1 with
Functor_comps f ->
!check_modtype_inclusion env mty2 p2 f.fcomp_arg;
(Papply(p1, p2), !components_of_functor_appl' f p1 p2)
| Structure_comps c ->
raise Not_found
end
and lookup_module lid env =
match lid with
Lident s ->
begin try
let (_, ty) as r = EnvTbl.find_name s env.modules in
begin match ty with
| Mty_ident (Path.Pident id) when Ident.name id = "#recmod#" ->
(* see #5965 *)
raise Recmodule
| _ -> ()
end;
r
with Not_found ->
if s = !current_unit then raise Not_found;
let ps = find_pers_struct s in
(Pident(Ident.create_persistent s), Mty_signature ps.ps_sig)
end
| Ldot(l, s) ->
let (p, descr) = lookup_module_descr l env in
begin match EnvLazy.force !components_of_module_maker' descr with
Structure_comps c ->
let (data, pos) = Tbl.find s c.comp_modules in
(Pdot(p, s, pos), EnvLazy.force subst_modtype_maker data)
| Functor_comps f ->
raise Not_found
end
| Lapply(l1, l2) ->
let (p1, desc1) = lookup_module_descr l1 env in
let (p2, mty2) = lookup_module l2 env in
let p = Papply(p1, p2) in
begin match EnvLazy.force !components_of_module_maker' desc1 with
Functor_comps f ->
!check_modtype_inclusion env mty2 p2 f.fcomp_arg;
(p, Subst.modtype (Subst.add_module f.fcomp_param p2 f.fcomp_subst)
f.fcomp_res)
| Structure_comps c ->
raise Not_found
end
let lookup proj1 proj2 lid env =
match lid with
Lident s ->
EnvTbl.find_name s (proj1 env)
| Ldot(l, s) ->
let (p, desc) = lookup_module_descr l env in
begin match EnvLazy.force !components_of_module_maker' desc with
Structure_comps c ->
let (data, pos) = Tbl.find s (proj2 c) in
(Pdot(p, s, pos), data)
| Functor_comps f ->
raise Not_found
end
| Lapply(l1, l2) ->
raise Not_found
let lookup_simple proj1 proj2 lid env =
match lid with
Lident s ->
EnvTbl.find_name s (proj1 env)
| Ldot(l, s) ->
let (p, desc) = lookup_module_descr l env in
begin match EnvLazy.force !components_of_module_maker' desc with
Structure_comps c ->
let (data, pos) = Tbl.find s (proj2 c) in
data
| Functor_comps f ->
raise Not_found
end
| Lapply(l1, l2) ->
raise Not_found
let lookup_all_simple proj1 proj2 shadow lid env =
match lid with
Lident s ->
let xl = EnvTbl.find_all s (proj1 env) in
let rec do_shadow =
function
| [] -> []
| ((x, f) :: xs) ->
(x, f) ::
(do_shadow (List.filter (fun (y, g) -> not (shadow x y)) xs))
in
do_shadow xl
| Ldot(l, s) ->
let (p, desc) = lookup_module_descr l env in
begin match EnvLazy.force !components_of_module_maker' desc with
Structure_comps c ->
let comps =
try Tbl.find s (proj2 c) with Not_found -> []
in
List.map
(fun (data, pos) -> (data, (fun () -> ())))
comps
| Functor_comps f ->
raise Not_found
end
| Lapply(l1, l2) ->
raise Not_found
let has_local_constraints env = env.local_constraints
let cstr_shadow cstr1 cstr2 =
match cstr1.cstr_tag, cstr2.cstr_tag with
Cstr_exception _, Cstr_exception _ -> true
| _ -> false
let lbl_shadow lbl1 lbl2 = false
let lookup_value =
lookup (fun env -> env.values) (fun sc -> sc.comp_values)
and lookup_all_constructors =
lookup_all_simple (fun env -> env.constrs) (fun sc -> sc.comp_constrs)
cstr_shadow
and lookup_all_labels =
lookup_all_simple (fun env -> env.labels) (fun sc -> sc.comp_labels)
lbl_shadow
and lookup_type =
lookup (fun env -> env.types) (fun sc -> sc.comp_types)
and lookup_modtype =
lookup (fun env -> env.modtypes) (fun sc -> sc.comp_modtypes)
and lookup_class =
lookup (fun env -> env.classes) (fun sc -> sc.comp_classes)
and lookup_cltype =
lookup (fun env -> env.cltypes) (fun sc -> sc.comp_cltypes)
let mark_value_used name vd =
try Hashtbl.find value_declarations (name, vd.val_loc) ()
with Not_found -> ()
let mark_type_used name vd =
try Hashtbl.find type_declarations (name, vd.type_loc) ()
with Not_found -> ()
let mark_constructor_used usage name vd constr =
try Hashtbl.find used_constructors (name, vd.type_loc, constr) usage
with Not_found -> ()
let mark_exception_used usage ed constr =
try Hashtbl.find used_constructors ("exn", ed.exn_loc, constr) usage
with Not_found -> ()
let set_value_used_callback name vd callback =
let key = (name, vd.val_loc) in
try
let old = Hashtbl.find value_declarations key in
Hashtbl.replace value_declarations key (fun () -> old (); callback ())
(* this is to support cases like:
let x = let x = 1 in x in x
where the two declarations have the same location
(e.g. resulting from Camlp4 expansion of grammar entries) *)
with Not_found ->
Hashtbl.add value_declarations key callback
let set_type_used_callback name td callback =
let loc = td.type_loc in
if loc.Location.loc_ghost then ()
else let key = (name, loc) in
let old =
try Hashtbl.find type_declarations key
with Not_found -> assert false
in
Hashtbl.replace type_declarations key (fun () -> callback old)
let lookup_value lid env =
let (_, desc) as r = lookup_value lid env in
mark_value_used (Longident.last lid) desc;
r
let lookup_type lid env =
let (path, (decl, _)) = lookup_type lid env in
mark_type_used (Longident.last lid) decl;
(path, decl)
(* [path] must be the path to a type, not to a module ! *)
let path_subst_last path id =
match path with
Pident _ -> Pident id
| Pdot (p, name, pos) -> Pdot(p, Ident.name id, pos)
| Papply (p1, p2) -> assert false
let mark_type_path env path =
try
let decl = find_type path env in
mark_type_used (Path.last path) decl
with Not_found -> ()
let ty_path t =
match repr t with
| {desc=Tconstr(path, _, _)} -> path
| _ -> assert false
let lookup_constructor lid env =
match lookup_all_constructors lid env with
[] -> raise Not_found
| (desc, use) :: _ ->
mark_type_path env (ty_path desc.cstr_res);
use ();
desc
let is_lident = function
Lident _ -> true
| _ -> false
let lookup_all_constructors lid env =
try
let cstrs = lookup_all_constructors lid env in
let wrap_use desc use () =
mark_type_path env (ty_path desc.cstr_res);
use ()
in
List.map (fun (cstr, use) -> (cstr, wrap_use cstr use)) cstrs
with
Not_found when is_lident lid -> []
let mark_constructor usage env name desc =
match desc.cstr_tag with
| Cstr_exception (_, loc) ->
begin
try Hashtbl.find used_constructors ("exn", loc, name) usage
with Not_found -> ()
end
| _ ->
let ty_path = ty_path desc.cstr_res in
let ty_decl = try find_type ty_path env with Not_found -> assert false in
let ty_name = Path.last ty_path in
mark_constructor_used usage ty_name ty_decl name
let lookup_label lid env =
match lookup_all_labels lid env with
[] -> raise Not_found
| (desc, use) :: _ ->
mark_type_path env (ty_path desc.lbl_res);
use ();
desc
let lookup_all_labels lid env =
try
let lbls = lookup_all_labels lid env in
let wrap_use desc use () =
mark_type_path env (ty_path desc.lbl_res);
use ()
in
List.map (fun (lbl, use) -> (lbl, wrap_use lbl use)) lbls
with
Not_found when is_lident lid -> []
let lookup_class lid env =
let (_, desc) as r = lookup_class lid env in
(* special support for Typeclass.unbound_class *)
if Path.name desc.cty_path = "" then ignore (lookup_type lid env)
else mark_type_path env desc.cty_path;
r
let lookup_cltype lid env =
let (_, desc) as r = lookup_cltype lid env in
if Path.name desc.clty_path = "" then ignore (lookup_type lid env)
else mark_type_path env desc.clty_path;
mark_type_path env desc.clty_path;
r
(* Iter on an environment (ignoring the body of functors and
not yet evaluated structures) *)
let iter_env proj1 proj2 f env =
Ident.iter (fun id (x,_) -> f (Pident id) x) (proj1 env);
let rec iter_components path path' mcomps =
(* if EnvLazy.is_val mcomps then *)
match EnvLazy.force !components_of_module_maker' mcomps with
Structure_comps comps ->
Tbl.iter
(fun s (d, n) -> f (Pdot (path, s, n)) (Pdot (path', s, n), d))
(proj2 comps);
Tbl.iter
(fun s (c, n) ->
iter_components (Pdot (path, s, n)) (Pdot (path', s, n)) c)
comps.comp_components
| Functor_comps _ -> ()
in
Hashtbl.iter
(fun s pso ->
match pso with None -> ()
| Some ps ->
let id = Pident (Ident.create_persistent s) in
iter_components id id ps.ps_comps)
persistent_structures;
Ident.iter
(fun id ((path, comps), _) -> iter_components (Pident id) path comps)
env.components
let iter_types f = iter_env (fun env -> env.types) (fun sc -> sc.comp_types) f
let same_types env1 env2 =
env1.types == env2.types && env1.components == env2.components
let used_persistent () =
let r = ref Concr.empty in
Hashtbl.iter (fun s pso -> if pso != None then r := Concr.add s !r)
persistent_structures;
!r
let find_all_comps proj s (p,mcomps) =
match EnvLazy.force !components_of_module_maker' mcomps with
Functor_comps _ -> []
| Structure_comps comps ->
try let (c,n) = Tbl.find s (proj comps) in [Pdot(p,s,n), c]
with Not_found -> []
let rec find_shadowed_comps path env =
match path with
Pident id ->
List.map fst (Ident.find_all (Ident.name id) env.components)
| Pdot (p, s, _) ->
let l = find_shadowed_comps p env in
let l' =
List.map (find_all_comps (fun comps -> comps.comp_components) s) l in
List.flatten l'
| Papply _ -> []
let find_shadowed proj1 proj2 path env =
match path with
Pident id ->
List.map fst (Ident.find_all (Ident.name id) (proj1 env))
| Pdot (p, s, _) ->
let l = find_shadowed_comps p env in
let l' = List.map (find_all_comps proj2 s) l in
List.flatten l'
| Papply _ -> []
let find_shadowed_types path env =
let l =
find_shadowed
(fun env -> env.types) (fun comps -> comps.comp_types) path env
in
List.map fst l
(* GADT instance tracking *)
let add_gadt_instance_level lv env =
{env with
gadt_instances = (lv, ref TypeSet.empty) :: env.gadt_instances}
let is_Tlink = function {desc = Tlink _} -> true | _ -> false
let gadt_instance_level env t =
let rec find_instance = function
[] -> None
| (lv, r) :: rem ->
if TypeSet.exists is_Tlink !r then
(* Should we use set_typeset ? *)
r := TypeSet.fold (fun ty -> TypeSet.add (repr ty)) !r TypeSet.empty;
if TypeSet.mem t !r then Some lv else find_instance rem
in find_instance env.gadt_instances
let add_gadt_instances env lv tl =
let r =
try List.assoc lv env.gadt_instances with Not_found -> assert false in
(* Format.eprintf "Added";
List.iter (fun ty -> Format.eprintf "@ %a" !Btype.print_raw ty) tl;
Format.eprintf "@."; *)
set_typeset r (List.fold_right TypeSet.add tl !r)
(* Only use this after expand_head! *)
let add_gadt_instance_chain env lv t =
let r =
try List.assoc lv env.gadt_instances with Not_found -> assert false in
let rec add_instance t =
let t = repr t in
if not (TypeSet.mem t !r) then begin
(* Format.eprintf "@ %a" !Btype.print_raw t; *)
set_typeset r (TypeSet.add t !r);
match t.desc with
Tconstr (p, _, memo) ->
may add_instance (find_expans Private p !memo)
| _ -> ()
end
in
(* Format.eprintf "Added chain"; *)
add_instance t
(* Format.eprintf "@." *)
(* Expand manifest module type names at the top of the given module type *)
let rec scrape_modtype mty env =
match mty with
Mty_ident path ->
begin try
scrape_modtype (find_modtype_expansion path env) env
with Not_found ->
mty
end
| _ -> mty
(* Compute constructor descriptions *)
let constructors_of_type ty_path decl =
let handle_variants cstrs =
Datarepr.constructor_descrs
(newgenty (Tconstr(ty_path, decl.type_params, ref Mnil)))
cstrs decl.type_private
in
match decl.type_kind with
| Type_variant cstrs -> handle_variants cstrs
| Type_record _ | Type_abstract -> []
(* Compute label descriptions *)
let labels_of_type ty_path decl =
match decl.type_kind with
Type_record(labels, rep) ->
Datarepr.label_descrs
(newgenty (Tconstr(ty_path, decl.type_params, ref Mnil)))
labels rep decl.type_private
| Type_variant _ | Type_abstract -> []
(* Given a signature and a root path, prefix all idents in the signature
by the root path and build the corresponding substitution. *)
let rec prefix_idents root pos sub = function
[] -> ([], sub)
| Sig_value(id, decl) :: rem ->
let p = Pdot(root, Ident.name id, pos) in
let nextpos = match decl.val_kind with Val_prim _ -> pos | _ -> pos+1 in
let (pl, final_sub) = prefix_idents root nextpos sub rem in
(p::pl, final_sub)
| Sig_type(id, decl, _) :: rem ->
let p = Pdot(root, Ident.name id, nopos) in
let (pl, final_sub) =
prefix_idents root pos (Subst.add_type id p sub) rem in
(p::pl, final_sub)
| Sig_exception(id, decl) :: rem ->
let p = Pdot(root, Ident.name id, pos) in
let (pl, final_sub) = prefix_idents root (pos+1) sub rem in
(p::pl, final_sub)
| Sig_module(id, mty, _) :: rem ->
let p = Pdot(root, Ident.name id, pos) in
let (pl, final_sub) =
prefix_idents root (pos+1) (Subst.add_module id p sub) rem in
(p::pl, final_sub)
| Sig_modtype(id, decl) :: rem ->
let p = Pdot(root, Ident.name id, nopos) in
let (pl, final_sub) =
prefix_idents root pos
(Subst.add_modtype id (Mty_ident p) sub) rem in
(p::pl, final_sub)
| Sig_class(id, decl, _) :: rem ->
let p = Pdot(root, Ident.name id, pos) in
let (pl, final_sub) = prefix_idents root (pos + 1) sub rem in
(p::pl, final_sub)
| Sig_class_type(id, decl, _) :: rem ->
let p = Pdot(root, Ident.name id, nopos) in
let (pl, final_sub) = prefix_idents root pos sub rem in
(p::pl, final_sub)
let subst_signature sub sg =
List.map
(fun item ->
match item with
| Sig_value(id, decl) ->
Sig_value (id, Subst.value_description sub decl)
| Sig_type(id, decl, x) ->
Sig_type(id, Subst.type_declaration sub decl, x)
| Sig_exception(id, decl) ->
Sig_exception (id, Subst.exception_declaration sub decl)
| Sig_module(id, mty, x) ->
Sig_module(id, Subst.modtype sub mty,x)
| Sig_modtype(id, decl) ->
Sig_modtype(id, Subst.modtype_declaration sub decl)
| Sig_class(id, decl, x) ->
Sig_class(id, Subst.class_declaration sub decl, x)
| Sig_class_type(id, decl, x) ->
Sig_class_type(id, Subst.cltype_declaration sub decl, x)
)
sg