diff options
Diffstat (limited to 'compiler/rustc_save_analysis/src/dump_visitor.rs')
-rw-r--r-- | compiler/rustc_save_analysis/src/dump_visitor.rs | 1471 |
1 files changed, 0 insertions, 1471 deletions
diff --git a/compiler/rustc_save_analysis/src/dump_visitor.rs b/compiler/rustc_save_analysis/src/dump_visitor.rs deleted file mode 100644 index a5f09de1c..000000000 --- a/compiler/rustc_save_analysis/src/dump_visitor.rs +++ /dev/null @@ -1,1471 +0,0 @@ -//! Write the output of rustc's analysis to an implementor of Dump. -//! -//! Dumping the analysis is implemented by walking the AST and getting a bunch of -//! info out from all over the place. We use `DefId`s to identify objects. The -//! tricky part is getting syntactic (span, source text) and semantic (reference -//! `DefId`s) information for parts of expressions which the compiler has discarded. -//! E.g., in a path `foo::bar::baz`, the compiler only keeps a span for the whole -//! path and a reference to `baz`, but we want spans and references for all three -//! idents. -//! -//! SpanUtils is used to manipulate spans. In particular, to extract sub-spans -//! from spans (e.g., the span for `bar` from the above example path). -//! DumpVisitor walks the AST and processes it, and Dumper is used for -//! recording the output. - -use rustc_ast as ast; -use rustc_ast::walk_list; -use rustc_data_structures::fx::FxHashSet; -use rustc_hir as hir; -use rustc_hir::def::{DefKind as HirDefKind, Res}; -use rustc_hir::def_id::{DefId, LocalDefId, CRATE_DEF_ID}; -use rustc_hir::intravisit::{self, Visitor}; -use rustc_hir_pretty::{bounds_to_string, fn_to_string, generic_params_to_string, ty_to_string}; -use rustc_middle::hir::nested_filter; -use rustc_middle::span_bug; -use rustc_middle::ty::{self, DefIdTree, TyCtxt}; -use rustc_session::config::Input; -use rustc_span::symbol::Ident; -use rustc_span::*; - -use std::env; -use std::path::Path; - -use crate::dumper::{Access, Dumper}; -use crate::sig; -use crate::span_utils::SpanUtils; -use crate::{ - escape, generated_code, id_from_def_id, id_from_hir_id, lower_attributes, PathCollector, - SaveContext, -}; - -use rls_data::{ - CompilationOptions, CratePreludeData, Def, DefKind, GlobalCrateId, Import, ImportKind, Ref, - RefKind, Relation, RelationKind, SpanData, -}; - -#[rustfmt::skip] // https://github.com/rust-lang/rustfmt/issues/5213 -macro_rules! down_cast_data { - ($id:ident, $kind:ident, $sp:expr) => { - let super::Data::$kind($id) = $id else { - span_bug!($sp, "unexpected data kind: {:?}", $id); - }; - }; -} - -macro_rules! access_from { - ($save_ctxt:expr, $id:expr) => { - Access { - public: $save_ctxt.tcx.visibility($id).is_public(), - reachable: $save_ctxt.effective_visibilities.is_reachable($id), - } - }; -} - -pub struct DumpVisitor<'tcx> { - pub save_ctxt: SaveContext<'tcx>, - tcx: TyCtxt<'tcx>, - dumper: Dumper, - - span: SpanUtils<'tcx>, - // Set of macro definition (callee) spans, and the set - // of macro use (callsite) spans. We store these to ensure - // we only write one macro def per unique macro definition, and - // one macro use per unique callsite span. - // mac_defs: FxHashSet<Span>, - // macro_calls: FxHashSet<Span>, -} - -impl<'tcx> DumpVisitor<'tcx> { - pub fn new(save_ctxt: SaveContext<'tcx>) -> DumpVisitor<'tcx> { - let span_utils = SpanUtils::new(&save_ctxt.tcx.sess); - let dumper = Dumper::new(save_ctxt.config.clone()); - DumpVisitor { tcx: save_ctxt.tcx, save_ctxt, dumper, span: span_utils } - } - - pub fn analysis(&self) -> &rls_data::Analysis { - self.dumper.analysis() - } - - fn nest_typeck_results<F>(&mut self, item_def_id: LocalDefId, f: F) - where - F: FnOnce(&mut Self), - { - let typeck_results = if self.tcx.has_typeck_results(item_def_id) { - Some(self.tcx.typeck(item_def_id)) - } else { - None - }; - - let old_maybe_typeck_results = self.save_ctxt.maybe_typeck_results; - self.save_ctxt.maybe_typeck_results = typeck_results; - f(self); - self.save_ctxt.maybe_typeck_results = old_maybe_typeck_results; - } - - fn span_from_span(&self, span: Span) -> SpanData { - self.save_ctxt.span_from_span(span) - } - - fn lookup_def_id(&self, ref_id: hir::HirId) -> Option<DefId> { - self.save_ctxt.lookup_def_id(ref_id) - } - - pub fn dump_crate_info(&mut self, name: Symbol) { - let crate_root = self.tcx.sess.local_crate_source_file().map(|source_file| { - match source_file.file_name() { - Some(_) => source_file.parent().unwrap().display(), - None => source_file.display(), - } - .to_string() - }); - - let data = CratePreludeData { - crate_id: GlobalCrateId { - name: name.to_string(), - disambiguator: (self.tcx.sess.local_stable_crate_id().to_u64(), 0), - }, - crate_root: crate_root.unwrap_or_else(|| "<no source>".to_owned()), - external_crates: self.save_ctxt.get_external_crates(), - span: self.span_from_span(self.tcx.def_span(CRATE_DEF_ID)), - }; - - self.dumper.crate_prelude(data); - } - - pub fn dump_compilation_options(&mut self, input: &Input, crate_name: Symbol) { - // Apply possible `remap-path-prefix` remapping to the input source file - // (and don't include remapping args anymore) - let (program, arguments) = { - let remap_arg_indices = { - let mut indices = FxHashSet::default(); - // Args are guaranteed to be valid UTF-8 (checked early) - for (i, e) in env::args().enumerate() { - if e.starts_with("--remap-path-prefix=") { - indices.insert(i); - } else if e == "--remap-path-prefix" { - indices.insert(i); - indices.insert(i + 1); - } - } - indices - }; - - let mut args = env::args() - .enumerate() - .filter(|(i, _)| !remap_arg_indices.contains(i)) - .map(|(_, arg)| match input { - Input::File(ref path) if path == Path::new(&arg) => self - .tcx - .sess - .local_crate_source_file() - .as_ref() - .unwrap() - .to_string_lossy() - .into(), - _ => arg, - }); - - (args.next().unwrap(), args.collect()) - }; - - let data = CompilationOptions { - directory: self.tcx.sess.opts.working_dir.remapped_path_if_available().into(), - program, - arguments, - output: self.save_ctxt.compilation_output(crate_name), - }; - - self.dumper.compilation_opts(data); - } - - fn write_segments(&mut self, segments: impl IntoIterator<Item = &'tcx hir::PathSegment<'tcx>>) { - for seg in segments { - if let Some(data) = self.save_ctxt.get_path_segment_data(seg) { - self.dumper.dump_ref(data); - } - } - } - - fn write_sub_paths<R>(&mut self, path: &'tcx hir::Path<'tcx, R>) { - self.write_segments(path.segments) - } - - // As write_sub_paths, but does not process the last ident in the path (assuming it - // will be processed elsewhere). See note on write_sub_paths about global. - fn write_sub_paths_truncated<R>(&mut self, path: &'tcx hir::Path<'tcx, R>) { - if let [segments @ .., _] = path.segments { - self.write_segments(segments) - } - } - - fn process_formals(&mut self, formals: &'tcx [hir::Param<'tcx>], qualname: &str) { - for arg in formals { - self.visit_pat(&arg.pat); - let mut collector = PathCollector::new(self.tcx); - collector.visit_pat(&arg.pat); - - for (hir_id, ident, ..) in collector.collected_idents { - let typ = match self.save_ctxt.typeck_results().node_type_opt(hir_id) { - Some(s) => s.to_string(), - None => continue, - }; - if !self.span.filter_generated(ident.span) { - let id = id_from_hir_id(hir_id, &self.save_ctxt); - let span = self.span_from_span(ident.span); - - self.dumper.dump_def( - &Access { public: false, reachable: false }, - Def { - kind: DefKind::Local, - id, - span, - name: ident.to_string(), - qualname: format!("{}::{}", qualname, ident), - value: typ, - parent: None, - children: vec![], - decl_id: None, - docs: String::new(), - sig: None, - attributes: vec![], - }, - ); - } - } - } - } - - fn process_method( - &mut self, - sig: &'tcx hir::FnSig<'tcx>, - body: Option<hir::BodyId>, - def_id: LocalDefId, - ident: Ident, - generics: &'tcx hir::Generics<'tcx>, - span: Span, - ) { - debug!("process_method: {:?}:{}", def_id, ident); - - let map = self.tcx.hir(); - let hir_id = map.local_def_id_to_hir_id(def_id); - self.nest_typeck_results(def_id, |v| { - if let Some(mut method_data) = v.save_ctxt.get_method_data(hir_id, ident, span) { - if let Some(body) = body { - v.process_formals(map.body(body).params, &method_data.qualname); - } - v.process_generic_params(&generics, &method_data.qualname, hir_id); - - method_data.value = - fn_to_string(sig.decl, sig.header, Some(ident.name), generics, &[], None); - method_data.sig = sig::method_signature(hir_id, ident, generics, sig, &v.save_ctxt); - - v.dumper.dump_def(&access_from!(v.save_ctxt, def_id), method_data); - } - - // walk arg and return types - for arg in sig.decl.inputs { - v.visit_ty(arg); - } - - if let hir::FnRetTy::Return(ref ret_ty) = sig.decl.output { - v.visit_ty(ret_ty) - } - - // walk the fn body - if let Some(body) = body { - v.visit_expr(&map.body(body).value); - } - }); - } - - fn process_struct_field_def( - &mut self, - field: &'tcx hir::FieldDef<'tcx>, - parent_id: hir::HirId, - ) { - let field_data = self.save_ctxt.get_field_data(field, parent_id); - if let Some(field_data) = field_data { - self.dumper.dump_def( - &access_from!(self.save_ctxt, self.tcx.hir().local_def_id(field.hir_id)), - field_data, - ); - } - } - - // Dump generic params bindings, then visit_generics - fn process_generic_params( - &mut self, - generics: &'tcx hir::Generics<'tcx>, - prefix: &str, - id: hir::HirId, - ) { - for param in generics.params { - match param.kind { - hir::GenericParamKind::Lifetime { .. } => {} - hir::GenericParamKind::Type { .. } => { - let param_ss = param.name.ident().span; - let name = escape(self.span.snippet(param_ss)); - // Append $id to name to make sure each one is unique. - let qualname = format!("{}::{}${}", prefix, name, id); - if !self.span.filter_generated(param_ss) { - let id = id_from_hir_id(param.hir_id, &self.save_ctxt); - let span = self.span_from_span(param_ss); - - self.dumper.dump_def( - &Access { public: false, reachable: false }, - Def { - kind: DefKind::Type, - id, - span, - name, - qualname, - value: String::new(), - parent: None, - children: vec![], - decl_id: None, - docs: String::new(), - sig: None, - attributes: vec![], - }, - ); - } - } - hir::GenericParamKind::Const { .. } => {} - } - } - - self.visit_generics(generics) - } - - fn process_fn( - &mut self, - item: &'tcx hir::Item<'tcx>, - decl: &'tcx hir::FnDecl<'tcx>, - _header: &'tcx hir::FnHeader, - ty_params: &'tcx hir::Generics<'tcx>, - body: hir::BodyId, - ) { - let map = self.tcx.hir(); - self.nest_typeck_results(item.owner_id.def_id, |v| { - let body = map.body(body); - if let Some(fn_data) = v.save_ctxt.get_item_data(item) { - down_cast_data!(fn_data, DefData, item.span); - v.process_formals(body.params, &fn_data.qualname); - v.process_generic_params(ty_params, &fn_data.qualname, item.hir_id()); - - v.dumper.dump_def(&access_from!(v.save_ctxt, item.owner_id.def_id), fn_data); - } - - for arg in decl.inputs { - v.visit_ty(arg) - } - - if let hir::FnRetTy::Return(ref ret_ty) = decl.output { - v.visit_ty(ret_ty) - } - - v.visit_expr(&body.value); - }); - } - - fn process_static_or_const_item( - &mut self, - item: &'tcx hir::Item<'tcx>, - typ: &'tcx hir::Ty<'tcx>, - expr: &'tcx hir::Expr<'tcx>, - ) { - self.nest_typeck_results(item.owner_id.def_id, |v| { - if let Some(var_data) = v.save_ctxt.get_item_data(item) { - down_cast_data!(var_data, DefData, item.span); - v.dumper.dump_def(&access_from!(v.save_ctxt, item.owner_id.def_id), var_data); - } - v.visit_ty(&typ); - v.visit_expr(expr); - }); - } - - fn process_assoc_const( - &mut self, - def_id: LocalDefId, - ident: Ident, - typ: &'tcx hir::Ty<'tcx>, - expr: Option<&'tcx hir::Expr<'tcx>>, - parent_id: DefId, - attrs: &'tcx [ast::Attribute], - ) { - let qualname = format!("::{}", self.tcx.def_path_str(def_id.to_def_id())); - - if !self.span.filter_generated(ident.span) { - let hir_id = self.tcx.hir().local_def_id_to_hir_id(def_id); - let sig = sig::assoc_const_signature(hir_id, ident.name, typ, expr, &self.save_ctxt); - let span = self.span_from_span(ident.span); - - self.dumper.dump_def( - &access_from!(self.save_ctxt, def_id), - Def { - kind: DefKind::Const, - id: id_from_hir_id(hir_id, &self.save_ctxt), - span, - name: ident.name.to_string(), - qualname, - value: ty_to_string(&typ), - parent: Some(id_from_def_id(parent_id)), - children: vec![], - decl_id: None, - docs: self.save_ctxt.docs_for_attrs(attrs), - sig, - attributes: lower_attributes(attrs.to_owned(), &self.save_ctxt), - }, - ); - } - - // walk type and init value - self.nest_typeck_results(def_id, |v| { - v.visit_ty(typ); - if let Some(expr) = expr { - v.visit_expr(expr); - } - }); - } - - // FIXME tuple structs should generate tuple-specific data. - fn process_struct( - &mut self, - item: &'tcx hir::Item<'tcx>, - def: &'tcx hir::VariantData<'tcx>, - ty_params: &'tcx hir::Generics<'tcx>, - ) { - debug!("process_struct {:?} {:?}", item, item.span); - let name = item.ident.to_string(); - let qualname = format!("::{}", self.tcx.def_path_str(item.owner_id.to_def_id())); - - let kind = match item.kind { - hir::ItemKind::Struct(_, _) => DefKind::Struct, - hir::ItemKind::Union(_, _) => DefKind::Union, - _ => unreachable!(), - }; - - let (value, fields) = match item.kind { - hir::ItemKind::Struct(hir::VariantData::Struct(ref fields, ..), ..) - | hir::ItemKind::Union(hir::VariantData::Struct(ref fields, ..), ..) => { - let include_priv_fields = !self.save_ctxt.config.pub_only; - let fields_str = fields - .iter() - .filter_map(|f| { - if include_priv_fields { - return Some(f.ident.to_string()); - } - let def_id = self.save_ctxt.tcx.hir().local_def_id(f.hir_id); - if self.save_ctxt.tcx.visibility(def_id).is_public() { - Some(f.ident.to_string()) - } else { - None - } - }) - .collect::<Vec<_>>() - .join(", "); - let value = format!("{} {{ {} }}", name, fields_str); - (value, fields.iter().map(|f| id_from_hir_id(f.hir_id, &self.save_ctxt)).collect()) - } - _ => (String::new(), vec![]), - }; - - if !self.span.filter_generated(item.ident.span) { - let span = self.span_from_span(item.ident.span); - let attrs = self.tcx.hir().attrs(item.hir_id()); - self.dumper.dump_def( - &access_from!(self.save_ctxt, item.owner_id.def_id), - Def { - kind, - id: id_from_def_id(item.owner_id.to_def_id()), - span, - name, - qualname: qualname.clone(), - value, - parent: None, - children: fields, - decl_id: None, - docs: self.save_ctxt.docs_for_attrs(attrs), - sig: sig::item_signature(item, &self.save_ctxt), - attributes: lower_attributes(attrs.to_vec(), &self.save_ctxt), - }, - ); - } - - self.nest_typeck_results(item.owner_id.def_id, |v| { - for field in def.fields() { - v.process_struct_field_def(field, item.hir_id()); - v.visit_ty(&field.ty); - } - - v.process_generic_params(ty_params, &qualname, item.hir_id()); - }); - } - - fn process_enum( - &mut self, - item: &'tcx hir::Item<'tcx>, - enum_definition: &'tcx hir::EnumDef<'tcx>, - ty_params: &'tcx hir::Generics<'tcx>, - ) { - let enum_data = self.save_ctxt.get_item_data(item); - let Some(enum_data) = enum_data else { - return; - }; - down_cast_data!(enum_data, DefData, item.span); - - let access = access_from!(self.save_ctxt, item.owner_id.def_id); - - for variant in enum_definition.variants { - let name = variant.ident.name.to_string(); - let qualname = format!("{}::{}", enum_data.qualname, name); - let name_span = variant.ident.span; - - match variant.data { - hir::VariantData::Struct(ref fields, ..) => { - let fields_str = - fields.iter().map(|f| f.ident.to_string()).collect::<Vec<_>>().join(", "); - let value = format!("{}::{} {{ {} }}", enum_data.name, name, fields_str); - if !self.span.filter_generated(name_span) { - let span = self.span_from_span(name_span); - let id = id_from_hir_id(variant.hir_id, &self.save_ctxt); - let parent = Some(id_from_def_id(item.owner_id.to_def_id())); - let attrs = self.tcx.hir().attrs(variant.hir_id); - - self.dumper.dump_def( - &access, - Def { - kind: DefKind::StructVariant, - id, - span, - name, - qualname, - value, - parent, - children: vec![], - decl_id: None, - docs: self.save_ctxt.docs_for_attrs(attrs), - sig: sig::variant_signature(variant, &self.save_ctxt), - attributes: lower_attributes(attrs.to_vec(), &self.save_ctxt), - }, - ); - } - } - ref v => { - let mut value = format!("{}::{}", enum_data.name, name); - if let hir::VariantData::Tuple(fields, _, _) = v { - value.push('('); - value.push_str( - &fields - .iter() - .map(|f| ty_to_string(&f.ty)) - .collect::<Vec<_>>() - .join(", "), - ); - value.push(')'); - } - if !self.span.filter_generated(name_span) { - let span = self.span_from_span(name_span); - let id = id_from_hir_id(variant.hir_id, &self.save_ctxt); - let parent = Some(id_from_def_id(item.owner_id.to_def_id())); - let attrs = self.tcx.hir().attrs(variant.hir_id); - - self.dumper.dump_def( - &access, - Def { - kind: DefKind::TupleVariant, - id, - span, - name, - qualname, - value, - parent, - children: vec![], - decl_id: None, - docs: self.save_ctxt.docs_for_attrs(attrs), - sig: sig::variant_signature(variant, &self.save_ctxt), - attributes: lower_attributes(attrs.to_vec(), &self.save_ctxt), - }, - ); - } - } - } - - for field in variant.data.fields() { - self.process_struct_field_def(field, variant.hir_id); - self.visit_ty(field.ty); - } - } - self.process_generic_params(ty_params, &enum_data.qualname, item.hir_id()); - self.dumper.dump_def(&access, enum_data); - } - - fn process_impl(&mut self, item: &'tcx hir::Item<'tcx>, impl_: &'tcx hir::Impl<'tcx>) { - if let Some(impl_data) = self.save_ctxt.get_item_data(item) { - if !self.span.filter_generated(item.span) { - if let super::Data::RelationData(rel, imp) = impl_data { - self.dumper.dump_relation(rel); - self.dumper.dump_impl(imp); - } else { - span_bug!(item.span, "unexpected data kind: {:?}", impl_data); - } - } - } - - let map = self.tcx.hir(); - self.nest_typeck_results(item.owner_id.def_id, |v| { - v.visit_ty(&impl_.self_ty); - if let Some(trait_ref) = &impl_.of_trait { - v.process_path(trait_ref.hir_ref_id, &hir::QPath::Resolved(None, &trait_ref.path)); - } - v.process_generic_params(&impl_.generics, "", item.hir_id()); - for impl_item in impl_.items { - v.process_impl_item(map.impl_item(impl_item.id), item.owner_id.to_def_id()); - } - }); - } - - fn process_trait( - &mut self, - item: &'tcx hir::Item<'tcx>, - generics: &'tcx hir::Generics<'tcx>, - trait_refs: hir::GenericBounds<'tcx>, - methods: &'tcx [hir::TraitItemRef], - ) { - let name = item.ident.to_string(); - let qualname = format!("::{}", self.tcx.def_path_str(item.owner_id.to_def_id())); - let mut val = name.clone(); - if !generics.params.is_empty() { - val.push_str(&generic_params_to_string(generics.params)); - } - if !trait_refs.is_empty() { - val.push_str(": "); - val.push_str(&bounds_to_string(trait_refs)); - } - if !self.span.filter_generated(item.ident.span) { - let id = id_from_def_id(item.owner_id.to_def_id()); - let span = self.span_from_span(item.ident.span); - let children = - methods.iter().map(|i| id_from_def_id(i.id.owner_id.to_def_id())).collect(); - let attrs = self.tcx.hir().attrs(item.hir_id()); - self.dumper.dump_def( - &access_from!(self.save_ctxt, item.owner_id.def_id), - Def { - kind: DefKind::Trait, - id, - span, - name, - qualname: qualname.clone(), - value: val, - parent: None, - children, - decl_id: None, - docs: self.save_ctxt.docs_for_attrs(attrs), - sig: sig::item_signature(item, &self.save_ctxt), - attributes: lower_attributes(attrs.to_vec(), &self.save_ctxt), - }, - ); - } - - // supertraits - for super_bound in trait_refs.iter() { - let (def_id, sub_span) = match *super_bound { - hir::GenericBound::Trait(ref trait_ref, _) => ( - self.lookup_def_id(trait_ref.trait_ref.hir_ref_id), - trait_ref.trait_ref.path.segments.last().unwrap().ident.span, - ), - hir::GenericBound::LangItemTrait(lang_item, span, _, _) => { - (Some(self.tcx.require_lang_item(lang_item, Some(span))), span) - } - hir::GenericBound::Outlives(..) => continue, - }; - - if let Some(id) = def_id { - if !self.span.filter_generated(sub_span) { - let span = self.span_from_span(sub_span); - self.dumper.dump_ref(Ref { - kind: RefKind::Type, - span: span.clone(), - ref_id: id_from_def_id(id), - }); - - self.dumper.dump_relation(Relation { - kind: RelationKind::SuperTrait, - span, - from: id_from_def_id(id), - to: id_from_def_id(item.owner_id.to_def_id()), - }); - } - } - } - - // walk generics and methods - self.process_generic_params(generics, &qualname, item.hir_id()); - for method in methods { - let map = self.tcx.hir(); - self.process_trait_item(map.trait_item(method.id), item.owner_id.to_def_id()) - } - } - - // `item` is the module in question, represented as an( item. - fn process_mod(&mut self, item: &'tcx hir::Item<'tcx>) { - if let Some(mod_data) = self.save_ctxt.get_item_data(item) { - down_cast_data!(mod_data, DefData, item.span); - self.dumper.dump_def(&access_from!(self.save_ctxt, item.owner_id.def_id), mod_data); - } - } - - fn dump_path_ref(&mut self, id: hir::HirId, path: &hir::QPath<'tcx>) { - let path_data = self.save_ctxt.get_path_data(id, path); - if let Some(path_data) = path_data { - self.dumper.dump_ref(path_data); - } - } - - fn dump_path_segment_ref(&mut self, id: hir::HirId, segment: &hir::PathSegment<'tcx>) { - let segment_data = self.save_ctxt.get_path_segment_data_with_id(segment, id); - if let Some(segment_data) = segment_data { - self.dumper.dump_ref(segment_data); - } - } - - fn process_path(&mut self, id: hir::HirId, path: &hir::QPath<'tcx>) { - if self.span.filter_generated(path.span()) { - return; - } - self.dump_path_ref(id, path); - - // Type arguments - let segments = match path { - hir::QPath::Resolved(ty, path) => { - if let Some(ty) = ty { - self.visit_ty(ty); - } - path.segments - } - hir::QPath::TypeRelative(ty, segment) => { - self.visit_ty(ty); - std::slice::from_ref(*segment) - } - hir::QPath::LangItem(..) => return, - }; - for seg in segments { - if let Some(ref generic_args) = seg.args { - for arg in generic_args.args { - if let hir::GenericArg::Type(ref ty) = arg { - self.visit_ty(ty); - } - } - } - } - - if let hir::QPath::Resolved(_, path) = path { - self.write_sub_paths_truncated(path); - } - } - - fn process_struct_lit( - &mut self, - ex: &'tcx hir::Expr<'tcx>, - path: &'tcx hir::QPath<'tcx>, - fields: &'tcx [hir::ExprField<'tcx>], - variant: &'tcx ty::VariantDef, - rest: Option<&'tcx hir::Expr<'tcx>>, - ) { - if let Some(_ex_res_data) = self.save_ctxt.get_expr_data(ex) { - if let hir::QPath::Resolved(_, path) = path { - self.write_sub_paths_truncated(path); - } - // For MyEnum::MyVariant, get_expr_data gives us MyEnum, not MyVariant. - // For recording the span's ref id, we want MyVariant. - if !generated_code(ex.span) { - let sub_span = path.last_segment_span(); - let span = self.save_ctxt.span_from_span(sub_span); - let reff = - Ref { kind: RefKind::Type, span, ref_id: id_from_def_id(variant.def_id) }; - self.dumper.dump_ref(reff); - } - - for field in fields { - if let Some(field_data) = self.save_ctxt.get_field_ref_data(field, variant) { - self.dumper.dump_ref(field_data); - } - - self.visit_expr(&field.expr) - } - } - - if let Some(base) = rest { - self.visit_expr(&base); - } - } - - fn process_method_call( - &mut self, - ex: &'tcx hir::Expr<'tcx>, - seg: &'tcx hir::PathSegment<'tcx>, - receiver: &'tcx hir::Expr<'tcx>, - args: &'tcx [hir::Expr<'tcx>], - ) { - debug!("process_method_call {:?} {:?}", ex, ex.span); - if let Some(mcd) = self.save_ctxt.get_expr_data(ex) { - down_cast_data!(mcd, RefData, ex.span); - if !generated_code(ex.span) { - self.dumper.dump_ref(mcd); - } - } - - // Explicit types in the turbo-fish. - if let Some(generic_args) = seg.args { - for arg in generic_args.args { - if let hir::GenericArg::Type(ty) = arg { - self.visit_ty(&ty) - }; - } - } - - // walk receiver and args - self.visit_expr(receiver); - walk_list!(self, visit_expr, args); - } - - fn process_pat(&mut self, p: &'tcx hir::Pat<'tcx>) { - match p.kind { - hir::PatKind::Struct(ref _path, fields, _) => { - // FIXME do something with _path? - let adt = match self.save_ctxt.typeck_results().node_type_opt(p.hir_id) { - Some(ty) if ty.ty_adt_def().is_some() => ty.ty_adt_def().unwrap(), - _ => { - intravisit::walk_pat(self, p); - return; - } - }; - let variant = adt.variant_of_res(self.save_ctxt.get_path_res(p.hir_id)); - - for field in fields { - if let Some(index) = self.tcx.find_field_index(field.ident, variant) { - if !self.span.filter_generated(field.ident.span) { - let span = self.span_from_span(field.ident.span); - self.dumper.dump_ref(Ref { - kind: RefKind::Variable, - span, - ref_id: id_from_def_id(variant.fields[index].did), - }); - } - } - self.visit_pat(&field.pat); - } - } - _ => intravisit::walk_pat(self, p), - } - } - - fn process_var_decl(&mut self, pat: &'tcx hir::Pat<'tcx>) { - // The pattern could declare multiple new vars, - // we must walk the pattern and collect them all. - let mut collector = PathCollector::new(self.tcx); - collector.visit_pat(&pat); - self.visit_pat(&pat); - - // Process collected paths. - for (id, ident, _) in collector.collected_idents { - let res = self.save_ctxt.get_path_res(id); - match res { - Res::Local(hir_id) => { - let typ = self - .save_ctxt - .typeck_results() - .node_type_opt(hir_id) - .map(|t| t.to_string()) - .unwrap_or_default(); - - // Rust uses the id of the pattern for var lookups, so we'll use it too. - if !self.span.filter_generated(ident.span) { - let qualname = format!("{}${}", ident, hir_id); - let id = id_from_hir_id(hir_id, &self.save_ctxt); - let span = self.span_from_span(ident.span); - - self.dumper.dump_def( - &Access { public: false, reachable: false }, - Def { - kind: DefKind::Local, - id, - span, - name: ident.to_string(), - qualname, - value: typ, - parent: None, - children: vec![], - decl_id: None, - docs: String::new(), - sig: None, - attributes: vec![], - }, - ); - } - } - Res::Def( - HirDefKind::Ctor(..) - | HirDefKind::Const - | HirDefKind::AssocConst - | HirDefKind::Struct - | HirDefKind::Variant - | HirDefKind::TyAlias - | HirDefKind::AssocTy, - _, - ) - | Res::SelfTyParam { .. } - | Res::SelfTyAlias { .. } => { - self.dump_path_segment_ref( - id, - &hir::PathSegment::new(ident, hir::HirId::INVALID, Res::Err), - ); - } - def => { - error!("unexpected definition kind when processing collected idents: {:?}", def) - } - } - } - - for (id, ref path) in collector.collected_paths { - self.process_path(id, path); - } - } - - /// Extracts macro use and definition information from the AST node defined - /// by the given NodeId, using the expansion information from the node's - /// span. - /// - /// If the span is not macro-generated, do nothing, else use callee and - /// callsite spans to record macro definition and use data, using the - /// mac_uses and mac_defs sets to prevent multiples. - fn process_macro_use(&mut self, _span: Span) { - // FIXME if we're not dumping the defs (see below), there is no point - // dumping refs either. - // let source_span = span.source_callsite(); - // if !self.macro_calls.insert(source_span) { - // return; - // } - - // let data = match self.save_ctxt.get_macro_use_data(span) { - // None => return, - // Some(data) => data, - // }; - - // self.dumper.macro_use(data); - - // FIXME write the macro def - // let mut hasher = DefaultHasher::new(); - // data.callee_span.hash(&mut hasher); - // let hash = hasher.finish(); - // let qualname = format!("{}::{}", data.name, hash); - // Don't write macro definition for imported macros - // if !self.mac_defs.contains(&data.callee_span) - // && !data.imported { - // self.mac_defs.insert(data.callee_span); - // if let Some(sub_span) = self.span.span_for_macro_def_name(data.callee_span) { - // self.dumper.macro_data(MacroData { - // span: sub_span, - // name: data.name.clone(), - // qualname: qualname.clone(), - // // FIXME where do macro docs come from? - // docs: String::new(), - // }.lower(self.tcx)); - // } - // } - } - - fn process_trait_item(&mut self, trait_item: &'tcx hir::TraitItem<'tcx>, trait_id: DefId) { - self.process_macro_use(trait_item.span); - match trait_item.kind { - hir::TraitItemKind::Const(ref ty, body) => { - let body = body.map(|b| self.tcx.hir().body(b).value); - let attrs = self.tcx.hir().attrs(trait_item.hir_id()); - self.process_assoc_const( - trait_item.owner_id.def_id, - trait_item.ident, - &ty, - body, - trait_id, - attrs, - ); - } - hir::TraitItemKind::Fn(ref sig, ref trait_fn) => { - let body = - if let hir::TraitFn::Provided(body) = trait_fn { Some(*body) } else { None }; - self.process_method( - sig, - body, - trait_item.owner_id.def_id, - trait_item.ident, - &trait_item.generics, - trait_item.span, - ); - } - hir::TraitItemKind::Type(ref bounds, ref default_ty) => { - // FIXME do something with _bounds (for type refs) - let name = trait_item.ident.name.to_string(); - let qualname = - format!("::{}", self.tcx.def_path_str(trait_item.owner_id.to_def_id())); - - if !self.span.filter_generated(trait_item.ident.span) { - let span = self.span_from_span(trait_item.ident.span); - let id = id_from_def_id(trait_item.owner_id.to_def_id()); - let attrs = self.tcx.hir().attrs(trait_item.hir_id()); - - self.dumper.dump_def( - &Access { public: true, reachable: true }, - Def { - kind: DefKind::Type, - id, - span, - name, - qualname, - value: self.span.snippet(trait_item.span), - parent: Some(id_from_def_id(trait_id)), - children: vec![], - decl_id: None, - docs: self.save_ctxt.docs_for_attrs(attrs), - sig: sig::assoc_type_signature( - trait_item.hir_id(), - trait_item.ident, - Some(bounds), - default_ty.as_deref(), - &self.save_ctxt, - ), - attributes: lower_attributes(attrs.to_vec(), &self.save_ctxt), - }, - ); - } - - if let Some(default_ty) = default_ty { - self.visit_ty(default_ty) - } - } - } - } - - fn process_impl_item(&mut self, impl_item: &'tcx hir::ImplItem<'tcx>, impl_id: DefId) { - self.process_macro_use(impl_item.span); - match impl_item.kind { - hir::ImplItemKind::Const(ref ty, body) => { - let body = self.tcx.hir().body(body); - let attrs = self.tcx.hir().attrs(impl_item.hir_id()); - self.process_assoc_const( - impl_item.owner_id.def_id, - impl_item.ident, - &ty, - Some(&body.value), - impl_id, - attrs, - ); - } - hir::ImplItemKind::Fn(ref sig, body) => { - self.process_method( - sig, - Some(body), - impl_item.owner_id.def_id, - impl_item.ident, - &impl_item.generics, - impl_item.span, - ); - } - hir::ImplItemKind::Type(ref ty) => { - // FIXME: uses of the assoc type should ideally point to this - // 'def' and the name here should be a ref to the def in the - // trait. - self.visit_ty(ty) - } - } - } - - pub(crate) fn process_crate(&mut self) { - let id = hir::CRATE_HIR_ID; - let qualname = - format!("::{}", self.tcx.def_path_str(self.tcx.hir().local_def_id(id).to_def_id())); - - let sm = self.tcx.sess.source_map(); - let krate_mod = self.tcx.hir().root_module(); - let filename = sm.span_to_filename(krate_mod.spans.inner_span); - let data_id = id_from_hir_id(id, &self.save_ctxt); - let children = - krate_mod.item_ids.iter().map(|i| id_from_def_id(i.owner_id.to_def_id())).collect(); - let span = self.span_from_span(krate_mod.spans.inner_span); - let attrs = self.tcx.hir().attrs(id); - - self.dumper.dump_def( - &Access { public: true, reachable: true }, - Def { - kind: DefKind::Mod, - id: data_id, - name: String::new(), - qualname, - span, - value: filename.prefer_remapped().to_string(), - children, - parent: None, - decl_id: None, - docs: self.save_ctxt.docs_for_attrs(attrs), - sig: None, - attributes: lower_attributes(attrs.to_owned(), &self.save_ctxt), - }, - ); - self.tcx.hir().walk_toplevel_module(self); - } - - fn process_bounds(&mut self, bounds: hir::GenericBounds<'tcx>) { - for bound in bounds { - if let hir::GenericBound::Trait(ref trait_ref, _) = *bound { - self.process_path( - trait_ref.trait_ref.hir_ref_id, - &hir::QPath::Resolved(None, &trait_ref.trait_ref.path), - ) - } - } - } -} - -impl<'tcx> Visitor<'tcx> for DumpVisitor<'tcx> { - type NestedFilter = nested_filter::All; - - fn nested_visit_map(&mut self) -> Self::Map { - self.tcx.hir() - } - - fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) { - self.process_macro_use(item.span); - match item.kind { - hir::ItemKind::Use(path, hir::UseKind::Single) => { - let sub_span = path.segments.last().unwrap().ident.span; - if !self.span.filter_generated(sub_span) { - let access = access_from!(self.save_ctxt, item.owner_id.def_id); - let ref_id = self.lookup_def_id(item.hir_id()).map(id_from_def_id); - let span = self.span_from_span(sub_span); - let parent = self.save_ctxt.tcx.local_parent(item.owner_id.def_id); - self.dumper.import( - &access, - Import { - kind: ImportKind::Use, - ref_id, - span, - alias_span: None, - name: item.ident.to_string(), - value: String::new(), - parent: Some(id_from_def_id(parent.to_def_id())), - }, - ); - self.write_sub_paths_truncated(&path); - } - } - hir::ItemKind::Use(path, hir::UseKind::Glob) => { - // Make a comma-separated list of names of imported modules. - let names = self.tcx.names_imported_by_glob_use(item.owner_id.def_id); - let names: Vec<_> = names.iter().map(|n| n.to_string()).collect(); - - // Otherwise it's a span with wrong macro expansion info, which - // we don't want to track anyway, since it's probably macro-internal `use` - if let Some(sub_span) = self.span.sub_span_of_star(item.span) { - if !self.span.filter_generated(item.span) { - let access = access_from!(self.save_ctxt, item.owner_id.def_id); - let span = self.span_from_span(sub_span); - let parent = self.save_ctxt.tcx.local_parent(item.owner_id.def_id); - self.dumper.import( - &access, - Import { - kind: ImportKind::GlobUse, - ref_id: None, - span, - alias_span: None, - name: "*".to_owned(), - value: names.join(", "), - parent: Some(id_from_def_id(parent.to_def_id())), - }, - ); - self.write_sub_paths(&path); - } - } - } - hir::ItemKind::ExternCrate(_) => { - let name_span = item.ident.span; - if !self.span.filter_generated(name_span) { - let span = self.span_from_span(name_span); - let parent = self.save_ctxt.tcx.local_parent(item.owner_id.def_id); - self.dumper.import( - &Access { public: false, reachable: false }, - Import { - kind: ImportKind::ExternCrate, - ref_id: None, - span, - alias_span: None, - name: item.ident.to_string(), - value: String::new(), - parent: Some(id_from_def_id(parent.to_def_id())), - }, - ); - } - } - hir::ItemKind::Fn(ref sig, ref ty_params, body) => { - self.process_fn(item, sig.decl, &sig.header, ty_params, body) - } - hir::ItemKind::Static(ref typ, _, body) => { - let body = self.tcx.hir().body(body); - self.process_static_or_const_item(item, typ, &body.value) - } - hir::ItemKind::Const(ref typ, body) => { - let body = self.tcx.hir().body(body); - self.process_static_or_const_item(item, typ, &body.value) - } - hir::ItemKind::Struct(ref def, ref ty_params) - | hir::ItemKind::Union(ref def, ref ty_params) => { - self.process_struct(item, def, ty_params) - } - hir::ItemKind::Enum(ref def, ref ty_params) => self.process_enum(item, def, ty_params), - hir::ItemKind::Impl(ref impl_) => self.process_impl(item, impl_), - hir::ItemKind::Trait(_, _, ref generics, ref trait_refs, methods) => { - self.process_trait(item, generics, trait_refs, methods) - } - hir::ItemKind::Mod(ref m) => { - self.process_mod(item); - intravisit::walk_mod(self, m, item.hir_id()); - } - hir::ItemKind::TyAlias(ty, ref generics) => { - let qualname = format!("::{}", self.tcx.def_path_str(item.owner_id.to_def_id())); - let value = ty_to_string(&ty); - if !self.span.filter_generated(item.ident.span) { - let span = self.span_from_span(item.ident.span); - let id = id_from_def_id(item.owner_id.to_def_id()); - let attrs = self.tcx.hir().attrs(item.hir_id()); - - self.dumper.dump_def( - &access_from!(self.save_ctxt, item.owner_id.def_id), - Def { - kind: DefKind::Type, - id, - span, - name: item.ident.to_string(), - qualname: qualname.clone(), - value, - parent: None, - children: vec![], - decl_id: None, - docs: self.save_ctxt.docs_for_attrs(attrs), - sig: sig::item_signature(item, &self.save_ctxt), - attributes: lower_attributes(attrs.to_vec(), &self.save_ctxt), - }, - ); - } - - self.visit_ty(ty); - self.process_generic_params(generics, &qualname, item.hir_id()); - } - _ => intravisit::walk_item(self, item), - } - } - - fn visit_generics(&mut self, generics: &'tcx hir::Generics<'tcx>) { - for param in generics.params { - match param.kind { - hir::GenericParamKind::Lifetime { .. } => {} - hir::GenericParamKind::Type { ref default, .. } => { - if let Some(ref ty) = default { - self.visit_ty(ty); - } - } - hir::GenericParamKind::Const { ref ty, ref default } => { - self.visit_ty(ty); - if let Some(default) = default { - self.visit_anon_const(default); - } - } - } - } - for pred in generics.predicates { - if let hir::WherePredicate::BoundPredicate(ref wbp) = *pred { - self.process_bounds(wbp.bounds); - self.visit_ty(wbp.bounded_ty); - } - } - } - - fn visit_ty(&mut self, t: &'tcx hir::Ty<'tcx>) { - self.process_macro_use(t.span); - match t.kind { - hir::TyKind::Path(ref path) => { - if generated_code(t.span) { - return; - } - - if let Some(id) = self.lookup_def_id(t.hir_id) { - let sub_span = path.last_segment_span(); - let span = self.span_from_span(sub_span); - self.dumper.dump_ref(Ref { - kind: RefKind::Type, - span, - ref_id: id_from_def_id(id), - }); - } - - if let hir::QPath::Resolved(_, path) = path { - self.write_sub_paths_truncated(path); - } - intravisit::walk_qpath(self, path, t.hir_id); - } - hir::TyKind::Array(ref ty, ref length) => { - self.visit_ty(ty); - let map = self.tcx.hir(); - match length { - // FIXME(generic_arg_infer): We probably want to - // output the inferred type here? :shrug: - hir::ArrayLen::Infer(..) => {} - hir::ArrayLen::Body(anon_const) => self - .nest_typeck_results(self.tcx.hir().local_def_id(anon_const.hir_id), |v| { - v.visit_expr(&map.body(anon_const.body).value) - }), - } - } - hir::TyKind::OpaqueDef(item_id, _, _) => { - let item = self.tcx.hir().item(item_id); - self.nest_typeck_results(item_id.owner_id.def_id, |v| v.visit_item(item)); - } - _ => intravisit::walk_ty(self, t), - } - } - - fn visit_expr(&mut self, ex: &'tcx hir::Expr<'tcx>) { - debug!("visit_expr {:?}", ex.kind); - self.process_macro_use(ex.span); - match ex.kind { - hir::ExprKind::Struct(ref path, ref fields, ref rest) => { - let hir_expr = self.save_ctxt.tcx.hir().expect_expr(ex.hir_id); - let adt = match self.save_ctxt.typeck_results().expr_ty_opt(&hir_expr) { - Some(ty) if ty.ty_adt_def().is_some() => ty.ty_adt_def().unwrap(), - _ => { - intravisit::walk_expr(self, ex); - return; - } - }; - let res = self.save_ctxt.get_path_res(hir_expr.hir_id); - self.process_struct_lit(ex, path, fields, adt.variant_of_res(res), *rest) - } - hir::ExprKind::MethodCall(ref seg, receiver, args, _) => { - self.process_method_call(ex, seg, receiver, args) - } - hir::ExprKind::Field(ref sub_ex, _) => { - self.visit_expr(&sub_ex); - - if let Some(field_data) = self.save_ctxt.get_expr_data(ex) { - down_cast_data!(field_data, RefData, ex.span); - if !generated_code(ex.span) { - self.dumper.dump_ref(field_data); - } - } - } - hir::ExprKind::Closure(&hir::Closure { ref fn_decl, body, .. }) => { - let id = format!("${}", ex.hir_id); - - // walk arg and return types - for ty in fn_decl.inputs { - self.visit_ty(ty); - } - - if let hir::FnRetTy::Return(ref ret_ty) = fn_decl.output { - self.visit_ty(ret_ty); - } - - // walk the body - let map = self.tcx.hir(); - self.nest_typeck_results(self.tcx.hir().local_def_id(ex.hir_id), |v| { - let body = map.body(body); - v.process_formals(body.params, &id); - v.visit_expr(&body.value) - }); - } - hir::ExprKind::Repeat(ref expr, ref length) => { - self.visit_expr(expr); - let map = self.tcx.hir(); - match length { - // FIXME(generic_arg_infer): We probably want to - // output the inferred type here? :shrug: - hir::ArrayLen::Infer(..) => {} - hir::ArrayLen::Body(anon_const) => self - .nest_typeck_results(self.tcx.hir().local_def_id(anon_const.hir_id), |v| { - v.visit_expr(&map.body(anon_const.body).value) - }), - } - } - // In particular, we take this branch for call and path expressions, - // where we'll index the idents involved just by continuing to walk. - _ => intravisit::walk_expr(self, ex), - } - } - - fn visit_pat(&mut self, p: &'tcx hir::Pat<'tcx>) { - self.process_macro_use(p.span); - self.process_pat(p); - } - - fn visit_arm(&mut self, arm: &'tcx hir::Arm<'tcx>) { - self.process_var_decl(&arm.pat); - if let Some(hir::Guard::If(expr)) = &arm.guard { - self.visit_expr(expr); - } - self.visit_expr(&arm.body); - } - - fn visit_qpath(&mut self, path: &'tcx hir::QPath<'tcx>, id: hir::HirId, _: Span) { - self.process_path(id, path); - } - - fn visit_stmt(&mut self, s: &'tcx hir::Stmt<'tcx>) { - self.process_macro_use(s.span); - intravisit::walk_stmt(self, s) - } - - fn visit_local(&mut self, l: &'tcx hir::Local<'tcx>) { - self.process_macro_use(l.span); - self.process_var_decl(&l.pat); - - // Just walk the initializer, the else branch and type (don't want to walk the pattern again). - walk_list!(self, visit_ty, &l.ty); - walk_list!(self, visit_expr, &l.init); - walk_list!(self, visit_block, l.els); - } - - fn visit_foreign_item(&mut self, item: &'tcx hir::ForeignItem<'tcx>) { - let access = access_from!(self.save_ctxt, item.owner_id.def_id); - - match item.kind { - hir::ForeignItemKind::Fn(decl, _, ref generics) => { - if let Some(fn_data) = self.save_ctxt.get_extern_item_data(item) { - down_cast_data!(fn_data, DefData, item.span); - - self.process_generic_params(generics, &fn_data.qualname, item.hir_id()); - self.dumper.dump_def(&access, fn_data); - } - - for ty in decl.inputs { - self.visit_ty(ty); - } - - if let hir::FnRetTy::Return(ref ret_ty) = decl.output { - self.visit_ty(ret_ty); - } - } - hir::ForeignItemKind::Static(ref ty, _) => { - if let Some(var_data) = self.save_ctxt.get_extern_item_data(item) { - down_cast_data!(var_data, DefData, item.span); - self.dumper.dump_def(&access, var_data); - } - - self.visit_ty(ty); - } - hir::ForeignItemKind::Type => { - if let Some(var_data) = self.save_ctxt.get_extern_item_data(item) { - down_cast_data!(var_data, DefData, item.span); - self.dumper.dump_def(&access, var_data); - } - } - } - } -} |