<html> <head> <title>CppTest - A C++ Unit Testing Framework</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"> </head> <body bgcolor="#ffffff"> <table width="100%"> <tr> <td width="40%" align="right" valign="center"> <a href="http://cpptest.sourceforge.net">CppTest home page</a> </td> <td></td> <td width="40%" align="left" valign="center"> <a href="http://sourceforge.net/projects/cpptest">CppTest project page</a> </td> </tr> </table> <hr> <!-- Generated by Doxygen 1.5.9 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> </div> <div class="contents"> <h1>cpptest-assert.h File Reference</h1> <p> <a href="cpptest-assert_8h_source.html">Go to the source code of this file.</a><h2>Defines</h2> <ul> <li>#define <a class="el" href="cpptest-assert_8h.html#947ab44cc42369eb7cfe33f8a1e38e4b">TEST_FAIL</a>(msg) <li>#define <a class="el" href="cpptest-assert_8h.html#29a763f14098f5574ae5c68291dc6ddd">TEST_ASSERT</a>(expr) <li>#define <a class="el" href="cpptest-assert_8h.html#c612ede938734f9c8d898e05818882fb">TEST_ASSERT_MSG</a>(expr, msg) <li>#define <a class="el" href="cpptest-assert_8h.html#9583b1709f4b9dfb3ff2849bfec5c885">TEST_ASSERT_DELTA</a>(a, b, delta) <li>#define <a class="el" href="cpptest-assert_8h.html#fcd749452840bfde9be575ef22fcede0">TEST_ASSERT_DELTA_MSG</a>(a, b, delta, msg) <li>#define <a class="el" href="cpptest-assert_8h.html#5174c5f93519d5726c8993b2f36d6ceb">TEST_THROWS</a>(expr, x) <li>#define <a class="el" href="cpptest-assert_8h.html#1ce6abe9e9134ce993840a648673e0f2">TEST_THROWS_MSG</a>(expr, x, msg) <li>#define <a class="el" href="cpptest-assert_8h.html#895af88056cd626a010136ac07b81d37">TEST_THROWS_ANYTHING</a>(expr) <li>#define <a class="el" href="cpptest-assert_8h.html#052597a8fd7dbc40ba350c735c4517c5">TEST_THROWS_ANYTHING_MSG</a>(expr, msg) <li>#define <a class="el" href="cpptest-assert_8h.html#885a5f6b6decac47414b4cc1a0a66425">TEST_THROWS_NOTHING</a>(expr) <li>#define <a class="el" href="cpptest-assert_8h.html#758a47b613522a3d597c513786191ff9">TEST_THROWS_NOTHING_MSG</a>(expr, msg) </ul> <hr><h2>Detailed Description</h2> <hr><h2>Define Documentation</h2> <a class="anchor" name="947ab44cc42369eb7cfe33f8a1e38e4b"></a><!-- doxytag: member="cpptest-assert.h::TEST_FAIL" ref="947ab44cc42369eb7cfe33f8a1e38e4b" args="(msg)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define TEST_FAIL </td> <td>(</td> <td class="paramtype">msg </td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Unconditional failure.<p> Used in conjunction with <a class="el" href="classTest_1_1Suite.html" title="Unit testing suite.">Test::Suite</a>.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>Provided message.</td></tr> </table> </dl> <dl class="user" compact><dt><b>Example:</b></dt><dd><div class="fragment"><pre class="fragment"> <span class="keywordtype">void</span> MySuite::test() { <span class="comment">// ...</span> <span class="keywordflow">switch</span> (flag) { <span class="comment">// handling valid cases ...</span> <span class="keywordflow">default</span>: <a class="code" href="cpptest-assert_8h.html#947ab44cc42369eb7cfe33f8a1e38e4b">TEST_FAIL</a>(<span class="stringliteral">"This should not happen"</span>) } } </pre></div></dd></dl> For a description of all asserts, see <a class="el" href="asserts.html">Available asserts</a>. </div> </div><p> <a class="anchor" name="29a763f14098f5574ae5c68291dc6ddd"></a><!-- doxytag: member="cpptest-assert.h::TEST_ASSERT" ref="29a763f14098f5574ae5c68291dc6ddd" args="(expr)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define TEST_ASSERT </td> <td>(</td> <td class="paramtype">expr </td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Verify an expression and issues an assertment if it fails.<p> Used in conjunction with <a class="el" href="classTest_1_1Suite.html" title="Unit testing suite.">Test::Suite</a>.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>expr</em> </td><td>Expression to test.</td></tr> </table> </dl> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="cpptest-assert_8h.html#c612ede938734f9c8d898e05818882fb">TEST_ASSERT_MSG(expr, msg)</a></dd></dl> <dl class="user" compact><dt><b>Example:</b></dt><dd><div class="fragment"><pre class="fragment"> <span class="keywordtype">void</span> MySuite::test() { <span class="keywordtype">int</span> i; <span class="comment">// ...</span> <a class="code" href="cpptest-assert_8h.html#29a763f14098f5574ae5c68291dc6ddd">TEST_ASSERT</a>(i == 13) } </pre></div></dd></dl> For a description of all asserts, see <a class="el" href="asserts.html">Available asserts</a>. </div> </div><p> <a class="anchor" name="c612ede938734f9c8d898e05818882fb"></a><!-- doxytag: member="cpptest-assert.h::TEST_ASSERT_MSG" ref="c612ede938734f9c8d898e05818882fb" args="(expr, msg)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define TEST_ASSERT_MSG </td> <td>(</td> <td class="paramtype">expr, <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">msg </td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Verify an expression and issues an assertment if it fails.<p> Used in conjunction with <a class="el" href="classTest_1_1Suite.html" title="Unit testing suite.">Test::Suite</a>.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>expr</em> </td><td>Expression to test. </td></tr> <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>User message.</td></tr> </table> </dl> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="cpptest-assert_8h.html#29a763f14098f5574ae5c68291dc6ddd">TEST_ASSERT(expr)</a></dd></dl> For a description of all asserts, see <a class="el" href="asserts.html">Available asserts</a>. </div> </div><p> <a class="anchor" name="9583b1709f4b9dfb3ff2849bfec5c885"></a><!-- doxytag: member="cpptest-assert.h::TEST_ASSERT_DELTA" ref="9583b1709f4b9dfb3ff2849bfec5c885" args="(a, b, delta)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define TEST_ASSERT_DELTA </td> <td>(</td> <td class="paramtype">a, <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">b, <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">delta </td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Verify that two expressions are equal up to a constant, issues an assertment if it fails.<p> Used in conjunction with <a class="el" href="classTest_1_1Suite.html" title="Unit testing suite.">Test::Suite</a>.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>a</em> </td><td>First expression to test. </td></tr> <tr><td valign="top"></td><td valign="top"><em>b</em> </td><td>Second expression to test. </td></tr> <tr><td valign="top"></td><td valign="top"><em>delta</em> </td><td>Constant.</td></tr> </table> </dl> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="cpptest-assert_8h.html#fcd749452840bfde9be575ef22fcede0">TEST_ASSERT_DELTA_MSG(a, b, delta, msg)</a></dd></dl> For a description of all asserts, see <a class="el" href="asserts.html">Available asserts</a>. </div> </div><p> <a class="anchor" name="fcd749452840bfde9be575ef22fcede0"></a><!-- doxytag: member="cpptest-assert.h::TEST_ASSERT_DELTA_MSG" ref="fcd749452840bfde9be575ef22fcede0" args="(a, b, delta, msg)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define TEST_ASSERT_DELTA_MSG </td> <td>(</td> <td class="paramtype">a, <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">b, <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">delta, <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">msg </td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Verify that two expressions are equal up to a constant, issues an assertment if it fails.<p> Used in conjunction with <a class="el" href="classTest_1_1Suite.html" title="Unit testing suite.">Test::Suite</a>.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>a</em> </td><td>First expression to test. </td></tr> <tr><td valign="top"></td><td valign="top"><em>b</em> </td><td>Second expression to test. </td></tr> <tr><td valign="top"></td><td valign="top"><em>delta</em> </td><td>Constant. </td></tr> <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>User message.</td></tr> </table> </dl> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="cpptest-assert_8h.html#9583b1709f4b9dfb3ff2849bfec5c885">TEST_ASSERT_DELTA(a, b, delta)</a></dd></dl> For a description of all asserts, see <a class="el" href="asserts.html">Available asserts</a>. </div> </div><p> <a class="anchor" name="5174c5f93519d5726c8993b2f36d6ceb"></a><!-- doxytag: member="cpptest-assert.h::TEST_THROWS" ref="5174c5f93519d5726c8993b2f36d6ceb" args="(expr, x)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define TEST_THROWS </td> <td>(</td> <td class="paramtype">expr, <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">x </td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Verify an expression and expects an exception in return. An assertment is issued if the exception is not thrown.<p> Used in conjunction with <a class="el" href="classTest_1_1Suite.html" title="Unit testing suite.">Test::Suite</a>.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>expr</em> </td><td>Expression to test. </td></tr> <tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>Expected exception.</td></tr> </table> </dl> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="cpptest-assert_8h.html#1ce6abe9e9134ce993840a648673e0f2">TEST_THROWS_MSG(expr, x, msg)</a></dd></dl> For a description of all asserts, see <a class="el" href="asserts.html">Available asserts</a>. </div> </div><p> <a class="anchor" name="1ce6abe9e9134ce993840a648673e0f2"></a><!-- doxytag: member="cpptest-assert.h::TEST_THROWS_MSG" ref="1ce6abe9e9134ce993840a648673e0f2" args="(expr, x, msg)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define TEST_THROWS_MSG </td> <td>(</td> <td class="paramtype">expr, <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">x, <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">msg </td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Verify an expression and expects an exception in return. An assertment is issued if the exception is not thrown.<p> Used in conjunction with <a class="el" href="classTest_1_1Suite.html" title="Unit testing suite.">Test::Suite</a>.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>expr</em> </td><td>Expression to test. </td></tr> <tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>Expected exception. </td></tr> <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>User message.</td></tr> </table> </dl> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="cpptest-assert_8h.html#5174c5f93519d5726c8993b2f36d6ceb">TEST_THROWS(expr, x)</a></dd></dl> For a description of all asserts, see <a class="el" href="asserts.html">Available asserts</a>. </div> </div><p> <a class="anchor" name="895af88056cd626a010136ac07b81d37"></a><!-- doxytag: member="cpptest-assert.h::TEST_THROWS_ANYTHING" ref="895af88056cd626a010136ac07b81d37" args="(expr)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define TEST_THROWS_ANYTHING </td> <td>(</td> <td class="paramtype">expr </td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Verify an expression and expects any exception in return. An assertment is issued if no exception is thrown.<p> Used in conjunction with <a class="el" href="classTest_1_1Suite.html" title="Unit testing suite.">Test::Suite</a>.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>expr</em> </td><td>Expression to test.</td></tr> </table> </dl> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="cpptest-assert_8h.html#052597a8fd7dbc40ba350c735c4517c5">TEST_THROWS_ANYTHING_MSG(expr, msg)</a></dd></dl> For a description of all asserts, see <a class="el" href="asserts.html">Available asserts</a>. </div> </div><p> <a class="anchor" name="052597a8fd7dbc40ba350c735c4517c5"></a><!-- doxytag: member="cpptest-assert.h::TEST_THROWS_ANYTHING_MSG" ref="052597a8fd7dbc40ba350c735c4517c5" args="(expr, msg)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define TEST_THROWS_ANYTHING_MSG </td> <td>(</td> <td class="paramtype">expr, <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">msg </td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Verify an expression and expects any exception in return. An assertment is issued if no exception is thrown.<p> Used in conjunction with <a class="el" href="classTest_1_1Suite.html" title="Unit testing suite.">Test::Suite</a>.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>expr</em> </td><td>Expression to test. </td></tr> <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>User message.</td></tr> </table> </dl> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="cpptest-assert_8h.html#895af88056cd626a010136ac07b81d37">TEST_THROWS_ANYTHING(expr)</a></dd></dl> For a description of all asserts, see <a class="el" href="asserts.html">Available asserts</a>. </div> </div><p> <a class="anchor" name="885a5f6b6decac47414b4cc1a0a66425"></a><!-- doxytag: member="cpptest-assert.h::TEST_THROWS_NOTHING" ref="885a5f6b6decac47414b4cc1a0a66425" args="(expr)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define TEST_THROWS_NOTHING </td> <td>(</td> <td class="paramtype">expr </td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Verify an expression and expects no exception in return. An assertment is issued if any exception is thrown.<p> Used in conjunction with <a class="el" href="classTest_1_1Suite.html" title="Unit testing suite.">Test::Suite</a>.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>expr</em> </td><td>Expression to test.</td></tr> </table> </dl> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="cpptest-assert_8h.html#758a47b613522a3d597c513786191ff9">TEST_THROWS_NOTHING_MSG(expr, msg)</a></dd></dl> For a description of all asserts, see <a class="el" href="asserts.html">Available asserts</a>. </div> </div><p> <a class="anchor" name="758a47b613522a3d597c513786191ff9"></a><!-- doxytag: member="cpptest-assert.h::TEST_THROWS_NOTHING_MSG" ref="758a47b613522a3d597c513786191ff9" args="(expr, msg)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define TEST_THROWS_NOTHING_MSG </td> <td>(</td> <td class="paramtype">expr, <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">msg </td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Verify an expression and expects no exception in return. An assertment is issued if any exception is thrown.<p> Used in conjunction with <a class="el" href="classTest_1_1Suite.html" title="Unit testing suite.">Test::Suite</a>.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>expr</em> </td><td>Expression to test. </td></tr> <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>User message.</td></tr> </table> </dl> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="cpptest-assert_8h.html#885a5f6b6decac47414b4cc1a0a66425">TEST_THROWS_NOTHING(expr)</a></dd></dl> For a description of all asserts, see <a class="el" href="asserts.html">Available asserts</a>. </div> </div><p> </div> <hr> <div align="center"> Supported by: <br><br> <img src="http://sourceforge.net/sflogo.php?group_id=77564" width="88" height="31" border="0" alt="SourceForge Logo"></a> </div> </body> </html>