1 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")]
2 #![feature(if_let_guard)]
5 #![recursion_limit = "256"]
6 #![cfg_attr(not(bootstrap), allow(rustc::potential_query_instability))]
15 use rustc_ast::util::comments::beautify_doc_string;
16 use rustc_ast_pretty::pprust::attribute_to_string;
18 use rustc_hir::def::{DefKind as HirDefKind, Res};
19 use rustc_hir::def_id::{DefId, LOCAL_CRATE};
20 use rustc_hir::intravisit::{self, Visitor};
22 use rustc_hir_pretty::{enum_def_to_string, fn_to_string, ty_to_string};
23 use rustc_middle::hir::nested_filter;
24 use rustc_middle::middle::privacy::AccessLevels;
25 use rustc_middle::ty::{self, print::with_no_trimmed_paths, DefIdTree, TyCtxt};
26 use rustc_middle::{bug, span_bug};
27 use rustc_session::config::{CrateType, Input, OutputType};
28 use rustc_session::cstore::ExternCrate;
29 use rustc_session::output::{filename_for_metadata, out_filename};
30 use rustc_span::source_map::Spanned;
31 use rustc_span::symbol::Ident;
35 use std::default::Default;
38 use std::io::BufWriter;
39 use std::path::{Path, PathBuf};
41 use dump_visitor::DumpVisitor;
42 use span_utils::SpanUtils;
44 use rls_data::config::Config;
46 Analysis, Def, DefKind, ExternalCrateData, GlobalCrateId, Impl, ImplKind, MacroRef, Ref,
47 RefKind, Relation, RelationKind, SpanData,
50 use tracing::{debug, error, info};
52 pub struct SaveContext<'tcx> {
54 maybe_typeck_results: Option<&'tcx ty::TypeckResults<'tcx>>,
55 access_levels: &'tcx AccessLevels,
56 span_utils: SpanUtils<'tcx>,
58 impl_counter: Cell<u32>,
65 RelationData(Relation, Impl),
68 impl<'tcx> SaveContext<'tcx> {
69 /// Gets the type-checking results for the current body.
70 /// As this will ICE if called outside bodies, only call when working with
71 /// `Expr` or `Pat` nodes (they are guaranteed to be found only in bodies).
73 fn typeck_results(&self) -> &'tcx ty::TypeckResults<'tcx> {
74 self.maybe_typeck_results.expect("`SaveContext::typeck_results` called outside of body")
77 fn span_from_span(&self, span: Span) -> SpanData {
78 use rls_span::{Column, Row};
80 let sm = self.tcx.sess.source_map();
81 let start = sm.lookup_char_pos(span.lo());
82 let end = sm.lookup_char_pos(span.hi());
85 file_name: start.file.name.prefer_remapped().to_string().into(),
86 byte_start: span.lo().0,
87 byte_end: span.hi().0,
88 line_start: Row::new_one_indexed(start.line as u32),
89 line_end: Row::new_one_indexed(end.line as u32),
90 column_start: Column::new_one_indexed(start.col.0 as u32 + 1),
91 column_end: Column::new_one_indexed(end.col.0 as u32 + 1),
95 // Returns path to the compilation output (e.g., libfoo-12345678.rmeta)
96 pub fn compilation_output(&self, crate_name: &str) -> PathBuf {
97 let sess = &self.tcx.sess;
98 // Save-analysis is emitted per whole session, not per each crate type
99 let crate_type = sess.crate_types()[0];
100 let outputs = &*self.tcx.output_filenames(());
102 if outputs.outputs.contains_key(&OutputType::Metadata) {
103 filename_for_metadata(sess, crate_name, outputs)
104 } else if outputs.outputs.should_codegen() {
105 out_filename(sess, crate_type, outputs, crate_name)
107 // Otherwise it's only a DepInfo, in which case we return early and
108 // not even reach the analysis stage.
113 // List external crates used by the current crate.
114 pub fn get_external_crates(&self) -> Vec<ExternalCrateData> {
115 let mut result = Vec::with_capacity(self.tcx.crates(()).len());
117 for &n in self.tcx.crates(()).iter() {
118 let span = match self.tcx.extern_crate(n.as_def_id()) {
119 Some(&ExternCrate { span, .. }) => span,
121 debug!("skipping crate {}, no data", n);
125 let lo_loc = self.span_utils.sess.source_map().lookup_char_pos(span.lo());
126 result.push(ExternalCrateData {
127 // FIXME: change file_name field to PathBuf in rls-data
128 // https://github.com/nrc/rls-data/issues/7
129 file_name: self.span_utils.make_filename_string(&lo_loc.file),
132 name: self.tcx.crate_name(n).to_string(),
134 self.tcx.def_path_hash(n.as_def_id()).stable_crate_id().to_u64(),
144 pub fn get_extern_item_data(&self, item: &hir::ForeignItem<'_>) -> Option<Data> {
145 let def_id = item.def_id.to_def_id();
146 let qualname = format!("::{}", self.tcx.def_path_str(def_id));
147 let attrs = self.tcx.hir().attrs(item.hir_id());
149 hir::ForeignItemKind::Fn(ref decl, arg_names, ref generics) => {
150 filter!(self.span_utils, item.ident.span);
152 Some(Data::DefData(Def {
153 kind: DefKind::ForeignFunction,
154 id: id_from_def_id(def_id),
155 span: self.span_from_span(item.ident.span),
156 name: item.ident.to_string(),
161 // functions in extern block are implicitly unsafe
162 unsafety: hir::Unsafety::Unsafe,
163 // functions in extern block cannot be const
164 constness: hir::Constness::NotConst,
165 abi: self.tcx.hir().get_foreign_abi(item.hir_id()),
166 // functions in extern block cannot be async
167 asyncness: hir::IsAsync::NotAsync,
169 Some(item.ident.name),
178 docs: self.docs_for_attrs(attrs),
179 sig: sig::foreign_item_signature(item, self),
180 attributes: lower_attributes(attrs.to_vec(), self),
183 hir::ForeignItemKind::Static(ref ty, _) => {
184 filter!(self.span_utils, item.ident.span);
186 let id = id_from_def_id(def_id);
187 let span = self.span_from_span(item.ident.span);
189 Some(Data::DefData(Def {
190 kind: DefKind::ForeignStatic,
193 name: item.ident.to_string(),
195 value: ty_to_string(ty),
199 docs: self.docs_for_attrs(attrs),
200 sig: sig::foreign_item_signature(item, self),
201 attributes: lower_attributes(attrs.to_vec(), self),
204 // FIXME(plietar): needs a new DefKind in rls-data
205 hir::ForeignItemKind::Type => None,
209 pub fn get_item_data(&self, item: &hir::Item<'_>) -> Option<Data> {
210 let def_id = item.def_id.to_def_id();
211 let attrs = self.tcx.hir().attrs(item.hir_id());
213 hir::ItemKind::Fn(ref sig, ref generics, _) => {
214 let qualname = format!("::{}", self.tcx.def_path_str(def_id));
215 filter!(self.span_utils, item.ident.span);
216 Some(Data::DefData(Def {
217 kind: DefKind::Function,
218 id: id_from_def_id(def_id),
219 span: self.span_from_span(item.ident.span),
220 name: item.ident.to_string(),
225 Some(item.ident.name),
234 docs: self.docs_for_attrs(attrs),
235 sig: sig::item_signature(item, self),
236 attributes: lower_attributes(attrs.to_vec(), self),
239 hir::ItemKind::Static(ref typ, ..) => {
240 let qualname = format!("::{}", self.tcx.def_path_str(def_id));
242 filter!(self.span_utils, item.ident.span);
244 let id = id_from_def_id(def_id);
245 let span = self.span_from_span(item.ident.span);
247 Some(Data::DefData(Def {
248 kind: DefKind::Static,
251 name: item.ident.to_string(),
253 value: ty_to_string(&typ),
257 docs: self.docs_for_attrs(attrs),
258 sig: sig::item_signature(item, self),
259 attributes: lower_attributes(attrs.to_vec(), self),
262 hir::ItemKind::Const(ref typ, _) => {
263 let qualname = format!("::{}", self.tcx.def_path_str(def_id));
264 filter!(self.span_utils, item.ident.span);
266 let id = id_from_def_id(def_id);
267 let span = self.span_from_span(item.ident.span);
269 Some(Data::DefData(Def {
270 kind: DefKind::Const,
273 name: item.ident.to_string(),
275 value: ty_to_string(typ),
279 docs: self.docs_for_attrs(attrs),
280 sig: sig::item_signature(item, self),
281 attributes: lower_attributes(attrs.to_vec(), self),
284 hir::ItemKind::Mod(ref m) => {
285 let qualname = format!("::{}", self.tcx.def_path_str(def_id));
287 let sm = self.tcx.sess.source_map();
288 let filename = sm.span_to_filename(m.inner);
290 filter!(self.span_utils, item.ident.span);
292 Some(Data::DefData(Def {
294 id: id_from_def_id(def_id),
295 name: item.ident.to_string(),
297 span: self.span_from_span(item.ident.span),
298 value: filename.prefer_remapped().to_string(),
303 .map(|i| id_from_def_id(i.def_id.to_def_id()))
306 docs: self.docs_for_attrs(attrs),
307 sig: sig::item_signature(item, self),
308 attributes: lower_attributes(attrs.to_vec(), self),
311 hir::ItemKind::Enum(ref def, ref generics) => {
312 let name = item.ident.to_string();
313 let qualname = format!("::{}", self.tcx.def_path_str(def_id));
314 filter!(self.span_utils, item.ident.span);
316 enum_def_to_string(def, generics, item.ident.name, item.span, &item.vis);
317 Some(Data::DefData(Def {
319 id: id_from_def_id(def_id),
320 span: self.span_from_span(item.ident.span),
325 children: def.variants.iter().map(|v| id_from_hir_id(v.id, self)).collect(),
327 docs: self.docs_for_attrs(attrs),
328 sig: sig::item_signature(item, self),
329 attributes: lower_attributes(attrs.to_vec(), self),
332 hir::ItemKind::Impl(hir::Impl { ref of_trait, ref self_ty, ref items, .. })
333 if let hir::TyKind::Path(hir::QPath::Resolved(_, ref path)) = self_ty.kind =>
335 // Common case impl for a struct or something basic.
336 if generated_code(path.span) {
339 let sub_span = path.segments.last().unwrap().ident.span;
340 filter!(self.span_utils, sub_span);
342 let impl_id = self.next_impl_id();
343 let span = self.span_from_span(sub_span);
345 let type_data = self.lookup_def_id(self_ty.hir_id);
346 type_data.map(|type_data| {
349 kind: RelationKind::Impl { id: impl_id },
351 from: id_from_def_id(type_data),
354 .and_then(|t| self.lookup_def_id(t.hir_ref_id))
356 .unwrap_or_else(null_id),
360 kind: match *of_trait {
361 Some(_) => ImplKind::Direct,
362 None => ImplKind::Inherent,
365 value: String::new(),
369 .map(|i| id_from_def_id(i.id.def_id.to_def_id()))
378 hir::ItemKind::Impl(_) => None,
386 pub fn get_field_data(&self, field: &hir::FieldDef<'_>, scope: hir::HirId) -> Option<Def> {
387 let name = field.ident.to_string();
388 let scope_def_id = self.tcx.hir().local_def_id(scope).to_def_id();
389 let qualname = format!("::{}::{}", self.tcx.def_path_str(scope_def_id), field.ident);
390 filter!(self.span_utils, field.ident.span);
391 let field_def_id = self.tcx.hir().local_def_id(field.hir_id).to_def_id();
392 let typ = self.tcx.type_of(field_def_id).to_string();
394 let id = id_from_def_id(field_def_id);
395 let span = self.span_from_span(field.ident.span);
396 let attrs = self.tcx.hir().attrs(field.hir_id);
399 kind: DefKind::Field,
405 parent: Some(id_from_def_id(scope_def_id)),
408 docs: self.docs_for_attrs(attrs),
409 sig: sig::field_signature(field, self),
410 attributes: lower_attributes(attrs.to_vec(), self),
414 // FIXME would be nice to take a MethodItem here, but the ast provides both
415 // trait and impl flavours, so the caller must do the disassembly.
416 pub fn get_method_data(&self, hir_id: hir::HirId, ident: Ident, span: Span) -> Option<Def> {
417 // The qualname for a method is the trait name or name of the struct in an impl in
418 // which the method is declared in, followed by the method's name.
419 let def_id = self.tcx.hir().local_def_id(hir_id).to_def_id();
420 let (qualname, parent_scope, decl_id, docs, attributes) =
421 match self.tcx.impl_of_method(def_id) {
422 Some(impl_id) => match self.tcx.hir().get_if_local(impl_id) {
423 Some(Node::Item(item)) => match item.kind {
424 hir::ItemKind::Impl(hir::Impl { ref self_ty, .. }) => {
425 let hir = self.tcx.hir();
427 let mut qualname = String::from("<");
429 .push_str(&rustc_hir_pretty::id_to_string(&hir, self_ty.hir_id));
431 let trait_id = self.tcx.trait_id_of_impl(impl_id);
432 let mut docs = String::new();
433 let mut attrs = vec![];
434 if let Some(Node::ImplItem(_)) = hir.find(hir_id) {
435 attrs = self.tcx.hir().attrs(hir_id).to_vec();
436 docs = self.docs_for_attrs(&attrs);
439 let mut decl_id = None;
440 if let Some(def_id) = trait_id {
441 // A method in a trait impl.
442 qualname.push_str(" as ");
443 qualname.push_str(&self.tcx.def_path_str(def_id));
447 .associated_items(def_id)
448 .filter_by_name_unhygienic(ident.name)
450 .map(|item| item.def_id);
454 (qualname, trait_id, decl_id, docs, attrs)
459 "Container {:?} for method {} not an impl?",
468 "Container {:?} for method {} is not a node item {:?}",
475 None => match self.tcx.trait_of_item(def_id) {
477 let mut docs = String::new();
478 let mut attrs = vec![];
480 if let Some(Node::TraitItem(_)) = self.tcx.hir().find(hir_id) {
481 attrs = self.tcx.hir().attrs(hir_id).to_vec();
482 docs = self.docs_for_attrs(&attrs);
486 format!("::{}", self.tcx.def_path_str(def_id)),
494 debug!("could not find container for method {} at {:?}", hir_id, span);
495 // This is not necessarily a bug, if there was a compilation error,
496 // the typeck results we need might not exist.
502 let qualname = format!("{}::{}", qualname, ident.name);
504 filter!(self.span_utils, ident.span);
507 kind: DefKind::Method,
508 id: id_from_def_id(def_id),
509 span: self.span_from_span(ident.span),
510 name: ident.name.to_string(),
512 // FIXME you get better data here by using the visitor.
513 value: String::new(),
514 parent: parent_scope.map(id_from_def_id),
516 decl_id: decl_id.map(id_from_def_id),
519 attributes: lower_attributes(attributes, self),
523 pub fn get_expr_data(&self, expr: &hir::Expr<'_>) -> Option<Data> {
524 let ty = self.typeck_results().expr_ty_adjusted_opt(expr)?;
525 if matches!(ty.kind(), ty::Error(_)) {
529 hir::ExprKind::Field(ref sub_ex, ident) => {
530 match self.typeck_results().expr_ty_adjusted(&sub_ex).kind() {
531 ty::Adt(def, _) if !def.is_enum() => {
532 let variant = &def.non_enum_variant();
533 filter!(self.span_utils, ident.span);
534 let span = self.span_from_span(ident.span);
535 Some(Data::RefData(Ref {
536 kind: RefKind::Variable,
540 .find_field_index(ident, variant)
541 .map(|index| id_from_def_id(variant.fields[index].did))
542 .unwrap_or_else(null_id),
545 ty::Tuple(..) => None,
547 debug!("expected struct or union type, found {:?}", ty);
552 hir::ExprKind::Struct(qpath, ..) => match ty.kind() {
554 let sub_span = qpath.last_segment_span();
555 filter!(self.span_utils, sub_span);
556 let span = self.span_from_span(sub_span);
557 Some(Data::RefData(Ref {
560 ref_id: id_from_def_id(def.did),
564 debug!("expected adt, found {:?}", ty);
568 hir::ExprKind::MethodCall(ref seg, ..) => {
569 let method_id = match self.typeck_results().type_dependent_def_id(expr.hir_id) {
572 debug!("could not resolve method id for {:?}", expr);
576 let (def_id, decl_id) = match self.tcx.associated_item(method_id).container {
577 ty::ImplContainer(_) => (Some(method_id), None),
578 ty::TraitContainer(_) => (None, Some(method_id)),
580 let sub_span = seg.ident.span;
581 filter!(self.span_utils, sub_span);
582 let span = self.span_from_span(sub_span);
583 Some(Data::RefData(Ref {
584 kind: RefKind::Function,
586 ref_id: def_id.or(decl_id).map(id_from_def_id).unwrap_or_else(null_id),
589 hir::ExprKind::Path(ref path) => {
590 self.get_path_data(expr.hir_id, path).map(Data::RefData)
594 bug!("invalid expression: {:?}", expr);
599 pub fn get_path_res(&self, hir_id: hir::HirId) -> Res {
600 match self.tcx.hir().get(hir_id) {
601 Node::TraitRef(tr) => tr.path.res,
603 Node::Item(&hir::Item { kind: hir::ItemKind::Use(path, _), .. }) => path.res,
604 Node::Visibility(&Spanned {
605 node: hir::VisibilityKind::Restricted { ref path, .. },
609 Node::PathSegment(seg) => match seg.res {
610 Some(res) if res != Res::Err => res,
612 let parent_node = self.tcx.hir().get_parent_node(hir_id);
613 self.get_path_res(parent_node)
617 Node::Expr(&hir::Expr { kind: hir::ExprKind::Struct(ref qpath, ..), .. }) => {
618 self.typeck_results().qpath_res(qpath, hir_id)
621 Node::Expr(&hir::Expr { kind: hir::ExprKind::Path(ref qpath), .. })
622 | Node::Pat(&hir::Pat {
624 hir::PatKind::Path(ref qpath)
625 | hir::PatKind::Struct(ref qpath, ..)
626 | hir::PatKind::TupleStruct(ref qpath, ..),
629 | Node::Ty(&hir::Ty { kind: hir::TyKind::Path(ref qpath), .. }) => match qpath {
630 hir::QPath::Resolved(_, path) => path.res,
631 hir::QPath::TypeRelative(..) | hir::QPath::LangItem(..) => {
632 // #75962: `self.typeck_results` may be different from the `hir_id`'s result.
633 if self.tcx.has_typeck_results(hir_id.owner.to_def_id()) {
634 self.tcx.typeck(hir_id.owner).qpath_res(qpath, hir_id)
641 Node::Binding(&hir::Pat {
642 kind: hir::PatKind::Binding(_, canonical_id, ..), ..
643 }) => Res::Local(canonical_id),
649 pub fn get_path_data(&self, id: hir::HirId, path: &hir::QPath<'_>) -> Option<Ref> {
650 let segment = match path {
651 hir::QPath::Resolved(_, path) => path.segments.last(),
652 hir::QPath::TypeRelative(_, segment) => Some(*segment),
653 hir::QPath::LangItem(..) => None,
655 segment.and_then(|seg| {
656 self.get_path_segment_data(seg).or_else(|| self.get_path_segment_data_with_id(seg, id))
660 pub fn get_path_segment_data(&self, path_seg: &hir::PathSegment<'_>) -> Option<Ref> {
661 self.get_path_segment_data_with_id(path_seg, path_seg.hir_id?)
664 pub fn get_path_segment_data_with_id(
666 path_seg: &hir::PathSegment<'_>,
669 // Returns true if the path is function type sugar, e.g., `Fn(A) -> B`.
670 fn fn_type(seg: &hir::PathSegment<'_>) -> bool {
671 seg.args.map_or(false, |args| args.parenthesized)
674 let res = self.get_path_res(id);
675 let span = path_seg.ident.span;
676 filter!(self.span_utils, span);
677 let span = self.span_from_span(span);
681 Some(Ref { kind: RefKind::Variable, span, ref_id: id_from_hir_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) })
688 | HirDefKind::Variant
691 | HirDefKind::TyAlias
692 | HirDefKind::ForeignTy
693 | HirDefKind::TraitAlias
694 | HirDefKind::AssocTy
696 | HirDefKind::OpaqueTy
697 | HirDefKind::TyParam,
699 ) => 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(..), def_id) => {
704 // This is a reference to a tuple struct or an enum variant 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 or enum variant 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 | HirDefKind::Const | HirDefKind::AssocConst, _) => {
711 Some(Ref { kind: RefKind::Variable, span, ref_id: id_from_def_id(res.def_id()) })
713 Res::Def(HirDefKind::AssocFn, decl_id) => {
714 let def_id = if decl_id.is_local() {
715 if self.tcx.associated_item(decl_id).defaultness.has_value() {
724 kind: RefKind::Function,
726 ref_id: id_from_def_id(def_id.unwrap_or(decl_id)),
729 Res::Def(HirDefKind::Fn, def_id) => {
730 Some(Ref { kind: RefKind::Function, span, ref_id: id_from_def_id(def_id) })
732 Res::Def(HirDefKind::Mod, def_id) => {
733 Some(Ref { kind: RefKind::Mod, span, ref_id: id_from_def_id(def_id) })
737 HirDefKind::Macro(..)
738 | HirDefKind::ExternCrate
739 | HirDefKind::ForeignMod
740 | HirDefKind::LifetimeParam
741 | HirDefKind::AnonConst
742 | HirDefKind::InlineConst
745 | HirDefKind::GlobalAsm
747 | HirDefKind::Closure
748 | HirDefKind::Generator,
754 | Res::NonMacroAttr(..)
760 pub fn get_field_ref_data(
762 field_ref: &hir::ExprField<'_>,
763 variant: &ty::VariantDef,
765 filter!(self.span_utils, field_ref.ident.span);
766 self.tcx.find_field_index(field_ref.ident, variant).map(|index| {
767 let span = self.span_from_span(field_ref.ident.span);
768 Ref { kind: RefKind::Variable, span, ref_id: id_from_def_id(variant.fields[index].did) }
772 /// Attempt to return MacroRef for any AST node.
774 /// For a given piece of AST defined by the supplied Span and NodeId,
775 /// returns `None` if the node is not macro-generated or the span is malformed,
776 /// else uses the expansion callsite and callee to return some MacroRef.
778 /// FIXME: [`DumpVisitor::process_macro_use`] should actually dump this data
780 fn get_macro_use_data(&self, span: Span) -> Option<MacroRef> {
781 if !generated_code(span) {
784 // Note we take care to use the source callsite/callee, to handle
785 // nested expansions and ensure we only generate data for source-visible
787 let callsite = span.source_callsite();
788 let callsite_span = self.span_from_span(callsite);
789 let callee = span.source_callee()?;
791 let mac_name = match callee.kind {
792 ExpnKind::Macro(kind, name) => match kind {
793 MacroKind::Bang => name,
795 // Ignore attribute macros, their spans are usually mangled
796 // FIXME(eddyb) is this really the case anymore?
797 MacroKind::Attr | MacroKind::Derive => return None,
800 // These are not macros.
801 // FIXME(eddyb) maybe there is a way to handle them usefully?
802 ExpnKind::Inlined | ExpnKind::Root | ExpnKind::AstPass(_) | ExpnKind::Desugaring(_) => {
807 let callee_span = self.span_from_span(callee.def_site);
810 qualname: mac_name.to_string(), // FIXME: generate the real qualname
815 fn lookup_def_id(&self, ref_id: hir::HirId) -> Option<DefId> {
816 match self.get_path_res(ref_id) {
817 Res::PrimTy(_) | Res::SelfTy(..) | Res::Err => None,
818 def => def.opt_def_id(),
822 fn docs_for_attrs(&self, attrs: &[ast::Attribute]) -> String {
823 let mut result = String::new();
826 if let Some((val, kind)) = attr.doc_str_and_comment_kind() {
827 // FIXME: Should save-analysis beautify doc strings itself or leave it to users?
828 result.push_str(beautify_doc_string(val, kind).as_str());
833 if !self.config.full_docs {
834 if let Some(index) = result.find("\n\n") {
835 result.truncate(index);
842 fn next_impl_id(&self) -> u32 {
843 let next = self.impl_counter.get();
844 self.impl_counter.set(next + 1);
849 // An AST visitor for collecting paths (e.g., the names of structs) and formal
850 // variables (idents) from patterns.
851 struct PathCollector<'l> {
853 collected_paths: Vec<(hir::HirId, &'l hir::QPath<'l>)>,
854 collected_idents: Vec<(hir::HirId, Ident, hir::Mutability)>,
857 impl<'l> PathCollector<'l> {
858 fn new(tcx: TyCtxt<'l>) -> PathCollector<'l> {
859 PathCollector { tcx, collected_paths: vec![], collected_idents: vec![] }
863 impl<'l> Visitor<'l> for PathCollector<'l> {
864 type NestedFilter = nested_filter::All;
866 fn nested_visit_map(&mut self) -> Self::Map {
870 fn visit_pat(&mut self, p: &'l hir::Pat<'l>) {
872 hir::PatKind::Struct(ref path, ..) => {
873 self.collected_paths.push((p.hir_id, path));
875 hir::PatKind::TupleStruct(ref path, ..) | hir::PatKind::Path(ref path) => {
876 self.collected_paths.push((p.hir_id, path));
878 hir::PatKind::Binding(bm, _, ident, _) => {
880 "PathCollector, visit ident in pat {}: {:?} {:?}",
881 ident, p.span, ident.span
883 let immut = match bm {
884 // Even if the ref is mut, you can't change the ref, only
885 // the data pointed at, so showing the initialising expression
886 // is still worthwhile.
887 hir::BindingAnnotation::Unannotated | hir::BindingAnnotation::Ref => {
890 hir::BindingAnnotation::Mutable | hir::BindingAnnotation::RefMut => {
894 self.collected_idents.push((p.hir_id, ident, immut));
898 intravisit::walk_pat(self, p);
902 /// Defines what to do with the results of saving the analysis.
903 pub trait SaveHandler {
904 fn save(&mut self, save_ctxt: &SaveContext<'_>, analysis: &Analysis);
907 /// Dump the save-analysis results to a file.
908 pub struct DumpHandler<'a> {
909 odir: Option<&'a Path>,
913 impl<'a> DumpHandler<'a> {
914 pub fn new(odir: Option<&'a Path>, cratename: &str) -> DumpHandler<'a> {
915 DumpHandler { odir, cratename: cratename.to_owned() }
918 fn output_file(&self, ctx: &SaveContext<'_>) -> (BufWriter<File>, PathBuf) {
919 let sess = &ctx.tcx.sess;
920 let file_name = match ctx.config.output_file {
921 Some(ref s) => PathBuf::from(s),
923 let mut root_path = match self.odir {
924 Some(val) => val.join("save-analysis"),
925 None => PathBuf::from("save-analysis-temp"),
928 if let Err(e) = std::fs::create_dir_all(&root_path) {
929 error!("Could not create directory {}: {}", root_path.display(), e);
932 let executable = sess.crate_types().iter().any(|ct| *ct == CrateType::Executable);
933 let mut out_name = if executable { String::new() } else { "lib".to_owned() };
934 out_name.push_str(&self.cratename);
935 out_name.push_str(&sess.opts.cg.extra_filename);
936 out_name.push_str(".json");
937 root_path.push(&out_name);
943 info!("Writing output to {}", file_name.display());
945 let output_file = BufWriter::new(File::create(&file_name).unwrap_or_else(|e| {
946 sess.fatal(&format!("Could not open {}: {}", file_name.display(), e))
949 (output_file, file_name)
953 impl SaveHandler for DumpHandler<'_> {
954 fn save(&mut self, save_ctxt: &SaveContext<'_>, analysis: &Analysis) {
955 let sess = &save_ctxt.tcx.sess;
956 let (output, file_name) = self.output_file(&save_ctxt);
957 if let Err(e) = serde_json::to_writer(output, &analysis) {
958 error!("Can't serialize save-analysis: {:?}", e);
961 if sess.opts.json_artifact_notifications {
962 sess.parse_sess.span_diagnostic.emit_artifact_notification(&file_name, "save-analysis");
967 /// Call a callback with the results of save-analysis.
968 pub struct CallbackHandler<'b> {
969 pub callback: &'b mut dyn FnMut(&rls_data::Analysis),
972 impl SaveHandler for CallbackHandler<'_> {
973 fn save(&mut self, _: &SaveContext<'_>, analysis: &Analysis) {
974 (self.callback)(analysis)
978 pub fn process_crate<'l, 'tcx, H: SaveHandler>(
982 config: Option<Config>,
985 with_no_trimmed_paths(|| {
986 tcx.dep_graph.with_ignore(|| {
987 info!("Dumping crate {}", cratename);
989 // Privacy checking must be done outside of type inference; use a
990 // fallback in case the access levels couldn't have been correctly computed.
991 let access_levels = match tcx.sess.compile_status() {
992 Ok(..) => tcx.privacy_access_levels(()),
993 Err(..) => tcx.arena.alloc(AccessLevels::default()),
996 let save_ctxt = SaveContext {
998 maybe_typeck_results: None,
999 access_levels: &access_levels,
1000 span_utils: SpanUtils::new(&tcx.sess),
1001 config: find_config(config),
1002 impl_counter: Cell::new(0),
1005 let mut visitor = DumpVisitor::new(save_ctxt);
1007 visitor.dump_crate_info(cratename);
1008 visitor.dump_compilation_options(input, cratename);
1009 visitor.process_crate();
1011 handler.save(&visitor.save_ctxt, &visitor.analysis())
1016 fn find_config(supplied: Option<Config>) -> Config {
1017 if let Some(config) = supplied {
1021 match env::var_os("RUST_SAVE_ANALYSIS_CONFIG") {
1022 None => Config::default(),
1023 Some(config) => config
1026 .map_err(|_| error!("`RUST_SAVE_ANALYSIS_CONFIG` isn't UTF-8"))
1028 serde_json::from_str(cfg)
1029 .map_err(|_| error!("Could not deserialize save-analysis config"))
1031 .unwrap_or_default(),
1035 // Utility functions for the module.
1037 // Helper function to escape quotes in a string
1038 fn escape(s: String) -> String {
1039 s.replace('\"', "\"\"")
1042 // Helper function to determine if a span came from a
1043 // macro expansion or syntax extension.
1044 fn generated_code(span: Span) -> bool {
1045 span.from_expansion() || span.is_dummy()
1048 // DefId::index is a newtype and so the JSON serialisation is ugly. Therefore
1049 // we use our own Id which is the same, but without the newtype.
1050 fn id_from_def_id(id: DefId) -> rls_data::Id {
1051 rls_data::Id { krate: id.krate.as_u32(), index: id.index.as_u32() }
1054 fn id_from_hir_id(id: hir::HirId, scx: &SaveContext<'_>) -> rls_data::Id {
1055 let def_id = scx.tcx.hir().opt_local_def_id(id);
1056 def_id.map(|id| id_from_def_id(id.to_def_id())).unwrap_or_else(|| {
1057 // Create a *fake* `DefId` out of a `HirId` by combining the owner
1058 // `local_def_index` and the `local_id`.
1059 // This will work unless you have *billions* of definitions in a single
1060 // crate (very unlikely to actually happen).
1062 krate: LOCAL_CRATE.as_u32(),
1063 index: id.owner.local_def_index.as_u32() | id.local_id.as_u32().reverse_bits(),
1068 fn null_id() -> rls_data::Id {
1069 rls_data::Id { krate: u32::MAX, index: u32::MAX }
1072 fn lower_attributes(attrs: Vec<ast::Attribute>, scx: &SaveContext<'_>) -> Vec<rls_data::Attribute> {
1075 // Only retain real attributes. Doc comments are lowered separately.
1076 .filter(|attr| !attr.has_name(sym::doc))
1078 // Remove the surrounding '#[..]' or '#![..]' of the pretty printed
1079 // attribute. First normalize all inner attribute (#![..]) to outer
1080 // ones (#[..]), then remove the two leading and the one trailing character.
1081 attr.style = ast::AttrStyle::Outer;
1082 let value = attribute_to_string(&attr);
1083 // This str slicing works correctly, because the leading and trailing characters
1084 // are in the ASCII range and thus exactly one byte each.
1085 let value = value[2..value.len() - 1].to_string();
1087 rls_data::Attribute { value, span: scx.span_from_span(attr.span) }