helm/software/components/content_pres/cicNotationParser.mli

   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 exception Parse_error of string
  27 exception Level_not_found of int
  28
  29 type checked_l1_pattern = private CL1P of CicNotationPt.term * int
  30
  31 (** {2 Parsing functions} *)
  32
  33   (** concrete syntax pattern: notation level 1, the
  34    *  integer is the precedence *)
  35 val parse_level1_pattern: int -> Ulexing.lexbuf -> CicNotationPt.term
  36
  37   (** AST pattern: notation level 2 *)
  38 val parse_level2_ast: Ulexing.lexbuf -> CicNotationPt.term
  39 val parse_level2_meta: Ulexing.lexbuf -> CicNotationPt.term
  40
  41 (** {2 Grammar extension} *)
  42
  43 type rule_id
  44
  45 val compare_rule_id : rule_id -> rule_id -> int
  46
  47 val check_l1_pattern: (* level1_pattern, pponly, precedence, assoc *)
  48  CicNotationPt.term -> bool ->  int -> Gramext.g_assoc -> checked_l1_pattern
  49
  50 val extend:
  51   checked_l1_pattern ->
  52   (CicNotationEnv.t -> CicNotationPt.location -> CicNotationPt.term) ->
  53     rule_id
  54
  55 val delete: rule_id -> unit
  56
  57 (** {2 Grammar entries}
  58  * needed by grafite parser *)
  59
  60 val level2_ast_grammar: unit -> Grammar.g
  61
  62 val term : unit -> CicNotationPt.term Grammar.Entry.e
  63
  64 val let_defs : unit ->
  65   (CicNotationPt.term CicNotationPt.capture_variable list * CicNotationPt.term CicNotationPt.capture_variable * CicNotationPt.term * int) list
  66     Grammar.Entry.e
  67
  68 val protected_binder_vars : unit ->
  69   (CicNotationPt.term list * CicNotationPt.term option) Grammar.Entry.e
  70
  71 val parse_term: Ulexing.lexbuf -> CicNotationPt.term
  72
  73 (** {2 Debugging} *)
  74
  75   (** print "level2_pattern" entry on stdout, flushing afterwards *)
  76 val print_l2_pattern: unit -> unit
  77
  78 val push: unit -> unit
  79 val pop: unit -> unit