kvec.h
Go to the documentation of this file.
1 // The MIT License
2 //
3 // Copyright (c) 2008, by Attractive Chaos <[email protected]>
4 //
5 // Permission is hereby granted, free of charge, to any person obtaining
6 // a copy of this software and associated documentation files (the
7 // "Software"), to deal in the Software without restriction, including
8 // without limitation the rights to use, copy, modify, merge, publish,
9 // distribute, sublicense, and/or sell copies of the Software, and to
10 // permit persons to whom the Software is furnished to do so, subject to
11 // the following conditions:
12 //
13 // The above copyright notice and this permission notice shall be
14 // included in all copies or substantial portions of the Software.
15 //
16 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
20 // BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21 // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 // CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 // SOFTWARE.
24 
25 // An example:
26 //
27 // #include "kvec.h"
28 // int main() {
29 // kvec_t(int) array = KV_INITIAL_VALUE;
30 // kv_push(array, 10); // append
31 // kv_a(array, 20) = 5; // dynamic
32 // kv_A(array, 20) = 4; // static
33 // kv_destroy(array);
34 // return 0;
35 // }
36 
37 #ifndef NVIM_LIB_KVEC_H
38 #define NVIM_LIB_KVEC_H
39 
40 #include <stdlib.h>
41 #include <string.h>
42 
43 #include "nvim/memory.h"
44 #include "nvim/os/os_defs.h"
45 
46 #define kv_roundup32(x) \
47  ((--(x)), \
48  ((x)|=(x)>>1, (x)|=(x)>>2, (x)|=(x)>>4, (x)|=(x)>>8, (x)|=(x)>>16), \
49  (++(x)))
50 
51 #define KV_INITIAL_VALUE { .size = 0, .capacity = 0, .items = NULL }
52 
53 #define kvec_t(type) \
54  struct { \
55  size_t size; \
56  size_t capacity; \
57  type *items; \
58  }
59 
60 #define kv_init(v) ((v).size = (v).capacity = 0, (v).items = 0)
61 #define kv_destroy(v) xfree((v).items)
62 #define kv_A(v, i) ((v).items[(i)])
63 #define kv_pop(v) ((v).items[--(v).size])
64 #define kv_size(v) ((v).size)
65 #define kv_max(v) ((v).capacity)
66 #define kv_Z(v, i) kv_A(v, kv_size(v) - (i) - 1)
67 #define kv_last(v) kv_Z(v, 0)
68 
75 #define kv_drop(v, n) ((v).size -= (n))
76 
77 #define kv_resize(v, s) \
78  ((v).capacity = (s), \
79  (v).items = xrealloc((v).items, sizeof((v).items[0]) * (v).capacity))
80 
81 #define kv_resize_full(v) \
82  kv_resize(v, (v).capacity ? (v).capacity << 1 : 8)
83 
84 #define kv_copy(v1, v0) \
85  do { \
86  if ((v1).capacity < (v0).size) { \
87  kv_resize(v1, (v0).size); \
88  } \
89  (v1).size = (v0).size; \
90  memcpy((v1).items, (v0).items, sizeof((v1).items[0]) * (v0).size); \
91  } while (0) \
92 
93 #define kv_pushp(v) \
94  ((((v).size == (v).capacity) ? (kv_resize_full(v), 0) : 0), \
95  ((v).items + ((v).size++)))
96 
97 #define kv_push(v, x) \
98  (*kv_pushp(v) = (x))
99 
100 #define kv_a(v, i) \
101  (*(((v).capacity <= (size_t) (i) \
102  ? ((v).capacity = (v).size = (i) + 1, \
103  kv_roundup32((v).capacity), \
104  kv_resize((v), (v).capacity), 0UL) \
105  : ((v).size <= (size_t) (i) \
106  ? (v).size = (i) + 1 \
107  : 0UL)), \
108  &(v).items[(i)]))
109 
118 #define kvec_withinit_t(type, INIT_SIZE) \
119  struct { \
120  size_t size; \
121  size_t capacity; \
122  type *items; \
123  type init_array[INIT_SIZE]; \
124  }
125 
129 #define kvi_init(v) \
130  ((v).capacity = ARRAY_SIZE((v).init_array), \
131  (v).size = 0, \
132  (v).items = (v).init_array)
133 
135 static inline void *_memcpy_free(void *const restrict dest,
136  void *const restrict src,
137  const size_t size)
139 {
140  memcpy(dest, src, size);
141  xfree(src);
142  return dest;
143 }
144 
145 // -V:kvi_push:512
146 
154 #define kvi_resize(v, s) \
155  ((v).capacity = ((s) > ARRAY_SIZE((v).init_array) \
156  ? (s) \
157  : ARRAY_SIZE((v).init_array)), \
158  (v).items = ((v).capacity == ARRAY_SIZE((v).init_array) \
159  ? ((v).items == (v).init_array \
160  ? (v).items \
161  : _memcpy_free((v).init_array, (v).items, \
162  (v).size * sizeof((v).items[0]))) \
163  : ((v).items == (v).init_array \
164  ? memcpy(xmalloc((v).capacity * sizeof((v).items[0])), \
165  (v).items, \
166  (v).size * sizeof((v).items[0])) \
167  : xrealloc((v).items, \
168  (v).capacity * sizeof((v).items[0])))))
169 
173 #define kvi_resize_full(v) \
174  /* ARRAY_SIZE((v).init_array) is the minimal capacity of this vector. */ \
175  /* Thus when vector is full capacity may not be zero and it is safe */ \
176  /* not to bother with checking whether (v).capacity is 0. But now */ \
177  /* capacity is not guaranteed to have size that is a power of 2, it is */ \
178  /* hard to fix this here and is not very necessary if users will use */ \
179  /* 2^x initial array size. */ \
180  kvi_resize(v, (v).capacity << 1)
181 
187 #define kvi_pushp(v) \
188  ((((v).size == (v).capacity) ? (kvi_resize_full(v), 0) : 0), \
189  ((v).items + ((v).size++)))
190 
195 #define kvi_push(v, x) \
196  (*kvi_pushp(v) = (x))
197 
201 #define kvi_destroy(v) \
202  do { \
203  if ((v).items != (v).init_array) { \
204  xfree((v).items); \
205  } \
206  } while (0)
207 
208 #endif // NVIM_LIB_KVEC_H
#define FUNC_ATTR_ALWAYS_INLINE
Definition: func_attr.h:236
void FUNC_ATTR_NONNULL_RET
Definition: memory.c:146
#define FUNC_ATTR_NONNULL_ALL
Definition: func_attr.h:238
xfree(sourcing_name)