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::{driver, target_features, abort_on_err};
  13 use rustc::session::{self, config};
  14 use rustc::hir::def_id::DefId;
  15 use rustc::hir::def::Def;
  16 use rustc::middle::privacy::AccessLevels;
  17 use rustc::ty::{self, TyCtxt, AllArenas};
  18 use rustc::hir::map as hir_map;
  19 use rustc::lint;
  20 use rustc::util::nodemap::FxHashMap;
  21 use rustc_trans;
  22 use rustc_trans::back::link;
  23 use rustc_resolve as resolve;
  24 use rustc_metadata::cstore::CStore;
  25
  26 use syntax::codemap;
  27 use syntax::feature_gate::UnstableFeatures;
  28 use errors;
  29 use errors::emitter::ColorConfig;
  30
  31 use std::cell::{RefCell, Cell};
  32 use std::mem;
  33 use std::rc::Rc;
  34 use std::path::PathBuf;
  35
  36 use visit_ast::RustdocVisitor;
  37 use clean;
  38 use clean::Clean;
  39 use html::render::RenderInfo;
  40
  41 pub use rustc::session::config::Input;
  42 pub use rustc::session::search_paths::SearchPaths;
  43
  44 pub type ExternalPaths = FxHashMap<DefId, (Vec<String>, clean::TypeKind)>;
  45
  46 pub struct DocContext<'a, 'tcx: 'a> {
  47     pub tcx: TyCtxt<'a, 'tcx, 'tcx>,
  48     pub populated_all_crate_impls: Cell<bool>,
  49     // Note that external items for which `doc(hidden)` applies to are shown as
  50     // non-reachable while local items aren't. This is because we're reusing
  51     // the access levels from crateanalysis.
  52     /// Later on moved into `clean::Crate`
  53     pub access_levels: RefCell<AccessLevels<DefId>>,
  54     /// Later on moved into `html::render::CACHE_KEY`
  55     pub renderinfo: RefCell<RenderInfo>,
  56     /// Later on moved through `clean::Crate` into `html::render::CACHE_KEY`
  57     pub external_traits: RefCell<FxHashMap<DefId, clean::Trait>>,
  58
  59     // The current set of type and lifetime substitutions,
  60     // for expanding type aliases at the HIR level:
  61
  62     /// Table type parameter definition -> substituted type
  63     pub ty_substs: RefCell<FxHashMap<Def, clean::Type>>,
  64     /// Table node id of lifetime parameter definition -> substituted lifetime
  65     pub lt_substs: RefCell<FxHashMap<DefId, clean::Lifetime>>,
  66 }
  67
  68 impl<'a, 'tcx> DocContext<'a, 'tcx> {
  69     pub fn sess(&self) -> &session::Session {
  70         &self.tcx.sess
  71     }
  72
  73     /// Call the closure with the given parameters set as
  74     /// the substitutions for a type alias' RHS.
  75     pub fn enter_alias<F, R>(&self,
  76                              ty_substs: FxHashMap<Def, clean::Type>,
  77                              lt_substs: FxHashMap<DefId, clean::Lifetime>,
  78                              f: F) -> R
  79     where F: FnOnce() -> R {
  80         let (old_tys, old_lts) =
  81             (mem::replace(&mut *self.ty_substs.borrow_mut(), ty_substs),
  82              mem::replace(&mut *self.lt_substs.borrow_mut(), lt_substs));
  83         let r = f();
  84         *self.ty_substs.borrow_mut() = old_tys;
  85         *self.lt_substs.borrow_mut() = old_lts;
  86         r
  87     }
  88 }
  89
  90 pub trait DocAccessLevels {
  91     fn is_doc_reachable(&self, did: DefId) -> bool;
  92 }
  93
  94 impl DocAccessLevels for AccessLevels<DefId> {
  95     fn is_doc_reachable(&self, did: DefId) -> bool {
  96         self.is_public(did)
  97     }
  98 }
  99
 100
 101 pub fn run_core(search_paths: SearchPaths,
 102                 cfgs: Vec<String>,
 103                 externs: config::Externs,
 104                 input: Input,
 105                 triple: Option<String>,
 106                 maybe_sysroot: Option<PathBuf>,
 107                 allow_warnings: bool,
 108                 force_unstable_if_unmarked: bool) -> (clean::Crate, RenderInfo)
 109 {
 110     // Parse, resolve, and typecheck the given crate.
 111
 112     let cpath = match input {
 113         Input::File(ref p) => Some(p.clone()),
 114         _ => None
 115     };
 116
 117     let warning_lint = lint::builtin::WARNINGS.name_lower();
 118
 119     let sessopts = config::Options {
 120         maybe_sysroot,
 121         search_paths,
 122         crate_types: vec![config::CrateTypeRlib],
 123         lint_opts: if !allow_warnings { vec![(warning_lint, lint::Allow)] } else { vec![] },
 124         lint_cap: Some(lint::Allow),
 125         externs,
 126         target_triple: triple.unwrap_or(config::host_triple().to_string()),
 127         // Ensure that rustdoc works even if rustc is feature-staged
 128         unstable_features: UnstableFeatures::Allow,
 129         actually_rustdoc: true,
 130         debugging_opts: config::DebuggingOptions {
 131             force_unstable_if_unmarked,
 132             ..config::basic_debugging_options()
 133         },
 134         ..config::basic_options().clone()
 135     };
 136
 137     let codemap = Rc::new(codemap::CodeMap::new(sessopts.file_path_mapping()));
 138     let diagnostic_handler = errors::Handler::with_tty_emitter(ColorConfig::Auto,
 139                                                                true,
 140                                                                false,
 141                                                                Some(codemap.clone()));
 142
 143     let cstore = Rc::new(CStore::new(box rustc_trans::LlvmMetadataLoader));
 144     let mut sess = session::build_session_(
 145         sessopts, cpath, diagnostic_handler, codemap,
 146     );
 147     rustc_trans::init(&sess);
 148     rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
 149
 150     let mut cfg = config::build_configuration(&sess, config::parse_cfgspecs(cfgs));
 151     target_features::add_configuration(&mut cfg, &sess);
 152     sess.parse_sess.config = cfg;
 153
 154     let control = &driver::CompileController::basic();
 155
 156     let krate = panictry!(driver::phase_1_parse_input(control, &sess, &input));
 157
 158     let name = link::find_crate_name(Some(&sess), &krate.attrs, &input);
 159
 160     let driver::ExpansionResult { defs, analysis, resolutions, mut hir_forest, .. } = {
 161         let result = driver::phase_2_configure_and_expand(&sess,
 162                                                           &cstore,
 163                                                           krate,
 164                                                           None,
 165                                                           &name,
 166                                                           None,
 167                                                           resolve::MakeGlobMap::No,
 168                                                           |_| Ok(()));
 169         abort_on_err(result, &sess)
 170     };
 171
 172     let arenas = AllArenas::new();
 173     let hir_map = hir_map::map_crate(&sess, &*cstore, &mut hir_forest, &defs);
 174     let output_filenames = driver::build_output_filenames(&input,
 175                                                           &None,
 176                                                           &None,
 177                                                           &[],
 178                                                           &sess);
 179
 180     abort_on_err(driver::phase_3_run_analysis_passes(control,
 181                                                      &sess,
 182                                                      &*cstore,
 183                                                      hir_map,
 184                                                      analysis,
 185                                                      resolutions,
 186                                                      &arenas,
 187                                                      &name,
 188                                                      &output_filenames,
 189                                                      |tcx, analysis, _, result| {
 190         if let Err(_) = result {
 191             sess.fatal("Compilation failed, aborting rustdoc");
 192         }
 193
 194         let ty::CrateAnalysis { access_levels, .. } = analysis;
 195
 196         // Convert from a NodeId set to a DefId set since we don't always have easy access
 197         // to the map from defid -> nodeid
 198         let access_levels = AccessLevels {
 199             map: access_levels.map.iter()
 200                                   .map(|(&k, &v)| (tcx.hir.local_def_id(k), v))
 201                                   .collect()
 202         };
 203
 204         let ctxt = DocContext {
 205             tcx,
 206             populated_all_crate_impls: Cell::new(false),
 207             access_levels: RefCell::new(access_levels),
 208             external_traits: Default::default(),
 209             renderinfo: Default::default(),
 210             ty_substs: Default::default(),
 211             lt_substs: Default::default(),
 212         };
 213         debug!("crate: {:?}", tcx.hir.krate());
 214
 215         let krate = {
 216             let mut v = RustdocVisitor::new(&*cstore, &ctxt);
 217             v.visit(tcx.hir.krate());
 218             v.clean(&ctxt)
 219         };
 220
 221         (krate, ctxt.renderinfo.into_inner())
 222     }), &sess)
 223 }