gpe-expenses
0.1.9
|
Files | |
file | qof-main.c |
Common functions for the QOF external framework. | |
file | qof-main.h |
Common functions for the QOF external framework. |
Data Structures | |
struct | QofMain_s |
The qof-main context struct. More... |
Macros | |
#define | _GNU_SOURCE |
#define | MAX_LINE 79 |
#define | ERR_INDENT strlen(PACKAGE) + 2 |
Indent error messages as paragraphs. | |
#define | QOF_DATE_STRING_LENGTH MAX_DATE_LENGTH |
#define | QOF_MAIN_CLI "QOF-mod-command-line" |
#define | CATEGORY_NAME "category" |
Category name. | |
#define | QSF_COMPRESS "compression_level" |
#define | QSF_ENCODING "encoding_string" |
#define | QSF_DATE_CONVERT "convert_date_to_time" |
#define | QOF_SQL_SUPPORTED "^SELECT|INSERT" |
#define | QOF_CLI_OPTIONS |
Common QOF CLI options. | |
#define | QOF_MAIN_OP |
#define | QOF_OP_VARS |
#define | QOF_OP_INIT |
Typedefs | |
typedef struct QofMain_s | QofMainContext |
The qof-main context struct. |
Functions | |
void | qof_main_wrap_line (FILE *fp, gint indent, const gchar *template_str,...) __attribute__((format(printf |
Wrap long lines in popt-style. | |
static void | qof_main_run_sql (QofMainContext *context) |
static void | qof_main_run_query (QofMainContext *context) |
void | qof_main_free (QofMainContext *context) |
static void | find_param_cb (QofParam *param, gpointer user_data) |
static void | build_database_list (QofIdTypeConst obj_type, QofMainContext *context) |
static void | select_cb (QofObject *obj, gpointer data) |
void | qof_main_moderate_query (QofMainContext *context) |
Assemble the components of the query. | |
static void | option_cb (QofBackendOption *option, gpointer 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_cmd_xmlfile (QofMainContext *context) |
static void | qof_main_list (QofObject *obj, gpointer G_GNUC_UNUSED data) |
void | qof_main_select (QofMainContext *context) |
void | qof_cmd_list (void) |
Lists all databases supported by the current QOF framework. | |
static void | explain_cb (QofParam *param, gpointer G_GNUC_UNUSED user_data) |
void | qof_cmd_explain (QofMainContext *context) |
void | qof_mod_category (const gchar *category, QofMainContext *data) |
Shorthand to only query objects that are set to the specified category. | |
glong | qof_mod_get_local_offset (void) |
Get the gmt_off offset for this locale. | |
void | qof_mod_database (const gchar *database, QofMainContext *data) |
Shorthand to only query objects within one specific supported database. | |
void | qof_mod_time (const gchar *date_time, QofMainContext *data) |
Shorthand to only query objects that contain the specified date. | |
void | qof_mod_exclude (const gchar *exclude, QofMainContext *data) |
Shorthand to exclude a supported database from the query. | |
void | qof_mod_sql (const gchar *sql_query, QofMainContext *data) |
Specify a SQL query on the command line. | |
void | qof_mod_sql_file (const gchar *sql_file, QofMainContext *data) |
Specify one or more SQL queries contained in a file. | |
void | qof_mod_write (const gchar *write_file, QofMainContext *data) |
Write the results of any query to the file. | |
void | qof_main_show_error (QofSession *session) |
Output error messages from QOF. | |
GSList * | qof_main_get_param_list (QofIdTypeConst object_type, QofType param_type) |
List of all parameters for this object of one QOF type. |
Variables | |
static QofLogModule | log_module = "QOF-mod-command-line" |
Includes common functions for all QOF CLI programs and provides generic functions to implement command line and interactive shell options.
QOF provides an outline CLI that is easily patched from the qof-generator project to make it easier to keep various QOF projects updated.
This CLI is easily extended to support your own functions and options and includes macros to help you keep up to date with changes in main QOF options. It is recommended that you do not edit this file, instead please feed patches back to the QOF-devel mailing list at http://lists.sourceforge.net/mailman/listinfo/qof-devel so that other projects can be updated.
#define CATEGORY_NAME "category" |
Category name.
The name of the parameter that holds the category of the entity.
Many CLI data sources categorise data by user-editable category strings. If your program does not, simply implement a modified QOF_CLI_OPTIONS in your code without the category option:
{"category", 'c', POPT_ARG_STRING, &category, qof_op_category, _("Shorthand to only query objects that are set to the specified category."), "string"},
Definition at line 118 of file qof-main.h.
#define QOF_CLI_OPTIONS |
Common QOF CLI options.
These are definitions for popt support in the CLI. Every program's popt table should start with QOF_CLI_OPTIONS or a replacement to insert the standard options into it. Also enables autohelp. End your popt option list with POPT_TABLEEND. If you want to remove any of these options, simply copy QOF_CLI_OPTIONS into a macro of your own and remove the options you do not need.
Definition at line 419 of file qof-main.h.
#define QOF_DATE_STRING_LENGTH MAX_DATE_LENGTH |
Maximum length of the UTC timestamp used by QSF
QOF_UTC_DATE_FORMAT "%Y-%m-%dT%H:%M:%SZ"
Definition at line 100 of file qof-main.h.
#define QOF_MAIN_CLI "QOF-mod-command-line" |
Debug module for qof-main
Definition at line 103 of file qof-main.h.
#define QOF_MAIN_OP |
use only if you have no extended options, otherwise use as a template.
Definition at line 456 of file qof-main.h.
#define QOF_OP_INIT |
initialise the standard QOF CLI option variables.
A simple convenience macro.
Definition at line 485 of file qof-main.h.
#define QOF_OP_VARS |
Define the variables for the standard QOF CLI options.
If you remove any QOF CLI options, ensure you also remove the option variable and it's initialiser.
Definition at line 477 of file qof-main.h.
#define QOF_SQL_SUPPORTED "^SELECT|INSERT" |
The SQL commands supported by QOF
A regular expression used to exclude unsupported commands from SQL files. Anything that does not match the expression will be silently ignored. This allows genuine SQL dump files to be parsed without errors.
A QOF object is similar to a definition of a SQL table.
A QOF entity is similar to an instance of a SQL record.
A QOF parameter is similar to data in a SQL field.
Certain SQL commands have no QOF equivalent and should always be ignored silently:
Definition at line 159 of file qof-main.h.
Referenced by qof_mod_sql_file().
#define QSF_COMPRESS "compression_level" |
backend configuration index string for QSF
The identifier for the configuration option within QSF supported by the CLI. Matches the QofBackendOption->option_name in the KvpFrame holding the options.
Definition at line 127 of file qof-main.h.
#define QSF_DATE_CONVERT "convert_date_to_time" |
convert deprecated date fields into times.
Definition at line 133 of file qof-main.h.
#define QSF_ENCODING "encoding_string" |
backend configuration encoding string
Definition at line 130 of file qof-main.h.
typedef struct QofMain_s QofMainContext |
The qof-main context struct.
Intended as a core type for QOF-based CLI programs, wrap your own context struct around qof_main_context
void qof_cmd_explain | ( | QofMainContext * | context | ) |
Print a list of available parameters for a database.
Used with qof_mod_database to print a list of QofParam for the QofObject set in context->database.
Definition at line 444 of file qof-main.c.
References QofMain_s::database, and QofMain_s::error.
void qof_cmd_list | ( | void | ) |
Lists all databases supported by the current QOF framework.
Prints the name and description for each object type registered with this instance of QOF. No options are used.
Definition at line 416 of file qof-main.c.
References qof_main_wrap_line().
void qof_cmd_xmlfile | ( | QofMainContext * | context | ) |
query the QSF XML data
Definition at line 354 of file qof-main.c.
References QofMain_s::database, QofMain_s::encoding, ERR_INDENT, QofMain_s::exclude, QofMain_s::export_session, QofMain_s::filename, QofMain_s::gz_level, QofMain_s::input_session, qof_main_moderate_query(), qof_main_show_error(), qof_main_wrap_line(), qof_mod_compression(), qof_mod_encoding(), and QofMain_s::write_file.
void qof_main_free | ( | QofMainContext * | context | ) |
Free qof_main_context values when work is done.
Definition at line 136 of file qof-main.c.
References QofMain_s::category, QofMain_s::database, QofMain_s::filename, QofMain_s::sql_file, and QofMain_s::write_file.
Referenced by gpe_expense_close().
GSList* qof_main_get_param_list | ( | QofIdTypeConst | object_type, |
QofType | param_type | ||
) |
List of all parameters for this object of one QOF type.
Return a GSList of all parameters of this object that are a particular QOF type, QOF_TYPE_STRING, QOF_TYPE_BOOLEAN etc.
The returned GSList should be freed by the caller.
object_type | object->e_type for the relevant object. |
param_type | The type of parameter to match, QOF_TYPE_STRING etc. |
void qof_main_moderate_query | ( | QofMainContext * | context | ) |
Assemble the components of the query.
If any SQL statements are found, run separately from any -c, -d or -t options.
All queries are additive: Successive queries add more entities to the result set but no entity is set more than once.
Definition at line 224 of file qof-main.c.
References QofMain_s::database, QofMain_s::exclude, QofMain_s::query, QofMain_s::sql_list, and QofMain_s::sql_str.
Referenced by qof_cmd_xmlfile().
void qof_main_show_error | ( | QofSession * | session | ) |
Output error messages from QOF.
QOF will set errors in the QofSession. The application determines how to output those messages and for the CLI, this will be to stderr. Not all these messages are implemented in any one QOF CLI.
session | Any current session. |
Definition at line 596 of file qof-main.c.
References ERR_INDENT, and qof_main_wrap_line().
Referenced by qof_cmd_xmlfile().
void qof_main_wrap_line | ( | FILE * | fp, |
gint | indent, | ||
const gchar * | template_str, | ||
... | |||
) |
Wrap long lines in popt-style.
Defaults to a line width of 79 characters. Indents lines following the first according to the value of indent.
fp | A file stream, including stdout or stderr. |
indent | The number of characters to indent from the left. Values over or equal to 79 or less than zero are adjusted. |
template_str | String to be wrapped, containing positional parameters, as specified in the Single Unix Specification. Can be translated but should not contain newline characters except at the beginning or end of the message. |
Definition at line 56 of file qof-main.c.
Referenced by qof_cmd_list(), qof_cmd_xmlfile(), qof_main_show_error(), and qof_mod_sql_file().
void qof_mod_category | ( | const gchar * | category, |
QofMainContext * | data | ||
) |
Shorthand to only query objects that are set to the specified category.
Modifies the QOF query to only query objects that are set to category.
Definition at line 455 of file qof-main.c.
References QofMain_s::category.
void qof_mod_compression | ( | gint64 | gz_level, |
QofMainContext * | context | ||
) |
Pass the requested compression to QSF
gz_level | Integer between 0 and 9, 9 highest compression, 0 for none. |
context | The QofMain context. |
Definition at line 298 of file qof-main.c.
References QofMain_s::export_session, and QofMain_s::gz_level.
Referenced by qof_cmd_xmlfile().
void qof_mod_convert_deprecated | ( | gint64 | convert, |
QofMainContext * | context | ||
) |
configure handling of deprecated date fields.
Definition at line 335 of file qof-main.c.
References QofMain_s::convert, and QofMain_s::export_session.
void qof_mod_database | ( | const gchar * | database, |
QofMainContext * | data | ||
) |
Shorthand to only query objects within one specific supported database.
Used to only query objects within the specified database.
Definition at line 475 of file qof-main.c.
References QofMain_s::database.
void qof_mod_encoding | ( | const gchar * | encoding, |
QofMainContext * | context | ||
) |
Pass an encoding string to the backend.
Definition at line 318 of file qof-main.c.
References QofMain_s::encoding, and QofMain_s::export_session.
Referenced by qof_cmd_xmlfile().
void qof_mod_exclude | ( | const gchar * | exclude, |
QofMainContext * | data | ||
) |
Shorthand to exclude a supported database from the query.
Excludes the (single) specified database from the query.
Definition at line 528 of file qof-main.c.
References QofMain_s::exclude.
glong qof_mod_get_local_offset | ( | void | ) |
Get the gmt_off offset for this locale.
User specified strings can be assumed to be in localtime, but values are stored as UTC. This offset allows the application to modify the minimum and maximum time settings for queries so that the user gets the expected results.
If the timezone is +0100 and the date is 24th July 2006, values could be stored as 11pm on 23rd July 2006 UTC. qof_mod_get_local_offset returns -86400. Add this value to the minimum and maximum time passed to the query to ensure queries select expected timeframe: 2006-07-23T23:00:00Z to 2006-07-24T22:59:59Z.
Definition at line 461 of file qof-main.c.
Referenced by qof_mod_time().
void qof_mod_sql | ( | const gchar * | sql_query, |
QofMainContext * | data | ||
) |
Specify a SQL query on the command line.
For SELECT, the returned list is a list of all of the instances of 'SomeObj' that match the query. The 'SORT' term is optional. The 'WHERE' term is optional; but if you don't include 'WHERE', you will get a list of all of the object instances. The Boolean operations 'AND' and 'OR' together with parenthesis can be used to construct arbitrarily nested predicates.
For INSERT, the returned list is a list containing the newly created instance of 'SomeObj'.
Date queries handle full date and time strings, using the format exported by the QSF backend. To query dates and times, convert user input into UTC time using qof_date_print and QOF_DATE_FORMAT_UTC
If the param is a KVP frame, then we use a special markup to indicate frame values. The markup should look like /some/kvp/path:value. Thus, for example,
SELECT * FROM SomeObj WHERE (param_a < '/some/kvp:10.0')
will search for the object where param_a is a KVP frame, and this KVP frame contains a path '/some/kvp' and the value stored at that path is floating-point and that float value is less than 10.0.
sql_query | Examples: |
"select * from pilot_address"
"select * from pilot_expenses where type_of_expense = 'Mileage';"
"SELECT * from pilot_datebook where start_time > '2004-04-06T00:00Z' and end_time < '2005-04-05T23:59:59Z';"
"insert into pilot_todo (description, date_due, todo_priority) values ('put the cat out', '2005-11-24T21:30:00Z', 1)"
data | The QofMain context. |
Definition at line 535 of file qof-main.c.
References QofMain_s::sql_str.
void qof_mod_sql_file | ( | const gchar * | sql_file, |
QofMainContext * | data | ||
) |
Specify one or more SQL queries contained in a file.
The rules for single SQL commands also apply with regard to the lack of explicit support for joins and the pending support for selecting only certain parameters from a certain object.
See qof_mod_sql for information on the queries supported.
Definition at line 541 of file qof-main.c.
References ERR_INDENT, qof_main_wrap_line(), QOF_SQL_SUPPORTED, QofMain_s::sql_file, and QofMain_s::sql_list.
void qof_mod_time | ( | const gchar * | date_time, |
QofMainContext * | data | ||
) |
Shorthand to only query objects that contain the specified date.
Used to modify the QOF query to only query objects that contain at least one parameter containing a QOF_TYPE_TIME that matches the range specified. Dates need to be specified as YY-MM-DD, i.e. QOF_DATE_FORMAT_ISO.
You can specify a UTC timestring, just as normally output by QSF, but the time will not be matched when using the shorthand option, only the year, month and day.
For more precise time matches or to set a defined period that doesn't follow whole calendar months, (e.g. the UK financial year) use a SQL statement:
"SELECT * from pilot_datebook where start_time > '2004-04-06T00:00Z'\n and end_time < '2005-04-05T23:59:59Z';"
Partial matches are allowed, so YY-MM matches any object where a date is within the specified month and year, YY matches any object where a date is within the specified year.
The query range starts at midnight on the first day of the range and ends at 1 second to midnight on the last day of the range.
Definition at line 482 of file qof-main.c.
References QofMain_s::max_qt, QofMain_s::min_qt, and qof_mod_get_local_offset().
void qof_mod_write | ( | const gchar * | write_file, |
QofMainContext * | data | ||
) |
Write the results of any query to the file.
filename of the file to be written out.
Definition at line 590 of file qof-main.c.
References QofMain_s::write_file.