| <!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.4"/> |
| <title>SDL Visual Test: C:/Users/DELL/Work/sdlvisualtest/visualtest/include/SDL_visualtest_sut_configparser.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">SDL Visual Test |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.4 --> |
| <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="annotated.html"><span>Data Structures</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>Globals</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>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> |
| |
| <!-- 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 id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Data Structures</a> | |
| <a href="#define-members">Macros</a> | |
| <a href="#typedef-members">Typedefs</a> | |
| <a href="#enum-members">Enumerations</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">SDL_visualtest_sut_configparser.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a href="_s_d_l__visualtest__sut__configparser_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> |
| Data Structures</h2></td></tr> |
| <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> |
| <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="struct_s_d_l_visual_test___s_u_t_option.html">SDLVisualTest_SUTOption</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="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</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: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> |
| <tr class="separator:a0a8b0c1f8eee787abf09bf3a840eccc7"><td class="memSeparator" colspan="2"> </td></tr> |
| <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> |
| <tr class="separator:a21a678ced8cdf55b4cc70ad398bf33b6"><td class="memSeparator" colspan="2"> </td></tr> |
| <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> |
| <tr class="separator:a6c700fc8ff02cfa0c795b9593f86b9a0"><td class="memSeparator" colspan="2"> </td></tr> |
| <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> |
| <tr class="separator:a8f1a5749af5a592b30a194c72d848f75"><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:a8cbe93330b2ce59cdf6da59e2eca6045"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> |
| <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> |
| <tr class="separator:a8cbe93330b2ce59cdf6da59e2eca6045"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9f35b5fe1ce4ba831a9b9e1f2bc8b7f6"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> |
| <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> |
| <tr class="separator:a9f35b5fe1ce4ba831a9b9e1f2bc8b7f6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1b493a40d601932b62ee643390aec169"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> |
| <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> |
| <tr class="separator:a1b493a40d601932b62ee643390aec169"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> |
| Enumerations</h2></td></tr> |
| <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, |
| <b>SDL_SUT_OPTIONTYPE_INT</b>, |
| <b>SDL_SUT_OPTIONTYPE_ENUM</b>, |
| <b>SDL_SUT_OPTIONTYPE_BOOL</b> |
| }</td></tr> |
| <tr class="separator:af9893831d9f79360f57e84a67a90293c"><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: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> |
| <tr class="separator:a8e178cd8a1f279f5d2cf908545e97544"><td class="memSeparator" colspan="2"> </td></tr> |
| <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> |
| <tr class="separator:a1bddf9732c0d3ed1c24455d22193de9a"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Header for the parser for SUT config files. </p> |
| </div><h2 class="groupheader">Macro Definition Documentation</h2> |
| <a class="anchor" id="a21a678ced8cdf55b4cc70ad398bf33b6"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define MAX_SUTOPTION_CATEGORY_LEN   40</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Maximum length of the name of a category of an SUT option </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6c700fc8ff02cfa0c795b9593f86b9a0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define MAX_SUTOPTION_ENUMVAL_LEN   40</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Maximum length of one enum value of an SUT option </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a8f1a5749af5a592b30a194c72d848f75"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define MAX_SUTOPTION_LINE_LENGTH   256</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Maximum length of a line in the paramters file </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a0a8b0c1f8eee787abf09bf3a840eccc7"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define MAX_SUTOPTION_NAME_LEN   100</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Maximum length of the name of an SUT option </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Typedef Documentation</h2> |
| <a class="anchor" id="a1b493a40d601932b62ee643390aec169"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <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> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Struct to hold all the options to an SUT application. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a8cbe93330b2ce59cdf6da59e2eca6045"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <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> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Represents the range of values an integer option can take. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a9f35b5fe1ce4ba831a9b9e1f2bc8b7f6"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <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> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Struct that defines an option to be passed to the SUT. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Enumeration Type Documentation</h2> |
| <a class="anchor" id="af9893831d9f79360f57e84a67a90293c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="_s_d_l__visualtest__sut__configparser_8h.html#af9893831d9f79360f57e84a67a90293c">SDLVisualTest_SUTOptionType</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Describes the different kinds of options to the SUT. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a class="anchor" id="a1bddf9732c0d3ed1c24455d22193de9a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void SDLVisualTest_FreeSUTConfig </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a> * </td> |
| <td class="paramname"><em>config</em>)</td><td></td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Free any resources associated with the config object pointed to by <code>config</code>. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a8e178cd8a1f279f5d2cf908545e97544"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int SDLVisualTest_ParseSUTConfig </td> |
| <td>(</td> |
| <td class="paramtype">char * </td> |
| <td class="paramname"><em>file</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a> * </td> |
| <td class="paramname"><em>config</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <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> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">file</td><td>Path to the configuration file. </td></tr> |
| <tr><td class="paramname">config</td><td>Pointer to an object that represents an SUT configuration.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>zero on failure, non-zero on success </dd></dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Sep 26 2013 00:18:23 for SDL Visual Test by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.4 |
| </small></address> |
| </body> |
| </html> |