Improve lua bindings parsing

[kolayne]

Describe the feature

I suggest to treat more cases in the config as errors. It will simplify debugging config errors. In particular:

• Multiple binds for the same keystroke is an error. We needed support for multiple bindings in hyprlang, but in lua the same is supported with functions, which also make multi-action bindings more explicit and obvious. When programmatically changing bindins, one can still unbind the old binding and bind again.
• Repeating the same key in a binding (e.g., hl.bind("ALT + ALT + 1", ...) is an error. This will be helpful when debugging errornous bindings involving variables (e.g., hl.bind(mod .. "ALT + 1", ...), where mod is ALT + , is likely an error)
• Bind to something of the form hl.dsp.exec_raw(..., { float = true }) is an error: exec_raw does not supported effects, so it must be an error to supply them.
• Bind to something of the form hl.dsp.window.kill (as opposed to hl.dsp.window.kill()) is an error: it is meaningless, and currently results in weird behavior.

And another relevant improvement would be to compare and treat bind hotkeys as sets of keys rather than strings.

Why would it be beneficial

The cases above are either unsupported already, or are supported but unlikely to be intended by users. However, when appearing by mistake, they are hard to debug, and error messages would help with that.

[kolayne]

@vaxerski, promotion?

[vaxerski]

Multiple binds for the same keystroke is an error

disagree

Repeating the same key in a binding

Fair

Bind to something of the form ...

Fair, we should enforce signatures better

Bind to something of the form ...

Yes

Do you wanna take this one?

[kolayne]

Multiple binds for the same keystroke is an error

disagree

Why? I think it's just hyprlang's legacy that doesn't make sense for the lua config.

Do you wanna take this one?

Not anytime soon, no :(

[ItsOhen]

Why? I think it's just hyprlang's legacy that doesn't make sense for the lua config.

Makes perfect sense to me. If user wants to add more keybinds on some condition, he/she shouldn't have to go query what the old keybind was, remove it, then add a new. That's just silly.

[kolayne]

No, that's not what I'm talking about. I am saying that, for example, this should be a bug:

hl.bind("ALT + F4", hl.dsp.window.close())
hl.bind("ALT + F4", hl.dsp.window.close())

If the user wants multiple actions performed on the same hotkey, they should instead do:

hl.bind("ALT + F4", function()
    hl.dispatch(hl.dsp.window.close())
    hl.dispatch(hl.dsp.window.close())
end)

[ItsOhen]

And i'm saying it shouldn't be a bug.

hl.bind("ALT + F4", hl.dsp.window.close())
if os.getenv("KIOSK") then
    hl.bind("ALT + F4", hl.dsp.exec_cmd("mykiosk"))
end

should be allowed without having to put the condition in the bind. Maybe i want the condition in some completely different module?

[kolayne]

Okay, I see your use case.

Seems quite niche, though. I wonder if we could support it conveniently with some extra functionality, while making the basic use cases more restricted, to avoid accidental bugs.

[kolayne]

+1: display a warning when an unrecognized extra argument is provided to any dispatcher, like hl.dsp.window.kill({ hello = "world" })

[kolayne]

+1: it turns out send_shortcut silently ignores unknown modifiers. E.g., hyprctl dispatcher hl.dsp.send_shortcut'({ mods = "abacaba", key = "space" })' completes successfully and the space key is sent.

[vaxerski]

I can take a look at this once #15354 is done

[kolayne]

@vaxerski, reminder.

And maybe we should promote the rest.

[vaxerski]

wdym "the rest"?

[vaxerski]

#15871

[leaty]

Multiple binds for the same keystroke is an error

@kolayne I just wanted to mention that this is already sort of possible using lua, you can write a wrapper and then leverage lua tables like this:

{

	['SUPER + RETURN'] = app.terminal,
	['SUPER + RETURN'] = app.browser, -- Emits LSP warning as "Duplicate index `SUPER + RETURN`"
}

Caveat is it won't emit anything for a swapped key order because it's no longer identical, but it's still something.

[vaxerski]

compute a hash :)