WildBind.X11

This module exports a FrontEnd for X11 environments.

X11 front-end

withFrontEnd :: (XKeyInput i, Describable i, Ord i) => (FrontEnd ActiveWindow i -> IO a) -> IO a

Initialize and obtain FrontEnd for X11, and run the given action.

The X11 FrontEnd watches and provides ActiveWindow as the front-end state. ActiveWindow keeps information about the window currently active. As for the input type i, this FrontEnd gets keyboard events from the X server.

CAVEATS

Code using this function must be compiled with -threaded option enabled in ghc. Otherwise, it aborts.

Basically you should call this function directly under main. This is because this function calls some low-level X11 functions to initialize the X11 client, which should be done first.

Because this FrontEnd currently uses XGrabKey(3) to get the input, it may cause some weird behavior such as:

• Every input event makes the active window lose focus temporarily. This may result in flickering cursor, for example. See also: https://stackoverflow.com/questions/15270420/
• Key input is captured only while the first grabbed key is pressed. For example, if (release xK_a) and (release xK_b) are bound, and you input (press xK_a), (press xK_b), (release xK_a), (release xK_b), the last (release xK_b) is NOT captured because key grab ends with (release xK_a).

class XKeyInput k where

Class of data types that can be handled by X11. The data type can tell X11 to grab key with optional modifiers, and it can be extracted from a X11 Event object.

Since: 0.2.0.0

Minimal complete definition

toKeySym, fromKeyEvent

Methods

toKeySym :: k -> KeySym

Get the X11 keysym for this input.

toModifierMasks :: KeyMaskMap -> k -> NonEmpty KeyMask

Get modifer masks to grab the keysym. The grab action is repeated for all modifier masks. By default, it just returns 0.

fromKeyEvent :: KeyMaskMap -> KeyEventType -> KeySym -> KeyMask -> Maybe k

Create the input object from a key event type, a keysym and a modifier (got from XEvent.)

Instances

XKeyInput NumPadUnlocked

This input event captures the KeyRelease event only. That way, you can deliver events to the window that originally has the keyboard focus.

Defined in WildBind.X11.Internal.Key

Methods

toKeySym :: NumPadUnlocked -> KeySym

toModifierMasks :: KeyMaskMap -> NumPadUnlocked -> NonEmpty KeyMask

fromKeyEvent :: KeyMaskMap -> KeyEventType -> KeySym -> KeyMask -> Maybe NumPadUnlocked

XKeyInput NumPadLocked

This input event captures the KeyRelease event only. That way, you can deliver events to the window that originally has the keyboard focus.

Defined in WildBind.X11.Internal.Key

Methods

toKeySym :: NumPadLocked -> KeySym

toModifierMasks :: KeyMaskMap -> NumPadLocked -> NonEmpty KeyMask

fromKeyEvent :: KeyMaskMap -> KeyEventType -> KeySym -> KeyMask -> Maybe NumPadLocked

XKeyInput XKeyEvent

fromKeyEvent always returns Just.

Defined in WildBind.X11.Internal.Key

Methods

toKeySym :: XKeyEvent -> KeySym

toModifierMasks :: KeyMaskMap -> XKeyEvent -> NonEmpty KeyMask

fromKeyEvent :: KeyMaskMap -> KeyEventType -> KeySym -> KeyMask -> Maybe XKeyEvent

(XKeyInput a, XKeyInput b) => XKeyInput (Either a b)

fromKeyEvent first tries to create Left (type a). If it fails, then it tries to create Right (type b).

Defined in WildBind.X11.Internal.Key

Methods

toKeySym :: Either a b -> KeySym

toModifierMasks :: KeyMaskMap -> Either a b -> NonEmpty KeyMask

fromKeyEvent :: KeyMaskMap -> KeyEventType -> KeySym -> KeyMask -> Maybe (Either a b)

Windows in X11

data Window

Information about window. You can inspect properties winInstance and winClass by wmctrl command.

$ wmctrl -lx
0x01400004 -1 xfce4-panel.Xfce4-panel  mydesktop xfce4-panel
0x01800003 -1 xfdesktop.Xfdesktop   mydesktop desktop
0x03800004  0 xfce4-terminal.Xfce4-terminal  mydesktop Terminal - toshio@mydesktop - byobu
0x03a000a7  0 emacs.Emacs23         mydesktop emacs@mydesktop
0x03e010fc  0 Navigator.Firefox     mydesktop debug-ito (Toshio Ito) - Mozilla Firefox
0x02600003  0 totem.Totem           mydesktop Movie Player

