Skip to content

Commit 3e97763

Browse files
borsbors
committed
Auto merge of #106745 - m-ou-se:format-args-ast, r=oli-obk
Move format_args!() into AST (and expand it during AST lowering) Implements rust-lang/compiler-team#541 This moves FormatArgs from rustc_builtin_macros to rustc_ast_lowering. For now, the end result is the same. But this allows for future changes to do smarter things with format_args!(). It also allows Clippy to directly access the ast::FormatArgs, making things a lot easier. This change turns the format args types into lang items. The builtin macro used to refer to them by their path. After this change, the path is no longer relevant, making it easier to make changes in `core`. This updates clippy to use the new language items, but this doesn't yet make clippy use the ast::FormatArgs structure that's now available. That should be done after this is merged.
2 parents 40fda7b + db731e4 commit 3e97763

File tree

32 files changed

+750
-449
lines changed

32 files changed

+750
-449
lines changed

‎Cargo.lock

+1
Original file line numberDiff line numberDiff line change
@@ -3729,6 +3729,7 @@ name = "rustc_ast_pretty"
37293729
version = "0.0.0"
37303730
dependencies = [
37313731
"rustc_ast",
3732+
"rustc_parse_format",
37323733
"rustc_span",
37333734
]
37343735

‎compiler/rustc_ast/src/ast.rs

+5
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
//! - [`Attribute`]: Metadata associated with item.
1919
//! - [`UnOp`], [`BinOp`], and [`BinOpKind`]: Unary and binary operators.
2020
21+
pub use crate::format::*;
2122
pub use crate::util::parser::ExprPrecedence;
2223
pub use GenericArgs::*;
2324
pub use UnsafeSource::*;
@@ -1269,6 +1270,7 @@ impl Expr {
12691270
ExprKind::Try(..) => ExprPrecedence::Try,
12701271
ExprKind::Yield(..) => ExprPrecedence::Yield,
12711272
ExprKind::Yeet(..) => ExprPrecedence::Yeet,
1273+
ExprKind::FormatArgs(..) => ExprPrecedence::FormatArgs,
12721274
ExprKind::Err => ExprPrecedence::Err,
12731275
}
12741276
}
@@ -1499,6 +1501,9 @@ pub enum ExprKind {
14991501
/// with a `ByteStr` literal.
15001502
IncludedBytes(Lrc<[u8]>),
15011503

1504+
/// A `format_args!()` expression.
1505+
FormatArgs(P<FormatArgs>),
1506+
15021507
/// Placeholder for an expression that wasn't syntactically well formed in some way.
15031508
Err,
15041509
}

‎compiler/rustc_builtin_macros/src/format/ast.rs ‎compiler/rustc_ast/src/format.rs

