| <!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-db/src/source_change.rs`."><title>source_change.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-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="ide_db" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.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-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.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_db/</div>source_change.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">//! This modules defines type to represent changes to the source code, that flow |
| <a href=#2 id=2 data-nosnippet>2</a>//! from the server to the client. |
| <a href=#3 id=3 data-nosnippet>3</a>//! |
| <a href=#4 id=4 data-nosnippet>4</a>//! It can be viewed as a dual for `Change`. |
| <a href=#5 id=5 data-nosnippet>5</a> |
| <a href=#6 id=6 data-nosnippet>6</a></span><span class="kw">use </span>std::{collections::hash_map::Entry, fmt, iter, mem}; |
| <a href=#7 id=7 data-nosnippet>7</a> |
| <a href=#8 id=8 data-nosnippet>8</a><span class="kw">use </span><span class="kw">crate</span>::imports::insert_use::{ImportScope, ImportScopeKind}; |
| <a href=#9 id=9 data-nosnippet>9</a><span class="kw">use </span><span class="kw">crate</span>::text_edit::{TextEdit, TextEditBuilder}; |
| <a href=#10 id=10 data-nosnippet>10</a><span class="kw">use crate</span>::{SnippetCap, assists::Command, syntax_helpers::tree_diff::diff}; |
| <a href=#11 id=11 data-nosnippet>11</a><span class="kw">use </span>base_db::AnchoredPathBuf; |
| <a href=#12 id=12 data-nosnippet>12</a><span class="kw">use </span>itertools::Itertools; |
| <a href=#13 id=13 data-nosnippet>13</a><span class="kw">use </span>macros::UpmapFromRaFixture; |
| <a href=#14 id=14 data-nosnippet>14</a><span class="kw">use </span>nohash_hasher::IntMap; |
| <a href=#15 id=15 data-nosnippet>15</a><span class="kw">use </span>rustc_hash::FxHashMap; |
| <a href=#16 id=16 data-nosnippet>16</a><span class="kw">use </span>span::FileId; |
| <a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>stdx::never; |
| <a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>syntax::{ |
| <a href=#19 id=19 data-nosnippet>19</a> AstNode, SyntaxElement, SyntaxNode, SyntaxNodePtr, SyntaxToken, TextRange, TextSize, |
| <a href=#20 id=20 data-nosnippet>20</a> syntax_editor::{SyntaxAnnotation, SyntaxEditor}, |
| <a href=#21 id=21 data-nosnippet>21</a>}; |
| <a href=#22 id=22 data-nosnippet>22</a> |
| <a href=#23 id=23 data-nosnippet>23</a><span class="doccomment">/// An annotation ID associated with an indel, to describe changes. |
| <a href=#24 id=24 data-nosnippet>24</a></span><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, UpmapFromRaFixture)] |
| <a href=#25 id=25 data-nosnippet>25</a></span><span class="kw">pub struct </span>ChangeAnnotationId(u32); |
| <a href=#26 id=26 data-nosnippet>26</a> |
| <a href=#27 id=27 data-nosnippet>27</a><span class="kw">impl </span>fmt::Display <span class="kw">for </span>ChangeAnnotationId { |
| <a href=#28 id=28 data-nosnippet>28</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <a href=#29 id=29 data-nosnippet>29</a> fmt::Display::fmt(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>, f) |
| <a href=#30 id=30 data-nosnippet>30</a> } |
| <a href=#31 id=31 data-nosnippet>31</a>} |
| <a href=#32 id=32 data-nosnippet>32</a> |
| <a href=#33 id=33 data-nosnippet>33</a><span class="attr">#[derive(Debug, Clone)] |
| <a href=#34 id=34 data-nosnippet>34</a></span><span class="kw">pub struct </span>ChangeAnnotation { |
| <a href=#35 id=35 data-nosnippet>35</a> <span class="kw">pub </span>label: String, |
| <a href=#36 id=36 data-nosnippet>36</a> <span class="kw">pub </span>needs_confirmation: bool, |
| <a href=#37 id=37 data-nosnippet>37</a> <span class="kw">pub </span>description: <span class="prelude-ty">Option</span><String>, |
| <a href=#38 id=38 data-nosnippet>38</a>} |
| <a href=#39 id=39 data-nosnippet>39</a> |
| <a href=#40 id=40 data-nosnippet>40</a><span class="attr">#[derive(Default, Debug, Clone)] |
| <a href=#41 id=41 data-nosnippet>41</a></span><span class="kw">pub struct </span>SourceChange { |
| <a href=#42 id=42 data-nosnippet>42</a> <span class="kw">pub </span>source_file_edits: IntMap<FileId, (TextEdit, <span class="prelude-ty">Option</span><SnippetEdit>)>, |
| <a href=#43 id=43 data-nosnippet>43</a> <span class="kw">pub </span>file_system_edits: Vec<FileSystemEdit>, |
| <a href=#44 id=44 data-nosnippet>44</a> <span class="kw">pub </span>is_snippet: bool, |
| <a href=#45 id=45 data-nosnippet>45</a> <span class="kw">pub </span>annotations: FxHashMap<ChangeAnnotationId, ChangeAnnotation>, |
| <a href=#46 id=46 data-nosnippet>46</a> next_annotation_id: u32, |
| <a href=#47 id=47 data-nosnippet>47</a>} |
| <a href=#48 id=48 data-nosnippet>48</a> |
| <a href=#49 id=49 data-nosnippet>49</a><span class="kw">impl </span>SourceChange { |
| <a href=#50 id=50 data-nosnippet>50</a> <span class="kw">pub fn </span>from_text_edit(file_id: <span class="kw">impl </span>Into<FileId>, edit: TextEdit) -> <span class="self">Self </span>{ |
| <a href=#51 id=51 data-nosnippet>51</a> SourceChange { |
| <a href=#52 id=52 data-nosnippet>52</a> source_file_edits: iter::once((file_id.into(), (edit, <span class="prelude-val">None</span>))).collect(), |
| <a href=#53 id=53 data-nosnippet>53</a> ..Default::default() |
| <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> |
| <a href=#57 id=57 data-nosnippet>57</a> <span class="kw">pub fn </span>insert_annotation(<span class="kw-2">&mut </span><span class="self">self</span>, annotation: ChangeAnnotation) -> ChangeAnnotationId { |
| <a href=#58 id=58 data-nosnippet>58</a> <span class="kw">let </span>id = ChangeAnnotationId(<span class="self">self</span>.next_annotation_id); |
| <a href=#59 id=59 data-nosnippet>59</a> <span class="self">self</span>.next_annotation_id += <span class="number">1</span>; |
| <a href=#60 id=60 data-nosnippet>60</a> <span class="self">self</span>.annotations.insert(id, annotation); |
| <a href=#61 id=61 data-nosnippet>61</a> id |
| <a href=#62 id=62 data-nosnippet>62</a> } |
| <a href=#63 id=63 data-nosnippet>63</a> |
| <a href=#64 id=64 data-nosnippet>64</a> <span class="doccomment">/// Inserts a [`TextEdit`] for the given [`FileId`]. This properly handles merging existing |
| <a href=#65 id=65 data-nosnippet>65</a> /// edits for a file if some already exist. |
| <a href=#66 id=66 data-nosnippet>66</a> </span><span class="kw">pub fn </span>insert_source_edit(<span class="kw-2">&mut </span><span class="self">self</span>, file_id: <span class="kw">impl </span>Into<FileId>, edit: TextEdit) { |
| <a href=#67 id=67 data-nosnippet>67</a> <span class="self">self</span>.insert_source_and_snippet_edit(file_id.into(), edit, <span class="prelude-val">None</span>) |
| <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> <span class="doccomment">/// Inserts a [`TextEdit`] and potentially a [`SnippetEdit`] for the given [`FileId`]. |
| <a href=#71 id=71 data-nosnippet>71</a> /// This properly handles merging existing edits for a file if some already exist. |
| <a href=#72 id=72 data-nosnippet>72</a> </span><span class="kw">pub fn </span>insert_source_and_snippet_edit( |
| <a href=#73 id=73 data-nosnippet>73</a> <span class="kw-2">&mut </span><span class="self">self</span>, |
| <a href=#74 id=74 data-nosnippet>74</a> file_id: <span class="kw">impl </span>Into<FileId>, |
| <a href=#75 id=75 data-nosnippet>75</a> edit: TextEdit, |
| <a href=#76 id=76 data-nosnippet>76</a> snippet_edit: <span class="prelude-ty">Option</span><SnippetEdit>, |
| <a href=#77 id=77 data-nosnippet>77</a> ) { |
| <a href=#78 id=78 data-nosnippet>78</a> <span class="kw">match </span><span class="self">self</span>.source_file_edits.entry(file_id.into()) { |
| <a href=#79 id=79 data-nosnippet>79</a> Entry::Occupied(<span class="kw-2">mut </span>entry) => { |
| <a href=#80 id=80 data-nosnippet>80</a> <span class="kw">let </span>value = entry.get_mut(); |
| <a href=#81 id=81 data-nosnippet>81</a> <span class="macro">never!</span>(value.<span class="number">0</span>.union(edit).is_err(), <span class="string">"overlapping edits for same file"</span>); |
| <a href=#82 id=82 data-nosnippet>82</a> <span class="macro">never!</span>( |
| <a href=#83 id=83 data-nosnippet>83</a> value.<span class="number">1</span>.is_some() && snippet_edit.is_some(), |
| <a href=#84 id=84 data-nosnippet>84</a> <span class="string">"overlapping snippet edits for same file" |
| <a href=#85 id=85 data-nosnippet>85</a> </span>); |
| <a href=#86 id=86 data-nosnippet>86</a> <span class="kw">if </span>value.<span class="number">1</span>.is_none() { |
| <a href=#87 id=87 data-nosnippet>87</a> value.<span class="number">1 </span>= snippet_edit; |
| <a href=#88 id=88 data-nosnippet>88</a> } |
| <a href=#89 id=89 data-nosnippet>89</a> } |
| <a href=#90 id=90 data-nosnippet>90</a> Entry::Vacant(entry) => { |
| <a href=#91 id=91 data-nosnippet>91</a> entry.insert((edit, snippet_edit)); |
| <a href=#92 id=92 data-nosnippet>92</a> } |
| <a href=#93 id=93 data-nosnippet>93</a> } |
| <a href=#94 id=94 data-nosnippet>94</a> } |
| <a href=#95 id=95 data-nosnippet>95</a> |
| <a href=#96 id=96 data-nosnippet>96</a> <span class="kw">pub fn </span>push_file_system_edit(<span class="kw-2">&mut </span><span class="self">self</span>, edit: FileSystemEdit) { |
| <a href=#97 id=97 data-nosnippet>97</a> <span class="self">self</span>.file_system_edits.push(edit); |
| <a href=#98 id=98 data-nosnippet>98</a> } |
| <a href=#99 id=99 data-nosnippet>99</a> |
| <a href=#100 id=100 data-nosnippet>100</a> <span class="kw">pub fn </span>get_source_and_snippet_edit( |
| <a href=#101 id=101 data-nosnippet>101</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#102 id=102 data-nosnippet>102</a> file_id: FileId, |
| <a href=#103 id=103 data-nosnippet>103</a> ) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>(TextEdit, <span class="prelude-ty">Option</span><SnippetEdit>)> { |
| <a href=#104 id=104 data-nosnippet>104</a> <span class="self">self</span>.source_file_edits.get(<span class="kw-2">&</span>file_id) |
| <a href=#105 id=105 data-nosnippet>105</a> } |
| <a href=#106 id=106 data-nosnippet>106</a> |
| <a href=#107 id=107 data-nosnippet>107</a> <span class="kw">pub fn </span>merge(<span class="kw-2">mut </span><span class="self">self</span>, other: SourceChange) -> SourceChange { |
| <a href=#108 id=108 data-nosnippet>108</a> <span class="self">self</span>.extend(other.source_file_edits); |
| <a href=#109 id=109 data-nosnippet>109</a> <span class="self">self</span>.extend(other.file_system_edits); |
| <a href=#110 id=110 data-nosnippet>110</a> <span class="self">self</span>.is_snippet |= other.is_snippet; |
| <a href=#111 id=111 data-nosnippet>111</a> <span class="self">self |
| <a href=#112 id=112 data-nosnippet>112</a> </span>} |
| <a href=#113 id=113 data-nosnippet>113</a>} |
| <a href=#114 id=114 data-nosnippet>114</a> |
| <a href=#115 id=115 data-nosnippet>115</a><span class="kw">impl </span>Extend<(FileId, TextEdit)> <span class="kw">for </span>SourceChange { |
| <a href=#116 id=116 data-nosnippet>116</a> <span class="kw">fn </span>extend<T: IntoIterator<Item = (FileId, TextEdit)>>(<span class="kw-2">&mut </span><span class="self">self</span>, iter: T) { |
| <a href=#117 id=117 data-nosnippet>117</a> <span class="self">self</span>.extend(iter.into_iter().map(|(file_id, edit)| (file_id, (edit, <span class="prelude-val">None</span>)))) |
| <a href=#118 id=118 data-nosnippet>118</a> } |
| <a href=#119 id=119 data-nosnippet>119</a>} |
| <a href=#120 id=120 data-nosnippet>120</a> |
| <a href=#121 id=121 data-nosnippet>121</a><span class="kw">impl </span>Extend<(FileId, (TextEdit, <span class="prelude-ty">Option</span><SnippetEdit>))> <span class="kw">for </span>SourceChange { |
| <a href=#122 id=122 data-nosnippet>122</a> <span class="kw">fn </span>extend<T: IntoIterator<Item = (FileId, (TextEdit, <span class="prelude-ty">Option</span><SnippetEdit>))>>( |
| <a href=#123 id=123 data-nosnippet>123</a> <span class="kw-2">&mut </span><span class="self">self</span>, |
| <a href=#124 id=124 data-nosnippet>124</a> iter: T, |
| <a href=#125 id=125 data-nosnippet>125</a> ) { |
| <a href=#126 id=126 data-nosnippet>126</a> iter.into_iter().for_each(|(file_id, (edit, snippet_edit))| { |
| <a href=#127 id=127 data-nosnippet>127</a> <span class="self">self</span>.insert_source_and_snippet_edit(file_id, edit, snippet_edit) |
| <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>} |
| <a href=#131 id=131 data-nosnippet>131</a> |
| <a href=#132 id=132 data-nosnippet>132</a><span class="kw">impl </span>Extend<FileSystemEdit> <span class="kw">for </span>SourceChange { |
| <a href=#133 id=133 data-nosnippet>133</a> <span class="kw">fn </span>extend<T: IntoIterator<Item = FileSystemEdit>>(<span class="kw-2">&mut </span><span class="self">self</span>, iter: T) { |
| <a href=#134 id=134 data-nosnippet>134</a> iter.into_iter().for_each(|edit| <span class="self">self</span>.push_file_system_edit(edit)); |
| <a href=#135 id=135 data-nosnippet>135</a> } |
| <a href=#136 id=136 data-nosnippet>136</a>} |
| <a href=#137 id=137 data-nosnippet>137</a> |
| <a href=#138 id=138 data-nosnippet>138</a><span class="kw">impl </span>From<IntMap<FileId, TextEdit>> <span class="kw">for </span>SourceChange { |
| <a href=#139 id=139 data-nosnippet>139</a> <span class="kw">fn </span>from(source_file_edits: IntMap<FileId, TextEdit>) -> SourceChange { |
| <a href=#140 id=140 data-nosnippet>140</a> <span class="kw">let </span>source_file_edits = |
| <a href=#141 id=141 data-nosnippet>141</a> source_file_edits.into_iter().map(|(file_id, edit)| (file_id, (edit, <span class="prelude-val">None</span>))).collect(); |
| <a href=#142 id=142 data-nosnippet>142</a> SourceChange { |
| <a href=#143 id=143 data-nosnippet>143</a> source_file_edits, |
| <a href=#144 id=144 data-nosnippet>144</a> file_system_edits: Vec::new(), |
| <a href=#145 id=145 data-nosnippet>145</a> is_snippet: <span class="bool-val">false</span>, |
| <a href=#146 id=146 data-nosnippet>146</a> ..SourceChange::default() |
| <a href=#147 id=147 data-nosnippet>147</a> } |
| <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">impl </span>FromIterator<(FileId, TextEdit)> <span class="kw">for </span>SourceChange { |
| <a href=#152 id=152 data-nosnippet>152</a> <span class="kw">fn </span>from_iter<T: IntoIterator<Item = (FileId, TextEdit)>>(iter: T) -> <span class="self">Self </span>{ |
| <a href=#153 id=153 data-nosnippet>153</a> <span class="kw">let </span><span class="kw-2">mut </span>this = SourceChange::default(); |
| <a href=#154 id=154 data-nosnippet>154</a> this.extend(iter); |
| <a href=#155 id=155 data-nosnippet>155</a> this |
| <a href=#156 id=156 data-nosnippet>156</a> } |
| <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><span class="attr">#[derive(Debug, Clone, PartialEq, Eq)] |
| <a href=#160 id=160 data-nosnippet>160</a></span><span class="kw">pub struct </span>SnippetEdit(Vec<(u32, TextRange)>); |
| <a href=#161 id=161 data-nosnippet>161</a> |
| <a href=#162 id=162 data-nosnippet>162</a><span class="kw">impl </span>SnippetEdit { |
| <a href=#163 id=163 data-nosnippet>163</a> <span class="kw">pub fn </span>new(snippets: Vec<Snippet>) -> <span class="self">Self </span>{ |
| <a href=#164 id=164 data-nosnippet>164</a> <span class="kw">let </span><span class="kw-2">mut </span>snippet_ranges = snippets |
| <a href=#165 id=165 data-nosnippet>165</a> .into_iter() |
| <a href=#166 id=166 data-nosnippet>166</a> .zip(<span class="number">1</span>..) |
| <a href=#167 id=167 data-nosnippet>167</a> .with_position() |
| <a href=#168 id=168 data-nosnippet>168</a> .flat_map(|pos| { |
| <a href=#169 id=169 data-nosnippet>169</a> <span class="kw">let </span>(snippet, index) = <span class="kw">match </span>pos { |
| <a href=#170 id=170 data-nosnippet>170</a> (itertools::Position::First, it) | (itertools::Position::Middle, it) => it, |
| <a href=#171 id=171 data-nosnippet>171</a> <span class="comment">// last/only snippet gets index 0 |
| <a href=#172 id=172 data-nosnippet>172</a> </span>(itertools::Position::Last, (snippet, <span class="kw">_</span>)) |
| <a href=#173 id=173 data-nosnippet>173</a> | (itertools::Position::Only, (snippet, <span class="kw">_</span>)) => (snippet, <span class="number">0</span>), |
| <a href=#174 id=174 data-nosnippet>174</a> }; |
| <a href=#175 id=175 data-nosnippet>175</a> |
| <a href=#176 id=176 data-nosnippet>176</a> <span class="kw">match </span>snippet { |
| <a href=#177 id=177 data-nosnippet>177</a> Snippet::Tabstop(pos) => <span class="macro">vec!</span>[(index, TextRange::empty(pos))], |
| <a href=#178 id=178 data-nosnippet>178</a> Snippet::Placeholder(range) => <span class="macro">vec!</span>[(index, range)], |
| <a href=#179 id=179 data-nosnippet>179</a> Snippet::PlaceholderGroup(ranges) => { |
| <a href=#180 id=180 data-nosnippet>180</a> ranges.into_iter().map(|range| (index, range)).collect() |
| <a href=#181 id=181 data-nosnippet>181</a> } |
| <a href=#182 id=182 data-nosnippet>182</a> } |
| <a href=#183 id=183 data-nosnippet>183</a> }) |
| <a href=#184 id=184 data-nosnippet>184</a> .collect_vec(); |
| <a href=#185 id=185 data-nosnippet>185</a> |
| <a href=#186 id=186 data-nosnippet>186</a> snippet_ranges.sort_by_key(|(<span class="kw">_</span>, range)| range.start()); |
| <a href=#187 id=187 data-nosnippet>187</a> |
| <a href=#188 id=188 data-nosnippet>188</a> <span class="comment">// Ensure that none of the ranges overlap |
| <a href=#189 id=189 data-nosnippet>189</a> </span><span class="kw">let </span>disjoint_ranges = snippet_ranges |
| <a href=#190 id=190 data-nosnippet>190</a> .iter() |
| <a href=#191 id=191 data-nosnippet>191</a> .zip(snippet_ranges.iter().skip(<span class="number">1</span>)) |
| <a href=#192 id=192 data-nosnippet>192</a> .all(|((<span class="kw">_</span>, left), (<span class="kw">_</span>, right))| left.end() <= right.start() || left == right); |
| <a href=#193 id=193 data-nosnippet>193</a> <span class="macro">stdx::always!</span>(disjoint_ranges); |
| <a href=#194 id=194 data-nosnippet>194</a> |
| <a href=#195 id=195 data-nosnippet>195</a> SnippetEdit(snippet_ranges) |
| <a href=#196 id=196 data-nosnippet>196</a> } |
| <a href=#197 id=197 data-nosnippet>197</a> |
| <a href=#198 id=198 data-nosnippet>198</a> <span class="doccomment">/// Inserts all of the snippets into the given text. |
| <a href=#199 id=199 data-nosnippet>199</a> </span><span class="kw">pub fn </span>apply(<span class="kw-2">&</span><span class="self">self</span>, text: <span class="kw-2">&mut </span>String) { |
| <a href=#200 id=200 data-nosnippet>200</a> <span class="comment">// Start from the back so that we don't have to adjust ranges |
| <a href=#201 id=201 data-nosnippet>201</a> </span><span class="kw">for </span>(index, range) <span class="kw">in </span><span class="self">self</span>.<span class="number">0</span>.iter().rev() { |
| <a href=#202 id=202 data-nosnippet>202</a> <span class="kw">if </span>range.is_empty() { |
| <a href=#203 id=203 data-nosnippet>203</a> <span class="comment">// is a tabstop |
| <a href=#204 id=204 data-nosnippet>204</a> </span>text.insert_str(range.start().into(), <span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">"${index}"</span>)); |
| <a href=#205 id=205 data-nosnippet>205</a> } <span class="kw">else </span>{ |
| <a href=#206 id=206 data-nosnippet>206</a> <span class="comment">// is a placeholder |
| <a href=#207 id=207 data-nosnippet>207</a> </span>text.insert(range.end().into(), <span class="string">'}'</span>); |
| <a href=#208 id=208 data-nosnippet>208</a> text.insert_str(range.start().into(), <span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">"${{{index}:"</span>)); |
| <a href=#209 id=209 data-nosnippet>209</a> } |
| <a href=#210 id=210 data-nosnippet>210</a> } |
| <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">/// Gets the underlying snippet index + text range |
| <a href=#214 id=214 data-nosnippet>214</a> /// Tabstops are represented by an empty range, and placeholders use the range that they were given |
| <a href=#215 id=215 data-nosnippet>215</a> </span><span class="kw">pub fn </span>into_edit_ranges(<span class="self">self</span>) -> Vec<(u32, TextRange)> { |
| <a href=#216 id=216 data-nosnippet>216</a> <span class="self">self</span>.<span class="number">0 |
| <a href=#217 id=217 data-nosnippet>217</a> </span>} |
| <a href=#218 id=218 data-nosnippet>218</a>} |
| <a href=#219 id=219 data-nosnippet>219</a> |
| <a href=#220 id=220 data-nosnippet>220</a><span class="kw">pub struct </span>SourceChangeBuilder { |
| <a href=#221 id=221 data-nosnippet>221</a> <span class="kw">pub </span>edit: TextEditBuilder, |
| <a href=#222 id=222 data-nosnippet>222</a> <span class="kw">pub </span>file_id: FileId, |
| <a href=#223 id=223 data-nosnippet>223</a> <span class="kw">pub </span>source_change: SourceChange, |
| <a href=#224 id=224 data-nosnippet>224</a> <span class="kw">pub </span>command: <span class="prelude-ty">Option</span><Command>, |
| <a href=#225 id=225 data-nosnippet>225</a> |
| <a href=#226 id=226 data-nosnippet>226</a> <span class="doccomment">/// Keeps track of all edits performed on each file |
| <a href=#227 id=227 data-nosnippet>227</a> </span><span class="kw">pub </span>file_editors: FxHashMap<FileId, SyntaxEditor>, |
| <a href=#228 id=228 data-nosnippet>228</a> <span class="doccomment">/// Keeps track of which annotations correspond to which snippets |
| <a href=#229 id=229 data-nosnippet>229</a> </span><span class="kw">pub </span>snippet_annotations: Vec<(AnnotationSnippet, SyntaxAnnotation)>, |
| <a href=#230 id=230 data-nosnippet>230</a> |
| <a href=#231 id=231 data-nosnippet>231</a> <span class="doccomment">/// Maps the original, immutable `SyntaxNode` to a `clone_for_update` twin. |
| <a href=#232 id=232 data-nosnippet>232</a> </span><span class="kw">pub </span>mutated_tree: <span class="prelude-ty">Option</span><TreeMutator>, |
| <a href=#233 id=233 data-nosnippet>233</a> <span class="doccomment">/// Keeps track of where to place snippets |
| <a href=#234 id=234 data-nosnippet>234</a> </span><span class="kw">pub </span>snippet_builder: <span class="prelude-ty">Option</span><SnippetBuilder>, |
| <a href=#235 id=235 data-nosnippet>235</a>} |
| <a href=#236 id=236 data-nosnippet>236</a> |
| <a href=#237 id=237 data-nosnippet>237</a><span class="kw">pub struct </span>TreeMutator { |
| <a href=#238 id=238 data-nosnippet>238</a> immutable: SyntaxNode, |
| <a href=#239 id=239 data-nosnippet>239</a> mutable_clone: SyntaxNode, |
| <a href=#240 id=240 data-nosnippet>240</a>} |
| <a href=#241 id=241 data-nosnippet>241</a> |
| <a href=#242 id=242 data-nosnippet>242</a><span class="attr">#[derive(Default)] |
| <a href=#243 id=243 data-nosnippet>243</a></span><span class="kw">pub struct </span>SnippetBuilder { |
| <a href=#244 id=244 data-nosnippet>244</a> <span class="doccomment">/// Where to place snippets at |
| <a href=#245 id=245 data-nosnippet>245</a> </span>places: Vec<PlaceSnippet>, |
| <a href=#246 id=246 data-nosnippet>246</a>} |
| <a href=#247 id=247 data-nosnippet>247</a> |
| <a href=#248 id=248 data-nosnippet>248</a><span class="kw">impl </span>TreeMutator { |
| <a href=#249 id=249 data-nosnippet>249</a> <span class="kw">pub fn </span>new(immutable: <span class="kw-2">&</span>SyntaxNode) -> TreeMutator { |
| <a href=#250 id=250 data-nosnippet>250</a> <span class="kw">let </span>immutable = immutable.ancestors().last().unwrap(); |
| <a href=#251 id=251 data-nosnippet>251</a> <span class="kw">let </span>mutable_clone = immutable.clone_for_update(); |
| <a href=#252 id=252 data-nosnippet>252</a> TreeMutator { immutable, mutable_clone } |
| <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">pub fn </span>make_mut<N: AstNode>(<span class="kw-2">&</span><span class="self">self</span>, node: <span class="kw-2">&</span>N) -> N { |
| <a href=#256 id=256 data-nosnippet>256</a> N::cast(<span class="self">self</span>.make_syntax_mut(node.syntax())).unwrap() |
| <a href=#257 id=257 data-nosnippet>257</a> } |
| <a href=#258 id=258 data-nosnippet>258</a> |
| <a href=#259 id=259 data-nosnippet>259</a> <span class="kw">pub fn </span>make_syntax_mut(<span class="kw-2">&</span><span class="self">self</span>, node: <span class="kw-2">&</span>SyntaxNode) -> SyntaxNode { |
| <a href=#260 id=260 data-nosnippet>260</a> <span class="kw">let </span>ptr = SyntaxNodePtr::new(node); |
| <a href=#261 id=261 data-nosnippet>261</a> ptr.to_node(<span class="kw-2">&</span><span class="self">self</span>.mutable_clone) |
| <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> |
| <a href=#265 id=265 data-nosnippet>265</a><span class="kw">impl </span>SourceChangeBuilder { |
| <a href=#266 id=266 data-nosnippet>266</a> <span class="kw">pub fn </span>new(file_id: <span class="kw">impl </span>Into<FileId>) -> SourceChangeBuilder { |
| <a href=#267 id=267 data-nosnippet>267</a> SourceChangeBuilder { |
| <a href=#268 id=268 data-nosnippet>268</a> edit: TextEdit::builder(), |
| <a href=#269 id=269 data-nosnippet>269</a> file_id: file_id.into(), |
| <a href=#270 id=270 data-nosnippet>270</a> source_change: SourceChange::default(), |
| <a href=#271 id=271 data-nosnippet>271</a> command: <span class="prelude-val">None</span>, |
| <a href=#272 id=272 data-nosnippet>272</a> file_editors: FxHashMap::default(), |
| <a href=#273 id=273 data-nosnippet>273</a> snippet_annotations: <span class="macro">vec!</span>[], |
| <a href=#274 id=274 data-nosnippet>274</a> mutated_tree: <span class="prelude-val">None</span>, |
| <a href=#275 id=275 data-nosnippet>275</a> snippet_builder: <span class="prelude-val">None</span>, |
| <a href=#276 id=276 data-nosnippet>276</a> } |
| <a href=#277 id=277 data-nosnippet>277</a> } |
| <a href=#278 id=278 data-nosnippet>278</a> |
| <a href=#279 id=279 data-nosnippet>279</a> <span class="kw">pub fn </span>edit_file(<span class="kw-2">&mut </span><span class="self">self</span>, file_id: <span class="kw">impl </span>Into<FileId>) { |
| <a href=#280 id=280 data-nosnippet>280</a> <span class="self">self</span>.commit(); |
| <a href=#281 id=281 data-nosnippet>281</a> <span class="self">self</span>.file_id = file_id.into(); |
| <a href=#282 id=282 data-nosnippet>282</a> } |
| <a href=#283 id=283 data-nosnippet>283</a> |
| <a href=#284 id=284 data-nosnippet>284</a> <span class="kw">pub fn </span>make_editor(<span class="kw-2">&</span><span class="self">self</span>, node: <span class="kw-2">&</span>SyntaxNode) -> SyntaxEditor { |
| <a href=#285 id=285 data-nosnippet>285</a> SyntaxEditor::new(node.ancestors().last().unwrap_or_else(|| node.clone())) |
| <a href=#286 id=286 data-nosnippet>286</a> } |
| <a href=#287 id=287 data-nosnippet>287</a> |
| <a href=#288 id=288 data-nosnippet>288</a> <span class="kw">pub fn </span>add_file_edits(<span class="kw-2">&mut </span><span class="self">self</span>, file_id: <span class="kw">impl </span>Into<FileId>, edit: SyntaxEditor) { |
| <a href=#289 id=289 data-nosnippet>289</a> <span class="kw">match </span><span class="self">self</span>.file_editors.entry(file_id.into()) { |
| <a href=#290 id=290 data-nosnippet>290</a> Entry::Occupied(<span class="kw-2">mut </span>entry) => entry.get_mut().merge(edit), |
| <a href=#291 id=291 data-nosnippet>291</a> Entry::Vacant(entry) => { |
| <a href=#292 id=292 data-nosnippet>292</a> entry.insert(edit); |
| <a href=#293 id=293 data-nosnippet>293</a> } |
| <a href=#294 id=294 data-nosnippet>294</a> } |
| <a href=#295 id=295 data-nosnippet>295</a> } |
| <a href=#296 id=296 data-nosnippet>296</a> |
| <a href=#297 id=297 data-nosnippet>297</a> <span class="kw">pub fn </span>make_placeholder_snippet(<span class="kw-2">&mut </span><span class="self">self</span>, _cap: SnippetCap) -> SyntaxAnnotation { |
| <a href=#298 id=298 data-nosnippet>298</a> <span class="self">self</span>.add_snippet_annotation(AnnotationSnippet::Over) |
| <a href=#299 id=299 data-nosnippet>299</a> } |
| <a href=#300 id=300 data-nosnippet>300</a> |
| <a href=#301 id=301 data-nosnippet>301</a> <span class="kw">pub fn </span>make_tabstop_before(<span class="kw-2">&mut </span><span class="self">self</span>, _cap: SnippetCap) -> SyntaxAnnotation { |
| <a href=#302 id=302 data-nosnippet>302</a> <span class="self">self</span>.add_snippet_annotation(AnnotationSnippet::Before) |
| <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 fn </span>make_tabstop_after(<span class="kw-2">&mut </span><span class="self">self</span>, _cap: SnippetCap) -> SyntaxAnnotation { |
| <a href=#306 id=306 data-nosnippet>306</a> <span class="self">self</span>.add_snippet_annotation(AnnotationSnippet::After) |
| <a href=#307 id=307 data-nosnippet>307</a> } |
| <a href=#308 id=308 data-nosnippet>308</a> |
| <a href=#309 id=309 data-nosnippet>309</a> <span class="kw">fn </span>commit(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <a href=#310 id=310 data-nosnippet>310</a> <span class="comment">// Apply syntax editor edits |
| <a href=#311 id=311 data-nosnippet>311</a> </span><span class="kw">for </span>(file_id, editor) <span class="kw">in </span>mem::take(<span class="kw-2">&mut </span><span class="self">self</span>.file_editors) { |
| <a href=#312 id=312 data-nosnippet>312</a> <span class="kw">let </span>edit_result = editor.finish(); |
| <a href=#313 id=313 data-nosnippet>313</a> <span class="kw">let </span><span class="kw-2">mut </span>snippet_edit = <span class="macro">vec!</span>[]; |
| <a href=#314 id=314 data-nosnippet>314</a> |
| <a href=#315 id=315 data-nosnippet>315</a> <span class="comment">// Find snippet edits |
| <a href=#316 id=316 data-nosnippet>316</a> </span><span class="kw">for </span>(kind, annotation) <span class="kw">in </span><span class="kw-2">&</span><span class="self">self</span>.snippet_annotations { |
| <a href=#317 id=317 data-nosnippet>317</a> <span class="kw">let </span>elements = edit_result.find_annotation(<span class="kw-2">*</span>annotation); |
| <a href=#318 id=318 data-nosnippet>318</a> |
| <a href=#319 id=319 data-nosnippet>319</a> <span class="kw">let </span>snippet = <span class="kw">match </span>(kind, elements) { |
| <a href=#320 id=320 data-nosnippet>320</a> (AnnotationSnippet::Before, [element]) => { |
| <a href=#321 id=321 data-nosnippet>321</a> Snippet::Tabstop(element.text_range().start()) |
| <a href=#322 id=322 data-nosnippet>322</a> } |
| <a href=#323 id=323 data-nosnippet>323</a> (AnnotationSnippet::After, [element]) => { |
| <a href=#324 id=324 data-nosnippet>324</a> Snippet::Tabstop(element.text_range().end()) |
| <a href=#325 id=325 data-nosnippet>325</a> } |
| <a href=#326 id=326 data-nosnippet>326</a> (AnnotationSnippet::Over, [element]) => { |
| <a href=#327 id=327 data-nosnippet>327</a> Snippet::Placeholder(element.text_range()) |
| <a href=#328 id=328 data-nosnippet>328</a> } |
| <a href=#329 id=329 data-nosnippet>329</a> (AnnotationSnippet::Over, elements) <span class="kw">if </span>!elements.is_empty() => { |
| <a href=#330 id=330 data-nosnippet>330</a> Snippet::PlaceholderGroup( |
| <a href=#331 id=331 data-nosnippet>331</a> elements.iter().map(|it| it.text_range()).collect(), |
| <a href=#332 id=332 data-nosnippet>332</a> ) |
| <a href=#333 id=333 data-nosnippet>333</a> } |
| <a href=#334 id=334 data-nosnippet>334</a> <span class="kw">_ </span>=> <span class="kw">continue</span>, |
| <a href=#335 id=335 data-nosnippet>335</a> }; |
| <a href=#336 id=336 data-nosnippet>336</a> |
| <a href=#337 id=337 data-nosnippet>337</a> snippet_edit.push(snippet); |
| <a href=#338 id=338 data-nosnippet>338</a> } |
| <a href=#339 id=339 data-nosnippet>339</a> |
| <a href=#340 id=340 data-nosnippet>340</a> <span class="kw">let </span><span class="kw-2">mut </span>edit = TextEdit::builder(); |
| <a href=#341 id=341 data-nosnippet>341</a> diff(edit_result.old_root(), edit_result.new_root()).into_text_edit(<span class="kw-2">&mut </span>edit); |
| <a href=#342 id=342 data-nosnippet>342</a> <span class="kw">let </span>edit = edit.finish(); |
| <a href=#343 id=343 data-nosnippet>343</a> |
| <a href=#344 id=344 data-nosnippet>344</a> <span class="kw">let </span>snippet_edit = |
| <a href=#345 id=345 data-nosnippet>345</a> <span class="kw">if </span>!snippet_edit.is_empty() { <span class="prelude-val">Some</span>(SnippetEdit::new(snippet_edit)) } <span class="kw">else </span>{ <span class="prelude-val">None </span>}; |
| <a href=#346 id=346 data-nosnippet>346</a> |
| <a href=#347 id=347 data-nosnippet>347</a> <span class="kw">if </span>!edit.is_empty() || snippet_edit.is_some() { |
| <a href=#348 id=348 data-nosnippet>348</a> <span class="self">self</span>.source_change.insert_source_and_snippet_edit(file_id, edit, snippet_edit); |
| <a href=#349 id=349 data-nosnippet>349</a> } |
| <a href=#350 id=350 data-nosnippet>350</a> } |
| <a href=#351 id=351 data-nosnippet>351</a> |
| <a href=#352 id=352 data-nosnippet>352</a> <span class="comment">// Apply mutable edits |
| <a href=#353 id=353 data-nosnippet>353</a> </span><span class="kw">let </span>snippet_edit = <span class="self">self</span>.snippet_builder.take().map(|builder| { |
| <a href=#354 id=354 data-nosnippet>354</a> SnippetEdit::new( |
| <a href=#355 id=355 data-nosnippet>355</a> builder.places.into_iter().flat_map(PlaceSnippet::finalize_position).collect(), |
| <a href=#356 id=356 data-nosnippet>356</a> ) |
| <a href=#357 id=357 data-nosnippet>357</a> }); |
| <a href=#358 id=358 data-nosnippet>358</a> |
| <a href=#359 id=359 data-nosnippet>359</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(tm) = <span class="self">self</span>.mutated_tree.take() { |
| <a href=#360 id=360 data-nosnippet>360</a> diff(<span class="kw-2">&</span>tm.immutable, <span class="kw-2">&</span>tm.mutable_clone).into_text_edit(<span class="kw-2">&mut </span><span class="self">self</span>.edit); |
| <a href=#361 id=361 data-nosnippet>361</a> } |
| <a href=#362 id=362 data-nosnippet>362</a> |
| <a href=#363 id=363 data-nosnippet>363</a> <span class="kw">let </span>edit = mem::take(<span class="kw-2">&mut </span><span class="self">self</span>.edit).finish(); |
| <a href=#364 id=364 data-nosnippet>364</a> <span class="kw">if </span>!edit.is_empty() || snippet_edit.is_some() { |
| <a href=#365 id=365 data-nosnippet>365</a> <span class="self">self</span>.source_change.insert_source_and_snippet_edit(<span class="self">self</span>.file_id, edit, snippet_edit); |
| <a href=#366 id=366 data-nosnippet>366</a> } |
| <a href=#367 id=367 data-nosnippet>367</a> } |
| <a href=#368 id=368 data-nosnippet>368</a> |
| <a href=#369 id=369 data-nosnippet>369</a> <span class="kw">pub fn </span>make_mut<N: AstNode>(<span class="kw-2">&mut </span><span class="self">self</span>, node: N) -> N { |
| <a href=#370 id=370 data-nosnippet>370</a> <span class="self">self</span>.mutated_tree.get_or_insert_with(|| TreeMutator::new(node.syntax())).make_mut(<span class="kw-2">&</span>node) |
| <a href=#371 id=371 data-nosnippet>371</a> } |
| <a href=#372 id=372 data-nosnippet>372</a> |
| <a href=#373 id=373 data-nosnippet>373</a> <span class="kw">pub fn </span>make_import_scope_mut(<span class="kw-2">&mut </span><span class="self">self</span>, scope: ImportScope) -> ImportScope { |
| <a href=#374 id=374 data-nosnippet>374</a> ImportScope { |
| <a href=#375 id=375 data-nosnippet>375</a> kind: <span class="kw">match </span>scope.kind.clone() { |
| <a href=#376 id=376 data-nosnippet>376</a> ImportScopeKind::File(it) => ImportScopeKind::File(<span class="self">self</span>.make_mut(it)), |
| <a href=#377 id=377 data-nosnippet>377</a> ImportScopeKind::Module(it) => ImportScopeKind::Module(<span class="self">self</span>.make_mut(it)), |
| <a href=#378 id=378 data-nosnippet>378</a> ImportScopeKind::Block(it) => ImportScopeKind::Block(<span class="self">self</span>.make_mut(it)), |
| <a href=#379 id=379 data-nosnippet>379</a> }, |
| <a href=#380 id=380 data-nosnippet>380</a> required_cfgs: scope.required_cfgs.iter().map(|it| <span class="self">self</span>.make_mut(it.clone())).collect(), |
| <a href=#381 id=381 data-nosnippet>381</a> } |
| <a href=#382 id=382 data-nosnippet>382</a> } |
| <a href=#383 id=383 data-nosnippet>383</a> <span class="doccomment">/// Returns a copy of the `node`, suitable for mutation. |
| <a href=#384 id=384 data-nosnippet>384</a> /// |
| <a href=#385 id=385 data-nosnippet>385</a> /// Syntax trees in rust-analyzer are typically immutable, and mutating |
| <a href=#386 id=386 data-nosnippet>386</a> /// operations panic at runtime. However, it is possible to make a copy of |
| <a href=#387 id=387 data-nosnippet>387</a> /// the tree and mutate the copy freely. Mutation is based on interior |
| <a href=#388 id=388 data-nosnippet>388</a> /// mutability, and different nodes in the same tree see the same mutations. |
| <a href=#389 id=389 data-nosnippet>389</a> /// |
| <a href=#390 id=390 data-nosnippet>390</a> /// The typical pattern for an assist is to find specific nodes in the read |
| <a href=#391 id=391 data-nosnippet>391</a> /// phase, and then get their mutable counterparts using `make_mut` in the |
| <a href=#392 id=392 data-nosnippet>392</a> /// mutable state. |
| <a href=#393 id=393 data-nosnippet>393</a> </span><span class="kw">pub fn </span>make_syntax_mut(<span class="kw-2">&mut </span><span class="self">self</span>, node: SyntaxNode) -> SyntaxNode { |
| <a href=#394 id=394 data-nosnippet>394</a> <span class="self">self</span>.mutated_tree.get_or_insert_with(|| TreeMutator::new(<span class="kw-2">&</span>node)).make_syntax_mut(<span class="kw-2">&</span>node) |
| <a href=#395 id=395 data-nosnippet>395</a> } |
| <a href=#396 id=396 data-nosnippet>396</a> |
| <a href=#397 id=397 data-nosnippet>397</a> <span class="doccomment">/// Remove specified `range` of text. |
| <a href=#398 id=398 data-nosnippet>398</a> </span><span class="kw">pub fn </span>delete(<span class="kw-2">&mut </span><span class="self">self</span>, range: TextRange) { |
| <a href=#399 id=399 data-nosnippet>399</a> <span class="self">self</span>.edit.delete(range) |
| <a href=#400 id=400 data-nosnippet>400</a> } |
| <a href=#401 id=401 data-nosnippet>401</a> <span class="doccomment">/// Append specified `text` at the given `offset` |
| <a href=#402 id=402 data-nosnippet>402</a> </span><span class="kw">pub fn </span>insert(<span class="kw-2">&mut </span><span class="self">self</span>, offset: TextSize, text: <span class="kw">impl </span>Into<String>) { |
| <a href=#403 id=403 data-nosnippet>403</a> <span class="self">self</span>.edit.insert(offset, text.into()) |
| <a href=#404 id=404 data-nosnippet>404</a> } |
| <a href=#405 id=405 data-nosnippet>405</a> <span class="doccomment">/// Replaces specified `range` of text with a given string. |
| <a href=#406 id=406 data-nosnippet>406</a> </span><span class="kw">pub fn </span>replace(<span class="kw-2">&mut </span><span class="self">self</span>, range: TextRange, replace_with: <span class="kw">impl </span>Into<String>) { |
| <a href=#407 id=407 data-nosnippet>407</a> <span class="self">self</span>.edit.replace(range, replace_with.into()) |
| <a href=#408 id=408 data-nosnippet>408</a> } |
| <a href=#409 id=409 data-nosnippet>409</a> <span class="kw">pub fn </span>replace_ast<N: AstNode>(<span class="kw-2">&mut </span><span class="self">self</span>, old: N, new: N) { |
| <a href=#410 id=410 data-nosnippet>410</a> diff(old.syntax(), new.syntax()).into_text_edit(<span class="kw-2">&mut </span><span class="self">self</span>.edit) |
| <a href=#411 id=411 data-nosnippet>411</a> } |
| <a href=#412 id=412 data-nosnippet>412</a> <span class="kw">pub fn </span>create_file(<span class="kw-2">&mut </span><span class="self">self</span>, dst: AnchoredPathBuf, content: <span class="kw">impl </span>Into<String>) { |
| <a href=#413 id=413 data-nosnippet>413</a> <span class="kw">let </span>file_system_edit = FileSystemEdit::CreateFile { dst, initial_contents: content.into() }; |
| <a href=#414 id=414 data-nosnippet>414</a> <span class="self">self</span>.source_change.push_file_system_edit(file_system_edit); |
| <a href=#415 id=415 data-nosnippet>415</a> } |
| <a href=#416 id=416 data-nosnippet>416</a> <span class="kw">pub fn </span>move_file(<span class="kw-2">&mut </span><span class="self">self</span>, src: <span class="kw">impl </span>Into<FileId>, dst: AnchoredPathBuf) { |
| <a href=#417 id=417 data-nosnippet>417</a> <span class="kw">let </span>file_system_edit = FileSystemEdit::MoveFile { src: src.into(), dst }; |
| <a href=#418 id=418 data-nosnippet>418</a> <span class="self">self</span>.source_change.push_file_system_edit(file_system_edit); |
| <a href=#419 id=419 data-nosnippet>419</a> } |
| <a href=#420 id=420 data-nosnippet>420</a> |
| <a href=#421 id=421 data-nosnippet>421</a> <span class="doccomment">/// Triggers the parameter hint popup after the assist is applied |
| <a href=#422 id=422 data-nosnippet>422</a> </span><span class="kw">pub fn </span>trigger_parameter_hints(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <a href=#423 id=423 data-nosnippet>423</a> <span class="self">self</span>.command = <span class="prelude-val">Some</span>(Command::TriggerParameterHints); |
| <a href=#424 id=424 data-nosnippet>424</a> } |
| <a href=#425 id=425 data-nosnippet>425</a> |
| <a href=#426 id=426 data-nosnippet>426</a> <span class="doccomment">/// Renames the item at the cursor position after the assist is applied |
| <a href=#427 id=427 data-nosnippet>427</a> </span><span class="kw">pub fn </span>rename(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <a href=#428 id=428 data-nosnippet>428</a> <span class="self">self</span>.command = <span class="prelude-val">Some</span>(Command::Rename); |
| <a href=#429 id=429 data-nosnippet>429</a> } |
| <a href=#430 id=430 data-nosnippet>430</a> |
| <a href=#431 id=431 data-nosnippet>431</a> <span class="doccomment">/// Adds a tabstop snippet to place the cursor before `node` |
| <a href=#432 id=432 data-nosnippet>432</a> </span><span class="kw">pub fn </span>add_tabstop_before(<span class="kw-2">&mut </span><span class="self">self</span>, _cap: SnippetCap, node: <span class="kw">impl </span>AstNode) { |
| <a href=#433 id=433 data-nosnippet>433</a> <span class="macro">assert!</span>(node.syntax().parent().is_some()); |
| <a href=#434 id=434 data-nosnippet>434</a> <span class="self">self</span>.add_snippet(PlaceSnippet::Before(node.syntax().clone().into())); |
| <a href=#435 id=435 data-nosnippet>435</a> } |
| <a href=#436 id=436 data-nosnippet>436</a> |
| <a href=#437 id=437 data-nosnippet>437</a> <span class="doccomment">/// Adds a tabstop snippet to place the cursor after `node` |
| <a href=#438 id=438 data-nosnippet>438</a> </span><span class="kw">pub fn </span>add_tabstop_after(<span class="kw-2">&mut </span><span class="self">self</span>, _cap: SnippetCap, node: <span class="kw">impl </span>AstNode) { |
| <a href=#439 id=439 data-nosnippet>439</a> <span class="macro">assert!</span>(node.syntax().parent().is_some()); |
| <a href=#440 id=440 data-nosnippet>440</a> <span class="self">self</span>.add_snippet(PlaceSnippet::After(node.syntax().clone().into())); |
| <a href=#441 id=441 data-nosnippet>441</a> } |
| <a href=#442 id=442 data-nosnippet>442</a> |
| <a href=#443 id=443 data-nosnippet>443</a> <span class="doccomment">/// Adds a tabstop snippet to place the cursor before `token` |
| <a href=#444 id=444 data-nosnippet>444</a> </span><span class="kw">pub fn </span>add_tabstop_before_token(<span class="kw-2">&mut </span><span class="self">self</span>, _cap: SnippetCap, token: SyntaxToken) { |
| <a href=#445 id=445 data-nosnippet>445</a> <span class="macro">assert!</span>(token.parent().is_some()); |
| <a href=#446 id=446 data-nosnippet>446</a> <span class="self">self</span>.add_snippet(PlaceSnippet::Before(token.into())); |
| <a href=#447 id=447 data-nosnippet>447</a> } |
| <a href=#448 id=448 data-nosnippet>448</a> |
| <a href=#449 id=449 data-nosnippet>449</a> <span class="doccomment">/// Adds a tabstop snippet to place the cursor after `token` |
| <a href=#450 id=450 data-nosnippet>450</a> </span><span class="kw">pub fn </span>add_tabstop_after_token(<span class="kw-2">&mut </span><span class="self">self</span>, _cap: SnippetCap, token: SyntaxToken) { |
| <a href=#451 id=451 data-nosnippet>451</a> <span class="macro">assert!</span>(token.parent().is_some()); |
| <a href=#452 id=452 data-nosnippet>452</a> <span class="self">self</span>.add_snippet(PlaceSnippet::After(token.into())); |
| <a href=#453 id=453 data-nosnippet>453</a> } |
| <a href=#454 id=454 data-nosnippet>454</a> |
| <a href=#455 id=455 data-nosnippet>455</a> <span class="doccomment">/// Adds a snippet to move the cursor selected over `node` |
| <a href=#456 id=456 data-nosnippet>456</a> </span><span class="kw">pub fn </span>add_placeholder_snippet(<span class="kw-2">&mut </span><span class="self">self</span>, _cap: SnippetCap, node: <span class="kw">impl </span>AstNode) { |
| <a href=#457 id=457 data-nosnippet>457</a> <span class="macro">assert!</span>(node.syntax().parent().is_some()); |
| <a href=#458 id=458 data-nosnippet>458</a> <span class="self">self</span>.add_snippet(PlaceSnippet::Over(node.syntax().clone().into())) |
| <a href=#459 id=459 data-nosnippet>459</a> } |
| <a href=#460 id=460 data-nosnippet>460</a> |
| <a href=#461 id=461 data-nosnippet>461</a> <span class="doccomment">/// Adds a snippet to move the cursor selected over `token` |
| <a href=#462 id=462 data-nosnippet>462</a> </span><span class="kw">pub fn </span>add_placeholder_snippet_token(<span class="kw-2">&mut </span><span class="self">self</span>, _cap: SnippetCap, token: SyntaxToken) { |
| <a href=#463 id=463 data-nosnippet>463</a> <span class="macro">assert!</span>(token.parent().is_some()); |
| <a href=#464 id=464 data-nosnippet>464</a> <span class="self">self</span>.add_snippet(PlaceSnippet::Over(token.into())) |
| <a href=#465 id=465 data-nosnippet>465</a> } |
| <a href=#466 id=466 data-nosnippet>466</a> |
| <a href=#467 id=467 data-nosnippet>467</a> <span class="doccomment">/// Adds a snippet to move the cursor selected over `nodes` |
| <a href=#468 id=468 data-nosnippet>468</a> /// |
| <a href=#469 id=469 data-nosnippet>469</a> /// This allows for renaming newly generated items without having to go |
| <a href=#470 id=470 data-nosnippet>470</a> /// through a separate rename step. |
| <a href=#471 id=471 data-nosnippet>471</a> </span><span class="kw">pub fn </span>add_placeholder_snippet_group(<span class="kw-2">&mut </span><span class="self">self</span>, _cap: SnippetCap, nodes: Vec<SyntaxNode>) { |
| <a href=#472 id=472 data-nosnippet>472</a> <span class="macro">assert!</span>(nodes.iter().all(|node| node.parent().is_some())); |
| <a href=#473 id=473 data-nosnippet>473</a> <span class="self">self</span>.add_snippet(PlaceSnippet::OverGroup( |
| <a href=#474 id=474 data-nosnippet>474</a> nodes.into_iter().map(|node| node.into()).collect(), |
| <a href=#475 id=475 data-nosnippet>475</a> )) |
| <a href=#476 id=476 data-nosnippet>476</a> } |
| <a href=#477 id=477 data-nosnippet>477</a> |
| <a href=#478 id=478 data-nosnippet>478</a> <span class="kw">fn </span>add_snippet(<span class="kw-2">&mut </span><span class="self">self</span>, snippet: PlaceSnippet) { |
| <a href=#479 id=479 data-nosnippet>479</a> <span class="kw">let </span>snippet_builder = <span class="self">self</span>.snippet_builder.get_or_insert(SnippetBuilder { places: <span class="macro">vec!</span>[] }); |
| <a href=#480 id=480 data-nosnippet>480</a> snippet_builder.places.push(snippet); |
| <a href=#481 id=481 data-nosnippet>481</a> <span class="self">self</span>.source_change.is_snippet = <span class="bool-val">true</span>; |
| <a href=#482 id=482 data-nosnippet>482</a> } |
| <a href=#483 id=483 data-nosnippet>483</a> |
| <a href=#484 id=484 data-nosnippet>484</a> <span class="kw">fn </span>add_snippet_annotation(<span class="kw-2">&mut </span><span class="self">self</span>, kind: AnnotationSnippet) -> SyntaxAnnotation { |
| <a href=#485 id=485 data-nosnippet>485</a> <span class="kw">let </span>annotation = SyntaxAnnotation::default(); |
| <a href=#486 id=486 data-nosnippet>486</a> <span class="self">self</span>.snippet_annotations.push((kind, annotation)); |
| <a href=#487 id=487 data-nosnippet>487</a> <span class="self">self</span>.source_change.is_snippet = <span class="bool-val">true</span>; |
| <a href=#488 id=488 data-nosnippet>488</a> annotation |
| <a href=#489 id=489 data-nosnippet>489</a> } |
| <a href=#490 id=490 data-nosnippet>490</a> |
| <a href=#491 id=491 data-nosnippet>491</a> <span class="kw">pub fn </span>finish(<span class="kw-2">mut </span><span class="self">self</span>) -> SourceChange { |
| <a href=#492 id=492 data-nosnippet>492</a> <span class="self">self</span>.commit(); |
| <a href=#493 id=493 data-nosnippet>493</a> |
| <a href=#494 id=494 data-nosnippet>494</a> <span class="comment">// Only one file can have snippet edits |
| <a href=#495 id=495 data-nosnippet>495</a> </span><span class="macro">stdx::never!</span>( |
| <a href=#496 id=496 data-nosnippet>496</a> <span class="self">self</span>.source_change |
| <a href=#497 id=497 data-nosnippet>497</a> .source_file_edits |
| <a href=#498 id=498 data-nosnippet>498</a> .iter() |
| <a href=#499 id=499 data-nosnippet>499</a> .filter(|(<span class="kw">_</span>, (<span class="kw">_</span>, snippet_edit))| snippet_edit.is_some()) |
| <a href=#500 id=500 data-nosnippet>500</a> .at_most_one() |
| <a href=#501 id=501 data-nosnippet>501</a> .is_err() |
| <a href=#502 id=502 data-nosnippet>502</a> ); |
| <a href=#503 id=503 data-nosnippet>503</a> |
| <a href=#504 id=504 data-nosnippet>504</a> mem::take(<span class="kw-2">&mut </span><span class="self">self</span>.source_change) |
| <a href=#505 id=505 data-nosnippet>505</a> } |
| <a href=#506 id=506 data-nosnippet>506</a>} |
| <a href=#507 id=507 data-nosnippet>507</a> |
| <a href=#508 id=508 data-nosnippet>508</a><span class="attr">#[derive(Debug, Clone)] |
| <a href=#509 id=509 data-nosnippet>509</a></span><span class="kw">pub enum </span>FileSystemEdit { |
| <a href=#510 id=510 data-nosnippet>510</a> CreateFile { dst: AnchoredPathBuf, initial_contents: String }, |
| <a href=#511 id=511 data-nosnippet>511</a> MoveFile { src: FileId, dst: AnchoredPathBuf }, |
| <a href=#512 id=512 data-nosnippet>512</a> MoveDir { src: AnchoredPathBuf, src_id: FileId, dst: AnchoredPathBuf }, |
| <a href=#513 id=513 data-nosnippet>513</a>} |
| <a href=#514 id=514 data-nosnippet>514</a> |
| <a href=#515 id=515 data-nosnippet>515</a><span class="kw">impl </span>From<FileSystemEdit> <span class="kw">for </span>SourceChange { |
| <a href=#516 id=516 data-nosnippet>516</a> <span class="kw">fn </span>from(edit: FileSystemEdit) -> SourceChange { |
| <a href=#517 id=517 data-nosnippet>517</a> SourceChange { |
| <a href=#518 id=518 data-nosnippet>518</a> source_file_edits: Default::default(), |
| <a href=#519 id=519 data-nosnippet>519</a> file_system_edits: <span class="macro">vec!</span>[edit], |
| <a href=#520 id=520 data-nosnippet>520</a> is_snippet: <span class="bool-val">false</span>, |
| <a href=#521 id=521 data-nosnippet>521</a> ..SourceChange::default() |
| <a href=#522 id=522 data-nosnippet>522</a> } |
| <a href=#523 id=523 data-nosnippet>523</a> } |
| <a href=#524 id=524 data-nosnippet>524</a>} |
| <a href=#525 id=525 data-nosnippet>525</a> |
| <a href=#526 id=526 data-nosnippet>526</a><span class="kw">pub enum </span>Snippet { |
| <a href=#527 id=527 data-nosnippet>527</a> <span class="doccomment">/// A tabstop snippet (e.g. `$0`). |
| <a href=#528 id=528 data-nosnippet>528</a> </span>Tabstop(TextSize), |
| <a href=#529 id=529 data-nosnippet>529</a> <span class="doccomment">/// A placeholder snippet (e.g. `${0:placeholder}`). |
| <a href=#530 id=530 data-nosnippet>530</a> </span>Placeholder(TextRange), |
| <a href=#531 id=531 data-nosnippet>531</a> <span class="doccomment">/// A group of placeholder snippets, e.g. |
| <a href=#532 id=532 data-nosnippet>532</a> /// |
| <a href=#533 id=533 data-nosnippet>533</a> /// ```ignore |
| <a href=#534 id=534 data-nosnippet>534</a> /// let ${0:new_var} = 4; |
| <a href=#535 id=535 data-nosnippet>535</a> /// fun(1, 2, 3, ${0:new_var}); |
| <a href=#536 id=536 data-nosnippet>536</a> /// ``` |
| <a href=#537 id=537 data-nosnippet>537</a> </span>PlaceholderGroup(Vec<TextRange>), |
| <a href=#538 id=538 data-nosnippet>538</a>} |
| <a href=#539 id=539 data-nosnippet>539</a> |
| <a href=#540 id=540 data-nosnippet>540</a><span class="kw">pub enum </span>AnnotationSnippet { |
| <a href=#541 id=541 data-nosnippet>541</a> <span class="doccomment">/// Place a tabstop before an element |
| <a href=#542 id=542 data-nosnippet>542</a> </span>Before, |
| <a href=#543 id=543 data-nosnippet>543</a> <span class="doccomment">/// Place a tabstop before an element |
| <a href=#544 id=544 data-nosnippet>544</a> </span>After, |
| <a href=#545 id=545 data-nosnippet>545</a> <span class="doccomment">/// Place a placeholder snippet in place of the element(s) |
| <a href=#546 id=546 data-nosnippet>546</a> </span>Over, |
| <a href=#547 id=547 data-nosnippet>547</a>} |
| <a href=#548 id=548 data-nosnippet>548</a> |
| <a href=#549 id=549 data-nosnippet>549</a><span class="kw">enum </span>PlaceSnippet { |
| <a href=#550 id=550 data-nosnippet>550</a> <span class="doccomment">/// Place a tabstop before an element |
| <a href=#551 id=551 data-nosnippet>551</a> </span>Before(SyntaxElement), |
| <a href=#552 id=552 data-nosnippet>552</a> <span class="doccomment">/// Place a tabstop before an element |
| <a href=#553 id=553 data-nosnippet>553</a> </span>After(SyntaxElement), |
| <a href=#554 id=554 data-nosnippet>554</a> <span class="doccomment">/// Place a placeholder snippet in place of the element |
| <a href=#555 id=555 data-nosnippet>555</a> </span>Over(SyntaxElement), |
| <a href=#556 id=556 data-nosnippet>556</a> <span class="doccomment">/// Place a group of placeholder snippets which are linked together |
| <a href=#557 id=557 data-nosnippet>557</a> /// in place of the elements |
| <a href=#558 id=558 data-nosnippet>558</a> </span>OverGroup(Vec<SyntaxElement>), |
| <a href=#559 id=559 data-nosnippet>559</a>} |
| <a href=#560 id=560 data-nosnippet>560</a> |
| <a href=#561 id=561 data-nosnippet>561</a><span class="kw">impl </span>PlaceSnippet { |
| <a href=#562 id=562 data-nosnippet>562</a> <span class="kw">fn </span>finalize_position(<span class="self">self</span>) -> Vec<Snippet> { |
| <a href=#563 id=563 data-nosnippet>563</a> <span class="kw">match </span><span class="self">self </span>{ |
| <a href=#564 id=564 data-nosnippet>564</a> PlaceSnippet::Before(it) => <span class="macro">vec!</span>[Snippet::Tabstop(it.text_range().start())], |
| <a href=#565 id=565 data-nosnippet>565</a> PlaceSnippet::After(it) => <span class="macro">vec!</span>[Snippet::Tabstop(it.text_range().end())], |
| <a href=#566 id=566 data-nosnippet>566</a> PlaceSnippet::Over(it) => <span class="macro">vec!</span>[Snippet::Placeholder(it.text_range())], |
| <a href=#567 id=567 data-nosnippet>567</a> PlaceSnippet::OverGroup(it) => { |
| <a href=#568 id=568 data-nosnippet>568</a> <span class="macro">vec!</span>[Snippet::PlaceholderGroup(it.into_iter().map(|it| it.text_range()).collect())] |
| <a href=#569 id=569 data-nosnippet>569</a> } |
| <a href=#570 id=570 data-nosnippet>570</a> } |
| <a href=#571 id=571 data-nosnippet>571</a> } |
| <a href=#572 id=572 data-nosnippet>572</a>}</code></pre></div></section></main></body></html> |
