Workflow.Types

Documentation

WorkflowF

data WorkflowF k

platform-agnostic workflows, which can be interpreted by platform-specific bindings.

Naming: WorkflowF for "Workflow Functor".

NOTE: currently, no error codes are returned (only ())). this (1) simplifies bindings and (2) saves the user from explicitly ignoring action results (e.g. _ <- getClipboard). later, they can be supported, alongside wrappers that return () and throw SomeException and provide the same simple API. since the intented usage of workflows are as user-facing (often user-written) scripts, and the monad that satisifes MonadWorkflow will often satisify MonadIO too, convenient partial functions that throw a helpful error message to stdout (the error codes should be converted to their error messages) should suffice. and either way, is strictly better for the user than ignoring, as the exceptions can always be caught, or not displayed.

Constructors

SendKeyChord [Modifier] Key k

press the Key while the Modifiers are held down. sent to the current application. TODO | SendKeyChordTo Application [Modifier] Key k -- ^ TODO | SendKeyChordTo Window [Modifier] Key k -- ^ versus unary: ([Modifier], Key) rn SendChord

SendText String k

a logical grouping for: (1) unicode support (2) efficiency and (3) debugging. sent to the current application.

SendMouseClick [Modifier] Natural MouseButton k

click the button, some number of times, holding down the modifiers derived, make method, not constructor. sent to the current application.

SendMouseScroll [Modifier] MouseScroll Natural k

spin the wheel, some number of units*, holding down the modifiers

GetClipboard (Clipboard -> k)

SetClipboard Clipboard k

CurrentApplication (Application -> k)

like getter

OpenApplication Application k

like setter

OpenURL URL k

Delay MilliSeconds k

interpreted as threadDelay on all platforms; included for convenience

Instances

Functor WorkflowF

Methods

fmap :: (a -> b) -> WorkflowF a -> WorkflowF b

(<$) :: a -> WorkflowF b -> WorkflowF a

data Workflow_

the non-monadic subset of WorkflowF. i.e. all cases that return (), preserving the previous continuation.

Naming: "unit workflow", like "traverse_".

Constructors

SendKeyChord_ [Modifier] Key

SendText_ String

SendMouseClick_ [Modifier] Natural MouseButton

SendMouseScroll_ [Modifier] MouseScroll Natural

SetClipboard_ Clipboard

OpenApplication_ Application

OpenURL_ URL

Delay_ MilliSeconds

Instances

Eq Workflow_

Methods

(==) :: Workflow_ -> Workflow_ -> Bool

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

Data Workflow_

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Workflow_ -> c Workflow_

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Workflow_

toConstr :: Workflow_ -> Constr

dataTypeOf :: Workflow_ -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Workflow_)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Workflow_)

gmapT :: (forall b. Data b => b -> b) -> Workflow_ -> Workflow_

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Workflow_ -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Workflow_ -> r

gmapQ :: (forall d. Data d => d -> u) -> Workflow_ -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Workflow_ -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Workflow_ -> m Workflow_

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Workflow_ -> m Workflow_

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Workflow_ -> m Workflow_

Ord Workflow_

Methods

compare :: Workflow_ -> Workflow_ -> Ordering

(<) :: Workflow_ -> Workflow_ -> Bool

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

(>) :: Workflow_ -> Workflow_ -> Bool

(>=) :: Workflow_ -> Workflow_ -> Bool

max :: Workflow_ -> Workflow_ -> Workflow_

min :: Workflow_ -> Workflow_ -> Workflow_

Read Workflow_

Methods

readsPrec :: Int -> ReadS Workflow_

readList :: ReadS [Workflow_]

readPrec :: ReadPrec Workflow_

readListPrec :: ReadPrec [Workflow_]

Show Workflow_

Methods

showsPrec :: Int -> Workflow_ -> ShowS

show :: Workflow_ -> String

showList :: [Workflow_] -> ShowS

Generic Workflow_

Associated Types

type Rep Workflow_ :: * -> *

Methods

from :: Workflow_ -> Rep Workflow_ x

to :: Rep Workflow_ x -> Workflow_

NFData Workflow_

Methods

rnf :: Workflow_ -> ()

