<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="OUnitLogger.html">
<link rel="next" href="OUnitShared.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="OUnit" rel="Chapter" href="OUnit.html">
<link title="OUnit2" rel="Chapter" href="OUnit2.html">
<link title="OUnitThreads" rel="Chapter" href="OUnitThreads.html">
<link title="OUnitUtils" rel="Chapter" href="OUnitUtils.html">
<link title="OUnitPropList" rel="Chapter" href="OUnitPropList.html">
<link title="OUnitPlugin" rel="Chapter" href="OUnitPlugin.html">
<link title="OUnitChooser" rel="Chapter" href="OUnitChooser.html">
<link title="OUnitResultSummary" rel="Chapter" href="OUnitResultSummary.html">
<link title="OUnitLoggerStd" rel="Chapter" href="OUnitLoggerStd.html">
<link title="OUnitLoggerHTML" rel="Chapter" href="OUnitLoggerHTML.html">
<link title="OUnitLoggerHTMLData" rel="Chapter" href="OUnitLoggerHTMLData.html">
<link title="OUnitLoggerJUnit" rel="Chapter" href="OUnitLoggerJUnit.html">
<link title="OUnitAssert" rel="Chapter" href="OUnitAssert.html">
<link title="OUnitBracket" rel="Chapter" href="OUnitBracket.html">
<link title="OUnitTest" rel="Chapter" href="OUnitTest.html">
<link title="OUnitState" rel="Chapter" href="OUnitState.html">
<link title="OUnitRunner" rel="Chapter" href="OUnitRunner.html">
<link title="OUnitRunnerProcesses" rel="Chapter" href="OUnitRunnerProcesses.html">
<link title="OUnitCore" rel="Chapter" href="OUnitCore.html">
<link title="OUnitLogger" rel="Chapter" href="OUnitLogger.html">
<link title="OUnitConf" rel="Chapter" href="OUnitConf.html">
<link title="OUnitShared" rel="Chapter" href="OUnitShared.html">
<link title="OUnitCache" rel="Chapter" href="OUnitCache.html">
<link title="OUnitTestData" rel="Chapter" href="OUnitTestData.html">
<link title="OUnitCheckEnv" rel="Chapter" href="OUnitCheckEnv.html">
<link title="OUnitDiff" rel="Chapter" href="OUnitDiff.html"><title>OUnit user guide : OUnitConf</title>
</head>
<body>
<div class="navbar"><a href="OUnitLogger.html">Previous</a>
<a href="index.html">Up</a>
<a href="OUnitShared.html">Next</a>
</div>
<center><h1>Module <a href="type_OUnitConf.html">OUnitConf</a></h1></center>
<br>
<pre><span class="keyword">module</span> OUnitConf: <code class="code"><span class="keyword">sig</span></code> <a href="OUnitConf.html">..</a> <code class="code"><span class="keyword">end</span></code></pre>Load test options from file, environment and command line (in this order).
Not that <code class="code">extra_specs</code> is here for historical reason, better use <code class="code">make</code> to
create command line options.<br>
<hr width="100%">
<pre><span id="EXCEPTIONParse_error"><span class="keyword">exception</span> Parse_error</span> <span class="keyword">of</span> <code class="type">string</code></pre>
<pre><span id="TYPEconf"><span class="keyword">type</span> <code class="type"></code>conf</span> = <code class="type"><a href="OUnitPropList.html#TYPEt">OUnitPropList.t</a></code> </pre>
<br><code><span id="TYPEmetadata"><span class="keyword">type</span> <code class="type"></code>metadata</span> = {</code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>help : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>get_print : <code class="type"><a href="OUnitConf.html#TYPEconf">conf</a> -> string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>parse_set : <code class="type">string -> <a href="OUnitConf.html#TYPEconf">conf</a> -> unit</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>cli : <code class="type"><a href="OUnitConf.html#TYPEconf">conf</a> -> (string * Arg.spec * string) list</code>;</code></td>
</tr></table>
}
<pre><span id="VALmetaconf"><span class="keyword">val</span> <a href="code_VALOUnitConf.metaconf.html">metaconf</a></span> : <code class="type">(string, <a href="OUnitConf.html#TYPEmetadata">metadata</a>) Hashtbl.t</code></pre><pre><span id="VALcheck_variable_name"><span class="keyword">val</span> <a href="code_VALOUnitConf.check_variable_name.html">check_variable_name</a></span> : <code class="type">string -> unit</code></pre><pre><span id="VALcli_name"><span class="keyword">val</span> <a href="code_VALOUnitConf.cli_name.html">cli_name</a></span> : <code class="type">string -> string</code></pre><pre><span id="VALsubst"><span class="keyword">val</span> <a href="code_VALOUnitConf.subst.html">subst</a></span> : <code class="type"><a href="OUnitConf.html#TYPEconf">conf</a> -> (string * string) list -> string -> string</code></pre><pre><span id="VALmake"><span class="keyword">val</span> <a href="code_VALOUnitConf.make.html">make</a></span> : <code class="type">name:string -><br> parse:(string -> 'a) -><br> print:('a -> string) -><br> default:'a -><br> help:string -><br> fcli:('a -> ('a -> unit) -> (string * Arg.spec * string) list) -><br> unit -> <a href="OUnitConf.html#TYPEconf">conf</a> -> 'a</code></pre><pre><span id="VALmake_string"><span class="keyword">val</span> <a href="code_VALOUnitConf.make_string.html">make_string</a></span> : <code class="type">string -> string -> string -> <a href="OUnitConf.html#TYPEconf">conf</a> -> string</code></pre><pre><span id="VALmake_string_subst"><span class="keyword">val</span> <a href="code_VALOUnitConf.make_string_subst.html">make_string_subst</a></span> : <code class="type">string -><br> string -><br> string -> ?extra_subst:(string * string) list -> <a href="OUnitConf.html#TYPEconf">conf</a> -> string</code></pre><pre><span id="VALmake_string_opt"><span class="keyword">val</span> <a href="code_VALOUnitConf.make_string_opt.html">make_string_opt</a></span> : <code class="type">string -> string option -> string -> <a href="OUnitConf.html#TYPEconf">conf</a> -> string option</code></pre><pre><span id="VALmake_string_subst_opt"><span class="keyword">val</span> <a href="code_VALOUnitConf.make_string_subst_opt.html">make_string_subst_opt</a></span> : <code class="type">string -><br> string option -><br> string -><br> ?extra_subst:(string * string) list -> <a href="OUnitConf.html#TYPEconf">conf</a> -> string option</code></pre><pre><span id="VALmake_int"><span class="keyword">val</span> <a href="code_VALOUnitConf.make_int.html">make_int</a></span> : <code class="type">string -> int -> string -> <a href="OUnitConf.html#TYPEconf">conf</a> -> int</code></pre><pre><span id="VALmake_float"><span class="keyword">val</span> <a href="code_VALOUnitConf.make_float.html">make_float</a></span> : <code class="type">string -> float -> string -> <a href="OUnitConf.html#TYPEconf">conf</a> -> float</code></pre><pre><span id="VALmake_bool"><span class="keyword">val</span> <a href="code_VALOUnitConf.make_bool.html">make_bool</a></span> : <code class="type">string -> bool -> string -> <a href="OUnitConf.html#TYPEconf">conf</a> -> bool</code></pre><pre><span id="VALmake_enum"><span class="keyword">val</span> <a href="code_VALOUnitConf.make_enum.html">make_enum</a></span> : <code class="type">string -><br> (unit -> (string * 'a) list) -><br> string -> string -> <a href="OUnitConf.html#TYPEconf">conf</a> -> string * 'a</code></pre><pre><span id="VALmake_exec"><span class="keyword">val</span> <a href="code_VALOUnitConf.make_exec.html">make_exec</a></span> : <code class="type">string -> <a href="OUnitConf.html#TYPEconf">conf</a> -> string</code></pre><pre><span id="VALset"><span class="keyword">val</span> <a href="code_VALOUnitConf.set.html">set</a></span> : <code class="type">origin:string -> <a href="OUnitConf.html#TYPEconf">conf</a> -> string -> string -> unit</code></pre><pre><span id="VALfile_parse"><span class="keyword">val</span> <a href="code_VALOUnitConf.file_parse.html">file_parse</a></span> : <code class="type"><a href="OUnitConf.html#TYPEconf">conf</a> -> string -> unit</code></pre><pre><span id="VALenv_parse"><span class="keyword">val</span> <a href="code_VALOUnitConf.env_parse.html">env_parse</a></span> : <code class="type"><a href="OUnitConf.html#TYPEconf">conf</a> -> unit</code></pre><pre><span id="VALcli_parse"><span class="keyword">val</span> <a href="code_VALOUnitConf.cli_parse.html">cli_parse</a></span> : <code class="type">?argv:string array -><br> (Arg.key * Arg.spec * Arg.doc) list -> <a href="OUnitConf.html#TYPEconf">conf</a> -> unit</code></pre><pre><span id="VALdefault"><span class="keyword">val</span> <a href="code_VALOUnitConf.default.html">default</a></span> : <code class="type">?preset:(string * string) list -> unit -> (int, unit -> unit) Hashtbl.t</code></pre><pre><span id="VALload"><span class="keyword">val</span> <a href="code_VALOUnitConf.load.html">load</a></span> : <code class="type">?preset:(string * string) list -><br> ?argv:string array -><br> (Arg.key * Arg.spec * Arg.doc) list -> (int, unit -> unit) Hashtbl.t</code></pre><div class="info">
Load test options from file, environment and command line (in this order).
Not that <code class="code">extra_specs</code> is here for historical reason, better use <code class="code">make</code> to
create command line options.<br>
</div>
<pre><span id="VALdump"><span class="keyword">val</span> <a href="code_VALOUnitConf.dump.html">dump</a></span> : <code class="type"><a href="OUnitConf.html#TYPEconf">conf</a> -> (string * string) list</code></pre></body></html>
