Safe Haskell	None
Language	Haskell2010

Text.XML.Optics

Contents

Document
- Lenses
Node
- Prisms
Element
- Lenses
- Traversals
  - Filtering elements
  - Traversing subnodes
Composing traversals
Name
- Lenses

Synopsis

data Document = Document {
- documentPrologue :: Prologue
- documentRoot :: Element
- documentEpilogue :: [Miscellaneous]
}
root :: Lens' Document Element
prologue :: Lens' Document Prologue
epilogue :: Lens' Document [Miscellaneous]
data Node
- = NodeElement Element
- | NodeInstruction Instruction
- | NodeContent Text
- | NodeComment Text
_Element :: Prism' Node Element
_Content :: Prism' Node Text
class CanbeInstruction t where
- _Instruction :: Prism' t Instruction
class CanbeComment t where
- _Comment :: Prism' t Text
data Element = Element {
- elementName :: Name
- elementAttributes :: Map Name Text
- elementNodes :: [Node]
}
attrs :: Lens' Element (Map Name Text)
nodes :: Lens' Element [Node]
name :: Lens' Element Name
el :: Name -> AffineTraversal' Element Element
named :: Text -> AffineTraversal' Element Element
attr :: Name -> AffineTraversal' Element Text
attributeSatisfies :: Name -> (Maybe Text -> Bool) -> AffineTraversal' Element Element
withoutAttribute :: Name -> AffineTraversal' Element Element
attributeIs :: Name -> Text -> AffineTraversal' Element Element
lower :: IxTraversal' Int Element Node
plate :: IxTraversal' Int Element Element
text :: IxTraversal' Int Element Text
comment :: IxTraversal' Int Element Text
(./) :: (JoinKinds k1 l m, JoinKinds k2 A_Traversal k1, AppendIndices is1 js ks, AppendIndices is2 (WithIx Int) is1) => Optic k2 is2 s t Element Element -> Optic l js Element Element a b -> Optic m ks s t a b
(.//) :: (AppendIndices is js ks, JoinKinds k1 l m, JoinKinds k2 A_Traversal k1) => Optic k2 is s t Element Element -> Optic l js Element Element a b -> Optic m ks s t a b
data Name = Name {
- nameLocalName :: Text
- nameNamespace :: Maybe Text
- namePrefix :: Maybe Text
}
localName :: Lens' Name Text
namespace :: Lens' Name (Maybe Text)
prefix :: Lens' Name (Maybe Text)

Document

data Document #

Constructors

Document
Fields documentPrologue :: Prologue documentRoot :: Element documentEpilogue :: [Miscellaneous]

Instances

Instances details

Eq Document
Instance details Defined in Text.XML Methods (==) :: Document -> Document -> Bool # (/=) :: Document -> Document -> Bool #
Data Document
Instance details Defined in Text.XML Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Document -> c Document # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Document # toConstr :: Document -> Constr # dataTypeOf :: Document -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Document) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Document) # gmapT :: (forall b. Data b => b -> b) -> Document -> Document # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Document -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Document -> r # gmapQ :: (forall d. Data d => d -> u) -> Document -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Document -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Document -> m Document # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Document -> m Document # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Document -> m Document #
Show Document
Instance details Defined in Text.XML Methods showsPrec :: Int -> Document -> ShowS # show :: Document -> String # showList :: [Document] -> ShowS #
ToMarkup Document
Instance details Defined in Text.XML Methods toMarkup :: Document -> Markup # preEscapedToMarkup :: Document -> Markup #
NFData Document
Instance details Defined in Text.XML Methods rnf :: Document -> () #

Lenses

root :: Lens' Document Element Source #

prologue :: Lens' Document Prologue Source #

epilogue :: Lens' Document [Miscellaneous] Source #

Node

data Node #

Constructors

NodeElement Element
NodeInstruction Instruction
NodeContent Text
NodeComment Text

Instances

Instances details

Eq Node
Instance details Defined in Text.XML Methods (==) :: Node -> Node -> Bool # (/=) :: Node -> Node -> Bool #
Data Node
Instance details Defined in Text.XML Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Node -> c Node # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Node # toConstr :: Node -> Constr # dataTypeOf :: Node -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Node) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Node) # gmapT :: (forall b. Data b => b -> b) -> Node -> Node # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Node -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Node -> r # gmapQ :: (forall d. Data d => d -> u) -> Node -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Node -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Node -> m Node # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Node -> m Node # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Node -> m Node #
Ord Node
Instance details Defined in Text.XML Methods compare :: Node -> Node -> Ordering # (<) :: Node -> Node -> Bool # (<=) :: Node -> Node -> Bool # (>) :: Node -> Node -> Bool # (>=) :: Node -> Node -> Bool # max :: Node -> Node -> Node # min :: Node -> Node -> Node #
Show Node
Instance details Defined in Text.XML Methods showsPrec :: Int -> Node -> ShowS # show :: Node -> String # showList :: [Node] -> ShowS #
ToMarkup Node
Instance details Defined in Text.XML Methods toMarkup :: Node -> Markup # preEscapedToMarkup :: Node -> Markup #
NFData Node
Instance details Defined in Text.XML Methods rnf :: Node -> () #
CanbeComment Node Source #
Instance details Defined in Text.XML.Optics Methods _Comment :: Prism' Node Text Source #
CanbeInstruction Node Source #
Instance details Defined in Text.XML.Optics Methods _Instruction :: Prism' Node Instruction Source #

Prisms

_Element :: Prism' Node Element Source #

_Content :: Prism' Node Text Source #

class CanbeInstruction t where Source #

Methods

_Instruction :: Prism' t Instruction Source #

Instances

Instances details

CanbeInstruction Node Source #
Instance details Defined in Text.XML.Optics Methods _Instruction :: Prism' Node Instruction Source #
CanbeInstruction Miscellaneous Source #
Instance details Defined in Text.XML.Optics Methods _Instruction :: Prism' Miscellaneous Instruction Source #

class CanbeComment t where Source #

Methods

_Comment :: Prism' t Text Source #

Instances

Instances details

CanbeComment Node Source #
Instance details Defined in Text.XML.Optics Methods _Comment :: Prism' Node Text Source #
CanbeComment Miscellaneous Source #
Instance details Defined in Text.XML.Optics Methods _Comment :: Prism' Miscellaneous Text Source #

Element

data Element #

Constructors

Element
Fields elementName :: Name elementAttributes :: Map Name Text elementNodes :: [Node]

Instances

Instances details

Eq Element
Instance details Defined in Text.XML Methods (==) :: Element -> Element -> Bool # (/=) :: Element -> Element -> Bool #
Data Element
Instance details Defined in Text.XML Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Element -> c Element # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Element # toConstr :: Element -> Constr # dataTypeOf :: Element -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Element) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Element) # gmapT :: (forall b. Data b => b -> b) -> Element -> Element # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Element -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Element -> r # gmapQ :: (forall d. Data d => d -> u) -> Element -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Element -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Element -> m Element # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Element -> m Element # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Element -> m Element #
Ord Element
Instance details Defined in Text.XML Methods compare :: Element -> Element -> Ordering # (<) :: Element -> Element -> Bool # (<=) :: Element -> Element -> Bool # (>) :: Element -> Element -> Bool # (>=) :: Element -> Element -> Bool # max :: Element -> Element -> Element # min :: Element -> Element -> Element #
Show Element
Instance details Defined in Text.XML Methods showsPrec :: Int -> Element -> ShowS # show :: Element -> String # showList :: [Element] -> ShowS #
ToMarkup Element	Note that the special element name `{http:/www.snoyman.comxml2html}ie-cond` with the single attribute `cond` is used to indicate an IE conditional comment.
Instance details Defined in Text.XML Methods toMarkup :: Element -> Markup # preEscapedToMarkup :: Element -> Markup #
NFData Element
Instance details Defined in Text.XML Methods rnf :: Element -> () #

Lenses

attrs :: Lens' Element (Map Name Text) Source #

nodes :: Lens' Element [Node] Source #

name :: Lens' Element Name Source #

Traversals

Filtering elements

el :: Name -> AffineTraversal' Element Element Source #

named :: Text -> AffineTraversal' Element Element Source #

attr :: Name -> AffineTraversal' Element Text Source #

attributeSatisfies :: Name -> (Maybe Text -> Bool) -> AffineTraversal' Element Element Source #

withoutAttribute :: Name -> AffineTraversal' Element Element Source #

attributeIs :: Name -> Text -> AffineTraversal' Element Element Source #

Traversing subnodes

lower :: IxTraversal' Int Element Node Source #

Traverse all the subnodes of an Element

plate :: IxTraversal' Int Element Element Source #

lower then select all the NodeElements

text :: IxTraversal' Int Element Text Source #

lower then select all the NodeContents

comment :: IxTraversal' Int Element Text Source #

lower then select all the NodeComments

Composing traversals

(./) :: (JoinKinds k1 l m, JoinKinds k2 A_Traversal k1, AppendIndices is1 js ks, AppendIndices is2 (WithIx Int) is1) => Optic k2 is2 s t Element Element -> Optic l js Element Element a b -> Optic m ks s t a b infixr 9 Source #

Compose two Traversal' using plate

t1 ./ t2 = t1 % plate % t2

(.//) :: (AppendIndices is js ks, JoinKinds k1 l m, JoinKinds k2 A_Traversal k1) => Optic k2 is s t Element Element -> Optic l js Element Element a b -> Optic m ks s t a b infixr 9 Source #

A version of ./ that ignores the index from plate

t1 .// t1 = t1 <% plate % t2

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

Instances details

Eq Name
Instance details Defined in Data.XML.Types Methods (==) :: Name -> Name -> Bool # (/=) :: Name -> Name -> Bool #
Data Name
Instance details Defined in Data.XML.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Name -> c Name # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Name # toConstr :: Name -> Constr # dataTypeOf :: Name -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Name) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Name) # gmapT :: (forall b. Data b => b -> b) -> Name -> Name # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Name -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Name -> r # gmapQ :: (forall d. Data d => d -> u) -> Name -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Name -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Name -> m Name # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Name -> m Name # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Name -> m Name #
Ord Name
Instance details Defined in Data.XML.Types Methods compare :: Name -> Name -> Ordering # (<) :: Name -> Name -> Bool # (<=) :: Name -> Name -> Bool # (>) :: Name -> Name -> Bool # (>=) :: Name -> Name -> Bool # max :: Name -> Name -> Name # min :: Name -> Name -> Name #
Show Name
Instance details Defined in Data.XML.Types Methods showsPrec :: Int -> Name -> ShowS # show :: Name -> String # showList :: [Name] -> ShowS #
IsString Name
Instance details Defined in Data.XML.Types Methods fromString :: String -> Name #
Generic Name
Instance details Defined in Data.XML.Types Associated Types type Rep Name :: Type -> Type # Methods from :: Name -> Rep Name x # to :: Rep Name x -> Name #
NFData Name
Instance details Defined in Data.XML.Types Methods rnf :: Name -> () #
type Rep Name
Instance details Defined in Data.XML.Types type Rep Name = D1 ('MetaData "Name" "Data.XML.Types" "xml-types-0.3.8-1FskkqwabAiJVamcx9xCWD" 'False) (C1 ('MetaCons "Name" 'PrefixI 'True) (S1 ('MetaSel ('Just "nameLocalName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "nameNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "namePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

Lenses

localName :: Lens' Name Text Source #

namespace :: Lens' Name (Maybe Text) Source #

prefix :: Lens' Name (Maybe Text) Source #