/usr/share/doc/libghc-xml-doc/html/xml.txt is in libghc-xml-doc 1.3.12-3build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 | -- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | A simple XML library.
--
-- A simple XML library.
@package xml
@version 1.3.12
module Text.XML.Light.Types
-- | A line is an Integer
type Line = Integer
-- | XML content
data Content
Elem :: Element -> Content
Text :: CData -> Content
CRef :: String -> Content
-- | XML elements
data Element
Element :: QName -> [Attr] -> [Content] -> Maybe Line -> Element
elName :: Element -> QName
elAttribs :: Element -> [Attr]
elContent :: Element -> [Content]
elLine :: Element -> Maybe Line
-- | XML attributes
data Attr
Attr :: QName -> String -> Attr
attrKey :: Attr -> QName
attrVal :: Attr -> String
-- | XML CData
data CData
CData :: CDataKind -> String -> Maybe Line -> CData
cdVerbatim :: CData -> CDataKind
cdData :: CData -> String
cdLine :: CData -> Maybe Line
data CDataKind
-- | Ordinary character data; pretty printer escapes &, < etc.
CDataText :: CDataKind
-- | Unescaped character data; pretty printer embeds it in <![CDATA[..
CDataVerbatim :: CDataKind
-- | As-is character data; pretty printer passes it along without any
-- escaping or CDATA wrap-up.
CDataRaw :: CDataKind
-- | XML qualified names
data QName
QName :: String -> Maybe String -> Maybe String -> QName
qName :: QName -> String
qURI :: QName -> Maybe String
qPrefix :: QName -> Maybe String
-- | Blank names
blank_name :: QName
-- | Blank cdata
blank_cdata :: CData
-- | Blank elements
blank_element :: Element
instance Typeable CDataKind
instance Typeable CData
instance Typeable QName
instance Typeable Attr
instance Typeable Element
instance Typeable Content
instance Eq CDataKind
instance Show CDataKind
instance Data CDataKind
instance Show CData
instance Data CData
instance Show QName
instance Data QName
instance Eq Attr
instance Ord Attr
instance Show Attr
instance Data Attr
instance Show Element
instance Data Element
instance Show Content
instance Data Content
instance Ord QName
instance Eq QName
module Text.XML.Light.Proc
-- | Get the text value of an XML element. This function ignores non-text
-- elements, and concatenates all text elements.
strContent :: Element -> String
-- | Select only the elements from a list of XML content.
onlyElems :: [Content] -> [Element]
-- | Select only the elements from a parent.
elChildren :: Element -> [Element]
-- | Select only the text from a list of XML content.
onlyText :: [Content] -> [CData]
-- | Find all immediate children with the given name.
findChildren :: QName -> Element -> [Element]
-- | Filter all immediate children wrt a given predicate.
filterChildren :: (Element -> Bool) -> Element -> [Element]
-- | Filter all immediate children wrt a given predicate over their names.
filterChildrenName :: (QName -> Bool) -> Element -> [Element]
-- | Find an immediate child with the given name.
findChild :: QName -> Element -> Maybe Element
-- | Find an immediate child with the given name.
filterChild :: (Element -> Bool) -> Element -> Maybe Element
-- | Find an immediate child with name matching a predicate.
filterChildName :: (QName -> Bool) -> Element -> Maybe Element
-- | Find the left-most occurrence of an element matching given name.
findElement :: QName -> Element -> Maybe Element
-- | Filter the left-most occurrence of an element wrt. given predicate.
filterElement :: (Element -> Bool) -> Element -> Maybe Element
-- | Filter the left-most occurrence of an element wrt. given predicate.
filterElementName :: (QName -> Bool) -> Element -> Maybe Element
-- | Find all non-nested occurances of an element. (i.e., once we have
-- found an element, we do not search for more occurances among the
-- element's children).
findElements :: QName -> Element -> [Element]
-- | Find all non-nested occurrences of an element wrt. given predicate.
-- (i.e., once we have found an element, we do not search for more
-- occurances among the element's children).
filterElements :: (Element -> Bool) -> Element -> [Element]
-- | Find all non-nested occurences of an element wrt a predicate over
-- element names. (i.e., once we have found an element, we do not search
-- for more occurances among the element's children).
filterElementsName :: (QName -> Bool) -> Element -> [Element]
-- | Lookup the value of an attribute.
findAttr :: QName -> Element -> Maybe String
-- | Lookup attribute name from list.
lookupAttr :: QName -> [Attr] -> Maybe String
-- | Lookup the first attribute whose name satisfies the given predicate.
lookupAttrBy :: (QName -> Bool) -> [Attr] -> Maybe String
-- | Lookup the value of the first attribute whose name satisfies the given
-- predicate.
findAttrBy :: (QName -> Bool) -> Element -> Maybe String
module Text.XML.Light.Output
-- | Adds the <a>?xml?</a> header.
showTopElement :: Element -> String
showContent :: Content -> String
showElement :: Element -> String
showCData :: CData -> String
showQName :: QName -> String
showAttr :: Attr -> String
-- | Pretty printing renders XML documents faithfully, with the exception
-- that whitespace may be added/removed in non-verbatim character data.
ppTopElement :: Element -> String
-- | Pretty printing content
ppContent :: Content -> String
-- | Pretty printing elements
ppElement :: Element -> String
-- | Pretty printing renders XML documents faithfully, with the exception
-- that whitespace may be added/removed in non-verbatim character data.
ppcTopElement :: ConfigPP -> Element -> String
-- | Pretty printing content
ppcContent :: ConfigPP -> Content -> String
-- | Pretty printing elements
ppcElement :: ConfigPP -> Element -> String
data ConfigPP
-- | Default pretty orinting configutaion. * Always use abbreviate empty
-- tags.
defaultConfigPP :: ConfigPP
-- | A configuration that tries to make things pretty (possibly at the cost
-- of changing the semantics a bit through adding white space.)
prettyConfigPP :: ConfigPP
-- | The predicate specifies for which empty tags we should use XML's
-- abbreviated notation <a>/</a>. This is useful if we are working with
-- some XML-ish standards (such as certain versions of HTML) where some
-- empty tags should always be displayed in the <a>TAG</a><a>/TAG</a>
-- form.
useShortEmptyTags :: (QName -> Bool) -> ConfigPP -> ConfigPP
-- | Specify if we should use extra white-space to make document more
-- readable. WARNING: This adds additional white-space to text elements,
-- and so it may change the meaning of the document.
useExtraWhiteSpace :: Bool -> ConfigPP -> ConfigPP
tagEnd :: QName -> ShowS
-- | The XML 1.0 header
xml_header :: String
module Text.XML.Light.Lexer
class XmlSource s
uncons :: XmlSource s => s -> Maybe (Char, s)
linenumber :: XmlSource s => Integer -> s -> LString
type LChar = (Line, Char)
type LString = [LChar]
data Token
TokStart :: Line -> QName -> [Attr] -> Bool -> Token
TokEnd :: Line -> QName -> Token
TokCRef :: String -> Token
TokText :: CData -> Token
tokens :: XmlSource source => source -> [Token]
tokens' :: LString -> [Token]
special :: LChar -> LString -> [Token]
qualName :: LString -> (QName, LString)
tag :: LString -> [Token]
attribs :: LString -> ([Attr], Bool, [Token])
attrib :: LString -> (Attr, LString)
attr_val :: LString -> (String, LString)
dropSpace :: LString -> LString
-- | Match the value for an attribute. For malformed XML we do our best to
-- guess the programmer's intention.
string :: LString -> (String, LString)
break' :: (a -> Bool) -> [(b, a)] -> ([a], [(b, a)])
breakn :: (a -> Bool) -> [(b, a)] -> ([a], [(b, a)])
decode_attr :: String -> String
data Txt
TxtBit :: String -> Txt
CRefBit :: String -> Txt
decode_text :: [Char] -> [Txt]
cref_to_char :: [Char] -> Maybe Char
num_esc :: String -> Maybe Char
cvt_char :: Int -> Maybe Char
instance Show Token
instance Show Txt
instance XmlSource Text
instance XmlSource Text
instance XmlSource ByteString
instance XmlSource ByteString
instance XmlSource String
-- | Lightweight XML parsing
module Text.XML.Light.Input
-- | parseXML to a list of content chunks
parseXML :: XmlSource s => s -> [Content]
-- | parseXMLDoc, parse a XMLl document to maybe an element
parseXMLDoc :: XmlSource s => s -> Maybe Element
-- | XML cursors for working XML content withing the context of an XML
-- document. This implementation is based on the general tree zipper
-- written by Krasimir Angelov and Iavor S. Diatchki.
module Text.XML.Light.Cursor
data Tag
Tag :: QName -> [Attr] -> Maybe Line -> Tag
tagName :: Tag -> QName
tagAttribs :: Tag -> [Attr]
tagLine :: Tag -> Maybe Line
getTag :: Element -> Tag
setTag :: Tag -> Element -> Element
fromTag :: Tag -> [Content] -> Element
-- | The position of a piece of content in an XML document.
data Cursor
Cur :: Content -> [Content] -> [Content] -> Path -> Cursor
-- | The currently selected content.
current :: Cursor -> Content
-- | Siblings on the left, closest first.
lefts :: Cursor -> [Content]
-- | Siblings on the right, closest first.
rights :: Cursor -> [Content]
-- | The contexts of the parent elements of this location.
parents :: Cursor -> Path
type Path = [([Content], Tag, [Content])]
-- | A cursor for the given content.
fromContent :: Content -> Cursor
-- | A cursor for the given element.
fromElement :: Element -> Cursor
-- | The location of the first tree in a forest.
fromForest :: [Content] -> Maybe Cursor
-- | Computes the forest containing this location.
toForest :: Cursor -> [Content]
-- | Computes the tree containing this location.
toTree :: Cursor -> Content
-- | The parent of the given location.
parent :: Cursor -> Maybe Cursor
-- | The top-most parent of the given location.
root :: Cursor -> Cursor
-- | The child with the given index (starting from 0).
getChild :: Int -> Cursor -> Maybe Cursor
-- | The first child of the given location.
firstChild :: Cursor -> Maybe Cursor
-- | The last child of the given location.
lastChild :: Cursor -> Maybe Cursor
-- | The left sibling of the given location.
left :: Cursor -> Maybe Cursor
-- | The right sibling of the given location.
right :: Cursor -> Maybe Cursor
-- | The next position in a left-to-right depth-first traversal of a
-- document: either the first child, right sibling, or the right sibling
-- of a parent that has one.
nextDF :: Cursor -> Maybe Cursor
-- | The first child that satisfies a predicate.
findChild :: (Cursor -> Bool) -> Cursor -> Maybe Cursor
-- | Find the next left sibling that satisfies a predicate.
findLeft :: (Cursor -> Bool) -> Cursor -> Maybe Cursor
-- | Find the next right sibling that satisfies a predicate.
findRight :: (Cursor -> Bool) -> Cursor -> Maybe Cursor
-- | Perform a depth first search for a descendant that satisfies the given
-- predicate.
findRec :: (Cursor -> Bool) -> Cursor -> Maybe Cursor
-- | Are we at the top of the document?
isRoot :: Cursor -> Bool
-- | Are we at the left end of the the document?
isFirst :: Cursor -> Bool
-- | Are we at the right end of the document?
isLast :: Cursor -> Bool
-- | Are we at the bottom of the document?
isLeaf :: Cursor -> Bool
-- | Do we have a parent?
isChild :: Cursor -> Bool
-- | Do we have children?
hasChildren :: Cursor -> Bool
-- | Get the node index inside the sequence of children
getNodeIndex :: Cursor -> Int
-- | Change the current content.
setContent :: Content -> Cursor -> Cursor
-- | Modify the current content.
modifyContent :: (Content -> Content) -> Cursor -> Cursor
-- | Modify the current content, allowing for an effect.
modifyContentM :: Monad m => (Content -> m Content) -> Cursor -> m Cursor
-- | Insert content to the left of the current position.
insertLeft :: Content -> Cursor -> Cursor
-- | Insert content to the right of the current position.
insertRight :: Content -> Cursor -> Cursor
-- | Insert content to the left of the current position. The new content
-- becomes the current position.
insertGoLeft :: Content -> Cursor -> Cursor
-- | Insert content to the right of the current position. The new content
-- becomes the current position.
insertGoRight :: Content -> Cursor -> Cursor
-- | Remove the content on the left of the current position, if any.
removeLeft :: Cursor -> Maybe (Content, Cursor)
-- | Remove the content on the right of the current position, if any.
removeRight :: Cursor -> Maybe (Content, Cursor)
-- | Remove the current element. The new position is the one on the left.
removeGoLeft :: Cursor -> Maybe Cursor
-- | Remove the current element. The new position is the one on the right.
removeGoRight :: Cursor -> Maybe Cursor
-- | Remove the current element. The new position is the parent of the old
-- position.
removeGoUp :: Cursor -> Maybe Cursor
instance Show Tag
instance Show Cursor
-- | A lightweight XML parsing, filtering and generating library.
--
-- This module reexports functions from:
--
-- <ul>
-- <li><a>Text.XML.Light.Types</a></li>
-- <li><a>Text.XML.Light.Proc</a></li>
-- <li><a>Text.XML.Light.Input</a></li>
-- <li><a>Text.XML.Light.Output</a></li>
-- </ul>
module Text.XML.Light
-- | Add an attribute to an element.
add_attr :: Attr -> Element -> Element
-- | Add some attributes to an element.
add_attrs :: [Attr] -> Element -> Element
-- | Create an unqualified name.
unqual :: String -> QName
-- | A smart element constructor which uses the type of its argument to
-- determine what sort of element to make.
class Node t
node :: Node t => QName -> t -> Element
-- | Create node with unqualified name
unode :: Node t => String -> t -> Element
instance Node [Char]
instance Node (Attr, String)
instance Node ([Attr], String)
instance Node CData
instance Node [CData]
instance Node (Attr, CData)
instance Node ([Attr], CData)
instance Node ([Attr], [CData])
instance Node Element
instance Node [Element]
instance Node (Attr, Element)
instance Node ([Attr], Element)
instance Node ([Attr], [Element])
instance Node (Attr, Content)
instance Node ([Attr], Content)
instance Node Content
instance Node [Content]
instance Node ()
instance Node Attr
instance Node [Attr]
instance Node ([Attr], [Content])
|