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