/*
- * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved.
- *
* This file is part of libFirm.
- *
- * This file may be distributed and/or modified under the terms of the
- * GNU General Public License version 2 as published by the Free Software
- * Foundation and appearing in the file LICENSE.GPL included in the
- * packaging of this file.
- *
- * Licensees holding valid libFirm Professional Edition licenses may use
- * this file in accordance with the libFirm Commercial License.
- * Agreement provided with the Software.
- *
- * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
- * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE.
+ * Copyright (C) 2012 University of Karlsruhe.
*/
/**
* @file
* @brief Dynamic and flexible arrays for C.
* @author Markus Armbruster, Michael Beck, Matthias Braun, Sebastian Hack
- * @version $Id$
*/
#ifndef FIRM_ADT_ARRAY_H
#define FIRM_ADT_ARRAY_H
#include <stddef.h>
#include "obst.h"
-#include "fourcc.h"
-#include "xmalloc.h"
#include "../begin.h"
+/**
+ * @ingroup adt
+ * @defgroup array Arrays
+ * @{
+ */
+
/**
* Creates a flexible array.
*
* @return A pointer to the flexible array (can be used as a pointer to the
* first element of this array).
*/
-#define NEW_ARR_F(type, nelts) \
+#define NEW_ARR_F(type, nelts) \
((type *)ir_new_arr_f((nelts), sizeof(type) * (nelts)))
+/**
+ * Create a flexible array and null its contents.
+ */
+#define NEW_ARR_FZ(type, nelts) \
+ ((type*)memset(NEW_ARR_F(type, (nelts)), 0, sizeof(type) * (nelts)))
+
/**
* Creates a new flexible array with the same number of elements as a
* given one.
* @return A pointer to the flexible array (can be used as a pointer to the
* first element of this array).
*/
-#define CLONE_ARR_F(type, arr) \
+#define CLONE_ARR_F(type, arr) \
NEW_ARR_F(type, ARR_LEN((arr)))
/**
* @return A pointer to the flexible array (can be used as a pointer to the
* first element of this array).
*/
-#define DUP_ARR_F(type, arr) \
+#define DUP_ARR_F(type, arr) \
((type*) memcpy(CLONE_ARR_F(type, (arr)), (arr), sizeof(type) * ARR_LEN((arr))))
/**
* @return A pointer to the dynamic array (can be used as a pointer to the
* first element of this array).
*/
-#define NEW_ARR_D(type, obstack, nelts) \
- ( nelts \
- ? (type *)ir_new_arr_d((obstack), (nelts), sizeof(type) * (nelts)) \
+#define NEW_ARR_D(type, obstack, nelts) \
+ ( nelts \
+ ? (type *)ir_new_arr_d((obstack), (nelts), sizeof(type) * (nelts)) \
: (type *)arr_mt_descr.elts)
+/**
+ * Create a dynamic array on an obstack and null its contents.
+ */
+#define NEW_ARR_DZ(type, obstack, nelts) \
+ ((type*)memset(NEW_ARR_D(type, (obstack), (nelts)), 0, sizeof(type) * (nelts)))
+
/**
* Creates a new dynamic array with the same number of elements as a
* given one.
* @return A pointer to the dynamic array (can be used as a pointer to the
* first element of this array).
*/
-#define CLONE_ARR_D(type, obstack, arr) \
+#define CLONE_ARR_D(type, obstack, arr) \
NEW_ARR_D(type, (obstack), ARR_LEN((arr)))
/**
* @return A pointer to the dynamic array (can be used as a pointer to the
* first element of this array).
*/
-#define DUP_ARR_D(type, obstack, arr) \
+#define DUP_ARR_D(type, obstack, arr) \
((type*)memcpy(CLONE_ARR_D(type, (obstack), (arr)), (arr), sizeof(type) * ARR_LEN ((arr))))
/**
*
* @remark This macro may change arr, so update all references!
*/
-#define ARR_RESIZE(type, arr, n) \
+#define ARR_RESIZE(type, arr, n) \
((arr) = (type*) ir_arr_resize((void *)(arr), (n), sizeof(type)))
/**
*
* @remark This macro may change arr, so update all references!
*/
-#define ARR_SETLEN(type, arr, n) \
+#define ARR_SETLEN(type, arr, n) \
((arr) = (type*) ir_arr_setlen((void *)(arr), (n), sizeof(type) * (n)))
-/** Set a length smaller than the current length of the array. Do not
- * resize. len must be <= ARR_LEN(arr). */
-#define ARR_SHRINKLEN(arr,len) \
- (ARR_VRFY((arr)), assert(ARR_DESCR((arr))->nelts >= len), \
- ARR_DESCR((arr))->nelts = len)
-
/**
* Resize a flexible array by growing it by delta elements.
*
*
* @remark This macro may change arr, so update all references!
*/
-#define ARR_EXTEND(type, arr, delta) \
+#define ARR_EXTEND(type, arr, delta) \
ARR_RESIZE(type, (arr), ARR_LEN((arr)) + (delta))
/**
*
* @remark This macro may change arr, so update all references!
*/
-#define ARR_EXTO(type, arr, n) \
- ((n) >= ARR_LEN((arr)) ? ARR_RESIZE(type, (arr), (n)+1) : (arr))
+#define ARR_EXTO(type, arr, n) \
+ do { \
+ if ((n) >= ARR_LEN(arr)) { ARR_RESIZE(type, arr, (n)+1); } \
+ } while(0)
/**
* Append one element to a flexible array.
* @param arr The array, which must be an lvalue.
* @param elt The new element, must be of type (type).
*/
-#define ARR_APP1(type, arr, elt) \
+#define ARR_APP1(type, arr, elt) \
(ARR_EXTEND(type, (arr), 1), (arr)[ARR_LEN((arr))-1] = (elt))
#ifdef NDEBUG
# define ARR_VRFY(arr) ((void)0)
# define ARR_IDX_VRFY(arr, idx) ((void)0)
#else
+/** Check array for consistency */
# define ARR_VRFY(arr) ir_verify_arr(arr)
-# define ARR_IDX_VRFY(arr, idx) \
+/** Check if index is within array bounds */
+# define ARR_IDX_VRFY(arr, idx) \
assert((0 <= (idx)) && ((idx) < ARR_LEN((arr))))
#endif
+/** @cond PRIVATE */
+
/** A type that has most constrained alignment. */
typedef union {
long double d;
long l;
} aligned_type;
-
/**
* The array descriptor header type.
*/
typedef struct {
int magic; /**< array magic. */
- size_t eltsize; /**< size of array elements. */
- union {
- struct obstack *obstack; /**< for obstack array: the obstack. */
- size_t allocated; /**< number of allocated elements. */
- } u;
+ size_t allocated; /**< number of allocated elements. */
size_t nelts; /**< current length of the array. */
aligned_type elts[1]; /**< start of the array data. */
} ir_arr_descr;
#define ARR_ELTS_OFFS offsetof(ir_arr_descr, elts)
#define ARR_DESCR(elts) ((ir_arr_descr *)(void *)((char *)(elts) - ARR_ELTS_OFFS))
+/** Set a length smaller than the current length of the array. Do not
+ * resize. len must be <= ARR_LEN(arr). */
+static inline void ARR_SHRINKLEN(void *arr, size_t new_len)
+{
+ ARR_VRFY(arr);
+ assert(ARR_DESCR(arr)->nelts >= new_len);
+ ARR_DESCR(arr)->nelts = new_len;
+}
+
+/** @endcond */
+
+/** @} */
+
#include "../end.h"
#endif
projects / libfirm / blobdiff