Source file tac2entries.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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
module SynclassDyn = Dyn.Make()
open Pp
open Util
open CAst
open CErrors
open Names
open Libnames
open Libobject
open Nametab
open Tac2expr
open Tac2print
open Tac2intern
(** Grammar entries *)
module Pltac =
struct
let ltac2_expr = Procq.Entry.make "ltac2_expr"
let tac2expr_in_env = Procq.Entry.make "tac2expr_in_env"
let q_ident = Procq.Entry.make "q_ident"
let q_bindings = Procq.Entry.make "q_bindings"
let q_with_bindings = Procq.Entry.make "q_with_bindings"
let q_intropattern = Procq.Entry.make "q_intropattern"
let q_intropatterns = Procq.Entry.make "q_intropatterns"
let q_destruction_arg = Procq.Entry.make "q_destruction_arg"
let q_induction_clause = Procq.Entry.make "q_induction_clause"
let q_conversion = Procq.Entry.make "q_conversion"
let q_orient = Procq.Entry.make "q_orient"
let q_rewriting = Procq.Entry.make "q_rewriting"
let q_clause = Procq.Entry.make "q_clause"
let q_dispatch = Procq.Entry.make "q_dispatch"
let q_occurrences = Procq.Entry.make "q_occurrences"
let q_reference = Procq.Entry.make "q_reference"
let q_strategy_flag = Procq.Entry.make "q_strategy_flag"
let q_constr_matching = Procq.Entry.make "q_constr_matching"
let q_goal_matching = Procq.Entry.make "q_goal_matching"
let q_hintdb = Procq.Entry.make "q_hintdb"
let q_move_location = Procq.Entry.make "q_move_location"
let q_pose = Procq.Entry.make "q_pose"
let q_assert = Procq.Entry.make "q_assert"
end
let () =
let entries = [
Procq.Entry.Any Pltac.ltac2_expr;
] in
Procq.register_grammars_by_name "ltac2" entries
(** Tactic definition *)
type tacdef = {
tacdef_local : bool;
tacdef_mutable : bool;
tacdef_expr : glb_tacexpr;
tacdef_type : type_scheme;
tacdef_deprecation : Deprecation.t option;
}
let define_tacdef ((_,kn), def) =
let data = {
Tac2env.gdata_expr = def.tacdef_expr;
gdata_type = def.tacdef_type;
gdata_mutable = def.tacdef_mutable;
gdata_deprecation = def.tacdef_deprecation;
gdata_mutation_history = [];
} in
Tac2env.define_global kn data
let push_tacdef visibility ((sp, kn), def) =
if not def.tacdef_local then Tac2env.push_ltac visibility sp (TacConstant kn)
let load_tacdef i obj =
push_tacdef (Until i) obj;
define_tacdef obj
let open_tacdef i obj = push_tacdef (Exactly i) obj
let cache_tacdef ((sp, kn), def as obj) =
Tac2env.push_ltac (Until 1) sp (TacConstant kn);
define_tacdef obj
let subst_tacdef (subst, def) =
let expr' = subst_expr subst def.tacdef_expr in
let type' = subst_type_scheme subst def.tacdef_type in
if expr' == def.tacdef_expr && type' == def.tacdef_type then def
else { def with tacdef_expr = expr'; tacdef_type = type' }
let classify_tacdef o = Substitute
let inTacDef : Id.t -> tacdef -> obj =
declare_named_object {(default_object "TAC2-DEFINITION") with
cache_function = cache_tacdef;
load_function = load_tacdef;
open_function = filtered_open open_tacdef;
subst_function = subst_tacdef;
classify_function = classify_tacdef}
(** Type definition *)
type typdef = {
typdef_local : bool;
typdef_abstract : bool;
typdef_expr : glb_quant_typedef;
}
let change_kn_label kn id =
let mp = KerName.modpath kn in
KerName.make mp id
let change_sp_label sp id =
let (dp, _) = Libnames.repr_path sp in
Libnames.make_path dp id
let push_typedef_contents visibility sp kn (_, def) = match def with
| GTydDef _ -> ()
| GTydAlg { galg_constructors = cstrs } ->
let iter (user_warns, c, _) =
let spc = change_sp_label sp c in
let knc = change_kn_label kn c in
Tac2env.push_constructor ?user_warns visibility spc knc
in
List.iter iter cstrs
| GTydRec fields ->
let iter (c, _, _) =
let spc = change_sp_label sp c in
let knc = change_kn_label kn c in
Tac2env.push_projection visibility spc knc
in
List.iter iter fields
| GTydOpn -> ()
let push_typedef visibility sp kn def =
Tac2env.push_type visibility sp kn;
push_typedef_contents visibility sp kn def
let next i =
let ans = !i in
let () = incr i in
ans
let define_typedef kn (params, def as qdef) = match def with
| GTydDef _ ->
Tac2env.define_type kn qdef
| GTydAlg { galg_constructors = cstrs } ->
let constant = ref 0 in
let nonconstant = ref 0 in
let iter (_warn, c, args) =
let knc = change_kn_label kn c in
let tag = if List.is_empty args then next constant else next nonconstant in
let data = {
Tac2env.cdata_prms = params;
cdata_type = kn;
cdata_args = args;
cdata_indx = Some tag;
} in
Tac2env.define_constructor knc data
in
Tac2env.define_type kn qdef;
List.iter iter cstrs
| GTydRec fs ->
let iter i (id, mut, t) =
let knp = change_kn_label kn id in
let proj = {
Tac2env.pdata_prms = params;
pdata_type = kn;
pdata_ptyp = t;
pdata_mutb = mut;
pdata_indx = i;
} in
Tac2env.define_projection knp proj
in
Tac2env.define_type kn qdef;
List.iteri iter fs
| GTydOpn ->
Tac2env.define_type kn qdef
let perform_typdef vs ((sp, kn), def) =
let expr = def.typdef_expr in
let expr = if def.typdef_abstract then fst expr, GTydDef None else expr in
let () = if not def.typdef_local then push_typedef vs sp kn expr in
define_typedef kn expr
let load_typdef i obj = perform_typdef (Until i) obj
let open_typdef i obj = perform_typdef (Exactly i) obj
let cache_typdef ((sp, kn), def) =
let () = push_typedef (Until 1) sp kn def.typdef_expr in
define_typedef kn def.typdef_expr
let subst_typdef (subst, def) =
let expr' = subst_quant_typedef subst def.typdef_expr in
if expr' == def.typdef_expr then def else { def with typdef_expr = expr' }
let classify_typdef o = Substitute
let inTypDef : Id.t -> typdef -> obj =
declare_named_object {(default_object "TAC2-TYPE-DEFINITION") with
cache_function = cache_typdef;
load_function = load_typdef;
open_function = filtered_open open_typdef;
subst_function = subst_typdef;
classify_function = classify_typdef}
(** Type extension *)
type extension_data = {
edata_warn : UserWarn.t option;
edata_name : Id.t;
edata_args : int glb_typexpr list;
}
type typext = {
typext_local : bool;
typext_prms : int;
typext_type : type_constant;
typext_expr : extension_data list;
}
let push_typext vis prefix def =
let iter data =
let spc = Libnames.add_path_suffix prefix.obj_path data.edata_name in
let knc = KerName.make prefix.obj_mp data.edata_name in
let user_warns = data.edata_warn in
Tac2env.push_constructor ?user_warns vis spc knc
in
List.iter iter def.typext_expr
let define_typext mp def =
let iter data =
let knc = KerName.make mp data.edata_name in
let cdata = {
Tac2env.cdata_prms = def.typext_prms;
cdata_type = def.typext_type;
cdata_args = data.edata_args;
cdata_indx = None;
} in
Tac2env.define_constructor knc cdata
in
List.iter iter def.typext_expr
let cache_typext (prefix, def) =
let () = define_typext prefix.obj_mp def in
push_typext (Until 1) prefix def
let perform_typext vs (prefix, def) =
let () = if not def.typext_local then push_typext vs prefix def in
define_typext prefix.obj_mp def
let load_typext i obj = perform_typext (Until i) obj
let open_typext i obj = perform_typext (Exactly i) obj
let subst_typext (subst, e) =
let open Mod_subst in
let subst_data data =
let edata_args = List.Smart.map (fun e -> subst_type subst e) data.edata_args in
if edata_args == data.edata_args then data
else { data with edata_args }
in
let typext_type = subst_kn subst e.typext_type in
let typext_expr = List.Smart.map subst_data e.typext_expr in
if typext_type == e.typext_type && typext_expr == e.typext_expr then
e
else
{ e with typext_type; typext_expr }
let classify_typext o = Substitute
let inTypExt : typext -> obj =
declare_named_object_gen {(default_object "TAC2-TYPE-EXTENSION") with
cache_function = cache_typext;
load_function = load_typext;
open_function = filtered_open open_typext;
subst_function = subst_typext;
classify_function = classify_typext}
(** Toplevel entries *)
(** Mangle recursive tactics *)
let inline_rec_tactic tactics =
let map (id, e) =
let map_body ({loc;v=id}, e) = CAst.(make ?loc @@ CPatVar (Name id)), e in
let bnd = List.map map_body tactics in
let var_of_id {loc;v=id} =
let qid = qualid_of_ident ?loc id in
CAst.make ?loc @@ CTacRef (RelId qid)
in
let loc0 = e.loc in
let e = CAst.make ?loc:loc0 @@ CTacLet (true, bnd, var_of_id id) in
(id, e)
in
List.map map tactics
let check_lowercase {loc;v=id} =
if Tac2env.is_constructor (Libnames.qualid_of_ident id) then
user_err ?loc (str "The identifier " ++ Id.print id ++ str " must start with a lowercase letter.")
let check_uppercase {loc;v=id} =
if not @@ Tac2env.is_constructor (Libnames.qualid_of_ident id) then
user_err ?loc (str "The identifier " ++ Id.print id ++ str " must start with an uppercase letter.")
let pp_not_value_reason = function
| MutString -> str "(it contains a string literal, and strings are mutable)"
| Application -> str "(it contains an application)"
| MutDef kn -> str "(it contains mutable definition " ++ pr_tacref Id.Set.empty kn
| MutCtor kn -> str "(it contains a constructor of type " ++ pr_typref kn ++ str " which has mutable fields)"
| MutProj kn -> str "(it contains a mutable projection from type " ++ pr_typref kn ++ str ")"
| MaybeValButNotSupported -> mt()
let check_value ?loc e =
match check_value e with
| None -> ()
| Some reason ->
let ppreason = pp_not_value_reason reason in
user_err ?loc
(str "Tactic definition must be a syntactical value" ++
(if ismt ppreason then mt() else spc() ++ ppreason) ++ str "." ++ spc() ++
str "Consider using a thunk.")
let check_ltac_exists {loc;v=id} =
let kn = Lib.make_kn id in
let exists =
try let _ = Tac2env.interp_global kn in true with Not_found -> false
in
if exists then
user_err ?loc (str "Tactic " ++ Names.Id.print id ++ str " already exists")
let register_ltac ?deprecation ?(local = false) ?(mut = false) isrec tactics =
let map ({loc;v=na}, e) =
let id = match na with
| Anonymous ->
user_err ?loc (str "Tactic definition must have a name")
| Name id -> id
in
let () = check_lowercase CAst.(make ?loc id) in
(CAst.(make ?loc id), e)
in
let tactics = List.map map tactics in
let tactics =
if isrec then inline_rec_tactic tactics else tactics
in
let map (lid, ({loc=eloc} as e)) =
let (e, t) = intern ~strict:true [] e in
let () = check_value ?loc:eloc e in
let () = check_ltac_exists lid in
(lid.v, e, t)
in
let defs = List.map map tactics in
let iter (id, e, t) =
let def = {
tacdef_local = local;
tacdef_mutable = mut;
tacdef_expr = e;
tacdef_type = t;
tacdef_deprecation = deprecation;
} in
Lib.add_leaf (inTacDef id def)
in
List.iter iter defs
let qualid_to_ident qid =
if qualid_is_ident qid then CAst.make ?loc:qid.CAst.loc @@ qualid_basename qid
else user_err ?loc:qid.CAst.loc (str "Identifier expected")
let register_typedef ?(local = false) ?(abstract=false) isrec types =
let same_name ({v=id1}, _) ({v=id2}, _) = Id.equal id1 id2 in
let () = match List.duplicates same_name types with
| [] -> ()
| ({loc;v=id}, _) :: _ ->
user_err ?loc (str "Multiple definition of the type name " ++ Id.print id)
in
let () =
let check_existing_type ({v=id},_) =
let (_, kn) = Lib.make_foname id in
try let _ = Tac2env.interp_type kn in
user_err (str "Multiple definition of the type name " ++ Id.print id)
with Not_found -> ()
in
List.iter check_existing_type types
in
let check ({loc;v=id}, (params, def)) =
let same_name {v=id1} {v=id2} = Id.equal id1 id2 in
let () = match List.duplicates same_name params with
| [] -> ()
| {loc;v=id} :: _ ->
user_err ?loc (str "The type parameter " ++ Id.print id ++
str " occurs several times")
in
match def with
| CTydDef _ ->
if isrec then
user_err ?loc (str "The type abbreviation " ++ Id.print id ++
str " cannot be recursive")
| CTydAlg cs ->
let same_name (_, id1, _) (_, id2, _) = Id.equal id1.v id2.v in
let () = match List.duplicates same_name cs with
| [] -> ()
| (_, id, _) :: _ ->
user_err (str "Multiple definitions of the constructor " ++ Id.print id.v)
in
let () = List.iter (fun (_,id,_) -> check_uppercase id) cs in
let () =
let check_existing_ctor (_, id, _) =
let (_, kn) = Lib.make_foname id.v in
try let _ = Tac2env.interp_constructor kn in
user_err (str "Constructor already defined in this module " ++ Id.print id.v)
with Not_found -> ()
in
List.iter check_existing_ctor cs
in
()
| CTydRec ps ->
let same_name (id1, _, _) (id2, _, _) = Id.equal id1 id2 in
let () = match List.duplicates same_name ps with
| [] -> ()
| (id, _, _) :: _ ->
user_err (str "Multiple definitions of the projection " ++ Id.print id)
in
()
| CTydOpn ->
if isrec then
user_err ?loc (str "The open type declaration " ++ Id.print id ++
str " cannot be recursive");
if abstract then
user_err ?loc (str "Open types currently do not support #[abstract].")
in
let () = List.iter check types in
let self =
if isrec then
let fold accu ({v=id}, (params, _)) =
Id.Map.add id (Lib.make_kn id, List.length params) accu
in
List.fold_left fold Id.Map.empty types
else Id.Map.empty
in
let map ({v=id}, def) =
let typdef = {
typdef_local = local;
typdef_abstract = abstract;
typdef_expr = intern_typedef self def;
} in
(id, typdef)
in
let types = List.map map types in
let iter (id, def) = Lib.add_leaf (inTypDef id def) in
List.iter iter types
let register_primitive ?deprecation ?(local = false) ({loc;v=id} as lid) t ml =
let () = check_ltac_exists lid in
let t = intern_open_type t in
let () =
try let _ = Tac2env.interp_primitive ml in () with Not_found ->
user_err ?loc (str "Unregistered primitive " ++
quote (str ml.mltac_plugin) ++ spc () ++ quote (str ml.mltac_tactic))
in
let e = GTacPrm ml in
let def = {
tacdef_local = local;
tacdef_mutable = false;
tacdef_expr = e;
tacdef_type = t;
tacdef_deprecation = deprecation;
} in
Lib.add_leaf (inTacDef id def)
let register_open ?(local = false) qid (params, def) =
let kn =
try Tac2env.locate_type qid
with Not_found ->
user_err ?loc:qid.CAst.loc (str "Unbound type " ++ pr_qualid qid)
in
let (tparams, t) = Tac2env.interp_type kn in
let () = match t with
| GTydOpn -> ()
| GTydAlg _ | GTydRec _ | GTydDef _ ->
user_err ?loc:qid.CAst.loc (str "Type " ++ pr_qualid qid ++ str " is not an open type")
in
let () =
if not (Int.equal (List.length params) tparams) then
Tac2intern.error_nparams_mismatch ?loc:qid.CAst.loc (List.length params) tparams
in
match def with
| CTydOpn -> ()
| CTydAlg def ->
let () =
let same_name (_, id1, _) (_, id2, _) = Id.equal id1.v id2.v in
let () = match List.duplicates same_name def with
| [] -> ()
| (_, id, _) :: _ ->
user_err (str "Multiple definitions of the constructor " ++ Id.print id.v)
in
let check_existing_ctor (_, id, _) =
let (_, kn) = Lib.make_foname id.v in
try let _ = Tac2env.interp_constructor kn in
user_err (str "Constructor already defined in this module " ++ Id.print id.v)
with Not_found -> ()
in
let () = List.iter check_existing_ctor def in
()
in
let intern_type t =
let tpe = CTydDef (Some t) in
let (_, ans) = intern_typedef Id.Map.empty (params, tpe) in
match ans with
| GTydDef (Some t) -> t
| _ -> assert false
in
let map (atts, id, tpe) =
let () = check_uppercase id in
let warn = Attributes.parse Attributes.user_warns atts in
let tpe = List.map intern_type tpe in
{ edata_warn = warn; edata_name = id.v; edata_args = tpe }
in
let def = List.map map def in
let def = {
typext_local = local;
typext_type = kn;
typext_prms = tparams;
typext_expr = def;
} in
Lib.add_leaf (inTypExt def)
| CTydRec _ | CTydDef _ ->
user_err ?loc:qid.CAst.loc (str "Extensions only accept inductive constructors")
let register_type ?local ?abstract isrec types = match types with
| [qid, true, def] ->
let () = if isrec then user_err ?loc:qid.CAst.loc (str "Extensions cannot be recursive.") in
let () = if Option.default false abstract
then user_err ?loc:qid.loc (str "Extensions cannot be abstract.")
in
register_open ?local qid def
| _ ->
let map (qid, redef, def) =
let () = if redef then
user_err ?loc:qid.loc (str "Types can only be extended one by one")
in
(qualid_to_ident qid, def)
in
let types = List.map map types in
register_typedef ?local ?abstract isrec types
let load_import_type i ((sp,kn),orig) =
let def = Tac2env.interp_type orig in
push_typedef_contents (Until i) sp orig def
let open_import_type i ((sp,kn),orig) =
let def = Tac2env.interp_type orig in
push_typedef_contents (Exactly i) sp orig def
let cache_import_type o = load_import_type 1 o
let inImportType =
declare_named_object
{ (default_object "TAC2-IMPORT-TYPE") with
cache_function = cache_import_type;
load_function = load_import_type;
open_function = filtered_open open_import_type;
subst_function = (fun (subst,kn) -> Mod_subst.subst_kn subst kn);
classify_function = (fun _ -> Substitute);
}
let import_type qid as_id =
let () =
if Lib.sections_are_opened() then
CErrors.user_err Pp.(str "Ltac2 Import Type not supported in sections.")
in
match Tac2env.locate_type qid with
| exception Not_found ->
CErrors.user_err ?loc:qid.loc Pp.(str "Unknown Ltac2 type " ++ pr_qualid qid ++ str ".")
| orig ->
let params, _ = Tac2env.interp_type orig in
let alias_def = GTypRef (Other orig, List.init params (fun i -> GTypVar i)) in
Lib.add_leaf (inTypDef as_id {
typdef_local = false;
typdef_abstract = false;
typdef_expr = params, GTydDef (Some alias_def);
});
Lib.add_leaf (inImportType as_id orig)
(** Parsing *)
type 'a token =
| TacTerm of string
| TacNonTerm of Name.t * 'a
type syntax_class_rule =
| SyntaxRule : (raw_tacexpr, _, 'a) Procq.Symbol.t * ('a -> raw_tacexpr) -> syntax_class_rule
module Tac2Custom = KerName
type used_levels = Int.Set.t Tac2Custom.Map.t
let no_used_levels = Tac2Custom.Map.empty
let union_used_levels a b =
Tac2Custom.Map.union (fun _ a b -> Some (Int.Set.union a b)) a b
type 'glb syntax_class_decl = {
intern_synclass : sexpr list -> used_levels * 'glb;
interp_synclass : 'glb -> syntax_class_rule;
}
type syntax_class = SynclassDyn.t
module SynclassInterpMap = SynclassDyn.Map(struct
type 'a t = 'a -> syntax_class_rule
end)
let syntax_class_interns : (sexpr list -> used_levels * SynclassDyn.t) Id.Map.t ref =
ref Id.Map.empty
let syntax_class_interps = ref SynclassInterpMap.empty
module CustomV = struct
include Tac2Custom
let is_var _ = None
let stage = Summary.Stage.Synterp
let summary_name = "ltac2_customentrytab"
end
module CustomTab = Nametab.EasyNoWarn(CustomV)()
let ltac2_custom_map : raw_tacexpr Procq.Entry.t Tac2Custom.Map.t Procq.GramState.field =
Procq.GramState.field "ltac2_custom_map"
let ltac2_custom_entry : (Tac2Custom.t, raw_tacexpr) Procq.entry_command =
Procq.create_entry_command "ltac2" {
eext_fun = (fun kn e state ->
let map = Option.default Tac2Custom.Map.empty (Procq.GramState.get state ltac2_custom_map) in
let map = Tac2Custom.Map.add kn e map in
Procq.GramState.set state ltac2_custom_map map);
eext_name = (fun kn -> "custom-ltac2:" ^ Tac2Custom.to_string kn);
eext_eq = Tac2Custom.equal;
}
let find_custom_entry kn =
Tac2Custom.Map.get kn @@ Option.get @@ Procq.GramState.get (Procq.gramstate()) ltac2_custom_map
let () =
Metasyntax.register_custom_grammar_for_print @@ fun name ->
match CustomTab.locate name with
| exception Not_found -> None
| name -> Some [Any (find_custom_entry name)]
let load_custom_entry i ((sp,kn),local) =
let () = CustomTab.push (Until i) sp kn in
let () = Procq.extend_entry_command ltac2_custom_entry kn in
let () = assert (not local) in
()
let import_custom_entry i ((sp,kn),local) =
let () = CustomTab.push (Exactly i) sp kn in
()
let cache_custom_entry o =
load_custom_entry 1 o;
import_custom_entry 1 o
let inCustomEntry : Id.t -> bool -> Libobject.obj =
declare_named_object {
(default_object "Ltac2 custom entry") with
object_stage = Synterp;
cache_function = cache_custom_entry;
load_function = load_custom_entry;
open_function = filtered_open import_custom_entry;
subst_function = (fun (_,x) -> x);
classify_function = (fun local -> if local then Dispose else Substitute);
}
let check_custom_entry_name id =
if Id.Map.mem id !syntax_class_interns then
CErrors.user_err
Pp.(str "Cannot declare " ++ Id.print id ++
str " as a ltac2 custom entry:" ++ spc() ++
str "that name is already used for a builtin syntactic class.")
else if CustomTab.exists (Lib.make_path id) then
CErrors.user_err Pp.(str "Ltac2 custom entry " ++ Id.print id ++ str " already exists.")
let register_custom_entry name =
let name = name.CAst.v in
check_custom_entry_name name;
let local = false in
Lib.add_leaf (inCustomEntry name local)
let register_syntax_class id (s:_ syntax_class_decl) =
assert (not (Id.Map.mem id !syntax_class_interns));
let tag = SynclassDyn.create (Id.to_string id) in
let intern args =
let used, data = s.intern_synclass args in
used, SynclassDyn.Dyn (tag, data)
in
syntax_class_interns := Id.Map.add id intern !syntax_class_interns;
syntax_class_interps := SynclassInterpMap.add tag s.interp_synclass !syntax_class_interps
let level_name lev = string_of_int lev
let terminal_synclass_tag : string SynclassDyn.tag = SynclassDyn.create "<terminal>"
let interp_terminal str : syntax_class_rule =
let v_unit = CAst.make @@ CTacCst (AbsKn (Tuple 0)) in
SyntaxRule (Procq.Symbol.token (Tok.PIDENT (Some str)), (fun _ -> v_unit))
let () =
syntax_class_interps := SynclassInterpMap.add terminal_synclass_tag interp_terminal !syntax_class_interps
type custom_synclass_data = {
custom_synclass_name : Tac2Custom.t;
custom_synclass_level : int option;
}
let interp_custom_entry data : syntax_class_rule =
let ename = data.custom_synclass_name in
let entry = find_custom_entry ename in
match data.custom_synclass_level with
| None ->
SyntaxRule (Procq.Symbol.nterm entry, (fun expr -> expr))
| Some lev ->
SyntaxRule (Procq.Symbol.nterml entry (level_name lev), (fun expr -> expr))
let custom_synclass_tag : custom_synclass_data SynclassDyn.tag = SynclassDyn.create "<custom>"
let () =
syntax_class_interps := SynclassInterpMap.add custom_synclass_tag interp_custom_entry !syntax_class_interps
let intern_custom_entry ?loc qid ename args : used_levels * custom_synclass_data =
let lev =
match args with
| [] -> None
| [SexprInt {CAst.v=lev}] -> Some lev
| _ :: _ ->
CErrors.user_err ?loc
Pp.(str "Invalid arguments for ltac2 custom entry " ++ pr_qualid qid ++ str ".")
in
let used = match lev with
| None -> no_used_levels
| Some lev -> Tac2Custom.Map.singleton ename (Int.Set.singleton lev)
in
used, { custom_synclass_name = ename;
custom_synclass_level = lev;
}
let intern_syntactic_class ?loc qid args =
let is_class =
if qualid_is_ident qid then Id.Map.find_opt (qualid_basename qid) !syntax_class_interns
else None
in
match is_class with
| Some intern -> intern args
| None ->
match CustomTab.locate qid with
| kn ->
let used, data = intern_custom_entry ?loc qid kn args in
used, SynclassDyn.Dyn (custom_synclass_tag, data)
| exception Not_found ->
CErrors.user_err ?loc (str "Unknown syntactic class" ++ spc () ++ pr_qualid qid)
module ParseToken =
struct
let loc_of_token = function
| SexprStr {loc} -> loc
| SexprInt {loc} -> loc
| SexprRec (loc, _, _) -> Some loc
let intern_syntax_class = function
| SexprRec (_, {loc;v=Some id}, toks) ->
intern_syntactic_class id toks
| SexprStr {v=str} -> no_used_levels, SynclassDyn.Dyn (terminal_synclass_tag, str)
| tok ->
let loc = loc_of_token tok in
CErrors.user_err ?loc (str "Invalid parsing token")
let check_name na =
match na.CAst.v with
| None -> Anonymous
| Some id ->
let id = if qualid_is_ident id then qualid_basename id
else CErrors.user_err ?loc:id.loc Pp.(str "Must be an identifier.")
in
let () = check_lowercase (CAst.make ?loc:na.CAst.loc id) in
Name id
let parse_token = function
| SexprStr {v=s} -> no_used_levels, TacTerm s
| SexprRec (_, na, [tok]) ->
let na = check_name na in
let used, syntax_class = intern_syntax_class tok in
used, TacNonTerm (na, syntax_class)
| tok ->
let loc = loc_of_token tok in
CErrors.user_err ?loc (str "Invalid parsing token")
let name_of_token = function
| SexprStr _ -> Anonymous
| SexprRec (_, na, _) -> check_name na
| tok ->
let loc = loc_of_token tok in
CErrors.user_err ?loc (str "Invalid parsing token")
let rec print_syntax_class = function
| SexprStr s -> str s.CAst.v
| SexprInt i -> int i.CAst.v
| SexprRec (_, {v=na}, []) -> Option.cata pr_qualid (str "_") na
| SexprRec (_, {v=na}, e) ->
Option.cata pr_qualid (str "_") na ++ str "(" ++ pr_sequence print_syntax_class e ++ str ")"
let print_token = function
| SexprStr {v=s} -> quote (str s)
| SexprRec (_, {v=na}, [tok]) -> print_syntax_class tok
| _ -> assert false
end
let intern_syntax_class = ParseToken.intern_syntax_class
type synext = {
synext_kn : KerName.t;
synext_raw : sexpr list;
synext_used : used_levels;
synext_tok : SynclassDyn.t token list;
synext_entry : Tac2Custom.t option * int;
synext_loc : bool;
synext_depr : Deprecation.t option;
}
type krule =
| KRule :
(raw_tacexpr, _, 'act, Loc.t -> raw_tacexpr) Procq.Rule.t *
((Loc.t -> (Name.t * raw_tacexpr) list -> raw_tacexpr) -> 'act) -> krule
let interp_syntax_class (SynclassDyn.Dyn (tag, data)) =
let interp = SynclassInterpMap.find tag !syntax_class_interps in
interp data
let rec get_rule (tok : SynclassDyn.t token list) : krule = match tok with
| [] -> KRule (Procq.Rule.stop, fun k loc -> k loc [])
| TacNonTerm (na, v) :: tok ->
let SyntaxRule (syntax_class, inj) = interp_syntax_class v in
let KRule (rule, act) = get_rule tok in
let rule = Procq.Rule.next rule syntax_class in
let act k e = act (fun loc acc -> k loc ((na, inj e) :: acc)) in
KRule (rule, act)
| TacTerm t :: tok ->
let KRule (rule, act) = get_rule tok in
let rule = Procq.(Rule.next rule (Symbol.token (CLexer.terminal t))) in
let act k _ = act k in
KRule (rule, act)
let deprecated_ltac2_notation =
Deprecation.create_warning
~object_name:"Ltac2 notation"
~warning_name_if_no_since:"deprecated-ltac2-notation"
(fun (toks : sexpr list) -> pr_sequence ParseToken.print_token toks)
let ltac2_levels = Procq.GramState.field "ltac2_levels"
let fresh_level st entry lev =
match entry with
| None -> st, None
| Some entry ->
let all_levels = Option.default Tac2Custom.Map.empty @@ Procq.GramState.get st ltac2_levels in
let entry_levels = Option.default Int.Set.empty @@ Tac2Custom.Map.find_opt entry all_levels in
let last_before = Int.Set.find_first_opt (fun lev' -> lev' >= lev) entry_levels in
if Option.equal Int.equal last_before (Some lev) then st, None
else
let pos = match last_before with
| None -> Gramlib.Gramext.First
| Some lev' -> Gramlib.Gramext.After (level_name lev')
in
let entry_levels = Int.Set.add lev entry_levels in
let all_levels = Tac2Custom.Map.add entry entry_levels all_levels in
let st = Procq.GramState.set st ltac2_levels all_levels in
st, Some pos
let check_levels st used_levels =
let all_levels = Option.default Tac2Custom.Map.empty @@ Procq.GramState.get st ltac2_levels in
let iter kn used =
let known = Option.default Int.Set.empty (Tac2Custom.Map.find_opt kn all_levels) in
let missing = Int.Set.diff used known in
if not (Int.Set.is_empty missing) then
CErrors.user_err
Pp.(str "Unknown " ++ str (String.plural (Int.Set.cardinal missing) "level") ++
str " for ltac2 custom entry " ++ CustomTab.pr kn)
in
Tac2Custom.Map.iter iter used_levels
let perform_notation syn st =
let tok = syn.synext_tok in
let used = syn.synext_used in
let KRule (rule, act) = get_rule tok in
let mk loc args =
let () = match syn.synext_depr with
| None -> ()
| Some depr -> deprecated_ltac2_notation ~loc (syn.synext_raw, depr)
in
let map (na, e) =
((CAst.make ?loc:e.loc na), e)
in
let bnd = List.map map args in
CAst.make ~loc @@ CTacSyn (bnd, syn.synext_kn)
in
let rule = Procq.Production.make rule (act mk) in
let entry, lev = syn.synext_entry in
let st, fresh = fresh_level st entry lev in
let () = check_levels st used in
let pos = Some (level_name lev) in
let rule = match fresh with
| None -> Procq.Reuse (pos, [rule])
| Some pos' ->
Procq.Fresh (pos', [pos, Some BothA, [rule]])
in
let entry = match entry with
| None -> Pltac.ltac2_expr
| Some entry -> find_custom_entry entry
in
[Procq.ExtendRule (entry, rule)], st
let ltac2_notation =
Procq.create_grammar_command "ltac2-notation" { gext_fun = perform_notation; gext_eq = (==) }
let cache_synext syn =
Procq.extend_grammar_command ~ignore_kw:false ltac2_notation syn
let subst_synext (subst, syn) =
let kn = Mod_subst.subst_kn subst syn.synext_kn in
if kn == syn.synext_kn then syn
else { syn with synext_kn = kn }
let classify_synext o =
if o.synext_loc then Dispose else Substitute
let ltac2_notation_cat = Libobject.create_category "ltac2.notations"
let inTac2Notation : synext -> obj =
declare_object {(default_object "TAC2-NOTATION") with
object_stage = Summary.Stage.Synterp;
cache_function = cache_synext;
open_function = simple_open ~cat:ltac2_notation_cat cache_synext;
subst_function = subst_synext;
classify_function = classify_synext}
let cache_synext_interp (local,kn,tac) =
Tac2env.define_notation kn tac
let subst_notation_data subst = function
| Tac2env.UntypedNota body as n ->
let body' = Tac2intern.subst_rawexpr subst body in
if body' == body then n else UntypedNota body'
| TypedNota { nota_prms=prms; nota_argtys=argtys; nota_ty=ty; nota_body=body } as n ->
let body' = Tac2intern.subst_expr subst body in
let argtys' = Id.Map.Smart.map (subst_type subst) argtys in
let ty' = subst_type subst ty in
if body' == body && argtys' == argtys && ty' == ty then n
else TypedNota {nota_body=body'; nota_argtys=argtys'; nota_ty=ty'; nota_prms=prms}
let subst_synext_interp (subst, (local,kn,tac as o)) =
let tac' = subst_notation_data subst tac in
let kn' = Mod_subst.subst_kn subst kn in
if kn' == kn && tac' == tac then o else
(local, kn', tac')
let classify_synext_interp (local,_,_) =
if local then Dispose else Substitute
let inTac2NotationInterp : (bool*KerName.t*Tac2env.notation_data) -> obj =
declare_object {(default_object "TAC2-NOTATION-INTERP") with
cache_function = cache_synext_interp;
open_function = simple_open ~cat:ltac2_notation_cat cache_synext_interp;
subst_function = subst_synext_interp;
classify_function = classify_synext_interp}
type abbreviation = {
abbr_body : raw_tacexpr;
abbr_depr : Deprecation.t option;
}
let perform_abbreviation visibility ((sp, kn), abbr) =
let () = Tac2env.push_ltac visibility sp (TacAlias kn) in
Tac2env.define_alias ?deprecation:abbr.abbr_depr kn abbr.abbr_body
let load_abbreviation i obj = perform_abbreviation (Until i) obj
let open_abbreviation i obj = perform_abbreviation (Exactly i) obj
let cache_abbreviation ((sp, kn), abbr) =
let () = Tac2env.push_ltac (Until 1) sp (TacAlias kn) in
Tac2env.define_alias ?deprecation:abbr.abbr_depr kn abbr.abbr_body
let subst_abbreviation (subst, abbr) =
let body' = subst_rawexpr subst abbr.abbr_body in
if body' == abbr.abbr_body then abbr
else { abbr_body = body'; abbr_depr = abbr.abbr_depr }
let classify_abbreviation o = Substitute
let inTac2Abbreviation : Id.t -> abbreviation -> obj =
declare_named_object {(default_object "TAC2-ABBREVIATION") with
cache_function = cache_abbreviation;
load_function = load_abbreviation;
open_function = filtered_open ~cat:ltac2_notation_cat open_abbreviation;
subst_function = subst_abbreviation;
classify_function = classify_abbreviation}
let rec string_of_syntax_class = function
| SexprStr s -> Printf.sprintf "str(%s)" s.CAst.v
| SexprInt i -> Printf.sprintf "int(%i)" i.CAst.v
| SexprRec (_, {v=na}, []) -> Option.cata string_of_qualid "_" na
| SexprRec (_, {v=na}, e) ->
Printf.sprintf "%s(%s)" (Option.cata string_of_qualid "_" na) (String.concat " " (List.map string_of_syntax_class e))
let string_of_token = function
| SexprStr {v=s} -> Printf.sprintf "str(%s)" s
| SexprRec (_, {v=na}, [tok]) -> string_of_syntax_class tok
| _ -> assert false
let make_fresh_key tokens =
let prods = String.concat "_" (List.map string_of_token tokens) in
let hash = (ModPath.hash (Lib.current_mp ())) land 0x7FFFFFFF in
let lbl = Id.of_string_soft (Printf.sprintf "%s_%08X" prods hash) in
Lib.make_kn lbl
type notation_interpretation_data =
| Abbreviation of Id.t * Deprecation.t option * raw_tacexpr
| Synext of bool * KerName.t * Id.Set.t * raw_tacexpr
type notation_target = qualid option * int option
let pr_register_notation tkn (entry,lev) body =
let pptarget = match entry, lev with
| None, None -> mt()
| None, Some lev -> spc() ++ str ": " ++ int lev
| Some entry, None -> spc() ++ str ": " ++ pr_qualid entry
| Some entry, Some lev ->
spc() ++ str ": " ++ pr_qualid entry ++ str "(" ++ int lev ++ str ")"
in
prlist_with_sep spc Tac2print.pr_syntax_class tkn ++
pptarget ++ spc() ++
hov 2 (str ":= " ++ Tac2print.pr_rawexpr_gen E5 ~avoid:Id.Set.empty body)
let pr_register_abbreviation id body =
Id.print id.CAst.v ++
hov 2 (str ":= " ++ Tac2print.pr_rawexpr_gen E5 ~avoid:Id.Set.empty body)
let register_abbreviation atts id body =
let deprecation = Attributes.(parse deprecation) atts in
let () = check_lowercase id in
Abbreviation(id.CAst.v, deprecation, body)
let warn_deprecated_notation_for_abbreviation =
CWarnings.create ~name:"ltac2-notation-for-abbreviation" ~category:Deprecation.Version.v9_2
(fun () -> strbrk "Use of \"Ltac2 Notation\" keyword for abbreviations is deprecated, use \"Ltac2 Abbreviation\" instead.")
let tactic_qualid = qualid_of_ident (Id.of_string "tactic")
let register_notation atts tkn (entry,lev) body =
match tkn, entry, lev with
| [SexprRec (_, {loc;v=Some id}, [])], None, None ->
warn_deprecated_notation_for_abbreviation ();
let id = if qualid_is_ident id then qualid_basename id
else CErrors.user_err ?loc:id.loc Pp.(str "Must be an identifier.")
in
register_abbreviation atts CAst.(make ?loc id) body
| _ ->
let deprecation, local = Attributes.(parse Notations.(deprecation ++ locality)) atts in
let local = Option.default false local in
let entries = List.map ParseToken.name_of_token tkn in
let fold accu tok = match tok with
| Name id -> Id.Set.add id accu
| Anonymous -> accu
in
let ids = List.fold_left fold Id.Set.empty entries in
let entry = match entry with
| Some entry ->
if qualid_eq entry tactic_qualid then None
else begin
try Some (CustomTab.locate entry)
with Not_found -> CErrors.user_err Pp.(str "Unknown entry " ++ pr_qualid entry ++ str ".")
end
| None -> None
in
let lev = if Option.has_some entry then
let lev = match lev with
| Some lev -> lev
| None -> user_err (str "Custom entry level must be explicit.")
in
let () = if lev < 0 then user_err (str "Custom entry levels must be nonnegative.") in
lev
else match lev with
| Some n ->
let () =
if n < 0 || n > 6 then
user_err (str "Notation levels must range between 0 and 6")
in
n
| None ->
begin match tkn with
| SexprStr s :: _ when Names.Id.is_valid s.CAst.v -> 1
| _ -> 5
end
in
let key = make_fresh_key tkn in
let tokens = List.rev_map ParseToken.parse_token tkn in
let used, tokens = List.split tokens in
let used = List.fold_left union_used_levels no_used_levels used in
let ext = {
synext_kn = key;
synext_raw = tkn;
synext_used = used;
synext_tok = tokens;
synext_entry = (entry,lev);
synext_loc = local;
synext_depr = deprecation;
} in
Lib.add_leaf (inTac2Notation ext);
Synext (local,key,ids,body)
let register_notation_interpretation = function
| Abbreviation (id, deprecation, body) ->
let body = Tac2intern.globalize Id.Set.empty body in
let abbr = { abbr_body = body; abbr_depr = deprecation } in
Lib.add_leaf (inTac2Abbreviation id abbr)
| Synext (local,kn,ids,body) ->
let data = intern_notation_data ids body in
Lib.add_leaf (inTac2NotationInterp (local,kn,data))
type redefinition = {
redef_local : Libobject.locality;
redef_kn : ltac_constant;
redef_body : glb_tacexpr;
redef_old : Id.t option;
}
let perform_redefinition (prefix,redef) =
let kn = redef.redef_kn in
let data = Tac2env.interp_global kn in
let body = match redef.redef_old with
| None -> redef.redef_body
| Some id ->
GTacLet (false, [Name id, data.Tac2env.gdata_expr], redef.redef_body)
in
let history = if Option.has_some redef.redef_old then data.gdata_mutation_history else [] in
let data = {
data with
gdata_expr = body;
gdata_mutation_history = prefix.Libobject.obj_mp :: history;
}
in
Tac2env.define_global kn data
let load_redefinition _ (_,redef as o) =
match redef.redef_local with
| Local -> assert false
| Export -> ()
| SuperGlobal -> perform_redefinition o
let open_redefinition (_,redef as o) =
match redef.redef_local with
| Local -> assert false
| Export -> perform_redefinition o
| SuperGlobal -> ()
let subst_redefinition (subst, redef) =
let kn = Mod_subst.subst_kn subst redef.redef_kn in
let body = Tac2intern.subst_expr subst redef.redef_body in
if kn == redef.redef_kn && body == redef.redef_body then redef
else { redef_local = redef.redef_local;
redef_kn = kn;
redef_body = body;
redef_old = redef.redef_old;
}
let classify_redefinition o = match o.redef_local with
| Local -> Dispose
| Export | SuperGlobal -> Substitute
let inTac2Redefinition : redefinition -> obj =
declare_named_object_gen
{(default_object "TAC2-REDEFINITION") with
cache_function = perform_redefinition;
load_function = load_redefinition;
open_function = simple_open open_redefinition;
subst_function = subst_redefinition;
classify_function = classify_redefinition;
}
let register_redefinition ~local qid old ({loc=eloc} as e) =
let local = match local with
| None -> if Lib.sections_are_opened() then Local else Export
| Some local -> Locality.check_locality_nodischarge Local; local
in
let kn =
try Tac2env.locate_ltac qid
with Not_found -> user_err ?loc:qid.CAst.loc (str "Unknown tactic " ++ pr_qualid qid)
in
let kn = match kn with
| TacConstant kn -> kn
| TacAlias _ ->
user_err ?loc:qid.CAst.loc (str "Cannot redefine syntactic abbreviations")
in
let data = Tac2env.interp_global kn in
let () =
if not (data.Tac2env.gdata_mutable) then
user_err ?loc:qid.CAst.loc (str "The tactic " ++ pr_qualid qid ++ str " is not declared as mutable")
in
let ctx = match old with
| None -> []
| Some { CAst.v = id } -> [id, data.Tac2env.gdata_type]
in
let (e, t) = intern ~strict:true ctx e in
let () = check_value ?loc:eloc e in
let () =
if not (Tac2intern.check_subtype t data.Tac2env.gdata_type) then
let name = int_name () in
user_err ?loc:qid.CAst.loc (str "Type " ++ pr_glbtype name (snd t) ++
str " is not a subtype of " ++ pr_glbtype name (snd data.Tac2env.gdata_type))
in
let old = Option.map (fun { CAst.v = id } -> id) old in
let def = {
redef_local = local;
redef_kn = kn;
redef_body = e;
redef_old = old;
} in
Lib.add_leaf (inTac2Redefinition def)
let perform_eval ~pstate e =
let env = Global.env () in
let (e, ty) = Tac2intern.intern ~strict:false [] e in
let v = Tac2interp.interp Tac2interp.empty_environment e in
let proof =
match pstate with
| None ->
let sigma = Evd.from_env env in
let name = Id.of_string "ltac2" in
Proof.start ~name ~poly:PolyFlags.default sigma []
| Some pstate ->
Declare.Proof.get pstate
in
let (proof, _, ans) = Proof.run_tactic (Global.env ()) v proof in
let { Proof.sigma } = Proof.data proof in
let name = int_name () in
Feedback.msg_notice (str "- : " ++ pr_glbtype name (snd ty)
++ spc () ++ str "=" ++ spc () ++
Tac2print.pr_valexpr env sigma ans (snd ty))
(** Toplevel entries *)
let warn_modtype = CWarnings.create ~name:"ltac2-in-modtype" ~category:CWarnings.CoreCategories.ltac2 ~default:AsError
Pp.(fun what -> strbrk "Ltac2 " ++ str what ++ strbrk " should not be defined inside module types: functor application to arguments of this module type will be unchecked")
let check_modtype what =
if Lib.is_modtype ()
then warn_modtype what
let abstract_att = Attributes.bool_attribute ~name:"abstract"
let register_struct atts str = match str with
| StrVal (mut, isrec, e) ->
check_modtype "definitions";
let deprecation, local = Attributes.(parse Notations.(deprecation ++ locality)) atts in
register_ltac ?deprecation ?local ~mut isrec e
| StrTyp (isrec, t) ->
check_modtype "types";
let local, abstract = Attributes.(parse Notations.(locality ++ abstract_att)) atts in
register_type ?local ?abstract isrec t
| StrPrm (id, t, ml) ->
check_modtype "externals";
let deprecation, local = Attributes.(parse Notations.(deprecation ++ locality)) atts in
register_primitive ?deprecation ?local id t ml
| StrMut (qid, old, e) ->
let local = Attributes.(parse explicit_hint_locality) atts in
register_redefinition ~local qid old e
(** Toplevel exception *)
let { Goptions.get = compact_bt } =
Goptions.declare_bool_option_and_ref ~key:["Ltac2";"Backtrace";"Compact"] ~value:true ()
let pr_frame = function
| FrAnon e ->
if compact_bt() then str "Call <fun>"
else str "Call {" ++ pr_glbexpr ~avoid:Id.Set.empty e ++ str "}"
| FrLtac kn ->
str "Call " ++ pr_tacref Id.Set.empty kn
| FrPrim ml ->
str "Prim <" ++ str ml.mltac_plugin ++ str ":" ++ str ml.mltac_tactic ++ str ">"
| FrExtn (tag, arg) ->
if compact_bt() then fmt "Extn <%s>" (Tac2dyn.Arg.repr tag)
else
let obj = Tac2env.interp_ml_object tag in
let env = Global.env () in
let sigma = Evd.from_env env in
str "Extn " ++ str (Tac2dyn.Arg.repr tag) ++ str ":" ++ spc () ++
obj.Tac2env.ml_print env sigma arg
let print_raw_error kn args =
let t_exn = KerName.make Tac2env.rocq_prefix (Id.of_string "exn") in
let v = Tac2ffi.of_open (kn, args) in
let t = GTypRef (Other t_exn, []) in
let c = Tac2print.pr_valexpr (Global.env ()) Evd.empty v t in
hov 0 (str "Uncaught Ltac2 exception:" ++ spc () ++ hov 0 c)
let print_error kn args =
let env = Global.env() in
let sigma = Evd.from_env env in
let user_print = KerName.make Tac2quote.Refs.control_prefix (Id.of_string "print_exn") in
let user_print = Tac2interp.eval_global user_print in
let user_print = Tac2ffi.(to_fun1 of_exn (to_option to_pp)) user_print in
let user_print () =
let res, _, _, _, _ =
Proofview.apply ~name:(Id.of_string_soft "ltac2 error printing") ~poly:PolyFlags.default
env
(user_print (Tac2interp.LtacError (kn, args), Exninfo.null))
(snd @@ Proofview.init sigma [])
in
res
in
match user_print() with
| Some msg -> msg
| None -> print_raw_error kn args
| exception e when CErrors.noncritical e ->
let e = Exninfo.capture e in
let ppe = match e with
| Tac2interp.LtacError (kn', args'), _info ->
print_raw_error kn' args'
| _ -> CErrors.iprint e
in
print_raw_error kn args ++ fnl() ++
hov 2 (str "Custom Ltac2 printer failed:" ++ spc() ++ ppe)
let () = register_handler begin function
| Tac2interp.LtacError (kn, args) -> Some (print_error kn args)
| _ -> None
end
let () = CErrors.register_additional_error_info begin fun info ->
if !Tac2bt.print_ltac2_backtrace then
let bt = Exninfo.get info Tac2bt.backtrace in
match bt with
| None -> None
| Some bt ->
let bt = List.rev bt in
let bt =
str "Backtrace:" ++ fnl () ++ prlist_with_sep fnl pr_frame bt ++ fnl ()
in
Some bt
else None
end
(** Printing *)
let print_constant ~print_def qid ?info data =
let e = data.Tac2env.gdata_expr in
let (_, t) = data.Tac2env.gdata_type in
let ismut = if data.gdata_mutable then spc() ++ str "(* mutable *)" else mt() in
let history = if not print_def then mt()
else match data.gdata_mutation_history with
| [] -> mt ()
| mods ->
let pr_one mp =
let qid = try Nametab.shortest_qualid_of_module mp
with Not_found ->
try Nametab.shortest_qualid_of_dir (DirOpenModule mp)
with Not_found -> Nametab.shortest_qualid_of_dir (DirOpenModtype mp)
in
pr_qualid qid
in
let redef = prlist_with_sep fnl pr_one mods in
fnl () ++ str "Redefined by:" ++ fnl () ++ redef
in
let name = int_name () in
let def = if print_def then
fnl () ++ hov 2
(pr_qualid qid ++ spc () ++ str ":=" ++ spc () ++ pr_glbexpr ~avoid:Id.Set.empty e)
else mt()
in
let info = match info with
| None -> mt()
| Some info -> fnl() ++ fnl() ++ hov 2 (str "Compiled as" ++ spc() ++ str info.Tac2env.source)
in
hov 0 (
hov 2 (pr_qualid qid ++ spc () ++ str ":" ++ spc () ++ pr_glbtype name t ++ ismut) ++ def ++ info ++ history
)
let print_type ~print_def qid kn =
let nparams, data = Tac2env.interp_type kn in
let name = int_name () in
let params = List.init nparams (fun i -> GTypVar i) in
let ty = match params with
| [] -> pr_qualid qid
| [t] -> pr_glbtype name t ++ spc() ++ pr_qualid qid
| _ -> surround (prlist_with_sep pr_comma (pr_glbtype name) params) ++ spc() ++ pr_qualid qid
in
let def = if not print_def || (match data with GTydDef None -> true | _ -> false)
then mt()
else spc() ++ str ":= " ++ match data with
| GTydDef None -> assert false
| GTydDef (Some t) -> pr_glbtype name t
| GTydAlg { galg_constructors = [] } -> str "[ ]"
| GTydAlg { galg_constructors = ctors } ->
let pr_ctor (_, id, argtys) =
hov 0
(Id.print id ++ if CList.is_empty argtys then mt()
else spc() ++surround (prlist_with_sep pr_comma (pr_glbtype name) argtys))
in
hv 0 (str "[ " ++ prlist_with_sep (fun () -> spc() ++ str "| ") pr_ctor ctors ++ str " ]")
| GTydRec fields ->
let pr_field (id, ismut, t) =
hov 0 ((if ismut then str "mutable " else mt()) ++ Id.print id
++ spc() ++ str ": " ++ pr_glbtype name t) ++ str ";"
in
hv 2 (str "{ " ++ prlist_with_sep spc pr_field fields ++ str " }")
| GTydOpn ->
let ctors = KerName.Map.bindings (Tac2env.find_all_constructors_in_type kn) in
if CList.is_empty ctors then str "[ .. ]"
else
let pr_ctor (ckn, cdata) =
let argtys = cdata.Tac2env.cdata_args in
hov 0
(Tac2print.pr_constructor ckn ++ if CList.is_empty argtys then mt()
else spc() ++surround (prlist_with_sep pr_comma (pr_glbtype name) argtys))
in
hov 0 (str "[ .." ++ spc() ++ str "| "
++ prlist_with_sep (fun () -> spc() ++ str "| ") pr_ctor ctors
++ str " ]")
in
hov 2 (ty ++ def)
let print_tacref ~print_def qid = function
| TacConstant kn ->
let data = Tac2env.interp_global kn in
let info = Option.map fst (Tac2env.get_compiled_global kn) in
print_constant ~print_def qid data ?info
| TacAlias kn ->
let { Tac2env.alias_body = body } = Tac2env.interp_alias kn in
str "Notation" ++ spc() ++ pr_qualid qid ++ str " :=" ++ spc()
++ Tac2print.pr_rawexpr_gen E5 ~avoid:Id.Set.empty body
let print_constructor qid kn =
let cdata = Tac2env.interp_constructor kn in
let name = int_name () in
let ty = GTypRef (Other cdata.cdata_type, List.init cdata.cdata_prms (fun i -> GTypVar i)) in
let ty = List.fold_right (fun arg ty -> GTypArrow (arg,ty)) cdata.cdata_args ty in
pr_qualid qid ++ spc() ++ str ": " ++ Tac2print.pr_glbtype name ty
let locatable_ltac2 = "Ltac2"
type ltac2_object =
| Type of type_constant
| Constructor of ltac_constructor
| TacRef of tacref
let locate_object qid =
try Type (Tac2env.locate_type qid)
with Not_found ->
try Constructor (Tac2env.locate_constructor qid)
with Not_found ->
TacRef (Tac2env.locate_ltac qid)
let locate_all_object qid =
let open Tac2env in
(List.map (fun x -> Type x) (locate_extended_all_type qid))
@ (List.map (fun x -> Constructor x) (locate_extended_all_constructor qid))
@ (List.map (fun x -> TacRef x) (locate_extended_all_ltac qid))
let shortest_qualid_of_object = function
| Type kn -> Tac2env.shortest_qualid_of_type kn
| Constructor kn -> Tac2env.shortest_qualid_of_constructor kn
| TacRef kn -> Tac2env.shortest_qualid_of_ltac Id.Set.empty kn
let path_of_object = function
| Type kn -> Tac2env.path_of_type kn
| Constructor kn -> Tac2env.path_of_constructor kn
| TacRef kn -> Tac2env.path_of_ltac kn
let print_object ~print_def qid = function
| Type kn -> str "Ltac2 Type" ++ spc() ++ print_type ~print_def qid kn
| Constructor kn -> str "Ltac2 constructor" ++ spc() ++ print_constructor qid kn
| TacRef kn -> str "Ltac2 " ++ print_tacref ~print_def qid kn
let () =
let open Prettyp in
let locate qid = try Some (qid, locate_object qid) with Not_found -> None in
let locate_all qid = List.map (fun x -> qid, x) (locate_all_object qid) in
let shortest_qualid (_,kn) = shortest_qualid_of_object kn in
let name (_,kn) =
let hdr = match kn with
| Type _ -> str "Ltac2 Type"
| TacRef (TacConstant _) -> str "Ltac2"
| TacRef (TacAlias _) -> str "Ltac2 Notation"
| Constructor _ -> str "Ltac2 Constructor"
in
hdr ++ spc () ++ pr_path (path_of_object kn)
in
let print (qid,kn) = print_object ~print_def:true qid kn in
let about (qid,kn) = print_object ~print_def:false qid kn in
register_locatable locatable_ltac2 {
locate;
locate_all;
shortest_qualid;
name;
print;
about;
}
let print_located_tactic qid =
Feedback.msg_notice (Prettyp.print_located_other (Global.env ()) locatable_ltac2 qid)
let print_ltac2 qid =
if Tac2env.is_constructor qid then
let kn =
try Tac2env.locate_constructor qid
with Not_found -> user_err ?loc:qid.CAst.loc (str "Unknown constructor " ++ pr_qualid qid)
in
Feedback.msg_notice (print_constructor qid kn)
else
let kn =
try Tac2env.locate_ltac qid
with Not_found -> user_err ?loc:qid.CAst.loc (str "Unknown tactic " ++ pr_qualid qid)
in
Feedback.msg_notice (print_tacref ~print_def:true qid kn)
let print_ltac2_type qid =
match Tac2env.locate_type qid with
| exception Not_found -> user_err ?loc:qid.CAst.loc (str "Unknown Ltac2 type " ++ pr_qualid qid)
| kn ->
Feedback.msg_notice (print_type ~print_def:true qid kn)
let print_signatures () =
let entries = KerName.Map.bindings (Tac2env.globals ()) in
let sort (kn1, _) (kn2, _) = KerName.compare kn1 kn2 in
let entries = List.sort sort entries in
let map (kn, entry) =
let qid =
try Some (Tac2env.shortest_qualid_of_ltac Id.Set.empty (TacConstant kn))
with Not_found -> None
in
match qid with
| None -> None
| Some qid -> Some (qid, entry)
in
let entries = List.map_filter map entries in
let pr_entry (qid, data) =
hov 2 (print_constant ~print_def:false qid data)
in
Feedback.msg_notice (prlist_with_sep fnl pr_entry entries)
let typecheck_expr e =
let e, (_,t) = Tac2intern.intern ~strict:false [] e in
let name = int_name() in
let pp =
pr_glbexpr_gen E5 ~avoid:Id.Set.empty e ++ spc() ++
str ":" ++ spc() ++ pr_glbtype name t
in
Feedback.msg_notice pp
let globalize_expr e =
let avoid = Id.Set.empty in
let e = Tac2intern.debug_globalize_allow_ext avoid e in
Feedback.msg_notice (Tac2print.pr_rawexpr_gen E5 ~avoid e)
(** Calling tactics *)
let ltac2_interp e =
let loc = e.loc in
let (e, t) = intern ~strict:false [] e in
let () = check_unit ?loc t in
let tac = Tac2interp.interp Tac2interp.empty_environment e in
Proofview.tclIGNORE tac
let ComTactic.Interpreter ltac2_interp = ComTactic.register_tactic_interpreter "rocq-runtime.plugins.ltac2" ltac2_interp
let call ~pstate g ~with_end_tac tac =
let g = Option.default (Goal_select.get_default_goal_selector()) g in
ComTactic.solve ~pstate ~with_end_tac g ~info:None (ltac2_interp tac)
let call_par ~pstate tac =
ComTactic.solve_parallel ~pstate ~info:None (ltac2_interp tac) ~abstract:false
(** Primitive algebraic types than can't be defined Rocq-side *)
let register_prim_alg name params def =
let id = Id.of_string name in
let def = List.map (fun (cstr, tpe) -> (None, Id.of_string_soft cstr, tpe)) def in
let getn (const, nonconst) (_, c, args) = match args with
| [] -> (succ const, nonconst)
| _ :: _ -> (const, succ nonconst)
in
let nconst, nnonconst = List.fold_left getn (0, 0) def in
let alg = {
galg_constructors = def;
galg_nconst = nconst;
galg_nnonconst = nnonconst;
} in
let def = (params, GTydAlg alg) in
let def = { typdef_local = false; typdef_abstract = false; typdef_expr = def } in
Lib.add_leaf (inTypDef id def)
let rocq_def n = KerName.make Tac2env.rocq_prefix (Id.of_string n)
let def_unit = {
typdef_local = false;
typdef_abstract = false;
typdef_expr = 0, GTydDef (Some (GTypRef (Tuple 0, [])));
}
let t_list = rocq_def "list"
let () =
let obj () =
let unit = Id.of_string "unit" in
Lib.add_leaf (inTypDef unit def_unit);
register_prim_alg "list" 1 [
("[]", []);
("::", [GTypVar 0; GTypRef (Other t_list, [GTypVar 0])]);
];
in
Mltop.(declare_cache_obj_full (interp_only_obj obj) "rocq-runtime.plugins.ltac2")