- add doxygen comments to all functions

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

diff --git a/include/libfirm/adt/xmalloc.h b/include/libfirm/adt/xmalloc.h
index 30925b9..d9d8d75 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.
  *
@@ -28,26 +28,78 @@
 #ifndef FIRM_ADT_XMALLOC_H
 #define FIRM_ADT_XMALLOC_H
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 #include <stddef.h>
+#include <stdlib.h>
 
 /* xmalloc() & friends. */
 
 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);
 
 #define xfree(ptr)      free(ptr)
 
+/**
+ * Allocate n objects of a certain type
+ */
+#define XMALLOCN(type, n) ((type*)xmalloc(sizeof(type) * (n)))
+
+/**
+ * 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(xmalloc(offsetof(type, member) + sizeof(((type*)0)->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)))
+
 
 /* Includes for alloca() */
-#if defined(__FreeBSD__)
-#include <stdlib.h>
-#elif defined(_WIN32)
+#ifdef _WIN32
 #include <malloc.h>
-#else
+#endif
+#ifdef HAVE_ALLOCA_H
 #include <alloca.h>
 #endif
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif