Hledger.Data.AccountName

AccountNames are strings like assets:cash:petty, with multiple components separated by :. From a set of these we derive the account hierarchy.

Documentation

accountLeafName :: AccountName -> Text

accountNameComponents :: AccountName -> [Text]

accountNameDrop :: Int -> AccountName -> AccountName

Remove some number of account name components from the front of the account name. If the special "unbudgeted" top-level account is present, it is preserved and dropping affects the rest of the account name.

accountNameFromComponents :: [Text] -> AccountName

accountNameLevel :: AccountName -> Int

accountNameToAccountOnlyRegex :: AccountName -> Regexp

Convert an account name to a regular expression matching it but not its subaccounts.

accountNameToAccountOnlyRegexCI :: AccountName -> Regexp

Convert an account name to a regular expression matching it but not its subaccounts, case insensitively.

accountNameToAccountRegex :: AccountName -> Regexp

Convert an account name to a regular expression matching it and its subaccounts.

accountNameToAccountRegexCI :: AccountName -> Regexp

Convert an account name to a regular expression matching it and its subaccounts, case insensitively.

accountNameTreeFrom :: [AccountName] -> Tree AccountName

Convert a list of account names to a tree.

accountSummarisedName :: AccountName -> Text

Truncate all account name components but the last to two characters.

accountNameInferType :: AccountName -> Maybe AccountType

Try to guess an account's type from its name, matching common English top-level account names.

accountNameType :: Map AccountName AccountType -> AccountName -> Maybe AccountType

assetAccountRegex :: Regexp

Regular expressions matching common English top-level account names, used as a fallback when account types are not declared.

cashAccountRegex :: Regexp

liabilityAccountRegex :: Regexp

equityAccountRegex :: Regexp

conversionAccountRegex :: Regexp

revenueAccountRegex :: Regexp

expenseAccountRegex :: Regexp

acctsep :: Text

acctsepchar :: Char

clipAccountName :: Maybe Int -> AccountName -> AccountName

Keep only the first n components of an account name, where n is a positive integer. If n is Just 0, returns the empty string, if n is Nothing, return the full name.

clipOrEllipsifyAccountName :: Maybe Int -> AccountName -> AccountName

Keep only the first n components of an account name, where n is a positive integer. If n is Just 0, returns "...", if n is Nothing, return the full name.

elideAccountName :: Int -> AccountName -> AccountName

Elide an account name to fit in the specified width. From the ledger 2.6 news:

  What Ledger now does is that if an account name is too long, it will
  start abbreviating the first parts of the account name down to two
  letters in length.  If this results in a string that is still too
  long, the front will be elided -- not the end.  For example:

    Expenses:Cash           ; OK, not too long
    Ex:Wednesday:Cash       ; Expenses was abbreviated to fit
    Ex:We:Afternoon:Cash    ; Expenses and Wednesday abbreviated
    ; Expenses:Wednesday:Afternoon:Lunch:Snack:Candy:Chocolate:Cash
    ..:Af:Lu:Sn:Ca:Ch:Cash  ; Abbreviated and elided!

escapeName :: AccountName -> Text

Escape an AccountName for use within a regular expression. >>> putStr . T.unpack $ escapeName "First?!#$*?$(*) !^#*? %)*!#" First?!#$*?$(*) !^#*? %)*!#

expandAccountName :: AccountName -> [AccountName]

"a:b:c" -> ["a","a:b","a:b:c"]

expandAccountNames :: [AccountName] -> [AccountName]

Sorted unique account names implied by these account names, ie these plus all their parent accounts up to the root. Eg: ["a:b:c","d:e"] -> ["a","a:b","a:b:c","d","d:e"]

isAccountNamePrefixOf :: AccountName -> AccountName -> Bool

Is the first account a parent or other ancestor of (and not the same as) the second ?

isSubAccountNameOf :: AccountName -> AccountName -> Bool

parentAccountName :: AccountName -> AccountName

parentAccountNames :: AccountName -> [AccountName]

subAccountNamesFrom :: [AccountName] -> AccountName -> [AccountName]

From a list of account names, select those which are direct subaccounts of the given account name.

topAccountNames :: [AccountName] -> [AccountName]

"a:b:c","d:e"

-> ["a","d"]

unbudgetedAccountName :: Text

A top-level account prefixed to some accounts in budget reports. Defined here so it can be ignored by accountNameDrop.

accountNamePostingType :: AccountName -> PostingType

accountNameWithoutPostingType :: AccountName -> AccountName

accountNameWithPostingType :: PostingType -> AccountName -> AccountName

joinAccountNames :: AccountName -> AccountName -> AccountName

Prefix one account name to another, preserving posting type indicators like concatAccountNames.

concatAccountNames :: [AccountName] -> AccountName

Join account names into one. If any of them has () or [] posting type indicators, these (the first type encountered) will also be applied to the resulting account name.

accountNameApplyAliases :: [AccountAlias] -> AccountName -> Either RegexError AccountName

Rewrite an account name using all matching aliases from the given list, in sequence. Each alias sees the result of applying the previous aliases. Or, return any error arising from a bad regular expression in the aliases.

accountNameApplyAliasesMemo :: [AccountAlias] -> AccountName -> Either RegexError AccountName

Memoising version of accountNameApplyAliases, maybe overkill.

tests_AccountName :: TestTree