HSX.XMLGenerator

The class and monad transformer that forms the basis of the literal XML syntax translation. Literal tags will be translated into functions of the GenerateXML class, and any instantiating monads with associated XML types can benefit from that syntax.

Documentation

newtype XMLGenT m a

The monad transformer that allows a monad to generate XML values.

Constructors

XMLGenT (m a)

Instances

MonadTrans XMLGenT

Monad m => Monad (XMLGenT m)

Functor m => Functor (XMLGenT m)

MonadIO m => MonadIO (XMLGenT m)

unXMLGenT :: XMLGenT m a -> m a

un-lift.

type Name = (Maybe String, String)

class Monad m => XMLGenerator m where

Generate XML values in some XMLGenerator monad.

Associated Types

type XML m

type Child m

type Attribute m

Methods

genElement :: Name -> [XMLGenT m (Attribute m)] -> [XMLGenT m [Child m]] -> XMLGenT m (XML m)

genEElement :: Name -> [XMLGenT m (Attribute m)] -> XMLGenT m (XML m)

class EmbedAsChild a c where

Embed values as child nodes of an XML element. The parent type will be clear from the context so it is not mentioned.

Methods

asChild :: a -> c

class EmbedAsAttr a at where

Similarly embed values as attributes of an XML element.

Methods

asAttr :: a -> at

data Attr n a

Constructors

n := a

Instances

(Show n, Show a) => Show (Attr n a)

class XMLGenerator m => SetAttr m t where

Set attributes on XML elements

Methods

setAttr :: t -> XMLGenT m (Attribute m) -> XMLGenT m (XML m)

setAll :: t -> XMLGenT m [Attribute m] -> XMLGenT m (XML m)

set :: (SetAttr m t, EmbedAsAttr a (XMLGenT m (Attribute m))) => t -> a -> XMLGenT m (XML m)

(<@) :: (SetAttr m t, EmbedAsAttr a (XMLGenT m (Attribute m))) => t -> a -> XMLGenT m (XML m)

(<<@) :: (SetAttr m t, EmbedAsAttr a (XMLGenT m (Attribute m))) => t -> [a] -> XMLGenT m (XML m)

class XMLGenerator m => AppendChild m t where

Methods

appChild :: t -> XMLGenT m (Child m) -> XMLGenT m (XML m)

appAll :: t -> XMLGenT m [Child m] -> XMLGenT m (XML m)

app :: (AppendChild m t, EmbedAsChild c (XMLGenT m [Child m])) => t -> c -> XMLGenT m (XML m)

(<:) :: (AppendChild m t, EmbedAsChild c (XMLGenT m [Child m])) => t -> c -> XMLGenT m (XML m)

class Show n => IsName n where

Names can be simple or qualified with a domain. We want to conveniently use both simple strings or pairs wherever a Name is expected.

Methods

toName :: n -> Name

Instances

IsName String

Strings can represent names, meaning a simple name with no domain.

IsName Name

Names can represent names, of course.

IsName (String, String)

Pairs of strings can represent names, meaning a name qualified with a domain.

class TypeCast a b | a -> b, b -> a where

Methods

typeCast :: a -> b

Instances

TypeCast' () a b => TypeCast a b

class TypeCast' t a b | t a -> b, t b -> a where

Methods

typeCast' :: t -> a -> b

Instances

TypeCast'' t a b => TypeCast' t a b

class TypeCast'' t a b | t a -> b, t b -> a where

Methods

typeCast'' :: t -> a -> b

Instances

TypeCast'' () a a