qof-string-cache.h

Go to the documentation of this file.

/********************************************************************\
 * qof-string-cache.h -- QOF string cache 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_STRING_UTIL_H
#define QOF_STRING_UTIL_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#define QOF_MOD_UTIL "qof.utilities"
 
void qof_string_cache_init(void);
 
void qof_string_cache_destroy(void);
 
void qof_string_cache_remove(const char * key);
 
const char * qof_string_cache_insert(const char * key);
 
const char * qof_string_cache_replace(const char * dst, const char * src);
 
#define CACHE_INSERT(str) qof_string_cache_insert((str))
#define CACHE_REMOVE(str) qof_string_cache_remove((str))
 
/* Replace cached string currently in 'dst' with string in 'src'.
 * Typical usage:
 *     void foo_set_name(Foo *f, const char *str) {
 *        CACHE_REPLACE(f->name, str);
 *     }
 * It avoids unnecessary ejection by doing INSERT before REMOVE.
*/
#define CACHE_REPLACE(dst, src) do {          \
        const char *tmp = CACHE_INSERT((src));   \
        CACHE_REMOVE((dst));                  \
        (dst) = tmp;                          \
    } while (0)
 
#define QOF_CACHE_NEW(void) qof_string_cache_insert("")
 
#ifdef __cplusplus
}
#endif
 
#endif /* QOF_STRING_CACHE_H */