blaze-markup-0.8.2.2: A blazingly fast markup combinator library for Haskell

Safe HaskellNone
LanguageHaskell98

Text.Blaze.Internal

Contents

Description

The BlazeMarkup core, consisting of functions that offer the power to generate custom markup elements. It also offers user-centric functions, which are exposed through Blaze.

While this module is exported, usage of it is not recommended, unless you know what you are doing. This module might undergo changes at any time.

Synopsis

Important types.

data ChoiceString Source #

A string denoting input from different string representations.

Constructors

Static !StaticString

Static data

String String

A Haskell String

Text Text

A Text value

ByteString ByteString

An encoded bytestring

PreEscaped ChoiceString

A pre-escaped string

External ChoiceString

External data in style/script tags, should be checked for validity

AppendChoiceString ChoiceString ChoiceString

Concatenation

EmptyChoiceString

Empty string

data StaticString Source #

A static string that supports efficient output to all possible backends.

Constructors

StaticString 

Fields

Instances
IsString StaticString Source # 
Instance details

Defined in Text.Blaze.Internal

data MarkupM a Source #

The core Markup datatype.

Constructors

Parent StaticString StaticString StaticString (MarkupM a)

Tag, open tag, end tag, content

CustomParent ChoiceString (MarkupM a)

Custom parent

Leaf StaticString StaticString StaticString a

Tag, open tag, end tag

CustomLeaf ChoiceString Bool a

Custom leaf

Content ChoiceString a

HTML content

Comment ChoiceString a

HTML comment. Note: you should wrap the ChoiceString in a PreEscaped.

Append (MarkupM b) (MarkupM a)

Concatenation of two HTML pieces

AddAttribute StaticString StaticString ChoiceString (MarkupM a)

Add an attribute to the inner HTML. Raw key, key, value, HTML to receive the attribute.

AddCustomAttribute ChoiceString ChoiceString (MarkupM a)

Add a custom attribute to the inner HTML.

Empty a

Empty HTML.

Instances
Monad MarkupM Source # 
Instance details

Defined in Text.Blaze.Internal

Methods

(>>=) :: MarkupM a -> (a -> MarkupM b) -> MarkupM b #

(>>) :: MarkupM a -> MarkupM b -> MarkupM b #

return :: a -> MarkupM a #

fail :: String -> MarkupM a #

Functor MarkupM Source # 
Instance details

Defined in Text.Blaze.Internal

Methods

fmap :: (a -> b) -> MarkupM a -> MarkupM b #

(<$) :: a -> MarkupM b -> MarkupM a #

Applicative MarkupM Source # 
Instance details

Defined in Text.Blaze.Internal

Methods

pure :: a -> MarkupM a #

(<*>) :: MarkupM (a -> b) -> MarkupM a -> MarkupM b #

liftA2 :: (a -> b -> c) -> MarkupM a -> MarkupM b -> MarkupM c #

(*>) :: MarkupM a -> MarkupM b -> MarkupM b #

(<*) :: MarkupM a -> MarkupM b -> MarkupM a #

ToMarkup Markup Source # 
Instance details

Defined in Text.Blaze

a ~ () => IsString (MarkupM a) Source # 
Instance details

Defined in Text.Blaze.Internal

Methods

fromString :: String -> MarkupM a #

Monoid a => Semigroup (MarkupM a) Source # 
Instance details

Defined in Text.Blaze.Internal

Methods

(<>) :: MarkupM a -> MarkupM a -> MarkupM a #

sconcat :: NonEmpty (MarkupM a) -> MarkupM a #

stimes :: Integral b => b -> MarkupM a -> MarkupM a #

Monoid a => Monoid (MarkupM a) Source # 
Instance details

Defined in Text.Blaze.Internal

Methods

mempty :: MarkupM a #

mappend :: MarkupM a -> MarkupM a -> MarkupM a #

mconcat :: [MarkupM a] -> MarkupM a #

Attributable (MarkupM a) Source # 
Instance details

Defined in Text.Blaze.Internal

Methods

(!) :: MarkupM a -> Attribute -> MarkupM a Source #

