<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.8"/> <title>My Project: SDL_test_assert.h Source File</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/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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 style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">My Project </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.8 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <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="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <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><!-- top --> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="headertitle"> <div class="title">SDL_test_assert.h</div> </div> </div><!--header--> <div class="contents"> <a href="SDL__test__assert_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Simple DirectMedia Layer</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org></span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> This software is provided 'as-is', without any express or implied</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> warranty. In no event will the authors be held liable for any damages</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> arising from the use of this software.</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> Permission is granted to anyone to use this software for any purpose,</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> including commercial applications, and to alter it and redistribute it</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> freely, subject to the following restrictions:</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> 1. The origin of this software must not be misrepresented; you must not</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> claim that you wrote the original software. If you use this software</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> in a product, an acknowledgment in the product documentation would be</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> appreciated but is not required.</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> 2. Altered source versions must be plainly marked as such, and must not be</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> misrepresented as being the original software.</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> 3. This notice may not be removed or altered from any source distribution.</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">*/</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/*</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> *</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * Assert API for test code and test cases</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> *</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> */</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#ifndef _SDL_test_assert_h</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#define _SDL_test_assert_h</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#include "<a class="code" href="begin__code_8h.html">begin_code.h</a>"</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">/* Set up for C function definitions, even when using C++ */</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div> <div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="SDL__test__assert_8h.html#adc9dbc949d8699a6f6515211a2efa0cf"> 48</a></span> <span class="preprocessor">#define ASSERT_FAIL 0</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> <div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="SDL__test__assert_8h.html#ae67a2f28e6df1e351df870754835a09a"> 53</a></span> <span class="preprocessor">#define ASSERT_PASS 1</span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keywordtype">void</span> <a class="code" href="SDL__test__assert_8h.html#a59e7e8f7ecf1ac4a0c8c10c810483add">SDLTest_Assert</a>(<span class="keywordtype">int</span> assertCondition, <span class="keyword">const</span> <span class="keywordtype">char</span> *assertDescription, ...);</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keywordtype">int</span> <a class="code" href="SDL__test__assert_8h.html#a5920e6901ad268836111c2226ae03c28">SDLTest_AssertCheck</a>(<span class="keywordtype">int</span> assertCondition, <span class="keyword">const</span> <span class="keywordtype">char</span> *assertDescription, ...);</div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keywordtype">void</span> <a class="code" href="SDL__test__assert_8h.html#a8d7023e35d3a2c5961a00f097408d34a">SDLTest_AssertPass</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *assertDescription, ...);</div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="keywordtype">void</span> <a class="code" href="SDL__test__assert_8h.html#a64f6f1dfd462826ad4fbc33bc0658954">SDLTest_ResetAssertSummary</a>();</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="keywordtype">void</span> <a class="code" href="SDL__test__assert_8h.html#a91bf7c3d801ba6d0ded433e5ed661bbe">SDLTest_LogAssertSummary</a>();</div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keywordtype">int</span> <a class="code" href="SDL__test__assert_8h.html#a2196b3c11e7eba93ec4ff797ed20bc3c">SDLTest_AssertSummaryToTestResult</a>();</div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> }</div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor">#include "<a class="code" href="close__code_8h.html">close_code.h</a>"</span></div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor">#endif </span><span class="comment">/* _SDL_test_assert_h */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment">/* vi: set ts=4 sw=4 expandtab: */</span></div> <div class="ttc" id="SDL__test__assert_8h_html_a59e7e8f7ecf1ac4a0c8c10c810483add"><div class="ttname"><a href="SDL__test__assert_8h.html#a59e7e8f7ecf1ac4a0c8c10c810483add">SDLTest_Assert</a></div><div class="ttdeci">void SDLTest_Assert(int assertCondition, const char *assertDescription,...)</div><div class="ttdoc">Assert that logs and break execution flow on failures. </div></div> <div class="ttc" id="SDL__test__assert_8h_html_a64f6f1dfd462826ad4fbc33bc0658954"><div class="ttname"><a href="SDL__test__assert_8h.html#a64f6f1dfd462826ad4fbc33bc0658954">SDLTest_ResetAssertSummary</a></div><div class="ttdeci">void SDLTest_ResetAssertSummary()</div><div class="ttdoc">Resets the assert summary counters to zero. </div></div> <div class="ttc" id="SDL__test__assert_8h_html_a5920e6901ad268836111c2226ae03c28"><div class="ttname"><a href="SDL__test__assert_8h.html#a5920e6901ad268836111c2226ae03c28">SDLTest_AssertCheck</a></div><div class="ttdeci">int SDLTest_AssertCheck(int assertCondition, const char *assertDescription,...)</div><div class="ttdoc">Assert for test cases that logs but does not break execution flow on failures. Updates assertion coun...</div></div> <div class="ttc" id="SDL__test__assert_8h_html_a8d7023e35d3a2c5961a00f097408d34a"><div class="ttname"><a href="SDL__test__assert_8h.html#a8d7023e35d3a2c5961a00f097408d34a">SDLTest_AssertPass</a></div><div class="ttdeci">void SDLTest_AssertPass(const char *assertDescription,...)</div><div class="ttdoc">Explicitely pass without checking an assertion condition. Updates assertion counter. </div></div> <div class="ttc" id="begin__code_8h_html"><div class="ttname"><a href="begin__code_8h.html">begin_code.h</a></div></div> <div class="ttc" id="close__code_8h_html"><div class="ttname"><a href="close__code_8h.html">close_code.h</a></div></div> <div class="ttc" id="SDL__test__assert_8h_html_a2196b3c11e7eba93ec4ff797ed20bc3c"><div class="ttname"><a href="SDL__test__assert_8h.html#a2196b3c11e7eba93ec4ff797ed20bc3c">SDLTest_AssertSummaryToTestResult</a></div><div class="ttdeci">int SDLTest_AssertSummaryToTestResult()</div><div class="ttdoc">Converts the current assert summary state to a test result. </div></div> <div class="ttc" id="SDL__test__assert_8h_html_a91bf7c3d801ba6d0ded433e5ed661bbe"><div class="ttname"><a href="SDL__test__assert_8h.html#a91bf7c3d801ba6d0ded433e5ed661bbe">SDLTest_LogAssertSummary</a></div><div class="ttdeci">void SDLTest_LogAssertSummary()</div><div class="ttdoc">Logs summary of all assertions (total, pass, fail) since last reset as INFO or ERROR. </div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Thu Oct 16 2014 16:33:09 for My Project by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.8 </small></address> </body> </html>