1 //! Support for inlining external documentation into the current AST.
7 use rustc_data_structures::fx::FxHashSet;
8 use rustc_data_structures::thin_vec::ThinVec;
10 use rustc_hir::def::{DefKind, Res};
11 use rustc_hir::def_id::DefId;
12 use rustc_hir::Mutability;
13 use rustc_metadata::creader::{CStore, LoadedMacro};
14 use rustc_middle::ty::{self, TyCtxt};
15 use rustc_span::hygiene::MacroKind;
16 use rustc_span::symbol::{kw, sym, Symbol};
19 self, clean_fn_decl_from_did_and_sig, clean_ty_generics, utils, Attributes, AttributesExt,
20 Clean, ImplKind, ItemId, Type, Visibility,
22 use crate::core::DocContext;
23 use crate::formats::item_type::ItemType;
25 type Attrs<'hir> = &'hir [ast::Attribute];
27 /// Attempt to inline a definition into this AST.
29 /// This function will fetch the definition specified, and if it is
30 /// from another crate it will attempt to inline the documentation
31 /// from the other crate into this crate.
33 /// This is primarily used for `pub use` statements which are, in general,
34 /// implementation details. Inlining the documentation should help provide a
35 /// better experience when reading the documentation in this use case.
37 /// The returned value is `None` if the definition could not be inlined,
38 /// and `Some` of a vector of items if it was successfully expanded.
40 /// `parent_module` refers to the parent of the *re-export*, not the original item.
41 pub(crate) fn try_inline(
42 cx: &mut DocContext<'_>,
44 import_def_id: Option<DefId>,
47 attrs: Option<Attrs<'_>>,
48 visited: &mut FxHashSet<DefId>,
49 ) -> Option<Vec<clean::Item>> {
50 let did = res.opt_def_id()?;
54 let mut ret = Vec::new();
56 debug!("attrs={:?}", attrs);
57 let attrs_clone = attrs;
59 let kind = match res {
60 Res::Def(DefKind::Trait, did) => {
61 record_extern_fqn(cx, did, ItemType::Trait);
62 build_impls(cx, Some(parent_module), did, attrs, &mut ret);
63 clean::TraitItem(build_external_trait(cx, did))
65 Res::Def(DefKind::Fn, did) => {
66 record_extern_fqn(cx, did, ItemType::Function);
67 clean::FunctionItem(build_external_function(cx, did))
69 Res::Def(DefKind::Struct, did) => {
70 record_extern_fqn(cx, did, ItemType::Struct);
71 build_impls(cx, Some(parent_module), did, attrs, &mut ret);
72 clean::StructItem(build_struct(cx, did))
74 Res::Def(DefKind::Union, did) => {
75 record_extern_fqn(cx, did, ItemType::Union);
76 build_impls(cx, Some(parent_module), did, attrs, &mut ret);
77 clean::UnionItem(build_union(cx, did))
79 Res::Def(DefKind::TyAlias, did) => {
80 record_extern_fqn(cx, did, ItemType::Typedef);
81 build_impls(cx, Some(parent_module), did, attrs, &mut ret);
82 clean::TypedefItem(build_type_alias(cx, did))
84 Res::Def(DefKind::Enum, did) => {
85 record_extern_fqn(cx, did, ItemType::Enum);
86 build_impls(cx, Some(parent_module), did, attrs, &mut ret);
87 clean::EnumItem(build_enum(cx, did))
89 Res::Def(DefKind::ForeignTy, did) => {
90 record_extern_fqn(cx, did, ItemType::ForeignType);
91 build_impls(cx, Some(parent_module), did, attrs, &mut ret);
92 clean::ForeignTypeItem
94 // Never inline enum variants but leave them shown as re-exports.
95 Res::Def(DefKind::Variant, _) => return None,
96 // Assume that enum variants and struct types are re-exported next to
97 // their constructors.
98 Res::Def(DefKind::Ctor(..), _) | Res::SelfCtor(..) => return Some(Vec::new()),
99 Res::Def(DefKind::Mod, did) => {
100 record_extern_fqn(cx, did, ItemType::Module);
101 clean::ModuleItem(build_module(cx, did, visited))
103 Res::Def(DefKind::Static(_), did) => {
104 record_extern_fqn(cx, did, ItemType::Static);
105 clean::StaticItem(build_static(cx, did, cx.tcx.is_mutable_static(did)))
107 Res::Def(DefKind::Const, did) => {
108 record_extern_fqn(cx, did, ItemType::Constant);
109 clean::ConstantItem(build_const(cx, did))
111 Res::Def(DefKind::Macro(kind), did) => {
112 let mac = build_macro(cx, did, name, import_def_id);
114 let type_kind = match kind {
115 MacroKind::Bang => ItemType::Macro,
116 MacroKind::Attr => ItemType::ProcAttribute,
117 MacroKind::Derive => ItemType::ProcDerive,
119 record_extern_fqn(cx, did, type_kind);
125 let (attrs, cfg) = merge_attrs(cx, Some(parent_module), load_attrs(cx, did), attrs_clone);
126 cx.inlined.insert(did.into());
127 let mut item = clean::Item::from_def_id_and_attrs_and_parts(
135 if let Some(import_def_id) = import_def_id {
136 // The visibility needs to reflect the one from the reexport and not from the "source" DefId.
137 item.visibility = cx.tcx.visibility(import_def_id).clean(cx);
143 pub(crate) fn try_inline_glob(
144 cx: &mut DocContext<'_>,
146 visited: &mut FxHashSet<DefId>,
147 ) -> Option<Vec<clean::Item>> {
148 let did = res.opt_def_id()?;
154 Res::Def(DefKind::Mod, did) => {
155 let m = build_module(cx, did, visited);
158 // glob imports on things like enums aren't inlined even for local exports, so just bail
163 pub(crate) fn load_attrs<'hir>(cx: &DocContext<'hir>, did: DefId) -> Attrs<'hir> {
164 cx.tcx.get_attrs_unchecked(did)
167 /// Record an external fully qualified name in the external_paths cache.
169 /// These names are used later on by HTML rendering to generate things like
170 /// source links back to the original item.
171 pub(crate) fn record_extern_fqn(cx: &mut DocContext<'_>, did: DefId, kind: ItemType) {
172 let crate_name = cx.tcx.crate_name(did.krate);
175 cx.tcx.def_path(did).data.into_iter().filter_map(|elem| elem.data.get_opt_name());
176 let fqn = if let ItemType::Macro = kind {
177 // Check to see if it is a macro 2.0 or built-in macro
179 CStore::from_tcx(cx.tcx).load_macro_untracked(did, cx.sess()),
180 LoadedMacro::MacroDef(def, _)
181 if matches!(&def.kind, ast::ItemKind::MacroDef(ast_def)
182 if !ast_def.macro_rules)
184 once(crate_name).chain(relative).collect()
186 vec![crate_name, relative.last().expect("relative was empty")]
189 once(crate_name).chain(relative).collect()
193 cx.cache.exact_paths.insert(did, fqn);
195 cx.cache.external_paths.insert(did, (fqn, kind));
199 pub(crate) fn build_external_trait(cx: &mut DocContext<'_>, did: DefId) -> clean::Trait {
202 .associated_items(did)
203 .in_definition_order()
205 // When building an external trait, the cleaned trait will have all items public,
206 // which causes methods to have a `pub` prefix, which is invalid since items in traits
207 // can not have a visibility prefix. Thus we override the visibility here manually.
208 // See https://github.com/rust-lang/rust/issues/81274
209 clean::Item { visibility: Visibility::Inherited, ..item.clean(cx) }
213 let predicates = cx.tcx.predicates_of(did);
214 let generics = clean_ty_generics(cx, cx.tcx.generics_of(did), predicates);
215 let generics = filter_non_trait_generics(did, generics);
216 let (generics, supertrait_bounds) = separate_supertrait_bounds(generics);
217 let is_auto = cx.tcx.trait_is_auto(did);
219 unsafety: cx.tcx.trait_def(did).unsafety,
222 bounds: supertrait_bounds,
227 fn build_external_function<'tcx>(cx: &mut DocContext<'tcx>, did: DefId) -> clean::Function {
228 let sig = cx.tcx.fn_sig(did);
230 let predicates = cx.tcx.predicates_of(did);
231 let (generics, decl) = clean::enter_impl_trait(cx, |cx| {
232 // NOTE: generics need to be cleaned before the decl!
233 let generics = clean_ty_generics(cx, cx.tcx.generics_of(did), predicates);
234 let decl = clean_fn_decl_from_did_and_sig(cx, Some(did), sig);
237 clean::Function { decl, generics }
240 fn build_enum(cx: &mut DocContext<'_>, did: DefId) -> clean::Enum {
241 let predicates = cx.tcx.explicit_predicates_of(did);
244 generics: clean_ty_generics(cx, cx.tcx.generics_of(did), predicates),
245 variants: cx.tcx.adt_def(did).variants().iter().map(|v| v.clean(cx)).collect(),
249 fn build_struct(cx: &mut DocContext<'_>, did: DefId) -> clean::Struct {
250 let predicates = cx.tcx.explicit_predicates_of(did);
251 let variant = cx.tcx.adt_def(did).non_enum_variant();
254 struct_type: variant.ctor_kind,
255 generics: clean_ty_generics(cx, cx.tcx.generics_of(did), predicates),
256 fields: variant.fields.iter().map(|x| x.clean(cx)).collect(),
260 fn build_union(cx: &mut DocContext<'_>, did: DefId) -> clean::Union {
261 let predicates = cx.tcx.explicit_predicates_of(did);
262 let variant = cx.tcx.adt_def(did).non_enum_variant();
264 let generics = clean_ty_generics(cx, cx.tcx.generics_of(did), predicates);
265 let fields = variant.fields.iter().map(|x| x.clean(cx)).collect();
266 clean::Union { generics, fields }
269 fn build_type_alias(cx: &mut DocContext<'_>, did: DefId) -> clean::Typedef {
270 let predicates = cx.tcx.explicit_predicates_of(did);
271 let type_ = cx.tcx.type_of(did).clean(cx);
275 generics: clean_ty_generics(cx, cx.tcx.generics_of(did), predicates),
280 /// Builds all inherent implementations of an ADT (struct/union/enum) or Trait item/path/reexport.
281 pub(crate) fn build_impls(
282 cx: &mut DocContext<'_>,
283 parent_module: Option<DefId>,
285 attrs: Option<Attrs<'_>>,
286 ret: &mut Vec<clean::Item>,
288 let _prof_timer = cx.tcx.sess.prof.generic_activity("build_inherent_impls");
291 // for each implementation of an item represented by `did`, build the clean::Item for that impl
292 for &did in tcx.inherent_impls(did).iter() {
293 build_impl(cx, parent_module, did, attrs, ret);
297 /// `parent_module` refers to the parent of the re-export, not the original item
299 cx: &mut DocContext<'_>,
300 parent_module: Option<DefId>,
301 old_attrs: Attrs<'_>,
302 new_attrs: Option<Attrs<'_>>,
303 ) -> (clean::Attributes, Option<Arc<clean::cfg::Cfg>>) {
304 // NOTE: If we have additional attributes (from a re-export),
305 // always insert them first. This ensure that re-export
306 // doc comments show up before the original doc comments
307 // when we render them.
308 if let Some(inner) = new_attrs {
309 let mut both = inner.to_vec();
310 both.extend_from_slice(old_attrs);
312 if let Some(new_id) = parent_module {
313 Attributes::from_ast(old_attrs, Some((inner, new_id)))
315 Attributes::from_ast(&both, None)
317 both.cfg(cx.tcx, &cx.cache.hidden_cfg),
320 (old_attrs.clean(cx), old_attrs.cfg(cx.tcx, &cx.cache.hidden_cfg))
324 /// Inline an `impl`, inherent or of a trait. The `did` must be for an `impl`.
325 pub(crate) fn build_impl(
326 cx: &mut DocContext<'_>,
327 parent_module: Option<DefId>,
329 attrs: Option<Attrs<'_>>,
330 ret: &mut Vec<clean::Item>,
332 if !cx.inlined.insert(did.into()) {
336 let _prof_timer = cx.tcx.sess.prof.generic_activity("build_impl");
339 let associated_trait = tcx.impl_trait_ref(did);
341 // Only inline impl if the implemented trait is
342 // reachable in rustdoc generated documentation
344 if let Some(traitref) = associated_trait {
345 let did = traitref.def_id;
346 if !cx.cache.access_levels.is_public(did) {
350 if let Some(stab) = tcx.lookup_stability(did) {
351 if stab.is_unstable() && stab.feature == sym::rustc_private {
358 let impl_item = match did.as_local() {
359 Some(did) => match &tcx.hir().expect_item(did).kind {
360 hir::ItemKind::Impl(impl_) => Some(impl_),
361 _ => panic!("`DefID` passed to `build_impl` is not an `impl"),
366 let for_ = match &impl_item {
367 Some(impl_) => impl_.self_ty.clean(cx),
368 None => tcx.type_of(did).clean(cx),
371 // Only inline impl if the implementing type is
372 // reachable in rustdoc generated documentation
374 if let Some(did) = for_.def_id(&cx.cache) {
375 if !cx.cache.access_levels.is_public(did) {
379 if let Some(stab) = tcx.lookup_stability(did) {
380 if stab.is_unstable() && stab.feature == sym::rustc_private {
387 let document_hidden = cx.render_options.document_hidden;
388 let predicates = tcx.explicit_predicates_of(did);
389 let (trait_items, generics) = match impl_item {
394 .map(|item| tcx.hir().impl_item(item.id))
396 // Filter out impl items whose corresponding trait item has `doc(hidden)`
397 // not to document such impl items.
398 // For inherent impls, we don't do any filtering, because that's already done in strip_hidden.rs.
400 // When `--document-hidden-items` is passed, we don't
401 // do any filtering, too.
405 if let Some(associated_trait) = associated_trait {
406 let assoc_kind = match item.kind {
407 hir::ImplItemKind::Const(..) => ty::AssocKind::Const,
408 hir::ImplItemKind::Fn(..) => ty::AssocKind::Fn,
409 hir::ImplItemKind::TyAlias(..) => ty::AssocKind::Type,
412 .associated_items(associated_trait.def_id)
413 .find_by_name_and_kind(
417 associated_trait.def_id,
419 .unwrap(); // SAFETY: For all impl items there exists trait item that has the same name.
420 !tcx.is_doc_hidden(trait_item.def_id)
425 .map(|item| item.clean(cx))
426 .collect::<Vec<_>>(),
427 impl_.generics.clean(cx),
430 tcx.associated_items(did)
431 .in_definition_order()
433 // If this is a trait impl, filter out associated items whose corresponding item
434 // in the associated trait is marked `doc(hidden)`.
435 // If this is an inherent impl, filter out private associated items.
436 if let Some(associated_trait) = associated_trait {
438 .associated_items(associated_trait.def_id)
439 .find_by_name_and_kind(
443 associated_trait.def_id,
445 .unwrap(); // corresponding associated item has to exist
446 !tcx.is_doc_hidden(trait_item.def_id)
451 .map(|item| item.clean(cx))
452 .collect::<Vec<_>>(),
453 clean::enter_impl_trait(cx, |cx| {
454 clean_ty_generics(cx, tcx.generics_of(did), predicates)
458 let polarity = tcx.impl_polarity(did);
459 let trait_ = associated_trait.map(|t| t.clean(cx));
460 if trait_.as_ref().map(|t| t.def_id()) == tcx.lang_items().deref_trait() {
461 super::build_deref_target_impls(cx, &trait_items, ret);
464 // Return if the trait itself or any types of the generic parameters are doc(hidden).
465 let mut stack: Vec<&Type> = vec![&for_];
467 if let Some(did) = trait_.as_ref().map(|t| t.def_id()) {
468 if tcx.is_doc_hidden(did) {
472 if let Some(generics) = trait_.as_ref().and_then(|t| t.generics()) {
473 stack.extend(generics);
476 while let Some(ty) = stack.pop() {
477 if let Some(did) = ty.def_id(&cx.cache) {
478 if tcx.is_doc_hidden(did) {
482 if let Some(generics) = ty.generics() {
483 stack.extend(generics);
487 if let Some(did) = trait_.as_ref().map(|t| t.def_id()) {
488 record_extern_trait(cx, did);
491 let (merged_attrs, cfg) = merge_attrs(cx, parent_module, load_attrs(cx, did), attrs);
492 trace!("merged_attrs={:?}", merged_attrs);
495 "build_impl: impl {:?} for {:?}",
496 trait_.as_ref().map(|t| t.def_id()),
497 for_.def_id(&cx.cache)
499 ret.push(clean::Item::from_def_id_and_attrs_and_parts(
502 clean::ImplItem(clean::Impl {
503 unsafety: hir::Unsafety::Normal,
509 kind: if utils::has_doc_flag(tcx, did, sym::fake_variadic) {
510 ImplKind::FakeVaradic
515 Box::new(merged_attrs),
522 cx: &mut DocContext<'_>,
524 visited: &mut FxHashSet<DefId>,
526 let mut items = Vec::new();
528 // If we're re-exporting a re-export it may actually re-export something in
529 // two namespaces, so the target may be listed twice. Make sure we only
530 // visit each node at most once.
531 for &item in cx.tcx.module_children(did).iter() {
532 if item.vis.is_public() {
533 let res = item.res.expect_non_local();
534 if let Some(def_id) = res.mod_def_id() {
535 if did == def_id || !visited.insert(def_id) {
539 if let Res::PrimTy(p) = res {
540 // Primitive types can't be inlined so generate an import instead.
541 let prim_ty = clean::PrimitiveType::from(p);
542 items.push(clean::Item {
544 attrs: Box::new(clean::Attributes::default()),
545 item_id: ItemId::Primitive(prim_ty, did.krate),
546 visibility: clean::Public,
547 kind: box clean::ImportItem(clean::Import::new_simple(
549 clean::ImportSource {
552 segments: vec![clean::PathSegment {
553 name: prim_ty.as_sym(),
554 args: clean::GenericArgs::AngleBracketed {
555 args: Default::default(),
556 bindings: ThinVec::new(),
566 } else if let Some(i) = try_inline(cx, did, None, res, item.ident.name, None, visited) {
572 let span = clean::Span::new(cx.tcx.def_span(did));
573 clean::Module { items, span }
576 pub(crate) fn print_inlined_const(tcx: TyCtxt<'_>, did: DefId) -> String {
577 if let Some(did) = did.as_local() {
578 let hir_id = tcx.hir().local_def_id_to_hir_id(did);
579 rustc_hir_pretty::id_to_string(&tcx.hir(), hir_id)
581 tcx.rendered_const(did).clone()
585 fn build_const(cx: &mut DocContext<'_>, def_id: DefId) -> clean::Constant {
587 type_: cx.tcx.type_of(def_id).clean(cx),
588 kind: clean::ConstantKind::Extern { def_id },
592 fn build_static(cx: &mut DocContext<'_>, did: DefId, mutable: bool) -> clean::Static {
594 type_: cx.tcx.type_of(did).clean(cx),
595 mutability: if mutable { Mutability::Mut } else { Mutability::Not },
601 cx: &mut DocContext<'_>,
604 import_def_id: Option<DefId>,
605 ) -> clean::ItemKind {
606 match CStore::from_tcx(cx.tcx).load_macro_untracked(def_id, cx.sess()) {
607 LoadedMacro::MacroDef(item_def, _) => {
608 if let ast::ItemKind::MacroDef(ref def) = item_def.kind {
609 let vis = cx.tcx.visibility(import_def_id.unwrap_or(def_id)).clean(cx);
610 clean::MacroItem(clean::Macro {
611 source: utils::display_macro_source(cx, name, def, def_id, vis),
617 LoadedMacro::ProcMacro(ext) => clean::ProcMacroItem(clean::ProcMacro {
618 kind: ext.macro_kind(),
619 helpers: ext.helper_attrs,
624 /// A trait's generics clause actually contains all of the predicates for all of
625 /// its associated types as well. We specifically move these clauses to the
626 /// associated types instead when displaying, so when we're generating the
627 /// generics for the trait itself we need to be sure to remove them.
628 /// We also need to remove the implied "recursive" Self: Trait bound.
630 /// The inverse of this filtering logic can be found in the `Clean`
631 /// implementation for `AssociatedType`
632 fn filter_non_trait_generics(trait_did: DefId, mut g: clean::Generics) -> clean::Generics {
633 for pred in &mut g.where_predicates {
635 clean::WherePredicate::BoundPredicate {
636 ty: clean::Generic(ref s),
639 } if *s == kw::SelfUpper => {
640 bounds.retain(|bound| match bound {
641 clean::GenericBound::TraitBound(clean::PolyTrait { trait_, .. }, _) => {
642 trait_.def_id() != trait_did
651 g.where_predicates.retain(|pred| match pred {
652 clean::WherePredicate::BoundPredicate {
653 ty: clean::QPath { self_type: box clean::Generic(ref s), trait_, .. },
656 } => !(bounds.is_empty() || *s == kw::SelfUpper && trait_.def_id() == trait_did),
662 /// Supertrait bounds for a trait are also listed in the generics coming from
663 /// the metadata for a crate, so we want to separate those out and create a new
664 /// list of explicit supertrait bounds to render nicely.
665 fn separate_supertrait_bounds(
666 mut g: clean::Generics,
667 ) -> (clean::Generics, Vec<clean::GenericBound>) {
668 let mut ty_bounds = Vec::new();
669 g.where_predicates.retain(|pred| match *pred {
670 clean::WherePredicate::BoundPredicate { ty: clean::Generic(ref s), ref bounds, .. }
671 if *s == kw::SelfUpper =>
673 ty_bounds.extend(bounds.iter().cloned());
681 pub(crate) fn record_extern_trait(cx: &mut DocContext<'_>, did: DefId) {
687 if cx.external_traits.borrow().contains_key(&did) || cx.active_extern_traits.contains(&did)
694 cx.active_extern_traits.insert(did);
697 debug!("record_extern_trait: {:?}", did);
698 let trait_ = build_external_trait(cx, did);
700 let trait_ = clean::TraitWithExtraInfo {
702 is_notable: clean::utils::has_doc_flag(cx.tcx, did, sym::notable_trait),
704 cx.external_traits.borrow_mut().insert(did, trait_);
705 cx.active_extern_traits.remove(&did);