]> matita.cs.unibo.it Git - helm.git/blob - helm/ocaml/registry/helm_registry.mli
- added "has" method
[helm.git] / 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  * ++ Variable interpolation ++
59  *
60  * Interpolation is supported with the following syntax:
61  *  
62  *  foo.bar = "quux"
63  *  foo.baz = $(foo.bar)/baz
64  *)
65
66   (** raised when a looked up key can't be found
67    * @param key looked up key *)
68 exception Key_not_found of string
69
70   (** raised when a cyclic definitions is found, e.g. after
71    * Helm_registry.set "a" "$b"
72    * Helm_registry.set "b" "$a"
73    * @param msg brief description of the definition cycle *)
74 exception Cyclic_definition of string
75
76   (** raised when a looked up key doesn't have the required type
77    * @param expected_type
78    * @param value
79    * @param msg *)
80 exception Type_error of string * string * string
81
82   (** raised when a malformed key is encountered
83    * @param key malformed key *)
84 exception Malformed_key of string
85
86   (** raised when an error is encountered while parsing a configuration file
87    * @param fname file name 
88    * @param line line number
89    * @param col column number
90    * @param msg error description
91    *)
92 exception Parse_error of string * int * int * string
93
94   (** raised when a given <key,value> pair fails validity test(s)
95    * @param pair <key,value> pair
96    * @param descr description of the failed test *)
97 exception Invalid_value of (string * string) * string
98
99 (** {2 Generic untyped interface}
100  * Using the functions below this module could be used as a repository of
101  * key/value pairs *)
102
103   (** lookup key in registry with environment variable override *)
104 val get: string -> string
105 val set: key:string -> value:string -> unit
106 val has: string -> bool
107
108   (** remove a key from the current environment, next get over this key will
109    * raise Key_not_found until the key will be redefined *)
110 val unset: string -> unit
111
112 val fold: ?prefix:string -> ('a -> string -> string -> 'a) -> 'a -> 'a
113 val iter: ?prefix:string -> (string -> string -> unit) -> unit
114 val to_list: ?prefix:string -> unit -> (string * string) list
115
116   (** @param prefix key representing the section whose contents should be listed
117   * @return section list * key list *)
118 val ls: string -> string list * string list
119
120 (** {2 Typed interface}
121  * Three basic types are supported: strings, int and strings list. Strings
122  * correspond literally to what is written inside double quotes; int to the
123  * parsing of an integer number from ; strings list to the splitting at blanks
124  * of it (heading and trailing blanks are removed before splitting) *)
125
126 val get_string:       string -> string  (* alias for bare "get" above *)
127 val get_int:          string -> int
128 val get_float:        string -> float
129 val get_bool:         string -> bool
130 val get_string_list:  string -> string list
131
132   (* alias for bare "set" above *)
133 val set_string:       key:string -> value:string      -> unit
134 val set_int:          key:string -> value:int         -> unit
135 val set_float:        key:string -> value:float       -> unit
136 val set_bool:         key:string -> value:bool        -> unit
137 val set_string_list:  key:string -> value:string list -> unit
138
139 (** {3 Optional values interface}
140  * Functions below took as first argument respectively a "getter" and a "setter"
141  * function. A getter is one of the get_* function above, a setter is one of the
142  * set_* function above. Returned value is a get (set) function typed as the
143  * given getter (setter) whith optional values. None is returned for missing
144  * keys and None can be assigned to a key removing it from the registry.
145  *
146  * Sample  usage:
147  *
148  *  match Helm_registry.get_opt Helm_registry.get_int "foo.bar" with
149  *  | Some i -> ...
150  *  | None -> ...
151  *)
152
153 val get_opt:
154   (string -> 'a) (* getter *) ->
155     string -> 'a option
156 val set_opt:
157   (key:string -> value:'a -> unit) (* setter *) ->
158     key:string -> value:'a option -> unit
159 val get_opt_default:  (* as get_opt with an additional default value *)
160   (string -> 'a) -> 'a -> string -> 'a
161
162 (** {2 Validators}
163  * Each key may have zero or more associated validators, that are predicates
164  * "this value is valid for this key". Each time a value is set, all validators
165  * associated to the corresponding key are executed, if at least one of them
166  * fails, Invalid_value exception will be raised *)
167
168 type validator_id
169
170   (** register a new validator for a given key
171    * @param key key to which validator applies
172    * @param validator a function applying to a value returning true if that
173    *  value is valid, false otherwise
174    * @param descr validator description, for the final user when a validation
175    *  attempt fails
176    * @return validator_id should be used to remove the validator later on *)
177 val add_validator:
178   key:string -> validator:(string -> bool) -> descr:string ->
179     validator_id
180 (* val remove_validator: validator_id -> unit *)
181
182 (** {2 Persistent configuration}
183  * Validators aren't saved. load_from/save_to sequences don't preserve comments
184  *)
185
186   (** @param fname file to which save current configuration
187    * If xmllint is available then it will be used for pretty printing fname,
188    * otherwise fname will be in the usual pxp ugly format *)
189 val save_to: string -> unit
190
191   (** @param fname file from which load new configuration. If it's an absolute
192    * file name "path" argument is ignored.
193    * Otherwise given file name is looked up in each directory member of the
194    * given path. Each matching file is loaded overriding previous settings. If
195    * no path is given a default path composed of just the current working
196    * directory is used.
197    *)
198 val load_from: ?path:string list -> string -> unit
199
200 (* DEBUGGING *)
201 (* val dump: unit -> unit *)
202