gnc-engine-util.h

Go to the documentation of this file.

/********************************************************************\
 * gnc-engine-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       *
 * 59 Temple Place - Suite 330        Fax:    +1-617-542-2652       *
 * Boston, MA  02111-1307,  USA       gnu@gnu.org                   *
\********************************************************************/

#ifndef QOF_UTIL_H
#define QOF_UTIL_H

#include <glib.h>
#include <stddef.h>
#include "config.h"
#include "qof.h"

/* Macros *****************************************************/

#define SAFE_STRCMP_REAL(fcn,da,db) {    \
  if ((da) && (db)) {                    \
    if ((da) != (db)) {                  \
      int retval = fcn ((da), (db));     \
      /* if strings differ, return */    \
      if (retval) return retval;         \
    }                                    \
  } else                                 \
  if ((!(da)) && (db)) {                 \
    return -1;                           \
  } else                                 \
  if ((da) && (!(db))) {                 \
    return +1;                           \
  }                                      \
}

#define SAFE_STRCMP(da,db) SAFE_STRCMP_REAL(strcmp,(da),(db))

#define SAFE_STRCASECMP(da,db) SAFE_STRCMP_REAL(strcasecmp,(da),(db))

#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 char* name##asString(name n);

#define AS_STRING_FUNC(name, list)       \
    const char* name##asString(name n) {       \
        switch (n) {                     \
            list(AS_STRING_CASE)         \
            default: return "";  } }

#define FROM_STRING_DEC(name, list)      \
    name name##fromString                \
    (const char* str);

#define FROM_STRING_FUNC(name, list)     \
    name name##fromString                \
    (const char* str) {                  \
    if(str == NULL) { return 0; }        \
        list(FROM_STRING_CASE)           \
        return 0;  }

#define FROM_STRING_DEC_NON_TYPEDEF(name, list)      \
   void name##fromString                          \
        (const char* 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 char* str, enum name *type) {         \
   if(str == NULL) { return; }                    \
    list(FROM_STRING_CASE_NON_TYPEDEF) }

#define AS_STRING_DEC_NON_TYPEDEF(name, list)        \
    const char* name##asString(enum name n);

#define AS_STRING_FUNC_NON_TYPEDEF(name, list)       \
    const char* 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; }

/* Define the long long int conversion for scanf */
#if HAVE_SCANF_LLD
# define GNC_SCANF_LLD "%lld"
#else
# define GNC_SCANF_LLD "%qd"
#endif

void qof_init (void);

void qof_close (void);

/* **** Prototypes *********************************************/

int safe_strcmp (const char * da, const char * db);

int safe_strcasecmp (const char * da, const char * db);

int null_strcmp (const char * da, const char * db);

extern char *strncasestr(const char *str1, const char *str2, size_t len);
extern char *strcasestr(const char *str1, const char *str2);

char * ultostr (unsigned long val, int base);

gboolean gnc_strisnum(const char *s);

char * gnc_stpcpy (char *dest, const char *src);

#ifndef HAVE_STPCPY
#define stpcpy gnc_stpcpy
#endif

const char * qof_util_whitespace_filter (const char * val);

int qof_util_bool_to_int (const char * val);


GCache* gnc_engine_get_string_cache(void);

void gnc_engine_string_cache_destroy (void);

void gnc_string_cache_remove(gconstpointer key);

gpointer gnc_string_cache_insert(gpointer key);

#define CACHE_INSERT(str) gnc_string_cache_insert((gpointer)(str));
#define CACHE_REMOVE(str) gnc_string_cache_remove((str));

#endif /* QOF_UTIL_H */

---