Safe Haskell	None
Language	Haskell2010

Text.XML.Pugi

Contents

Document
- parse
- render
Node
- getter
- setter
  - specified append/prepend child
XPath
- NodeSet
reexport

Description

parse xml

> docA <- parse def "<a />"
> docA
Right Document <a />

> parseFile def "test.xml"
Document <test >

render xml

> Data.ByteString.Lazy.Char.putStrLn $ either undefined (pretty def) docA
<?xml version="1.0"?>
<a />

> prettyFile def docA

create xml

testHtml :: IO Document
testHtml = create $ doc -> do
    decl <- appendDeclaration "xml" doc
    appendAttrs [("version", "1.0"), ("lang", "ja")] decl

    appendDoctype "html" doc

    html <- appendElement "html" doc
    body <- appendElement "body" html
    div_ <- appendElement "div"  body
    a    <- appendElement "a"    div_
    appendAttr "href" "http://example.com" a
    txt  <- appendPCData "example.com" a
    return ()

-- testHtml for copy&paste to ghci.
> doc <- create $ \doc -> appendDeclaration "xml" doc >>= \decl -> appendAttrs [("version", "1.0"), ("lang", "ja")] decl >> appendDoctype "html" doc >> appendElement "html" doc >>= \html -> appendElement "body" html >>= \body -> appendElement "div"  body >>= \div_ -> appendElement "a"    div_ >>= \a -> appendAttr "href" "http://example.com" a >> appendPCData "example.com" a >> return ()

> doc
Document <?xml version="1.0" lang="ja"?><!DOCTYPE html><html><body><div><a href="http://example.com">example.com</a></div></body></html>

access xml tree

> let Just x = child "xml" doc
> x
Node <?xml version="1.0" lang="ja"?>

> nextSibling x
Just Node <!DOCTYPE html>

> Just html = nextSiblingByName "html" x

> html
Node <html><body><div><a href="http://example.com">example.com</a></div></body></html>

