Text.XML.Generator

This module provides combinators for generating XML documents.

As an example, suppose you want to generate the following XML document:

 <?xml version="1.0"?>
 <people>
   <person age="32">Stefan</person>
   <person age="4">Judith</person>
 </people>

Then you could use the following Haskell code:

 let people = [("Stefan", "32"), ("Judith", "4")]
 in doc defaultDocInfo $
      xelem "people" $
        xelems $ map ((name, age) -> xelem "person" (xattr "age" age <#> xtext name)) people

General

data Xml t

The type Xml t represent a piece of XML of type t, where t is usually one of Elem, Attr, or Doc.

Instances

Monoid (Xml Attr)

Monoid (Xml Elem)

AddChildren (Xml Attr)

AddChildren (Xml Elem)

AddChildren (Xml Attr, Xml Elem)

Documents

data Doc

A piece of XML at the document level.

Instances

Renderable Doc

Misc Doc

data DocInfo

The DocInfo type contains all information of an XML document except the root element.

Constructors

DocInfo

Fields

docInfo_standalone :: Bool

Value of the standalone attribute in the <?xml ... ?> header

docInfo_docType :: Maybe String

Document type (N.B.: rendering does not escape this value)

docInfo_preMisc :: Xml Doc

Content before the root element

docInfo_postMisc :: Xml Doc

Content after the root element

doc :: DocInfo -> Xml Elem -> Xml Doc

Constructs an XML document from a DocInfo value and the root element.

defaultDocInfo :: DocInfo

The default document info (standalone, without document type, without content before/after the root element).

Namespaces

data Namespace

Type for representing presence or absence of an XML namespace.

Instances

Eq Namespace

Show Namespace

MkEmptyElem Namespace

AddChildren c => MkElem Namespace c

MkAttr Namespace t

type Prefix = String

Namespace prefix.

type Uri = String

Namespace URI.

namespace :: Prefix -> Uri -> Namespace

Constructs a qualified XML namespace. The given URI must not be the empty string.

noNamespace :: Namespace

A Namespace value denoting the absence of any XML namespace information.

defaultNamespace :: Namespace

A Namespace value denoting the default namespace.

• For elements, this is the namespace currently mapped to the empty prefix.
• For attributes, the default namespace does not carry any namespace information.

Elements

data Elem

A piece of XML at the element level.

Instances

Renderable Elem

Misc Elem

Monoid (Xml Elem)

AddChildren (Xml Elem)

AddChildren (Xml Attr, Xml Elem)

class AddChildren c => MkElem n c where

Class providing methods for constructing XML elements.

The String instance of this class constructs an element in the default namespace, the Namespace instance allows customization of namespaces.

Methods

xelem :: n -> MkElemRes n c

Instances

AddChildren c => MkElem String c

AddChildren c => MkElem Namespace c

class MkEmptyElem n where

Class providing a method for constructing XML elements without children.

The String instance of this class constructs an element in the default namespace, the Namespace instance allows customization of namespaces.

Methods

xelemEmpty :: n -> MkEmptyElemRes n

Instances

MkEmptyElem String

MkEmptyElem Namespace

class AddChildren c

Class for adding children to an element.

The various instances of this class allow the addition of different kinds of children.

Instances

AddChildren ()

TextContent t => AddChildren t

AddChildren (Xml Attr)

AddChildren (Xml Elem)

AddChildren (Xml Attr, Xml Elem)

xelems :: [Xml Elem] -> Xml Elem

Merges a list of elements into a single piece of XML at the element level.

noElems :: Xml Elem

No elements at all.

xelemWithText :: TextContent t => String -> t -> Xml Elem

The expression xelemWithText n t constructs an XML element with name n and text content t.

(<>) :: Monoid t => t -> t -> t

Shortcut for the mappend functions of monoids. Used to concatenate elements, attributes and text nodes.

(<#>) :: a -> b -> (a, b)

Shortcut for coonstructing pairs. Used in combination with xelem for separating child-attributes from child-elements.

Attributes

data Attr

A piece of XML at the attribute level.

Instances

Renderable Attr

Monoid (Xml Attr)

AddChildren (Xml Attr)

AddChildren (Xml Attr, Xml Elem)

class MkAttr n t where

Class providing methods for constructing XML attributes.

The String instance of this class constructs an attribute with a name in the default namespace, the Namespace instance allows customization of namespaces.

Methods

xattr :: TextContent t => n -> MkAttrRes n t

Construct an attribute by escaping its value

xattrRaw :: RawTextContent t => n -> MkAttrRes n t

Construct an attribute without escaping its value. Note: attribute values are quoted with double quotes.

Instances

MkAttr String t

MkAttr Namespace t

xattrs :: [Xml Attr] -> Xml Attr

Merges a list of attributes into a single piece of XML at the attribute level.

noAttrs :: Xml Attr

The empty attribute list.

Text

class RawTextContent t

Construction of text content not subject to escaping.

Instances

RawTextContent String

RawTextContent Text

RawTextContent Text

RawTextContent ByteString

RawTextContent ByteString

class RawTextContent t => TextContent t

Construction of text content subject to escaping.

Instances

TextContent String

TextContent Text

TextContent Text

xtext :: TextContent t => t -> Xml Elem

Constructs a text node by escaping the given argument.

xtextRaw :: RawTextContent t => t -> Xml Elem

Constructs a text node without escaping the given argument.

xentityRef :: String -> Xml Elem

Constructs a reference to the named entity. Note: no escaping is performed on the name of the entity

Other

xempty :: Renderable t => Xml t

An empty, polymorphic piece of XML.

class Renderable t => Misc t where

Class providing methods for adding processing instructions and comments.

Methods

xprocessingInstruction :: String -> String -> Xml t

Constructs a processing instruction with the given target and content. Note: Rendering does not perform escaping on the target and the content.

xcomment :: String -> Xml t

Constructs an XML comment. Note: No escaping is performed on the text of the comment.

Instances

Misc Doc

Misc Elem

Rendering

xrender :: (Renderable r, XmlOutput t) => Xml r -> t

Renders a given piece of XML.

class XmlOutput t where

Instances of the XmlOutput class may serve as target of serializing an XML document.

Methods

fromBuilder :: Builder -> t

Creates the target type from a Builder.

Instances

XmlOutput ByteString

XmlOutput ByteString

XmlOutput Builder

class Renderable t

Any type subject to rendering must implement this type class.

Instances

Renderable Doc

Renderable Attr

Renderable Elem

XHTML documents

xhtmlFramesetDocInfo :: DocInfo

Document info for XHTML 1.0 frameset.

xhtmlStrictDocInfo :: DocInfo

Document info for XHTML 1.0 strict.

xhtmlTransitionalDocInfo :: DocInfo

Document info for XHTML 1.0 transitional.

xhtmlRootElem :: String -> Xml Elem -> Xml Elem

Constructs the root element of an XHTML document.