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