1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtCore module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39
40 #include <QtCore/qglobal.h>
41
42 #ifndef QFLAGS_H
43 #define QFLAGS_H
44
45 #include <initializer_list>
46
47 QT_BEGIN_NAMESPACE
48
49 class QDataStream;
50
51 class QFlag
52 {
53 int i;
54 public:
QFlag(int value)55 Q_DECL_CONSTEXPR inline QFlag(int value) noexcept : i(value) {}
56 Q_DECL_CONSTEXPR inline operator int() const noexcept { return i; }
57
58 #if !defined(Q_CC_MSVC)
59 // Microsoft Visual Studio has buggy behavior when it comes to
60 // unsigned enums: even if the enum is unsigned, the enum tags are
61 // always signed
62 # if !defined(__LP64__) && !defined(Q_CLANG_QDOC)
QFlag(long value)63 Q_DECL_CONSTEXPR inline QFlag(long value) noexcept : i(int(value)) {}
QFlag(ulong value)64 Q_DECL_CONSTEXPR inline QFlag(ulong value) noexcept : i(int(long(value))) {}
65 # endif
QFlag(uint value)66 Q_DECL_CONSTEXPR inline QFlag(uint value) noexcept : i(int(value)) {}
QFlag(short value)67 Q_DECL_CONSTEXPR inline QFlag(short value) noexcept : i(int(value)) {}
QFlag(ushort value)68 Q_DECL_CONSTEXPR inline QFlag(ushort value) noexcept : i(int(uint(value))) {}
uint()69 Q_DECL_CONSTEXPR inline operator uint() const noexcept { return uint(i); }
70 #endif
71 };
72 Q_DECLARE_TYPEINFO(QFlag, Q_PRIMITIVE_TYPE);
73
74 class QIncompatibleFlag
75 {
76 int i;
77 public:
78 Q_DECL_CONSTEXPR inline explicit QIncompatibleFlag(int i) noexcept;
79 Q_DECL_CONSTEXPR inline operator int() const noexcept { return i; }
80 };
81 Q_DECLARE_TYPEINFO(QIncompatibleFlag, Q_PRIMITIVE_TYPE);
82
QIncompatibleFlag(int value)83 Q_DECL_CONSTEXPR inline QIncompatibleFlag::QIncompatibleFlag(int value) noexcept : i(value) {}
84
85
86 #ifndef Q_NO_TYPESAFE_FLAGS
87
88 template<typename Enum>
89 class QFlags
90 {
91 Q_STATIC_ASSERT_X((sizeof(Enum) <= sizeof(int)),
92 "QFlags uses an int as storage, so an enum with underlying "
93 "long long will overflow.");
94 Q_STATIC_ASSERT_X((std::is_enum<Enum>::value), "QFlags is only usable on enumeration types.");
95
96 #if QT_DEPRECATED_SINCE(5,15)
97 struct Private;
98 typedef int (Private::*Zero);
99 #endif
100 template <typename E> friend QDataStream &operator>>(QDataStream &, QFlags<E> &);
101 template <typename E> friend QDataStream &operator<<(QDataStream &, QFlags<E>);
102 public:
103 #if defined(Q_CC_MSVC) || defined(Q_CLANG_QDOC)
104 // see above for MSVC
105 // the definition below is too complex for qdoc
106 typedef int Int;
107 #else
108 typedef typename std::conditional<
109 std::is_unsigned<typename std::underlying_type<Enum>::type>::value,
110 unsigned int,
111 signed int
112 >::type Int;
113 #endif
114 typedef Enum enum_type;
115 // compiler-generated copy/move ctor/assignment operators are fine!
116 #ifdef Q_CLANG_QDOC
117 Q_DECL_CONSTEXPR inline QFlags(const QFlags &other);
118 Q_DECL_CONSTEXPR inline QFlags &operator=(const QFlags &other);
119 #endif
QFlags()120 Q_DECL_CONSTEXPR inline QFlags() noexcept : i(0) {}
QFlags(Enum flags)121 Q_DECL_CONSTEXPR inline QFlags(Enum flags) noexcept : i(Int(flags)) {}
122 #if QT_DEPRECATED_SINCE(5,15)
QFlags(Zero)123 QT_DEPRECATED_X("Use default constructor instead") Q_DECL_CONSTEXPR inline QFlags(Zero) noexcept : i(0) {}
124 #endif
QFlags(QFlag flag)125 Q_DECL_CONSTEXPR inline QFlags(QFlag flag) noexcept : i(flag) {}
126
QFlags(std::initializer_list<Enum> flags)127 Q_DECL_CONSTEXPR inline QFlags(std::initializer_list<Enum> flags) noexcept
128 : i(initializer_list_helper(flags.begin(), flags.end())) {}
129
130 Q_DECL_RELAXED_CONSTEXPR inline QFlags &operator&=(int mask) noexcept { i &= mask; return *this; }
131 Q_DECL_RELAXED_CONSTEXPR inline QFlags &operator&=(uint mask) noexcept { i &= mask; return *this; }
132 Q_DECL_RELAXED_CONSTEXPR inline QFlags &operator&=(Enum mask) noexcept { i &= Int(mask); return *this; }
133 Q_DECL_RELAXED_CONSTEXPR inline QFlags &operator|=(QFlags other) noexcept { i |= other.i; return *this; }
134 Q_DECL_RELAXED_CONSTEXPR inline QFlags &operator|=(Enum other) noexcept { i |= Int(other); return *this; }
135 Q_DECL_RELAXED_CONSTEXPR inline QFlags &operator^=(QFlags other) noexcept { i ^= other.i; return *this; }
136 Q_DECL_RELAXED_CONSTEXPR inline QFlags &operator^=(Enum other) noexcept { i ^= Int(other); return *this; }
137
Int()138 Q_DECL_CONSTEXPR inline operator Int() const noexcept { return i; }
139
140 Q_DECL_CONSTEXPR inline QFlags operator|(QFlags other) const noexcept { return QFlags(QFlag(i | other.i)); }
141 Q_DECL_CONSTEXPR inline QFlags operator|(Enum other) const noexcept { return QFlags(QFlag(i | Int(other))); }
142 Q_DECL_CONSTEXPR inline QFlags operator^(QFlags other) const noexcept { return QFlags(QFlag(i ^ other.i)); }
143 Q_DECL_CONSTEXPR inline QFlags operator^(Enum other) const noexcept { return QFlags(QFlag(i ^ Int(other))); }
144 Q_DECL_CONSTEXPR inline QFlags operator&(int mask) const noexcept { return QFlags(QFlag(i & mask)); }
145 Q_DECL_CONSTEXPR inline QFlags operator&(uint mask) const noexcept { return QFlags(QFlag(i & mask)); }
146 Q_DECL_CONSTEXPR inline QFlags operator&(Enum other) const noexcept { return QFlags(QFlag(i & Int(other))); }
147 Q_DECL_CONSTEXPR inline QFlags operator~() const noexcept { return QFlags(QFlag(~i)); }
148
149 Q_DECL_CONSTEXPR inline bool operator!() const noexcept { return !i; }
150
testFlag(Enum flag)151 Q_DECL_CONSTEXPR inline bool testFlag(Enum flag) const noexcept { return (i & Int(flag)) == Int(flag) && (Int(flag) != 0 || i == Int(flag) ); }
152 Q_DECL_RELAXED_CONSTEXPR inline QFlags &setFlag(Enum flag, bool on = true) noexcept
153 {
154 return on ? (*this |= flag) : (*this &= ~Int(flag));
155 }
156
157 private:
initializer_list_helper(typename std::initializer_list<Enum>::const_iterator it,typename std::initializer_list<Enum>::const_iterator end)158 Q_DECL_CONSTEXPR static inline Int initializer_list_helper(typename std::initializer_list<Enum>::const_iterator it,
159 typename std::initializer_list<Enum>::const_iterator end)
160 noexcept
161 {
162 return (it == end ? Int(0) : (Int(*it) | initializer_list_helper(it + 1, end)));
163 }
164
165 Int i;
166 };
167
168 #ifndef Q_MOC_RUN
169 #define Q_DECLARE_FLAGS(Flags, Enum)\
170 typedef QFlags<Enum> Flags;
171 #endif
172
173 #define Q_DECLARE_INCOMPATIBLE_FLAGS(Flags) \
174 Q_DECL_CONSTEXPR inline QIncompatibleFlag operator|(Flags::enum_type f1, int f2) noexcept \
175 { return QIncompatibleFlag(int(f1) | f2); }
176
177 #define Q_DECLARE_OPERATORS_FOR_FLAGS(Flags) \
178 Q_DECL_CONSTEXPR inline QFlags<Flags::enum_type> operator|(Flags::enum_type f1, Flags::enum_type f2) noexcept \
179 { return QFlags<Flags::enum_type>(f1) | f2; } \
180 Q_DECL_CONSTEXPR inline QFlags<Flags::enum_type> operator|(Flags::enum_type f1, QFlags<Flags::enum_type> f2) noexcept \
181 { return f2 | f1; } Q_DECLARE_INCOMPATIBLE_FLAGS(Flags)
182
183
184 #else /* Q_NO_TYPESAFE_FLAGS */
185
186 #ifndef Q_MOC_RUN
187 #define Q_DECLARE_FLAGS(Flags, Enum)\
188 typedef uint Flags;
189 #endif
190
191 #define Q_DECLARE_OPERATORS_FOR_FLAGS(Flags)
192
193 #endif /* Q_NO_TYPESAFE_FLAGS */
194
195 QT_END_NAMESPACE
196
197 #endif // QFLAGS_H
198