hledger-lib-1.32.3: A library providing the core functionality of hledger

Safe Haskell | Safe-Inferred
Language | Haskell2010

Hledger.Reports.ReportOptions

Description

Options common to most hledger reports.

Synopsis

- data ReportOpts = ReportOpts {
  - period_ :: Period
  - interval_ :: Interval
  - statuses_ :: [Status]
  - conversionop_ :: Maybe ConversionOp
  - value_ :: Maybe ValuationType
  - infer_prices_ :: Bool
  - depth_ :: Maybe Int
  - date2_ :: Bool
  - empty_ :: Bool
  - no_elide_ :: Bool
  - real_ :: Bool
  - format_ :: StringFormat
  - pretty_ :: Bool
  - querystring_ :: [Text]
  - average_ :: Bool
  - related_ :: Bool
  - txn_dates_ :: Bool
  - balancecalc_ :: BalanceCalculation
  - balanceaccum_ :: BalanceAccumulation
  - budgetpat_ :: Maybe Text
  - accountlistmode_ :: AccountListMode
  - drop_ :: Int
  - declared_ :: Bool
  - row_total_ :: Bool
  - no_total_ :: Bool
  - summary_only_ :: Bool
  - show_costs_ :: Bool
  - sort_amount_ :: Bool
  - percent_ :: Bool
  - invert_ :: Bool
  - normalbalance_ :: Maybe NormalSign
  - color_ :: Bool
  - transpose_ :: Bool
  - layout_ :: Layout
  }
- class HasReportOptsNoUpdate c where
  - reportOptsNoUpdate :: Lens' c ReportOpts
  - accountlistmode :: Lens' c AccountListMode
  - average :: Lens' c Bool
  - balanceaccum :: Lens' c BalanceAccumulation
  - balancecalc :: Lens' c BalanceCalculation
  - budgetpat :: Lens' c (Maybe Text)
  - color__ :: Lens' c Bool
  - conversionop :: Lens' c (Maybe ConversionOp)
  - date2NoUpdate :: Lens' c Bool
  - declared :: Lens' c Bool
  - depthNoUpdate :: Lens' c (Maybe Int)
  - drop__ :: Lens' c Int
  - empty__ :: Lens' c Bool
  - format :: Lens' c StringFormat
  - infer_prices :: Lens' c Bool
  - interval :: Lens' c Interval
  - invert :: Lens' c Bool
  - layout :: Lens' c Layout
  - no_elide :: Lens' c Bool
  - no_total :: Lens' c Bool
  - normalbalance :: Lens' c (Maybe NormalSign)
  - percent :: Lens' c Bool
  - periodNoUpdate :: Lens' c Period
  - pretty :: Lens' c Bool
  - querystringNoUpdate :: Lens' c [Text]
  - realNoUpdate :: Lens' c Bool
  - related :: Lens' c Bool
  - row_total :: Lens' c Bool
  - show_costs :: Lens' c Bool
  - sort_amount :: Lens' c Bool
  - statusesNoUpdate :: Lens' c [Status]
  - summary_only :: Lens' c Bool
  - transpose__ :: Lens' c Bool
  - txn_dates :: Lens' c Bool
  - value :: Lens' c (Maybe ValuationType)
- class HasReportOptsNoUpdate a => HasReportOpts a where
  - reportOpts :: ReportableLens' a ReportOpts
  - period :: ReportableLens' a Period
  - statuses :: ReportableLens' a [Status]
  - depth :: ReportableLens' a (Maybe Int)
  - date2 :: ReportableLens' a Bool
  - real :: ReportableLens' a Bool
  - querystring :: ReportableLens' a [Text]
- data ReportSpec = ReportSpec {
  - _rsReportOpts :: ReportOpts
  - _rsDay :: Day
  - _rsQuery :: Query
  - _rsQueryOpts :: [QueryOpt]
  }
- class HasReportSpec c where
  - reportSpec :: Lens' c ReportSpec
  - rsDay :: Lens' c Day
  - rsQuery :: Lens' c Query
  - rsQueryOpts :: Lens' c [QueryOpt]
  - rsReportOpts :: Lens' c ReportOpts
