summaryrefslogtreecommitdiffstats
path: root/libdimension/dimension/array.h
blob: afd5e16dae65baa66c3ff68705633e3cff927d0d (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
/*************************************************************************
 * Copyright (C) 2010 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/>.                                       *
 *************************************************************************/

/*
 * Simple generalized arrays, for returning variable-length arrays from
 * functions, and other fun stuff.  All functions are inline for performance
 * reasons.
 */

#ifndef DIMENSION_ARRAY_H
#define DIMENSION_ARRAY_H

#include <stdlib.h> /* For size_t */
#include <string.h> /* For memcpy */

typedef struct {
  void *ptr;
  size_t obj_size, length, capacity;
} dmnsn_array;

/* Delete an array */
DMNSN_INLINE void
dmnsn_delete_array(dmnsn_array *array)
{
  if (array) {
    free(array->ptr);
    free(array);
  }
}

/* Array allocation */
DMNSN_INLINE dmnsn_array *
dmnsn_new_array(size_t obj_size)
{
  dmnsn_array *array = (dmnsn_array *)dmnsn_malloc(sizeof(dmnsn_array));
  array->obj_size = obj_size;
  array->length   = 0;
  array->capacity = 4; /* Start with capacity of 4 */

  /* Allocate the memory */
  array->ptr = dmnsn_malloc(array->capacity*array->obj_size);

  return array;
}

/* Get the size of the array */
DMNSN_INLINE size_t
dmnsn_array_size(const dmnsn_array *array)
{
  return array->length;
}

/* Set the size of the array */
DMNSN_INLINE void
dmnsn_array_resize(dmnsn_array *array, size_t length)
{
  if (length > array->capacity) {
    /* Resize if we don't have enough capacity */
    array->capacity = length*2; /* We are greedy */
    array->ptr = dmnsn_realloc(array->ptr, array->obj_size*array->capacity);
  }

  array->length = length;
}

/* Get the i'th object, bailing out if i is out of range */
DMNSN_INLINE void
dmnsn_array_get(const dmnsn_array *array, size_t i, void *obj)
{
  dmnsn_assert(i < dmnsn_array_size(array), "Array index out of bounds.");
  memcpy(obj, (char *)array->ptr + array->obj_size*i, array->obj_size);
}


/* Set the i'th object, expanding the array if necessary */
DMNSN_INLINE void
dmnsn_array_set(dmnsn_array *array, size_t i, const void *obj)
{
  if (i >= dmnsn_array_size(array)) {
    /* Resize if i is out of range */
    dmnsn_array_resize(array, i + 1);
  }
  memcpy((char *)array->ptr + array->obj_size*i, obj, array->obj_size);
}

/* First element */
DMNSN_INLINE void *
dmnsn_array_first(const dmnsn_array *array)
{
  return array->ptr;
}

/* Last element */
DMNSN_INLINE void *
dmnsn_array_last(const dmnsn_array *array)
{
  return (char *)array->ptr + array->obj_size*(array->length - 1);
}

/* Arbitrary element access */
DMNSN_INLINE void *
dmnsn_array_at(const dmnsn_array *array, size_t i)
{
  dmnsn_assert(i < dmnsn_array_size(array), "Array index out of bounds.");
  return (char *)array->ptr + array->obj_size*i;
}

/* Push obj to the end of the array */
DMNSN_INLINE void
dmnsn_array_push(dmnsn_array *array, const void *obj)
{
  dmnsn_array_set(array, dmnsn_array_size(array), obj);
}

/* Pop obj from the end of the array */
DMNSN_INLINE void
dmnsn_array_pop(dmnsn_array *array, void *obj)
{
  size_t size = dmnsn_array_size(array);
  dmnsn_assert(size > 0, "Array is empty.");
  dmnsn_array_get(array, size - 1, obj); /* Copy the object */
  dmnsn_array_resize(array, size - 1);   /* Shrink the array */
}

/* Insert an item into the middle of the array */
DMNSN_INLINE void
dmnsn_array_insert(dmnsn_array *array, size_t i, const void *obj)
{
  size_t size = dmnsn_array_size(array) + 1;
  if (i >= size)
    size = i + 1;
  dmnsn_array_resize(array, size);

  /* Move the elements at and after `i' 1 to the right */
  memmove((char *)array->ptr + array->obj_size*(i + 1),
          (char *)array->ptr + array->obj_size*i,
          array->obj_size*(size - i - 1));
  /* Insert `obj' at `i' */
  memcpy((char *)array->ptr + array->obj_size*i, obj, array->obj_size);
}

/* Remove an item from the middle of the array */
DMNSN_INLINE void
dmnsn_array_remove(dmnsn_array *array, size_t i)
{
  size_t size = dmnsn_array_size(array);
  dmnsn_assert(i < size, "Array index out of bounds.");
  /* Move the array elements after `i' 1 to the left */
  memmove((char *)array->ptr + array->obj_size*i,
          (char *)array->ptr + array->obj_size*(i + 1),
          array->obj_size*(size - i - 1));
  /* Decrease the size by 1 */
  dmnsn_array_resize(array, size - 1);
}

/* Macro to shorten array iteration */
#define DMNSN_ARRAY_FOREACH(type, i, array)     \
  for (type i = dmnsn_array_first(array);       \
       i <= (type)dmnsn_array_last(array);      \
       ++i)

#endif /* DIMENSION_ARRAY_H */