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