{-|

Options common to most hledger reports.

-}

{-# LANGUAGE FlexibleContexts      #-}
{-# LANGUAGE FlexibleInstances     #-}
{-# LANGUAGE LambdaCase            #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE OverloadedStrings     #-}
{-# LANGUAGE RankNTypes            #-}
{-# LANGUAGE RecordWildCards       #-}
{-# LANGUAGE TemplateHaskell       #-}
{-# LANGUAGE TypeFamilies          #-}
{-# LANGUAGE TypeOperators #-}

module Hledger.Reports.ReportOptions (
  ReportOpts(..),
  HasReportOptsNoUpdate(..),
  HasReportOpts(..),
  ReportSpec(..),
  HasReportSpec(..),
  overEither,
  setEither,
  BalanceCalculation(..),
  BalanceAccumulation(..),
  AccountListMode(..),
  ValuationType(..),
  Layout(..),
  defreportopts,
  rawOptsToReportOpts,
  defreportspec,
  setDefaultConversionOp,
  reportOptsToSpec,
  updateReportSpec,
  updateReportSpecWith,
  rawOptsToReportSpec,
  balanceAccumulationOverride,
  flat_,
  tree_,
  reportOptsToggleStatus,
  simplifyStatuses,
  whichDate,
  journalValueAndFilterPostings,
  journalValueAndFilterPostingsWith,
  journalApplyValuationFromOpts,
  journalApplyValuationFromOptsWith,
  mixedAmountApplyValuationAfterSumFromOptsWith,
  valuationAfterSum,
  intervalFromRawOpts,
  queryFromFlags,
  transactionDateFn,
  postingDateFn,
  reportSpan,
  reportSpanBothDates,
  reportStartDate,
  reportEndDate,
  reportPeriodStart,
  reportPeriodOrJournalStart,
  reportPeriodLastDay,
  reportPeriodOrJournalLastDay,
  reportPeriodName
)
where

import Prelude hiding (Applicative(..))
import Control.Applicative (Applicative(..), Const(..), (<|>))
import Control.Monad ((<=<), guard, join)
import Data.Char (toLower)
import Data.Either (fromRight)
import Data.Either.Extra (eitherToMaybe)
import Data.Functor.Identity (Identity(..))
import Data.List.Extra (find, isPrefixOf, nubSort)
import Data.Maybe (fromMaybe, isJust, isNothing)
import qualified Data.Text as T
import Data.Time.Calendar (Day, addDays)
import Data.Default (Default(..))
import Safe (headMay, lastDef, lastMay, maximumMay, readMay)

import Text.Megaparsec.Custom

import Hledger.Data
import Hledger.Query
import Hledger.Utils


-- | What to calculate for each cell in a balance report.
-- "Balance report types -> Calculation type" in the hledger manual.
data BalanceCalculation =
    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.
  deriving (BalanceCalculation -> BalanceCalculation -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: BalanceCalculation -> BalanceCalculation -> Bool
$c/= :: BalanceCalculation -> BalanceCalculation -> Bool
== :: BalanceCalculation -> BalanceCalculation -> Bool
$c== :: BalanceCalculation -> BalanceCalculation -> Bool
Eq, Int -> BalanceCalculation -> ShowS
[BalanceCalculation] -> ShowS
BalanceCalculation -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [BalanceCalculation] -> ShowS
$cshowList :: [BalanceCalculation] -> ShowS
show :: BalanceCalculation -> String
$cshow :: BalanceCalculation -> String
showsPrec :: Int -> BalanceCalculation -> ShowS
$cshowsPrec :: Int -> BalanceCalculation -> ShowS
Show)

instance Default BalanceCalculation where def :: BalanceCalculation
def = BalanceCalculation
CalcChange

-- | How to accumulate calculated values across periods (columns) in a balance report.
-- "Balance report types -> Accumulation type" in the hledger manual.
data BalanceAccumulation =
    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.
  deriving (BalanceAccumulation -> BalanceAccumulation -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: BalanceAccumulation -> BalanceAccumulation -> Bool
$c/= :: BalanceAccumulation -> BalanceAccumulation -> Bool
== :: BalanceAccumulation -> BalanceAccumulation -> Bool
$c== :: BalanceAccumulation -> BalanceAccumulation -> Bool
Eq,Int -> BalanceAccumulation -> ShowS
[BalanceAccumulation] -> ShowS
BalanceAccumulation -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [BalanceAccumulation] -> ShowS
$cshowList :: [BalanceAccumulation] -> ShowS
show :: BalanceAccumulation -> String
$cshow :: BalanceAccumulation -> String
showsPrec :: Int -> BalanceAccumulation -> ShowS
$cshowsPrec :: Int -> BalanceAccumulation -> ShowS
Show)

instance Default BalanceAccumulation where def :: BalanceAccumulation
def = BalanceAccumulation
PerPeriod

-- | Should accounts be displayed: in the command's default style, hierarchically, or as a flat list ?
data AccountListMode = ALFlat | ALTree deriving (AccountListMode -> AccountListMode -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AccountListMode -> AccountListMode -> Bool
$c/= :: AccountListMode -> AccountListMode -> Bool
== :: AccountListMode -> AccountListMode -> Bool
$c== :: AccountListMode -> AccountListMode -> Bool
Eq, Int -> AccountListMode -> ShowS
[AccountListMode] -> ShowS
AccountListMode -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AccountListMode] -> ShowS
$cshowList :: [AccountListMode] -> ShowS
show :: AccountListMode -> String
$cshow :: AccountListMode -> String
showsPrec :: Int -> AccountListMode -> ShowS
$cshowsPrec :: Int -> AccountListMode -> ShowS
Show)

instance Default AccountListMode where def :: AccountListMode
def = AccountListMode
ALFlat

data Layout = LayoutWide (Maybe Int)
            | LayoutTall
            | LayoutBare
            | LayoutTidy
  deriving (Layout -> Layout -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Layout -> Layout -> Bool
$c/= :: Layout -> Layout -> Bool
== :: Layout -> Layout -> Bool
$c== :: Layout -> Layout -> Bool
Eq, Int -> Layout -> ShowS
[Layout] -> ShowS
Layout -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Layout] -> ShowS
$cshowList :: [Layout] -> ShowS
show :: Layout -> String
$cshow :: Layout -> String
showsPrec :: Int -> Layout -> ShowS
$cshowsPrec :: Int -> Layout -> ShowS
Show)

-- | 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.
data ReportOpts = ReportOpts {
     -- for most reports:
     ReportOpts -> Period
period_           :: Period
    ,ReportOpts -> Interval
interval_         :: Interval
    ,ReportOpts -> [Status]
statuses_         :: [Status]  -- ^ Zero, one, or two statuses to be matched
    ,ReportOpts -> Maybe ConversionOp
conversionop_     :: Maybe ConversionOp  -- ^ Which operation should we apply to conversion transactions?
    ,ReportOpts -> Maybe ValuationType
value_            :: Maybe ValuationType  -- ^ What value should amounts be converted to ?
    ,ReportOpts -> Bool
infer_prices_     :: Bool      -- ^ Infer market prices from transactions ?
    ,ReportOpts -> Maybe Int
depth_            :: Maybe Int
    ,ReportOpts -> Bool
date2_            :: Bool
    ,ReportOpts -> Bool
empty_            :: Bool
    ,ReportOpts -> Bool
no_elide_         :: Bool
    ,ReportOpts -> Bool
real_             :: Bool
    ,ReportOpts -> StringFormat
format_           :: StringFormat
    ,ReportOpts -> Bool
pretty_           :: Bool
    ,ReportOpts -> [Text]
querystring_      :: [T.Text]
    --
    ,ReportOpts -> Bool
average_          :: Bool
    -- for posting reports (register)
    ,ReportOpts -> Bool
related_          :: Bool
    -- for account transactions reports (aregister)
    ,ReportOpts -> Bool
txn_dates_        :: Bool
    -- for balance reports (bal, bs, cf, is)
    ,ReportOpts -> BalanceCalculation
balancecalc_      :: BalanceCalculation  -- ^ What to calculate in balance report cells
    ,ReportOpts -> BalanceAccumulation
balanceaccum_     :: BalanceAccumulation -- ^ How to accumulate balance report values over time
    ,ReportOpts -> Maybe Text
budgetpat_        :: Maybe T.Text  -- ^ A case-insensitive description substring
                                        --   to select periodic transactions for budget reports.
                                        --   (Not a regexp, nor a full hledger query, for now.)
    ,ReportOpts -> AccountListMode
accountlistmode_  :: AccountListMode
    ,ReportOpts -> Int
drop_             :: Int
    ,ReportOpts -> Bool
declared_         :: Bool  -- ^ Include accounts declared but not yet posted to ?
    ,ReportOpts -> Bool
row_total_        :: Bool
    ,ReportOpts -> Bool
no_total_         :: Bool
    ,ReportOpts -> Bool
show_costs_       :: Bool  -- ^ Show costs for reports which normally don't show them ?
    ,ReportOpts -> Bool
sort_amount_      :: Bool
    ,ReportOpts -> Bool
percent_          :: Bool
    ,ReportOpts -> Bool
invert_           :: Bool  -- ^ Flip all amount signs in reports ?
    ,ReportOpts -> Maybe NormalSign
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.
    ,ReportOpts -> Bool
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.
    ,ReportOpts -> Bool
transpose_        :: Bool
    ,ReportOpts -> Layout
layout_           :: Layout
 } deriving (Int -> ReportOpts -> ShowS
[ReportOpts] -> ShowS
ReportOpts -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ReportOpts] -> ShowS
$cshowList :: [ReportOpts] -> ShowS
show :: ReportOpts -> String
$cshow :: ReportOpts -> String
showsPrec :: Int -> ReportOpts -> ShowS
$cshowsPrec :: Int -> ReportOpts -> ShowS
Show)

instance Default ReportOpts where def :: ReportOpts
def = ReportOpts
defreportopts

defreportopts :: ReportOpts
defreportopts :: ReportOpts
defreportopts = ReportOpts
    { period_ :: Period
period_           = Period
PeriodAll
    , interval_ :: Interval
interval_         = Interval
NoInterval
    , statuses_ :: [Status]
statuses_         = []
    , conversionop_ :: Maybe ConversionOp
conversionop_     = forall a. Maybe a
Nothing
    , value_ :: Maybe ValuationType
value_            = forall a. Maybe a
Nothing
    , infer_prices_ :: Bool
infer_prices_     = Bool
False
    , depth_ :: Maybe Int
depth_            = forall a. Maybe a
Nothing
    , date2_ :: Bool
date2_            = Bool
False
    , empty_ :: Bool
empty_            = Bool
False
    , no_elide_ :: Bool
no_elide_         = Bool
False
    , real_ :: Bool
real_             = Bool
False
    , format_ :: StringFormat
format_           = forall a. Default a => a
def
    , pretty_ :: Bool
pretty_           = Bool
False
    , querystring_ :: [Text]
querystring_      = []
    , average_ :: Bool
average_          = Bool
False
    , related_ :: Bool
related_          = Bool
False
    , txn_dates_ :: Bool
txn_dates_        = Bool
False
    , balancecalc_ :: BalanceCalculation
balancecalc_      = forall a. Default a => a
def
    , balanceaccum_ :: BalanceAccumulation
balanceaccum_     = forall a. Default a => a
def
    , budgetpat_ :: Maybe Text
budgetpat_        = forall a. Maybe a
Nothing
    , accountlistmode_ :: AccountListMode
accountlistmode_  = AccountListMode
ALFlat
    , drop_ :: Int
drop_             = Int
0
    , declared_ :: Bool
declared_         = Bool
False
    , row_total_ :: Bool
row_total_        = Bool
False
    , no_total_ :: Bool
no_total_         = Bool
False
    , show_costs_ :: Bool
show_costs_       = Bool
False
    , sort_amount_ :: Bool
sort_amount_      = Bool
False
    , percent_ :: Bool
percent_          = Bool
False
    , invert_ :: Bool
invert_           = Bool
False
    , normalbalance_ :: Maybe NormalSign
normalbalance_    = forall a. Maybe a
Nothing
    , color_ :: Bool
color_            = Bool
False
    , transpose_ :: Bool
transpose_        = Bool
False
    , layout_ :: Layout
layout_           = Maybe Int -> Layout
LayoutWide forall a. Maybe a
Nothing
    }

-- | 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,
rawOptsToReportOpts :: Day -> RawOpts -> ReportOpts
rawOptsToReportOpts :: Day -> RawOpts -> ReportOpts
rawOptsToReportOpts Day
d RawOpts
rawopts =

    let formatstring :: Maybe Text
formatstring = String -> Text
T.pack forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> String -> RawOpts -> Maybe String
maybestringopt String
"format" RawOpts
rawopts
        querystring :: [Text]
querystring  = forall a b. (a -> b) -> [a] -> [b]
map String -> Text
T.pack forall a b. (a -> b) -> a -> b
$ String -> RawOpts -> [String]
listofstringopt String
"args" RawOpts
rawopts  -- doesn't handle an arg like "" right
        pretty :: Bool
pretty = forall a. a -> Maybe a -> a
fromMaybe Bool
False forall a b. (a -> b) -> a -> b
$ String -> RawOpts -> Maybe Bool
alwaysneveropt String
"pretty" RawOpts
rawopts

        format :: StringFormat
format = case Text -> Either String StringFormat
parseStringFormat forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Maybe Text
formatstring of
            Maybe (Either String StringFormat)
Nothing         -> StringFormat
defaultBalanceLineFormat
            Just (Right StringFormat
x)  -> StringFormat
x
            Just (Left String
err) -> forall a. String -> a
usageError forall a b. (a -> b) -> a -> b
$ String
"could not parse format option: " forall a. [a] -> [a] -> [a]
++ String
err

    in ReportOpts
defreportopts
          {period_ :: Period
period_           = Day -> RawOpts -> Period
periodFromRawOpts Day
d RawOpts
rawopts
          ,interval_ :: Interval
interval_         = RawOpts -> Interval
intervalFromRawOpts RawOpts
rawopts
          ,statuses_ :: [Status]
statuses_         = RawOpts -> [Status]
statusesFromRawOpts RawOpts
rawopts
          ,conversionop_ :: Maybe ConversionOp
conversionop_     = RawOpts -> Maybe ConversionOp
conversionOpFromRawOpts RawOpts
rawopts
          ,value_ :: Maybe ValuationType
value_            = RawOpts -> Maybe ValuationType
valuationTypeFromRawOpts RawOpts
rawopts
          ,infer_prices_ :: Bool
infer_prices_     = String -> RawOpts -> Bool
boolopt String
"infer-market-prices" RawOpts
rawopts
          ,depth_ :: Maybe Int
depth_            = String -> RawOpts -> Maybe Int
maybeposintopt String
"depth" RawOpts
rawopts
          ,date2_ :: Bool
date2_            = String -> RawOpts -> Bool
boolopt String
"date2" RawOpts
rawopts
          ,empty_ :: Bool
empty_            = String -> RawOpts -> Bool
boolopt String
"empty" RawOpts
rawopts
          ,no_elide_ :: Bool
no_elide_         = String -> RawOpts -> Bool
boolopt String
"no-elide" RawOpts
rawopts
          ,real_ :: Bool
real_             = String -> RawOpts -> Bool
boolopt String
"real" RawOpts
rawopts
          ,format_ :: StringFormat
format_           = StringFormat
format
          ,querystring_ :: [Text]
querystring_      = [Text]
querystring
          ,average_ :: Bool
average_          = String -> RawOpts -> Bool
boolopt String
"average" RawOpts
rawopts
          ,related_ :: Bool
related_          = String -> RawOpts -> Bool
boolopt String
"related" RawOpts
rawopts
          ,txn_dates_ :: Bool
txn_dates_        = String -> RawOpts -> Bool
boolopt String
"txn-dates" RawOpts
rawopts
          ,balancecalc_ :: BalanceCalculation
balancecalc_      = RawOpts -> BalanceCalculation
balancecalcopt RawOpts
rawopts
          ,balanceaccum_ :: BalanceAccumulation
balanceaccum_     = RawOpts -> BalanceAccumulation
balanceaccumopt RawOpts
rawopts
          ,budgetpat_ :: Maybe Text
budgetpat_        = RawOpts -> Maybe Text
maybebudgetpatternopt RawOpts
rawopts
          ,accountlistmode_ :: AccountListMode
accountlistmode_  = RawOpts -> AccountListMode
accountlistmodeopt RawOpts
rawopts
          ,drop_ :: Int
drop_             = String -> RawOpts -> Int
posintopt String
"drop" RawOpts
rawopts
          ,declared_ :: Bool
declared_         = String -> RawOpts -> Bool
boolopt String
"declared" RawOpts
rawopts
          ,row_total_ :: Bool
row_total_        = String -> RawOpts -> Bool
boolopt String
"row-total" RawOpts
rawopts
          ,no_total_ :: Bool
no_total_         = String -> RawOpts -> Bool
boolopt String
"no-total" RawOpts
rawopts
          ,show_costs_ :: Bool
show_costs_       = String -> RawOpts -> Bool
boolopt String
"show-costs" RawOpts
rawopts
          ,sort_amount_ :: Bool
sort_amount_      = String -> RawOpts -> Bool
boolopt String
"sort-amount" RawOpts
rawopts
          ,percent_ :: Bool
percent_          = String -> RawOpts -> Bool
boolopt String
"percent" RawOpts
rawopts
          ,invert_ :: Bool
invert_           = String -> RawOpts -> Bool
boolopt String
"invert" RawOpts
rawopts
          ,pretty_ :: Bool
pretty_           = Bool
pretty
          ,color_ :: Bool
color_            = Bool
useColorOnStdout -- a lower-level helper
          ,transpose_ :: Bool
transpose_        = String -> RawOpts -> Bool
boolopt String
"transpose" RawOpts
rawopts
          ,layout_ :: Layout
layout_           = RawOpts -> Layout
layoutopt RawOpts
rawopts
          }

-- | 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.
--
data ReportSpec = ReportSpec
  { ReportSpec -> ReportOpts
_rsReportOpts :: ReportOpts  -- ^ The underlying ReportOpts used to generate this ReportSpec
  , ReportSpec -> Day
_rsDay        :: Day         -- ^ The Day this ReportSpec is generated for
  , ReportSpec -> Query
_rsQuery      :: Query       -- ^ The generated Query for the given day
  , ReportSpec -> [QueryOpt]
_rsQueryOpts  :: [QueryOpt]  -- ^ A list of QueryOpts for the given day
  } deriving (Int -> ReportSpec -> ShowS
[ReportSpec] -> ShowS
ReportSpec -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ReportSpec] -> ShowS
$cshowList :: [ReportSpec] -> ShowS
show :: ReportSpec -> String
$cshow :: ReportSpec -> String
showsPrec :: Int -> ReportSpec -> ShowS
$cshowsPrec :: Int -> ReportSpec -> ShowS
Show)

instance Default ReportSpec where def :: ReportSpec
def = ReportSpec
defreportspec

defreportspec :: ReportSpec
defreportspec :: ReportSpec
defreportspec = ReportSpec
    { _rsReportOpts :: ReportOpts
_rsReportOpts = forall a. Default a => a
def
    , _rsDay :: Day
_rsDay        = Day
nulldate
    , _rsQuery :: Query
_rsQuery      = Query
Any
    , _rsQueryOpts :: [QueryOpt]
_rsQueryOpts  = []
    }

-- | Set the default ConversionOp.
setDefaultConversionOp :: ConversionOp -> ReportSpec -> ReportSpec
setDefaultConversionOp :: ConversionOp -> ReportSpec -> ReportSpec
setDefaultConversionOp ConversionOp
defop rspec :: ReportSpec
rspec@ReportSpec{_rsReportOpts :: ReportSpec -> ReportOpts
_rsReportOpts=ReportOpts
ropts} =
    ReportSpec
rspec{_rsReportOpts :: ReportOpts
_rsReportOpts=ReportOpts
ropts{conversionop_ :: Maybe ConversionOp
conversionop_=ReportOpts -> Maybe ConversionOp
conversionop_ ReportOpts
ropts forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> forall a. a -> Maybe a
Just ConversionOp
defop}}

accountlistmodeopt :: RawOpts -> AccountListMode
accountlistmodeopt :: RawOpts -> AccountListMode
accountlistmodeopt =
  forall a. a -> Maybe a -> a
fromMaybe AccountListMode
ALFlat forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. (String -> Maybe a) -> RawOpts -> Maybe a
choiceopt String -> Maybe AccountListMode
parse where
    parse :: String -> Maybe AccountListMode
parse = \case
      String
"tree" -> forall a. a -> Maybe a
Just AccountListMode
ALTree
      String
"flat" -> forall a. a -> Maybe a
Just AccountListMode
ALFlat
      String
_      -> forall a. Maybe a
Nothing

-- Get the argument of the --budget option if any, or the empty string.
maybebudgetpatternopt :: RawOpts -> Maybe T.Text
maybebudgetpatternopt :: RawOpts -> Maybe Text
maybebudgetpatternopt = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap String -> Text
T.pack forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> RawOpts -> Maybe String
maybestringopt String
"budget"

balancecalcopt :: RawOpts -> BalanceCalculation
balancecalcopt :: RawOpts -> BalanceCalculation
balancecalcopt =
  forall a. a -> Maybe a -> a
fromMaybe BalanceCalculation
CalcChange forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. (String -> Maybe a) -> RawOpts -> Maybe a
choiceopt String -> Maybe BalanceCalculation
parse where
    parse :: String -> Maybe BalanceCalculation
parse = \case
      String
"sum"         -> forall a. a -> Maybe a
Just BalanceCalculation
CalcChange
      String
"valuechange" -> forall a. a -> Maybe a
Just BalanceCalculation
CalcValueChange
      String
"gain"        -> forall a. a -> Maybe a
Just BalanceCalculation
CalcGain
      String
"budget"      -> forall a. a -> Maybe a
Just BalanceCalculation
CalcBudget
      String
"count"       -> forall a. a -> Maybe a
Just BalanceCalculation
CalcPostingsCount
      String
_             -> forall a. Maybe a
Nothing

balanceaccumopt :: RawOpts -> BalanceAccumulation
balanceaccumopt :: RawOpts -> BalanceAccumulation
balanceaccumopt = forall a. a -> Maybe a -> a
fromMaybe BalanceAccumulation
PerPeriod forall b c a. (b -> c) -> (a -> b) -> a -> c
. RawOpts -> Maybe BalanceAccumulation
balanceAccumulationOverride

alwaysneveropt :: String -> RawOpts -> Maybe Bool
alwaysneveropt :: String -> RawOpts -> Maybe Bool
alwaysneveropt String
opt RawOpts
rawopts = case String -> RawOpts -> Maybe String
maybestringopt String
opt RawOpts
rawopts of
    Just String
"always" -> forall a. a -> Maybe a
Just Bool
True
    Just String
"yes"    -> forall a. a -> Maybe a
Just Bool
True
    Just String
"y"      -> forall a. a -> Maybe a
Just Bool
True
    Just String
"never"  -> forall a. a -> Maybe a
Just Bool
False
    Just String
"no"     -> forall a. a -> Maybe a
Just Bool
False
    Just String
"n"      -> forall a. a -> Maybe a
Just Bool
False
    Just String
_        -> forall a. String -> a
usageError String
"--pretty's argument should be \"yes\" or \"no\" (or y, n, always, never)"
    Maybe String
_             -> forall a. Maybe a
Nothing

balanceAccumulationOverride :: RawOpts -> Maybe BalanceAccumulation
balanceAccumulationOverride :: RawOpts -> Maybe BalanceAccumulation
balanceAccumulationOverride RawOpts
rawopts = forall a. (String -> Maybe a) -> RawOpts -> Maybe a
choiceopt String -> Maybe BalanceAccumulation
parse RawOpts
rawopts forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> Maybe BalanceAccumulation
reportbal
  where
    parse :: String -> Maybe BalanceAccumulation
parse = \case
      String
"historical" -> forall a. a -> Maybe a
Just BalanceAccumulation
Historical
      String
"cumulative" -> forall a. a -> Maybe a
Just BalanceAccumulation
Cumulative
      String
"change"     -> forall a. a -> Maybe a
Just BalanceAccumulation
PerPeriod
      String
_            -> forall a. Maybe a
Nothing
    reportbal :: Maybe BalanceAccumulation
reportbal = case RawOpts -> BalanceCalculation
balancecalcopt RawOpts
rawopts of
      BalanceCalculation
CalcValueChange -> forall a. a -> Maybe a
Just BalanceAccumulation
PerPeriod
      BalanceCalculation
_               -> forall a. Maybe a
Nothing

layoutopt :: RawOpts -> Layout
layoutopt :: RawOpts -> Layout
layoutopt RawOpts
rawopts = forall a. a -> Maybe a -> a
fromMaybe (Maybe Int -> Layout
LayoutWide forall a. Maybe a
Nothing) forall a b. (a -> b) -> a -> b
$ Maybe Layout
layout forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> Maybe Layout
column
  where
    layout :: Maybe Layout
layout = String -> Layout
parse forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> String -> RawOpts -> Maybe String
maybestringopt String
"layout" RawOpts
rawopts
    column :: Maybe Layout
column = Layout
LayoutBare forall (f :: * -> *) a b. Functor f => a -> f b -> f a
<$ forall (f :: * -> *). Alternative f => Bool -> f ()
guard (String -> RawOpts -> Bool
boolopt String
"commodity-column" RawOpts
rawopts)

    parse :: String -> Layout
parse String
opt = forall b a. b -> (a -> b) -> Maybe a -> b
maybe forall {a}. a
err forall a b. (a, b) -> b
snd forall a b. (a -> b) -> a -> b
$ forall (f :: * -> *). Alternative f => Bool -> f ()
guard (Bool -> Bool
not forall a b. (a -> b) -> a -> b
$ forall (t :: * -> *) a. Foldable t => t a -> Bool
null String
s) forall (f :: * -> *) a b. Applicative f => f a -> f b -> f b
*> forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Maybe a
find (forall a. Eq a => [a] -> [a] -> Bool
isPrefixOf String
s forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. (a, b) -> a
fst) [(String, Layout)]
checkNames
      where
        checkNames :: [(String, Layout)]
checkNames = [ (String
"wide", Maybe Int -> Layout
LayoutWide Maybe Int
w)
                     , (String
"tall", Layout
LayoutTall)
                     , (String
"bare", Layout
LayoutBare)
                     , (String
"tidy", Layout
LayoutTidy)
                     ]
        -- For `--layout=elided,n`, elide to the given width
        (String
s,String
n) = forall a. (a -> Bool) -> [a] -> ([a], [a])
break (forall a. Eq a => a -> a -> Bool
==Char
',') forall a b. (a -> b) -> a -> b
$ forall a b. (a -> b) -> [a] -> [b]
map Char -> Char
toLower String
opt
        w :: Maybe Int
w = case forall a. Int -> [a] -> [a]
drop Int
1 String
n of
              String
"" -> forall a. Maybe a
Nothing
              String
c | Just Int
w' <- forall a. Read a => String -> Maybe a
readMay String
c -> forall a. a -> Maybe a
Just Int
w'
              String
_ -> forall a. String -> a
usageError String
"width in --layout=wide,WIDTH must be an integer"

        err :: a
err = forall a. String -> a
usageError String
"--layout's argument should be \"wide[,WIDTH]\", \"tall\", \"bare\", or \"tidy\""

-- Get the period specified by any -b/--begin, -e/--end and/or -p/--period
-- options appearing in the command line.
-- Its bounds are the rightmost begin date specified by a -b or -p, and
-- the rightmost end date specified by a -e or -p. Cf #1011.
-- Today's date is provided to help interpret any relative dates.
periodFromRawOpts :: Day -> RawOpts -> Period
periodFromRawOpts :: Day -> RawOpts -> Period
periodFromRawOpts Day
d RawOpts
rawopts =
  case (Maybe Day
mlastb, Maybe Day
mlaste) of
    (Maybe Day
Nothing, Maybe Day
Nothing) -> Period
PeriodAll
    (Just Day
b, Maybe Day
Nothing)  -> Day -> Period
PeriodFrom Day
b
    (Maybe Day
Nothing, Just Day
e)  -> Day -> Period
PeriodTo Day
e
    (Just Day
b, Just Day
e)   -> Period -> Period
simplifyPeriod forall a b. (a -> b) -> a -> b
$ Day -> Day -> Period
PeriodBetween Day
b Day
e
  where
    mlastb :: Maybe Day
mlastb = case Day -> RawOpts -> [EFDay]
beginDatesFromRawOpts Day
d RawOpts
rawopts of
                   [] -> forall a. Maybe a
Nothing
                   [EFDay]
bs -> forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ EFDay -> Day
fromEFDay forall a b. (a -> b) -> a -> b
$ forall a. [a] -> a
last [EFDay]
bs
    mlaste :: Maybe Day
mlaste = case Day -> RawOpts -> [EFDay]
endDatesFromRawOpts Day
d RawOpts
rawopts of
                   [] -> forall a. Maybe a
Nothing
                   [EFDay]
es -> forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ EFDay -> Day
fromEFDay forall a b. (a -> b) -> a -> b
$ forall a. [a] -> a
last [EFDay]
es

-- Get all begin dates specified by -b/--begin or -p/--period options, in order,
-- using the given date to interpret relative date expressions.
beginDatesFromRawOpts :: Day -> RawOpts -> [EFDay]
beginDatesFromRawOpts :: Day -> RawOpts -> [EFDay]
beginDatesFromRawOpts Day
d = forall a. ((String, String) -> Maybe a) -> RawOpts -> [a]
collectopts (Day -> (String, String) -> Maybe EFDay
begindatefromrawopt Day
d)
  where
    begindatefromrawopt :: Day -> (String, String) -> Maybe EFDay
begindatefromrawopt Day
d' (String
n,String
v)
      | String
n forall a. Eq a => a -> a -> Bool
== String
"begin" =
          forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either (\HledgerParseErrors
e -> forall a. String -> a
usageError forall a b. (a -> b) -> a -> b
$ String
"could not parse "forall a. [a] -> [a] -> [a]
++String
nforall a. [a] -> [a] -> [a]
++String
" date: "forall a. [a] -> [a] -> [a]
++HledgerParseErrors -> String
customErrorBundlePretty HledgerParseErrors
e) forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$
          Day -> Text -> Either HledgerParseErrors EFDay
fixSmartDateStrEither' Day
d' (String -> Text
T.pack String
v)
      | String
n forall a. Eq a => a -> a -> Bool
== String
"period" =
        case
          forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either (\HledgerParseErrors
e -> forall a. String -> a
usageError forall a b. (a -> b) -> a -> b
$ String
"could not parse period option: "forall a. [a] -> [a] -> [a]
++HledgerParseErrors -> String
customErrorBundlePretty HledgerParseErrors
e) forall a. a -> a
id forall a b. (a -> b) -> a -> b
$
          Day -> Text -> Either HledgerParseErrors (Interval, DateSpan)
parsePeriodExpr Day
d' (Text -> Text
stripquotes forall a b. (a -> b) -> a -> b
$ String -> Text
T.pack String
v)
        of
          (Interval
_, DateSpan (Just EFDay
b) Maybe EFDay
_) -> forall a. a -> Maybe a
Just EFDay
b
          (Interval, DateSpan)
_                        -> forall a. Maybe a
Nothing
      | Bool
otherwise = forall a. Maybe a
Nothing

-- Get all end dates specified by -e/--end or -p/--period options, in order,
-- using the given date to interpret relative date expressions.
endDatesFromRawOpts :: Day -> RawOpts -> [EFDay]
endDatesFromRawOpts :: Day -> RawOpts -> [EFDay]
endDatesFromRawOpts Day
d = forall a. ((String, String) -> Maybe a) -> RawOpts -> [a]
collectopts (Day -> (String, String) -> Maybe EFDay
enddatefromrawopt Day
d)
  where
    enddatefromrawopt :: Day -> (String, String) -> Maybe EFDay
enddatefromrawopt Day
d' (String
n,String
v)
      | String
