Source

mutated_ocaml / camlp4 / Camlp4 / Sig.ml

Full commit
   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
(* camlp4r *)
(****************************************************************************)
(*                                                                          *)
(*                                   OCaml                                  *)
(*                                                                          *)
(*                            INRIA Rocquencourt                            *)
(*                                                                          *)
(*  Copyright  2006   Institut National de Recherche  en  Informatique et   *)
(*  en Automatique.  All rights reserved.  This file is distributed under   *)
(*  the terms of the GNU Library General Public License, with the special   *)
(*  exception on linking described in LICENSE at the top of the OCaml       *)
(*  source tree.                                                            *)
(*                                                                          *)
(****************************************************************************)

(* Authors:
 * - Daniel de Rauglaudre: initial version
 * - Nicolas Pouillard: refactoring
 *)



(** Camlp4 signature repository *)

(** {6 Basic signatures} *)

(** Signature with just a type. *)
module type Type = sig
  type t;
end;

(** Signature for errors modules, an Error modules can be registred with
    the {!ErrorHandler.Register} functor in order to be well printed. *)
module type Error = sig
  type t;
  exception E of t;
  value to_string : t -> string;
  value print : Format.formatter -> t -> unit;
end;

(** A signature for extensions identifiers. *)
module type Id = sig

  (** The name of the extension, typically the module name. *)
  value name    : string;

  (** The version of the extension, typically $ Id$ with a versionning system. *)
  value version : string;

end;

(** A signature for warnings abstract from locations. *)
module Warning (Loc : Type) = struct
  module type S = sig
    type warning = Loc.t -> string -> unit;
    value default_warning : warning;
    value current_warning : ref warning;
    value print_warning   : warning;
  end;
end;

(** {6 Advanced signatures} *)

(** A signature for locations. *)
module type Loc = sig

  (** The type of locations.  Note that, as for OCaml locations,
      character numbers in locations refer to character numbers in the
      parsed character stream, while line numbers refer to line
      numbers in the source file. The source file and the parsed
      character stream differ, for instance, when the parsed character
      stream contains a line number directive. The line number
      directive will only update the file-name field and the
      line-number field of the position. It makes therefore no sense
      to use character numbers with the source file if the sources
      contain line number directives. *)
  type t;

  (** Return a start location for the given file name.
      This location starts at the begining of the file. *)
  value mk : string -> t;

  (** The [ghost] location can be used when no location
      information is available. *)
  value ghost : t;

  (** {6 Conversion functions} *)

  (** Return a location where both positions are set the given position. *)
  value of_lexing_position : Lexing.position -> t;

  (** Return an OCaml location. *)
  value to_ocaml_location : t -> Camlp4_import.Location.t;

  (** Return a location from an OCaml location. *)
  value of_ocaml_location : Camlp4_import.Location.t -> t;

  (** Return a location from ocamllex buffer. *)
  value of_lexbuf : Lexing.lexbuf -> t;

  (** Return a location from [(file_name, start_line, start_bol, start_off,
      stop_line,  stop_bol,  stop_off, ghost)]. *)
  value of_tuple : (string * int * int * int * int * int * int * bool) -> t;

  (** Return [(file_name, start_line, start_bol, start_off,
      stop_line,  stop_bol,  stop_off, ghost)]. *)
  value to_tuple : t -> (string * int * int * int * int * int * int * bool);

  (** [merge loc1 loc2] Return a location that starts at [loc1] and end at
      [loc2]. *)
  value merge : t -> t -> t;

  (** The stop pos becomes equal to the start pos. *)
  value join : t -> t;

  (** [move selector n loc]
      Return the location where positions are moved.
      Affected positions are chosen with [selector].
      Returned positions have their character offset plus [n]. *)
  value move : [= `start | `stop | `both ] -> int -> t -> t;

  (** [shift n loc] Return the location where the new start position is the old
      stop position, and where the new stop position character offset is the
      old one plus [n]. *)
  value shift : int -> t -> t;

  (** [move_line n loc] Return the location with the old line count plus [n].
      The "begin of line" of both positions become the current offset. *)
  value move_line : int -> t -> t;

  (** {6 Accessors} *)

  (** Return the file name *)
  value file_name  : t -> string;

  (** Return the line number of the begining of this location. *)
  value start_line : t -> int;

  (** Return the line number of the ending of this location. *)
  value stop_line  : t -> int;

  (** Returns the number of characters from the begining of the stream
      to the begining of the line of location's begining. *)
  value start_bol  : t -> int;

  (** Returns the number of characters from the begining of the stream
      to the begining of the line of location's ending. *)
  value stop_bol   : t -> int;

  (** Returns the number of characters from the begining of the stream
      of the begining of this location. *)
  value start_off  : t -> int;

  (** Return the number of characters from the begining of the stream
      of the ending of this location. *)
  value stop_off   : t -> int;

  (** Return the start position as a Lexing.position. *)
  value start_pos  : t -> Lexing.position;

  (** Return the stop position as a Lexing.position. *)
  value stop_pos   : t -> Lexing.position;

  (** Generally, return true if this location does not come
      from an input stream. *)
  value is_ghost   : t -> bool;

  (** Return the associated ghost location. *)
  value ghostify   : t -> t;

  (** Return the location with the give file name *)
  value set_file_name : string -> t -> t;

  (** [strictly_before loc1 loc2] True if the stop position of [loc1] is
      strictly_before the start position of [loc2]. *)
  value strictly_before : t -> t -> bool;

  (** Return the location with an absolute file name. *)
  value make_absolute : t -> t;

  (** Print the location into the formatter in a format suitable for error
      reporting. *)
  value print : Format.formatter -> t -> unit;

  (** Print the location in a short format useful for debugging. *)
  value dump  : Format.formatter -> t -> unit;

  (** Same as {!print} but return a string instead of printting it. *)
  value to_string : t -> string;

  (** [Exc_located loc e] is an encapsulation of the exception [e] with
      the input location [loc]. To be used in quotation expanders
      and in grammars to specify some input location for an error.
      Do not raise this exception directly: rather use the following
      function [Loc.raise]. *)
  exception Exc_located of t and exn;

  (** [raise loc e], if [e] is already an [Exc_located] exception,
      re-raise it, else raise the exception [Exc_located loc e]. *)
  value raise : t -> exn -> 'a;

  (** The name of the location variable used in grammars and in
      the predefined quotations for OCaml syntax trees. Default: [_loc]. *)
  value name : ref string;

end;

(** Abstract syntax tree minimal signature.
    Types of this signature are abstract.
    See the {!Camlp4Ast} signature for a concrete definition. *)
module type Ast = sig

  (** {6 Syntactic categories as abstract types} *)

  type loc;
  type meta_bool;
  type meta_option 'a;
  type meta_list 'a;
  type ctyp;
  type patt;
  type expr;
  type module_type;
  type sig_item;
  type with_constr;
  type module_expr;
  type str_item;
  type class_type;
  type class_sig_item;
  type class_expr;
  type class_str_item;
  type match_case;
  type ident;
  type binding;
  type rec_binding;
  type module_binding;
  type rec_flag;
  type direction_flag;
  type mutable_flag;
  type private_flag;
  type virtual_flag;
  type row_var_flag;
  type override_flag;

  (** {6 Location accessors} *)

  value loc_of_ctyp : ctyp -> loc;
  value loc_of_patt : patt -> loc;
  value loc_of_expr : expr -> loc;
  value loc_of_module_type : module_type -> loc;
  value loc_of_module_expr : module_expr -> loc;
  value loc_of_sig_item : sig_item -> loc;
  value loc_of_str_item : str_item -> loc;
  value loc_of_class_type : class_type -> loc;
  value loc_of_class_sig_item : class_sig_item -> loc;
  value loc_of_class_expr : class_expr -> loc;
  value loc_of_class_str_item : class_str_item -> loc;
  value loc_of_with_constr : with_constr -> loc;
  value loc_of_binding : binding -> loc;
  value loc_of_rec_binding : rec_binding -> loc;
  value loc_of_module_binding : module_binding -> loc;
  value loc_of_match_case : match_case -> loc;
  value loc_of_ident : ident -> loc;

  (** {6 Traversals} *)

  (** This class is the base class for map traversal on the Ast.
      To make a custom traversal class one just extend it like that:

      This example swap pairs expression contents:
      open Camlp4.PreCast;
      [class swap = object
        inherit Ast.map as super;
        method expr e =
          match super#expr e with
          \[ <:expr\@_loc< ($e1$, $e2$) >> -> <:expr< ($e2$, $e1$) >>
          | e -> e \];
      end;
      value _loc = Loc.ghost;
      value map = (new swap)#expr;
      assert (map <:expr< fun x -> (x, 42) >> = <:expr< fun x -> (42, x) >>);]
  *)
  class map : object ('self_type)
    method string : string -> string;
    method list : ! 'a 'b . ('self_type -> 'a -> 'b) -> list 'a -> list 'b;
    method meta_bool : meta_bool -> meta_bool;
    method meta_option : ! 'a 'b . ('self_type -> 'a -> 'b) -> meta_option 'a -> meta_option 'b;
    method meta_list : ! 'a 'b . ('self_type -> 'a -> 'b) -> meta_list 'a -> meta_list 'b;
    method loc : loc -> loc;
    method expr : expr -> expr;
    method patt : patt -> patt;
    method ctyp : ctyp -> ctyp;
    method str_item : str_item -> str_item;
    method sig_item : sig_item -> sig_item;

    method module_expr : module_expr -> module_expr;
    method module_type : module_type -> module_type;
    method class_expr : class_expr -> class_expr;
    method class_type : class_type -> class_type;
    method class_sig_item : class_sig_item -> class_sig_item;
    method class_str_item : class_str_item -> class_str_item;
    method with_constr : with_constr -> with_constr;
    method binding : binding -> binding;
    method rec_binding : rec_binding -> rec_binding;
    method module_binding : module_binding -> module_binding;
    method match_case : match_case -> match_case;
    method ident : ident -> ident;
    method override_flag : override_flag -> override_flag;
    method mutable_flag : mutable_flag -> mutable_flag;
    method private_flag : private_flag -> private_flag;
    method virtual_flag : virtual_flag -> virtual_flag;
    method direction_flag : direction_flag -> direction_flag;
    method rec_flag : rec_flag -> rec_flag;
    method row_var_flag : row_var_flag -> row_var_flag;

    method unknown : ! 'a. 'a -> 'a;
  end;

  (** Fold style traversal *)
  class fold : object ('self_type)
    method string : string -> 'self_type;
    method list : ! 'a . ('self_type -> 'a -> 'self_type) -> list 'a -> 'self_type;
    method meta_bool : meta_bool -> 'self_type;
    method meta_option : ! 'a . ('self_type -> 'a -> 'self_type) -> meta_option 'a -> 'self_type;
    method meta_list : ! 'a . ('self_type -> 'a -> 'self_type) -> meta_list 'a -> 'self_type;
    method loc : loc -> 'self_type;
    method expr : expr -> 'self_type;
    method patt : patt -> 'self_type;
    method ctyp : ctyp -> 'self_type;
    method str_item : str_item -> 'self_type;
    method sig_item : sig_item -> 'self_type;
    method module_expr : module_expr -> 'self_type;
    method module_type : module_type -> 'self_type;
    method class_expr : class_expr -> 'self_type;
    method class_type : class_type -> 'self_type;
    method class_sig_item : class_sig_item -> 'self_type;
    method class_str_item : class_str_item -> 'self_type;
    method with_constr : with_constr -> 'self_type;
    method binding : binding -> 'self_type;
    method rec_binding : rec_binding -> 'self_type;
    method module_binding : module_binding -> 'self_type;
    method match_case : match_case -> 'self_type;
    method ident : ident -> 'self_type;
    method rec_flag : rec_flag -> 'self_type;
    method direction_flag : direction_flag -> 'self_type;
    method mutable_flag : mutable_flag -> 'self_type;
    method private_flag : private_flag -> 'self_type;
    method virtual_flag : virtual_flag -> 'self_type;
    method row_var_flag : row_var_flag -> 'self_type;
    method override_flag : override_flag -> 'self_type;

    method unknown : ! 'a. 'a -> 'self_type;
  end;

end;


(** Signature for OCaml syntax trees. *) (*
    This signature is an extension of {!Ast}
    It provides:
      - Types for all kinds of structure.
      - Map: A base class for map traversals.
      - Map classes and functions for common kinds.

    == Core language ==
    ctyp               :: Representaion of types
    patt               :: The type of patterns
    expr               :: The type of expressions
    match_case         :: The type of cases for match/function/try constructions
    ident              :: The type of identifiers (including path like Foo(X).Bar.y)
    binding            :: The type of let bindings
    rec_binding        :: The type of record definitions

    == Modules ==
    module_type        :: The type of module types
    sig_item           :: The type of signature items
    str_item           :: The type of structure items
    module_expr        :: The type of module expressions
    module_binding     :: The type of recursive module definitions
    with_constr        :: The type of `with' constraints

    == Classes ==
    class_type         :: The type of class types
    class_sig_item     :: The type of class signature items
    class_expr         :: The type of class expressions
    class_str_item     :: The type of class structure items
 *)
