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>
<htmlxmlns="http://www.w3.org/1999/xhtml"><head><title>SourceFile (infer.IBase.SourceFile)</title><linkrel="stylesheet"href="../../../odoc.css"/><metacharset="utf-8"/><metaname="generator"content="odoc 1.5.1"/><metaname="viewport"content="width=device-width,initial-scale=1.0"/><scriptsrc="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><divclass="content"><header><nav><ahref="../index.html">Up</a>–<ahref="../../index.html">infer</a>»<ahref="../index.html">IBase</a>» SourceFile</nav><h1>Module <code>IBase.SourceFile</code></h1></header><dl><dtclass="spec type"id="type-t"><ahref="#type-t"class="anchor"></a><code><spanclass="keyword">type</span> t</code></dt></dl><div><divclass="spec include"><divclass="doc"><dl><dtclass="spec value"id="val-compare"><ahref="#val-compare"class="anchor"></a><code><spanclass="keyword">val</span> compare : <ahref="index.html#type-t">t</a><span>-></span><ahref="index.html#type-t">t</a><span>-></span> int</code></dt></dl></div></div></div><dl><dtclass="spec module"id="module-Map"><ahref="#module-Map"class="anchor"></a><code><spanclass="keyword">module</span> Map : <ahref="../../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.Caml.Map.S <spanclass="keyword">with</span><spanclass="keyword">type</span><ahref="index.html#module-Map">Map</a>.key = <ahref="index.html#type-t">t</a></code></dt><dd><p>Maps from source_file</p></dd></dl><dl><dtclass="spec module"id="module-Set"><ahref="#module-Set"class="anchor"></a><code><spanclass="keyword">module</span> Set : <ahref="../../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.Caml.Set.S <spanclass="keyword">with</span><spanclass="keyword">type</span><ahref="index.html#module-Set">Set</a>.elt = <ahref="index.html#type-t">t</a></code></dt><dd><p>Set of source files</p></dd></dl><divclass="spec module"id="module-Hash"><ahref="#module-Hash"class="anchor"></a><code><spanclass="keyword">module</span> Hash : <ahref="../../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.Caml.Hashtbl.S <spanclass="keyword">with</span><spanclass="keyword">type</span><ahref="index.html#module-Hash">Hash</a>.key = <ahref="index.html#type-t">t</a></code></div><dl><dtclass="spec value"id="val-is_invalid"><ahref="#val-is_invalid"class="anchor"></a><code><spanclass="keyword">val</span> is_invalid : <ahref="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><dtclass="spec value"id="val-changed_sources_from_changed_files"><ahref="#val-changed_sources_from_changed_files"class="anchor"></a><code><spanclass="keyword">val</span> changed_sources_from_changed_files : <span>string list</span><span>-></span><ahref="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><dtclass="spec value"id="val-invalid"><ahref="#val-invalid"class="anchor"></a><code><spanclass="keyword">val</span> invalid : string <span>-></span><ahref="index.html#type-t">t</a></code></dt><dd><p>Invalid source file</p></dd></dl><dl><dtclass="spec value"id="val-equal"><ahref="#val-equal"class="anchor"></a><code><spanclass="keyword">val</span> equal : <ahref="index.html#type-t">t</a><span>-></span><ahref="index.html#type-t">t</a><span>-></span> bool</code></dt><dd><p>equality of source files</p></dd></dl><dl><dtclass="spec value"id="val-from_abs_path"><ahref="#val-from_abs_path"class="anchor"></a><code><spanclass="keyword">val</span> from_abs_path : <span>?⁠warn_on_error:bool</span><span>-></span> string <span>-></span><ahref="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><dtclass="spec value"id="val-create"><ahref="#val-create"class="anchor"></a><code><spanclass="keyword">val</span> create : <span>?⁠warn_on_error:bool</span><span>-></span> string <span>-></span><ahref="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><dtclass="spec value"id="val-is_under_project_root"><ahref="#val-is_under_project_root"class="anchor"></a><code><spanclass="keyword">val</span> is_under_project_root : <ahref="index.html#type-t">t</a><span>-></span> bool</code></dt><dd><p>Returns true if the file is under the project root or the workspace directory if it exists</p></dd></dl><dl><dtclass="spec value"id="val-of_header"><ahref="#val-of_header"class="anchor"></a><code><spanclass="keyword">val</span> of_header : <span>?⁠warn_on_error:bool</span><span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><ahref="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><dtclass="spec value"id="val-pp"><ahref="#val-pp"class="anchor"></a><code><spanclass="keyword">val</span> pp : Stdlib.Format.formatter <span>-></span><ahref="index.html#type-t">t</a><span>-></span> unit</code></dt><dd><p>pretty print t</p></dd></dl><dl><dtclass="spec value"id="val-to_abs_path"><ahref="#val-to_abs_path"class="anchor"></a><code><spanclass="keyword">val</span> to_abs_path : <ahref="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><dtclass="spec value"id="val-to_rel_path"><ahref="#val-to_rel_path"class="anchor"></a><code><spanclass="keyword">val</span> to_rel_path : <ahref="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><dtclass="spec value"id="val-to_string"><ahref="#val-to_string"class="anchor"></a><code><spanclass="keyword">val</span> to_string : <span>?⁠force_relative:bool</span><span>-></span><ahref="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><dtclass="spec value"id="val-has_extension"><ahref="#val-has_extension"class="anchor"></a><code><spanclass="keyword">val</span> has_extension : <ahref="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><divclass="spec module"id="module-SQLite"><ahref="#module-SQLite"class="anchor"></a><code><spanclass="keyword">module</span><ahref="SQLite/index.html">SQLite</a> : <ahref="../SqliteUtils/index.html#module-type-Data">SqliteUtils.Data</a><spanclass="keyword">with</span><spanclass="keyword">type</span><ahref="../SqliteUtils/module-type-Data/index.html#type-t">t</a> = <ahref="index.html#type-t">t</a></code></div><divclass="spec module"id="module-Normalizer"><ahref="#module-Normalizer"class="anchor"></a><code><spanclass="keyword">module</span><ahref="Normalizer/index.html">Normalizer</a> : <ahref="../../IStdlib/HashNormalizer/index.html#module-type-S">IStdlib.HashNormalizer.S</a><spanclass="keyword">with</span><spanclass="keyword">type</span><ahref="../../IStdlib/HashNormalizer/module-type-S/index.html#type-t">t</a> = <ahref="index.html#type-t">t</a></code></div></div></body></html>