n forall a. Eq a => a -> a -> Bool
== String
"end" =
          forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either (\HledgerParseErrors
e -> forall a. String -> a
usageError forall a b. (a -> b) -> a -> b
$ String
"could not parse "forall a. [a] -> [a] -> [a]
++String
nforall a. [a] -> [a] -> [a]
++String
" date: "forall a. [a] -> [a] -> [a]
++HledgerParseErrors -> String
customErrorBundlePretty HledgerParseErrors
e) forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$
          Day -> Text -> Either HledgerParseErrors EFDay
fixSmartDateStrEither' Day
d' (String -> Text
T.pack String
v)
      | String
n forall a. Eq a => a -> a -> Bool
== String
"period" =
        case
          forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either (\HledgerParseErrors
e -> forall a. String -> a
usageError forall a b. (a -> b) -> a -> b
$ String
"could not parse period option: "forall a. [a] -> [a] -> [a]
++HledgerParseErrors -> String
customErrorBundlePretty HledgerParseErrors
e) forall a. a -> a
id forall a b. (a -> b) -> a -> b
$
          Day -> Text -> Either HledgerParseErrors (Interval, DateSpan)
parsePeriodExpr Day
d' (Text -> Text
stripquotes forall a b. (a -> b) -> a -> b
$ String -> Text
T.pack String
v)
        of
          (Interval
_, DateSpan Maybe EFDay
_ (Just EFDay
e)) -> forall a. a -> Maybe a
Just EFDay
e
          (Interval, DateSpan)
