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),
179 pub fn get_item_data(&self, item: &ast::Item) -> Option<Data> {
181 ast::ItemKind::Fn(ref decl, .., ref generics, _) => {
182 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
183 let sub_span = self.span_utils.sub_span_after_keyword(item.span, keywords::Fn);
184 filter!(self.span_utils, sub_span, item.span, None);
185 Some(Data::DefData(Def {
186 kind: DefKind::Function,
187 id: id_from_node_id(item.id, self),
188 span: self.span_from_span(sub_span.unwrap()),
189 name: item.ident.to_string(),
191 value: make_signature(decl, generics),
195 docs: self.docs_for_attrs(&item.attrs),
196 sig: sig::item_signature(item, self),
197 attributes: lower_attributes(item.attrs.clone(), self),
200 ast::ItemKind::Static(ref typ, mt, _) => {
201 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
203 let keyword = match mt {
204 ast::Mutability::Mutable => keywords::Mut,
205 ast::Mutability::Immutable => keywords::Static,
208 let sub_span = self.span_utils.sub_span_after_keyword(item.span, keyword);
209 filter!(self.span_utils, sub_span, item.span, None);
211 let id = id_from_node_id(item.id, self);
212 let span = self.span_from_span(sub_span.unwrap());
214 Some(Data::DefData(Def {
215 kind: DefKind::Static,
218 name: item.ident.to_string(),
220 value: ty_to_string(&typ),
224 docs: self.docs_for_attrs(&item.attrs),
225 sig: sig::item_signature(item, self),
226 attributes: lower_attributes(item.attrs.clone(), self),
229 ast::ItemKind::Const(ref typ, _) => {
230 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
231 let sub_span = self.span_utils.sub_span_after_keyword(item.span, keywords::Const);
232 filter!(self.span_utils, sub_span, item.span, None);
234 let id = id_from_node_id(item.id, self);
235 let span = self.span_from_span(sub_span.unwrap());
237 Some(Data::DefData(Def {
238 kind: DefKind::Const,
241 name: item.ident.to_string(),
243 value: ty_to_string(typ),
247 docs: self.docs_for_attrs(&item.attrs),
248 sig: sig::item_signature(item, self),
249 attributes: lower_attributes(item.attrs.clone(), self),
252 ast::ItemKind::Mod(ref m) => {
253 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
255 let cm = self.tcx.sess.codemap();
256 let filename = cm.span_to_filename(m.inner);
258 let sub_span = self.span_utils.sub_span_after_keyword(item.span, keywords::Mod);
259 filter!(self.span_utils, sub_span, item.span, None);
261 Some(Data::DefData(Def {
263 id: id_from_node_id(item.id, self),
264 name: item.ident.to_string(),
266 span: self.span_from_span(sub_span.unwrap()),
269 children: m.items.iter().map(|i| id_from_node_id(i.id, self)).collect(),
271 docs: self.docs_for_attrs(&item.attrs),
272 sig: sig::item_signature(item, self),
273 attributes: lower_attributes(item.attrs.clone(), self),
276 ast::ItemKind::Enum(ref def, _) => {
277 let name = item.ident.to_string();
278 let qualname = format!("::{}", self.tcx.node_path_str(item.id));
279 let sub_span = self.span_utils.sub_span_after_keyword(item.span, keywords::Enum);
280 filter!(self.span_utils, sub_span, item.span, None);
281 let variants_str = def.variants.iter()
282 .map(|v| v.node.name.to_string())
285 let value = format!("{}::{{{}}}", name, variants_str);
286 Some(Data::DefData(Def {
288 id: id_from_node_id(item.id, self),
289 span: self.span_from_span(sub_span.unwrap()),
294 children: def.variants
296 .map(|v| id_from_node_id(v.node.data.id(), self))
299 docs: self.docs_for_attrs(&item.attrs),
300 sig: sig::item_signature(item, self),
301 attributes: lower_attributes(item.attrs.to_owned(), self),
304 ast::ItemKind::Impl(.., ref trait_ref, ref typ, _) => {
305 if let ast::TyKind::Path(None, ref path) = typ.node {
306 // Common case impl for a struct or something basic.
307 if generated_code(path.span) {
310 let sub_span = self.span_utils.sub_span_for_type_name(path.span);
311 filter!(self.span_utils, sub_span, typ.span, None);
313 let type_data = self.lookup_ref_id(typ.id);
314 type_data.map(|type_data| Data::RelationData(Relation {
315 kind: RelationKind::Impl,
316 span: self.span_from_span(sub_span.unwrap()),
317 from: id_from_def_id(type_data),
318 to: trait_ref.as_ref()
319 .and_then(|t| self.lookup_ref_id(t.ref_id))
321 .unwrap_or(null_id()),
334 pub fn get_field_data(&self,
335 field: &ast::StructField,
338 if let Some(ident) = field.ident {
339 let name = ident.to_string();
340 let qualname = format!("::{}::{}", self.tcx.node_path_str(scope), ident);
341 let sub_span = self.span_utils.sub_span_before_token(field.span, token::Colon);
342 filter!(self.span_utils, sub_span, field.span, None);
343 let def_id = self.tcx.hir.local_def_id(field.id);
344 let typ = self.tcx.type_of(def_id).to_string();
347 let id = id_from_node_id(field.id, self);
348 let span = self.span_from_span(sub_span.unwrap());
351 kind: DefKind::Field,
357 parent: Some(id_from_node_id(scope, self)),
360 docs: self.docs_for_attrs(&field.attrs),
361 sig: sig::field_signature(field, self),
362 attributes: lower_attributes(field.attrs.clone(), self),
369 // FIXME would be nice to take a MethodItem here, but the ast provides both
370 // trait and impl flavours, so the caller must do the disassembly.
371 pub fn get_method_data(&self,
376 // The qualname for a method is the trait name or name of the struct in an impl in
377 // which the method is declared in, followed by the method's name.
378 let (qualname, parent_scope, decl_id, docs, attributes) =
379 match self.tcx.impl_of_method(self.tcx.hir.local_def_id(id)) {
380 Some(impl_id) => match self.tcx.hir.get_if_local(impl_id) {
381 Some(Node::NodeItem(item)) => {
383 hir::ItemImpl(.., ref ty, _) => {
384 let mut result = String::from("<");
385 result.push_str(&self.tcx.hir.node_to_pretty_string(ty.id));
387 let mut trait_id = self.tcx.trait_id_of_impl(impl_id);
388 let mut decl_id = None;
389 if let Some(def_id) = trait_id {
390 result.push_str(" as ");
391 result.push_str(&self.tcx.item_path_str(def_id));
392 self.tcx.associated_items(def_id)
393 .find(|item| item.name == name)
394 .map(|item| decl_id = Some(item.def_id));
396 if let Some(NodeItem(item)) = self.tcx.hir.find(id) {
397 if let hir::ItemImpl(_, _, _, _, _, ref ty, _) = item.node {
398 trait_id = self.lookup_ref_id(ty.id);
402 result.push_str(">");
404 (result, trait_id, decl_id,
405 self.docs_for_attrs(&item.attrs),
410 "Container {:?} for method {} not an impl?",
418 "Container {:?} for method {} is not a node item {:?}",
424 None => match self.tcx.trait_of_item(self.tcx.hir.local_def_id(id)) {
426 match self.tcx.hir.get_if_local(def_id) {
427 Some(Node::NodeItem(item)) => {
428 (format!("::{}", self.tcx.item_path_str(def_id)),
430 self.docs_for_attrs(&item.attrs),
435 "Could not find container {:?} for \
436 method {}, got {:?}",
444 debug!("Could not find container for method {} at {:?}", id, span);
445 // This is not necessarily a bug, if there was a compilation error, the tables
446 // we need might not exist.
452 let qualname = format!("{}::{}", qualname, name);
454 let sub_span = self.span_utils.sub_span_after_keyword(span, keywords::Fn);
455 filter!(self.span_utils, sub_span, span, None);
458 kind: DefKind::Method,
459 id: id_from_node_id(id, self),
460 span: self.span_from_span(sub_span.unwrap()),
461 name: name.to_string(),
463 // FIXME you get better data here by using the visitor.
464 value: String::new(),
465 parent: parent_scope.map(|id| id_from_def_id(id)),
467 decl_id: decl_id.map(|id| id_from_def_id(id)),
470 attributes: lower_attributes(attributes, self),
474 pub fn get_trait_ref_data(&self,
475 trait_ref: &ast::TraitRef)
477 self.lookup_ref_id(trait_ref.ref_id).and_then(|def_id| {
478 let span = trait_ref.path.span;
479 if generated_code(span) {
482 let sub_span = self.span_utils.sub_span_for_type_name(span).or(Some(span));
483 filter!(self.span_utils, sub_span, span, None);
484 let span = self.span_from_span(sub_span.unwrap());
488 ref_id: id_from_def_id(def_id),
493 pub fn get_expr_data(&self, expr: &ast::Expr) -> Option<Data> {
494 let hir_node = self.tcx.hir.expect_expr(expr.id);
495 let ty = self.tables.expr_ty_adjusted_opt(&hir_node);
496 if ty.is_none() || ty.unwrap().sty == ty::TyError {
500 ast::ExprKind::Field(ref sub_ex, ident) => {
501 let hir_node = match self.tcx.hir.find(sub_ex.id) {
502 Some(Node::NodeExpr(expr)) => expr,
504 debug!("Missing or weird node for sub-expression {} in {:?}",
509 match self.tables.expr_ty_adjusted(&hir_node).sty {
510 ty::TyAdt(def, _) if !def.is_enum() => {
511 let f = def.struct_variant().field_named(ident.node.name);
512 let sub_span = self.span_utils.span_for_last_ident(expr.span);
513 filter!(self.span_utils, sub_span, expr.span, None);
514 let span = self.span_from_span(sub_span.unwrap());
515 return Some(Data::RefData(Ref {
516 kind: RefKind::Variable,
518 ref_id: id_from_def_id(f.did),
522 debug!("Expected struct or union type, found {:?}", ty);
527 ast::ExprKind::Struct(ref path, ..) => {
528 match self.tables.expr_ty_adjusted(&hir_node).sty {
529 ty::TyAdt(def, _) if !def.is_enum() => {
530 let sub_span = self.span_utils.span_for_last_ident(path.span);
531 filter!(self.span_utils, sub_span, path.span, None);
532 let span = self.span_from_span(sub_span.unwrap());
533 Some(Data::RefData(Ref {
536 ref_id: id_from_def_id(def.did),
540 // FIXME ty could legitimately be an enum, but then we will fail
541 // later if we try to look up the fields.
542 debug!("expected struct or union, found {:?}", ty);
547 ast::ExprKind::MethodCall(..) => {
548 let expr_hir_id = self.tcx.hir.definitions().node_to_hir_id(expr.id);
549 let method_id = self.tables.type_dependent_defs()[expr_hir_id].def_id();
550 let (def_id, decl_id) = match self.tcx.associated_item(method_id).container {
551 ty::ImplContainer(_) => (Some(method_id), None),
552 ty::TraitContainer(_) => (None, Some(method_id)),
554 let sub_span = self.span_utils.sub_span_for_meth_name(expr.span);
555 filter!(self.span_utils, sub_span, expr.span, None);
556 let span = self.span_from_span(sub_span.unwrap());
557 Some(Data::RefData(Ref {
558 kind: RefKind::Function,
560 ref_id: def_id.or(decl_id).map(|id| id_from_def_id(id)).unwrap_or(null_id()),
563 ast::ExprKind::Path(_, ref path) => {
564 self.get_path_data(expr.id, path).map(|d| Data::RefData(d))
573 pub fn get_path_def(&self, id: NodeId) -> HirDef {
574 match self.tcx.hir.get(id) {
575 Node::NodeTraitRef(tr) => tr.path.def,
577 Node::NodeItem(&hir::Item { node: hir::ItemUse(ref path, _), .. }) |
578 Node::NodeVisibility(&hir::Visibility::Restricted { ref path, .. }) => path.def,
580 Node::NodeExpr(&hir::Expr { node: hir::ExprPath(ref qpath), .. }) |
581 Node::NodeExpr(&hir::Expr { node: hir::ExprStruct(ref qpath, ..), .. }) |
582 Node::NodePat(&hir::Pat { node: hir::PatKind::Path(ref qpath), .. }) |
583 Node::NodePat(&hir::Pat { node: hir::PatKind::Struct(ref qpath, ..), .. }) |
584 Node::NodePat(&hir::Pat { node: hir::PatKind::TupleStruct(ref qpath, ..), .. }) => {
585 let hir_id = self.tcx.hir.node_to_hir_id(id);
586 self.tables.qpath_def(qpath, hir_id)
589 Node::NodeBinding(&hir::Pat {
590 node: hir::PatKind::Binding(_, canonical_id, ..), ..
591 }) => HirDef::Local(canonical_id),
593 Node::NodeTy(ty) => {
594 if let hir::Ty { node: hir::TyPath(ref qpath), .. } = *ty {
596 hir::QPath::Resolved(_, ref path) => path.def,
597 hir::QPath::TypeRelative(..) => {
598 let ty = hir_ty_to_ty(self.tcx, ty);
599 if let ty::TyProjection(proj) = ty.sty {
600 return HirDef::AssociatedTy(proj.item_def_id);
614 pub fn get_path_data(&self, id: NodeId, path: &ast::Path) -> Option<Ref> {
615 let def = self.get_path_def(id);
616 let sub_span = self.span_utils.span_for_last_ident(path.span);
617 filter!(self.span_utils, sub_span, path.span, None);
619 HirDef::Upvar(id, ..) |
620 HirDef::Local(id) => {
621 let span = self.span_from_span(sub_span.unwrap());
623 kind: RefKind::Variable,
625 ref_id: id_from_node_id(id, self),
630 HirDef::AssociatedConst(..) |
631 HirDef::StructCtor(..) |
632 HirDef::VariantCtor(..) => {
633 let span = self.span_from_span(sub_span.unwrap());
635 kind: RefKind::Variable,
637 ref_id: id_from_def_id(def.def_id()),
640 HirDef::Struct(def_id) |
641 HirDef::Variant(def_id, ..) |
642 HirDef::Union(def_id) |
643 HirDef::Enum(def_id) |
644 HirDef::TyAlias(def_id) |
645 HirDef::AssociatedTy(def_id) |
646 HirDef::Trait(def_id) |
647 HirDef::TyParam(def_id) => {
648 let span = self.span_from_span(sub_span.unwrap());
652 ref_id: id_from_def_id(def_id),
655 HirDef::Method(decl_id) => {
656 let sub_span = self.span_utils.sub_span_for_meth_name(path.span);
657 filter!(self.span_utils, sub_span, path.span, None);
658 let def_id = if decl_id.is_local() {
659 let ti = self.tcx.associated_item(decl_id);
660 self.tcx.associated_items(ti.container.id())
661 .find(|item| item.name == ti.name && item.defaultness.has_value())
662 .map(|item| item.def_id)
666 let span = self.span_from_span(sub_span.unwrap());
668 kind: RefKind::Function,
670 ref_id: id_from_def_id(def_id.unwrap_or(decl_id)),
673 HirDef::Fn(def_id) => {
674 let span = self.span_from_span(sub_span.unwrap());
676 kind: RefKind::Function,
678 ref_id: id_from_def_id(def_id),
681 HirDef::Mod(def_id) => {
682 let span = self.span_from_span(sub_span.unwrap());
686 ref_id: id_from_def_id(def_id),
693 HirDef::GlobalAsm(..) |
698 pub fn get_field_ref_data(&self,
699 field_ref: &ast::Field,
700 variant: &ty::VariantDef)
702 let f = variant.field_named(field_ref.ident.node.name);
703 // We don't really need a sub-span here, but no harm done
704 let sub_span = self.span_utils.span_for_last_ident(field_ref.ident.span);
705 filter!(self.span_utils, sub_span, field_ref.ident.span, None);
706 let span = self.span_from_span(sub_span.unwrap());
708 kind: RefKind::Variable,
710 ref_id: id_from_def_id(f.did),
714 /// Attempt to return MacroRef for any AST node.
716 /// For a given piece of AST defined by the supplied Span and NodeId,
717 /// returns None if the node is not macro-generated or the span is malformed,
718 /// else uses the expansion callsite and callee to return some MacroRef.
719 pub fn get_macro_use_data(&self, span: Span) -> Option<MacroRef> {
720 if !generated_code(span) {
723 // Note we take care to use the source callsite/callee, to handle
724 // nested expansions and ensure we only generate data for source-visible
726 let callsite = span.source_callsite();
727 let callsite_span = self.span_from_span(callsite);
728 let callee = option_try!(span.source_callee());
729 let callee_span = option_try!(callee.span);
731 // Ignore attribute macros, their spans are usually mangled
732 if let MacroAttribute(_) = callee.format {
736 // If the callee is an imported macro from an external crate, need to get
737 // the source span and name from the session, as their spans are localized
738 // when read in, and no longer correspond to the source.
739 if let Some(mac) = self.tcx.sess.imported_macro_spans.borrow().get(&callee_span) {
740 let &(ref mac_name, mac_span) = mac;
741 let mac_span = self.span_from_span(mac_span);
742 return Some(MacroRef {
744 qualname: mac_name.clone(), // FIXME: generate the real qualname
745 callee_span: mac_span,
749 let callee_span = self.span_from_span(callee_span);
752 qualname: callee.name().to_string(), // FIXME: generate the real qualname
757 fn lookup_ref_id(&self, ref_id: NodeId) -> Option<DefId> {
758 match self.get_path_def(ref_id) {
759 HirDef::PrimTy(_) | HirDef::SelfTy(..) | HirDef::Err => None,
760 def => Some(def.def_id()),
764 fn docs_for_attrs(&self, attrs: &[Attribute]) -> String {
765 let mut result = String::new();
768 if attr.check_name("doc") {
769 if let Some(val) = attr.value_str() {
770 if attr.is_sugared_doc {
771 result.push_str(&strip_doc_comment_decoration(&val.as_str()));
773 result.push_str(&val.as_str());
780 if !self.config.full_docs {
781 if let Some(index) = result.find("\n\n") {
782 result.truncate(index);
790 fn make_signature(decl: &ast::FnDecl, generics: &ast::Generics) -> String {
791 let mut sig = "fn ".to_owned();
792 if !generics.lifetimes.is_empty() || !generics.ty_params.is_empty() {
794 sig.push_str(&generics.lifetimes.iter()
795 .map(|l| l.lifetime.ident.name.to_string())
798 if !generics.lifetimes.is_empty() {
801 sig.push_str(&generics.ty_params.iter()
802 .map(|l| l.ident.to_string())
808 sig.push_str(&decl.inputs.iter().map(arg_to_string).collect::<Vec<_>>().join(", "));
811 ast::FunctionRetTy::Default(_) => sig.push_str(" -> ()"),
812 ast::FunctionRetTy::Ty(ref t) => sig.push_str(&format!(" -> {}", ty_to_string(t))),
818 // An AST visitor for collecting paths from patterns.
819 struct PathCollector {
820 // The Row field identifies the kind of pattern.
821 collected_paths: Vec<(NodeId, ast::Path, ast::Mutability)>,
825 fn new() -> PathCollector {
826 PathCollector { collected_paths: vec![] }
830 impl<'a> Visitor<'a> for PathCollector {
831 fn visit_pat(&mut self, p: &ast::Pat) {
833 PatKind::Struct(ref path, ..) => {
834 self.collected_paths.push((p.id, path.clone(),
835 ast::Mutability::Mutable));
837 PatKind::TupleStruct(ref path, ..) |
838 PatKind::Path(_, ref path) => {
839 self.collected_paths.push((p.id, path.clone(),
840 ast::Mutability::Mutable));
842 PatKind::Ident(bm, ref path1, _) => {
843 debug!("PathCollector, visit ident in pat {}: {:?} {:?}",
847 let immut = match bm {
848 // Even if the ref is mut, you can't change the ref, only
849 // the data pointed at, so showing the initialising expression
850 // is still worthwhile.
851 ast::BindingMode::ByRef(_) => ast::Mutability::Immutable,
852 ast::BindingMode::ByValue(mt) => mt,
854 // collect path for either visit_local or visit_arm
855 let path = ast::Path::from_ident(path1.span, path1.node);
856 self.collected_paths.push((p.id, path, immut));
860 visit::walk_pat(self, p);
864 /// Defines what to do with the results of saving the analysis.
865 pub trait SaveHandler {
866 fn save<'l, 'tcx>(&mut self,
867 save_ctxt: SaveContext<'l, 'tcx>,
872 /// Dump the save-analysis results to a file.
873 pub struct DumpHandler<'a> {
874 odir: Option<&'a Path>,
878 impl<'a> DumpHandler<'a> {
879 pub fn new(odir: Option<&'a Path>, cratename: &str) -> DumpHandler<'a> {
882 cratename: cratename.to_owned()
886 fn output_file(&self, ctx: &SaveContext) -> File {
887 let sess = &ctx.tcx.sess;
888 let file_name = match ctx.config.output_file {
889 Some(ref s) => PathBuf::from(s),
891 let mut root_path = match self.odir {
892 Some(val) => val.join("save-analysis"),
893 None => PathBuf::from("save-analysis-temp"),
896 if let Err(e) = std::fs::create_dir_all(&root_path) {
897 error!("Could not create directory {}: {}", root_path.display(), e);
901 sess.crate_types.borrow().iter().any(|ct| *ct == CrateTypeExecutable);
902 let mut out_name = if executable {
907 out_name.push_str(&self.cratename);
908 out_name.push_str(&sess.opts.cg.extra_filename);
909 out_name.push_str(".json");
910 root_path.push(&out_name);
916 info!("Writing output to {}", file_name.display());
918 let output_file = File::create(&file_name).unwrap_or_else(|e| {
919 sess.fatal(&format!("Could not open {}: {}", file_name.display(), e))
926 impl<'a> SaveHandler for DumpHandler<'a> {
927 fn save<'l, 'tcx>(&mut self,
928 save_ctxt: SaveContext<'l, 'tcx>,
931 let output = &mut self.output_file(&save_ctxt);
932 let mut dumper = JsonDumper::new(output, save_ctxt.config.clone());
933 let mut visitor = DumpVisitor::new(save_ctxt, &mut dumper);
935 visitor.dump_crate_info(cratename, krate);
936 visit::walk_crate(&mut visitor, krate);
940 /// Call a callback with the results of save-analysis.
941 pub struct CallbackHandler<'b> {
942 pub callback: &'b mut FnMut(&rls_data::Analysis),
945 impl<'b> SaveHandler for CallbackHandler<'b> {
946 fn save<'l, 'tcx>(&mut self,
947 save_ctxt: SaveContext<'l, 'tcx>,
950 // We're using the JsonDumper here because it has the format of the
951 // save-analysis results that we will pass to the callback. IOW, we are
952 // using the JsonDumper to collect the save-analysis results, but not
953 // actually to dump them to a file. This is all a bit convoluted and
954 // there is certainly a simpler design here trying to get out (FIXME).
955 let mut dumper = JsonDumper::with_callback(self.callback, save_ctxt.config.clone());
956 let mut visitor = DumpVisitor::new(save_ctxt, &mut dumper);
958 visitor.dump_crate_info(cratename, krate);
959 visit::walk_crate(&mut visitor, krate);
963 pub fn process_crate<'l, 'tcx, H: SaveHandler>(tcx: TyCtxt<'l, 'tcx, 'tcx>,
965 analysis: &'l ty::CrateAnalysis,
967 config: Option<Config>,
969 let _ignore = tcx.dep_graph.in_ignore();
971 assert!(analysis.glob_map.is_some());
973 info!("Dumping crate {}", cratename);
975 let save_ctxt = SaveContext {
977 tables: &ty::TypeckTables::empty(None),
979 span_utils: SpanUtils::new(&tcx.sess),
980 config: find_config(config),
983 handler.save(save_ctxt, krate, cratename)
986 fn find_config(supplied: Option<Config>) -> Config {
987 if let Some(config) = supplied {
990 match env::var_os("RUST_SAVE_ANALYSIS_CONFIG") {
991 Some(config_string) => {
992 rustc_serialize::json::decode(config_string.to_str().unwrap())
993 .expect("Could not deserialize save-analysis config")
995 None => Config::default(),
999 // Utility functions for the module.
1001 // Helper function to escape quotes in a string
1002 fn escape(s: String) -> String {
1003 s.replace("\"", "\"\"")
1006 // Helper function to determine if a span came from a
1007 // macro expansion or syntax extension.
1008 fn generated_code(span: Span) -> bool {
1009 span.ctxt() != NO_EXPANSION || span == DUMMY_SP
1012 // DefId::index is a newtype and so the JSON serialisation is ugly. Therefore
1013 // we use our own Id which is the same, but without the newtype.
1014 fn id_from_def_id(id: DefId) -> rls_data::Id {
1016 krate: id.krate.as_u32(),
1017 index: id.index.as_u32(),
1021 fn id_from_node_id(id: NodeId, scx: &SaveContext) -> rls_data::Id {
1022 let def_id = scx.tcx.hir.opt_local_def_id(id);
1023 def_id.map(|id| id_from_def_id(id)).unwrap_or_else(|| {
1024 // Create a *fake* `DefId` out of a `NodeId` by subtracting the `NodeId`
1025 // out of the maximum u32 value. This will work unless you have *billions*
1026 // of definitions in a single crate (very unlikely to actually happen).
1028 krate: LOCAL_CRATE.as_u32(),
1029 index: !id.as_u32(),
1034 fn null_id() -> rls_data::Id {
1036 krate: u32::max_value(),
1037 index: u32::max_value(),
1041 fn lower_attributes(attrs: Vec<Attribute>, scx: &SaveContext) -> Vec<rls_data::Attribute> {
1043 // Only retain real attributes. Doc comments are lowered separately.
1044 .filter(|attr| attr.path != "doc")
1046 // Remove the surrounding '#[..]' or '#![..]' of the pretty printed
1047 // attribute. First normalize all inner attribute (#![..]) to outer
1048 // ones (#[..]), then remove the two leading and the one trailing character.
1049 attr.style = ast::AttrStyle::Outer;
1050 let value = pprust::attribute_to_string(&attr);
1051 // This str slicing works correctly, because the leading and trailing characters
1052 // are in the ASCII range and thus exactly one byte each.
1053 let value = value[2..value.len()-1].to_string();
1055 rls_data::Attribute {
1057 span: scx.span_from_span(attr.span),