In the above example, the third column shows winInstance.winClass.

Instances

Eq Window

Defined in WildBind.X11.Internal.Window

Methods

(==) :: Window -> Window -> Bool

(/=) :: Window -> Window -> Bool

Ord Window

Defined in WildBind.X11.Internal.Window

Methods

compare :: Window -> Window -> Ordering

(<) :: Window -> Window -> Bool

(<=) :: Window -> Window -> Bool

(>) :: Window -> Window -> Bool

(>=) :: Window -> Window -> Bool

max :: Window -> Window -> Window

min :: Window -> Window -> Window

Show Window

Defined in WildBind.X11.Internal.Window

Methods

showsPrec :: Int -> Window -> ShowS

show :: Window -> String

showList :: [Window] -> ShowS

type ActiveWindow = Window

Use this type especially when the Window is active.

Getters

winInstance :: Window -> Text

name of the application instance (part of WM_CLASS property)

winClass :: Window -> Text

name of the application class (part of WM_CLASS property)

winName :: Window -> Text

what's shown in the title bar

Keys in X11

data XKeyEvent

High-level X11 key event.

Since: 0.2.0.0

Constructors

XKeyEvent

Fields

• xKeyEventType :: KeyEventType
• xKeyEventMods :: Set XMod

  set of key modifiers enabled.

• xKeyEventKeySym :: KeySym

  X11 KeySym for the key. WildBind.X11.KeySym re-exports KeySym values.

Instances

Eq XKeyEvent

Defined in WildBind.X11.Internal.Key

Methods

(==) :: XKeyEvent -> XKeyEvent -> Bool

(/=) :: XKeyEvent -> XKeyEvent -> Bool

Ord XKeyEvent

Defined in WildBind.X11.Internal.Key

Methods

compare :: XKeyEvent -> XKeyEvent -> Ordering

(<) :: XKeyEvent -> XKeyEvent -> Bool

(<=) :: XKeyEvent -> XKeyEvent -> Bool

(>) :: XKeyEvent -> XKeyEvent -> Bool

(>=) :: XKeyEvent -> XKeyEvent -> Bool

max :: XKeyEvent -> XKeyEvent -> XKeyEvent

min :: XKeyEvent -> XKeyEvent -> XKeyEvent

Show XKeyEvent

Defined in WildBind.X11.Internal.Key

Methods

showsPrec :: Int -> XKeyEvent -> ShowS

show :: XKeyEvent -> String

showList :: [XKeyEvent] -> ShowS

Describable XKeyEvent

Defined in WildBind.X11.Internal.Key

Methods

describe :: XKeyEvent -> ActionDescription

ToXKeyEvent XKeyEvent

Defined in WildBind.X11.Internal.Key

Methods

toXKeyEvent :: XKeyEvent -> XKeyEvent

XKeyInput XKeyEvent

fromKeyEvent always returns Just.

Defined in WildBind.X11.Internal.Key

Methods

toKeySym :: XKeyEvent -> KeySym

toModifierMasks :: KeyMaskMap -> XKeyEvent -> NonEmpty KeyMask

fromKeyEvent :: KeyMaskMap -> KeyEventType -> KeySym -> KeyMask -> Maybe XKeyEvent

data XMod

X11 key modifiers.

Since: 0.2.0.0

Constructors

Shift

Ctrl

Alt

Super

Instances

Bounded XMod

Defined in WildBind.X11.Internal.Key

Methods

minBound :: XMod

maxBound :: XMod

Enum XMod

Defined in WildBind.X11.Internal.Key

Methods

succ :: XMod -> XMod

pred :: XMod -> XMod

toEnum :: Int -> XMod

fromEnum :: XMod -> Int

enumFrom :: XMod -> [XMod]

enumFromThen :: XMod -> XMod -> [XMod]

enumFromTo :: XMod -> XMod -> [XMod]

enumFromThenTo :: XMod -> XMod -> XMod -> [XMod]

Eq XMod

Defined in WildBind.X11.Internal.Key

Methods

(==) :: XMod -> XMod -> Bool

(/=) :: XMod -> XMod -> Bool

Ord XMod

Defined in WildBind.X11.Internal.Key

Methods

compare :: XMod -> XMod -> Ordering

(<) :: XMod -> XMod -> Bool

(<=) :: XMod -> XMod -> Bool

(>) :: XMod -> XMod -> Bool

(>=) :: XMod -> XMod -> Bool

max :: XMod -> XMod -> XMod

min :: XMod -> XMod -> XMod

Show XMod

Defined in WildBind.X11.Internal.Key

Methods

