nsz Git - libfirm/blob - ir/adt/array.h

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/adt/array.h
   4  * Purpose:     Declarations for Array.
   5  * Author:      Markus Armbruster
   6  * Modified by:
   7  * Created:     1999 by getting from fiasco
   8  * CVS-ID:      $Id$
   9  * Copyright:   (c) 1995, 1996 Markus Armbruster
  10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  11  */
  12
  13 /* @@@ growing a dynamic on an obstack */
  14
  15 #ifndef _ARRAY_H
  16 #define _ARRAY_H
  17
  18 #include <assert.h>
  19 #include <stddef.h>
  20 #include <obstack.h>
  21 #include "cookies.h"
  22 #include "misc.h"
  23
  24
  25 /* Flexible create / delete */
  26 #define NEW_ARR_F(type, nelts)                                          \
  27   (XMALLOC_TRACE (type *)_new_arr_f ((nelts), sizeof(type) * (nelts)))
  28 #define CLONE_ARR_F(type, arr)                  \
  29   NEW_ARR_F (type, ARR_LEN ((arr)))
  30 #define DUP_ARR_F(type, arr)                                                    \
  31   memcpy (CLONE_ARR_F (type, (arr)), (arr), sizeof(type) * ARR_LEN((arr)))
  32 #define DEL_ARR_F(arr) (XMALLOC_TRACE _del_arr_f ((arr)))
  33
  34 /* Dynamic create on obstacks */
  35 #define NEW_ARR_D(type, obstack, nelts)                                 \
  36   (  nelts                                                              \
  37    ? (type *)_new_arr_d ((obstack), (nelts), sizeof(type) * (nelts))    \
  38    : (type *)arr_mt_descr.v.elts)
  39 #define CLONE_ARR_D(type, obstack, arr)         \
  40   NEW_ARR_D (type, (obstack), ARR_LEN ((arr)))
  41 #define DUP_ARR_D(type, obstack, arr)                                                   \
  42   memcpy (CLONE_ARR_D (type, (obstack), (arr)), (arr), sizeof(type) * ARR_LEN ((arr)))
  43
  44 /* Automatic create; delete is automatic at return from function */
  45 /* Quick'n'dirty! */
  46 #define NEW_ARR_A(type, var, n)                                                                 \
  47   do {                                                                                          \
  48     int _nelts = (n);                                                                           \
  49     assert (_nelts >= 0);                                                                       \
  50     (var) = (void *)((_arr_descr *)alloca (_ARR_ELTS_OFFS + sizeof(type) * _nelts))->v.elts;    \
  51     _ARR_SET_DBGINF (_ARR_DESCR ((var)), ARR_A_MAGIC, sizeof (type));                           \
  52     (void)(_ARR_DESCR ((var))->nelts = _nelts);                                                 \
  53   } while (0)
  54 #define CLONE_ARR_A(type, var, arr)             \
  55   NEW_ARR_A (type, (var), ARR_LEN ((arr)))
  56
  57 #define DUP_ARR_A(type, var, arr)                                       \
  58   do { CLONE_ARR_A(type, (var), (arr));                                 \
  59        memcpy ((var), (arr), sizeof (type) * ARR_LEN ((arr))); }        \
  60   while (0)
  61
  62 /* Declare an initialized array of fixed size */
  63 #define DECL_ARR_S(type, var, _nelts)                                   \
  64   ARR_STRUCT(type, (_nelts) ? (_nelts) : 1) _##var;                     \
  65   type *var = (_ARR_SET_DBGINF (&_##var, ARR_A_MAGIC, sizeof (type)),   \
  66                _##var.nelts = _nelts,                                   \
  67                _##var.v.elts)
  68
  69 /* Length */
  70 #define ARR_LEN(arr) (ARR_VRFY ((arr)), _ARR_DESCR((arr))->nelts)
  71
  72 /* Resize
  73    Applicable to flexibles only, change arr which must be an lvalue.  */
  74 /* resize arr to hold n elts */
  75 #define ARR_RESIZE(type, arr, n)                                        \
  76   (XMALLOC_TRACE (arr) = _arr_resize ((arr), (n), sizeof(type)))
  77 /* resize arr to hold exactly n elts */
  78 #define ARR_SETLEN(type, arr, n)                                        \
  79   (XMALLOC_TRACE (arr) = _arr_setlen ((arr), (n), sizeof(type) * (n)))
  80 /* resize arr by delta elts */
  81 #define ARR_EXTEND(type, arr, delta)                    \
  82   ARR_RESIZE (type, (arr), ARR_LEN ((arr)) + (delta))
  83 /* resize arr to hold n elts only if it is currently shorter */
  84 #define ARR_EXTO(type, arr, n)                                          \
  85   ((n) >= ARR_LEN ((arr)) ? ARR_RESIZE (type, (arr), (n)+1) : (arr))
  86 /* append one elt to arr */
  87 #define ARR_APP1(type, arr, elt)                                        \
  88   (ARR_EXTEND (type, (arr), 1), (arr)[ARR_LEN ((arr))-1] = (elt))
  89
  90
  91 #ifdef NDEBUG
  92 # define ARR_VRFY(arr) ((void)0)
  93 # define ARR_IDX_VRFY(arr, idx) ((void)0)
  94 #else
  95 # define ARR_VRFY(arr)                                                                  \
  96     assert (   (   (_ARR_DESCR((arr))->cookie == ARR_D_MAGIC)                           \
  97                 || (_ARR_DESCR((arr))->cookie == ARR_A_MAGIC)                           \
  98                 || (_ARR_DESCR((arr))->cookie == ARR_F_MAGIC))                          \
  99             && (   (_ARR_DESCR((arr))->cookie != ARR_F_MAGIC)                           \
 100                 || (_ARR_DESCR((arr))->u.allocated >= _ARR_DESCR((arr))->nelts))        \
 101             && (_ARR_DESCR((arr))->nelts >= 0))
 102 # define ARR_IDX_VRFY(arr, idx)                         \
 103     assert ((0 <= (idx)) && ((idx) < ARR_LEN ((arr))))
 104 #endif
 105
 106
 107 /* Private !!!
 108    Don't try this at home, kids, we're trained professionals ;->
 109    ... or at the IPD, either. */
 110 #ifdef NDEBUG
 111 # define _ARR_DBGINF_DECL
 112 # define _ARR_SET_DBGINF(descr, co, es) ((co), (es))
 113 #else
 114 # define _ARR_DBGINF_DECL int cookie; size_t eltsize;
 115 # define _ARR_SET_DBGINF(descr, co, es)                                 \
 116     ((descr)->cookie = (co), (descr)->eltsize = (es))
 117 #endif
 118
 119 #define ARR_STRUCT(type, _nelts)                                                \
 120   struct {                                                                      \
 121     _ARR_DBGINF_DECL                                                            \
 122     union {                                                                     \
 123       struct obstack *obstack;  /* dynamic: allocated on this obstack */        \
 124       int allocated;                    /* flexible: #slots allocated */        \
 125     } u;                                                                        \
 126     int nelts;                                                                  \
 127     union {                                                                     \
 128       type elts[(_nelts)];                                                      \
 129       aligned_type align[1];                                                    \
 130     } v;                                                                        \
 131   }
 132
 133 typedef ARR_STRUCT (aligned_type, 1) _arr_descr;
 134
 135 extern _arr_descr arr_mt_descr;
 136
 137 void *_new_arr_f (int, size_t);
 138 void _del_arr_f (void *);
 139 void *_new_arr_d (struct obstack *, int, size_t);
 140 void *_arr_resize (void *, int, size_t);
 141 void *_arr_setlen (void *, int, size_t);
 142
 143 #define _ARR_ELTS_OFFS offsetof (_arr_descr, v.elts)
 144 #define _ARR_DESCR(elts) ((_arr_descr *)(void *)((char *)(elts) - _ARR_ELTS_OFFS))
 145
 146 #endif