mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clean up rustdoc make_test function code

Browse Source
This commit is contained in:
Guillaume Gomez 2024-06-08 13:46:02 +02:00
parent 80eb5a8e91
commit 05fbfde17d
1 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
src/librustdoc/doctest/make.rs
View File

@ -25,6 +25,7 @@ pub(crate) fn make_test(
dont_insert_main: bool, dont_insert_main: bool,
opts: &GlobalTestOptions, opts: &GlobalTestOptions,
edition: Edition, edition: Edition,
// If `test_id` is `None`, it means we're generating code for a code example "run" link.
test_id: Option<&str>, test_id: Option<&str>,
) -> (String, usize, bool) { ) -> (String, usize, bool) {
let (crate_attrs, everything_else, crates) = partition_source(s, edition); let (crate_attrs, everything_else, crates) = partition_source(s, edition);
@ -65,21 +66,22 @@ pub(crate) fn make_test(
// Don't inject `extern crate std` because it's already injected by the // Don't inject `extern crate std` because it's already injected by the
// compiler. // compiler.
if !already_has_extern_crate && !opts.no_crate_inject && crate_name != Some("std") { if !already_has_extern_crate &&
if let Some(crate_name) = crate_name { !opts.no_crate_inject &&
// Don't inject `extern crate` if the crate is never used. let Some(crate_name) = crate_name &&
// NOTE: this is terribly inaccurate because it doesn't actually crate_name != "std" &&
// parse the source, but only has false positives, not false // Don't inject `extern crate` if the crate is never used.
// negatives. // NOTE: this is terribly inaccurate because it doesn't actually
if s.contains(crate_name) { // parse the source, but only has false positives, not false
// rustdoc implicitly inserts an `extern crate` item for the own crate // negatives.
// which may be unused, so we need to allow the lint. s.contains(crate_name)
prog.push_str("#[allow(unused_extern_crates)]\n"); {
// 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")); prog.push_str(&format!("extern crate r#{crate_name};\n"));
line_offset += 1; line_offset += 1;
}
}
} }
// FIXME: This code cannot yet handle no_std test cases yet // FIXME: This code cannot yet handle no_std test cases yet
@ -234,22 +236,20 @@ fn check_for_main_and_extern_crate(
(found_main, found_extern_crate, found_macro) (found_main, found_extern_crate, found_macro)
}) })
}); });
let (already_has_main, already_has_extern_crate, found_macro) = result?; let (mut already_has_main, already_has_extern_crate, found_macro) = result?;
// If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't // 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 // 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 // function written inside a macro invocation. See
// https://github.com/rust-lang/rust/issues/56898 // https://github.com/rust-lang/rust/issues/56898
let already_has_main = if found_macro && !already_has_main { if found_macro && !already_has_main {
source already_has_main = source
.lines() .lines()
.map(|line| { .map(|line| {
let comment = line.find("//"); let comment = line.find("//");
if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line } if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
}) })
.any(|code| code.contains("fn main")) .any(|code| code.contains("fn main"));
} else {
already_has_main
}; };
Ok((already_has_main, already_has_extern_crate)) Ok((already_has_main, already_has_extern_crate))