- overEither :: ((a -> Either e b) -> s -> Either e t) -> (a -> b) -> s -> Either e t
- setEither :: ((a -> Either e b) -> s -> Either e t) -> b -> s -> Either e t
- data BalanceCalculation
  - = CalcChange
  - | CalcBudget
  - | CalcValueChange
  - | CalcGain
  - | CalcPostingsCount
- data BalanceAccumulation
  - = PerPeriod
  - | Cumulative
  - | Historical
- data AccountListMode
  - = ALFlat
  - | ALTree
- data ValuationType
  - = AtThen (Maybe CommoditySymbol)
  - | AtEnd (Maybe CommoditySymbol)
  - | AtNow (Maybe CommoditySymbol)
  - | AtDate Day (Maybe CommoditySymbol)
- data Layout
  - = LayoutWide (Maybe Int)
  - | LayoutTall
  - | LayoutBare
  - | LayoutTidy
- defreportopts :: ReportOpts
- rawOptsToReportOpts :: Day -> RawOpts -> ReportOpts
- defreportspec :: ReportSpec
- setDefaultConversionOp :: ConversionOp -> ReportSpec -> ReportSpec
- reportOptsToSpec :: Day -> ReportOpts -> Either String ReportSpec
- updateReportSpec :: ReportOpts -> ReportSpec -> Either String ReportSpec
- updateReportSpecWith :: (ReportOpts -> ReportOpts) -> ReportSpec -> Either String ReportSpec
- rawOptsToReportSpec :: Day -> RawOpts -> Either String ReportSpec
- balanceAccumulationOverride :: RawOpts -> Maybe BalanceAccumulation
- flat_ :: ReportOpts -> Bool
- tree_ :: ReportOpts -> Bool
- reportOptsToggleStatus :: Status -> ReportOpts -> ReportOpts
- simplifyStatuses :: Ord a => [a] -> [a]
- whichDate :: ReportOpts -> WhichDate
- journalValueAndFilterPostings :: ReportSpec -> Journal -> Journal
- journalValueAndFilterPostingsWith :: ReportSpec -> Journal -> PriceOracle -> Journal
- journalApplyValuationFromOpts :: ReportSpec -> Journal -> Journal
- journalApplyValuationFromOptsWith :: ReportSpec -> Journal -> PriceOracle -> Journal
- mixedAmountApplyValuationAfterSumFromOptsWith :: ReportOpts -> Journal -> PriceOracle -> DateSpan -> MixedAmount -> MixedAmount
- valuationAfterSum :: ReportOpts -> Maybe (Maybe CommoditySymbol)
- intervalFromRawOpts :: RawOpts -> Interval
- queryFromFlags :: ReportOpts -> Query
- transactionDateFn :: ReportOpts -> Transaction -> Day
- postingDateFn :: ReportOpts -> Posting -> Day
- reportSpan :: Journal -> ReportSpec -> (DateSpan, [DateSpan])
- reportSpanBothDates :: Journal -> ReportSpec -> (DateSpan, [DateSpan])
- 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 :: BalanceAccumulation -> [DateSpan] -> DateSpan -> Text

# Documentation

data ReportOpts Source #

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

- conversionop_ :: Maybe ConversionOp

  Which operation should we apply to conversion transactions?

- value_ :: Maybe ValuationType

  What value should amounts be converted to ?

- infer_prices_ :: Bool

  Infer market prices from transactions ?

- depth_ :: Maybe Int
- date2_ :: Bool
- empty_ :: Bool
- no_elide_ :: Bool
- real_ :: Bool
- format_ :: StringFormat
- pretty_ :: Bool
- querystring_ :: [Text]
- average_ :: Bool
- related_ :: Bool
- txn_dates_ :: Bool
- balancecalc_ :: BalanceCalculation

  What to calculate in balance report cells

- balanceaccum_ :: BalanceAccumulation

  How to accumulate balance report values over time

- budgetpat_ :: Maybe Text

  A case-insensitive description substring to select periodic transactions for budget reports. (Not a regexp, nor a full hledger query, for now.)

- accountlistmode_ :: AccountListMode
- drop_ :: Int
- declared_ :: Bool

  Include accounts declared but not yet posted to ?

- row_total_ :: Bool
- no_total_ :: Bool
- summary_only_ :: Bool
- show_costs_ :: Bool

  Show costs for reports which normally don't show them ?

- sort_amount_ :: Bool
- percent_ :: Bool
- invert_ :: Bool

  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
- layout_ :: Layout

#### Instances

Instances details

Show ReportOpts Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods showsPrec :: Int -> ReportOpts -> ShowS Source # show :: ReportOpts -> String Source # showList :: [ReportOpts] -> ShowS Source #
Default ReportOpts Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods def :: ReportOpts #
HasReportOpts ReportOpts Source # |

Instance details

Defined in Hledger.Reports.ReportOptions

Methods

reportOpts :: ReportableLens' ReportOpts ReportOpts Source #

period :: ReportableLens' ReportOpts Period Source #

statuses :: ReportableLens' ReportOpts [Status] Source #

depth :: ReportableLens' ReportOpts (Maybe Int) Source #

date2 :: ReportableLens' ReportOpts Bool Source #

real :: ReportableLens' ReportOpts Bool Source #

querystring :: ReportableLens' ReportOpts [Text] Source #

HasReportOptsNoUpdate ReportOpts Source # |

Instance details

Defined in Hledger.Reports.ReportOptions

Methods

reportOptsNoUpdate :: Lens' ReportOpts ReportOpts Source #

accountlistmode :: Lens' ReportOpts AccountListMode Source #

average :: Lens' ReportOpts Bool Source #

balanceaccum :: Lens' ReportOpts BalanceAccumulation Source #

balancecalc :: Lens' ReportOpts BalanceCalculation Source #

budgetpat :: Lens' ReportOpts (Maybe Text) Source #

color__ :: Lens' ReportOpts Bool Source #

conversionop :: Lens' ReportOpts (Maybe ConversionOp) Source #

date2NoUpdate :: Lens' ReportOpts Bool Source #

declared :: Lens' ReportOpts Bool Source #

depthNoUpdate :: Lens' ReportOpts (Maybe Int) Source #

drop__ :: Lens' ReportOpts Int Source #

empty__ :: Lens' ReportOpts Bool Source #

format :: Lens' ReportOpts StringFormat Source #

infer_prices :: Lens' ReportOpts Bool Source #

interval :: Lens' ReportOpts Interval Source #

invert :: Lens' ReportOpts Bool Source #

layout :: Lens' ReportOpts Layout Source #

no_elide :: Lens' ReportOpts Bool Source #

no_total :: Lens' ReportOpts Bool Source #

normalbalance :: Lens' ReportOpts (Maybe NormalSign) Source #

percent :: Lens' ReportOpts Bool Source #

periodNoUpdate :: Lens' ReportOpts Period Source #

pretty :: Lens' ReportOpts Bool Source #

querystringNoUpdate :: Lens' ReportOpts [Text] Source #

realNoUpdate :: Lens' ReportOpts Bool Source #

related :: Lens' ReportOpts Bool Source #

row_total :: Lens' ReportOpts Bool Source #

show_costs :: Lens' ReportOpts Bool Source #

sort_amount :: Lens' ReportOpts Bool Source #

statusesNoUpdate :: Lens' ReportOpts [Status] Source #

summary_only :: Lens' ReportOpts Bool Source #

transpose__ :: Lens' ReportOpts Bool Source #

txn_dates :: Lens' ReportOpts Bool Source #

value :: Lens' ReportOpts (Maybe ValuationType) Source #

class HasReportOptsNoUpdate c where Source #

Lenses for ReportOpts.

Minimal complete definition

reportOptsNoUpdate

Methods

reportOptsNoUpdate :: Lens' c ReportOpts Source #

accountlistmode :: Lens' c AccountListMode Source #

average :: Lens' c Bool Source #

