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 (** {2 Types} *)
  29
  30 type value =
  31   | TermValue of CicNotationPt.term
  32   | StringValue of string
  33   | NumValue of string
  34   | OptValue of value option
  35   | ListValue of value list
  36
  37 type value_type =
  38   | TermType
  39   | StringType
  40   | NumType
  41   | OptType of value_type
  42   | ListType of value_type
  43
  44 type declaration = string * value_type
  45 type binding = string * (value_type * value)
  46 type t = binding list
  47
  48 (** {2 Environment lookup} *)
  49
  50 val lookup_value:   t -> string -> value
  51 val lookup_num:     t -> string -> string
  52 val lookup_string:  t -> string -> string
  53 val lookup_term:    t -> string -> CicNotationPt.term
  54
  55 (** {2 Bindings mangling} *)
  56
  57 val opt_binding_some: binding -> binding          (* v -> Some v *)
  58 val opt_binding_none: binding -> binding          (* v -> None *)
  59
  60 val opt_binding_of_name:  declaration -> binding  (* None binding *)
  61 val list_binding_of_name: declaration -> binding  (* [] binding *)
  62
  63 val opt_declaration:  declaration -> declaration  (* t -> OptType t *)
  64 val list_declaration: declaration -> declaration  (* t -> ListType t *)
  65