blob: cd05c27538406afba6a13eabe65965bf7725f34c [file] [log] [blame] [edit]
<!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/src/parent_module.rs`."><title>parent_module.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" 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/</div>parent_module.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="kw">use </span>hir::{Semantics, crate_def_map};
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>ide_db::{
<a href=#3 id=3 data-nosnippet>3</a> FileId, FilePosition, RootDatabase,
<a href=#4 id=4 data-nosnippet>4</a> base_db::{Crate, RootQueryDb},
<a href=#5 id=5 data-nosnippet>5</a>};
<a href=#6 id=6 data-nosnippet>6</a><span class="kw">use </span>itertools::Itertools;
<a href=#7 id=7 data-nosnippet>7</a><span class="kw">use </span>syntax::{
<a href=#8 id=8 data-nosnippet>8</a> algo::find_node_at_offset,
<a href=#9 id=9 data-nosnippet>9</a> ast::{<span class="self">self</span>, AstNode},
<a href=#10 id=10 data-nosnippet>10</a>};
<a href=#11 id=11 data-nosnippet>11</a>
<a href=#12 id=12 data-nosnippet>12</a><span class="kw">use </span><span class="kw">crate</span>::NavigationTarget;
<a href=#13 id=13 data-nosnippet>13</a>
<a href=#14 id=14 data-nosnippet>14</a><span class="comment">// Feature: Parent Module
<a href=#15 id=15 data-nosnippet>15</a>//
<a href=#16 id=16 data-nosnippet>16</a>// Navigates to the parent module of the current module.
<a href=#17 id=17 data-nosnippet>17</a>//
<a href=#18 id=18 data-nosnippet>18</a>// | Editor | Action Name |
<a href=#19 id=19 data-nosnippet>19</a>// |---------|-------------|
<a href=#20 id=20 data-nosnippet>20</a>// | VS Code | **rust-analyzer: Locate parent module** |
<a href=#21 id=21 data-nosnippet>21</a>//
<a href=#22 id=22 data-nosnippet>22</a>// ![Parent Module](https://user-images.githubusercontent.com/48062697/113065580-04c21800-91b1-11eb-9a32-00086161c0bd.gif)
<a href=#23 id=23 data-nosnippet>23</a>
<a href=#24 id=24 data-nosnippet>24</a></span><span class="doccomment">/// This returns `Vec` because a module may be included from several places.
<a href=#25 id=25 data-nosnippet>25</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>parent_module(db: <span class="kw-2">&amp;</span>RootDatabase, position: FilePosition) -&gt; Vec&lt;NavigationTarget&gt; {
<a href=#26 id=26 data-nosnippet>26</a> <span class="kw">let </span>sema = Semantics::new(db);
<a href=#27 id=27 data-nosnippet>27</a> <span class="kw">let </span>source_file = sema.parse_guess_edition(position.file_id);
<a href=#28 id=28 data-nosnippet>28</a>
<a href=#29 id=29 data-nosnippet>29</a> <span class="kw">let </span><span class="kw-2">mut </span>module = find_node_at_offset::&lt;ast::Module&gt;(source_file.syntax(), position.offset);
<a href=#30 id=30 data-nosnippet>30</a>
<a href=#31 id=31 data-nosnippet>31</a> <span class="comment">// If cursor is literally on `mod foo`, go to the grandpa.
<a href=#32 id=32 data-nosnippet>32</a> </span><span class="kw">if let </span><span class="prelude-val">Some</span>(m) = <span class="kw-2">&amp;</span>module
<a href=#33 id=33 data-nosnippet>33</a> &amp;&amp; !m
<a href=#34 id=34 data-nosnippet>34</a> .item_list()
<a href=#35 id=35 data-nosnippet>35</a> .is_some_and(|it| it.syntax().text_range().contains_inclusive(position.offset))
<a href=#36 id=36 data-nosnippet>36</a> {
<a href=#37 id=37 data-nosnippet>37</a> <span class="macro">cov_mark::hit!</span>(test_resolve_parent_module_on_module_decl);
<a href=#38 id=38 data-nosnippet>38</a> module = m.syntax().ancestors().skip(<span class="number">1</span>).find_map(ast::Module::cast);
<a href=#39 id=39 data-nosnippet>39</a> }
<a href=#40 id=40 data-nosnippet>40</a>
<a href=#41 id=41 data-nosnippet>41</a> <span class="kw">match </span>module {
<a href=#42 id=42 data-nosnippet>42</a> <span class="prelude-val">Some</span>(module) =&gt; sema
<a href=#43 id=43 data-nosnippet>43</a> .to_def(<span class="kw-2">&amp;</span>module)
<a href=#44 id=44 data-nosnippet>44</a> .into_iter()
<a href=#45 id=45 data-nosnippet>45</a> .flat_map(|module| NavigationTarget::from_module_to_decl(db, module))
<a href=#46 id=46 data-nosnippet>46</a> .collect(),
<a href=#47 id=47 data-nosnippet>47</a> <span class="prelude-val">None </span>=&gt; sema
<a href=#48 id=48 data-nosnippet>48</a> .file_to_module_defs(position.file_id)
<a href=#49 id=49 data-nosnippet>49</a> .flat_map(|module| NavigationTarget::from_module_to_decl(db, module))
<a href=#50 id=50 data-nosnippet>50</a> .collect(),
<a href=#51 id=51 data-nosnippet>51</a> }
<a href=#52 id=52 data-nosnippet>52</a>}
<a href=#53 id=53 data-nosnippet>53</a>
<a href=#54 id=54 data-nosnippet>54</a><span class="doccomment">/// This returns `Vec` because a module may be included from several places.
<a href=#55 id=55 data-nosnippet>55</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>crates_for(db: <span class="kw-2">&amp;</span>RootDatabase, file_id: FileId) -&gt; Vec&lt;Crate&gt; {
<a href=#56 id=56 data-nosnippet>56</a> db.relevant_crates(file_id)
<a href=#57 id=57 data-nosnippet>57</a> .iter()
<a href=#58 id=58 data-nosnippet>58</a> .copied()
<a href=#59 id=59 data-nosnippet>59</a> .filter(|<span class="kw-2">&amp;</span>crate_id| {
<a href=#60 id=60 data-nosnippet>60</a> crate_def_map(db, crate_id).modules_for_file(db, file_id).next().is_some()
<a href=#61 id=61 data-nosnippet>61</a> })
<a href=#62 id=62 data-nosnippet>62</a> .sorted()
<a href=#63 id=63 data-nosnippet>63</a> .collect()
<a href=#64 id=64 data-nosnippet>64</a>}
<a href=#65 id=65 data-nosnippet>65</a>
<a href=#66 id=66 data-nosnippet>66</a><span class="attr">#[cfg(test)]
<a href=#67 id=67 data-nosnippet>67</a></span><span class="kw">mod </span>tests {
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">use </span>ide_db::FileRange;
<a href=#69 id=69 data-nosnippet>69</a>
<a href=#70 id=70 data-nosnippet>70</a> <span class="kw">use </span><span class="kw">crate</span>::fixture;
<a href=#71 id=71 data-nosnippet>71</a>
<a href=#72 id=72 data-nosnippet>72</a> <span class="kw">fn </span>check(<span class="attr">#[rust_analyzer::rust_fixture] </span>ra_fixture: <span class="kw-2">&amp;</span>str) {
<a href=#73 id=73 data-nosnippet>73</a> <span class="kw">let </span>(analysis, position, expected) = fixture::annotations(ra_fixture);
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">let </span>navs = analysis.parent_module(position).unwrap();
<a href=#75 id=75 data-nosnippet>75</a> <span class="kw">let </span>navs = navs
<a href=#76 id=76 data-nosnippet>76</a> .iter()
<a href=#77 id=77 data-nosnippet>77</a> .map(|nav| FileRange { file_id: nav.file_id, range: nav.focus_or_full_range() })
<a href=#78 id=78 data-nosnippet>78</a> .collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;();
<a href=#79 id=79 data-nosnippet>79</a> <span class="macro">assert_eq!</span>(expected.into_iter().map(|(fr, <span class="kw">_</span>)| fr).collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;(), navs);
<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> <span class="attr">#[test]
<a href=#83 id=83 data-nosnippet>83</a> </span><span class="kw">fn </span>test_resolve_parent_module() {
<a href=#84 id=84 data-nosnippet>84</a> check(
<a href=#85 id=85 data-nosnippet>85</a> <span class="string">r#"
<a href=#86 id=86 data-nosnippet>86</a>//- /lib.rs
<a href=#87 id=87 data-nosnippet>87</a>mod foo;
<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>//- /foo.rs
<a href=#91 id=91 data-nosnippet>91</a>$0// empty
<a href=#92 id=92 data-nosnippet>92</a>"#</span>,
<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="attr">#[test]
<a href=#97 id=97 data-nosnippet>97</a> </span><span class="kw">fn </span>test_resolve_parent_module_on_module_decl() {
<a href=#98 id=98 data-nosnippet>98</a> <span class="macro">cov_mark::check!</span>(test_resolve_parent_module_on_module_decl);
<a href=#99 id=99 data-nosnippet>99</a> check(
<a href=#100 id=100 data-nosnippet>100</a> <span class="string">r#"
<a href=#101 id=101 data-nosnippet>101</a>//- /lib.rs
<a href=#102 id=102 data-nosnippet>102</a>mod foo;
<a href=#103 id=103 data-nosnippet>103</a> //^^^
<a href=#104 id=104 data-nosnippet>104</a>//- /foo.rs
<a href=#105 id=105 data-nosnippet>105</a>mod $0bar;
<a href=#106 id=106 data-nosnippet>106</a>
<a href=#107 id=107 data-nosnippet>107</a>//- /foo/bar.rs
<a href=#108 id=108 data-nosnippet>108</a>// empty
<a href=#109 id=109 data-nosnippet>109</a>"#</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="attr">#[test]
<a href=#114 id=114 data-nosnippet>114</a> </span><span class="kw">fn </span>test_resolve_parent_module_for_inline() {
<a href=#115 id=115 data-nosnippet>115</a> check(
<a href=#116 id=116 data-nosnippet>116</a> <span class="string">r#"
<a href=#117 id=117 data-nosnippet>117</a>//- /lib.rs
<a href=#118 id=118 data-nosnippet>118</a>mod foo {
<a href=#119 id=119 data-nosnippet>119</a> mod bar {
<a href=#120 id=120 data-nosnippet>120</a> mod baz { $0 }
<a href=#121 id=121 data-nosnippet>121</a> } //^^^
<a href=#122 id=122 data-nosnippet>122</a>}
<a href=#123 id=123 data-nosnippet>123</a>"#</span>,
<a href=#124 id=124 data-nosnippet>124</a> );
<a href=#125 id=125 data-nosnippet>125</a> }
<a href=#126 id=126 data-nosnippet>126</a>
<a href=#127 id=127 data-nosnippet>127</a> <span class="attr">#[test]
<a href=#128 id=128 data-nosnippet>128</a> </span><span class="kw">fn </span>test_resolve_multi_parent_module() {
<a href=#129 id=129 data-nosnippet>129</a> check(
<a href=#130 id=130 data-nosnippet>130</a> <span class="string">r#"
<a href=#131 id=131 data-nosnippet>131</a>//- /main.rs
<a href=#132 id=132 data-nosnippet>132</a>mod foo;
<a href=#133 id=133 data-nosnippet>133</a> //^^^
<a href=#134 id=134 data-nosnippet>134</a>#[path = "foo.rs"]
<a href=#135 id=135 data-nosnippet>135</a>mod bar;
<a href=#136 id=136 data-nosnippet>136</a> //^^^
<a href=#137 id=137 data-nosnippet>137</a>//- /foo.rs
<a href=#138 id=138 data-nosnippet>138</a>$0
<a href=#139 id=139 data-nosnippet>139</a>"#</span>,
<a href=#140 id=140 data-nosnippet>140</a> );
<a href=#141 id=141 data-nosnippet>141</a> }
<a href=#142 id=142 data-nosnippet>142</a>
<a href=#143 id=143 data-nosnippet>143</a> <span class="attr">#[test]
<a href=#144 id=144 data-nosnippet>144</a> </span><span class="kw">fn </span>test_resolve_crate_root() {
<a href=#145 id=145 data-nosnippet>145</a> <span class="kw">let </span>(analysis, file_id) = fixture::file(
<a href=#146 id=146 data-nosnippet>146</a> <span class="string">r#"
<a href=#147 id=147 data-nosnippet>147</a>//- /foo.rs
<a href=#148 id=148 data-nosnippet>148</a>$0
<a href=#149 id=149 data-nosnippet>149</a>//- /main.rs
<a href=#150 id=150 data-nosnippet>150</a>mod foo;
<a href=#151 id=151 data-nosnippet>151</a>"#</span>,
<a href=#152 id=152 data-nosnippet>152</a> );
<a href=#153 id=153 data-nosnippet>153</a> <span class="macro">assert_eq!</span>(analysis.crates_for(file_id).unwrap().len(), <span class="number">1</span>);
<a href=#154 id=154 data-nosnippet>154</a> }
<a href=#155 id=155 data-nosnippet>155</a>
<a href=#156 id=156 data-nosnippet>156</a> <span class="attr">#[test]
<a href=#157 id=157 data-nosnippet>157</a> </span><span class="kw">fn </span>test_resolve_multi_parent_crate() {
<a href=#158 id=158 data-nosnippet>158</a> <span class="kw">let </span>(analysis, file_id) = fixture::file(
<a href=#159 id=159 data-nosnippet>159</a> <span class="string">r#"
<a href=#160 id=160 data-nosnippet>160</a>//- /baz.rs
<a href=#161 id=161 data-nosnippet>161</a>$0
<a href=#162 id=162 data-nosnippet>162</a>//- /foo.rs crate:foo
<a href=#163 id=163 data-nosnippet>163</a>mod baz;
<a href=#164 id=164 data-nosnippet>164</a>//- /bar.rs crate:bar
<a href=#165 id=165 data-nosnippet>165</a>mod baz;
<a href=#166 id=166 data-nosnippet>166</a>"#</span>,
<a href=#167 id=167 data-nosnippet>167</a> );
<a href=#168 id=168 data-nosnippet>168</a> <span class="macro">assert_eq!</span>(analysis.crates_for(file_id).unwrap().len(), <span class="number">2</span>);
<a href=#169 id=169 data-nosnippet>169</a> }
<a href=#170 id=170 data-nosnippet>170</a>}
</code></pre></div></section></main></body></html>