1 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
3 #![recursion_limit = "256"]
11 use rustc::middle::cstore::ExternCrate;
12 use rustc::middle::privacy::AccessLevels;
13 use rustc::session::config::{CrateType, Input, OutputType};
14 use rustc::ty::{self, DefIdTree, TyCtxt};
15 use rustc::{bug, span_bug};
16 use rustc_ast_pretty::pprust::{self, param_to_string, ty_to_string};
17 use rustc_codegen_utils::link::{filename_for_metadata, out_filename};
19 use rustc_hir::def::{CtorOf, DefKind as HirDefKind, Res};
20 use rustc_hir::def_id::{DefId, LOCAL_CRATE};
22 use rustc_span::source_map::Spanned;
24 use syntax::ast::{self, Attribute, NodeId, PatKind, DUMMY_NODE_ID};
25 use syntax::util::comments::strip_doc_comment_decoration;
26 use syntax::visit::{self, Visitor};
29 use std::default::Default;
32 use std::io::BufWriter;
33 use std::path::{Path, PathBuf};
35 use dump_visitor::DumpVisitor;
36 use span_utils::SpanUtils;
38 use rls_data::config::Config;
40 Analysis, Def, DefKind, ExternalCrateData, GlobalCrateId, Impl, ImplKind, MacroRef, Ref,
41 RefKind, Relation, RelationKind, SpanData,
44 use log::{debug, error, info};
46 pub struct SaveContext<'l, 'tcx> {
48 tables: &'l ty::TypeckTables<'tcx>,
49 /// Used as a fallback when nesting the typeck tables during item processing
50 /// (if these are not available for that item, e.g. don't own a body)
51 empty_tables: &'l ty::TypeckTables<'tcx>,
52 access_levels: &'l AccessLevels,
53 span_utils: SpanUtils<'tcx>,
55 impl_counter: Cell<u32>,
62 RelationData(Relation, Impl),
65 impl<'l, 'tcx> SaveContext<'l, 'tcx> {
66 fn span_from_span(&self, span: Span) -> SpanData {
67 use rls_span::{Column, Row};
69 let cm = self.tcx.sess.source_map();
70 let start = cm.lookup_char_pos(span.lo());
71 let end = cm.lookup_char_pos(span.hi());
74 file_name: start.file.name.to_string().into(),
75 byte_start: span.lo().0,
76 byte_end: span.hi().0,
77 line_start: Row::new_one_indexed(start.line as u32),
78 line_end: Row::new_one_indexed(end.line as u32),
79 column_start: Column::new_one_indexed(start.col.0 as u32 + 1),
80 column_end: Column::new_one_indexed(end.col.0 as u32 + 1),
84 // Returns path to the compilation output (e.g., libfoo-12345678.rmeta)
85 pub fn compilation_output(&self, crate_name: &str) -> PathBuf {
86 let sess = &self.tcx.sess;
87 // Save-analysis is emitted per whole session, not per each crate type
88 let crate_type = sess.crate_types.borrow()[0];
89 let outputs = &*self.tcx.output_filenames(LOCAL_CRATE);
91 if outputs.outputs.contains_key(&OutputType::Metadata) {
92 filename_for_metadata(sess, crate_name, outputs)
93 } else if outputs.outputs.should_codegen() {
94 out_filename(sess, crate_type, outputs, crate_name)
96 // Otherwise it's only a DepInfo, in which case we return early and
97 // not even reach the analysis stage.
102 // List external crates used by the current crate.
103 pub fn get_external_crates(&self) -> Vec<ExternalCrateData> {
104 let mut result = Vec::with_capacity(self.tcx.crates().len());
106 for &n in self.tcx.crates().iter() {
107 let span = match self.tcx.extern_crate(n.as_def_id()) {
108 Some(&ExternCrate { span, .. }) => span,
110 debug!("skipping crate {}, no data", n);
114 let lo_loc = self.span_utils.sess.source_map().lookup_char_pos(span.lo());
115 result.push(ExternalCrateData {
116 // FIXME: change file_name field to PathBuf in rls-data
117 // https://github.com/nrc/rls-data/issues/7
118 file_name: self.span_utils.make_filename_string(&lo_loc.file),
121 name: self.tcx.crate_name(n).to_string(),
122 disambiguator: self.tcx.crate_disambiguator(n).to_fingerprint().as_value(),
130 pub fn get_extern_item_data(&self, item: &ast::ForeignItem) -> Option<Data> {
131 let qualname = format!(
133 self.tcx.def_path_str(self.tcx.hir().local_def_id_from_node_id(item.id))
136 ast::ForeignItemKind::Fn(ref sig, ref generics, _) => {
137 filter!(self.span_utils, item.ident.span);
139 Some(Data::DefData(Def {
140 kind: DefKind::ForeignFunction,
141 id: id_from_node_id(item.id, self),
142 span: self.span_from_span(item.ident.span),
143 name: item.ident.to_string(),
145 value: make_signature(&sig.decl, generics),
149 docs: self.docs_for_attrs(&item.attrs),
150 sig: sig::foreign_item_signature(item, self),
151 attributes: lower_attributes(item.attrs.clone(), self),
154 ast::ForeignItemKind::Static(ref ty, _, _) => {
155 filter!(self.span_utils, item.ident.span);
157 let id = id_from_node_id(item.id, self);
158 let span = self.span_from_span(item.ident.span);
160 Some(Data::DefData(Def {
161 kind: DefKind::ForeignStatic,
164 name: item.ident.to_string(),
166 value: ty_to_string(ty),
170 docs: self.docs_for_attrs(&item.attrs),
171 sig: sig::foreign_item_signature(item, self),
172 attributes: lower_attributes(item.attrs.clone(), self),
175 // FIXME(plietar): needs a new DefKind in rls-data
176 ast::ForeignItemKind::TyAlias(..) => None,
177 ast::ForeignItemKind::Macro(..) => None,
181 pub fn get_item_data(&self, item: &ast::Item) -> Option<Data> {
183 ast::ItemKind::Fn(ref sig, .., ref generics, _) => {
184 let qualname = format!(
186 self.tcx.def_path_str(self.tcx.hir().local_def_id_from_node_id(item.id))
188 filter!(self.span_utils, item.ident.span);
189 Some(Data::DefData(Def {
190 kind: DefKind::Function,
191 id: id_from_node_id(item.id, self),
192 span: self.span_from_span(item.ident.span),
193 name: item.ident.to_string(),
195 value: make_signature(&sig.decl, generics),
199 docs: self.docs_for_attrs(&item.attrs),
200 sig: sig::item_signature(item, self),
201 attributes: lower_attributes(item.attrs.clone(), self),
204 ast::ItemKind::Static(ref typ, ..) => {
205 let qualname = format!(
207 self.tcx.def_path_str(self.tcx.hir().local_def_id_from_node_id(item.id))
210 filter!(self.span_utils, item.ident.span);
212 let id = id_from_node_id(item.id, self);
213 let span = self.span_from_span(item.ident.span);
215 Some(Data::DefData(Def {
216 kind: DefKind::Static,
219 name: item.ident.to_string(),
221 value: ty_to_string(&typ),
225 docs: self.docs_for_attrs(&item.attrs),
226 sig: sig::item_signature(item, self),
227 attributes: lower_attributes(item.attrs.clone(), self),
230 ast::ItemKind::Const(ref typ, _) => {
231 let qualname = format!(
233 self.tcx.def_path_str(self.tcx.hir().local_def_id_from_node_id(item.id))
235 filter!(self.span_utils, item.ident.span);
237 let id = id_from_node_id(item.id, self);
238 let span = self.span_from_span(item.ident.span);
240 Some(Data::DefData(Def {
241 kind: DefKind::Const,
244 name: item.ident.to_string(),
246 value: ty_to_string(typ),
250 docs: self.docs_for_attrs(&item.attrs),
251 sig: sig::item_signature(item, self),
252 attributes: lower_attributes(item.attrs.clone(), self),
255 ast::ItemKind::Mod(ref m) => {
256 let qualname = format!(
258 self.tcx.def_path_str(self.tcx.hir().local_def_id_from_node_id(item.id))
261 let cm = self.tcx.sess.source_map();
262 let filename = cm.span_to_filename(m.inner);
264 filter!(self.span_utils, item.ident.span);
266 Some(Data::DefData(Def {
268 id: id_from_node_id(item.id, self),
269 name: item.ident.to_string(),
271 span: self.span_from_span(item.ident.span),
272 value: filename.to_string(),
274 children: m.items.iter().map(|i| id_from_node_id(i.id, self)).collect(),
276 docs: self.docs_for_attrs(&item.attrs),
277 sig: sig::item_signature(item, self),
278 attributes: lower_attributes(item.attrs.clone(), self),
281 ast::ItemKind::Enum(ref def, _) => {
282 let name = item.ident.to_string();
283 let qualname = format!(
285 self.tcx.def_path_str(self.tcx.hir().local_def_id_from_node_id(item.id))
287 filter!(self.span_utils, item.ident.span);
289 def.variants.iter().map(|v| v.ident.to_string()).collect::<Vec<_>>().join(", ");
290 let value = format!("{}::{{{}}}", name, variants_str);
291 Some(Data::DefData(Def {
293 id: id_from_node_id(item.id, self),
294 span: self.span_from_span(item.ident.span),
299 children: def.variants.iter().map(|v| id_from_node_id(v.id, self)).collect(),
301 docs: self.docs_for_attrs(&item.attrs),
302 sig: sig::item_signature(item, self),
303 attributes: lower_attributes(item.attrs.clone(), self),
306 ast::ItemKind::Impl { ref of_trait, ref self_ty, ref items, .. } => {
307 if let ast::TyKind::Path(None, ref path) = self_ty.kind {
308 // Common case impl for a struct or something basic.
309 if generated_code(path.span) {
312 let sub_span = path.segments.last().unwrap().ident.span;
313 filter!(self.span_utils, sub_span);
315 let impl_id = self.next_impl_id();
316 let span = self.span_from_span(sub_span);
318 let type_data = self.lookup_def_id(self_ty.id);
319 type_data.map(|type_data| {
322 kind: RelationKind::Impl { id: impl_id },
324 from: id_from_def_id(type_data),
327 .and_then(|t| self.lookup_def_id(t.ref_id))
329 .unwrap_or_else(|| null_id()),
333 kind: match *of_trait {
334 Some(_) => ImplKind::Direct,
335 None => ImplKind::Inherent,
338 value: String::new(),
342 .map(|i| id_from_node_id(i.id, self))
361 pub fn get_field_data(&self, field: &ast::StructField, scope: NodeId) -> Option<Def> {
362 if let Some(ident) = field.ident {
363 let name = ident.to_string();
364 let qualname = format!(
366 self.tcx.def_path_str(self.tcx.hir().local_def_id_from_node_id(scope)),
369 filter!(self.span_utils, ident.span);
370 let def_id = self.tcx.hir().local_def_id_from_node_id(field.id);
371 let typ = self.tcx.type_of(def_id).to_string();
373 let id = id_from_node_id(field.id, self);
374 let span = self.span_from_span(ident.span);
377 kind: DefKind::Field,
383 parent: Some(id_from_node_id(scope, self)),
386 docs: self.docs_for_attrs(&field.attrs),
387 sig: sig::field_signature(field, self),
388 attributes: lower_attributes(field.attrs.clone(), self),
395 // FIXME would be nice to take a MethodItem here, but the ast provides both
396 // trait and impl flavours, so the caller must do the disassembly.
397 pub fn get_method_data(&self, id: ast::NodeId, ident: ast::Ident, span: Span) -> Option<Def> {
398 // The qualname for a method is the trait name or name of the struct in an impl in
399 // which the method is declared in, followed by the method's name.
400 let (qualname, parent_scope, decl_id, docs, attributes) = match self
402 .impl_of_method(self.tcx.hir().local_def_id_from_node_id(id))
404 Some(impl_id) => match self.tcx.hir().get_if_local(impl_id) {
405 Some(Node::Item(item)) => match item.kind {
406 hir::ItemKind::Impl { ref self_ty, .. } => {
407 let mut qualname = String::from("<");
408 qualname.push_str(&self.tcx.hir().hir_to_pretty_string(self_ty.hir_id));
410 let trait_id = self.tcx.trait_id_of_impl(impl_id);
411 let mut decl_id = None;
412 let mut docs = String::new();
413 let mut attrs = vec![];
414 let hir_id = self.tcx.hir().node_to_hir_id(id);
415 if let Some(Node::ImplItem(item)) = self.tcx.hir().find(hir_id) {
416 docs = self.docs_for_attrs(&item.attrs);
417 attrs = item.attrs.to_vec();
420 if let Some(def_id) = trait_id {
421 // A method in a trait impl.
422 qualname.push_str(" as ");
423 qualname.push_str(&self.tcx.def_path_str(def_id));
425 .associated_items(def_id)
427 .find(|item| item.ident.name == ident.name)
428 .map(|item| decl_id = Some(item.def_id));
430 qualname.push_str(">");
432 (qualname, trait_id, decl_id, docs, attrs)
435 span_bug!(span, "Container {:?} for method {} not an impl?", impl_id, id);
441 "Container {:?} for method {} is not a node item {:?}",
448 None => match self.tcx.trait_of_item(self.tcx.hir().local_def_id_from_node_id(id)) {
450 let mut docs = String::new();
451 let mut attrs = vec![];
452 let hir_id = self.tcx.hir().node_to_hir_id(id);
454 if let Some(Node::TraitItem(item)) = self.tcx.hir().find(hir_id) {
455 docs = self.docs_for_attrs(&item.attrs);
456 attrs = item.attrs.to_vec();
460 format!("::{}", self.tcx.def_path_str(def_id)),
468 debug!("could not find container for method {} at {:?}", id, span);
469 // This is not necessarily a bug, if there was a compilation error,
470 // the tables we need might not exist.
476 let qualname = format!("{}::{}", qualname, ident.name);
478 filter!(self.span_utils, ident.span);
481 kind: DefKind::Method,
482 id: id_from_node_id(id, self),
483 span: self.span_from_span(ident.span),
484 name: ident.name.to_string(),
486 // FIXME you get better data here by using the visitor.
487 value: String::new(),
488 parent: parent_scope.map(|id| id_from_def_id(id)),
490 decl_id: decl_id.map(|id| id_from_def_id(id)),
493 attributes: lower_attributes(attributes, self),
497 pub fn get_trait_ref_data(&self, trait_ref: &ast::TraitRef) -> Option<Ref> {
498 self.lookup_def_id(trait_ref.ref_id).and_then(|def_id| {
499 let span = trait_ref.path.span;
500 if generated_code(span) {
503 let sub_span = trait_ref.path.segments.last().unwrap().ident.span;
504 filter!(self.span_utils, sub_span);
505 let span = self.span_from_span(sub_span);
506 Some(Ref { kind: RefKind::Type, span, ref_id: id_from_def_id(def_id) })
510 pub fn get_expr_data(&self, expr: &ast::Expr) -> Option<Data> {
511 let expr_hir_id = self.tcx.hir().node_to_hir_id(expr.id);
512 let hir_node = self.tcx.hir().expect_expr(expr_hir_id);
513 let ty = self.tables.expr_ty_adjusted_opt(&hir_node);
514 if ty.is_none() || ty.unwrap().kind == ty::Error {
518 ast::ExprKind::Field(ref sub_ex, ident) => {
519 let sub_ex_hir_id = self.tcx.hir().node_to_hir_id(sub_ex.id);
520 let hir_node = match self.tcx.hir().find(sub_ex_hir_id) {
521 Some(Node::Expr(expr)) => expr,
524 "Missing or weird node for sub-expression {} in {:?}",
530 match self.tables.expr_ty_adjusted(&hir_node).kind {
531 ty::Adt(def, _) if !def.is_enum() => {
532 let variant = &def.non_enum_variant();
533 let index = self.tcx.find_field_index(ident, variant).unwrap();
534 filter!(self.span_utils, ident.span);
535 let span = self.span_from_span(ident.span);
536 return Some(Data::RefData(Ref {
537 kind: RefKind::Variable,
539 ref_id: id_from_def_id(variant.fields[index].did),
542 ty::Tuple(..) => None,
544 debug!("expected struct or union type, found {:?}", ty);
549 ast::ExprKind::Struct(ref path, ..) => {
550 match self.tables.expr_ty_adjusted(&hir_node).kind {
551 ty::Adt(def, _) if !def.is_enum() => {
552 let sub_span = path.segments.last().unwrap().ident.span;
553 filter!(self.span_utils, sub_span);
554 let span = self.span_from_span(sub_span);
555 Some(Data::RefData(Ref {
558 ref_id: id_from_def_id(def.did),
562 // FIXME ty could legitimately be an enum, but then we will fail
563 // later if we try to look up the fields.
564 debug!("expected struct or union, found {:?}", ty);
569 ast::ExprKind::MethodCall(ref seg, ..) => {
570 let expr_hir_id = self.tcx.hir().definitions().node_to_hir_id(expr.id);
571 let method_id = match self.tables.type_dependent_def_id(expr_hir_id) {
574 debug!("could not resolve method id for {:?}", expr);
578 let (def_id, decl_id) = match self.tcx.associated_item(method_id).container {
579 ty::ImplContainer(_) => (Some(method_id), None),
580 ty::TraitContainer(_) => (None, Some(method_id)),
582 let sub_span = seg.ident.span;
583 filter!(self.span_utils, sub_span);
584 let span = self.span_from_span(sub_span);
585 Some(Data::RefData(Ref {
586 kind: RefKind::Function,
590 .map(|id| id_from_def_id(id))
591 .unwrap_or_else(|| null_id()),
594 ast::ExprKind::Path(_, ref path) => {
595 self.get_path_data(expr.id, path).map(|d| Data::RefData(d))
604 pub fn get_path_res(&self, id: NodeId) -> Res {
605 let hir_id = self.tcx.hir().node_to_hir_id(id);
606 match self.tcx.hir().get(hir_id) {
607 Node::TraitRef(tr) => tr.path.res,
609 Node::Item(&hir::Item { kind: hir::ItemKind::Use(path, _), .. }) => path.res,
610 Node::Visibility(&Spanned {
611 node: hir::VisibilityKind::Restricted { ref path, .. },
615 Node::PathSegment(seg) => match seg.res {
616 Some(res) if res != Res::Err => res,
618 let parent_node = self.tcx.hir().get_parent_node(hir_id);
619 self.get_path_res(self.tcx.hir().hir_to_node_id(parent_node))
623 Node::Expr(&hir::Expr { kind: hir::ExprKind::Struct(ref qpath, ..), .. }) => {
624 self.tables.qpath_res(qpath, hir_id)
627 Node::Expr(&hir::Expr { kind: hir::ExprKind::Path(ref qpath), .. })
628 | Node::Pat(&hir::Pat { kind: hir::PatKind::Path(ref qpath), .. })
629 | Node::Pat(&hir::Pat { kind: hir::PatKind::Struct(ref qpath, ..), .. })
630 | Node::Pat(&hir::Pat { kind: hir::PatKind::TupleStruct(ref qpath, ..), .. })
631 | Node::Ty(&hir::Ty { kind: hir::TyKind::Path(ref qpath), .. }) => {
632 self.tables.qpath_res(qpath, hir_id)
635 Node::Binding(&hir::Pat {
636 kind: hir::PatKind::Binding(_, canonical_id, ..), ..
637 }) => Res::Local(canonical_id),
643 pub fn get_path_data(&self, id: NodeId, path: &ast::Path) -> Option<Ref> {
644 path.segments.last().and_then(|seg| {
645 self.get_path_segment_data(seg).or_else(|| self.get_path_segment_data_with_id(seg, id))
649 pub fn get_path_segment_data(&self, path_seg: &ast::PathSegment) -> Option<Ref> {
650 self.get_path_segment_data_with_id(path_seg, path_seg.id)
653 fn get_path_segment_data_with_id(
655 path_seg: &ast::PathSegment,
658 // Returns true if the path is function type sugar, e.g., `Fn(A) -> B`.
659 fn fn_type(seg: &ast::PathSegment) -> bool {
660 if let Some(ref generic_args) = seg.args {
661 if let ast::GenericArgs::Parenthesized(_) = **generic_args {
668 if id == DUMMY_NODE_ID {
672 let res = self.get_path_res(id);
673 let span = path_seg.ident.span;
674 filter!(self.span_utils, span);
675 let span = self.span_from_span(span);
678 Res::Local(id) => Some(Ref {
679 kind: RefKind::Variable,
681 ref_id: id_from_node_id(self.tcx.hir().hir_to_node_id(id), self),
683 Res::Def(HirDefKind::Trait, def_id) if fn_type(path_seg) => {
684 Some(Ref { kind: RefKind::Type, span, ref_id: id_from_def_id(def_id) })
686 Res::Def(HirDefKind::Struct, def_id)
687 | Res::Def(HirDefKind::Variant, def_id)
688 | Res::Def(HirDefKind::Union, def_id)
689 | Res::Def(HirDefKind::Enum, def_id)
690 | Res::Def(HirDefKind::TyAlias, def_id)
691 | Res::Def(HirDefKind::ForeignTy, def_id)
692 | Res::Def(HirDefKind::TraitAlias, def_id)
693 | Res::Def(HirDefKind::AssocOpaqueTy, def_id)
694 | Res::Def(HirDefKind::AssocTy, def_id)
695 | Res::Def(HirDefKind::Trait, def_id)
696 | Res::Def(HirDefKind::OpaqueTy, def_id)
697 | Res::Def(HirDefKind::TyParam, def_id) => {
698 Some(Ref { kind: RefKind::Type, span, ref_id: id_from_def_id(def_id) })
700 Res::Def(HirDefKind::ConstParam, def_id) => {
701 Some(Ref { kind: RefKind::Variable, span, ref_id: id_from_def_id(def_id) })
703 Res::Def(HirDefKind::Ctor(CtorOf::Struct, ..), def_id) => {
704 // This is a reference to a tuple struct where the def_id points
705 // to an invisible constructor function. That is not a very useful
706 // def, so adjust to point to the tuple struct itself.
707 let parent_def_id = self.tcx.parent(def_id).unwrap();
708 Some(Ref { kind: RefKind::Type, span, ref_id: id_from_def_id(parent_def_id) })
710 Res::Def(HirDefKind::Static, _)
711 | Res::Def(HirDefKind::Const, _)
712 | Res::Def(HirDefKind::AssocConst, _)
713 | Res::Def(HirDefKind::Ctor(..), _) => {
714 Some(Ref { kind: RefKind::Variable, span, ref_id: id_from_def_id(res.def_id()) })
716 Res::Def(HirDefKind::Method, decl_id) => {
717 let def_id = if decl_id.is_local() {
718 let ti = self.tcx.associated_item(decl_id);
720 .associated_items(ti.container.id())
723 item.ident.name == ti.ident.name && item.defaultness.has_value()
725 .map(|item| item.def_id)
730 kind: RefKind::Function,
732 ref_id: id_from_def_id(def_id.unwrap_or(decl_id)),
735 Res::Def(HirDefKind::Fn, def_id) => {
736 Some(Ref { kind: RefKind::Function, span, ref_id: id_from_def_id(def_id) })
738 Res::Def(HirDefKind::Mod, def_id) => {
739 Some(Ref { kind: RefKind::Mod, span, ref_id: id_from_def_id(def_id) })
743 | Res::Def(HirDefKind::Macro(..), _)
745 | Res::NonMacroAttr(..)
751 pub fn get_field_ref_data(
753 field_ref: &ast::Field,
754 variant: &ty::VariantDef,
756 filter!(self.span_utils, field_ref.ident.span);
757 self.tcx.find_field_index(field_ref.ident, variant).map(|index| {
758 let span = self.span_from_span(field_ref.ident.span);
759 Ref { kind: RefKind::Variable, span, ref_id: id_from_def_id(variant.fields[index].did) }
763 /// Attempt to return MacroRef for any AST node.
765 /// For a given piece of AST defined by the supplied Span and NodeId,
766 /// returns `None` if the node is not macro-generated or the span is malformed,
767 /// else uses the expansion callsite and callee to return some MacroRef.
768 pub fn get_macro_use_data(&self, span: Span) -> Option<MacroRef> {
769 if !generated_code(span) {
772 // Note we take care to use the source callsite/callee, to handle
773 // nested expansions and ensure we only generate data for source-visible
775 let callsite = span.source_callsite();
776 let callsite_span = self.span_from_span(callsite);
777 let callee = span.source_callee()?;
779 let mac_name = match callee.kind {
780 ExpnKind::Macro(mac_kind, name) => match mac_kind {
781 MacroKind::Bang => name,
783 // Ignore attribute macros, their spans are usually mangled
784 // FIXME(eddyb) is this really the case anymore?
785 MacroKind::Attr | MacroKind::Derive => return None,
788 // These are not macros.
789 // FIXME(eddyb) maybe there is a way to handle them usefully?
790 ExpnKind::Root | ExpnKind::AstPass(_) | ExpnKind::Desugaring(_) => return None,
793 // If the callee is an imported macro from an external crate, need to get
794 // the source span and name from the session, as their spans are localized
795 // when read in, and no longer correspond to the source.
796 if let Some(mac) = self.tcx.sess.imported_macro_spans.borrow().get(&callee.def_site) {
797 let &(ref mac_name, mac_span) = mac;
798 let mac_span = self.span_from_span(mac_span);
799 return Some(MacroRef {
801 qualname: mac_name.clone(), // FIXME: generate the real qualname
802 callee_span: mac_span,
806 let callee_span = self.span_from_span(callee.def_site);
809 qualname: mac_name.to_string(), // FIXME: generate the real qualname
814 fn lookup_def_id(&self, ref_id: NodeId) -> Option<DefId> {
815 match self.get_path_res(ref_id) {
816 Res::PrimTy(_) | Res::SelfTy(..) | Res::Err => None,
817 def => Some(def.def_id()),
821 fn docs_for_attrs(&self, attrs: &[Attribute]) -> String {
822 let mut result = String::new();
825 if let Some(val) = attr.doc_str() {
826 if attr.is_doc_comment() {
827 result.push_str(&strip_doc_comment_decoration(&val.as_str()));
829 result.push_str(&val.as_str());
832 } else if attr.check_name(sym::doc) {
833 if let Some(meta_list) = attr.meta_item_list() {
836 .filter(|it| it.check_name(sym::include))
837 .filter_map(|it| it.meta_item_list().map(|l| l.to_owned()))
839 .filter(|meta| meta.check_name(sym::contents))
840 .filter_map(|meta| meta.value_str())
842 result.push_str(&val.as_str());
849 if !self.config.full_docs {
850 if let Some(index) = result.find("\n\n") {
851 result.truncate(index);
858 fn next_impl_id(&self) -> u32 {
859 let next = self.impl_counter.get();
860 self.impl_counter.set(next + 1);
865 fn make_signature(decl: &ast::FnDecl, generics: &ast::Generics) -> String {
866 let mut sig = "fn ".to_owned();
867 if !generics.params.is_empty() {
873 .map(|param| param.ident.to_string())
880 sig.push_str(&decl.inputs.iter().map(param_to_string).collect::<Vec<_>>().join(", "));
883 ast::FunctionRetTy::Default(_) => sig.push_str(" -> ()"),
884 ast::FunctionRetTy::Ty(ref t) => sig.push_str(&format!(" -> {}", ty_to_string(t))),
890 // An AST visitor for collecting paths (e.g., the names of structs) and formal
891 // variables (idents) from patterns.
892 struct PathCollector<'l> {
893 collected_paths: Vec<(NodeId, &'l ast::Path)>,
894 collected_idents: Vec<(NodeId, ast::Ident, ast::Mutability)>,
897 impl<'l> PathCollector<'l> {
898 fn new() -> PathCollector<'l> {
899 PathCollector { collected_paths: vec![], collected_idents: vec![] }
903 impl<'l> Visitor<'l> for PathCollector<'l> {
904 fn visit_pat(&mut self, p: &'l ast::Pat) {
906 PatKind::Struct(ref path, ..) => {
907 self.collected_paths.push((p.id, path));
909 PatKind::TupleStruct(ref path, ..) | PatKind::Path(_, ref path) => {
910 self.collected_paths.push((p.id, path));
912 PatKind::Ident(bm, ident, _) => {
914 "PathCollector, visit ident in pat {}: {:?} {:?}",
915 ident, p.span, ident.span
917 let immut = match bm {
918 // Even if the ref is mut, you can't change the ref, only
919 // the data pointed at, so showing the initialising expression
920 // is still worthwhile.
921 ast::BindingMode::ByRef(_) => ast::Mutability::Not,
922 ast::BindingMode::ByValue(mt) => mt,
924 self.collected_idents.push((p.id, ident, immut));
928 visit::walk_pat(self, p);
932 /// Defines what to do with the results of saving the analysis.
933 pub trait SaveHandler {
934 fn save(&mut self, save_ctxt: &SaveContext<'_, '_>, analysis: &Analysis);
937 /// Dump the save-analysis results to a file.
938 pub struct DumpHandler<'a> {
939 odir: Option<&'a Path>,
943 impl<'a> DumpHandler<'a> {
944 pub fn new(odir: Option<&'a Path>, cratename: &str) -> DumpHandler<'a> {
945 DumpHandler { odir, cratename: cratename.to_owned() }
948 fn output_file(&self, ctx: &SaveContext<'_, '_>) -> (BufWriter<File>, PathBuf) {
949 let sess = &ctx.tcx.sess;
950 let file_name = match ctx.config.output_file {
951 Some(ref s) => PathBuf::from(s),
953 let mut root_path = match self.odir {
954 Some(val) => val.join("save-analysis"),
955 None => PathBuf::from("save-analysis-temp"),
958 if let Err(e) = std::fs::create_dir_all(&root_path) {
959 error!("Could not create directory {}: {}", root_path.display(), e);
963 sess.crate_types.borrow().iter().any(|ct| *ct == CrateType::Executable);
964 let mut out_name = if executable { String::new() } else { "lib".to_owned() };
965 out_name.push_str(&self.cratename);
966 out_name.push_str(&sess.opts.cg.extra_filename);
967 out_name.push_str(".json");
968 root_path.push(&out_name);
974 info!("Writing output to {}", file_name.display());
976 let output_file = BufWriter::new(File::create(&file_name).unwrap_or_else(|e| {
977 sess.fatal(&format!("Could not open {}: {}", file_name.display(), e))
980 (output_file, file_name)
984 impl SaveHandler for DumpHandler<'_> {
985 fn save(&mut self, save_ctxt: &SaveContext<'_, '_>, analysis: &Analysis) {
986 let sess = &save_ctxt.tcx.sess;
987 let (output, file_name) = self.output_file(&save_ctxt);
988 if let Err(e) = serde_json::to_writer(output, &analysis) {
989 error!("Can't serialize save-analysis: {:?}", e);
992 if sess.opts.json_artifact_notifications {
993 sess.parse_sess.span_diagnostic.emit_artifact_notification(&file_name, "save-analysis");
998 /// Call a callback with the results of save-analysis.
999 pub struct CallbackHandler<'b> {
1000 pub callback: &'b mut dyn FnMut(&rls_data::Analysis),
1003 impl SaveHandler for CallbackHandler<'_> {
1004 fn save(&mut self, _: &SaveContext<'_, '_>, analysis: &Analysis) {
1005 (self.callback)(analysis)
1009 pub fn process_crate<'l, 'tcx, H: SaveHandler>(
1014 config: Option<Config>,
1017 tcx.dep_graph.with_ignore(|| {
1018 info!("Dumping crate {}", cratename);
1020 // Privacy checking requires and is done after type checking; use a
1021 // fallback in case the access levels couldn't have been correctly computed.
1022 let access_levels = match tcx.sess.compile_status() {
1023 Ok(..) => tcx.privacy_access_levels(LOCAL_CRATE),
1024 Err(..) => tcx.arena.alloc(AccessLevels::default()),
1027 let save_ctxt = SaveContext {
1029 tables: &ty::TypeckTables::empty(None),
1030 empty_tables: &ty::TypeckTables::empty(None),
1031 access_levels: &access_levels,
1032 span_utils: SpanUtils::new(&tcx.sess),
1033 config: find_config(config),
1034 impl_counter: Cell::new(0),
1037 let mut visitor = DumpVisitor::new(save_ctxt);
1039 visitor.dump_crate_info(cratename, krate);
1040 visitor.dump_compilation_options(input, cratename);
1041 visit::walk_crate(&mut visitor, krate);
1043 handler.save(&visitor.save_ctxt, &visitor.analysis())
1047 fn find_config(supplied: Option<Config>) -> Config {
1048 if let Some(config) = supplied {
1052 match env::var_os("RUST_SAVE_ANALYSIS_CONFIG") {
1053 None => Config::default(),
1054 Some(config) => config
1057 .map_err(|_| error!("`RUST_SAVE_ANALYSIS_CONFIG` isn't UTF-8"))
1059 serde_json::from_str(cfg)
1060 .map_err(|_| error!("Could not deserialize save-analysis config"))
1062 .unwrap_or_default(),
1066 // Utility functions for the module.
1068 // Helper function to escape quotes in a string
1069 fn escape(s: String) -> String {
1070 s.replace("\"", "\"\"")
1073 // Helper function to determine if a span came from a
1074 // macro expansion or syntax extension.
1075 fn generated_code(span: Span) -> bool {
1076 span.from_expansion() || span.is_dummy()
1079 // DefId::index is a newtype and so the JSON serialisation is ugly. Therefore
1080 // we use our own Id which is the same, but without the newtype.
1081 fn id_from_def_id(id: DefId) -> rls_data::Id {
1082 rls_data::Id { krate: id.krate.as_u32(), index: id.index.as_u32() }
1085 fn id_from_node_id(id: NodeId, scx: &SaveContext<'_, '_>) -> rls_data::Id {
1086 let def_id = scx.tcx.hir().opt_local_def_id_from_node_id(id);
1087 def_id.map(|id| id_from_def_id(id)).unwrap_or_else(|| {
1088 // Create a *fake* `DefId` out of a `NodeId` by subtracting the `NodeId`
1089 // out of the maximum u32 value. This will work unless you have *billions*
1090 // of definitions in a single crate (very unlikely to actually happen).
1091 rls_data::Id { krate: LOCAL_CRATE.as_u32(), index: !id.as_u32() }
1095 fn null_id() -> rls_data::Id {
1096 rls_data::Id { krate: u32::max_value(), index: u32::max_value() }
1099 fn lower_attributes(attrs: Vec<Attribute>, scx: &SaveContext<'_, '_>) -> Vec<rls_data::Attribute> {
1102 // Only retain real attributes. Doc comments are lowered separately.
1103 .filter(|attr| !attr.has_name(sym::doc))
1105 // Remove the surrounding '#[..]' or '#![..]' of the pretty printed
1106 // attribute. First normalize all inner attribute (#![..]) to outer
1107 // ones (#[..]), then remove the two leading and the one trailing character.
1108 attr.style = ast::AttrStyle::Outer;
1109 let value = pprust::attribute_to_string(&attr);
1110 // This str slicing works correctly, because the leading and trailing characters
1111 // are in the ASCII range and thus exactly one byte each.
1112 let value = value[2..value.len() - 1].to_string();
1114 rls_data::Attribute { value, span: scx.span_from_span(attr.span) }