Ledger.Parse

Parsers for standard ledger and timelog files.

Here is the ledger grammar from the ledger 2.5 manual:

The ledger file format is quite simple, but also very flexible. It supports
many options, though typically the user can ignore most of them. They are
summarized below.  The initial character of each line determines what the
line means, and how it should be interpreted. Allowable initial characters
are:

NUMBER      A line beginning with a number denotes an entry. It may be followed by any
            number of lines, each beginning with whitespace, to denote the entrys account
            transactions. The format of the first line is:

DATE[=EDATE] [*|!] [(CODE)] DESC

If * appears after the date (with optional eective date), it indicates the entry
            is cleared, which can mean whatever the user wants it t omean. If ! appears
            after the date, it indicates d the entry is pending; i.e., tentatively cleared from
            the users point of view, but not yet actually cleared. If a CODE appears in
            parentheses, it may be used to indicate a check number, or the type of the
            transaction. Following these is the payee, or a description of the transaction.
            The format of each following transaction is:

ACCOUNT     AMOUNT    [; NOTE]

The ACCOUNT may be surrounded by parentheses if it is a virtual
            transactions, or square brackets if it is a virtual transactions that must
            balance. The AMOUNT can be followed by a per-unit transaction cost,
            by specifying  AMOUNT, or a complete transaction cost with @ AMOUNT.
            Lastly, the NOTE may specify an actual and/or eective date for the
            transaction by using the syntax [ACTUAL_DATE] or [=EFFECTIVE_DATE] or
            [ACTUAL_DATE=EFFECtIVE_DATE].

=           An automated entry. A value expression must appear after the equal sign.
            After this initial line there should be a set of one or more transactions, just as
            if it were normal entry. If the amounts of the transactions have no commodity,
            they will be applied as modifiers to whichever real transaction is matched by
            the value expression.

~           A period entry. A period expression must appear after the tilde.
            After this initial line there should be a set of one or more transactions, just as
            if it were normal entry.

!           A line beginning with an exclamation mark denotes a command directive. It
            must be immediately followed by the command word. The supported commands
            are:

!include
                        Include the stated ledger file.
           !account
                        The account name is given is taken to be the parent of all transac-
                        tions that follow, until !end is seen.
           !end       Ends an account block.

;          A line beginning with a colon indicates a comment, and is ignored.

Y          If a line begins with a capital Y, it denotes the year used for all subsequent
           entries that give a date without a year. The year should appear immediately
           after the Y, for example: Y2004. This is useful at the beginning of a file, to
           specify the year for that file. If all entries specify a year, however, this command
           has no eect.

P          Specifies a historical price for a commodity. These are usually found in a pricing
           history file (see the -Q option). The syntax is:

P DATE SYMBOL PRICE

N SYMBOL   Indicates that pricing information is to be ignored for a given symbol, nor will
           quotes ever be downloaded for that symbol. Useful with a home currency, such
           as the dollar ($). It is recommended that these pricing options be set in the price
           database file, which defaults to ~/.pricedb. The syntax for this command is:

N SYMBOL

D AMOUNT   Specifies the default commodity to use, by specifying an amount in the expected
           format. The entry command will use this commodity as the default when none
           other can be determined. This command may be used multiple times, to set
           the default flags for dierent commodities; whichever is seen last is used as the
           default commodity. For example, to set US dollars as the default commodity,
           while also setting the thousands flag and decimal flag for that commodity, use:

D $1,000.00

C AMOUNT1 = AMOUNT2
           Specifies a commodity conversion, where the first amount is given to be equiv-
           alent to the second amount. The first amount should use the decimal precision
           desired during reporting:

C 1.00 Kb = 1024 bytes

i, o, b, h
           These four relate to timeclock support, which permits ledger to read timelog
           files. See the timeclocks documentation for more info on the syntax of its
           timelog files.

Here is the timelog grammar from timeclock.el 2.6:

A timelog contains data in the form of a single entry per line.
Each entry has the form:

CODE YYYYMMDD HH:MM:SS [COMMENT]

CODE is one of: b, h, i, o or O.  COMMENT is optional when the code is
i, o or O.  The meanings of the codes are:

b  Set the current time balance, or "time debt".  Useful when
     archiving old log data, when a debt must be carried forward.
     The COMMENT here is the number of seconds of debt.

h  Set the required working time for the given day.  This must
     be the first entry for that day.  The COMMENT in this case is
     the number of hours in this workday.  Floating point amounts
     are allowed.

i  Clock in.  The COMMENT in this case should be the name of the
     project worked on.

o  Clock out.  COMMENT is unnecessary, but can be used to provide
     a description of how the period went, for example.

O  Final clock out.  Whatever project was being worked on, it is
     now finished.  Useful for creating summary reports.

