ClangFormat: apply to source, most of intern
[blender.git] / source / blender / blenlib / BLI_bitmap.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2012 by Nicholas Bishop
17  * All rights reserved.
18  */
19
20 #ifndef __BLI_BITMAP_H__
21 #define __BLI_BITMAP_H__
22
23 /** \file
24  * \ingroup bli
25  */
26
27 typedef unsigned int BLI_bitmap;
28
29 /* warning: the bitmap does not keep track of its own size or check
30  * for out-of-bounds access */
31
32 /* internal use */
33 /* 2^5 = 32 (bits) */
34 #define _BITMAP_POWER 5
35 /* 0b11111 */
36 #define _BITMAP_MASK 31
37
38 /* number of blocks needed to hold '_tot' bits */
39 #define _BITMAP_NUM_BLOCKS(_tot) (((_tot) >> _BITMAP_POWER) + 1)
40
41 /* size (in bytes) used to hold '_tot' bits */
42 #define BLI_BITMAP_SIZE(_tot) ((size_t)(_BITMAP_NUM_BLOCKS(_tot)) * sizeof(BLI_bitmap))
43
44 /* allocate memory for a bitmap with '_tot' bits; free with MEM_freeN() */
45 #define BLI_BITMAP_NEW(_tot, _alloc_string) \
46   ((BLI_bitmap *)MEM_callocN(BLI_BITMAP_SIZE(_tot), _alloc_string))
47
48 /* allocate a bitmap on the stack */
49 #define BLI_BITMAP_NEW_ALLOCA(_tot) \
50   ((BLI_bitmap *)memset(alloca(BLI_BITMAP_SIZE(_tot)), 0, BLI_BITMAP_SIZE(_tot)))
51
52 /* Allocate using given MemArena */
53 #define BLI_BITMAP_NEW_MEMARENA(_mem, _tot) \
54   (CHECK_TYPE_INLINE(_mem, MemArena *), \
55    ((BLI_bitmap *)BLI_memarena_calloc(_mem, BLI_BITMAP_SIZE(_tot))))
56
57 /* get the value of a single bit at '_index' */
58 #define BLI_BITMAP_TEST(_bitmap, _index) \
59   (CHECK_TYPE_ANY(_bitmap, BLI_bitmap *, const BLI_bitmap *), \
60    ((_bitmap)[(_index) >> _BITMAP_POWER] & (1u << ((_index)&_BITMAP_MASK))))
61
62 #define BLI_BITMAP_TEST_AND_SET_ATOMIC(_bitmap, _index) \
63   (CHECK_TYPE_ANY(_bitmap, BLI_bitmap *, const BLI_bitmap *), \
64    (atomic_fetch_and_or_uint32((uint32_t *)&(_bitmap)[(_index) >> _BITMAP_POWER], \
65                                (1u << ((_index)&_BITMAP_MASK))) & \
66     (1u << ((_index)&_BITMAP_MASK))))
67
68 #define BLI_BITMAP_TEST_BOOL(_bitmap, _index) \
69   (CHECK_TYPE_ANY(_bitmap, BLI_bitmap *, const BLI_bitmap *), \
70    (BLI_BITMAP_TEST(_bitmap, _index) != 0))
71
72 /* set the value of a single bit at '_index' */
73 #define BLI_BITMAP_ENABLE(_bitmap, _index) \
74   (CHECK_TYPE_ANY(_bitmap, BLI_bitmap *, const BLI_bitmap *), \
75    ((_bitmap)[(_index) >> _BITMAP_POWER] |= (1u << ((_index)&_BITMAP_MASK))))
76
77 /* clear the value of a single bit at '_index' */
78 #define BLI_BITMAP_DISABLE(_bitmap, _index) \
79   (CHECK_TYPE_ANY(_bitmap, BLI_bitmap *, const BLI_bitmap *), \
80    ((_bitmap)[(_index) >> _BITMAP_POWER] &= ~(1u << ((_index)&_BITMAP_MASK))))
81
82 /* flip the value of a single bit at '_index' */
83 #define BLI_BITMAP_FLIP(_bitmap, _index) \
84   (CHECK_TYPE_ANY(_bitmap, BLI_bitmap *, const BLI_bitmap *), \
85    ((_bitmap)[(_index) >> _BITMAP_POWER] ^= (1u << ((_index)&_BITMAP_MASK))))
86
87 /* set or clear the value of a single bit at '_index' */
88 #define BLI_BITMAP_SET(_bitmap, _index, _set) \
89   { \
90     CHECK_TYPE(_bitmap, BLI_bitmap *); \
91     if (_set) \
92       BLI_BITMAP_ENABLE(_bitmap, _index); \
93     else \
94       BLI_BITMAP_DISABLE(_bitmap, _index); \
95   } \
96   (void)0
97
98 /* resize bitmap to have space for '_tot' bits */
99 #define BLI_BITMAP_RESIZE(_bitmap, _tot) \
100   { \
101     CHECK_TYPE(_bitmap, BLI_bitmap *); \
102     (_bitmap) = MEM_reallocN(_bitmap, BLI_BITMAP_SIZE(_tot)); \
103   } \
104   (void)0
105
106 void BLI_bitmap_set_all(BLI_bitmap *bitmap, bool set, size_t bits);
107 void BLI_bitmap_flip_all(BLI_bitmap *bitmap, size_t bits);
108 void BLI_bitmap_copy_all(BLI_bitmap *dst, const BLI_bitmap *src, size_t bits);
109 void BLI_bitmap_and_all(BLI_bitmap *dst, const BLI_bitmap *src, size_t bits);
110 void BLI_bitmap_or_all(BLI_bitmap *dst, const BLI_bitmap *src, size_t bits);
111
112 #endif