bitmask_operators.h File Reference

Support of bitwise operations for compatible enum classes. More...

Go to the source code of this file.

Classes
struct	hermes::EnableBitMaskOperators< Enum >
	Wrapper struct to add bitwise operations to enum class. More...

Macros
#define	HERMES_ENABLE_BITMASK_OPERATORS(x)
	Adds bitwise operation support to a given enum class. More...
#define	HERMES_MASK_BIT(MASK, BIT)   (((MASK) & (BIT)) == (BIT))
	Tests if enum class value is enabled. More...

Functions
template<typename Enum >
HERMES_DEVICE_CALLABLE std::enable_if< EnableBitMaskOperators< Enum >::enable, Enum >::type	hermes::operator| (Enum lhs, Enum rhs) noexcept
template<typename Enum >
HERMES_DEVICE_CALLABLE std::enable_if< EnableBitMaskOperators< Enum >::enable, Enum >::type	hermes::operator& (Enum lhs, Enum rhs)
template<typename Enum >
HERMES_DEVICE_CALLABLE std::enable_if< EnableBitMaskOperators< Enum >::enable, Enum >::type	hermes::operator^ (Enum lhs, Enum rhs)
	adds ^ operation support More...
template<typename Enum >
HERMES_DEVICE_CALLABLE std::enable_if< EnableBitMaskOperators< Enum >::enable, Enum >::type	hermes::operator~ (Enum rhs)
	adds ~ operation support More...

Detailed Description

Support of bitwise operations for compatible enum classes.

Copyright (c) 2020, FilipeCN.

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Author

FilipeCN (filip.nosp@m.edec.nosp@m.n@gma.nosp@m.il.c.nosp@m.om)

Date

2020-14-08

Macro Definition Documentation

HERMES_ENABLE_BITMASK_OPERATORS

#define HERMES_ENABLE_BITMASK_OPERATORS

(

x

)

Value:

template<>                           \
struct EnableBitMaskOperators<x>     \
{                                    \
    static const bool enable = true; \
}

Adds bitwise operation support to a given enum class.

// Suppose you have an enum class object
enum class Permissions {
   Readable   = 0x4,
   Writeable  = 0x2,
   Executable = 0x1
};
// and you want to do things like this
Permissions p = Permissions::Readable | Permissions::Writable;

Then, just call this macro after you enum class declaration:

enum class Permissions {..};
HERMES_ENABLE_BITMASK_OPERATORS(Permissions);

Precondition

The enum class underlying type must support such operations

Parameters

x	enum class name

HERMES_MASK_BIT

#define HERMES_MASK_BIT	(		MASK,
			BIT
	)		(((MASK) & (BIT)) == (BIT))

Tests if enum class value is enabled.

• Example:

  enum class Permissions {
     Readable   = 0x4,
     Writeable  = 0x2,
     Executable = 0x1
  };
  HERMES_ENABLE_BITMASK_OPERATORS(Permissions);
  void function() {
      Permissions p = Permissions::Readable | Permissions::Writable;
      // you can check if Permissions::Executable is in p
      if(HERMES_MASK_BIT(p, Permissions::Executable)) {}
  }

Parameters

MASK	enum class instance object
BIT	set of values to be looked in MASK

Function Documentation

operator&()

template<typename Enum >

HERMES_DEVICE_CALLABLE std::enable_if<EnableBitMaskOperators<Enum>::enable, Enum>::type hermes::operator&	(	Enum	lhs,
		Enum	rhs
	)

adds & operation support

Template Parameters

Enum

Parameters

lhs
rhs

Returns

underlying enum data type

operator^()

template<typename Enum >

HERMES_DEVICE_CALLABLE std::enable_if<EnableBitMaskOperators<Enum>::enable, Enum>::type hermes::operator^	(	Enum	lhs,
		Enum	rhs
	)

adds ^ operation support

Template Parameters

Enum

Parameters

lhs
rhs

Returns

operator|()

template<typename Enum >

HERMES_DEVICE_CALLABLE std::enable_if<EnableBitMaskOperators<Enum>::enable, Enum>::type hermes::operator| ( Enum  lhs, Enum  rhs  )

noexcept

adds | operation support

Template Parameters

Enum

Parameters

lhs
rhs

Returns

underlying enum data type

operator~()

template<typename Enum >

HERMES_DEVICE_CALLABLE std::enable_if<EnableBitMaskOperators<Enum>::enable, Enum>::type hermes::operator~

(

Enum

rhs

)

adds ~ operation support

Template Parameters

Enum

Parameters

rhs

Returns

underlying enum data type