-
Notifications
You must be signed in to change notification settings - Fork 125
/
imp_MatchGeneration.ml
1493 lines (1396 loc) · 48.8 KB
/
imp_MatchGeneration.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/>.
*)
(*
TODO:
We can take advantage of the analysis for adding new warnings
about unused patterns.
The problem to do this there, is that it will be only on the
client side, and the same optimisation are possible on the server
side. Maybe after a working prototype, we can try to extract
the analysis part, to be able to use it on the server too.
Possible solution:
1) Functorization
2) Parametrized libraries
*)
(* depends *)
module Format = Base.Format
module List = Base.List
(* alias *)
module Common = Imp_Common
module FieldSet = StringSet
module FieldMap = StringMap
module PatternAnalysis = Imp_PatternAnalysis
module SumAnalysis = Imp_SumCase.SumAnalysis
module SumCondition = Imp_SumCase.SumCondition
module SumEnv = Imp_SumCase.SumEnv
(* shorthands *)
module E = Imp_Env
module J = JsAst
module P = Imp_PatternAnalysis
module Q = QmlAst
module SC = SumCondition
(* -- *)
(* type alias *)
type env = Imp_Env.env
type penv = Imp_Env.private_env
type condition = Imp_SumCase.SumCondition.t
type decision = Imp_SumCase.SumCondition.decision
type check = Imp_SumCase.SumCondition.check
type path = Imp_SumCase.path
type rev_path = Imp_SumCase.rev_path
type guard = JsAst.expr
type rev_guards = guard list
type binding = JsAst.ident * JsAst.expr
type bindings = binding list
type pat = Imp_PatternAnalysis.pat
type 'rh rev_cases = (guard option * bindings * 'rh) list
module PathMap = BaseMap.Make ( Order.StringList )
type analysed_bool_pattern = [
| `onlybool of bool
(*
The value is statically known as being a bool value, and every other
matched expression is also necessary a bool at runtime.
In that case, we compile the pattern as native javascript test.
In case of an introduction, we always bind [js_void].
*)
| `partialbool of bool
(*
We know statically that the pattern matches a bool value, but we cannot
assume that every matched value will be a bool at runtime, e.g open colvar.
In this case, we cannot compile the test as a javascript native test, because
every not null object will pass a native test:
{[
if (e) {
// pass if e is a javascript object, even if (e !== [true])
}
]}
We compile the guard as a strict equality with the boolean [true].
In case of an introduction, we always bind [js_void].
*)
| `maybebool of bool
(*
We do not know at compile time if the runtime value will be a boolean or not.
If we end-up in this case, that means that either a pass as lost some type annotation,
or the user has redefined some exotic types dealing with fields ["true"] or ["false"],
like:
{[
type optionbool('a) = { false } / { true : 'a}
]}
In this case, we will use special introspection accessors ClientLib.[dot_$bool].
In case of an introduction, we bind the value returned by the introspection accessor.
*)
]
let pp_analysed_bool fmt = function
| `onlybool b -> Format.fprintf fmt "onlybool:%b" b
| `partialbool b -> Format.fprintf fmt "partialbool:%b" b
| `maybebool b -> Format.fprintf fmt "maybebool:%b" b
type special_bool_hack = analysed_bool_pattern
(*
Priorities used for the patvar heuristic
*)
module Priority =
struct
let shared_fields = 1
let shared_var = 0
let shared_const = 1
let fields = 3
let var = 2
let const = 3
end
module Impl :
sig
type 'a t
val empty : 'a t
val is_empty : 'a t -> bool
val add : rev_path:FieldSet.elt list -> 'a -> 'a t -> 'a t
val fold_right : ('a -> 'acc -> 'acc) -> 'a t -> 'acc -> 'acc
val list : 'a t -> 'a list
end =
struct
(*
A type for aggregating implications.
When 2 implications with diverging path are added to the structure,
the structures becomes closed, and can never gets implications again.
This is so because we do not handle negation of conjonction currently.
*)
type 'a t = (FieldSet.elt * 'a list) list option
let empty = Some []
let is_empty = function
| Some pathmap -> List.is_empty pathmap
| None -> true
let add ~rev_path a = function
| None -> None
| Some map ->
Return.set_checkpoint_none (fun label ->
(*
Not tail rec, but used with very small list (depth of pattern imbrication level)
*)
let rec aux path map =
match path with
| [] ->
(*
Internal error, a dummy first element is always added to the path.
*)
assert false
| [ hd ] -> (
match map with
| [] ->
[ hd, [ a ] ]
| (hd2, list) :: tl ->
if FieldSet.compare_elt hd hd2 <> 0
then
Return.return label ()
else
(hd, a::list) :: tl
)
| hd :: tl -> (
match map with
| [] ->
(hd, []) :: aux tl map
| ((hd2, _) as top) :: map ->
if FieldSet.compare_elt hd hd2 <> 0
then
Return.return label ()
else
top :: aux tl map
)
in
aux (""::(List.rev rev_path)) map
)
let fold_right fold t acc =
match t with
| None -> acc
| Some map ->
List.fold_left (
fun acc (_, list) ->
List.fold_left (fun acc impl -> fold impl acc) acc list
) acc map
let list = function
| None -> []
| Some map -> List.rev_concat_map snd map
end
type menv = {
sum_env : JsAst.ident SumEnv.t ;
(*
The environment where already produced bindings are stored.
*)
sum : SumAnalysis.sum ;
(*
The abstract representation of the sum we are matching in this pattern matching.
*)
condition : SumCondition.t ;
(*
The union of all assertion we know verified statically, growing as long as
we traverse patterns.
*)
shared_dot : int FieldMap.t PathMap.t ;
}
(* ========================================================================== *)
let aux_const expr const =
let const = Common.const const in
JsCons.Expr.strict_equality expr const
let aux_size expr size =
let size = JsCons.Expr.int size in
let object_size = JsCons.Expr.call ~pure:true Common.ClientLib.size [ expr ] in
JsCons.Expr.strict_equality object_size size
let aux_build_guard ~env ~menv ~rev_path ~assign ~ident ~check ~special_bool_hack =
match special_bool_hack with
| Some (`onlybool present)->
if present
then
assign
else
JsCons.Expr.not_ assign
| Some (`partialbool present)->
JsCons.Expr.strict_equality assign (JsCons.Expr.bool present)
| _ ->
let maybe_js_false =
let gamma = env.E.gamma in
let ty = SumAnalysis.ty gamma ~rev_path menv.sum in
Common.maybe_js_false gamma ty
in
if maybe_js_false
then
let null = JsCons.Expr.null () in
match ident with
| Some ident ->
let ident = JsCons.Expr.ident ident in
let check =
match check with
| SC.Field present ->
if present
then
JsCons.Expr.neq ident null
else
JsCons.Expr.equality ident null
| SC.Const const ->
aux_const ident const
| SC.Size size ->
aux_size ident size
in
JsCons.Expr.comma [ assign ] check
| None -> (
match check with
| SC.Field present ->
if present
then
JsCons.Expr.neq assign null
else
JsCons.Expr.equality assign null
| SC.Const const ->
aux_const assign const
| SC.Size size ->
aux_size assign size
)
else
match check with
| SC.Field present ->
if present
then
assign
else
JsCons.Expr.not_ assign
| SC.Const const ->
aux_const assign const
| SC.Size size ->
aux_size assign size
(* ========================================================================== *)
let build_guard
~env ~penv ~menv ~minimal_condition ~rev_guards ~matched
~check ~special_bool_hack ~rev_path ~path =
let rec aux ~penv ~menv ~minimal_condition ~rev_guards ~matched ~rev_comma ~rev_path ~path =
match path with
| [] ->
let rev_guards =
let ident = None in
let assign = matched in
let guard = aux_build_guard ~env ~menv ~rev_path ~assign ~ident ~check ~special_bool_hack in
(*
pending comma
*)
let guard = JsCons.Expr.comma (List.rev rev_comma) guard in
guard :: rev_guards
in
(*
We should update the conditions for everything which come after this dot
*)
let decision =
match special_bool_hack with
| Some (`onlybool bool) | Some (`partialbool bool) ->
SC.Check (SC.Field true, (if bool then "true" else "false") :: rev_path)
| _ ->
SC.Check (check, rev_path)
in
let minimal_condition = SumCondition.add decision minimal_condition in
let menv =
(*
With the maximal condition
*)
let condition = SumCondition.add decision menv.condition in
{ menv with
condition ;
}
in
penv, menv, minimal_condition, rev_guards
| field :: path -> (
(*
Update the rev_path
*)
let rev_path = field :: rev_path in
(*
Perform the dot
*)
let penv, var = E.next penv field in
let assign =
let dot =
match path, special_bool_hack with
| [], Some (`maybebool bool)-> (
match bool, field with
| true, "true" ->
JsCons.Expr.call ~pure:true Common.ClientLib.dot_true [ matched ]
| false, "false" ->
JsCons.Expr.call ~pure:true Common.ClientLib.dot_false [ matched ]
| _ ->
(*
Internal error between path, maybebool
*)
OManager.printf "bool:%b -- field:%S@." bool field ;
assert false
)
| _ ->
JsCons.Expr.dot matched field
in
JsCons.Expr.assign_ident var dot
in
(*
add the dot in the sharing environment
*)
let sum_env = SumEnv.add_dot ~rev_path minimal_condition var menv.sum_env in
(*
This is different from last case, because all test about path are present checks,
even in a absent final check. (for guessing if [x.a.b.c] is absent, we should be sure that
[x.a.b] is present in the first place).
*)
let check, decision =
if path = []
then check, (
match special_bool_hack with
| Some (`onlybool bool) | Some (`partialbool bool) ->
SC.Check (SC.Field true, (if bool then "true" else "false") :: rev_path)
| _ ->
SC.Check (check, rev_path)
)
else
let check = SC.Field true in
check, SC.Check (check, rev_path)
in
(*
Enrich the comma, and guards
*)
let rev_comma, rev_guards =
(*
OPTIM: There this is possible that partial dot are implied by the maximial_condition,
without available variables for avoiding the assignement.
In this case, we should use a simple comma instead of a land
*)
let is_implied = SumCondition.implies_decision menv.condition decision in
if is_implied
then
let rev_comma = assign :: rev_comma in
rev_comma, rev_guards
else
let rev_guards =
let ident = Some var in
let guard = aux_build_guard ~env ~menv ~rev_path ~assign ~ident ~check ~special_bool_hack in
(*
pending comma
*)
let guard = JsCons.Expr.comma (List.rev rev_comma) guard in
guard :: rev_guards in
[], rev_guards
in
(*
The next expr matched is now the just inserted var
*)
let matched = JsCons.Expr.ident var in
(*
We should update the conditions
*)
let minimal_condition = SumCondition.add decision minimal_condition in
(*
Enrich the sum_env
*)
let menv =
(*
With the maximal condition
*)
let condition = SumCondition.add decision menv.condition in
{ menv with
condition ;
sum_env ;
}
in
(*
recursive call
*)
if path = []
then
penv, menv, minimal_condition, rev_guards
else
aux ~penv ~menv ~minimal_condition ~rev_guards ~matched ~rev_comma ~rev_path ~path
)
in
let rev_comma = [] in
aux ~penv ~menv ~minimal_condition ~rev_guards ~matched ~rev_comma ~rev_path ~path
(* ========================================================================== *)
let aux_build_decision
~env ~penv ~menv ~minimal_condition ~rev_guards ~matched
~check ~special_bool_hack ~rev_path =
(*
order of call:, Example for x.a.b.c.d
The starting rev_path is taken from the decision.
If this rev_path is not found in the sum_env, We extract its [hd] and completing the path.
Once we find a previous variable assigned to a rev_path, we call [build_guard]
rev_path | path
[ d ; c ; b ; a ] | []
[ c ; b ; a ] | [ d ]
[ b ; a ] | [ c ; d ]
[ a ] | [ b ; c ; d ]
[ ] | [ a ; b ; c ; d ]
*)
let rec find rev_path path =
match SumEnv.find_dot ~rev_path menv.condition menv.sum_env with
| Some ident ->
(*
The ident was found under the maximal_condition, which means that there is no special check
to do to be sure about the definition of this field.
*)
let matched = JsCons.Expr.ident ident in
build_guard
~env ~penv ~menv ~minimal_condition ~rev_guards
~matched ~check ~special_bool_hack ~rev_path ~path
| None -> (
match rev_path with
| [] ->
(*
This is the end, not any partial dot was found,
we should build it now. (nested_dot)
*)
build_guard
~env ~penv ~menv ~minimal_condition ~rev_guards
~matched ~check ~special_bool_hack ~rev_path ~path
| hd :: rev_path ->
(*
This rev_path was not found in the sum_env, but there is a chance
to find a partial one, so we retry with a shorter rev_path, and a longer path
*)
let path = hd :: path in
find rev_path path
)
in
find rev_path []
(* ========================================================================== *)
let build_decision ~env ~penv ~menv ~minimal_condition ~rev_guards ~matched ~decision =
let special_bool_hack = None in
let rec aux ((penv, menv, minimal_condition, rev_guards) as acc) decision =
match decision with
| SC.True ->
acc
| SC.Check (check, rev_path) ->
aux_build_decision
~env ~penv ~menv ~minimal_condition ~rev_guards ~matched
~check ~special_bool_hack ~rev_path
| SC.And list ->
List.fold_left aux acc list
in
#<If:JS_MATCH_COMPILATION $contains "MatchGeneration.build_decision">
let under_condition = menv.condition in
let ((_, menv, minimal_condition, rev_guards) as acc) = aux (penv, menv, minimal_condition, rev_guards) decision in
OManager.printf (
"@[<2>@{<bright>build_decision@}@\n%a@]@\n@[<2>under condition:@\n%a@]@\n"^^
"returns:@\n@[<2>min-cond:@\n%a@]@\n@[<2>and rev_guards:@\n%a@]@\n@[<2>and max-cond:@\n%a@]@\n@."
)
SumCondition.pp_decision decision
SumCondition.pp under_condition
SumCondition.pp minimal_condition
(Format.pp_list " / " (JsPrint.pp#expr ~leading:false)) rev_guards
SumCondition.pp menv.condition
;
acc
#<Else>
aux (penv, menv, minimal_condition, rev_guards) decision
#<End>
(* ========================================================================== *)
let build_dot ~menv ~matched ~rev_path ~maybebool =
let dots =
if maybebool
then (
fun matched path ->
let rec aux acc = function
| [] -> acc
| [ last ] -> (
match last with
| "true" ->
JsCons.Expr.call ~pure:true Common.ClientLib.dot_true [ acc ]
| "false" ->
JsCons.Expr.call ~pure:true Common.ClientLib.dot_false [ acc ]
| _ ->
JsCons.Expr.dot acc last
)
| field :: tl ->
let acc = JsCons.Expr.dot acc field in
aux acc tl
in
aux matched path
)
else (
fun matched path ->
let dot acc field = JsCons.Expr.dot acc field in
List.fold_left dot matched path
)
in
(*
This uses the same order of call than aux_build_decision:
Example for x.a.b.c.d
rev_path | path
[ d ; c ; b ; a ] | []
[ c ; b ; a ] | [ d ]
[ b ; a ] | [ c ; d ]
[ a ] | [ b ; c ; d ]
[ ] | [ a ; b ; c ; d ]
*)
let rec find rev_path path =
match SumEnv.find_dot ~rev_path menv.condition menv.sum_env with
| Some ident ->
let matched = JsCons.Expr.ident ident in
dots matched path
| None -> (
match rev_path with
| [] ->
dots matched path
| hd :: rev_path ->
(*
This rev_path was not found in the sum_env, but there is a chance
to find a partial one, so we retry with a shorter rev_path, and a longer path
*)
let path = hd :: path in
find rev_path path
)
in
find rev_path []
(* ========================================================================== *)
(*
Special dedicated function for the potential boolean case
*)
let aux_boolean
~env ~penv ~menv ~minimal_condition ~implications ~rev_guards ~rev_bindings ~rev_path
~matched ~sub_pat ~colvar ~rowvar ~bool ~unused_pattern =
let fallback_condition = menv.condition in
let fallback_minimal_condition = minimal_condition in
let fallback_sum = menv.sum in
let gamma = env.E.gamma in
let rev_prefix_path = rev_path in
let bool_value = bool = "true" in
let ty_bool = SumAnalysis.ty gamma fallback_sum ~rev_path in
let ty_void = SumAnalysis.ty gamma fallback_sum ~rev_path:(bool::rev_path) in
let analysed_bool_pattern =
if QmlTypesUtils.Inspect.is_type_bool gamma ty_bool
then
`onlybool bool_value
else
if QmlTypesUtils.Inspect.is_type_void gamma ty_void
|| (
let rec aux sub_pat =
match sub_pat with
| P.Fields _ ->
(*
Invariant: if we end-up there, the fields is necessary empty,
meaning that the global pattern is { true } or { false }
*)
true
| P.As (_, pat, _) -> aux pat
| _ -> false
in
aux sub_pat
)
then
`partialbool bool_value
else
`maybebool bool_value
in
let () =
#<If:JS_MATCH_COMPILATION $contains "MatchGeneration.boolean">
OManager.printf (
"@{<bright>aux_boolean@}@\n@[<2>where @{<bright>rev_path@} is: %a@]@\n"^^
"@[<2>@{<bright>analysis@}: %a@]@\n@."
)
Common.pp_path rev_path
pp_analysed_bool analysed_bool_pattern
#<End>
in
let sum = SumAnalysis.from_sum gamma fallback_sum ~rev_path in
let analysed_sum_case =
let sum_case = StringSet.singleton bool in
SumAnalysis.make sum ~rowvar ~colvar ~rev_prefix_path sum_case
in
let rev_path = match analysed_bool_pattern with `maybebool _ -> bool :: rev_path | _ -> rev_path in
let penv, menv, minimal_condition, rev_guards =
(*
case validation
*)
let decisions =
try
SumAnalysis.decisions menv.condition analysed_sum_case
with
| SumCondition.Inconsistency _ ->
unused_pattern ()
in
if Option.is_none decisions
then
penv, menv, minimal_condition, rev_guards
else
let penv, menv, minimal_condition, rev_guards =
let check = SC.Field true in
let special_bool_hack = Some analysed_bool_pattern in
aux_build_decision
~env ~penv ~menv ~minimal_condition ~rev_guards
~matched ~check ~special_bool_hack ~rev_path
in
let acc = penv, menv, minimal_condition, rev_guards in
let penv, menv, minimal_condition, rev_guards =
(*
Add a size guard only in the case maybebool with an open var, or with a closed var
if the bool field appears in at least one other sum case.
*)
match analysed_bool_pattern with
| `maybebool _ ->
if (rowvar = `closed) && (
(colvar = `open_) || (
match SumAnalysis.cases sum with
| None -> true
| Some cases -> (
let count = Array.fold_left (
fun count set ->
if FieldSet.mem bool set then succ count else count
) 0 cases in
count > 1
)
))
then
let check = SC.Size 1 in
let special_bool_hack = None in
aux_build_decision
~env ~penv ~menv ~minimal_condition ~rev_guards
~matched ~check ~special_bool_hack ~rev_path:rev_prefix_path
else
acc
| _ ->
acc
in
penv, menv, minimal_condition, rev_guards
in
(*
subpat binding
*)
let penv, rev_bindings =
(*
Gathering all ident needed to be binded to the void or the contents of the record
*)
let idents =
let rec aux acc = function
| P.Var (_, ident) -> ident :: acc
| P.As (_, pat, ident) -> aux (ident::acc) pat
| _ ->
(*
There is nothing to do in any other cases.
the possible cases there are :
| P.Any -> really nothing to do
| P.Fields [||] -> then, it means we are in the case onlybool, or partial bool,
the test is already handled by the guard.
*)
acc
in
aux [] sub_pat
in
match idents with
| [] ->
penv, rev_bindings
| idents -> (
match analysed_bool_pattern with
| `onlybool _ | `partialbool _ ->
let bind = Common.ClientLib.void in
let fold (penv, rev_bindings) ident =
let penv, ident = E.next_exprident penv ident in
let rev_bindings = (ident, bind) :: rev_bindings in
penv, rev_bindings
in
List.fold_left fold (penv, rev_bindings) idents
| `maybebool _ ->
let fold (penv, rev_bindings) ident =
(*
We should reuse the same identifier used in the test.
*)
let penv, ident = E.next_exprident penv ident in
let bind = build_dot ~menv ~matched ~rev_path ~maybebool:true in
let rev_bindings = (ident, bind) :: rev_bindings in
penv, rev_bindings
in
List.fold_left fold (penv, rev_bindings) idents
)
in
(*
Negation optimization
*)
let implications =
let negation = SumAnalysis.negation fallback_condition analysed_sum_case in
let implications =
match negation with
| None -> implications
| Some decision ->
let implication = fallback_minimal_condition, decision in
Impl.add ~rev_path implication implications
in
implications
in
(*
fallback to the condition before the pattern case validation.
*)
let menv =
let condition = fallback_condition in
{ menv with
condition ;
}
in
penv, menv, minimal_condition, implications, rev_guards, rev_bindings
(* ========================================================================== *)
let aux_pattern ~env ~penv ~menv ~matched ~pat =
let gamma = env.E.gamma in
Return.set_checkpoint_none (fun label ->
let rec aux ~penv ~menv ~minimal_condition ~implications ~rev_guards ~rev_bindings ~rev_path ~pat =
match pat with
(*
SIMPLE CASES const, var, any
*)
| P.Const (_, const) ->
let check = SC.Const const in
let special_bool_hack = None in
let penv, menv, minimal_condition, rev_guards =
aux_build_decision
~env ~penv ~menv ~minimal_condition ~rev_guards
~matched ~check ~special_bool_hack ~rev_path in
penv, menv, minimal_condition, implications, rev_guards, rev_bindings
| P.Var (_, ident) ->
let penv, ident = E.next_exprident penv ident in
let bind = build_dot ~menv ~matched ~rev_path ~maybebool:false in
(*
This will potentially generate some alias, but they
will be solved after that by the local renaming pass.
In particular, all dots already done in the guard part will systematically
generate there an alias.
*)
let rev_bindings = (ident, bind) :: rev_bindings in
penv, menv, minimal_condition, implications, rev_guards, rev_bindings
| P.As (_, pat, ident) ->
let penv, ident = E.next_exprident penv ident in
let bind = build_dot ~menv ~matched ~rev_path ~maybebool:false in
let rev_bindings = (ident, bind) :: rev_bindings in
aux ~penv ~menv ~minimal_condition ~implications ~rev_guards ~rev_bindings ~rev_path ~pat
| P.Any _ ->
penv, menv, minimal_condition, implications, rev_guards, rev_bindings
(*
RECORD CASE
*)
| P.Fields (annot_label, fields, rowvar, colvar) -> (
let unused_pattern () =
let context = QmlError.Context.pos (Annot.pos annot_label) in
QmlError.warning ~wclass:WarningClass.pattern context (
"This pattern is never matched"
);
Return.return label ()
in
let () =
#<If:JS_MATCH_COMPILATION $contains "MatchGeneration.aux_pattern">
OManager.printf (
"@{<bright>compiling pat@}: | %a%a@\n@."
)
(Format.pp_list "." Format.pp_print_string) (List.rev (""::rev_path))
PatternAnalysis.pp pat ;
OManager.printf (
"@{<bright>fallback_condition@} is:@\n%a@]@\n@."
)
SumCondition.pp menv.condition
#<End>
in
(*
detection: special case for potential booleans
*)
match fields with
| [| ("true" |"false") as bool, sub_pat |] when (
let rec aux sub_pat =
match sub_pat with
| P.Fields (_, fields, _, _) -> Array.length fields = 0
| P.Const _ -> false
| P.As (_, pat, _) -> aux pat
| _ -> true
in
aux sub_pat
) ->
aux_boolean
~env ~penv ~menv ~minimal_condition ~implications ~rev_guards ~rev_bindings ~rev_path
~matched ~sub_pat ~colvar ~rowvar ~bool ~unused_pattern
| _ ->
(*
Store the folback informations, for compiling next patterns
*)
let fallback_rev_guards = rev_guards in
let fallback_sum = menv.sum in
let fallback_condition = menv.condition in
let fallback_minimal_condition = minimal_condition in
let rev_prefix_path = rev_path in
(*
What is the sum corresponding to this pattern ?
*)
let sum =
SumAnalysis.from_sum gamma fallback_sum ~rev_path
in
(*
sum case analysis
*)
let analysed_sum_case =
let sum_case =
Array.fold_left (fun acc p -> StringSet.add (fst p) acc) StringSet.empty fields
in
SumAnalysis.make sum ~rowvar ~colvar ~rev_prefix_path sum_case
in
let menv = {
menv with
sum ;
} in
(*
toplevel validation
*)
let penv, menv, minimal_condition, rev_guards =
let decisions =
(*
optimisation: taking informations from previous cases.
static validation (or invalidation) of the pattern
*)
try
SumAnalysis.decisions menv.condition analysed_sum_case
with
(*
If the current condition is inconsistent with one of the decision, this means that
the pattern is invalidated statically.
This is a dead pattern, we simply skip it of the code.
*)
| SumCondition.Inconsistency _ ->
(*
FIXME: what wclass should we use there ?
Probably a part of this analysis will be done by a common pass to the server and
client, so that the user may have more check on patterns. (TODO after prototyping)
*)
unused_pattern ()
in
match decisions with
| None ->
(*
if one of the decisions validating the sum_case is implied by the
accumulated condition state of the match_env, there is nothing to check at
this level.
*)
penv, menv, minimal_condition, rev_guards
| Some decisions -> (
(*
we should validate the sum_case, using one of the returned decisions
*)
(*
collecting toplevel fields which will be doted anyway in the guard,
this is used for applying the heuristic about decisions filtering
*)
let to_dot = Option.default FieldMap.empty
(PathMap.find_opt rev_prefix_path menv.shared_dot)
in
let to_dot = Array.fold_left (
fun to_dot (field, pat) ->
match pat with
| P.Var (_, ident) -> (
match Ident.renaming_should_warn_when ident with
| `unused | `never -> FieldMap.add field Priority.var to_dot
| `used -> to_dot
)
| P.Const _ ->
FieldMap.add field Priority.const to_dot
| P.Fields (_, fields, _, _) ->
if Array.length fields > 0
then
FieldMap.add field Priority.fields to_dot
else
to_dot
| _ -> to_dot
) to_dot fields
in
let () =
#<If:JS_MATCH_COMPILATION $contains "SumAnalysis.Filter">
OManager.printf (
"@[<2>@{<bright>filtering decisions@}:@\nrev_path=[%a]@\nto_dot={%a}@]@\n@."
)
Common.pp_path rev_prefix_path
(FieldMap.pp " ; " (Format.pp_fmt "%s:%d")) to_dot
#<End>
in
(*
use heuristics for choosing a final choice about what decision we want to use
*)
let decision =
let sum = menv.sum in
SumAnalysis.Filter.final_choice
~rev_prefix_path
~gamma
~sum
~to_dot
decisions
in
(*
<!> Optimization there:
It could be so that a part of the decision is already implied by the current condition,
without beeing fully implied.
FIXME: this is innefficient, a first filter has already been done in the List.exists
*)
let decision =
if SumCondition.is_conjonction decision
then
SumCondition.filter menv.condition decision
else
decision
in