feat(debug): highlight current line

[filipdutescu]

Add new theme highlight keys, for setting the colour of the breakpoint
character and the current line at which execution has been paused at.
The two new keys are ui.highlight.frameline and ui.debug.breakpoint.
Highlight according to those keys, both the line at which debugging
is paused at and the breakpoint indicator.

Add an indicator for the current line at which execution is paused
at, themed by the ui.debug.active theme scope. Update various themes
to showcase how the new functionality works.

Better icons are dependent on #2869, and as such will be handled in the
future, once it lands.

Closes: #5952
Signed-off-by: Filip Dutescu filip.dutescu@gmail.com

[pascalkuthe]

I am gonna test this out tomorrow. Just a couple quick comments.

I think the CI failure is unrelated and a rerun would pass fine

[filipdutescu]

Will push changes that address most of the comments. Still need to resolve the bug in the screenshot and update all themes to use the new highlight keys.

[pascalkuthe]

I am afraid you misunderstood my hint a bit. All the code you pushed in b26b98e is unnecessary.

Simply add the code below after the following line:
https://github.com/filipdutescu/helix/blob/b26b98ec952d75fe6be2560c503c5b0a014c7af4/helix-term/src/ui/editor.rs#L109

This will

if let Some(frame_line) = current_frame{
         let doc = doc.text();
	 highlights = Box::new(syntax::merge(
	    highlights,
	    vec![(frame_highlight_scope, doc.line_to_char(frame_line), doc.line_to_char(frame_line + 1))],
	));
}

I just wrote this down off the top of my head so there might be a typo somewhere and the code is probably not perfect but it should set you on the right path.
current_frame should be the result of checking whether there is a dap line for the current view (None if there isn't one otherwise it should be Some(line_number)).
frame_highlight_scope should be the highlight scope you obtained from the theme for highlighting the line.

This will remove any foreground/background colors set by syntax highlighting but leave cursors untouched (since those are merged in afterwards)

[filipdutescu]

Seems like I overcomplicated the solution a bunch. I did not realise I could just use doc.line_to_char(...), it was exactly what I, somehow, did not see. It will probably similarly easy to change cursor and selection highlights for the dap line.

Thank you for pointing it out!

[filipdutescu]

Fixed all issues, I just need to also update basically all themes, which I'll do during this week.

[filipdutescu]

Talked a bit more with @pascalkuthe (thanks for being so helpful and patient) and decided to go for a more VSCode design, rather than VS. This simplifies the logic a lot the logic needed for this feature and makes it so we only need to add at minimum 1 new mandatory highlight, ui.debug. I will push the changes tomorrow. Here is an example using my theme:

I would still like to allow for more customisation (read as allow VS style frame-lines), but I think it's a lot more important to get the overhaul in an MVP state, rather than focus on customisation and endless architecture discussions. This solution should be a simple one, which should not raise any/many concerns, leading to rapid inclusion.

[filipdutescu]

How the default theme will look:

[filipdutescu]

After talking some more with @archseer, we landed on this colour for the debug highlight, which I find beautiful:

[pascalkuthe]

LGTM, thanks for working on this 👍

[filipdutescu]

Thank you very much for guiding me through the process! Looking forward to many more contributions 😁

[pascalkuthe]

just a reference for other reviews:

Adding inner,.y is correct here, the fact that it was missing before was a regression from #5420

[filipdutescu]

I forgot to set the breakpoint to the proper colour, which I did with this rebase as well: