| <!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/ide-ssr/src/lib.rs`."><title>lib.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-77263533.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="ide_ssr" data-themes="" data-resource-suffix="" data-rustdoc-version="1.94.0 (4a4ef493e 2026-03-02)" data-channel="1.94.0" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-b897f86f.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-7bab91a1.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-ffcac47a.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">ide_ssr/</div>lib.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">//! Structural Search Replace |
| <a href=#2 id=2 data-nosnippet>2</a>//! |
| <a href=#3 id=3 data-nosnippet>3</a>//! Allows searching the AST for code that matches one or more patterns and then replacing that code |
| <a href=#4 id=4 data-nosnippet>4</a>//! based on a template. |
| <a href=#5 id=5 data-nosnippet>5</a> |
| <a href=#6 id=6 data-nosnippet>6</a></span><span class="comment">// Feature: Structural Search and Replace |
| <a href=#7 id=7 data-nosnippet>7</a>// |
| <a href=#8 id=8 data-nosnippet>8</a>// Search and replace with named wildcards that will match any expression, type, path, pattern or item. |
| <a href=#9 id=9 data-nosnippet>9</a>// The syntax for a structural search replace command is `<search_pattern> ==>> <replace_pattern>`. |
| <a href=#10 id=10 data-nosnippet>10</a>// A `$<name>` placeholder in the search pattern will match any AST node and `$<name>` will reference it in the replacement. |
| <a href=#11 id=11 data-nosnippet>11</a>// Within a macro call, a placeholder will match up until whatever token follows the placeholder. |
| <a href=#12 id=12 data-nosnippet>12</a>// |
| <a href=#13 id=13 data-nosnippet>13</a>// All paths in both the search pattern and the replacement template must resolve in the context |
| <a href=#14 id=14 data-nosnippet>14</a>// in which this command is invoked. Paths in the search pattern will then match the code if they |
| <a href=#15 id=15 data-nosnippet>15</a>// resolve to the same item, even if they're written differently. For example if we invoke the |
| <a href=#16 id=16 data-nosnippet>16</a>// command in the module `foo` with a pattern of `Bar`, then code in the parent module that refers |
| <a href=#17 id=17 data-nosnippet>17</a>// to `foo::Bar` will match. |
| <a href=#18 id=18 data-nosnippet>18</a>// |
| <a href=#19 id=19 data-nosnippet>19</a>// Paths in the replacement template will be rendered appropriately for the context in which the |
| <a href=#20 id=20 data-nosnippet>20</a>// replacement occurs. For example if our replacement template is `foo::Bar` and we match some |
| <a href=#21 id=21 data-nosnippet>21</a>// code in the `foo` module, we'll insert just `Bar`. |
| <a href=#22 id=22 data-nosnippet>22</a>// |
| <a href=#23 id=23 data-nosnippet>23</a>// Inherent method calls should generally be written in UFCS form. e.g. `foo::Bar::baz($s, $a)` will |
| <a href=#24 id=24 data-nosnippet>24</a>// match `$s.baz($a)`, provided the method call `baz` resolves to the method `foo::Bar::baz`. When a |
| <a href=#25 id=25 data-nosnippet>25</a>// placeholder is the receiver of a method call in the search pattern (e.g. `$s.foo()`), but not in |
| <a href=#26 id=26 data-nosnippet>26</a>// the replacement template (e.g. `bar($s)`), then *, & and &mut will be added as needed to mirror |
| <a href=#27 id=27 data-nosnippet>27</a>// whatever autoderef and autoref was happening implicitly in the matched code. |
| <a href=#28 id=28 data-nosnippet>28</a>// |
| <a href=#29 id=29 data-nosnippet>29</a>// The scope of the search / replace will be restricted to the current selection if any, otherwise |
| <a href=#30 id=30 data-nosnippet>30</a>// it will apply to the whole workspace. |
| <a href=#31 id=31 data-nosnippet>31</a>// |
| <a href=#32 id=32 data-nosnippet>32</a>// Placeholders may be given constraints by writing them as `${<name>:<constraint1>:<constraint2>...}`. |
| <a href=#33 id=33 data-nosnippet>33</a>// |
| <a href=#34 id=34 data-nosnippet>34</a>// Supported constraints: |
| <a href=#35 id=35 data-nosnippet>35</a>// |
| <a href=#36 id=36 data-nosnippet>36</a>// | Constraint | Restricts placeholder | |
| <a href=#37 id=37 data-nosnippet>37</a>// |---------------|------------------------| |
| <a href=#38 id=38 data-nosnippet>38</a>// | kind(literal) | Is a literal (e.g. `42` or `"forty two"`) | |
| <a href=#39 id=39 data-nosnippet>39</a>// | not(a) | Negates the constraint `a` | |
| <a href=#40 id=40 data-nosnippet>40</a>// |
| <a href=#41 id=41 data-nosnippet>41</a>// Available via the command `rust-analyzer.ssr`. |
| <a href=#42 id=42 data-nosnippet>42</a>// |
| <a href=#43 id=43 data-nosnippet>43</a>// ```rust |
| <a href=#44 id=44 data-nosnippet>44</a>// // Using structural search replace command [foo($a, $b) ==>> ($a).foo($b)] |
| <a href=#45 id=45 data-nosnippet>45</a>// |
| <a href=#46 id=46 data-nosnippet>46</a>// // BEFORE |
| <a href=#47 id=47 data-nosnippet>47</a>// String::from(foo(y + 5, z)) |
| <a href=#48 id=48 data-nosnippet>48</a>// |
| <a href=#49 id=49 data-nosnippet>49</a>// // AFTER |
| <a href=#50 id=50 data-nosnippet>50</a>// String::from((y + 5).foo(z)) |
| <a href=#51 id=51 data-nosnippet>51</a>// ``` |
| <a href=#52 id=52 data-nosnippet>52</a>// |
| <a href=#53 id=53 data-nosnippet>53</a>// | Editor | Action Name | |
| <a href=#54 id=54 data-nosnippet>54</a>// |---------|--------------| |
| <a href=#55 id=55 data-nosnippet>55</a>// | VS Code | **rust-analyzer: Structural Search Replace** | |
| <a href=#56 id=56 data-nosnippet>56</a>// |
| <a href=#57 id=57 data-nosnippet>57</a>// Also available as an assist, by writing a comment containing the structural |
| <a href=#58 id=58 data-nosnippet>58</a>// search and replace rule. You will only see the assist if the comment can |
| <a href=#59 id=59 data-nosnippet>59</a>// be parsed as a valid structural search and replace rule. |
| <a href=#60 id=60 data-nosnippet>60</a>// |
| <a href=#61 id=61 data-nosnippet>61</a>// ```rust |
| <a href=#62 id=62 data-nosnippet>62</a>// // Place the cursor on the line below to see the assist 💡. |
| <a href=#63 id=63 data-nosnippet>63</a>// // foo($a, $b) ==>> ($a).foo($b) |
| <a href=#64 id=64 data-nosnippet>64</a>// ``` |
| <a href=#65 id=65 data-nosnippet>65</a> |
| <a href=#66 id=66 data-nosnippet>66</a></span><span class="attr">#![cfg_attr(feature = <span class="string">"in-rust-tree"</span>, feature(rustc_private))] |
| <a href=#67 id=67 data-nosnippet>67</a> |
| <a href=#68 id=68 data-nosnippet>68</a>#[cfg(feature = <span class="string">"in-rust-tree"</span>)] |
| <a href=#69 id=69 data-nosnippet>69</a></span><span class="kw">extern crate </span>rustc_driver <span class="kw">as _</span>; |
| <a href=#70 id=70 data-nosnippet>70</a> |
| <a href=#71 id=71 data-nosnippet>71</a><span class="kw">mod </span>fragments; |
| <a href=#72 id=72 data-nosnippet>72</a><span class="kw">mod </span>from_comment; |
| <a href=#73 id=73 data-nosnippet>73</a><span class="kw">mod </span>matching; |
| <a href=#74 id=74 data-nosnippet>74</a><span class="kw">mod </span>nester; |
| <a href=#75 id=75 data-nosnippet>75</a><span class="kw">mod </span>parsing; |
| <a href=#76 id=76 data-nosnippet>76</a><span class="kw">mod </span>replacing; |
| <a href=#77 id=77 data-nosnippet>77</a><span class="kw">mod </span>resolving; |
| <a href=#78 id=78 data-nosnippet>78</a><span class="kw">mod </span>search; |
| <a href=#79 id=79 data-nosnippet>79</a><span class="attr">#[macro_use] |
| <a href=#80 id=80 data-nosnippet>80</a></span><span class="kw">mod </span>errors; |
| <a href=#81 id=81 data-nosnippet>81</a><span class="attr">#[cfg(test)] |
| <a href=#82 id=82 data-nosnippet>82</a></span><span class="kw">mod </span>tests; |
| <a href=#83 id=83 data-nosnippet>83</a> |
| <a href=#84 id=84 data-nosnippet>84</a><span class="kw">pub use </span>crate::{errors::SsrError, from_comment::ssr_from_comment, matching::Match}; |
| <a href=#85 id=85 data-nosnippet>85</a> |
| <a href=#86 id=86 data-nosnippet>86</a><span class="kw">use </span>crate::{errors::bail, matching::MatchFailureReason}; |
| <a href=#87 id=87 data-nosnippet>87</a><span class="kw">use </span>hir::{FileRange, Semantics}; |
| <a href=#88 id=88 data-nosnippet>88</a><span class="kw">use </span>ide_db::LocalRoots; |
| <a href=#89 id=89 data-nosnippet>89</a><span class="kw">use </span>ide_db::text_edit::TextEdit; |
| <a href=#90 id=90 data-nosnippet>90</a><span class="kw">use </span>ide_db::{EditionedFileId, FileId, FxHashMap, RootDatabase, base_db::SourceDatabase}; |
| <a href=#91 id=91 data-nosnippet>91</a><span class="kw">use </span>resolving::ResolvedRule; |
| <a href=#92 id=92 data-nosnippet>92</a><span class="kw">use </span>syntax::{AstNode, SyntaxNode, TextRange, ast}; |
| <a href=#93 id=93 data-nosnippet>93</a> |
| <a href=#94 id=94 data-nosnippet>94</a><span class="comment">// A structured search replace rule. Create by calling `parse` on a str. |
| <a href=#95 id=95 data-nosnippet>95</a></span><span class="attr">#[derive(Debug)] |
| <a href=#96 id=96 data-nosnippet>96</a></span><span class="kw">pub struct </span>SsrRule { |
| <a href=#97 id=97 data-nosnippet>97</a> <span class="doccomment">/// A structured pattern that we're searching for. |
| <a href=#98 id=98 data-nosnippet>98</a> </span>pattern: parsing::RawPattern, |
| <a href=#99 id=99 data-nosnippet>99</a> <span class="doccomment">/// What we'll replace it with. |
| <a href=#100 id=100 data-nosnippet>100</a> </span>template: parsing::RawPattern, |
| <a href=#101 id=101 data-nosnippet>101</a> parsed_rules: Vec<parsing::ParsedRule>, |
| <a href=#102 id=102 data-nosnippet>102</a>} |
| <a href=#103 id=103 data-nosnippet>103</a> |
| <a href=#104 id=104 data-nosnippet>104</a><span class="attr">#[derive(Debug)] |
| <a href=#105 id=105 data-nosnippet>105</a></span><span class="kw">pub struct </span>SsrPattern { |
| <a href=#106 id=106 data-nosnippet>106</a> parsed_rules: Vec<parsing::ParsedRule>, |
| <a href=#107 id=107 data-nosnippet>107</a>} |
| <a href=#108 id=108 data-nosnippet>108</a> |
| <a href=#109 id=109 data-nosnippet>109</a><span class="attr">#[derive(Debug, Default)] |
| <a href=#110 id=110 data-nosnippet>110</a></span><span class="kw">pub struct </span>SsrMatches { |
| <a href=#111 id=111 data-nosnippet>111</a> <span class="kw">pub </span>matches: Vec<Match>, |
| <a href=#112 id=112 data-nosnippet>112</a>} |
| <a href=#113 id=113 data-nosnippet>113</a> |
| <a href=#114 id=114 data-nosnippet>114</a><span class="doccomment">/// Searches a crate for pattern matches and possibly replaces them with something else. |
| <a href=#115 id=115 data-nosnippet>115</a></span><span class="kw">pub struct </span>MatchFinder<<span class="lifetime">'db</span>> { |
| <a href=#116 id=116 data-nosnippet>116</a> <span class="doccomment">/// Our source of information about the user's code. |
| <a href=#117 id=117 data-nosnippet>117</a> </span>sema: Semantics<<span class="lifetime">'db</span>, ide_db::RootDatabase>, |
| <a href=#118 id=118 data-nosnippet>118</a> rules: Vec<ResolvedRule<<span class="lifetime">'db</span>>>, |
| <a href=#119 id=119 data-nosnippet>119</a> resolution_scope: resolving::ResolutionScope<<span class="lifetime">'db</span>>, |
| <a href=#120 id=120 data-nosnippet>120</a> restrict_ranges: Vec<ide_db::FileRange>, |
| <a href=#121 id=121 data-nosnippet>121</a>} |
| <a href=#122 id=122 data-nosnippet>122</a> |
| <a href=#123 id=123 data-nosnippet>123</a><span class="kw">impl</span><<span class="lifetime">'db</span>> MatchFinder<<span class="lifetime">'db</span>> { |
| <a href=#124 id=124 data-nosnippet>124</a> <span class="doccomment">/// Constructs a new instance where names will be looked up as if they appeared at |
| <a href=#125 id=125 data-nosnippet>125</a> /// `lookup_context`. |
| <a href=#126 id=126 data-nosnippet>126</a> </span><span class="kw">pub fn </span>in_context( |
| <a href=#127 id=127 data-nosnippet>127</a> db: <span class="kw-2">&</span><span class="lifetime">'db </span>RootDatabase, |
| <a href=#128 id=128 data-nosnippet>128</a> lookup_context: ide_db::FilePosition, |
| <a href=#129 id=129 data-nosnippet>129</a> <span class="kw-2">mut </span>restrict_ranges: Vec<ide_db::FileRange>, |
| <a href=#130 id=130 data-nosnippet>130</a> ) -> <span class="prelude-ty">Result</span><MatchFinder<<span class="lifetime">'db</span>>, SsrError> { |
| <a href=#131 id=131 data-nosnippet>131</a> restrict_ranges.retain(|range| !range.range.is_empty()); |
| <a href=#132 id=132 data-nosnippet>132</a> <span class="kw">let </span>sema = Semantics::new(db); |
| <a href=#133 id=133 data-nosnippet>133</a> <span class="kw">let </span>file_id = sema.attach_first_edition(lookup_context.file_id); |
| <a href=#134 id=134 data-nosnippet>134</a> <span class="kw">let </span>resolution_scope = resolving::ResolutionScope::new( |
| <a href=#135 id=135 data-nosnippet>135</a> <span class="kw-2">&</span>sema, |
| <a href=#136 id=136 data-nosnippet>136</a> hir::FilePosition { file_id, offset: lookup_context.offset }, |
| <a href=#137 id=137 data-nosnippet>137</a> ) |
| <a href=#138 id=138 data-nosnippet>138</a> .ok_or_else(|| SsrError(<span class="string">"no resolution scope for file"</span>.into()))<span class="question-mark">?</span>; |
| <a href=#139 id=139 data-nosnippet>139</a> <span class="prelude-val">Ok</span>(MatchFinder { sema, rules: Vec::new(), resolution_scope, restrict_ranges }) |
| <a href=#140 id=140 data-nosnippet>140</a> } |
| <a href=#141 id=141 data-nosnippet>141</a> |
| <a href=#142 id=142 data-nosnippet>142</a> <span class="doccomment">/// Constructs an instance using the start of the first file in `db` as the lookup context. |
| <a href=#143 id=143 data-nosnippet>143</a> </span><span class="kw">pub fn </span>at_first_file(db: <span class="kw-2">&</span><span class="lifetime">'db </span>ide_db::RootDatabase) -> <span class="prelude-ty">Result</span><MatchFinder<<span class="lifetime">'db</span>>, SsrError> { |
| <a href=#144 id=144 data-nosnippet>144</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(first_file_id) = LocalRoots::get(db) |
| <a href=#145 id=145 data-nosnippet>145</a> .roots(db) |
| <a href=#146 id=146 data-nosnippet>146</a> .iter() |
| <a href=#147 id=147 data-nosnippet>147</a> .next() |
| <a href=#148 id=148 data-nosnippet>148</a> .and_then(|root| db.source_root(<span class="kw-2">*</span>root).source_root(db).iter().next()) |
| <a href=#149 id=149 data-nosnippet>149</a> { |
| <a href=#150 id=150 data-nosnippet>150</a> MatchFinder::in_context( |
| <a href=#151 id=151 data-nosnippet>151</a> db, |
| <a href=#152 id=152 data-nosnippet>152</a> ide_db::FilePosition { file_id: first_file_id, offset: <span class="number">0</span>.into() }, |
| <a href=#153 id=153 data-nosnippet>153</a> <span class="macro">vec!</span>[], |
| <a href=#154 id=154 data-nosnippet>154</a> ) |
| <a href=#155 id=155 data-nosnippet>155</a> } <span class="kw">else </span>{ |
| <a href=#156 id=156 data-nosnippet>156</a> <span class="macro">bail!</span>(<span class="string">"No files to search"</span>); |
| <a href=#157 id=157 data-nosnippet>157</a> } |
| <a href=#158 id=158 data-nosnippet>158</a> } |
| <a href=#159 id=159 data-nosnippet>159</a> |
| <a href=#160 id=160 data-nosnippet>160</a> <span class="doccomment">/// Adds a rule to be applied. The order in which rules are added matters. Earlier rules take |
| <a href=#161 id=161 data-nosnippet>161</a> /// precedence. If a node is matched by an earlier rule, then later rules won't be permitted to |
| <a href=#162 id=162 data-nosnippet>162</a> /// match to it. |
| <a href=#163 id=163 data-nosnippet>163</a> </span><span class="kw">pub fn </span>add_rule(<span class="kw-2">&mut </span><span class="self">self</span>, rule: SsrRule) -> <span class="prelude-ty">Result</span><(), SsrError> { |
| <a href=#164 id=164 data-nosnippet>164</a> <span class="kw">for </span>parsed_rule <span class="kw">in </span>rule.parsed_rules { |
| <a href=#165 id=165 data-nosnippet>165</a> <span class="self">self</span>.rules.push(ResolvedRule::new( |
| <a href=#166 id=166 data-nosnippet>166</a> parsed_rule, |
| <a href=#167 id=167 data-nosnippet>167</a> <span class="kw-2">&</span><span class="self">self</span>.resolution_scope, |
| <a href=#168 id=168 data-nosnippet>168</a> <span class="self">self</span>.rules.len(), |
| <a href=#169 id=169 data-nosnippet>169</a> )<span class="question-mark">?</span>); |
| <a href=#170 id=170 data-nosnippet>170</a> } |
| <a href=#171 id=171 data-nosnippet>171</a> <span class="prelude-val">Ok</span>(()) |
| <a href=#172 id=172 data-nosnippet>172</a> } |
| <a href=#173 id=173 data-nosnippet>173</a> |
| <a href=#174 id=174 data-nosnippet>174</a> <span class="doccomment">/// Finds matches for all added rules and returns edits for all found matches. |
| <a href=#175 id=175 data-nosnippet>175</a> </span><span class="kw">pub fn </span>edits(<span class="kw-2">&</span><span class="self">self</span>) -> FxHashMap<FileId, TextEdit> { |
| <a href=#176 id=176 data-nosnippet>176</a> <span class="kw">let </span><span class="kw-2">mut </span>matches_by_file = FxHashMap::default(); |
| <a href=#177 id=177 data-nosnippet>177</a> <span class="kw">for </span>m <span class="kw">in </span><span class="self">self</span>.matches().matches { |
| <a href=#178 id=178 data-nosnippet>178</a> matches_by_file |
| <a href=#179 id=179 data-nosnippet>179</a> .entry(m.range.file_id.file_id(<span class="self">self</span>.sema.db)) |
| <a href=#180 id=180 data-nosnippet>180</a> .or_insert_with(SsrMatches::default) |
| <a href=#181 id=181 data-nosnippet>181</a> .matches |
| <a href=#182 id=182 data-nosnippet>182</a> .push(m); |
| <a href=#183 id=183 data-nosnippet>183</a> } |
| <a href=#184 id=184 data-nosnippet>184</a> matches_by_file |
| <a href=#185 id=185 data-nosnippet>185</a> .into_iter() |
| <a href=#186 id=186 data-nosnippet>186</a> .map(|(file_id, matches)| { |
| <a href=#187 id=187 data-nosnippet>187</a> ( |
| <a href=#188 id=188 data-nosnippet>188</a> file_id, |
| <a href=#189 id=189 data-nosnippet>189</a> replacing::matches_to_edit( |
| <a href=#190 id=190 data-nosnippet>190</a> <span class="self">self</span>.sema.db, |
| <a href=#191 id=191 data-nosnippet>191</a> <span class="kw-2">&</span>matches, |
| <a href=#192 id=192 data-nosnippet>192</a> <span class="self">self</span>.sema.db.file_text(file_id).text(<span class="self">self</span>.sema.db), |
| <a href=#193 id=193 data-nosnippet>193</a> <span class="kw-2">&</span><span class="self">self</span>.rules, |
| <a href=#194 id=194 data-nosnippet>194</a> ), |
| <a href=#195 id=195 data-nosnippet>195</a> ) |
| <a href=#196 id=196 data-nosnippet>196</a> }) |
| <a href=#197 id=197 data-nosnippet>197</a> .collect() |
| <a href=#198 id=198 data-nosnippet>198</a> } |
| <a href=#199 id=199 data-nosnippet>199</a> |
| <a href=#200 id=200 data-nosnippet>200</a> <span class="doccomment">/// Adds a search pattern. For use if you intend to only call `find_matches_in_file`. If you |
| <a href=#201 id=201 data-nosnippet>201</a> /// intend to do replacement, use `add_rule` instead. |
| <a href=#202 id=202 data-nosnippet>202</a> </span><span class="kw">pub fn </span>add_search_pattern(<span class="kw-2">&mut </span><span class="self">self</span>, pattern: SsrPattern) -> <span class="prelude-ty">Result</span><(), SsrError> { |
| <a href=#203 id=203 data-nosnippet>203</a> <span class="kw">for </span>parsed_rule <span class="kw">in </span>pattern.parsed_rules { |
| <a href=#204 id=204 data-nosnippet>204</a> <span class="self">self</span>.rules.push(ResolvedRule::new( |
| <a href=#205 id=205 data-nosnippet>205</a> parsed_rule, |
| <a href=#206 id=206 data-nosnippet>206</a> <span class="kw-2">&</span><span class="self">self</span>.resolution_scope, |
| <a href=#207 id=207 data-nosnippet>207</a> <span class="self">self</span>.rules.len(), |
| <a href=#208 id=208 data-nosnippet>208</a> )<span class="question-mark">?</span>); |
| <a href=#209 id=209 data-nosnippet>209</a> } |
| <a href=#210 id=210 data-nosnippet>210</a> <span class="prelude-val">Ok</span>(()) |
| <a href=#211 id=211 data-nosnippet>211</a> } |
| <a href=#212 id=212 data-nosnippet>212</a> |
| <a href=#213 id=213 data-nosnippet>213</a> <span class="doccomment">/// Returns matches for all added rules. |
| <a href=#214 id=214 data-nosnippet>214</a> </span><span class="kw">pub fn </span>matches(<span class="kw-2">&</span><span class="self">self</span>) -> SsrMatches { |
| <a href=#215 id=215 data-nosnippet>215</a> <span class="kw">let </span><span class="kw-2">mut </span>matches = Vec::new(); |
| <a href=#216 id=216 data-nosnippet>216</a> <span class="kw">let </span><span class="kw-2">mut </span>usage_cache = search::UsageCache::default(); |
| <a href=#217 id=217 data-nosnippet>217</a> <span class="kw">for </span>rule <span class="kw">in </span><span class="kw-2">&</span><span class="self">self</span>.rules { |
| <a href=#218 id=218 data-nosnippet>218</a> <span class="self">self</span>.find_matches_for_rule(rule, <span class="kw-2">&mut </span>usage_cache, <span class="kw-2">&mut </span>matches); |
| <a href=#219 id=219 data-nosnippet>219</a> } |
| <a href=#220 id=220 data-nosnippet>220</a> nester::nest_and_remove_collisions(matches, <span class="kw-2">&</span><span class="self">self</span>.sema) |
| <a href=#221 id=221 data-nosnippet>221</a> } |
| <a href=#222 id=222 data-nosnippet>222</a> |
| <a href=#223 id=223 data-nosnippet>223</a> <span class="doccomment">/// Finds all nodes in `file_id` whose text is exactly equal to `snippet` and attempts to match |
| <a href=#224 id=224 data-nosnippet>224</a> /// them, while recording reasons why they don't match. This API is useful for command |
| <a href=#225 id=225 data-nosnippet>225</a> /// line-based debugging where providing a range is difficult. |
| <a href=#226 id=226 data-nosnippet>226</a> </span><span class="kw">pub fn </span>debug_where_text_equal( |
| <a href=#227 id=227 data-nosnippet>227</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#228 id=228 data-nosnippet>228</a> file_id: EditionedFileId, |
| <a href=#229 id=229 data-nosnippet>229</a> snippet: <span class="kw-2">&</span>str, |
| <a href=#230 id=230 data-nosnippet>230</a> ) -> Vec<MatchDebugInfo> { |
| <a href=#231 id=231 data-nosnippet>231</a> <span class="kw">let </span>file = <span class="self">self</span>.sema.parse(file_id); |
| <a href=#232 id=232 data-nosnippet>232</a> <span class="kw">let </span><span class="kw-2">mut </span>res = Vec::new(); |
| <a href=#233 id=233 data-nosnippet>233</a> <span class="kw">let </span>file_text = <span class="self">self</span>.sema.db.file_text(file_id.file_id(<span class="self">self</span>.sema.db)).text(<span class="self">self</span>.sema.db); |
| <a href=#234 id=234 data-nosnippet>234</a> <span class="kw">let </span><span class="kw-2">mut </span>remaining_text = <span class="kw-2">&**</span>file_text; |
| <a href=#235 id=235 data-nosnippet>235</a> <span class="kw">let </span><span class="kw-2">mut </span>base = <span class="number">0</span>; |
| <a href=#236 id=236 data-nosnippet>236</a> <span class="kw">let </span>len = snippet.len() <span class="kw">as </span>u32; |
| <a href=#237 id=237 data-nosnippet>237</a> <span class="kw">while let </span><span class="prelude-val">Some</span>(offset) = remaining_text.find(snippet) { |
| <a href=#238 id=238 data-nosnippet>238</a> <span class="kw">let </span>start = base + offset <span class="kw">as </span>u32; |
| <a href=#239 id=239 data-nosnippet>239</a> <span class="kw">let </span>end = start + len; |
| <a href=#240 id=240 data-nosnippet>240</a> <span class="self">self</span>.output_debug_for_nodes_at_range( |
| <a href=#241 id=241 data-nosnippet>241</a> file.syntax(), |
| <a href=#242 id=242 data-nosnippet>242</a> FileRange { file_id, range: TextRange::new(start.into(), end.into()) }, |
| <a href=#243 id=243 data-nosnippet>243</a> <span class="kw-2">&</span><span class="prelude-val">None</span>, |
| <a href=#244 id=244 data-nosnippet>244</a> <span class="kw-2">&mut </span>res, |
| <a href=#245 id=245 data-nosnippet>245</a> ); |
| <a href=#246 id=246 data-nosnippet>246</a> remaining_text = <span class="kw-2">&</span>remaining_text[offset + snippet.len()..]; |
| <a href=#247 id=247 data-nosnippet>247</a> base = end; |
| <a href=#248 id=248 data-nosnippet>248</a> } |
| <a href=#249 id=249 data-nosnippet>249</a> res |
| <a href=#250 id=250 data-nosnippet>250</a> } |
| <a href=#251 id=251 data-nosnippet>251</a> |
| <a href=#252 id=252 data-nosnippet>252</a> <span class="kw">fn </span>output_debug_for_nodes_at_range( |
| <a href=#253 id=253 data-nosnippet>253</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#254 id=254 data-nosnippet>254</a> node: <span class="kw-2">&</span>SyntaxNode, |
| <a href=#255 id=255 data-nosnippet>255</a> range: FileRange, |
| <a href=#256 id=256 data-nosnippet>256</a> restrict_range: <span class="kw-2">&</span><span class="prelude-ty">Option</span><FileRange>, |
| <a href=#257 id=257 data-nosnippet>257</a> out: <span class="kw-2">&mut </span>Vec<MatchDebugInfo>, |
| <a href=#258 id=258 data-nosnippet>258</a> ) { |
| <a href=#259 id=259 data-nosnippet>259</a> <span class="kw">for </span>node <span class="kw">in </span>node.children() { |
| <a href=#260 id=260 data-nosnippet>260</a> <span class="kw">let </span>node_range = <span class="self">self</span>.sema.original_range(<span class="kw-2">&</span>node); |
| <a href=#261 id=261 data-nosnippet>261</a> <span class="kw">if </span>node_range.<span class="macro">file_id !</span>= range.file_id || !node_range.range.contains_range(range.range) |
| <a href=#262 id=262 data-nosnippet>262</a> { |
| <a href=#263 id=263 data-nosnippet>263</a> <span class="kw">continue</span>; |
| <a href=#264 id=264 data-nosnippet>264</a> } |
| <a href=#265 id=265 data-nosnippet>265</a> <span class="kw">if </span>node_range.range == range.range { |
| <a href=#266 id=266 data-nosnippet>266</a> <span class="kw">for </span>rule <span class="kw">in </span><span class="kw-2">&</span><span class="self">self</span>.rules { |
| <a href=#267 id=267 data-nosnippet>267</a> <span class="comment">// For now we ignore rules that have a different kind than our node, otherwise |
| <a href=#268 id=268 data-nosnippet>268</a> // we get lots of noise. If at some point we add support for restricting rules |
| <a href=#269 id=269 data-nosnippet>269</a> // to a particular kind of thing (e.g. only match type references), then we can |
| <a href=#270 id=270 data-nosnippet>270</a> // relax this. We special-case expressions, since function calls can match |
| <a href=#271 id=271 data-nosnippet>271</a> // method calls. |
| <a href=#272 id=272 data-nosnippet>272</a> </span><span class="kw">if </span>rule.pattern.node.kind() != node.kind() |
| <a href=#273 id=273 data-nosnippet>273</a> && !(ast::Expr::can_cast(rule.pattern.node.kind()) |
| <a href=#274 id=274 data-nosnippet>274</a> && ast::Expr::can_cast(node.kind())) |
| <a href=#275 id=275 data-nosnippet>275</a> { |
| <a href=#276 id=276 data-nosnippet>276</a> <span class="kw">continue</span>; |
| <a href=#277 id=277 data-nosnippet>277</a> } |
| <a href=#278 id=278 data-nosnippet>278</a> out.push(MatchDebugInfo { |
| <a href=#279 id=279 data-nosnippet>279</a> matched: matching::get_match(<span class="bool-val">true</span>, rule, <span class="kw-2">&</span>node, restrict_range, <span class="kw-2">&</span><span class="self">self</span>.sema) |
| <a href=#280 id=280 data-nosnippet>280</a> .map_err(|e| MatchFailureReason { |
| <a href=#281 id=281 data-nosnippet>281</a> reason: e.reason.unwrap_or_else(|| { |
| <a href=#282 id=282 data-nosnippet>282</a> <span class="string">"Match failed, but no reason was given"</span>.to_owned() |
| <a href=#283 id=283 data-nosnippet>283</a> }), |
| <a href=#284 id=284 data-nosnippet>284</a> }), |
| <a href=#285 id=285 data-nosnippet>285</a> pattern: rule.pattern.node.clone(), |
| <a href=#286 id=286 data-nosnippet>286</a> node: node.clone(), |
| <a href=#287 id=287 data-nosnippet>287</a> }); |
| <a href=#288 id=288 data-nosnippet>288</a> } |
| <a href=#289 id=289 data-nosnippet>289</a> } <span class="kw">else if let </span><span class="prelude-val">Some</span>(macro_call) = ast::MacroCall::cast(node.clone()) |
| <a href=#290 id=290 data-nosnippet>290</a> && <span class="kw">let </span><span class="prelude-val">Some</span>(expanded) = <span class="self">self</span>.sema.expand_macro_call(<span class="kw-2">&</span>macro_call) |
| <a href=#291 id=291 data-nosnippet>291</a> && <span class="kw">let </span><span class="prelude-val">Some</span>(tt) = macro_call.token_tree() |
| <a href=#292 id=292 data-nosnippet>292</a> { |
| <a href=#293 id=293 data-nosnippet>293</a> <span class="self">self</span>.output_debug_for_nodes_at_range( |
| <a href=#294 id=294 data-nosnippet>294</a> <span class="kw-2">&</span>expanded.value, |
| <a href=#295 id=295 data-nosnippet>295</a> range, |
| <a href=#296 id=296 data-nosnippet>296</a> <span class="kw-2">&</span><span class="prelude-val">Some</span>(<span class="self">self</span>.sema.original_range(tt.syntax())), |
| <a href=#297 id=297 data-nosnippet>297</a> out, |
| <a href=#298 id=298 data-nosnippet>298</a> ); |
| <a href=#299 id=299 data-nosnippet>299</a> } |
| <a href=#300 id=300 data-nosnippet>300</a> <span class="self">self</span>.output_debug_for_nodes_at_range(<span class="kw-2">&</span>node, range, restrict_range, out); |
| <a href=#301 id=301 data-nosnippet>301</a> } |
| <a href=#302 id=302 data-nosnippet>302</a> } |
| <a href=#303 id=303 data-nosnippet>303</a>} |
| <a href=#304 id=304 data-nosnippet>304</a> |
| <a href=#305 id=305 data-nosnippet>305</a><span class="kw">pub struct </span>MatchDebugInfo { |
| <a href=#306 id=306 data-nosnippet>306</a> node: SyntaxNode, |
| <a href=#307 id=307 data-nosnippet>307</a> <span class="doccomment">/// Our search pattern parsed as an expression or item, etc |
| <a href=#308 id=308 data-nosnippet>308</a> </span>pattern: SyntaxNode, |
| <a href=#309 id=309 data-nosnippet>309</a> matched: <span class="prelude-ty">Result</span><Match, MatchFailureReason>, |
| <a href=#310 id=310 data-nosnippet>310</a>} |
| <a href=#311 id=311 data-nosnippet>311</a> |
| <a href=#312 id=312 data-nosnippet>312</a><span class="kw">impl </span>std::fmt::Debug <span class="kw">for </span>MatchDebugInfo { |
| <a href=#313 id=313 data-nosnippet>313</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>std::fmt::Formatter<<span class="lifetime">'_</span>>) -> std::fmt::Result { |
| <a href=#314 id=314 data-nosnippet>314</a> <span class="kw">match </span><span class="kw-2">&</span><span class="self">self</span>.matched { |
| <a href=#315 id=315 data-nosnippet>315</a> <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => <span class="macro">writeln!</span>(f, <span class="string">"Node matched"</span>)<span class="question-mark">?</span>, |
| <a href=#316 id=316 data-nosnippet>316</a> <span class="prelude-val">Err</span>(reason) => <span class="macro">writeln!</span>(f, <span class="string">"Node failed to match because: {}"</span>, reason.reason)<span class="question-mark">?</span>, |
| <a href=#317 id=317 data-nosnippet>317</a> } |
| <a href=#318 id=318 data-nosnippet>318</a> <span class="macro">writeln!</span>( |
| <a href=#319 id=319 data-nosnippet>319</a> f, |
| <a href=#320 id=320 data-nosnippet>320</a> <span class="string">"============ AST ===========\n\ |
| <a href=#321 id=321 data-nosnippet>321</a> {:#?}"</span>, |
| <a href=#322 id=322 data-nosnippet>322</a> <span class="self">self</span>.node |
| <a href=#323 id=323 data-nosnippet>323</a> )<span class="question-mark">?</span>; |
| <a href=#324 id=324 data-nosnippet>324</a> <span class="macro">writeln!</span>(f, <span class="string">"========= PATTERN =========="</span>)<span class="question-mark">?</span>; |
| <a href=#325 id=325 data-nosnippet>325</a> <span class="macro">writeln!</span>(f, <span class="string">"{:#?}"</span>, <span class="self">self</span>.pattern)<span class="question-mark">?</span>; |
| <a href=#326 id=326 data-nosnippet>326</a> <span class="macro">writeln!</span>(f, <span class="string">"============================"</span>)<span class="question-mark">?</span>; |
| <a href=#327 id=327 data-nosnippet>327</a> <span class="prelude-val">Ok</span>(()) |
| <a href=#328 id=328 data-nosnippet>328</a> } |
| <a href=#329 id=329 data-nosnippet>329</a>} |
| <a href=#330 id=330 data-nosnippet>330</a> |
| <a href=#331 id=331 data-nosnippet>331</a><span class="kw">impl </span>SsrMatches { |
| <a href=#332 id=332 data-nosnippet>332</a> <span class="doccomment">/// Returns `self` with any nested matches removed and made into top-level matches. |
| <a href=#333 id=333 data-nosnippet>333</a> </span><span class="kw">pub fn </span>flattened(<span class="self">self</span>) -> SsrMatches { |
| <a href=#334 id=334 data-nosnippet>334</a> <span class="kw">let </span><span class="kw-2">mut </span>out = SsrMatches::default(); |
| <a href=#335 id=335 data-nosnippet>335</a> <span class="self">self</span>.flatten_into(<span class="kw-2">&mut </span>out); |
| <a href=#336 id=336 data-nosnippet>336</a> out |
| <a href=#337 id=337 data-nosnippet>337</a> } |
| <a href=#338 id=338 data-nosnippet>338</a> |
| <a href=#339 id=339 data-nosnippet>339</a> <span class="kw">fn </span>flatten_into(<span class="self">self</span>, out: <span class="kw-2">&mut </span>SsrMatches) { |
| <a href=#340 id=340 data-nosnippet>340</a> <span class="kw">for </span><span class="kw-2">mut </span>m <span class="kw">in </span><span class="self">self</span>.matches { |
| <a href=#341 id=341 data-nosnippet>341</a> <span class="kw">for </span>p <span class="kw">in </span>m.placeholder_values.values_mut() { |
| <a href=#342 id=342 data-nosnippet>342</a> std::mem::take(<span class="kw-2">&mut </span>p.inner_matches).flatten_into(out); |
| <a href=#343 id=343 data-nosnippet>343</a> } |
| <a href=#344 id=344 data-nosnippet>344</a> out.matches.push(m); |
| <a href=#345 id=345 data-nosnippet>345</a> } |
| <a href=#346 id=346 data-nosnippet>346</a> } |
| <a href=#347 id=347 data-nosnippet>347</a>} |
| <a href=#348 id=348 data-nosnippet>348</a> |
| <a href=#349 id=349 data-nosnippet>349</a><span class="kw">impl </span>Match { |
| <a href=#350 id=350 data-nosnippet>350</a> <span class="kw">pub fn </span>matched_text(<span class="kw-2">&</span><span class="self">self</span>) -> String { |
| <a href=#351 id=351 data-nosnippet>351</a> <span class="self">self</span>.matched_node.text().to_string() |
| <a href=#352 id=352 data-nosnippet>352</a> } |
| <a href=#353 id=353 data-nosnippet>353</a>} |
| <a href=#354 id=354 data-nosnippet>354</a> |
| <a href=#355 id=355 data-nosnippet>355</a><span class="kw">impl </span>std::error::Error <span class="kw">for </span>SsrError {} |
| <a href=#356 id=356 data-nosnippet>356</a> |
| <a href=#357 id=357 data-nosnippet>357</a><span class="attr">#[cfg(test)] |
| <a href=#358 id=358 data-nosnippet>358</a></span><span class="kw">impl </span>MatchDebugInfo { |
| <a href=#359 id=359 data-nosnippet>359</a> <span class="kw">pub fn </span>match_failure_reason(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str> { |
| <a href=#360 id=360 data-nosnippet>360</a> <span class="self">self</span>.matched.as_ref().err().map(|r| r.reason.as_str()) |
| <a href=#361 id=361 data-nosnippet>361</a> } |
| <a href=#362 id=362 data-nosnippet>362</a>} |
| </code></pre></div></section></main></body></html> |
