Skip to content

refactor(bitflags): Simplify functions in BitFlags class #2472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xezon wants to merge 5 commits into
base: main
Choose a base branch
from
+32 −90
Open

refactor(bitflags): Simplify functions in BitFlags class #2472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d7732d7
refactor(bitflags): Simplify functions in BitFlags class
xezon Mar 18, 2026
7977d13
Simplify more
xezon Mar 19, 2026
d984f7d
Replicate in Generals
xezon Mar 19, 2026
f522b8a
Simplify argument names
xezon Mar 19, 2026
d5e6a22
Remove the assert
xezon Mar 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 16 additions & 45 deletions Generals/Code/GameEngine/Include/Common/BitFlags.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,12 +126,12 @@ class BitFlags

Bool operator==(const BitFlags& that) const
{
return this->m_bits == that.m_bits;
return m_bits == that.m_bits;
}

Bool operator!=(const BitFlags& that) const
{
return this->m_bits != that.m_bits;
return m_bits != that.m_bits;
}

void set(Int i, Int val = 1)
Expand All @@ -147,28 +147,19 @@ class BitFlags
//Tests for any bits that are set in both.
Bool testForAny( const BitFlags& that ) const
{
BitFlags tmp = *this;
tmp.m_bits &= that.m_bits;
return tmp.m_bits.any();
return (m_bits & that.m_bits).any();
}

//All argument bits must be set in our bits too in order to return TRUE
Bool testForAll( const BitFlags& that ) const
{
DEBUG_ASSERTCRASH( that.any(), ("BitFlags::testForAll is always true if you ask about zero flags. Did you mean that?") );

BitFlags tmp = *this;
tmp.m_bits.flip();
tmp.m_bits &= that.m_bits;
return !tmp.m_bits.any();
return (m_bits & that.m_bits) == that.m_bits;
}

//None of the argument bits must be set in our bits in order to return TRUE
Bool testForNone( const BitFlags& that ) const
{
BitFlags tmp = *this;
tmp.m_bits &= that.m_bits;
return !tmp.m_bits.any();
return (m_bits & that.m_bits).none();
}

Int size() const
Expand Down Expand Up @@ -198,58 +189,38 @@ class BitFlags

Int countIntersection(const BitFlags& that) const
{
BitFlags tmp = *this;
tmp.m_bits &= that.m_bits;
return tmp.m_bits.count();
return (m_bits & that.m_bits).count();
}

Int countInverseIntersection(const BitFlags& that) const
{
BitFlags tmp = *this;
tmp.m_bits.flip();
tmp.m_bits &= that.m_bits;
return tmp.m_bits.count();
return (~m_bits & that.m_bits).count();
}

Bool anyIntersectionWith(const BitFlags& that) const
{
/// @todo srj -- improve me.
BitFlags tmp = that;
tmp.m_bits &= m_bits;
return tmp.m_bits.any();
return (m_bits & that.m_bits).any();
}

void clear(const BitFlags& clr)
void clear(const BitFlags& that)
{
m_bits &= ~clr.m_bits;
m_bits &= ~that.m_bits;
}

void set(const BitFlags& set)
void set(const BitFlags& that)
{
m_bits |= set.m_bits;
m_bits |= that.m_bits;
}

void clearAndSet(const BitFlags& clr, const BitFlags& set)
void clearAndSet(const BitFlags& flagsToClear, const BitFlags& flagsToSet)
{
m_bits &= ~clr.m_bits;
m_bits |= set.m_bits;
clear(flagsToClear);
set(flagsToSet);
}

Bool testSetAndClear(const BitFlags& mustBeSet, const BitFlags& mustBeClear) const
{
/// @todo srj -- improve me.
BitFlags tmp = *this;
tmp.m_bits &= mustBeClear.m_bits;
if (tmp.m_bits.any())
return false;

tmp = *this;
tmp.m_bits.flip();
tmp.m_bits &= mustBeSet.m_bits;
if (tmp.m_bits.any())
return false;

return true;
return testForNone(mustBeClear) && testForAll(mustBeSet);
}

// TheSuperHackers @info Function for rare use cases where we must access the flags as an integer.
Expand Down
61 changes: 16 additions & 45 deletions GeneralsMD/Code/GameEngine/Include/Common/BitFlags.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,12 +126,12 @@ class BitFlags

Bool operator==(const BitFlags& that) const
{
return this->m_bits == that.m_bits;
return m_bits == that.m_bits;
}

Bool operator!=(const BitFlags& that) const
{
return this->m_bits != that.m_bits;
return m_bits != that.m_bits;
}

void set(Int i, Int val = 1)
Expand All @@ -147,28 +147,19 @@ class BitFlags
//Tests for any bits that are set in both.
Bool testForAny( const BitFlags& that ) const
{
BitFlags tmp = *this;
tmp.m_bits &= that.m_bits;
return tmp.m_bits.any();
return (m_bits & that.m_bits).any();
}

//All argument bits must be set in our bits too in order to return TRUE
Bool testForAll( const BitFlags& that ) const
{
DEBUG_ASSERTCRASH( that.any(), ("BitFlags::testForAll is always true if you ask about zero flags. Did you mean that?") );

BitFlags tmp = *this;
tmp.m_bits.flip();
tmp.m_bits &= that.m_bits;
return !tmp.m_bits.any();
return (m_bits & that.m_bits) == that.m_bits;
}

//None of the argument bits must be set in our bits in order to return TRUE
Bool testForNone( const BitFlags& that ) const
{
BitFlags tmp = *this;
tmp.m_bits &= that.m_bits;
return !tmp.m_bits.any();
return (m_bits & that.m_bits).none();
}

Int size() const
Expand Down Expand Up @@ -198,58 +189,38 @@ class BitFlags

Int countIntersection(const BitFlags& that) const
{
BitFlags tmp = *this;
tmp.m_bits &= that.m_bits;
return tmp.m_bits.count();
return (m_bits & that.m_bits).count();
}

Int countInverseIntersection(const BitFlags& that) const
{
BitFlags tmp = *this;
tmp.m_bits.flip();
tmp.m_bits &= that.m_bits;
return tmp.m_bits.count();
return (~m_bits & that.m_bits).count();
}

Bool anyIntersectionWith(const BitFlags& that) const
{
/// @todo srj -- improve me.
BitFlags tmp = that;
tmp.m_bits &= m_bits;
return tmp.m_bits.any();
return (m_bits & that.m_bits).any();
}

void clear(const BitFlags& clr)
void clear(const BitFlags& that)
{
m_bits &= ~clr.m_bits;
m_bits &= ~that.m_bits;
}

void set(const BitFlags& set)
void set(const BitFlags& that)
{
m_bits |= set.m_bits;
m_bits |= that.m_bits;
}

void clearAndSet(const BitFlags& clr, const BitFlags& set)
void clearAndSet(const BitFlags& flagsToClear, const BitFlags& flagsToSet)
{
m_bits &= ~clr.m_bits;
m_bits |= set.m_bits;
clear(flagsToClear);
set(flagsToSet);
}

Bool testSetAndClear(const BitFlags& mustBeSet, const BitFlags& mustBeClear) const
{
/// @todo srj -- improve me.
BitFlags tmp = *this;
tmp.m_bits &= mustBeClear.m_bits;
if (tmp.m_bits.any())
return false;

tmp = *this;
tmp.m_bits.flip();
tmp.m_bits &= mustBeSet.m_bits;
if (tmp.m_bits.any())
return false;

return true;
return testForNone(mustBeClear) && testForAll(mustBeSet);
}

// TheSuperHackers @info Function for rare use cases where we must access the flags as an integer.
Expand Down
Loading