Safe Haskell	None

Hledger.Reports.ReportOptions

Description

Options common to most hledger reports.

Synopsis

Documentation

data ReportOpts Source

Standard options for customising report filtering and output, corresponding to hledger's command-line options and query language arguments. Used in hledger-lib and above.

Constructors

ReportOpts

Fields

begin_ :: Maybe Day
end_ :: Maybe Day
period_ :: Maybe (Interval, DateSpan)
cleared_ :: Bool
uncleared_ :: Bool
cost_ :: Bool
depth_ :: Maybe Int
display_ :: Maybe DisplayExp
date2_ :: Bool
empty_ :: Bool
no_elide_ :: Bool
real_ :: Bool
daily_ :: Bool
weekly_ :: Bool
monthly_ :: Bool
quarterly_ :: Bool
yearly_ :: Bool
format_ :: Maybe FormatStr
query_ :: String
average_ :: Bool
related_ :: Bool
balancetype_ :: BalanceType
flat_ :: Bool
tree_ :: Bool
drop_ :: Int
no_total_ :: Bool

Instances

Data ReportOpts
Show ReportOpts
Typeable ReportOpts
Default ReportOpts

data BalanceType Source

Which balance is being shown in a multi-column balance report.

Constructors

PeriodBalance	The change of balance in each period.
CumulativeBalance	The accumulated balance at each period's end, starting from zero at the report start date.
HistoricalBalance	The historical balance at each period's end, starting from the account balances at the report start date.

Instances

Eq BalanceType
Data BalanceType
Show BalanceType
Typeable BalanceType
Default BalanceType

type FormatStr = String Source

defreportopts :: ReportOpts Source

rawOptsToReportOpts :: RawOpts -> IO ReportOpts Source

dateSpanFromOpts :: Day -> ReportOpts -> DateSpan Source

Figure out the date span we should report on, based on any beginendperiod options provided. A period option will cause begin and end options to be ignored.

intervalFromOpts :: ReportOpts -> Interval Source

Figure out the reporting interval, if any, specified by the options. --period overrides --daily overrides --weekly overrides --monthly etc.

clearedValueFromOpts :: ReportOpts -> Maybe Bool Source

Get a maybe boolean representing the last cleared/uncleared option if any.

whichDateFromOpts :: ReportOpts -> WhichDate Source

Report which date we will report on based on --date2.

journalSelectingAmountFromOpts :: ReportOpts -> Journal -> Journal Source

Convert this journal's postings' amounts to the cost basis amounts if specified by options.

queryFromOpts :: Day -> ReportOpts -> Query Source

Convert report options and arguments to a query.

queryFromOptsOnly :: Day -> ReportOpts -> Query Source

Convert report options to a query, ignoring any non-flag command line arguments.

queryOptsFromOpts :: Day -> ReportOpts -> [QueryOpt]Source

Convert report options and arguments to query options.

transactionDateFn :: ReportOpts -> Transaction -> Day Source

Select the Transaction date accessor based on --date2.

postingDateFn :: ReportOpts -> Posting -> Day Source

Select the Posting date accessor based on --date2.

tests_Hledger_Reports_ReportOptions :: Test Source