showsPrec :: Int -> XMod -> ShowS

show :: XMod -> String

showList :: [XMod] -> ShowS

data KeyEventType

Whether the key is pressed or released.

Since: 0.2.0.0

Constructors

KeyPress

KeyRelease

Instances

Bounded KeyEventType

Defined in WildBind.X11.Internal.Key

Methods

minBound :: KeyEventType

maxBound :: KeyEventType

Enum KeyEventType

Defined in WildBind.X11.Internal.Key

Methods

succ :: KeyEventType -> KeyEventType

pred :: KeyEventType -> KeyEventType

toEnum :: Int -> KeyEventType

fromEnum :: KeyEventType -> Int

enumFrom :: KeyEventType -> [KeyEventType]

enumFromThen :: KeyEventType -> KeyEventType -> [KeyEventType]

enumFromTo :: KeyEventType -> KeyEventType -> [KeyEventType]

enumFromThenTo :: KeyEventType -> KeyEventType -> KeyEventType -> [KeyEventType]

Eq KeyEventType

Defined in WildBind.X11.Internal.Key

Methods

(==) :: KeyEventType -> KeyEventType -> Bool

(/=) :: KeyEventType -> KeyEventType -> Bool

Ord KeyEventType

Defined in WildBind.X11.Internal.Key

Methods

compare :: KeyEventType -> KeyEventType -> Ordering

(<) :: KeyEventType -> KeyEventType -> Bool

(<=) :: KeyEventType -> KeyEventType -> Bool

(>) :: KeyEventType -> KeyEventType -> Bool

(>=) :: KeyEventType -> KeyEventType -> Bool

max :: KeyEventType -> KeyEventType -> KeyEventType

min :: KeyEventType -> KeyEventType -> KeyEventType

Show KeyEventType

Defined in WildBind.X11.Internal.Key

Methods

showsPrec :: Int -> KeyEventType -> ShowS

show :: KeyEventType -> String

showList :: [KeyEventType] -> ShowS

class ToXKeyEvent k where

Something that can converted to XKeyEvent.

Since: 0.2.0.0

Methods

toXKeyEvent :: k -> XKeyEvent

Instances

ToXKeyEvent KeySym

KeyPress event of KeySym with empty XMod set.

Defined in WildBind.X11.Internal.Key

Methods

toXKeyEvent :: KeySym -> XKeyEvent

ToXKeyEvent XKeyEvent

Defined in WildBind.X11.Internal.Key

Methods

toXKeyEvent :: XKeyEvent -> XKeyEvent

(ToXKeyEvent a, ToXKeyEvent b) => ToXKeyEvent (Either a b)

Defined in WildBind.X11.Internal.Key

Methods

toXKeyEvent :: Either a b -> XKeyEvent

Setters

press :: ToXKeyEvent k => k -> XKeyEvent

Set KeyPress to xKeyEventType.

Since: 0.2.0.0

release :: ToXKeyEvent k => k -> XKeyEvent

Set KeyRelease to xKeyEventType.

Since: 0.2.0.0

shift :: ToXKeyEvent k => k -> XKeyEvent

Add Shift modifier to xKeyEventMods.

Since: 0.2.0.0

ctrl :: ToXKeyEvent k => k -> XKeyEvent

Add Ctrl modifier to xKeyEventMods.

Since: 0.2.0.0

alt :: ToXKeyEvent k => k -> XKeyEvent

Add Alt modifier to xKeyEventMods.

Since: 0.2.0.0

super :: ToXKeyEvent k => k -> XKeyEvent

Add Super modifier to xKeyEventMods.

Since: 0.2.0.0

addXMod :: ToXKeyEvent k => XMod -> k -> XKeyEvent

Add a XMod to xKeyEventMods.

Since: 0.2.0.0

X11Front

data X11Front k

The X11 front-end. k is the input key type.

This is the implementation of the FrontEnd given by withFrontEnd function. With this object, you can do more advanced actions. See WildBind.X11.Emulate.

X11Front is relatively low-level interface, so it's more likely for this API to change in the future than FrontEnd.

Since: 0.2.0.0

withX11Front :: (X11Front k -> IO a) -> IO a

Same as withFrontEnd, but it creates X11Front. To create FrontEnd, use makeFrontEnd.

Since: 0.2.0.0

makeFrontEnd :: (XKeyInput k, Describable k, Ord k) => X11Front k -> FrontEnd ActiveWindow k

Create FrontEnd from X11Front object.

Since: 0.2.0.0

defaultRootWindow :: X11Front k -> Window

Get the default root window.

Since: 0.2.0.0