You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2 lines
6.1 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IBase__DB (infer.IBase__DB)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../index.html">infer</a> &#x00BB; IBase__DB</nav><h1>Module <code>IBase__DB</code></h1><nav class="toc"><ul><li><a href="#filename">Filename</a></li><li><a href="#results-directory">Results Directory</a></li><li><a href="#source-dirs">Source Dirs</a></li></ul></nav></header><aside><p>Database of analysis results</p></aside><section><header><h3 id="filename"><a href="#filename" class="anchor"></a>Filename</h3></header><dl><dt class="spec type" id="type-filename"><a href="#type-filename" class="anchor"></a><code><span class="keyword">type</span> filename</code></dt><dd><p>generic file name</p></dd></dl><div><div class="spec include"><div class="doc"><dl><dt class="spec value" id="val-compare_filename"><a href="#val-compare_filename" class="anchor"></a><code><span class="keyword">val</span> compare_filename : <a href="index.html#type-filename">filename</a> <span>&#45;&gt;</span> <a href="index.html#type-filename">filename</a> <span>&#45;&gt;</span> int</code></dt></dl></div></div></div><dl><dt class="spec value" id="val-filename_from_string"><a href="#val-filename_from_string" class="anchor"></a><code><span class="keyword">val</span> filename_from_string : string <span>&#45;&gt;</span> <a href="index.html#type-filename">filename</a></code></dt><dt class="spec value" id="val-filename_to_string"><a href="#val-filename_to_string" class="anchor"></a><code><span class="keyword">val</span> filename_to_string : <a href="index.html#type-filename">filename</a> <span>&#45;&gt;</span> string</code></dt><dt class="spec value" id="val-filename_add_suffix"><a href="#val-filename_add_suffix" class="anchor"></a><code><span class="keyword">val</span> filename_add_suffix : <a href="index.html#type-filename">filename</a> <span>&#45;&gt;</span> string <span>&#45;&gt;</span> <a href="index.html#type-filename">filename</a></code></dt><dt class="spec value" id="val-file_exists"><a href="#val-file_exists" class="anchor"></a><code><span class="keyword">val</span> file_exists : <a href="index.html#type-filename">filename</a> <span>&#45;&gt;</span> bool</code></dt><dt class="spec value" id="val-file_modified_time"><a href="#val-file_modified_time" class="anchor"></a><code><span class="keyword">val</span> file_modified_time : <span>?&#8288;symlink:bool</span> <span>&#45;&gt;</span> <a href="index.html#type-filename">filename</a> <span>&#45;&gt;</span> float</code></dt><dd><p>Return the time when a file was last modified. The file must exist.</p></dd></dl></section><section><header><h3 id="results-directory"><a href="#results-directory" class="anchor"></a>Results Directory</h3></header><div class="spec module" id="module-Results_dir"><a href="#module-Results_dir" class="anchor"></a><code><span class="keyword">module</span> <a href="Results_dir/index.html">Results_dir</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><dl><dt class="spec value" id="val-append_crc_cutoff"><a href="#val-append_crc_cutoff" class="anchor"></a><code><span class="keyword">val</span> append_crc_cutoff : <span>?&#8288;key:string</span> <span>&#45;&gt;</span> string <span>&#45;&gt;</span> string * string</code></dt><dd><p>Append a crc to the string, using string_crc_hex32. Cut the string if it exceeds the cutoff limit. Use an optional key to compute the crc. Return a pair of the appended result and crc string.</p></dd></dl><dl><dt class="spec value" id="val-source_file_encoding"><a href="#val-source_file_encoding" class="anchor"></a><code><span class="keyword">val</span> source_file_encoding : <a href="../IBase/SourceFile/index.html#type-t">IBase.SourceFile.t</a> <span>&#45;&gt;</span> string</code></dt><dd><p>string encoding of a source file (including path) as a single filename</p></dd></dl></section><section><header><h3 id="source-dirs"><a href="#source-dirs" class="anchor"></a>Source Dirs</h3></header><dl><dt class="spec type" id="type-source_dir"><a href="#type-source_dir" class="anchor"></a><code><span class="keyword">type</span> source_dir</code></dt><dd><p>source directory: the directory inside the results dir corresponding to a source file</p></dd></dl><div><div class="spec include"><div class="doc"><dl><dt class="spec value" id="val-compare_source_dir"><a href="#val-compare_source_dir" class="anchor"></a><code><span class="keyword">val</span> compare_source_dir : <a href="index.html#type-source_dir">source_dir</a> <span>&#45;&gt;</span> <a href="index.html#type-source_dir">source_dir</a> <span>&#45;&gt;</span> int</code></dt></dl></div></div></div><dl><dt class="spec value" id="val-source_dir_get_internal_file"><a href="#val-source_dir_get_internal_file" class="anchor"></a><code><span class="keyword">val</span> source_dir_get_internal_file : <a href="index.html#type-source_dir">source_dir</a> <span>&#45;&gt;</span> string <span>&#45;&gt;</span> <a href="index.html#type-filename">filename</a></code></dt><dd><p>get the path to an internal file with the given extention (.tenv, ...)</p></dd></dl><dl><dt class="spec value" id="val-source_dir_from_source_file"><a href="#val-source_dir_from_source_file" class="anchor"></a><code><span class="keyword">val</span> source_dir_from_source_file : <a href="../IBase/SourceFile/index.html#type-t">IBase.SourceFile.t</a> <span>&#45;&gt;</span> <a href="index.html#type-source_dir">source_dir</a></code></dt><dd><p>get the source directory corresponding to a source file</p></dd></dl><dl><dt class="spec value" id="val-is_source_file"><a href="#val-is_source_file" class="anchor"></a><code><span class="keyword">val</span> is_source_file : string <span>&#45;&gt;</span> bool</code></dt><dd><p>Check if a path is a Java, C, C++ or Objectve C source file according to the file extention</p></dd></dl></section></div></body></html>