variator__common_8c.html (12676B)
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/variator_common.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="#func-members">Functions</a> </div> 88 <div class="headertitle"> 89<div class="title">variator_common.c File Reference</div> </div> 90</div><!--header--> 91<div class="contents"> 92<div class="textblock"><code>#include <SDL_test.h></code><br/> 93<code>#include "<a class="el" href="_s_d_l__visualtest__variator__common_8h_source.html">SDL_visualtest_variator_common.h</a>"</code><br/> 94</div><table class="memberdecls"> 95<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 96Functions</h2></td></tr> 97<tr class="memitem:aafcecc06c8feb24b6f6a509bfa9db681"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="variator__common_8c.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> 98<tr class="separator:aafcecc06c8feb24b6f6a509bfa9db681"><td class="memSeparator" colspan="2"> </td></tr> 99<tr class="memitem:ad981c2efab849e76dc878ef8da9d6017"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="variator__common_8c.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> 100<tr class="separator:ad981c2efab849e76dc878ef8da9d6017"><td class="memSeparator" colspan="2"> </td></tr> 101<tr class="memitem:ac87934906c51364778dc910ebca47b6c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="variator__common_8c.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> 102<tr class="separator:ac87934906c51364778dc910ebca47b6c"><td class="memSeparator" colspan="2"> </td></tr> 103</table> 104<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 105<div class="textblock"><p>Source file for some common functionality used by variators. </p> 106</div><h2 class="groupheader">Function Documentation</h2> 107<a class="anchor" id="ac87934906c51364778dc910ebca47b6c"></a> 108<div class="memitem"> 109<div class="memproto"> 110 <table class="memname"> 111 <tr> 112 <td class="memname">int SDLVisualTest_InitVariation </td> 113 <td>(</td> 114 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___variation.html">SDLVisualTest_Variation</a> * </td> 115 <td class="paramname"><em>variation</em>, </td> 116 </tr> 117 <tr> 118 <td class="paramkey"></td> 119 <td></td> 120 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a> * </td> 121 <td class="paramname"><em>config</em> </td> 122 </tr> 123 <tr> 124 <td></td> 125 <td>)</td> 126 <td></td><td></td> 127 </tr> 128 </table> 129</div><div class="memdoc"> 130<p>Initializes the variation using the following rules:</p> 131<ul> 132<li>Boolean options are initialized to SDL_FALSE.</li> 133<li>Integer options are initialized to the minimum valid value they can hold.</li> 134<li>Enum options are initialized to the first element in the list of values they can take.</li> 135<li>String options are initialized to the name of the option.</li> 136</ul> 137<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl> 138 139</div> 140</div> 141<a class="anchor" id="ad981c2efab849e76dc878ef8da9d6017"></a> 142<div class="memitem"> 143<div class="memproto"> 144 <table class="memname"> 145 <tr> 146 <td class="memname">int SDLVisualTest_MakeStrFromVariation </td> 147 <td>(</td> 148 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___variation.html">SDLVisualTest_Variation</a> * </td> 149 <td class="paramname"><em>variation</em>, </td> 150 </tr> 151 <tr> 152 <td class="paramkey"></td> 153 <td></td> 154 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___s_u_t_config.html">SDLVisualTest_SUTConfig</a> * </td> 155 <td class="paramname"><em>config</em>, </td> 156 </tr> 157 <tr> 158 <td class="paramkey"></td> 159 <td></td> 160 <td class="paramtype">char * </td> 161 <td class="paramname"><em>buffer</em>, </td> 162 </tr> 163 <tr> 164 <td class="paramkey"></td> 165 <td></td> 166 <td class="paramtype">int </td> 167 <td class="paramname"><em>size</em> </td> 168 </tr> 169 <tr> 170 <td></td> 171 <td>)</td> 172 <td></td><td></td> 173 </tr> 174 </table> 175</div><div class="memdoc"> 176<p>Converts a variation object into a string of command line arguments.</p> 177<dl class="params"><dt>Parameters</dt><dd> 178 <table class="params"> 179 <tr><td class="paramname">variation</td><td>Variation object to be converted. </td></tr> 180 <tr><td class="paramname">config</td><td>Config object for the SUT. </td></tr> 181 <tr><td class="paramname">buffer</td><td>Pointer to the buffer the arguments string will be copied into. </td></tr> 182 <tr><td class="paramname">size</td><td>Size of the buffer.</td></tr> 183 </table> 184 </dd> 185</dl> 186<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure </dd></dl> 187 188</div> 189</div> 190<a class="anchor" id="aafcecc06c8feb24b6f6a509bfa9db681"></a> 191<div class="memitem"> 192<div class="memproto"> 193 <table class="memname"> 194 <tr> 195 <td class="memname">int SDLVisualTest_NextValue </td> 196 <td>(</td> 197 <td class="paramtype"><a class="el" href="union_s_d_l_visual_test___s_u_t_option_value.html">SDLVisualTest_SUTOptionValue</a> * </td> 198 <td class="paramname"><em>var</em>, </td> 199 </tr> 200 <tr> 201 <td class="paramkey"></td> 202 <td></td> 203 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___s_u_t_option.html">SDLVisualTest_SUTOption</a> * </td> 204 <td class="paramname"><em>opt</em> </td> 205 </tr> 206 <tr> 207 <td></td> 208 <td>)</td> 209 <td></td><td></td> 210 </tr> 211 </table> 212</div><div class="memdoc"> 213<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> 214<dl class="params"><dt>Parameters</dt><dd> 215 <table class="params"> 216 <tr><td class="paramname">var</td><td>Value of the option </td></tr> 217 <tr><td class="paramname">opt</td><td>Object with metadata about the option</td></tr> 218 </table> 219 </dd> 220</dl> 221<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> 222 223</div> 224</div> 225</div><!-- contents --> 226<!-- start footer part --> 227<hr class="footer"/><address class="footer"><small> 228Generated on Thu Sep 26 2013 00:18:24 for SDL Visual Test by  <a href="http://www.doxygen.org/index.html"> 229<img class="footer" src="doxygen.png" alt="doxygen"/> 230</a> 1.8.4 231</small></address> 232</body> 233</html>