Safe Haskell	None
Language	Haskell2010

Network.Irc.Types

Contents

Type Aliases, Newtypes, Other Basics
Message Parts
Mask
Message
Modes
Reply

Synopsis

Type Aliases, Newtypes, Other Basics

module Network.Irc.Types.Base

Message Parts

data Prefix Source #

IRC message prefix.

Constructors

PrefixServer Hostname	The server which sends the message
PrefixNick Nickname (Maybe Username) (Maybe Host)	The user which sends the message (if the message comes from a user)

Instances

Eq Prefix Source #
Methods (==) :: Prefix -> Prefix -> Bool # (/=) :: Prefix -> Prefix -> Bool #
Show Prefix Source #
Methods showsPrec :: Int -> Prefix -> ShowS # show :: Prefix -> String # showList :: [Prefix] -> ShowS #

data UserAddress Source #

User address containing a name part (as in "user") and an optional host part (as in "user@host").

Constructors

UserAddress Username (Maybe Host)

Instances

Eq UserAddress Source #
Methods (==) :: UserAddress -> UserAddress -> Bool # (/=) :: UserAddress -> UserAddress -> Bool #
Show UserAddress Source #
Methods showsPrec :: Int -> UserAddress -> ShowS # show :: UserAddress -> String # showList :: [UserAddress] -> ShowS #

data Target Source #

Some IRC commands operate on a target, that is either a single user or an entire IRC server.

Constructors

NickTarget Nickname
ServerTarget Hostname

Instances

Eq Target Source #
Methods (==) :: Target -> Target -> Bool # (/=) :: Target -> Target -> Bool #
Show Target Source #
Methods showsPrec :: Int -> Target -> ShowS # show :: Target -> String # showList :: [Target] -> ShowS #

data Address Source #

An IP address.

Constructors

IPv4 Text
IPv6 Text

Instances

Eq Address Source #
Methods (==) :: Address -> Address -> Bool # (/=) :: Address -> Address -> Bool #
Show Address Source #
Methods showsPrec :: Int -> Address -> ShowS # show :: Address -> String # showList :: [Address] -> ShowS #

data Host Source #

A host, either a hostname (e.g. irc.freenode.net) or an IP address, or a cloak assigned by the server.

Constructors

HostByName Hostname
HostByAddr Address
HostCloak Text

Instances

Eq Host Source #
Methods (==) :: Host -> Host -> Bool # (/=) :: Host -> Host -> Bool #
Show Host Source #
Methods showsPrec :: Int -> Host -> ShowS # show :: Host -> String # showList :: [Host] -> ShowS #

data Command Source #

An IRC command code. Either a named command, or a numeric one.

Constructors

NamedCmd CmdName
NumericCmd CmdNumber

Instances

Eq Command Source #
Methods (==) :: Command -> Command -> Bool # (/=) :: Command -> Command -> Bool #
Show Command Source #
Methods showsPrec :: Int -> Command -> ShowS # show :: Command -> String # showList :: [Command] -> ShowS #

Mask

data MaskPart Source #

Part of a Mask.

Constructors

MaskChar Char	A literal character.
MaskWildOne	A wildcard which matches a single character.
MaskWildMany	A wildcard which matches zero or more characters.

Instances

Eq MaskPart Source #
Methods (==) :: MaskPart -> MaskPart -> Bool # (/=) :: MaskPart -> MaskPart -> Bool #
Show MaskPart Source #
Methods showsPrec :: Int -> MaskPart -> ShowS # show :: MaskPart -> String # showList :: [MaskPart] -> ShowS #

newtype Mask Source #

A pattern for matching host and server names. A mask in the protocol is a string which consists of literal characters and wildcards. There are two wildcards: ?, which matches a single character; *, which matches any number of characters (zero or more).

Constructors

Mask [MaskPart]

Instances

Eq Mask Source #
Methods (==) :: Mask -> Mask -> Bool # (/=) :: Mask -> Mask -> Bool #
Show Mask Source #
Methods showsPrec :: Int -> Mask -> ShowS # show :: Mask -> String # showList :: [Mask] -> ShowS #

