src/librustdoc/scrape_examples.rs

   1 //! This module analyzes crates to find call sites that can serve as examples in the documentation.
   2
   3 use crate::clean;
   4 use crate::config;
   5 use crate::formats;
   6 use crate::formats::renderer::FormatRenderer;
   7 use crate::html::render::Context;
   8
   9 use rustc_data_structures::fx::FxHashMap;
  10 use rustc_hir::{
  11     self as hir,
  12     intravisit::{self, Visitor},
  13 };
  14 use rustc_interface::interface;
  15 use rustc_macros::{Decodable, Encodable};
  16 use rustc_middle::hir::map::Map;
  17 use rustc_middle::hir::nested_filter;
  18 use rustc_middle::ty::{self, TyCtxt};
  19 use rustc_serialize::{
  20     opaque::{FileEncoder, MemDecoder},
  21     Decodable, Encodable,
  22 };
  23 use rustc_session::getopts;
  24 use rustc_span::{
  25     def_id::{CrateNum, DefPathHash, LOCAL_CRATE},
  26     edition::Edition,
  27     BytePos, FileName, SourceFile,
  28 };
  29
  30 use std::fs;
  31 use std::path::PathBuf;
  32
  33 #[derive(Debug, Clone)]
  34 pub(crate) struct ScrapeExamplesOptions {
  35     output_path: PathBuf,
  36     target_crates: Vec<String>,
  37     pub(crate) scrape_tests: bool,
  38 }
  39
  40 impl ScrapeExamplesOptions {
  41     pub(crate) fn new(
  42         matches: &getopts::Matches,
  43         diag: &rustc_errors::Handler,
  44     ) -> Result<Option<Self>, i32> {
  45         let output_path = matches.opt_str("scrape-examples-output-path");
  46         let target_crates = matches.opt_strs("scrape-examples-target-crate");
  47         let scrape_tests = matches.opt_present("scrape-tests");
  48         match (output_path, !target_crates.is_empty(), scrape_tests) {
  49             (Some(output_path), true, _) => Ok(Some(ScrapeExamplesOptions {
  50                 output_path: PathBuf::from(output_path),
  51                 target_crates,
  52                 scrape_tests,
  53             })),
  54             (Some(_), false, _) | (None, true, _) => {
  55                 diag.err("must use --scrape-examples-output-path and --scrape-examples-target-crate together");
  56                 Err(1)
  57             }
  58             (None, false, true) => {
  59                 diag.err("must use --scrape-examples-output-path and --scrape-examples-target-crate with --scrape-tests");
  60                 Err(1)
  61             }
  62             (None, false, false) => Ok(None),
  63         }
  64     }
  65 }
  66
  67 #[derive(Encodable, Decodable, Debug, Clone)]
  68 pub(crate) struct SyntaxRange {
  69     pub(crate) byte_span: (u32, u32),
  70     pub(crate) line_span: (usize, usize),
  71 }
  72
  73 impl SyntaxRange {
  74     fn new(span: rustc_span::Span, file: &SourceFile) -> Option<Self> {
  75         let get_pos = |bytepos: BytePos| file.original_relative_byte_pos(bytepos).0;
  76         let get_line = |bytepos: BytePos| file.lookup_line(bytepos);
  77
  78         Some(SyntaxRange {
  79             byte_span: (get_pos(span.lo()), get_pos(span.hi())),
  80             line_span: (get_line(span.lo())?, get_line(span.hi())?),
  81         })
  82     }
  83 }
  84
  85 #[derive(Encodable, Decodable, Debug, Clone)]
  86 pub(crate) struct CallLocation {
  87     pub(crate) call_expr: SyntaxRange,
  88     pub(crate) call_ident: SyntaxRange,
  89     pub(crate) enclosing_item: SyntaxRange,
  90 }
  91
  92 impl CallLocation {
  93     fn new(
  94         expr_span: rustc_span::Span,
  95         ident_span: rustc_span::Span,
  96         enclosing_item_span: rustc_span::Span,
  97         source_file: &SourceFile,
  98     ) -> Option<Self> {
  99         Some(CallLocation {
 100             call_expr: SyntaxRange::new(expr_span, source_file)?,
 101             call_ident: SyntaxRange::new(ident_span, source_file)?,
 102             enclosing_item: SyntaxRange::new(enclosing_item_span, source_file)?,
 103         })
 104     }
 105 }
 106
 107 #[derive(Encodable, Decodable, Debug, Clone)]
 108 pub(crate) struct CallData {
 109     pub(crate) locations: Vec<CallLocation>,
 110     pub(crate) url: String,
 111     pub(crate) display_name: String,
 112     pub(crate) edition: Edition,
 113 }
 114
 115 pub(crate) type FnCallLocations = FxHashMap<PathBuf, CallData>;
 116 pub(crate) type AllCallLocations = FxHashMap<DefPathHash, FnCallLocations>;
 117
 118 /// Visitor for traversing a crate and finding instances of function calls.
 119 struct FindCalls<'a, 'tcx> {
 120     tcx: TyCtxt<'tcx>,
 121     map: Map<'tcx>,
 122     cx: Context<'tcx>,
 123     target_crates: Vec<CrateNum>,
 124     calls: &'a mut AllCallLocations,
 125 }
 126
 127 impl<'a, 'tcx> Visitor<'tcx> for FindCalls<'a, 'tcx>
 128 where
 129     'tcx: 'a,
 130 {
 131     type NestedFilter = nested_filter::OnlyBodies;
 132
 133     fn nested_visit_map(&mut self) -> Self::Map {
 134         self.map
 135     }
 136
 137     fn visit_expr(&mut self, ex: &'tcx hir::Expr<'tcx>) {
 138         intravisit::walk_expr(self, ex);
 139
 140         let tcx = self.tcx;
 141
 142         // If we visit an item that contains an expression outside a function body,
 143         // then we need to exit before calling typeck (which will panic). See
 144         // test/run-make/rustdoc-scrape-examples-invalid-expr for an example.
 145         let hir = tcx.hir();
 146         if hir.maybe_body_owned_by(ex.hir_id.owner.def_id).is_none() {
 147             return;
 148         }
 149
 150         // Get type of function if expression is a function call
 151         let (ty, call_span, ident_span) = match ex.kind {
 152             hir::ExprKind::Call(f, _) => {
 153                 let types = tcx.typeck(ex.hir_id.owner.def_id);
 154
 155                 if let Some(ty) = types.node_type_opt(f.hir_id) {
 156                     (ty, ex.span, f.span)
 157                 } else {
 158                     trace!("node_type_opt({}) = None", f.hir_id);
 159                     return;
 160                 }
 161             }
 162             hir::ExprKind::MethodCall(path, _, _, call_span) => {
 163                 let types = tcx.typeck(ex.hir_id.owner.def_id);
 164                 let Some(def_id) = types.type_dependent_def_id(ex.hir_id) else {
 165                     trace!("type_dependent_def_id({}) = None", ex.hir_id);
 166                     return;
 167                 };
 168
 169                 let ident_span = path.ident.span;
 170                 (tcx.type_of(def_id), call_span, ident_span)
 171             }
 172             _ => {
 173                 return;
 174             }
 175         };
 176
 177         // If this span comes from a macro expansion, then the source code may not actually show
 178         // a use of the given item, so it would be a poor example. Hence, we skip all uses in macros.
 179         if call_span.from_expansion() {
 180             trace!("Rejecting expr from macro: {call_span:?}");
 181             return;
 182         }
 183
 184         // If the enclosing item has a span coming from a proc macro, then we also don't want to include
 185         // the example.
 186         let enclosing_item_span =
 187             tcx.hir().span_with_body(tcx.hir().get_parent_item(ex.hir_id).into());
 188         if enclosing_item_span.from_expansion() {
 189             trace!("Rejecting expr ({call_span:?}) from macro item: {enclosing_item_span:?}");
 190             return;
 191         }
 192
 193         // If the enclosing item doesn't actually enclose the call, this means we probably have a weird
 194         // macro issue even though the spans aren't tagged as being from an expansion.
 195         if !enclosing_item_span.contains(call_span) {
 196             warn!(
 197                 "Attempted to scrape call at [{call_span:?}] whose enclosing item [{enclosing_item_span:?}] doesn't contain the span of the call."
 198             );
 199             return;
 200         }
 201
 202         // Similarly for the call w/ the function ident.
 203         if !call_span.contains(ident_span) {
 204             warn!(
 205                 "Attempted to scrape call at [{call_span:?}] whose identifier [{ident_span:?}] was not contained in the span of the call."
 206             );
 207             return;
 208         }
 209
 210         // Save call site if the function resolves to a concrete definition
 211         if let ty::FnDef(def_id, _) = ty.kind() {
 212             if self.target_crates.iter().all(|krate| *krate != def_id.krate) {
 213                 trace!("Rejecting expr from crate not being documented: {call_span:?}");
 214                 return;
 215             }
 216
 217             let source_map = tcx.sess.source_map();
 218             let file = source_map.lookup_char_pos(call_span.lo()).file;
 219             let file_path = match file.name.clone() {
 220                 FileName::Real(real_filename) => real_filename.into_local_path(),
 221                 _ => None,
 222             };
 223
 224             if let Some(file_path) = file_path {
 225                 let abs_path = match fs::canonicalize(file_path.clone()) {
 226                     Ok(abs_path) => abs_path,
 227                     Err(_) => {
 228                         trace!("Could not canonicalize file path: {}", file_path.display());
 229                         return;
 230                     }
 231                 };
 232
 233                 let cx = &self.cx;
 234                 let clean_span = crate::clean::types::Span::new(call_span);
 235                 let url = match cx.href_from_span(clean_span, false) {
 236                     Some(url) => url,
 237                     None => {
 238                         trace!(
 239                             "Rejecting expr ({call_span:?}) whose clean span ({clean_span:?}) cannot be turned into a link"
 240                         );
 241                         return;
 242                     }
 243                 };
 244
 245                 let mk_call_data = || {
 246                     let display_name = file_path.display().to_string();
 247                     let edition = call_span.edition();
 248                     CallData { locations: Vec::new(), url, display_name, edition }
 249                 };
 250
 251                 let fn_key = tcx.def_path_hash(*def_id);
 252                 let fn_entries = self.calls.entry(fn_key).or_default();
 253
 254                 trace!("Including expr: {:?}", call_span);
 255                 let enclosing_item_span =
 256                     source_map.span_extend_to_prev_char(enclosing_item_span, '\n', false);
 257                 let location =
 258                     match CallLocation::new(call_span, ident_span, enclosing_item_span, &file) {
 259                         Some(location) => location,
 260                         None => {
 261                             trace!("Could not get serializable call location for {call_span:?}");
 262                             return;
 263                         }
 264                     };
 265                 fn_entries.entry(abs_path).or_insert_with(mk_call_data).locations.push(location);
 266             }
 267         }
 268     }
 269 }
 270
 271 pub(crate) fn run(
 272     krate: clean::Crate,
 273     mut renderopts: config::RenderOptions,
 274     cache: formats::cache::Cache,
 275     tcx: TyCtxt<'_>,
 276     options: ScrapeExamplesOptions,
 277 ) -> interface::Result<()> {
 278     let inner = move || -> Result<(), String> {
 279         // Generates source files for examples
 280         renderopts.no_emit_shared = true;
 281         let (cx, _) = Context::init(krate, renderopts, cache, tcx).map_err(|e| e.to_string())?;
 282
 283         // Collect CrateIds corresponding to provided target crates
 284         // If two different versions of the crate in the dependency tree, then examples will be collcted from both.
 285         let all_crates = tcx
 286             .crates(())
 287             .iter()
 288             .chain([&LOCAL_CRATE])
 289             .map(|crate_num| (crate_num, tcx.crate_name(*crate_num)))
 290             .collect::<Vec<_>>();
 291         let target_crates = options
 292             .target_crates
 293             .into_iter()
 294             .flat_map(|target| all_crates.iter().filter(move |(_, name)| name.as_str() == target))
 295             .map(|(crate_num, _)| **crate_num)
 296             .collect::<Vec<_>>();
 297
 298         debug!("All crates in TyCtxt: {all_crates:?}");
 299         debug!("Scrape examples target_crates: {target_crates:?}");
 300
 301         // Run call-finder on all items
 302         let mut calls = FxHashMap::default();
 303         let mut finder = FindCalls { calls: &mut calls, tcx, map: tcx.hir(), cx, target_crates };
 304         tcx.hir().visit_all_item_likes_in_crate(&mut finder);
 305
 306         // The visitor might have found a type error, which we need to
 307         // promote to a fatal error
 308         if tcx.sess.diagnostic().has_errors_or_lint_errors().is_some() {
 309             return Err(String::from("Compilation failed, aborting rustdoc"));
 310         }
 311
 312         // Sort call locations within a given file in document order
 313         for fn_calls in calls.values_mut() {
 314             for file_calls in fn_calls.values_mut() {
 315                 file_calls.locations.sort_by_key(|loc| loc.call_expr.byte_span.0);
 316             }
 317         }
 318
 319         // Save output to provided path
 320         let mut encoder = FileEncoder::new(options.output_path).map_err(|e| e.to_string())?;
 321         calls.encode(&mut encoder);
 322         encoder.finish().map_err(|e| e.to_string())?;
 323
 324         Ok(())
 325     };
 326
 327     if let Err(e) = inner() {
 328         tcx.sess.fatal(&e);
 329     }
 330
 331     Ok(())
 332 }
 333
 334 // Note: the Handler must be passed in explicitly because sess isn't available while parsing options
 335 pub(crate) fn load_call_locations(
 336     with_examples: Vec<String>,
 337     diag: &rustc_errors::Handler,
 338 ) -> Result<AllCallLocations, i32> {
 339     let inner = || {
 340         let mut all_calls: AllCallLocations = FxHashMap::default();
 341         for path in with_examples {
 342             let bytes = fs::read(&path).map_err(|e| format!("{} (for path {})", e, path))?;
 343             let mut decoder = MemDecoder::new(&bytes, 0);
 344             let calls = AllCallLocations::decode(&mut decoder);
 345
 346             for (function, fn_calls) in calls.into_iter() {
 347                 all_calls.entry(function).or_default().extend(fn_calls.into_iter());
 348             }
 349         }
 350
 351         Ok(all_calls)
 352     };
 353
 354     inner().map_err(|e: String| {
 355         diag.err(&format!("failed to load examples: {}", e));
 356         1
 357     })
 358 }