Add Unicode block-drawing compiler output support #126597

estebank · 2024-06-17T15:14:51Z

Add nightly-only theming support to rustc output using Unicode box
drawing characters instead of ASCII-art to draw the terminal UI.

In order to enable, the flags -Zunstable-options=yes --error-format=human-unicode must be passed in.

After:

error: foo
  ╭▸ test.rs:3:3
  │
3 │       X0 Y0 Z0
  │   ┌───╿──│──┘
  │  ┌│───│──┘
  │ ┏││━━━┙
  │ ┃││
4 │ ┃││   X1 Y1 Z1
5 │ ┃││   X2 Y2 Z2
  │ ┃│└────╿──│──┘ `Z` label
  │ ┃└─────│──┤
  │ ┗━━━━━━┥  `Y` is a good letter too
  │        `X` is a good letter
  ╰╴
note: bar
  ╭▸ test.rs:4:3
  │
4 │ ┏   X1 Y1 Z1
5 │ ┃   X2 Y2 Z2
6 │ ┃   X3 Y3 Z3
  │ ┗━━━━━━━━━━┛
  ├ note: bar
  ╰ note: baz
note: qux
  ╭▸ test.rs:4:3
  │
4 │   X1 Y1 Z1
  ╰╴  ━━━━━━━━

Before:

error: foo
 --> test.rs:3:3
  |
3 |       X0 Y0 Z0
  |    ___^__-__-
  |   |___|__|
  |  ||___|
  | |||
4 | |||   X1 Y1 Z1
5 | |||   X2 Y2 Z2
  | |||____^__-__- `Z` label
  | ||_____|__|
  | |______|  `Y` is a good letter too
  |        `X` is a good letter
  |
note: bar
 --> test.rs:4:3
  |
4 | /   X1 Y1 Z1
5 | |   X2 Y2 Z2
6 | |   X3 Y3 Z3
  | |__________^
  = note: bar
  = note: baz
note: qux
 --> test.rs:4:3
  |
4 |   X1 Y1 Z1
  |   ^^^^^^^^

After:

Before:

rustbot · 2024-06-20T04:08:40Z

Some changes occurred in src/tools/clippy

cc @rust-lang/clippy

rustbot · 2024-06-20T23:17:55Z

Some changes occurred in tests/ui/check-cfg

cc @Urgau

estebank · 2024-06-20T23:18:11Z

r? compiler

compiler/rustc_errors/src/emitter.rs

tests/ui/check-cfg/cargo-build-script.stderr

tests/ui/parser/recover/recover-labeled-non-block-expr.stderr

This change (IMO) improves the diagnostic output by changing the characters that codespan uses when outputting diagnostics. Inspired by rust-lang/rust#126597.

apiraino · 2024-08-01T10:49:38Z

@estebank do we know what the situation is, about Unicode support (on terminals) for all the platforms that rustc supports?
I'm a fan of UTF-8 but I wonder if this would break diags on some Tier 2/3 we don't actively test. Or on some terminals.

Can you say more about the reasoning behind this change? Why do we want to do this? thanks

estebank · 2024-08-04T16:47:34Z

@apiraino

do we know what the situation is, about Unicode support (on terminals) for all the platforms that rustc supports? I'm a fan of UTF-8 but I wonder if this would break diags on some Tier 2/3 we don't actively test. Or on some terminals.

It's spotty at best. I've tested a few different terminals in different platforms and it is honestly quite a terrible status-quo. Mac terminals seem to all support this output correctly. Windows terminals it's hit or miss. Linux is almost always terrible (unless you have a good combination of terminal + fonts, Konsole for example looks ok).

The idea for the output is to be configurable in ~/.cargo/config.toml, maybe with different default per-platform, but to make this something that individual users can set and forget.

Can you say more about the reasoning behind this change? Why do we want to do this? thanks

There are a couple of things behind this:

I keep finding people that have small misunderstandings with the ASCII output: it is not quite as readable as I'd want. I find that the new output is way more readable, particularly for overlapping multiline spans
I find the unicode output more pleasing to the eyes, and communicates the same amount of information with slightly more compact output in some cases
I wanted to experiment with what was possible while still being constrained by the terminal
I wanted to identify what the base components would be if we wanted to ever support theming of the output: I implemented this in such a way that an alternative way of rendering this output is actually possible
we've got a goal to migrate to annotate-snippets, I prototyped this here but I want for all this code to eventually just live there
I want annotate-snippets to have this rendering option as a carrot for people to try out the new rendering, I know people would jump at the option
I wanted to exercise the cargo/rustc communication in order to enable this. I encountered a bunch of places where we were failing to properly propagate the information through for anything other than short error messages (particularly the interaction with json output)
"I just think it's neat"

