herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
archeus/doc/doxygen/html/d2/dbd/queue_8c.html

419 lines
35 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen 1.9.2-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" class="dark-mode">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Archeus: /home/herbglitch/programs/archeus/arc/src/std/queue.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="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../cookie.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
<link href="../../doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="../../doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="../../doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../doxygen-awesome-darkmode-toggle.js"></script>
</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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Archeus<span id="projectnumber">&#160;0.0.0</span>
</div>
<div id="projectbrief">A C library and game engine that focuses on documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(1); });
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('d2/dbd/queue_8c.html','../../'); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">queue.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="../../d8/d38/queue_8h_source.html">arc/std/queue.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d8/dc2/errno_8h_source.html">arc/std/errno.h</a>&quot;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
</div>
<p><a href="../../d2/dbd/queue_8c_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 id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/da2/structARC__QueueNode.html">ARC_QueueNode</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="../../d2/d32/structARC__Queue.html">ARC_Queue</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 id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ac5598ca23e4a3a22a9a0225ad3a3acb6" id="r_ac5598ca23e4a3a22a9a0225ad3a3acb6"><td class="memItemLeft" align="right" valign="top">typedef struct ARC_QueueNode&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac5598ca23e4a3a22a9a0225ad3a3acb6">ARC_QueueNode</a></td></tr>
<tr class="separator:ac5598ca23e4a3a22a9a0225ad3a3acb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae8b1146e12bbf3fb85323f3d142df0bf" id="r_ae8b1146e12bbf3fb85323f3d142df0bf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae8b1146e12bbf3fb85323f3d142df0bf">ARC_Queue_Create</a> (<a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> **queue)</td></tr>
<tr class="memdesc:ae8b1146e12bbf3fb85323f3d142df0bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">creates <a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> type <br /></td></tr>
<tr class="separator:ae8b1146e12bbf3fb85323f3d142df0bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a02c62a5c9ea508b2ad0f4f6512331d" id="r_a3a02c62a5c9ea508b2ad0f4f6512331d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3a02c62a5c9ea508b2ad0f4f6512331d">ARC_Queue_Destroy</a> (<a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> *queue)</td></tr>
<tr class="memdesc:a3a02c62a5c9ea508b2ad0f4f6512331d"><td class="mdescLeft">&#160;</td><td class="mdescRight">destroyes <a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> type <br /></td></tr>
<tr class="separator:a3a02c62a5c9ea508b2ad0f4f6512331d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a148faa7bfa969213e32a29aaf3799cd3" id="r_a148faa7bfa969213e32a29aaf3799cd3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a148faa7bfa969213e32a29aaf3799cd3">ARC_Queue_Push</a> (<a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> *queue, void *data)</td></tr>
<tr class="memdesc:a148faa7bfa969213e32a29aaf3799cd3"><td class="mdescLeft">&#160;</td><td class="mdescRight">pushes value to end of queue <br /></td></tr>
<tr class="separator:a148faa7bfa969213e32a29aaf3799cd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6dfacddca2614a104273d52726fb4bb9" id="r_a6dfacddca2614a104273d52726fb4bb9"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6dfacddca2614a104273d52726fb4bb9">ARC_Queue_Pop</a> (<a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> *queue)</td></tr>
<tr class="memdesc:a6dfacddca2614a104273d52726fb4bb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">pops the front off of the <a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> <br /></td></tr>
<tr class="separator:a6dfacddca2614a104273d52726fb4bb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a874a468cb3a68e9193618c9d2eac11b6" id="r_a874a468cb3a68e9193618c9d2eac11b6"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a874a468cb3a68e9193618c9d2eac11b6">ARC_Queue_Size</a> (<a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> *queue)</td></tr>
<tr class="memdesc:a874a468cb3a68e9193618c9d2eac11b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">gets size of queue <br /></td></tr>
<tr class="separator:a874a468cb3a68e9193618c9d2eac11b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ac5598ca23e4a3a22a9a0225ad3a3acb6" name="ac5598ca23e4a3a22a9a0225ad3a3acb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5598ca23e4a3a22a9a0225ad3a3acb6">&#9670;&#160;</a></span>ARC_QueueNode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct ARC_QueueNode ARC_QueueNode</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d2/dbd/queue_8c_source.html#l00006">6</a> of file <a class="el" href="../../d2/dbd/queue_8c_source.html">queue.c</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ae8b1146e12bbf3fb85323f3d142df0bf" name="ae8b1146e12bbf3fb85323f3d142df0bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8b1146e12bbf3fb85323f3d142df0bf">&#9670;&#160;</a></span>ARC_Queue_Create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Queue_Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> **</td> <td class="paramname"><span class="paramname"><em>queue</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>creates <a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">queue</td><td><a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> to initialize </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d2/dbd/queue_8c_source.html#l00018">18</a> of file <a class="el" href="../../d2/dbd/queue_8c_source.html">queue.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 18</span> {</div>
<div class="line"><span class="lineno"> 19</span> *queue = (<a class="code hl_struct" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> *)malloc(<span class="keyword">sizeof</span>(<a class="code hl_struct" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a>));</div>
<div class="line"><span class="lineno"> 20</span> (*queue)-&gt;<a class="code hl_variable" href="../../d2/d32/structARC__Queue.html#a2db56d1b37ef101ef0b5c5aea2b38ceb">currentSize</a> = 0;</div>
<div class="line"><span class="lineno"> 21</span> (*queue)-&gt;node = NULL;</div>
<div class="line"><span class="lineno"> 22</span>}</div>
<div class="ttc" id="astructARC__Queue_html"><div class="ttname"><a href="../../d2/d32/structARC__Queue.html">ARC_Queue</a></div><div class="ttdef"><b>Definition</b> <a href="../../d2/dbd/queue_8c_source.html#l00013">queue.c:13</a></div></div>
<div class="ttc" id="astructARC__Queue_html_a2db56d1b37ef101ef0b5c5aea2b38ceb"><div class="ttname"><a href="../../d2/d32/structARC__Queue.html#a2db56d1b37ef101ef0b5c5aea2b38ceb">ARC_Queue::currentSize</a></div><div class="ttdeci">uint32_t currentSize</div><div class="ttdef"><b>Definition</b> <a href="../../d2/dbd/queue_8c_source.html#l00014">queue.c:14</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="../../d2/dbd/queue_8c_source.html#l00014">ARC_Queue::currentSize</a>.</p>
</div>
</div>
<a id="a3a02c62a5c9ea508b2ad0f4f6512331d" name="a3a02c62a5c9ea508b2ad0f4f6512331d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a02c62a5c9ea508b2ad0f4f6512331d">&#9670;&#160;</a></span>ARC_Queue_Destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Queue_Destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> *</td> <td class="paramname"><span class="paramname"><em>queue</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>destroyes <a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> type </p>
<p class="definition">Definition at line <a class="el" href="../../d2/dbd/queue_8c_source.html#l00024">24</a> of file <a class="el" href="../../d2/dbd/queue_8c_source.html">queue.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 24</span> {</div>
<div class="line"><span class="lineno"> 25</span> <span class="keywordflow">if</span>(queue-&gt;<a class="code hl_variable" href="../../d2/d32/structARC__Queue.html#a2db56d1b37ef101ef0b5c5aea2b38ceb">currentSize</a> != 0 || queue-&gt;<a class="code hl_variable" href="../../d2/d32/structARC__Queue.html#aad38dc94dd6f7a359785f38db6d02ac7">node</a> != NULL){</div>
<div class="line"><span class="lineno"> 26</span> <a class="code hl_variable" href="../../d8/dc2/errno_8h.html#a5884aa8cc9b4e733345e49f93b54f75a">arc_errno</a> = <a class="code hl_define" href="../../d8/dc2/errno_8h.html#af21596945a4d9ac142fe4cfef53e7a80">ARC_ERRNO_DATA</a>;</div>
<div class="line"><span class="lineno"> 27</span> <a class="code hl_define" href="../../d8/dc2/errno_8h.html#ad32a4f194b90c9ede4e393c0d4185590">ARC_DEBUG_LOG_ERROR</a>(<span class="stringliteral">&quot;ARC_Queue_Destroy(queue) called, but queue was not empty&quot;</span>);</div>
<div class="line"><span class="lineno"> 28</span> <span class="keywordflow">return</span>;</div>
<div class="line"><span class="lineno"> 29</span> }</div>
<div class="line"><span class="lineno"> 30</span> </div>
<div class="line"><span class="lineno"> 31</span> free(queue);</div>
<div class="line"><span class="lineno"> 32</span>}</div>
<div class="ttc" id="aerrno_8h_html_a5884aa8cc9b4e733345e49f93b54f75a"><div class="ttname"><a href="../../d8/dc2/errno_8h.html#a5884aa8cc9b4e733345e49f93b54f75a">arc_errno</a></div><div class="ttdeci">int32_t arc_errno</div><div class="ttdef"><b>Definition</b> <a href="../../d0/d90/errno_8c_source.html#l00005">errno.c:5</a></div></div>
<div class="ttc" id="aerrno_8h_html_ad32a4f194b90c9ede4e393c0d4185590"><div class="ttname"><a href="../../d8/dc2/errno_8h.html#ad32a4f194b90c9ede4e393c0d4185590">ARC_DEBUG_LOG_ERROR</a></div><div class="ttdeci">#define ARC_DEBUG_LOG_ERROR(STR)</div><div class="ttdef"><b>Definition</b> <a href="../../d8/dc2/errno_8h_source.html#l00039">errno.h:39</a></div></div>
<div class="ttc" id="aerrno_8h_html_af21596945a4d9ac142fe4cfef53e7a80"><div class="ttname"><a href="../../d8/dc2/errno_8h.html#af21596945a4d9ac142fe4cfef53e7a80">ARC_ERRNO_DATA</a></div><div class="ttdeci">#define ARC_ERRNO_DATA</div><div class="ttdef"><b>Definition</b> <a href="../../d8/dc2/errno_8h_source.html#l00007">errno.h:7</a></div></div>
<div class="ttc" id="astructARC__Queue_html_aad38dc94dd6f7a359785f38db6d02ac7"><div class="ttname"><a href="../../d2/d32/structARC__Queue.html#aad38dc94dd6f7a359785f38db6d02ac7">ARC_Queue::node</a></div><div class="ttdeci">ARC_QueueNode * node</div><div class="ttdef"><b>Definition</b> <a href="../../d2/dbd/queue_8c_source.html#l00015">queue.c:15</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="../../d8/dc2/errno_8h_source.html#l00039">ARC_DEBUG_LOG_ERROR</a>, <a class="el" href="../../d0/d90/errno_8c_source.html#l00005">arc_errno</a>, <a class="el" href="../../d8/dc2/errno_8h_source.html#l00007">ARC_ERRNO_DATA</a>, <a class="el" href="../../d2/dbd/queue_8c_source.html#l00014">ARC_Queue::currentSize</a>, and <a class="el" href="../../d2/dbd/queue_8c_source.html#l00015">ARC_Queue::node</a>.</p>
</div>
</div>
<a id="a6dfacddca2614a104273d52726fb4bb9" name="a6dfacddca2614a104273d52726fb4bb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6dfacddca2614a104273d52726fb4bb9">&#9670;&#160;</a></span>ARC_Queue_Pop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * ARC_Queue_Pop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> *</td> <td class="paramname"><span class="paramname"><em>queue</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>pops the front off of the <a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">queue</td><td><a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> to remove from</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the poped data from the queue as a void * </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d2/dbd/queue_8c_source.html#l00072">72</a> of file <a class="el" href="../../d2/dbd/queue_8c_source.html">queue.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 72</span> {</div>
<div class="line"><span class="lineno"> 73</span> <span class="keywordflow">if</span>(queue-&gt;<a class="code hl_variable" href="../../d2/d32/structARC__Queue.html#a2db56d1b37ef101ef0b5c5aea2b38ceb">currentSize</a> == 0){</div>
<div class="line"><span class="lineno"> 74</span> <a class="code hl_variable" href="../../d8/dc2/errno_8h.html#a5884aa8cc9b4e733345e49f93b54f75a">arc_errno</a> = <a class="code hl_define" href="../../d8/dc2/errno_8h.html#af21596945a4d9ac142fe4cfef53e7a80">ARC_ERRNO_DATA</a>;</div>
<div class="line"><span class="lineno"> 75</span> <a class="code hl_define" href="../../d8/dc2/errno_8h.html#ad32a4f194b90c9ede4e393c0d4185590">ARC_DEBUG_LOG_ERROR</a>(<span class="stringliteral">&quot;ARC_Queue_Pop(queue) called, but queue was empty&quot;</span>);</div>
<div class="line"><span class="lineno"> 76</span> <span class="keywordflow">return</span> NULL;</div>
<div class="line"><span class="lineno"> 77</span> }</div>
<div class="line"><span class="lineno"> 78</span> </div>
<div class="line"><span class="lineno"> 79</span> <a class="code hl_struct" href="../../d5/da2/structARC__QueueNode.html">ARC_QueueNode</a> *node = queue-&gt;<a class="code hl_variable" href="../../d2/d32/structARC__Queue.html#aad38dc94dd6f7a359785f38db6d02ac7">node</a>;</div>
<div class="line"><span class="lineno"> 80</span> <span class="keywordflow">if</span>(node == NULL){</div>
<div class="line"><span class="lineno"> 81</span> <a class="code hl_variable" href="../../d8/dc2/errno_8h.html#a5884aa8cc9b4e733345e49f93b54f75a">arc_errno</a> = <a class="code hl_define" href="../../d8/dc2/errno_8h.html#ab626cdbbebc1ac9abd1548a5f6f6195b">ARC_ERRNO_NULL</a>;</div>
<div class="line"><span class="lineno"> 82</span> <a class="code hl_define" href="../../d8/dc2/errno_8h.html#ad32a4f194b90c9ede4e393c0d4185590">ARC_DEBUG_LOG_ERROR</a>(<span class="stringliteral">&quot;ARC_Queue_Pop(queue) called, but node was NULL&quot;</span>);</div>
<div class="line"><span class="lineno"> 83</span> <span class="keywordflow">return</span> NULL;</div>
<div class="line"><span class="lineno"> 84</span> }</div>
<div class="line"><span class="lineno"> 85</span> </div>
<div class="line"><span class="lineno"> 86</span> queue-&gt;<a class="code hl_variable" href="../../d2/d32/structARC__Queue.html#aad38dc94dd6f7a359785f38db6d02ac7">node</a> = node-&gt;<a class="code hl_variable" href="../../d5/da2/structARC__QueueNode.html#a10953e098f8189e8fd17aac1af508719">next</a>;</div>
<div class="line"><span class="lineno"> 87</span> <span class="keywordtype">void</span> *nodeData = node-&gt;<a class="code hl_variable" href="../../d5/da2/structARC__QueueNode.html#afa52acc0d0648fd9e1935e6ef0f4309c">data</a>;</div>
<div class="line"><span class="lineno"> 88</span> free(node);</div>
<div class="line"><span class="lineno"> 89</span> </div>
<div class="line"><span class="lineno"> 90</span> queue-&gt;<a class="code hl_variable" href="../../d2/d32/structARC__Queue.html#a2db56d1b37ef101ef0b5c5aea2b38ceb">currentSize</a>--;</div>
<div class="line"><span class="lineno"> 91</span> </div>
<div class="line"><span class="lineno"> 92</span> <span class="keywordflow">return</span> nodeData;</div>
<div class="line"><span class="lineno"> 93</span>}</div>
<div class="ttc" id="aerrno_8h_html_ab626cdbbebc1ac9abd1548a5f6f6195b"><div class="ttname"><a href="../../d8/dc2/errno_8h.html#ab626cdbbebc1ac9abd1548a5f6f6195b">ARC_ERRNO_NULL</a></div><div class="ttdeci">#define ARC_ERRNO_NULL</div><div class="ttdef"><b>Definition</b> <a href="../../d8/dc2/errno_8h_source.html#l00006">errno.h:6</a></div></div>
<div class="ttc" id="astructARC__QueueNode_html"><div class="ttname"><a href="../../d5/da2/structARC__QueueNode.html">ARC_QueueNode</a></div><div class="ttdef"><b>Definition</b> <a href="../../d2/dbd/queue_8c_source.html#l00008">queue.c:8</a></div></div>
<div class="ttc" id="astructARC__QueueNode_html_a10953e098f8189e8fd17aac1af508719"><div class="ttname"><a href="../../d5/da2/structARC__QueueNode.html#a10953e098f8189e8fd17aac1af508719">ARC_QueueNode::next</a></div><div class="ttdeci">ARC_QueueNode * next</div><div class="ttdef"><b>Definition</b> <a href="../../d2/dbd/queue_8c_source.html#l00009">queue.c:9</a></div></div>
<div class="ttc" id="astructARC__QueueNode_html_afa52acc0d0648fd9e1935e6ef0f4309c"><div class="ttname"><a href="../../d5/da2/structARC__QueueNode.html#afa52acc0d0648fd9e1935e6ef0f4309c">ARC_QueueNode::data</a></div><div class="ttdeci">void * data</div><div class="ttdef"><b>Definition</b> <a href="../../d2/dbd/queue_8c_source.html#l00010">queue.c:10</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="../../d8/dc2/errno_8h_source.html#l00039">ARC_DEBUG_LOG_ERROR</a>, <a class="el" href="../../d0/d90/errno_8c_source.html#l00005">arc_errno</a>, <a class="el" href="../../d8/dc2/errno_8h_source.html#l00007">ARC_ERRNO_DATA</a>, <a class="el" href="../../d8/dc2/errno_8h_source.html#l00006">ARC_ERRNO_NULL</a>, <a class="el" href="../../d2/dbd/queue_8c_source.html#l00014">ARC_Queue::currentSize</a>, <a class="el" href="../../d2/dbd/queue_8c_source.html#l00010">ARC_QueueNode::data</a>, <a class="el" href="../../d2/dbd/queue_8c_source.html#l00009">ARC_QueueNode::next</a>, and <a class="el" href="../../d2/dbd/queue_8c_source.html#l00015">ARC_Queue::node</a>.</p>
</div>
</div>
<a id="a148faa7bfa969213e32a29aaf3799cd3" name="a148faa7bfa969213e32a29aaf3799cd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a148faa7bfa969213e32a29aaf3799cd3">&#9670;&#160;</a></span>ARC_Queue_Push()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Queue_Push </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> *</td> <td class="paramname"><span class="paramname"><em>queue</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>data</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>pushes value to end of queue </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">queue</td><td><a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> to push to </td></tr>
<tr><td class="paramname">data</td><td>data that is being pushed </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d2/dbd/queue_8c_source.html#l00034">34</a> of file <a class="el" href="../../d2/dbd/queue_8c_source.html">queue.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 34</span> {</div>
<div class="line"><span class="lineno"> 35</span> <span class="keywordflow">if</span>(queue-&gt;<a class="code hl_variable" href="../../d2/d32/structARC__Queue.html#a2db56d1b37ef101ef0b5c5aea2b38ceb">currentSize</a> == ~(uint32_t)0){</div>
<div class="line"><span class="lineno"> 36</span> <a class="code hl_variable" href="../../d8/dc2/errno_8h.html#a5884aa8cc9b4e733345e49f93b54f75a">arc_errno</a> = <a class="code hl_define" href="../../d8/dc2/errno_8h.html#a9d88eecae5e1850a90ae502999ca5a73">ARC_ERRNO_OVERFLOW</a>;</div>
<div class="line"><span class="lineno"> 37</span> <a class="code hl_define" href="../../d8/dc2/errno_8h.html#ad32a4f194b90c9ede4e393c0d4185590">ARC_DEBUG_LOG_ERROR</a>(<span class="stringliteral">&quot;ARC_Queue_Push(queue) called, size of queue is maxed, cannot add another node&quot;</span>);</div>
<div class="line"><span class="lineno"> 38</span> <span class="keywordflow">return</span>;</div>
<div class="line"><span class="lineno"> 39</span> }</div>
<div class="line"><span class="lineno"> 40</span> </div>
<div class="line"><span class="lineno"> 41</span> <span class="keywordflow">if</span>(queue-&gt;<a class="code hl_variable" href="../../d2/d32/structARC__Queue.html#a2db56d1b37ef101ef0b5c5aea2b38ceb">currentSize</a> == 0){</div>
<div class="line"><span class="lineno"> 42</span> <a class="code hl_struct" href="../../d5/da2/structARC__QueueNode.html">ARC_QueueNode</a> *node = (<a class="code hl_struct" href="../../d5/da2/structARC__QueueNode.html">ARC_QueueNode</a> *)malloc(<span class="keyword">sizeof</span>(<a class="code hl_struct" href="../../d5/da2/structARC__QueueNode.html">ARC_QueueNode</a>));</div>
<div class="line"><span class="lineno"> 43</span> node-&gt;<a class="code hl_variable" href="../../d5/da2/structARC__QueueNode.html#afa52acc0d0648fd9e1935e6ef0f4309c">data</a> = data;</div>
<div class="line"><span class="lineno"> 44</span> node-&gt;<a class="code hl_variable" href="../../d5/da2/structARC__QueueNode.html#a10953e098f8189e8fd17aac1af508719">next</a> = NULL;</div>
<div class="line"><span class="lineno"> 45</span> </div>
<div class="line"><span class="lineno"> 46</span> queue-&gt;<a class="code hl_variable" href="../../d2/d32/structARC__Queue.html#aad38dc94dd6f7a359785f38db6d02ac7">node</a> = node;</div>
<div class="line"><span class="lineno"> 47</span> queue-&gt;<a class="code hl_variable" href="../../d2/d32/structARC__Queue.html#a2db56d1b37ef101ef0b5c5aea2b38ceb">currentSize</a>++;</div>
<div class="line"><span class="lineno"> 48</span> </div>
<div class="line"><span class="lineno"> 49</span> <span class="keywordflow">return</span>;</div>
<div class="line"><span class="lineno"> 50</span> }</div>
<div class="line"><span class="lineno"> 51</span> </div>
<div class="line"><span class="lineno"> 52</span> <a class="code hl_struct" href="../../d5/da2/structARC__QueueNode.html">ARC_QueueNode</a> *end = queue-&gt;<a class="code hl_variable" href="../../d2/d32/structARC__Queue.html#aad38dc94dd6f7a359785f38db6d02ac7">node</a>;</div>
<div class="line"><span class="lineno"> 53</span> <span class="keywordflow">for</span>(uint32_t i = 1; i &lt; queue-&gt;<a class="code hl_variable" href="../../d2/d32/structARC__Queue.html#a2db56d1b37ef101ef0b5c5aea2b38ceb">currentSize</a>; i++){</div>
<div class="line"><span class="lineno"> 54</span> <span class="keywordflow">if</span>(end-&gt;<a class="code hl_variable" href="../../d5/da2/structARC__QueueNode.html#a10953e098f8189e8fd17aac1af508719">next</a> == NULL){</div>
<div class="line"><span class="lineno"> 55</span> <a class="code hl_variable" href="../../d8/dc2/errno_8h.html#a5884aa8cc9b4e733345e49f93b54f75a">arc_errno</a> = <a class="code hl_define" href="../../d8/dc2/errno_8h.html#ab626cdbbebc1ac9abd1548a5f6f6195b">ARC_ERRNO_NULL</a>;</div>
<div class="line"><span class="lineno"> 56</span> <a class="code hl_define" href="../../d8/dc2/errno_8h.html#ad32a4f194b90c9ede4e393c0d4185590">ARC_DEBUG_LOG_ERROR</a>(<span class="stringliteral">&quot;ARC_Queue_Push(queue), when getting end node encountered a NULL node&quot;</span>);</div>
<div class="line"><span class="lineno"> 57</span> <span class="keywordflow">return</span>;</div>
<div class="line"><span class="lineno"> 58</span> }</div>
<div class="line"><span class="lineno"> 59</span> </div>
<div class="line"><span class="lineno"> 60</span> end = end-&gt;<a class="code hl_variable" href="../../d5/da2/structARC__QueueNode.html#a10953e098f8189e8fd17aac1af508719">next</a>;</div>
<div class="line"><span class="lineno"> 61</span> }</div>
<div class="line"><span class="lineno"> 62</span> </div>
<div class="line"><span class="lineno"> 63</span> <a class="code hl_struct" href="../../d5/da2/structARC__QueueNode.html">ARC_QueueNode</a> *node = (<a class="code hl_struct" href="../../d5/da2/structARC__QueueNode.html">ARC_QueueNode</a> *)malloc(<span class="keyword">sizeof</span>(<a class="code hl_struct" href="../../d5/da2/structARC__QueueNode.html">ARC_QueueNode</a>));</div>
<div class="line"><span class="lineno"> 64</span> node-&gt;<a class="code hl_variable" href="../../d5/da2/structARC__QueueNode.html#afa52acc0d0648fd9e1935e6ef0f4309c">data</a> = data;</div>
<div class="line"><span class="lineno"> 65</span> node-&gt;<a class="code hl_variable" href="../../d5/da2/structARC__QueueNode.html#a10953e098f8189e8fd17aac1af508719">next</a> = NULL;</div>
<div class="line"><span class="lineno"> 66</span> </div>
<div class="line"><span class="lineno"> 67</span> end-&gt;<a class="code hl_variable" href="../../d5/da2/structARC__QueueNode.html#a10953e098f8189e8fd17aac1af508719">next</a> = node;</div>
<div class="line"><span class="lineno"> 68</span> </div>
<div class="line"><span class="lineno"> 69</span> queue-&gt;<a class="code hl_variable" href="../../d2/d32/structARC__Queue.html#a2db56d1b37ef101ef0b5c5aea2b38ceb">currentSize</a>++;</div>
<div class="line"><span class="lineno"> 70</span>}</div>
<div class="ttc" id="aerrno_8h_html_a9d88eecae5e1850a90ae502999ca5a73"><div class="ttname"><a href="../../d8/dc2/errno_8h.html#a9d88eecae5e1850a90ae502999ca5a73">ARC_ERRNO_OVERFLOW</a></div><div class="ttdeci">#define ARC_ERRNO_OVERFLOW</div><div class="ttdef"><b>Definition</b> <a href="../../d8/dc2/errno_8h_source.html#l00010">errno.h:10</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="../../d8/dc2/errno_8h_source.html#l00039">ARC_DEBUG_LOG_ERROR</a>, <a class="el" href="../../d0/d90/errno_8c_source.html#l00005">arc_errno</a>, <a class="el" href="../../d8/dc2/errno_8h_source.html#l00006">ARC_ERRNO_NULL</a>, <a class="el" href="../../d8/dc2/errno_8h_source.html#l00010">ARC_ERRNO_OVERFLOW</a>, <a class="el" href="../../d2/dbd/queue_8c_source.html#l00014">ARC_Queue::currentSize</a>, <a class="el" href="../../d2/dbd/queue_8c_source.html#l00010">ARC_QueueNode::data</a>, <a class="el" href="../../d2/dbd/queue_8c_source.html#l00009">ARC_QueueNode::next</a>, and <a class="el" href="../../d2/dbd/queue_8c_source.html#l00015">ARC_Queue::node</a>.</p>
</div>
</div>
<a id="a874a468cb3a68e9193618c9d2eac11b6" name="a874a468cb3a68e9193618c9d2eac11b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a874a468cb3a68e9193618c9d2eac11b6">&#9670;&#160;</a></span>ARC_Queue_Size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARC_Queue_Size </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> *</td> <td class="paramname"><span class="paramname"><em>queue</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gets size of queue </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vector</td><td><a class="el" href="../../d2/d32/structARC__Queue.html">ARC_Queue</a> to get size from</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the queues size </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d2/dbd/queue_8c_source.html#l00095">95</a> of file <a class="el" href="../../d2/dbd/queue_8c_source.html">queue.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 95</span> {</div>
<div class="line"><span class="lineno"> 96</span> <span class="keywordflow">return</span> queue-&gt;<a class="code hl_variable" href="../../d2/d32/structARC__Queue.html#a2db56d1b37ef101ef0b5c5aea2b38ceb">currentSize</a>;</div>
<div class="line"><span class="lineno"> 97</span>}</div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="../../d2/dbd/queue_8c_source.html#l00014">ARC_Queue::currentSize</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.2-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul><li class="navelem"><a class="el" href="../../dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="../../dir_fe9004854c8f0f3cfbfe7f330be58a96.html">std</a></li><li class="navelem"><a class="el" href="../../d2/dbd/queue_8c.html">queue.c</a></li></ul>
</div>
<script type="text/javascript">
// script for doxygen 1.9.1
$(function() {
toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
toggleButton.title = "Toggle Light/Dark Mode"
$(document).ready(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
$(window).resize(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
})
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink