Test.Robot

The main Robot interface.

Running your robot

data Robot a

A Robot is a program that interacts with the GUI.

Use runRobot to execute your Robot, and liftIO to perform arbitrary I/O.

Instances

Monad Robot

Functor Robot

Applicative Robot

MonadThrow Robot

MonadCatch Robot

MonadMask Robot

MonadIO Robot

runRobot :: Robot a -> IO a

Run the robot, connecting to the display automatically.

Key and button constants

module Test.Robot.Types

Doing things

class Pressable x where

Represents things that can be pressed: either a single Switch or a list of Switches.

Minimal complete definition

press, release

Methods

press :: x -> Robot ()

Press a key or button.

release :: x -> Robot ()

Release a key or button.

hold :: x -> Robot a -> Robot a infixr 4

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

press x >> act >> release x

except hold ensures that the argument is released in the event of an exception.

Instances

Pressable Switch

Pressable x => Pressable [x]

Press items from left-to-right, but release from right-to-left.

This behavior ensures the following equivalence holds:

press xs >> act >> release xs
  === xs `hold` act
  === x1 `hold` x2 `hold` ... xn `hold` act

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

Move the pointer by an offset.

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

Move the pointer to a point on the screen.

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

Press the argument, then release it.

Note that the underlying events are fired very quickly; much faster than some applications (such as Xmonad) can handle. If this becomes an issue, you may introduce a delay using sleep:

slowTap x = x `hold` sleep 0.1

Miscellaneous

sleep :: Rational -> Robot ()

Do nothing for the specified number of seconds.

module Test.Robot.Connection