Skip to content

Commit

Permalink
Wrap iter_header callback arguments in a documentable struct
Browse files Browse the repository at this point in the history
  • Loading branch information
Zalathar committed Feb 17, 2024
1 parent ba824a2 commit 5ae41d1
Showing 1 changed file with 24 additions and 12 deletions.
36 changes: 24 additions & 12 deletions src/tools/compiletest/src/header.rs
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ impl EarlyProps {
&mut poisoned,
testfile,
rdr,
&mut |_, _, ln, _| {
&mut |HeaderLine { directive: ln, .. }| {
config.push_name_value_directive(ln, directives::AUX_BUILD, &mut props.aux, |r| {
r.trim().to_string()
});
Expand Down Expand Up @@ -329,8 +329,8 @@ impl TestProps {
&mut poisoned,
testfile,
file,
&mut |revision, _, ln, _| {
if revision.is_some() && revision != cfg {
&mut |HeaderLine { header_revision, directive: ln, .. }| {
if header_revision.is_some() && header_revision != cfg {
return;
}

Expand Down Expand Up @@ -677,7 +677,7 @@ fn iter_header<R: Read>(
poisoned: &mut bool,
testfile: &Path,
rdr: R,
it: &mut dyn FnMut(Option<&str>, &str, &str, usize),
it: &mut dyn FnMut(HeaderLine<'_>),
) {
iter_header_extra(mode, suite, poisoned, testfile, rdr, &[], it)
}
Expand Down Expand Up @@ -800,14 +800,26 @@ const DIAGNOSTICS_DIRECTIVE_NAMES: &[&str] = &[
"unset-rustc-env",
];

/// Arguments passed to the callback in [`iter_header`].
struct HeaderLine<'ln> {
/// Contents of the square brackets preceding this header, if present.
header_revision: Option<&'ln str>,
/// Raw line from the test file, including comment prefix and any revision.
original_line: &'ln str,
/// Remainder of the directive line, after the initial comment prefix
/// (`//` or `//@` or `#`) and revision (if any) have been stripped.
directive: &'ln str,
line_number: usize,
}

fn iter_header_extra(
mode: Mode,
suite: &str,
poisoned: &mut bool,
testfile: &Path,
rdr: impl Read,
extra_directives: &[&str],
it: &mut dyn FnMut(Option<&str>, &str, &str, usize),
it: &mut dyn FnMut(HeaderLine<'_>),
) {
if testfile.is_dir() {
return;
Expand All @@ -816,7 +828,7 @@ fn iter_header_extra(
// Process any extra directives supplied by the caller (e.g. because they
// are implied by the test mode), with a dummy line number of 0.
for directive in extra_directives {
it(None, directive, directive, 0);
it(HeaderLine { header_revision: None, original_line: "", directive, line_number: 0 });
}

let comment = if testfile.extension().is_some_and(|e| e == "rs") {
Expand All @@ -841,14 +853,14 @@ fn iter_header_extra(
// Assume that any directives will be found before the first
// module or function. This doesn't seem to be an optimization
// with a warm page cache. Maybe with a cold one.
let orig_ln = &ln;
let original_line = &ln;
let ln = ln.trim();
if ln.starts_with("fn") || ln.starts_with("mod") {
return;

// First try to accept `ui_test` style comments
} else if let Some((lncfg, ln)) = line_directive(comment, ln) {
it(lncfg, orig_ln, ln, line_number);
} else if let Some((header_revision, directive)) = line_directive(comment, ln) {
it(HeaderLine { header_revision, original_line, directive, line_number });
} else if mode == Mode::Ui && suite == "ui" && !revision_magic_comment.is_match(ln) {
let Some((_, rest)) = line_directive("//", ln) else {
continue;
Expand Down Expand Up @@ -1177,8 +1189,8 @@ pub fn make_test_description<R: Read>(
path,
src,
extra_directives,
&mut |revision, og_ln, ln, line_number| {
if revision.is_some() && revision != cfg {
&mut |HeaderLine { header_revision, original_line, directive: ln, line_number }| {
if header_revision.is_some() && header_revision != cfg {
return;
}

Expand All @@ -1202,7 +1214,7 @@ pub fn make_test_description<R: Read>(
};
}

if let Some((_, post)) = og_ln.trim_start().split_once("//") {
if let Some((_, post)) = original_line.trim_start().split_once("//") {
let post = post.trim_start();
if post.starts_with("ignore-tidy")
&& config.mode == Mode::Ui
Expand Down

0 comments on commit 5ae41d1

Please sign in to comment.