Karabiner.Config

Provides support for generating a Karabiner config via Haskell.

Documentation

mkMain :: Root -> IO ()

Builds a main function which outputs the given Root as JSON.

encodeRoot :: Root -> ByteString

Encode a Root to a JSON lazy ByteString.

litPat :: Text -> Text

Converts a text literal to an application regex pattern.

data KeyBinding a

Represents a key binding of [a] modifiers (e.g. shift, control) and a key code. The a is polymorphic so we can make distinctions between PhysicalModifier and MetaModifier.

Constructors

KeyBinding [a] KeyCode

Instances

(TypeError (('Text "Unsupported ManipulatorBuilder (!>) usage;" :$$: 'Text "'to' binding must use a PhysicalModifier (e.g. RightControl)") :$$: 'Text "not a MetaModifier (e.g. Control)") :: Constraint) => ManipulatorBuilder a (KeyBinding MetaModifier)

Defined in Karabiner.Config

Methods

(!>) :: a -> KeyBinding MetaModifier -> Manipulator

AsAnyModifier a => ManipulatorBuilder (KeyBinding a) KeyCode

Defined in Karabiner.Config

Methods

(!>) :: KeyBinding a -> KeyCode -> Manipulator

AsAnyModifier a => ManipulatorBuilder (KeyBinding a) [KeyBinding PhysicalModifier]

Defined in Karabiner.Config

Methods

(!>) :: KeyBinding a -> [KeyBinding PhysicalModifier] -> Manipulator

AsAnyModifier a => ManipulatorBuilder (KeyBinding a) (KeyBinding PhysicalModifier)

Defined in Karabiner.Config

Methods

(!>) :: KeyBinding a -> KeyBinding PhysicalModifier -> Manipulator

singleKey :: KeyCode -> KeyBinding PhysicalModifier

Key binding with no modifiers.

(|->) :: KeyBinding a -> KeyBinding a -> [KeyBinding a] infix 5

Helper for a key binding sequence, only slightly prettier than using a list.

class ToKeyBinding a b c | a b -> c where

Type class for constructing a single key binding from multiple keys.

Methods

(|+|) :: a -> b -> KeyBinding c infix 6

Instances

ToKeyBinding MetaModifier KeyCode MetaModifier

Defined in Karabiner.Config

Methods

(|+|) :: MetaModifier -> KeyCode -> KeyBinding MetaModifier

ToKeyBinding PhysicalModifier KeyCode PhysicalModifier

Defined in Karabiner.Config

Methods

(|+|) :: PhysicalModifier -> KeyCode -> KeyBinding PhysicalModifier

ToKeyBinding [MetaModifier] KeyCode MetaModifier

Defined in Karabiner.Config

Methods

(|+|) :: [MetaModifier] -> KeyCode -> KeyBinding MetaModifier

ToKeyBinding [PhysicalModifier] KeyCode PhysicalModifier

Defined in Karabiner.Config

Methods

(|+|) :: [PhysicalModifier] -> KeyCode -> KeyBinding PhysicalModifier

class ManipulatorBuilder a b where

Maps first KeyBinding to second KeyBinding We can map physical modifiers to physical modifiers or meta modifiers to physical modifiers, but we can't (or rather, shouldn't) map any modifiers to meta modifiers; these type class instances enforce this. We provide an instance for this via TypeError to provide nice error messages.

Methods

(!>) :: a -> b -> Manipulator infix 4

Instances

(TypeError (('Text "Unsupported ManipulatorBuilder (!>) usage;" :$$: 'Text "'to' binding must use a PhysicalModifier (e.g. RightControl)") :$$: 'Text "not a MetaModifier (e.g. Control)") :: Constraint) => ManipulatorBuilder a (KeyBinding MetaModifier)

Defined in Karabiner.Config

Methods

(!>) :: a -> KeyBinding MetaModifier -> Manipulator

AsAnyModifier a => ManipulatorBuilder (KeyBinding a) KeyCode

Defined in Karabiner.Config

Methods

(!>) :: KeyBinding a -> KeyCode -> Manipulator

AsAnyModifier a => ManipulatorBuilder (KeyBinding a) [KeyBinding PhysicalModifier]

Defined in Karabiner.Config

Methods

(!>) :: KeyBinding a -> [KeyBinding PhysicalModifier] -> Manipulator

AsAnyModifier a => ManipulatorBuilder (KeyBinding a) (KeyBinding PhysicalModifier)

Defined in Karabiner.Config

Methods

(!>) :: KeyBinding a -> KeyBinding PhysicalModifier -> Manipulator

frontmostApplicationIf :: Manipulator -> [Text] -> Manipulator

Adds frontmost_application_if condition to Manipulator

(?) :: Manipulator -> [Text] -> Manipulator

Alias for frontmostApplicationIf

(??) :: [Manipulator] -> [Text] -> [Manipulator]

Same as frontmostApplicationIf except updates a list of Manipulator

frontmostApplicationUnless :: Manipulator -> [Text] -> Manipulator

Adds frontmost_application_unless condition to Manipulator

(?!) :: Manipulator -> [Text] -> Manipulator infix 3

Alias for frontmostApplicationUnless

(??!) :: [Manipulator] -> [Text] -> [Manipulator]

Same as ?! except updates a list of Manipulator

data Root

Most top-level node of the karabiner config

Constructors

Root

Fields

• rootTitle :: Text
• rootRules :: [Rule]

Instances

ToJSON Root

Defined in Karabiner.Config

Methods

toJSON :: Root -> Value

toEncoding :: Root -> Encoding

toJSONList :: [Root] -> Value

toEncodingList :: [Root] -> Encoding

data Rule

A set of manupulations that can be enabled or disabled via the Complex modifications section in the Karabiner UI.

Constructors

Rule

Fields

• ruleDescription :: Text
• ruleManipulators :: [Manipulator]

Instances

ToJSON Rule

Defined in Karabiner.Config

Methods

toJSON :: Rule -> Value

toEncoding :: Rule -> Encoding

toJSONList :: [Rule] -> Value

toEncodingList :: [Rule] -> Encoding

data Manipulator

A configured key rebinding

Constructors

Manipulator

Fields

• manipulatorType :: ManipulatorType
• manipulatorFrom :: ManipulatorFrom
• manipulatorTo :: [ManipulatorTo]
• manipulatorConditions :: Maybe [ManipulatorCondition]

Instances

ToJSON Manipulator

Defined in Karabiner.Config

Methods

toJSON :: Manipulator -> Value

toEncoding :: Manipulator -> Encoding

toJSONList :: [Manipulator] -> Value

toEncodingList :: [Manipulator] -> Encoding

data ManipulatorType

Constructors

Basic

Instances

ToJSON ManipulatorType

Defined in Karabiner.Config

Methods

toJSON :: ManipulatorType -> Value

toEncoding :: ManipulatorType -> Encoding

toJSONList :: [ManipulatorType] -> Value

toEncodingList :: [ManipulatorType] -> Encoding

manipulatorTypeToText :: ManipulatorType -> Text

data ManipulatorFrom

Constructors

ManipulatorFrom

Fields

• fromKeyCode :: KeyCode
• fromModifiers :: FromModifiers

Instances

ToJSON ManipulatorFrom

Defined in Karabiner.Config

Methods

toJSON :: ManipulatorFrom -> Value

toEncoding :: ManipulatorFrom -> Encoding

toJSONList :: [ManipulatorFrom] -> Value

toEncodingList :: [ManipulatorFrom] -> Encoding

data ManipulatorTo

Constructors

ManipulatorTo

Fields

• toKeyCode :: KeyCode
• toModifiers :: [PhysicalModifier]

Instances

ToJSON ManipulatorTo

Defined in Karabiner.Config

Methods

toJSON :: ManipulatorTo -> Value

toEncoding :: ManipulatorTo -> Encoding

toJSONList :: [ManipulatorTo] -> Value

toEncodingList :: [ManipulatorTo] -> Encoding

data ManipulatorCondition

Constructors

ManipulatorCondition

Fields

• conditionType :: ManipulatorConditionType
• conditionBundleIdentifiers :: [Text]

Instances

ToJSON ManipulatorCondition

Defined in Karabiner.Config

Methods

toJSON :: ManipulatorCondition -> Value

toEncoding :: ManipulatorCondition -> Encoding

toJSONList :: [ManipulatorCondition] -> Value

toEncodingList :: [ManipulatorCondition] -> Encoding

data ManipulatorConditionType

Constructors

FrontmostApplicationUnless

FrontmostApplicationIf

Instances

ToJSON ManipulatorConditionType

Defined in Karabiner.Config

Methods

toJSON :: ManipulatorConditionType -> Value

toEncoding :: ManipulatorConditionType -> Encoding

toJSONList :: [ManipulatorConditionType] -> Value

toEncodingList :: [ManipulatorConditionType] -> Encoding

manipulatorConditionTypeToText :: ManipulatorConditionType -> Text

data FromModifiers

Constructors

FromModifiers

Fields

• modifiersMandatory :: [AnyModifier]

Instances

ToJSON FromModifiers

Defined in Karabiner.Config

Methods

toJSON :: FromModifiers -> Value

toEncoding :: FromModifiers -> Encoding

toJSONList :: [FromModifiers] -> Value

toEncodingList :: [FromModifiers] -> Encoding

data PhysicalModifier

Constructors

LeftShift

RightShift

LeftControl

RightControl

LeftOption

RightOption

LeftCommand

RightCommand

Instances

ToJSON PhysicalModifier

Defined in Karabiner.Config

Methods

toJSON :: PhysicalModifier -> Value

toEncoding :: PhysicalModifier -> Encoding

toJSONList :: [PhysicalModifier] -> Value

toEncodingList :: [PhysicalModifier] -> Encoding

AsAnyModifier PhysicalModifier

Defined in Karabiner.Config

Methods

asAnyModifier :: PhysicalModifier -> AnyModifier

ToKeyBinding PhysicalModifier KeyCode PhysicalModifier

Defined in Karabiner.Config

Methods

(|+|) :: PhysicalModifier -> KeyCode -> KeyBinding PhysicalModifier

ToKeyBinding [PhysicalModifier] KeyCode PhysicalModifier

Defined in Karabiner.Config

Methods

(|+|) :: [PhysicalModifier] -> KeyCode -> KeyBinding PhysicalModifier

AsAnyModifier a => ManipulatorBuilder (KeyBinding a) [KeyBinding PhysicalModifier]

Defined in Karabiner.Config

Methods

(!>) :: KeyBinding a -> [KeyBinding PhysicalModifier] -> Manipulator

AsAnyModifier a => ManipulatorBuilder (KeyBinding a) (KeyBinding PhysicalModifier)

Defined in Karabiner.Config

Methods

(!>) :: KeyBinding a -> KeyBinding PhysicalModifier -> Manipulator

data MetaModifier

Constructors

Shift

Control

Option

Command

Instances

ToJSON MetaModifier

Defined in Karabiner.Config

Methods

toJSON :: MetaModifier -> Value

toEncoding :: MetaModifier -> Encoding

toJSONList :: [MetaModifier] -> Value

toEncodingList :: [MetaModifier] -> Encoding

AsAnyModifier MetaModifier

Defined in Karabiner.Config

Methods

asAnyModifier :: MetaModifier -> AnyModifier

ToKeyBinding MetaModifier KeyCode MetaModifier

Defined in Karabiner.Config

Methods

(|+|) :: MetaModifier -> KeyCode -> KeyBinding MetaModifier

(TypeError (('Text "Unsupported ManipulatorBuilder (!>) usage;" :$$: 'Text "'to' binding must use a PhysicalModifier (e.g. RightControl)") :$$: 'Text "not a MetaModifier (e.g. Control)") :: Constraint) => ManipulatorBuilder a (KeyBinding MetaModifier)

Defined in Karabiner.Config

Methods

(!>) :: a -> KeyBinding MetaModifier -> Manipulator

ToKeyBinding [MetaModifier] KeyCode MetaModifier

Defined in Karabiner.Config

Methods

(|+|) :: [MetaModifier] -> KeyCode -> KeyBinding MetaModifier

data AnyModifier

Constructors

ModifierFromPhysical PhysicalModifier

ModifierFromMeta MetaModifier

Instances

ToJSON AnyModifier

Defined in Karabiner.Config

Methods

toJSON :: AnyModifier -> Value

toEncoding :: AnyModifier -> Encoding

toJSONList :: [AnyModifier] -> Value

toEncodingList :: [AnyModifier] -> Encoding

class AsAnyModifier a where

Methods

asAnyModifier :: a -> AnyModifier

Instances

AsAnyModifier MetaModifier

Defined in Karabiner.Config

Methods

asAnyModifier :: MetaModifier -> AnyModifier

AsAnyModifier PhysicalModifier

Defined in Karabiner.Config

Methods

asAnyModifier :: PhysicalModifier -> AnyModifier

data KeyCode

Key codes available for binding The full list can be viewed in the Karabiner-Elements source https://github.com/tekezo/Karabiner-Elements/blob/master/src/share/types.hpp

Constructors

A

B

C

D

E

F

G

H

I

J

K

L

M

N

O

P

Q

R

S

T

U

V

W

X

Y

Z

One

Two

Three

Four

Five

Six

Seven

Eight

Nine

Zero

Spacebar

Backspace

OpenBracket

CloseBracket

RightArrow

LeftArrow

UpArrow

DownArrow

ReturnOrEnter

Tab

Comma

Semicolon

Instances

ToJSON KeyCode

Defined in Karabiner.Config

Methods

toJSON :: KeyCode -> Value

toEncoding :: KeyCode -> Encoding

toJSONList :: [KeyCode] -> Value

toEncodingList :: [KeyCode] -> Encoding

ToKeyBinding MetaModifier KeyCode MetaModifier

Defined in Karabiner.Config

Methods

(|+|) :: MetaModifier -> KeyCode -> KeyBinding MetaModifier

ToKeyBinding PhysicalModifier KeyCode PhysicalModifier

Defined in Karabiner.Config

Methods

(|+|) :: PhysicalModifier -> KeyCode -> KeyBinding PhysicalModifier

AsAnyModifier a => ManipulatorBuilder (KeyBinding a) KeyCode

Defined in Karabiner.Config

Methods

(!>) :: KeyBinding a -> KeyCode -> Manipulator

ToKeyBinding [MetaModifier] KeyCode MetaModifier

Defined in Karabiner.Config

Methods

(|+|) :: [MetaModifier] -> KeyCode -> KeyBinding MetaModifier

ToKeyBinding [PhysicalModifier] KeyCode PhysicalModifier

Defined in Karabiner.Config

Methods

(|+|) :: [PhysicalModifier] -> KeyCode -> KeyBinding PhysicalModifier

numbers :: [KeyCode]

keyCodeToString :: IsString a => KeyCode -> a