<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<ocamldoc with-contents="true">
<title>Stog library reference documentation : Stog_misc</title><contents><div class="ocamldoc-page">
<div class="navbar"><a class="pre" href="Stog_msg.html" title="Stog_msg">Previous</a>
 <a class="up" href="index.html" title="Index">Up</a>
 <a class="post" href="Stog_config.html" title="Stog_config">Next</a>
</div>
<h1>Module <a href="type_Stog_misc.html">Stog_misc</a></h1>
<pre><span class="keyword">module</span> Stog_misc: <code class="code">sig</code> <a href="Stog_misc.html">..</a> <code class="code">end</code></pre><div class="info">
Utilities.<br/>
</div>
<hr width="100%"/>
<pre><span id="VALsafe_main"><span class="keyword">val</span> safe_main</span> : <code class="type">(unit -> unit) -> unit</code></pre><div class="info">
<code class="code">safe_main f</code> calls <code class="code">f ()</code> but handles <code class="code">Sys_error</code> and <code class="code">Failure</code>
exceptions by exiting with error code 1.<br/>
<b>Author(s):</b> Maxence Guesdon<br/>
<b>Version:</b> 1.0<br/>
</div>
<pre><span id="VALstring_of_file"><span class="keyword">val</span> string_of_file</span> : <code class="type">string -> string</code></pre><div class="info">
<code class="code">string_of_file filename</code> returns the content of <code class="code">filename</code>
in the form of one string.<br/>
<b>Author(s):</b> Maxence Guesdon<br/>
<b>Version:</b> 1.0<br/>
<b>Raises</b> <code>Sys_error</code> if the file could not be opened.<br/>
</div>
<pre><span id="VALfile_of_string"><span class="keyword">val</span> file_of_string</span> : <code class="type">file:string -> string -> unit</code></pre><div class="info">
<code class="code">file_of_string ~file str</code> creates a file named
<code class="code">filename</code> whose content is <code class="code">str</code>.<br/>
<b>Author(s):</b> Fabrice Lefessant<br/>
<b>Version:</b> 1.1<br/>
<b>Raises</b> <code>Sys_error</code> if the file could not be opened.<br/>
</div>
<pre><span id="VALcreate_log_fun"><span class="keyword">val</span> create_log_fun</span> : <code class="type">?prefix:string -><br/> ?print:(string -> unit) -><br/> string -> ?loc:string -> ?level:int -> (unit -> string) -> unit</code></pre><div class="info">
Creating a log function.
<code class="code">create_log_fun env_var</code> get the log level (an integer) from the given
environment variable, and returns a function to print messages.
This function takes a level (default is 1) and a function returning
the message do print. The function is called only if the log level is
higher than or equal to the given level.
The <code class="code">loc</code> parameter of the returned function can be used to indicate
an additional string to print before the log message.
If the environment variable is empty or does not contain an integer,
then the log level is set to 0.<br/>
</div>
<div class="param_info"><code class="code">prefix</code> : can be used to indicate a string prefixing every message</div>
<div class="param_info"><code class="code">print</code> : can be given to the function build the log function, to
indicate an alternative way to display the message; default is to call
<code class="code">prerr_endline</code>.</div>
<pre><span id="VALcreate_log_fun_with_set"><span class="keyword">val</span> create_log_fun_with_set</span> : <code class="type">?prefix:string -><br/> ?print:(string -> unit) -><br/> string -><br/> (?loc:string -> ?level:int -> (unit -> string) -> unit) * (int -> unit)</code></pre><div class="info">
Same as <code class="code">create_log_fun</code> but also return a function to change
the log level.<br/>
</div>
<pre><span id="VALsplit_string"><span class="keyword">val</span> split_string</span> : <code class="type">?keep_empty:bool -> string -> char list -> string list</code></pre><div class="info">
Separate the given string according to the given list of characters.<br/>
<b>Author(s):</b> Maxence Guesdon<br/>
<b>Version:</b> 1.1<br/>
</div>
<div class="param_info"><code class="code">keep_empty</code> : is <code class="code">false</code> by default. If set to <code class="code">true</code>,
the empty strings between separators are kept.</div>
<pre><span id="VALstrip_string"><span class="keyword">val</span> strip_string</span> : <code class="type">string -> string</code></pre><div class="info">
<code class="code">strip_string s</code> removes all leading and trailing spaces from the given string.<br/>
<b>Author(s):</b> Maxence Guesdon<br/>
<b>Version:</b> 1.0<br/>
</div>
<pre><span id="VALstrip_blank_lines"><span class="keyword">val</span> strip_blank_lines</span> : <code class="type">string -> string</code></pre><div class="info">
<code class="code">strip_blank_lines s</code> works as <a href="Stog_misc.html#VALstrip_string"><code class="code">Stog_misc.strip_string</code></a>, but only strips
full blank lines, without touching spaces or tabulations.<br/>
</div>
<pre><span id="VALlowercase"><span class="keyword">val</span> lowercase</span> : <code class="type">string -> string</code></pre><div class="info">
<code class="code">lowercase s</code> lowers the case of the given string, including accentuated characters.<br/>
<b>Author(s):</b> Maxence Guesdon<br/>
<b>Version:</b> 1.0<br/>
</div>
<pre><span id="VALlist_chop"><span class="keyword">val</span> list_chop</span> : <code class="type">int -> 'h list -> 'h list</code></pre><div class="info">
<code class="code">list_chop n l</code> returns the <code class="code">n</code> first elements of list <code class="code">l</code> or the whole
list if <code class="code">n >= List.length l</code>.<br/>
<b>Author(s):</b> Maxence Guesdon<br/>
<b>Version:</b> 1.0<br/>
</div>
<pre><span id="VALmkdir"><span class="keyword">val</span> mkdir</span> : <code class="type">string -> unit</code></pre><pre><span id="VALis_prefix"><span class="keyword">val</span> is_prefix</span> : <code class="type">string -> string -> bool</code></pre><div class="info">
<code class="code">is_prefix pattern s</code> returns true if string <code class="code">s</code> begins with <code class="code">pattern</code>.<br/>
<b>Author(s):</b> Maxence Guesdon<br/>
<b>Version:</b> 1.0<br/>
</div>
<pre><span id="VALlist_remove_doubles"><span class="keyword">val</span> list_remove_doubles</span> : <code class="type">?pred:('k -> 'k -> bool) -> 'k list -> 'k list</code></pre><div class="info">
<code class="code">list_remove_doubles ?pred l</code> remove doubles in the given list <code class="code">l</code>, according
to the optional equality function <code class="code">pred</code>. Default equality function is <code class="code">(=)</code>.<br/>
<b>Author(s):</b> Maxence Guesdon<br/>
<b>Version:</b> 1.0<br/>
</div>
<pre><span id="VALmd5"><span class="keyword">val</span> md5</span> : <code class="type">string -> string</code></pre><pre><span id="VALcount_char"><span class="keyword">val</span> count_char</span> : <code class="type">string -> char -> int</code></pre><pre><span id="VALencode_string"><span class="keyword">val</span> encode_string</span> : <code class="type">string -> string</code></pre><pre><span id="VALmap_opt"><span class="keyword">val</span> map_opt</span> : <code class="type">('a -> 'b) -> 'a option -> 'b option</code></pre><pre><span id="VALlist_concat"><span class="keyword">val</span> list_concat</span> : <code class="type">?sep:'a -> 'a list -> 'a list</code></pre><pre><span id="VALdot_to_svg"><span class="keyword">val</span> dot_to_svg</span> : <code class="type">string -> string</code></pre><pre><span id="VALlist_compare"><span class="keyword">val</span> list_compare</span> : <code class="type">('a -> 'a -> int) -> 'a list -> 'a list -> int</code></pre><pre><span id="VALfilename_extension"><span class="keyword">val</span> filename_extension</span> : <code class="type">string -> string</code></pre><div class="info">
<code class="code">filename_extension filename</code> returns extension of <code class="code">filename</code>
or <code class="code">""</code> if there is no extension.<br/>
</div>
<pre><span id="VALsafe_mkdir"><span class="keyword">val</span> safe_mkdir</span> : <code class="type">string -> unit</code></pre><pre><span id="VALopt_of_string"><span class="keyword">val</span> opt_of_string</span> : <code class="type">string -> string option</code></pre><div class="info">
<code class="code">opt_of_string s</code> returns <code class="code">None</code> if the string if empty
(length is 0) or <code class="code">Some s</code>.<br/>
<b>Version:</b> 1.0<br/>
</div>
<pre><span id="VALstring_of_opt"><span class="keyword">val</span> string_of_opt</span> : <code class="type">string option -> string</code></pre><div class="info">
<code class="code">string_of_opt s_opt</code> returns the empty string if
<code class="code">s_opt = None</code> or <code class="code">s</code> if <code class="code">s_opt = Some s</code>.<br/>
<b>Version:</b> 1.0<br/>
</div>
<pre><span id="VALfile_mtime"><span class="keyword">val</span> file_mtime</span> : <code class="type">string -> float option</code></pre><div class="info">
Return mdification time of the given file, or None if
the file does not exist.<br/>
</div>
<pre><span id="VALpath_under"><span class="keyword">val</span> path_under</span> : <code class="type">parent:string -> string -> string</code></pre><div class="info">
<code class="code">path_under ~parent file</code> returns the path to <code class="code">file</code> from <code class="code">parent</code>.<br/>
<b>Raises</b> <code>Failure</code> if <code class="code">parent</code> is not a prefix of <code class="code">file</code>.<br/>
</div>
<pre><span id="VALhighlight"><span class="keyword">val</span> highlight</span> : <code class="type">opts:string -> string -> string</code></pre><div class="info">
Call the highlight command on the given string and make it produce xhtml code.
Options are passed to the highlight command.<br/>
</div>
<pre><span id="VALstring_of_time"><span class="keyword">val</span> string_of_time</span> : <code class="type">float -> string</code></pre></div></contents></ocamldoc>
