Text.XML.Lens

Useful traversals inspired by XPath

Lenses, traversals for Element

data Element

Constructors

Element

Fields

elementName :: Name

elementAttributes :: Map Name Text

elementNodes :: [Node]

Instances

Eq Element

Data Element

Ord Element

Show Element

Typeable Element

ToMarkup Element

Note that the special element name {http:www.snoyman.com/xml2html}ie-cond with the single attribute cond is used to indicate an IE conditional comment.

Plated Element

NFData Element

(./) :: Plated a => Traversal s t a a -> Traversal a a u v -> Traversal s t u v

Combine two Traversals just like XPath's slash.

 
 l ./ m ≡ l . plate . m

Names

name :: Lens' Element Name

localName :: Lens' Element Text

el :: Name -> Traversal' Element Element

Traverse elements which has the specified name.

ell :: Text -> Traversal' Element Element

Traverse elements which has the specified *local* name.

Attributes

attributeIs :: Name -> Text -> Traversal' Element Element

attributeSatisfies :: Name -> (Text -> Bool) -> Traversal' Element Element

attr :: Name -> Traversal' Element Text

attribute :: Name -> Lens' Element (Maybe Text)

attrs :: Lens' Element (Map Name Text)

Contents

text :: Traversal' Element Text

Traverse all contents of the element.

comment :: Traversal' Element Text

Traverse all comments of the element.

Children

entire :: Traversal' Element Element

Traverse itself with its all children.　Rewriting subnodes of each children will break a traversal law.

nodes :: Lens' Element [Node]

Prisms for Node

data Node

Constructors

NodeElement Element

NodeInstruction Instruction

NodeContent Text

NodeComment Text

Instances

Eq Node

Data Node

Ord Node

Show Node

Typeable Node

ToMarkup Node

NFData Node

AsComment Node

AsInstruction Node

_Element :: Prism' Node Element

_Content :: Prism' Node Text

class AsInstruction t where

Methods

_Instruction :: Prism' t Instruction

Instances

AsInstruction Node

AsInstruction Miscellaneous

class AsComment t where

Methods

_Comment :: Prism' t Text

Instances

AsComment Node

AsComment Miscellaneous

Lenses for Document

data Document

Constructors

Document

Fields

documentPrologue :: Prologue

documentRoot :: Element

documentEpilogue :: [Miscellaneous]

Instances

Eq Document

Data Document

Show Document

Typeable Document

ToMarkup Document

NFData Document

root :: Lens' Document Element

The root element of the document.

prologue :: Lens' Document Prologue

epilogue :: Lens' Document [Miscellaneous]

doctype :: Lens' Prologue (Maybe Doctype)

Lenses for Name

data Name

A fully qualified name.

Prefixes are not semantically important; they are included only to simplify pass-through parsing. When comparing names with Eq or Ord methods, prefixes are ignored.

The IsString instance supports Clark notation; see http://www.jclark.com/xml/xmlns.htm and http://infohost.nmt.edu/tcc/help/pubs/pylxml/etree-QName.html. Use the OverloadedStrings language extension for very simple Name construction:

 myname :: Name
 myname = "{http://example.com/ns/my-namespace}my-name"

Constructors

Name

Fields

nameLocalName :: Text

nameNamespace :: Maybe Text

namePrefix :: Maybe Text

Instances

Eq Name

Data Name

Ord Name

Show Name

Typeable Name

IsString Name

NFData Name

_nameLocalName :: Lens' Name Text

_nameNamespace :: Lens' Name (Maybe Text)

_namePrefix :: Lens' Name (Maybe Text)

Lenses for Instruction

data Instruction

Constructors

Instruction

Fields

instructionTarget :: Text

instructionData :: Text

Instances

Eq Instruction

Data Instruction

Ord Instruction

Show Instruction

Typeable Instruction

NFData Instruction

_instructionTarget :: Lens' Instruction Text

_instructionData :: Lens' Instruction Text

Reexport

module Control.Lens