components/acic_content/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 (* $Id$ *)
  27
  28 (** CIC Notation Parse Tree *)
  29
  30 type binder_kind = [ `Lambda | `Pi | `Exists | `Forall ]
  31 type induction_kind = [ `Inductive | `CoInductive ]
  32 type sort_kind = [ `Prop | `Set | `Type of CicUniv.universe | `CProp ]
  33 type fold_kind = [ `Left | `Right ]
  34
  35 type location = Token.flocation
  36 let fail floc msg =
  37   let (x, y) = HExtlib.loc_of_floc floc in
  38   failwith (Printf.sprintf "Error at characters %d - %d: %s" x y msg)
  39
  40 type href = UriManager.uri
  41
  42 type child_pos = [ `Left | `Right | `Inner ]
  43
  44 type term_attribute =
  45   [ `Loc of location                  (* source file location *)
  46   | `IdRef of string                  (* ACic pointer *)
  47   | `Level of int * Gramext.g_assoc   (* precedence, associativity *)
  48   | `ChildPos of child_pos            (* position of l1 pattern variables *)
  49   | `XmlAttrs of (string option * string * string) list
  50       (* list of XML attributes: namespace, name, value *)
  51   | `Raw of string                    (* unparsed version *)
  52   ]
  53
  54 type literal =
  55   [ `Symbol of string
  56   | `Keyword of string
  57   | `Number of string
  58   ]
  59
  60 type case_indtype = string * href option
  61
  62 type 'term capture_variable = 'term * 'term option
  63
  64 (** To be increased each time the term type below changes, used for "safe"
  65  * marshalling *)
  66 let magic = 2
  67
  68 type term =
  69   (* CIC AST *)
  70
  71   | AttributedTerm of term_attribute * term
  72
  73   | Appl of term list
  74   | Binder of binder_kind * term capture_variable * term (* kind, name, body *)
  75   | Case of term * case_indtype option * term option *
  76       (case_pattern * term) list
  77       (* what to match, inductive type, out type, <pattern,action> list *)
  78   | Cast of term * term
  79   | LetIn of term capture_variable * term * term  (* name, body, where *)
  80   | LetRec of induction_kind * (term capture_variable list * term capture_variable * term * int) list * term
  81       (* (params, name, body, decreasing arg) list, where *)
  82   | Ident of string * subst list option
  83       (* literal, substitutions.
  84       * Some [] -> user has given an empty explicit substitution list
  85       * None -> user has given no explicit substitution list *)
  86   | Implicit
  87   | Meta of int * meta_subst list
  88   | Num of string * int (* literal, instance *)
  89   | Sort of sort_kind
  90   | Symbol of string * int  (* canonical name, instance *)
  91
  92   | UserInput (* place holder for user input, used by MatitaConsole, not to be
  93               used elsewhere *)
  94   | Uri of string * subst list option (* as Ident, for long names *)
  95
  96   (* Syntax pattern extensions *)
  97
  98   | Literal of literal
  99   | Layout of layout_pattern
 100
 101   | Magic of magic_term
 102   | Variable of pattern_variable
 103
 104   (* name, type. First component must be Ident or Variable (FreshVar _) *)
 105
 106 and meta_subst = term option
 107 and subst = string * term
 108 and case_pattern = string * href option * term capture_variable list
 109
 110 and box_kind = H | V | HV | HOV
 111 and box_spec = box_kind * bool * bool (* kind, spacing, indent *)
 112
 113 and layout_pattern =
 114   | Sub of term * term
 115   | Sup of term * term
 116   | Below of term * term
 117   | Above of term * term
 118   | Frac of term * term
 119   | Over of term * term
 120   | Atop of term * term
 121 (*   | array of term * literal option * literal option
 122       |+ column separator, row separator +| *)
 123   | Sqrt of term
 124   | Root of term * term (* argument, index *)
 125   | Break
 126   | Box of box_spec * term list
 127   | Group of term list
 128
 129 and magic_term =
 130   (* level 1 magics *)
 131   | List0 of term * literal option (* pattern, separator *)
 132   | List1 of term * literal option (* pattern, separator *)
 133   | Opt of term
 134
 135   (* level 2 magics *)
 136   | Fold of fold_kind * term * string list * term
 137     (* base case pattern, recursive case bound names, recursive case pattern *)
 138   | Default of term * term  (* "some" case pattern, "none" case pattern *)
 139   | Fail
 140   | If of term * term * term (* test, pattern if true, pattern if false *)
 141
 142 and pattern_variable =
 143   (* level 1 and 2 variables *)
 144   | NumVar of string
 145   | IdentVar of string
 146   | TermVar of string
 147
 148   (* level 1 variables *)
 149   | Ascription of term * string
 150
 151   (* level 2 variables *)
 152   | FreshVar of string
 153
 154 type argument_pattern =
 155   | IdentArg of int * string (* eta-depth, name *)
 156
 157 type cic_appl_pattern =
 158   | UriPattern of UriManager.uri
 159   | VarPattern of string
 160   | ImplicitPattern
 161   | ApplPattern of cic_appl_pattern list
 162
 163   (** <name, inductive/coinductive, type, constructor list>
 164   * true means inductive, false coinductive *)
 165 type 'term inductive_type = string * bool * 'term * (string * 'term) list
 166
 167 type 'term obj =
 168   | Inductive of 'term capture_variable list * 'term inductive_type list
 169       (** parameters, list of loc * mutual inductive types *)
 170   | Theorem of Cic.object_flavour * string * 'term * 'term option
 171       (** flavour, name, type, body
 172        * - name is absent when an unnamed theorem is being proved, tipically in
 173        *   interactive usage
 174        * - body is present when its given along with the command, otherwise it
 175        *   will be given in proof editing mode using the tactical language,
 176        *   unless the flavour is an Axiom
 177        *)
 178   | Record of 'term capture_variable list * string * 'term * (string * 'term * bool * int) list
 179       (** left parameters, name, type, fields *)
 180
 181 (** {2 Standard precedences} *)
 182
 183 let let_in_prec = 10
 184 let binder_prec = 20
 185 let apply_prec = 70
 186 let simple_prec = 90
 187
 188 let let_in_assoc = Gramext.NonA
 189 let binder_assoc = Gramext.RightA
 190 let apply_assoc = Gramext.LeftA
 191 let simple_assoc = Gramext.NonA
 192