apio/sapphire
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
af0fb223be
sapphire/docs/html/_parser_8h_source.html

185 lines
17 KiB
HTML
Raw Normal View History

updates
2022-07-02 10:03:06 +00:00
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>sapphirec: src/Parser.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="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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"/>
</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">sapphirec
</div>
<div id="projectbrief">The Sapphire documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_parser_8h_source.html',''); initResizable(); });
/* @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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Parser.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_parser_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_number_node_8h.html">AST/NumberNode.h</a>&quot;</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_error_8h.html">Error.h</a>&quot;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_lexer_8h.html">Lexer.h</a>&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="sapphirepch_8h.html">sapphirepch.h</a>&quot;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">/* Parser class for the Sapphire compiler. */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="class_parser.html"> 8</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_parser.html">Parser</a></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;{</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; <span class="comment">/* Struct to store a parsing result which can be either a parsing error or a success, in which case it contains a</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * pointer to the result. */</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt; <span class="keyword">struct </span>ErrorOr</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; {</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; <span class="comment">/* Return the stored pointer. */</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; std::shared_ptr&lt;T&gt; get()</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; {</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; assert(!m_is_error);</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keywordflow">return</span> m_ptr;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; }</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="comment">/* Call Error::throw_error() with the stored error&#39;s location, line text, and the error string provided to this</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> * struct instance. */</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keywordtype">void</span> ethrow()</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; {</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; assert(m_is_error);</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="namespace_error.html#a52e79c9d3b4d7280ffee959c4646675f">Error::throw_error</a>(error_tok-&gt;loc, error_tok-&gt;line(), m_error);</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; }</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="comment">/* Construct a new successful ErrorOr with a heap-allocated pointer to the result class. */</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; ErrorOr(T* ptr) : m_ptr(ptr), m_is_error(<span class="keyword">false</span>)</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; }</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="comment">/* Construct a new failed ErrorOr with the error details and the token where parsing failed. */</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; ErrorOr(<span class="keyword">const</span> std::string&amp; error, <span class="keyword">const</span> <a class="code" href="struct_token.html">Token</a>&amp; error_tok)</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; : m_error(error), m_is_error(<span class="keyword">true</span>), error_tok(error_tok)</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; }</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="comment">/* Is this ErrorOr instance successful or failed? */</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordtype">bool</span> is_error()</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">return</span> m_is_error;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; }</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">bool</span> m_is_error;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; std::string m_error;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; std::unique_ptr&lt;Token&gt; error_tok;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; std::shared_ptr&lt;T&gt; m_ptr;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; };</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="class_parser.html">Parser</a>(<span class="keyword">const</span> <a class="code" href="_lexer_8h.html#a43f892d4a347a32f8602cfbcff2e237e">TokenStream</a>&amp; tokens);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="_lexer_8h.html#a43f892d4a347a32f8602cfbcff2e237e">TokenStream</a> tokens;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; ErrorOr&lt;ExprNode&gt; walk_expr();</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; ErrorOr&lt;NumberNode&gt; walk_number();</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">int</span> m_index;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordtype">int</span> saved_m_index;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">void</span> save_current_position();</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordtype">void</span> restore_current_position();</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <a class="code" href="class_parser.html#a3e658b5917a93a3ef648050d060e3a93">~Parser</a>();</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="comment">/* Construct a new Parser with the given TokenStream. */</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">static</span> std::shared_ptr&lt;Parser&gt; <a class="code" href="class_parser.html#a94032f3f6e1d0776c1110e82809c65a5">new_parser</a>(<span class="keyword">const</span> <a class="code" href="_lexer_8h.html#a43f892d4a347a32f8602cfbcff2e237e">TokenStream</a>&amp; tokens);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="comment">/* Parse the stored TokenStream and return the top-level node of the result Abstract Syntax Tree. */</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; std::shared_ptr&lt;ASTNode&gt; <a class="code" href="class_parser.html#ae094dfbfd3065ff21b12a9dd19a771ee">parse</a>();</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;};</div>
<div class="ttc" id="a_error_8h_html"><div class="ttname"><a href="_error_8h.html">Error.h</a></div></div>
<div class="ttc" id="a_lexer_8h_html"><div class="ttname"><a href="_lexer_8h.html">Lexer.h</a></div></div>
<div class="ttc" id="a_lexer_8h_html_a43f892d4a347a32f8602cfbcff2e237e"><div class="ttname"><a href="_lexer_8h.html#a43f892d4a347a32f8602cfbcff2e237e">TokenStream</a></div><div class="ttdeci">std::vector&lt; Token &gt; TokenStream</div><div class="ttdef"><b>Definition:</b> Lexer.h:7</div></div>
<div class="ttc" id="a_number_node_8h_html"><div class="ttname"><a href="_number_node_8h.html">NumberNode.h</a></div></div>
<div class="ttc" id="aclass_parser_html"><div class="ttname"><a href="class_parser.html">Parser</a></div><div class="ttdef"><b>Definition:</b> Parser.h:9</div></div>
<div class="ttc" id="aclass_parser_html_a3e658b5917a93a3ef648050d060e3a93"><div class="ttname"><a href="class_parser.html#a3e658b5917a93a3ef648050d060e3a93">Parser::~Parser</a></div><div class="ttdeci">~Parser()</div><div class="ttdef"><b>Definition:</b> Parser.cpp:7</div></div>
<div class="ttc" id="aclass_parser_html_a94032f3f6e1d0776c1110e82809c65a5"><div class="ttname"><a href="class_parser.html#a94032f3f6e1d0776c1110e82809c65a5">Parser::new_parser</a></div><div class="ttdeci">static std::shared_ptr&lt; Parser &gt; new_parser(const TokenStream &amp;tokens)</div><div class="ttdef"><b>Definition:</b> Parser.cpp:11</div></div>
<div class="ttc" id="aclass_parser_html_ae094dfbfd3065ff21b12a9dd19a771ee"><div class="ttname"><a href="class_parser.html#ae094dfbfd3065ff21b12a9dd19a771ee">Parser::parse</a></div><div class="ttdeci">std::shared_ptr&lt; ASTNode &gt; parse()</div><div class="ttdef"><b>Definition:</b> Parser.cpp:17</div></div>
<div class="ttc" id="anamespace_error_html_a52e79c9d3b4d7280ffee959c4646675f"><div class="ttname"><a href="namespace_error.html#a52e79c9d3b4d7280ffee959c4646675f">Error::throw_error</a></div><div class="ttdeci">void throw_error(const Location &amp;loc, const std::string line_text, const std::string &amp;details)</div><div class="ttdef"><b>Definition:</b> Error.cpp:41</div></div>
<div class="ttc" id="asapphirepch_8h_html"><div class="ttname"><a href="sapphirepch_8h.html">sapphirepch.h</a></div></div>
<div class="ttc" id="astruct_token_html"><div class="ttname"><a href="struct_token.html">Token</a></div><div class="ttdef"><b>Definition:</b> Token.h:54</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_parser_8h.html">Parser.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink