License	BSD-3-Clause
Safe Haskell	Safe-Inferred
Language	Haskell2010

Swarm.Language.Key

Contents

Orphan instances

Description

Parsing and pretty-printing for keys (as in, keys on a keyboard) and key combos.

Synopsis

data KeyCombo
mkKeyCombo :: [Modifier] -> Key -> KeyCombo
parseKeyComboFull :: Parser KeyCombo
parseKeyCombo :: Parser KeyCombo
prettyKeyCombo :: KeyCombo -> Text
specialKeyNames :: Set Text

Documentation

data KeyCombo Source #

A keyboard input, represented as a key + modifiers. Invariant: the modifier list is always sorted.

Instances

Instances details

FromJSON KeyCombo Source #
Instance details Defined in Swarm.Language.Key Methods parseJSON :: Value -> Parser KeyCombo # parseJSONList :: Value -> Parser [KeyCombo] #
ToJSON KeyCombo Source #
Instance details Defined in Swarm.Language.Key Methods toJSON :: KeyCombo -> Value # toEncoding :: KeyCombo -> Encoding # toJSONList :: [KeyCombo] -> Value # toEncodingList :: [KeyCombo] -> Encoding #
Generic KeyCombo Source #
Instance details Defined in Swarm.Language.Key Associated Types type Rep KeyCombo :: Type -> Type # Methods from :: KeyCombo -> Rep KeyCombo x # to :: Rep KeyCombo x -> KeyCombo #
Show KeyCombo Source #
Instance details Defined in Swarm.Language.Key Methods showsPrec :: Int -> KeyCombo -> ShowS # show :: KeyCombo -> String # showList :: [KeyCombo] -> ShowS #
Eq KeyCombo Source #
Instance details Defined in Swarm.Language.Key Methods (==) :: KeyCombo -> KeyCombo -> Bool # (/=) :: KeyCombo -> KeyCombo -> Bool #
Ord KeyCombo Source #
Instance details Defined in Swarm.Language.Key Methods compare :: KeyCombo -> KeyCombo -> Ordering # (<) :: KeyCombo -> KeyCombo -> Bool # (<=) :: KeyCombo -> KeyCombo -> Bool # (>) :: KeyCombo -> KeyCombo -> Bool # (>=) :: KeyCombo -> KeyCombo -> Bool # max :: KeyCombo -> KeyCombo -> KeyCombo # min :: KeyCombo -> KeyCombo -> KeyCombo #
type Rep KeyCombo Source #
Instance details Defined in Swarm.Language.Key type Rep KeyCombo = D1 ('MetaData "KeyCombo" "Swarm.Language.Key" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) (C1 ('MetaCons "KeyCombo" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Key) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Modifier])))

mkKeyCombo :: [Modifier] -> Key -> KeyCombo Source #

Smart constructor for KeyCombo.

parseKeyComboFull :: Parser KeyCombo Source #

Parse a key combo with nothing after it.

parseKeyCombo :: Parser KeyCombo Source #

Parse a key combo like "M-C-F5", "Down", or "C-x".

prettyKeyCombo :: KeyCombo -> Text Source #

Pretty-print a key combo, e.g. "C-M-F5". Right inverse to parseKeyCombo. Left inverse up to reordering of modifiers.

specialKeyNames :: Set Text Source #

Orphan instances

FromJSON Key Source #
Instance details Methods parseJSON :: Value -> Parser Key # parseJSONList :: Value -> Parser [Key] #
FromJSON Modifier Source #
Instance details Methods parseJSON :: Value -> Parser Modifier # parseJSONList :: Value -> Parser [Modifier] #
ToJSON Key Source #
Instance details Methods toJSON :: Key -> Value # toEncoding :: Key -> Encoding # toJSONList :: [Key] -> Value # toEncodingList :: [Key] -> Encoding #
ToJSON Modifier Source #
Instance details Methods toJSON :: Modifier -> Value # toEncoding :: Modifier -> Encoding # toJSONList :: [Modifier] -> Value # toEncodingList :: [Modifier] -> Encoding #