###############################################################

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

diff --git a/helm/ocaml/registry/helm_registry.mli b/helm/ocaml/registry/helm_registry.mli
index f50d9b4a9711485e8aa86f5f1c2cf65f0cd79ceb..a6b51271bf48610552deb61f2c49f539c6ac5dd9 100644 (file)
--- a/helm/ocaml/registry/helm_registry.mli
+++ b/helm/ocaml/registry/helm_registry.mli
@@ -29,7 +29,7 @@
  *
  *  key ::= path
  *  path ::= component ( '.' component )*
- *  component ::= ( lowercase_alpha | num | '_' )+
+ *  component ::= ( alpha | num | '_' )+
  *  # with the only exception that sequences of '_' longer than 1 aren't valid
  *  # components
  *
@@ -51,9 +51,15 @@
  *  a configuration file (via "save_to" function below) .
  *
  *  Mapping between keys and environment variables is as follows:
- *  - the whole key is uppercased
  *  - each "." is converted to "__"
- *  E.g.: my.foo_ish.application -> MY__FOO_ISH__APPLICATION
+ *  E.g.: my.Foo_iSH.Application -> my__Foo_iSH__Application
+ *
+ * ++ Variable interpolation ++
+ *
+ * Interpolation is supported with the following syntax:
+ *  
+ *  foo.bar = "quux"
+ *  foo.baz = $(foo.bar)/baz
  *)
 
   (** raised when a looked up key can't be found
@@ -96,11 +102,20 @@ exception Invalid_value of (string * string) * string
   (** lookup key in registry with environment variable override *)
 val get: string -> string
 val set: key:string -> value:string -> unit
+val has: string -> bool
 
   (** remove a key from the current environment, next get over this key will
    * raise Key_not_found until the key will be redefined *)
 val unset: string -> unit
 
+val fold: ?prefix:string -> ('a -> string -> string -> 'a) -> 'a -> 'a
+val iter: ?prefix:string -> (string -> string -> unit) -> unit
+val to_list: ?prefix:string -> unit -> (string * string) list
+
+  (** @param prefix key representing the section whose contents should be listed
+  * @return section list * key list *)
+val ls: string -> string list * string list
+
 (** {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
@@ -126,6 +141,12 @@ val set_string_list:  key:string -> value:string list -> unit
  * set_* function above. Returned value is a get (set) function typed as the
  * given getter (setter) whith optional values. None is returned for missing
  * keys and None can be assigned to a key removing it from the registry.
+ *
+ * Sample  usage:
+ *
+ *  match Helm_registry.get_opt Helm_registry.get_int "foo.bar" with
+ *  | Some i -> ...
+ *  | None -> ...
  *)
 
 val get_opt:
@@ -134,6 +155,8 @@ val get_opt:
 val set_opt:
   (key:string -> value:'a -> unit) (* setter *) ->
     key:string -> value:'a option -> unit
+val get_opt_default:  (* as get_opt with an additional default value *)
+  (string -> 'a) -> 'a -> string -> 'a
 
 (** {2 Validators}
  * Each key may have zero or more associated validators, that are predicates
@@ -141,8 +164,9 @@ val set_opt:
  * associated to the corresponding key are executed, if at least one of them
  * fails, Invalid_value exception will be raised *)
 
-type validator_id
 
+(*
+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
@@ -153,14 +177,17 @@ type validator_id
 val add_validator:
   key:string -> validator:(string -> bool) -> descr:string ->
     validator_id
-(* val remove_validator: validator_id -> unit *)
+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 to which save current configuration
+   * If xmllint is available then it will be used for pretty printing fname,
+   * otherwise fname will be in the usual pxp ugly format *)
+val save_to: string -> unit
 
   (** @param fname file from which load new configuration. If it's an absolute
    * file name "path" argument is ignored.
@@ -171,8 +198,38 @@ val add_validator:
    *)
 val load_from: ?path:string list -> string -> unit
 
-(*
-(* DEBUGGING *)
-val dump: unit -> unit
-*)
+(** {2 OO interface} *)
+
+  (** @see load_from *)
+class registry: ?path: string list -> string ->
+  object
+    method get: string -> string
+    method set: key:string -> value:string -> unit
+    method has: string -> bool
+    method unset: string -> unit
+    method fold: ?prefix:string -> ('a -> string -> string -> 'a) -> 'a -> 'a
+    method iter: ?prefix:string -> (string -> string -> unit) -> unit
+    method to_list: ?prefix:string -> unit -> (string * string) list
+    method ls: string -> string list * string list
+    method get_string: string -> string
+    method get_int: string -> int
+    method get_float: string -> float
+    method get_bool: string -> bool
+    method get_string_list: string -> string list
+    method set_string: key:string -> value:string -> unit
+    method set_int: key:string -> value:int -> unit
+    method set_float: key:string -> value:float -> unit
+    method set_bool: key:string -> value:bool -> unit
+    method set_string_list: key:string -> value:string list -> unit
+    method get_opt:
+      (string -> 'a) (* getter *) ->
+        string -> 'a option
+    method set_opt:
+      (key:string -> value:'a -> unit) (* setter *) ->
+        key:string -> value:'a option -> unit
+    method get_opt_default:
+      (string -> 'a) (* getter *) ->
+        'a -> string -> 'a
+    method save_to: string -> unit
+  end