TrinityCore
SmartEnum.h
Go to the documentation of this file.
1/*
2 * This file is part of the TrinityCore Project. See AUTHORS file for Copyright information
3 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the
6 * Free Software Foundation; either version 2 of the License, or (at your
7 * option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
13 *
14 * You should have received a copy of the GNU General Public License along
15 * with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17
18#ifndef TRINITY_SMARTENUM_H
19#define TRINITY_SMARTENUM_H
20
21#include "IteratorPair.h"
22#include <iterator>
23
25{
26 EnumText(char const* c, char const* t, char const* d) : Constant(c), Title(t), Description(d) { }
27 // Enum constant of the value
28 char const* const Constant;
29 // Human-readable title of the value
30 char const* const Title;
31 // Human-readable description of the value
32 char const* const Description;
33};
34
36{
37 template <typename Enum>
38 struct EnumUtils
39 {
40 static size_t Count();
41 static EnumText ToString(Enum value);
42 static Enum FromIndex(size_t index);
43 static size_t ToIndex(Enum index);
44 };
45}
46
48{
49 public:
50 template <typename Enum>
52 template <typename Enum>
54 template <typename Enum>
55 static Enum FromIndex(size_t index) { return Trinity::Impl::EnumUtilsImpl::EnumUtils<Enum>::FromIndex(index); }
56 template <typename Enum>
58
59 template<typename Enum>
60 static bool IsValid(Enum value)
61 {
62 try
63 {
65 return true;
66 } catch (...)
67 {
68 return false;
69 }
70 }
71
72 template<typename Enum>
73 static bool IsValid(std::underlying_type_t<Enum> value) { return IsValid(static_cast<Enum>(value)); }
74
75 template <typename Enum>
77 {
78 public:
79 using iterator_category = std::random_access_iterator_tag;
80 using value_type = Enum;
81 using pointer = Enum*;
82 using reference = Enum&;
83 using difference_type = std::ptrdiff_t;
84
85 Iterator() : _index(EnumUtils::Count<Enum>()) {}
86 explicit Iterator(size_t index) : _index(index) { }
87
88 bool operator==(const Iterator& other) const = default;
89 std::strong_ordering operator<=>(const Iterator& other) const = default;
90
91 difference_type operator-(Iterator const& other) const { return _index - other._index; }
92
93 value_type operator[](difference_type d) const { return FromIndex<Enum>(_index + d); }
94 value_type operator*() const { return operator[](0); }
95
96 Iterator& operator+=(difference_type d) { _index += d; return *this; }
97 Iterator& operator++() { return operator+=(1); }
98 Iterator operator++(int) { Iterator i = *this; operator++(); return i; }
99 Iterator operator+(difference_type d) const { Iterator i = *this; i += d; return i; }
100
101 Iterator& operator-=(difference_type d) { _index -= d; return *this; }
103 Iterator operator--(int) { Iterator i = *this; operator--(); return i; }
104 Iterator operator-(difference_type d) const { Iterator i = *this; i -= d; return i; }
105
106 private:
108 };
109
110 template <typename Enum>
111 static Iterator<Enum> Begin() { return Iterator<Enum>(0); }
112
113 template <typename Enum>
114 static Iterator<Enum> End() { return Iterator<Enum>(); }
115
116 template <typename Enum>
117 static Trinity::IteratorPair<Iterator<Enum>> Iterate() { return { Begin<Enum>(), End<Enum>() }; }
118
119 template <typename Enum>
120 static char const* ToConstant(Enum value) { return ToString(value).Constant; }
121
122 template <typename Enum>
123 static char const* ToTitle(Enum value) { return ToString(value).Title; }
124
125 template <typename Enum>
126 static char const* ToDescription(Enum value) { return ToString(value).Description; }
127};
128
129#endif
uint32_t uint32
Definition: Define.h:142
Iterator & operator+=(difference_type d)
Definition: SmartEnum.h:96
bool operator==(const Iterator &other) const =default
Iterator & operator--()
Definition: SmartEnum.h:102
Iterator operator++(int)
Definition: SmartEnum.h:98
value_type operator*() const
Definition: SmartEnum.h:94
std::ptrdiff_t difference_type
Definition: SmartEnum.h:83
difference_type _index
Definition: SmartEnum.h:107
std::random_access_iterator_tag iterator_category
Definition: SmartEnum.h:79
Iterator & operator-=(difference_type d)
Definition: SmartEnum.h:101
Iterator operator-(difference_type d) const
Definition: SmartEnum.h:104
std::strong_ordering operator<=>(const Iterator &other) const =default
Iterator operator+(difference_type d) const
Definition: SmartEnum.h:99
Iterator & operator++()
Definition: SmartEnum.h:97
Iterator(size_t index)
Definition: SmartEnum.h:86
value_type operator[](difference_type d) const
Definition: SmartEnum.h:93
Iterator operator--(int)
Definition: SmartEnum.h:103
difference_type operator-(Iterator const &other) const
Definition: SmartEnum.h:91
static Trinity::IteratorPair< Iterator< Enum > > Iterate()
Definition: SmartEnum.h:117
static uint32 ToIndex(Enum value)
Definition: SmartEnum.h:57
static EnumText ToString(Enum value)
Definition: SmartEnum.h:53
static size_t Count()
Definition: SmartEnum.h:51
static bool IsValid(Enum value)
Definition: SmartEnum.h:60
static Enum FromIndex(size_t index)
Definition: SmartEnum.h:55
static char const * ToConstant(Enum value)
Definition: SmartEnum.h:120
static char const * ToDescription(Enum value)
Definition: SmartEnum.h:126
static bool IsValid(std::underlying_type_t< Enum > value)
Definition: SmartEnum.h:73
static Iterator< Enum > Begin()
Definition: SmartEnum.h:111
static char const * ToTitle(Enum value)
Definition: SmartEnum.h:123
static Iterator< Enum > End()
Definition: SmartEnum.h:114
Utility class to enable range for loop syntax for multimap.equal_range uses.
Definition: IteratorPair.h:32
char const *const Constant
Definition: SmartEnum.h:28
char const *const Title
Definition: SmartEnum.h:30
EnumText(char const *c, char const *t, char const *d)
Definition: SmartEnum.h:26
char const *const Description
Definition: SmartEnum.h:32
static size_t ToIndex(Enum index)
static EnumText ToString(Enum value)
static Enum FromIndex(size_t index)