type Rep Workflow_

type Rep Workflow_ = D1 (MetaData "Workflow_" "Workflow.Types" "workflow-types-0.0.0-K0EoQCaTrIdFAFcwhnivNQ" False) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "SendKeyChord_" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Modifier])) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Key)))) (C1 (MetaCons "SendText_" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))) ((:+:) (C1 (MetaCons "SendMouseClick_" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Modifier])) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Natural)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MouseButton))))) (C1 (MetaCons "SendMouseScroll_" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Modifier])) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MouseScroll)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Natural))))))) ((:+:) ((:+:) (C1 (MetaCons "SetClipboard_" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Clipboard))) (C1 (MetaCons "OpenApplication_" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Application)))) ((:+:) (C1 (MetaCons "OpenURL_" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 URL))) (C1 (MetaCons "Delay_" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MilliSeconds))))))

type MonadWorkflow m = (MonadFree WorkflowF m, MonadThrow m)

abstract interface.

a monad constraint for "workflow effects" (just like MonadState is for "state effects"). Can be used in any monad transformer stack that handles them.

WorkflowF holds the effects.

MonadThrow supports:

• press, if the user's syntax is wrong
• error messages from the underlying system calls (TODO e.g. Win32's GetLastError())

type MonadWorkflow_ = MonadFree WorkflowF

(without failability)

type WorkflowT = FreeT WorkflowF

concrete transformer.

type Workflow = Free WorkflowF

concrete monad.

type Clipboard = String

type Application = String

type URL = String

type MilliSeconds = Int

data MouseButton

Operating systems always (?) support at least these mouse events.

Most mice have these three buttons, trackpads have left/right.

Constructors

LeftButton

MiddleButton

RightButton

Instances

Bounded MouseButton

Methods

minBound :: MouseButton

maxBound :: MouseButton

Enum MouseButton

Methods

succ :: MouseButton -> MouseButton

pred :: MouseButton -> MouseButton

toEnum :: Int -> MouseButton

fromEnum :: MouseButton -> Int

enumFrom :: MouseButton -> [MouseButton]

enumFromThen :: MouseButton -> MouseButton -> [MouseButton]

enumFromTo :: MouseButton -> MouseButton -> [MouseButton]

enumFromThenTo :: MouseButton -> MouseButton -> MouseButton -> [MouseButton]

Eq MouseButton

Methods

(==) :: MouseButton -> MouseButton -> Bool

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

Data MouseButton

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MouseButton -> c MouseButton

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MouseButton

toConstr :: MouseButton -> Constr

dataTypeOf :: MouseButton -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c MouseButton)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MouseButton)

gmapT :: (forall b. Data b => b -> b) -> MouseButton -> MouseButton

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MouseButton -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MouseButton -> r

gmapQ :: (forall d. Data d => d -> u) -> MouseButton -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> MouseButton -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MouseButton -> m MouseButton

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MouseButton -> m MouseButton

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MouseButton -> m MouseButton

Ord MouseButton

Methods

compare :: MouseButton -> MouseButton -> Ordering

(<) :: MouseButton -> MouseButton -> Bool

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

(>) :: MouseButton -> MouseButton -> Bool

(>=) :: MouseButton -> MouseButton -> Bool

max :: MouseButton -> MouseButton -> MouseButton

min :: MouseButton -> MouseButton -> MouseButton

Read MouseButton

Methods

readsPrec :: Int -> ReadS MouseButton

readList :: ReadS [MouseButton]

readPrec :: ReadPrec MouseButton

readListPrec :: ReadPrec [MouseButton]

Show MouseButton

Methods

showsPrec :: Int -> MouseButton -> ShowS

show :: MouseButton -> String

showList :: [MouseButton] -> ShowS

Generic MouseButton

Associated Types

type Rep MouseButton :: * -> *

Methods

from :: MouseButton -> Rep MouseButton x

to :: Rep MouseButton x -> MouseButton

NFData MouseButton

Methods

rnf :: MouseButton -> ()

type Rep MouseButton

type Rep MouseButton = D1 (MetaData "MouseButton" "Workflow.Types" "workflow-types-0.0.0-K0EoQCaTrIdFAFcwhnivNQ" False) ((:+:) (C1 (MetaCons "LeftButton" PrefixI False) U1) ((:+:) (C1 (MetaCons "MiddleButton" PrefixI False) U1) (C1 (MetaCons "RightButton" PrefixI False) U1)))

data MouseScroll

Mouse wheel scrolling, vertically and horizontally.

ScrollTowards:

• scrolls up when "natural scrolling" is disabled
• scrolls down when "natural scrolling" is enabled

TODO check

Constructors

ScrollTowards

ScrollAway

ScrollLeft

ScrollRight

Instances

Bounded MouseScroll

Methods

minBound :: MouseScroll

maxBound :: MouseScroll

Enum MouseScroll

Methods

succ :: MouseScroll -> MouseScroll

pred :: MouseScroll -> MouseScroll

toEnum :: Int -> MouseScroll

fromEnum :: MouseScroll -> Int

enumFrom :: MouseScroll -> [MouseScroll]

enumFromThen :: MouseScroll -> MouseScroll -> [MouseScroll]

enumFromTo :: MouseScroll -> MouseScroll -> [MouseScroll]

enumFromThenTo :: MouseScroll -> MouseScroll -> MouseScroll -> [MouseScroll]

Eq MouseScroll

Methods

(==) :: MouseScroll -> MouseScroll -> Bool

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

Data MouseScroll

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MouseScroll -> c MouseScroll

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MouseScroll

toConstr :: MouseScroll -> Constr

dataTypeOf :: MouseScroll -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c MouseScroll)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MouseScroll)

gmapT :: (forall b. Data b => b -> b) -> MouseScroll -> MouseScroll

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MouseScroll -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MouseScroll -> r

gmapQ :: (forall d. Data d => d -> u) -> MouseScroll -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> MouseScroll -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MouseScroll -> m MouseScroll

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MouseScroll -> m MouseScroll

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MouseScroll -> m MouseScroll

Ord MouseScroll

Methods

compare :: MouseScroll -> MouseScroll -> Ordering

(<) :: MouseScroll -> MouseScroll -> Bool

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

(>) :: MouseScroll -> MouseScroll -> Bool

(>=) :: MouseScroll -> MouseScroll -> Bool

max :: MouseScroll -> MouseScroll -> MouseScroll

min :: MouseScroll -> MouseScroll -> MouseScroll

Read MouseScroll

Methods

readsPrec :: Int -> ReadS MouseScroll

readList :: ReadS [MouseScroll]

readPrec :: ReadPrec MouseScroll

readListPrec :: ReadPrec [MouseScroll]

Show MouseScroll

Methods

showsPrec :: Int -> MouseScroll -> ShowS

show :: MouseScroll -> String

showList :: [MouseScroll] -> ShowS

Generic MouseScroll

Associated Types

type Rep MouseScroll :: * -> *

Methods

from :: MouseScroll -> Rep MouseScroll x

to :: Rep MouseScroll x -> MouseScroll

NFData MouseScroll

Methods

rnf :: MouseScroll -> ()

type Rep MouseScroll

type Rep MouseScroll = D1 (MetaData "MouseScroll" "Workflow.Types" "workflow-types-0.0.0-K0EoQCaTrIdFAFcwhnivNQ" False) ((:+:) ((:+:) (C1 (MetaCons "ScrollTowards" PrefixI False) U1) (C1 (MetaCons "ScrollAway" PrefixI False) U1)) ((:+:) (C1 (MetaCons "ScrollLeft" PrefixI False) U1) (C1 (MetaCons "ScrollRight" PrefixI False) U1)))

type KeySequence = [KeyChord]

a sequence of key chords make up a keyboard shortcut

Naming: https://www.emacswiki.org/emacs/KeySequence

type KeyChord = ([Modifier], Key)

represents joitly holding down all the modifiers while individually press each key down and back up.

Naming: https://www.emacswiki.org/emacs/Chord

pattern KeyChord :: [Modifier] -> Key -> KeyChord

pattern KeyChord ms k = (ms,k)

pattern SimpleKeyChord :: Key -> KeyChord

data Modifier

modifier keys are keys that can be "held".

NOTE the escape key tends to be "pressed", not "held", it seems. (possibly explains its behavior in your terminal emulator?)

alt is OptionModifier.

Constructors

MetaModifier

fake modifier: Alt on Linux/Windows, Command on OSX

HyperModifier

fake modifier: Control on Linux/Windows, Command on OSX

ControlModifier

OptionModifier

ShiftModifier

FunctionModifier

Instances

Bounded Modifier

Methods

minBound :: Modifier

maxBound :: Modifier

Enum Modifier

Methods

succ :: Modifier -> Modifier

pred :: Modifier -> Modifier

toEnum :: Int -> Modifier

fromEnum :: Modifier -> Int

enumFrom :: Modifier -> [Modifier]

enumFromThen :: Modifier -> Modifier -> [Modifier]

enumFromTo :: Modifier -> Modifier -> [Modifier]

enumFromThenTo :: Modifier -> Modifier -> Modifier -> [Modifier]

Eq Modifier

Methods

(==) :: Modifier -> Modifier -> Bool

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

Data Modifier

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Modifier -> c Modifier

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Modifier

toConstr :: Modifier -> Constr

dataTypeOf :: Modifier -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Modifier)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Modifier)

gmapT :: (forall b. Data b => b -> b) -> Modifier -> Modifier

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Modifier -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Modifier -> r

gmapQ :: (forall d. Data d => d -> u) -> Modifier -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Modifier -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Modifier -> m Modifier

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Modifier -> m Modifier

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Modifier -> m Modifier

Ord Modifier

Methods

compare :: Modifier -> Modifier -> Ordering

(<) :: Modifier -> Modifier -> Bool

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

(>) :: Modifier -> Modifier -> Bool

(>=) :: Modifier -> Modifier -> Bool

max :: Modifier -> Modifier -> Modifier

min :: Modifier -> Modifier -> Modifier

Read Modifier

Methods

readsPrec :: Int -> ReadS Modifier

readList :: ReadS [Modifier]

readPrec :: ReadPrec Modifier

readListPrec :: ReadPrec [Modifier]

Show Modifier

Methods

showsPrec :: Int -> Modifier -> ShowS

show :: Modifier -> String

showList :: [Modifier] -> ShowS

Generic Modifier

Associated Types

type Rep Modifier :: * -> *

Methods

from :: Modifier -> Rep Modifier x

to :: Rep Modifier x -> Modifier

NFData Modifier

Methods

rnf :: Modifier -> ()

type Rep Modifier

type Rep Modifier = D1 (MetaData "Modifier" "Workflow.Types" "workflow-types-0.0.0-K0EoQCaTrIdFAFcwhnivNQ" False) ((:+:) ((:+:) (C1 (MetaCons "MetaModifier" PrefixI False) U1) ((:+:) (C1 (MetaCons "HyperModifier" PrefixI False) U1) (C1 (MetaCons "ControlModifier" PrefixI False) U1))) ((:+:) (C1 (MetaCons "OptionModifier" PrefixI False) U1) ((:+:) (C1 (MetaCons "ShiftModifier" PrefixI False) U1) (C1 (MetaCons "FunctionModifier" PrefixI False) U1))))

data Key

a "cross-platform" keyboard, that has:

• all keys that exist on standard keyboards.
• plus, MetaKey and HyperKey: virtual modifiers to abstract over common keyboard shortcuts.

(let me know if you want a type to support cross-platform international keyboards, i haven't looked into it. you can still use the platform-specific virtual-key-codes in the dependent packages: workflow-linux, workflow-osx, and workflow-windows)

Constructors

MetaKey

fake key: Alt on Linux/Windows, Command on OSX

HyperKey

fake key: Control on Linux/Windows, Command on OSX Control/Command both have C/O/N

ControlKey

CapsLockKey

ShiftKey

OptionKey

FunctionKey

GraveKey

MinusKey

EqualKey

DeleteKey

ForwardDeleteKey

LeftBracketKey

RightBracketKey

BackslashKey

SemicolonKey

QuoteKey

CommaKey

PeriodKey

SlashKey

TabKey

SpaceKey

ReturnKey

LeftArrowKey

RightArrowKey

DownArrowKey

UpArrowKey

AKey

BKey

CKey

DKey

EKey

FKey

GKey

HKey

IKey

JKey

KKey

LKey

MKey

NKey

OKey

PKey

QKey

RKey

SKey

TKey

UKey

VKey

WKey

XKey

YKey

ZKey

ZeroKey

OneKey

TwoKey

ThreeKey

FourKey

FiveKey

SixKey

SevenKey

EightKey

NineKey

EscapeKey

F1Key

F2Key

F3Key

F4Key

F5Key

F6Key

F7Key

F8Key

F9Key

F10Key

F11Key

F12Key

F13Key

F14Key

F15Key

F16Key

F17Key

F18Key

F19Key

F20Key

Instances

Bounded Key

Methods

minBound :: Key

maxBound :: Key

Enum Key

Methods

succ :: Key -> Key

pred :: Key -> Key

toEnum :: Int -> Key

fromEnum :: Key -> Int

enumFrom :: Key -> [Key]

enumFromThen :: Key -> Key -> [Key]

enumFromTo :: Key -> Key -> [Key]

enumFromThenTo :: Key -> Key -> Key -> [Key]

Eq Key

Methods

(==) :: Key -> Key -> Bool

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

Data Key

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Key -> c Key

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Key

toConstr :: Key -> Constr

dataTypeOf :: Key -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Key)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Key)

gmapT :: (forall b. Data b => b -> b) -> Key -> Key

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Key -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Key -> r

gmapQ :: (forall d. Data d => d -> u) -> Key -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Key -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Key -> m Key

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Key -> m Key

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Key -> m Key

Ord Key

Methods

compare :: Key -> Key -> Ordering

(<) :: Key -> Key -> Bool

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

(>) :: Key -> Key -> Bool

(>=) :: Key -> Key -> Bool

max :: Key -> Key -> Key

min :: Key -> Key -> Key

Read Key

Methods

readsPrec :: Int -> ReadS Key

readList :: ReadS [Key]

readPrec :: ReadPrec Key

readListPrec :: ReadPrec [Key]

Show Key

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

Generic Key

Associated Types

type Rep Key :: * -> *

Methods

from :: Key -> Rep Key x

to :: Rep Key x -> Key

NFData Key

Methods

rnf :: Key -> ()

type Rep Key

