src/librustc_save_analysis/dump_visitor.rs

   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.
   4 //
   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.
  10
  11 //! Write the output of rustc's analysis to an implementor of Dump.
  12 //!
  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
  19 //! idents.
  20 //!
  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
  25 //! for an example).
  26
  27 use rustc::hir::def::Def as HirDef;
  28 use rustc::hir::def_id::DefId;
  29 use rustc::hir::map::Node;
  30 use rustc::session::Session;
  31 use rustc::ty::{self, TyCtxt};
  32 use rustc_data_structures::fx::FxHashSet;
  33
  34 use std::path::Path;
  35
  36 use syntax::ast::{self, NodeId, PatKind, Attribute, CRATE_NODE_ID};
  37 use syntax::parse::token;
  38 use syntax::symbol::keywords;
  39 use syntax::visit::{self, Visitor};
  40 use syntax::print::pprust::{path_to_string, ty_to_string, bounds_to_string, generics_to_string};
  41 use syntax::ptr::P;
  42 use syntax::codemap::Spanned;
  43 use syntax_pos::*;
  44
  45 use {escape, generated_code, SaveContext, PathCollector, lower_attributes};
  46 use json_dumper::{JsonDumper, DumpOutput};
  47 use span_utils::SpanUtils;
  48 use sig;
  49
  50 use rls_data::{CratePreludeData, Import, ImportKind, SpanData, Ref, RefKind,
  51                Def, DefKind, Relation, RelationKind};
  52
  53 macro_rules! down_cast_data {
  54     ($id:ident, $kind:ident, $sp:expr) => {
  55         let $id = if let super::Data::$kind(data) = $id {
  56             data
  57         } else {
  58             span_bug!($sp, "unexpected data kind: {:?}", $id);
  59         };
  60     };
  61 }
  62
  63 pub struct DumpVisitor<'l, 'tcx: 'l, 'll, O: DumpOutput + 'll> {
  64     save_ctxt: SaveContext<'l, 'tcx>,
  65     sess: &'l Session,
  66     tcx: TyCtxt<'l, 'tcx, 'tcx>,
  67     dumper: &'ll mut JsonDumper<O>,
  68
  69     span: SpanUtils<'l>,
  70
  71     cur_scope: NodeId,
  72
  73     // Set of macro definition (callee) spans, and the set
  74     // of macro use (callsite) spans. We store these to ensure
  75     // we only write one macro def per unique macro definition, and
  76     // one macro use per unique callsite span.
  77     // mac_defs: HashSet<Span>,
  78     macro_calls: FxHashSet<Span>,
  79 }
  80
  81 impl<'l, 'tcx: 'l, 'll, O: DumpOutput + 'll> DumpVisitor<'l, 'tcx, 'll, O> {
  82     pub fn new(save_ctxt: SaveContext<'l, 'tcx>,
  83                dumper: &'ll mut JsonDumper<O>)
  84                -> DumpVisitor<'l, 'tcx, 'll, O> {
  85         let span_utils = SpanUtils::new(&save_ctxt.tcx.sess);
  86         DumpVisitor {
  87             sess: &save_ctxt.tcx.sess,
  88             tcx: save_ctxt.tcx,
  89             save_ctxt: save_ctxt,
  90             dumper: dumper,
  91             span: span_utils.clone(),
  92             cur_scope: CRATE_NODE_ID,
  93             // mac_defs: HashSet::new(),
  94             macro_calls: FxHashSet(),
  95         }
  96     }
  97
  98     fn nest_scope<F>(&mut self, scope_id: NodeId, f: F)
  99         where F: FnOnce(&mut DumpVisitor<'l, 'tcx, 'll, O>)
 100     {
 101         let parent_scope = self.cur_scope;
 102         self.cur_scope = scope_id;
 103         f(self);
 104         self.cur_scope = parent_scope;
 105     }
 106
 107     fn nest_tables<F>(&mut self, item_id: NodeId, f: F)
 108         where F: FnOnce(&mut DumpVisitor<'l, 'tcx, 'll, O>)
 109     {
 110         let item_def_id = self.tcx.hir.local_def_id(item_id);
 111         if self.tcx.has_typeck_tables(item_def_id) {
 112             let tables = self.tcx.typeck_tables_of(item_def_id);
 113             let old_tables = self.save_ctxt.tables;
 114             self.save_ctxt.tables = tables;
 115             f(self);
 116             self.save_ctxt.tables = old_tables;
 117         } else {
 118             f(self);
 119         }
 120     }
 121
 122     fn span_from_span(&self, span: Span) -> SpanData {
 123         self.save_ctxt.span_from_span(span)
 124     }
 125
 126     pub fn dump_crate_info(&mut self, name: &str, krate: &ast::Crate) {
 127         let source_file = self.tcx.sess.local_crate_source_file.as_ref();
 128         let crate_root = source_file.map(|source_file| {
 129             let source_file = Path::new(source_file);
 130             match source_file.file_name() {
 131                 Some(_) => source_file.parent().unwrap().display().to_string(),
 132                 None => source_file.display().to_string(),
 133             }
 134         });
 135
 136         let data = CratePreludeData {
 137             crate_name: name.into(),
 138             crate_root: crate_root.unwrap_or("<no source>".to_owned()),
 139             external_crates: self.save_ctxt.get_external_crates(),
 140             span: self.span_from_span(krate.span),
 141         };
 142
 143         self.dumper.crate_prelude(data);
 144     }
 145
 146     // Return all non-empty prefixes of a path.
 147     // For each prefix, we return the span for the last segment in the prefix and
 148     // a str representation of the entire prefix.
 149     fn process_path_prefixes(&self, path: &ast::Path) -> Vec<(Span, String)> {
 150         let spans = self.span.spans_for_path_segments(path);
 151         let segments = &path.segments[if path.is_global() { 1 } else { 0 }..];
 152
 153         // Paths to enums seem to not match their spans - the span includes all the
 154         // variants too. But they seem to always be at the end, so I hope we can cope with
 155         // always using the first ones. So, only error out if we don't have enough spans.
 156         // What could go wrong...?
 157         if spans.len() < segments.len() {
 158             if generated_code(path.span) {
 159                 return vec![];
 160             }
 161             error!("Mis-calculated spans for path '{}'. Found {} spans, expected {}. Found spans:",
 162                    path_to_string(path),
 163                    spans.len(),
 164                    segments.len());
 165             for s in &spans {
 166                 let loc = self.sess.codemap().lookup_char_pos(s.lo);
 167                 error!("    '{}' in {}, line {}",
 168                        self.span.snippet(*s),
 169                        loc.file.name,
 170                        loc.line);
 171             }
 172             error!("    master span: {:?}: `{}`", path.span, self.span.snippet(path.span));
 173             return vec![];
 174         }
 175
 176         let mut result: Vec<(Span, String)> = vec![];
 177
 178         let mut segs = vec![];
 179         for (i, (seg, span)) in segments.iter().zip(&spans).enumerate() {
 180             segs.push(seg.clone());
 181             let sub_path = ast::Path {
 182                 span: *span, // span for the last segment
 183                 segments: segs,
 184             };
 185             let qualname = if i == 0 && path.is_global() {
 186                 format!("::{}", path_to_string(&sub_path))
 187             } else {
 188                 path_to_string(&sub_path)
 189             };
 190             result.push((*span, qualname));
 191             segs = sub_path.segments;
 192         }
 193
 194         result
 195     }
 196
 197     fn write_sub_paths(&mut self, path: &ast::Path) {
 198         let sub_paths = self.process_path_prefixes(path);
 199         for (span, _) in sub_paths {
 200             let span = self.span_from_span(span);
 201             self.dumper.dump_ref(Ref {
 202                 kind: RefKind::Mod,
 203                 span,
 204                 ref_id: ::null_id(),
 205             });
 206         }
 207     }
 208
 209     // As write_sub_paths, but does not process the last ident in the path (assuming it
 210     // will be processed elsewhere). See note on write_sub_paths about global.
 211     fn write_sub_paths_truncated(&mut self, path: &ast::Path) {
 212         let sub_paths = self.process_path_prefixes(path);
 213         let len = sub_paths.len();
 214         if len <= 1 {
 215             return;
 216         }
 217
 218         for (span, _) in sub_paths.into_iter().take(len - 1) {
 219             let span = self.span_from_span(span);
 220             self.dumper.dump_ref(Ref {
 221                 kind: RefKind::Mod,
 222                 span,
 223                 ref_id: ::null_id(),
 224             });
 225         }
 226     }
 227
 228     // As write_sub_paths, but expects a path of the form module_path::trait::method
 229     // Where trait could actually be a struct too.
 230     fn write_sub_path_trait_truncated(&mut self, path: &ast::Path) {
 231         let sub_paths = self.process_path_prefixes(path);
 232         let len = sub_paths.len();
 233         if len <= 1 {
 234             return;
 235         }
 236         let sub_paths = &sub_paths[.. (len-1)];
 237
 238         // write the trait part of the sub-path
 239         let (ref span, _) = sub_paths[len-2];
 240         let span = self.span_from_span(*span);
 241         self.dumper.dump_ref(Ref {
 242             kind: RefKind::Type,
 243             ref_id: ::null_id(),
 244             span,
 245         });
 246
 247         // write the other sub-paths
 248         if len <= 2 {
 249             return;
 250         }
 251         let sub_paths = &sub_paths[..len-2];
 252         for &(ref span, _) in sub_paths {
 253             let span = self.span_from_span(*span);
 254             self.dumper.dump_ref(Ref {
 255                 kind: RefKind::Mod,
 256                 span,
 257                 ref_id: ::null_id(),
 258             });
 259         }
 260     }
 261
 262     fn lookup_def_id(&self, ref_id: NodeId) -> Option<DefId> {
 263         match self.save_ctxt.get_path_def(ref_id) {
 264             HirDef::PrimTy(..) | HirDef::SelfTy(..) | HirDef::Err => None,
 265             def => Some(def.def_id()),
 266         }
 267     }
 268
 269     fn process_def_kind(&mut self,
 270                         ref_id: NodeId,
 271                         span: Span,
 272                         sub_span: Option<Span>,
 273                         def_id: DefId) {
 274         if self.span.filter_generated(sub_span, span) {
 275             return;
 276         }
 277
 278         let def = self.save_ctxt.get_path_def(ref_id);
 279         match def {
 280             HirDef::Mod(_) => {
 281                 let span = self.span_from_span(sub_span.expect("No span found for mod ref"));
 282                 self.dumper.dump_ref(Ref {
 283                     kind: RefKind::Mod,
 284                     span,
 285                     ref_id: ::id_from_def_id(def_id),
 286                 });
 287             }
 288             HirDef::Struct(..) |
 289             HirDef::Variant(..) |
 290             HirDef::Union(..) |
 291             HirDef::Enum(..) |
 292             HirDef::TyAlias(..) |
 293             HirDef::Trait(_) => {
 294                 let span = self.span_from_span(sub_span.expect("No span found for type ref"));
 295                 self.dumper.dump_ref(Ref {
 296                     kind: RefKind::Type,
 297                     span,
 298                     ref_id: ::id_from_def_id(def_id),
 299                 });
 300             }
 301             HirDef::Static(..) |
 302             HirDef::Const(..) |
 303             HirDef::StructCtor(..) |
 304             HirDef::VariantCtor(..) => {
 305                 let span = self.span_from_span(sub_span.expect("No span found for var ref"));
 306                 self.dumper.dump_ref(Ref {
 307                     kind: RefKind::Variable,
 308                     span,
 309                     ref_id: ::id_from_def_id(def_id),
 310                 });
 311             }
 312             HirDef::Fn(..) => {
 313                 let span = self.span_from_span(sub_span.expect("No span found for fn ref"));
 314                 self.dumper.dump_ref(Ref {
 315                     kind: RefKind::Function,
 316                     span,
 317                     ref_id: ::id_from_def_id(def_id),
 318                 });
 319             }
 320             // With macros 2.0, we can legitimately get a ref to a macro, but
 321             // we don't handle it properly for now (FIXME).
 322             HirDef::Macro(..) => {}
 323             HirDef::Local(..) |
 324             HirDef::Upvar(..) |
 325             HirDef::SelfTy(..) |
 326             HirDef::Label(_) |
 327             HirDef::TyParam(..) |
 328             HirDef::Method(..) |
 329             HirDef::AssociatedTy(..) |
 330             HirDef::AssociatedConst(..) |
 331             HirDef::PrimTy(_) |
 332             HirDef::GlobalAsm(_) |
 333             HirDef::Err => {
 334                span_bug!(span,
 335                          "process_def_kind for unexpected item: {:?}",
 336                          def);
 337             }
 338         }
 339     }
 340
 341     fn process_formals(&mut self, formals: &'l [ast::Arg], qualname: &str) {
 342         for arg in formals {
 343             self.visit_pat(&arg.pat);
 344             let mut collector = PathCollector::new();
 345             collector.visit_pat(&arg.pat);
 346             let span_utils = self.span.clone();
 347             for &(id, ref p, ..) in &collector.collected_paths {
 348                 let typ = match self.save_ctxt.tables.node_types.get(&id) {
 349                     Some(s) => s.to_string(),
 350                     None => continue,
 351                 };
 352                 // get the span only for the name of the variable (I hope the path is only ever a
 353                 // variable name, but who knows?)
 354                 let sub_span = span_utils.span_for_last_ident(p.span);
 355                 if !self.span.filter_generated(sub_span, p.span) {
 356                     let id = ::id_from_node_id(id, &self.save_ctxt);
 357                     let span = self.span_from_span(sub_span.expect("No span found for variable"));
 358
 359                     self.dumper.dump_def(false, Def {
 360                         kind: DefKind::Local,
 361                         id,
 362                         span,
 363                         name: path_to_string(p),
 364                         qualname: format!("{}::{}", qualname, path_to_string(p)),
 365                         value: typ,
 366                         parent: None,
 367                         children: vec![],
 368                         decl_id: None,
 369                         docs: String::new(),
 370                         sig: None,
 371                         attributes:vec![],
 372                     });
 373                 }
 374             }
 375         }
 376     }
 377
 378     fn process_method(&mut self,
 379                       sig: &'l ast::MethodSig,
 380                       body: Option<&'l ast::Block>,
 381                       id: ast::NodeId,
 382                       name: ast::Ident,
 383                       vis: ast::Visibility,
 384                       span: Span) {
 385         debug!("process_method: {}:{}", id, name);
 386
 387         if let Some(mut method_data) = self.save_ctxt.get_method_data(id, name.name, span) {
 388
 389             let sig_str = ::make_signature(&sig.decl, &sig.generics);
 390             if body.is_some() {
 391                 self.nest_tables(id, |v| {
 392                     v.process_formals(&sig.decl.inputs, &method_data.qualname)
 393                 });
 394             }
 395
 396             self.process_generic_params(&sig.generics, span, &method_data.qualname, id);
 397
 398             method_data.value = sig_str;
 399             method_data.sig = sig::method_signature(id, name, sig, &self.save_ctxt);
 400             self.dumper.dump_def(vis == ast::Visibility::Public, method_data);
 401         }
 402
 403         // walk arg and return types
 404         for arg in &sig.decl.inputs {
 405             self.visit_ty(&arg.ty);
 406         }
 407
 408         if let ast::FunctionRetTy::Ty(ref ret_ty) = sig.decl.output {
 409             self.visit_ty(ret_ty);
 410         }
 411
 412         // walk the fn body
 413         if let Some(body) = body {
 414             self.nest_tables(id, |v| v.nest_scope(id, |v| v.visit_block(body)));
 415         }
 416     }
 417
 418     fn process_trait_ref(&mut self, trait_ref: &'l ast::TraitRef) {
 419         let trait_ref_data = self.save_ctxt.get_trait_ref_data(trait_ref);
 420         if let Some(trait_ref_data) = trait_ref_data {
 421             self.dumper.dump_ref(trait_ref_data);
 422         }
 423         self.process_path(trait_ref.ref_id, &trait_ref.path);
 424     }
 425
 426     fn process_struct_field_def(&mut self, field: &ast::StructField, parent_id: NodeId) {
 427         let field_data = self.save_ctxt.get_field_data(field, parent_id);
 428         if let Some(field_data) = field_data {
 429             self.dumper.dump_def(field.vis == ast::Visibility::Public, field_data);
 430         }
 431     }
 432
 433     // Dump generic params bindings, then visit_generics
 434     fn process_generic_params(&mut self,
 435                               generics: &'l ast::Generics,
 436                               full_span: Span,
 437                               prefix: &str,
 438                               id: NodeId) {
 439         // We can't only use visit_generics since we don't have spans for param
 440         // bindings, so we reparse the full_span to get those sub spans.
 441         // However full span is the entire enum/fn/struct block, so we only want
 442         // the first few to match the number of generics we're looking for.
 443         let param_sub_spans = self.span.spans_for_ty_params(full_span,
 444                                                             (generics.ty_params.len() as isize));
 445         for (param, param_ss) in generics.ty_params.iter().zip(param_sub_spans) {
 446             let name = escape(self.span.snippet(param_ss));
 447             // Append $id to name to make sure each one is unique
 448             let qualname = format!("{}::{}${}",
 449                                    prefix,
 450                                    name,
 451                                    id);
 452             if !self.span.filter_generated(Some(param_ss), full_span) {
 453                 let id = ::id_from_node_id(param.id, &self.save_ctxt);
 454                 let span = self.span_from_span(param_ss);
 455
 456                 self.dumper.dump_def(false, Def {
 457                     kind: DefKind::Type,
 458                     id,
 459                     span,
 460                     name,
 461                     qualname,
 462                     value: String::new(),
 463                     parent: None,
 464                     children: vec![],
 465                     decl_id: None,
 466                     docs: String::new(),
 467                     sig: None,
 468                     attributes: vec![],
 469                 });
 470             }
 471         }
 472         self.visit_generics(generics);
 473     }
 474
 475     fn process_fn(&mut self,
 476                   item: &'l ast::Item,
 477                   decl: &'l ast::FnDecl,
 478                   ty_params: &'l ast::Generics,
 479                   body: &'l ast::Block) {
 480         if let Some(fn_data) = self.save_ctxt.get_item_data(item) {
 481             down_cast_data!(fn_data, DefData, item.span);
 482             self.nest_tables(item.id, |v| v.process_formals(&decl.inputs, &fn_data.qualname));
 483             self.process_generic_params(ty_params, item.span, &fn_data.qualname, item.id);
 484             self.dumper.dump_def(item.vis == ast::Visibility::Public, fn_data);
 485         }
 486
 487         for arg in &decl.inputs {
 488             self.visit_ty(&arg.ty);
 489         }
 490
 491         if let ast::FunctionRetTy::Ty(ref ret_ty) = decl.output {
 492             self.visit_ty(&ret_ty);
 493         }
 494
 495         self.nest_tables(item.id, |v| v.nest_scope(item.id, |v| v.visit_block(&body)));
 496     }
 497
 498     fn process_static_or_const_item(&mut self,
 499                                     item: &'l ast::Item,
 500                                     typ: &'l ast::Ty,
 501                                     expr: &'l ast::Expr) {
 502         if let Some(var_data) = self.save_ctxt.get_item_data(item) {
 503             down_cast_data!(var_data, DefData, item.span);
 504             self.dumper.dump_def(item.vis == ast::Visibility::Public, var_data);
 505         }
 506         self.visit_ty(&typ);
 507         self.visit_expr(expr);
 508     }
 509
 510     fn process_assoc_const(&mut self,
 511                            id: ast::NodeId,
 512                            name: ast::Name,
 513                            span: Span,
 514                            typ: &'l ast::Ty,
 515                            expr: Option<&'l ast::Expr>,
 516                            parent_id: DefId,
 517                            vis: ast::Visibility,
 518                            attrs: &'l [Attribute]) {
 519         let qualname = format!("::{}", self.tcx.node_path_str(id));
 520
 521         let sub_span = self.span.sub_span_after_keyword(span, keywords::Const);
 522
 523         if !self.span.filter_generated(sub_span, span) {
 524             let sig = sig::assoc_const_signature(id, name, typ, expr, &self.save_ctxt);
 525             let id = ::id_from_node_id(id, &self.save_ctxt);
 526             let span = self.span_from_span(sub_span.expect("No span found for variable"));
 527
 528             self.dumper.dump_def(vis == ast::Visibility::Public, Def {
 529                 kind: DefKind::Const,
 530                 id,
 531                 span,
 532                 name: name.to_string(),
 533                 qualname,
 534                 value: ty_to_string(&typ),
 535                 parent: Some(::id_from_def_id(parent_id)),
 536                 children: vec![],
 537                 decl_id: None,
 538                 docs: self.save_ctxt.docs_for_attrs(attrs),
 539                 sig,
 540                 attributes: lower_attributes(attrs.to_owned(), &self.save_ctxt),
 541             });
 542         }
 543
 544         // walk type and init value
 545         self.visit_ty(typ);
 546         if let Some(expr) = expr {
 547             self.visit_expr(expr);
 548         }
 549     }
 550
 551     // FIXME tuple structs should generate tuple-specific data.
 552     fn process_struct(&mut self,
 553                       item: &'l ast::Item,
 554                       def: &'l ast::VariantData,
 555                       ty_params: &'l ast::Generics) {
 556         let name = item.ident.to_string();
 557         let qualname = format!("::{}", self.tcx.node_path_str(item.id));
 558
 559         let sub_span = self.span.sub_span_after_keyword(item.span, keywords::Struct);
 560         let (value, fields) =
 561             if let ast::ItemKind::Struct(ast::VariantData::Struct(ref fields, _), _) = item.node
 562         {
 563             let include_priv_fields = !self.save_ctxt.config.pub_only;
 564             let fields_str = fields.iter()
 565                                    .enumerate()
 566                                    .filter_map(|(i, f)| {
 567                                         if include_priv_fields || f.vis == ast::Visibility::Public {
 568                                             f.ident.map(|i| i.to_string()).or_else(|| Some(i.to_string()))
 569                                         } else {
 570                                             None
 571                                         }
 572                                    })
 573                                    .collect::<Vec<_>>()
 574                                    .join(", ");
 575             let value = format!("{} {{ {} }}", name, fields_str);
 576             (value, fields.iter().map(|f| ::id_from_node_id(f.id, &self.save_ctxt)).collect())
 577         } else {
 578             (String::new(), vec![])
 579         };
 580
 581         if !self.span.filter_generated(sub_span, item.span) {
 582             let span = self.span_from_span(sub_span.expect("No span found for struct"));
 583             self.dumper.dump_def(item.vis == ast::Visibility::Public, Def {
 584                 kind: DefKind::Struct,
 585                 id: ::id_from_node_id(item.id, &self.save_ctxt),
 586                 span,
 587                 name,
 588                 qualname: qualname.clone(),
 589                 value,
 590                 parent: None,
 591                 children: fields,
 592                 decl_id: None,
 593                 docs: self.save_ctxt.docs_for_attrs(&item.attrs),
 594                 sig: sig::item_signature(item, &self.save_ctxt),
 595                 attributes: lower_attributes(item.attrs.clone(), &self.save_ctxt),
 596             });
 597         }
 598
 599         for field in def.fields() {
 600             self.process_struct_field_def(field, item.id);
 601             self.visit_ty(&field.ty);
 602         }
 603
 604         self.process_generic_params(ty_params, item.span, &qualname, item.id);
 605     }
 606
 607     fn process_enum(&mut self,
 608                     item: &'l ast::Item,
 609                     enum_definition: &'l ast::EnumDef,
 610                     ty_params: &'l ast::Generics) {
 611         let enum_data = self.save_ctxt.get_item_data(item);
 612         let enum_data = match enum_data {
 613             None => return,
 614             Some(data) => data,
 615         };
 616         down_cast_data!(enum_data, DefData, item.span);
 617
 618         for variant in &enum_definition.variants {
 619             let name = variant.node.name.name.to_string();
 620             let mut qualname = enum_data.qualname.clone();
 621             qualname.push_str("::");
 622             qualname.push_str(&name);
 623
 624             match variant.node.data {
 625                 ast::VariantData::Struct(ref fields, _) => {
 626                     let sub_span = self.span.span_for_first_ident(variant.span);
 627                     let fields_str = fields.iter()
 628                                            .enumerate()
 629                                            .map(|(i, f)| f.ident.map(|i| i.to_string())
 630                                                           .unwrap_or(i.to_string()))
 631                                            .collect::<Vec<_>>()
 632                                            .join(", ");
 633                     let value = format!("{}::{} {{ {} }}", enum_data.name, name, fields_str);
 634                     if !self.span.filter_generated(sub_span, variant.span) {
 635                         let span = self.span_from_span(
 636                             sub_span.expect("No span found for struct variant"));
 637                         let id = ::id_from_node_id(variant.node.data.id(), &self.save_ctxt);
 638                         let parent = Some(::id_from_node_id(item.id, &self.save_ctxt));
 639
 640                         self.dumper.dump_def(item.vis == ast::Visibility::Public, Def {
 641                             kind: DefKind::Struct,
 642                             id,
 643                             span,
 644                             name,
 645                             qualname,
 646                             value,
 647                             parent,
 648                             children: vec![],
 649                             decl_id: None,
 650                             docs: self.save_ctxt.docs_for_attrs(&variant.node.attrs),
 651                             sig: sig::variant_signature(variant, &self.save_ctxt),
 652                             attributes: lower_attributes(variant.node.attrs.clone(),
 653                                                          &self.save_ctxt),
 654                         });
 655                     }
 656                 }
 657                 ref v => {
 658                     let sub_span = self.span.span_for_first_ident(variant.span);
 659                     let mut value = format!("{}::{}", enum_data.name, name);
 660                     if let &ast::VariantData::Tuple(ref fields, _) = v {
 661                         value.push('(');
 662                         value.push_str(&fields.iter()
 663                                               .map(|f| ty_to_string(&f.ty))
 664                                               .collect::<Vec<_>>()
 665                                               .join(", "));
 666                         value.push(')');
 667                     }
 668                     if !self.span.filter_generated(sub_span, variant.span) {
 669                         let span =
 670                             self.span_from_span(sub_span.expect("No span found for tuple variant"));
 671                         let id = ::id_from_node_id(variant.node.data.id(), &self.save_ctxt);
 672                         let parent = Some(::id_from_node_id(item.id, &self.save_ctxt));
 673
 674                         self.dumper.dump_def(item.vis == ast::Visibility::Public, Def {
 675                             kind: DefKind::Tuple,
 676                             id,
 677                             span,
 678                             name,
 679                             qualname,
 680                             value,
 681                             parent,
 682                             children: vec![],
 683                             decl_id: None,
 684                             docs: self.save_ctxt.docs_for_attrs(&variant.node.attrs),
 685                             sig: sig::variant_signature(variant, &self.save_ctxt),
 686                             attributes: lower_attributes(variant.node.attrs.clone(),
 687                                                          &self.save_ctxt),
 688                         });
 689                     }
 690                 }
 691             }
 692
 693
 694             for field in variant.node.data.fields() {
 695                 self.process_struct_field_def(field, variant.node.data.id());
 696                 self.visit_ty(&field.ty);
 697             }
 698         }
 699         self.process_generic_params(ty_params, item.span, &enum_data.qualname, item.id);
 700         self.dumper.dump_def(item.vis == ast::Visibility::Public, enum_data);
 701     }
 702
 703     fn process_impl(&mut self,
 704                     item: &'l ast::Item,
 705                     type_parameters: &'l ast::Generics,
 706                     trait_ref: &'l Option<ast::TraitRef>,
 707                     typ: &'l ast::Ty,
 708                     impl_items: &'l [ast::ImplItem]) {
 709         if let Some(impl_data) = self.save_ctxt.get_item_data(item) {
 710             down_cast_data!(impl_data, RelationData, item.span);
 711             self.dumper.dump_relation(impl_data);
 712         }
 713         self.visit_ty(&typ);
 714         if let &Some(ref trait_ref) = trait_ref {
 715             self.process_path(trait_ref.ref_id, &trait_ref.path);
 716         }
 717         self.process_generic_params(type_parameters, item.span, "", item.id);
 718         for impl_item in impl_items {
 719             let map = &self.tcx.hir;
 720             self.process_impl_item(impl_item, map.local_def_id(item.id));
 721         }
 722     }
 723
 724     fn process_trait(&mut self,
 725                      item: &'l ast::Item,
 726                      generics: &'l ast::Generics,
 727                      trait_refs: &'l ast::TyParamBounds,
 728                      methods: &'l [ast::TraitItem]) {
 729         let name = item.ident.to_string();
 730         let qualname = format!("::{}", self.tcx.node_path_str(item.id));
 731         let mut val = name.clone();
 732         if !generics.lifetimes.is_empty() || !generics.ty_params.is_empty() {
 733             val.push_str(&generics_to_string(generics));
 734         }
 735         if !trait_refs.is_empty() {
 736             val.push_str(": ");
 737             val.push_str(&bounds_to_string(trait_refs));
 738         }
 739         let sub_span = self.span.sub_span_after_keyword(item.span, keywords::Trait);
 740         if !self.span.filter_generated(sub_span, item.span) {
 741             let id = ::id_from_node_id(item.id, &self.save_ctxt);
 742             let span = self.span_from_span(sub_span.expect("No span found for trait"));
 743             let children =
 744                 methods.iter().map(|i| ::id_from_node_id(i.id, &self.save_ctxt)).collect();
 745             self.dumper.dump_def(item.vis == ast::Visibility::Public, Def {
 746                 kind: DefKind::Trait,
 747                 id,
 748                 span,
 749                 name,
 750                 qualname: qualname.clone(),
 751                 value: val,
 752                 parent: None,
 753                 children,
 754                 decl_id: None,
 755                 docs: self.save_ctxt.docs_for_attrs(&item.attrs),
 756                 sig: sig::item_signature(item, &self.save_ctxt),
 757                 attributes: lower_attributes(item.attrs.clone(), &self.save_ctxt),
 758             });
 759         }
 760
 761         // super-traits
 762         for super_bound in trait_refs.iter() {
 763             let trait_ref = match *super_bound {
 764                 ast::TraitTyParamBound(ref trait_ref, _) => {
 765                     trait_ref
 766                 }
 767                 ast::RegionTyParamBound(..) => {
 768                     continue;
 769                 }
 770             };
 771
 772             let trait_ref = &trait_ref.trait_ref;
 773             if let Some(id) = self.lookup_def_id(trait_ref.ref_id) {
 774                 let sub_span = self.span.sub_span_for_type_name(trait_ref.path.span);
 775                 if !self.span.filter_generated(sub_span, trait_ref.path.span) {
 776                     let span = self.span_from_span(sub_span.expect("No span found for trait ref"));
 777                     self.dumper.dump_ref(Ref {
 778                         kind: RefKind::Type,
 779                         span,
 780                         ref_id: ::id_from_def_id(id),
 781                     });
 782                 }
 783
 784                 if !self.span.filter_generated(sub_span, trait_ref.path.span) {
 785                     let sub_span = self.span_from_span(sub_span.expect("No span for inheritance"));
 786                     self.dumper.dump_relation(Relation {
 787                         kind: RelationKind::SuperTrait,
 788                         span: sub_span,
 789                         from: ::id_from_def_id(id),
 790                         to: ::id_from_node_id(item.id, &self.save_ctxt),
 791                     });
 792                 }
 793             }
 794         }
 795
 796         // walk generics and methods
 797         self.process_generic_params(generics, item.span, &qualname, item.id);
 798         for method in methods {
 799             let map = &self.tcx.hir;
 800             self.process_trait_item(method, map.local_def_id(item.id))
 801         }
 802     }
 803
 804     // `item` is the module in question, represented as an item.
 805     fn process_mod(&mut self, item: &ast::Item) {
 806         if let Some(mod_data) = self.save_ctxt.get_item_data(item) {
 807             down_cast_data!(mod_data, DefData, item.span);
 808             self.dumper.dump_def(item.vis == ast::Visibility::Public, mod_data);
 809         }
 810     }
 811
 812     fn process_path(&mut self, id: NodeId, path: &ast::Path) {
 813         let path_data = self.save_ctxt.get_path_data(id, path);
 814         if generated_code(path.span) && path_data.is_none() {
 815             return;
 816         }
 817
 818         let path_data = match path_data {
 819             Some(pd) => pd,
 820             None => {
 821                 return;
 822             }
 823         };
 824
 825         self.dumper.dump_ref(path_data);
 826
 827         // Modules or types in the path prefix.
 828         match self.save_ctxt.get_path_def(id) {
 829             HirDef::Method(did) => {
 830                 let ti = self.tcx.associated_item(did);
 831                 if ti.kind == ty::AssociatedKind::Method && ti.method_has_self_argument {
 832                     self.write_sub_path_trait_truncated(path);
 833                 }
 834             }
 835             HirDef::Fn(..) |
 836             HirDef::Const(..) |
 837             HirDef::Static(..) |
 838             HirDef::StructCtor(..) |
 839             HirDef::VariantCtor(..) |
 840             HirDef::AssociatedConst(..) |
 841             HirDef::Local(..) |
 842             HirDef::Upvar(..) |
 843             HirDef::Struct(..) |
 844             HirDef::Union(..) |
 845             HirDef::Variant(..) |
 846             HirDef::TyAlias(..) |
 847             HirDef::AssociatedTy(..) => self.write_sub_paths_truncated(path),
 848             _ => {}
 849         }
 850     }
 851
 852     fn process_struct_lit(&mut self,
 853                           ex: &'l ast::Expr,
 854                           path: &'l ast::Path,
 855                           fields: &'l [ast::Field],
 856                           variant: &'l ty::VariantDef,
 857                           base: &'l Option<P<ast::Expr>>) {
 858         self.write_sub_paths_truncated(path);
 859
 860         if let Some(struct_lit_data) = self.save_ctxt.get_expr_data(ex) {
 861             down_cast_data!(struct_lit_data, RefData, ex.span);
 862             if !generated_code(ex.span) {
 863                 self.dumper.dump_ref(struct_lit_data);
 864             }
 865
 866             for field in fields {
 867                 if let Some(field_data) = self.save_ctxt
 868                                               .get_field_ref_data(field, variant) {
 869                     self.dumper.dump_ref(field_data);
 870                 }
 871
 872                 self.visit_expr(&field.expr)
 873             }
 874         }
 875
 876         walk_list!(self, visit_expr, base);
 877     }
 878
 879     fn process_method_call(&mut self, ex: &'l ast::Expr, args: &'l [P<ast::Expr>]) {
 880         if let Some(mcd) = self.save_ctxt.get_expr_data(ex) {
 881             down_cast_data!(mcd, RefData, ex.span);
 882             if !generated_code(ex.span) {
 883                 self.dumper.dump_ref(mcd);
 884             }
 885         }
 886
 887         // walk receiver and args
 888         walk_list!(self, visit_expr, args);
 889     }
 890
 891     fn process_pat(&mut self, p: &'l ast::Pat) {
 892         match p.node {
 893             PatKind::Struct(ref _path, ref fields, _) => {
 894                 // FIXME do something with _path?
 895                 let adt = match self.save_ctxt.tables.node_id_to_type_opt(p.id) {
 896                     Some(ty) => ty.ty_adt_def().unwrap(),
 897                     None => {
 898                         visit::walk_pat(self, p);
 899                         return;
 900                     }
 901                 };
 902                 let variant = adt.variant_of_def(self.save_ctxt.get_path_def(p.id));
 903
 904                 for &Spanned { node: ref field, span } in fields {
 905                     let sub_span = self.span.span_for_first_ident(span);
 906                     if let Some(f) = variant.find_field_named(field.ident.name) {
 907                         if !self.span.filter_generated(sub_span, span) {
 908                             let span =
 909                                 self.span_from_span(sub_span.expect("No span fund for var ref"));
 910                             self.dumper.dump_ref(Ref {
 911                                 kind: RefKind::Variable,
 912                                 span,
 913                                 ref_id: ::id_from_def_id(f.did),
 914                             });
 915                         }
 916                     }
 917                     self.visit_pat(&field.pat);
 918                 }
 919             }
 920             _ => visit::walk_pat(self, p),
 921         }
 922     }
 923
 924
 925     fn process_var_decl(&mut self, p: &'l ast::Pat, value: String) {
 926         // The local could declare multiple new vars, we must walk the
 927         // pattern and collect them all.
 928         let mut collector = PathCollector::new();
 929         collector.visit_pat(&p);
 930         self.visit_pat(&p);
 931
 932         for &(id, ref p, immut) in &collector.collected_paths {
 933             let mut value = match immut {
 934                 ast::Mutability::Immutable => value.to_string(),
 935                 _ => String::new(),
 936             };
 937             let typ = match self.save_ctxt.tables.node_types.get(&id) {
 938                 Some(typ) => {
 939                     let typ = typ.to_string();
 940                     if !value.is_empty() {
 941                         value.push_str(": ");
 942                     }
 943                     value.push_str(&typ);
 944                     typ
 945                 }
 946                 None => String::new(),
 947             };
 948
 949             // Get the span only for the name of the variable (I hope the path
 950             // is only ever a variable name, but who knows?).
 951             let sub_span = self.span.span_for_last_ident(p.span);
 952             // Rust uses the id of the pattern for var lookups, so we'll use it too.
 953             if !self.span.filter_generated(sub_span, p.span) {
 954                 let qualname = format!("{}${}", path_to_string(p), id);
 955                 let id = ::id_from_node_id(id, &self.save_ctxt);
 956                 let span = self.span_from_span(sub_span.expect("No span found for variable"));
 957
 958                 self.dumper.dump_def(false, Def {
 959                     kind: DefKind::Local,
 960                     id,
 961                     span,
 962                     name: path_to_string(p),
 963                     qualname,
 964                     value: typ,
 965                     parent: None,
 966                     children: vec![],
 967                     decl_id: None,
 968                     docs: String::new(),
 969                     sig: None,
 970                     attributes:vec![],
 971                 });
 972             }
 973         }
 974     }
 975
 976     /// Extract macro use and definition information from the AST node defined
 977     /// by the given NodeId, using the expansion information from the node's
 978     /// span.
 979     ///
 980     /// If the span is not macro-generated, do nothing, else use callee and
 981     /// callsite spans to record macro definition and use data, using the
 982     /// mac_uses and mac_defs sets to prevent multiples.
 983     fn process_macro_use(&mut self, span: Span) {
 984         let source_span = span.source_callsite();
 985         if self.macro_calls.contains(&source_span) {
 986             return;
 987         }
 988         self.macro_calls.insert(source_span);
 989
 990         let data = match self.save_ctxt.get_macro_use_data(span) {
 991             None => return,
 992             Some(data) => data,
 993         };
 994
 995         self.dumper.macro_use(data);
 996
 997         // FIXME write the macro def
 998         // let mut hasher = DefaultHasher::new();
 999         // data.callee_span.hash(&mut hasher);
1000         // let hash = hasher.finish();
1001         // let qualname = format!("{}::{}", data.name, hash);
1002         // Don't write macro definition for imported macros
1003         // if !self.mac_defs.contains(&data.callee_span)
1004         //     && !data.imported {
1005         //     self.mac_defs.insert(data.callee_span);
1006         //     if let Some(sub_span) = self.span.span_for_macro_def_name(data.callee_span) {
1007         //         self.dumper.macro_data(MacroData {
1008         //             span: sub_span,
1009         //             name: data.name.clone(),
1010         //             qualname: qualname.clone(),
1011         //             // FIXME where do macro docs come from?
1012         //             docs: String::new(),
1013         //         }.lower(self.tcx));
1014         //     }
1015         // }
1016     }
1017
1018     fn process_trait_item(&mut self, trait_item: &'l ast::TraitItem, trait_id: DefId) {
1019         self.process_macro_use(trait_item.span);
1020         match trait_item.node {
1021             ast::TraitItemKind::Const(ref ty, ref expr) => {
1022                 self.process_assoc_const(trait_item.id,
1023                                          trait_item.ident.name,
1024                                          trait_item.span,
1025                                          &ty,
1026                                          expr.as_ref().map(|e| &**e),
1027                                          trait_id,
1028                                          ast::Visibility::Public,
1029                                          &trait_item.attrs);
1030             }
1031             ast::TraitItemKind::Method(ref sig, ref body) => {
1032                 self.process_method(sig,
1033                                     body.as_ref().map(|x| &**x),
1034                                     trait_item.id,
1035                                     trait_item.ident,
1036                                     ast::Visibility::Public,
1037                                     trait_item.span);
1038             }
1039             ast::TraitItemKind::Type(ref bounds, ref default_ty) => {
1040                 // FIXME do something with _bounds (for type refs)
1041                 let name = trait_item.ident.name.to_string();
1042                 let qualname = format!("::{}", self.tcx.node_path_str(trait_item.id));
1043                 let sub_span = self.span.sub_span_after_keyword(trait_item.span, keywords::Type);
1044
1045                 if !self.span.filter_generated(sub_span, trait_item.span) {
1046                     let span = self.span_from_span(sub_span.expect("No span found for assoc type"));
1047                     let id = ::id_from_node_id(trait_item.id, &self.save_ctxt);
1048
1049                     self.dumper.dump_def(true, Def {
1050                         kind: DefKind::Type,
1051                         id,
1052                         span,
1053                         name,
1054                         qualname,
1055                         value: self.span.snippet(trait_item.span),
1056                         parent: Some(::id_from_def_id(trait_id)),
1057                         children: vec![],
1058                         decl_id: None,
1059                         docs: self.save_ctxt.docs_for_attrs(&trait_item.attrs),
1060                         sig: sig::assoc_type_signature(trait_item.id,
1061                                                        trait_item.ident,
1062                                                        Some(bounds),
1063                                                        default_ty.as_ref().map(|ty| &**ty),
1064                                                        &self.save_ctxt),
1065                         attributes: lower_attributes(trait_item.attrs.clone(), &self.save_ctxt),
1066                     });
1067                 }
1068
1069                 if let &Some(ref default_ty) = default_ty {
1070                     self.visit_ty(default_ty)
1071                 }
1072             }
1073             ast::TraitItemKind::Macro(_) => {}
1074         }
1075     }
1076
1077     fn process_impl_item(&mut self, impl_item: &'l ast::ImplItem, impl_id: DefId) {
1078         self.process_macro_use(impl_item.span);
1079         match impl_item.node {
1080             ast::ImplItemKind::Const(ref ty, ref expr) => {
1081                 self.process_assoc_const(impl_item.id,
1082                                          impl_item.ident.name,
1083                                          impl_item.span,
1084                                          &ty,
1085                                          Some(expr),
1086                                          impl_id,
1087                                          impl_item.vis.clone(),
1088                                          &impl_item.attrs);
1089             }
1090             ast::ImplItemKind::Method(ref sig, ref body) => {
1091                 self.process_method(sig,
1092                                     Some(body),
1093                                     impl_item.id,
1094                                     impl_item.ident,
1095                                     impl_item.vis.clone(),
1096                                     impl_item.span);
1097             }
1098             ast::ImplItemKind::Type(ref ty) => {
1099                 // FIXME uses of the assoc type should ideally point to this
1100                 // 'def' and the name here should be a ref to the def in the
1101                 // trait.
1102                 self.visit_ty(ty)
1103             }
1104             ast::ImplItemKind::Macro(_) => {}
1105         }
1106     }
1107 }
1108
1109 impl<'l, 'tcx: 'l, 'll, O: DumpOutput + 'll> Visitor<'l> for DumpVisitor<'l, 'tcx, 'll, O> {
1110     fn visit_mod(&mut self, m: &'l ast::Mod, span: Span, attrs: &[ast::Attribute], id: NodeId) {
1111         // Since we handle explicit modules ourselves in visit_item, this should
1112         // only get called for the root module of a crate.
1113         assert_eq!(id, ast::CRATE_NODE_ID);
1114
1115         let qualname = format!("::{}", self.tcx.node_path_str(id));
1116
1117         let cm = self.tcx.sess.codemap();
1118         let filename = cm.span_to_filename(span);
1119         let data_id = ::id_from_node_id(id, &self.save_ctxt);
1120         let children = m.items.iter().map(|i| ::id_from_node_id(i.id, &self.save_ctxt)).collect();
1121         let span = self.span_from_span(span);
1122
1123         self.dumper.dump_def(true, Def {
1124             kind: DefKind::Mod,
1125             id: data_id,
1126             name: String::new(),
1127             qualname,
1128             span,
1129             value: filename,
1130             children,
1131             parent: None,
1132             decl_id: None,
1133             docs: self.save_ctxt.docs_for_attrs(attrs),
1134             sig: None,
1135             attributes: lower_attributes(attrs.to_owned(), &self.save_ctxt),
1136         });
1137         self.nest_scope(id, |v| visit::walk_mod(v, m));
1138     }
1139
1140     fn visit_item(&mut self, item: &'l ast::Item) {
1141         use syntax::ast::ItemKind::*;
1142         self.process_macro_use(item.span);
1143         match item.node {
1144             Use(ref use_item) => {
1145                 match use_item.node {
1146                     ast::ViewPathSimple(ident, ref path) => {
1147                         let sub_span = self.span.span_for_last_ident(path.span);
1148                         let mod_id = match self.lookup_def_id(item.id) {
1149                             Some(def_id) => {
1150                                 self.process_def_kind(item.id, path.span, sub_span, def_id);
1151                                 Some(def_id)
1152                             }
1153                             None => None,
1154                         };
1155
1156                         // 'use' always introduces an alias, if there is not an explicit
1157                         // one, there is an implicit one.
1158                         let sub_span = match self.span.sub_span_after_keyword(use_item.span,
1159                                                                               keywords::As) {
1160                             Some(sub_span) => Some(sub_span),
1161                             None => sub_span,
1162                         };
1163
1164                         if !self.span.filter_generated(sub_span, path.span) {
1165                             let span =
1166                                 self.span_from_span(sub_span.expect("No span found for use"));
1167                             self.dumper.import(item.vis == ast::Visibility::Public, Import {
1168                                 kind: ImportKind::Use,
1169                                 ref_id: mod_id.map(|id| ::id_from_def_id(id)),
1170                                 span,
1171                                 name: ident.to_string(),
1172                                 value: String::new(),
1173                             });
1174                         }
1175                         self.write_sub_paths_truncated(path);
1176                     }
1177                     ast::ViewPathGlob(ref path) => {
1178                         // Make a comma-separated list of names of imported modules.
1179                         let mut names = vec![];
1180                         let glob_map = &self.save_ctxt.analysis.glob_map;
1181                         let glob_map = glob_map.as_ref().unwrap();
1182                         if glob_map.contains_key(&item.id) {
1183                             for n in glob_map.get(&item.id).unwrap() {
1184                                 names.push(n.to_string());
1185                             }
1186                         }
1187
1188                         let sub_span = self.span
1189                                            .sub_span_of_token(item.span, token::BinOp(token::Star));
1190                         if !self.span.filter_generated(sub_span, item.span) {
1191                             let span =
1192                                 self.span_from_span(sub_span.expect("No span found for use glob"));
1193                             self.dumper.import(item.vis == ast::Visibility::Public, Import {
1194                                 kind: ImportKind::GlobUse,
1195                                 ref_id: None,
1196                                 span,
1197                                 name: "*".to_owned(),
1198                                 value: names.join(", "),
1199                             });
1200                         }
1201                         self.write_sub_paths(path);
1202                     }
1203                     ast::ViewPathList(ref path, ref list) => {
1204                         for plid in list {
1205                             let id = plid.node.id;
1206                             if let Some(def_id) = self.lookup_def_id(id) {
1207                                 let span = plid.span;
1208                                 self.process_def_kind(id, span, Some(span), def_id);
1209                             }
1210                         }
1211
1212                         self.write_sub_paths(path);
1213                     }
1214                 }
1215             }
1216             ExternCrate(_) => {
1217                 let alias_span = self.span.span_for_last_ident(item.span);
1218
1219                 if !self.span.filter_generated(alias_span, item.span) {
1220                     let span =
1221                         self.span_from_span(alias_span.expect("No span found for extern crate"));
1222                     self.dumper.import(false, Import {
1223                         kind: ImportKind::ExternCrate,
1224                         ref_id: None,
1225                         span,
1226                         name: item.ident.to_string(),
1227                         value: String::new(),
1228                     });
1229                 }
1230             }
1231             Fn(ref decl, .., ref ty_params, ref body) =>
1232                 self.process_fn(item, &decl, ty_params, &body),
1233             Static(ref typ, _, ref expr) =>
1234                 self.process_static_or_const_item(item, typ, expr),
1235             Const(ref typ, ref expr) =>
1236                 self.process_static_or_const_item(item, &typ, &expr),
1237             Struct(ref def, ref ty_params) => self.process_struct(item, def, ty_params),
1238             Enum(ref def, ref ty_params) => self.process_enum(item, def, ty_params),
1239             Impl(..,
1240                  ref ty_params,
1241                  ref trait_ref,
1242                  ref typ,
1243                  ref impl_items) => {
1244                 self.process_impl(item, ty_params, trait_ref, &typ, impl_items)
1245             }
1246             Trait(_, ref generics, ref trait_refs, ref methods) =>
1247                 self.process_trait(item, generics, trait_refs, methods),
1248             Mod(ref m) => {
1249                 self.process_mod(item);
1250                 self.nest_scope(item.id, |v| visit::walk_mod(v, m));
1251             }
1252             Ty(ref ty, ref ty_params) => {
1253                 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
1254                 let value = ty_to_string(&ty);
1255                 let sub_span = self.span.sub_span_after_keyword(item.span, keywords::Type);
1256                 if !self.span.filter_generated(sub_span, item.span) {
1257                     let span = self.span_from_span(sub_span.expect("No span found for typedef"));
1258                     let id = ::id_from_node_id(item.id, &self.save_ctxt);
1259
1260                     self.dumper.dump_def(item.vis == ast::Visibility::Public, Def {
1261                         kind: DefKind::Type,
1262                         id,
1263                         span,
1264                         name: item.ident.to_string(),
1265                         qualname: qualname.clone(),
1266                         value,
1267                         parent: None,
1268                         children: vec![],
1269                         decl_id: None,
1270                         docs: self.save_ctxt.docs_for_attrs(&item.attrs),
1271                         sig: sig::item_signature(item, &self.save_ctxt),
1272                         attributes: lower_attributes(item.attrs.clone(), &self.save_ctxt),
1273                     });
1274                 }
1275
1276                 self.visit_ty(&ty);
1277                 self.process_generic_params(ty_params, item.span, &qualname, item.id);
1278             }
1279             Mac(_) => (),
1280             _ => visit::walk_item(self, item),
1281         }
1282     }
1283
1284     fn visit_generics(&mut self, generics: &'l ast::Generics) {
1285         for param in generics.ty_params.iter() {
1286             for bound in param.bounds.iter() {
1287                 if let ast::TraitTyParamBound(ref trait_ref, _) = *bound {
1288                     self.process_trait_ref(&trait_ref.trait_ref);
1289                 }
1290             }
1291             if let Some(ref ty) = param.default {
1292                 self.visit_ty(&ty);
1293             }
1294         }
1295     }
1296
1297     fn visit_ty(&mut self, t: &'l ast::Ty) {
1298         self.process_macro_use(t.span);
1299         match t.node {
1300             ast::TyKind::Path(_, ref path) => {
1301                 if generated_code(t.span) {
1302                     return;
1303                 }
1304
1305                 if let Some(id) = self.lookup_def_id(t.id) {
1306                     if let Some(sub_span) = self.span.sub_span_for_type_name(t.span) {
1307                         let span = self.span_from_span(sub_span);
1308                         self.dumper.dump_ref(Ref {
1309                             kind: RefKind::Type,
1310                             span,
1311                             ref_id: ::id_from_def_id(id),
1312                         });
1313                     }
1314                 }
1315
1316                 self.write_sub_paths_truncated(path);
1317                 visit::walk_path(self, path);
1318             }
1319             ast::TyKind::Array(ref element, ref length) => {
1320                 self.visit_ty(element);
1321                 self.nest_tables(length.id, |v| v.visit_expr(length));
1322             }
1323             _ => visit::walk_ty(self, t),
1324         }
1325     }
1326
1327     fn visit_expr(&mut self, ex: &'l ast::Expr) {
1328         debug!("visit_expr {:?}", ex.node);
1329         self.process_macro_use(ex.span);
1330         match ex.node {
1331             ast::ExprKind::Struct(ref path, ref fields, ref base) => {
1332                 let hir_expr = self.save_ctxt.tcx.hir.expect_expr(ex.id);
1333                 let adt = match self.save_ctxt.tables.expr_ty_opt(&hir_expr) {
1334                     Some(ty) if ty.ty_adt_def().is_some() => ty.ty_adt_def().unwrap(),
1335                     _ => {
1336                         visit::walk_expr(self, ex);
1337                         return;
1338                     }
1339                 };
1340                 let def = self.save_ctxt.get_path_def(hir_expr.id);
1341                 self.process_struct_lit(ex, path, fields, adt.variant_of_def(def), base)
1342             }
1343             ast::ExprKind::MethodCall(.., ref args) => self.process_method_call(ex, args),
1344             ast::ExprKind::Field(ref sub_ex, _) => {
1345                 self.visit_expr(&sub_ex);
1346
1347                 if let Some(field_data) = self.save_ctxt.get_expr_data(ex) {
1348                     down_cast_data!(field_data, RefData, ex.span);
1349                     if !generated_code(ex.span) {
1350                         self.dumper.dump_ref(field_data);
1351                     }
1352                 }
1353             }
1354             ast::ExprKind::TupField(ref sub_ex, idx) => {
1355                 self.visit_expr(&sub_ex);
1356
1357                 let hir_node = match self.save_ctxt.tcx.hir.find(sub_ex.id) {
1358                     Some(Node::NodeExpr(expr)) => expr,
1359                     _ => {
1360                         debug!("Missing or weird node for sub-expression {} in {:?}",
1361                                sub_ex.id, ex);
1362                         return;
1363                     }
1364                 };
1365                 let ty = match self.save_ctxt.tables.expr_ty_adjusted_opt(&hir_node) {
1366                     Some(ty) => &ty.sty,
1367                     None => {
1368                         visit::walk_expr(self, ex);
1369                         return;
1370                     }
1371                 };
1372                 match *ty {
1373                     ty::TyAdt(def, _) => {
1374                         let sub_span = self.span.sub_span_after_token(ex.span, token::Dot);
1375                         if !self.span.filter_generated(sub_span, ex.span) {
1376                             let span =
1377                                 self.span_from_span(sub_span.expect("No span found for var ref"));
1378                             self.dumper.dump_ref(Ref {
1379                                 kind: RefKind::Variable,
1380                                 span: span,
1381                                 ref_id: ::id_from_def_id(def.struct_variant().fields[idx.node].did),
1382                             });
1383                         }
1384                     }
1385                     ty::TyTuple(..) => {}
1386                     _ => span_bug!(ex.span,
1387                                    "Expected struct or tuple type, found {:?}",
1388                                    ty),
1389                 }
1390             }
1391             ast::ExprKind::Closure(_, ref decl, ref body, _fn_decl_span) => {
1392                 let mut id = String::from("$");
1393                 id.push_str(&ex.id.to_string());
1394
1395                 // walk arg and return types
1396                 for arg in &decl.inputs {
1397                     self.visit_ty(&arg.ty);
1398                 }
1399
1400                 if let ast::FunctionRetTy::Ty(ref ret_ty) = decl.output {
1401                     self.visit_ty(&ret_ty);
1402                 }
1403
1404                 // walk the body
1405                 self.nest_tables(ex.id, |v| {
1406                     v.process_formals(&decl.inputs, &id);
1407                     v.nest_scope(ex.id, |v| v.visit_expr(body))
1408                 });
1409             }
1410             ast::ExprKind::ForLoop(ref pattern, ref subexpression, ref block, _) |
1411             ast::ExprKind::WhileLet(ref pattern, ref subexpression, ref block, _) => {
1412                 let value = self.span.snippet(subexpression.span);
1413                 self.process_var_decl(pattern, value);
1414                 debug!("for loop, walk sub-expr: {:?}", subexpression.node);
1415                 visit::walk_expr(self, subexpression);
1416                 visit::walk_block(self, block);
1417             }
1418             ast::ExprKind::IfLet(ref pattern, ref subexpression, ref block, ref opt_else) => {
1419                 let value = self.span.snippet(subexpression.span);
1420                 self.process_var_decl(pattern, value);
1421                 visit::walk_expr(self, subexpression);
1422                 visit::walk_block(self, block);
1423                 opt_else.as_ref().map(|el| visit::walk_expr(self, el));
1424             }
1425             ast::ExprKind::Repeat(ref element, ref count) => {
1426                 self.visit_expr(element);
1427                 self.nest_tables(count.id, |v| v.visit_expr(count));
1428             }
1429             // In particular, we take this branch for call and path expressions,
1430             // where we'll index the idents involved just by continuing to walk.
1431             _ => {
1432                 visit::walk_expr(self, ex)
1433             }
1434         }
1435     }
1436
1437     fn visit_mac(&mut self, mac: &'l ast::Mac) {
1438         // These shouldn't exist in the AST at this point, log a span bug.
1439         span_bug!(mac.span, "macro invocation should have been expanded out of AST");
1440     }
1441
1442     fn visit_pat(&mut self, p: &'l ast::Pat) {
1443         self.process_macro_use(p.span);
1444         self.process_pat(p);
1445     }
1446
1447     fn visit_arm(&mut self, arm: &'l ast::Arm) {
1448         let mut collector = PathCollector::new();
1449         for pattern in &arm.pats {
1450             // collect paths from the arm's patterns
1451             collector.visit_pat(&pattern);
1452             self.visit_pat(&pattern);
1453         }
1454
1455         // This is to get around borrow checking, because we need mut self to call process_path.
1456         let mut paths_to_process = vec![];
1457
1458         // process collected paths
1459         for &(id, ref p, immut) in &collector.collected_paths {
1460             match self.save_ctxt.get_path_def(id) {
1461                 HirDef::Local(def_id) => {
1462                     let id = self.tcx.hir.as_local_node_id(def_id).unwrap();
1463                     let mut value = if immut == ast::Mutability::Immutable {
1464                         self.span.snippet(p.span).to_string()
1465                     } else {
1466                         "<mutable>".to_string()
1467                     };
1468                     let typ = self.save_ctxt.tables.node_types
1469                                   .get(&id).map(|t| t.to_string()).unwrap_or(String::new());
1470                     value.push_str(": ");
1471                     value.push_str(&typ);
1472
1473                     assert!(p.segments.len() == 1,
1474                             "qualified path for local variable def in arm");
1475                     if !self.span.filter_generated(Some(p.span), p.span) {
1476                         let qualname = format!("{}${}", path_to_string(p), id);
1477                         let id = ::id_from_node_id(id, &self.save_ctxt);
1478                         let span = self.span_from_span(p.span);
1479
1480                         self.dumper.dump_def(false, Def {
1481                             kind: DefKind::Local,
1482                             id,
1483                             span,
1484                             name: path_to_string(p),
1485                             qualname,
1486                             value: typ,
1487                             parent: None,
1488                             children: vec![],
1489                             decl_id: None,
1490                             docs: String::new(),
1491                             sig: None,
1492                             attributes:vec![],
1493                         });
1494                     }
1495                 }
1496                 HirDef::StructCtor(..) | HirDef::VariantCtor(..) |
1497                 HirDef::Const(..) | HirDef::AssociatedConst(..) |
1498                 HirDef::Struct(..) | HirDef::Variant(..) |
1499                 HirDef::TyAlias(..) | HirDef::AssociatedTy(..) |
1500                 HirDef::SelfTy(..) => {
1501                     paths_to_process.push((id, p.clone()))
1502                 }
1503                 def => error!("unexpected definition kind when processing collected paths: {:?}",
1504                               def),
1505             }
1506         }
1507
1508         for &(id, ref path) in &paths_to_process {
1509             self.process_path(id, path);
1510         }
1511         walk_list!(self, visit_expr, &arm.guard);
1512         self.visit_expr(&arm.body);
1513     }
1514
1515     fn visit_path(&mut self, p: &'l ast::Path, id: NodeId) {
1516         self.process_path(id, p);
1517     }
1518
1519     fn visit_stmt(&mut self, s: &'l ast::Stmt) {
1520         self.process_macro_use(s.span);
1521         visit::walk_stmt(self, s)
1522     }
1523
1524     fn visit_local(&mut self, l: &'l ast::Local) {
1525         self.process_macro_use(l.span);
1526         let value = l.init.as_ref().map(|i| self.span.snippet(i.span)).unwrap_or(String::new());
1527         self.process_var_decl(&l.pat, value);
1528
1529         // Just walk the initialiser and type (don't want to walk the pattern again).
1530         walk_list!(self, visit_ty, &l.ty);
1531         walk_list!(self, visit_expr, &l.init);
1532     }
1533
1534     fn visit_foreign_item(&mut self, item: &'l ast::ForeignItem) {
1535         match item.node {
1536             ast::ForeignItemKind::Fn(ref decl, ref generics) => {
1537                 if let Some(fn_data) = self.save_ctxt.get_extern_item_data(item) {
1538                     down_cast_data!(fn_data, DefData, item.span);
1539
1540                     self.nest_tables(item.id, |v| v.process_formals(&decl.inputs,
1541                                                                     &fn_data.qualname));
1542                     self.process_generic_params(generics, item.span, &fn_data.qualname, item.id);
1543                     self.dumper.dump_def(item.vis == ast::Visibility::Public, fn_data);
1544                 }
1545
1546                 for arg in &decl.inputs {
1547                     self.visit_ty(&arg.ty);
1548                 }
1549
1550                 if let ast::FunctionRetTy::Ty(ref ret_ty) = decl.output {
1551                     self.visit_ty(&ret_ty);
1552                 }
1553             }
1554             ast::ForeignItemKind::Static(ref ty, _) => {
1555                 if let Some(var_data) = self.save_ctxt.get_extern_item_data(item) {
1556                     down_cast_data!(var_data, DefData, item.span);
1557                     self.dumper.dump_def(item.vis == ast::Visibility::Public, var_data);
1558                 }
1559
1560                 self.visit_ty(ty);
1561             }
1562         }
1563     }
1564 }