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

Safe HaskellNone
LanguageHaskell2010

Hledger.Reports.ReportOptions

Description

Options common to most hledger reports.

Synopsis

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

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

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

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

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

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

Default AccountListMode Source # 
Instance details

Defined in Hledger.Reports.ReportOptions

checkReportOpts :: ReportOpts -> ReportOpts Source #

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

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.

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.