Copyright	(c) Galois Inc. 2008 (c) Herbert Valerio Riedel 2019
License	BSD-3-Clause AND GPL-3.0-or-later
Safe Haskell	None
Language	Haskell2010

Text.XML.Cursor

Contents

Conversions
Moving around
- Searching
Node classification
Updates
- Inserting content
- Removing content

Description

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.

Synopsis

data Tag = Tag {
- tagName :: QName
- tagAttribs :: [Attr]
}
getTag :: Element -> Tag
setTag :: Tag -> Element -> Element
fromTag :: Tag -> [Content] -> Element
data Cursor = Cur {
- current :: Content
- lefts :: [Content]
- rights :: [Content]
- parents :: Path
}
type Path = [([Content], Tag, [Content])]
fromContent :: Content -> Cursor
fromElement :: Element -> Cursor
fromForest :: [Content] -> Maybe Cursor
toForest :: Cursor -> [Content]
toTree :: Cursor -> Content
parent :: Cursor -> Maybe Cursor
root :: Cursor -> Cursor
getChild :: Int -> Cursor -> Maybe Cursor
firstChild :: Cursor -> Maybe Cursor
lastChild :: Cursor -> Maybe Cursor
left :: Cursor -> Maybe Cursor
right :: Cursor -> Maybe Cursor
nextDF :: Cursor -> Maybe Cursor
findChild :: (Cursor -> Bool) -> Cursor -> Maybe Cursor
findLeft :: (Cursor -> Bool) -> Cursor -> Maybe Cursor
findRight :: (Cursor -> Bool) -> Cursor -> Maybe Cursor
findRec :: (Cursor -> Bool) -> Cursor -> Maybe Cursor
isRoot :: Cursor -> Bool
isFirst :: Cursor -> Bool
isLast :: Cursor -> Bool
isLeaf :: Cursor -> Bool
isChild :: Cursor -> Bool
hasChildren :: Cursor -> Bool
getNodeIndex :: Cursor -> Int
setContent :: Content -> Cursor -> Cursor
modifyContent :: (Content -> Content) -> Cursor -> Cursor
modifyContentM :: Monad m => (Content -> m Content) -> Cursor -> m Cursor
insertLeft :: Content -> Cursor -> Cursor
insertRight :: Content -> Cursor -> Cursor
insertGoLeft :: Content -> Cursor -> Cursor
insertGoRight :: Content -> Cursor -> Cursor
removeLeft :: Cursor -> Maybe (Content, Cursor)
removeRight :: Cursor -> Maybe (Content, Cursor)
removeGoLeft :: Cursor -> Maybe Cursor
removeGoRight :: Cursor -> Maybe Cursor
removeGoUp :: Cursor -> Maybe Cursor

Documentation

data Tag Source #

Constructors

Tag
Fields tagName :: QName tagAttribs :: [Attr]

Instances

Data Tag Source #
Instance details Defined in Text.XML.Cursor Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Tag -> c Tag # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Tag # toConstr :: Tag -> Constr # dataTypeOf :: Tag -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Tag) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Tag) # gmapT :: (forall b. Data b => b -> b) -> Tag -> Tag # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r # gmapQ :: (forall d. Data d => d -> u) -> Tag -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Tag -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Tag -> m Tag # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag #
Show Tag Source #
Instance details Defined in Text.XML.Cursor Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
Generic Tag Source #
Instance details Defined in Text.XML.Cursor Associated Types type Rep Tag :: Type -> Type # Methods from :: Tag -> Rep Tag x # to :: Rep Tag x -> Tag #
NFData Tag Source #
Instance details Defined in Text.XML.Cursor Methods rnf :: Tag -> () #
type Rep Tag Source #
Instance details Defined in Text.XML.Cursor type Rep Tag = D1 (MetaData "Tag" "Text.XML.Cursor" "X-0.1.0.0-H75dv9mzIBp4jgzgZrAGzn" False) (C1 (MetaCons "Tag" PrefixI True) (S1 (MetaSel (Just "tagName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 QName) :*: S1 (MetaSel (Just "tagAttribs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Attr])))

getTag :: Element -> Tag Source #

setTag :: Tag -> Element -> Element Source #

fromTag :: Tag -> [Content] -> Element Source #

data Cursor Source #

The position of a piece of content in an XML document.

Constructors

Cur
Fields current :: Content The currently selected content. lefts :: [Content] Siblings on the left, closest first. rights :: [Content] Siblings on the right, closest first. parents :: Path The contexts of the parent elements of this location.

Instances

Data Cursor Source #
Instance details Defined in Text.XML.Cursor Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Cursor -> c Cursor # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Cursor # toConstr :: Cursor -> Constr # dataTypeOf :: Cursor -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Cursor) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Cursor) # gmapT :: (forall b. Data b => b -> b) -> Cursor -> Cursor # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Cursor -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Cursor -> r # gmapQ :: (forall d. Data d => d -> u) -> Cursor -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Cursor -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Cursor -> m Cursor # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Cursor -> m Cursor # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Cursor -> m Cursor #
Show Cursor Source #
Instance details Defined in Text.XML.Cursor Methods showsPrec :: Int -> Cursor -> ShowS # show :: Cursor -> String # showList :: [Cursor] -> ShowS #
Generic Cursor Source #
Instance details Defined in Text.XML.Cursor Associated Types type Rep Cursor :: Type -> Type # Methods from :: Cursor -> Rep Cursor x # to :: Rep Cursor x -> Cursor #
NFData Cursor Source #
Instance details Defined in Text.XML.Cursor Methods rnf :: Cursor -> () #
type Rep Cursor Source #
Instance details Defined in Text.XML.Cursor type Rep Cursor = D1 (MetaData "Cursor" "Text.XML.Cursor" "X-0.1.0.0-H75dv9mzIBp4jgzgZrAGzn" False) (C1 (MetaCons "Cur" PrefixI True) ((S1 (MetaSel (Just "current") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Content) :: S1 (MetaSel (Just "lefts") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Content])) :: (S1 (MetaSel (Just "rights") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Content]) :*: S1 (MetaSel (Just "parents") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Path))))

type Path = [([Content], Tag, [Content])] Source #

Conversions

fromContent :: Content -> Cursor Source #

A cursor for the given content.

fromElement :: Element -> Cursor Source #

A cursor for the given element.

fromForest :: [Content] -> Maybe Cursor Source #

The location of the first tree in a forest.

toForest :: Cursor -> [Content] Source #

Computes the forest containing this location.

toTree :: Cursor -> Content Source #

Computes the tree containing this location.

Moving around

parent :: Cursor -> Maybe Cursor Source #

The parent of the given location.

root :: Cursor -> Cursor Source #

The top-most parent of the given location.

getChild :: Int -> Cursor -> Maybe Cursor Source #

The child with the given index (starting from 0).

firstChild :: Cursor -> Maybe Cursor Source #

The first child of the given location.

lastChild :: Cursor -> Maybe Cursor Source #

The last child of the given location.

left :: Cursor -> Maybe Cursor Source #

The left sibling of the given location.

right :: Cursor -> Maybe Cursor Source #

The right sibling of the given location.

nextDF :: Cursor -> Maybe Cursor Source #

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.