helm/ocaml/registry/helm_registry.mli

   1 (* Copyright (C) 2004, 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 (** Configuration repository for HELM applications.
  27  *
  28  * ++ Keys format ++
  29  *
  30  *  key ::= path
  31  *  path ::= component ( '.' component )*
  32  *  component ::= ( lowercase_alpha | num | '_' )+
  33  *  # with the only exception that sequences of '_' longer than 1 aren't valid
  34  *  # components
  35  *
  36  *  Suggested usage <application>.<setting>:
  37  *   e.g. gTopLevel.prooffile, http_getter.port, ...
  38  *
  39  * ++ Configuration file example ++
  40  *
  41  *  gTopLevel.prooffile = "/home/zack/prooffile"
  42  *  http_getter.port = "58080"
  43  *
  44  * ++ Environment variable override ++
  45  *
  46  *  each key has an associated environment variable name. At runtime (i.e. when
  47  *  "get" requests are performed) a variable with this name will be looked for,
  48  *  if it's defined it will override the value present (or absent) in the
  49  *  registry.
  50  *  Environment variables are _not_ considered when saving the configuration to
  51  *  a configuration file (via "save_to" function below) .
  52  *
  53  *  Mapping between keys and environment variables is as follows:
  54  *  - the whole key is uppercased
  55  *  - each "." is converted to "__"
  56  *  E.g.: my.foo_ish.application -> MY__FOO_ISH__APPLICATION
  57  *)
  58
  59   (** raised when a looked up key can't be found
  60    * @param key looked up key *)
  61 exception Key_not_found of string
  62
  63   (** raised when a cyclic definitions is found, e.g. after
  64    * Helm_registry.set "a" "$b"
  65    * Helm_registry.set "b" "$a"
  66    * @param msg brief description of the definition cycle *)
  67 exception Cyclic_definition of string
  68
  69   (** raised when a looked up key doesn't have the required type
  70    * @param expected_type
  71    * @param value
  72    * @param msg *)
  73 exception Type_error of string * string * string
  74
  75   (** raised when a malformed key is encountered
  76    * @param key malformed key *)
  77 exception Malformed_key of string
  78
  79   (** raised when an error is encountered while parsing a configuration file
  80    * @param fname file name
  81    * @param line line number
  82    * @param col column number
  83    * @param msg error description
  84    *)
  85 exception Parse_error of string * int * int * string
  86
  87   (** raised when a given <key,value> pair fails validity test(s)
  88    * @param pair <key,value> pair
  89    * @param descr description of the failed test *)
  90 exception Invalid_value of (string * string) * string
  91
  92 (** {2 Generic untyped interface}
  93  * Using the functions below this module could be used as a repository of
  94  * key/value pairs *)
  95
  96   (** lookup key in registry with environment variable override *)
  97 val get: string -> string
  98 val set: key:string -> value:string -> unit
  99
 100   (** remove a key from the current environment, next get over this key will
 101    * raise Key_not_found until the key will be redefined *)
 102 val unset: string -> unit
 103
 104 (** {2 Typed interface}
 105  * Three basic types are supported: strings, int and strings list. Strings
 106  * correspond literally to what is written inside double quotes; int to the
 107  * parsing of an integer number from ; strings list to the splitting at blanks
 108  * of it (heading and trailing blanks are removed before splitting) *)
 109
 110 val get_string:       string -> string  (* alias for bare "get" above *)
 111 val get_int:          string -> int
 112 val get_float:        string -> float
 113 val get_bool:         string -> bool
 114 val get_string_list:  string -> string list
 115
 116   (* alias for bare "set" above *)
 117 val set_string:       key:string -> value:string      -> unit
 118 val set_int:          key:string -> value:int         -> unit
 119 val set_float:        key:string -> value:float       -> unit
 120 val set_bool:         key:string -> value:bool        -> unit
 121 val set_string_list:  key:string -> value:string list -> unit
 122
 123 (** {3 Optional values interface}
 124  * Functions below took as first argument respectively a "getter" and a "setter"
 125  * function. A getter is one of the get_* function above, a setter is one of the
 126  * set_* function above. Returned value is a get (set) function typed as the
 127  * given getter (setter) whith optional values. None is returned for missing
 128  * keys and None can be assigned to a key removing it from the registry.
 129  *)
 130
 131 val get_opt:
 132   (string -> 'a) (* getter *) ->
 133     string -> 'a option
 134 val set_opt:
 135   (key:string -> value:'a -> unit) (* setter *) ->
 136     key:string -> value:'a option -> unit
 137
 138 (** {2 Validators}
 139  * Each key may have zero or more associated validators, that are predicates
 140  * "this value is valid for this key". Each time a value is set, all validators
 141  * associated to the corresponding key are executed, if at least one of them
 142  * fails, Invalid_value exception will be raised *)
 143
 144 type validator_id
 145
 146   (** register a new validator for a given key
 147    * @param key key to which validator applies
 148    * @param validator a function applying to a value returning true if that
 149    *  value is valid, false otherwise
 150    * @param descr validator description, for the final user when a validation
 151    *  attempt fails
 152    * @return validator_id should be used to remove the validator later on *)
 153 val add_validator:
 154   key:string -> validator:(string -> bool) -> descr:string ->
 155     validator_id
 156 (* val remove_validator: validator_id -> unit *)
 157
 158 (** {2 Persistent configuration}
 159  * Validators aren't saved. load_from/save_to sequences don't preserve comments
 160  *)
 161
 162   (** @param fname file to which save current configuration *)
 163 (* val save_to: string -> unit *)
 164
 165   (** @param fname file from which load new configuration. If it's an absolute
 166    * file name "path" argument is ignored.
 167    * Otherwise given file name is looked up in each directory member of the
 168    * given path. Each matching file is loaded overriding previous settings. If
 169    * no path is given a default path composed of just the current working
 170    * directory is used.
 171    *)
 172 val load_from: ?path:string list -> string -> unit
 173
 174 (*
 175 (* DEBUGGING *)
 176 val dump: unit -> unit
 177 *)
 178