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.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 #![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/")]
16 #![feature(custom_attribute)]
17 #![allow(unused_attributes)]
19 #[macro_use] extern crate rustc;
21 #[macro_use] extern crate log;
22 #[macro_use] extern crate syntax;
23 extern crate rustc_data_structures;
24 extern crate rustc_serialize;
25 extern crate rustc_typeck;
26 extern crate syntax_pos;
28 extern crate rls_data;
29 extern crate rls_span;
39 use rustc::hir::def::Def as HirDef;
40 use rustc::hir::map::{Node, NodeItem};
41 use rustc::hir::def_id::{LOCAL_CRATE, DefId};
42 use rustc::session::config::CrateType::CrateTypeExecutable;
43 use rustc::ty::{self, TyCtxt};
44 use rustc_typeck::hir_ty_to_ty;
46 use std::default::Default;
49 use std::path::{Path, PathBuf};
51 use syntax::ast::{self, NodeId, PatKind, Attribute};
52 use syntax::parse::lexer::comments::strip_doc_comment_decoration;
53 use syntax::parse::token;
54 use syntax::print::pprust;
55 use syntax::symbol::keywords;
56 use syntax::visit::{self, Visitor};
57 use syntax::print::pprust::{ty_to_string, arg_to_string};
58 use syntax::codemap::MacroAttribute;
61 use json_dumper::JsonDumper;
62 use dump_visitor::DumpVisitor;
63 use span_utils::SpanUtils;
65 use rls_data::{Ref, RefKind, SpanData, MacroRef, Def, DefKind, Relation, RelationKind,
67 use rls_data::config::Config;
70 pub struct SaveContext<'l, 'tcx: 'l> {
71 tcx: TyCtxt<'l, 'tcx, 'tcx>,
72 tables: &'l ty::TypeckTables<'tcx>,
73 analysis: &'l ty::CrateAnalysis,
74 span_utils: SpanUtils<'tcx>,
82 RelationData(Relation),
85 macro_rules! option_try(
86 ($e:expr) => (match $e { Some(e) => e, None => return None })
89 impl<'l, 'tcx: 'l> SaveContext<'l, 'tcx> {
90 fn span_from_span(&self, span: Span) -> SpanData {
91 use rls_span::{Row, Column};
93 let cm = self.tcx.sess.codemap();
94 let start = cm.lookup_char_pos(span.lo());
95 let end = cm.lookup_char_pos(span.hi());
98 file_name: start.file.name.clone().into(),
99 byte_start: span.lo().0,
100 byte_end: span.hi().0,
101 line_start: Row::new_one_indexed(start.line as u32),
102 line_end: Row::new_one_indexed(end.line as u32),
103 column_start: Column::new_one_indexed(start.col.0 as u32 + 1),
104 column_end: Column::new_one_indexed(end.col.0 as u32 + 1),
108 // List external crates used by the current crate.
109 pub fn get_external_crates(&self) -> Vec<ExternalCrateData> {
110 let mut result = Vec::new();
112 for &n in self.tcx.crates().iter() {
113 let span = match *self.tcx.extern_crate(n.as_def_id()) {
114 Some(ref c) => c.span,
116 debug!("Skipping crate {}, no data", n);
120 let lo_loc = self.span_utils.sess.codemap().lookup_char_pos(span.lo());
121 result.push(ExternalCrateData {
122 name: self.tcx.crate_name(n).to_string(),
124 file_name: SpanUtils::make_path_string(&lo_loc.file.name),
131 pub fn get_extern_item_data(&self, item: &ast::ForeignItem) -> Option<Data> {
132 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
134 ast::ForeignItemKind::Fn(ref decl, ref generics) => {
135 let sub_span = self.span_utils.sub_span_after_keyword(item.span, keywords::Fn);
136 filter!(self.span_utils, sub_span, item.span, None);
138 Some(Data::DefData(Def {
139 kind: DefKind::Function,
140 id: id_from_node_id(item.id, self),
141 span: self.span_from_span(sub_span.unwrap()),
142 name: item.ident.to_string(),
144 value: make_signature(decl, generics),
148 docs: self.docs_for_attrs(&item.attrs),
149 sig: sig::foreign_item_signature(item, self),
150 attributes: lower_attributes(item.attrs.clone(), self),
153 ast::ForeignItemKind::Static(ref ty, m) => {
154 let keyword = if m { keywords::Mut } else { keywords::Static };
155 let sub_span = self.span_utils.sub_span_after_keyword(item.span, keyword);
156 filter!(self.span_utils, sub_span, item.span, None);
158 let id = ::id_from_node_id(item.id, self);
159 let span = self.span_from_span(sub_span.unwrap());
161 Some(Data::DefData(Def {
162 kind: DefKind::Static,
165 name: item.ident.to_string(),
167 value: ty_to_string(ty),
171 docs: self.docs_for_attrs(&item.attrs),
172 sig: sig::foreign_item_signature(item, self),
173 attributes: lower_attributes(item.attrs.clone(), self),
176 // FIXME(plietar): needs a new DefKind in rls-data
177 ast::ForeignItemKind::Ty => None,
181 pub fn get_item_data(&self, item: &ast::Item) -> Option<Data> {
183 ast::ItemKind::Fn(ref decl, .., ref generics, _) => {
184 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
185 let sub_span = self.span_utils.sub_span_after_keyword(item.span, keywords::Fn);
186 filter!(self.span_utils, sub_span, item.span, None);
187 Some(Data::DefData(Def {
188 kind: DefKind::Function,
189 id: id_from_node_id(item.id, self),
190 span: self.span_from_span(sub_span.unwrap()),
191 name: item.ident.to_string(),
193 value: make_signature(decl, generics),
197 docs: self.docs_for_attrs(&item.attrs),
198 sig: sig::item_signature(item, self),
199 attributes: lower_attributes(item.attrs.clone(), self),
202 ast::ItemKind::Static(ref typ, mt, _) => {
203 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
205 let keyword = match mt {
206 ast::Mutability::Mutable => keywords::Mut,
207 ast::Mutability::Immutable => keywords::Static,
210 let sub_span = self.span_utils.sub_span_after_keyword(item.span, keyword);
211 filter!(self.span_utils, sub_span, item.span, None);
213 let id = id_from_node_id(item.id, self);
214 let span = self.span_from_span(sub_span.unwrap());
216 Some(Data::DefData(Def {
217 kind: DefKind::Static,
220 name: item.ident.to_string(),
222 value: ty_to_string(&typ),
226 docs: self.docs_for_attrs(&item.attrs),
227 sig: sig::item_signature(item, self),
228 attributes: lower_attributes(item.attrs.clone(), self),
231 ast::ItemKind::Const(ref typ, _) => {
232 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
233 let sub_span = self.span_utils.sub_span_after_keyword(item.span, keywords::Const);
234 filter!(self.span_utils, sub_span, item.span, None);
236 let id = id_from_node_id(item.id, self);
237 let span = self.span_from_span(sub_span.unwrap());
239 Some(Data::DefData(Def {
240 kind: DefKind::Const,
243 name: item.ident.to_string(),
245 value: ty_to_string(typ),
249 docs: self.docs_for_attrs(&item.attrs),
250 sig: sig::item_signature(item, self),
251 attributes: lower_attributes(item.attrs.clone(), self),
254 ast::ItemKind::Mod(ref m) => {
255 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
257 let cm = self.tcx.sess.codemap();
258 let filename = cm.span_to_filename(m.inner);
260 let sub_span = self.span_utils.sub_span_after_keyword(item.span, keywords::Mod);
261 filter!(self.span_utils, sub_span, item.span, None);
263 Some(Data::DefData(Def {
265 id: id_from_node_id(item.id, self),
266 name: item.ident.to_string(),
268 span: self.span_from_span(sub_span.unwrap()),
271 children: m.items.iter().map(|i| id_from_node_id(i.id, self)).collect(),
273 docs: self.docs_for_attrs(&item.attrs),
274 sig: sig::item_signature(item, self),
275 attributes: lower_attributes(item.attrs.clone(), self),
278 ast::ItemKind::Enum(ref def, _) => {
279 let name = item.ident.to_string();
280 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
281 let sub_span = self.span_utils.sub_span_after_keyword(item.span, keywords::Enum);
282 filter!(self.span_utils, sub_span, item.span, None);
283 let variants_str = def.variants.iter()
284 .map(|v| v.node.name.to_string())
287 let value = format!("{}::{{{}}}", name, variants_str);
288 Some(Data::DefData(Def {
290 id: id_from_node_id(item.id, self),
291 span: self.span_from_span(sub_span.unwrap()),
296 children: def.variants
298 .map(|v| id_from_node_id(v.node.data.id(), self))
301 docs: self.docs_for_attrs(&item.attrs),
302 sig: sig::item_signature(item, self),
303 attributes: lower_attributes(item.attrs.to_owned(), self),
306 ast::ItemKind::Impl(.., ref trait_ref, ref typ, _) => {
307 if let ast::TyKind::Path(None, ref path) = typ.node {
308 // Common case impl for a struct or something basic.
309 if generated_code(path.span) {
312 let sub_span = self.span_utils.sub_span_for_type_name(path.span);
313 filter!(self.span_utils, sub_span, typ.span, None);
315 let type_data = self.lookup_ref_id(typ.id);
316 type_data.map(|type_data| Data::RelationData(Relation {
317 kind: RelationKind::Impl,
318 span: self.span_from_span(sub_span.unwrap()),
319 from: id_from_def_id(type_data),
320 to: trait_ref.as_ref()
321 .and_then(|t| self.lookup_ref_id(t.ref_id))
323 .unwrap_or(null_id()),
336 pub fn get_field_data(&self,
337 field: &ast::StructField,
340 if let Some(ident) = field.ident {
341 let name = ident.to_string();
342 let qualname = format!("::{}::{}", self.tcx.node_path_str(scope), ident);
343 let sub_span = self.span_utils.sub_span_before_token(field.span, token::Colon);
344 filter!(self.span_utils, sub_span, field.span, None);
345 let def_id = self.tcx.hir.local_def_id(field.id);
346 let typ = self.tcx.type_of(def_id).to_string();
349 let id = id_from_node_id(field.id, self);
350 let span = self.span_from_span(sub_span.unwrap());
353 kind: DefKind::Field,
359 parent: Some(id_from_node_id(scope, self)),
362 docs: self.docs_for_attrs(&field.attrs),
363 sig: sig::field_signature(field, self),
364 attributes: lower_attributes(field.attrs.clone(), self),
371 // FIXME would be nice to take a MethodItem here, but the ast provides both
372 // trait and impl flavours, so the caller must do the disassembly.
373 pub fn get_method_data(&self,
378 // The qualname for a method is the trait name or name of the struct in an impl in
379 // which the method is declared in, followed by the method's name.
380 let (qualname, parent_scope, decl_id, docs, attributes) =
381 match self.tcx.impl_of_method(self.tcx.hir.local_def_id(id)) {
382 Some(impl_id) => match self.tcx.hir.get_if_local(impl_id) {
383 Some(Node::NodeItem(item)) => {
385 hir::ItemImpl(.., ref ty, _) => {
386 let mut result = String::from("<");
387 result.push_str(&self.tcx.hir.node_to_pretty_string(ty.id));
389 let mut trait_id = self.tcx.trait_id_of_impl(impl_id);
390 let mut decl_id = None;
391 if let Some(def_id) = trait_id {
392 result.push_str(" as ");
393 result.push_str(&self.tcx.item_path_str(def_id));
394 self.tcx.associated_items(def_id)
395 .find(|item| item.name == name)
396 .map(|item| decl_id = Some(item.def_id));
398 if let Some(NodeItem(item)) = self.tcx.hir.find(id) {
399 if let hir::ItemImpl(_, _, _, _, _, ref ty, _) = item.node {
400 trait_id = self.lookup_ref_id(ty.id);
404 result.push_str(">");
406 (result, trait_id, decl_id,
407 self.docs_for_attrs(&item.attrs),
412 "Container {:?} for method {} not an impl?",
420 "Container {:?} for method {} is not a node item {:?}",
426 None => match self.tcx.trait_of_item(self.tcx.hir.local_def_id(id)) {
428 match self.tcx.hir.get_if_local(def_id) {
429 Some(Node::NodeItem(item)) => {
430 (format!("::{}", self.tcx.item_path_str(def_id)),
432 self.docs_for_attrs(&item.attrs),
437 "Could not find container {:?} for \
438 method {}, got {:?}",
446 debug!("Could not find container for method {} at {:?}", id, span);
447 // This is not necessarily a bug, if there was a compilation error, the tables
448 // we need might not exist.
454 let qualname = format!("{}::{}", qualname, name);
456 let sub_span = self.span_utils.sub_span_after_keyword(span, keywords::Fn);
457 filter!(self.span_utils, sub_span, span, None);
460 kind: DefKind::Method,
461 id: id_from_node_id(id, self),
462 span: self.span_from_span(sub_span.unwrap()),
463 name: name.to_string(),
465 // FIXME you get better data here by using the visitor.
466 value: String::new(),
467 parent: parent_scope.map(|id| id_from_def_id(id)),
469 decl_id: decl_id.map(|id| id_from_def_id(id)),
472 attributes: lower_attributes(attributes, self),
476 pub fn get_trait_ref_data(&self,
477 trait_ref: &ast::TraitRef)
479 self.lookup_ref_id(trait_ref.ref_id).and_then(|def_id| {
480 let span = trait_ref.path.span;
481 if generated_code(span) {
484 let sub_span = self.span_utils.sub_span_for_type_name(span).or(Some(span));
485 filter!(self.span_utils, sub_span, span, None);
486 let span = self.span_from_span(sub_span.unwrap());
490 ref_id: id_from_def_id(def_id),
495 pub fn get_expr_data(&self, expr: &ast::Expr) -> Option<Data> {
496 let hir_node = self.tcx.hir.expect_expr(expr.id);
497 let ty = self.tables.expr_ty_adjusted_opt(&hir_node);
498 if ty.is_none() || ty.unwrap().sty == ty::TyError {
502 ast::ExprKind::Field(ref sub_ex, ident) => {
503 let hir_node = match self.tcx.hir.find(sub_ex.id) {
504 Some(Node::NodeExpr(expr)) => expr,
506 debug!("Missing or weird node for sub-expression {} in {:?}",
511 match self.tables.expr_ty_adjusted(&hir_node).sty {
512 ty::TyAdt(def, _) if !def.is_enum() => {
513 let f = def.struct_variant().field_named(ident.node.name);
514 let sub_span = self.span_utils.span_for_last_ident(expr.span);
515 filter!(self.span_utils, sub_span, expr.span, None);
516 let span = self.span_from_span(sub_span.unwrap());
517 return Some(Data::RefData(Ref {
518 kind: RefKind::Variable,
520 ref_id: id_from_def_id(f.did),
524 debug!("Expected struct or union type, found {:?}", ty);
529 ast::ExprKind::Struct(ref path, ..) => {
530 match self.tables.expr_ty_adjusted(&hir_node).sty {
531 ty::TyAdt(def, _) if !def.is_enum() => {
532 let sub_span = self.span_utils.span_for_last_ident(path.span);
533 filter!(self.span_utils, sub_span, path.span, None);
534 let span = self.span_from_span(sub_span.unwrap());
535 Some(Data::RefData(Ref {
538 ref_id: id_from_def_id(def.did),
542 // FIXME ty could legitimately be an enum, but then we will fail
543 // later if we try to look up the fields.
544 debug!("expected struct or union, found {:?}", ty);
549 ast::ExprKind::MethodCall(..) => {
550 let expr_hir_id = self.tcx.hir.definitions().node_to_hir_id(expr.id);
551 let method_id = self.tables.type_dependent_defs()[expr_hir_id].def_id();
552 let (def_id, decl_id) = match self.tcx.associated_item(method_id).container {
553 ty::ImplContainer(_) => (Some(method_id), None),
554 ty::TraitContainer(_) => (None, Some(method_id)),
556 let sub_span = self.span_utils.sub_span_for_meth_name(expr.span);
557 filter!(self.span_utils, sub_span, expr.span, None);
558 let span = self.span_from_span(sub_span.unwrap());
559 Some(Data::RefData(Ref {
560 kind: RefKind::Function,
562 ref_id: def_id.or(decl_id).map(|id| id_from_def_id(id)).unwrap_or(null_id()),
565 ast::ExprKind::Path(_, ref path) => {
566 self.get_path_data(expr.id, path).map(|d| Data::RefData(d))
575 pub fn get_path_def(&self, id: NodeId) -> HirDef {
576 match self.tcx.hir.get(id) {
577 Node::NodeTraitRef(tr) => tr.path.def,
579 Node::NodeItem(&hir::Item { node: hir::ItemUse(ref path, _), .. }) |
580 Node::NodeVisibility(&hir::Visibility::Restricted { ref path, .. }) => path.def,
582 Node::NodeExpr(&hir::Expr { node: hir::ExprPath(ref qpath), .. }) |
583 Node::NodeExpr(&hir::Expr { node: hir::ExprStruct(ref qpath, ..), .. }) |
584 Node::NodePat(&hir::Pat { node: hir::PatKind::Path(ref qpath), .. }) |
585 Node::NodePat(&hir::Pat { node: hir::PatKind::Struct(ref qpath, ..), .. }) |
586 Node::NodePat(&hir::Pat { node: hir::PatKind::TupleStruct(ref qpath, ..), .. }) => {
587 let hir_id = self.tcx.hir.node_to_hir_id(id);
588 self.tables.qpath_def(qpath, hir_id)
591 Node::NodeBinding(&hir::Pat {
592 node: hir::PatKind::Binding(_, canonical_id, ..), ..
593 }) => HirDef::Local(canonical_id),
595 Node::NodeTy(ty) => {
596 if let hir::Ty { node: hir::TyPath(ref qpath), .. } = *ty {
598 hir::QPath::Resolved(_, ref path) => path.def,
599 hir::QPath::TypeRelative(..) => {
600 let ty = hir_ty_to_ty(self.tcx, ty);
601 if let ty::TyProjection(proj) = ty.sty {
602 return HirDef::AssociatedTy(proj.item_def_id);
616 pub fn get_path_data(&self, id: NodeId, path: &ast::Path) -> Option<Ref> {
617 let def = self.get_path_def(id);
618 let sub_span = self.span_utils.span_for_last_ident(path.span);
619 filter!(self.span_utils, sub_span, path.span, None);
621 HirDef::Upvar(id, ..) |
622 HirDef::Local(id) => {
623 let span = self.span_from_span(sub_span.unwrap());
625 kind: RefKind::Variable,
627 ref_id: id_from_node_id(id, self),
632 HirDef::AssociatedConst(..) |
633 HirDef::StructCtor(..) |
634 HirDef::VariantCtor(..) => {
635 let span = self.span_from_span(sub_span.unwrap());
637 kind: RefKind::Variable,
639 ref_id: id_from_def_id(def.def_id()),
642 HirDef::Struct(def_id) |
643 HirDef::Variant(def_id, ..) |
644 HirDef::Union(def_id) |
645 HirDef::Enum(def_id) |
646 HirDef::TyAlias(def_id) |
647 HirDef::TyForeign(def_id) |
648 HirDef::AssociatedTy(def_id) |
649 HirDef::Trait(def_id) |
650 HirDef::TyParam(def_id) => {
651 let span = self.span_from_span(sub_span.unwrap());
655 ref_id: id_from_def_id(def_id),
658 HirDef::Method(decl_id) => {
659 let sub_span = self.span_utils.sub_span_for_meth_name(path.span);
660 filter!(self.span_utils, sub_span, path.span, None);
661 let def_id = if decl_id.is_local() {
662 let ti = self.tcx.associated_item(decl_id);
663 self.tcx.associated_items(ti.container.id())
664 .find(|item| item.name == ti.name && item.defaultness.has_value())
665 .map(|item| item.def_id)
669 let span = self.span_from_span(sub_span.unwrap());
671 kind: RefKind::Function,
673 ref_id: id_from_def_id(def_id.unwrap_or(decl_id)),
676 HirDef::Fn(def_id) => {
677 let span = self.span_from_span(sub_span.unwrap());
679 kind: RefKind::Function,
681 ref_id: id_from_def_id(def_id),
684 HirDef::Mod(def_id) => {
685 let span = self.span_from_span(sub_span.unwrap());
689 ref_id: id_from_def_id(def_id),
696 HirDef::GlobalAsm(..) |
701 pub fn get_field_ref_data(&self,
702 field_ref: &ast::Field,
703 variant: &ty::VariantDef)
705 let f = variant.field_named(field_ref.ident.node.name);
706 // We don't really need a sub-span here, but no harm done
707 let sub_span = self.span_utils.span_for_last_ident(field_ref.ident.span);
708 filter!(self.span_utils, sub_span, field_ref.ident.span, None);
709 let span = self.span_from_span(sub_span.unwrap());
711 kind: RefKind::Variable,
713 ref_id: id_from_def_id(f.did),
717 /// Attempt to return MacroRef for any AST node.
719 /// For a given piece of AST defined by the supplied Span and NodeId,
720 /// returns None if the node is not macro-generated or the span is malformed,
721 /// else uses the expansion callsite and callee to return some MacroRef.
722 pub fn get_macro_use_data(&self, span: Span) -> Option<MacroRef> {
723 if !generated_code(span) {
726 // Note we take care to use the source callsite/callee, to handle
727 // nested expansions and ensure we only generate data for source-visible
729 let callsite = span.source_callsite();
730 let callsite_span = self.span_from_span(callsite);
731 let callee = option_try!(span.source_callee());
732 let callee_span = option_try!(callee.span);
734 // Ignore attribute macros, their spans are usually mangled
735 if let MacroAttribute(_) = callee.format {
739 // If the callee is an imported macro from an external crate, need to get
740 // the source span and name from the session, as their spans are localized
741 // when read in, and no longer correspond to the source.
742 if let Some(mac) = self.tcx.sess.imported_macro_spans.borrow().get(&callee_span) {
743 let &(ref mac_name, mac_span) = mac;
744 let mac_span = self.span_from_span(mac_span);
745 return Some(MacroRef {
747 qualname: mac_name.clone(), // FIXME: generate the real qualname
748 callee_span: mac_span,
752 let callee_span = self.span_from_span(callee_span);
755 qualname: callee.name().to_string(), // FIXME: generate the real qualname
760 fn lookup_ref_id(&self, ref_id: NodeId) -> Option<DefId> {
761 match self.get_path_def(ref_id) {
762 HirDef::PrimTy(_) | HirDef::SelfTy(..) | HirDef::Err => None,
763 def => Some(def.def_id()),
767 fn docs_for_attrs(&self, attrs: &[Attribute]) -> String {
768 let mut result = String::new();
771 if attr.check_name("doc") {
772 if let Some(val) = attr.value_str() {
773 if attr.is_sugared_doc {
774 result.push_str(&strip_doc_comment_decoration(&val.as_str()));
776 result.push_str(&val.as_str());
783 if !self.config.full_docs {
784 if let Some(index) = result.find("\n\n") {
785 result.truncate(index);
793 fn make_signature(decl: &ast::FnDecl, generics: &ast::Generics) -> String {
794 let mut sig = "fn ".to_owned();
795 if !generics.lifetimes.is_empty() || !generics.ty_params.is_empty() {
797 sig.push_str(&generics.lifetimes.iter()
798 .map(|l| l.lifetime.ident.name.to_string())
801 if !generics.lifetimes.is_empty() {
804 sig.push_str(&generics.ty_params.iter()
805 .map(|l| l.ident.to_string())
811 sig.push_str(&decl.inputs.iter().map(arg_to_string).collect::<Vec<_>>().join(", "));
814 ast::FunctionRetTy::Default(_) => sig.push_str(" -> ()"),
815 ast::FunctionRetTy::Ty(ref t) => sig.push_str(&format!(" -> {}", ty_to_string(t))),
821 // An AST visitor for collecting paths from patterns.
822 struct PathCollector {
823 // The Row field identifies the kind of pattern.
824 collected_paths: Vec<(NodeId, ast::Path, ast::Mutability)>,
828 fn new() -> PathCollector {
829 PathCollector { collected_paths: vec![] }
833 impl<'a> Visitor<'a> for PathCollector {
834 fn visit_pat(&mut self, p: &ast::Pat) {
836 PatKind::Struct(ref path, ..) => {
837 self.collected_paths.push((p.id, path.clone(),
838 ast::Mutability::Mutable));
840 PatKind::TupleStruct(ref path, ..) |
841 PatKind::Path(_, ref path) => {
842 self.collected_paths.push((p.id, path.clone(),
843 ast::Mutability::Mutable));
845 PatKind::Ident(bm, ref path1, _) => {
846 debug!("PathCollector, visit ident in pat {}: {:?} {:?}",
850 let immut = match bm {
851 // Even if the ref is mut, you can't change the ref, only
852 // the data pointed at, so showing the initialising expression
853 // is still worthwhile.
854 ast::BindingMode::ByRef(_) => ast::Mutability::Immutable,
855 ast::BindingMode::ByValue(mt) => mt,
857 // collect path for either visit_local or visit_arm
858 let path = ast::Path::from_ident(path1.span, path1.node);
859 self.collected_paths.push((p.id, path, immut));
863 visit::walk_pat(self, p);
867 /// Defines what to do with the results of saving the analysis.
868 pub trait SaveHandler {
869 fn save<'l, 'tcx>(&mut self,
870 save_ctxt: SaveContext<'l, 'tcx>,
875 /// Dump the save-analysis results to a file.
876 pub struct DumpHandler<'a> {
877 odir: Option<&'a Path>,
881 impl<'a> DumpHandler<'a> {
882 pub fn new(odir: Option<&'a Path>, cratename: &str) -> DumpHandler<'a> {
885 cratename: cratename.to_owned()
889 fn output_file(&self, ctx: &SaveContext) -> File {
890 let sess = &ctx.tcx.sess;
891 let file_name = match ctx.config.output_file {
892 Some(ref s) => PathBuf::from(s),
894 let mut root_path = match self.odir {
895 Some(val) => val.join("save-analysis"),
896 None => PathBuf::from("save-analysis-temp"),
899 if let Err(e) = std::fs::create_dir_all(&root_path) {
900 error!("Could not create directory {}: {}", root_path.display(), e);
904 sess.crate_types.borrow().iter().any(|ct| *ct == CrateTypeExecutable);
905 let mut out_name = if executable {
910 out_name.push_str(&self.cratename);
911 out_name.push_str(&sess.opts.cg.extra_filename);
912 out_name.push_str(".json");
913 root_path.push(&out_name);
919 info!("Writing output to {}", file_name.display());
921 let output_file = File::create(&file_name).unwrap_or_else(|e| {
922 sess.fatal(&format!("Could not open {}: {}", file_name.display(), e))
929 impl<'a> SaveHandler for DumpHandler<'a> {
930 fn save<'l, 'tcx>(&mut self,
931 save_ctxt: SaveContext<'l, 'tcx>,
934 let output = &mut self.output_file(&save_ctxt);
935 let mut dumper = JsonDumper::new(output, save_ctxt.config.clone());
936 let mut visitor = DumpVisitor::new(save_ctxt, &mut dumper);
938 visitor.dump_crate_info(cratename, krate);
939 visit::walk_crate(&mut visitor, krate);
943 /// Call a callback with the results of save-analysis.
944 pub struct CallbackHandler<'b> {
945 pub callback: &'b mut FnMut(&rls_data::Analysis),
948 impl<'b> SaveHandler for CallbackHandler<'b> {
949 fn save<'l, 'tcx>(&mut self,
950 save_ctxt: SaveContext<'l, 'tcx>,
953 // We're using the JsonDumper here because it has the format of the
954 // save-analysis results that we will pass to the callback. IOW, we are
955 // using the JsonDumper to collect the save-analysis results, but not
956 // actually to dump them to a file. This is all a bit convoluted and
957 // there is certainly a simpler design here trying to get out (FIXME).
958 let mut dumper = JsonDumper::with_callback(self.callback, save_ctxt.config.clone());
959 let mut visitor = DumpVisitor::new(save_ctxt, &mut dumper);
961 visitor.dump_crate_info(cratename, krate);
962 visit::walk_crate(&mut visitor, krate);
966 pub fn process_crate<'l, 'tcx, H: SaveHandler>(tcx: TyCtxt<'l, 'tcx, 'tcx>,
968 analysis: &'l ty::CrateAnalysis,
970 config: Option<Config>,
972 let _ignore = tcx.dep_graph.in_ignore();
974 assert!(analysis.glob_map.is_some());
976 info!("Dumping crate {}", cratename);
978 let save_ctxt = SaveContext {
980 tables: &ty::TypeckTables::empty(None),
982 span_utils: SpanUtils::new(&tcx.sess),
983 config: find_config(config),
986 handler.save(save_ctxt, krate, cratename)
989 fn find_config(supplied: Option<Config>) -> Config {
990 if let Some(config) = supplied {
993 match env::var_os("RUST_SAVE_ANALYSIS_CONFIG") {
994 Some(config_string) => {
995 rustc_serialize::json::decode(config_string.to_str().unwrap())
996 .expect("Could not deserialize save-analysis config")
998 None => Config::default(),
1002 // Utility functions for the module.
1004 // Helper function to escape quotes in a string
1005 fn escape(s: String) -> String {
1006 s.replace("\"", "\"\"")
1009 // Helper function to determine if a span came from a
1010 // macro expansion or syntax extension.
1011 fn generated_code(span: Span) -> bool {
1012 span.ctxt() != NO_EXPANSION || span == DUMMY_SP
1015 // DefId::index is a newtype and so the JSON serialisation is ugly. Therefore
1016 // we use our own Id which is the same, but without the newtype.
1017 fn id_from_def_id(id: DefId) -> rls_data::Id {
1019 krate: id.krate.as_u32(),
1020 index: id.index.as_u32(),
1024 fn id_from_node_id(id: NodeId, scx: &SaveContext) -> rls_data::Id {
1025 let def_id = scx.tcx.hir.opt_local_def_id(id);
1026 def_id.map(|id| id_from_def_id(id)).unwrap_or_else(|| {
1027 // Create a *fake* `DefId` out of a `NodeId` by subtracting the `NodeId`
1028 // out of the maximum u32 value. This will work unless you have *billions*
1029 // of definitions in a single crate (very unlikely to actually happen).
1031 krate: LOCAL_CRATE.as_u32(),
1032 index: !id.as_u32(),
1037 fn null_id() -> rls_data::Id {
1039 krate: u32::max_value(),
1040 index: u32::max_value(),
1044 fn lower_attributes(attrs: Vec<Attribute>, scx: &SaveContext) -> Vec<rls_data::Attribute> {
1046 // Only retain real attributes. Doc comments are lowered separately.
1047 .filter(|attr| attr.path != "doc")
1049 // Remove the surrounding '#[..]' or '#![..]' of the pretty printed
1050 // attribute. First normalize all inner attribute (#![..]) to outer
1051 // ones (#[..]), then remove the two leading and the one trailing character.
1052 attr.style = ast::AttrStyle::Outer;
1053 let value = pprust::attribute_to_string(&attr);
1054 // This str slicing works correctly, because the leading and trailing characters
1055 // are in the ASCII range and thus exactly one byte each.
1056 let value = value[2..value.len()-1].to_string();
1058 rls_data::Attribute {
1060 span: scx.span_from_span(attr.span),