helm/ocaml/cic_notation/cicNotationEnv.mli

   1 (* Copyright (C) 2004-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 Value_not_found of string
  27
  28 type value =
  29   | TermValue of CicNotationPt.term
  30   | StringValue of string
  31   | NumValue of string
  32   | OptValue of value option
  33   | ListValue of value list
  34
  35 type value_type =
  36   | TermType
  37   | StringType
  38   | NumType
  39   | OptType of value_type
  40   | ListType of value_type
  41
  42 type declaration = string * value_type
  43 type binding = string * (value_type * value)
  44 type env_type = binding list
  45
  46   (** fills a term pattern instantiating variable magics *)
  47 val instantiate: env:env_type -> CicNotationPt.term -> CicNotationPt.term
  48
  49 (** {2 Bindings mangling} *)
  50
  51 val opt_binding_some: binding -> binding          (* v -> Some v *)
  52 val opt_binding_none: binding -> binding          (* v -> None *)
  53
  54 val opt_binding_of_name:  declaration -> binding  (* None binding *)
  55 val list_binding_of_name: declaration -> binding  (* [] binding *)
  56
  57 val opt_declaration:  declaration -> declaration  (* t -> OptType t *)
  58 val list_declaration: declaration -> declaration  (* t -> ListType t *)
  59