+26-16
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
use rustc_ast::ptr::P;
2-
use rustc_ast::Expr;
1+
use crate::ptr::P;
2+
use crate::Expr;
33
use rustc_data_structures::fx::FxHashMap;
44
use rustc_span::symbol::{Ident, Symbol};
55
use rustc_span::Span;
@@ -39,7 +39,7 @@ use rustc_span::Span;
3939
/// Basically the "AST" for a complete `format_args!()`.
4040
///
4141
/// E.g., `format_args!("hello {name}");`.
42-
#[derive(Clone, Debug)]
42+
#[derive(Clone, Encodable, Decodable, Debug)]
4343
pub struct FormatArgs {
4444
pub span: Span,
4545
pub template: Vec<FormatArgsPiece>,
@@ -49,7 +49,7 @@ pub struct FormatArgs {
4949
/// A piece of a format template string.
5050
///
5151
/// E.g. "hello" or "{name}".
52-
#[derive(Clone, Debug)]
52+
#[derive(Clone, Encodable, Decodable, Debug)]
5353
pub enum FormatArgsPiece {
5454
Literal(Symbol),
5555
Placeholder(FormatPlaceholder),
@@ -59,14 +59,20 @@ pub enum FormatArgsPiece {
5959
///
6060
/// E.g. `1, 2, name="ferris", n=3`,
6161
/// but also implicit captured arguments like `x` in `format_args!("{x}")`.
62-
#[derive(Clone, Debug)]
62+
#[derive(Clone, Encodable, Decodable, Debug)]
6363
pub struct FormatArguments {
6464
arguments: Vec<FormatArgument>,
6565
num_unnamed_args: usize,
6666
num_explicit_args: usize,
6767
names: FxHashMap<Symbol, usize>,
6868
}
6969

70+
// FIXME: Rustdoc has trouble proving Send/Sync for this. See #106930.
71+
#[cfg(parallel_compiler)]
72+
unsafe impl Sync for FormatArguments {}
73+
#[cfg(parallel_compiler)]
74+
unsafe impl Send for FormatArguments {}
75+
7076
impl FormatArguments {
7177
pub fn new() -> Self {
7278
Self {
@@ -121,18 +127,22 @@ impl FormatArguments {
121127
&self.arguments[..self.num_explicit_args]
122128
}
123129

124-
pub fn into_vec(self) -> Vec<FormatArgument> {
125-
self.arguments
130+
pub fn all_args(&self) -> &[FormatArgument] {
131+
&self.arguments[..]
132+
}
133+
134+
pub fn all_args_mut(&mut self) -> &mut [FormatArgument] {
135+
&mut self.arguments[..]
126136
}
127137
}
128138

129-
#[derive(Clone, Debug)]
139+
#[derive(Clone, Encodable, Decodable, Debug)]
130140
pub struct FormatArgument {
131141
pub kind: FormatArgumentKind,
132142
pub expr: P<Expr>,
133143
}
134144

135-
#[derive(Clone, Debug)]
145+
#[derive(Clone, Encodable, Decodable, Debug)]
136146
pub enum FormatArgumentKind {
137147
/// `format_args(…, arg)`
138148
Normal,
@@ -152,7 +162,7 @@ impl FormatArgumentKind {
152162
}
153163
}
154164

155-
#[derive(Clone, Debug, PartialEq, Eq)]
165+
#[derive(Clone, Encodable, Decodable, Debug, PartialEq, Eq)]
156166
pub struct FormatPlaceholder {
157167
/// Index into [`FormatArgs::arguments`].
158168
pub argument: FormatArgPosition,
@@ -164,7 +174,7 @@ pub struct FormatPlaceholder {
164174
pub format_options: FormatOptions,
165175
}
166176

167-
#[derive(Clone, Debug, PartialEq, Eq)]
177+
#[derive(Clone, Encodable, Decodable, Debug, PartialEq, Eq)]
168178
pub struct FormatArgPosition {
169179
/// Which argument this position refers to (Ok),
170180
/// or would've referred to if it existed (Err).
@@ -175,7 +185,7 @@ pub struct FormatArgPosition {
175185
pub span: Option<Span>,
176186
}
177187

178-
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
188+
#[derive(Copy, Clone, Encodable, Decodable, Debug, PartialEq, Eq)]
179189
pub enum FormatArgPositionKind {
180190
/// `{}` or `{:.*}`
181191
Implicit,
@@ -185,7 +195,7 @@ pub enum FormatArgPositionKind {
185195
Named,
186196
}
187197

188-
#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
198+
#[derive(Copy, Clone, Encodable, Decodable, Debug, PartialEq, Eq, Hash)]
189199
pub enum FormatTrait {
190200
/// `{}`
191201
Display,
@@ -207,7 +217,7 @@ pub enum FormatTrait {
207217
UpperHex,
208218
}
209219

210-
#[derive(Clone, Debug, Default, PartialEq, Eq)]
220+
#[derive(Clone, Encodable, Decodable, Default, Debug, PartialEq, Eq)]
211221
pub struct FormatOptions {
212222
/// The width. E.g. `{:5}` or `{:width$}`.
213223
pub width: Option<FormatCount>,
@@ -221,7 +231,7 @@ pub struct FormatOptions {
221231
pub flags: u32,
222232
}
223233

224-
#[derive(Clone, Debug, PartialEq, Eq)]
234+
#[derive(Copy, Clone, Encodable, Decodable, Debug, PartialEq, Eq)]
225235
pub enum FormatAlignment {
226236
/// `{:<}`
227237
Left,
@@ -231,7 +241,7 @@ pub enum FormatAlignment {
231241
Center,
232242
}
233243

234-
#[derive(Clone, Debug, PartialEq, Eq)]
244+
#[derive(Clone, Encodable, Decodable, Debug, PartialEq, Eq)]
235245
pub enum FormatCount {
236246
/// `{:5}` or `{:.5}`
237247
Literal(usize),

‎compiler/rustc_ast/src/lib.rs

+2
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ pub mod ast_traits;
4242
pub mod attr;
4343
pub mod entry;
4444
pub mod expand;
45+
pub mod format;
4546
pub mod mut_visit;
4647
pub mod node_id;
4748
pub mod ptr;
@@ -51,6 +52,7 @@ pub mod visit;
5152

5253
pub use self::ast::*;
5354
pub use self::ast_traits::{AstDeref, AstNodeWrapper, HasAttrs, HasNodeId, HasSpan, HasTokens};
55+
pub use self::format::*;
5456

5557
use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
5658

‎compiler/rustc_ast/src/mut_visit.rs

+14
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,10 @@ pub trait MutVisitor: Sized {
297297
fn visit_inline_asm_sym(&mut self, sym: &mut InlineAsmSym) {
298298
noop_visit_inline_asm_sym(sym, self)
299299
}
300+
301+
fn visit_format_args(&mut self, fmt: &mut FormatArgs) {
302+
noop_visit_format_args(fmt, self)
303+
}
300304
}
301305

302306
/// Use a map-style function (`FnOnce(T) -> T`) to overwrite a `&mut T`. Useful
@@ -1284,6 +1288,15 @@ pub fn noop_visit_inline_asm_sym<T: MutVisitor>(
12841288
vis.visit_path(path);
12851289
}
12861290

1291+
pub fn noop_visit_format_args<T: MutVisitor>(fmt: &mut FormatArgs, vis: &mut T) {
1292+
for arg in fmt.arguments.all_args_mut() {
1293+
if let FormatArgumentKind::Named(name) = &mut arg.kind {
1294+
vis.visit_ident(name);
1295+
}
1296+
vis.visit_expr(&mut arg.expr);
1297+
}
1298+
}
1299+
12871300
pub fn noop_visit_expr<T: MutVisitor>(
12881301
Expr { kind, id, span, attrs, tokens }: &mut Expr,
12891302
vis: &mut T,
@@ -1425,6 +1438,7 @@ pub fn noop_visit_expr<T: MutVisitor>(
14251438
visit_opt(expr, |expr| vis.visit_expr(expr));
14261439
}
14271440
ExprKind::InlineAsm(asm) => vis.visit_inline_asm(asm),
1441+
ExprKind::FormatArgs(fmt) => vis.visit_format_args(fmt),
14281442
ExprKind::MacCall(mac) => vis.visit_mac_call(mac),
14291443
ExprKind::Struct(se) => {
14301444
let StructExpr { qself, path, fields, rest } = se.deref_mut();

‎compiler/rustc_ast/src/util/parser.rs

+3-1
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,7 @@ pub enum ExprPrecedence {
271271
Try,
272272
InlineAsm,
273273
Mac,
274+
FormatArgs,
274275

275276
Array,
276277
Repeat,
@@ -335,7 +336,8 @@ impl ExprPrecedence {
335336
| ExprPrecedence::Index
336337
| ExprPrecedence::Try
337338
| ExprPrecedence::InlineAsm
338-
| ExprPrecedence::Mac => PREC_POSTFIX,
339+
| ExprPrecedence::Mac
340+
| ExprPrecedence::FormatArgs => PREC_POSTFIX,
339341

340342
// Never need parens
341343
ExprPrecedence::Array

‎compiler/rustc_ast/src/visit.rs

+13
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,9 @@ pub trait Visitor<'ast>: Sized {
242242
fn visit_inline_asm(&mut self, asm: &'ast InlineAsm) {
243243
walk_inline_asm(self, asm)
244244
}
245+
fn visit_format_args(&mut self, fmt: &'ast FormatArgs) {
246+
walk_format_args(self, fmt)
247+
}
245248
fn visit_inline_asm_sym(&mut self, sym: &'ast InlineAsmSym) {
246249
walk_inline_asm_sym(self, sym)
247250
}
@@ -756,6 +759,15 @@ pub fn walk_inline_asm_sym<'a, V: Visitor<'a>>(visitor: &mut V, sym: &'a InlineA
756759
visitor.visit_path(&sym.path, sym.id);
757760
}
758761

762+
pub fn walk_format_args<'a, V: Visitor<'a>>(visitor: &mut V, fmt: &'a FormatArgs) {
763+
for arg in fmt.arguments.all_args() {
764+
if let FormatArgumentKind::Named(name) = arg.kind {
765+
visitor.visit_ident(name);
766+
}
767+
visitor.visit_expr(&arg.expr);
768+
}
769+
}
770+
759771
pub fn walk_expr<'a, V: Visitor<'a>>(visitor: &mut V, expression: &'a Expr) {
760772
walk_list!(visitor, visit_attribute, expression.attrs.iter());
761773

@@ -896,6 +908,7 @@ pub fn walk_expr<'a, V: Visitor<'a>>(visitor: &mut V, expression: &'a Expr) {
896908
ExprKind::MacCall(mac) => visitor.visit_mac_call(mac),
897909
ExprKind::Paren(subexpression) => visitor.visit_expr(subexpression),
898910
ExprKind::InlineAsm(asm) => visitor.visit_inline_asm(asm),
911+
ExprKind::FormatArgs(f) => visitor.visit_format_args(f),
899912
ExprKind::Yield(optional_expression) => {
900913
walk_list!(visitor, visit_expr, optional_expression);
901914
}

0 commit comments

Comments
 (0)