data TargetMask Source #

Some IRC command parameters are targets, and one way to specify a target is using a Mask.

Constructors

HostMask Mask	Host mask, prefixed with `#` in the protocol. Selects all the users whose host matches the mask.
ServerMask Mask	Server mask, prefixed with `$` in the protocol. Selects all the users connected to a server which matches the mask.

Instances

Eq TargetMask Source #
Methods (==) :: TargetMask -> TargetMask -> Bool # (/=) :: TargetMask -> TargetMask -> Bool #
Show TargetMask Source #
Methods showsPrec :: Int -> TargetMask -> ShowS # show :: TargetMask -> String # showList :: [TargetMask] -> ShowS #

Message

data GenericMessage Source #

A generic IRC message. It consists of a sender prefix, command name (string or numeric) and optionally a list of parameters.

Constructors

GenericMessage
Fields gmPrefix :: Maybe Prefix gmCommand :: Command gmParams :: [Text]

Instances

Show GenericMessage Source #
Methods showsPrec :: Int -> GenericMessage -> ShowS # show :: GenericMessage -> String # showList :: [GenericMessage] -> ShowS #

data SpecificMessage Source #

An IRC message of a specific type. This includes only messages whose command is a name. Messages with a numeric command are handled in the Network.IRC.Fun.Messages.Reply module.

Constructors

SpecificMessage (Maybe Prefix) Message

Instances

Show SpecificMessage Source #
Methods showsPrec :: Int -> SpecificMessage -> ShowS # show :: SpecificMessage -> String # showList :: [SpecificMessage] -> ShowS #

data MessageTarget Source #

Some IRC commands have targets. For example, to which channel to send a given text message. Targets are specified as parameters in IRC messages.

Constructors

ChannelTarget Channel

An IRC channel.

UserTarget (Maybe Nickname) (Maybe UserAddress) (Maybe Hostname)

An IRC user. Possible combinations in the protocol are:

Address (address host is required)
Address and server (address host is optional)
Nickname
Nickname and address (address host is required)

MaskTarget TargetMask

A mask which matches the server or host of the users to whom the message should be sent.

Instances

Show MessageTarget Source #
Methods showsPrec :: Int -> MessageTarget -> ShowS # show :: MessageTarget -> String # showList :: [MessageTarget] -> ShowS #

data Query Source #

A server query. Can be sent through a StatsMessage.

Constructors

Connections	TODO
CommandUsage	TODO
PrivilegedUsers	TODO
Uptime	TODO
OtherQuery Char	TODO

Instances

Show Query Source #
Methods showsPrec :: Int -> Query -> ShowS # show :: Query -> String # showList :: [Query] -> ShowS #

data Message Source #

An IRC message of specific type (excluding the optional sender prefix, see SpecificMessage).

Constructors

