This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden characters.
<!DOCTYPE html>
<htmlxmlns="http://www.w3.org/1999/xhtml"><head><title>InferIR__ProcAttributes (InferIR.InferIR__ProcAttributes)</title><linkrel="stylesheet"href="../../odoc.css"/><metacharset="utf-8"/><metaname="viewport"content="width=device-width,initial-scale=1.0"/><metaname="generator"content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><navid="top"><ahref="../index.html">Up</a>—<spanclass="package">package <ahref="../index.html">InferIR</a></span></nav><header><h1><spanclass="keyword">Module</span><spanclass="module-path">InferIR__ProcAttributes</span></h1></header><p>Attributes of a procedure.</p><divclass="spec type"id="type-proc_flags"><ahref="#type-proc_flags"class="anchor"></a><divclass="def type"><code><spanclass="keyword">type </span>proc_flags</code><code><spanclass="keyword"> = </span>(string,string)<ahref="../../InferStdlib/InferStdlib/index.html#module-IStd">InferStdlib.IStd</a>.Caml.Hashtbl.t</code><code></code></div><divclass="doc"><p>flags for a procedure</p></div></div><divclass="spec include"><divclass="doc"></div><detailsopen="open"><summary><spanclass="def"><code><spanclass="keyword">include </span><spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></span></summary><divclass="spec val"id="val-compare_proc_flags"><ahref="#val-compare_proc_flags"class="anchor"></a><divclass="def val"><code><spanclass="keyword">val </span>compare_proc_flags : <ahref="index.html#type-proc_flags">proc_flags</a><spanclass="keyword">‑></span><ahref="index.html#type-proc_flags">proc_flags</a><spanclass="keyword">‑></span> int</code></div><divclass="doc"></div></div></details></div><divclass="spec type"id="type-clang_method_kind"><ahref="#type-clang_method_kind"class="anchor"></a><divclass="def type"><code><spanclass="keyword">type </span>clang_method_kind</code><code></code><code><spanclass="keyword"> = </span></code><tableclass="variant"><trid="type-clang_method_kind.CPP_INSTANCE"class="anchored"><tdclass="def constructor"><ahref="#type-clang_method_kind.CPP_INSTANCE"class="anchor"></a><code><spanclass="keyword">| </span></code><code><spanclass="constructor">CPP_INSTANCE</span></code></td></tr><trid="type-clang_method_kind.OBJC_INSTANCE"class="anchored"><tdclass="def constructor"><ahref="#type-clang_method_kind.OBJC_INSTANCE"class="anchor"></a><code><spanclass="keyword">| </span></code><code><spanclass="constructor">OBJC_INSTANCE</span></code></td></tr><trid="type-clang_method_kind.CPP_CLASS"class="anchored"><tdclass="def constructor"><ahref="#type-clang_method_kind.CPP_CLASS"class="anchor"></a><code><spanclass="keyword">| </span></code><code><spanclass="constructor">CPP_CLASS</span></code></td></tr><trid="type-clang_method_kind.OBJC_CLASS"class="anchored"><tdclass="def constructor"><ahref="#type-clang_method_kind.OBJC_CLASS"class="anchor"></a><code><spanclass="keyword">| </span></code><code><spanclass="constructor">OBJC_CLASS</span></code></td></tr><trid="type-clang_method_kind.BLOCK"class="anchored"><tdclass="def constructor"><ahref="#type-clang_method_kind.BLOCK"class="anchor"></a><code><spanclass="keyword">| </span></code><code><spanclass="constructor">BLOCK</span></code></td></tr><trid="type-clang_method_kind.C_FUNCTION"class="anchored"><tdclass="def constructor"><ahref="#type-clang_method_kind.C_FUNCTION"class="anchor"></a><code><spanclass="keyword">| </span></code><code><spanclass="constructor">C_FUNCTION</span></code></td></tr></table><code></code></div><divclass="doc"></div></div><divclass="spec include"><divclass="doc"></div><detailsopen="open"><summary><spanclass="def"><code><spanclass="keyword">include </span><spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></span></summary><divclass="spec val"id="val-compare_clang_method_kind"><ahref="#val-compare_clang_method_kind"class="anchor"></a><divclass="def val"><code><spanclass="keyword">val </span>compare_clang_method_kind : <ahref="index.html#type-clang_method_kind">clang_method_kind</a><spanclass="keyword">‑></span><ahref="index.html#type-clang_method_kind">clang_method_kind</a><spanclass="keyword">‑></span> int</code></div><divclass="doc"></div></div></details></div><divclass="spec val"id="val-equal_clang_method_kind"><ahref="#val-equal_clang_method_kind"class="anchor"></a><divclass="def val"><code><spanclass="keyword">val </span>equal_clang_method_kind : <ahref="index.html#type-clang_method_kind">clang_method_kind</a><spanclass="keyword">‑></span><ahref="index.html#type-clang_method_kind">clang_method_kind</a><spanclass="keyword">‑></span> bool</code></div><divclass="doc"></div></div><divclass="spec val"id="val-string_of_clang_method_kind"><ahref="#val-string_of_clang_method_kind"class="anchor"></a><divclass="def val"><code><spanclass="keyword">val </span>string_of_clang_method_kind : <ahref="index.html#type-clang_method_kind">clang_method_kind</a><spanclass="keyword">‑></span> string</code></div><divclass="doc"></div></div><divclass="spec type"id="type-objc_accessor_type"><ahref="#type-objc_accessor_type"class="anchor"></a><divclass="def type"><code><spanclass="keyword">type </span>objc_accessor_type</code><code></code><code><spanclass="keyword"> = </span></code><tableclass="variant"><trid="type-objc_accessor_type.Objc_getter"class="anchored"><tdclass="def constructor"><ahref="#type-objc_accessor_type.Objc_getter"class="anchor"></a><code><spanclass="keyword">| </span></code><code><spanclass="constructor">Objc_getter</span><spanclass="keyword"> of </span><ahref="../InferIR/Typ/Struct/index.html#type-field">InferIR.Typ.Struct.field</a></code></td></tr><trid="type-objc_accessor_type.Objc_setter"class="anchored"><tdclass="def constructor"><ahref="#type-objc_accessor_type.Objc_setter"class="anchor"></a><code><spanclass="keyword">| </span></code><code><spanclass="constructor">Objc_setter</span><spanclass="keyword"> of </span><ahref="../InferIR/Typ/Struct/index.html#type-field">InferIR.Typ.Struct.field</a></code></td></tr></table><code></code></div><divclass="doc"></div></div><divclass="spec include"><divclass="doc"></div><detailsopen="open"><summary><spanclass="def"><code><spanclass="keyword">include </span><spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></span></summary><divclass="spec val"id="val-compare_objc_accessor_type"><ahref="#val-compare_objc_accessor_type"class="anchor"></a><divclass="def val"><code><spanclass="keyword">val </span>compare_objc_accessor_type : <ahref="index.html#type-objc_accessor_type">objc_accessor_type</a><spanclass="keyword">‑></span><ahref="index.html#type-objc_accessor_type">objc_accessor_type</a><spanclass="keyword">‑></span> int</code></div><divclass="doc"></div></div></details></div><divclass="spec val"id="val-kind_of_objc_accessor_type"><ahref="#val-kind_of_objc_accessor_type"class="anchor"></a><divclass="def val"><code><spanclass="keyword">val </span>kind_of_objc_accessor_type : <ahref="index.html#type-objc_accessor_type">objc_accessor_type</a><spanclass="keyword">‑></span> string</code></div><divclass="doc"></div></div><divclass="spec type"id="type-var_attribute"><ahref="#type-var_attribute"class="anchor"></a><divclass="def type"><code><spanclass="keyword">type </span>var_attribute</code><code></code><code><spanclass="keyword"> = </span></code><tableclass="variant"><trid="type-var_attribute.Modify_in_block"class="anchored"><tdclass="def constructor"><ahref="#type-var_attribute.Modify_in_block"class="anchor"></a><code><spanclass="keyword">| </span></code><code><spanclass="constructor">Modify_in_block</span></code></td></tr></table><code></code></div><divclass="doc"></div></div><divclass="spec include"><divclass="doc"></div><detailsopen="open"><summary><spanclass="def"><code><spanclass="keyword">include </span><spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></span></summary><divclass="spec val"id="val-compare_var_attribute"><ahref="#val-compare_var_attribute"class="anchor"></a><divclass="def val"><code><spanclass="keyword">val </span>compare_var_attribute : <ahref="index.html#type-var_attribute">var_attribute</a><spanclass="keyword">‑></span><ahref="index.html#type-var_attribute">var_attribute</a><spanclass="keyword">‑></span> int</code></div><divclass="doc"></div></div></details></div><divclass="spec val"id="val-var_attribute_equal"><ahref="#val-var_attribute_equal"class="anchor"></a><divclass="def val"><code><spanclass="keyword">val </span>var_attribute_equal : <ahref="index.html#type-var_attribute">var_attribute</a><spanclass="keyword">‑></span><ahref="index.html#type-var_attribute">var_attribute</a><spanclass="keyword">‑></span> bool</code></div><divclass="doc"><p>Equality for var_attribute</p></div></div><divclass="spec type"id="type-var_data"><ahref="#type-var_data"class="anchor"></a><divclass="def type"><code><spanclass="keyword">type </span>var_data</code><code></code><code><spanclass="keyword"> = </span></code><code>{</code><tableclass="record"><trid="type-var_data.name"class="anchored"><tdclass="def field"><ahref="#type-var_data.name"class="anchor"></a><code>name : <ahref="../InferIR/Mangled/index.html#type-t">InferIR.Mangled.t</a>;</code></td></tr><trid="type-var_data.typ"class="anchored"><tdclass="def field"><ahref="#type-var_data.typ"class="anchor"></a><code>typ : <ahref="../InferIR/Typ/index.html#type-t">InferIR.Typ.t</a>;</code></td></tr><trid="type-var_data.attributes"class="anchored"><tdclass="def field"><ahref="#type-var_data.attributes"class="anchor"></a><code>attributes : <ahref="index.html#type-var_attribute">var_attribute</a> list;</code></td></tr></table><code>}</code><code></code></div><divclass="doc"></div></div><divclass="spec include"><divclass="doc"></div><detailsopen="open"><summary><spanclass="def"><code><spanclass="keyword">include </span><spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></span></summary><divclass="spec val"id="val-compare_var_data"><ahref="#val-compare_var_data"class="anchor"></a><divclass="def val"><code><spanclass="keyword">val </span>compare_var_data : <ahref="index.html#type-var_data">var_data</a><spanclass="keyword">‑></span><ahref="index.html#type-var_data">var_data</a><spanclass="keyword">‑></span> int</code></div><divclass="doc"></div></div></details></div><divclass="spec type"id="type-t"><ahref="#type-t"class="anchor"></a><divclass="def type"><code><spanclass="keyword">type </span>t</code><code></code><code><spanclass="keyword"> = </span></code><code>{</code><tableclass="record"><trid="type-t.access"class="anchored"><tdclass="def field"><ahref="#type-t.access"class="anchor"></a><code>access : <ahref="../InferIR/PredSymb/index.html#type-access">InferIR.PredSymb.access</a>;</code></td><tdclass="doc"><p>(** visibility access *)</p></td></tr><trid="type-t.captured"class="anchored"><tdclass="def field"><ahref="#type-t.captured"class="anchor"></a><code>captured : (<ahref="../InferIR/Mangled/index.html#type-t">InferIR.Mangled.t</a><spanclass="keyword"> * </span><ahref="../InferIR/Typ/index.html#type-t">InferIR.Typ.t</a>) list;</code></td><tdclass="doc"><p>(** name and type of variables captured in blocks *)</p></td></tr><trid="type-t.did_preanalysis"class="anchored"><tdclass="def field"><ahref="#type-t.did_preanalysis"class="anchor"></a><code><spanclass="keyword">mutable </span>did_preanalysis : bool;</code></td><tdclass="doc"><p>(** true if we performed preanalysis on the CFG for this proc *)</p></td></tr><trid="type-t.err_log"class="anchored"><tdclass="def field"><ahref="#type-t.err_log"class="anchor"></a><code>err_log : <ahref="../InferIR/Errlog/index.html#type-t">InferIR.Errlog.t</a>;</code></td><tdclass="doc"><p>(** Error log for the procedure *)</p></td></tr><trid="type-t.exceptions"class="anchored"><tdclass="def field"><ahref="#type-t.exceptions"class="anchor"></a><code>exceptions : string list;</code></td><tdclass="doc"><p>(** exceptions thrown by the procedure *)</p></td></tr><trid="type-t.formals"class="anchored"><tdclass="def field"><ahref="#type-t.formals"class="anchor"></a><code>formals : (<ahref="../InferIR/Mangled/index.html#type-t">InferIR.Mangled.t</a><spanclass="keyword"> * </span><ahref="../InferIR/Typ/index.html#type-t">InferIR.Typ.t</a>) list;</code></td><tdclass="doc"><p>(** name and type of formal parameters *)</p></td></tr><trid="type-t.const_formals"class="anchored"><tdclass="def field"><ahref="#type-t.const_formals"class="anchor"></a><code>const_formals : int list;</code></td><tdclass="doc"><p>(** list of indices of formals that are const-qualified *)</p></td></tr><trid="type-t.by_vals"class="anchored"><tdclass="def field"><ahref="#type-t.by_vals"class="anchor"></a><code>by_vals : int list;</code></td><tdclass="doc"><p>(** list of indices of formals that are passed by-value *)</p></td></tr><trid="type-t.func_attributes"class="anchored"><tdclass="def field"><ahref="#type-t.func_attributes"class="anchor"></a><code>func_attributes : <ahref="../InferIR/PredSymb/index.html#type-func_attribute">InferIR.PredSymb.func_attribute</a> list;</code></td></tr><trid="type-t.is_abstract"class="anchored"><tdclass="def field"><ahref="#type-t.is_abstract"class="anchor"></a><code>is_abstract : bool;</code></td><tdclass="doc"><p>(** the procedure is abstract *)</p></td></tr><trid="type-t.is_bridge_method"class="anchored"><tdclass="def field"><ahref="#type-t.is_bridge_method"class="anchor"></a><code>is_bridge_method : bool;</code></td><tdclass="doc"><p>(** the procedure is a bridge method *)</p></td></tr><trid="type-t.is_defined"class="anchored"><tdclass="def field"><ahref="#type-t.is_defined"class="anchor"></a><code>is_defined : bool;</code></td><tdclass="doc"><p>(** true if the procedure is defined, and not just declared *)</p></td></tr><trid="type-t.is_cpp_noexcept_method"class="anchored"><tdclass="def field"><ahref="#type-t.is_cpp_noexcept_method"class="anchor"></a><code>is_cpp_noexcept_method : bool;</code></td><tdclass="doc"><p>(** the procedure is an C++ method annotated with "noexcept" *)</p></td></tr><trid="type-t.is_java_synchronized_method"class="anchored"><tdclass="def field"><ahref="#type-t.is_java_synchronized_method"class="anchor"></a><code>is_java_synchronized_method : bool;</code></td><tdclass="doc"><p>(** the procedure is a Java synchronized method *)</p></td></tr><trid="type-t.is_model"class="anchored"><tdclass="def field"><ahref="#type-t.is_model"class="anchor"></a><code>is_model : bool;</code></td><tdclass="doc"><p>(** the procedure is a model *)</p></td></tr><trid="type-t.is_specialized"class="anchored"><tdclass="def field"><ahref="#type-t.is_specialized"class="anchor"></a><code>is_specialized : bool;</code></td><tdclass="doc"><p>(** the procedure is a clone specialized for dynamic dispatch handling *)</p></td></tr><trid="type-t.is_synthetic_method"class="anchored"><tdclass="def field"><ahref="#type-t.is_synthetic_method"class="anchor"></a><code>is_synthetic_method : bool;</code></td><tdclass="doc"><p>(** the procedure is a synthetic method *)</p></td></tr><trid="type-t.clang_method_kind"class="anchored"><tdclass="def field"><ahref="#type-t.clang_method_kind"class="anchor"></a><code>clang_method_kind : <ahref="index.html#type-clang_method_kind">clang_method_kind</a>;</code></td><tdclass="doc"><p>(** the kind of method the procedure is *)</p></td></tr><trid="type-t.loc"class="anchored"><tdclass="def field"><ahref="#type-t.loc"class="anchor"></a><code>loc : <ahref="../../InferBase/InferBase/Location/index.html#type-t">InferBase.Location.t</a>;</code></td><tdclass="doc"><p>(** location of this procedure in the source code *)</p></td></tr><trid="type-t.translation_unit"class="anchored"><tdclass="def field"><ahref="#type-t.translation_unit"class="anchor"></a><code>translation_unit : <ahref="../../InferBase/InferBase/SourceFile/index.html#type-t">InferBase.SourceFile.t</a> option;</code></td><tdclass="doc"><p>(** translation unit to which the procedure belongs *)</p></td></tr><trid="type-t.locals"class="anchored"><tdclass="def field"><ahref="#type-t.locals"class="anchor"></a><code><spanclass="keyword">mutable </span>locals : <ahref="index.html#type-var_data">var_data</a> list;</code></td><tdclass="doc"><p>(** name, type and attributes of local variables *)</p></td></tr><trid="type-t.method_annotation"class="anchored"><tdclass="def field"><ahref="#type-t.method_annotation"class="anchor"></a><code>method_annotation : <ahref="../InferIR/Annot/Method/index.html#type-t">InferIR.Annot.Method.t</a>;</code></td><tdclass="doc"><p>(** annotations for all methods *)</p></td></tr><trid="type-t.objc_accessor"class="anchored"><tdclass="def field"><ahref="#type-t.objc_accessor"class="anchor"></a><code>objc_accessor : <ahref="index.html#type-objc_accessor_type">objc_accessor_type</a> option;</code></td><tdclass="doc"><p>(** type of ObjC accessor, if any *)</p></td></tr><trid="type-t.proc_flags"class="anchored"><tdclass="def field"><ahref="#type-t.proc_flags"class="anchor"></a><code>proc_flags : <ahref="index.html#type-proc_flags">proc_flags</a>;</code></td><tdclass="doc"><p>(** flags of the procedure *)</p></td></tr><trid="type-t.proc_name"class="anchored"><tdclass="def field"><ahref="#type-t.proc_name"class="anchor"></a><code>proc_name : <ahref="../InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a>;</code></td><tdclass="doc"><p>(** name of the procedure *)</p></td></tr><trid="type-t.ret_type"class="anchored"><tdclass="def field"><ahref="#type-t.ret_type"class="anchor"></a><code>ret_type : <ahref="../InferIR/Typ/index.html#type-t">InferIR.Typ.t</a>;</code></td><tdclass="doc"><p>(** return type *)</p></td></tr><trid="type-t.source_file_captured"class="anchored"><tdclass="def field"><ahref="#type-t.source_file_captured"class="anchor"></a><code>source_file_captured : <ahref="../../InferBase/InferBase/SourceFile/index.html#type-t">InferBase.SourceFile.t</a>;</code></td><tdclass="doc"><p>(** source file where the procedure was captured *)</p></td></tr></table><code>}</code><code></code></div><divclass="doc"></div></div><divclass="spec include"><divclass="doc"></div><detailsopen="open"><summary><spanclass="def"><code><spanclass="keyword">include </span><spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></span></summary><divclass="spec val"id="val-compare"><ahref="#val-compare"class="anchor"></a><divclass="def val"><code><spanclass="keyword">val </span>compare : <ahref="index.html#type-t">t</a><spanclass="keyword">‑></span><ahref="index.html#type-t">t</a><spanclass="keyword">‑></span> int</code></div><divclass="doc"></div></div></details></div><divclass="spec val"id="val-default"><ahref="#val-default"class="anchor"></a><divclass="def val"><code><spanclass="keyword">val </span>default : <ahref="../InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a><spanclass="keyword">‑></span><ahref="index.html#type-t">t</a></code></div><divclass="doc"><p>Create a proc_attributes with default values.</p></div></div><divclass="spec val"id="val-pp"><ahref="#val-pp"class="anchor"></a><divclass="def val"><code><spanclass="keyword">val </span>pp : Format.formatter <spanclass="keyword">‑></span><ahref="index.html#type-t">t</a><spanclass="keyword">‑></span> unit</code></div><divclass="doc"></div></div><divclass="spec module"id="module-SQLite"><ahref="#module-SQLite"class="anchor"></a><divclass="def module"><code><spanclass="keyword">module </span><ahref="SQLite/index.html">SQLite</a> : <ahref="../../InferBase/InferBase/SqliteUtils/index.html#module-type-Data">InferBase.SqliteUtils.Data</a><spanclass="keyword"> with </span><spanclass="keyword">type </span><ahref="../../InferBase/InferBase/SqliteUtils/module-type-Data/index.html#type-t">t</a><spanclass="keyword"> = </span><ahref="index.html#type-t">t</a></code></div><divclass="doc"></div></div></body></html>
