Lambdabot.Plugin

Documentation

data Module st

The Module type class.

Constructors

Module

Fields

• moduleSerialize :: !(Maybe (Serial st))

  If the module wants its state to be saved, this function should return a Serial.

  The default implementation returns Nothing.

• moduleDefState :: !(LB st)

  If the module maintains state, this method specifies the default state (for example in case the state can't be read from a state).

  The default implementation returns an error and assumes the state is never accessed.

• moduleSticky :: !Bool

  Is the module sticky? Sticky modules (as well as static ones) can't be unloaded. By default, modules are not sticky.

• moduleCmds :: !(ModuleT st LB [Command (ModuleT st LB)])

  The commands the module listens to.

• moduleInit :: !(ModuleT st LB ())

  Initialize the module. The default implementation does nothing.

• moduleExit :: !(ModuleT st LB ())

  Finalize the module. The default implementation does nothing.

• contextual :: !(String -> Cmd (ModuleT st LB) ())

  Process contextual input. A plugin that implements contextual is able to respond to text not part of a normal command.

data ModuleT st m a

This transformer encodes the additional information a module might need to access its name or its state.

Instances

MonadBase b m => MonadBase b (ModuleT st m)

Defined in Lambdabot.Module

Methods

liftBase :: b α -> ModuleT st m α

MonadBaseControl b m => MonadBaseControl b (ModuleT st m)

Defined in Lambdabot.Module

Associated Types

type StM (ModuleT st m) a

Methods

liftBaseWith :: (RunInBase (ModuleT st m) b -> b a) -> ModuleT st m a

restoreM :: StM (ModuleT st m) a -> ModuleT st m a

MonadTrans (ModuleT st)

Defined in Lambdabot.Module

Methods

lift :: Monad m => m a -> ModuleT st m a

MonadTransControl (ModuleT st)

Defined in Lambdabot.Module

Associated Types

type StT (ModuleT st) a

Methods

liftWith :: Monad m => (Run (ModuleT st) -> m a) -> ModuleT st m a

restoreT :: Monad m => m (StT (ModuleT st) a) -> ModuleT st m a

Monad m => MonadReader (ModuleInfo st) (ModuleT st m)

Defined in Lambdabot.Module

Methods

ask :: ModuleT st m (ModuleInfo st)

local :: (ModuleInfo st -> ModuleInfo st) -> ModuleT st m a -> ModuleT st m a

reader :: (ModuleInfo st -> a) -> ModuleT st m a

Monad m => Monad (ModuleT st m)

Defined in Lambdabot.Module

Methods

(>>=) :: ModuleT st m a -> (a -> ModuleT st m b) -> ModuleT st m b

(>>) :: ModuleT st m a -> ModuleT st m b -> ModuleT st m b

return :: a -> ModuleT st m a

Functor m => Functor (ModuleT st m)

Defined in Lambdabot.Module

Methods

fmap :: (a -> b) -> ModuleT st m a -> ModuleT st m b

(<$) :: a -> ModuleT st m b -> ModuleT st m a

MonadFail m => MonadFail (ModuleT st m)

Defined in Lambdabot.Module

Methods

fail :: String -> ModuleT st m a

Applicative m => Applicative (ModuleT st m)

Defined in Lambdabot.Module

Methods

pure :: a -> ModuleT st m a

(<*>) :: ModuleT st m (a -> b) -> ModuleT st m a -> ModuleT st m b

liftA2 :: (a -> b -> c) -> ModuleT st m a -> ModuleT st m b -> ModuleT st m c

(*>) :: ModuleT st m a -> ModuleT st m b -> ModuleT st m b

(<*) :: ModuleT st m a -> ModuleT st m b -> ModuleT st m a

MonadIO m => MonadIO (ModuleT st m)

Defined in Lambdabot.Module

Methods

liftIO :: IO a -> ModuleT st m a

MonadThrow m => MonadThrow (ModuleT st m)

Defined in Lambdabot.Module

Methods

throwM :: Exception e => e -> ModuleT st m a

MonadCatch m => MonadCatch (ModuleT st m)

Defined in Lambdabot.Module

Methods

catch :: Exception e => ModuleT st m a -> (e -> ModuleT st m a) -> ModuleT st m a

MonadMask m => MonadMask (ModuleT st m)

Defined in Lambdabot.Module

Methods

mask :: ((forall a. ModuleT st m a -> ModuleT st m a) -> ModuleT st m b) -> ModuleT st m b

uninterruptibleMask :: ((forall a. ModuleT st m a -> ModuleT st m a) -> ModuleT st m b) -> ModuleT st m b

generalBracket :: ModuleT st m a -> (a -> ExitCase b -> ModuleT st m c) -> (a -> ModuleT st m b) -> ModuleT st m (b, c)

MonadConfig m => MonadConfig (ModuleT st m)

Defined in Lambdabot.Module

Methods

getConfig :: Config a -> ModuleT st m a

MonadLogging m => MonadLogging (ModuleT st m)

Defined in Lambdabot.Module

Methods

getCurrentLogger :: ModuleT st m [String]

logM :: String -> Priority -> String -> ModuleT st m ()

MonadLB m => MonadLB (ModuleT st m)

Defined in Lambdabot.Monad

Methods

lb :: LB a -> ModuleT st m a

MonadLB m => MonadLBState (ModuleT st m)

Defined in Lambdabot.State

Associated Types

type LBState (ModuleT st m)

Methods

withMS :: (LBState (ModuleT st m) -> (LBState (ModuleT st m) -> ModuleT st m ()) -> ModuleT st m a) -> ModuleT st m a

type StT (ModuleT st) a

Defined in Lambdabot.Module

type StT (ModuleT st) a = a

type LBState (ModuleT st m)

Defined in Lambdabot.State

type LBState (ModuleT st m) = st

type StM (ModuleT st m) a

Defined in Lambdabot.Module

type StM (ModuleT st m) a = ComposeSt (ModuleT st) m a

newModule :: Module st

data LB a

The IRC Monad. The reader transformer holds information about the connection to the IRC server.

instances Monad, Functor, MonadIO, MonadState, MonadError

Instances

Monad LB

Defined in Lambdabot.Monad

Methods

(>>=) :: LB a -> (a -> LB b) -> LB b

(>>) :: LB a -> LB b -> LB b

return :: a -> LB a

Functor LB

Defined in Lambdabot.Monad

Methods

fmap :: (a -> b) -> LB a -> LB b

(<$) :: a -> LB b -> LB a

MonadFail LB

Defined in Lambdabot.Monad

Methods

fail :: String -> LB a

Applicative LB

Defined in Lambdabot.Monad

Methods

pure :: a -> LB a

(<*>) :: LB (a -> b) -> LB a -> LB b

liftA2 :: (a -> b -> c) -> LB a -> LB b -> LB c

(*>) :: LB a -> LB b -> LB b

(<*) :: LB a -> LB b -> LB a

MonadIO LB

Defined in Lambdabot.Monad

Methods

liftIO :: IO a -> LB a

MonadThrow LB

Defined in Lambdabot.Monad

Methods

throwM :: Exception e => e -> LB a

MonadCatch LB

Defined in Lambdabot.Monad

Methods

catch :: Exception e => LB a -> (e -> LB a) -> LB a

MonadMask LB

Defined in Lambdabot.Monad

Methods

mask :: ((forall a. LB a -> LB a) -> LB b) -> LB b

uninterruptibleMask :: ((forall a. LB a -> LB a) -> LB b) -> LB b

generalBracket :: LB a -> (a -> ExitCase b -> LB c) -> (a -> LB b) -> LB (b, c)

MonadRandom LB

Defined in Lambdabot.Bot

Methods

getRandomPrim :: Prim t -> LB t

getRandomWord8 :: LB Word8

getRandomWord16 :: LB Word16

getRandomWord32 :: LB Word32

getRandomWord64 :: LB Word64

getRandomDouble :: LB Double

getRandomNByteInteger :: Int -> LB Integer

MonadConfig LB

Defined in Lambdabot.Monad

Methods

getConfig :: Config a -> LB a

MonadLogging LB

Defined in Lambdabot.Monad

Methods

getCurrentLogger :: LB [String]

logM :: String -> Priority -> String -> LB ()

MonadLB LB

Defined in Lambdabot.Monad

Methods

lb :: LB a -> LB a

MonadBase IO LB

Defined in Lambdabot.Monad

Methods

liftBase :: IO α -> LB α

MonadBaseControl IO LB

Defined in Lambdabot.Monad

Associated Types

type StM LB a

Methods

liftBaseWith :: (RunInBase LB IO -> IO a) -> LB a

restoreM :: StM LB a -> LB a

MonadState IRCRWState LB

Defined in Lambdabot.Monad

Methods

get :: LB IRCRWState

put :: IRCRWState -> LB ()

state :: (IRCRWState -> (a, IRCRWState)) -> LB a

type StM LB a

Defined in Lambdabot.Monad

type StM LB a = StM (ReaderT (IRCRState, IORef IRCRWState) IO) a

class (MonadIO m, MonadBaseControl IO m, MonadConfig m, MonadLogging m, Applicative m, MonadFail m) => MonadLB m where

Methods

lb :: LB a -> m a

Instances

MonadLB LB

Defined in Lambdabot.Monad

Methods

lb :: LB a -> LB a

MonadLB m => MonadLB (Cmd m)

Defined in Lambdabot.Monad

Methods

lb :: LB a -> Cmd m a

MonadLB m => MonadLB (ModuleT st m)

Defined in Lambdabot.Monad

Methods

lb :: LB a -> ModuleT st m a

lim80 :: Monad m => m String -> Cmd m ()

ios80 :: MonadIO m => IO String -> Cmd m ()

convenience, similar to ios but also cut output to channel to 80 characters usage: process _ _ to _ s = ios80 to (plugs s)

data ChanName

Instances

Eq ChanName

Defined in Lambdabot.ChanName

Methods

(==) :: ChanName -> ChanName -> Bool

(/=) :: ChanName -> ChanName -> Bool

Ord ChanName

Defined in Lambdabot.ChanName

Methods

compare :: ChanName -> ChanName -> Ordering

(<) :: ChanName -> ChanName -> Bool

(<=) :: ChanName -> ChanName -> Bool

(>) :: ChanName -> ChanName -> Bool

(>=) :: ChanName -> ChanName -> Bool

max :: ChanName -> ChanName -> ChanName

min :: ChanName -> ChanName -> ChanName

mkCN :: Nick -> ChanName

getCN :: ChanName -> Nick

data Nick

The type of nicknames isolated from a message.

Constructors

Nick

Fields

• nTag :: !String

  The tag of the server this nick is on

• nName :: !String

  The server-specific nickname of this nick

Instances

Eq Nick

Defined in Lambdabot.Nick

Methods

(==) :: Nick -> Nick -> Bool

(/=) :: Nick -> Nick -> Bool

Ord Nick

Defined in Lambdabot.Nick

Methods

compare :: Nick -> Nick -> Ordering

(<) :: Nick -> Nick -> Bool

(<=) :: Nick -> Nick -> Bool

(>) :: Nick -> Nick -> Bool

(>=) :: Nick -> Nick -> Bool

max :: Nick -> Nick -> Nick

min :: Nick -> Nick -> Nick

ircPrivmsg

Arguments

:: Nick

The channel/user.

-> String

The message.

-> LB ()

Send a message to a channel/user, applying all output filters

module Lambdabot.Config

commandPrefixes :: Config [String]

disabledCommands :: Config [String]

editDistanceLimit :: Config Int

enableInsults :: Config Bool

onStartupCmds :: Config [String]

outputDir :: Config FilePath

dataDir :: Config FilePath

lbVersion :: Config Version

textWidth :: Config Int

uncaughtExceptionHandler :: Config DIH

replaceRootLogger :: Config Bool

lbRootLoggerPath :: Config [String]

consoleLogHandle :: Config Handle

consoleLogLevel :: Config Priority

consoleLogFormat :: Config String

data Command m

Constructors

Command

Fields

• cmdName :: String
• aliases :: [String]
• privileged :: Bool
• help :: Cmd m ()
• process :: String -> Cmd m ()

data Cmd m a

Instances

MonadTrans Cmd

Defined in Lambdabot.Command

Methods

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

MonadTransControl Cmd

Defined in Lambdabot.Command

Associated Types

type StT Cmd a

Methods

liftWith :: Monad m => (Run Cmd -> m a) -> Cmd m a

restoreT :: Monad m => m (StT Cmd a) -> Cmd m a

MonadBase b m => MonadBase b (Cmd m)

Defined in Lambdabot.Command

Methods

liftBase :: b α -> Cmd m α

MonadBaseControl b m => MonadBaseControl b (Cmd m)

Defined in Lambdabot.Command

Associated Types

type StM (Cmd m) a

Methods

liftBaseWith :: (RunInBase (Cmd m) b -> b a) -> Cmd m a

restoreM :: StM (Cmd m) a -> Cmd m a

Monad m => Monad (Cmd m)

Defined in Lambdabot.Command

Methods

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

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

return :: a -> Cmd m a

Functor f => Functor (Cmd f)

Defined in Lambdabot.Command

Methods

fmap :: (a -> b) -> Cmd f a -> Cmd f b

(<$) :: a -> Cmd f b -> Cmd f a

MonadFail m => MonadFail (Cmd m)

Defined in Lambdabot.Command

Methods

fail :: String -> Cmd m a

Applicative f => Applicative (Cmd f)

Defined in Lambdabot.Command

Methods

pure :: a -> Cmd f a

(<*>) :: Cmd f (a -> b) -> Cmd f a -> Cmd f b

liftA2 :: (a -> b -> c) -> Cmd f a -> Cmd f b -> Cmd f c

(*>) :: Cmd f a -> Cmd f b -> Cmd f b

(<*) :: Cmd f a -> Cmd f b -> Cmd f a

MonadIO m => MonadIO (Cmd m)

Defined in Lambdabot.Command

Methods

liftIO :: IO a -> Cmd m a

MonadConfig m => MonadConfig (Cmd m)

Defined in Lambdabot.Command

Methods

getConfig :: Config a -> Cmd m a

MonadLogging m => MonadLogging (Cmd m)

Defined in Lambdabot.Command

Methods

getCurrentLogger :: Cmd m [String]

logM :: String -> Priority -> String -> Cmd m ()

MonadLB m => MonadLB (Cmd m)

Defined in Lambdabot.Monad

Methods

lb :: LB a -> Cmd m a

MonadLBState m => MonadLBState (Cmd m)

Defined in Lambdabot.State

Associated Types

type LBState (Cmd m)

Methods

withMS :: (LBState (Cmd m) -> (LBState (Cmd m) -> Cmd m ()) -> Cmd m a) -> Cmd m a

type StT Cmd a

Defined in Lambdabot.Command

type StT Cmd a = (a, [String])

type LBState (Cmd m)

Defined in Lambdabot.State

type LBState (Cmd m) = LBState m

type StM (Cmd m) a

Defined in Lambdabot.Command

type StM (Cmd m) a = ComposeSt Cmd m a

cmdNames :: Command m -> [String]

command :: String -> Command Identity

getTarget :: Monad m => Cmd m Nick

getCmdName :: Monad m => Cmd m String

say :: Monad m => String -> Cmd m ()

withMsg :: Monad m => (forall a. Message a => a -> Cmd m t) -> Cmd m t

readNick :: Monad m => String -> Cmd m Nick

showNick :: Monad m => Nick -> Cmd m String

getServer :: Monad m => Cmd m String

getSender :: Monad m => Cmd m Nick

getLambdabotName :: Monad m => Cmd m Nick

module Lambdabot.State

module Lambdabot.File

data Serial s

Constructors

Serial

Fields

• serialize :: s -> Maybe ByteString
• deserialize :: ByteString -> Maybe s

stdSerial :: (Show s, Read s) => Serial s

Default `instance' for a Serial

mapSerial :: (Ord k, Show k, Show v, Read k, Read v) => Serial (Map k v)

Serializes a Map type if both the key and the value are instances of Read and Show. The serialization is done by converting the map to and from lists. Results are saved line-wise, for better editing and revision control.

mapPackedSerial :: Serial (Map ByteString ByteString)

assocListPackedSerial :: Serial [(ByteString, ByteString)]

mapListPackedSerial :: Serial (Map ByteString [ByteString])

readM :: (MonadFail m, Read a) => String -> m a

readM behaves like read, but catches failure in a monad. this allocates a 20-30 M on startup...

class Packable t where

Methods

readPacked :: ByteString -> t

showPacked :: t -> ByteString

Instances

Packable [(ByteString, ByteString)]

Defined in Lambdabot.Util.Serial

Methods

readPacked :: ByteString -> [(ByteString, ByteString)]

showPacked :: [(ByteString, ByteString)] -> ByteString

Packable (Map ByteString [ByteString])

An instance for Map Packed [Packed] uses gzip compression

Defined in Lambdabot.Util.Serial

Methods

readPacked :: ByteString -> Map ByteString [ByteString]

showPacked :: Map ByteString [ByteString] -> ByteString

Packable (Map ByteString (Bool, [(ByteString, Int)]))

Defined in Lambdabot.Util.Serial

Methods

readPacked :: ByteString -> Map ByteString (Bool, [(ByteString, Int)])

showPacked :: Map ByteString (Bool, [(ByteString, Int)]) -> ByteString

Packable (Map ByteString ByteString)

Defined in Lambdabot.Util.Serial

Methods

readPacked :: ByteString -> Map ByteString ByteString

showPacked :: Map ByteString ByteString -> ByteString

readOnly :: (ByteString -> b) -> Serial b