svn merge ^/trunk/blender -r42973:42991
[blender.git] / source / blender / blenkernel / BKE_array_mallocn.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef BKE_ARRAY_MALLOCN_H
29 #define BKE_ARRAY_MALLOCN_H
30
31 /** \file BKE_array_mallocn.h
32  *  \ingroup bke
33  *  \brief little array macro library.
34  */
35
36 /* example of usage:
37  *
38  * int *arr = NULL;
39  * V_DECLARE(arr);
40  * int i;
41  *
42  * for (i=0; i<10; i++) {
43  *      V_GROW(arr);
44  *      arr[i] = something;
45  * }
46  * V_FREE(arr);
47  *
48  * arrays are buffered, using double-buffering (so on each reallocation,
49  * the array size is doubled).  supposedly this should give good Big Oh
50  * behaviour, though it may not be the best in practice.
51  */
52
53 #define V_DECLARE(vec) int _##vec##_count=0; void *_##vec##_tmp
54
55 /* in the future, I plan on having V_DECLARE allocate stack memory it'll
56  * use at first, and switch over to heap when it needs more.  that'll mess
57  * up cases where you'd want to use this API to build a dynamic list for
58  * non-local use, so all such cases should use this macro.*/
59 #define V_DYNDECLARE(vec) V_DECLARE(vec)
60
61 /*this returns the entire size of the array, including any buffering.*/
62 #define V_SIZE(vec) ((signed int)((vec)==NULL ? 0 : MEM_allocN_len(vec) / sizeof(*vec)))
63
64 /*this returns the logical size of the array, not including buffering.*/
65 #define V_COUNT(vec) _##vec##_count
66
67 /*grow the array by one.  zeroes the new elements.*/
68 #define V_GROW(vec) \
69         V_SIZE(vec) > _##vec##_count ? _##vec##_count++ : \
70         ((_##vec##_tmp = MEM_callocN(sizeof(*vec)*(_##vec##_count*2+2), #vec " " __FILE__ " ")),\
71         (void)(vec && memcpy(_##vec##_tmp, vec, sizeof(*vec) * _##vec##_count)),\
72         (void)(vec && (MEM_freeN(vec),1)),\
73         (vec = _##vec##_tmp),\
74         _##vec##_count++)
75
76 #define V_FREE(vec) if (vec) MEM_freeN(vec);
77
78 /*resets the logical size of an array to zero, but doesn't
79   free the memory.*/
80 #define V_RESET(vec) _##vec##_count=0
81
82 /*set the count of the array*/
83 #define V_SETCOUNT(vec, count) _##vec##_count = (count)
84
85 #endif // BKE_ARRAY_MALLOCN_H