Hledger.Read

This is the entry point to hledger's reading system, which can read Journals from various data formats. Use this module if you want to parse journal data or read journal files. Generally it should not be necessary to import modules below this one.

Journal reading API

defaultJournalPath :: IO String

All the data formats we can read. formats = map rFormat readers

Get the default journal file path specified by the environment. Like ledger, we look first for the LEDGER_FILE environment variable, and if that does not exist, for the legacy LEDGER environment variable. If neither is set, or the value is blank, return the hard-coded default, which is .hledger.journal in the users's home directory (or in the current directory, if we cannot determine a home directory).

defaultJournal :: IO Journal

Read the default journal file specified by the environment, or raise an error.

readJournal :: Maybe Format -> Maybe FilePath -> Maybe FilePath -> String -> IO (Either String Journal)

Read a journal from this string, trying whatever readers seem appropriate:

• if a format is specified, try that reader only
• or if one or more readers recognises the file path and data, try those
• otherwise, try them all.

A CSV conversion rules file may also be specified for use by the CSV reader.

readJournal' :: String -> IO Journal

Read a journal from the given string, trying all known formats, or simply throw an error.

readJournalFile :: Maybe Format -> Maybe FilePath -> FilePath -> IO (Either String Journal)

Read a Journal from this file (or stdin if the filename is -) or give an error message, using the specified data format or trying all known formats. A CSV conversion rules file may be specified for better conversion of that format.

requireJournalFileExists :: FilePath -> IO ()

If the specified journal file does not exist, give a helpful error and quit.

ensureJournalFileExists :: FilePath -> IO ()

Ensure there is a journal file at the given path, creating an empty one if needed.

Parsers used elsewhere

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

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.

code :: GenParser Char JournalContext String

Tests

samplejournal :: IO Journal

tests_Hledger_Read :: Test