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

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