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 JsonDumper is used for
24 //! recording the output.
26 use rustc::hir::def::Def as HirDef;
27 use rustc::hir::def_id::DefId;
28 use rustc::ty::{self, TyCtxt};
29 use rustc_data_structures::fx::FxHashSet;
33 use syntax::ast::{self, Attribute, NodeId, PatKind, CRATE_NODE_ID};
34 use syntax::parse::token;
35 use syntax::symbol::keywords;
36 use syntax::visit::{self, Visitor};
37 use syntax::print::pprust::{
39 generic_params_to_string,
44 use syntax::codemap::{Spanned, DUMMY_SP, respan};
47 use {escape, generated_code, lower_attributes, PathCollector, SaveContext};
48 use json_dumper::{Access, DumpOutput, JsonDumper};
49 use span_utils::SpanUtils;
52 use rls_data::{CratePreludeData, Def, DefKind, GlobalCrateId, Import, ImportKind, Ref, RefKind,
53 Relation, RelationKind, SpanData};
55 macro_rules! down_cast_data {
56 ($id:ident, $kind:ident, $sp:expr) => {
57 let $id = if let super::Data::$kind(data) = $id {
60 span_bug!($sp, "unexpected data kind: {:?}", $id);
65 macro_rules! access_from {
66 ($save_ctxt:expr, $vis:expr, $id:expr) => {
68 public: $vis.node == ast::VisibilityKind::Public,
69 reachable: $save_ctxt.analysis.access_levels.is_reachable($id),
73 ($save_ctxt:expr, $item:expr) => {
75 public: $item.vis.node == ast::VisibilityKind::Public,
76 reachable: $save_ctxt.analysis.access_levels.is_reachable($item.id),
81 pub struct DumpVisitor<'l, 'tcx: 'l, 'll, O: DumpOutput + 'll> {
82 save_ctxt: SaveContext<'l, 'tcx>,
83 tcx: TyCtxt<'l, 'tcx, 'tcx>,
84 dumper: &'ll mut JsonDumper<O>,
90 // Set of macro definition (callee) spans, and the set
91 // of macro use (callsite) spans. We store these to ensure
92 // we only write one macro def per unique macro definition, and
93 // one macro use per unique callsite span.
94 // mac_defs: HashSet<Span>,
95 macro_calls: FxHashSet<Span>,
98 impl<'l, 'tcx: 'l, 'll, O: DumpOutput + 'll> DumpVisitor<'l, 'tcx, 'll, O> {
100 save_ctxt: SaveContext<'l, 'tcx>,
101 dumper: &'ll mut JsonDumper<O>,
102 ) -> DumpVisitor<'l, 'tcx, 'll, O> {
103 let span_utils = SpanUtils::new(&save_ctxt.tcx.sess);
108 span: span_utils.clone(),
109 cur_scope: CRATE_NODE_ID,
110 // mac_defs: HashSet::new(),
111 macro_calls: FxHashSet(),
115 fn nest_scope<F>(&mut self, scope_id: NodeId, f: F)
117 F: FnOnce(&mut DumpVisitor<'l, 'tcx, 'll, O>),
119 let parent_scope = self.cur_scope;
120 self.cur_scope = scope_id;
122 self.cur_scope = parent_scope;
125 fn nest_tables<F>(&mut self, item_id: NodeId, f: F)
127 F: FnOnce(&mut DumpVisitor<'l, 'tcx, 'll, O>),
129 let item_def_id = self.tcx.hir.local_def_id(item_id);
130 if self.tcx.has_typeck_tables(item_def_id) {
131 let tables = self.tcx.typeck_tables_of(item_def_id);
132 let old_tables = self.save_ctxt.tables;
133 self.save_ctxt.tables = tables;
135 self.save_ctxt.tables = old_tables;
141 fn span_from_span(&self, span: Span) -> SpanData {
142 self.save_ctxt.span_from_span(span)
145 pub fn dump_crate_info(&mut self, name: &str, krate: &ast::Crate) {
146 let source_file = self.tcx.sess.local_crate_source_file.as_ref();
147 let crate_root = source_file.map(|source_file| {
148 let source_file = Path::new(source_file);
149 match source_file.file_name() {
150 Some(_) => source_file.parent().unwrap().display().to_string(),
151 None => source_file.display().to_string(),
155 let data = CratePreludeData {
156 crate_id: GlobalCrateId {
158 disambiguator: self.tcx
160 .local_crate_disambiguator()
164 crate_root: crate_root.unwrap_or("<no source>".to_owned()),
165 external_crates: self.save_ctxt.get_external_crates(),
166 span: self.span_from_span(krate.span),
169 self.dumper.crate_prelude(data);
172 // Return all non-empty prefixes of a path.
173 // For each prefix, we return the span for the last segment in the prefix and
174 // a str representation of the entire prefix.
175 fn process_path_prefixes(&self, path: &ast::Path) -> Vec<(Span, String)> {
176 let segments = &path.segments[if path.is_global() { 1 } else { 0 }..];
178 let mut result = Vec::with_capacity(segments.len());
180 let mut segs = vec![];
181 for (i, seg) in segments.iter().enumerate() {
182 segs.push(seg.clone());
183 let sub_path = ast::Path {
184 span: seg.ident.span, // span for the last segment
187 let qualname = if i == 0 && path.is_global() {
188 format!("::{}", path_to_string(&sub_path))
190 path_to_string(&sub_path)
192 result.push((seg.ident.span, qualname));
193 segs = sub_path.segments;
199 fn write_sub_paths(&mut self, path: &ast::Path) {
200 let sub_paths = self.process_path_prefixes(path);
201 for (span, _) in sub_paths {
202 let span = self.span_from_span(span);
203 self.dumper.dump_ref(Ref {
211 // As write_sub_paths, but does not process the last ident in the path (assuming it
212 // will be processed elsewhere). See note on write_sub_paths about global.
213 fn write_sub_paths_truncated(&mut self, path: &ast::Path) {
214 let sub_paths = self.process_path_prefixes(path);
215 let len = sub_paths.len();
220 for (span, _) in sub_paths.into_iter().take(len - 1) {
221 let span = self.span_from_span(span);
222 self.dumper.dump_ref(Ref {
230 // As write_sub_paths, but expects a path of the form module_path::trait::method
231 // Where trait could actually be a struct too.
232 fn write_sub_path_trait_truncated(&mut self, path: &ast::Path) {
233 let sub_paths = self.process_path_prefixes(path);
234 let len = sub_paths.len();
238 let sub_paths = &sub_paths[..(len - 1)];
240 // write the trait part of the sub-path
241 let (ref span, _) = sub_paths[len - 2];
242 let span = self.span_from_span(*span);
243 self.dumper.dump_ref(Ref {
249 // write the other sub-paths
253 let sub_paths = &sub_paths[..len - 2];
254 for &(ref span, _) in sub_paths {
255 let span = self.span_from_span(*span);
256 self.dumper.dump_ref(Ref {
264 fn lookup_def_id(&self, ref_id: NodeId) -> Option<DefId> {
265 match self.save_ctxt.get_path_def(ref_id) {
266 HirDef::PrimTy(..) | HirDef::SelfTy(..) | HirDef::Err => None,
267 def => Some(def.def_id()),
271 fn process_formals(&mut self, formals: &'l [ast::Arg], qualname: &str) {
273 self.visit_pat(&arg.pat);
274 let mut collector = PathCollector::new();
275 collector.visit_pat(&arg.pat);
276 let span_utils = self.span.clone();
278 for (id, ident, ..) in collector.collected_idents {
279 let hir_id = self.tcx.hir.node_to_hir_id(id);
280 let typ = match self.save_ctxt.tables.node_id_to_type_opt(hir_id) {
281 Some(s) => s.to_string(),
284 let sub_span = span_utils.span_for_last_ident(ident.span);
285 if !self.span.filter_generated(sub_span, ident.span) {
286 let id = ::id_from_node_id(id, &self.save_ctxt);
287 let span = self.span_from_span(sub_span.expect("No span found for variable"));
289 self.dumper.dump_def(
295 kind: DefKind::Local,
298 name: ident.to_string(),
299 qualname: format!("{}::{}", qualname, ident.to_string()),
316 sig: &'l ast::MethodSig,
317 body: Option<&'l ast::Block>,
320 generics: &'l ast::Generics,
321 vis: ast::Visibility,
324 debug!("process_method: {}:{}", id, name);
326 if let Some(mut method_data) = self.save_ctxt.get_method_data(id, name.name, span) {
327 let sig_str = ::make_signature(&sig.decl, &generics);
331 |v| v.process_formals(&sig.decl.inputs, &method_data.qualname),
335 self.process_generic_params(&generics, span, &method_data.qualname, id);
337 method_data.value = sig_str;
338 method_data.sig = sig::method_signature(id, name, generics, sig, &self.save_ctxt);
339 self.dumper.dump_def(&access_from!(self.save_ctxt, vis, id), method_data);
342 // walk arg and return types
343 for arg in &sig.decl.inputs {
344 self.visit_ty(&arg.ty);
347 if let ast::FunctionRetTy::Ty(ref ret_ty) = sig.decl.output {
348 self.visit_ty(ret_ty);
352 if let Some(body) = body {
353 self.nest_tables(id, |v| v.nest_scope(id, |v| v.visit_block(body)));
357 fn process_struct_field_def(&mut self, field: &ast::StructField, parent_id: NodeId) {
358 let field_data = self.save_ctxt.get_field_data(field, parent_id);
359 if let Some(field_data) = field_data {
360 self.dumper.dump_def(&access_from!(self.save_ctxt, field), field_data);
364 // Dump generic params bindings, then visit_generics
365 fn process_generic_params(
367 generics: &'l ast::Generics,
372 for param in &generics.params {
373 if let ast::GenericParam::Type(ref ty_param) = *param {
374 let param_ss = ty_param.ident.span;
375 let name = escape(self.span.snippet(param_ss));
376 // Append $id to name to make sure each one is unique
377 let qualname = format!("{}::{}${}", prefix, name, id);
378 if !self.span.filter_generated(Some(param_ss), full_span) {
379 let id = ::id_from_node_id(ty_param.id, &self.save_ctxt);
380 let span = self.span_from_span(param_ss);
382 self.dumper.dump_def(
393 value: String::new(),
405 self.visit_generics(generics);
411 decl: &'l ast::FnDecl,
412 ty_params: &'l ast::Generics,
413 body: &'l ast::Block,
415 if let Some(fn_data) = self.save_ctxt.get_item_data(item) {
416 down_cast_data!(fn_data, DefData, item.span);
419 |v| v.process_formals(&decl.inputs, &fn_data.qualname),
421 self.process_generic_params(ty_params, item.span, &fn_data.qualname, item.id);
422 self.dumper.dump_def(&access_from!(self.save_ctxt, item), fn_data);
425 for arg in &decl.inputs {
426 self.visit_ty(&arg.ty);
429 if let ast::FunctionRetTy::Ty(ref ret_ty) = decl.output {
430 self.visit_ty(&ret_ty);
433 self.nest_tables(item.id, |v| v.nest_scope(item.id, |v| v.visit_block(&body)));
436 fn process_static_or_const_item(
442 self.nest_tables(item.id, |v| {
443 if let Some(var_data) = v.save_ctxt.get_item_data(item) {
444 down_cast_data!(var_data, DefData, item.span);
445 v.dumper.dump_def(&access_from!(v.save_ctxt, item), var_data);
452 fn process_assoc_const(
458 expr: Option<&'l ast::Expr>,
460 vis: ast::Visibility,
461 attrs: &'l [Attribute],
463 let qualname = format!("::{}", self.tcx.node_path_str(id));
465 let sub_span = self.span.sub_span_after_keyword(span, keywords::Const);
467 if !self.span.filter_generated(sub_span, span) {
468 let sig = sig::assoc_const_signature(id, name, typ, expr, &self.save_ctxt);
469 let span = self.span_from_span(sub_span.expect("No span found for variable"));
471 self.dumper.dump_def(
472 &access_from!(self.save_ctxt, vis, id),
474 kind: DefKind::Const,
475 id: ::id_from_node_id(id, &self.save_ctxt),
477 name: name.to_string(),
479 value: ty_to_string(&typ),
480 parent: Some(::id_from_def_id(parent_id)),
483 docs: self.save_ctxt.docs_for_attrs(attrs),
485 attributes: lower_attributes(attrs.to_owned(), &self.save_ctxt),
490 // walk type and init value
492 if let Some(expr) = expr {
493 self.visit_expr(expr);
497 // FIXME tuple structs should generate tuple-specific data.
501 def: &'l ast::VariantData,
502 ty_params: &'l ast::Generics,
504 debug!("process_struct {:?} {:?}", item, item.span);
505 let name = item.ident.to_string();
506 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
508 let (kind, keyword) = match item.node {
509 ast::ItemKind::Struct(_, _) => (DefKind::Struct, keywords::Struct),
510 ast::ItemKind::Union(_, _) => (DefKind::Union, keywords::Union),
514 let sub_span = self.span.sub_span_after_keyword(item.span, keyword);
515 let (value, fields) = match item.node {
516 ast::ItemKind::Struct(ast::VariantData::Struct(ref fields, _), _) |
517 ast::ItemKind::Union(ast::VariantData::Struct(ref fields, _), _) => {
518 let include_priv_fields = !self.save_ctxt.config.pub_only;
519 let fields_str = fields
522 .filter_map(|(i, f)| {
523 if include_priv_fields || f.vis.node == ast::VisibilityKind::Public {
525 .map(|i| i.to_string())
526 .or_else(|| Some(i.to_string()))
533 let value = format!("{} {{ {} }}", name, fields_str);
538 .map(|f| ::id_from_node_id(f.id, &self.save_ctxt))
542 _ => (String::new(), vec![]),
545 if !self.span.filter_generated(sub_span, item.span) {
546 let span = self.span_from_span(sub_span.expect("No span found for struct"));
547 self.dumper.dump_def(
548 &access_from!(self.save_ctxt, item),
551 id: ::id_from_node_id(item.id, &self.save_ctxt),
554 qualname: qualname.clone(),
559 docs: self.save_ctxt.docs_for_attrs(&item.attrs),
560 sig: sig::item_signature(item, &self.save_ctxt),
561 attributes: lower_attributes(item.attrs.clone(), &self.save_ctxt),
566 for field in def.fields() {
567 self.process_struct_field_def(field, item.id);
568 self.visit_ty(&field.ty);
571 self.process_generic_params(ty_params, item.span, &qualname, item.id);
577 enum_definition: &'l ast::EnumDef,
578 ty_params: &'l ast::Generics,
580 let enum_data = self.save_ctxt.get_item_data(item);
581 let enum_data = match enum_data {
585 down_cast_data!(enum_data, DefData, item.span);
587 let access = access_from!(self.save_ctxt, item);
589 for variant in &enum_definition.variants {
590 let name = variant.node.ident.name.to_string();
591 let mut qualname = enum_data.qualname.clone();
592 qualname.push_str("::");
593 qualname.push_str(&name);
595 match variant.node.data {
596 ast::VariantData::Struct(ref fields, _) => {
597 let sub_span = self.span.span_for_first_ident(variant.span);
598 let fields_str = fields
602 f.ident.map(|i| i.to_string()).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) {
609 .span_from_span(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(
616 kind: DefKind::StructVariant,
625 docs: self.save_ctxt.docs_for_attrs(&variant.node.attrs),
626 sig: sig::variant_signature(variant, &self.save_ctxt),
627 attributes: lower_attributes(
628 variant.node.attrs.clone(),
636 let sub_span = self.span.span_for_first_ident(variant.span);
637 let mut value = format!("{}::{}", enum_data.name, name);
638 if let &ast::VariantData::Tuple(ref fields, _) = v {
640 value.push_str(&fields
642 .map(|f| ty_to_string(&f.ty))
647 if !self.span.filter_generated(sub_span, variant.span) {
649 self.span_from_span(sub_span.expect("No span found for tuple variant"));
650 let id = ::id_from_node_id(variant.node.data.id(), &self.save_ctxt);
651 let parent = Some(::id_from_node_id(item.id, &self.save_ctxt));
653 self.dumper.dump_def(
656 kind: DefKind::TupleVariant,
665 docs: self.save_ctxt.docs_for_attrs(&variant.node.attrs),
666 sig: sig::variant_signature(variant, &self.save_ctxt),
667 attributes: lower_attributes(
668 variant.node.attrs.clone(),
678 for field in variant.node.data.fields() {
679 self.process_struct_field_def(field, variant.node.data.id());
680 self.visit_ty(&field.ty);
683 self.process_generic_params(ty_params, item.span, &enum_data.qualname, item.id);
684 self.dumper.dump_def(&access, enum_data);
690 type_parameters: &'l ast::Generics,
691 trait_ref: &'l Option<ast::TraitRef>,
693 impl_items: &'l [ast::ImplItem],
695 if let Some(impl_data) = self.save_ctxt.get_item_data(item) {
696 if let super::Data::RelationData(rel, imp) = impl_data {
697 self.dumper.dump_relation(rel);
698 self.dumper.dump_impl(imp);
700 span_bug!(item.span, "unexpected data kind: {:?}", impl_data);
704 if let &Some(ref trait_ref) = trait_ref {
705 self.process_path(trait_ref.ref_id, &trait_ref.path);
707 self.process_generic_params(type_parameters, item.span, "", item.id);
708 for impl_item in impl_items {
709 let map = &self.tcx.hir;
710 self.process_impl_item(impl_item, map.local_def_id(item.id));
717 generics: &'l ast::Generics,
718 trait_refs: &'l ast::TyParamBounds,
719 methods: &'l [ast::TraitItem],
721 let name = item.ident.to_string();
722 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
723 let mut val = name.clone();
724 if !generics.params.is_empty() {
725 val.push_str(&generic_params_to_string(&generics.params));
727 if !trait_refs.is_empty() {
729 val.push_str(&bounds_to_string(trait_refs));
731 let sub_span = self.span.sub_span_after_keyword(item.span, keywords::Trait);
732 if !self.span.filter_generated(sub_span, item.span) {
733 let id = ::id_from_node_id(item.id, &self.save_ctxt);
734 let span = self.span_from_span(sub_span.expect("No span found for trait"));
735 let children = methods
737 .map(|i| ::id_from_node_id(i.id, &self.save_ctxt))
739 self.dumper.dump_def(
740 &access_from!(self.save_ctxt, item),
742 kind: DefKind::Trait,
746 qualname: qualname.clone(),
751 docs: self.save_ctxt.docs_for_attrs(&item.attrs),
752 sig: sig::item_signature(item, &self.save_ctxt),
753 attributes: lower_attributes(item.attrs.clone(), &self.save_ctxt),
759 for super_bound in trait_refs.iter() {
760 let trait_ref = match *super_bound {
761 ast::TraitTyParamBound(ref trait_ref, _) => trait_ref,
762 ast::RegionTyParamBound(..) => {
767 let trait_ref = &trait_ref.trait_ref;
768 if let Some(id) = self.lookup_def_id(trait_ref.ref_id) {
769 let sub_span = self.span.sub_span_for_type_name(trait_ref.path.span);
770 if !self.span.filter_generated(sub_span, trait_ref.path.span) {
771 let span = self.span_from_span(sub_span.expect("No span found for trait ref"));
772 self.dumper.dump_ref(Ref {
775 ref_id: ::id_from_def_id(id),
779 if !self.span.filter_generated(sub_span, trait_ref.path.span) {
780 let sub_span = self.span_from_span(sub_span.expect("No span for inheritance"));
781 self.dumper.dump_relation(Relation {
782 kind: RelationKind::SuperTrait,
784 from: ::id_from_def_id(id),
785 to: ::id_from_node_id(item.id, &self.save_ctxt),
791 // walk generics and methods
792 self.process_generic_params(generics, item.span, &qualname, item.id);
793 for method in methods {
794 let map = &self.tcx.hir;
795 self.process_trait_item(method, map.local_def_id(item.id))
799 // `item` is the module in question, represented as an item.
800 fn process_mod(&mut self, item: &ast::Item) {
801 if let Some(mod_data) = self.save_ctxt.get_item_data(item) {
802 down_cast_data!(mod_data, DefData, item.span);
803 self.dumper.dump_def(&access_from!(self.save_ctxt, item), mod_data);
807 fn dump_path_ref(&mut self, id: NodeId, path: &ast::Path) {
808 let path_data = self.save_ctxt.get_path_data(id, path);
809 if let Some(path_data) = path_data {
810 self.dumper.dump_ref(path_data);
814 fn process_path(&mut self, id: NodeId, path: &'l ast::Path) {
815 debug!("process_path {:?}", path);
816 if generated_code(path.span) {
819 self.dump_path_ref(id, path);
822 for seg in &path.segments {
823 if let Some(ref params) = seg.parameters {
825 ast::PathParameters::AngleBracketed(ref data) => for t in &data.types {
828 ast::PathParameters::Parenthesized(ref data) => {
829 for t in &data.inputs {
832 if let Some(ref t) = data.output {
840 // Modules or types in the path prefix.
841 match self.save_ctxt.get_path_def(id) {
842 HirDef::Method(did) => {
843 let ti = self.tcx.associated_item(did);
844 if ti.kind == ty::AssociatedKind::Method && ti.method_has_self_argument {
845 self.write_sub_path_trait_truncated(path);
851 HirDef::StructCtor(..) |
852 HirDef::VariantCtor(..) |
853 HirDef::AssociatedConst(..) |
858 HirDef::Variant(..) |
859 HirDef::TyAlias(..) |
860 HirDef::AssociatedTy(..) => self.write_sub_paths_truncated(path),
865 fn process_struct_lit(
869 fields: &'l [ast::Field],
870 variant: &'l ty::VariantDef,
871 base: &'l Option<P<ast::Expr>>,
873 self.write_sub_paths_truncated(path);
875 if let Some(struct_lit_data) = self.save_ctxt.get_expr_data(ex) {
876 down_cast_data!(struct_lit_data, RefData, ex.span);
877 if !generated_code(ex.span) {
878 self.dumper.dump_ref(struct_lit_data);
881 for field in fields {
882 if let Some(field_data) = self.save_ctxt.get_field_ref_data(field, variant) {
883 self.dumper.dump_ref(field_data);
886 self.visit_expr(&field.expr)
890 walk_list!(self, visit_expr, base);
893 fn process_method_call(
896 seg: &'l ast::PathSegment,
897 args: &'l [P<ast::Expr>],
899 debug!("process_method_call {:?} {:?}", ex, ex.span);
900 if let Some(mcd) = self.save_ctxt.get_expr_data(ex) {
901 down_cast_data!(mcd, RefData, ex.span);
902 if !generated_code(ex.span) {
903 self.dumper.dump_ref(mcd);
907 // Explicit types in the turbo-fish.
908 if let Some(ref params) = seg.parameters {
909 if let ast::PathParameters::AngleBracketed(ref data) = **params {
910 for t in &data.types {
916 // walk receiver and args
917 walk_list!(self, visit_expr, args);
920 fn process_pat(&mut self, p: &'l ast::Pat) {
922 PatKind::Struct(ref _path, ref fields, _) => {
923 // FIXME do something with _path?
924 let hir_id = self.tcx.hir.node_to_hir_id(p.id);
925 let adt = match self.save_ctxt.tables.node_id_to_type_opt(hir_id) {
926 Some(ty) => ty.ty_adt_def().unwrap(),
928 visit::walk_pat(self, p);
932 let variant = adt.variant_of_def(self.save_ctxt.get_path_def(p.id));
934 for &Spanned { node: ref field, span } in fields {
935 let sub_span = self.span.span_for_first_ident(span);
936 if let Some(index) = self.tcx.find_field_index(field.ident, variant) {
937 if !self.span.filter_generated(sub_span, span) {
939 self.span_from_span(sub_span.expect("No span fund for var ref"));
940 self.dumper.dump_ref(Ref {
941 kind: RefKind::Variable,
943 ref_id: ::id_from_def_id(variant.fields[index].did),
947 self.visit_pat(&field.pat);
950 _ => visit::walk_pat(self, p),
954 fn process_var_decl_multi(&mut self, pats: &'l [P<ast::Pat>]) {
955 let mut collector = PathCollector::new();
956 for pattern in pats {
957 // collect paths from the arm's patterns
958 collector.visit_pat(&pattern);
959 self.visit_pat(&pattern);
962 // process collected paths
963 for (id, ident, immut) in collector.collected_idents {
964 match self.save_ctxt.get_path_def(id) {
965 HirDef::Local(id) => {
966 let mut value = if immut == ast::Mutability::Immutable {
967 self.span.snippet(ident.span).to_string()
969 "<mutable>".to_string()
971 let hir_id = self.tcx.hir.node_to_hir_id(id);
972 let typ = self.save_ctxt
974 .node_id_to_type_opt(hir_id)
975 .map(|t| t.to_string())
976 .unwrap_or(String::new());
977 value.push_str(": ");
978 value.push_str(&typ);
980 if !self.span.filter_generated(Some(ident.span), ident.span) {
981 let qualname = format!("{}${}", ident.to_string(), id);
982 let id = ::id_from_node_id(id, &self.save_ctxt);
983 let span = self.span_from_span(ident.span);
985 self.dumper.dump_def(
991 kind: DefKind::Local,
994 name: ident.to_string(),
1000 docs: String::new(),
1007 HirDef::StructCtor(..) |
1008 HirDef::VariantCtor(..) |
1010 HirDef::AssociatedConst(..) |
1011 HirDef::Struct(..) |
1012 HirDef::Variant(..) |
1013 HirDef::TyAlias(..) |
1014 HirDef::AssociatedTy(..) |
1015 HirDef::SelfTy(..) => {
1016 self.dump_path_ref(id, &ast::Path::from_ident(ident));
1019 "unexpected definition kind when processing collected idents: {:?}",
1025 for (id, ref path) in collector.collected_paths {
1026 self.process_path(id, path);
1030 fn process_var_decl(&mut self, p: &'l ast::Pat, value: String) {
1031 // The local could declare multiple new vars, we must walk the
1032 // pattern and collect them all.
1033 let mut collector = PathCollector::new();
1034 collector.visit_pat(&p);
1037 for (id, ident, immut) in collector.collected_idents {
1038 let mut value = match immut {
1039 ast::Mutability::Immutable => value.to_string(),
1042 let hir_id = self.tcx.hir.node_to_hir_id(id);
1043 let typ = match self.save_ctxt.tables.node_id_to_type_opt(hir_id) {
1045 let typ = typ.to_string();
1046 if !value.is_empty() {
1047 value.push_str(": ");
1049 value.push_str(&typ);
1052 None => String::new(),
1055 // Get the span only for the name of the variable (I hope the path
1056 // is only ever a variable name, but who knows?).
1057 let sub_span = self.span.span_for_last_ident(ident.span);
1058 // Rust uses the id of the pattern for var lookups, so we'll use it too.
1059 if !self.span.filter_generated(sub_span, ident.span) {
1060 let qualname = format!("{}${}", ident.to_string(), id);
1061 let id = ::id_from_node_id(id, &self.save_ctxt);
1062 let span = self.span_from_span(sub_span.expect("No span found for variable"));
1064 self.dumper.dump_def(
1070 kind: DefKind::Local,
1073 name: ident.to_string(),
1079 docs: String::new(),
1088 /// Extract macro use and definition information from the AST node defined
1089 /// by the given NodeId, using the expansion information from the node's
1092 /// If the span is not macro-generated, do nothing, else use callee and
1093 /// callsite spans to record macro definition and use data, using the
1094 /// mac_uses and mac_defs sets to prevent multiples.
1095 fn process_macro_use(&mut self, span: Span) {
1096 let source_span = span.source_callsite();
1097 if self.macro_calls.contains(&source_span) {
1100 self.macro_calls.insert(source_span);
1102 let data = match self.save_ctxt.get_macro_use_data(span) {
1107 self.dumper.macro_use(data);
1109 // FIXME write the macro def
1110 // let mut hasher = DefaultHasher::new();
1111 // data.callee_span.hash(&mut hasher);
1112 // let hash = hasher.finish();
1113 // let qualname = format!("{}::{}", data.name, hash);
1114 // Don't write macro definition for imported macros
1115 // if !self.mac_defs.contains(&data.callee_span)
1116 // && !data.imported {
1117 // self.mac_defs.insert(data.callee_span);
1118 // if let Some(sub_span) = self.span.span_for_macro_def_name(data.callee_span) {
1119 // self.dumper.macro_data(MacroData {
1121 // name: data.name.clone(),
1122 // qualname: qualname.clone(),
1123 // // FIXME where do macro docs come from?
1124 // docs: String::new(),
1125 // }.lower(self.tcx));
1130 fn process_trait_item(&mut self, trait_item: &'l ast::TraitItem, trait_id: DefId) {
1131 self.process_macro_use(trait_item.span);
1132 let vis_span = trait_item.span.shrink_to_lo();
1133 match trait_item.node {
1134 ast::TraitItemKind::Const(ref ty, ref expr) => {
1135 self.process_assoc_const(
1137 trait_item.ident.name,
1140 expr.as_ref().map(|e| &**e),
1142 respan(vis_span, ast::VisibilityKind::Public),
1146 ast::TraitItemKind::Method(ref sig, ref body) => {
1147 self.process_method(
1149 body.as_ref().map(|x| &**x),
1152 &trait_item.generics,
1153 respan(vis_span, ast::VisibilityKind::Public),
1157 ast::TraitItemKind::Type(ref bounds, ref default_ty) => {
1158 // FIXME do something with _bounds (for type refs)
1159 let name = trait_item.ident.name.to_string();
1160 let qualname = format!("::{}", self.tcx.node_path_str(trait_item.id));
1161 let sub_span = self.span
1162 .sub_span_after_keyword(trait_item.span, keywords::Type);
1164 if !self.span.filter_generated(sub_span, trait_item.span) {
1165 let span = self.span_from_span(sub_span.expect("No span found for assoc type"));
1166 let id = ::id_from_node_id(trait_item.id, &self.save_ctxt);
1168 self.dumper.dump_def(
1174 kind: DefKind::Type,
1179 value: self.span.snippet(trait_item.span),
1180 parent: Some(::id_from_def_id(trait_id)),
1183 docs: self.save_ctxt.docs_for_attrs(&trait_item.attrs),
1184 sig: sig::assoc_type_signature(
1188 default_ty.as_ref().map(|ty| &**ty),
1191 attributes: lower_attributes(trait_item.attrs.clone(), &self.save_ctxt),
1196 if let &Some(ref default_ty) = default_ty {
1197 self.visit_ty(default_ty)
1200 ast::TraitItemKind::Macro(_) => {}
1204 fn process_impl_item(&mut self, impl_item: &'l ast::ImplItem, impl_id: DefId) {
1205 self.process_macro_use(impl_item.span);
1206 match impl_item.node {
1207 ast::ImplItemKind::Const(ref ty, ref expr) => {
1208 self.process_assoc_const(
1210 impl_item.ident.name,
1215 impl_item.vis.clone(),
1219 ast::ImplItemKind::Method(ref sig, ref body) => {
1220 self.process_method(
1225 &impl_item.generics,
1226 impl_item.vis.clone(),
1230 ast::ImplItemKind::Type(ref ty) => {
1231 // FIXME uses of the assoc type should ideally point to this
1232 // 'def' and the name here should be a ref to the def in the
1236 ast::ImplItemKind::Macro(_) => {}
1240 /// Dumps imports in a use tree recursively.
1242 /// A use tree is an import that may contain nested braces (RFC 2128). The `use_tree` parameter
1243 /// is the current use tree under scrutiny, while `id` and `prefix` are its corresponding node
1244 /// id and path. `root_item` is the topmost use tree in the hierarchy.
1246 /// If `use_tree` is a simple or glob import, it is dumped into the analysis data. Otherwise,
1247 /// each child use tree is dumped recursively.
1248 fn process_use_tree(&mut self,
1249 use_tree: &'l ast::UseTree,
1251 root_item: &'l ast::Item,
1252 prefix: &ast::Path) {
1253 let path = &use_tree.prefix;
1255 // The access is calculated using the current tree ID, but with the root tree's visibility
1256 // (since nested trees don't have their own visibility).
1257 let access = access_from!(self.save_ctxt, root_item.vis, id);
1259 // The parent def id of a given use tree is always the enclosing item.
1260 let parent = self.save_ctxt.tcx.hir.opt_local_def_id(id)
1261 .and_then(|id| self.save_ctxt.tcx.parent_def_id(id))
1262 .map(::id_from_def_id);
1264 match use_tree.kind {
1265 ast::UseTreeKind::Simple(..) => {
1266 let ident = use_tree.ident();
1267 let path = ast::Path {
1268 segments: prefix.segments
1270 .chain(path.segments.iter())
1276 let sub_span = self.span.span_for_last_ident(path.span);
1277 let alias_span = self.span.sub_span_after_keyword(use_tree.span, keywords::As);
1278 let ref_id = self.lookup_def_id(id);
1280 if !self.span.filter_generated(sub_span, path.span) {
1281 let span = self.span_from_span(sub_span.expect("No span found for use"));
1282 let alias_span = alias_span.map(|sp| self.span_from_span(sp));
1283 self.dumper.import(&access, Import {
1284 kind: ImportKind::Use,
1285 ref_id: ref_id.map(|id| ::id_from_def_id(id)),
1288 name: ident.to_string(),
1289 value: String::new(),
1293 self.write_sub_paths_truncated(&path);
1295 ast::UseTreeKind::Glob => {
1296 let path = ast::Path {
1297 segments: prefix.segments
1299 .chain(path.segments.iter())
1305 // Make a comma-separated list of names of imported modules.
1306 let mut names = vec![];
1307 let glob_map = &self.save_ctxt.analysis.glob_map;
1308 let glob_map = glob_map.as_ref().unwrap();
1309 if glob_map.contains_key(&id) {
1310 for n in glob_map.get(&id).unwrap() {
1311 names.push(n.to_string());
1315 let sub_span = self.span.sub_span_of_token(use_tree.span,
1316 token::BinOp(token::Star));
1317 if !self.span.filter_generated(sub_span, use_tree.span) {
1319 self.span_from_span(sub_span.expect("No span found for use glob"));
1320 self.dumper.import(&access, Import {
1321 kind: ImportKind::GlobUse,
1325 name: "*".to_owned(),
1326 value: names.join(", "),
1330 self.write_sub_paths(&path);
1332 ast::UseTreeKind::Nested(ref nested_items) => {
1333 let prefix = ast::Path {
1334 segments: prefix.segments
1336 .chain(path.segments.iter())
1341 for &(ref tree, id) in nested_items {
1342 self.process_use_tree(tree, id, root_item, &prefix);
1349 impl<'l, 'tcx: 'l, 'll, O: DumpOutput + 'll> Visitor<'l> for DumpVisitor<'l, 'tcx, 'll, O> {
1350 fn visit_mod(&mut self, m: &'l ast::Mod, span: Span, attrs: &[ast::Attribute], id: NodeId) {
1351 // Since we handle explicit modules ourselves in visit_item, this should
1352 // only get called for the root module of a crate.
1353 assert_eq!(id, ast::CRATE_NODE_ID);
1355 let qualname = format!("::{}", self.tcx.node_path_str(id));
1357 let cm = self.tcx.sess.codemap();
1358 let filename = cm.span_to_filename(span);
1359 let data_id = ::id_from_node_id(id, &self.save_ctxt);
1360 let children = m.items
1362 .map(|i| ::id_from_node_id(i.id, &self.save_ctxt))
1364 let span = self.span_from_span(span);
1366 self.dumper.dump_def(
1374 name: String::new(),
1377 value: filename.to_string(),
1381 docs: self.save_ctxt.docs_for_attrs(attrs),
1383 attributes: lower_attributes(attrs.to_owned(), &self.save_ctxt),
1386 self.nest_scope(id, |v| visit::walk_mod(v, m));
1389 fn visit_item(&mut self, item: &'l ast::Item) {
1390 use syntax::ast::ItemKind::*;
1391 self.process_macro_use(item.span);
1393 Use(ref use_tree) => {
1394 let prefix = ast::Path {
1398 self.process_use_tree(use_tree, item.id, item, &prefix);
1401 let alias_span = self.span.span_for_last_ident(item.span);
1403 if !self.span.filter_generated(alias_span, item.span) {
1405 self.span_from_span(alias_span.expect("No span found for extern crate"));
1406 let parent = self.save_ctxt.tcx.hir.opt_local_def_id(item.id)
1407 .and_then(|id| self.save_ctxt.tcx.parent_def_id(id))
1408 .map(::id_from_def_id);
1415 kind: ImportKind::ExternCrate,
1419 name: item.ident.to_string(),
1420 value: String::new(),
1426 Fn(ref decl, .., ref ty_params, ref body) => {
1427 self.process_fn(item, &decl, ty_params, &body)
1429 Static(ref typ, _, ref expr) => self.process_static_or_const_item(item, typ, expr),
1430 Const(ref typ, ref expr) => self.process_static_or_const_item(item, &typ, &expr),
1431 Struct(ref def, ref ty_params) | Union(ref def, ref ty_params) => {
1432 self.process_struct(item, def, ty_params)
1434 Enum(ref def, ref ty_params) => self.process_enum(item, def, ty_params),
1435 Impl(.., ref ty_params, ref trait_ref, ref typ, ref impl_items) => {
1436 self.process_impl(item, ty_params, trait_ref, &typ, impl_items)
1438 Trait(_, _, ref generics, ref trait_refs, ref methods) => {
1439 self.process_trait(item, generics, trait_refs, methods)
1442 self.process_mod(item);
1443 self.nest_scope(item.id, |v| visit::walk_mod(v, m));
1445 Ty(ref ty, ref ty_params) => {
1446 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
1447 let value = ty_to_string(&ty);
1448 let sub_span = self.span.sub_span_after_keyword(item.span, keywords::Type);
1449 if !self.span.filter_generated(sub_span, item.span) {
1450 let span = self.span_from_span(sub_span.expect("No span found for typedef"));
1451 let id = ::id_from_node_id(item.id, &self.save_ctxt);
1453 self.dumper.dump_def(
1454 &access_from!(self.save_ctxt, item),
1456 kind: DefKind::Type,
1459 name: item.ident.to_string(),
1460 qualname: qualname.clone(),
1465 docs: self.save_ctxt.docs_for_attrs(&item.attrs),
1466 sig: sig::item_signature(item, &self.save_ctxt),
1467 attributes: lower_attributes(item.attrs.clone(), &self.save_ctxt),
1473 self.process_generic_params(ty_params, item.span, &qualname, item.id);
1476 _ => visit::walk_item(self, item),
1480 fn visit_generics(&mut self, generics: &'l ast::Generics) {
1481 for param in &generics.params {
1482 if let ast::GenericParam::Type(ref ty_param) = *param {
1483 for bound in ty_param.bounds.iter() {
1484 if let ast::TraitTyParamBound(ref trait_ref, _) = *bound {
1485 self.process_path(trait_ref.trait_ref.ref_id, &trait_ref.trait_ref.path)
1488 if let Some(ref ty) = ty_param.default {
1495 fn visit_ty(&mut self, t: &'l ast::Ty) {
1496 self.process_macro_use(t.span);
1498 ast::TyKind::Path(_, ref path) => {
1499 if generated_code(t.span) {
1503 if let Some(id) = self.lookup_def_id(t.id) {
1504 if let Some(sub_span) = self.span.sub_span_for_type_name(t.span) {
1505 let span = self.span_from_span(sub_span);
1506 self.dumper.dump_ref(Ref {
1507 kind: RefKind::Type,
1509 ref_id: ::id_from_def_id(id),
1514 self.write_sub_paths_truncated(path);
1515 visit::walk_path(self, path);
1517 ast::TyKind::Array(ref element, ref length) => {
1518 self.visit_ty(element);
1519 self.nest_tables(length.id, |v| v.visit_expr(&length.value));
1521 _ => visit::walk_ty(self, t),
1525 fn visit_expr(&mut self, ex: &'l ast::Expr) {
1526 debug!("visit_expr {:?}", ex.node);
1527 self.process_macro_use(ex.span);
1529 ast::ExprKind::Struct(ref path, ref fields, ref base) => {
1530 let hir_expr = self.save_ctxt.tcx.hir.expect_expr(ex.id);
1531 let adt = match self.save_ctxt.tables.expr_ty_opt(&hir_expr) {
1532 Some(ty) if ty.ty_adt_def().is_some() => ty.ty_adt_def().unwrap(),
1534 visit::walk_expr(self, ex);
1538 let def = self.save_ctxt.get_path_def(hir_expr.id);
1539 self.process_struct_lit(ex, path, fields, adt.variant_of_def(def), base)
1541 ast::ExprKind::MethodCall(ref seg, ref args) => self.process_method_call(ex, seg, args),
1542 ast::ExprKind::Field(ref sub_ex, _) => {
1543 self.visit_expr(&sub_ex);
1545 if let Some(field_data) = self.save_ctxt.get_expr_data(ex) {
1546 down_cast_data!(field_data, RefData, ex.span);
1547 if !generated_code(ex.span) {
1548 self.dumper.dump_ref(field_data);
1552 ast::ExprKind::Closure(_, _, ref decl, ref body, _fn_decl_span) => {
1553 let mut id = String::from("$");
1554 id.push_str(&ex.id.to_string());
1556 // walk arg and return types
1557 for arg in &decl.inputs {
1558 self.visit_ty(&arg.ty);
1561 if let ast::FunctionRetTy::Ty(ref ret_ty) = decl.output {
1562 self.visit_ty(&ret_ty);
1566 self.nest_tables(ex.id, |v| {
1567 v.process_formals(&decl.inputs, &id);
1568 v.nest_scope(ex.id, |v| v.visit_expr(body))
1571 ast::ExprKind::ForLoop(ref pattern, ref subexpression, ref block, _) => {
1572 let value = self.span.snippet(subexpression.span);
1573 self.process_var_decl(pattern, value);
1574 debug!("for loop, walk sub-expr: {:?}", subexpression.node);
1575 self.visit_expr(subexpression);
1576 visit::walk_block(self, block);
1578 ast::ExprKind::WhileLet(ref pats, ref subexpression, ref block, _) => {
1579 self.process_var_decl_multi(pats);
1580 debug!("for loop, walk sub-expr: {:?}", subexpression.node);
1581 self.visit_expr(subexpression);
1582 visit::walk_block(self, block);
1584 ast::ExprKind::IfLet(ref pats, ref subexpression, ref block, ref opt_else) => {
1585 self.process_var_decl_multi(pats);
1586 self.visit_expr(subexpression);
1587 visit::walk_block(self, block);
1588 opt_else.as_ref().map(|el| self.visit_expr(el));
1590 ast::ExprKind::Repeat(ref element, ref count) => {
1591 self.visit_expr(element);
1592 self.nest_tables(count.id, |v| v.visit_expr(&count.value));
1594 // In particular, we take this branch for call and path expressions,
1595 // where we'll index the idents involved just by continuing to walk.
1596 _ => visit::walk_expr(self, ex),
1600 fn visit_mac(&mut self, mac: &'l ast::Mac) {
1601 // These shouldn't exist in the AST at this point, log a span bug.
1604 "macro invocation should have been expanded out of AST"
1608 fn visit_pat(&mut self, p: &'l ast::Pat) {
1609 self.process_macro_use(p.span);
1610 self.process_pat(p);
1613 fn visit_arm(&mut self, arm: &'l ast::Arm) {
1614 self.process_var_decl_multi(&arm.pats);
1615 walk_list!(self, visit_expr, &arm.guard);
1616 self.visit_expr(&arm.body);
1619 fn visit_path(&mut self, p: &'l ast::Path, id: NodeId) {
1620 self.process_path(id, p);
1623 fn visit_stmt(&mut self, s: &'l ast::Stmt) {
1624 self.process_macro_use(s.span);
1625 visit::walk_stmt(self, s)
1628 fn visit_local(&mut self, l: &'l ast::Local) {
1629 self.process_macro_use(l.span);
1632 .map(|i| self.span.snippet(i.span))
1633 .unwrap_or(String::new());
1634 self.process_var_decl(&l.pat, value);
1636 // Just walk the initialiser and type (don't want to walk the pattern again).
1637 walk_list!(self, visit_ty, &l.ty);
1638 walk_list!(self, visit_expr, &l.init);
1641 fn visit_foreign_item(&mut self, item: &'l ast::ForeignItem) {
1642 let access = access_from!(self.save_ctxt, item);
1645 ast::ForeignItemKind::Fn(ref decl, ref generics) => {
1646 if let Some(fn_data) = self.save_ctxt.get_extern_item_data(item) {
1647 down_cast_data!(fn_data, DefData, item.span);
1651 |v| v.process_formals(&decl.inputs, &fn_data.qualname),
1653 self.process_generic_params(generics, item.span, &fn_data.qualname, item.id);
1654 self.dumper.dump_def(&access, fn_data);
1657 for arg in &decl.inputs {
1658 self.visit_ty(&arg.ty);
1661 if let ast::FunctionRetTy::Ty(ref ret_ty) = decl.output {
1662 self.visit_ty(&ret_ty);
1665 ast::ForeignItemKind::Static(ref ty, _) => {
1666 if let Some(var_data) = self.save_ctxt.get_extern_item_data(item) {
1667 down_cast_data!(var_data, DefData, item.span);
1668 self.dumper.dump_def(&access, var_data);
1673 ast::ForeignItemKind::Ty => {
1674 if let Some(var_data) = self.save_ctxt.get_extern_item_data(item) {
1675 down_cast_data!(var_data, DefData, item.span);
1676 self.dumper.dump_def(&access, var_data);
1679 ast::ForeignItemKind::Macro(..) => {}