hledger-lib-1.12: Core data types, parsers and functionality for the hledger accounting tools

Safe Haskell | None
Language | Haskell2010

Hledger.Read

Contents

- Journal files
- Journal parsing
- Re-exported
- Tests

Description

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.

Synopsis

- type PrefixedFilePath = FilePath
- defaultJournal :: IO Journal
- defaultJournalPath :: IO String
- readJournalFiles :: InputOpts -> [FilePath] -> IO (Either String Journal)
- readJournalFile :: InputOpts -> PrefixedFilePath -> IO (Either String Journal)
- requireJournalFileExists :: FilePath -> IO ()
- ensureJournalFileExists :: FilePath -> IO ()
- splitReaderPrefix :: PrefixedFilePath -> (Maybe String, FilePath)
- readJournal :: InputOpts -> Maybe FilePath -> Text -> IO (Either String Journal)
- readJournal' :: Text -> IO Journal
- postingp :: Maybe Year -> JournalParser m Posting
- module Hledger.Read.Common
- tests_Read :: Test ()

# Journal files

type PrefixedFilePath = FilePath Source #

A file path optionally prefixed by a reader name and colon (journal:, csv:, timedot:, etc.).

defaultJournal :: IO Journal Source #

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

defaultJournalPath :: IO String Source #

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).

readJournalFiles :: InputOpts -> [FilePath] -> IO (Either String Journal) Source #

Read a Journal from each specified file path and combine them into one. Or, return the first error message.

Combining Journals means concatenating them, basically. The parse state resets at the start of each file, which means that directives & aliases do not affect subsequent sibling or parent files. They do affect included child files though. Also the final parse state saved in the Journal does span all files.

readJournalFile :: InputOpts -> PrefixedFilePath -> IO (Either String Journal) Source #

Read a Journal from this file, or from stdin if the file path is -, or return an error message. The file path can have a READER: prefix.

The reader (data format) to use is determined from (in priority order): the `mformat_` specified in the input options, if any; the file path's READER: prefix, if any; a recognised file name extension. if none of these identify a known reader, all built-in readers are tried in turn.

The input options can also configure balance assertion checking, automated posting generation, a rules file for converting CSV data, etc.

requireJournalFileExists :: FilePath -> IO () Source #

If the specified journal file does not exist (and is not "-"), give a helpful error and quit.

ensureJournalFileExists :: FilePath -> IO () Source #

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

splitReaderPrefix :: PrefixedFilePath -> (Maybe String, FilePath) Source #

If a filepath is prefixed by one of the reader names and a colon, split that off. Eg "csv:-" -> (Just "csv", "-").

# Journal parsing

readJournal :: InputOpts -> Maybe FilePath -> Text -> IO (Either String Journal) Source #

    readJournal iopts mfile txt

Read a Journal from some text, or return an error message.

The reader (data format) is chosen based on a recognised file name extension in `mfile` (if provided). If it does not identify a known reader, all built-in readers are tried in turn (returning the first one's error message if none of them succeed).

Input ioptions (`iopts`) specify CSV conversion rules file to help convert CSV data, enable or disable balance assertion checking and automated posting generation.

readJournal' :: Text -> IO Journal Source #

Read a Journal from the given text trying all readers in turn, or throw an error.

# Re-exported

postingp :: Maybe Year -> JournalParser m Posting Source #

module Hledger.Read.Common

# Tests

tests_Read :: Test () Source #