herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
archeus/doc/doxygen/html/dd/dee/handler_8h.html

535 lines
29 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/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>
Reference in a new issue View git blame Copy permalink