1 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
2 use rustc_data_structures::sync::{self, Lrc};
3 use rustc_driver::abort_on_err;
4 use rustc_errors::emitter::{Emitter, EmitterWriter};
5 use rustc_errors::json::JsonEmitter;
6 use rustc_feature::UnstableFeatures;
7 use rustc_hir::def::{Namespace::TypeNS, Res};
8 use rustc_hir::def_id::{CrateNum, DefId, DefIndex, LocalDefId, CRATE_DEF_INDEX, LOCAL_CRATE};
11 intravisit::{self, NestedVisitorMap, Visitor},
14 use rustc_interface::{interface, Queries};
15 use rustc_middle::hir::map::Map;
16 use rustc_middle::middle::privacy::AccessLevels;
17 use rustc_middle::ty::{ParamEnv, Ty, TyCtxt};
18 use rustc_resolve as resolve;
19 use rustc_session::config::{self, CrateType, ErrorOutputType};
20 use rustc_session::lint;
21 use rustc_session::DiagnosticOutput;
22 use rustc_session::Session;
23 use rustc_span::source_map;
24 use rustc_span::symbol::sym;
25 use rustc_span::DUMMY_SP;
30 cell::{Cell, RefCell},
31 collections::hash_map::Entry,
35 use crate::clean::{AttributesExt, MAX_DEF_IDX};
36 use crate::config::{Options as RustdocOptions, RenderOptions};
37 use crate::config::{OutputFormat, RenderInfo};
38 use crate::formats::cache::Cache;
39 use crate::passes::{self, Condition::*, ConditionalPass};
41 crate use rustc_session::config::{DebuggingOptions, Input, Options};
43 crate type ExternalPaths = FxHashMap<DefId, (Vec<String>, clean::TypeKind)>;
45 crate struct DocContext<'tcx> {
46 crate tcx: TyCtxt<'tcx>,
47 crate resolver: Rc<RefCell<interface::BoxedResolver>>,
48 /// Used for normalization.
50 /// Most of this logic is copied from rustc_lint::late.
51 crate param_env: Cell<ParamEnv<'tcx>>,
52 /// Later on moved into `cache`
53 crate renderinfo: RefCell<RenderInfo>,
54 /// Later on moved through `clean::Crate` into `cache`
55 crate external_traits: Rc<RefCell<FxHashMap<DefId, clean::Trait>>>,
56 /// Used while populating `external_traits` to ensure we don't process the same trait twice at
58 crate active_extern_traits: RefCell<FxHashSet<DefId>>,
59 // The current set of type and lifetime substitutions,
60 // for expanding type aliases at the HIR level:
61 /// Table `DefId` of type parameter -> substituted type
62 crate ty_substs: RefCell<FxHashMap<DefId, clean::Type>>,
63 /// Table `DefId` of lifetime parameter -> substituted lifetime
64 crate lt_substs: RefCell<FxHashMap<DefId, clean::Lifetime>>,
65 /// Table `DefId` of const parameter -> substituted const
66 crate ct_substs: RefCell<FxHashMap<DefId, clean::Constant>>,
67 /// Table synthetic type parameter for `impl Trait` in argument position -> bounds
68 crate impl_trait_bounds: RefCell<FxHashMap<ImplTraitParam, Vec<clean::GenericBound>>>,
69 crate fake_def_ids: RefCell<FxHashMap<CrateNum, DefIndex>>,
70 /// Auto-trait or blanket impls processed so far, as `(self_ty, trait_def_id)`.
71 // FIXME(eddyb) make this a `ty::TraitRef<'tcx>` set.
72 crate generated_synthetics: RefCell<FxHashSet<(Ty<'tcx>, DefId)>>,
73 crate auto_traits: Vec<DefId>,
74 /// The options given to rustdoc that could be relevant to a pass.
75 crate render_options: RenderOptions,
76 /// The traits in scope for a given module.
78 /// See `collect_intra_doc_links::traits_implemented_by` for more details.
79 /// `map<module, set<trait>>`
80 crate module_trait_cache: RefCell<FxHashMap<DefId, FxHashSet<DefId>>>,
81 /// Fake empty cache used when cache is required as parameter.
85 impl<'tcx> DocContext<'tcx> {
86 crate fn sess(&self) -> &Session {
90 crate fn with_param_env<T, F: FnOnce() -> T>(&self, def_id: DefId, f: F) -> T {
91 let old_param_env = self.param_env.replace(self.tcx.param_env(def_id));
93 self.param_env.set(old_param_env);
97 crate fn enter_resolver<F, R>(&self, f: F) -> R
99 F: FnOnce(&mut resolve::Resolver<'_>) -> R,
101 self.resolver.borrow_mut().access(f)
104 /// Call the closure with the given parameters set as
105 /// the substitutions for a type alias' RHS.
106 crate fn enter_alias<F, R>(
108 ty_substs: FxHashMap<DefId, clean::Type>,
109 lt_substs: FxHashMap<DefId, clean::Lifetime>,
110 ct_substs: FxHashMap<DefId, clean::Constant>,
116 let (old_tys, old_lts, old_cts) = (
117 mem::replace(&mut *self.ty_substs.borrow_mut(), ty_substs),
118 mem::replace(&mut *self.lt_substs.borrow_mut(), lt_substs),
119 mem::replace(&mut *self.ct_substs.borrow_mut(), ct_substs),
122 *self.ty_substs.borrow_mut() = old_tys;
123 *self.lt_substs.borrow_mut() = old_lts;
124 *self.ct_substs.borrow_mut() = old_cts;
128 /// Create a new "fake" [`DefId`].
130 /// This is an ugly hack, but it's the simplest way to handle synthetic impls without greatly
131 /// refactoring either rustdoc or [`rustc_middle`]. In particular, allowing new [`DefId`]s
132 /// to be registered after the AST is constructed would require storing the [`DefId`] mapping
133 /// in a [`RefCell`], decreasing the performance for normal compilation for very little gain.
135 /// Instead, we construct "fake" [`DefId`]s, which start immediately after the last `DefId`.
136 /// In the [`Debug`] impl for [`clean::Item`], we explicitly check for fake `DefId`s,
137 /// as we'll end up with a panic if we use the `DefId` `Debug` impl for fake `DefId`s.
139 /// [`RefCell`]: std::cell::RefCell
140 /// [`Debug`]: std::fmt::Debug
141 /// [`clean::Item`]: crate::clean::types::Item
142 crate fn next_def_id(&self, crate_num: CrateNum) -> DefId {
143 let mut fake_ids = self.fake_def_ids.borrow_mut();
145 let def_index = match fake_ids.entry(crate_num) {
146 Entry::Vacant(e) => {
148 let num_def_idx = if crate_num == LOCAL_CRATE {
149 self.tcx.hir().definitions().def_path_table().num_def_ids()
151 self.enter_resolver(|r| r.cstore().num_def_ids(crate_num))
154 DefIndex::from_usize(num_def_idx)
157 MAX_DEF_IDX.with(|m| {
158 m.borrow_mut().insert(crate_num, num_def_idx);
160 e.insert(num_def_idx)
162 Entry::Occupied(e) => e.into_mut(),
164 *def_index = DefIndex::from(*def_index + 1);
166 DefId { krate: crate_num, index: *def_index }
169 /// Like `hir().local_def_id_to_hir_id()`, but skips calling it on fake DefIds.
170 /// (This avoids a slice-index-out-of-bounds panic.)
171 crate fn as_local_hir_id(&self, def_id: DefId) -> Option<HirId> {
172 if MAX_DEF_IDX.with(|m| {
173 m.borrow().get(&def_id.krate).map(|&idx| idx <= def_id.index).unwrap_or(false)
177 def_id.as_local().map(|def_id| self.tcx.hir().local_def_id_to_hir_id(def_id))
182 /// Creates a new diagnostic `Handler` that can be used to emit warnings and errors.
184 /// If the given `error_format` is `ErrorOutputType::Json` and no `SourceMap` is given, a new one
185 /// will be created for the handler.
186 crate fn new_handler(
187 error_format: ErrorOutputType,
188 source_map: Option<Lrc<source_map::SourceMap>>,
189 debugging_opts: &DebuggingOptions,
190 ) -> rustc_errors::Handler {
191 let emitter: Box<dyn Emitter + sync::Send> = match error_format {
192 ErrorOutputType::HumanReadable(kind) => {
193 let (short, color_config) = kind.unzip();
195 EmitterWriter::stderr(
197 source_map.map(|sm| sm as _),
199 debugging_opts.teach,
200 debugging_opts.terminal_width,
203 .ui_testing(debugging_opts.ui_testing),
206 ErrorOutputType::Json { pretty, json_rendered } => {
207 let source_map = source_map.unwrap_or_else(|| {
208 Lrc::new(source_map::SourceMap::new(source_map::FilePathMapping::empty()))
216 debugging_opts.terminal_width,
219 .ui_testing(debugging_opts.ui_testing),
224 rustc_errors::Handler::with_emitter_and_flags(
226 debugging_opts.diagnostic_handler_flags(true),
230 /// This function is used to setup the lint initialization. By default, in rustdoc, everything
231 /// is "allowed". Depending if we run in test mode or not, we want some of them to be at their
232 /// default level. For example, the "INVALID_CODEBLOCK_ATTRIBUTES" lint is activated in both
235 /// A little detail easy to forget is that there is a way to set the lint level for all lints
236 /// through the "WARNINGS" lint. To prevent this to happen, we set it back to its "normal" level
237 /// inside this function.
239 /// It returns a tuple containing:
240 /// * Vector of tuples of lints' name and their associated "max" level
241 /// * HashMap of lint id with their associated "max" level
242 pub(crate) fn init_lints<F>(
243 mut allowed_lints: Vec<String>,
244 lint_opts: Vec<(String, lint::Level)>,
246 ) -> (Vec<(String, lint::Level)>, FxHashMap<lint::LintId, lint::Level>)
248 F: Fn(&lint::Lint) -> Option<(String, lint::Level)>,
250 let warnings_lint_name = lint::builtin::WARNINGS.name;
252 allowed_lints.push(warnings_lint_name.to_owned());
253 allowed_lints.extend(lint_opts.iter().map(|(lint, _)| lint).cloned());
256 lint::builtin::HardwiredLints::get_lints()
258 .chain(rustc_lint::SoftLints::get_lints().into_iter())
261 let lint_opts = lints()
263 // Permit feature-gated lints to avoid feature errors when trying to
265 if lint.feature_gate.is_some() || allowed_lints.iter().any(|l| lint.name == l) {
271 .chain(lint_opts.into_iter())
272 .collect::<Vec<_>>();
274 let lint_caps = lints()
276 // We don't want to allow *all* lints so let's ignore
278 if allowed_lints.iter().any(|l| lint.name == l) {
281 Some((lint::LintId::of(lint), lint::Allow))
285 (lint_opts, lint_caps)
288 /// Parse, resolve, and typecheck the given crate.
289 crate fn create_config(
309 ) -> rustc_interface::Config {
310 // Add the doc cfg into the doc build.
311 cfgs.push("doc".to_string());
313 let cpath = Some(input.clone());
314 let input = Input::File(input);
316 let broken_intra_doc_links = lint::builtin::BROKEN_INTRA_DOC_LINKS.name;
317 let private_intra_doc_links = lint::builtin::PRIVATE_INTRA_DOC_LINKS.name;
318 let missing_docs = rustc_lint::builtin::MISSING_DOCS.name;
319 let missing_doc_example = rustc_lint::builtin::MISSING_DOC_CODE_EXAMPLES.name;
320 let private_doc_tests = rustc_lint::builtin::PRIVATE_DOC_TESTS.name;
321 let no_crate_level_docs = rustc_lint::builtin::MISSING_CRATE_LEVEL_DOCS.name;
322 let invalid_codeblock_attributes_name = rustc_lint::builtin::INVALID_CODEBLOCK_ATTRIBUTES.name;
323 let invalid_html_tags = rustc_lint::builtin::INVALID_HTML_TAGS.name;
324 let renamed_and_removed_lints = rustc_lint::builtin::RENAMED_AND_REMOVED_LINTS.name;
325 let non_autolinks = rustc_lint::builtin::NON_AUTOLINKS.name;
326 let unknown_lints = rustc_lint::builtin::UNKNOWN_LINTS.name;
328 // In addition to those specific lints, we also need to allow those given through
329 // command line, otherwise they'll get ignored and we don't want that.
330 let lints_to_show = vec![
331 broken_intra_doc_links.to_owned(),
332 private_intra_doc_links.to_owned(),
333 missing_docs.to_owned(),
334 missing_doc_example.to_owned(),
335 private_doc_tests.to_owned(),
336 no_crate_level_docs.to_owned(),
337 invalid_codeblock_attributes_name.to_owned(),
338 invalid_html_tags.to_owned(),
339 renamed_and_removed_lints.to_owned(),
340 unknown_lints.to_owned(),
341 non_autolinks.to_owned(),
344 let (lint_opts, lint_caps) = init_lints(lints_to_show, lint_opts, |lint| {
345 // FIXME: why is this necessary?
346 if lint.name == broken_intra_doc_links || lint.name == invalid_codeblock_attributes_name {
349 Some((lint.name_lower(), lint::Allow))
354 if proc_macro_crate { vec![CrateType::ProcMacro] } else { vec![CrateType::Rlib] };
355 // plays with error output here!
356 let sessopts = config::Options {
360 lint_opts: if !display_warnings { lint_opts } else { vec![] },
364 target_triple: target,
365 unstable_features: UnstableFeatures::from_environment(crate_name.as_deref()),
366 actually_rustdoc: true,
377 crate_cfg: interface::parse_cfgspecs(cfgs),
383 diagnostic_output: DiagnosticOutput::Default,
386 register_lints: None,
387 override_queries: Some(|_sess, providers, _external_providers| {
388 // Most lints will require typechecking, so just don't run them.
389 providers.lint_mod = |_, _| {};
390 // Prevent `rustc_typeck::check_crate` from calling `typeck` on all bodies.
391 providers.typeck_item_bodies = |_, _| {};
392 // hack so that `used_trait_imports` won't try to call typeck
393 providers.used_trait_imports = |_, _| {
395 static ref EMPTY_SET: FxHashSet<LocalDefId> = FxHashSet::default();
399 // In case typeck does end up being called, don't ICE in case there were name resolution errors
400 providers.typeck = move |tcx, def_id| {
401 // Closures' tables come from their outermost function,
402 // as they are part of the same "inference environment".
403 // This avoids emitting errors for the parent twice (see similar code in `typeck_with_fallback`)
404 let outer_def_id = tcx.closure_base_def_id(def_id.to_def_id()).expect_local();
405 if outer_def_id != def_id {
406 return tcx.typeck(outer_def_id);
410 let body = hir.body(hir.body_owned_by(hir.local_def_id_to_hir_id(def_id)));
411 debug!("visiting body for {:?}", def_id);
412 EmitIgnoredResolutionErrors::new(tcx).visit_body(body);
413 (rustc_interface::DEFAULT_QUERY_PROVIDERS.typeck)(tcx, def_id)
416 make_codegen_backend: None,
417 registry: rustc_driver::diagnostics_registry(),
421 crate fn create_resolver<'a>(
422 externs: config::Externs,
423 queries: &Queries<'a>,
425 ) -> Rc<RefCell<interface::BoxedResolver>> {
426 let extern_names: Vec<String> = externs
428 .filter(|(_, entry)| entry.add_prelude)
429 .map(|(name, _)| name)
433 let parts = abort_on_err(queries.expansion(), sess).peek();
434 let resolver = parts.1.borrow();
436 // Before we actually clone it, let's force all the extern'd crates to
437 // actually be loaded, just in case they're only referred to inside
439 resolver.borrow_mut().access(|resolver| {
440 sess.time("load_extern_crates", || {
441 for extern_name in &extern_names {
442 debug!("loading extern crate {}", extern_name);
443 if let Err(()) = resolver
444 .resolve_str_path_error(
448 LocalDefId { local_def_index: CRATE_DEF_INDEX }.to_def_id(),
450 warn!("unable to resolve external crate {} (do you have an unused `--extern` crate?)", extern_name)
456 // Now we're good to clone the resolver because everything should be loaded
460 crate fn run_global_ctxt(
462 resolver: Rc<RefCell<interface::BoxedResolver>>,
463 mut default_passes: passes::DefaultPassOption,
464 mut manual_passes: Vec<String>,
465 render_options: RenderOptions,
466 output_format: OutputFormat,
467 ) -> (clean::Crate, RenderInfo, RenderOptions) {
468 // Certain queries assume that some checks were run elsewhere
469 // (see https://github.com/rust-lang/rust/pull/73566#issuecomment-656954425),
470 // so type-check everything other than function bodies in this crate before running lints.
472 // NOTE: this does not call `tcx.analysis()` so that we won't
473 // typeck function bodies or run the default rustc lints.
474 // (see `override_queries` in the `config`)
476 // HACK(jynelson) this calls an _extremely_ limited subset of `typeck`
477 // and might break if queries change their assumptions in the future.
479 // NOTE: This is copy/pasted from typeck/lib.rs and should be kept in sync with those changes.
480 tcx.sess.time("item_types_checking", || {
481 for &module in tcx.hir().krate().modules.keys() {
482 tcx.ensure().check_mod_item_types(tcx.hir().local_def_id(module));
485 tcx.sess.abort_if_errors();
486 tcx.sess.time("missing_docs", || {
487 rustc_lint::check_crate(tcx, rustc_lint::builtin::MissingDoc::new);
489 tcx.sess.time("check_mod_attrs", || {
490 for &module in tcx.hir().krate().modules.keys() {
491 let local_def_id = tcx.hir().local_def_id(module);
492 tcx.ensure().check_mod_attrs(local_def_id);
496 let access_levels = tcx.privacy_access_levels(LOCAL_CRATE);
497 // Convert from a HirId set to a DefId set since we don't always have easy access
498 // to the map from defid -> hirid
499 let access_levels = AccessLevels {
503 .map(|(&k, &v)| (tcx.hir().local_def_id(k).to_def_id(), v))
507 let mut renderinfo = RenderInfo::default();
508 renderinfo.access_levels = access_levels;
509 renderinfo.output_format = output_format;
511 let mut ctxt = DocContext {
514 param_env: Cell::new(ParamEnv::empty()),
515 external_traits: Default::default(),
516 active_extern_traits: Default::default(),
517 renderinfo: RefCell::new(renderinfo),
518 ty_substs: Default::default(),
519 lt_substs: Default::default(),
520 ct_substs: Default::default(),
521 impl_trait_bounds: Default::default(),
522 fake_def_ids: Default::default(),
523 generated_synthetics: Default::default(),
525 .all_traits(LOCAL_CRATE)
528 .filter(|trait_def_id| tcx.trait_is_auto(*trait_def_id))
531 module_trait_cache: RefCell::new(FxHashMap::default()),
532 cache: Cache::default(),
534 debug!("crate: {:?}", tcx.hir().krate());
536 let mut krate = tcx.sess.time("clean_crate", || clean::krate(&mut ctxt));
538 if let Some(ref m) = krate.module {
539 if m.doc_value().map(|d| d.is_empty()).unwrap_or(true) {
540 let help = "The following guide may be of use:\n\
541 https://doc.rust-lang.org/nightly/rustdoc/how-to-write-documentation.html";
542 tcx.struct_lint_node(
543 rustc_lint::builtin::MISSING_CRATE_LEVEL_DOCS,
544 ctxt.as_local_hir_id(m.def_id).unwrap(),
547 lint.build("no documentation found for this crate's top-level module");
555 fn report_deprecated_attr(name: &str, diag: &rustc_errors::Handler) {
557 .struct_warn(&format!("the `#![doc({})]` attribute is considered deprecated", name));
559 "see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
560 for more information",
563 if name == "no_default_passes" {
564 msg.help("you may want to use `#![doc(document_private_items)]`");
570 // Process all of the crate attributes, extracting plugin metadata along
571 // with the passes which we are supposed to run.
572 for attr in krate.module.as_ref().unwrap().attrs.lists(sym::doc) {
573 let diag = ctxt.sess().diagnostic();
575 let name = attr.name_or_empty();
577 if name == sym::no_default_passes {
578 report_deprecated_attr("no_default_passes", diag);
579 if default_passes == passes::DefaultPassOption::Default {
580 default_passes = passes::DefaultPassOption::None;
583 } else if let Some(value) = attr.value_str() {
584 let sink = match name {
586 report_deprecated_attr("passes = \"...\"", diag);
590 report_deprecated_attr("plugins = \"...\"", diag);
592 "WARNING: `#![doc(plugins = \"...\")]` \
593 no longer functions; see CVE-2018-1000622"
599 for name in value.as_str().split_whitespace() {
600 sink.push(name.to_string());
604 if attr.is_word() && name == sym::document_private_items {
605 ctxt.render_options.document_private = true;
609 let passes = passes::defaults(default_passes).iter().copied().chain(
610 manual_passes.into_iter().flat_map(|name| {
611 if let Some(pass) = passes::find_pass(&name) {
612 Some(ConditionalPass::always(pass))
614 error!("unknown pass {}, skipping", name);
620 info!("Executing passes");
623 let run = match p.condition {
625 WhenDocumentPrivate => ctxt.render_options.document_private,
626 WhenNotDocumentPrivate => !ctxt.render_options.document_private,
627 WhenNotDocumentHidden => !ctxt.render_options.document_hidden,
630 debug!("running pass {}", p.pass.name);
631 krate = ctxt.tcx.sess.time(p.pass.name, || (p.pass.run)(krate, &ctxt));
635 ctxt.sess().abort_if_errors();
637 // The main crate doc comments are always collapsed.
638 krate.collapsed = true;
640 (krate, ctxt.renderinfo.into_inner(), ctxt.render_options)
643 /// Due to <https://github.com/rust-lang/rust/pull/73566>,
644 /// the name resolution pass may find errors that are never emitted.
645 /// If typeck is called after this happens, then we'll get an ICE:
646 /// 'Res::Error found but not reported'. To avoid this, emit the errors now.
647 struct EmitIgnoredResolutionErrors<'tcx> {
651 impl<'tcx> EmitIgnoredResolutionErrors<'tcx> {
652 fn new(tcx: TyCtxt<'tcx>) -> Self {
657 impl<'tcx> Visitor<'tcx> for EmitIgnoredResolutionErrors<'tcx> {
658 type Map = Map<'tcx>;
660 fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
661 // We need to recurse into nested closures,
662 // since those will fallback to the parent for type checking.
663 NestedVisitorMap::OnlyBodies(self.tcx.hir())
666 fn visit_path(&mut self, path: &'tcx Path<'_>, _id: HirId) {
667 debug!("visiting path {:?}", path);
668 if path.res == Res::Err {
669 // We have less context here than in rustc_resolve,
670 // so we can only emit the name and span.
671 // However we can give a hint that rustc_resolve will have more info.
673 "could not resolve path `{}`",
676 .map(|segment| segment.ident.as_str().to_string())
680 let mut err = rustc_errors::struct_span_err!(
684 "failed to resolve: {}",
687 err.span_label(path.span, label);
688 err.note("this error was originally ignored because you are running `rustdoc`");
689 err.note("try running again with `rustc` or `cargo check` and you may get a more detailed error");
692 // We could have an outer resolution that succeeded,
693 // but with generic parameters that failed.
694 // Recurse into the segments so we catch those too.
695 intravisit::walk_path(self, path);
699 /// `DefId` or parameter index (`ty::ParamTy.index`) of a synthetic type parameter
700 /// for `impl Trait` in argument position.
701 #[derive(Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
702 crate enum ImplTraitParam {
707 impl From<DefId> for ImplTraitParam {
708 fn from(did: DefId) -> Self {
709 ImplTraitParam::DefId(did)
713 impl From<u32> for ImplTraitParam {
714 fn from(idx: u32) -> Self {
715 ImplTraitParam::ParamIndex(idx)