_s_d_l__visualtest__variator__common_8h.html (19801B)
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_variator_common.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_variator_common.h File Reference</div> </div> 94</div><!--header--> 95<div class="contents"> 96<div class="textblock"><code>#include <SDL_types.h></code><br/> 97<code>#include "<a class="el" href="_s_d_l__visualtest__sut__configparser_8h_source.html">SDL_visualtest_sut_configparser.h</a>"</code><br/> 98</div> 99<p><a href="_s_d_l__visualtest__variator__common_8h_source.html">Go to the source code of this file.</a></p> 100<table class="memberdecls"> 101<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> 102Data Structures</h2></td></tr> 103<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union  </td><td class="memItemRight" valign="bottom"><a class="el" href="union_s_d_l_visual_test___s_u_t_option_value.html">SDLVisualTest_SUTOptionValue</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___variation.html">SDLVisualTest_Variation</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:afcdce86a10fbcdc9f3e47c47b70e3ea3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__variator__common_8h.html#afcdce86a10fbcdc9f3e47c47b70e3ea3">SDL_SUT_INTEGER_OPTION_TEST_STEPS</a>   3</td></tr> 111<tr class="separator:afcdce86a10fbcdc9f3e47c47b70e3ea3"><td class="memSeparator" colspan="2"> </td></tr> 112</table><table class="memberdecls"> 113<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> 114Typedefs</h2></td></tr> 115<tr class="memitem:a4a7752dc89880ce3f62a478b3d0d8d64"><td class="memItemLeft" align="right" valign="top">typedef enum <br class="typebreak"/> 116<a class="el" href="_s_d_l__visualtest__variator__common_8h.html#a04bfc880abe6940d69a63c06a33acdbd">SDLVisualTest_VariatorType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__variator__common_8h.html#a4a7752dc89880ce3f62a478b3d0d8d64">SDLVisualTest_VariatorType</a></td></tr> 117<tr class="separator:a4a7752dc89880ce3f62a478b3d0d8d64"><td class="memSeparator" colspan="2"> </td></tr> 118<tr class="memitem:aa4e5fb752f4cd087101ea3e1f6124dfb"><td class="memItemLeft" align="right" valign="top">typedef union <br class="typebreak"/> 119<a class="el" href="union_s_d_l_visual_test___s_u_t_option_value.html">SDLVisualTest_SUTOptionValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__variator__common_8h.html#aa4e5fb752f4cd087101ea3e1f6124dfb">SDLVisualTest_SUTOptionValue</a></td></tr> 120<tr class="separator:aa4e5fb752f4cd087101ea3e1f6124dfb"><td class="memSeparator" colspan="2"> </td></tr> 121<tr class="memitem:a6b447c1467862ecd623cc8f37489faeb"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> 122<a class="el" href="struct_s_d_l_visual_test___variation.html">SDLVisualTest_Variation</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__variator__common_8h.html#a6b447c1467862ecd623cc8f37489faeb">SDLVisualTest_Variation</a></td></tr> 123<tr class="separator:a6b447c1467862ecd623cc8f37489faeb"><td class="memSeparator" colspan="2"> </td></tr> 124</table><table class="memberdecls"> 125<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> 126Enumerations</h2></td></tr> 127<tr class="memitem:a04bfc880abe6940d69a63c06a33acdbd"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__variator__common_8h.html#a04bfc880abe6940d69a63c06a33acdbd">SDLVisualTest_VariatorType</a> { <b>SDL_VARIATOR_NONE</b> = 0, 128<b>SDL_VARIATOR_EXHAUSTIVE</b>, 129<b>SDL_VARIATOR_RANDOM</b> 130 }</td></tr> 131<tr class="separator:a04bfc880abe6940d69a63c06a33acdbd"><td class="memSeparator" colspan="2"> </td></tr> 132</table><table class="memberdecls"> 133<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 134Functions</h2></td></tr> 135<tr class="memitem:aafcecc06c8feb24b6f6a509bfa9db681"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__variator__common_8h.html#aafcecc06c8feb24b6f6a509bfa9db681">SDLVisualTest_NextValue</a> (<a class="el" href="union_s_d_l_visual_test___s_u_t_option_value.html">SDLVisualTest_SUTOptionValue</a> *var, <a class="el" href="struct_s_d_l_visual_test___s_u_t_option.html">SDLVisualTest_SUTOption</a> *opt)</td></tr> 136<tr class="separator:aafcecc06c8feb24b6f6a509bfa9db681"><td class="memSeparator" colspan="2"> </td></tr> 137<tr class="memitem:ad981c2efab849e76dc878ef8da9d6017"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__variator__common_8h.html#ad981c2efab849e76dc878ef8da9d6017">SDLVisualTest_MakeStrFromVariation</a> (<a class="el" href="struct_s_d_l_visual_test___variation.html">SDLVisualTest_Variation</a> *variation, <a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a> *config, char *buffer, int size)</td></tr> 138<tr class="separator:ad981c2efab849e76dc878ef8da9d6017"><td class="memSeparator" colspan="2"> </td></tr> 139<tr class="memitem:ac87934906c51364778dc910ebca47b6c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__variator__common_8h.html#ac87934906c51364778dc910ebca47b6c">SDLVisualTest_InitVariation</a> (<a class="el" href="struct_s_d_l_visual_test___variation.html">SDLVisualTest_Variation</a> *variation, <a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a> *config)</td></tr> 140<tr class="separator:ac87934906c51364778dc910ebca47b6c"><td class="memSeparator" colspan="2"> </td></tr> 141</table> 142<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 143<div class="textblock"><p>Header for common functionality used by variators. </p> 144</div><h2 class="groupheader">Macro Definition Documentation</h2> 145<a class="anchor" id="afcdce86a10fbcdc9f3e47c47b70e3ea3"></a> 146<div class="memitem"> 147<div class="memproto"> 148 <table class="memname"> 149 <tr> 150 <td class="memname">#define SDL_SUT_INTEGER_OPTION_TEST_STEPS   3</td> 151 </tr> 152 </table> 153</div><div class="memdoc"> 154<p>The number of variations one integer option would generate </p> 155 156</div> 157</div> 158<h2 class="groupheader">Typedef Documentation</h2> 159<a class="anchor" id="aa4e5fb752f4cd087101ea3e1f6124dfb"></a> 160<div class="memitem"> 161<div class="memproto"> 162 <table class="memname"> 163 <tr> 164 <td class="memname">typedef union <a class="el" href="union_s_d_l_visual_test___s_u_t_option_value.html">SDLVisualTest_SUTOptionValue</a> <a class="el" href="union_s_d_l_visual_test___s_u_t_option_value.html">SDLVisualTest_SUTOptionValue</a></td> 165 </tr> 166 </table> 167</div><div class="memdoc"> 168<p>One possible value for a command line option to the SUT. </p> 169 170</div> 171</div> 172<a class="anchor" id="a6b447c1467862ecd623cc8f37489faeb"></a> 173<div class="memitem"> 174<div class="memproto"> 175 <table class="memname"> 176 <tr> 177 <td class="memname">typedef struct <a class="el" href="struct_s_d_l_visual_test___variation.html">SDLVisualTest_Variation</a> <a class="el" href="struct_s_d_l_visual_test___variation.html">SDLVisualTest_Variation</a></td> 178 </tr> 179 </table> 180</div><div class="memdoc"> 181<p>Represents a valid combination of parameters that can be passed to the SUT. The ordering of the values here is the same as the ordering of the options in the <a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a> object for this variation. </p> 182 183</div> 184</div> 185<a class="anchor" id="a4a7752dc89880ce3f62a478b3d0d8d64"></a> 186<div class="memitem"> 187<div class="memproto"> 188 <table class="memname"> 189 <tr> 190 <td class="memname">typedef enum <a class="el" href="_s_d_l__visualtest__variator__common_8h.html#a04bfc880abe6940d69a63c06a33acdbd">SDLVisualTest_VariatorType</a> <a class="el" href="_s_d_l__visualtest__variator__common_8h.html#a04bfc880abe6940d69a63c06a33acdbd">SDLVisualTest_VariatorType</a></td> 191 </tr> 192 </table> 193</div><div class="memdoc"> 194<p>enum for indicating the type of variator being used </p> 195 196</div> 197</div> 198<h2 class="groupheader">Enumeration Type Documentation</h2> 199<a class="anchor" id="a04bfc880abe6940d69a63c06a33acdbd"></a> 200<div class="memitem"> 201<div class="memproto"> 202 <table class="memname"> 203 <tr> 204 <td class="memname">enum <a class="el" href="_s_d_l__visualtest__variator__common_8h.html#a04bfc880abe6940d69a63c06a33acdbd">SDLVisualTest_VariatorType</a></td> 205 </tr> 206 </table> 207</div><div class="memdoc"> 208<p>enum for indicating the type of variator being used </p> 209 210</div> 211</div> 212<h2 class="groupheader">Function Documentation</h2> 213<a class="anchor" id="ac87934906c51364778dc910ebca47b6c"></a> 214<div class="memitem"> 215<div class="memproto"> 216 <table class="memname"> 217 <tr> 218 <td class="memname">int SDLVisualTest_InitVariation </td> 219 <td>(</td> 220 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___variation.html">SDLVisualTest_Variation</a> * </td> 221 <td class="paramname"><em>variation</em>, </td> 222 </tr> 223 <tr> 224 <td class="paramkey"></td> 225 <td></td> 226 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a> * </td> 227 <td class="paramname"><em>config</em> </td> 228 </tr> 229 <tr> 230 <td></td> 231 <td>)</td> 232 <td></td><td></td> 233 </tr> 234 </table> 235</div><div class="memdoc"> 236<p>Initializes the variation using the following rules:</p> 237<ul> 238<li>Boolean options are initialized to SDL_FALSE.</li> 239<li>Integer options are initialized to the minimum valid value they can hold.</li> 240<li>Enum options are initialized to the first element in the list of values they can take.</li> 241<li>String options are initialized to the name of the option.</li> 242</ul> 243<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl> 244 245</div> 246</div> 247<a class="anchor" id="ad981c2efab849e76dc878ef8da9d6017"></a> 248<div class="memitem"> 249<div class="memproto"> 250 <table class="memname"> 251 <tr> 252 <td class="memname">int SDLVisualTest_MakeStrFromVariation </td> 253 <td>(</td> 254 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___variation.html">SDLVisualTest_Variation</a> * </td> 255 <td class="paramname"><em>variation</em>, </td> 256 </tr> 257 <tr> 258 <td class="paramkey"></td> 259 <td></td> 260 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a> * </td> 261 <td class="paramname"><em>config</em>, </td> 262 </tr> 263 <tr> 264 <td class="paramkey"></td> 265 <td></td> 266 <td class="paramtype">char * </td> 267 <td class="paramname"><em>buffer</em>, </td> 268 </tr> 269 <tr> 270 <td class="paramkey"></td> 271 <td></td> 272 <td class="paramtype">int </td> 273 <td class="paramname"><em>size</em> </td> 274 </tr> 275 <tr> 276 <td></td> 277 <td>)</td> 278 <td></td><td></td> 279 </tr> 280 </table> 281</div><div class="memdoc"> 282<p>Converts a variation object into a string of command line arguments.</p> 283<dl class="params"><dt>Parameters</dt><dd> 284 <table class="params"> 285 <tr><td class="paramname">variation</td><td>Variation object to be converted. </td></tr> 286 <tr><td class="paramname">config</td><td>Config object for the SUT. </td></tr> 287 <tr><td class="paramname">buffer</td><td>Pointer to the buffer the arguments string will be copied into. </td></tr> 288 <tr><td class="paramname">size</td><td>Size of the buffer.</td></tr> 289 </table> 290 </dd> 291</dl> 292<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure </dd></dl> 293 294</div> 295</div> 296<a class="anchor" id="aafcecc06c8feb24b6f6a509bfa9db681"></a> 297<div class="memitem"> 298<div class="memproto"> 299 <table class="memname"> 300 <tr> 301 <td class="memname">int SDLVisualTest_NextValue </td> 302 <td>(</td> 303 <td class="paramtype"><a class="el" href="union_s_d_l_visual_test___s_u_t_option_value.html">SDLVisualTest_SUTOptionValue</a> * </td> 304 <td class="paramname"><em>var</em>, </td> 305 </tr> 306 <tr> 307 <td class="paramkey"></td> 308 <td></td> 309 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___s_u_t_option.html">SDLVisualTest_SUTOption</a> * </td> 310 <td class="paramname"><em>opt</em> </td> 311 </tr> 312 <tr> 313 <td></td> 314 <td>)</td> 315 <td></td><td></td> 316 </tr> 317 </table> 318</div><div class="memdoc"> 319<p>"Increments" the value of the option by one and returns the carry. We wrap around to the initial value on overflow which makes the carry one. For example: "incrementing" an SDL_FALSE option makes it SDL_TRUE with no carry, and "incrementing" an SDL_TRUE option makes it SDL_FALSE with carry one. For integers, a random value in the valid range for the option is used.</p> 320<dl class="params"><dt>Parameters</dt><dd> 321 <table class="params"> 322 <tr><td class="paramname">var</td><td>Value of the option </td></tr> 323 <tr><td class="paramname">opt</td><td>Object with metadata about the option</td></tr> 324 </table> 325 </dd> 326</dl> 327<dl class="section return"><dt>Returns</dt><dd>1 if there is a carry for enum and bool type options, 0 otherwise. 1 is always returned for integer and string type options. -1 is returned on error. </dd></dl> 328 329</div> 330</div> 331</div><!-- contents --> 332<!-- start footer part --> 333<hr class="footer"/><address class="footer"><small> 334Generated on Thu Sep 26 2013 00:18:23 for SDL Visual Test by  <a href="http://www.doxygen.org/index.html"> 335<img class="footer" src="doxygen.png" alt="doxygen"/> 336</a> 1.8.4 337</small></address> 338</body> 339</html>