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 (** {2 Types} *)
  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   (** looked up value not found in environment *)
  43 exception Value_not_found of string
  44
  45   (** looked up value has the wrong type
  46    * parameters are value name and value type in environment *)
  47 exception Type_mismatch of string * value_type
  48
  49 type declaration = string * value_type
  50 type binding = string * (value_type * value)
  51 type t = binding list
  52
  53 val declaration_of_var: CicNotationPt.pattern_variable -> declaration
  54 val value_of_term: CicNotationPt.term -> value
  55 val term_of_value: value -> CicNotationPt.term
  56 val well_typed: value_type -> value -> bool
  57
  58 val declarations_of_env: t -> declaration list
  59 val declarations_of_term: CicNotationPt.term -> declaration list
  60 val combine: declaration list -> value list -> t  (** @raise Invalid_argument *)
  61
  62 (** {2 Environment lookup} *)
  63
  64 val lookup_value:   t -> string -> value  (** @raise Value_not_found *)
  65
  66 (** lookup_* functions below may raise Value_not_found and Type_mismatch *)
  67
  68 val lookup_term:    t -> string -> CicNotationPt.term
  69 val lookup_string:  t -> string -> string
  70 val lookup_num:     t -> string -> string
  71 val lookup_opt:     t -> string -> value option
  72 val lookup_list:    t -> string -> value list
  73
  74 val remove_name:    t -> string -> t
  75 val remove_names:   t -> string list -> t
  76
  77 (** {2 Bindings mangling} *)
  78
  79 val opt_binding_some: binding -> binding          (* v -> Some v *)
  80 val opt_binding_none: binding -> binding          (* v -> None *)
  81
  82 val opt_binding_of_name:  declaration -> binding  (* None binding *)
  83 val list_binding_of_name: declaration -> binding  (* [] binding *)
  84
  85 val opt_declaration:  declaration -> declaration  (* t -> OptType t *)
  86 val list_declaration: declaration -> declaration  (* t -> ListType t *)
  87
  88 (** given a list of environments bindings a set of names n_1, ..., n_k, returns
  89  * a single environment where n_i is bound to the list of values bound in the
  90  * starting environments *)
  91 val coalesce_env: declaration list -> t list -> t
  92