Source code Contents Index

Hledger.Cli.Utils

Description

Utilities for top-level modules and ghci. See also Hledger.Read and Hledger.Data.Utils.

Synopsis

withJournalDo :: [Opt] -> [String] -> String -> ([Opt] -> [String] -> Journal -> IO ()) -> IO () readJournalWithOpts :: [Opt] -> String -> IO Journal journalReload :: Journal -> IO (Either String Journal) journalReloadIfChanged :: [Opt] -> Journal -> IO (Either String Journal, Bool) journalFileIsNewer :: Journal -> IO Bool journalFileModificationTime :: Journal -> IO ClockTime openBrowserOn :: String -> IO ExitCode writeFileWithBackupIfChanged :: FilePath -> String -> IO Bool writeFileWithBackup :: FilePath -> String -> IO () backUpFile :: FilePath -> IO () safeGetDirectoryContents :: FilePath -> IO [FilePath] backupNumber :: FilePath -> FilePath -> Maybe Int

Documentation

withJournalDo :: [Opt] -> [String] -> String -> ([Opt] -> [String] -> Journal -> IO ()) -> IO () Source

Parse the user's specified journal file and run a hledger command on it, or throw an error.

readJournalWithOpts :: [Opt] -> String -> IO Journal Source

Get a journal from the given string and options, or throw an error.

journalReload :: Journal -> IO (Either String Journal) Source

Re-read a journal from its data file, or return an error string.

journalReloadIfChanged :: [Opt] -> Journal -> IO (Either String Journal, Bool) Source

Re-read a journal from its data file mostly, only if the file has changed since last read (or if there is no file, ie data read from stdin). The provided options are mostly ignored. Return a journal or the error message while reading it, and a flag indicating whether it was re-read or not.

journalFileIsNewer :: Journal -> IO Bool Source

Has the journal's data file changed since last parsed ?

journalFileModificationTime :: Journal -> IO ClockTime Source

Get the last modified time of the journal's data file (or if there is no file, the current time).

openBrowserOn :: String -> IO ExitCode Source

Attempt to open a web browser on the given url, all platforms.

writeFileWithBackupIfChanged :: FilePath -> String -> IO Bool Source

Back up this file with a (incrementing) numbered suffix then overwrite it with this new text, or give an error, but only if the text is different from the current file contents, and return a flag indicating whether we did anything.

writeFileWithBackup :: FilePath -> String -> IO () Source

Back up this file with a (incrementing) numbered suffix, then overwrite it with this new text, or give an error.

backUpFile :: FilePath -> IO () Source

Back up this file with a (incrementing) numbered suffix, or give an error.

safeGetDirectoryContents :: FilePath -> IO [FilePath] Source

backupNumber :: FilePath -> FilePath -> Maybe Int Source

Does the second file represent a backup of the first, and if so which version is it ?

Produced by Haddock version 2.6.1