herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
archeus/doc/doxygen/html/d3/d58/std_2config_8h_source.html

270 lines
34 KiB
HTML
Raw Normal View History

started woking on figuring out doxygen documentation and added readme
2024-12-24 03:47:16 -07:00
<!-- 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/config.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('d3/d58/std_2config_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">config.h</div></div>
</div><!--header-->
<div class="contents">
<a href="../../d3/d58/std_2config_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_CONFIG_H_</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ARC_STD_CONFIG_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="../../dd/d16/hashtable_8h.html">arc/std/hashtable.h</a>&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;<a class="code" href="../../da/d66/string_8h.html">arc/std/string.h</a>&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="../../d3/d58/std_2config_8h.html#aa8d55a1d202b495b292e51919ee099d1"> 12</a></span><span class="preprocessor">#define ARC_KEY_BUCKET_SIZE 0x20</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="../../d3/d58/std_2config_8h.html#aebe7e30736515ea92af7365a8c05e269"> 13</a></span><span class="preprocessor">#define ARC_GROUP_BUCKET_SIZE 0x20</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="../../d3/d58/std_2config_8h.html#a2979878127e519a90fc5276c19405a55"> 14</a></span><span class="preprocessor">#define ARC_GROUP_DATA_BUCKET_SIZE 0x20</span></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 a type that keeps permanice of data for when loading and unloading config files</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="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_typedef" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> <a class="code hl_typedef" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a>;</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">/**</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * @brief a function to read a key from string to a ARC_ConfigTypeTemplate</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"> * @param config ARC_Config to store data to</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> * @param string ARC_String of data that is being read in</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment"> * @param value value that is read in</span></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"> * @note use ARC_Config_StoreValue(ARC_Config *config, ARC_String *name, void *value); to store a value to the config</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"> * if there is an error, set arc_errno</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"> * @return 0 if value not a reference, 1 if value is a reference</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="../../d3/d58/std_2config_8h.html#a24eb640dcf65c28bc8e07ea59a733245"> 33</a></span><span class="keyword">typedef</span> uint8_t (* <a class="code hl_typedef" href="../../d3/d58/std_2config_8h.html#a24eb640dcf65c28bc8e07ea59a733245">ARC_ConfigKeyRead</a>)(<a class="code hl_typedef" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a>* config, <a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *string, <span class="keywordtype">void</span> **value);</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 to delete a value from a key in ARC_Config</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 config ARC_Config that can be used to check for references in data</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> * @param value pointer of data to be deleted</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment"> *</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"> * @note this function can be NULL if memory does not need to be cleaned for this type</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"> * if there is an error, set arc_errno</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment"> */</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="../../d3/d58/std_2config_8h.html#af84f4d14d9da265c9f136b832a16bc9c"> 44</a></span><span class="keyword">typedef</span> void (* <a class="code hl_typedef" href="../../d3/d58/std_2config_8h.html#af84f4d14d9da265c9f136b832a16bc9c">ARC_ConfigKeyDelete</a>)(<a class="code hl_typedef" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a>* config, <a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *string, <span class="keywordtype">void</span> *value);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment"></span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment">/**</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"> * @brief adds a usable key to ARC_Config</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"> *</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"> * @param config ARC_Config to add keys to</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment"> * @param type string of key type</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"> * @param keyRead function for reading/creating key from string</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment"> * @param keyDelete function for deleting stored key</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment"> */</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="../../d3/d58/std_2config_8h.html#aff40cd55a3b227cd33334d1c5843ed06"> 54</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d3/d58/std_2config_8h.html#aff40cd55a3b227cd33334d1c5843ed06">ARC_Config_AddKey</a>(<a class="code hl_typedef" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config, <a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *type, <a class="code hl_typedef" href="../../d3/d58/std_2config_8h.html#a24eb640dcf65c28bc8e07ea59a733245">ARC_ConfigKeyRead</a> keyRead, <a class="code hl_typedef" href="../../d3/d58/std_2config_8h.html#af84f4d14d9da265c9f136b832a16bc9c">ARC_ConfigKeyDelete</a> keyDelete);</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment"></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"> 57</span><span class="comment"> * @brief adds a key from a cstring</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment"> * @param config ARC_Config to add keys to</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment"> * @param type cstring of key type</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment"> * @param length length of cstring</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment"> * @param keyRead function for reading/creating key from string</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment"> * @param keyDelete function for deleting stored key</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment">*/</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="../../d3/d58/std_2config_8h.html#a16b8895da92529e4c6ede062db2e417e"> 64</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d3/d58/std_2config_8h.html#a16b8895da92529e4c6ede062db2e417e">ARC_Config_AddKeyCString</a>(<a class="code hl_typedef" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config, <span class="keyword">const</span> <span class="keywordtype">char</span> *type, uint64_t length, <a class="code hl_typedef" href="../../d3/d58/std_2config_8h.html#a24eb640dcf65c28bc8e07ea59a733245">ARC_ConfigKeyRead</a> keyRead, <a class="code hl_typedef" href="../../d3/d58/std_2config_8h.html#af84f4d14d9da265c9f136b832a16bc9c">ARC_ConfigKeyDelete</a> keyDelete);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment"></span> </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"> * @brief external callback to add keys to config</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment"> */</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="../../d3/d58/std_2config_8h.html#a810e986107e108c65fe808edbd6371af"> 69</a></span><span class="keyword">typedef</span> void (* <a class="code hl_typedef" href="../../d3/d58/std_2config_8h.html#a810e986107e108c65fe808edbd6371af">ARC_ConfigKey_AddFunc</a>)(<a class="code hl_typedef" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment"></span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="comment">/**</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment"> * @brief creates ARC_Config type</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 config ARC_Config to initialize</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment"> */</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="../../d3/d58/std_2config_8h.html#a3bf1d8c89c92e8dd42ecd6105dc78306"> 76</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d3/d58/std_2config_8h.html#a3bf1d8c89c92e8dd42ecd6105dc78306">ARC_Config_Create</a>(<a class="code hl_typedef" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> **config);</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment"></span> </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"> * @brief destroys ARC_Config type</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="comment"> */</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="../../d3/d58/std_2config_8h.html#ae771a007a23bb925494d68ae7ca212be"> 81</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d3/d58/std_2config_8h.html#ae771a007a23bb925494d68ae7ca212be">ARC_Config_Destroy</a>(<a class="code hl_typedef" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config);</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment"></span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment">/**</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment"> * @brief sets current group in config</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"> * @note ARC_Config_Get will use this set group</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="comment"> *</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="comment"> * @param config ARC_Config we are setting current group in</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="comment"> * @param groupname name of group that will be set</span></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"><a class="line" href="../../d3/d58/std_2config_8h.html#aa1ec47a354f6cc1ee8356a098cf5b3c9"> 91</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d3/d58/std_2config_8h.html#aa1ec47a354f6cc1ee8356a098cf5b3c9">ARC_Config_SetGroup</a>(<a class="code hl_typedef" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config, <a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *groupname);</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="comment"></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"> * @brief get a value from a given keyname</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="comment"> *</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="comment"> * @note name may be prefaced with &lt;group&gt;:: to specify group</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="comment"> *</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="comment"> * @param config ARC_Config to get value from</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="comment"> * @param keyname name of key to get from config</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="comment"> * @param value data retrieved from config</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"><a class="line" href="../../d3/d58/std_2config_8h.html#a4bd96f3f4cf016f82ffaf82f679288c4"> 102</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d3/d58/std_2config_8h.html#a4bd96f3f4cf016f82ffaf82f679288c4">ARC_Config_Get</a>(<a class="code hl_typedef" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config, <a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *keyname, <span class="keywordtype">void</span> **value);</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"> 104</span><span class="comment">/**</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="comment"> * @brief commands that can be used in ARC_Config_FileIO</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"><a class="line" href="../../d3/d58/std_2config_8h.html#a696d760ea66fed20ff42c3aaac0f9609"> 107</a></span><span class="preprocessor">#define ARC_CONFIG_FILE_IO_LOAD 0x00</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="../../d3/d58/std_2config_8h.html#a101688a6bcee61c9a68cdc4a9fea8ce6"> 108</a></span><span class="preprocessor">#define ARC_CONFIG_FILE_IO_UNLOAD 0x01</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="comment"></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"> * @brief handles file io for ARC_Config Type</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"> 113</span><span class="comment"> * @param config ARC_Config where io operations will take place</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="comment"> * @param path file path for io</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"><a class="line" href="../../d3/d58/std_2config_8h.html#ad6467c7d5aa224d49620fabc990d13f3"> 116</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d3/d58/std_2config_8h.html#ad6467c7d5aa224d49620fabc990d13f3">ARC_Config_FileIO</a>(<a class="code hl_typedef" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config, <a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *path, uint8_t command);</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span>}</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span><span class="preprocessor">#endif</span></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">#endif </span><span class="comment">//ARC_STD_CONFIG_H_</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">#ifdef ARC_DEFAULT_CONFIG</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="preprocessor">#include &quot;<a class="code" href="../../d2/d8b/std_2defaults_2config_8h.html">defaults/config.h</a>&quot;</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_DEFAULT_CONFIG</span></div>
<div class="ttc" id="aaudio_2config_8h_html_aabee9667260a8e773757a111923b6c60"><div class="ttname"><a href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a></div><div class="ttdeci">struct ARC_Config ARC_Config</div><div class="ttdoc">a type that keeps permanice of data for when loading and unloading config files</div><div class="ttdef"><b>Definition</b> <a href="../../df/df7/audio_2config_8h_source.html#l00011">config.h:11</a></div></div>
<div class="ttc" id="ahashtable_8h_html"><div class="ttname"><a href="../../dd/d16/hashtable_8h.html">hashtable.h</a></div></div>
<div class="ttc" id="astd_2config_8h_html_a16b8895da92529e4c6ede062db2e417e"><div class="ttname"><a href="../../d3/d58/std_2config_8h.html#a16b8895da92529e4c6ede062db2e417e">ARC_Config_AddKeyCString</a></div><div class="ttdeci">void ARC_Config_AddKeyCString(ARC_Config *config, const char *type, uint64_t length, ARC_ConfigKeyRead keyRead, ARC_ConfigKeyDelete keyDelete)</div><div class="ttdoc">adds a key from a cstring</div></div>
<div class="ttc" id="astd_2config_8h_html_a24eb640dcf65c28bc8e07ea59a733245"><div class="ttname"><a href="../../d3/d58/std_2config_8h.html#a24eb640dcf65c28bc8e07ea59a733245">ARC_ConfigKeyRead</a></div><div class="ttdeci">uint8_t(* ARC_ConfigKeyRead)(ARC_Config *config, ARC_String *string, void **value)</div><div class="ttdoc">a function to read a key from string to a ARC_ConfigTypeTemplate</div><div class="ttdef"><b>Definition</b> <a href="#l00033">config.h:33</a></div></div>
<div class="ttc" id="astd_2config_8h_html_a3bf1d8c89c92e8dd42ecd6105dc78306"><div class="ttname"><a href="../../d3/d58/std_2config_8h.html#a3bf1d8c89c92e8dd42ecd6105dc78306">ARC_Config_Create</a></div><div class="ttdeci">void ARC_Config_Create(ARC_Config **config)</div><div class="ttdoc">creates ARC_Config type</div></div>
<div class="ttc" id="astd_2config_8h_html_a4bd96f3f4cf016f82ffaf82f679288c4"><div class="ttname"><a href="../../d3/d58/std_2config_8h.html#a4bd96f3f4cf016f82ffaf82f679288c4">ARC_Config_Get</a></div><div class="ttdeci">void ARC_Config_Get(ARC_Config *config, ARC_String *keyname, void **value)</div><div class="ttdoc">get a value from a given keyname</div></div>
<div class="ttc" id="astd_2config_8h_html_a810e986107e108c65fe808edbd6371af"><div class="ttname"><a href="../../d3/d58/std_2config_8h.html#a810e986107e108c65fe808edbd6371af">ARC_ConfigKey_AddFunc</a></div><div class="ttdeci">void(* ARC_ConfigKey_AddFunc)(ARC_Config *config)</div><div class="ttdoc">external callback to add keys to config</div><div class="ttdef"><b>Definition</b> <a href="#l00069">config.h:69</a></div></div>
<div class="ttc" id="astd_2config_8h_html_aa1ec47a354f6cc1ee8356a098cf5b3c9"><div class="ttname"><a href="../../d3/d58/std_2config_8h.html#aa1ec47a354f6cc1ee8356a098cf5b3c9">ARC_Config_SetGroup</a></div><div class="ttdeci">void ARC_Config_SetGroup(ARC_Config *config, ARC_String *groupname)</div><div class="ttdoc">sets current group in config</div></div>
<div class="ttc" id="astd_2config_8h_html_ad6467c7d5aa224d49620fabc990d13f3"><div class="ttname"><a href="../../d3/d58/std_2config_8h.html#ad6467c7d5aa224d49620fabc990d13f3">ARC_Config_FileIO</a></div><div class="ttdeci">void ARC_Config_FileIO(ARC_Config *config, ARC_String *path, uint8_t command)</div><div class="ttdoc">handles file io for ARC_Config Type</div></div>
<div class="ttc" id="astd_2config_8h_html_ae771a007a23bb925494d68ae7ca212be"><div class="ttname"><a href="../../d3/d58/std_2config_8h.html#ae771a007a23bb925494d68ae7ca212be">ARC_Config_Destroy</a></div><div class="ttdeci">void ARC_Config_Destroy(ARC_Config *config)</div><div class="ttdoc">destroys ARC_Config type</div></div>
<div class="ttc" id="astd_2config_8h_html_af84f4d14d9da265c9f136b832a16bc9c"><div class="ttname"><a href="../../d3/d58/std_2config_8h.html#af84f4d14d9da265c9f136b832a16bc9c">ARC_ConfigKeyDelete</a></div><div class="ttdeci">void(* ARC_ConfigKeyDelete)(ARC_Config *config, ARC_String *string, void *value)</div><div class="ttdoc">a function to delete a value from a key in ARC_Config</div><div class="ttdef"><b>Definition</b> <a href="#l00044">config.h:44</a></div></div>
<div class="ttc" id="astd_2config_8h_html_aff40cd55a3b227cd33334d1c5843ed06"><div class="ttname"><a href="../../d3/d58/std_2config_8h.html#aff40cd55a3b227cd33334d1c5843ed06">ARC_Config_AddKey</a></div><div class="ttdeci">void ARC_Config_AddKey(ARC_Config *config, ARC_String *type, ARC_ConfigKeyRead keyRead, ARC_ConfigKeyDelete keyDelete)</div><div class="ttdoc">adds a usable key to ARC_Config</div></div>
<div class="ttc" id="astd_2defaults_2config_8h_html"><div class="ttname"><a href="../../d2/d8b/std_2defaults_2config_8h.html">config.h</a></div></div>
<div class="ttc" id="astring_8h_html"><div class="ttname"><a href="../../da/d66/string_8h.html">string.h</a></div></div>
<div class="ttc" id="astructARC__String_html"><div class="ttname"><a href="../../df/d06/structARC__String.html">ARC_String</a></div><div class="ttdoc">substring position within a string</div><div class="ttdef"><b>Definition</b> <a href="../../da/d66/string_8h_source.html#l00014">string.h:14</a></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="../../d3/d58/std_2config_8h.html">config.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 Copy permalink