module type Camlp4Ast = sig

  (** The inner module for locations *)
  module Loc : Loc;

  INCLUDE "camlp4/Camlp4/Camlp4Ast.partial.ml";

  value loc_of_ctyp : ctyp -> loc;
  value loc_of_patt : patt -> loc;
  value loc_of_expr : expr -> loc;
  value loc_of_module_type : module_type -> loc;
  value loc_of_module_expr : module_expr -> loc;
  value loc_of_sig_item : sig_item -> loc;
  value loc_of_str_item : str_item -> loc;
  value loc_of_class_type : class_type -> loc;
  value loc_of_class_sig_item : class_sig_item -> loc;
  value loc_of_class_expr : class_expr -> loc;
  value loc_of_class_str_item : class_str_item -> loc;
  value loc_of_with_constr : with_constr -> loc;
  value loc_of_binding : binding -> loc;
  value loc_of_rec_binding : rec_binding -> loc;
  value loc_of_module_binding : module_binding -> loc;
  value loc_of_match_case : match_case -> loc;
  value loc_of_ident : ident -> loc;

  module Meta : sig
    module type META_LOC = sig
      (* The first location is where to put the returned pattern.
          Generally it's _loc to match with <:patt< ... >> quotations.
          The second location is the one to treat. *)
      value meta_loc_patt : loc -> loc -> patt;
      (* The first location is where to put the returned expression.
          Generally it's _loc to match with <:expr< ... >> quotations.
          The second location is the one to treat. *)
      value meta_loc_expr : loc -> loc -> expr;
    end;
    module MetaLoc : sig
      value meta_loc_patt : loc -> loc -> patt;
      value meta_loc_expr : loc -> loc -> expr;
    end;
    module MetaGhostLoc : sig
      value meta_loc_patt : loc -> 'a -> patt;
      value meta_loc_expr : loc -> 'a -> expr;
    end;
    module MetaLocVar : sig
      value meta_loc_patt : loc -> 'a -> patt;
      value meta_loc_expr : loc -> 'a -> expr;
    end;
    module Make (MetaLoc : META_LOC) : sig
      module Expr : sig
        value meta_string : loc -> string -> expr;
        value meta_int : loc -> string -> expr;
        value meta_float : loc -> string -> expr;
        value meta_char : loc -> string -> expr;
        value meta_bool : loc -> bool -> expr;
        value meta_list : (loc -> 'a -> expr) -> loc -> list 'a -> expr;
        value meta_binding : loc -> binding -> expr;
        value meta_rec_binding : loc -> rec_binding -> expr;
        value meta_class_expr : loc -> class_expr -> expr;
        value meta_class_sig_item : loc -> class_sig_item -> expr;
        value meta_class_str_item : loc -> class_str_item -> expr;
        value meta_class_type : loc -> class_type -> expr;
        value meta_ctyp : loc -> ctyp -> expr;
        value meta_expr : loc -> expr -> expr;
        value meta_ident : loc -> ident -> expr;
        value meta_match_case : loc -> match_case -> expr;
        value meta_module_binding : loc -> module_binding -> expr;
        value meta_module_expr : loc -> module_expr -> expr;
        value meta_module_type : loc -> module_type -> expr;
        value meta_patt : loc -> patt -> expr;
        value meta_sig_item : loc -> sig_item -> expr;
        value meta_str_item : loc -> str_item -> expr;
        value meta_with_constr : loc -> with_constr -> expr;
        value meta_rec_flag : loc -> rec_flag -> expr;
        value meta_mutable_flag : loc -> mutable_flag -> expr;
        value meta_virtual_flag : loc -> virtual_flag -> expr;
        value meta_private_flag : loc -> private_flag -> expr;
        value meta_row_var_flag : loc -> row_var_flag -> expr;
        value meta_override_flag : loc -> override_flag -> expr;
        value meta_direction_flag : loc -> direction_flag -> expr;
      end;
      module Patt : sig
        value meta_string : loc -> string -> patt;
        value meta_int : loc -> string -> patt;
        value meta_float : loc -> string -> patt;
        value meta_char : loc -> string -> patt;
        value meta_bool : loc -> bool -> patt;
        value meta_list : (loc -> 'a -> patt) -> loc -> list 'a -> patt;
        value meta_binding : loc -> binding -> patt;
        value meta_rec_binding : loc -> rec_binding -> patt;
        value meta_class_expr : loc -> class_expr -> patt;
        value meta_class_sig_item : loc -> class_sig_item -> patt;
        value meta_class_str_item : loc -> class_str_item -> patt;
        value meta_class_type : loc -> class_type -> patt;
        value meta_ctyp : loc -> ctyp -> patt;
        value meta_expr : loc -> expr -> patt;
        value meta_ident : loc -> ident -> patt;
        value meta_match_case : loc -> match_case -> patt;
        value meta_module_binding : loc -> module_binding -> patt;
        value meta_module_expr : loc -> module_expr -> patt;
        value meta_module_type : loc -> module_type -> patt;
        value meta_patt : loc -> patt -> patt;
        value meta_sig_item : loc -> sig_item -> patt;
        value meta_str_item : loc -> str_item -> patt;
        value meta_with_constr : loc -> with_constr -> patt;
        value meta_rec_flag : loc -> rec_flag -> patt;
        value meta_mutable_flag : loc -> mutable_flag -> patt;
        value meta_virtual_flag : loc -> virtual_flag -> patt;
        value meta_private_flag : loc -> private_flag -> patt;
        value meta_row_var_flag : loc -> row_var_flag -> patt;
        value meta_override_flag : loc -> override_flag -> patt;
        value meta_direction_flag : loc -> direction_flag -> patt;
      end;
    end;
  end;

  (** See {!Ast.map}. *)
  class map : object ('self_type)
    method string : string -> string;
    method list : ! 'a 'b . ('self_type -> 'a -> 'b) -> list 'a -> list 'b;
    method meta_bool : meta_bool -> meta_bool;
    method meta_option : ! 'a 'b . ('self_type -> 'a -> 'b) -> meta_option 'a -> meta_option 'b;
    method meta_list : ! 'a 'b . ('self_type -> 'a -> 'b) -> meta_list 'a -> meta_list 'b;
    method loc : loc -> loc;
    method expr : expr -> expr;
    method patt : patt -> patt;
    method ctyp : ctyp -> ctyp;
    method str_item : str_item -> str_item;
    method sig_item : sig_item -> sig_item;

    method module_expr : module_expr -> module_expr;
    method module_type : module_type -> module_type;
    method class_expr : class_expr -> class_expr;
    method class_type : class_type -> class_type;
    method class_sig_item : class_sig_item -> class_sig_item;
    method class_str_item : class_str_item -> class_str_item;
    method with_constr : with_constr -> with_constr;
    method binding : binding -> binding;
    method rec_binding : rec_binding -> rec_binding;
    method module_binding : module_binding -> module_binding;
    method match_case : match_case -> match_case;
    method ident : ident -> ident;
    method mutable_flag : mutable_flag -> mutable_flag;
    method private_flag : private_flag -> private_flag;
    method virtual_flag : virtual_flag -> virtual_flag;
    method direction_flag : direction_flag -> direction_flag;
    method rec_flag : rec_flag -> rec_flag;
    method row_var_flag : row_var_flag -> row_var_flag;
    method override_flag : override_flag -> override_flag;

    method unknown : ! 'a. 'a -> 'a;
  end;

  (** See {!Ast.fold}. *)
  class fold : object ('self_type)
    method string : string -> 'self_type;
    method list : ! 'a . ('self_type -> 'a -> 'self_type) -> list 'a -> 'self_type;
    method meta_bool : meta_bool -> 'self_type;
    method meta_option : ! 'a . ('self_type -> 'a -> 'self_type) -> meta_option 'a -> 'self_type;
    method meta_list : ! 'a . ('self_type -> 'a -> 'self_type) -> meta_list 'a -> 'self_type;
    method loc : loc -> 'self_type;
    method expr : expr -> 'self_type;
    method patt : patt -> 'self_type;
    method ctyp : ctyp -> 'self_type;
    method str_item : str_item -> 'self_type;
    method sig_item : sig_item -> 'self_type;
    method module_expr : module_expr -> 'self_type;
    method module_type : module_type -> 'self_type;
    method class_expr : class_expr -> 'self_type;
    method class_type : class_type -> 'self_type;
    method class_sig_item : class_sig_item -> 'self_type;
    method class_str_item : class_str_item -> 'self_type;
    method with_constr : with_constr -> 'self_type;
    method binding : binding -> 'self_type;
    method rec_binding : rec_binding -> 'self_type;
    method module_binding : module_binding -> 'self_type;
    method match_case : match_case -> 'self_type;
    method ident : ident -> 'self_type;
    method rec_flag : rec_flag -> 'self_type;
    method direction_flag : direction_flag -> 'self_type;
    method mutable_flag : mutable_flag -> 'self_type;
    method private_flag : private_flag -> 'self_type;
    method virtual_flag : virtual_flag -> 'self_type;
    method row_var_flag : row_var_flag -> 'self_type;
    method override_flag : override_flag -> 'self_type;

    method unknown : ! 'a. 'a -> 'self_type;
  end;

  value map_expr : (expr -> expr) -> map;
  value map_patt : (patt -> patt) -> map;
  value map_ctyp : (ctyp -> ctyp) -> map;
  value map_str_item : (str_item -> str_item) -> map;
  value map_sig_item : (sig_item -> sig_item) -> map;
  value map_loc : (loc -> loc) -> map;

  value ident_of_expr : expr -> ident;
  value ident_of_patt : patt -> ident;
  value ident_of_ctyp : ctyp -> ident;

  value biAnd_of_list : list binding -> binding;
  value rbSem_of_list : list rec_binding -> rec_binding;
  value paSem_of_list : list patt -> patt;
  value paCom_of_list : list patt -> patt;
  value tyOr_of_list : list ctyp -> ctyp;
  value tyAnd_of_list : list ctyp -> ctyp;
  value tyAmp_of_list : list ctyp -> ctyp;
  value tySem_of_list : list ctyp -> ctyp;
  value tyCom_of_list : list ctyp -> ctyp;
  value tySta_of_list : list ctyp -> ctyp;
  value stSem_of_list : list str_item -> str_item;
  value sgSem_of_list : list sig_item -> sig_item;
  value crSem_of_list : list class_str_item -> class_str_item;
  value cgSem_of_list : list class_sig_item -> class_sig_item;
  value ctAnd_of_list : list class_type -> class_type;
  value ceAnd_of_list : list class_expr -> class_expr;
  value wcAnd_of_list : list with_constr -> with_constr;
  value meApp_of_list : list module_expr -> module_expr;
  value mbAnd_of_list : list module_binding -> module_binding;
  value mcOr_of_list : list match_case -> match_case;
  value idAcc_of_list : list ident -> ident;
  value idApp_of_list : list ident -> ident;
  value exSem_of_list : list expr -> expr;
  value exCom_of_list : list expr -> expr;

  value list_of_ctyp : ctyp -> list ctyp -> list ctyp;
  value list_of_binding : binding -> list binding -> list binding;
  value list_of_rec_binding : rec_binding -> list rec_binding -> list rec_binding;
  value list_of_with_constr : with_constr -> list with_constr -> list with_constr;
  value list_of_patt : patt -> list patt -> list patt;
  value list_of_expr : expr -> list expr -> list expr;
  value list_of_str_item : str_item -> list str_item -> list str_item;
  value list_of_sig_item : sig_item -> list sig_item -> list sig_item;
  value list_of_class_sig_item : class_sig_item -> list class_sig_item -> list class_sig_item;
  value list_of_class_str_item : class_str_item -> list class_str_item -> list class_str_item;
  value list_of_class_type : class_type -> list class_type -> list class_type;
  value list_of_class_expr : class_expr -> list class_expr -> list class_expr;
  value list_of_module_expr : module_expr -> list module_expr -> list module_expr;
  value list_of_module_binding : module_binding -> list module_binding -> list module_binding;
  value list_of_match_case : match_case -> list match_case -> list match_case;
  value list_of_ident : ident -> list ident -> list ident;

  (** Like [String.escape] but takes care to not
      escape antiquotations strings. *)
  value safe_string_escaped : string -> string;

  (** Returns True if the given pattern is irrefutable. *)
  value is_irrefut_patt : patt -> bool;

  value is_constructor : ident -> bool;
  value is_patt_constructor : patt -> bool;
  value is_expr_constructor : expr -> bool;

  value ty_of_stl : (Loc.t * string * list ctyp) -> ctyp;
  value ty_of_sbt : (Loc.t * string * bool * ctyp) -> ctyp;
  value bi_of_pe : (patt * expr) -> binding;
  value pel_of_binding : binding -> list (patt * expr);
  value binding_of_pel : list (patt * expr) -> binding;
  value sum_type_of_list : list (Loc.t * string * list ctyp) -> ctyp;
  value record_type_of_list : list (Loc.t * string * bool * ctyp) -> ctyp;
end;

(** This functor is a restriction functor.
    It takes a Camlp4Ast module and gives the Ast one.
    Typical use is for [with] constraints.
    Example: ... with module Ast = Camlp4.Sig.Camlp4AstToAst Camlp4Ast *)
module Camlp4AstToAst (M : Camlp4Ast) : Ast
  with type loc = M.loc
   and type meta_bool = M.meta_bool
   and type meta_option 'a = M.meta_option 'a
   and type meta_list 'a = M.meta_list 'a
   and type ctyp = M.ctyp
   and type patt = M.patt
   and type expr = M.expr
   and type module_type = M.module_type
   and type sig_item = M.sig_item
   and type with_constr = M.with_constr
   and type module_expr = M.module_expr
   and type str_item = M.str_item
   and type class_type = M.class_type
   and type class_sig_item = M.class_sig_item
   and type class_expr = M.class_expr
   and type class_str_item = M.class_str_item
   and type binding = M.binding
   and type rec_binding = M.rec_binding
   and type module_binding = M.module_binding
   and type match_case = M.match_case
   and type ident = M.ident
   and type rec_flag = M.rec_flag
   and type direction_flag = M.direction_flag
   and type mutable_flag = M.mutable_flag
   and type private_flag = M.private_flag
   and type virtual_flag = M.virtual_flag
   and type row_var_flag = M.row_var_flag
   and type override_flag = M.override_flag
= M;

(** Concrete definition of Camlp4 ASTs abstracted from locations.
    Since the Ast contains locations, this functor produces Ast types
    for a given location type. *)
module MakeCamlp4Ast (Loc : Type) = struct

  INCLUDE "camlp4/Camlp4/Camlp4Ast.partial.ml";

end;

(** {6 Filters} *)

(** A type for stream filters. *)
type stream_filter 'a 'loc = Stream.t ('a * 'loc) -> Stream.t ('a * 'loc);

(** Registerinng and folding of Ast filters.
    Two kinds of filters must be handled:
      - Implementation filters: str_item -> str_item.
      - Interface filters: sig_item -> sig_item. *)
module type AstFilters = sig

  module Ast : Camlp4Ast;

  type filter 'a = 'a -> 'a;

  value register_sig_item_filter : (filter Ast.sig_item) -> unit;
  value register_str_item_filter : (filter Ast.str_item) -> unit;
  value register_topphrase_filter : (filter Ast.str_item) -> unit;

  value fold_interf_filters : ('a -> filter Ast.sig_item -> 'a) -> 'a -> 'a;
  value fold_implem_filters : ('a -> filter Ast.str_item -> 'a) -> 'a -> 'a;
  value fold_topphrase_filters : ('a -> filter Ast.str_item -> 'a) -> 'a -> 'a;

end;

(** ASTs as one single dynamic type *)
module type DynAst = sig
  module Ast : Ast;
  type tag 'a;

  value ctyp_tag : tag Ast.ctyp;
  value patt_tag : tag Ast.patt;
  value expr_tag : tag Ast.expr;
  value module_type_tag : tag Ast.module_type;
  value sig_item_tag : tag Ast.sig_item;
  value with_constr_tag : tag Ast.with_constr;
  value module_expr_tag : tag Ast.module_expr;
  value str_item_tag : tag Ast.str_item;
  value class_type_tag : tag Ast.class_type;
  value class_sig_item_tag : tag Ast.class_sig_item;
  value class_expr_tag : tag Ast.class_expr;
  value class_str_item_tag : tag Ast.class_str_item;
  value match_case_tag : tag Ast.match_case;
  value ident_tag : tag Ast.ident;
  value binding_tag : tag Ast.binding;
  value rec_binding_tag : tag Ast.rec_binding;
  value module_binding_tag : tag Ast.module_binding;

  value string_of_tag : tag 'a -> string;

  module Pack (X : sig type t 'a; end) : sig
    type pack;
    value pack : tag 'a -> X.t 'a -> pack;
    value unpack : tag 'a -> pack -> X.t 'a;
    value print_tag : Format.formatter -> pack -> unit;
  end;
end;


(** {6 Quotation operations} *)

(** The generic quotation type.
    To see how fields are used here is an example:
       <:q_name@q_loc<q_contents>>
    The last one, q_shift is equal to the length of "<:q_name@q_loc<". *)
type quotation =
  { q_name     : string ;
    q_loc      : string ;
    q_shift    : int    ;
    q_contents : string };

(** The signature for a quotation expander registery. *)
module type Quotation = sig
  module Ast : Ast;
  module DynAst : DynAst with module Ast = Ast;
  open Ast;

  (** The [loc] is the initial location. The option string is the optional name
      for the location variable. The string is the quotation contents. *)
  type expand_fun 'a = loc -> option string -> string -> 'a;

  (** [add name exp] adds the quotation [name] associated with the
      expander [exp]. *)
  value add : string -> DynAst.tag 'a -> expand_fun 'a -> unit;

  (** [find name] returns the expander of the given quotation name. *)
  value find : string -> DynAst.tag 'a -> expand_fun 'a;

  (** [default] holds the default quotation name. *)
  value default : ref string;

  (** [parse_quotation_result parse_function loc position_tag quotation quotation_result]
      It's a parser wrapper, this function handles the error reporting for you. *)
  value parse_quotation_result :
    (loc -> string -> 'a) -> loc -> quotation -> string -> string -> 'a;

  (** function translating quotation names; default = identity *)
  value translate : ref (string -> string);

  value expand : loc -> quotation -> DynAst.tag 'a -> 'a;

  (** [dump_file] optionally tells Camlp4 to dump the
      result of an expander if this result is syntactically incorrect.
      If [None] (default), this result is not dumped. If [Some fname], the
      result is dumped in the file [fname]. *)
  value dump_file : ref (option string);

  module Error : Error;

end;

(** {6 Tokens} *)

(** A signature for tokens. *)
module type Token = sig

  module Loc : Loc;

  type t;

  value to_string : t -> string;

  value print : Format.formatter -> t -> unit;

  value match_keyword : string -> t -> bool;

  value extract_string : t -> string;

  module Filter : sig

    type token_filter = stream_filter t Loc.t;

    (** The type for this filter chain.
        A basic implementation just store the [is_keyword] function given
        by [mk] and use it in the [filter] function. *)
    type t;

    (** The given predicate function returns true if the given string
        is a keyword. This function can be used in filters to translate
        identifier tokens to keyword tokens. *)
    value mk : (string -> bool) -> t;

    (** This function allows to register a new filter to the token filter chain.
        You can choose to not support these and raise an exception. *)
    value define_filter : t -> (token_filter -> token_filter) -> unit;

    (** This function filter the given stream and return a filtered stream.
        A basic implementation just match identifiers against the [is_keyword]
        function to produce token keywords instead. *)
    value filter : t -> token_filter;

    (** Called by the grammar system when a keyword is used.
        The boolean argument is True when it's the first time that keyword
        is used. If you do not care about this information just return [()]. *)
    value keyword_added : t -> string -> bool -> unit;

    (** Called by the grammar system when a keyword is no longer used.
        If you do not care about this information just return [()]. *)
    value keyword_removed : t -> string -> unit;
  end;

  module Error : Error;
end;

(** This signature describes tokens for the OCaml and the Revised
    syntax lexing rules. For some tokens the data constructor holds two
    representations with the evaluated one and the source one. For example
    the INT data constructor holds an integer and a string, this string can
    contains more information that's needed for a good pretty-printing
    ("42", "4_2", "0000042", "0b0101010"...).

    The meaning of the tokens are:
-      [KEYWORD s] is the keyword [s].
-      [LIDENT s] is the ident [s] starting with a lowercase letter.
-      [UIDENT s] is the ident [s] starting with an uppercase letter.
-      [INT i s] (resp. [INT32 i s], [INT64 i s] and [NATIVEINT i s])
        the integer constant [i] whose string source is [s].
-      [FLOAT f s] is the float constant [f] whose string source is [s].
-      [STRING s s'] is the string constant [s] whose string source is [s'].
-      [CHAR c s] is the character constant [c] whose string source is [s].
-      [QUOTATION q] is a quotation [q], see {!Quotation.t} for more information.
-      [ANTIQUOT n s] is an antiquotation [n] holding the string [s].
-      [EOI] is the end of input.

     Warning: the second string associated with the constructor [STRING] is
     the string found in the source without any interpretation. In particular,
     the backslashes are not interpreted. For example, if the input is ["\n"]
     the string is *not* a string with one element containing the character
     "return", but a string of two elements: the backslash and the character
     ["n"]. To interpret a string use the first string of the [STRING]
     constructor (or if you need to compute it use the module
     {!Camlp4.Struct.Token.Eval}. Same thing for the constructor [CHAR]. *)
type camlp4_token =
  [ KEYWORD       of string
  | SYMBOL        of string
  | LIDENT        of string
  | UIDENT        of string
  | ESCAPED_IDENT of string
  | INT           of int and string
  | INT32         of int32 and string
  | INT64         of int64 and string
  | NATIVEINT     of nativeint and string
  | FLOAT         of float and string
  | CHAR          of char and string
  | STRING        of string and string
  | LABEL         of string
  | OPTLABEL      of string
  | QUOTATION     of quotation
  | ANTIQUOT      of string and string
  | COMMENT       of string
  | BLANKS        of string
  | NEWLINE
  | LINE_DIRECTIVE of int and option string
  | EOI ];

(** A signature for specialized tokens. *)
module type Camlp4Token = Token with type t = camlp4_token;

(** {6 Dynamic loaders} *)

(** A signature for dynamic loaders. *)
module type DynLoader = sig
  type t;
  exception Error of string and string;

  (** [mk ?ocaml_stdlib ?camlp4_stdlib]
      The stdlib flag is true by default.
      To disable it use: [mk ~ocaml_stdlib:False] *)
  value mk : ?ocaml_stdlib: bool -> ?camlp4_stdlib: bool -> unit -> t;

  (** Fold over the current load path list. *)
  value fold_load_path : t -> (string -> 'a -> 'a) -> 'a -> 'a;

  (** [load f] Load the file [f]. If [f] is not an absolute path name,
      the load path list used to find the directory of [f]. *)
  value load : t -> string -> unit;

  (** [include_dir d] Add the directory [d] in the current load path
      list (like the common -I option). *)
  value include_dir : t -> string -> unit;

  (** [find_in_path f] Returns the full path of the file [f] if
      [f] is in the current load path, raises [Not_found] otherwise. *)
  value find_in_path : t -> string -> string;

  (** [is_native] [True] if we are in native code, [False] for bytecode. *)
  value is_native : bool;
end;

(** A signature for grammars. *)
module Grammar = struct

  (** Internal signature for sematantic actions of grammars,
      not for the casual user. These functions are unsafe. *)
  module type Action = sig
    type  t    ;

    value mk    : 'a ->  t;
    value get   :  t -> 'a;
    value getf  :  t -> ('a -> 'b);
    value getf2 :  t -> ('a -> 'b -> 'c);
  end;

  type assoc =
    [ NonA
    | RightA
    | LeftA ];

  type position =
    [ First
    | Last
    | Before of string
    | After of string
    | Level of string ];

  (** Common signature for {!Sig.Grammar.Static} and {!Sig.Grammar.Dynamic}. *)
  module type Structure = sig
    module Loc    : Loc;
    module Action : Action;
    module Token  : Token with module Loc = Loc;

    type gram;
    type internal_entry;
    type tree;

    type token_pattern = ((Token.t -> bool) * string);
    type token_info;
    type token_stream = Stream.t (Token.t * token_info);

    value token_location : token_info -> Loc.t;

    type symbol =
      [ Smeta of string and list symbol and Action.t
      | Snterm of internal_entry
      | Snterml of internal_entry and string
      | Slist0 of symbol
      | Slist0sep of symbol and symbol
      | Slist1 of symbol
      | Slist1sep of symbol and symbol
      | Sopt of symbol
      | Stry of symbol
      | Sself
      | Snext
      | Stoken of token_pattern
      | Skeyword of string
      | Stree of tree ];

    type production_rule = (list symbol * Action.t);
    type single_extend_statment =
      (option string * option assoc * list production_rule);
    type extend_statment =
      (option position * list single_extend_statment);
    type delete_statment = list symbol;

    type fold 'a 'b 'c =
      internal_entry -> list symbol ->
        (Stream.t 'a -> 'b) -> Stream.t 'a -> 'c;

    type foldsep 'a 'b 'c =
      internal_entry -> list symbol ->
        (Stream.t 'a -> 'b) -> (Stream.t 'a -> unit) -> Stream.t 'a -> 'c;

  end;

  (** Signature for Camlp4 grammars. Here the dynamic means that you can produce as
      many grammar values as needed with a single grammar module.
      If you do not need many grammar values it's preferable to use a static one. *)
  module type Dynamic = sig
    include Structure;

    (** Make a new grammar. *)
    value mk : unit -> gram;

    module Entry : sig
      (** The abstract type of grammar entries. The type parameter is the type
          of the semantic actions that are associated with this entry. *)
      type t 'a;

      (** Make a new entry from the given name. *)
      value mk : gram -> string -> t 'a;

      (** Make a new entry from a name and an hand made token parser. *)
      value of_parser :
        gram -> string -> (token_stream -> 'a) -> t 'a;

      (** Clear the entry and setup this parser instead. *)
      value setup_parser :
        t 'a -> (token_stream -> 'a) -> unit;

      (** Get the entry name. *)
      value name : t 'a -> string;

      (** Print the given entry into the given formatter. *)
      value print : Format.formatter -> t 'a -> unit;

      (** Same as {!print} but show the left-factorization. *)
      value dump : Format.formatter -> t 'a -> unit;

      (**/**)
      value obj : t 'a -> internal_entry;
      value clear : t 'a -> unit;
      (**/**)
    end;

    (** [get_filter g] Get the {!Token.Filter} associated to the [g]. *)
    value get_filter : gram -> Token.Filter.t;

    type not_filtered 'a;

    (** This function is called by the EXTEND ... END syntax. *)
    value extend      : Entry.t 'a -> extend_statment -> unit;

    (** The delete rule. *)
    value delete_rule : Entry.t 'a -> delete_statment -> unit;

    value srules      : Entry.t 'a -> list (list symbol * Action.t) -> symbol;
    value sfold0      : ('a -> 'b -> 'b) -> 'b -> fold _ 'a 'b;
    value sfold1      : ('a -> 'b -> 'b) -> 'b -> fold _ 'a 'b;
    value sfold0sep   : ('a -> 'b -> 'b) -> 'b -> foldsep _ 'a 'b;
    (* value sfold1sep : ('a -> 'b -> 'b) -> 'b -> foldsep _ 'a 'b; *)

    (** Use the lexer to produce a non filtered token stream from a char stream. *)
    value lex : gram -> Loc.t -> Stream.t char -> not_filtered (Stream.t (Token.t * Loc.t));

    (** Token stream from string. *)
    value lex_string : gram -> Loc.t -> string -> not_filtered (Stream.t (Token.t * Loc.t));

    value set_from_lexbuf : 
      (?quotations: bool -> Lexing.lexbuf -> Stream.t (Token.t * Loc.t)) 
    -> unit;
      
    (** Filter a token stream using the {!Token.Filter} module *)
    value filter : gram -> not_filtered (Stream.t (Token.t * Loc.t)) -> token_stream;

    (** Lex, filter and parse a stream of character. *)
    value parse : Entry.t 'a -> Loc.t -> Stream.t char -> 'a;

    (** Same as {!parse} but from a string. *)
    value parse_string : Entry.t 'a -> Loc.t -> string -> 'a;

    (** Parse a token stream that is not filtered yet. *)
    value parse_tokens_before_filter :
      Entry.t 'a -> not_filtered (Stream.t (Token.t * Loc.t)) -> 'a;

    (** Parse a token stream that is already filtered. *)
    value parse_tokens_after_filter :
      Entry.t 'a -> token_stream -> 'a;

  end;

  (** Signature for Camlp4 grammars. Here the static means that there is only
      one grammar value by grammar module. If you do not need to store the grammar
      value it's preferable to use a static one. *)
  module type Static = sig
    include Structure;

    module Entry : sig
      (** The abstract type of grammar entries. The type parameter is the type
          of the semantic actions that are associated with this entry. *)
      type t 'a;

      (** Make a new entry from the given name. *)
      value mk : string -> t 'a;

      (** Make a new entry from a name and an hand made token parser. *)
      value of_parser :
        string -> (token_stream -> 'a) -> t 'a;

      (** Clear the entry and setup this parser instead. *)
      value setup_parser :
        t 'a -> (token_stream -> 'a) -> unit;

      (** Get the entry name. *)
      value name : t 'a -> string;

      (** Print the given entry into the given formatter. *)
      value print : Format.formatter -> t 'a -> unit;

      (** Same as {!print} but show the left-factorization. *)
      value dump : Format.formatter -> t 'a -> unit;

      (**/**)
      value obj : t 'a -> internal_entry;
      value clear : t 'a -> unit;
      (**/**)
    end;

    (** Get the {!Token.Filter} associated to the grammar module. *)
    value get_filter : unit -> Token.Filter.t;

    type not_filtered 'a;

    (** This function is called by the EXTEND ... END syntax. *)
    value extend      : Entry.t 'a -> extend_statment -> unit;

    (** The delete rule. *)
    value delete_rule : Entry.t 'a -> delete_statment -> unit;
    value srules      : Entry.t 'a -> list (list symbol * Action.t) -> symbol;
    value sfold0      : ('a -> 'b -> 'b) -> 'b -> fold _ 'a 'b;
    value sfold1      : ('a -> 'b -> 'b) -> 'b -> fold _ 'a 'b;
    value sfold0sep   : ('a -> 'b -> 'b) -> 'b -> foldsep _ 'a 'b;
    (* value sfold1sep : ('a -> 'b -> 'b) -> 'b -> foldsep _ 'a 'b; *)

    (** Use the lexer to produce a non filtered token stream from a char stream. *)
    value lex : Loc.t -> Stream.t char -> not_filtered (Stream.t (Token.t * Loc.t));

    (** Token stream from string. *)
    value lex_string : Loc.t -> string -> not_filtered (Stream.t (Token.t * Loc.t));

    value set_from_lexbuf : 
      (?quotations: bool -> Lexing.lexbuf -> Stream.t (Token.t * Loc.t)) 
    -> unit;

    (** Filter a token stream using the {!Token.Filter} module *)
    value filter : not_filtered (Stream.t (Token.t * Loc.t)) -> token_stream;

    (** Lex, filter and parse a stream of character. *)
    value parse : Entry.t 'a -> Loc.t -> Stream.t char -> 'a;

    (** Same as {!parse} but from a string. *)
    value parse_string : Entry.t 'a -> Loc.t -> string -> 'a;

    (** Parse a token stream that is not filtered yet. *)
    value parse_tokens_before_filter :
      Entry.t 'a -> not_filtered (Stream.t (Token.t * Loc.t)) -> 'a;

    (** Parse a token stream that is already filtered. *)
    value parse_tokens_after_filter :
      Entry.t 'a -> token_stream -> 'a;

  end;

end;

(** A signature for lexers. *)
module type Lexer = sig
  module Loc : Loc;
  module Token : Token with module Loc = Loc;
  module Error : Error;

  (** The constructor for a lexing function. The character stream is the input
      stream to be lexed. The result is a stream of pairs of a token and
      a location.
      The lexer do not use global (mutable) variables: instantiations
      of [Lexer.mk ()] do not perturb each other. *)
  value mk : unit -> (Loc.t -> Stream.t char -> Stream.t (Token.t * Loc.t));

  value from_lexbuf : 
    ?quotations: bool -> Lexing.lexbuf -> Stream.t (Token.t * Loc.t);

  value set_from_lexbuf : 
    (?quotations: bool -> Lexing.lexbuf -> Stream.t (Token.t * Loc.t)) -> unit;
end;


(** A signature for parsers abstract from ASTs. *)
module Parser (Ast : Ast) = struct
  module type SIMPLE = sig
    (** The parse function for expressions.
        The underlying expression grammar entry is generally "expr; EOI". *)
    value parse_expr : Ast.loc -> string -> Ast.expr;

    (** The parse function for patterns.
        The underlying pattern grammar entry is generally "patt; EOI". *)
    value parse_patt : Ast.loc -> string -> Ast.patt;
  end;

  module type S = sig

    (** Called when parsing an implementation (ml file) to build the syntax
        tree; the returned list contains the phrases (structure items) as a
        single "declare" node (a list of structure items);   if  the parser
        encounter a directive it stops (since the directive may change  the
        syntax), the given [directive_handler] function  evaluates  it  and
        the parsing starts again. *)
    value parse_implem : ?directive_handler:(Ast.str_item -> option Ast.str_item) ->
                        Ast.loc -> Stream.t char -> Ast.str_item;

    (** Same as {!parse_implem} but for interface (mli file). *)
    value parse_interf : ?directive_handler:(Ast.sig_item -> option Ast.sig_item) ->
                        Ast.loc -> Stream.t char -> Ast.sig_item;
  end;
end;

(** A signature for printers abstract from ASTs. *)
module Printer (Ast : Ast) = struct
  module type S = sig

    value print_interf : ?input_file:string -> ?output_file:string ->
                        Ast.sig_item -> unit;
    value print_implem : ?input_file:string -> ?output_file:string ->
                        Ast.str_item -> unit;

  end;
end;

(** A syntax module is a sort of constistent bunch of modules and values.
   In such a module you have a parser, a printer, and also modules for
   locations, syntax trees, tokens, grammars, quotations, anti-quotations.
   There is also the main grammar entries. *)
module type Syntax = sig
  module Loc            : Loc;
  module Ast            : Ast with type loc = Loc.t;
  module Token          : Token with module Loc = Loc;
  module Gram           : Grammar.Static with module Loc = Loc and module Token = Token;
  module Quotation      : Quotation with module Ast = Ast;

  module AntiquotSyntax : (Parser Ast).SIMPLE;

  include (Warning Loc).S;
  include (Parser  Ast).S;
  include (Printer Ast).S;
end;

(** A syntax module is a sort of constistent bunch of modules and values.
    In such a module you have a parser, a printer, and also modules for
    locations, syntax trees, tokens, grammars, quotations, anti-quotations.
    There is also the main grammar entries. *)
module type Camlp4Syntax = sig
  module Loc            : Loc;

  module Ast            : Camlp4Ast with module Loc = Loc;
  module Token          : Camlp4Token with module Loc = Loc;

  module Gram           : Grammar.Static with module Loc = Loc and module Token = Token;
  module Quotation      : Quotation with module Ast = Camlp4AstToAst Ast;

  module AntiquotSyntax : (Parser Ast).SIMPLE;

  include (Warning Loc).S;
  include (Parser  Ast).S;
  include (Printer Ast).S;

  value interf : Gram.Entry.t (list Ast.sig_item * option Loc.t);
  value implem : Gram.Entry.t (list Ast.str_item * option Loc.t);
  value top_phrase : Gram.Entry.t (option Ast.str_item);
  value use_file : Gram.Entry.t (list Ast.str_item * option Loc.t);
  value a_CHAR : Gram.Entry.t string;
  value a_FLOAT : Gram.Entry.t string;
  value a_INT : Gram.Entry.t string;
  value a_INT32 : Gram.Entry.t string;
  value a_INT64 : Gram.Entry.t string;
  value a_LABEL : Gram.Entry.t string;
  value a_LIDENT : Gram.Entry.t string;
  value a_NATIVEINT : Gram.Entry.t string;
  value a_OPTLABEL : Gram.Entry.t string;
  value a_STRING : Gram.Entry.t string;
  value a_UIDENT : Gram.Entry.t string;
  value a_ident : Gram.Entry.t string;
  value amp_ctyp : Gram.Entry.t Ast.ctyp;
  value and_ctyp : Gram.Entry.t Ast.ctyp;
  value match_case : Gram.Entry.t Ast.match_case;
  value match_case0 : Gram.Entry.t Ast.match_case;
  value match_case_quot : Gram.Entry.t Ast.match_case;
  value binding : Gram.Entry.t Ast.binding;
  value binding_quot : Gram.Entry.t Ast.binding;
  value rec_binding_quot : Gram.Entry.t Ast.rec_binding;
  value class_declaration : Gram.Entry.t Ast.class_expr;
  value class_description : Gram.Entry.t Ast.class_type;
  value class_expr : Gram.Entry.t Ast.class_expr;
  value class_expr_quot : Gram.Entry.t Ast.class_expr;
  value class_fun_binding : Gram.Entry.t Ast.class_expr;
  value class_fun_def : Gram.Entry.t Ast.class_expr;
  value class_info_for_class_expr : Gram.Entry.t Ast.class_expr;
  value class_info_for_class_type : Gram.Entry.t Ast.class_type;
  value class_longident : Gram.Entry.t Ast.ident;
  value class_longident_and_param : Gram.Entry.t Ast.class_expr;
  value class_name_and_param : Gram.Entry.t (string * Ast.ctyp);
  value class_sig_item : Gram.Entry.t Ast.class_sig_item;
  value class_sig_item_quot : Gram.Entry.t Ast.class_sig_item;
  value class_signature : Gram.Entry.t Ast.class_sig_item;
  value class_str_item : Gram.Entry.t Ast.class_str_item;
  value class_str_item_quot : Gram.Entry.t Ast.class_str_item;
  value class_structure : Gram.Entry.t Ast.class_str_item;
  value class_type : Gram.Entry.t Ast.class_type;
  value class_type_declaration : Gram.Entry.t Ast.class_type;
  value class_type_longident : Gram.Entry.t Ast.ident;
  value class_type_longident_and_param : Gram.Entry.t Ast.class_type;
  value class_type_plus : Gram.Entry.t Ast.class_type;
  value class_type_quot : Gram.Entry.t Ast.class_type;
  value comma_ctyp : Gram.Entry.t Ast.ctyp;
  value comma_expr : Gram.Entry.t Ast.expr;
  value comma_ipatt : Gram.Entry.t Ast.patt;
  value comma_patt : Gram.Entry.t Ast.patt;
  value comma_type_parameter : Gram.Entry.t Ast.ctyp;
  value constrain : Gram.Entry.t (Ast.ctyp * Ast.ctyp);
  value constructor_arg_list : Gram.Entry.t Ast.ctyp;
  value constructor_declaration : Gram.Entry.t Ast.ctyp;
  value constructor_declarations : Gram.Entry.t Ast.ctyp;
  value ctyp : Gram.Entry.t Ast.ctyp;
  value ctyp_quot : Gram.Entry.t Ast.ctyp;
  value cvalue_binding : Gram.Entry.t Ast.expr;
  value direction_flag : Gram.Entry.t Ast.direction_flag;
  value direction_flag_quot : Gram.Entry.t Ast.direction_flag;
  value dummy : Gram.Entry.t unit;
  value eq_expr : Gram.Entry.t (string -> Ast.patt -> Ast.patt);
  value expr : Gram.Entry.t Ast.expr;
  value expr_eoi : Gram.Entry.t Ast.expr;
  value expr_quot : Gram.Entry.t Ast.expr;
  value field_expr : Gram.Entry.t Ast.rec_binding;
  value field_expr_list : Gram.Entry.t Ast.rec_binding;
  value fun_binding : Gram.Entry.t Ast.expr;
  value fun_def : Gram.Entry.t Ast.expr;
  value ident : Gram.Entry.t Ast.ident;
  value ident_quot : Gram.Entry.t Ast.ident;
  value ipatt : Gram.Entry.t Ast.patt;
  value ipatt_tcon : Gram.Entry.t Ast.patt;
  value label : Gram.Entry.t string;
  value label_declaration : Gram.Entry.t Ast.ctyp;
  value label_declaration_list : Gram.Entry.t Ast.ctyp;
  value label_expr : Gram.Entry.t Ast.rec_binding;
  value label_expr_list : Gram.Entry.t Ast.rec_binding;
  value label_ipatt : Gram.Entry.t Ast.patt;
  value label_ipatt_list : Gram.Entry.t Ast.patt;
  value label_longident : Gram.Entry.t Ast.ident;
  value label_patt : Gram.Entry.t Ast.patt;
  value label_patt_list : Gram.Entry.t Ast.patt;
  value labeled_ipatt : Gram.Entry.t Ast.patt;
  value let_binding : Gram.Entry.t Ast.binding;
  value meth_list : Gram.Entry.t (Ast.ctyp * Ast.row_var_flag);
  value meth_decl : Gram.Entry.t Ast.ctyp;
  value module_binding : Gram.Entry.t Ast.module_binding;
  value module_binding0 : Gram.Entry.t Ast.module_expr;
  value module_binding_quot : Gram.Entry.t Ast.module_binding;
  value module_declaration : Gram.Entry.t Ast.module_type;
  value module_expr : Gram.Entry.t Ast.module_expr;
  value module_expr_quot : Gram.Entry.t Ast.module_expr;
  value module_longident : Gram.Entry.t Ast.ident;
  value module_longident_with_app : Gram.Entry.t Ast.ident;
  value module_rec_declaration : Gram.Entry.t Ast.module_binding;
  value module_type : Gram.Entry.t Ast.module_type;
  value package_type : Gram.Entry.t Ast.module_type;
  value module_type_quot : Gram.Entry.t Ast.module_type;
  value more_ctyp : Gram.Entry.t Ast.ctyp;
  value name_tags : Gram.Entry.t Ast.ctyp;
  value opt_as_lident : Gram.Entry.t string;
  value opt_class_self_patt : Gram.Entry.t Ast.patt;
  value opt_class_self_type : Gram.Entry.t Ast.ctyp;
  value opt_comma_ctyp : Gram.Entry.t Ast.ctyp;
  value opt_dot_dot : Gram.Entry.t Ast.row_var_flag;
  value row_var_flag_quot : Gram.Entry.t Ast.row_var_flag;
  value opt_eq_ctyp : Gram.Entry.t Ast.ctyp;
  value opt_expr : Gram.Entry.t Ast.expr;
  value opt_meth_list : Gram.Entry.t Ast.ctyp;
  value opt_mutable : Gram.Entry.t Ast.mutable_flag;
  value mutable_flag_quot : Gram.Entry.t Ast.mutable_flag;
  value opt_override : Gram.Entry.t Ast.override_flag;
  value override_flag_quot : Gram.Entry.t Ast.override_flag;
  value opt_polyt : Gram.Entry.t Ast.ctyp;
  value opt_private : Gram.Entry.t Ast.private_flag;
  value private_flag_quot : Gram.Entry.t Ast.private_flag;
  value opt_rec : Gram.Entry.t Ast.rec_flag;
  value rec_flag_quot : Gram.Entry.t Ast.rec_flag;
  value opt_virtual : Gram.Entry.t Ast.virtual_flag;
  value virtual_flag_quot : Gram.Entry.t Ast.virtual_flag;
  value opt_when_expr : Gram.Entry.t Ast.expr;
  value patt : Gram.Entry.t Ast.patt;
  value patt_as_patt_opt : Gram.Entry.t Ast.patt;
  value patt_eoi : Gram.Entry.t Ast.patt;
  value patt_quot : Gram.Entry.t Ast.patt;
  value patt_tcon : Gram.Entry.t Ast.patt;
  value phrase : Gram.Entry.t Ast.str_item;
  value poly_type : Gram.Entry.t Ast.ctyp;
  value row_field : Gram.Entry.t Ast.ctyp;
  value sem_expr : Gram.Entry.t Ast.expr;
  value sem_expr_for_list : Gram.Entry.t (Ast.expr -> Ast.expr);
  value sem_patt : Gram.Entry.t Ast.patt;
  value sem_patt_for_list : Gram.Entry.t (Ast.patt -> Ast.patt);
  value semi : Gram.Entry.t unit;
  value sequence : Gram.Entry.t Ast.expr;
  value do_sequence : Gram.Entry.t Ast.expr;
  value sig_item : Gram.Entry.t Ast.sig_item;
  value sig_item_quot : Gram.Entry.t Ast.sig_item;
  value sig_items : Gram.Entry.t Ast.sig_item;
  value star_ctyp : Gram.Entry.t Ast.ctyp;
  value str_item : Gram.Entry.t Ast.str_item;
  value str_item_quot : Gram.Entry.t Ast.str_item;
  value str_items : Gram.Entry.t Ast.str_item;
  value type_constraint : Gram.Entry.t unit;
  value type_declaration : Gram.Entry.t Ast.ctyp;
  value type_ident_and_parameters : Gram.Entry.t (string * list Ast.ctyp);
  value type_kind : Gram.Entry.t Ast.ctyp;
  value type_longident : Gram.Entry.t Ast.ident;
  value type_longident_and_parameters : Gram.Entry.t Ast.ctyp;
  value type_parameter : Gram.Entry.t Ast.ctyp;
  value type_parameters : Gram.Entry.t (Ast.ctyp -> Ast.ctyp);
  value typevars : Gram.Entry.t Ast.ctyp;
  value val_longident : Gram.Entry.t Ast.ident;
  value value_let : Gram.Entry.t unit;
  value value_val : Gram.Entry.t unit;
  value with_constr : Gram.Entry.t Ast.with_constr;
  value with_constr_quot : Gram.Entry.t Ast.with_constr;
  value prefixop : Gram.Entry.t Ast.expr;
  value infixop0 : Gram.Entry.t Ast.expr;
  value infixop1 : Gram.Entry.t Ast.expr;
  value infixop2 : Gram.Entry.t Ast.expr;
  value infixop3 : Gram.Entry.t Ast.expr;
  value infixop4 : Gram.Entry.t Ast.expr;
end;

(** A signature for syntax extension (syntax -> syntax functors). *)
module type SyntaxExtension = functor (Syn : Syntax)
                    -> (Syntax with module Loc            = Syn.Loc
                                and module Ast            = Syn.Ast
                                and module Token          = Syn.Token
                                and module Gram           = Syn.Gram
                                and module Quotation      = Syn.Quotation);