Hledger.Utils

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

Documentation

underline :: String -> String

quoteIfSpaced :: String -> String

Wrap a string in single quotes, and -prefix any embedded single quotes, if it contains whitespace and is not already single- or double-quoted.

words' :: String -> [String]

Quote-aware version of words - don't split on spaces which are inside quotes. NB correctly handles a'b but not ''a''.

unwords' :: [String] -> String

Quote-aware version of unwords - single-quote strings which contain whitespace

stripquotes :: String -> String

Strip one matching pair of single or double quotes on the ends of a string.

unbracket :: String -> String

concatTopPadded :: [String] -> String

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

concatBottomPadded :: [String] -> String

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

vConcatRightAligned :: [String] -> String

Compose strings vertically and right-aligned.

padtop :: Int -> String -> String

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

padbottom :: Int -> String -> String

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

padleft :: Int -> String -> String

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

padright :: Int -> String -> String

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

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

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

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

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

type PlatformString = String

A platform string is a string value from or for the operating system, such as a file path or command-line argument (or environment variable's name or value ?). On some platforms (such as unix) these are not real unicode strings but have some encoding such as UTF-8. This alias does no type enforcement but aids code clarity.

fromPlatformString :: PlatformString -> String

Convert a possibly encoded platform string to a real unicode string. We decode the UTF-8 encoding recommended for unix systems (cf http:www.dwheeler.comessaysfixing-unix-linux-filenames.html) and leave anything else unchanged.

toPlatformString :: String -> PlatformString

Convert a unicode string to a possibly encoded platform string. On unix we encode with the recommended UTF-8 (cf http:www.dwheeler.comessaysfixing-unix-linux-filenames.html) and elsewhere we leave it unchanged.

error' :: String -> a

A version of error that's better at displaying unicode.

userError' :: String -> IOError

A version of userError that's better at displaying unicode.

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

regexMatches :: String -> String -> Bool

regexMatchesCI :: String -> String -> Bool

regexReplace :: String -> String -> String -> String

regexReplaceCI :: String -> String -> String -> String

regexReplaceBy :: String -> (String -> String) -> String -> String

regexToCaseInsensitive :: String -> String

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

leaves :: Tree a -> [a]

List just the leaf nodes of a tree

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

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)

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

remove all nodes past a certain depth

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

apply f to all tree nodes

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

remove all subtrees whose nodes do not fulfill predicate

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

is predicate true in any node of tree ?

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

show a compact ascii representation of a tree

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

show a compact ascii representation of a forest

strace :: Show a => a -> a

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

labelled trace - like strace, with a label prepended

mtrace :: (Monad m, Show a) => a -> m a

monadic trace - like strace, but works as a standalone line in a monad

tracewith :: (a -> String) -> a -> a

trace an expression using a custom show function

choice' :: [GenParser tok st a] -> GenParser tok st a

Backtracking choice, use this when alternatives share a prefix. Consumes no input if all choices fail.

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

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

fromparse :: Either ParseError a -> a

parseerror :: ParseError -> a

showParseError :: ParseError -> String

showDateParseError :: ParseError -> String

nonspace :: GenParser Char st Char

spacenonewline :: GenParser Char st Char

restofline :: GenParser Char st String

getCurrentLocalTime :: IO LocalTime

tname :: Test -> String

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

tflatten :: Test -> [Test]

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

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

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

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

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

assertParse :: Either ParseError a -> Assertion

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

assertParseFailure :: Either ParseError a -> Assertion

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

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

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

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

isLeft :: Either a b -> Bool

isRight :: Either a b -> Bool

applyN :: Int -> (a -> a) -> a -> a

Apply a function the specified number of times. Possibly uses O(n) stack ?

trace :: String -> a -> a

When called, trace outputs the string in its first argument, before returning the second argument as its result. The trace function is not referentially transparent, and should only be used for debugging, or for monitoring execution. Some implementations of trace may decorate the string that's output to indicate that you're tracing. The function is implemented on top of putTraceMsg.