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

464
doc/doxygen/html/de/de8/chemical_8h.html Normal file
View file

@ -0,0 +1,464 @@
<!-- 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/chemical.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('de/de8/chemical_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">chemical.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
<code>#include &quot;<a class="el" href="../../d5/d36/parser_8h_source.html">arc/std/parser.h</a>&quot;</code><br />
</div>
<p><a href="../../de/de8/chemical_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:a878b92abe81c5c07d8adaf4685fdf5c8" id="r_a878b92abe81c5c07d8adaf4685fdf5c8"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a878b92abe81c5c07d8adaf4685fdf5c8">ARC_ChemicalData_CopyToTypeFn</a>) (void **data, <a class="el" href="../../dc/d37/structARC__ParserTagToken.html">ARC_ParserTagToken</a> *parsedData)</td></tr>
<tr class="memdesc:a878b92abe81c5c07d8adaf4685fdf5c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO: write this. <br /></td></tr>
<tr class="separator:a878b92abe81c5c07d8adaf4685fdf5c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d9a36eaffba502a7ec8b17ff640787d" id="r_a6d9a36eaffba502a7ec8b17ff640787d"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6d9a36eaffba502a7ec8b17ff640787d">ARC_ParserCSV_DestroyTypeFn</a>) (void *data)</td></tr>
<tr class="memdesc:a6d9a36eaffba502a7ec8b17ff640787d"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO: write this. <br /></td></tr>
<tr class="separator:a6d9a36eaffba502a7ec8b17ff640787d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08f9b566b2b36bdabebfd13eb5754fb1" id="r_a08f9b566b2b36bdabebfd13eb5754fb1"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a></td></tr>
<tr class="memdesc:a08f9b566b2b36bdabebfd13eb5754fb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">a function to read a key from string to a ARC_ConfigTypeTemplate <br /></td></tr>
<tr class="separator:a08f9b566b2b36bdabebfd13eb5754fb1"><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:a57285cb04aa534e1d031332dcaa1a870" id="r_a57285cb04aa534e1d031332dcaa1a870"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a57285cb04aa534e1d031332dcaa1a870">ARC_Chemical_Create</a> (<a class="el" href="#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a> **chemical)</td></tr>
<tr class="memdesc:a57285cb04aa534e1d031332dcaa1a870"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO: write this. <br /></td></tr>
<tr class="separator:a57285cb04aa534e1d031332dcaa1a870"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a686a72bf4514fe44106185d4b5c588ef" id="r_a686a72bf4514fe44106185d4b5c588ef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a686a72bf4514fe44106185d4b5c588ef">ARC_Chemical_Destroy</a> (<a class="el" href="#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a> *chemical)</td></tr>
<tr class="memdesc:a686a72bf4514fe44106185d4b5c588ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO: write this. <br /></td></tr>
<tr class="separator:a686a72bf4514fe44106185d4b5c588ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a585e4d4a2bd7f2484fa3e6a308b483d3" id="r_a585e4d4a2bd7f2484fa3e6a308b483d3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a585e4d4a2bd7f2484fa3e6a308b483d3">ARC_Chemical_RegisterType</a> (<a class="el" href="#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a> *chemical, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *typeName, <a class="el" href="#a878b92abe81c5c07d8adaf4685fdf5c8">ARC_ChemicalData_CopyToTypeFn</a> *copyToTypeFn, <a class="el" href="#a6d9a36eaffba502a7ec8b17ff640787d">ARC_ParserCSV_DestroyTypeFn</a> destroyTypeFn)</td></tr>
<tr class="memdesc:a585e4d4a2bd7f2484fa3e6a308b483d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO: write this. <br /></td></tr>
<tr class="separator:a585e4d4a2bd7f2484fa3e6a308b483d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d6a498f3920dc4bed51fe2e855ef69f" id="r_a5d6a498f3920dc4bed51fe2e855ef69f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5d6a498f3920dc4bed51fe2e855ef69f">ARC_Chemical_SetGroup</a> (<a class="el" href="#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a> *chemical, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *groupName)</td></tr>
<tr class="memdesc:a5d6a498f3920dc4bed51fe2e855ef69f"><td class="mdescLeft">&#160;</td><td class="mdescRight">sets current group in config <br /></td></tr>
<tr class="separator:a5d6a498f3920dc4bed51fe2e855ef69f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb8a34d9191beed01e6fed8a897151c3" id="r_adb8a34d9191beed01e6fed8a897151c3"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adb8a34d9191beed01e6fed8a897151c3">ARC_Chemical_Get</a> (<a class="el" href="#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a> *chemical, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *element)</td></tr>
<tr class="memdesc:adb8a34d9191beed01e6fed8a897151c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">get a value from a given keyname <br /></td></tr>
<tr class="separator:adb8a34d9191beed01e6fed8a897151c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56505ede690711cbfd12c9e56864c4b3" id="r_a56505ede690711cbfd12c9e56864c4b3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a56505ede690711cbfd12c9e56864c4b3">ARC_Chemical_LoadFromString</a> (<a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *path)</td></tr>
<tr class="memdesc:a56505ede690711cbfd12c9e56864c4b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO: write this. <br /></td></tr>
<tr class="separator:a56505ede690711cbfd12c9e56864c4b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12062638bce9e79bc5409a12c05e3023" id="r_a12062638bce9e79bc5409a12c05e3023"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a12062638bce9e79bc5409a12c05e3023">ARC_Chemical_LoadFromFile</a> (<a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *path)</td></tr>
<tr class="memdesc:a12062638bce9e79bc5409a12c05e3023"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO: write this. <br /></td></tr>
<tr class="separator:a12062638bce9e79bc5409a12c05e3023"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad875764e9e18d4aa3db2cf86081d2048" id="r_ad875764e9e18d4aa3db2cf86081d2048"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad875764e9e18d4aa3db2cf86081d2048">ARC_Chemical_UnloadFromString</a> (<a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *data)</td></tr>
<tr class="memdesc:ad875764e9e18d4aa3db2cf86081d2048"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO: write this. <br /></td></tr>
<tr class="separator:ad875764e9e18d4aa3db2cf86081d2048"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43b69b30d57bdf40ffe674e4e0105157" id="r_a43b69b30d57bdf40ffe674e4e0105157"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a43b69b30d57bdf40ffe674e4e0105157">ARC_Chemical_UnloadFromFile</a> (<a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *data)</td></tr>
<tr class="memdesc:a43b69b30d57bdf40ffe674e4e0105157"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO: write this. <br /></td></tr>
<tr class="separator:a43b69b30d57bdf40ffe674e4e0105157"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a08f9b566b2b36bdabebfd13eb5754fb1" name="a08f9b566b2b36bdabebfd13eb5754fb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08f9b566b2b36bdabebfd13eb5754fb1">&#9670;&#160;</a></span>ARC_Chemical</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a> <a class="el" href="#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>a function to read a key from string to a ARC_ConfigTypeTemplate </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>ARC_Config to store data to </td></tr>
<tr><td class="paramname">string</td><td><a class="el" href="../../df/d06/structARC__String.html" title="substring position within a string">ARC_String</a> of data that is being read in </td></tr>
<tr><td class="paramname">value</td><td>value that is read in</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>use ARC_Config_StoreValue(ARC_Config *config, ARC_String *name, void *value); to store a value to the config if there is an error, set arc_errno</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>0 if value not a reference, 1 if value is a reference</dd></dl>
<p>a function to delete a value from a key in ARC_Config</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>ARC_Config that can be used to check for references in data </td></tr>
<tr><td class="paramname">value</td><td>pointer of data to be deleted</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>this function can be NULL if memory does not need to be cleaned for this type if there is an error, set arc_errno</dd></dl>
<p>TODO: write this </p>
<p class="definition">Definition at line <a class="el" href="../../de/de8/chemical_8h_source.html#l00073">73</a> of file <a class="el" href="../../de/de8/chemical_8h_source.html">chemical.h</a>.</p>
</div>
</div>
<a id="a878b92abe81c5c07d8adaf4685fdf5c8" name="a878b92abe81c5c07d8adaf4685fdf5c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a878b92abe81c5c07d8adaf4685fdf5c8">&#9670;&#160;</a></span>ARC_ChemicalData_CopyToTypeFn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* ARC_ChemicalData_CopyToTypeFn) (void **data, <a class="el" href="../../dc/d37/structARC__ParserTagToken.html">ARC_ParserTagToken</a> *parsedData)</td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO: write this. </p>
<p class="definition">Definition at line <a class="el" href="../../de/de8/chemical_8h_source.html#l00038">38</a> of file <a class="el" href="../../de/de8/chemical_8h_source.html">chemical.h</a>.</p>
</div>
</div>
<a id="a6d9a36eaffba502a7ec8b17ff640787d" name="a6d9a36eaffba502a7ec8b17ff640787d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d9a36eaffba502a7ec8b17ff640787d">&#9670;&#160;</a></span>ARC_ParserCSV_DestroyTypeFn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* ARC_ParserCSV_DestroyTypeFn) (void *data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO: write this. </p>
<p class="definition">Definition at line <a class="el" href="../../de/de8/chemical_8h_source.html#l00043">43</a> of file <a class="el" href="../../de/de8/chemical_8h_source.html">chemical.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a57285cb04aa534e1d031332dcaa1a870" name="a57285cb04aa534e1d031332dcaa1a870"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57285cb04aa534e1d031332dcaa1a870">&#9670;&#160;</a></span>ARC_Chemical_Create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Chemical_Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a> **</td> <td class="paramname"><span class="paramname"><em>chemical</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO: write this. </p>
</div>
</div>
<a id="a686a72bf4514fe44106185d4b5c588ef" name="a686a72bf4514fe44106185d4b5c588ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a686a72bf4514fe44106185d4b5c588ef">&#9670;&#160;</a></span>ARC_Chemical_Destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Chemical_Destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a> *</td> <td class="paramname"><span class="paramname"><em>chemical</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO: write this. </p>
</div>
</div>
<a id="adb8a34d9191beed01e6fed8a897151c3" name="adb8a34d9191beed01e6fed8a897151c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb8a34d9191beed01e6fed8a897151c3">&#9670;&#160;</a></span>ARC_Chemical_Get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * ARC_Chemical_Get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a> *</td> <td class="paramname"><span class="paramname"><em>chemical</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>element</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>get a value from a given keyname </p>
<dl class="section note"><dt>Note</dt><dd>name may be prefaced with &lt;group&gt;:: to specify group</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">chemical</td><td>ARC_Chemical to get value from </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">element</td><td>name of a variable that has been read in</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the stored element on success, or NULL on failure </dd></dl>
</div>
</div>
<a id="a12062638bce9e79bc5409a12c05e3023" name="a12062638bce9e79bc5409a12c05e3023"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12062638bce9e79bc5409a12c05e3023">&#9670;&#160;</a></span>ARC_Chemical_LoadFromFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Chemical_LoadFromFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>path</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO: write this. </p>
</div>
</div>
<a id="a56505ede690711cbfd12c9e56864c4b3" name="a56505ede690711cbfd12c9e56864c4b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56505ede690711cbfd12c9e56864c4b3">&#9670;&#160;</a></span>ARC_Chemical_LoadFromString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Chemical_LoadFromString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>path</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO: write this. </p>
</div>
</div>
<a id="a585e4d4a2bd7f2484fa3e6a308b483d3" name="a585e4d4a2bd7f2484fa3e6a308b483d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a585e4d4a2bd7f2484fa3e6a308b483d3">&#9670;&#160;</a></span>ARC_Chemical_RegisterType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Chemical_RegisterType </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a> *</td> <td class="paramname"><span class="paramname"><em>chemical</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>typeName</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a878b92abe81c5c07d8adaf4685fdf5c8">ARC_ChemicalData_CopyToTypeFn</a> *</td> <td class="paramname"><span class="paramname"><em>copyToTypeFn</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a6d9a36eaffba502a7ec8b17ff640787d">ARC_ParserCSV_DestroyTypeFn</a></td> <td class="paramname"><span class="paramname"><em>destroyTypeFn</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO: write this. </p>
</div>
</div>
<a id="a5d6a498f3920dc4bed51fe2e855ef69f" name="a5d6a498f3920dc4bed51fe2e855ef69f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d6a498f3920dc4bed51fe2e855ef69f">&#9670;&#160;</a></span>ARC_Chemical_SetGroup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Chemical_SetGroup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a> *</td> <td class="paramname"><span class="paramname"><em>chemical</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>groupName</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>sets current group in config </p>
<dl class="section note"><dt>Note</dt><dd>ARC_Chemical_Get will use this set group</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">chemical</td><td>ARC_Config we are setting current group in </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">groupname</td><td>name of group that will be set </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a43b69b30d57bdf40ffe674e4e0105157" name="a43b69b30d57bdf40ffe674e4e0105157"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43b69b30d57bdf40ffe674e4e0105157">&#9670;&#160;</a></span>ARC_Chemical_UnloadFromFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Chemical_UnloadFromFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO: write this. </p>
</div>
</div>
<a id="ad875764e9e18d4aa3db2cf86081d2048" name="ad875764e9e18d4aa3db2cf86081d2048"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad875764e9e18d4aa3db2cf86081d2048">&#9670;&#160;</a></span>ARC_Chemical_UnloadFromString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Chemical_UnloadFromString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO: write this. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.2-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul><li class="navelem"><a class="el" href="../../dir_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="../../de/de8/chemical_8h.html">chemical.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>

15
doc/doxygen/html/de/de8/chemical_8h.js Normal file
View file

@ -0,0 +1,15 @@
var chemical_8h =
[
[ "ARC_Chemical", "de/de8/chemical_8h.html#a08f9b566b2b36bdabebfd13eb5754fb1", null ],
[ "ARC_ChemicalData_CopyToTypeFn", "de/de8/chemical_8h.html#a878b92abe81c5c07d8adaf4685fdf5c8", null ],
[ "ARC_ParserCSV_DestroyTypeFn", "de/de8/chemical_8h.html#a6d9a36eaffba502a7ec8b17ff640787d", null ],
[ "ARC_Chemical_Create", "de/de8/chemical_8h.html#a57285cb04aa534e1d031332dcaa1a870", null ],
[ "ARC_Chemical_Destroy", "de/de8/chemical_8h.html#a686a72bf4514fe44106185d4b5c588ef", null ],
[ "ARC_Chemical_Get", "de/de8/chemical_8h.html#adb8a34d9191beed01e6fed8a897151c3", null ],
[ "ARC_Chemical_LoadFromFile", "de/de8/chemical_8h.html#a12062638bce9e79bc5409a12c05e3023", null ],
[ "ARC_Chemical_LoadFromString", "de/de8/chemical_8h.html#a56505ede690711cbfd12c9e56864c4b3", null ],
[ "ARC_Chemical_RegisterType", "de/de8/chemical_8h.html#a585e4d4a2bd7f2484fa3e6a308b483d3", null ],
[ "ARC_Chemical_SetGroup", "de/de8/chemical_8h.html#a5d6a498f3920dc4bed51fe2e855ef69f", null ],
[ "ARC_Chemical_UnloadFromFile", "de/de8/chemical_8h.html#a43b69b30d57bdf40ffe674e4e0105157", null ],
[ "ARC_Chemical_UnloadFromString", "de/de8/chemical_8h.html#ad875764e9e18d4aa3db2cf86081d2048", null ]
];

279
doc/doxygen/html/de/de8/chemical_8h_source.html Normal file
View file

@ -0,0 +1,279 @@
<!-- 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/chemical.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('de/de8/chemical_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">chemical.h</div></div>
</div><!--header-->
<div class="contents">
<a href="../../de/de8/chemical_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_PARSER_CHEMICAL_H_</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ARC_STD_PARSER_CHEMICAL_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 &lt;stdint.h&gt;</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="../../d5/d36/parser_8h.html">arc/std/parser.h</a>&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</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"> * TODO: note here in header that this uses parser</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * TODO: note here in header that group being used is persistant</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">&lt;language&gt; -&gt; &lt;group&gt; &lt;language&gt; | &lt;variableLine&gt; &lt;language&gt; | &lt;whitespace&gt; &lt;language&gt;</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">&lt;group&gt; -&gt; &lt;groupName&gt; &lt;whitespace&gt; &lt;variable&gt; &lt;whitespace&gt; LEFT_CURLY_BRACE &lt;whitespace&gt; &lt;variableLine&gt; &lt;whitespace&gt; RIGHT_CURLY_BRACE</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">&lt;variableLine&gt; -&gt; &lt;type&gt; &lt;whitespace&gt; &lt;variable&gt; &lt;whitespace&gt; EQUALS &lt;whitespace&gt; value &lt;whitespace&gt; SEMICOLON &lt;whitespace&gt;</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"></span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">&lt;groupName&gt; -&gt; &lt;variable&gt;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">&lt;type&gt; -&gt; &lt;variable&gt;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment">&lt;value&gt; -&gt; &lt;variable&gt; | &lt;number&gt; | &lt;nestedValue&gt;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment">&lt;nestedValue&gt; -&gt; OPEN_CURLY_BRACE &lt;whitespace&gt; &lt;valueArgs&gt; &lt;whitespace&gt; CLOSE_CURLY_BRACE</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment">&lt;valueArgs&gt; -&gt; &lt;value&gt; | &lt;value&gt; COMMA &lt;valueArgs&gt;</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"> 26</span><span class="comment">&lt;variable&gt; -&gt; ALPHA_UPPER_CHAR &lt;variableName&gt; | ALPHA_LOWER_CHAR &lt;variableName&gt; | UNDERSCORE &lt;variableName&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment">&lt;variableName&gt; -&gt; &lt;charOrNum&gt; &lt;variableName&gt; | LAMBDA</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">&lt;charOrNum&gt; -&gt; ALPHA_UPPER_CHAR | ALPHA_LOWER_CHAR | UNDERSCORE | NUM</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"></span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">&lt;number&gt; -&gt; NUMBER &lt;number&gt; | NUMBER LAMBDA</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"></span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment">&lt;whitespace&gt; -&gt; SPACE &lt;whitespace&gt; | TAB &lt;whitespace&gt; | NEWLINE &lt;whitespace&gt; | LAMBDA</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment">*/</span></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 TODO: write this</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"><a class="line" href="../../de/de8/chemical_8h.html#a878b92abe81c5c07d8adaf4685fdf5c8"> 38</a></span><span class="keyword">typedef</span> void (* <a class="code hl_typedef" href="../../de/de8/chemical_8h.html#a878b92abe81c5c07d8adaf4685fdf5c8">ARC_ChemicalData_CopyToTypeFn</a>)(<span class="keywordtype">void</span> **data, <a class="code hl_struct" href="../../dc/d37/structARC__ParserTagToken.html">ARC_ParserTagToken</a> *parsedData);</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"> 40</span><span class="comment">/**</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"> * @brief TODO: write this</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"><a class="line" href="../../de/de8/chemical_8h.html#a6d9a36eaffba502a7ec8b17ff640787d"> 43</a></span><span class="keyword">typedef</span> void (* <a class="code hl_typedef" href="../../de/de8/chemical_8h.html#a6d9a36eaffba502a7ec8b17ff640787d">ARC_ParserCSV_DestroyTypeFn</a>)(<span class="keywordtype">void</span> *data);</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">/**</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment"> * @brief a function to read a key from string to a ARC_ConfigTypeTemplate</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"> *</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"> * @param config ARC_Config to store data to</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"> * @param string ARC_String of data that is being read in</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment"> * @param value value that is read in</span></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"> * @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="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment"> * if there is an error, set arc_errno</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"> * @return 0 if value not a reference, 1 if value is a reference</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">//typedef uint8_t (* ARC_ConfigKeyRead)(ARC_Config* config, ARC_String *string, void **value);</span></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 a function to delete a value from a key in ARC_Config</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 config ARC_Config that can be used to check for references in data</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment"> * @param value pointer of data to be deleted</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"> 65</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="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="comment"> * if there is an error, set arc_errno</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">//typedef void (* ARC_ConfigKeyDelete)(ARC_Config* config, ARC_String *string, void *value);</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">/**</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="comment"> * @brief TODO: write this</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment">*/</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="../../de/de8/chemical_8h.html#a08f9b566b2b36bdabebfd13eb5754fb1"> 73</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_typedef" href="../../de/de8/chemical_8h.html#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a> <a class="code hl_typedef" href="../../de/de8/chemical_8h.html#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a>;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="comment"></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"> 76</span><span class="comment"> * @brief TODO: write this</span></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"><a class="line" href="../../de/de8/chemical_8h.html#a57285cb04aa534e1d031332dcaa1a870"> 78</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../de/de8/chemical_8h.html#a57285cb04aa534e1d031332dcaa1a870">ARC_Chemical_Create</a>(<a class="code hl_typedef" href="../../de/de8/chemical_8h.html#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a> **chemical);</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">/**</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment"> * @brief TODO: write this</span></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"><a class="line" href="../../de/de8/chemical_8h.html#a686a72bf4514fe44106185d4b5c588ef"> 83</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../de/de8/chemical_8h.html#a686a72bf4514fe44106185d4b5c588ef">ARC_Chemical_Destroy</a>(<a class="code hl_typedef" href="../../de/de8/chemical_8h.html#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a> *chemical);</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment"></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"> * @brief TODO: write this</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"><a class="line" href="../../de/de8/chemical_8h.html#a585e4d4a2bd7f2484fa3e6a308b483d3"> 88</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../de/de8/chemical_8h.html#a585e4d4a2bd7f2484fa3e6a308b483d3">ARC_Chemical_RegisterType</a>(<a class="code hl_typedef" href="../../de/de8/chemical_8h.html#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a> *chemical, <a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *typeName, <a class="code hl_typedef" href="../../de/de8/chemical_8h.html#a878b92abe81c5c07d8adaf4685fdf5c8">ARC_ChemicalData_CopyToTypeFn</a> *copyToTypeFn, <a class="code hl_typedef" href="../../de/de8/chemical_8h.html#a6d9a36eaffba502a7ec8b17ff640787d">ARC_ParserCSV_DestroyTypeFn</a> destroyTypeFn);</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="comment"></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"> 91</span><span class="comment"> * @brief sets current group in config</span></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"> * @note ARC_Chemical_Get will use this set group</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="comment"> *</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="comment"> * @param[in] chemical ARC_Config we are setting current group in</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="comment"> * @param[in] groupname name of group that will be set</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"><a class="line" href="../../de/de8/chemical_8h.html#a5d6a498f3920dc4bed51fe2e855ef69f"> 98</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../de/de8/chemical_8h.html#a5d6a498f3920dc4bed51fe2e855ef69f">ARC_Chemical_SetGroup</a>(<a class="code hl_typedef" href="../../de/de8/chemical_8h.html#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a> *chemical, <a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *groupName);</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">/**</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="comment"> * @brief get a value from a given keyname</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment"> *</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="comment"> * @note name may be prefaced with &lt;group&gt;:: to specify group</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"> * @param[in] chemical ARC_Chemical to get value from</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="comment"> * @param[in] element name of a variable that has been read in</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="comment"> *</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="comment"> * @return the stored element on success, or NULL on failure</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"><a class="line" href="../../de/de8/chemical_8h.html#adb8a34d9191beed01e6fed8a897151c3"> 110</a></span><span class="keywordtype">void</span> *<a class="code hl_function" href="../../de/de8/chemical_8h.html#adb8a34d9191beed01e6fed8a897151c3">ARC_Chemical_Get</a>(<a class="code hl_typedef" href="../../de/de8/chemical_8h.html#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a> *chemical, <a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *element);</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="comment"></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"> * @brief TODO: write this</span></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"><a class="line" href="../../de/de8/chemical_8h.html#a56505ede690711cbfd12c9e56864c4b3"> 115</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../de/de8/chemical_8h.html#a56505ede690711cbfd12c9e56864c4b3">ARC_Chemical_LoadFromString</a>(<a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *path);</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="comment"></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"> * @brief TODO: write this</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="../../de/de8/chemical_8h.html#a12062638bce9e79bc5409a12c05e3023"> 120</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../de/de8/chemical_8h.html#a12062638bce9e79bc5409a12c05e3023">ARC_Chemical_LoadFromFile</a>(<a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *path);</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span><span class="comment"></span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><span class="comment">/**</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span><span class="comment"> * @brief TODO: write this</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span><span class="comment">*/</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="../../de/de8/chemical_8h.html#ad875764e9e18d4aa3db2cf86081d2048"> 125</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../de/de8/chemical_8h.html#ad875764e9e18d4aa3db2cf86081d2048">ARC_Chemical_UnloadFromString</a>(<a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *data);</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="comment"></span> </div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><span class="comment">/**</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span><span class="comment"> * @brief TODO: write this</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span><span class="comment">*/</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"><a class="line" href="../../de/de8/chemical_8h.html#a43b69b30d57bdf40ffe674e4e0105157"> 130</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../de/de8/chemical_8h.html#a43b69b30d57bdf40ffe674e4e0105157">ARC_Chemical_UnloadFromFile</a>(<a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *data);</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> </div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span>}</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span><span class="preprocessor">#endif </span><span class="comment">//ARC_STD_PARSER_CHEMICAL_H_</span></div>
<div class="ttc" id="achemical_8h_html_a08f9b566b2b36bdabebfd13eb5754fb1"><div class="ttname"><a href="../../de/de8/chemical_8h.html#a08f9b566b2b36bdabebfd13eb5754fb1">ARC_Chemical</a></div><div class="ttdeci">struct ARC_Chemical ARC_Chemical</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="#l00073">chemical.h:73</a></div></div>
<div class="ttc" id="achemical_8h_html_a12062638bce9e79bc5409a12c05e3023"><div class="ttname"><a href="../../de/de8/chemical_8h.html#a12062638bce9e79bc5409a12c05e3023">ARC_Chemical_LoadFromFile</a></div><div class="ttdeci">void ARC_Chemical_LoadFromFile(ARC_String *path)</div><div class="ttdoc">TODO: write this.</div></div>
<div class="ttc" id="achemical_8h_html_a43b69b30d57bdf40ffe674e4e0105157"><div class="ttname"><a href="../../de/de8/chemical_8h.html#a43b69b30d57bdf40ffe674e4e0105157">ARC_Chemical_UnloadFromFile</a></div><div class="ttdeci">void ARC_Chemical_UnloadFromFile(ARC_String *data)</div><div class="ttdoc">TODO: write this.</div></div>
<div class="ttc" id="achemical_8h_html_a56505ede690711cbfd12c9e56864c4b3"><div class="ttname"><a href="../../de/de8/chemical_8h.html#a56505ede690711cbfd12c9e56864c4b3">ARC_Chemical_LoadFromString</a></div><div class="ttdeci">void ARC_Chemical_LoadFromString(ARC_String *path)</div><div class="ttdoc">TODO: write this.</div></div>
<div class="ttc" id="achemical_8h_html_a57285cb04aa534e1d031332dcaa1a870"><div class="ttname"><a href="../../de/de8/chemical_8h.html#a57285cb04aa534e1d031332dcaa1a870">ARC_Chemical_Create</a></div><div class="ttdeci">void ARC_Chemical_Create(ARC_Chemical **chemical)</div><div class="ttdoc">TODO: write this.</div></div>
<div class="ttc" id="achemical_8h_html_a585e4d4a2bd7f2484fa3e6a308b483d3"><div class="ttname"><a href="../../de/de8/chemical_8h.html#a585e4d4a2bd7f2484fa3e6a308b483d3">ARC_Chemical_RegisterType</a></div><div class="ttdeci">void ARC_Chemical_RegisterType(ARC_Chemical *chemical, ARC_String *typeName, ARC_ChemicalData_CopyToTypeFn *copyToTypeFn, ARC_ParserCSV_DestroyTypeFn destroyTypeFn)</div><div class="ttdoc">TODO: write this.</div></div>
<div class="ttc" id="achemical_8h_html_a5d6a498f3920dc4bed51fe2e855ef69f"><div class="ttname"><a href="../../de/de8/chemical_8h.html#a5d6a498f3920dc4bed51fe2e855ef69f">ARC_Chemical_SetGroup</a></div><div class="ttdeci">void ARC_Chemical_SetGroup(ARC_Chemical *chemical, ARC_String *groupName)</div><div class="ttdoc">sets current group in config</div></div>
<div class="ttc" id="achemical_8h_html_a686a72bf4514fe44106185d4b5c588ef"><div class="ttname"><a href="../../de/de8/chemical_8h.html#a686a72bf4514fe44106185d4b5c588ef">ARC_Chemical_Destroy</a></div><div class="ttdeci">void ARC_Chemical_Destroy(ARC_Chemical *chemical)</div><div class="ttdoc">TODO: write this.</div></div>
<div class="ttc" id="achemical_8h_html_a6d9a36eaffba502a7ec8b17ff640787d"><div class="ttname"><a href="../../de/de8/chemical_8h.html#a6d9a36eaffba502a7ec8b17ff640787d">ARC_ParserCSV_DestroyTypeFn</a></div><div class="ttdeci">void(* ARC_ParserCSV_DestroyTypeFn)(void *data)</div><div class="ttdoc">TODO: write this.</div><div class="ttdef"><b>Definition</b> <a href="#l00043">chemical.h:43</a></div></div>
<div class="ttc" id="achemical_8h_html_a878b92abe81c5c07d8adaf4685fdf5c8"><div class="ttname"><a href="../../de/de8/chemical_8h.html#a878b92abe81c5c07d8adaf4685fdf5c8">ARC_ChemicalData_CopyToTypeFn</a></div><div class="ttdeci">void(* ARC_ChemicalData_CopyToTypeFn)(void **data, ARC_ParserTagToken *parsedData)</div><div class="ttdoc">TODO: write this.</div><div class="ttdef"><b>Definition</b> <a href="#l00038">chemical.h:38</a></div></div>
<div class="ttc" id="achemical_8h_html_ad875764e9e18d4aa3db2cf86081d2048"><div class="ttname"><a href="../../de/de8/chemical_8h.html#ad875764e9e18d4aa3db2cf86081d2048">ARC_Chemical_UnloadFromString</a></div><div class="ttdeci">void ARC_Chemical_UnloadFromString(ARC_String *data)</div><div class="ttdoc">TODO: write this.</div></div>
<div class="ttc" id="achemical_8h_html_adb8a34d9191beed01e6fed8a897151c3"><div class="ttname"><a href="../../de/de8/chemical_8h.html#adb8a34d9191beed01e6fed8a897151c3">ARC_Chemical_Get</a></div><div class="ttdeci">void * ARC_Chemical_Get(ARC_Chemical *chemical, ARC_String *element)</div><div class="ttdoc">get a value from a given keyname</div></div>
<div class="ttc" id="aparser_8h_html"><div class="ttname"><a href="../../d5/d36/parser_8h.html">parser.h</a></div></div>
<div class="ttc" id="astructARC__ParserTagToken_html"><div class="ttname"><a href="../../dc/d37/structARC__ParserTagToken.html">ARC_ParserTagToken</a></div><div class="ttdoc">a parser type used inside of the parser data create function</div><div class="ttdef"><b>Definition</b> <a href="../../d5/d36/parser_8h_source.html#l00035">parser.h:35</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="../../de/de8/chemical_8h.html">chemical.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>

130
doc/doxygen/html/de/de8/packages_2input_2glfw_2keyboard_8h.html Normal file
View file

@ -0,0 +1,130 @@
<!-- 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/packages/input/glfw/keyboard.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('de/de8/packages_2input_2glfw_2keyboard_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="headertitle"><div class="title">keyboard.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="../../de/de8/packages_2input_2glfw_2keyboard_8h_source.html">Go to the source code of this file.</a></p>
</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_93501a11e921083efbd154e0cdff5f10.html">packages</a></li><li class="navelem"><a class="el" href="../../dir_51e2434ae88e74fc7fbecce0cef5d995.html">input</a></li><li class="navelem"><a class="el" href="../../dir_4b39d776351c46ae0dc101f31c393a2e.html">glfw</a></li><li class="navelem"><a class="el" href="../../de/de8/packages_2input_2glfw_2keyboard_8h.html">keyboard.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>

155
doc/doxygen/html/de/de8/packages_2input_2glfw_2keyboard_8h_source.html Normal file
View file

@ -0,0 +1,155 @@
<!-- 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/packages/input/glfw/keyboard.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('de/de8/packages_2input_2glfw_2keyboard_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">keyboard.h</div></div>
</div><!--header-->
<div class="contents">
<a href="../../de/de8/packages_2input_2glfw_2keyboard_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_GLFW_KEYBOARD_H_</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ARC_GLFW_KEYBOARD_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 ARC_GLFW_INPUT</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;GLFW/glfw3.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &quot;<a class="code" href="../../d2/d78/include_2arc_2input_2keyboard_8h.html">arc/input/keyboard.h</a>&quot;</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="keyword">struct </span><a class="code hl_struct" href="../../dc/ddf/structARC__Keyboard.html">ARC_Keyboard</a> {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> GLFWwindow *window;</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <a class="code hl_enumeration" href="../../d2/d78/include_2arc_2input_2keyboard_8h.html#a4fa42600e63b733ac23ec8ddfe49573f">ARC_KeyboardState</a> *<a class="code hl_variable" href="../../dc/ddf/structARC__Keyboard.html#a7b573bd9db9e1537a7a4887a7bc2aca5">keys</a>;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <a class="code hl_enumeration" href="../../d2/d78/include_2arc_2input_2keyboard_8h.html#a4fa42600e63b733ac23ec8ddfe49573f">ARC_KeyboardState</a> *<a class="code hl_variable" href="../../dc/ddf/structARC__Keyboard.html#aca2305c054da5935f3f48e1b1f1981f4">released</a>;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span>};</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">struct </span><a class="code hl_typedef" href="../../d2/d78/include_2arc_2input_2keyboard_8h.html#a3f54728e2ec869f82c48e7a97b3fa630">ARC_KeyboardInfo</a> {</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> GLFWwindow *window;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span>};</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#endif </span><span class="comment">// !ARC_GLFW_INPUT</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#endif </span><span class="comment">// !ARC_GLFW_KEYBOARD_H_</span></div>
<div class="ttc" id="ainclude_2arc_2input_2keyboard_8h_html"><div class="ttname"><a href="../../d2/d78/include_2arc_2input_2keyboard_8h.html">keyboard.h</a></div></div>
<div class="ttc" id="ainclude_2arc_2input_2keyboard_8h_html_a3f54728e2ec869f82c48e7a97b3fa630"><div class="ttname"><a href="../../d2/d78/include_2arc_2input_2keyboard_8h.html#a3f54728e2ec869f82c48e7a97b3fa630">ARC_KeyboardInfo</a></div><div class="ttdeci">struct ARC_KeyboardInfo ARC_KeyboardInfo</div><div class="ttdef"><b>Definition</b> <a href="../../d2/d78/include_2arc_2input_2keyboard_8h_source.html#l00017">keyboard.h:17</a></div></div>
<div class="ttc" id="ainclude_2arc_2input_2keyboard_8h_html_a4fa42600e63b733ac23ec8ddfe49573f"><div class="ttname"><a href="../../d2/d78/include_2arc_2input_2keyboard_8h.html#a4fa42600e63b733ac23ec8ddfe49573f">ARC_KeyboardState</a></div><div class="ttdeci">ARC_KeyboardState</div><div class="ttdef"><b>Definition</b> <a href="../../d2/d78/include_2arc_2input_2keyboard_8h_source.html#l00019">keyboard.h:19</a></div></div>
<div class="ttc" id="astructARC__Keyboard_html"><div class="ttname"><a href="../../dc/ddf/structARC__Keyboard.html">ARC_Keyboard</a></div><div class="ttdef"><b>Definition</b> <a href="../../d4/d6b/packages_2input_2sdl_2keyboard_8h_source.html#l00007">keyboard.h:7</a></div></div>
<div class="ttc" id="astructARC__Keyboard_html_a7b573bd9db9e1537a7a4887a7bc2aca5"><div class="ttname"><a href="../../dc/ddf/structARC__Keyboard.html#a7b573bd9db9e1537a7a4887a7bc2aca5">ARC_Keyboard::keys</a></div><div class="ttdeci">ARC_KeyboardState * keys</div><div class="ttdef"><b>Definition</b> <a href="../../d4/d6b/packages_2input_2sdl_2keyboard_8h_source.html#l00010">keyboard.h:10</a></div></div>
<div class="ttc" id="astructARC__Keyboard_html_aca2305c054da5935f3f48e1b1f1981f4"><div class="ttname"><a href="../../dc/ddf/structARC__Keyboard.html#aca2305c054da5935f3f48e1b1f1981f4">ARC_Keyboard::released</a></div><div class="ttdeci">ARC_KeyboardState * released</div><div class="ttdef"><b>Definition</b> <a href="../../d4/d6b/packages_2input_2sdl_2keyboard_8h_source.html#l00011">keyboard.h:11</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_93501a11e921083efbd154e0cdff5f10.html">packages</a></li><li class="navelem"><a class="el" href="../../dir_51e2434ae88e74fc7fbecce0cef5d995.html">input</a></li><li class="navelem"><a class="el" href="../../dir_4b39d776351c46ae0dc101f31c393a2e.html">glfw</a></li><li class="navelem"><a class="el" href="../../de/de8/packages_2input_2glfw_2keyboard_8h.html">keyboard.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>