helm/software/components/content_pres/cicNotationParser.ml

   1 (* Copyright (C) 2005, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26 (* $Id$ *)
  27
  28 open Printf
  29
  30 module Ast = CicNotationPt
  31 module Env = CicNotationEnv
  32
  33 exception Parse_error of string
  34 exception Level_not_found of int
  35
  36 let level1_pattern_grammar =
  37   Grammar.gcreate CicNotationLexer.level1_pattern_lexer
  38 let level2_ast_grammar = Grammar.gcreate CicNotationLexer.level2_ast_lexer
  39 let level2_meta_grammar = Grammar.gcreate CicNotationLexer.level2_meta_lexer
  40
  41 let min_precedence = 0
  42 let max_precedence = 100
  43
  44 let level1_pattern =
  45   Grammar.Entry.create level1_pattern_grammar "level1_pattern"
  46 let level2_ast = Grammar.Entry.create level2_ast_grammar "level2_ast"
  47 let term = Grammar.Entry.create level2_ast_grammar "term"
  48 let let_defs = Grammar.Entry.create level2_ast_grammar "let_defs"
  49 let protected_binder_vars = Grammar.Entry.create level2_ast_grammar "protected_binder_vars"
  50 let level2_meta = Grammar.Entry.create level2_meta_grammar "level2_meta"
  51
  52 let int_of_string s =
  53   try
  54     Pervasives.int_of_string s
  55   with Failure _ ->
  56     failwith (sprintf "Lexer failure: string_of_int \"%s\" failed" s)
  57
  58 (** {2 Grammar extension} *)
  59
  60 let level_of precedence =
  61   if precedence < min_precedence || precedence > max_precedence then
  62     raise (Level_not_found precedence);
  63   string_of_int precedence ^ "N"
  64
  65 let gram_symbol s = Gramext.Stoken ("SYMBOL", s)
  66 let gram_ident s = Gramext.Stoken ("IDENT", s)
  67 let gram_number s = Gramext.Stoken ("NUMBER", s)
  68 let gram_keyword s = Gramext.Stoken ("", s)
  69 let gram_term = function
  70   | None -> Gramext.Sself
  71   | Some (precedence) ->
  72       Gramext.Snterml (Grammar.Entry.obj (term: 'a Grammar.Entry.e),level_of precedence)
  73 ;;
  74
  75 let gram_of_literal =
  76   function
  77   | `Symbol s -> gram_symbol s
  78   | `Keyword s -> gram_keyword s
  79   | `Number s -> gram_number s
  80
  81 type binding =
  82   | NoBinding
  83   | Binding of string * Env.value_type
  84   | Env of (string * Env.value_type) list
  85
  86 let make_action action bindings =
  87   let rec aux (vl : CicNotationEnv.t) =
  88     function
  89       [] -> Gramext.action (fun (loc: Ast.location) -> action vl loc)
  90     | NoBinding :: tl -> Gramext.action (fun _ -> aux vl tl)
  91     (* LUCA: DEFCON 3 BEGIN *)
  92     | Binding (name, Env.TermType l) :: tl ->
  93         Gramext.action
  94           (fun (v:Ast.term) ->
  95             aux ((name, (Env.TermType l, Env.TermValue v))::vl) tl)
  96     | Binding (name, Env.StringType) :: tl ->
  97         Gramext.action
  98           (fun (v:string) ->
  99             aux ((name, (Env.StringType, Env.StringValue v)) :: vl) tl)
 100     | Binding (name, Env.NumType) :: tl ->
 101         Gramext.action
 102           (fun (v:string) ->
 103             aux ((name, (Env.NumType, Env.NumValue v)) :: vl) tl)
 104     | Binding (name, Env.OptType t) :: tl ->
 105         Gramext.action
 106           (fun (v:'a option) ->
 107             aux ((name, (Env.OptType t, Env.OptValue v)) :: vl) tl)
 108     | Binding (name, Env.ListType t) :: tl ->
 109         Gramext.action
 110           (fun (v:'a list) ->
 111             aux ((name, (Env.ListType t, Env.ListValue v)) :: vl) tl)
 112     | Env _ :: tl ->
 113         Gramext.action (fun (v:CicNotationEnv.t) -> aux (v @ vl) tl)
 114     (* LUCA: DEFCON 3 END *)
 115   in
 116     aux [] (List.rev bindings)
 117
 118 let flatten_opt =
 119   let rec aux acc =
 120     function
 121       [] -> List.rev acc
 122     | NoBinding :: tl -> aux acc tl
 123     | Env names :: tl -> aux (List.rev names @ acc) tl
 124     | Binding (name, ty) :: tl -> aux ((name, ty) :: acc) tl
 125   in
 126   aux []
 127
 128   (* given a level 1 pattern computes the new RHS of "term" grammar entry *)
 129 let extract_term_production pattern =
 130   let rec aux = function
 131     | Ast.AttributedTerm (_, t) -> aux t
 132     | Ast.Literal l -> aux_literal l
 133     | Ast.Layout l -> aux_layout l
 134     | Ast.Magic m -> aux_magic m
 135     | Ast.Variable v -> aux_variable v
 136     | t ->
 137         prerr_endline (CicNotationPp.pp_term t);
 138         assert false
 139   and aux_literal =
 140     function
 141     | `Symbol s -> [NoBinding, gram_symbol s]
 142     | `Keyword s ->
 143         (* assumption: s will be registered as a keyword with the lexer *)
 144         [NoBinding, gram_keyword s]
 145     | `Number s -> [NoBinding, gram_number s]
 146   and aux_layout = function
 147     | Ast.Sub (p1, p2) -> aux p1 @ [NoBinding, gram_symbol "\\sub"] @ aux p2
 148     | Ast.Sup (p1, p2) -> aux p1 @ [NoBinding, gram_symbol "\\sup"] @ aux p2
 149     | Ast.Below (p1, p2) -> aux p1 @ [NoBinding, gram_symbol "\\below"] @ aux p2
 150     | Ast.Above (p1, p2) -> aux p1 @ [NoBinding, gram_symbol "\\above"] @ aux p2
 151     | Ast.Frac (p1, p2) -> aux p1 @ [NoBinding, gram_symbol "\\frac"] @ aux p2
 152     | Ast.Atop (p1, p2) -> aux p1 @ [NoBinding, gram_symbol "\\atop"] @ aux p2
 153     | Ast.Over (p1, p2) -> aux p1 @ [NoBinding, gram_symbol "\\over"] @ aux p2
 154     | Ast.Root (p1, p2) ->
 155         [NoBinding, gram_symbol "\\root"] @ aux p2
 156         @ [NoBinding, gram_symbol "\\of"] @ aux p1
 157     | Ast.Sqrt p -> [NoBinding, gram_symbol "\\sqrt"] @ aux p
 158     | Ast.Break -> []
 159     | Ast.Box (_, pl) -> List.flatten (List.map aux pl)
 160     | Ast.Group pl -> List.flatten (List.map aux pl)
 161   and aux_magic magic =
 162     match magic with
 163     | Ast.Opt p ->
 164         let p_bindings, p_atoms, p_names, p_action = inner_pattern p in
 165         let action (env_opt : CicNotationEnv.t option) (loc : Ast.location) =
 166           match env_opt with
 167           | Some env -> List.map Env.opt_binding_some env
 168           | None -> List.map Env.opt_binding_of_name p_names
 169         in
 170         [ Env (List.map Env.opt_declaration p_names),
 171           Gramext.srules
 172             [ [ Gramext.Sopt (Gramext.srules [ p_atoms, p_action ]) ],
 173               Gramext.action action ] ]
 174     | Ast.List0 (p, _)
 175     | Ast.List1 (p, _) ->
 176         let p_bindings, p_atoms, p_names, p_action = inner_pattern p in
 177         let action (env_list : CicNotationEnv.t list) (loc : Ast.location) =
 178           CicNotationEnv.coalesce_env p_names env_list
 179         in
 180         let gram_of_list s =
 181           match magic with
 182           | Ast.List0 (_, None) -> Gramext.Slist0 s
 183           | Ast.List1 (_, None) -> Gramext.Slist1 s
 184           | Ast.List0 (_, Some l) -> Gramext.Slist0sep (s, gram_of_literal l)
 185           | Ast.List1 (_, Some l) -> Gramext.Slist1sep (s, gram_of_literal l)
 186           | _ -> assert false
 187         in
 188         [ Env (List.map Env.list_declaration p_names),
 189           Gramext.srules
 190             [ [ gram_of_list (Gramext.srules [ p_atoms, p_action ]) ],
 191               Gramext.action action ] ]
 192     | _ -> assert false
 193   and aux_variable =
 194     function
 195     | Ast.NumVar s -> [Binding (s, Env.NumType), gram_number ""]
 196     | Ast.TermVar (s,level) ->
 197         [Binding (s, Env.TermType level), gram_term level]
 198     | Ast.IdentVar s -> [Binding (s, Env.StringType), gram_ident ""]
 199     | Ast.Ascription (p, s) -> assert false (* TODO *)
 200     | Ast.FreshVar _ -> assert false
 201   and inner_pattern p =
 202     let p_bindings, p_atoms = List.split (aux p) in
 203     let p_names = flatten_opt p_bindings in
 204     let action =
 205       make_action (fun (env : CicNotationEnv.t) (loc : Ast.location) -> env)
 206         p_bindings
 207     in
 208     p_bindings, p_atoms, p_names, action
 209   in
 210   aux pattern
 211
 212 type rule_id = Grammar.token Gramext.g_symbol list
 213
 214   (* mapping: rule_id -> owned keywords. (rule_id, string list) Hashtbl.t *)
 215 let owned_keywords = Hashtbl.create 23
 216
 217 type checked_l1_pattern = CL1P of CicNotationPt.term * int
 218
 219 let check_l1_pattern level1_pattern level associativity =
 220   let variables = ref 0 in
 221   let symbols = ref 0 in
 222   let rec aux = function
 223     | Ast.AttributedTerm (att, t) -> Ast.AttributedTerm (att,aux t)
 224     | Ast.Literal _ as l -> incr symbols; l
 225     | Ast.Layout l -> Ast.Layout (aux_layout l)
 226     | Ast.Magic m -> Ast.Magic (aux_magic m)
 227     | Ast.Variable v -> Ast.Variable (aux_variable v)
 228     | t -> assert false
 229   and aux_layout = function
 230     | Ast.Sub (p1, p2)   -> let p1 = aux p1 in let p2 = aux p2 in Ast.Sub (p1, p2)
 231     | Ast.Sup (p1, p2)   -> let p1 = aux p1 in let p2 = aux p2 in Ast.Sup (p1, p2)
 232     | Ast.Below (p1, p2) -> let p1 = aux p1 in let p2 = aux p2 in Ast.Below (p1, p2)
 233     | Ast.Above (p1, p2) -> let p1 = aux p1 in let p2 = aux p2 in Ast.Above (p1, p2)
 234     | Ast.Frac (p1, p2)  -> let p1 = aux p1 in let p2 = aux p2 in Ast.Frac (p1, p2)
 235     | Ast.Atop (p1, p2)  -> let p1 = aux p1 in let p2 = aux p2 in Ast.Atop (p1, p2)
 236     | Ast.Over (p1, p2)  -> let p1 = aux p1 in let p2 = aux p2 in Ast.Over (p1, p2)
 237     | Ast.Root (p1, p2)  -> let p1 = aux p1 in let p2 = aux p2 in Ast.Root (p1, p2)
 238     | Ast.Sqrt p -> Ast.Sqrt (aux p)
 239     | Ast.Break as t -> t
 240     | Ast.Box (b, pl) -> Ast.Box(b, List.map aux pl)
 241     | Ast.Group pl -> Ast.Group (List.map aux pl)
 242   and aux_magic magic =
 243     match magic with
 244     | Ast.Opt p -> Ast.Opt (aux p)
 245     | Ast.List0 (p, x) -> Ast.List0 (aux p, x)
 246     | Ast.List1 (p, x) -> Ast.List1 (aux p, x)
 247     | _ -> assert false
 248   and aux_variable =
 249     function
 250     | Ast.NumVar _ as t -> t
 251     | Ast.TermVar (s,None) when associativity <> Gramext.NonA ->
 252         incr variables;
 253         if !variables > 2 then
 254           raise (Parse_error ("Exactly 2 variables must be specified in an "^
 255           "associative notation"));
 256         (match !variables, associativity with
 257         | 1,Gramext.LeftA -> Ast.TermVar (s, None) (*Ast.TermVar (s, Some
 258         (level-1)) *)
 259         | 1,Gramext.RightA -> Ast.TermVar (s, None)
 260         | 2,Gramext.LeftA ->Ast.TermVar (s, None)
 261         | 2,Gramext.RightA -> Ast.TermVar (s, Some (level-1))
 262         | _ -> assert false)
 263     | Ast.TermVar (s,Some _) when associativity <> Gramext.NonA ->
 264           raise (Parse_error ("Variables can not be declared with a " ^
 265             "precedence in an associative notation"))
 266        (* avoid camlp5 divergence due to non-Sself recursion at the same level *)
 267     | Ast.TermVar (s,Some l) when l=level ->
 268         incr variables;
 269         Ast.TermVar (s,None)
 270        (* avoid camlp5 divergence due to non-Sself left recursion *)
 271     | Ast.TermVar (s,Some _) when !symbols = 0 && !variables = 0 ->
 272           raise (Parse_error "Left recursive rule with precedence not allowed")
 273     | Ast.TermVar _ as t -> incr variables; t
 274     | Ast.IdentVar _ as t -> t
 275     | Ast.Ascription _ -> assert false (* TODO *)
 276     | Ast.FreshVar _ -> assert false
 277   in
 278   if associativity <> Gramext.NonA && level = min_precedence then
 279     raise (Parse_error ("You can not specify an associative notation " ^
 280     "at level "^string_of_int min_precedence ^ "; increase it"));
 281   let cp = CL1P (aux level1_pattern, level) in
 282   if !variables <> 2 && associativity <> Gramext.NonA then
 283     raise (Parse_error ("Exactly 2 variables must be specified in an "^
 284      "associative notation"));
 285   cp
 286 ;;
 287
 288 let extend (CL1P (level1_pattern,precedence)) action =
 289   let p_bindings, p_atoms =
 290     List.split (extract_term_production level1_pattern)
 291   in
 292   let level = level_of precedence in
 293   let _ =
 294     Grammar.extend
 295       [ Grammar.Entry.obj (term: 'a Grammar.Entry.e),
 296         Some (Gramext.Level level),
 297         [ None,
 298           Some (*Gramext.NonA*) Gramext.LeftA,
 299           [ p_atoms,
 300             (make_action
 301               (fun (env: CicNotationEnv.t) (loc: Ast.location) ->
 302                 (action env loc))
 303               p_bindings) ]]]
 304   in
 305   let keywords = CicNotationUtil.keywords_of_term level1_pattern in
 306   let rule_id = p_atoms in
 307   List.iter CicNotationLexer.add_level2_ast_keyword keywords;
 308   Hashtbl.add owned_keywords rule_id keywords;  (* keywords may be [] *)
 309   rule_id
 310
 311 let delete rule_id =
 312   let atoms = rule_id in
 313   (try
 314     let keywords = Hashtbl.find owned_keywords rule_id in
 315     List.iter CicNotationLexer.remove_level2_ast_keyword keywords
 316   with Not_found -> assert false);
 317   Grammar.delete_rule term atoms
 318
 319 (** {2 Grammar} *)
 320
 321 let parse_level1_pattern_ref = ref (fun _ -> assert false)
 322 let parse_level2_ast_ref = ref (fun _ -> assert false)
 323 let parse_level2_meta_ref = ref (fun _ -> assert false)
 324
 325 let fold_cluster binder terms ty body =
 326   List.fold_right
 327     (fun term body -> Ast.Binder (binder, (term, ty), body))
 328     terms body  (* terms are names: either Ident or FreshVar *)
 329
 330 let fold_exists terms ty body =
 331   List.fold_right
 332     (fun term body ->
 333       let lambda = Ast.Binder (`Lambda, (term, ty), body) in
 334       Ast.Appl [ Ast.Symbol ("exists", 0); lambda ])
 335     terms body
 336
 337 let fold_binder binder pt_names body =
 338   List.fold_right
 339     (fun (names, ty) body -> fold_cluster binder names ty body)
 340     pt_names body
 341
 342 let return_term loc term = Ast.AttributedTerm (`Loc loc, term)
 343
 344   (* create empty precedence level for "term" *)
 345 let _ =
 346   let dummy_action =
 347     Gramext.action (fun _ ->
 348       failwith "internal error, lexer generated a dummy token")
 349   in
 350   (* Needed since campl4 on "delete_rule" remove the precedence level if it gets
 351    * empty after the deletion. The lexer never generate the Stoken below. *)
 352   let dummy_prod = [ [ Gramext.Stoken ("DUMMY", "") ], dummy_action ] in
 353   let mk_level_list first last =
 354     let rec aux acc = function
 355       | i when i < first -> acc
 356       | i ->
 357           aux
 358             ((Some (string_of_int i ^ "N"), Some (*Gramext.NonA*)Gramext.LeftA, dummy_prod)
 359              :: acc)
 360             (i - 1)
 361     in
 362     aux [] last
 363   in
 364   Grammar.extend
 365     [ Grammar.Entry.obj (term: 'a Grammar.Entry.e),
 366       None,
 367       mk_level_list min_precedence max_precedence ]
 368
 369 (* {{{ Grammar for concrete syntax patterns, notation level 1 *)
 370 EXTEND
 371   GLOBAL: level1_pattern;
 372
 373   level1_pattern: [ [ p = l1_pattern; EOI -> CicNotationUtil.boxify p ] ];
 374   l1_pattern: [ [ p = LIST1 l1_simple_pattern -> p ] ];
 375   literal: [
 376     [ s = SYMBOL -> `Symbol s
 377     | k = QKEYWORD -> `Keyword k
 378     | n = NUMBER -> `Number n
 379     ]
 380   ];
 381   sep:       [ [ "sep";      sep = literal -> sep ] ];
 382 (*   row_sep:   [ [ "rowsep";   sep = literal -> sep ] ];
 383   field_sep: [ [ "fieldsep"; sep = literal -> sep ] ]; *)
 384   l1_magic_pattern: [
 385     [ "list0"; p = l1_simple_pattern; sep = OPT sep -> Ast.List0 (p, sep)
 386     | "list1"; p = l1_simple_pattern; sep = OPT sep -> Ast.List1 (p, sep)
 387     | "opt";   p = l1_simple_pattern -> Ast.Opt p
 388     ]
 389   ];
 390   l1_pattern_variable: [
 391     [ "term"; precedence = NUMBER; id = IDENT ->
 392         Ast.TermVar (id, Some (int_of_string precedence))
 393     | "number"; id = IDENT -> Ast.NumVar id
 394     | "ident"; id = IDENT -> Ast.IdentVar id
 395     ]
 396   ];
 397   l1_simple_pattern:
 398     [ "layout" LEFTA
 399       [ p1 = SELF; SYMBOL "\\sub"; p2 = SELF ->
 400           return_term loc (Ast.Layout (Ast.Sub (p1, p2)))
 401       | p1 = SELF; SYMBOL "\\sup"; p2 = SELF ->
 402           return_term loc (Ast.Layout (Ast.Sup (p1, p2)))
 403       | p1 = SELF; SYMBOL "\\below"; p2 = SELF ->
 404           return_term loc (Ast.Layout (Ast.Below (p1, p2)))
 405       | p1 = SELF; SYMBOL "\\above"; p2 = SELF ->
 406           return_term loc (Ast.Layout (Ast.Above (p1, p2)))
 407       | p1 = SELF; SYMBOL "\\over"; p2 = SELF ->
 408           return_term loc (Ast.Layout (Ast.Over (p1, p2)))
 409       | p1 = SELF; SYMBOL "\\atop"; p2 = SELF ->
 410           return_term loc (Ast.Layout (Ast.Atop (p1, p2)))
 411 (*       | "array"; p = SELF; csep = OPT field_sep; rsep = OPT row_sep ->
 412           return_term loc (Array (p, csep, rsep)) *)
 413       | SYMBOL "\\frac"; p1 = SELF; p2 = SELF ->
 414           return_term loc (Ast.Layout (Ast.Frac (p1, p2)))
 415       | SYMBOL "\\sqrt"; p = SELF -> return_term loc (Ast.Layout (Ast.Sqrt p))
 416       | SYMBOL "\\root"; index = SELF; SYMBOL "\\of"; arg = SELF ->
 417           return_term loc (Ast.Layout (Ast.Root (arg, index)))
 418       | "hbox"; LPAREN; p = l1_pattern; RPAREN ->
 419           return_term loc (Ast.Layout (Ast.Box ((Ast.H, false, false), p)))
 420       | "vbox"; LPAREN; p = l1_pattern; RPAREN ->
 421           return_term loc (Ast.Layout (Ast.Box ((Ast.V, false, false), p)))
 422       | "hvbox"; LPAREN; p = l1_pattern; RPAREN ->
 423           return_term loc (Ast.Layout (Ast.Box ((Ast.HV, false, false), p)))
 424       | "hovbox"; LPAREN; p = l1_pattern; RPAREN ->
 425           return_term loc (Ast.Layout (Ast.Box ((Ast.HOV, false, false), p)))
 426       | "break" -> return_term loc (Ast.Layout Ast.Break)
 427 (*       | SYMBOL "\\SPACE" -> return_term loc (Layout Space) *)
 428       | LPAREN; p = l1_pattern; RPAREN ->
 429           return_term loc (CicNotationUtil.group p)
 430       ]
 431     | "simple" NONA
 432       [ i = IDENT -> return_term loc (Ast.Variable (Ast.TermVar (i,None)))
 433       | m = l1_magic_pattern -> return_term loc (Ast.Magic m)
 434       | v = l1_pattern_variable -> return_term loc (Ast.Variable v)
 435       | l = literal -> return_term loc (Ast.Literal l)
 436       ]
 437     ];
 438   END
 439 (* }}} *)
 440
 441 (* {{{ Grammar for ast magics, notation level 2 *)
 442 EXTEND
 443   GLOBAL: level2_meta;
 444   l2_variable: [
 445     [ "term"; precedence = NUMBER; id = IDENT ->
 446         Ast.TermVar (id,Some (int_of_string precedence))
 447     | "number"; id = IDENT -> Ast.NumVar id
 448     | "ident"; id = IDENT -> Ast.IdentVar id
 449     | "fresh"; id = IDENT -> Ast.FreshVar id
 450     | "anonymous" -> Ast.TermVar ("_",None)
 451     | id = IDENT -> Ast.TermVar (id,None)
 452     ]
 453   ];
 454   l2_magic: [
 455     [ "fold"; kind = [ "left" -> `Left | "right" -> `Right ];
 456       base = level2_meta; "rec"; id = IDENT; recursive = level2_meta ->
 457         Ast.Fold (kind, base, [id], recursive)
 458     | "default"; some = level2_meta; none = level2_meta ->
 459         Ast.Default (some, none)
 460     | "if"; p_test = level2_meta;
 461       "then"; p_true = level2_meta;
 462       "else"; p_false = level2_meta ->
 463         Ast.If (p_test, p_true, p_false)
 464     | "fail" -> Ast.Fail
 465     ]
 466   ];
 467   level2_meta: [
 468     [ magic = l2_magic -> Ast.Magic magic
 469     | var = l2_variable -> Ast.Variable var
 470     | blob = UNPARSED_AST ->
 471         !parse_level2_ast_ref (Ulexing.from_utf8_string blob)
 472     ]
 473   ];
 474 END
 475 (* }}} *)
 476
 477 (* {{{ Grammar for ast patterns, notation level 2 *)
 478 EXTEND
 479   GLOBAL: level2_ast term let_defs protected_binder_vars;
 480   level2_ast: [ [ p = term -> p ] ];
 481   sort: [
 482     [ "Prop" -> `Prop
 483     | "Set" -> `Set
 484     | "Type" -> `Type (CicUniv.fresh ())
 485     | "CProp" -> `CProp (CicUniv.fresh ())
 486     ]
 487   ];
 488   explicit_subst: [
 489     [ SYMBOL "\\subst";  (* to avoid catching frequent "a [1]" cases *)
 490       SYMBOL "[";
 491       substs = LIST1 [
 492         i = IDENT; SYMBOL <:unicode<Assign>> (* ≔ *); t = term -> (i, t)
 493       ] SEP SYMBOL ";";
 494       SYMBOL "]" ->
 495         substs
 496     ]
 497   ];
 498   meta_subst: [
 499     [ s = SYMBOL "_" -> None
 500     | p = term -> Some p ]
 501   ];
 502   meta_substs: [
 503     [ SYMBOL "["; substs = LIST0 meta_subst; SYMBOL "]" -> substs ]
 504   ];
 505   possibly_typed_name: [
 506     [ LPAREN; id = single_arg; SYMBOL ":"; typ = term; RPAREN ->
 507         id, Some typ
 508     | arg = single_arg -> arg, None
 509     | SYMBOL "_" -> Ast.Ident ("_", None), None
 510     | LPAREN; SYMBOL "_"; SYMBOL ":"; typ = term; RPAREN ->
 511         Ast.Ident ("_", None), Some typ
 512     ]
 513   ];
 514   match_pattern: [
 515     [ id = IDENT -> Ast.Pattern (id, None, [])
 516     | LPAREN; id = IDENT; vars = LIST1 possibly_typed_name; RPAREN ->
 517        Ast.Pattern (id, None, vars)
 518     | id = IDENT; vars = LIST1 possibly_typed_name ->
 519        Ast.Pattern (id, None, vars)
 520     | SYMBOL "_" -> Ast.Wildcard
 521     ]
 522   ];
 523   binder: [
 524     [ SYMBOL <:unicode<Pi>>     (* Π *) -> `Pi
 525 (*     | SYMBOL <:unicode<exists>> |+ ∃ +| -> `Exists *)
 526     | SYMBOL <:unicode<forall>> (* ∀ *) -> `Forall
 527     | SYMBOL <:unicode<lambda>> (* λ *) -> `Lambda
 528     ]
 529   ];
 530   arg: [
 531     [ LPAREN; names = LIST1 IDENT SEP SYMBOL ",";
 532       SYMBOL ":"; ty = term; RPAREN ->
 533         List.map (fun n -> Ast.Ident (n, None)) names, Some ty
 534     | name = IDENT -> [Ast.Ident (name, None)], None
 535     | blob = UNPARSED_META ->
 536         let meta = !parse_level2_meta_ref (Ulexing.from_utf8_string blob) in
 537         match meta with
 538         | Ast.Variable (Ast.FreshVar _) -> [meta], None
 539         | Ast.Variable (Ast.TermVar ("_",_)) -> [Ast.Ident ("_", None)], None
 540         | _ -> failwith "Invalid bound name."
 541    ]
 542   ];
 543   single_arg: [
 544     [ name = IDENT -> Ast.Ident (name, None)
 545     | blob = UNPARSED_META ->
 546         let meta = !parse_level2_meta_ref (Ulexing.from_utf8_string blob) in
 547         match meta with
 548         | Ast.Variable (Ast.FreshVar _)
 549         | Ast.Variable (Ast.IdentVar _) -> meta
 550         | Ast.Variable (Ast.TermVar ("_",_)) -> Ast.Ident ("_", None)
 551         | _ -> failwith "Invalid index name."
 552     ]
 553   ];
 554   let_defs: [
 555     [ defs = LIST1 [
 556         name = single_arg;
 557         args = LIST1 arg;
 558         index_name = OPT [ "on"; id = single_arg -> id ];
 559         ty = OPT [ SYMBOL ":" ; p = term -> p ];
 560         SYMBOL <:unicode<def>> (* ≝ *); body = term ->
 561           let rec position_of name p = function
 562             | [] -> None, p
 563             | n :: _ when n = name -> Some p, p
 564             | _ :: tl -> position_of name (p + 1) tl
 565           in
 566           let rec find_arg name n = function
 567             | [] ->
 568                 Ast.fail loc (sprintf "Argument %s not found"
 569                   (CicNotationPp.pp_term name))
 570             | (l,_) :: tl ->
 571                 (match position_of name 0 l with
 572                 | None, len -> find_arg name (n + len) tl
 573                 | Some where, len -> n + where)
 574           in
 575           let index =
 576             match index_name with
 577             | None -> 0
 578             | Some index_name -> find_arg index_name 0 args
 579           in
 580           let args =
 581            List.concat
 582             (List.map
 583              (function (names,ty) -> List.map (function x -> x,ty) names
 584              ) args)
 585           in
 586            args, (name, ty), body, index
 587       ] SEP "and" ->
 588         defs
 589     ]
 590   ];
 591   binder_vars: [
 592     [ vars = [
 593           l = LIST1 single_arg SEP SYMBOL "," -> l
 594         | SYMBOL "_" -> [Ast.Ident ("_", None)] ];
 595       typ = OPT [ SYMBOL ":"; t = term -> t ] -> (vars, typ)
 596     ]
 597   ];
 598   protected_binder_vars: [
 599     [ LPAREN; vars = binder_vars; RPAREN -> vars
 600     ]
 601   ];
 602   maybe_protected_binder_vars: [
 603     [ vars = binder_vars -> vars
 604     | vars = protected_binder_vars -> vars
 605     ]
 606   ];
 607   term: LEVEL "10N"
 608   [
 609     [ "let"; var = possibly_typed_name; SYMBOL <:unicode<def>> (* ≝ *);
 610       p1 = term; "in"; p2 = term ->
 611         return_term loc (Ast.LetIn (var, p1, p2))
 612     | LETCOREC; defs = let_defs; "in";
 613       body = term ->
 614         return_term loc (Ast.LetRec (`CoInductive, defs, body))
 615     | LETREC; defs = let_defs; "in";
 616       body = term ->
 617         return_term loc (Ast.LetRec (`Inductive, defs, body))
 618     ]
 619   ];
 620   term: LEVEL "20N"
 621     [
 622       [ b = binder; (vars, typ) = maybe_protected_binder_vars; SYMBOL "."; body = term LEVEL "19N" ->
 623           return_term loc (fold_cluster b vars typ body)
 624       | SYMBOL <:unicode<exists>> (* ∃ *);
 625         (vars, typ) = maybe_protected_binder_vars; SYMBOL "."; body = term LEVEL "19N"->
 626           return_term loc (fold_exists vars typ body)
 627       ]
 628     ];
 629   term: LEVEL "70N"
 630     [
 631       [ p1 = term; p2 = term ->
 632           let rec aux = function
 633             | Ast.Appl (hd :: tl)
 634             | Ast.AttributedTerm (_, Ast.Appl (hd :: tl)) ->
 635                 aux hd @ tl
 636             | term -> [term]
 637           in
 638           return_term loc (Ast.Appl (aux p1 @ [p2]))
 639       ]
 640     ];
 641   term: LEVEL "90N"
 642     [
 643       [ id = IDENT -> return_term loc (Ast.Ident (id, None))
 644       | id = IDENT; s = explicit_subst ->
 645           return_term loc (Ast.Ident (id, Some s))
 646       | s = CSYMBOL -> return_term loc (Ast.Symbol (s, 0))
 647       | u = URI -> return_term loc (Ast.Uri (u, None))
 648       | n = NUMBER -> return_term loc (Ast.Num (n, 0))
 649       | IMPLICIT -> return_term loc (Ast.Implicit)
 650       | PLACEHOLDER -> return_term loc Ast.UserInput
 651       | m = META -> return_term loc (Ast.Meta (int_of_string m, []))
 652       | m = META; s = meta_substs ->
 653           return_term loc (Ast.Meta (int_of_string m, s))
 654       | s = sort -> return_term loc (Ast.Sort s)
 655       | "match"; t = term;
 656         indty_ident = OPT [ "in"; id = IDENT -> id, None ];
 657         outtyp = OPT [ "return"; ty = term -> ty ];
 658         "with"; SYMBOL "[";
 659         patterns = LIST0 [
 660           lhs = match_pattern; SYMBOL <:unicode<Rightarrow>> (* ⇒ *);
 661           rhs = term ->
 662             lhs, rhs
 663         ] SEP SYMBOL "|";
 664         SYMBOL "]" ->
 665           return_term loc (Ast.Case (t, indty_ident, outtyp, patterns))
 666       | LPAREN; p1 = term; SYMBOL ":"; p2 = term; RPAREN ->
 667           return_term loc (Ast.Cast (p1, p2))
 668       | LPAREN; p = term; RPAREN -> p
 669       | blob = UNPARSED_META ->
 670           !parse_level2_meta_ref (Ulexing.from_utf8_string blob)
 671       ]
 672     ];
 673 END
 674 (* }}} *)
 675
 676 (** {2 API implementation} *)
 677
 678 let exc_located_wrapper f =
 679   try
 680     f ()
 681   with
 682   | Stdpp.Exc_located (floc, Stream.Error msg) ->
 683       raise (HExtlib.Localized (floc, Parse_error msg))
 684   | Stdpp.Exc_located (floc, exn) ->
 685       raise (HExtlib.Localized (floc, (Parse_error (Printexc.to_string exn))))
 686
 687 let parse_level1_pattern lexbuf =
 688   exc_located_wrapper
 689     (fun () -> Grammar.Entry.parse level1_pattern (Obj.magic lexbuf))
 690
 691 let parse_level2_ast lexbuf =
 692   exc_located_wrapper
 693     (fun () -> Grammar.Entry.parse level2_ast (Obj.magic lexbuf))
 694
 695 let parse_level2_meta lexbuf =
 696   exc_located_wrapper
 697     (fun () -> Grammar.Entry.parse level2_meta (Obj.magic lexbuf))
 698
 699 let _ =
 700   parse_level1_pattern_ref := parse_level1_pattern;
 701   parse_level2_ast_ref := parse_level2_ast;
 702   parse_level2_meta_ref := parse_level2_meta
 703
 704 let parse_term lexbuf =
 705   exc_located_wrapper
 706     (fun () -> (Grammar.Entry.parse term (Obj.magic lexbuf)))
 707
 708 (** {2 Debugging} *)
 709
 710 let print_l2_pattern () =
 711   Grammar.print_entry Format.std_formatter (Grammar.Entry.obj term);
 712   Format.pp_print_flush Format.std_formatter ();
 713   flush stdout
 714
 715 (* vim:set encoding=utf8 foldmethod=marker: *)