Yogurt-0.3: A MUD client librarySource codeContentsIndex
Hook record fields
Match information
Triggering hooks
The core of Yogurt, consisting of the Mud monad and all functions manipulating this monad.
type Mud = StateT MudState IO
data MudState
emptyMud :: RunMud -> Output -> MudState
type RunMud = forall a. Mud a -> IO a
type Output = Destination -> String -> IO ()
data Hook
data Destination
= Local
| Remote
type Pattern = String
data Var a
mkHook :: Destination -> Pattern -> Mud a -> Mud Hook
mkPrioHook :: Int -> Destination -> Pattern -> Mud a -> Mud Hook
setHook :: Hook -> Mud ()
rmHook :: Hook -> Mud ()
allHooks :: Mud [Hook]
hPriority :: Hook -> Int
hDestination :: Hook -> Destination
hPattern :: Hook -> Pattern
hAction :: Hook -> Mud ()
triggeredHook :: Mud Hook
matchedLine :: Mud String
before :: Mud String
group :: Int -> Mud String
after :: Mud String
mkVar :: a -> Mud (Var a)
setVar :: Var a -> a -> Mud ()
readVar :: Var a -> Mud a
modifyVar :: Var a -> (a -> a) -> Mud ()
trigger :: Destination -> String -> Mud ()
triggerJust :: (Hook -> Bool) -> Destination -> String -> Mud ()
io :: Destination -> String -> Mud ()
forkWithCallback :: (RunMud -> IO ()) -> Mud ThreadId
type Mud = StateT MudState IOSource
The Mud monad is a state monad over IO.
data MudState Source
State internal to the Mud monad.
emptyMud :: RunMud -> Output -> MudStateSource
The initial state of the Mud monad.
type RunMud = forall a. Mud a -> IO aSource
Run a Mud computation in IO.
type Output = Destination -> String -> IO ()Source
Provides a way to output messages.
data Hook Source

The abstract Hook type. For every pair of hooks (h1, h2):

  • h1 == h2 iff they were created by the same call to mkHook.
  • h1 < h2 iff h1 will match earlier than h2.
show/hide Instances
data Destination Source
The direction in which a message is going.
LocalThe message is headed towards the user's terminal.
RemoteThe message is headed towards the remote MUD server.
show/hide Instances
type Pattern = StringSource
A Pattern is a regular expression.
data Var a Source
Variables hold temporary, updatable, typed data.
A hook watches a channel for messages matching a specific regular expression. When a hook fires, the triggering message is consumed and the hook's action is executed. When a message doesn't trigger any hooks, it is sent on to its destination. A hook's action may query for match-specific data; see section Match information. At most one hook fires for each message, unless the hook's action explicitly sends the message through trigger again. If several hooks match, only the hook with the highest priority fires. If there is still a tie, the hook that was defined last (using mkHook) fires.
mkHook :: Destination -> Pattern -> Mud a -> Mud HookSource
Calls mkPrioHook with priority 0.
mkPrioHook :: Int -> Destination -> Pattern -> Mud a -> Mud HookSource
Creates and installs a hook that watches messages headed to the specified destination and match the specified pattern.
setHook :: Hook -> Mud ()Source
Saves a changed hook, or reactivates it.
rmHook :: Hook -> Mud ()Source
Disables a hook.
allHooks :: Mud [Hook]Source
Yields all current hooks in preferred firing order.
Hook record fields
Use these in combination with setHook to update hooks.
hPriority :: Hook -> IntSource
Yields the hook's priority.
hDestination :: Hook -> DestinationSource
Yields the destination this hook watches.
hPattern :: Hook -> PatternSource
Yields the pattern messages must have for this hook to fire.
hAction :: Hook -> Mud ()Source
Yields the Mud program to execute when the hook fires.
Match information
Functions for querying the currently firing hook. These functions can only be called from within a hook's body.
triggeredHook :: Mud HookSource
Yields the hook that is currently firing.
matchedLine :: Mud StringSource
Yields the message that triggered the currently firing hook.
before :: Mud StringSource
Yields the part of the triggering message that comes before the matched pattern.
group :: Int -> Mud StringSource
Yields the regex group from the matched pattern. group 0 yields the complete match; higher indices correspond to the parenthesized groups.
after :: Mud StringSource
Yields the part of the triggering message that comes after the matched pattern.
mkVar :: a -> Mud (Var a)Source
Creates a variable with an initial value.
setVar :: Var a -> a -> Mud ()Source
Updates a variable to a new value.
readVar :: Var a -> Mud aSource
Yields the variable's current value.
modifyVar :: Var a -> (a -> a) -> Mud ()Source
Updates the variable using the update function.
Triggering hooks
trigger :: Destination -> String -> Mud ()Source
Short for triggerJust (const True).
triggerJust :: (Hook -> Bool) -> Destination -> String -> Mud ()Source
If the message triggers a hook that passes the specified test, it is fired. Otherwise, the message is passed on to the destination using io.
io :: Destination -> String -> Mud ()Source
Immediately write a message to a destination, without triggering hooks.
forkWithCallback :: (RunMud -> IO ()) -> Mud ThreadIdSource
Used when you want a forked thread to be able to call back into the Mud monad. Note that when using the RunMud argument, the forked thread will have to contend with the threads for the user input and MUD input, because only one Mud computation can run at any given time. The id of the forked thread is returned.
Produced by Haddock version 2.4.2