https://github.com/zhuagenborn/enum-flags
🚩 A header-only type-safe bit flag manager for C++ scoped enumerations written in C++23.
https://github.com/zhuagenborn/enum-flags
enum-flags scoped-enum
Last synced: 3 months ago
JSON representation
🚩 A header-only type-safe bit flag manager for C++ scoped enumerations written in C++23.
- Host: GitHub
- URL: https://github.com/zhuagenborn/enum-flags
- Owner: Zhuagenborn
- License: mit
- Created: 2024-09-29T12:48:48.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-11-25T07:05:30.000Z (6 months ago)
- Last Synced: 2025-01-02T11:11:50.714Z (5 months ago)
- Topics: enum-flags, scoped-enum
- Language: C++
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# *C++* Enumeration Bit Flags
[](https://cmake.org)
## Introduction
A header-only type-safe bit flag manager for *C++* scoped enumerations written in *C++23*.
## Unit Tests
### Prerequisites
- Install *GoogleTest*.
- Install *CMake*.
### Building
Go to the project folder and run:
```bash
mkdir -p build
cd build
cmake ..
cmake --build .
```
### Running
Go to the `build` folder and run:
```bash
ctest -VV
```
## Examples
See more examples in `tests/enum_flags_tests.cpp`.
```c++
enum class Opt : unsigned int {
A = EnumFlags::CreateFlag(0),
B = EnumFlags::CreateFlag(1),
C = EnumFlags::CreateFlag(2),
D = EnumFlags::CreateFlag(3),
E = EnumFlags::CreateFlag(4)
};
```
```c++
const EnumFlags flags {Opt::A, Opt::B, Opt::C};
EXPECT_TRUE(flags & Opt::A);
EXPECT_FALSE(flags & Opt::D);
EXPECT_TRUE(flags.HasAny({Opt::A, Opt::D}));
EXPECT_FALSE(flags.HasAny({Opt::D, Opt::E}));
EXPECT_TRUE(flags.HasAll({Opt::A, Opt::B}));
EXPECT_TRUE((flags & EnumFlags {Opt::A, Opt::B}));
EXPECT_FALSE(flags.HasAll({Opt::C, Opt::D}));
EXPECT_FALSE((flags & EnumFlags {Opt::C, Opt::D}));
```
```c++
EnumFlags flags;
EXPECT_FALSE(flags & Opt::A);
flags |= Opt::A;
EXPECT_TRUE(flags & Opt::A);
const auto new_flags {flags | Opt::D};
EXPECT_TRUE(new_flags & Opt::D);
```
```c++
EnumFlags flags {Opt::A, Opt::B, Opt::C};
EXPECT_TRUE(flags & Opt::C);
flags.Remove(Opt::C);
EXPECT_FALSE(flags & Opt::C);
```
## License
Distributed under the *MIT License*. See `LICENSE` for more information.