irc-0.1: A small library for parsing IRC messages Source code Contents Index

Network.IRC Portability non-portable (not tested) Stability experimental Maintainer trevor@geekgateway.com

Contents Type Synonyms IRC Datatypes Parsing and Formatting Functions Parsec Combinators for Parsing IRC messages Other Parser Combinators

Description

library for parsing IRC messages

Synopsis

type Parameter = String type ServerName = String type UserName = String type RealName = String type Command = String data Prefix = Server ServerName | NickName String (Maybe UserName) (Maybe ServerName) data Message = Message (Maybe Prefix) Command [Parameter] parseMessage :: String -> Maybe Message formatMessage :: Message -> String translateReply :: Command -> String prefix :: CharParser st Prefix server :: CharParser st Prefix nickname :: CharParser st Prefix command :: CharParser st Command parameter :: CharParser st Parameter message :: CharParser st Message crlf :: CharParser st () spaces :: CharParser st () maybeP :: GenParser tok st a -> GenParser tok st (Maybe a) tokenize :: CharParser st a -> CharParser st a takeUntil :: String -> CharParser st String

Type Synonyms

type Parameter = String Source

type ServerName = String Source

type UserName = String Source

type RealName = String Source

type Command = String Source

IRC Datatypes

data Prefix Source

The optional beginning of an IRC messages Constructors Server ServerName Server Prefix NickName String (Maybe UserName) (Maybe ServerName) Nickname Prefix Instances Show Prefix

data Message Source

IRC messages are parsed as: [ ':' prefix space ] command { space param } crlf Constructors Message (Maybe Prefix) Command [Parameter] IRC Message Instances Show Message

Parsing and Formatting Functions

parseMessage Source

:: String Message string -> Maybe Message Parsed message Parse a String into a Message.

formatMessage Source

:: Message IRC Message -> String Formatted message Message formatting

translateReply Source

:: Command Reply -> String Text translation Translate a reply into the text version of the reply. If no text version is available, the argument is returned.

Parsec Combinators for Parsing IRC messages

prefix :: CharParser st Prefix Source

Parse a Prefix

server :: CharParser st Prefix Source

Parse a Server prefix

nickname :: CharParser st Prefix Source

Parse a NickName prefix

command :: CharParser st Command Source

Parse a command. Either a string of capital letters, or 3 digits.

parameter :: CharParser st Parameter Source

Parse a command parameter.

message :: CharParser st Message Source

Parse a Message

crlf :: CharParser st () Source

Parse a cr lf

spaces :: CharParser st () Source

Consume only spaces tabs or the bell character

Other Parser Combinators

maybeP :: GenParser tok st a -> GenParser tok st (Maybe a) Source

Convert a parser into an optional one that returns a Maybe

tokenize :: CharParser st a -> CharParser st a Source

Convert a parser that consumes all space after it

takeUntil :: String -> CharParser st String Source

Take all tokens until one character from a given string is found

Produced by Haddock version 2.1.0