infer_clone/website/static/odoc/next/infer/TOPLlib__Topl/index.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>TOPLlib__Topl (infer.TOPLlib__Topl)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.2"/><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; TOPLlib__Topl</nav><h1>Module <code>TOPLlib__Topl</code></h1></header><dl><dt class="spec value" id="val-automaton"><a href="#val-automaton" class="anchor"></a><code><span class="keyword">val</span> automaton : unit <span>&#45;&gt;</span> <a href="../TOPLlib/ToplAutomaton/index.html#type-t">TOPLlib.ToplAutomaton.t</a></code></dt><dd><p>Return the automaton representing all Topl properties.</p></dd></dl><dl><dt class="spec value" id="val-is_shallow_active"><a href="#val-is_shallow_active" class="anchor"></a><code><span class="keyword">val</span> is_shallow_active : unit <span>&#45;&gt;</span> bool</code></dt><dd><p>Return whether the Topl based on Sil instrumentation is active.</p></dd></dl><dl><dt class="spec value" id="val-is_deep_active"><a href="#val-is_deep_active" class="anchor"></a><code><span class="keyword">val</span> is_deep_active : unit <span>&#45;&gt;</span> bool</code></dt><dd><p>Return whether PulseTopl is active.</p></dd></dl><dl><dt class="spec value" id="val-get_proc_attr"><a href="#val-get_proc_attr" class="anchor"></a><code><span class="keyword">val</span> get_proc_attr : <a href="../IR/Procname/index.html#type-t">IR.Procname.t</a> <span>&#45;&gt;</span> <span><a href="../IR/ProcAttributes/index.html#type-t">IR.ProcAttributes.t</a> option</span></code></dt><dd><p><code>get_proc_attr proc_name</code> returns the attributes of <code>get_proc_desc proc_name</code></p></dd></dl><dl><dt class="spec value" id="val-get_proc_desc"><a href="#val-get_proc_desc" class="anchor"></a><code><span class="keyword">val</span> get_proc_desc : <a href="../IR/Procname/index.html#type-t">IR.Procname.t</a> <span>&#45;&gt;</span> <span><a href="../IR/Procdesc/index.html#type-t">IR.Procdesc.t</a> option</span></code></dt><dd><p>Return a synthesized Procdesc.t, when it corresponds to instrumentation for a TOPL property.</p></dd></dl><dl><dt class="spec value" id="val-sourcefile"><a href="#val-sourcefile" class="anchor"></a><code><span class="keyword">val</span> sourcefile : unit <span>&#45;&gt;</span> <a href="../IBase/SourceFile/index.html#type-t">IBase.SourceFile.t</a></code></dt><dd><p>The (fake) sourcefile in which synthesized code resides. This function has a side-effect, because that's how <code>SourceFile</code> works, so do NOT call when Topl is inactive.</p></dd></dl><dl><dt class="spec value" id="val-cfg"><a href="#val-cfg" class="anchor"></a><code><span class="keyword">val</span> cfg : unit <span>&#45;&gt;</span> <a href="../IR/Cfg/index.html#type-t">IR.Cfg.t</a></code></dt><dd><p>The CFG of the synthesized code. This function has a side-effect, because that's how <code>Cfg</code> works, so do NOT call when Topl is inactive.</p></dd></dl><dl><dt class="spec type" id="type-analysis"><a href="#type-analysis" class="anchor"></a><code><span class="keyword">type</span> <span>'summary analysis</span></code><code> = <span><span class="type-var">'summary</span> <a href="../Absint/InterproceduralAnalysis/index.html#type-t">Absint.InterproceduralAnalysis.t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'summary</span> option</span></code></dt><dt class="spec type" id="type-postprocess"><a href="#type-postprocess" class="anchor"></a><code><span class="keyword">type</span> <span>'summary postprocess</span></code><code> = <span><span class="type-var">'summary</span> <a href="../Absint/InterproceduralAnalysis/index.html#type-t">Absint.InterproceduralAnalysis.t</a></span> <span>&#45;&gt;</span> <span class="type-var">'summary</span> <span>&#45;&gt;</span> unit</code></dt><dt class="spec type" id="type-analysis_transformer"
[website] docs for current master Summary: Run `make doc-publish` and adjust links in website/docs/04-internal-API.md to point to odoc/next/infer/infer.html as the starting point of the docs has changed (was: odoc/index.html but now this also contains dead links to sledge and ppx_trace... also infer.mld is a me-written exposé of the various libraries and index.mld is an auto-generated list of all the modules now). Reviewed By: ngorogiannis Differential Revision: D21552864 fbshipit-source-id: c3977f645 5 years ago				`<!DOCTYPE html>`
[website] Updating website Summary: updating website. The update was triggered by `make doc-publish`. Reviewed By: jvillard Differential Revision: D26424662 fbshipit-source-id: 5be2369cd 4 years ago				<html xmlns="http://www.w3.org/1999/xhtml"><head><title>TOPLlib__Topl (infer.TOPLlib__Topl)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.2"/><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> » TOPLlib__Topl</nav><h1>Module <code>TOPLlib__Topl</code></h1></header><dl><dt class="spec value" id="val-automaton"><a href="#val-automaton" class="anchor"></a><code><span class="keyword">val</span> automaton : unit <span>-></span> <a href="../TOPLlib/ToplAutomaton/index.html#type-t">TOPLlib.ToplAutomaton.t</a></code></dt><dd><p>Return the automaton representing all Topl properties.</p></dd></dl><dl><dt class="spec value" id="val-is_shallow_active"><a href="#val-is_shallow_active" class="anchor"></a><code><span class="keyword">val</span> is_shallow_active : unit <span>-></span> bool</code></dt><dd><p>Return whether the Topl based on Sil instrumentation is active.</p></dd></dl><dl><dt class="spec value" id="val-is_deep_active"><a href="#val-is_deep_active" class="anchor"></a><code><span class="keyword">val</span> is_deep_active : unit <span>-></span> bool</code></dt><dd><p>Return whether PulseTopl is active.</p></dd></dl><dl><dt class="spec value" id="val-get_proc_attr"><a href="#val-get_proc_attr" class="anchor"></a><code><span class="keyword">val</span> get_proc_attr : <a href="../IR/Procname/index.html#type-t">IR.Procname.t</a> <span>-></span> <span><a href="../IR/ProcAttributes/index.html#type-t">IR.ProcAttributes.t</a> option</span></code></dt><dd><p><code>get_proc_attr proc_name</code> returns the attributes of <code>get_proc_desc proc_name</code></p></dd></dl><dl><dt class="spec value" id="val-get_proc_desc"><a href="#val-get_proc_desc" class="anchor"></a><code><span class="keyword">val</span> get_proc_desc : <a href="../IR/Procname/index.html#type-t">IR.Procname.t</a> <span>-></span> <span><a href="../IR/Procdesc/index.html#type-t">IR.Procdesc.t</a> option</span></code></dt><dd><p>Return a synthesized Procdesc.t, when it corresponds to instrumentation for a TOPL property.</p></dd></dl><dl><dt class="spec value" id="val-sourcefile"><a href="#val-sourcefile" class="anchor"></a><code><span class="keyword">val</span> sourcefile : unit <span>-></span> <a href="../IBase/SourceFile/index.html#type-t">IBase.SourceFile.t</a></code></dt><dd><p>The (fake) sourcefile in which synthesized code resides. This function has a side-effect, because that's how <code>SourceFile</code> works, so do NOT call when Topl is inactive.</p></dd></dl><dl><dt class="spec value" id="val-cfg"><a href="#val-cfg" class="anchor"></a><code><span class="keyword">val</span> cfg : unit <span>-></span> <a href="../IR/Cfg/index.html#type-t">IR.Cfg.t</a></code></dt><dd><p>The CFG of the synthesized code. This function has a side-effect, because that's how <code>Cfg</code> works, so do NOT call when Topl is inactive.</p></dd></dl><dl><dt class="spec type" id="type-analysis"><a href="#type-analysis" class="anchor"></a><code><span class="keyword">type</span> <span>'summary analysis</span></code><code> = <span><span class="type-var">'summary</span> <a href="../Absint/InterproceduralAnalysis/index.html#type-t">Absint.InterproceduralAnalysis.t</a></span> <span>-></span> <span><span class="type-var">'summary</span> option</span></code></dt><dt class="spec type" id="type-postprocess"><a href="#type-postprocess" class="anchor"></a><code><span class="keyword">type</span> <span>'summary postprocess</span></code><code> = <span><span class="type-var">'summary</span> <a href="../Absint/InterproceduralAnalysis/index.html#type-t">Absint.InterproceduralAnalysis.t</a></span> <span>-></span> <span class="type-var">'summary</span> <span>-></span> unit</code></dt><dt class="spec type" id="type-analysis_transformer"