hledger-lib-1.19.1: A reusable library providing the core functionality of hledger

Safe Haskell | None
Language | Haskell2010

Hledger.Query

Contents

- Query and QueryOpt
- parsing
- accessors
- matching
- tests

Description

A general query system for matching things (accounts, postings, transactions..) by various criteria, and a SimpleTextParser for query expressions.

Synopsis

- data Query
  - = Any
  - | None
  - | Not Query
  - | Or [Query]
  - | And [Query]
  - | Code Regexp
  - | Desc Regexp
  - | Acct Regexp
  - | Date DateSpan
  - | Date2 DateSpan
  - | StatusQ Status
  - | Real Bool
  - | Amt OrdPlus Quantity
  - | Sym Regexp
  - | Empty Bool
  - | Depth Int
  - | Tag Regexp (Maybe Regexp)
- data QueryOpt
  - = QueryOptInAcctOnly AccountName
  - | QueryOptInAcct AccountName
- payeeTag :: Maybe String -> Either RegexError Query
- noteTag :: Maybe String -> Either RegexError Query
- generatedTransactionTag :: Query
- parseQuery :: Day -> Text -> Either String (Query, [QueryOpt])
- simplifyQuery :: Query -> Query
- filterQuery :: (Query -> Bool) -> Query -> Query
- queryIsNull :: Query -> Bool
- queryIsAcct :: Query -> Bool
- queryIsAmt :: Query -> Bool
- queryIsDepth :: Query -> Bool
- queryIsDate :: Query -> Bool
- queryIsDate2 :: Query -> Bool
- queryIsDateOrDate2 :: Query -> Bool
- queryIsStartDateOnly :: Bool -> Query -> Bool
- queryIsSym :: Query -> Bool
- queryIsReal :: Query -> Bool
- queryIsStatus :: Query -> Bool
- queryIsEmpty :: Query -> Bool
- queryStartDate :: Bool -> Query -> Maybe Day
- queryEndDate :: Bool -> Query -> Maybe Day
- queryDateSpan :: Bool -> Query -> DateSpan
- queryDateSpan' :: Query -> DateSpan
- queryDepth :: Query -> Maybe Int
- inAccount :: [QueryOpt] -> Maybe (AccountName, Bool)
- inAccountQuery :: [QueryOpt] -> Maybe Query
- matchesTransaction :: Query -> Transaction -> Bool
- matchesPosting :: Query -> Posting -> Bool
- matchesAccount :: Query -> AccountName -> Bool
- matchesMixedAmount :: Query -> MixedAmount -> Bool
- matchesAmount :: Query -> Amount -> Bool
- matchesCommodity :: Query -> CommoditySymbol -> Bool
- matchesTags :: Regexp -> Maybe Regexp -> [Tag] -> Bool
- matchesPriceDirective :: Query -> PriceDirective -> Bool
- words'' :: [Text] -> Text -> [Text]
- prefixes :: [Text]
- tests_Query :: TestTree

# Query and QueryOpt

data Query Source #

A query is a composition of search criteria, which can be used to match postings, transactions, accounts and more.

Constructors

Any | always match
None | never match
Not Query | negate this match
Or [Query] | match if any of these match
And [Query] | match if all of these match
Code Regexp | match if code matches this regexp
Desc Regexp | match if description matches this regexp
Acct Regexp | match postings whose account matches this regexp
Date DateSpan | match if primary date in this date span
Date2 DateSpan | match if secondary date in this date span
StatusQ Status | match txns/postings with this status
Real Bool | match if "realness" (involves a real non-virtual account ?) has this value
Amt OrdPlus Quantity | match if the amount's numeric quantity is less thangreater thanequal to/unsignedly equal to some value
Sym Regexp | match if the entire commodity symbol is matched by this regexp
Empty Bool | if true, show zero-amount postings/accounts which are usually not shown more of a query option than a query criteria ?
Depth Int | match if account depth is less than or equal to this value. Depth is sometimes used like a query (for filtering report data) and sometimes like a query option (for controlling display)
Tag Regexp (Maybe Regexp) | match if a tag's name, and optionally its value, is matched by these respective regexps matching the regexp if provided, exists

#### Instances

Instances details

Eq Query Source # |
Instance details Defined in Hledger.Query Methods (==) :: Query -> Query -> Bool Source # (/=) :: Query -> Query -> Bool Source #
Show Query Source # |
Instance details Defined in Hledger.Query Methods showsPrec :: Int -> Query -> ShowS Source # show :: Query -> String Source # showList :: [Query] -> ShowS Source #

data QueryOpt Source #

A query option changes a query's/report's behaviour and output in some way.

Constructors

QueryOptInAcctOnly AccountName | show an account register focussed on this account
QueryOptInAcct AccountName | as above but include sub-accounts in the account register | QueryOptCostBasis -- ^ show amounts converted to cost where possible | QueryOptDate2 -- ^ show secondary dates instead of primary dates

#### Instances

Instances details

Eq QueryOpt Source # |
Instance details Defined in Hledger.Query Methods (==) :: QueryOpt -> QueryOpt -> Bool Source # (/=) :: QueryOpt -> QueryOpt -> Bool Source #
Show QueryOpt Source # |
Instance details Defined in Hledger.Query Methods showsPrec :: Int -> QueryOpt -> ShowS Source # show :: QueryOpt -> String Source # showList :: [QueryOpt] -> ShowS Source #

