A reimplementation of Mario Kart Wii's physics engine in C++
Loading...
Searching...
No Matches
BitFlag.hh
Go to the documentation of this file.
1#pragma once
2
3#include <Logger.hh>
4
5#include <array>
6#include <cstddef>
7#include <cstdint>
8#include <limits>
9#include <type_traits>
10
11namespace Kinoko {
12
13// We can't include Common.hh, because we have a cyclic dependency
14typedef uint32_t u32;
15
16namespace EGG {
17
21template <typename T, typename E>
22 requires(std::is_enum_v<E> && std::is_integral_v<T>)
23struct TBitFlag {
26 constexpr TBitFlag() {
28 }
29
33 constexpr TBitFlag(T mask) {
34 setDirect(mask);
35 }
36
40 constexpr TBitFlag(E e) : TBitFlag() {
41 setBit(e);
42 }
43
48 template <typename... Es>
49 requires(std::is_same_v<Es, E> && ...)
50 constexpr TBitFlag(Es... es) : TBitFlag() {
51 (setBit(es), ...);
52 }
53
55 [[nodiscard]] constexpr operator T() const {
56 return getDirect();
57 }
58
62 constexpr TBitFlag<T, E> &operator=(const TBitFlag<T, E> &rhs) {
63 bits = rhs.bits;
64 return *this;
65 }
66
72 template <typename... Es>
73 requires(std::is_same_v<Es, E> && ...)
74 constexpr TBitFlag<T, E> &setBit(Es... es) {
75 (setBit_(es), ...);
76 return *this;
77 }
78
83 template <typename... Es>
84 requires(std::is_same_v<Es, E> && ...)
85 constexpr TBitFlag<T, E> &resetBit(Es... es) {
86 (resetBit_(es), ...);
87 return *this;
88 }
89
95 template <typename... Es>
96 requires(std::is_same_v<Es, E> && ...)
97 constexpr TBitFlag<T, E> &changeBit(bool on, Es... es) {
98 (changeBit_(on, es), ...);
99 return *this;
100 }
101
106 template <typename... Es>
107 requires(std::is_same_v<Es, E> && ...)
108 constexpr TBitFlag<T, E> &toggleBit(Es... es) {
109 (toggleBit_(es), ...);
110 return *this;
111 }
112
118 template <typename... Es>
119 requires(std::is_same_v<Es, E> && ...)
120 [[nodiscard]] constexpr bool onBit(Es... es) const {
121 return (onAnyBit(es...));
122 }
123
129 template <typename... Es>
130 requires(std::is_same_v<Es, E> && ...)
131 [[nodiscard]] constexpr bool onAnyBit(Es... es) const {
132 return (onBit_(es) || ...);
133 }
134
140 template <typename... Es>
141 requires(std::is_same_v<Es, E> && ...)
142 [[nodiscard]] constexpr bool onAllBit(Es... es) const {
143 return (onBit_(es) && ...);
144 }
145
151 template <typename... Es>
152 requires(std::is_same_v<Es, E> && ...)
153 [[nodiscard]] constexpr bool offBit(Es... es) const {
154 return offAllBit(es...);
155 }
156
162 template <typename... Es>
163 requires(std::is_same_v<Es, E> && ...)
164 [[nodiscard]] constexpr bool offAllBit(Es... es) const {
165 return (offBit_(es) && ...);
166 }
167
173 template <typename... Es>
174 requires(std::is_same_v<Es, E> && ...)
175 [[nodiscard]] constexpr bool offAnyBit(Es... es) const {
176 return (offBit_(es) || ...);
177 }
178
184 template <typename... Es>
185 requires(std::is_same_v<Es, E> && ...)
186 [[nodiscard]] constexpr T maskBit(Es... es) const {
187 return bits & makeMask(es...);
188 }
189
194 template <typename... Es>
195 requires(std::is_same_v<Es, E> && ...)
196 [[nodiscard]] constexpr T makeMask(Es... es) const {
197 return (makeMask_(es) | ...);
198 }
199
203 constexpr TBitFlag<T, E> &set(T mask) {
204 bits |= mask;
205 return *this;
206 }
207
211 constexpr TBitFlag<T, E> &reset(T mask) {
212 bits &= ~mask;
213 return *this;
214 }
215
220 constexpr TBitFlag<T, E> &change(bool on, T mask) {
221 return on ? set(mask) : reset(mask);
222 }
223
227 [[nodiscard]] constexpr bool on(T mask) const {
228 return (bits & mask) != 0;
229 }
230
234 [[nodiscard]] constexpr bool onAll(T mask) const {
235 return (bits | mask) == bits;
236 }
237
241 [[nodiscard]] constexpr bool off(T mask) const {
242 return (bits & mask) == 0;
243 }
244
246 constexpr void makeAllZero() {
247 bits = 0;
248 }
249
252 [[nodiscard]] constexpr T getDirect() const {
253 return bits;
254 }
255
258 constexpr void setDirect(T mask) {
259 bits = mask;
260 }
261
262private:
263 typedef std::underlying_type_t<E> EI;
264 static constexpr size_t MAX_CAPACITY = std::numeric_limits<T>::digits;
265
269 constexpr void setBit_(E e) {
270 ASSERT(static_cast<EI>(e) < MAX_CAPACITY);
271 set(makeMask_(e));
272 }
273
277 constexpr void resetBit_(E e) {
278 ASSERT(static_cast<EI>(e) < MAX_CAPACITY);
279 reset(makeMask_(e));
280 }
281
286 constexpr void changeBit_(bool on, E e) {
287 ASSERT(static_cast<EI>(e) < MAX_CAPACITY);
288 change(on, makeMask_(e));
289 }
290
294 constexpr void toggleBit_(E e) {
295 ASSERT(static_cast<EI>(e) < MAX_CAPACITY);
296 changeBit_(offBit_(e), e);
297 }
298
303 [[nodiscard]] constexpr bool onBit_(E e) const {
304 ASSERT(static_cast<EI>(e) < MAX_CAPACITY);
305 return on(makeMask_(e));
306 }
307
312 [[nodiscard]] constexpr bool offBit_(E e) const {
313 ASSERT(static_cast<EI>(e) < MAX_CAPACITY);
314 return off(makeMask_(e));
315 }
316
321 [[nodiscard]] constexpr T makeMask_(E e) const {
322 ASSERT(static_cast<EI>(e) < MAX_CAPACITY);
323 return static_cast<T>(1) << static_cast<T>(e);
324 }
325
327};
328
332template <size_t N, typename E>
333 requires(std::is_enum_v<E> && N > 64)
335public:
338 constexpr TBitFlagExt() {
339 makeAllZero();
340 }
341
345 std::fill(bits.begin(), bits.end(), 0);
346 return *this;
347 }
348
354 template <typename... Es>
355 requires(std::is_same_v<Es, E> && ...)
356 constexpr TBitFlagExt<N, E> &setBit(Es... es) {
357 (setBit_(es), ...);
358 return *this;
359 }
360
365 template <typename... Es>
366 requires(std::is_same_v<Es, E> && ...)
367 constexpr TBitFlagExt<N, E> &resetBit(Es... es) {
368 (resetBit_(es), ...);
369 return *this;
370 }
371
377 template <typename... Es>
378 requires(std::is_same_v<Es, E> && ...)
379 constexpr TBitFlagExt<N, E> &changeBit(bool on, Es... es) {
380 (changeBit_(on, es), ...);
381 return *this;
382 }
383
389 template <typename... Es>
390 requires(std::is_same_v<Es, E> && ...)
391 [[nodiscard]] constexpr bool onBit(Es... es) const {
392 return onAnyBit(es...);
393 }
394
400 template <typename... Es>
401 requires(std::is_same_v<Es, E> && ...)
402 [[nodiscard]] constexpr bool onAnyBit(Es... es) const {
403 return (onBit_(es) || ...);
404 }
405
411 template <typename... Es>
412 requires(std::is_same_v<Es, E> && ...)
413 [[nodiscard]] constexpr bool onAllBit(Es... es) const {
414 return (onBit_(es) && ...);
415 }
416
422 template <typename... Es>
423 requires(std::is_same_v<Es, E> && ...)
424 [[nodiscard]] constexpr bool offBit(Es... es) const {
425 return offAllBit(es...);
426 }
427
433 template <typename... Es>
434 requires(std::is_same_v<Es, E> && ...)
435 [[nodiscard]] constexpr bool offAllBit(Es... es) const {
436 return (offBit_(es) && ...);
437 }
438
444 template <typename... Es>
445 requires(std::is_same_v<Es, E> && ...)
446 [[nodiscard]] constexpr bool offAnyBit(Es... es) const {
447 return (offBit_(es) || ...);
448 }
449
450private:
451 typedef std::underlying_type_t<E> EI;
452
456 constexpr void setBit_(E e) {
457 auto [field, mask] = makeMask_(e);
458 field |= mask;
459 }
460
464 constexpr void resetBit_(E e) {
465 auto [field, mask] = makeMask_(e);
466 field &= ~mask;
467 }
468
473 [[nodiscard]] constexpr void changeBit_(bool on, E e) {
474 on ? setBit_(e) : resetBit_(e);
475 }
476
481 [[nodiscard]] constexpr bool onBit_(E e) const {
482 auto [field, mask] = makeMask_(e);
483 return (field & mask) != 0;
484 }
485
490 [[nodiscard]] constexpr bool offBit_(E e) const {
491 auto [field, mask] = makeMask_(e);
492 return (field & mask) == 0;
493 }
494
495 typedef u32 T;
496
501 [[nodiscard]] constexpr std::pair<T, T> makeMask_(E e) const {
502 EI ei = static_cast<EI>(e);
503 ASSERT(ei < N);
504 return std::pair<T, T>(bits[ei / C], static_cast<T>(1) << (ei % C));
505 }
506
511 [[nodiscard]] constexpr std::pair<T &, T> makeMask_(E e) {
512 EI ei = static_cast<EI>(e);
513 ASSERT(ei < N);
514 return std::pair<T &, T>(bits[ei / C], static_cast<T>(1) << (ei % C));
515 }
516
517 static constexpr size_t C = 8 * sizeof(T);
518 std::array<T, (N + C - 1) / C> bits;
519};
520
521} // namespace EGG
522
523} // namespace Kinoko
#define ASSERT(e)
Definition Logger.hh:25
constexpr TBitFlagExt< N, eStatus > & changeBit(bool on, Es... es)
Definition BitFlag.hh:379
constexpr bool offBit(Es... es) const
Checks if all of the corresponding bits for the provided enum values are off.
Definition BitFlag.hh:424
constexpr bool onBit(Es... es) const
Checks if any of the corresponding bits for the provided enum values are on.
Definition BitFlag.hh:391
constexpr bool onAllBit(Es... es) const
Checks if all of the corresponding bits for the provided enum values are on.
Definition BitFlag.hh:413
constexpr std::pair< T &, T > makeMask_(E e)
Gets bit index and mask for a specific bit.
Definition BitFlag.hh:511
constexpr TBitFlagExt< N, E > & resetBit(Es... es)
Resets the corresponding bits for the provided enum values.
Definition BitFlag.hh:367
constexpr TBitFlagExt()
Default constructor, initializes all flags to off.
Definition BitFlag.hh:338
constexpr bool offAnyBit(Es... es) const
Checks if any of the corresponding bits for the provided enum values are off.
Definition BitFlag.hh:446
std::underlying_type_t< E > EI
Definition BitFlag.hh:451
EGG core library.
Definition Allocator.hh:5
uint32_t u32
Definition Memory.hh:18
constexpr bool offBit(Es... es) const
Checks if all of the corresponding bits for the provided enum values are off.
Definition BitFlag.hh:153
constexpr bool onBit(Es... es) const
Checks if any of the corresponding bits for the provided enum values are on.
Definition BitFlag.hh:120
constexpr void toggleBit_(eAttribute e)
Definition BitFlag.hh:294
constexpr bool onAll(T mask) const
Checks if all bits are on in the specified mask.
Definition BitFlag.hh:234
constexpr bool offAllBit(Es... es) const
Definition BitFlag.hh:164
constexpr TBitFlag< u16, eAttribute > & setBit(Es... es)
Definition BitFlag.hh:74
constexpr TBitFlag()
Default constructor, initializes all flags to off.
Definition BitFlag.hh:26
constexpr bool onAllBit(Es... es) const
Checks if all of the corresponding bits for the provided enum values are on.
Definition BitFlag.hh:142
constexpr TBitFlag< T, E > & change(bool on, T mask)
Changes the bits using a direct mask.
Definition BitFlag.hh:220
constexpr T getDirect() const
Gets the current bit mask.
Definition BitFlag.hh:252
constexpr TBitFlag< u16, eAttribute > & changeBit(bool on, Es... es)
Definition BitFlag.hh:97
constexpr u16 makeMask_(eAttribute e) const
Definition BitFlag.hh:321
constexpr TBitFlag(E e)
Constructor that initializes the bit flags with a given enum.
Definition BitFlag.hh:40
constexpr bool onBit_(eAttribute e) const
Definition BitFlag.hh:303
constexpr TBitFlag(T mask)
Constructor that initializes the bit flags with a given mask.
Definition BitFlag.hh:33
constexpr TBitFlag< T, E > & reset(T mask)
Resets the bits using a direct mask.
Definition BitFlag.hh:211
constexpr TBitFlag< T, E > & operator=(const TBitFlag< T, E > &rhs)
Assignment operator.
Definition BitFlag.hh:62
constexpr bool offBit_(eAttribute e) const
Definition BitFlag.hh:312
constexpr void resetBit_(eAttribute e)
Definition BitFlag.hh:277
constexpr u16 makeMask(Es... es) const
Definition BitFlag.hh:196
constexpr TBitFlag< T, E > & toggleBit(Es... es)
Toggles the corresponding bits for the provided enum values.
Definition BitFlag.hh:108
constexpr bool on(u16 mask) const
Definition BitFlag.hh:227
constexpr void setDirect(u16 mask)
Definition BitFlag.hh:258
constexpr TBitFlag< T, E > & set(T mask)
Sets the bits using a direct mask.
Definition BitFlag.hh:203
constexpr void setBit_(eAttribute e)
Definition BitFlag.hh:269
constexpr bool off(T mask) const
Checks if all bits are off in the specified mask.
Definition BitFlag.hh:241
constexpr T maskBit(Es... es) const
Creates an applied mask of the corresponding bits for the provided enum values.
Definition BitFlag.hh:186
constexpr TBitFlag< T, E > & resetBit(Es... es)
Resets the corresponding bits for the provided enum values.
Definition BitFlag.hh:85
constexpr bool offAnyBit(Es... es) const
Checks if any of the corresponding bits for the provided enum values are off.
Definition BitFlag.hh:175
constexpr bool onAnyBit(Es... es) const
Definition BitFlag.hh:131
constexpr void changeBit_(bool on, eAttribute e)
Definition BitFlag.hh:286
std::underlying_type_t< eAttribute > EI
Definition BitFlag.hh:263
static constexpr size_t MAX_CAPACITY
Definition BitFlag.hh:264