StormByte 3.0.0
C++26 foundation of the StormByte suite
Loading...
Searching...
No Matches
bitmask.txx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This is the base for StormByte Suite libraries.
5 *
6 * StormByte original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte source in this repository.
20 * They do not cover other StormByte modules or any third-party material
21 * shipped with this repository (including everything under thirdparty/),
22 * which remains under its own license.
23 *
24 * Neither license grants any patent rights. Any patent licenses required
25 * to use this software or third-party components must be obtained separately
26 * from the patent holders.
27 *
28 * StormByte is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU Lesser General Public License for more details.
32 *
33 * You should have received a copy of the GNU Lesser General Public License
34 * version 3 along with StormByte. If not, see
35 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
36 *
37 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
38 */
39
40#pragma once
41
42// Out-of-line implementation of StormByte::Bitmask, included by bitmask.hxx.
43// See bitmask.hxx for documentation of each member.
44
45namespace StormByte {
46 template<typename Derived, Type::UnsignedEnum E>
47 constexpr bool Bitmask<Derived, E>::operator==(const Bitmask& other) const noexcept {
48 return m_value == other.m_value;
49 }
50
51 template<typename Derived, Type::UnsignedEnum E>
52 constexpr bool Bitmask<Derived, E>::operator!=(const Bitmask& other) const noexcept {
53 return m_value != other.m_value;
54 }
55
56 template<typename Derived, Type::UnsignedEnum E>
57 constexpr Derived Bitmask<Derived, E>::operator|(const Bitmask& other) const noexcept {
58 return Derived(m_value | other.m_value);
59 }
60
61 template<typename Derived, Type::UnsignedEnum E>
62 constexpr Derived Bitmask<Derived, E>::operator&(const Bitmask& other) const noexcept {
63 return Derived(m_value & other.m_value);
64 }
65
66 template<typename Derived, Type::UnsignedEnum E>
67 constexpr Derived Bitmask<Derived, E>::operator^(const Bitmask& other) const noexcept {
68 return Derived(m_value ^ other.m_value);
69 }
70
71 template<typename Derived, Type::UnsignedEnum E>
72 constexpr Derived Bitmask<Derived, E>::operator~() const noexcept {
73 return Derived(~m_value);
74 }
75
76 template<typename Derived, Type::UnsignedEnum E>
77 constexpr Bitmask<Derived, E>& Bitmask<Derived, E>::operator|=(const Bitmask& other) noexcept {
78 m_value = m_value | other.m_value;
79 return *this;
80 }
81
82 template<typename Derived, Type::UnsignedEnum E>
83 constexpr Bitmask<Derived, E>& Bitmask<Derived, E>::operator&=(const Bitmask& other) noexcept {
84 m_value = m_value & other.m_value;
85 return *this;
86 }
87
88 template<typename Derived, Type::UnsignedEnum E>
89 constexpr Bitmask<Derived, E>& Bitmask<Derived, E>::operator^=(const Bitmask& other) noexcept {
90 m_value = m_value ^ other.m_value;
91 return *this;
92 }
93
94 template<typename Derived, Type::UnsignedEnum E>
95 constexpr void Bitmask<Derived, E>::Add(E value) noexcept {
96 m_value = m_value | value;
97 }
98
99 template<typename Derived, Type::UnsignedEnum E>
100 constexpr void Bitmask<Derived, E>::Remove(E value) noexcept {
101 m_value = m_value & ~value;
102 }
103
104 template<typename Derived, Type::UnsignedEnum E>
105 constexpr E Bitmask<Derived, E>::Value() const noexcept {
106 return m_value;
107 }
108
109 template<typename Derived, Type::UnsignedEnum E>
110 constexpr bool Bitmask<Derived, E>::Has(E value) const noexcept {
111 return (m_value & value) == value;
112 }
113
114 template<typename Derived, Type::UnsignedEnum E>
115 constexpr bool Bitmask<Derived, E>::Has(const Bitmask& other) const noexcept {
116 return Has(other.m_value);
117 }
118
119 template<typename Derived, Type::UnsignedEnum E>
120 constexpr bool Bitmask<Derived, E>::HasAny(E value) const noexcept {
121 return (m_value & value) != static_cast<E>(0);
122 }
123
124 template<typename Derived, Type::UnsignedEnum E>
125 constexpr bool Bitmask<Derived, E>::HasAny(const Bitmask& other) const noexcept {
126 return HasAny(other.m_value);
127 }
128
129 template<typename Derived, Type::UnsignedEnum E>
130 constexpr bool Bitmask<Derived, E>::HasNone(E value) const noexcept {
131 return (m_value & value) == static_cast<E>(0);
132 }
133
134 template<typename Derived, Type::UnsignedEnum E>
135 constexpr bool Bitmask<Derived, E>::HasNone(const Bitmask& other) const noexcept {
136 return HasNone(other.m_value);
137 }
138}