macros: introduce `fluent_messages` macro #97327

davidtwco · 2022-05-23T17:45:35Z

Adds a new fluent_messages macro which performs compile-time validation of the compiler's Fluent resources (i.e. that the resources parse and don't multiply define the same messages) and generates constants that make using those messages in diagnostics more ergonomic.

For example, given the following invocation of the macro..

fluent_messages! {
    typeck => "./typeck.ftl",
}

..where typeck.ftl has the following contents..

typeck-field-multiply-specified-in-initializer =
    field `{$ident}` specified more than once
    .label = used more than once
    .label-previous-use = first use of `{$ident}`

...then the macro parse the Fluent resource, emitting a diagnostic if it fails to do so...

error: could not parse Fluent resource
  --> $DIR/test.rs:35:28
   |
LL |         missing_message => "./missing-message.ftl",
   |                            ^^^^^^^^^^^^^^^^^^^^^^^
   |
   = help: see additional errors emitted

error: expected a message field for "missing-message"
 --> ./missing-message.ftl:1:1
  |
1 | missing-message = 
  | ^^^^^^^^^^^^^^^^^^
  |

...or generating the following code if it succeeds:

pub static DEFAULT_LOCALE_RESOURCES: &'static [&'static str] = &[
    include_str!("./typeck.ftl"),
];

mod fluent_generated {
    mod typeck {
        pub const field_multiply_specified_in_initializer: DiagnosticMessage =
            DiagnosticMessage::fluent("typeck-field-multiply-specified-in-initializer");
        pub const field_multiply_specified_in_initializer_label_previous_use: DiagnosticMessage =
            DiagnosticMessage::fluent_attr(
                "typeck-field-multiply-specified-in-initializer",
                "previous-use-label"
            );
    }
}

When emitting a diagnostic, the generated constants can be used as follows:

let mut err = sess.struct_span_err(
    span,
    fluent::typeck::field_multiply_specified_in_initializer
);
err.span_label(
    span,
    fluent::typeck::field_multiply_specified_in_initializer_label
);
err.span_label(
    previous_use_span,
    fluent::typeck::field_multiply_specified_in_initializer_label_previous_use
);
err.emit();

I'd like to reduce the verbosity of referring to labels/notes/helps with this scheme (though it wasn't much better before), but I'll leave that for a follow-up.

r? @oli-obk
cc @pvdrz @compiler-errors

oli-obk · 2022-05-24T07:49:53Z

@bors r+

bors · 2022-05-24T07:49:55Z

📌 Commit d7d5a0b has been approved by oli-obk

oli-obk · 2022-05-24T07:51:11Z

src/test/ui-fulldeps/fluent-messages/test.stderr

+error: expected a message field for "missing-message"
+ --> ./missing-message.ftl:1:1
+  |
+1 | missing-message = 
+  | ^^^^^^^^^^^^^^^^^^
+  |


spans into non-Rust code are so cool

…mpile-time-validation, r=oli-obk macros: introduce `fluent_messages` macro Adds a new `fluent_messages` macro which performs compile-time validation of the compiler's Fluent resources (i.e. that the resources parse and don't multiply define the same messages) and generates constants that make using those messages in diagnostics more ergonomic. For example, given the following invocation of the macro.. ```rust fluent_messages! { typeck => "./typeck.ftl", } ``` ..where `typeck.ftl` has the following contents.. ```fluent typeck-field-multiply-specified-in-initializer = field `{$ident}` specified more than once .label = used more than once .label-previous-use = first use of `{$ident}` ``` ...then the macro parse the Fluent resource, emitting a diagnostic if it fails to do so... ```text error: could not parse Fluent resource --> $DIR/test.rs:35:28 | LL | missing_message => "./missing-message.ftl", | ^^^^^^^^^^^^^^^^^^^^^^^ | = help: see additional errors emitted error: expected a message field for "missing-message" --> ./missing-message.ftl:1:1 | 1 | missing-message = | ^^^^^^^^^^^^^^^^^^ | ``` ...or generating the following code if it succeeds: ```rust pub static DEFAULT_LOCALE_RESOURCES: &'static [&'static str] = &[ include_str!("./typeck.ftl"), ]; mod fluent_generated { mod typeck { pub const field_multiply_specified_in_initializer: DiagnosticMessage = DiagnosticMessage::fluent("typeck-field-multiply-specified-in-initializer"); pub const field_multiply_specified_in_initializer_label_previous_use: DiagnosticMessage = DiagnosticMessage::fluent_attr( "typeck-field-multiply-specified-in-initializer", "previous-use-label" ); } } ``` When emitting a diagnostic, the generated constants can be used as follows: ```rust let mut err = sess.struct_span_err( span, fluent::typeck::field_multiply_specified_in_initializer ); err.span_label( span, fluent::typeck::field_multiply_specified_in_initializer_label ); err.span_label( previous_use_span, fluent::typeck::field_multiply_specified_in_initializer_label_previous_use ); err.emit(); ``` I'd like to reduce the verbosity of referring to labels/notes/helps with this scheme (though it wasn't much better before), but I'll leave that for a follow-up. r? `@oli-obk` cc `@pvdrz` `@compiler-errors`

