kc3-lang/SDL/visualtest/docs/html/action__configparser_8c.html
-
Show log
Commit
-
Hash : 3dcb451f
Author :
Date : 2014-04-09T21:29:19
Added a README file regarding WinRT support To note, this file is currently formatted with CRLF line endings, rather than LF, to allow the file to be viewed with Notepad.
-
visualtest/docs/html/action__configparser_8c.html
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
<!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/src/action_configparser.c 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 Page</span></a></li> <li><a href="annotated.html"><span>Data 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 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"> </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> <!-- 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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">action_configparser.c File Reference</div> </div> </div><!--header--> <div class="contents"> <div class="textblock"><code>#include <SDL_stdinc.h></code><br/> <code>#include <SDL_test.h></code><br/> <code>#include <string.h></code><br/> <code>#include "<a class="el" href="_s_d_l__visualtest__action__configparser_8h_source.html">SDL_visualtest_action_configparser.h</a>"</code><br/> <code>#include "SDL_visualtest_rwhelper.h"</code><br/> <code>#include "<a class="el" href="_s_d_l__visualtest__parsehelper_8h_source.html">SDL_visualtest_parsehelper.h</a>"</code><br/> </div><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <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> <tr class="separator:a647d1be8f0f27af2fb1e5d4da2100596"><td class="memSeparator" colspan="2"> </td></tr> <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> <tr class="separator:a0e7998533e6e10590612a8d5dee7ec0b"><td class="memSeparator" colspan="2"> </td></tr> <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> <tr class="separator:ae68c1c80f728e125869882139bec2c9e"><td class="memSeparator" colspan="2"> </td></tr> <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> <tr class="separator:afb508801942e7c74084480bcdb6f8613"><td class="memSeparator" colspan="2"> </td></tr> <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> <tr class="separator:a8484ee36f78952192d4193c85fca2f17"><td class="memSeparator" colspan="2"> </td></tr> <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> <tr class="separator:a677da0d0e4793df342f91974b4559efa"><td class="memSeparator" colspan="2"> </td></tr> <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> <tr class="separator:ace5374ef7509e95383929ff185aaf7e6"><td class="memSeparator" colspan="2"> </td></tr> <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> <tr class="separator:a8ef9dce4d464d6994596deeace6ffa2d"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Source file for the parser for action config files. </p> </div><h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="a0e7998533e6e10590612a8d5dee7ec0b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int SDLVisualTest_DequeueAction </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> * </td> <td class="paramname"><em>queue</em>)</td><td></td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Remove an action from the front of the action queue pointed to by <code>queue</code>.</p> <dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl> </div> </div> <a class="anchor" id="a677da0d0e4793df342f91974b4559efa"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void SDLVisualTest_EmptyActionQueue </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> * </td> <td class="paramname"><em>queue</em>)</td><td></td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Dequeues all the elements in the queque pointed to by <code>queue</code>. </p> </div> </div> <a class="anchor" id="a647d1be8f0f27af2fb1e5d4da2100596"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int SDLVisualTest_EnqueueAction </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> * </td> <td class="paramname"><em>queue</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action.html">SDLVisualTest_Action</a> </td> <td class="paramname"><em>action</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Add an action pointed to by <code>action</code> to the rear of the action queue pointed to by <code>queue</code>.</p> <dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl> </div> </div> <a class="anchor" id="afb508801942e7c74084480bcdb6f8613"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="struct_s_d_l_visual_test___action.html">SDLVisualTest_Action</a>* SDLVisualTest_GetQueueFront </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> * </td> <td class="paramname"><em>queue</em>)</td><td></td> <td></td> </tr> </table> </div><div class="memdoc"> <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> <dl class="section return"><dt>Returns</dt><dd>pointer to the action on success, NULL on failure. </dd></dl> </div> </div> <a class="anchor" id="ae68c1c80f728e125869882139bec2c9e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void SDLVisualTest_InitActionQueue </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> * </td> <td class="paramname"><em>queue</em>)</td><td></td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Initialize the action queue pointed to by <code>queue</code>. </p> </div> </div> <a class="anchor" id="ace5374ef7509e95383929ff185aaf7e6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int SDLVisualTest_InsertIntoActionQueue </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> * </td> <td class="paramname"><em>queue</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action.html">SDLVisualTest_Action</a> </td> <td class="paramname"><em>action</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <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> <dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl> </div> </div> <a class="anchor" id="a8484ee36f78952192d4193c85fca2f17"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int SDLVisualTest_IsActionQueueEmpty </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> * </td> <td class="paramname"><em>queue</em>)</td><td></td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Check if the queue pointed to by <code>queue</code> is empty or not.</p> <dl class="section return"><dt>Returns</dt><dd>1 if the queue is empty, 0 otherwise. </dd></dl> </div> </div> <a class="anchor" id="a8ef9dce4d464d6994596deeace6ffa2d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int SDLVisualTest_ParseActionConfig </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"><em>file</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> * </td> <td class="paramname"><em>queue</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <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> <dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </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  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.4 </small></address> </body> </html>