lasso/lasso/utils.h

383 lines
9.5 KiB
C

/* $Id$
*
* Lasso - A free implementation of the Liberty Alliance specifications.
*
* Copyright (C) 2004-2007 Entr'ouvert
* http://lasso.entrouvert.org
*
* Authors: See AUTHORS file in top-level directory.
*
* 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef __LASSO_UTILS_H__
#define __LASSO_UTILS_H__
#include <glib.h>
#include "debug.h"
#ifdef LASSO_DEBUG
#ifdef __GNUC__
#define lasso_check_type_equality(a,b) \
{ \
enum { TYPE_MISMATCH = (1 / __builtin_types_compatible_p(typeof(a), typeof(b))) }; \
}
#else
#define lasso_check_type_equality(a,b)
#endif
#else
#define lasso_check_type_equality(a,b)
#endif
#ifdef __GNUC__
#define lasso_check_type_equality2(a,b,c) \
{ \
enum { TYPE_MISMATCH = (1 / (__builtin_types_compatible_p(typeof(a), typeof(b))+__builtin_types_compatible_p(typeof(a), typeof(c)))) }; \
}
#else
#define lasso_check_type_equality2(a,b,c)
#endif
/* Freeing */
#define lasso_release(dest) \
{ \
if (dest) { \
g_free(dest); dest = NULL; \
} \
}
#define lasso_release_full(dest, free_function) \
{ \
if (dest) { \
free_function(dest); dest = NULL; \
} \
}
#define lasso_release_full2(dest, free_function, type) \
{ \
lasso_check_type_equality(dest, type); \
if (dest) { \
free_function(dest); dest = NULL; \
} \
}
#define lasso_release_gobject(dest) \
{ \
if (G_IS_OBJECT(dest) || dest == NULL) { \
lasso_release_full(dest, g_object_unref); \
} else { \
g_critical("Trying to unref a non GObject pointer dest=%s", #dest); \
} \
}
#define lasso_release_string(dest) \
lasso_release_full(dest, g_free)
#define lasso_release_list(dest) \
lasso_release_full2(dest, g_list_free, GList*)
#define lasso_release_list_of_full(dest, free_function) \
{ \
if (dest) { \
g_list_foreach(dest, (GFunc)free_function, NULL); \
lasso_release_list(dest); \
} \
}
#define lasso_release_list_of_strings(dest) \
lasso_release_list_of_full(dest, g_free)
#define lasso_release_list_of_gobjects(dest) \
lasso_release_list_of_full(dest, g_object_unref)
#define lasso_unlink_and_release_node(node) \
lasso_release_list_of_full(dest, xmlFreeNode)
#define lasso_release_xml_node(node) \
lasso_release_full2(node, xmlFreeNode, xmlNodePtr)
#define lasso_release_doc(doc) \
lasso_release_full2(doc, xmlFreeDoc, xmlDocPtr)
#define lasso_release_xml_string(dest) \
lasso_release_full2(dest, xmlFree, xmlChar*)
#define lasso_release_encrypt_context(dest) \
lasso_release_full2(dest, xmlSecEncCtxDestroy, xmlSecEncCtxPtr)
#define lasso_release_signature_context(dest) \
lasso_release_full2(dest, xmlSecDSigCtxDestroy,xmlSecDSigCtxPtr)
#define lasso_release_key_manager(dest) \
lasso_release_full2(dest, xmlSecKeysMngrDestroy, xmlSecKeysMngrPtr)
#define lasso_release_output_buffer(dest) \
lasso_release_full2(dest, xmlOutputBufferClose, xmlOutputBufferPtr)
#define lasso_release_xpath_object(dest) \
lasso_release_full2(dest, xmlXPathFreeObject, xmlXPathObjectPtr)
#define lasso_release_xpath_context(dest) \
lasso_release_full2(dest, xmlXPathFreeContext, xmlXPathContextPtr)
#define lasso_release_xpath_job(xpathObject, xpathContext, xmlDocument) \
lasso_release_xpath_object(xpathObject); \
lasso_release_xpath_context(xpathContext); \
lasso_release_doc(xmlDocument)
#define lasso_release_sec_key(dest) \
lasso_release_full2(dest, xmlSecKeyDestroy, xmlSecKeyPtr)
/* Assignment and list appending */
#define lasso_assign_string(dest,src) \
{ \
char *__tmp = g_strdup(src);\
lasso_release_string(dest); \
dest = __tmp; \
}
#define lasso_assign_xml_string(dest,src) \
{ \
xmlChar *__tmp = g_strdup(src); \
lasso_release_xml_string(dest); \
dest = __tmp; \
}
#define lasso_assign_new_string(dest,src) \
{ \
char *__tmp = src; \
if (dest != __tmp) \
lasso_release_string(dest); \
dest = __tmp; \
}
#define lasso_assign_gobject(dest,src) \
{ \
GObject *__tmp = G_OBJECT(src); \
if (__tmp) \
g_object_ref(__tmp); \
lasso_release_gobject(dest); \
dest = (void*)(__tmp); \
}
#define lasso_assign_new_gobject(dest,src) \
{ \
GObject *__tmp = G_OBJECT(src); \
if (dest != (void*)__tmp) \
lasso_release_gobject(dest); \
dest = (void*)(__tmp); \
}
#define lasso_assign_xml_node(dest,src) \
{ \
xmlNode *__tmp = (src); \
lasso_check_type_equality(dest, src); \
if (dest) \
xmlFreeNode(dest); \
dest = xmlCopyNode(__tmp, 1); \
}
#define lasso_assign_new_list_of_gobjects(dest, src) \
{ \
GList *__tmp = (src); \
lasso_release_gobject_list(dest); \
dest = __tmp; \
}
#define lasso_assign_list_of_gobjects(dest, src) \
{ \
GList *__tmp = (src); \
lasso_release_list_of_gobjects(dest); \
dest = g_list_copy(__tmp); \
for (;__tmp != NULL; __tmp = g_list_next(__tmp)) { \
if (G_IS_OBJECT(__tmp->data)) { \
g_object_ref(__tmp->data); \
} \
} \
}
#define lasso_assign_list_of_strings(dest, src) \
{ \
GList *__tmp = src; \
GList *__iter_dest; \
lasso_release_list_of_strings(dest); \
dest = g_list_copy(__tmp); \
for (__iter_dest = dest ; __iter_dest != NULL ; __iter_dest = g_list_next(__iter_dest)) { \
__iter_dest->data = g_strdup(__iter_dest->data); \
} \
}
#define lasso_assign_new_sec_key(dest, src) \
{ \
xmlSecKey *__tmp = (src); \
if (dest) \
lasso_release_sec_key(dest); \
dest = __tmp; \
}
#define lasso_assign_sec_key(dest, src) \
{ \
xmlSecKey *__tmp = xmlSecKeyDup(src); \
if (dest) \
lasso_release_sec_key(dest); \
dest = __tmp; \
}
/* List appending */
#define lasso_list_add(dest, src) \
{ \
lasso_check_type_equality((src), void*); \
dest = g_list_append(dest, (src)); \
}
#define lasso_list_add_non_null(dest, src) \
{ \
void *__tmp_non_null_src = (src); \
if (__tmp_non_null_src != NULL) { \
dest = g_list_append(dest, __tmp_non_null_src); \
} else { \
g_critical("Adding a NULL value to a non-NULL content list: dest=%s src=%s", #dest, #src); \
} \
}
#define lasso_list_add_string(dest, src) \
{ \
lasso_list_add_non_null(dest, g_strdup(src));\
}
#define lasso_list_add_new_string(dest, src) \
{ \
gchar *__tmp = src; \
lasso_list_add_non_null(dest, __tmp); \
}
#define lasso_list_add_xml_string(dest, src) \
{\
xmlChar *__tmp_src = (src);\
lasso_list_add_non_null(dest, (void*)g_strdup((char*)__tmp_src));\
}
#define lasso_list_add_gobject(dest, src) \
{ \
void *__tmp_src = (src); \
if (G_IS_OBJECT(__tmp_src)) { \
dest = g_list_append(dest, g_object_ref(__tmp_src)); \
} else { \
g_critical("Trying to add to a GList* a non GObject pointer dest=%s src=%s", #dest, #src); \
} \
}
#define lasso_list_add_new_gobject(dest, src) \
{ \
void *__tmp_src = (src); \
if (G_IS_OBJECT(__tmp_src)) { \
dest = g_list_append(dest, __tmp_src); \
} else { \
g_critical("Trying to add to a GList* a non GObject pointer dest=%s src=%s", #dest, #src); \
} \
}
#define lasso_list_add_xml_node(dest, src) \
{ \
xmlNode *__tmp_src = src; \
lasso_list_add_non_null(dest, __tmp_src); \
}
/* Pointer ownership transfer */
#define lasso_transfer_full(dest, src, kind) \
{\
lasso_release_##kind((dest)); \
lasso_check_type_equality(dest, src); \
(dest) = (void*)(src); \
(src) = NULL; \
}
#define lasso_transfer_xpath_object(dest, src) \
lasso_transfer_full(dest, src, xpath_object)
#define lasso_transfer_string(dest, src) \
lasso_transfer_full(dest, src, string)
#define lasso_transfer_gobject(dest, src) \
lasso_transfer_full(dest, src, gobject)
/* Node extraction */
#define lasso_extract_node_or_fail(to, from, kind, error) \
if (LASSO_IS_##kind(from)) { \
to = LASSO_##kind(from); \
} else { \
rc = error; \
goto cleanup; \
}
/* Bad param handling */
#define lasso_return_val_if_invalid_param(kind, name, val) \
g_return_val_if_fail(LASSO_IS_##kind(name), val)
#define lasso_bad_param(kind, name) \
lasso_return_val_if_invalid_param(kind, name, \
LASSO_PARAM_ERROR_BAD_TYPE_OR_NULL_OBJ);
#define lasso_null_param(name) \
g_return_val_if_fail(name != NULL, LASSO_PARAM_ERROR_BAD_TYPE_OR_NULL_OBJ);
#define goto_exit_with_rc(rc_value) \
{\
rc = (rc_value); \
goto exit; \
}
#define goto_exit_if_fail(condition, rc_value) \
{\
if (! (condition) ) {\
rc = (rc_value); \
goto exit; \
} \
}
#define goto_exit_if_fail_with_warning(condition, rc_value) \
{\
if (! (condition) ) {\
g_warning("%s %s", __STRING(condition), __STRING(rc_value));\
rc = (rc_value); \
goto exit; \
} \
}
#define lasso_mem_debug(who, what, where) \
{ \
if (lasso_flag_memory_debug) \
fprintf(stdout, " freeing %s/%s (at %p)\n", who, what, (void*)where); \
}
/* Declare type of element in a container */
#ifndef OFTYPE
#define OFTYPE(x)
#endif
/* Get a printable extract for error messages */
char* lasso_safe_prefix_string(const char *str, gsize length);
/* GLIB bacward-compatibility */
#if (GLIB_MAJOR_VERSION == 2 && GLIB_MINOR_VERSION < 16)
int g_strcmp0 (const char *str1,
const char *str2);
#endif
#endif /* __LASSO_UTILS_H__ */