src/test/ui-fulldeps/fluent-messages/test.rs

With `ignore (rust)` rather than `ignore (pseudo-Rust)` my editor highlights the code in the block, which is nicer. Signed-off-by: David Wood <david.wood@huawei.com>

Adds a new `fluent_messages` macro which performs compile-time validation of the compiler's Fluent resources (i.e. that the resources parse and don't multiply define the same messages) and generates constants that make using those messages in diagnostics more ergonomic. For example, given the following invocation of the macro.. ```ignore (rust) fluent_messages! { typeck => "./typeck.ftl", } ``` ..where `typeck.ftl` has the following contents.. ```fluent typeck-field-multiply-specified-in-initializer = field `{$ident}` specified more than once .label = used more than once .label-previous-use = first use of `{$ident}` ``` ...then the macro parse the Fluent resource, emitting a diagnostic if it fails to do so, and will generate the following code: ```ignore (rust) pub static DEFAULT_LOCALE_RESOURCES: &'static [&'static str] = &[ include_str!("./typeck.ftl"), ]; mod fluent_generated { mod typeck { pub const field_multiply_specified_in_initializer: DiagnosticMessage = DiagnosticMessage::fluent("typeck-field-multiply-specified-in-initializer"); pub const field_multiply_specified_in_initializer_label_previous_use: DiagnosticMessage = DiagnosticMessage::fluent_attr( "typeck-field-multiply-specified-in-initializer", "previous-use-label" ); } } ``` When emitting a diagnostic, the generated constants can be used as follows: ```ignore (rust) let mut err = sess.struct_span_err( span, fluent::typeck::field_multiply_specified_in_initializer ); err.span_default_label(span); err.span_label( previous_use_span, fluent::typeck::field_multiply_specified_in_initializer_label_previous_use ); err.emit(); ``` Signed-off-by: David Wood <david.wood@huawei.com>

Use new typed Fluent identifiers for the "missing type parameters" diagnostic in the typeck crate which was manually creating `DiagnosticMessage`s previously. Signed-off-by: David Wood <david.wood@huawei.com>

oli-obk · 2022-05-26T12:53:41Z

@bors r+

bors · 2022-05-26T12:53:43Z

📌 Commit ce9901f has been approved by oli-obk

bors · 2022-05-26T13:37:38Z

⌛ Testing commit ce9901f with merge 71836c3f551ade22dbe2eda2361c4a93574ae786...

rust-log-analyzer · 2022-05-26T15:28:12Z

The job x86_64-apple-2 failed! Check out the build log: (web) (plain)

Click to see the possible cause of the failure (guessed by this bot)

      Memory: 14 GB
      System Firmware Version: VMW71.00V.13989454.B64.1906190538
      Apple ROM Info: [MS_VM_CERT/SHA1/27d66596a61c48dd3dc7216fd715126e33f59ae7]Welcome to the Virtual Machine
      SMC Version (system): 2.8f0
      Serial Number (system): VMRd/GyU2YJf
      Provisioning UDID: 4203018E-580F-C1B5-9525-B745CECA79EB

hw.ncpu: 3
hw.byteorder: 1234
---
Some tests failed in compiletest suite=rustdoc mode=rustdoc host=x86_64-apple-darwin target=x86_64-apple-darwin

failures:

---- [rustdoc] src/test/rustdoc/primitive/no_std.rs stdout ----
thread '[rustdoc] src/test/rustdoc/primitive/no_std.rs' panicked at 'called `Result::unwrap()` on an `Err` value: Os { code: 22, kind: InvalidInput, message: "Invalid argument" }', src/tools/compiletest/src/runtest.rs:2252:34


