https://github.com/grisumbras/enum-flags

Bit flags for C++11 scoped enums
https://github.com/grisumbras/enum-flags

bit-flag bit-mask c-plus-plus scoped-enum

Last synced: about 2 months ago
JSON representation

Bit flags for C++11 scoped enums

• Host: GitHub
• URL: https://github.com/grisumbras/enum-flags
• Owner: grisumbras
• License: mit
• Created: 2014-08-01T20:21:02.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-08-19T10:52:46.000Z (over 2 years ago)
• Last Synced: 2024-10-20T18:32:20.911Z (about 2 months ago)
• Topics: bit-flag, bit-mask, c-plus-plus, scoped-enum
• Language: C++
• Homepage:
• Size: 2.53 MB
• Stars: 119
• Watchers: 13
• Forks: 20
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• AwesomeCppGameDev - enum-flags

README

        
# enum-flags

[![Download](https://api.bintray.com/packages/grisumbras/conan/enum-flags:grisumbras/images/download.svg?version=0.1.0:testing) ](https://bintray.com/grisumbras/conan/enum-flags:grisumbras/0.1.0:testing/link)

![Build Status](https://github.com/grisumbras/enum-flags/workflows/publish/badge.svg)

![License](https://img.shields.io/github/license/grisumbras/enum-flags.svg)

> Bit flags for C++ scoped enums

C++ 11 added a new type of enums — *enum classes*.

These are strongly typed enumerations, they do not cast implicitly to or from

the underlying integer type. They also do not leak enumeration values to

enclosing scope (thus the names of this values do not clash and you no longer

need to prefix/suffix them with something to disambiguate).

The only drawback to type safety is you cannot treat variables of *enum class*

types as sets of flags. That is because *enum classes* do not cast to integers

and there are no bitwise operators overloads defined for them.

This library brings a `flags` class template which provides bit flags for

scoped enums.

## Install

### Using Conan

Add required remote:

```shell

$ conan remote add grisumbras https://api.bintray.com/conan/grisumbras/conan

```

Use inside `conanfile.txt`:

```ini

[requires]

enum-flags/[>=0.1]@grisumbras/testing

```

### Installing from source

Download source code and run from inside the project root:

```shell

$ b2 install --prefix=/path/to/installation/prefix

```

## Usage

``` c++

#include 

enum class MyEnum { Value1 = 1 << 0, Value2 = 1 << 1 };

ALLOW_FLAGS_FOR_ENUM(MyEnum)

int main() {

  auto mask1 = MyEnum::Value1 | MyEnum::Value2; // set flags Value1 and Value 2

  if (mask1 & MyEnum::Value2) { // if Value2 flag is set

    /* ... */

  }

}

```

More info can be found in the [docs](http://grisumbras.github.io/enum-flags/).

## Maintainer

Dmitry Arkhipov 

## Contributing

Patches welcome!

## License

[MIT (C) Dmitry Arkhipov.](LICENSE)