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.
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>CContext (infer.ClangFrontend.CContext)</title><linkrel="stylesheet"href="../../../odoc.css"/><metacharset="utf-8"/><metaname="generator"content="odoc 1.5.2"/><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">ClangFrontend</a>» CContext</nav><h1>Module <code>ClangFrontend.CContext</code></h1></header><aside><p>Contains current class and current method to be translated as well as local variables, and the cfg, and tenv corresponding to the current file.</p></aside><divclass="spec module"id="module-StmtMap"><ahref="#module-StmtMap"class="anchor"></a><code><spanclass="keyword">module</span> StmtMap = <ahref="../ClangPointers/index.html#module-Map">ClangPointers.Map</a></code></div><dl><dtclass="spec type"id="type-curr_class"><ahref="#type-curr_class"class="anchor"></a><code><spanclass="keyword">type</span> curr_class</code><code> = </code><tableclass="variant"><trid="type-curr_class.ContextClsDeclPtr"class="anchored"><tdclass="def constructor"><ahref="#type-curr_class.ContextClsDeclPtr"class="anchor"></a><code>| </code><code><spanclass="constructor">ContextClsDeclPtr</span><spanclass="keyword">of</span> int</code></td></tr><trid="type-curr_class.ContextNoCls"class="anchored"><tdclass="def constructor"><ahref="#type-curr_class.ContextNoCls"class="anchor"></a><code>| </code><code><spanclass="constructor">ContextNoCls</span></code></td></tr></table></dt></dl><div><divclass="spec include"><divclass="doc"><dl><dtclass="spec value"id="val-compare_curr_class"><ahref="#val-compare_curr_class"class="anchor"></a><code><spanclass="keyword">val</span> compare_curr_class : <ahref="index.html#type-curr_class">curr_class</a><span>-></span><ahref="index.html#type-curr_class">curr_class</a><span>-></span> int</code></dt></dl></div></div></div><dl><dtclass="spec type"id="type-str_node_map"><ahref="#type-str_node_map"class="anchor"></a><code><spanclass="keyword">type</span> str_node_map</code><code> = <span><span>(string,<ahref="../../IR/Procdesc/Node/index.html#type-t">IR.Procdesc.Node.t</a>)</span><ahref="../../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.Caml.Hashtbl.t</span></code></dt><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.translation_unit_context"class="anchored"><tdclass="def field"><ahref="#type-t.translation_unit_context"class="anchor"></a><code>translation_unit_context : <ahref="../CFrontend_config/index.html#type-translation_unit_context">CFrontend_config.translation_unit_context</a>;</code></td></tr><trid="type-t.tenv"class="anchored"><tdclass="def field"><ahref="#type-t.tenv"class="anchor"></a><code>tenv : <ahref="../../IR/Tenv/index.html#type-t">IR.Tenv.t</a>;</code></td></tr><trid="type-t.cfg"class="anchored"><tdclass="def field"><ahref="#type-t.cfg"class="anchor"></a><code>cfg : <ahref="../../IR/Cfg/index.html#type-t">IR.Cfg.t</a>;</code></td></tr><trid="type-t.procdesc"class="anchored"><tdclass="def field"><ahref="#type-t.procdesc"class="anchor"></a><code>procdesc : <ahref="../../IR/Procdesc/index.html#type-t">IR.Procdesc.t</a>;</code></td></tr><trid="type-t.immediate_curr_class"class="anchored"><tdclass="def field"><ahref="#type-t.immediate_curr_class"class="anchor"></a><code>immediate_curr_class : <ahref="index.html#type-curr_class">curr_class</a>;</code></td></tr><trid="type-t.return_param_typ"class="anchored"><tdclass="def field"><ahref="#type-t.return_param_typ"class="anchor"></a><code>return_param_typ : <span><ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a> option</span>;</code></td></tr><trid="type-t.outer_context"class="anchored"><tdclass="def field"><ahref="#type-t.outer_context"class="anchor"></a><code>outer_context : <span><ahref="index.html#type-t">t</a> option</span>;</code></td><tdclass="doc"><p>in case of objc blocks, the context of the method containing the block</p></td></tr><trid="type-t.blocks_static_vars"class="anchored"><tdclass="def field"><ahref="#type-t.blocks_static_vars"class="anchor"></a><code><spanclass="keyword">mutable</span> blocks_static_vars : <span><span><span>(<ahref="../../IR/Pvar/index.html#type-t">IR.Pvar.t</a> * <ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a>)</span> list</span><ahref="../../IR__Procname/index.html#module-Map">IR.Procname.Map</a>.t</span>;</code></td></tr><trid="type-t.label_map"class="anchored"><tdclass="def field"><ahref="#type-t.label_map"class="anchor"></a><code>label_map : <ahref="index.html#type-str_node_map">str_node_map</a>;</code></td></tr><trid="type-t.vars_to_destroy"class="anchored"><tdclass="def field"><ahref="#type-t.vars_to_destroy"class="anchor"></a><code>vars_to_destroy : <span><span><ahref="../../ATDGenerated/Clang_ast_t/index.html#type-decl">ATDGenerated.Clang_ast_t.decl</a> list</span><ahref="../../ClangFrontend__ClangPointers/Map/index.html#type-t">StmtMap.t</a></span>;</code></td><tdclass="doc"><p>mapping from a statement to a list of variables, that go out of scope after the end of the statement</p></td></tr><trid="type-t.temporary_names"class="anchored"><tdclass="def field"><ahref="#type-t.temporary_names"class="anchor"></a><code>temporary_names : <span><span>(<ahref="../../ATDGenerated/Clang_ast_t/index.html#type-pointer">ATDGenerated.Clang_ast_t.pointer</a>,<ahref="../../IR/Pvar/index.html#type-t">IR.Pvar.t</a> * <ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a>)</span><ahref="../../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.Caml.Hashtbl.t</span>;</code></td></tr><trid="type-t.temporaries_constructor_markers"class="anchored"><tdclass="def field"><ahref="#type-t.temporaries_constructor_markers"class="anchor"></a><code>temporaries_constructor_markers : <span><span>(<ahref="../../IR/Pvar/index.html#type-t">IR.Pvar.t</a> * <ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a>)</span><ahref="../../IR__Exp/index.html#module-Map">IR.Exp.Map</a>.t</span>;</code></td><tdclass="doc"><p>In order to know when to destruct C++ temporaries created in expressions containing conditionals (e.g. to hold the object created by <code>X()</code> in <code>b?foo(X()):goo()</code>), we associate "markers" to each one of them, set to true if and only if the temporary has been created. This is the map associating each such C++ temporary with its marker variable.</p></td></tr></table><code>}</code></dt></dl><dl><dtclass="spec value"id="val-get_curr_class"><ahref="#val-get_curr_class"class="anchor"></a><code><spanclass="keyword">val</span> get_curr_class : <ahref="index.html#type-t">t</a><span>-></span><ahref="index.html#type-curr_class">curr_class</a></code></dt><dtclass="spec value"id="val-get_curr_class_typename"><ahref="#val-get_curr_class_typename"class="anchor"></a><code><spanclass="keyword">val</span> get_curr_class_typename : <ahref="../../ATDGenerated/Clang_ast_t/index.html#type-stmt_info">ATDGenerated.Clang_ast_t.stmt_info</a><span>-></span><ahref="index.html#type-t">t</a><span>-></span><ahref="../../IR/Typ/Name/index.html#type-t">IR.Typ.Name.t</a></code></dt><dtclass="spec value"id="val-get_curr_class_decl_ptr"><ahref="#val-get_curr_class_decl_ptr"class="anchor"></a><code><spanclass="keyword">val</span> get_curr_class_decl_ptr : <ahref="../../ATDGenerated/Clang_ast_t/index.html#type-stmt_info">ATDGenerated.Clang_ast_t.stmt_info</a><span>-></span><ahref="index.html#type-curr_class">curr_class</a><span>-></span><ahref="../../ATDGenerated/Clang_ast_t/index.html#type-pointer">ATDGenerated.Clang_ast_t.pointer</a></code></dt><dtclass="spec value"id="val-is_objc_method"><ahref="#val-is_objc_method"class="anchor"></a><code><spanclass="keyword">val</span> is_objc_method : <ahref="index.html#type-t">t</a><span>-></span> bool</code></dt><dtclass="spec value"id="val-is_objc_class_method"><ahref="#val-is_objc_class_method"class="anchor"></a><code><spanclass="keyword">val</span> is_objc_class_method : <ahref="index.html#type-t">t</a><span>-></span> bool</code></dt><dtclass="spec value"id="val-create_context"><ahref="#val-create_context"class="anchor"></a><code><spanclass="keyword">val</span> create_context : <ahref="../CFrontend_config/index.html#type-translation_unit_context">CFrontend_config.translation_unit_context</a><span>-></span><ahref="../../IR/Tenv/index.html#type-t">IR.Tenv.t</a><span>-></span><ahref="../../IR/Cfg/index.html#type-t">IR.Cfg.t</a><span>-></span><ahref="../../IR/Procdesc/index.html#type-t">IR.Procdesc.t</a><span>-></span><ahref="index.html#type-curr_class">curr_class</a><span>-></span><span><ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a> option</span><span>-></span><span><ahref="index.html#type-t">t</a> option</span><span>-></span><span><span><ahref="../../ATDGenerated/Clang_ast_t/index.html#type-decl">ATDGenerated.Clang_ast_t.decl</a> list</span><ahref="../../ClangFrontend__ClangPointers/Map/index.html#type-t">StmtMap.t</a></span><span>-></span><ahref="index.html#type-t">t</a></code></dt><dtclass="spec value"id="val-add_block_static_var"><ahref="#val-add_block_static_var"class="anchor"></a><code><spanclass="keyword">val</span> add_block_static_var : <ahref="index.html#type-t">t</a><span>-></span><ahref="../../IR/Procname/index.html#type-t">IR.Procname.t</a><span>-></span><span>(<ahref="../../IR/Pvar/index.html#type-t">IR.Pvar.t</a> * <ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a>)</span><span>-></span> unit</code></dt><dtclass="spec value"id="val-get_outer_procname"><ahref="#val-get_outer_procname"class="anchor"></a><code><spanclass="keyword">val</span> get_outer_procname : <ahref="index.html#type-t">t</a><span>-></span><ahref="../../IR/Procname/index.html#type-t">IR.Procname.t</a></code></dt></dl></div></body></html>
