herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

started woking on figuring out doxygen documentation and added readme

Browse source
This commit is contained in:
herbglitch 2024-12-24 03:47:16 -07:00
parent c598f3e106
commit 3f0556341c
1192 changed files with 199462 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

535
doc/doxygen/html/dd/dee/handler_8h.html Normal file
View file

@ -0,0 +1,535 @@
<!-- 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/include/arc/std/handler.h 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('dd/dee/handler_8h.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="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">handler.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="../../d8/d77/bool_8h_source.html">arc/std/bool.h</a>&quot;</code><br />
<code>#include &lt;stdint.h&gt;</code><br />
</div>
<p><a href="../../dd/dee/handler_8h_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="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:afe553e395e78a22d36ca5a788adf6fb9" id="r_afe553e395e78a22d36ca5a788adf6fb9"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a></td></tr>
<tr class="memdesc:afe553e395e78a22d36ca5a788adf6fb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">a handler type <br /></td></tr>
<tr class="separator:afe553e395e78a22d36ca5a788adf6fb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49c7e2f7ac665db636c13cff6c0a9abf" id="r_a49c7e2f7ac665db636c13cff6c0a9abf"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="../../d8/d77/bool_8h.html#aad51710c999c22d9440e5ce0ba8e2c45">ARC_Bool</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a49c7e2f7ac665db636c13cff6c0a9abf">ARC_Handler_CompareDataFn</a>) (void *a, void *b)</td></tr>
<tr class="memdesc:a49c7e2f7ac665db636c13cff6c0a9abf"><td class="mdescLeft">&#160;</td><td class="mdescRight">data comparison function ptr <br /></td></tr>
<tr class="separator:a49c7e2f7ac665db636c13cff6c0a9abf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6c371d0df719e273df4fcd1a66415e2" id="r_aa6c371d0df719e273df4fcd1a66415e2"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa6c371d0df719e273df4fcd1a66415e2">ARC_Handler_DataFn</a>) (void *data)</td></tr>
<tr class="memdesc:aa6c371d0df719e273df4fcd1a66415e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">a function that will take iterated data <br /></td></tr>
<tr class="separator:aa6c371d0df719e273df4fcd1a66415e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97613b0958fc34c00446d4dc669737a1" id="r_a97613b0958fc34c00446d4dc669737a1"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a97613b0958fc34c00446d4dc669737a1">ARC_Handler_CleanDataFn</a>) (void *data)</td></tr>
<tr class="memdesc:a97613b0958fc34c00446d4dc669737a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">a function that will be used during destruction of trash vector <br /></td></tr>
<tr class="separator:a97613b0958fc34c00446d4dc669737a1"><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:a5642adc667af392d4e81ed9266992cf2" id="r_a5642adc667af392d4e81ed9266992cf2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5642adc667af392d4e81ed9266992cf2">ARC_Handler_Create</a> (<a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> **handler, <a class="el" href="#a49c7e2f7ac665db636c13cff6c0a9abf">ARC_Handler_CompareDataFn</a> *compareFn, <a class="el" href="#a97613b0958fc34c00446d4dc669737a1">ARC_Handler_CleanDataFn</a> cleanFn)</td></tr>
<tr class="memdesc:a5642adc667af392d4e81ed9266992cf2"><td class="mdescLeft">&#160;</td><td class="mdescRight">creates ARC_Handler type <br /></td></tr>
<tr class="separator:a5642adc667af392d4e81ed9266992cf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a504e83100f5bc3b257f81fb27c7850d9" id="r_a504e83100f5bc3b257f81fb27c7850d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a504e83100f5bc3b257f81fb27c7850d9">ARC_Handler_Destroy</a> (<a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *handler)</td></tr>
<tr class="memdesc:a504e83100f5bc3b257f81fb27c7850d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">destroyes ARC_Handler type <br /></td></tr>
<tr class="separator:a504e83100f5bc3b257f81fb27c7850d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1819b266e74d30c0faf05b7ce687f2dc" id="r_a1819b266e74d30c0faf05b7ce687f2dc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1819b266e74d30c0faf05b7ce687f2dc">ARC_Handler_Add</a> (<a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *handler, void *data)</td></tr>
<tr class="memdesc:a1819b266e74d30c0faf05b7ce687f2dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">adds data to handler <br /></td></tr>
<tr class="separator:a1819b266e74d30c0faf05b7ce687f2dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af37753d9ef62d0b3cabf114acc890c22" id="r_af37753d9ef62d0b3cabf114acc890c22"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af37753d9ef62d0b3cabf114acc890c22">ARC_Handler_Remove</a> (<a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *handler, void *data)</td></tr>
<tr class="memdesc:af37753d9ef62d0b3cabf114acc890c22"><td class="mdescLeft">&#160;</td><td class="mdescRight">remove from handler <br /></td></tr>
<tr class="separator:af37753d9ef62d0b3cabf114acc890c22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff62f9d70a675932736fa20f671490c4" id="r_aff62f9d70a675932736fa20f671490c4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aff62f9d70a675932736fa20f671490c4">ARC_Handler_RemoveIndex</a> (<a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *handler, uint32_t index)</td></tr>
<tr class="memdesc:aff62f9d70a675932736fa20f671490c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">remove from handler <br /></td></tr>
<tr class="separator:aff62f9d70a675932736fa20f671490c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adaa4103a1879a0e0acc595d3e1c2b911" id="r_adaa4103a1879a0e0acc595d3e1c2b911"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adaa4103a1879a0e0acc595d3e1c2b911">ARC_Handler_Iterate</a> (<a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *handler, <a class="el" href="#aa6c371d0df719e273df4fcd1a66415e2">ARC_Handler_DataFn</a> datafn)</td></tr>
<tr class="memdesc:adaa4103a1879a0e0acc595d3e1c2b911"><td class="mdescLeft">&#160;</td><td class="mdescRight">calls provided function on each element in handler <br /></td></tr>
<tr class="separator:adaa4103a1879a0e0acc595d3e1c2b911"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ce371bd450a568dfb98a9e4b40fa423" id="r_a7ce371bd450a568dfb98a9e4b40fa423"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7ce371bd450a568dfb98a9e4b40fa423">ARC_Handler_Clear</a> (<a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *handler)</td></tr>
<tr class="memdesc:a7ce371bd450a568dfb98a9e4b40fa423"><td class="mdescLeft">&#160;</td><td class="mdescRight">clears all data from handler and puts it in trash vector <br /></td></tr>
<tr class="separator:a7ce371bd450a568dfb98a9e4b40fa423"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af36b878567ea73a90f826af9af64c989" id="r_af36b878567ea73a90f826af9af64c989"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af36b878567ea73a90f826af9af64c989">ARC_Handler_Clean</a> (<a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *handler)</td></tr>
<tr class="memdesc:af36b878567ea73a90f826af9af64c989"><td class="mdescLeft">&#160;</td><td class="mdescRight">clears trash from handler <br /></td></tr>
<tr class="separator:af36b878567ea73a90f826af9af64c989"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3630dbdb66e538bf1d457b9c1bc1165" id="r_ad3630dbdb66e538bf1d457b9c1bc1165"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad3630dbdb66e538bf1d457b9c1bc1165">ARC_Handler_GetSize</a> (<a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *handler)</td></tr>
<tr class="memdesc:ad3630dbdb66e538bf1d457b9c1bc1165"><td class="mdescLeft">&#160;</td><td class="mdescRight">gets size of vector <br /></td></tr>
<tr class="separator:ad3630dbdb66e538bf1d457b9c1bc1165"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="afe553e395e78a22d36ca5a788adf6fb9" name="afe553e395e78a22d36ca5a788adf6fb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe553e395e78a22d36ca5a788adf6fb9">&#9670;&#160;</a></span>ARC_Handler</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> <a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>a handler type </p>
<p class="definition">Definition at line <a class="el" href="../../dd/dee/handler_8h_source.html#l00014">14</a> of file <a class="el" href="../../dd/dee/handler_8h_source.html">handler.h</a>.</p>
</div>
</div>
<a id="a97613b0958fc34c00446d4dc669737a1" name="a97613b0958fc34c00446d4dc669737a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97613b0958fc34c00446d4dc669737a1">&#9670;&#160;</a></span>ARC_Handler_CleanDataFn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* ARC_Handler_CleanDataFn) (void *data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>a function that will be used during destruction of trash vector </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>data that is being destroyed from trash </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../dd/dee/handler_8h_source.html#l00040">40</a> of file <a class="el" href="../../dd/dee/handler_8h_source.html">handler.h</a>.</p>
</div>
</div>
<a id="a49c7e2f7ac665db636c13cff6c0a9abf" name="a49c7e2f7ac665db636c13cff6c0a9abf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49c7e2f7ac665db636c13cff6c0a9abf">&#9670;&#160;</a></span>ARC_Handler_CompareDataFn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="../../d8/d77/bool_8h.html#aad51710c999c22d9440e5ce0ba8e2c45">ARC_Bool</a>(* ARC_Handler_CompareDataFn) (void *a, void *b)</td>
</tr>
</table>
</div><div class="memdoc">
<p>data comparison function ptr </p>
<dl class="section note"><dt>Note</dt><dd>this is used for comparison within vectors</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>first data struct </td></tr>
<tr><td class="paramname">b</td><td>second data struct</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 when a == b </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../dd/dee/handler_8h_source.html#l00026">26</a> of file <a class="el" href="../../dd/dee/handler_8h_source.html">handler.h</a>.</p>
</div>
</div>
<a id="aa6c371d0df719e273df4fcd1a66415e2" name="aa6c371d0df719e273df4fcd1a66415e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6c371d0df719e273df4fcd1a66415e2">&#9670;&#160;</a></span>ARC_Handler_DataFn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* ARC_Handler_DataFn) (void *data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>a function that will take iterated data </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>iterated data from ARC_Handler_Iterate </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../dd/dee/handler_8h_source.html#l00033">33</a> of file <a class="el" href="../../dd/dee/handler_8h_source.html">handler.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a1819b266e74d30c0faf05b7ce687f2dc" name="a1819b266e74d30c0faf05b7ce687f2dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1819b266e74d30c0faf05b7ce687f2dc">&#9670;&#160;</a></span>ARC_Handler_Add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Handler_Add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *</td> <td class="paramname"><span class="paramname"><em>handler</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>adds data to handler </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>ARC_Handler to add to </td></tr>
<tr><td class="paramname">data</td><td>data that is being added </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af36b878567ea73a90f826af9af64c989" name="af36b878567ea73a90f826af9af64c989"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af36b878567ea73a90f826af9af64c989">&#9670;&#160;</a></span>ARC_Handler_Clean()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Handler_Clean </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *</td> <td class="paramname"><span class="paramname"><em>handler</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>clears trash from handler </p>
<dl class="section note"><dt>Note</dt><dd>cleanfn's main purpose is to help manage memory</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>ARC_Handler to remove trash from </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7ce371bd450a568dfb98a9e4b40fa423" name="a7ce371bd450a568dfb98a9e4b40fa423"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ce371bd450a568dfb98a9e4b40fa423">&#9670;&#160;</a></span>ARC_Handler_Clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Handler_Clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *</td> <td class="paramname"><span class="paramname"><em>handler</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>clears all data from handler and puts it in trash vector </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>ARC_Handler to clear data from </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5642adc667af392d4e81ed9266992cf2" name="a5642adc667af392d4e81ed9266992cf2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5642adc667af392d4e81ed9266992cf2">&#9670;&#160;</a></span>ARC_Handler_Create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Handler_Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> **</td> <td class="paramname"><span class="paramname"><em>handler</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a49c7e2f7ac665db636c13cff6c0a9abf">ARC_Handler_CompareDataFn</a> *</td> <td class="paramname"><span class="paramname"><em>compareFn</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a97613b0958fc34c00446d4dc669737a1">ARC_Handler_CleanDataFn</a></td> <td class="paramname"><span class="paramname"><em>cleanFn</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>creates ARC_Handler type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>ARC_Handler to initialize </td></tr>
<tr><td class="paramname">compareFn</td><td>function to remove handler data </td></tr>
<tr><td class="paramname">cleanFn</td><td>function to clean data in handler can be null </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a504e83100f5bc3b257f81fb27c7850d9" name="a504e83100f5bc3b257f81fb27c7850d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a504e83100f5bc3b257f81fb27c7850d9">&#9670;&#160;</a></span>ARC_Handler_Destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Handler_Destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *</td> <td class="paramname"><span class="paramname"><em>handler</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>destroyes ARC_Handler type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>ARC_Handler to destory </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad3630dbdb66e538bf1d457b9c1bc1165" name="ad3630dbdb66e538bf1d457b9c1bc1165"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3630dbdb66e538bf1d457b9c1bc1165">&#9670;&#160;</a></span>ARC_Handler_GetSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARC_Handler_GetSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *</td> <td class="paramname"><span class="paramname"><em>handler</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gets size of vector </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>ARC_handler to get size from </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="adaa4103a1879a0e0acc595d3e1c2b911" name="adaa4103a1879a0e0acc595d3e1c2b911"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adaa4103a1879a0e0acc595d3e1c2b911">&#9670;&#160;</a></span>ARC_Handler_Iterate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Handler_Iterate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *</td> <td class="paramname"><span class="paramname"><em>handler</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#aa6c371d0df719e273df4fcd1a66415e2">ARC_Handler_DataFn</a></td> <td class="paramname"><span class="paramname"><em>datafn</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>calls provided function on each element in handler </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>ARC_Handler to iterate through </td></tr>
<tr><td class="paramname">datafn</td><td>function that will be called on each element of data </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af37753d9ef62d0b3cabf114acc890c22" name="af37753d9ef62d0b3cabf114acc890c22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af37753d9ef62d0b3cabf114acc890c22">&#9670;&#160;</a></span>ARC_Handler_Remove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Handler_Remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *</td> <td class="paramname"><span class="paramname"><em>handler</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>remove from handler </p>
<dl class="section note"><dt>Note</dt><dd>the data that is removed is stored in a trash vector the ARC_Handler_Clean function must be called clean the trash vector the trash vector is to make sure a state is not deleted while being run</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>ARC_Handler to remove from </td></tr>
<tr><td class="paramname">data</td><td>data that is being removed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aff62f9d70a675932736fa20f671490c4" name="aff62f9d70a675932736fa20f671490c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff62f9d70a675932736fa20f671490c4">&#9670;&#160;</a></span>ARC_Handler_RemoveIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Handler_RemoveIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *</td> <td class="paramname"><span class="paramname"><em>handler</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>index</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>remove from handler </p>
<dl class="section note"><dt>Note</dt><dd>the data that is removed is stored in a trash vector the ARC_Handler_Clean function must be called clean the trash vector the trash vector is to make sure a state is not deleted while being run</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>ARC_Handler to remove from </td></tr>
<tr><td class="paramname">index</td><td>index of data that is being removed </td></tr>
</table>
</dd>
</dl>
</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_8698ff38f6ae643760cdad826b9d4736.html">arc</a></li><li class="navelem"><a class="el" href="../../dir_b3e500eb3a6fe660b1141f591e523c76.html">std</a></li><li class="navelem"><a class="el" href="../../dd/dee/handler_8h.html">handler.h</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>

16
doc/doxygen/html/dd/dee/handler_8h.js Normal file
View file

@ -0,0 +1,16 @@
var handler_8h =
[
[ "ARC_Handler", "dd/dee/handler_8h.html#afe553e395e78a22d36ca5a788adf6fb9", null ],
[ "ARC_Handler_CleanDataFn", "dd/dee/handler_8h.html#a97613b0958fc34c00446d4dc669737a1", null ],
[ "ARC_Handler_CompareDataFn", "dd/dee/handler_8h.html#a49c7e2f7ac665db636c13cff6c0a9abf", null ],
[ "ARC_Handler_DataFn", "dd/dee/handler_8h.html#aa6c371d0df719e273df4fcd1a66415e2", null ],
[ "ARC_Handler_Add", "dd/dee/handler_8h.html#a1819b266e74d30c0faf05b7ce687f2dc", null ],
[ "ARC_Handler_Clean", "dd/dee/handler_8h.html#af36b878567ea73a90f826af9af64c989", null ],
[ "ARC_Handler_Clear", "dd/dee/handler_8h.html#a7ce371bd450a568dfb98a9e4b40fa423", null ],
[ "ARC_Handler_Create", "dd/dee/handler_8h.html#a5642adc667af392d4e81ed9266992cf2", null ],
[ "ARC_Handler_Destroy", "dd/dee/handler_8h.html#a504e83100f5bc3b257f81fb27c7850d9", null ],
[ "ARC_Handler_GetSize", "dd/dee/handler_8h.html#ad3630dbdb66e538bf1d457b9c1bc1165", null ],
[ "ARC_Handler_Iterate", "dd/dee/handler_8h.html#adaa4103a1879a0e0acc595d3e1c2b911", null ],
[ "ARC_Handler_Remove", "dd/dee/handler_8h.html#af37753d9ef62d0b3cabf114acc890c22", null ],
[ "ARC_Handler_RemoveIndex", "dd/dee/handler_8h.html#aff62f9d70a675932736fa20f671490c4", null ]
];

269
doc/doxygen/html/dd/dee/handler_8h_source.html Normal file
View file

@ -0,0 +1,269 @@
<!-- 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/include/arc/std/handler.h Source File</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('dd/dee/handler_8h_source.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="headertitle"><div class="title">handler.h</div></div>
</div><!--header-->
<div class="contents">
<a href="../../dd/dee/handler_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef ARC_STD_HANDLER_H_</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ARC_STD_HANDLER_H_</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;<a class="code" href="../../d8/d77/bool_8h.html">arc/std/bool.h</a>&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"></span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">/**</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * @brief a handler type</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> */</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="../../dd/dee/handler_8h.html#afe553e395e78a22d36ca5a788adf6fb9"> 14</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_typedef" href="../../dd/dee/handler_8h.html#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> <a class="code hl_typedef" href="../../dd/dee/handler_8h.html#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a>;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"></span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">/**</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * @brief data comparison function ptr</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> *</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> * @note this is used for comparison within vectors</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> * </span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"> * @param a first data struct</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * @param b second data struct</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> *</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment"> * @return 0 when a == b</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> */</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="../../dd/dee/handler_8h.html#a49c7e2f7ac665db636c13cff6c0a9abf"> 26</a></span><span class="keyword">typedef</span> <a class="code hl_define" href="../../d8/d77/bool_8h.html#aad51710c999c22d9440e5ce0ba8e2c45">ARC_Bool</a> (* <a class="code hl_typedef" href="../../dd/dee/handler_8h.html#a49c7e2f7ac665db636c13cff6c0a9abf">ARC_Handler_CompareDataFn</a>)(<span class="keywordtype">void</span> *a, <span class="keywordtype">void</span> *b);</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment"></span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">/**</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"> * @brief a function that will take iterated data</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment"> *</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"> * @param data iterated data from ARC_Handler_Iterate</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> */</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="../../dd/dee/handler_8h.html#aa6c371d0df719e273df4fcd1a66415e2"> 33</a></span><span class="keyword">typedef</span> void (* <a class="code hl_typedef" href="../../dd/dee/handler_8h.html#aa6c371d0df719e273df4fcd1a66415e2">ARC_Handler_DataFn</a>)(<span class="keywordtype">void</span> *data);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"></span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment">/**</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment"> * @brief a function that will be used during destruction of trash vector</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment"> *</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment"> * @param data data that is being destroyed from trash</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> */</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="../../dd/dee/handler_8h.html#a97613b0958fc34c00446d4dc669737a1"> 40</a></span><span class="keyword">typedef</span> void (* <a class="code hl_typedef" href="../../dd/dee/handler_8h.html#a97613b0958fc34c00446d4dc669737a1">ARC_Handler_CleanDataFn</a>)(<span class="keywordtype">void</span> *data);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"></span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment">/**</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment"> * @brief creates ARC_Handler type</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment"> *</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment"> * @param config ARC_Handler to initialize</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment"> * @param compareFn function to remove handler data</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"> * @param cleanFn function to clean data in handler</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"> * can be null</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"> */</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="../../dd/dee/handler_8h.html#a5642adc667af392d4e81ed9266992cf2"> 50</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../dd/dee/handler_8h.html#a5642adc667af392d4e81ed9266992cf2">ARC_Handler_Create</a>(<a class="code hl_typedef" href="../../dd/dee/handler_8h.html#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> **handler, <a class="code hl_typedef" href="../../dd/dee/handler_8h.html#a49c7e2f7ac665db636c13cff6c0a9abf">ARC_Handler_CompareDataFn</a> *compareFn, <a class="code hl_typedef" href="../../dd/dee/handler_8h.html#a97613b0958fc34c00446d4dc669737a1">ARC_Handler_CleanDataFn</a> cleanFn);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"></span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment">/**</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment"> * @brief destroyes ARC_Handler type</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment"> *</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment"> * @param handler ARC_Handler to destory</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment"> */</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="../../dd/dee/handler_8h.html#a504e83100f5bc3b257f81fb27c7850d9"> 57</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../dd/dee/handler_8h.html#a504e83100f5bc3b257f81fb27c7850d9">ARC_Handler_Destroy</a>(<a class="code hl_typedef" href="../../dd/dee/handler_8h.html#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *handler);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment"></span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment">/**</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment"> * @brief adds data to handler</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment"> *</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment"> * @param handler ARC_Handler to add to</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment"> * @param data data that is being added</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="comment"> */</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="../../dd/dee/handler_8h.html#a1819b266e74d30c0faf05b7ce687f2dc"> 65</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../dd/dee/handler_8h.html#a1819b266e74d30c0faf05b7ce687f2dc">ARC_Handler_Add</a>(<a class="code hl_typedef" href="../../dd/dee/handler_8h.html#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *handler, <span class="keywordtype">void</span> *data);</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="comment"></span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="comment">/**</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment"> * @brief remove from handler</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment"> *</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment"> * @note the data that is removed is stored in a trash vector</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="comment"> * the ARC_Handler_Clean function must be called clean the trash vector</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment"> * the trash vector is to make sure a state is not deleted while being run</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment"> *</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="comment"> * @param handler ARC_Handler to remove from</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment"> * @param data data that is being removed</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment"> */</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="../../dd/dee/handler_8h.html#af37753d9ef62d0b3cabf114acc890c22"> 77</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../dd/dee/handler_8h.html#af37753d9ef62d0b3cabf114acc890c22">ARC_Handler_Remove</a>(<a class="code hl_typedef" href="../../dd/dee/handler_8h.html#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *handler, <span class="keywordtype">void</span> *data);</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment"></span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="comment">/**</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="comment"> * @brief remove from handler</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment"> *</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment"> * @note the data that is removed is stored in a trash vector</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment"> * the ARC_Handler_Clean function must be called clean the trash vector</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment"> * the trash vector is to make sure a state is not deleted while being run</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment"> *</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="comment"> * @param handler ARC_Handler to remove from</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="comment"> * @param index index of data that is being removed</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="comment"> */</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="../../dd/dee/handler_8h.html#aff62f9d70a675932736fa20f671490c4"> 89</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../dd/dee/handler_8h.html#aff62f9d70a675932736fa20f671490c4">ARC_Handler_RemoveIndex</a>(<a class="code hl_typedef" href="../../dd/dee/handler_8h.html#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *handler, uint32_t index);</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="comment"></span> </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="comment">/**</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="comment"> * @brief calls provided function on each element in handler</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="comment"> *</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="comment"> * @param handler ARC_Handler to iterate through</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="comment"> * @param datafn function that will be called on each element of data</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="comment"> */</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="../../dd/dee/handler_8h.html#adaa4103a1879a0e0acc595d3e1c2b911"> 97</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../dd/dee/handler_8h.html#adaa4103a1879a0e0acc595d3e1c2b911">ARC_Handler_Iterate</a>(<a class="code hl_typedef" href="../../dd/dee/handler_8h.html#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *handler, <a class="code hl_typedef" href="../../dd/dee/handler_8h.html#aa6c371d0df719e273df4fcd1a66415e2">ARC_Handler_DataFn</a> datafn);</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="comment"></span> </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="comment">/**</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="comment"> * @brief clears all data from handler and puts it in trash vector</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="comment"> *</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment"> * @param handler ARC_Handler to clear data from</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="comment"> */</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"><a class="line" href="../../dd/dee/handler_8h.html#a7ce371bd450a568dfb98a9e4b40fa423"> 104</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../dd/dee/handler_8h.html#a7ce371bd450a568dfb98a9e4b40fa423">ARC_Handler_Clear</a>(<a class="code hl_typedef" href="../../dd/dee/handler_8h.html#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *handler);</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="comment"></span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="comment">/**</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="comment"> * @brief clears trash from handler</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="comment"> *</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="comment"> * @note cleanfn&#39;s main purpose is to help manage memory</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="comment"> *</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="comment"> * @param handler ARC_Handler to remove trash from</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="comment"> */</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"><a class="line" href="../../dd/dee/handler_8h.html#af36b878567ea73a90f826af9af64c989"> 113</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../dd/dee/handler_8h.html#af36b878567ea73a90f826af9af64c989">ARC_Handler_Clean</a>(<a class="code hl_typedef" href="../../dd/dee/handler_8h.html#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *handler);</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="comment"></span> </div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="comment">/**</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="comment"> * @brief gets size of vector</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span><span class="comment"> *</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="comment"> * @param handler ARC_handler to get size from</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="comment"> */</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"><a class="line" href="../../dd/dee/handler_8h.html#ad3630dbdb66e538bf1d457b9c1bc1165"> 120</a></span>uint32_t <a class="code hl_function" href="../../dd/dee/handler_8h.html#ad3630dbdb66e538bf1d457b9c1bc1165">ARC_Handler_GetSize</a>(<a class="code hl_typedef" href="../../dd/dee/handler_8h.html#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a> *handler);</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span>}</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="preprocessor">#endif </span><span class="comment">//ARC_STD_HANDLER_H_</span></div>
<div class="ttc" id="abool_8h_html"><div class="ttname"><a href="../../d8/d77/bool_8h.html">bool.h</a></div></div>
<div class="ttc" id="abool_8h_html_aad51710c999c22d9440e5ce0ba8e2c45"><div class="ttname"><a href="../../d8/d77/bool_8h.html#aad51710c999c22d9440e5ce0ba8e2c45">ARC_Bool</a></div><div class="ttdeci">#define ARC_Bool</div><div class="ttdef"><b>Definition</b> <a href="../../d8/d77/bool_8h_source.html#l00010">bool.h:10</a></div></div>
<div class="ttc" id="ahandler_8h_html_a1819b266e74d30c0faf05b7ce687f2dc"><div class="ttname"><a href="../../dd/dee/handler_8h.html#a1819b266e74d30c0faf05b7ce687f2dc">ARC_Handler_Add</a></div><div class="ttdeci">void ARC_Handler_Add(ARC_Handler *handler, void *data)</div><div class="ttdoc">adds data to handler</div></div>
<div class="ttc" id="ahandler_8h_html_a49c7e2f7ac665db636c13cff6c0a9abf"><div class="ttname"><a href="../../dd/dee/handler_8h.html#a49c7e2f7ac665db636c13cff6c0a9abf">ARC_Handler_CompareDataFn</a></div><div class="ttdeci">ARC_Bool(* ARC_Handler_CompareDataFn)(void *a, void *b)</div><div class="ttdoc">data comparison function ptr</div><div class="ttdef"><b>Definition</b> <a href="#l00026">handler.h:26</a></div></div>
<div class="ttc" id="ahandler_8h_html_a504e83100f5bc3b257f81fb27c7850d9"><div class="ttname"><a href="../../dd/dee/handler_8h.html#a504e83100f5bc3b257f81fb27c7850d9">ARC_Handler_Destroy</a></div><div class="ttdeci">void ARC_Handler_Destroy(ARC_Handler *handler)</div><div class="ttdoc">destroyes ARC_Handler type</div></div>
<div class="ttc" id="ahandler_8h_html_a5642adc667af392d4e81ed9266992cf2"><div class="ttname"><a href="../../dd/dee/handler_8h.html#a5642adc667af392d4e81ed9266992cf2">ARC_Handler_Create</a></div><div class="ttdeci">void ARC_Handler_Create(ARC_Handler **handler, ARC_Handler_CompareDataFn *compareFn, ARC_Handler_CleanDataFn cleanFn)</div><div class="ttdoc">creates ARC_Handler type</div></div>
<div class="ttc" id="ahandler_8h_html_a7ce371bd450a568dfb98a9e4b40fa423"><div class="ttname"><a href="../../dd/dee/handler_8h.html#a7ce371bd450a568dfb98a9e4b40fa423">ARC_Handler_Clear</a></div><div class="ttdeci">void ARC_Handler_Clear(ARC_Handler *handler)</div><div class="ttdoc">clears all data from handler and puts it in trash vector</div></div>
<div class="ttc" id="ahandler_8h_html_a97613b0958fc34c00446d4dc669737a1"><div class="ttname"><a href="../../dd/dee/handler_8h.html#a97613b0958fc34c00446d4dc669737a1">ARC_Handler_CleanDataFn</a></div><div class="ttdeci">void(* ARC_Handler_CleanDataFn)(void *data)</div><div class="ttdoc">a function that will be used during destruction of trash vector</div><div class="ttdef"><b>Definition</b> <a href="#l00040">handler.h:40</a></div></div>
<div class="ttc" id="ahandler_8h_html_aa6c371d0df719e273df4fcd1a66415e2"><div class="ttname"><a href="../../dd/dee/handler_8h.html#aa6c371d0df719e273df4fcd1a66415e2">ARC_Handler_DataFn</a></div><div class="ttdeci">void(* ARC_Handler_DataFn)(void *data)</div><div class="ttdoc">a function that will take iterated data</div><div class="ttdef"><b>Definition</b> <a href="#l00033">handler.h:33</a></div></div>
<div class="ttc" id="ahandler_8h_html_ad3630dbdb66e538bf1d457b9c1bc1165"><div class="ttname"><a href="../../dd/dee/handler_8h.html#ad3630dbdb66e538bf1d457b9c1bc1165">ARC_Handler_GetSize</a></div><div class="ttdeci">uint32_t ARC_Handler_GetSize(ARC_Handler *handler)</div><div class="ttdoc">gets size of vector</div></div>
<div class="ttc" id="ahandler_8h_html_adaa4103a1879a0e0acc595d3e1c2b911"><div class="ttname"><a href="../../dd/dee/handler_8h.html#adaa4103a1879a0e0acc595d3e1c2b911">ARC_Handler_Iterate</a></div><div class="ttdeci">void ARC_Handler_Iterate(ARC_Handler *handler, ARC_Handler_DataFn datafn)</div><div class="ttdoc">calls provided function on each element in handler</div></div>
<div class="ttc" id="ahandler_8h_html_af36b878567ea73a90f826af9af64c989"><div class="ttname"><a href="../../dd/dee/handler_8h.html#af36b878567ea73a90f826af9af64c989">ARC_Handler_Clean</a></div><div class="ttdeci">void ARC_Handler_Clean(ARC_Handler *handler)</div><div class="ttdoc">clears trash from handler</div></div>
<div class="ttc" id="ahandler_8h_html_af37753d9ef62d0b3cabf114acc890c22"><div class="ttname"><a href="../../dd/dee/handler_8h.html#af37753d9ef62d0b3cabf114acc890c22">ARC_Handler_Remove</a></div><div class="ttdeci">void ARC_Handler_Remove(ARC_Handler *handler, void *data)</div><div class="ttdoc">remove from handler</div></div>
<div class="ttc" id="ahandler_8h_html_afe553e395e78a22d36ca5a788adf6fb9"><div class="ttname"><a href="../../dd/dee/handler_8h.html#afe553e395e78a22d36ca5a788adf6fb9">ARC_Handler</a></div><div class="ttdeci">struct ARC_Handler ARC_Handler</div><div class="ttdoc">a handler type</div><div class="ttdef"><b>Definition</b> <a href="#l00014">handler.h:14</a></div></div>
<div class="ttc" id="ahandler_8h_html_aff62f9d70a675932736fa20f671490c4"><div class="ttname"><a href="../../dd/dee/handler_8h.html#aff62f9d70a675932736fa20f671490c4">ARC_Handler_RemoveIndex</a></div><div class="ttdeci">void ARC_Handler_RemoveIndex(ARC_Handler *handler, uint32_t index)</div><div class="ttdoc">remove from handler</div></div>
</div><!-- fragment --></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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_8698ff38f6ae643760cdad826b9d4736.html">arc</a></li><li class="navelem"><a class="el" href="../../dir_b3e500eb3a6fe660b1141f591e523c76.html">std</a></li><li class="navelem"><a class="el" href="../../dd/dee/handler_8h.html">handler.h</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>