Safe Haskell	Safe-Inferred
Language	GHC2021

Butler.App

Description

This module contains the logic for graphical app definition.

Synopsis

data Display = Display {
- sessions :: Sessions
- clients :: TVar (Map SessionID [DisplayClient])
}
data DisplayEvent
- = UserConnected ChannelName DisplayClient
- | UserDisconnected ChannelName DisplayClient
newtype AppTag = AppTag Text
data AppEvent
- = AppDisplay DisplayEvent
- | AppTrigger GuiEvent
- | AppData DataEvent
- | AppFile Directory (Maybe File)
eventFromMessage :: DisplayClient -> DataMessage -> Maybe (WinID, AppEvent)
data App = App {
- name :: ProgramName
- tags :: Set AppTag
- title :: Text
- description :: Text
- size :: Maybe (Int, Int)
- xfiles :: [XStaticFile]
- acceptFiles :: Maybe ContentType
- start :: AppContext -> ProcessIO ()
}
defaultApp :: ProgramName -> (AppContext -> ProcessIO ()) -> App
data AppContext = AppContext {
- clients :: DisplayClients
- wid :: WinID
- pipe :: Pipe AppEvent
- shared :: AppSharedContext
}
data AppSharedContext = AppSharedContext {
- display :: Display
- processEnv :: ProcessEnv
- appSet :: AppSet
- dynamics :: Dynamics
- apps :: Apps
}
newAppSharedContext :: Display -> ProcessEnv -> AppSet -> STM AppSharedContext
newtype Apps = Apps (TVar (Map WinID AppInstance))
newApps :: STM Apps
unregisterApp :: Apps -> AppInstance -> STM ()
registerApp :: Apps -> AppInstance -> STM ()
getApps :: Apps -> STM (Map WinID AppInstance)
data AppInstance = AppInstance {
- app :: App
- process :: Process
- wid :: WinID
- pipeAE :: Pipe AppEvent
}
newtype AppSet = AppSet (Map ProgramName App)
appSetApps :: AppSet -> [App]
sendHtmlOnConnect :: HtmlT STM () -> AppEvent -> ProcessIO ()
newAppSet :: [App] -> AppSet
launchApp :: AppSet -> ProgramName -> AppSharedContext -> DisplayClients -> WinID -> ProcessIO (Maybe AppInstance)
startApp :: Text -> App -> AppSharedContext -> DisplayClients -> WinID -> ProcessIO AppInstance
startApps :: [App] -> Display -> DisplayClients -> ProcessIO AppSharedContext
tagIcon :: AppTag -> Maybe Text
startAppScript :: App -> [Pair] -> Text
appSetHtml :: Monad m => WinID -> AppSet -> HtmlT m ()

Documentation

data Display #

Constructors

Display
Fields sessions :: Sessions clients :: TVar (Map SessionID [DisplayClient])

data DisplayEvent #

Constructors

UserConnected ChannelName DisplayClient
UserDisconnected ChannelName DisplayClient

Instances

Instances details

ToJSON DisplayEvent #
Instance details Defined in Butler.App Methods toJSON :: DisplayEvent -> Value # toEncoding :: DisplayEvent -> Encoding # toJSONList :: [DisplayEvent] -> Value # toEncodingList :: [DisplayEvent] -> Encoding #
Generic DisplayEvent #
Instance details Defined in Butler.App Associated Types type Rep DisplayEvent :: Type -> Type # Methods from :: DisplayEvent -> Rep DisplayEvent x # to :: Rep DisplayEvent x -> DisplayEvent #
Show DisplayEvent #
Instance details Defined in Butler.App Methods showsPrec :: Int -> DisplayEvent -> ShowS # show :: DisplayEvent -> String # showList :: [DisplayEvent] -> ShowS #
type Rep DisplayEvent #
Instance details Defined in Butler.App type Rep DisplayEvent = D1 ('MetaData "DisplayEvent" "Butler.App" "butler-0.0.1.0-inplace" 'False) (C1 ('MetaCons "UserConnected" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChannelName) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DisplayClient)) :+: C1 ('MetaCons "UserDisconnected" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChannelName) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DisplayClient)))

newtype AppTag #

Application tag.

Constructors

AppTag Text

Instances

Instances details

