forked from boostorg/preprocessor
57 lines
1.6 KiB
HTML
57 lines
1.6 KiB
HTML
|
<html>
|
||
|
|
<head>
|
||
|
|
<title>BOOST_PP_ASSERT_MSG</title>
|
||
|
|
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||
|
|
<script language="javascript" type="text/javascript" src="../scripts.js"></script>
|
||
|
|
</head>
|
||
|
|
<body onload="init('sample');">
|
||
|
|
<div style="margin-left: 0px;">
|
||
|
|
The <b>BOOST_PP_ASSERT_MSG</b> macro conditionally inserts debugging text.
|
||
|
|
</div>
|
||
|
|
<h4>Usage</h4>
|
||
|
|
<div class="code">
|
||
|
|
<b>BOOST_PP_ASSERT_MSG</b>(<i>cond</i>, <i>msg</i>)
|
||
|
|
</div>
|
||
|
|
<h4>Arguments</h4>
|
||
|
|
<dl>
|
||
|
|
<dt>cond</dt>
|
||
|
|
<dd>
|
||
|
|
A condition that determines whether an assertion occurs.
|
||
|
|
Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
|
||
|
|
</dd>
|
||
|
|
<dt>msg</dt>
|
||
|
|
<dd>
|
||
|
|
A message to display if <i>cond</i> evaluates to <i>0</i>.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<h4>Remarks</h4>
|
||
|
|
<div>
|
||
|
|
If <i>cond</i> expands to <i>0</i>, this macro expands to <i>msg</i>.
|
||
|
|
Otherwise, it expands to nothing.
|
||
|
|
</div>
|
||
|
|
<h4>See Also</h4>
|
||
|
|
<ul>
|
||
|
|
<li><a href="assert_msg.html">BOOST_PP_ASSERT_MSG</a></li>
|
||
|
|
<li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
|
||
|
|
</ul>
|
||
|
|
<h4>Requirements</h4>
|
||
|
|
<div>
|
||
|
|
<b>Header:</b> <a href="../headers/debug/assert.hpp.html"><boost/preprocessor/debug/assert.hpp></a>
|
||
|
|
</div>
|
||
|
|
<h4><a class="local" onclick="toggle('sample');" onmouseover="change(this);" onmouseout="revert(this);">Sample Code</a></h4>
|
||
|
|
<div id="sample"><pre>
|
||
|
|
#include <boost/preprocessor/comparison/equal.hpp>
|
||
|
|
#include <boost/preprocessor/debug/assert.hpp>
|
||
|
|
|
||
|
|
// lines are supposed to be counted
|
||
|
|
// in translation phase 1
|
||
|
|
|
||
|
|
#line 9
|
||
|
|
BOOST_PP_ASSERT_MSG( /* ....... */ \
|
||
|
|
BOOST_PP_EQUAL(__LINE__, 9), \
|
||
|
|
"weird line numbering detected" \
|
||
|
|
)
|
||
|
|
<pre></div>
|
||
|
|
</body>
|
||
|
|
</html>
|