Move logic for "making" doctests to submodule
This code turns the raw code given by the user into something actually runnable, e.g. by adding a `main` function if it doesn't already exist. I also made a couple other items private that didn't need to be crate-public.
This commit is contained in:
Noah Lev
Guillaume Gomez
parent
0dc72d9551
commit
d06a05e262
@ -1,23 +1,19 @@
|
|||||||
|
mod make;
|
||||||
mod markdown;
|
mod markdown;
|
||||||
mod rust;
|
mod rust;
|
||||||
|
|
||||||
|
pub(crate) use make::make_test;
|
||||||
pub(crate) use markdown::test as test_markdown;
|
pub(crate) use markdown::test as test_markdown;
|
||||||
|
|
||||||
use rustc_ast as ast;
|
use rustc_ast as ast;
|
||||||
use rustc_data_structures::fx::{FxHashMap, FxHashSet};
|
use rustc_data_structures::fx::{FxHashMap, FxHashSet};
|
||||||
use rustc_data_structures::sync::Lrc;
|
|
||||||
use rustc_errors::emitter::stderr_destination;
|
|
||||||
use rustc_errors::{ColorConfig, ErrorGuaranteed, FatalError};
|
use rustc_errors::{ColorConfig, ErrorGuaranteed, FatalError};
|
||||||
use rustc_hir::def_id::LOCAL_CRATE;
|
use rustc_hir::def_id::LOCAL_CRATE;
|
||||||
use rustc_hir::CRATE_HIR_ID;
|
use rustc_hir::CRATE_HIR_ID;
|
||||||
use rustc_interface::interface;
|
use rustc_interface::interface;
|
||||||
use rustc_parse::new_parser_from_source_str;
|
|
||||||
use rustc_parse::parser::attr::InnerAttrPolicy;
|
|
||||||
use rustc_session::config::{self, CrateType, ErrorOutputType};
|
use rustc_session::config::{self, CrateType, ErrorOutputType};
|
||||||
use rustc_session::lint;
|
use rustc_session::lint;
|
||||||
use rustc_session::parse::ParseSess;
|
|
||||||
use rustc_span::edition::Edition;
|
use rustc_span::edition::Edition;
|
||||||
use rustc_span::source_map::SourceMap;
|
|
||||||
use rustc_span::symbol::sym;
|
use rustc_span::symbol::sym;
|
||||||
use rustc_span::FileName;
|
use rustc_span::FileName;
|
||||||
use rustc_target::spec::{Target, TargetTriple};
|
use rustc_target::spec::{Target, TargetTriple};
|
||||||
@ -577,369 +573,7 @@ fn make_maybe_absolute_path(path: PathBuf) -> PathBuf {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
|
struct IndividualTestOptions {
|
||||||
/// lines before the test code begins as well as if the output stream supports colors or not.
|
|
||||||
pub(crate) fn make_test(
|
|
||||||
s: &str,
|
|
||||||
crate_name: Option<&str>,
|
|
||||||
dont_insert_main: bool,
|
|
||||||
opts: &GlobalTestOptions,
|
|
||||||
edition: Edition,
|
|
||||||
test_id: Option<&str>,
|
|
||||||
) -> (String, usize, bool) {
|
|
||||||
let (crate_attrs, everything_else, crates) = partition_source(s, edition);
|
|
||||||
let everything_else = everything_else.trim();
|
|
||||||
let mut line_offset = 0;
|
|
||||||
let mut prog = String::new();
|
|
||||||
let mut supports_color = false;
|
|
||||||
|
|
||||||
if opts.attrs.is_empty() {
|
|
||||||
// If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
|
|
||||||
// lints that are commonly triggered in doctests. The crate-level test attributes are
|
|
||||||
// commonly used to make tests fail in case they trigger warnings, so having this there in
|
|
||||||
// that case may cause some tests to pass when they shouldn't have.
|
|
||||||
prog.push_str("#![allow(unused)]\n");
|
|
||||||
line_offset += 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
|
|
||||||
for attr in &opts.attrs {
|
|
||||||
prog.push_str(&format!("#![{attr}]\n"));
|
|
||||||
line_offset += 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Now push any outer attributes from the example, assuming they
|
|
||||||
// are intended to be crate attributes.
|
|
||||||
prog.push_str(&crate_attrs);
|
|
||||||
prog.push_str(&crates);
|
|
||||||
|
|
||||||
// Uses librustc_ast to parse the doctest and find if there's a main fn and the extern
|
|
||||||
// crate already is included.
|
|
||||||
let result = rustc_driver::catch_fatal_errors(|| {
|
|
||||||
rustc_span::create_session_if_not_set_then(edition, |_| {
|
|
||||||
use rustc_errors::emitter::{Emitter, HumanEmitter};
|
|
||||||
use rustc_errors::DiagCtxt;
|
|
||||||
use rustc_parse::parser::ForceCollect;
|
|
||||||
use rustc_span::source_map::FilePathMapping;
|
|
||||||
|
|
||||||
let filename = FileName::anon_source_code(s);
|
|
||||||
let source = crates + everything_else;
|
|
||||||
|
|
||||||
// Any errors in parsing should also appear when the doctest is compiled for real, so just
|
|
||||||
// send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
|
|
||||||
let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
|
|
||||||
let fallback_bundle = rustc_errors::fallback_fluent_bundle(
|
|
||||||
rustc_driver::DEFAULT_LOCALE_RESOURCES.to_vec(),
|
|
||||||
false,
|
|
||||||
);
|
|
||||||
supports_color =
|
|
||||||
HumanEmitter::new(stderr_destination(ColorConfig::Auto), fallback_bundle.clone())
|
|
||||||
.supports_color();
|
|
||||||
|
|
||||||
let emitter = HumanEmitter::new(Box::new(io::sink()), fallback_bundle);
|
|
||||||
|
|
||||||
// FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
|
|
||||||
let dcx = DiagCtxt::new(Box::new(emitter)).disable_warnings();
|
|
||||||
let psess = ParseSess::with_dcx(dcx, sm);
|
|
||||||
|
|
||||||
let mut found_main = false;
|
|
||||||
let mut found_extern_crate = crate_name.is_none();
|
|
||||||
let mut found_macro = false;
|
|
||||||
|
|
||||||
let mut parser = match new_parser_from_source_str(&psess, filename, source) {
|
|
||||||
Ok(p) => p,
|
|
||||||
Err(errs) => {
|
|
||||||
errs.into_iter().for_each(|err| err.cancel());
|
|
||||||
return (found_main, found_extern_crate, found_macro);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
loop {
|
|
||||||
match parser.parse_item(ForceCollect::No) {
|
|
||||||
Ok(Some(item)) => {
|
|
||||||
if !found_main
|
|
||||||
&& let ast::ItemKind::Fn(..) = item.kind
|
|
||||||
&& item.ident.name == sym::main
|
|
||||||
{
|
|
||||||
found_main = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
if !found_extern_crate
|
|
||||||
&& let ast::ItemKind::ExternCrate(original) = item.kind
|
|
||||||
{
|
|
||||||
// This code will never be reached if `crate_name` is none because
|
|
||||||
// `found_extern_crate` is initialized to `true` if it is none.
|
|
||||||
let crate_name = crate_name.unwrap();
|
|
||||||
|
|
||||||
match original {
|
|
||||||
Some(name) => found_extern_crate = name.as_str() == crate_name,
|
|
||||||
None => found_extern_crate = item.ident.as_str() == crate_name,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if !found_macro && let ast::ItemKind::MacCall(..) = item.kind {
|
|
||||||
found_macro = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
if found_main && found_extern_crate {
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Ok(None) => break,
|
|
||||||
Err(e) => {
|
|
||||||
e.cancel();
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// The supplied item is only used for diagnostics,
|
|
||||||
// which are swallowed here anyway.
|
|
||||||
parser.maybe_consume_incorrect_semicolon(None);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reset errors so that they won't be reported as compiler bugs when dropping the
|
|
||||||
// dcx. Any errors in the tests will be reported when the test file is compiled,
|
|
||||||
// Note that we still need to cancel the errors above otherwise `Diag` will panic on
|
|
||||||
// drop.
|
|
||||||
psess.dcx.reset_err_count();
|
|
||||||
|
|
||||||
(found_main, found_extern_crate, found_macro)
|
|
||||||
})
|
|
||||||
});
|
|
||||||
let Ok((already_has_main, already_has_extern_crate, found_macro)) = result else {
|
|
||||||
// If the parser panicked due to a fatal error, pass the test code through unchanged.
|
|
||||||
// The error will be reported during compilation.
|
|
||||||
return (s.to_owned(), 0, false);
|
|
||||||
};
|
|
||||||
|
|
||||||
// If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
|
|
||||||
// see it. In that case, run the old text-based scan to see if they at least have a main
|
|
||||||
// function written inside a macro invocation. See
|
|
||||||
// https://github.com/rust-lang/rust/issues/56898
|
|
||||||
let already_has_main = if found_macro && !already_has_main {
|
|
||||||
s.lines()
|
|
||||||
.map(|line| {
|
|
||||||
let comment = line.find("//");
|
|
||||||
if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
|
|
||||||
})
|
|
||||||
.any(|code| code.contains("fn main"))
|
|
||||||
} else {
|
|
||||||
already_has_main
|
|
||||||
};
|
|
||||||
|
|
||||||
// Don't inject `extern crate std` because it's already injected by the
|
|
||||||
// compiler.
|
|
||||||
if !already_has_extern_crate && !opts.no_crate_inject && crate_name != Some("std") {
|
|
||||||
if let Some(crate_name) = crate_name {
|
|
||||||
// Don't inject `extern crate` if the crate is never used.
|
|
||||||
// NOTE: this is terribly inaccurate because it doesn't actually
|
|
||||||
// parse the source, but only has false positives, not false
|
|
||||||
// negatives.
|
|
||||||
if s.contains(crate_name) {
|
|
||||||
// rustdoc implicitly inserts an `extern crate` item for the own crate
|
|
||||||
// which may be unused, so we need to allow the lint.
|
|
||||||
prog.push_str("#[allow(unused_extern_crates)]\n");
|
|
||||||
|
|
||||||
prog.push_str(&format!("extern crate r#{crate_name};\n"));
|
|
||||||
line_offset += 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// FIXME: This code cannot yet handle no_std test cases yet
|
|
||||||
if dont_insert_main || already_has_main || prog.contains("![no_std]") {
|
|
||||||
prog.push_str(everything_else);
|
|
||||||
} else {
|
|
||||||
let returns_result = everything_else.trim_end().ends_with("(())");
|
|
||||||
// Give each doctest main function a unique name.
|
|
||||||
// This is for example needed for the tooling around `-C instrument-coverage`.
|
|
||||||
let inner_fn_name = if let Some(test_id) = test_id {
|
|
||||||
format!("_doctest_main_{test_id}")
|
|
||||||
} else {
|
|
||||||
"_inner".into()
|
|
||||||
};
|
|
||||||
let inner_attr = if test_id.is_some() { "#[allow(non_snake_case)] " } else { "" };
|
|
||||||
let (main_pre, main_post) = if returns_result {
|
|
||||||
(
|
|
||||||
format!(
|
|
||||||
"fn main() {{ {inner_attr}fn {inner_fn_name}() -> Result<(), impl core::fmt::Debug> {{\n",
|
|
||||||
),
|
|
||||||
format!("\n}} {inner_fn_name}().unwrap() }}"),
|
|
||||||
)
|
|
||||||
} else if test_id.is_some() {
|
|
||||||
(
|
|
||||||
format!("fn main() {{ {inner_attr}fn {inner_fn_name}() {{\n",),
|
|
||||||
format!("\n}} {inner_fn_name}() }}"),
|
|
||||||
)
|
|
||||||
} else {
|
|
||||||
("fn main() {\n".into(), "\n}".into())
|
|
||||||
};
|
|
||||||
// Note on newlines: We insert a line/newline *before*, and *after*
|
|
||||||
// the doctest and adjust the `line_offset` accordingly.
|
|
||||||
// In the case of `-C instrument-coverage`, this means that the generated
|
|
||||||
// inner `main` function spans from the doctest opening codeblock to the
|
|
||||||
// closing one. For example
|
|
||||||
// /// ``` <- start of the inner main
|
|
||||||
// /// <- code under doctest
|
|
||||||
// /// ``` <- end of the inner main
|
|
||||||
line_offset += 1;
|
|
||||||
|
|
||||||
// add extra 4 spaces for each line to offset the code block
|
|
||||||
let content = if opts.insert_indent_space {
|
|
||||||
everything_else
|
|
||||||
.lines()
|
|
||||||
.map(|line| format!(" {}", line))
|
|
||||||
.collect::<Vec<String>>()
|
|
||||||
.join("\n")
|
|
||||||
} else {
|
|
||||||
everything_else.to_string()
|
|
||||||
};
|
|
||||||
prog.extend([&main_pre, content.as_str(), &main_post].iter().cloned());
|
|
||||||
}
|
|
||||||
|
|
||||||
debug!("final doctest:\n{prog}");
|
|
||||||
|
|
||||||
(prog, line_offset, supports_color)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn check_if_attr_is_complete(source: &str, edition: Edition) -> bool {
|
|
||||||
if source.is_empty() {
|
|
||||||
// Empty content so nothing to check in here...
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
rustc_driver::catch_fatal_errors(|| {
|
|
||||||
rustc_span::create_session_if_not_set_then(edition, |_| {
|
|
||||||
use rustc_errors::emitter::HumanEmitter;
|
|
||||||
use rustc_errors::DiagCtxt;
|
|
||||||
use rustc_span::source_map::FilePathMapping;
|
|
||||||
|
|
||||||
let filename = FileName::anon_source_code(source);
|
|
||||||
// Any errors in parsing should also appear when the doctest is compiled for real, so just
|
|
||||||
// send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
|
|
||||||
let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
|
|
||||||
let fallback_bundle = rustc_errors::fallback_fluent_bundle(
|
|
||||||
rustc_driver::DEFAULT_LOCALE_RESOURCES.to_vec(),
|
|
||||||
false,
|
|
||||||
);
|
|
||||||
|
|
||||||
let emitter = HumanEmitter::new(Box::new(io::sink()), fallback_bundle);
|
|
||||||
|
|
||||||
let dcx = DiagCtxt::new(Box::new(emitter)).disable_warnings();
|
|
||||||
let psess = ParseSess::with_dcx(dcx, sm);
|
|
||||||
let mut parser = match new_parser_from_source_str(&psess, filename, source.to_owned()) {
|
|
||||||
Ok(p) => p,
|
|
||||||
Err(errs) => {
|
|
||||||
errs.into_iter().for_each(|err| err.cancel());
|
|
||||||
// If there is an unclosed delimiter, an error will be returned by the
|
|
||||||
// tokentrees.
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
// If a parsing error happened, it's very likely that the attribute is incomplete.
|
|
||||||
if let Err(e) = parser.parse_attribute(InnerAttrPolicy::Permitted) {
|
|
||||||
e.cancel();
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
true
|
|
||||||
})
|
|
||||||
})
|
|
||||||
.unwrap_or(false)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn partition_source(s: &str, edition: Edition) -> (String, String, String) {
|
|
||||||
#[derive(Copy, Clone, PartialEq)]
|
|
||||||
enum PartitionState {
|
|
||||||
Attrs,
|
|
||||||
Crates,
|
|
||||||
Other,
|
|
||||||
}
|
|
||||||
let mut state = PartitionState::Attrs;
|
|
||||||
let mut before = String::new();
|
|
||||||
let mut crates = String::new();
|
|
||||||
let mut after = String::new();
|
|
||||||
|
|
||||||
let mut mod_attr_pending = String::new();
|
|
||||||
|
|
||||||
for line in s.lines() {
|
|
||||||
let trimline = line.trim();
|
|
||||||
|
|
||||||
// FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
|
|
||||||
// shunted into "everything else"
|
|
||||||
match state {
|
|
||||||
PartitionState::Attrs => {
|
|
||||||
state = if trimline.starts_with("#![") {
|
|
||||||
if !check_if_attr_is_complete(line, edition) {
|
|
||||||
mod_attr_pending = line.to_owned();
|
|
||||||
} else {
|
|
||||||
mod_attr_pending.clear();
|
|
||||||
}
|
|
||||||
PartitionState::Attrs
|
|
||||||
} else if trimline.chars().all(|c| c.is_whitespace())
|
|
||||||
|| (trimline.starts_with("//") && !trimline.starts_with("///"))
|
|
||||||
{
|
|
||||||
PartitionState::Attrs
|
|
||||||
} else if trimline.starts_with("extern crate")
|
|
||||||
|| trimline.starts_with("#[macro_use] extern crate")
|
|
||||||
{
|
|
||||||
PartitionState::Crates
|
|
||||||
} else {
|
|
||||||
// First we check if the previous attribute was "complete"...
|
|
||||||
if !mod_attr_pending.is_empty() {
|
|
||||||
// If not, then we append the new line into the pending attribute to check
|
|
||||||
// if this time it's complete...
|
|
||||||
mod_attr_pending.push_str(line);
|
|
||||||
if !trimline.is_empty()
|
|
||||||
&& check_if_attr_is_complete(&mod_attr_pending, edition)
|
|
||||||
{
|
|
||||||
// If it's complete, then we can clear the pending content.
|
|
||||||
mod_attr_pending.clear();
|
|
||||||
}
|
|
||||||
// In any case, this is considered as `PartitionState::Attrs` so it's
|
|
||||||
// prepended before rustdoc's inserts.
|
|
||||||
PartitionState::Attrs
|
|
||||||
} else {
|
|
||||||
PartitionState::Other
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
PartitionState::Crates => {
|
|
||||||
state = if trimline.starts_with("extern crate")
|
|
||||||
|| trimline.starts_with("#[macro_use] extern crate")
|
|
||||||
|| trimline.chars().all(|c| c.is_whitespace())
|
|
||||||
|| (trimline.starts_with("//") && !trimline.starts_with("///"))
|
|
||||||
{
|
|
||||||
PartitionState::Crates
|
|
||||||
} else {
|
|
||||||
PartitionState::Other
|
|
||||||
};
|
|
||||||
}
|
|
||||||
PartitionState::Other => {}
|
|
||||||
}
|
|
||||||
|
|
||||||
match state {
|
|
||||||
PartitionState::Attrs => {
|
|
||||||
before.push_str(line);
|
|
||||||
before.push('\n');
|
|
||||||
}
|
|
||||||
PartitionState::Crates => {
|
|
||||||
crates.push_str(line);
|
|
||||||
crates.push('\n');
|
|
||||||
}
|
|
||||||
PartitionState::Other => {
|
|
||||||
after.push_str(line);
|
|
||||||
after.push('\n');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
debug!("before:\n{before}");
|
|
||||||
debug!("crates:\n{crates}");
|
|
||||||
debug!("after:\n{after}");
|
|
||||||
|
|
||||||
(before, after, crates)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) struct IndividualTestOptions {
|
|
||||||
outdir: DirState,
|
outdir: DirState,
|
||||||
test_id: String,
|
test_id: String,
|
||||||
path: PathBuf,
|
path: PathBuf,
|
||||||
@ -989,8 +623,8 @@ pub(crate) trait DoctestVisitor {
|
|||||||
fn visit_header(&mut self, _name: &str, _level: u32) {}
|
fn visit_header(&mut self, _name: &str, _level: u32) {}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) struct CreateRunnableDoctests {
|
struct CreateRunnableDoctests {
|
||||||
pub(crate) tests: Vec<test::TestDescAndFn>,
|
tests: Vec<test::TestDescAndFn>,
|
||||||
|
|
||||||
rustdoc_options: Arc<RustdocOptions>,
|
rustdoc_options: Arc<RustdocOptions>,
|
||||||
opts: GlobalTestOptions,
|
opts: GlobalTestOptions,
|
||||||
@ -1000,10 +634,7 @@ pub(crate) struct CreateRunnableDoctests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl CreateRunnableDoctests {
|
impl CreateRunnableDoctests {
|
||||||
pub(crate) fn new(
|
fn new(rustdoc_options: RustdocOptions, opts: GlobalTestOptions) -> CreateRunnableDoctests {
|
||||||
rustdoc_options: RustdocOptions,
|
|
||||||
opts: GlobalTestOptions,
|
|
||||||
) -> CreateRunnableDoctests {
|
|
||||||
CreateRunnableDoctests {
|
CreateRunnableDoctests {
|
||||||
tests: Vec::new(),
|
tests: Vec::new(),
|
||||||
rustdoc_options: Arc::new(rustdoc_options),
|
rustdoc_options: Arc::new(rustdoc_options),
|
||||||
|
|||||||
381
src/librustdoc/doctest/make.rs
Normal file
381
src/librustdoc/doctest/make.rs
Normal file
@ -0,0 +1,381 @@
|
|||||||
|
//! Logic for transforming the raw code given by the user into something actually
|
||||||
|
//! runnable, e.g. by adding a `main` function if it doesn't already exist.
|
||||||
|
|
||||||
|
use std::io;
|
||||||
|
|
||||||
|
use rustc_ast as ast;
|
||||||
|
use rustc_data_structures::sync::Lrc;
|
||||||
|
use rustc_errors::emitter::stderr_destination;
|
||||||
|
use rustc_errors::ColorConfig;
|
||||||
|
use rustc_parse::new_parser_from_source_str;
|
||||||
|
use rustc_parse::parser::attr::InnerAttrPolicy;
|
||||||
|
use rustc_session::parse::ParseSess;
|
||||||
|
use rustc_span::edition::Edition;
|
||||||
|
use rustc_span::source_map::SourceMap;
|
||||||
|
use rustc_span::symbol::sym;
|
||||||
|
use rustc_span::FileName;
|
||||||
|
|
||||||
|
use super::GlobalTestOptions;
|
||||||
|
|
||||||
|
/// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
|
||||||
|
/// lines before the test code begins as well as if the output stream supports colors or not.
|
||||||
|
pub(crate) fn make_test(
|
||||||
|
s: &str,
|
||||||
|
crate_name: Option<&str>,
|
||||||
|
dont_insert_main: bool,
|
||||||
|
opts: &GlobalTestOptions,
|
||||||
|
edition: Edition,
|
||||||
|
test_id: Option<&str>,
|
||||||
|
) -> (String, usize, bool) {
|
||||||
|
let (crate_attrs, everything_else, crates) = partition_source(s, edition);
|
||||||
|
let everything_else = everything_else.trim();
|
||||||
|
let mut line_offset = 0;
|
||||||
|
let mut prog = String::new();
|
||||||
|
let mut supports_color = false;
|
||||||
|
|
||||||
|
if opts.attrs.is_empty() {
|
||||||
|
// If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
|
||||||
|
// lints that are commonly triggered in doctests. The crate-level test attributes are
|
||||||
|
// commonly used to make tests fail in case they trigger warnings, so having this there in
|
||||||
|
// that case may cause some tests to pass when they shouldn't have.
|
||||||
|
prog.push_str("#![allow(unused)]\n");
|
||||||
|
line_offset += 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
|
||||||
|
for attr in &opts.attrs {
|
||||||
|
prog.push_str(&format!("#![{attr}]\n"));
|
||||||
|
line_offset += 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Now push any outer attributes from the example, assuming they
|
||||||
|
// are intended to be crate attributes.
|
||||||
|
prog.push_str(&crate_attrs);
|
||||||
|
prog.push_str(&crates);
|
||||||
|
|
||||||
|
// Uses librustc_ast to parse the doctest and find if there's a main fn and the extern
|
||||||
|
// crate already is included.
|
||||||
|
let result = rustc_driver::catch_fatal_errors(|| {
|
||||||
|
rustc_span::create_session_if_not_set_then(edition, |_| {
|
||||||
|
use rustc_errors::emitter::{Emitter, HumanEmitter};
|
||||||
|
use rustc_errors::DiagCtxt;
|
||||||
|
use rustc_parse::parser::ForceCollect;
|
||||||
|
use rustc_span::source_map::FilePathMapping;
|
||||||
|
|
||||||
|
let filename = FileName::anon_source_code(s);
|
||||||
|
let source = crates + everything_else;
|
||||||
|
|
||||||
|
// Any errors in parsing should also appear when the doctest is compiled for real, so just
|
||||||
|
// send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
|
||||||
|
let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
|
||||||
|
let fallback_bundle = rustc_errors::fallback_fluent_bundle(
|
||||||
|
rustc_driver::DEFAULT_LOCALE_RESOURCES.to_vec(),
|
||||||
|
false,
|
||||||
|
);
|
||||||
|
supports_color =
|
||||||
|
HumanEmitter::new(stderr_destination(ColorConfig::Auto), fallback_bundle.clone())
|
||||||
|
.supports_color();
|
||||||
|
|
||||||
|
let emitter = HumanEmitter::new(Box::new(io::sink()), fallback_bundle);
|
||||||
|
|
||||||
|
// FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
|
||||||
|
let dcx = DiagCtxt::new(Box::new(emitter)).disable_warnings();
|
||||||
|
let psess = ParseSess::with_dcx(dcx, sm);
|
||||||
|
|
||||||
|
let mut found_main = false;
|
||||||
|
let mut found_extern_crate = crate_name.is_none();
|
||||||
|
let mut found_macro = false;
|
||||||
|
|
||||||
|
let mut parser = match new_parser_from_source_str(&psess, filename, source) {
|
||||||
|
Ok(p) => p,
|
||||||
|
Err(errs) => {
|
||||||
|
errs.into_iter().for_each(|err| err.cancel());
|
||||||
|
return (found_main, found_extern_crate, found_macro);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
loop {
|
||||||
|
match parser.parse_item(ForceCollect::No) {
|
||||||
|
Ok(Some(item)) => {
|
||||||
|
if !found_main
|
||||||
|
&& let ast::ItemKind::Fn(..) = item.kind
|
||||||
|
&& item.ident.name == sym::main
|
||||||
|
{
|
||||||
|
found_main = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if !found_extern_crate
|
||||||
|
&& let ast::ItemKind::ExternCrate(original) = item.kind
|
||||||
|
{
|
||||||
|
// This code will never be reached if `crate_name` is none because
|
||||||
|
// `found_extern_crate` is initialized to `true` if it is none.
|
||||||
|
let crate_name = crate_name.unwrap();
|
||||||
|
|
||||||
|
match original {
|
||||||
|
Some(name) => found_extern_crate = name.as_str() == crate_name,
|
||||||
|
None => found_extern_crate = item.ident.as_str() == crate_name,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if !found_macro && let ast::ItemKind::MacCall(..) = item.kind {
|
||||||
|
found_macro = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if found_main && found_extern_crate {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(None) => break,
|
||||||
|
Err(e) => {
|
||||||
|
e.cancel();
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The supplied item is only used for diagnostics,
|
||||||
|
// which are swallowed here anyway.
|
||||||
|
parser.maybe_consume_incorrect_semicolon(None);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reset errors so that they won't be reported as compiler bugs when dropping the
|
||||||
|
// dcx. Any errors in the tests will be reported when the test file is compiled,
|
||||||
|
// Note that we still need to cancel the errors above otherwise `Diag` will panic on
|
||||||
|
// drop.
|
||||||
|
psess.dcx.reset_err_count();
|
||||||
|
|
||||||
|
(found_main, found_extern_crate, found_macro)
|
||||||
|
})
|
||||||
|
});
|
||||||
|
let Ok((already_has_main, already_has_extern_crate, found_macro)) = result else {
|
||||||
|
// If the parser panicked due to a fatal error, pass the test code through unchanged.
|
||||||
|
// The error will be reported during compilation.
|
||||||
|
return (s.to_owned(), 0, false);
|
||||||
|
};
|
||||||
|
|
||||||
|
// If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
|
||||||
|
// see it. In that case, run the old text-based scan to see if they at least have a main
|
||||||
|
// function written inside a macro invocation. See
|
||||||
|
// https://github.com/rust-lang/rust/issues/56898
|
||||||
|
let already_has_main = if found_macro && !already_has_main {
|
||||||
|
s.lines()
|
||||||
|
.map(|line| {
|
||||||
|
let comment = line.find("//");
|
||||||
|
if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
|
||||||
|
})
|
||||||
|
.any(|code| code.contains("fn main"))
|
||||||
|
} else {
|
||||||
|
already_has_main
|
||||||
|
};
|
||||||
|
|
||||||
|
// Don't inject `extern crate std` because it's already injected by the
|
||||||
|
// compiler.
|
||||||
|
if !already_has_extern_crate && !opts.no_crate_inject && crate_name != Some("std") {
|
||||||
|
if let Some(crate_name) = crate_name {
|
||||||
|
// Don't inject `extern crate` if the crate is never used.
|
||||||
|
// NOTE: this is terribly inaccurate because it doesn't actually
|
||||||
|
// parse the source, but only has false positives, not false
|
||||||
|
// negatives.
|
||||||
|
if s.contains(crate_name) {
|
||||||
|
// rustdoc implicitly inserts an `extern crate` item for the own crate
|
||||||
|
// which may be unused, so we need to allow the lint.
|
||||||
|
prog.push_str("#[allow(unused_extern_crates)]\n");
|
||||||
|
|
||||||
|
prog.push_str(&format!("extern crate r#{crate_name};\n"));
|
||||||
|
line_offset += 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// FIXME: This code cannot yet handle no_std test cases yet
|
||||||
|
if dont_insert_main || already_has_main || prog.contains("![no_std]") {
|
||||||
|
prog.push_str(everything_else);
|
||||||
|
} else {
|
||||||
|
let returns_result = everything_else.trim_end().ends_with("(())");
|
||||||
|
// Give each doctest main function a unique name.
|
||||||
|
// This is for example needed for the tooling around `-C instrument-coverage`.
|
||||||
|
let inner_fn_name = if let Some(test_id) = test_id {
|
||||||
|
format!("_doctest_main_{test_id}")
|
||||||
|
} else {
|
||||||
|
"_inner".into()
|
||||||
|
};
|
||||||
|
let inner_attr = if test_id.is_some() { "#[allow(non_snake_case)] " } else { "" };
|
||||||
|
let (main_pre, main_post) = if returns_result {
|
||||||
|
(
|
||||||
|
format!(
|
||||||
|
"fn main() {{ {inner_attr}fn {inner_fn_name}() -> Result<(), impl core::fmt::Debug> {{\n",
|
||||||
|
),
|
||||||
|
format!("\n}} {inner_fn_name}().unwrap() }}"),
|
||||||
|
)
|
||||||
|
} else if test_id.is_some() {
|
||||||
|
(
|
||||||
|
format!("fn main() {{ {inner_attr}fn {inner_fn_name}() {{\n",),
|
||||||
|
format!("\n}} {inner_fn_name}() }}"),
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
("fn main() {\n".into(), "\n}".into())
|
||||||
|
};
|
||||||
|
// Note on newlines: We insert a line/newline *before*, and *after*
|
||||||
|
// the doctest and adjust the `line_offset` accordingly.
|
||||||
|
// In the case of `-C instrument-coverage`, this means that the generated
|
||||||
|
// inner `main` function spans from the doctest opening codeblock to the
|
||||||
|
// closing one. For example
|
||||||
|
// /// ``` <- start of the inner main
|
||||||
|
// /// <- code under doctest
|
||||||
|
// /// ``` <- end of the inner main
|
||||||
|
line_offset += 1;
|
||||||
|
|
||||||
|
// add extra 4 spaces for each line to offset the code block
|
||||||
|
let content = if opts.insert_indent_space {
|
||||||
|
everything_else
|
||||||
|
.lines()
|
||||||
|
.map(|line| format!(" {}", line))
|
||||||
|
.collect::<Vec<String>>()
|
||||||
|
.join("\n")
|
||||||
|
} else {
|
||||||
|
everything_else.to_string()
|
||||||
|
};
|
||||||
|
prog.extend([&main_pre, content.as_str(), &main_post].iter().cloned());
|
||||||
|
}
|
||||||
|
|
||||||
|
debug!("final doctest:\n{prog}");
|
||||||
|
|
||||||
|
(prog, line_offset, supports_color)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn check_if_attr_is_complete(source: &str, edition: Edition) -> bool {
|
||||||
|
if source.is_empty() {
|
||||||
|
// Empty content so nothing to check in here...
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
rustc_driver::catch_fatal_errors(|| {
|
||||||
|
rustc_span::create_session_if_not_set_then(edition, |_| {
|
||||||
|
use rustc_errors::emitter::HumanEmitter;
|
||||||
|
use rustc_errors::DiagCtxt;
|
||||||
|
use rustc_span::source_map::FilePathMapping;
|
||||||
|
|
||||||
|
let filename = FileName::anon_source_code(source);
|
||||||
|
// Any errors in parsing should also appear when the doctest is compiled for real, so just
|
||||||
|
// send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
|
||||||
|
let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
|
||||||
|
let fallback_bundle = rustc_errors::fallback_fluent_bundle(
|
||||||
|
rustc_driver::DEFAULT_LOCALE_RESOURCES.to_vec(),
|
||||||
|
false,
|
||||||
|
);
|
||||||
|
|
||||||
|
let emitter = HumanEmitter::new(Box::new(io::sink()), fallback_bundle);
|
||||||
|
|
||||||
|
let dcx = DiagCtxt::new(Box::new(emitter)).disable_warnings();
|
||||||
|
let psess = ParseSess::with_dcx(dcx, sm);
|
||||||
|
let mut parser =
|
||||||
|
match new_parser_from_source_str(&psess, filename, source.to_owned()) {
|
||||||
|
Ok(p) => p,
|
||||||
|
Err(errs) => {
|
||||||
|
errs.into_iter().for_each(|err| err.cancel());
|
||||||
|
// If there is an unclosed delimiter, an error will be returned by the
|
||||||
|
// tokentrees.
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
// If a parsing error happened, it's very likely that the attribute is incomplete.
|
||||||
|
if let Err(e) = parser.parse_attribute(InnerAttrPolicy::Permitted) {
|
||||||
|
e.cancel();
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
true
|
||||||
|
})
|
||||||
|
})
|
||||||
|
.unwrap_or(false)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn partition_source(s: &str, edition: Edition) -> (String, String, String) {
|
||||||
|
#[derive(Copy, Clone, PartialEq)]
|
||||||
|
enum PartitionState {
|
||||||
|
Attrs,
|
||||||
|
Crates,
|
||||||
|
Other,
|
||||||
|
}
|
||||||
|
let mut state = PartitionState::Attrs;
|
||||||
|
let mut before = String::new();
|
||||||
|
let mut crates = String::new();
|
||||||
|
let mut after = String::new();
|
||||||
|
|
||||||
|
let mut mod_attr_pending = String::new();
|
||||||
|
|
||||||
|
for line in s.lines() {
|
||||||
|
let trimline = line.trim();
|
||||||
|
|
||||||
|
// FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
|
||||||
|
// shunted into "everything else"
|
||||||
|
match state {
|
||||||
|
PartitionState::Attrs => {
|
||||||
|
state = if trimline.starts_with("#![") {
|
||||||
|
if !check_if_attr_is_complete(line, edition) {
|
||||||
|
mod_attr_pending = line.to_owned();
|
||||||
|
} else {
|
||||||
|
mod_attr_pending.clear();
|
||||||
|
}
|
||||||
|
PartitionState::Attrs
|
||||||
|
} else if trimline.chars().all(|c| c.is_whitespace())
|
||||||
|
|| (trimline.starts_with("//") && !trimline.starts_with("///"))
|
||||||
|
{
|
||||||
|
PartitionState::Attrs
|
||||||
|
} else if trimline.starts_with("extern crate")
|
||||||
|
|| trimline.starts_with("#[macro_use] extern crate")
|
||||||
|
{
|
||||||
|
PartitionState::Crates
|
||||||
|
} else {
|
||||||
|
// First we check if the previous attribute was "complete"...
|
||||||
|
if !mod_attr_pending.is_empty() {
|
||||||
|
// If not, then we append the new line into the pending attribute to check
|
||||||
|
// if this time it's complete...
|
||||||
|
mod_attr_pending.push_str(line);
|
||||||
|
if !trimline.is_empty()
|
||||||
|
&& check_if_attr_is_complete(&mod_attr_pending, edition)
|
||||||
|
{
|
||||||
|
// If it's complete, then we can clear the pending content.
|
||||||
|
mod_attr_pending.clear();
|
||||||
|
}
|
||||||
|
// In any case, this is considered as `PartitionState::Attrs` so it's
|
||||||
|
// prepended before rustdoc's inserts.
|
||||||
|
PartitionState::Attrs
|
||||||
|
} else {
|
||||||
|
PartitionState::Other
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
PartitionState::Crates => {
|
||||||
|
state = if trimline.starts_with("extern crate")
|
||||||
|
|| trimline.starts_with("#[macro_use] extern crate")
|
||||||
|
|| trimline.chars().all(|c| c.is_whitespace())
|
||||||
|
|| (trimline.starts_with("//") && !trimline.starts_with("///"))
|
||||||
|
{
|
||||||
|
PartitionState::Crates
|
||||||
|
} else {
|
||||||
|
PartitionState::Other
|
||||||
|
};
|
||||||
|
}
|
||||||
|
PartitionState::Other => {}
|
||||||
|
}
|
||||||
|
|
||||||
|
match state {
|
||||||
|
PartitionState::Attrs => {
|
||||||
|
before.push_str(line);
|
||||||
|
before.push('\n');
|
||||||
|
}
|
||||||
|
PartitionState::Crates => {
|
||||||
|
crates.push_str(line);
|
||||||
|
crates.push('\n');
|
||||||
|
}
|
||||||
|
PartitionState::Other => {
|
||||||
|
after.push_str(line);
|
||||||
|
after.push('\n');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
debug!("before:\n{before}");
|
||||||
|
debug!("crates:\n{crates}");
|
||||||
|
debug!("after:\n{after}");
|
||||||
|
|
||||||
|
(before, after, crates)
|
||||||
|
}
|
||||||
Loading…
x
Reference in New Issue
Block a user