Client.Image.Message

This module provides image renderers for messages.

Documentation

data MessageRendererParams

Parameters used when rendering messages

Constructors

MessageRendererParams

Fields

• rendStatusMsg :: [Char]

  restricted message sigils

• rendUserSigils :: [Char]

  sender sigils

• rendHighlights :: HashMap Identifier Highlight

  words to highlight

• rendPalette :: Palette

  nick color palette

• rendAccounts :: Maybe (HashMap Identifier UserAndHost)
• rendNetPalette :: NetworkPalette
• rendChanTypes :: [Char]

  A list of valid channel name prefixes.

data RenderMode

Level of detail to use when rendering

Constructors

NormalRender

only render nicknames

DetailedRender

render full user info

data IdentifierColorMode

Constructors

PrivmsgIdentifier

An identifier in a PRIVMSG

NormalIdentifier

An identifier somewhere else

defaultRenderParams :: MessageRendererParams

Default MessageRendererParams with no sigils or nicknames specified

msgImage

Arguments

:: ZonedTime

time of message

-> MessageRendererParams

render parameters

-> MessageBody

message body

-> (Image', Image', Image')

prefix, image, full

Construct a message given the time the message was received and its render parameters.

metadataImg :: Palette -> IrcSummary -> Maybe (Image', Identifier, Maybe Identifier)

Returns image and identifier to be used when collapsing metadata messages.

ignoreImage :: Palette -> Image'

Image used when treating ignored chat messages as metadata

quietIdentifier :: Palette -> Identifier -> Image'

Render an identifier without using colors. This is useful for metadata.

coloredUserInfo

Arguments

:: Palette

color palette

-> RenderMode

mode

-> HashMap Identifier Highlight

highlights

-> UserInfo

userinfo to draw

-> Image'

Render an a full user. In normal mode only the nickname will be rendered. If detailed mode the full user info including the username and hostname parts will be rendered. The nickname will be colored.

coloredIdentifier

Arguments

:: Palette

color palette

-> IdentifierColorMode

draw mode

-> HashMap Identifier Highlight

highlights

-> Identifier

identifier to draw

-> Image'

Render a nickname in its hash-based color.

cleanText :: Text -> Text

cleanChar :: Char -> Char

nickPad

Arguments

:: PaddingMode

padding mode

-> Image'

input image

-> Image'

padded image

Optionally add padding to an input image according to the specified mode. If the input image is already wider than the specified padding mode, the image is returned unmodified.

timeImage :: Palette -> TimeOfDay -> Image'

Render a ZonedTime as time using quiet attributes

23:15

drawWindowLine

Arguments

:: Palette

palette

-> Int

draw columns

-> PaddingMode

nick padding

-> WindowLine

window line

-> [Image']

wrapped lines

Render the normal view of a chat message line padded and wrapped.

modesImage :: Attr -> HashMap Char Attr -> String -> Image'

prettyTime :: Int -> String -> String

Render string representing seconds into days, hours, minutes, and seconds.

parseIrcTextWithNicks

Arguments

:: Palette

palette

-> HashMap Identifier Highlight

Highlights

-> Bool

explicit controls rendering

-> Text

input text

-> Image'

colored text

Parse message text to construct an image. If the text has formatting control characters in it then the text will be rendered according to the formatting codes. Otherwise the nicknames in the message are highlighted.

data Highlight

Constructors

HighlightMe

HighlightNick

HighlightError

HighlightNone

Instances

Eq Highlight

Defined in Client.Image.Message

Methods

(==) :: Highlight -> Highlight -> Bool

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