balanceaccum :: Lens' c BalanceAccumulation Source #

balancecalc :: Lens' c BalanceCalculation Source #

budgetpat :: Lens' c (Maybe Text) Source #

color__ :: Lens' c Bool Source #

conversionop :: Lens' c (Maybe ConversionOp) Source #

date2NoUpdate :: Lens' c Bool Source #

declared :: Lens' c Bool Source #

depthNoUpdate :: Lens' c (Maybe Int) Source #

drop__ :: Lens' c Int Source #

empty__ :: Lens' c Bool Source #

format :: Lens' c StringFormat Source #

infer_prices :: Lens' c Bool Source #

interval :: Lens' c Interval Source #

invert :: Lens' c Bool Source #

layout :: Lens' c Layout Source #

no_elide :: Lens' c Bool Source #

no_total :: Lens' c Bool Source #

normalbalance :: Lens' c (Maybe NormalSign) Source #

percent :: Lens' c Bool Source #

periodNoUpdate :: Lens' c Period Source #

pretty :: Lens' c Bool Source #

querystringNoUpdate :: Lens' c [Text] Source #

realNoUpdate :: Lens' c Bool Source #

related :: Lens' c Bool Source #

row_total :: Lens' c Bool Source #

show_costs :: Lens' c Bool Source #

sort_amount :: Lens' c Bool Source #

statusesNoUpdate :: Lens' c [Status] Source #

summary_only :: Lens' c Bool Source #

transpose__ :: Lens' c Bool Source #

txn_dates :: Lens' c Bool Source #

value :: Lens' c (Maybe ValuationType) Source #

#### Instances

Instances details

HasReportOptsNoUpdate ReportOpts Source # |

Instance details

Defined in Hledger.Reports.ReportOptions

Methods

reportOptsNoUpdate :: Lens' ReportOpts ReportOpts Source #

accountlistmode :: Lens' ReportOpts AccountListMode Source #

average :: Lens' ReportOpts Bool Source #

balanceaccum :: Lens' ReportOpts BalanceAccumulation Source #

balancecalc :: Lens' ReportOpts BalanceCalculation Source #

budgetpat :: Lens' ReportOpts (Maybe Text) Source #

color__ :: Lens' ReportOpts Bool Source #

conversionop :: Lens' ReportOpts (Maybe ConversionOp) Source #

date2NoUpdate :: Lens' ReportOpts Bool Source #

declared :: Lens' ReportOpts Bool Source #

depthNoUpdate :: Lens' ReportOpts (Maybe Int) Source #

drop__ :: Lens' ReportOpts Int Source #

empty__ :: Lens' ReportOpts Bool Source #

format :: Lens' ReportOpts StringFormat Source #

infer_prices :: Lens' ReportOpts Bool Source #

interval :: Lens' ReportOpts Interval Source #

invert :: Lens' ReportOpts Bool Source #

layout :: Lens' ReportOpts Layout Source #

no_elide :: Lens' ReportOpts Bool Source #

no_total :: Lens' ReportOpts Bool Source #

normalbalance :: Lens' ReportOpts (Maybe NormalSign) Source #

percent :: Lens' ReportOpts Bool Source #

periodNoUpdate :: Lens' ReportOpts Period Source #

pretty :: Lens' ReportOpts Bool Source #

querystringNoUpdate :: Lens' ReportOpts [Text] Source #

realNoUpdate :: Lens' ReportOpts Bool Source #

related :: Lens' ReportOpts Bool Source #

row_total :: Lens' ReportOpts Bool Source #

show_costs :: Lens' ReportOpts Bool Source #

sort_amount :: Lens' ReportOpts Bool Source #

statusesNoUpdate :: Lens' ReportOpts [Status] Source #

summary_only :: Lens' ReportOpts Bool Source #

transpose__ :: Lens' ReportOpts Bool Source #

txn_dates :: Lens' ReportOpts Bool Source #

value :: Lens' ReportOpts (Maybe ValuationType) Source #

HasReportOptsNoUpdate ReportSpec Source # |

Instance details

Defined in Hledger.Reports.ReportOptions

Methods

reportOptsNoUpdate :: Lens' ReportSpec ReportOpts Source #

accountlistmode :: Lens' ReportSpec AccountListMode Source #

average :: Lens' ReportSpec Bool Source #

balanceaccum :: Lens' ReportSpec BalanceAccumulation Source #

balancecalc :: Lens' ReportSpec BalanceCalculation Source #

budgetpat :: Lens' ReportSpec (Maybe Text) Source #

color__ :: Lens' ReportSpec Bool Source #

conversionop :: Lens' ReportSpec (Maybe ConversionOp) Source #

date2NoUpdate :: Lens' ReportSpec Bool Source #

declared :: Lens' ReportSpec Bool Source #

depthNoUpdate :: Lens' ReportSpec (Maybe Int) Source #

drop__ :: Lens' ReportSpec Int Source #

empty__ :: Lens' ReportSpec Bool Source #

format :: Lens' ReportSpec StringFormat Source #

infer_prices :: Lens' ReportSpec Bool Source #

interval :: Lens' ReportSpec Interval Source #

invert :: Lens' ReportSpec Bool Source #

layout :: Lens' ReportSpec Layout Source #

no_elide :: Lens' ReportSpec Bool Source #

no_total :: Lens' ReportSpec Bool Source #

normalbalance :: Lens' ReportSpec (Maybe NormalSign) Source #

percent :: Lens' ReportSpec Bool Source #

periodNoUpdate :: Lens' ReportSpec Period Source #

pretty :: Lens' ReportSpec Bool Source #

querystringNoUpdate :: Lens' ReportSpec [Text] Source #

realNoUpdate :: Lens' ReportSpec Bool Source #

related :: Lens' ReportSpec Bool Source #

row_total :: Lens' ReportSpec Bool Source #

show_costs :: Lens' ReportSpec Bool Source #

sort_amount :: Lens' ReportSpec Bool Source #

statusesNoUpdate :: Lens' ReportSpec [Status] Source #

summary_only :: Lens' ReportSpec Bool Source #

transpose__ :: Lens' ReportSpec Bool Source #

txn_dates :: Lens' ReportSpec Bool Source #

value :: Lens' ReportSpec (Maybe ValuationType) Source #

class HasReportOptsNoUpdate a => HasReportOpts a where Source #

Special lenses for ReportOpts which also update the Query and QueryOpts in ReportSpec. Note that these are not true lenses, as they have a further restriction on the functor. This will work as a normal lens for all common uses, but since they don't obey the lens laws for some fancy cases, they may fail in some exotic circumstances.

Note that setEither/overEither should only be necessary with querystring and reportOpts: the other lenses should never fail.

### Examples:

    >>> import Lens.Micro (set)
    >>> _rsQuery <$> setEither querystring ["assets"] defreportspec
    Right (Acct (RegexpCI "assets"))
    >>> _rsQuery <$> setEither querystring ["(assets"] defreportspec
    Left "This regular expression is malformed, please correct it:\n(assets"
    >>> _rsQuery $ set querystring ["assets"] defreportspec
    Acct (RegexpCI "assets")
    >>> _rsQuery $ set querystring ["(assets"] defreportspec
    *** Exception: Error: Updating ReportSpec failed: try using overEither instead of over or setEither instead of set
    >>> _rsQuery $ set period (MonthPeriod 2021 08) defreportspec
    Date DateSpan 2021-08

Minimal complete definition

Nothing

Methods

reportOpts :: ReportableLens' a ReportOpts Source #

period :: ReportableLens' a Period Source #

statuses :: ReportableLens' a [Status] Source #

depth :: ReportableLens' a (Maybe Int) Source #

date2 :: ReportableLens' a Bool Source #

real :: ReportableLens' a Bool Source #

querystring :: ReportableLens' a [Text] Source #

#### Instances

Instances details

HasReportOpts ReportOpts Source # |

Instance details

Defined in Hledger.Reports.ReportOptions

Methods

reportOpts :: ReportableLens' ReportOpts ReportOpts Source #

