harness__argparser_8c.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.4"/>
  7. <title>SDL Visual Test: C:/Users/DELL/Work/sdlvisualtest/visualtest/src/harness_argparser.c File Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">SDL Visual Test
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.4 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <div id="navrow1" class="tabs">
  38. <ul class="tablist">
  39. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  40. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  41. <li class="current"><a href="files.html"><span>Files</span></a></li>
  42. <li>
  43. <div id="MSearchBox" class="MSearchBoxInactive">
  44. <span class="left">
  45. <img id="MSearchSelect" src="search/mag_sel.png"
  46. onmouseover="return searchBox.OnSearchSelectShow()"
  47. onmouseout="return searchBox.OnSearchSelectHide()"
  48. alt=""/>
  49. <input type="text" id="MSearchField" value="Search" accesskey="S"
  50. onfocus="searchBox.OnSearchFieldFocus(true)"
  51. onblur="searchBox.OnSearchFieldFocus(false)"
  52. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  53. </span><span class="right">
  54. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  55. </span>
  56. </div>
  57. </li>
  58. </ul>
  59. </div>
  60. <div id="navrow2" class="tabs2">
  61. <ul class="tablist">
  62. <li><a href="files.html"><span>File&#160;List</span></a></li>
  63. <li><a href="globals.html"><span>Globals</span></a></li>
  64. </ul>
  65. </div>
  66. <!-- window showing the filter options -->
  67. <div id="MSearchSelectWindow"
  68. onmouseover="return searchBox.OnSearchSelectShow()"
  69. onmouseout="return searchBox.OnSearchSelectHide()"
  70. onkeydown="return searchBox.OnSearchSelectKey(event)">
  71. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  72. <!-- iframe showing the search results (closed by default) -->
  73. <div id="MSearchResultsWindow">
  74. <iframe src="javascript:void(0)" frameborder="0"
  75. name="MSearchResults" id="MSearchResults">
  76. </iframe>
  77. </div>
  78. <div id="nav-path" class="navpath">
  79. <ul>
  80. <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
  81. </div>
  82. </div><!-- top -->
  83. <div class="header">
  84. <div class="summary">
  85. <a href="#define-members">Macros</a> &#124;
  86. <a href="#func-members">Functions</a> </div>
  87. <div class="headertitle">
  88. <div class="title">harness_argparser.c File Reference</div> </div>
  89. </div><!--header-->
  90. <div class="contents">
  91. <div class="textblock"><code>#include &lt;SDL_test.h&gt;</code><br/>
  92. <code>#include &lt;stdio.h&gt;</code><br/>
  93. <code>#include &lt;string.h&gt;</code><br/>
  94. <code>#include &quot;<a class="el" href="_s_d_l__visualtest__harness__argparser_8h_source.html">SDL_visualtest_harness_argparser.h</a>&quot;</code><br/>
  95. <code>#include &quot;SDL_visualtest_rwhelper.h&quot;</code><br/>
  96. </div><table class="memberdecls">
  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  98. Macros</h2></td></tr>
  99. <tr class="memitem:a7186273cd88640b740b6333cd98ae243"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="harness__argparser_8c.html#a7186273cd88640b740b6333cd98ae243">MAX_CONFIG_LINE_LEN</a>&#160;&#160;&#160;400</td></tr>
  100. <tr class="separator:a7186273cd88640b740b6333cd98ae243"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a6669f8e5a07e7a0e4622dd23362831e7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="harness__argparser_8c.html#a6669f8e5a07e7a0e4622dd23362831e7">DEFAULT_SUT_TIMEOUT</a>&#160;&#160;&#160;(60 * 1000)</td></tr>
  102. <tr class="separator:a6669f8e5a07e7a0e4622dd23362831e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. </table><table class="memberdecls">
  104. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  105. Functions</h2></td></tr>
  106. <tr class="memitem:a629609acc04ef21a21fdfbbf6c1589c8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="harness__argparser_8c.html#a629609acc04ef21a21fdfbbf6c1589c8">SDLVisualTest_ParseHarnessArgs</a> (char **argv, <a class="el" href="struct_s_d_l_visual_test___harness_state.html">SDLVisualTest_HarnessState</a> *state)</td></tr>
  107. <tr class="separator:a629609acc04ef21a21fdfbbf6c1589c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a833147d8da541982c615645a797627cc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="harness__argparser_8c.html#a833147d8da541982c615645a797627cc">SDLVisualTest_FreeHarnessState</a> (<a class="el" href="struct_s_d_l_visual_test___harness_state.html">SDLVisualTest_HarnessState</a> *state)</td></tr>
  109. <tr class="separator:a833147d8da541982c615645a797627cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. </table>
  111. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  112. <div class="textblock"><p>Source file for functions to parse arguments to the test harness. </p>
  113. </div><h2 class="groupheader">Macro Definition Documentation</h2>
  114. <a class="anchor" id="a6669f8e5a07e7a0e4622dd23362831e7"></a>
  115. <div class="memitem">
  116. <div class="memproto">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname">#define DEFAULT_SUT_TIMEOUT&#160;&#160;&#160;(60 * 1000)</td>
  120. </tr>
  121. </table>
  122. </div><div class="memdoc">
  123. <p>Default value for the timeout after which the SUT is forcefully killed </p>
  124. </div>
  125. </div>
  126. <a class="anchor" id="a7186273cd88640b740b6333cd98ae243"></a>
  127. <div class="memitem">
  128. <div class="memproto">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname">#define MAX_CONFIG_LINE_LEN&#160;&#160;&#160;400</td>
  132. </tr>
  133. </table>
  134. </div><div class="memdoc">
  135. <p>Maximum length of one line in the config file </p>
  136. </div>
  137. </div>
  138. <h2 class="groupheader">Function Documentation</h2>
  139. <a class="anchor" id="a833147d8da541982c615645a797627cc"></a>
  140. <div class="memitem">
  141. <div class="memproto">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname">void SDLVisualTest_FreeHarnessState </td>
  145. <td>(</td>
  146. <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___harness_state.html">SDLVisualTest_HarnessState</a> *&#160;</td>
  147. <td class="paramname"><em>state</em>)</td><td></td>
  148. <td></td>
  149. </tr>
  150. </table>
  151. </div><div class="memdoc">
  152. <p>Frees any resources associated with the state object pointed to by <code>state</code>. </p>
  153. </div>
  154. </div>
  155. <a class="anchor" id="a629609acc04ef21a21fdfbbf6c1589c8"></a>
  156. <div class="memitem">
  157. <div class="memproto">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">int SDLVisualTest_ParseHarnessArgs </td>
  161. <td>(</td>
  162. <td class="paramtype">char **&#160;</td>
  163. <td class="paramname"><em>argv</em>, </td>
  164. </tr>
  165. <tr>
  166. <td class="paramkey"></td>
  167. <td></td>
  168. <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___harness_state.html">SDLVisualTest_HarnessState</a> *&#160;</td>
  169. <td class="paramname"><em>state</em>&#160;</td>
  170. </tr>
  171. <tr>
  172. <td></td>
  173. <td>)</td>
  174. <td></td><td></td>
  175. </tr>
  176. </table>
  177. </div><div class="memdoc">
  178. <p>Parse command line paramters to the test harness and populate a state object.</p>
  179. <dl class="params"><dt>Parameters</dt><dd>
  180. <table class="params">
  181. <tr><td class="paramname">argv</td><td>The array of command line parameters. </td></tr>
  182. <tr><td class="paramname">state</td><td>Pointer to the state object to be populated.</td></tr>
  183. </table>
  184. </dd>
  185. </dl>
  186. <dl class="section return"><dt>Returns</dt><dd>Non-zero on success, zero on failure. </dd></dl>
  187. </div>
  188. </div>
  189. </div><!-- contents -->
  190. <!-- start footer part -->
  191. <hr class="footer"/><address class="footer"><small>
  192. Generated on Thu Sep 26 2013 00:18:23 for SDL Visual Test by &#160;<a href="http://www.doxygen.org/index.html">
  193. <img class="footer" src="doxygen.png" alt="doxygen"/>
  194. </a> 1.8.4
  195. </small></address>
  196. </body>
  197. </html>