<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>IBase__SourceFile (infer.IBase__SourceFile)</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> » IBase__SourceFile</nav><h1>Module <code>IBase__SourceFile</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><div><div class="spec include"><div class="doc"><dl><dt class="spec value" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span class="keyword">val</span> compare : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> int</code></dt></dl></div></div></div><dl><dt class="spec module" id="module-Map"><a href="#module-Map" class="anchor"></a><code><span class="keyword">module</span> Map : <a href="../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.Caml.Map.S <span class="keyword">with</span> <span class="keyword">type</span> <a href="index.html#module-Map">Map</a>.key = <a href="index.html#type-t">t</a></code></dt><dd><p>Maps from source_file</p></dd></dl><dl><dt class="spec module" id="module-Set"><a href="#module-Set" class="anchor"></a><code><span class="keyword">module</span> Set : <a href="../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.Caml.Set.S <span class="keyword">with</span> <span class="keyword">type</span> <a href="index.html#module-Set">Set</a>.elt = <a href="index.html#type-t">t</a></code></dt><dd><p>Set of source files</p></dd></dl><div class="spec module" id="module-Hash"><a href="#module-Hash" class="anchor"></a><code><span class="keyword">module</span> Hash : <a href="../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.Caml.Hashtbl.S <span class="keyword">with</span> <span class="keyword">type</span> <a href="index.html#module-Hash">Hash</a>.key = <a href="index.html#type-t">t</a></code></div><dl><dt class="spec value" id="val-is_invalid"><a href="#val-is_invalid" class="anchor"></a><code><span class="keyword">val</span> is_invalid : <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><p>Is the source file the invalid source file?</p></dd></dl><dl><dt class="spec value" id="val-changed_sources_from_changed_files"><a href="#val-changed_sources_from_changed_files" class="anchor"></a><code><span class="keyword">val</span> changed_sources_from_changed_files : <span>string list</span> <span>-></span> <a href="index.html#module-Set">Set</a>.t</code></dt><dd><p>Set of files read from --changed-files-index file, None if option not specified NOTE: it may include extra source_files if --changed-files-index contains paths to header files</p></dd></dl><dl><dt class="spec value" id="val-invalid"><a href="#val-invalid" class="anchor"></a><code><span class="keyword">val</span> invalid : string <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Invalid source file</p></dd></dl><dl><dt class="spec value" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span class="keyword">val</span> equal : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><p>equality of source files</p></dd></dl><dl><dt class="spec value" id="val-from_abs_path"><a href="#val-from_abs_path" class="anchor"></a><code><span class="keyword">val</span> from_abs_path : <span>?⁠warn_on_error:bool</span> <span>-></span> string <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>create source file from absolute path. WARNING: If warn_on_error is false, no warning will be shown whenever an error occurs for the given path (e.g. if it does not exist).</p></dd></dl><dl><dt class="spec value" id="val-create"><a href="#val-create" class="anchor"></a><code><span class="keyword">val</span> create : <span>?⁠warn_on_error:bool</span> <span>-></span> string <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Create a SourceFile from a given path. If relative, it assumes it is w.r.t. project root. WARNING: If warn_on_error is false, no warning will be shown whenever an error occurs for the given path (e.g. if it does not exist).</p></dd></dl><dl><dt class="spec value" id="val-is_under_project_root"><a href="#val-is_under_project_root" class="anchor"></a><code><span class="keyword">val</span> is_under_project_root : <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><p>Returns true if the file is in project root</p></dd></dl><dl><dt class="spec value" id="val-of_header"><a href="#val-of_header" class="anchor"></a><code><span class="keyword">val</span> of_header : <span>?⁠warn_on_error:bool</span> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <span><a href="index.html#type-t">t</a> option</span></code></dt><dd><p>Return approximate source file corresponding to the parameter if it's header file and file exists. returns None otherwise. WARNING: If warn_on_error is false, no warning will be shown whenever an error occurs for the given SourceFile (e.g. if it does not exist).</p></dd></dl><dl><dt class="spec value" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span class="keyword">val</span> pp : Stdlib.Format.formatter <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> unit</code></dt><dd><p>pretty print t</p></dd></dl><dl><dt class="spec value" id="val-to_abs_path"><a href="#val-to_abs_path" class="anchor"></a><code><span class="keyword">val</span> to_abs_path : <a href="index.html#type-t">t</a> <span>-></span> string</code></dt><dd><p>get the full path of a source file</p></dd></dl><dl><dt class="spec value" id="val-to_rel_path"><a href="#val-to_rel_path" class="anchor"></a><code><span class="keyword">val</span> to_rel_path : <a href="index.html#type-t">t</a> <span>-></span> string</code></dt><dd><p>get the relative path of a source file</p></dd></dl><dl><dt class="spec value" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span class="keyword">val</span> to_string : <span>?⁠force_relative:bool</span> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> string</code></dt><dd><p>convert a source file to a string WARNING: result may not be valid file path, do not use this function to perform operations on filenames</p></dd></dl><dl><dt class="spec value" id="val-has_extension"><a href="#val-has_extension" class="anchor"></a><code><span class="keyword">val</span> has_extension : <a href="index.html#type-t">t</a> <span>-></span> <span>ext:string</span> <span>-></span> bool</code></dt><dd><p>returns whether the source file has provided extension</p></dd></dl><div class="spec module" id="module-SQLite"><a href="#module-SQLite" class="anchor"></a><code><span class="keyword">module</span> <a href="SQLite/index.html">SQLite</a> : <a href="../IBase/SqliteUtils/index.html#module-type-Data">IBase.SqliteUtils.Data</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="../IBase/SqliteUtils/module-type-Data/index.html#type-t">t</a> = <a href="index.html#type-t">t</a></code></div></div></body></html>