Avoid ignoring newlines in multi line messages when rendering end-of-line diagnostics #11815
Conversation
|
I do find the second lines useful quite often so the current situation is preferable to this IMO |
|
@pascalkuthe Ok, I checked Neovim's behavior and it uses double spaces to separate the lines, which seems like a reasonable idea to me. Here's the example from above using this approach. 
|
|
Seems good. I don't really care what the seperator looks like, I just want all information to be there |
| @@ -102,10 +102,11 @@ impl Renderer<'_, '_> { | |||
| return 0; | |||
| } | |||
| let col = (col - self.renderer.offset.col) as u16; | |||
| let message = diag.message.replace('\n', " "); | |||
There was a problem hiding this comment.
this allocates a lot (once for each diagnostic during each frame). I intentionally didn't do something like this in the original PR for this reason. We will need to refactor set_string_truncated but since there are other consumers that is a larger change and I am worried about breaking other places that use that API (but maybe after this change we can update unicode-width and then it's fine?)
There was a problem hiding this comment.
I wasn't sure how much I needed to worry about allocations here, but I'm happy to avoid the overhead.
Rather than modifying set_string_truncated I've adapted draw_eol_diagnostic to render the lines separately in a loop. This behaves well in my testing but please let me know if I've overlooked something.
d10bc48 to
696b79e
Compare
|
Apologies for the force push, I rebased but then went back. Other than the new `"Draw each message line separately" commit the history hasn't been changed. |
This was copied from the function above (set_style). I don't know enough about the function to suggest an alternative.
`set_string_truncated` renders the entire string while ignoring newlines, so if the diagnostic's message contains multiple lines it produces messages like 'first linesecond line'. To avoid these run-ons, this commit renders each line separately, inserting double spaces for disambiguation.
696b79e to
6da03c0
Compare
|
I rebased the PR on to the latest master to keep it fresh, and squashed the solution-finding commits to make the intention of the branch clearer. |
set_string_truncatedrenders the entire string while ignoring newlines, so if the diagnostic's message contains multiple lines thendraw_eol_diagnosticproduces output like 'first linesecond line'.An alternative would be to reformat the message to replace newlines with spaces (or something), but I think the first line should be sufficient for end of line diagnostics.
Before:
After:
