HORIZON HASKELLDocslts/ghc-10.0.x8c2f8e82026-10-19Search names, modules, packages, or :: a typeCtrl K

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8c2f8e8 · 2026-10-19

Modulehledger-lib-1.52.4GHC2021

Hledger.Data.Amount

A simple Amount is some quantity of money, shares, or anything else. It has a (possibly null) CommoditySymbol and a numeric quantity:

  $1
  £-50
  EUR 3.44
  GOOG 500
  1.5h
  90 apples
  0

It may also have an AmountCost, representing this amount's per-unit or total cost in a different commodity. If present, this is rendered like so:

  EUR 2 @ $1.50  (unit cost)
  EUR 2 @@ $3   (total cost)

A MixedAmount is zero or more simple amounts, so can represent multiple commodities; this is the type most often used:

  0
  $50 + EUR 3
  16h + $13.55 + AAPL 500 + 6 oranges

A mixed amount is always "normalised", it has no more than one amount in each commodity and cost. When calling amounts it will have no zero amounts, or just a single zero amount and no other amounts.

Limited arithmetic with simple and mixed amounts is supported, best used with similar amounts since it mostly ignores costss and commodity exchange rates.

  • 1 type
  • 114 values

Commodity

3 declarations

Amount

0 declarations

arithmetic

valuenullamt :: Amount
#

The empty simple amount - a zero with no commodity symbol or cost and the default amount display style.

valuemissingamt :: Amount
#

A special amount used as a marker, meaning "no explicit amount provided here, infer it when needed". It is nullamt with commodity symbol AUTO.

valueamountCost :: Amount -> Amount
#

Convert a amount to its total cost in another commodity, using its attached cost amount if it has one. Notes:

  • cost amounts must be MixedAmounts with exactly one component Amount (or there will be a runtime error XXX)

  • cost amounts should be positive in the Journal (though this is currently not enforced)

valueamountIsZero :: Amount -> Bool
#

Is this Amount (and its total cost, if it has one) exactly zero, ignoring its display precision ?

valueamountLooksZero :: Amount -> Bool
#

Do this Amount and (and its total cost, if it has one) appear to be zero when rendered with its display precision ? The display precision should usually have a specific value here; if unset, it will be treated like NaturalPrecision.

valueinvertAmount :: Amount -> Amount
#

Invert an amount (replace its quantity q with 1/q). The amount's transacted price, if any, is not changed. An amount with zero quantity is left unchanged.

styles

valuecommodityStylesFromAmounts
  1. :: [Amount]
  2. -> Either String (Map CommoditySymbol AmountStyle)
#

Given a list of amounts, in parse order (roughly speaking; see journalStyleInfluencingAmounts), build a map from their commodity names to standard commodity display formats. Can return an error message eg if inconsistent number formats are found.

Though, these amounts may have come from multiple files, so we shouldn't assume they use consistent number formats. Currently we don't enforce that even within a single file, and this function never reports an error.

valuegetAmounts :: Amount -> [Amount]
#

Get an amount and its attached cost amount if any. Returns one or two amounts.

rendering

datadata AmountFormat
#

Formatting options available when displaying Amounts and MixedAmounts. Similar to AmountStyle but lower level, not attached to amounts or commodities, and can override it in some ways. See also hledger manual > "Amount formatting, parseability", which speaks of human, hledger, and machine output.

Constructors

Instances2Show, Default
  • Show AmountFormatDefined in hledger-lib-1.52.4 · Hledger.Data.Amount
  • Default AmountFormatDefined in hledger-lib-1.52.4 · Hledger.Data.Amount

    By default, display amounts using defaultFmt amount display options.

valuefullZeroFmt :: AmountFormat
#

Like defaultFmt but show zero amounts with commodity symbol and styling, like non-zero amounts.

valuemachineFmt :: AmountFormat
#

A (slightly more) machine-readable amount format; like oneLineNoCostFmt but don't show digit group marks.

