blob: c5c0b04c2b922fb379d7203ca4a83eeabecb1a49 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iceberg-cpp: iceberg/expression/expression_visitor.h File 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectrow">
<td id="projectalign">
<div id="projectname">iceberg-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_f51fe74ea6bc2b1b900619895eaa63be.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_832d158f51fdfd219125f1a0f5099b44.html">expression</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">expression_visitor.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;concepts&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &lt;typeinfo&gt;</code><br />
<code>#include &quot;<a class="el" href="aggregate_8h_source.html">iceberg/expression/aggregate.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="expression_8h_source.html">iceberg/expression/expression.h</a>&quot;</code><br />
<code>#include &quot;iceberg/expression/literal.h&quot;</code><br />
<code>#include &quot;<a class="el" href="predicate_8h_source.html">iceberg/expression/predicate.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="term_8h_source.html">iceberg/expression/term.h</a>&quot;</code><br />
<code>#include &quot;iceberg/iceberg_export.h&quot;</code><br />
<code>#include &quot;iceberg/result.h&quot;</code><br />
<code>#include &quot;<a class="el" href="checked__cast_8h_source.html">iceberg/util/checked_cast.h</a>&quot;</code><br />
<code>#include &quot;iceberg/util/macros.h&quot;</code><br />
</div>
<p><a href="expression__visitor_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ExpressionVisitor.html">iceberg::ExpressionVisitor&lt; R &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base visitor for traversing expression trees. <a href="classiceberg_1_1ExpressionVisitor.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1BoundVisitor.html">iceberg::BoundVisitor&lt; R &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Visitor for bound expressions. <a href="classiceberg_1_1BoundVisitor.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:adfd2545dd2069fa4ab5d30ea46813edc" id="r_adfd2545dd2069fa4ab5d30ea46813edc"><td class="memTemplParams" colspan="2">template&lt;typename R , typename V &gt; <br />
requires std::derived_from&lt;V, <a class="el" href="classiceberg_1_1ExpressionVisitor.html">ExpressionVisitor</a>&lt;R&gt;&gt;</td></tr>
<tr class="memitem:adfd2545dd2069fa4ab5d30ea46813edc"><td class="memTemplItemLeft" align="right" valign="top">Result&lt; R &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="expression__visitor_8h.html#adfd2545dd2069fa4ab5d30ea46813edc">iceberg::Visit</a> (const std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Expression.html">Expression</a> &gt; &amp;expr, V &amp;visitor)</td></tr>
<tr class="memdesc:adfd2545dd2069fa4ab5d30ea46813edc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Traverse an expression tree with a visitor. <br /></td></tr>
<tr class="separator:adfd2545dd2069fa4ab5d30ea46813edc"><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>Visitor pattern implementation for traversing Iceberg expression trees. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="adfd2545dd2069fa4ab5d30ea46813edc" name="adfd2545dd2069fa4ab5d30ea46813edc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfd2545dd2069fa4ab5d30ea46813edc">&#9670;&#160;</a></span>Visit()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename R , typename V &gt; <br />
requires std::derived_from&lt;V, ExpressionVisitor&lt;R&gt;&gt;</div>
<table class="memname">
<tr>
<td class="memname">Result&lt; R &gt; iceberg::Visit </td>
<td>(</td>
<td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Expression.html">Expression</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>expr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">V &amp;&#160;</td>
<td class="paramname"><em>visitor</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Traverse an expression tree with a visitor. </p>
<p>This function traverses the given expression tree in postorder traversal and calls appropriate visitor methods for each node. Results from child nodes are passed to parent nodes.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">R</td><td>The return type produced by the visitor </td></tr>
<tr><td class="paramname">V</td><td>The visitor type (must derive from ExpressionVisitor&lt;R&gt;) </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">expr</td><td>The expression to traverse </td></tr>
<tr><td class="paramname">visitor</td><td>The visitor to use for traversal </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The result produced by the visitor for the root expression node </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>