src/librustc_save_analysis/lib.rs

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