src/librustdoc/clean/utils.rs

   1 use crate::clean::auto_trait::AutoTraitFinder;
   2 use crate::clean::blanket_impl::BlanketImplFinder;
   3 use crate::clean::{
   4     inline, Clean, Crate, Generic, GenericArg, GenericArgs, ImportSource, Item, ItemKind, Lifetime,
   5     Path, PathSegment, Primitive, PrimitiveType, ResolvedPath, Type, TypeBinding,
   6 };
   7 use crate::core::DocContext;
   8 use crate::formats::item_type::ItemType;
   9
  10 use rustc_hir as hir;
  11 use rustc_hir::def::{DefKind, Res};
  12 use rustc_hir::def_id::{DefId, LOCAL_CRATE};
  13 use rustc_middle::mir::interpret::ConstValue;
  14 use rustc_middle::ty::subst::{GenericArgKind, SubstsRef};
  15 use rustc_middle::ty::{self, DefIdTree, TyCtxt};
  16 use rustc_span::symbol::{kw, sym, Symbol};
  17 use std::mem;
  18
  19 #[cfg(test)]
  20 mod tests;
  21
  22 crate fn krate(cx: &mut DocContext<'_>) -> Crate {
  23     use crate::visit_lib::LibEmbargoVisitor;
  24
  25     let krate = cx.tcx.hir().krate();
  26     let module = crate::visit_ast::RustdocVisitor::new(cx).visit(krate);
  27
  28     cx.cache.deref_trait_did = cx.tcx.lang_items().deref_trait();
  29     cx.cache.deref_mut_trait_did = cx.tcx.lang_items().deref_mut_trait();
  30     cx.cache.owned_box_did = cx.tcx.lang_items().owned_box();
  31
  32     let mut externs = Vec::new();
  33     for &cnum in cx.tcx.crates().iter() {
  34         externs.push((cnum, cnum.clean(cx)));
  35         // Analyze doc-reachability for extern items
  36         LibEmbargoVisitor::new(cx).visit_lib(cnum);
  37     }
  38     externs.sort_by(|&(a, _), &(b, _)| a.cmp(&b));
  39
  40     // Clean the crate, translating the entire librustc_ast AST to one that is
  41     // understood by rustdoc.
  42     let mut module = module.clean(cx);
  43
  44     match *module.kind {
  45         ItemKind::ModuleItem(ref module) => {
  46             for it in &module.items {
  47                 // `compiler_builtins` should be masked too, but we can't apply
  48                 // `#[doc(masked)]` to the injected `extern crate` because it's unstable.
  49                 if it.is_extern_crate()
  50                     && (it.attrs.has_doc_flag(sym::masked)
  51                         || cx.tcx.is_compiler_builtins(it.def_id.krate()))
  52                 {
  53                     cx.cache.masked_crates.insert(it.def_id.krate());
  54                 }
  55             }
  56         }
  57         _ => unreachable!(),
  58     }
  59
  60     let local_crate = LOCAL_CRATE.clean(cx);
  61     let src = local_crate.src(cx.tcx);
  62     let name = local_crate.name(cx.tcx);
  63     let primitives = local_crate.primitives(cx.tcx);
  64     let keywords = local_crate.keywords(cx.tcx);
  65     {
  66         let m = match *module.kind {
  67             ItemKind::ModuleItem(ref mut m) => m,
  68             _ => unreachable!(),
  69         };
  70         m.items.extend(primitives.iter().map(|&(def_id, prim)| {
  71             Item::from_def_id_and_parts(
  72                 def_id,
  73                 Some(prim.as_sym()),
  74                 ItemKind::PrimitiveItem(prim),
  75                 cx,
  76             )
  77         }));
  78         m.items.extend(keywords.into_iter().map(|(def_id, kw)| {
  79             Item::from_def_id_and_parts(def_id, Some(kw), ItemKind::KeywordItem(kw), cx)
  80         }));
  81     }
  82
  83     Crate {
  84         name,
  85         src,
  86         module,
  87         externs,
  88         primitives,
  89         external_traits: cx.external_traits.clone(),
  90         collapsed: false,
  91     }
  92 }
  93
  94 fn external_generic_args(
  95     cx: &mut DocContext<'_>,
  96     trait_did: Option<DefId>,
  97     has_self: bool,
  98     bindings: Vec<TypeBinding>,
  99     substs: SubstsRef<'_>,
 100 ) -> GenericArgs {
 101     let mut skip_self = has_self;
 102     let mut ty_kind = None;
 103     let args: Vec<_> = substs
 104         .iter()
 105         .filter_map(|kind| match kind.unpack() {
 106             GenericArgKind::Lifetime(lt) => match lt {
 107                 ty::ReLateBound(_, ty::BoundRegion { kind: ty::BrAnon(_), .. }) => {
 108                     Some(GenericArg::Lifetime(Lifetime::elided()))
 109                 }
 110                 _ => lt.clean(cx).map(GenericArg::Lifetime),
 111             },
 112             GenericArgKind::Type(_) if skip_self => {
 113                 skip_self = false;
 114                 None
 115             }
 116             GenericArgKind::Type(ty) => {
 117                 ty_kind = Some(ty.kind());
 118                 Some(GenericArg::Type(ty.clean(cx)))
 119             }
 120             GenericArgKind::Const(ct) => Some(GenericArg::Const(ct.clean(cx))),
 121         })
 122         .collect();
 123
 124     match trait_did {
 125         // Attempt to sugar an external path like Fn<(A, B,), C> to Fn(A, B) -> C
 126         Some(did) if cx.tcx.fn_trait_kind_from_lang_item(did).is_some() => {
 127             assert!(ty_kind.is_some());
 128             let inputs = match ty_kind {
 129                 Some(ty::Tuple(ref tys)) => tys.iter().map(|t| t.expect_ty().clean(cx)).collect(),
 130                 _ => return GenericArgs::AngleBracketed { args, bindings },
 131             };
 132             let output = None;
 133             // FIXME(#20299) return type comes from a projection now
 134             // match types[1].kind {
 135             //     ty::Tuple(ref v) if v.is_empty() => None, // -> ()
 136             //     _ => Some(types[1].clean(cx))
 137             // };
 138             GenericArgs::Parenthesized { inputs, output }
 139         }
 140         _ => GenericArgs::AngleBracketed { args, bindings },
 141     }
 142 }
 143
 144 // trait_did should be set to a trait's DefId if called on a TraitRef, in order to sugar
 145 // from Fn<(A, B,), C> to Fn(A, B) -> C
 146 pub(super) fn external_path(
 147     cx: &mut DocContext<'_>,
 148     name: Symbol,
 149     trait_did: Option<DefId>,
 150     has_self: bool,
 151     bindings: Vec<TypeBinding>,
 152     substs: SubstsRef<'_>,
 153 ) -> Path {
 154     Path {
 155         global: false,
 156         res: Res::Err,
 157         segments: vec![PathSegment {
 158             name,
 159             args: external_generic_args(cx, trait_did, has_self, bindings, substs),
 160         }],
 161     }
 162 }
 163
 164 crate fn strip_type(ty: Type) -> Type {
 165     match ty {
 166         Type::ResolvedPath { path, param_names, did, is_generic } => {
 167             Type::ResolvedPath { path: strip_path(&path), param_names, did, is_generic }
 168         }
 169         Type::Tuple(inner_tys) => {
 170             Type::Tuple(inner_tys.iter().map(|t| strip_type(t.clone())).collect())
 171         }
 172         Type::Slice(inner_ty) => Type::Slice(Box::new(strip_type(*inner_ty))),
 173         Type::Array(inner_ty, s) => Type::Array(Box::new(strip_type(*inner_ty)), s),
 174         Type::RawPointer(m, inner_ty) => Type::RawPointer(m, Box::new(strip_type(*inner_ty))),
 175         Type::BorrowedRef { lifetime, mutability, type_ } => {
 176             Type::BorrowedRef { lifetime, mutability, type_: Box::new(strip_type(*type_)) }
 177         }
 178         Type::QPath { name, self_type, trait_, self_def_id } => Type::QPath {
 179             name,
 180             self_def_id,
 181             self_type: Box::new(strip_type(*self_type)),
 182             trait_: Box::new(strip_type(*trait_)),
 183         },
 184         _ => ty,
 185     }
 186 }
 187
 188 crate fn strip_path(path: &Path) -> Path {
 189     let segments = path
 190         .segments
 191         .iter()
 192         .map(|s| PathSegment {
 193             name: s.name,
 194             args: GenericArgs::AngleBracketed { args: vec![], bindings: vec![] },
 195         })
 196         .collect();
 197
 198     Path { global: path.global, res: path.res, segments }
 199 }
 200
 201 crate fn qpath_to_string(p: &hir::QPath<'_>) -> String {
 202     let segments = match *p {
 203         hir::QPath::Resolved(_, ref path) => &path.segments,
 204         hir::QPath::TypeRelative(_, ref segment) => return segment.ident.to_string(),
 205         hir::QPath::LangItem(lang_item, ..) => return lang_item.name().to_string(),
 206     };
 207
 208     let mut s = String::new();
 209     for (i, seg) in segments.iter().enumerate() {
 210         if i > 0 {
 211             s.push_str("::");
 212         }
 213         if seg.ident.name != kw::PathRoot {
 214             s.push_str(&seg.ident.as_str());
 215         }
 216     }
 217     s
 218 }
 219
 220 crate fn build_deref_target_impls(cx: &mut DocContext<'_>, items: &[Item], ret: &mut Vec<Item>) {
 221     let tcx = cx.tcx;
 222
 223     for item in items {
 224         let target = match *item.kind {
 225             ItemKind::TypedefItem(ref t, true) => &t.type_,
 226             _ => continue,
 227         };
 228
 229         if let Some(prim) = target.primitive_type() {
 230             for &did in prim.impls(tcx).iter().filter(|did| !did.is_local()) {
 231                 inline::build_impl(cx, None, did, None, ret);
 232             }
 233         } else if let ResolvedPath { did, .. } = *target {
 234             if !did.is_local() {
 235                 inline::build_impls(cx, None, did, None, ret);
 236             }
 237         }
 238     }
 239 }
 240
 241 crate trait ToSource {
 242     fn to_src(&self, cx: &DocContext<'_>) -> String;
 243 }
 244
 245 impl ToSource for rustc_span::Span {
 246     fn to_src(&self, cx: &DocContext<'_>) -> String {
 247         debug!("converting span {:?} to snippet", self);
 248         let sn = match cx.sess().source_map().span_to_snippet(*self) {
 249             Ok(x) => x,
 250             Err(_) => String::new(),
 251         };
 252         debug!("got snippet {}", sn);
 253         sn
 254     }
 255 }
 256
 257 crate fn name_from_pat(p: &hir::Pat<'_>) -> Symbol {
 258     use rustc_hir::*;
 259     debug!("trying to get a name from pattern: {:?}", p);
 260
 261     Symbol::intern(&match p.kind {
 262         PatKind::Wild | PatKind::Struct(..) => return kw::Underscore,
 263         PatKind::Binding(_, _, ident, _) => return ident.name,
 264         PatKind::TupleStruct(ref p, ..) | PatKind::Path(ref p) => qpath_to_string(p),
 265         PatKind::Or(ref pats) => pats
 266             .iter()
 267             .map(|p| name_from_pat(&**p).to_string())
 268             .collect::<Vec<String>>()
 269             .join(" | "),
 270         PatKind::Tuple(ref elts, _) => format!(
 271             "({})",
 272             elts.iter()
 273                 .map(|p| name_from_pat(&**p).to_string())
 274                 .collect::<Vec<String>>()
 275                 .join(", ")
 276         ),
 277         PatKind::Box(ref p) => return name_from_pat(&**p),
 278         PatKind::Ref(ref p, _) => return name_from_pat(&**p),
 279         PatKind::Lit(..) => {
 280             warn!(
 281                 "tried to get argument name from PatKind::Lit, which is silly in function arguments"
 282             );
 283             return Symbol::intern("()");
 284         }
 285         PatKind::Range(..) => return kw::Underscore,
 286         PatKind::Slice(ref begin, ref mid, ref end) => {
 287             let begin = begin.iter().map(|p| name_from_pat(&**p).to_string());
 288             let mid = mid.as_ref().map(|p| format!("..{}", name_from_pat(&**p))).into_iter();
 289             let end = end.iter().map(|p| name_from_pat(&**p).to_string());
 290             format!("[{}]", begin.chain(mid).chain(end).collect::<Vec<_>>().join(", "))
 291         }
 292     })
 293 }
 294
 295 crate fn print_const(cx: &DocContext<'_>, n: &'tcx ty::Const<'_>) -> String {
 296     match n.val {
 297         ty::ConstKind::Unevaluated(ty::Unevaluated { def, substs: _, promoted }) => {
 298             let mut s = if let Some(def) = def.as_local() {
 299                 let hir_id = cx.tcx.hir().local_def_id_to_hir_id(def.did);
 300                 print_const_expr(cx.tcx, cx.tcx.hir().body_owned_by(hir_id))
 301             } else {
 302                 inline::print_inlined_const(cx.tcx, def.did)
 303             };
 304             if let Some(promoted) = promoted {
 305                 s.push_str(&format!("::{:?}", promoted))
 306             }
 307             s
 308         }
 309         _ => {
 310             let mut s = n.to_string();
 311             // array lengths are obviously usize
 312             if s.ends_with("_usize") {
 313                 let n = s.len() - "_usize".len();
 314                 s.truncate(n);
 315                 if s.ends_with(": ") {
 316                     let n = s.len() - ": ".len();
 317                     s.truncate(n);
 318                 }
 319             }
 320             s
 321         }
 322     }
 323 }
 324
 325 crate fn print_evaluated_const(tcx: TyCtxt<'_>, def_id: DefId) -> Option<String> {
 326     tcx.const_eval_poly(def_id).ok().and_then(|val| {
 327         let ty = tcx.type_of(def_id);
 328         match (val, ty.kind()) {
 329             (_, &ty::Ref(..)) => None,
 330             (ConstValue::Scalar(_), &ty::Adt(_, _)) => None,
 331             (ConstValue::Scalar(_), _) => {
 332                 let const_ = ty::Const::from_value(tcx, val, ty);
 333                 Some(print_const_with_custom_print_scalar(tcx, const_))
 334             }
 335             _ => None,
 336         }
 337     })
 338 }
 339
 340 fn format_integer_with_underscore_sep(num: &str) -> String {
 341     let num_chars: Vec<_> = num.chars().collect();
 342     let mut num_start_index = if num_chars.get(0) == Some(&'-') { 1 } else { 0 };
 343     let chunk_size = match num[num_start_index..].as_bytes() {
 344         [b'0', b'b' | b'x', ..] => {
 345             num_start_index += 2;
 346             4
 347         }
 348         [b'0', b'o', ..] => {
 349             num_start_index += 2;
 350             let remaining_chars = num_chars.len() - num_start_index;
 351             if remaining_chars <= 6 {
 352                 // don't add underscores to Unix permissions like 0755 or 100755
 353                 return num.to_string();
 354             }
 355             3
 356         }
 357         _ => 3,
 358     };
 359
 360     num_chars[..num_start_index]
 361         .iter()
 362         .chain(num_chars[num_start_index..].rchunks(chunk_size).rev().intersperse(&['_']).flatten())
 363         .collect()
 364 }
 365
 366 fn print_const_with_custom_print_scalar(tcx: TyCtxt<'_>, ct: &'tcx ty::Const<'tcx>) -> String {
 367     // Use a slightly different format for integer types which always shows the actual value.
 368     // For all other types, fallback to the original `pretty_print_const`.
 369     match (ct.val, ct.ty.kind()) {
 370         (ty::ConstKind::Value(ConstValue::Scalar(int)), ty::Uint(ui)) => {
 371             format!("{}{}", format_integer_with_underscore_sep(&int.to_string()), ui.name_str())
 372         }
 373         (ty::ConstKind::Value(ConstValue::Scalar(int)), ty::Int(i)) => {
 374             let ty = tcx.lift(ct.ty).unwrap();
 375             let size = tcx.layout_of(ty::ParamEnv::empty().and(ty)).unwrap().size;
 376             let data = int.assert_bits(size);
 377             let sign_extended_data = size.sign_extend(data) as i128;
 378
 379             format!(
 380                 "{}{}",
 381                 format_integer_with_underscore_sep(&sign_extended_data.to_string()),
 382                 i.name_str()
 383             )
 384         }
 385         _ => ct.to_string(),
 386     }
 387 }
 388
 389 crate fn is_literal_expr(tcx: TyCtxt<'_>, hir_id: hir::HirId) -> bool {
 390     if let hir::Node::Expr(expr) = tcx.hir().get(hir_id) {
 391         if let hir::ExprKind::Lit(_) = &expr.kind {
 392             return true;
 393         }
 394
 395         if let hir::ExprKind::Unary(hir::UnOp::Neg, expr) = &expr.kind {
 396             if let hir::ExprKind::Lit(_) = &expr.kind {
 397                 return true;
 398             }
 399         }
 400     }
 401
 402     false
 403 }
 404
 405 crate fn print_const_expr(tcx: TyCtxt<'_>, body: hir::BodyId) -> String {
 406     let hir = tcx.hir();
 407     let value = &hir.body(body).value;
 408
 409     let snippet = if !value.span.from_expansion() {
 410         tcx.sess.source_map().span_to_snippet(value.span).ok()
 411     } else {
 412         None
 413     };
 414
 415     snippet.unwrap_or_else(|| rustc_hir_pretty::id_to_string(&hir, body.hir_id))
 416 }
 417
 418 /// Given a type Path, resolve it to a Type using the TyCtxt
 419 crate fn resolve_type(cx: &mut DocContext<'_>, path: Path, id: hir::HirId) -> Type {
 420     debug!("resolve_type({:?},{:?})", path, id);
 421
 422     let is_generic = match path.res {
 423         Res::PrimTy(p) => return Primitive(PrimitiveType::from(p)),
 424         Res::SelfTy(..) if path.segments.len() == 1 => {
 425             return Generic(kw::SelfUpper);
 426         }
 427         Res::Def(DefKind::TyParam, _) if path.segments.len() == 1 => {
 428             return Generic(Symbol::intern(&path.whole_name()));
 429         }
 430         Res::SelfTy(..) | Res::Def(DefKind::TyParam | DefKind::AssocTy, _) => true,
 431         _ => false,
 432     };
 433     let did = register_res(cx, path.res);
 434     ResolvedPath { path, param_names: None, did, is_generic }
 435 }
 436
 437 crate fn get_auto_trait_and_blanket_impls(
 438     cx: &mut DocContext<'tcx>,
 439     item_def_id: DefId,
 440 ) -> impl Iterator<Item = Item> {
 441     let auto_impls = cx
 442         .sess()
 443         .prof
 444         .generic_activity("get_auto_trait_impls")
 445         .run(|| AutoTraitFinder::new(cx).get_auto_trait_impls(item_def_id));
 446     let blanket_impls = cx
 447         .sess()
 448         .prof
 449         .generic_activity("get_blanket_impls")
 450         .run(|| BlanketImplFinder { cx }.get_blanket_impls(item_def_id));
 451     auto_impls.into_iter().chain(blanket_impls)
 452 }
 453
 454 /// If `res` has a documentation page associated, store it in the cache.
 455 ///
 456 /// This is later used by [`href()`] to determine the HTML link for the item.
 457 ///
 458 /// [`href()`]: crate::html::format::href
 459 crate fn register_res(cx: &mut DocContext<'_>, res: Res) -> DefId {
 460     use DefKind::*;
 461     debug!("register_res({:?})", res);
 462
 463     let (did, kind) = match res {
 464         Res::Def(DefKind::AssocTy | DefKind::AssocFn | DefKind::AssocConst, i) => {
 465             // associated items are documented, but on the page of their parent
 466             (cx.tcx.parent(i).unwrap(), ItemType::Trait)
 467         }
 468         Res::Def(DefKind::Variant, i) => {
 469             // variant items are documented, but on the page of their parent
 470             (cx.tcx.parent(i).expect("cannot get parent def id"), ItemType::Enum)
 471         }
 472         // Each of these have their own page.
 473         Res::Def(
 474             kind
 475             @
 476             (Fn | TyAlias | Enum | Trait | Struct | Union | Mod | ForeignTy | Const | Static
 477             | Macro(..) | TraitAlias),
 478             i,
 479         ) => (i, kind.into()),
 480         // This is part of a trait definition; document the trait.
 481         Res::SelfTy(Some(trait_def_id), _) => (trait_def_id, ItemType::Trait),
 482         // This is an inherent impl; it doesn't have its own page.
 483         Res::SelfTy(None, Some((impl_def_id, _))) => return impl_def_id,
 484         Res::SelfTy(None, None)
 485         | Res::PrimTy(_)
 486         | Res::ToolMod
 487         | Res::SelfCtor(_)
 488         | Res::Local(_)
 489         | Res::NonMacroAttr(_)
 490         | Res::Err => return res.def_id(),
 491         Res::Def(
 492             TyParam | ConstParam | Ctor(..) | ExternCrate | Use | ForeignMod | AnonConst | OpaqueTy
 493             | Field | LifetimeParam | GlobalAsm | Impl | Closure | Generator,
 494             id,
 495         ) => return id,
 496     };
 497     if did.is_local() {
 498         return did;
 499     }
 500     inline::record_extern_fqn(cx, did, kind);
 501     if let ItemType::Trait = kind {
 502         inline::record_extern_trait(cx, did);
 503     }
 504     did
 505 }
 506
 507 crate fn resolve_use_source(cx: &mut DocContext<'_>, path: Path) -> ImportSource {
 508     ImportSource {
 509         did: if path.res.opt_def_id().is_none() { None } else { Some(register_res(cx, path.res)) },
 510         path,
 511     }
 512 }
 513
 514 crate fn enter_impl_trait<F, R>(cx: &mut DocContext<'_>, f: F) -> R
 515 where
 516     F: FnOnce(&mut DocContext<'_>) -> R,
 517 {
 518     let old_bounds = mem::take(&mut cx.impl_trait_bounds);
 519     let r = f(cx);
 520     assert!(cx.impl_trait_bounds.is_empty());
 521     cx.impl_trait_bounds = old_bounds;
 522     r
 523 }
 524
 525 /// Find the nearest parent module of a [`DefId`].
 526 crate fn find_nearest_parent_module(tcx: TyCtxt<'_>, def_id: DefId) -> Option<DefId> {
 527     if def_id.is_top_level_module() {
 528         // The crate root has no parent. Use it as the root instead.
 529         Some(def_id)
 530     } else {
 531         let mut current = def_id;
 532         // The immediate parent might not always be a module.
 533         // Find the first parent which is.
 534         while let Some(parent) = tcx.parent(current) {
 535             if tcx.def_kind(parent) == DefKind::Mod {
 536                 return Some(parent);
 537             }
 538             current = parent;
 539         }
 540         None
 541     }
 542 }
 543
 544 /// Checks for the existence of `hidden` in the attribute below if `flag` is `sym::hidden`:
 545 ///
 546 /// ```
 547 /// #[doc(hidden)]
 548 /// pub fn foo() {}
 549 /// ```
 550 ///
 551 /// This function exists because it runs on `hir::Attributes` whereas the other is a
 552 /// `clean::Attributes` method.
 553 crate fn has_doc_flag(attrs: ty::Attributes<'_>, flag: Symbol) -> bool {
 554     attrs.iter().any(|attr| {
 555         attr.has_name(sym::doc)
 556             && attr.meta_item_list().map_or(false, |l| rustc_attr::list_contains_name(&l, flag))
 557     })
 558 }
 559
 560 /// A link to `doc.rust-lang.org` that includes the channel name. Use this instead of manual links
 561 /// so that the channel is consistent.
 562 ///
 563 /// Set by `bootstrap::Builder::doc_rust_lang_org_channel` in order to keep tests passing on beta/stable.
 564 crate const DOC_RUST_LANG_ORG_CHANNEL: &'static str = env!("DOC_RUST_LANG_ORG_CHANNEL");