<!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_harness.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="#nested-classes">Classes</a> | <a href="#define-members">Macros</a> | <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">SDL_test_harness.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__harness_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="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSDLTest__TestCaseReference.html">SDLTest_TestCaseReference</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSDLTest__TestSuiteReference.html">SDLTest_TestSuiteReference</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:a4404f2feb87e68e20e31bd86ec1728b1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4404f2feb87e68e20e31bd86ec1728b1"></a> #define </td><td class="memItemRight" valign="bottom"><b>TEST_ENABLED</b>   1</td></tr> <tr class="separator:a4404f2feb87e68e20e31bd86ec1728b1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac7b13b8aefdada941436332f7559e5f0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac7b13b8aefdada941436332f7559e5f0"></a> #define </td><td class="memItemRight" valign="bottom"><b>TEST_DISABLED</b>   0</td></tr> <tr class="separator:ac7b13b8aefdada941436332f7559e5f0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad1b0d362df8510a4a917442ae7173aa1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1b0d362df8510a4a917442ae7173aa1"></a> #define </td><td class="memItemRight" valign="bottom"><b>TEST_ABORTED</b>   -1</td></tr> <tr class="separator:ad1b0d362df8510a4a917442ae7173aa1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a24c50cc9207eee59e73f95faff5ef07a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24c50cc9207eee59e73f95faff5ef07a"></a> #define </td><td class="memItemRight" valign="bottom"><b>TEST_STARTED</b>   0</td></tr> <tr class="separator:a24c50cc9207eee59e73f95faff5ef07a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa1fcd18bba2a887390bb7e032f177716"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1fcd18bba2a887390bb7e032f177716"></a> #define </td><td class="memItemRight" valign="bottom"><b>TEST_COMPLETED</b>   1</td></tr> <tr class="separator:aa1fcd18bba2a887390bb7e032f177716"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adc53d81b0aba42f8a5773a4bd1c3da88"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc53d81b0aba42f8a5773a4bd1c3da88"></a> #define </td><td class="memItemRight" valign="bottom"><b>TEST_SKIPPED</b>   2</td></tr> <tr class="separator:adc53d81b0aba42f8a5773a4bd1c3da88"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:accbb9396b61c19b746505b685275ce82"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="accbb9396b61c19b746505b685275ce82"></a> #define </td><td class="memItemRight" valign="bottom"><b>TEST_RESULT_PASSED</b>   0</td></tr> <tr class="separator:accbb9396b61c19b746505b685275ce82"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a25cadd1b04d9f8f342919a53e2b984b7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25cadd1b04d9f8f342919a53e2b984b7"></a> #define </td><td class="memItemRight" valign="bottom"><b>TEST_RESULT_FAILED</b>   1</td></tr> <tr class="separator:a25cadd1b04d9f8f342919a53e2b984b7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab560e79979c20b68710cc24585a2f78f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab560e79979c20b68710cc24585a2f78f"></a> #define </td><td class="memItemRight" valign="bottom"><b>TEST_RESULT_NO_ASSERT</b>   2</td></tr> <tr class="separator:ab560e79979c20b68710cc24585a2f78f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aadce13b4d24fe4ac2b58578167e53846"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aadce13b4d24fe4ac2b58578167e53846"></a> #define </td><td class="memItemRight" valign="bottom"><b>TEST_RESULT_SKIPPED</b>   3</td></tr> <tr class="separator:aadce13b4d24fe4ac2b58578167e53846"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aff94de0de0428e277e9c660d755adb1a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff94de0de0428e277e9c660d755adb1a"></a> #define </td><td class="memItemRight" valign="bottom"><b>TEST_RESULT_SETUP_FAILURE</b>   4</td></tr> <tr class="separator:aff94de0de0428e277e9c660d755adb1a"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:ac995a74bcb5eedd4aa06e888ae522862"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac995a74bcb5eedd4aa06e888ae522862"></a> typedef <a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a>(* </td><td class="memItemRight" valign="bottom"><b>SDLTest_TestCaseSetUpFp</b> )(<a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> *arg)</td></tr> <tr class="separator:ac995a74bcb5eedd4aa06e888ae522862"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a999ef3d353a817ab1c127f3c607d8c7d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a999ef3d353a817ab1c127f3c607d8c7d"></a> typedef <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a>(* </td><td class="memItemRight" valign="bottom"><b>SDLTest_TestCaseFp</b> )(<a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> *arg)</td></tr> <tr class="separator:a999ef3d353a817ab1c127f3c607d8c7d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab5047d0e13a626b93d696e06cfa748fd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5047d0e13a626b93d696e06cfa748fd"></a> typedef <a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a>(* </td><td class="memItemRight" valign="bottom"><b>SDLTest_TestCaseTearDownFp</b> )(<a class="el" href="SDL__audio_8h.html#a52835ae37c4bb905b903cbaf5d04b05f">void</a> *arg)</td></tr> <tr class="separator:ab5047d0e13a626b93d696e06cfa748fd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a80ea4f56022704ad5ca88f045ca90647"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak" /> <a class="el" href="structSDLTest__TestCaseReference.html">SDLTest_TestCaseReference</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__test__harness_8h.html#a80ea4f56022704ad5ca88f045ca90647">SDLTest_TestCaseReference</a></td></tr> <tr class="separator:a80ea4f56022704ad5ca88f045ca90647"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac9f9cb01c6801359e407bd49723f8e7c"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak" /> <a class="el" href="structSDLTest__TestSuiteReference.html">SDLTest_TestSuiteReference</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__test__harness_8h.html#ac9f9cb01c6801359e407bd49723f8e7c">SDLTest_TestSuiteReference</a></td></tr> <tr class="separator:ac9f9cb01c6801359e407bd49723f8e7c"><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:a4999be460499b1cb45e2b2b3bbb582b2"><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__harness_8h.html#a4999be460499b1cb45e2b2b3bbb582b2">SDLTest_RunSuites</a> (<a class="el" href="structSDLTest__TestSuiteReference.html">SDLTest_TestSuiteReference</a> *testSuites[], const char *userRunSeed, <a class="el" href="SDL__stdinc_8h.html#ac006cf2bd55a42a9cc8ae9f123aa7e13">Uint64</a> userExecKey, const char *filter, <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> testIterations)</td></tr> <tr class="memdesc:a4999be460499b1cb45e2b2b3bbb582b2"><td class="mdescLeft"> </td><td class="mdescRight">Execute a test suite using the given run seed and execution key. <a href="#a4999be460499b1cb45e2b2b3bbb582b2">More...</a><br /></td></tr> <tr class="separator:a4999be460499b1cb45e2b2b3bbb582b2"><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">Typedef Documentation</h2> <a class="anchor" id="a80ea4f56022704ad5ca88f045ca90647"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structSDLTest__TestCaseReference.html">SDLTest_TestCaseReference</a> <a class="el" href="structSDLTest__TestCaseReference.html">SDLTest_TestCaseReference</a></td> </tr> </table> </div><div class="memdoc"> <p>Holds information about a single test case. </p> </div> </div> <a class="anchor" id="ac9f9cb01c6801359e407bd49723f8e7c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structSDLTest__TestSuiteReference.html">SDLTest_TestSuiteReference</a> <a class="el" href="structSDLTest__TestSuiteReference.html">SDLTest_TestSuiteReference</a></td> </tr> </table> </div><div class="memdoc"> <p>Holds information about a test suite (multiple test cases). </p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="a4999be460499b1cb45e2b2b3bbb582b2"></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_RunSuites </td> <td>(</td> <td class="paramtype"><a class="el" href="structSDLTest__TestSuiteReference.html">SDLTest_TestSuiteReference</a> * </td> <td class="paramname"><em>testSuites</em>[], </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>userRunSeed</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="SDL__stdinc_8h.html#ac006cf2bd55a42a9cc8ae9f123aa7e13">Uint64</a> </td> <td class="paramname"><em>userExecKey</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>filter</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> </td> <td class="paramname"><em>testIterations</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Execute a test suite using the given run seed and execution key. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">testSuites</td><td>Suites containing the test case. </td></tr> <tr><td class="paramname">userRunSeed</td><td>Custom run seed provided by user, or NULL to autogenerate one. </td></tr> <tr><td class="paramname">userExecKey</td><td>Custom execution key provided by user, or 0 to autogenerate one. </td></tr> <tr><td class="paramname">filter</td><td>Filter specification. NULL disables. Case sensitive. </td></tr> <tr><td class="paramname">testIterations</td><td>Number of iterations to run each test case.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Test run result; 0 when all tests passed, 1 if any tests failed. </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>