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 min_precedence = 0
  37 let max_precedence = 100
  38
  39 type ('a,'b,'c,'d) grammars = {
  40   level1_pattern: 'a Grammar.Entry.e;
  41   level2_ast: 'b Grammar.Entry.e;
  42   level2_ast_grammar : Grammar.g;
  43   term: 'b Grammar.Entry.e;
  44   let_defs: 'c Grammar.Entry.e;
  45   protected_binder_vars: 'd Grammar.Entry.e;
  46   level2_meta: 'b Grammar.Entry.e;
  47 }
  48
  49 let initial_grammars () =
  50   let level1_pattern_grammar =
  51     Grammar.gcreate (CicNotationLexer.level1_pattern_lexer ()) in
  52   let level2_ast_grammar =
  53     Grammar.gcreate (CicNotationLexer.level2_ast_lexer ()) in
  54   let level2_meta_grammar =
  55     Grammar.gcreate (CicNotationLexer.level2_meta_lexer ()) in
  56   let level1_pattern =
  57     Grammar.Entry.create level1_pattern_grammar "level1_pattern" in
  58   let level2_ast = Grammar.Entry.create level2_ast_grammar "level2_ast" in
  59   let term = Grammar.Entry.create level2_ast_grammar "term" in
  60   let let_defs = Grammar.Entry.create level2_ast_grammar "let_defs" in
  61   let protected_binder_vars =
  62     Grammar.Entry.create level2_ast_grammar "protected_binder_vars" in
  63   let level2_meta = Grammar.Entry.create level2_meta_grammar "level2_meta" in
  64   { level1_pattern=level1_pattern;
  65     level2_ast=level2_ast;
  66     term=term;
  67     let_defs=let_defs;
  68     protected_binder_vars=protected_binder_vars;
  69     level2_meta=level2_meta;
  70     level2_ast_grammar=level2_ast_grammar;
  71 }
  72 ;;
  73
  74 let grammars = ref (initial_grammars ());;
  75
  76 let int_of_string s =
  77   try
  78     Pervasives.int_of_string s
  79   with Failure _ ->
  80     failwith (sprintf "Lexer failure: string_of_int \"%s\" failed" s)
  81
  82 (** {2 Grammar extension} *)
  83
  84 let level_of precedence =
  85   if precedence < min_precedence || precedence > max_precedence then
  86     raise (Level_not_found precedence);
  87   string_of_int precedence
  88
  89 let gram_symbol s = Gramext.Stoken ("SYMBOL", s)
  90 let gram_ident s = Gramext.Stoken ("IDENT", s)
  91 let gram_number s = Gramext.Stoken ("NUMBER", s)
  92 let gram_keyword s = Gramext.Stoken ("", s)
  93 let gram_term = function
  94   | Ast.Self _ -> Gramext.Sself
  95   | Ast.Level precedence ->
  96       Gramext.Snterml
  97         (Grammar.Entry.obj (!grammars.term: 'a Grammar.Entry.e),
  98          level_of precedence)
  99 ;;
 100
 101 let gram_of_literal =
 102   function
 103   | `Symbol s -> gram_symbol s
 104   | `Keyword s -> gram_keyword s
 105   | `Number s -> gram_number s
 106
 107 type binding =
 108   | NoBinding
 109   | Binding of string * Env.value_type
 110   | Env of (string * Env.value_type) list
 111
 112 let make_action action bindings =
 113   let rec aux (vl : CicNotationEnv.t) =
 114     function
 115       [] -> Gramext.action (fun (loc: Ast.location) -> action vl loc)
 116     | NoBinding :: tl -> Gramext.action (fun _ -> aux vl tl)
 117     (* LUCA: DEFCON 3 BEGIN *)
 118     | Binding (name, Env.TermType l) :: tl ->
 119         Gramext.action
 120           (fun (v:Ast.term) ->
 121             aux ((name, (Env.TermType l, Env.TermValue v))::vl) tl)
 122     | Binding (name, Env.StringType) :: tl ->
 123         Gramext.action
 124           (fun (v:string) ->
 125             aux ((name, (Env.StringType, Env.StringValue v)) :: vl) tl)
 126     | Binding (name, Env.NumType) :: tl ->
 127         Gramext.action
 128           (fun (v:string) ->
 129             aux ((name, (Env.NumType, Env.NumValue v)) :: vl) tl)
 130     | Binding (name, Env.OptType t) :: tl ->
 131         Gramext.action
 132           (fun (v:'a option) ->
 133             aux ((name, (Env.OptType t, Env.OptValue v)) :: vl) tl)
 134     | Binding (name, Env.ListType t) :: tl ->
 135         Gramext.action
 136           (fun (v:'a list) ->
 137             aux ((name, (Env.ListType t, Env.ListValue v)) :: vl) tl)
 138     | Env _ :: tl ->
 139         Gramext.action (fun (v:CicNotationEnv.t) -> aux (v @ vl) tl)
 140     (* LUCA: DEFCON 3 END *)
 141   in
 142     aux [] (List.rev bindings)
 143
 144 let flatten_opt =
 145   let rec aux acc =
 146     function
 147       [] -> List.rev acc
 148     | NoBinding :: tl -> aux acc tl
 149     | Env names :: tl -> aux (List.rev names @ acc) tl
 150     | Binding (name, ty) :: tl -> aux ((name, ty) :: acc) tl
 151   in
 152   aux []
 153
 154   (* given a level 1 pattern computes the new RHS of "term" grammar entry *)
 155 let extract_term_production pattern =
 156   let rec aux = function
 157     | Ast.AttributedTerm (_, t) -> aux t
 158     | Ast.Literal l -> aux_literal l
 159     | Ast.Layout l -> aux_layout l
 160     | Ast.Magic m -> aux_magic m
 161     | Ast.Variable v -> aux_variable v
 162     | t ->
 163         prerr_endline (CicNotationPp.pp_term t);
 164         assert false
 165   and aux_literal =
 166     function
 167     | `Symbol s -> [NoBinding, gram_symbol s]
 168     | `Keyword s ->
 169         (* assumption: s will be registered as a keyword with the lexer *)
 170         [NoBinding, gram_keyword s]
 171     | `Number s -> [NoBinding, gram_number s]
 172   and aux_layout = function
 173     | Ast.Sub (p1, p2) -> aux p1 @ [NoBinding, gram_symbol "\\sub "] @ aux p2
 174     | Ast.Sup (p1, p2) -> aux p1 @ [NoBinding, gram_symbol "\\sup "] @ aux p2
 175     | Ast.Below (p1, p2) -> aux p1 @ [NoBinding, gram_symbol "\\below "] @ aux p2
 176     | Ast.Above (p1, p2) -> aux p1 @ [NoBinding, gram_symbol "\\above "] @ aux p2
 177     | Ast.Frac (p1, p2) -> aux p1 @ [NoBinding, gram_symbol "\\frac "] @ aux p2
 178     | Ast.InfRule (p1, p2, p3) -> [NoBinding, gram_symbol "\\infrule "] @ aux p1 @ aux p2 @ aux p3
 179     | Ast.Atop (p1, p2) -> aux p1 @ [NoBinding, gram_symbol "\\atop "] @ aux p2
 180     | Ast.Over (p1, p2) -> aux p1 @ [NoBinding, gram_symbol "\\over "] @ aux p2
 181     | Ast.Root (p1, p2) ->
 182         [NoBinding, gram_symbol "\\root "] @ aux p2
 183         @ [NoBinding, gram_symbol "\\of "] @ aux p1
 184     | Ast.Sqrt p -> [NoBinding, gram_symbol "\\sqrt "] @ aux p
 185     | Ast.Break -> []
 186     | Ast.Box (_, pl) -> List.flatten (List.map aux pl)
 187     | Ast.Group pl -> List.flatten (List.map aux pl)
 188     | Ast.Mstyle (_,pl) -> List.flatten (List.map aux pl)
 189     | Ast.Mpadded (_,pl) -> List.flatten (List.map aux pl)
 190     | Ast.Maction l -> List.flatten (List.map aux l)
 191   and aux_magic magic =
 192     match magic with
 193     | Ast.Opt p ->
 194         let p_bindings, p_atoms, p_names, p_action = inner_pattern p in
 195         let action (env_opt : CicNotationEnv.t option) (loc : Ast.location) =
 196           match env_opt with
 197           | Some env -> List.map Env.opt_binding_some env
 198           | None -> List.map Env.opt_binding_of_name p_names
 199         in
 200         [ Env (List.map Env.opt_declaration p_names),
 201           Gramext.srules
 202             [ [ Gramext.Sopt (Gramext.srules [ p_atoms, p_action ]) ],
 203               Gramext.action action ] ]
 204     | Ast.List0 (p, _)
 205     | Ast.List1 (p, _) ->
 206         let p_bindings, p_atoms, p_names, p_action = inner_pattern p in
 207         let action (env_list : CicNotationEnv.t list) (loc : Ast.location) =
 208           CicNotationEnv.coalesce_env p_names env_list
 209         in
 210         let gram_of_list s =
 211           match magic with
 212           | Ast.List0 (_, None) -> Gramext.Slist0 s
 213           | Ast.List1 (_, None) -> Gramext.Slist1 s
 214           | Ast.List0 (_, Some l) -> Gramext.Slist0sep (s, gram_of_literal l, false)
 215           | Ast.List1 (_, Some l) -> Gramext.Slist1sep (s, gram_of_literal l, false)
 216           | _ -> assert false
 217         in
 218         [ Env (List.map Env.list_declaration p_names),
 219           Gramext.srules
 220             [ [ gram_of_list (Gramext.srules [ p_atoms, p_action ]) ],
 221               Gramext.action action ] ]
 222     | _ -> assert false
 223   and aux_variable =
 224     function
 225     | Ast.NumVar s -> [Binding (s, Env.NumType), gram_number ""]
 226     | Ast.TermVar (s,(Ast.Self level|Ast.Level level as lv)) ->
 227         [Binding (s, Env.TermType level), gram_term lv]
 228     | Ast.IdentVar s -> [Binding (s, Env.StringType), gram_ident ""]
 229     | Ast.Ascription (p, s) -> assert false (* TODO *)
 230     | Ast.FreshVar _ -> assert false
 231   and inner_pattern p =
 232     let p_bindings, p_atoms = List.split (aux p) in
 233     let p_names = flatten_opt p_bindings in
 234     let action =
 235       make_action (fun (env : CicNotationEnv.t) (loc : Ast.location) -> env)
 236         p_bindings
 237     in
 238     p_bindings, p_atoms, p_names, action
 239   in
 240   aux pattern
 241
 242 type rule_id = Grammar.token Gramext.g_symbol list
 243
 244 let compare_rule_id x y =
 245   let rec aux = function
 246     | [],[] -> 0
 247     | [],_ -> ~-1
 248     | _,[] -> 1
 249     | ((s1::tl1) ),((s2::tl2) ) ->
 250         if Gramext.eq_symbol s1 s2 then aux (tl1,tl2)
 251         else
 252           let res =
 253             try Pervasives.compare s1 s2
 254             with Invalid_argument _ -> 0
 255           in
 256            if res = 0 then aux (tl1, tl2) else res
 257   in
 258     aux (x,y)
 259
 260   (* mapping: rule_id -> owned keywords. (rule_id, string list) Hashtbl.t *)
 261 let initial_owned_keywords () = Hashtbl.create 23
 262 let owned_keywords = ref (initial_owned_keywords ())
 263
 264 type checked_l1_pattern = CL1P of CicNotationPt.term * int
 265
 266 let check_l1_pattern level1_pattern pponly level associativity =
 267   let variables = ref 0 in
 268   let symbols = ref 0 in
 269   let rec aux = function
 270     | Ast.AttributedTerm (att, t) -> Ast.AttributedTerm (att,aux t)
 271     | Ast.Literal _ as l -> incr symbols; l
 272     | Ast.Layout l -> Ast.Layout (aux_layout l)
 273     | Ast.Magic m -> Ast.Magic (aux_magic m)
 274     | Ast.Variable v -> (aux_variable v)
 275     | t -> assert false
 276   and aux_layout = function
 277     | Ast.Sub (p1, p2)   -> let p1 = aux p1 in let p2 = aux p2 in Ast.Sub (p1, p2)
 278     | Ast.Sup (p1, p2)   -> let p1 = aux p1 in let p2 = aux p2 in Ast.Sup (p1, p2)
 279     | Ast.Below (p1, p2) -> let p1 = aux p1 in let p2 = aux p2 in Ast.Below (p1, p2)
 280     | Ast.Above (p1, p2) -> let p1 = aux p1 in let p2 = aux p2 in Ast.Above (p1, p2)
 281     | Ast.Frac (p1, p2)  -> let p1 = aux p1 in let p2 = aux p2 in Ast.Frac (p1, p2)
 282     | Ast.InfRule (p1, p2, p3)  -> let p1 = aux p1 in let p2 = aux p2 in let p3 = aux p3 in Ast.InfRule (p1, p2, p3)
 283     | Ast.Atop (p1, p2)  -> let p1 = aux p1 in let p2 = aux p2 in Ast.Atop (p1, p2)
 284     | Ast.Over (p1, p2)  -> let p1 = aux p1 in let p2 = aux p2 in Ast.Over (p1, p2)
 285     | Ast.Root (p1, p2)  -> let p1 = aux p1 in let p2 = aux p2 in Ast.Root (p1, p2)
 286     | Ast.Sqrt p -> Ast.Sqrt (aux p)
 287     | Ast.Break as t -> t
 288     | Ast.Box (b, pl) -> Ast.Box(b, List.map aux pl)
 289     | Ast.Group pl -> Ast.Group (List.map aux pl)
 290     | Ast.Mstyle (l,pl) -> Ast.Mstyle (l, List.map aux pl)
 291     | Ast.Mpadded (l,pl) -> Ast.Mpadded (l, List.map aux pl)
 292     | Ast.Maction l as t ->
 293         if not pponly then
 294         raise(Parse_error("Maction can be used only in output notations"))
 295         else t
 296   and aux_magic magic =
 297     match magic with
 298     | Ast.Opt p -> Ast.Opt (aux p)
 299     | Ast.List0 (p, x) -> Ast.List0 (aux p, x)
 300     | Ast.List1 (p, x) -> Ast.List1 (aux p, x)
 301     | _ -> assert false
 302   and aux_variable =
 303     function
 304     | Ast.NumVar _ as t -> Ast.Variable t
 305     | Ast.TermVar (s,Ast.Self _) when associativity <> Gramext.NonA ->
 306         incr variables;
 307         if !variables > 2 then
 308           raise (Parse_error ("Exactly 2 variables must be specified in an "^
 309           "associative notation"));
 310         (match !variables, associativity with
 311         | 1,Gramext.LeftA ->
 312              Ast.Variable (Ast.TermVar (s, Ast.Self level))
 313         | 1,Gramext.RightA ->
 314              Ast.Variable (Ast.TermVar (s, Ast.Self (level+1)))
 315         | 2,Gramext.LeftA ->
 316              Ast.Variable (Ast.TermVar (s, Ast.Self (level+1)))
 317         | 2,Gramext.RightA ->
 318              Ast.Variable (Ast.TermVar (s, Ast.Level (level-1)))
 319         | _ -> assert false)
 320     | Ast.TermVar (s,Ast.Level _) when associativity <> Gramext.NonA ->
 321           raise (Parse_error ("Variables can not be declared with a " ^
 322             "precedence in an associative notation"))
 323        (*avoid camlp5 divergence due to non-Sself recursion at the same level *)
 324     | Ast.TermVar (s,Ast.Level l) when l<=level && !variables=0 && !symbols=0->
 325        raise(Parse_error("Left recursive rule with precedence not greater " ^
 326         "than " ^ string_of_int level ^ " is not allowed to avoid divergence"))
 327     | Ast.TermVar _ as t -> incr variables; Ast.Variable t
 328     | Ast.IdentVar _ as t -> Ast.Variable t
 329     | Ast.Ascription _ -> assert false (* TODO *)
 330     | Ast.FreshVar _ -> assert false
 331   in
 332   if associativity <> Gramext.NonA && level = min_precedence then
 333     raise (Parse_error ("You can not specify an associative notation " ^
 334     "at level "^string_of_int min_precedence ^ "; increase it"));
 335   let cp = aux level1_pattern in
 336 (*   prerr_endline ("checked_pattern: " ^ CicNotationPp.pp_term cp); *)
 337   if !variables <> 2 && associativity <> Gramext.NonA then
 338     raise (Parse_error ("Exactly 2 variables must be specified in an "^
 339      "associative notation"));
 340   CL1P (cp,level)
 341 ;;
 342
 343 let extend (CL1P (level1_pattern,precedence)) action =
 344   let p_bindings, p_atoms =
 345     List.split (extract_term_production level1_pattern)
 346   in
 347   let level = level_of precedence in
 348   let _ =
 349     Grammar.extend
 350       [ Grammar.Entry.obj (!grammars.term: 'a Grammar.Entry.e),
 351         Some (Gramext.Level level),
 352         [ None,
 353           Some (*Gramext.NonA*) Gramext.NonA,
 354           [ p_atoms,
 355             (make_action
 356               (fun (env: CicNotationEnv.t) (loc: Ast.location) ->
 357                 (action env loc))
 358               p_bindings) ]]]
 359   in
 360   let keywords = CicNotationUtil.keywords_of_term level1_pattern in
 361   let rule_id = p_atoms in
 362   List.iter CicNotationLexer.add_level2_ast_keyword keywords;
 363   Hashtbl.add !owned_keywords rule_id keywords;  (* keywords may be [] *)
 364   rule_id
 365
 366 let delete rule_id =
 367   let atoms = rule_id in
 368   (try
 369     let keywords = Hashtbl.find !owned_keywords rule_id in
 370     List.iter CicNotationLexer.remove_level2_ast_keyword keywords
 371   with Not_found -> assert false);
 372   Grammar.delete_rule !grammars.term atoms
 373
 374 (** {2 Grammar} *)
 375
 376 let parse_level1_pattern_ref = ref (fun _ _ -> assert false)
 377 let parse_level2_ast_ref = ref (fun _ -> assert false)
 378 let parse_level2_meta_ref = ref (fun _ -> assert false)
 379
 380 let fold_cluster binder terms ty body =
 381   List.fold_right
 382     (fun term body -> Ast.Binder (binder, (term, ty), body))
 383     terms body  (* terms are names: either Ident or FreshVar *)
 384
 385 let fold_exists terms ty body =
 386   List.fold_right
 387     (fun term body ->
 388       let lambda = Ast.Binder (`Lambda, (term, ty), body) in
 389       Ast.Appl [ Ast.Symbol ("exists", 0); lambda ])
 390     terms body
 391
 392 let fold_binder binder pt_names body =
 393   List.fold_right
 394     (fun (names, ty) body -> fold_cluster binder names ty body)
 395     pt_names body
 396
 397 let return_term loc term = Ast.AttributedTerm (`Loc loc, term)
 398 let return_term_of_level loc term l =
 399   Ast.AttributedTerm (`Loc loc, term l)
 400
 401   (* create empty precedence level for "term" *)
 402 let initialize_grammars () =
 403   let dummy_action =
 404     Gramext.action (fun _ ->
 405       failwith "internal error, lexer generated a dummy token")
 406   in
 407   (* Needed since campl4 on "delete_rule" remove the precedence level if it gets
 408    * empty after the deletion. The lexer never generate the Stoken below. *)
 409   let dummy_prod = [ [ Gramext.Stoken ("DUMMY", "") ], dummy_action ] in
 410   let mk_level_list first last =
 411     let rec aux acc = function
 412       | i when i < first -> acc
 413       | i ->
 414           aux
 415             ((Some (level_of i), Some Gramext.NonA, dummy_prod)
 416              :: acc)
 417             (i - 1)
 418     in
 419     aux [] last
 420   in
 421   Grammar.extend
 422     [ Grammar.Entry.obj (!grammars.term: 'a Grammar.Entry.e),
 423       None,
 424       mk_level_list min_precedence max_precedence ];
 425 (* {{{ Grammar for concrete syntax patterns, notation level 1 *)
 426   begin
 427   let level1_pattern = !grammars.level1_pattern in
 428 EXTEND
 429   GLOBAL: level1_pattern;
 430
 431   level1_pattern: [
 432     [ p = l1_pattern; EOI -> fun l -> CicNotationUtil.boxify (p l) ]
 433   ];
 434   l1_pattern: [
 435     [ p = LIST1 l1_simple_pattern ->
 436         fun l -> List.map (fun x -> x l) p ]
 437   ];
 438   literal: [
 439     [ s = SYMBOL -> `Symbol s
 440     | k = QKEYWORD -> `Keyword k
 441     | n = NUMBER -> `Number n
 442     ]
 443   ];
 444   sep:       [ [ "sep";      sep = literal -> sep ] ];
 445   l1_magic_pattern: [
 446     [ "list0"; p = l1_simple_pattern; sep = OPT sep ->
 447             fun l -> Ast.List0 (p l, sep)
 448     | "list1"; p = l1_simple_pattern; sep = OPT sep ->
 449             fun l -> Ast.List1 (p l, sep)
 450     | "opt";   p = l1_simple_pattern -> fun l -> Ast.Opt (p l)
 451     ]
 452   ];
 453   l1_pattern_variable: [
 454     [ "term"; precedence = NUMBER; id = IDENT ->
 455         Ast.TermVar (id, Ast.Level (int_of_string precedence))
 456     | "number"; id = IDENT -> Ast.NumVar id
 457     | "ident"; id = IDENT -> Ast.IdentVar id
 458     ]
 459   ];
 460   mstyle: [
 461     [ id = IDENT;
 462       v = [ IDENT | NUMBER | COLOR | FLOATWITHUNIT ] -> id, v]];
 463   mpadded: [
 464     [ id = IDENT;
 465       v = [ PERCENTAGE ] -> id, v]];
 466   l1_simple_pattern:
 467     [ "layout" LEFTA
 468       [ p1 = SELF; SYMBOL "\\sub "; p2 = SELF ->
 469           return_term_of_level loc
 470             (fun l -> Ast.Layout (Ast.Sub (p1 l, p2 l)))
 471       | p1 = SELF; SYMBOL "\\sup "; p2 = SELF ->
 472           return_term_of_level loc
 473             (fun l -> Ast.Layout (Ast.Sup (p1 l, p2 l)))
 474       | p1 = SELF; SYMBOL "\\below "; p2 = SELF ->
 475           return_term_of_level loc
 476             (fun l -> Ast.Layout (Ast.Below (p1 l, p2 l)))
 477       | p1 = SELF; SYMBOL "\\above "; p2 = SELF ->
 478           return_term_of_level loc
 479             (fun l -> Ast.Layout (Ast.Above (p1 l, p2 l)))
 480       | p1 = SELF; SYMBOL "\\over "; p2 = SELF ->
 481           return_term_of_level loc
 482             (fun l -> Ast.Layout (Ast.Over (p1 l, p2 l)))
 483       | p1 = SELF; SYMBOL "\\atop "; p2 = SELF ->
 484           return_term_of_level loc
 485             (fun l -> Ast.Layout (Ast.Atop (p1 l, p2 l)))
 486       | p1 = SELF; SYMBOL "\\frac "; p2 = SELF ->
 487           return_term_of_level loc
 488             (fun l -> Ast.Layout (Ast.Frac (p1 l, p2 l)))
 489       | SYMBOL "\\infrule "; p1 = SELF; p2 = SELF; p3 = SELF ->
 490           return_term_of_level loc
 491             (fun l -> Ast.Layout (Ast.InfRule (p1 l, p2 l, p3 l)))
 492       | SYMBOL "\\sqrt "; p = SELF ->
 493           return_term_of_level loc (fun l -> Ast.Layout (Ast.Sqrt p l))
 494       | SYMBOL "\\root "; index = SELF; SYMBOL "\\of "; arg = SELF ->
 495           return_term_of_level loc
 496             (fun l -> Ast.Layout (Ast.Root (arg l, index l)))
 497       | "hbox"; LPAREN; p = l1_pattern; RPAREN ->
 498           return_term_of_level loc
 499             (fun l -> Ast.Layout (Ast.Box ((Ast.H, false, false), p l)))
 500       | "vbox"; LPAREN; p = l1_pattern; RPAREN ->
 501           return_term_of_level loc
 502             (fun l -> Ast.Layout (Ast.Box ((Ast.V, false, false), p l)))
 503       | "hvbox"; LPAREN; p = l1_pattern; RPAREN ->
 504           return_term_of_level loc
 505             (fun l -> Ast.Layout (Ast.Box ((Ast.HV, false, false), p l)))
 506       | "hovbox"; LPAREN; p = l1_pattern; RPAREN ->
 507           return_term_of_level loc
 508             (fun l -> Ast.Layout (Ast.Box ((Ast.HOV, false, false), p l)))
 509       | "break" -> return_term_of_level loc (fun _ -> Ast.Layout Ast.Break)
 510       | "mstyle"; m = LIST1 mstyle ; LPAREN; t = l1_pattern; RPAREN ->
 511           return_term_of_level loc
 512             (fun l ->
 513                Ast.Layout (Ast.Mstyle (m, t l)))
 514       | "mpadded"; m = LIST1 mpadded ; LPAREN; t = l1_pattern; RPAREN ->
 515           return_term_of_level loc
 516             (fun l ->
 517                Ast.Layout (Ast.Mpadded (m, t l)))
 518       | "maction"; m = LIST1 [ LPAREN; l = l1_pattern; RPAREN -> l ] ->
 519            return_term_of_level loc
 520             (fun l -> Ast.Layout (Ast.Maction (List.map (fun x ->
 521               CicNotationUtil.group (x l)) m)))
 522       | LPAREN; p = l1_pattern; RPAREN ->
 523           return_term_of_level loc (fun l -> CicNotationUtil.group (p l))
 524       ]
 525     | "simple" NONA
 526       [ i = IDENT ->
 527          return_term_of_level loc
 528            (fun l -> Ast.Variable (Ast.TermVar (i,Ast.Self l)))
 529       | m = l1_magic_pattern ->
 530              return_term_of_level loc (fun l -> Ast.Magic (m l))
 531       | v = l1_pattern_variable ->
 532              return_term_of_level loc (fun _ -> Ast.Variable v)
 533       | l = literal -> return_term_of_level loc (fun _ -> Ast.Literal l)
 534       ]
 535     ];
 536   END
 537   end;
 538 (* }}} *)
 539 (* {{{ Grammar for ast magics, notation level 2 *)
 540   begin
 541   let level2_meta = !grammars.level2_meta in
 542 EXTEND
 543   GLOBAL: level2_meta;
 544   l2_variable: [
 545     [ "term"; precedence = NUMBER; id = IDENT ->
 546         Ast.TermVar (id,Ast.Level (int_of_string precedence))
 547     | "number"; id = IDENT -> Ast.NumVar id
 548     | "ident"; id = IDENT -> Ast.IdentVar id
 549     | "fresh"; id = IDENT -> Ast.FreshVar id
 550     | "anonymous" -> Ast.TermVar ("_",Ast.Self 0) (* is the level relevant?*)
 551     | id = IDENT -> Ast.TermVar (id,Ast.Self 0)
 552     ]
 553   ];
 554   l2_magic: [
 555     [ "fold"; kind = [ "left" -> `Left | "right" -> `Right ];
 556       base = level2_meta; "rec"; id = IDENT; recursive = level2_meta ->
 557         Ast.Fold (kind, base, [id], recursive)
 558     | "default"; some = level2_meta; none = level2_meta ->
 559         Ast.Default (some, none)
 560     | "if"; p_test = level2_meta;
 561       "then"; p_true = level2_meta;
 562       "else"; p_false = level2_meta ->
 563         Ast.If (p_test, p_true, p_false)
 564     | "fail" -> Ast.Fail
 565     ]
 566   ];
 567   level2_meta: [
 568     [ magic = l2_magic -> Ast.Magic magic
 569     | var = l2_variable -> Ast.Variable var
 570     | blob = UNPARSED_AST ->
 571         !parse_level2_ast_ref (Ulexing.from_utf8_string blob)
 572     ]
 573   ];
 574 END
 575   end;
 576 (* }}} *)
 577 (* {{{ Grammar for ast patterns, notation level 2 *)
 578   begin
 579   let level2_ast = !grammars.level2_ast in
 580   let term = !grammars.term in
 581   let let_defs = !grammars.let_defs in
 582   let protected_binder_vars = !grammars.protected_binder_vars in
 583 EXTEND
 584   GLOBAL: level2_ast term let_defs protected_binder_vars;
 585   level2_ast: [ [ p = term -> p ] ];
 586   sort: [
 587     [ "Prop" -> `Prop
 588     | "Set" -> `Set
 589     | "Type"; SYMBOL "["; n = [ NUMBER| IDENT ]; SYMBOL "]" -> `NType n
 590     | "Type" -> `Type (CicUniv.fresh ())
 591     | "CProp"; SYMBOL "["; n = [ NUMBER| IDENT ]; SYMBOL "]" -> `NCProp n
 592     | "CProp" -> `CProp (CicUniv.fresh ())
 593     ]
 594   ];
 595   explicit_subst: [
 596     [ SYMBOL "\\subst ";  (* to avoid catching frequent "a [1]" cases *)
 597       SYMBOL "[";
 598       substs = LIST1 [
 599         i = IDENT; SYMBOL <:unicode<Assign>> (* ≔ *); t = term -> (i, t)
 600       ] SEP SYMBOL ";";
 601       SYMBOL "]" ->
 602         substs
 603     ]
 604   ];
 605   meta_subst: [
 606     [ s = SYMBOL "_" -> None
 607     | p = term -> Some p ]
 608   ];
 609   meta_substs: [
 610     [ SYMBOL "["; substs = LIST0 meta_subst; SYMBOL "]" -> substs ]
 611   ];
 612   possibly_typed_name: [
 613     [ LPAREN; id = single_arg; SYMBOL ":"; typ = term; RPAREN ->
 614         id, Some typ
 615     | arg = single_arg -> arg, None
 616     | id = PIDENT -> Ast.Ident (id, None), None
 617     | SYMBOL "_" -> Ast.Ident ("_", None), None
 618     | LPAREN; id = PIDENT; SYMBOL ":"; typ = term; RPAREN ->
 619         Ast.Ident (id, None), Some typ
 620     | LPAREN; SYMBOL "_"; SYMBOL ":"; typ = term; RPAREN ->
 621         Ast.Ident ("_", None), Some typ
 622     ]
 623   ];
 624   match_pattern: [
 625     [ SYMBOL "_" -> Ast.Wildcard
 626     | id = IDENT -> Ast.Pattern (id, None, [])
 627     | LPAREN; id = IDENT; vars = LIST1 possibly_typed_name; RPAREN ->
 628        Ast.Pattern (id, None, vars)
 629     | id = IDENT; vars = LIST1 possibly_typed_name ->
 630        Ast.Pattern (id, None, vars)
 631     ]
 632   ];
 633   binder: [
 634     [ SYMBOL <:unicode<Pi>>     (* Π *) -> `Pi
 635     | SYMBOL <:unicode<forall>> (* ∀ *) -> `Forall
 636     | SYMBOL <:unicode<lambda>> (* λ *) -> `Lambda
 637     ]
 638   ];
 639   arg: [
 640     [ LPAREN; names = LIST1 IDENT SEP SYMBOL ",";
 641       SYMBOL ":"; ty = term; RPAREN ->
 642         List.map (fun n -> Ast.Ident (n, None)) names, Some ty
 643     | name = IDENT -> [Ast.Ident (name, None)], None
 644     | blob = UNPARSED_META ->
 645         let meta = !parse_level2_meta_ref (Ulexing.from_utf8_string blob) in
 646         match meta with
 647         | Ast.Variable (Ast.FreshVar _) -> [meta], None
 648         | Ast.Variable (Ast.TermVar ("_",_)) -> [Ast.Ident ("_", None)], None
 649         | _ -> failwith "Invalid bound name."
 650    ]
 651   ];
 652   single_arg: [
 653     [ name = IDENT -> Ast.Ident (name, None)
 654     | blob = UNPARSED_META ->
 655         let meta = !parse_level2_meta_ref (Ulexing.from_utf8_string blob) in
 656         match meta with
 657         | Ast.Variable (Ast.FreshVar _)
 658         | Ast.Variable (Ast.IdentVar _) -> meta
 659         | Ast.Variable (Ast.TermVar ("_",_)) -> Ast.Ident ("_", None)
 660         | _ -> failwith "Invalid index name."
 661     ]
 662   ];
 663   let_defs: [
 664     [ defs = LIST1 [
 665         name = single_arg;
 666         args = LIST1 arg;
 667         index_name = OPT [ "on"; id = single_arg -> id ];
 668         ty = OPT [ SYMBOL ":" ; p = term -> p ];
 669         SYMBOL <:unicode<def>> (* ≝ *); body = term ->
 670           let rec position_of name p = function
 671             | [] -> None, p
 672             | n :: _ when n = name -> Some p, p
 673             | _ :: tl -> position_of name (p + 1) tl
 674           in
 675           let rec find_arg name n = function
 676             | [] ->
 677                 Ast.fail loc (sprintf "Argument %s not found"
 678                   (CicNotationPp.pp_term name))
 679             | (l,_) :: tl ->
 680                 (match position_of name 0 l with
 681                 | None, len -> find_arg name (n + len) tl
 682                 | Some where, len -> n + where)
 683           in
 684           let index =
 685             match index_name with
 686             | None -> 0
 687             | Some index_name -> find_arg index_name 0 args
 688           in
 689           let args =
 690            List.concat
 691             (List.map
 692              (function (names,ty) -> List.map (function x -> x,ty) names
 693              ) args)
 694           in
 695            args, (name, ty), body, index
 696       ] SEP "and" ->
 697         defs
 698     ]
 699   ];
 700   binder_vars: [
 701     [ vars = [ l =
 702         [ l = LIST1 single_arg SEP SYMBOL "," -> l
 703         | l = LIST1 [ PIDENT | SYMBOL "_" ] SEP SYMBOL "," ->
 704             List.map (fun x -> Ast.Ident(x,None)) l
 705       ] -> l ];
 706       typ = OPT [ SYMBOL ":"; t = term -> t ] -> (vars, typ)
 707     ]
 708   ];
 709   protected_binder_vars: [
 710     [ LPAREN; vars = binder_vars; RPAREN -> vars
 711     ]
 712   ];
 713   maybe_protected_binder_vars: [
 714     [ vars = binder_vars -> vars
 715     | vars = protected_binder_vars -> vars
 716     ]
 717   ];
 718   term: LEVEL "10"
 719   [
 720     [ "let";
 721      var =
 722       [ LPAREN; id = single_arg; SYMBOL ":"; typ = term; RPAREN ->
 723           id, Some typ
 724       | id = IDENT; ty = OPT [ SYMBOL ":"; typ = term -> typ] ->
 725           Ast.Ident(id,None), ty ];
 726       SYMBOL <:unicode<def>> (* ≝ *);
 727       p1 = term; "in"; p2 = term ->
 728         return_term loc (Ast.LetIn (var, p1, p2))
 729     | LETCOREC; defs = let_defs; "in";
 730       body = term ->
 731         return_term loc (Ast.LetRec (`CoInductive, defs, body))
 732     | LETREC; defs = let_defs; "in";
 733       body = term ->
 734         return_term loc (Ast.LetRec (`Inductive, defs, body))
 735     ]
 736   ];
 737   term: LEVEL "20"
 738     [
 739       [ b = binder; (vars, typ) = maybe_protected_binder_vars; SYMBOL "."; body = term LEVEL "19" ->
 740           return_term loc (fold_cluster b vars typ body)
 741       ]
 742     ];
 743   term: LEVEL "70"
 744     [
 745       [ p1 = term; p2 = term LEVEL "71" ->
 746           let rec aux = function
 747             | Ast.Appl (hd :: tl)
 748             | Ast.AttributedTerm (_, Ast.Appl (hd :: tl)) ->
 749                 aux hd @ tl
 750             | term -> [term]
 751           in
 752           return_term loc (Ast.Appl (aux p1 @ [p2]))
 753       ]
 754     ];
 755   term: LEVEL "90"
 756     [
 757       [ id = IDENT -> return_term loc (Ast.Ident (id, None))
 758       | id = IDENT; s = explicit_subst ->
 759           return_term loc (Ast.Ident (id, Some s))
 760       | s = CSYMBOL -> return_term loc (Ast.Symbol (s, 0))
 761       | u = URI -> return_term loc (Ast.Uri (u, None))
 762       | r = NREF -> return_term loc (Ast.NRef (NReference.reference_of_string r))
 763       | n = NUMBER -> return_term loc (Ast.Num (n, 0))
 764       | IMPLICIT -> return_term loc (Ast.Implicit `JustOne)
 765       | SYMBOL <:unicode<ldots>> -> return_term loc (Ast.Implicit `Vector)
 766       | PLACEHOLDER -> return_term loc Ast.UserInput
 767       | m = META -> return_term loc (Ast.Meta (int_of_string m, []))
 768       | m = META; s = meta_substs ->
 769           return_term loc (Ast.Meta (int_of_string m, s))
 770       | s = sort -> return_term loc (Ast.Sort s)
 771       | "match"; t = term;
 772         indty_ident = OPT [ "in"; id = IDENT -> id, None ];
 773         outtyp = OPT [ "return"; ty = term -> ty ];
 774         "with"; SYMBOL "[";
 775         patterns = LIST0 [
 776           lhs = match_pattern; SYMBOL <:unicode<Rightarrow>> (* ⇒ *);
 777           rhs = term ->
 778             lhs, rhs
 779         ] SEP SYMBOL "|";
 780         SYMBOL "]" ->
 781           return_term loc (Ast.Case (t, indty_ident, outtyp, patterns))
 782       | LPAREN; p1 = term; SYMBOL ":"; p2 = term; RPAREN ->
 783           return_term loc (Ast.Cast (p1, p2))
 784       | LPAREN; p = term; RPAREN -> p
 785       | blob = UNPARSED_META ->
 786           !parse_level2_meta_ref (Ulexing.from_utf8_string blob)
 787       ]
 788     ];
 789 END
 790   end
 791 (* }}} *)
 792 ;;
 793
 794 let _ = initialize_grammars ();;
 795
 796 let history = ref [];;
 797
 798 let push () =
 799   CicNotationLexer.push ();
 800   history := (!owned_keywords,!grammars) :: !history;
 801   owned_keywords := (initial_owned_keywords ());
 802   grammars := initial_grammars ();
 803   initialize_grammars ()
 804 ;;
 805
 806 let pop () =
 807   CicNotationLexer.pop ();
 808   match !history with
 809   | [] -> assert false
 810   | (kw,gram) :: old_history ->
 811       owned_keywords := kw;
 812       grammars := gram;
 813       history := old_history
 814 ;;
 815
 816 (** {2 API implementation} *)
 817
 818 let exc_located_wrapper f =
 819   try
 820     f ()
 821   with
 822   | Ploc.Exc (floc, Stream.Error msg) ->
 823       raise (HExtlib.Localized (floc, Parse_error msg))
 824   | Ploc.Exc (floc, HExtlib.Localized (_,exn)) ->
 825       raise (HExtlib.Localized (floc, (Parse_error (Printexc.to_string exn))))
 826   | Ploc.Exc (floc, exn) ->
 827       raise (HExtlib.Localized (floc, (Parse_error (Printexc.to_string exn))))
 828
 829 let parse_level1_pattern precedence lexbuf =
 830   exc_located_wrapper
 831     (fun () -> Grammar.Entry.parse !grammars.level1_pattern (Obj.magic lexbuf) precedence)
 832
 833 let parse_level2_ast lexbuf =
 834   exc_located_wrapper
 835     (fun () -> Grammar.Entry.parse !grammars.level2_ast (Obj.magic lexbuf))
 836
 837 let parse_level2_meta lexbuf =
 838   exc_located_wrapper
 839     (fun () -> Grammar.Entry.parse !grammars.level2_meta (Obj.magic lexbuf))
 840
 841 let _ =
 842   parse_level1_pattern_ref := parse_level1_pattern;
 843   parse_level2_ast_ref := parse_level2_ast;
 844   parse_level2_meta_ref := parse_level2_meta
 845
 846 let parse_term lexbuf =
 847   exc_located_wrapper
 848     (fun () -> (Grammar.Entry.parse !grammars.term (Obj.magic lexbuf)))
 849
 850 let level2_ast_grammar () = !grammars.level2_ast_grammar
 851 let term  () = !grammars.term
 852 let let_defs  () = !grammars.let_defs
 853 let protected_binder_vars  () = !grammars.protected_binder_vars
 854
 855
 856 (** {2 Debugging} *)
 857
 858 let print_l2_pattern () =
 859   Grammar.print_entry Format.std_formatter (Grammar.Entry.obj !grammars.term);
 860   Format.pp_print_flush Format.std_formatter ();
 861   flush stdout
 862
 863 (* vim:set encoding=utf8 foldmethod=marker: *)