Safe Haskell	None
Language	Haskell2010

Hledger.Reports.ReportOptions

Description

Options common to most hledger reports.

Synopsis

data ReportOpts = ReportOpts {
- today_ :: Maybe Day
- period_ :: Period
- interval_ :: Interval
- statuses_ :: [Status]
- value_ :: Maybe ValuationType
- 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
- pretty_tables_ :: Bool
- sort_amount_ :: Bool
- percent_ :: Bool
- invert_ :: Bool
- normalbalance_ :: Maybe NormalSign
- color_ :: Bool
- forecast_ :: Bool
- transpose_ :: Bool
}
data BalanceType
- = PeriodChange
- | CumulativeChange
- | HistoricalBalance
data AccountListMode
- = ALDefault
- | ALTree
- | ALFlat
data ValuationType
- = AtCost (Maybe CommoditySymbol)
- | AtEnd (Maybe CommoditySymbol)
- | AtNow (Maybe CommoditySymbol)
- | AtDate Day (Maybe CommoditySymbol)
- | AtDefault (Maybe CommoditySymbol)
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)
reportPeriodStart :: ReportOpts -> Maybe Day
reportPeriodOrJournalStart :: ReportOpts -> Journal -> Maybe Day
reportPeriodLastDay :: ReportOpts -> Maybe Day
reportPeriodOrJournalLastDay :: ReportOpts -> Journal -> Maybe Day
valuationTypeIsCost :: ReportOpts -> Bool
valuationTypeIsDefaultValue :: ReportOpts -> Bool
tests_ReportOptions :: TestTree

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

today_ :: Maybe Day
The current date. A late addition to ReportOpts. Optional, but when set it may affect some reports: Reports use it when picking a -V valuation date. This is not great, adds indeterminacy.
period_ :: Period
interval_ :: Interval
statuses_ :: [Status]
Zero, one, or two statuses to be matched
value_ :: Maybe ValuationType
What value should amounts be converted to ?
depth_ :: Maybe Int
display_ :: Maybe DisplayExp
date2_ :: Bool
empty_ :: Bool
no_elide_ :: Bool
real_ :: Bool
format_ :: Maybe FormatStr
query_ :: String
All query arguments space sepeareted and quoted if needed (see quoteIfNeeded)
average_ :: Bool
related_ :: Bool
balancetype_ :: BalanceType
accountlistmode_ :: AccountListMode
drop_ :: Int
row_total_ :: Bool
no_total_ :: Bool
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
forecast_ :: Bool
transpose_ :: 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 # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ReportOpts # toConstr :: ReportOpts -> Constr # dataTypeOf :: ReportOpts -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ReportOpts) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ReportOpts) # gmapT :: (forall b. Data b => b -> b) -> ReportOpts -> ReportOpts # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ReportOpts -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ReportOpts -> r # gmapQ :: (forall d. Data d => d -> u) -> ReportOpts -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ReportOpts -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ReportOpts -> m ReportOpts # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ReportOpts -> m ReportOpts # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ReportOpts -> m ReportOpts #
Show ReportOpts Source #
Instance details Defined in Hledger.Reports.ReportOptions Methods showsPrec :: Int -> ReportOpts -> ShowS # show :: ReportOpts -> String # showList :: [ReportOpts] -> ShowS #
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 # (/=) :: BalanceType -> BalanceType -> Bool #
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 # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BalanceType # toConstr :: BalanceType -> Constr # dataTypeOf :: BalanceType -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BalanceType) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BalanceType) # gmapT :: (forall b. Data b => b -> b) -> BalanceType -> BalanceType # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BalanceType -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BalanceType -> r # gmapQ :: (forall d. Data d => d -> u) -> BalanceType -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> BalanceType -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> BalanceType -> m BalanceType # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BalanceType -> m BalanceType # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BalanceType -> m BalanceType #
Show BalanceType Source #
Instance details Defined in Hledger.Reports.ReportOptions Methods showsPrec :: Int -> BalanceType -> ShowS # show :: BalanceType -> String # showList :: [BalanceType] -> ShowS #
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 # (/=) :: AccountListMode -> AccountListMode -> Bool #
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 # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AccountListMode # toConstr :: AccountListMode -> Constr # dataTypeOf :: AccountListMode -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AccountListMode) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AccountListMode) # gmapT :: (forall b. Data b => b -> b) -> AccountListMode -> AccountListMode # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AccountListMode -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AccountListMode -> r # gmapQ :: (forall d. Data d => d -> u) -> AccountListMode -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AccountListMode -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AccountListMode -> m AccountListMode # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AccountListMode -> m AccountListMode # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AccountListMode -> m AccountListMode #
Show AccountListMode Source #
Instance details Defined in Hledger.Reports.ReportOptions Methods showsPrec :: Int -> AccountListMode -> ShowS # show :: AccountListMode -> String # showList :: [AccountListMode] -> ShowS #
Default AccountListMode Source #
Instance details Defined in Hledger.Reports.ReportOptions Methods def :: AccountListMode #

data ValuationType Source #

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

Constructors

AtCost (Maybe CommoditySymbol)	convert to cost commodity using transaction prices, then optionally to given commodity using market prices at posting date
AtEnd (Maybe CommoditySymbol)	convert to default valuation commodity or given commodity, using market prices at period end(s)
AtNow (Maybe CommoditySymbol)	convert to default valuation commodity or given commodity, using current market prices
AtDate Day (Maybe CommoditySymbol)	convert to default valuation commodity or given commodity, using market prices on some date
AtDefault (Maybe CommoditySymbol)	works like AtNow in single period reports, like AtEnd in multiperiod reports

Instances

Eq ValuationType Source #
Instance details Defined in Hledger.Data.Valuation Methods (==) :: ValuationType -> ValuationType -> Bool # (/=) :: ValuationType -> ValuationType -> Bool #
Data ValuationType Source #
Instance details Defined in Hledger.Data.Valuation Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ValuationType -> c ValuationType # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ValuationType # toConstr :: ValuationType -> Constr # dataTypeOf :: ValuationType -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ValuationType) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ValuationType) # gmapT :: (forall b. Data b => b -> b) -> ValuationType -> ValuationType # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ValuationType -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ValuationType -> r # gmapQ :: (forall d. Data d => d -> u) -> ValuationType -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ValuationType -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ValuationType -> m ValuationType # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ValuationType -> m ValuationType # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ValuationType -> m ValuationType #
Show ValuationType Source #
Instance details Defined in Hledger.Data.Valuation Methods showsPrec :: Int -> ValuationType -> ShowS # show :: ValuationType -> String # showList :: [ValuationType] -> ShowS #

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 cost using their transaction prices, if specified by options (-B/--value=cost). Maybe soon superseded by newer valuation code.

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.

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 #

reportPeriodStart :: ReportOpts -> Maybe Day Source #

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

reportPeriodLastDay :: ReportOpts -> Maybe Day Source #

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

valuationTypeIsCost :: ReportOpts -> Bool Source #

valuationTypeIsDefaultValue :: ReportOpts -> Bool Source #

tests_ReportOptions :: TestTree Source #