period :: ReportableLens' ReportOpts Period Source #

statuses :: ReportableLens' ReportOpts [Status] Source #

depth :: ReportableLens' ReportOpts (Maybe Int) Source #

date2 :: ReportableLens' ReportOpts Bool Source #

real :: ReportableLens' ReportOpts Bool Source #

querystring :: ReportableLens' ReportOpts [Text] Source #

HasReportOpts ReportSpec Source # |

Instance details

Defined in Hledger.Reports.ReportOptions

Methods

reportOpts :: ReportableLens' ReportSpec ReportOpts Source #

period :: ReportableLens' ReportSpec Period Source #

statuses :: ReportableLens' ReportSpec [Status] Source #

depth :: ReportableLens' ReportSpec (Maybe Int) Source #

date2 :: ReportableLens' ReportSpec Bool Source #

real :: ReportableLens' ReportSpec Bool Source #

querystring :: ReportableLens' ReportSpec [Text] Source #

data ReportSpec Source #

A fully-determined set of report parameters (report options with all partial values made total, eg the begin and end dates are known, avoiding date/regex errors; plus the reporting date), and the query successfully calculated from them.

If you change the report options or date in one of these, you should use `reportOptsToSpec` to regenerate the whole thing, avoiding inconsistency.

Constructors

ReportSpec |

Fields

- _rsReportOpts :: ReportOpts

  The underlying ReportOpts used to generate this ReportSpec

- _rsDay :: 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

Instances details

Show ReportSpec Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods showsPrec :: Int -> ReportSpec -> ShowS Source # show :: ReportSpec -> String Source # showList :: [ReportSpec] -> ShowS Source #
Default ReportSpec Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods def :: ReportSpec #
HasReportOpts ReportSpec Source # |

Instance details

Defined in Hledger.Reports.ReportOptions

Methods

reportOpts :: ReportableLens' ReportSpec ReportOpts Source #

period :: ReportableLens' ReportSpec Period Source #

statuses :: ReportableLens' ReportSpec [Status] Source #

depth :: ReportableLens' ReportSpec (Maybe Int) Source #

date2 :: ReportableLens' ReportSpec Bool Source #

real :: ReportableLens' ReportSpec Bool Source #

querystring :: ReportableLens' ReportSpec [Text] Source #

HasReportOptsNoUpdate ReportSpec Source # |

Instance details

Defined in Hledger.Reports.ReportOptions

Methods

reportOptsNoUpdate :: Lens' ReportSpec ReportOpts Source #

accountlistmode :: Lens' ReportSpec AccountListMode Source #

average :: Lens' ReportSpec Bool Source #

balanceaccum :: Lens' ReportSpec BalanceAccumulation Source #

balancecalc :: Lens' ReportSpec BalanceCalculation Source #

budgetpat :: Lens' ReportSpec (Maybe Text) Source #

color__ :: Lens' ReportSpec Bool Source #

conversionop :: Lens' ReportSpec (Maybe ConversionOp) Source #

date2NoUpdate :: Lens' ReportSpec Bool Source #

declared :: Lens' ReportSpec Bool Source #

depthNoUpdate :: Lens' ReportSpec (Maybe Int) Source #

drop__ :: Lens' ReportSpec Int Source #

empty__ :: Lens' ReportSpec Bool Source #

format :: Lens' ReportSpec StringFormat Source #

infer_prices :: Lens' ReportSpec Bool Source #

interval :: Lens' ReportSpec Interval Source #

invert :: Lens' ReportSpec Bool Source #

layout :: Lens' ReportSpec Layout Source #

no_elide :: Lens' ReportSpec Bool Source #

no_total :: Lens' ReportSpec Bool Source #

normalbalance :: Lens' ReportSpec (Maybe NormalSign) Source #

percent :: Lens' ReportSpec Bool Source #

periodNoUpdate :: Lens' ReportSpec Period Source #

pretty :: Lens' ReportSpec Bool Source #

querystringNoUpdate :: Lens' ReportSpec [Text] Source #

realNoUpdate :: Lens' ReportSpec Bool Source #

