Maintainer	bastiaan.heeren@ou.nl
Stability	provisional
Portability	portable (depends on ghc)
Safe Haskell	None
Language	Haskell98

Ideas.Text.XML

Contents

XML types
Parsing XML
Building/constructing XML
Pretty-printing XML
Simple decoding queries
Decoding XML
Type classes for converting to/from XML
Processing XML
Deprecated functions

Description

Collection of common operation on XML documents

Synopsis

data XML
type Name = String
type Attributes = [Attribute]
data Attribute = Name := String
parseXML :: String -> Either String XML
parseXMLFile :: FilePath -> IO XML
class (Semigroup a, Monoid a) => BuildXML a where
data XMLBuilder
makeXML :: String -> XMLBuilder -> XML
prettyXML :: XML -> String
compactXML :: XML -> String
name :: XML -> Name
attributes :: XML -> Attributes
findAttribute :: Monad m => String -> XML -> m String
children :: XML -> [XML]
findChildren :: String -> XML -> [XML]
findChild :: Monad m => String -> XML -> m XML
getData :: XML -> String
expecting :: Monad m => String -> XML -> m ()
decodeData :: Decoder env XML String
decodeAttribute :: String -> Decoder env XML String
decodeChild :: Name -> Decoder env XML a -> Decoder env XML a
decodeFirstChild :: Name -> Decoder env XML a -> Decoder env XML a
class ToXML a where
builderXML :: (ToXML a, BuildXML b) => a -> b
class ToXML a => InXML a where
foldXML :: (Name -> [a] -> [Either s e] -> e) -> (Attribute -> a) -> (String -> s) -> XML -> e
trimXML :: XML -> XML
content :: XML -> [Either String XML]
emptyContent :: XML -> Bool
fromBuilder :: XMLBuilder -> Maybe XML

XML types

data XML Source #

Instances

Eq XML Source #
Instance details Defined in Ideas.Text.XML Methods (==) :: XML -> XML -> Bool # (/=) :: XML -> XML -> Bool #
Show XML Source #
Instance details Defined in Ideas.Text.XML Methods showsPrec :: Int -> XML -> ShowS # show :: XML -> String # showList :: [XML] -> ShowS #

type Name = String Source #

type Attributes = [Attribute] Source #

data Attribute Source #

Constructors

Name := String

Instances

Eq Attribute Source #
Instance details Defined in Ideas.Text.XML Methods (==) :: Attribute -> Attribute -> Bool # (/=) :: Attribute -> Attribute -> Bool #

Parsing XML

parseXML :: String -> Either String XML Source #

parseXMLFile :: FilePath -> IO XML Source #

Building/constructing XML

class (Semigroup a, Monoid a) => BuildXML a where Source #

Minimal complete definition

(.=.), string, builder, tag

Methods

(.=.) :: String -> String -> a infix 7 Source #

string :: String -> a Source #

builder :: XML -> a Source #

tag :: String -> a -> a Source #

char :: Char -> a Source #

text :: Show s => s -> a Source #

element :: String -> [a] -> a Source #

emptyTag :: String -> a Source #

Instances

BuildXML XMLBuilder Source #
Instance details Defined in Ideas.Text.XML Methods (.=.) :: String -> String -> XMLBuilder Source # string :: String -> XMLBuilder Source # builder :: XML -> XMLBuilder Source # tag :: String -> XMLBuilder -> XMLBuilder Source # char :: Char -> XMLBuilder Source # text :: Show s => s -> XMLBuilder Source # element :: String -> [XMLBuilder] -> XMLBuilder Source # emptyTag :: String -> XMLBuilder Source #
BuildXML a => BuildXML (Decoder env s a) Source #
Instance details Defined in Ideas.Text.XML Methods (.=.) :: String -> String -> Decoder env s a Source # string :: String -> Decoder env s a Source # builder :: XML -> Decoder env s a Source # tag :: String -> Decoder env s a -> Decoder env s a Source # char :: Char -> Decoder env s a Source # text :: Show s0 => s0 -> Decoder env s a Source # element :: String -> [Decoder env s a] -> Decoder env s a Source # emptyTag :: String -> Decoder env s a Source #

data XMLBuilder Source #

Instances

