Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

X.A.Repeatable: Auto-detect modifier keys from currentEvent #892

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

liskin
Copy link
Member

@liskin liskin commented May 26, 2024

Description

This makes all the cycleSomething key bindings easier to use: users don't need to manually list the KeySyms of modifier keys in addition to specifying the mask for the keybinding itself. We can easily get those KeySyms from the KeyEvent currently being handled with the help of XGetModifierMapping.

This only implements the logic in X.A.Repeatable. We need to decide
whether to change the API of all the user-facing functions (drop the mods
argument), just document that empty list means "auto-detect", or some
combination thereof.

Checklist

  • I've read CONTRIBUTING.md

  • I've considered how to best test these changes (property, unit,
    manually, ...) and concluded:
    seems to work fine for me…
    automated testing not feasible

  • I updated the CHANGES.md file

This makes all the cycleSomething key bindings easier to use: users
don't need to manually list the KeySyms of modifier keys in addition to
specifying the mask for the keybinding itself. We can easily get those
KeySyms from the KeyEvent currently being handled with the help of
XGetModifierMapping.
@liskin
Copy link
Member Author

liskin commented Jul 7, 2024

Anyone happens to have an opinion about the API?

@slotThe
Copy link
Member

slotThe commented Jul 8, 2024

This sounds much better than the current situation, but I guess breaking user configs by dropping an argument is always a bit "eh" :/

@geekosaur
Copy link
Contributor

New API and mark the old one as deprecated? Or just go with "empty list means get it from the event"?
Also, do we want to think about this for https://hackage.haskell.org/package/xmonad-contrib-0.18.0/docs/XMonad-Actions-CycleWindows.html#v:cycleRecentWindows?

@liskin
Copy link
Member Author

liskin commented Jul 8, 2024

Also, do we want to think about this for https://hackage.haskell.org/package/xmonad-contrib-0.18.0/docs/XMonad-Actions-CycleWindows.html#v:cycleRecentWindows?

X.A.Repeatable is used in X.A.CycleWindows, and also in X.A.{CycleWorkspaceByScreen,CycleRecentWS,MostRecentlyUsed} so changing the API would result in quite a lot of breaking changes, or at least quite a lot of new function names and lot of deprecations.

I guess going with the "empty list …" option is better then. Or something.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants