helm registry --- first release

[helm.git] / helm / ocaml / registry / helm_registry.mli

diff --git a/helm/ocaml/registry/helm_registry.mli b/helm/ocaml/registry/helm_registry.mli
new file mode 100644 (file)
index 0000000..02c0df7
--- /dev/null
+++ b/helm/ocaml/registry/helm_registry.mli
@@ -0,0 +1,120 @@
+(* Copyright (C) 2004, HELM Team.
+ * 
+ * This file is part of HELM, an Hypertextual, Electronic
+ * Library of Mathematics, developed at the Computer Science
+ * Department, University of Bologna, Italy.
+ * 
+ * HELM is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ * 
+ * HELM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with HELM; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+ * MA  02111-1307, USA.
+ * 
+ * For details, see the HELM World-Wide-Web page,
+ * http://helm.cs.unibo.it/
+ *)
+
+(** Configuration repository for HELM applications.
+ *
+ * key ::= path
+ * path ::= component ( '.' component )*
+ * component ::= ( alpha | num | '_' )+
+ *
+ * Suggested usage <application>.<setting>:
+ * e.g. gTopLevel.prooffile, http_getter.port, ...
+ *
+ * Configuration file example:
+ *
+ *  gTopLevel.prooffile = "/home/zack/prooffile"
+ *  http_getter.port = "58080"
+ *)
+
+  (** raised when a looked up key can't be found
+   * @param key looked up key *)
+exception Key_not_found of string
+
+  (** raised when a looked up key doesn't have the required type
+   * @param expected_type
+   * @param value
+   * @param msg *)
+exception Type_error of string * string * string
+
+  (** raised when a malformed key is encountered
+   * @param key malformed key *)
+exception Malformed_key of string
+
+  (** raised when an error is encountered while parsing a configuration file
+   * @param fname file name 
+   * @param lno line number *)
+exception Parse_error of string * int
+
+  (** raised when a given <key,value> pair fails validity test(s)
+   * @param pair <key,value> pair
+   * @param descr description of the failed test *)
+exception Invalid_value of (string * string) * string
+
+(** {2 Generic untyped interface}
+ * Using the functions below this module could be used as a repository of
+ * key/value pairs *)
+
+val get: string -> string
+val set: key:string -> value:string -> unit
+
+(** {2 Typed interface}
+ * Three basic types are supported: strings, int and strings list. Strings
+ * correspond literally to what is written inside double quotes; int to the
+ * parsing of an integer number from ; strings list to the splitting at blanks
+ * of it (heading and trailing blanks are removed before splitting) *)
+
+val get_int: string -> int
+val get_float: string -> float
+val get_string_list: string -> string list
+
+val set_int: key:string -> value:int -> unit
+val set_float: key:string -> value:float -> unit
+val set_string_list: key:string -> value:string list -> unit
+
+(** {2 Validators}
+ * Each key may have zero or more associated validators, that are predicates
+ * "this value is valid for this key". Each time a value is set, all validators
+ * associated to the corresponding key are executed, if at least one of them
+ * fails, Invalid_value exception will be raised *)
+
+type validator_id
+
+  (** register a new validator for a given key
+   * @param key key to which validator applies
+   * @param validator a function applying to a value returning true if that
+   *  value is valid, false otherwise
+   * @param descr validator description, for the final user when a validation
+   *  attempt fails
+   * @return validator_id should be used to remove the validator later on *)
+val add_validator:
+  key:string -> validator:(string -> bool) -> descr:string ->
+    validator_id
+(* val remove_validator: validator_id -> unit *)
+
+(** {2 Persistent configuration}
+ * Validators aren't saved. load_from/save_to sequences don't preserve comments
+ *)
+
+  (** @param fname file to which save current configuration *)
+val save_to: string -> unit
+
+  (** @param fname file from which load new configuration *)
+val load_from: string -> unit
+
+(*
+(* DEBUGGING *)
+val dump: unit -> unit
+*)
+