src/librustdoc/core.rs

   1 use rustc::lint;
   2 use rustc::middle::cstore::CrateStore;
   3 use rustc::middle::privacy::AccessLevels;
   4 use rustc::session::config::ErrorOutputType;
   5 use rustc::session::DiagnosticOutput;
   6 use rustc::session::{self, config};
   7 use rustc::ty::{Ty, TyCtxt};
   8 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
   9 use rustc_driver::abort_on_err;
  10 use rustc_feature::UnstableFeatures;
  11 use rustc_hir::def::Namespace::TypeNS;
  12 use rustc_hir::def_id::{CrateNum, DefId, DefIndex, LOCAL_CRATE};
  13 use rustc_hir::HirId;
  14 use rustc_interface::interface;
  15 use rustc_lint;
  16 use rustc_resolve as resolve;
  17
  18 use errors::emitter::{Emitter, EmitterWriter};
  19 use errors::json::JsonEmitter;
  20 use rustc_span::source_map;
  21 use rustc_span::symbol::sym;
  22 use rustc_span::DUMMY_SP;
  23 use syntax::ast::CRATE_NODE_ID;
  24 use syntax::attr;
  25
  26 use rustc_data_structures::sync::{self, Lrc};
  27 use std::cell::RefCell;
  28 use std::mem;
  29 use std::rc::Rc;
  30
  31 use crate::clean;
  32 use crate::clean::{AttributesExt, MAX_DEF_ID};
  33 use crate::config::{Options as RustdocOptions, RenderOptions};
  34 use crate::html::render::RenderInfo;
  35
  36 use crate::passes::{self, Condition::*, ConditionalPass};
  37
  38 pub use rustc::session::config::{CodegenOptions, DebuggingOptions, Input, Options};
  39 pub use rustc::session::search_paths::SearchPath;
  40
  41 pub type ExternalPaths = FxHashMap<DefId, (Vec<String>, clean::TypeKind)>;
  42
  43 pub struct DocContext<'tcx> {
  44     pub tcx: TyCtxt<'tcx>,
  45     pub resolver: Rc<RefCell<interface::BoxedResolver>>,
  46     /// Later on moved into `html::render::CACHE_KEY`
  47     pub renderinfo: RefCell<RenderInfo>,
  48     /// Later on moved through `clean::Crate` into `html::render::CACHE_KEY`
  49     pub external_traits: Rc<RefCell<FxHashMap<DefId, clean::Trait>>>,
  50     /// Used while populating `external_traits` to ensure we don't process the same trait twice at
  51     /// the same time.
  52     pub active_extern_traits: RefCell<FxHashSet<DefId>>,
  53     // The current set of type and lifetime substitutions,
  54     // for expanding type aliases at the HIR level:
  55     /// Table `DefId` of type parameter -> substituted type
  56     pub ty_substs: RefCell<FxHashMap<DefId, clean::Type>>,
  57     /// Table `DefId` of lifetime parameter -> substituted lifetime
  58     pub lt_substs: RefCell<FxHashMap<DefId, clean::Lifetime>>,
  59     /// Table `DefId` of const parameter -> substituted const
  60     pub ct_substs: RefCell<FxHashMap<DefId, clean::Constant>>,
  61     /// Table synthetic type parameter for `impl Trait` in argument position -> bounds
  62     pub impl_trait_bounds: RefCell<FxHashMap<ImplTraitParam, Vec<clean::GenericBound>>>,
  63     pub fake_def_ids: RefCell<FxHashMap<CrateNum, DefId>>,
  64     pub all_fake_def_ids: RefCell<FxHashSet<DefId>>,
  65     /// Auto-trait or blanket impls processed so far, as `(self_ty, trait_def_id)`.
  66     // FIXME(eddyb) make this a `ty::TraitRef<'tcx>` set.
  67     pub generated_synthetics: RefCell<FxHashSet<(Ty<'tcx>, DefId)>>,
  68     pub auto_traits: Vec<DefId>,
  69 }
  70
  71 impl<'tcx> DocContext<'tcx> {
  72     pub fn sess(&self) -> &session::Session {
  73         &self.tcx.sess
  74     }
  75
  76     pub fn enter_resolver<F, R>(&self, f: F) -> R
  77     where
  78         F: FnOnce(&mut resolve::Resolver<'_>) -> R,
  79     {
  80         self.resolver.borrow_mut().access(f)
  81     }
  82
  83     /// Call the closure with the given parameters set as
  84     /// the substitutions for a type alias' RHS.
  85     pub fn enter_alias<F, R>(
  86         &self,
  87         ty_substs: FxHashMap<DefId, clean::Type>,
  88         lt_substs: FxHashMap<DefId, clean::Lifetime>,
  89         ct_substs: FxHashMap<DefId, clean::Constant>,
  90         f: F,
  91     ) -> R
  92     where
  93         F: FnOnce() -> R,
  94     {
  95         let (old_tys, old_lts, old_cts) = (
  96             mem::replace(&mut *self.ty_substs.borrow_mut(), ty_substs),
  97             mem::replace(&mut *self.lt_substs.borrow_mut(), lt_substs),
  98             mem::replace(&mut *self.ct_substs.borrow_mut(), ct_substs),
  99         );
 100         let r = f();
 101         *self.ty_substs.borrow_mut() = old_tys;
 102         *self.lt_substs.borrow_mut() = old_lts;
 103         *self.ct_substs.borrow_mut() = old_cts;
 104         r
 105     }
 106
 107     // This is an ugly hack, but it's the simplest way to handle synthetic impls without greatly
 108     // refactoring either librustdoc or librustc. In particular, allowing new DefIds to be
 109     // registered after the AST is constructed would require storing the defid mapping in a
 110     // RefCell, decreasing the performance for normal compilation for very little gain.
 111     //
 112     // Instead, we construct 'fake' def ids, which start immediately after the last DefId.
 113     // In the Debug impl for clean::Item, we explicitly check for fake
 114     // def ids, as we'll end up with a panic if we use the DefId Debug impl for fake DefIds
 115     pub fn next_def_id(&self, crate_num: CrateNum) -> DefId {
 116         let start_def_id = {
 117             let next_id = if crate_num == LOCAL_CRATE {
 118                 self.tcx.hir().definitions().def_path_table().next_id()
 119             } else {
 120                 self.enter_resolver(|r| r.cstore().def_path_table(crate_num).next_id())
 121             };
 122
 123             DefId { krate: crate_num, index: next_id }
 124         };
 125
 126         let mut fake_ids = self.fake_def_ids.borrow_mut();
 127
 128         let def_id = fake_ids.entry(crate_num).or_insert(start_def_id).clone();
 129         fake_ids.insert(
 130             crate_num,
 131             DefId { krate: crate_num, index: DefIndex::from(def_id.index.index() + 1) },
 132         );
 133
 134         MAX_DEF_ID.with(|m| {
 135             m.borrow_mut().entry(def_id.krate.clone()).or_insert(start_def_id);
 136         });
 137
 138         self.all_fake_def_ids.borrow_mut().insert(def_id);
 139
 140         def_id.clone()
 141     }
 142
 143     /// Like the function of the same name on the HIR map, but skips calling it on fake DefIds.
 144     /// (This avoids a slice-index-out-of-bounds panic.)
 145     pub fn as_local_hir_id(&self, def_id: DefId) -> Option<HirId> {
 146         if self.all_fake_def_ids.borrow().contains(&def_id) {
 147             None
 148         } else {
 149             self.tcx.hir().as_local_hir_id(def_id)
 150         }
 151     }
 152
 153     pub fn stability(&self, id: HirId) -> Option<attr::Stability> {
 154         self.tcx
 155             .hir()
 156             .opt_local_def_id(id)
 157             .and_then(|def_id| self.tcx.lookup_stability(def_id))
 158             .cloned()
 159     }
 160
 161     pub fn deprecation(&self, id: HirId) -> Option<attr::Deprecation> {
 162         self.tcx.hir().opt_local_def_id(id).and_then(|def_id| self.tcx.lookup_deprecation(def_id))
 163     }
 164 }
 165
 166 /// Creates a new diagnostic `Handler` that can be used to emit warnings and errors.
 167 ///
 168 /// If the given `error_format` is `ErrorOutputType::Json` and no `SourceMap` is given, a new one
 169 /// will be created for the handler.
 170 pub fn new_handler(
 171     error_format: ErrorOutputType,
 172     source_map: Option<Lrc<source_map::SourceMap>>,
 173     debugging_opts: &DebuggingOptions,
 174 ) -> errors::Handler {
 175     let emitter: Box<dyn Emitter + sync::Send> = match error_format {
 176         ErrorOutputType::HumanReadable(kind) => {
 177             let (short, color_config) = kind.unzip();
 178             Box::new(
 179                 EmitterWriter::stderr(
 180                     color_config,
 181                     source_map.map(|cm| cm as _),
 182                     short,
 183                     debugging_opts.teach,
 184                     debugging_opts.terminal_width,
 185                     false,
 186                 )
 187                 .ui_testing(debugging_opts.ui_testing()),
 188             )
 189         }
 190         ErrorOutputType::Json { pretty, json_rendered } => {
 191             let source_map = source_map.unwrap_or_else(|| {
 192                 Lrc::new(source_map::SourceMap::new(source_map::FilePathMapping::empty()))
 193             });
 194             Box::new(
 195                 JsonEmitter::stderr(None, source_map, pretty, json_rendered, false)
 196                     .ui_testing(debugging_opts.ui_testing()),
 197             )
 198         }
 199     };
 200
 201     errors::Handler::with_emitter_and_flags(emitter, debugging_opts.diagnostic_handler_flags(true))
 202 }
 203
 204 pub fn run_core(options: RustdocOptions) -> (clean::Crate, RenderInfo, RenderOptions) {
 205     // Parse, resolve, and typecheck the given crate.
 206
 207     let RustdocOptions {
 208         input,
 209         crate_name,
 210         proc_macro_crate,
 211         error_format,
 212         libs,
 213         externs,
 214         mut cfgs,
 215         codegen_options,
 216         debugging_options,
 217         target,
 218         edition,
 219         maybe_sysroot,
 220         lint_opts,
 221         describe_lints,
 222         lint_cap,
 223         mut default_passes,
 224         mut document_private,
 225         document_hidden,
 226         mut manual_passes,
 227         display_warnings,
 228         render_options,
 229         ..
 230     } = options;
 231
 232     let extern_names: Vec<String> = externs
 233         .iter()
 234         .filter(|(_, entry)| entry.add_prelude)
 235         .map(|(name, _)| name)
 236         .cloned()
 237         .collect();
 238
 239     // Add the doc cfg into the doc build.
 240     cfgs.push("doc".to_string());
 241
 242     let cpath = Some(input.clone());
 243     let input = Input::File(input);
 244
 245     let intra_link_resolution_failure_name = lint::builtin::INTRA_DOC_LINK_RESOLUTION_FAILURE.name;
 246     let warnings_lint_name = lint::builtin::WARNINGS.name;
 247     let missing_docs = rustc_lint::builtin::MISSING_DOCS.name;
 248     let missing_doc_example = rustc_lint::builtin::MISSING_DOC_CODE_EXAMPLES.name;
 249     let private_doc_tests = rustc_lint::builtin::PRIVATE_DOC_TESTS.name;
 250
 251     // In addition to those specific lints, we also need to whitelist those given through
 252     // command line, otherwise they'll get ignored and we don't want that.
 253     let mut whitelisted_lints = vec![
 254         warnings_lint_name.to_owned(),
 255         intra_link_resolution_failure_name.to_owned(),
 256         missing_docs.to_owned(),
 257         missing_doc_example.to_owned(),
 258         private_doc_tests.to_owned(),
 259     ];
 260
 261     whitelisted_lints.extend(lint_opts.iter().map(|(lint, _)| lint).cloned());
 262
 263     let lints = || {
 264         lint::builtin::HardwiredLints::get_lints()
 265             .into_iter()
 266             .chain(rustc_lint::SoftLints::get_lints().into_iter())
 267     };
 268
 269     let lint_opts = lints()
 270         .filter_map(|lint| {
 271             if lint.name == warnings_lint_name || lint.name == intra_link_resolution_failure_name {
 272                 None
 273             } else {
 274                 Some((lint.name_lower(), lint::Allow))
 275             }
 276         })
 277         .chain(lint_opts.into_iter())
 278         .collect::<Vec<_>>();
 279
 280     let lint_caps = lints()
 281         .filter_map(|lint| {
 282             // We don't want to whitelist *all* lints so let's
 283             // ignore those ones.
 284             if whitelisted_lints.iter().any(|l| &lint.name == l) {
 285                 None
 286             } else {
 287                 Some((lint::LintId::of(lint), lint::Allow))
 288             }
 289         })
 290         .collect();
 291
 292     let crate_types = if proc_macro_crate {
 293         vec![config::CrateType::ProcMacro]
 294     } else {
 295         vec![config::CrateType::Rlib]
 296     };
 297     // plays with error output here!
 298     let sessopts = config::Options {
 299         maybe_sysroot,
 300         search_paths: libs,
 301         crate_types,
 302         lint_opts: if !display_warnings { lint_opts } else { vec![] },
 303         lint_cap: Some(lint_cap.unwrap_or_else(|| lint::Forbid)),
 304         cg: codegen_options,
 305         externs,
 306         target_triple: target,
 307         // Ensure that rustdoc works even if rustc is feature-staged
 308         unstable_features: UnstableFeatures::Allow,
 309         actually_rustdoc: true,
 310         debugging_opts: debugging_options,
 311         error_format,
 312         edition,
 313         describe_lints,
 314         ..Options::default()
 315     };
 316
 317     let config = interface::Config {
 318         opts: sessopts,
 319         crate_cfg: interface::parse_cfgspecs(cfgs),
 320         input,
 321         input_path: cpath,
 322         output_file: None,
 323         output_dir: None,
 324         file_loader: None,
 325         diagnostic_output: DiagnosticOutput::Default,
 326         stderr: None,
 327         crate_name,
 328         lint_caps,
 329         register_lints: None,
 330         override_queries: None,
 331         registry: rustc_driver::diagnostics_registry(),
 332     };
 333
 334     interface::run_compiler_in_existing_thread_pool(config, |compiler| {
 335         compiler.enter(|queries| {
 336             let sess = compiler.session();
 337
 338             // We need to hold on to the complete resolver, so we cause everything to be
 339             // cloned for the analysis passes to use. Suboptimal, but necessary in the
 340             // current architecture.
 341             let resolver = {
 342                 let parts = abort_on_err(queries.expansion(), sess).peek();
 343                 let resolver = parts.1.borrow();
 344
 345                 // Before we actually clone it, let's force all the extern'd crates to
 346                 // actually be loaded, just in case they're only referred to inside
 347                 // intra-doc-links
 348                 resolver.borrow_mut().access(|resolver| {
 349                     for extern_name in &extern_names {
 350                         resolver
 351                             .resolve_str_path_error(DUMMY_SP, extern_name, TypeNS, CRATE_NODE_ID)
 352                             .unwrap_or_else(|()| {
 353                                 panic!("Unable to resolve external crate {}", extern_name)
 354                             });
 355                     }
 356                 });
 357
 358                 // Now we're good to clone the resolver because everything should be loaded
 359                 resolver.clone()
 360             };
 361
 362             if sess.has_errors() {
 363                 sess.fatal("Compilation failed, aborting rustdoc");
 364             }
 365
 366             let mut global_ctxt = abort_on_err(queries.global_ctxt(), sess).take();
 367
 368             global_ctxt.enter(|tcx| {
 369                 tcx.analysis(LOCAL_CRATE).ok();
 370
 371                 // Abort if there were any errors so far
 372                 sess.abort_if_errors();
 373
 374                 let access_levels = tcx.privacy_access_levels(LOCAL_CRATE);
 375                 // Convert from a HirId set to a DefId set since we don't always have easy access
 376                 // to the map from defid -> hirid
 377                 let access_levels = AccessLevels {
 378                     map: access_levels
 379                         .map
 380                         .iter()
 381                         .map(|(&k, &v)| (tcx.hir().local_def_id(k), v))
 382                         .collect(),
 383                 };
 384
 385                 let mut renderinfo = RenderInfo::default();
 386                 renderinfo.access_levels = access_levels;
 387
 388                 let mut ctxt = DocContext {
 389                     tcx,
 390                     resolver,
 391                     external_traits: Default::default(),
 392                     active_extern_traits: Default::default(),
 393                     renderinfo: RefCell::new(renderinfo),
 394                     ty_substs: Default::default(),
 395                     lt_substs: Default::default(),
 396                     ct_substs: Default::default(),
 397                     impl_trait_bounds: Default::default(),
 398                     fake_def_ids: Default::default(),
 399                     all_fake_def_ids: Default::default(),
 400                     generated_synthetics: Default::default(),
 401                     auto_traits: tcx
 402                         .all_traits(LOCAL_CRATE)
 403                         .iter()
 404                         .cloned()
 405                         .filter(|trait_def_id| tcx.trait_is_auto(*trait_def_id))
 406                         .collect(),
 407                 };
 408                 debug!("crate: {:?}", tcx.hir().krate());
 409
 410                 let mut krate = clean::krate(&mut ctxt);
 411
 412                 fn report_deprecated_attr(name: &str, diag: &errors::Handler) {
 413                     let mut msg = diag.struct_warn(&format!(
 414                         "the `#![doc({})]` attribute is \
 415                                                          considered deprecated",
 416                         name
 417                     ));
 418                     msg.warn("please see https://github.com/rust-lang/rust/issues/44136");
 419
 420                     if name == "no_default_passes" {
 421                         msg.help("you may want to use `#![doc(document_private_items)]`");
 422                     }
 423
 424                     msg.emit();
 425                 }
 426
 427                 // Process all of the crate attributes, extracting plugin metadata along
 428                 // with the passes which we are supposed to run.
 429                 for attr in krate.module.as_ref().unwrap().attrs.lists(sym::doc) {
 430                     let diag = ctxt.sess().diagnostic();
 431
 432                     let name = attr.name_or_empty();
 433                     if attr.is_word() {
 434                         if name == sym::no_default_passes {
 435                             report_deprecated_attr("no_default_passes", diag);
 436                             if default_passes == passes::DefaultPassOption::Default {
 437                                 default_passes = passes::DefaultPassOption::None;
 438                             }
 439                         }
 440                     } else if let Some(value) = attr.value_str() {
 441                         let sink = match name {
 442                             sym::passes => {
 443                                 report_deprecated_attr("passes = \"...\"", diag);
 444                                 &mut manual_passes
 445                             }
 446                             sym::plugins => {
 447                                 report_deprecated_attr("plugins = \"...\"", diag);
 448                                 eprintln!(
 449                                     "WARNING: `#![doc(plugins = \"...\")]` \
 450                                       no longer functions; see CVE-2018-1000622"
 451                                 );
 452                                 continue;
 453                             }
 454                             _ => continue,
 455                         };
 456                         for name in value.as_str().split_whitespace() {
 457                             sink.push(name.to_string());
 458                         }
 459                     }
 460
 461                     if attr.is_word() && name == sym::document_private_items {
 462                         document_private = true;
 463                     }
 464                 }
 465
 466                 let passes = passes::defaults(default_passes).iter().copied().chain(
 467                     manual_passes.into_iter().flat_map(|name| {
 468                         if let Some(pass) = passes::find_pass(&name) {
 469                             Some(ConditionalPass::always(pass))
 470                         } else {
 471                             error!("unknown pass {}, skipping", name);
 472                             None
 473                         }
 474                     }),
 475                 );
 476
 477                 info!("Executing passes");
 478
 479                 for p in passes {
 480                     let run = match p.condition {
 481                         Always => true,
 482                         WhenDocumentPrivate => document_private,
 483                         WhenNotDocumentPrivate => !document_private,
 484                         WhenNotDocumentHidden => !document_hidden,
 485                     };
 486                     if run {
 487                         debug!("running pass {}", p.pass.name);
 488                         krate = (p.pass.run)(krate, &ctxt);
 489                     }
 490                 }
 491
 492                 ctxt.sess().abort_if_errors();
 493
 494                 (krate, ctxt.renderinfo.into_inner(), render_options)
 495             })
 496         })
 497     })
 498 }
 499
 500 /// `DefId` or parameter index (`ty::ParamTy.index`) of a synthetic type parameter
 501 /// for `impl Trait` in argument position.
 502 #[derive(Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
 503 pub enum ImplTraitParam {
 504     DefId(DefId),
 505     ParamIndex(u32),
 506 }
 507
 508 impl From<DefId> for ImplTraitParam {
 509     fn from(did: DefId) -> Self {
 510         ImplTraitParam::DefId(did)
 511     }
 512 }
 513
 514 impl From<u32> for ImplTraitParam {
 515     fn from(idx: u32) -> Self {
 516         ImplTraitParam::ParamIndex(idx)
 517     }
 518 }