Test.Robot

The main Robot interface.

Running your robot

data Robot a

The Robot monad: a reader monad over IO.

Instances

Monad Robot

Functor Robot

Applicative Robot

MonadIO Robot

runRobot :: Robot a -> IO a

Run the robot, connecting to the display automatically.

runRobotWithConnection :: Robot a -> Connection -> IO a

Run the robot using an existing connection.

Key and button constants

module Test.Robot.Types

Doing things

Basic operations

class Pressable x where

Represents things that can be pressed: either a key on a keyboard or a button on a mouse.

Methods

press :: x -> Robot ()

Press a key or button.

release :: x -> Robot ()

Release a key or button.

Instances

Pressable Button

Pressable Key

moveBy :: Int -> Int -> Robot ()

Move the pointer by an offset.

moveTo :: Int -> Int -> Robot ()

Move the pointer to a point on the screen.

Derived operations

hold :: Pressable x => x -> Robot a -> Robot a

hold x act holds down x while executing act. It is equivalent to the code:

 press x
 act
 release x

For example, you type some text in ALL CAPS using:

 hold _Shift $ mapM_ tap [_D, _U, _C, _K, _S]

tap :: Pressable x => x -> Robot ()

Press the argument, then release it.

Fancy utilities

sleep :: Rational -> Robot ()

Do nothing for the specified number of seconds.