Sindre.Runtime

Definitions for the Sindre runtime environment.

Documentation

data Sindre m a

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

Defined in Sindre.Runtime

Methods

lift :: Monad m => m a -> Sindre m a

MonadBackend im => MonadSindre im Sindre

Defined in Sindre.Runtime

Methods

sindre :: Sindre im a -> Sindre im a

back :: im a -> Sindre im a

Monad (Sindre m)

Defined in Sindre.Runtime

Methods

(>>=) :: Sindre m a -> (a -> Sindre m b) -> Sindre m b

(>>) :: Sindre m a -> Sindre m b -> Sindre m b

return :: a -> Sindre m a

Functor (Sindre m)

Defined in Sindre.Runtime

Methods

fmap :: (a -> b) -> Sindre m a -> Sindre m b

(<$) :: a -> Sindre m b -> Sindre m a

MonadFail m => MonadFail (Sindre m)

Defined in Sindre.Runtime

Methods

fail :: String -> Sindre m a

Applicative (Sindre m)

Defined in Sindre.Runtime

Methods

pure :: a -> Sindre m a

(<*>) :: Sindre m (a -> b) -> Sindre m a -> Sindre m b

liftA2 :: (a -> b -> c) -> Sindre m a -> Sindre m b -> Sindre m c

(*>) :: Sindre m a -> Sindre m b -> Sindre m b

(<*) :: Sindre m a -> Sindre m b -> Sindre m a

MonadIO m => MonadIO (Sindre m)

Defined in Sindre.Runtime

Methods

liftIO :: IO a -> Sindre m a

MonadCont (Sindre m)

Defined in Sindre.Runtime

Methods

callCC :: ((a -> Sindre m b) -> Sindre m a) -> Sindre m a

MonadState (SindreEnv m) (Sindre m)

Defined in Sindre.Runtime

Methods

get :: Sindre m (SindreEnv m)

put :: SindreEnv m -> Sindre m ()

state :: (SindreEnv m -> (a, SindreEnv m)) -> Sindre m a

Semigroup (Sindre m ())

Defined in Sindre.Runtime

Methods

(<>) :: Sindre m () -> Sindre m () -> Sindre m ()

sconcat :: NonEmpty (Sindre m ()) -> Sindre m ()

stimes :: Integral b => b -> Sindre m () -> Sindre m ()

Monoid (Sindre m ())

Defined in Sindre.Runtime

Methods

mempty :: Sindre m ()

mappend :: Sindre m () -> Sindre m () -> Sindre m ()

mconcat :: [Sindre m ()] -> Sindre m ()

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

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

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

Immediately return from execSindre, returning the given exit code.

class (MonadBackend im, MonadFail (m im), MonadFail im) => MonadSindre im m where

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

Minimal complete definition

sindre

Methods

sindre :: Sindre im a -> m im a

Lift a Sindre operation into this monad.

back :: im a -> m im a

Lift a backend operation into this monad.

Instances

MonadBackend im => MonadSindre im Execution

Defined in Sindre.Runtime

Methods

sindre :: Sindre im a -> Execution im a

back :: im a -> Execution im a

MonadBackend im => MonadSindre im Sindre

Defined in Sindre.Runtime

Methods

sindre :: Sindre im a -> Sindre im a

back :: im a -> Sindre im a

MonadBackend im => MonadSindre im ConstructorM

Defined in Sindre.Compiler

Methods

sindre :: Sindre im a -> ConstructorM im a

back :: im a -> ConstructorM im a

MonadBackend im => MonadSindre im (ObjectM o)

Defined in Sindre.Runtime

Methods

sindre :: Sindre im a -> ObjectM o im a

back :: im a -> ObjectM o im a

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

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

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

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

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

class (MonadIO m, MonadFail m, Mold (RootPosition m)) => MonadBackend m where

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

Associated Types

type BackEvent m :: *

type RootPosition m :: *

Methods

redrawRoot :: Sindre m ()

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

getBackEvent :: Sindre m (Maybe Event)

waitForBackEvent :: Sindre m Event

printVal :: String -> m ()

Instances

MonadBackend SindreX11M

Defined in Sindre.X11

Associated Types

type BackEvent SindreX11M

type RootPosition SindreX11M

Methods

redrawRoot :: Sindre SindreX11M ()

redrawRegion :: [Rectangle] -> Sindre SindreX11M ()

getBackEvent :: Sindre SindreX11M (Maybe Event)

waitForBackEvent :: Sindre SindreX11M Event

printVal :: String -> SindreX11M ()

data NewObject im

Container describing a newly created object.

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

data NewWidget im

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 im

data DataSlot im

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

instObject :: NewObject im -> DataSlot im

data FieldDesc s im v

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

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

field :: (MonadFail im, Mold v) => FieldDesc s im v -> Field s im

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

data Field s im

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

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

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

Instances

MonadBackend im => MonadSindre im (ObjectM o)

Defined in Sindre.Runtime

Methods

sindre :: Sindre im a -> ObjectM o im a

back :: im a -> ObjectM o im a

MonadState s (ObjectM s im)

Defined in Sindre.Runtime

Methods

get :: ObjectM s im s

put :: s -> ObjectM s im ()

state :: (s -> (a, s)) -> ObjectM s im a

MonadReader ObjectRef (ObjectM s im)

Defined in Sindre.Runtime

Methods

ask :: ObjectM s im ObjectRef

local :: (ObjectRef -> ObjectRef) -> ObjectM s im a -> ObjectM s im a

reader :: (ObjectRef -> a) -> ObjectM s im a

Monad (ObjectM s im)

Defined in Sindre.Runtime

Methods

