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
9.7 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>Checker (infer.IBase.Checker)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.0"/><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; <a href="../index.html">IBase</a> &#x00BB; Checker</nav><h1>Module <code>IBase.Checker</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><code> = </code><table class="variant"><tr id="type-t.AnnotationReachability" class="anchored"><td class="def constructor"><a href="#type-t.AnnotationReachability" class="anchor"></a><code>| </code><code><span class="constructor">AnnotationReachability</span></code></td></tr><tr id="type-t.Biabduction" class="anchored"><td class="def constructor"><a href="#type-t.Biabduction" class="anchor"></a><code>| </code><code><span class="constructor">Biabduction</span></code></td></tr><tr id="type-t.BufferOverrun" class="anchored"><td class="def constructor"><a href="#type-t.BufferOverrun" class="anchor"></a><code>| </code><code><span class="constructor">BufferOverrun</span></code></td></tr><tr id="type-t.ClassLoads" class="anchored"><td class="def constructor"><a href="#type-t.ClassLoads" class="anchor"></a><code>| </code><code><span class="constructor">ClassLoads</span></code></td></tr><tr id="type-t.Cost" class="anchored"><td class="def constructor"><a href="#type-t.Cost" class="anchor"></a><code>| </code><code><span class="constructor">Cost</span></code></td></tr><tr id="type-t.Eradicate" class="anchored"><td class="def constructor"><a href="#type-t.Eradicate" class="anchor"></a><code>| </code><code><span class="constructor">Eradicate</span></code></td></tr><tr id="type-t.FragmentRetainsView" class="anchored"><td class="def constructor"><a href="#type-t.FragmentRetainsView" class="anchor"></a><code>| </code><code><span class="constructor">FragmentRetainsView</span></code></td></tr><tr id="type-t.ImmutableCast" class="anchored"><td class="def constructor"><a href="#type-t.ImmutableCast" class="anchor"></a><code>| </code><code><span class="constructor">ImmutableCast</span></code></td></tr><tr id="type-t.Impurity" class="anchored"><td class="def constructor"><a href="#type-t.Impurity" class="anchor"></a><code>| </code><code><span class="constructor">Impurity</span></code></td></tr><tr id="type-t.InefficientKeysetIterator" class="anchored"><td class="def constructor"><a href="#type-t.InefficientKeysetIterator" class="anchor"></a><code>| </code><code><span class="constructor">InefficientKeysetIterator</span></code></td></tr><tr id="type-t.Linters" class="anchored"><td class="def constructor"><a href="#type-t.Linters" class="anchor"></a><code>| </code><code><span class="constructor">Linters</span></code></td></tr><tr id="type-t.LithoRequiredProps" class="anchored"><td class="def constructor"><a href="#type-t.LithoRequiredProps" class="anchor"></a><code>| </code><code><span class="constructor">LithoRequiredProps</span></code></td></tr><tr id="type-t.Liveness" class="anchored"><td class="def constructor"><a href="#type-t.Liveness" class="anchor"></a><code>| </code><code><span class="constructor">Liveness</span></code></td></tr><tr id="type-t.LoopHoisting" class="anchored"><td class="def constructor"><a href="#type-t.LoopHoisting" class="anchor"></a><code>| </code><code><span class="constructor">LoopHoisting</span></code></td></tr><tr id="type-t.NullsafeDeprecated" class="anchored"><td class="def constructor"><a href="#type-t.NullsafeDeprecated" class="anchor"></a><code>| </code><code><span class="constructor">NullsafeDeprecated</span></code></td></tr><tr id="type-t.PrintfArgs" class="anchored"><td class="def constructor"><a href="#type-t.PrintfArgs" class="anchor"></a><code>| </code><code><span class="constructor">PrintfArgs</span></code></td></tr><tr id="type-t.Pulse" class="anchored"><td class="def constructor"><a href="#type-t.Pulse" class="anchor"></a><code>| </code><code><span class="constructor">Pulse</span></code></td></tr><tr id="type-t.Purity" class="anchored"><td class="def constructor"><a href="#type-t.Purity" class="anchor"></a><code>| </code><code><span class="constructor">Purity</span></code></td></tr><tr id="type-t.Quandary" class="anchored"><td class="def constructor"><a href="#type-t.Quandary" class="anchor"></a><code>| </code><code><span class="constructor">Quandary</span></code></td></tr><tr id="type-t.RacerD" class="anchored"><td class="def constructor"><a href="#type-t.RacerD" class="anchor"></a><code>| </code><code><span class="constructor">RacerD</span></code></td></tr><tr id="type-t.ResourceLeak" class="anchored"><td class="def constructor"><a href="#type-t.ResourceLeak" class="anchor"></a><code>| </code><code><span class="constructor">ResourceLeak</span></code></td></tr><tr id="type-t.SIOF" class="anchored"><td class="def constructor"><a href="#type-t.SIOF" class="anchor"></a><code>| </code><code><span class="constructor">SIOF</span></code></td></tr><tr id="type-t.SelfInBlock" class="anchored"><td class="def constructor"><a href="#type-t.SelfInBlock" class="anchor"></a><code>| </code><code><span class="constructor">SelfInBlock</span></code></td></tr><tr id="type-t.Starvation" class="anchored"><td class="def constructor"><a href="#type-t.Starvation" class="anchor"></a><code>| </code><code><span class="constructor">Starvation</span></code></td></tr><tr id="type-t.Uninit" class="anchored"><td class="def constructor"><a href="#type-t.Uninit" class="anchor"></a><code>| </code><code><span class="constructor">Uninit</span></code></td></tr></table></dt></dl><div><div class="spec include"><div class="doc"><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>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> bool</code></dt><dt class="spec value" id="val-all"><a href="#val-all" class="anchor"></a><code><span class="keyword">val</span> all : <span><a href="index.html#type-t">t</a> list</span></code></dt></dl></div></div></div><dl><dt class="spec type" id="type-support"><a href="#type-support" class="anchor"></a><code><span class="keyword">type</span> support</code><code> = </code><table class="variant"><tr id="type-support.NoSupport" class="anchored"><td class="def constructor"><a href="#type-support.NoSupport" class="anchor"></a><code>| </code><code><span class="constructor">NoSupport</span></code></td><td class="doc"><p>checker does not run at all for this language</p></td></tr><tr id="type-support.Support" class="anchored"><td class="def constructor"><a href="#type-support.Support" class="anchor"></a><code>| </code><code><span class="constructor">Support</span></code></td><td class="doc"><p>checker is expected to give reasonable results</p></td></tr><tr id="type-support.ExperimentalSupport" class="anchored"><td class="def constructor"><a href="#type-support.ExperimentalSupport" class="anchor"></a><code>| </code><code><span class="constructor">ExperimentalSupport</span></code></td><td class="doc"><p>checker runs but is not expected to give reasonable results</p></td></tr><tr id="type-support.ToySupport" class="anchored"><td class="def constructor"><a href="#type-support.ToySupport" class="anchor"></a><code>| </code><code><span class="constructor">ToySupport</span></code></td><td class="doc"><p>the checker is for teaching purposes only (like experimental but with no plans to improve it)</p></td></tr></table></dt><dd><p>per-language support for each checker</p></dd></dl><dl><dt class="spec type" id="type-config"><a href="#type-config" class="anchor"></a><code><span class="keyword">type</span> config</code><code> = </code><code>{</code><table class="record"><tr id="type-config.support" class="anchored"><td class="def field"><a href="#type-config.support" class="anchor"></a><code>support : <a href="../Language/index.html#type-t">Language.t</a> <span>&#45;&gt;</span> <a href="index.html#type-support">support</a>;</code></td></tr><tr id="type-config.short_documentation" class="anchored"><td class="def field"><a href="#type-config.short_documentation" class="anchor"></a><code>short_documentation : string;</code></td></tr><tr id="type-config.cli_flag" class="anchored"><td class="def field"><a href="#type-config.cli_flag" class="anchor"></a><code>cli_flag : string;</code></td><td class="doc"><p>the flag to enable this option on the command line, without the leading &quot;--&quot; (like the <code>~long</code> argument of <code>CommandLineOption</code> functions)</p></td></tr><tr id="type-config.show_in_help" class="anchored"><td class="def field"><a href="#type-config.show_in_help" class="anchor"></a><code>show_in_help : bool;</code></td></tr><tr id="type-config.enabled_by_default" class="anchored"><td class="def field"><a href="#type-config.enabled_by_default" class="anchor"></a><code>enabled_by_default : bool;</code></td></tr><tr id="type-config.cli_deprecated_flags" class="anchored"><td class="def field"><a href="#type-config.cli_deprecated_flags" class="anchor"></a><code>cli_deprecated_flags : <span>string list</span>;</code></td><td class="doc"><p>more command-line flags, similar to <code>~deprecated</code> arguments</p></td></tr></table><code>}</code></dt></dl><dl><dt class="spec value" id="val-config"><a href="#val-config" class="anchor"></a><code><span class="keyword">val</span> config : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-config">config</a></code></dt></dl></div></body></html>