Hledger.Read.JournalReader

A reader for hledger's journal file format (http://hledger.org/MANUAL.html#the-journal-file). hledger's journal format is a compatible subset of c++ ledger's (http://ledger-cli.org/3.0/doc/ledger3.html#Journal-Format), so this reader should handle many ledger files as well. Example:

2012/3/24 gift
    expenses:gifts  $10
    assets:cash

Reader

reader :: Reader

Parsers used elsewhere

parseJournalWith :: GenParser Char JournalContext (JournalUpdate, JournalContext) -> 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.

getParentAccount :: GenParser tok JournalContext String

journal :: GenParser Char JournalContext (JournalUpdate, JournalContext)

Top-level journal parser. Returns a single composite, I/O performing, error-raising JournalUpdate (and final JournalContext) which can be applied to an empty journal to get the final result.

directive :: GenParser Char JournalContext JournalUpdate

defaultyeardirective :: GenParser Char JournalContext JournalUpdate

historicalpricedirective :: GenParser Char JournalContext HistoricalPrice

datetimep :: GenParser Char JournalContext LocalTime

Parse a date and time in YYYYMMDD HH:MM[:SS][+-ZZZZ] format. Any timezone will be ignored; the time is treated as local time. Fewer digits are allowed, except in the timezone. The year may be omitted if a default year has already been set.

codep :: GenParser Char JournalContext String

accountnamep :: GenParser Char st AccountName

Parse an account name. Account names may have single spaces inside them, and are terminated by two or more spaces. They should have one or more components of at least one character, separated by the account separator char.

postingp :: GenParser Char JournalContext Posting

amountp :: GenParser Char JournalContext Amount

Parse a single-commodity amount, with optional symbol on the left or right, optional unit or total price, and optional (ignored) ledger-style balance assertion or fixed lot price declaration.

amountp' :: String -> Amount

Parse an amount from a string, or get an error.

mamountp' :: String -> MixedAmount

Parse a mixed amount from a string, or get an error.

numberp :: GenParser Char JournalContext (Quantity, Int, Char, Char, [Int])

Parse a numeric quantity for its value and display attributes. Some international number formats (cf http://en.wikipedia.org/wiki/Decimal_separator) are accepted: either period or comma may be used for the decimal point, and the other of these may be used for separating digit groups in the integer part (eg a thousands separator). This returns the numeric value, the precision (number of digits to the right of the decimal point), the decimal point and separator characters (defaulting to . and ,), and the positions of separators (counting leftward from the decimal point, the last is assumed to repeat).

emptyorcommentlinep :: GenParser Char JournalContext ()

followingcommentp :: GenParser Char JournalContext String