1 //! Support for inlining external documentation into the current AST.
7 use rustc_data_structures::fx::FxHashSet;
9 use rustc_hir::def::{DefKind, Res};
10 use rustc_hir::def_id::DefId;
11 use rustc_hir::Mutability;
12 use rustc_metadata::creader::LoadedMacro;
13 use rustc_middle::ty::{self, TyCtxt};
14 use rustc_span::hygiene::MacroKind;
15 use rustc_span::symbol::{kw, sym, Symbol};
18 self, utils, Attributes, AttributesExt, FakeDefId, GetDefId, NestedAttributesExt, Type,
20 use crate::core::DocContext;
21 use crate::formats::item_type::ItemType;
23 use super::{Clean, Visibility};
25 type Attrs<'hir> = rustc_middle::ty::Attributes<'hir>;
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.
42 cx: &mut DocContext<'_>,
46 attrs: Option<Attrs<'_>>,
47 visited: &mut FxHashSet<DefId>,
48 ) -> Option<Vec<clean::Item>> {
49 let did = res.opt_def_id()?;
53 let mut ret = Vec::new();
55 debug!("attrs={:?}", attrs);
56 let attrs_clone = attrs;
58 let kind = match res {
59 Res::Def(DefKind::Trait, did) => {
60 record_extern_fqn(cx, did, ItemType::Trait);
61 build_impls(cx, Some(parent_module), did, attrs, &mut ret);
62 clean::TraitItem(build_external_trait(cx, did))
64 Res::Def(DefKind::Fn, did) => {
65 record_extern_fqn(cx, did, ItemType::Function);
66 clean::FunctionItem(build_external_function(cx, did))
68 Res::Def(DefKind::Struct, did) => {
69 record_extern_fqn(cx, did, ItemType::Struct);
70 build_impls(cx, Some(parent_module), did, attrs, &mut ret);
71 clean::StructItem(build_struct(cx, did))
73 Res::Def(DefKind::Union, did) => {
74 record_extern_fqn(cx, did, ItemType::Union);
75 build_impls(cx, Some(parent_module), did, attrs, &mut ret);
76 clean::UnionItem(build_union(cx, did))
78 Res::Def(DefKind::TyAlias, did) => {
79 record_extern_fqn(cx, did, ItemType::Typedef);
80 build_impls(cx, Some(parent_module), did, attrs, &mut ret);
81 clean::TypedefItem(build_type_alias(cx, did), false)
83 Res::Def(DefKind::Enum, did) => {
84 record_extern_fqn(cx, did, ItemType::Enum);
85 build_impls(cx, Some(parent_module), did, attrs, &mut ret);
86 clean::EnumItem(build_enum(cx, did))
88 Res::Def(DefKind::ForeignTy, did) => {
89 record_extern_fqn(cx, did, ItemType::ForeignType);
90 build_impls(cx, Some(parent_module), did, attrs, &mut ret);
91 clean::ForeignTypeItem
93 // Never inline enum variants but leave them shown as re-exports.
94 Res::Def(DefKind::Variant, _) => return None,
95 // Assume that enum variants and struct types are re-exported next to
96 // their constructors.
97 Res::Def(DefKind::Ctor(..), _) | Res::SelfCtor(..) => return Some(Vec::new()),
98 Res::Def(DefKind::Mod, did) => {
99 record_extern_fqn(cx, did, ItemType::Module);
100 clean::ModuleItem(build_module(cx, did, visited))
102 Res::Def(DefKind::Static, did) => {
103 record_extern_fqn(cx, did, ItemType::Static);
104 clean::StaticItem(build_static(cx, did, cx.tcx.is_mutable_static(did)))
106 Res::Def(DefKind::Const, did) => {
107 record_extern_fqn(cx, did, ItemType::Constant);
108 clean::ConstantItem(build_const(cx, did))
110 Res::Def(DefKind::Macro(kind), did) => {
111 let mac = build_macro(cx, did, name);
113 let type_kind = match kind {
114 MacroKind::Bang => ItemType::Macro,
115 MacroKind::Attr => ItemType::ProcAttribute,
116 MacroKind::Derive => ItemType::ProcDerive,
118 record_extern_fqn(cx, did, type_kind);
124 let (attrs, cfg) = merge_attrs(cx, Some(parent_module), load_attrs(cx, did), attrs_clone);
125 cx.inlined.insert(did.into());
126 ret.push(clean::Item::from_def_id_and_attrs_and_parts(
137 crate fn try_inline_glob(
138 cx: &mut DocContext<'_>,
140 visited: &mut FxHashSet<DefId>,
141 ) -> Option<Vec<clean::Item>> {
142 let did = res.opt_def_id()?;
148 Res::Def(DefKind::Mod, did) => {
149 let m = build_module(cx, did, visited);
152 // glob imports on things like enums aren't inlined even for local exports, so just bail
157 crate fn load_attrs<'hir>(cx: &DocContext<'hir>, did: DefId) -> Attrs<'hir> {
158 cx.tcx.get_attrs(did)
161 /// Record an external fully qualified name in the external_paths cache.
163 /// These names are used later on by HTML rendering to generate things like
164 /// source links back to the original item.
165 crate fn record_extern_fqn(cx: &mut DocContext<'_>, did: DefId, kind: ItemType) {
166 let crate_name = cx.tcx.crate_name(did.krate).to_string();
168 let relative = cx.tcx.def_path(did).data.into_iter().filter_map(|elem| {
169 // extern blocks have an empty name
170 let s = elem.data.to_string();
171 if !s.is_empty() { Some(s) } else { None }
173 let fqn = if let ItemType::Macro = kind {
174 // Check to see if it is a macro 2.0 or built-in macro
176 cx.enter_resolver(|r| r.cstore().load_macro_untracked(did, cx.sess())),
177 LoadedMacro::MacroDef(def, _)
178 if matches!(&def.kind, ast::ItemKind::MacroDef(ast_def)
179 if !ast_def.macro_rules)
181 once(crate_name).chain(relative).collect()
183 vec![crate_name, relative.last().expect("relative was empty")]
186 once(crate_name).chain(relative).collect()
190 cx.cache.exact_paths.insert(did, fqn);
192 cx.cache.external_paths.insert(did, (fqn, kind));
196 crate fn build_external_trait(cx: &mut DocContext<'_>, did: DefId) -> clean::Trait {
199 .associated_items(did)
200 .in_definition_order()
202 // When building an external trait, the cleaned trait will have all items public,
203 // which causes methods to have a `pub` prefix, which is invalid since items in traits
204 // can not have a visibility prefix. Thus we override the visibility here manually.
205 // See https://github.com/rust-lang/rust/issues/81274
206 clean::Item { visibility: Visibility::Inherited, ..item.clean(cx) }
210 let predicates = cx.tcx.predicates_of(did);
211 let generics = (cx.tcx.generics_of(did), predicates).clean(cx);
212 let generics = filter_non_trait_generics(did, generics);
213 let (generics, supertrait_bounds) = separate_supertrait_bounds(generics);
214 let is_auto = cx.tcx.trait_is_auto(did);
216 unsafety: cx.tcx.trait_def(did).unsafety,
219 bounds: supertrait_bounds,
224 fn build_external_function(cx: &mut DocContext<'_>, did: DefId) -> clean::Function {
225 let sig = cx.tcx.fn_sig(did);
228 if cx.tcx.is_const_fn_raw(did) { hir::Constness::Const } else { hir::Constness::NotConst };
229 let asyncness = cx.tcx.asyncness(did);
230 let predicates = cx.tcx.predicates_of(did);
231 let (generics, decl) = clean::enter_impl_trait(cx, |cx| {
232 ((cx.tcx.generics_of(did), predicates).clean(cx), (did, sig).clean(cx))
237 header: hir::FnHeader { unsafety: sig.unsafety(), abi: sig.abi(), constness, asyncness },
241 fn build_enum(cx: &mut DocContext<'_>, did: DefId) -> clean::Enum {
242 let predicates = cx.tcx.explicit_predicates_of(did);
245 generics: (cx.tcx.generics_of(did), predicates).clean(cx),
246 variants_stripped: false,
247 variants: cx.tcx.adt_def(did).variants.clean(cx),
251 fn build_struct(cx: &mut DocContext<'_>, did: DefId) -> clean::Struct {
252 let predicates = cx.tcx.explicit_predicates_of(did);
253 let variant = cx.tcx.adt_def(did).non_enum_variant();
256 struct_type: variant.ctor_kind,
257 generics: (cx.tcx.generics_of(did), predicates).clean(cx),
258 fields: variant.fields.clean(cx),
259 fields_stripped: false,
263 fn build_union(cx: &mut DocContext<'_>, did: DefId) -> clean::Union {
264 let predicates = cx.tcx.explicit_predicates_of(did);
265 let variant = cx.tcx.adt_def(did).non_enum_variant();
268 generics: (cx.tcx.generics_of(did), predicates).clean(cx),
269 fields: variant.fields.clean(cx),
270 fields_stripped: false,
274 fn build_type_alias(cx: &mut DocContext<'_>, did: DefId) -> clean::Typedef {
275 let predicates = cx.tcx.explicit_predicates_of(did);
276 let type_ = cx.tcx.type_of(did).clean(cx);
280 generics: (cx.tcx.generics_of(did), predicates).clean(cx),
285 /// Builds all inherent implementations of an ADT (struct/union/enum) or Trait item/path/reexport.
286 crate fn build_impls(
287 cx: &mut DocContext<'_>,
288 parent_module: Option<DefId>,
290 attrs: Option<Attrs<'_>>,
291 ret: &mut Vec<clean::Item>,
295 // for each implementation of an item represented by `did`, build the clean::Item for that impl
296 for &did in tcx.inherent_impls(did).iter() {
297 build_impl(cx, parent_module, did, attrs, ret);
301 /// `parent_module` refers to the parent of the re-export, not the original item
303 cx: &mut DocContext<'_>,
304 parent_module: Option<DefId>,
305 old_attrs: Attrs<'_>,
306 new_attrs: Option<Attrs<'_>>,
307 ) -> (clean::Attributes, Option<Arc<clean::cfg::Cfg>>) {
308 // NOTE: If we have additional attributes (from a re-export),
309 // always insert them first. This ensure that re-export
310 // doc comments show up before the original doc comments
311 // when we render them.
312 if let Some(inner) = new_attrs {
313 let mut both = inner.to_vec();
314 both.extend_from_slice(old_attrs);
316 if let Some(new_id) = parent_module {
317 Attributes::from_ast(old_attrs, Some((inner, new_id)))
319 Attributes::from_ast(&both, None)
324 (old_attrs.clean(cx), old_attrs.cfg(cx.sess()))
328 /// Builds a specific implementation of a type. The `did` could be a type method or trait method.
330 cx: &mut DocContext<'_>,
331 parent_module: impl Into<Option<DefId>>,
333 attrs: Option<Attrs<'_>>,
334 ret: &mut Vec<clean::Item>,
336 if !cx.inlined.insert(did.into()) {
341 let associated_trait = tcx.impl_trait_ref(did);
343 // Only inline impl if the implemented trait is
344 // reachable in rustdoc generated documentation
346 if let Some(traitref) = associated_trait {
347 let did = traitref.def_id;
348 if !cx.cache.access_levels.is_public(did) {
352 if let Some(stab) = tcx.lookup_stability(did) {
353 if stab.level.is_unstable() && stab.feature == sym::rustc_private {
360 let impl_item = match did.as_local() {
362 let hir_id = tcx.hir().local_def_id_to_hir_id(did);
363 match &tcx.hir().expect_item(hir_id).kind {
364 hir::ItemKind::Impl(impl_) => Some(impl_),
365 _ => panic!("`DefID` passed to `build_impl` is not an `impl"),
371 let for_ = match &impl_item {
372 Some(impl_) => impl_.self_ty.clean(cx),
373 None => tcx.type_of(did).clean(cx),
376 // Only inline impl if the implementing type is
377 // reachable in rustdoc generated documentation
379 if let Some(did) = for_.def_id() {
380 if !cx.cache.access_levels.is_public(did) {
384 if let Some(stab) = tcx.lookup_stability(did) {
385 if stab.level.is_unstable() && stab.feature == sym::rustc_private {
392 let predicates = tcx.explicit_predicates_of(did);
393 let (trait_items, generics) = match impl_item {
398 .map(|item| tcx.hir().impl_item(item.id).clean(cx))
399 .collect::<Vec<_>>(),
400 impl_.generics.clean(cx),
403 tcx.associated_items(did)
404 .in_definition_order()
406 if associated_trait.is_some() || item.vis == ty::Visibility::Public {
412 .collect::<Vec<_>>(),
413 clean::enter_impl_trait(cx, |cx| (tcx.generics_of(did), predicates).clean(cx)),
416 let polarity = tcx.impl_polarity(did);
417 let trait_ = associated_trait.clean(cx).map(|bound| match bound {
418 clean::GenericBound::TraitBound(polyt, _) => polyt.trait_,
419 clean::GenericBound::Outlives(..) => unreachable!(),
421 if trait_.def_id() == tcx.lang_items().deref_trait() {
422 super::build_deref_target_impls(cx, &trait_items, ret);
425 // Return if the trait itself or any types of the generic parameters are doc(hidden).
426 let mut stack: Vec<&Type> = trait_.iter().collect();
428 while let Some(ty) = stack.pop() {
429 if let Some(did) = ty.def_id() {
430 if cx.tcx.get_attrs(did).lists(sym::doc).has_word(sym::hidden) {
434 if let Some(generics) = ty.generics() {
435 stack.extend(generics);
439 if let Some(trait_did) = trait_.def_id() {
440 record_extern_trait(cx, trait_did);
443 let (merged_attrs, cfg) = merge_attrs(cx, parent_module.into(), load_attrs(cx, did), attrs);
444 debug!("merged_attrs={:?}", merged_attrs);
446 debug!("build_impl: impl {:?} for {:?}", trait_.def_id(), for_.def_id());
447 ret.push(clean::Item::from_def_id_and_attrs_and_parts(
450 clean::ImplItem(clean::Impl {
451 span: clean::types::rustc_span(did, cx.tcx),
452 unsafety: hir::Unsafety::Normal,
457 negative_polarity: polarity.clean(cx),
468 cx: &mut DocContext<'_>,
470 visited: &mut FxHashSet<DefId>,
472 let mut items = Vec::new();
474 // If we're re-exporting a re-export it may actually re-export something in
475 // two namespaces, so the target may be listed twice. Make sure we only
476 // visit each node at most once.
477 for &item in cx.tcx.item_children(did).iter() {
478 if item.vis == ty::Visibility::Public {
479 if let Some(def_id) = item.res.mod_def_id() {
480 if did == def_id || !visited.insert(def_id) {
484 if let Res::PrimTy(p) = item.res {
485 // Primitive types can't be inlined so generate an import instead.
486 items.push(clean::Item {
488 attrs: box clean::Attributes::default(),
489 def_id: FakeDefId::new_fake(did.krate),
490 visibility: clean::Public,
491 kind: box clean::ImportItem(clean::Import::new_simple(
493 clean::ImportSource {
497 segments: vec![clean::PathSegment {
498 name: clean::PrimitiveType::from(p).as_sym(),
499 args: clean::GenericArgs::AngleBracketed {
501 bindings: Vec::new(),
511 } else if let Some(i) = try_inline(cx, did, item.res, item.ident.name, None, visited) {
517 let span = clean::Span::from_rustc_span(cx.tcx.def_span(did));
518 clean::Module { items, span }
521 crate fn print_inlined_const(tcx: TyCtxt<'_>, did: DefId) -> String {
522 if let Some(did) = did.as_local() {
523 let hir_id = tcx.hir().local_def_id_to_hir_id(did);
524 rustc_hir_pretty::id_to_string(&tcx.hir(), hir_id)
526 tcx.rendered_const(did)
530 fn build_const(cx: &mut DocContext<'_>, def_id: DefId) -> clean::Constant {
532 type_: cx.tcx.type_of(def_id).clean(cx),
533 kind: clean::ConstantKind::Extern { def_id },
537 fn build_static(cx: &mut DocContext<'_>, did: DefId, mutable: bool) -> clean::Static {
539 type_: cx.tcx.type_of(did).clean(cx),
540 mutability: if mutable { Mutability::Mut } else { Mutability::Not },
545 fn build_macro(cx: &mut DocContext<'_>, did: DefId, name: Symbol) -> clean::ItemKind {
546 let imported_from = cx.tcx.crate_name(did.krate);
547 match cx.enter_resolver(|r| r.cstore().load_macro_untracked(did, cx.sess())) {
548 LoadedMacro::MacroDef(def, _) => {
549 if let ast::ItemKind::MacroDef(ref def) = def.kind {
550 let tts: Vec<_> = def.body.inner_tokens().into_trees().collect();
551 let matchers = tts.chunks(4).map(|arm| &arm[0]);
553 let source = format!(
554 "macro_rules! {} {{\n{}}}",
556 utils::render_macro_arms(matchers, ";")
559 clean::MacroItem(clean::Macro { source, imported_from: Some(imported_from) })
564 LoadedMacro::ProcMacro(ext) => clean::ProcMacroItem(clean::ProcMacro {
565 kind: ext.macro_kind(),
566 helpers: ext.helper_attrs,
571 /// A trait's generics clause actually contains all of the predicates for all of
572 /// its associated types as well. We specifically move these clauses to the
573 /// associated types instead when displaying, so when we're generating the
574 /// generics for the trait itself we need to be sure to remove them.
575 /// We also need to remove the implied "recursive" Self: Trait bound.
577 /// The inverse of this filtering logic can be found in the `Clean`
578 /// implementation for `AssociatedType`
579 fn filter_non_trait_generics(trait_did: DefId, mut g: clean::Generics) -> clean::Generics {
580 for pred in &mut g.where_predicates {
582 clean::WherePredicate::BoundPredicate {
583 ty: clean::Generic(ref s),
586 } if *s == kw::SelfUpper => {
587 bounds.retain(|bound| match *bound {
588 clean::GenericBound::TraitBound(
589 clean::PolyTrait { trait_: clean::ResolvedPath { did, .. }, .. },
591 ) => did != trait_did,
599 g.where_predicates.retain(|pred| match *pred {
600 clean::WherePredicate::BoundPredicate {
603 self_type: box clean::Generic(ref s),
604 trait_: box clean::ResolvedPath { did, .. },
610 } => !(bounds.is_empty() || *s == kw::SelfUpper && did == trait_did),
616 /// Supertrait bounds for a trait are also listed in the generics coming from
617 /// the metadata for a crate, so we want to separate those out and create a new
618 /// list of explicit supertrait bounds to render nicely.
619 fn separate_supertrait_bounds(
620 mut g: clean::Generics,
621 ) -> (clean::Generics, Vec<clean::GenericBound>) {
622 let mut ty_bounds = Vec::new();
623 g.where_predicates.retain(|pred| match *pred {
624 clean::WherePredicate::BoundPredicate { ty: clean::Generic(ref s), ref bounds, .. }
625 if *s == kw::SelfUpper =>
627 ty_bounds.extend(bounds.iter().cloned());
635 crate fn record_extern_trait(cx: &mut DocContext<'_>, did: DefId) {
641 if cx.external_traits.borrow().contains_key(&did) || cx.active_extern_traits.contains(&did)
648 cx.active_extern_traits.insert(did);
651 debug!("record_extern_trait: {:?}", did);
652 let trait_ = build_external_trait(cx, did);
654 let trait_ = clean::TraitWithExtraInfo {
656 is_notable: clean::utils::has_doc_flag(cx.tcx.get_attrs(did), sym::notable_trait),
658 cx.external_traits.borrow_mut().insert(did, trait_);
659 cx.active_extern_traits.remove(&did);