Network.Damn

This module provides a datatype and convenience functions for parsing, manipulating, and rendering deviantART Message Network messages.

Datatypes

data Message

A top-level dAmn message.

General syntax for a message:

name arg
attr1=val1
attr2=val2

body

As reflected in the field types of Message, the arg and body are both optional.

Attribute values are considered to be textual data and generally consist of part reasons, privclass names, users' "taglines" and so on. The message body can either be treated as text or as a SubMessage (see MessageBody).

Note that dAmn is a primarily browser-based platform; it deals with only ISO-8859-1 output and input and inserts chat messages directly into the DOM. As a consequence, correctly displaying characters past the ASCII block requires the use of HTML entities.

All functions in this module transparently convert HTML entities embedded in ByteStrings to Text (and back; see toBodyText). Thus, when Text appears in fields of this record or of SubMessage, you can assume that the HTML entity decoding step has already been handled.

Constructors

Message

Fields

• messageName :: ByteString
• messageArgument :: Maybe ByteString
• messageAttrs :: [(ByteString, Text)]
• messageBody :: Maybe MessageBody

Instances

Eq Message

Methods

(==) :: Message -> Message -> Bool

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

Show Message

Methods

showsPrec :: Int -> Message -> ShowS

show :: Message -> String

showList :: [Message] -> ShowS

data SubMessage

A second-level dAmn message. Note that this message can omit the name/argument pair.

Constructors

SubMessage

Fields

• subMessageName :: Maybe ByteString
• subMessageArgument :: Maybe ByteString
• subMessageAttrs :: [(ByteString, Text)]
• subMessageBody :: Maybe MessageBody

Instances

Eq SubMessage

Methods

(==) :: SubMessage -> SubMessage -> Bool

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

Show SubMessage

Methods

showsPrec :: Int -> SubMessage -> ShowS

show :: SubMessage -> String

showList :: [SubMessage] -> ShowS

data MessageBody

The body of a message, which can be converted to various formats (bodyWithFormat) or parsed as a SubMessage (subMessage).

Instances

Eq MessageBody

Methods

(==) :: MessageBody -> MessageBody -> Bool

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

Show MessageBody

Methods

showsPrec :: Int -> MessageBody -> ShowS

show :: MessageBody -> String

showList :: [MessageBody] -> ShowS

IsString MessageBody

Methods

fromString :: String -> MessageBody

Working with message bodies

bodyBytes :: MessageBody -> ByteString

View the original binary content of a MessageBody.

To interpret this as textual data, use bodyWithFormat.

type Formatter m = Either Text Lump -> m

bodyWithFormat :: Monoid s => Formatter s -> MessageBody -> s

Convert a MessageBody to some stringlike representation using the given Formatter. (See damnFormat).

toBody :: ByteString -> MessageBody

MessageBody smart constructor.

toBodyText :: Text -> MessageBody

Like toBody, but convert codepoints outside the ASCII range to HTML entities.

Note that this is NOT equivalent to toBody . encodeUtf8.

Working with sub-messages

subMessage :: MessageBody -> forall m. MonadFail m => m SubMessage

Try to parse a MessageBody as a SubMessage.

pattern SubM :: SubMessage -> Maybe MessageBody

subMessage as a pattern.

case messageBody of
    Sub (SubMessage name args attrs body)) -> ...
    _ -> error "No parse"

Can be nested:

isJoinPacket :: Message -> Bool
isJoinPacket (Message "recv" room _
    (Sub (SubMessage (Just "join") (Just uname) _
        (Sub (SubMessage Nothing Nothing userAttrs _)))))
    = True
isJoinPacket _ = False

Parsing

parseMessage :: ByteString -> Either String Message

parseOnly messageP

messageP :: Parser Message

Rendering

render :: Message -> ByteString

Convert a Message back into a ByteString to send to dAmn. The null byte is appended. In addition, all characters outside the ASCII block are converted to HTML entities, thus

>>> render (Message "foo" (Just "bar") [("attr1", "☭")] Nothing)
"foo bar\nattr1=☭\n\NUL"

Tablumps

data Lump

Tokens representing tablumps.

These constructors are defined first in order of arity, then alphabetically.

Constructors

A ByteString ByteString

C_A

Abbr ByteString

C_Abbr

Acro ByteString

C_Acro

Avatar ByteString ByteString

B

C_B

Bcode

C_Bcode

Br

Code

C_Code

Dev ByteString ByteString

Embed ByteString ByteString ByteString

C_Embed

Emote ByteString ByteString ByteString ByteString ByteString

I

C_I

Iframe ByteString ByteString ByteString

C_Iframe

Img ByteString ByteString ByteString

Li

C_Li

Link ByteString (Maybe ByteString)

Ol

C_Ol

P

C_P

S

C_S

Sub

C_Sub

Sup

C_Sup

Thumb ByteString ByteString ByteString ByteString ByteString ByteString

U

C_U

Ul

C_Ul

Instances

Eq Lump

Methods

(==) :: Lump -> Lump -> Bool

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

Show Lump

Methods

showsPrec :: Int -> Lump -> ShowS

show :: Lump -> String

showList :: [Lump] -> ShowS