<!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 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/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>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">SDL_test_assert.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="begin__code_8h_source.html">begin_code.h</a>"</code><br />
<code>#include "<a class="el" href="close__code_8h_source.html">close_code.h</a>"</code><br />
</div>
<p><a href="SDL__test__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 name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:adc9dbc949d8699a6f6515211a2efa0cf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc9dbc949d8699a6f6515211a2efa0cf"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__test__assert_8h.html#adc9dbc949d8699a6f6515211a2efa0cf">ASSERT_FAIL</a>   0</td></tr>
<tr class="memdesc:adc9dbc949d8699a6f6515211a2efa0cf"><td class="mdescLeft"> </td><td class="mdescRight">Fails the assert. <br /></td></tr>
<tr class="separator:adc9dbc949d8699a6f6515211a2efa0cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae67a2f28e6df1e351df870754835a09a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae67a2f28e6df1e351df870754835a09a"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__test__assert_8h.html#ae67a2f28e6df1e351df870754835a09a">ASSERT_PASS</a>   1</td></tr>
<tr class="memdesc:ae67a2f28e6df1e351df870754835a09a"><td class="mdescLeft"> </td><td class="mdescRight">Passes the assert. <br /></td></tr>
<tr class="separator:ae67a2f28e6df1e351df870754835a09a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a59e7e8f7ecf1ac4a0c8c10c810483add"><td class="memItemLeft" align="right" valign="top"><a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__test__assert_8h.html#a59e7e8f7ecf1ac4a0c8c10c810483add">SDLTest_Assert</a> (<a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> assertCondition, const char *assertDescription,...)</td></tr>
<tr class="memdesc:a59e7e8f7ecf1ac4a0c8c10c810483add"><td class="mdescLeft"> </td><td class="mdescRight">Assert that logs and break execution flow on failures. <a href="#a59e7e8f7ecf1ac4a0c8c10c810483add">More...</a><br /></td></tr>
<tr class="separator:a59e7e8f7ecf1ac4a0c8c10c810483add"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5920e6901ad268836111c2226ae03c28"><td class="memItemLeft" align="right" valign="top"><a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__test__assert_8h.html#a5920e6901ad268836111c2226ae03c28">SDLTest_AssertCheck</a> (<a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> assertCondition, const char *assertDescription,...)</td></tr>
<tr class="memdesc:a5920e6901ad268836111c2226ae03c28"><td class="mdescLeft"> </td><td class="mdescRight">Assert for test cases that logs but does not break execution flow on failures. Updates assertion counters. <a href="#a5920e6901ad268836111c2226ae03c28">More...</a><br /></td></tr>
<tr class="separator:a5920e6901ad268836111c2226ae03c28"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d7023e35d3a2c5961a00f097408d34a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__test__assert_8h.html#a8d7023e35d3a2c5961a00f097408d34a">SDLTest_AssertPass</a> (const char *assertDescription,...)</td></tr>
<tr class="memdesc:a8d7023e35d3a2c5961a00f097408d34a"><td class="mdescLeft"> </td><td class="mdescRight">Explicitely pass without checking an assertion condition. Updates assertion counter. <a href="#a8d7023e35d3a2c5961a00f097408d34a">More...</a><br /></td></tr>
<tr class="separator:a8d7023e35d3a2c5961a00f097408d34a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a64f6f1dfd462826ad4fbc33bc0658954"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a64f6f1dfd462826ad4fbc33bc0658954"></a>
<a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__test__assert_8h.html#a64f6f1dfd462826ad4fbc33bc0658954">SDLTest_ResetAssertSummary</a> ()</td></tr>
<tr class="memdesc:a64f6f1dfd462826ad4fbc33bc0658954"><td class="mdescLeft"> </td><td class="mdescRight">Resets the assert summary counters to zero. <br /></td></tr>
<tr class="separator:a64f6f1dfd462826ad4fbc33bc0658954"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a91bf7c3d801ba6d0ded433e5ed661bbe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91bf7c3d801ba6d0ded433e5ed661bbe"></a>
<a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__test__assert_8h.html#a91bf7c3d801ba6d0ded433e5ed661bbe">SDLTest_LogAssertSummary</a> ()</td></tr>
<tr class="memdesc:a91bf7c3d801ba6d0ded433e5ed661bbe"><td class="mdescLeft"> </td><td class="mdescRight">Logs summary of all assertions (total, pass, fail) since last reset as INFO or ERROR. <br /></td></tr>
<tr class="separator:a91bf7c3d801ba6d0ded433e5ed661bbe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2196b3c11e7eba93ec4ff797ed20bc3c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__test__assert_8h.html#a2196b3c11e7eba93ec4ff797ed20bc3c">SDLTest_AssertSummaryToTestResult</a> ()</td></tr>
<tr class="memdesc:a2196b3c11e7eba93ec4ff797ed20bc3c"><td class="mdescLeft"> </td><td class="mdescRight">Converts the current assert summary state to a test result. <a href="#a2196b3c11e7eba93ec4ff797ed20bc3c">More...</a><br /></td></tr>
<tr class="separator:a2196b3c11e7eba93ec4ff797ed20bc3c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Include file for SDL test framework.</p>
<p>This code is a part of the SDL2_test library, not the main SDL library. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a59e7e8f7ecf1ac4a0c8c10c810483add"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> SDLTest_Assert </td>
<td>(</td>
<td class="paramtype"><a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> </td>
<td class="paramname"><em>assertCondition</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>assertDescription</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assert that logs and break execution flow on failures. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">assertCondition</td><td>Evaluated condition or variable to assert; fail (==0) or pass (!=0). </td></tr>
<tr><td class="paramname">assertDescription</td><td>Message to log with the assert describing it. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5920e6901ad268836111c2226ae03c28"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> SDLTest_AssertCheck </td>
<td>(</td>
<td class="paramtype"><a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> </td>
<td class="paramname"><em>assertCondition</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>assertDescription</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assert for test cases that logs but does not break execution flow on failures. Updates assertion counters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">assertCondition</td><td>Evaluated condition or variable to assert; fail (==0) or pass (!=0). </td></tr>
<tr><td class="paramname">assertDescription</td><td>Message to log with the assert describing it.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the assertCondition so it can be used to externally to break execution flow if desired. </dd></dl>
</div>
</div>
<a class="anchor" id="a8d7023e35d3a2c5961a00f097408d34a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> SDLTest_AssertPass </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>assertDescription</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Explicitely pass without checking an assertion condition. Updates assertion counter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">assertDescription</td><td>Message to log with the assert describing it. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2196b3c11e7eba93ec4ff797ed20bc3c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> SDLTest_AssertSummaryToTestResult </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts the current assert summary state to a test result. </p>
<dl class="section return"><dt>Returns</dt><dd>TEST_RESULT_PASSED, TEST_RESULT_FAILED, or TEST_RESULT_NO_ASSERT </dd></dl>
</div>
</div>
</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>