IsString XMLBuilder Source #
Instance details Defined in Ideas.Text.XML Methods fromString :: String -> XMLBuilder #
Semigroup XMLBuilder Source #
Instance details Defined in Ideas.Text.XML Methods (<>) :: XMLBuilder -> XMLBuilder -> XMLBuilder # sconcat :: NonEmpty XMLBuilder -> XMLBuilder # stimes :: Integral b => b -> XMLBuilder -> XMLBuilder #
Monoid XMLBuilder Source #
Instance details Defined in Ideas.Text.XML Methods mempty :: XMLBuilder # mappend :: XMLBuilder -> XMLBuilder -> XMLBuilder # mconcat :: [XMLBuilder] -> XMLBuilder #
BuildXML XMLBuilder Source #
Instance details Defined in Ideas.Text.XML Methods (.=.) :: String -> String -> XMLBuilder Source # string :: String -> XMLBuilder Source # builder :: XML -> XMLBuilder Source # tag :: String -> XMLBuilder -> XMLBuilder Source # char :: Char -> XMLBuilder Source # text :: Show s => s -> XMLBuilder Source # element :: String -> [XMLBuilder] -> XMLBuilder Source # emptyTag :: String -> XMLBuilder Source #

makeXML :: String -> XMLBuilder -> XML Source #

Pretty-printing XML

prettyXML :: XML -> String Source #

compactXML :: XML -> String Source #

Simple decoding queries

name :: XML -> Name Source #

attributes :: XML -> Attributes Source #

findAttribute :: Monad m => String -> XML -> m String Source #

children :: XML -> [XML] Source #

findChildren :: String -> XML -> [XML] Source #

findChild :: Monad m => String -> XML -> m XML Source #

getData :: XML -> String Source #

expecting :: Monad m => String -> XML -> m () Source #

Decoding XML

decodeData :: Decoder env XML String Source #

decodeAttribute :: String -> Decoder env XML String Source #

decodeChild :: Name -> Decoder env XML a -> Decoder env XML a Source #

decodeFirstChild :: Name -> Decoder env XML a -> Decoder env XML a Source #

Type classes for converting to/from XML

class ToXML a where Source #

Minimal complete definition

toXML

Methods

toXML :: a -> XML Source #

listToXML :: [a] -> XML Source #

Instances

ToXML () Source #
Instance details Defined in Ideas.Text.XML Methods toXML :: () -> XML Source # listToXML :: [()] -> XML Source #
ToXML OMOBJ Source #
Instance details Defined in Ideas.Text.OpenMath.Object Methods toXML :: OMOBJ -> XML Source # listToXML :: [OMOBJ] -> XML Source #
ToXML HTMLPage Source #
Instance details Defined in Ideas.Text.HTML Methods toXML :: HTMLPage -> XML Source # listToXML :: [HTMLPage] -> XML Source #
ToXML MathML Source #
Instance details Defined in Ideas.Text.MathML Methods toXML :: MathML -> XML Source # listToXML :: [MathML] -> XML Source #
ToXML a => ToXML (Maybe a) Source #
Instance details Defined in Ideas.Text.XML Methods toXML :: Maybe a -> XML Source # listToXML :: [Maybe a] -> XML Source #

builderXML :: (ToXML a, BuildXML b) => a -> b Source #

class ToXML a => InXML a where Source #

Minimal complete definition

fromXML

Methods

fromXML :: Monad m => XML -> m a Source #

listFromXML :: Monad m => XML -> m [a] Source #

Instances

InXML OMOBJ Source #
Instance details Defined in Ideas.Text.OpenMath.Object Methods fromXML :: Monad m => XML -> m OMOBJ Source # listFromXML :: Monad m => XML -> m [OMOBJ] Source #
InXML MathML Source #
Instance details Defined in Ideas.Text.MathML Methods fromXML :: Monad m => XML -> m MathML Source # listFromXML :: Monad m => XML -> m [MathML] Source #

Processing XML

foldXML :: (Name -> [a] -> [Either s e] -> e) -> (Attribute -> a) -> (String -> s) -> XML -> e Source #

trimXML :: XML -> XML Source #

Deprecated functions

content :: XML -> [Either String XML] Source #

emptyContent :: XML -> Bool Source #

fromBuilder :: XMLBuilder -> Maybe XML Source #