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

Safe Haskell | None
Language | Haskell2010

Hledger.Reports.ReportOptions

Description

Options common to most hledger reports.

Synopsis

- data ReportOpts = ReportOpts {
  - period_ :: Period
  - interval_ :: Interval
  - statuses_ :: [Status]
  - cost_ :: Bool
  - depth_ :: Maybe Int
  - display_ :: Maybe DisplayExp
  - date2_ :: Bool
  - empty_ :: Bool
  - no_elide_ :: Bool
  - real_ :: Bool
  - format_ :: Maybe FormatStr
  - query_ :: String
  - average_ :: Bool
  - related_ :: Bool
  - balancetype_ :: BalanceType
  - accountlistmode_ :: AccountListMode
  - drop_ :: Int
  - row_total_ :: Bool
  - no_total_ :: Bool
  - value_ :: Bool
  - pretty_tables_ :: Bool
  - sort_amount_ :: Bool
  - invert_ :: Bool
  - normalbalance_ :: Maybe NormalSign
  - color_ :: Bool
  - forecast_ :: Bool
  }
- data BalanceType
  - = PeriodChange
  - | CumulativeChange
  - | HistoricalBalance
- data AccountListMode
  - = ALDefault
  - | ALTree
  - | ALFlat
- type FormatStr = String
- defreportopts :: ReportOpts
- rawOptsToReportOpts :: RawOpts -> IO ReportOpts
- checkReportOpts :: ReportOpts -> ReportOpts
- flat_ :: ReportOpts -> Bool
- tree_ :: ReportOpts -> Bool
- reportOptsToggleStatus :: Status -> ReportOpts -> ReportOpts
- simplifyStatuses :: Ord a => [a] -> [a]
- whichDateFromOpts :: ReportOpts -> WhichDate
- journalSelectingAmountFromOpts :: ReportOpts -> Journal -> Journal
- intervalFromRawOpts :: RawOpts -> Interval
- queryFromOpts :: Day -> ReportOpts -> Query
- queryFromOptsOnly :: Day -> ReportOpts -> Query
- queryOptsFromOpts :: Day -> ReportOpts -> [QueryOpt]
- transactionDateFn :: ReportOpts -> Transaction -> Day
- postingDateFn :: ReportOpts -> Posting -> Day
- reportSpan :: Journal -> ReportOpts -> IO DateSpan
- reportStartDate :: Journal -> ReportOpts -> IO (Maybe Day)
- reportEndDate :: Journal -> ReportOpts -> IO (Maybe Day)
- specifiedStartEndDates :: ReportOpts -> IO (Maybe Day, Maybe Day)
- specifiedStartDate :: ReportOpts -> IO (Maybe Day)
- specifiedEndDate :: ReportOpts -> IO (Maybe Day)
- tests_ReportOptions :: Test ()

# 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

- cost_ :: Bool
- depth_ :: Maybe Int
- display_ :: Maybe DisplayExp
- date2_ :: Bool
- empty_ :: Bool
- no_elide_ :: Bool
- real_ :: Bool
- format_ :: Maybe FormatStr
- query_ :: String
- average_ :: Bool
- related_ :: Bool
- balancetype_ :: BalanceType
- accountlistmode_ :: AccountListMode
- drop_ :: Int
- row_total_ :: Bool
- no_total_ :: Bool
- value_ :: Bool
- pretty_tables_ :: Bool
- sort_amount_ :: 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
- forecast_ :: Bool

Instances

Data ReportOpts Source # |

Instance details

Defined in Hledger.Reports.ReportOptions

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ReportOpts -> c ReportOpts Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ReportOpts Source #

toConstr :: ReportOpts -> Constr Source #

dataTypeOf :: ReportOpts -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ReportOpts) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ReportOpts) Source #

gmapT :: (forall b. Data b => b -> b) -> ReportOpts -> ReportOpts Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ReportOpts -> r Source #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ReportOpts -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> ReportOpts -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ReportOpts -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ReportOpts -> m ReportOpts Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ReportOpts -> m ReportOpts Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ReportOpts -> m ReportOpts Source #

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 #

data BalanceType Source #

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

Constructors

PeriodChange | The change of balance in each 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 Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods (==) :: BalanceType -> BalanceType -> Bool Source # (/=) :: BalanceType -> BalanceType -> Bool Source #
Data BalanceType Source # |

Instance details

Defined in Hledger.Reports.ReportOptions

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BalanceType -> c BalanceType Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BalanceType Source #

toConstr :: BalanceType -> Constr Source #

dataTypeOf :: BalanceType -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BalanceType) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BalanceType) Source #

gmapT :: (forall b. Data b => b -> b) -> BalanceType -> BalanceType Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BalanceType -> r Source #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BalanceType -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> BalanceType -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> BalanceType -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BalanceType -> m BalanceType Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BalanceType -> m BalanceType Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BalanceType -> m BalanceType Source #

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

data AccountListMode Source #

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

Constructors

ALDefault |
ALTree |
ALFlat |

Instances

Eq AccountListMode Source # |
Instance details Defined in Hledger.Reports.ReportOptions Methods (==) :: AccountListMode -> AccountListMode -> Bool Source # (/=) :: AccountListMode -> AccountListMode -> Bool Source #
Data AccountListMode Source # |

Instance details

Defined in Hledger.Reports.ReportOptions

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AccountListMode -> c AccountListMode Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AccountListMode Source #

toConstr :: AccountListMode -> Constr Source #

dataTypeOf :: AccountListMode -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AccountListMode) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AccountListMode) Source #

gmapT :: (forall b. Data b => b -> b) -> AccountListMode -> AccountListMode Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AccountListMode -> r Source #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AccountListMode -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> AccountListMode -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AccountListMode -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AccountListMode -> m AccountListMode Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AccountListMode -> m AccountListMode Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AccountListMode -> m AccountListMode Source #

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 #

type FormatStr = String Source #

defreportopts :: ReportOpts Source #

rawOptsToReportOpts :: RawOpts -> IO ReportOpts Source #

checkReportOpts :: ReportOpts -> ReportOpts Source #

Do extra validation of report options, raising an error if there's a problem.

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.

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.

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.

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.

reportSpan :: Journal -> ReportOpts -> IO 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. Needs IO to parse smart dates in options/queries.

reportStartDate :: Journal -> ReportOpts -> IO (Maybe Day) Source #

reportEndDate :: Journal -> ReportOpts -> IO (Maybe Day) Source #

specifiedStartEndDates :: ReportOpts -> IO (Maybe Day, Maybe Day) Source #

The specified report start/end dates are the dates specified by options or queries, if any. Needs IO to parse smart dates in options/queries.

specifiedStartDate :: ReportOpts -> IO (Maybe Day) Source #

specifiedEndDate :: ReportOpts -> IO (Maybe Day) Source #

tests_ReportOptions :: Test () Source #