2 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
3 use rustc_data_structures::sync::{self, Lrc};
4 use rustc_errors::emitter::{Emitter, EmitterWriter};
5 use rustc_errors::json::JsonEmitter;
6 use rustc_feature::UnstableFeatures;
7 use rustc_hir::def::{Namespace, Res};
8 use rustc_hir::def_id::{DefId, DefIdMap, LocalDefId};
9 use rustc_hir::intravisit::{self, Visitor};
10 use rustc_hir::{HirId, Path, TraitCandidate};
11 use rustc_interface::interface;
12 use rustc_middle::hir::nested_filter;
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::Session;
18 use rustc_span::symbol::sym;
19 use rustc_span::{source_map, Span, Symbol};
21 use std::cell::RefCell;
24 use std::sync::LazyLock;
26 use crate::clean::inline::build_external_trait;
27 use crate::clean::{self, ItemId};
28 use crate::config::{Options as RustdocOptions, OutputFormat, RenderOptions};
29 use crate::formats::cache::Cache;
30 use crate::passes::collect_intra_doc_links::PreprocessedMarkdownLink;
31 use crate::passes::{self, Condition::*};
33 pub(crate) use rustc_session::config::{Input, Options, UnstableOptions};
35 pub(crate) struct ResolverCaches {
36 pub(crate) markdown_links: Option<FxHashMap<String, Vec<PreprocessedMarkdownLink>>>,
37 pub(crate) doc_link_resolutions: FxHashMap<(Symbol, Namespace, DefId), Option<Res<NodeId>>>,
38 /// Traits in scope for a given module.
39 /// See `collect_intra_doc_links::traits_implemented_by` for more details.
40 pub(crate) traits_in_scope: DefIdMap<Vec<TraitCandidate>>,
41 pub(crate) all_trait_impls: Option<Vec<DefId>>,
42 pub(crate) all_macro_rules: FxHashMap<Symbol, Res<NodeId>>,
45 pub(crate) struct DocContext<'tcx> {
46 pub(crate) tcx: TyCtxt<'tcx>,
47 /// Name resolver. Used for intra-doc links.
49 /// The `Rc<RefCell<...>>` wrapping is needed because that is what's returned by
50 /// [`rustc_interface::Queries::expansion()`].
51 // FIXME: see if we can get rid of this RefCell somehow
52 pub(crate) resolver: Rc<RefCell<interface::BoxedResolver>>,
53 pub(crate) resolver_caches: ResolverCaches,
54 /// Used for normalization.
56 /// Most of this logic is copied from rustc_lint::late.
57 pub(crate) param_env: ParamEnv<'tcx>,
58 /// Later on moved through `clean::Crate` into `cache`
59 pub(crate) external_traits: Rc<RefCell<FxHashMap<DefId, clean::Trait>>>,
60 /// Used while populating `external_traits` to ensure we don't process the same trait twice at
62 pub(crate) active_extern_traits: FxHashSet<DefId>,
63 // The current set of parameter substitutions,
64 // for expanding type aliases at the HIR level:
65 /// Table `DefId` of type, lifetime, or const parameter -> substituted type, lifetime, or const
66 pub(crate) substs: FxHashMap<DefId, clean::SubstParam>,
67 /// Table synthetic type parameter for `impl Trait` in argument position -> bounds
68 pub(crate) impl_trait_bounds: FxHashMap<ImplTraitParam, Vec<clean::GenericBound>>,
69 /// Auto-trait or blanket impls processed so far, as `(self_ty, trait_def_id)`.
70 // FIXME(eddyb) make this a `ty::TraitRef<'tcx>` set.
71 pub(crate) generated_synthetics: FxHashSet<(Ty<'tcx>, DefId)>,
72 pub(crate) auto_traits: Vec<DefId>,
73 /// The options given to rustdoc that could be relevant to a pass.
74 pub(crate) render_options: RenderOptions,
75 /// This same cache is used throughout rustdoc, including in [`crate::html::render`].
76 pub(crate) cache: Cache,
77 /// Used by [`clean::inline`] to tell if an item has already been inlined.
78 pub(crate) inlined: FxHashSet<ItemId>,
79 /// Used by `calculate_doc_coverage`.
80 pub(crate) output_format: OutputFormat,
81 /// Used by `strip_private`.
82 pub(crate) show_coverage: bool,
85 impl<'tcx> DocContext<'tcx> {
86 pub(crate) fn sess(&self) -> &'tcx Session {
90 pub(crate) fn with_param_env<T, F: FnOnce(&mut Self) -> T>(
95 let old_param_env = mem::replace(&mut self.param_env, self.tcx.param_env(def_id));
97 self.param_env = old_param_env;
101 pub(crate) fn enter_resolver<F, R>(&self, f: F) -> R
103 F: FnOnce(&mut resolve::Resolver<'_>) -> R,
105 self.resolver.borrow_mut().access(f)
108 /// Call the closure with the given parameters set as
109 /// the substitutions for a type alias' RHS.
110 pub(crate) fn enter_alias<F, R>(
112 substs: FxHashMap<DefId, clean::SubstParam>,
116 F: FnOnce(&mut Self) -> R,
118 let old_substs = mem::replace(&mut self.substs, substs);
120 self.substs = old_substs;
124 /// Like `hir().local_def_id_to_hir_id()`, but skips calling it on fake DefIds.
125 /// (This avoids a slice-index-out-of-bounds panic.)
126 pub(crate) fn as_local_hir_id(tcx: TyCtxt<'_>, item_id: ItemId) -> Option<HirId> {
128 ItemId::DefId(real_id) => {
129 real_id.as_local().map(|def_id| tcx.hir().local_def_id_to_hir_id(def_id))
131 // FIXME: Can this be `Some` for `Auto` or `Blanket`?
136 pub(crate) fn with_all_trait_impls(&mut self, f: impl FnOnce(&mut Self, &[DefId])) {
137 let all_trait_impls = self.resolver_caches.all_trait_impls.take();
138 f(self, all_trait_impls.as_ref().expect("`all_trait_impls` are already borrowed"));
139 self.resolver_caches.all_trait_impls = all_trait_impls;
143 /// Creates a new diagnostic `Handler` that can be used to emit warnings and errors.
145 /// If the given `error_format` is `ErrorOutputType::Json` and no `SourceMap` is given, a new one
146 /// will be created for the handler.
147 pub(crate) fn new_handler(
148 error_format: ErrorOutputType,
149 source_map: Option<Lrc<source_map::SourceMap>>,
150 diagnostic_width: Option<usize>,
151 unstable_opts: &UnstableOptions,
152 ) -> rustc_errors::Handler {
153 let fallback_bundle =
154 rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
155 let emitter: Box<dyn Emitter + sync::Send> = match error_format {
156 ErrorOutputType::HumanReadable(kind) => {
157 let (short, color_config) = kind.unzip();
159 EmitterWriter::stderr(
161 source_map.map(|sm| sm as _),
169 .ui_testing(unstable_opts.ui_testing),
172 ErrorOutputType::Json { pretty, json_rendered } => {
173 let source_map = source_map.unwrap_or_else(|| {
174 Lrc::new(source_map::SourceMap::new(source_map::FilePathMapping::empty()))
187 .ui_testing(unstable_opts.ui_testing),
192 rustc_errors::Handler::with_emitter_and_flags(
194 unstable_opts.diagnostic_handler_flags(true),
198 /// Parse, resolve, and typecheck the given crate.
199 pub(crate) fn create_config(
218 scrape_examples_options,
221 ) -> rustc_interface::Config {
222 // Add the doc cfg into the doc build.
223 cfgs.push("doc".to_string());
225 let cpath = Some(input.clone());
226 let input = Input::File(input);
228 // By default, rustdoc ignores all lints.
229 // Specifically unblock lints relevant to documentation or the lint machinery itself.
230 let mut lints_to_show = vec![
231 // it's unclear whether these should be part of rustdoc directly (#77364)
232 rustc_lint::builtin::MISSING_DOCS.name.to_string(),
233 rustc_lint::builtin::INVALID_DOC_ATTRIBUTES.name.to_string(),
234 // these are definitely not part of rustdoc, but we want to warn on them anyway.
235 rustc_lint::builtin::RENAMED_AND_REMOVED_LINTS.name.to_string(),
236 rustc_lint::builtin::UNKNOWN_LINTS.name.to_string(),
237 rustc_lint::builtin::UNEXPECTED_CFGS.name.to_string(),
238 // this lint is needed to support `#[expect]` attributes
239 rustc_lint::builtin::UNFULFILLED_LINT_EXPECTATIONS.name.to_string(),
241 lints_to_show.extend(crate::lint::RUSTDOC_LINTS.iter().map(|lint| lint.name.to_string()));
243 let (lint_opts, lint_caps) = crate::lint::init_lints(lints_to_show, lint_opts, |lint| {
244 Some((lint.name_lower(), lint::Allow))
248 if proc_macro_crate { vec![CrateType::ProcMacro] } else { vec![CrateType::Rlib] };
249 let test = scrape_examples_options.map(|opts| opts.scrape_tests).unwrap_or(false);
250 // plays with error output here!
251 let sessopts = config::Options {
259 target_triple: target,
260 unstable_features: UnstableFeatures::from_environment(crate_name.as_deref()),
261 actually_rustdoc: true,
274 crate_cfg: interface::parse_cfgspecs(cfgs),
275 crate_check_cfg: interface::parse_check_cfg(check_cfgs),
282 parse_sess_created: None,
283 register_lints: Some(Box::new(crate::lint::register_lints)),
284 override_queries: Some(|_sess, providers, _external_providers| {
285 // Most lints will require typechecking, so just don't run them.
286 providers.lint_mod = |_, _| {};
287 // Prevent `rustc_hir_analysis::check_crate` from calling `typeck` on all bodies.
288 providers.typeck_item_bodies = |_, _| {};
289 // hack so that `used_trait_imports` won't try to call typeck
290 providers.used_trait_imports = |_, _| {
291 static EMPTY_SET: LazyLock<FxHashSet<LocalDefId>> =
292 LazyLock::new(FxHashSet::default);
295 // In case typeck does end up being called, don't ICE in case there were name resolution errors
296 providers.typeck = move |tcx, def_id| {
297 // Closures' tables come from their outermost function,
298 // as they are part of the same "inference environment".
299 // This avoids emitting errors for the parent twice (see similar code in `typeck_with_fallback`)
300 let typeck_root_def_id = tcx.typeck_root_def_id(def_id.to_def_id()).expect_local();
301 if typeck_root_def_id != def_id {
302 return tcx.typeck(typeck_root_def_id);
306 let body = hir.body(hir.body_owned_by(def_id));
307 debug!("visiting body for {:?}", def_id);
308 EmitIgnoredResolutionErrors::new(tcx).visit_body(body);
309 (rustc_interface::DEFAULT_QUERY_PROVIDERS.typeck)(tcx, def_id)
312 make_codegen_backend: None,
313 registry: rustc_driver::diagnostics_registry(),
317 pub(crate) fn run_global_ctxt(
319 resolver: Rc<RefCell<interface::BoxedResolver>>,
320 resolver_caches: ResolverCaches,
322 render_options: RenderOptions,
323 output_format: OutputFormat,
324 ) -> (clean::Crate, RenderOptions, Cache) {
325 // Certain queries assume that some checks were run elsewhere
326 // (see https://github.com/rust-lang/rust/pull/73566#issuecomment-656954425),
327 // so type-check everything other than function bodies in this crate before running lints.
329 // NOTE: this does not call `tcx.analysis()` so that we won't
330 // typeck function bodies or run the default rustc lints.
331 // (see `override_queries` in the `config`)
333 // HACK(jynelson) this calls an _extremely_ limited subset of `typeck`
334 // and might break if queries change their assumptions in the future.
336 // NOTE: This is copy/pasted from typeck/lib.rs and should be kept in sync with those changes.
337 tcx.sess.time("item_types_checking", || {
338 tcx.hir().for_each_module(|module| tcx.ensure().check_mod_item_types(module))
340 tcx.sess.abort_if_errors();
341 tcx.sess.time("missing_docs", || {
342 rustc_lint::check_crate(tcx, rustc_lint::builtin::MissingDoc::new);
344 tcx.sess.time("check_mod_attrs", || {
345 tcx.hir().for_each_module(|module| tcx.ensure().check_mod_attrs(module))
347 rustc_passes::stability::check_unused_or_stable_features(tcx);
350 tcx.all_traits().filter(|&trait_def_id| tcx.trait_is_auto(trait_def_id)).collect();
351 let access_levels = tcx.privacy_access_levels(()).map_id(Into::into);
353 let mut ctxt = DocContext {
357 param_env: ParamEnv::empty(),
358 external_traits: Default::default(),
359 active_extern_traits: Default::default(),
360 substs: Default::default(),
361 impl_trait_bounds: Default::default(),
362 generated_synthetics: Default::default(),
364 cache: Cache::new(access_levels, render_options.document_private),
365 inlined: FxHashSet::default(),
371 // Small hack to force the Sized trait to be present.
373 // Note that in case of `#![no_core]`, the trait is not available.
374 if let Some(sized_trait_did) = ctxt.tcx.lang_items().sized_trait() {
375 let sized_trait = build_external_trait(&mut ctxt, sized_trait_did);
376 ctxt.external_traits.borrow_mut().insert(sized_trait_did, sized_trait);
379 debug!("crate: {:?}", tcx.hir().krate());
381 let mut krate = tcx.sess.time("clean_crate", || clean::krate(&mut ctxt));
383 if krate.module.doc_value().map(|d| d.is_empty()).unwrap_or(true) {
385 "The following guide may be of use:\n\
386 {}/rustdoc/how-to-write-documentation.html",
387 crate::DOC_RUST_LANG_ORG_CHANNEL
389 tcx.struct_lint_node(
390 crate::lint::MISSING_CRATE_LEVEL_DOCS,
391 DocContext::as_local_hir_id(tcx, krate.module.item_id).unwrap(),
392 "no documentation found for this crate's top-level module",
393 |lint| lint.help(help),
397 fn report_deprecated_attr(name: &str, diag: &rustc_errors::Handler, sp: Span) {
399 diag.struct_span_warn(sp, &format!("the `#![doc({})]` attribute is deprecated", name));
401 "see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
402 for more information",
405 if name == "no_default_passes" {
406 msg.help("`#![doc(no_default_passes)]` no longer functions; you may want to use `#![doc(document_private_items)]`");
407 } else if name.starts_with("passes") {
408 msg.help("`#![doc(passes = \"...\")]` no longer functions; you may want to use `#![doc(document_private_items)]`");
409 } else if name.starts_with("plugins") {
410 msg.warn("`#![doc(plugins = \"...\")]` no longer functions; see CVE-2018-1000622 <https://nvd.nist.gov/vuln/detail/CVE-2018-1000622>");
416 // Process all of the crate attributes, extracting plugin metadata along
417 // with the passes which we are supposed to run.
418 for attr in krate.module.attrs.lists(sym::doc) {
419 let diag = ctxt.sess().diagnostic();
421 let name = attr.name_or_empty();
422 // `plugins = "..."`, `no_default_passes`, and `passes = "..."` have no effect
423 if attr.is_word() && name == sym::no_default_passes {
424 report_deprecated_attr("no_default_passes", diag, attr.span());
425 } else if attr.value_str().is_some() {
428 report_deprecated_attr("passes = \"...\"", diag, attr.span());
431 report_deprecated_attr("plugins = \"...\"", diag, attr.span());
437 if attr.is_word() && name == sym::document_private_items {
438 ctxt.render_options.document_private = true;
442 info!("Executing passes");
444 for p in passes::defaults(show_coverage) {
445 let run = match p.condition {
447 WhenDocumentPrivate => ctxt.render_options.document_private,
448 WhenNotDocumentPrivate => !ctxt.render_options.document_private,
449 WhenNotDocumentHidden => !ctxt.render_options.document_hidden,
452 debug!("running pass {}", p.pass.name);
453 krate = tcx.sess.time(p.pass.name, || (p.pass.run)(krate, &mut ctxt));
457 tcx.sess.time("check_lint_expectations", || tcx.check_expectations(Some(sym::rustdoc)));
459 if tcx.sess.diagnostic().has_errors_or_lint_errors().is_some() {
460 rustc_errors::FatalError.raise();
463 krate = tcx.sess.time("create_format_cache", || Cache::populate(&mut ctxt, krate));
465 (krate, ctxt.render_options, ctxt.cache)
468 /// Due to <https://github.com/rust-lang/rust/pull/73566>,
469 /// the name resolution pass may find errors that are never emitted.
470 /// If typeck is called after this happens, then we'll get an ICE:
471 /// 'Res::Error found but not reported'. To avoid this, emit the errors now.
472 struct EmitIgnoredResolutionErrors<'tcx> {
476 impl<'tcx> EmitIgnoredResolutionErrors<'tcx> {
477 fn new(tcx: TyCtxt<'tcx>) -> Self {
482 impl<'tcx> Visitor<'tcx> for EmitIgnoredResolutionErrors<'tcx> {
483 type NestedFilter = nested_filter::OnlyBodies;
485 fn nested_visit_map(&mut self) -> Self::Map {
486 // We need to recurse into nested closures,
487 // since those will fallback to the parent for type checking.
491 fn visit_path(&mut self, path: &'tcx Path<'_>, _id: HirId) {
492 debug!("visiting path {:?}", path);
493 if path.res == Res::Err {
494 // We have less context here than in rustc_resolve,
495 // so we can only emit the name and span.
496 // However we can give a hint that rustc_resolve will have more info.
498 "could not resolve path `{}`",
501 .map(|segment| segment.ident.as_str())
505 let mut err = rustc_errors::struct_span_err!(
509 "failed to resolve: {}",
512 err.span_label(path.span, label);
513 err.note("this error was originally ignored because you are running `rustdoc`");
514 err.note("try running again with `rustc` or `cargo check` and you may get a more detailed error");
517 // We could have an outer resolution that succeeded,
518 // but with generic parameters that failed.
519 // Recurse into the segments so we catch those too.
520 intravisit::walk_path(self, path);
524 /// `DefId` or parameter index (`ty::ParamTy.index`) of a synthetic type parameter
525 /// for `impl Trait` in argument position.
526 #[derive(Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
527 pub(crate) enum ImplTraitParam {
532 impl From<DefId> for ImplTraitParam {
533 fn from(did: DefId) -> Self {
534 ImplTraitParam::DefId(did)
538 impl From<u32> for ImplTraitParam {
539 fn from(idx: u32) -> Self {
540 ImplTraitParam::ParamIndex(idx)