summaryrefslogtreecommitdiffstats
path: root/libdimensionxx/dimensionxx/array.hpp
blob: aa1f8058f53c3e8f9d3d3f4eab16901acb1f8608 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
/*************************************************************************
 * Copyright (C) 2009 Tavian Barnes <tavianator@gmail.com>               *
 *                                                                       *
 * This file is part of The Dimension Library.                           *
 *                                                                       *
 * The Dimension Library is free software; you can redistribute it and/  *
 * or modify it under the terms of the GNU Lesser General Public License *
 * as published by the Free Software Foundation; either version 3 of the *
 * License, or (at your option) any later version.                       *
 *                                                                       *
 * The Dimension Library 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  *
 * Lesser General Public License for more details.                       *
 *                                                                       *
 * You should have received a copy of the GNU Lesser General Public      *
 * License along with this program.  If not, see                         *
 * <http://www.gnu.org/licenses/>.                                       *
 *************************************************************************/

// dmnsn_array* wrapper.

#ifndef DIMENSIONXX_ARRAY_HPP
#define DIMENSIONXX_ARRAY_HPP

#include <tr1/memory> // For tr1::shared_ptr
#include <cstdlib>    // For size_t
#include <vector>

namespace Dimension
{
  // Class to store POD types, and wrapped dmnsn_* types, including polymorphic
  // types.  The non-specialized version will only handle POD types; specialize
  // it to allow storage of classes in Array's.
  template <typename T>
  class Array_Element
  {
  public:
    typedef T C_Type;

    inline Array_Element();
    inline Array_Element(T t);

    // Specializations should implement this constructor if C_Type differs from
    // T - but it should throw if T is a polymorphic type
    // Array_Element(C_Type c);

    // Array_Element(const Array_Element& ae);
    // ~Array_Element();

    // Array_Element& operator=(const Array_Element& ae);

    C_Type dmnsn() const { return m_t; }
    T& object(C_Type* c) const { return *c; }

  private:
    T m_t;
  };

  // Array template class, wraps a dmnsn_array*.  Copying is possible, but
  // copies refer to the same object, which is reference counted.  T must be
  // a POD type.
  template <typename T>
  class Array
  {
  public:
    inline Array();
    explicit inline Array(dmnsn_array* array);
    // Array(const Array& a);
    ~Array()
      { if (m_array && m_array.unique()) { dmnsn_delete_array(dmnsn()); } }

    // Array& operator=(const Array& a);

    inline T&       operator[](std::size_t i);
    inline const T& operator[](std::size_t i) const;

    std::size_t size() const { return dmnsn_array_size(dmnsn()); }
    inline void resize(std::size_t size);

    inline void push(T& object);
    inline void push(const T& object); // Not valid for polymorphic types
    inline void pop();

    // Access the wrapped C object.
    inline dmnsn_array*       dmnsn();
    inline const dmnsn_array* dmnsn() const;

    // Release ownership of the dmnsn_array*, needed for returning a
    // dmnsn_array* from a function.
    inline dmnsn_array* release();

  private:
    typedef typename Array_Element<T>::C_Type C_Type;

    std::tr1::shared_ptr<dmnsn_array*> m_array;
    std::vector<Array_Element<T> > m_elements;
  };

  // Base class for non-polymorphic wrappers
  template <typename T, typename C>
  class DMNSN_Array_Element
  {
  public:
    typedef C C_Type;

    DMNSN_Array_Element() {
      throw Dimension_Error("Couldn't default-construct an array element.");
    }

    DMNSN_Array_Element(const T& object) : m_object(new T(object)) { }
    DMNSN_Array_Element(C_Type c) : m_object(new T(c)) { }
    // DMNSN_Array_Element(const DMNSN_Array_Element& ae);
    // ~DMNSN_Array_Element();

    // DMNSN_Array_Element& operator=(const DMNSN_Array_Element& ae);

    C_Type dmnsn() const { return m_object->dmnsn(); }
    T& object(C_Type* c) const { return *m_object; }

  private:
    std::tr1::shared_ptr<T> m_object;
  };

  // Base class for polymorphic wrappers
  template <typename T, typename C>
  class Polymorphic_Array_Element
  {
  public:
    typedef C C_Type;

    Polymorphic_Array_Element()
    {
      throw Dimension_Error("Cannot default-construct a polymorphic array"
                            " object.");
    }

    Polymorphic_Array_Element(T& object) : m_object(object.copy()) { }