type Rep Key = D1 (MetaData "Key" "Workflow.Types" "workflow-types-0.0.0-K0EoQCaTrIdFAFcwhnivNQ" False) ((:+:) ((:+:) ((:+:) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "MetaKey" PrefixI False) U1) (C1 (MetaCons "HyperKey" PrefixI False) U1)) ((:+:) (C1 (MetaCons "ControlKey" PrefixI False) U1) ((:+:) (C1 (MetaCons "CapsLockKey" PrefixI False) U1) (C1 (MetaCons "ShiftKey" PrefixI False) U1)))) ((:+:) ((:+:) (C1 (MetaCons "OptionKey" PrefixI False) U1) (C1 (MetaCons "FunctionKey" PrefixI False) U1)) ((:+:) (C1 (MetaCons "GraveKey" PrefixI False) U1) ((:+:) (C1 (MetaCons "MinusKey" PrefixI False) U1) (C1 (MetaCons "EqualKey" PrefixI False) U1))))) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "DeleteKey" PrefixI False) U1) (C1 (MetaCons "ForwardDeleteKey" PrefixI False) U1)) ((:+:) (C1 (MetaCons "LeftBracketKey" PrefixI False) U1) ((:+:) (C1 (MetaCons "RightBracketKey" PrefixI False) U1) (C1 (MetaCons "BackslashKey" PrefixI False) U1)))) ((:+:) ((:+:) (C1 (MetaCons "SemicolonKey" PrefixI False) U1) ((:+:) (C1 (MetaCons "QuoteKey" PrefixI False) U1) (C1 (MetaCons "CommaKey" PrefixI False) U1))) ((:+:) (C1 (MetaCons "PeriodKey" PrefixI False) U1) ((:+:) (C1 (MetaCons "SlashKey" PrefixI False) U1) (C1 (MetaCons "TabKey" PrefixI False) U1)))))) ((:+:) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "SpaceKey" PrefixI False) U1) (C1 (MetaCons "ReturnKey" PrefixI False) U1)) ((:+:) (C1 (MetaCons "LeftArrowKey" PrefixI False) U1) ((:+:) (C1 (MetaCons "RightArrowKey" PrefixI False) U1) (C1 (MetaCons "DownArrowKey" PrefixI False) U1)))) ((:+:) ((:+:) (C1 (MetaCons "UpArrowKey" PrefixI False) U1) (C1 (MetaCons "AKey" PrefixI False) U1)) ((:+:) (C1 (MetaCons "BKey" PrefixI False) U1) ((:+:) (C1 (MetaCons "CKey" PrefixI False) U1) (C1 (MetaCons "DKey" PrefixI False) U1))))) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "EKey" PrefixI False) U1) (C1 (MetaCons "FKey" PrefixI False) U1)) ((:+:) (C1 (MetaCons "GKey" PrefixI False) U1) ((:+:) (C1 (MetaCons "HKey" PrefixI False) U1) (C1 (MetaCons "IKey" PrefixI False) U1)))) ((:+:) ((:+:) (C1 (MetaCons "JKey" PrefixI False) U1) ((:+:) (C1 (MetaCons "KKey" PrefixI False) U1) (C1 (MetaCons "LKey" PrefixI False) U1))) ((:+:) (C1 (MetaCons "MKey" PrefixI False) U1) ((:+:) (C1 (MetaCons "NKey" PrefixI False) U1) (C1 (MetaCons "OKey" PrefixI False) U1))))))) ((:+:) ((:+:) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "PKey" PrefixI False) U1) (C1 (MetaCons "QKey" PrefixI False) U1)) ((:+:) (C1 (MetaCons "RKey" PrefixI False) U1) ((:+:) (C1 (MetaCons "SKey" PrefixI False) U1) (C1 (MetaCons "TKey" PrefixI False) U1)))) ((:+:) ((:+:) (C1 (MetaCons "UKey" PrefixI False) U1) (C1 (MetaCons "VKey" PrefixI False) U1)) ((:+:) (C1 (MetaCons "WKey" PrefixI False) U1) ((:+:) (C1 (MetaCons "XKey" PrefixI False) U1) (C1 (MetaCons "YKey" PrefixI False) U1))))) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "ZKey" PrefixI False) U1) (C1 (MetaCons "ZeroKey" PrefixI False) U1)) ((:+:) (C1 (MetaCons "OneKey" PrefixI False) U1) ((:+:) (C1 (MetaCons "TwoKey" PrefixI False) U1) (C1 (MetaCons "ThreeKey" PrefixI False) U1)))) ((:+:) ((:+:) (C1 (MetaCons "FourKey" PrefixI False) U1) ((:+:) (C1 (MetaCons "FiveKey" PrefixI False) U1) (C1 (MetaCons "SixKey" PrefixI False) U1))) ((:+:) (C1 (MetaCons "SevenKey" PrefixI False) U1) ((:+:) (C1 (MetaCons "EightKey" PrefixI False) U1) (C1 (MetaCons "NineKey" PrefixI False) U1)))))) ((:+:) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "EscapeKey" PrefixI False) U1) (C1 (MetaCons "F1Key" PrefixI False) U1)) ((:+:) (C1 (MetaCons "F2Key" PrefixI False) U1) ((:+:) (C1 (MetaCons "F3Key" PrefixI False) U1) (C1 (MetaCons "F4Key" PrefixI False) U1)))) ((:+:) ((:+:) (C1 (MetaCons "F5Key" PrefixI False) U1) (C1 (MetaCons "F6Key" PrefixI False) U1)) ((:+:) (C1 (MetaCons "F7Key" PrefixI False) U1) ((:+:) (C1 (MetaCons "F8Key" PrefixI False) U1) (C1 (MetaCons "F9Key" PrefixI False) U1))))) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "F10Key" PrefixI False) U1) (C1 (MetaCons "F11Key" PrefixI False) U1)) ((:+:) (C1 (MetaCons "F12Key" PrefixI False) U1) ((:+:) (C1 (MetaCons "F13Key" PrefixI False) U1) (C1 (MetaCons "F14Key" PrefixI False) U1)))) ((:+:) ((:+:) (C1 (MetaCons "F15Key" PrefixI False) U1) ((:+:) (C1 (MetaCons "F16Key" PrefixI False) U1) (C1 (MetaCons "F17Key" PrefixI False) U1))) ((:+:) (C1 (MetaCons "F18Key" PrefixI False) U1) ((:+:) (C1 (MetaCons "F19Key" PrefixI False) U1) (C1 (MetaCons "F20Key" PrefixI False) U1))))))))

