blob: b6543f7642a71df1cc6bbf4fb196308c452556ca [file] [log] [blame]
<!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 `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/regex-syntax-0.7.2/src/ast/visitor.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>visitor.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../regex_syntax/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../regex_syntax/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
<span id="511">511</span>
</pre><pre class="rust"><code><span class="kw">use </span>alloc::{vec, vec::Vec};
<span class="kw">use </span><span class="kw">crate</span>::ast::{<span class="self">self</span>, Ast};
<span class="doccomment">/// A trait for visiting an abstract syntax tree (AST) in depth first order.
///
/// The principle aim of this trait is to enable callers to perform case
/// analysis on an abstract syntax tree without necessarily using recursion.
/// In particular, this permits callers to do case analysis with constant stack
/// usage, which can be important since the size of an abstract syntax tree
/// may be proportional to end user input.
///
/// Typical usage of this trait involves providing an implementation and then
/// running it using the [`visit`] function.
///
/// Note that the abstract syntax tree for a regular expression is quite
/// complex. Unless you specifically need it, you might be able to use the much
/// simpler [high-level intermediate representation](crate::hir::Hir) and its
/// [corresponding `Visitor` trait](crate::hir::Visitor) instead.
</span><span class="kw">pub trait </span>Visitor {
<span class="doccomment">/// The result of visiting an AST.
</span><span class="kw">type </span>Output;
<span class="doccomment">/// An error that visiting an AST might return.
</span><span class="kw">type </span><span class="prelude-val">Err</span>;
<span class="doccomment">/// All implementors of `Visitor` must provide a `finish` method, which
/// yields the result of visiting the AST or an error.
</span><span class="kw">fn </span>finish(<span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>::Output, <span class="self">Self</span>::Err&gt;;
<span class="doccomment">/// This method is called before beginning traversal of the AST.
</span><span class="kw">fn </span>start(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {}
<span class="doccomment">/// This method is called on an `Ast` before descending into child `Ast`
/// nodes.
</span><span class="kw">fn </span>visit_pre(<span class="kw-2">&amp;mut </span><span class="self">self</span>, _ast: <span class="kw-2">&amp;</span>Ast) -&gt; <span class="prelude-ty">Result</span>&lt;(), <span class="self">Self</span>::Err&gt; {
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// This method is called on an `Ast` after descending all of its child
/// `Ast` nodes.
</span><span class="kw">fn </span>visit_post(<span class="kw-2">&amp;mut </span><span class="self">self</span>, _ast: <span class="kw-2">&amp;</span>Ast) -&gt; <span class="prelude-ty">Result</span>&lt;(), <span class="self">Self</span>::Err&gt; {
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// This method is called between child nodes of an
/// [`Alternation`](ast::Alternation).
</span><span class="kw">fn </span>visit_alternation_in(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), <span class="self">Self</span>::Err&gt; {
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// This method is called on every [`ClassSetItem`](ast::ClassSetItem)
/// before descending into child nodes.
</span><span class="kw">fn </span>visit_class_set_item_pre(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
_ast: <span class="kw-2">&amp;</span>ast::ClassSetItem,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), <span class="self">Self</span>::Err&gt; {
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// This method is called on every [`ClassSetItem`](ast::ClassSetItem)
/// after descending into child nodes.
</span><span class="kw">fn </span>visit_class_set_item_post(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
_ast: <span class="kw-2">&amp;</span>ast::ClassSetItem,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), <span class="self">Self</span>::Err&gt; {
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// This method is called on every
/// [`ClassSetBinaryOp`](ast::ClassSetBinaryOp) before descending into
/// child nodes.
</span><span class="kw">fn </span>visit_class_set_binary_op_pre(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
_ast: <span class="kw-2">&amp;</span>ast::ClassSetBinaryOp,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), <span class="self">Self</span>::Err&gt; {
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// This method is called on every
/// [`ClassSetBinaryOp`](ast::ClassSetBinaryOp) after descending into child
/// nodes.
</span><span class="kw">fn </span>visit_class_set_binary_op_post(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
_ast: <span class="kw-2">&amp;</span>ast::ClassSetBinaryOp,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), <span class="self">Self</span>::Err&gt; {
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// This method is called between the left hand and right hand child nodes
/// of a [`ClassSetBinaryOp`](ast::ClassSetBinaryOp).
</span><span class="kw">fn </span>visit_class_set_binary_op_in(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
_ast: <span class="kw-2">&amp;</span>ast::ClassSetBinaryOp,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), <span class="self">Self</span>::Err&gt; {
<span class="prelude-val">Ok</span>(())
}
}
<span class="doccomment">/// Executes an implementation of `Visitor` in constant stack space.
///
/// This function will visit every node in the given `Ast` while calling the
/// appropriate methods provided by the [`Visitor`] trait.
///
/// The primary use case for this method is when one wants to perform case
/// analysis over an `Ast` without using a stack size proportional to the depth
/// of the `Ast`. Namely, this method will instead use constant stack size, but
/// will use heap space proportional to the size of the `Ast`. This may be
/// desirable in cases where the size of `Ast` is proportional to end user
/// input.
///
/// If the visitor returns an error at any point, then visiting is stopped and
/// the error is returned.
</span><span class="kw">pub fn </span>visit&lt;V: Visitor&gt;(ast: <span class="kw-2">&amp;</span>Ast, visitor: V) -&gt; <span class="prelude-ty">Result</span>&lt;V::Output, V::Err&gt; {
HeapVisitor::new().visit(ast, visitor)
}
<span class="doccomment">/// HeapVisitor visits every item in an `Ast` recursively using constant stack
/// size and a heap size proportional to the size of the `Ast`.
</span><span class="kw">struct </span>HeapVisitor&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// A stack of `Ast` nodes. This is roughly analogous to the call stack
/// used in a typical recursive visitor.
</span>stack: Vec&lt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Ast, Frame&lt;<span class="lifetime">&#39;a</span>&gt;)&gt;,
<span class="doccomment">/// Similar to the `Ast` stack above, but is used only for character
/// classes. In particular, character classes embed their own mini
/// recursive syntax.
</span>stack_class: Vec&lt;(ClassInduct&lt;<span class="lifetime">&#39;a</span>&gt;, ClassFrame&lt;<span class="lifetime">&#39;a</span>&gt;)&gt;,
}
<span class="doccomment">/// Represents a single stack frame while performing structural induction over
/// an `Ast`.
</span><span class="kw">enum </span>Frame&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// A stack frame allocated just before descending into a repetition
/// operator&#39;s child node.
</span>Repetition(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>ast::Repetition),
<span class="doccomment">/// A stack frame allocated just before descending into a group&#39;s child
/// node.
</span>Group(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>ast::Group),
<span class="doccomment">/// The stack frame used while visiting every child node of a concatenation
/// of expressions.
</span>Concat {
<span class="doccomment">/// The child node we are currently visiting.
</span>head: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Ast,
<span class="doccomment">/// The remaining child nodes to visit (which may be empty).
</span>tail: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[Ast],
},
<span class="doccomment">/// The stack frame used while visiting every child node of an alternation
/// of expressions.
</span>Alternation {
<span class="doccomment">/// The child node we are currently visiting.
</span>head: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Ast,
<span class="doccomment">/// The remaining child nodes to visit (which may be empty).
</span>tail: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[Ast],
},
}
<span class="doccomment">/// Represents a single stack frame while performing structural induction over
/// a character class.
</span><span class="kw">enum </span>ClassFrame&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// The stack frame used while visiting every child node of a union of
/// character class items.
</span>Union {
<span class="doccomment">/// The child node we are currently visiting.
</span>head: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>ast::ClassSetItem,
<span class="doccomment">/// The remaining child nodes to visit (which may be empty).
</span>tail: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[ast::ClassSetItem],
},
<span class="doccomment">/// The stack frame used while a binary class operation.
</span>Binary { op: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>ast::ClassSetBinaryOp },
<span class="doccomment">/// A stack frame allocated just before descending into a binary operator&#39;s
/// left hand child node.
</span>BinaryLHS {
op: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>ast::ClassSetBinaryOp,
lhs: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>ast::ClassSet,
rhs: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>ast::ClassSet,
},
<span class="doccomment">/// A stack frame allocated just before descending into a binary operator&#39;s
/// right hand child node.
</span>BinaryRHS { op: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>ast::ClassSetBinaryOp, rhs: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>ast::ClassSet },
}
<span class="doccomment">/// A representation of the inductive step when performing structural induction
/// over a character class.
///
/// Note that there is no analogous explicit type for the inductive step for
/// `Ast` nodes because the inductive step is just an `Ast`. For character
/// classes, the inductive step can produce one of two possible child nodes:
/// an item or a binary operation. (An item cannot be a binary operation
/// because that would imply binary operations can be unioned in the concrete
/// syntax, which is not possible.)
</span><span class="kw">enum </span>ClassInduct&lt;<span class="lifetime">&#39;a</span>&gt; {
Item(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>ast::ClassSetItem),
BinaryOp(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>ast::ClassSetBinaryOp),
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; HeapVisitor&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">fn </span>new() -&gt; HeapVisitor&lt;<span class="lifetime">&#39;a</span>&gt; {
HeapVisitor { stack: <span class="macro">vec!</span>[], stack_class: <span class="macro">vec!</span>[] }
}
<span class="kw">fn </span>visit&lt;V: Visitor&gt;(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
<span class="kw-2">mut </span>ast: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Ast,
<span class="kw-2">mut </span>visitor: V,
) -&gt; <span class="prelude-ty">Result</span>&lt;V::Output, V::Err&gt; {
<span class="self">self</span>.stack.clear();
<span class="self">self</span>.stack_class.clear();
visitor.start();
<span class="kw">loop </span>{
visitor.visit_pre(ast)<span class="question-mark">?</span>;
<span class="kw">if let </span><span class="prelude-val">Some</span>(x) = <span class="self">self</span>.induct(ast, <span class="kw-2">&amp;mut </span>visitor)<span class="question-mark">? </span>{
<span class="kw">let </span>child = x.child();
<span class="self">self</span>.stack.push((ast, x));
ast = child;
<span class="kw">continue</span>;
}
<span class="comment">// No induction means we have a base case, so we can post visit
// it now.
</span>visitor.visit_post(ast)<span class="question-mark">?</span>;
<span class="comment">// At this point, we now try to pop our call stack until it is
// either empty or we hit another inductive case.
</span><span class="kw">loop </span>{
<span class="kw">let </span>(post_ast, frame) = <span class="kw">match </span><span class="self">self</span>.stack.pop() {
<span class="prelude-val">None </span>=&gt; <span class="kw">return </span>visitor.finish(),
<span class="prelude-val">Some</span>((post_ast, frame)) =&gt; (post_ast, frame),
};
<span class="comment">// If this is a concat/alternate, then we might have additional
// inductive steps to process.
</span><span class="kw">if let </span><span class="prelude-val">Some</span>(x) = <span class="self">self</span>.pop(frame) {
<span class="kw">if let </span>Frame::Alternation { .. } = x {
visitor.visit_alternation_in()<span class="question-mark">?</span>;
}
ast = x.child();
<span class="self">self</span>.stack.push((post_ast, x));
<span class="kw">break</span>;
}
<span class="comment">// Otherwise, we&#39;ve finished visiting all the child nodes for
// this AST, so we can post visit it now.
</span>visitor.visit_post(post_ast)<span class="question-mark">?</span>;
}
}
}
<span class="doccomment">/// Build a stack frame for the given AST if one is needed (which occurs if
/// and only if there are child nodes in the AST). Otherwise, return None.
///
/// If this visits a class, then the underlying visitor implementation may
/// return an error which will be passed on here.
</span><span class="kw">fn </span>induct&lt;V: Visitor&gt;(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
ast: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Ast,
visitor: <span class="kw-2">&amp;mut </span>V,
) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;Frame&lt;<span class="lifetime">&#39;a</span>&gt;&gt;, V::Err&gt; {
<span class="prelude-val">Ok</span>(<span class="kw">match </span><span class="kw-2">*</span>ast {
Ast::Class(ast::Class::Bracketed(<span class="kw-2">ref </span>x)) =&gt; {
<span class="self">self</span>.visit_class(x, visitor)<span class="question-mark">?</span>;
<span class="prelude-val">None
</span>}
Ast::Repetition(<span class="kw-2">ref </span>x) =&gt; <span class="prelude-val">Some</span>(Frame::Repetition(x)),
Ast::Group(<span class="kw-2">ref </span>x) =&gt; <span class="prelude-val">Some</span>(Frame::Group(x)),
Ast::Concat(<span class="kw-2">ref </span>x) <span class="kw">if </span>x.asts.is_empty() =&gt; <span class="prelude-val">None</span>,
Ast::Concat(<span class="kw-2">ref </span>x) =&gt; {
<span class="prelude-val">Some</span>(Frame::Concat { head: <span class="kw-2">&amp;</span>x.asts[<span class="number">0</span>], tail: <span class="kw-2">&amp;</span>x.asts[<span class="number">1</span>..] })
}
Ast::Alternation(<span class="kw-2">ref </span>x) <span class="kw">if </span>x.asts.is_empty() =&gt; <span class="prelude-val">None</span>,
Ast::Alternation(<span class="kw-2">ref </span>x) =&gt; <span class="prelude-val">Some</span>(Frame::Alternation {
head: <span class="kw-2">&amp;</span>x.asts[<span class="number">0</span>],
tail: <span class="kw-2">&amp;</span>x.asts[<span class="number">1</span>..],
}),
<span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
})
}
<span class="doccomment">/// Pops the given frame. If the frame has an additional inductive step,
/// then return it, otherwise return `None`.
</span><span class="kw">fn </span>pop(<span class="kw-2">&amp;</span><span class="self">self</span>, induct: Frame&lt;<span class="lifetime">&#39;a</span>&gt;) -&gt; <span class="prelude-ty">Option</span>&lt;Frame&lt;<span class="lifetime">&#39;a</span>&gt;&gt; {
<span class="kw">match </span>induct {
Frame::Repetition(<span class="kw">_</span>) =&gt; <span class="prelude-val">None</span>,
Frame::Group(<span class="kw">_</span>) =&gt; <span class="prelude-val">None</span>,
Frame::Concat { tail, .. } =&gt; {
<span class="kw">if </span>tail.is_empty() {
<span class="prelude-val">None
</span>} <span class="kw">else </span>{
<span class="prelude-val">Some</span>(Frame::Concat { head: <span class="kw-2">&amp;</span>tail[<span class="number">0</span>], tail: <span class="kw-2">&amp;</span>tail[<span class="number">1</span>..] })
}
}
Frame::Alternation { tail, .. } =&gt; {
<span class="kw">if </span>tail.is_empty() {
<span class="prelude-val">None
</span>} <span class="kw">else </span>{
<span class="prelude-val">Some</span>(Frame::Alternation {
head: <span class="kw-2">&amp;</span>tail[<span class="number">0</span>],
tail: <span class="kw-2">&amp;</span>tail[<span class="number">1</span>..],
})
}
}
}
}
<span class="kw">fn </span>visit_class&lt;V: Visitor&gt;(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
ast: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>ast::ClassBracketed,
visitor: <span class="kw-2">&amp;mut </span>V,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), V::Err&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>ast = ClassInduct::from_bracketed(ast);
<span class="kw">loop </span>{
<span class="self">self</span>.visit_class_pre(<span class="kw-2">&amp;</span>ast, visitor)<span class="question-mark">?</span>;
<span class="kw">if let </span><span class="prelude-val">Some</span>(x) = <span class="self">self</span>.induct_class(<span class="kw-2">&amp;</span>ast) {
<span class="kw">let </span>child = x.child();
<span class="self">self</span>.stack_class.push((ast, x));
ast = child;
<span class="kw">continue</span>;
}
<span class="self">self</span>.visit_class_post(<span class="kw-2">&amp;</span>ast, visitor)<span class="question-mark">?</span>;
<span class="comment">// At this point, we now try to pop our call stack until it is
// either empty or we hit another inductive case.
</span><span class="kw">loop </span>{
<span class="kw">let </span>(post_ast, frame) = <span class="kw">match </span><span class="self">self</span>.stack_class.pop() {
<span class="prelude-val">None </span>=&gt; <span class="kw">return </span><span class="prelude-val">Ok</span>(()),
<span class="prelude-val">Some</span>((post_ast, frame)) =&gt; (post_ast, frame),
};
<span class="comment">// If this is a union or a binary op, then we might have
// additional inductive steps to process.
</span><span class="kw">if let </span><span class="prelude-val">Some</span>(x) = <span class="self">self</span>.pop_class(frame) {
<span class="kw">if let </span>ClassFrame::BinaryRHS { <span class="kw-2">ref </span>op, .. } = x {
visitor.visit_class_set_binary_op_in(op)<span class="question-mark">?</span>;
}
ast = x.child();
<span class="self">self</span>.stack_class.push((post_ast, x));
<span class="kw">break</span>;
}
<span class="comment">// Otherwise, we&#39;ve finished visiting all the child nodes for
// this class node, so we can post visit it now.
</span><span class="self">self</span>.visit_class_post(<span class="kw-2">&amp;</span>post_ast, visitor)<span class="question-mark">?</span>;
}
}
}
<span class="doccomment">/// Call the appropriate `Visitor` methods given an inductive step.
</span><span class="kw">fn </span>visit_class_pre&lt;V: Visitor&gt;(
<span class="kw-2">&amp;</span><span class="self">self</span>,
ast: <span class="kw-2">&amp;</span>ClassInduct&lt;<span class="lifetime">&#39;a</span>&gt;,
visitor: <span class="kw-2">&amp;mut </span>V,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), V::Err&gt; {
<span class="kw">match </span><span class="kw-2">*</span>ast {
ClassInduct::Item(item) =&gt; {
visitor.visit_class_set_item_pre(item)<span class="question-mark">?</span>;
}
ClassInduct::BinaryOp(op) =&gt; {
visitor.visit_class_set_binary_op_pre(op)<span class="question-mark">?</span>;
}
}
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Call the appropriate `Visitor` methods given an inductive step.
</span><span class="kw">fn </span>visit_class_post&lt;V: Visitor&gt;(
<span class="kw-2">&amp;</span><span class="self">self</span>,
ast: <span class="kw-2">&amp;</span>ClassInduct&lt;<span class="lifetime">&#39;a</span>&gt;,
visitor: <span class="kw-2">&amp;mut </span>V,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), V::Err&gt; {
<span class="kw">match </span><span class="kw-2">*</span>ast {
ClassInduct::Item(item) =&gt; {
visitor.visit_class_set_item_post(item)<span class="question-mark">?</span>;
}
ClassInduct::BinaryOp(op) =&gt; {
visitor.visit_class_set_binary_op_post(op)<span class="question-mark">?</span>;
}
}
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Build a stack frame for the given class node if one is needed (which
/// occurs if and only if there are child nodes). Otherwise, return None.
</span><span class="kw">fn </span>induct_class(<span class="kw-2">&amp;</span><span class="self">self</span>, ast: <span class="kw-2">&amp;</span>ClassInduct&lt;<span class="lifetime">&#39;a</span>&gt;) -&gt; <span class="prelude-ty">Option</span>&lt;ClassFrame&lt;<span class="lifetime">&#39;a</span>&gt;&gt; {
<span class="kw">match </span><span class="kw-2">*</span>ast {
ClassInduct::Item(<span class="kw-2">&amp;</span>ast::ClassSetItem::Bracketed(<span class="kw-2">ref </span>x)) =&gt; {
<span class="kw">match </span>x.kind {
ast::ClassSet::Item(<span class="kw-2">ref </span>item) =&gt; {
<span class="prelude-val">Some</span>(ClassFrame::Union { head: item, tail: <span class="kw-2">&amp;</span>[] })
}
ast::ClassSet::BinaryOp(<span class="kw-2">ref </span>op) =&gt; {
<span class="prelude-val">Some</span>(ClassFrame::Binary { op })
}
}
}
ClassInduct::Item(<span class="kw-2">&amp;</span>ast::ClassSetItem::Union(<span class="kw-2">ref </span>x)) =&gt; {
<span class="kw">if </span>x.items.is_empty() {
<span class="prelude-val">None
</span>} <span class="kw">else </span>{
<span class="prelude-val">Some</span>(ClassFrame::Union {
head: <span class="kw-2">&amp;</span>x.items[<span class="number">0</span>],
tail: <span class="kw-2">&amp;</span>x.items[<span class="number">1</span>..],
})
}
}
ClassInduct::BinaryOp(op) =&gt; {
<span class="prelude-val">Some</span>(ClassFrame::BinaryLHS { op, lhs: <span class="kw-2">&amp;</span>op.lhs, rhs: <span class="kw-2">&amp;</span>op.rhs })
}
<span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
}
}
<span class="doccomment">/// Pops the given frame. If the frame has an additional inductive step,
/// then return it, otherwise return `None`.
</span><span class="kw">fn </span>pop_class(<span class="kw-2">&amp;</span><span class="self">self</span>, induct: ClassFrame&lt;<span class="lifetime">&#39;a</span>&gt;) -&gt; <span class="prelude-ty">Option</span>&lt;ClassFrame&lt;<span class="lifetime">&#39;a</span>&gt;&gt; {
<span class="kw">match </span>induct {
ClassFrame::Union { tail, .. } =&gt; {
<span class="kw">if </span>tail.is_empty() {
<span class="prelude-val">None
</span>} <span class="kw">else </span>{
<span class="prelude-val">Some</span>(ClassFrame::Union {
head: <span class="kw-2">&amp;</span>tail[<span class="number">0</span>],
tail: <span class="kw-2">&amp;</span>tail[<span class="number">1</span>..],
})
}
}
ClassFrame::Binary { .. } =&gt; <span class="prelude-val">None</span>,
ClassFrame::BinaryLHS { op, rhs, .. } =&gt; {
<span class="prelude-val">Some</span>(ClassFrame::BinaryRHS { op, rhs })
}
ClassFrame::BinaryRHS { .. } =&gt; <span class="prelude-val">None</span>,
}
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Frame&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// Perform the next inductive step on this frame and return the next
/// child AST node to visit.
</span><span class="kw">fn </span>child(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Ast {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
Frame::Repetition(rep) =&gt; <span class="kw-2">&amp;</span>rep.ast,
Frame::Group(group) =&gt; <span class="kw-2">&amp;</span>group.ast,
Frame::Concat { head, .. } =&gt; head,
Frame::Alternation { head, .. } =&gt; head,
}
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; ClassFrame&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// Perform the next inductive step on this frame and return the next
/// child class node to visit.
</span><span class="kw">fn </span>child(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; ClassInduct&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
ClassFrame::Union { head, .. } =&gt; ClassInduct::Item(head),
ClassFrame::Binary { op, .. } =&gt; ClassInduct::BinaryOp(op),
ClassFrame::BinaryLHS { <span class="kw-2">ref </span>lhs, .. } =&gt; {
ClassInduct::from_set(lhs)
}
ClassFrame::BinaryRHS { <span class="kw-2">ref </span>rhs, .. } =&gt; {
ClassInduct::from_set(rhs)
}
}
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; ClassInduct&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">fn </span>from_bracketed(ast: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>ast::ClassBracketed) -&gt; ClassInduct&lt;<span class="lifetime">&#39;a</span>&gt; {
ClassInduct::from_set(<span class="kw-2">&amp;</span>ast.kind)
}
<span class="kw">fn </span>from_set(ast: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>ast::ClassSet) -&gt; ClassInduct&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">match </span><span class="kw-2">*</span>ast {
ast::ClassSet::Item(<span class="kw-2">ref </span>item) =&gt; ClassInduct::Item(item),
ast::ClassSet::BinaryOp(<span class="kw-2">ref </span>op) =&gt; ClassInduct::BinaryOp(op),
}
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; core::fmt::Debug <span class="kw">for </span>ClassFrame&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>core::fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; core::fmt::Result {
<span class="kw">let </span>x = <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
ClassFrame::Union { .. } =&gt; <span class="string">&quot;Union&quot;</span>,
ClassFrame::Binary { .. } =&gt; <span class="string">&quot;Binary&quot;</span>,
ClassFrame::BinaryLHS { .. } =&gt; <span class="string">&quot;BinaryLHS&quot;</span>,
ClassFrame::BinaryRHS { .. } =&gt; <span class="string">&quot;BinaryRHS&quot;</span>,
};
<span class="macro">write!</span>(f, <span class="string">&quot;{}&quot;</span>, x)
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; core::fmt::Debug <span class="kw">for </span>ClassInduct&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>core::fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; core::fmt::Result {
<span class="kw">let </span>x = <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
ClassInduct::Item(it) =&gt; <span class="kw">match </span><span class="kw-2">*</span>it {
ast::ClassSetItem::Empty(<span class="kw">_</span>) =&gt; <span class="string">&quot;Item(Empty)&quot;</span>,
ast::ClassSetItem::Literal(<span class="kw">_</span>) =&gt; <span class="string">&quot;Item(Literal)&quot;</span>,
ast::ClassSetItem::Range(<span class="kw">_</span>) =&gt; <span class="string">&quot;Item(Range)&quot;</span>,
ast::ClassSetItem::Ascii(<span class="kw">_</span>) =&gt; <span class="string">&quot;Item(Ascii)&quot;</span>,
ast::ClassSetItem::Perl(<span class="kw">_</span>) =&gt; <span class="string">&quot;Item(Perl)&quot;</span>,
ast::ClassSetItem::Unicode(<span class="kw">_</span>) =&gt; <span class="string">&quot;Item(Unicode)&quot;</span>,
ast::ClassSetItem::Bracketed(<span class="kw">_</span>) =&gt; <span class="string">&quot;Item(Bracketed)&quot;</span>,
ast::ClassSetItem::Union(<span class="kw">_</span>) =&gt; <span class="string">&quot;Item(Union)&quot;</span>,
},
ClassInduct::BinaryOp(it) =&gt; <span class="kw">match </span>it.kind {
ast::ClassSetBinaryOpKind::Intersection =&gt; {
<span class="string">&quot;BinaryOp(Intersection)&quot;
</span>}
ast::ClassSetBinaryOpKind::Difference =&gt; {
<span class="string">&quot;BinaryOp(Difference)&quot;
</span>}
ast::ClassSetBinaryOpKind::SymmetricDifference =&gt; {
<span class="string">&quot;BinaryOp(SymmetricDifference)&quot;
</span>}
},
};
<span class="macro">write!</span>(f, <span class="string">&quot;{}&quot;</span>, x)
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="regex_syntax" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>