    Polymorphic_Array_Element(C_Type c)
    {
      throw Dimension_Error("Cannot wrap existing dmnsn_array* elements in"
                            " polymorphic class.");
    }

    // Polymorphic_Array_Element(const Polymorphic_Array_Element& ae);
    // ~Polymorphic_Array_Element();

    // Polymorphic_Array_Element& operator=(const Polymorphic_Array_Element& e);

    C_Type dmnsn() const { return m_object->dmnsn(); }
    T& object(C_Type* c) const { return *m_object; }

  private:
    std::tr1::shared_ptr<T> m_object;
  };

  // A constraint enforcing that T is a POD type by making it part of a union.
  // Taking the address of this function will cause a compile-time failure if
  // T is not a POD type.
  template <typename T>
  void
  POD_constraint()
  {
    union
    {
      T t;
    } constraint;
    static_cast<void>(constraint); // Silence unused variable warning
  }

  // Array_Element

  template <typename T>
  inline
  Array_Element<T>::Array_Element()
  {
    void (*constraint)() = &POD_constraint<T>;
    static_cast<void>(constraint); // Silence unused variable warning
  }

  template <typename T>
  inline
  Array_Element<T>::Array_Element(T t)
    : m_t(t)
  {
    void (*constraint)() = &POD_constraint<T>;
    static_cast<void>(constraint); // Silence unused variable warning
  }

  // Array constructors

  template <typename T>
  inline
  Array<T>::Array()
    : m_array(new dmnsn_array*(dmnsn_new_array(sizeof(T)))) { }

  template <typename T>
  inline
  Array<T>::Array(dmnsn_array* array)
    : m_array(new dmnsn_array*(array))
  {
    m_elements.reserve(dmnsn_array_size(dmnsn()));
    for (std::size_t i = 0; i < dmnsn_array_size(dmnsn()); ++i) {
      C_Type* c = reinterpret_cast<C_Type*>(dmnsn_array_at(dmnsn(), i));
      m_elements.push_back(Array_Element<T>(*c));
    }
  }

  // Array element access

  template <typename T>
  inline T&
  Array<T>::operator[](std::size_t i)
  {
    if (i >= m_elements.size()) {
      m_elements.resize(i + 1);
    }
    C_Type* c = reinterpret_cast<C_Type*>(dmnsn_array_at(dmnsn(), i));
    return m_elements[i].object(c);
  }

  template <typename T>
  inline const T&
  Array<T>::operator[](std::size_t i) const
  {
    if (i >= m_elements.size()) {
      m_elements.resize(i + 1);
    }
    C_Type* c = reinterpret_cast<C_Type*>(dmnsn_array_at(dmnsn(), i));
    return m_elements[i].object(c);
  }

  template <typename T>
  inline void
  Array<T>::resize(std::size_t size)
  {
    m_elements.resize(size);
    dmnsn_array_resize(dmnsn(), size);
  }

  template <typename T>
  inline void
  Array<T>::push(T& object)
  {
    Array_Element<T> ae(object);
    m_elements.push_back(ae);

    C_Type c = ae.dmnsn();
    dmnsn_array_push(dmnsn(), &c);
  }

  template <typename T>
  inline void
  Array<T>::push(const T& object)
  {
    Array_Element<T> ae(object);
    m_elements.push_back(ae);

    C_Type c = ae.dmnsn();
    dmnsn_array_push(dmnsn(), &c);
  }

  template <typename T>
  inline void
  Array<T>::pop()
  {
    m_elements.pop();
    dmnsn_array_resize(dmnsn_array_size(dmnsn()) - 1);
  }

  // Access the underlying dmnsn_array*

  template <typename T>
  inline dmnsn_array*
  Array<T>::dmnsn()
  {
    if (!m_array) {
      throw Dimension_Error("Attempting to access released array.");
    }

    return *m_array;
  }

  template <typename T>
  inline const dmnsn_array*
  Array<T>::dmnsn() const
  {
    if (!m_array) {
      throw Dimension_Error("Attempting to access released array.");
    }

    return *m_array;
  }

  // Release the dmnsn_array*, if we are the only Array holding it
  template <typename T>
  inline dmnsn_array*
  Array<T>::release()
  {
    dmnsn_array* array = dmnsn();

    if (!m_array.unique()) {
      throw Dimension_Error("Attempting to release non-unique array.");
    } else {
      m_array.reset();
      return array;
    }
  }
}

#endif /* DIMENSIONXX_ARRAY_HPP */