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.
10 pub use self::MaybeTyped::*;
13 use rustc_driver::{driver, target_features, abort_on_err};
14 use rustc::dep_graph::DepGraph;
15 use rustc::session::{self, config};
16 use rustc::hir::def_id::DefId;
17 use rustc::middle::privacy::AccessLevels;
18 use rustc::ty::{self, TyCtxt};
19 use rustc::hir::map as hir_map;
21 use rustc_trans::back::link;
22 use rustc_resolve as resolve;
23 use rustc_metadata::cstore::CStore;
25 use syntax::{ast, codemap};
26 use syntax::feature_gate::UnstableFeatures;
28 use errors::emitter::ColorConfig;
30 use std::cell::{RefCell, Cell};
31 use std::collections::{HashMap, HashSet};
34 use visit_ast::RustdocVisitor;
37 use html::render::RenderInfo;
39 pub use rustc::session::config::Input;
40 pub use rustc::session::search_paths::SearchPaths;
42 /// Are we generating documentation (`Typed`) or tests (`NotTyped`)?
43 pub enum MaybeTyped<'a, 'tcx: 'a> {
44 Typed(TyCtxt<'a, 'tcx, 'tcx>),
45 NotTyped(&'a session::Session)
48 pub type ExternalPaths = HashMap<DefId, (Vec<String>, clean::TypeKind)>;
50 pub struct DocContext<'a, 'tcx: 'a> {
51 pub map: &'a hir_map::Map<'tcx>,
52 pub maybe_typed: MaybeTyped<'a, 'tcx>,
54 pub populated_crate_impls: RefCell<HashSet<ast::CrateNum>>,
55 pub deref_trait_did: Cell<Option<DefId>>,
56 // Note that external items for which `doc(hidden)` applies to are shown as
57 // non-reachable while local items aren't. This is because we're reusing
58 // the access levels from crateanalysis.
59 /// Later on moved into `clean::Crate`
60 pub access_levels: RefCell<AccessLevels<DefId>>,
61 /// Later on moved into `html::render::CACHE_KEY`
62 pub renderinfo: RefCell<RenderInfo>,
63 /// Later on moved through `clean::Crate` into `html::render::CACHE_KEY`
64 pub external_traits: RefCell<HashMap<DefId, clean::Trait>>,
67 impl<'b, 'tcx> DocContext<'b, 'tcx> {
68 pub fn sess<'a>(&'a self) -> &'a session::Session {
69 match self.maybe_typed {
70 Typed(tcx) => &tcx.sess,
71 NotTyped(ref sess) => sess
75 pub fn tcx_opt<'a>(&'a self) -> Option<TyCtxt<'a, 'tcx, 'tcx>> {
76 match self.maybe_typed {
77 Typed(tcx) => Some(tcx),
82 pub fn tcx<'a>(&'a self) -> TyCtxt<'a, 'tcx, 'tcx> {
83 let tcx_opt = self.tcx_opt();
84 tcx_opt.expect("tcx not present")
88 pub trait DocAccessLevels {
89 fn is_doc_reachable(&self, DefId) -> bool;
92 impl DocAccessLevels for AccessLevels<DefId> {
93 fn is_doc_reachable(&self, did: DefId) -> bool {
99 pub fn run_core(search_paths: SearchPaths,
101 externs: config::Externs,
103 triple: Option<String>) -> (clean::Crate, RenderInfo)
105 // Parse, resolve, and typecheck the given crate.
107 let cpath = match input {
108 Input::File(ref p) => Some(p.clone()),
112 let warning_lint = lint::builtin::WARNINGS.name_lower();
114 let sessopts = config::Options {
116 search_paths: search_paths,
117 crate_types: vec!(config::CrateTypeRlib),
118 lint_opts: vec!((warning_lint, lint::Allow)),
119 lint_cap: Some(lint::Allow),
121 target_triple: triple.unwrap_or(config::host_triple().to_string()),
122 // Ensure that rustdoc works even if rustc is feature-staged
123 unstable_features: UnstableFeatures::Allow,
124 ..config::basic_options().clone()
127 let codemap = Rc::new(codemap::CodeMap::new());
128 let diagnostic_handler = errors::Handler::with_tty_emitter(ColorConfig::Auto,
131 Some(codemap.clone()));
133 let dep_graph = DepGraph::new(false);
134 let _ignore = dep_graph.in_ignore();
135 let cstore = Rc::new(CStore::new(&dep_graph));
136 let sess = session::build_session_(sessopts, &dep_graph, cpath, diagnostic_handler,
137 codemap, cstore.clone());
138 rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
140 let mut cfg = config::build_configuration(&sess, config::parse_cfgspecs(cfgs));
141 target_features::add_configuration(&mut cfg, &sess);
143 let krate = panictry!(driver::phase_1_parse_input(&sess, cfg, &input));
145 let name = link::find_crate_name(Some(&sess), &krate.attrs, &input);
147 let driver::ExpansionResult { defs, analysis, resolutions, mut hir_forest, .. } = {
148 driver::phase_2_configure_and_expand(
149 &sess, &cstore, krate, &name, None, resolve::MakeGlobMap::No, |_| Ok(()),
150 ).expect("phase_2_configure_and_expand aborted in rustdoc!")
153 let arenas = ty::CtxtArenas::new();
154 let hir_map = hir_map::map_crate(&mut hir_forest, defs);
156 abort_on_err(driver::phase_3_run_analysis_passes(&sess,
162 |tcx, _, analysis, _, result| {
163 if let Err(_) = result {
164 sess.fatal("Compilation failed, aborting rustdoc");
167 let ty::CrateAnalysis { access_levels, .. } = analysis;
169 // Convert from a NodeId set to a DefId set since we don't always have easy access
170 // to the map from defid -> nodeid
171 let access_levels = AccessLevels {
172 map: access_levels.map.into_iter()
173 .map(|(k, v)| (tcx.map.local_def_id(k), v))
177 let ctxt = DocContext {
179 maybe_typed: Typed(tcx),
181 populated_crate_impls: RefCell::new(HashSet::new()),
182 deref_trait_did: Cell::new(None),
183 access_levels: RefCell::new(access_levels),
184 external_traits: RefCell::new(HashMap::new()),
185 renderinfo: RefCell::new(Default::default()),
187 debug!("crate: {:?}", ctxt.map.krate());
190 let mut v = RustdocVisitor::new(&ctxt);
191 v.visit(ctxt.map.krate());
195 (krate, ctxt.renderinfo.into_inner())