helm/ocaml/cic_notation/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 Token.flocation * string
  27 exception Level_not_found of int
  28
  29 (** {2 Parsing functions} *)
  30
  31   (** concrete syntax pattern: notation level 1 *)
  32 val parse_level1_pattern: char Stream.t -> CicNotationPt.term
  33
  34   (** AST pattern: notation level 2 *)
  35 val parse_level2_ast: char Stream.t -> CicNotationPt.term
  36 val parse_level2_meta: char Stream.t -> CicNotationPt.term
  37
  38 (** {2 Grammar extension} *)
  39
  40 type rule_id
  41
  42 val extend:
  43   CicNotationPt.term ->
  44   ?precedence:int ->
  45   ?associativity:Gramext.g_assoc ->
  46   (CicNotationEnv.t -> CicNotationPt.location -> CicNotationPt.term) ->
  47     rule_id
  48
  49 val delete: rule_id -> unit
  50
  51 (** {2 Standard precedences} *)
  52
  53 val let_in_prec: int
  54 val binder_prec: int
  55 val apply_prec: int
  56 val simple_prec: int
  57
  58 val let_in_assoc: Gramext.g_assoc
  59 val binder_assoc: Gramext.g_assoc
  60 val apply_assoc: Gramext.g_assoc
  61 val simple_assoc: Gramext.g_assoc
  62
  63 (** {2 Grammar entries}
  64  * needed by grafite parser *)
  65
  66 val level2_ast_grammar: Grammar.g
  67
  68 val term : CicNotationPt.term Grammar.Entry.e
  69 val let_defs :
  70   (CicNotationPt.capture_variable * CicNotationPt.term * int) list Grammar.Entry.e
  71
  72 (** {2 Debugging} *)
  73
  74   (** print "level2_pattern" entry on stdout, flushing afterwards *)
  75 val print_l2_pattern: unit -> unit
  76