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

645
doc/doxygen/html/d5/d36/parser_8h.html Normal file
View file

@ -0,0 +1,645 @@
<!-- 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/parser.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('d5/d36/parser_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="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">parser.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="../../db/d63/array_8h_source.html">arc/std/array.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d5/df3/lexer_8h_source.html">arc/std/lexer.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d6/d68/vector_8h_source.html">arc/std/vector.h</a>&quot;</code><br />
<code>#include &lt;stdint.h&gt;</code><br />
</div>
<p><a href="../../d5/d36/parser_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="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d0a/structARC__ParserTag.html">ARC_ParserTag</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">a langue tag type for the parser //TODO: explain this better <a href="../../d3/d0a/structARC__ParserTag.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d37/structARC__ParserTagToken.html">ARC_ParserTagToken</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">a parser type used inside of the parser data create function <a href="../../dc/d37/structARC__ParserTagToken.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a49859e4f0658f564f4236d2c4b317852" id="r_a49859e4f0658f564f4236d2c4b317852"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a49859e4f0658f564f4236d2c4b317852">ARC_PARSER_TAG_LAMBDA</a>&#160;&#160;&#160;0</td></tr>
<tr class="memdesc:a49859e4f0658f564f4236d2c4b317852"><td class="mdescLeft">&#160;</td><td class="mdescRight">basic tag for letting the parser know it is ok to end <br /></td></tr>
<tr class="separator:a49859e4f0658f564f4236d2c4b317852"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:af86417aa26af2cf87b688c18e1c42985" id="r_af86417aa26af2cf87b688c18e1c42985"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a></td></tr>
<tr class="memdesc:af86417aa26af2cf87b688c18e1c42985"><td class="mdescLeft">&#160;</td><td class="mdescRight">a parser type <br /></td></tr>
<tr class="separator:af86417aa26af2cf87b688c18e1c42985"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9ea2265d5d0797b7b6fa009beed6aa4" id="r_aa9ea2265d5d0797b7b6fa009beed6aa4"><td class="memItemLeft" align="right" valign="top">typedef struct ARC_ParserTag&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa9ea2265d5d0797b7b6fa009beed6aa4">ARC_ParserTag</a></td></tr>
<tr class="memdesc:aa9ea2265d5d0797b7b6fa009beed6aa4"><td class="mdescLeft">&#160;</td><td class="mdescRight">a langue tag type for the parser //TODO: explain this better <br /></td></tr>
<tr class="separator:aa9ea2265d5d0797b7b6fa009beed6aa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb6d26dc3b6ae7e2049e0e47bdfd3c3e" id="r_afb6d26dc3b6ae7e2049e0e47bdfd3c3e"><td class="memItemLeft" align="right" valign="top">typedef struct ARC_ParserTagToken&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afb6d26dc3b6ae7e2049e0e47bdfd3c3e">ARC_ParserTagToken</a></td></tr>
<tr class="memdesc:afb6d26dc3b6ae7e2049e0e47bdfd3c3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">a parser type used inside of the parser data create function <br /></td></tr>
<tr class="separator:afb6d26dc3b6ae7e2049e0e47bdfd3c3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a852129b2e4cebf0dca9a4d7753093367" id="r_a852129b2e4cebf0dca9a4d7753093367"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a852129b2e4cebf0dca9a4d7753093367">ARC_Parser_InitLexerRulesFn</a>) (<a class="el" href="../../d5/df3/lexer_8h.html#ad48d6475f5cf332db813477ee8621446">ARC_Lexer</a> *lexer)</td></tr>
<tr class="memdesc:a852129b2e4cebf0dca9a4d7753093367"><td class="mdescLeft">&#160;</td><td class="mdescRight">a callback function to initialize the lexer the parser uses with rules <br /></td></tr>
<tr class="separator:a852129b2e4cebf0dca9a4d7753093367"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65a947ffcc719e780cd0df6f37dd84bf" id="r_a65a947ffcc719e780cd0df6f37dd84bf"><td class="memItemLeft" align="right" valign="top">typedef uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a65a947ffcc719e780cd0df6f37dd84bf">ARC_Parser_GetStringIdFn</a>) (<a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *string)</td></tr>
<tr class="memdesc:a65a947ffcc719e780cd0df6f37dd84bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO: write this. <br /></td></tr>
<tr class="separator:a65a947ffcc719e780cd0df6f37dd84bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8cd71477a9351e7cd708b346b945e3bb" id="r_a8cd71477a9351e7cd708b346b945e3bb"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8cd71477a9351e7cd708b346b945e3bb">ARC_ParserData_CreateFn</a>) (void **data, <a class="el" href="../../dc/d37/structARC__ParserTagToken.html">ARC_ParserTagToken</a> *parsedData, void *userData)</td></tr>
<tr class="memdesc:a8cd71477a9351e7cd708b346b945e3bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO: write this. <br /></td></tr>
<tr class="separator:a8cd71477a9351e7cd708b346b945e3bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfe01be54d5787de64d479494ad6aa2d" id="r_abfe01be54d5787de64d479494ad6aa2d"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abfe01be54d5787de64d479494ad6aa2d">ARC_ParserData_DestroyFn</a>) (void *data, <a class="el" href="../../d8/d77/bool_8h.html#aad51710c999c22d9440e5ce0ba8e2c45">ARC_Bool</a> clear, void *userData)</td></tr>
<tr class="memdesc:abfe01be54d5787de64d479494ad6aa2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO: write this. <br /></td></tr>
<tr class="separator:abfe01be54d5787de64d479494ad6aa2d"><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:a1bdcaaa9871c881c8826698840a99d2d" id="r_a1bdcaaa9871c881c8826698840a99d2d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1bdcaaa9871c881c8826698840a99d2d">ARC_Parser_Create</a> (<a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a> **parser, <a class="el" href="../../d3/dac/structARC__Array.html">ARC_Array</a> *language, <a class="el" href="#a852129b2e4cebf0dca9a4d7753093367">ARC_Parser_InitLexerRulesFn</a> initLexerRulesFn, <a class="el" href="#a8cd71477a9351e7cd708b346b945e3bb">ARC_ParserData_CreateFn</a> *createDataFn, <a class="el" href="#abfe01be54d5787de64d479494ad6aa2d">ARC_ParserData_DestroyFn</a> *destroyDataFn, void *userData)</td></tr>
<tr class="memdesc:a1bdcaaa9871c881c8826698840a99d2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">creates an ARC_Parser type <br /></td></tr>
<tr class="separator:a1bdcaaa9871c881c8826698840a99d2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace1a2cfd32a6054ce46a88153024dfb0" id="r_ace1a2cfd32a6054ce46a88153024dfb0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ace1a2cfd32a6054ce46a88153024dfb0">ARC_Parser_CreateFromVector</a> (<a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a> **parser, <a class="el" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *language, <a class="el" href="#a852129b2e4cebf0dca9a4d7753093367">ARC_Parser_InitLexerRulesFn</a> initLexerRulesFn, <a class="el" href="#a8cd71477a9351e7cd708b346b945e3bb">ARC_ParserData_CreateFn</a> *createDataFn, <a class="el" href="#abfe01be54d5787de64d479494ad6aa2d">ARC_ParserData_DestroyFn</a> *destroyDataFn, void *userData)</td></tr>
<tr class="memdesc:ace1a2cfd32a6054ce46a88153024dfb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">creates an ARC_Parser type from an arc vector <br /></td></tr>
<tr class="separator:ace1a2cfd32a6054ce46a88153024dfb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a003b81e4311d906bb549c112036703d6" id="r_a003b81e4311d906bb549c112036703d6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a003b81e4311d906bb549c112036703d6">ARC_Parser_CreateFromString</a> (<a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a> **parser, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *languageString, <a class="el" href="#a852129b2e4cebf0dca9a4d7753093367">ARC_Parser_InitLexerRulesFn</a> initLexerRulesFn, <a class="el" href="#a65a947ffcc719e780cd0df6f37dd84bf">ARC_Parser_GetStringIdFn</a> getStringIdFn, <a class="el" href="#a8cd71477a9351e7cd708b346b945e3bb">ARC_ParserData_CreateFn</a> *createDataFn, <a class="el" href="#abfe01be54d5787de64d479494ad6aa2d">ARC_ParserData_DestroyFn</a> *destroyDataFn, void *userData)</td></tr>
<tr class="memdesc:a003b81e4311d906bb549c112036703d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">creates an ARC_Parser type from a string <br /></td></tr>
<tr class="separator:a003b81e4311d906bb549c112036703d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb54341fc82ed984990434a9885ee644" id="r_adb54341fc82ed984990434a9885ee644"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adb54341fc82ed984990434a9885ee644">ARC_Parser_Destroy</a> (<a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a> *parser)</td></tr>
<tr class="memdesc:adb54341fc82ed984990434a9885ee644"><td class="mdescLeft">&#160;</td><td class="mdescRight">destroys an ARC_Parser type <br /></td></tr>
<tr class="separator:adb54341fc82ed984990434a9885ee644"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7b13da43887f6fd9e4571f3dd477de6" id="r_ac7b13da43887f6fd9e4571f3dd477de6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac7b13da43887f6fd9e4571f3dd477de6">ARC_Parser_Parse</a> (<a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a> *parser, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> **data)</td></tr>
<tr class="separator:ac7b13da43887f6fd9e4571f3dd477de6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07112a0644e5f29259bd814a4b4d5a86" id="r_a07112a0644e5f29259bd814a4b4d5a86"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a07112a0644e5f29259bd814a4b4d5a86">ARC_Parser_ParseFile</a> (<a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a> *parser, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *path)</td></tr>
<tr class="separator:a07112a0644e5f29259bd814a4b4d5a86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1d5928a3b7a1107ae2f93256b8e82df" id="r_af1d5928a3b7a1107ae2f93256b8e82df"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af1d5928a3b7a1107ae2f93256b8e82df">ARC_Parser_ClearData</a> (<a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a> *parser)</td></tr>
<tr class="separator:af1d5928a3b7a1107ae2f93256b8e82df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6a130ed662019fd063f9b613c1b43cd" id="r_af6a130ed662019fd063f9b613c1b43cd"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af6a130ed662019fd063f9b613c1b43cd">ARC_Parser_GetData</a> (<a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a> *parser)</td></tr>
<tr class="separator:af6a130ed662019fd063f9b613c1b43cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a49859e4f0658f564f4236d2c4b317852" name="a49859e4f0658f564f4236d2c4b317852"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49859e4f0658f564f4236d2c4b317852">&#9670;&#160;</a></span>ARC_PARSER_TAG_LAMBDA</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARC_PARSER_TAG_LAMBDA&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p>basic tag for letting the parser know it is ok to end </p>
<p class="definition">Definition at line <a class="el" href="../../d5/d36/parser_8h_source.html#l00150">150</a> of file <a class="el" href="../../d5/d36/parser_8h_source.html">parser.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="af86417aa26af2cf87b688c18e1c42985" name="af86417aa26af2cf87b688c18e1c42985"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af86417aa26af2cf87b688c18e1c42985">&#9670;&#160;</a></span>ARC_Parser</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a> <a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>a parser type </p>
<p class="definition">Definition at line <a class="el" href="../../d5/d36/parser_8h_source.html#l00016">16</a> of file <a class="el" href="../../d5/d36/parser_8h_source.html">parser.h</a>.</p>
</div>
</div>
<a id="a65a947ffcc719e780cd0df6f37dd84bf" name="a65a947ffcc719e780cd0df6f37dd84bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65a947ffcc719e780cd0df6f37dd84bf">&#9670;&#160;</a></span>ARC_Parser_GetStringIdFn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef uint32_t(* ARC_Parser_GetStringIdFn) (<a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *string)</td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO: write this. </p>
<p class="definition">Definition at line <a class="el" href="../../d5/d36/parser_8h_source.html#l00052">52</a> of file <a class="el" href="../../d5/d36/parser_8h_source.html">parser.h</a>.</p>
</div>
</div>
<a id="a852129b2e4cebf0dca9a4d7753093367" name="a852129b2e4cebf0dca9a4d7753093367"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a852129b2e4cebf0dca9a4d7753093367">&#9670;&#160;</a></span>ARC_Parser_InitLexerRulesFn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* ARC_Parser_InitLexerRulesFn) (<a class="el" href="../../d5/df3/lexer_8h.html#ad48d6475f5cf332db813477ee8621446">ARC_Lexer</a> *lexer)</td>
</tr>
</table>
</div><div class="memdoc">
<p>a callback function to initialize the lexer the parser uses with rules </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lexer</td><td>the lexer used by the parser that rules should be added to </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d5/d36/parser_8h_source.html#l00047">47</a> of file <a class="el" href="../../d5/d36/parser_8h_source.html">parser.h</a>.</p>
</div>
</div>
<a id="a8cd71477a9351e7cd708b346b945e3bb" name="a8cd71477a9351e7cd708b346b945e3bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8cd71477a9351e7cd708b346b945e3bb">&#9670;&#160;</a></span>ARC_ParserData_CreateFn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* ARC_ParserData_CreateFn) (void **data, <a class="el" href="../../dc/d37/structARC__ParserTagToken.html">ARC_ParserTagToken</a> *parsedData, void *userData)</td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO: write this. </p>
<p class="definition">Definition at line <a class="el" href="../../d5/d36/parser_8h_source.html#l00057">57</a> of file <a class="el" href="../../d5/d36/parser_8h_source.html">parser.h</a>.</p>
</div>
</div>
<a id="abfe01be54d5787de64d479494ad6aa2d" name="abfe01be54d5787de64d479494ad6aa2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfe01be54d5787de64d479494ad6aa2d">&#9670;&#160;</a></span>ARC_ParserData_DestroyFn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* ARC_ParserData_DestroyFn) (void *data, <a class="el" href="../../d8/d77/bool_8h.html#aad51710c999c22d9440e5ce0ba8e2c45">ARC_Bool</a> clear, void *userData)</td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO: write this. </p>
<p class="definition">Definition at line <a class="el" href="../../d5/d36/parser_8h_source.html#l00062">62</a> of file <a class="el" href="../../d5/d36/parser_8h_source.html">parser.h</a>.</p>
</div>
</div>
<a id="aa9ea2265d5d0797b7b6fa009beed6aa4" name="aa9ea2265d5d0797b7b6fa009beed6aa4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9ea2265d5d0797b7b6fa009beed6aa4">&#9670;&#160;</a></span>ARC_ParserTag</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct ARC_ParserTag ARC_ParserTag</td>
</tr>
</table>
</div><div class="memdoc">
<p>a langue tag type for the parser //TODO: explain this better </p>
</div>
</div>
<a id="afb6d26dc3b6ae7e2049e0e47bdfd3c3e" name="afb6d26dc3b6ae7e2049e0e47bdfd3c3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb6d26dc3b6ae7e2049e0e47bdfd3c3e">&#9670;&#160;</a></span>ARC_ParserTagToken</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct ARC_ParserTagToken ARC_ParserTagToken</td>
</tr>
</table>
</div><div class="memdoc">
<p>a parser type used inside of the parser data create function </p>
<dl class="section note"><dt>Note</dt><dd>there are no public creation and destruction functions for this type as it is only ment to be used within the creation callback </dd>
<dd>
if the parser tag token is a token then tagTokens will be NULL </dd>
<dd>
if the parser tag token is a tag then token will be NULL </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="af1d5928a3b7a1107ae2f93256b8e82df" name="af1d5928a3b7a1107ae2f93256b8e82df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1d5928a3b7a1107ae2f93256b8e82df">&#9670;&#160;</a></span>ARC_Parser_ClearData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Parser_ClearData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a> *</td> <td class="paramname"><span class="paramname"><em>parser</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">parser</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1bdcaaa9871c881c8826698840a99d2d" name="a1bdcaaa9871c881c8826698840a99d2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bdcaaa9871c881c8826698840a99d2d">&#9670;&#160;</a></span>ARC_Parser_Create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Parser_Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a> **</td> <td class="paramname"><span class="paramname"><em>parser</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d3/dac/structARC__Array.html">ARC_Array</a> *</td> <td class="paramname"><span class="paramname"><em>language</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a852129b2e4cebf0dca9a4d7753093367">ARC_Parser_InitLexerRulesFn</a></td> <td class="paramname"><span class="paramname"><em>initLexerRulesFn</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a8cd71477a9351e7cd708b346b945e3bb">ARC_ParserData_CreateFn</a> *</td> <td class="paramname"><span class="paramname"><em>createDataFn</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#abfe01be54d5787de64d479494ad6aa2d">ARC_ParserData_DestroyFn</a> *</td> <td class="paramname"><span class="paramname"><em>destroyDataFn</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>userData</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>creates an ARC_Parser type </p>
<p>@TODO: fix this documentation to reflect changes</p>
<p>@TODO: probs want to move the note to another file </p><dl class="section note"><dt>Note</dt><dd>array of tokens for langauge? like <a class="el" href="../../d3/d0a/structARC__ParserTag.html" title="a langue tag type for the parser //TODO: explain this better">ARC_ParserTag</a> tag = { VARIABLE_NAME, //tagId { { 2, CHAR_OR_NUM, VARIABLE_NAME }, { 1, LAMBDA }, }, //components 2 //componentsSize };</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">parser</td><td>ARC_Parser to create </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">language</td><td>an arry of ARC_ParserLanguageTags defining a langauge </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">initLexerRulesFn</td><td>a callback used to initalize the token rules the lexer within the parser will use </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a003b81e4311d906bb549c112036703d6" name="a003b81e4311d906bb549c112036703d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a003b81e4311d906bb549c112036703d6">&#9670;&#160;</a></span>ARC_Parser_CreateFromString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Parser_CreateFromString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a> **</td> <td class="paramname"><span class="paramname"><em>parser</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>languageString</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a852129b2e4cebf0dca9a4d7753093367">ARC_Parser_InitLexerRulesFn</a></td> <td class="paramname"><span class="paramname"><em>initLexerRulesFn</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a65a947ffcc719e780cd0df6f37dd84bf">ARC_Parser_GetStringIdFn</a></td> <td class="paramname"><span class="paramname"><em>getStringIdFn</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a8cd71477a9351e7cd708b346b945e3bb">ARC_ParserData_CreateFn</a> *</td> <td class="paramname"><span class="paramname"><em>createDataFn</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#abfe01be54d5787de64d479494ad6aa2d">ARC_ParserData_DestroyFn</a> *</td> <td class="paramname"><span class="paramname"><em>destroyDataFn</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>userData</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>creates an ARC_Parser type from a string </p>
<p>@TODO: probs want to move the note to another file </p><dl class="section note"><dt>Note</dt><dd>the syntax looks like: &lt;variable&gt; -&gt; CHAR &lt;variableName&gt; EOF &lt;variableName&gt; -&gt; &lt;charOrNum&gt; &lt;variableName&gt; | LAMBDA &lt;charOrNum&gt; -&gt; CHAR | NUM</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">parser</td><td>ARC_Parser to create </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">language</td><td>an arry of ARC_ParserLanguageTags defining a langauge </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">initLexerRulesFn</td><td>a callback used to initalize the token rules the lexer within the parser will use </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ace1a2cfd32a6054ce46a88153024dfb0" name="ace1a2cfd32a6054ce46a88153024dfb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace1a2cfd32a6054ce46a88153024dfb0">&#9670;&#160;</a></span>ARC_Parser_CreateFromVector()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Parser_CreateFromVector </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a> **</td> <td class="paramname"><span class="paramname"><em>parser</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *</td> <td class="paramname"><span class="paramname"><em>language</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a852129b2e4cebf0dca9a4d7753093367">ARC_Parser_InitLexerRulesFn</a></td> <td class="paramname"><span class="paramname"><em>initLexerRulesFn</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a8cd71477a9351e7cd708b346b945e3bb">ARC_ParserData_CreateFn</a> *</td> <td class="paramname"><span class="paramname"><em>createDataFn</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#abfe01be54d5787de64d479494ad6aa2d">ARC_ParserData_DestroyFn</a> *</td> <td class="paramname"><span class="paramname"><em>destroyDataFn</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>userData</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>creates an ARC_Parser type from an arc vector </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">parser</td><td>ARC_Parser to create </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">language</td><td>an vector of ARC_ParserLanguageTags defining a langauge </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">initLexerRulesFn</td><td>a callback used to initalize the token rules the lexer within the parser will use </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="adb54341fc82ed984990434a9885ee644" name="adb54341fc82ed984990434a9885ee644"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb54341fc82ed984990434a9885ee644">&#9670;&#160;</a></span>ARC_Parser_Destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Parser_Destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a> *</td> <td class="paramname"><span class="paramname"><em>parser</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>destroys an ARC_Parser type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">parser</td><td>ARC_Parser to free </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af6a130ed662019fd063f9b613c1b43cd" name="af6a130ed662019fd063f9b613c1b43cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6a130ed662019fd063f9b613c1b43cd">&#9670;&#160;</a></span>ARC_Parser_GetData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * ARC_Parser_GetData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a> *</td> <td class="paramname"><span class="paramname"><em>parser</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">parser</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac7b13da43887f6fd9e4571f3dd477de6" name="ac7b13da43887f6fd9e4571f3dd477de6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7b13da43887f6fd9e4571f3dd477de6">&#9670;&#160;</a></span>ARC_Parser_Parse()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Parser_Parse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a> *</td> <td class="paramname"><span class="paramname"><em>parser</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>data</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">parser</td><td></td></tr>
<tr><td class="paramdir"></td><td class="paramname">[in/out]</td><td>data the string to parse, will be freed and set to NULL by the end of this function </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a07112a0644e5f29259bd814a4b4d5a86" name="a07112a0644e5f29259bd814a4b4d5a86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07112a0644e5f29259bd814a4b4d5a86">&#9670;&#160;</a></span>ARC_Parser_ParseFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Parser_ParseFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#af86417aa26af2cf87b688c18e1c42985">ARC_Parser</a> *</td> <td class="paramname"><span class="paramname"><em>parser</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>path</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">parser</td><td><br />
</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">language</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.2-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul><li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_8698ff38f6ae643760cdad826b9d4736.html">arc</a></li><li class="navelem"><a class="el" href="../../dir_b3e500eb3a6fe660b1141f591e523c76.html">std</a></li><li class="navelem"><a class="el" href="../../d5/d36/parser_8h.html">parser.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>