swarm-0.7.0.0: 2D resource gathering game with programmable robots
LicenseBSD-3-Clause
Safe HaskellNone
LanguageHaskell2010

Swarm.Language.Key

Description

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

Synopsis

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] #

omittedField :: Maybe KeyCombo #

ToJSON KeyCombo Source # 
Instance details

Defined in Swarm.Language.Key

Methods

toJSON :: KeyCombo -> Value #

toEncoding :: KeyCombo -> Encoding #

toJSONList :: [KeyCombo] -> Value #

toEncodingList :: [KeyCombo] -> Encoding #

omitField :: KeyCombo -> Bool #

Generic KeyCombo Source # 
Instance details

Defined in Swarm.Language.Key

Associated Types

type Rep KeyCombo 
Instance details

Defined in Swarm.Language.Key

type Rep KeyCombo = D1 ('MetaData "KeyCombo" "Swarm.Language.Key" "swarm-0.7.0.0-IuFfgHrMoE7JrptOBRVOwx-swarm-lang" '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])))

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 #

Hashable KeyCombo Source # 
Instance details

Defined in Swarm.Language.Key

Methods

hashWithSalt :: Int -> KeyCombo -> Int #

hash :: KeyCombo -> Int #

type Rep KeyCombo Source # 
Instance details

Defined in Swarm.Language.Key

type Rep KeyCombo = D1 ('MetaData "KeyCombo" "Swarm.Language.Key" "swarm-0.7.0.0-IuFfgHrMoE7JrptOBRVOwx-swarm-lang" '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 :: SParser KeyCombo Source #

Parse a key combo with nothing after it.

parseKeyCombo :: SParser 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