related :: Lens' ReportSpec Bool Source #

row_total :: Lens' ReportSpec Bool Source #

show_costs :: Lens' ReportSpec Bool Source #

sort_amount :: Lens' ReportSpec Bool Source #

statusesNoUpdate :: Lens' ReportSpec [Status] Source #

summary_only :: Lens' ReportSpec Bool Source #

transpose__ :: Lens' ReportSpec Bool Source #

txn_dates :: Lens' ReportSpec Bool Source #

value :: Lens' ReportSpec (Maybe ValuationType) Source #

HasReportSpec ReportSpec Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods reportSpec :: Lens' ReportSpec ReportSpec Source # rsDay :: Lens' ReportSpec Day Source # rsQuery :: Lens' ReportSpec Query Source # rsQueryOpts :: Lens' ReportSpec [QueryOpt] Source # rsReportOpts :: Lens' ReportSpec ReportOpts Source #

class HasReportSpec c where Source #

Minimal complete definition

reportSpec

Methods

reportSpec :: Lens' c ReportSpec Source #

rsDay :: Lens' c Day Source #

rsQuery :: Lens' c Query Source #

rsQueryOpts :: Lens' c [QueryOpt] Source #

rsReportOpts :: Lens' c ReportOpts Source #

#### Instances

Instances details

HasReportSpec ReportSpec Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods reportSpec :: Lens' ReportSpec ReportSpec Source # rsDay :: Lens' ReportSpec Day Source # rsQuery :: Lens' ReportSpec Query Source # rsQueryOpts :: Lens' ReportSpec [QueryOpt] Source # rsReportOpts :: Lens' ReportSpec ReportOpts Source #

overEither :: ((a -> Either e b) -> s -> Either e t) -> (a -> b) -> s -> Either e t Source #

Apply a function over a lens, but report on failure.

setEither :: ((a -> Either e b) -> s -> Either e t) -> b -> s -> Either e t Source #

Set a field using a lens, but report on failure.

data BalanceCalculation Source #

What to calculate for each cell in a balance report. "Balance report types -> Calculation type" in the hledger manual.

Constructors

CalcChange | Sum of posting amounts in the period.
CalcBudget | Sum of posting amounts and the goal for the period.
CalcValueChange | Change from previous period's historical end value to this period's historical end value.
CalcGain | Change from previous period's gain, i.e. valuation minus cost basis.
CalcPostingsCount | Number of postings in the period.

#### Instances

Instances details

Show BalanceCalculation Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods showsPrec :: Int -> BalanceCalculation -> ShowS Source # show :: BalanceCalculation -> String Source # showList :: [BalanceCalculation] -> ShowS Source #
Default BalanceCalculation Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods def :: BalanceCalculation #
Eq BalanceCalculation Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods (==) :: BalanceCalculation -> BalanceCalculation -> Bool Source # (/=) :: BalanceCalculation -> BalanceCalculation -> Bool Source #

data BalanceAccumulation Source #

How to accumulate calculated values across periods (columns) in a balance report. "Balance report types -> Accumulation type" in the hledger manual.

Constructors

PerPeriod | No accumulation. Eg, shows the change of balance in each period.
Cumulative | Accumulate changes across periods, starting from zero at report start.
Historical | Accumulate changes across periods, including any from before report start. Eg, shows the historical end balance of each period.

#### Instances

Instances details

Show BalanceAccumulation Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods showsPrec :: Int -> BalanceAccumulation -> ShowS Source # show :: BalanceAccumulation -> String Source # showList :: [BalanceAccumulation] -> ShowS Source #
Default BalanceAccumulation Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods def :: BalanceAccumulation #
Eq BalanceAccumulation Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods (==) :: BalanceAccumulation -> BalanceAccumulation -> Bool Source # (/=) :: BalanceAccumulation -> BalanceAccumulation -> Bool Source #

data AccountListMode Source #

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

Constructors

ALFlat |
ALTree |

#### Instances

Instances details

