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
  39 type term_attribute =
  40   [ `Loc of location                  (* source file location *)
  41   | `IdRef of string                  (* ACic pointer *)
  42   | `Href of UriManager.uri list      (* hyperlinks for literals *)
  43   | `Level of int * Gramext.g_assoc   (* precedence, associativity *)
  44   | `XmlAttrs of (string option * string * string) list
  45       (* list of XML attributes: namespace, name, value *)
  46   ]
  47
  48 type literal =
  49   [ `Symbol of string
  50   | `Keyword of string
  51   | `Number of string
  52   ]
  53
  54 type term =
  55   (* CIC AST *)
  56
  57   | AttributedTerm of term_attribute * term
  58
  59   | Appl of term list
  60   | Binder of binder_kind * capture_variable * term (* kind, name, body *)
  61   | Case of term * string option * term option * (case_pattern * term) list
  62       (* what to match, inductive type, out type, <pattern,action> list *)
  63   | LetIn of capture_variable * term * term  (* name, body, where *)
  64   | LetRec of induction_kind * (capture_variable * term * int) list * term
  65       (* (name, body, decreasing argument) list, where *)
  66   | Ident of string * subst list option
  67       (* literal, substitutions.
  68       * Some [] -> user has given an empty explicit substitution list
  69       * None -> user has given no explicit substitution list *)
  70   | Implicit
  71   | Meta of int * meta_subst list
  72   | Num of string * int (* literal, instance *)
  73   | Sort of sort_kind
  74   | Symbol of string * int  (* canonical name, instance *)
  75
  76   | UserInput (* place holder for user input, used by MatitaConsole, not to be
  77               used elsewhere *)
  78   | Uri of string * subst list option (* as Ident, for long names *)
  79
  80   (* Syntax pattern extensions *)
  81
  82   | Literal of literal
  83   | Layout of layout_pattern
  84
  85   | Magic of magic_term
  86   | Variable of pattern_variable
  87
  88   (* name, type. First component must be Ident or Variable (FreshVar _) *)
  89 and capture_variable = term * term option
  90
  91 and meta_subst = term option
  92 and subst = string * term
  93 and case_pattern = string * capture_variable list
  94
  95 and box_kind = H | V | HV | HOV
  96 and box_spec = box_kind * bool * bool (* kind, spacing, indent *)
  97
  98 and layout_pattern =
  99   | Sub of term * term
 100   | Sup of term * term
 101   | Below of term * term
 102   | Above of term * term
 103   | Frac of term * term
 104   | Over of term * term
 105   | Atop of term * term
 106 (*   | array of term * literal option * literal option
 107       |+ column separator, row separator +| *)
 108   | Sqrt of term
 109   | Root of term * term (* argument, index *)
 110   | Break
 111   | Box of box_spec * term list
 112
 113 and magic_term =
 114   (* level 1 magics *)
 115   | List0 of term * literal option (* pattern, separator *)
 116   | List1 of term * literal option (* pattern, separator *)
 117   | Opt of term
 118
 119   (* level 2 magics *)
 120   | Fold of fold_kind * term * string list * term
 121     (* base case pattern, recursive case bound names, recursive case pattern *)
 122   | Default of term * term  (* "some" case pattern, "none" case pattern *)
 123   | Fail
 124   | If of term * term * term (* test, pattern if true, pattern if false *)
 125
 126 and pattern_variable =
 127   (* level 1 and 2 variables *)
 128   | NumVar of string
 129   | IdentVar of string
 130   | TermVar of string
 131
 132   (* level 1 variables *)
 133   | Ascription of term * string
 134
 135   (* level 2 variables *)
 136   | FreshVar of string
 137
 138 type argument_pattern =
 139   | IdentArg of int * string (* eta-depth, name *)
 140
 141 type cic_appl_pattern =
 142   | UriPattern of UriManager.uri
 143   | VarPattern of string
 144   | ApplPattern of cic_appl_pattern list
 145
 146 type phrase = (* TODO hackish: replace with TacticAst.statement or similar *)
 147   | Print of term
 148   | Notation of term * Gramext.g_assoc option * int option * term
 149       (* level 1 pattern, associativity, precedence, level 2 pattern *)
 150   | Interpretation of (string * argument_pattern list) * cic_appl_pattern
 151   | Render of UriManager.uri
 152   | Dump  (* dump grammar *)
 153