FromJSON AppTag #
Instance details Defined in Butler.App Methods parseJSON :: Value -> Parser AppTag # parseJSONList :: Value -> Parser [AppTag] #
ToJSON AppTag #
Instance details Defined in Butler.App Methods toJSON :: AppTag -> Value # toEncoding :: AppTag -> Encoding # toJSONList :: [AppTag] -> Value # toEncodingList :: [AppTag] -> Encoding #
IsString AppTag #
Instance details Defined in Butler.App Methods fromString :: String -> AppTag #
Semigroup AppTag #
Instance details Defined in Butler.App Methods (<>) :: AppTag -> AppTag -> AppTag # sconcat :: NonEmpty AppTag -> AppTag # stimes :: Integral b => b -> AppTag -> AppTag #
Generic AppTag #
Instance details Defined in Butler.App Associated Types type Rep AppTag :: Type -> Type # Methods from :: AppTag -> Rep AppTag x # to :: Rep AppTag x -> AppTag #
Show AppTag #
Instance details Defined in Butler.App Methods showsPrec :: Int -> AppTag -> ShowS # show :: AppTag -> String # showList :: [AppTag] -> ShowS #
Eq AppTag #
Instance details Defined in Butler.App Methods (==) :: AppTag -> AppTag -> Bool # (/=) :: AppTag -> AppTag -> Bool #
Ord AppTag #
Instance details Defined in Butler.App Methods compare :: AppTag -> AppTag -> Ordering # (<) :: AppTag -> AppTag -> Bool # (<=) :: AppTag -> AppTag -> Bool # (>) :: AppTag -> AppTag -> Bool # (>=) :: AppTag -> AppTag -> Bool # max :: AppTag -> AppTag -> AppTag # min :: AppTag -> AppTag -> AppTag #
ToHtml AppTag #
Instance details Defined in Butler.App Methods toHtml :: forall (m :: Type -> Type). Monad m => AppTag -> HtmlT m () # toHtmlRaw :: forall (m :: Type -> Type). Monad m => AppTag -> HtmlT m () #
Serialise AppTag #
Instance details Defined in Butler.App Methods encode :: AppTag -> Encoding # decode :: Decoder s AppTag # encodeList :: [AppTag] -> Encoding # decodeList :: Decoder s [AppTag] #
type Rep AppTag #
Instance details Defined in Butler.App type Rep AppTag = D1 ('MetaData "AppTag" "Butler.App" "butler-0.0.1.0-inplace" 'True) (C1 ('MetaCons "AppTag" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data AppEvent #

The type of event an app receive

Constructors

AppDisplay DisplayEvent	A display event (e.g. to mount the UI)
AppTrigger GuiEvent	A trigger event (e.g. onclick)
AppData DataEvent	A data event (e.g. for raw data)
AppFile Directory (Maybe File)	A file event (e.g. a new file opened)

Instances

Instances details

ToJSON AppEvent #
Instance details Defined in Butler.App Methods toJSON :: AppEvent -> Value # toEncoding :: AppEvent -> Encoding # toJSONList :: [AppEvent] -> Value # toEncodingList :: [AppEvent] -> Encoding #
Generic AppEvent #
Instance details Defined in Butler.App Associated Types type Rep AppEvent :: Type -> Type # Methods from :: AppEvent -> Rep AppEvent x # to :: Rep AppEvent x -> AppEvent #
type Rep AppEvent #
Instance details Defined in Butler.App type Rep AppEvent = D1 ('MetaData "AppEvent" "Butler.App" "butler-0.0.1.0-inplace" 'False) ((C1 ('MetaCons "AppDisplay" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DisplayEvent)) :+: C1 ('MetaCons "AppTrigger" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GuiEvent))) :+: (C1 ('MetaCons "AppData" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DataEvent)) :+: C1 ('MetaCons "AppFile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Directory) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe File)))))

eventFromMessage :: DisplayClient -> DataMessage -> Maybe (WinID, AppEvent) #

data App #

A graphical application definition.

Constructors

App
Fields name :: ProgramName The application name. tags :: Set AppTag Its categories. title :: Text Its title. description :: Text A description. size :: Maybe (Int, Int) An optional size. xfiles :: [XStaticFile] Required XStaticFile acceptFiles :: Maybe ContentType start :: AppContext -> ProcessIO () Start action.

defaultApp :: ProgramName -> (AppContext -> ProcessIO ()) -> App #

data AppContext #

The application context

Constructors

AppContext
Fields clients :: DisplayClients the list of all the connected clients. To send update, app should uses `sendsHtml clients ""` wid :: WinID the instance identifier. The app should mount its UI with `with div_ [wid_ wid] "body"`, and the trigger must container the WinID suffix too. pipe :: Pipe AppEvent the channel to receive events. shared :: AppSharedContext

data AppSharedContext #

Constructors

AppSharedContext
Fields display :: Display processEnv :: ProcessEnv appSet :: AppSet dynamics :: Dynamics apps :: Apps

newAppSharedContext :: Display -> ProcessEnv -> AppSet -> STM AppSharedContext #

newtype Apps #

Constructors

Apps (TVar (Map WinID AppInstance))

newApps :: STM Apps #

unregisterApp :: Apps -> AppInstance -> STM () #

registerApp :: Apps -> AppInstance -> STM () #

getApps :: Apps -> STM (Map WinID AppInstance) #

data AppInstance #

Constructors

AppInstance
Fields app :: App process :: Process wid :: WinID pipeAE :: Pipe AppEvent

Instances

Instances details

Generic AppInstance #
Instance details Defined in Butler.App Associated Types type Rep AppInstance :: Type -> Type # Methods from :: AppInstance -> Rep AppInstance x # to :: Rep AppInstance x -> AppInstance #
type Rep AppInstance #
Instance details Defined in Butler.App type Rep AppInstance = D1 ('MetaData "AppInstance" "Butler.App" "butler-0.0.1.0-inplace" 'False) (C1 ('MetaCons "AppInstance" 'PrefixI 'True) ((S1 ('MetaSel ('Just "app") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 App) :: S1 ('MetaSel ('Just "process") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Process)) :: (S1 ('MetaSel ('Just "wid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 WinID) :*: S1 ('MetaSel ('Just "pipeAE") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Pipe AppEvent)))))

newtype AppSet #

Constructors

AppSet (Map ProgramName App)

appSetApps :: AppSet -> [App] #

sendHtmlOnConnect :: HtmlT STM () -> AppEvent -> ProcessIO () #

A convenient helper to mount the UI when a new user connect.

newAppSet :: [App] -> AppSet #

launchApp :: AppSet -> ProgramName -> AppSharedContext -> DisplayClients -> WinID -> ProcessIO (Maybe AppInstance) #

startApp :: Text -> App -> AppSharedContext -> DisplayClients -> WinID -> ProcessIO AppInstance #

startApps :: [App] -> Display -> DisplayClients -> ProcessIO AppSharedContext #

tagIcon :: AppTag -> Maybe Text #

startAppScript :: App -> [Pair] -> Text #

appSetHtml :: Monad m => WinID -> AppSet -> HtmlT m () #