]> git.lizzy.rs Git - rust.git/blob - src/librustdoc/core.rs
Rollup merge of #98972 - TaKO8Ki:suggest-adding-missing-zero-to-floating-point-number...
[rust.git] / src / librustdoc / core.rs
1 use rustc_ast::NodeId;
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::middle::privacy::AccessLevels;
14 use rustc_middle::ty::{ParamEnv, Ty, TyCtxt};
15 use rustc_resolve as resolve;
16 use rustc_session::config::{self, CrateType, ErrorOutputType};
17 use rustc_session::lint;
18 use rustc_session::DiagnosticOutput;
19 use rustc_session::Session;
20 use rustc_span::symbol::sym;
21 use rustc_span::{source_map, Span, Symbol};
22
23 use std::cell::RefCell;
24 use std::mem;
25 use std::rc::Rc;
26 use std::sync::LazyLock;
27
28 use crate::clean::inline::build_external_trait;
29 use crate::clean::{self, ItemId, TraitWithExtraInfo};
30 use crate::config::{Options as RustdocOptions, OutputFormat, RenderOptions};
31 use crate::formats::cache::Cache;
32 use crate::passes::collect_intra_doc_links::PreprocessedMarkdownLink;
33 use crate::passes::{self, Condition::*};
34
35 pub(crate) use rustc_session::config::{DebuggingOptions, Input, Options};
36
37 pub(crate) struct ResolverCaches {
38     pub(crate) markdown_links: Option<FxHashMap<String, Vec<PreprocessedMarkdownLink>>>,
39     pub(crate) doc_link_resolutions: FxHashMap<(Symbol, Namespace, DefId), Option<Res<NodeId>>>,
40     /// Traits in scope for a given module.
41     /// See `collect_intra_doc_links::traits_implemented_by` for more details.
42     pub(crate) traits_in_scope: DefIdMap<Vec<TraitCandidate>>,
43     pub(crate) all_traits: Option<Vec<DefId>>,
44     pub(crate) all_trait_impls: Option<Vec<DefId>>,
45     pub(crate) all_macro_rules: FxHashMap<Symbol, Res<NodeId>>,
46 }
47
48 pub(crate) struct DocContext<'tcx> {
49     pub(crate) tcx: TyCtxt<'tcx>,
50     /// Name resolver. Used for intra-doc links.
51     ///
52     /// The `Rc<RefCell<...>>` wrapping is needed because that is what's returned by
53     /// [`rustc_interface::Queries::expansion()`].
54     // FIXME: see if we can get rid of this RefCell somehow
55     pub(crate) resolver: Rc<RefCell<interface::BoxedResolver>>,
56     pub(crate) resolver_caches: ResolverCaches,
57     /// Used for normalization.
58     ///
59     /// Most of this logic is copied from rustc_lint::late.
60     pub(crate) param_env: ParamEnv<'tcx>,
61     /// Later on moved through `clean::Crate` into `cache`
62     pub(crate) external_traits: Rc<RefCell<FxHashMap<DefId, clean::TraitWithExtraInfo>>>,
63     /// Used while populating `external_traits` to ensure we don't process the same trait twice at
64     /// the same time.
65     pub(crate) active_extern_traits: FxHashSet<DefId>,
66     // The current set of parameter substitutions,
67     // for expanding type aliases at the HIR level:
68     /// Table `DefId` of type, lifetime, or const parameter -> substituted type, lifetime, or const
69     pub(crate) substs: FxHashMap<DefId, clean::SubstParam>,
70     /// Table synthetic type parameter for `impl Trait` in argument position -> bounds
71     pub(crate) impl_trait_bounds: FxHashMap<ImplTraitParam, Vec<clean::GenericBound>>,
72     /// Auto-trait or blanket impls processed so far, as `(self_ty, trait_def_id)`.
73     // FIXME(eddyb) make this a `ty::TraitRef<'tcx>` set.
74     pub(crate) generated_synthetics: FxHashSet<(Ty<'tcx>, DefId)>,
75     pub(crate) auto_traits: Vec<DefId>,
76     /// The options given to rustdoc that could be relevant to a pass.
77     pub(crate) render_options: RenderOptions,
78     /// This same cache is used throughout rustdoc, including in [`crate::html::render`].
79     pub(crate) cache: Cache,
80     /// Used by [`clean::inline`] to tell if an item has already been inlined.
81     pub(crate) inlined: FxHashSet<ItemId>,
82     /// Used by `calculate_doc_coverage`.
83     pub(crate) output_format: OutputFormat,
84 }
85
86 impl<'tcx> DocContext<'tcx> {
87     pub(crate) fn sess(&self) -> &'tcx Session {
88         self.tcx.sess
89     }
90
91     pub(crate) fn with_param_env<T, F: FnOnce(&mut Self) -> T>(
92         &mut self,
93         def_id: DefId,
94         f: F,
95     ) -> T {
96         let old_param_env = mem::replace(&mut self.param_env, self.tcx.param_env(def_id));
97         let ret = f(self);
98         self.param_env = old_param_env;
99         ret
100     }
101
102     pub(crate) fn enter_resolver<F, R>(&self, f: F) -> R
103     where
104         F: FnOnce(&mut resolve::Resolver<'_>) -> R,
105     {
106         self.resolver.borrow_mut().access(f)
107     }
108
109     /// Call the closure with the given parameters set as
110     /// the substitutions for a type alias' RHS.
111     pub(crate) fn enter_alias<F, R>(
112         &mut self,
113         substs: FxHashMap<DefId, clean::SubstParam>,
114         f: F,
115     ) -> R
116     where
117         F: FnOnce(&mut Self) -> R,
118     {
119         let old_substs = mem::replace(&mut self.substs, substs);
120         let r = f(self);
121         self.substs = old_substs;
122         r
123     }
124
125     /// Like `hir().local_def_id_to_hir_id()`, but skips calling it on fake DefIds.
126     /// (This avoids a slice-index-out-of-bounds panic.)
127     pub(crate) fn as_local_hir_id(tcx: TyCtxt<'_>, item_id: ItemId) -> Option<HirId> {
128         match item_id {
129             ItemId::DefId(real_id) => {
130                 real_id.as_local().map(|def_id| tcx.hir().local_def_id_to_hir_id(def_id))
131             }
132             // FIXME: Can this be `Some` for `Auto` or `Blanket`?
133             _ => None,
134         }
135     }
136
137     pub(crate) fn with_all_traits(&mut self, f: impl FnOnce(&mut Self, &[DefId])) {
138         let all_traits = self.resolver_caches.all_traits.take();
139         f(self, all_traits.as_ref().expect("`all_traits` are already borrowed"));
140         self.resolver_caches.all_traits = all_traits;
141     }
142
143     pub(crate) fn with_all_trait_impls(&mut self, f: impl FnOnce(&mut Self, &[DefId])) {
144         let all_trait_impls = self.resolver_caches.all_trait_impls.take();
145         f(self, all_trait_impls.as_ref().expect("`all_trait_impls` are already borrowed"));
146         self.resolver_caches.all_trait_impls = all_trait_impls;
147     }
148 }
149
150 /// Creates a new diagnostic `Handler` 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 handler.
154 pub(crate) fn new_handler(
155     error_format: ErrorOutputType,
156     source_map: Option<Lrc<source_map::SourceMap>>,
157     diagnostic_width: Option<usize>,
158     debugging_opts: &DebuggingOptions,
159 ) -> rustc_errors::Handler {
160     let fallback_bundle =
161         rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
162     let emitter: Box<dyn Emitter + sync::Send> = match error_format {
163         ErrorOutputType::HumanReadable(kind) => {
164             let (short, color_config) = kind.unzip();
165             Box::new(
166                 EmitterWriter::stderr(
167                     color_config,
168                     source_map.map(|sm| sm as _),
169                     None,
170                     fallback_bundle,
171                     short,
172                     debugging_opts.teach,
173                     diagnostic_width,
174                     false,
175                 )
176                 .ui_testing(debugging_opts.ui_testing),
177             )
178         }
179         ErrorOutputType::Json { pretty, json_rendered } => {
180             let source_map = source_map.unwrap_or_else(|| {
181                 Lrc::new(source_map::SourceMap::new(source_map::FilePathMapping::empty()))
182             });
183             Box::new(
184                 JsonEmitter::stderr(
185                     None,
186                     source_map,
187                     None,
188                     fallback_bundle,
189                     pretty,
190                     json_rendered,
191                     diagnostic_width,
192                     false,
193                 )
194                 .ui_testing(debugging_opts.ui_testing),
195             )
196         }
197     };
198
199     rustc_errors::Handler::with_emitter_and_flags(
200         emitter,
201         debugging_opts.diagnostic_handler_flags(true),
202     )
203 }
204
205 /// Parse, resolve, and typecheck the given crate.
206 pub(crate) fn create_config(
207     RustdocOptions {
208         input,
209         crate_name,
210         proc_macro_crate,
211         error_format,
212         diagnostic_width,
213         libs,
214         externs,
215         mut cfgs,
216         check_cfgs,
217         codegen_options,
218         debugging_opts,
219         target,
220         edition,
221         maybe_sysroot,
222         lint_opts,
223         describe_lints,
224         lint_cap,
225         scrape_examples_options,
226         ..
227     }: RustdocOptions,
228 ) -> rustc_interface::Config {
229     // Add the doc cfg into the doc build.
230     cfgs.push("doc".to_string());
231
232     let cpath = Some(input.clone());
233     let input = Input::File(input);
234
235     // By default, rustdoc ignores all lints.
236     // Specifically unblock lints relevant to documentation or the lint machinery itself.
237     let mut lints_to_show = vec![
238         // it's unclear whether these should be part of rustdoc directly (#77364)
239         rustc_lint::builtin::MISSING_DOCS.name.to_string(),
240         rustc_lint::builtin::INVALID_DOC_ATTRIBUTES.name.to_string(),
241         // these are definitely not part of rustdoc, but we want to warn on them anyway.
242         rustc_lint::builtin::RENAMED_AND_REMOVED_LINTS.name.to_string(),
243         rustc_lint::builtin::UNKNOWN_LINTS.name.to_string(),
244         rustc_lint::builtin::UNEXPECTED_CFGS.name.to_string(),
245         // this lint is needed to support `#[expect]` attributes
246         rustc_lint::builtin::UNFULFILLED_LINT_EXPECTATIONS.name.to_string(),
247     ];
248     lints_to_show.extend(crate::lint::RUSTDOC_LINTS.iter().map(|lint| lint.name.to_string()));
249
250     let (lint_opts, lint_caps) = crate::lint::init_lints(lints_to_show, lint_opts, |lint| {
251         Some((lint.name_lower(), lint::Allow))
252     });
253
254     let crate_types =
255         if proc_macro_crate { vec![CrateType::ProcMacro] } else { vec![CrateType::Rlib] };
256     let test = scrape_examples_options.map(|opts| opts.scrape_tests).unwrap_or(false);
257     // plays with error output here!
258     let sessopts = config::Options {
259         maybe_sysroot,
260         search_paths: libs,
261         crate_types,
262         lint_opts,
263         lint_cap,
264         cg: codegen_options,
265         externs,
266         target_triple: target,
267         unstable_features: UnstableFeatures::from_environment(crate_name.as_deref()),
268         actually_rustdoc: true,
269         debugging_opts,
270         error_format,
271         diagnostic_width,
272         edition,
273         describe_lints,
274         crate_name,
275         test,
276         ..Options::default()
277     };
278
279     interface::Config {
280         opts: sessopts,
281         crate_cfg: interface::parse_cfgspecs(cfgs),
282         crate_check_cfg: interface::parse_check_cfg(check_cfgs),
283         input,
284         input_path: cpath,
285         output_file: None,
286         output_dir: None,
287         file_loader: None,
288         diagnostic_output: DiagnosticOutput::Default,
289         lint_caps,
290         parse_sess_created: None,
291         register_lints: Some(box crate::lint::register_lints),
292         override_queries: Some(|_sess, providers, _external_providers| {
293             // Most lints will require typechecking, so just don't run them.
294             providers.lint_mod = |_, _| {};
295             // Prevent `rustc_typeck::check_crate` from calling `typeck` on all bodies.
296             providers.typeck_item_bodies = |_, _| {};
297             // hack so that `used_trait_imports` won't try to call typeck
298             providers.used_trait_imports = |_, _| {
299                 static EMPTY_SET: LazyLock<FxHashSet<LocalDefId>> =
300                     LazyLock::new(FxHashSet::default);
301                 &EMPTY_SET
302             };
303             // In case typeck does end up being called, don't ICE in case there were name resolution errors
304             providers.typeck = move |tcx, def_id| {
305                 // Closures' tables come from their outermost function,
306                 // as they are part of the same "inference environment".
307                 // This avoids emitting errors for the parent twice (see similar code in `typeck_with_fallback`)
308                 let typeck_root_def_id = tcx.typeck_root_def_id(def_id.to_def_id()).expect_local();
309                 if typeck_root_def_id != def_id {
310                     return tcx.typeck(typeck_root_def_id);
311                 }
312
313                 let hir = tcx.hir();
314                 let body = hir.body(hir.body_owned_by(hir.local_def_id_to_hir_id(def_id)));
315                 debug!("visiting body for {:?}", def_id);
316                 EmitIgnoredResolutionErrors::new(tcx).visit_body(body);
317                 (rustc_interface::DEFAULT_QUERY_PROVIDERS.typeck)(tcx, def_id)
318             };
319         }),
320         make_codegen_backend: None,
321         registry: rustc_driver::diagnostics_registry(),
322     }
323 }
324
325 pub(crate) fn run_global_ctxt(
326     tcx: TyCtxt<'_>,
327     resolver: Rc<RefCell<interface::BoxedResolver>>,
328     resolver_caches: ResolverCaches,
329     show_coverage: bool,
330     render_options: RenderOptions,
331     output_format: OutputFormat,
332 ) -> (clean::Crate, RenderOptions, Cache) {
333     // Certain queries assume that some checks were run elsewhere
334     // (see https://github.com/rust-lang/rust/pull/73566#issuecomment-656954425),
335     // so type-check everything other than function bodies in this crate before running lints.
336
337     // NOTE: this does not call `tcx.analysis()` so that we won't
338     // typeck function bodies or run the default rustc lints.
339     // (see `override_queries` in the `config`)
340
341     // HACK(jynelson) this calls an _extremely_ limited subset of `typeck`
342     // and might break if queries change their assumptions in the future.
343
344     // NOTE: This is copy/pasted from typeck/lib.rs and should be kept in sync with those changes.
345     tcx.sess.time("item_types_checking", || {
346         tcx.hir().for_each_module(|module| tcx.ensure().check_mod_item_types(module))
347     });
348     tcx.sess.abort_if_errors();
349     tcx.sess.time("missing_docs", || {
350         rustc_lint::check_crate(tcx, rustc_lint::builtin::MissingDoc::new);
351     });
352     tcx.sess.time("check_mod_attrs", || {
353         tcx.hir().for_each_module(|module| tcx.ensure().check_mod_attrs(module))
354     });
355     rustc_passes::stability::check_unused_or_stable_features(tcx);
356
357     let auto_traits = resolver_caches
358         .all_traits
359         .as_ref()
360         .expect("`all_traits` are already borrowed")
361         .iter()
362         .copied()
363         .filter(|&trait_def_id| tcx.trait_is_auto(trait_def_id))
364         .collect();
365     let access_levels = AccessLevels {
366         map: tcx.privacy_access_levels(()).map.iter().map(|(k, v)| (k.to_def_id(), *v)).collect(),
367     };
368
369     let mut ctxt = DocContext {
370         tcx,
371         resolver,
372         resolver_caches,
373         param_env: ParamEnv::empty(),
374         external_traits: Default::default(),
375         active_extern_traits: Default::default(),
376         substs: Default::default(),
377         impl_trait_bounds: Default::default(),
378         generated_synthetics: Default::default(),
379         auto_traits,
380         cache: Cache::new(access_levels, render_options.document_private),
381         inlined: FxHashSet::default(),
382         output_format,
383         render_options,
384     };
385
386     // Small hack to force the Sized trait to be present.
387     //
388     // Note that in case of `#![no_core]`, the trait is not available.
389     if let Some(sized_trait_did) = ctxt.tcx.lang_items().sized_trait() {
390         let mut sized_trait = build_external_trait(&mut ctxt, sized_trait_did);
391         sized_trait.is_auto = true;
392         ctxt.external_traits
393             .borrow_mut()
394             .insert(sized_trait_did, TraitWithExtraInfo { trait_: sized_trait, is_notable: false });
395     }
396
397     debug!("crate: {:?}", tcx.hir().krate());
398
399     let mut krate = tcx.sess.time("clean_crate", || clean::krate(&mut ctxt));
400
401     if krate.module.doc_value().map(|d| d.is_empty()).unwrap_or(true) {
402         let help = format!(
403             "The following guide may be of use:\n\
404             {}/rustdoc/how-to-write-documentation.html",
405             crate::DOC_RUST_LANG_ORG_CHANNEL
406         );
407         tcx.struct_lint_node(
408             crate::lint::MISSING_CRATE_LEVEL_DOCS,
409             DocContext::as_local_hir_id(tcx, krate.module.item_id).unwrap(),
410             |lint| {
411                 let mut diag =
412                     lint.build("no documentation found for this crate's top-level module");
413                 diag.help(&help);
414                 diag.emit();
415             },
416         );
417     }
418
419     fn report_deprecated_attr(name: &str, diag: &rustc_errors::Handler, sp: Span) {
420         let mut msg =
421             diag.struct_span_warn(sp, &format!("the `#![doc({})]` attribute is deprecated", name));
422         msg.note(
423             "see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
424             for more information",
425         );
426
427         if name == "no_default_passes" {
428             msg.help("`#![doc(no_default_passes)]` no longer functions; you may want to use `#![doc(document_private_items)]`");
429         } else if name.starts_with("passes") {
430             msg.help("`#![doc(passes = \"...\")]` no longer functions; you may want to use `#![doc(document_private_items)]`");
431         } else if name.starts_with("plugins") {
432             msg.warn("`#![doc(plugins = \"...\")]` no longer functions; see CVE-2018-1000622 <https://nvd.nist.gov/vuln/detail/CVE-2018-1000622>");
433         }
434
435         msg.emit();
436     }
437
438     // Process all of the crate attributes, extracting plugin metadata along
439     // with the passes which we are supposed to run.
440     for attr in krate.module.attrs.lists(sym::doc) {
441         let diag = ctxt.sess().diagnostic();
442
443         let name = attr.name_or_empty();
444         // `plugins = "..."`, `no_default_passes`, and `passes = "..."` have no effect
445         if attr.is_word() && name == sym::no_default_passes {
446             report_deprecated_attr("no_default_passes", diag, attr.span());
447         } else if attr.value_str().is_some() {
448             match name {
449                 sym::passes => {
450                     report_deprecated_attr("passes = \"...\"", diag, attr.span());
451                 }
452                 sym::plugins => {
453                     report_deprecated_attr("plugins = \"...\"", diag, attr.span());
454                 }
455                 _ => (),
456             }
457         }
458
459         if attr.is_word() && name == sym::document_private_items {
460             ctxt.render_options.document_private = true;
461         }
462     }
463
464     info!("Executing passes");
465
466     for p in passes::defaults(show_coverage) {
467         let run = match p.condition {
468             Always => true,
469             WhenDocumentPrivate => ctxt.render_options.document_private,
470             WhenNotDocumentPrivate => !ctxt.render_options.document_private,
471             WhenNotDocumentHidden => !ctxt.render_options.document_hidden,
472         };
473         if run {
474             debug!("running pass {}", p.pass.name);
475             krate = tcx.sess.time(p.pass.name, || (p.pass.run)(krate, &mut ctxt));
476         }
477     }
478
479     tcx.sess.time("check_lint_expectations", || tcx.check_expectations(Some(sym::rustdoc)));
480
481     if tcx.sess.diagnostic().has_errors_or_lint_errors().is_some() {
482         rustc_errors::FatalError.raise();
483     }
484
485     krate = tcx.sess.time("create_format_cache", || Cache::populate(&mut ctxt, krate));
486
487     (krate, ctxt.render_options, ctxt.cache)
488 }
489
490 /// Due to <https://github.com/rust-lang/rust/pull/73566>,
491 /// the name resolution pass may find errors that are never emitted.
492 /// If typeck is called after this happens, then we'll get an ICE:
493 /// 'Res::Error found but not reported'. To avoid this, emit the errors now.
494 struct EmitIgnoredResolutionErrors<'tcx> {
495     tcx: TyCtxt<'tcx>,
496 }
497
498 impl<'tcx> EmitIgnoredResolutionErrors<'tcx> {
499     fn new(tcx: TyCtxt<'tcx>) -> Self {
500         Self { tcx }
501     }
502 }
503
504 impl<'tcx> Visitor<'tcx> for EmitIgnoredResolutionErrors<'tcx> {
505     type NestedFilter = nested_filter::OnlyBodies;
506
507     fn nested_visit_map(&mut self) -> Self::Map {
508         // We need to recurse into nested closures,
509         // since those will fallback to the parent for type checking.
510         self.tcx.hir()
511     }
512
513     fn visit_path(&mut self, path: &'tcx Path<'_>, _id: HirId) {
514         debug!("visiting path {:?}", path);
515         if path.res == Res::Err {
516             // We have less context here than in rustc_resolve,
517             // so we can only emit the name and span.
518             // However we can give a hint that rustc_resolve will have more info.
519             let label = format!(
520                 "could not resolve path `{}`",
521                 path.segments
522                     .iter()
523                     .map(|segment| segment.ident.as_str())
524                     .intersperse("::")
525                     .collect::<String>()
526             );
527             let mut err = rustc_errors::struct_span_err!(
528                 self.tcx.sess,
529                 path.span,
530                 E0433,
531                 "failed to resolve: {}",
532                 label
533             );
534             err.span_label(path.span, label);
535             err.note("this error was originally ignored because you are running `rustdoc`");
536             err.note("try running again with `rustc` or `cargo check` and you may get a more detailed error");
537             err.emit();
538         }
539         // We could have an outer resolution that succeeded,
540         // but with generic parameters that failed.
541         // Recurse into the segments so we catch those too.
542         intravisit::walk_path(self, path);
543     }
544 }
545
546 /// `DefId` or parameter index (`ty::ParamTy.index`) of a synthetic type parameter
547 /// for `impl Trait` in argument position.
548 #[derive(Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
549 pub(crate) enum ImplTraitParam {
550     DefId(DefId),
551     ParamIndex(u32),
552 }
553
554 impl From<DefId> for ImplTraitParam {
555     fn from(did: DefId) -> Self {
556         ImplTraitParam::DefId(did)
557     }
558 }
559
560 impl From<u32> for ImplTraitParam {
561     fn from(idx: u32) -> Self {
562         ImplTraitParam::ParamIndex(idx)
563     }
564 }