If this lands before we move to annotate-snippets, we'd change the setting for this to actually affect annotate-snippets, so anyone that starts opting-into unicode output will be "enrolled" in the testing of annotate-snippets when we do that move.

bors · 2024-08-10T15:45:27Z

☔ The latest upstream changes (presumably #122792) made this pull request unmergeable. Please resolve the merge conflicts.

apiraino · 2024-09-05T14:26:47Z

Discussed in t-compiler triage on Zulip

Green light 🚦 since it will be nightly-only and opt-in anyway

@rustbot label -I-compiler-nominated

bors · 2024-09-25T14:36:36Z

☔ The latest upstream changes (presumably #130778) made this pull request unmergeable. Please resolve the merge conflicts.

fmease

r=me after rebase. sorry for the abysmal delay. I have some small nits but they shouldn't really block this PR. esp. since annotate-snippet will likely remedy them

fmease · 2024-09-24T10:15:19Z

compiler/rustc_errors/src/emitter.rs

        if margin.was_cut_left() {
            // We have stripped some code/whitespace from the beginning, make it clear.
-            buffer.puts(line_offset, code_offset, "...", Style::LineNumber);
+            buffer.puts(line_offset, code_offset, placeholder, Style::LineNumber);
        }
        if margin.was_cut_right(line_len) {


Not super important: You could slightly tweak the comment & code inside Margin::was_cut_right? The comment is outdated (refers to "code above" and "...") and hard-codes the offset (it's 6 right now; it that 2 * width(padding)?).

I think was_cut_right is still correct because "...".len() == 3 == "…".len() but otoh I'm not sure if it the usizes represent byte offsets for indexing or for displaying ("len vs width"). So might be worth double checking.

Note that below, you use placeholder.chars().map(|ch| char_width(ch)).sum() to robustly calculate the padding of the placeholder.

… however given the plan to push annotate-snippets forward and eventually use it in the compiler over emitter.rs, I'm sure if these issues matter ^^'.

fmease · 2024-09-24T10:20:33Z

compiler/rustc_errors/src/emitter.rs

        if margin.was_cut_left() {
            // We have stripped some code/whitespace from the beginning, make it clear.
-            buffer.puts(line_offset, code_offset, "...", Style::LineNumber);
+            buffer.puts(line_offset, code_offset, placeholder, Style::LineNumber);


I haven't spent too much thought on this but I wonder if things would break (offsets, alignments) if OutputTheme::Ascii.margin().len() != OutputTheme::Unicode.margin().len() (which coincidentally isn't the case for ... and … so things just work out). Anyway, see comment chain directly below.

fmease · 2024-10-10T00:01:34Z

compiler/rustc_errors/src/emitter.rs

+                    if let AnnotationType::MultilineLine(_) = annotation.annotation_type {
+                        buffer.putc(
+                            p,
+                            (code_offset + annotation.start_col.display).saturating_sub(left),
+                            underline.multiline_vertical,
+                            underline.style,
+                        );
+                    } else {
+                        buffer.putc(
+                            p,
+                            (code_offset + annotation.start_col.display).saturating_sub(left),
+                            underline.vertical_text_line,
+                            underline.style,
+                        );
+                    }


Suggested change

if let AnnotationType::MultilineLine(_) = annotation.annotation_type {

buffer.putc(

p,

(code_offset + annotation.start_col.display).saturating_sub(left),

underline.multiline_vertical,

underline.style,

);

} else {

buffer.putc(

p,

(code_offset + annotation.start_col.display).saturating_sub(left),

underline.vertical_text_line,

underline.style,

);

}

buffer.putc(

p,

(code_offset + annotation.start_col.display).saturating_sub(left),

match annotation.annotation_style {

AnnotationType::MultilineLine(_) => underline.multiline_vertical,

_ => underline.vertical_text_line,

},

underline.style,

);

fmease · 2024-10-10T00:02:35Z

compiler/rustc_errors/src/emitter.rs

+                if let AnnotationType::MultilineStart(_) = annotation.annotation_type {
                    buffer.putc(
-                        p,
+                        line_offset + pos,
                        (code_offset + annotation.start_col.display).saturating_sub(left),
-                        '|',
-                        style,
+                        underline.bottom_right,
+                        underline.style,
+                    );
+                }
+                if let AnnotationType::MultilineEnd(_) = annotation.annotation_type
+                    && annotation.has_label()
+                {
+                    buffer.putc(
+                        line_offset + pos,
+                        (code_offset + annotation.start_col.display).saturating_sub(left),
+                        underline.multiline_bottom_right_with_text,
+                        underline.style,
                    );
                }


fmease · 2024-10-10T00:08:39Z

compiler/rustc_errors/src/emitter.rs

@@ -1102,7 +1155,11 @@ impl HumanEmitter {
            let style =
                if annotation.is_primary { Style::LabelPrimary } else { Style::LabelSecondary };
            let (pos, col) = if pos == 0 {
-                (pos + 1, (annotation.end_col.display + 1).saturating_sub(left))
+                if annotation.end_col.display == 0 {


Could you maybe leave a comment why this is necessary?

fmease · 2024-10-10T00:28:14Z

compiler/rustc_errors/src/emitter.rs

@@ -2082,7 +2249,7 @@ impl HumanEmitter {
                            buffer.putc(
                                row_num,
                                (padding as isize + p) as usize,
-                                if part.is_addition(sm) { '+' } else { '~' },
+                                if part.is_addition(sm) { '+' } else { self.diff() },


Side note: For annotate-snippet, it would be nice if symbols like + that currently don't vary by OutputTheme get moved to the "palette".

Add nightly-only theming support to rustc output using Unicode box drawing characters instead of ASCII-art to draw the terminal UI: After: ``` error: foo ╭▸ test.rs:3:3 │ 3 │ X0 Y0 Z0 │ ┌───╿──│──┘ │ ┌│───│──┘ │ ┏││━━━┙ │ ┃││ 4 │ ┃││ X1 Y1 Z1 5 │ ┃││ X2 Y2 Z2 │ ┃│└────╿──│──┘ `Z` label │ ┃└─────│──┤ │ ┗━━━━━━┥ `Y` is a good letter too │ `X` is a good letter ╰╴ note: bar ╭▸ test.rs:4:3 │ 4 │ ┏ X1 Y1 Z1 5 │ ┃ X2 Y2 Z2 6 │ ┃ X3 Y3 Z3 │ ┗━━━━━━━━━━┛ ├ note: bar ╰ note: baz note: qux ╭▸ test.rs:4:3 │ 4 │ X1 Y1 Z1 ╰╴ ━━━━━━━━ ``` Before: ``` error: foo --> test.rs:3:3 | 3 | X0 Y0 Z0 | ___^__-__- | |___|__| | ||___| | ||| 4 | ||| X1 Y1 Z1 5 | ||| X2 Y2 Z2 | |||____^__-__- `Z` label | ||_____|__| | |______| `Y` is a good letter too | `X` is a good letter | note: bar --> test.rs:4:3 | 4 | / X1 Y1 Z1 5 | | X2 Y2 Z2 6 | | X3 Y3 Z3 | |__________^ = note: bar = note: baz note: qux --> test.rs:4:3 | 4 | X1 Y1 Z1 | ^^^^^^^^ ```

estebank force-pushed the unicode-output branch from ab6dfc7 to bc3a6c2 Compare June 19, 2024 16:01

rustbot added T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jun 19, 2024

estebank force-pushed the unicode-output branch 2 times, most recently from 0fb5d30 to 3b7a44f Compare June 20, 2024 02:04

estebank changed the title ~~[Experiment] Repalce ASCII compiler output with Unicode block-drawing~~ Add Unicode block-drawing compiler output support Jun 20, 2024

estebank force-pushed the unicode-output branch from 3b7a44f to ffafff1 Compare June 20, 2024 02:16

estebank marked this pull request as ready for review June 20, 2024 02:16

This comment was marked as resolved.

Sign in to view

estebank force-pushed the unicode-output branch from ffafff1 to 17b37f9 Compare June 20, 2024 02:31

This comment has been minimized.

Sign in to view

estebank force-pushed the unicode-output branch from 17b37f9 to 9a606ca Compare June 20, 2024 03:14

This comment has been minimized.

Sign in to view

estebank force-pushed the unicode-output branch from 9a606ca to bb62232 Compare June 20, 2024 04:08

This comment was marked as resolved.

Sign in to view

Jake-Shadle mentioned this pull request Jun 20, 2024

Unicode block-drawing support brendanzab/codespan#362

Closed

estebank force-pushed the unicode-output branch from bb62232 to 5c77d3b Compare June 20, 2024 15:12

rustbot assigned fmease Jun 20, 2024

estebank commented Jun 20, 2024

View reviewed changes

compiler/rustc_errors/src/emitter.rs Outdated Show resolved Hide resolved

This comment has been minimized.

Sign in to view

Urgau reviewed Jun 21, 2024

View reviewed changes

tests/ui/check-cfg/cargo-build-script.stderr Outdated Show resolved Hide resolved

This comment has been minimized.

Sign in to view

estebank added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 21, 2024

estebank commented Jun 21, 2024

View reviewed changes

tests/ui/parser/recover/recover-labeled-non-block-expr.stderr Outdated Show resolved Hide resolved

This comment was marked as resolved.

Sign in to view

estebank force-pushed the unicode-output branch 2 times, most recently from 57ff435 to 6fe519d Compare June 24, 2024 17:17

BrewTestBot mentioned this pull request Jul 25, 2024

cargo-deny 0.15.0 Homebrew/homebrew-core#178470

Merged

estebank force-pushed the unicode-output branch 2 times, most recently from f3d1fce to bcd2412 Compare August 8, 2024 01:53

This comment has been minimized.

Sign in to view

estebank force-pushed the unicode-output branch from bcd2412 to bd8daa3 Compare August 8, 2024 02:47

This comment has been minimized.

Sign in to view

estebank force-pushed the unicode-output branch from bd8daa3 to 885d979 Compare August 8, 2024 14:41

This comment has been minimized.

Sign in to view

estebank force-pushed the unicode-output branch from 885d979 to c64e042 Compare August 9, 2024 16:23

fmease added I-compiler-nominated Nominated for discussion during a compiler team meeting. S-waiting-on-team Status: Awaiting decision from the relevant subteam (see the T-<team> label). labels Sep 4, 2024

rustbot removed the I-compiler-nominated Nominated for discussion during a compiler team meeting. label Sep 5, 2024

estebank force-pushed the unicode-output branch from c64e042 to 171688f Compare September 23, 2024 21:37

estebank removed the S-waiting-on-team Status: Awaiting decision from the relevant subteam (see the T-<team> label). label Sep 23, 2024

estebank force-pushed the unicode-output branch from 171688f to f8f56b6 Compare September 27, 2024 01:12

y21 mentioned this pull request Oct 6, 2024

Show interior mutability chain in mutable_key_type rust-lang/rust-clippy#13496

Merged

This comment was marked as resolved.

Sign in to view

fmease approved these changes Oct 10, 2024

View reviewed changes

fmease 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 Oct 10, 2024

fmease force-pushed the unicode-output branch from f8f56b6 to 2af9d09 Compare October 23, 2024 16:08

This comment was marked as resolved.

Sign in to view

fmease force-pushed the unicode-output branch from 2af9d09 to eb55252 Compare October 24, 2024 17:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Unicode block-drawing compiler output support #126597

Add Unicode block-drawing compiler output support #126597

estebank commented Jun 17, 2024 •

edited

Loading

This comment was marked as resolved.

This comment has been minimized.

This comment has been minimized.

rustbot commented Jun 20, 2024

This comment was marked as resolved.

rustbot commented Jun 20, 2024

estebank commented Jun 20, 2024

This comment has been minimized.

This comment has been minimized.

This comment was marked as resolved.

apiraino commented Aug 1, 2024 •

edited

Loading

estebank commented Aug 4, 2024

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

bors commented Aug 10, 2024

apiraino commented Sep 5, 2024

bors commented Sep 25, 2024

This comment was marked as resolved.

fmease left a comment

fmease Sep 24, 2024

fmease Oct 9, 2024

fmease Oct 9, 2024

fmease Sep 24, 2024

fmease Oct 10, 2024

fmease Oct 10, 2024

fmease Oct 10, 2024

fmease Oct 10, 2024

This comment was marked as resolved.

Add Unicode block-drawing compiler output support #126597

Are you sure you want to change the base?

Add Unicode block-drawing compiler output support #126597

Conversation

estebank commented Jun 17, 2024 • edited Loading

This comment was marked as resolved.

This comment has been minimized.

This comment has been minimized.

rustbot commented Jun 20, 2024

This comment was marked as resolved.

rustbot commented Jun 20, 2024

estebank commented Jun 20, 2024

This comment has been minimized.

This comment has been minimized.

This comment was marked as resolved.

apiraino commented Aug 1, 2024 • edited Loading

estebank commented Aug 4, 2024

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

bors commented Aug 10, 2024

apiraino commented Sep 5, 2024

bors commented Sep 25, 2024

This comment was marked as resolved.

fmease left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as resolved.

estebank commented Jun 17, 2024 •

edited

Loading

apiraino commented Aug 1, 2024 •

edited

Loading