src/librustdoc/core.rs

   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};
   9 use rustc_hir::HirId;
  10 use rustc_hir::{
  11     intravisit::{self, NestedVisitorMap, Visitor},
  12     Path,
  13 };
  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;
  26
  27 use std::mem;
  28 use std::rc::Rc;
  29 use std::{cell::RefCell, collections::hash_map::Entry};
  30
  31 use crate::clean;
  32 use crate::clean::inline::build_external_trait;
  33 use crate::clean::{AttributesExt, MAX_DEF_IDX};
  34 use crate::config::{Options as RustdocOptions, RenderOptions};
  35 use crate::config::{OutputFormat, RenderInfo};
  36 use crate::formats::cache::Cache;
  37 use crate::passes::{self, Condition::*, ConditionalPass};
  38
  39 crate use rustc_session::config::{DebuggingOptions, Input, Options};
  40
  41 crate type ExternalPaths = FxHashMap<DefId, (Vec<String>, clean::TypeKind)>;
  42
  43 crate struct DocContext<'tcx> {
  44     crate tcx: TyCtxt<'tcx>,
  45     crate resolver: Rc<RefCell<interface::BoxedResolver>>,
  46     /// Used for normalization.
  47     ///
  48     /// Most of this logic is copied from rustc_lint::late.
  49     crate param_env: ParamEnv<'tcx>,
  50     /// Later on moved into `cache`
  51     crate renderinfo: RefCell<RenderInfo>,
  52     /// Later on moved through `clean::Crate` into `cache`
  53     crate external_traits: Rc<RefCell<FxHashMap<DefId, clean::Trait>>>,
  54     /// Used while populating `external_traits` to ensure we don't process the same trait twice at
  55     /// the same time.
  56     crate active_extern_traits: RefCell<FxHashSet<DefId>>,
  57     // The current set of type and lifetime substitutions,
  58     // for expanding type aliases at the HIR level:
  59     /// Table `DefId` of type parameter -> substituted type
  60     crate ty_substs: RefCell<FxHashMap<DefId, clean::Type>>,
  61     /// Table `DefId` of lifetime parameter -> substituted lifetime
  62     crate lt_substs: RefCell<FxHashMap<DefId, clean::Lifetime>>,
  63     /// Table `DefId` of const parameter -> substituted const
  64     crate ct_substs: RefCell<FxHashMap<DefId, clean::Constant>>,
  65     /// Table synthetic type parameter for `impl Trait` in argument position -> bounds
  66     crate impl_trait_bounds: RefCell<FxHashMap<ImplTraitParam, Vec<clean::GenericBound>>>,
  67     crate fake_def_ids: FxHashMap<CrateNum, DefIndex>,
  68     /// Auto-trait or blanket impls processed so far, as `(self_ty, trait_def_id)`.
  69     // FIXME(eddyb) make this a `ty::TraitRef<'tcx>` set.
  70     crate generated_synthetics: RefCell<FxHashSet<(Ty<'tcx>, DefId)>>,
  71     crate auto_traits: Vec<DefId>,
  72     /// The options given to rustdoc that could be relevant to a pass.
  73     crate render_options: RenderOptions,
  74     /// The traits in scope for a given module.
  75     ///
  76     /// See `collect_intra_doc_links::traits_implemented_by` for more details.
  77     /// `map<module, set<trait>>`
  78     crate module_trait_cache: RefCell<FxHashMap<DefId, FxHashSet<DefId>>>,
  79     /// Fake empty cache used when cache is required as parameter.
  80     crate cache: Cache,
  81 }
  82
  83 impl<'tcx> DocContext<'tcx> {
  84     crate fn sess(&self) -> &'tcx Session {
  85         &self.tcx.sess
  86     }
  87
  88     crate fn with_param_env<T, F: FnOnce(&mut Self) -> T>(&mut self, def_id: DefId, f: F) -> T {
  89         let old_param_env = mem::replace(&mut self.param_env, self.tcx.param_env(def_id));
  90         let ret = f(self);
  91         self.param_env = old_param_env;
  92         ret
  93     }
  94
  95     crate fn enter_resolver<F, R>(&self, f: F) -> R
  96     where
  97         F: FnOnce(&mut resolve::Resolver<'_>) -> R,
  98     {
  99         self.resolver.borrow_mut().access(f)
 100     }
 101
 102     /// Call the closure with the given parameters set as
 103     /// the substitutions for a type alias' RHS.
 104     crate fn enter_alias<F, R>(
 105         &mut self,
 106         ty_substs: FxHashMap<DefId, clean::Type>,
 107         lt_substs: FxHashMap<DefId, clean::Lifetime>,
 108         ct_substs: FxHashMap<DefId, clean::Constant>,
 109         f: F,
 110     ) -> R
 111     where
 112         F: FnOnce(&mut Self) -> R,
 113     {
 114         let (old_tys, old_lts, old_cts) = (
 115             mem::replace(&mut *self.ty_substs.get_mut(), ty_substs),
 116             mem::replace(&mut *self.lt_substs.get_mut(), lt_substs),
 117             mem::replace(&mut *self.ct_substs.get_mut(), ct_substs),
 118         );
 119         let r = f(self);
 120         *self.ty_substs.get_mut() = old_tys;
 121         *self.lt_substs.get_mut() = old_lts;
 122         *self.ct_substs.get_mut() = old_cts;
 123         r
 124     }
 125
 126     /// Create a new "fake" [`DefId`].
 127     ///
 128     /// This is an ugly hack, but it's the simplest way to handle synthetic impls without greatly
 129     /// refactoring either rustdoc or [`rustc_middle`]. In particular, allowing new [`DefId`]s
 130     /// to be registered after the AST is constructed would require storing the [`DefId`] mapping
 131     /// in a [`RefCell`], decreasing the performance for normal compilation for very little gain.
 132     ///
 133     /// Instead, we construct "fake" [`DefId`]s, which start immediately after the last `DefId`.
 134     /// In the [`Debug`] impl for [`clean::Item`], we explicitly check for fake `DefId`s,
 135     /// as we'll end up with a panic if we use the `DefId` `Debug` impl for fake `DefId`s.
 136     ///
 137     /// [`RefCell`]: std::cell::RefCell
 138     /// [`Debug`]: std::fmt::Debug
 139     /// [`clean::Item`]: crate::clean::types::Item
 140     crate fn next_def_id(&mut self, crate_num: CrateNum) -> DefId {
 141         let def_index = match self.fake_def_ids.entry(crate_num) {
 142             Entry::Vacant(e) => {
 143                 let num_def_idx = {
 144                     let num_def_idx = if crate_num == LOCAL_CRATE {
 145                         self.tcx.hir().definitions().def_path_table().num_def_ids()
 146                     } else {
 147                         self.resolver.borrow_mut().access(|r| r.cstore().num_def_ids(crate_num))
 148                     };
 149
 150                     DefIndex::from_usize(num_def_idx)
 151                 };
 152
 153                 MAX_DEF_IDX.with(|m| {
 154                     m.borrow_mut().insert(crate_num, num_def_idx);
 155                 });
 156                 e.insert(num_def_idx)
 157             }
 158             Entry::Occupied(e) => e.into_mut(),
 159         };
 160         *def_index = *def_index + 1;
 161
 162         DefId { krate: crate_num, index: *def_index }
 163     }
 164
 165     /// Like `hir().local_def_id_to_hir_id()`, but skips calling it on fake DefIds.
 166     /// (This avoids a slice-index-out-of-bounds panic.)
 167     crate fn as_local_hir_id(&self, def_id: DefId) -> Option<HirId> {
 168         if MAX_DEF_IDX.with(|m| {
 169             m.borrow().get(&def_id.krate).map(|&idx| idx <= def_id.index).unwrap_or(false)
 170         }) {
 171             None
 172         } else {
 173             def_id.as_local().map(|def_id| self.tcx.hir().local_def_id_to_hir_id(def_id))
 174         }
 175     }
 176 }
 177
 178 /// Creates a new diagnostic `Handler` that can be used to emit warnings and errors.
 179 ///
 180 /// If the given `error_format` is `ErrorOutputType::Json` and no `SourceMap` is given, a new one
 181 /// will be created for the handler.
 182 crate fn new_handler(
 183     error_format: ErrorOutputType,
 184     source_map: Option<Lrc<source_map::SourceMap>>,
 185     debugging_opts: &DebuggingOptions,
 186 ) -> rustc_errors::Handler {
 187     let emitter: Box<dyn Emitter + sync::Send> = match error_format {
 188         ErrorOutputType::HumanReadable(kind) => {
 189             let (short, color_config) = kind.unzip();
 190             Box::new(
 191                 EmitterWriter::stderr(
 192                     color_config,
 193                     source_map.map(|sm| sm as _),
 194                     short,
 195                     debugging_opts.teach,
 196                     debugging_opts.terminal_width,
 197                     false,
 198                 )
 199                 .ui_testing(debugging_opts.ui_testing),
 200             )
 201         }
 202         ErrorOutputType::Json { pretty, json_rendered } => {
 203             let source_map = source_map.unwrap_or_else(|| {
 204                 Lrc::new(source_map::SourceMap::new(source_map::FilePathMapping::empty()))
 205             });
 206             Box::new(
 207                 JsonEmitter::stderr(
 208                     None,
 209                     source_map,
 210                     pretty,
 211                     json_rendered,
 212                     debugging_opts.terminal_width,
 213                     false,
 214                 )
 215                 .ui_testing(debugging_opts.ui_testing),
 216             )
 217         }
 218     };
 219
 220     rustc_errors::Handler::with_emitter_and_flags(
 221         emitter,
 222         debugging_opts.diagnostic_handler_flags(true),
 223     )
 224 }
 225
 226 /// This function is used to setup the lint initialization. By default, in rustdoc, everything
 227 /// is "allowed". Depending if we run in test mode or not, we want some of them to be at their
 228 /// default level. For example, the "INVALID_CODEBLOCK_ATTRIBUTES" lint is activated in both
 229 /// modes.
 230 ///
 231 /// A little detail easy to forget is that there is a way to set the lint level for all lints
 232 /// through the "WARNINGS" lint. To prevent this to happen, we set it back to its "normal" level
 233 /// inside this function.
 234 ///
 235 /// It returns a tuple containing:
 236 ///  * Vector of tuples of lints' name and their associated "max" level
 237 ///  * HashMap of lint id with their associated "max" level
 238 pub(crate) fn init_lints<F>(
 239     mut allowed_lints: Vec<String>,
 240     lint_opts: Vec<(String, lint::Level)>,
 241     filter_call: F,
 242 ) -> (Vec<(String, lint::Level)>, FxHashMap<lint::LintId, lint::Level>)
 243 where
 244     F: Fn(&lint::Lint) -> Option<(String, lint::Level)>,
 245 {
 246     let warnings_lint_name = lint::builtin::WARNINGS.name;
 247
 248     allowed_lints.push(warnings_lint_name.to_owned());
 249     allowed_lints.extend(lint_opts.iter().map(|(lint, _)| lint).cloned());
 250
 251     let lints = || {
 252         lint::builtin::HardwiredLints::get_lints()
 253             .into_iter()
 254             .chain(rustc_lint::SoftLints::get_lints().into_iter())
 255     };
 256
 257     let lint_opts = lints()
 258         .filter_map(|lint| {
 259             // Permit feature-gated lints to avoid feature errors when trying to
 260             // allow all lints.
 261             if lint.feature_gate.is_some() || allowed_lints.iter().any(|l| lint.name == l) {
 262                 None
 263             } else {
 264                 filter_call(lint)
 265             }
 266         })
 267         .chain(lint_opts.into_iter())
 268         .collect::<Vec<_>>();
 269
 270     let lint_caps = lints()
 271         .filter_map(|lint| {
 272             // We don't want to allow *all* lints so let's ignore
 273             // those ones.
 274             if allowed_lints.iter().any(|l| lint.name == l) {
 275                 None
 276             } else {
 277                 Some((lint::LintId::of(lint), lint::Allow))
 278             }
 279         })
 280         .collect();
 281     (lint_opts, lint_caps)
 282 }
 283
 284 /// Parse, resolve, and typecheck the given crate.
 285 crate fn create_config(
 286     RustdocOptions {
 287         input,
 288         crate_name,
 289         proc_macro_crate,
 290         error_format,
 291         libs,
 292         externs,
 293         mut cfgs,
 294         codegen_options,
 295         debugging_opts,
 296         target,
 297         edition,
 298         maybe_sysroot,
 299         lint_opts,
 300         describe_lints,
 301         lint_cap,
 302         display_warnings,
 303         ..
 304     }: RustdocOptions,
 305 ) -> rustc_interface::Config {
 306     // Add the doc cfg into the doc build.
 307     cfgs.push("doc".to_string());
 308
 309     let cpath = Some(input.clone());
 310     let input = Input::File(input);
 311
 312     let broken_intra_doc_links = lint::builtin::BROKEN_INTRA_DOC_LINKS.name;
 313     let private_intra_doc_links = lint::builtin::PRIVATE_INTRA_DOC_LINKS.name;
 314     let missing_docs = rustc_lint::builtin::MISSING_DOCS.name;
 315     let missing_doc_example = rustc_lint::builtin::MISSING_DOC_CODE_EXAMPLES.name;
 316     let private_doc_tests = rustc_lint::builtin::PRIVATE_DOC_TESTS.name;
 317     let no_crate_level_docs = rustc_lint::builtin::MISSING_CRATE_LEVEL_DOCS.name;
 318     let invalid_codeblock_attributes_name = rustc_lint::builtin::INVALID_CODEBLOCK_ATTRIBUTES.name;
 319     let invalid_html_tags = rustc_lint::builtin::INVALID_HTML_TAGS.name;
 320     let renamed_and_removed_lints = rustc_lint::builtin::RENAMED_AND_REMOVED_LINTS.name;
 321     let non_autolinks = rustc_lint::builtin::NON_AUTOLINKS.name;
 322     let unknown_lints = rustc_lint::builtin::UNKNOWN_LINTS.name;
 323
 324     // In addition to those specific lints, we also need to allow those given through
 325     // command line, otherwise they'll get ignored and we don't want that.
 326     let lints_to_show = vec![
 327         broken_intra_doc_links.to_owned(),
 328         private_intra_doc_links.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(),
 334         invalid_html_tags.to_owned(),
 335         renamed_and_removed_lints.to_owned(),
 336         unknown_lints.to_owned(),
 337         non_autolinks.to_owned(),
 338     ];
 339
 340     let (lint_opts, lint_caps) = init_lints(lints_to_show, lint_opts, |lint| {
 341         // FIXME: why is this necessary?
 342         if lint.name == broken_intra_doc_links || lint.name == invalid_codeblock_attributes_name {
 343             None
 344         } else {
 345             Some((lint.name_lower(), lint::Allow))
 346         }
 347     });
 348
 349     let crate_types =
 350         if proc_macro_crate { vec![CrateType::ProcMacro] } else { vec![CrateType::Rlib] };
 351     // plays with error output here!
 352     let sessopts = config::Options {
 353         maybe_sysroot,
 354         search_paths: libs,
 355         crate_types,
 356         lint_opts: if !display_warnings { lint_opts } else { vec![] },
 357         lint_cap,
 358         cg: codegen_options,
 359         externs,
 360         target_triple: target,
 361         unstable_features: UnstableFeatures::from_environment(crate_name.as_deref()),
 362         actually_rustdoc: true,
 363         debugging_opts,
 364         error_format,
 365         edition,
 366         describe_lints,
 367         crate_name,
 368         ..Options::default()
 369     };
 370
 371     interface::Config {
 372         opts: sessopts,
 373         crate_cfg: interface::parse_cfgspecs(cfgs),
 374         input,
 375         input_path: cpath,
 376         output_file: None,
 377         output_dir: None,
 378         file_loader: None,
 379         diagnostic_output: DiagnosticOutput::Default,
 380         stderr: None,
 381         lint_caps,
 382         register_lints: None,
 383         override_queries: Some(|_sess, providers, _external_providers| {
 384             // Most lints will require typechecking, so just don't run them.
 385             providers.lint_mod = |_, _| {};
 386             // Prevent `rustc_typeck::check_crate` from calling `typeck` on all bodies.
 387             providers.typeck_item_bodies = |_, _| {};
 388             // hack so that `used_trait_imports` won't try to call typeck
 389             providers.used_trait_imports = |_, _| {
 390                 lazy_static! {
 391                     static ref EMPTY_SET: FxHashSet<LocalDefId> = FxHashSet::default();
 392                 }
 393                 &EMPTY_SET
 394             };
 395             // In case typeck does end up being called, don't ICE in case there were name resolution errors
 396             providers.typeck = move |tcx, def_id| {
 397                 // Closures' tables come from their outermost function,
 398                 // as they are part of the same "inference environment".
 399                 // This avoids emitting errors for the parent twice (see similar code in `typeck_with_fallback`)
 400                 let outer_def_id = tcx.closure_base_def_id(def_id.to_def_id()).expect_local();
 401                 if outer_def_id != def_id {
 402                     return tcx.typeck(outer_def_id);
 403                 }
 404
 405                 let hir = tcx.hir();
 406                 let body = hir.body(hir.body_owned_by(hir.local_def_id_to_hir_id(def_id)));
 407                 debug!("visiting body for {:?}", def_id);
 408                 EmitIgnoredResolutionErrors::new(tcx).visit_body(body);
 409                 (rustc_interface::DEFAULT_QUERY_PROVIDERS.typeck)(tcx, def_id)
 410             };
 411         }),
 412         make_codegen_backend: None,
 413         registry: rustc_driver::diagnostics_registry(),
 414     }
 415 }
 416
 417 crate fn create_resolver<'a>(
 418     externs: config::Externs,
 419     queries: &Queries<'a>,
 420     sess: &Session,
 421 ) -> Rc<RefCell<interface::BoxedResolver>> {
 422     let extern_names: Vec<String> = externs
 423         .iter()
 424         .filter(|(_, entry)| entry.add_prelude)
 425         .map(|(name, _)| name)
 426         .cloned()
 427         .collect();
 428
 429     let parts = abort_on_err(queries.expansion(), sess).peek();
 430     let resolver = parts.1.borrow();
 431
 432     // Before we actually clone it, let's force all the extern'd crates to
 433     // actually be loaded, just in case they're only referred to inside
 434     // intra-doc links
 435     resolver.borrow_mut().access(|resolver| {
 436         sess.time("load_extern_crates", || {
 437             for extern_name in &extern_names {
 438                 debug!("loading extern crate {}", extern_name);
 439                 if let Err(()) = resolver
 440                     .resolve_str_path_error(
 441                         DUMMY_SP,
 442                         extern_name,
 443                         TypeNS,
 444                         LocalDefId { local_def_index: CRATE_DEF_INDEX }.to_def_id(),
 445                   ) {
 446                     warn!("unable to resolve external crate {} (do you have an unused `--extern` crate?)", extern_name)
 447                   }
 448             }
 449         });
 450     });
 451
 452     // Now we're good to clone the resolver because everything should be loaded
 453     resolver.clone()
 454 }
 455
 456 crate fn run_global_ctxt(
 457     tcx: TyCtxt<'_>,
 458     resolver: Rc<RefCell<interface::BoxedResolver>>,
 459     mut default_passes: passes::DefaultPassOption,
 460     mut manual_passes: Vec<String>,
 461     render_options: RenderOptions,
 462     output_format: OutputFormat,
 463 ) -> (clean::Crate, RenderInfo, RenderOptions) {
 464     // Certain queries assume that some checks were run elsewhere
 465     // (see https://github.com/rust-lang/rust/pull/73566#issuecomment-656954425),
 466     // so type-check everything other than function bodies in this crate before running lints.
 467
 468     // NOTE: this does not call `tcx.analysis()` so that we won't
 469     // typeck function bodies or run the default rustc lints.
 470     // (see `override_queries` in the `config`)
 471
 472     // HACK(jynelson) this calls an _extremely_ limited subset of `typeck`
 473     // and might break if queries change their assumptions in the future.
 474
 475     // NOTE: This is copy/pasted from typeck/lib.rs and should be kept in sync with those changes.
 476     tcx.sess.time("item_types_checking", || {
 477         for &module in tcx.hir().krate().modules.keys() {
 478             tcx.ensure().check_mod_item_types(module);
 479         }
 480     });
 481     tcx.sess.abort_if_errors();
 482     tcx.sess.time("missing_docs", || {
 483         rustc_lint::check_crate(tcx, rustc_lint::builtin::MissingDoc::new);
 484     });
 485     tcx.sess.time("check_mod_attrs", || {
 486         for &module in tcx.hir().krate().modules.keys() {
 487             tcx.ensure().check_mod_attrs(module);
 488         }
 489     });
 490
 491     let access_levels = tcx.privacy_access_levels(LOCAL_CRATE);
 492     // Convert from a HirId set to a DefId set since we don't always have easy access
 493     // to the map from defid -> hirid
 494     let access_levels = AccessLevels {
 495         map: access_levels
 496             .map
 497             .iter()
 498             .map(|(&k, &v)| (tcx.hir().local_def_id(k).to_def_id(), v))
 499             .collect(),
 500     };
 501
 502     let mut renderinfo = RenderInfo::default();
 503     renderinfo.access_levels = access_levels;
 504     renderinfo.output_format = output_format;
 505
 506     let mut ctxt = DocContext {
 507         tcx,
 508         resolver,
 509         param_env: ParamEnv::empty(),
 510         external_traits: Default::default(),
 511         active_extern_traits: Default::default(),
 512         renderinfo: RefCell::new(renderinfo),
 513         ty_substs: Default::default(),
 514         lt_substs: Default::default(),
 515         ct_substs: Default::default(),
 516         impl_trait_bounds: Default::default(),
 517         fake_def_ids: Default::default(),
 518         generated_synthetics: Default::default(),
 519         auto_traits: tcx
 520             .all_traits(LOCAL_CRATE)
 521             .iter()
 522             .cloned()
 523             .filter(|trait_def_id| tcx.trait_is_auto(*trait_def_id))
 524             .collect(),
 525         render_options,
 526         module_trait_cache: RefCell::new(FxHashMap::default()),
 527         cache: Cache::default(),
 528     };
 529
 530     // Small hack to force the Sized trait to be present.
 531     //
 532     // Note that in case of `#![no_core]`, the trait is not available.
 533     if let Some(sized_trait_did) = ctxt.tcx.lang_items().sized_trait() {
 534         let mut sized_trait = build_external_trait(&mut ctxt, sized_trait_did);
 535         sized_trait.is_auto = true;
 536         ctxt.external_traits.borrow_mut().insert(sized_trait_did, sized_trait);
 537     }
 538
 539     debug!("crate: {:?}", tcx.hir().krate());
 540
 541     let mut krate = tcx.sess.time("clean_crate", || clean::krate(&mut ctxt));
 542
 543     if let Some(ref m) = krate.module {
 544         if m.doc_value().map(|d| d.is_empty()).unwrap_or(true) {
 545             let help = "The following guide may be of use:\n\
 546                 https://doc.rust-lang.org/nightly/rustdoc/how-to-write-documentation.html";
 547             tcx.struct_lint_node(
 548                 rustc_lint::builtin::MISSING_CRATE_LEVEL_DOCS,
 549                 ctxt.as_local_hir_id(m.def_id).unwrap(),
 550                 |lint| {
 551                     let mut diag =
 552                         lint.build("no documentation found for this crate's top-level module");
 553                     diag.help(help);
 554                     diag.emit();
 555                 },
 556             );
 557         }
 558     }
 559
 560     fn report_deprecated_attr(name: &str, diag: &rustc_errors::Handler) {
 561         let mut msg = diag
 562             .struct_warn(&format!("the `#![doc({})]` attribute is considered deprecated", name));
 563         msg.warn(
 564             "see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
 565              for more information",
 566         );
 567
 568         if name == "no_default_passes" {
 569             msg.help("you may want to use `#![doc(document_private_items)]`");
 570         }
 571
 572         msg.emit();
 573     }
 574
 575     // Process all of the crate attributes, extracting plugin metadata along
 576     // with the passes which we are supposed to run.
 577     for attr in krate.module.as_ref().unwrap().attrs.lists(sym::doc) {
 578         let diag = ctxt.sess().diagnostic();
 579
 580         let name = attr.name_or_empty();
 581         if attr.is_word() {
 582             if name == sym::no_default_passes {
 583                 report_deprecated_attr("no_default_passes", diag);
 584                 if default_passes == passes::DefaultPassOption::Default {
 585                     default_passes = passes::DefaultPassOption::None;
 586                 }
 587             }
 588         } else if let Some(value) = attr.value_str() {
 589             let sink = match name {
 590                 sym::passes => {
 591                     report_deprecated_attr("passes = \"...\"", diag);
 592                     &mut manual_passes
 593                 }
 594                 sym::plugins => {
 595                     report_deprecated_attr("plugins = \"...\"", diag);
 596                     eprintln!(
 597                         "WARNING: `#![doc(plugins = \"...\")]` \
 598                          no longer functions; see CVE-2018-1000622"
 599                     );
 600                     continue;
 601                 }
 602                 _ => continue,
 603             };
 604             for name in value.as_str().split_whitespace() {
 605                 sink.push(name.to_string());
 606             }
 607         }
 608
 609         if attr.is_word() && name == sym::document_private_items {
 610             ctxt.render_options.document_private = true;
 611         }
 612     }
 613
 614     let passes = passes::defaults(default_passes).iter().copied().chain(
 615         manual_passes.into_iter().flat_map(|name| {
 616             if let Some(pass) = passes::find_pass(&name) {
 617                 Some(ConditionalPass::always(pass))
 618             } else {
 619                 error!("unknown pass {}, skipping", name);
 620                 None
 621             }
 622         }),
 623     );
 624
 625     info!("Executing passes");
 626
 627     for p in passes {
 628         let run = match p.condition {
 629             Always => true,
 630             WhenDocumentPrivate => ctxt.render_options.document_private,
 631             WhenNotDocumentPrivate => !ctxt.render_options.document_private,
 632             WhenNotDocumentHidden => !ctxt.render_options.document_hidden,
 633         };
 634         if run {
 635             debug!("running pass {}", p.pass.name);
 636             krate = ctxt.tcx.sess.time(p.pass.name, || (p.pass.run)(krate, &mut ctxt));
 637         }
 638     }
 639
 640     ctxt.sess().abort_if_errors();
 641
 642     // The main crate doc comments are always collapsed.
 643     krate.collapsed = true;
 644
 645     (krate, ctxt.renderinfo.into_inner(), ctxt.render_options)
 646 }
 647
 648 /// Due to <https://github.com/rust-lang/rust/pull/73566>,
 649 /// the name resolution pass may find errors that are never emitted.
 650 /// If typeck is called after this happens, then we'll get an ICE:
 651 /// 'Res::Error found but not reported'. To avoid this, emit the errors now.
 652 struct EmitIgnoredResolutionErrors<'tcx> {
 653     tcx: TyCtxt<'tcx>,
 654 }
 655
 656 impl<'tcx> EmitIgnoredResolutionErrors<'tcx> {
 657     fn new(tcx: TyCtxt<'tcx>) -> Self {
 658         Self { tcx }
 659     }
 660 }
 661
 662 impl<'tcx> Visitor<'tcx> for EmitIgnoredResolutionErrors<'tcx> {
 663     type Map = Map<'tcx>;
 664
 665     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
 666         // We need to recurse into nested closures,
 667         // since those will fallback to the parent for type checking.
 668         NestedVisitorMap::OnlyBodies(self.tcx.hir())
 669     }
 670
 671     fn visit_path(&mut self, path: &'tcx Path<'_>, _id: HirId) {
 672         debug!("visiting path {:?}", path);
 673         if path.res == Res::Err {
 674             // We have less context here than in rustc_resolve,
 675             // so we can only emit the name and span.
 676             // However we can give a hint that rustc_resolve will have more info.
 677             let label = format!(
 678                 "could not resolve path `{}`",
 679                 path.segments
 680                     .iter()
 681                     .map(|segment| segment.ident.as_str().to_string())
 682                     .collect::<Vec<_>>()
 683                     .join("::")
 684             );
 685             let mut err = rustc_errors::struct_span_err!(
 686                 self.tcx.sess,
 687                 path.span,
 688                 E0433,
 689                 "failed to resolve: {}",
 690                 label
 691             );
 692             err.span_label(path.span, label);
 693             err.note("this error was originally ignored because you are running `rustdoc`");
 694             err.note("try running again with `rustc` or `cargo check` and you may get a more detailed error");
 695             err.emit();
 696         }
 697         // We could have an outer resolution that succeeded,
 698         // but with generic parameters that failed.
 699         // Recurse into the segments so we catch those too.
 700         intravisit::walk_path(self, path);
 701     }
 702 }
 703
 704 /// `DefId` or parameter index (`ty::ParamTy.index`) of a synthetic type parameter
 705 /// for `impl Trait` in argument position.
 706 #[derive(Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
 707 crate enum ImplTraitParam {
 708     DefId(DefId),
 709     ParamIndex(u32),
 710 }
 711
 712 impl From<DefId> for ImplTraitParam {
 713     fn from(did: DefId) -> Self {
 714         ImplTraitParam::DefId(did)
 715     }
 716 }
 717
 718 impl From<u32> for ImplTraitParam {
 719     fn from(idx: u32) -> Self {
 720         ImplTraitParam::ParamIndex(idx)
 721     }
 722 }