crawl-ref/source/fixedvector.h

   1 /*
   2  *  File:       fixedvector.h
   3  *  Summary:    Fixed size vector class that asserts if you do something bad.
   4  *  Written by: Jesse Jones
   5  */
   6
   7 #ifndef FIXVEC_H
   8 #define FIXVEC_H
   9
  10 #include <cstdarg>
  11 #include <cstring>
  12
  13 #include "debug.h"
  14 // ==========================================================================
  15 //    class FixedVector
  16 // ==========================================================================
  17
  18 template <class TYPE, int SIZE> class FixedVector
  19 {
  20
  21 //-----------------------------------
  22 //    Types
  23 //
  24 public:
  25     typedef TYPE            value_type;
  26     typedef TYPE&           reference;
  27     typedef const TYPE&     const_reference;
  28     typedef TYPE*           pointer;
  29     typedef const TYPE*     const_pointer;
  30
  31     typedef unsigned long   size_type;
  32     typedef long            difference_type;
  33
  34     typedef TYPE*           iterator;
  35     typedef const TYPE*     const_iterator;
  36
  37 //-----------------------------------
  38 //    Initialization/Destruction
  39 //
  40 public:
  41     ~FixedVector()                           {}
  42
  43     FixedVector()                            {}
  44
  45     FixedVector(TYPE def) : mData()
  46     {
  47         init(def);
  48     }
  49
  50     FixedVector(TYPE value0, TYPE value1, ...);
  51     // Allows for something resembling C array initialization, eg
  52     // instead of "int a[3] = {0, 1, 2}" you'd use "FixedVector<int, 3>
  53     // a(0, 1, 2)". Note that there must be SIZE arguments.
  54
  55 //-----------------------------------
  56 //    API
  57 //
  58 public:
  59     // ----- Size -----
  60     bool empty() const { return SIZE == 0; }
  61     size_t size() const { return SIZE; }
  62
  63     // ----- Access -----
  64     TYPE& operator[](unsigned long index)
  65     {
  66 #ifdef ASSERTS
  67         if (index >= SIZE)
  68         {
  69             // Intentionally printed as signed, it's very, very unlikely we'd
  70             // have a genuine big number here, but underflows are common.
  71             die("FixedVector out of bounds (%ld / %ld)", (signed long)index,
  72                 SIZE);
  73         }
  74 #endif
  75         return mData[index];
  76     }
  77
  78     const TYPE& operator[](unsigned long index) const
  79     {
  80 #ifdef ASSERTS
  81         if (index >= SIZE)
  82         {
  83             die("FixedVector out of bounds (%ld / %ld)", (signed long)index,
  84                 SIZE);
  85         }
  86 #endif
  87         return mData[index];
  88     }
  89
  90     const TYPE* buffer() const { return mData; }
  91     TYPE* buffer() { return mData; }
  92
  93     // ----- Iterating -----
  94     iterator begin() { return mData; }
  95     const_iterator begin() const { return mData; }
  96
  97     iterator end() { return this->begin() + this->size(); }
  98     const_iterator end() const { return this->begin() + this->size(); }
  99     void init(const TYPE& def);
 100
 101 //-----------------------------------
 102 //    Member Data
 103 //
 104 protected:
 105     TYPE    mData[SIZE];
 106 };
 107
 108
 109 // ==========================================================================
 110 //    Outlined Methods
 111 // ==========================================================================
 112 template <class TYPE, int SIZE>
 113 FixedVector<TYPE, SIZE>::FixedVector(TYPE value0, TYPE value1, ...)
 114 {
 115     mData[0] = value0;
 116     mData[1] = value1;
 117
 118     va_list ap;
 119     va_start(ap, value1);   // second argument is last fixed parameter
 120
 121     for (int index = 2; index < SIZE; index++)
 122     {
 123         TYPE value = va_arg(ap, TYPE);
 124         mData[index] = value;
 125     }
 126
 127     va_end(ap);
 128 }
 129
 130 template <class TYPE, int SIZE>
 131 void FixedVector<TYPE, SIZE>::init(const TYPE& def)
 132 {
 133     for (int i = 0; i < SIZE; ++i)
 134         mData[i] = def;
 135 }
 136
 137 #endif    // FIXVEC_H