Cleanup: remove redundant, invalid info from headers
[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 BLI_bitmap.h
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) \
40         (((_tot) >> _BITMAP_POWER) + 1)
41
42 /* size (in bytes) used to hold '_tot' bits */
43 #define BLI_BITMAP_SIZE(_tot) \
44         ((size_t)(_BITMAP_NUM_BLOCKS(_tot)) * sizeof(BLI_bitmap))
45
46 /* allocate memory for a bitmap with '_tot' bits; free with MEM_freeN() */
47 #define BLI_BITMAP_NEW(_tot, _alloc_string) \
48         ((BLI_bitmap *)MEM_callocN(BLI_BITMAP_SIZE(_tot), \
49                                  _alloc_string))
50
51 /* allocate a bitmap on the stack */
52 #define BLI_BITMAP_NEW_ALLOCA(_tot) \
53         ((BLI_bitmap *)memset(alloca(BLI_BITMAP_SIZE(_tot)), 0, BLI_BITMAP_SIZE(_tot)))
54
55 /* Allocate using given MemArena */
56 #define BLI_BITMAP_NEW_MEMARENA(_mem, _tot) \
57         (CHECK_TYPE_INLINE(_mem, MemArena *), \
58          ((BLI_bitmap *)BLI_memarena_calloc(_mem, BLI_BITMAP_SIZE(_tot))))
59
60 /* get the value of a single bit at '_index' */
61 #define BLI_BITMAP_TEST(_bitmap, _index) \
62         (CHECK_TYPE_ANY(_bitmap, BLI_bitmap *, const BLI_bitmap *), \
63          ((_bitmap)[(_index) >> _BITMAP_POWER] & \
64           (1u << ((_index) & _BITMAP_MASK))))
65
66 #define BLI_BITMAP_TEST_BOOL(_bitmap, _index) \
67         (CHECK_TYPE_ANY(_bitmap, BLI_bitmap *, const BLI_bitmap *), \
68          (BLI_BITMAP_TEST(_bitmap, _index) != 0))
69
70 /* set the value of a single bit at '_index' */
71 #define BLI_BITMAP_ENABLE(_bitmap, _index) \
72         (CHECK_TYPE_ANY(_bitmap, BLI_bitmap *, const BLI_bitmap *), \
73          ((_bitmap)[(_index) >> _BITMAP_POWER] |= \
74           (1u << ((_index) & _BITMAP_MASK))))
75
76 /* clear the value of a single bit at '_index' */
77 #define BLI_BITMAP_DISABLE(_bitmap, _index) \
78         (CHECK_TYPE_ANY(_bitmap, BLI_bitmap *, const BLI_bitmap *), \
79          ((_bitmap)[(_index) >> _BITMAP_POWER] &= \
80           ~(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] ^= \
86           (1u << ((_index) & _BITMAP_MASK))))
87
88 /* set or clear the value of a single bit at '_index' */
89 #define BLI_BITMAP_SET(_bitmap, _index, _set) \
90         { \
91                 CHECK_TYPE(_bitmap, BLI_bitmap *); \
92                 if (_set) \
93                         BLI_BITMAP_ENABLE(_bitmap, _index); \
94                 else \
95                         BLI_BITMAP_DISABLE(_bitmap, _index); \
96         } (void)0
97
98 /* set or clear the value of the whole bitmap (needs size info) */
99 #define BLI_BITMAP_SET_ALL(_bitmap, _set, _tot) \
100         { \
101                 CHECK_TYPE(_bitmap, BLI_bitmap *); \
102                 if (_set) \
103                         memset(_bitmap, UCHAR_MAX, BLI_BITMAP_SIZE(_tot)); \
104                 else \
105                         memset(_bitmap, 0, BLI_BITMAP_SIZE(_tot)); \
106         } (void)0
107
108 /* resize bitmap to have space for '_tot' bits */
109 #define BLI_BITMAP_RESIZE(_bitmap, _tot) \
110         { \
111                 CHECK_TYPE(_bitmap, BLI_bitmap *); \
112                 (_bitmap) = MEM_reallocN(_bitmap, BLI_BITMAP_SIZE(_tot)); \
113         } (void)0
114
115 #endif