1 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
2 use rustc_data_structures::sync::{self, Lrc};
3 use rustc_errors::emitter::{Emitter, EmitterWriter};
4 use rustc_errors::json::JsonEmitter;
5 use rustc_feature::UnstableFeatures;
6 use rustc_hir::def::Res;
7 use rustc_hir::def_id::{DefId, DefIdMap, LocalDefId};
8 use rustc_hir::intravisit::{self, Visitor};
9 use rustc_hir::{HirId, Path, TraitCandidate};
10 use rustc_interface::interface;
11 use rustc_middle::hir::nested_filter;
12 use rustc_middle::middle::privacy::AccessLevels;
13 use rustc_middle::ty::{ParamEnv, Ty, TyCtxt};
14 use rustc_resolve as resolve;
15 use rustc_session::config::{self, CrateType, ErrorOutputType};
16 use rustc_session::lint;
17 use rustc_session::DiagnosticOutput;
18 use rustc_session::Session;
19 use rustc_span::symbol::sym;
20 use rustc_span::{source_map, Span};
22 use std::cell::RefCell;
23 use std::lazy::SyncLazy;
27 use crate::clean::inline::build_external_trait;
28 use crate::clean::{self, ItemId, TraitWithExtraInfo};
29 use crate::config::{Options as RustdocOptions, OutputFormat, RenderOptions};
30 use crate::formats::cache::Cache;
31 use crate::passes::{self, Condition::*};
33 crate use rustc_session::config::{DebuggingOptions, Input, Options};
35 crate struct ResolverCaches {
36 /// Traits in scope for a given module.
37 /// See `collect_intra_doc_links::traits_implemented_by` for more details.
38 crate traits_in_scope: DefIdMap<Vec<TraitCandidate>>,
39 crate all_traits: Option<Vec<DefId>>,
40 crate all_trait_impls: Option<Vec<DefId>>,
43 crate struct DocContext<'tcx> {
44 crate tcx: TyCtxt<'tcx>,
45 /// Name resolver. Used for intra-doc links.
47 /// The `Rc<RefCell<...>>` wrapping is needed because that is what's returned by
48 /// [`rustc_interface::Queries::expansion()`].
49 // FIXME: see if we can get rid of this RefCell somehow
50 crate resolver: Rc<RefCell<interface::BoxedResolver>>,
51 crate resolver_caches: ResolverCaches,
52 /// Used for normalization.
54 /// Most of this logic is copied from rustc_lint::late.
55 crate param_env: ParamEnv<'tcx>,
56 /// Later on moved through `clean::Crate` into `cache`
57 crate external_traits: Rc<RefCell<FxHashMap<DefId, clean::TraitWithExtraInfo>>>,
58 /// Used while populating `external_traits` to ensure we don't process the same trait twice at
60 crate active_extern_traits: FxHashSet<DefId>,
61 // The current set of parameter substitutions,
62 // for expanding type aliases at the HIR level:
63 /// Table `DefId` of type, lifetime, or const parameter -> substituted type, lifetime, or const
64 crate substs: FxHashMap<DefId, clean::SubstParam>,
65 /// Table synthetic type parameter for `impl Trait` in argument position -> bounds
66 crate impl_trait_bounds: FxHashMap<ImplTraitParam, Vec<clean::GenericBound>>,
67 /// Auto-trait or blanket impls processed so far, as `(self_ty, trait_def_id)`.
68 // FIXME(eddyb) make this a `ty::TraitRef<'tcx>` set.
69 crate generated_synthetics: FxHashSet<(Ty<'tcx>, DefId)>,
70 crate auto_traits: Vec<DefId>,
71 /// The options given to rustdoc that could be relevant to a pass.
72 crate render_options: RenderOptions,
73 /// This same cache is used throughout rustdoc, including in [`crate::html::render`].
75 /// Used by [`clean::inline`] to tell if an item has already been inlined.
76 crate inlined: FxHashSet<ItemId>,
77 /// Used by `calculate_doc_coverage`.
78 crate output_format: OutputFormat,
81 impl<'tcx> DocContext<'tcx> {
82 crate fn sess(&self) -> &'tcx Session {
86 crate fn with_param_env<T, F: FnOnce(&mut Self) -> T>(&mut self, def_id: DefId, f: F) -> T {
87 let old_param_env = mem::replace(&mut self.param_env, self.tcx.param_env(def_id));
89 self.param_env = old_param_env;
93 crate fn enter_resolver<F, R>(&self, f: F) -> R
95 F: FnOnce(&mut resolve::Resolver<'_>) -> R,
97 self.resolver.borrow_mut().access(f)
100 /// Call the closure with the given parameters set as
101 /// the substitutions for a type alias' RHS.
102 crate fn enter_alias<F, R>(&mut self, substs: FxHashMap<DefId, clean::SubstParam>, f: F) -> R
104 F: FnOnce(&mut Self) -> R,
106 let old_substs = mem::replace(&mut self.substs, substs);
108 self.substs = old_substs;
112 /// Like `hir().local_def_id_to_hir_id()`, but skips calling it on fake DefIds.
113 /// (This avoids a slice-index-out-of-bounds panic.)
114 crate fn as_local_hir_id(tcx: TyCtxt<'_>, def_id: ItemId) -> Option<HirId> {
116 ItemId::DefId(real_id) => {
117 real_id.as_local().map(|def_id| tcx.hir().local_def_id_to_hir_id(def_id))
119 // FIXME: Can this be `Some` for `Auto` or `Blanket`?
124 crate fn with_all_traits(&mut self, f: impl FnOnce(&mut Self, &[DefId])) {
125 let all_traits = self.resolver_caches.all_traits.take();
126 f(self, all_traits.as_ref().expect("`all_traits` are already borrowed"));
127 self.resolver_caches.all_traits = all_traits;
130 crate fn with_all_trait_impls(&mut self, f: impl FnOnce(&mut Self, &[DefId])) {
131 let all_trait_impls = self.resolver_caches.all_trait_impls.take();
132 f(self, all_trait_impls.as_ref().expect("`all_trait_impls` are already borrowed"));
133 self.resolver_caches.all_trait_impls = all_trait_impls;
137 /// Creates a new diagnostic `Handler` that can be used to emit warnings and errors.
139 /// If the given `error_format` is `ErrorOutputType::Json` and no `SourceMap` is given, a new one
140 /// will be created for the handler.
141 crate fn new_handler(
142 error_format: ErrorOutputType,
143 source_map: Option<Lrc<source_map::SourceMap>>,
144 debugging_opts: &DebuggingOptions,
145 ) -> rustc_errors::Handler {
146 let emitter: Box<dyn Emitter + sync::Send> = match error_format {
147 ErrorOutputType::HumanReadable(kind) => {
148 let (short, color_config) = kind.unzip();
150 EmitterWriter::stderr(
152 source_map.map(|sm| sm as _),
154 debugging_opts.teach,
155 debugging_opts.terminal_width,
158 .ui_testing(debugging_opts.ui_testing),
161 ErrorOutputType::Json { pretty, json_rendered } => {
162 let source_map = source_map.unwrap_or_else(|| {
163 Lrc::new(source_map::SourceMap::new(source_map::FilePathMapping::empty()))
171 debugging_opts.terminal_width,
174 .ui_testing(debugging_opts.ui_testing),
179 rustc_errors::Handler::with_emitter_and_flags(
181 debugging_opts.diagnostic_handler_flags(true),
185 /// Parse, resolve, and typecheck the given crate.
186 crate fn create_config(
204 scrape_examples_options,
207 ) -> rustc_interface::Config {
208 // Add the doc cfg into the doc build.
209 cfgs.push("doc".to_string());
211 let cpath = Some(input.clone());
212 let input = Input::File(input);
214 // By default, rustdoc ignores all lints.
215 // Specifically unblock lints relevant to documentation or the lint machinery itself.
216 let mut lints_to_show = vec![
217 // it's unclear whether these should be part of rustdoc directly (#77364)
218 rustc_lint::builtin::MISSING_DOCS.name.to_string(),
219 rustc_lint::builtin::INVALID_DOC_ATTRIBUTES.name.to_string(),
220 // these are definitely not part of rustdoc, but we want to warn on them anyway.
221 rustc_lint::builtin::RENAMED_AND_REMOVED_LINTS.name.to_string(),
222 rustc_lint::builtin::UNKNOWN_LINTS.name.to_string(),
223 rustc_lint::builtin::UNEXPECTED_CFGS.name.to_string(),
225 lints_to_show.extend(crate::lint::RUSTDOC_LINTS.iter().map(|lint| lint.name.to_string()));
227 let (lint_opts, lint_caps) = crate::lint::init_lints(lints_to_show, lint_opts, |lint| {
228 Some((lint.name_lower(), lint::Allow))
232 if proc_macro_crate { vec![CrateType::ProcMacro] } else { vec![CrateType::Rlib] };
233 let test = scrape_examples_options.map(|opts| opts.scrape_tests).unwrap_or(false);
234 // plays with error output here!
235 let sessopts = config::Options {
243 target_triple: target,
244 unstable_features: UnstableFeatures::from_environment(crate_name.as_deref()),
245 actually_rustdoc: true,
257 crate_cfg: interface::parse_cfgspecs(cfgs),
258 crate_check_cfg: interface::parse_check_cfg(check_cfgs),
264 diagnostic_output: DiagnosticOutput::Default,
266 parse_sess_created: None,
267 register_lints: Some(box crate::lint::register_lints),
268 override_queries: Some(|_sess, providers, _external_providers| {
269 // Most lints will require typechecking, so just don't run them.
270 providers.lint_mod = |_, _| {};
271 // Prevent `rustc_typeck::check_crate` from calling `typeck` on all bodies.
272 providers.typeck_item_bodies = |_, _| {};
273 // hack so that `used_trait_imports` won't try to call typeck
274 providers.used_trait_imports = |_, _| {
275 static EMPTY_SET: SyncLazy<FxHashSet<LocalDefId>> =
276 SyncLazy::new(FxHashSet::default);
279 // In case typeck does end up being called, don't ICE in case there were name resolution errors
280 providers.typeck = move |tcx, def_id| {
281 // Closures' tables come from their outermost function,
282 // as they are part of the same "inference environment".
283 // This avoids emitting errors for the parent twice (see similar code in `typeck_with_fallback`)
284 let typeck_root_def_id = tcx.typeck_root_def_id(def_id.to_def_id()).expect_local();
285 if typeck_root_def_id != def_id {
286 return tcx.typeck(typeck_root_def_id);
290 let body = hir.body(hir.body_owned_by(hir.local_def_id_to_hir_id(def_id)));
291 debug!("visiting body for {:?}", def_id);
292 EmitIgnoredResolutionErrors::new(tcx).visit_body(body);
293 (rustc_interface::DEFAULT_QUERY_PROVIDERS.typeck)(tcx, def_id)
296 make_codegen_backend: None,
297 registry: rustc_driver::diagnostics_registry(),
301 crate fn run_global_ctxt(
303 resolver: Rc<RefCell<interface::BoxedResolver>>,
304 resolver_caches: ResolverCaches,
306 render_options: RenderOptions,
307 output_format: OutputFormat,
308 ) -> (clean::Crate, RenderOptions, Cache) {
309 // Certain queries assume that some checks were run elsewhere
310 // (see https://github.com/rust-lang/rust/pull/73566#issuecomment-656954425),
311 // so type-check everything other than function bodies in this crate before running lints.
313 // NOTE: this does not call `tcx.analysis()` so that we won't
314 // typeck function bodies or run the default rustc lints.
315 // (see `override_queries` in the `config`)
317 // HACK(jynelson) this calls an _extremely_ limited subset of `typeck`
318 // and might break if queries change their assumptions in the future.
320 // NOTE: This is copy/pasted from typeck/lib.rs and should be kept in sync with those changes.
321 tcx.sess.time("item_types_checking", || {
322 tcx.hir().for_each_module(|module| tcx.ensure().check_mod_item_types(module))
324 tcx.sess.abort_if_errors();
325 tcx.sess.time("missing_docs", || {
326 rustc_lint::check_crate(tcx, rustc_lint::builtin::MissingDoc::new);
328 tcx.sess.time("check_mod_attrs", || {
329 tcx.hir().for_each_module(|module| tcx.ensure().check_mod_attrs(module))
331 rustc_passes::stability::check_unused_or_stable_features(tcx);
333 let auto_traits = resolver_caches
336 .expect("`all_traits` are already borrowed")
339 .filter(|&trait_def_id| tcx.trait_is_auto(trait_def_id))
341 let access_levels = AccessLevels {
342 map: tcx.privacy_access_levels(()).map.iter().map(|(k, v)| (k.to_def_id(), *v)).collect(),
345 let mut ctxt = DocContext {
349 param_env: ParamEnv::empty(),
350 external_traits: Default::default(),
351 active_extern_traits: Default::default(),
352 substs: Default::default(),
353 impl_trait_bounds: Default::default(),
354 generated_synthetics: Default::default(),
356 cache: Cache::new(access_levels, render_options.document_private),
357 inlined: FxHashSet::default(),
362 // Small hack to force the Sized trait to be present.
364 // Note that in case of `#![no_core]`, the trait is not available.
365 if let Some(sized_trait_did) = ctxt.tcx.lang_items().sized_trait() {
366 let mut sized_trait = build_external_trait(&mut ctxt, sized_trait_did);
367 sized_trait.is_auto = true;
370 .insert(sized_trait_did, TraitWithExtraInfo { trait_: sized_trait, is_notable: false });
373 debug!("crate: {:?}", tcx.hir().krate());
375 let mut krate = tcx.sess.time("clean_crate", || clean::krate(&mut ctxt));
377 if krate.module.doc_value().map(|d| d.is_empty()).unwrap_or(true) {
379 "The following guide may be of use:\n\
380 {}/rustdoc/how-to-write-documentation.html",
381 crate::DOC_RUST_LANG_ORG_CHANNEL
383 tcx.struct_lint_node(
384 crate::lint::MISSING_CRATE_LEVEL_DOCS,
385 DocContext::as_local_hir_id(tcx, krate.module.def_id).unwrap(),
388 lint.build("no documentation found for this crate's top-level module");
395 fn report_deprecated_attr(name: &str, diag: &rustc_errors::Handler, sp: Span) {
397 diag.struct_span_warn(sp, &format!("the `#![doc({})]` attribute is deprecated", name));
399 "see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
400 for more information",
403 if name == "no_default_passes" {
404 msg.help("`#![doc(no_default_passes)]` no longer functions; you may want to use `#![doc(document_private_items)]`");
405 } else if name.starts_with("passes") {
406 msg.help("`#![doc(passes = \"...\")]` no longer functions; you may want to use `#![doc(document_private_items)]`");
407 } else if name.starts_with("plugins") {
408 msg.warn("`#![doc(plugins = \"...\")]` no longer functions; see CVE-2018-1000622 <https://nvd.nist.gov/vuln/detail/CVE-2018-1000622>");
414 // Process all of the crate attributes, extracting plugin metadata along
415 // with the passes which we are supposed to run.
416 for attr in krate.module.attrs.lists(sym::doc) {
417 let diag = ctxt.sess().diagnostic();
419 let name = attr.name_or_empty();
420 // `plugins = "..."`, `no_default_passes`, and `passes = "..."` have no effect
421 if attr.is_word() && name == sym::no_default_passes {
422 report_deprecated_attr("no_default_passes", diag, attr.span());
423 } else if attr.value_str().is_some() {
426 report_deprecated_attr("passes = \"...\"", diag, attr.span());
429 report_deprecated_attr("plugins = \"...\"", diag, attr.span());
435 if attr.is_word() && name == sym::document_private_items {
436 ctxt.render_options.document_private = true;
440 info!("Executing passes");
442 for p in passes::defaults(show_coverage) {
443 let run = match p.condition {
445 WhenDocumentPrivate => ctxt.render_options.document_private,
446 WhenNotDocumentPrivate => !ctxt.render_options.document_private,
447 WhenNotDocumentHidden => !ctxt.render_options.document_hidden,
450 debug!("running pass {}", p.pass.name);
451 krate = tcx.sess.time(p.pass.name, || (p.pass.run)(krate, &mut ctxt));
455 if tcx.sess.diagnostic().has_errors_or_lint_errors().is_some() {
456 rustc_errors::FatalError.raise();
459 krate = tcx.sess.time("create_format_cache", || Cache::populate(&mut ctxt, krate));
461 (krate, ctxt.render_options, ctxt.cache)
464 /// Due to <https://github.com/rust-lang/rust/pull/73566>,
465 /// the name resolution pass may find errors that are never emitted.
466 /// If typeck is called after this happens, then we'll get an ICE:
467 /// 'Res::Error found but not reported'. To avoid this, emit the errors now.
468 struct EmitIgnoredResolutionErrors<'tcx> {
472 impl<'tcx> EmitIgnoredResolutionErrors<'tcx> {
473 fn new(tcx: TyCtxt<'tcx>) -> Self {
478 impl<'tcx> Visitor<'tcx> for EmitIgnoredResolutionErrors<'tcx> {
479 type NestedFilter = nested_filter::OnlyBodies;
481 fn nested_visit_map(&mut self) -> Self::Map {
482 // We need to recurse into nested closures,
483 // since those will fallback to the parent for type checking.
487 fn visit_path(&mut self, path: &'tcx Path<'_>, _id: HirId) {
488 debug!("visiting path {:?}", path);
489 if path.res == Res::Err {
490 // We have less context here than in rustc_resolve,
491 // so we can only emit the name and span.
492 // However we can give a hint that rustc_resolve will have more info.
494 "could not resolve path `{}`",
497 .map(|segment| segment.ident.as_str())
501 let mut err = rustc_errors::struct_span_err!(
505 "failed to resolve: {}",
508 err.span_label(path.span, label);
509 err.note("this error was originally ignored because you are running `rustdoc`");
510 err.note("try running again with `rustc` or `cargo check` and you may get a more detailed error");
513 // We could have an outer resolution that succeeded,
514 // but with generic parameters that failed.
515 // Recurse into the segments so we catch those too.
516 intravisit::walk_path(self, path);
520 /// `DefId` or parameter index (`ty::ParamTy.index`) of a synthetic type parameter
521 /// for `impl Trait` in argument position.
522 #[derive(Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
523 crate enum ImplTraitParam {
528 impl From<DefId> for ImplTraitParam {
529 fn from(did: DefId) -> Self {
530 ImplTraitParam::DefId(did)
534 impl From<u32> for ImplTraitParam {
535 fn from(idx: u32) -> Self {
536 ImplTraitParam::ParamIndex(idx)