| <!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/search.rs`."><title>search.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>search.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">//! Searching for matches. |
| <a href=#2 id=2 data-nosnippet>2</a> |
| <a href=#3 id=3 data-nosnippet>3</a></span><span class="kw">use </span>crate::{ |
| <a href=#4 id=4 data-nosnippet>4</a> Match, MatchFinder, matching, |
| <a href=#5 id=5 data-nosnippet>5</a> resolving::{ResolvedPath, ResolvedPattern, ResolvedRule}, |
| <a href=#6 id=6 data-nosnippet>6</a>}; |
| <a href=#7 id=7 data-nosnippet>7</a><span class="kw">use </span>hir::FileRange; |
| <a href=#8 id=8 data-nosnippet>8</a><span class="kw">use </span>ide_db::{ |
| <a href=#9 id=9 data-nosnippet>9</a> FileId, FxHashSet, LocalRoots, |
| <a href=#10 id=10 data-nosnippet>10</a> defs::Definition, |
| <a href=#11 id=11 data-nosnippet>11</a> search::{SearchScope, UsageSearchResult}, |
| <a href=#12 id=12 data-nosnippet>12</a>}; |
| <a href=#13 id=13 data-nosnippet>13</a><span class="kw">use </span>syntax::{AstNode, SyntaxKind, SyntaxNode, ast}; |
| <a href=#14 id=14 data-nosnippet>14</a> |
| <a href=#15 id=15 data-nosnippet>15</a><span class="doccomment">/// A cache for the results of find_usages. This is for when we have multiple patterns that have the |
| <a href=#16 id=16 data-nosnippet>16</a>/// same path. e.g. if the pattern was `foo::Bar` that can parse as a path, an expression, a type |
| <a href=#17 id=17 data-nosnippet>17</a>/// and as a pattern. In each, the usages of `foo::Bar` are the same and we'd like to avoid finding |
| <a href=#18 id=18 data-nosnippet>18</a>/// them more than once. |
| <a href=#19 id=19 data-nosnippet>19</a></span><span class="attr">#[derive(Default)] |
| <a href=#20 id=20 data-nosnippet>20</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>UsageCache { |
| <a href=#21 id=21 data-nosnippet>21</a> usages: Vec<(Definition, UsageSearchResult)>, |
| <a href=#22 id=22 data-nosnippet>22</a>} |
| <a href=#23 id=23 data-nosnippet>23</a> |
| <a href=#24 id=24 data-nosnippet>24</a><span class="kw">impl</span><<span class="lifetime">'db</span>> MatchFinder<<span class="lifetime">'db</span>> { |
| <a href=#25 id=25 data-nosnippet>25</a> <span class="doccomment">/// Adds all matches for `rule` to `matches_out`. Matches may overlap in ways that make |
| <a href=#26 id=26 data-nosnippet>26</a> /// replacement impossible, so further processing is required in order to properly nest matches |
| <a href=#27 id=27 data-nosnippet>27</a> /// and remove overlapping matches. This is done in the `nesting` module. |
| <a href=#28 id=28 data-nosnippet>28</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>find_matches_for_rule( |
| <a href=#29 id=29 data-nosnippet>29</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#30 id=30 data-nosnippet>30</a> rule: <span class="kw-2">&</span>ResolvedRule<<span class="lifetime">'db</span>>, |
| <a href=#31 id=31 data-nosnippet>31</a> usage_cache: <span class="kw-2">&mut </span>UsageCache, |
| <a href=#32 id=32 data-nosnippet>32</a> matches_out: <span class="kw-2">&mut </span>Vec<Match>, |
| <a href=#33 id=33 data-nosnippet>33</a> ) { |
| <a href=#34 id=34 data-nosnippet>34</a> <span class="kw">if </span>rule.pattern.contains_self { |
| <a href=#35 id=35 data-nosnippet>35</a> <span class="comment">// If the pattern contains `self` we restrict the scope of the search to just the |
| <a href=#36 id=36 data-nosnippet>36</a> // current method. No other method can reference the same `self`. This makes the |
| <a href=#37 id=37 data-nosnippet>37</a> // behavior of `self` consistent with other variables. |
| <a href=#38 id=38 data-nosnippet>38</a> </span><span class="kw">if let </span><span class="prelude-val">Some</span>(current_function) = <span class="self">self</span>.resolution_scope.current_function() { |
| <a href=#39 id=39 data-nosnippet>39</a> <span class="self">self</span>.slow_scan_node(<span class="kw-2">&</span>current_function, rule, <span class="kw-2">&</span><span class="prelude-val">None</span>, matches_out); |
| <a href=#40 id=40 data-nosnippet>40</a> } |
| <a href=#41 id=41 data-nosnippet>41</a> <span class="kw">return</span>; |
| <a href=#42 id=42 data-nosnippet>42</a> } |
| <a href=#43 id=43 data-nosnippet>43</a> <span class="kw">if </span>pick_path_for_usages(<span class="kw-2">&</span>rule.pattern).is_none() { |
| <a href=#44 id=44 data-nosnippet>44</a> <span class="self">self</span>.slow_scan(rule, matches_out); |
| <a href=#45 id=45 data-nosnippet>45</a> <span class="kw">return</span>; |
| <a href=#46 id=46 data-nosnippet>46</a> } |
| <a href=#47 id=47 data-nosnippet>47</a> <span class="self">self</span>.find_matches_for_pattern_tree(rule, <span class="kw-2">&</span>rule.pattern, usage_cache, matches_out); |
| <a href=#48 id=48 data-nosnippet>48</a> } |
| <a href=#49 id=49 data-nosnippet>49</a> |
| <a href=#50 id=50 data-nosnippet>50</a> <span class="kw">fn </span>find_matches_for_pattern_tree( |
| <a href=#51 id=51 data-nosnippet>51</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#52 id=52 data-nosnippet>52</a> rule: <span class="kw-2">&</span>ResolvedRule<<span class="lifetime">'db</span>>, |
| <a href=#53 id=53 data-nosnippet>53</a> pattern: <span class="kw-2">&</span>ResolvedPattern<<span class="lifetime">'db</span>>, |
| <a href=#54 id=54 data-nosnippet>54</a> usage_cache: <span class="kw-2">&mut </span>UsageCache, |
| <a href=#55 id=55 data-nosnippet>55</a> matches_out: <span class="kw-2">&mut </span>Vec<Match>, |
| <a href=#56 id=56 data-nosnippet>56</a> ) { |
| <a href=#57 id=57 data-nosnippet>57</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(resolved_path) = pick_path_for_usages(pattern) { |
| <a href=#58 id=58 data-nosnippet>58</a> <span class="kw">let </span>definition: Definition = resolved_path.resolution.into(); |
| <a href=#59 id=59 data-nosnippet>59</a> <span class="kw">for </span>file_range <span class="kw">in </span><span class="self">self</span>.find_usages(usage_cache, definition).file_ranges() { |
| <a href=#60 id=60 data-nosnippet>60</a> <span class="kw">for </span>node_to_match <span class="kw">in </span><span class="self">self</span>.find_nodes_to_match(resolved_path, file_range) { |
| <a href=#61 id=61 data-nosnippet>61</a> <span class="kw">if </span>!is_search_permitted_ancestors(<span class="kw-2">&</span>node_to_match) { |
| <a href=#62 id=62 data-nosnippet>62</a> <span class="macro">cov_mark::hit!</span>(use_declaration_with_braces); |
| <a href=#63 id=63 data-nosnippet>63</a> <span class="kw">continue</span>; |
| <a href=#64 id=64 data-nosnippet>64</a> } |
| <a href=#65 id=65 data-nosnippet>65</a> <span class="self">self</span>.try_add_match(rule, <span class="kw-2">&</span>node_to_match, <span class="kw-2">&</span><span class="prelude-val">None</span>, matches_out); |
| <a href=#66 id=66 data-nosnippet>66</a> } |
| <a href=#67 id=67 data-nosnippet>67</a> } |
| <a href=#68 id=68 data-nosnippet>68</a> } |
| <a href=#69 id=69 data-nosnippet>69</a> } |
| <a href=#70 id=70 data-nosnippet>70</a> |
| <a href=#71 id=71 data-nosnippet>71</a> <span class="kw">fn </span>find_nodes_to_match( |
| <a href=#72 id=72 data-nosnippet>72</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#73 id=73 data-nosnippet>73</a> resolved_path: <span class="kw-2">&</span>ResolvedPath, |
| <a href=#74 id=74 data-nosnippet>74</a> file_range: FileRange, |
| <a href=#75 id=75 data-nosnippet>75</a> ) -> Vec<SyntaxNode> { |
| <a href=#76 id=76 data-nosnippet>76</a> <span class="kw">let </span>file = <span class="self">self</span>.sema.parse(file_range.file_id); |
| <a href=#77 id=77 data-nosnippet>77</a> <span class="kw">let </span>depth = resolved_path.depth <span class="kw">as </span>usize; |
| <a href=#78 id=78 data-nosnippet>78</a> <span class="kw">let </span>offset = file_range.range.start(); |
| <a href=#79 id=79 data-nosnippet>79</a> |
| <a href=#80 id=80 data-nosnippet>80</a> <span class="kw">let </span><span class="kw-2">mut </span>paths = <span class="self">self |
| <a href=#81 id=81 data-nosnippet>81</a> </span>.sema |
| <a href=#82 id=82 data-nosnippet>82</a> .find_nodes_at_offset_with_descend::<ast::Path>(file.syntax(), offset) |
| <a href=#83 id=83 data-nosnippet>83</a> .peekable(); |
| <a href=#84 id=84 data-nosnippet>84</a> |
| <a href=#85 id=85 data-nosnippet>85</a> <span class="kw">if </span>paths.peek().is_some() { |
| <a href=#86 id=86 data-nosnippet>86</a> paths |
| <a href=#87 id=87 data-nosnippet>87</a> .filter_map(|path| { |
| <a href=#88 id=88 data-nosnippet>88</a> <span class="self">self</span>.sema.ancestors_with_macros(path.syntax().clone()).nth(depth) |
| <a href=#89 id=89 data-nosnippet>89</a> }) |
| <a href=#90 id=90 data-nosnippet>90</a> .collect::<Vec<<span class="kw">_</span>>>() |
| <a href=#91 id=91 data-nosnippet>91</a> } <span class="kw">else </span>{ |
| <a href=#92 id=92 data-nosnippet>92</a> <span class="self">self</span>.sema |
| <a href=#93 id=93 data-nosnippet>93</a> .find_nodes_at_offset_with_descend::<ast::MethodCallExpr>(file.syntax(), offset) |
| <a href=#94 id=94 data-nosnippet>94</a> .filter_map(|path| { |
| <a href=#95 id=95 data-nosnippet>95</a> <span class="comment">// If the pattern contained a path and we found a reference to that path that wasn't |
| <a href=#96 id=96 data-nosnippet>96</a> // itself a path, but was a method call, then we need to adjust how far up to try |
| <a href=#97 id=97 data-nosnippet>97</a> // matching by how deep the path was within a CallExpr. The structure would have been |
| <a href=#98 id=98 data-nosnippet>98</a> // CallExpr, PathExpr, Path - i.e. a depth offset of 2. We don't need to check if the |
| <a href=#99 id=99 data-nosnippet>99</a> // path was part of a CallExpr because if it wasn't then all that will happen is we'll |
| <a href=#100 id=100 data-nosnippet>100</a> // fail to match, which is the desired behavior. |
| <a href=#101 id=101 data-nosnippet>101</a> </span><span class="kw">const </span>PATH_DEPTH_IN_CALL_EXPR: usize = <span class="number">2</span>; |
| <a href=#102 id=102 data-nosnippet>102</a> <span class="kw">if </span>depth < PATH_DEPTH_IN_CALL_EXPR { |
| <a href=#103 id=103 data-nosnippet>103</a> <span class="kw">return </span><span class="prelude-val">None</span>; |
| <a href=#104 id=104 data-nosnippet>104</a> } |
| <a href=#105 id=105 data-nosnippet>105</a> <span class="self">self</span>.sema |
| <a href=#106 id=106 data-nosnippet>106</a> .ancestors_with_macros(path.syntax().clone()) |
| <a href=#107 id=107 data-nosnippet>107</a> .nth(depth - PATH_DEPTH_IN_CALL_EXPR) |
| <a href=#108 id=108 data-nosnippet>108</a> }) |
| <a href=#109 id=109 data-nosnippet>109</a> .collect::<Vec<<span class="kw">_</span>>>() |
| <a href=#110 id=110 data-nosnippet>110</a> } |
| <a href=#111 id=111 data-nosnippet>111</a> } |
| <a href=#112 id=112 data-nosnippet>112</a> |
| <a href=#113 id=113 data-nosnippet>113</a> <span class="kw">fn </span>find_usages<<span class="lifetime">'a</span>>( |
| <a href=#114 id=114 data-nosnippet>114</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#115 id=115 data-nosnippet>115</a> usage_cache: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>UsageCache, |
| <a href=#116 id=116 data-nosnippet>116</a> definition: Definition, |
| <a href=#117 id=117 data-nosnippet>117</a> ) -> <span class="kw-2">&</span><span class="lifetime">'a </span>UsageSearchResult { |
| <a href=#118 id=118 data-nosnippet>118</a> <span class="comment">// Logically if a lookup succeeds we should just return it. Unfortunately returning it would |
| <a href=#119 id=119 data-nosnippet>119</a> // extend the lifetime of the borrow, then we wouldn't be able to do the insertion on a |
| <a href=#120 id=120 data-nosnippet>120</a> // cache miss. This is a limitation of NLL and is fixed with Polonius. For now we do two |
| <a href=#121 id=121 data-nosnippet>121</a> // lookups in the case of a cache hit. |
| <a href=#122 id=122 data-nosnippet>122</a> </span><span class="kw">if </span>usage_cache.find(<span class="kw-2">&</span>definition).is_none() { |
| <a href=#123 id=123 data-nosnippet>123</a> <span class="kw">let </span>usages = definition.usages(<span class="kw-2">&</span><span class="self">self</span>.sema).in_scope(<span class="kw-2">&</span><span class="self">self</span>.search_scope()).all(); |
| <a href=#124 id=124 data-nosnippet>124</a> usage_cache.usages.push((definition, usages)); |
| <a href=#125 id=125 data-nosnippet>125</a> <span class="kw">return </span><span class="kw-2">&</span>usage_cache.usages.last().unwrap().<span class="number">1</span>; |
| <a href=#126 id=126 data-nosnippet>126</a> } |
| <a href=#127 id=127 data-nosnippet>127</a> usage_cache.find(<span class="kw-2">&</span>definition).unwrap() |
| <a href=#128 id=128 data-nosnippet>128</a> } |
| <a href=#129 id=129 data-nosnippet>129</a> |
| <a href=#130 id=130 data-nosnippet>130</a> <span class="doccomment">/// Returns the scope within which we want to search. We don't want un unrestricted search |
| <a href=#131 id=131 data-nosnippet>131</a> /// scope, since we don't want to find references in external dependencies. |
| <a href=#132 id=132 data-nosnippet>132</a> </span><span class="kw">fn </span>search_scope(<span class="kw-2">&</span><span class="self">self</span>) -> SearchScope { |
| <a href=#133 id=133 data-nosnippet>133</a> <span class="comment">// FIXME: We should ideally have a test that checks that we edit local roots and not library |
| <a href=#134 id=134 data-nosnippet>134</a> // roots. This probably would require some changes to fixtures, since currently everything |
| <a href=#135 id=135 data-nosnippet>135</a> // seems to get put into a single source root. |
| <a href=#136 id=136 data-nosnippet>136</a> </span><span class="kw">let </span><span class="kw-2">mut </span>files = Vec::new(); |
| <a href=#137 id=137 data-nosnippet>137</a> <span class="self">self</span>.search_files_do(|file_id| { |
| <a href=#138 id=138 data-nosnippet>138</a> files.push(<span class="self">self</span>.sema.attach_first_edition(file_id)); |
| <a href=#139 id=139 data-nosnippet>139</a> }); |
| <a href=#140 id=140 data-nosnippet>140</a> SearchScope::files(<span class="kw-2">&</span>files) |
| <a href=#141 id=141 data-nosnippet>141</a> } |
| <a href=#142 id=142 data-nosnippet>142</a> |
| <a href=#143 id=143 data-nosnippet>143</a> <span class="kw">fn </span>slow_scan(<span class="kw-2">&</span><span class="self">self</span>, rule: <span class="kw-2">&</span>ResolvedRule<<span class="lifetime">'db</span>>, matches_out: <span class="kw-2">&mut </span>Vec<Match>) { |
| <a href=#144 id=144 data-nosnippet>144</a> <span class="self">self</span>.search_files_do(|file_id| { |
| <a href=#145 id=145 data-nosnippet>145</a> <span class="kw">let </span>file = <span class="self">self</span>.sema.parse_guess_edition(file_id); |
| <a href=#146 id=146 data-nosnippet>146</a> <span class="kw">let </span>code = file.syntax(); |
| <a href=#147 id=147 data-nosnippet>147</a> <span class="self">self</span>.slow_scan_node(code, rule, <span class="kw-2">&</span><span class="prelude-val">None</span>, matches_out); |
| <a href=#148 id=148 data-nosnippet>148</a> }) |
| <a href=#149 id=149 data-nosnippet>149</a> } |
| <a href=#150 id=150 data-nosnippet>150</a> |
| <a href=#151 id=151 data-nosnippet>151</a> <span class="kw">fn </span>search_files_do(<span class="kw-2">&</span><span class="self">self</span>, <span class="kw-2">mut </span>callback: <span class="kw">impl </span>FnMut(FileId)) { |
| <a href=#152 id=152 data-nosnippet>152</a> <span class="kw">if </span><span class="self">self</span>.restrict_ranges.is_empty() { |
| <a href=#153 id=153 data-nosnippet>153</a> <span class="comment">// Unrestricted search. |
| <a href=#154 id=154 data-nosnippet>154</a> </span><span class="kw">use </span>ide_db::base_db::SourceDatabase; |
| <a href=#155 id=155 data-nosnippet>155</a> <span class="kw">for </span><span class="kw-2">&</span>root <span class="kw">in </span>LocalRoots::get(<span class="self">self</span>.sema.db).roots(<span class="self">self</span>.sema.db).iter() { |
| <a href=#156 id=156 data-nosnippet>156</a> <span class="kw">let </span>sr = <span class="self">self</span>.sema.db.source_root(root).source_root(<span class="self">self</span>.sema.db); |
| <a href=#157 id=157 data-nosnippet>157</a> <span class="kw">for </span>file_id <span class="kw">in </span>sr.iter() { |
| <a href=#158 id=158 data-nosnippet>158</a> callback(file_id); |
| <a href=#159 id=159 data-nosnippet>159</a> } |
| <a href=#160 id=160 data-nosnippet>160</a> } |
| <a href=#161 id=161 data-nosnippet>161</a> } <span class="kw">else </span>{ |
| <a href=#162 id=162 data-nosnippet>162</a> <span class="comment">// Search is restricted, deduplicate file IDs (generally only one). |
| <a href=#163 id=163 data-nosnippet>163</a> </span><span class="kw">let </span><span class="kw-2">mut </span>files = FxHashSet::default(); |
| <a href=#164 id=164 data-nosnippet>164</a> <span class="kw">for </span>range <span class="kw">in </span><span class="kw-2">&</span><span class="self">self</span>.restrict_ranges { |
| <a href=#165 id=165 data-nosnippet>165</a> <span class="kw">if </span>files.insert(range.file_id) { |
| <a href=#166 id=166 data-nosnippet>166</a> callback(range.file_id); |
| <a href=#167 id=167 data-nosnippet>167</a> } |
| <a href=#168 id=168 data-nosnippet>168</a> } |
| <a href=#169 id=169 data-nosnippet>169</a> } |
| <a href=#170 id=170 data-nosnippet>170</a> } |
| <a href=#171 id=171 data-nosnippet>171</a> |
| <a href=#172 id=172 data-nosnippet>172</a> <span class="kw">fn </span>slow_scan_node( |
| <a href=#173 id=173 data-nosnippet>173</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#174 id=174 data-nosnippet>174</a> code: <span class="kw-2">&</span>SyntaxNode, |
| <a href=#175 id=175 data-nosnippet>175</a> rule: <span class="kw-2">&</span>ResolvedRule<<span class="lifetime">'db</span>>, |
| <a href=#176 id=176 data-nosnippet>176</a> restrict_range: <span class="kw-2">&</span><span class="prelude-ty">Option</span><FileRange>, |
| <a href=#177 id=177 data-nosnippet>177</a> matches_out: <span class="kw-2">&mut </span>Vec<Match>, |
| <a href=#178 id=178 data-nosnippet>178</a> ) { |
| <a href=#179 id=179 data-nosnippet>179</a> <span class="kw">if </span>!is_search_permitted(code) { |
| <a href=#180 id=180 data-nosnippet>180</a> <span class="kw">return</span>; |
| <a href=#181 id=181 data-nosnippet>181</a> } |
| <a href=#182 id=182 data-nosnippet>182</a> <span class="self">self</span>.try_add_match(rule, code, restrict_range, matches_out); |
| <a href=#183 id=183 data-nosnippet>183</a> <span class="comment">// If we've got a macro call, we already tried matching it pre-expansion, which is the only |
| <a href=#184 id=184 data-nosnippet>184</a> // way to match the whole macro, now try expanding it and matching the expansion. |
| <a href=#185 id=185 data-nosnippet>185</a> </span><span class="kw">if let </span><span class="prelude-val">Some</span>(macro_call) = ast::MacroCall::cast(code.clone()) |
| <a href=#186 id=186 data-nosnippet>186</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=#187 id=187 data-nosnippet>187</a> && <span class="kw">let </span><span class="prelude-val">Some</span>(tt) = macro_call.token_tree() |
| <a href=#188 id=188 data-nosnippet>188</a> { |
| <a href=#189 id=189 data-nosnippet>189</a> <span class="comment">// When matching within a macro expansion, we only want to allow matches of |
| <a href=#190 id=190 data-nosnippet>190</a> // nodes that originated entirely from within the token tree of the macro call. |
| <a href=#191 id=191 data-nosnippet>191</a> // i.e. we don't want to match something that came from the macro itself. |
| <a href=#192 id=192 data-nosnippet>192</a> </span><span class="kw">if let </span><span class="prelude-val">Some</span>(range) = <span class="self">self</span>.sema.original_range_opt(tt.syntax()) { |
| <a href=#193 id=193 data-nosnippet>193</a> <span class="self">self</span>.slow_scan_node(<span class="kw-2">&</span>expanded.value, rule, <span class="kw-2">&</span><span class="prelude-val">Some</span>(range), matches_out); |
| <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> <span class="kw">for </span>child <span class="kw">in </span>code.children() { |
| <a href=#197 id=197 data-nosnippet>197</a> <span class="self">self</span>.slow_scan_node(<span class="kw-2">&</span>child, rule, restrict_range, matches_out); |
| <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> |
| <a href=#201 id=201 data-nosnippet>201</a> <span class="kw">fn </span>try_add_match( |
| <a href=#202 id=202 data-nosnippet>202</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#203 id=203 data-nosnippet>203</a> rule: <span class="kw-2">&</span>ResolvedRule<<span class="lifetime">'db</span>>, |
| <a href=#204 id=204 data-nosnippet>204</a> code: <span class="kw-2">&</span>SyntaxNode, |
| <a href=#205 id=205 data-nosnippet>205</a> restrict_range: <span class="kw-2">&</span><span class="prelude-ty">Option</span><FileRange>, |
| <a href=#206 id=206 data-nosnippet>206</a> matches_out: <span class="kw-2">&mut </span>Vec<Match>, |
| <a href=#207 id=207 data-nosnippet>207</a> ) { |
| <a href=#208 id=208 data-nosnippet>208</a> <span class="kw">if </span>!<span class="self">self</span>.within_range_restrictions(code) { |
| <a href=#209 id=209 data-nosnippet>209</a> <span class="macro">cov_mark::hit!</span>(replace_nonpath_within_selection); |
| <a href=#210 id=210 data-nosnippet>210</a> <span class="kw">return</span>; |
| <a href=#211 id=211 data-nosnippet>211</a> } |
| <a href=#212 id=212 data-nosnippet>212</a> <span class="kw">if let </span><span class="prelude-val">Ok</span>(m) = matching::get_match(<span class="bool-val">false</span>, rule, code, restrict_range, <span class="kw-2">&</span><span class="self">self</span>.sema) { |
| <a href=#213 id=213 data-nosnippet>213</a> matches_out.push(m); |
| <a href=#214 id=214 data-nosnippet>214</a> } |
| <a href=#215 id=215 data-nosnippet>215</a> } |
| <a href=#216 id=216 data-nosnippet>216</a> |
| <a href=#217 id=217 data-nosnippet>217</a> <span class="doccomment">/// Returns whether `code` is within one of our range restrictions if we have any. No range |
| <a href=#218 id=218 data-nosnippet>218</a> /// restrictions is considered unrestricted and always returns true. |
| <a href=#219 id=219 data-nosnippet>219</a> </span><span class="kw">fn </span>within_range_restrictions(<span class="kw-2">&</span><span class="self">self</span>, code: <span class="kw-2">&</span>SyntaxNode) -> bool { |
| <a href=#220 id=220 data-nosnippet>220</a> <span class="kw">if </span><span class="self">self</span>.restrict_ranges.is_empty() { |
| <a href=#221 id=221 data-nosnippet>221</a> <span class="comment">// There is no range restriction. |
| <a href=#222 id=222 data-nosnippet>222</a> </span><span class="kw">return </span><span class="bool-val">true</span>; |
| <a href=#223 id=223 data-nosnippet>223</a> } |
| <a href=#224 id=224 data-nosnippet>224</a> <span class="kw">let </span><span class="prelude-val">Some</span>(node_range) = <span class="self">self</span>.sema.original_range_opt(code) <span class="kw">else </span>{ <span class="kw">return </span><span class="bool-val">false </span>}; |
| <a href=#225 id=225 data-nosnippet>225</a> <span class="kw">for </span>range <span class="kw">in </span><span class="kw-2">&</span><span class="self">self</span>.restrict_ranges { |
| <a href=#226 id=226 data-nosnippet>226</a> <span class="kw">if </span>range.file_id == node_range.file_id.file_id(<span class="self">self</span>.sema.db) |
| <a href=#227 id=227 data-nosnippet>227</a> && range.range.contains_range(node_range.range) |
| <a href=#228 id=228 data-nosnippet>228</a> { |
| <a href=#229 id=229 data-nosnippet>229</a> <span class="kw">return </span><span class="bool-val">true</span>; |
| <a href=#230 id=230 data-nosnippet>230</a> } |
| <a href=#231 id=231 data-nosnippet>231</a> } |
| <a href=#232 id=232 data-nosnippet>232</a> <span class="bool-val">false |
| <a href=#233 id=233 data-nosnippet>233</a> </span>} |
| <a href=#234 id=234 data-nosnippet>234</a>} |
| <a href=#235 id=235 data-nosnippet>235</a> |
| <a href=#236 id=236 data-nosnippet>236</a><span class="doccomment">/// Returns whether we support matching within `node` and all of its ancestors. |
| <a href=#237 id=237 data-nosnippet>237</a></span><span class="kw">fn </span>is_search_permitted_ancestors(node: <span class="kw-2">&</span>SyntaxNode) -> bool { |
| <a href=#238 id=238 data-nosnippet>238</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(parent) = node.parent() |
| <a href=#239 id=239 data-nosnippet>239</a> && !is_search_permitted_ancestors(<span class="kw-2">&</span>parent) |
| <a href=#240 id=240 data-nosnippet>240</a> { |
| <a href=#241 id=241 data-nosnippet>241</a> <span class="kw">return </span><span class="bool-val">false</span>; |
| <a href=#242 id=242 data-nosnippet>242</a> } |
| <a href=#243 id=243 data-nosnippet>243</a> is_search_permitted(node) |
| <a href=#244 id=244 data-nosnippet>244</a>} |
| <a href=#245 id=245 data-nosnippet>245</a> |
| <a href=#246 id=246 data-nosnippet>246</a><span class="doccomment">/// Returns whether we support matching within this kind of node. |
| <a href=#247 id=247 data-nosnippet>247</a></span><span class="kw">fn </span>is_search_permitted(node: <span class="kw-2">&</span>SyntaxNode) -> bool { |
| <a href=#248 id=248 data-nosnippet>248</a> <span class="comment">// FIXME: Properly handle use declarations. At the moment, if our search pattern is `foo::bar` |
| <a href=#249 id=249 data-nosnippet>249</a> // and the code is `use foo::{baz, bar}`, we'll match `bar`, since it resolves to `foo::bar`. |
| <a href=#250 id=250 data-nosnippet>250</a> // However we'll then replace just the part we matched `bar`. We probably need to instead remove |
| <a href=#251 id=251 data-nosnippet>251</a> // `bar` and insert a new use declaration. |
| <a href=#252 id=252 data-nosnippet>252</a> </span>node.kind() != SyntaxKind::USE |
| <a href=#253 id=253 data-nosnippet>253</a>} |
| <a href=#254 id=254 data-nosnippet>254</a> |
| <a href=#255 id=255 data-nosnippet>255</a><span class="kw">impl </span>UsageCache { |
| <a href=#256 id=256 data-nosnippet>256</a> <span class="kw">fn </span>find(<span class="kw-2">&mut </span><span class="self">self</span>, definition: <span class="kw-2">&</span>Definition) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>UsageSearchResult> { |
| <a href=#257 id=257 data-nosnippet>257</a> <span class="comment">// We expect a very small number of cache entries (generally 1), so a linear scan should be |
| <a href=#258 id=258 data-nosnippet>258</a> // fast enough and avoids the need to implement Hash for Definition. |
| <a href=#259 id=259 data-nosnippet>259</a> </span><span class="kw">for </span>(d, refs) <span class="kw">in </span><span class="kw-2">&</span><span class="self">self</span>.usages { |
| <a href=#260 id=260 data-nosnippet>260</a> <span class="kw">if </span>d == definition { |
| <a href=#261 id=261 data-nosnippet>261</a> <span class="kw">return </span><span class="prelude-val">Some</span>(refs); |
| <a href=#262 id=262 data-nosnippet>262</a> } |
| <a href=#263 id=263 data-nosnippet>263</a> } |
| <a href=#264 id=264 data-nosnippet>264</a> <span class="prelude-val">None |
| <a href=#265 id=265 data-nosnippet>265</a> </span>} |
| <a href=#266 id=266 data-nosnippet>266</a>} |
| <a href=#267 id=267 data-nosnippet>267</a> |
| <a href=#268 id=268 data-nosnippet>268</a><span class="doccomment">/// Returns a path that's suitable for path resolution. We exclude builtin types, since they aren't |
| <a href=#269 id=269 data-nosnippet>269</a>/// something that we can find references to. We then somewhat arbitrarily pick the path that is the |
| <a href=#270 id=270 data-nosnippet>270</a>/// longest as this is hopefully more likely to be less common, making it faster to find. |
| <a href=#271 id=271 data-nosnippet>271</a></span><span class="kw">fn </span>pick_path_for_usages<<span class="lifetime">'a</span>>(pattern: <span class="kw-2">&</span><span class="lifetime">'a </span>ResolvedPattern<<span class="lifetime">'_</span>>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>ResolvedPath> { |
| <a href=#272 id=272 data-nosnippet>272</a> <span class="comment">// FIXME: Take the scope of the resolved path into account. e.g. if there are any paths that are |
| <a href=#273 id=273 data-nosnippet>273</a> // private to the current module, then we definitely would want to pick them over say a path |
| <a href=#274 id=274 data-nosnippet>274</a> // from std. Possibly we should go further than this and intersect the search scopes for all |
| <a href=#275 id=275 data-nosnippet>275</a> // resolved paths then search only in that scope. |
| <a href=#276 id=276 data-nosnippet>276</a> </span>pattern |
| <a href=#277 id=277 data-nosnippet>277</a> .resolved_paths |
| <a href=#278 id=278 data-nosnippet>278</a> .iter() |
| <a href=#279 id=279 data-nosnippet>279</a> .filter(|(<span class="kw">_</span>, p)| { |
| <a href=#280 id=280 data-nosnippet>280</a> !<span class="macro">matches!</span>(p.resolution, hir::PathResolution::Def(hir::ModuleDef::BuiltinType(<span class="kw">_</span>))) |
| <a href=#281 id=281 data-nosnippet>281</a> }) |
| <a href=#282 id=282 data-nosnippet>282</a> .map(|(node, resolved)| (node.text().len(), resolved)) |
| <a href=#283 id=283 data-nosnippet>283</a> .max_by(|(a, <span class="kw">_</span>), (b, <span class="kw">_</span>)| a.cmp(b)) |
| <a href=#284 id=284 data-nosnippet>284</a> .map(|(<span class="kw">_</span>, resolved)| resolved) |
| <a href=#285 id=285 data-nosnippet>285</a>} |
| </code></pre></div></section></main></body></html> |
