| <!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/error.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>error.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> |
| </pre><pre class="rust"><code><span class="kw">use </span>alloc::{ |
| format, |
| string::{String, ToString}, |
| vec, |
| vec::Vec, |
| }; |
| |
| <span class="kw">use crate</span>::{ast, hir}; |
| |
| <span class="doccomment">/// This error type encompasses any error that can be returned by this crate. |
| /// |
| /// This error type is marked as `non_exhaustive`. This means that adding a |
| /// new variant is not considered a breaking change. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Clone, Debug, Eq, PartialEq)] |
| </span><span class="kw">pub enum </span>Error { |
| <span class="doccomment">/// An error that occurred while translating concrete syntax into abstract |
| /// syntax (AST). |
| </span>Parse(ast::Error), |
| <span class="doccomment">/// An error that occurred while translating abstract syntax into a high |
| /// level intermediate representation (HIR). |
| </span>Translate(hir::Error), |
| } |
| |
| <span class="kw">impl </span>From<ast::Error> <span class="kw">for </span>Error { |
| <span class="kw">fn </span>from(err: ast::Error) -> Error { |
| Error::Parse(err) |
| } |
| } |
| |
| <span class="kw">impl </span>From<hir::Error> <span class="kw">for </span>Error { |
| <span class="kw">fn </span>from(err: hir::Error) -> Error { |
| Error::Translate(err) |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">impl </span>std::error::Error <span class="kw">for </span>Error {} |
| |
| <span class="kw">impl </span>core::fmt::Display <span class="kw">for </span>Error { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>core::fmt::Formatter<<span class="lifetime">'_</span>>) -> core::fmt::Result { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| Error::Parse(<span class="kw-2">ref </span>x) => x.fmt(f), |
| Error::Translate(<span class="kw-2">ref </span>x) => x.fmt(f), |
| } |
| } |
| } |
| |
| <span class="doccomment">/// A helper type for formatting nice error messages. |
| /// |
| /// This type is responsible for reporting regex parse errors in a nice human |
| /// readable format. Most of its complexity is from interspersing notational |
| /// markers pointing out the position where an error occurred. |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>Formatter<<span class="lifetime">'e</span>, E> { |
| <span class="doccomment">/// The original regex pattern in which the error occurred. |
| </span>pattern: <span class="kw-2">&</span><span class="lifetime">'e </span>str, |
| <span class="doccomment">/// The error kind. It must impl fmt::Display. |
| </span>err: <span class="kw-2">&</span><span class="lifetime">'e </span>E, |
| <span class="doccomment">/// The primary span of the error. |
| </span>span: <span class="kw-2">&</span><span class="lifetime">'e </span>ast::Span, |
| <span class="doccomment">/// An auxiliary and optional span, in case the error needs to point to |
| /// two locations (e.g., when reporting a duplicate capture group name). |
| </span>aux_span: <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'e </span>ast::Span>, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'e</span>> From<<span class="kw-2">&</span><span class="lifetime">'e </span>ast::Error> <span class="kw">for </span>Formatter<<span class="lifetime">'e</span>, ast::ErrorKind> { |
| <span class="kw">fn </span>from(err: <span class="kw-2">&</span><span class="lifetime">'e </span>ast::Error) -> <span class="self">Self </span>{ |
| Formatter { |
| pattern: err.pattern(), |
| err: err.kind(), |
| span: err.span(), |
| aux_span: err.auxiliary_span(), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'e</span>> From<<span class="kw-2">&</span><span class="lifetime">'e </span>hir::Error> <span class="kw">for </span>Formatter<<span class="lifetime">'e</span>, hir::ErrorKind> { |
| <span class="kw">fn </span>from(err: <span class="kw-2">&</span><span class="lifetime">'e </span>hir::Error) -> <span class="self">Self </span>{ |
| Formatter { |
| pattern: err.pattern(), |
| err: err.kind(), |
| span: err.span(), |
| aux_span: <span class="prelude-val">None</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'e</span>, E: core::fmt::Display> core::fmt::Display <span class="kw">for </span>Formatter<<span class="lifetime">'e</span>, E> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>core::fmt::Formatter<<span class="lifetime">'_</span>>) -> core::fmt::Result { |
| <span class="kw">let </span>spans = Spans::from_formatter(<span class="self">self</span>); |
| <span class="kw">if </span><span class="self">self</span>.pattern.contains(<span class="string">'\n'</span>) { |
| <span class="kw">let </span>divider = repeat_char(<span class="string">'~'</span>, <span class="number">79</span>); |
| |
| <span class="macro">writeln!</span>(f, <span class="string">"regex parse error:"</span>)<span class="question-mark">?</span>; |
| <span class="macro">writeln!</span>(f, <span class="string">"{}"</span>, divider)<span class="question-mark">?</span>; |
| <span class="kw">let </span>notated = spans.notate(); |
| <span class="macro">write!</span>(f, <span class="string">"{}"</span>, notated)<span class="question-mark">?</span>; |
| <span class="macro">writeln!</span>(f, <span class="string">"{}"</span>, divider)<span class="question-mark">?</span>; |
| <span class="comment">// If we have error spans that cover multiple lines, then we just |
| // note the line numbers. |
| </span><span class="kw">if </span>!spans.multi_line.is_empty() { |
| <span class="kw">let </span><span class="kw-2">mut </span>notes = <span class="macro">vec!</span>[]; |
| <span class="kw">for </span>span <span class="kw">in </span><span class="kw-2">&</span>spans.multi_line { |
| notes.push(<span class="macro">format!</span>( |
| <span class="string">"on line {} (column {}) through line {} (column {})"</span>, |
| span.start.line, |
| span.start.column, |
| span.end.line, |
| span.end.column - <span class="number">1 |
| </span>)); |
| } |
| <span class="macro">writeln!</span>(f, <span class="string">"{}"</span>, notes.join(<span class="string">"\n"</span>))<span class="question-mark">?</span>; |
| } |
| <span class="macro">write!</span>(f, <span class="string">"error: {}"</span>, <span class="self">self</span>.err)<span class="question-mark">?</span>; |
| } <span class="kw">else </span>{ |
| <span class="macro">writeln!</span>(f, <span class="string">"regex parse error:"</span>)<span class="question-mark">?</span>; |
| <span class="kw">let </span>notated = Spans::from_formatter(<span class="self">self</span>).notate(); |
| <span class="macro">write!</span>(f, <span class="string">"{}"</span>, notated)<span class="question-mark">?</span>; |
| <span class="macro">write!</span>(f, <span class="string">"error: {}"</span>, <span class="self">self</span>.err)<span class="question-mark">?</span>; |
| } |
| <span class="prelude-val">Ok</span>(()) |
| } |
| } |
| |
| <span class="doccomment">/// This type represents an arbitrary number of error spans in a way that makes |
| /// it convenient to notate the regex pattern. ("Notate" means "point out |
| /// exactly where the error occurred in the regex pattern.") |
| /// |
| /// Technically, we can only ever have two spans given our current error |
| /// structure. However, after toiling with a specific algorithm for handling |
| /// two spans, it became obvious that an algorithm to handle an arbitrary |
| /// number of spans was actually much simpler. |
| </span><span class="kw">struct </span>Spans<<span class="lifetime">'p</span>> { |
| <span class="doccomment">/// The original regex pattern string. |
| </span>pattern: <span class="kw-2">&</span><span class="lifetime">'p </span>str, |
| <span class="doccomment">/// The total width that should be used for line numbers. The width is |
| /// used for left padding the line numbers for alignment. |
| /// |
| /// A value of `0` means line numbers should not be displayed. That is, |
| /// the pattern is itself only one line. |
| </span>line_number_width: usize, |
| <span class="doccomment">/// All error spans that occur on a single line. This sequence always has |
| /// length equivalent to the number of lines in `pattern`, where the index |
| /// of the sequence represents a line number, starting at `0`. The spans |
| /// in each line are sorted in ascending order. |
| </span>by_line: Vec<Vec<ast::Span>>, |
| <span class="doccomment">/// All error spans that occur over one or more lines. That is, the start |
| /// and end position of the span have different line numbers. The spans are |
| /// sorted in ascending order. |
| </span>multi_line: Vec<ast::Span>, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'p</span>> Spans<<span class="lifetime">'p</span>> { |
| <span class="doccomment">/// Build a sequence of spans from a formatter. |
| </span><span class="kw">fn </span>from_formatter<<span class="lifetime">'e</span>, E: core::fmt::Display>( |
| fmter: <span class="kw-2">&</span><span class="lifetime">'p </span>Formatter<<span class="lifetime">'e</span>, E>, |
| ) -> Spans<<span class="lifetime">'p</span>> { |
| <span class="kw">let </span><span class="kw-2">mut </span>line_count = fmter.pattern.lines().count(); |
| <span class="comment">// If the pattern ends with a `\n` literal, then our line count is |
| // off by one, since a span can occur immediately after the last `\n`, |
| // which is consider to be an additional line. |
| </span><span class="kw">if </span>fmter.pattern.ends_with(<span class="string">'\n'</span>) { |
| line_count += <span class="number">1</span>; |
| } |
| <span class="kw">let </span>line_number_width = |
| <span class="kw">if </span>line_count <= <span class="number">1 </span>{ <span class="number">0 </span>} <span class="kw">else </span>{ line_count.to_string().len() }; |
| <span class="kw">let </span><span class="kw-2">mut </span>spans = Spans { |
| pattern: <span class="kw-2">&</span>fmter.pattern, |
| line_number_width, |
| by_line: <span class="macro">vec!</span>[<span class="macro">vec!</span>[]; line_count], |
| multi_line: <span class="macro">vec!</span>[], |
| }; |
| spans.add(fmter.span.clone()); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(span) = fmter.aux_span { |
| spans.add(span.clone()); |
| } |
| spans |
| } |
| |
| <span class="doccomment">/// Add the given span to this sequence, putting it in the right place. |
| </span><span class="kw">fn </span>add(<span class="kw-2">&mut </span><span class="self">self</span>, span: ast::Span) { |
| <span class="comment">// This is grossly inefficient since we sort after each add, but right |
| // now, we only ever add two spans at most. |
| </span><span class="kw">if </span>span.is_one_line() { |
| <span class="kw">let </span>i = span.start.line - <span class="number">1</span>; <span class="comment">// because lines are 1-indexed |
| </span><span class="self">self</span>.by_line[i].push(span); |
| <span class="self">self</span>.by_line[i].sort(); |
| } <span class="kw">else </span>{ |
| <span class="self">self</span>.multi_line.push(span); |
| <span class="self">self</span>.multi_line.sort(); |
| } |
| } |
| |
| <span class="doccomment">/// Notate the pattern string with carents (`^`) pointing at each span |
| /// location. This only applies to spans that occur within a single line. |
| </span><span class="kw">fn </span>notate(<span class="kw-2">&</span><span class="self">self</span>) -> String { |
| <span class="kw">let </span><span class="kw-2">mut </span>notated = String::new(); |
| <span class="kw">for </span>(i, line) <span class="kw">in </span><span class="self">self</span>.pattern.lines().enumerate() { |
| <span class="kw">if </span><span class="self">self</span>.line_number_width > <span class="number">0 </span>{ |
| notated.push_str(<span class="kw-2">&</span><span class="self">self</span>.left_pad_line_number(i + <span class="number">1</span>)); |
| notated.push_str(<span class="string">": "</span>); |
| } <span class="kw">else </span>{ |
| notated.push_str(<span class="string">" "</span>); |
| } |
| notated.push_str(line); |
| notated.push(<span class="string">'\n'</span>); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(notes) = <span class="self">self</span>.notate_line(i) { |
| notated.push_str(<span class="kw-2">&</span>notes); |
| notated.push(<span class="string">'\n'</span>); |
| } |
| } |
| notated |
| } |
| |
| <span class="doccomment">/// Return notes for the line indexed at `i` (zero-based). If there are no |
| /// spans for the given line, then `None` is returned. Otherwise, an |
| /// appropriately space padded string with correctly positioned `^` is |
| /// returned, accounting for line numbers. |
| </span><span class="kw">fn </span>notate_line(<span class="kw-2">&</span><span class="self">self</span>, i: usize) -> <span class="prelude-ty">Option</span><String> { |
| <span class="kw">let </span>spans = <span class="kw-2">&</span><span class="self">self</span>.by_line[i]; |
| <span class="kw">if </span>spans.is_empty() { |
| <span class="kw">return </span><span class="prelude-val">None</span>; |
| } |
| <span class="kw">let </span><span class="kw-2">mut </span>notes = String::new(); |
| <span class="kw">for _ in </span><span class="number">0</span>..<span class="self">self</span>.line_number_padding() { |
| notes.push(<span class="string">' '</span>); |
| } |
| <span class="kw">let </span><span class="kw-2">mut </span>pos = <span class="number">0</span>; |
| <span class="kw">for </span>span <span class="kw">in </span>spans { |
| <span class="kw">for _ in </span>pos..(span.start.column - <span class="number">1</span>) { |
| notes.push(<span class="string">' '</span>); |
| pos += <span class="number">1</span>; |
| } |
| <span class="kw">let </span>note_len = span.end.column.saturating_sub(span.start.column); |
| <span class="kw">for _ in </span><span class="number">0</span>..core::cmp::max(<span class="number">1</span>, note_len) { |
| notes.push(<span class="string">'^'</span>); |
| pos += <span class="number">1</span>; |
| } |
| } |
| <span class="prelude-val">Some</span>(notes) |
| } |
| |
| <span class="doccomment">/// Left pad the given line number with spaces such that it is aligned with |
| /// other line numbers. |
| </span><span class="kw">fn </span>left_pad_line_number(<span class="kw-2">&</span><span class="self">self</span>, n: usize) -> String { |
| <span class="kw">let </span>n = n.to_string(); |
| <span class="kw">let </span>pad = <span class="self">self</span>.line_number_width.checked_sub(n.len()).unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>result = repeat_char(<span class="string">' '</span>, pad); |
| result.push_str(<span class="kw-2">&</span>n); |
| result |
| } |
| |
| <span class="doccomment">/// Return the line number padding beginning at the start of each line of |
| /// the pattern. |
| /// |
| /// If the pattern is only one line, then this returns a fixed padding |
| /// for visual indentation. |
| </span><span class="kw">fn </span>line_number_padding(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="kw">if </span><span class="self">self</span>.line_number_width == <span class="number">0 </span>{ |
| <span class="number">4 |
| </span>} <span class="kw">else </span>{ |
| <span class="number">2 </span>+ <span class="self">self</span>.line_number_width |
| } |
| } |
| } |
| |
| <span class="kw">fn </span>repeat_char(c: char, count: usize) -> String { |
| core::iter::repeat(c).take(count).collect() |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span>alloc::string::ToString; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::ast::parse::Parser; |
| |
| <span class="kw">fn </span>assert_panic_message(pattern: <span class="kw-2">&</span>str, expected_msg: <span class="kw-2">&</span>str) { |
| <span class="kw">let </span>result = Parser::new().parse(pattern); |
| <span class="kw">match </span>result { |
| <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => { |
| <span class="macro">panic!</span>(<span class="string">"regex should not have parsed"</span>); |
| } |
| <span class="prelude-val">Err</span>(err) => { |
| <span class="macro">assert_eq!</span>(err.to_string(), expected_msg.trim()); |
| } |
| } |
| } |
| |
| <span class="comment">// See: https://github.com/rust-lang/regex/issues/464 |
| </span><span class="attribute">#[test] |
| </span><span class="kw">fn </span>regression_464() { |
| <span class="kw">let </span>err = Parser::new().parse(<span class="string">"a{\n"</span>).unwrap_err(); |
| <span class="comment">// This test checks that the error formatter doesn't panic. |
| </span><span class="macro">assert!</span>(!err.to_string().is_empty()); |
| } |
| |
| <span class="comment">// See: https://github.com/rust-lang/regex/issues/545 |
| </span><span class="attribute">#[test] |
| </span><span class="kw">fn </span>repetition_quantifier_expects_a_valid_decimal() { |
| assert_panic_message( |
| <span class="string">r"\\u{[^}]*}"</span>, |
| <span class="string">r#" |
| regex parse error: |
| \\u{[^}]*} |
| ^ |
| error: repetition quantifier expects a valid decimal |
| "#</span>, |
| ); |
| } |
| } |
| </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> |
