Make "when" inside "case" sticky

[sigmuha]

Currently when using VS-code I observe that case statements are sticky, but its when statements are not.

This is a feature request to make when statements inside case sticky as well.

I believe this is an issue for rust_hdl directly and not the vs-code integration repo, as this would potentially be solved on the document symbol level.

[Schottkyc137]

Hi, thanks for submitting this issue!

Could you give some more detail / minimal reproducible example? Is this a formatting issue? What do you expect / what is actually happening?

[sigmuha]

MRE:

library ieee;
use ieee.std_logic_1164.all;

entity sticky_scroll_mre is
    port(
        clk : in std_logic;
        rst : in std_logic
    );
end entity;

architecture rtl of sticky_scroll_mre is
    type t_state is (IDLE, RUNNING);
    signal state : t_state;
begin

    p_main : process(clk)
    begin
        if rising_edge(clk) then
            if rst = '1' then
                state <= IDLE;
            else
                case state is


                    when IDLE =>













                    
                        state <= RUNNING;

                    when RUNNING =>















                        state <= IDLE;

                end case;
            end if;
        end if;
    end process;

end architecture;

You will observe that the architecture, process, if statement, if statement, and case are sticky:

However, when scrolling past the when IDLE statement it isn't a part of the sticky scroll:

The expected behaviour would be that the sticky scroll would include line 26: when IDLE =>

[nselvara]

Isn't this actually a VSCode feature rather than scroll view offered by VHDL LS? I think you configure it via: Editor-Sticky-Scroll.

[Schottkyc137]

It is a VSCode feature, but I believe a language server can define the bounds where things are sticky or not. So this is actually the right place for this feature request.

[nselvara]

Ah, interesting, hadn't considered that case. Good to know! Are there any other VSCode features that VHDL LS modifies? A comprehensive list would be really helpful.

P.S. I didn't want to open a separate issue for this off-topic question, but do you happen to have any Rust learning resources you'd recommend? I'd love to contribute but have no prior Rust experience.

[Schottkyc137]

Ah, interesting, hadn't considered that case. Good to know! Are there any other VSCode features that VHDL LS modifies? A comprehensive list would be really helpful.

I think it's not strictly speaking a VSCode specific feature and it has more todo with the Document Symbols feature. VSCode just seems to make certain symbols sticky (see this so answer).

P.S. I didn't want to open a separate issue for this off-topic question, but do you happen to have any Rust learning resources you'd recommend? I'd love to contribute but have no prior Rust experience.

Personally I just started nosing around in this and other Rust-based projects.
My recommendation is to just look for some open-source project and work on something you are interested in. Look for small and contained issues work your way up.
You can always ask maintainers for guidance if you're unsure about where exactly to start. Most of them will appreciate any support they can get and be more than happy to provide help.
Ideally, issues marked as "good first issue" can serve as starting point. If you'd like to contribute to vhdl_ls I think the new vhdl_syntax crate has now of good options to get started as it is early in development and there are several low hanging fruit.

[nselvara]

Hoi, I'm actually into contributing to this repo. However, with my limited free time, I first need to work my way up to understand how Rust even works in first place. 😅
But yeah, those "good first issue" seems to look like a good start to begin with. I'll def. ask you if I have any doubt. Thank you for your detailed elaboration.