Google Git
Sign in
skia / external / github.com / libsdl-org / SDL / 9e67444a363e217773562fb687c2503ba4cf1d45 / . / visualtest / docs / html / _s_d_l__visualtest__variator__common_8h.html
blob: 018bcaa0bb9d3059605b9080926fbf801e85cff6 [file] [log] [blame]
<!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_variator_common.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&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Data&#160;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&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</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> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">SDL_visualtest_variator_common.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;SDL_types.h&gt;</code><br/>
<code>#include &quot;<a class="el" href="_s_d_l__visualtest__sut__configparser_8h_source.html">SDL_visualtest_sut_configparser.h</a>&quot;</code><br/>
</div>
<p><a href="_s_d_l__visualtest__variator__common_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">union &#160;</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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_s_d_l_visual_test___variation.html">SDLVisualTest_Variation</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:afcdce86a10fbcdc9f3e47c47b70e3ea3"><td class="memItemLeft" align="right" valign="top">#define&#160;</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>&#160;&#160;&#160;3</td></tr>
<tr class="separator:afcdce86a10fbcdc9f3e47c47b70e3ea3"><td class="memSeparator" colspan="2">&#160;</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:a4a7752dc89880ce3f62a478b3d0d8d64"><td class="memItemLeft" align="right" valign="top">typedef enum <br class="typebreak"/>
<a class="el" href="_s_d_l__visualtest__variator__common_8h.html#a04bfc880abe6940d69a63c06a33acdbd">SDLVisualTest_VariatorType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__variator__common_8h.html#a4a7752dc89880ce3f62a478b3d0d8d64">SDLVisualTest_VariatorType</a></td></tr>
<tr class="separator:a4a7752dc89880ce3f62a478b3d0d8d64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4e5fb752f4cd087101ea3e1f6124dfb"><td class="memItemLeft" align="right" valign="top">typedef union <br class="typebreak"/>
<a class="el" href="union_s_d_l_visual_test___s_u_t_option_value.html">SDLVisualTest_SUTOptionValue</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__variator__common_8h.html#aa4e5fb752f4cd087101ea3e1f6124dfb">SDLVisualTest_SUTOptionValue</a></td></tr>
<tr class="separator:aa4e5fb752f4cd087101ea3e1f6124dfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b447c1467862ecd623cc8f37489faeb"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="struct_s_d_l_visual_test___variation.html">SDLVisualTest_Variation</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__variator__common_8h.html#a6b447c1467862ecd623cc8f37489faeb">SDLVisualTest_Variation</a></td></tr>
<tr class="separator:a6b447c1467862ecd623cc8f37489faeb"><td class="memSeparator" colspan="2">&#160;</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:a04bfc880abe6940d69a63c06a33acdbd"><td class="memItemLeft" align="right" valign="top">enum &#160;</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,
<b>SDL_VARIATOR_EXHAUSTIVE</b>,
<b>SDL_VARIATOR_RANDOM</b>
}</td></tr>
<tr class="separator:a04bfc880abe6940d69a63c06a33acdbd"><td class="memSeparator" colspan="2">&#160;</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:aafcecc06c8feb24b6f6a509bfa9db681"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
<tr class="separator:aafcecc06c8feb24b6f6a509bfa9db681"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad981c2efab849e76dc878ef8da9d6017"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
<tr class="separator:ad981c2efab849e76dc878ef8da9d6017"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac87934906c51364778dc910ebca47b6c"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
<tr class="separator:ac87934906c51364778dc910ebca47b6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Header for common functionality used by variators. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="afcdce86a10fbcdc9f3e47c47b70e3ea3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SDL_SUT_INTEGER_OPTION_TEST_STEPS&#160;&#160;&#160;3</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of variations one integer option would generate </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="aa4e5fb752f4cd087101ea3e1f6124dfb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div><div class="memdoc">
<p>One possible value for a command line option to the SUT. </p>
</div>
</div>
<a class="anchor" id="a6b447c1467862ecd623cc8f37489faeb"></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___variation.html">SDLVisualTest_Variation</a> <a class="el" href="struct_s_d_l_visual_test___variation.html">SDLVisualTest_Variation</a></td>
</tr>
</table>
</div><div class="memdoc">
<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>
</div>
</div>
<a class="anchor" id="a4a7752dc89880ce3f62a478b3d0d8d64"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div><div class="memdoc">
<p>enum for indicating the type of variator being used </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a04bfc880abe6940d69a63c06a33acdbd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="_s_d_l__visualtest__variator__common_8h.html#a04bfc880abe6940d69a63c06a33acdbd">SDLVisualTest_VariatorType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>enum for indicating the type of variator being used </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ac87934906c51364778dc910ebca47b6c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int SDLVisualTest_InitVariation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___variation.html">SDLVisualTest_Variation</a> *&#160;</td>
<td class="paramname"><em>variation</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> *&#160;</td>
<td class="paramname"><em>config</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the variation using the following rules:</p>
<ul>
<li>Boolean options are initialized to SDL_FALSE.</li>
<li>Integer options are initialized to the minimum valid value they can hold.</li>
<li>Enum options are initialized to the first element in the list of values they can take.</li>
<li>String options are initialized to the name of the option.</li>
</ul>
<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="ad981c2efab849e76dc878ef8da9d6017"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int SDLVisualTest_MakeStrFromVariation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___variation.html">SDLVisualTest_Variation</a> *&#160;</td>
<td class="paramname"><em>variation</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> *&#160;</td>
<td class="paramname"><em>config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts a variation object into a string of command line arguments.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">variation</td><td>Variation object to be converted. </td></tr>
<tr><td class="paramname">config</td><td>Config object for the SUT. </td></tr>
<tr><td class="paramname">buffer</td><td>Pointer to the buffer the arguments string will be copied into. </td></tr>
<tr><td class="paramname">size</td><td>Size of the buffer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure </dd></dl>
</div>
</div>
<a class="anchor" id="aafcecc06c8feb24b6f6a509bfa9db681"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int SDLVisualTest_NextValue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="union_s_d_l_visual_test___s_u_t_option_value.html">SDLVisualTest_SUTOptionValue</a> *&#160;</td>
<td class="paramname"><em>var</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_option.html">SDLVisualTest_SUTOption</a> *&#160;</td>
<td class="paramname"><em>opt</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<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>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">var</td><td>Value of the option </td></tr>
<tr><td class="paramname">opt</td><td>Object with metadata about the option</td></tr>
</table>
</dd>
</dl>
<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>
</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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>