(>>=) :: ObjectM s im a -> (a -> ObjectM s im b) -> ObjectM s im b

(>>) :: ObjectM s im a -> ObjectM s im b -> ObjectM s im b

return :: a -> ObjectM s im a

Functor (ObjectM s im)

Defined in Sindre.Runtime

Methods

fmap :: (a -> b) -> ObjectM s im a -> ObjectM s im b

(<$) :: a -> ObjectM s im b -> ObjectM s im a

MonadFail im => MonadFail (ObjectM s im)

Defined in Sindre.Runtime

Methods

fail :: String -> ObjectM s im a

Applicative (ObjectM s im)

Defined in Sindre.Runtime

Methods

pure :: a -> ObjectM s im a

(<*>) :: ObjectM s im (a -> b) -> ObjectM s im a -> ObjectM s im b

liftA2 :: (a -> b -> c) -> ObjectM s im a -> ObjectM s im b -> ObjectM s im c

(*>) :: ObjectM s im a -> ObjectM s im b -> ObjectM s im b

(<*) :: ObjectM s im a -> ObjectM s im b -> ObjectM s im a

(MonadIO m, MonadBackend m) => MonadIO (ObjectM o m)

Defined in Sindre.Runtime

Methods

liftIO :: IO a -> ObjectM o m a

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

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

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

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

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

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

data SindreEnv m

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)

Defined in Sindre.Runtime

Methods

get :: Sindre m (SindreEnv m)

put :: SindreEnv m -> Sindre m ()

state :: (SindreEnv m -> (a, SindreEnv m)) -> Sindre m a

newEnv :: WidgetRef -> Arguments -> SindreEnv m

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

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

data Execution m a

Instances

MonadBackend im => MonadSindre im Execution

Defined in Sindre.Runtime

Methods

sindre :: Sindre im a -> Execution im a

back :: im a -> Execution im a

Monad (Execution m)

Defined in Sindre.Runtime

Methods

(>>=) :: Execution m a -> (a -> Execution m b) -> Execution m b

(>>) :: Execution m a -> Execution m b -> Execution m b

return :: a -> Execution m a

Functor (Execution m)

Defined in Sindre.Runtime

Methods

fmap :: (a -> b) -> Execution m a -> Execution m b

(<$) :: a -> Execution m b -> Execution m a

MonadFail m => MonadFail (Execution m)

Defined in Sindre.Runtime

Methods

fail :: String -> Execution m a

Applicative (Execution m)

Defined in Sindre.Runtime

Methods

pure :: a -> Execution m a

(<*>) :: Execution m (a -> b) -> Execution m a -> Execution m b

liftA2 :: (a -> b -> c) -> Execution m a -> Execution m b -> Execution m c

(*>) :: Execution m a -> Execution m b -> Execution m b

(<*) :: Execution m a -> Execution m b -> Execution m a

MonadCont (Execution m)

Defined in Sindre.Runtime

Methods

callCC :: ((a -> Execution m b) -> Execution m a) -> Execution m a

execute :: MonadBackend m => Execution m Value -> Sindre m Value

execute_ :: MonadBackend m => Execution m a -> Sindre m ()

returnHere :: MonadBackend m => Execution m Value -> Execution m Value

doReturn :: MonadBackend m => Value -> Execution m ()

nextHere :: MonadBackend m => Execution m () -> Execution m ()

doNext :: MonadBackend m => Execution m ()

breakHere :: MonadBackend m => Execution m () -> Execution m ()

doBreak :: MonadBackend m => Execution m ()

contHere :: MonadBackend m => Execution m () -> Execution m ()

doCont :: MonadBackend m => Execution m ()

setScope :: MonadBackend m => [Value] -> Execution m a -> Execution m a

enterScope :: MonadBackend m => [Value] -> Execution m a -> Execution m a

lexicalVal :: MonadBackend m => Key -> Execution m Value

setLexical :: MonadBackend m => Key -> Value -> Execution m ()

eventLoop :: MonadBackend m => EventHandler m -> Sindre m ()

type EventHandler m = Event -> Execution m ()

class Mold a where

Methods

mold :: Value -> Maybe a

unmold :: a -> Value

Instances

Mold Bool

Defined in Sindre.Runtime

Methods

mold :: Value -> Maybe Bool

unmold :: Bool -> Value

Mold Double

Defined in Sindre.Runtime

Methods

mold :: Value -> Maybe Double

unmold :: Double -> Value

Mold Int

Defined in Sindre.Runtime

Methods

mold :: Value -> Maybe Int

unmold :: Int -> Value

Mold Integer

Defined in Sindre.Runtime

Methods

mold :: Value -> Maybe Integer

unmold :: Integer -> Value

Mold ()

Defined in Sindre.Runtime

Methods

mold :: Value -> Maybe ()

unmold :: () -> Value

Mold Text

Defined in Sindre.Runtime

Methods

mold :: Value -> Maybe Text

unmold :: Text -> Value

Mold String

Defined in Sindre.Runtime

Methods

mold :: Value -> Maybe String

unmold :: String -> Value

Mold Value

Defined in Sindre.Runtime

Methods

mold :: Value -> Maybe Value

unmold :: Value -> Value

Mold FormatString

Defined in Sindre.Formatting

Methods

mold :: Value -> Maybe FormatString

unmold :: FormatString -> Value

Mold a => Mold (Maybe a)

Defined in Sindre.Runtime

Methods

mold :: Value -> Maybe (Maybe a)

unmold :: Maybe a -> Value

Mold (Align, Align)

Defined in Sindre.Runtime

Methods

mold :: Value -> Maybe (Align, Align)

unmold :: (Align, Align) -> Value