modifier2key :: Modifier -> Key

All modifiers are keys.

delay :: forall m. MonadFree WorkflowF m => MilliSeconds -> m ()

openURL :: forall m. MonadFree WorkflowF m => URL -> m ()

openApplication :: forall m. MonadFree WorkflowF m => Application -> m ()

currentApplication :: forall m. MonadFree WorkflowF m => m Application

setClipboard :: forall m. MonadFree WorkflowF m => Clipboard -> m ()

getClipboard :: forall m. MonadFree WorkflowF m => m Clipboard

sendMouseScroll :: forall m. MonadFree WorkflowF m => [Modifier] -> MouseScroll -> Natural -> m ()

sendMouseClick :: forall m. MonadFree WorkflowF m => [Modifier] -> Natural -> MouseButton -> m ()

sendText :: forall m. MonadFree WorkflowF m => String -> m ()

sendKeyChord :: forall m. MonadFree WorkflowF m => [Modifier] -> Key -> m ()

sendKeySequence :: MonadWorkflow m => KeySequence -> m ()

= traverse_ sendKeyChord'

sendKeyChord' :: MonadWorkflow m => KeyChord -> m ()

uncurried sendKeyChord

fromWorkflows_ :: MonadWorkflow m => [Workflow_] -> m ()

fromWorkflow_ :: Workflow_ -> WorkflowF ()

CoWorkflowF

provides generic helper functions for defining interpreters.

data CoWorkflowF k

Naming: induces a CoMonad, see http://dlaing.org/cofun/posts/free_and_cofree.html

WorkflowF, CoWorkflowF, and runWorkflowWithT are analogous to:

• Either (a -> c) (b,c), "get an a, or set a b"
• ((a,c), (b -> c)), "a handler for the getting of an a, and a handler for the setting of a b"
• @ handle :: ((a,c), (b -> c))
• > (Either (a -> c) (b,c))
• > c handle (aHasBeenGotten, bHasBeenSet) = either TODO @

background: see http://dlaing.org/cofun/posts/free_and_cofree.html

Constructors

CoWorkflowF

Fields

• _SendKeyChord :: [Modifier] -> Key -> k
• _SendText :: String -> k
• _SendMouseClick :: [Modifier] -> Natural -> MouseButton -> k
• _SendMouseScroll :: [Modifier] -> MouseScroll -> Natural -> k
• _GetClipboard :: (Clipboard, k)
• _SetClipboard :: Clipboard -> k
• _CurrentApplication :: (Application, k)
• _OpenApplication :: Application -> k
• _OpenURL :: URL -> k
• _Delay :: MilliSeconds -> k

Instances

Functor CoWorkflowF

Methods

fmap :: (a -> b) -> CoWorkflowF a -> CoWorkflowF b

(<$) :: a -> CoWorkflowF b -> CoWorkflowF a

type CoWorkflowT = CofreeT CoWorkflowF

e.g.

@

expansion:

CoWorkflowT w a ~ CofreeT CoWorkflowF w a ~ w (CofreeF CoWorkflowF a (CofreeT CoWorkflowF w a)) ~ w (a, CoWorkflowF (CofreeT CoWorkflowF w a)) @

since:

data CofreeT f w a = w (CofreeF f a (CofreeT f w a))

type CoWorkflow = Cofree CoWorkflowF

expansion:

CoWorkflow a
~
Cofree CoWorkflowF a
~
(a, CoWorkflow (Cofree CoWorkflowF a))

since:

data Cofree f a = a :< f (Cofree f a)