_                        -> forall a. Maybe a
Nothing
      | Bool
otherwise = forall a. Maybe a
Nothing

-- | 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.
intervalFromRawOpts :: RawOpts -> Interval
intervalFromRawOpts :: RawOpts -> Interval
intervalFromRawOpts = forall a. a -> [a] -> a
lastDef Interval
NoInterval forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. ((String, String) -> Maybe a) -> RawOpts -> [a]
collectopts forall {a}. (Eq a, IsString a) => (a, String) -> Maybe Interval
intervalfromrawopt
  where
    intervalfromrawopt :: (a, String) -> Maybe Interval
intervalfromrawopt (a
n,String
v)
      | a
n forall a. Eq a => a -> a -> Bool
== a
"period" =
          forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either
            (\HledgerParseErrors
e -> forall a. String -> a
usageError forall a b. (a -> b) -> a -> b
$ String
"could not parse period option: "forall a. [a] -> [a] -> [a]
++HledgerParseErrors -> String
customErrorBundlePretty HledgerParseErrors
e)
            (Interval, DateSpan) -> Maybe Interval
extractIntervalOrNothing forall a b. (a -> b) -> a -> b
$
            Day -> Text -> Either HledgerParseErrors (Interval, DateSpan)
parsePeriodExpr
              (forall a. String -> a
error' String
"intervalFromRawOpts: did not expect to need today's date here")  -- PARTIAL: should not happen; we are just getting the interval, which does not use the reference date
              (Text -> Text
stripquotes forall a b. (a -> b) -> a -> b
$ String -> Text
T.pack String
v)
      | a
