X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=adt%2Farray.h;h=3ade247d004d7478af65ffa7fcff2a76a018be68;hb=f56ee1a34627fb21c5909086f3597c76ce9583be;hp=ffa5e44099e14f816e52718e932e719177c9548e;hpb=ffaec83406ffaee8b981b2b80114bc2e2eab5f0e;p=cparser diff --git a/adt/array.h b/adt/array.h index ffa5e44..3ade247 100644 --- a/adt/array.h +++ b/adt/array.h @@ -1,402 +1 @@ -/* - * This file is part of cparser. - * Copyright (C) 2007-2008 Matthias Braun - * - * 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. - */ - -/* - * Project: libFIRM - * File name: ir/adt/array.h - * Purpose: Declarations for Array. - * Author: Markus Armbruster - * Modified by: - * Created: 1999 by getting from fiasco - * CVS-ID: $Id$ - * Copyright: (c) 1995, 1996 Markus Armbruster - * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE. - */ - -/** - * @file array.h Dynamic and flexible arrays for C. - */ - -#ifndef _ARRAY_H -#define _ARRAY_H - -#include -#include - -#include "fourcc.h" -#include "align.h" -#include "obst.h" -#include "xmalloc.h" - -#define ARR_D_MAGIC FOURCC('A','R','R','D') -#define ARR_A_MAGIC FOURCC('A','R','R','A') -#define ARR_F_MAGIC FOURCC('A','R','R','F') - -/** - * Creates a flexible array. - * - * @param type The element type of the new array. - * @param nelts a size_t expression evaluating to the number of elements - * - * This macro creates a flexible array of a given type at runtime. - * The size of the array can be changed later. - * - * @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) \ - ((type *)_new_arr_f ((nelts), sizeof(type) * (nelts))) - -/** - * Creates a new flxible array with the same number of elements as a - * given one. - * - * @param type The element type of the new array. - * @param arr An array from which the number of elements will be taken - * - * This macro creates a flexible array of a given type at runtime. - * The size of the array can be changed later. - * - * @return A pointer to the flexible array (can be used as a pointer to the - * first element of this array). - */ -#ifdef __GNUC__ -#define CLONE_ARR_F(type, arr) \ - NEW_ARR_F (__typeof__(arr[0]), ARR_LEN ((arr))) -#else -#define CLONE_ARR_F(type, arr) \ - NEW_ARR_F (type, ARR_LEN ((arr))) -#endif - -/** - * Duplicates an array and returns the new flexible one. - * - * @param type The element type of the new array. - * @param arr An array from which the elements will be duplicated - * - * This macro creates a flexible array of a given type at runtime. - * The size of the array can be changed later. - * - * @return A pointer to the flexible array (can be used as a pointer to the - * first element of this array). - */ -#ifdef __GNUC__ -#define DUP_ARR_F(type, arr) \ - memcpy (CLONE_ARR_F (__typeof__(arr[0]), (arr)), (arr), sizeof(__typeof__(arr[0])) * ARR_LEN((arr))) -#else -#define DUP_ARR_F(type, arr) \ - memcpy (CLONE_ARR_F (type, (arr)), (arr), sizeof(type) * ARR_LEN((arr))) -#endif - -/** - * Delete a flexible array. - * - * @param arr The flexible array. - */ -#define DEL_ARR_F(arr) (_del_arr_f ((arr))) - -/** - * Creates a dynamic array on an obstack. - * - * @param type The element type of the new array. - * @param obstack A struct obstack * were the data will be allocated - * @param nelts A size_t expression evaluating to the number of elements - * - * This macro creates a dynamic array of a given type at runtime. - * The size of the array cannot be changed later. - * - * @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 *)_new_arr_d((obstack), (nelts), sizeof(type) * (nelts)) \ - : (type *)arr_mt_descr.v.elts) - -/** - * Creates a new dynamic array with the same number of elements as a - * given one. - * - * @param type The element type of the new array. - * @param obstack An struct obstack * were the data will be allocated - * @param arr An array from which the number of elements will be taken - * - * This macro creates a dynamic array of a given type at runtime. - * The size of the array cannot be changed later. - * - * @return A pointer to the dynamic array (can be used as a pointer to the - * first element of this array). - */ -#ifdef __GNUC__ -#define CLONE_ARR_D(type, obstack, arr) \ - NEW_ARR_D(__typeof__(arr[0]), (obstack), ARR_LEN((arr))) -#else -#define CLONE_ARR_D(type, obstack, arr) \ - NEW_ARR_D(type, (obstack), ARR_LEN((arr))) -#endif - -/** - * Duplicates an array and returns the new dynamic one. - * - * @param type The element type of the new array. - * @param obstack An struct obstack * were the data will be allocated - * @param arr An array from which the elements will be duplicated - * - * This macro creates a dynamic array of a given type at runtime. - * The size of the array cannot be changed later. - * - * @return A pointer to the dynamic array (can be used as a pointer to the - * first element of this array). - */ -#ifdef __GNUC__ -#define DUP_ARR_D(type, obstack, arr) \ - memcpy(CLONE_ARR_D(__typeof__(arr[0]), (obstack), (arr)), (arr), sizeof(__typeof__(arr[0])) * ARR_LEN((arr))) -#else -#define DUP_ARR_D(type, obstack, arr) \ - memcpy(CLONE_ARR_D(type, (obstack), (arr)), (arr), sizeof(type) * ARR_LEN((arr))) -#endif - -/** - * Create an automatic array which will be deleted at return from function. - * Beware, the data will be allocated on the function stack! - * - * @param type The element type of the new array. - * @param var A lvalue of type (type *) which will hold the new array. - * @param n number of elements in this array. - * - * This macro creates a dynamic array on the functions stack of a given type at runtime. - * The size of the array cannot be changed later. - */ -#define NEW_ARR_A(type, var, n) \ - do { \ - int _nelts = (n); \ - assert (_nelts >= 0); \ - (var) = (void *)((_arr_descr *)alloca (_ARR_ELTS_OFFS + sizeof(type) * _nelts))->v.elts; \ - _ARR_SET_DBGINF (_ARR_DESCR ((var)), ARR_A_MAGIC, sizeof (type)); \ - (void)(_ARR_DESCR ((var))->nelts = _nelts); \ - } while (0) - -/** - * Creates a new automatic array with the same number of elements as a - * given one. - * - * @param type The element type of the array. - * @param var A lvalue of type (type *) which will hold the new array. - * @param arr An array from which the elements will be duplicated - * - * This macro creates a dynamic array of a given type at runtime. - * The size of the array cannot be changed later. - * - * @return A pointer to the dynamic array (can be used as a pointer to the - * first element of this array). - */ -#ifdef __GNUC__ -#define CLONE_ARR_A(type, var, arr) \ - NEW_ARR_A(__typeof__(arr[0]), (var), ARR_LEN((arr))) -#else -#define CLONE_ARR_A(type, var, arr) \ - NEW_ARR_A(type, (var), ARR_LEN((arr))) -#endif - -/** - * Duplicates an array and returns a new automatic one. - * - * @param type The element type of the new array. - * @param var A lvalue of type (type *) which will hold the new array. - * @param arr An array from with the number of elements will be taken - * - * This macro creates a dynamic array of a given type at runtime. - * The size of the array cannot be changed later. - * - * @return A pointer to the dynamic array (can be used as a pointer to the - * first element of this array). - */ -#ifdef __GNUC__ -#define DUP_ARR_A(type, var, arr) \ - do { CLONE_ARR_A(__typeof__(arr[0]), (var), (arr)); \ - memcpy((var), (arr), sizeof(__typeof__(arr[0])) * ARR_LEN((arr))); } \ - while (0) -#else -#define DUP_ARR_A(type, var, arr) \ - do { CLONE_ARR_A(type, (var), (arr)); \ - memcpy((var), (arr), sizeof(type) * ARR_LEN((arr))); } \ - while (0) -#endif - -/** - * Declare an initialized (zero'ed) array of fixed size. - * This macro should be used at file scope only. - * - * @param type The element type of the new array. - * @param var A lvalue of type (type *) which will hold the new array. - * @param _nelts Number of elements in this new array. - */ -#define DECL_ARR_S(type, var, _nelts) \ - ARR_STRUCT(type, (_nelts) ? (_nelts) : 1) _##var; \ - type *var = (_ARR_SET_DBGINF (&_##var, ARR_A_MAGIC, sizeof (type)), \ - _##var.nelts = _nelts, \ - _##var.v.elts) - -/** - * Returns the length of an array - * - * @param arr a flexible, dynamic, automatic or static array. - */ -#define ARR_LEN(arr) (ARR_VRFY ((arr)), _ARR_DESCR((arr))->nelts) - -/** - * Resize a flexible array, allocate more data if needed but do NOT - * reduce. - * - * @param type The element type of the array. - * @param arr The array, which must be an lvalue. - * @param n The new size of the array. - * - * @remark This macro may change arr, so update all references! - */ -#ifdef __GNUC__ -#define ARR_RESIZE(type, arr, n) \ - ((arr) = _arr_resize((arr), (n), sizeof(__typeof__(arr[0])))) -#else -#define ARR_RESIZE(type, arr, n) \ - ((arr) = _arr_resize((arr), (n), sizeof(type))) -#endif - -/** - * Resize a flexible array, always reallocate data. - * - * @param type The element type of the array. - * @param arr The array, which must be an lvalue. - * @param n The new size of the array. - * - * @remark This macro may change arr, so update all references! - */ -#ifdef __GNUC__ -#define ARR_SETLEN(type, arr, n) \ - ((arr) = _arr_setlen ((arr), (n), sizeof(__typeof__(arr[0])) * (n))) -#else -#define ARR_SETLEN(type, arr, n) \ - ((arr) = _arr_setlen ((arr), (n), sizeof(type) * (n))) -#endif - -/** 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. - * - * @param type The element type of the array. - * @param arr The array, which must be an lvalue. - * @param delta The delta number of elements. - * - * @remark This macro may change arr, so update all references! - */ -#define ARR_EXTEND(type, arr, delta) \ - ARR_RESIZE(type, (arr), ARR_LEN((arr)) + (delta)) - -/** - * Resize a flexible array to hold n elements only if it is currently shorter - * than n. - * - * @param type The element type of the array. - * @param arr The array, which must be an lvalue. - * @param n The new size of the array. - * - * @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)) - -/** - * Append one element to a flexible array. - * - * @param type The element type of the 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) \ - (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 -# define ARR_VRFY(arr) \ - assert ( ( (_ARR_DESCR((arr))->magic == ARR_D_MAGIC) \ - || (_ARR_DESCR((arr))->magic == ARR_A_MAGIC) \ - || (_ARR_DESCR((arr))->magic == ARR_F_MAGIC)) \ - && ( (_ARR_DESCR((arr))->magic != ARR_F_MAGIC) \ - || (_ARR_DESCR((arr))->u.allocated >= _ARR_DESCR((arr))->nelts)) \ - && (_ARR_DESCR((arr))->nelts >= 0)) -# define ARR_IDX_VRFY(arr, idx) \ - assert ((0 <= (idx)) && ((idx) < ARR_LEN ((arr)))) -#endif - - -/* Private !!! - Don't try this at home, kids, we're trained professionals ;-> - ... or at the IPD, either. */ -#ifdef NDEBUG -# define _ARR_DBGINF_DECL -# define _ARR_SET_DBGINF(descr, co, es) -#else -# define _ARR_DBGINF_DECL int magic; size_t eltsize; -# define _ARR_SET_DBGINF(descr, co, es) \ - ( (descr)->magic = (co), (descr)->eltsize = (es) ) -#endif - -/** - * Construct an array header. - */ -#define ARR_STRUCT(type, _nelts) \ - struct { \ - _ARR_DBGINF_DECL \ - union { \ - struct obstack *obstack; /* dynamic: allocated on this obstack */ \ - int allocated; /* flexible: #slots allocated */ \ - } u; \ - int nelts; \ - union { \ - type elts[(_nelts)]; \ - aligned_type align[1]; \ - } v; \ - } - -/** - * The array descriptor header type. - */ -typedef ARR_STRUCT (aligned_type, 1) _arr_descr; - -extern _arr_descr arr_mt_descr; - -void *_new_arr_f (int, size_t); -void _del_arr_f (void *); -void *_new_arr_d (struct obstack *obstack, int nelts, size_t elts_size); -void *_arr_resize (void *, int, size_t); -void *_arr_setlen (void *, int, size_t); - -#define _ARR_ELTS_OFFS offsetof (_arr_descr, v.elts) -#define _ARR_DESCR(elts) ((_arr_descr *)(void *)((char *)(elts) - _ARR_ELTS_OFFS)) - -#endif +#include