qofutil.h

Go to the documentation of this file.

/********************************************************************\
 * qof-util.h -- QOF utility functions                              *
 *                                                                  *
 * 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_UTIL_H
#define QOF_UTIL_H
 
#include <stddef.h>
#include "qof.h"
#include "qoflog.h"
#include "qofbackend.h"
#include "qofclass.h"
#include "qofbook.h"
#include "qofinstance.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#define QOF_MOD_UTIL "qof.utilities"
 
#define ENUM_BODY(name, value)           \
    name value,
 
#define AS_STRING_CASE(name, value)      \
    case name: { return #name; }
 
#define FROM_STRING_CASE(name, value)    \
    if (strcmp(str, #name) == 0) {       \
        return name;  }
 
#define DEFINE_ENUM(name, list)          \
    typedef enum {                       \
        list(ENUM_BODY)                  \
    }name;
 
#define AS_STRING_DEC(name, list)        \
    const gchar* name##asString(name n);
 
#define AS_STRING_FUNC(name, list)        \
    const gchar* name##asString(name n) { \
        switch (n) {                      \
            list(AS_STRING_CASE)          \
            default: return "";  } }
 
#define FROM_STRING_DEC(name, list)      \
    name name##fromString                \
    (const gchar* str);
 
#define FROM_STRING_FUNC(name, list)     \
    name name##fromString                \
    (const gchar* str) {                 \
    if(str == NULL) { return 0; }        \
        list(FROM_STRING_CASE)           \
        return 0;  }
 
#define DEFINE_ENUM_NON_TYPEDEF(name, list)   \
    enum name {                               \
        list(ENUM_BODY)                       \
    };
 
#define FROM_STRING_DEC_NON_TYPEDEF(name, list)   \
   void name##fromString                          \
   (const gchar* str, enum name *type);
 
#define FROM_STRING_CASE_NON_TYPEDEF(name, value) \
   if (strcmp(str, #name) == 0) { *type = name; }
 
#define FROM_STRING_FUNC_NON_TYPEDEF(name, list)  \
   void name##fromString                          \
   (const gchar* str, enum name *type) {          \
   if(str == NULL) { return; }                    \
    list(FROM_STRING_CASE_NON_TYPEDEF) }
 
#define AS_STRING_DEC_NON_TYPEDEF(name, list)     \
   const gchar* name##asString(enum name n);
 
#define AS_STRING_FUNC_NON_TYPEDEF(name, list)    \
   const gchar* name##asString(enum name n) {     \
       switch (n) {                               \
           list(AS_STRING_CASE_NON_TYPEDEF)       \
           default: return ""; } }
 
#define AS_STRING_CASE_NON_TYPEDEF(name, value)   \
   case name: { return #name; }
 
void qof_init (void);
 
void qof_close (void);
 
/* **** Prototypes *********************************************/
 
void g_hash_table_foreach_sorted(GHashTable *hash_table, GHFunc func, gpointer user_data, GCompareFunc compare_func);
 
gboolean qof_utf8_substr_nocase (const gchar *haystack, const gchar *needle);
 
gint safe_strcasecmp (const gchar * da, const gchar * db);
 
gint null_strcmp (const gchar * da, const gchar * db);
 
gchar * ultostr (gulong val, gint base);
 
gboolean gnc_strisnum(const gchar *s);
 
#ifndef HAVE_STPCPY
#define stpcpy g_stpcpy
#endif
 
gboolean qof_begin_edit(QofInstance *inst);
 
gboolean qof_commit_edit(QofInstance *inst);
 
gboolean
qof_commit_edit_part2(QofInstance *inst,
                      void (*on_error)(QofInstance *, QofBackendError),
                      void (*on_done)(QofInstance *),
                      void (*on_free)(QofInstance *));
 
#ifdef __cplusplus
}
#endif
 
#endif /* QOF_UTIL_H */