225 lines
9.5 KiB
C++
225 lines
9.5 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** This file is part of the QtCore module of the Qt Toolkit.
|
|
**
|
|
** $QT_BEGIN_LICENSE:LGPL$
|
|
** Commercial License Usage
|
|
** Licensees holding valid commercial Qt licenses may use this file in
|
|
** accordance with the commercial license agreement provided with the
|
|
** Software or, alternatively, in accordance with the terms contained in
|
|
** a written agreement between you and The Qt Company. For licensing terms
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU Lesser General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU Lesser
|
|
** General Public License version 3 as published by the Free Software
|
|
** Foundation and appearing in the file LICENSE.LGPL3 included in the
|
|
** packaging of this file. Please review the following information to
|
|
** ensure the GNU Lesser General Public License version 3 requirements
|
|
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 2.0 or (at your option) the GNU General
|
|
** Public license version 3 or any later version approved by the KDE Free
|
|
** Qt Foundation. The licenses are as published by the Free Software
|
|
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
|
|
** included in the packaging of this file. Please review the following
|
|
** information to ensure the GNU General Public License requirements will
|
|
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
|
|
** https://www.gnu.org/licenses/gpl-3.0.html.
|
|
**
|
|
** $QT_END_LICENSE$
|
|
**
|
|
****************************************************************************/
|
|
|
|
#include <QtCore/qglobal.h>
|
|
|
|
#ifndef QFLAGS_H
|
|
#define QFLAGS_H
|
|
|
|
#include <initializer_list>
|
|
|
|
QT_BEGIN_NAMESPACE
|
|
|
|
class QDataStream;
|
|
|
|
class QFlag
|
|
{
|
|
int i;
|
|
public:
|
|
Q_DECL_CONSTEXPR inline QFlag(int value) noexcept : i(value) {}
|
|
Q_DECL_CONSTEXPR inline operator int() const noexcept { return i; }
|
|
|
|
#if !defined(Q_CC_MSVC)
|
|
// Microsoft Visual Studio has buggy behavior when it comes to
|
|
// unsigned enums: even if the enum is unsigned, the enum tags are
|
|
// always signed
|
|
# if !defined(__LP64__) && !defined(Q_CLANG_QDOC)
|
|
Q_DECL_CONSTEXPR inline QFlag(long value) noexcept : i(int(value)) {}
|
|
Q_DECL_CONSTEXPR inline QFlag(ulong value) noexcept : i(int(long(value))) {}
|
|
# endif
|
|
Q_DECL_CONSTEXPR inline QFlag(uint value) noexcept : i(int(value)) {}
|
|
Q_DECL_CONSTEXPR inline QFlag(short value) noexcept : i(int(value)) {}
|
|
Q_DECL_CONSTEXPR inline QFlag(ushort value) noexcept : i(int(uint(value))) {}
|
|
Q_DECL_CONSTEXPR inline operator uint() const noexcept { return uint(i); }
|
|
#endif
|
|
};
|
|
Q_DECLARE_TYPEINFO(QFlag, Q_PRIMITIVE_TYPE);
|
|
|
|
class QIncompatibleFlag
|
|
{
|
|
int i;
|
|
public:
|
|
Q_DECL_CONSTEXPR inline explicit QIncompatibleFlag(int i) noexcept;
|
|
Q_DECL_CONSTEXPR inline operator int() const noexcept { return i; }
|
|
};
|
|
Q_DECLARE_TYPEINFO(QIncompatibleFlag, Q_PRIMITIVE_TYPE);
|
|
|
|
Q_DECL_CONSTEXPR inline QIncompatibleFlag::QIncompatibleFlag(int value) noexcept : i(value) {}
|
|
|
|
|
|
#ifndef Q_NO_TYPESAFE_FLAGS
|
|
|
|
template<typename Enum>
|
|
class QFlags
|
|
{
|
|
Q_STATIC_ASSERT_X((sizeof(Enum) <= sizeof(int)),
|
|
"QFlags uses an int as storage, so an enum with underlying "
|
|
"long long will overflow.");
|
|
Q_STATIC_ASSERT_X((std::is_enum<Enum>::value), "QFlags is only usable on enumeration types.");
|
|
|
|
#if QT_DEPRECATED_SINCE(5,15)
|
|
struct Private;
|
|
typedef int (Private::*Zero);
|
|
#endif
|
|
template <typename E> friend QDataStream &operator>>(QDataStream &, QFlags<E> &);
|
|
template <typename E> friend QDataStream &operator<<(QDataStream &, QFlags<E>);
|
|
public:
|
|
#if defined(Q_CC_MSVC) || defined(Q_CLANG_QDOC)
|
|
// see above for MSVC
|
|
// the definition below is too complex for qdoc
|
|
typedef int Int;
|
|
#else
|
|
typedef typename std::conditional<
|
|
std::is_unsigned<typename std::underlying_type<Enum>::type>::value,
|
|
unsigned int,
|
|
signed int
|
|
>::type Int;
|
|
#endif
|
|
typedef Enum enum_type;
|
|
// compiler-generated copy/move ctor/assignment operators are fine!
|
|
#ifdef Q_CLANG_QDOC
|
|
Q_DECL_CONSTEXPR inline QFlags(const QFlags &other);
|
|
Q_DECL_CONSTEXPR inline QFlags &operator=(const QFlags &other);
|
|
#endif
|
|
Q_DECL_CONSTEXPR inline QFlags() noexcept : i(0) {}
|
|
Q_DECL_CONSTEXPR inline QFlags(Enum flags) noexcept : i(Int(flags)) {}
|
|
#if QT_DEPRECATED_SINCE(5,15)
|
|
QT_DEPRECATED_X("Use default constructor instead") Q_DECL_CONSTEXPR inline QFlags(Zero) noexcept : i(0) {}
|
|
#endif
|
|
Q_DECL_CONSTEXPR inline QFlags(QFlag flag) noexcept : i(flag) {}
|
|
|
|
Q_DECL_CONSTEXPR inline QFlags(std::initializer_list<Enum> flags) noexcept
|
|
: i(initializer_list_helper(flags.begin(), flags.end())) {}
|
|
|
|
Q_DECL_RELAXED_CONSTEXPR inline QFlags &operator&=(int mask) noexcept { i &= mask; return *this; }
|
|
Q_DECL_RELAXED_CONSTEXPR inline QFlags &operator&=(uint mask) noexcept { i &= mask; return *this; }
|
|
Q_DECL_RELAXED_CONSTEXPR inline QFlags &operator&=(Enum mask) noexcept { i &= Int(mask); return *this; }
|
|
Q_DECL_RELAXED_CONSTEXPR inline QFlags &operator|=(QFlags other) noexcept { i |= other.i; return *this; }
|
|
Q_DECL_RELAXED_CONSTEXPR inline QFlags &operator|=(Enum other) noexcept { i |= Int(other); return *this; }
|
|
Q_DECL_RELAXED_CONSTEXPR inline QFlags &operator^=(QFlags other) noexcept { i ^= other.i; return *this; }
|
|
Q_DECL_RELAXED_CONSTEXPR inline QFlags &operator^=(Enum other) noexcept { i ^= Int(other); return *this; }
|
|
|
|
Q_DECL_CONSTEXPR inline operator Int() const noexcept { return i; }
|
|
|
|
Q_DECL_CONSTEXPR inline QFlags operator|(QFlags other) const noexcept { return QFlags(QFlag(i | other.i)); }
|
|
Q_DECL_CONSTEXPR inline QFlags operator|(Enum other) const noexcept { return QFlags(QFlag(i | Int(other))); }
|
|
Q_DECL_CONSTEXPR inline QFlags operator^(QFlags other) const noexcept { return QFlags(QFlag(i ^ other.i)); }
|
|
Q_DECL_CONSTEXPR inline QFlags operator^(Enum other) const noexcept { return QFlags(QFlag(i ^ Int(other))); }
|
|
Q_DECL_CONSTEXPR inline QFlags operator&(int mask) const noexcept { return QFlags(QFlag(i & mask)); }
|
|
Q_DECL_CONSTEXPR inline QFlags operator&(uint mask) const noexcept { return QFlags(QFlag(i & mask)); }
|
|
Q_DECL_CONSTEXPR inline QFlags operator&(Enum other) const noexcept { return QFlags(QFlag(i & Int(other))); }
|
|
Q_DECL_CONSTEXPR inline QFlags operator~() const noexcept { return QFlags(QFlag(~i)); }
|
|
|
|
Q_DECL_CONSTEXPR inline bool operator!() const noexcept { return !i; }
|
|
|
|
Q_DECL_CONSTEXPR inline bool testFlag(Enum flag) const noexcept { return (i & Int(flag)) == Int(flag) && (Int(flag) != 0 || i == Int(flag) ); }
|
|
Q_DECL_RELAXED_CONSTEXPR inline QFlags &setFlag(Enum flag, bool on = true) noexcept
|
|
{
|
|
return on ? (*this |= flag) : (*this &= ~Int(flag));
|
|
}
|
|
|
|
private:
|
|
Q_DECL_CONSTEXPR static inline Int initializer_list_helper(typename std::initializer_list<Enum>::const_iterator it,
|
|
typename std::initializer_list<Enum>::const_iterator end)
|
|
noexcept
|
|
{
|
|
return (it == end ? Int(0) : (Int(*it) | initializer_list_helper(it + 1, end)));
|
|
}
|
|
|
|
Int i;
|
|
};
|
|
|
|
#ifndef Q_MOC_RUN
|
|
#define Q_DECLARE_FLAGS(Flags, Enum)\
|
|
typedef QFlags<Enum> Flags;
|
|
#endif
|
|
|
|
#define Q_DECLARE_INCOMPATIBLE_FLAGS(Flags) \
|
|
Q_DECL_CONSTEXPR inline QIncompatibleFlag operator|(Flags::enum_type f1, int f2) noexcept \
|
|
{ return QIncompatibleFlag(int(f1) | f2); }
|
|
|
|
#define Q_DECLARE_OPERATORS_FOR_FLAGS(Flags) \
|
|
Q_DECL_CONSTEXPR inline QFlags<Flags::enum_type> operator|(Flags::enum_type f1, Flags::enum_type f2) noexcept \
|
|
{ return QFlags<Flags::enum_type>(f1) | f2; } \
|
|
Q_DECL_CONSTEXPR inline QFlags<Flags::enum_type> operator|(Flags::enum_type f1, QFlags<Flags::enum_type> f2) noexcept \
|
|
{ return f2 | f1; } Q_DECLARE_INCOMPATIBLE_FLAGS(Flags)
|
|
|
|
|
|
#else /* Q_NO_TYPESAFE_FLAGS */
|
|
|
|
#ifndef Q_MOC_RUN
|
|
#define Q_DECLARE_FLAGS(Flags, Enum)\
|
|
typedef uint Flags;
|
|
#endif
|
|
|
|
#define Q_DECLARE_OPERATORS_FOR_FLAGS(Flags)
|
|
|
|
#endif /* Q_NO_TYPESAFE_FLAGS */
|
|
|
|
// restore bit-wise enum-enum operators deprecated in C++20,
|
|
// but used in a few places in the API
|
|
#if __cplusplus > 201702L // assume compilers don't warn if in C++17 mode
|
|
// in C++20 mode, provide user-defined operators to override the deprecated operations:
|
|
# define Q_DECLARE_MIXED_ENUM_OPERATOR(op, Ret, LHS, RHS) \
|
|
constexpr inline Ret operator op (LHS lhs, RHS rhs) noexcept \
|
|
{ return static_cast<Ret>(std::underlying_type_t<LHS>(lhs) op std::underlying_type_t<RHS>(rhs)); } \
|
|
/* end */
|
|
#else
|
|
// in C++11-17 mode, statically-assert that this compiler's result of the
|
|
// operation is the same that the C++20 version would produce:
|
|
# define Q_DECLARE_MIXED_ENUM_OPERATOR(op, Ret, LHS, RHS) \
|
|
Q_STATIC_ASSERT((std::is_same<decltype(std::declval<LHS>() op std::declval<RHS>()), Ret>::value));
|
|
#endif
|
|
|
|
#define Q_DECLARE_MIXED_ENUM_OPERATORS(Ret, Flags, Enum) \
|
|
Q_DECLARE_MIXED_ENUM_OPERATOR(|, Ret, Flags, Enum) \
|
|
Q_DECLARE_MIXED_ENUM_OPERATOR(&, Ret, Flags, Enum) \
|
|
Q_DECLARE_MIXED_ENUM_OPERATOR(^, Ret, Flags, Enum) \
|
|
/* end */
|
|
|
|
#define Q_DECLARE_MIXED_ENUM_OPERATORS_SYMMETRIC(Ret, Flags, Enum) \
|
|
Q_DECLARE_MIXED_ENUM_OPERATORS(Ret, Flags, Enum) \
|
|
Q_DECLARE_MIXED_ENUM_OPERATORS(Ret, Enum, Flags) \
|
|
/* end */
|
|
|
|
|
|
QT_END_NAMESPACE
|
|
|
|
#endif // QFLAGS_H
|