Skip to content

Add WI_MaskFlag/WI_RaiseFlag inline macros #469

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add WI_MaskFlag/WI_RaiseFlag inline macros #469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 31 additions & 13 deletions include/wil/common.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,22 +414,27 @@ check fails as opposed to the invalid parameter handler that the STL invokes. Th
//!
//! Common example usage (manipulation of flag variables):
//! ~~~~
//! WI_SetFlag(m_flags, MyFlags::Foo); // Set a single flag in the given variable
//! WI_SetAllFlags(m_flags, MyFlags::Foo | MyFlags::Bar); // Set one or more flags
//! WI_ClearFlagIf(m_flags, MyFlags::Bar, isBarClosed); // Conditionally clear a single flag based upon a bool
//! WI_ClearAllFlags(m_flags, MyFlags::Foo | MyFlags::Bar); // Clear one or more flags from the given variable
//! WI_ToggleFlag(m_flags, MyFlags::Foo); // Toggle (change to the opposite value) a single flag
//! WI_UpdateFlag(m_flags, MyFlags::Bar, isBarClosed); // Sets or Clears a single flag from the given variable based
//! // upon a bool value
//! WI_UpdateFlagsInMask(m_flags, flagsMask, newFlagValues); // Sets or Clears the flags in flagsMask to the masked values
//! // from newFlagValues
//! WI_SetFlag(m_flags, MyFlags::Foo); // Set a single flag in the given variable
//! WI_SetAllFlags(m_flags, MyFlags::Foo | MyFlags::Bar); // Set one or more flags
//! WI_ClearFlagIf(m_flags, MyFlags::Bar, isBarClosed); // Conditionally clear a single flag based upon a bool
//! WI_ClearAllFlags(m_flags, MyFlags::Foo | MyFlags::Bar); // Clear one or more flags from the given variable
//! WI_ToggleFlag(m_flags, MyFlags::Foo); // Toggle (change to the opposite value) a single flag
//! WI_UpdateFlag(m_flags, MyFlags::Bar, isBarClosed); // Sets or Clears a single flag from the given variable based
//! // upon a bool value
//! WI_UpdateFlagsInMask(m_flags, flagsMask, newFlagValues); // Sets or Clears the flags in flagsMask to the masked values
//! // from newFlagValues
//! ~~~~
//! Common example usage (inspection of flag variables):
//! ~~~~
//! if (WI_IsFlagSet(m_flags, MyFlags::Foo)) // Is a single flag set in the given variable?
//! if (WI_IsAnyFlagSet(m_flags, MyFlags::Foo | MyFlags::Bar)) // Is at least one flag from the given mask set?
//! if (WI_AreAllFlagsClear(m_flags, MyFlags::Foo | MyFlags::Bar)) // Are all flags in the given list clear?
//! if (WI_IsSingleFlagSet(m_flags)) // Is *exactly* one flag set in the given variable?
//! if (WI_IsFlagSet(m_flags, MyFlags::Foo)) // Is a single flag set in the given variable?
//! if (WI_IsAnyFlagSet(m_flags, MyFlags::Foo | MyFlags::Bar)) // Is at least one flag from the given mask set?
//! if (WI_AreAllFlagsClear(m_flags, MyFlags::Foo | MyFlags::Bar)) // Are all flags in the given list clear?
//! if (WI_IsSingleFlagSet(m_flags)) // Is *exactly* one flag set in the given variable?
//! ~~~~
//! Common example usage (masking/raising of flag(s) from variable):
//! ~~~~
//! SetFileAttributes(Path, WI_MaskFlag(Attr, FILE_ATTRIBUTE_READONLY)); // Mask flag inline without modifying the variable
//! SetFileAttributes(Path, WI_RaiseFlag(Attr, FILE_ATTRIBUTE_READONLY)); // Raise flag inline without modifying the variable
//! ~~~~
//! @{

Expand Down Expand Up @@ -512,6 +517,19 @@ check fails as opposed to the invalid parameter handler that the STL invokes. Th
#define WI_IsClearOrSingleFlagSetInMask(val, mask) wil::details::IsClearOrSingleFlagSetHelper((val) & (mask))
//! @} // bitwise inspection macros

//! @name Bitwise masking/raising macros
//! @{

//! Mask zero or more bitflags specified by `flags` from the variable `var`.
#define WI_MaskAllFlags(var, flags) ((var) & ~(flags))
//! Mask a single compile-time constant `flag` from the variable `var`.
#define WI_MaskFlag(var, flag) WI_MaskAllFlags(var, WI_StaticAssertSingleBitSet(flag))
//! Raise zero or more bitflags specified by `flags` from the variable `var`.
#define WI_RaiseAllFlags(var, flags) ((var) | (flags))
//! Raise a single compile-time constant `flag` from the variable `var`.
#define WI_RaiseFlag(var, flag) WI_RaiseAllFlags(var, WI_StaticAssertSingleBitSet(flag))
//! @} // bitwise masking/raising macros

//! @} // group bitwise

#if defined(WIL_DOXYGEN)
Expand Down
5 changes: 5 additions & 0 deletions tests/CommonTests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,11 @@ static void FlagsMacrosNonStatic(T none, T one, T two, T three, T four)
eval = one;
WI_ToggleAllFlags(MDEC(eval), MDEC(one | two));
REQUIRE(eval == two);

REQUIRE(WI_MaskFlag(MDEC(one | two | three), MDEC(two)) == (one | three));
REQUIRE(WI_MaskAllFlags(MDEC(one | two | three), MDEC(two | three)) == one);
REQUIRE(WI_RaiseFlag(MDEC(one | three), MDEC(two)) == (one | two | three));
REQUIRE(WI_RaiseAllFlag(MDEC(one), MDEC(two | three)) == (one | two | three));
}

enum class EClassTest
Expand Down
Loading