Safe Haskell	Safe-Inferred

Ui.Skeleton

Description

Operations on Skeletons.

A skeleton is a tree, but it's stored as a Data.Graph and converted to a tree when needed. This seems weird, but at the time it seemed overly awkward to add and remove edges to a tree, and to detect cycles, while graphs have those operations built in. In retrospect, dealing with Data.Graph was probably more of a pain, so maybe someday if I have a lot of extra time and feel like some aggravation I'll see about redoing Skeleton as a Tree. I could also maybe clean up Ui.TrackTree.

Synopsis

data Skeleton
type Edge = (TrackNum, TrackNum)
empty :: Skeleton
make :: [Edge] -> Skeleton
draw :: Skeleton -> String
has_edge :: Skeleton -> Edge -> Bool
add_edges :: [Edge] -> Skeleton -> Maybe Skeleton
remove_edges :: [Edge] -> Skeleton -> Skeleton
lonely_vertex :: Skeleton -> TrackNum -> Bool
flatten :: Skeleton -> [Edge]
to_forest :: TrackNum -> Skeleton -> [Tree.Tree TrackNum]
parents :: Skeleton -> TrackNum -> [TrackNum]
children :: Skeleton -> TrackNum -> [TrackNum]
insert :: TrackNum -> Skeleton -> Skeleton
remove :: TrackNum -> Skeleton -> Skeleton
toggle_edge :: Edge -> Skeleton -> Maybe Skeleton
splice_above :: TrackNum -> TrackNum -> Skeleton -> Maybe Skeleton
splice_below :: TrackNum -> TrackNum -> Skeleton -> Maybe Skeleton
move :: TrackNum -> TrackNum -> Skeleton -> Skeleton

Documentation

data Skeleton Source #

The skeleton describes a hierarchical relationship between tracks. It's used at the UI level only to display the hierarchy visually, but the deriver level will presumably use it for derivation. A given track may appear multiple times or not at all.

Instances

Instances details

Read Skeleton Source #
Instance details Defined in Ui.Skeleton Methods readsPrec :: Int -> ReadS Skeleton # readList :: ReadS [Skeleton] # readPrec :: ReadPrec Skeleton # readListPrec :: ReadPrec [Skeleton] #
Show Skeleton Source #
Instance details Defined in Ui.Skeleton Methods showsPrec :: Int -> Skeleton -> ShowS # show :: Skeleton -> String # showList :: [Skeleton] -> ShowS #
Eq Skeleton Source #
Instance details Defined in Ui.Skeleton Methods (==) :: Skeleton -> Skeleton -> Bool # (/=) :: Skeleton -> Skeleton -> Bool #
Pretty Skeleton Source #
Instance details Defined in Ui.Skeleton Methods pretty :: Skeleton -> Text Source # format :: Skeleton -> Doc Source # formatList :: [Skeleton] -> Doc Source #
Serialize.Serialize Skeleton Source #
Instance details Defined in Ui.Skeleton Methods put :: Putter Skeleton Source # get :: Serialize.Get Skeleton Source #

type Edge = (TrackNum, TrackNum) Source #

This is (parent, child).

empty :: Skeleton Source #

make :: [Edge] -> Skeleton Source #

draw :: Skeleton -> String Source #

has_edge :: Skeleton -> Edge -> Bool Source #

add_edges :: [Edge] -> Skeleton -> Maybe Skeleton Source #

remove_edges :: [Edge] -> Skeleton -> Skeleton Source #

lonely_vertex :: Skeleton -> TrackNum -> Bool Source #

flatten :: Skeleton -> [Edge] Source #

to_forest Source #

Arguments

:: TrackNum	Total number of tracks. This is needed because the underlying graph may be smaller than the number of tracks. I don't want to allow a skeleton that doesn't have certain tracks (and hence makes them invisible) so any missing tracks are appended.
-> Skeleton
-> [Tree.Tree TrackNum]	Each list of Nodes is sorted so the tree appears in the same order as the tracks. This is essential for calls that want to deal with tracks left-to-right.

parents :: Skeleton -> TrackNum -> [TrackNum] Source #

Get the parents of a TrackNum.

children :: Skeleton -> TrackNum -> [TrackNum] Source #

insert :: TrackNum -> Skeleton -> Skeleton Source #

Increment all vertices at and above, insert new empty vertex.

remove :: TrackNum -> Skeleton -> Skeleton Source #

All vertices pointing to the removed vertex instead point to what it pointed to. All vertices above the removed one get (-1).

toggle_edge :: Edge -> Skeleton -> Maybe Skeleton Source #

splice_above :: TrackNum -> TrackNum -> Skeleton -> Maybe Skeleton Source #

splice_below :: TrackNum -> TrackNum -> Skeleton -> Maybe Skeleton Source #

move :: TrackNum -> TrackNum -> Skeleton -> Skeleton Source #

If from<to, then from is inserted after to. If to<from, then from is inserted before to.