ActiveWindow selector or something similar for the send_shortcut dispatcher

[Abdisto]

I'm facing issues when trying to make a shortcut that only works for the current active application if it is a specific window.
An Example should be the best way to describe what I want to have and what my issues are.

I have a keypad that I want to use as undo/redo buttons for xournalpp. But only when it is the current active window, in every other case I want it to behave as the original button, in particular I want to use the keypad buttons as binds for a game(osu!). I don't want to use non_consuming since this will cause diff. issues. FYI the buttons are mapped to f13 and f14.

I already tried to use a lua function with varying degrees of success.
I fetched the activeWindow checked it's class value, and sent a shortcut. This shortcut will work for this application now. As the else case, I tried to send the button presses with the already fetched window info, as well as returning nil,-1,false, but this wouldn't trigger the later-mentioned auto_consuming flag. In both pass and send_shortcut it behaves weirdly, as it will only sends the press but not the release (This may be intended behavior, since it is for shortcuts, but I couldn't get the info if this is the case). This causes issues in osu! as it will not get registered as a button press. I tried using auto_consuming as it states, "Key/mouse events will be passed to the active window if the dispatcher doesn’t succeed."

Well, now I tried multiple things and couldn't get it to work in a satisfactory manner. As the auto_consuming preserves the state of the button presses normally if the dispatcher "fails", I would like to ask if we could get an activewindow regex that allows us to check if the window is currently active, and if not, fails so that auto_consuming will pass the key presses. Trying to use an arbitrary class name that does not exist, the auto_consuming behavior would work as expected. Is it possible to return a dispatch failure manually with a lua function?

These are the code segments of some of my tries:

hl.bind("F13",
    hl.dsp.send_shortcut({
        mods = "CTRL",
        key = "Z",
        window = "class:^(arbitrary-non-existing-class)$",
    }),
    { auto_consuming = true } -- send_shortcut fails and triggers normal key-presses
)

This was my lua function try

hl.bind("F13",
    function()
        local activeWindow = hl.get_active_window()

        if activeWindow ~= nil then
            if activeWindow.class == "com.github.xournalpp.xournalpp" then
                hl.dispatch(hl.dsp.send_shortcut(
                    {
                        mods = "CTRL",
                        key = "Z",
                        window = "class:^(com.github.xournalpp.xournalpp)$",
                    })
                )
            else
                hl.dispatch(hl.dsp.pass({ window = string.format("class:^(%s)$", activeWindow.class) }))
                -- return -1 / return nil / return false
            end
        else
            return
        end
    end,
    { auto_consuming = true }
)

Would having a "activewindow:^(class.name)$" and failing the dispatch if it is not the curr active window be a good idea?
What do you think would be the best way to handle this?

I would appreciate any feedback or direction, and hey, maybe there is already some way to achieve that, which I did not consider.

[Hy4ri]

This method create the keybind when the window is active and removes when its not

local xournal_binds_active = false

local function apply_xournal_binds()
    if not xournal_binds_active then
        hl.bind("F13", hl.dsp.send_shortcut({
            mods = "CTRL",
            key = "Z",
            window = "class:^(com.github.xournalpp.xournalpp)$"
        }))
        
        hl.bind("F14", hl.dsp.send_shortcut({
            mods = "CTRL",
            key = "Y",
            window = "class:^(com.github.xournalpp.xournalpp)$"
        }))
        
        xournal_binds_active = true
    end
end

local function remove_xournal_binds()
    if xournal_binds_active then
        hl.exec_cmd("hyprctl keyword unbind , F13")
        hl.exec_cmd("hyprctl keyword unbind , F14")
        
        xournal_binds_active = false
    end
end

-- Listen for window focus changes
hl.on("window.active", function(w)
    if w ~= nil and w.class == "com.github.xournalpp.xournalpp" then
        apply_xournal_binds()
    else
        remove_xournal_binds()
    end
end)

@Abdisto

[Abdisto]

@Hy4ri, thanks a lot, this is a simple yet effective way to achieve that. Don't know how it slipped my mind that I could simply use states outside the bind scope.
I guess I was too focused on understanding the Lua syntax. Again, thank you :D

[Abdisto]

hl.unbind("F13") and hl.unbind("F14") should be used, though. hl.exec_cmd("hyprctl keyword unbind , F13") does not restore key functionality for some reason (Unbinds completely)

[Abdisto]

@Hy4ri I noticed a weird bug where Hyprland crashes completely whenever xournal is the active window, and I try to switch workspaces with eg. SUPER + 1. Also tested with different applications with the same result.

for i = 1, 10 do
    local key = i % 10
    hl.bind(mainmod .. " + " .. key, hl.dsp.focus({ workspace = i }))
    hl.bind(mainmod .. " + SHIFT + " .. key, hl.dsp.window.move({ workspace = i }))
end

Are you able to reproduce?
If not, what should I look out for when skimming through the logs?
Is it normal that aquamarine throws a lot of cursor buffer import and debounce state updates? I will attach this hyprland.log fetched via: cat $XDG_RUNTIME_DIR/hypr/$(ls -t $XDG_RUNTIME_DIR/hypr | head -n 2 | tail -n 1)/hyprland.log. Would change category to bug when it's reproducible and not a user error.
crash.log

[Hy4ri]

@Abdisto no i cant reproduce.
for the crash i cant help you with this try openning new discussions
:(

[Abdisto]

The issue is the hl.unbind() function. This appears to be a race condition. Adding a delay with hl.timer() works for me. Thanks for trying to reproduce.