Example:

i 20070310 12:26:00 hledger
o 20070310 17:26:02

Documentation

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

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

data LedgerFileCtx

Some context kept during parsing.

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 LedgerFileCtx

Show LedgerFileCtx

emptyCtx :: LedgerFileCtx

setYear :: Integer -> GenParser tok LedgerFileCtx ()

getYear :: GenParser tok LedgerFileCtx (Maybe Integer)

pushParentAccount :: String -> GenParser tok LedgerFileCtx ()

popParentAccount :: GenParser tok LedgerFileCtx ()

getParentAccount :: GenParser tok LedgerFileCtx String

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

parseLedgerFile :: LocalTime -> FilePath -> ErrorT String IO Journal

Parses a ledger file or timelog file to a Journal, or gives an error. Requires the current (local) time to calculate any unfinished timelog sessions, we pass it in for repeatability.

parseLedger :: LocalTime -> FilePath -> String -> ErrorT String IO Journal

Like parseLedgerFile, but parses a string. A file path is still provided to save in the resulting journal.

ledgerFile :: GenParser Char LedgerFileCtx JournalUpdate

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

emptyLine :: GenParser Char st ()

ledgercomment :: GenParser Char st String

ledgercommentline :: GenParser Char st String

ledgerExclamationDirective :: GenParser Char LedgerFileCtx JournalUpdate

ledgerInclude :: GenParser Char LedgerFileCtx JournalUpdate

ledgerAccountBegin :: GenParser Char LedgerFileCtx JournalUpdate

ledgerAccountEnd :: GenParser Char LedgerFileCtx JournalUpdate

ledgerModifierTransaction :: GenParser Char LedgerFileCtx ModifierTransaction

ledgerPeriodicTransaction :: GenParser Char LedgerFileCtx PeriodicTransaction

ledgerHistoricalPrice :: GenParser Char LedgerFileCtx HistoricalPrice

ledgerIgnoredPriceCommodity :: GenParser Char LedgerFileCtx JournalUpdate

ledgerDefaultCommodity :: GenParser Char LedgerFileCtx JournalUpdate

ledgerCommodityConversion :: GenParser Char LedgerFileCtx JournalUpdate

ledgerTagDirective :: GenParser Char LedgerFileCtx JournalUpdate

ledgerEndTagDirective :: GenParser Char LedgerFileCtx JournalUpdate

ledgerDefaultYear :: GenParser Char LedgerFileCtx JournalUpdate

ledgerTransaction :: GenParser Char LedgerFileCtx Transaction

Try to parse a ledger entry. If we successfully parse an entry, check it can be balanced, and fail if not.

ledgerdate :: GenParser Char LedgerFileCtx Day

ledgerfulldate :: GenParser Char LedgerFileCtx Day

ledgerpartialdate :: GenParser Char LedgerFileCtx Day

Match a partial M/D date in a ledger, and also require that a default year directive was previously encountered.

ledgerdatetime :: GenParser Char LedgerFileCtx LocalTime

ledgereffectivedate :: Day -> GenParser Char LedgerFileCtx (Maybe Day)

ledgerstatus :: GenParser Char st Bool

ledgercode :: GenParser Char st String

ledgerpostings :: GenParser Char LedgerFileCtx [Posting]

linebeginningwithspaces :: GenParser Char st String

ledgerposting :: GenParser Char LedgerFileCtx Posting

transactionaccountname :: GenParser Char LedgerFileCtx AccountName

ledgeraccountname :: 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.

postingamount :: GenParser Char st MixedAmount

Parse an amount, with an optional left or right currency symbol and optional price.

someamount :: GenParser Char st MixedAmount

leftsymbolamount :: GenParser Char st MixedAmount

rightsymbolamount :: GenParser Char st MixedAmount

nosymbolamount :: GenParser Char st MixedAmount

commoditysymbol :: GenParser Char st String

quotedcommoditysymbol :: GenParser Char st String

priceamount :: GenParser Char st (Maybe MixedAmount)

amountquantity :: GenParser Char st (Double, Int, Bool)

Parse a ledger-style numeric quantity and also return the number of digits to the right of the decimal point and whether thousands are separated by comma.

numberparts :: GenParser Char st (String, String)

parse the two strings of digits before and after a possible decimal point. The integer part may contain commas, or either part may be empty, or there may be no point.

numberpartsstartingwithdigit :: GenParser Char st (String, String)

numberpartsstartingwithpoint :: GenParser Char st (String, String)

timelogentry :: GenParser Char LedgerFileCtx TimeLogEntry

Parse a timelog entry.

datedisplayexpr :: GenParser Char st (Posting -> Bool)

Parse a hledger display expression, which is a simple date test like d>[DATE] or d<=[DATE], and return a Posting-matching predicate.