]>
Commit | Line | Data |
---|---|---|
1b1a35ee | 1 | #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")] |
94222f64 | 2 | #![feature(if_let_guard)] |
0bf4aa26 | 3 | #![feature(nll)] |
dfeec247 | 4 | #![recursion_limit = "256"] |
7cac9316 | 5 | |
a7813a04 | 6 | mod dump_visitor; |
dfeec247 | 7 | mod dumper; |
a7813a04 | 8 | #[macro_use] |
041b39d2 XL |
9 | mod span_utils; |
10 | mod sig; | |
a7813a04 | 11 | |
3dfed10e XL |
12 | use rustc_ast as ast; |
13 | use rustc_ast::util::comments::beautify_doc_string; | |
f035d41b | 14 | use rustc_ast_pretty::pprust::attribute_to_string; |
dfeec247 | 15 | use rustc_hir as hir; |
f035d41b | 16 | use rustc_hir::def::{DefKind as HirDefKind, Res}; |
dfeec247 | 17 | use rustc_hir::def_id::{DefId, LOCAL_CRATE}; |
f035d41b | 18 | use rustc_hir::intravisit::{self, Visitor}; |
dfeec247 | 19 | use rustc_hir::Node; |
f035d41b XL |
20 | use rustc_hir_pretty::{enum_def_to_string, fn_to_string, ty_to_string}; |
21 | use rustc_middle::hir::map::Map; | |
ba9703b0 | 22 | use rustc_middle::middle::privacy::AccessLevels; |
1b1a35ee | 23 | use rustc_middle::ty::{self, print::with_no_trimmed_paths, DefIdTree, TyCtxt}; |
ba9703b0 XL |
24 | use rustc_middle::{bug, span_bug}; |
25 | use rustc_session::config::{CrateType, Input, OutputType}; | |
c295e0f8 | 26 | use rustc_session::cstore::ExternCrate; |
ba9703b0 | 27 | use rustc_session::output::{filename_for_metadata, out_filename}; |
74b04a01 | 28 | use rustc_span::source_map::Spanned; |
f9f354fc | 29 | use rustc_span::symbol::Ident; |
74b04a01 | 30 | use rustc_span::*; |
1a4d82fc | 31 | |
2c00a5a8 | 32 | use std::cell::Cell; |
3b2f2976 | 33 | use std::default::Default; |
85aaf69f | 34 | use std::env; |
476ff2be | 35 | use std::fs::File; |
dc9dc135 | 36 | use std::io::BufWriter; |
c34b1796 | 37 | use std::path::{Path, PathBuf}; |
1a4d82fc | 38 | |
041b39d2 XL |
39 | use dump_visitor::DumpVisitor; |
40 | use span_utils::SpanUtils; | |
41 | ||
3b2f2976 | 42 | use rls_data::config::Config; |
dfeec247 XL |
43 | use rls_data::{ |
44 | Analysis, Def, DefKind, ExternalCrateData, GlobalCrateId, Impl, ImplKind, MacroRef, Ref, | |
45 | RefKind, Relation, RelationKind, SpanData, | |
46 | }; | |
041b39d2 | 47 | |
3dfed10e | 48 | use tracing::{debug, error, info}; |
9fa01778 | 49 | |
f035d41b | 50 | pub struct SaveContext<'tcx> { |
dc9dc135 | 51 | tcx: TyCtxt<'tcx>, |
3dfed10e | 52 | maybe_typeck_results: Option<&'tcx ty::TypeckResults<'tcx>>, |
f035d41b | 53 | access_levels: &'tcx AccessLevels, |
a7813a04 | 54 | span_utils: SpanUtils<'tcx>, |
3b2f2976 | 55 | config: Config, |
2c00a5a8 | 56 | impl_counter: Cell<u32>, |
7453a54e SL |
57 | } |
58 | ||
041b39d2 XL |
59 | #[derive(Debug)] |
60 | pub enum Data { | |
041b39d2 XL |
61 | RefData(Ref), |
62 | DefData(Def), | |
2c00a5a8 | 63 | RelationData(Relation, Impl), |
041b39d2 XL |
64 | } |
65 | ||
f035d41b | 66 | impl<'tcx> SaveContext<'tcx> { |
3dfed10e | 67 | /// Gets the type-checking results for the current body. |
f035d41b XL |
68 | /// As this will ICE if called outside bodies, only call when working with |
69 | /// `Expr` or `Pat` nodes (they are guaranteed to be found only in bodies). | |
70 | #[track_caller] | |
3dfed10e XL |
71 | fn typeck_results(&self) -> &'tcx ty::TypeckResults<'tcx> { |
72 | self.maybe_typeck_results.expect("`SaveContext::typeck_results` called outside of body") | |
f035d41b XL |
73 | } |
74 | ||
041b39d2 | 75 | fn span_from_span(&self, span: Span) -> SpanData { |
abe05a73 | 76 | use rls_span::{Column, Row}; |
041b39d2 | 77 | |
74b04a01 XL |
78 | let sm = self.tcx.sess.source_map(); |
79 | let start = sm.lookup_char_pos(span.lo()); | |
80 | let end = sm.lookup_char_pos(span.hi()); | |
041b39d2 XL |
81 | |
82 | SpanData { | |
17df50a5 | 83 | file_name: start.file.name.prefer_remapped().to_string().into(), |
ea8adc8c XL |
84 | byte_start: span.lo().0, |
85 | byte_end: span.hi().0, | |
041b39d2 XL |
86 | line_start: Row::new_one_indexed(start.line as u32), |
87 | line_end: Row::new_one_indexed(end.line as u32), | |
88 | column_start: Column::new_one_indexed(start.col.0 as u32 + 1), | |
89 | column_end: Column::new_one_indexed(end.col.0 as u32 + 1), | |
90 | } | |
91 | } | |
92 | ||
0731742a | 93 | // Returns path to the compilation output (e.g., libfoo-12345678.rmeta) |
0bf4aa26 XL |
94 | pub fn compilation_output(&self, crate_name: &str) -> PathBuf { |
95 | let sess = &self.tcx.sess; | |
96 | // Save-analysis is emitted per whole session, not per each crate type | |
f9f354fc | 97 | let crate_type = sess.crate_types()[0]; |
17df50a5 | 98 | let outputs = &*self.tcx.output_filenames(()); |
0bf4aa26 XL |
99 | |
100 | if outputs.outputs.contains_key(&OutputType::Metadata) { | |
101 | filename_for_metadata(sess, crate_name, outputs) | |
102 | } else if outputs.outputs.should_codegen() { | |
103 | out_filename(sess, crate_type, outputs, crate_name) | |
104 | } else { | |
105 | // Otherwise it's only a DepInfo, in which case we return early and | |
106 | // not even reach the analysis stage. | |
107 | unreachable!() | |
108 | } | |
109 | } | |
110 | ||
d9579d0f | 111 | // List external crates used by the current crate. |
041b39d2 | 112 | pub fn get_external_crates(&self) -> Vec<ExternalCrateData> { |
136023e0 | 113 | let mut result = Vec::with_capacity(self.tcx.crates(()).len()); |
1a4d82fc | 114 | |
136023e0 | 115 | for &n in self.tcx.crates(()).iter() { |
dc9dc135 XL |
116 | let span = match self.tcx.extern_crate(n.as_def_id()) { |
117 | Some(&ExternCrate { span, .. }) => span, | |
a7813a04 | 118 | None => { |
416331ca | 119 | debug!("skipping crate {}, no data", n); |
a7813a04 XL |
120 | continue; |
121 | } | |
122 | }; | |
b7449926 | 123 | let lo_loc = self.span_utils.sess.source_map().lookup_char_pos(span.lo()); |
041b39d2 | 124 | result.push(ExternalCrateData { |
ff7c6d11 XL |
125 | // FIXME: change file_name field to PathBuf in rls-data |
126 | // https://github.com/nrc/rls-data/issues/7 | |
0bf4aa26 | 127 | file_name: self.span_utils.make_filename_string(&lo_loc.file), |
abe05a73 XL |
128 | num: n.as_u32(), |
129 | id: GlobalCrateId { | |
130 | name: self.tcx.crate_name(n).to_string(), | |
136023e0 XL |
131 | disambiguator: ( |
132 | self.tcx.def_path_hash(n.as_def_id()).stable_crate_id().to_u64(), | |
133 | 0, | |
134 | ), | |
abe05a73 | 135 | }, |
b039eaaf | 136 | }); |
92a42be0 | 137 | } |
1a4d82fc JJ |
138 | |
139 | result | |
140 | } | |
141 | ||
f035d41b | 142 | pub fn get_extern_item_data(&self, item: &hir::ForeignItem<'_>) -> Option<Data> { |
6a06907d | 143 | let def_id = item.def_id.to_def_id(); |
f035d41b | 144 | let qualname = format!("::{}", self.tcx.def_path_str(def_id)); |
6a06907d | 145 | let attrs = self.tcx.hir().attrs(item.hir_id()); |
e74abb32 | 146 | match item.kind { |
f035d41b | 147 | hir::ForeignItemKind::Fn(ref decl, arg_names, ref generics) => { |
13cf67c4 | 148 | filter!(self.span_utils, item.ident.span); |
041b39d2 XL |
149 | |
150 | Some(Data::DefData(Def { | |
b7449926 | 151 | kind: DefKind::ForeignFunction, |
f035d41b | 152 | id: id_from_def_id(def_id), |
13cf67c4 | 153 | span: self.span_from_span(item.ident.span), |
cc61c64b | 154 | name: item.ident.to_string(), |
041b39d2 | 155 | qualname, |
f035d41b XL |
156 | value: fn_to_string( |
157 | decl, | |
158 | hir::FnHeader { | |
159 | // functions in extern block are implicitly unsafe | |
160 | unsafety: hir::Unsafety::Unsafe, | |
161 | // functions in extern block cannot be const | |
162 | constness: hir::Constness::NotConst, | |
6a06907d | 163 | abi: self.tcx.hir().get_foreign_abi(item.hir_id()), |
f035d41b XL |
164 | // functions in extern block cannot be async |
165 | asyncness: hir::IsAsync::NotAsync, | |
166 | }, | |
167 | Some(item.ident.name), | |
168 | generics, | |
169 | &item.vis, | |
170 | arg_names, | |
171 | None, | |
172 | ), | |
cc61c64b | 173 | parent: None, |
041b39d2 XL |
174 | children: vec![], |
175 | decl_id: None, | |
6a06907d | 176 | docs: self.docs_for_attrs(attrs), |
041b39d2 | 177 | sig: sig::foreign_item_signature(item, self), |
6a06907d | 178 | attributes: lower_attributes(attrs.to_vec(), self), |
cc61c64b XL |
179 | })) |
180 | } | |
f035d41b | 181 | hir::ForeignItemKind::Static(ref ty, _) => { |
13cf67c4 | 182 | filter!(self.span_utils, item.ident.span); |
041b39d2 | 183 | |
f035d41b | 184 | let id = id_from_def_id(def_id); |
13cf67c4 | 185 | let span = self.span_from_span(item.ident.span); |
041b39d2 XL |
186 | |
187 | Some(Data::DefData(Def { | |
b7449926 | 188 | kind: DefKind::ForeignStatic, |
041b39d2 XL |
189 | id, |
190 | span, | |
cc61c64b | 191 | name: item.ident.to_string(), |
041b39d2 XL |
192 | qualname, |
193 | value: ty_to_string(ty), | |
cc61c64b | 194 | parent: None, |
041b39d2 XL |
195 | children: vec![], |
196 | decl_id: None, | |
6a06907d | 197 | docs: self.docs_for_attrs(attrs), |
041b39d2 | 198 | sig: sig::foreign_item_signature(item, self), |
6a06907d | 199 | attributes: lower_attributes(attrs.to_vec(), self), |
cc61c64b XL |
200 | })) |
201 | } | |
abe05a73 | 202 | // FIXME(plietar): needs a new DefKind in rls-data |
f035d41b | 203 | hir::ForeignItemKind::Type => None, |
cc61c64b XL |
204 | } |
205 | } | |
206 | ||
f035d41b | 207 | pub fn get_item_data(&self, item: &hir::Item<'_>) -> Option<Data> { |
6a06907d XL |
208 | let def_id = item.def_id.to_def_id(); |
209 | let attrs = self.tcx.hir().attrs(item.hir_id()); | |
e74abb32 | 210 | match item.kind { |
f035d41b XL |
211 | hir::ItemKind::Fn(ref sig, ref generics, _) => { |
212 | let qualname = format!("::{}", self.tcx.def_path_str(def_id)); | |
13cf67c4 | 213 | filter!(self.span_utils, item.ident.span); |
041b39d2 XL |
214 | Some(Data::DefData(Def { |
215 | kind: DefKind::Function, | |
f035d41b | 216 | id: id_from_def_id(def_id), |
13cf67c4 | 217 | span: self.span_from_span(item.ident.span), |
3157f602 | 218 | name: item.ident.to_string(), |
041b39d2 | 219 | qualname, |
f035d41b XL |
220 | value: fn_to_string( |
221 | sig.decl, | |
222 | sig.header, | |
223 | Some(item.ident.name), | |
224 | generics, | |
225 | &item.vis, | |
226 | &[], | |
227 | None, | |
228 | ), | |
9e0c209e | 229 | parent: None, |
041b39d2 XL |
230 | children: vec![], |
231 | decl_id: None, | |
6a06907d | 232 | docs: self.docs_for_attrs(attrs), |
041b39d2 | 233 | sig: sig::item_signature(item, self), |
6a06907d | 234 | attributes: lower_attributes(attrs.to_vec(), self), |
7453a54e | 235 | })) |
1a4d82fc | 236 | } |
f035d41b XL |
237 | hir::ItemKind::Static(ref typ, ..) => { |
238 | let qualname = format!("::{}", self.tcx.def_path_str(def_id)); | |
1a4d82fc | 239 | |
13cf67c4 | 240 | filter!(self.span_utils, item.ident.span); |
041b39d2 | 241 | |
f035d41b | 242 | let id = id_from_def_id(def_id); |
13cf67c4 | 243 | let span = self.span_from_span(item.ident.span); |
041b39d2 XL |
244 | |
245 | Some(Data::DefData(Def { | |
246 | kind: DefKind::Static, | |
247 | id, | |
248 | span, | |
c1a9b12d | 249 | name: item.ident.to_string(), |
041b39d2 XL |
250 | qualname, |
251 | value: ty_to_string(&typ), | |
9e0c209e | 252 | parent: None, |
041b39d2 XL |
253 | children: vec![], |
254 | decl_id: None, | |
6a06907d | 255 | docs: self.docs_for_attrs(attrs), |
041b39d2 | 256 | sig: sig::item_signature(item, self), |
6a06907d | 257 | attributes: lower_attributes(attrs.to_vec(), self), |
7453a54e | 258 | })) |
1a4d82fc | 259 | } |
f035d41b XL |
260 | hir::ItemKind::Const(ref typ, _) => { |
261 | let qualname = format!("::{}", self.tcx.def_path_str(def_id)); | |
13cf67c4 | 262 | filter!(self.span_utils, item.ident.span); |
041b39d2 | 263 | |
f035d41b | 264 | let id = id_from_def_id(def_id); |
13cf67c4 | 265 | let span = self.span_from_span(item.ident.span); |
041b39d2 XL |
266 | |
267 | Some(Data::DefData(Def { | |
268 | kind: DefKind::Const, | |
269 | id, | |
270 | span, | |
c1a9b12d | 271 | name: item.ident.to_string(), |
041b39d2 XL |
272 | qualname, |
273 | value: ty_to_string(typ), | |
9e0c209e | 274 | parent: None, |
041b39d2 XL |
275 | children: vec![], |
276 | decl_id: None, | |
6a06907d | 277 | docs: self.docs_for_attrs(attrs), |
041b39d2 | 278 | sig: sig::item_signature(item, self), |
6a06907d | 279 | attributes: lower_attributes(attrs.to_vec(), self), |
7453a54e | 280 | })) |
85aaf69f | 281 | } |
f035d41b XL |
282 | hir::ItemKind::Mod(ref m) => { |
283 | let qualname = format!("::{}", self.tcx.def_path_str(def_id)); | |
62682a34 | 284 | |
74b04a01 XL |
285 | let sm = self.tcx.sess.source_map(); |
286 | let filename = sm.span_to_filename(m.inner); | |
62682a34 | 287 | |
13cf67c4 | 288 | filter!(self.span_utils, item.ident.span); |
32a655c1 | 289 | |
041b39d2 XL |
290 | Some(Data::DefData(Def { |
291 | kind: DefKind::Mod, | |
f035d41b | 292 | id: id_from_def_id(def_id), |
c1a9b12d | 293 | name: item.ident.to_string(), |
041b39d2 | 294 | qualname, |
13cf67c4 | 295 | span: self.span_from_span(item.ident.span), |
17df50a5 | 296 | value: filename.prefer_remapped().to_string(), |
041b39d2 | 297 | parent: None, |
6a06907d XL |
298 | children: m |
299 | .item_ids | |
300 | .iter() | |
301 | .map(|i| id_from_def_id(i.def_id.to_def_id())) | |
302 | .collect(), | |
041b39d2 | 303 | decl_id: None, |
6a06907d | 304 | docs: self.docs_for_attrs(attrs), |
041b39d2 | 305 | sig: sig::item_signature(item, self), |
6a06907d | 306 | attributes: lower_attributes(attrs.to_vec(), self), |
7453a54e | 307 | })) |
e9174d1e | 308 | } |
f035d41b | 309 | hir::ItemKind::Enum(ref def, ref generics) => { |
a7813a04 | 310 | let name = item.ident.to_string(); |
f035d41b | 311 | let qualname = format!("::{}", self.tcx.def_path_str(def_id)); |
13cf67c4 | 312 | filter!(self.span_utils, item.ident.span); |
f035d41b XL |
313 | let value = |
314 | enum_def_to_string(def, generics, item.ident.name, item.span, &item.vis); | |
041b39d2 XL |
315 | Some(Data::DefData(Def { |
316 | kind: DefKind::Enum, | |
f035d41b | 317 | id: id_from_def_id(def_id), |
13cf67c4 | 318 | span: self.span_from_span(item.ident.span), |
041b39d2 XL |
319 | name, |
320 | qualname, | |
321 | value, | |
322 | parent: None, | |
f035d41b | 323 | children: def.variants.iter().map(|v| id_from_hir_id(v.id, self)).collect(), |
041b39d2 | 324 | decl_id: None, |
6a06907d | 325 | docs: self.docs_for_attrs(attrs), |
041b39d2 | 326 | sig: sig::item_signature(item, self), |
6a06907d | 327 | attributes: lower_attributes(attrs.to_vec(), self), |
7453a54e | 328 | })) |
e9174d1e | 329 | } |
94222f64 XL |
330 | hir::ItemKind::Impl(hir::Impl { ref of_trait, ref self_ty, ref items, .. }) |
331 | if let hir::TyKind::Path(hir::QPath::Resolved(_, ref path)) = self_ty.kind => | |
332 | { | |
333 | // Common case impl for a struct or something basic. | |
334 | if generated_code(path.span) { | |
335 | return None; | |
62682a34 | 336 | } |
94222f64 XL |
337 | let sub_span = path.segments.last().unwrap().ident.span; |
338 | filter!(self.span_utils, sub_span); | |
339 | ||
340 | let impl_id = self.next_impl_id(); | |
341 | let span = self.span_from_span(sub_span); | |
342 | ||
343 | let type_data = self.lookup_def_id(self_ty.hir_id); | |
344 | type_data.map(|type_data| { | |
345 | Data::RelationData( | |
346 | Relation { | |
347 | kind: RelationKind::Impl { id: impl_id }, | |
348 | span: span.clone(), | |
349 | from: id_from_def_id(type_data), | |
350 | to: of_trait | |
351 | .as_ref() | |
352 | .and_then(|t| self.lookup_def_id(t.hir_ref_id)) | |
353 | .map(id_from_def_id) | |
354 | .unwrap_or_else(null_id), | |
355 | }, | |
356 | Impl { | |
357 | id: impl_id, | |
358 | kind: match *of_trait { | |
359 | Some(_) => ImplKind::Direct, | |
360 | None => ImplKind::Inherent, | |
361 | }, | |
362 | span, | |
363 | value: String::new(), | |
364 | parent: None, | |
365 | children: items | |
366 | .iter() | |
367 | .map(|i| id_from_def_id(i.id.def_id.to_def_id())) | |
368 | .collect(), | |
369 | docs: String::new(), | |
370 | sig: None, | |
371 | attributes: vec![], | |
372 | }, | |
373 | ) | |
374 | }) | |
62682a34 | 375 | } |
94222f64 | 376 | hir::ItemKind::Impl(_) => None, |
d9579d0f AL |
377 | _ => { |
378 | // FIXME | |
54a0048b | 379 | bug!(); |
1a4d82fc JJ |
380 | } |
381 | } | |
1a4d82fc JJ |
382 | } |
383 | ||
6a06907d | 384 | pub fn get_field_data(&self, field: &hir::FieldDef<'_>, scope: hir::HirId) -> Option<Def> { |
f035d41b XL |
385 | let name = field.ident.to_string(); |
386 | let scope_def_id = self.tcx.hir().local_def_id(scope).to_def_id(); | |
387 | let qualname = format!("::{}::{}", self.tcx.def_path_str(scope_def_id), field.ident); | |
388 | filter!(self.span_utils, field.ident.span); | |
389 | let field_def_id = self.tcx.hir().local_def_id(field.hir_id).to_def_id(); | |
390 | let typ = self.tcx.type_of(field_def_id).to_string(); | |
391 | ||
392 | let id = id_from_def_id(field_def_id); | |
393 | let span = self.span_from_span(field.ident.span); | |
6a06907d | 394 | let attrs = self.tcx.hir().attrs(field.hir_id); |
f035d41b XL |
395 | |
396 | Some(Def { | |
397 | kind: DefKind::Field, | |
398 | id, | |
399 | span, | |
400 | name, | |
401 | qualname, | |
402 | value: typ, | |
403 | parent: Some(id_from_def_id(scope_def_id)), | |
404 | children: vec![], | |
405 | decl_id: None, | |
6a06907d | 406 | docs: self.docs_for_attrs(attrs), |
f035d41b | 407 | sig: sig::field_signature(field, self), |
6a06907d | 408 | attributes: lower_attributes(attrs.to_vec(), self), |
f035d41b | 409 | }) |
62682a34 SL |
410 | } |
411 | ||
c1a9b12d SL |
412 | // FIXME would be nice to take a MethodItem here, but the ast provides both |
413 | // trait and impl flavours, so the caller must do the disassembly. | |
f035d41b | 414 | pub fn get_method_data(&self, hir_id: hir::HirId, ident: Ident, span: Span) -> Option<Def> { |
c1a9b12d SL |
415 | // The qualname for a method is the trait name or name of the struct in an impl in |
416 | // which the method is declared in, followed by the method's name. | |
f035d41b XL |
417 | let def_id = self.tcx.hir().local_def_id(hir_id).to_def_id(); |
418 | let (qualname, parent_scope, decl_id, docs, attributes) = | |
419 | match self.tcx.impl_of_method(def_id) { | |
420 | Some(impl_id) => match self.tcx.hir().get_if_local(impl_id) { | |
421 | Some(Node::Item(item)) => match item.kind { | |
5869c6ff | 422 | hir::ItemKind::Impl(hir::Impl { ref self_ty, .. }) => { |
f035d41b XL |
423 | let hir = self.tcx.hir(); |
424 | ||
425 | let mut qualname = String::from("<"); | |
426 | qualname | |
427 | .push_str(&rustc_hir_pretty::id_to_string(&hir, self_ty.hir_id)); | |
428 | ||
429 | let trait_id = self.tcx.trait_id_of_impl(impl_id); | |
430 | let mut docs = String::new(); | |
431 | let mut attrs = vec![]; | |
6a06907d XL |
432 | if let Some(Node::ImplItem(_)) = hir.find(hir_id) { |
433 | attrs = self.tcx.hir().attrs(hir_id).to_vec(); | |
434 | docs = self.docs_for_attrs(&attrs); | |
f035d41b XL |
435 | } |
436 | ||
437 | let mut decl_id = None; | |
438 | if let Some(def_id) = trait_id { | |
439 | // A method in a trait impl. | |
440 | qualname.push_str(" as "); | |
441 | qualname.push_str(&self.tcx.def_path_str(def_id)); | |
442 | ||
443 | decl_id = self | |
444 | .tcx | |
445 | .associated_items(def_id) | |
446 | .filter_by_name_unhygienic(ident.name) | |
447 | .next() | |
448 | .map(|item| item.def_id); | |
449 | } | |
1b1a35ee | 450 | qualname.push('>'); |
f035d41b XL |
451 | |
452 | (qualname, trait_id, decl_id, docs, attrs) | |
453 | } | |
454 | _ => { | |
455 | span_bug!( | |
456 | span, | |
457 | "Container {:?} for method {} not an impl?", | |
458 | impl_id, | |
459 | hir_id | |
460 | ); | |
461 | } | |
462 | }, | |
463 | r => { | |
464 | span_bug!( | |
465 | span, | |
466 | "Container {:?} for method {} is not a node item {:?}", | |
467 | impl_id, | |
468 | hir_id, | |
469 | r | |
470 | ); | |
471 | } | |
472 | }, | |
473 | None => match self.tcx.trait_of_item(def_id) { | |
474 | Some(def_id) => { | |
94b46f34 XL |
475 | let mut docs = String::new(); |
476 | let mut attrs = vec![]; | |
f035d41b | 477 | |
6a06907d XL |
478 | if let Some(Node::TraitItem(_)) = self.tcx.hir().find(hir_id) { |
479 | attrs = self.tcx.hir().attrs(hir_id).to_vec(); | |
480 | docs = self.docs_for_attrs(&attrs); | |
94b46f34 XL |
481 | } |
482 | ||
f035d41b XL |
483 | ( |
484 | format!("::{}", self.tcx.def_path_str(def_id)), | |
485 | Some(def_id), | |
486 | None, | |
487 | docs, | |
488 | attrs, | |
489 | ) | |
94b46f34 | 490 | } |
f035d41b XL |
491 | None => { |
492 | debug!("could not find container for method {} at {:?}", hir_id, span); | |
493 | // This is not necessarily a bug, if there was a compilation error, | |
3dfed10e | 494 | // the typeck results we need might not exist. |
f035d41b | 495 | return None; |
c1a9b12d | 496 | } |
abe05a73 | 497 | }, |
f035d41b | 498 | }; |
c1a9b12d | 499 | |
13cf67c4 | 500 | let qualname = format!("{}::{}", qualname, ident.name); |
c1a9b12d | 501 | |
13cf67c4 | 502 | filter!(self.span_utils, ident.span); |
32a655c1 | 503 | |
041b39d2 XL |
504 | Some(Def { |
505 | kind: DefKind::Method, | |
f035d41b | 506 | id: id_from_def_id(def_id), |
13cf67c4 XL |
507 | span: self.span_from_span(ident.span), |
508 | name: ident.name.to_string(), | |
041b39d2 | 509 | qualname, |
a7813a04 XL |
510 | // FIXME you get better data here by using the visitor. |
511 | value: String::new(), | |
ba9703b0 | 512 | parent: parent_scope.map(id_from_def_id), |
041b39d2 | 513 | children: vec![], |
ba9703b0 | 514 | decl_id: decl_id.map(id_from_def_id), |
041b39d2 XL |
515 | docs, |
516 | sig: None, | |
517 | attributes: lower_attributes(attributes, self), | |
7453a54e | 518 | }) |
c1a9b12d SL |
519 | } |
520 | ||
f035d41b | 521 | pub fn get_expr_data(&self, expr: &hir::Expr<'_>) -> Option<Data> { |
3dfed10e | 522 | let ty = self.typeck_results().expr_ty_adjusted_opt(expr)?; |
1b1a35ee | 523 | if matches!(ty.kind(), ty::Error(_)) { |
7453a54e SL |
524 | return None; |
525 | } | |
e74abb32 | 526 | match expr.kind { |
f035d41b | 527 | hir::ExprKind::Field(ref sub_ex, ident) => { |
1b1a35ee | 528 | match self.typeck_results().expr_ty_adjusted(&sub_ex).kind() { |
b7449926 | 529 | ty::Adt(def, _) if !def.is_enum() => { |
83c7162d | 530 | let variant = &def.non_enum_variant(); |
13cf67c4 XL |
531 | filter!(self.span_utils, ident.span); |
532 | let span = self.span_from_span(ident.span); | |
ba9703b0 | 533 | Some(Data::RefData(Ref { |
041b39d2 XL |
534 | kind: RefKind::Variable, |
535 | span, | |
74b04a01 XL |
536 | ref_id: self |
537 | .tcx | |
538 | .find_field_index(ident, variant) | |
539 | .map(|index| id_from_def_id(variant.fields[index].did)) | |
ba9703b0 XL |
540 | .unwrap_or_else(null_id), |
541 | })) | |
62682a34 | 542 | } |
b7449926 | 543 | ty::Tuple(..) => None, |
62682a34 | 544 | _ => { |
416331ca | 545 | debug!("expected struct or union type, found {:?}", ty); |
62682a34 SL |
546 | None |
547 | } | |
548 | } | |
549 | } | |
1b1a35ee | 550 | hir::ExprKind::Struct(qpath, ..) => match ty.kind() { |
3dfed10e XL |
551 | ty::Adt(def, _) => { |
552 | let sub_span = qpath.last_segment_span(); | |
553 | filter!(self.span_utils, sub_span); | |
554 | let span = self.span_from_span(sub_span); | |
555 | Some(Data::RefData(Ref { | |
556 | kind: RefKind::Type, | |
557 | span, | |
558 | ref_id: id_from_def_id(def.did), | |
559 | })) | |
62682a34 | 560 | } |
3dfed10e XL |
561 | _ => { |
562 | debug!("expected adt, found {:?}", ty); | |
563 | None | |
564 | } | |
565 | }, | |
f035d41b | 566 | hir::ExprKind::MethodCall(ref seg, ..) => { |
3dfed10e | 567 | let method_id = match self.typeck_results().type_dependent_def_id(expr.hir_id) { |
532ac7d7 | 568 | Some(id) => id, |
abe05a73 | 569 | None => { |
416331ca | 570 | debug!("could not resolve method id for {:?}", expr); |
abe05a73 XL |
571 | return None; |
572 | } | |
573 | }; | |
476ff2be | 574 | let (def_id, decl_id) = match self.tcx.associated_item(method_id).container { |
c1a9b12d | 575 | ty::ImplContainer(_) => (Some(method_id), None), |
e9174d1e | 576 | ty::TraitContainer(_) => (None, Some(method_id)), |
c1a9b12d | 577 | }; |
83c7162d | 578 | let sub_span = seg.ident.span; |
13cf67c4 | 579 | filter!(self.span_utils, sub_span); |
abe05a73 | 580 | let span = self.span_from_span(sub_span); |
041b39d2 XL |
581 | Some(Data::RefData(Ref { |
582 | kind: RefKind::Function, | |
583 | span, | |
ba9703b0 | 584 | ref_id: def_id.or(decl_id).map(id_from_def_id).unwrap_or_else(null_id), |
c1a9b12d SL |
585 | })) |
586 | } | |
f035d41b XL |
587 | hir::ExprKind::Path(ref path) => { |
588 | self.get_path_data(expr.hir_id, path).map(Data::RefData) | |
c1a9b12d | 589 | } |
62682a34 SL |
590 | _ => { |
591 | // FIXME | |
f035d41b | 592 | bug!("invalid expression: {:?}", expr); |
62682a34 SL |
593 | } |
594 | } | |
595 | } | |
596 | ||
f035d41b | 597 | pub fn get_path_res(&self, hir_id: hir::HirId) -> Res { |
dc9dc135 | 598 | match self.tcx.hir().get(hir_id) { |
48663c56 | 599 | Node::TraitRef(tr) => tr.path.res, |
476ff2be | 600 | |
dfeec247 | 601 | Node::Item(&hir::Item { kind: hir::ItemKind::Use(path, _), .. }) => path.res, |
b7449926 | 602 | Node::Visibility(&Spanned { |
dfeec247 XL |
603 | node: hir::VisibilityKind::Restricted { ref path, .. }, |
604 | .. | |
605 | }) => path.res, | |
476ff2be | 606 | |
dfeec247 XL |
607 | Node::PathSegment(seg) => match seg.res { |
608 | Some(res) if res != Res::Err => res, | |
609 | _ => { | |
610 | let parent_node = self.tcx.hir().get_parent_node(hir_id); | |
f035d41b | 611 | self.get_path_res(parent_node) |
0731742a | 612 | } |
dfeec247 | 613 | }, |
9fa01778 | 614 | |
dfeec247 | 615 | Node::Expr(&hir::Expr { kind: hir::ExprKind::Struct(ref qpath, ..), .. }) => { |
3dfed10e | 616 | self.typeck_results().qpath_res(qpath, hir_id) |
9fa01778 XL |
617 | } |
618 | ||
dfeec247 | 619 | Node::Expr(&hir::Expr { kind: hir::ExprKind::Path(ref qpath), .. }) |
ba9703b0 XL |
620 | | Node::Pat(&hir::Pat { |
621 | kind: | |
622 | hir::PatKind::Path(ref qpath) | |
623 | | hir::PatKind::Struct(ref qpath, ..) | |
624 | | hir::PatKind::TupleStruct(ref qpath, ..), | |
625 | .. | |
626 | }) | |
f035d41b XL |
627 | | Node::Ty(&hir::Ty { kind: hir::TyKind::Path(ref qpath), .. }) => match qpath { |
628 | hir::QPath::Resolved(_, path) => path.res, | |
29967ef6 XL |
629 | hir::QPath::TypeRelative(..) | hir::QPath::LangItem(..) => { |
630 | // #75962: `self.typeck_results` may be different from the `hir_id`'s result. | |
631 | if self.tcx.has_typeck_results(hir_id.owner.to_def_id()) { | |
632 | self.tcx.typeck(hir_id.owner).qpath_res(qpath, hir_id) | |
633 | } else { | |
634 | Res::Err | |
635 | } | |
636 | } | |
f035d41b | 637 | }, |
476ff2be | 638 | |
b7449926 | 639 | Node::Binding(&hir::Pat { |
dfeec247 | 640 | kind: hir::PatKind::Binding(_, canonical_id, ..), .. |
48663c56 | 641 | }) => Res::Local(canonical_id), |
476ff2be | 642 | |
48663c56 | 643 | _ => Res::Err, |
476ff2be SL |
644 | } |
645 | } | |
646 | ||
f035d41b XL |
647 | pub fn get_path_data(&self, id: hir::HirId, path: &hir::QPath<'_>) -> Option<Ref> { |
648 | let segment = match path { | |
649 | hir::QPath::Resolved(_, path) => path.segments.last(), | |
650 | hir::QPath::TypeRelative(_, segment) => Some(*segment), | |
3dfed10e | 651 | hir::QPath::LangItem(..) => None, |
f035d41b XL |
652 | }; |
653 | segment.and_then(|seg| { | |
dfeec247 XL |
654 | self.get_path_segment_data(seg).or_else(|| self.get_path_segment_data_with_id(seg, id)) |
655 | }) | |
13cf67c4 XL |
656 | } |
657 | ||
f035d41b XL |
658 | pub fn get_path_segment_data(&self, path_seg: &hir::PathSegment<'_>) -> Option<Ref> { |
659 | self.get_path_segment_data_with_id(path_seg, path_seg.hir_id?) | |
13cf67c4 XL |
660 | } |
661 | ||
f035d41b | 662 | pub fn get_path_segment_data_with_id( |
13cf67c4 | 663 | &self, |
f035d41b XL |
664 | path_seg: &hir::PathSegment<'_>, |
665 | id: hir::HirId, | |
13cf67c4 | 666 | ) -> Option<Ref> { |
abe05a73 | 667 | // Returns true if the path is function type sugar, e.g., `Fn(A) -> B`. |
f035d41b | 668 | fn fn_type(seg: &hir::PathSegment<'_>) -> bool { |
5869c6ff | 669 | seg.args.map_or(false, |args| args.parenthesized) |
abe05a73 XL |
670 | } |
671 | ||
48663c56 | 672 | let res = self.get_path_res(id); |
13cf67c4 XL |
673 | let span = path_seg.ident.span; |
674 | filter!(self.span_utils, span); | |
675 | let span = self.span_from_span(span); | |
676 | ||
48663c56 | 677 | match res { |
f035d41b XL |
678 | Res::Local(id) => { |
679 | Some(Ref { kind: RefKind::Variable, span, ref_id: id_from_hir_id(id, self) }) | |
680 | } | |
48663c56 | 681 | Res::Def(HirDefKind::Trait, def_id) if fn_type(path_seg) => { |
dfeec247 | 682 | Some(Ref { kind: RefKind::Type, span, ref_id: id_from_def_id(def_id) }) |
abe05a73 | 683 | } |
ba9703b0 XL |
684 | Res::Def( |
685 | HirDefKind::Struct | |
686 | | HirDefKind::Variant | |
687 | | HirDefKind::Union | |
688 | | HirDefKind::Enum | |
689 | | HirDefKind::TyAlias | |
690 | | HirDefKind::ForeignTy | |
691 | | HirDefKind::TraitAlias | |
ba9703b0 XL |
692 | | HirDefKind::AssocTy |
693 | | HirDefKind::Trait | |
694 | | HirDefKind::OpaqueTy | |
695 | | HirDefKind::TyParam, | |
696 | def_id, | |
697 | ) => Some(Ref { kind: RefKind::Type, span, ref_id: id_from_def_id(def_id) }), | |
48663c56 | 698 | Res::Def(HirDefKind::ConstParam, def_id) => { |
dfeec247 | 699 | Some(Ref { kind: RefKind::Variable, span, ref_id: id_from_def_id(def_id) }) |
9fa01778 | 700 | } |
3dfed10e | 701 | Res::Def(HirDefKind::Ctor(..), def_id) => { |
f035d41b | 702 | // This is a reference to a tuple struct or an enum variant where the def_id points |
abe05a73 | 703 | // to an invisible constructor function. That is not a very useful |
f035d41b | 704 | // def, so adjust to point to the tuple struct or enum variant itself. |
532ac7d7 | 705 | let parent_def_id = self.tcx.parent(def_id).unwrap(); |
dfeec247 | 706 | Some(Ref { kind: RefKind::Type, span, ref_id: id_from_def_id(parent_def_id) }) |
abe05a73 | 707 | } |
f035d41b XL |
708 | Res::Def(HirDefKind::Static | HirDefKind::Const | HirDefKind::AssocConst, _) => { |
709 | Some(Ref { kind: RefKind::Variable, span, ref_id: id_from_def_id(res.def_id()) }) | |
710 | } | |
ba9703b0 | 711 | Res::Def(HirDefKind::AssocFn, decl_id) => { |
e9174d1e | 712 | let def_id = if decl_id.is_local() { |
476ff2be | 713 | let ti = self.tcx.associated_item(decl_id); |
74b04a01 | 714 | |
abe05a73 XL |
715 | self.tcx |
716 | .associated_items(ti.container.id()) | |
74b04a01 XL |
717 | .filter_by_name_unhygienic(ti.ident.name) |
718 | .find(|item| item.defaultness.has_value()) | |
476ff2be | 719 | .map(|item| item.def_id) |
c1a9b12d SL |
720 | } else { |
721 | None | |
722 | }; | |
041b39d2 XL |
723 | Some(Ref { |
724 | kind: RefKind::Function, | |
725 | span, | |
726 | ref_id: id_from_def_id(def_id.unwrap_or(decl_id)), | |
727 | }) | |
e9174d1e | 728 | } |
48663c56 | 729 | Res::Def(HirDefKind::Fn, def_id) => { |
dfeec247 | 730 | Some(Ref { kind: RefKind::Function, span, ref_id: id_from_def_id(def_id) }) |
c1a9b12d | 731 | } |
48663c56 | 732 | Res::Def(HirDefKind::Mod, def_id) => { |
dfeec247 | 733 | Some(Ref { kind: RefKind::Mod, span, ref_id: id_from_def_id(def_id) }) |
c1a9b12d | 734 | } |
f9f354fc XL |
735 | |
736 | Res::Def( | |
737 | HirDefKind::Macro(..) | |
738 | | HirDefKind::ExternCrate | |
739 | | HirDefKind::ForeignMod | |
740 | | HirDefKind::LifetimeParam | |
741 | | HirDefKind::AnonConst | |
3c0e092e | 742 | | HirDefKind::InlineConst |
f9f354fc XL |
743 | | HirDefKind::Use |
744 | | HirDefKind::Field | |
745 | | HirDefKind::GlobalAsm | |
746 | | HirDefKind::Impl | |
747 | | HirDefKind::Closure | |
748 | | HirDefKind::Generator, | |
749 | _, | |
750 | ) | |
751 | | Res::PrimTy(..) | |
dfeec247 | 752 | | Res::SelfTy(..) |
dfeec247 XL |
753 | | Res::ToolMod |
754 | | Res::NonMacroAttr(..) | |
755 | | Res::SelfCtor(..) | |
756 | | Res::Err => None, | |
c1a9b12d SL |
757 | } |
758 | } | |
759 | ||
abe05a73 XL |
760 | pub fn get_field_ref_data( |
761 | &self, | |
6a06907d | 762 | field_ref: &hir::ExprField<'_>, |
abe05a73 XL |
763 | variant: &ty::VariantDef, |
764 | ) -> Option<Ref> { | |
13cf67c4 XL |
765 | filter!(self.span_utils, field_ref.ident.span); |
766 | self.tcx.find_field_index(field_ref.ident, variant).map(|index| { | |
767 | let span = self.span_from_span(field_ref.ident.span); | |
dfeec247 | 768 | Ref { kind: RefKind::Variable, span, ref_id: id_from_def_id(variant.fields[index].did) } |
7453a54e SL |
769 | }) |
770 | } | |
771 | ||
041b39d2 | 772 | /// Attempt to return MacroRef for any AST node. |
7453a54e SL |
773 | /// |
774 | /// For a given piece of AST defined by the supplied Span and NodeId, | |
9fa01778 | 775 | /// returns `None` if the node is not macro-generated or the span is malformed, |
041b39d2 | 776 | /// else uses the expansion callsite and callee to return some MacroRef. |
cdc7bbd5 XL |
777 | /// |
778 | /// FIXME: [`DumpVisitor::process_macro_use`] should actually dump this data | |
779 | #[allow(dead_code)] | |
780 | fn get_macro_use_data(&self, span: Span) -> Option<MacroRef> { | |
7453a54e SL |
781 | if !generated_code(span) { |
782 | return None; | |
783 | } | |
784 | // Note we take care to use the source callsite/callee, to handle | |
785 | // nested expansions and ensure we only generate data for source-visible | |
786 | // macro uses. | |
cc61c64b | 787 | let callsite = span.source_callsite(); |
041b39d2 | 788 | let callsite_span = self.span_from_span(callsite); |
abe05a73 | 789 | let callee = span.source_callee()?; |
7453a54e | 790 | |
dfeec247 | 791 | let mac_name = match callee.kind { |
136023e0 | 792 | ExpnKind::Macro(kind, name) => match kind { |
dfeec247 XL |
793 | MacroKind::Bang => name, |
794 | ||
795 | // Ignore attribute macros, their spans are usually mangled | |
796 | // FIXME(eddyb) is this really the case anymore? | |
797 | MacroKind::Attr | MacroKind::Derive => return None, | |
798 | }, | |
799 | ||
800 | // These are not macros. | |
801 | // FIXME(eddyb) maybe there is a way to handle them usefully? | |
29967ef6 XL |
802 | ExpnKind::Inlined | ExpnKind::Root | ExpnKind::AstPass(_) | ExpnKind::Desugaring(_) => { |
803 | return None; | |
804 | } | |
dfeec247 | 805 | }; |
7453a54e | 806 | |
416331ca | 807 | let callee_span = self.span_from_span(callee.def_site); |
041b39d2 XL |
808 | Some(MacroRef { |
809 | span: callsite_span, | |
dfeec247 | 810 | qualname: mac_name.to_string(), // FIXME: generate the real qualname |
041b39d2 | 811 | callee_span, |
7453a54e | 812 | }) |
62682a34 SL |
813 | } |
814 | ||
f035d41b | 815 | fn lookup_def_id(&self, ref_id: hir::HirId) -> Option<DefId> { |
48663c56 XL |
816 | match self.get_path_res(ref_id) { |
817 | Res::PrimTy(_) | Res::SelfTy(..) | Res::Err => None, | |
74b04a01 | 818 | def => def.opt_def_id(), |
62682a34 SL |
819 | } |
820 | } | |
821 | ||
f035d41b | 822 | fn docs_for_attrs(&self, attrs: &[ast::Attribute]) -> String { |
3b2f2976 XL |
823 | let mut result = String::new(); |
824 | ||
825 | for attr in attrs { | |
dfeec247 | 826 | if let Some(val) = attr.doc_str() { |
3dfed10e | 827 | // FIXME: Should save-analysis beautify doc strings itself or leave it to users? |
a2a8927a | 828 | result.push_str(beautify_doc_string(val).as_str()); |
dfeec247 | 829 | result.push('\n'); |
3b2f2976 XL |
830 | } |
831 | } | |
832 | ||
833 | if !self.config.full_docs { | |
834 | if let Some(index) = result.find("\n\n") { | |
835 | result.truncate(index); | |
836 | } | |
837 | } | |
838 | ||
839 | result | |
c1a9b12d | 840 | } |
2c00a5a8 XL |
841 | |
842 | fn next_impl_id(&self) -> u32 { | |
843 | let next = self.impl_counter.get(); | |
844 | self.impl_counter.set(next + 1); | |
845 | next | |
846 | } | |
d9579d0f | 847 | } |
1a4d82fc | 848 | |
abe05a73 XL |
849 | // An AST visitor for collecting paths (e.g., the names of structs) and formal |
850 | // variables (idents) from patterns. | |
851 | struct PathCollector<'l> { | |
f035d41b XL |
852 | tcx: TyCtxt<'l>, |
853 | collected_paths: Vec<(hir::HirId, &'l hir::QPath<'l>)>, | |
854 | collected_idents: Vec<(hir::HirId, Ident, hir::Mutability)>, | |
d9579d0f | 855 | } |
1a4d82fc | 856 | |
abe05a73 | 857 | impl<'l> PathCollector<'l> { |
f035d41b XL |
858 | fn new(tcx: TyCtxt<'l>) -> PathCollector<'l> { |
859 | PathCollector { tcx, collected_paths: vec![], collected_idents: vec![] } | |
1a4d82fc | 860 | } |
d9579d0f | 861 | } |
1a4d82fc | 862 | |
dc9dc135 | 863 | impl<'l> Visitor<'l> for PathCollector<'l> { |
f035d41b XL |
864 | type Map = Map<'l>; |
865 | ||
866 | fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<Self::Map> { | |
867 | intravisit::NestedVisitorMap::All(self.tcx.hir()) | |
868 | } | |
869 | ||
870 | fn visit_pat(&mut self, p: &'l hir::Pat<'l>) { | |
e74abb32 | 871 | match p.kind { |
f035d41b XL |
872 | hir::PatKind::Struct(ref path, ..) => { |
873 | self.collected_paths.push((p.hir_id, path)); | |
1a4d82fc | 874 | } |
f035d41b XL |
875 | hir::PatKind::TupleStruct(ref path, ..) | hir::PatKind::Path(ref path) => { |
876 | self.collected_paths.push((p.hir_id, path)); | |
1a4d82fc | 877 | } |
f035d41b | 878 | hir::PatKind::Binding(bm, _, ident, _) => { |
abe05a73 XL |
879 | debug!( |
880 | "PathCollector, visit ident in pat {}: {:?} {:?}", | |
dfeec247 | 881 | ident, p.span, ident.span |
abe05a73 | 882 | ); |
1a4d82fc JJ |
883 | let immut = match bm { |
884 | // Even if the ref is mut, you can't change the ref, only | |
885 | // the data pointed at, so showing the initialising expression | |
886 | // is still worthwhile. | |
f035d41b XL |
887 | hir::BindingAnnotation::Unannotated | hir::BindingAnnotation::Ref => { |
888 | hir::Mutability::Not | |
889 | } | |
890 | hir::BindingAnnotation::Mutable | hir::BindingAnnotation::RefMut => { | |
891 | hir::Mutability::Mut | |
892 | } | |
1a4d82fc | 893 | }; |
f035d41b | 894 | self.collected_idents.push((p.hir_id, ident, immut)); |
1a4d82fc | 895 | } |
d9579d0f | 896 | _ => {} |
1a4d82fc | 897 | } |
f035d41b | 898 | intravisit::walk_pat(self, p); |
1a4d82fc JJ |
899 | } |
900 | } | |
901 | ||
cc61c64b XL |
902 | /// Defines what to do with the results of saving the analysis. |
903 | pub trait SaveHandler { | |
f035d41b | 904 | fn save(&mut self, save_ctxt: &SaveContext<'_>, analysis: &Analysis); |
cc61c64b | 905 | } |
9cc50fc6 | 906 | |
cc61c64b XL |
907 | /// Dump the save-analysis results to a file. |
908 | pub struct DumpHandler<'a> { | |
cc61c64b | 909 | odir: Option<&'a Path>, |
abe05a73 | 910 | cratename: String, |
cc61c64b | 911 | } |
1a4d82fc | 912 | |
cc61c64b | 913 | impl<'a> DumpHandler<'a> { |
3b2f2976 | 914 | pub fn new(odir: Option<&'a Path>, cratename: &str) -> DumpHandler<'a> { |
dfeec247 | 915 | DumpHandler { odir, cratename: cratename.to_owned() } |
cc61c64b | 916 | } |
1a4d82fc | 917 | |
f035d41b | 918 | fn output_file(&self, ctx: &SaveContext<'_>) -> (BufWriter<File>, PathBuf) { |
3b2f2976 XL |
919 | let sess = &ctx.tcx.sess; |
920 | let file_name = match ctx.config.output_file { | |
921 | Some(ref s) => PathBuf::from(s), | |
922 | None => { | |
923 | let mut root_path = match self.odir { | |
924 | Some(val) => val.join("save-analysis"), | |
925 | None => PathBuf::from("save-analysis-temp"), | |
926 | }; | |
cc61c64b | 927 | |
3b2f2976 XL |
928 | if let Err(e) = std::fs::create_dir_all(&root_path) { |
929 | error!("Could not create directory {}: {}", root_path.display(), e); | |
930 | } | |
cc61c64b | 931 | |
f9f354fc | 932 | let executable = sess.crate_types().iter().any(|ct| *ct == CrateType::Executable); |
dfeec247 | 933 | let mut out_name = if executable { String::new() } else { "lib".to_owned() }; |
3b2f2976 XL |
934 | out_name.push_str(&self.cratename); |
935 | out_name.push_str(&sess.opts.cg.extra_filename); | |
936 | out_name.push_str(".json"); | |
937 | root_path.push(&out_name); | |
cc61c64b | 938 | |
3b2f2976 XL |
939 | root_path |
940 | } | |
cc61c64b | 941 | }; |
3b2f2976 XL |
942 | |
943 | info!("Writing output to {}", file_name.display()); | |
944 | ||
dfeec247 XL |
945 | let output_file = BufWriter::new(File::create(&file_name).unwrap_or_else(|e| { |
946 | sess.fatal(&format!("Could not open {}: {}", file_name.display(), e)) | |
947 | })); | |
3b2f2976 | 948 | |
dc9dc135 | 949 | (output_file, file_name) |
cc61c64b XL |
950 | } |
951 | } | |
952 | ||
416331ca | 953 | impl SaveHandler for DumpHandler<'_> { |
f035d41b | 954 | fn save(&mut self, save_ctxt: &SaveContext<'_>, analysis: &Analysis) { |
dc9dc135 | 955 | let sess = &save_ctxt.tcx.sess; |
416331ca XL |
956 | let (output, file_name) = self.output_file(&save_ctxt); |
957 | if let Err(e) = serde_json::to_writer(output, &analysis) { | |
958 | error!("Can't serialize save-analysis: {:?}", e); | |
959 | } | |
dc9dc135 | 960 | |
416331ca | 961 | if sess.opts.json_artifact_notifications { |
dfeec247 | 962 | sess.parse_sess.span_diagnostic.emit_artifact_notification(&file_name, "save-analysis"); |
dc9dc135 | 963 | } |
1a4d82fc | 964 | } |
cc61c64b XL |
965 | } |
966 | ||
967 | /// Call a callback with the results of save-analysis. | |
968 | pub struct CallbackHandler<'b> { | |
8faf50e0 | 969 | pub callback: &'b mut dyn FnMut(&rls_data::Analysis), |
cc61c64b XL |
970 | } |
971 | ||
416331ca | 972 | impl SaveHandler for CallbackHandler<'_> { |
f035d41b | 973 | fn save(&mut self, _: &SaveContext<'_>, analysis: &Analysis) { |
416331ca | 974 | (self.callback)(analysis) |
1a4d82fc | 975 | } |
cc61c64b | 976 | } |
1a4d82fc | 977 | |
abe05a73 | 978 | pub fn process_crate<'l, 'tcx, H: SaveHandler>( |
dc9dc135 | 979 | tcx: TyCtxt<'tcx>, |
abe05a73 | 980 | cratename: &str, |
0bf4aa26 | 981 | input: &'l Input, |
abe05a73 XL |
982 | config: Option<Config>, |
983 | mut handler: H, | |
984 | ) { | |
1b1a35ee XL |
985 | with_no_trimmed_paths(|| { |
986 | tcx.dep_graph.with_ignore(|| { | |
987 | info!("Dumping crate {}", cratename); | |
988 | ||
989 | // Privacy checking requires and is done after type checking; use a | |
990 | // fallback in case the access levels couldn't have been correctly computed. | |
991 | let access_levels = match tcx.sess.compile_status() { | |
17df50a5 | 992 | Ok(..) => tcx.privacy_access_levels(()), |
1b1a35ee XL |
993 | Err(..) => tcx.arena.alloc(AccessLevels::default()), |
994 | }; | |
0731742a | 995 | |
1b1a35ee XL |
996 | let save_ctxt = SaveContext { |
997 | tcx, | |
998 | maybe_typeck_results: None, | |
999 | access_levels: &access_levels, | |
1000 | span_utils: SpanUtils::new(&tcx.sess), | |
1001 | config: find_config(config), | |
1002 | impl_counter: Cell::new(0), | |
1003 | }; | |
1a4d82fc | 1004 | |
1b1a35ee | 1005 | let mut visitor = DumpVisitor::new(save_ctxt); |
416331ca | 1006 | |
c295e0f8 | 1007 | visitor.dump_crate_info(cratename); |
1b1a35ee | 1008 | visitor.dump_compilation_options(input, cratename); |
c295e0f8 | 1009 | visitor.process_crate(); |
416331ca | 1010 | |
1b1a35ee XL |
1011 | handler.save(&visitor.save_ctxt, &visitor.analysis()) |
1012 | }) | |
2c00a5a8 | 1013 | }) |
1a4d82fc | 1014 | } |
d9579d0f | 1015 | |
3b2f2976 XL |
1016 | fn find_config(supplied: Option<Config>) -> Config { |
1017 | if let Some(config) = supplied { | |
1018 | return config; | |
1019 | } | |
48663c56 | 1020 | |
3b2f2976 | 1021 | match env::var_os("RUST_SAVE_ANALYSIS_CONFIG") { |
3b2f2976 | 1022 | None => Config::default(), |
dfeec247 XL |
1023 | Some(config) => config |
1024 | .to_str() | |
48663c56 XL |
1025 | .ok_or(()) |
1026 | .map_err(|_| error!("`RUST_SAVE_ANALYSIS_CONFIG` isn't UTF-8")) | |
dfeec247 XL |
1027 | .and_then(|cfg| { |
1028 | serde_json::from_str(cfg) | |
1029 | .map_err(|_| error!("Could not deserialize save-analysis config")) | |
1030 | }) | |
1031 | .unwrap_or_default(), | |
3b2f2976 XL |
1032 | } |
1033 | } | |
1034 | ||
d9579d0f AL |
1035 | // Utility functions for the module. |
1036 | ||
1037 | // Helper function to escape quotes in a string | |
1038 | fn escape(s: String) -> String { | |
a2a8927a | 1039 | s.replace('\"', "\"\"") |
d9579d0f AL |
1040 | } |
1041 | ||
7453a54e SL |
1042 | // Helper function to determine if a span came from a |
1043 | // macro expansion or syntax extension. | |
041b39d2 | 1044 | fn generated_code(span: Span) -> bool { |
e1599b0c | 1045 | span.from_expansion() || span.is_dummy() |
d9579d0f | 1046 | } |
041b39d2 XL |
1047 | |
1048 | // DefId::index is a newtype and so the JSON serialisation is ugly. Therefore | |
1049 | // we use our own Id which is the same, but without the newtype. | |
1050 | fn id_from_def_id(id: DefId) -> rls_data::Id { | |
dfeec247 | 1051 | rls_data::Id { krate: id.krate.as_u32(), index: id.index.as_u32() } |
041b39d2 XL |
1052 | } |
1053 | ||
f035d41b XL |
1054 | fn id_from_hir_id(id: hir::HirId, scx: &SaveContext<'_>) -> rls_data::Id { |
1055 | let def_id = scx.tcx.hir().opt_local_def_id(id); | |
ba9703b0 | 1056 | def_id.map(|id| id_from_def_id(id.to_def_id())).unwrap_or_else(|| { |
f035d41b XL |
1057 | // Create a *fake* `DefId` out of a `HirId` by combining the owner |
1058 | // `local_def_index` and the `local_id`. | |
1059 | // This will work unless you have *billions* of definitions in a single | |
1060 | // crate (very unlikely to actually happen). | |
1061 | rls_data::Id { | |
1062 | krate: LOCAL_CRATE.as_u32(), | |
1063 | index: id.owner.local_def_index.as_u32() | id.local_id.as_u32().reverse_bits(), | |
1064 | } | |
ea8adc8c | 1065 | }) |
041b39d2 XL |
1066 | } |
1067 | ||
1068 | fn null_id() -> rls_data::Id { | |
f035d41b | 1069 | rls_data::Id { krate: u32::MAX, index: u32::MAX } |
041b39d2 XL |
1070 | } |
1071 | ||
f035d41b | 1072 | fn lower_attributes(attrs: Vec<ast::Attribute>, scx: &SaveContext<'_>) -> Vec<rls_data::Attribute> { |
dfeec247 XL |
1073 | attrs |
1074 | .into_iter() | |
1075 | // Only retain real attributes. Doc comments are lowered separately. | |
1076 | .filter(|attr| !attr.has_name(sym::doc)) | |
1077 | .map(|mut attr| { | |
1078 | // Remove the surrounding '#[..]' or '#![..]' of the pretty printed | |
1079 | // attribute. First normalize all inner attribute (#![..]) to outer | |
1080 | // ones (#[..]), then remove the two leading and the one trailing character. | |
1081 | attr.style = ast::AttrStyle::Outer; | |
f035d41b | 1082 | let value = attribute_to_string(&attr); |
dfeec247 XL |
1083 | // This str slicing works correctly, because the leading and trailing characters |
1084 | // are in the ASCII range and thus exactly one byte each. | |
1085 | let value = value[2..value.len() - 1].to_string(); | |
1086 | ||
1087 | rls_data::Attribute { value, span: scx.span_from_span(attr.span) } | |
1088 | }) | |
1089 | .collect() | |
041b39d2 | 1090 | } |