1 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")]
2 #![feature(if_let_guard)]
4 #![recursion_limit = "256"]
5 #![allow(rustc::potential_query_instability)]
6 #![feature(never_type)]
7 #![deny(rustc::untranslatable_diagnostic)]
8 #![deny(rustc::diagnostic_outside_of_impl)]
21 use rustc_ast::util::comments::beautify_doc_string;
22 use rustc_ast_pretty::pprust::attribute_to_string;
24 use rustc_hir::def::{DefKind as HirDefKind, Res};
25 use rustc_hir::def_id::{DefId, LOCAL_CRATE};
26 use rustc_hir::intravisit::{self, Visitor};
28 use rustc_hir_pretty::{enum_def_to_string, fn_to_string, ty_to_string};
29 use rustc_middle::hir::nested_filter;
30 use rustc_middle::middle::privacy::AccessLevels;
31 use rustc_middle::ty::{self, print::with_no_trimmed_paths, DefIdTree, TyCtxt};
32 use rustc_middle::{bug, span_bug};
33 use rustc_session::config::{CrateType, Input, OutputType};
34 use rustc_session::cstore::ExternCrate;
35 use rustc_session::output::{filename_for_metadata, out_filename};
36 use rustc_span::symbol::Ident;
40 use std::default::Default;
43 use std::io::BufWriter;
44 use std::path::{Path, PathBuf};
46 use dump_visitor::DumpVisitor;
47 use span_utils::SpanUtils;
49 use rls_data::config::Config;
51 Analysis, Def, DefKind, ExternalCrateData, GlobalCrateId, Impl, ImplKind, MacroRef, Ref,
52 RefKind, Relation, RelationKind, SpanData,
55 pub struct SaveContext<'tcx> {
57 maybe_typeck_results: Option<&'tcx ty::TypeckResults<'tcx>>,
58 access_levels: &'tcx AccessLevels,
59 span_utils: SpanUtils<'tcx>,
61 impl_counter: Cell<u32>,
68 RelationData(Relation, Impl),
71 impl<'tcx> SaveContext<'tcx> {
72 /// Gets the type-checking results for the current body.
73 /// As this will ICE if called outside bodies, only call when working with
74 /// `Expr` or `Pat` nodes (they are guaranteed to be found only in bodies).
76 fn typeck_results(&self) -> &'tcx ty::TypeckResults<'tcx> {
77 self.maybe_typeck_results.expect("`SaveContext::typeck_results` called outside of body")
80 fn span_from_span(&self, span: Span) -> SpanData {
81 use rls_span::{Column, Row};
83 let sm = self.tcx.sess.source_map();
84 let start = sm.lookup_char_pos(span.lo());
85 let end = sm.lookup_char_pos(span.hi());
88 file_name: start.file.name.prefer_remapped().to_string().into(),
89 byte_start: span.lo().0,
90 byte_end: span.hi().0,
91 line_start: Row::new_one_indexed(start.line as u32),
92 line_end: Row::new_one_indexed(end.line as u32),
93 column_start: Column::new_one_indexed(start.col.0 as u32 + 1),
94 column_end: Column::new_one_indexed(end.col.0 as u32 + 1),
98 // Returns path to the compilation output (e.g., libfoo-12345678.rmeta)
99 pub fn compilation_output(&self, crate_name: &str) -> PathBuf {
100 let sess = &self.tcx.sess;
101 // Save-analysis is emitted per whole session, not per each crate type
102 let crate_type = sess.crate_types()[0];
103 let outputs = &*self.tcx.output_filenames(());
105 if outputs.outputs.contains_key(&OutputType::Metadata) {
106 filename_for_metadata(sess, crate_name, outputs)
107 } else if outputs.outputs.should_codegen() {
108 out_filename(sess, crate_type, outputs, crate_name)
110 // Otherwise it's only a DepInfo, in which case we return early and
111 // not even reach the analysis stage.
116 // List external crates used by the current crate.
117 pub fn get_external_crates(&self) -> Vec<ExternalCrateData> {
118 let mut result = Vec::with_capacity(self.tcx.crates(()).len());
120 for &n in self.tcx.crates(()).iter() {
121 let Some(&ExternCrate { span, .. }) = self.tcx.extern_crate(n.as_def_id()) else {
122 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),
177 docs: self.docs_for_attrs(attrs),
178 sig: sig::foreign_item_signature(item, self),
179 attributes: lower_attributes(attrs.to_vec(), self),
182 hir::ForeignItemKind::Static(ref ty, _) => {
183 filter!(self.span_utils, item.ident.span);
185 let id = id_from_def_id(def_id);
186 let span = self.span_from_span(item.ident.span);
188 Some(Data::DefData(Def {
189 kind: DefKind::ForeignStatic,
192 name: item.ident.to_string(),
194 value: ty_to_string(ty),
198 docs: self.docs_for_attrs(attrs),
199 sig: sig::foreign_item_signature(item, self),
200 attributes: lower_attributes(attrs.to_vec(), self),
203 // FIXME(plietar): needs a new DefKind in rls-data
204 hir::ForeignItemKind::Type => None,
208 pub fn get_item_data(&self, item: &hir::Item<'_>) -> Option<Data> {
209 let def_id = item.def_id.to_def_id();
210 let attrs = self.tcx.hir().attrs(item.hir_id());
212 hir::ItemKind::Fn(ref sig, ref generics, _) => {
213 let qualname = format!("::{}", self.tcx.def_path_str(def_id));
214 filter!(self.span_utils, item.ident.span);
215 Some(Data::DefData(Def {
216 kind: DefKind::Function,
217 id: id_from_def_id(def_id),
218 span: self.span_from_span(item.ident.span),
219 name: item.ident.to_string(),
224 Some(item.ident.name),
232 docs: self.docs_for_attrs(attrs),
233 sig: sig::item_signature(item, self),
234 attributes: lower_attributes(attrs.to_vec(), self),
237 hir::ItemKind::Static(ref typ, ..) => {
238 let qualname = format!("::{}", self.tcx.def_path_str(def_id));
240 filter!(self.span_utils, item.ident.span);
242 let id = id_from_def_id(def_id);
243 let span = self.span_from_span(item.ident.span);
245 Some(Data::DefData(Def {
246 kind: DefKind::Static,
249 name: item.ident.to_string(),
251 value: ty_to_string(&typ),
255 docs: self.docs_for_attrs(attrs),
256 sig: sig::item_signature(item, self),
257 attributes: lower_attributes(attrs.to_vec(), self),
260 hir::ItemKind::Const(ref typ, _) => {
261 let qualname = format!("::{}", self.tcx.def_path_str(def_id));
262 filter!(self.span_utils, item.ident.span);
264 let id = id_from_def_id(def_id);
265 let span = self.span_from_span(item.ident.span);
267 Some(Data::DefData(Def {
268 kind: DefKind::Const,
271 name: item.ident.to_string(),
273 value: ty_to_string(typ),
277 docs: self.docs_for_attrs(attrs),
278 sig: sig::item_signature(item, self),
279 attributes: lower_attributes(attrs.to_vec(), self),
282 hir::ItemKind::Mod(ref m) => {
283 let qualname = format!("::{}", self.tcx.def_path_str(def_id));
285 let sm = self.tcx.sess.source_map();
286 let filename = sm.span_to_filename(m.spans.inner_span);
288 filter!(self.span_utils, item.ident.span);
290 Some(Data::DefData(Def {
292 id: id_from_def_id(def_id),
293 name: item.ident.to_string(),
295 span: self.span_from_span(item.ident.span),
296 value: filename.prefer_remapped().to_string(),
301 .map(|i| id_from_def_id(i.def_id.to_def_id()))
304 docs: self.docs_for_attrs(attrs),
305 sig: sig::item_signature(item, self),
306 attributes: lower_attributes(attrs.to_vec(), self),
309 hir::ItemKind::Enum(ref def, ref generics) => {
310 let name = item.ident.to_string();
311 let qualname = format!("::{}", self.tcx.def_path_str(def_id));
312 filter!(self.span_utils, item.ident.span);
314 enum_def_to_string(def, generics, item.ident.name, item.span);
315 Some(Data::DefData(Def {
317 id: id_from_def_id(def_id),
318 span: self.span_from_span(item.ident.span),
323 children: def.variants.iter().map(|v| id_from_hir_id(v.id, self)).collect(),
325 docs: self.docs_for_attrs(attrs),
326 sig: sig::item_signature(item, self),
327 attributes: lower_attributes(attrs.to_vec(), self),
330 hir::ItemKind::Impl(hir::Impl { ref of_trait, ref self_ty, ref items, .. })
331 if let hir::TyKind::Path(hir::QPath::Resolved(_, ref path)) = self_ty.kind =>
333 // Common case impl for a struct or something basic.
334 if generated_code(path.span) {
337 let sub_span = path.segments.last().unwrap().ident.span;
338 filter!(self.span_utils, sub_span);
340 let impl_id = self.next_impl_id();
341 let span = self.span_from_span(sub_span);
343 let type_data = self.lookup_def_id(self_ty.hir_id);
344 type_data.map(|type_data| {
347 kind: RelationKind::Impl { id: impl_id },
349 from: id_from_def_id(type_data),
352 .and_then(|t| self.lookup_def_id(t.hir_ref_id))
354 .unwrap_or_else(null_id),
358 kind: match *of_trait {
359 Some(_) => ImplKind::Direct,
360 None => ImplKind::Inherent,
363 value: String::new(),
367 .map(|i| id_from_def_id(i.id.def_id.to_def_id()))
376 hir::ItemKind::Impl(_) => None,
384 pub fn get_field_data(&self, field: &hir::FieldDef<'_>, scope: hir::HirId) -> Option<Def> {
385 let name = field.ident.to_string();
386 let scope_def_id = self.tcx.hir().local_def_id(scope).to_def_id();
387 let qualname = format!("::{}::{}", self.tcx.def_path_str(scope_def_id), field.ident);
388 filter!(self.span_utils, field.ident.span);
389 let field_def_id = self.tcx.hir().local_def_id(field.hir_id).to_def_id();
390 let typ = self.tcx.type_of(field_def_id).to_string();
392 let id = id_from_def_id(field_def_id);
393 let span = self.span_from_span(field.ident.span);
394 let attrs = self.tcx.hir().attrs(field.hir_id);
397 kind: DefKind::Field,
403 parent: Some(id_from_def_id(scope_def_id)),
406 docs: self.docs_for_attrs(attrs),
407 sig: sig::field_signature(field, self),
408 attributes: lower_attributes(attrs.to_vec(), self),
412 // FIXME would be nice to take a MethodItem here, but the ast provides both
413 // trait and impl flavours, so the caller must do the disassembly.
414 pub fn get_method_data(&self, hir_id: hir::HirId, ident: Ident, span: Span) -> Option<Def> {
415 // The qualname for a method is the trait name or name of the struct in an impl in
416 // which the method is declared in, followed by the method's name.
417 let def_id = self.tcx.hir().local_def_id(hir_id).to_def_id();
418 let (qualname, parent_scope, decl_id, docs, attributes) =
419 match self.tcx.impl_of_method(def_id) {
420 Some(impl_id) => match self.tcx.hir().get_if_local(impl_id) {
421 Some(Node::Item(item)) => match item.kind {
422 hir::ItemKind::Impl(hir::Impl { ref self_ty, .. }) => {
423 let hir = self.tcx.hir();
425 let mut qualname = String::from("<");
427 .push_str(&rustc_hir_pretty::id_to_string(&hir, self_ty.hir_id));
429 let trait_id = self.tcx.trait_id_of_impl(impl_id);
430 let mut docs = String::new();
431 let mut attrs = vec![];
432 if let Some(Node::ImplItem(_)) = hir.find(hir_id) {
433 attrs = self.tcx.hir().attrs(hir_id).to_vec();
434 docs = self.docs_for_attrs(&attrs);
437 let mut decl_id = None;
438 if let Some(def_id) = trait_id {
439 // A method in a trait impl.
440 qualname.push_str(" as ");
441 qualname.push_str(&self.tcx.def_path_str(def_id));
445 .associated_items(def_id)
446 .filter_by_name_unhygienic(ident.name)
448 .map(|item| item.def_id);
452 (qualname, trait_id, decl_id, docs, attrs)
457 "Container {:?} for method {} not an impl?",
466 "Container {:?} for method {} is not a node item {:?}",
473 None => match self.tcx.trait_of_item(def_id) {
475 let mut docs = String::new();
476 let mut attrs = vec![];
478 if let Some(Node::TraitItem(_)) = self.tcx.hir().find(hir_id) {
479 attrs = self.tcx.hir().attrs(hir_id).to_vec();
480 docs = self.docs_for_attrs(&attrs);
484 format!("::{}", self.tcx.def_path_str(def_id)),
492 debug!("could not find container for method {} at {:?}", hir_id, span);
493 // This is not necessarily a bug, if there was a compilation error,
494 // the typeck results we need might not exist.
500 let qualname = format!("{}::{}", qualname, ident.name);
502 filter!(self.span_utils, ident.span);
505 kind: DefKind::Method,
506 id: id_from_def_id(def_id),
507 span: self.span_from_span(ident.span),
508 name: ident.name.to_string(),
510 // FIXME you get better data here by using the visitor.
511 value: String::new(),
512 parent: parent_scope.map(id_from_def_id),
514 decl_id: decl_id.map(id_from_def_id),
517 attributes: lower_attributes(attributes, self),
521 pub fn get_expr_data(&self, expr: &hir::Expr<'_>) -> Option<Data> {
522 let ty = self.typeck_results().expr_ty_adjusted_opt(expr)?;
523 if matches!(ty.kind(), ty::Error(_)) {
527 hir::ExprKind::Field(ref sub_ex, ident) => {
528 match self.typeck_results().expr_ty_adjusted(&sub_ex).kind() {
529 ty::Adt(def, _) if !def.is_enum() => {
530 let variant = &def.non_enum_variant();
531 filter!(self.span_utils, ident.span);
532 let span = self.span_from_span(ident.span);
533 Some(Data::RefData(Ref {
534 kind: RefKind::Variable,
538 .find_field_index(ident, variant)
539 .map(|index| id_from_def_id(variant.fields[index].did))
540 .unwrap_or_else(null_id),
543 ty::Tuple(..) => None,
545 debug!("expected struct or union type, found {:?}", ty);
550 hir::ExprKind::Struct(qpath, ..) => match ty.kind() {
552 let sub_span = qpath.last_segment_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 debug!("expected adt, found {:?}", ty);
566 hir::ExprKind::MethodCall(ref seg, ..) => {
567 let Some(method_id) = self.typeck_results().type_dependent_def_id(expr.hir_id) else {
568 debug!("could not resolve method id for {:?}", expr);
571 let (def_id, decl_id) = match self.tcx.associated_item(method_id).container {
572 ty::ImplContainer => (Some(method_id), None),
573 ty::TraitContainer => (None, Some(method_id)),
575 let sub_span = seg.ident.span;
576 filter!(self.span_utils, sub_span);
577 let span = self.span_from_span(sub_span);
578 Some(Data::RefData(Ref {
579 kind: RefKind::Function,
581 ref_id: def_id.or(decl_id).map(id_from_def_id).unwrap_or_else(null_id),
584 hir::ExprKind::Path(ref path) => {
585 self.get_path_data(expr.hir_id, path).map(Data::RefData)
589 bug!("invalid expression: {:?}", expr);
594 pub fn get_path_res(&self, hir_id: hir::HirId) -> Res {
595 match self.tcx.hir().get(hir_id) {
596 Node::TraitRef(tr) => tr.path.res,
598 Node::Item(&hir::Item { kind: hir::ItemKind::Use(path, _), .. }) => path.res,
599 Node::PathSegment(seg) => {
600 if seg.res != Res::Err {
603 let parent_node = self.tcx.hir().get_parent_node(hir_id);
604 self.get_path_res(parent_node)
608 Node::Expr(&hir::Expr { kind: hir::ExprKind::Struct(ref qpath, ..), .. }) => {
609 self.typeck_results().qpath_res(qpath, hir_id)
612 Node::Expr(&hir::Expr { kind: hir::ExprKind::Path(ref qpath), .. })
613 | Node::Pat(&hir::Pat {
615 hir::PatKind::Path(ref qpath)
616 | hir::PatKind::Struct(ref qpath, ..)
617 | hir::PatKind::TupleStruct(ref qpath, ..),
620 | Node::Ty(&hir::Ty { kind: hir::TyKind::Path(ref qpath), .. }) => match qpath {
621 hir::QPath::Resolved(_, path) => path.res,
622 hir::QPath::TypeRelative(..) | hir::QPath::LangItem(..) => {
623 // #75962: `self.typeck_results` may be different from the `hir_id`'s result.
624 if self.tcx.has_typeck_results(hir_id.owner.to_def_id()) {
625 self.tcx.typeck(hir_id.owner).qpath_res(qpath, hir_id)
632 Node::Pat(&hir::Pat { kind: hir::PatKind::Binding(_, canonical_id, ..), .. }) => {
633 Res::Local(canonical_id)
640 pub fn get_path_data(&self, id: hir::HirId, path: &hir::QPath<'_>) -> Option<Ref> {
641 let segment = match path {
642 hir::QPath::Resolved(_, path) => path.segments.last(),
643 hir::QPath::TypeRelative(_, segment) => Some(*segment),
644 hir::QPath::LangItem(..) => None,
646 segment.and_then(|seg| {
647 self.get_path_segment_data(seg).or_else(|| self.get_path_segment_data_with_id(seg, id))
651 pub fn get_path_segment_data(&self, path_seg: &hir::PathSegment<'_>) -> Option<Ref> {
652 self.get_path_segment_data_with_id(path_seg, path_seg.hir_id)
655 pub fn get_path_segment_data_with_id(
657 path_seg: &hir::PathSegment<'_>,
660 // Returns true if the path is function type sugar, e.g., `Fn(A) -> B`.
661 fn fn_type(seg: &hir::PathSegment<'_>) -> bool {
662 seg.args.map_or(false, |args| args.parenthesized)
665 let res = self.get_path_res(id);
666 let span = path_seg.ident.span;
667 filter!(self.span_utils, span);
668 let span = self.span_from_span(span);
672 Some(Ref { kind: RefKind::Variable, span, ref_id: id_from_hir_id(id, self) })
674 Res::Def(HirDefKind::Trait, def_id) if fn_type(path_seg) => {
675 Some(Ref { kind: RefKind::Type, span, ref_id: id_from_def_id(def_id) })
679 | HirDefKind::Variant
682 | HirDefKind::TyAlias
683 | HirDefKind::ForeignTy
684 | HirDefKind::TraitAlias
685 | HirDefKind::AssocTy
687 | HirDefKind::OpaqueTy
688 | HirDefKind::ImplTraitPlaceholder
689 | HirDefKind::TyParam,
691 ) => Some(Ref { kind: RefKind::Type, span, ref_id: id_from_def_id(def_id) }),
692 Res::Def(HirDefKind::ConstParam, def_id) => {
693 Some(Ref { kind: RefKind::Variable, span, ref_id: id_from_def_id(def_id) })
695 Res::Def(HirDefKind::Ctor(..), def_id) => {
696 // This is a reference to a tuple struct or an enum variant where the def_id points
697 // to an invisible constructor function. That is not a very useful
698 // def, so adjust to point to the tuple struct or enum variant itself.
699 let parent_def_id = self.tcx.parent(def_id);
700 Some(Ref { kind: RefKind::Type, span, ref_id: id_from_def_id(parent_def_id) })
702 Res::Def(HirDefKind::Static(_) | HirDefKind::Const | HirDefKind::AssocConst, _) => {
703 Some(Ref { kind: RefKind::Variable, span, ref_id: id_from_def_id(res.def_id()) })
705 Res::Def(HirDefKind::AssocFn, decl_id) => {
706 let def_id = if decl_id.is_local() {
707 if self.tcx.impl_defaultness(decl_id).has_value() {
716 kind: RefKind::Function,
718 ref_id: id_from_def_id(def_id.unwrap_or(decl_id)),
721 Res::Def(HirDefKind::Fn, def_id) => {
722 Some(Ref { kind: RefKind::Function, span, ref_id: id_from_def_id(def_id) })
724 Res::Def(HirDefKind::Mod, def_id) => {
725 Some(Ref { kind: RefKind::Mod, span, ref_id: id_from_def_id(def_id) })
729 HirDefKind::Macro(..)
730 | HirDefKind::ExternCrate
731 | HirDefKind::ForeignMod
732 | HirDefKind::LifetimeParam
733 | HirDefKind::AnonConst
734 | HirDefKind::InlineConst
737 | HirDefKind::GlobalAsm
739 | HirDefKind::Closure
740 | HirDefKind::Generator,
746 | Res::NonMacroAttr(..)
752 pub fn get_field_ref_data(
754 field_ref: &hir::ExprField<'_>,
755 variant: &ty::VariantDef,
757 filter!(self.span_utils, field_ref.ident.span);
758 self.tcx.find_field_index(field_ref.ident, variant).map(|index| {
759 let span = self.span_from_span(field_ref.ident.span);
760 Ref { kind: RefKind::Variable, span, ref_id: id_from_def_id(variant.fields[index].did) }
764 /// Attempt to return MacroRef for any AST node.
766 /// For a given piece of AST defined by the supplied Span and NodeId,
767 /// returns `None` if the node is not macro-generated or the span is malformed,
768 /// else uses the expansion callsite and callee to return some MacroRef.
770 /// FIXME: [`DumpVisitor::process_macro_use`] should actually dump this data
772 fn get_macro_use_data(&self, span: Span) -> Option<MacroRef> {
773 if !generated_code(span) {
776 // Note we take care to use the source callsite/callee, to handle
777 // nested expansions and ensure we only generate data for source-visible
779 let callsite = span.source_callsite();
780 let callsite_span = self.span_from_span(callsite);
781 let callee = span.source_callee()?;
783 let mac_name = match callee.kind {
784 ExpnKind::Macro(kind, name) => match kind {
785 MacroKind::Bang => name,
787 // Ignore attribute macros, their spans are usually mangled
788 // FIXME(eddyb) is this really the case anymore?
789 MacroKind::Attr | MacroKind::Derive => return None,
792 // These are not macros.
793 // FIXME(eddyb) maybe there is a way to handle them usefully?
794 ExpnKind::Inlined | ExpnKind::Root | ExpnKind::AstPass(_) | ExpnKind::Desugaring(_) => {
799 let callee_span = self.span_from_span(callee.def_site);
802 qualname: mac_name.to_string(), // FIXME: generate the real qualname
807 fn lookup_def_id(&self, ref_id: hir::HirId) -> Option<DefId> {
808 match self.get_path_res(ref_id) {
809 Res::PrimTy(_) | Res::SelfTy { .. } | Res::Err => None,
810 def => def.opt_def_id(),
814 fn docs_for_attrs(&self, attrs: &[ast::Attribute]) -> String {
815 let mut result = String::new();
818 if let Some((val, kind)) = attr.doc_str_and_comment_kind() {
819 // FIXME: Should save-analysis beautify doc strings itself or leave it to users?
820 result.push_str(beautify_doc_string(val, kind).as_str());
825 if !self.config.full_docs {
826 if let Some(index) = result.find("\n\n") {
827 result.truncate(index);
834 fn next_impl_id(&self) -> u32 {
835 let next = self.impl_counter.get();
836 self.impl_counter.set(next + 1);
841 // An AST visitor for collecting paths (e.g., the names of structs) and formal
842 // variables (idents) from patterns.
843 struct PathCollector<'l> {
845 collected_paths: Vec<(hir::HirId, &'l hir::QPath<'l>)>,
846 collected_idents: Vec<(hir::HirId, Ident, hir::Mutability)>,
849 impl<'l> PathCollector<'l> {
850 fn new(tcx: TyCtxt<'l>) -> PathCollector<'l> {
851 PathCollector { tcx, collected_paths: vec![], collected_idents: vec![] }
855 impl<'l> Visitor<'l> for PathCollector<'l> {
856 type NestedFilter = nested_filter::All;
858 fn nested_visit_map(&mut self) -> Self::Map {
862 fn visit_pat(&mut self, p: &'l hir::Pat<'l>) {
864 hir::PatKind::Struct(ref path, ..) => {
865 self.collected_paths.push((p.hir_id, path));
867 hir::PatKind::TupleStruct(ref path, ..) | hir::PatKind::Path(ref path) => {
868 self.collected_paths.push((p.hir_id, path));
870 hir::PatKind::Binding(hir::BindingAnnotation(_, mutbl), _, ident, _) => {
872 "PathCollector, visit ident in pat {}: {:?} {:?}",
873 ident, p.span, ident.span
875 self.collected_idents.push((p.hir_id, ident, mutbl));
879 intravisit::walk_pat(self, p);
883 /// Defines what to do with the results of saving the analysis.
884 pub trait SaveHandler {
885 fn save(&mut self, save_ctxt: &SaveContext<'_>, analysis: &Analysis);
888 /// Dump the save-analysis results to a file.
889 pub struct DumpHandler<'a> {
890 odir: Option<&'a Path>,
894 impl<'a> DumpHandler<'a> {
895 pub fn new(odir: Option<&'a Path>, cratename: &str) -> DumpHandler<'a> {
896 DumpHandler { odir, cratename: cratename.to_owned() }
899 fn output_file(&self, ctx: &SaveContext<'_>) -> (BufWriter<File>, PathBuf) {
900 let sess = &ctx.tcx.sess;
901 let file_name = match ctx.config.output_file {
902 Some(ref s) => PathBuf::from(s),
904 let mut root_path = match self.odir {
905 Some(val) => val.join("save-analysis"),
906 None => PathBuf::from("save-analysis-temp"),
909 if let Err(e) = std::fs::create_dir_all(&root_path) {
910 error!("Could not create directory {}: {}", root_path.display(), e);
913 let executable = sess.crate_types().iter().any(|ct| *ct == CrateType::Executable);
914 let mut out_name = if executable { String::new() } else { "lib".to_owned() };
915 out_name.push_str(&self.cratename);
916 out_name.push_str(&sess.opts.cg.extra_filename);
917 out_name.push_str(".json");
918 root_path.push(&out_name);
924 info!("Writing output to {}", file_name.display());
926 let output_file = BufWriter::new(File::create(&file_name).unwrap_or_else(|e| {
927 sess.emit_fatal(errors::CouldNotOpen { file_name: file_name.as_path(), err: e })
930 (output_file, file_name)
934 impl SaveHandler for DumpHandler<'_> {
935 fn save(&mut self, save_ctxt: &SaveContext<'_>, analysis: &Analysis) {
936 let sess = &save_ctxt.tcx.sess;
937 let (output, file_name) = self.output_file(&save_ctxt);
938 if let Err(e) = serde_json::to_writer(output, &analysis) {
939 error!("Can't serialize save-analysis: {:?}", e);
942 if sess.opts.json_artifact_notifications {
943 sess.parse_sess.span_diagnostic.emit_artifact_notification(&file_name, "save-analysis");
948 /// Call a callback with the results of save-analysis.
949 pub struct CallbackHandler<'b> {
950 pub callback: &'b mut dyn FnMut(&rls_data::Analysis),
953 impl SaveHandler for CallbackHandler<'_> {
954 fn save(&mut self, _: &SaveContext<'_>, analysis: &Analysis) {
955 (self.callback)(analysis)
959 pub fn process_crate<'l, 'tcx, H: SaveHandler>(
963 config: Option<Config>,
966 with_no_trimmed_paths!({
967 tcx.dep_graph.with_ignore(|| {
968 info!("Dumping crate {}", cratename);
970 // Privacy checking must be done outside of type inference; use a
971 // fallback in case the access levels couldn't have been correctly computed.
972 let access_levels = match tcx.sess.compile_status() {
973 Ok(..) => tcx.privacy_access_levels(()),
974 Err(..) => tcx.arena.alloc(AccessLevels::default()),
977 let save_ctxt = SaveContext {
979 maybe_typeck_results: None,
980 access_levels: &access_levels,
981 span_utils: SpanUtils::new(&tcx.sess),
982 config: find_config(config),
983 impl_counter: Cell::new(0),
986 let mut visitor = DumpVisitor::new(save_ctxt);
988 visitor.dump_crate_info(cratename);
989 visitor.dump_compilation_options(input, cratename);
990 visitor.process_crate();
992 handler.save(&visitor.save_ctxt, &visitor.analysis())
997 fn find_config(supplied: Option<Config>) -> Config {
998 if let Some(config) = supplied {
1002 match env::var_os("RUST_SAVE_ANALYSIS_CONFIG") {
1003 None => Config::default(),
1004 Some(config) => config
1007 .map_err(|_| error!("`RUST_SAVE_ANALYSIS_CONFIG` isn't UTF-8"))
1009 serde_json::from_str(cfg)
1010 .map_err(|_| error!("Could not deserialize save-analysis config"))
1012 .unwrap_or_default(),
1016 // Utility functions for the module.
1018 // Helper function to escape quotes in a string
1019 fn escape(s: String) -> String {
1020 s.replace('\"', "\"\"")
1023 // Helper function to determine if a span came from a
1024 // macro expansion or syntax extension.
1025 fn generated_code(span: Span) -> bool {
1026 span.from_expansion() || span.is_dummy()
1029 // DefId::index is a newtype and so the JSON serialisation is ugly. Therefore
1030 // we use our own Id which is the same, but without the newtype.
1031 fn id_from_def_id(id: DefId) -> rls_data::Id {
1032 rls_data::Id { krate: id.krate.as_u32(), index: id.index.as_u32() }
1035 fn id_from_hir_id(id: hir::HirId, scx: &SaveContext<'_>) -> rls_data::Id {
1036 let def_id = scx.tcx.hir().opt_local_def_id(id);
1037 def_id.map(|id| id_from_def_id(id.to_def_id())).unwrap_or_else(|| {
1038 // Create a *fake* `DefId` out of a `HirId` by combining the owner
1039 // `local_def_index` and the `local_id`.
1040 // This will work unless you have *billions* of definitions in a single
1041 // crate (very unlikely to actually happen).
1043 krate: LOCAL_CRATE.as_u32(),
1044 index: id.owner.local_def_index.as_u32() | id.local_id.as_u32().reverse_bits(),
1049 fn null_id() -> rls_data::Id {
1050 rls_data::Id { krate: u32::MAX, index: u32::MAX }
1053 fn lower_attributes(attrs: Vec<ast::Attribute>, scx: &SaveContext<'_>) -> Vec<rls_data::Attribute> {
1056 // Only retain real attributes. Doc comments are lowered separately.
1057 .filter(|attr| !attr.has_name(sym::doc))
1059 // Remove the surrounding '#[..]' or '#![..]' of the pretty printed
1060 // attribute. First normalize all inner attribute (#![..]) to outer
1061 // ones (#[..]), then remove the two leading and the one trailing character.
1062 attr.style = ast::AttrStyle::Outer;
1063 let value = attribute_to_string(&attr);
1064 // This str slicing works correctly, because the leading and trailing characters
1065 // are in the ASCII range and thus exactly one byte each.
1066 let value = value[2..value.len() - 1].to_string();
1068 rls_data::Attribute { value, span: scx.span_from_span(attr.span) }