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;
27 use std::cell::{Cell, RefCell};
32 use crate::clean::{AttributesExt, MAX_DEF_ID};
33 use crate::config::{Options as RustdocOptions, RenderOptions};
34 use crate::config::{OutputFormat, RenderInfo};
35 use crate::passes::{self, Condition::*, ConditionalPass};
37 crate use rustc_session::config::{DebuggingOptions, Input, Options};
39 crate type ExternalPaths = FxHashMap<DefId, (Vec<String>, clean::TypeKind)>;
41 crate struct DocContext<'tcx> {
42 crate tcx: TyCtxt<'tcx>,
43 crate resolver: Rc<RefCell<interface::BoxedResolver>>,
44 /// Used for normalization.
46 /// Most of this logic is copied from rustc_lint::late.
47 crate param_env: Cell<ParamEnv<'tcx>>,
48 /// Later on moved into `CACHE_KEY`
49 crate renderinfo: RefCell<RenderInfo>,
50 /// Later on moved through `clean::Crate` into `CACHE_KEY`
51 crate external_traits: Rc<RefCell<FxHashMap<DefId, clean::Trait>>>,
52 /// Used while populating `external_traits` to ensure we don't process the same trait twice at
54 crate active_extern_traits: RefCell<FxHashSet<DefId>>,
55 // The current set of type and lifetime substitutions,
56 // for expanding type aliases at the HIR level:
57 /// Table `DefId` of type parameter -> substituted type
58 crate ty_substs: RefCell<FxHashMap<DefId, clean::Type>>,
59 /// Table `DefId` of lifetime parameter -> substituted lifetime
60 crate lt_substs: RefCell<FxHashMap<DefId, clean::Lifetime>>,
61 /// Table `DefId` of const parameter -> substituted const
62 crate ct_substs: RefCell<FxHashMap<DefId, clean::Constant>>,
63 /// Table synthetic type parameter for `impl Trait` in argument position -> bounds
64 crate impl_trait_bounds: RefCell<FxHashMap<ImplTraitParam, Vec<clean::GenericBound>>>,
65 crate fake_def_ids: RefCell<FxHashMap<CrateNum, DefId>>,
66 crate all_fake_def_ids: RefCell<FxHashSet<DefId>>,
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: RefCell<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 /// The traits in scope for a given module.
75 /// See `collect_intra_doc_links::traits_implemented_by` for more details.
76 /// `map<module, set<trait>>`
77 crate module_trait_cache: RefCell<FxHashMap<DefId, FxHashSet<DefId>>>,
80 impl<'tcx> DocContext<'tcx> {
81 crate fn sess(&self) -> &Session {
85 crate fn with_param_env<T, F: FnOnce() -> T>(&self, def_id: DefId, f: F) -> T {
86 let old_param_env = self.param_env.replace(self.tcx.param_env(def_id));
88 self.param_env.set(old_param_env);
92 crate fn enter_resolver<F, R>(&self, f: F) -> R
94 F: FnOnce(&mut resolve::Resolver<'_>) -> R,
96 self.resolver.borrow_mut().access(f)
99 /// Call the closure with the given parameters set as
100 /// the substitutions for a type alias' RHS.
101 crate fn enter_alias<F, R>(
103 ty_substs: FxHashMap<DefId, clean::Type>,
104 lt_substs: FxHashMap<DefId, clean::Lifetime>,
105 ct_substs: FxHashMap<DefId, clean::Constant>,
111 let (old_tys, old_lts, old_cts) = (
112 mem::replace(&mut *self.ty_substs.borrow_mut(), ty_substs),
113 mem::replace(&mut *self.lt_substs.borrow_mut(), lt_substs),
114 mem::replace(&mut *self.ct_substs.borrow_mut(), ct_substs),
117 *self.ty_substs.borrow_mut() = old_tys;
118 *self.lt_substs.borrow_mut() = old_lts;
119 *self.ct_substs.borrow_mut() = old_cts;
123 // This is an ugly hack, but it's the simplest way to handle synthetic impls without greatly
124 // refactoring either librustdoc or librustc_middle. In particular, allowing new DefIds to be
125 // registered after the AST is constructed would require storing the defid mapping in a
126 // RefCell, decreasing the performance for normal compilation for very little gain.
128 // Instead, we construct 'fake' def ids, which start immediately after the last DefId.
129 // In the Debug impl for clean::Item, we explicitly check for fake
130 // def ids, as we'll end up with a panic if we use the DefId Debug impl for fake DefIds
131 crate fn next_def_id(&self, crate_num: CrateNum) -> DefId {
133 let num_def_ids = if crate_num == LOCAL_CRATE {
134 self.tcx.hir().definitions().def_path_table().num_def_ids()
136 self.enter_resolver(|r| r.cstore().num_def_ids(crate_num))
139 DefId { krate: crate_num, index: DefIndex::from_usize(num_def_ids) }
142 let mut fake_ids = self.fake_def_ids.borrow_mut();
144 let def_id = *fake_ids.entry(crate_num).or_insert(start_def_id);
147 DefId { krate: crate_num, index: DefIndex::from(def_id.index.index() + 1) },
150 MAX_DEF_ID.with(|m| {
151 m.borrow_mut().entry(def_id.krate).or_insert(start_def_id);
154 self.all_fake_def_ids.borrow_mut().insert(def_id);
159 /// Like `hir().local_def_id_to_hir_id()`, but skips calling it on fake DefIds.
160 /// (This avoids a slice-index-out-of-bounds panic.)
161 crate fn as_local_hir_id(&self, def_id: DefId) -> Option<HirId> {
162 if self.all_fake_def_ids.borrow().contains(&def_id) {
165 def_id.as_local().map(|def_id| self.tcx.hir().local_def_id_to_hir_id(def_id))
170 /// Creates a new diagnostic `Handler` that can be used to emit warnings and errors.
172 /// If the given `error_format` is `ErrorOutputType::Json` and no `SourceMap` is given, a new one
173 /// will be created for the handler.
174 crate fn new_handler(
175 error_format: ErrorOutputType,
176 source_map: Option<Lrc<source_map::SourceMap>>,
177 debugging_opts: &DebuggingOptions,
178 ) -> rustc_errors::Handler {
179 let emitter: Box<dyn Emitter + sync::Send> = match error_format {
180 ErrorOutputType::HumanReadable(kind) => {
181 let (short, color_config) = kind.unzip();
183 EmitterWriter::stderr(
185 source_map.map(|sm| sm as _),
187 debugging_opts.teach,
188 debugging_opts.terminal_width,
191 .ui_testing(debugging_opts.ui_testing),
194 ErrorOutputType::Json { pretty, json_rendered } => {
195 let source_map = source_map.unwrap_or_else(|| {
196 Lrc::new(source_map::SourceMap::new(source_map::FilePathMapping::empty()))
204 debugging_opts.terminal_width,
207 .ui_testing(debugging_opts.ui_testing),
212 rustc_errors::Handler::with_emitter_and_flags(
214 debugging_opts.diagnostic_handler_flags(true),
218 /// This function is used to setup the lint initialization. By default, in rustdoc, everything
219 /// is "allowed". Depending if we run in test mode or not, we want some of them to be at their
220 /// default level. For example, the "INVALID_CODEBLOCK_ATTRIBUTES" lint is activated in both
223 /// A little detail easy to forget is that there is a way to set the lint level for all lints
224 /// through the "WARNINGS" lint. To prevent this to happen, we set it back to its "normal" level
225 /// inside this function.
227 /// It returns a tuple containing:
228 /// * Vector of tuples of lints' name and their associated "max" level
229 /// * HashMap of lint id with their associated "max" level
230 pub(crate) fn init_lints<F>(
231 mut allowed_lints: Vec<String>,
232 lint_opts: Vec<(String, lint::Level)>,
234 ) -> (Vec<(String, lint::Level)>, FxHashMap<lint::LintId, lint::Level>)
236 F: Fn(&lint::Lint) -> Option<(String, lint::Level)>,
238 let warnings_lint_name = lint::builtin::WARNINGS.name;
240 allowed_lints.push(warnings_lint_name.to_owned());
241 allowed_lints.extend(lint_opts.iter().map(|(lint, _)| lint).cloned());
244 lint::builtin::HardwiredLints::get_lints()
246 .chain(rustc_lint::SoftLints::get_lints().into_iter())
249 let lint_opts = lints()
251 // Permit feature-gated lints to avoid feature errors when trying to
253 if lint.feature_gate.is_some() || allowed_lints.iter().any(|l| lint.name == l) {
259 .chain(lint_opts.into_iter())
260 .collect::<Vec<_>>();
262 let lint_caps = lints()
264 // We don't want to allow *all* lints so let's ignore
266 if allowed_lints.iter().any(|l| lint.name == l) {
269 Some((lint::LintId::of(lint), lint::Allow))
273 (lint_opts, lint_caps)
276 /// Parse, resolve, and typecheck the given crate.
277 crate fn create_config(
297 ) -> rustc_interface::Config {
298 // Add the doc cfg into the doc build.
299 cfgs.push("doc".to_string());
301 let cpath = Some(input.clone());
302 let input = Input::File(input);
304 let broken_intra_doc_links = lint::builtin::BROKEN_INTRA_DOC_LINKS.name;
305 let private_intra_doc_links = lint::builtin::PRIVATE_INTRA_DOC_LINKS.name;
306 let missing_docs = rustc_lint::builtin::MISSING_DOCS.name;
307 let missing_doc_example = rustc_lint::builtin::MISSING_DOC_CODE_EXAMPLES.name;
308 let private_doc_tests = rustc_lint::builtin::PRIVATE_DOC_TESTS.name;
309 let no_crate_level_docs = rustc_lint::builtin::MISSING_CRATE_LEVEL_DOCS.name;
310 let invalid_codeblock_attributes_name = rustc_lint::builtin::INVALID_CODEBLOCK_ATTRIBUTES.name;
311 let invalid_html_tags = rustc_lint::builtin::INVALID_HTML_TAGS.name;
312 let renamed_and_removed_lints = rustc_lint::builtin::RENAMED_AND_REMOVED_LINTS.name;
313 let non_autolinks = rustc_lint::builtin::NON_AUTOLINKS.name;
314 let unknown_lints = rustc_lint::builtin::UNKNOWN_LINTS.name;
316 // In addition to those specific lints, we also need to allow those given through
317 // command line, otherwise they'll get ignored and we don't want that.
318 let lints_to_show = vec![
319 broken_intra_doc_links.to_owned(),
320 private_intra_doc_links.to_owned(),
321 missing_docs.to_owned(),
322 missing_doc_example.to_owned(),
323 private_doc_tests.to_owned(),
324 no_crate_level_docs.to_owned(),
325 invalid_codeblock_attributes_name.to_owned(),
326 invalid_html_tags.to_owned(),
327 renamed_and_removed_lints.to_owned(),
328 unknown_lints.to_owned(),
329 non_autolinks.to_owned(),
332 let (lint_opts, lint_caps) = init_lints(lints_to_show, lint_opts, |lint| {
333 // FIXME: why is this necessary?
334 if lint.name == broken_intra_doc_links || lint.name == invalid_codeblock_attributes_name {
337 Some((lint.name_lower(), lint::Allow))
342 if proc_macro_crate { vec![CrateType::ProcMacro] } else { vec![CrateType::Rlib] };
343 // plays with error output here!
344 let sessopts = config::Options {
348 lint_opts: if !display_warnings { lint_opts } else { vec![] },
352 target_triple: target,
353 unstable_features: UnstableFeatures::from_environment(crate_name.as_deref()),
354 actually_rustdoc: true,
365 crate_cfg: interface::parse_cfgspecs(cfgs),
371 diagnostic_output: DiagnosticOutput::Default,
374 register_lints: None,
375 override_queries: Some(|_sess, providers, _external_providers| {
376 // Most lints will require typechecking, so just don't run them.
377 providers.lint_mod = |_, _| {};
378 // Prevent `rustc_typeck::check_crate` from calling `typeck` on all bodies.
379 providers.typeck_item_bodies = |_, _| {};
380 // hack so that `used_trait_imports` won't try to call typeck
381 providers.used_trait_imports = |_, _| {
383 static ref EMPTY_SET: FxHashSet<LocalDefId> = FxHashSet::default();
387 // In case typeck does end up being called, don't ICE in case there were name resolution errors
388 providers.typeck = move |tcx, def_id| {
389 // Closures' tables come from their outermost function,
390 // as they are part of the same "inference environment".
391 // This avoids emitting errors for the parent twice (see similar code in `typeck_with_fallback`)
392 let outer_def_id = tcx.closure_base_def_id(def_id.to_def_id()).expect_local();
393 if outer_def_id != def_id {
394 return tcx.typeck(outer_def_id);
398 let body = hir.body(hir.body_owned_by(hir.local_def_id_to_hir_id(def_id)));
399 debug!("visiting body for {:?}", def_id);
400 EmitIgnoredResolutionErrors::new(tcx).visit_body(body);
401 (rustc_interface::DEFAULT_QUERY_PROVIDERS.typeck)(tcx, def_id)
404 make_codegen_backend: None,
405 registry: rustc_driver::diagnostics_registry(),
409 crate fn create_resolver<'a>(
410 externs: config::Externs,
411 queries: &Queries<'a>,
413 ) -> Rc<RefCell<interface::BoxedResolver>> {
414 let extern_names: Vec<String> = externs
416 .filter(|(_, entry)| entry.add_prelude)
417 .map(|(name, _)| name)
421 let parts = abort_on_err(queries.expansion(), sess).peek();
422 let resolver = parts.1.borrow();
424 // Before we actually clone it, let's force all the extern'd crates to
425 // actually be loaded, just in case they're only referred to inside
427 resolver.borrow_mut().access(|resolver| {
428 sess.time("load_extern_crates", || {
429 for extern_name in &extern_names {
430 debug!("loading extern crate {}", extern_name);
432 .resolve_str_path_error(
436 LocalDefId { local_def_index: CRATE_DEF_INDEX }.to_def_id(),
438 .unwrap_or_else(|()| {
439 panic!("Unable to resolve external crate {}", extern_name)
445 // Now we're good to clone the resolver because everything should be loaded
449 crate fn run_global_ctxt(
451 resolver: Rc<RefCell<interface::BoxedResolver>>,
452 mut default_passes: passes::DefaultPassOption,
453 mut manual_passes: Vec<String>,
454 render_options: RenderOptions,
455 output_format: Option<OutputFormat>,
456 ) -> (clean::Crate, RenderInfo, RenderOptions) {
457 // Certain queries assume that some checks were run elsewhere
458 // (see https://github.com/rust-lang/rust/pull/73566#issuecomment-656954425),
459 // so type-check everything other than function bodies in this crate before running lints.
461 // NOTE: this does not call `tcx.analysis()` so that we won't
462 // typeck function bodies or run the default rustc lints.
463 // (see `override_queries` in the `config`)
465 // HACK(jynelson) this calls an _extremely_ limited subset of `typeck`
466 // and might break if queries change their assumptions in the future.
468 // NOTE: This is copy/pasted from typeck/lib.rs and should be kept in sync with those changes.
469 tcx.sess.time("item_types_checking", || {
470 for &module in tcx.hir().krate().modules.keys() {
471 tcx.ensure().check_mod_item_types(tcx.hir().local_def_id(module));
474 tcx.sess.abort_if_errors();
475 tcx.sess.time("missing_docs", || {
476 rustc_lint::check_crate(tcx, rustc_lint::builtin::MissingDoc::new);
478 tcx.sess.time("check_mod_attrs", || {
479 for &module in tcx.hir().krate().modules.keys() {
480 let local_def_id = tcx.hir().local_def_id(module);
481 tcx.ensure().check_mod_attrs(local_def_id);
485 let access_levels = tcx.privacy_access_levels(LOCAL_CRATE);
486 // Convert from a HirId set to a DefId set since we don't always have easy access
487 // to the map from defid -> hirid
488 let access_levels = AccessLevels {
492 .map(|(&k, &v)| (tcx.hir().local_def_id(k).to_def_id(), v))
496 let mut renderinfo = RenderInfo::default();
497 renderinfo.access_levels = access_levels;
498 renderinfo.output_format = output_format;
500 let mut ctxt = DocContext {
503 param_env: Cell::new(ParamEnv::empty()),
504 external_traits: Default::default(),
505 active_extern_traits: Default::default(),
506 renderinfo: RefCell::new(renderinfo),
507 ty_substs: Default::default(),
508 lt_substs: Default::default(),
509 ct_substs: Default::default(),
510 impl_trait_bounds: Default::default(),
511 fake_def_ids: Default::default(),
512 all_fake_def_ids: Default::default(),
513 generated_synthetics: Default::default(),
515 .all_traits(LOCAL_CRATE)
518 .filter(|trait_def_id| tcx.trait_is_auto(*trait_def_id))
521 module_trait_cache: RefCell::new(FxHashMap::default()),
523 debug!("crate: {:?}", tcx.hir().krate());
525 let mut krate = tcx.sess.time("clean_crate", || clean::krate(&mut ctxt));
527 if let Some(ref m) = krate.module {
528 if let None | Some("") = m.doc_value() {
529 let help = "The following guide may be of use:\n\
530 https://doc.rust-lang.org/nightly/rustdoc/how-to-write-documentation.html";
531 tcx.struct_lint_node(
532 rustc_lint::builtin::MISSING_CRATE_LEVEL_DOCS,
533 ctxt.as_local_hir_id(m.def_id).unwrap(),
536 lint.build("no documentation found for this crate's top-level module");
544 fn report_deprecated_attr(name: &str, diag: &rustc_errors::Handler) {
546 .struct_warn(&format!("the `#![doc({})]` attribute is considered deprecated", name));
548 "see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
549 for more information",
552 if name == "no_default_passes" {
553 msg.help("you may want to use `#![doc(document_private_items)]`");
559 // Process all of the crate attributes, extracting plugin metadata along
560 // with the passes which we are supposed to run.
561 for attr in krate.module.as_ref().unwrap().attrs.lists(sym::doc) {
562 let diag = ctxt.sess().diagnostic();
564 let name = attr.name_or_empty();
566 if name == sym::no_default_passes {
567 report_deprecated_attr("no_default_passes", diag);
568 if default_passes == passes::DefaultPassOption::Default {
569 default_passes = passes::DefaultPassOption::None;
572 } else if let Some(value) = attr.value_str() {
573 let sink = match name {
575 report_deprecated_attr("passes = \"...\"", diag);
579 report_deprecated_attr("plugins = \"...\"", diag);
581 "WARNING: `#![doc(plugins = \"...\")]` \
582 no longer functions; see CVE-2018-1000622"
588 for name in value.as_str().split_whitespace() {
589 sink.push(name.to_string());
593 if attr.is_word() && name == sym::document_private_items {
594 ctxt.render_options.document_private = true;
598 let passes = passes::defaults(default_passes).iter().copied().chain(
599 manual_passes.into_iter().flat_map(|name| {
600 if let Some(pass) = passes::find_pass(&name) {
601 Some(ConditionalPass::always(pass))
603 error!("unknown pass {}, skipping", name);
609 info!("Executing passes");
612 let run = match p.condition {
614 WhenDocumentPrivate => ctxt.render_options.document_private,
615 WhenNotDocumentPrivate => !ctxt.render_options.document_private,
616 WhenNotDocumentHidden => !ctxt.render_options.document_hidden,
619 debug!("running pass {}", p.pass.name);
620 krate = ctxt.tcx.sess.time(p.pass.name, || (p.pass.run)(krate, &ctxt));
624 ctxt.sess().abort_if_errors();
626 (krate, ctxt.renderinfo.into_inner(), ctxt.render_options)
629 /// Due to <https://github.com/rust-lang/rust/pull/73566>,
630 /// the name resolution pass may find errors that are never emitted.
631 /// If typeck is called after this happens, then we'll get an ICE:
632 /// 'Res::Error found but not reported'. To avoid this, emit the errors now.
633 struct EmitIgnoredResolutionErrors<'tcx> {
637 impl<'tcx> EmitIgnoredResolutionErrors<'tcx> {
638 fn new(tcx: TyCtxt<'tcx>) -> Self {
643 impl<'tcx> Visitor<'tcx> for EmitIgnoredResolutionErrors<'tcx> {
644 type Map = Map<'tcx>;
646 fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
647 // We need to recurse into nested closures,
648 // since those will fallback to the parent for type checking.
649 NestedVisitorMap::OnlyBodies(self.tcx.hir())
652 fn visit_path(&mut self, path: &'tcx Path<'_>, _id: HirId) {
653 debug!("visiting path {:?}", path);
654 if path.res == Res::Err {
655 // We have less context here than in rustc_resolve,
656 // so we can only emit the name and span.
657 // However we can give a hint that rustc_resolve will have more info.
659 "could not resolve path `{}`",
662 .map(|segment| segment.ident.as_str().to_string())
666 let mut err = rustc_errors::struct_span_err!(
670 "failed to resolve: {}",
673 err.span_label(path.span, label);
674 err.note("this error was originally ignored because you are running `rustdoc`");
675 err.note("try running again with `rustc` or `cargo check` and you may get a more detailed error");
678 // We could have an outer resolution that succeeded,
679 // but with generic parameters that failed.
680 // Recurse into the segments so we catch those too.
681 intravisit::walk_path(self, path);
685 /// `DefId` or parameter index (`ty::ParamTy.index`) of a synthetic type parameter
686 /// for `impl Trait` in argument position.
687 #[derive(Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
688 crate enum ImplTraitParam {
693 impl From<DefId> for ImplTraitParam {
694 fn from(did: DefId) -> Self {
695 ImplTraitParam::DefId(did)
699 impl From<u32> for ImplTraitParam {
700 fn from(idx: u32) -> Self {
701 ImplTraitParam::ParamIndex(idx)