libfirm/adt/array.h

Go to the documentation of this file.

/*
 * 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.
 */

#ifndef FIRM_ADT_ARRAY_H
#define FIRM_ADT_ARRAY_H

#include <assert.h>
#include <stddef.h>

#include "obst.h"

#include "../begin.h"

#define NEW_ARR_F(type, nelts) \
  ((type *)ir_new_arr_f((nelts), sizeof(type) * (nelts)))

#define CLONE_ARR_F(type, arr) \
  NEW_ARR_F(type, ARR_LEN((arr)))

#define DUP_ARR_F(type, arr) \
  ((type*) memcpy(CLONE_ARR_F(type, (arr)), (arr), sizeof(type) * ARR_LEN((arr))))

#define DEL_ARR_F(arr) (ir_del_arr_f((void *)(arr)))

#define NEW_ARR_D(type, obstack, nelts)                                 \
  (  nelts                                                              \
   ? (type *)ir_new_arr_d((obstack), (nelts), sizeof(type) * (nelts))   \
   : (type *)arr_mt_descr.elts)

#define CLONE_ARR_D(type, obstack, arr) \
  NEW_ARR_D(type, (obstack), ARR_LEN((arr)))

#define DUP_ARR_D(type, obstack, arr) \
  ((type*)memcpy(CLONE_ARR_D(type, (obstack), (arr)), (arr), sizeof(type) * ARR_LEN ((arr))))

#define ARR_LEN(arr) (ARR_VRFY((arr)), ARR_DESCR((arr))->nelts)

#define ARR_RESIZE(type, arr, n) \
  ((arr) = (type*) ir_arr_resize((void *)(arr), (n), sizeof(type)))

#define ARR_SETLEN(type, arr, n) \
  ((arr) = (type*) ir_arr_setlen((void *)(arr), (n), sizeof(type) * (n)))

#define ARR_EXTEND(type, arr, delta) \
  ARR_RESIZE(type, (arr), ARR_LEN((arr)) + (delta))

#define ARR_EXTO(type, arr, n) \
    do { \
        if ((n) >= ARR_LEN(arr)) { ARR_RESIZE(type, arr, (n)+1); } \
    } while(0)

#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)          ir_verify_arr(arr)

# define ARR_IDX_VRFY(arr, idx) \
    assert((0 <= (idx)) && ((idx) < ARR_LEN((arr))))
#endif

typedef union {
  long double d;
  void *p;
  long l;
} aligned_type;

typedef struct {
    int magic;                    
    size_t eltsize;               
    union {
        struct obstack *obstack;  
        size_t allocated;         
    } u;
    size_t nelts;                 
    aligned_type elts[1];         
} ir_arr_descr;

extern ir_arr_descr arr_mt_descr;

FIRM_API void *ir_new_arr_f(size_t nelts, size_t elts_size);
FIRM_API void ir_del_arr_f(void *elts);
FIRM_API void *ir_new_arr_d(struct obstack *obstack, size_t nelts, size_t elts_size);
FIRM_API void *ir_arr_resize(void *elts, size_t nelts, size_t elts_size);
FIRM_API void *ir_arr_setlen(void *elts, size_t nelts, size_t elts_size);
FIRM_API void ir_verify_arr(const void *elts);

#define ARR_ELTS_OFFS offsetof(ir_arr_descr, elts)
#define ARR_DESCR(elts) ((ir_arr_descr *)(void *)((char *)(elts) - ARR_ELTS_OFFS))

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;
}

#include "../end.h"

#endif