Source code Contents Index

Hledger.Data.Utils

Description

Standard imports and utilities which are useful everywhere, or needed low in the module hierarchy. This is the bottom of hledger's module graph.

Synopsis

underline :: String -> String unbracket :: String -> String concatTopPadded :: [String] -> String concatBottomPadded :: [String] -> String vConcatRightAligned :: [String] -> String padtop :: Int -> String -> String padbottom :: Int -> String -> String padleft :: Int -> String -> String padright :: Int -> String -> String cliptopleft :: Int -> Int -> String -> String fitto :: Int -> Int -> String -> String difforzero :: (Num a, Ord a) => a -> a -> a containsRegex :: String -> String -> Bool splitAtElement :: Eq a => a -> [a] -> [[a]] leaves :: Tree a -> [a] subtreeat :: Eq a => a -> Tree a -> Maybe (Tree a) subtreeinforest :: Eq a => a -> [Tree a] -> Maybe (Tree a) treeprune :: Int -> Tree a -> Tree a treemap :: (a -> b) -> Tree a -> Tree b treefilter :: (a -> Bool) -> Tree a -> Tree a treeany :: (a -> Bool) -> Tree a -> Bool showtree :: Show a => Tree a -> String showforest :: Show a => Forest a -> String strace :: Show a => a -> a ltrace :: Show a => String -> a -> a parsewith :: Parser a -> String -> Either ParseError a parseWithCtx :: b -> GenParser Char b a -> String -> Either ParseError a fromparse :: Either ParseError a -> a nonspace :: GenParser Char st Char spacenonewline :: GenParser Char st Char restofline :: GenParser Char st String getCurrentLocalTime :: IO LocalTime tname :: Test -> String tflatten :: Test -> [Test] tfilter :: (Test -> Bool) -> Test -> Test is :: (Eq a, Show a) => a -> a -> Assertion assertParse :: Either ParseError a -> Assertion assertParseEqual :: (Show a, Eq a) => Either ParseError a -> a -> Assertion printParseError :: Show a => a -> IO () isLeft :: Either a b -> Bool isRight :: Either a b -> Bool strictReadFile :: FilePath -> IO String

Documentation

underline :: String -> String Source

unbracket :: String -> String Source

concatTopPadded :: [String] -> String Source

Join multi-line strings as side-by-side rectangular strings of the same height, top-padded.

concatBottomPadded :: [String] -> String Source

Join multi-line strings as side-by-side rectangular strings of the same height, bottom-padded.

vConcatRightAligned :: [String] -> String Source

Compose strings vertically and right-aligned.

padtop :: Int -> String -> String Source

Convert a multi-line string to a rectangular string top-padded to the specified height.

padbottom :: Int -> String -> String Source

Convert a multi-line string to a rectangular string bottom-padded to the specified height.

padleft :: Int -> String -> String Source

Convert a multi-line string to a rectangular string left-padded to the specified width.

padright :: Int -> String -> String Source

Convert a multi-line string to a rectangular string right-padded to the specified width.

cliptopleft :: Int -> Int -> String -> String Source

Clip a multi-line string to the specified width and height from the top left.

fitto :: Int -> Int -> String -> String Source

Clip and pad a multi-line string to fill the specified width and height.

difforzero :: (Num a, Ord a) => a -> a -> a Source

containsRegex :: String -> String -> Bool Source

splitAtElement :: Eq a => a -> [a] -> [[a]] Source

leaves :: Tree a -> [a] Source

List just the leaf nodes of a tree

subtreeat :: Eq a => a -> Tree a -> Maybe (Tree a) Source

get the sub-tree rooted at the first (left-most, depth-first) occurrence of the specified node value

subtreeinforest :: Eq a => a -> [Tree a] -> Maybe (Tree a) Source

get the sub-tree for the specified node value in the first tree in forest in which it occurs.

treeprune :: Int -> Tree a -> Tree a Source

remove all nodes past a certain depth

treemap :: (a -> b) -> Tree a -> Tree b Source

apply f to all tree nodes

treefilter :: (a -> Bool) -> Tree a -> Tree a Source

remove all subtrees whose nodes do not fulfill predicate

treeany :: (a -> Bool) -> Tree a -> Bool Source

is predicate true in any node of tree ?

showtree :: Show a => Tree a -> String Source

show a compact ascii representation of a tree

showforest :: Show a => Forest a -> String Source

show a compact ascii representation of a forest

strace :: Show a => a -> a Source

trace (print on stdout at runtime) a showable expression (for easily tracing in the middle of a complex expression)

ltrace :: Show a => String -> a -> a Source

labelled trace - like strace, with a newline and a label prepended

parsewith :: Parser a -> String -> Either ParseError a Source

trace an expression using a custom show function

parseWithCtx :: b -> GenParser Char b a -> String -> Either ParseError a Source

fromparse :: Either ParseError a -> a Source

nonspace :: GenParser Char st Char Source

spacenonewline :: GenParser Char st Char Source

restofline :: GenParser Char st String Source

getCurrentLocalTime :: IO LocalTime Source

tname :: Test -> String Source

Get a Test's label, or the empty string.

tflatten :: Test -> [Test] Source

Flatten a Test containing TestLists into a list of single tests.

tfilter :: (Test -> Bool) -> Test -> Test Source

Filter TestLists in a Test, recursively, preserving the structure.

is :: (Eq a, Show a) => a -> a -> Assertion Source

Simple way to assert something is some expected value, with no label.

assertParse :: Either ParseError a -> Assertion Source

Assert a parse result is successful, printing the parse error on failure.

assertParseEqual :: (Show a, Eq a) => Either ParseError a -> a -> Assertion Source

Assert a parse result is some expected value, printing the parse error on failure.

printParseError :: Show a => a -> IO () Source

isLeft :: Either a b -> Bool Source

isRight :: Either a b -> Bool Source

strictReadFile :: FilePath -> IO String Source

Produced by Haddock version 2.6.1