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