aboutsummaryrefslogtreecommitdiffstats
path: root/lib/Readconfig.mli
diff options
context:
space:
mode:
authorBernhard Schommer <bernhardschommer@gmail.com>2015-03-10 10:30:16 +0100
committerBernhard Schommer <bernhardschommer@gmail.com>2015-03-10 10:30:16 +0100
commite37e366c826a0dc422e449b9ad0afa70be204e12 (patch)
tree3bcc0c14099862614d19c95fee0edc7b388720b3 /lib/Readconfig.mli
parent8aae10b50b321cfcbde86582cdd7ce1df8960628 (diff)
parent3e01154d693e1c457e1e974f5e9ebaa4601050aa (diff)
downloadcompcert-e37e366c826a0dc422e449b9ad0afa70be204e12.tar.gz
compcert-e37e366c826a0dc422e449b9ad0afa70be204e12.zip
Merge branch 'master' into dwarf
Diffstat (limited to 'lib/Readconfig.mli')
-rw-r--r--lib/Readconfig.mli39
1 files changed, 39 insertions, 0 deletions
diff --git a/lib/Readconfig.mli b/lib/Readconfig.mli
new file mode 100644
index 00000000..c81e7786
--- /dev/null
+++ b/lib/Readconfig.mli
@@ -0,0 +1,39 @@
+(* *********************************************************************)
+(* *)
+(* The Compcert verified compiler *)
+(* *)
+(* Xavier Leroy, INRIA Paris-Rocquencourt *)
+(* *)
+(* Copyright Institut National de Recherche en Informatique et en *)
+(* Automatique. All rights reserved. This file is distributed *)
+(* 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. This file is also distributed *)
+(* under the terms of the INRIA Non-Commercial License Agreement. *)
+(* *)
+(* *********************************************************************)
+
+(* Reading configuration files *)
+
+(* The format of a configuration file is a list of lines
+ variable=value
+ The "value" on the right hand side is a list of whitespace-separated
+ words. Quoting is honored with the same rules as POSIX shell:
+ \<newline> for multi-line values
+ single quotes no escapes within
+ double quotes \$ \` \<doublequote> \\ \<newline> as escapes
+ Finally, lines starting with '#' are comments.
+*)
+
+val read_config_file: string -> unit
+ (** Read (key, value) pairs from the given file name. Raise [Error]
+ if file is ill-formed. *)
+
+val key_val: string -> string list option
+ (** [key_val k] returns the value associated with key [k], if any.
+ Otherwise, [None] is returned. *)
+
+exception Error of string * int * string
+ (** Raised in case of error.
+ First argument is file name, second argument is line number,
+ third argument is an explanation of the error. *)