PassMessage Password
NickMessage Nickname
UserMessage Username Bool Bool RealName	first bool = whether invisible, second bool = whether sees wallops
OperMessage Username Password
UserModeMessage Nickname [UserMode] [UserMode]	first list: modes to remove (-), second list: modes to add (+)
ServiceMessage Nickname Mask Text
QuitMessage (Maybe Comment)
SQuitMessage Hostname Comment
JoinMessage (Maybe ([Channel], [ChannelKey]))
PartMessage [Channel] (Maybe Comment)
ChannelModeMessage [ChannelMode] [ChannelMode]
TopicMessage Channel (Maybe ChannelTopic)
NamesMessage [Channel] (Maybe Hostname)
ListMessage [Channel] (Maybe Hostname)
InviteMessage Nickname Channel
KickMessage [Channel] [Username] (Maybe Comment)
PrivMsgMessage MessageTarget MsgContent
PrivActionMessage MessageTarget MsgContent
NoticeMessage MessageTarget MsgContent
MotdMessage (Maybe Hostname)
LusersMessage (Maybe (Mask, Maybe Hostname))
VersionMessage (Maybe (Either Hostname Mask))
StatsMessage (Maybe (Query, Maybe (Either Hostname Mask)))
LinksMessage (Maybe (Maybe (Either Hostname Mask), Mask))
TimeMessage (Maybe (Either Hostname Mask))
ConnectMessage Hostname PortNumber (Either Hostname Mask)
TraceMessage (Maybe Target)
AdminMessage (Maybe Target)
InfoMessage (Maybe Target)
ServlistMessage (Maybe (Mask, Maybe Text))
SQueryMessage ServiceName MsgContent
WhoMessage (Maybe (Mask, Bool))
WhoisMessage (Maybe Hostname) [Mask]
WhowasMessage [Nickname] (Maybe (Int, Maybe Hostname))
KillMessage Nickname Comment
PingMessage Hostname (Maybe Hostname)
PongMessage Hostname (Maybe Hostname)
ErrorMessage Text
AwayMessage (Maybe MsgContent)
RehashMessage
DieMessage
RestartMessage
SummonMessage Username (Maybe (Hostname, Maybe Channel))
UsersMessage (Maybe Hostname)
WallopsMessage MsgContent
UserhostMessage [Nickname]
IsonMessage [Nickname]

Instances

Show Message Source #
Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #

data AnalysisError Source #

An error occuring while analyzing a parsed IRC protocol message into a specific message type, such as JoinMessage.

Constructors

WrongNumArgs Int (Maybe ArgSpec)
InvalidArg (Maybe Int) (Maybe Text) (Maybe Text)
OtherError Text

Instances

Show AnalysisError Source #
Methods showsPrec :: Int -> AnalysisError -> ShowS # show :: AnalysisError -> String # showList :: [AnalysisError] -> ShowS #

data ArgSpec Source #

Specifies the number of parameter a certain IRC message type accepts.

Constructors

Exactly Int
AtLeast Int
AtMost Int
Between Int Int
OneOf [Int]

Instances

Show ArgSpec Source #
Methods showsPrec :: Int -> ArgSpec -> ShowS # show :: ArgSpec -> String # showList :: [ArgSpec] -> ShowS #

Modes

data UserMode Source #

TODO

Constructors

UModeInvisible
UModeCallerID
UModeSeeWallops
UModeDeaf
UModeNoForwarding
UModeBlockUnidentified
UModeConnectedViaSSL
UModeAway
UModeRestricted
UModeOperator
UModeLocalOperator
UModeSeeNotices
UModeOther Char

Instances

Eq UserMode Source #
Methods (==) :: UserMode -> UserMode -> Bool # (/=) :: UserMode -> UserMode -> Bool #
Show UserMode Source #
Methods showsPrec :: Int -> UserMode -> ShowS # show :: UserMode -> String # showList :: [UserMode] -> ShowS #

data ChannelMode Source #

TODO

Instances

Eq ChannelMode Source #
Methods (==) :: ChannelMode -> ChannelMode -> Bool # (/=) :: ChannelMode -> ChannelMode -> Bool #
Show ChannelMode Source #
Methods showsPrec :: Int -> ChannelMode -> ShowS # show :: ChannelMode -> String # showList :: [ChannelMode] -> ShowS #

data ChannelModeType Source #

Constructors

ModeTypeList
ModeTypeSetting
ModeTypeMaybeSetting
ModeTypeFlag

Reply

data GenericReply Source #

TODO

Constructors

GenericReply
Fields grSender :: Hostname grCode :: CmdNumber grTarget :: Target grParams :: [Parameter]

Instances

Show GenericReply Source #
Methods showsPrec :: Int -> GenericReply -> ShowS # show :: GenericReply -> String # showList :: [GenericReply] -> ShowS #

data Reply Source #

TODO

Constructors

