rustdoc/
core.rs

1use std::sync::{Arc, LazyLock};
2use std::{io, mem};
3
4use rustc_data_structures::fx::{FxHashMap, FxHashSet, FxIndexMap};
5use rustc_data_structures::unord::UnordSet;
6use rustc_driver::USING_INTERNAL_FEATURES;
7use rustc_errors::TerminalUrl;
8use rustc_errors::annotate_snippet_emitter_writer::AnnotateSnippetEmitter;
9use rustc_errors::codes::*;
10use rustc_errors::emitter::{DynEmitter, HumanReadableErrorType, OutputTheme, stderr_destination};
11use rustc_errors::json::JsonEmitter;
12use rustc_feature::UnstableFeatures;
13use rustc_hir::def::Res;
14use rustc_hir::def_id::{DefId, DefIdMap, DefIdSet, LocalDefId};
15use rustc_hir::intravisit::{self, Visitor};
16use rustc_hir::{HirId, Path};
17use rustc_lint::{MissingDoc, late_lint_mod};
18use rustc_middle::hir::nested_filter;
19use rustc_middle::ty::{self, ParamEnv, Ty, TyCtxt};
20use rustc_session::config::{
21    self, CrateType, ErrorOutputType, Input, OutputType, OutputTypes, ResolveDocLinks,
22};
23pub(crate) use rustc_session::config::{Options, UnstableOptions};
24use rustc_session::{Session, lint};
25use rustc_span::source_map;
26use rustc_span::symbol::sym;
27use tracing::{debug, info};
28
29use crate::clean::inline::build_trait;
30use crate::clean::{self, ItemId};
31use crate::config::{Options as RustdocOptions, OutputFormat, RenderOptions};
32use crate::formats::cache::Cache;
33use crate::html::macro_expansion::{ExpandedCode, source_macro_expansion};
34use crate::passes;
35use crate::passes::Condition::*;
36use crate::passes::collect_intra_doc_links::LinkCollector;
37
38pub(crate) struct DocContext<'tcx> {
39    pub(crate) tcx: TyCtxt<'tcx>,
40    /// Used for normalization.
41    ///
42    /// Most of this logic is copied from rustc_lint::late.
43    pub(crate) param_env: ParamEnv<'tcx>,
44    /// Later on moved through `clean::Crate` into `cache`
45    pub(crate) external_traits: FxIndexMap<DefId, clean::Trait>,
46    /// Used while populating `external_traits` to ensure we don't process the same trait twice at
47    /// the same time.
48    pub(crate) active_extern_traits: DefIdSet,
49    /// The current set of parameter instantiations for expanding type aliases at the HIR level.
50    ///
51    /// Maps from the `DefId` of a lifetime or type parameter to the
52    /// generic argument it's currently instantiated to in this context.
53    // FIXME(#82852): We don't record const params since we don't visit const exprs at all and
54    // therefore wouldn't use the corresp. generic arg anyway. Add support for them.
55    pub(crate) args: DefIdMap<clean::GenericArg>,
56    pub(crate) current_type_aliases: DefIdMap<usize>,
57    /// Table synthetic type parameter for `impl Trait` in argument position -> bounds
58    pub(crate) impl_trait_bounds: FxHashMap<ImplTraitParam, Vec<clean::GenericBound>>,
59    /// Auto-trait or blanket impls processed so far, as `(self_ty, trait_def_id)`.
60    // FIXME(eddyb) make this a `ty::TraitRef<'tcx>` set.
61    pub(crate) generated_synthetics: FxHashSet<(Ty<'tcx>, DefId)>,
62    pub(crate) auto_traits: Vec<DefId>,
63    /// This same cache is used throughout rustdoc, including in [`crate::html::render`].
64    pub(crate) cache: Cache,
65    /// Used by [`clean::inline`] to tell if an item has already been inlined.
66    pub(crate) inlined: FxHashSet<ItemId>,
67    /// Used by `calculate_doc_coverage`.
68    pub(crate) output_format: OutputFormat,
69    /// Used by `strip_private`.
70    pub(crate) show_coverage: bool,
71}
72
73impl<'tcx> DocContext<'tcx> {
74    pub(crate) fn sess(&self) -> &'tcx Session {
75        self.tcx.sess
76    }
77
78    pub(crate) fn with_param_env<T, F: FnOnce(&mut Self) -> T>(
79        &mut self,
80        def_id: DefId,
81        f: F,
82    ) -> T {
83        let old_param_env = mem::replace(&mut self.param_env, self.tcx.param_env(def_id));
84        let ret = f(self);
85        self.param_env = old_param_env;
86        ret
87    }
88
89    pub(crate) fn typing_env(&self) -> ty::TypingEnv<'tcx> {
90        ty::TypingEnv {
91            typing_mode: ty::TypingMode::non_body_analysis(),
92            param_env: self.param_env,
93        }
94    }
95
96    /// Call the closure with the given parameters set as
97    /// the generic parameters for a type alias' RHS.
98    pub(crate) fn enter_alias<F, R>(
99        &mut self,
100        args: DefIdMap<clean::GenericArg>,
101        def_id: DefId,
102        f: F,
103    ) -> R
104    where
105        F: FnOnce(&mut Self) -> R,
106    {
107        let old_args = mem::replace(&mut self.args, args);
108        *self.current_type_aliases.entry(def_id).or_insert(0) += 1;
109        let r = f(self);
110        self.args = old_args;
111        if let Some(count) = self.current_type_aliases.get_mut(&def_id) {
112            *count -= 1;
113            if *count == 0 {
114                self.current_type_aliases.remove(&def_id);
115            }
116        }
117        r
118    }
119
120    /// Like `tcx.local_def_id_to_hir_id()`, but skips calling it on fake DefIds.
121    /// (This avoids a slice-index-out-of-bounds panic.)
122    pub(crate) fn as_local_hir_id(tcx: TyCtxt<'_>, item_id: ItemId) -> Option<HirId> {
123        match item_id {
124            ItemId::DefId(real_id) => {
125                real_id.as_local().map(|def_id| tcx.local_def_id_to_hir_id(def_id))
126            }
127            // FIXME: Can this be `Some` for `Auto` or `Blanket`?
128            _ => None,
129        }
130    }
131
132    /// Returns `true` if the JSON output format is enabled for generating the crate content.
133    ///
134    /// If another option like `--show-coverage` is enabled, it will return `false`.
135    pub(crate) fn is_json_output(&self) -> bool {
136        self.output_format.is_json() && !self.show_coverage
137    }
138
139    /// If `--document-private-items` was passed to rustdoc.
140    pub(crate) fn document_private(&self) -> bool {
141        self.cache.document_private
142    }
143
144    /// If `--document-hidden-items` was passed to rustdoc.
145    pub(crate) fn document_hidden(&self) -> bool {
146        self.cache.document_hidden
147    }
148}
149
150/// Creates a new `DiagCtxt` that can be used to emit warnings and errors.
151///
152/// If the given `error_format` is `ErrorOutputType::Json` and no `SourceMap` is given, a new one
153/// will be created for the `DiagCtxt`.
154pub(crate) fn new_dcx(
155    error_format: ErrorOutputType,
156    source_map: Option<Arc<source_map::SourceMap>>,
157    diagnostic_width: Option<usize>,
158    unstable_opts: &UnstableOptions,
159) -> rustc_errors::DiagCtxt {
160    let translator = rustc_driver::default_translator();
161    let emitter: Box<DynEmitter> = match error_format {
162        ErrorOutputType::HumanReadable { kind, color_config } => match kind {
163            HumanReadableErrorType { short, unicode } => Box::new(
164                AnnotateSnippetEmitter::new(stderr_destination(color_config), translator)
165                    .sm(source_map.map(|sm| sm as _))
166                    .short_message(short)
167                    .diagnostic_width(diagnostic_width)
168                    .track_diagnostics(unstable_opts.track_diagnostics)
169                    .theme(if unicode { OutputTheme::Unicode } else { OutputTheme::Ascii })
170                    .ui_testing(unstable_opts.ui_testing),
171            ),
172        },
173        ErrorOutputType::Json { pretty, json_rendered, color_config } => {
174            let source_map = source_map.unwrap_or_else(|| {
175                Arc::new(source_map::SourceMap::new(source_map::FilePathMapping::empty()))
176            });
177            Box::new(
178                JsonEmitter::new(
179                    Box::new(io::BufWriter::new(io::stderr())),
180                    Some(source_map),
181                    translator,
182                    pretty,
183                    json_rendered,
184                    color_config,
185                )
186                .ui_testing(unstable_opts.ui_testing)
187                .diagnostic_width(diagnostic_width)
188                .track_diagnostics(unstable_opts.track_diagnostics)
189                .terminal_url(TerminalUrl::No),
190            )
191        }
192    };
193
194    rustc_errors::DiagCtxt::new(emitter).with_flags(unstable_opts.dcx_flags(true))
195}
196
197/// Parse, resolve, and typecheck the given crate.
198pub(crate) fn create_config(
199    input: Input,
200    RustdocOptions {
201        crate_name,
202        proc_macro_crate,
203        error_format,
204        diagnostic_width,
205        libs,
206        externs,
207        mut cfgs,
208        check_cfgs,
209        codegen_options,
210        unstable_opts,
211        target,
212        edition,
213        sysroot,
214        lint_opts,
215        describe_lints,
216        lint_cap,
217        scrape_examples_options,
218        remap_path_prefix,
219        target_modifiers,
220        ..
221    }: RustdocOptions,
222    render_options: &RenderOptions,
223) -> rustc_interface::Config {
224    // Add the doc cfg into the doc build.
225    cfgs.push("doc".to_string());
226
227    // By default, rustdoc ignores all lints.
228    // Specifically unblock lints relevant to documentation or the lint machinery itself.
229    let mut lints_to_show = vec![
230        // it's unclear whether these should be part of rustdoc directly (#77364)
231        rustc_lint::builtin::MISSING_DOCS.name.to_string(),
232        rustc_lint::builtin::INVALID_DOC_ATTRIBUTES.name.to_string(),
233        // these are definitely not part of rustdoc, but we want to warn on them anyway.
234        rustc_lint::builtin::RENAMED_AND_REMOVED_LINTS.name.to_string(),
235        rustc_lint::builtin::UNKNOWN_LINTS.name.to_string(),
236        rustc_lint::builtin::UNEXPECTED_CFGS.name.to_string(),
237        // this lint is needed to support `#[expect]` attributes
238        rustc_lint::builtin::UNFULFILLED_LINT_EXPECTATIONS.name.to_string(),
239    ];
240    lints_to_show.extend(crate::lint::RUSTDOC_LINTS.iter().map(|lint| lint.name.to_string()));
241
242    let (lint_opts, lint_caps) = crate::lint::init_lints(lints_to_show, lint_opts, |lint| {
243        Some((lint.name_lower(), lint::Allow))
244    });
245
246    let crate_types =
247        if proc_macro_crate { vec![CrateType::ProcMacro] } else { vec![CrateType::Rlib] };
248    let resolve_doc_links = if render_options.document_private {
249        ResolveDocLinks::All
250    } else {
251        ResolveDocLinks::Exported
252    };
253    let test = scrape_examples_options.map(|opts| opts.scrape_tests).unwrap_or(false);
254    // plays with error output here!
255    let sessopts = config::Options {
256        sysroot,
257        search_paths: libs,
258        crate_types,
259        lint_opts,
260        lint_cap,
261        cg: codegen_options,
262        externs,
263        target_triple: target,
264        unstable_features: UnstableFeatures::from_environment(crate_name.as_deref()),
265        actually_rustdoc: true,
266        resolve_doc_links,
267        unstable_opts,
268        error_format,
269        diagnostic_width,
270        edition,
271        describe_lints,
272        crate_name,
273        test,
274        remap_path_prefix,
275        output_types: if let Some(file) = render_options.dep_info() {
276            OutputTypes::new(&[(OutputType::DepInfo, file.cloned())])
277        } else {
278            OutputTypes::new(&[])
279        },
280        target_modifiers,
281        ..Options::default()
282    };
283
284    rustc_interface::Config {
285        opts: sessopts,
286        crate_cfg: cfgs,
287        crate_check_cfg: check_cfgs,
288        input,
289        output_file: None,
290        output_dir: None,
291        file_loader: None,
292        lint_caps,
293        psess_created: None,
294        hash_untracked_state: None,
295        register_lints: Some(Box::new(crate::lint::register_lints)),
296        override_queries: Some(|_sess, providers| {
297            // We do not register late module lints, so this only runs `MissingDoc`.
298            // Most lints will require typechecking, so just don't run them.
299            providers.queries.lint_mod =
300                |tcx, module_def_id| late_lint_mod(tcx, module_def_id, MissingDoc);
301            // hack so that `used_trait_imports` won't try to call typeck
302            providers.queries.used_trait_imports = |_, _| {
303                static EMPTY_SET: LazyLock<UnordSet<LocalDefId>> = LazyLock::new(UnordSet::default);
304                &EMPTY_SET
305            };
306            // In case typeck does end up being called, don't ICE in case there were name resolution errors
307            providers.queries.typeck = move |tcx, def_id| {
308                // Closures' tables come from their outermost function,
309                // as they are part of the same "inference environment".
310                // This avoids emitting errors for the parent twice (see similar code in `typeck_with_fallback`)
311                let typeck_root_def_id = tcx.typeck_root_def_id(def_id.to_def_id()).expect_local();
312                if typeck_root_def_id != def_id {
313                    return tcx.typeck(typeck_root_def_id);
314                }
315
316                let body = tcx.hir_body_owned_by(def_id);
317                debug!("visiting body for {def_id:?}");
318                EmitIgnoredResolutionErrors::new(tcx).visit_body(body);
319                (rustc_interface::DEFAULT_QUERY_PROVIDERS.queries.typeck)(tcx, def_id)
320            };
321        }),
322        extra_symbols: Vec::new(),
323        make_codegen_backend: None,
324        ice_file: None,
325        using_internal_features: &USING_INTERNAL_FEATURES,
326    }
327}
328
329pub(crate) fn run_global_ctxt(
330    tcx: TyCtxt<'_>,
331    show_coverage: bool,
332    render_options: RenderOptions,
333    output_format: OutputFormat,
334) -> (clean::Crate, RenderOptions, Cache, FxHashMap<rustc_span::BytePos, Vec<ExpandedCode>>) {
335    // Certain queries assume that some checks were run elsewhere
336    // (see https://github.com/rust-lang/rust/pull/73566#issuecomment-656954425),
337    // so type-check everything other than function bodies in this crate before running lints.
338
339    let expanded_macros = {
340        // We need for these variables to be removed to ensure that the `Crate` won't be "stolen"
341        // anymore.
342        let (_resolver, krate) = &*tcx.resolver_for_lowering().borrow();
343
344        source_macro_expansion(&krate, &render_options, output_format, tcx.sess.source_map())
345    };
346
347    // NOTE: this does not call `tcx.analysis()` so that we won't
348    // typeck function bodies or run the default rustc lints.
349    // (see `override_queries` in the `config`)
350
351    // NOTE: These are copy/pasted from typeck/lib.rs and should be kept in sync with those changes.
352    let _ = tcx.sess.time("wf_checking", || tcx.ensure_ok().check_type_wf(()));
353
354    tcx.dcx().abort_if_errors();
355
356    tcx.sess.time("missing_docs", || rustc_lint::check_crate(tcx));
357    tcx.sess.time("check_mod_attrs", || {
358        tcx.hir_for_each_module(|module| tcx.ensure_ok().check_mod_attrs(module))
359    });
360    rustc_passes::stability::check_unused_or_stable_features(tcx);
361
362    let auto_traits =
363        tcx.visible_traits().filter(|&trait_def_id| tcx.trait_is_auto(trait_def_id)).collect();
364
365    let mut ctxt = DocContext {
366        tcx,
367        param_env: ParamEnv::empty(),
368        external_traits: Default::default(),
369        active_extern_traits: Default::default(),
370        args: Default::default(),
371        current_type_aliases: Default::default(),
372        impl_trait_bounds: Default::default(),
373        generated_synthetics: Default::default(),
374        auto_traits,
375        cache: Cache::new(render_options.document_private, render_options.document_hidden),
376        inlined: FxHashSet::default(),
377        output_format,
378        show_coverage,
379    };
380
381    for cnum in tcx.crates(()) {
382        crate::visit_lib::lib_embargo_visit_item(&mut ctxt, cnum.as_def_id());
383    }
384
385    // Small hack to force the Sized trait to be present.
386    //
387    // Note that in case of `#![no_core]`, the trait is not available.
388    if let Some(sized_trait_did) = ctxt.tcx.lang_items().sized_trait() {
389        let sized_trait = build_trait(&mut ctxt, sized_trait_did);
390        ctxt.external_traits.insert(sized_trait_did, sized_trait);
391    }
392
393    let mut krate = tcx.sess.time("clean_crate", || clean::krate(&mut ctxt));
394
395    if krate.module.doc_value().is_empty() {
396        let help = format!(
397            "The following guide may be of use:\n\
398            {}/rustdoc/how-to-write-documentation.html",
399            crate::DOC_RUST_LANG_ORG_VERSION
400        );
401        tcx.node_lint(
402            crate::lint::MISSING_CRATE_LEVEL_DOCS,
403            DocContext::as_local_hir_id(tcx, krate.module.item_id).unwrap(),
404            |lint| {
405                if let Some(local_def_id) = krate.module.item_id.as_local_def_id() {
406                    lint.span(tcx.def_span(local_def_id));
407                }
408                lint.primary_message("no documentation found for this crate's top-level module");
409                lint.help(help);
410            },
411        );
412    }
413
414    info!("Executing passes");
415
416    let mut visited = FxHashMap::default();
417    let mut ambiguous = FxIndexMap::default();
418
419    for p in passes::defaults(show_coverage) {
420        let run = match p.condition {
421            Always => true,
422            WhenDocumentPrivate => ctxt.document_private(),
423            WhenNotDocumentPrivate => !ctxt.document_private(),
424            WhenNotDocumentHidden => !ctxt.document_hidden(),
425        };
426        if run {
427            debug!("running pass {}", p.pass.name);
428            if let Some(run_fn) = p.pass.run {
429                krate = tcx.sess.time(p.pass.name, || run_fn(krate, &mut ctxt));
430            } else {
431                let (k, LinkCollector { visited_links, ambiguous_links, .. }) =
432                    passes::collect_intra_doc_links::collect_intra_doc_links(krate, &mut ctxt);
433                krate = k;
434                visited = visited_links;
435                ambiguous = ambiguous_links;
436            }
437        }
438    }
439
440    tcx.sess.time("check_lint_expectations", || tcx.check_expectations(Some(sym::rustdoc)));
441
442    krate =
443        tcx.sess.time("create_format_cache", || Cache::populate(&mut ctxt, krate, &render_options));
444
445    let mut collector =
446        LinkCollector { cx: &mut ctxt, visited_links: visited, ambiguous_links: ambiguous };
447    collector.resolve_ambiguities();
448
449    tcx.dcx().abort_if_errors();
450
451    (krate, render_options, ctxt.cache, expanded_macros)
452}
453
454/// Due to <https://github.com/rust-lang/rust/pull/73566>,
455/// the name resolution pass may find errors that are never emitted.
456/// If typeck is called after this happens, then we'll get an ICE:
457/// 'Res::Error found but not reported'. To avoid this, emit the errors now.
458struct EmitIgnoredResolutionErrors<'tcx> {
459    tcx: TyCtxt<'tcx>,
460}
461
462impl<'tcx> EmitIgnoredResolutionErrors<'tcx> {
463    fn new(tcx: TyCtxt<'tcx>) -> Self {
464        Self { tcx }
465    }
466}
467
468impl<'tcx> Visitor<'tcx> for EmitIgnoredResolutionErrors<'tcx> {
469    type NestedFilter = nested_filter::OnlyBodies;
470
471    fn maybe_tcx(&mut self) -> Self::MaybeTyCtxt {
472        // We need to recurse into nested closures,
473        // since those will fallback to the parent for type checking.
474        self.tcx
475    }
476
477    fn visit_path(&mut self, path: &Path<'tcx>, _id: HirId) {
478        debug!("visiting path {path:?}");
479        if path.res == Res::Err {
480            // We have less context here than in rustc_resolve,
481            // so we can only emit the name and span.
482            // However we can give a hint that rustc_resolve will have more info.
483            let label = format!(
484                "could not resolve path `{}`",
485                path.segments
486                    .iter()
487                    .map(|segment| segment.ident.as_str())
488                    .intersperse("::")
489                    .collect::<String>()
490            );
491            rustc_errors::struct_span_code_err!(
492                self.tcx.dcx(),
493                path.span,
494                E0433,
495                "failed to resolve: {label}",
496            )
497            .with_span_label(path.span, label)
498            .with_note("this error was originally ignored because you are running `rustdoc`")
499            .with_note("try running again with `rustc` or `cargo check` and you may get a more detailed error")
500            .emit();
501        }
502        // We could have an outer resolution that succeeded,
503        // but with generic parameters that failed.
504        // Recurse into the segments so we catch those too.
505        intravisit::walk_path(self, path);
506    }
507}
508
509/// `DefId` or parameter index (`ty::ParamTy.index`) of a synthetic type parameter
510/// for `impl Trait` in argument position.
511#[derive(Clone, Copy, PartialEq, Eq, Hash)]
512pub(crate) enum ImplTraitParam {
513    DefId(DefId),
514    ParamIndex(u32),
515}
516
517impl From<DefId> for ImplTraitParam {
518    fn from(did: DefId) -> Self {
519        ImplTraitParam::DefId(did)
520    }
521}
522
523impl From<u32> for ImplTraitParam {
524    fn from(idx: u32) -> Self {
525        ImplTraitParam::ParamIndex(idx)
526    }
527}
rustdoc/core.rs

rustdoc/
core.rs
