helm/software/components/lexicon/lexiconAst.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 type direction = [ `LeftToRight | `RightToLeft ]
  29
  30 type loc = Stdpp.location
  31
  32 type alias_spec =
  33   | Ident_alias of string * string        (* identifier, uri *)
  34   | Symbol_alias of string * int * string (* name, instance no, description *)
  35   | Number_alias of int * string          (* instance no, description *)
  36
  37 (** To be increased each time the command type below changes, used for "safe"
  38  * marshalling *)
  39 let magic = 6
  40
  41 type inclusion_mode = WithPreferences | WithoutPreferences (* aka aliases *)
  42
  43 type command =
  44   | Include of loc * string * inclusion_mode * string (* _,buri,_,path *)
  45   | Alias of loc * alias_spec
  46       (** parameters, name, type, fields *)
  47   | Notation of loc * direction option * CicNotationPt.term * Gramext.g_assoc *
  48       int * CicNotationPt.term
  49       (* direction, l1 pattern, associativity, precedence, l2 pattern *)
  50   | Interpretation of loc *
  51       string * (string * CicNotationPt.argument_pattern list) *
  52         CicNotationPt.cic_appl_pattern
  53       (* description (i.e. id), symbol, arg pattern, appl pattern *)
  54
  55 (* composed magic: term + command magics. No need to change this value *)
  56 let magic = magic + 10000 * CicNotationPt.magic
  57