fix(menu): allow relative win settings other than win

[willothy]

Allows menus to be created with positions relative to cursor, editor, etc.

Main reason for this is that I'm working on a dropbar_menu_t implementation of vim.ui.select.

[Bekaboo]

@willothy Is there any problem if we left win field untouched when win_configs.relative ~= 'win'?

[willothy]

Yes if relative ~= "win" and the win field is set then nvim throws a validation error.

Added a few more changes to this as well, needed for positioning of the fzf window (also hides the fzf top border if possible to save height).

[willothy]

Also, the ui-select is working great, just needs a bit more work on positioning. Here's a demo:

I've also added custom extmarks to the 3rd section of the demo, to showcase an idea I've had where menu entries could have virtual text displayed below them for extra line-associated context.

1. Code actions ui-select
2. :OverseerRun
3. overseer.nvim task actions, with custom extmarks

The menu class is very versatile and feels better than telescope or nui for this kind of thing because you get the power of the fuzzy finder, but also the hjkl navigation and motions of a nui menu.

2023-09-25.03-23-35.mp4

[Bekaboo]

@willothy

Yes if relative ~= "win" and the win field is set then nvim throws a validation error.

I then wonder why win field is set if relative field is not "win". It would be better if we can avoid calling nvim_open_win() with wrong _win_configs at the beginning rather than fixing the parameterss just before calling the ``nvim_open_win()` function.

[willothy]

It's set because the global configs are used when creating windows, and overridden by the menu-local settings, but vim.tbl_deep_extend will not replace non-nil with nil so if the default win config uses relative = "win" (which it does), win will be set even if the menu-local win config doesn't set it.

I'm not sure how that could be done other than completely overriding the global config with window-local settings, which I don't think would be ideal.

Checking the win key manually might not be a very pretty fix, but it is the simplest one I could come up with.

[Bekaboo]

@willothy This makes full sense to me, thanks for pointing out. Could we fix the wrong _win_configs field in method dropbar_menu_t:eval_win_configs()?

[willothy]

@willothy This makes full sense to me, thanks for pointing out. Could we fix the wrong _win_configs field in method dropbar_menu_t:eval_win_configs()?

Yes, definitely. Updated!