BLI_bitmap: add functions operating on the whole bitmask.

There is no point having operations that iterate over the whole
bit array as macros, so convert BLI_BITMAP_SET_ALL to a function.
Also, add more utilities for copying and manipulating masks.

Reviewers: brecht, campbellbarton

Differential Revision: https://developer.blender.org/D4101

4 files changed, 83 insertions, 11 deletions

diff --git a/source/blender/blenlib/BLI_bitmap.h b/source/blender/blenlib/BLI_bitmap.h
index 8e873c76dc9..c3be39c5bc5 100644
--- a/source/blender/blenlib/BLI_bitmap.h
+++ b/source/blender/blenlib/BLI_bitmap.h
@@ -107,16 +107,6 @@ typedef unsigned int BLI_bitmap;
 			BLI_BITMAP_DISABLE(_bitmap, _index); \
 	} (void)0
 
-/* set or clear the value of the whole bitmap (needs size info) */
-#define BLI_BITMAP_SET_ALL(_bitmap, _set, _tot) \
-	{ \
-		CHECK_TYPE(_bitmap, BLI_bitmap *); \
-		if (_set) \
-			memset(_bitmap, UCHAR_MAX, BLI_BITMAP_SIZE(_tot)); \
-		else \
-			memset(_bitmap, 0, BLI_BITMAP_SIZE(_tot)); \
-	} (void)0
-
 /* resize bitmap to have space for '_tot' bits */
 #define BLI_BITMAP_RESIZE(_bitmap, _tot) \
 	{ \
@@ -124,4 +114,10 @@ typedef unsigned int BLI_bitmap;
 		(_bitmap) = MEM_reallocN(_bitmap, BLI_BITMAP_SIZE(_tot)); \
 	} (void)0
 
+void BLI_bitmap_set_all(BLI_bitmap *bitmap, bool set, size_t bits);
+void BLI_bitmap_flip_all(BLI_bitmap *bitmap, size_t bits);
+void BLI_bitmap_copy_all(BLI_bitmap *dst, const BLI_bitmap *src, size_t bits);
+void BLI_bitmap_and_all(BLI_bitmap *dst, const BLI_bitmap *src, size_t bits);
+void BLI_bitmap_or_all(BLI_bitmap *dst, const BLI_bitmap *src, size_t bits);
+
 #endif
diff --git a/source/blender/blenlib/CMakeLists.txt b/source/blender/blenlib/CMakeLists.txt
index 921ecc29e18..90d24d0b84e 100644
--- a/source/blender/blenlib/CMakeLists.txt
+++ b/source/blender/blenlib/CMakeLists.txt
@@ -62,6 +62,7 @@ set(SRC
 	intern/array_store_utils.c
 	intern/array_utils.c
 	intern/astar.c
+	intern/bitmap.c
 	intern/bitmap_draw_2d.c
 	intern/boxpack_2d.c
 	intern/buffer.c
diff --git a/source/blender/blenlib/intern/astar.c b/source/blender/blenlib/intern/astar.c
index ff4dfea2401..4a94c385b59 100644
--- a/source/blender/blenlib/intern/astar.c
+++ b/source/blender/blenlib/intern/astar.c
@@ -216,7 +216,7 @@ bool BLI_astar_graph_solve(
 
 	r_solution->steps = 0;
 	prev_nodes[node_index_src] = -1;
-	BLI_BITMAP_SET_ALL(done_nodes, false, as_graph->node_num);
+	BLI_bitmap_set_all(done_nodes, false, as_graph->node_num);
 	copy_vn_fl(g_costs, as_graph->node_num, FLT_MAX);
 	g_costs[node_index_src] = 0.0f;
 	g_steps[node_index_src] = 0;
diff --git a/source/blender/blenlib/intern/bitmap.c b/source/blender/blenlib/intern/bitmap.c
new file mode 100644
index 00000000000..fab8b3dedf6
--- /dev/null
+++ b/source/blender/blenlib/intern/bitmap.c
@@ -0,0 +1,75 @@
+/*
+ * ***** BEGIN GPL LICENSE BLOCK *****
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * The Original Code is Copyright (C) 2012 by Nicholas Bishop
+ * All rights reserved.
+ *
+ * The Original Code is: all of this file.
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+
+/** \file blender/blenlib/intern/bitmap.c
+ *  \ingroup bli
+ *
+ * Utility functions for variable size bitmasks.
+ */
+
+#include <string.h>
+#include <limits.h>
+
+#include "BLI_utildefines.h"
+#include "BLI_bitmap.h"
+
+/** Set or clear all bits in the bitmap. */
+void BLI_bitmap_set_all(BLI_bitmap *bitmap, bool set, size_t bits)
+{
+	memset(bitmap, set ? UCHAR_MAX : 0, BLI_BITMAP_SIZE(bits));
+}
+
+/** Invert all bits in the bitmap. */
+void BLI_bitmap_flip_all(BLI_bitmap *bitmap, size_t bits)
+{
+	size_t num_blocks = _BITMAP_NUM_BLOCKS(bits);
+	for (size_t i = 0; i < num_blocks; i++) {
+		bitmap[i] ^= ~(BLI_bitmap)0;
+	}
+}
+
+/** Copy all bits from one bitmap to another. */
+void BLI_bitmap_copy_all(BLI_bitmap *dst, const BLI_bitmap *src, size_t bits)
+{
+	memcpy(dst, src, BLI_BITMAP_SIZE(bits));
+}
+
+/** Combine two bitmaps with boolean AND. */
+void BLI_bitmap_and_all(BLI_bitmap *dst, const BLI_bitmap *src, size_t bits)
+{
+	size_t num_blocks = _BITMAP_NUM_BLOCKS(bits);
+	for (size_t i = 0; i < num_blocks; i++) {
+		dst[i] &= src[i];
+	}
+}
+
+/** Combine two bitmaps with boolean OR. */
+void BLI_bitmap_or_all(BLI_bitmap *dst, const BLI_bitmap *src, size_t bits)
+{
+	size_t num_blocks = _BITMAP_NUM_BLOCKS(bits);
+	for (size_t i = 0; i < num_blocks; i++) {
+		dst[i] |= src[i];
+	}
+}