Google Git
Sign in
apache / impala / asf-site / . / doc / html / classimpala_1_1SymbolsUtil.html
blob: d2371fbeca4bd914dffd9b59fffcc28a50008fdb [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Impala: impala::SymbolsUtil Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Impala
</div>
<div id="projectbrief">Impalaistheopensource,nativeanalyticdatabaseforApacheHadoop.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classimpala_1_1SymbolsUtil.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classimpala_1_1SymbolsUtil-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">impala::SymbolsUtil Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Utility class to manipulate c++/IR symbols, mangling and demangling names.
<a href="classimpala_1_1SymbolsUtil.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="symbols-util_8h_source.html">symbols-util.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for impala::SymbolsUtil:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classimpala_1_1SymbolsUtil__coll__graph.svg" width="238" height="147"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a84139b9a49bf9800d785b7828c25b8e1"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classbool.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1SymbolsUtil.html#a84139b9a49bf9800d785b7828c25b8e1">IsMangled</a> (const std::string &amp;symbol)</td></tr>
<tr class="memdesc:a84139b9a49bf9800d785b7828c25b8e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if this symbol is mangled. <a href="#a84139b9a49bf9800d785b7828c25b8e1">More...</a><br/></td></tr>
<tr class="separator:a84139b9a49bf9800d785b7828c25b8e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a51c09589e88e59a4e30c214c7772c3"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1SymbolsUtil.html#a4a51c09589e88e59a4e30c214c7772c3">Demangle</a> (const std::string &amp;<a class="el" href="namespaceimpala.html#aaebb9aadfa9e5aec064bc26565df06d3">name</a>)</td></tr>
<tr class="separator:a4a51c09589e88e59a4e30c214c7772c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab73bb3194956269eda00003eefc259a3"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1SymbolsUtil.html#ab73bb3194956269eda00003eefc259a3">DemangleNameOnly</a> (const std::string &amp;symbol)</td></tr>
<tr class="separator:ab73bb3194956269eda00003eefc259a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6be90a6b4c20a0c79d6e8e9faaf9136"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1SymbolsUtil.html#ad6be90a6b4c20a0c79d6e8e9faaf9136">MangleUserFunction</a> (const std::string &amp;fn_name, const std::vector&lt; <a class="el" href="structimpala_1_1ColumnType.html">ColumnType</a> &gt; &amp;arg_types, <a class="el" href="classbool.html">bool</a> has_var_args=false, <a class="el" href="structimpala_1_1ColumnType.html">ColumnType</a> *ret_argument=NULL)</td></tr>
<tr class="separator:ad6be90a6b4c20a0c79d6e8e9faaf9136"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5859d2711308fe340d9f7583008e9603"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1SymbolsUtil.html#a5859d2711308fe340d9f7583008e9603">ManglePrepareOrCloseFunction</a> (const std::string &amp;fn_name)</td></tr>
<tr class="separator:a5859d2711308fe340d9f7583008e9603"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Utility class to manipulate c++/IR symbols, mangling and demangling names. </p>
<p>Definition at line <a class="el" href="symbols-util_8h_source.html#l00024">24</a> of file <a class="el" href="symbols-util_8h_source.html">symbols-util.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4a51c09589e88e59a4e30c214c7772c3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string SymbolsUtil::Demangle </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the demangled string. The name is assumed to be a mangled string using the gcc/llvm convention. Returns the empty string if the name is not valid. </p>
<p>Definition at line <a class="el" href="symbols-util_8cc_source.html#l00057">57</a> of file <a class="el" href="symbols-util_8cc_source.html">symbols-util.cc</a>.</p>
<p>Referenced by <a class="el" href="symbols-util_8cc_source.html#l00066">DemangleNameOnly()</a>, <a class="el" href="symbols-util-test_8cc_source.html#l00027">impala::TestDemangling()</a>, <a class="el" href="symbols-util-test_8cc_source.html#l00039">impala::TestMangling()</a>, and <a class="el" href="symbols-util-test_8cc_source.html#l00051">impala::TestManglingPrepareOrClose()</a>.</p>
</div>
</div>
<a class="anchor" id="ab73bb3194956269eda00003eefc259a3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string SymbolsUtil::DemangleNameOnly </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>symbol</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the function name of the demangled symbol (i.e., it strips the arguments and any namespace/class qualifiers). Returns the empty string if the name is not valid. </p>
<p>Definition at line <a class="el" href="symbols-util_8cc_source.html#l00066">66</a> of file <a class="el" href="symbols-util_8cc_source.html">symbols-util.cc</a>.</p>
<p>References <a class="el" href="symbols-util_8cc_source.html#l00057">Demangle()</a>, and <a class="el" href="gen__ir__descriptions_8py_source.html#l00219">gen_ir_descriptions::fn_name</a>.</p>
<p>Referenced by <a class="el" href="scalar-fn-call_8cc_source.html#l00243">impala::ScalarFnCall::GetCodegendComputeFn()</a>, and <a class="el" href="symbols-util-test_8cc_source.html#l00032">impala::TestDemanglingNameOnly()</a>.</p>
</div>
</div>
<a class="anchor" id="a84139b9a49bf9800d785b7828c25b8e1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbool.html">bool</a> SymbolsUtil::IsMangled </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>symbol</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if this symbol is mangled. </p>
<p>Definition at line <a class="el" href="symbols-util_8cc_source.html#l00053">53</a> of file <a class="el" href="symbols-util_8cc_source.html">symbols-util.cc</a>.</p>
<p>References <a class="el" href="symbols-util_8cc_source.html#l00051">MANGLE_PREFIX</a>.</p>
<p>Referenced by <a class="el" href="fe-support_8cc_source.html#l00131">ResolveSymbolLookup()</a>.</p>
</div>
</div>
<a class="anchor" id="a5859d2711308fe340d9f7583008e9603"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string SymbolsUtil::ManglePrepareOrCloseFunction </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>fn_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Mangles fn_name assuming arguments (<a class="el" href="classimpala__udf_1_1FunctionContext.html">impala_udf::FunctionContext</a>*, <a class="el" href="classimpala__udf_1_1FunctionContext.html#a1e9662a1bbb78daa9923b47412347ffc">impala_udf::FunctionContext::FunctionStateScope</a>). </p>
<p>Definition at line <a class="el" href="symbols-util_8cc_source.html#l00236">236</a> of file <a class="el" href="symbols-util_8cc_source.html">symbols-util.cc</a>.</p>
<p>References <a class="el" href="symbols-util_8cc_source.html#l00077">AppendMangledToken()</a>, and <a class="el" href="symbols-util_8cc_source.html#l00051">MANGLE_PREFIX</a>.</p>
<p>Referenced by <a class="el" href="fe-support_8cc_source.html#l00131">ResolveSymbolLookup()</a>, and <a class="el" href="symbols-util-test_8cc_source.html#l00051">impala::TestManglingPrepareOrClose()</a>.</p>
</div>
</div>
<a class="anchor" id="ad6be90a6b4c20a0c79d6e8e9faaf9136"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string SymbolsUtil::MangleUserFunction </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>fn_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; <a class="el" href="structimpala_1_1ColumnType.html">ColumnType</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>arg_types</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classbool.html">bool</a>&#160;</td>
<td class="paramname"><em>has_var_args</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structimpala_1_1ColumnType.html">ColumnType</a> *&#160;</td>
<td class="paramname"><em>ret_argument</em> = <code>NULL</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Mangles fn_name with 'arg_types' to the function signature for user functions. This maps types to AnyVal* and automatically adds the FunctionContext* as the first argument. The fn_name must be fully qualified. i.e namespace::class::fn. if 'has_var_args' is true, the last argument in arg_types can be variable. if 'ret_argument' is non-null, it is added as a last return argument. TODO: this is not a general mangling function and that is more difficult to do. Find a library to do this. There is no place we require this to be perfect, if we can't do this right, the user will need to specify the full mangled string. </p>
<p>Definition at line <a class="el" href="symbols-util_8cc_source.html#l00154">154</a> of file <a class="el" href="symbols-util_8cc_source.html">symbols-util.cc</a>.</p>
<p>References <a class="el" href="symbols-util_8cc_source.html#l00109">AppendAnyValType()</a>, <a class="el" href="symbols-util_8cc_source.html#l00077">AppendMangledToken()</a>, <a class="el" href="symbols-util_8cc_source.html#l00088">AppendSeqId()</a>, <a class="el" href="symbols-util_8cc_source.html#l00051">MANGLE_PREFIX</a>, and <a class="el" href="types_8h_source.html#l00060">impala::ColumnType::type</a>.</p>
<p>Referenced by <a class="el" href="fe-support_8cc_source.html#l00131">ResolveSymbolLookup()</a>, and <a class="el" href="symbols-util-test_8cc_source.html#l00039">impala::TestMangling()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>be/src/util/<a class="el" href="symbols-util_8h_source.html">symbols-util.h</a></li>
<li>be/src/util/<a class="el" href="symbols-util_8cc_source.html">symbols-util.cc</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceimpala.html">impala</a></li><li class="navelem"><a class="el" href="classimpala_1_1SymbolsUtil.html">SymbolsUtil</a></li>
<li class="footer">Generated on Thu May 7 2015 16:10:50 for Impala by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>