harness__argparser_8c.html (10817B)
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"> 35var 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 Page</span></a></li> 40 <li><a href="annotated.html"><span>Data 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 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</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> 72 73<!-- iframe showing the search results (closed by default) --> 74<div id="MSearchResultsWindow"> 75<iframe src="javascript:void(0)" frameborder="0" 76 name="MSearchResults" id="MSearchResults"> 77</iframe> 78</div> 79 80<div id="nav-path" class="navpath"> 81 <ul> 82<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul> 83</div> 84</div><!-- top --> 85<div class="header"> 86 <div class="summary"> 87<a href="#define-members">Macros</a> | 88<a href="#func-members">Functions</a> </div> 89 <div class="headertitle"> 90<div class="title">harness_argparser.c File Reference</div> </div> 91</div><!--header--> 92<div class="contents"> 93<div class="textblock"><code>#include <SDL_test.h></code><br/> 94<code>#include <stdio.h></code><br/> 95<code>#include <string.h></code><br/> 96<code>#include "<a class="el" href="_s_d_l__visualtest__harness__argparser_8h_source.html">SDL_visualtest_harness_argparser.h</a>"</code><br/> 97<code>#include "SDL_visualtest_rwhelper.h"</code><br/> 98</div><table class="memberdecls"> 99<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> 100Macros</h2></td></tr> 101<tr class="memitem:a7186273cd88640b740b6333cd98ae243"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="harness__argparser_8c.html#a7186273cd88640b740b6333cd98ae243">MAX_CONFIG_LINE_LEN</a>   400</td></tr> 102<tr class="separator:a7186273cd88640b740b6333cd98ae243"><td class="memSeparator" colspan="2"> </td></tr> 103<tr class="memitem:a6669f8e5a07e7a0e4622dd23362831e7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="harness__argparser_8c.html#a6669f8e5a07e7a0e4622dd23362831e7">DEFAULT_SUT_TIMEOUT</a>   (60 * 1000)</td></tr> 104<tr class="separator:a6669f8e5a07e7a0e4622dd23362831e7"><td class="memSeparator" colspan="2"> </td></tr> 105</table><table class="memberdecls"> 106<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 107Functions</h2></td></tr> 108<tr class="memitem:a629609acc04ef21a21fdfbbf6c1589c8"><td class="memItemLeft" align="right" valign="top">int </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> 109<tr class="separator:a629609acc04ef21a21fdfbbf6c1589c8"><td class="memSeparator" colspan="2"> </td></tr> 110<tr class="memitem:a833147d8da541982c615645a797627cc"><td class="memItemLeft" align="right" valign="top">void </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> 111<tr class="separator:a833147d8da541982c615645a797627cc"><td class="memSeparator" colspan="2"> </td></tr> 112</table> 113<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 114<div class="textblock"><p>Source file for functions to parse arguments to the test harness. </p> 115</div><h2 class="groupheader">Macro Definition Documentation</h2> 116<a class="anchor" id="a6669f8e5a07e7a0e4622dd23362831e7"></a> 117<div class="memitem"> 118<div class="memproto"> 119 <table class="memname"> 120 <tr> 121 <td class="memname">#define DEFAULT_SUT_TIMEOUT   (60 * 1000)</td> 122 </tr> 123 </table> 124</div><div class="memdoc"> 125<p>Default value for the timeout after which the SUT is forcefully killed </p> 126 127</div> 128</div> 129<a class="anchor" id="a7186273cd88640b740b6333cd98ae243"></a> 130<div class="memitem"> 131<div class="memproto"> 132 <table class="memname"> 133 <tr> 134 <td class="memname">#define MAX_CONFIG_LINE_LEN   400</td> 135 </tr> 136 </table> 137</div><div class="memdoc"> 138<p>Maximum length of one line in the config file </p> 139 140</div> 141</div> 142<h2 class="groupheader">Function Documentation</h2> 143<a class="anchor" id="a833147d8da541982c615645a797627cc"></a> 144<div class="memitem"> 145<div class="memproto"> 146 <table class="memname"> 147 <tr> 148 <td class="memname">void SDLVisualTest_FreeHarnessState </td> 149 <td>(</td> 150 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___harness_state.html">SDLVisualTest_HarnessState</a> * </td> 151 <td class="paramname"><em>state</em>)</td><td></td> 152 <td></td> 153 </tr> 154 </table> 155</div><div class="memdoc"> 156<p>Frees any resources associated with the state object pointed to by <code>state</code>. </p> 157 158</div> 159</div> 160<a class="anchor" id="a629609acc04ef21a21fdfbbf6c1589c8"></a> 161<div class="memitem"> 162<div class="memproto"> 163 <table class="memname"> 164 <tr> 165 <td class="memname">int SDLVisualTest_ParseHarnessArgs </td> 166 <td>(</td> 167 <td class="paramtype">char ** </td> 168 <td class="paramname"><em>argv</em>, </td> 169 </tr> 170 <tr> 171 <td class="paramkey"></td> 172 <td></td> 173 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___harness_state.html">SDLVisualTest_HarnessState</a> * </td> 174 <td class="paramname"><em>state</em> </td> 175 </tr> 176 <tr> 177 <td></td> 178 <td>)</td> 179 <td></td><td></td> 180 </tr> 181 </table> 182</div><div class="memdoc"> 183<p>Parse command line paramters to the test harness and populate a state object.</p> 184<dl class="params"><dt>Parameters</dt><dd> 185 <table class="params"> 186 <tr><td class="paramname">argv</td><td>The array of command line parameters. </td></tr> 187 <tr><td class="paramname">state</td><td>Pointer to the state object to be populated.</td></tr> 188 </table> 189 </dd> 190</dl> 191<dl class="section return"><dt>Returns</dt><dd>Non-zero on success, zero on failure. </dd></dl> 192 193</div> 194</div> 195</div><!-- contents --> 196<!-- start footer part --> 197<hr class="footer"/><address class="footer"><small> 198Generated on Thu Sep 26 2013 00:18:23 for SDL Visual Test by  <a href="http://www.doxygen.org/index.html"> 199<img class="footer" src="doxygen.png" alt="doxygen"/> 200</a> 1.8.4 201</small></address> 202</body> 203</html>