Hledger.Reports.ReportOptions

Options common to most hledger reports.

Documentation

data ReportOpts

Standard options for customising report filtering and output. Most of these correspond to standard hledger command-line options or query arguments, but not all. Some are used only by certain commands, as noted below.

Constructors

ReportOpts

Fields

• period_ :: Period
• interval_ :: Interval
• statuses_ :: [Status]

  Zero, one, or two statuses to be matched

• cost_ :: Costing

  Should we convert amounts to cost, when present?

• value_ :: Maybe ValuationType

  What value should amounts be converted to ?

• infer_value_ :: Bool

  Infer market prices from transactions ?

• depth_ :: Maybe Int
• date2_ :: Bool
• empty_ :: Bool
• no_elide_ :: Bool
• real_ :: Bool
• format_ :: StringFormat
• querystring_ :: [Text]
• average_ :: Bool
• related_ :: Bool
• txn_dates_ :: Bool
• reporttype_ :: ReportType
• balancetype_ :: BalanceType
• accountlistmode_ :: AccountListMode
• drop_ :: Int
• row_total_ :: Bool
• no_total_ :: Bool
• show_costs_ :: Bool

  Whether to show costs for reports which normally don't show them

• pretty_tables_ :: Bool
• sort_amount_ :: Bool
• percent_ :: Bool
• invert_ :: Bool

  if true, flip all amount signs in reports

• normalbalance_ :: Maybe NormalSign

  This can be set when running balance reports on a set of accounts with the same normal balance type (eg all assets, or all incomes). - It helps --sort-amount know how to sort negative numbers (eg in the income section of an income statement) - It helps compound balance report commands (is, bs etc.) do sign normalisation, converting normally negative subreports to normally positive for a more conventional display.

• color_ :: Bool

  Whether to use ANSI color codes in text output. Influenced by the --color/colour flag (cf CliOptions), whether stdout is an interactive terminal, and the value of TERM and existence of NO_COLOR environment variables.

• transpose_ :: Bool

Instances

Show ReportOpts

Defined in Hledger.Reports.ReportOptions

Methods

showsPrec :: Int -> ReportOpts -> ShowS

show :: ReportOpts -> String

showList :: [ReportOpts] -> ShowS

Default ReportOpts

Defined in Hledger.Reports.ReportOptions

Methods

def :: ReportOpts

data ReportSpec

The result of successfully parsing a ReportOpts on a particular Day. Any ambiguous dates are completed and Queries are parsed, ensuring that there are no regular expression errors. Values here should be used in preference to re-deriving them from ReportOpts. If you change the query_ in ReportOpts, you should call reportOptsToSpec to regenerate the ReportSpec with the new Query.

Constructors

ReportSpec

Fields

• rsOpts :: ReportOpts

  The underlying ReportOpts used to generate this ReportSpec

• rsToday :: Day

  The Day this ReportSpec is generated for

• rsQuery :: Query

  The generated Query for the given day

• rsQueryOpts :: [QueryOpt]

  A list of QueryOpts for the given day

Instances

Show ReportSpec

Defined in Hledger.Reports.ReportOptions

Methods

showsPrec :: Int -> ReportSpec -> ShowS

show :: ReportSpec -> String

showList :: [ReportSpec] -> ShowS

Default ReportSpec

Defined in Hledger.Reports.ReportOptions

Methods

def :: ReportSpec

data ReportType

What is calculated and shown in each cell in a balance report.

Constructors

ChangeReport

The sum of posting amounts.

BudgetReport

The sum of posting amounts and the goal.

ValueChangeReport

The change of value of period-end historical values.

Instances

Eq ReportType

Defined in Hledger.Reports.ReportOptions

Methods

(==) :: ReportType -> ReportType -> Bool

(/=) :: ReportType -> ReportType -> Bool

Show ReportType

Defined in Hledger.Reports.ReportOptions

Methods

showsPrec :: Int -> ReportType -> ShowS

show :: ReportType -> String

showList :: [ReportType] -> ShowS

Default ReportType

Defined in Hledger.Reports.ReportOptions

Methods

def :: ReportType

data BalanceType

Which "accumulation method" is being shown in a balance report.

Constructors

PeriodChange

The accumulate change over a single period.

CumulativeChange

The accumulated change across multiple periods.

HistoricalBalance

The historical ending balance, including the effect of all postings before the report period. Unless altered by, a query, this is what you would see on a bank statement.

Instances

Eq BalanceType

Defined in Hledger.Reports.ReportOptions

Methods

(==) :: BalanceType -> BalanceType -> Bool

(/=) :: BalanceType -> BalanceType -> Bool

Show BalanceType

Defined in Hledger.Reports.ReportOptions

Methods

showsPrec :: Int -> BalanceType -> ShowS

show :: BalanceType -> String

showList :: [BalanceType] -> ShowS

Default BalanceType

Defined in Hledger.Reports.ReportOptions

Methods

def :: BalanceType

data AccountListMode

Should accounts be displayed: in the command's default style, hierarchically, or as a flat list ?

Constructors

ALFlat

ALTree

Instances

Eq AccountListMode

Defined in Hledger.Reports.ReportOptions

Methods

(==) :: AccountListMode -> AccountListMode -> Bool

(/=) :: AccountListMode -> AccountListMode -> Bool

Show AccountListMode

Defined in Hledger.Reports.ReportOptions

Methods

showsPrec :: Int -> AccountListMode -> ShowS

show :: AccountListMode -> String

showList :: [AccountListMode] -> ShowS

Default AccountListMode

Defined in Hledger.Reports.ReportOptions

Methods

def :: AccountListMode

