/* $Id$
 * Include file with general macros and typedefs used through Captive project
 * Copyright (C) 2002 Jan Kratochvil <project-captive@jankratochvil.net>
 * 
 * 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; exactly version 2 of June 1991 is required
 * 
 * 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 _CAPTIVE_MACROS_H
#define _CAPTIVE_MACROS_H 1


#include <glib/gmacros.h>
#include <glib/gmem.h>
#include <stdarg.h>


G_BEGIN_DECLS

/**
 * CAPTIVE_FAKEUSE:
 *
 * Prevent 'might be used uninitialized' warning.
 * Macro will fakes the use of the variable as sometimes GCC can't code flow
 * analyse #C correctly.
 *
 * <informalexample>
 * <programlisting>
 * g_some_type some_variable CAPTIVE_FAKEUSE;
 * </programlisting>
 * </informalexample>
 */
#define CAPTIVE_FAKEUSE =0


/**
 * captive_newn:
 * @objp: Variable with the pointer to the objects wished to be allocated.
 * Original value is discarded.
 * @n: Numbers of objects to be allocated. Value %0 is permitted (g_free() effect).
 *
 * Macto to allocate @n objects of type *@objp and to assign the resulting pointer to @objp.
 * Allocated memory may contain garbage.
 *
 * @Returns: Initialized @objp value as the memory of size #sizeof(typeof(*objp))*n.
 */
#define captive_newn(objp,n) ((objp)=g_new(typeof(*(objp)),(n)))


/**
 * captive_new0n:
 * @objp: Variable with the pointer to the objects wished to be allocated and precleared.
 * Original value is discarded.
 * @n: Numbers of objects to be allocated. Value %0 is permitted (g_free() effect).
 *
 * Macro to allocate @n objects of type *@objp and to assign the resulting pointer to @objp.
 * Allocated memory is precleared.
 * 
 * @Returns: Initialized @objp value as the cleared memory of size #sizeof(typeof(*objp))*n.
 */
#define captive_new0n(objp,n) ((objp)=g_new0(typeof(*(objp)),(n)))


/**
 * captive_renewn:
 * @objp: Variable with the pointer to the objects wished to be reallocated. 
 * Value %NULL is permitted (g_malloc() effect).
 * @n: Numbers of objects to be allocated. Value %0 is permitted (g_free() effect).
 *
 * Macro to reallocate the original memory stored in @objp
 * to the size @n objects of type *@objp and to assign the resulting pointer to @objp.
 * New allocated space may contain garbage. Both @objp and @n can be nonexclusively
 * passed as zero.
 * 
 * @Returns: Initialized @objp value as the memory of size #sizeof(typeof(*objp))*n.
 */
#define captive_renewn(objp,n) ((objp)=g_renew(typeof(*(objp)),(objp),(n)))


/**
 * captive_new:
 * @objp: Variable with the pointer to the object wished to be allocated.
 * Original value is discarded.
 *
 * Macto to allocate one object of type *@objp and to assign the resulting pointer to @objp.
 * Allocated memory may contain garbage. Equivalent to captive_newn(objp,1) call.
 *
 * @Returns: Initialized @objp value as the memory of size #sizeof(typeof(*objp)).
 */
#define captive_new(objp) (captive_newn((objp),1))


/**
 * captive_new0:
 * @objp: Variable with the pointer to the object wished to be allocated and precleared.
 * Original value is discarded.
 *
 * Macro to allocate one object of type *@objp and to assign the resulting pointer to @objp.
 * Allocated memory is precleared. Equivalent to captive_new0n(objp,1) call.
 * 
 * @Returns: Initialized @objp value as the cleared memory of size #sizeof(typeof(*objp)).
 */
#define captive_new0(objp) (captive_new0n((objp),1))


/**
 * captive_va_arg:
 * @objp: Variable to be filled from the next argument of @ap.
 * @ap: Initialized #va_list type.
 *
 * Automatically determines the size of @objp.
 * Equivalent to objp=va_arg(ap,typeof(objp)) call.
 *
 * @Returns: Initialized @objp value.
 */
#define captive_va_arg(objp,ap) ((objp)=va_arg((ap),typeof(objp)))

G_END_DECLS


#endif /* _CAPTIVE_MACROS_H */