Merge branch 'blender2.7'
[blender.git] / source / blender / blenlib / BLI_bitmap.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) 2012 by Nicholas Bishop
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 #ifndef __BLI_BITMAP_H__
27 #define __BLI_BITMAP_H__
28
29 /** \file BLI_bitmap.h
30  *  \ingroup bli
31  */
32
33 typedef unsigned int BLI_bitmap;
34
35 /* warning: the bitmap does not keep track of its own size or check
36  * for out-of-bounds access */
37
38 /* internal use */
39 /* 2^5 = 32 (bits) */
40 #define _BITMAP_POWER 5
41 /* 0b11111 */
42 #define _BITMAP_MASK 31
43
44 /* number of blocks needed to hold '_tot' bits */
45 #define _BITMAP_NUM_BLOCKS(_tot) \
46         (((_tot) >> _BITMAP_POWER) + 1)
47
48 /* size (in bytes) used to hold '_tot' bits */
49 #define BLI_BITMAP_SIZE(_tot) \
50         ((size_t)(_BITMAP_NUM_BLOCKS(_tot)) * sizeof(BLI_bitmap))
51
52 /* allocate memory for a bitmap with '_tot' bits; free with MEM_freeN() */
53 #define BLI_BITMAP_NEW(_tot, _alloc_string) \
54         ((BLI_bitmap *)MEM_callocN(BLI_BITMAP_SIZE(_tot), \
55                                  _alloc_string))
56
57 /* allocate a bitmap on the stack */
58 #define BLI_BITMAP_NEW_ALLOCA(_tot) \
59         ((BLI_bitmap *)memset(alloca(BLI_BITMAP_SIZE(_tot)), 0, BLI_BITMAP_SIZE(_tot)))
60
61 /* Allocate using given MemArena */
62 #define BLI_BITMAP_NEW_MEMARENA(_mem, _tot) \
63         (CHECK_TYPE_INLINE(_mem, MemArena *), \
64          ((BLI_bitmap *)BLI_memarena_calloc(_mem, BLI_BITMAP_SIZE(_tot))))
65
66 /* get the value of a single bit at '_index' */
67 #define BLI_BITMAP_TEST(_bitmap, _index) \
68         (CHECK_TYPE_ANY(_bitmap, BLI_bitmap *, const BLI_bitmap *), \
69          ((_bitmap)[(_index) >> _BITMAP_POWER] & \
70           (1u << ((_index) & _BITMAP_MASK))))
71
72 #define BLI_BITMAP_TEST_AND_SET_ATOMIC(_bitmap, _index) \
73         (CHECK_TYPE_ANY(_bitmap, BLI_bitmap *, const BLI_bitmap *), \
74         (atomic_fetch_and_or_uint32((uint32_t*)&(_bitmap)[(_index) >> _BITMAP_POWER], \
75                                     (1u << ((_index) & _BITMAP_MASK))) & \
76                                     (1u << ((_index) & _BITMAP_MASK))))
77
78 #define BLI_BITMAP_TEST_BOOL(_bitmap, _index) \
79         (CHECK_TYPE_ANY(_bitmap, BLI_bitmap *, const BLI_bitmap *), \
80          (BLI_BITMAP_TEST(_bitmap, _index) != 0))
81
82 /* set the value of a single bit at '_index' */
83 #define BLI_BITMAP_ENABLE(_bitmap, _index) \
84         (CHECK_TYPE_ANY(_bitmap, BLI_bitmap *, const BLI_bitmap *), \
85          ((_bitmap)[(_index) >> _BITMAP_POWER] |= \
86           (1u << ((_index) & _BITMAP_MASK))))
87
88 /* clear the value of a single bit at '_index' */
89 #define BLI_BITMAP_DISABLE(_bitmap, _index) \
90         (CHECK_TYPE_ANY(_bitmap, BLI_bitmap *, const BLI_bitmap *), \
91          ((_bitmap)[(_index) >> _BITMAP_POWER] &= \
92           ~(1u << ((_index) & _BITMAP_MASK))))
93
94 /* flip the value of a single bit at '_index' */
95 #define BLI_BITMAP_FLIP(_bitmap, _index) \
96         (CHECK_TYPE_ANY(_bitmap, BLI_bitmap *, const BLI_bitmap *), \
97          ((_bitmap)[(_index) >> _BITMAP_POWER] ^= \
98           (1u << ((_index) & _BITMAP_MASK))))
99
100 /* set or clear the value of a single bit at '_index' */
101 #define BLI_BITMAP_SET(_bitmap, _index, _set) \
102         { \
103                 CHECK_TYPE(_bitmap, BLI_bitmap *); \
104                 if (_set) \
105                         BLI_BITMAP_ENABLE(_bitmap, _index); \
106                 else \
107                         BLI_BITMAP_DISABLE(_bitmap, _index); \
108         } (void)0
109
110 /* resize bitmap to have space for '_tot' bits */
111 #define BLI_BITMAP_RESIZE(_bitmap, _tot) \
112         { \
113                 CHECK_TYPE(_bitmap, BLI_bitmap *); \
114                 (_bitmap) = MEM_reallocN(_bitmap, BLI_BITMAP_SIZE(_tot)); \
115         } (void)0
116
117 void BLI_bitmap_set_all(BLI_bitmap *bitmap, bool set, size_t bits);
118 void BLI_bitmap_flip_all(BLI_bitmap *bitmap, size_t bits);
119 void BLI_bitmap_copy_all(BLI_bitmap *dst, const BLI_bitmap *src, size_t bits);
120 void BLI_bitmap_and_all(BLI_bitmap *dst, const BLI_bitmap *src, size_t bits);
121 void BLI_bitmap_or_all(BLI_bitmap *dst, const BLI_bitmap *src, size_t bits);
122
123 #endif