qofquerycore.h

Go to the documentation of this file.

/********************************************************************\
 * qofquerycore.h -- API for providing core Query data types        *
 * Copyright (C) 2002 Derek Atkins <warlord@MIT.EDU>                *
 * Copyright (C) 2006 Neil Williams <linux@codehelp.co.uk>          *
 *                                                                  *
 * 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 QOF_QUERYCORE_H
#define QOF_QUERYCORE_H

#include "qofnumeric.h"
#include "qofdate.h"
#include "kvpframe.h"
#include "qofclass.h"

typedef struct _QofQueryPredData QofQueryPredData;

typedef enum
{
    QOF_COMPARE_LT = 1,
    QOF_COMPARE_LTE,
    QOF_COMPARE_EQUAL,
    QOF_COMPARE_GT,
    QOF_COMPARE_GTE,
    QOF_COMPARE_NEQ
} QofQueryCompare;

/* Comparisons for QOF_TYPE_STRING */
typedef enum
{
    QOF_STRING_MATCH_NORMAL = 1,
    QOF_STRING_MATCH_CASEINSENSITIVE
} QofStringMatch;

typedef enum
{
    QOF_DATE_MATCH_NORMAL = 1,
    QOF_DATE_MATCH_DAY
} QofDateMatch;

typedef enum
{
    QOF_NUMERIC_MATCH_DEBIT = 1,
    QOF_NUMERIC_MATCH_CREDIT,
    QOF_NUMERIC_MATCH_ANY
} QofNumericMatch;

/* Comparisons for QOF_TYPE_GUID */
typedef enum
{
    QOF_GUID_MATCH_ANY = 1,
    QOF_GUID_MATCH_NONE,
    QOF_GUID_MATCH_NULL,
    QOF_GUID_MATCH_ALL,
    QOF_GUID_MATCH_LIST_ANY,
} QofGuidMatch;

typedef enum
{
    QOF_CHAR_MATCH_ANY = 1,
    QOF_CHAR_MATCH_NONE
} QofCharMatch;

struct _QofQueryPredData
{
    QofType type_name;          /* QOF_TYPE_* */
    QofQueryCompare how;
};


QofQueryPredData *
qof_query_string_predicate (QofQueryCompare how,
                            const gchar * str,
                            QofStringMatch options,
                            gboolean is_regex);

QofQueryPredData *
qof_query_time_predicate (QofQueryCompare how,
                          QofDateMatch options,
                          QofTime *qt);

QofQueryPredData *
qof_query_numeric_predicate (QofQueryCompare how,
                             QofNumericMatch options,
                             QofNumeric value);

QofQueryPredData *
qof_query_guid_predicate (QofGuidMatch options,
                          GList * guids);

QofQueryPredData *
qof_query_int32_predicate (QofQueryCompare how, gint32 val);

QofQueryPredData *
qof_query_int64_predicate (QofQueryCompare how, gint64 val);

QofQueryPredData *
qof_query_double_predicate (QofQueryCompare how,
                            double val);

QofQueryPredData *
qof_query_boolean_predicate (QofQueryCompare how,
                             gboolean val);

QofQueryPredData *
qof_query_char_predicate (QofCharMatch options,
                          const gchar * chars);

QofQueryPredData *
qof_query_collect_predicate (QofGuidMatch options,
                             QofCollection * coll);

QofQueryPredData *
qof_query_choice_predicate (QofGuidMatch options,
                            GList * guids);

QofQueryPredData *
qof_query_kvp_predicate (QofQueryCompare how,
                         GSList * path,
                         const KvpValue * value);

QofQueryPredData *
qof_query_kvp_predicate_path (QofQueryCompare how,
                              const gchar * path,
                              const KvpValue * value);

QofQueryPredData *
qof_query_core_predicate_copy (QofQueryPredData * pdata);

void qof_query_core_predicate_free (QofQueryPredData * pdata);

gboolean
qof_query_time_predicate_get_time (QofQueryPredData * pd, 
                                   QofTime * qt);

gchar *
qof_query_core_to_string (QofType, gpointer object, 
                          QofParam * getter);

#endif /* QOF_QUERYCORE_H */
/* @} */
/* @} */

---