_s_d_l__visualtest__exhaustive__variator_8h.html (12597B)
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_exhaustive_variator.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="#func-members">Functions</a> </div> 91 <div class="headertitle"> 92<div class="title">SDL_visualtest_exhaustive_variator.h File Reference</div> </div> 93</div><!--header--> 94<div class="contents"> 95<div class="textblock"><code>#include "<a class="el" href="_s_d_l__visualtest__harness__argparser_8h_source.html">SDL_visualtest_harness_argparser.h</a>"</code><br/> 96<code>#include "<a class="el" href="_s_d_l__visualtest__variator__common_8h_source.html">SDL_visualtest_variator_common.h</a>"</code><br/> 97</div> 98<p><a href="_s_d_l__visualtest__exhaustive__variator_8h_source.html">Go to the source code of this file.</a></p> 99<table class="memberdecls"> 100<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> 101Data Structures</h2></td></tr> 102<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___exhaustive_variator.html">SDLVisualTest_ExhaustiveVariator</a></td></tr> 103<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> 104</table><table class="memberdecls"> 105<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> 106Typedefs</h2></td></tr> 107<tr class="memitem:ab64de6cf7d6a1e6d09d470c020940c25"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> 108<a class="el" href="struct_s_d_l_visual_test___exhaustive_variator.html">SDLVisualTest_ExhaustiveVariator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__exhaustive__variator_8h.html#ab64de6cf7d6a1e6d09d470c020940c25">SDLVisualTest_ExhaustiveVariator</a></td></tr> 109<tr class="separator:ab64de6cf7d6a1e6d09d470c020940c25"><td class="memSeparator" colspan="2"> </td></tr> 110</table><table class="memberdecls"> 111<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 112Functions</h2></td></tr> 113<tr class="memitem:a9e213e530ddf5a18014786d10e9fdaee"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__exhaustive__variator_8h.html#a9e213e530ddf5a18014786d10e9fdaee">SDLVisualTest_InitExhaustiveVariator</a> (<a class="el" href="struct_s_d_l_visual_test___exhaustive_variator.html">SDLVisualTest_ExhaustiveVariator</a> *variator, <a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a> *config)</td></tr> 114<tr class="separator:a9e213e530ddf5a18014786d10e9fdaee"><td class="memSeparator" colspan="2"> </td></tr> 115<tr class="memitem:aa9e13a92945ef48308215b3fa068ed29"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__exhaustive__variator_8h.html#aa9e13a92945ef48308215b3fa068ed29">SDLVisualTest_GetNextExhaustiveVariation</a> (<a class="el" href="struct_s_d_l_visual_test___exhaustive_variator.html">SDLVisualTest_ExhaustiveVariator</a> *variator)</td></tr> 116<tr class="separator:aa9e13a92945ef48308215b3fa068ed29"><td class="memSeparator" colspan="2"> </td></tr> 117<tr class="memitem:a7168b055fb86bbbb700d87ae842f7152"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__exhaustive__variator_8h.html#a7168b055fb86bbbb700d87ae842f7152">SDLVisualTest_FreeExhaustiveVariator</a> (<a class="el" href="struct_s_d_l_visual_test___exhaustive_variator.html">SDLVisualTest_ExhaustiveVariator</a> *variator)</td></tr> 118<tr class="separator:a7168b055fb86bbbb700d87ae842f7152"><td class="memSeparator" colspan="2"> </td></tr> 119</table> 120<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 121<div class="textblock"><p>Header for the exhaustive variator. </p> 122</div><h2 class="groupheader">Typedef Documentation</h2> 123<a class="anchor" id="ab64de6cf7d6a1e6d09d470c020940c25"></a> 124<div class="memitem"> 125<div class="memproto"> 126 <table class="memname"> 127 <tr> 128 <td class="memname">typedef struct <a class="el" href="struct_s_d_l_visual_test___exhaustive_variator.html">SDLVisualTest_ExhaustiveVariator</a> <a class="el" href="struct_s_d_l_visual_test___exhaustive_variator.html">SDLVisualTest_ExhaustiveVariator</a></td> 129 </tr> 130 </table> 131</div><div class="memdoc"> 132<p>Struct for the variator that exhaustively iterates through all variations of command line arguments to the SUT. </p> 133 134</div> 135</div> 136<h2 class="groupheader">Function Documentation</h2> 137<a class="anchor" id="a7168b055fb86bbbb700d87ae842f7152"></a> 138<div class="memitem"> 139<div class="memproto"> 140 <table class="memname"> 141 <tr> 142 <td class="memname">void SDLVisualTest_FreeExhaustiveVariator </td> 143 <td>(</td> 144 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___exhaustive_variator.html">SDLVisualTest_ExhaustiveVariator</a> * </td> 145 <td class="paramname"><em>variator</em>)</td><td></td> 146 <td></td> 147 </tr> 148 </table> 149</div><div class="memdoc"> 150<p>Frees any resources associated with the variator. </p> 151 152</div> 153</div> 154<a class="anchor" id="aa9e13a92945ef48308215b3fa068ed29"></a> 155<div class="memitem"> 156<div class="memproto"> 157 <table class="memname"> 158 <tr> 159 <td class="memname">char* SDLVisualTest_GetNextExhaustiveVariation </td> 160 <td>(</td> 161 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___exhaustive_variator.html">SDLVisualTest_ExhaustiveVariator</a> * </td> 162 <td class="paramname"><em>variator</em>)</td><td></td> 163 <td></td> 164 </tr> 165 </table> 166</div><div class="memdoc"> 167<p>Gets the arguments string for the next variation using the variator and updates the variator's current variation object to the next variation.</p> 168<dl class="section return"><dt>Returns</dt><dd>The arguments string representing the next variation on success, and NULL on failure or if we have iterated through all possible variations. In the latter case subsequent calls will start the variations again from the very beginning. The pointer returned should not be freed. </dd></dl> 169 170</div> 171</div> 172<a class="anchor" id="a9e213e530ddf5a18014786d10e9fdaee"></a> 173<div class="memitem"> 174<div class="memproto"> 175 <table class="memname"> 176 <tr> 177 <td class="memname">int SDLVisualTest_InitExhaustiveVariator </td> 178 <td>(</td> 179 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___exhaustive_variator.html">SDLVisualTest_ExhaustiveVariator</a> * </td> 180 <td class="paramname"><em>variator</em>, </td> 181 </tr> 182 <tr> 183 <td class="paramkey"></td> 184 <td></td> 185 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a> * </td> 186 <td class="paramname"><em>config</em> </td> 187 </tr> 188 <tr> 189 <td></td> 190 <td>)</td> 191 <td></td><td></td> 192 </tr> 193 </table> 194</div><div class="memdoc"> 195<p>Initializes the variator.</p> 196<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure </dd></dl> 197 198</div> 199</div> 200</div><!-- contents --> 201<!-- start footer part --> 202<hr class="footer"/><address class="footer"><small> 203Generated on Thu Sep 26 2013 00:18:23 for SDL Visual Test by  <a href="http://www.doxygen.org/index.html"> 204<img class="footer" src="doxygen.png" alt="doxygen"/> 205</a> 1.8.4 206</small></address> 207</body> 208</html>