n forall a. Eq a => a -> a -> Bool
== a
"daily"     = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ Int -> Interval
Days Int
1
      | a
n forall a. Eq a => a -> a -> Bool
== a
"weekly"    = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ Int -> Interval
Weeks Int
1
      | a
n forall a. Eq a => a -> a -> Bool
== a
"monthly"   = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ Int -> Interval
Months Int
1
      | a
n forall a. Eq a => a -> a -> Bool
== a
"quarterly" = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ Int -> Interval
Quarters Int
1
      | a
n forall a. Eq a => a -> a -> Bool
== a
"yearly"    = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ Int -> Interval
Years Int
1
      | Bool
otherwise = forall a. Maybe a
Nothing

-- | Extract the interval from the parsed -p/--period expression.
-- Return Nothing if an interval is not explicitly defined.
extractIntervalOrNothing :: (Interval, DateSpan) -> Maybe Interval
extractIntervalOrNothing :: (Interval, DateSpan) -> Maybe Interval
extractIntervalOrNothing (Interval
NoInterval, DateSpan
_) = forall a. Maybe a
Nothing
extractIntervalOrNothing (Interval
interval, DateSpan
_) = forall a. a -> Maybe a
Just Interval
interval

-- | Get any statuses to be matched, as specified by -U/--unmarked,
-- -P/--pending, -C/--cleared flags. -UPC is equivalent to no flags,
-- so this returns a list of 0-2 unique statuses.
statusesFromRawOpts :: RawOpts -> [Status]
statusesFromRawOpts :: RawOpts -> [Status]
statusesFromRawOpts = forall {a}. Ord a => [a] -> [a]
simplifyStatuses forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. ((String, String) -> Maybe a) -> RawOpts -> [a]
collectopts forall {a} {b}. (Eq a, IsString a) => (a, b) -> Maybe Status
statusfromrawopt
  where
    statusfromrawopt :: (a, b) -> Maybe Status
statusfromrawopt (a
n,b
_)
      | a
n forall a. Eq a => a -> a -> Bool
== a
"unmarked"  = forall a. a -> Maybe a
Just Status
Unmarked
      | a
n forall a. Eq a => a -> a -> Bool
== a
"pending"   = forall a. a -> Maybe a
Just Status
Pending
      | a
n forall a. Eq a => a -> a -> Bool
== a
"cleared"   = forall a. a -> Maybe a
Just Status
Cleared
      | Bool
otherwise        = forall a. Maybe a
Nothing

-- | Reduce a list of statuses to just one of each status,
-- and if all statuses are present return the empty list.
simplifyStatuses :: [a] -> [a]
simplifyStatuses [a]
l
  | forall (t :: * -> *) a. Foldable t => t a -> Int
length [a]
l' forall a. Ord a => a -> a -> Bool
>= Int
numstatuses = []
  | Bool
otherwise                = [a]
l'
  where
    l' :: [a]
l' = forall {a}. Ord a => [a] -> [a]
nubSort [a]
l
    numstatuses :: Int
numstatuses = forall (t :: * -> *) a. Foldable t => t a -> Int
length [forall a. Bounded a => a
minBound .. forall a. Bounded a => a
maxBound :: Status]

-- | Add/remove this status from the status list. Used by hledger-ui.
reportOptsToggleStatus :: Status -> ReportOpts -> ReportOpts
reportOptsToggleStatus Status
s ropts :: ReportOpts
ropts@ReportOpts{statuses_ :: ReportOpts -> [Status]
statuses_=[Status]
ss}
  | Status
s forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` [Status]
ss = ReportOpts
ropts{statuses_ :: [Status]
statuses_=forall a. (a -> Bool) -> [a] -> [a]
filter (forall a. Eq a => a -> a -> Bool
/= Status
s) [Status]
ss}
  | Bool
otherwise   = ReportOpts
ropts{statuses_ :: [Status]
statuses_=forall {a}. Ord a => [a] -> [a]
simplifyStatuses (Status
sforall a. a -> [a] -> [a]
:[Status]
ss)}

-- | Parse the type of valuation to be performed, if any, specified by -V,
-- -X/--exchange, or --value flags. If there's more than one valuation type,
-- the rightmost flag wins. This will fail with a usage error if an invalid
-- argument is passed to --value, or if --valuechange is called with a
-- valuation type other than -V/--value=end.
valuationTypeFromRawOpts :: RawOpts -> Maybe ValuationType
valuationTypeFromRawOpts :: RawOpts -> Maybe ValuationType
valuationTypeFromRawOpts RawOpts
rawopts = case (RawOpts -> BalanceCalculation
balancecalcopt RawOpts
rawopts, Maybe ValuationType
directval) of
    (BalanceCalculation
CalcValueChange, Maybe ValuationType
Nothing       ) -> forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ Maybe Text -> ValuationType
AtEnd forall a. Maybe a
Nothing  -- If no valuation requested for valuechange, use AtEnd
    (BalanceCalculation
CalcValueChange, Just (AtEnd Maybe Text
_)) -> Maybe ValuationType
directval             -- If AtEnd valuation requested, use it
    (BalanceCalculation
CalcValueChange, Maybe ValuationType
_             ) -> forall a. String -> a
usageError String
"--valuechange only produces sensible results with --value=end"
    (BalanceCalculation
CalcGain,        Maybe ValuationType
Nothing       ) -> forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ Maybe Text -> ValuationType
AtEnd forall a. Maybe a
Nothing  -- If no valuation requested for gain, use AtEnd
    (BalanceCalculation
_,               Maybe ValuationType
_             ) -> Maybe ValuationType
directval             -- Otherwise, use requested valuation
  where
    directval :: Maybe ValuationType
directval = forall a. [a] -> Maybe a
lastMay forall a b. (a -> b) -> a -> b
$ forall a. ((String, String) -> Maybe a) -> RawOpts -> [a]
collectopts forall {a}.
(Eq a, IsString a) =>
(a, String) -> Maybe ValuationType
valuationfromrawopt RawOpts
rawopts
    valuationfromrawopt :: (a, String) -> Maybe ValuationType
valuationfromrawopt (a
n,String
v)  -- option name, value
      | a
n forall a. Eq a => a -> a -> Bool
== a
"V"     = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ Maybe Text -> ValuationType
AtEnd forall a. Maybe a
Nothing
      | a
n forall a. Eq a => a -> a -> Bool
== a
"X"     = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ Maybe Text -> ValuationType
AtEnd (forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ String -> Text
T.pack String
v)
      | a
n forall a. Eq a => a -> a -> Bool
== a
"value" = String -> Maybe ValuationType
valueopt String
v
      | Bool
otherwise    = forall a. Maybe a
Nothing
    valueopt :: String -> Maybe ValuationType
valueopt String
v
      | String
t forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` [String
"cost",String
"c"]  = Maybe Text -> ValuationType
AtEnd forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. a -> Maybe a
Just forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Maybe Text
mc  -- keep supporting --value=cost,COMM for now
      | String
t forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` [String
"then" ,String
"t"] = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ Maybe Text -> ValuationType
AtThen Maybe Text
mc
      | String
t forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` [String
"end" ,String
"e"]  = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ Maybe Text -> ValuationType
AtEnd  Maybe Text
mc
      | String
t forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` [String
"now" ,String
"n"]  = forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ Maybe Text -> ValuationType
AtNow  Maybe Text
mc
      | Bool
otherwise = case String -> Maybe Day
parsedateM String
t of
            Just Day
d  -> forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ Day -> Maybe Text -> ValuationType
AtDate Day
d Maybe Text
mc
            Maybe Day
Nothing -> forall a. String -> a
usageError forall a b. (a -> b) -> a -> b
$ String
"could not parse \""forall a. [a] -> [a] -> [a]
++String
tforall a. [a] -> [a] -> [a]
++String
"\" as valuation type, should be: then|end|now|t|e|n|YYYY-MM-DD"
      where
        -- parse --value's value: TYPE[,COMM]
        (String
t,String
c') = forall a. (a -> Bool) -> [a] -> ([a], [a])
break (forall a. Eq a => a -> a -> Bool
==Char
',') String
v
        mc :: Maybe Text
mc     = case forall a. Int -> [a] -> [a]
drop Int
1 String
c' of
                   String
"" -> forall a. Maybe a
Nothing
                   String
c  -> forall a. a -> Maybe a
Just forall a b. (a -> b) -> a -> b
$ String -> Text
T.pack String
c

-- | Parse the type of costing to be performed, if any, specified by -B/--cost
-- or --value flags. If there's more than one costing type, the rightmost flag
-- wins. This will fail with a usage error if an invalid argument is passed to
-- --cost or if a costing type is requested with --gain.
conversionOpFromRawOpts :: RawOpts -> Maybe ConversionOp
conversionOpFromRawOpts :: RawOpts -> Maybe ConversionOp
conversionOpFromRawOpts RawOpts
rawopts
    | forall a. Maybe a -> Bool
isJust Maybe ConversionOp
costFlag Bool -> Bool -> Bool
&& RawOpts -> BalanceCalculation
balancecalcopt RawOpts
rawopts forall a. Eq a => a -> a -> Bool
== BalanceCalculation
CalcGain = forall a. String -> a
usageError String
"--gain cannot be combined with --cost"
    | Bool
otherwise = Maybe ConversionOp
costFlag
  where
    costFlag :: Maybe ConversionOp
costFlag = forall a. [a] -> Maybe a
lastMay forall a b. (a -> b) -> a -> b
$ forall a. ((String, String) -> Maybe a) -> RawOpts -> [a]
collectopts forall {a}. (Eq a, IsString a) => (a, String) -> Maybe ConversionOp
conversionopfromrawopt RawOpts
rawopts
    conversionopfromrawopt :: (a, String) -> Maybe ConversionOp
conversionopfromrawopt (a
n,String
v)  -- option name, value
      | a
n forall a. Eq a => a -> a -> Bool
== a
"B"                                    = forall a. a -> Maybe a
Just ConversionOp
ToCost
      | a
n forall a. Eq a => a -> a -> Bool
== a
"value", forall a. (a -> Bool) -> [a] -> [a]
takeWhile (forall a. Eq a => a -> a -> Bool
/=Char
',') String
v forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` [String
"cost", String
"c"] = forall a. a -> Maybe a
Just ConversionOp
ToCost  -- keep supporting --value=cost for now
      | Bool
otherwise                                   = forall a. Maybe a
Nothing

