comms_doc/Assert_8h.html at master · commschamp/comms_doc · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
<!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>COMMS: include/comms/Assert.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">COMMS
   </div>
   <div id="projectbrief">Template library intended to help with implementation of communication protocols.</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b3b90260015bf389bbf56758f180cfb9.html">comms</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle"><div class="title">Assert.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>This file contains classes required for generic custom assertion functionality.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;cassert&gt;</code><br />
<code>#include &lt;type_traits&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
</div>
<p><a href="Assert_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="classcomms_1_1Assert.html">comms::Assert</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base class for any custom assertion behaviour.  <a href="classcomms_1_1Assert.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="classcomms_1_1EnableAssert.html">comms::EnableAssert&lt; TAssert &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable new assertion behaviour.  <a href="classcomms_1_1EnableAssert.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="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacecomms" id="r_namespacecomms"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecomms.html">comms</a></td></tr>
<tr class="memdesc:namespacecomms"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main namespace for all classes / functions of COMMS library. <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:a941aec86290602caa61d86b671aea550" id="r_a941aec86290602caa61d86b671aea550"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Assert_8h.html#a941aec86290602caa61d86b671aea550">COMMS_ASSERT</a>(expr)</td></tr>
<tr class="memdesc:a941aec86290602caa61d86b671aea550"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic assert macro.  <br /></td></tr>
<tr class="separator:a941aec86290602caa61d86b671aea550"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9835d74469ee1f6f50d14e1d770e93fb" id="r_a9835d74469ee1f6f50d14e1d770e93fb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Assert_8h.html#a9835d74469ee1f6f50d14e1d770e93fb">GASSERT</a>(expr)&#160;&#160;&#160;<a class="el" href="Assert_8h.html#a941aec86290602caa61d86b671aea550">COMMS_ASSERT</a>(expr)</td></tr>
<tr class="memdesc:a9835d74469ee1f6f50d14e1d770e93fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <a class="el" href="Assert_8h.html#a941aec86290602caa61d86b671aea550">COMMS_ASSERT</a>.  <br /></td></tr>
<tr class="separator:a9835d74469ee1f6f50d14e1d770e93fb"><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>This file contains classes required for generic custom assertion functionality. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a941aec86290602caa61d86b671aea550" name="a941aec86290602caa61d86b671aea550"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a941aec86290602caa61d86b671aea550">&#9670;&#160;</a></span>COMMS_ASSERT</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define COMMS_ASSERT</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">    ((expr)                               \</div>
<div class="line">      ? <span class="keyword">static_cast&lt;</span><span class="keywordtype">void</span><span class="keyword">&gt;</span>(0)                     \</div>
<div class="line">      : (comms::AssertManager::instance().hasAssertRegistered() \</div>
<div class="line">            ? comms::AssertManager::instance().getAssert()-&gt;fail( \</div>
<div class="line">                #expr, __FILE__, __LINE__, COMMS_ASSERT_FUNCTION_STR) \</div>
<div class="line">            : COMMS_ASSERT_FAIL_FUNC(expr)))</div>
</div><!-- fragment -->
<p>Generic assert macro. </p>
<p>Will use custom assertion failure behaviour if such is defined, otherwise it will use standard "assert()" macro. In case COMMS_NOSTDLIB is defined and no custom assertion failure was enabled, infinite loop will be executed. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">expr</td><td>Boolean expression </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a9835d74469ee1f6f50d14e1d770e93fb" name="a9835d74469ee1f6f50d14e1d770e93fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9835d74469ee1f6f50d14e1d770e93fb">&#9670;&#160;</a></span>GASSERT</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GASSERT</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">expr</td><td>)</td>
          <td>&#160;&#160;&#160;<a class="el" href="Assert_8h.html#a941aec86290602caa61d86b671aea550">COMMS_ASSERT</a>(expr)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Same as <a class="el" href="Assert_8h.html#a941aec86290602caa61d86b671aea550">COMMS_ASSERT</a>. </p>
<p>Kept for backward compatibility of already written protocols. </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>