Hledger.Read.Common

Common utilities for hledger data readers, such as the context (state) that is kept while parsing a journal.

Documentation

data Reader

A hledger data reader is a triple of format name, format-detecting predicate, and a parser to Journal.

Constructors

Reader

Fields

rFormat :: String

rDetector :: FilePath -> String -> Bool

rParser :: FilePath -> String -> ErrorT String IO Journal

type JournalUpdate = ErrorT String IO (Journal -> Journal)

A JournalUpdate is some transformation of a Journal. It can do I/O or raise an error.

parseJournalWith :: GenParser Char JournalContext JournalUpdate -> FilePath -> String -> ErrorT String IO Journal

Given a JournalUpdate-generating parsec parser, file path and data string, parse and post-process a Journal so that it's ready to use, or give an error.

data JournalContext

Some state kept while parsing a journal file.

Constructors

Ctx

Fields

ctxYear :: !(Maybe Integer)

the default year most recently specified with Y

ctxCommod :: !(Maybe String)

I don't know

ctxAccount :: ![String]

the current stack of parent accounts specified by !account

Instances

Read JournalContext

Show JournalContext

emptyCtx :: JournalContext

setYear :: Integer -> GenParser tok JournalContext ()

getYear :: GenParser tok JournalContext (Maybe Integer)

pushParentAccount :: String -> GenParser tok JournalContext ()

popParentAccount :: GenParser tok JournalContext ()

getParentAccount :: GenParser tok JournalContext String

expandPath :: MonadIO m => SourcePos -> FilePath -> m FilePath

fileSuffix :: FilePath -> String