sapphire/docs/html/Token_8h_source.html
2022-07-02 11:49:51 +02:00

187 lines
17 KiB
HTML

<!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/Token.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="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" />
</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 compiler</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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Token.h</div> </div>
</div><!--header-->
<div class="contents">
<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;Location.h&quot;</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &quot;sapphirepch.h&quot;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">/* All current token types. Will change in the future. */</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="keyword">enum</span> TokenType</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;{</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; TT_Identifier,</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; TT_Number,</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; TT_Float,</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; TT_Keyword,</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; TT_String,</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; TT_Plus,</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; TT_Minus,</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; TT_Mul,</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; TT_Div,</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; TT_At,</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; TT_Equal,</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; TT_LessThan,</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; TT_GreaterThan,</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; TT_LParen,</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; TT_RParen,</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; TT_LBracket,</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; TT_RBracket,</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; TT_Semicolon,</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; TT_LoadedString,</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; TT_EOF,</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; TT_Null,</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; TT_Equals,</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; TT_GTE,</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; TT_LTE,</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; TT_Period,</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; TT_Comma,</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; TT_Path,</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; TT_Exclamation,</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; TT_NEqual,</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; TT_LSQB,</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; TT_RSQB,</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; TT_Type,</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; TT_Import,</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; TT_Syscall0,</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; TT_Syscall1,</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; TT_Syscall2,</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; TT_Syscall3,</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; TT_Syscall4,</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; TT_Syscall5,</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; TT_CompilerMacro</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;};</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword">extern</span> <span class="keyword">const</span> std::string token_strings[];</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="comment">/* Struct to represent tokens generated by the Lexer. */</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structToken.html"> 53</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structToken.html">Token</a></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;{</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; TokenType tk_type;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">int</span> int_value;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; std::string string_value;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">float</span> float_value;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <a class="code" href="structLocation.html">Location</a> loc;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="structToken.html">Token</a>(<span class="keyword">const</span> TokenType&amp; type);</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; <a class="code" href="structToken.html">Token</a>(<span class="keyword">const</span> TokenType&amp; type, <span class="keyword">const</span> <a class="code" href="structLocation.html">Location</a>&amp; location);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <a class="code" href="structToken.html">Token</a>(<span class="keyword">const</span> TokenType&amp; type, <span class="keyword">const</span> <span class="keywordtype">int</span>&amp; val, <span class="keyword">const</span> <a class="code" href="structLocation.html">Location</a>&amp; location);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <a class="code" href="structToken.html">Token</a>(<span class="keyword">const</span> TokenType&amp; type, <span class="keyword">const</span> std::string&amp; val, <span class="keyword">const</span> <a class="code" href="structLocation.html">Location</a>&amp; location);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="structToken.html">Token</a>(<span class="keyword">const</span> TokenType&amp; type, <span class="keyword">const</span> std::string&amp; val);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <a class="code" href="structToken.html">Token</a>(<span class="keyword">const</span> TokenType&amp; type, <span class="keyword">const</span> <span class="keywordtype">float</span>&amp; val, <span class="keyword">const</span> <a class="code" href="structLocation.html">Location</a>&amp; location);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; ~<a class="code" href="structToken.html">Token</a>();</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="comment">/* Return a string representation of the Token&#39;s contents. */</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; std::string to_string() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="comment">/* Return the contents of the line where the Token was located. */</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; std::string line() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="comment">/* Return a copy of the original token, but adding the contents of the line where</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="comment"> the token was located. */</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">static</span> <a class="code" href="structToken.html">Token</a> make_with_line(<span class="keyword">const</span> <a class="code" href="structToken.html">Token</a>&amp; origin, <span class="keyword">const</span> std::string&amp; line_text);</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code" href="structToken.html">Token</a>&amp; other);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="comment">/* Convert the Token into a blank token (does not delete it), so that the Normalizer can remove it afterwards.</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="comment"> This is to not alter vectors while iterating over them. */</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> erase(<a class="code" href="structToken.html">Token</a>&amp; tk);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="comment">/* Return a copy of this Token, but with its TokenType changed. */</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <a class="code" href="structToken.html">Token</a> copy_with_new_type(<span class="keyword">const</span> TokenType&amp; type);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="comment">/* Iterate over two vectors of Tokens, starting from count for vector A, starting from 0 for vector B, checking if</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;<span class="comment"> the current Tokens&#39; types match. If at any point they don&#39;t, return false. Else, return true. */</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> match_token_types(<span class="keyword">const</span> std::vector&lt;Token&gt;&amp; a, <span class="keyword">const</span> std::vector&lt;Token&gt;&amp; b, <span class="keywordtype">int</span> count);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; std::string line_text;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;};</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<span class="comment">/* typedef to make it easier to see a what a std::vector of tokens is being used for. */</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="keyword">typedef</span> std::vector&lt;Token&gt; TokenStream;</div>
<div class="ttc" id="astructLocation_html"><div class="ttname"><a href="structLocation.html">Location</a></div><div class="ttdef"><b>Definition:</b> Location.h:6</div></div>
<div class="ttc" id="astructToken_html"><div class="ttname"><a href="structToken.html">Token</a></div><div class="ttdef"><b>Definition:</b> Token.h:54</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>