-//! This module analyzes provided crates to find examples of uses for items in the
-//! current crate being documented.
+//! This module analyzes crates to find call sites that can serve as examples in the documentation.
+
+use crate::clean;
+use crate::config;
+use crate::formats;
+use crate::formats::renderer::FormatRenderer;
+use crate::html::render::Context;
-use rayon::prelude::*;
use rustc_data_structures::fx::FxHashMap;
use rustc_hir::{
self as hir,
intravisit::{self, Visitor},
};
use rustc_interface::interface;
+use rustc_macros::{Decodable, Encodable};
use rustc_middle::hir::map::Map;
use rustc_middle::ty::{self, TyCtxt};
-use rustc_span::symbol::Symbol;
+use rustc_serialize::{
+ opaque::{Decoder, FileEncoder},
+ Decodable, Encodable,
+};
+use rustc_session::getopts;
+use rustc_span::{
+ def_id::{CrateNum, DefPathHash, LOCAL_CRATE},
+ edition::Edition,
+ BytePos, FileName, SourceFile,
+};
+
+use std::fs;
+use std::path::PathBuf;
+
+#[derive(Debug, Clone)]
+crate struct ScrapeExamplesOptions {
+ output_path: PathBuf,
+ target_crates: Vec<String>,
+}
+
+impl ScrapeExamplesOptions {
+ crate fn new(
+ matches: &getopts::Matches,
+ diag: &rustc_errors::Handler,
+ ) -> Result<Option<Self>, i32> {
+ let output_path = matches.opt_str("scrape-examples-output-path");
+ let target_crates = matches.opt_strs("scrape-examples-target-crate");
+ match (output_path, !target_crates.is_empty()) {
+ (Some(output_path), true) => Ok(Some(ScrapeExamplesOptions {
+ output_path: PathBuf::from(output_path),
+ target_crates,
+ })),
+ (Some(_), false) | (None, true) => {
+ diag.err("must use --scrape-examples-output-path and --scrape-examples-target-crate together");
+ Err(1)
+ }
+ (None, false) => Ok(None),
+ }
+ }
+}
+
+#[derive(Encodable, Decodable, Debug, Clone)]
+crate struct SyntaxRange {
+ crate byte_span: (u32, u32),
+ crate line_span: (usize, usize),
+}
+
+impl SyntaxRange {
+ fn new(span: rustc_span::Span, file: &SourceFile) -> Self {
+ let get_pos = |bytepos: BytePos| file.original_relative_byte_pos(bytepos).0;
+ let get_line = |bytepos: BytePos| file.lookup_line(bytepos).unwrap();
+
+ SyntaxRange {
+ byte_span: (get_pos(span.lo()), get_pos(span.hi())),
+ line_span: (get_line(span.lo()), get_line(span.hi())),
+ }
+ }
+}
+
+#[derive(Encodable, Decodable, Debug, Clone)]
+crate struct CallLocation {
+ crate call_expr: SyntaxRange,
+ crate enclosing_item: SyntaxRange,
+}
-crate type FnCallLocations = FxHashMap<String, Vec<(usize, usize)>>;
-crate type AllCallLocations = FxHashMap<String, FnCallLocations>;
+impl CallLocation {
+ fn new(
+ expr_span: rustc_span::Span,
+ enclosing_item_span: rustc_span::Span,
+ source_file: &SourceFile,
+ ) -> Self {
+ CallLocation {
+ call_expr: SyntaxRange::new(expr_span, source_file),
+ enclosing_item: SyntaxRange::new(enclosing_item_span, source_file),
+ }
+ }
+}
+
+#[derive(Encodable, Decodable, Debug, Clone)]
+crate struct CallData {
+ crate locations: Vec<CallLocation>,
+ crate url: String,
+ crate display_name: String,
+ crate edition: Edition,
+}
+
+crate type FnCallLocations = FxHashMap<PathBuf, CallData>;
+crate type AllCallLocations = FxHashMap<DefPathHash, FnCallLocations>;
/// Visitor for traversing a crate and finding instances of function calls.
struct FindCalls<'a, 'tcx> {
tcx: TyCtxt<'tcx>,
map: Map<'tcx>,
-
- /// Workspace-relative path to the root of the crate. Used to remember
- /// which example a particular call came from.
- file_name: String,
-
- /// Name of the crate being documented, to filter out calls to irrelevant
- /// functions.
- krate: Symbol,
-
- /// Data structure to accumulate call sites across all examples.
+ cx: Context<'tcx>,
+ target_crates: Vec<CrateNum>,
calls: &'a mut AllCallLocations,
}
fn visit_expr(&mut self, ex: &'tcx hir::Expr<'tcx>) {
intravisit::walk_expr(self, ex);
+ let tcx = self.tcx;
+
+ // If we visit an item that contains an expression outside a function body,
+ // then we need to exit before calling typeck (which will panic). See
+ // test/run-make/rustdoc-scrape-examples-invalid-expr for an example.
+ let hir = tcx.hir();
+ let owner = hir.local_def_id_to_hir_id(ex.hir_id.owner);
+ if hir.maybe_body_owned_by(owner).is_none() {
+ return;
+ }
+
// Get type of function if expression is a function call
- let types = self.tcx.typeck(ex.hir_id.owner);
let (ty, span) = match ex.kind {
- hir::ExprKind::Call(f, _) => (types.node_type(f.hir_id), ex.span),
+ hir::ExprKind::Call(f, _) => {
+ let types = tcx.typeck(ex.hir_id.owner);
+
+ if let Some(ty) = types.node_type_opt(f.hir_id) {
+ (ty, ex.span)
+ } else {
+ trace!("node_type_opt({}) = None", f.hir_id);
+ return;
+ }
+ }
hir::ExprKind::MethodCall(_, _, _, span) => {
- let types = self.tcx.typeck(ex.hir_id.owner);
- let def_id = types.type_dependent_def_id(ex.hir_id).unwrap();
- (self.tcx.type_of(def_id), span)
+ let types = tcx.typeck(ex.hir_id.owner);
+ let def_id = if let Some(def_id) = types.type_dependent_def_id(ex.hir_id) {
+ def_id
+ } else {
+ trace!("type_dependent_def_id({}) = None", ex.hir_id);
+ return;
+ };
+ (tcx.type_of(def_id), span)
}
_ => {
return;
}
};
- // Save call site if the function resovles to a concrete definition
+ // If this span comes from a macro expansion, then the source code may not actually show
+ // a use of the given item, so it would be a poor example. Hence, we skip all uses in macros.
+ if span.from_expansion() {
+ trace!("Rejecting expr from macro: {:?}", span);
+ return;
+ }
+
+ // If the enclosing item has a span coming from a proc macro, then we also don't want to include
+ // the example.
+ let enclosing_item_span = tcx.hir().span_with_body(tcx.hir().get_parent_item(ex.hir_id));
+ if enclosing_item_span.from_expansion() {
+ trace!("Rejecting expr ({:?}) from macro item: {:?}", span, enclosing_item_span);
+ return;
+ }
+
+ assert!(
+ enclosing_item_span.contains(span),
+ "Attempted to scrape call at [{:?}] whose enclosing item [{:?}] doesn't contain the span of the call.",
+ span,
+ enclosing_item_span
+ );
+
+ // Save call site if the function resolves to a concrete definition
if let ty::FnDef(def_id, _) = ty.kind() {
- if self.tcx.crate_name(def_id.krate) == self.krate {
- let key = self.tcx.def_path(*def_id).to_string_no_crate_verbose();
- let entries = self.calls.entry(key).or_insert_with(FxHashMap::default);
- entries
- .entry(self.file_name.clone())
- .or_insert_with(Vec::new)
- .push((span.lo().0 as usize, span.hi().0 as usize));
+ if self.target_crates.iter().all(|krate| *krate != def_id.krate) {
+ trace!("Rejecting expr from crate not being documented: {:?}", span);
+ return;
+ }
+
+ let file = tcx.sess.source_map().lookup_char_pos(span.lo()).file;
+ let file_path = match file.name.clone() {
+ FileName::Real(real_filename) => real_filename.into_local_path(),
+ _ => None,
+ };
+
+ if let Some(file_path) = file_path {
+ let abs_path = fs::canonicalize(file_path.clone()).unwrap();
+ let cx = &self.cx;
+ let mk_call_data = || {
+ let clean_span = crate::clean::types::Span::new(span);
+ let url = cx.href_from_span(clean_span, false).unwrap();
+ let display_name = file_path.display().to_string();
+ let edition = span.edition();
+ CallData { locations: Vec::new(), url, display_name, edition }
+ };
+
+ let fn_key = tcx.def_path_hash(*def_id);
+ let fn_entries = self.calls.entry(fn_key).or_default();
+
+ trace!("Including expr: {:?}", span);
+ let location = CallLocation::new(span, enclosing_item_span, &file);
+ fn_entries.entry(abs_path).or_insert_with(mk_call_data).locations.push(location);
}
}
}
}
-struct Callbacks {
- calls: AllCallLocations,
- krate: String,
- file_name: String,
-}
+crate fn run(
+ krate: clean::Crate,
+ renderopts: config::RenderOptions,
+ cache: formats::cache::Cache,
+ tcx: TyCtxt<'_>,
+ options: ScrapeExamplesOptions,
+) -> interface::Result<()> {
+ let inner = move || -> Result<(), String> {
+ // Generates source files for examples
+ let (cx, _) = Context::init(krate, renderopts, cache, tcx).map_err(|e| e.to_string())?;
-impl rustc_driver::Callbacks for Callbacks {
- fn after_analysis<'tcx>(
- &mut self,
- _compiler: &rustc_interface::interface::Compiler,
- queries: &'tcx rustc_interface::Queries<'tcx>,
- ) -> rustc_driver::Compilation {
- queries.global_ctxt().unwrap().take().enter(|tcx| {
- let mut finder = FindCalls {
- calls: &mut self.calls,
- tcx,
- map: tcx.hir(),
- file_name: self.file_name.clone(),
- krate: Symbol::intern(&self.krate),
- };
- tcx.hir().krate().visit_all_item_likes(&mut finder.as_deep_visitor());
- });
+ // Collect CrateIds corresponding to provided target crates
+ // If two different versions of the crate in the dependency tree, then examples will be collcted from both.
+ let all_crates = tcx
+ .crates(())
+ .iter()
+ .chain([&LOCAL_CRATE])
+ .map(|crate_num| (crate_num, tcx.crate_name(*crate_num)))
+ .collect::<Vec<_>>();
+ let target_crates = options
+ .target_crates
+ .into_iter()
+ .map(|target| all_crates.iter().filter(move |(_, name)| name.as_str() == target))
+ .flatten()
+ .map(|(crate_num, _)| **crate_num)
+ .collect::<Vec<_>>();
+
+ debug!("All crates in TyCtxt: {:?}", all_crates);
+ debug!("Scrape examples target_crates: {:?}", target_crates);
+
+ // Run call-finder on all items
+ let mut calls = FxHashMap::default();
+ let mut finder = FindCalls { calls: &mut calls, tcx, map: tcx.hir(), cx, target_crates };
+ tcx.hir().visit_all_item_likes(&mut finder.as_deep_visitor());
+
+ // Sort call locations within a given file in document order
+ for fn_calls in calls.values_mut() {
+ for file_calls in fn_calls.values_mut() {
+ file_calls.locations.sort_by_key(|loc| loc.call_expr.byte_span.0);
+ }
+ }
- rustc_driver::Compilation::Stop
+ // Save output to provided path
+ let mut encoder = FileEncoder::new(options.output_path).map_err(|e| e.to_string())?;
+ calls.encode(&mut encoder).map_err(|e| e.to_string())?;
+ encoder.flush().map_err(|e| e.to_string())?;
+
+ Ok(())
+ };
+
+ if let Err(e) = inner() {
+ tcx.sess.fatal(&e);
}
+
+ Ok(())
}
-/// Executes rustc on each example and collects call locations into a single structure.
-///
-/// # Arguments:
-/// * `examples` is an array of invocations to rustc, generated by Cargo.
-/// * `krate` is the name of the crate being documented.
-pub fn scrape(examples: &[String], krate: &str) -> interface::Result<AllCallLocations> {
- // Scrape each crate in parallel
- // FIXME(wcrichto): do we need optional support for no rayon?
- let maps = examples
- .par_iter()
- .map(|example| {
- // FIXME(wcrichto): is there a more robust way to get arguments than split(" ")?
- let mut args = example.split(" ").map(|s| s.to_owned()).collect::<Vec<_>>();
- let file_name = args[0].clone();
- args.insert(0, "_".to_string());
-
- // FIXME(wcrichto): is there any setup / cleanup that needs to be performed
- // here upon the invocation of rustc_driver?
- debug!("Scraping examples from krate {} with args:\n{:?}", krate, args);
- let mut callbacks =
- Callbacks { calls: FxHashMap::default(), file_name, krate: krate.to_string() };
- rustc_driver::RunCompiler::new(&args, &mut callbacks).run()?;
- Ok(callbacks.calls)
- })
- .collect::<interface::Result<Vec<_>>>()?;
-
- // Merge the call locations into a single result
- let mut all_map = FxHashMap::default();
- for map in maps {
- for (function, calls) in map.into_iter() {
- all_map.entry(function).or_insert_with(FxHashMap::default).extend(calls.into_iter());
+// Note: the Handler must be passed in explicitly because sess isn't available while parsing options
+crate fn load_call_locations(
+ with_examples: Vec<String>,
+ diag: &rustc_errors::Handler,
+) -> Result<AllCallLocations, i32> {
+ let inner = || {
+ let mut all_calls: AllCallLocations = FxHashMap::default();
+ for path in with_examples {
+ let bytes = fs::read(&path).map_err(|e| format!("{} (for path {})", e, path))?;
+ let mut decoder = Decoder::new(&bytes, 0);
+ let calls = AllCallLocations::decode(&mut decoder)?;
+
+ for (function, fn_calls) in calls.into_iter() {
+ all_calls.entry(function).or_default().extend(fn_calls.into_iter());
+ }
}
- }
- Ok(all_map)
+ Ok(all_calls)
+ };
+
+ inner().map_err(|e: String| {
+ diag.err(&format!("failed to load examples: {}", e));
+ 1
+ })
}
projects / rust.git / blobdiff