| <!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/nester.rs`."><title>nester.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>nester.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Converts a flat collection of matches into a nested form suitable for replacement. When there |
| <a href=#2 id=2 data-nosnippet>2</a>//! are multiple matches for a node, or that overlap, priority is given to the earlier rule. Nested |
| <a href=#3 id=3 data-nosnippet>3</a>//! matches are only permitted if the inner match is contained entirely within a placeholder of an |
| <a href=#4 id=4 data-nosnippet>4</a>//! outer match. |
| <a href=#5 id=5 data-nosnippet>5</a>//! |
| <a href=#6 id=6 data-nosnippet>6</a>//! For example, if our search pattern is `foo(foo($a))` and the code had `foo(foo(foo(foo(42))))`, |
| <a href=#7 id=7 data-nosnippet>7</a>//! then we'll get 3 matches, however only the outermost and innermost matches can be accepted. The |
| <a href=#8 id=8 data-nosnippet>8</a>//! middle match would take the second `foo` from the outer match. |
| <a href=#9 id=9 data-nosnippet>9</a> |
| <a href=#10 id=10 data-nosnippet>10</a></span><span class="kw">use </span>ide_db::FxHashMap; |
| <a href=#11 id=11 data-nosnippet>11</a><span class="kw">use </span>syntax::SyntaxNode; |
| <a href=#12 id=12 data-nosnippet>12</a> |
| <a href=#13 id=13 data-nosnippet>13</a><span class="kw">use </span>crate::{Match, SsrMatches}; |
| <a href=#14 id=14 data-nosnippet>14</a> |
| <a href=#15 id=15 data-nosnippet>15</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>nest_and_remove_collisions( |
| <a href=#16 id=16 data-nosnippet>16</a> <span class="kw-2">mut </span>matches: Vec<Match>, |
| <a href=#17 id=17 data-nosnippet>17</a> sema: <span class="kw-2">&</span>hir::Semantics<<span class="lifetime">'_</span>, ide_db::RootDatabase>, |
| <a href=#18 id=18 data-nosnippet>18</a>) -> SsrMatches { |
| <a href=#19 id=19 data-nosnippet>19</a> <span class="comment">// We sort the matches by depth then by rule index. Sorting by depth means that by the time we |
| <a href=#20 id=20 data-nosnippet>20</a> // see a match, any parent matches or conflicting matches will have already been seen. Sorting |
| <a href=#21 id=21 data-nosnippet>21</a> // by rule_index means that if there are two matches for the same node, the rule added first |
| <a href=#22 id=22 data-nosnippet>22</a> // will take precedence. |
| <a href=#23 id=23 data-nosnippet>23</a> </span>matches.sort_by(|a, b| a.depth.cmp(<span class="kw-2">&</span>b.depth).then_with(|| a.rule_index.cmp(<span class="kw-2">&</span>b.rule_index))); |
| <a href=#24 id=24 data-nosnippet>24</a> <span class="kw">let </span><span class="kw-2">mut </span>collector = MatchCollector::default(); |
| <a href=#25 id=25 data-nosnippet>25</a> <span class="kw">for </span>m <span class="kw">in </span>matches { |
| <a href=#26 id=26 data-nosnippet>26</a> collector.add_match(m, sema); |
| <a href=#27 id=27 data-nosnippet>27</a> } |
| <a href=#28 id=28 data-nosnippet>28</a> collector.into() |
| <a href=#29 id=29 data-nosnippet>29</a>} |
| <a href=#30 id=30 data-nosnippet>30</a> |
| <a href=#31 id=31 data-nosnippet>31</a><span class="attr">#[derive(Default)] |
| <a href=#32 id=32 data-nosnippet>32</a></span><span class="kw">struct </span>MatchCollector { |
| <a href=#33 id=33 data-nosnippet>33</a> matches_by_node: FxHashMap<SyntaxNode, Match>, |
| <a href=#34 id=34 data-nosnippet>34</a>} |
| <a href=#35 id=35 data-nosnippet>35</a> |
| <a href=#36 id=36 data-nosnippet>36</a><span class="kw">impl </span>MatchCollector { |
| <a href=#37 id=37 data-nosnippet>37</a> <span class="doccomment">/// Attempts to add `m` to matches. If it conflicts with an existing match, it is discarded. If |
| <a href=#38 id=38 data-nosnippet>38</a> /// it is entirely within the a placeholder of an existing match, then it is added as a child |
| <a href=#39 id=39 data-nosnippet>39</a> /// match of the existing match. |
| <a href=#40 id=40 data-nosnippet>40</a> </span><span class="kw">fn </span>add_match(<span class="kw-2">&mut </span><span class="self">self</span>, m: Match, sema: <span class="kw-2">&</span>hir::Semantics<<span class="lifetime">'_</span>, ide_db::RootDatabase>) { |
| <a href=#41 id=41 data-nosnippet>41</a> <span class="kw">let </span>matched_node = m.matched_node.clone(); |
| <a href=#42 id=42 data-nosnippet>42</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(existing) = <span class="self">self</span>.matches_by_node.get_mut(<span class="kw-2">&</span>matched_node) { |
| <a href=#43 id=43 data-nosnippet>43</a> try_add_sub_match(m, existing, sema); |
| <a href=#44 id=44 data-nosnippet>44</a> <span class="kw">return</span>; |
| <a href=#45 id=45 data-nosnippet>45</a> } |
| <a href=#46 id=46 data-nosnippet>46</a> <span class="kw">for </span>ancestor <span class="kw">in </span>sema.ancestors_with_macros(m.matched_node.clone()) { |
| <a href=#47 id=47 data-nosnippet>47</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(existing) = <span class="self">self</span>.matches_by_node.get_mut(<span class="kw-2">&</span>ancestor) { |
| <a href=#48 id=48 data-nosnippet>48</a> try_add_sub_match(m, existing, sema); |
| <a href=#49 id=49 data-nosnippet>49</a> <span class="kw">return</span>; |
| <a href=#50 id=50 data-nosnippet>50</a> } |
| <a href=#51 id=51 data-nosnippet>51</a> } |
| <a href=#52 id=52 data-nosnippet>52</a> <span class="self">self</span>.matches_by_node.insert(matched_node, m); |
| <a href=#53 id=53 data-nosnippet>53</a> } |
| <a href=#54 id=54 data-nosnippet>54</a>} |
| <a href=#55 id=55 data-nosnippet>55</a> |
| <a href=#56 id=56 data-nosnippet>56</a><span class="doccomment">/// Attempts to add `m` as a sub-match of `existing`. |
| <a href=#57 id=57 data-nosnippet>57</a></span><span class="kw">fn </span>try_add_sub_match( |
| <a href=#58 id=58 data-nosnippet>58</a> m: Match, |
| <a href=#59 id=59 data-nosnippet>59</a> existing: <span class="kw-2">&mut </span>Match, |
| <a href=#60 id=60 data-nosnippet>60</a> sema: <span class="kw-2">&</span>hir::Semantics<<span class="lifetime">'_</span>, ide_db::RootDatabase>, |
| <a href=#61 id=61 data-nosnippet>61</a>) { |
| <a href=#62 id=62 data-nosnippet>62</a> <span class="kw">for </span>p <span class="kw">in </span>existing.placeholder_values.values_mut() { |
| <a href=#63 id=63 data-nosnippet>63</a> <span class="comment">// Note, no need to check if p.range.file is equal to m.range.file, since we |
| <a href=#64 id=64 data-nosnippet>64</a> // already know we're within `existing`. |
| <a href=#65 id=65 data-nosnippet>65</a> </span><span class="kw">if </span>p.range.range.contains_range(m.range.range) { |
| <a href=#66 id=66 data-nosnippet>66</a> <span class="comment">// Convert the inner matches in `p` into a temporary MatchCollector. When |
| <a href=#67 id=67 data-nosnippet>67</a> // we're done, we then convert it back into an SsrMatches. If we expected |
| <a href=#68 id=68 data-nosnippet>68</a> // lots of inner matches, it might be worthwhile keeping a MatchCollector |
| <a href=#69 id=69 data-nosnippet>69</a> // around for each placeholder match. However we expect most placeholder |
| <a href=#70 id=70 data-nosnippet>70</a> // will have 0 and a few will have 1. More than that should hopefully be |
| <a href=#71 id=71 data-nosnippet>71</a> // exceptional. |
| <a href=#72 id=72 data-nosnippet>72</a> </span><span class="kw">let </span><span class="kw-2">mut </span>collector = MatchCollector::default(); |
| <a href=#73 id=73 data-nosnippet>73</a> <span class="kw">for </span>m <span class="kw">in </span>std::mem::take(<span class="kw-2">&mut </span>p.inner_matches.matches) { |
| <a href=#74 id=74 data-nosnippet>74</a> collector.matches_by_node.insert(m.matched_node.clone(), m); |
| <a href=#75 id=75 data-nosnippet>75</a> } |
| <a href=#76 id=76 data-nosnippet>76</a> collector.add_match(m, sema); |
| <a href=#77 id=77 data-nosnippet>77</a> p.inner_matches = collector.into(); |
| <a href=#78 id=78 data-nosnippet>78</a> <span class="kw">break</span>; |
| <a href=#79 id=79 data-nosnippet>79</a> } |
| <a href=#80 id=80 data-nosnippet>80</a> } |
| <a href=#81 id=81 data-nosnippet>81</a>} |
| <a href=#82 id=82 data-nosnippet>82</a> |
| <a href=#83 id=83 data-nosnippet>83</a><span class="kw">impl </span>From<MatchCollector> <span class="kw">for </span>SsrMatches { |
| <a href=#84 id=84 data-nosnippet>84</a> <span class="kw">fn </span>from(<span class="kw-2">mut </span>match_collector: MatchCollector) -> <span class="self">Self </span>{ |
| <a href=#85 id=85 data-nosnippet>85</a> <span class="kw">let </span><span class="kw-2">mut </span>matches = SsrMatches::default(); |
| <a href=#86 id=86 data-nosnippet>86</a> <span class="kw">for </span>(<span class="kw">_</span>, m) <span class="kw">in </span>match_collector.matches_by_node.drain() { |
| <a href=#87 id=87 data-nosnippet>87</a> matches.matches.push(m); |
| <a href=#88 id=88 data-nosnippet>88</a> } |
| <a href=#89 id=89 data-nosnippet>89</a> matches.matches.sort_by(|a, b| { |
| <a href=#90 id=90 data-nosnippet>90</a> <span class="comment">// Order matches by file_id then by start range. This should be sufficient since ranges |
| <a href=#91 id=91 data-nosnippet>91</a> // shouldn't be overlapping. |
| <a href=#92 id=92 data-nosnippet>92</a> </span>a.range |
| <a href=#93 id=93 data-nosnippet>93</a> .file_id |
| <a href=#94 id=94 data-nosnippet>94</a> .cmp(<span class="kw-2">&</span>b.range.file_id) |
| <a href=#95 id=95 data-nosnippet>95</a> .then_with(|| a.range.range.start().cmp(<span class="kw-2">&</span>b.range.range.start())) |
| <a href=#96 id=96 data-nosnippet>96</a> }); |
| <a href=#97 id=97 data-nosnippet>97</a> matches |
| <a href=#98 id=98 data-nosnippet>98</a> } |
| <a href=#99 id=99 data-nosnippet>99</a>} |
| </code></pre></div></section></main></body></html> |
