Data.Tree.NTree.Zipper.TypeDefs

hxt-9.3.1.22: A collection of tools for processing XML with Haskell.

Copyright | Copyright (C) 2010 Uwe Schmidt
License | MIT
Maintainer | Uwe Schmidt (uwe\@fh-wedel.de)
Stability | stable
Portability | portable
Safe Haskell | Safe-Inferred
Language | Haskell2010

Data.Tree.NTree.Zipper.TypeDefs

Contents

- Orphan instances

Description

Implementation of navigateble trees for rose trees. The implementation is done with zippers. A description and introductory tutorial about zippers can be found in http://learnyouahaskell.com/zippers

Synopsis

- data NTZipper a = NTZ {
  - ntree :: NTree a
  - context :: NTBreadCrumbs a
  }
- type NTBreadCrumbs a = [NTCrumb a]
- data NTCrumb a = NTC (NTrees a) a (NTrees a)
- toNTZipper :: NTree a -> NTZipper a
- fromNTZipper :: NTZipper a -> NTree a
- up :: NTZipper a -> Maybe (NTZipper a)
- down :: NTZipper a -> Maybe (NTZipper a)
- toTheRight :: NTZipper a -> Maybe (NTZipper a)
- toTheLeft :: NTZipper a -> Maybe (NTZipper a)
- addToTheLeft :: NTree a -> NTZipper a -> Maybe (NTZipper a)
- addToTheRight :: NTree a -> NTZipper a -> Maybe (NTZipper a)
- dropFromTheLeft :: NTZipper a -> Maybe (NTZipper a)
- dropFromTheRight :: NTZipper a -> Maybe (NTZipper a)
- isTop :: NTZipper a -> Bool
- up1 :: NTree a -> NTCrumb a -> NTree a

# Documentation

data NTZipper a #

Zipper for rose trees

A zipper consist of the current tree and the branches on the way back to the root

Constructors

NTZ |
Fields ntree :: NTree a context :: NTBreadCrumbs a

#### Instances

Instances details

Functor NTZipper # |
Instance details Defined in Data.Tree.NTree.Zipper.TypeDefs Methods fmap :: (a -> b) -> NTZipper a -> NTZipper b # (<$) :: a -> NTZipper b -> NTZipper a #
Tree NTZipper # |
Instance details Defined in Data.Tree.NTree.Zipper.TypeDefs Methods mkTree :: a -> [NTZipper a] -> NTZipper a # mkLeaf :: a -> NTZipper a # isLeaf :: NTZipper a -> Bool # isInner :: NTZipper a -> Bool # getNode :: NTZipper a -> a # getChildren :: NTZipper a -> [NTZipper a] # changeNode :: (a -> a) -> NTZipper a -> NTZipper a # changeChildren :: ([NTZipper a] -> [NTZipper a]) -> NTZipper a -> NTZipper a # setNode :: a -> NTZipper a -> NTZipper a # setChildren :: [NTZipper a] -> NTZipper a -> NTZipper a # foldTree :: (a -> [b] -> b) -> NTZipper a -> b # nodesTree :: NTZipper a -> [a] # depthTree :: NTZipper a -> Int # cardTree :: NTZipper a -> Int # formatTree :: (a -> String) -> NTZipper a -> String #
NavigatableTree NTZipper # |
Instance details Defined in Data.Tree.NTree.Zipper.TypeDefs Methods mvUp :: NTZipper a -> Maybe (NTZipper a) # mvDown :: NTZipper a -> Maybe (NTZipper a) # mvLeft :: NTZipper a -> Maybe (NTZipper a) # mvRight :: NTZipper a -> Maybe (NTZipper a) #
NavigatableTreeModify NTZipper NTree # |
Instance details Defined in Data.Tree.NTree.Zipper.TypeDefs Methods addTreeLeft :: NTree a -> NTZipper a -> Maybe (NTZipper a) # addTreeRight :: NTree a -> NTZipper a -> Maybe (NTZipper a) # dropTreeLeft :: NTZipper a -> Maybe (NTZipper a) # dropTreeRight :: NTZipper a -> Maybe (NTZipper a) # substThisTree :: NTree a -> NTZipper a -> NTZipper a #
NavigatableTreeToTree NTZipper NTree # |
Instance details Defined in Data.Tree.NTree.Zipper.TypeDefs Methods fromTree :: NTree a -> NTZipper a # toTree :: NTZipper a -> NTree a #
Show a => Show (NTZipper a) # |
Instance details Defined in Data.Tree.NTree.Zipper.TypeDefs Methods showsPrec :: Int -> NTZipper a -> ShowS # show :: NTZipper a -> String # showList :: [NTZipper a] -> ShowS #

type NTBreadCrumbs a = [NTCrumb a] #

The list of unzipped nodes from a current tree back to the root

data NTCrumb a #

One unzipped step consists of the left siblings, the node info and the right siblings

Constructors

NTC (NTrees a) a (NTrees a) |

#### Instances

Instances details

Functor NTCrumb # |
Instance details Defined in Data.Tree.NTree.Zipper.TypeDefs Methods fmap :: (a -> b) -> NTCrumb a -> NTCrumb b # (<$) :: a -> NTCrumb b -> NTCrumb a #
Show a => Show (NTCrumb a) # |
Instance details Defined in Data.Tree.NTree.Zipper.TypeDefs Methods showsPrec :: Int -> NTCrumb a -> ShowS # show :: NTCrumb a -> String # showList :: [NTCrumb a] -> ShowS #

toNTZipper :: NTree a -> NTZipper a #

Conversion of a rose tree into a navigatable rose tree

fromNTZipper :: NTZipper a -> NTree a #

Conversion of a navigatable rose tree into an ordinary rose tree.

The context, the parts for moving up to the root are just removed from the tree. So when transforming a navigatable tree by moving around and by changing some nodes, one has to navigate back to the root, else that parts are removed from the result

up :: NTZipper a -> Maybe (NTZipper a) #

down :: NTZipper a -> Maybe (NTZipper a) #

toTheRight :: NTZipper a -> Maybe (NTZipper a) #

toTheLeft :: NTZipper a -> Maybe (NTZipper a) #

addToTheLeft :: NTree a -> NTZipper a -> Maybe (NTZipper a) #

addToTheRight :: NTree a -> NTZipper a -> Maybe (NTZipper a) #

dropFromTheLeft :: NTZipper a -> Maybe (NTZipper a) #

dropFromTheRight :: NTZipper a -> Maybe (NTZipper a) #

isTop :: NTZipper a -> Bool #

up1 :: NTree a -> NTCrumb a -> NTree a #

# Orphan instances

NavigatableTreeModify NTZipper NTree # |
Instance details Methods addTreeLeft :: NTree a -> NTZipper a -> Maybe (NTZipper a) # addTreeRight :: NTree a -> NTZipper a -> Maybe (NTZipper a) # dropTreeLeft :: NTZipper a -> Maybe (NTZipper a) # dropTreeRight :: NTZipper a -> Maybe (NTZipper a) # substThisTree :: NTree a -> NTZipper a -> NTZipper a #
NavigatableTreeToTree NTZipper NTree # |
Instance details Methods fromTree :: NTree a -> NTZipper a # toTree :: NTZipper a -> NTree a #