action__configparser_8c.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301
  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">
  35. var 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&#160;Page</span></a></li>
  40. <li><a href="annotated.html"><span>Data&#160;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&#160;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">&#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>
  72. <!-- iframe showing the search results (closed by default) -->
  73. <div id="MSearchResultsWindow">
  74. <iframe src="javascript:void(0)" frameborder="0"
  75. name="MSearchResults" id="MSearchResults">
  76. </iframe>
  77. </div>
  78. <div id="nav-path" class="navpath">
  79. <ul>
  80. <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
  81. </div>
  82. </div><!-- top -->
  83. <div class="header">
  84. <div class="summary">
  85. <a href="#func-members">Functions</a> </div>
  86. <div class="headertitle">
  87. <div class="title">action_configparser.c File Reference</div> </div>
  88. </div><!--header-->
  89. <div class="contents">
  90. <div class="textblock"><code>#include &lt;SDL_stdinc.h&gt;</code><br/>
  91. <code>#include &lt;SDL_test.h&gt;</code><br/>
  92. <code>#include &lt;string.h&gt;</code><br/>
  93. <code>#include &quot;<a class="el" href="_s_d_l__visualtest__action__configparser_8h_source.html">SDL_visualtest_action_configparser.h</a>&quot;</code><br/>
  94. <code>#include &quot;SDL_visualtest_rwhelper.h&quot;</code><br/>
  95. <code>#include &quot;<a class="el" href="_s_d_l__visualtest__parsehelper_8h_source.html">SDL_visualtest_parsehelper.h</a>&quot;</code><br/>
  96. </div><table class="memberdecls">
  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  98. Functions</h2></td></tr>
  99. <tr class="memitem:a647d1be8f0f27af2fb1e5d4da2100596"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  100. <tr class="separator:a647d1be8f0f27af2fb1e5d4da2100596"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a0e7998533e6e10590612a8d5dee7ec0b"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  102. <tr class="separator:a0e7998533e6e10590612a8d5dee7ec0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:ae68c1c80f728e125869882139bec2c9e"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  104. <tr class="separator:ae68c1c80f728e125869882139bec2c9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <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> *&#160;</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>
  106. <tr class="separator:afb508801942e7c74084480bcdb6f8613"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a8484ee36f78952192d4193c85fca2f17"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  108. <tr class="separator:a8484ee36f78952192d4193c85fca2f17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a677da0d0e4793df342f91974b4559efa"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  110. <tr class="separator:a677da0d0e4793df342f91974b4559efa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:ace5374ef7509e95383929ff185aaf7e6"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  112. <tr class="separator:ace5374ef7509e95383929ff185aaf7e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a8ef9dce4d464d6994596deeace6ffa2d"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  114. <tr class="separator:a8ef9dce4d464d6994596deeace6ffa2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. </table>
  116. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  117. <div class="textblock"><p>Source file for the parser for action config files. </p>
  118. </div><h2 class="groupheader">Function Documentation</h2>
  119. <a class="anchor" id="a0e7998533e6e10590612a8d5dee7ec0b"></a>
  120. <div class="memitem">
  121. <div class="memproto">
  122. <table class="memname">
  123. <tr>
  124. <td class="memname">int SDLVisualTest_DequeueAction </td>
  125. <td>(</td>
  126. <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> *&#160;</td>
  127. <td class="paramname"><em>queue</em>)</td><td></td>
  128. <td></td>
  129. </tr>
  130. </table>
  131. </div><div class="memdoc">
  132. <p>Remove an action from the front of the action queue pointed to by <code>queue</code>.</p>
  133. <dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl>
  134. </div>
  135. </div>
  136. <a class="anchor" id="a677da0d0e4793df342f91974b4559efa"></a>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">void SDLVisualTest_EmptyActionQueue </td>
  142. <td>(</td>
  143. <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> *&#160;</td>
  144. <td class="paramname"><em>queue</em>)</td><td></td>
  145. <td></td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. <p>Dequeues all the elements in the queque pointed to by <code>queue</code>. </p>
  150. </div>
  151. </div>
  152. <a class="anchor" id="a647d1be8f0f27af2fb1e5d4da2100596"></a>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="memname">
  156. <tr>
  157. <td class="memname">int SDLVisualTest_EnqueueAction </td>
  158. <td>(</td>
  159. <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> *&#160;</td>
  160. <td class="paramname"><em>queue</em>, </td>
  161. </tr>
  162. <tr>
  163. <td class="paramkey"></td>
  164. <td></td>
  165. <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action.html">SDLVisualTest_Action</a>&#160;</td>
  166. <td class="paramname"><em>action</em>&#160;</td>
  167. </tr>
  168. <tr>
  169. <td></td>
  170. <td>)</td>
  171. <td></td><td></td>
  172. </tr>
  173. </table>
  174. </div><div class="memdoc">
  175. <p>Add an action pointed to by <code>action</code> to the rear of the action queue pointed to by <code>queue</code>.</p>
  176. <dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl>
  177. </div>
  178. </div>
  179. <a class="anchor" id="afb508801942e7c74084480bcdb6f8613"></a>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname"><a class="el" href="struct_s_d_l_visual_test___action.html">SDLVisualTest_Action</a>* SDLVisualTest_GetQueueFront </td>
  185. <td>(</td>
  186. <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> *&#160;</td>
  187. <td class="paramname"><em>queue</em>)</td><td></td>
  188. <td></td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. <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>
  193. <dl class="section return"><dt>Returns</dt><dd>pointer to the action on success, NULL on failure. </dd></dl>
  194. </div>
  195. </div>
  196. <a class="anchor" id="ae68c1c80f728e125869882139bec2c9e"></a>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname">void SDLVisualTest_InitActionQueue </td>
  202. <td>(</td>
  203. <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> *&#160;</td>
  204. <td class="paramname"><em>queue</em>)</td><td></td>
  205. <td></td>
  206. </tr>
  207. </table>
  208. </div><div class="memdoc">
  209. <p>Initialize the action queue pointed to by <code>queue</code>. </p>
  210. </div>
  211. </div>
  212. <a class="anchor" id="ace5374ef7509e95383929ff185aaf7e6"></a>
  213. <div class="memitem">
  214. <div class="memproto">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">int SDLVisualTest_InsertIntoActionQueue </td>
  218. <td>(</td>
  219. <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> *&#160;</td>
  220. <td class="paramname"><em>queue</em>, </td>
  221. </tr>
  222. <tr>
  223. <td class="paramkey"></td>
  224. <td></td>
  225. <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action.html">SDLVisualTest_Action</a>&#160;</td>
  226. <td class="paramname"><em>action</em>&#160;</td>
  227. </tr>
  228. <tr>
  229. <td></td>
  230. <td>)</td>
  231. <td></td><td></td>
  232. </tr>
  233. </table>
  234. </div><div class="memdoc">
  235. <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>
  236. <dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl>
  237. </div>
  238. </div>
  239. <a class="anchor" id="a8484ee36f78952192d4193c85fca2f17"></a>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">int SDLVisualTest_IsActionQueueEmpty </td>
  245. <td>(</td>
  246. <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> *&#160;</td>
  247. <td class="paramname"><em>queue</em>)</td><td></td>
  248. <td></td>
  249. </tr>
  250. </table>
  251. </div><div class="memdoc">
  252. <p>Check if the queue pointed to by <code>queue</code> is empty or not.</p>
  253. <dl class="section return"><dt>Returns</dt><dd>1 if the queue is empty, 0 otherwise. </dd></dl>
  254. </div>
  255. </div>
  256. <a class="anchor" id="a8ef9dce4d464d6994596deeace6ffa2d"></a>
  257. <div class="memitem">
  258. <div class="memproto">
  259. <table class="memname">
  260. <tr>
  261. <td class="memname">int SDLVisualTest_ParseActionConfig </td>
  262. <td>(</td>
  263. <td class="paramtype">char *&#160;</td>
  264. <td class="paramname"><em>file</em>, </td>
  265. </tr>
  266. <tr>
  267. <td class="paramkey"></td>
  268. <td></td>
  269. <td class="paramtype"><a class="el" href="struct_s_d_l_visual_test___action_queue.html">SDLVisualTest_ActionQueue</a> *&#160;</td>
  270. <td class="paramname"><em>queue</em>&#160;</td>
  271. </tr>
  272. <tr>
  273. <td></td>
  274. <td>)</td>
  275. <td></td><td></td>
  276. </tr>
  277. </table>
  278. </div><div class="memdoc">
  279. <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>
  280. <dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl>
  281. </div>
  282. </div>
  283. </div><!-- contents -->
  284. <!-- start footer part -->
  285. <hr class="footer"/><address class="footer"><small>
  286. Generated on Thu Sep 26 2013 00:18:23 for SDL Visual Test by &#160;<a href="http://www.doxygen.org/index.html">
  287. <img class="footer" src="doxygen.png" alt="doxygen"/>
  288. </a> 1.8.4
  289. </small></address>
  290. </body>
  291. </html>