Portability	portable
Stability	provisional
Safe Haskell	None

Sindre.Runtime

Description

Definitions for the Sindre runtime environment.

Synopsis

Documentation

data Sindre m a Source

The main monad in which a Sindre program executes. More specialised monads, such as Execution are used for specific purposes, but they all run on top of the Sindre monad.

Instances

MonadTrans Sindre
MonadBackend im => MonadSindre im Sindre
Monad (Sindre m)
Functor (Sindre m)
Applicative (Sindre m)
MonadIO m => MonadIO (Sindre m)
MonadCont (Sindre m)
MonadReader (QuitFun m) (Sindre m)
MonadState (SindreEnv m) (Sindre m)
Monoid (Sindre m ())

execSindre :: MonadBackend m => SindreEnv m -> Sindre m a -> m ExitCode Source

execSindre e m executes the action m in environment e, returning the exit code of m.

quitSindre :: MonadBackend m => ExitCode -> Sindre m ()Source

Immediately return from execSindre, returning the given exit code.

class (MonadBackend im, Monad (m im)) => MonadSindre im m whereSource

MonadSindre im m is the class of monads m that run on top of Sindre with backend im, and can thus access Sindre functionality.

Methods

sindre :: Sindre im a -> m im aSource

Lift a Sindre operation into this monad.

back :: im a -> m im aSource

Lift a backend operation into this monad.

Instances

MonadBackend im => MonadSindre im Execution
MonadBackend im => MonadSindre im Sindre
MonadBackend im => MonadSindre im ConstructorM
MonadBackend im => MonadSindre im (ObjectM o)

broadcast :: MonadBackend im => Event -> ObjectM o im ()Source

changed :: MonadBackend im => Identifier -> Value -> Value -> ObjectM o im ()Source

redraw :: MonadBackend im => ObjectM s im ()Source

fullRedraw :: MonadSindre im m => m im ()Source

setRootPosition :: MonadBackend m => Value -> Sindre m ()Source

class (MonadIO m, Functor m, Applicative m, Mold (RootPosition m)) => MonadBackend m whereSource

A monad that can be used as the layer beneath Sindre.

Associated Types

type BackEvent m :: *Source

type RootPosition m :: *Source

Methods

redrawRoot :: Sindre m ()Source

redrawRegion :: [Rectangle] -> Sindre m ()Source

getBackEvent :: Sindre m (Maybe Event)Source

waitForBackEvent :: Sindre m Event Source

printVal :: String -> m ()Source

Instances

MonadBackend SindreX11M

data NewObject im Source

Container describing a newly created object.

newObject :: s -> Map Identifier (Method s im) -> [Field s im] -> (Event -> ObjectM s im ()) -> NewObject imSource

data NewWidget im Source

Container describing a newly created widget.

newWidget :: s -> Map Identifier (Method s im) -> [Field s im] -> (Event -> ObjectM s im ()) -> ObjectM s im SpaceNeed -> (Rectangle -> ObjectM s im SpaceUse) -> NewWidget imSource

data DataSlot im Source

instWidget :: NewWidget im -> Constraints -> DataSlot imSource

instObject :: NewObject im -> DataSlot imSource

data FieldDesc s im v Source

A typed description of a field, which may be read-write or read-only. When constructing the actual widget, you must turn these into real Fields by using the field function. A description of a field consists of a name and monadic actions for reading and optionally writing to the field.

Constructors

ReadWriteField Identifier (ObjectM s im v) (v -> ObjectM s im ())
ReadOnlyField Identifier (ObjectM s im v)

fieldName :: FieldDesc s im v -> Identifier Source

getField :: FieldDesc s im v -> ObjectM s im vSource

field :: Mold v => FieldDesc s im v -> Field s imSource

Turn a Haskell-typed high-level field description into a Value-typed field.

data Field s im Source

An opaque notion of a field. These are for internal use in the Sindre runtime.

type Method s im = [Value] -> ObjectM s im Value Source

A method takes as arguments a list of Values and returns another Value. You probably do not want to call these directly from Haskell code, as they are dynamically typed. See function for a convenient way to turn a Haskell function into a suitable method.

data ObjectM s im a Source

Instances

MonadBackend im => MonadSindre im (ObjectM o)
MonadReader ObjectRef (ObjectM s im)
MonadState s (ObjectM s im)
Monad (ObjectM s im)
Functor (ObjectM s im)
Applicative (ObjectM s im)
(MonadIO m, MonadBackend m) => MonadIO (ObjectM o m)

setFieldByRef :: MonadBackend im => ObjectRef -> Identifier -> Value -> Execution im Value Source

getFieldByRef :: MonadBackend im => ObjectRef -> Identifier -> Execution im Value Source

callMethodByRef :: MonadBackend im => ObjectRef -> Identifier -> [Value] -> Execution im Value Source

recvEventByRef :: MonadBackend im => WidgetRef -> Event -> Execution im ()Source

draw :: MonadSindre im m => WidgetRef -> Maybe Rectangle -> m im SpaceUse Source

compose :: MonadSindre im m => WidgetRef -> m im SpaceNeed Source

data SindreEnv m Source

Constructors

SindreEnv
Fields objects :: Array ObjectNum (DataSlot m) evtQueue :: Seq Event globals :: IntMap Value execFrame :: Frame kbdFocus :: WidgetRef rootWidget :: (Maybe (RootPosition m), WidgetRef) arguments :: Arguments needsRedraw :: Redraw

Instances

MonadState (SindreEnv m) (Sindre m)

newEnv :: WidgetRef -> Arguments -> SindreEnv mSource

globalVal :: MonadBackend m => Key -> Sindre m Value Source

setGlobal :: MonadBackend m => Key -> Value -> Sindre m ()Source

data Execution m a Source

Instances

MonadBackend im => MonadSindre im Execution
Monad (Execution m)
Functor (Execution m)
Applicative (Execution m)
MonadCont (Execution m)
MonadReader (ExecutionEnv m) (Execution m)