-- | Select the Transaction date accessor based on --date2.
transactionDateFn :: ReportOpts -> (Transaction -> Day)
transactionDateFn :: ReportOpts -> Transaction -> Day
transactionDateFn ReportOpts{Bool
Int
[Text]
[Status]
Maybe Int
Maybe Text
Maybe NormalSign
Maybe ValuationType
Maybe ConversionOp
Interval
Period
StringFormat
Layout
AccountListMode
BalanceAccumulation
BalanceCalculation
layout_ :: Layout
transpose_ :: Bool
color_ :: Bool
normalbalance_ :: Maybe NormalSign
invert_ :: Bool
percent_ :: Bool
sort_amount_ :: Bool
show_costs_ :: Bool
no_total_ :: Bool
row_total_ :: Bool
declared_ :: Bool
drop_ :: Int
accountlistmode_ :: AccountListMode
budgetpat_ :: Maybe Text
balanceaccum_ :: BalanceAccumulation
balancecalc_ :: BalanceCalculation
txn_dates_ :: Bool
related_ :: Bool
average_ :: Bool
querystring_ :: [Text]
pretty_ :: Bool
format_ :: StringFormat
real_ :: Bool
no_elide_ :: Bool
empty_ :: Bool
date2_ :: Bool
depth_ :: Maybe Int
infer_prices_ :: Bool
value_ :: Maybe ValuationType
conversionop_ :: Maybe ConversionOp
statuses_ :: [Status]
interval_ :: Interval
period_ :: Period
layout_ :: ReportOpts -> Layout
transpose_ :: ReportOpts -> Bool
color_ :: ReportOpts -> Bool
normalbalance_ :: ReportOpts -> Maybe NormalSign
invert_ :: ReportOpts -> Bool
percent_ :: ReportOpts -> Bool
sort_amount_ :: ReportOpts -> Bool
show_costs_ :: ReportOpts -> Bool
no_total_ :: ReportOpts -> Bool
row_total_ :: ReportOpts -> Bool
declared_ :: ReportOpts -> Bool
drop_ :: ReportOpts -> Int
accountlistmode_ :: ReportOpts -> AccountListMode
budgetpat_ :: ReportOpts -> Maybe Text
balanceaccum_ :: ReportOpts -> BalanceAccumulation
balancecalc_ :: ReportOpts -> BalanceCalculation
txn_dates_ :: ReportOpts -> Bool
related_ :: ReportOpts -> Bool
average_ :: ReportOpts -> Bool
querystring_ :: ReportOpts -> [Text]
pretty_ :: ReportOpts -> Bool
format_ :: ReportOpts -> StringFormat
real_ :: ReportOpts -> Bool
no_elide_ :: ReportOpts -> Bool
empty_ :: ReportOpts -> Bool
date2_ :: ReportOpts -> Bool
depth_ :: ReportOpts -> Maybe Int
infer_prices_ :: ReportOpts -> Bool
value_ :: ReportOpts -> Maybe ValuationType
conversionop_ :: ReportOpts -> Maybe ConversionOp
statuses_ :: ReportOpts -> [Status]
interval_ :: ReportOpts -> Interval
period_ :: ReportOpts -> Period
..} = if Bool
date2_ then Transaction -> Day
transactionDate2 else Transaction -> Day
tdate

-- | Select the Posting date accessor based on --date2.
postingDateFn :: ReportOpts -> (Posting -> Day)
postingDateFn :: ReportOpts -> Posting -> Day
postingDateFn ReportOpts{Bool
Int
[Text]
[Status]
Maybe Int
Maybe Text
Maybe NormalSign
Maybe ValuationType
Maybe ConversionOp
Interval
Period
StringFormat
Layout
AccountListMode
BalanceAccumulation
BalanceCalculation
layout_ :: Layout
transpose_ :: Bool
color_ :: Bool
normalbalance_ :: Maybe NormalSign
invert_ :: Bool
percent_ :: Bool
sort_amount_ :: Bool
show_costs_ :: Bool
no_total_ :: Bool
row_total_ :: Bool
declared_ :: Bool
drop_ :: Int
accountlistmode_ :: AccountListMode
budgetpat_ :: Maybe Text
balanceaccum_ :: BalanceAccumulation
balancecalc_ :: BalanceCalculation
txn_dates_ :: Bool
related_ :: Bool
average_ :: Bool
querystring_ :: [Text]
pretty_ :: Bool
format_ :: StringFormat
real_ :: Bool
no_elide_ :: Bool
empty_ :: Bool
date2_ :: Bool
depth_ :: Maybe Int
infer_prices_ :: Bool
value_ :: Maybe ValuationType
conversionop_ :: Maybe ConversionOp
statuses_ :: [Status]
interval_ :: Interval
period_ :: Period
layout_ :: ReportOpts -> Layout
transpose_ :: ReportOpts -> Bool
color_ :: ReportOpts -> Bool
normalbalance_ :: ReportOpts -> Maybe NormalSign
invert_ :: ReportOpts -> Bool
percent_ :: ReportOpts -> Bool
sort_amount_ :: ReportOpts -> Bool
show_costs_ :: ReportOpts -> Bool
no_total_ :: ReportOpts -> Bool
row_total_ :: ReportOpts -> Bool
declared_ :: ReportOpts -> Bool
drop_ :: ReportOpts -> Int
accountlistmode_ :: ReportOpts -> AccountListMode
budgetpat_ :: ReportOpts -> Maybe Text
balanceaccum_ :: ReportOpts -> BalanceAccumulation
balancecalc_ :: ReportOpts -> BalanceCalculation
txn_dates_ :: ReportOpts -> Bool
related_ :: ReportOpts -> Bool
average_ :: ReportOpts -> Bool
querystring_ :: ReportOpts -> [Text]
pretty_ :: ReportOpts -> Bool
format_ :: ReportOpts -> StringFormat
real_ :: ReportOpts -> Bool
no_elide_ :: ReportOpts -> Bool
empty_ :: ReportOpts -> Bool
date2_ :: ReportOpts -> Bool
depth_ :: ReportOpts -> Maybe Int
infer_prices_ :: ReportOpts -> Bool
value_ :: ReportOpts -> Maybe ValuationType
conversionop_ :: ReportOpts -> Maybe ConversionOp
statuses_ :: ReportOpts -> [Status]
interval_ :: ReportOpts -> Interval
period_ :: ReportOpts -> Period
..} = if Bool
date2_ then Posting -> Day
postingDate2 else Posting -> Day
postingDate

-- | Report which date we will report on based on --date2.
whichDate :: ReportOpts -> WhichDate
whichDate :: ReportOpts -> WhichDate
whichDate ReportOpts{Bool
Int
[Text]
[Status]
Maybe Int
Maybe Text
Maybe NormalSign
Maybe ValuationType
Maybe ConversionOp
Interval
Period
StringFormat
Layout
AccountListMode
BalanceAccumulation
BalanceCalculation
layout_ :: Layout
transpose_ :: Bool
color_ :: Bool
normalbalance_ :: Maybe NormalSign
invert_ :: Bool
percent_ :: Bool
sort_amount_ :: Bool
show_costs_ :: Bool
no_total_ :: Bool
row_total_ :: Bool
declared_ :: Bool
drop_ :: Int
accountlistmode_ :: AccountListMode
budgetpat_ :: Maybe Text
balanceaccum_ :: BalanceAccumulation
balancecalc_ :: BalanceCalculation
txn_dates_ :: Bool
related_ :: Bool
average_ :: Bool
querystring_ :: [Text]
pretty_ :: Bool
format_ :: StringFormat
real_ :: Bool
no_elide_ :: Bool
empty_ :: Bool
date2_ :: Bool
depth_ :: Maybe Int
infer_prices_ :: Bool
value_ :: Maybe ValuationType
conversionop_ :: Maybe ConversionOp
statuses_ :: [Status]
interval_ :: Interval
period_ :: Period
layout_ :: ReportOpts -> Layout
transpose_ :: ReportOpts -> Bool
color_ :: ReportOpts -> Bool
normalbalance_ :: ReportOpts -> Maybe NormalSign
invert_ :: ReportOpts -> Bool
percent_ :: ReportOpts -> Bool
sort_amount_ :: ReportOpts -> Bool
show_costs_ :: ReportOpts -> Bool
no_total_ :: ReportOpts -> Bool
row_total_ :: ReportOpts -> Bool
declared_ :: ReportOpts -> Bool
drop_ :: ReportOpts -> Int
accountlistmode_ :: ReportOpts -> AccountListMode
budgetpat_ :: ReportOpts -> Maybe Text
balanceaccum_ :: ReportOpts -> BalanceAccumulation
balancecalc_ :: ReportOpts -> BalanceCalculation
txn_dates_ :: ReportOpts -> Bool
related_ :: ReportOpts -> Bool
average_ :: ReportOpts -> Bool
querystring_ :: ReportOpts -> [Text]
pretty_ :: ReportOpts -> Bool
format_ :: ReportOpts -> StringFormat
real_ :: ReportOpts -> Bool
no_elide_ :: ReportOpts -> Bool
empty_ :: ReportOpts -> Bool
date2_ :: ReportOpts -> Bool
depth_ :: ReportOpts -> Maybe Int
infer_prices_ :: ReportOpts -> Bool
value_ :: ReportOpts -> Maybe ValuationType
conversionop_ :: ReportOpts -> Maybe ConversionOp
statuses_ :: ReportOpts -> [Status]
interval_ :: ReportOpts -> Interval
period_ :: ReportOpts -> Period
..} = if Bool
date2_ then WhichDate
SecondaryDate else WhichDate
PrimaryDate

-- | Legacy-compatible convenience aliases for accountlistmode_.
tree_ :: ReportOpts -> Bool
tree_ :: ReportOpts -> Bool
tree_ ReportOpts{accountlistmode_ :: ReportOpts -> AccountListMode
accountlistmode_ = AccountListMode
ALTree} = Bool
True
tree_ ReportOpts{accountlistmode_ :: ReportOpts -> AccountListMode
accountlistmode_ = AccountListMode
ALFlat} = Bool
False

flat_ :: ReportOpts -> Bool
flat_ :: ReportOpts -> Bool
flat_ = Bool -> Bool
not forall b c a. (b -> c) -> (a -> b) -> a -> c
. ReportOpts -> Bool
tree_

-- depthFromOpts :: ReportOpts -> Int
-- depthFromOpts opts = min (fromMaybe 99999 $ depth_ opts) (queryDepth $ queryFromOpts nulldate opts)

-- | 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.
journalValueAndFilterPostings :: ReportSpec -> Journal -> Journal
journalValueAndFilterPostings :: ReportSpec -> Journal -> Journal
journalValueAndFilterPostings ReportSpec
rspec Journal
j = ReportSpec -> Journal -> PriceOracle -> Journal
journalValueAndFilterPostingsWith ReportSpec
rspec Journal
j PriceOracle
priceoracle
  where priceoracle :: PriceOracle
priceoracle = Bool -> Journal -> PriceOracle
journalPriceOracle (ReportOpts -> Bool
infer_prices_ forall a b. (a -> b) -> a -> b
$ ReportSpec -> ReportOpts
_rsReportOpts ReportSpec
rspec) Journal
j

-- | Like 'journalValueAndFilterPostings', but takes a 'PriceOracle' as an argument.
journalValueAndFilterPostingsWith :: ReportSpec -> Journal -> PriceOracle -> Journal
journalValueAndFilterPostingsWith :: ReportSpec -> Journal -> PriceOracle -> Journal
journalValueAndFilterPostingsWith rspec :: ReportSpec
rspec@ReportSpec{_rsQuery :: ReportSpec -> Query
_rsQuery=Query
q, _rsReportOpts :: ReportSpec -> ReportOpts
_rsReportOpts=ReportOpts
ropts} Journal
j =
    -- Filter by the remainder of the query
      Query -> Journal -> Journal
filterJournal Query
reportq
    -- Apply valuation and costing
    forall b c a. (b -> c) -> (a -> b) -> a -> c
. ReportSpec -> Journal -> PriceOracle -> Journal
journalApplyValuationFromOptsWith ReportSpec
rspec
    -- Filter by amount and currency, so it matches pre-valuation/costing
      (if Query -> Bool
queryIsNull Query
amtsymq then Journal
j else Query -> Journal -> Journal
filterJournalAmounts Query
amtsymq Journal
j)
  where
    -- with -r, replace each posting with its sibling postings
    filterJournal :: Query -> Journal -> Journal
filterJournal = if ReportOpts -> Bool
related_ ReportOpts
ropts then Query -> Journal -> Journal
filterJournalRelatedPostings else Query -> Journal -> Journal
filterJournalPostings
    amtsymq :: Query
amtsymq = forall a. Show a => String -> a -> a
dbg3 String
"amtsymq" forall a b. (a -> b) -> a -> b
$ (Query -> Bool) -> Query -> Query
filterQuery Query -> Bool
queryIsAmtOrSym Query
q
    reportq :: Query
reportq = forall a. Show a => String -> a -> a
dbg3 String
"reportq" forall a b. (a -> b) -> a -> b
$ (Query -> Bool) -> Query -> Query
filterQuery (Bool -> Bool
not forall b c a. (b -> c) -> (a -> b) -> a -> c
. Query -> Bool
queryIsAmtOrSym) Query
q
    queryIsAmtOrSym :: Query -> Bool