ToMarkup [Markup] Source # 
Instance details

Defined in Text.Blaze

Attributable (MarkupM a -> MarkupM b) Source # 
Instance details

Defined in Text.Blaze.Internal

Methods

(!) :: (MarkupM a -> MarkupM b) -> Attribute -> MarkupM a -> MarkupM b Source #

type Markup = MarkupM () Source #

Simplification of the MarkupM datatype.

data Tag Source #

Type for an HTML tag. This can be seen as an internal string type used by BlazeMarkup.

Instances
IsString Tag Source # 
Instance details

Defined in Text.Blaze.Internal

Methods

fromString :: String -> Tag #

data Attribute Source #

Type for an attribute.

Creating custom tags and attributes.

customParent Source #

Arguments

:: Tag

Element tag

-> Markup

Content

-> Markup

Resulting markup

Create a custom parent element

customLeaf Source #

Arguments

:: Tag

Element tag

-> Bool

Close the leaf?

-> Markup

Resulting markup

Create a custom leaf element

attribute Source #

Arguments

:: Tag

Raw key

-> Tag

Shared key string for the HTML attribute.

-> AttributeValue

Value for the HTML attribute.

-> Attribute

Resulting HTML attribute.

Create an HTML attribute that can be applied to an HTML element later using the ! operator.

dataAttribute Source #

Arguments

:: Tag

Name of the attribute.

-> AttributeValue

Value for the attribute.

-> Attribute

Resulting HTML attribute.

From HTML 5 onwards, the user is able to specify custom data attributes.

An example:

<p data-foo="bar">Hello.</p>

We support this in BlazeMarkup using this function. The above fragment could be described using BlazeMarkup with:

p ! dataAttribute "foo" "bar" $ "Hello."

customAttribute Source #

Arguments

:: Tag

Name of the attribute

-> AttributeValue

Value for the attribute

-> Attribute

Resulting HTML attribtue

Create a custom attribute. This is not specified in the HTML spec, but some JavaScript libraries rely on it.

An example:

<select dojoType="select">foo</select>

Can be produced using:

select ! customAttribute "dojoType" "select" $ "foo"

Converting values to Markup.

text Source #

Arguments

:: Text

Text to render.

-> Markup

Resulting HTML fragment.

Render text. Functions like these can be used to supply content in HTML.

preEscapedText Source #

Arguments

:: Text

Text to insert

-> Markup

Resulting HTML fragment

Render text without escaping.

lazyText Source #

Arguments

:: Text

Text to insert

-> Markup

Resulting HTML fragment

A variant of text for lazy Text.

preEscapedLazyText Source #

Arguments

:: Text

Text to insert

-> Markup

Resulting HTML fragment

A variant of preEscapedText for lazy Text

textBuilder Source #

Arguments

:: Builder

Text to insert

-> Markup

Resulting HTML fragment

A variant of text for text Builder.

preEscapedTextBuilder Source #

Arguments

:: Builder

Text to insert

-> Markup

Resulting HTML fragment

A variant of preEscapedText for lazy Text

string Source #

Arguments

:: String

String to insert.

-> Markup

Resulting HTML fragment.

Create an HTML snippet from a ChoiceString.

preEscapedString Source #

Arguments

:: String

String to insert.

-> Markup

Resulting HTML fragment.

Create an HTML snippet from a ChoiceString without escaping

unsafeByteString Source #

Arguments

:: ByteString

Value to insert.

-> Markup

Resulting HTML fragment.

Insert a ChoiceString. This is an unsafe operation:

  • The ChoiceString could have the wrong encoding.
  • The ChoiceString might contain illegal HTML characters (no escaping is done).

unsafeLazyByteString Source #

Arguments

:: ByteString

Value to insert

-> Markup

Resulting HTML fragment

Insert a lazy ByteString. See unsafeByteString for reasons why this is an unsafe operation.

Comments

textComment :: Text -> Markup Source #

Create a comment from a ChoiceString value. The text should not contain "--". This is not checked by the library.

lazyTextComment :: Text -> Markup Source #

