rosezipper-0.2: Generic zipper implementation for Data.Tree
Safe HaskellSafe-Inferred
LanguageHaskell98

Data.Tree.Zipper

Synopsis

Documentation

data TreePos (t :: Type -> Type) a Source #

A position within a Tree. The parameter t inidcates if the position is pointing to a specific tree (if t is Full), or if it is pointing in-between trees (if t is Empty).

Instances

Instances details
(Read a, Read (t a)) => Read (TreePos t a) Source # 
Instance details

Defined in Data.Tree.Zipper

Methods

readsPrec :: Int -> ReadS (TreePos t a)

readList :: ReadS [TreePos t a]

readPrec :: ReadPrec (TreePos t a)

readListPrec :: ReadPrec [TreePos t a]

(Show a, Show (t a)) => Show (TreePos t a) Source # 
Instance details

Defined in Data.Tree.Zipper

Methods

showsPrec :: Int -> TreePos t a -> ShowS

show :: TreePos t a -> String

showList :: [TreePos t a] -> ShowS

(Eq a, Eq (t a)) => Eq (TreePos t a) Source # 
Instance details

Defined in Data.Tree.Zipper

Methods

(==) :: TreePos t a -> TreePos t a -> Bool

(/=) :: TreePos t a -> TreePos t a -> Bool

class PosType (t :: Type -> Type) Source #

Positions may be either Full or Empty.

Minimal complete definition

_prev, _next, _forest

Instances

Instances details
PosType Empty Source # 
Instance details

Defined in Data.Tree.Zipper

Methods

_prev :: TreePos Empty a -> Maybe (TreePos Empty a)

_next :: TreePos Empty a -> Maybe (TreePos Empty a)

_forest :: TreePos Empty a -> Forest a

PosType Full Source # 
Instance details

Defined in Data.Tree.Zipper

Methods

_prev :: TreePos Full a -> Maybe (TreePos Full a)

_next :: TreePos Full a -> Maybe (TreePos Full a)

_forest :: TreePos Full a -> Forest a

data Empty a Source #

Position which does not point to a tree (e.g., it is between two trees).

Instances

Instances details
PosType Empty Source # 
Instance details

Defined in Data.Tree.Zipper

Methods

_prev :: TreePos Empty a -> Maybe (TreePos Empty a)

_next :: TreePos Empty a -> Maybe (TreePos Empty a)

_forest :: TreePos Empty a -> Forest a

Read (Empty a) Source # 
Instance details

Defined in Data.Tree.Zipper

Methods

readsPrec :: Int -> ReadS (Empty a)

readList :: ReadS [Empty a]

readPrec :: ReadPrec (Empty a)

readListPrec :: ReadPrec [Empty a]

Show (Empty a) Source # 
Instance details

Defined in Data.Tree.Zipper

Methods

showsPrec :: Int -> Empty a -> ShowS

show :: Empty a -> String

showList :: [Empty a] -> ShowS

Eq (Empty a) Source # 
Instance details

Defined in Data.Tree.Zipper

Methods

(==) :: Empty a -> Empty a -> Bool

(/=) :: Empty a -> Empty a -> Bool

data Full a Source #

Position which points to a tree.

Instances

Instances details
PosType Full Source # 
Instance details

Defined in Data.Tree.Zipper

Methods

_prev :: TreePos Full a -> Maybe (TreePos Full a)

_next :: TreePos Full a -> Maybe (TreePos Full a)

_forest :: TreePos Full a -> Forest a

Read a => Read (Full a) Source # 
Instance details

Defined in Data.Tree.Zipper

Methods

readsPrec :: Int -> ReadS (Full a)

readList :: ReadS [Full a]

readPrec :: ReadPrec (Full a)

readListPrec :: ReadPrec [Full a]

Show a => Show (Full a) Source # 
Instance details

Defined in Data.Tree.Zipper

Methods

showsPrec :: Int -> Full a -> ShowS

show :: Full a -> String

showList :: [Full a] -> ShowS

Eq a => Eq (Full a) Source # 
Instance details

Defined in Data.Tree.Zipper

Methods

(==) :: Full a -> Full a -> Bool

(/=) :: Full a -> Full a -> Bool

Context

