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>Checker (infer.IBase.Checker)</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>» Checker</nav><h1>Module <code>IBase.Checker</code></h1></header><dl><dtclass="spec type"id="type-t"><ahref="#type-t"class="anchor"></a><code><spanclass="keyword">type</span> t</code><code> = </code><tableclass="variant"><trid="type-t.AnnotationReachability"class="anchored"><tdclass="def constructor"><ahref="#type-t.AnnotationReachability"class="anchor"></a><code>| </code><code><spanclass="constructor">AnnotationReachability</span></code></td></tr><trid="type-t.Biabduction"class="anchored"><tdclass="def constructor"><ahref="#type-t.Biabduction"class="anchor"></a><code>| </code><code><spanclass="constructor">Biabduction</span></code></td></tr><trid="type-t.BufferOverrunAnalysis"class="anchored"><tdclass="def constructor"><ahref="#type-t.BufferOverrunAnalysis"class="anchor"></a><code>| </code><code><spanclass="constructor">BufferOverrunAnalysis</span></code></td></tr><trid="type-t.BufferOverrunChecker"class="anchored"><tdclass="def constructor"><ahref="#type-t.BufferOverrunChecker"class="anchor"></a><code>| </code><code><spanclass="constructor">BufferOverrunChecker</span></code></td></tr><trid="type-t.ConfigChecksBetweenMarkers"class="anchored"><tdclass="def constructor"><ahref="#type-t.ConfigChecksBetweenMarkers"class="anchor"></a><code>| </code><code><spanclass="constructor">ConfigChecksBetweenMarkers</span></code></td></tr><trid="type-t.Cost"class="anchored"><tdclass="def constructor"><ahref="#type-t.Cost"class="anchor"></a><code>| </code><code><spanclass="constructor">Cost</span></code></td></tr><trid="type-t.Eradicate"class="anchored"><tdclass="def constructor"><ahref="#type-t.Eradicate"class="anchor"></a><code>| </code><code><spanclass="constructor">Eradicate</span></code></td></tr><trid="type-t.FragmentRetainsView"class="anchored"><tdclass="def constructor"><ahref="#type-t.FragmentRetainsView"class="anchor"></a><code>| </code><code><spanclass="constructor">FragmentRetainsView</span></code></td></tr><trid="type-t.ImmutableCast"class="anchored"><tdclass="def constructor"><ahref="#type-t.ImmutableCast"class="anchor"></a><code>| </code><code><spanclass="constructor">ImmutableCast</span></code></td></tr><trid="type-t.Impurity"class="anchored"><tdclass="def constructor"><ahref="#type-t.Impurity"class="anchor"></a><code>| </code><code><spanclass="constructor">Impurity</span></code></td></tr><trid="type-t.InefficientKeysetIterator"class="anchored"><tdclass="def constructor"><ahref="#type-t.InefficientKeysetIterator"class="anchor"></a><code>| </code><code><spanclass="constructor">InefficientKeysetIterator</span></code></td></tr><trid="type-t.Linters"class="anchored"><tdclass="def constructor"><ahref="#type-t.Linters"class="anchor"></a><code>| </code><code><spanclass="constructor">Linters</span></code></td></tr><trid="type-t.LithoRequiredProps"class="anchored"><tdclass="def constructor"><ahref="#type-t.LithoRequiredProps"class="anchor"></a><code>| </code><code><spanclass="constructor">LithoRequiredProps</span></code></td></tr><trid="type-t.Liveness"class="anchored"><tdclass="def constructor"><ahref="#type-t.Liveness"class="anchor"></a><code>| </code><code><spanclass="constructor">Liveness</span></code></td></tr><trid="type-t.LoopHoisting"class="anchored"><tdclass="def constructor"><ahref="#type-t.LoopHoisting"class="anchor"></a><code>| </code><code><spanclass="constructor">LoopHoisting</span></code></td></tr><trid="type-t.NullsafeDeprecated"class="anchored"><tdclass="def constructor"><ahref="#type-t.NullsafeDeprecated"class="anchor"></a><code>| </code><code><spanclass="constructor">NullsafeDeprecated</span></code></td></tr><trid="type-t.PrintfArgs"class="anchored"><tdclass="def constructor"><ahref="#type-t.PrintfArgs"class="anchor"></a><code>| </code><code><spanclass="constructor">PrintfArgs</span></code></td></tr><trid="type-t.Pulse"class="anchored"><tdclass="def constructor"><ahref="#type-t.Pulse"class="anchor"></a><code>| </code><code><spanclass="constructor">Pulse</span></code></td></tr><trid="type-t.PurityAnalysis"class="anchored"><tdclass="def constructor"><ahref="#type-t.PurityAnalysis"class="anchor"></a><code>| </code><code><spanclass="constructor">PurityAnalysis</span></code></td></tr><trid="type-t.PurityChecker"class="anchored"><tdclass="def constructor"><ahref="#type-t.PurityChecker"class="anchor"></a><code>| </code><code><spanclass="constructor">PurityChecker</span></code></td></tr><trid="type-t.Quandary"class="anchored"><tdclass="def constructor"><ahref="#type-t.Quandary"class="anchor"></a><code>| </code><code><spanclass="constructor">Quandary</span></code></td></tr><trid="type-t.RacerD"class="anchored"><tdclass="def constructor"><ahref="#type-t.RacerD"class="anchor"></a><code>| </code><code><spanclass="constructor">RacerD</span></code></td></tr><trid="type-t.ResourceLeakLabExercise"class="anchored"><tdclass="def constructor"><ahref="#type-t.ResourceLeakLabExercise"class="anchor"></a><code>| </code><code><spanclass="constructor">ResourceLeakLabExercise</span></code></td></tr><trid="type-t.SIOF"class="anchored"><tdclass="def constructor"><ahref="#type-t.SIOF"class="anchor"></a><code>| </code><code><spanclass="constructor">SIOF</span></code></td></tr><trid="type-t.SelfInBlock"class="anchored"><tdclass="def constructor"><ahref="#type-t.SelfInBlock"class="anchor"></a><code>| </code><code><spanclass="constructor">SelfInBlock</span></code></td></tr><trid="type-t.Starvation"class="anchored"><tdclass="def constructor"><ahref="#type-t.Starvation"class="anchor"></a><code>| </code><code><spanclass="constructor">Starvation</span></code></td></tr><trid="type-t.ToplOnBiabduction"class="anchored"><tdclass="def constructor"><ahref="#type-t.ToplOnBiabduction"class="anchor"></a><code>| </code><code><spanclass="constructor">ToplOnBiabduction</span></code></td></tr><trid="type-t.ToplOnPulse"class="anchored"><tdclass="def constructor"><ahref="#type-t.ToplOnPulse"class="anchor"></a><code>| </code><code><spanclass="constructor">ToplOnPulse</span></code></td></tr><trid="type-t.Uninit"class="anchored"><tdclass="def constructor"><ahref="#type-t.Uninit"class="anchor"></a><code>| </code><code><spanclass="constructor">Uninit</span></code></td></tr></table></dt></dl><div><divclass="spec include"><divclass="doc"><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><dtclass="spec value"id="val-all"><ahref="#val-all"class="anchor"></a><code><spanclass="keyword">val</span> all : <span><ahref="index.html#type-t">t</a> list</span></code></dt></dl></div></div></div><dl><dtclass="spec type"id="type-support"><ahref="#type-support"class="anchor"></a><code><spanclass="keyword">type</span> support</code><code> = </code><tableclass="variant"><trid="type-support.NoSupport"class="anchored"><tdclass="def constructor"><ahref="#type-support.NoSupport"class="anchor"></a><code>| </code><code><spanclass="constructor">NoSupport</span></code></td><tdclass="doc"><p>checker does not run at all for this language</p></td></tr><trid="type-support.ExperimentalSupport"class="anchored"><tdclass="def constructor"><ahref="#type-support.ExperimentalSupport"class="anchor"></a><code>| </code><code><spanclass="constructor">ExperimentalSupport</span></code></td><tdclass="doc"><p>checker runs but is not expected to give reasonable results</p></td></tr><trid="type-support.Support"class="anchored"><tdclass="def constructor"><ahref="#type-support.Support"class="anchor"></a><code>| </code><code><spanclass="constructor">Support</span></code></td><tdclass="doc"><p>checker is expected to give reasonable results</p></td></tr></table></dt><dd><p>per-language support for each checker</p></dd></dl><dl><dtclass="spec type"id="type-cli_flags"><ahref="#type-cli_flags"class="anchor"></a><code><spanclass="keyword">type</span> cli_flags</code><code> = </code><code>{</code><tableclass="record"><trid="type-cli_flags.deprecated"class="anchored"><tdclass="def field"><ahref="#type-cli_flags.deprecated"class="anchor"></a><code>deprecated : <span>string list</span>;</code></td><tdclass="doc"><p>More command-line flags, similar to <code>~deprecated</code> arguments in <ahref="../CommandLineOption/index.html"><code>CommandLineOption</code></a>.</p></td></tr><trid="type-cli_flags.show_in_help"class="anchored"><tdclass="def field"><ahref="#type-cli_flags.show_in_help"class="anchor"></a><code>show_in_help : bool;</code></td></tr></table><code>}</code></dt><dtclass="spec type"id="type-kind"><ahref="#type-kind"class="anchor"></a><code><spanclass="keyword">type</span> kind</code><code> = </code><tableclass="variant"><trid="type-kind.UserFacing"class="anchored"><tdclass="def constructor"><ahref="#type-kind.UserFacing"class="anchor"></a><code>| </code><code><spanclass="constructor">UserFacing</span><spanclass="keyword">of</span></code><code>{</code><tableclass="record"><trid="type-kind.title"class="anchored"><tdclass="def field"><ahref="#type-kind.title"class="anchor"></a><code>title : string;</code></td><tdclass="doc"><p>the title of the documentation web page</p></td></tr><trid="type-kind.markdown_body"class="anchored"><tdclass="def field"><ahref="#type-kind.markdown_body"class="anchor"></a><code>markdown_body : string;</code></td><tdclass="doc"><p>main text of the documentation</p></td></tr></table><code>}</code></td><tdclass="doc"><p>can report issues to users</p></td></tr><trid="type-kind.UserFacingDeprecated"class="anchored"><tdclass="def constructor"><ahref="#type-kind.UserFacingDeprecated"class="anchor"></a><code>| </code><code><spanclass="constructor">UserFacingDeprecated</span><spanclass="keyword">of</span></code><code>{</code><tableclass="record"><trid="type-kind.title"class="anchored"><tdclass="def field"><ahref="#type-kind.title"class="anchor"></a><code>title : string;</code></td><tdclass="doc"><p>the title of the documentation web page</p></td></tr><trid="type-kind.markdown_body"class="anchored"><tdclass="def field"><ahref="#type-kind.markdown_body"class="anchor"></a><code>markdown_body : string;</code></td><tdclass="doc"><p>main text of the documentation</p></td></tr><trid="type-kind.deprecation_message"class="anchored"><tdclass="def field"><ahref="#type-kind.deprecation_message"class="anchor"></a><code>deprecation_message : string;</code></td></tr></table><code>}</code></td><tdclass="doc"><p>can report issues to users but should probably be deleted from infer</p></td></tr><trid="type-kind.Internal"class="anchored"><tdclass="def constructor"><ahref="#type-kind.Internal"class="anchor"></a><code>| </code><code><spanclass="constructor">Internal</span></code></td><tdclass="doc"><p>Analysis that only serves other analyses. Do not use to mean experimental! Please still document experimental checkers as they will become non-experimental.</p></td></tr><trid="type-kind.Exercise"class="anchored"><tdclass="def constructor"><ahref="#type-kind.Exercise"class="anchor"></a><code>| </code><code><spanclass="constructor">Exercise</span></code></td><tdclass="doc"><p>reserved for the "resource leak" lab exercise</p></td></tr></table></dt><dtclass="spec type"id="type-config"><ahref="#type-config"class="anchor"></a><code><spanclass="keyword">type</span> config</code><code> = </code><code>{</code><tableclass="record"><trid="type-config.id"class="anchored"><tdclass="def field"><ahref="#type-config.id"class="anchor"></a><code>id : string;</code></td><tdclass="doc"><p>Unique identifier. Used to generate web URLs for the documentation as well as the flag to enable this option on the command line.</p></td></tr><trid="type-config.kind"class="anchored"><tdclass="def field"><ahref="#type-config.kind"class="anchor"></a><code>kind : <ahref="index.html#type-kind">kind</a>;</code></td></tr><trid="type-config.support"class="anchored"><tdclass="def field"><ahref="#type-config.support"class="anchor"></a><code>support : <ahref="../Language/index.html#type-t">Language.t</a><span>-></span><ahref="index.html#type-support">support</a>;</code></td></tr><trid="type-config.short_documentation"class="anchored"><tdclass="def field"><ahref="#type-config.short_documentation"class="anchor"></a><code>short_documentation : string;</code></td><tdclass="doc"><p>used in man pages and as a short intro on the website</p></td></tr><trid="type-config.cli_flags"class="anchored"><tdclass="def field"><ahref="#type-config.cli_flags"class="anchor"></a><code>cli_flags : <span><ahref="index.html#type-cli_flags">cli_flags</a> option</span>;</code></td><tdclass="doc"><p>If <code>None</code> then the checker cannot be enabled/disabled from the command line.</p></td></tr><trid="type-config.enabled_by_default"class="anchored"><tdclass="def field"><ahref="#type-config.enabled_by_default"class="anchor"></a><code>enabled_by_default : bool;</code></td></tr><trid="type-config.activates"class="anchored"><tdclass="def field"><ahref="#type-config.activates"class="anchor"></a><code>activates : <span><ahref="index.html#type-t">t</a> list</span>;</code></td><tdclass="doc"><p>list of checkers that get enabled when this checker is enabled</p></td></tr></table><code>}</code></dt></dl><dl><dtclass="spec value"id="val-config"><ahref="#val-config"class="anchor"></a><code><spanclass="keyword">val</span> config : <ahref="index.html#type-t">t</a><span>-></span><ahref="index.html#type-config">config</a></code></dt><dtclass="spec value"id="val-get_id"><ahref="#val-get_id"class="anchor"></a><code><spanclass="keyword">val</span> get_id : <ahref="index.html#type-t">t</a><span>-></span> string</code></dt><dd><p><code>get_id c</code> is <code>(config c).id</code></p></dd></dl><dl><dtclass="spec value"id="val-from_id"><ahref="#val-from_id"class="anchor"></a><code><spanclass="keyword">val</span> from_id : string <span>-></span><span><ahref="index.html#type-t">t</a> option</span></code></dt></dl></div></body></html>