> evaluate [xpath|string(//a/href)|] html
"http://example.com"

> let ns = evaluate [xpath|//a/href|] html

> nodeSetSize ns
1
> nodeSetIndex ns 0
Right ("href","http://example.com")

modify xml

modify doc $ \d -> selectSingleNode [xpath|//a|] d >>= \(Left a) -> setOrAppendAttr "href" "#" a
Document <?xml version="1.0" lang="ja"?><!DOCTYPE html><html><body><div><a href="#">example.com</a></div></body></html>

Synopsis

Document

data Document_ k m Source

Instances

MutableNodeLike Document_

type Document = Document_ Unknown Immutable Source

type MutableDocument = Document_ Unknown Mutable Source

parse

data ParseConfig Source

Constructors

ParseConfig
Fields parseFlags :: ParseFlags parseEncoding :: Encoding

Instances

Show ParseConfig
Default ParseConfig

data ParseException Source

Constructors

ParseException
Fields parseExceptionStatus :: ParseStatus parseExceptionOffset :: CLong parseExceptionEncoding :: Encoding parseExceptionDescripton :: String

Instances

Show ParseException
Exception ParseException
Typeable * ParseException

parse :: ParseConfig -> ByteString -> Either ParseException Document Source

parseFile :: ParseConfig -> FilePath -> IO Document Source

render

data PrettyConfig Source

Constructors

PrettyConfig
Fields prettyIndent :: String prettyFlags :: FormatFlags prettyEncoding :: Encoding

Instances

Show PrettyConfig
Default PrettyConfig

prettyFile :: PrettyConfig -> FilePath -> Document -> IO () Source

pretty :: PrettyConfig -> Document -> ByteString Source

Node

data Node_ k m Source

Instances

MutableNodeLike Node_

type Node = Node_ Unknown Immutable Source

type MutableNode k = Node_ k Mutable Source

data NodeKind Source

Constructors

Element	<name>children</name>
PCData	value
CData	<![CDATA[value]]>
Comment	<!--value-->
Pi	<?name value?>
Declaration	<?name?>
Doctype	<!DOCTYPE value>
Unknown

class HasName k Source

Instances

HasName Unknown
HasName Declaration
HasName Pi
HasName Element

class HasValue k Source

Instances

HasValue Unknown
HasValue Doctype
HasValue Pi
HasValue Comment
HasValue CData
HasValue PCData

class HasAttribute k Source

Instances

HasAttribute Unknown
HasAttribute Declaration
HasAttribute Element

class HasChildren k Source

Instances

HasChildren Unknown
HasChildren Element

getter

type family M m a Source

M Immutable a = a
M Mutable   a = Modify a

class NodeLike n m where Source

instance NodeLike Document_ Immutable
instance NodeLike Node_     Immutable
instance NodeLike Document_ Mutable
instance NodeLike Node_     Mutable

Minimal complete definition

asNode, nodeEqual, prettyNode, hashValue, nodeType, getName, getValue, parent, firstChild, lastChild, nextSibling, prevSibling, child, attribute, nextSiblingByName, prevSiblingByName, findChildByNameAndAttr, findChildByAttr, childValue, childValueByName, text, findAttribute, findChild, findNode, mapSibling, mapAttrs, path, firstElementByPath, root, evaluate, selectSingleNode, selectNodes

Methods

asNode :: n k m -> M m (Node_ k m) Source

nodeEqual :: n k m -> n l o -> M m Bool Source

forgetNodeKind :: n k m -> n Unknown m Source

prettyNode :: PrettyConfig -> Int -> n k m -> M m ByteString Source

hashValue :: n k m -> M m CSize Source

nodeType :: n k m -> M m NodeType Source

getName :: HasName k => n k m -> M m ByteString Source

getValue :: HasValue k => n k m -> M m ByteString Source

parent :: n k m -> M m (Maybe (Node_ Unknown m)) Source

firstChild :: HasChildren k => n k m -> M m (Maybe (Node_ Unknown m)) Source

lastChild :: HasChildren k => n k m -> M m (Maybe (Node_ Unknown m)) Source

nextSibling :: n k m -> M m (Maybe (Node_ Unknown m)) Source

prevSibling :: n k m -> M m (Maybe (Node_ Unknown m)) Source

child :: HasChildren k => ByteString -> n k m -> M m (Maybe (Node_ Unknown m)) Source

attribute :: HasAttribute k => ByteString -> n k m -> M m (Maybe ByteString) Source

nextSiblingByName :: ByteString -> n k m -> M m (Maybe (Node_ Unknown m)) Source

prevSiblingByName :: ByteString -> n k m -> M m (Maybe (Node_ Unknown m)) Source

findChildByNameAndAttr Source

Arguments

:: HasChildren k
=> ByteString	node name
-> ByteString	attribute name
-> ByteString	attribute value
-> n k m
-> M m (Maybe (Node_ Unknown m))

findChildByAttr Source

Arguments

:: HasChildren k
=> ByteString	attribute name
-> ByteString	attribute value
-> n k m
-> M m (Maybe (Node_ Unknown m))

childValue :: HasChildren k => n k m -> M m ByteString Source

childValueByName :: HasChildren k => ByteString -> n k m -> M m ByteString Source

text :: n k m -> M m ByteString Source

findAttribute :: (ByteString -> ByteString -> Bool) -> n k m -> M m (Maybe Attribute) Source

find attribute by predicate. since v0.2.0.

findChild :: (Node -> Bool) -> n k m -> M m (Maybe (Node_ Unknown m)) Source

find child by predicate. since v0.2.0.

findNode :: (Node -> Bool) -> n k m -> M m (Maybe (Node_ Unknown m)) Source

find node by predicate. since v0.2.0.

mapSibling :: (Node_ Unknown m -> a) -> n k m -> M m [a] Source

mapAttrs :: HasAttribute k => (ByteString -> ByteString -> a) -> n k m -> M m [a] Source

path :: Char -> n k m -> M m ByteString Source

firstElementByPath :: Char -> ByteString -> n k m -> M m (Maybe (Node_ Unknown m)) Source

root :: n k m -> M m (Maybe (Node_ Unknown m)) Source

evaluate :: EvalXPath r => XPath r -> n k m -> M m r Source

selectSingleNode :: XPath (NodeSet m) -> n k m -> M m (XPathNode m) Source

selectNodes :: XPath (NodeSet m) -> n k m -> M m (NodeSet m) Source

setter

data Modify a Source

Instances

Alternative Modify
Monad Modify
Functor Modify
MonadPlus Modify
Applicative Modify

create :: Monad m => (MutableDocument -> Modify ()) -> m Document Source

create document from scratch.

modify :: Monad m => Document -> (MutableDocument -> Modify ()) -> m Document Source

modify document.

class MutableNodeLike n where Source

Methods

setName :: HasName k => ByteString -> n k Mutable -> Modify () Source

setValue :: HasValue k => ByteString -> n k Mutable -> Modify () Source

appendAttr :: HasAttribute k => ByteString -> ByteString -> n k Mutable -> Modify () Source

prependAttr :: HasAttribute k => ByteString -> ByteString -> n k Mutable -> Modify () Source

setAttr :: HasAttribute k => ByteString -> ByteString -> n k Mutable -> Modify () Source

appendChild :: HasChildren k => NodeType -> n k Mutable -> Modify (MutableNode l) Source

generic appendChild method. Recommend to use appendElement etc...

prependChild :: HasChildren k => NodeType -> n k Mutable -> Modify (MutableNode l) Source

generic prependChild method. Recommend to use prependElement etc...

appendCopy :: HasChildren k => Node_ k a -> n l Mutable -> Modify (MutableNode k) Source

prependCopy :: HasChildren k => Node_ k a -> n l Mutable -> Modify (MutableNode k) Source

removeAttr :: HasAttribute k => ByteString -> n k Mutable -> Modify () Source

removeChild :: HasChildren k => Node_ k a -> n l Mutable -> Modify () Source

appendFlagment :: HasChildren k => ParseConfig -> ByteString -> n k Mutable -> Modify () Source

Instances

MutableNodeLike Node_
MutableNodeLike Document_

appendAttrs :: (MutableNodeLike n, HasAttribute k) => [Attribute] -> n k Mutable -> Modify () Source

setOrAppendAttr :: (HasAttribute k, MutableNodeLike n) => ByteString -> ByteString -> n k Mutable -> Modify () Source

specified append/prepend child

appendElement :: (HasChildren k, MutableNodeLike n) => ByteString -> n k Mutable -> Modify (MutableNode Element) Source

prependElement :: (HasChildren k, MutableNodeLike n) => ByteString -> n k Mutable -> Modify (MutableNode Element) Source

appendDeclaration :: (HasChildren k, MutableNodeLike n) => ByteString -> n k Mutable -> Modify (MutableNode Declaration) Source

prependDeclaration :: (HasChildren k, MutableNodeLike n) => ByteString -> n k Mutable -> Modify (MutableNode Declaration) Source

appendPCData :: (HasChildren k, MutableNodeLike n) => ByteString -> n k Mutable -> Modify (MutableNode PCData) Source

prependPCData :: (HasChildren k, MutableNodeLike n) => ByteString -> n k Mutable -> Modify (MutableNode PCData) Source

appendCData :: (HasChildren k, MutableNodeLike n) => ByteString -> n k Mutable -> Modify (MutableNode CData) Source

prependCData :: (HasChildren k, MutableNodeLike n) => ByteString -> n k Mutable -> Modify (MutableNode CData) Source

appendComment :: (HasChildren k, MutableNodeLike n) => ByteString -> n k Mutable -> Modify (MutableNode Comment) Source

prependComment :: (HasChildren k, MutableNodeLike n) => ByteString -> n k Mutable -> Modify (MutableNode Comment) Source

appendDoctype :: (HasChildren k, MutableNodeLike n) => ByteString -> n k Mutable -> Modify (MutableNode Doctype) Source

prependDoctype :: (HasChildren k, MutableNodeLike n) => ByteString -> n k Mutable -> Modify (MutableNode Doctype) Source

appendPi :: (HasChildren k, MutableNodeLike n) => ByteString -> ByteString -> n k Mutable -> Modify (MutableNode Pi) Source

prependPi :: (HasChildren k, MutableNodeLike n) => ByteString -> ByteString -> n k Mutable -> Modify (MutableNode Pi) Source

XPath

data XPath rt Source

class EvalXPath a Source

Minimal complete definition

evaluateXPath

Instances

EvalXPath Bool
EvalXPath Double
EvalXPath ByteString
EvalXPath (NodeSet m)

xpath :: QuasiQuoter Source

generate xpath object.

[xpath|query|] == ((xpathObject) :: XPath (instance of EvalXPath))

NodeSet

data NodeSet m Source

Instances

Show (NodeSet m)
EvalXPath (NodeSet m)

type XPathNode m = Either (Node_ Unknown m) Attribute Source

type Attribute = (ByteString, ByteString) Source

nodeSetSize :: NodeSet m -> Int Source

nodeSetIndex :: NodeSet m -> Int -> XPathNode m Source

nodeSetMapM :: (XPathNode m -> IO a) -> NodeSet m -> IO [a] Source

nodeSetMapM_ :: (XPathNode m -> IO ()) -> NodeSet m -> IO () Source

nodeSetMap :: (XPathNode m -> a) -> NodeSet m -> [a] Source

nodeSetToList :: NodeSet m -> [XPathNode m] Source

reexport

module Text.XML.Pugi.Const

def :: Default a => a

The default value for this type.