mkdocs/docs/api/visitor__generate_8h.html - iceberg-cpp - Git at Google

 <!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/util/visitor_generate.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_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_6a066966226cd78a6111c1015733de08.html">util</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
   <div class="summary">
 <a href="#namespaces">Namespaces</a> &#124;
 <a href="#define-members">Macros</a>  </div>
   <div class="headertitle"><div class="title">visitor_generate.h File Reference</div></div>
 </div><!--header-->
 <div class="contents">

 <p>Define macros for generating type visitors.
 <a href="#details">More...</a></p>

 <p><a href="visitor__generate_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="namespaces" name="namespaces"></a>
 Namespaces</h2></td></tr>
 <tr class="memitem:namespaceiceberg" id="r_namespaceiceberg"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html">iceberg</a></td></tr>
 <tr class="memdesc:namespaceiceberg"><td class="mdescLeft">&#160;</td><td class="mdescRight">Core Apache Iceberg C++ APIs. <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="define-members" name="define-members"></a>
 Macros</h2></td></tr>
 <tr class="memitem:a66510a25ffa1008cf6b9dd94a00f0c3d" id="r_a66510a25ffa1008cf6b9dd94a00f0c3d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="visitor__generate_8h.html#a66510a25ffa1008cf6b9dd94a00f0c3d">ICEBERG_GENERATE_FOR_ALL_TYPES</a>(ACTION)</td></tr>
 <tr class="separator:a66510a25ffa1008cf6b9dd94a00f0c3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a87238c645f18377242e3007d506d30f6" id="r_a87238c645f18377242e3007d506d30f6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="visitor__generate_8h.html#a87238c645f18377242e3007d506d30f6">ICEBERG_TYPE_SWITCH_WITH_PRIMITIVE_DEFAULT</a>(ACTION)</td></tr>
 <tr class="memdesc:a87238c645f18377242e3007d506d30f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate switch-case for schema visitor pattern.  <br /></td></tr>
 <tr class="separator:a87238c645f18377242e3007d506d30f6"><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>Define macros for generating type visitors. </p>
 </div><h2 class="groupheader">Macro Definition Documentation</h2>
 <a id="a66510a25ffa1008cf6b9dd94a00f0c3d" name="a66510a25ffa1008cf6b9dd94a00f0c3d"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a66510a25ffa1008cf6b9dd94a00f0c3d">&#9670;&#160;</a></span>ICEBERG_GENERATE_FOR_ALL_TYPES</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">#define ICEBERG_GENERATE_FOR_ALL_TYPES</td>
           <td>(</td>
           <td class="paramtype">&#160;</td>
           <td class="paramname">ACTION</td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">
 <b>Value:</b><div class="fragment"><div class="line">  ACTION(Boolean);                             \</div>
 <div class="line">  ACTION(Int);                                 \</div>
 <div class="line">  ACTION(Long);                                \</div>
 <div class="line">  ACTION(Float);                               \</div>
 <div class="line">  ACTION(Double);                              \</div>
 <div class="line">  ACTION(Decimal);                             \</div>
 <div class="line">  ACTION(Date);                                \</div>
 <div class="line">  ACTION(Time);                                \</div>
 <div class="line">  ACTION(Timestamp);                           \</div>
 <div class="line">  ACTION(TimestampTz);                         \</div>
 <div class="line">  ACTION(TimestampNs);                         \</div>
 <div class="line">  ACTION(TimestampTzNs);                       \</div>
 <div class="line">  ACTION(String);                              \</div>
 <div class="line">  ACTION(Uuid);                                \</div>
 <div class="line">  ACTION(Fixed);                               \</div>
 <div class="line">  ACTION(Binary);                              \</div>
 <div class="line">  ACTION(Unknown);                             \</div>
 <div class="line">  ACTION(Variant);                             \</div>
 <div class="line">  ACTION(Geometry);                            \</div>
 <div class="line">  ACTION(Geography);                           \</div>
 <div class="line">  ACTION(Struct);                              \</div>
 <div class="line">  ACTION(List);                                \</div>
 <div class="line">  ACTION(Map);</div>
 </div><!-- fragment -->
 </div>
 </div>
 <a id="a87238c645f18377242e3007d506d30f6" name="a87238c645f18377242e3007d506d30f6"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a87238c645f18377242e3007d506d30f6">&#9670;&#160;</a></span>ICEBERG_TYPE_SWITCH_WITH_PRIMITIVE_DEFAULT</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">#define ICEBERG_TYPE_SWITCH_WITH_PRIMITIVE_DEFAULT</td>
           <td>(</td>
           <td class="paramtype">&#160;</td>
           <td class="paramname">ACTION</td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">
 <b>Value:</b><div class="fragment"><div class="line">  case ::iceberg::TypeId::kStruct:                         \</div>
 <div class="line">    ACTION(Struct)                                         \</div>
 <div class="line">  case ::iceberg::TypeId::kList:                           \</div>
 <div class="line">    ACTION(List)                                           \</div>
 <div class="line">  case ::iceberg::TypeId::kMap:                            \</div>
 <div class="line">    ACTION(Map)                                            \</div>
 <div class="line">  case ::iceberg::TypeId::kVariant:                        \</div>
 <div class="line">    ACTION(Variant)                                        \</div>
 <div class="line">  <span class="keywordflow">default</span>:                                                 \</div>
 <div class="line">    ACTION(Primitive)</div>
 </div><!-- fragment -->
 <p>Generate switch-case for schema visitor pattern. </p>
 <p>This macro generates switch cases that dispatch to visitor methods based on type:</p><ul>
 <li>Struct types -&gt; calls ACTION with Struct</li>
 <li>List types -&gt; calls ACTION with List</li>
 <li>Map types -&gt; calls ACTION with Map</li>
 <li>Variant type -&gt; calls ACTION with Variant</li>
 <li>All primitive types (default) -&gt; calls ACTION with Primitive</li>
 </ul>
 <p>Variant is dispatched explicitly because it is neither a nested nor a primitive type, so it must not be routed into the primitive default (which would cast it to PrimitiveType). </p>

 </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>
	<!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/util/visitor_generate.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&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&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_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_6a066966226cd78a6111c1015733de08.html">util</a></li> </ul>
	</div>
	</div><!-- top -->
	<div class="header">
	<div class="summary">
	<a href="#namespaces">Namespaces</a> \|
	<a href="#define-members">Macros</a> </div>
	<div class="headertitle"><div class="title">visitor_generate.h File Reference</div></div>
	</div><!--header-->
	<div class="contents">

	<p>Define macros for generating type visitors.
	<a href="#details">More...</a></p>

	<p><a href="visitor__generate_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="namespaces" name="namespaces"></a>
	Namespaces</h2></td></tr>
	<tr class="memitem:namespaceiceberg" id="r_namespaceiceberg"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html">iceberg</a></td></tr>
	<tr class="memdesc:namespaceiceberg"><td class="mdescLeft"> </td><td class="mdescRight">Core Apache Iceberg C++ APIs. <br /></td></tr>
	<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
	</table><table class="memberdecls">
	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
	Macros</h2></td></tr>
	<tr class="memitem:a66510a25ffa1008cf6b9dd94a00f0c3d" id="r_a66510a25ffa1008cf6b9dd94a00f0c3d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="visitor__generate_8h.html#a66510a25ffa1008cf6b9dd94a00f0c3d">ICEBERG_GENERATE_FOR_ALL_TYPES</a>(ACTION)</td></tr>
	<tr class="separator:a66510a25ffa1008cf6b9dd94a00f0c3d"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a87238c645f18377242e3007d506d30f6" id="r_a87238c645f18377242e3007d506d30f6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="visitor__generate_8h.html#a87238c645f18377242e3007d506d30f6">ICEBERG_TYPE_SWITCH_WITH_PRIMITIVE_DEFAULT</a>(ACTION)</td></tr>
	<tr class="memdesc:a87238c645f18377242e3007d506d30f6"><td class="mdescLeft"> </td><td class="mdescRight">Generate switch-case for schema visitor pattern. <br /></td></tr>
	<tr class="separator:a87238c645f18377242e3007d506d30f6"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
	<div class="textblock"><p>Define macros for generating type visitors. </p>
	</div><h2 class="groupheader">Macro Definition Documentation</h2>
	<a id="a66510a25ffa1008cf6b9dd94a00f0c3d" name="a66510a25ffa1008cf6b9dd94a00f0c3d"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#a66510a25ffa1008cf6b9dd94a00f0c3d">◆ </a></span>ICEBERG_GENERATE_FOR_ALL_TYPES</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">#define ICEBERG_GENERATE_FOR_ALL_TYPES</td>
	<td>(</td>
	<td class="paramtype"> </td>
	<td class="paramname">ACTION</td><td>)</td>
	<td></td>
	</tr>
	</table>
	</div><div class="memdoc">
	<b>Value:</b><div class="fragment"><div class="line"> ACTION(Boolean); \</div>
	<div class="line"> ACTION(Int); \</div>
	<div class="line"> ACTION(Long); \</div>
	<div class="line"> ACTION(Float); \</div>
	<div class="line"> ACTION(Double); \</div>
	<div class="line"> ACTION(Decimal); \</div>
	<div class="line"> ACTION(Date); \</div>
	<div class="line"> ACTION(Time); \</div>
	<div class="line"> ACTION(Timestamp); \</div>
	<div class="line"> ACTION(TimestampTz); \</div>
	<div class="line"> ACTION(TimestampNs); \</div>
	<div class="line"> ACTION(TimestampTzNs); \</div>
	<div class="line"> ACTION(String); \</div>
	<div class="line"> ACTION(Uuid); \</div>
	<div class="line"> ACTION(Fixed); \</div>
	<div class="line"> ACTION(Binary); \</div>
	<div class="line"> ACTION(Unknown); \</div>
	<div class="line"> ACTION(Variant); \</div>
	<div class="line"> ACTION(Geometry); \</div>
	<div class="line"> ACTION(Geography); \</div>
	<div class="line"> ACTION(Struct); \</div>
	<div class="line"> ACTION(List); \</div>
	<div class="line"> ACTION(Map);</div>
	</div><!-- fragment -->
	</div>
	</div>
	<a id="a87238c645f18377242e3007d506d30f6" name="a87238c645f18377242e3007d506d30f6"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#a87238c645f18377242e3007d506d30f6">◆ </a></span>ICEBERG_TYPE_SWITCH_WITH_PRIMITIVE_DEFAULT</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">#define ICEBERG_TYPE_SWITCH_WITH_PRIMITIVE_DEFAULT</td>
	<td>(</td>
	<td class="paramtype"> </td>
	<td class="paramname">ACTION</td><td>)</td>
	<td></td>
	</tr>
	</table>
	</div><div class="memdoc">
	<b>Value:</b><div class="fragment"><div class="line"> case ::iceberg::TypeId::kStruct: \</div>
	<div class="line"> ACTION(Struct) \</div>
	<div class="line"> case ::iceberg::TypeId::kList: \</div>
	<div class="line"> ACTION(List) \</div>
	<div class="line"> case ::iceberg::TypeId::kMap: \</div>
	<div class="line"> ACTION(Map) \</div>
	<div class="line"> case ::iceberg::TypeId::kVariant: \</div>
	<div class="line"> ACTION(Variant) \</div>
	<div class="line"> <span class="keywordflow">default</span>: \</div>
	<div class="line"> ACTION(Primitive)</div>
	</div><!-- fragment -->
	<p>Generate switch-case for schema visitor pattern. </p>
	<p>This macro generates switch cases that dispatch to visitor methods based on type:</p><ul>
	<li>Struct types -> calls ACTION with Struct</li>
	<li>List types -> calls ACTION with List</li>
	<li>Map types -> calls ACTION with Map</li>
	<li>Variant type -> calls ACTION with Variant</li>
	<li>All primitive types (default) -> calls ACTION with Primitive</li>
	</ul>
	<p>Variant is dispatched explicitly because it is neither a nested nor a primitive type, so it must not be routed into the primitive default (which would cast it to PrimitiveType). </p>

	</div>
	</div>
	</div><!-- contents -->
	<!-- start footer part -->
	<hr class="footer"/><address class="footer"><small>
	Generated by <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>