hledger-lib-0.15: Core data types, parsers and utilities for the hledger accounting tool.

Hledger.Read

Description

Read hledger data from various data formats, and related utilities.

Synopsis

Documentation

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

Read a journal from this file, using the specified data format or trying all known formats, or give an error string; also create the file if it doesn't exist.

readJournal :: Maybe String -> String -> IO (Either String Journal)Source

Read a Journal from this string, using the specified data format or trying all known formats, or give an error string.

journalFromPathAndString :: Maybe String -> FilePath -> String -> IO (Either String Journal)Source

Read a Journal from this string (and file path), auto-detecting the data format, or give a useful error string. Tries to parse each known data format in turn. If none succeed, gives the error message specific to the intended data format, which if not specified is guessed from the file suffix and possibly the data.

ledgeraccountname :: GenParser Char st AccountNameSource

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.

myJournalPath :: IO StringSource

Get the user's journal file path. 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 default journal file path, which is .hledger.journal in the users's home directory, or if we cannot determine that, in the current directory.

myTimelogPath :: IO StringSource

Get the user's default timelog file path.

myJournal :: IO JournalSource

Read the user's default journal file, or give an error.

myTimelog :: IO JournalSource

Read the user's default timelog file, or give an error.