-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Optics for xml-conduit
--   
--   Optics port of xml-lens, a collection of optics for xml-conduit
@package xml-optics
@version 0.2.0

module Text.XML.Optics
data Document
Document :: Prologue -> Element -> [Miscellaneous] -> Document
[documentPrologue] :: Document -> Prologue
[documentRoot] :: Document -> Element
[documentEpilogue] :: Document -> [Miscellaneous]
root :: Lens' Document Element
prologue :: Lens' Document Prologue
epilogue :: Lens' Document [Miscellaneous]
data Node
NodeElement :: Element -> Node
NodeInstruction :: Instruction -> Node
NodeContent :: Text -> Node
NodeComment :: Text -> Node
_Element :: Prism' Node Element
_Content :: Prism' Node Text
class CanbeInstruction t
_Instruction :: CanbeInstruction t => Prism' t Instruction
class CanbeComment t
_Comment :: CanbeComment t => Prism' t Text
data Element
Element :: Name -> Map Name Text -> [Node] -> Element
[elementName] :: Element -> Name
[elementAttributes] :: Element -> Map Name Text
[elementNodes] :: Element -> [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

-- | Traverse all the subnodes of an <a>Element</a>
lower :: IxTraversal' Int Element Node

-- | <a>lower</a> then select all the <a>NodeElement</a>s
plate :: IxTraversal' Int Element Element

-- | <a>lower</a> then select all the <a>NodeContent</a>s
text :: IxTraversal' Int Element Text

-- | <a>lower</a> then select all the <a>NodeComment</a>s
comment :: IxTraversal' Int Element Text

-- | Compose two <a>Traversal'</a> using <a>plate</a>
--   
--   <pre>
--   t1 <a>./</a> t2 = t1 <a>%</a> <a>plate</a> <a>%</a> t2
--   </pre>
(./) :: (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 ./

-- | A version of <a>./</a> that ignores the index from <a>plate</a>
--   
--   <pre>
--   t1 <a>.//</a> t1 = t1 <a>&lt;%</a> <a>plate</a> <a>%</a> t2
--   </pre>
(.//) :: (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 .//

-- | A fully qualified name.
--   
--   Prefixes are not semantically important; they are included only to
--   simplify pass-through parsing. When comparing names with <a>Eq</a> or
--   <a>Ord</a> methods, prefixes are ignored.
--   
--   The <tt>IsString</tt> instance supports Clark notation; see
--   <a>http://www.jclark.com/xml/xmlns.htm</a> and
--   <a>http://infohost.nmt.edu/tcc/help/pubs/pylxml/etree-QName.html</a>.
--   Use the <tt>OverloadedStrings</tt> language extension for very simple
--   <tt>Name</tt> construction:
--   
--   <pre>
--   myname :: Name
--   myname = "{http://example.com/ns/my-namespace}my-name"
--   </pre>
data Name
Name :: Text -> Maybe Text -> Maybe Text -> Name
[nameLocalName] :: Name -> Text
[nameNamespace] :: Name -> Maybe Text
[namePrefix] :: Name -> Maybe Text
localName :: Lens' Name Text
namespace :: Lens' Name (Maybe Text)
prefix :: Lens' Name (Maybe Text)
instance Text.XML.Optics.CanbeComment Text.XML.Node
instance Text.XML.Optics.CanbeComment Data.XML.Types.Miscellaneous
instance Text.XML.Optics.CanbeInstruction Text.XML.Node
instance Text.XML.Optics.CanbeInstruction Data.XML.Types.Miscellaneous