1 use rustc_attr as attr;
2 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
3 use rustc_data_structures::sync::{self, Lrc};
4 use rustc_driver::abort_on_err;
5 use rustc_errors::emitter::{Emitter, EmitterWriter};
6 use rustc_errors::json::JsonEmitter;
7 use rustc_feature::UnstableFeatures;
8 use rustc_hir::def::{Namespace::TypeNS, Res};
9 use rustc_hir::def_id::{CrateNum, DefId, DefIndex, LocalDefId, CRATE_DEF_INDEX, LOCAL_CRATE};
12 intravisit::{self, NestedVisitorMap, Visitor},
15 use rustc_interface::interface;
16 use rustc_middle::hir::map::Map;
17 use rustc_middle::middle::cstore::CrateStore;
18 use rustc_middle::middle::privacy::AccessLevels;
19 use rustc_middle::ty::{Ty, TyCtxt};
20 use rustc_resolve as resolve;
21 use rustc_session::config::{self, CrateType, ErrorOutputType};
22 use rustc_session::lint;
23 use rustc_session::DiagnosticOutput;
24 use rustc_session::Session;
25 use rustc_span::source_map;
26 use rustc_span::symbol::sym;
27 use rustc_span::DUMMY_SP;
29 use std::cell::RefCell;
34 use crate::clean::{AttributesExt, MAX_DEF_ID};
35 use crate::config::RenderInfo;
36 use crate::config::{Options as RustdocOptions, RenderOptions};
37 use crate::passes::{self, Condition::*, ConditionalPass};
39 pub use rustc_session::config::{CodegenOptions, DebuggingOptions, Input, Options};
40 pub use rustc_session::search_paths::SearchPath;
42 pub type ExternalPaths = FxHashMap<DefId, (Vec<String>, clean::TypeKind)>;
44 pub struct DocContext<'tcx> {
45 pub tcx: TyCtxt<'tcx>,
46 pub resolver: Rc<RefCell<interface::BoxedResolver>>,
47 /// Later on moved into `CACHE_KEY`
48 pub renderinfo: RefCell<RenderInfo>,
49 /// Later on moved through `clean::Crate` into `CACHE_KEY`
50 pub external_traits: Rc<RefCell<FxHashMap<DefId, clean::Trait>>>,
51 /// Used while populating `external_traits` to ensure we don't process the same trait twice at
53 pub active_extern_traits: RefCell<FxHashSet<DefId>>,
54 // The current set of type and lifetime substitutions,
55 // for expanding type aliases at the HIR level:
56 /// Table `DefId` of type parameter -> substituted type
57 pub ty_substs: RefCell<FxHashMap<DefId, clean::Type>>,
58 /// Table `DefId` of lifetime parameter -> substituted lifetime
59 pub lt_substs: RefCell<FxHashMap<DefId, clean::Lifetime>>,
60 /// Table `DefId` of const parameter -> substituted const
61 pub ct_substs: RefCell<FxHashMap<DefId, clean::Constant>>,
62 /// Table synthetic type parameter for `impl Trait` in argument position -> bounds
63 pub impl_trait_bounds: RefCell<FxHashMap<ImplTraitParam, Vec<clean::GenericBound>>>,
64 pub fake_def_ids: RefCell<FxHashMap<CrateNum, DefId>>,
65 pub all_fake_def_ids: RefCell<FxHashSet<DefId>>,
66 /// Auto-trait or blanket impls processed so far, as `(self_ty, trait_def_id)`.
67 // FIXME(eddyb) make this a `ty::TraitRef<'tcx>` set.
68 pub generated_synthetics: RefCell<FxHashSet<(Ty<'tcx>, DefId)>>,
69 pub auto_traits: Vec<DefId>,
70 /// The options given to rustdoc that could be relevant to a pass.
71 pub render_options: RenderOptions,
74 impl<'tcx> DocContext<'tcx> {
75 pub fn sess(&self) -> &Session {
79 pub fn enter_resolver<F, R>(&self, f: F) -> R
81 F: FnOnce(&mut resolve::Resolver<'_>) -> R,
83 self.resolver.borrow_mut().access(f)
86 /// Call the closure with the given parameters set as
87 /// the substitutions for a type alias' RHS.
88 pub fn enter_alias<F, R>(
90 ty_substs: FxHashMap<DefId, clean::Type>,
91 lt_substs: FxHashMap<DefId, clean::Lifetime>,
92 ct_substs: FxHashMap<DefId, clean::Constant>,
98 let (old_tys, old_lts, old_cts) = (
99 mem::replace(&mut *self.ty_substs.borrow_mut(), ty_substs),
100 mem::replace(&mut *self.lt_substs.borrow_mut(), lt_substs),
101 mem::replace(&mut *self.ct_substs.borrow_mut(), ct_substs),
104 *self.ty_substs.borrow_mut() = old_tys;
105 *self.lt_substs.borrow_mut() = old_lts;
106 *self.ct_substs.borrow_mut() = old_cts;
110 // This is an ugly hack, but it's the simplest way to handle synthetic impls without greatly
111 // refactoring either librustdoc or librustc_middle. In particular, allowing new DefIds to be
112 // registered after the AST is constructed would require storing the defid mapping in a
113 // RefCell, decreasing the performance for normal compilation for very little gain.
115 // Instead, we construct 'fake' def ids, which start immediately after the last DefId.
116 // In the Debug impl for clean::Item, we explicitly check for fake
117 // def ids, as we'll end up with a panic if we use the DefId Debug impl for fake DefIds
118 pub fn next_def_id(&self, crate_num: CrateNum) -> DefId {
120 let next_id = if crate_num == LOCAL_CRATE {
121 self.tcx.hir().definitions().def_path_table().next_id()
123 self.enter_resolver(|r| r.cstore().def_path_table(crate_num).next_id())
126 DefId { krate: crate_num, index: next_id }
129 let mut fake_ids = self.fake_def_ids.borrow_mut();
131 let def_id = *fake_ids.entry(crate_num).or_insert(start_def_id);
134 DefId { krate: crate_num, index: DefIndex::from(def_id.index.index() + 1) },
137 MAX_DEF_ID.with(|m| {
138 m.borrow_mut().entry(def_id.krate).or_insert(start_def_id);
141 self.all_fake_def_ids.borrow_mut().insert(def_id);
146 /// Like the function of the same name on the HIR map, but skips calling it on fake DefIds.
147 /// (This avoids a slice-index-out-of-bounds panic.)
148 pub fn as_local_hir_id(&self, def_id: DefId) -> Option<HirId> {
149 if self.all_fake_def_ids.borrow().contains(&def_id) {
152 def_id.as_local().map(|def_id| self.tcx.hir().as_local_hir_id(def_id))
156 pub fn stability(&self, id: HirId) -> Option<attr::Stability> {
159 .opt_local_def_id(id)
160 .and_then(|def_id| self.tcx.lookup_stability(def_id.to_def_id()))
164 pub fn deprecation(&self, id: HirId) -> Option<attr::Deprecation> {
167 .opt_local_def_id(id)
168 .and_then(|def_id| self.tcx.lookup_deprecation(def_id.to_def_id()))
172 /// Creates a new diagnostic `Handler` that can be used to emit warnings and errors.
174 /// If the given `error_format` is `ErrorOutputType::Json` and no `SourceMap` is given, a new one
175 /// will be created for the handler.
177 error_format: ErrorOutputType,
178 source_map: Option<Lrc<source_map::SourceMap>>,
179 debugging_opts: &DebuggingOptions,
180 ) -> rustc_errors::Handler {
181 let emitter: Box<dyn Emitter + sync::Send> = match error_format {
182 ErrorOutputType::HumanReadable(kind) => {
183 let (short, color_config) = kind.unzip();
185 EmitterWriter::stderr(
187 source_map.map(|sm| sm as _),
189 debugging_opts.teach,
190 debugging_opts.terminal_width,
193 .ui_testing(debugging_opts.ui_testing),
196 ErrorOutputType::Json { pretty, json_rendered } => {
197 let source_map = source_map.unwrap_or_else(|| {
198 Lrc::new(source_map::SourceMap::new(source_map::FilePathMapping::empty()))
206 debugging_opts.terminal_width,
209 .ui_testing(debugging_opts.ui_testing),
214 rustc_errors::Handler::with_emitter_and_flags(
216 debugging_opts.diagnostic_handler_flags(true),
220 /// This function is used to setup the lint initialization. By default, in rustdoc, everything
221 /// is "allowed". Depending if we run in test mode or not, we want some of them to be at their
222 /// default level. For example, the "INVALID_CODEBLOCK_ATTRIBUTES" lint is activated in both
225 /// A little detail easy to forget is that there is a way to set the lint level for all lints
226 /// through the "WARNINGS" lint. To prevent this to happen, we set it back to its "normal" level
227 /// inside this function.
229 /// It returns a tuple containing:
230 /// * Vector of tuples of lints' name and their associated "max" level
231 /// * HashMap of lint id with their associated "max" level
232 pub fn init_lints<F>(
233 mut allowed_lints: Vec<String>,
234 lint_opts: Vec<(String, lint::Level)>,
236 ) -> (Vec<(String, lint::Level)>, FxHashMap<lint::LintId, lint::Level>)
238 F: Fn(&lint::Lint) -> Option<(String, lint::Level)>,
240 let warnings_lint_name = lint::builtin::WARNINGS.name;
242 allowed_lints.push(warnings_lint_name.to_owned());
243 allowed_lints.extend(lint_opts.iter().map(|(lint, _)| lint).cloned());
246 lint::builtin::HardwiredLints::get_lints()
248 .chain(rustc_lint::SoftLints::get_lints().into_iter())
251 let lint_opts = lints()
253 // Permit feature-gated lints to avoid feature errors when trying to
255 if lint.name == warnings_lint_name || lint.feature_gate.is_some() {
261 .chain(lint_opts.into_iter())
262 .collect::<Vec<_>>();
264 let lint_caps = lints()
266 // We don't want to allow *all* lints so let's ignore
268 if allowed_lints.iter().any(|l| lint.name == l) {
271 Some((lint::LintId::of(lint), lint::Allow))
275 (lint_opts, lint_caps)
278 pub fn run_core(options: RustdocOptions) -> (clean::Crate, RenderInfo, RenderOptions) {
279 // Parse, resolve, and typecheck the given crate.
305 let extern_names: Vec<String> = externs
307 .filter(|(_, entry)| entry.add_prelude)
308 .map(|(name, _)| name)
312 // Add the doc cfg into the doc build.
313 cfgs.push("doc".to_string());
315 let cpath = Some(input.clone());
316 let input = Input::File(input);
318 let intra_link_resolution_failure_name = lint::builtin::BROKEN_INTRA_DOC_LINKS.name;
319 let missing_docs = rustc_lint::builtin::MISSING_DOCS.name;
320 let missing_doc_example = rustc_lint::builtin::MISSING_DOC_CODE_EXAMPLES.name;
321 let private_doc_tests = rustc_lint::builtin::PRIVATE_DOC_TESTS.name;
322 let no_crate_level_docs = rustc_lint::builtin::MISSING_CRATE_LEVEL_DOCS.name;
323 let invalid_codeblock_attributes_name = rustc_lint::builtin::INVALID_CODEBLOCK_ATTRIBUTES.name;
325 // In addition to those specific lints, we also need to allow those given through
326 // command line, otherwise they'll get ignored and we don't want that.
327 let allowed_lints = vec![
328 intra_link_resolution_failure_name.to_owned(),
329 missing_docs.to_owned(),
330 missing_doc_example.to_owned(),
331 private_doc_tests.to_owned(),
332 no_crate_level_docs.to_owned(),
333 invalid_codeblock_attributes_name.to_owned(),
336 let (lint_opts, lint_caps) = init_lints(allowed_lints, lint_opts, |lint| {
337 if lint.name == intra_link_resolution_failure_name
338 || lint.name == invalid_codeblock_attributes_name
342 Some((lint.name_lower(), lint::Allow))
347 if proc_macro_crate { vec![CrateType::ProcMacro] } else { vec![CrateType::Rlib] };
348 // plays with error output here!
349 let sessopts = config::Options {
353 lint_opts: if !display_warnings { lint_opts } else { vec![] },
354 lint_cap: Some(lint_cap.unwrap_or_else(|| lint::Forbid)),
357 target_triple: target,
358 unstable_features: UnstableFeatures::from_environment(),
359 actually_rustdoc: true,
360 debugging_opts: debugging_options,
367 let config = interface::Config {
369 crate_cfg: interface::parse_cfgspecs(cfgs),
375 diagnostic_output: DiagnosticOutput::Default,
379 register_lints: None,
380 override_queries: Some(|_sess, providers, _external_providers| {
381 // Most lints will require typechecking, so just don't run them.
382 providers.lint_mod = |_, _| {};
383 // Prevent `rustc_typeck::check_crate` from calling `typeck` on all bodies.
384 providers.typeck_item_bodies = |_, _| {};
385 // hack so that `used_trait_imports` won't try to call typeck
386 providers.used_trait_imports = |_, _| {
388 static ref EMPTY_SET: FxHashSet<LocalDefId> = FxHashSet::default();
392 // In case typeck does end up being called, don't ICE in case there were name resolution errors
393 providers.typeck = move |tcx, def_id| {
394 // Closures' tables come from their outermost function,
395 // as they are part of the same "inference environment".
396 // This avoids emitting errors for the parent twice (see similar code in `typeck_with_fallback`)
397 let outer_def_id = tcx.closure_base_def_id(def_id.to_def_id()).expect_local();
398 if outer_def_id != def_id {
399 return tcx.typeck(outer_def_id);
403 let body = hir.body(hir.body_owned_by(hir.as_local_hir_id(def_id)));
404 debug!("visiting body for {:?}", def_id);
405 EmitIgnoredResolutionErrors::new(tcx).visit_body(body);
406 (rustc_interface::DEFAULT_QUERY_PROVIDERS.typeck)(tcx, def_id)
409 registry: rustc_driver::diagnostics_registry(),
412 interface::create_compiler_and_run(config, |compiler| {
413 compiler.enter(|queries| {
414 let sess = compiler.session();
416 // We need to hold on to the complete resolver, so we cause everything to be
417 // cloned for the analysis passes to use. Suboptimal, but necessary in the
418 // current architecture.
420 let parts = abort_on_err(queries.expansion(), sess).peek();
421 let resolver = parts.1.borrow();
423 // Before we actually clone it, let's force all the extern'd crates to
424 // actually be loaded, just in case they're only referred to inside
426 resolver.borrow_mut().access(|resolver| {
427 for extern_name in &extern_names {
429 .resolve_str_path_error(
433 LocalDefId { local_def_index: CRATE_DEF_INDEX }.to_def_id(),
435 .unwrap_or_else(|()| {
436 panic!("Unable to resolve external crate {}", extern_name)
441 // Now we're good to clone the resolver because everything should be loaded
445 if sess.has_errors() {
446 sess.fatal("Compilation failed, aborting rustdoc");
449 let mut global_ctxt = abort_on_err(queries.global_ctxt(), sess).take();
451 global_ctxt.enter(|tcx| {
452 // Certain queries assume that some checks were run elsewhere
453 // (see https://github.com/rust-lang/rust/pull/73566#issuecomment-656954425),
454 // so type-check everything other than function bodies in this crate before running lints.
455 // NOTE: this does not call `tcx.analysis()` so that we won't
456 // typeck function bodies or run the default rustc lints.
457 // (see `override_queries` in the `config`)
458 let _ = rustc_typeck::check_crate(tcx);
459 tcx.sess.abort_if_errors();
460 sess.time("missing_docs", || {
461 rustc_lint::check_crate(tcx, rustc_lint::builtin::MissingDoc::new);
464 let access_levels = tcx.privacy_access_levels(LOCAL_CRATE);
465 // Convert from a HirId set to a DefId set since we don't always have easy access
466 // to the map from defid -> hirid
467 let access_levels = AccessLevels {
471 .map(|(&k, &v)| (tcx.hir().local_def_id(k).to_def_id(), v))
475 let mut renderinfo = RenderInfo::default();
476 renderinfo.access_levels = access_levels;
477 renderinfo.output_format = output_format;
479 let mut ctxt = DocContext {
482 external_traits: Default::default(),
483 active_extern_traits: Default::default(),
484 renderinfo: RefCell::new(renderinfo),
485 ty_substs: Default::default(),
486 lt_substs: Default::default(),
487 ct_substs: Default::default(),
488 impl_trait_bounds: Default::default(),
489 fake_def_ids: Default::default(),
490 all_fake_def_ids: Default::default(),
491 generated_synthetics: Default::default(),
493 .all_traits(LOCAL_CRATE)
496 .filter(|trait_def_id| tcx.trait_is_auto(*trait_def_id))
500 debug!("crate: {:?}", tcx.hir().krate());
502 let mut krate = clean::krate(&mut ctxt);
504 if let Some(ref m) = krate.module {
505 if let None | Some("") = m.doc_value() {
506 let help = "The following guide may be of use:\n\
507 https://doc.rust-lang.org/nightly/rustdoc/how-to-write-documentation\
509 tcx.struct_lint_node(
510 rustc_lint::builtin::MISSING_CRATE_LEVEL_DOCS,
511 ctxt.as_local_hir_id(m.def_id).unwrap(),
513 let mut diag = lint.build(
514 "no documentation found for this crate's top-level module",
523 fn report_deprecated_attr(name: &str, diag: &rustc_errors::Handler) {
524 let mut msg = diag.struct_warn(&format!(
525 "the `#![doc({})]` attribute is considered deprecated",
529 "see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
530 for more information",
533 if name == "no_default_passes" {
534 msg.help("you may want to use `#![doc(document_private_items)]`");
540 // Process all of the crate attributes, extracting plugin metadata along
541 // with the passes which we are supposed to run.
542 for attr in krate.module.as_ref().unwrap().attrs.lists(sym::doc) {
543 let diag = ctxt.sess().diagnostic();
545 let name = attr.name_or_empty();
547 if name == sym::no_default_passes {
548 report_deprecated_attr("no_default_passes", diag);
549 if default_passes == passes::DefaultPassOption::Default {
550 default_passes = passes::DefaultPassOption::None;
553 } else if let Some(value) = attr.value_str() {
554 let sink = match name {
556 report_deprecated_attr("passes = \"...\"", diag);
560 report_deprecated_attr("plugins = \"...\"", diag);
562 "WARNING: `#![doc(plugins = \"...\")]` \
563 no longer functions; see CVE-2018-1000622"
569 for name in value.as_str().split_whitespace() {
570 sink.push(name.to_string());
574 if attr.is_word() && name == sym::document_private_items {
575 ctxt.render_options.document_private = true;
579 let passes = passes::defaults(default_passes).iter().copied().chain(
580 manual_passes.into_iter().flat_map(|name| {
581 if let Some(pass) = passes::find_pass(&name) {
582 Some(ConditionalPass::always(pass))
584 error!("unknown pass {}, skipping", name);
590 info!("Executing passes");
593 let run = match p.condition {
595 WhenDocumentPrivate => ctxt.render_options.document_private,
596 WhenNotDocumentPrivate => !ctxt.render_options.document_private,
597 WhenNotDocumentHidden => !ctxt.render_options.document_hidden,
600 debug!("running pass {}", p.pass.name);
601 krate = (p.pass.run)(krate, &ctxt);
605 ctxt.sess().abort_if_errors();
607 (krate, ctxt.renderinfo.into_inner(), ctxt.render_options)
613 /// Due to https://github.com/rust-lang/rust/pull/73566,
614 /// the name resolution pass may find errors that are never emitted.
615 /// If typeck is called after this happens, then we'll get an ICE:
616 /// 'Res::Error found but not reported'. To avoid this, emit the errors now.
617 struct EmitIgnoredResolutionErrors<'tcx> {
621 impl<'tcx> EmitIgnoredResolutionErrors<'tcx> {
622 fn new(tcx: TyCtxt<'tcx>) -> Self {
627 impl<'tcx> Visitor<'tcx> for EmitIgnoredResolutionErrors<'tcx> {
628 type Map = Map<'tcx>;
630 fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
631 // We need to recurse into nested closures,
632 // since those will fallback to the parent for type checking.
633 NestedVisitorMap::OnlyBodies(self.tcx.hir())
636 fn visit_path(&mut self, path: &'tcx Path<'_>, _id: HirId) {
637 debug!("visiting path {:?}", path);
638 if path.res == Res::Err {
639 // We have less context here than in rustc_resolve,
640 // so we can only emit the name and span.
641 // However we can give a hint that rustc_resolve will have more info.
643 "could not resolve path `{}`",
646 .map(|segment| segment.ident.as_str().to_string())
650 let mut err = rustc_errors::struct_span_err!(
654 "failed to resolve: {}",
657 err.span_label(path.span, label);
658 err.note("this error was originally ignored because you are running `rustdoc`");
659 err.note("try running again with `rustc` or `cargo check` and you may get a more detailed error");
662 // We could have an outer resolution that succeeded,
663 // but with generic parameters that failed.
664 // Recurse into the segments so we catch those too.
665 intravisit::walk_path(self, path);
669 /// `DefId` or parameter index (`ty::ParamTy.index`) of a synthetic type parameter
670 /// for `impl Trait` in argument position.
671 #[derive(Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
672 pub enum ImplTraitParam {
677 impl From<DefId> for ImplTraitParam {
678 fn from(did: DefId) -> Self {
679 ImplTraitParam::DefId(did)
683 impl From<u32> for ImplTraitParam {
684 fn from(idx: u32) -> Self {
685 ImplTraitParam::ParamIndex(idx)