2013-09-12 20:10:51 -05:00
|
|
|
// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
|
|
|
|
// file at the top-level directory of this distribution and at
|
|
|
|
// http://rust-lang.org/COPYRIGHT.
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
|
|
// option. This file may not be copied, modified, or distributed
|
|
|
|
// except according to those terms.
|
|
|
|
|
2013-08-15 15:28:54 -05:00
|
|
|
use rustc;
|
|
|
|
use rustc::{driver, middle};
|
2013-12-25 12:10:33 -06:00
|
|
|
use rustc::metadata::creader::Loader;
|
2013-10-12 16:40:41 -05:00
|
|
|
use rustc::middle::privacy;
|
2014-05-02 18:06:56 -05:00
|
|
|
use rustc::middle::lint;
|
2013-08-15 15:28:54 -05:00
|
|
|
|
|
|
|
use syntax::ast;
|
2014-01-08 12:35:15 -06:00
|
|
|
use syntax::parse::token;
|
2013-08-30 12:55:24 -05:00
|
|
|
use syntax;
|
2013-08-15 15:28:54 -05:00
|
|
|
|
2013-12-21 16:28:04 -06:00
|
|
|
use std::cell::RefCell;
|
2013-08-15 15:28:54 -05:00
|
|
|
use std::os;
|
2014-05-09 15:52:17 -05:00
|
|
|
use collections::{HashSet, HashMap};
|
2013-08-15 15:28:54 -05:00
|
|
|
|
|
|
|
use visit_ast::RustdocVisitor;
|
|
|
|
use clean;
|
|
|
|
use clean::Clean;
|
|
|
|
|
2014-03-05 08:36:01 -06:00
|
|
|
pub enum MaybeTyped {
|
|
|
|
Typed(middle::ty::ctxt),
|
|
|
|
NotTyped(driver::session::Session)
|
|
|
|
}
|
|
|
|
|
2014-05-09 15:52:17 -05:00
|
|
|
pub type ExternalPaths = RefCell<Option<HashMap<ast::DefId,
|
|
|
|
(Vec<~str>, clean::TypeKind)>>>;
|
|
|
|
|
2013-08-15 15:28:54 -05:00
|
|
|
pub struct DocContext {
|
2014-03-28 12:27:24 -05:00
|
|
|
pub krate: ast::Crate,
|
2014-05-02 18:15:12 -05:00
|
|
|
pub maybe_typed: MaybeTyped,
|
|
|
|
pub src: Path,
|
2014-05-09 15:52:17 -05:00
|
|
|
pub external_paths: ExternalPaths,
|
2014-03-05 08:36:01 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
impl DocContext {
|
|
|
|
pub fn sess<'a>(&'a self) -> &'a driver::session::Session {
|
|
|
|
match self.maybe_typed {
|
|
|
|
Typed(ref tcx) => &tcx.sess,
|
|
|
|
NotTyped(ref sess) => sess
|
|
|
|
}
|
|
|
|
}
|
2013-08-15 15:28:54 -05:00
|
|
|
}
|
|
|
|
|
2013-10-12 16:40:41 -05:00
|
|
|
pub struct CrateAnalysis {
|
2014-03-28 12:27:24 -05:00
|
|
|
pub exported_items: privacy::ExportedItems,
|
|
|
|
pub public_items: privacy::PublicItems,
|
2014-05-09 15:52:17 -05:00
|
|
|
pub external_paths: ExternalPaths,
|
2013-10-12 16:40:41 -05:00
|
|
|
}
|
|
|
|
|
2013-08-15 15:28:54 -05:00
|
|
|
/// Parses, resolves, and typechecks the given crate
|
2014-03-05 17:28:08 -06:00
|
|
|
fn get_ast_and_resolve(cpath: &Path, libs: HashSet<Path>, cfgs: Vec<~str>)
|
|
|
|
-> (DocContext, CrateAnalysis) {
|
2013-08-15 15:28:54 -05:00
|
|
|
use syntax::codemap::dummy_spanned;
|
2014-01-13 10:31:05 -06:00
|
|
|
use rustc::driver::driver::{FileInput, build_configuration,
|
2013-10-12 16:40:41 -05:00
|
|
|
phase_1_parse_input,
|
|
|
|
phase_2_configure_and_expand,
|
|
|
|
phase_3_run_analysis_passes};
|
2013-08-15 15:28:54 -05:00
|
|
|
|
2014-01-13 10:31:05 -06:00
|
|
|
let input = FileInput(cpath.clone());
|
2013-08-15 15:28:54 -05:00
|
|
|
|
2014-03-17 02:55:41 -05:00
|
|
|
let sessopts = driver::session::Options {
|
2014-03-09 07:24:58 -05:00
|
|
|
maybe_sysroot: Some(os::self_exe_path().unwrap().dir_path()),
|
|
|
|
addl_lib_search_paths: RefCell::new(libs),
|
2014-03-05 13:04:36 -06:00
|
|
|
crate_types: vec!(driver::session::CrateTypeDylib),
|
2014-05-02 18:06:56 -05:00
|
|
|
lint_opts: vec!((lint::Warnings, lint::allow)),
|
2014-03-17 02:55:41 -05:00
|
|
|
..rustc::driver::session::basic_options().clone()
|
2013-08-15 15:28:54 -05:00
|
|
|
};
|
|
|
|
|
|
|
|
|
2014-03-17 02:55:41 -05:00
|
|
|
let codemap = syntax::codemap::CodeMap::new();
|
2014-02-28 14:33:49 -06:00
|
|
|
let diagnostic_handler = syntax::diagnostic::default_handler();
|
2013-08-15 15:28:54 -05:00
|
|
|
let span_diagnostic_handler =
|
2014-03-17 02:55:41 -05:00
|
|
|
syntax::diagnostic::mk_span_handler(diagnostic_handler, codemap);
|
2013-08-15 15:28:54 -05:00
|
|
|
|
2013-08-30 12:55:24 -05:00
|
|
|
let sess = driver::driver::build_session_(sessopts,
|
2014-01-27 07:58:40 -06:00
|
|
|
Some(cpath.clone()),
|
2013-08-30 12:55:24 -05:00
|
|
|
span_diagnostic_handler);
|
2013-08-15 15:28:54 -05:00
|
|
|
|
2014-03-05 08:36:01 -06:00
|
|
|
let mut cfg = build_configuration(&sess);
|
2013-11-24 22:31:21 -06:00
|
|
|
for cfg_ in cfgs.move_iter() {
|
2014-01-08 12:35:15 -06:00
|
|
|
let cfg_ = token::intern_and_get_ident(cfg_);
|
|
|
|
cfg.push(@dummy_spanned(ast::MetaWord(cfg_)));
|
2013-11-24 22:31:21 -06:00
|
|
|
}
|
2013-08-15 15:28:54 -05:00
|
|
|
|
2014-03-05 08:36:01 -06:00
|
|
|
let krate = phase_1_parse_input(&sess, cfg, &input);
|
2014-03-17 02:55:41 -05:00
|
|
|
let (krate, ast_map) = phase_2_configure_and_expand(&sess, &mut Loader::new(&sess),
|
2014-03-05 08:36:01 -06:00
|
|
|
krate, &from_str("rustdoc").unwrap());
|
2013-10-12 16:40:41 -05:00
|
|
|
let driver::driver::CrateAnalysis {
|
2014-01-07 20:46:16 -06:00
|
|
|
exported_items, public_items, ty_cx, ..
|
2014-02-05 15:15:24 -06:00
|
|
|
} = phase_3_run_analysis_passes(sess, &krate, ast_map);
|
2013-10-12 16:40:41 -05:00
|
|
|
|
2014-02-05 15:15:24 -06:00
|
|
|
debug!("crate: {:?}", krate);
|
2014-03-05 08:36:01 -06:00
|
|
|
(DocContext {
|
|
|
|
krate: krate,
|
2014-05-02 18:15:12 -05:00
|
|
|
maybe_typed: Typed(ty_cx),
|
|
|
|
src: cpath.clone(),
|
2014-05-09 15:52:17 -05:00
|
|
|
external_paths: RefCell::new(Some(HashMap::new())),
|
2014-03-05 08:36:01 -06:00
|
|
|
}, CrateAnalysis {
|
|
|
|
exported_items: exported_items,
|
|
|
|
public_items: public_items,
|
2014-05-09 15:52:17 -05:00
|
|
|
external_paths: RefCell::new(None),
|
2014-03-05 08:36:01 -06:00
|
|
|
})
|
2013-08-15 15:28:54 -05:00
|
|
|
}
|
|
|
|
|
2014-03-05 17:28:08 -06:00
|
|
|
pub fn run_core(libs: HashSet<Path>, cfgs: Vec<~str>, path: &Path)
|
|
|
|
-> (clean::Crate, CrateAnalysis) {
|
2013-11-24 22:31:21 -06:00
|
|
|
let (ctxt, analysis) = get_ast_and_resolve(path, libs, cfgs);
|
2013-10-12 16:40:41 -05:00
|
|
|
let ctxt = @ctxt;
|
2014-04-28 22:36:08 -05:00
|
|
|
super::ctxtkey.replace(Some(ctxt));
|
2013-08-15 15:28:54 -05:00
|
|
|
|
2014-02-05 15:15:24 -06:00
|
|
|
let krate = {
|
2014-01-07 20:46:16 -06:00
|
|
|
let mut v = RustdocVisitor::new(ctxt, Some(&analysis));
|
2014-02-05 15:15:24 -06:00
|
|
|
v.visit(&ctxt.krate);
|
2014-01-07 20:46:16 -06:00
|
|
|
v.clean()
|
|
|
|
};
|
2013-08-15 15:28:54 -05:00
|
|
|
|
2014-05-09 15:52:17 -05:00
|
|
|
let external_paths = ctxt.external_paths.borrow_mut().take();
|
|
|
|
*analysis.external_paths.borrow_mut() = external_paths;
|
2014-02-05 15:15:24 -06:00
|
|
|
(krate, analysis)
|
2013-08-15 15:28:54 -05:00
|
|
|
}
|