helm/ocaml/cic_notation/cicNotationPt.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 (** CIC Notation Parse Tree *)
  27
  28 type binder_kind = [ `Lambda | `Pi | `Exists | `Forall ]
  29 type induction_kind = [ `Inductive | `CoInductive ]
  30 type sort_kind = [ `Prop | `Set | `Type | `CProp ]
  31 type fold_kind = [ `Left | `Right ]
  32
  33 type location = Lexing.position * Lexing.position
  34 (* cut and past from CicAst.loc_of_floc *)
  35 let loc_of_floc = function
  36   | { Lexing.pos_cnum = loc_begin }, { Lexing.pos_cnum = loc_end } ->
  37       (loc_begin, loc_end)
  38 let fail floc msg =
  39   let (x, y) = loc_of_floc floc in
  40   failwith (Printf.sprintf "Error at characters %d - %d: %s" x y msg)
  41
  42 type term_attribute =
  43   [ `Loc of location                  (* source file location *)
  44   | `IdRef of string                  (* ACic pointer *)
  45   | `Href of UriManager.uri list      (* hyperlinks for literals *)
  46   | `Level of int * Gramext.g_assoc   (* precedence, associativity *)
  47   | `XmlAttrs of (string option * string * string) list
  48       (* list of XML attributes: namespace, name, value *)
  49   ]
  50
  51 type literal =
  52   [ `Symbol of string
  53   | `Keyword of string
  54   | `Number of string
  55   ]
  56
  57 type term =
  58   (* CIC AST *)
  59
  60   | AttributedTerm of term_attribute * term
  61
  62   | Appl of term list
  63   | Binder of binder_kind * capture_variable * term (* kind, name, body *)
  64   | Case of term * string option * term option * (case_pattern * term) list
  65       (* what to match, inductive type, out type, <pattern,action> list *)
  66   | Cast of term * term
  67   | LetIn of capture_variable * term * term  (* name, body, where *)
  68   | LetRec of induction_kind * (capture_variable * term * int) list * term
  69       (* (name, body, decreasing argument) list, where *)
  70   | Ident of string * subst list option
  71       (* literal, substitutions.
  72       * Some [] -> user has given an empty explicit substitution list
  73       * None -> user has given no explicit substitution list *)
  74   | Implicit
  75   | Meta of int * meta_subst list
  76   | Num of string * int (* literal, instance *)
  77   | Sort of sort_kind
  78   | Symbol of string * int  (* canonical name, instance *)
  79
  80   | UserInput (* place holder for user input, used by MatitaConsole, not to be
  81               used elsewhere *)
  82   | Uri of string * subst list option (* as Ident, for long names *)
  83
  84   (* Syntax pattern extensions *)
  85
  86   | Literal of literal
  87   | Layout of layout_pattern
  88
  89   | Magic of magic_term
  90   | Variable of pattern_variable
  91
  92   (* name, type. First component must be Ident or Variable (FreshVar _) *)
  93 and capture_variable = term * term option
  94
  95 and meta_subst = term option
  96 and subst = string * term
  97 and case_pattern = string * capture_variable list
  98
  99 and box_kind = H | V | HV | HOV
 100 and box_spec = box_kind * bool * bool (* kind, spacing, indent *)
 101
 102 and layout_pattern =
 103   | Sub of term * term
 104   | Sup of term * term
 105   | Below of term * term
 106   | Above of term * term
 107   | Frac of term * term
 108   | Over of term * term
 109   | Atop of term * term
 110 (*   | array of term * literal option * literal option
 111       |+ column separator, row separator +| *)
 112   | Sqrt of term
 113   | Root of term * term (* argument, index *)
 114   | Break
 115   | Box of box_spec * term list
 116   | Group of term list
 117
 118 and magic_term =
 119   (* level 1 magics *)
 120   | List0 of term * literal option (* pattern, separator *)
 121   | List1 of term * literal option (* pattern, separator *)
 122   | Opt of term
 123
 124   (* level 2 magics *)
 125   | Fold of fold_kind * term * string list * term
 126     (* base case pattern, recursive case bound names, recursive case pattern *)
 127   | Default of term * term  (* "some" case pattern, "none" case pattern *)
 128   | Fail
 129   | If of term * term * term (* test, pattern if true, pattern if false *)
 130
 131 and pattern_variable =
 132   (* level 1 and 2 variables *)
 133   | NumVar of string
 134   | IdentVar of string
 135   | TermVar of string
 136
 137   (* level 1 variables *)
 138   | Ascription of term * string
 139
 140   (* level 2 variables *)
 141   | FreshVar of string
 142
 143 type argument_pattern =
 144   | IdentArg of int * string (* eta-depth, name *)
 145
 146 type cic_appl_pattern =
 147   | UriPattern of UriManager.uri
 148   | VarPattern of string
 149   | ImplicitPattern
 150   | ApplPattern of cic_appl_pattern list
 151
 152 (** {2 Standard precedences} *)
 153
 154 let let_in_prec = 10
 155 let binder_prec = 20
 156 let apply_prec = 70
 157 let simple_prec = 90
 158
 159 let let_in_assoc = Gramext.NonA
 160 let binder_assoc = Gramext.RightA
 161 let apply_assoc = Gramext.LeftA
 162 let simple_assoc = Gramext.NonA
 163