1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Write the output of rustc's analysis to an implementor of Dump.
13 //! Dumping the analysis is implemented by walking the AST and getting a bunch of
14 //! info out from all over the place. We use Def IDs to identify objects. The
15 //! tricky part is getting syntactic (span, source text) and semantic (reference
16 //! Def IDs) information for parts of expressions which the compiler has discarded.
17 //! E.g., in a path `foo::bar::baz`, the compiler only keeps a span for the whole
18 //! path and a reference to `baz`, but we want spans and references for all three
21 //! SpanUtils is used to manipulate spans. In particular, to extract sub-spans
22 //! from spans (e.g., the span for `bar` from the above example path).
23 //! DumpVisitor walks the AST and processes it, and an implementor of Dump
24 //! is used for recording the output in a format-agnostic way (see CsvDumper
27 use rustc::hir::def::Def as HirDef;
28 use rustc::hir::def_id::DefId;
29 use rustc::hir::map::Node;
30 use rustc::ty::{self, TyCtxt};
31 use rustc_data_structures::fx::FxHashSet;
35 use syntax::ast::{self, NodeId, PatKind, Attribute, CRATE_NODE_ID};
36 use syntax::parse::token;
37 use syntax::symbol::keywords;
38 use syntax::visit::{self, Visitor};
39 use syntax::print::pprust::{path_to_string, ty_to_string, bounds_to_string, generics_to_string};
41 use syntax::codemap::Spanned;
44 use {escape, generated_code, SaveContext, PathCollector, lower_attributes};
45 use json_dumper::{JsonDumper, DumpOutput};
46 use span_utils::SpanUtils;
49 use rls_data::{CratePreludeData, Import, ImportKind, SpanData, Ref, RefKind,
50 Def, DefKind, Relation, RelationKind};
52 macro_rules! down_cast_data {
53 ($id:ident, $kind:ident, $sp:expr) => {
54 let $id = if let super::Data::$kind(data) = $id {
57 span_bug!($sp, "unexpected data kind: {:?}", $id);
62 pub struct DumpVisitor<'l, 'tcx: 'l, 'll, O: DumpOutput + 'll> {
63 save_ctxt: SaveContext<'l, 'tcx>,
64 tcx: TyCtxt<'l, 'tcx, 'tcx>,
65 dumper: &'ll mut JsonDumper<O>,
71 // Set of macro definition (callee) spans, and the set
72 // of macro use (callsite) spans. We store these to ensure
73 // we only write one macro def per unique macro definition, and
74 // one macro use per unique callsite span.
75 // mac_defs: HashSet<Span>,
76 macro_calls: FxHashSet<Span>,
79 impl<'l, 'tcx: 'l, 'll, O: DumpOutput + 'll> DumpVisitor<'l, 'tcx, 'll, O> {
80 pub fn new(save_ctxt: SaveContext<'l, 'tcx>,
81 dumper: &'ll mut JsonDumper<O>)
82 -> DumpVisitor<'l, 'tcx, 'll, O> {
83 let span_utils = SpanUtils::new(&save_ctxt.tcx.sess);
88 span: span_utils.clone(),
89 cur_scope: CRATE_NODE_ID,
90 // mac_defs: HashSet::new(),
91 macro_calls: FxHashSet(),
95 fn nest_scope<F>(&mut self, scope_id: NodeId, f: F)
96 where F: FnOnce(&mut DumpVisitor<'l, 'tcx, 'll, O>)
98 let parent_scope = self.cur_scope;
99 self.cur_scope = scope_id;
101 self.cur_scope = parent_scope;
104 fn nest_tables<F>(&mut self, item_id: NodeId, f: F)
105 where F: FnOnce(&mut DumpVisitor<'l, 'tcx, 'll, O>)
107 let item_def_id = self.tcx.hir.local_def_id(item_id);
108 if self.tcx.has_typeck_tables(item_def_id) {
109 let tables = self.tcx.typeck_tables_of(item_def_id);
110 let old_tables = self.save_ctxt.tables;
111 self.save_ctxt.tables = tables;
113 self.save_ctxt.tables = old_tables;
119 fn span_from_span(&self, span: Span) -> SpanData {
120 self.save_ctxt.span_from_span(span)
123 pub fn dump_crate_info(&mut self, name: &str, krate: &ast::Crate) {
124 let source_file = self.tcx.sess.local_crate_source_file.as_ref();
125 let crate_root = source_file.map(|source_file| {
126 let source_file = Path::new(source_file);
127 match source_file.file_name() {
128 Some(_) => source_file.parent().unwrap().display().to_string(),
129 None => source_file.display().to_string(),
133 let data = CratePreludeData {
134 crate_name: name.into(),
135 crate_root: crate_root.unwrap_or("<no source>".to_owned()),
136 external_crates: self.save_ctxt.get_external_crates(),
137 span: self.span_from_span(krate.span),
140 self.dumper.crate_prelude(data);
143 // Return all non-empty prefixes of a path.
144 // For each prefix, we return the span for the last segment in the prefix and
145 // a str representation of the entire prefix.
146 fn process_path_prefixes(&self, path: &ast::Path) -> Vec<(Span, String)> {
147 let segments = &path.segments[if path.is_global() { 1 } else { 0 }..];
149 let mut result = Vec::with_capacity(segments.len());
151 let mut segs = vec![];
152 for (i, seg) in segments.iter().enumerate() {
153 segs.push(seg.clone());
154 let sub_path = ast::Path {
155 span: seg.span, // span for the last segment
158 let qualname = if i == 0 && path.is_global() {
159 format!("::{}", path_to_string(&sub_path))
161 path_to_string(&sub_path)
163 result.push((seg.span, qualname));
164 segs = sub_path.segments;
170 fn write_sub_paths(&mut self, path: &ast::Path) {
171 let sub_paths = self.process_path_prefixes(path);
172 for (span, _) in sub_paths {
173 let span = self.span_from_span(span);
174 self.dumper.dump_ref(Ref {
182 // As write_sub_paths, but does not process the last ident in the path (assuming it
183 // will be processed elsewhere). See note on write_sub_paths about global.
184 fn write_sub_paths_truncated(&mut self, path: &ast::Path) {
185 let sub_paths = self.process_path_prefixes(path);
186 let len = sub_paths.len();
191 for (span, _) in sub_paths.into_iter().take(len - 1) {
192 let span = self.span_from_span(span);
193 self.dumper.dump_ref(Ref {
201 // As write_sub_paths, but expects a path of the form module_path::trait::method
202 // Where trait could actually be a struct too.
203 fn write_sub_path_trait_truncated(&mut self, path: &ast::Path) {
204 let sub_paths = self.process_path_prefixes(path);
205 let len = sub_paths.len();
209 let sub_paths = &sub_paths[.. (len-1)];
211 // write the trait part of the sub-path
212 let (ref span, _) = sub_paths[len-2];
213 let span = self.span_from_span(*span);
214 self.dumper.dump_ref(Ref {
220 // write the other sub-paths
224 let sub_paths = &sub_paths[..len-2];
225 for &(ref span, _) in sub_paths {
226 let span = self.span_from_span(*span);
227 self.dumper.dump_ref(Ref {
235 fn lookup_def_id(&self, ref_id: NodeId) -> Option<DefId> {
236 match self.save_ctxt.get_path_def(ref_id) {
237 HirDef::PrimTy(..) | HirDef::SelfTy(..) | HirDef::Err => None,
238 def => Some(def.def_id()),
242 fn process_def_kind(&mut self,
245 sub_span: Option<Span>,
247 if self.span.filter_generated(sub_span, span) {
251 let def = self.save_ctxt.get_path_def(ref_id);
254 let span = self.span_from_span(sub_span.expect("No span found for mod ref"));
255 self.dumper.dump_ref(Ref {
258 ref_id: ::id_from_def_id(def_id),
262 HirDef::Variant(..) |
265 HirDef::TyAlias(..) |
266 HirDef::Trait(_) => {
267 let span = self.span_from_span(sub_span.expect("No span found for type ref"));
268 self.dumper.dump_ref(Ref {
271 ref_id: ::id_from_def_id(def_id),
276 HirDef::StructCtor(..) |
277 HirDef::VariantCtor(..) => {
278 let span = self.span_from_span(sub_span.expect("No span found for var ref"));
279 self.dumper.dump_ref(Ref {
280 kind: RefKind::Variable,
282 ref_id: ::id_from_def_id(def_id),
286 let span = self.span_from_span(sub_span.expect("No span found for fn ref"));
287 self.dumper.dump_ref(Ref {
288 kind: RefKind::Function,
290 ref_id: ::id_from_def_id(def_id),
293 // With macros 2.0, we can legitimately get a ref to a macro, but
294 // we don't handle it properly for now (FIXME).
295 HirDef::Macro(..) => {}
300 HirDef::TyParam(..) |
302 HirDef::AssociatedTy(..) |
303 HirDef::AssociatedConst(..) |
305 HirDef::GlobalAsm(_) |
308 "process_def_kind for unexpected item: {:?}",
314 fn process_formals(&mut self, formals: &'l [ast::Arg], qualname: &str) {
316 self.visit_pat(&arg.pat);
317 let mut collector = PathCollector::new();
318 collector.visit_pat(&arg.pat);
319 let span_utils = self.span.clone();
320 for &(id, ref p, ..) in &collector.collected_paths {
321 let hir_id = self.tcx.hir.node_to_hir_id(id);
322 let typ = match self.save_ctxt.tables.node_id_to_type_opt(hir_id) {
323 Some(s) => s.to_string(),
326 // get the span only for the name of the variable (I hope the path is only ever a
327 // variable name, but who knows?)
328 let sub_span = span_utils.span_for_last_ident(p.span);
329 if !self.span.filter_generated(sub_span, p.span) {
330 let id = ::id_from_node_id(id, &self.save_ctxt);
331 let span = self.span_from_span(sub_span.expect("No span found for variable"));
333 self.dumper.dump_def(false, Def {
334 kind: DefKind::Local,
337 name: path_to_string(p),
338 qualname: format!("{}::{}", qualname, path_to_string(p)),
352 fn process_method(&mut self,
353 sig: &'l ast::MethodSig,
354 body: Option<&'l ast::Block>,
357 generics: &'l ast::Generics,
358 vis: ast::Visibility,
360 debug!("process_method: {}:{}", id, name);
362 if let Some(mut method_data) = self.save_ctxt.get_method_data(id, name.name, span) {
364 let sig_str = ::make_signature(&sig.decl, &generics);
366 self.nest_tables(id, |v| {
367 v.process_formals(&sig.decl.inputs, &method_data.qualname)
371 self.process_generic_params(&generics, span, &method_data.qualname, id);
373 method_data.value = sig_str;
374 method_data.sig = sig::method_signature(id, name, generics, sig, &self.save_ctxt);
375 self.dumper.dump_def(vis == ast::Visibility::Public, method_data);
378 // walk arg and return types
379 for arg in &sig.decl.inputs {
380 self.visit_ty(&arg.ty);
383 if let ast::FunctionRetTy::Ty(ref ret_ty) = sig.decl.output {
384 self.visit_ty(ret_ty);
388 if let Some(body) = body {
389 self.nest_tables(id, |v| v.nest_scope(id, |v| v.visit_block(body)));
393 fn process_trait_ref(&mut self, trait_ref: &'l ast::TraitRef) {
394 let trait_ref_data = self.save_ctxt.get_trait_ref_data(trait_ref);
395 if let Some(trait_ref_data) = trait_ref_data {
396 self.dumper.dump_ref(trait_ref_data);
398 self.process_path(trait_ref.ref_id, &trait_ref.path);
401 fn process_struct_field_def(&mut self, field: &ast::StructField, parent_id: NodeId) {
402 let field_data = self.save_ctxt.get_field_data(field, parent_id);
403 if let Some(field_data) = field_data {
404 self.dumper.dump_def(field.vis == ast::Visibility::Public, field_data);
408 // Dump generic params bindings, then visit_generics
409 fn process_generic_params(&mut self,
410 generics: &'l ast::Generics,
414 for param in &generics.ty_params {
415 let param_ss = param.span;
416 let name = escape(self.span.snippet(param_ss));
417 // Append $id to name to make sure each one is unique
418 let qualname = format!("{}::{}${}",
422 if !self.span.filter_generated(Some(param_ss), full_span) {
423 let id = ::id_from_node_id(param.id, &self.save_ctxt);
424 let span = self.span_from_span(param_ss);
426 self.dumper.dump_def(false, Def {
432 value: String::new(),
442 self.visit_generics(generics);
445 fn process_fn(&mut self,
447 decl: &'l ast::FnDecl,
448 ty_params: &'l ast::Generics,
449 body: &'l ast::Block) {
450 if let Some(fn_data) = self.save_ctxt.get_item_data(item) {
451 down_cast_data!(fn_data, DefData, item.span);
452 self.nest_tables(item.id, |v| v.process_formals(&decl.inputs, &fn_data.qualname));
453 self.process_generic_params(ty_params, item.span, &fn_data.qualname, item.id);
454 self.dumper.dump_def(item.vis == ast::Visibility::Public, fn_data);
457 for arg in &decl.inputs {
458 self.visit_ty(&arg.ty);
461 if let ast::FunctionRetTy::Ty(ref ret_ty) = decl.output {
462 self.visit_ty(&ret_ty);
465 self.nest_tables(item.id, |v| v.nest_scope(item.id, |v| v.visit_block(&body)));
468 fn process_static_or_const_item(&mut self,
471 expr: &'l ast::Expr) {
472 self.nest_tables(item.id, |v| {
473 if let Some(var_data) = v.save_ctxt.get_item_data(item) {
474 down_cast_data!(var_data, DefData, item.span);
475 v.dumper.dump_def(item.vis == ast::Visibility::Public, var_data);
482 fn process_assoc_const(&mut self,
487 expr: Option<&'l ast::Expr>,
489 vis: ast::Visibility,
490 attrs: &'l [Attribute]) {
491 let qualname = format!("::{}", self.tcx.node_path_str(id));
493 let sub_span = self.span.sub_span_after_keyword(span, keywords::Const);
495 if !self.span.filter_generated(sub_span, span) {
496 let sig = sig::assoc_const_signature(id, name, typ, expr, &self.save_ctxt);
497 let id = ::id_from_node_id(id, &self.save_ctxt);
498 let span = self.span_from_span(sub_span.expect("No span found for variable"));
500 self.dumper.dump_def(vis == ast::Visibility::Public, Def {
501 kind: DefKind::Const,
504 name: name.to_string(),
506 value: ty_to_string(&typ),
507 parent: Some(::id_from_def_id(parent_id)),
510 docs: self.save_ctxt.docs_for_attrs(attrs),
512 attributes: lower_attributes(attrs.to_owned(), &self.save_ctxt),
516 // walk type and init value
518 if let Some(expr) = expr {
519 self.visit_expr(expr);
523 // FIXME tuple structs should generate tuple-specific data.
524 fn process_struct(&mut self,
526 def: &'l ast::VariantData,
527 ty_params: &'l ast::Generics) {
528 let name = item.ident.to_string();
529 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
531 let sub_span = self.span.sub_span_after_keyword(item.span, keywords::Struct);
532 let (value, fields) =
533 if let ast::ItemKind::Struct(ast::VariantData::Struct(ref fields, _), _) = item.node
535 let include_priv_fields = !self.save_ctxt.config.pub_only;
536 let fields_str = fields
539 .filter_map(|(i, f)| {
540 if include_priv_fields || f.vis == ast::Visibility::Public {
541 f.ident.map(|i| i.to_string()).or_else(|| Some(i.to_string()))
548 let value = format!("{} {{ {} }}", name, fields_str);
549 (value, fields.iter().map(|f| ::id_from_node_id(f.id, &self.save_ctxt)).collect())
551 (String::new(), vec![])
554 if !self.span.filter_generated(sub_span, item.span) {
555 let span = self.span_from_span(sub_span.expect("No span found for struct"));
556 self.dumper.dump_def(item.vis == ast::Visibility::Public, Def {
557 kind: DefKind::Struct,
558 id: ::id_from_node_id(item.id, &self.save_ctxt),
561 qualname: qualname.clone(),
566 docs: self.save_ctxt.docs_for_attrs(&item.attrs),
567 sig: sig::item_signature(item, &self.save_ctxt),
568 attributes: lower_attributes(item.attrs.clone(), &self.save_ctxt),
572 for field in def.fields() {
573 self.process_struct_field_def(field, item.id);
574 self.visit_ty(&field.ty);
577 self.process_generic_params(ty_params, item.span, &qualname, item.id);
580 fn process_enum(&mut self,
582 enum_definition: &'l ast::EnumDef,
583 ty_params: &'l ast::Generics) {
584 let enum_data = self.save_ctxt.get_item_data(item);
585 let enum_data = match enum_data {
589 down_cast_data!(enum_data, DefData, item.span);
591 for variant in &enum_definition.variants {
592 let name = variant.node.name.name.to_string();
593 let mut qualname = enum_data.qualname.clone();
594 qualname.push_str("::");
595 qualname.push_str(&name);
597 match variant.node.data {
598 ast::VariantData::Struct(ref fields, _) => {
599 let sub_span = self.span.span_for_first_ident(variant.span);
600 let fields_str = fields.iter()
602 .map(|(i, f)| f.ident.map(|i| i.to_string())
603 .unwrap_or(i.to_string()))
606 let value = format!("{}::{} {{ {} }}", enum_data.name, name, fields_str);
607 if !self.span.filter_generated(sub_span, variant.span) {
608 let span = self.span_from_span(
609 sub_span.expect("No span found for struct variant"));
610 let id = ::id_from_node_id(variant.node.data.id(), &self.save_ctxt);
611 let parent = Some(::id_from_node_id(item.id, &self.save_ctxt));
613 self.dumper.dump_def(item.vis == ast::Visibility::Public, Def {
614 kind: DefKind::Struct,
623 docs: self.save_ctxt.docs_for_attrs(&variant.node.attrs),
624 sig: sig::variant_signature(variant, &self.save_ctxt),
625 attributes: lower_attributes(variant.node.attrs.clone(),
631 let sub_span = self.span.span_for_first_ident(variant.span);
632 let mut value = format!("{}::{}", enum_data.name, name);
633 if let &ast::VariantData::Tuple(ref fields, _) = v {
635 value.push_str(&fields.iter()
636 .map(|f| ty_to_string(&f.ty))
641 if !self.span.filter_generated(sub_span, variant.span) {
643 self.span_from_span(sub_span.expect("No span found for tuple variant"));
644 let id = ::id_from_node_id(variant.node.data.id(), &self.save_ctxt);
645 let parent = Some(::id_from_node_id(item.id, &self.save_ctxt));
647 self.dumper.dump_def(item.vis == ast::Visibility::Public, Def {
648 kind: DefKind::Tuple,
657 docs: self.save_ctxt.docs_for_attrs(&variant.node.attrs),
658 sig: sig::variant_signature(variant, &self.save_ctxt),
659 attributes: lower_attributes(variant.node.attrs.clone(),
667 for field in variant.node.data.fields() {
668 self.process_struct_field_def(field, variant.node.data.id());
669 self.visit_ty(&field.ty);
672 self.process_generic_params(ty_params, item.span, &enum_data.qualname, item.id);
673 self.dumper.dump_def(item.vis == ast::Visibility::Public, enum_data);
676 fn process_impl(&mut self,
678 type_parameters: &'l ast::Generics,
679 trait_ref: &'l Option<ast::TraitRef>,
681 impl_items: &'l [ast::ImplItem]) {
682 if let Some(impl_data) = self.save_ctxt.get_item_data(item) {
683 down_cast_data!(impl_data, RelationData, item.span);
684 self.dumper.dump_relation(impl_data);
687 if let &Some(ref trait_ref) = trait_ref {
688 self.process_path(trait_ref.ref_id, &trait_ref.path);
690 self.process_generic_params(type_parameters, item.span, "", item.id);
691 for impl_item in impl_items {
692 let map = &self.tcx.hir;
693 self.process_impl_item(impl_item, map.local_def_id(item.id));
697 fn process_trait(&mut self,
699 generics: &'l ast::Generics,
700 trait_refs: &'l ast::TyParamBounds,
701 methods: &'l [ast::TraitItem]) {
702 let name = item.ident.to_string();
703 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
704 let mut val = name.clone();
705 if !generics.lifetimes.is_empty() || !generics.ty_params.is_empty() {
706 val.push_str(&generics_to_string(generics));
708 if !trait_refs.is_empty() {
710 val.push_str(&bounds_to_string(trait_refs));
712 let sub_span = self.span.sub_span_after_keyword(item.span, keywords::Trait);
713 if !self.span.filter_generated(sub_span, item.span) {
714 let id = ::id_from_node_id(item.id, &self.save_ctxt);
715 let span = self.span_from_span(sub_span.expect("No span found for trait"));
717 methods.iter().map(|i| ::id_from_node_id(i.id, &self.save_ctxt)).collect();
718 self.dumper.dump_def(item.vis == ast::Visibility::Public, Def {
719 kind: DefKind::Trait,
723 qualname: qualname.clone(),
728 docs: self.save_ctxt.docs_for_attrs(&item.attrs),
729 sig: sig::item_signature(item, &self.save_ctxt),
730 attributes: lower_attributes(item.attrs.clone(), &self.save_ctxt),
735 for super_bound in trait_refs.iter() {
736 let trait_ref = match *super_bound {
737 ast::TraitTyParamBound(ref trait_ref, _) => {
740 ast::RegionTyParamBound(..) => {
745 let trait_ref = &trait_ref.trait_ref;
746 if let Some(id) = self.lookup_def_id(trait_ref.ref_id) {
747 let sub_span = self.span.sub_span_for_type_name(trait_ref.path.span);
748 if !self.span.filter_generated(sub_span, trait_ref.path.span) {
749 let span = self.span_from_span(sub_span.expect("No span found for trait ref"));
750 self.dumper.dump_ref(Ref {
753 ref_id: ::id_from_def_id(id),
757 if !self.span.filter_generated(sub_span, trait_ref.path.span) {
758 let sub_span = self.span_from_span(sub_span.expect("No span for inheritance"));
759 self.dumper.dump_relation(Relation {
760 kind: RelationKind::SuperTrait,
762 from: ::id_from_def_id(id),
763 to: ::id_from_node_id(item.id, &self.save_ctxt),
769 // walk generics and methods
770 self.process_generic_params(generics, item.span, &qualname, item.id);
771 for method in methods {
772 let map = &self.tcx.hir;
773 self.process_trait_item(method, map.local_def_id(item.id))
777 // `item` is the module in question, represented as an item.
778 fn process_mod(&mut self, item: &ast::Item) {
779 if let Some(mod_data) = self.save_ctxt.get_item_data(item) {
780 down_cast_data!(mod_data, DefData, item.span);
781 self.dumper.dump_def(item.vis == ast::Visibility::Public, mod_data);
785 fn process_path(&mut self, id: NodeId, path: &ast::Path) {
786 let path_data = self.save_ctxt.get_path_data(id, path);
787 if generated_code(path.span) && path_data.is_none() {
791 let path_data = match path_data {
798 self.dumper.dump_ref(path_data);
800 // Modules or types in the path prefix.
801 match self.save_ctxt.get_path_def(id) {
802 HirDef::Method(did) => {
803 let ti = self.tcx.associated_item(did);
804 if ti.kind == ty::AssociatedKind::Method && ti.method_has_self_argument {
805 self.write_sub_path_trait_truncated(path);
811 HirDef::StructCtor(..) |
812 HirDef::VariantCtor(..) |
813 HirDef::AssociatedConst(..) |
818 HirDef::Variant(..) |
819 HirDef::TyAlias(..) |
820 HirDef::AssociatedTy(..) => self.write_sub_paths_truncated(path),
825 fn process_struct_lit(&mut self,
828 fields: &'l [ast::Field],
829 variant: &'l ty::VariantDef,
830 base: &'l Option<P<ast::Expr>>) {
831 self.write_sub_paths_truncated(path);
833 if let Some(struct_lit_data) = self.save_ctxt.get_expr_data(ex) {
834 down_cast_data!(struct_lit_data, RefData, ex.span);
835 if !generated_code(ex.span) {
836 self.dumper.dump_ref(struct_lit_data);
839 for field in fields {
840 if let Some(field_data) = self.save_ctxt
841 .get_field_ref_data(field, variant) {
842 self.dumper.dump_ref(field_data);
845 self.visit_expr(&field.expr)
849 walk_list!(self, visit_expr, base);
852 fn process_method_call(&mut self, ex: &'l ast::Expr, args: &'l [P<ast::Expr>]) {
853 if let Some(mcd) = self.save_ctxt.get_expr_data(ex) {
854 down_cast_data!(mcd, RefData, ex.span);
855 if !generated_code(ex.span) {
856 self.dumper.dump_ref(mcd);
860 // walk receiver and args
861 walk_list!(self, visit_expr, args);
864 fn process_pat(&mut self, p: &'l ast::Pat) {
866 PatKind::Struct(ref _path, ref fields, _) => {
867 // FIXME do something with _path?
868 let hir_id = self.tcx.hir.node_to_hir_id(p.id);
869 let adt = match self.save_ctxt.tables.node_id_to_type_opt(hir_id) {
870 Some(ty) => ty.ty_adt_def().unwrap(),
872 visit::walk_pat(self, p);
876 let variant = adt.variant_of_def(self.save_ctxt.get_path_def(p.id));
878 for &Spanned { node: ref field, span } in fields {
879 let sub_span = self.span.span_for_first_ident(span);
880 if let Some(f) = variant.find_field_named(field.ident.name) {
881 if !self.span.filter_generated(sub_span, span) {
883 self.span_from_span(sub_span.expect("No span fund for var ref"));
884 self.dumper.dump_ref(Ref {
885 kind: RefKind::Variable,
887 ref_id: ::id_from_def_id(f.did),
891 self.visit_pat(&field.pat);
894 _ => visit::walk_pat(self, p),
899 fn process_var_decl(&mut self, p: &'l ast::Pat, value: String) {
900 // The local could declare multiple new vars, we must walk the
901 // pattern and collect them all.
902 let mut collector = PathCollector::new();
903 collector.visit_pat(&p);
906 for &(id, ref p, immut) in &collector.collected_paths {
907 let mut value = match immut {
908 ast::Mutability::Immutable => value.to_string(),
911 let hir_id = self.tcx.hir.node_to_hir_id(id);
912 let typ = match self.save_ctxt.tables.node_id_to_type_opt(hir_id) {
914 let typ = typ.to_string();
915 if !value.is_empty() {
916 value.push_str(": ");
918 value.push_str(&typ);
921 None => String::new(),
924 // Get the span only for the name of the variable (I hope the path
925 // is only ever a variable name, but who knows?).
926 let sub_span = self.span.span_for_last_ident(p.span);
927 // Rust uses the id of the pattern for var lookups, so we'll use it too.
928 if !self.span.filter_generated(sub_span, p.span) {
929 let qualname = format!("{}${}", path_to_string(p), id);
930 let id = ::id_from_node_id(id, &self.save_ctxt);
931 let span = self.span_from_span(sub_span.expect("No span found for variable"));
933 self.dumper.dump_def(false, Def {
934 kind: DefKind::Local,
937 name: path_to_string(p),
951 /// Extract macro use and definition information from the AST node defined
952 /// by the given NodeId, using the expansion information from the node's
955 /// If the span is not macro-generated, do nothing, else use callee and
956 /// callsite spans to record macro definition and use data, using the
957 /// mac_uses and mac_defs sets to prevent multiples.
958 fn process_macro_use(&mut self, span: Span) {
959 let source_span = span.source_callsite();
960 if self.macro_calls.contains(&source_span) {
963 self.macro_calls.insert(source_span);
965 let data = match self.save_ctxt.get_macro_use_data(span) {
970 self.dumper.macro_use(data);
972 // FIXME write the macro def
973 // let mut hasher = DefaultHasher::new();
974 // data.callee_span.hash(&mut hasher);
975 // let hash = hasher.finish();
976 // let qualname = format!("{}::{}", data.name, hash);
977 // Don't write macro definition for imported macros
978 // if !self.mac_defs.contains(&data.callee_span)
979 // && !data.imported {
980 // self.mac_defs.insert(data.callee_span);
981 // if let Some(sub_span) = self.span.span_for_macro_def_name(data.callee_span) {
982 // self.dumper.macro_data(MacroData {
984 // name: data.name.clone(),
985 // qualname: qualname.clone(),
986 // // FIXME where do macro docs come from?
987 // docs: String::new(),
988 // }.lower(self.tcx));
993 fn process_trait_item(&mut self, trait_item: &'l ast::TraitItem, trait_id: DefId) {
994 self.process_macro_use(trait_item.span);
995 match trait_item.node {
996 ast::TraitItemKind::Const(ref ty, ref expr) => {
997 self.process_assoc_const(trait_item.id,
998 trait_item.ident.name,
1001 expr.as_ref().map(|e| &**e),
1003 ast::Visibility::Public,
1006 ast::TraitItemKind::Method(ref sig, ref body) => {
1007 self.process_method(sig,
1008 body.as_ref().map(|x| &**x),
1011 &trait_item.generics,
1012 ast::Visibility::Public,
1015 ast::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();
1018 let qualname = format!("::{}", self.tcx.node_path_str(trait_item.id));
1019 let sub_span = self.span.sub_span_after_keyword(trait_item.span, keywords::Type);
1021 if !self.span.filter_generated(sub_span, trait_item.span) {
1022 let span = self.span_from_span(sub_span.expect("No span found for assoc type"));
1023 let id = ::id_from_node_id(trait_item.id, &self.save_ctxt);
1025 self.dumper.dump_def(true, Def {
1026 kind: DefKind::Type,
1031 value: self.span.snippet(trait_item.span),
1032 parent: Some(::id_from_def_id(trait_id)),
1035 docs: self.save_ctxt.docs_for_attrs(&trait_item.attrs),
1036 sig: sig::assoc_type_signature(trait_item.id,
1039 default_ty.as_ref().map(|ty| &**ty),
1041 attributes: lower_attributes(trait_item.attrs.clone(), &self.save_ctxt),
1045 if let &Some(ref default_ty) = default_ty {
1046 self.visit_ty(default_ty)
1049 ast::TraitItemKind::Macro(_) => {}
1053 fn process_impl_item(&mut self, impl_item: &'l ast::ImplItem, impl_id: DefId) {
1054 self.process_macro_use(impl_item.span);
1055 match impl_item.node {
1056 ast::ImplItemKind::Const(ref ty, ref expr) => {
1057 self.process_assoc_const(impl_item.id,
1058 impl_item.ident.name,
1063 impl_item.vis.clone(),
1066 ast::ImplItemKind::Method(ref sig, ref body) => {
1067 self.process_method(sig,
1071 &impl_item.generics,
1072 impl_item.vis.clone(),
1075 ast::ImplItemKind::Type(ref ty) => {
1076 // FIXME uses of the assoc type should ideally point to this
1077 // 'def' and the name here should be a ref to the def in the
1081 ast::ImplItemKind::Macro(_) => {}
1086 impl<'l, 'tcx: 'l, 'll, O: DumpOutput + 'll> Visitor<'l> for DumpVisitor<'l, 'tcx, 'll, O> {
1087 fn visit_mod(&mut self, m: &'l ast::Mod, span: Span, attrs: &[ast::Attribute], id: NodeId) {
1088 // Since we handle explicit modules ourselves in visit_item, this should
1089 // only get called for the root module of a crate.
1090 assert_eq!(id, ast::CRATE_NODE_ID);
1092 let qualname = format!("::{}", self.tcx.node_path_str(id));
1094 let cm = self.tcx.sess.codemap();
1095 let filename = cm.span_to_filename(span);
1096 let data_id = ::id_from_node_id(id, &self.save_ctxt);
1097 let children = m.items.iter().map(|i| ::id_from_node_id(i.id, &self.save_ctxt)).collect();
1098 let span = self.span_from_span(span);
1100 self.dumper.dump_def(true, Def {
1103 name: String::new(),
1110 docs: self.save_ctxt.docs_for_attrs(attrs),
1112 attributes: lower_attributes(attrs.to_owned(), &self.save_ctxt),
1114 self.nest_scope(id, |v| visit::walk_mod(v, m));
1117 fn visit_item(&mut self, item: &'l ast::Item) {
1118 use syntax::ast::ItemKind::*;
1119 self.process_macro_use(item.span);
1121 Use(ref use_item) => {
1122 match use_item.node {
1123 ast::ViewPathSimple(ident, ref path) => {
1124 let sub_span = self.span.span_for_last_ident(path.span);
1125 let mod_id = match self.lookup_def_id(item.id) {
1127 self.process_def_kind(item.id, path.span, sub_span, def_id);
1133 // 'use' always introduces an alias, if there is not an explicit
1134 // one, there is an implicit one.
1135 let sub_span = match self.span.sub_span_after_keyword(use_item.span,
1137 Some(sub_span) => Some(sub_span),
1141 if !self.span.filter_generated(sub_span, path.span) {
1143 self.span_from_span(sub_span.expect("No span found for use"));
1144 self.dumper.import(item.vis == ast::Visibility::Public, Import {
1145 kind: ImportKind::Use,
1146 ref_id: mod_id.map(|id| ::id_from_def_id(id)),
1148 name: ident.to_string(),
1149 value: String::new(),
1152 self.write_sub_paths_truncated(path);
1154 ast::ViewPathGlob(ref path) => {
1155 // Make a comma-separated list of names of imported modules.
1156 let mut names = vec![];
1157 let glob_map = &self.save_ctxt.analysis.glob_map;
1158 let glob_map = glob_map.as_ref().unwrap();
1159 if glob_map.contains_key(&item.id) {
1160 for n in glob_map.get(&item.id).unwrap() {
1161 names.push(n.to_string());
1165 let sub_span = self.span
1166 .sub_span_of_token(item.span, token::BinOp(token::Star));
1167 if !self.span.filter_generated(sub_span, item.span) {
1169 self.span_from_span(sub_span.expect("No span found for use glob"));
1170 self.dumper.import(item.vis == ast::Visibility::Public, Import {
1171 kind: ImportKind::GlobUse,
1174 name: "*".to_owned(),
1175 value: names.join(", "),
1178 self.write_sub_paths(path);
1180 ast::ViewPathList(ref path, ref list) => {
1182 let id = plid.node.id;
1183 if let Some(def_id) = self.lookup_def_id(id) {
1184 let span = plid.span;
1185 self.process_def_kind(id, span, Some(span), def_id);
1189 self.write_sub_paths(path);
1194 let alias_span = self.span.span_for_last_ident(item.span);
1196 if !self.span.filter_generated(alias_span, item.span) {
1198 self.span_from_span(alias_span.expect("No span found for extern crate"));
1199 self.dumper.import(false, Import {
1200 kind: ImportKind::ExternCrate,
1203 name: item.ident.to_string(),
1204 value: String::new(),
1208 Fn(ref decl, .., ref ty_params, ref body) =>
1209 self.process_fn(item, &decl, ty_params, &body),
1210 Static(ref typ, _, ref expr) =>
1211 self.process_static_or_const_item(item, typ, expr),
1212 Const(ref typ, ref expr) =>
1213 self.process_static_or_const_item(item, &typ, &expr),
1214 Struct(ref def, ref ty_params) => self.process_struct(item, def, ty_params),
1215 Enum(ref def, ref ty_params) => self.process_enum(item, def, ty_params),
1220 ref impl_items) => {
1221 self.process_impl(item, ty_params, trait_ref, &typ, impl_items)
1223 Trait(_, ref generics, ref trait_refs, ref methods) =>
1224 self.process_trait(item, generics, trait_refs, methods),
1226 self.process_mod(item);
1227 self.nest_scope(item.id, |v| visit::walk_mod(v, m));
1229 Ty(ref ty, ref ty_params) => {
1230 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
1231 let value = ty_to_string(&ty);
1232 let sub_span = self.span.sub_span_after_keyword(item.span, keywords::Type);
1233 if !self.span.filter_generated(sub_span, item.span) {
1234 let span = self.span_from_span(sub_span.expect("No span found for typedef"));
1235 let id = ::id_from_node_id(item.id, &self.save_ctxt);
1237 self.dumper.dump_def(item.vis == ast::Visibility::Public, Def {
1238 kind: DefKind::Type,
1241 name: item.ident.to_string(),
1242 qualname: qualname.clone(),
1247 docs: self.save_ctxt.docs_for_attrs(&item.attrs),
1248 sig: sig::item_signature(item, &self.save_ctxt),
1249 attributes: lower_attributes(item.attrs.clone(), &self.save_ctxt),
1254 self.process_generic_params(ty_params, item.span, &qualname, item.id);
1257 _ => visit::walk_item(self, item),
1261 fn visit_generics(&mut self, generics: &'l ast::Generics) {
1262 for param in generics.ty_params.iter() {
1263 for bound in param.bounds.iter() {
1264 if let ast::TraitTyParamBound(ref trait_ref, _) = *bound {
1265 self.process_trait_ref(&trait_ref.trait_ref);
1268 if let Some(ref ty) = param.default {
1274 fn visit_ty(&mut self, t: &'l ast::Ty) {
1275 self.process_macro_use(t.span);
1277 ast::TyKind::Path(_, ref path) => {
1278 if generated_code(t.span) {
1282 if let Some(id) = self.lookup_def_id(t.id) {
1283 if let Some(sub_span) = self.span.sub_span_for_type_name(t.span) {
1284 let span = self.span_from_span(sub_span);
1285 self.dumper.dump_ref(Ref {
1286 kind: RefKind::Type,
1288 ref_id: ::id_from_def_id(id),
1293 self.write_sub_paths_truncated(path);
1294 visit::walk_path(self, path);
1296 ast::TyKind::Array(ref element, ref length) => {
1297 self.visit_ty(element);
1298 self.nest_tables(length.id, |v| v.visit_expr(length));
1300 _ => visit::walk_ty(self, t),
1304 fn visit_expr(&mut self, ex: &'l ast::Expr) {
1305 debug!("visit_expr {:?}", ex.node);
1306 self.process_macro_use(ex.span);
1308 ast::ExprKind::Struct(ref path, ref fields, ref base) => {
1309 let hir_expr = self.save_ctxt.tcx.hir.expect_expr(ex.id);
1310 let adt = match self.save_ctxt.tables.expr_ty_opt(&hir_expr) {
1311 Some(ty) if ty.ty_adt_def().is_some() => ty.ty_adt_def().unwrap(),
1313 visit::walk_expr(self, ex);
1317 let def = self.save_ctxt.get_path_def(hir_expr.id);
1318 self.process_struct_lit(ex, path, fields, adt.variant_of_def(def), base)
1320 ast::ExprKind::MethodCall(.., ref args) => self.process_method_call(ex, args),
1321 ast::ExprKind::Field(ref sub_ex, _) => {
1322 self.visit_expr(&sub_ex);
1324 if let Some(field_data) = self.save_ctxt.get_expr_data(ex) {
1325 down_cast_data!(field_data, RefData, ex.span);
1326 if !generated_code(ex.span) {
1327 self.dumper.dump_ref(field_data);
1331 ast::ExprKind::TupField(ref sub_ex, idx) => {
1332 self.visit_expr(&sub_ex);
1334 let hir_node = match self.save_ctxt.tcx.hir.find(sub_ex.id) {
1335 Some(Node::NodeExpr(expr)) => expr,
1337 debug!("Missing or weird node for sub-expression {} in {:?}",
1342 let ty = match self.save_ctxt.tables.expr_ty_adjusted_opt(&hir_node) {
1343 Some(ty) => &ty.sty,
1345 visit::walk_expr(self, ex);
1350 ty::TyAdt(def, _) => {
1351 let sub_span = self.span.sub_span_after_token(ex.span, token::Dot);
1352 if !self.span.filter_generated(sub_span, ex.span) {
1354 self.span_from_span(sub_span.expect("No span found for var ref"));
1355 self.dumper.dump_ref(Ref {
1356 kind: RefKind::Variable,
1358 ref_id: ::id_from_def_id(def.struct_variant().fields[idx.node].did),
1362 ty::TyTuple(..) => {}
1363 _ => span_bug!(ex.span,
1364 "Expected struct or tuple type, found {:?}",
1368 ast::ExprKind::Closure(_, ref decl, ref body, _fn_decl_span) => {
1369 let mut id = String::from("$");
1370 id.push_str(&ex.id.to_string());
1372 // walk arg and return types
1373 for arg in &decl.inputs {
1374 self.visit_ty(&arg.ty);
1377 if let ast::FunctionRetTy::Ty(ref ret_ty) = decl.output {
1378 self.visit_ty(&ret_ty);
1382 self.nest_tables(ex.id, |v| {
1383 v.process_formals(&decl.inputs, &id);
1384 v.nest_scope(ex.id, |v| v.visit_expr(body))
1387 ast::ExprKind::ForLoop(ref pattern, ref subexpression, ref block, _) |
1388 ast::ExprKind::WhileLet(ref pattern, ref subexpression, ref block, _) => {
1389 let value = self.span.snippet(subexpression.span);
1390 self.process_var_decl(pattern, value);
1391 debug!("for loop, walk sub-expr: {:?}", subexpression.node);
1392 visit::walk_expr(self, subexpression);
1393 visit::walk_block(self, block);
1395 ast::ExprKind::IfLet(ref pattern, ref subexpression, ref block, ref opt_else) => {
1396 let value = self.span.snippet(subexpression.span);
1397 self.process_var_decl(pattern, value);
1398 visit::walk_expr(self, subexpression);
1399 visit::walk_block(self, block);
1400 opt_else.as_ref().map(|el| visit::walk_expr(self, el));
1402 ast::ExprKind::Repeat(ref element, ref count) => {
1403 self.visit_expr(element);
1404 self.nest_tables(count.id, |v| v.visit_expr(count));
1406 // In particular, we take this branch for call and path expressions,
1407 // where we'll index the idents involved just by continuing to walk.
1409 visit::walk_expr(self, ex)
1414 fn visit_mac(&mut self, mac: &'l ast::Mac) {
1415 // These shouldn't exist in the AST at this point, log a span bug.
1416 span_bug!(mac.span, "macro invocation should have been expanded out of AST");
1419 fn visit_pat(&mut self, p: &'l ast::Pat) {
1420 self.process_macro_use(p.span);
1421 self.process_pat(p);
1424 fn visit_arm(&mut self, arm: &'l ast::Arm) {
1425 let mut collector = PathCollector::new();
1426 for pattern in &arm.pats {
1427 // collect paths from the arm's patterns
1428 collector.visit_pat(&pattern);
1429 self.visit_pat(&pattern);
1432 // This is to get around borrow checking, because we need mut self to call process_path.
1433 let mut paths_to_process = vec![];
1435 // process collected paths
1436 for &(id, ref p, immut) in &collector.collected_paths {
1437 match self.save_ctxt.get_path_def(id) {
1438 HirDef::Local(id) => {
1439 let mut value = if immut == ast::Mutability::Immutable {
1440 self.span.snippet(p.span).to_string()
1442 "<mutable>".to_string()
1444 let hir_id = self.tcx.hir.node_to_hir_id(id);
1445 let typ = self.save_ctxt
1447 .node_id_to_type_opt(hir_id)
1448 .map(|t| t.to_string())
1449 .unwrap_or(String::new());
1450 value.push_str(": ");
1451 value.push_str(&typ);
1453 assert!(p.segments.len() == 1,
1454 "qualified path for local variable def in arm");
1455 if !self.span.filter_generated(Some(p.span), p.span) {
1456 let qualname = format!("{}${}", path_to_string(p), id);
1457 let id = ::id_from_node_id(id, &self.save_ctxt);
1458 let span = self.span_from_span(p.span);
1460 self.dumper.dump_def(false, Def {
1461 kind: DefKind::Local,
1464 name: path_to_string(p),
1470 docs: String::new(),
1476 HirDef::StructCtor(..) | HirDef::VariantCtor(..) |
1477 HirDef::Const(..) | HirDef::AssociatedConst(..) |
1478 HirDef::Struct(..) | HirDef::Variant(..) |
1479 HirDef::TyAlias(..) | HirDef::AssociatedTy(..) |
1480 HirDef::SelfTy(..) => {
1481 paths_to_process.push((id, p.clone()))
1483 def => error!("unexpected definition kind when processing collected paths: {:?}",
1488 for &(id, ref path) in &paths_to_process {
1489 self.process_path(id, path);
1491 walk_list!(self, visit_expr, &arm.guard);
1492 self.visit_expr(&arm.body);
1495 fn visit_path(&mut self, p: &'l ast::Path, id: NodeId) {
1496 self.process_path(id, p);
1499 fn visit_stmt(&mut self, s: &'l ast::Stmt) {
1500 self.process_macro_use(s.span);
1501 visit::walk_stmt(self, s)
1504 fn visit_local(&mut self, l: &'l ast::Local) {
1505 self.process_macro_use(l.span);
1506 let value = l.init.as_ref().map(|i| self.span.snippet(i.span)).unwrap_or(String::new());
1507 self.process_var_decl(&l.pat, value);
1509 // Just walk the initialiser and type (don't want to walk the pattern again).
1510 walk_list!(self, visit_ty, &l.ty);
1511 walk_list!(self, visit_expr, &l.init);
1514 fn visit_foreign_item(&mut self, item: &'l ast::ForeignItem) {
1516 ast::ForeignItemKind::Fn(ref decl, ref generics) => {
1517 if let Some(fn_data) = self.save_ctxt.get_extern_item_data(item) {
1518 down_cast_data!(fn_data, DefData, item.span);
1520 self.nest_tables(item.id, |v| v.process_formals(&decl.inputs,
1521 &fn_data.qualname));
1522 self.process_generic_params(generics, item.span, &fn_data.qualname, item.id);
1523 self.dumper.dump_def(item.vis == ast::Visibility::Public, fn_data);
1526 for arg in &decl.inputs {
1527 self.visit_ty(&arg.ty);
1530 if let ast::FunctionRetTy::Ty(ref ret_ty) = decl.output {
1531 self.visit_ty(&ret_ty);
1534 ast::ForeignItemKind::Static(ref ty, _) => {
1535 if let Some(var_data) = self.save_ctxt.get_extern_item_data(item) {
1536 down_cast_data!(var_data, DefData, item.span);
1537 self.dumper.dump_def(item.vis == ast::Visibility::Public, var_data);