WelcomeReply	TODO
YourHostReply	TODO
CreatedReply	TODO
MyInfoReply	TODO
BounceReply	TODO
ISupportReply	TODO
UserHostReply	TODO
IsOnReply	TODO
AwayReply	TODO
UnAwayReply	TODO
NoAwayReply	TODO
WhoIsUserReply	TODO
WhoIsServerReply	TODO
WhoIsOperatorReply	TODO
WhoIsIdleReply	TODO
EndOfWhoIsReply	TODO
WhoIsChannelsReply	TODO
WhoWasUserReply	TODO
EndOfWhoWasReply	TODO
ListStartReply	TODO
ListReply	TODO
ListEndReply	TODO
UniqueOpIsReply	TODO
ChannelModeIsReply	TODO
NoTopicReply	TODO
TopicReply	TODO
InvitingReply	TODO
SummoningReply	TODO
InviteListReply	TODO
EndOfInviteListReply	TODO
ExceptListReply	TODO
EndOfExceptListReply	TODO
VersionReply	TODO
WhoReply	TODO
EndOfWhoReply	TODO
NamesReply ChannelPrivacy Channel [(Privilege, Nickname)]	Lists members of IRC channels. Sent when JOINing a channel to list the users in that channel, or as a response to the NAMES command.
EndOfNamesReply	Sent after a sequence of 0 or more `NameReply`s, to signal that the list transmission is finished.
LinksReply	TODO
EndOfLinksReply	TODO
BanListReply	TODO
EndOfBanListReply	TODO
InfoReply	TODO
EndOfInfoReply	TODO
MotdStartReply	TODO
MessageOfTheDayReply	TODO
EndOfMessageOfTheDayReply	TODO
YoureOperReply	TODO
RehashingReply	TODO
YoureServiceReply	TODO
TimeReply	TODO
UsersStartReply	TODO
UsersReply	TODO
EndOfUsersReply	TODO
NoUsersReply	TODO
TraceLinkReply	TODO
TraceConnectingReply	TODO
TraceHandshakeReply	TODO
TraceUnknownReply	TODO
TraceOperatorReply	TODO
TraceUserReply	TODO
TraceServerReply	TODO
TraceServiceReply	TODO
TraceNewTypeReply	TODO
TraceClassReply	TODO
TraceReconnectReply	TODO
TraceLogReply	TODO
TraceEndReply	TODO
StatsLinkInfoReply	TODO
StatsCommandsReply	TODO
EndOfStatsReply	TODO
StatsUptimeReply	TODO
StatsOLineReply	TODO
UModeIsReply	TODO
ServListReply	TODO
ServListEndReply	TODO
LuserClientReply	TODO
LuserOpReply	TODO
LuserUnknownReply	TODO
LuserChannelsReply	TODO
LuserMeReply	TODO
AdminMeReply	TODO
AdminLocation1Reply	TODO
AdminLocation2Reply	TODO
AdminEmailReply	TODO
TryAgainReply	TODO

Instances

Eq Reply Source #
Methods (==) :: Reply -> Reply -> Bool # (/=) :: Reply -> Reply -> Bool #
Show Reply Source #
Methods showsPrec :: Int -> Reply -> ShowS # show :: Reply -> String # showList :: [Reply] -> ShowS #

data SpecificReply Source #

An IRC server numeric reply of a specific type.

Constructors

SpecificReply Hostname Target Reply

Instances

Show SpecificReply Source #
Methods showsPrec :: Int -> SpecificReply -> ShowS # show :: SpecificReply -> String # showList :: [SpecificReply] -> ShowS #

CModeCreator
CModeOperator
CModeVoice
CModeAnonymous
CModeInviteOnly
CModeModerated
CModeNoMessagesFromOutside
CModeQuiet
CModePrivate
CModeSecret
CModeServerReop
CModeTopicSettableByChannelOpOnly
CModeKey (Maybe ChannelKey)
CModeUserLimit (Maybe Int)
CModeBanMask (Maybe Mask)
CModeExceptionMask (Maybe Mask)
CModeInvitationMask (Maybe Mask)
CModeOther Char [Text]
CModeFreenodeQuiet (Maybe Mask)