forked from MLstate/opalang
-
Notifications
You must be signed in to change notification settings - Fork 0
/
surfaceAstRenaming.ml
1825 lines (1665 loc) · 69.5 KB
/
surfaceAstRenaming.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
(*
Copyright © 2011 MLstate
This file is part of OPA.
OPA is free software: you can redistribute it and/or modify it under the
terms of the GNU Affero General Public License, version 3, as published by
the Free Software Foundation.
OPA is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for
more details.
You should have received a copy of the GNU Affero General Public License
along with OPA. If not, see <http://www.gnu.org/licenses/>.
*)
(**
Alpha renaming of the Ast
Alpha renaming is done the following way:
- first scan the toplevel and rename all toplevel identifiers
it also records which of these identifiers are modules
(so that you have enough information when you see an 'open' later)
Since all the identifiers in the AST have the same type, an intermediate
datastructure is introduced to keep the alpha renamed toplevel identifiers
and the not alpha renamed expressions
this pass creates the toplevel environment, and a part of the global
environment
- then fold into the expressions
this pass manages three kind of environment:
- the toplevel one (the one mentioned three lines above)
when an identifier is not (locally) bound, it is looked up in the toplevel
environment
contains bindings for variables and type names (independently)
- the local one
contains bindings for both variable and type names (independently)
it maps source name to unique names
only variables in the scope appear in this environment
- the folding one
contains a map from source type variable to unique type variables
contains also a map from unique identifiers to property about them
(mainly to see if they have been used or not)
type variables need to appear in this environment (contrary to variable
and type names) because they are (except in typedef) implicitely bound
eg: when you see [x = (2 : 'a) y = (2 : 'a) x], you have to keep the
keep the environment that renamed 'a in the branch of 'x' to some unique
name to be able to give the same unique name to the 'a in the branch of
'y'
Type variables are bound to the closest surrounding field (or toplevel
definition) in coercions
In type definitions, they are bound to the type definition explicitely
or bound to the surrounding module type
*)
(* depends *)
module List = BaseList
module Format = BaseFormat
module String = BaseString
(* HACK : please, clean-up in opa lang *)
module Parser_utils = OpaParserUtils
open SurfaceAst
open SurfaceAstHelper
let warning_set = WarningClass.Set.create ()
let warn_duplicateL0 =
let doc = "Duplication of names at level 0" in
WarningClass.create ~name:"duplicateL0" ~doc ~err:false ~enable:true ()
let warn_unused =
let doc = "Complain when a variable is unused" in
WarningClass.create ~name:"unused" ~doc ~err:false ~enable:(#<If:TESTING>false#<Else>true#<End>) ()
let warn_used =
let doc = "Complain when a variable starting with one _ is used" in
WarningClass.create ~parent:warn_unused ~name:"used" ~doc ~err:false ~enable:(#<If:TESTING>false#<Else>true#<End>) ()
let () = WarningClass.Set.add_all warning_set [
warn_duplicateL0;
warn_unused;
warn_used;
]
(*--------------------------------*)
(*------------ utils -------------*)
(*--------------------------------*)
let stringmap_filter_map f map =
StringMap.map (fun x -> Option.get (f x)) (StringMap.filter_val (fun x -> f x <> None) map)
(*--------------------------------*)
(*----------- typedefs -----------*)
(*--------------------------------*)
type 'a result =
| Result of 'a
| Error of string
(**
Normal represents an identifier who wasn't defined as [ident = {{ .. }}]
OpenedIdent represents a path to an identifier
In "m = \{\{ x = 2 \}\} ... open m ... do x ... "
The map would be "m -> 'node(m) -> node(x)', uniq(m), \[\]"
"x -> 'node(x)' , uniq(x), \[x\]"
That way, when you see 'x', you can replace it by 'm.x'
*)
type var_in_scope =
| Normal of Ident.t
| OpenedIdent of string Tree.t * Ident.t * string list
type scope_env =
{ scope_vars : var_in_scope StringMap.t;
scope_types : Ident.t StringMap.t ;
}
(* these properties are used to issue warnings *)
type properties =
{ used : bool
; no_warning : unit }
(**
Some information about the identifiers: if they were used, etc.
*)
type information = {
properties : properties;
is_type : bool;
exported : bool;
ident : Ident.t;
pos : FilePos.pos;
warning_when: [`used | `unused | `never];
}
(**
The different kind of environment needed
*)
type toplevel_env =
{ tnames : (var_in_scope * FilePos.pos) list StringMap.t
; ttypes : (Ident.t * FilePos.pos) list StringMap.t
}
type 'a folding_env =
{ fglobal : information IdentMap.t
; ftypevars : Ident.t StringMap.t
; data: 'a (* - when renaming types, it contains a boolean saying whether
* type variable are explicitely bound or not
* - when renaming patterns, it contains a set containing
* the identifiers previously defined in the pattern
* - when renaming expressions, it contains unit
*)
}
type local_env =
{ lnames: var_in_scope StringMap.t
; ltypes : Ident.t StringMap.t
}
type 'a all_envs =
{ t : toplevel_env
; l : local_env
; f : 'a folding_env
}
type env = {
all_envs : unit all_envs; (* the environment for renaming *)
maptoident_val : Ident.t StringMap.t;
maptoident_typ : Ident.t StringMap.t;
}
(*-------------------------------------*)
(*---------- debug printing -----------*)
(*-------------------------------------*)
let pp_key f map =
StringMap.iter (fun name key ->
let is_m =
match key with
| [OpenedIdent _] -> true
| _ -> false in
Printf.fprintf f "%s-%d-%B " name (List.length key) is_m
) map;
Printf.fprintf f "\n\n%!"
let pp_stringmap_aux p f set =
StringMap.iter (fun k v -> Format.fprintf f "@ (%S,%a);" k p v) set
let pp_stringmap p f map =
Format.fprintf f "@[@[<hv2>StringMap.of_list [%a@]@ ]@]" (pp_stringmap_aux p) map
let pp_identmap_aux p f set =
IdentMap.iter (fun k v -> Format.fprintf f "@ (%s,%a);" (Ident.to_string k) p v) set
let pp_identmap p f map =
Format.fprintf f "@[@[<hv2>IdentMap.of_list [%a@]@ ]@]" (pp_identmap_aux p) map
let pp_list_aux p f list =
List.iter (fun v -> Format.fprintf f "@ %a;" p v) list
let pp_list p f list =
Format.fprintf f "@[@[<hv2>[%a@]@ ]@]" (pp_list_aux p) list
let pp_ident f i =
Format.fprintf f "%s" (Ident.to_string i)
let pp_fixme f _ = Format.fprintf f "<FIXME>"
let pp_var_in_scope f = function
| Normal i -> Format.fprintf f "Normal %a" pp_ident i
| OpenedIdent (_,i,l) -> Format.fprintf f "OpenedIdent (%a,%d)" pp_ident i (List.length l)
let pp_toplevel_env f { tnames = tnames
; ttypes = ttypes } =
Format.fprintf f "@[@[<v 2>{@,@[<2>tname:@ %a@]@ \
@[<2>ttypes:@ %a@]@]@,}@]"
(pp_stringmap (fun f l -> pp_list pp_var_in_scope f (List.map fst l))) tnames
pp_fixme ttypes
let pp_information = pp_fixme
let pp_folding_env f {fglobal=fglobal; _} =
Format.fprintf f "{fglobal=%a; ...}"
(pp_identmap pp_information) fglobal
let pp_local_env = pp_fixme
let pp_all_envs ff {t = t; l = l; f = f} =
Format.fprintf ff "@[@[<v 2>{@,@[<2>t:@ %a@]@ \
@[<2>l:@ %a@]@ \
@[<2>f:@ %a@]@]@,}@]"
pp_toplevel_env t
pp_local_env l
pp_folding_env f
let print_and_return env =
Format.printf "%a@." pp_all_envs env;
env
(*-------------------------------*)
(*--------- hierarchy -----------*)
(*-------------------------------*)
(* was meant for incremental compilation, could possibly be removed
* if it doesn't matter anymore
* this way, we wouldn't have very long identifiers *)
type hierar = int * string list
let empty_hierar = (0,[])
let max_hierar_high = 6
let (+>) s ((n,l) as h : hierar) =
if n > max_hierar_high then h else (n+1,s :: l)
let fake_hierar context = context +> empty_hierar
(* Generate an exprIdent from a (source) name and a hierarchy
* (list of string to make renaming somewhat stable) *)
let ident_of_string ~label name ((_,l):hierar) =
let filename = FilePos.get_file label.QmlLoc.pos in
let buff = FBuffer.make 0 in
let descr = List.fold_left FBuffer.add buff (l |> List.rev) |> FBuffer.contents in
Ident.next ~filename ~descr name
let source_of_string = Ident.source
(*-------------------------------------*)
(*----------- initial env -------------*)
(*-------------------------------------*)
let init_property' ?warning ~exported ~is_type ident pos =
{ properties = { used = false; no_warning = () }
; ident = ident
; is_type = is_type
; exported = exported
; warning_when =
(match warning with
| None -> Ident.renaming_should_warn_when ident
| Some v -> v)
; pos = pos }
let init_property ?warning ~exported ~is_type ident label =
init_property' ?warning ~exported ~is_type ident label.QmlLoc.pos
let empty_local_env =
{ lnames = StringMap.empty
; ltypes = StringMap.empty
}
let empty_folding_env =
{ fglobal = IdentMap.empty
; ftypevars = StringMap.empty
; data = ()
}
let empty_toplevel_env =
{ tnames = StringMap.empty
; ttypes = StringMap.empty
}
let empty_envs =
{ t = empty_toplevel_env
; l = empty_local_env
; f = empty_folding_env
}
let with_typevars r t =
{r with f = {r.f with ftypevars = t }}
let with_tnames r tnames =
{r with t = {r.t with tnames = tnames }}
let with_data r v =
{r with f = {r.f with data = v}}
let with_type_env r v =
{ r with f = {r.f with ftypevars = v }}
let with_lnames r v =
{ r with l = {r.l with lnames = v }}
let with_global r g =
{ r with f = {r.f with fglobal = g }}
let init_env compiler_inserted_names compiler_inserted_types =
let nopos = FilePos.nopos "SurfaceAstRenaming.init_env" in
let tnames,fglobal =
List.fold_left
(fun (tnames, fglobal) name ->
let ident = ident_of_string ~label:(SurfaceAstCons.Label.builtin()) name (fake_hierar "renaming") in
StringMap.add name [(Normal ident,FilePos.nopos "Builtin name")] tnames,
IdentMap.add ident (init_property' ~exported:false ~is_type:false ident
nopos) fglobal
) (StringMap.empty, IdentMap.empty) compiler_inserted_names in
let ttypes, fglobal =
List.fold_left
(fun (ttypes, fglobal) name ->
let pos = FilePos.nopos "Builtin type" in
let ident = ident_of_string ~label:(SurfaceAstCons.Label.builtin()) name (fake_hierar "renaming") in
StringMap.add name [(ident,pos)] ttypes,
IdentMap.add ident (init_property' ~exported:false ~is_type:true ident nopos) fglobal
) (StringMap.empty, fglobal) compiler_inserted_types in
{ all_envs =
{ t = {tnames = tnames; ttypes = ttypes}
; f = {empty_folding_env with fglobal = fglobal}
; l = empty_local_env };
maptoident_typ = StringMap.empty;
maptoident_val = StringMap.empty;
}
(*-----------------------*)
(*--- managing 'open' ---*)
(*-----------------------*)
(* a few functions to deal with the 'open' node *)
(* tree_of_expr gives
x
/ \
[y z]
| |
[] [w]
|
[]
from:
x = {{ y = 2 z = {{ w = 3 }} }}
tree_option_of_expr gives you a result only if the argument is a module,
or a path to a module
*)
let ignore_for_modules =
let module D = SurfaceAstDecons in
[ D.Remove.Basic.expand
; D.Remove.Basic.opacapi
; D.Remove.Basic.opavalue_directive
; D.Remove.Basic.letin
; D.Remove.Basic.coerce
; D.Remove.Basic.open_
; D.Remove.Basic.slicer_directive ]
let rec tree_of_expr name l =
let children =
List.map
(fun (field,e) ->
Option.default
(Tree.leaf field)
(tree_option_of_expr field e)
) l in
Tree.Tree (name,children)
and tree_option_of_expr name e =
match SurfaceAstDecons.FoldThrough.fields ~through:ignore_for_modules e with
| None -> None
(* the following expression was used to be able to open records modulo
* alias (but it didn't in all cases, especially at toplevel)
* path_expr_to_module old_tree_map e *)
| Some fields -> Some (tree_of_expr name fields)
(*----------------------------------*)
(*---- error/warning management ----*)
(*----------------------------------*)
(* Gives you an advice when you have an unbound variable *)
let filter_closest name li =
let dist = (float_of_int (String.length name)) *. 2. /. 3. in
let li = List.filter (fun (_, d) -> d < dist) li in
let li =
List.fold_left (fun (li, (old, delta)) (name, d) ->
let d' = old -. d in if d' <= delta
then ((name, d)::li, (d, d'))
else (li, (old, delta)) ) ([], (0., dist)) li |> fst |> List.rev in
li
let get_closest_field_names typo l =
HintUtils.get_closest_names (List.map fst l) typo
(* Error/Warning: Using OpaError *)
let exists_duplicatesL0 = ref false
let duplicate_type_declarations = ref false
let print_duplicatesL0 () =
if !exists_duplicatesL0 then
OManager.warning ~wclass:warn_duplicateL0
"@[<2> You have @{<bright>duplicate definitions@} at toplevel.@\nThe compilation result can depend on source files order.@]";
if !duplicate_type_declarations then
OManager.serror "You have duplicate type declarations, which is forbidden."
let make_placeholder label name = ident_of_string ~label "renaming_placeholder" (fake_hierar name)
let is_placeholder ident = Ident.original_name ident = "renaming_placeholder"
let pos_of_label label = QmlLoc.pos label
let string_of_label label = FilePos.to_string (pos_of_label label)
(* Following the standard layout for error messages *)
let make_error error label fmt =
let context = OpaError.Context.pos (pos_of_label label) in
error context ("@[<2> "^^fmt^^"@]")
let serror label = make_error OpaError.serror label
let error label = make_error OpaError.error label
let unbound kind name all_env label =
let string, names_in_scope =
match kind with
| `var ->
"variable",
List.uniq (StringMap.keys all_env.l.lnames @ StringMap.keys all_env.t.tnames)
| `typ ->
"type name",
List.uniq (StringMap.keys all_env.l.ltypes @ StringMap.keys all_env.t.ttypes) in
serror label "the %s @{<bright>%s@} is unbound." string name;
OManager.printf "%a%!" (HintUtils.pp_suggestion names_in_scope) name;
make_placeholder label name
let non_linear_pattern name label =
serror label "the variable @{<bright>%s@} appears several times." name
let invalid_open label =
serror label "you are trying to @{<bright>open@} an invalid expression.";
[], make_placeholder label "open", []
let invalid_coerced_open label =
serror label "you are applying a wrong @{<bright>coercion@} on the @{<bright>opened@} expression.";
fun x -> x
let check_for_toplevel_duplicates val_map type_map =
exists_duplicatesL0 := false;
StringMap.iter (fun name l ->
match l with
| [] -> invalid_arg "SurfaceAstRenaming.check_for_toplevel_duplicates"
| [_] -> ()
| _ ->
let positions = List.map snd l in
exists_duplicatesL0 := true;
let origins = List.filter_map
(function
| (OpenedIdent (_,ident,(_ :: _ as path)),_) ->
Some (String.concat_map "." Base.identity (Ident.original_name ident :: path))
| _ ->
None
) l in
let n1 = List.length l in
let n2 = List.length origins in
OManager.warning ~wclass:warn_duplicateL0
"%a@\n@[<2> @{<bright>%s@} is defined @{<bright>%d@} times at the toplevel%s.@]"
(Format.pp_list "@\n" FilePos.pp_pos) positions
name n1 (if n2 = 0 then "" else Printf.sprintf " (%d of which by an 'open' statement)" n2)
) val_map;
StringMap.iter (fun name l ->
match l with
| [] -> assert false
| [_] -> ()
| _ ->
duplicate_type_declarations := true;
let positions = List.map snd l in
OManager.serror
"%a@\n@[<2> The type @{<bright>%s@} is defined %d times."
(Format.pp_list "@\n" FilePos.pp_pos) positions
name
(List.length l)
) type_map
let is_exported i infos =
try (IdentMap.find i infos).exported
with Not_found -> false
let exported_var global_env l =
let rec aux o = function
| (OpenedIdent (_,ident,[]),pos) :: l
| (Normal ident,pos) :: l ->
if is_exported ident global_env then
aux (Some (ident,pos)) l
else
aux o l
| _ :: l -> aux o l
| [] -> o in
aux None l
let check_for_unused_names identmap toplevel_names =
if WarningClass.is_warn warn_used || WarningClass.is_warn warn_unused then (
IdentMap.iter
(fun val_ key ->
if not (FilePos.is_empty key.pos) && (* no warning for compiler introduced names *)
not key.is_type (* no warnings for type *)
then
if not key.properties.used && key.warning_when = `unused then
let l = StringMap.find_opt (Ident.original_name val_) toplevel_names in
let v =
match l with
| None -> None
| Some l -> Option.map fst (exported_var identmap l) in
match v with
| Some x when Ident.equal val_ x -> () (* no warning for the exported names either *)
| _ ->
OManager.warning ~wclass:warn_unused "%a@\n Unused %s %s."
FilePos.pp_pos key.pos
(if key.is_type then "type name" else "variable")
(Ident.original_name val_)
else if key.properties.used && key.warning_when = `used then
OManager.warning ~wclass:warn_used "%a@\n Used %s %s."
FilePos.pp_pos key.pos
(if key.is_type then "type name" else "variable")
(Ident.original_name val_)
) identmap;
)
(* Check that a value is not bound several times in a set of recursives bindings
* like [rec x() = void and x() = void] *)
let rec check_unicity ~case ~compare_by iel =
match iel with
| [] -> ()
| v :: t ->
let (i, label) = compare_by v in
if List.exists (fun w -> i = fst (compare_by w)) t then
serror label "@{<bright>%s@} is bound multiple times in %s." i case;
check_unicity ~case ~compare_by t
(*----------------------------*)
(*---------- tuple -----------*)
(*----------------------------*)
(*
Because the set of types tuple_2, tuple_3, ... is extensible, we need
to take special care of them
The following reference holds a map of the size of the tuple used in the code
It should be given to the pass that actually defines the types
These types are not defined in the toplevel map like the other types, so they
need to be added at the end (so that looking for the unique name of "tuple_2"
doesn't raise Not_found)
*)
let tuples = ref IntMap.empty
let add_tuple_n num ident = tuples := IntMap.safe_add num ident !tuples
let get_tuple_n num = IntMap.find_opt num !tuples
let get_tuple_size name =
match String.slice '_' name with
| ["tuple"; s] ->
( match Base.int_of_string_opt s with
| None -> None
| Some n -> if n >= 0 then Some n else None
)
| _ -> None
(** Interface to the stuff on tuples *)
let add_tuple mk_ident name =
match get_tuple_size name with
| None -> `none
| Some n ->
match get_tuple_n n with
| None -> let ident = mk_ident () in
add_tuple_n n ident;
`new_ ident
| Some ident -> `old ident
let get_tuple_int_map () =
let v = !tuples in
tuples := IntMap.empty;
v
let set_tuple_int_map map =
tuples := map
let get_tuple_string_map () =
IntMap.fold
(fun n ident acc -> StringMap.add (Printf.sprintf "tuple_%d" n) ident acc)
!tuples
StringMap.empty
(*-------------------------*)
(*-- pattern environment --*)
(*-------------------------*)
(* ie the value of the field data when foldmapping a pattern
* it is the set of the all the names defined in the current left hand side of a rule
*)
let empty_pat_env =
StringSet.empty
let is_hiding_pat_var name all_env =
StringSet.mem name (snd all_env.f.data)
(*--------------------------------*)
(*---- updating environments -----*)
(*--------------------------------*)
(* tags an identifier as used when looking it up *)
let use_var ident all_env =
let fglobal = all_env.f.fglobal in
if is_placeholder ident then
all_env
else
try
let old_prop = IdentMap.find ident fglobal in
let new_prop = {old_prop with properties = {old_prop.properties with used = true}} in
let fglobal = IdentMap.add ident new_prop fglobal in
{all_env with f = {all_env.f with fglobal = fglobal}}
with
Not_found ->
all_env
let add_type name hierar all_env label =
let ident = ident_of_string ~label name hierar in
let infos = init_property ~exported:true ~is_type:true ident label in
{all_env with l = {all_env.l with ltypes = StringMap.add name ident all_env.l.ltypes};
f = {all_env.f with fglobal = IdentMap.add ident infos all_env.f.fglobal}},
ident
let push_in_front k v map = try StringMap.add k (v :: (StringMap.find k map)) map with Not_found -> StringMap.add k [v] map
let add_global_type name hierar all_env label =
let ident = ident_of_string ~label name hierar in
let infos = init_property ~exported:true ~is_type:true ident label in
{all_env with t = {all_env.t with ttypes = push_in_front name (ident,label.QmlLoc.pos) all_env.t.ttypes};
f = {all_env.f with fglobal = IdentMap.add ident infos all_env.f.fglobal}},
ident
let add_type_var name hierar all_env label =
let ident = ident_of_string ~label name hierar in
let folding_env = all_env.f in
({all_env with f =
{folding_env with
ftypevars = StringMap.add name ident folding_env.ftypevars}},
ident)
let add_var ?(no_warning=false) ?(exported=true) name hierar all_env label =
let ident = ident_of_string ~label name hierar in
let warning = if no_warning then Some `never else None in
let infos = init_property ?warning ~exported ~is_type:false ident label in
{all_env with l = {all_env.l with lnames = StringMap.add name (Normal ident) all_env.l.lnames};
f = {all_env.f with fglobal = IdentMap.add ident infos all_env.f.fglobal}},
ident
let add_opened_var name tree ident path all_env =
let all_env = use_var ident all_env in
{all_env with
l = {all_env.l with
lnames = StringMap.add name (OpenedIdent (tree, ident, path @ [name])) all_env.l.lnames}}
(*let add_opened_var_global name tree ident path all_env =
let all_env = use_var ident all_env in
let old_l = Option.default [] (StringMap.find_opt name all_env.t.tnames) in
{all_env with
t = {all_env.t with
tnames = StringMap.add name (OpenedIdent (tree, ident, path @ [name]) :: old_l) all_env.t.tnames}}*)
let add_pat_var ?no_warning name hierar all_env label =
if is_hiding_pat_var name all_env then
non_linear_pattern name label;
let exported, bindings = all_env.f.data in
let all_env = with_data all_env (exported, StringSet.add name bindings) in
add_var ?no_warning ~exported name hierar all_env label
(* do we really need to give all_env back all the time? *)
(*--------------------------------*)
(*-- look up in the environment --*)
(*--------------------------------*)
let get_type name all_env label =
let ident, all_env =
match StringMap.find_opt name all_env.l.ltypes with
| None ->
( match StringMap.find_opt name all_env.t.ttypes with
| None ->
( match add_tuple (fun () -> source_of_string name) name with
| `none ->
(* unbound type *)
unbound `typ name all_env label, all_env
| `old ident -> ident, all_env
| `new_ ident ->
(* definition of a new tuple type *)
ident,
with_global all_env
(IdentMap.add
(* For exported, either value is good, because we won't look at it
* since the type doesn't appear in the toplevel environment *)
ident (init_property ~exported:true ~is_type:true ident label)
all_env.f.fglobal)
)
| Some [] -> assert false
| Some ((ident,_pos) :: _) ->
ident, all_env
)
| Some ident -> ident, all_env
in
(use_var ident all_env).f, ident
let get_typevar name hierar all_env label =
(* if the variable is bound to a typedef, use it *)
match List.find_opt (fun ident -> Ident.original_name ident = name) all_env.f.data with
| None ->
(* else, it is in the environment, use it *)
( match StringMap.find_opt name all_env.f.ftypevars with
| None ->
(* else define it in the environment *)
let all_env, ident = add_type_var name hierar all_env label in
all_env.f, ident
| Some ident ->
all_env.f, ident)
| Some ident ->
all_env.f, ident
let get_var_from_var_in_scope all_env label = function
| Normal ident ->
(use_var ident all_env).f, Ident ident
| OpenedIdent (_tree, ident, path) ->
(* when saying [m = {{x = 1}} open m x]
* m is marked as used (x doesn't even appear in the global environment)
*)
(use_var ident all_env).f, Parser_utils.undecorate (Parser_utils.dot_path (Ident ident, label) path)
let get_var_from_toplevel name all_env label =
match StringMap.find_opt name all_env.t.tnames with
| Some ((var_in_scope,_) :: _) ->
get_var_from_var_in_scope all_env label var_in_scope
| Some [] ->
(* not well formed toplevel environment *)
failwith (Printf.sprintf "SurfaceAstRenaming: get_var: malformed environment: %s" name)
| None ->
(* unbound variable *)
all_env.f, Ident (unbound `var name all_env label)
let get_var name all_env label =
match StringMap.find_opt name all_env.l.lnames with
| Some var_in_scope -> get_var_from_var_in_scope all_env label var_in_scope
| None -> get_var_from_toplevel name all_env label
(*--------------------------*)
(*-- renaming for types ----*)
(*--------------------------*)
(*
The 'exported' functions are grouped at the end
These functions have all type :
all_envs -> string list -> 'a -> all_env, 'a
Technically, this function fold with the full environment
The local environment and toplevel environment should not go up the tree,
but since there is no bindings in type expressions (except for type variables
but their map is already in the folding environment), it makes no difference
and it is simpler to write
*)
let f_list_aux f all_env hierar l =
List.fold_right
(fun x (folding_env,l) ->
let f_env, x = f {all_env with f = folding_env} hierar x in
f_env, x :: l
) l (all_env.f, [])
let rec f_typeinstance_node label all_env hierar (Typeident ident,tyl) =
let f_env, ident = get_type ident all_env label in
let f_env, tyl = f_tys {all_env with f = f_env} hierar tyl in
f_env, (Typeident ident, tyl)
and f_arrow_t all_env hierar (arrow_t_node, label) =
let f_env, arrow_t_node = f_arrow_t_node all_env hierar arrow_t_node in
f_env, (arrow_t_node, label)
and f_arrow_t_node all_env hierar (row_t, ty) =
let f_env, row_t = f_row_t all_env hierar row_t in
let f_env, ty = f_ty {all_env with f = f_env} hierar ty in
f_env, (row_t, ty)
and f_row_t all_env hierar (v, label) =
let f_env, v = f_row_t_node label all_env hierar v in
f_env, (v, label)
and f_row_t_node label all_env hierar (TyRow (fields, rowvaro)) =
let f_env, fields = f_fields_t_node_list all_env hierar fields in
match rowvaro with
| None -> f_env, TyRow (fields, None)
| Some (Rowvar v) ->
let f_env, v = f_typevar label {all_env with f = f_env} hierar v in
f_env, TyRow (fields, Some (Rowvar v))
and f_fields_t_node_list all_env hierar fields =
f_list_aux f_fields_t_node all_env hierar fields
and f_module_fields all_env hierar fields =
let original_ftypevars = all_env.f.ftypevars in
let new_ftypevars = StringMap.empty in
let f_env, fields =
List.fold_left_map
(fun f_env (field,ty) ->
let f_env, ty = f_ty {all_env with f = {f_env with ftypevars = new_ftypevars}} hierar ty in
(* rev_map is used so that variables have the same order as in the source
* it shouldn't matter but it is easier to read *)
let defined_typed_vars = List.rev_map SurfaceAstHelper.flatvar (StringMap.elts f_env.ftypevars) in
let ty = if defined_typed_vars = [] then ty else (TypeForall (defined_typed_vars, ty), Parser_utils.nlabel ty) in
f_env, (field,ty)) all_env.f fields in
{f_env with ftypevars = original_ftypevars}, fields
and f_fields_t_node all_env hierar (field_name, ty) =
let f_env, ty = f_ty all_env hierar ty in
f_env, (field_name, ty)
and f_sum_t_list all_env hierar sum =
f_list_aux f_sum_t all_env hierar sum
and f_sum_t all_env hierar (sum_t_node, label) =
let f_env, sum_t_node = f_sum_t_node label all_env hierar sum_t_node in
f_env, (sum_t_node, label)
and f_sum_t_node label all_env hierar = function
| SumName ti ->
let f_env, ti = f_typeinstance_node label all_env hierar ti in
f_env, SumName ti
| SumRecord row_t ->
let f_env, row_t = f_row_t_node label all_env hierar row_t in
f_env, SumRecord row_t
| SumVar (Colvar name) ->
let f_env, name = f_typevar label all_env hierar name in
f_env, SumVar (Colvar name)
and f_ty all_env hierar (ty_node, label) =
let f_env, ty_node = f_ty_node label all_env hierar ty_node in
f_env, (ty_node, label)
and f_tys all_env hierar tys =
f_list_aux f_ty all_env hierar tys
and f_ty_node label (all_env:Ident.t list all_envs) hierar = function
| TypeExternal
| TypeConst _ as t ->
all_env.f, t
| TypeVar (Flatvar name) ->
let f_env, name = f_typevar label all_env hierar name in
f_env, TypeVar (Flatvar name)
| TypeArrow r ->
let f_env, r = f_arrow_t_node all_env hierar r in
f_env, TypeArrow r
| TypeRecord r ->
let f_env, r = f_row_t_node label all_env hierar r in
f_env, TypeRecord r
| TypeSumSugar l ->
let f_env, l = f_sum_t_list all_env hierar l in
f_env, TypeSumSugar l
| TypeNamed ti ->
let f_env, ti = f_typeinstance_node label all_env hierar ti in
f_env, TypeNamed ti
| TypeForall (vars, t) ->
let original_vars = vars in
let original_ftypevars = all_env.f.ftypevars in
let f_env, vars =
(* put the vars in the environment *)
List.fold_left_map
(fun f_env (Flatvar var) ->
let all_env, var = add_type_var var hierar {all_env with f = f_env} label in
all_env.f, (Flatvar var)) all_env.f vars in
(* rename the underlying type *)
let f_env, t = f_ty {all_env with f = f_env} hierar t in
let f_env = (* remove the bindings for the quantified variables
* (and restore the original one if any) *)
{f_env with ftypevars =
List.fold_left
(fun (map:_ StringMap.t) (Flatvar v) ->
try
StringMap.add v
(StringMap.find v original_ftypevars) map
with Not_found ->
StringMap.remove v map
) f_env.ftypevars original_vars} in
f_env, TypeForall (vars,t)
| TypeModule fields ->
let f_env, fields = f_module_fields all_env hierar fields in
f_env, TypeRecord (TyRow (fields, None))
and f_flatvar label (all_env:Ident.t list all_envs) hierar (Flatvar name) =
let f_env, name = f_typevar label all_env hierar name in
f_env, Flatvar name
and f_typevar label all_env hierar name =
get_typevar name hierar all_env label
let f_flatvars label x y z = f_list_aux (f_flatvar label) x y z
(**
The field all_env.f.data contains the variable bound to the surrounding typedef
or [] if we are in a coercion
When looking for a variable, this field is looked up BEFORE the field all_env.f.ftypevars
Meaning of empty_type_env:
- true: ignore the given type var environment and use the empty env instead
used when opening a new scope for typevars
- false: take the given type_env
Meaning if give_original:
- true: ignore the computed type var environment, and give back the one
initially given to the function
used when closing a new scope
eg: [type t('a) = 'a x : 'a], once the typedef is renamed, you throw the
type env to take the one you had before
- false: give the computed environment
*)
let f_ty_make_ext func ~empty_type_env ~give_original all_env hierar v =
let f = all_env.f in
let new_f =
{f with
data = [];
ftypevars = if empty_type_env then StringMap.empty else f.ftypevars
} in
let new_all_env = {all_env with f = new_f} in
let f_env,result = func new_all_env hierar v in
let f_env =
{ f_env with
data = f.data;
ftypevars = if give_original then all_env.f.ftypevars else f_env.ftypevars
} in
{new_all_env with f = f_env}, result
(**
The entry points for renaming types
You can't directly call the previous functions because the types of the
environments are not compatible: the 'a of 'a folding_env is bool here,
StringSet.t in patterns, unit in expressions
*)
let f_ty_ext ~empty_type_env =
f_ty_make_ext f_ty ~empty_type_env
let f_arrow_t_ext ~empty_type_env =
f_ty_make_ext f_arrow_t ~empty_type_env
let f_flatvars_ext label ~empty_type_env =
f_ty_make_ext (f_list_aux (f_flatvar label)) ~empty_type_env
(*------------------------------*)
(*---- renaming for typedefs ---*)
(*------------------------------*)
(*
Taken care of specially, because, contrary to other cases, in typedefs
you can (and need to) bind your type variables explicitely
*)
let f_global_typeident all_env hierar (Typeident name) label =
add_global_type name hierar all_env label
let f_typedef all_env hierar (tyvl,ty) =
let original_data = all_env.f.data in
let original_ftypevars = all_env.f.ftypevars in
let f_env, tyvl =
(* renaming the vars in an empty environment
* (because when saying type t('a), 'a can never be shared, it is a definition) *)
f_flatvars
(Parser_utils.label ty)
{all_env with f = {all_env.f with ftypevars = StringMap.empty; data = []}}
hierar
tyvl in
(* putting the vars of the typedef in the 'data' field, that is the field containing
* the variable that are shared in the whole type *)
let all_env = {all_env with f = {f_env with data = List.map (fun (Flatvar v) -> v) tyvl}} in
let f_env, ty = f_ty all_env hierar ty in
(* discarding everything from the renaming of the ty but the global_env *)
let all_env = {all_env with f = {f_env with data = original_data; ftypevars = original_ftypevars}} in
all_env, (tyvl, ty)
let f_typedefs all_env hierar typedefs =
check_unicity
~case: "a type definition"
~compare_by:
(fun ({ SurfaceAst.ty_def_name = Typeident i ; _ }, label) -> (i, label))
typedefs ;
let all_env, l =
List.fold_left
(fun (all_env, l)
({
SurfaceAst.ty_def_options = options ;
SurfaceAst.ty_def_visibility = visibility ;
SurfaceAst.ty_def_name = Typeident name ;
SurfaceAst.ty_def_params = c ;
SurfaceAst.ty_def_body = d ;
}, e) ->
let (all_env, ident) = add_type name hierar all_env e in
all_env, (options, visibility, ident, c, d, e) :: l)
(all_env,[]) typedefs in
(* The list of types is reversed once, but it doesn't matter since there is
no ambiguity (no types occurs several times in the list). *)
List.fold_left
(fun (all_env, l) (options, visibility, ident, tyvl, ty, e) ->
let (all_env, (tyvl, ty)) = f_typedef all_env hierar (tyvl, ty) in
all_env, (
{
SurfaceAst.ty_def_options = options ;
SurfaceAst.ty_def_visibility = visibility ;
SurfaceAst.ty_def_name = Typeident ident ;
SurfaceAst.ty_def_params = tyvl ;
SurfaceAst.ty_def_body = ty ;
}, e) :: l)
(all_env, []) l
(*------------------------------*)
(*---- renaming for patterns ---*)
(*------------------------------*)
(*
Gives back the environment with bindings from the patterns
and renames everything
The field 'data' of all_env.f.data contains the pattern environment, that
is used to check the linearity of the pattern, ie that no variable
appears twice in a pattern
*)
let f_list_aux f all_env hierar l =
List.fold_right
(fun x (all_env, l) ->
let all_env, x = f all_env hierar x in
all_env, x :: l
) l (all_env, [])
let rec f_pat all_env hierar (pat_node, label) =
let all_env, pat_node = f_pat_node label all_env hierar pat_node in
all_env, (pat_node, label)
and f_pat_node label all_env hierar = function
| PatAny
| PatConst _ as p -> all_env, p
| PatRecord (p, rowvar) ->
let all_env, p = f_pat_record_node all_env hierar p in
all_env, PatRecord (p, rowvar)