queryIsAmtOrSym = forall (f :: * -> *) a b c.
Applicative f =>
(a -> b -> c) -> f a -> f b -> f c
liftA2 Bool -> Bool -> Bool
(||) Query -> Bool
queryIsAmt Query -> Bool
queryIsSym

-- | 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.
journalApplyValuationFromOpts :: ReportSpec -> Journal -> Journal
journalApplyValuationFromOpts :: ReportSpec -> Journal -> Journal
journalApplyValuationFromOpts ReportSpec
rspec Journal
j =
    ReportSpec -> Journal -> PriceOracle -> Journal
journalApplyValuationFromOptsWith ReportSpec
rspec Journal
j PriceOracle
priceoracle
  where priceoracle :: PriceOracle
priceoracle = Bool -> Journal -> PriceOracle
journalPriceOracle (ReportOpts -> Bool
infer_prices_ forall a b. (a -> b) -> a -> b
$ ReportSpec -> ReportOpts
_rsReportOpts ReportSpec
rspec) Journal
j

-- | Like journalApplyValuationFromOpts, but takes PriceOracle as an argument.
journalApplyValuationFromOptsWith :: ReportSpec -> Journal -> PriceOracle -> Journal
journalApplyValuationFromOptsWith :: ReportSpec -> Journal -> PriceOracle -> Journal
journalApplyValuationFromOptsWith rspec :: ReportSpec
rspec@ReportSpec{_rsReportOpts :: ReportSpec -> ReportOpts
_rsReportOpts=ReportOpts
ropts} Journal
j PriceOracle
priceoracle =
    case ReportOpts -> BalanceCalculation
balancecalc_ ReportOpts
ropts of
      BalanceCalculation
CalcGain -> (Posting -> Posting) -> Journal -> Journal
journalMapPostings (\Posting
p -> (MixedAmount -> MixedAmount) -> Posting -> Posting
postingTransformAmount (Posting -> MixedAmount -> MixedAmount
gain Posting
p) Posting
p) Journal
j
      BalanceCalculation
_        -> (Posting -> Posting) -> Journal -> Journal
journalMapPostings (\Posting
p -> (MixedAmount -> MixedAmount) -> Posting -> Posting
postingTransformAmount (Posting -> MixedAmount -> MixedAmount
valuation Posting
p) Posting
p) forall a b. (a -> b) -> a -> b
$ Journal -> Journal
costing Journal
j
  where
    valuation :: Posting -> MixedAmount -> MixedAmount
valuation Posting
p = forall b a. b -> (a -> b) -> Maybe a -> b
maybe forall a. a -> a
id (PriceOracle
-> Map Text AmountStyle
-> Day
-> Day
-> Day
-> ValuationType
-> MixedAmount
-> MixedAmount
mixedAmountApplyValuation PriceOracle
priceoracle Map Text AmountStyle
styles (Posting -> Day
postingperiodend Posting
p) (ReportSpec -> Day
_rsDay ReportSpec
rspec) (Posting -> Day
postingDate Posting
p)) (ReportOpts -> Maybe ValuationType
value_ ReportOpts
ropts)
    gain :: Posting -> MixedAmount -> MixedAmount
gain      Posting
p = forall b a. b -> (a -> b) -> Maybe a -> b
maybe forall a. a -> a
id (PriceOracle
-> Map Text AmountStyle
-> Day
-> Day
-> Day
-> ValuationType
-> MixedAmount
-> MixedAmount
mixedAmountApplyGain      PriceOracle
priceoracle Map Text AmountStyle
styles (Posting -> Day
postingperiodend Posting
p) (ReportSpec -> Day
_rsDay ReportSpec
rspec) (Posting -> Day
postingDate Posting
p)) (ReportOpts -> Maybe ValuationType
value_ ReportOpts
ropts)
    costing :: Journal -> Journal
costing     = ConversionOp -> Journal -> Journal
journalToCost (forall a. a -> Maybe a -> a
fromMaybe ConversionOp
NoConversionOp forall a b. (a -> b) -> a -> b
$ ReportOpts -> Maybe ConversionOp
conversionop_ ReportOpts
ropts)

    -- Find the end of the period containing this posting
    postingperiodend :: Posting -> Day
postingperiodend  = Year -> Day -> Day
addDays (-Year
1) forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. a -> Maybe a -> a
fromMaybe forall {a}. a
err forall b c a. (b -> c) -> (a -> b) -> a -> c
. Day -> Maybe Day
mPeriodEnd forall b c a. (b -> c) -> (a -> b) -> a -> c
. WhichDate -> Posting -> Day
postingDateOrDate2 (ReportOpts -> WhichDate
whichDate ReportOpts
ropts)
    mPeriodEnd :: Day -> Maybe Day
mPeriodEnd = case ReportOpts -> Interval
interval_ ReportOpts
ropts of
        Interval
NoInterval -> forall a b. a -> b -> a
const forall b c a. (b -> c) -> (a -> b) -> a -> c
. DateSpan -> Maybe Day
spanEnd forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. (a, b) -> a
fst forall a b. (a -> b) -> a -> b
$ Journal -> ReportSpec -> (DateSpan, [DateSpan])
reportSpan Journal
j ReportSpec
rspec
        Interval
_          -> DateSpan -> Maybe Day
spanEnd forall (m :: * -> *) b c a.
Monad m =>
(b -> m c) -> (a -> m b) -> a -> m c
<=< [DateSpan] -> Day -> Maybe DateSpan
latestSpanContaining (DateSpan
historical forall a. a -> [a] -> [a]
: [DateSpan]
spans)
    historical :: DateSpan
historical = Maybe EFDay -> Maybe EFDay -> DateSpan
DateSpan forall a. Maybe a
Nothing forall a b. (a -> b) -> a -> b
$ (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap Day -> EFDay
Exact forall b c a. (b -> c) -> (a -> b) -> a -> c
. DateSpan -> Maybe Day
spanStart) forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< forall a. [a] -> Maybe a
headMay [DateSpan]
spans
    spans :: [DateSpan]
spans = forall a b. (a, b) -> b
snd forall a b. (a -> b) -> a -> b
$ Journal -> ReportSpec -> (DateSpan, [DateSpan])
reportSpanBothDates Journal
j ReportSpec
rspec
    styles :: Map Text AmountStyle
styles = Journal -> Map Text AmountStyle
journalCommodityStyles Journal
j
    err :: a
err = forall a. HasCallStack => String -> a
error String
"journalApplyValuationFromOpts: expected all spans to have an end date"

-- | Select the Account valuation functions required for performing valuation after summing
-- amounts. Used in MultiBalanceReport to value historical and similar reports.
mixedAmountApplyValuationAfterSumFromOptsWith :: ReportOpts -> Journal -> PriceOracle
                                              -> (DateSpan -> MixedAmount -> MixedAmount)
mixedAmountApplyValuationAfterSumFromOptsWith :: ReportOpts
-> Journal -> PriceOracle -> DateSpan -> MixedAmount -> MixedAmount
mixedAmountApplyValuationAfterSumFromOptsWith ReportOpts
ropts Journal
j PriceOracle
priceoracle =
    case ReportOpts -> Maybe (Maybe Text)
valuationAfterSum ReportOpts
ropts of
        Just Maybe Text
mc -> case ReportOpts -> BalanceCalculation
balancecalc_ ReportOpts
ropts of
            BalanceCalculation
CalcGain -> Maybe Text -> DateSpan -> MixedAmount -> MixedAmount
gain Maybe Text
mc
            BalanceCalculation
_        -> \DateSpan
spn -> Maybe Text -> DateSpan -> MixedAmount -> MixedAmount
valuation Maybe Text
mc DateSpan
spn forall b c a. (b -> c) -> (a -> b) -> a -> c
. MixedAmount -> MixedAmount
costing
        Maybe (Maybe Text)
Nothing      -> forall a b. a -> b -> a
const forall a. a -> a
id
  where
    valuation :: Maybe Text -> DateSpan -> MixedAmount -> MixedAmount
valuation Maybe Text
mc DateSpan
spn = PriceOracle
-> Map Text AmountStyle
-> Maybe Text
-> Day
-> MixedAmount
-> MixedAmount
mixedAmountValueAtDate PriceOracle
priceoracle Map Text AmountStyle
styles Maybe Text
mc (forall b a. b -> (a -> b) -> Maybe a -> b
maybe forall {a}. a
err (Year -> Day -> Day
addDays (-Year
1)) forall a b. (a -> b) -> a -> b
$ DateSpan -> Maybe Day
spanEnd DateSpan
spn)
    gain :: Maybe Text -> DateSpan -> MixedAmount -> MixedAmount
gain Maybe Text
mc DateSpan
spn = PriceOracle
-> Map Text AmountStyle
-> Maybe Text
-> Day
-> MixedAmount
-> MixedAmount
mixedAmountGainAtDate PriceOracle
priceoracle Map Text AmountStyle
styles Maybe Text
mc (forall b a. b -> (a -> b) -> Maybe a -> b
maybe forall {a}. a
err (Year -> Day -> Day
addDays (-Year
1)) forall a b. (a -> b) -> a -> b
$ DateSpan -> Maybe Day
spanEnd DateSpan
spn)
    costing :: MixedAmount -> MixedAmount
costing = case forall a. a -> Maybe a -> a
fromMaybe ConversionOp
NoConversionOp forall a b. (a -> b) -> a -> b
$ ReportOpts -> Maybe ConversionOp
conversionop_ ReportOpts
ropts of
        ConversionOp
NoConversionOp -> forall a. a -> a
id
        ConversionOp
ToCost         -> Map Text AmountStyle -> MixedAmount -> MixedAmount
styleMixedAmount Map Text AmountStyle
styles forall b c a. (b -> c) -> (a -> b) -> a -> c
. MixedAmount -> MixedAmount
mixedAmountCost
    styles :: Map Text AmountStyle
styles = Journal -> Map Text AmountStyle
journalCommodityStyles Journal
j
    err :: a
err = forall a. HasCallStack => String -> a
error String
"mixedAmountApplyValuationAfterSumFromOptsWith: expected all spans to have an end date"

-- | 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.
valuationAfterSum :: ReportOpts -> Maybe (Maybe CommoditySymbol)
valuationAfterSum :: ReportOpts -> Maybe (Maybe Text)
valuationAfterSum ReportOpts
ropts = case ReportOpts -> Maybe ValuationType
value_ ReportOpts
ropts of
    Just (AtEnd Maybe Text
mc) | Bool
valueAfterSum -> forall a. a -> Maybe a
Just Maybe Text
mc
    Maybe ValuationType
_                               -> forall a. Maybe a
Nothing
  where valueAfterSum :: Bool
valueAfterSum = ReportOpts -> BalanceCalculation
balancecalc_  ReportOpts
ropts forall a. Eq a => a -> a -> Bool
== BalanceCalculation
CalcValueChange
                     Bool -> Bool -> Bool
|| ReportOpts -> BalanceCalculation
balancecalc_  ReportOpts
ropts forall a. Eq a => a -> a -> Bool
== BalanceCalculation
CalcGain
                     Bool -> Bool -> Bool
|| ReportOpts -> BalanceAccumulation
balanceaccum_ ReportOpts
ropts forall a. Eq a => a -> a -> Bool
/= BalanceAccumulation
PerPeriod


