1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
12 use rustc_driver::{self, driver, target_features, abort_on_err};
13 use rustc::session::{self, config};
14 use rustc::hir::def_id::{DefId, DefIndex, DefIndexAddressSpace, CrateNum, LOCAL_CRATE};
15 use rustc::hir::def::Def;
16 use rustc::hir::{self, HirVec};
17 use rustc::middle::cstore::CrateStore;
18 use rustc::middle::privacy::AccessLevels;
19 use rustc::ty::{self, TyCtxt, AllArenas};
20 use rustc::hir::map as hir_map;
21 use rustc::lint::{self, LintPass};
22 use rustc::session::config::ErrorOutputType;
23 use rustc::util::nodemap::{FxHashMap, FxHashSet};
24 use rustc_resolve as resolve;
25 use rustc_metadata::creader::CrateLoader;
26 use rustc_metadata::cstore::CStore;
27 use rustc_target::spec::TargetTriple;
29 use syntax::ast::{self, Ident, NodeId};
30 use syntax::source_map;
31 use syntax::edition::Edition;
32 use syntax::feature_gate::UnstableFeatures;
33 use syntax::json::JsonEmitter;
35 use syntax::symbol::keywords;
36 use syntax_pos::DUMMY_SP;
38 use errors::emitter::{Emitter, EmitterWriter};
39 use parking_lot::ReentrantMutex;
41 use std::cell::RefCell;
43 use rustc_data_structures::sync::{self, Lrc};
46 use std::path::PathBuf;
48 use visit_ast::RustdocVisitor;
50 use clean::{get_path_for_type, Clean, MAX_DEF_ID, AttributesExt};
51 use html::render::RenderInfo;
54 pub use rustc::session::config::{Input, Options, CodegenOptions};
55 pub use rustc::session::search_paths::SearchPaths;
57 pub type ExternalPaths = FxHashMap<DefId, (Vec<String>, clean::TypeKind)>;
59 pub struct DocContext<'a, 'tcx: 'a, 'rcx: 'a, 'cstore: 'rcx> {
60 pub tcx: TyCtxt<'a, 'tcx, 'tcx>,
61 pub resolver: &'a RefCell<resolve::Resolver<'rcx, 'cstore>>,
62 /// The stack of module NodeIds up till this point
63 pub crate_name: Option<String>,
64 pub cstore: Rc<CStore>,
65 // Note that external items for which `doc(hidden)` applies to are shown as
66 // non-reachable while local items aren't. This is because we're reusing
67 // the access levels from crateanalysis.
68 /// Later on moved into `html::render::CACHE_KEY`
69 pub renderinfo: RefCell<RenderInfo>,
70 /// Later on moved through `clean::Crate` into `html::render::CACHE_KEY`
71 pub external_traits: Arc<ReentrantMutex<RefCell<FxHashMap<DefId, clean::Trait>>>>,
72 /// Used while populating `external_traits` to ensure we don't process the same trait twice at
74 pub active_extern_traits: RefCell<Vec<DefId>>,
75 // The current set of type and lifetime substitutions,
76 // for expanding type aliases at the HIR level:
78 /// Table type parameter definition -> substituted type
79 pub ty_substs: RefCell<FxHashMap<Def, clean::Type>>,
80 /// Table node id of lifetime parameter definition -> substituted lifetime
81 pub lt_substs: RefCell<FxHashMap<DefId, clean::Lifetime>>,
82 /// Table DefId of `impl Trait` in argument position -> bounds
83 pub impl_trait_bounds: RefCell<FxHashMap<DefId, Vec<clean::GenericBound>>>,
84 pub send_trait: Option<DefId>,
85 pub fake_def_ids: RefCell<FxHashMap<CrateNum, DefId>>,
86 pub all_fake_def_ids: RefCell<FxHashSet<DefId>>,
87 /// Maps (type_id, trait_id) -> auto trait impl
88 pub generated_synthetics: RefCell<FxHashSet<(DefId, DefId)>>,
89 pub all_traits: Vec<DefId>,
92 impl<'a, 'tcx, 'rcx, 'cstore> DocContext<'a, 'tcx, 'rcx, 'cstore> {
93 pub fn sess(&self) -> &session::Session {
97 /// Call the closure with the given parameters set as
98 /// the substitutions for a type alias' RHS.
99 pub fn enter_alias<F, R>(&self,
100 ty_substs: FxHashMap<Def, clean::Type>,
101 lt_substs: FxHashMap<DefId, clean::Lifetime>,
103 where F: FnOnce() -> R {
104 let (old_tys, old_lts) =
105 (mem::replace(&mut *self.ty_substs.borrow_mut(), ty_substs),
106 mem::replace(&mut *self.lt_substs.borrow_mut(), lt_substs));
108 *self.ty_substs.borrow_mut() = old_tys;
109 *self.lt_substs.borrow_mut() = old_lts;
113 // This is an ugly hack, but it's the simplest way to handle synthetic impls without greatly
114 // refactoring either librustdoc or librustc. In particular, allowing new DefIds to be
115 // registered after the AST is constructed would require storing the defid mapping in a
116 // RefCell, decreasing the performance for normal compilation for very little gain.
118 // Instead, we construct 'fake' def ids, which start immediately after the last DefId in
119 // DefIndexAddressSpace::Low. In the Debug impl for clean::Item, we explicitly check for fake
120 // def ids, as we'll end up with a panic if we use the DefId Debug impl for fake DefIds
121 pub fn next_def_id(&self, crate_num: CrateNum) -> DefId {
123 let next_id = if crate_num == LOCAL_CRATE {
128 .next_id(DefIndexAddressSpace::Low)
131 .def_path_table(crate_num)
132 .next_id(DefIndexAddressSpace::Low)
141 let mut fake_ids = self.fake_def_ids.borrow_mut();
143 let def_id = fake_ids.entry(crate_num).or_insert(start_def_id).clone();
148 index: DefIndex::from_array_index(
149 def_id.index.as_array_index() + 1,
150 def_id.index.address_space(),
155 MAX_DEF_ID.with(|m| {
157 .entry(def_id.krate.clone())
158 .or_insert(start_def_id);
161 self.all_fake_def_ids.borrow_mut().insert(def_id);
166 /// Like the function of the same name on the HIR map, but skips calling it on fake DefIds.
167 /// (This avoids a slice-index-out-of-bounds panic.)
168 pub fn as_local_node_id(&self, def_id: DefId) -> Option<NodeId> {
169 if self.all_fake_def_ids.borrow().contains(&def_id) {
172 self.tcx.hir.as_local_node_id(def_id)
176 pub fn get_real_ty<F>(&self,
179 real_name: &Option<Ident>,
180 generics: &ty::Generics,
182 where F: Fn(DefId) -> Def {
183 let path = get_path_for_type(self.tcx, def_id, def_ctor);
184 let mut segments = path.segments.into_vec();
185 let last = segments.pop().expect("segments were empty");
187 segments.push(hir::PathSegment::new(
188 real_name.unwrap_or(last.ident),
191 self.generics_to_path_params(generics.clone()),
195 let new_path = hir::Path {
198 segments: HirVec::from_vec(segments),
202 id: ast::DUMMY_NODE_ID,
203 node: hir::TyKind::Path(hir::QPath::Resolved(None, P(new_path))),
205 hir_id: hir::DUMMY_HIR_ID,
209 pub fn generics_to_path_params(&self, generics: ty::Generics) -> hir::GenericArgs {
210 let mut args = vec![];
212 for param in generics.params.iter() {
214 ty::GenericParamDefKind::Lifetime => {
215 let name = if param.name == "" {
216 hir::ParamName::Plain(keywords::StaticLifetime.ident())
218 hir::ParamName::Plain(ast::Ident::from_interned_str(param.name))
221 args.push(hir::GenericArg::Lifetime(hir::Lifetime {
222 id: ast::DUMMY_NODE_ID,
224 name: hir::LifetimeName::Param(name),
227 ty::GenericParamDefKind::Type {..} => {
228 args.push(hir::GenericArg::Type(self.ty_param_to_ty(param.clone())));
234 args: HirVec::from_vec(args),
235 bindings: HirVec::new(),
236 parenthesized: false,
240 pub fn ty_param_to_ty(&self, param: ty::GenericParamDef) -> hir::Ty {
241 debug!("ty_param_to_ty({:?}) {:?}", param, param.def_id);
243 id: ast::DUMMY_NODE_ID,
244 node: hir::TyKind::Path(hir::QPath::Resolved(
248 def: Def::TyParam(param.def_id),
249 segments: HirVec::from_vec(vec![
250 hir::PathSegment::from_ident(Ident::from_interned_str(param.name))
255 hir_id: hir::DUMMY_HIR_ID,
260 pub trait DocAccessLevels {
261 fn is_doc_reachable(&self, did: DefId) -> bool;
264 impl DocAccessLevels for AccessLevels<DefId> {
265 fn is_doc_reachable(&self, did: DefId) -> bool {
270 /// Creates a new diagnostic `Handler` that can be used to emit warnings and errors.
272 /// If the given `error_format` is `ErrorOutputType::Json` and no `SourceMap` is given, a new one
273 /// will be created for the handler.
274 pub fn new_handler(error_format: ErrorOutputType,
275 source_map: Option<Lrc<source_map::SourceMap>>,
276 treat_err_as_bug: bool,
278 ) -> errors::Handler {
279 // rustdoc doesn't override (or allow to override) anything from this that is relevant here, so
280 // stick to the defaults
281 let sessopts = Options::default();
282 let emitter: Box<dyn Emitter + sync::Send> = match error_format {
283 ErrorOutputType::HumanReadable(color_config) => Box::new(
284 EmitterWriter::stderr(
286 source_map.map(|cm| cm as _),
288 sessopts.debugging_opts.teach,
289 ).ui_testing(ui_testing)
291 ErrorOutputType::Json(pretty) => {
292 let source_map = source_map.unwrap_or_else(
293 || Lrc::new(source_map::SourceMap::new(sessopts.file_path_mapping())));
299 ).ui_testing(ui_testing)
302 ErrorOutputType::Short(color_config) => Box::new(
303 EmitterWriter::stderr(
305 source_map.map(|cm| cm as _),
311 errors::Handler::with_emitter_and_flags(
313 errors::HandlerFlags {
314 can_emit_warnings: true,
316 report_delayed_bugs: false,
317 external_macro_backtrace: false,
323 pub fn run_core(search_paths: SearchPaths,
325 externs: config::Externs,
327 triple: Option<TargetTriple>,
328 maybe_sysroot: Option<PathBuf>,
329 allow_warnings: bool,
330 crate_name: Option<String>,
331 force_unstable_if_unmarked: bool,
334 error_format: ErrorOutputType,
335 cmd_lints: Vec<(String, lint::Level)>,
336 lint_cap: Option<lint::Level>,
337 describe_lints: bool,
338 mut manual_passes: Vec<String>,
339 mut default_passes: passes::DefaultPassOption,
340 treat_err_as_bug: bool,
342 ) -> (clean::Crate, RenderInfo, Vec<String>) {
343 // Parse, resolve, and typecheck the given crate.
345 let cpath = match input {
346 Input::File(ref p) => Some(p.clone()),
350 let intra_link_resolution_failure_name = lint::builtin::INTRA_DOC_LINK_RESOLUTION_FAILURE.name;
351 let warnings_lint_name = lint::builtin::WARNINGS.name;
352 let missing_docs = rustc_lint::builtin::MISSING_DOCS.name;
353 let missing_doc_example = rustc_lint::builtin::MISSING_DOC_CODE_EXAMPLES.name;
355 // In addition to those specific lints, we also need to whitelist those given through
356 // command line, otherwise they'll get ignored and we don't want that.
357 let mut whitelisted_lints = vec![warnings_lint_name.to_owned(),
358 intra_link_resolution_failure_name.to_owned(),
359 missing_docs.to_owned(),
360 missing_doc_example.to_owned()];
362 whitelisted_lints.extend(cmd_lints.iter().map(|(lint, _)| lint).cloned());
364 let lints = lint::builtin::HardwiredLints.get_lints()
366 .chain(rustc_lint::SoftLints.get_lints().into_iter())
368 if lint.name == warnings_lint_name ||
369 lint.name == intra_link_resolution_failure_name {
372 Some((lint.name_lower(), lint::Allow))
375 .chain(cmd_lints.into_iter())
376 .collect::<Vec<_>>();
378 let host_triple = TargetTriple::from_triple(config::host_triple());
379 // plays with error output here!
380 let sessopts = config::Options {
383 crate_types: vec![config::CrateType::Rlib],
384 lint_opts: if !allow_warnings {
389 lint_cap: Some(lint_cap.unwrap_or_else(|| lint::Forbid)),
392 target_triple: triple.unwrap_or(host_triple),
393 // Ensure that rustdoc works even if rustc is feature-staged
394 unstable_features: UnstableFeatures::Allow,
395 actually_rustdoc: true,
396 debugging_opts: config::DebuggingOptions {
397 force_unstable_if_unmarked,
400 ..config::basic_debugging_options()
407 driver::spawn_thread_pool(sessopts, move |sessopts| {
408 let source_map = Lrc::new(source_map::SourceMap::new(sessopts.file_path_mapping()));
409 let diagnostic_handler = new_handler(error_format,
410 Some(source_map.clone()),
414 let mut sess = session::build_session_(
415 sessopts, cpath, diagnostic_handler, source_map,
418 lint::builtin::HardwiredLints.get_lints()
420 .chain(rustc_lint::SoftLints.get_lints().into_iter())
422 // We don't want to whitelist *all* lints so let's
423 // ignore those ones.
424 if whitelisted_lints.iter().any(|l| &lint.name == l) {
431 sess.driver_lint_caps.insert(lint::LintId::of(l),
435 let codegen_backend = rustc_driver::get_codegen_backend(&sess);
436 let cstore = Rc::new(CStore::new(codegen_backend.metadata_loader()));
437 rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
439 let mut cfg = config::build_configuration(&sess, config::parse_cfgspecs(cfgs));
440 target_features::add_configuration(&mut cfg, &sess, &*codegen_backend);
441 sess.parse_sess.config = cfg;
443 let control = &driver::CompileController::basic();
445 let krate = panictry!(driver::phase_1_parse_input(control, &sess, &input));
447 let name = match crate_name {
448 Some(ref crate_name) => crate_name.clone(),
449 None => ::rustc_codegen_utils::link::find_crate_name(Some(&sess), &krate.attrs, &input),
452 let mut crate_loader = CrateLoader::new(&sess, &cstore, &name);
454 let resolver_arenas = resolve::Resolver::arenas();
455 let result = driver::phase_2_configure_and_expand_inner(&sess,
461 resolve::MakeGlobMap::No,
465 let driver::InnerExpansionResult {
469 } = abort_on_err(result, &sess);
471 // We need to hold on to the complete resolver, so we clone everything
472 // for the analysis passes to use. Suboptimal, but necessary in the
473 // current architecture.
474 let defs = resolver.definitions.clone();
475 let resolutions = ty::Resolutions {
476 freevars: resolver.freevars.clone(),
477 export_map: resolver.export_map.clone(),
478 trait_map: resolver.trait_map.clone(),
479 maybe_unused_trait_imports: resolver.maybe_unused_trait_imports.clone(),
480 maybe_unused_extern_crates: resolver.maybe_unused_extern_crates.clone(),
481 extern_prelude: resolver.extern_prelude.iter().map(|(ident, entry)| {
482 (ident.name, entry.introduced_by_item)
485 let analysis = ty::CrateAnalysis {
486 access_levels: Lrc::new(AccessLevels::default()),
487 name: name.to_string(),
488 glob_map: if resolver.make_glob_map { Some(resolver.glob_map.clone()) } else { None },
491 let arenas = AllArenas::new();
492 let hir_map = hir_map::map_crate(&sess, &*cstore, &mut hir_forest, &defs);
493 let output_filenames = driver::build_output_filenames(&input,
499 let resolver = RefCell::new(resolver);
500 abort_on_err(driver::phase_3_run_analysis_passes(&*codegen_backend,
510 |tcx, analysis, _, result| {
512 sess.fatal("Compilation failed, aborting rustdoc");
515 let ty::CrateAnalysis { access_levels, .. } = analysis;
517 // Convert from a NodeId set to a DefId set since we don't always have easy access
518 // to the map from defid -> nodeid
519 let access_levels = AccessLevels {
520 map: access_levels.map.iter()
521 .map(|(&k, &v)| (tcx.hir.local_def_id(k), v))
525 let send_trait = if crate_name == Some("core".to_string()) {
526 clean::path_to_def_local(&tcx, &["marker", "Send"])
528 clean::path_to_def(&tcx, &["core", "marker", "Send"])
531 let mut renderinfo = RenderInfo::default();
532 renderinfo.access_levels = access_levels;
534 let ctxt = DocContext {
538 cstore: cstore.clone(),
539 external_traits: Default::default(),
540 active_extern_traits: Default::default(),
541 renderinfo: RefCell::new(renderinfo),
542 ty_substs: Default::default(),
543 lt_substs: Default::default(),
544 impl_trait_bounds: Default::default(),
545 send_trait: send_trait,
546 fake_def_ids: Default::default(),
547 all_fake_def_ids: Default::default(),
548 generated_synthetics: Default::default(),
549 all_traits: tcx.all_traits(LOCAL_CRATE).to_vec(),
551 debug!("crate: {:?}", tcx.hir.krate());
554 let mut v = RustdocVisitor::new(&ctxt);
555 v.visit(tcx.hir.krate());
559 fn report_deprecated_attr(name: &str, diag: &errors::Handler) {
560 let mut msg = diag.struct_warn(&format!("the `#![doc({})]` attribute is \
561 considered deprecated", name));
562 msg.warn("please see https://github.com/rust-lang/rust/issues/44136");
564 if name == "no_default_passes" {
565 msg.help("you may want to use `#![doc(document_private_items)]`");
571 // Process all of the crate attributes, extracting plugin metadata along
572 // with the passes which we are supposed to run.
573 for attr in krate.module.as_ref().unwrap().attrs.lists("doc") {
574 let diag = ctxt.sess().diagnostic();
576 let name = attr.name().map(|s| s.as_str());
577 let name = name.as_ref().map(|s| &s[..]);
579 if name == Some("no_default_passes") {
580 report_deprecated_attr("no_default_passes", diag);
581 if default_passes == passes::DefaultPassOption::Default {
582 default_passes = passes::DefaultPassOption::None;
585 } else if let Some(value) = attr.value_str() {
586 let sink = match name {
588 report_deprecated_attr("passes = \"...\"", diag);
592 report_deprecated_attr("plugins = \"...\"", diag);
593 eprintln!("WARNING: #![doc(plugins = \"...\")] no longer functions; \
594 see CVE-2018-1000622");
599 for p in value.as_str().split_whitespace() {
600 sink.push(p.to_string());
604 if attr.is_word() && name == Some("document_private_items") {
605 if default_passes == passes::DefaultPassOption::Default {
606 default_passes = passes::DefaultPassOption::Private;
611 let mut passes: Vec<String> =
612 passes::defaults(default_passes).iter().map(|p| p.to_string()).collect();
613 passes.extend(manual_passes);
615 for pass in &passes {
616 // the "unknown pass" error will be reported when late passes are run
617 if let Some(pass) = passes::find_pass(pass).and_then(|p| p.early_fn()) {
618 krate = pass(krate, &ctxt);
622 ctxt.sess().abort_if_errors();
624 (krate, ctxt.renderinfo.into_inner(), passes)