1 //! Write the output of rustc's analysis to an implementor of Dump.
3 //! Dumping the analysis is implemented by walking the AST and getting a bunch of
4 //! info out from all over the place. We use `DefId`s to identify objects. The
5 //! tricky part is getting syntactic (span, source text) and semantic (reference
6 //! `DefId`s) information for parts of expressions which the compiler has discarded.
7 //! E.g., in a path `foo::bar::baz`, the compiler only keeps a span for the whole
8 //! path and a reference to `baz`, but we want spans and references for all three
11 //! SpanUtils is used to manipulate spans. In particular, to extract sub-spans
12 //! from spans (e.g., the span for `bar` from the above example path).
13 //! DumpVisitor walks the AST and processes it, and Dumper is used for
14 //! recording the output.
17 use rustc_ast::walk_list;
18 use rustc_data_structures::fx::FxHashSet;
20 use rustc_hir::def::{DefKind as HirDefKind, Res};
21 use rustc_hir::def_id::{DefId, LocalDefId};
22 use rustc_hir::intravisit::{self, Visitor};
23 use rustc_hir_pretty::{bounds_to_string, fn_to_string, generic_params_to_string, ty_to_string};
24 use rustc_middle::hir::map::Map;
25 use rustc_middle::span_bug;
26 use rustc_middle::ty::{self, DefIdTree, TyCtxt};
27 use rustc_session::config::Input;
28 use rustc_span::source_map::respan;
29 use rustc_span::symbol::Ident;
35 use crate::dumper::{Access, Dumper};
37 use crate::span_utils::SpanUtils;
39 escape, generated_code, id_from_def_id, id_from_hir_id, lower_attributes, PathCollector,
44 CompilationOptions, CratePreludeData, Def, DefKind, GlobalCrateId, Import, ImportKind, Ref,
45 RefKind, Relation, RelationKind, SpanData,
48 use tracing::{debug, error};
50 macro_rules! down_cast_data {
51 ($id:ident, $kind:ident, $sp:expr) => {
52 let $id = if let super::Data::$kind(data) = $id {
55 span_bug!($sp, "unexpected data kind: {:?}", $id);
60 macro_rules! access_from {
61 ($save_ctxt:expr, $item:expr, $id:expr) => {
63 public: $item.vis.node.is_pub(),
64 reachable: $save_ctxt.access_levels.is_reachable($id),
69 macro_rules! access_from_vis {
70 ($save_ctxt:expr, $vis:expr, $id:expr) => {
71 Access { public: $vis.node.is_pub(), reachable: $save_ctxt.access_levels.is_reachable($id) }
75 pub struct DumpVisitor<'tcx> {
76 pub save_ctxt: SaveContext<'tcx>,
80 span: SpanUtils<'tcx>,
81 // Set of macro definition (callee) spans, and the set
82 // of macro use (callsite) spans. We store these to ensure
83 // we only write one macro def per unique macro definition, and
84 // one macro use per unique callsite span.
85 // mac_defs: FxHashSet<Span>,
86 // macro_calls: FxHashSet<Span>,
89 impl<'tcx> DumpVisitor<'tcx> {
90 pub fn new(save_ctxt: SaveContext<'tcx>) -> DumpVisitor<'tcx> {
91 let span_utils = SpanUtils::new(&save_ctxt.tcx.sess);
92 let dumper = Dumper::new(save_ctxt.config.clone());
98 // mac_defs: FxHashSet::default(),
99 // macro_calls: FxHashSet::default(),
103 pub fn analysis(&self) -> &rls_data::Analysis {
104 self.dumper.analysis()
107 fn nest_typeck_results<F>(&mut self, item_def_id: LocalDefId, f: F)
109 F: FnOnce(&mut Self),
111 let typeck_results = if self.tcx.has_typeck_results(item_def_id) {
112 Some(self.tcx.typeck(item_def_id))
117 let old_maybe_typeck_results = self.save_ctxt.maybe_typeck_results;
118 self.save_ctxt.maybe_typeck_results = typeck_results;
120 self.save_ctxt.maybe_typeck_results = old_maybe_typeck_results;
123 fn span_from_span(&self, span: Span) -> SpanData {
124 self.save_ctxt.span_from_span(span)
127 fn lookup_def_id(&self, ref_id: hir::HirId) -> Option<DefId> {
128 self.save_ctxt.lookup_def_id(ref_id)
131 pub fn dump_crate_info(&mut self, name: &str, krate: &hir::Crate<'_>) {
132 let source_file = self.tcx.sess.local_crate_source_file.as_ref();
133 let crate_root = source_file.map(|source_file| {
134 let source_file = Path::new(source_file);
135 match source_file.file_name() {
136 Some(_) => source_file.parent().unwrap().display(),
137 None => source_file.display(),
142 let data = CratePreludeData {
143 crate_id: GlobalCrateId {
148 .local_crate_disambiguator()
152 crate_root: crate_root.unwrap_or_else(|| "<no source>".to_owned()),
153 external_crates: self.save_ctxt.get_external_crates(),
154 span: self.span_from_span(krate.item.inner),
157 self.dumper.crate_prelude(data);
160 pub fn dump_compilation_options(&mut self, input: &Input, crate_name: &str) {
161 // Apply possible `remap-path-prefix` remapping to the input source file
162 // (and don't include remapping args anymore)
163 let (program, arguments) = {
164 let remap_arg_indices = {
165 let mut indices = FxHashSet::default();
166 // Args are guaranteed to be valid UTF-8 (checked early)
167 for (i, e) in env::args().enumerate() {
168 if e.starts_with("--remap-path-prefix=") {
170 } else if e == "--remap-path-prefix" {
172 indices.insert(i + 1);
178 let mut args = env::args()
180 .filter(|(i, _)| !remap_arg_indices.contains(i))
181 .map(|(_, arg)| match input {
182 Input::File(ref path) if path == Path::new(&arg) => {
183 let mapped = &self.tcx.sess.local_crate_source_file;
184 mapped.as_ref().unwrap().to_string_lossy().into()
189 (args.next().unwrap(), args.collect())
192 let data = CompilationOptions {
193 directory: self.tcx.sess.working_dir.remapped_path_if_available().into(),
196 output: self.save_ctxt.compilation_output(crate_name),
199 self.dumper.compilation_opts(data);
202 fn write_segments(&mut self, segments: impl IntoIterator<Item = &'tcx hir::PathSegment<'tcx>>) {
203 for seg in segments {
204 if let Some(data) = self.save_ctxt.get_path_segment_data(seg) {
205 self.dumper.dump_ref(data);
210 fn write_sub_paths(&mut self, path: &'tcx hir::Path<'tcx>) {
211 self.write_segments(path.segments)
214 // As write_sub_paths, but does not process the last ident in the path (assuming it
215 // will be processed elsewhere). See note on write_sub_paths about global.
216 fn write_sub_paths_truncated(&mut self, path: &'tcx hir::Path<'tcx>) {
217 if let [segments @ .., _] = path.segments {
218 self.write_segments(segments)
222 fn process_formals(&mut self, formals: &'tcx [hir::Param<'tcx>], qualname: &str) {
224 self.visit_pat(&arg.pat);
225 let mut collector = PathCollector::new(self.tcx);
226 collector.visit_pat(&arg.pat);
228 for (hir_id, ident, ..) in collector.collected_idents {
229 let typ = match self.save_ctxt.typeck_results().node_type_opt(hir_id) {
230 Some(s) => s.to_string(),
233 if !self.span.filter_generated(ident.span) {
234 let id = id_from_hir_id(hir_id, &self.save_ctxt);
235 let span = self.span_from_span(ident.span);
237 self.dumper.dump_def(
238 &Access { public: false, reachable: false },
240 kind: DefKind::Local,
243 name: ident.to_string(),
244 qualname: format!("{}::{}", qualname, ident.to_string()),
261 sig: &'tcx hir::FnSig<'tcx>,
262 body: Option<hir::BodyId>,
265 generics: &'tcx hir::Generics<'tcx>,
266 vis: &hir::Visibility<'tcx>,
269 debug!("process_method: {}:{}", hir_id, ident);
271 let map = &self.tcx.hir();
272 self.nest_typeck_results(map.local_def_id(hir_id), |v| {
273 if let Some(mut method_data) = v.save_ctxt.get_method_data(hir_id, ident, span) {
274 if let Some(body) = body {
275 v.process_formals(map.body(body).params, &method_data.qualname);
277 v.process_generic_params(&generics, &method_data.qualname, hir_id);
280 fn_to_string(sig.decl, sig.header, Some(ident.name), generics, vis, &[], None);
281 method_data.sig = sig::method_signature(hir_id, ident, generics, sig, &v.save_ctxt);
283 v.dumper.dump_def(&access_from_vis!(v.save_ctxt, vis, hir_id), method_data);
286 // walk arg and return types
287 for arg in sig.decl.inputs {
291 if let hir::FnRetTy::Return(ref ret_ty) = sig.decl.output {
296 if let Some(body) = body {
297 v.visit_expr(&map.body(body).value);
302 fn process_struct_field_def(
304 field: &'tcx hir::FieldDef<'tcx>,
305 parent_id: hir::HirId,
307 let field_data = self.save_ctxt.get_field_data(field, parent_id);
308 if let Some(field_data) = field_data {
309 self.dumper.dump_def(&access_from!(self.save_ctxt, field, field.hir_id), field_data);
313 // Dump generic params bindings, then visit_generics
314 fn process_generic_params(
316 generics: &'tcx hir::Generics<'tcx>,
320 for param in generics.params {
322 hir::GenericParamKind::Lifetime { .. } => {}
323 hir::GenericParamKind::Type { .. } => {
324 let param_ss = param.name.ident().span;
325 let name = escape(self.span.snippet(param_ss));
326 // Append $id to name to make sure each one is unique.
327 let qualname = format!("{}::{}${}", prefix, name, id);
328 if !self.span.filter_generated(param_ss) {
329 let id = id_from_hir_id(param.hir_id, &self.save_ctxt);
330 let span = self.span_from_span(param_ss);
332 self.dumper.dump_def(
333 &Access { public: false, reachable: false },
340 value: String::new(),
351 hir::GenericParamKind::Const { .. } => {}
355 self.visit_generics(generics)
360 item: &'tcx hir::Item<'tcx>,
361 decl: &'tcx hir::FnDecl<'tcx>,
362 _header: &'tcx hir::FnHeader,
363 ty_params: &'tcx hir::Generics<'tcx>,
366 let map = &self.tcx.hir();
367 self.nest_typeck_results(item.def_id, |v| {
368 let body = map.body(body);
369 if let Some(fn_data) = v.save_ctxt.get_item_data(item) {
370 down_cast_data!(fn_data, DefData, item.span);
371 v.process_formals(body.params, &fn_data.qualname);
372 v.process_generic_params(ty_params, &fn_data.qualname, item.hir_id());
374 v.dumper.dump_def(&access_from!(v.save_ctxt, item, item.hir_id()), fn_data);
377 for arg in decl.inputs {
381 if let hir::FnRetTy::Return(ref ret_ty) = decl.output {
385 v.visit_expr(&body.value);
389 fn process_static_or_const_item(
391 item: &'tcx hir::Item<'tcx>,
392 typ: &'tcx hir::Ty<'tcx>,
393 expr: &'tcx hir::Expr<'tcx>,
395 self.nest_typeck_results(item.def_id, |v| {
396 if let Some(var_data) = v.save_ctxt.get_item_data(item) {
397 down_cast_data!(var_data, DefData, item.span);
398 v.dumper.dump_def(&access_from!(v.save_ctxt, item, item.hir_id()), var_data);
405 fn process_assoc_const(
409 typ: &'tcx hir::Ty<'tcx>,
410 expr: Option<&'tcx hir::Expr<'tcx>>,
412 vis: &hir::Visibility<'tcx>,
413 attrs: &'tcx [ast::Attribute],
416 format!("::{}", self.tcx.def_path_str(self.tcx.hir().local_def_id(hir_id).to_def_id()));
418 if !self.span.filter_generated(ident.span) {
419 let sig = sig::assoc_const_signature(hir_id, ident.name, typ, expr, &self.save_ctxt);
420 let span = self.span_from_span(ident.span);
422 self.dumper.dump_def(
423 &access_from_vis!(self.save_ctxt, vis, hir_id),
425 kind: DefKind::Const,
426 id: id_from_hir_id(hir_id, &self.save_ctxt),
428 name: ident.name.to_string(),
430 value: ty_to_string(&typ),
431 parent: Some(id_from_def_id(parent_id)),
434 docs: self.save_ctxt.docs_for_attrs(attrs),
436 attributes: lower_attributes(attrs.to_owned(), &self.save_ctxt),
441 // walk type and init value
442 self.nest_typeck_results(self.tcx.hir().local_def_id(hir_id), |v| {
444 if let Some(expr) = expr {
450 // FIXME tuple structs should generate tuple-specific data.
453 item: &'tcx hir::Item<'tcx>,
454 def: &'tcx hir::VariantData<'tcx>,
455 ty_params: &'tcx hir::Generics<'tcx>,
457 debug!("process_struct {:?} {:?}", item, item.span);
458 let name = item.ident.to_string();
459 let qualname = format!("::{}", self.tcx.def_path_str(item.def_id.to_def_id()));
461 let kind = match item.kind {
462 hir::ItemKind::Struct(_, _) => DefKind::Struct,
463 hir::ItemKind::Union(_, _) => DefKind::Union,
467 let (value, fields) = match item.kind {
468 hir::ItemKind::Struct(hir::VariantData::Struct(ref fields, ..), ..)
469 | hir::ItemKind::Union(hir::VariantData::Struct(ref fields, ..), ..) => {
470 let include_priv_fields = !self.save_ctxt.config.pub_only;
471 let fields_str = fields
474 if include_priv_fields || f.vis.node.is_pub() {
475 Some(f.ident.to_string())
482 let value = format!("{} {{ {} }}", name, fields_str);
483 (value, fields.iter().map(|f| id_from_hir_id(f.hir_id, &self.save_ctxt)).collect())
485 _ => (String::new(), vec![]),
488 if !self.span.filter_generated(item.ident.span) {
489 let span = self.span_from_span(item.ident.span);
490 let attrs = self.tcx.hir().attrs(item.hir_id());
491 self.dumper.dump_def(
492 &access_from!(self.save_ctxt, item, item.hir_id()),
495 id: id_from_def_id(item.def_id.to_def_id()),
498 qualname: qualname.clone(),
503 docs: self.save_ctxt.docs_for_attrs(attrs),
504 sig: sig::item_signature(item, &self.save_ctxt),
505 attributes: lower_attributes(attrs.to_vec(), &self.save_ctxt),
510 self.nest_typeck_results(item.def_id, |v| {
511 for field in def.fields() {
512 v.process_struct_field_def(field, item.hir_id());
513 v.visit_ty(&field.ty);
516 v.process_generic_params(ty_params, &qualname, item.hir_id());
522 item: &'tcx hir::Item<'tcx>,
523 enum_definition: &'tcx hir::EnumDef<'tcx>,
524 ty_params: &'tcx hir::Generics<'tcx>,
526 let enum_data = self.save_ctxt.get_item_data(item);
527 let enum_data = match enum_data {
531 down_cast_data!(enum_data, DefData, item.span);
533 let access = access_from!(self.save_ctxt, item, item.hir_id());
535 for variant in enum_definition.variants {
536 let name = variant.ident.name.to_string();
537 let qualname = format!("{}::{}", enum_data.qualname, name);
538 let name_span = variant.ident.span;
541 hir::VariantData::Struct(ref fields, ..) => {
543 fields.iter().map(|f| f.ident.to_string()).collect::<Vec<_>>().join(", ");
544 let value = format!("{}::{} {{ {} }}", enum_data.name, name, fields_str);
545 if !self.span.filter_generated(name_span) {
546 let span = self.span_from_span(name_span);
547 let id = id_from_hir_id(variant.id, &self.save_ctxt);
548 let parent = Some(id_from_def_id(item.def_id.to_def_id()));
549 let attrs = self.tcx.hir().attrs(variant.id);
551 self.dumper.dump_def(
554 kind: DefKind::StructVariant,
563 docs: self.save_ctxt.docs_for_attrs(attrs),
564 sig: sig::variant_signature(variant, &self.save_ctxt),
565 attributes: lower_attributes(attrs.to_vec(), &self.save_ctxt),
571 let mut value = format!("{}::{}", enum_data.name, name);
572 if let hir::VariantData::Tuple(fields, _) = v {
577 .map(|f| ty_to_string(&f.ty))
583 if !self.span.filter_generated(name_span) {
584 let span = self.span_from_span(name_span);
585 let id = id_from_hir_id(variant.id, &self.save_ctxt);
586 let parent = Some(id_from_def_id(item.def_id.to_def_id()));
587 let attrs = self.tcx.hir().attrs(variant.id);
589 self.dumper.dump_def(
592 kind: DefKind::TupleVariant,
601 docs: self.save_ctxt.docs_for_attrs(attrs),
602 sig: sig::variant_signature(variant, &self.save_ctxt),
603 attributes: lower_attributes(attrs.to_vec(), &self.save_ctxt),
610 for field in variant.data.fields() {
611 self.process_struct_field_def(field, variant.id);
612 self.visit_ty(field.ty);
615 self.process_generic_params(ty_params, &enum_data.qualname, item.hir_id());
616 self.dumper.dump_def(&access, enum_data);
619 fn process_impl(&mut self, item: &'tcx hir::Item<'tcx>, impl_: &'tcx hir::Impl<'tcx>) {
620 if let Some(impl_data) = self.save_ctxt.get_item_data(item) {
621 if !self.span.filter_generated(item.span) {
622 if let super::Data::RelationData(rel, imp) = impl_data {
623 self.dumper.dump_relation(rel);
624 self.dumper.dump_impl(imp);
626 span_bug!(item.span, "unexpected data kind: {:?}", impl_data);
631 let map = &self.tcx.hir();
632 self.nest_typeck_results(item.def_id, |v| {
633 v.visit_ty(&impl_.self_ty);
634 if let Some(trait_ref) = &impl_.of_trait {
635 v.process_path(trait_ref.hir_ref_id, &hir::QPath::Resolved(None, &trait_ref.path));
637 v.process_generic_params(&impl_.generics, "", item.hir_id());
638 for impl_item in impl_.items {
639 v.process_impl_item(map.impl_item(impl_item.id), item.def_id.to_def_id());
646 item: &'tcx hir::Item<'tcx>,
647 generics: &'tcx hir::Generics<'tcx>,
648 trait_refs: hir::GenericBounds<'tcx>,
649 methods: &'tcx [hir::TraitItemRef],
651 let name = item.ident.to_string();
652 let qualname = format!("::{}", self.tcx.def_path_str(item.def_id.to_def_id()));
653 let mut val = name.clone();
654 if !generics.params.is_empty() {
655 val.push_str(&generic_params_to_string(generics.params));
657 if !trait_refs.is_empty() {
659 val.push_str(&bounds_to_string(trait_refs));
661 if !self.span.filter_generated(item.ident.span) {
662 let id = id_from_def_id(item.def_id.to_def_id());
663 let span = self.span_from_span(item.ident.span);
665 methods.iter().map(|i| id_from_def_id(i.id.def_id.to_def_id())).collect();
666 let attrs = self.tcx.hir().attrs(item.hir_id());
667 self.dumper.dump_def(
668 &access_from!(self.save_ctxt, item, item.hir_id()),
670 kind: DefKind::Trait,
674 qualname: qualname.clone(),
679 docs: self.save_ctxt.docs_for_attrs(attrs),
680 sig: sig::item_signature(item, &self.save_ctxt),
681 attributes: lower_attributes(attrs.to_vec(), &self.save_ctxt),
687 for super_bound in trait_refs.iter() {
688 let (def_id, sub_span) = match *super_bound {
689 hir::GenericBound::Trait(ref trait_ref, _) => (
690 self.lookup_def_id(trait_ref.trait_ref.hir_ref_id),
691 trait_ref.trait_ref.path.segments.last().unwrap().ident.span,
693 hir::GenericBound::LangItemTrait(lang_item, span, _, _) => {
694 (Some(self.tcx.require_lang_item(lang_item, Some(span))), span)
696 hir::GenericBound::Outlives(..) => continue,
699 if let Some(id) = def_id {
700 if !self.span.filter_generated(sub_span) {
701 let span = self.span_from_span(sub_span);
702 self.dumper.dump_ref(Ref {
705 ref_id: id_from_def_id(id),
708 self.dumper.dump_relation(Relation {
709 kind: RelationKind::SuperTrait,
711 from: id_from_def_id(id),
712 to: id_from_def_id(item.def_id.to_def_id()),
718 // walk generics and methods
719 self.process_generic_params(generics, &qualname, item.hir_id());
720 for method in methods {
721 let map = &self.tcx.hir();
722 self.process_trait_item(map.trait_item(method.id), item.def_id.to_def_id())
726 // `item` is the module in question, represented as an( item.
727 fn process_mod(&mut self, item: &'tcx hir::Item<'tcx>) {
728 if let Some(mod_data) = self.save_ctxt.get_item_data(item) {
729 down_cast_data!(mod_data, DefData, item.span);
730 self.dumper.dump_def(&access_from!(self.save_ctxt, item, item.hir_id()), mod_data);
734 fn dump_path_ref(&mut self, id: hir::HirId, path: &hir::QPath<'tcx>) {
735 let path_data = self.save_ctxt.get_path_data(id, path);
736 if let Some(path_data) = path_data {
737 self.dumper.dump_ref(path_data);
741 fn dump_path_segment_ref(&mut self, id: hir::HirId, segment: &hir::PathSegment<'tcx>) {
742 let segment_data = self.save_ctxt.get_path_segment_data_with_id(segment, id);
743 if let Some(segment_data) = segment_data {
744 self.dumper.dump_ref(segment_data);
748 fn process_path(&mut self, id: hir::HirId, path: &hir::QPath<'tcx>) {
749 if self.span.filter_generated(path.span()) {
752 self.dump_path_ref(id, path);
755 let segments = match path {
756 hir::QPath::Resolved(ty, path) => {
757 if let Some(ty) = ty {
762 hir::QPath::TypeRelative(ty, segment) => {
764 std::slice::from_ref(*segment)
766 hir::QPath::LangItem(..) => return,
768 for seg in segments {
769 if let Some(ref generic_args) = seg.args {
770 for arg in generic_args.args {
771 if let hir::GenericArg::Type(ref ty) = arg {
778 if let hir::QPath::Resolved(_, path) = path {
779 self.write_sub_paths_truncated(path);
783 fn process_struct_lit(
785 ex: &'tcx hir::Expr<'tcx>,
786 path: &'tcx hir::QPath<'tcx>,
787 fields: &'tcx [hir::ExprField<'tcx>],
788 variant: &'tcx ty::VariantDef,
789 rest: Option<&'tcx hir::Expr<'tcx>>,
791 if let Some(struct_lit_data) = self.save_ctxt.get_expr_data(ex) {
792 if let hir::QPath::Resolved(_, path) = path {
793 self.write_sub_paths_truncated(path);
795 down_cast_data!(struct_lit_data, RefData, ex.span);
796 if !generated_code(ex.span) {
797 self.dumper.dump_ref(struct_lit_data);
800 for field in fields {
801 if let Some(field_data) = self.save_ctxt.get_field_ref_data(field, variant) {
802 self.dumper.dump_ref(field_data);
805 self.visit_expr(&field.expr)
809 if let Some(base) = rest {
810 self.visit_expr(&base);
814 fn process_method_call(
816 ex: &'tcx hir::Expr<'tcx>,
817 seg: &'tcx hir::PathSegment<'tcx>,
818 args: &'tcx [hir::Expr<'tcx>],
820 debug!("process_method_call {:?} {:?}", ex, ex.span);
821 if let Some(mcd) = self.save_ctxt.get_expr_data(ex) {
822 down_cast_data!(mcd, RefData, ex.span);
823 if !generated_code(ex.span) {
824 self.dumper.dump_ref(mcd);
828 // Explicit types in the turbo-fish.
829 if let Some(generic_args) = seg.args {
830 for arg in generic_args.args {
831 if let hir::GenericArg::Type(ty) = arg {
837 // walk receiver and args
838 walk_list!(self, visit_expr, args);
841 fn process_pat(&mut self, p: &'tcx hir::Pat<'tcx>) {
843 hir::PatKind::Struct(ref _path, fields, _) => {
844 // FIXME do something with _path?
845 let adt = match self.save_ctxt.typeck_results().node_type_opt(p.hir_id) {
846 Some(ty) if ty.ty_adt_def().is_some() => ty.ty_adt_def().unwrap(),
848 intravisit::walk_pat(self, p);
852 let variant = adt.variant_of_res(self.save_ctxt.get_path_res(p.hir_id));
854 for field in fields {
855 if let Some(index) = self.tcx.find_field_index(field.ident, variant) {
856 if !self.span.filter_generated(field.ident.span) {
857 let span = self.span_from_span(field.ident.span);
858 self.dumper.dump_ref(Ref {
859 kind: RefKind::Variable,
861 ref_id: id_from_def_id(variant.fields[index].did),
865 self.visit_pat(&field.pat);
868 _ => intravisit::walk_pat(self, p),
872 fn process_var_decl(&mut self, pat: &'tcx hir::Pat<'tcx>) {
873 // The pattern could declare multiple new vars,
874 // we must walk the pattern and collect them all.
875 let mut collector = PathCollector::new(self.tcx);
876 collector.visit_pat(&pat);
877 self.visit_pat(&pat);
879 // Process collected paths.
880 for (id, ident, _) in collector.collected_idents {
881 let res = self.save_ctxt.get_path_res(id);
883 Res::Local(hir_id) => {
887 .node_type_opt(hir_id)
888 .map(|t| t.to_string())
889 .unwrap_or_default();
891 // Rust uses the id of the pattern for var lookups, so we'll use it too.
892 if !self.span.filter_generated(ident.span) {
893 let qualname = format!("{}${}", ident.to_string(), hir_id);
894 let id = id_from_hir_id(hir_id, &self.save_ctxt);
895 let span = self.span_from_span(ident.span);
897 self.dumper.dump_def(
898 &Access { public: false, reachable: false },
900 kind: DefKind::Local,
903 name: ident.to_string(),
919 | HirDefKind::AssocConst
921 | HirDefKind::Variant
922 | HirDefKind::TyAlias
923 | HirDefKind::AssocTy,
926 | Res::SelfTy(..) => {
927 self.dump_path_segment_ref(id, &hir::PathSegment::from_ident(ident));
930 error!("unexpected definition kind when processing collected idents: {:?}", def)
935 for (id, ref path) in collector.collected_paths {
936 self.process_path(id, path);
940 /// Extracts macro use and definition information from the AST node defined
941 /// by the given NodeId, using the expansion information from the node's
944 /// If the span is not macro-generated, do nothing, else use callee and
945 /// callsite spans to record macro definition and use data, using the
946 /// mac_uses and mac_defs sets to prevent multiples.
947 fn process_macro_use(&mut self, _span: Span) {
948 // FIXME if we're not dumping the defs (see below), there is no point
949 // dumping refs either.
950 // let source_span = span.source_callsite();
951 // if !self.macro_calls.insert(source_span) {
955 // let data = match self.save_ctxt.get_macro_use_data(span) {
957 // Some(data) => data,
960 // self.dumper.macro_use(data);
962 // FIXME write the macro def
963 // let mut hasher = DefaultHasher::new();
964 // data.callee_span.hash(&mut hasher);
965 // let hash = hasher.finish();
966 // let qualname = format!("{}::{}", data.name, hash);
967 // Don't write macro definition for imported macros
968 // if !self.mac_defs.contains(&data.callee_span)
969 // && !data.imported {
970 // self.mac_defs.insert(data.callee_span);
971 // if let Some(sub_span) = self.span.span_for_macro_def_name(data.callee_span) {
972 // self.dumper.macro_data(MacroData {
974 // name: data.name.clone(),
975 // qualname: qualname.clone(),
976 // // FIXME where do macro docs come from?
977 // docs: String::new(),
978 // }.lower(self.tcx));
983 fn process_trait_item(&mut self, trait_item: &'tcx hir::TraitItem<'tcx>, trait_id: DefId) {
984 self.process_macro_use(trait_item.span);
985 let vis_span = trait_item.span.shrink_to_lo();
986 match trait_item.kind {
987 hir::TraitItemKind::Const(ref ty, body) => {
988 let body = body.map(|b| &self.tcx.hir().body(b).value);
989 let respan = respan(vis_span, hir::VisibilityKind::Public);
990 let attrs = self.tcx.hir().attrs(trait_item.hir_id());
991 self.process_assoc_const(
1001 hir::TraitItemKind::Fn(ref sig, ref trait_fn) => {
1003 if let hir::TraitFn::Provided(body) = trait_fn { Some(*body) } else { None };
1004 let respan = respan(vis_span, hir::VisibilityKind::Public);
1005 self.process_method(
1008 trait_item.hir_id(),
1010 &trait_item.generics,
1015 hir::TraitItemKind::Type(ref bounds, ref default_ty) => {
1016 // FIXME do something with _bounds (for type refs)
1017 let name = trait_item.ident.name.to_string();
1019 format!("::{}", self.tcx.def_path_str(trait_item.def_id.to_def_id()));
1021 if !self.span.filter_generated(trait_item.ident.span) {
1022 let span = self.span_from_span(trait_item.ident.span);
1023 let id = id_from_def_id(trait_item.def_id.to_def_id());
1024 let attrs = self.tcx.hir().attrs(trait_item.hir_id());
1026 self.dumper.dump_def(
1027 &Access { public: true, reachable: true },
1029 kind: DefKind::Type,
1034 value: self.span.snippet(trait_item.span),
1035 parent: Some(id_from_def_id(trait_id)),
1038 docs: self.save_ctxt.docs_for_attrs(attrs),
1039 sig: sig::assoc_type_signature(
1040 trait_item.hir_id(),
1043 default_ty.as_ref().map(|ty| &**ty),
1046 attributes: lower_attributes(attrs.to_vec(), &self.save_ctxt),
1051 if let Some(default_ty) = default_ty {
1052 self.visit_ty(default_ty)
1058 fn process_impl_item(&mut self, impl_item: &'tcx hir::ImplItem<'tcx>, impl_id: DefId) {
1059 self.process_macro_use(impl_item.span);
1060 match impl_item.kind {
1061 hir::ImplItemKind::Const(ref ty, body) => {
1062 let body = self.tcx.hir().body(body);
1063 let attrs = self.tcx.hir().attrs(impl_item.hir_id());
1064 self.process_assoc_const(
1074 hir::ImplItemKind::Fn(ref sig, body) => {
1075 self.process_method(
1080 &impl_item.generics,
1085 hir::ImplItemKind::TyAlias(ref ty) => {
1086 // FIXME: uses of the assoc type should ideally point to this
1087 // 'def' and the name here should be a ref to the def in the
1094 pub(crate) fn process_crate(&mut self, krate: &'tcx hir::Crate<'tcx>) {
1095 let id = hir::CRATE_HIR_ID;
1097 format!("::{}", self.tcx.def_path_str(self.tcx.hir().local_def_id(id).to_def_id()));
1099 let sm = self.tcx.sess.source_map();
1100 let filename = sm.span_to_filename(krate.item.inner);
1101 let data_id = id_from_hir_id(id, &self.save_ctxt);
1103 krate.item.item_ids.iter().map(|i| id_from_def_id(i.def_id.to_def_id())).collect();
1104 let span = self.span_from_span(krate.item.inner);
1105 let attrs = self.tcx.hir().attrs(id);
1107 self.dumper.dump_def(
1108 &Access { public: true, reachable: true },
1112 name: String::new(),
1115 value: filename.to_string(),
1119 docs: self.save_ctxt.docs_for_attrs(attrs),
1121 attributes: lower_attributes(attrs.to_owned(), &self.save_ctxt),
1124 intravisit::walk_crate(self, krate);
1127 fn process_bounds(&mut self, bounds: hir::GenericBounds<'tcx>) {
1128 for bound in bounds {
1129 if let hir::GenericBound::Trait(ref trait_ref, _) = *bound {
1131 trait_ref.trait_ref.hir_ref_id,
1132 &hir::QPath::Resolved(None, &trait_ref.trait_ref.path),
1139 impl<'tcx> Visitor<'tcx> for DumpVisitor<'tcx> {
1140 type Map = Map<'tcx>;
1142 fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<Self::Map> {
1143 intravisit::NestedVisitorMap::All(self.tcx.hir())
1146 fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) {
1147 self.process_macro_use(item.span);
1149 hir::ItemKind::Use(path, hir::UseKind::Single) => {
1150 let sub_span = path.segments.last().unwrap().ident.span;
1151 if !self.span.filter_generated(sub_span) {
1152 let access = access_from!(self.save_ctxt, item, item.hir_id());
1153 let ref_id = self.lookup_def_id(item.hir_id()).map(id_from_def_id);
1154 let span = self.span_from_span(sub_span);
1156 self.save_ctxt.tcx.parent(item.def_id.to_def_id()).map(id_from_def_id);
1160 kind: ImportKind::Use,
1164 name: item.ident.to_string(),
1165 value: String::new(),
1169 self.write_sub_paths_truncated(&path);
1172 hir::ItemKind::Use(path, hir::UseKind::Glob) => {
1173 // Make a comma-separated list of names of imported modules.
1174 let names = self.tcx.names_imported_by_glob_use(item.def_id);
1175 let names: Vec<_> = names.iter().map(|n| n.to_string()).collect();
1177 // Otherwise it's a span with wrong macro expansion info, which
1178 // we don't want to track anyway, since it's probably macro-internal `use`
1179 if let Some(sub_span) = self.span.sub_span_of_star(item.span) {
1180 if !self.span.filter_generated(item.span) {
1181 let access = access_from!(self.save_ctxt, item, item.hir_id());
1182 let span = self.span_from_span(sub_span);
1184 self.save_ctxt.tcx.parent(item.def_id.to_def_id()).map(id_from_def_id);
1188 kind: ImportKind::GlobUse,
1192 name: "*".to_owned(),
1193 value: names.join(", "),
1197 self.write_sub_paths(&path);
1201 hir::ItemKind::ExternCrate(_) => {
1202 let name_span = item.ident.span;
1203 if !self.span.filter_generated(name_span) {
1204 let span = self.span_from_span(name_span);
1206 self.save_ctxt.tcx.parent(item.def_id.to_def_id()).map(id_from_def_id);
1208 &Access { public: false, reachable: false },
1210 kind: ImportKind::ExternCrate,
1214 name: item.ident.to_string(),
1215 value: String::new(),
1221 hir::ItemKind::Fn(ref sig, ref ty_params, body) => {
1222 self.process_fn(item, sig.decl, &sig.header, ty_params, body)
1224 hir::ItemKind::Static(ref typ, _, body) => {
1225 let body = self.tcx.hir().body(body);
1226 self.process_static_or_const_item(item, typ, &body.value)
1228 hir::ItemKind::Const(ref typ, body) => {
1229 let body = self.tcx.hir().body(body);
1230 self.process_static_or_const_item(item, typ, &body.value)
1232 hir::ItemKind::Struct(ref def, ref ty_params)
1233 | hir::ItemKind::Union(ref def, ref ty_params) => {
1234 self.process_struct(item, def, ty_params)
1236 hir::ItemKind::Enum(ref def, ref ty_params) => self.process_enum(item, def, ty_params),
1237 hir::ItemKind::Impl(ref impl_) => self.process_impl(item, impl_),
1238 hir::ItemKind::Trait(_, _, ref generics, ref trait_refs, methods) => {
1239 self.process_trait(item, generics, trait_refs, methods)
1241 hir::ItemKind::Mod(ref m) => {
1242 self.process_mod(item);
1243 intravisit::walk_mod(self, m, item.hir_id());
1245 hir::ItemKind::TyAlias(ty, ref generics) => {
1246 let qualname = format!("::{}", self.tcx.def_path_str(item.def_id.to_def_id()));
1247 let value = ty_to_string(&ty);
1248 if !self.span.filter_generated(item.ident.span) {
1249 let span = self.span_from_span(item.ident.span);
1250 let id = id_from_def_id(item.def_id.to_def_id());
1251 let attrs = self.tcx.hir().attrs(item.hir_id());
1253 self.dumper.dump_def(
1254 &access_from!(self.save_ctxt, item, item.hir_id()),
1256 kind: DefKind::Type,
1259 name: item.ident.to_string(),
1260 qualname: qualname.clone(),
1265 docs: self.save_ctxt.docs_for_attrs(attrs),
1266 sig: sig::item_signature(item, &self.save_ctxt),
1267 attributes: lower_attributes(attrs.to_vec(), &self.save_ctxt),
1273 self.process_generic_params(generics, &qualname, item.hir_id());
1275 _ => intravisit::walk_item(self, item),
1279 fn visit_generics(&mut self, generics: &'tcx hir::Generics<'tcx>) {
1280 for param in generics.params {
1282 hir::GenericParamKind::Lifetime { .. } => {}
1283 hir::GenericParamKind::Type { ref default, .. } => {
1284 self.process_bounds(param.bounds);
1285 if let Some(ref ty) = default {
1289 hir::GenericParamKind::Const { ref ty, ref default } => {
1290 self.process_bounds(param.bounds);
1292 if let Some(default) = default {
1293 self.visit_anon_const(default);
1298 for pred in generics.where_clause.predicates {
1299 if let hir::WherePredicate::BoundPredicate(ref wbp) = *pred {
1300 self.process_bounds(wbp.bounds);
1301 self.visit_ty(wbp.bounded_ty);
1306 fn visit_ty(&mut self, t: &'tcx hir::Ty<'tcx>) {
1307 self.process_macro_use(t.span);
1309 hir::TyKind::Path(ref path) => {
1310 if generated_code(t.span) {
1314 if let Some(id) = self.lookup_def_id(t.hir_id) {
1315 let sub_span = path.last_segment_span();
1316 let span = self.span_from_span(sub_span);
1317 self.dumper.dump_ref(Ref {
1318 kind: RefKind::Type,
1320 ref_id: id_from_def_id(id),
1324 if let hir::QPath::Resolved(_, path) = path {
1325 self.write_sub_paths_truncated(path);
1327 intravisit::walk_qpath(self, path, t.hir_id, t.span);
1329 hir::TyKind::Array(ref ty, ref anon_const) => {
1331 let map = self.tcx.hir();
1332 self.nest_typeck_results(self.tcx.hir().local_def_id(anon_const.hir_id), |v| {
1333 v.visit_expr(&map.body(anon_const.body).value)
1336 hir::TyKind::OpaqueDef(item_id, _) => {
1337 let item = self.tcx.hir().item(item_id);
1338 self.nest_typeck_results(item_id.def_id, |v| v.visit_item(item));
1340 _ => intravisit::walk_ty(self, t),
1344 fn visit_expr(&mut self, ex: &'tcx hir::Expr<'tcx>) {
1345 debug!("visit_expr {:?}", ex.kind);
1346 self.process_macro_use(ex.span);
1348 hir::ExprKind::Struct(ref path, ref fields, ref rest) => {
1349 let hir_expr = self.save_ctxt.tcx.hir().expect_expr(ex.hir_id);
1350 let adt = match self.save_ctxt.typeck_results().expr_ty_opt(&hir_expr) {
1351 Some(ty) if ty.ty_adt_def().is_some() => ty.ty_adt_def().unwrap(),
1353 intravisit::walk_expr(self, ex);
1357 let res = self.save_ctxt.get_path_res(hir_expr.hir_id);
1358 self.process_struct_lit(ex, path, fields, adt.variant_of_res(res), *rest)
1360 hir::ExprKind::MethodCall(ref seg, _, args, _) => {
1361 self.process_method_call(ex, seg, args)
1363 hir::ExprKind::Field(ref sub_ex, _) => {
1364 self.visit_expr(&sub_ex);
1366 if let Some(field_data) = self.save_ctxt.get_expr_data(ex) {
1367 down_cast_data!(field_data, RefData, ex.span);
1368 if !generated_code(ex.span) {
1369 self.dumper.dump_ref(field_data);
1373 hir::ExprKind::Closure(_, ref decl, body, _fn_decl_span, _) => {
1374 let id = format!("${}", ex.hir_id);
1376 // walk arg and return types
1377 for ty in decl.inputs {
1381 if let hir::FnRetTy::Return(ref ret_ty) = decl.output {
1382 self.visit_ty(ret_ty);
1386 let map = self.tcx.hir();
1387 self.nest_typeck_results(self.tcx.hir().local_def_id(ex.hir_id), |v| {
1388 let body = map.body(body);
1389 v.process_formals(body.params, &id);
1390 v.visit_expr(&body.value)
1393 hir::ExprKind::Repeat(ref expr, ref anon_const) => {
1394 self.visit_expr(expr);
1395 let map = self.tcx.hir();
1396 self.nest_typeck_results(self.tcx.hir().local_def_id(anon_const.hir_id), |v| {
1397 v.visit_expr(&map.body(anon_const.body).value)
1400 // In particular, we take this branch for call and path expressions,
1401 // where we'll index the idents involved just by continuing to walk.
1402 _ => intravisit::walk_expr(self, ex),
1406 fn visit_pat(&mut self, p: &'tcx hir::Pat<'tcx>) {
1407 self.process_macro_use(p.span);
1408 self.process_pat(p);
1411 fn visit_arm(&mut self, arm: &'tcx hir::Arm<'tcx>) {
1412 self.process_var_decl(&arm.pat);
1413 if let Some(hir::Guard::If(expr)) = &arm.guard {
1414 self.visit_expr(expr);
1416 self.visit_expr(&arm.body);
1419 fn visit_qpath(&mut self, path: &'tcx hir::QPath<'tcx>, id: hir::HirId, _: Span) {
1420 self.process_path(id, path);
1423 fn visit_stmt(&mut self, s: &'tcx hir::Stmt<'tcx>) {
1424 self.process_macro_use(s.span);
1425 intravisit::walk_stmt(self, s)
1428 fn visit_local(&mut self, l: &'tcx hir::Local<'tcx>) {
1429 self.process_macro_use(l.span);
1430 self.process_var_decl(&l.pat);
1432 // Just walk the initialiser and type (don't want to walk the pattern again).
1433 walk_list!(self, visit_ty, &l.ty);
1434 walk_list!(self, visit_expr, &l.init);
1437 fn visit_foreign_item(&mut self, item: &'tcx hir::ForeignItem<'tcx>) {
1438 let access = access_from!(self.save_ctxt, item, item.hir_id());
1441 hir::ForeignItemKind::Fn(decl, _, ref generics) => {
1442 if let Some(fn_data) = self.save_ctxt.get_extern_item_data(item) {
1443 down_cast_data!(fn_data, DefData, item.span);
1445 self.process_generic_params(generics, &fn_data.qualname, item.hir_id());
1446 self.dumper.dump_def(&access, fn_data);
1449 for ty in decl.inputs {
1453 if let hir::FnRetTy::Return(ref ret_ty) = decl.output {
1454 self.visit_ty(ret_ty);
1457 hir::ForeignItemKind::Static(ref ty, _) => {
1458 if let Some(var_data) = self.save_ctxt.get_extern_item_data(item) {
1459 down_cast_data!(var_data, DefData, item.span);
1460 self.dumper.dump_def(&access, var_data);
1465 hir::ForeignItemKind::Type => {
1466 if let Some(var_data) = self.save_ctxt.get_extern_item_data(item) {
1467 down_cast_data!(var_data, DefData, item.span);
1468 self.dumper.dump_def(&access, var_data);