fix doxygen warning

[libfirm] / include / libfirm / adt / xmalloc.h

diff --git a/include/libfirm/adt/xmalloc.h b/include/libfirm/adt/xmalloc.h
index 30925b9..a4cfaa7 100644 (file)
--- a/include/libfirm/adt/xmalloc.h
+++ b/include/libfirm/adt/xmalloc.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -21,7 +21,6 @@
  * @file
  * @brief       never failing wrappers for malloc() & friends.
  * @author      Markus Armbruster
- * @version     $Id$
  * @note        The functions here never fail because they simply abort your
  *              program in case of an error.
  */
@@ -29,25 +28,129 @@
 #define FIRM_ADT_XMALLOC_H
 
 #include <stddef.h>
+#include <stdlib.h>
+#include <string.h>
 
-/* xmalloc() & friends. */
+/* Includes for alloca() */
+#ifdef _WIN32
+#include <malloc.h>
+#endif
+#if defined(__linux__) || defined(__APPLE__)
+#include <alloca.h>
+#endif
+
+#include "../begin.h"
 
-void *xmalloc(size_t size);
-void *xcalloc(size_t num, size_t size);
-void *xrealloc(void *ptr, size_t size);
-char *xstrdup(const char *str);
-void free(void *ptr);
+/**
+ * @ingroup adt
+ * @defgroup xmalloc Memory Allocation
+ * @{
+ */
 
+/**
+ * Allocate @p size bytes on the heap.
+ * This is a wrapper for malloc which calls panic() in case of errors, so no
+ * error handling is required for code using it.
+ */
+FIRM_API void *xmalloc(size_t size);
+/**
+ * Chane size of a previously allocated memory block to @p size bytes.
+ * This is a wrapper for realloc which calls panic() in case of errors, so no
+ * error handling is required for code using it.
+ */
+FIRM_API void *xrealloc(void *ptr, size_t size);
+/**
+ * Allocates memory and copies string @p str into it.
+ * This is a wrapper for strdup which calls panic() in case of errors, so no
+ * error handling is required for code using it.
+ */
+FIRM_API char *xstrdup(const char *str);
+/**
+ * Another name for the free function
+ * @deprecated
+ */
 #define xfree(ptr)      free(ptr)
 
+/**
+ * Allocate n objects of a certain type
+ */
+#define XMALLOCN(type, n) ((type*)xmalloc(sizeof(type) * (n)))
 
-/* Includes for alloca() */
-#if defined(__FreeBSD__)
-#include <stdlib.h>
-#elif defined(_WIN32)
-#include <malloc.h>
-#else
-#include <alloca.h>
-#endif
+/**
+ * Allocate n objects of a certain type and zero them
+ */
+#define XMALLOCNZ(type, n) ((type*)memset(xmalloc(sizeof(type) * (n)), 0, sizeof(type) * (n)))
+
+/**
+ * Allocate one object of a certain type
+ */
+#define XMALLOC(type) XMALLOCN(type, 1)
+
+/**
+ * Allocate one object of a certain type and zero it
+ */
+#define XMALLOCZ(type) XMALLOCNZ(type, 1)
+
+/**
+ * Reallocate n objects of a certain type
+ */
+#define XREALLOC(ptr, type, n) ((type*)xrealloc(ptr, sizeof(type) * (n)))
+
+/**
+ * Allocate an object with n elements of a flexible array member
+ */
+#define XMALLOCF(type, member, n) ((type*)xmalloc(offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
+
+/**
+ * Allocate an object with n elements of a flexible array member and zero the
+ * whole object
+ */
+#define XMALLOCFZ(type, member, n) ((type*)memset(XMALLOCF(type, member, (n)), 0, offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
+
+/**
+ * Allocate n objects of a certain type on the stack
+ */
+#define ALLOCAN(type, n) ((type*)alloca(sizeof(type) * (n)))
+
+/**
+ * Allocate n objects of a certain type on the stack and zero them
+ */
+#define ALLOCANZ(type, n) ((type*)memset((type*)alloca(sizeof(type) * (n)), 0, sizeof(type) * (n)))
+
+/**
+ * Allocate n objects of a certain type on the given obstack
+ */
+#define OALLOCN(obst, type, n) ((type*)obstack_alloc((obst), sizeof(type) * (n)))
+
+/**
+ * Allocate n objects of a certain type on the given obstack and zero them
+ */
+#define OALLOCNZ(obst, type, n) ((type*)memset(OALLOCN((obst), type, (n)), 0, sizeof(type) * (n)))
+
+/**
+ * Allocate one object of a certain type on the given obstack
+ */
+#define OALLOC(obst, type) OALLOCN(obst, type, 1)
+
+/**
+ * Allocate one object of a certain type on the given obstack and zero it
+ */
+#define OALLOCZ(obst, type) OALLOCNZ(obst, type, 1)
+
+/**
+ * Allocate an object with n elements of a flexible array member on the given
+ * obstck
+ */
+#define OALLOCF(obst, type, member, n) ((type*)obstack_alloc((obst), offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
+
+/**
+ * Allocate an object with n elements of a flexible array member on the given
+ * obstack and zero the whole object
+ */
+#define OALLOCFZ(obst, type, member, n) ((type*)memset(OALLOCF((obst), type, member, (n)), 0, offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
+
+/** @} */
+
+#include "../end.h"
 
 #endif