ROSE  0.9.11.145
Public Types | Public Member Functions | List of all members
Rose::BitFlags< E, V > Class Template Reference

Description

template<typename E, typename V = int64_t>
class Rose::BitFlags< E, V >

Stores a vector of enum bit flags.

This is a more self-documenting and terse way to use bit flags. For example, consider this original code:

class TableCharacter {
enum Corner { NONE = 0, LEFT = 1, RIGHT = 2, TOP = 4, BOTTOM = 8 };
unsigned current; // bit vector of Corner flags for current character
unsigned previous; // bit vector of Corner flags for previous character
TableCharacter(): current(NONE), previous(NONE) {}
void process(unsigned next) { // next is vector of Corner bit flags
if ((current & LEFT) != 0) {
previous |= LEFT;
current &= ~LEFT;
}
if ((next & TOP) == 0) {
current &= ~TOP;
current |= BOTTOM;
}
}
};

Now rewritten to use this class:

class TableCharacter {
enum Corner { NONE = 0, LEFT = 1, RIGHT = 2, TOP = 4, BOTTOM = 8 };
BitFlags<Corner> current;
BitFlags<Corner> previous;
TableCharacters(): current(NONE), previous(NONE) {}
void process(BitFlags<Corner> next) {
if (current.testAndClear(LEFT))
previous.set(LEFT);
if (next.isClear(TOP))
current.clear(TOP).set(BOTTOM);
}
};

Definition at line 59 of file BitFlags.h.

#include <BitFlags.h>

Inheritance diagram for Rose::BitFlags< E, V >:
Inheritance graph
[legend]

Public Types

typedef E Enum
 
typedef V Vector
 

Public Member Functions

 BitFlags ()
 Default constructor with all bits clear. More...
 
 BitFlags (Vector v)
 Construct bit vector from value or bit. More...
 
Vector vector () const
 Current value of the bit vector. More...
 
bool isSet (Enum e) const
 Test whether a bit is set. More...
 
bool isAllSet (BitFlags other) const
 True if all specified bits are set. More...
 
bool isAnySet (BitFlags other) const
 True if any of the specified bits are set. More...
 
bool isAnySet () const
 True if any bit is set. More...
 
bool isClear (Enum e) const
 Test whether a bit is clear. More...
 
BitFlagsset (Enum e)
 Set the specified bit. More...
 
BitFlagsset (BitFlags other)
 Set all bits that are set in other. More...
 
BitFlagsclear (Enum e)
 Clear the specified bit. More...
 
BitFlagsclear (BitFlags other)
 Clear all bits that are set in other. More...
 
BitFlagsclear ()
 Clear all bits. More...
 
bool testAndClear (Enum e)
 Test whether a bit is set, then clear it. More...
 
bool testAndSet (Enum e)
 Test whether a bit is set, then set it. More...
 
BitFlagsoperator= (Vector v)
 Set the vector to an exact value. More...
 
BitFlagsoperator= (BitFlags other)
 Set the vector to the same as another. More...
 
std::vector< Enum > split (std::vector< int64_t > constants, Vector &leftovers) const
 Split a vector into the individual enum values. More...
 
std::string toString (std::vector< int64_t > constants, const char *(*stringifier)(int64_t)) const
 Convert to string. More...
 
BitFlags operator| (BitFlags other) const
 Create a new vector that's the union of two vectors.
 
BitFlags operator| (Enum e) const
 Create a new vector that's the union of two vectors.
 
BitFlags intersection (BitFlags other) const
 Create a new vector that's the intersection of two vectors.
 
BitFlags intersection (Enum e) const
 Create a new vector that's the intersection of two vectors.
 
BitFlags operator& (BitFlags other) const
 Create a new vector that's the intersection of two vectors.
 
BitFlags operator& (Enum e) const
 Create a new vector that's the intersection of two vectors.
 
bool operator== (BitFlags other) const
 Compare two vectors.
 
bool operator!= (BitFlags other) const
 Compare two vectors.
 
bool operator< (BitFlags other) const
 Compare two vectors.
 
bool operator<= (BitFlags other) const
 Compare two vectors.
 
bool operator> (BitFlags other) const
 Compare two vectors.
 
bool operator>= (BitFlags other) const
 Compare two vectors.
 

Constructor & Destructor Documentation

template<typename E, typename V = int64_t>
Rose::BitFlags< E, V >::BitFlags ( )
inline

Default constructor with all bits clear.

Definition at line 79 of file BitFlags.h.

template<typename E, typename V = int64_t>
Rose::BitFlags< E, V >::BitFlags ( Vector  v)
inline

Construct bit vector from value or bit.

Definition at line 83 of file BitFlags.h.

Member Function Documentation

template<typename E, typename V = int64_t>
Vector Rose::BitFlags< E, V >::vector ( ) const
inline

Current value of the bit vector.

Definition at line 87 of file BitFlags.h.

template<typename E, typename V = int64_t>
bool Rose::BitFlags< E, V >::isSet ( Enum  e) const
inline
template<typename E, typename V = int64_t>
bool Rose::BitFlags< E, V >::isAllSet ( BitFlags< E, V >  other) const
inline

True if all specified bits are set.

Definition at line 97 of file BitFlags.h.

template<typename E, typename V = int64_t>
bool Rose::BitFlags< E, V >::isAnySet ( BitFlags< E, V >  other) const
inline

True if any of the specified bits are set.

Definition at line 102 of file BitFlags.h.

template<typename E, typename V = int64_t>
bool Rose::BitFlags< E, V >::isAnySet ( ) const
inline

True if any bit is set.

Definition at line 107 of file BitFlags.h.

template<typename E, typename V = int64_t>
bool Rose::BitFlags< E, V >::isClear ( Enum  e) const
inline

Test whether a bit is clear.

Definition at line 112 of file BitFlags.h.

template<typename E, typename V = int64_t>
BitFlags& Rose::BitFlags< E, V >::set ( Enum  e)
inline

Set the specified bit.

Definition at line 117 of file BitFlags.h.

Referenced by Rose::BitFlags< Reason, uint32_t >::testAndSet().

template<typename E, typename V = int64_t>
BitFlags& Rose::BitFlags< E, V >::set ( BitFlags< E, V >  other)
inline

Set all bits that are set in other.

Definition at line 123 of file BitFlags.h.

template<typename E, typename V = int64_t>
BitFlags& Rose::BitFlags< E, V >::clear ( Enum  e)
inline

Clear the specified bit.

Definition at line 129 of file BitFlags.h.

template<typename E, typename V = int64_t>
BitFlags& Rose::BitFlags< E, V >::clear ( BitFlags< E, V >  other)
inline

Clear all bits that are set in other.

Definition at line 135 of file BitFlags.h.

template<typename E, typename V = int64_t>
BitFlags& Rose::BitFlags< E, V >::clear ( )
inline

Clear all bits.

Definition at line 141 of file BitFlags.h.

Referenced by Rose::BitFlags< Reason, uint32_t >::testAndClear().

template<typename E, typename V = int64_t>
bool Rose::BitFlags< E, V >::testAndClear ( Enum  e)
inline

Test whether a bit is set, then clear it.

Definition at line 147 of file BitFlags.h.

template<typename E, typename V = int64_t>
bool Rose::BitFlags< E, V >::testAndSet ( Enum  e)
inline

Test whether a bit is set, then set it.

Definition at line 154 of file BitFlags.h.

template<typename E, typename V = int64_t>
BitFlags& Rose::BitFlags< E, V >::operator= ( Vector  v)
inline

Set the vector to an exact value.

Definition at line 161 of file BitFlags.h.

template<typename E, typename V = int64_t>
BitFlags& Rose::BitFlags< E, V >::operator= ( BitFlags< E, V >  other)
inline

Set the vector to the same as another.

Definition at line 167 of file BitFlags.h.

template<typename E, typename V = int64_t>
std::vector<Enum> Rose::BitFlags< E, V >::split ( std::vector< int64_t >  constants,
Vector &  leftovers 
) const
inline

Split a vector into the individual enum values.

The enum constants are first sorted so that those with more set bits appear before those with fewer bits. Then each constant is searched in the bit vector and those bits are removed. This continues until either no bits remain or no matching constant is found. The leftovers is set to those bits that could not be matched by this process.

Definition at line 228 of file BitFlags.h.

Referenced by Rose::BitFlags< Reason, uint32_t >::toString().

template<typename E, typename V = int64_t>
std::string Rose::BitFlags< E, V >::toString ( std::vector< int64_t >  constants,
const char *(*)(int64_t)  stringifier 
) const
inline

Convert to string.

Converts a bit vector to a string of the form "NAME1|NAME2|...". The constants are the individual enum flags, and the stringifier is a function that converts each of those constants to strings.

Definition at line 254 of file BitFlags.h.


The documentation for this class was generated from the following file: