_s_d_l__visualtest__sut__configparser_8h.html (18192B)
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/include/SDL_visualtest_sut_configparser.h 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_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul> 83</div> 84</div><!-- top --> 85<div class="header"> 86 <div class="summary"> 87<a href="#nested-classes">Data Structures</a> | 88<a href="#define-members">Macros</a> | 89<a href="#typedef-members">Typedefs</a> | 90<a href="#enum-members">Enumerations</a> | 91<a href="#func-members">Functions</a> </div> 92 <div class="headertitle"> 93<div class="title">SDL_visualtest_sut_configparser.h File Reference</div> </div> 94</div><!--header--> 95<div class="contents"> 96 97<p><a href="_s_d_l__visualtest__sut__configparser_8h_source.html">Go to the source code of this file.</a></p> 98<table class="memberdecls"> 99<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> 100Data Structures</h2></td></tr> 101<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_s_d_l_visual_test___s_u_t_int_range.html">SDLVisualTest_SUTIntRange</a></td></tr> 102<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> 103<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_s_d_l_visual_test___s_u_t_option.html">SDLVisualTest_SUTOption</a></td></tr> 104<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> 105<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a></td></tr> 106<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> 107</table><table class="memberdecls"> 108<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> 109Macros</h2></td></tr> 110<tr class="memitem:a0a8b0c1f8eee787abf09bf3a840eccc7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__sut__configparser_8h.html#a0a8b0c1f8eee787abf09bf3a840eccc7">MAX_SUTOPTION_NAME_LEN</a>   100</td></tr> 111<tr class="separator:a0a8b0c1f8eee787abf09bf3a840eccc7"><td class="memSeparator" colspan="2"> </td></tr> 112<tr class="memitem:a21a678ced8cdf55b4cc70ad398bf33b6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__sut__configparser_8h.html#a21a678ced8cdf55b4cc70ad398bf33b6">MAX_SUTOPTION_CATEGORY_LEN</a>   40</td></tr> 113<tr class="separator:a21a678ced8cdf55b4cc70ad398bf33b6"><td class="memSeparator" colspan="2"> </td></tr> 114<tr class="memitem:a6c700fc8ff02cfa0c795b9593f86b9a0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__sut__configparser_8h.html#a6c700fc8ff02cfa0c795b9593f86b9a0">MAX_SUTOPTION_ENUMVAL_LEN</a>   40</td></tr> 115<tr class="separator:a6c700fc8ff02cfa0c795b9593f86b9a0"><td class="memSeparator" colspan="2"> </td></tr> 116<tr class="memitem:a8f1a5749af5a592b30a194c72d848f75"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__sut__configparser_8h.html#a8f1a5749af5a592b30a194c72d848f75">MAX_SUTOPTION_LINE_LENGTH</a>   256</td></tr> 117<tr class="separator:a8f1a5749af5a592b30a194c72d848f75"><td class="memSeparator" colspan="2"> </td></tr> 118</table><table class="memberdecls"> 119<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> 120Typedefs</h2></td></tr> 121<tr class="memitem:a8cbe93330b2ce59cdf6da59e2eca6045"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> 122<a class="el" href="struct_s_d_l_visual_test___s_u_t_int_range.html">SDLVisualTest_SUTIntRange</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__sut__configparser_8h.html#a8cbe93330b2ce59cdf6da59e2eca6045">SDLVisualTest_SUTIntRange</a></td></tr> 123<tr class="separator:a8cbe93330b2ce59cdf6da59e2eca6045"><td class="memSeparator" colspan="2"> </td></tr> 124<tr class="memitem:a9f35b5fe1ce4ba831a9b9e1f2bc8b7f6"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> 125<a class="el" href="struct_s_d_l_visual_test___s_u_t_option.html">SDLVisualTest_SUTOption</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__sut__configparser_8h.html#a9f35b5fe1ce4ba831a9b9e1f2bc8b7f6">SDLVisualTest_SUTOption</a></td></tr> 126<tr class="separator:a9f35b5fe1ce4ba831a9b9e1f2bc8b7f6"><td class="memSeparator" colspan="2"> </td></tr> 127<tr class="memitem:a1b493a40d601932b62ee643390aec169"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> 128<a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__sut__configparser_8h.html#a1b493a40d601932b62ee643390aec169">SDLVisualTest_SUTConfig</a></td></tr> 129<tr class="separator:a1b493a40d601932b62ee643390aec169"><td class="memSeparator" colspan="2"> </td></tr> 130</table><table class="memberdecls"> 131<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> 132Enumerations</h2></td></tr> 133<tr class="memitem:af9893831d9f79360f57e84a67a90293c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__sut__configparser_8h.html#af9893831d9f79360f57e84a67a90293c">SDLVisualTest_SUTOptionType</a> { <b>SDL_SUT_OPTIONTYPE_STRING</b> = 0, 134<b>SDL_SUT_OPTIONTYPE_INT</b>, 135<b>SDL_SUT_OPTIONTYPE_ENUM</b>, 136<b>SDL_SUT_OPTIONTYPE_BOOL</b> 137 }</td></tr> 138<tr class="separator:af9893831d9f79360f57e84a67a90293c"><td class="memSeparator" colspan="2"> </td></tr> 139</table><table class="memberdecls"> 140<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 141Functions</h2></td></tr> 142<tr class="memitem:a8e178cd8a1f279f5d2cf908545e97544"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__sut__configparser_8h.html#a8e178cd8a1f279f5d2cf908545e97544">SDLVisualTest_ParseSUTConfig</a> (char *file, <a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a> *config)</td></tr> 143<tr class="separator:a8e178cd8a1f279f5d2cf908545e97544"><td class="memSeparator" colspan="2"> </td></tr> 144<tr class="memitem:a1bddf9732c0d3ed1c24455d22193de9a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__sut__configparser_8h.html#a1bddf9732c0d3ed1c24455d22193de9a">SDLVisualTest_FreeSUTConfig</a> (<a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a> *config)</td></tr> 145<tr class="separator:a1bddf9732c0d3ed1c24455d22193de9a"><td class="memSeparator" colspan="2"> </td></tr> 146</table> 147<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 148<div class="textblock"><p>Header for the parser for SUT config files. </p> 149</div><h2 class="groupheader">Macro Definition Documentation</h2> 150<a class="anchor" id="a21a678ced8cdf55b4cc70ad398bf33b6"></a> 151<div class="memitem"> 152<div class="memproto"> 153 <table class="memname"> 154 <tr> 155 <td class="memname">#define MAX_SUTOPTION_CATEGORY_LEN   40</td> 156 </tr> 157 </table> 158</div><div class="memdoc"> 159<p>Maximum length of the name of a category of an SUT option </p> 160 161</div> 162</div> 163<a class="anchor" id="a6c700fc8ff02cfa0c795b9593f86b9a0"></a> 164<div class="memitem"> 165<div class="memproto"> 166 <table class="memname"> 167 <tr> 168 <td class="memname">#define MAX_SUTOPTION_ENUMVAL_LEN   40</td> 169 </tr> 170 </table> 171</div><div class="memdoc"> 172<p>Maximum length of one enum value of an SUT option </p> 173 174</div> 175</div> 176<a class="anchor" id="a8f1a5749af5a592b30a194c72d848f75"></a> 177<div class="memitem"> 178<div class="memproto"> 179 <table class="memname"> 180 <tr> 181 <td class="memname">#define MAX_SUTOPTION_LINE_LENGTH   256</td> 182 </tr> 183 </table> 184</div><div class="memdoc"> 185<p>Maximum length of a line in the paramters file </p> 186 187</div> 188</div> 189<a class="anchor" id="a0a8b0c1f8eee787abf09bf3a840eccc7"></a> 190<div class="memitem"> 191<div class="memproto"> 192 <table class="memname"> 193 <tr> 194 <td class="memname">#define MAX_SUTOPTION_NAME_LEN   100</td> 195 </tr> 196 </table> 197</div><div class="memdoc"> 198<p>Maximum length of the name of an SUT option </p> 199 200</div> 201</div> 202<h2 class="groupheader">Typedef Documentation</h2> 203<a class="anchor" id="a1b493a40d601932b62ee643390aec169"></a> 204<div class="memitem"> 205<div class="memproto"> 206 <table class="memname"> 207 <tr> 208 <td class="memname">typedef struct <a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a> <a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a></td> 209 </tr> 210 </table> 211</div><div class="memdoc"> 212<p>Struct to hold all the options to an SUT application. </p> 213 214</div> 215</div> 216<a class="anchor" id="a8cbe93330b2ce59cdf6da59e2eca6045"></a> 217<div class="memitem"> 218<div class="memproto"> 219 <table class="memname"> 220 <tr> 221 <td class="memname">typedef struct <a class="el" href="struct_s_d_l_visual_test___s_u_t_int_range.html">SDLVisualTest_SUTIntRange</a> <a class="el" href="struct_s_d_l_visual_test___s_u_t_int_range.html">SDLVisualTest_SUTIntRange</a></td> 222 </tr> 223 </table> 224</div><div class="memdoc"> 225<p>Represents the range of values an integer option can take. </p> 226 227</div> 228</div> 229<a class="anchor" id="a9f35b5fe1ce4ba831a9b9e1f2bc8b7f6"></a> 230<div class="memitem"> 231<div class="memproto"> 232 <table class="memname"> 233 <tr> 234 <td class="memname">typedef struct <a class="el" href="struct_s_d_l_visual_test___s_u_t_option.html">SDLVisualTest_SUTOption</a> <a class="el" href="struct_s_d_l_visual_test___s_u_t_option.html">SDLVisualTest_SUTOption</a></td> 235 </tr> 236 </table> 237</div><div class="memdoc"> 238<p>Struct that defines an option to be passed to the SUT. </p> 239 240</div> 241</div> 242<h2 class="groupheader">Enumeration Type Documentation</h2> 243<a class="anchor" id="af9893831d9f79360f57e84a67a90293c"></a> 244<div class="memitem"> 245<div class="memproto"> 246 <table class="memname"> 247 <tr> 248 <td class="memname">enum <a class="el" href="_s_d_l__visualtest__sut__configparser_8h.html#af9893831d9f79360f57e84a67a90293c">SDLVisualTest_SUTOptionType</a></td> 249 </tr> 250 </table> 251</div><div class="memdoc"> 252<p>Describes the different kinds of options to the SUT. </p> 253 254</div> 255</div> 256<h2 class="groupheader">Function Documentation</h2> 257<a class="anchor" id="a1bddf9732c0d3ed1c24455d22193de9a"></a> 258<div class="memitem"> 259<div class="memproto"> 260 <table class="memname"> 261 <tr> 262 <td class="memname">void SDLVisualTest_FreeSUTConfig </td> 263 <td>(</td> 264 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a> * </td> 265 <td class="paramname"><em>config</em>)</td><td></td> 266 <td></td> 267 </tr> 268 </table> 269</div><div class="memdoc"> 270<p>Free any resources associated with the config object pointed to by <code>config</code>. </p> 271 272</div> 273</div> 274<a class="anchor" id="a8e178cd8a1f279f5d2cf908545e97544"></a> 275<div class="memitem"> 276<div class="memproto"> 277 <table class="memname"> 278 <tr> 279 <td class="memname">int SDLVisualTest_ParseSUTConfig </td> 280 <td>(</td> 281 <td class="paramtype">char * </td> 282 <td class="paramname"><em>file</em>, </td> 283 </tr> 284 <tr> 285 <td class="paramkey"></td> 286 <td></td> 287 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a> * </td> 288 <td class="paramname"><em>config</em> </td> 289 </tr> 290 <tr> 291 <td></td> 292 <td>)</td> 293 <td></td><td></td> 294 </tr> 295 </table> 296</div><div class="memdoc"> 297<p>Parses a configuration file that describes the command line options an SUT application will take and populates a SUT config object. All lines in the config file must be smaller than</p> 298<dl class="params"><dt>Parameters</dt><dd> 299 <table class="params"> 300 <tr><td class="paramname">file</td><td>Path to the configuration file. </td></tr> 301 <tr><td class="paramname">config</td><td>Pointer to an object that represents an SUT configuration.</td></tr> 302 </table> 303 </dd> 304</dl> 305<dl class="section return"><dt>Returns</dt><dd>zero on failure, non-zero on success </dd></dl> 306 307</div> 308</div> 309</div><!-- contents --> 310<!-- start footer part --> 311<hr class="footer"/><address class="footer"><small> 312Generated on Thu Sep 26 2013 00:18:23 for SDL Visual Test by  <a href="http://www.doxygen.org/index.html"> 313<img class="footer" src="doxygen.png" alt="doxygen"/> 314</a> 1.8.4 315</small></address> 316</body> 317</html>