Create a comment from a Text value. The text should not contain "--". This is not checked by the library.

stringComment :: String -> Markup Source #

Create a comment from a ChoiceString value. The text should not contain "--". This is not checked by the library.

unsafeByteStringComment :: ByteString -> Markup Source #

Create a comment from a ChoiceString value. The text should not contain "--". This is not checked by the library.

unsafeLazyByteStringComment :: ByteString -> Markup Source #

Create a comment from a ByteString value. The text should not contain "--". This is not checked by the library.

Converting values to tags.

textTag Source #

Arguments

:: Text

Text to create a tag from

-> Tag

Resulting tag

Create a Tag from some ChoiceString.

stringTag Source #

Arguments

:: String

String to create a tag from

-> Tag

Resulting tag

Create a Tag from a ChoiceString.

Converting values to attribute values.

textValue Source #

Arguments

:: Text

The actual value.

-> AttributeValue

Resulting attribute value.

Render an attribute value from ChoiceString.

preEscapedTextValue Source #

Arguments

:: Text

The actual value

-> AttributeValue

Resulting attribute value

Render an attribute value from ChoiceString without escaping.

lazyTextValue Source #

Arguments

:: Text

The actual value

-> AttributeValue

Resulting attribute value

A variant of textValue for lazy Text

preEscapedLazyTextValue Source #

Arguments

:: Text

The actual value

-> AttributeValue

Resulting attribute value

A variant of preEscapedTextValue for lazy Text

textBuilderValue Source #

Arguments

:: Builder

The actual value

-> AttributeValue

Resulting attribute value

A variant of textValue for text Builder

preEscapedTextBuilderValue Source #

Arguments

:: Builder

The actual value

-> AttributeValue

Resulting attribute value

A variant of preEscapedTextValue for text Builder

stringValue :: String -> AttributeValue Source #

Create an attribute value from a ChoiceString.

preEscapedStringValue :: String -> AttributeValue Source #

Create an attribute value from a ChoiceString without escaping.

unsafeByteStringValue Source #

Arguments

:: ByteString

ByteString value

-> AttributeValue

Resulting attribute value

Create an attribute value from a ChoiceString. See unsafeByteString for reasons why this might not be a good idea.

unsafeLazyByteStringValue Source #

Arguments

:: ByteString

ByteString value

-> AttributeValue

Resulting attribute value

Create an attribute value from a lazy ByteString. See unsafeByteString for reasons why this might not be a good idea.

Setting attributes

class Attributable h Source #

Used for applying attributes. You should not define your own instances of this class.

Minimal complete definition

(!)

Instances
Attributable (MarkupM a) Source # 
Instance details

Defined in Text.Blaze.Internal

Methods

(!) :: MarkupM a -> Attribute -> MarkupM a Source #

Attributable (MarkupM a -> MarkupM b) Source # 
Instance details

Defined in Text.Blaze.Internal

Methods

(!) :: (MarkupM a -> MarkupM b) -> Attribute -> MarkupM a -> MarkupM b Source #

(!) :: Attributable h => h -> Attribute -> h Source #

Apply an attribute to an element.

Example:

img ! src "foo.png"

Result:

<img src="foo.png" />

This can be used on nested elements as well.

Example:

p ! style "float: right" $ "Hello!"

Result:

<p style="float: right">Hello!</p>

(!?) :: Attributable h => h -> (Bool, Attribute) -> h Source #

Shorthand for setting an attribute depending on a conditional.

Example:

p !? (isBig, A.class "big") $ "Hello"

Gives the same result as:

(if isBig then p ! A.class "big" else p) "Hello"

Modifying Markup elements

contents :: MarkupM a -> MarkupM a Source #

Take only the text content of an HTML tree.

contents $ do
    p ! $ "Hello "
    p ! $ "Word!"

Result:

Hello World!

external :: MarkupM a -> MarkupM a Source #

Mark HTML as external data. External data can be:

This function is applied automatically when using the style or script combinators.

Querying Markup elements

null :: MarkupM a -> Bool Source #

Check if a Markup value is completely empty (renders to the empty string).