matita/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 db
  30
  31 class type g_status =
  32  object
  33   method notation_parser_db: db
  34  end
  35
  36 class status:
  37  object('self)
  38   inherit g_status
  39   method set_notation_parser_db: db -> 'self
  40   method set_notation_parser_status: 'status. #g_status as 'status -> 'self
  41  end
  42
  43 type checked_l1_pattern = private CL1P of NotationPt.term * int
  44
  45 (** {2 Parsing functions} *)
  46
  47   (** concrete syntax pattern: notation level 1, the
  48    *  integer is the precedence *)
  49 val parse_level1_pattern: #status -> int -> Ulexing.lexbuf -> NotationPt.term
  50
  51   (** AST pattern: notation level 2 *)
  52 val parse_level2_ast: #status -> Ulexing.lexbuf -> NotationPt.term
  53 val parse_level2_meta: #status -> Ulexing.lexbuf -> NotationPt.term
  54
  55 (** {2 Grammar extension} *)
  56
  57 val check_l1_pattern: (* level1_pattern, pponly, precedence, assoc *)
  58  NotationPt.term -> bool ->  int -> Gramext.g_assoc -> checked_l1_pattern
  59
  60 val extend:
  61   #status as 'status ->
  62   checked_l1_pattern ->
  63   (NotationEnv.t -> NotationPt.location -> NotationPt.term) ->
  64     'status
  65
  66 (** {2 Grammar entries}
  67  * needed by grafite parser *)
  68
  69 val level2_ast_grammar: #status -> Grammar.g
  70
  71 val term : #status -> NotationPt.term Grammar.Entry.e
  72
  73 val let_defs : #status ->
  74   (NotationPt.term NotationPt.capture_variable list * NotationPt.term NotationPt.capture_variable * NotationPt.term * int) list
  75     Grammar.Entry.e
  76
  77 val protected_binder_vars : #status ->
  78   (NotationPt.term list * NotationPt.term option) Grammar.Entry.e
  79
  80 val parse_term: #status -> Ulexing.lexbuf -> NotationPt.term
  81
  82 (** {2 Debugging} *)
  83
  84   (** print "level2_pattern" entry on stdout, flushing afterwards *)
  85 val print_l2_pattern: #status -> unit