-- | Convert report options to a query, ignoring any non-flag command line arguments.
queryFromFlags :: ReportOpts -> Query
queryFromFlags :: ReportOpts -> Query
queryFromFlags ReportOpts{Bool
Int
[Text]
[Status]
Maybe Int
Maybe Text
Maybe NormalSign
Maybe ValuationType
Maybe ConversionOp
Interval
Period
StringFormat
Layout
AccountListMode
BalanceAccumulation
BalanceCalculation
layout_ :: Layout
transpose_ :: Bool
color_ :: Bool
normalbalance_ :: Maybe NormalSign
invert_ :: Bool
percent_ :: Bool
sort_amount_ :: Bool
show_costs_ :: Bool
no_total_ :: Bool
row_total_ :: Bool
declared_ :: Bool
drop_ :: Int
accountlistmode_ :: AccountListMode
budgetpat_ :: Maybe Text
balanceaccum_ :: BalanceAccumulation
balancecalc_ :: BalanceCalculation
txn_dates_ :: Bool
related_ :: Bool
average_ :: Bool
querystring_ :: [Text]
pretty_ :: Bool
format_ :: StringFormat
real_ :: Bool
no_elide_ :: Bool
empty_ :: Bool
date2_ :: Bool
depth_ :: Maybe Int
infer_prices_ :: Bool
value_ :: Maybe ValuationType
conversionop_ :: Maybe ConversionOp
statuses_ :: [Status]
interval_ :: Interval
period_ :: Period
layout_ :: ReportOpts -> Layout
transpose_ :: ReportOpts -> Bool
color_ :: ReportOpts -> Bool
normalbalance_ :: ReportOpts -> Maybe NormalSign
invert_ :: ReportOpts -> Bool
percent_ :: ReportOpts -> Bool
sort_amount_ :: ReportOpts -> Bool
show_costs_ :: ReportOpts -> Bool
no_total_ :: ReportOpts -> Bool
row_total_ :: ReportOpts -> Bool
declared_ :: ReportOpts -> Bool
drop_ :: ReportOpts -> Int
accountlistmode_ :: ReportOpts -> AccountListMode
budgetpat_ :: ReportOpts -> Maybe Text
balanceaccum_ :: ReportOpts -> BalanceAccumulation
balancecalc_ :: ReportOpts -> BalanceCalculation
txn_dates_ :: ReportOpts -> Bool
related_ :: ReportOpts -> Bool
average_ :: ReportOpts -> Bool
querystring_ :: ReportOpts -> [Text]
pretty_ :: ReportOpts -> Bool
format_ :: ReportOpts -> StringFormat
real_ :: ReportOpts -> Bool
no_elide_ :: ReportOpts -> Bool
empty_ :: ReportOpts -> Bool
date2_ :: ReportOpts -> Bool
depth_ :: ReportOpts -> Maybe Int
infer_prices_ :: ReportOpts -> Bool
value_ :: ReportOpts -> Maybe ValuationType
conversionop_ :: ReportOpts -> Maybe ConversionOp
statuses_ :: ReportOpts -> [Status]
interval_ :: ReportOpts -> Interval
period_ :: ReportOpts -> Period
..} = Query -> Query
simplifyQuery forall a b. (a -> b) -> a -> b
$ [Query] -> Query
And [Query]
flagsq
  where
    flagsq :: [Query]
flagsq = forall {a}. (Bool -> a) -> Bool -> [a] -> [a]
consIf   Bool -> Query
Real  Bool
real_
           forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall {a} {b}. (a -> b) -> Maybe a -> [b] -> [b]
consJust Int -> Query
Depth Maybe Int
depth_
           forall a b. (a -> b) -> a -> b
$   [ (if Bool
date2_ then DateSpan -> Query
Date2 else DateSpan -> Query
Date) forall a b. (a -> b) -> a -> b
$ Period -> DateSpan
periodAsDateSpan Period
period_
               , [Query] -> Query
Or forall a b. (a -> b) -> a -> b
$ forall a b. (a -> b) -> [a] -> [b]
map Status -> Query
StatusQ [Status]
statuses_
               ]
    consIf :: (Bool -> a) -> Bool -> [a] -> [a]
consIf Bool -> a
f Bool
b = if Bool
b then (Bool -> a
f Bool
Trueforall a. a -> [a] -> [a]
:) else forall a. a -> a
id
    consJust :: (a -> b) -> Maybe a -> [b] -> [b]
consJust a -> b
f = forall b a. b -> (a -> b) -> Maybe a -> b
maybe forall a. a -> a
id ((:) forall b c a. (b -> c) -> (a -> b) -> a -> c
. a -> b
f)

-- Report dates.

-- | 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.
reportSpan :: Journal -> ReportSpec -> (DateSpan, [DateSpan])
reportSpan :: Journal -> ReportSpec -> (DateSpan, [DateSpan])
reportSpan = Bool -> Journal -> ReportSpec -> (DateSpan, [DateSpan])
reportSpanHelper Bool
False

-- | Like reportSpan, but uses both primary and secondary dates when calculating
-- the span.
reportSpanBothDates :: Journal -> ReportSpec -> (DateSpan, [DateSpan])
reportSpanBothDates :: Journal -> ReportSpec -> (DateSpan, [DateSpan])
reportSpanBothDates = Bool -> Journal -> ReportSpec -> (DateSpan, [DateSpan])
reportSpanHelper Bool
True

-- | A helper for reportSpan, which takes a Bool indicating whether to use both
-- primary and secondary dates.
reportSpanHelper :: Bool -> Journal -> ReportSpec -> (DateSpan, [DateSpan])
reportSpanHelper :: Bool -> Journal -> ReportSpec -> (DateSpan, [DateSpan])
reportSpanHelper Bool
bothdates Journal
j ReportSpec{_rsQuery :: ReportSpec -> Query
_rsQuery=Query
query, _rsReportOpts :: ReportSpec -> ReportOpts
_rsReportOpts=ReportOpts
ropts} =
    (DateSpan
reportspan, [DateSpan]
intervalspans)
  where
    -- The date span specified by -b/-e/-p options and query args if any.
    requestedspan :: DateSpan
requestedspan  = forall a. Show a => String -> a -> a
dbg3 String
"requestedspan" forall a b. (a -> b) -> a -> b
$ if Bool
bothdates then Query -> DateSpan
queryDateSpan' Query
query else Bool -> Query -> DateSpan
queryDateSpan (ReportOpts -> Bool
date2_ ReportOpts
ropts) Query
query
    -- If we are requesting period-end valuation, the journal date span should
    -- include price directives after the last transaction
    journalspan :: DateSpan
journalspan = forall a. Show a => String -> a -> a
dbg3 String
"journalspan" forall a b. (a -> b) -> a -> b
$ if Bool
bothdates then Journal -> DateSpan
journalDateSpanBothDates Journal
j else Bool -> Journal -> DateSpan
journalDateSpan (ReportOpts -> Bool
date2_ ReportOpts
ropts) Journal
j
    pricespan :: DateSpan
pricespan = forall a. Show a => String -> a -> a
dbg3 String
"pricespan" forall b c a. (b -> c) -> (a -> b) -> a -> c
. Maybe EFDay -> Maybe EFDay -> DateSpan
DateSpan forall a. Maybe a
Nothing forall a b. (a -> b) -> a -> b
$ case ReportOpts -> Maybe ValuationType
value_ ReportOpts
ropts of
        Just (AtEnd Maybe Text
_) -> forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (Day -> EFDay
Exact forall b c a. (b -> c) -> (a -> b) -> a -> c
. Year -> Day -> Day
addDays Year
1) forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. Ord a => [a] -> Maybe a
maximumMay forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. (a -> b) -> [a] -> [b]
map PriceDirective -> Day
pddate forall a b. (a -> b) -> a -> b
$ Journal -> [PriceDirective]
jpricedirectives Journal
j
        Maybe ValuationType
_              -> forall a. Maybe a
Nothing
    -- If the requested span is open-ended, close it using the journal's start and end dates.
    -- This can still be the null (open) span if the journal is empty.
    requestedspan' :: DateSpan
requestedspan' = forall a. Show a => String -> a -> a
dbg3 String
"requestedspan'" forall a b. (a -> b) -> a -> b
$ DateSpan
requestedspan DateSpan -> DateSpan -> DateSpan
`spanDefaultsFrom` (DateSpan
journalspan DateSpan -> DateSpan -> DateSpan
`spanUnion` DateSpan
pricespan)
    -- The list of interval spans enclosing the requested span.
    -- This list can be empty if the journal was empty,
    -- or if hledger-ui has added its special date:-tomorrow to the query
    -- and all txns are in the future.
    intervalspans :: [DateSpan]
intervalspans  = forall a. Show a => String -> a -> a
dbg3 String
"intervalspans" forall a b. (a -> b) -> a -> b
$ Bool -> Interval -> DateSpan -> [DateSpan]
splitSpan Bool
adjust (ReportOpts -> Interval
interval_ ReportOpts
ropts) DateSpan
requestedspan'
      where
        -- When calculating report periods, we will adjust the start date back to the nearest interval boundary
        -- unless a start date was specified explicitly.
        adjust :: Bool
adjust = forall a. Maybe a -> Bool
isNothing forall a b. (a -> b) -> a -> b
$ DateSpan -> Maybe Day
spanStart DateSpan
requestedspan
    -- The requested span enlarged to enclose a whole number of intervals.
    -- This can be the null span if there were no intervals.
    reportspan :: DateSpan
reportspan = forall a. Show a => String -> a -> a
dbg3 String
"reportspan" forall a b. (a -> b) -> a -> b
$ Maybe EFDay -> Maybe EFDay -> DateSpan
DateSpan (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap Day -> EFDay
Exact forall b c a. (b -> c) -> (a -> b) -> a -> c
. DateSpan -> Maybe Day
spanStart forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< forall a. [a] -> Maybe a
headMay [DateSpan]
intervalspans)
                                              (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap Day -> EFDay
Exact forall b c a. (b -> c) -> (a -> b) -> a -> c
. DateSpan -> Maybe Day
spanEnd forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< forall a. [a] -> Maybe a
lastMay [DateSpan]
intervalspans)

reportStartDate :: Journal -> ReportSpec -> Maybe Day
reportStartDate :: Journal -> ReportSpec -> Maybe Day
reportStartDate Journal
j = DateSpan -> Maybe Day
spanStart forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. (a, b) -> a
fst forall b c a. (b -> c) -> (a -> b) -> a -> c
. Journal -> ReportSpec -> (DateSpan, [DateSpan])
reportSpan Journal
j

reportEndDate :: Journal -> ReportSpec -> Maybe Day
reportEndDate :: Journal -> ReportSpec -> Maybe Day
reportEndDate Journal
j = DateSpan -> Maybe Day
spanEnd forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. (a, b) -> a
fst forall b c a. (b -> c) -> (a -> b) -> a -> c
. Journal -> ReportSpec -> (DateSpan, [DateSpan])
reportSpan Journal
j

-- Some pure alternatives to the above. XXX review/clean up

-- Get the report's start date.
-- If no report period is specified, will be Nothing.
reportPeriodStart :: ReportSpec -> Maybe Day
reportPeriodStart :: ReportSpec -> Maybe Day
reportPeriodStart = Bool -> Query -> Maybe Day
queryStartDate Bool
False forall b c a. (b -> c) -> (a -> b) -> a -> c
. ReportSpec -> Query
_rsQuery

-- Get the report's start date, or if no report period is specified,
-- the journal's start date (the earliest posting date). If there's no
-- report period and nothing in the journal, will be Nothing.
reportPeriodOrJournalStart :: ReportSpec -> Journal -> Maybe Day
reportPeriodOrJournalStart :: ReportSpec -> Journal -> Maybe Day
reportPeriodOrJournalStart ReportSpec
rspec Journal
j =
  ReportSpec -> Maybe Day
reportPeriodStart ReportSpec
rspec forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> Bool -> Journal -> Maybe Day
journalStartDate Bool
False Journal
j

-- Get the last day of the overall report period.
-- This the inclusive end date (one day before the
-- more commonly used, exclusive, report end date).
-- If no report period is specified, will be Nothing.
reportPeriodLastDay :: ReportSpec -> Maybe Day
reportPeriodLastDay :: ReportSpec -> Maybe Day
reportPeriodLastDay = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (Year -> Day -> Day
addDays (-Year
1)) forall b c a. (b -> c) -> (a -> b) -> a -> c
. Bool -> Query -> Maybe Day
queryEndDate Bool
False forall b c a. (b -> c) -> (a -> b) -> a -> c
. ReportSpec -> Query
_rsQuery

