corysanin/tubestation
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Bug 1865896 - Add ToString function to DefineEnum r=padenot

Browse Source 
This patch addes some macros to implement to-string helpers for enums.

Differential Revision: https://phabricator.services.mozilla.com/D194260
This commit is contained in:
Chun-Min Chang
2024-07-31 00:09:52 +00:00
parent e6fde42e6b
commit 74c5079039
1 changed files with 63 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
mfbt/DefineEnum.h
View File

@@ -10,6 +10,7 @@
#define mozilla_DefineEnum_h #define mozilla_DefineEnum_h
#include <stddef.h> // for size_t #include <stddef.h> // for size_t
#include <ostream> // for std::ostream
#include "mozilla/MacroArgs.h" // for MOZ_ARG_COUNT #include "mozilla/MacroArgs.h" // for MOZ_ARG_COUNT
#include "mozilla/MacroForEach.h" // for MOZ_FOR_EACH #include "mozilla/MacroForEach.h" // for MOZ_FOR_EACH
@@ -84,6 +85,14 @@
* and have names prefixed with "s" instead of "k" as per * and have names prefixed with "s" instead of "k" as per
* naming convention. * naming convention.
* *
* - A |_TOSTRING| variant, which generates an EnumValueToString function,
* converting the enum items to strings, and implements an "operator<<",
* providing a consistent way to convert enums to strings by
* mozilla::ToString function regardless of their definition context.
* For users needing C-string compatibility for logging in restricted
* contexts or performance sensitive applications, EnumValueToString is
* preferred.
*
* (and combinations of these). * (and combinations of these).
*/ */
@@ -153,4 +162,58 @@
MOZ_DEFINE_ENUM_AT_CLASS_SCOPE_IMPL(aEnumName, class, \ MOZ_DEFINE_ENUM_AT_CLASS_SCOPE_IMPL(aEnumName, class, \
: aBaseName, aEnumerators) : aBaseName, aEnumerators)
#define MOZ_DEFINE_ENUM_TO_ENUM_TEXT(aEnumeratorDecl) #aEnumeratorDecl
#define MOZ_DEFINE_ENUM_TOSTRING_FUNC_IMPL(aEnumName, aEnumerators, aFriend) \
inline static const char* EnumValueToString(const aEnumName& aEnum) { \
static constexpr const char* kMappedStrings[] = {MOZ_FOR_EACH_SEPARATED( \
MOZ_DEFINE_ENUM_TO_ENUM_TEXT, (, ), (), aEnumerators)}; \
return kMappedStrings[static_cast<size_t>(aEnum)]; \
} \
aFriend inline std::ostream& operator<<(std::ostream& aStream, \
const aEnumName& aEnum) { \
aStream << EnumValueToString(aEnum); \
return aStream; \
}
#define MOZ_DEFINE_ENUM_TOSTRING_FUNC(aEnumName, aEnumerators) \
MOZ_DEFINE_ENUM_TOSTRING_FUNC_IMPL(aEnumName, aEnumerators, )
#define MOZ_DEFINE_ENUM_TOSTRING_FUNC_IN_CLASS(aEnumName, aEnumerators) \
MOZ_DEFINE_ENUM_TOSTRING_FUNC_IMPL(aEnumName, aEnumerators, friend)
#define MOZ_DEFINE_ENUM_WITH_BASE_AND_TOSTRING(aEnumName, aBaseName, \
aEnumerators) \
MOZ_DEFINE_ENUM_WITH_BASE(aEnumName, aBaseName, aEnumerators) \
MOZ_DEFINE_ENUM_TOSTRING_FUNC(aEnumName, aEnumerators)
#define MOZ_DEFINE_ENUM_CLASS_WITH_TOSTRING(aEnumName, aEnumerators) \
MOZ_DEFINE_ENUM_CLASS(aEnumName, aEnumerators) \
MOZ_DEFINE_ENUM_TOSTRING_FUNC(aEnumName, aEnumerators)
#define MOZ_DEFINE_ENUM_CLASS_WITH_BASE_AND_TOSTRING(aEnumName, aBaseName, \
aEnumerators) \
MOZ_DEFINE_ENUM_CLASS_WITH_BASE(aEnumName, aBaseName, aEnumerators) \
MOZ_DEFINE_ENUM_TOSTRING_FUNC(aEnumName, aEnumerators)
#define MOZ_DEFINE_ENUM_WITH_TOSTRING_AT_CLASS_SCOPE(aEnumName, aEnumerators) \
MOZ_DEFINE_ENUM_AT_CLASS_SCOPE(aEnumName, aEnumerators) \
MOZ_DEFINE_ENUM_TOSTRING_FUNC_IN_CLASS(aEnumName, aEnumerators)
#define MOZ_DEFINE_ENUM_WITH_BASE_AND_TOSTRING_AT_CLASS_SCOPE( \
aEnumName, aBaseName, aEnumerators) \
MOZ_DEFINE_ENUM_WITH_BASE_AT_CLASS_SCOPE(aEnumName, aBaseName, aEnumerators) \
MOZ_DEFINE_ENUM_TOSTRING_FUNC_IN_CLASS(aEnumName, aEnumerators)
#define MOZ_DEFINE_ENUM_CLASS_WITH_TOSTRING_AT_CLASS_SCOPE(aEnumName, \
aEnumerators) \
MOZ_DEFINE_ENUM_CLASS_AT_CLASS_SCOPE(aEnumName, aEnumerators) \
MOZ_DEFINE_ENUM_TOSTRING_FUNC_IN_CLASS(aEnumName, aEnumerators)
#define MOZ_DEFINE_ENUM_CLASS_WITH_BASE_AND_TOSTRING_AT_CLASS_SCOPE( \
aEnumName, aBaseName, aEnumerators) \
MOZ_DEFINE_ENUM_CLASS_WITH_BASE_AT_CLASS_SCOPE(aEnumName, aBaseName, \
aEnumerators) \
MOZ_DEFINE_ENUM_TOSTRING_FUNC_IN_CLASS(aEnumName, aEnumerators)
#endif // mozilla_DefineEnum_h #endif // mozilla_DefineEnum_h