Copyright | (c) Niklas Broberg 2008-2013 |
---|---|
License | BSD-style (see the file LICENSE.txt) |
Maintainer | Niklas Broberg <niklas.broberg@gmail.com> |
Stability | experimental |
Portability | requires newtype deriving and MPTCs with fundeps and type families |
Safe Haskell | None |
Language | Haskell98 |
HSP.XMLGenerator
Description
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.
Synopsis
- newtype XMLGenT m a = XMLGenT (m a)
- unXMLGenT :: XMLGenT m a -> m a
- mapXMLGenT :: (m a -> n b) -> XMLGenT m a -> XMLGenT n b
- type Name a = (Maybe a, a)
- class Monad m => XMLGen m where
- type XMLType m
- type StringType m
- data ChildType m
- data AttributeType m
- genElement :: Name (StringType m) -> [XMLGenT m [AttributeType m]] -> [XMLGenT m [ChildType m]] -> XMLGenT m (XMLType m)
- genEElement :: Name (StringType m) -> [XMLGenT m [AttributeType m]] -> XMLGenT m (XMLType m)
- xmlToChild :: XMLType m -> ChildType m
- pcdataToChild :: StringType m -> ChildType m
- type GenXML m = XMLGenT m (XMLType m)
- type GenXMLList m = XMLGenT m [XMLType m]
- type GenChild m = XMLGenT m (ChildType m)
- type GenChildList m = XMLGenT m [ChildType m]
- type GenAttribute m = XMLGenT m (AttributeType m)
- type GenAttributeList m = XMLGenT m [AttributeType m]
- class XMLGen m => EmbedAsChild m c where
- asChild :: c -> GenChildList m
- data Attr n a = n := a
- class XMLGen m => EmbedAsAttr m a where
- asAttr :: a -> GenAttributeList m
- class (XMLGen m, SetAttr m (XMLType m), AppendChild m (XMLType m), EmbedAsChild m (XMLType m), EmbedAsChild m [XMLType m], EmbedAsChild m Text, EmbedAsChild m Char, EmbedAsChild m (), EmbedAsAttr m (Attr Text Text), EmbedAsAttr m (Attr Text Int), EmbedAsAttr m (Attr Text Bool)) => XMLGenerator m
- class XMLGen m => SetAttr m elem where
- setAttr :: elem -> GenAttribute m -> GenXML m
- setAll :: elem -> GenAttributeList m -> GenXML m
- (<@) :: (SetAttr m elem, EmbedAsAttr m attr) => elem -> attr -> GenXML m
- set :: (SetAttr m elem, EmbedAsAttr m attr) => elem -> attr -> GenXML m
- (<<@) :: (SetAttr m elem, EmbedAsAttr m attr) => elem -> [attr] -> GenXML m
- class XMLGen m => AppendChild m elem where
- (<:) :: (AppendChild m elem, EmbedAsChild m c) => elem -> c -> GenXML m
- app :: (AppendChild m elem, EmbedAsChild m c) => elem -> c -> GenXML m
- (<<:) :: (AppendChild m elem, EmbedAsChild m c) => elem -> [c] -> GenXML m
- class Show n => IsName n s where
- class TypeCast a b | a -> b, b -> a where
- typeCast :: a -> b
- class TypeCast' t a b | t a -> b, t b -> a where
- typeCast' :: t -> a -> b
- class TypeCast'' t a b | t a -> b, t b -> a where
- typeCast'' :: t -> a -> b
- class TypeCastM ma mb | ma -> mb, mb -> ma where
- typeCastM :: ma x -> mb x
- class TypeCastM' t ma mb | t ma -> mb, t mb -> ma where
- typeCastM' :: t -> ma x -> mb x
- class TypeCastM'' t ma mb | t ma -> mb, t mb -> ma where
- typeCastM'' :: t -> ma x -> mb x
Documentation
The monad transformer that allows a monad to generate XML values.
Constructors
XMLGenT (m a) |
Instances
mapXMLGenT :: (m a -> n b) -> XMLGenT m a -> XMLGenT n b #
map the inner monad
class Monad m => XMLGen m where #
Generate XML values in some XMLGenerator monad.
Minimal complete definition
Methods
genElement :: Name (StringType m) -> [XMLGenT m [AttributeType m]] -> [XMLGenT m [ChildType m]] -> XMLGenT m (XMLType m) #
genEElement :: Name (StringType m) -> [XMLGenT m [AttributeType m]] -> XMLGenT m (XMLType m) #
xmlToChild :: XMLType m -> ChildType m #
pcdataToChild :: StringType m -> ChildType m #
Instances
(Functor m, Monad m) => XMLGen (HSPT XML m) # | |
Defined in HSP.Monad Methods genElement :: Name (StringType (HSPT XML m)) -> [XMLGenT (HSPT XML m) [AttributeType (HSPT XML m)]] -> [XMLGenT (HSPT XML m) [ChildType (HSPT XML m)]] -> XMLGenT (HSPT XML m) (XMLType (HSPT XML m)) # genEElement :: Name (StringType (HSPT XML m)) -> [XMLGenT (HSPT XML m) [AttributeType (HSPT XML m)]] -> XMLGenT (HSPT XML m) (XMLType (HSPT XML m)) # xmlToChild :: XMLType (HSPT XML m) -> ChildType (HSPT XML m) # pcdataToChild :: StringType (HSPT XML m) -> ChildType (HSPT XML m) # |
type GenXMLList m = XMLGenT m [XMLType m] #
type GenChildList m = XMLGenT m [ChildType m] #
type GenAttribute m = XMLGenT m (AttributeType m) #
type GenAttributeList m = XMLGenT m [AttributeType m] #
class XMLGen m => EmbedAsChild m 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 :: c -> GenChildList m #
Instances
XMLGen m => EmbedAsChild m () # | |
Defined in HSP.XMLGenerator Methods asChild :: () -> GenChildList m # | |
(XMLGen m, XMLType m ~ x) => EmbedAsChild m x # | |
Defined in HSP.XMLGenerator Methods asChild :: x -> GenChildList m # | |
XMLGen m => EmbedAsChild m (ChildType m) # | |
Defined in HSP.XMLGenerator Methods asChild :: ChildType m -> GenChildList m # | |
EmbedAsChild m c => EmbedAsChild m [c] # | |
Defined in HSP.XMLGenerator Methods asChild :: [c] -> GenChildList m # | |
(EmbedAsChild m c, m ~ n) => EmbedAsChild m (XMLGenT n c) # | |
Defined in HSP.XMLGenerator Methods asChild :: XMLGenT n c -> GenChildList m # | |
(Functor m, Monad m) => EmbedAsChild (HSPT XML m) () # | |
(Functor m, Monad m) => EmbedAsChild (HSPT XML m) Char # | |
(Functor m, Monad m) => EmbedAsChild (HSPT XML m) Text # | |
(Functor m, Monad m) => EmbedAsChild (HSPT XML m) Text # | |
(Functor m, Monad m) => EmbedAsChild (HSPT XML m) String # | |
(Functor m, Monad m) => EmbedAsChild (HSPT XML m) XML # | |
(Functor m, Monad m) => EmbedAsChild (HSPT XML m) [XML] # | |
Constructors
n := a |
Instances
class XMLGen m => EmbedAsAttr m a where #
Similarly embed values as attributes of an XML element.
Methods
asAttr :: a -> GenAttributeList m #
Instances
class (XMLGen m, SetAttr m (XMLType m), AppendChild m (XMLType m), EmbedAsChild m (XMLType m), EmbedAsChild m [XMLType m], EmbedAsChild m Text, EmbedAsChild m Char, EmbedAsChild m (), EmbedAsAttr m (Attr Text Text), EmbedAsAttr m (Attr Text Int), EmbedAsAttr m (Attr Text Bool)) => XMLGenerator m #
class XMLGen m => SetAttr m elem where #
Set attributes on XML elements
Minimal complete definition
Methods
setAttr :: elem -> GenAttribute m -> GenXML m #
setAll :: elem -> GenAttributeList m -> GenXML m #
(<@) :: (SetAttr m elem, EmbedAsAttr m attr) => elem -> attr -> GenXML m #
prepend attr
to the list of attributes for the elem
set :: (SetAttr m elem, EmbedAsAttr m attr) => elem -> attr -> GenXML m #
prepend attr
to the list of attributes for the elem
(<<@) :: (SetAttr m elem, EmbedAsAttr m attr) => elem -> [attr] -> GenXML m #
prepend the list of attr
to the attributes for the elem
class XMLGen m => AppendChild m elem where #
Minimal complete definition
Instances
(AppendChild m x, TypeCastM m1 m) => AppendChild m (XMLGenT m1 x) # | |
(Functor m, Monad m) => AppendChild (HSPT XML m) XML # | |
(<:) :: (AppendChild m elem, EmbedAsChild m c) => elem -> c -> GenXML m #
append child to the children of elem
app :: (AppendChild m elem, EmbedAsChild m c) => elem -> c -> GenXML m #
append child to the children of elem
(<<:) :: (AppendChild m elem, EmbedAsChild m c) => elem -> [c] -> GenXML m #
append children to the children of elem
class Show n => IsName n s 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.
Instances
IsName String String # | Strings can represent names, meaning a simple name with no domain. |
IsName String Text # | Strings can represent names, meaning a simple name with no domain. |
IsName Text Text # | Strings can represent names, meaning a simple name with no domain. |
IsName Text Text # | strings can represent names, meaning a simple name with no domain. |
Show a => IsName (Name a) a # | Names can represent names, of course. |
Defined in HSP.XMLGenerator | |
IsName (String, String) Text # | Pairs of strings can represent names, meaning a name qualified with a domain. |
IsName (Text, Text) Text # | Pairs of strings can represent names, meaning a name qualified with a domain. |
IsName (Text, Text) Text # | Pairs of strings can represent names, meaning a name qualified with a domain. |
class TypeCast' t a b | t a -> b, t b -> a where #
Instances
TypeCast'' t a b => TypeCast' t a b # | |
Defined in HSP.XMLGenerator |
class TypeCast'' t a b | t a -> b, t b -> a where #
Methods
typeCast'' :: t -> a -> b #
Instances
TypeCast'' () a a # | |
Defined in HSP.XMLGenerator Methods typeCast'' :: () -> a -> a # |
class TypeCastM ma mb | ma -> mb, mb -> ma where #
Instances
TypeCastM' () ma mb => TypeCastM ma mb # | |
Defined in HSP.XMLGenerator |
class TypeCastM' t ma mb | t ma -> mb, t mb -> ma where #
Methods
typeCastM' :: t -> ma x -> mb x #
Instances
TypeCastM'' t ma mb => TypeCastM' t ma mb # | |
Defined in HSP.XMLGenerator Methods typeCastM' :: t -> ma x -> mb x # |
class TypeCastM'' t ma mb | t ma -> mb, t mb -> ma where #
Methods
typeCastM'' :: t -> ma x -> mb x #
Instances
TypeCastM'' () ma ma # | |
Defined in HSP.XMLGenerator Methods typeCastM'' :: () -> ma x -> ma x # |