-- Get the last day of the overall report period, or if no report
-- period is specified, the last day of the journal (ie the latest
-- posting date). If we're doing period-end valuation, include price
-- directive dates. If there's no report period and nothing in the
-- journal, will be Nothing.
reportPeriodOrJournalLastDay :: ReportSpec -> Journal -> Maybe Day
reportPeriodOrJournalLastDay :: ReportSpec -> Journal -> Maybe Day
reportPeriodOrJournalLastDay ReportSpec
rspec Journal
j = ReportSpec -> Maybe Day
reportPeriodLastDay ReportSpec
rspec forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> Maybe Day
journalOrPriceEnd
  where
    journalOrPriceEnd :: Maybe Day
journalOrPriceEnd = case ReportOpts -> Maybe ValuationType
value_ forall a b. (a -> b) -> a -> b
$ ReportSpec -> ReportOpts
_rsReportOpts ReportSpec
rspec of
        Just (AtEnd Maybe Text
_) -> forall a. Ord a => a -> a -> a
max (Bool -> Journal -> Maybe Day
journalLastDay Bool
False Journal
j) Maybe Day
lastPriceDirective
        Maybe ValuationType
_              -> Bool -> Journal -> Maybe Day
journalLastDay Bool
False Journal
j
    lastPriceDirective :: Maybe Day
lastPriceDirective = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (Year -> Day -> Day
addDays Year
1) forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. Ord a => [a] -> Maybe a
maximumMay forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. (a -> b) -> [a] -> [b]
map PriceDirective -> Day
pddate forall a b. (a -> b) -> a -> b
$ Journal -> [PriceDirective]
jpricedirectives Journal
j

-- | 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).
reportPeriodName :: BalanceAccumulation -> [DateSpan] -> DateSpan -> T.Text
reportPeriodName :: BalanceAccumulation -> [DateSpan] -> DateSpan -> Text
reportPeriodName BalanceAccumulation
balanceaccumulation [DateSpan]
spans =
  case BalanceAccumulation
balanceaccumulation of
    BalanceAccumulation
PerPeriod -> if Bool
multiyear then DateSpan -> Text
showDateSpan else DateSpan -> Text
showDateSpanMonthAbbrev
      where
        multiyear :: Bool
multiyear = (forall a. Ord a => a -> a -> Bool
>Int
1) forall a b. (a -> b) -> a -> b
$ forall (t :: * -> *) a. Foldable t => t a -> Int
length forall a b. (a -> b) -> a -> b
$ forall {a}. Ord a => [a] -> [a]
nubSort forall a b. (a -> b) -> a -> b
$ forall a b. (a -> b) -> [a] -> [b]
map DateSpan -> Maybe Year
spanStartYear [DateSpan]
spans
    BalanceAccumulation
_ -> forall b a. b -> (a -> b) -> Maybe a -> b
maybe Text
"" (Day -> Text
showDate forall b c a. (b -> c) -> (a -> b) -> a -> c
. Day -> Day
prevday) forall b c a. (b -> c) -> (a -> b) -> a -> c
. DateSpan -> Maybe Day
spanEnd

-- lenses

-- Reportable functors are so that we can create special lenses which can fail
-- and report on their failure.
class Functor f => Reportable f e where
    report :: a -> f (Either e a) -> f a

instance Reportable (Const r) e where
    report :: forall a. a -> Const r (Either e a) -> Const r a
report a
_ (Const r
x) = forall {k} a (b :: k). a -> Const a b
Const r
x

instance Reportable Identity e where
    report :: forall a. a -> Identity (Either e a) -> Identity a
report a
a (Identity Either e a
i) = forall a. a -> Identity a
Identity forall a b. (a -> b) -> a -> b
$ forall b a. b -> Either a b -> b
fromRight a
a Either e a
i

instance Reportable Maybe e where
    report :: forall a. a -> Maybe (Either e a) -> Maybe a
report a
_ = (forall a b. Either a b -> Maybe b
eitherToMaybe forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<<)

instance (e ~ a) => Reportable (Either a) e where
    report :: forall a. a -> Either a (Either e a) -> Either a a
report a
_ = forall (m :: * -> *) a. Monad m => m (m a) -> m a
join

-- | Apply a function over a lens, but report on failure.
overEither :: ((a -> Either e b) -> s -> Either e t) -> (a -> b) -> s -> Either e t
overEither :: forall a e b s t.
((a -> Either e b) -> s -> Either e t)
-> (a -> b) -> s -> Either e t
overEither (a -> Either e b) -> s -> Either e t
l a -> b
f = (a -> Either e b) -> s -> Either e t
l (forall (f :: * -> *) a. Applicative f => a -> f a
pure forall b c a. (b -> c) -> (a -> b) -> a -> c
. a -> b
f)

-- | Set a field using a lens, but report on failure.
setEither :: ((a -> Either e b) -> s -> Either e t) -> b -> s -> Either e t
setEither :: forall a e b s t.
((a -> Either e b) -> s -> Either e t) -> b -> s -> Either e t
setEither (a -> Either e b) -> s -> Either e t
l = forall a e b s t.
((a -> Either e b) -> s -> Either e t)
-> (a -> b) -> s -> Either e t
overEither (a -> Either e b) -> s -> Either e t
l forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. a -> b -> a
const

type ReportableLens' s a = forall f. Reportable f String => (a -> f a) -> s -> f s

-- | Lenses for ReportOpts.

-- Implement HasReportOptsNoUpdate, the basic lenses for ReportOpts.
makeHledgerClassyLenses ''ReportOpts
makeHledgerClassyLenses ''ReportSpec

-- | 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
class HasReportOptsNoUpdate a => HasReportOpts a where
    reportOpts :: ReportableLens' a ReportOpts
    reportOpts = forall c. HasReportOptsNoUpdate c => Lens' c ReportOpts
reportOptsNoUpdate
    {-# INLINE reportOpts #-}

    -- XXX these names are a bit clashy

    period :: ReportableLens' a Period
    period = forall a. HasReportOpts a => ReportableLens' a ReportOpts
reportOptsforall b c a. (b -> c) -> (a -> b) -> a -> c
.forall c. HasReportOptsNoUpdate c => Lens' c Period
periodNoUpdate
    {-# INLINE period #-}

    statuses :: ReportableLens' a [Status]
    statuses = forall a. HasReportOpts a => ReportableLens' a ReportOpts
reportOptsforall b c a. (b -> c) -> (a -> b) -> a -> c
.forall c. HasReportOptsNoUpdate c => Lens' c [Status]
statusesNoUpdate
    {-# INLINE statuses #-}

    depth :: ReportableLens' a (Maybe Int)
    depth = forall a. HasReportOpts a => ReportableLens' a ReportOpts
reportOptsforall b c a. (b -> c) -> (a -> b) -> a -> c
.forall c. HasReportOptsNoUpdate c => Lens' c (Maybe Int)
depthNoUpdate
    {-# INLINE depth #-}

    date2 :: ReportableLens' a Bool
    date2 = forall a. HasReportOpts a => ReportableLens' a ReportOpts
reportOptsforall b c a. (b -> c) -> (a -> b) -> a -> c
.forall c. HasReportOptsNoUpdate c => Lens' c Bool
date2NoUpdate
    {-# INLINE date2 #-}

    real :: ReportableLens' a Bool
    real = forall a. HasReportOpts a => ReportableLens' a ReportOpts
reportOptsforall b c a. (b -> c) -> (a -> b) -> a -> c
.forall c. HasReportOptsNoUpdate c => Lens' c Bool
realNoUpdate
    {-# INLINE real #-}

    querystring :: ReportableLens' a [T.Text]
    querystring = forall a. HasReportOpts a => ReportableLens' a ReportOpts
reportOptsforall b c a. (b -> c) -> (a -> b) -> a -> c
.forall c. HasReportOptsNoUpdate c => Lens' c [Text]
querystringNoUpdate
    {-# INLINE querystring #-}

instance HasReportOpts ReportOpts

instance HasReportOptsNoUpdate ReportSpec where
    reportOptsNoUpdate :: Lens' ReportSpec ReportOpts
reportOptsNoUpdate = forall c. HasReportSpec c => Lens' c ReportOpts
rsReportOpts

instance HasReportOpts ReportSpec where
    reportOpts :: ReportableLens' ReportSpec ReportOpts
reportOpts ReportOpts -> f ReportOpts
f ReportSpec
rspec = forall (f :: * -> *) e a.
Reportable f e =>
a -> f (Either e a) -> f a
report (forall a. String -> a
error' String
"Updating ReportSpec failed: try using overEither instead of over or setEither instead of set") forall a b. (a -> b) -> a -> b
$  -- PARTIAL:
      Day -> ReportOpts -> Either String ReportSpec
reportOptsToSpec (ReportSpec -> Day
_rsDay ReportSpec
rspec) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> ReportOpts -> f ReportOpts
f (ReportSpec -> ReportOpts
_rsReportOpts ReportSpec
rspec)
    {-# INLINE reportOpts #-}

-- | Generate a ReportSpec from a set of ReportOpts on a given day.
reportOptsToSpec :: Day -> ReportOpts -> Either String ReportSpec
reportOptsToSpec :: Day -> ReportOpts -> Either String ReportSpec
reportOptsToSpec Day
day ReportOpts
ropts = do
    (Query
argsquery, [QueryOpt]
queryopts) <- Day -> [Text] -> Either String (Query, [QueryOpt])
parseQueryList Day
day forall a b. (a -> b) -> a -> b
$ ReportOpts -> [Text]
querystring_ ReportOpts
ropts
    forall (m :: * -> *) a. Monad m => a -> m a
return ReportSpec
      { _rsReportOpts :: ReportOpts
_rsReportOpts = ReportOpts
ropts
      , _rsDay :: Day
_rsDay        = Day
day
      , _rsQuery :: Query
_rsQuery      = Query -> Query
simplifyQuery forall a b. (a -> b) -> a -> b
$ [Query] -> Query
And [ReportOpts -> Query
queryFromFlags ReportOpts
ropts, Query
argsquery]
      , _rsQueryOpts :: [QueryOpt]
_rsQueryOpts  = [QueryOpt]
queryopts
      }

-- | 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.
updateReportSpec :: ReportOpts -> ReportSpec -> Either String ReportSpec
updateReportSpec :: ReportOpts -> ReportSpec -> Either String ReportSpec
updateReportSpec = forall a e b s t.
((a -> Either e b) -> s -> Either e t) -> b -> s -> Either e t
setEither forall a. HasReportOpts a => ReportableLens' a ReportOpts
reportOpts

-- | Like updateReportSpec, but takes a ReportOpts-modifying function.
updateReportSpecWith :: (ReportOpts -> ReportOpts) -> ReportSpec -> Either String ReportSpec
updateReportSpecWith :: (ReportOpts -> ReportOpts)
-> ReportSpec -> Either String ReportSpec
updateReportSpecWith = forall a e b s t.
((a -> Either e b) -> s -> Either e t)
-> (a -> b) -> s -> Either e t
overEither forall a. HasReportOpts a => ReportableLens' a ReportOpts
reportOpts

-- | Generate a ReportSpec from RawOpts and a provided day, or return an error
-- string if there are regular expression errors.
rawOptsToReportSpec :: Day -> RawOpts -> Either String ReportSpec
rawOptsToReportSpec :: Day -> RawOpts -> Either String ReportSpec
rawOptsToReportSpec Day
day = Day -> ReportOpts -> Either String ReportSpec
reportOptsToSpec Day
day forall b c a. (b -> c) -> (a -> b) -> a -> c
. Day -> RawOpts -> ReportOpts
rawOptsToReportOpts Day
day