mirror of
https://github.com/scp-fs2open/fs2open.github.com.git
synced 2026-11-10 12:41:35 -10:00
100 lines
3.2 KiB
C++
100 lines
3.2 KiB
C++
/*
|
||
* Created by Ian "Goober5000" Warfield for the FreeSpace2 Source Code Project.
|
||
* You may not sell or otherwise commercially exploit the source or things you
|
||
* create based on the source.
|
||
*/
|
||
|
||
|
||
|
||
#ifndef _BIT_ARRAY_H
|
||
#define _BIT_ARRAY_H
|
||
|
||
#include "globalincs/pstypes.h"
|
||
|
||
|
||
// the following four functions are adapted from http://www.codeproject.com/cpp/BitArray.asp; their explanation
|
||
// is as follows:
|
||
/*
|
||
* The Bit Array structure provides a compacted arrays of Booleans, with one bit for each Boolean value.
|
||
* A 0 (1) bit corresponds to the Boolean value false (true), respectively. We can look at a stream of bytes
|
||
* as a stream of bits; each byte contains 8 bits, so any n bytes hold n*8 bits. And the operation to
|
||
* manipulate this stream or bit array is so easy, just read or change the bit's state or make any Boolean
|
||
* operation on the whole bits array, like ‘AND’, ‘OR’, or ‘XOR’.
|
||
*
|
||
* As each byte contains 8 bits, we need to divide the bit number by 8 to reach the byte that holds the bit.
|
||
* Then, we can seek to the right bit in the reached byte by the remainder of dividing the bit number by 8.
|
||
* So to read or change the bit state, the operations will be like that.
|
||
*
|
||
* Note that to divide by 8, we need only to shift right by 3 (>>3), and to get the remainder of dividing
|
||
* by 8, we need only to AND with 7 (&7).
|
||
*/
|
||
|
||
// returns bit state (0 or 1)
|
||
#define get_bit(array, bitnum) ((((ubyte *) array)[(bitnum) >> 3] >> ((bitnum) & 7)) & 1)
|
||
|
||
// sets bit to 1
|
||
#define set_bit(array, bitnum) (((ubyte *) array)[(bitnum) >> 3] |= (1 << ((bitnum) & 7)))
|
||
|
||
// clears bit to 0
|
||
#define clear_bit(array, bitnum) (((ubyte *) array)[(bitnum) >> 3] &= ~(1 << ((bitnum) & 7)))
|
||
|
||
// toggles bit (xor)
|
||
#define toggle_bit(array, bitnum) (((ubyte *) array)[(bitnum) >> 3] ^= (1 << ((bitnum) & 7)))
|
||
|
||
|
||
// calculates number of bytes from number of bits
|
||
#define calculate_num_bytes(num_bits) ((num_bits >> 3) + 1)
|
||
|
||
// zeroes out all bits in the bit array
|
||
#define clear_all_bits(array, num_bits) memset(array, 0, calculate_num_bytes(num_bits))
|
||
|
||
// tests whether any bit in this bit array is nonzero
|
||
template <class N_TYPE>
|
||
bool any_bits_set(void *array, N_TYPE num_bits)
|
||
{
|
||
auto bytes = static_cast<ubyte*>(array);
|
||
N_TYPE num_bytes = calculate_num_bytes(num_bits);
|
||
for (N_TYPE i = 0; i < num_bytes; ++i)
|
||
if (bytes[i] != 0)
|
||
return true;
|
||
return false;
|
||
}
|
||
|
||
// copies a bit array into an int so that they contain equivalent values, up to the capacity of the int type
|
||
template <class N_TYPE>
|
||
int bit_array_as_int(void *array, N_TYPE num_bits)
|
||
{
|
||
int rval = 0;
|
||
|
||
auto bytes = static_cast<ubyte*>(array);
|
||
N_TYPE num_bytes = calculate_num_bytes(num_bits);
|
||
for (N_TYPE i = 0; i < num_bytes && i < sizeof(int); ++i)
|
||
{
|
||
rval = rval << 3;
|
||
rval |= bytes[i];
|
||
}
|
||
|
||
return rval;
|
||
}
|
||
|
||
// copies an int into a bit array so that they contain equivalent values; any bits in the bit array higher than the capacity of an int are zeroed out
|
||
template <class N_TYPE>
|
||
void bit_array_set_from_int(void *array, N_TYPE num_bits, int input)
|
||
{
|
||
auto bytes = static_cast<ubyte*>(array);
|
||
N_TYPE num_bytes = calculate_num_bytes(num_bits);
|
||
for (N_TYPE i = 0; i < num_bytes; ++i)
|
||
{
|
||
if (i < sizeof(int))
|
||
{
|
||
bytes[i] = input & 255;
|
||
input = input >> 3;
|
||
}
|
||
else
|
||
bytes[i] = 0;
|
||
}
|
||
}
|
||
|
||
|
||
#endif // _BIT_ARRAY_H
|