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