mirror of
https://github.com/Gnucash/gnucash.git
synced 2024-11-26 02:40:43 -06:00
1cec0cb3f3
- removes warnings compiling swig engine ... [ 10%] Generating swig-engine.cpp .../libgnucash/engine/engine-helpers.h:31: Warning 313: Unrecognized extern type "C++". .../libgnucash/engine/gnc-date.h:83: Warning 313: Unrecognized extern type "C++". .../libgnucash/engine/qofquery.h:90: Warning 302: Identifier 'QofQuery' redefined (ignored), .../libgnucash/engine/gnc-option.hpp:55: Warning 302: previous definition of 'QofQuery'. .../libgnucash/engine/gnc-commodity.h:56: Warning 313: Unrecognized extern type "C++". .../libgnucash/engine/gncBusiness.h:40: Warning 313: Unrecognized extern type "C++". .../libgnucash/engine/gncEntry.h:37: Warning 313: Unrecognized extern type "C++".
198 lines
8.1 KiB
C
198 lines
8.1 KiB
C
/********************************************************************\
|
|
* Query.h : api for finding transactions *
|
|
* Copyright 2000 Bill Gribble <grib@billgribble.com> *
|
|
* Copyright 2002 Linas Vepstas <linas@linas.org> *
|
|
* *
|
|
* This program is free software; you can redistribute it and/or *
|
|
* modify it under the terms of the GNU General Public License as *
|
|
* published by the Free Software Foundation; either version 2 of *
|
|
* the License, or (at your option) any later version. *
|
|
* *
|
|
* This program is distributed in the hope that it will be useful, *
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
* GNU General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU General Public License*
|
|
* along with this program; if not, contact: *
|
|
* *
|
|
* Free Software Foundation Voice: +1-617-542-5942 *
|
|
* 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 *
|
|
* Boston, MA 02110-1301, USA gnu@gnu.org *
|
|
\********************************************************************/
|
|
|
|
#ifndef GNUCASH_QUERY_H
|
|
#define GNUCASH_QUERY_H
|
|
|
|
#include <sys/types.h>
|
|
#include <time.h>
|
|
#include <glib.h>
|
|
#include "qof.h"
|
|
#include "Account.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*
|
|
* This function defines a compatibility API from the old Query API to
|
|
* the new Query API. Note that it is not a 100% complete equivalent.
|
|
* Many functions have a one-to-one mapping in the new API, but many
|
|
* others do not.
|
|
*/
|
|
|
|
typedef QofQuery Query;
|
|
|
|
typedef enum
|
|
{
|
|
QUERY_TXN_MATCH_ALL = 1, /* match all accounts */
|
|
QUERY_TXN_MATCH_ANY = 2 /* match any account */
|
|
} query_txn_match_t;
|
|
|
|
/* After the query has been set up, call one of these to run the query.
|
|
* XXX The routines below should be replaced by a query
|
|
* that explicitly asks for a list of the desired item.
|
|
*
|
|
* The xaccQueryGetSplits() routine returns all splits matching the
|
|
* query. Any given split will appear at most once in the result;
|
|
* however, several splits from one transaction may appear in the list.
|
|
* The caller MUST NOT change the GList.
|
|
*/
|
|
|
|
/**
|
|
* The xaccQueryGetSplitsUniqueTrans() routine returns splits matching
|
|
* the query, but only one matching split per transaction will be
|
|
* returned. In other words, any given transaction will be
|
|
* represented at most once in the returned list. The caller must
|
|
* free the GList.
|
|
*/
|
|
SplitList * xaccQueryGetSplitsUniqueTrans(QofQuery *q);
|
|
|
|
/**
|
|
* The xaccQueryGetTransactions() routine returns a list of
|
|
* transactions that match the query. The GList must be freed by
|
|
* the caller. The query_run_t argument is used to provide account
|
|
* matching in the following way:
|
|
*
|
|
* query_txn_match_t describes how to match accounts when querying
|
|
* for transactions with xaccQueryGetTransactions().
|
|
* What is the difference between 'ANY' and 'ALL', you
|
|
* may ask? First, let us recall that a transaction consists
|
|
* of splits, and each split belongs to exactly one account.
|
|
* Specifying "MATCH_ALL" means that *every* account that
|
|
* shows up in the query must also show up in some split in
|
|
* the transaction (in order for that transaction to be
|
|
* selected). By contrast, specifying 'ANY' means that
|
|
* any account in the query must show up in some split
|
|
* in the transaction (in order for the transaction to
|
|
* be selected). Thus, 'ANY' acts as a boolean-OR when
|
|
* matching accounts, whereas 'AND' acts as a boolean-AND
|
|
* for matching accounts. Whew. Got that?
|
|
*/
|
|
TransList * xaccQueryGetTransactions(QofQuery * q, query_txn_match_t type);
|
|
|
|
/**
|
|
* The xaccQueryGetLots() routine is just like GetTransactions() except
|
|
* it returns a list of Lots.
|
|
*
|
|
*/
|
|
LotList * xaccQueryGetLots(QofQuery * q, query_txn_match_t type);
|
|
|
|
/*******************************************************************
|
|
* match-adding API
|
|
*******************************************************************/
|
|
|
|
void xaccQueryAddAccountMatch(QofQuery *, AccountList *,
|
|
QofGuidMatch how, QofQueryOp op);
|
|
|
|
void xaccQueryAddAccountGUIDMatch(QofQuery *, AccountGUIDList *,
|
|
QofGuidMatch, QofQueryOp);
|
|
|
|
void xaccQueryAddSingleAccountMatch(QofQuery *, Account *, QofQueryOp);
|
|
|
|
void xaccQueryAddStringMatch (QofQuery* q, const char *matchstring,
|
|
gboolean case_sens, gboolean use_regexp,
|
|
QofQueryCompare how, QofQueryOp op,
|
|
const char * path, ...);
|
|
void
|
|
xaccQueryAddDescriptionMatch(QofQuery *q, const char *m, gboolean c, gboolean r,
|
|
QofQueryCompare how, QofQueryOp o);
|
|
void
|
|
xaccQueryAddNotesMatch(QofQuery *q, const char *m, gboolean c, gboolean r,
|
|
QofQueryCompare how, QofQueryOp o);
|
|
void
|
|
xaccQueryAddNumberMatch(QofQuery *q, const char *m, gboolean c, gboolean r,
|
|
QofQueryCompare how, QofQueryOp o);
|
|
void
|
|
xaccQueryAddActionMatch(QofQuery *q, const char *m, gboolean c, gboolean r,
|
|
QofQueryCompare how, QofQueryOp o);
|
|
void
|
|
xaccQueryAddMemoMatch(QofQuery *q, const char *m, gboolean c, gboolean r,
|
|
QofQueryCompare how, QofQueryOp o);
|
|
void
|
|
xaccQueryAddValueMatch(QofQuery *q, gnc_numeric amt, QofNumericMatch sgn,
|
|
QofQueryCompare how, QofQueryOp op);
|
|
void
|
|
xaccQueryAddSharePriceMatch(QofQuery *q, gnc_numeric amt, QofQueryCompare how,
|
|
QofQueryOp op);
|
|
void
|
|
xaccQueryAddSharesMatch(QofQuery *q, gnc_numeric amt, QofQueryCompare how,
|
|
QofQueryOp op);
|
|
void
|
|
xaccQueryAddBalanceMatch(QofQuery *q, QofQueryCompare bal, QofQueryOp op);
|
|
|
|
void xaccQueryAddNumericMatch (QofQuery *q, gnc_numeric amount,
|
|
QofNumericMatch sign, QofQueryCompare how,
|
|
QofQueryOp op, const char * path, ...);
|
|
|
|
/** The DateMatch queries match transactions whose posted date
|
|
* is in a date range. If use_start is TRUE, then a matching
|
|
* posted date will be greater than the start date. If
|
|
* use_end is TRUE, then a match occurs for posted dates earlier
|
|
* than the end date. If both flags are set, then *both*
|
|
* conditions must hold ('and'). If neither flag is set, then
|
|
* all transactions are matched.
|
|
*/
|
|
|
|
void xaccQueryAddDateMatch(QofQuery * q, gboolean use_start,
|
|
int sday, int smonth, int syear,
|
|
gboolean use_end, int eday, int emonth, int eyear,
|
|
QofQueryOp op);
|
|
void xaccQueryAddDateMatchTT(QofQuery * q,
|
|
gboolean use_start, time64 stt,
|
|
gboolean use_end, time64 ett,
|
|
QofQueryOp op);
|
|
void xaccQueryGetDateMatchTT (QofQuery * q,
|
|
time64 * stt,
|
|
time64 * ett);
|
|
|
|
void xaccQueryAddClosingTransMatch(QofQuery *q, gboolean value, QofQueryOp op);
|
|
|
|
typedef enum
|
|
{
|
|
CLEARED_NONE = 0x0000,
|
|
CLEARED_NO = 0x0001,
|
|
CLEARED_CLEARED = 0x0002,
|
|
CLEARED_RECONCILED = 0x0004,
|
|
CLEARED_FROZEN = 0x0008,
|
|
CLEARED_VOIDED = 0x0010,
|
|
CLEARED_ALL = 0x001F
|
|
} cleared_match_t;
|
|
|
|
void xaccQueryAddClearedMatch(QofQuery * q, cleared_match_t how, QofQueryOp op);
|
|
void xaccQueryAddGUIDMatch(QofQuery * q, const GncGUID *guid,
|
|
QofIdType id_type, QofQueryOp op);
|
|
|
|
|
|
/*******************************************************************
|
|
* compatibility interface with old QofQuery API
|
|
*******************************************************************/
|
|
time64 xaccQueryGetEarliestDateFound(QofQuery * q);
|
|
time64 xaccQueryGetLatestDateFound(QofQuery * q);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|