Skip to content
This repository was archived by the owner on May 28, 2025. It is now read-only.

Commit a0991b8

Browse files
matthiaskrgrmatthiaskrgr
authored
Rollup merge of rust-lang#99987 - Alexendoo:parse-format-position-span, r=fee1-dead
Always include a position span in `rustc_parse_format::Argument` Moves the spans from the `Position` enum to always be included in the `Argument` struct. Doesn't make any changes to use it in rustc, but it will be useful for some upcoming Clippy lints
2 parents 792bc5a + 2a0b51d commit a0991b8

File tree

6 files changed

+96
-41
lines changed

6 files changed

+96
-41
lines changed

‎compiler/rustc_builtin_macros/src/asm.rs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -656,7 +656,7 @@ fn expand_preparsed_asm(ecx: &mut ExtCtxt<'_>, args: AsmArgs) -> Option<ast::Inl
656656
let span = arg_spans.next().unwrap_or(template_sp);
657657

658658
let operand_idx = match arg.position {
659-
parse::ArgumentIs(idx, _) | parse::ArgumentImplicitlyIs(idx) => {
659+
parse::ArgumentIs(idx) | parse::ArgumentImplicitlyIs(idx) => {
660660
if idx >= args.operands.len()
661661
|| named_pos.contains_key(&idx)
662662
|| args.reg_args.contains(&idx)
@@ -702,11 +702,12 @@ fn expand_preparsed_asm(ecx: &mut ExtCtxt<'_>, args: AsmArgs) -> Option<ast::Inl
702702
Some(idx)
703703
}
704704
}
705-
parse::ArgumentNamed(name, span) => {
705+
parse::ArgumentNamed(name) => {
706706
match args.named_args.get(&Symbol::intern(name)) {
707707
Some(&idx) => Some(idx),
708708
None => {
709709
let msg = format!("there is no argument named `{}`", name);
710+
let span = arg.position_span;
710711
ecx.struct_span_err(
711712
template_span
712713
.from_inner(InnerSpan::new(span.start, span.end)),

‎compiler/rustc_builtin_macros/src/format.rs‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -381,8 +381,8 @@ impl<'a, 'b> Context<'a, 'b> {
381381
match *p {
382382
parse::String(_) => {}
383383
parse::NextArgument(ref mut arg) => {
384-
if let parse::ArgumentNamed(s, _) = arg.position {
385-
arg.position = parse::ArgumentIs(lookup(s), None);
384+
if let parse::ArgumentNamed(s) = arg.position {
385+
arg.position = parse::ArgumentIs(lookup(s));
386386
}
387387
if let parse::CountIsName(s, _) = arg.format.width {
388388
arg.format.width = parse::CountIsParam(lookup(s));
@@ -417,14 +417,14 @@ impl<'a, 'b> Context<'a, 'b> {
417417
// argument second, if it's an implicit positional parameter
418418
// it's written second, so it should come after width/precision.
419419
let pos = match arg.position {
420-
parse::ArgumentIs(i, arg_end) => {
420+
parse::ArgumentIs(i) => {
421421
self.unused_names_lint.maybe_add_positional_named_arg(
422422
i,
423423
self.args.len(),
424424
i,
425425
PositionalNamedArgType::Arg,
426426
self.curpiece,
427-
arg_end,
427+
Some(arg.position_span),
428428
&self.names,
429429
);
430430

@@ -442,8 +442,9 @@ impl<'a, 'b> Context<'a, 'b> {
442442
);
443443
Exact(i)
444444
}
445-
parse::ArgumentNamed(s, span) => {
445+
parse::ArgumentNamed(s) => {
446446
let symbol = Symbol::intern(s);
447+
let span = arg.position_span;
447448
Named(symbol, InnerSpan::new(span.start, span.end))
448449
}
449450
};
@@ -878,8 +879,9 @@ impl<'a, 'b> Context<'a, 'b> {
878879
// track the current argument ourselves.
879880
let i = self.curarg;
880881
self.curarg += 1;
881-
parse::ArgumentIs(i, None)
882+
parse::ArgumentIs(i)
882883
},
884+
position_span: arg.position_span,
883885
format: parse::FormatSpec {
884886
fill: arg.format.fill,
885887
align: parse::AlignUnknown,

‎compiler/rustc_parse_format/src/lib.rs‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,9 @@ pub enum Piece<'a> {
7070
pub struct Argument<'a> {
7171
/// Where to find this argument
7272
pub position: Position<'a>,
73+
/// The span of the position indicator. Includes any whitespace in implicit
74+
/// positions (`{ }`).
75+
pub position_span: InnerSpan,
7376
/// How to format the argument
7477
pub format: FormatSpec<'a>,
7578
}
@@ -105,9 +108,9 @@ pub enum Position<'a> {
105108
/// The argument is implied to be located at an index
106109
ArgumentImplicitlyIs(usize),
107110
/// The argument is located at a specific index given in the format,
108-
ArgumentIs(usize, Option<InnerSpan>),
111+
ArgumentIs(usize),
109112
/// The argument has a name.
110-
ArgumentNamed(&'a str, InnerSpan),
113+
ArgumentNamed(&'a str),
111114
}
112115

113116
impl Position<'_> {
@@ -216,14 +219,15 @@ impl<'a> Iterator for Parser<'a> {
216219
'{' => {
217220
let curr_last_brace = self.last_opening_brace;
218221
let byte_pos = self.to_span_index(pos);
219-
self.last_opening_brace = Some(byte_pos.to(InnerOffset(byte_pos.0 + 1)));
222+
let lbrace_end = InnerOffset(byte_pos.0 + 1);
223+
self.last_opening_brace = Some(byte_pos.to(lbrace_end));
220224
self.cur.next();
221225
if self.consume('{') {
222226
self.last_opening_brace = curr_last_brace;
223227

224228
Some(String(self.string(pos + 1)))
225229
} else {
226-
let arg = self.argument();
230+
let arg = self.argument(lbrace_end);
227231
if let Some(rbrace_byte_idx) = self.must_consume('}') {
228232
let lbrace_inner_offset = self.to_span_index(pos);
229233
let rbrace_inner_offset = self.to_span_index(rbrace_byte_idx);
@@ -477,8 +481,16 @@ impl<'a> Parser<'a> {
477481
}
478482

479483
/// Parses an `Argument` structure, or what's contained within braces inside the format string.
480-
fn argument(&mut self) -> Argument<'a> {
484+
fn argument(&mut self, start: InnerOffset) -> Argument<'a> {
481485
let pos = self.position();
486+
487+
let end = self
488+
.cur
489+
.clone()
490+
.find(|(_, ch)| !ch.is_whitespace())
491+
.map_or(start, |(end, _)| self.to_span_index(end));
492+
let position_span = start.to(end);
493+
482494
let format = match self.mode {
483495
ParseMode::Format => self.format(),
484496
ParseMode::InlineAsm => self.inline_asm(),
@@ -494,31 +506,19 @@ impl<'a> Parser<'a> {
494506
}
495507
};
496508

497-
Argument { position: pos, format }
509+
Argument { position: pos, position_span, format }
498510
}
499511

500512
/// Parses a positional argument for a format. This could either be an
501513
/// integer index of an argument, a named argument, or a blank string.
502514
/// Returns `Some(parsed_position)` if the position is not implicitly
503515
/// consuming a macro argument, `None` if it's the case.
504516
fn position(&mut self) -> Option<Position<'a>> {
505-
let start_position = self.cur.peek().map(|item| item.0);
506517
if let Some(i) = self.integer() {
507-
let inner_span = start_position.and_then(|start| {
508-
self.cur
509-
.peek()
510-
.cloned()
511-
.and_then(|item| Some(self.to_span_index(start).to(self.to_span_index(item.0))))
512-
});
513-
Some(ArgumentIs(i, inner_span))
518+
Some(ArgumentIs(i))
514519
} else {
515520
match self.cur.peek() {
516-
Some(&(start, c)) if rustc_lexer::is_id_start(c) => {
517-
let word = self.word();
518-
let end = start + word.len();
519-
let span = self.to_span_index(start).to(self.to_span_index(end));
520-
Some(ArgumentNamed(word, span))
521-
}
521+
Some(&(_, c)) if rustc_lexer::is_id_start(c) => Some(ArgumentNamed(self.word())),
522522

523523
// This is an `ArgumentNext`.
524524
// Record the fact and do the resolution after parsing the

‎compiler/rustc_parse_format/src/tests.rs‎

Lines changed: 61 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,22 @@ fn invalid06() {
5858

5959
#[test]
6060
fn format_nothing() {
61-
same("{}", &[NextArgument(Argument { position: ArgumentImplicitlyIs(0), format: fmtdflt() })]);
61+
same(
62+
"{}",
63+
&[NextArgument(Argument {
64+
position: ArgumentImplicitlyIs(0),
65+
position_span: InnerSpan { start: 2, end: 2 },
66+
format: fmtdflt(),
67+
})],
68+
);
6269
}
6370
#[test]
6471
fn format_position() {
6572
same(
6673
"{3}",
6774
&[NextArgument(Argument {
68-
position: ArgumentIs(3, Some(InnerSpan { start: 2, end: 3 })),
75+
position: ArgumentIs(3),
76+
position_span: InnerSpan { start: 2, end: 3 },
6977
format: fmtdflt(),
7078
})],
7179
);
@@ -75,17 +83,30 @@ fn format_position_nothing_else() {
7583
same(
7684
"{3:}",
7785
&[NextArgument(Argument {
78-
position: ArgumentIs(3, Some(InnerSpan { start: 2, end: 3 })),
86+
position: ArgumentIs(3),
87+
position_span: InnerSpan { start: 2, end: 3 },
7988
format: fmtdflt(),
8089
})],
8190
);
8291
}
8392
#[test]
93+
fn format_named() {
94+
same(
95+
"{name}",
96+
&[NextArgument(Argument {
97+
position: ArgumentNamed("name"),
98+
position_span: InnerSpan { start: 2, end: 6 },
99+
format: fmtdflt(),
100+
})],
101+
)
102+
}
103+
#[test]
84104
fn format_type() {
85105
same(
86106
"{3:x}",
87107
&[NextArgument(Argument {
88-
position: ArgumentIs(3, Some(InnerSpan { start: 2, end: 3 })),
108+
position: ArgumentIs(3),
109+
position_span: InnerSpan { start: 2, end: 3 },
89110
format: FormatSpec {
90111
fill: None,
91112
align: AlignUnknown,
@@ -105,7 +126,8 @@ fn format_align_fill() {
105126
same(
106127
"{3:>}",
107128
&[NextArgument(Argument {
108-
position: ArgumentIs(3, Some(InnerSpan { start: 2, end: 3 })),
129+
position: ArgumentIs(3),
130+
position_span: InnerSpan { start: 2, end: 3 },
109131
format: FormatSpec {
110132
fill: None,
111133
align: AlignRight,
@@ -122,7 +144,8 @@ fn format_align_fill() {
122144
same(
123145
"{3:0<}",
124146
&[NextArgument(Argument {
125-
position: ArgumentIs(3, Some(InnerSpan { start: 2, end: 3 })),
147+
position: ArgumentIs(3),
148+
position_span: InnerSpan { start: 2, end: 3 },
126149
format: FormatSpec {
127150
fill: Some('0'),
128151
align: AlignLeft,
@@ -139,7 +162,8 @@ fn format_align_fill() {
139162
same(
140163
"{3:*<abcd}",
141164
&[NextArgument(Argument {
142-
position: ArgumentIs(3, Some(InnerSpan { start: 2, end: 3 })),
165+
position: ArgumentIs(3),
166+
position_span: InnerSpan { start: 2, end: 3 },
143167
format: FormatSpec {
144168
fill: Some('*'),
145169
align: AlignLeft,
@@ -160,6 +184,7 @@ fn format_counts() {
160184
"{:10x}",
161185
&[NextArgument(Argument {
162186
position: ArgumentImplicitlyIs(0),
187+
position_span: InnerSpan { start: 2, end: 2 },
163188
format: FormatSpec {
164189
fill: None,
165190
align: AlignUnknown,
@@ -177,6 +202,7 @@ fn format_counts() {
177202
"{:10$.10x}",
178203
&[NextArgument(Argument {
179204
position: ArgumentImplicitlyIs(0),
205+
position_span: InnerSpan { start: 2, end: 2 },
180206
format: FormatSpec {
181207
fill: None,
182208
align: AlignUnknown,
@@ -193,7 +219,8 @@ fn format_counts() {
193219
same(
194220
"{1:0$.10x}",
195221
&[NextArgument(Argument {
196-
position: ArgumentIs(1, Some(InnerSpan { start: 2, end: 3 })),
222+
position: ArgumentIs(1),
223+
position_span: InnerSpan { start: 2, end: 3 },
197224
format: FormatSpec {
198225
fill: None,
199226
align: AlignUnknown,
@@ -211,6 +238,7 @@ fn format_counts() {
211238
"{:.*x}",
212239
&[NextArgument(Argument {
213240
position: ArgumentImplicitlyIs(1),
241+
position_span: InnerSpan { start: 2, end: 2 },
214242
format: FormatSpec {
215243
fill: None,
216244
align: AlignUnknown,
@@ -228,6 +256,7 @@ fn format_counts() {
228256
"{:.10$x}",
229257
&[NextArgument(Argument {
230258
position: ArgumentImplicitlyIs(0),
259+
position_span: InnerSpan { start: 2, end: 2 },
231260
format: FormatSpec {
232261
fill: None,
233262
align: AlignUnknown,
@@ -245,6 +274,7 @@ fn format_counts() {
245274
"{:a$.b$?}",
246275
&[NextArgument(Argument {
247276
position: ArgumentImplicitlyIs(0),
277+
position_span: InnerSpan { start: 2, end: 2 },
248278
format: FormatSpec {
249279
fill: None,
250280
align: AlignUnknown,
@@ -265,6 +295,7 @@ fn format_flags() {
265295
"{:-}",
266296
&[NextArgument(Argument {
267297
position: ArgumentImplicitlyIs(0),
298+
position_span: InnerSpan { start: 2, end: 2 },
268299
format: FormatSpec {
269300
fill: None,
270301
align: AlignUnknown,
@@ -282,6 +313,7 @@ fn format_flags() {
282313
"{:+#}",
283314
&[NextArgument(Argument {
284315
position: ArgumentImplicitlyIs(0),
316+
position_span: InnerSpan { start: 2, end: 2 },
285317
format: FormatSpec {
286318
fill: None,
287319
align: AlignUnknown,
@@ -303,7 +335,8 @@ fn format_mixture() {
303335
&[
304336
String("abcd "),
305337
NextArgument(Argument {
306-
position: ArgumentIs(3, Some(InnerSpan { start: 7, end: 8 })),
338+
position: ArgumentIs(3),
339+
position_span: InnerSpan { start: 7, end: 8 },
307340
format: FormatSpec {
308341
fill: None,
309342
align: AlignUnknown,
@@ -320,3 +353,22 @@ fn format_mixture() {
320353
],
321354
);
322355
}
356+
#[test]
357+
fn format_whitespace() {
358+
same(
359+
"{ }",
360+
&[NextArgument(Argument {
361+
position: ArgumentImplicitlyIs(0),
362+
position_span: InnerSpan { start: 2, end: 3 },
363+
format: fmtdflt(),
364+
})],
365+
);
366+
same(
367+
"{ }",
368+
&[NextArgument(Argument {
369+
position: ArgumentImplicitlyIs(0),
370+
position_span: InnerSpan { start: 2, end: 4 },
371+
format: fmtdflt(),
372+
})],
373+
);
374+
}

‎compiler/rustc_trait_selection/src/traits/on_unimplemented.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ impl<'tcx> OnUnimplementedFormatString {
300300
match token {
301301
Piece::String(_) => (), // Normal string, no need to check it
302302
Piece::NextArgument(a) => match a.position {
303-
Position::ArgumentNamed(s, _) => {
303+
Position::ArgumentNamed(s) => {
304304
match Symbol::intern(s) {
305305
// `{Self}` is allowed
306306
kw::SelfUpper => (),
@@ -386,7 +386,7 @@ impl<'tcx> OnUnimplementedFormatString {
386386
.map(|p| match p {
387387
Piece::String(s) => s,
388388
Piece::NextArgument(a) => match a.position {
389-
Position::ArgumentNamed(s, _) => {
389+
Position::ArgumentNamed(s) => {
390390
let s = Symbol::intern(s);
391391
match generic_map.get(&s) {
392392
Some(val) => val,

‎src/tools/clippy/clippy_lints/src/write.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -441,7 +441,7 @@ impl SimpleFormatArgs {
441441
};
442442

443443
match arg.position {
444-
ArgumentIs(n, _) | ArgumentImplicitlyIs(n) => {
444+
ArgumentIs(n) | ArgumentImplicitlyIs(n) => {
445445
if self.unnamed.len() <= n {
446446
// Use a dummy span to mark all unseen arguments.
447447
self.unnamed.resize_with(n, || vec![DUMMY_SP]);
@@ -462,7 +462,7 @@ impl SimpleFormatArgs {
462462
}
463463
}
464464
},
465-
ArgumentNamed(n, _) => {
465+
ArgumentNamed(n) => {
466466
let n = Symbol::intern(n);
467467
if let Some(x) = self.named.iter_mut().find(|x| x.0 == n) {
468468
match x.1.as_slice() {

0 commit comments

Comments
 (0)