src/librustc_save_analysis/lib.rs

   1 // Copyright 2012-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 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  12        html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
  13        html_root_url = "https://doc.rust-lang.org/nightly/")]
  14 #![feature(custom_attribute)]
  15 #![allow(unused_attributes)]
  16
  17 #![recursion_limit="256"]
  18
  19 #[macro_use]
  20 extern crate rustc;
  21
  22 #[macro_use]
  23 extern crate log;
  24 extern crate rustc_data_structures;
  25 extern crate rustc_serialize;
  26 extern crate rustc_target;
  27 extern crate rustc_typeck;
  28 #[macro_use]
  29 extern crate syntax;
  30 extern crate syntax_pos;
  31
  32 extern crate rls_data;
  33 extern crate rls_span;
  34
  35
  36 mod json_dumper;
  37 mod dump_visitor;
  38 #[macro_use]
  39 mod span_utils;
  40 mod sig;
  41
  42 use rustc::hir;
  43 use rustc::hir::def::Def as HirDef;
  44 use rustc::hir::map::{Node, NodeTraitItem, NodeImplItem};
  45 use rustc::hir::def_id::{DefId, LOCAL_CRATE};
  46 use rustc::middle::cstore::ExternCrate;
  47 use rustc::session::config::CrateType;
  48 use rustc::ty::{self, TyCtxt};
  49 use rustc_typeck::hir_ty_to_ty;
  50
  51 use std::cell::Cell;
  52 use std::default::Default;
  53 use std::env;
  54 use std::fs::File;
  55 use std::path::{Path, PathBuf};
  56
  57 use syntax::ast::{self, Attribute, NodeId, PatKind};
  58 use syntax::codemap::Spanned;
  59 use syntax::parse::lexer::comments::strip_doc_comment_decoration;
  60 use syntax::parse::token;
  61 use syntax::print::pprust;
  62 use syntax::symbol::keywords;
  63 use syntax::visit::{self, Visitor};
  64 use syntax::print::pprust::{arg_to_string, ty_to_string};
  65 use syntax::codemap::MacroAttribute;
  66 use syntax_pos::*;
  67
  68 use json_dumper::JsonDumper;
  69 use dump_visitor::DumpVisitor;
  70 use span_utils::SpanUtils;
  71
  72 use rls_data::{Def, DefKind, ExternalCrateData, GlobalCrateId, MacroRef, Ref, RefKind, Relation,
  73                RelationKind, SpanData, Impl, ImplKind};
  74 use rls_data::config::Config;
  75
  76
  77 pub struct SaveContext<'l, 'tcx: 'l> {
  78     tcx: TyCtxt<'l, 'tcx, 'tcx>,
  79     tables: &'l ty::TypeckTables<'tcx>,
  80     analysis: &'l ty::CrateAnalysis,
  81     span_utils: SpanUtils<'tcx>,
  82     config: Config,
  83     impl_counter: Cell<u32>,
  84 }
  85
  86 #[derive(Debug)]
  87 pub enum Data {
  88     RefData(Ref),
  89     DefData(Def),
  90     RelationData(Relation, Impl),
  91 }
  92
  93 impl<'l, 'tcx: 'l> SaveContext<'l, 'tcx> {
  94     fn span_from_span(&self, span: Span) -> SpanData {
  95         use rls_span::{Column, Row};
  96
  97         let cm = self.tcx.sess.codemap();
  98         let start = cm.lookup_char_pos(span.lo());
  99         let end = cm.lookup_char_pos(span.hi());
 100
 101         SpanData {
 102             file_name: start.file.name.clone().to_string().into(),
 103             byte_start: span.lo().0,
 104             byte_end: span.hi().0,
 105             line_start: Row::new_one_indexed(start.line as u32),
 106             line_end: Row::new_one_indexed(end.line as u32),
 107             column_start: Column::new_one_indexed(start.col.0 as u32 + 1),
 108             column_end: Column::new_one_indexed(end.col.0 as u32 + 1),
 109         }
 110     }
 111
 112     // List external crates used by the current crate.
 113     pub fn get_external_crates(&self) -> Vec<ExternalCrateData> {
 114         let mut result = Vec::new();
 115
 116         for &n in self.tcx.crates().iter() {
 117             let span = match *self.tcx.extern_crate(n.as_def_id()) {
 118                 Some(ExternCrate { span, .. }) => span,
 119                 None => {
 120                     debug!("Skipping crate {}, no data", n);
 121                     continue;
 122                 }
 123             };
 124             let lo_loc = self.span_utils.sess.codemap().lookup_char_pos(span.lo());
 125             result.push(ExternalCrateData {
 126                 // FIXME: change file_name field to PathBuf in rls-data
 127                 // https://github.com/nrc/rls-data/issues/7
 128                 file_name: self.span_utils.make_path_string(&lo_loc.file.name),
 129                 num: n.as_u32(),
 130                 id: GlobalCrateId {
 131                     name: self.tcx.crate_name(n).to_string(),
 132                     disambiguator: self.tcx.crate_disambiguator(n).to_fingerprint().as_value(),
 133                 },
 134             });
 135         }
 136
 137         result
 138     }
 139
 140     pub fn get_extern_item_data(&self, item: &ast::ForeignItem) -> Option<Data> {
 141         let qualname = format!("::{}", self.tcx.node_path_str(item.id));
 142         match item.node {
 143             ast::ForeignItemKind::Fn(ref decl, ref generics) => {
 144                 let sub_span = self.span_utils
 145                     .sub_span_after_keyword(item.span, keywords::Fn);
 146                 filter!(self.span_utils, sub_span, item.span, None);
 147
 148                 Some(Data::DefData(Def {
 149                     kind: DefKind::Function,
 150                     id: id_from_node_id(item.id, self),
 151                     span: self.span_from_span(sub_span.unwrap()),
 152                     name: item.ident.to_string(),
 153                     qualname,
 154                     value: make_signature(decl, generics),
 155                     parent: None,
 156                     children: vec![],
 157                     decl_id: None,
 158                     docs: self.docs_for_attrs(&item.attrs),
 159                     sig: sig::foreign_item_signature(item, self),
 160                     attributes: lower_attributes(item.attrs.clone(), self),
 161                 }))
 162             }
 163             ast::ForeignItemKind::Static(ref ty, m) => {
 164                 let keyword = if m { keywords::Mut } else { keywords::Static };
 165                 let sub_span = self.span_utils.sub_span_after_keyword(item.span, keyword);
 166                 filter!(self.span_utils, sub_span, item.span, None);
 167
 168                 let id = ::id_from_node_id(item.id, self);
 169                 let span = self.span_from_span(sub_span.unwrap());
 170
 171                 Some(Data::DefData(Def {
 172                     kind: DefKind::Static,
 173                     id,
 174                     span,
 175                     name: item.ident.to_string(),
 176                     qualname,
 177                     value: ty_to_string(ty),
 178                     parent: None,
 179                     children: vec![],
 180                     decl_id: None,
 181                     docs: self.docs_for_attrs(&item.attrs),
 182                     sig: sig::foreign_item_signature(item, self),
 183                     attributes: lower_attributes(item.attrs.clone(), self),
 184                 }))
 185             }
 186             // FIXME(plietar): needs a new DefKind in rls-data
 187             ast::ForeignItemKind::Ty => None,
 188             ast::ForeignItemKind::Macro(..) => None,
 189         }
 190     }
 191
 192     pub fn get_item_data(&self, item: &ast::Item) -> Option<Data> {
 193         match item.node {
 194             ast::ItemKind::Fn(ref decl, .., ref generics, _) => {
 195                 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
 196                 let sub_span = self.span_utils
 197                     .sub_span_after_keyword(item.span, keywords::Fn);
 198                 filter!(self.span_utils, sub_span, item.span, None);
 199                 Some(Data::DefData(Def {
 200                     kind: DefKind::Function,
 201                     id: id_from_node_id(item.id, self),
 202                     span: self.span_from_span(sub_span.unwrap()),
 203                     name: item.ident.to_string(),
 204                     qualname,
 205                     value: make_signature(decl, generics),
 206                     parent: None,
 207                     children: vec![],
 208                     decl_id: None,
 209                     docs: self.docs_for_attrs(&item.attrs),
 210                     sig: sig::item_signature(item, self),
 211                     attributes: lower_attributes(item.attrs.clone(), self),
 212                 }))
 213             }
 214             ast::ItemKind::Static(ref typ, mt, _) => {
 215                 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
 216
 217                 let keyword = match mt {
 218                     ast::Mutability::Mutable => keywords::Mut,
 219                     ast::Mutability::Immutable => keywords::Static,
 220                 };
 221
 222                 let sub_span = self.span_utils.sub_span_after_keyword(item.span, keyword);
 223                 filter!(self.span_utils, sub_span, item.span, None);
 224
 225                 let id = id_from_node_id(item.id, self);
 226                 let span = self.span_from_span(sub_span.unwrap());
 227
 228                 Some(Data::DefData(Def {
 229                     kind: DefKind::Static,
 230                     id,
 231                     span,
 232                     name: item.ident.to_string(),
 233                     qualname,
 234                     value: ty_to_string(&typ),
 235                     parent: None,
 236                     children: vec![],
 237                     decl_id: None,
 238                     docs: self.docs_for_attrs(&item.attrs),
 239                     sig: sig::item_signature(item, self),
 240                     attributes: lower_attributes(item.attrs.clone(), self),
 241                 }))
 242             }
 243             ast::ItemKind::Const(ref typ, _) => {
 244                 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
 245                 let sub_span = self.span_utils
 246                     .sub_span_after_keyword(item.span, keywords::Const);
 247                 filter!(self.span_utils, sub_span, item.span, None);
 248
 249                 let id = id_from_node_id(item.id, self);
 250                 let span = self.span_from_span(sub_span.unwrap());
 251
 252                 Some(Data::DefData(Def {
 253                     kind: DefKind::Const,
 254                     id,
 255                     span,
 256                     name: item.ident.to_string(),
 257                     qualname,
 258                     value: ty_to_string(typ),
 259                     parent: None,
 260                     children: vec![],
 261                     decl_id: None,
 262                     docs: self.docs_for_attrs(&item.attrs),
 263                     sig: sig::item_signature(item, self),
 264                     attributes: lower_attributes(item.attrs.clone(), self),
 265                 }))
 266             }
 267             ast::ItemKind::Mod(ref m) => {
 268                 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
 269
 270                 let cm = self.tcx.sess.codemap();
 271                 let filename = cm.span_to_filename(m.inner);
 272
 273                 let sub_span = self.span_utils
 274                     .sub_span_after_keyword(item.span, keywords::Mod);
 275                 filter!(self.span_utils, sub_span, item.span, None);
 276
 277                 Some(Data::DefData(Def {
 278                     kind: DefKind::Mod,
 279                     id: id_from_node_id(item.id, self),
 280                     name: item.ident.to_string(),
 281                     qualname,
 282                     span: self.span_from_span(sub_span.unwrap()),
 283                     value: filename.to_string(),
 284                     parent: None,
 285                     children: m.items
 286                         .iter()
 287                         .map(|i| id_from_node_id(i.id, self))
 288                         .collect(),
 289                     decl_id: None,
 290                     docs: self.docs_for_attrs(&item.attrs),
 291                     sig: sig::item_signature(item, self),
 292                     attributes: lower_attributes(item.attrs.clone(), self),
 293                 }))
 294             }
 295             ast::ItemKind::Enum(ref def, _) => {
 296                 let name = item.ident.to_string();
 297                 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
 298                 let sub_span = self.span_utils
 299                     .sub_span_after_keyword(item.span, keywords::Enum);
 300                 filter!(self.span_utils, sub_span, item.span, None);
 301                 let variants_str = def.variants
 302                     .iter()
 303                     .map(|v| v.node.ident.to_string())
 304                     .collect::<Vec<_>>()
 305                     .join(", ");
 306                 let value = format!("{}::{{{}}}", name, variants_str);
 307                 Some(Data::DefData(Def {
 308                     kind: DefKind::Enum,
 309                     id: id_from_node_id(item.id, self),
 310                     span: self.span_from_span(sub_span.unwrap()),
 311                     name,
 312                     qualname,
 313                     value,
 314                     parent: None,
 315                     children: def.variants
 316                         .iter()
 317                         .map(|v| id_from_node_id(v.node.data.id(), self))
 318                         .collect(),
 319                     decl_id: None,
 320                     docs: self.docs_for_attrs(&item.attrs),
 321                     sig: sig::item_signature(item, self),
 322                     attributes: lower_attributes(item.attrs.to_owned(), self),
 323                 }))
 324             }
 325             ast::ItemKind::Impl(.., ref trait_ref, ref typ, ref impls) => {
 326                 if let ast::TyKind::Path(None, ref path) = typ.node {
 327                     // Common case impl for a struct or something basic.
 328                     if generated_code(path.span) {
 329                         return None;
 330                     }
 331                     let sub_span = self.span_utils.sub_span_for_type_name(path.span);
 332                     filter!(self.span_utils, sub_span, typ.span, None);
 333
 334                     let impl_id = self.next_impl_id();
 335                     let span = self.span_from_span(sub_span.unwrap());
 336
 337                     let type_data = self.lookup_ref_id(typ.id);
 338                     type_data.map(|type_data| {
 339                         Data::RelationData(Relation {
 340                             kind: RelationKind::Impl {
 341                                 id: impl_id,
 342                             },
 343                             span: span.clone(),
 344                             from: id_from_def_id(type_data),
 345                             to: trait_ref
 346                                 .as_ref()
 347                                 .and_then(|t| self.lookup_ref_id(t.ref_id))
 348                                 .map(id_from_def_id)
 349                                 .unwrap_or(null_id()),
 350                         },
 351                         Impl {
 352                             id: impl_id,
 353                             kind: match *trait_ref {
 354                                 Some(_) => ImplKind::Direct,
 355                                 None => ImplKind::Inherent,
 356                             },
 357                             span: span,
 358                             value: String::new(),
 359                             parent: None,
 360                             children: impls
 361                                 .iter()
 362                                 .map(|i| id_from_node_id(i.id, self))
 363                                 .collect(),
 364                             docs: String::new(),
 365                             sig: None,
 366                             attributes: vec![],
 367                         })
 368                     })
 369                 } else {
 370                     None
 371                 }
 372             }
 373             _ => {
 374                 // FIXME
 375                 bug!();
 376             }
 377         }
 378     }
 379
 380     pub fn get_field_data(&self, field: &ast::StructField, scope: NodeId) -> Option<Def> {
 381         if let Some(ident) = field.ident {
 382             let name = ident.to_string();
 383             let qualname = format!("::{}::{}", self.tcx.node_path_str(scope), ident);
 384             let sub_span = self.span_utils
 385                 .sub_span_before_token(field.span, token::Colon);
 386             filter!(self.span_utils, sub_span, field.span, None);
 387             let def_id = self.tcx.hir.local_def_id(field.id);
 388             let typ = self.tcx.type_of(def_id).to_string();
 389
 390
 391             let id = id_from_node_id(field.id, self);
 392             let span = self.span_from_span(sub_span.unwrap());
 393
 394             Some(Def {
 395                 kind: DefKind::Field,
 396                 id,
 397                 span,
 398                 name,
 399                 qualname,
 400                 value: typ,
 401                 parent: Some(id_from_node_id(scope, self)),
 402                 children: vec![],
 403                 decl_id: None,
 404                 docs: self.docs_for_attrs(&field.attrs),
 405                 sig: sig::field_signature(field, self),
 406                 attributes: lower_attributes(field.attrs.clone(), self),
 407             })
 408         } else {
 409             None
 410         }
 411     }
 412
 413     // FIXME would be nice to take a MethodItem here, but the ast provides both
 414     // trait and impl flavours, so the caller must do the disassembly.
 415     pub fn get_method_data(&self, id: ast::NodeId, name: ast::Name, span: Span) -> Option<Def> {
 416         // The qualname for a method is the trait name or name of the struct in an impl in
 417         // which the method is declared in, followed by the method's name.
 418         let (qualname, parent_scope, decl_id, docs, attributes) =
 419             match self.tcx.impl_of_method(self.tcx.hir.local_def_id(id)) {
 420                 Some(impl_id) => match self.tcx.hir.get_if_local(impl_id) {
 421                     Some(Node::NodeItem(item)) => match item.node {
 422                         hir::ItemKind::Impl(.., ref ty, _) => {
 423                             let mut qualname = String::from("<");
 424                             qualname.push_str(&self.tcx.hir.node_to_pretty_string(ty.id));
 425
 426                             let trait_id = self.tcx.trait_id_of_impl(impl_id);
 427                             let mut decl_id = None;
 428                             let mut docs = String::new();
 429                             let mut attrs = vec![];
 430                             if let Some(NodeImplItem(item)) = self.tcx.hir.find(id) {
 431                                 docs = self.docs_for_attrs(&item.attrs);
 432                                 attrs = item.attrs.to_vec();
 433                             }
 434
 435                             if let Some(def_id) = trait_id {
 436                                 // A method in a trait impl.
 437                                 qualname.push_str(" as ");
 438                                 qualname.push_str(&self.tcx.item_path_str(def_id));
 439                                 self.tcx
 440                                     .associated_items(def_id)
 441                                     .find(|item| item.ident.name == name)
 442                                     .map(|item| decl_id = Some(item.def_id));
 443                             }
 444                             qualname.push_str(">");
 445
 446                             (qualname, trait_id, decl_id, docs, attrs)
 447                         }
 448                         _ => {
 449                             span_bug!(
 450                                 span,
 451                                 "Container {:?} for method {} not an impl?",
 452                                 impl_id,
 453                                 id
 454                             );
 455                         }
 456                     },
 457                     r => {
 458                         span_bug!(
 459                             span,
 460                             "Container {:?} for method {} is not a node item {:?}",
 461                             impl_id,
 462                             id,
 463                             r
 464                         );
 465                     }
 466                 },
 467                 None => match self.tcx.trait_of_item(self.tcx.hir.local_def_id(id)) {
 468                     Some(def_id) => {
 469                         let mut docs = String::new();
 470                         let mut attrs = vec![];
 471
 472                         if let Some(NodeTraitItem(item)) = self.tcx.hir.find(id) {
 473                             docs = self.docs_for_attrs(&item.attrs);
 474                             attrs = item.attrs.to_vec();
 475                         }
 476
 477                         (
 478                             format!("::{}", self.tcx.item_path_str(def_id)),
 479                             Some(def_id),
 480                             None,
 481                             docs,
 482                             attrs,
 483                         )
 484                     }
 485                     None => {
 486                         debug!("Could not find container for method {} at {:?}", id, span);
 487                         // This is not necessarily a bug, if there was a compilation error,
 488                         // the tables we need might not exist.
 489                         return None;
 490                     }
 491                 },
 492             };
 493
 494         let qualname = format!("{}::{}", qualname, name);
 495
 496         let sub_span = self.span_utils.sub_span_after_keyword(span, keywords::Fn);
 497         filter!(self.span_utils, sub_span, span, None);
 498
 499         Some(Def {
 500             kind: DefKind::Method,
 501             id: id_from_node_id(id, self),
 502             span: self.span_from_span(sub_span.unwrap()),
 503             name: name.to_string(),
 504             qualname,
 505             // FIXME you get better data here by using the visitor.
 506             value: String::new(),
 507             parent: parent_scope.map(|id| id_from_def_id(id)),
 508             children: vec![],
 509             decl_id: decl_id.map(|id| id_from_def_id(id)),
 510             docs,
 511             sig: None,
 512             attributes: lower_attributes(attributes, self),
 513         })
 514     }
 515
 516     pub fn get_trait_ref_data(&self, trait_ref: &ast::TraitRef) -> Option<Ref> {
 517         self.lookup_ref_id(trait_ref.ref_id).and_then(|def_id| {
 518             let span = trait_ref.path.span;
 519             if generated_code(span) {
 520                 return None;
 521             }
 522             let sub_span = self.span_utils.sub_span_for_type_name(span).or(Some(span));
 523             filter!(self.span_utils, sub_span, span, None);
 524             let span = self.span_from_span(sub_span.unwrap());
 525             Some(Ref {
 526                 kind: RefKind::Type,
 527                 span,
 528                 ref_id: id_from_def_id(def_id),
 529             })
 530         })
 531     }
 532
 533     pub fn get_expr_data(&self, expr: &ast::Expr) -> Option<Data> {
 534         let hir_node = self.tcx.hir.expect_expr(expr.id);
 535         let ty = self.tables.expr_ty_adjusted_opt(&hir_node);
 536         if ty.is_none() || ty.unwrap().sty == ty::TyError {
 537             return None;
 538         }
 539         match expr.node {
 540             ast::ExprKind::Field(ref sub_ex, ident) => {
 541                 let hir_node = match self.tcx.hir.find(sub_ex.id) {
 542                     Some(Node::NodeExpr(expr)) => expr,
 543                     _ => {
 544                         debug!(
 545                             "Missing or weird node for sub-expression {} in {:?}",
 546                             sub_ex.id,
 547                             expr
 548                         );
 549                         return None;
 550                     }
 551                 };
 552                 match self.tables.expr_ty_adjusted(&hir_node).sty {
 553                     ty::TyAdt(def, _) if !def.is_enum() => {
 554                         let variant = &def.non_enum_variant();
 555                         let index = self.tcx.find_field_index(ident, variant).unwrap();
 556                         let sub_span = self.span_utils.span_for_last_ident(expr.span);
 557                         filter!(self.span_utils, sub_span, expr.span, None);
 558                         let span = self.span_from_span(sub_span.unwrap());
 559                         return Some(Data::RefData(Ref {
 560                             kind: RefKind::Variable,
 561                             span,
 562                             ref_id: id_from_def_id(variant.fields[index].did),
 563                         }));
 564                     }
 565                     ty::TyTuple(..) => None,
 566                     _ => {
 567                         debug!("Expected struct or union type, found {:?}", ty);
 568                         None
 569                     }
 570                 }
 571             }
 572             ast::ExprKind::Struct(ref path, ..) => {
 573                 match self.tables.expr_ty_adjusted(&hir_node).sty {
 574                     ty::TyAdt(def, _) if !def.is_enum() => {
 575                         let sub_span = self.span_utils.span_for_last_ident(path.span);
 576                         filter!(self.span_utils, sub_span, path.span, None);
 577                         let span = self.span_from_span(sub_span.unwrap());
 578                         Some(Data::RefData(Ref {
 579                             kind: RefKind::Type,
 580                             span,
 581                             ref_id: id_from_def_id(def.did),
 582                         }))
 583                     }
 584                     _ => {
 585                         // FIXME ty could legitimately be an enum, but then we will fail
 586                         // later if we try to look up the fields.
 587                         debug!("expected struct or union, found {:?}", ty);
 588                         None
 589                     }
 590                 }
 591             }
 592             ast::ExprKind::MethodCall(ref seg, ..) => {
 593                 let expr_hir_id = self.tcx.hir.definitions().node_to_hir_id(expr.id);
 594                 let method_id = match self.tables.type_dependent_defs().get(expr_hir_id) {
 595                     Some(id) => id.def_id(),
 596                     None => {
 597                         debug!("Could not resolve method id for {:?}", expr);
 598                         return None;
 599                     }
 600                 };
 601                 let (def_id, decl_id) = match self.tcx.associated_item(method_id).container {
 602                     ty::ImplContainer(_) => (Some(method_id), None),
 603                     ty::TraitContainer(_) => (None, Some(method_id)),
 604                 };
 605                 let sub_span = seg.ident.span;
 606                 filter!(self.span_utils, Some(sub_span), expr.span, None);
 607                 let span = self.span_from_span(sub_span);
 608                 Some(Data::RefData(Ref {
 609                     kind: RefKind::Function,
 610                     span,
 611                     ref_id: def_id
 612                         .or(decl_id)
 613                         .map(|id| id_from_def_id(id))
 614                         .unwrap_or(null_id()),
 615                 }))
 616             }
 617             ast::ExprKind::Path(_, ref path) => {
 618                 self.get_path_data(expr.id, path).map(|d| Data::RefData(d))
 619             }
 620             _ => {
 621                 // FIXME
 622                 bug!();
 623             }
 624         }
 625     }
 626
 627     pub fn get_path_def(&self, id: NodeId) -> HirDef {
 628         match self.tcx.hir.get(id) {
 629             Node::NodeTraitRef(tr) => tr.path.def,
 630
 631             Node::NodeItem(&hir::Item {
 632                 node: hir::ItemKind::Use(ref path, _),
 633                 ..
 634             }) |
 635             Node::NodeVisibility(&Spanned {
 636                 node: hir::VisibilityKind::Restricted { ref path, .. }, .. }) => path.def,
 637
 638             Node::NodeExpr(&hir::Expr {
 639                 node: hir::ExprKind::Struct(ref qpath, ..),
 640                 ..
 641             }) |
 642             Node::NodeExpr(&hir::Expr {
 643                 node: hir::ExprKind::Path(ref qpath),
 644                 ..
 645             }) |
 646             Node::NodePat(&hir::Pat {
 647                 node: hir::PatKind::Path(ref qpath),
 648                 ..
 649             }) |
 650             Node::NodePat(&hir::Pat {
 651                 node: hir::PatKind::Struct(ref qpath, ..),
 652                 ..
 653             }) |
 654             Node::NodePat(&hir::Pat {
 655                 node: hir::PatKind::TupleStruct(ref qpath, ..),
 656                 ..
 657             }) => {
 658                 let hir_id = self.tcx.hir.node_to_hir_id(id);
 659                 self.tables.qpath_def(qpath, hir_id)
 660             }
 661
 662             Node::NodeBinding(&hir::Pat {
 663                 node: hir::PatKind::Binding(_, canonical_id, ..),
 664                 ..
 665             }) => HirDef::Local(canonical_id),
 666
 667             Node::NodeTy(ty) => if let hir::Ty {
 668                 node: hir::TyKind::Path(ref qpath),
 669                 ..
 670             } = *ty
 671             {
 672                 match *qpath {
 673                     hir::QPath::Resolved(_, ref path) => path.def,
 674                     hir::QPath::TypeRelative(..) => {
 675                         let ty = hir_ty_to_ty(self.tcx, ty);
 676                         if let ty::TyProjection(proj) = ty.sty {
 677                             return HirDef::AssociatedTy(proj.item_def_id);
 678                         }
 679                         HirDef::Err
 680                     }
 681                 }
 682             } else {
 683                 HirDef::Err
 684             },
 685
 686             _ => HirDef::Err,
 687         }
 688     }
 689
 690     pub fn get_path_data(&self, id: NodeId, path: &ast::Path) -> Option<Ref> {
 691         // Returns true if the path is function type sugar, e.g., `Fn(A) -> B`.
 692         fn fn_type(path: &ast::Path) -> bool {
 693             if path.segments.len() != 1 {
 694                 return false;
 695             }
 696             if let Some(ref generic_args) = path.segments[0].args {
 697                 if let ast::GenericArgs::Parenthesized(_) = **generic_args {
 698                     return true;
 699                 }
 700             }
 701             false
 702         }
 703
 704         if path.segments.is_empty() {
 705             return None;
 706         }
 707
 708         let def = self.get_path_def(id);
 709         let last_seg = &path.segments[path.segments.len() - 1];
 710         let sub_span = last_seg.ident.span;
 711         filter!(self.span_utils, Some(sub_span), path.span, None);
 712         match def {
 713             HirDef::Upvar(id, ..) | HirDef::Local(id) => {
 714                 let span = self.span_from_span(sub_span);
 715                 Some(Ref {
 716                     kind: RefKind::Variable,
 717                     span,
 718                     ref_id: id_from_node_id(id, self),
 719                 })
 720             }
 721             HirDef::Static(..) |
 722             HirDef::Const(..) |
 723             HirDef::AssociatedConst(..) |
 724             HirDef::VariantCtor(..) => {
 725                 let span = self.span_from_span(sub_span);
 726                 Some(Ref {
 727                     kind: RefKind::Variable,
 728                     span,
 729                     ref_id: id_from_def_id(def.def_id()),
 730                 })
 731             }
 732             HirDef::Trait(def_id) if fn_type(path) => {
 733                 // Function type bounds are desugared in the parser, so we have to
 734                 // special case them here.
 735                 let fn_span = self.span_utils.span_for_first_ident(path.span);
 736                 fn_span.map(|span| {
 737                     Ref {
 738                         kind: RefKind::Type,
 739                         span: self.span_from_span(span),
 740                         ref_id: id_from_def_id(def_id),
 741                     }
 742                 })
 743             }
 744             HirDef::Struct(def_id) |
 745             HirDef::Variant(def_id, ..) |
 746             HirDef::Union(def_id) |
 747             HirDef::Enum(def_id) |
 748             HirDef::TyAlias(def_id) |
 749             HirDef::TyForeign(def_id) |
 750             HirDef::TraitAlias(def_id) |
 751             HirDef::AssociatedExistential(def_id) |
 752             HirDef::AssociatedTy(def_id) |
 753             HirDef::Trait(def_id) |
 754             HirDef::Existential(def_id) |
 755             HirDef::TyParam(def_id) => {
 756                 let span = self.span_from_span(sub_span);
 757                 Some(Ref {
 758                     kind: RefKind::Type,
 759                     span,
 760                     ref_id: id_from_def_id(def_id),
 761                 })
 762             }
 763             HirDef::StructCtor(def_id, _) => {
 764                 // This is a reference to a tuple struct where the def_id points
 765                 // to an invisible constructor function. That is not a very useful
 766                 // def, so adjust to point to the tuple struct itself.
 767                 let span = self.span_from_span(sub_span);
 768                 let parent_def_id = self.tcx.parent_def_id(def_id).unwrap();
 769                 Some(Ref {
 770                     kind: RefKind::Type,
 771                     span,
 772                     ref_id: id_from_def_id(parent_def_id),
 773                 })
 774             }
 775             HirDef::Method(decl_id) => {
 776                 let def_id = if decl_id.is_local() {
 777                     let ti = self.tcx.associated_item(decl_id);
 778                     self.tcx
 779                         .associated_items(ti.container.id())
 780                         .find(|item| item.ident.name == ti.ident.name &&
 781                                      item.defaultness.has_value())
 782                         .map(|item| item.def_id)
 783                 } else {
 784                     None
 785                 };
 786                 let span = self.span_from_span(sub_span);
 787                 Some(Ref {
 788                     kind: RefKind::Function,
 789                     span,
 790                     ref_id: id_from_def_id(def_id.unwrap_or(decl_id)),
 791                 })
 792             }
 793             HirDef::Fn(def_id) => {
 794                 let span = self.span_from_span(sub_span);
 795                 Some(Ref {
 796                     kind: RefKind::Function,
 797                     span,
 798                     ref_id: id_from_def_id(def_id),
 799                 })
 800             }
 801             HirDef::Mod(def_id) => {
 802                 let span = self.span_from_span(sub_span);
 803                 Some(Ref {
 804                     kind: RefKind::Mod,
 805                     span,
 806                     ref_id: id_from_def_id(def_id),
 807                 })
 808             }
 809             HirDef::PrimTy(..) |
 810             HirDef::SelfTy(..) |
 811             HirDef::Label(..) |
 812             HirDef::Macro(..) |
 813             HirDef::GlobalAsm(..) |
 814             HirDef::ToolMod |
 815             HirDef::NonMacroAttr |
 816             HirDef::Err => None,
 817         }
 818     }
 819
 820     pub fn get_field_ref_data(
 821         &self,
 822         field_ref: &ast::Field,
 823         variant: &ty::VariantDef,
 824     ) -> Option<Ref> {
 825         let index = self.tcx.find_field_index(field_ref.ident, variant).unwrap();
 826         // We don't really need a sub-span here, but no harm done
 827         let sub_span = self.span_utils.span_for_last_ident(field_ref.ident.span);
 828         filter!(self.span_utils, sub_span, field_ref.ident.span, None);
 829         let span = self.span_from_span(sub_span.unwrap());
 830         Some(Ref {
 831             kind: RefKind::Variable,
 832             span,
 833             ref_id: id_from_def_id(variant.fields[index].did),
 834         })
 835     }
 836
 837     /// Attempt to return MacroRef for any AST node.
 838     ///
 839     /// For a given piece of AST defined by the supplied Span and NodeId,
 840     /// returns None if the node is not macro-generated or the span is malformed,
 841     /// else uses the expansion callsite and callee to return some MacroRef.
 842     pub fn get_macro_use_data(&self, span: Span) -> Option<MacroRef> {
 843         if !generated_code(span) {
 844             return None;
 845         }
 846         // Note we take care to use the source callsite/callee, to handle
 847         // nested expansions and ensure we only generate data for source-visible
 848         // macro uses.
 849         let callsite = span.source_callsite();
 850         let callsite_span = self.span_from_span(callsite);
 851         let callee = span.source_callee()?;
 852         let callee_span = callee.def_site?;
 853
 854         // Ignore attribute macros, their spans are usually mangled
 855         if let MacroAttribute(_) = callee.format {
 856             return None;
 857         }
 858
 859         // If the callee is an imported macro from an external crate, need to get
 860         // the source span and name from the session, as their spans are localized
 861         // when read in, and no longer correspond to the source.
 862         if let Some(mac) = self.tcx
 863             .sess
 864             .imported_macro_spans
 865             .borrow()
 866             .get(&callee_span)
 867         {
 868             let &(ref mac_name, mac_span) = mac;
 869             let mac_span = self.span_from_span(mac_span);
 870             return Some(MacroRef {
 871                 span: callsite_span,
 872                 qualname: mac_name.clone(), // FIXME: generate the real qualname
 873                 callee_span: mac_span,
 874             });
 875         }
 876
 877         let callee_span = self.span_from_span(callee_span);
 878         Some(MacroRef {
 879             span: callsite_span,
 880             qualname: callee.format.name().to_string(), // FIXME: generate the real qualname
 881             callee_span,
 882         })
 883     }
 884
 885     fn lookup_ref_id(&self, ref_id: NodeId) -> Option<DefId> {
 886         match self.get_path_def(ref_id) {
 887             HirDef::PrimTy(_) | HirDef::SelfTy(..) | HirDef::Err => None,
 888             def => Some(def.def_id()),
 889         }
 890     }
 891
 892     fn docs_for_attrs(&self, attrs: &[Attribute]) -> String {
 893         let mut result = String::new();
 894
 895         for attr in attrs {
 896             if attr.check_name("doc") {
 897                 if let Some(val) = attr.value_str() {
 898                     if attr.is_sugared_doc {
 899                         result.push_str(&strip_doc_comment_decoration(&val.as_str()));
 900                     } else {
 901                         result.push_str(&val.as_str());
 902                     }
 903                     result.push('\n');
 904                 } else if let Some(meta_list) = attr.meta_item_list() {
 905                     meta_list.into_iter()
 906                              .filter(|it| it.check_name("include"))
 907                              .filter_map(|it| it.meta_item_list().map(|l| l.to_owned()))
 908                              .flat_map(|it| it)
 909                              .filter(|meta| meta.check_name("contents"))
 910                              .filter_map(|meta| meta.value_str())
 911                              .for_each(|val| {
 912                                  result.push_str(&val.as_str());
 913                                  result.push('\n');
 914                              });
 915                 }
 916             }
 917         }
 918
 919         if !self.config.full_docs {
 920             if let Some(index) = result.find("\n\n") {
 921                 result.truncate(index);
 922             }
 923         }
 924
 925         result
 926     }
 927
 928     fn next_impl_id(&self) -> u32 {
 929         let next = self.impl_counter.get();
 930         self.impl_counter.set(next + 1);
 931         next
 932     }
 933 }
 934
 935 fn make_signature(decl: &ast::FnDecl, generics: &ast::Generics) -> String {
 936     let mut sig = "fn ".to_owned();
 937     if !generics.params.is_empty() {
 938         sig.push('<');
 939         sig.push_str(&generics
 940             .params
 941             .iter()
 942             .map(|param| param.ident.to_string())
 943             .collect::<Vec<_>>()
 944             .join(", "));
 945         sig.push_str("> ");
 946     }
 947     sig.push('(');
 948     sig.push_str(&decl.inputs
 949         .iter()
 950         .map(arg_to_string)
 951         .collect::<Vec<_>>()
 952         .join(", "));
 953     sig.push(')');
 954     match decl.output {
 955         ast::FunctionRetTy::Default(_) => sig.push_str(" -> ()"),
 956         ast::FunctionRetTy::Ty(ref t) => sig.push_str(&format!(" -> {}", ty_to_string(t))),
 957     }
 958
 959     sig
 960 }
 961
 962 // An AST visitor for collecting paths (e.g., the names of structs) and formal
 963 // variables (idents) from patterns.
 964 struct PathCollector<'l> {
 965     collected_paths: Vec<(NodeId, &'l ast::Path)>,
 966     collected_idents: Vec<(NodeId, ast::Ident, ast::Mutability)>,
 967 }
 968
 969 impl<'l> PathCollector<'l> {
 970     fn new() -> PathCollector<'l> {
 971         PathCollector {
 972             collected_paths: vec![],
 973             collected_idents: vec![],
 974         }
 975     }
 976 }
 977
 978 impl<'l, 'a: 'l> Visitor<'a> for PathCollector<'l> {
 979     fn visit_pat(&mut self, p: &'a ast::Pat) {
 980         match p.node {
 981             PatKind::Struct(ref path, ..) => {
 982                 self.collected_paths.push((p.id, path));
 983             }
 984             PatKind::TupleStruct(ref path, ..) | PatKind::Path(_, ref path) => {
 985                 self.collected_paths.push((p.id, path));
 986             }
 987             PatKind::Ident(bm, ident, _) => {
 988                 debug!(
 989                     "PathCollector, visit ident in pat {}: {:?} {:?}",
 990                     ident,
 991                     p.span,
 992                     ident.span
 993                 );
 994                 let immut = match bm {
 995                     // Even if the ref is mut, you can't change the ref, only
 996                     // the data pointed at, so showing the initialising expression
 997                     // is still worthwhile.
 998                     ast::BindingMode::ByRef(_) => ast::Mutability::Immutable,
 999                     ast::BindingMode::ByValue(mt) => mt,
1000                 };
1001                 self.collected_idents
1002                     .push((p.id, ident, immut));
1003             }
1004             _ => {}
1005         }
1006         visit::walk_pat(self, p);
1007     }
1008 }
1009
1010 /// Defines what to do with the results of saving the analysis.
1011 pub trait SaveHandler {
1012     fn save<'l, 'tcx>(
1013         &mut self,
1014         save_ctxt: SaveContext<'l, 'tcx>,
1015         krate: &ast::Crate,
1016         cratename: &str,
1017     );
1018 }
1019
1020 /// Dump the save-analysis results to a file.
1021 pub struct DumpHandler<'a> {
1022     odir: Option<&'a Path>,
1023     cratename: String,
1024 }
1025
1026 impl<'a> DumpHandler<'a> {
1027     pub fn new(odir: Option<&'a Path>, cratename: &str) -> DumpHandler<'a> {
1028         DumpHandler {
1029             odir,
1030             cratename: cratename.to_owned(),
1031         }
1032     }
1033
1034     fn output_file(&self, ctx: &SaveContext) -> File {
1035         let sess = &ctx.tcx.sess;
1036         let file_name = match ctx.config.output_file {
1037             Some(ref s) => PathBuf::from(s),
1038             None => {
1039                 let mut root_path = match self.odir {
1040                     Some(val) => val.join("save-analysis"),
1041                     None => PathBuf::from("save-analysis-temp"),
1042                 };
1043
1044                 if let Err(e) = std::fs::create_dir_all(&root_path) {
1045                     error!("Could not create directory {}: {}", root_path.display(), e);
1046                 }
1047
1048                 let executable = sess.crate_types
1049                     .borrow()
1050                     .iter()
1051                     .any(|ct| *ct == CrateType::Executable);
1052                 let mut out_name = if executable {
1053                     "".to_owned()
1054                 } else {
1055                     "lib".to_owned()
1056                 };
1057                 out_name.push_str(&self.cratename);
1058                 out_name.push_str(&sess.opts.cg.extra_filename);
1059                 out_name.push_str(".json");
1060                 root_path.push(&out_name);
1061
1062                 root_path
1063             }
1064         };
1065
1066         info!("Writing output to {}", file_name.display());
1067
1068         let output_file = File::create(&file_name).unwrap_or_else(
1069             |e| sess.fatal(&format!("Could not open {}: {}", file_name.display(), e)),
1070         );
1071
1072         output_file
1073     }
1074 }
1075
1076 impl<'a> SaveHandler for DumpHandler<'a> {
1077     fn save<'l, 'tcx>(
1078         &mut self,
1079         save_ctxt: SaveContext<'l, 'tcx>,
1080         krate: &ast::Crate,
1081         cratename: &str,
1082     ) {
1083         let output = &mut self.output_file(&save_ctxt);
1084         let mut dumper = JsonDumper::new(output, save_ctxt.config.clone());
1085         let mut visitor = DumpVisitor::new(save_ctxt, &mut dumper);
1086
1087         visitor.dump_crate_info(cratename, krate);
1088         visit::walk_crate(&mut visitor, krate);
1089     }
1090 }
1091
1092 /// Call a callback with the results of save-analysis.
1093 pub struct CallbackHandler<'b> {
1094     pub callback: &'b mut dyn FnMut(&rls_data::Analysis),
1095 }
1096
1097 impl<'b> SaveHandler for CallbackHandler<'b> {
1098     fn save<'l, 'tcx>(
1099         &mut self,
1100         save_ctxt: SaveContext<'l, 'tcx>,
1101         krate: &ast::Crate,
1102         cratename: &str,
1103     ) {
1104         // We're using the JsonDumper here because it has the format of the
1105         // save-analysis results that we will pass to the callback. IOW, we are
1106         // using the JsonDumper to collect the save-analysis results, but not
1107         // actually to dump them to a file. This is all a bit convoluted and
1108         // there is certainly a simpler design here trying to get out (FIXME).
1109         let mut dumper = JsonDumper::with_callback(self.callback, save_ctxt.config.clone());
1110         let mut visitor = DumpVisitor::new(save_ctxt, &mut dumper);
1111
1112         visitor.dump_crate_info(cratename, krate);
1113         visit::walk_crate(&mut visitor, krate);
1114     }
1115 }
1116
1117 pub fn process_crate<'l, 'tcx, H: SaveHandler>(
1118     tcx: TyCtxt<'l, 'tcx, 'tcx>,
1119     krate: &ast::Crate,
1120     analysis: &'l ty::CrateAnalysis,
1121     cratename: &str,
1122     config: Option<Config>,
1123     mut handler: H,
1124 ) {
1125     tcx.dep_graph.with_ignore(|| {
1126         assert!(analysis.glob_map.is_some());
1127
1128         info!("Dumping crate {}", cratename);
1129
1130         let save_ctxt = SaveContext {
1131             tcx,
1132             tables: &ty::TypeckTables::empty(None),
1133             analysis,
1134             span_utils: SpanUtils::new(&tcx.sess),
1135             config: find_config(config),
1136             impl_counter: Cell::new(0),
1137         };
1138
1139         handler.save(save_ctxt, krate, cratename)
1140     })
1141 }
1142
1143 fn find_config(supplied: Option<Config>) -> Config {
1144     if let Some(config) = supplied {
1145         return config;
1146     }
1147     match env::var_os("RUST_SAVE_ANALYSIS_CONFIG") {
1148         Some(config_string) => rustc_serialize::json::decode(config_string.to_str().unwrap())
1149             .expect("Could not deserialize save-analysis config"),
1150         None => Config::default(),
1151     }
1152 }
1153
1154 // Utility functions for the module.
1155
1156 // Helper function to escape quotes in a string
1157 fn escape(s: String) -> String {
1158     s.replace("\"", "\"\"")
1159 }
1160
1161 // Helper function to determine if a span came from a
1162 // macro expansion or syntax extension.
1163 fn generated_code(span: Span) -> bool {
1164     span.ctxt() != NO_EXPANSION || span.is_dummy()
1165 }
1166
1167 // DefId::index is a newtype and so the JSON serialisation is ugly. Therefore
1168 // we use our own Id which is the same, but without the newtype.
1169 fn id_from_def_id(id: DefId) -> rls_data::Id {
1170     rls_data::Id {
1171         krate: id.krate.as_u32(),
1172         index: id.index.as_raw_u32(),
1173     }
1174 }
1175
1176 fn id_from_node_id(id: NodeId, scx: &SaveContext) -> rls_data::Id {
1177     let def_id = scx.tcx.hir.opt_local_def_id(id);
1178     def_id.map(|id| id_from_def_id(id)).unwrap_or_else(|| {
1179         // Create a *fake* `DefId` out of a `NodeId` by subtracting the `NodeId`
1180         // out of the maximum u32 value. This will work unless you have *billions*
1181         // of definitions in a single crate (very unlikely to actually happen).
1182         rls_data::Id {
1183             krate: LOCAL_CRATE.as_u32(),
1184             index: !id.as_u32(),
1185         }
1186     })
1187 }
1188
1189 fn null_id() -> rls_data::Id {
1190     rls_data::Id {
1191         krate: u32::max_value(),
1192         index: u32::max_value(),
1193     }
1194 }
1195
1196 fn lower_attributes(attrs: Vec<Attribute>, scx: &SaveContext) -> Vec<rls_data::Attribute> {
1197     attrs.into_iter()
1198     // Only retain real attributes. Doc comments are lowered separately.
1199     .filter(|attr| attr.path != "doc")
1200     .map(|mut attr| {
1201         // Remove the surrounding '#[..]' or '#![..]' of the pretty printed
1202         // attribute. First normalize all inner attribute (#![..]) to outer
1203         // ones (#[..]), then remove the two leading and the one trailing character.
1204         attr.style = ast::AttrStyle::Outer;
1205         let value = pprust::attribute_to_string(&attr);
1206         // This str slicing works correctly, because the leading and trailing characters
1207         // are in the ASCII range and thus exactly one byte each.
1208         let value = value[2..value.len()-1].to_string();
1209
1210         rls_data::Attribute {
1211             value,
1212             span: scx.span_from_span(attr.span),
1213         }
1214     }).collect()
1215 }