valueshowAmount :: Amount -> String
#

Render an amount using its display style and the default amount format. Zero-equivalent amounts are shown as just "0". The special "missing" amount is shown as the empty string.

valueshowAmountB :: AmountFormat -> Amount -> WideBuilder
#

Render an amount using its display style and the given amount format, as a builder for efficiency. (This can be converted to a Text with wbToText or to a String with wbUnpack). The special "missing" amount is displayed as the empty string.

valuecshowAmount :: Amount -> String
#

Colour version. For a negative amount, adds ANSI codes to change the colour, currently to hard-coded red.

cshowAmount = wbUnpack . showAmountB def{displayColour=True}
valueshowAmountWithZeroCommodity :: Amount -> String
#

Like showAmount, but show a zero amount's commodity if it has one.

showAmountWithZeroCommodity = wbUnpack . showAmountB defaultFmt{displayZeryCommodity=True}
valueshowAmountDebug :: Amount -> String
#

Get a string representation of an amount for debugging, appropriate to the current debug level. 9 shows maximum detail.

valueshowAmountWithoutCost :: Amount -> String
#

Get the string representation of an amount, without any @ cost.

showAmountWithoutCost = wbUnpack . showAmountB noCostFmt
valueamountSetFullPrecision :: Amount -> Amount
#

Increase an amount's display precision, if needed, to enough decimal places to show it exactly (showing all significant decimal digits, without trailing zeros). If the amount's display precision is unset, it will be treated as precision 0.

valueamountSetFullPrecisionUpTo :: Maybe Word8 -> Amount -> Amount
#

We often want to display "infinite decimal" amounts rounded to some readable number of digits, while still displaying amounts with a large but "non infinite" number of decimal digits (eg 10 or 100 or 200 digits) in full. This helper is like amountSetFullPrecision, but with some refinements:

  1. A maximum display precision can be specified, setting a hard upper limit.

  2. If no limit is specified, and the internal precision is the maximum (255), indicating an infinite decimal, display precision is set to a smaller default (8).

This function always sets an explicit display precision (ie, Precision n).

valuedefaultMaxPrecision :: Word8
#

The fallback display precision used when showing amounts representing an infinite decimal.

valuesetAmountInternalPrecision :: Word8 -> Amount -> Amount
#

Set an amount's internal decimal precision as well as its display precision. This rounds or pads its Decimal quantity to the specified number of decimal places. Rounding is done with Data.Decimal's default roundTo function: "If the value ends in 5 then it is rounded to the nearest even value (Banker's Rounding)".

MixedAmount

16 declarations
valuemissingmixedamt :: MixedAmount
#

A special mixed amount used as a marker, meaning "no explicit amount provided here, infer it when needed".

valueisMissingMixedAmount :: MixedAmount -> Bool
#

Does this MixedAmount include the "missing amount" marker ? Note: currently does not test for equality with missingmixedamt, instead it looks for missingamt among the Amounts. missingamt should always be alone, but detect it even if not.

valueamounts :: MixedAmount -> [Amount]
#

Get a mixed amount's component amounts, with some cleanups. The following descriptions are old and possibly wrong:

  • amounts in the same commodity are combined unless they have different costs or total costs

  • multiple zero amounts, all with the same non-null commodity, are replaced by just the last of them, preserving the commodity and amount style (all but the last zero amount are discarded)

  • multiple zero amounts with multiple commodities, or no commodities, are replaced by one commodity-less zero amount

  • an empty amount list is replaced by one commodity-less zero amount

  • the special "missing" mixed amount remains unchanged

valueamountsRaw :: MixedAmount -> [Amount]
#

Get a mixed amount's component amounts without normalising zero and missing amounts. This is used for JSON serialisation, so the order is important. In particular, we want the Amounts given in the order of the MixedAmountKeys, i.e. lexicographically first by commodity, then by cost commodity, then by unit cost from most negative to most positive.

valueamountsPreservingZeros :: MixedAmount -> [Amount]
#

