]> git.lizzy.rs Git - rust.git/blob - src/librustdoc/core.rs
Add lint for doc without codeblocks
[rust.git] / src / librustdoc / core.rs
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.
4 //
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.
10
11 use rustc_lint;
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;
28
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;
34 use syntax::ptr::P;
35 use syntax::symbol::keywords;
36 use syntax_pos::DUMMY_SP;
37 use errors;
38 use errors::emitter::{Emitter, EmitterWriter};
39 use parking_lot::ReentrantMutex;
40
41 use std::cell::RefCell;
42 use std::mem;
43 use rustc_data_structures::sync::{self, Lrc};
44 use std::rc::Rc;
45 use std::sync::Arc;
46 use std::path::PathBuf;
47
48 use visit_ast::RustdocVisitor;
49 use clean;
50 use clean::{get_path_for_type, Clean, MAX_DEF_ID, AttributesExt};
51 use html::render::RenderInfo;
52 use passes;
53
54 pub use rustc::session::config::{Input, Options, CodegenOptions};
55 pub use rustc::session::search_paths::SearchPaths;
56
57 pub type ExternalPaths = FxHashMap<DefId, (Vec<String>, clean::TypeKind)>;
58
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
73     /// the same time.
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:
77
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>,
90 }
91
92 impl<'a, 'tcx, 'rcx, 'cstore> DocContext<'a, 'tcx, 'rcx, 'cstore> {
93     pub fn sess(&self) -> &session::Session {
94         &self.tcx.sess
95     }
96
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>,
102                              f: F) -> R
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));
107         let r = f();
108         *self.ty_substs.borrow_mut() = old_tys;
109         *self.lt_substs.borrow_mut() = old_lts;
110         r
111     }
112
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.
117     //
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 {
122         let start_def_id = {
123             let next_id = if crate_num == LOCAL_CRATE {
124                 self.tcx
125                     .hir
126                     .definitions()
127                     .def_path_table()
128                     .next_id(DefIndexAddressSpace::Low)
129             } else {
130                 self.cstore
131                     .def_path_table(crate_num)
132                     .next_id(DefIndexAddressSpace::Low)
133             };
134
135             DefId {
136                 krate: crate_num,
137                 index: next_id,
138             }
139         };
140
141         let mut fake_ids = self.fake_def_ids.borrow_mut();
142
143         let def_id = fake_ids.entry(crate_num).or_insert(start_def_id).clone();
144         fake_ids.insert(
145             crate_num,
146             DefId {
147                 krate: crate_num,
148                 index: DefIndex::from_array_index(
149                     def_id.index.as_array_index() + 1,
150                     def_id.index.address_space(),
151                 ),
152             },
153         );
154
155         MAX_DEF_ID.with(|m| {
156             m.borrow_mut()
157                 .entry(def_id.krate.clone())
158                 .or_insert(start_def_id);
159         });
160
161         self.all_fake_def_ids.borrow_mut().insert(def_id);
162
163         def_id.clone()
164     }
165
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) {
170             None
171         } else {
172             self.tcx.hir.as_local_node_id(def_id)
173         }
174     }
175
176     pub fn get_real_ty<F>(&self,
177                           def_id: DefId,
178                           def_ctor: &F,
179                           real_name: &Option<Ident>,
180                           generics: &ty::Generics,
181     ) -> hir::Ty
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");
186
187         segments.push(hir::PathSegment::new(
188             real_name.unwrap_or(last.ident),
189             self.generics_to_path_params(generics.clone()),
190             false,
191         ));
192
193         let new_path = hir::Path {
194             span: path.span,
195             def: path.def,
196             segments: HirVec::from_vec(segments),
197         };
198
199         hir::Ty {
200             id: ast::DUMMY_NODE_ID,
201             node: hir::TyKind::Path(hir::QPath::Resolved(None, P(new_path))),
202             span: DUMMY_SP,
203             hir_id: hir::DUMMY_HIR_ID,
204         }
205     }
206
207     pub fn generics_to_path_params(&self, generics: ty::Generics) -> hir::GenericArgs {
208         let mut args = vec![];
209
210         for param in generics.params.iter() {
211             match param.kind {
212                 ty::GenericParamDefKind::Lifetime => {
213                     let name = if param.name == "" {
214                         hir::ParamName::Plain(keywords::StaticLifetime.ident())
215                     } else {
216                         hir::ParamName::Plain(ast::Ident::from_interned_str(param.name))
217                     };
218
219                     args.push(hir::GenericArg::Lifetime(hir::Lifetime {
220                         id: ast::DUMMY_NODE_ID,
221                         span: DUMMY_SP,
222                         name: hir::LifetimeName::Param(name),
223                     }));
224                 }
225                 ty::GenericParamDefKind::Type {..} => {
226                     args.push(hir::GenericArg::Type(self.ty_param_to_ty(param.clone())));
227                 }
228             }
229         }
230
231         hir::GenericArgs {
232             args: HirVec::from_vec(args),
233             bindings: HirVec::new(),
234             parenthesized: false,
235         }
236     }
237
238     pub fn ty_param_to_ty(&self, param: ty::GenericParamDef) -> hir::Ty {
239         debug!("ty_param_to_ty({:?}) {:?}", param, param.def_id);
240         hir::Ty {
241             id: ast::DUMMY_NODE_ID,
242             node: hir::TyKind::Path(hir::QPath::Resolved(
243                 None,
244                 P(hir::Path {
245                     span: DUMMY_SP,
246                     def: Def::TyParam(param.def_id),
247                     segments: HirVec::from_vec(vec![
248                         hir::PathSegment::from_ident(Ident::from_interned_str(param.name))
249                     ]),
250                 }),
251             )),
252             span: DUMMY_SP,
253             hir_id: hir::DUMMY_HIR_ID,
254         }
255     }
256 }
257
258 pub trait DocAccessLevels {
259     fn is_doc_reachable(&self, did: DefId) -> bool;
260 }
261
262 impl DocAccessLevels for AccessLevels<DefId> {
263     fn is_doc_reachable(&self, did: DefId) -> bool {
264         self.is_public(did)
265     }
266 }
267
268 /// Creates a new diagnostic `Handler` that can be used to emit warnings and errors.
269 ///
270 /// If the given `error_format` is `ErrorOutputType::Json` and no `SourceMap` is given, a new one
271 /// will be created for the handler.
272 pub fn new_handler(error_format: ErrorOutputType,
273                    source_map: Option<Lrc<source_map::SourceMap>>,
274                    treat_err_as_bug: bool,
275                    ui_testing: bool,
276 ) -> errors::Handler {
277     // rustdoc doesn't override (or allow to override) anything from this that is relevant here, so
278     // stick to the defaults
279     let sessopts = Options::default();
280     let emitter: Box<dyn Emitter + sync::Send> = match error_format {
281         ErrorOutputType::HumanReadable(color_config) => Box::new(
282             EmitterWriter::stderr(
283                 color_config,
284                 source_map.map(|cm| cm as _),
285                 false,
286                 sessopts.debugging_opts.teach,
287             ).ui_testing(ui_testing)
288         ),
289         ErrorOutputType::Json(pretty) => {
290             let source_map = source_map.unwrap_or_else(
291                 || Lrc::new(source_map::SourceMap::new(sessopts.file_path_mapping())));
292             Box::new(
293                 JsonEmitter::stderr(
294                     None,
295                     source_map,
296                     pretty,
297                 ).ui_testing(ui_testing)
298             )
299         },
300         ErrorOutputType::Short(color_config) => Box::new(
301             EmitterWriter::stderr(
302                 color_config,
303                 source_map.map(|cm| cm as _),
304                 true,
305                 false)
306         ),
307     };
308
309     errors::Handler::with_emitter_and_flags(
310         emitter,
311         errors::HandlerFlags {
312             can_emit_warnings: true,
313             treat_err_as_bug,
314             report_delayed_bugs: false,
315             external_macro_backtrace: false,
316             ..Default::default()
317         },
318     )
319 }
320
321 pub fn run_core(search_paths: SearchPaths,
322                 cfgs: Vec<String>,
323                 externs: config::Externs,
324                 input: Input,
325                 triple: Option<TargetTriple>,
326                 maybe_sysroot: Option<PathBuf>,
327                 allow_warnings: bool,
328                 crate_name: Option<String>,
329                 force_unstable_if_unmarked: bool,
330                 edition: Edition,
331                 cg: CodegenOptions,
332                 error_format: ErrorOutputType,
333                 cmd_lints: Vec<(String, lint::Level)>,
334                 lint_cap: Option<lint::Level>,
335                 describe_lints: bool,
336                 mut manual_passes: Vec<String>,
337                 mut default_passes: passes::DefaultPassOption,
338                 treat_err_as_bug: bool,
339                 ui_testing: bool,
340 ) -> (clean::Crate, RenderInfo, Vec<String>) {
341     // Parse, resolve, and typecheck the given crate.
342
343     let cpath = match input {
344         Input::File(ref p) => Some(p.clone()),
345         _ => None
346     };
347
348     let intra_link_resolution_failure_name = lint::builtin::INTRA_DOC_LINK_RESOLUTION_FAILURE.name;
349     let warnings_lint_name = lint::builtin::WARNINGS.name;
350     let missing_docs = rustc_lint::builtin::MISSING_DOCS.name;
351     let missing_doc_example = rustc_lint::builtin::MISSING_DOC_ITEM_CODE_EXAMPLE.name;
352
353     // In addition to those specific lints, we also need to whitelist those given through
354     // command line, otherwise they'll get ignored and we don't want that.
355     let mut whitelisted_lints = vec![warnings_lint_name.to_owned(),
356                                      intra_link_resolution_failure_name.to_owned(),
357                                      missing_docs.to_owned(),
358                                      missing_doc_example.to_owned()];
359
360     whitelisted_lints.extend(cmd_lints.iter().map(|(lint, _)| lint).cloned());
361
362     let lints = lint::builtin::HardwiredLints.get_lints()
363                     .into_iter()
364                     .chain(rustc_lint::SoftLints.get_lints().into_iter())
365                     .filter_map(|lint| {
366                         if lint.name == warnings_lint_name ||
367                            lint.name == intra_link_resolution_failure_name {
368                             None
369                         } else {
370                             Some((lint.name_lower(), lint::Allow))
371                         }
372                     })
373                     .chain(cmd_lints.into_iter())
374                     .collect::<Vec<_>>();
375
376     let host_triple = TargetTriple::from_triple(config::host_triple());
377     // plays with error output here!
378     let sessopts = config::Options {
379         maybe_sysroot,
380         search_paths,
381         crate_types: vec![config::CrateType::Rlib],
382         lint_opts: if !allow_warnings {
383             lints
384         } else {
385             vec![]
386         },
387         lint_cap: Some(lint_cap.unwrap_or_else(|| lint::Forbid)),
388         cg,
389         externs,
390         target_triple: triple.unwrap_or(host_triple),
391         // Ensure that rustdoc works even if rustc is feature-staged
392         unstable_features: UnstableFeatures::Allow,
393         actually_rustdoc: true,
394         debugging_opts: config::DebuggingOptions {
395             force_unstable_if_unmarked,
396             treat_err_as_bug,
397             ui_testing,
398             ..config::basic_debugging_options()
399         },
400         error_format,
401         edition,
402         describe_lints,
403         ..Options::default()
404     };
405     driver::spawn_thread_pool(sessopts, move |sessopts| {
406         let source_map = Lrc::new(source_map::SourceMap::new(sessopts.file_path_mapping()));
407         let diagnostic_handler = new_handler(error_format,
408                                              Some(source_map.clone()),
409                                              treat_err_as_bug,
410                                              ui_testing);
411
412         let mut sess = session::build_session_(
413             sessopts, cpath, diagnostic_handler, source_map,
414         );
415
416         lint::builtin::HardwiredLints.get_lints()
417                                      .into_iter()
418                                      .chain(rustc_lint::SoftLints.get_lints().into_iter())
419                                      .filter_map(|lint| {
420                                          // We don't want to whitelist *all* lints so let's
421                                          // ignore those ones.
422                                          if whitelisted_lints.iter().any(|l| &lint.name == l) {
423                                              None
424                                          } else {
425                                              Some(lint)
426                                          }
427                                      })
428                                      .for_each(|l| {
429                                          sess.driver_lint_caps.insert(lint::LintId::of(l),
430                                                                       lint::Allow);
431                                      });
432
433         let codegen_backend = rustc_driver::get_codegen_backend(&sess);
434         let cstore = Rc::new(CStore::new(codegen_backend.metadata_loader()));
435         rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
436
437         let mut cfg = config::build_configuration(&sess, config::parse_cfgspecs(cfgs));
438         target_features::add_configuration(&mut cfg, &sess, &*codegen_backend);
439         sess.parse_sess.config = cfg;
440
441         let control = &driver::CompileController::basic();
442
443         let krate = panictry!(driver::phase_1_parse_input(control, &sess, &input));
444
445         let name = match crate_name {
446             Some(ref crate_name) => crate_name.clone(),
447             None => ::rustc_codegen_utils::link::find_crate_name(Some(&sess), &krate.attrs, &input),
448         };
449
450         let mut crate_loader = CrateLoader::new(&sess, &cstore, &name);
451
452         let resolver_arenas = resolve::Resolver::arenas();
453         let result = driver::phase_2_configure_and_expand_inner(&sess,
454                                                         &cstore,
455                                                         krate,
456                                                         None,
457                                                         &name,
458                                                         None,
459                                                         resolve::MakeGlobMap::No,
460                                                         &resolver_arenas,
461                                                         &mut crate_loader,
462                                                         |_| Ok(()));
463         let driver::InnerExpansionResult {
464             mut hir_forest,
465             resolver,
466             ..
467         } = abort_on_err(result, &sess);
468
469         // We need to hold on to the complete resolver, so we clone everything
470         // for the analysis passes to use. Suboptimal, but necessary in the
471         // current architecture.
472         let defs = resolver.definitions.clone();
473         let resolutions = ty::Resolutions {
474             freevars: resolver.freevars.clone(),
475             export_map: resolver.export_map.clone(),
476             trait_map: resolver.trait_map.clone(),
477             maybe_unused_trait_imports: resolver.maybe_unused_trait_imports.clone(),
478             maybe_unused_extern_crates: resolver.maybe_unused_extern_crates.clone(),
479         };
480         let analysis = ty::CrateAnalysis {
481             access_levels: Lrc::new(AccessLevels::default()),
482             name: name.to_string(),
483             glob_map: if resolver.make_glob_map { Some(resolver.glob_map.clone()) } else { None },
484         };
485
486         let arenas = AllArenas::new();
487         let hir_map = hir_map::map_crate(&sess, &*cstore, &mut hir_forest, &defs);
488         let output_filenames = driver::build_output_filenames(&input,
489                                                             &None,
490                                                             &None,
491                                                             &[],
492                                                             &sess);
493
494         let resolver = RefCell::new(resolver);
495         abort_on_err(driver::phase_3_run_analysis_passes(&*codegen_backend,
496                                                         control,
497                                                         &sess,
498                                                         &*cstore,
499                                                         hir_map,
500                                                         analysis,
501                                                         resolutions,
502                                                         &arenas,
503                                                         &name,
504                                                         &output_filenames,
505                                                         |tcx, analysis, _, result| {
506             if result.is_err() {
507                 sess.fatal("Compilation failed, aborting rustdoc");
508             }
509
510             let ty::CrateAnalysis { access_levels, .. } = analysis;
511
512             // Convert from a NodeId set to a DefId set since we don't always have easy access
513             // to the map from defid -> nodeid
514             let access_levels = AccessLevels {
515                 map: access_levels.map.iter()
516                                     .map(|(&k, &v)| (tcx.hir.local_def_id(k), v))
517                                     .collect()
518             };
519
520             let send_trait = if crate_name == Some("core".to_string()) {
521                 clean::path_to_def_local(&tcx, &["marker", "Send"])
522             } else {
523                 clean::path_to_def(&tcx, &["core", "marker", "Send"])
524             };
525
526             let mut renderinfo = RenderInfo::default();
527             renderinfo.access_levels = access_levels;
528
529             let ctxt = DocContext {
530                 tcx,
531                 resolver: &resolver,
532                 crate_name,
533                 cstore: cstore.clone(),
534                 external_traits: Default::default(),
535                 active_extern_traits: Default::default(),
536                 renderinfo: RefCell::new(renderinfo),
537                 ty_substs: Default::default(),
538                 lt_substs: Default::default(),
539                 impl_trait_bounds: Default::default(),
540                 send_trait: send_trait,
541                 fake_def_ids: RefCell::new(FxHashMap()),
542                 all_fake_def_ids: RefCell::new(FxHashSet()),
543                 generated_synthetics: RefCell::new(FxHashSet()),
544                 all_traits: tcx.all_traits(LOCAL_CRATE).to_vec(),
545             };
546             debug!("crate: {:?}", tcx.hir.krate());
547
548             let mut krate = {
549                 let mut v = RustdocVisitor::new(&ctxt);
550                 v.visit(tcx.hir.krate());
551                 v.clean(&ctxt)
552             };
553
554             fn report_deprecated_attr(name: &str, diag: &errors::Handler) {
555                 let mut msg = diag.struct_warn(&format!("the `#![doc({})]` attribute is \
556                                                          considered deprecated", name));
557                 msg.warn("please see https://github.com/rust-lang/rust/issues/44136");
558
559                 if name == "no_default_passes" {
560                     msg.help("you may want to use `#![doc(document_private_items)]`");
561                 }
562
563                 msg.emit();
564             }
565
566             // Process all of the crate attributes, extracting plugin metadata along
567             // with the passes which we are supposed to run.
568             for attr in krate.module.as_ref().unwrap().attrs.lists("doc") {
569                 let diag = ctxt.sess().diagnostic();
570
571                 let name = attr.name().map(|s| s.as_str());
572                 let name = name.as_ref().map(|s| &s[..]);
573                 if attr.is_word() {
574                     if name == Some("no_default_passes") {
575                         report_deprecated_attr("no_default_passes", diag);
576                         if default_passes == passes::DefaultPassOption::Default {
577                             default_passes = passes::DefaultPassOption::None;
578                         }
579                     }
580                 } else if let Some(value) = attr.value_str() {
581                     let sink = match name {
582                         Some("passes") => {
583                             report_deprecated_attr("passes = \"...\"", diag);
584                             &mut manual_passes
585                         },
586                         Some("plugins") => {
587                             report_deprecated_attr("plugins = \"...\"", diag);
588                             eprintln!("WARNING: #![doc(plugins = \"...\")] no longer functions; \
589                                       see CVE-2018-1000622");
590                             continue
591                         },
592                         _ => continue,
593                     };
594                     for p in value.as_str().split_whitespace() {
595                         sink.push(p.to_string());
596                     }
597                 }
598
599                 if attr.is_word() && name == Some("document_private_items") {
600                     if default_passes == passes::DefaultPassOption::Default {
601                         default_passes = passes::DefaultPassOption::Private;
602                     }
603                 }
604             }
605
606             let mut passes: Vec<String> =
607                 passes::defaults(default_passes).iter().map(|p| p.to_string()).collect();
608             passes.extend(manual_passes);
609
610             for pass in &passes {
611                 // the "unknown pass" error will be reported when late passes are run
612                 if let Some(pass) = passes::find_pass(pass).and_then(|p| p.early_fn()) {
613                     krate = pass(krate, &ctxt);
614                 }
615             }
616
617             ctxt.sess().abort_if_errors();
618
619             (krate, ctxt.renderinfo.into_inner(), passes)
620         }), &sess)
621     })
622 }