encounter
/
SDL
mirror of https://github.com/encounter/SDL.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
SDL/visualtest/docs/html/action__configparser_8c.html

302 lines
17 KiB
HTML
Executable File
Raw Blame History

<!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&#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_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 &lt;SDL_stdinc.h&gt;</code><br/>
<code>#include &lt;SDL_test.h&gt;</code><br/>
<code>#include &lt;string.h&gt;</code><br/>
<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/>
<code>#include &quot;SDL_visualtest_rwhelper.h&quot;</code><br/>
<code>#include &quot;<a class="el" href="_s_d_l__visualtest__parsehelper_8h_source.html">SDL_visualtest_parsehelper.h</a>&quot;</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&#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>
<tr class="separator:a647d1be8f0f27af2fb1e5d4da2100596"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a0e7998533e6e10590612a8d5dee7ec0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ae68c1c80f728e125869882139bec2c9e"><td class="memSeparator" colspan="2">&#160;</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> *&#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>
<tr class="separator:afb508801942e7c74084480bcdb6f8613"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a8484ee36f78952192d4193c85fca2f17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a677da0d0e4793df342f91974b4559efa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ace5374ef7509e95383929ff185aaf7e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a8ef9dce4d464d6994596deeace6ffa2d"><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>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> *&#160;</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> *&#160;</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> *&#160;</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>&#160;</td>
<td class="paramname"><em>action</em>&#160;</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> *&#160;</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> *&#160;</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> *&#160;</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>&#160;</td>
<td class="paramname"><em>action</em>&#160;</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> *&#160;</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 *&#160;</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> *&#160;</td>
<td class="paramname"><em>queue</em>&#160;</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 &#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>
Reference in New Issue View Git Blame Copy Permalink