Get a mixed amount's component amounts, with some cleanups. This is a new version of amounts, with updated descriptions and optimised for print to show commodityful zeros.

  • If it contains the "missing amount" marker, only that is returned (discarding any additional amounts).

  • Or if it contains any non-zero amounts, only those are returned (discarding any zeroes).

  • Or if it contains any zero amounts (possibly more than one, possibly in different commodities), all of those are returned.

  • Otherwise the null amount is returned.

valuefilterMixedAmountByCommodity
  1. :: CommoditySymbol
  2. -> MixedAmount
  3. -> MixedAmount
#

Return an unnormalised MixedAmount containing just the amounts in the requested commodity from the original mixed amount.

The result will contain at least one Amount of the requested commodity, even if the original mixed amount did not (with quantity zero in that case, and this would be discarded when the mixed amount is next normalised).

The result can contain more than one Amount of the requested commodity, eg because there were several with different costs, or simply because the original mixed amount was was unnormalised.

valueunifyMixedAmount :: MixedAmount -> Maybe Amount
#

Unify a MixedAmount to a single commodity value if possible. This consolidates amounts of the same commodity and discards zero amounts; but this one insists on simplifying to a single commodity, and will return Nothing if this is not possible.

arithmetic

valuemaIsZero :: MixedAmount -> Bool
#

Is this mixed amount exactly zero, ignoring its display precision?

A convenient alias for mixedAmountIsZero.

valuemaIsNonZero :: MixedAmount -> Bool
#

Is this mixed amount non-zero, ignoring its display precision?

A convenient alias for not . mixedAmountIsZero.

styles

rendering

valueshowMixedAmount :: MixedAmount -> String
#

Render a mixed amount using its amount display styles and the default amount format, after normalising it (to at most one amount in each of its commodities). See showMixedAmountB for special cases.

valueshowMixedAmountWithoutCost :: Bool -> MixedAmount -> String
#

Get the string representation of a mixed amount, without showing any costs. With a True argument, adds ANSI codes to show negative amounts in red. See showMixedAmountB for special cases.

valueshowMixedAmountElided :: Int -> Bool -> MixedAmount -> String
#

Like showMixedAmountOneLineWithoutCost, but show at most the given width, with an elision indicator if there are more. With a True argument, adds ANSI codes to show negative amounts in red. See showMixedAmountB for special cases.

valueshowMixedAmountB :: AmountFormat -> MixedAmount -> WideBuilder
#

Render a mixed amount using its amount display styles and the given amount format, as a builder for efficiency. (This can be converted to a Text with wbToText or to a String with wbUnpack).

Warning: this (and its showMixedAmount aliases above) basically assumes amounts have no costs. It can show misleading costs or not show costs which are there.

If a maximum width is given then:

  • If displayed on one line, it will display as many Amounts as can fit in the given width, and further Amounts will be elided. There will always be at least one amount displayed, even if this will exceed the requested maximum width.

  • If displayed on multiple lines, any Amounts longer than the maximum width will be elided.

Zero-equivalent amounts are shown as just "0".

The special "missing" amount is shown as the empty string (?).

valueshowMixedAmountLinesB :: AmountFormat -> MixedAmount -> [WideBuilder]
#

Helper for showMixedAmountB (and postingAsLines, ...) to show a list of Amounts on multiple lines. This returns the list of WideBuilders: one for each Amount, and padded/elided to the appropriate width. This does not honour displayOneLine; all amounts will be displayed as if displayOneLine were False.

valuemixedAmountSetFullPrecisionUpTo :: Maybe Word8 -> MixedAmount -> MixedAmount
#

In each component amount, increase the display precision sufficiently to render it exactly if possible, but not more than the given max precision, and if no max precision is given and the amount has infinite decimals, limit display precision to a hard-coded smaller number (8). See amountSetFullPrecisionUpTo.

misc.

1 declaration

Orphan instances

9 instances