action__configparser_8c.html (17306B)
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/action_configparser.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">action_configparser.c File Reference</div> </div> 90</div><!--header--> 91<div class="contents"> 92<div class="textblock"><code>#include <SDL_stdinc.h></code><br/> 93<code>#include <SDL_test.h></code><br/> 94<code>#include <string.h></code><br/> 95<code>#include "<a class="el" href="_s_d_l__visualtest__action__configparser_8h_source.html">SDL_visualtest_action_configparser.h</a>"</code><br/> 96<code>#include "SDL_visualtest_rwhelper.h"</code><br/> 97<code>#include "<a class="el" href="_s_d_l__visualtest__parsehelper_8h_source.html">SDL_visualtest_parsehelper.h</a>"</code><br/> 98</div><table class="memberdecls"> 99<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 100Functions</h2></td></tr> 101<tr class="memitem:a647d1be8f0f27af2fb1e5d4da2100596"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="action__configparser_8c.html#a647d1be8f0f27af2fb1e5d4da2100596">SDLVisualTest_EnqueueAction</a> (<a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> *queue, <a class="el" href="struct_s_d_l_visual_test___action.html">SDLVisualTest_Action</a> action)</td></tr> 102<tr class="separator:a647d1be8f0f27af2fb1e5d4da2100596"><td class="memSeparator" colspan="2"> </td></tr> 103<tr class="memitem:a0e7998533e6e10590612a8d5dee7ec0b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="action__configparser_8c.html#a0e7998533e6e10590612a8d5dee7ec0b">SDLVisualTest_DequeueAction</a> (<a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> *queue)</td></tr> 104<tr class="separator:a0e7998533e6e10590612a8d5dee7ec0b"><td class="memSeparator" colspan="2"> </td></tr> 105<tr class="memitem:ae68c1c80f728e125869882139bec2c9e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="action__configparser_8c.html#ae68c1c80f728e125869882139bec2c9e">SDLVisualTest_InitActionQueue</a> (<a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> *queue)</td></tr> 106<tr class="separator:ae68c1c80f728e125869882139bec2c9e"><td class="memSeparator" colspan="2"> </td></tr> 107<tr class="memitem:afb508801942e7c74084480bcdb6f8613"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_s_d_l_visual_test___action.html">SDLVisualTest_Action</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="action__configparser_8c.html#afb508801942e7c74084480bcdb6f8613">SDLVisualTest_GetQueueFront</a> (<a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> *queue)</td></tr> 108<tr class="separator:afb508801942e7c74084480bcdb6f8613"><td class="memSeparator" colspan="2"> </td></tr> 109<tr class="memitem:a8484ee36f78952192d4193c85fca2f17"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="action__configparser_8c.html#a8484ee36f78952192d4193c85fca2f17">SDLVisualTest_IsActionQueueEmpty</a> (<a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> *queue)</td></tr> 110<tr class="separator:a8484ee36f78952192d4193c85fca2f17"><td class="memSeparator" colspan="2"> </td></tr> 111<tr class="memitem:a677da0d0e4793df342f91974b4559efa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="action__configparser_8c.html#a677da0d0e4793df342f91974b4559efa">SDLVisualTest_EmptyActionQueue</a> (<a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> *queue)</td></tr> 112<tr class="separator:a677da0d0e4793df342f91974b4559efa"><td class="memSeparator" colspan="2"> </td></tr> 113<tr class="memitem:ace5374ef7509e95383929ff185aaf7e6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="action__configparser_8c.html#ace5374ef7509e95383929ff185aaf7e6">SDLVisualTest_InsertIntoActionQueue</a> (<a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> *queue, <a class="el" href="struct_s_d_l_visual_test___action.html">SDLVisualTest_Action</a> action)</td></tr> 114<tr class="separator:ace5374ef7509e95383929ff185aaf7e6"><td class="memSeparator" colspan="2"> </td></tr> 115<tr class="memitem:a8ef9dce4d464d6994596deeace6ffa2d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="action__configparser_8c.html#a8ef9dce4d464d6994596deeace6ffa2d">SDLVisualTest_ParseActionConfig</a> (char *file, <a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> *queue)</td></tr> 116<tr class="separator:a8ef9dce4d464d6994596deeace6ffa2d"><td class="memSeparator" colspan="2"> </td></tr> 117</table> 118<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 119<div class="textblock"><p>Source file for the parser for action config files. </p> 120</div><h2 class="groupheader">Function Documentation</h2> 121<a class="anchor" id="a0e7998533e6e10590612a8d5dee7ec0b"></a> 122<div class="memitem"> 123<div class="memproto"> 124 <table class="memname"> 125 <tr> 126 <td class="memname">int SDLVisualTest_DequeueAction </td> 127 <td>(</td> 128 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> * </td> 129 <td class="paramname"><em>queue</em>)</td><td></td> 130 <td></td> 131 </tr> 132 </table> 133</div><div class="memdoc"> 134<p>Remove an action from the front of the action queue pointed to by <code>queue</code>.</p> 135<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl> 136 137</div> 138</div> 139<a class="anchor" id="a677da0d0e4793df342f91974b4559efa"></a> 140<div class="memitem"> 141<div class="memproto"> 142 <table class="memname"> 143 <tr> 144 <td class="memname">void SDLVisualTest_EmptyActionQueue </td> 145 <td>(</td> 146 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> * </td> 147 <td class="paramname"><em>queue</em>)</td><td></td> 148 <td></td> 149 </tr> 150 </table> 151</div><div class="memdoc"> 152<p>Dequeues all the elements in the queque pointed to by <code>queue</code>. </p> 153 154</div> 155</div> 156<a class="anchor" id="a647d1be8f0f27af2fb1e5d4da2100596"></a> 157<div class="memitem"> 158<div class="memproto"> 159 <table class="memname"> 160 <tr> 161 <td class="memname">int SDLVisualTest_EnqueueAction </td> 162 <td>(</td> 163 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> * </td> 164 <td class="paramname"><em>queue</em>, </td> 165 </tr> 166 <tr> 167 <td class="paramkey"></td> 168 <td></td> 169 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action.html">SDLVisualTest_Action</a> </td> 170 <td class="paramname"><em>action</em> </td> 171 </tr> 172 <tr> 173 <td></td> 174 <td>)</td> 175 <td></td><td></td> 176 </tr> 177 </table> 178</div><div class="memdoc"> 179<p>Add an action pointed to by <code>action</code> to the rear of the action queue pointed to by <code>queue</code>.</p> 180<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl> 181 182</div> 183</div> 184<a class="anchor" id="afb508801942e7c74084480bcdb6f8613"></a> 185<div class="memitem"> 186<div class="memproto"> 187 <table class="memname"> 188 <tr> 189 <td class="memname"><a class="el" href="struct_s_d_l_visual_test___action.html">SDLVisualTest_Action</a>* SDLVisualTest_GetQueueFront </td> 190 <td>(</td> 191 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> * </td> 192 <td class="paramname"><em>queue</em>)</td><td></td> 193 <td></td> 194 </tr> 195 </table> 196</div><div class="memdoc"> 197<p>Get the action at the front of the action queue pointed to by <code>queue</code>. The returned action pointer may become invalid after subsequent dequeues.</p> 198<dl class="section return"><dt>Returns</dt><dd>pointer to the action on success, NULL on failure. </dd></dl> 199 200</div> 201</div> 202<a class="anchor" id="ae68c1c80f728e125869882139bec2c9e"></a> 203<div class="memitem"> 204<div class="memproto"> 205 <table class="memname"> 206 <tr> 207 <td class="memname">void SDLVisualTest_InitActionQueue </td> 208 <td>(</td> 209 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> * </td> 210 <td class="paramname"><em>queue</em>)</td><td></td> 211 <td></td> 212 </tr> 213 </table> 214</div><div class="memdoc"> 215<p>Initialize the action queue pointed to by <code>queue</code>. </p> 216 217</div> 218</div> 219<a class="anchor" id="ace5374ef7509e95383929ff185aaf7e6"></a> 220<div class="memitem"> 221<div class="memproto"> 222 <table class="memname"> 223 <tr> 224 <td class="memname">int SDLVisualTest_InsertIntoActionQueue </td> 225 <td>(</td> 226 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> * </td> 227 <td class="paramname"><em>queue</em>, </td> 228 </tr> 229 <tr> 230 <td class="paramkey"></td> 231 <td></td> 232 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action.html">SDLVisualTest_Action</a> </td> 233 <td class="paramname"><em>action</em> </td> 234 </tr> 235 <tr> 236 <td></td> 237 <td>)</td> 238 <td></td><td></td> 239 </tr> 240 </table> 241</div><div class="memdoc"> 242<p>Inserts an action <code>action</code> into the queue pointed to by <code>queue</code> such that the times of actions in the queue increase as we move from the front to the rear.</p> 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="a8484ee36f78952192d4193c85fca2f17"></a> 248<div class="memitem"> 249<div class="memproto"> 250 <table class="memname"> 251 <tr> 252 <td class="memname">int SDLVisualTest_IsActionQueueEmpty </td> 253 <td>(</td> 254 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> * </td> 255 <td class="paramname"><em>queue</em>)</td><td></td> 256 <td></td> 257 </tr> 258 </table> 259</div><div class="memdoc"> 260<p>Check if the queue pointed to by <code>queue</code> is empty or not.</p> 261<dl class="section return"><dt>Returns</dt><dd>1 if the queue is empty, 0 otherwise. </dd></dl> 262 263</div> 264</div> 265<a class="anchor" id="a8ef9dce4d464d6994596deeace6ffa2d"></a> 266<div class="memitem"> 267<div class="memproto"> 268 <table class="memname"> 269 <tr> 270 <td class="memname">int SDLVisualTest_ParseActionConfig </td> 271 <td>(</td> 272 <td class="paramtype">char * </td> 273 <td class="paramname"><em>file</em>, </td> 274 </tr> 275 <tr> 276 <td class="paramkey"></td> 277 <td></td> 278 <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> * </td> 279 <td class="paramname"><em>queue</em> </td> 280 </tr> 281 <tr> 282 <td></td> 283 <td>)</td> 284 <td></td><td></td> 285 </tr> 286 </table> 287</div><div class="memdoc"> 288<p>Parses an action config file with path <code>file</code> and populates an action queue pointed to by <code>queue</code> with actions.</p> 289<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl> 290 291</div> 292</div> 293</div><!-- contents --> 294<!-- start footer part --> 295<hr class="footer"/><address class="footer"><small> 296Generated on Thu Sep 26 2013 00:18:23 for SDL Visual Test by  <a href="http://www.doxygen.org/index.html"> 297<img class="footer" src="doxygen.png" alt="doxygen"/> 298</a> 1.8.4 299</small></address> 300</body> 301</html>