blob: 6c36964df1c6439de93dd2871a15a134c33390b6 [file]
<!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/macros.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="#define-members">Macros</a> </div>
<div class="headertitle"><div class="title">macros.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Define common Iceberg utility macros.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;cassert&gt;</code><br />
<code>#include &quot;<a class="el" href="exception_8h_source.html">iceberg/exception.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="result_8h_source.html">iceberg/result.h</a>&quot;</code><br />
</div>
<p><a href="macros_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="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a26e595017382df7c971e5a27376a7b76" id="r_a26e595017382df7c971e5a27376a7b76"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8h.html#a26e595017382df7c971e5a27376a7b76">ICEBERG_RETURN_UNEXPECTED</a>(expr)</td></tr>
<tr class="separator:a26e595017382df7c971e5a27376a7b76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11505e1997a372d8e512ea5f712f557d" id="r_a11505e1997a372d8e512ea5f712f557d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8h.html#a11505e1997a372d8e512ea5f712f557d">ICEBERG_ASSIGN_OR_RAISE_IMPL</a>(result_name, lhs, rexpr)</td></tr>
<tr class="separator:a11505e1997a372d8e512ea5f712f557d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6de4873866caa5d256ab7a591af5d00" id="r_af6de4873866caa5d256ab7a591af5d00"><td class="memItemLeft" align="right" valign="top"><a id="af6de4873866caa5d256ab7a591af5d00" name="af6de4873866caa5d256ab7a591af5d00"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>ICEBERG_CONCAT</b>(x, y)&#160;&#160;&#160;x##y</td></tr>
<tr class="separator:af6de4873866caa5d256ab7a591af5d00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbadbdd6b6291ab37ab8123cbaa6dbfa" id="r_abbadbdd6b6291ab37ab8123cbaa6dbfa"><td class="memItemLeft" align="right" valign="top"><a id="abbadbdd6b6291ab37ab8123cbaa6dbfa" name="abbadbdd6b6291ab37ab8123cbaa6dbfa"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>ICEBERG_ASSIGN_OR_RAISE_NAME</b>(x, y)&#160;&#160;&#160;ICEBERG_CONCAT(x, y)</td></tr>
<tr class="separator:abbadbdd6b6291ab37ab8123cbaa6dbfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7761a99326d87edbbf3bca9b674fd23" id="r_ad7761a99326d87edbbf3bca9b674fd23"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8h.html#ad7761a99326d87edbbf3bca9b674fd23">ICEBERG_ASSIGN_OR_RAISE</a>(lhs, rexpr)</td></tr>
<tr class="separator:ad7761a99326d87edbbf3bca9b674fd23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c7c6e6653dde54c00b74ca777dae161" id="r_a0c7c6e6653dde54c00b74ca777dae161"><td class="memItemLeft" align="right" valign="top"><a id="a0c7c6e6653dde54c00b74ca777dae161" name="a0c7c6e6653dde54c00b74ca777dae161"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>ICEBERG_DCHECK</b>(expr, message)&#160;&#160;&#160;assert((expr) &amp;&amp; (message))</td></tr>
<tr class="separator:a0c7c6e6653dde54c00b74ca777dae161"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ac46a9babaee877fe8a7df9b0f368ab" id="r_a8ac46a9babaee877fe8a7df9b0f368ab"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8h.html#a8ac46a9babaee877fe8a7df9b0f368ab">ICEBERG_PRECHECK</a>(expr, ...)</td></tr>
<tr class="separator:a8ac46a9babaee877fe8a7df9b0f368ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca27c0fca8af389ba9f7d8a56e1c50e4" id="r_aca27c0fca8af389ba9f7d8a56e1c50e4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8h.html#aca27c0fca8af389ba9f7d8a56e1c50e4">ICEBERG_CHECK</a>(expr, ...)</td></tr>
<tr class="separator:aca27c0fca8af389ba9f7d8a56e1c50e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68009a0a865589affe8b95d44c296e45" id="r_a68009a0a865589affe8b95d44c296e45"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8h.html#a68009a0a865589affe8b95d44c296e45">ERROR_TO_EXCEPTION</a>(error)</td></tr>
<tr class="separator:a68009a0a865589affe8b95d44c296e45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e0f7828028d171fdd95f9deafd4bd09" id="r_a1e0f7828028d171fdd95f9deafd4bd09"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8h.html#a1e0f7828028d171fdd95f9deafd4bd09">ICEBERG_THROW_NOT_OK</a>(expr)</td></tr>
<tr class="separator:a1e0f7828028d171fdd95f9deafd4bd09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a310212e938f922350935a535810e11d5" id="r_a310212e938f922350935a535810e11d5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8h.html#a310212e938f922350935a535810e11d5">ICEBERG_ASSIGN_OR_THROW_IMPL</a>(result_name, lhs, rexpr)</td></tr>
<tr class="separator:a310212e938f922350935a535810e11d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8366ae31bcf87453fdb9e7833db27fbc" id="r_a8366ae31bcf87453fdb9e7833db27fbc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8h.html#a8366ae31bcf87453fdb9e7833db27fbc">ICEBERG_ASSIGN_OR_THROW</a>(lhs, rexpr)</td></tr>
<tr class="separator:a8366ae31bcf87453fdb9e7833db27fbc"><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 common Iceberg utility macros. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a68009a0a865589affe8b95d44c296e45" name="a68009a0a865589affe8b95d44c296e45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68009a0a865589affe8b95d44c296e45">&#9670;&#160;</a></span>ERROR_TO_EXCEPTION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ERROR_TO_EXCEPTION</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">error</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">if</span> (error.kind == iceberg::ErrorKind::kInvalidExpression) { \</div>
<div class="line"> <span class="keywordflow">throw</span> <a class="code hl_class" href="classiceberg_1_1ExpressionError.html">iceberg::ExpressionError</a>(error.message); \</div>
<div class="line"> } <span class="keywordflow">else</span> { \</div>
<div class="line"> <span class="keywordflow">throw</span> <a class="code hl_class" href="classiceberg_1_1IcebergError.html">iceberg::IcebergError</a>(error.message); \</div>
<div class="line"> }</div>
<div class="ttc" id="aclassiceberg_1_1ExpressionError_html"><div class="ttname"><a href="classiceberg_1_1ExpressionError.html">iceberg::ExpressionError</a></div><div class="ttdoc">Exception thrown when expression construction fails.</div><div class="ttdef"><b>Definition</b> exception.h:42</div></div>
<div class="ttc" id="aclassiceberg_1_1IcebergError_html"><div class="ttname"><a href="classiceberg_1_1IcebergError.html">iceberg::IcebergError</a></div><div class="ttdoc">Base exception class for exceptions thrown by the Iceberg library.</div><div class="ttdef"><b>Definition</b> exception.h:36</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="ad7761a99326d87edbbf3bca9b674fd23" name="ad7761a99326d87edbbf3bca9b674fd23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7761a99326d87edbbf3bca9b674fd23">&#9670;&#160;</a></span>ICEBERG_ASSIGN_OR_RAISE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ICEBERG_ASSIGN_OR_RAISE</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">lhs, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">rexpr&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> ICEBERG_ASSIGN_OR_RAISE_IMPL(ICEBERG_ASSIGN_OR_RAISE_NAME(result_, __COUNTER__), lhs, \</div>
<div class="line"> rexpr)</div>
</div><!-- fragment -->
</div>
</div>
<a id="a11505e1997a372d8e512ea5f712f557d" name="a11505e1997a372d8e512ea5f712f557d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11505e1997a372d8e512ea5f712f557d">&#9670;&#160;</a></span>ICEBERG_ASSIGN_OR_RAISE_IMPL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ICEBERG_ASSIGN_OR_RAISE_IMPL</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">result_name, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">lhs, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">rexpr&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keyword">auto</span>&amp;&amp; result_name = (rexpr); \</div>
<div class="line"> ICEBERG_RETURN_UNEXPECTED(result_name) \</div>
<div class="line"> lhs = std::move(result_name.value());</div>
</div><!-- fragment -->
</div>
</div>
<a id="a8366ae31bcf87453fdb9e7833db27fbc" name="a8366ae31bcf87453fdb9e7833db27fbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8366ae31bcf87453fdb9e7833db27fbc">&#9670;&#160;</a></span>ICEBERG_ASSIGN_OR_THROW</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ICEBERG_ASSIGN_OR_THROW</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">lhs, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">rexpr&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> ICEBERG_ASSIGN_OR_THROW_IMPL( \</div>
<div class="line"> ICEBERG_ASSIGN_OR_RAISE_NAME(_error_or_value, __COUNTER__), lhs, rexpr);</div>
</div><!-- fragment -->
</div>
</div>
<a id="a310212e938f922350935a535810e11d5" name="a310212e938f922350935a535810e11d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a310212e938f922350935a535810e11d5">&#9670;&#160;</a></span>ICEBERG_ASSIGN_OR_THROW_IMPL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ICEBERG_ASSIGN_OR_THROW_IMPL</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">result_name, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">lhs, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">rexpr&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keyword">auto</span>&amp;&amp; result_name = (rexpr); \</div>
<div class="line"> ICEBERG_THROW_NOT_OK(result_name); \</div>
<div class="line"> lhs = std::move(result_name.value());</div>
</div><!-- fragment -->
</div>
</div>
<a id="aca27c0fca8af389ba9f7d8a56e1c50e4" name="aca27c0fca8af389ba9f7d8a56e1c50e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca27c0fca8af389ba9f7d8a56e1c50e4">&#9670;&#160;</a></span>ICEBERG_CHECK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ICEBERG_CHECK</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">expr, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
<div class="line"> if (!(expr)) [[unlikely]] { \</div>
<div class="line"> <span class="keywordflow">return</span> ValidationFailed(__VA_ARGS__); \</div>
<div class="line"> } \</div>
<div class="line"> } <span class="keywordflow">while</span> (0)</div>
</div><!-- fragment -->
</div>
</div>
<a id="a8ac46a9babaee877fe8a7df9b0f368ab" name="a8ac46a9babaee877fe8a7df9b0f368ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ac46a9babaee877fe8a7df9b0f368ab">&#9670;&#160;</a></span>ICEBERG_PRECHECK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ICEBERG_PRECHECK</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">expr, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
<div class="line"> if (!(expr)) [[unlikely]] { \</div>
<div class="line"> <span class="keywordflow">return</span> InvalidArgument(__VA_ARGS__); \</div>
<div class="line"> } \</div>
<div class="line"> } <span class="keywordflow">while</span> (0)</div>
</div><!-- fragment -->
</div>
</div>
<a id="a26e595017382df7c971e5a27376a7b76" name="a26e595017382df7c971e5a27376a7b76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26e595017382df7c971e5a27376a7b76">&#9670;&#160;</a></span>ICEBERG_RETURN_UNEXPECTED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ICEBERG_RETURN_UNEXPECTED</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">expr</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">if</span> (<span class="keyword">auto</span>&amp;&amp; result_name = expr; !result_name) [[unlikely]] { \</div>
<div class="line"> <span class="keywordflow">return</span> std::unexpected&lt;Error&gt;(result_name.error()); \</div>
<div class="line"> }</div>
</div><!-- fragment -->
</div>
</div>
<a id="a1e0f7828028d171fdd95f9deafd4bd09" name="a1e0f7828028d171fdd95f9deafd4bd09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e0f7828028d171fdd95f9deafd4bd09">&#9670;&#160;</a></span>ICEBERG_THROW_NOT_OK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ICEBERG_THROW_NOT_OK</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">expr</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">if</span> (<span class="keyword">auto</span>&amp;&amp; result_name = expr; !result_name) [[unlikely]] { \</div>
<div class="line"> ERROR_TO_EXCEPTION(result_name.error()); \</div>
<div class="line"> }</div>
</div><!-- fragment -->
</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>