]> matita.cs.unibo.it Git - helm.git/blob - helm/software/components/content_pres/cicNotationParser.ml
support for mathml mpadded tag added (allows to overlap two subsequent symbols);...
[helm.git] / 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   and aux_magic magic =
191     match magic with
192     | Ast.Opt p ->
193         let p_bindings, p_atoms, p_names, p_action = inner_pattern p in
194         let action (env_opt : CicNotationEnv.t option) (loc : Ast.location) =
195           match env_opt with
196           | Some env -> List.map Env.opt_binding_some env
197           | None -> List.map Env.opt_binding_of_name p_names
198         in
199         [ Env (List.map Env.opt_declaration p_names),
200           Gramext.srules
201             [ [ Gramext.Sopt (Gramext.srules [ p_atoms, p_action ]) ],
202               Gramext.action action ] ]
203     | Ast.List0 (p, _)
204     | Ast.List1 (p, _) ->
205         let p_bindings, p_atoms, p_names, p_action = inner_pattern p in
206         let action (env_list : CicNotationEnv.t list) (loc : Ast.location) =
207           CicNotationEnv.coalesce_env p_names env_list
208         in
209         let gram_of_list s =
210           match magic with
211           | Ast.List0 (_, None) -> Gramext.Slist0 s
212           | Ast.List1 (_, None) -> Gramext.Slist1 s
213           | Ast.List0 (_, Some l) -> Gramext.Slist0sep (s, gram_of_literal l)
214           | Ast.List1 (_, Some l) -> Gramext.Slist1sep (s, gram_of_literal l)
215           | _ -> assert false
216         in
217         [ Env (List.map Env.list_declaration p_names),
218           Gramext.srules
219             [ [ gram_of_list (Gramext.srules [ p_atoms, p_action ]) ],
220               Gramext.action action ] ]
221     | _ -> assert false
222   and aux_variable =
223     function
224     | Ast.NumVar s -> [Binding (s, Env.NumType), gram_number ""]
225     | Ast.TermVar (s,(Ast.Self level|Ast.Level level as lv)) -> 
226         [Binding (s, Env.TermType level), gram_term lv]
227     | Ast.IdentVar s -> [Binding (s, Env.StringType), gram_ident ""]
228     | Ast.Ascription (p, s) -> assert false (* TODO *)
229     | Ast.FreshVar _ -> assert false
230   and inner_pattern p =
231     let p_bindings, p_atoms = List.split (aux p) in
232     let p_names = flatten_opt p_bindings in
233     let action =
234       make_action (fun (env : CicNotationEnv.t) (loc : Ast.location) -> env)
235         p_bindings
236     in
237     p_bindings, p_atoms, p_names, action
238   in
239   aux pattern
240
241 type rule_id = Grammar.token Gramext.g_symbol list
242
243 let compare_rule_id x y =
244   let rec aux = function
245     | [],[] -> 0
246     | [],_ -> ~-1
247     | _,[] -> 1
248     | ((s1::tl1) as x),((s2::tl2) as y) ->
249         if Gramext.eq_symbol s1 s2 then aux (tl1,tl2)
250         else Pervasives.compare x y 
251   in
252     aux (x,y)
253
254   (* mapping: rule_id -> owned keywords. (rule_id, string list) Hashtbl.t *)
255 let initial_owned_keywords () = Hashtbl.create 23
256 let owned_keywords = ref (initial_owned_keywords ())
257
258 type checked_l1_pattern = CL1P of CicNotationPt.term * int
259
260 let check_l1_pattern level1_pattern level associativity =
261   let variables = ref 0 in
262   let symbols = ref 0 in
263   let rec aux = function
264     | Ast.AttributedTerm (att, t) -> Ast.AttributedTerm (att,aux t)
265     | Ast.Literal _ as l -> incr symbols; l
266     | Ast.Layout l -> Ast.Layout (aux_layout l)
267     | Ast.Magic m -> Ast.Magic (aux_magic m)
268     | Ast.Variable v -> (aux_variable v)
269     | t -> assert false
270   and aux_layout = function
271     | Ast.Sub (p1, p2)   -> let p1 = aux p1 in let p2 = aux p2 in Ast.Sub (p1, p2)
272     | Ast.Sup (p1, p2)   -> let p1 = aux p1 in let p2 = aux p2 in Ast.Sup (p1, p2)
273     | Ast.Below (p1, p2) -> let p1 = aux p1 in let p2 = aux p2 in Ast.Below (p1, p2)
274     | Ast.Above (p1, p2) -> let p1 = aux p1 in let p2 = aux p2 in Ast.Above (p1, p2)
275     | Ast.Frac (p1, p2)  -> let p1 = aux p1 in let p2 = aux p2 in Ast.Frac (p1, p2)
276     | 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)
277     | Ast.Atop (p1, p2)  -> let p1 = aux p1 in let p2 = aux p2 in Ast.Atop (p1, p2)
278     | Ast.Over (p1, p2)  -> let p1 = aux p1 in let p2 = aux p2 in Ast.Over (p1, p2)
279     | Ast.Root (p1, p2)  -> let p1 = aux p1 in let p2 = aux p2 in Ast.Root (p1, p2)
280     | Ast.Sqrt p -> Ast.Sqrt (aux p)
281     | Ast.Break as t -> t 
282     | Ast.Box (b, pl) -> Ast.Box(b, List.map aux pl)
283     | Ast.Group pl -> Ast.Group (List.map aux pl)
284     | Ast.Mstyle (l,pl) -> Ast.Mstyle (l, List.map aux pl)
285     | Ast.Mpadded (l,pl) -> Ast.Mpadded (l, List.map aux pl)
286   and aux_magic magic =
287     match magic with
288     | Ast.Opt p -> Ast.Opt (aux p)
289     | Ast.List0 (p, x) -> Ast.List0 (aux p, x)
290     | Ast.List1 (p, x) -> Ast.List1 (aux p, x)
291     | _ -> assert false
292   and aux_variable =
293     function
294     | Ast.NumVar _ as t -> Ast.Variable t
295     | Ast.TermVar (s,Ast.Self _) when associativity <> Gramext.NonA -> 
296         incr variables; 
297         if !variables > 2 then
298           raise (Parse_error ("Exactly 2 variables must be specified in an "^
299           "associative notation"));
300         (match !variables, associativity with
301         | 1,Gramext.LeftA -> 
302              Ast.Variable (Ast.TermVar (s, Ast.Self level))
303         | 1,Gramext.RightA -> 
304              Ast.Variable (Ast.TermVar (s, Ast.Self (level+1)))
305         | 2,Gramext.LeftA ->
306              Ast.Variable (Ast.TermVar (s, Ast.Self (level+1)))
307         | 2,Gramext.RightA -> 
308              Ast.Variable (Ast.TermVar (s, Ast.Level (level-1)))
309         | _ -> assert false)
310     | Ast.TermVar (s,Ast.Level _) when associativity <> Gramext.NonA -> 
311           raise (Parse_error ("Variables can not be declared with a " ^ 
312             "precedence in an associative notation"))
313        (*avoid camlp5 divergence due to non-Sself recursion at the same level *)
314     | Ast.TermVar (s,Ast.Level l) when l<=level && !variables=0 && !symbols=0-> 
315        raise(Parse_error("Left recursive rule with precedence not greater " ^
316         "than " ^ string_of_int level ^ " is not allowed to avoid divergence"))
317     | Ast.TermVar _ as t -> incr variables; Ast.Variable t
318     | Ast.IdentVar _ as t -> Ast.Variable t
319     | Ast.Ascription _ -> assert false (* TODO *)
320     | Ast.FreshVar _ -> assert false
321   in
322   if associativity <> Gramext.NonA && level = min_precedence then
323     raise (Parse_error ("You can not specify an associative notation " ^
324     "at level "^string_of_int min_precedence ^ "; increase it"));
325   let cp = aux level1_pattern in
326 (*   prerr_endline ("checked_pattern: " ^ CicNotationPp.pp_term cp); *)
327   if !variables <> 2 && associativity <> Gramext.NonA then
328     raise (Parse_error ("Exactly 2 variables must be specified in an "^
329      "associative notation"));
330   CL1P (cp,level)
331 ;;
332
333 let extend (CL1P (level1_pattern,precedence)) action =
334   let p_bindings, p_atoms =
335     List.split (extract_term_production level1_pattern)
336   in
337   let level = level_of precedence in
338   let _ =
339     Grammar.extend
340       [ Grammar.Entry.obj (!grammars.term: 'a Grammar.Entry.e),
341         Some (Gramext.Level level),
342         [ None,
343           Some (*Gramext.NonA*) Gramext.NonA,
344           [ p_atoms, 
345             (make_action
346               (fun (env: CicNotationEnv.t) (loc: Ast.location) ->
347                 (action env loc))
348               p_bindings) ]]]
349   in
350   let keywords = CicNotationUtil.keywords_of_term level1_pattern in
351   let rule_id = p_atoms in
352   List.iter CicNotationLexer.add_level2_ast_keyword keywords;
353   Hashtbl.add !owned_keywords rule_id keywords;  (* keywords may be [] *)
354   rule_id
355
356 let delete rule_id =
357   let atoms = rule_id in
358   (try
359     let keywords = Hashtbl.find !owned_keywords rule_id in
360     List.iter CicNotationLexer.remove_level2_ast_keyword keywords
361   with Not_found -> assert false);
362   Grammar.delete_rule !grammars.term atoms
363
364 (** {2 Grammar} *)
365
366 let parse_level1_pattern_ref = ref (fun _ _ -> assert false)
367 let parse_level2_ast_ref = ref (fun _ -> assert false)
368 let parse_level2_meta_ref = ref (fun _ -> assert false)
369
370 let fold_cluster binder terms ty body =
371   List.fold_right
372     (fun term body -> Ast.Binder (binder, (term, ty), body))
373     terms body  (* terms are names: either Ident or FreshVar *)
374
375 let fold_exists terms ty body =
376   List.fold_right
377     (fun term body ->
378       let lambda = Ast.Binder (`Lambda, (term, ty), body) in
379       Ast.Appl [ Ast.Symbol ("exists", 0); lambda ])
380     terms body
381
382 let fold_binder binder pt_names body =
383   List.fold_right
384     (fun (names, ty) body -> fold_cluster binder names ty body)
385     pt_names body
386
387 let return_term loc term = Ast.AttributedTerm (`Loc loc, term)
388 let return_term_of_level loc term l = 
389   Ast.AttributedTerm (`Loc loc, term l)
390
391   (* create empty precedence level for "term" *)
392 let initialize_grammars () =
393   let dummy_action =
394     Gramext.action (fun _ ->
395       failwith "internal error, lexer generated a dummy token")
396   in
397   (* Needed since campl4 on "delete_rule" remove the precedence level if it gets
398    * empty after the deletion. The lexer never generate the Stoken below. *)
399   let dummy_prod = [ [ Gramext.Stoken ("DUMMY", "") ], dummy_action ] in
400   let mk_level_list first last =
401     let rec aux acc = function
402       | i when i < first -> acc
403       | i ->
404           aux
405             ((Some (level_of i), Some Gramext.NonA, dummy_prod)
406              :: acc)
407             (i - 1)
408     in
409     aux [] last
410   in
411   Grammar.extend
412     [ Grammar.Entry.obj (!grammars.term: 'a Grammar.Entry.e),
413       None,
414       mk_level_list min_precedence max_precedence ];
415 (* {{{ Grammar for concrete syntax patterns, notation level 1 *)
416   begin
417   let level1_pattern = !grammars.level1_pattern in
418 EXTEND
419   GLOBAL: level1_pattern;
420
421   level1_pattern: [ 
422     [ p = l1_pattern; EOI -> fun l -> CicNotationUtil.boxify (p l) ] 
423   ];
424   l1_pattern: [ 
425     [ p = LIST1 l1_simple_pattern -> 
426         fun l -> List.map (fun x -> x l) p ] 
427   ];
428   literal: [
429     [ s = SYMBOL -> `Symbol s
430     | k = QKEYWORD -> `Keyword k
431     | n = NUMBER -> `Number n
432     ]
433   ];
434   sep:       [ [ "sep";      sep = literal -> sep ] ];
435   l1_magic_pattern: [
436     [ "list0"; p = l1_simple_pattern; sep = OPT sep -> 
437             fun l -> Ast.List0 (p l, sep)
438     | "list1"; p = l1_simple_pattern; sep = OPT sep -> 
439             fun l -> Ast.List1 (p l, sep)
440     | "opt";   p = l1_simple_pattern -> fun l -> Ast.Opt (p l)
441     ]
442   ];
443   l1_pattern_variable: [
444     [ "term"; precedence = NUMBER; id = IDENT -> 
445         Ast.TermVar (id, Ast.Level (int_of_string precedence))
446     | "number"; id = IDENT -> Ast.NumVar id
447     | "ident"; id = IDENT -> Ast.IdentVar id
448     ]
449   ];
450   mstyle: [ 
451     [ id = IDENT; 
452       v = [ IDENT | NUMBER | COLOR | FLOATWITHUNIT ] -> id, v]];
453   mpadded: [ 
454     [ id = IDENT; 
455       v = [ PERCENTAGE ] -> id, v]];
456   l1_simple_pattern:
457     [ "layout" LEFTA
458       [ p1 = SELF; SYMBOL "\\sub"; p2 = SELF ->
459           return_term_of_level loc 
460             (fun l -> Ast.Layout (Ast.Sub (p1 l, p2 l)))
461       | p1 = SELF; SYMBOL "\\sup"; p2 = SELF ->
462           return_term_of_level loc 
463             (fun l -> Ast.Layout (Ast.Sup (p1 l, p2 l)))
464       | p1 = SELF; SYMBOL "\\below"; p2 = SELF ->
465           return_term_of_level loc 
466             (fun l -> Ast.Layout (Ast.Below (p1 l, p2 l)))
467       | p1 = SELF; SYMBOL "\\above"; p2 = SELF ->
468           return_term_of_level loc 
469             (fun l -> Ast.Layout (Ast.Above (p1 l, p2 l)))
470       | p1 = SELF; SYMBOL "\\over"; p2 = SELF ->
471           return_term_of_level loc 
472             (fun l -> Ast.Layout (Ast.Over (p1 l, p2 l)))
473       | p1 = SELF; SYMBOL "\\atop"; p2 = SELF ->
474           return_term_of_level loc 
475             (fun l -> Ast.Layout (Ast.Atop (p1 l, p2 l)))
476       | p1 = SELF; SYMBOL "\\frac"; p2 = SELF ->
477           return_term_of_level loc 
478             (fun l -> Ast.Layout (Ast.Frac (p1 l, p2 l)))
479       | SYMBOL "\\infrule"; p1 = SELF; p2 = SELF; p3 = SELF ->
480           return_term_of_level loc 
481             (fun l -> Ast.Layout (Ast.InfRule (p1 l, p2 l, p3 l)))
482       | SYMBOL "\\sqrt"; p = SELF -> 
483           return_term_of_level loc (fun l -> Ast.Layout (Ast.Sqrt p l))
484       | SYMBOL "\\root"; index = SELF; SYMBOL "\\of"; arg = SELF ->
485           return_term_of_level loc 
486             (fun l -> Ast.Layout (Ast.Root (arg l, index l)))
487       | "hbox"; LPAREN; p = l1_pattern; RPAREN ->
488           return_term_of_level loc 
489             (fun l -> Ast.Layout (Ast.Box ((Ast.H, false, false), p l)))
490       | "vbox"; LPAREN; p = l1_pattern; RPAREN ->
491           return_term_of_level loc 
492             (fun l -> Ast.Layout (Ast.Box ((Ast.V, false, false), p l)))
493       | "hvbox"; LPAREN; p = l1_pattern; RPAREN ->
494           return_term_of_level loc 
495             (fun l -> Ast.Layout (Ast.Box ((Ast.HV, false, false), p l)))
496       | "hovbox"; LPAREN; p = l1_pattern; RPAREN ->
497           return_term_of_level loc 
498             (fun l -> Ast.Layout (Ast.Box ((Ast.HOV, false, false), p l)))
499       | "break" -> return_term_of_level loc (fun _ -> Ast.Layout Ast.Break)
500       | "mstyle"; m = LIST1 mstyle ; LPAREN; t = l1_pattern; RPAREN ->
501           return_term_of_level loc 
502             (fun l -> 
503                Ast.Layout (Ast.Mstyle (m, t l)))
504       | "mpadded"; m = LIST1 mpadded ; LPAREN; t = l1_pattern; RPAREN ->
505           return_term_of_level loc 
506             (fun l -> 
507                Ast.Layout (Ast.Mpadded (m, t l)))
508       | LPAREN; p = l1_pattern; RPAREN ->
509           return_term_of_level loc (fun l -> CicNotationUtil.group (p l))
510       ]
511     | "simple" NONA
512       [ i = IDENT -> 
513          return_term_of_level loc 
514            (fun l -> Ast.Variable (Ast.TermVar (i,Ast.Self l)))
515       | m = l1_magic_pattern -> 
516              return_term_of_level loc (fun l -> Ast.Magic (m l))
517       | v = l1_pattern_variable -> 
518              return_term_of_level loc (fun _ -> Ast.Variable v)
519       | l = literal -> return_term_of_level loc (fun _ -> Ast.Literal l)
520       ]
521     ];
522   END
523   end;
524 (* }}} *)
525 (* {{{ Grammar for ast magics, notation level 2 *)
526   begin
527   let level2_meta = !grammars.level2_meta in
528 EXTEND
529   GLOBAL: level2_meta;
530   l2_variable: [
531     [ "term"; precedence = NUMBER; id = IDENT -> 
532         Ast.TermVar (id,Ast.Level (int_of_string precedence))
533     | "number"; id = IDENT -> Ast.NumVar id
534     | "ident"; id = IDENT -> Ast.IdentVar id
535     | "fresh"; id = IDENT -> Ast.FreshVar id
536     | "anonymous" -> Ast.TermVar ("_",Ast.Self 0) (* is the level relevant?*)
537     | id = IDENT -> Ast.TermVar (id,Ast.Self 0)
538     ]
539   ];
540   l2_magic: [
541     [ "fold"; kind = [ "left" -> `Left | "right" -> `Right ];
542       base = level2_meta; "rec"; id = IDENT; recursive = level2_meta ->
543         Ast.Fold (kind, base, [id], recursive)
544     | "default"; some = level2_meta; none = level2_meta ->
545         Ast.Default (some, none)
546     | "if"; p_test = level2_meta;
547       "then"; p_true = level2_meta;
548       "else"; p_false = level2_meta ->
549         Ast.If (p_test, p_true, p_false)
550     | "fail" -> Ast.Fail
551     ]
552   ];
553   level2_meta: [
554     [ magic = l2_magic -> Ast.Magic magic
555     | var = l2_variable -> Ast.Variable var
556     | blob = UNPARSED_AST ->
557         !parse_level2_ast_ref (Ulexing.from_utf8_string blob)
558     ]
559   ];
560 END
561   end;
562 (* }}} *)
563 (* {{{ Grammar for ast patterns, notation level 2 *)
564   begin
565   let level2_ast = !grammars.level2_ast in
566   let term = !grammars.term in
567   let let_defs = !grammars.let_defs in
568   let protected_binder_vars = !grammars.protected_binder_vars in
569 EXTEND
570   GLOBAL: level2_ast term let_defs protected_binder_vars;
571   level2_ast: [ [ p = term -> p ] ];
572   sort: [
573     [ "Prop" -> `Prop
574     | "Set" -> `Set
575     | "Type"; SYMBOL "["; n = NUMBER; SYMBOL "]" -> `NType n 
576     | "Type" -> `Type (CicUniv.fresh ()) 
577     | "CProp" -> `CProp (CicUniv.fresh ())
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     | SYMBOL "_" -> Ast.Ident ("_", None), None
602     | LPAREN; SYMBOL "_"; SYMBOL ":"; typ = term; RPAREN ->
603         Ast.Ident ("_", None), Some typ
604     ]
605   ];
606   match_pattern: [
607     [ id = IDENT -> Ast.Pattern (id, None, [])
608     | LPAREN; id = IDENT; vars = LIST1 possibly_typed_name; RPAREN ->
609        Ast.Pattern (id, None, vars)
610     | id = IDENT; vars = LIST1 possibly_typed_name ->
611        Ast.Pattern (id, None, vars)
612     | SYMBOL "_" -> Ast.Wildcard
613     ]
614   ];
615   binder: [
616     [ SYMBOL <:unicode<Pi>>     (* Π *) -> `Pi
617     | SYMBOL <:unicode<forall>> (* ∀ *) -> `Forall
618     | SYMBOL <:unicode<lambda>> (* λ *) -> `Lambda
619     ]
620   ];
621   arg: [
622     [ LPAREN; names = LIST1 IDENT SEP SYMBOL ",";
623       SYMBOL ":"; ty = term; RPAREN ->
624         List.map (fun n -> Ast.Ident (n, None)) names, Some ty
625     | name = IDENT -> [Ast.Ident (name, None)], None
626     | blob = UNPARSED_META ->
627         let meta = !parse_level2_meta_ref (Ulexing.from_utf8_string blob) in
628         match meta with
629         | Ast.Variable (Ast.FreshVar _) -> [meta], None
630         | Ast.Variable (Ast.TermVar ("_",_)) -> [Ast.Ident ("_", None)], None
631         | _ -> failwith "Invalid bound name."
632    ]
633   ];
634   single_arg: [
635     [ name = IDENT -> Ast.Ident (name, None)
636     | blob = UNPARSED_META ->
637         let meta = !parse_level2_meta_ref (Ulexing.from_utf8_string blob) in
638         match meta with
639         | Ast.Variable (Ast.FreshVar _)
640         | Ast.Variable (Ast.IdentVar _) -> meta
641         | Ast.Variable (Ast.TermVar ("_",_)) -> Ast.Ident ("_", None)
642         | _ -> failwith "Invalid index name."
643     ]
644   ];
645   let_defs: [
646     [ defs = LIST1 [
647         name = single_arg;
648         args = LIST1 arg;
649         index_name = OPT [ "on"; id = single_arg -> id ];
650         ty = OPT [ SYMBOL ":" ; p = term -> p ];
651         SYMBOL <:unicode<def>> (* ≝ *); body = term ->
652           let rec position_of name p = function 
653             | [] -> None, p
654             | n :: _ when n = name -> Some p, p
655             | _ :: tl -> position_of name (p + 1) tl
656           in
657           let rec find_arg name n = function 
658             | [] ->
659                 Ast.fail loc (sprintf "Argument %s not found"
660                   (CicNotationPp.pp_term name))
661             | (l,_) :: tl -> 
662                 (match position_of name 0 l with
663                 | None, len -> find_arg name (n + len) tl
664                 | Some where, len -> n + where)
665           in
666           let index = 
667             match index_name with 
668             | None -> 0 
669             | Some index_name -> find_arg index_name 0 args
670           in
671           let args =
672            List.concat
673             (List.map
674              (function (names,ty) -> List.map (function x -> x,ty) names
675              ) args)
676           in
677            args, (name, ty), body, index
678       ] SEP "and" ->
679         defs
680     ]
681   ];
682   binder_vars: [
683     [ vars = [
684           l = LIST1 single_arg SEP SYMBOL "," -> l
685         | SYMBOL "_" -> [Ast.Ident ("_", None)] ];
686       typ = OPT [ SYMBOL ":"; t = term -> t ] -> (vars, typ)
687     ]
688   ];
689   protected_binder_vars: [
690     [ LPAREN; vars = binder_vars; RPAREN -> vars 
691     ]
692   ];
693   maybe_protected_binder_vars: [
694     [ vars = binder_vars -> vars
695     | vars = protected_binder_vars -> vars
696     ]
697   ];
698   term: LEVEL "10"
699   [
700     [ "let"; var = possibly_typed_name; SYMBOL <:unicode<def>> (* ≝ *);
701       p1 = term; "in"; p2 = term ->
702         return_term loc (Ast.LetIn (var, p1, p2))
703     | LETCOREC; defs = let_defs; "in";
704       body = term ->
705         return_term loc (Ast.LetRec (`CoInductive, defs, body))
706     | LETREC; defs = let_defs; "in";
707       body = term ->
708         return_term loc (Ast.LetRec (`Inductive, defs, body))
709     ]
710   ];
711   term: LEVEL "20"
712     [
713       [ b = binder; (vars, typ) = maybe_protected_binder_vars; SYMBOL "."; body = term LEVEL "19" ->
714           return_term loc (fold_cluster b vars typ body)
715       ]
716     ];
717   term: LEVEL "70"
718     [
719       [ p1 = term; p2 = term LEVEL "71" ->
720           let rec aux = function
721             | Ast.Appl (hd :: tl)
722             | Ast.AttributedTerm (_, Ast.Appl (hd :: tl)) ->
723                 aux hd @ tl
724             | term -> [term]
725           in
726           return_term loc (Ast.Appl (aux p1 @ [p2]))
727       ]
728     ];
729   term: LEVEL "90"
730     [
731       [ id = IDENT -> return_term loc (Ast.Ident (id, None))
732       | id = IDENT; s = explicit_subst ->
733           return_term loc (Ast.Ident (id, Some s))
734       | s = CSYMBOL -> return_term loc (Ast.Symbol (s, 0))
735       | u = URI -> return_term loc (Ast.Uri (u, None))
736       | n = NUMBER -> return_term loc (Ast.Num (n, 0))
737       | IMPLICIT -> return_term loc (Ast.Implicit)
738       | PLACEHOLDER -> return_term loc Ast.UserInput
739       | m = META -> return_term loc (Ast.Meta (int_of_string m, []))
740       | m = META; s = meta_substs ->
741           return_term loc (Ast.Meta (int_of_string m, s))
742       | s = sort -> return_term loc (Ast.Sort s)
743       | "match"; t = term;
744         indty_ident = OPT [ "in"; id = IDENT -> id, None ];
745         outtyp = OPT [ "return"; ty = term -> ty ];
746         "with"; SYMBOL "[";
747         patterns = LIST0 [
748           lhs = match_pattern; SYMBOL <:unicode<Rightarrow>> (* ⇒ *);
749           rhs = term ->
750             lhs, rhs
751         ] SEP SYMBOL "|";
752         SYMBOL "]" ->
753           return_term loc (Ast.Case (t, indty_ident, outtyp, patterns))
754       | LPAREN; p1 = term; SYMBOL ":"; p2 = term; RPAREN ->
755           return_term loc (Ast.Cast (p1, p2))
756       | LPAREN; p = term; RPAREN -> p
757       | blob = UNPARSED_META ->
758           !parse_level2_meta_ref (Ulexing.from_utf8_string blob)
759       ]
760     ];
761 END
762   end
763 (* }}} *)
764 ;;
765
766 let _ = initialize_grammars ();;
767
768 let history = ref [];;
769
770 let push () =
771   CicNotationLexer.push ();
772   history := (!owned_keywords,!grammars) :: !history;
773   owned_keywords := (initial_owned_keywords ());
774   grammars := initial_grammars ();
775   initialize_grammars ()
776 ;;
777
778 let pop () =
779   CicNotationLexer.pop ();
780   match !history with
781   | [] -> assert false
782   | (kw,gram) :: old_history ->
783       owned_keywords := kw;
784       grammars := gram;
785       history := old_history
786 ;;
787
788 (** {2 API implementation} *)
789
790 let exc_located_wrapper f =
791   try
792     f ()
793   with
794   | Stdpp.Exc_located (floc, Stream.Error msg) ->
795       raise (HExtlib.Localized (floc, Parse_error msg))
796   | Stdpp.Exc_located (floc, exn) ->
797       raise (HExtlib.Localized (floc, (Parse_error (Printexc.to_string exn))))
798
799 let parse_level1_pattern precedence lexbuf =
800   exc_located_wrapper
801     (fun () -> Grammar.Entry.parse !grammars.level1_pattern (Obj.magic lexbuf) precedence)
802
803 let parse_level2_ast lexbuf =
804   exc_located_wrapper
805     (fun () -> Grammar.Entry.parse !grammars.level2_ast (Obj.magic lexbuf))
806
807 let parse_level2_meta lexbuf =
808   exc_located_wrapper
809     (fun () -> Grammar.Entry.parse !grammars.level2_meta (Obj.magic lexbuf))
810
811 let _ =
812   parse_level1_pattern_ref := parse_level1_pattern;
813   parse_level2_ast_ref := parse_level2_ast;
814   parse_level2_meta_ref := parse_level2_meta
815
816 let parse_term lexbuf =
817   exc_located_wrapper
818     (fun () -> (Grammar.Entry.parse !grammars.term (Obj.magic lexbuf)))
819
820 let level2_ast_grammar () = !grammars.level2_ast_grammar
821 let term  () = !grammars.term
822 let let_defs  () = !grammars.let_defs
823 let protected_binder_vars  () = !grammars.protected_binder_vars
824
825
826 (** {2 Debugging} *)
827
828 let print_l2_pattern () =
829   Grammar.print_entry Format.std_formatter (Grammar.Entry.obj !grammars.term);
830   Format.pp_print_flush Format.std_formatter ();
831   flush stdout  
832
833 (* vim:set encoding=utf8 foldmethod=marker: *)