failures:
    [rustdoc] src/test/rustdoc/primitive/no_std.rs

bors · 2022-05-26T15:28:55Z

💔 Test failed - checks-actions

davidtwco · 2022-05-27T09:14:33Z

This seems pretty spurious.

@bors retry

Rollup of 5 pull requests Successful merges: - rust-lang#94640 (Partially stabilize `(const_)slice_ptr_len` feature by stabilizing `NonNull::len`) - rust-lang#97034 (Implement `Hash` for `core::alloc::Layout`) - rust-lang#97327 (macros: introduce `fluent_messages` macro ) - rust-lang#97448 (docs: Don't imply that OsStr on Unix is always UTF-8) - rust-lang#97466 ([bootstrap] Move `sanitize_sh` from `dist` to `install`) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

rustbot added the T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. label May 23, 2022

rust-highfive assigned oli-obk May 23, 2022

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

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-review Status: Awaiting review from the assignee but also interested parties. labels May 24, 2022

oli-obk reviewed May 24, 2022

View reviewed changes

Dylan-DPC mentioned this pull request May 24, 2022

Rollup of 4 pull requests #97349

Closed

This comment was marked as resolved.

Sign in to view

bors 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-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels May 24, 2022

davidtwco force-pushed the diagnostic-translation-compile-time-validation branch from d7d5a0b to f3d0cda Compare May 24, 2022 14:29

davidtwco commented May 24, 2022

View reviewed changes

src/test/ui-fulldeps/fluent-messages/test.rs Outdated Show resolved Hide resolved

davidtwco mentioned this pull request May 24, 2022

errors: simplify referring to fluent attributes #97357

Merged

davidtwco added 3 commits May 24, 2022 16:48

macros: change code block language

6e85efd

With `ignore (rust)` rather than `ignore (pseudo-Rust)` my editor highlights the code in the block, which is nicer. Signed-off-by: David Wood <david.wood@huawei.com>

typeck: use typed fluent identifiers for diags

ce9901f

Use new typed Fluent identifiers for the "missing type parameters" diagnostic in the typeck crate which was manually creating `DiagnosticMessage`s previously. Signed-off-by: David Wood <david.wood@huawei.com>

davidtwco force-pushed the diagnostic-translation-compile-time-validation branch from f3d0cda to ce9901f Compare May 24, 2022 15:48

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 26, 2022

bors removed the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label May 26, 2022

bors added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 26, 2022

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-review Status: Awaiting review from the assignee but also interested parties. labels May 27, 2022

Dylan-DPC mentioned this pull request May 28, 2022

Rollup of 5 pull requests #97476

Merged

bors merged commit 7e7dd1c into rust-lang:master May 28, 2022

rustbot added this to the 1.63.0 milestone May 28, 2022

davidtwco deleted the diagnostic-translation-compile-time-validation branch May 28, 2022 12:00

compiler-errors added the A-translation Area: Translation infrastructure, and migrating existing diagnostics to SessionDiagnostic label Aug 11, 2022

ehuss mentioned this pull request Mar 20, 2023

CI random failure on x86_64-apple-2 InvalidInput in create_dir_all while running test/rustdoc/primitive/no_std.rs #109397

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

macros: introduce `fluent_messages` macro #97327

macros: introduce `fluent_messages` macro #97327

davidtwco commented May 23, 2022

oli-obk commented May 24, 2022

bors commented May 24, 2022

oli-obk May 24, 2022

This comment was marked as resolved.

oli-obk commented May 26, 2022

bors commented May 26, 2022

bors commented May 26, 2022

rust-log-analyzer commented May 26, 2022

bors commented May 26, 2022

davidtwco commented May 27, 2022

macros: introduce fluent_messages macro #97327

macros: introduce fluent_messages macro #97327

Conversation

davidtwco commented May 23, 2022

oli-obk commented May 24, 2022

bors commented May 24, 2022

oli-obk May 24, 2022

Choose a reason for hiding this comment

This comment was marked as resolved.

oli-obk commented May 26, 2022

bors commented May 26, 2022

bors commented May 26, 2022

rust-log-analyzer commented May 26, 2022

bors commented May 26, 2022

davidtwco commented May 27, 2022

macros: introduce `fluent_messages` macro #97327

macros: introduce `fluent_messages` macro #97327