Fix {:#?} representation of proc_macro::Literal #72233

dtolnay · 2020-05-15T15:39:59Z

Before:

TokenStream [
    Ident {
        ident: "name",
        span: #0 bytes(37..41),
    },
    Punct {
        ch: '=',
        spacing: Alone,
        span: #0 bytes(42..43),
    },
    Literal { lit: Lit { kind: Str, symbol: "SNPP", suffix: None }, span: Span { lo: BytePos(44), hi: BytePos(50), ctxt: #0 } },
    Punct {
        ch: ',',
        spacing: Alone,
        span: #0 bytes(50..51),
    },
    Ident {
        ident: "owner",
        span: #0 bytes(56..61),
    },
    Punct {
        ch: '=',
        spacing: Alone,
        span: #0 bytes(62..63),
    },
    Literal { lit: Lit { kind: Str, symbol: "Canary M Burns", suffix: None }, span: Span { lo: BytePos(64), hi: BytePos(80), ctxt: #0 } },
]

After:

TokenStream [
    Ident {
        ident: "name",
        span: #0 bytes(37..41),
    },
    Punct {
        ch: '=',
        spacing: Alone,
        span: #0 bytes(42..43),
    },
    Literal {
        kind: Str,
        symbol: "SNPP",
        suffix: None,
        span: #0 bytes(44..50),
    },
    Punct {
        ch: ',',
        spacing: Alone,
        span: #0 bytes(50..51),
    },
    Ident {
        ident: "owner",
        span: #0 bytes(56..61),
    },
    Punct {
        ch: '=',
        spacing: Alone,
        span: #0 bytes(62..63),
    },
    Literal {
        kind: Str,
        symbol: "Canary M Burns",
        suffix: None,
        span: #0 bytes(64..80),
    },
]

Before: TokenStream [ Ident { ident: "name", span: #0 bytes(37..41), }, Punct { ch: '=', spacing: Alone, span: #0 bytes(42..43), }, Literal { lit: Lit { kind: Str, symbol: "SNPP", suffix: None }, span: Span { lo: BytePos(44), hi: BytePos(50), ctxt: #0 } }, Punct { ch: ',', spacing: Alone, span: #0 bytes(50..51), }, Ident { ident: "owner", span: #0 bytes(56..61), }, Punct { ch: '=', spacing: Alone, span: #0 bytes(62..63), }, Literal { lit: Lit { kind: Str, symbol: "Canary M Burns", suffix: None }, span: Span { lo: BytePos(64), hi: BytePos(80), ctxt: #0 } }, ] After: TokenStream [ Ident { ident: "name", span: #0 bytes(37..41), }, Punct { ch: '=', spacing: Alone, span: #0 bytes(42..43), }, Literal { kind: Str, symbol: "SNPP", suffix: None, span: #0 bytes(44..50), }, Punct { ch: ',', spacing: Alone, span: #0 bytes(50..51), }, Ident { ident: "owner", span: #0 bytes(56..61), }, Punct { ch: '=', spacing: Alone, span: #0 bytes(62..63), }, Literal { kind: Str, symbol: "Canary M Burns", suffix: None, span: #0 bytes(64..80), }, ]

rust-highfive · 2020-05-15T15:40:02Z

r? @petrochenkov

(rust_highfive has picked a reviewer for you, use r? to override)

petrochenkov · 2020-05-15T16:28:32Z

src/libproc_macro/bridge/client.rs

 impl fmt::Debug for Literal {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        f.write_str(&self.debug())
+        f.debug_struct("Literal")
+            .field("kind", &format_args!("{}", &self.debug_kind()))


Suggested change

.field("kind", &format_args!("{}", &self.debug_kind()))

.field("kind", &self.debug_kind())

?

Or is it used to cancel the effect of {:#?}, similarly to the suffix? Could you add a comment then?

self.debug_kind() is a String so your suggestion prints it with quotes around, which is not what I want. The {} representation prints without quotes, as in kind: Float.

petrochenkov · 2020-05-15T16:30:02Z

r=me with #72233 (comment) clarified.

dtolnay · 2020-05-15T16:36:28Z

src/libproc_macro/bridge/client.rs

+            // format the kind without quotes, as in `kind: Float`
+            .field("kind", &format_args!("{}", &self.debug_kind()))


Added comment.

dtolnay · 2020-05-15T16:36:51Z

@bors r=petrochenkov

bors · 2020-05-15T16:36:52Z

📌 Commit bea2c59 has been approved by petrochenkov

Fix {:#?} representation of proc_macro::Literal Before: ```rust TokenStream [ Ident { ident: "name", span: #0 bytes(37..41), }, Punct { ch: '=', spacing: Alone, span: #0 bytes(42..43), }, Literal { lit: Lit { kind: Str, symbol: "SNPP", suffix: None }, span: Span { lo: BytePos(44), hi: BytePos(50), ctxt: #0 } }, Punct { ch: ',', spacing: Alone, span: #0 bytes(50..51), }, Ident { ident: "owner", span: #0 bytes(56..61), }, Punct { ch: '=', spacing: Alone, span: #0 bytes(62..63), }, Literal { lit: Lit { kind: Str, symbol: "Canary M Burns", suffix: None }, span: Span { lo: BytePos(64), hi: BytePos(80), ctxt: #0 } }, ] ``` After: ```rust TokenStream [ Ident { ident: "name", span: #0 bytes(37..41), }, Punct { ch: '=', spacing: Alone, span: #0 bytes(42..43), }, Literal { kind: Str, symbol: "SNPP", suffix: None, span: #0 bytes(44..50), }, Punct { ch: ',', spacing: Alone, span: #0 bytes(50..51), }, Ident { ident: "owner", span: #0 bytes(56..61), }, Punct { ch: '=', spacing: Alone, span: #0 bytes(62..63), }, Literal { kind: Str, symbol: "Canary M Burns", suffix: None, span: #0 bytes(64..80), }, ] ```

@ghost

Rollup of 4 pull requests Successful merges: - rust-lang#72233 (Fix {:#?} representation of proc_macro::Literal) - rust-lang#72277 (emphasize that ManuallyDrop is safe-to-access and unsafe-to-drop) - rust-lang#72281 (Fix whitespace in `?Sized` structured suggestion) - rust-lang#72282 (Fix issue number typo in note) Failed merges: r? @ghost

4676: proc_macro: fix current nightly/future stable ABI incompatibility r=matklad a=robojumper With rust-lang/rust#72233, the proc_macro ABI has changed, leading to the `test_derive_serialize_proc_macro` test believing (on nightly) that `serde` wants to pass the struct name as a byte string literal instead of a string literal. This fixes the test on nightly, but obviously breaks it on stable. As a result, this should be merged when Rust stable `1.45` releases on 2020-07-16. The PR is a draft as to not accidentally merge this too early. People working on nightly can simply apply the commit if they want a fully passing test suite. Co-authored-by: robojumper <robojumper@gmail.com>

4676: proc_macro: fix current nightly/future stable ABI incompatibility r=matklad a=robojumper With rust-lang/rust#72233, the proc_macro ABI has changed, leading to the `test_derive_serialize_proc_macro` test believing that `serde` wants to pass the struct name as a byte string literal instead of a string literal. Fixes #4866. Co-authored-by: robojumper <robojumper@gmail.com>

rust-highfive assigned petrochenkov May 15, 2020

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 15, 2020

Add test of proc_macro::TokenStream's Debug

4c4b4c4

petrochenkov reviewed May 15, 2020

View reviewed changes

petrochenkov added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 15, 2020

Clarify use of format_args in Debug for Literal

bea2c59

dtolnay commented May 15, 2020

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels May 15, 2020

Dylan-DPC-zz mentioned this pull request May 15, 2020

Rollup of 5 pull requests #72236

Closed

Dylan-DPC-zz mentioned this pull request May 15, 2020

Rollup of 7 pull requests #72244

Closed

This was referenced May 15, 2020

Rollup of 7 pull requests #72245

Closed

Rollup of 4 pull requests #72286

Merged

bors merged commit fc91043 into rust-lang:master May 17, 2020

dtolnay deleted the literal branch May 17, 2020 17:24

robojumper mentioned this pull request May 31, 2020

proc_macro: fix current nightly/future stable ABI incompatibility rust-lang/rust-analyzer#4676

Merged

dtolnay added T-libs Relevant to the library team, which will review and decide on the PR/issue. A-proc-macros Area: Procedural macros and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jan 14, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix {:#?} representation of proc_macro::Literal #72233

Fix {:#?} representation of proc_macro::Literal #72233

Uh oh!

dtolnay commented May 15, 2020

Uh oh!

rust-highfive commented May 15, 2020

Uh oh!

petrochenkov May 15, 2020

Uh oh!

dtolnay May 15, 2020

Uh oh!

petrochenkov commented May 15, 2020

Uh oh!

dtolnay May 15, 2020

Uh oh!

dtolnay commented May 15, 2020

Uh oh!

bors commented May 15, 2020

Uh oh!

Uh oh!

	.field("kind", &format_args!("{}", &self.debug_kind()))
	.field("kind", &self.debug_kind())

		// format the kind without quotes, as in `kind: Float`
		.field("kind", &format_args!("{}", &self.debug_kind()))

Fix {:#?} representation of proc_macro::Literal #72233

Fix {:#?} representation of proc_macro::Literal #72233

Uh oh!

Conversation

dtolnay commented May 15, 2020

Uh oh!

rust-highfive commented May 15, 2020

Uh oh!

petrochenkov May 15, 2020

Choose a reason for hiding this comment

Uh oh!

dtolnay May 15, 2020

Choose a reason for hiding this comment

Uh oh!

petrochenkov commented May 15, 2020

Uh oh!

dtolnay May 15, 2020

Choose a reason for hiding this comment

Uh oh!

dtolnay commented May 15, 2020

Uh oh!

bors commented May 15, 2020

Uh oh!

Uh oh!