data ValuationType

What kind of value conversion should be done on amounts ? CLI: --value=then|end|now|DATE[,COMM]

Constructors

AtThen (Maybe CommoditySymbol)

convert to default or given valuation commodity, using market prices at each posting's date

AtEnd (Maybe CommoditySymbol)

convert to default or given valuation commodity, using market prices at period end(s)

AtNow (Maybe CommoditySymbol)

convert to default or given valuation commodity, using current market prices

AtDate Day (Maybe CommoditySymbol)

convert to default or given valuation commodity, using market prices on some date

Instances

Eq ValuationType

Defined in Hledger.Data.Valuation

Methods

(==) :: ValuationType -> ValuationType -> Bool

(/=) :: ValuationType -> ValuationType -> Bool

Show ValuationType

Defined in Hledger.Data.Valuation

Methods

showsPrec :: Int -> ValuationType -> ShowS

show :: ValuationType -> String

showList :: [ValuationType] -> ShowS

defreportopts :: ReportOpts

rawOptsToReportOpts :: Day -> RawOpts -> ReportOpts

Generate a ReportOpts from raw command-line input, given a day. This will fail with a usage error if it is passed - an invalid --format argument, - an invalid --value argument, - if --valuechange is called with a valuation type other than -V/--value=end.

defreportspec :: ReportSpec

reportOptsToSpec :: Day -> ReportOpts -> Either String ReportSpec

Generate a ReportSpec from a set of ReportOpts on a given day.

updateReportSpec :: ReportOpts -> ReportSpec -> Either String ReportSpec

Update the ReportOpts and the fields derived from it in a ReportSpec, or return an error message if there is a problem such as missing or unparseable options data. This is the safe way to change a ReportSpec, ensuring that all fields (rsQuery, rsOpts, querystring_, etc.) are in sync.

updateReportSpecWith :: (ReportOpts -> ReportOpts) -> ReportSpec -> Either String ReportSpec

Like updateReportSpec, but takes a ReportOpts-modifying function.

rawOptsToReportSpec :: RawOpts -> IO ReportSpec

Generate a ReportSpec from RawOpts and the current date.

balanceTypeOverride :: RawOpts -> Maybe BalanceType

flat_ :: ReportOpts -> Bool

tree_ :: ReportOpts -> Bool

Legacy-compatible convenience aliases for accountlistmode_.

reportOptsToggleStatus :: Status -> ReportOpts -> ReportOpts

Add/remove this status from the status list. Used by hledger-ui.

simplifyStatuses :: Ord a => [a] -> [a]

Reduce a list of statuses to just one of each status, and if all statuses are present return the empty list.

whichDateFromOpts :: ReportOpts -> WhichDate

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

journalApplyValuationFromOpts :: ReportSpec -> Journal -> Journal

Convert this journal's postings' amounts to cost and/or to value, if specified by options (-B--cost-V-X--value etc.). Strip prices if not needed. This should be the main stop for performing costing and valuation. The exception is whenever you need to perform valuation _after_ summing up amounts, as in a historical balance report with --value=end. valuationAfterSum will check for this condition.

journalApplyValuationFromOptsWith :: ReportSpec -> Journal -> PriceOracle -> Journal

Like journalApplyValuationFromOpts, but takes PriceOracle as an argument.

mixedAmountApplyValuationAfterSumFromOptsWith :: ReportOpts -> Journal -> PriceOracle -> DateSpan -> MixedAmount -> MixedAmount

Select the Account valuation functions required for performing valuation after summing amounts. Used in MultiBalanceReport to value historical and similar reports.

valuationAfterSum :: ReportOpts -> Maybe (Maybe CommoditySymbol)

If the ReportOpts specify that we are performing valuation after summing amounts, return Just the commodity symbol we're converting to, otherwise return Nothing. Used for example with historical reports with --value=end.

intervalFromRawOpts :: RawOpts -> Interval

Get the report interval, if any, specified by the last of -p/--period, -D--daily, -W--weekly, -M/--monthly etc. options. An interval from --period counts only if it is explicitly defined.

queryFromFlags :: ReportOpts -> Query

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

transactionDateFn :: ReportOpts -> Transaction -> Day

Select the Transaction date accessor based on --date2.

postingDateFn :: ReportOpts -> Posting -> Day

Select the Posting date accessor based on --date2.

reportSpan :: Journal -> ReportSpec -> DateSpan

The effective report span is the start and end dates specified by options or queries, or otherwise the earliest and latest transaction or posting dates in the journal. If no dates are specified by options/queries and the journal is empty, returns the null date span.

reportSpanBothDates :: Journal -> ReportSpec -> DateSpan

Like reportSpan, but uses both primary and secondary dates when calculating the span.

reportStartDate :: Journal -> ReportSpec -> Maybe Day

reportEndDate :: Journal -> ReportSpec -> Maybe Day

reportPeriodStart :: ReportSpec -> Maybe Day

reportPeriodOrJournalStart :: ReportSpec -> Journal -> Maybe Day

reportPeriodLastDay :: ReportSpec -> Maybe Day

reportPeriodOrJournalLastDay :: ReportSpec -> Journal -> Maybe Day

reportPeriodName :: BalanceType -> [DateSpan] -> DateSpan -> Text

Make a name for the given period in a multiperiod report, given the type of balance being reported and the full set of report periods. This will be used as a column heading (or row heading, in a register summary report). We try to pick a useful name as follows:

• ending-balance reports: the period's end date
• balance change reports where the periods are months and all in the same year: the short month name in the current locale
• all other balance change reports: a description of the datespan, abbreviated to compact form if possible (see showDateSpan).