payeeTag :: Maybe String -> Either RegexError Query Source #

Construct a payee tag

noteTag :: Maybe String -> Either RegexError Query Source #

Construct a note tag

generatedTransactionTag :: Query Source #

Construct a generated-transaction tag

# parsing

parseQuery :: Day -> Text -> Either String (Query, [QueryOpt]) Source #

Convert a query expression containing zero or more space-separated terms to a query and zero or more query options; or return an error message if query parsing fails.

A query term is either:

1. a search pattern, which matches on one or more fields, eg:

   acct:REGEXP - match the account name with a regular expression desc:REGEXP - match the transaction description date:PERIODEXP - match the date with a period expression

The prefix indicates the field to match, or if there is no prefix account name is assumed.

1. a query option, which modifies the reporting behaviour in some way. There is currently one of these, which may appear only once:

   inacct:FULLACCTNAME

The usual shell quoting rules are assumed. When a pattern contains whitespace, it (or the whole term including prefix) should be enclosed in single or double quotes.

Period expressions may contain relative dates, so a reference date is required to fully parse these.

Multiple terms are combined as follows: 1. multiple account patterns are OR'd together 2. multiple description patterns are OR'd together 3. multiple status patterns are OR'd together 4. then all terms are AND'd together

    >>> parseQuery nulldate "expenses:dining out"
    Right (Or [Acct (RegexpCI "expenses:dining"),Acct (RegexpCI "out")],[])

    >>> parseQuery nulldate "\"expenses:dining out\""
    Right (Acct (RegexpCI "expenses:dining out"),[])

simplifyQuery :: Query -> Query Source #

filterQuery :: (Query -> Bool) -> Query -> Query Source #

Remove query terms (or whole sub-expressions) not matching the given predicate from this query. XXX Semantics not completely clear.

# accessors

queryIsNull :: Query -> Bool Source #

Does this query match everything ?

queryIsAcct :: Query -> Bool Source #

queryIsAmt :: Query -> Bool Source #

queryIsDepth :: Query -> Bool Source #

queryIsDate :: Query -> Bool Source #

queryIsDate2 :: Query -> Bool Source #

queryIsDateOrDate2 :: Query -> Bool Source #

queryIsStartDateOnly :: Bool -> Query -> Bool Source #

Does this query specify a start date and nothing else (that would filter postings prior to the date) ? When the flag is true, look for a starting secondary date instead.

queryIsSym :: Query -> Bool Source #

queryIsReal :: Query -> Bool Source #

queryIsStatus :: Query -> Bool Source #

queryIsEmpty :: Query -> Bool Source #

queryStartDate :: Bool -> Query -> Maybe Day Source #

What start date (or secondary date) does this query specify, if any ? For OR expressions, use the earliest of the dates. NOT is ignored.

queryEndDate :: Bool -> Query -> Maybe Day Source #

What end date (or secondary date) does this query specify, if any ? For OR expressions, use the latest of the dates. NOT is ignored.

queryDateSpan :: Bool -> Query -> DateSpan Source #

What date span (or with a true argument, what secondary date span) does this query specify ? OR clauses specifying multiple spans return their union (the span enclosing all of them). AND clauses specifying multiple spans return their intersection. NOT clauses are ignored.

queryDateSpan' :: Query -> DateSpan Source #

What date span does this query specify, treating primary and secondary dates as equivalent ? OR clauses specifying multiple spans return their union (the span enclosing all of them). AND clauses specifying multiple spans return their intersection. NOT clauses are ignored.

queryDepth :: Query -> Maybe Int Source #

The depth limit this query specifies, if it has one

inAccount :: [QueryOpt] -> Maybe (AccountName, Bool) Source #

The account we are currently focussed on, if any, and whether subaccounts are included. Just looks at the first query option.

inAccountQuery :: [QueryOpt] -> Maybe Query Source #

A query for the account(s) we are currently focussed on, if any. Just looks at the first query option.

# matching

matchesTransaction :: Query -> Transaction -> Bool Source #

Does the match expression match this transaction ?

matchesPosting :: Query -> Posting -> Bool Source #

Does the match expression match this posting ?

Note that for account match we try both original and effective account

matchesAccount :: Query -> AccountName -> Bool Source #

Does the match expression match this account ? A matching in: clause is also considered a match. When matching by account name pattern, if there's a regular expression error, this function calls error.

matchesMixedAmount :: Query -> MixedAmount -> Bool Source #

matchesAmount :: Query -> Amount -> Bool Source #

Does the match expression match this (simple) amount ?

matchesCommodity :: Query -> CommoditySymbol -> Bool Source #

matchesTags :: Regexp -> Maybe Regexp -> [Tag] -> Bool Source #

Does the query match the name and optionally the value of any of these tags ?

matchesPriceDirective :: Query -> PriceDirective -> Bool Source #

Does the query match this market price ?

words'' :: [Text] -> Text -> [Text] Source #

Quote-and-prefix-aware version of words - don't split on spaces which are inside quotes, including quotes which may have one of the specified prefixes in front, and maybe an additional not: prefix in front of that.

prefixes :: [Text] Source #

# tests

tests_Query :: TestTree Source #