before :: forall (t :: Type -> Type) a. PosType t => TreePos t a -> Forest a Source #

Siblings before this position, closest first.

after :: forall (t :: Type -> Type) a. PosType t => TreePos t a -> Forest a Source #

Siblings after this position, closest first.

forest :: forall (t :: Type -> Type) a. PosType t => TreePos t a -> Forest a Source #

All trees at this location (i.e., the current tree---if any---and its siblings).

tree :: TreePos Full a -> Tree a Source #

The selected tree.

label :: TreePos Full a -> a Source #

The current label.

parents :: forall (t :: Type -> Type) a. PosType t => TreePos t a -> [(Forest a, a, Forest a)] Source #

The contexts of the parents for this position.

Conversions

fromTree :: Tree a -> TreePos Full a Source #

A location corresponding to the root of the given tree.

fromForest :: Forest a -> TreePos Empty a Source #

The location at the beginning of the forest.

toForest :: forall (t :: Type -> Type) a. PosType t => TreePos t a -> Forest a Source #

The forest containing this location.

toTree :: TreePos Full a -> Tree a Source #

The tree containing this location.

Moving around

parent :: forall (t :: Type -> Type) a. PosType t => TreePos t a -> Maybe (TreePos Full a) Source #

The parent of the given location.

root :: TreePos Full a -> TreePos Full a Source #

The top-most parent of the given location.

prevSpace :: TreePos Full a -> TreePos Empty a Source #

The space immediately before this location.

prevTree :: TreePos Empty a -> Maybe (TreePos Full a) Source #

The tree before this location, if any.

prev :: forall (t :: Type -> Type) a. PosType t => TreePos t a -> Maybe (TreePos t a) Source #

The sibling before this location.

first :: TreePos Empty a -> TreePos Empty a Source #

The first space in the current forest.

spaceAt :: Int -> TreePos Empty a -> TreePos Empty a Source #

The empty space at the given index. The first space is at index 0. For indexes that are negative or too large, we return the first and last position in the tree, respectively.

nextSpace :: TreePos Full a -> TreePos Empty a Source #

The space immediately after this location.

nextTree :: TreePos Empty a -> Maybe (TreePos Full a) Source #

The tree after this location, if any.

next :: forall (t :: Type -> Type) a. PosType t => TreePos t a -> Maybe (TreePos t a) Source #

The sibling after this location.

last :: TreePos Empty a -> TreePos Empty a Source #

The last space in the current forest.

children :: TreePos Full a -> TreePos Empty a Source #

The location at the beginning of the forest of children.

firstChild :: TreePos Full a -> Maybe (TreePos Full a) Source #

The first child of the given location.

lastChild :: TreePos Full a -> Maybe (TreePos Full a) Source #

The last child of the given location.

childAt :: Int -> TreePos Full a -> Maybe (TreePos Full a) Source #

The child at the given index in the tree. The first child is at index 0.

Node classification

isRoot :: forall (t :: Type -> Type) a. PosType t => TreePos t a -> Bool Source #

Are we at the top of the tree?

isFirst :: forall (t :: Type -> Type) a. PosType t => TreePos t a -> Bool Source #

Are we the first position (of its kind) in a forest.

isLast :: forall (t :: Type -> Type) a. PosType t => TreePos t a -> Bool Source #

Are we the last position (of its kind) in a forest.

isLeaf :: TreePos Full a -> Bool Source #

Are we at the bottom of the tree?

isContained :: forall (t :: Type -> Type) a. PosType t => TreePos t a -> Bool Source #

Do we have a parent?

hasChildren :: TreePos Full a -> Bool Source #

Do we have children?

Working with the current tree

insert :: Tree a -> TreePos Empty a -> TreePos Full a Source #

Insert a new tree at the current position.

delete :: TreePos Full a -> TreePos Empty a Source #

Remove the tree at the current position.

setTree :: Tree a -> TreePos Full a -> TreePos Full a Source #

Change the current tree.

modifyTree :: (Tree a -> Tree a) -> TreePos Full a -> TreePos Full a Source #

Modify the current tree.

modifyLabel :: (a -> a) -> TreePos Full a -> TreePos Full a Source #

Modify the label at the current node.

setLabel :: a -> TreePos Full a -> TreePos Full a Source #

Change the label at the current node.