| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `crates/parser/src/output.rs`."><title>output.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="parser" data-themes="" data-resource-suffix="" data-rustdoc-version="1.91.1 (ed61e7d7e 2025-11-07)" data-channel="1.91.1" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-6dc2a7f3.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">parser/</div>output.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! See [`Output`] |
| <a href=#2 id=2 data-nosnippet>2</a> |
| <a href=#3 id=3 data-nosnippet>3</a></span><span class="kw">use </span><span class="kw">crate</span>::SyntaxKind; |
| <a href=#4 id=4 data-nosnippet>4</a> |
| <a href=#5 id=5 data-nosnippet>5</a><span class="doccomment">/// Output of the parser -- a DFS traversal of a concrete syntax tree. |
| <a href=#6 id=6 data-nosnippet>6</a>/// |
| <a href=#7 id=7 data-nosnippet>7</a>/// Use the [`Output::iter`] method to iterate over traversal steps and consume |
| <a href=#8 id=8 data-nosnippet>8</a>/// a syntax tree. |
| <a href=#9 id=9 data-nosnippet>9</a>/// |
| <a href=#10 id=10 data-nosnippet>10</a>/// In a sense, this is just a sequence of [`SyntaxKind`]-colored parenthesis |
| <a href=#11 id=11 data-nosnippet>11</a>/// interspersed into the original [`crate::Input`]. The output is fundamentally |
| <a href=#12 id=12 data-nosnippet>12</a>/// coordinated with the input and `n_input_tokens` refers to the number of |
| <a href=#13 id=13 data-nosnippet>13</a>/// times [`crate::Input::push`] was called. |
| <a href=#14 id=14 data-nosnippet>14</a></span><span class="attr">#[derive(Default)] |
| <a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">pub struct </span>Output { |
| <a href=#16 id=16 data-nosnippet>16</a> <span class="doccomment">/// 32-bit encoding of events. If LSB is zero, then that's an index into the |
| <a href=#17 id=17 data-nosnippet>17</a> /// error vector. Otherwise, it's one of the thee other variants, with data encoded as |
| <a href=#18 id=18 data-nosnippet>18</a> /// |
| <a href=#19 id=19 data-nosnippet>19</a> /// ```text |
| <a href=#20 id=20 data-nosnippet>20</a> /// |16 bit kind|8 bit n_input_tokens|4 bit tag|4 bit leftover| |
| <a href=#21 id=21 data-nosnippet>21</a> /// `````` |
| <a href=#22 id=22 data-nosnippet>22</a> </span>event: Vec<u32>, |
| <a href=#23 id=23 data-nosnippet>23</a> error: Vec<String>, |
| <a href=#24 id=24 data-nosnippet>24</a>} |
| <a href=#25 id=25 data-nosnippet>25</a> |
| <a href=#26 id=26 data-nosnippet>26</a><span class="attr">#[derive(Debug)] |
| <a href=#27 id=27 data-nosnippet>27</a></span><span class="kw">pub enum </span>Step<<span class="lifetime">'a</span>> { |
| <a href=#28 id=28 data-nosnippet>28</a> Token { kind: SyntaxKind, n_input_tokens: u8 }, |
| <a href=#29 id=29 data-nosnippet>29</a> FloatSplit { ends_in_dot: bool }, |
| <a href=#30 id=30 data-nosnippet>30</a> Enter { kind: SyntaxKind }, |
| <a href=#31 id=31 data-nosnippet>31</a> Exit, |
| <a href=#32 id=32 data-nosnippet>32</a> Error { msg: <span class="kw-2">&</span><span class="lifetime">'a </span>str }, |
| <a href=#33 id=33 data-nosnippet>33</a>} |
| <a href=#34 id=34 data-nosnippet>34</a> |
| <a href=#35 id=35 data-nosnippet>35</a><span class="kw">impl </span>Output { |
| <a href=#36 id=36 data-nosnippet>36</a> <span class="kw">const </span>EVENT_MASK: u32 = <span class="number">0b1</span>; |
| <a href=#37 id=37 data-nosnippet>37</a> <span class="kw">const </span>TAG_MASK: u32 = <span class="number">0x0000_00F0</span>; |
| <a href=#38 id=38 data-nosnippet>38</a> <span class="kw">const </span>N_INPUT_TOKEN_MASK: u32 = <span class="number">0x0000_FF00</span>; |
| <a href=#39 id=39 data-nosnippet>39</a> <span class="kw">const </span>KIND_MASK: u32 = <span class="number">0xFFFF_0000</span>; |
| <a href=#40 id=40 data-nosnippet>40</a> |
| <a href=#41 id=41 data-nosnippet>41</a> <span class="kw">const </span>ERROR_SHIFT: u32 = <span class="self">Self</span>::EVENT_MASK.trailing_ones(); |
| <a href=#42 id=42 data-nosnippet>42</a> <span class="kw">const </span>TAG_SHIFT: u32 = <span class="self">Self</span>::TAG_MASK.trailing_zeros(); |
| <a href=#43 id=43 data-nosnippet>43</a> <span class="kw">const </span>N_INPUT_TOKEN_SHIFT: u32 = <span class="self">Self</span>::N_INPUT_TOKEN_MASK.trailing_zeros(); |
| <a href=#44 id=44 data-nosnippet>44</a> <span class="kw">const </span>KIND_SHIFT: u32 = <span class="self">Self</span>::KIND_MASK.trailing_zeros(); |
| <a href=#45 id=45 data-nosnippet>45</a> |
| <a href=#46 id=46 data-nosnippet>46</a> <span class="kw">const </span>TOKEN_EVENT: u8 = <span class="number">0</span>; |
| <a href=#47 id=47 data-nosnippet>47</a> <span class="kw">const </span>ENTER_EVENT: u8 = <span class="number">1</span>; |
| <a href=#48 id=48 data-nosnippet>48</a> <span class="kw">const </span>EXIT_EVENT: u8 = <span class="number">2</span>; |
| <a href=#49 id=49 data-nosnippet>49</a> <span class="kw">const </span>SPLIT_EVENT: u8 = <span class="number">3</span>; |
| <a href=#50 id=50 data-nosnippet>50</a> |
| <a href=#51 id=51 data-nosnippet>51</a> <span class="kw">pub fn </span>iter(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw">impl </span>Iterator<Item = Step<<span class="lifetime">'_</span>>> { |
| <a href=#52 id=52 data-nosnippet>52</a> <span class="self">self</span>.event.iter().map(|<span class="kw-2">&</span>event| { |
| <a href=#53 id=53 data-nosnippet>53</a> <span class="kw">if </span>event & <span class="self">Self</span>::EVENT_MASK == <span class="number">0 </span>{ |
| <a href=#54 id=54 data-nosnippet>54</a> <span class="kw">return </span>Step::Error { |
| <a href=#55 id=55 data-nosnippet>55</a> msg: <span class="self">self</span>.error[(event <span class="kw">as </span>usize) >> <span class="self">Self</span>::ERROR_SHIFT].as_str(), |
| <a href=#56 id=56 data-nosnippet>56</a> }; |
| <a href=#57 id=57 data-nosnippet>57</a> } |
| <a href=#58 id=58 data-nosnippet>58</a> <span class="kw">let </span>tag = ((event & <span class="self">Self</span>::TAG_MASK) >> <span class="self">Self</span>::TAG_SHIFT) <span class="kw">as </span>u8; |
| <a href=#59 id=59 data-nosnippet>59</a> <span class="kw">match </span>tag { |
| <a href=#60 id=60 data-nosnippet>60</a> <span class="self">Self</span>::TOKEN_EVENT => { |
| <a href=#61 id=61 data-nosnippet>61</a> <span class="kw">let </span>kind: SyntaxKind = |
| <a href=#62 id=62 data-nosnippet>62</a> (((event & <span class="self">Self</span>::KIND_MASK) >> <span class="self">Self</span>::KIND_SHIFT) <span class="kw">as </span>u16).into(); |
| <a href=#63 id=63 data-nosnippet>63</a> <span class="kw">let </span>n_input_tokens = |
| <a href=#64 id=64 data-nosnippet>64</a> ((event & <span class="self">Self</span>::N_INPUT_TOKEN_MASK) >> <span class="self">Self</span>::N_INPUT_TOKEN_SHIFT) <span class="kw">as </span>u8; |
| <a href=#65 id=65 data-nosnippet>65</a> Step::Token { kind, n_input_tokens } |
| <a href=#66 id=66 data-nosnippet>66</a> } |
| <a href=#67 id=67 data-nosnippet>67</a> <span class="self">Self</span>::ENTER_EVENT => { |
| <a href=#68 id=68 data-nosnippet>68</a> <span class="kw">let </span>kind: SyntaxKind = |
| <a href=#69 id=69 data-nosnippet>69</a> (((event & <span class="self">Self</span>::KIND_MASK) >> <span class="self">Self</span>::KIND_SHIFT) <span class="kw">as </span>u16).into(); |
| <a href=#70 id=70 data-nosnippet>70</a> Step::Enter { kind } |
| <a href=#71 id=71 data-nosnippet>71</a> } |
| <a href=#72 id=72 data-nosnippet>72</a> <span class="self">Self</span>::EXIT_EVENT => Step::Exit, |
| <a href=#73 id=73 data-nosnippet>73</a> <span class="self">Self</span>::SPLIT_EVENT => { |
| <a href=#74 id=74 data-nosnippet>74</a> Step::FloatSplit { ends_in_dot: event & <span class="self">Self</span>::N_INPUT_TOKEN_MASK != <span class="number">0 </span>} |
| <a href=#75 id=75 data-nosnippet>75</a> } |
| <a href=#76 id=76 data-nosnippet>76</a> <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| <a href=#77 id=77 data-nosnippet>77</a> } |
| <a href=#78 id=78 data-nosnippet>78</a> }) |
| <a href=#79 id=79 data-nosnippet>79</a> } |
| <a href=#80 id=80 data-nosnippet>80</a> |
| <a href=#81 id=81 data-nosnippet>81</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>token(<span class="kw-2">&mut </span><span class="self">self</span>, kind: SyntaxKind, n_tokens: u8) { |
| <a href=#82 id=82 data-nosnippet>82</a> <span class="kw">let </span>e = ((kind <span class="kw">as </span>u16 <span class="kw">as </span>u32) << <span class="self">Self</span>::KIND_SHIFT) |
| <a href=#83 id=83 data-nosnippet>83</a> | ((n_tokens <span class="kw">as </span>u32) << <span class="self">Self</span>::N_INPUT_TOKEN_SHIFT) |
| <a href=#84 id=84 data-nosnippet>84</a> | <span class="self">Self</span>::EVENT_MASK; |
| <a href=#85 id=85 data-nosnippet>85</a> <span class="self">self</span>.event.push(e) |
| <a href=#86 id=86 data-nosnippet>86</a> } |
| <a href=#87 id=87 data-nosnippet>87</a> |
| <a href=#88 id=88 data-nosnippet>88</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>float_split_hack(<span class="kw-2">&mut </span><span class="self">self</span>, ends_in_dot: bool) { |
| <a href=#89 id=89 data-nosnippet>89</a> <span class="kw">let </span>e = ((<span class="self">Self</span>::SPLIT_EVENT <span class="kw">as </span>u32) << <span class="self">Self</span>::TAG_SHIFT) |
| <a href=#90 id=90 data-nosnippet>90</a> | ((ends_in_dot <span class="kw">as </span>u32) << <span class="self">Self</span>::N_INPUT_TOKEN_SHIFT) |
| <a href=#91 id=91 data-nosnippet>91</a> | <span class="self">Self</span>::EVENT_MASK; |
| <a href=#92 id=92 data-nosnippet>92</a> <span class="self">self</span>.event.push(e); |
| <a href=#93 id=93 data-nosnippet>93</a> } |
| <a href=#94 id=94 data-nosnippet>94</a> |
| <a href=#95 id=95 data-nosnippet>95</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>enter_node(<span class="kw-2">&mut </span><span class="self">self</span>, kind: SyntaxKind) { |
| <a href=#96 id=96 data-nosnippet>96</a> <span class="kw">let </span>e = ((kind <span class="kw">as </span>u16 <span class="kw">as </span>u32) << <span class="self">Self</span>::KIND_SHIFT) |
| <a href=#97 id=97 data-nosnippet>97</a> | ((<span class="self">Self</span>::ENTER_EVENT <span class="kw">as </span>u32) << <span class="self">Self</span>::TAG_SHIFT) |
| <a href=#98 id=98 data-nosnippet>98</a> | <span class="self">Self</span>::EVENT_MASK; |
| <a href=#99 id=99 data-nosnippet>99</a> <span class="self">self</span>.event.push(e) |
| <a href=#100 id=100 data-nosnippet>100</a> } |
| <a href=#101 id=101 data-nosnippet>101</a> |
| <a href=#102 id=102 data-nosnippet>102</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>leave_node(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <a href=#103 id=103 data-nosnippet>103</a> <span class="kw">let </span>e = ((<span class="self">Self</span>::EXIT_EVENT <span class="kw">as </span>u32) << <span class="self">Self</span>::TAG_SHIFT) | <span class="self">Self</span>::EVENT_MASK; |
| <a href=#104 id=104 data-nosnippet>104</a> <span class="self">self</span>.event.push(e) |
| <a href=#105 id=105 data-nosnippet>105</a> } |
| <a href=#106 id=106 data-nosnippet>106</a> |
| <a href=#107 id=107 data-nosnippet>107</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>error(<span class="kw-2">&mut </span><span class="self">self</span>, error: String) { |
| <a href=#108 id=108 data-nosnippet>108</a> <span class="kw">let </span>idx = <span class="self">self</span>.error.len(); |
| <a href=#109 id=109 data-nosnippet>109</a> <span class="self">self</span>.error.push(error); |
| <a href=#110 id=110 data-nosnippet>110</a> <span class="kw">let </span>e = (idx <span class="kw">as </span>u32) << <span class="self">Self</span>::ERROR_SHIFT; |
| <a href=#111 id=111 data-nosnippet>111</a> <span class="self">self</span>.event.push(e); |
| <a href=#112 id=112 data-nosnippet>112</a> } |
| <a href=#113 id=113 data-nosnippet>113</a>}</code></pre></div></section></main></body></html> |
