qof-main.h

Go to the documentation of this file.

/***************************************************************************
 *            qof-main.h
 *
 *  This is an auto-generated file. Patches are available from
 *  http://qof-gen.sourceforge.net/
 *  For QOF 0.7.0, using QofTime.
 *
 *  Thu Jan 13 12:15:41 2005
 *  Copyright  2005-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, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
#ifndef _QOF_MAIN_H
#define _QOF_MAIN_H

void qof_main_wrap_line (FILE * fp, gint indent,
    const gchar * template_str, ...)
    __attribute__ ((format (printf, 3, 4)));

#define ERR_INDENT strlen(PACKAGE) + 2

GSList*
qof_main_get_param_list(QofIdTypeConst object_type, QofType param_type);

#define QOF_DATE_STRING_LENGTH  MAX_DATE_LENGTH

#define QOF_MAIN_CLI  "QOF-mod-command-line"

#define CATEGORY_NAME "category"

#define QSF_COMPRESS "compression_level"

#define QSF_ENCODING "encoding_string"

#define QSF_DATE_CONVERT "convert_date_to_time"

#define QOF_SQL_SUPPORTED  "^SELECT|INSERT"

gchar *
qof_main_make_utf8 (gchar * string);

glong
qof_mod_get_local_offset (void);

void qof_main_show_error (QofSession * session);

typedef struct QofMain_s
{
    gchar *filename;
    gchar *write_file;
    gchar *input_file;
    gchar *sql_file;
    gchar *sql_str;
    gchar *database;
    gchar *exclude;
    gchar *category;
    QofTime *min_qt;
    QofTime *max_qt;
    QofSession *input_session;
    QofSession *export_session;
    gboolean error;
    QofQuery *query;
    GList *sql_list;
    gint64 gz_level;
    const gchar *encoding;
    gint64 convert;
    QofType param_type;
} QofMainContext;

void qof_main_free (QofMainContext * context);

void qof_cmd_xmlfile (QofMainContext * context);

void qof_cmd_list (void);

void 
qof_mod_category (const gchar * category, QofMainContext * data);

void 
qof_mod_database (const gchar * database, QofMainContext * data);

void 
qof_mod_time (const gchar * date_time, QofMainContext * data);

void 
qof_mod_exclude (const gchar * exclude, QofMainContext * data);

void 
qof_mod_sql (const gchar * sql_query, QofMainContext * data);

void 
qof_mod_sql_file (const gchar * sql_file, QofMainContext * data);

void 
qof_mod_write (const gchar * write_file, QofMainContext * data);

void 
qof_mod_compression (gint64 gz_level, QofMainContext * context);

void 
qof_mod_encoding (const gchar * encoding, QofMainContext * context);

void
qof_mod_convert_deprecated (gint64 convert, QofMainContext * context);

void qof_main_moderate_query (QofMainContext * context);

void qof_cmd_explain (QofMainContext * context);

void qof_main_select (QofMainContext * context);

/* Translators: ignore the above comment, gettext is too dumb to detect 
documentation. */

#define QOF_CLI_OPTIONS POPT_AUTOHELP \
    {"list", 'l', POPT_ARG_NONE, NULL, qof_op_list, \
     _("List all databases supported by the current QOF framework " \
        "and exit."), NULL}, \
    {"explain", 0, POPT_ARG_NONE, NULL, qof_op_explain, \
     _("List the fields within the specified database and " \
        "exit, requires -d."), NULL}, \
    {"xml-file", 'x', POPT_ARG_STRING, &filename, qof_op_offline, \
     _("Query the QSF XML data in <filename>"), \
     "filename"}, \
    {"date", 't', POPT_ARG_STRING, &date_time, qof_op_time, \
     _("Shorthand to only query objects that contain the " \
        "specified date."), "string"}, \
    {"database", 'd', POPT_ARG_STRING, &database, qof_op_database, \
     _("Shorthand to only query objects within a specific " \
        "supported database. "), "string"}, \
    {"exclude", 'e', POPT_ARG_STRING, &exclude, qof_op_exclude, \
     _("Shorthand to exclude a supported database from the query."), \
     "string"}, \
    {"sql", 's', POPT_ARG_STRING, &sql_query, qof_op_sql, \
     _("Specify a SQL query on the command line."), "string"}, \
    {"sql-file", 'f', POPT_ARG_STRING, &sql_file, qof_op_sql_file, \
     _("Specify one or more SQL queries contained in a file."), \
     "filename"}, \
    {"write", 'w', POPT_ARG_STRING, &write_file, qof_op_write, \
     _("Write the results of any query to the file"), "filename"}, \
    {"compress", 0, POPT_ARG_INT, &gz_level, qof_op_compress, \
     _("Compress output files, 0 for none, 9 for maximum"), "integer"}, \
    {"debug", 0, POPT_ARG_NONE, NULL, qof_op_debug, \
     _("Print debugging information to a temporary file."), NULL}, \
    {"version", 0, POPT_ARG_NONE, NULL, qof_op_vers, \
     _("Display version information"), NULL}, \
    {"category", 'c', POPT_ARG_STRING, &category, qof_op_category, \
     _("Shorthand to only query objects that are set to the specified category."), \
     "string"},

#define QOF_MAIN_OP \
    _(qof_op_noop, = 0) \
    _(qof_op_list,)     \
    _(qof_op_xmlfile,)  \
    _(qof_op_category,) \
    _(qof_op_database,) \
    _(qof_op_time,) \
    _(qof_op_exclude,)  \
    _(qof_op_sql,)      \
    _(qof_op_sql_file,) \
    _(qof_op_write, )   \
    _(qof_op_explain,)  \
    _(qof_op_vers,)     \
    _(qof_op_compress,) \
    _(qof_op_debug,)

#define QOF_OP_VARS \
    const gchar *exclude,  *date_time,  *category,  *database; \
    const gchar *sql_file, *write_file, *sql_query, *filename;

#define QOF_OP_INIT    \
    exclude = NULL;    \
    category = NULL;   \
    database = NULL;   \
    sql_file = NULL;   \
    write_file = NULL; \
    sql_query = NULL;  \
    filename = NULL;

#endif /* _QOF_MAIN_H */

---