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>IR__ProcAttributes (infer.IR__ProcAttributes)</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>» IR__ProcAttributes</nav><h1>Module <code>IR__ProcAttributes</code></h1></header><aside><p>Attributes of a procedure.</p></aside><dl><dtclass="spec type"id="type-access"><ahref="#type-access"class="anchor"></a><code><spanclass="keyword">type</span> access</code><code> = </code><tableclass="variant"><trid="type-access.Default"class="anchored"><tdclass="def constructor"><ahref="#type-access.Default"class="anchor"></a><code>| </code><code><spanclass="constructor">Default</span></code></td></tr><trid="type-access.Public"class="anchored"><tdclass="def constructor"><ahref="#type-access.Public"class="anchor"></a><code>| </code><code><spanclass="constructor">Public</span></code></td></tr><trid="type-access.Private"class="anchored"><tdclass="def constructor"><ahref="#type-access.Private"class="anchor"></a><code>| </code><code><spanclass="constructor">Private</span></code></td></tr><trid="type-access.Protected"class="anchored"><tdclass="def constructor"><ahref="#type-access.Protected"class="anchor"></a><code>| </code><code><spanclass="constructor">Protected</span></code></td></tr></table></dt><dd><p>Visibility modifiers.</p></dd></dl><div><divclass="spec include"><divclass="doc"><dl><dtclass="spec value"id="val-compare_access"><ahref="#val-compare_access"class="anchor"></a><code><spanclass="keyword">val</span> compare_access : <ahref="index.html#type-access">access</a><span>-></span><ahref="index.html#type-access">access</a><span>-></span> int</code></dt></dl></div></div></div><dl><dtclass="spec value"id="val-equal_access"><ahref="#val-equal_access"class="anchor"></a><code><spanclass="keyword">val</span> equal_access : <ahref="index.html#type-access">access</a><span>-></span><ahref="index.html#type-access">access</a><span>-></span> bool</code></dt></dl><dl><dtclass="spec type"id="type-objc_accessor_type"><ahref="#type-objc_accessor_type"class="anchor"></a><code><spanclass="keyword">type</span> objc_accessor_type</code><code> = </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>| </code><code><spanclass="constructor">Objc_getter</span><spanclass="keyword">of</span><ahref="../IR/Struct/index.html#type-field">IR.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>| </code><code><spanclass="constructor">Objc_setter</span><spanclass="keyword">of</span><ahref="../IR/Struct/index.html#type-field">IR.Struct.field</a></code></td></tr></table></dt><dtclass="spec type"id="type-var_data"><ahref="#type-var_data"class="anchor"></a><code><spanclass="keyword">type</span> var_data</code><code> = </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="../IR/Mangled/index.html#type-t">IR.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="../IR/Typ/index.html#type-t">IR.Typ.t</a>;</code></td></tr><trid="type-var_data.modify_in_block"class="anchored"><tdclass="def field"><ahref="#type-var_data.modify_in_block"class="anchor"></a><code>modify_in_block : bool;</code></td><tdclass="doc"><p>__block attribute of Objective-C variables, means that it will be modified inside a block</p></td></tr><trid="type-var_data.is_constexpr"class="anchored"><tdclass="def field"><ahref="#type-var_data.is_constexpr"class="anchor"></a><code>is_constexpr : bool;</code></td></tr><trid="type-var_data.is_declared_unused"class="anchored"><tdclass="def field"><ahref="#type-var_data.is_declared_unused"class="anchor"></a><code>is_declared_unused : bool;</code></td><tdclass="doc"><p>variable declared with attribute <code>unused</code></p></td></tr></table><code>}</code></dt><dtclass="spec type"id="type-specialized_with_blocks_info"><ahref="#type-specialized_with_blocks_info"class="anchor"></a><code><spanclass="keyword">type</span> specialized_with_blocks_info</code><code> = </code><code>{</code><tableclass="record"><trid="type-specialized_with_blocks_info.orig_proc"class="anchored"><tdclass="def field"><ahref="#type-specialized_with_blocks_info.orig_proc"class="anchor"></a><code>orig_proc : <ahref="../IR/Procname/index.html#type-t">IR.Procname.t</a>;</code></td></tr><trid="type-specialized_with_blocks_info.formals_to_procs_and_new_formals"class="anchored"><tdclass="def field"><ahref="#type-specialized_with_blocks_info.formals_to_procs_and_new_formals"class="anchor"></a><code>formals_to_procs_and_new_formals : <span><span>(<ahref="../IR/Procname/index.html#type-t">IR.Procname.t</a> * <span><span>(<ahref="../IR/Mangled/index.html#type-t">IR.Mangled.t</a> * <ahref="../IR/Typ/index.html#type-t">IR.Typ.t</a>)</span> list</span>)</span><ahref="../IR__Mangled/index.html#module-Map">IR.Mangled.Map</a>.t</span>;</code></td></tr></table><code>}</code></dt></dl><div><divclass="spec include"><divclass="doc"><dl><dtclass="spec value"id="val-compare_specialized_with_blocks_info"><ahref="#val-compare_specialized_with_blocks_info"class="anchor"></a><code><spanclass="keyword">val</span> compare_specialized_with_blocks_info : <ahref="index.html#type-specialized_with_blocks_info">specialized_with_blocks_info</a><span>-></span><ahref="index.html#type-specialized_with_blocks_info">specialized_with_blocks_info</a><span>-></span> int</code></dt></dl></div></div></div><dl><dtclass="spec type"id="type-t"><ahref="#type-t"class="anchor"></a><code><spanclass="keyword">type</span> t</code><code> = </code><code>{</code><tableclass="record"><trid="type-t.access"class="anchored"><tdclass="def field"><ahref="#type-t.access"class="anchor"></a><code>access : <ahref="index.html#type-access">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 : <span><ahref="../IR/CapturedVar/index.html#type-t">IR.CapturedVar.t</a> list</span>;</code></td><tdclass="doc"><p>name, type, and mode of variables captured in blocks and lambdas</p></td></tr><trid="type-t.exceptions"class="anchored"><tdclass="def field"><ahref="#type-t.exceptions"class="anchor"></a><code>exceptions : <span>string list</span>;</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 : <span><span>(<ahref="../IR/Mangled/index.html#type-t">IR.Mangled.t</a> * <ahref="../IR/Typ/index.html#type-t">IR.Typ.t</a>)</span> list</span>;</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 : <span>int list</span>;</code></td><tdclass="doc"><p>list of indices of formals that are const-qualified</p></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_biabduction_model"class="anchored"><tdclass="def field"><ahref="#type-t.is_biabduction_model"class="anchor"></a><code>is_biabduction_model : bool;</code></td><tdclass="doc"><p>the procedure is a model for the biabduction analysis</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_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_csharp_synchronized_method"class="anchored"><tdclass="def field"><ahref="#type-t.is_csharp_synchronized_method"class="anchor"></a><code>is_csharp_synchronized_method : bool;</code></td><tdclass="doc"><p>the procedure is a C# synchronized method</p></td></tr><trid="type-t.passed_as_noescape_block_to"class="anchored"><tdclass="def field"><ahref="#type-t.passed_as_noescape_block_to"class="anchor"></a><code>passed_as_noescape_block_to : <span><ahref="../IR/Procname/index.html#type-t">IR.Procname.t</a> option</span>;</code></td><tdclass="doc"><p>Present if the procedure is an Objective-C block that has been passed to the given method in a position annotated with the NS_NOESCAPE attribute.</p></td></tr><trid="type-t.is_no_return"class="anchored"><tdclass="def field"><ahref="#type-t.is_no_return"class="anchor"></a><code>is_no_return : bool;</code></td><tdclass="doc"><p>the procedure is known not to return</p></td></tr><trid="type-t.is_objc_arc_on"class="anchored"><tdclass="def field"><ahref="#type-t.is_objc_arc_on"class="anchor"></a><code>is_objc_arc_on : bool;</code></td><tdclass="doc"><p>the ObjC procedure is compiled with ARC</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.is_variadic"class="anchored"><tdclass="def field"><ahref="#type-t.is_variadic"class="anchor"></a><code>is_variadic : bool;</code></td><tdclass="doc"><p>the procedure is variadic, only supported for Clang procedures</p></td></tr><trid="type-t.sentinel_attr"class="anchored"><tdclass="def field"><ahref="#type-t.sentinel_attr"class="anchor"></a><code>sentinel_attr : <span><span>(int * int)</span> option</span>;</code></td><tdclass="doc"><p>__attribute__((sentinel(int, int)))</p></td></tr><trid="type-t.specialized_with_blocks_info"class="anchored"><tdclass="def field"><ahref="#type-t.specialized_with_blocks_info"class="anchor"></a><code>specialized_with_blocks_info : <span><ahref="index.html#type-specialized_with_blocks_info">specialized_with_blocks_info</a> option</span>;</code></td><tdclass="doc"><p>the procedure is a clone specialized with calls to concrete closures, with link to the original procedure, and a map that links the original formals to the elements of the closure used to specialize the procedure.</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="../IR/ClangMethodKind/index.html#type-t">IR.ClangMethodKind.t</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="../IBase/Location/index.html#type-t">IBase.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="../IBase/SourceFile/index.html#type-t">IBase.SourceFile.t</a>;</code></td><tdclass="doc"><p>source file where the procedure was captured</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 : <span><ahref="index.html#type-var_data">var_data</a> list</span>;</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="../IR/Annot/Method/index.html#type-t">IR.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 : <span><ahref="index.html#type-objc_accessor_type">objc_accessor_type</a> option</span>;</code></td><tdclass="doc"><p>type of ObjC accessor, if any</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="../IR/Procname/index.html#type-t">IR.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="../IR/Typ/index.html#type-t">IR.Typ.t</a>;</code></td><tdclass="doc"><p>return type</p></td></tr><trid="type-t.has_added_return_param"class="anchored"><tdclass="def field"><ahref="#type-t.has_added_return_param"class="anchor"></a><code>has_added_return_param : bool;</code></td><tdclass="doc"><p>whether or not a return param was added</p></td></tr><trid="type-t.is_ret_type_pod"class="anchored"><tdclass="def field"><ahref="#type-t.is_ret_type_pod"class="anchor"></a><code>is_ret_type_pod : bool;</code></td><tdclass="doc"><p>whether or not the return type is POD</p></td></tr><trid="type-t.is_ret_constexpr"class="anchored"><tdclass="def field"><ahref="#type-t.is_ret_constexpr"class="anchor"></a><code>is_ret_constexpr : bool;</code></td><tdclass="doc"><p>whether the (C++) function or method is declared as <code>constexpr</code></p></td></tr></table><code>}</code></dt></dl><dl><dtclass="spec value"id="val-default"><ahref="#val-default"class="anchor"></a><code><spanclass="keyword">val</span> default : <ahref="../IBase/SourceFile/index.html#type-t">IBase.SourceFile.t</a><span>-></span><ahref="../IR/Procname/index.html#type-t">IR.Procname.t</a><span>-></span><ahref="index.html#type-t">t</a></code></dt><dd><p>Create a proc_attributes with default values.</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><dtclass="spec value"id="val-get_access"><ahref="#val-get_access"class="anchor"></a><code><spanclass="keyword">val</span> get_access : <ahref="index.html#type-t">t</a><span>-></span><ahref="index.html#type-access">access</a></code></dt><dd><p>Return the visibility attribute</p></dd></dl><dl><dtclass="spec value"id="val-get_formals"><ahref="#val-get_formals"class="anchor"></a><code><spanclass="keyword">val</span> get_formals : <ahref="index.html#type-t">t</a><span>-></span><span><span>(<ahref="../IR/Mangled/index.html#type-t">IR.Mangled.t</a> * <ahref="../IR/Typ/index.html#type-t">IR.Typ.t</a>)</span> list</span></code></dt><dd><p>Return name and type of formal parameters</p></dd></dl><dl><dtclass="spec value"id="val-get_annotated_formals"><ahref="#val-get_annotated_formals"class="anchor"></a><code><spanclass="keyword">val</span> get_annotated_formals : <ahref="index.html#type-t">t</a><span>-></span><span><span>(<span>(<ahref="../IR/Mangled/index.html#type-t">IR.Mangled.t</a> * <ahref="../IR/Typ/index.html#type-t">IR.Typ.t</a>)</span> * <ahref="../IR/Annot/Item/index.html#type-t">IR.Annot.Item.t</a>)</span> list</span></code></dt><dtclass="spec value"id="val-get_loc"><ahref="#val-get_loc"class="anchor"></a><code><spanclass="keyword">val</span> get_loc : <ahref="index.html#type-t">t</a><span>-></span><ahref="../IBase/Location/index.html#type-t">IBase.Location.t</a></code></dt><dd><p>Return loc information for the procedure</p></dd></dl><dl><dtclass="spec value"id="val-get_proc_name"><ahref="#val-get_proc_name"class="anchor"></a><code><spanclass="keyword">val</span> get_proc_name : <ahref="index.html#type-t">t</a><span>-></span><ahref="../IR/Procname/index.html#type-t">IR.Procname.t</a></code></dt></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="../IBase/SqliteUtils/index.html#module-type-Data">IBase.SqliteUtils.Data</a><spanclass="keyword">with</span><spanclass="keyword">type</span><ahref="../IBase/SqliteUtils/module-type-Data/index.html#type-t">t</a> = <ahref="index.html#type-t">t</a></code></div></div></body></html>