Show AccountListMode Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods showsPrec :: Int -> AccountListMode -> ShowS Source # show :: AccountListMode -> String Source # showList :: [AccountListMode] -> ShowS Source #
Default AccountListMode Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods def :: AccountListMode #
Eq AccountListMode Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods (==) :: AccountListMode -> AccountListMode -> Bool Source # (/=) :: AccountListMode -> AccountListMode -> Bool Source #

data ValuationType Source #

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

Instances details

Show ValuationType Source # |
Instance details Defined in Hledger.Data.Valuation Methods showsPrec :: Int -> ValuationType -> ShowS Source # show :: ValuationType -> String Source # showList :: [ValuationType] -> ShowS Source #
Eq ValuationType Source # |
Instance details Defined in Hledger.Data.Valuation Methods (==) :: ValuationType -> ValuationType -> Bool Source # (/=) :: ValuationType -> ValuationType -> Bool Source #

data Layout Source #

Constructors

LayoutWide (Maybe Int) |
LayoutTall |
LayoutBare |
LayoutTidy |

#### Instances

Instances details

Show Layout Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods showsPrec :: Int -> Layout -> ShowS Source # show :: Layout -> String Source # showList :: [Layout] -> ShowS Source #
Eq Layout Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods (==) :: Layout -> Layout -> Bool Source # (/=) :: Layout -> Layout -> Bool Source #

defreportopts :: ReportOpts Source #

rawOptsToReportOpts :: Day -> RawOpts -> ReportOpts Source #

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. - an invalid --pretty argument,

defreportspec :: ReportSpec Source #

setDefaultConversionOp :: ConversionOp -> ReportSpec -> ReportSpec Source #

Set the default ConversionOp.

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

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

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

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, _rsReportOpts, querystring_, etc.) are in sync.

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

Like updateReportSpec, but takes a ReportOpts-modifying function.

rawOptsToReportSpec :: Day -> RawOpts -> Either String ReportSpec Source #

Generate a ReportSpec from RawOpts and a provided day, or return an error string if there are regular expression errors.

balanceAccumulationOverride :: RawOpts -> Maybe BalanceAccumulation Source #

flat_ :: ReportOpts -> Bool Source #

tree_ :: ReportOpts -> Bool Source #

Legacy-compatible convenience aliases for accountlistmode_.

reportOptsToggleStatus :: Status -> ReportOpts -> ReportOpts Source #

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

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

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

whichDate :: ReportOpts -> WhichDate Source #

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

journalValueAndFilterPostings :: ReportSpec -> Journal -> Journal Source #

Convert a `Journal'`s amounts to cost and/or to value (see `journalApplyValuationFromOpts`), and filter by the `ReportSpec` `Query`.

We make sure to first filter by amt: and cur: terms, then value the `Journal`, then filter by the remaining terms.

journalValueAndFilterPostingsWith :: ReportSpec -> Journal -> PriceOracle -> Journal Source #

Like `journalValueAndFilterPostings`, but takes a `PriceOracle` as an argument.

journalApplyValuationFromOpts :: ReportSpec -> Journal -> Journal Source #

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 Source #

Like journalApplyValuationFromOpts, but takes PriceOracle as an argument.

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

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) Source #

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

intervalFromRawOpts :: RawOpts -> Interval Source #

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 Source #

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

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.

reportSpan :: Journal -> ReportSpec -> (DateSpan, [DateSpan]) Source #

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. Also return the intervals if they are requested.

reportSpanBothDates :: Journal -> ReportSpec -> (DateSpan, [DateSpan]) Source #

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

reportStartDate :: Journal -> ReportSpec -> Maybe Day Source #

reportEndDate :: Journal -> ReportSpec -> Maybe Day Source #

reportPeriodStart :: ReportSpec -> Maybe Day Source #

reportPeriodOrJournalStart :: ReportSpec -> Journal -> Maybe Day Source #

reportPeriodLastDay :: ReportSpec -> Maybe Day Source #

reportPeriodOrJournalLastDay :: ReportSpec -> Journal -> Maybe Day Source #

reportPeriodName :: BalanceAccumulation -> [DateSpan] -> DateSpan -> Text Source #

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