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