mirror of
https://github.com/swift-project/pilotclient.git
synced 2026-03-31 21:15:33 +08:00
333 lines
12 KiB
C++
333 lines
12 KiB
C++
/* Copyright (C) 2016
|
|
* swift Project Community / Contributors
|
|
*
|
|
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
|
|
* directory of this distribution. No part of swift project, including this file, may be copied, modified, propagated,
|
|
* or distributed except according to the terms contained in the LICENSE file.
|
|
*/
|
|
|
|
//! \file
|
|
|
|
#ifndef BLACKMISC_METACLASS_H
|
|
#define BLACKMISC_METACLASS_H
|
|
|
|
#include "blackmisc/invoke.h"
|
|
#include "blackmisc/integersequence.h"
|
|
#include <QHash>
|
|
#include <QString>
|
|
#include <type_traits>
|
|
#include <functional>
|
|
|
|
/*!
|
|
* \defgroup MetaClass Metaclass system
|
|
* Compile-time reflection toolkit for iterating over
|
|
* members of value classes.
|
|
*/
|
|
|
|
//! \cond PRIVATE
|
|
|
|
// Work around MinGW problem with combination of constexpr and extern template
|
|
#if defined(Q_OS_WIN) && defined(Q_CC_GNU)
|
|
#define BLACK_NO_EXPORT_CONSTEXPR constexpr inline __attribute__((always_inline))
|
|
#else
|
|
#define BLACK_NO_EXPORT_CONSTEXPR constexpr
|
|
#endif
|
|
|
|
// MSVC, GCC, Clang all have non-standard extensions for skipping trailing
|
|
// commas in variadic macros, but the MSVC extension differs from the others.
|
|
#ifdef Q_CC_MSVC
|
|
#define BLACK_TRAILING_VA_ARGS(...) ,__VA_ARGS__
|
|
#else
|
|
#define BLACK_TRAILING_VA_ARGS(...) ,##__VA_ARGS__
|
|
#endif
|
|
|
|
//! \endcond
|
|
|
|
// *INDENT-OFF*
|
|
/*!
|
|
* Macro to define a nested metaclass that describes the attributes of its
|
|
* enclosing class. Use in the private section of the class.
|
|
*
|
|
* \tparam CLASS The name of the class containing the member.
|
|
* \note A semicolon is needed at the end.
|
|
* \ingroup MetaClass
|
|
*/
|
|
#define BLACK_METACLASS(CLASS, ...) \
|
|
friend struct BlackMisc::Private::CMetaClassAccessor; \
|
|
struct MetaClass : public BlackMisc::CMetaClass \
|
|
{ \
|
|
using Class = CLASS; \
|
|
BLACK_NO_EXPORT_CONSTEXPR static auto getMemberList() \
|
|
{ \
|
|
return makeMetaMemberList(__VA_ARGS__); \
|
|
} \
|
|
}
|
|
|
|
/*!
|
|
* Macro to define an element within a metaclass.
|
|
*
|
|
* Additional arguments can be supplied in the variadic part, which will be
|
|
* forwarded to CMetaClass::makeMetaMember.
|
|
*
|
|
* \tparam MEMBER The name of the member without m_ part.
|
|
* \see BLACK_METACLASS
|
|
* \see BLACK_METAMEMBER_NAMED
|
|
* \see BlackMisc::CMetaClass::makeMetaMember
|
|
* \ingroup MetaClass
|
|
*/
|
|
#define BLACK_METAMEMBER(MEMBER, ...) \
|
|
makeMetaMember( \
|
|
&Class::m_##MEMBER, #MEMBER BLACK_TRAILING_VA_ARGS(__VA_ARGS__) \
|
|
)
|
|
|
|
/*!
|
|
* Same as BLACK_METAMEMBER but the second parameter is a string literal
|
|
* containing the JSON name of the member.
|
|
*
|
|
* \ingroup MetaClass
|
|
*/
|
|
#define BLACK_METAMEMBER_NAMED(MEMBER, NAME, ...) \
|
|
makeMetaMember( \
|
|
&Class::m_##MEMBER, NAME BLACK_TRAILING_VA_ARGS(__VA_ARGS__) \
|
|
)
|
|
// *INDENT-ON*
|
|
|
|
//! std::string qHash
|
|
//! @{
|
|
inline uint qHash(const std::string &key, uint seed) { return qHash(QString::fromStdString(key), seed); }
|
|
inline uint qHash(const std::string &key) { return qHash(QString::fromStdString(key)); }
|
|
//! @}
|
|
|
|
namespace BlackMisc
|
|
{
|
|
class CVariant;
|
|
|
|
// *INDENT-OFF*
|
|
/*!
|
|
* Type wrapper for passing MetaFlag to CMetaClassIntrospector::with and CMetaClassIntrospector::without.
|
|
* \ingroup MetaClass
|
|
*/
|
|
template <quint64 F>
|
|
struct MetaFlags : public std::integral_constant<quint64, F>
|
|
{
|
|
//! Implicit conversion to std::false_type (if F is zero) or std::true_type (if F is non-zero).
|
|
constexpr operator std::integral_constant<bool, static_cast<bool>(F)>() const { return {}; }
|
|
};
|
|
|
|
/*!
|
|
* Compile-time union of MetaFlags.
|
|
* \ingroup MetaClass
|
|
*/
|
|
template <quint64 A, quint64 B>
|
|
constexpr MetaFlags<A | B> operator |(MetaFlags<A>, MetaFlags<B>) { return {}; }
|
|
|
|
/*!
|
|
* Compile-time intersection of MetaFlags.
|
|
* \ingroup MetaClass
|
|
*/
|
|
template <quint64 A, quint64 B>
|
|
constexpr MetaFlags<A & B> operator &(MetaFlags<A>, MetaFlags<B>) { return {}; }
|
|
|
|
/*!
|
|
* Literal aggregate type representing attributes of one member of a value class.
|
|
* \ingroup MetaClass
|
|
*/
|
|
template <typename M, quint64 Flags>
|
|
struct CMetaMember
|
|
{
|
|
//! Pointer to the member.
|
|
const M m_ptr;
|
|
|
|
//! Member name.
|
|
const char *const m_name;
|
|
|
|
//! Property index of the member.
|
|
//! \deprecated Reserved for future use.
|
|
const int m_index;
|
|
|
|
//! Any flags applying to the member.
|
|
const MetaFlags<Flags> m_flags;
|
|
|
|
//! True if m_flags contains all flags.
|
|
template <typename Flags2>
|
|
constexpr bool has(Flags2 flags) const { return (MetaFlags<Flags>() & flags) == flags; }
|
|
|
|
//! Invoke the member on an instance of the value class.
|
|
template <typename T, typename... Ts>
|
|
decltype(auto) in(T &&object, Ts &&... args) const
|
|
{
|
|
return Private::invoke(m_ptr, std::forward<T>(object), std::forward<Ts>(args)...);
|
|
}
|
|
|
|
//! Return name as QLatin1String.
|
|
constexpr auto latin1Name() const { return QLatin1String(m_name); }
|
|
};
|
|
|
|
/*!
|
|
* Literal aggregate type representing attributes of the members of a value class.
|
|
* \ingroup MetaClass
|
|
*/
|
|
template <typename... Members>
|
|
struct CMetaMemberList
|
|
{
|
|
//! Tuple of CMetaMember.
|
|
const std::tuple<Members...> m_members;
|
|
|
|
//! Number of members.
|
|
static constexpr size_t c_size = sizeof...(Members);
|
|
|
|
//! Convenience method returning the member at index I.
|
|
template <size_t I>
|
|
constexpr auto at(std::integral_constant<size_t, I> = {}) const
|
|
{
|
|
return std::get<I>(m_members);
|
|
}
|
|
};
|
|
// *INDENT-ON*
|
|
|
|
/*!
|
|
* Metadata flags attached to members of a meta class.
|
|
* \ingroup MetaClass
|
|
*/
|
|
enum MetaFlag
|
|
{
|
|
DisabledForComparison = 1 << 0, //!< Element will be ignored by compare() and comparison operators
|
|
DisabledForMarshalling = 1 << 1, //!< Element will be ignored during DBus and QDataStream marshalling
|
|
DisabledForDebugging = 1 << 2, //!< Element will be ignored when streaming to QDebug
|
|
DisabledForHashing = 1 << 3, //!< Element will be ignored by qHash()
|
|
DisabledForJson = 1 << 4, //!< Element will be ignored during JSON serialization
|
|
CaseInsensitiveComparison = 1 << 5, //!< Element will be compared case insensitively (must be a QString)
|
|
LosslessMarshalling = 1 << 6 //!< Element marshalling will preserve data at the expense of size
|
|
};
|
|
|
|
/*!
|
|
* Base class for meta classes.
|
|
* Just static protected members to be used by derived meta classes.
|
|
* \ingroup MetaClass
|
|
*/
|
|
class CMetaClass
|
|
{
|
|
protected:
|
|
//! Flags wrapped as compile-time constants.
|
|
//! @{
|
|
constexpr static MetaFlags<MetaFlag::DisabledForComparison> DisabledForComparison {};
|
|
constexpr static MetaFlags<MetaFlag::DisabledForMarshalling> DisabledForMarshalling {};
|
|
constexpr static MetaFlags<MetaFlag::DisabledForDebugging> DisabledForDebugging {};
|
|
constexpr static MetaFlags<MetaFlag::DisabledForHashing> DisabledForHashing {};
|
|
constexpr static MetaFlags<MetaFlag::DisabledForJson> DisabledForJson {};
|
|
constexpr static MetaFlags<MetaFlag::CaseInsensitiveComparison> CaseInsensitiveComparison {};
|
|
constexpr static MetaFlags<MetaFlag::LosslessMarshalling> LosslessMarshalling {};
|
|
//! @}
|
|
|
|
//! Return a CMetaMemberList of type deduced from the types of the meta members.
|
|
//! Usually not used directly, but via the macros.
|
|
template <typename... Members>
|
|
constexpr static CMetaMemberList<Members...> makeMetaMemberList(Members... members)
|
|
{
|
|
return { std::tuple<Members...>(members...) };
|
|
}
|
|
|
|
//! Return a CMetaMethod of type deduced from the type of the member.
|
|
//! Usually not used directly, but via the macros.
|
|
template <typename M, quint64 Flags = 0>
|
|
constexpr static CMetaMember<M, Flags> makeMetaMember(M ptrToMember, const char *name = nullptr, int index = 0, MetaFlags<Flags> flags = {})
|
|
{
|
|
static_assert(std::is_member_object_pointer<M>::value, "M must be a pointer to member object");
|
|
return { ptrToMember, name, index, flags };
|
|
}
|
|
};
|
|
|
|
// *INDENT-OFF*
|
|
/*!
|
|
* Implementation of an introspector for the metaclass of T.
|
|
* Obtain an instance of this class via BlackMisc::introspect.
|
|
* \ingroup MetaClass
|
|
*/
|
|
template <typename T, typename MetaClass, size_t... Is>
|
|
class CMetaClassIntrospector
|
|
{
|
|
public:
|
|
//! Return a CMetaClassIntrospector<T> covering only those members which have the given flags.
|
|
//! \see BlackMisc::MetaFlags
|
|
template <typename Flags>
|
|
constexpr static auto with(Flags) { return filter(MaskSequence<(members().at(index<Is>()).has(Flags()))...>()); }
|
|
|
|
//! Return a CMetaClassIntrospector<T> covering only those members which do not have the given flags.
|
|
//! \see BlackMisc::MetaFlags
|
|
template <typename Flags>
|
|
constexpr static auto without(Flags) { return filter(MaskSequence<(! members().at(index<Is>()).has(Flags()))...>()); }
|
|
|
|
//! For each metamember in metaclass, pass metamember as argument to visitor function.
|
|
template <typename F>
|
|
static void forEachMember(F &&visitor)
|
|
{
|
|
// parameter pack swallow idiom
|
|
static_cast<void>(std::initializer_list<int>
|
|
{
|
|
//! \fixme C-style cast is needed due to a clang bug: https://bugs.llvm.org/show_bug.cgi?id=39375
|
|
((void)(std::forward<F>(visitor)(members().at(index<Is>()))), 0)...
|
|
});
|
|
}
|
|
|
|
private:
|
|
template <bool... Mask>
|
|
using MaskSequence = Private::MaskSequence<std::index_sequence<Is...>, Mask...>;
|
|
|
|
template <size_t... Js>
|
|
constexpr static auto filter(std::index_sequence<Js...>) { return CMetaClassIntrospector<T, MetaClass, Js...>(); }
|
|
|
|
template <size_t I>
|
|
using index = std::integral_constant<size_t, I>;
|
|
|
|
// Trailing return type needed to work around MSVC "function returning auto can not be used before it has been defined" with /permissive-
|
|
constexpr static auto members() -> decltype(MetaClass::getMemberList()) { return MetaClass::getMemberList(); }
|
|
};
|
|
// *INDENT-ON*
|
|
|
|
namespace Private
|
|
{
|
|
//! \private Friend class of all value classes, so it can access the private nested class.
|
|
struct CMetaClassAccessor
|
|
{
|
|
template <typename T, size_t... Is>
|
|
constexpr static auto getIntrospector(std::index_sequence<Is...>)
|
|
{
|
|
return CMetaClassIntrospector<T, typename T::MetaClass, Is...>();
|
|
}
|
|
|
|
template <typename T>
|
|
constexpr static auto getIntrospector()
|
|
{
|
|
return getIntrospector<T>(std::make_index_sequence<T::MetaClass::getMemberList().c_size>());
|
|
}
|
|
|
|
template <typename T>
|
|
constexpr static std::true_type hasMetaClass(int, typename T::MetaClass * = nullptr) { return {}; }
|
|
|
|
template <typename T>
|
|
constexpr static std::false_type hasMetaClass(...) { return {}; }
|
|
};
|
|
}
|
|
|
|
/*!
|
|
* Obtain the CMetaClassIntrospector for the metaclass of T.
|
|
* \return BlackMisc::CMetaClassIntrospector
|
|
* \ingroup MetaClass
|
|
*/
|
|
template <typename T>
|
|
constexpr auto introspect()
|
|
{
|
|
return Private::CMetaClassAccessor::getIntrospector<T>();
|
|
}
|
|
|
|
/*!
|
|
* Trait that is true if T has a metaclass.
|
|
* \ingroup MetaClass
|
|
*/
|
|
template <typename T>
|
|
struct THasMetaClass : public decltype(Private::CMetaClassAccessor::hasMetaClass<T>(0)) {};
|
|
|
|
} // namespace
|
|
|
|
#endif
|