Safe Haskell	None
Language	Haskell2010

MiniLight

Contents

Orphan instances

Description

MiniLight module exports all basic concepts and oprations except for concrete components.

Synopsis

module MiniLight.Light
module MiniLight.Event
module MiniLight.Figure
module MiniLight.Component
module MiniLight.Loader
runLightT :: (MonadIO m, MonadMask m) => LightT LightEnv m a -> m a
runLightTWith :: (MonadIO m, MonadMask m) => LightConfig -> LightT LightEnv m a -> m a
data LightConfig = LightConfig {
- headless :: Bool
- logQueue :: LogLevel -> IO LogQueue
- logLevel :: LogLevel
}
defLightConfig :: LightConfig
data LoopState = LoopState {
- light :: LightEnv
- loop :: LoopEnv
- loader :: LoaderEnv
}
data LoopConfig = LoopConfig {
- watchKeys :: Maybe [Scancode]
- appConfigFile :: Maybe FilePath
- hotConfigReplacement :: Maybe FilePath
- componentResolver :: Resolver
- additionalComponents :: [Component]
}
defConfig :: LoopConfig
runMainloop :: (HasLightEnv env, HasLightEnv env', HasLoopEnv env', HasLoaderEnv env', MonadIO m, MonadMask m) => (env -> LoopEnv -> LoaderEnv -> env') -> LoopConfig -> s -> (s -> LightT env' m s) -> LightT env m ()
type MiniLoop = LightT LoopState IO
runMiniloop :: LoopConfig -> s -> (s -> MiniLoop s) -> MiniLight ()
runComponentEnv :: (HasLightEnv env, HasLoopEnv env) => Component -> (forall env'. (HasComponentEnv env', HasLoopEnv env', HasLightEnv env') => LightT env' m ()) -> LightT env m ()
(@@!) :: (EventType et, HasLoaderEnv env, HasLoopEnv env, HasLightEnv env, MonadIO m) => Text -> et -> LightT env m ()
quit :: (MonadIO m, HasLoopEnv env) => LightT env m ()

Documentation

module MiniLight.Light

module MiniLight.Event

module MiniLight.Figure

module MiniLight.Component

module MiniLight.Loader

runLightT :: (MonadIO m, MonadMask m) => LightT LightEnv m a -> m a Source #

Run a light monad with default configuration. runLightT = runLightTWith defLightConfig

runLightTWith :: (MonadIO m, MonadMask m) => LightConfig -> LightT LightEnv m a -> m a Source #

Run a Light monad.

data LightConfig Source #

Custom configuration for LightT

Constructors

LightConfig
Fields headless :: Bool logQueue :: LogLevel -> IO LogQueue LogQueue for logger logLevel :: LogLevel LogLevel for logger

defLightConfig :: LightConfig Source #

Default configuration for runLightT

data LoopState Source #

The state in the mainloop.

Constructors

LoopState
Fields light :: LightEnv loop :: LoopEnv loader :: LoaderEnv

Instances

HasLightEnv LoopState Source #
Instance details Defined in MiniLight Methods lightEnv :: Lens' LoopState LightEnv Source # _fontCache :: Lens' LoopState FontMap Source # _logger :: Lens' LoopState LogQueue Source # _renderer :: Lens' LoopState (Maybe Renderer) Source #
HasLoopEnv LoopState Source #
Instance details Defined in MiniLight Methods loopEnv :: Lens' LoopState LoopEnv Source # _events :: Lens' LoopState (MVar [Event]) Source # _keyStates :: Lens' LoopState (HashMap Scancode Int) Source # _signalQueue :: Lens' LoopState (IORef [Event]) Source #
HasLoaderEnv LoopState Source #
Instance details Defined in MiniLight Methods loaderEnv :: Lens' LoopState LoaderEnv Source # _appConfig :: Lens' LoopState (IORef AppConfig) Source # _registry :: Lens' LoopState (Registry Component) Source # _tagRegistry :: Lens' LoopState (IORef (HashMap Text Text)) Source #

data LoopConfig Source #

Use defConfig for a default setting.

Constructors

LoopConfig

Fields

watchKeys :: Maybe [Scancode]
Set Nothing if all keys should be watched. See also LoopState.
appConfigFile :: Maybe FilePath
Specify a yaml file which describes component settings. See Loader for the yaml syntax.
hotConfigReplacement :: Maybe FilePath
The directory path to be watched. If set, the config file modification will replace the component dynamically.
componentResolver :: Resolver
Your custom mappings between a component name and its type.
additionalComponents :: [Component]
The components here would be added during the initialization.

defConfig :: LoopConfig Source #

Default configurations for the mainloop. You need to set componentResolver if you use a component.

runMainloop Source #

Arguments

:: (HasLightEnv env, HasLightEnv env', HasLoopEnv env', HasLoaderEnv env', MonadIO m, MonadMask m)
=> (env -> LoopEnv -> LoaderEnv -> env')	Environment conversion
-> LoopConfig	Loop config
-> s	Initial state
-> (s -> LightT env' m s)	A function called in every loop
-> LightT env m ()

Run a mainloop. In a mainloop, components and events are managed.

Components in a mainloop: draw ~ update ~ (user-defined function) ~ event handling

type MiniLoop = LightT LoopState IO Source #

Type synonym to the minimal type of the mainloop

runMiniloop :: LoopConfig -> s -> (s -> MiniLoop s) -> MiniLight () Source #

Same as runMainloop but fixing the type.

runComponentEnv :: (HasLightEnv env, HasLoopEnv env) => Component -> (forall env'. (HasComponentEnv env', HasLoopEnv env', HasLightEnv env') => LightT env' m ()) -> LightT env m () Source #

Run an action over a component.

(@@!) :: (EventType et, HasLoaderEnv env, HasLoopEnv env, HasLightEnv env, MonadIO m) => Text -> et -> LightT env m () Source #

Emit a signal with a loader-defined target name (!) :: EventType et => T.Text -> et -> MiniLoop ()

quit :: (MonadIO m, HasLoopEnv env) => LightT env m () Source #

Quit the mainloop and terminate the application.

Orphan instances

Hashable Scancode Source #
Instance details Methods hashWithSalt :: Int -> Scancode -> Int # hash :: Scancode -> Int #