refs #628 Add mixins which use the metaclass system instead of the tuple system.

This commit is contained in:
Mathew Sutcliffe
2016-03-25 19:01:38 +00:00
parent 34bc76e74c
commit 4f3637a046
6 changed files with 273 additions and 0 deletions

View File

@@ -13,10 +13,63 @@
#define BLACKMISC_COMPARE_H #define BLACKMISC_COMPARE_H
#include "blackmisc/tuple.h" #include "blackmisc/tuple.h"
#include "blackmisc/metaclass.h"
#include "blackmisc/inheritancetraits.h" #include "blackmisc/inheritancetraits.h"
#include "blackmisc/typetraits.h"
namespace BlackMisc namespace BlackMisc
{ {
//! \cond PRIVATE
namespace Private
{
template <typename T, typename U>
int compareImpl(const T &a, const U &b, std::true_type)
{
return compare(a, b);
}
template <typename T, typename U>
int compareImpl(const T &a, const U &b, std::false_type)
{
return a < b ? -1 : b < a ? 1 : 0;
}
template <size_t C, size_t I = 0>
struct CompareHelper
{
template <typename T, typename U>
static int compareTuples(const T &a, const U &b)
{
int cmp = compareImpl(std::get<I>(a), std::get<I>(b), HasCompare<std::tuple_element_t<I, T>, std::tuple_element_t<I, U>>());
return cmp ? cmp : CompareHelper<C, I + 1>::compareTuples(a, b);
}
};
template <size_t C>
struct CompareHelper<C, C>
{
template <typename T, typename U>
static int compareTuples(const T &, const U &)
{
return 0;
}
};
}
//! \endcond
/*!
* Lexicographically compare two tuples and return negative, positive, or zero,
* if a is less than, greater than, or equal to b.
* Each element is compared with compare(a', b') if supported by the element type, operator less-than otherwise.
* \todo Rename to compare() after removing tuple.h, which contains a function with the same name and signature.
*/
template <typename... Ts, typename... Us>
int compareTuples(const std::tuple<Ts...> &a, const std::tuple<Us...> &b)
{
static_assert(sizeof...(Ts) == sizeof...(Us), "tuples must be same size");
return Private::CompareHelper<sizeof...(Ts)>::compareTuples(a, b);
}
namespace Mixin namespace Mixin
{ {
@@ -59,6 +112,30 @@ namespace BlackMisc
static bool baseEquals(const CEmpty *, const CEmpty *) { return true; } static bool baseEquals(const CEmpty *, const CEmpty *) { return true; }
}; };
/*!
* CRTP class template from which a derived class can inherit operator== implemented by metaclass.
*/
template <class Derived>
class EqualsByMetaClass
{
public:
//! Equals
friend bool operator ==(const Derived &a, const Derived &b) { return equals(a, b); }
//! Not equal
friend bool operator !=(const Derived &a, const Derived &b) { return ! equals(a, b); }
private:
static bool equals(const Derived &a, const Derived &b)
{
auto meta = introspect<Derived>().without(MetaFlags<DisabledForComparison>());
return meta.toCaseAwareTuple(a) == meta.toCaseAwareTuple(b) && baseEquals(static_cast<const BaseOfT<Derived> *>(&a), static_cast<const BaseOfT<Derived> *>(&b));
}
template <typename T> static bool baseEquals(const T *a, const T *b) { return *a == *b; }
static bool baseEquals(const void *, const void *) { return true; }
static bool baseEquals(const CEmpty *, const CEmpty *) { return true; }
};
/*! /*!
* CRTP class template from which a derived class can inherit operator< implemented using its compare function. * CRTP class template from which a derived class can inherit operator< implemented using its compare function.
* *
@@ -111,6 +188,37 @@ namespace BlackMisc
static bool baseLess(const CEmpty *, const CEmpty *) { return false; } static bool baseLess(const CEmpty *, const CEmpty *) { return false; }
}; };
/*!
* CRTP class template from which a derived class can inherit operator< implemented by metaclass.
*/
template <class Derived>
class LessThanByMetaClass
{
public:
//! Less than
friend bool operator <(const Derived &a, const Derived &b) { return less(a, b); }
//! Greater than
friend bool operator >(const Derived &a, const Derived &b) { return less(b, a); }
//! Less than or equal
friend bool operator <=(const Derived &a, const Derived &b) { return ! less(b, a); }
//! Greater than or equal
friend bool operator >=(const Derived &a, const Derived &b) { return ! less(a, b); }
private:
static bool less(const Derived &a, const Derived &b)
{
if (baseLess(static_cast<const BaseOfT<Derived> *>(&a), static_cast<const BaseOfT<Derived> *>(&b))) { return true; }
auto meta = introspect<Derived>().without(MetaFlags<DisabledForComparison>());
return meta.toCaseAwareTuple(a) < meta.toCaseAwareTuple(b);
}
template <typename T> static bool baseLess(const T *a, const T *b) { return *a < *b; }
static bool baseLess(const void *, const void *) { return false; }
static bool baseLess(const CEmpty *, const CEmpty *) { return false; }
};
/*! /*!
* CRTP class template from which a derived class can inherit non-member compare() implemented by metatuple. * CRTP class template from which a derived class can inherit non-member compare() implemented by metatuple.
* *
@@ -135,6 +243,29 @@ namespace BlackMisc
static int baseCompare(const CEmpty *, const CEmpty *) { return 0; } static int baseCompare(const CEmpty *, const CEmpty *) { return 0; }
}; };
/*!
* CRTP class template from which a derived class can inherit non-member compare() implemented by metaclass.
*/
template <class Derived>
class CompareByMetaClass
{
public:
//! Return negative, zero, or positive if a is less than, equal to, or greater than b.
friend int compare(const Derived &a, const Derived &b) { return compareImpl(a, b); }
private:
static int compareImpl(const Derived &a, const Derived &b)
{
int baseCmp = baseCompare(static_cast<const BaseOfT<Derived> *>(&a), static_cast<const BaseOfT<Derived> *>(&b));
if (baseCmp) { return baseCmp; }
auto meta = introspect<Derived>().without(MetaFlags<DisabledForComparison>());
return BlackMisc::compareTuples(meta.toCaseAwareTuple(a), meta.toCaseAwareTuple(b));
}
template <typename T> static int baseCompare(const T *a, const T *b) { return compare(*a, *b); }
static int baseCompare(const void *, const void *) { return 0; }
static int baseCompare(const CEmpty *, const CEmpty *) { return 0; }
};
} // Mixin } // Mixin
} // BlackMisc } // BlackMisc

View File

@@ -13,6 +13,7 @@
#define BLACKMISC_DBUS_H #define BLACKMISC_DBUS_H
#include "blackmisc/tuple.h" #include "blackmisc/tuple.h"
#include "blackmisc/metaclass.h"
#include "blackmisc/inheritancetraits.h" #include "blackmisc/inheritancetraits.h"
#include <QDBusArgument> #include <QDBusArgument>
#include <type_traits> #include <type_traits>
@@ -88,6 +89,43 @@ namespace BlackMisc
static void baseUnmarshall(CEmpty *, const QDBusArgument &) {} static void baseUnmarshall(CEmpty *, const QDBusArgument &) {}
}; };
/*!
* CRTP class template from which a derived class can inherit common methods dealing with marshalling instances by metaclass.
*
* \see BLACKMISC_DECLARE_USING_MIXIN_DBUS
*/
template <class Derived>
class DBusByMetaClass : public DBusOperators<Derived>
{
public:
//! Marshall without begin/endStructure, for when composed within another object
void marshallToDbus(QDBusArgument &arg) const
{
baseMarshall(static_cast<const BaseOfT<Derived> *>(derived()), arg);
auto meta = introspect<Derived>().without(MetaFlags<DisabledForMarshalling>());
meta.forEachMember(*derived(), [ & ](const auto &member) { arg << member; });
}
//! Unmarshall without begin/endStructure, for when composed within another object
void unmarshallFromDbus(const QDBusArgument &arg)
{
baseUnmarshall(static_cast<BaseOfT<Derived> *>(derived()), arg);
auto meta = introspect<Derived>().without(MetaFlags<DisabledForMarshalling>());
meta.forEachMember(*derived(), [ & ](auto &member) { arg >> member; });
}
private:
const Derived *derived() const { return static_cast<const Derived *>(this); }
Derived *derived() { return static_cast<Derived *>(this); }
template <typename T> static void baseMarshall(const T *base, QDBusArgument &arg) { base->marshallToDbus(arg); }
template <typename T> static void baseUnmarshall(T *base, const QDBusArgument &arg) { base->unmarshallFromDbus(arg); }
static void baseMarshall(const void *, QDBusArgument &) {}
static void baseUnmarshall(void *, const QDBusArgument &) {}
static void baseMarshall(const CEmpty *, QDBusArgument &) {}
static void baseUnmarshall(CEmpty *, const QDBusArgument &) {}
};
/*! /*!
* When a derived class and a base class both inherit from Mixin::DBusByTuple, * When a derived class and a base class both inherit from Mixin::DBusByTuple,
* the derived class uses this macro to disambiguate the inherited members. * the derived class uses this macro to disambiguate the inherited members.

View File

@@ -19,6 +19,7 @@
#include "range.h" #include "range.h"
#include "containerbase.h" #include "containerbase.h"
#include "typetraits.h" #include "typetraits.h"
#include "metaclass.h"
#include <QHash> #include <QHash>
#include <utility> #include <utility>
#include <initializer_list> #include <initializer_list>
@@ -47,6 +48,14 @@ namespace BlackMisc
struct DefaultType { static_assert(std::is_void<Key>::value, "Key does not support either QHash or QMap"); }; struct DefaultType { static_assert(std::is_void<Key>::value, "Key does not support either QHash or QMap"); };
}; };
// Work around MSVC2015 bug affecting generic lambda
struct Hasher
{
template <typename T>
void operator()(const T &object) { m_hash ^= qHash(object); }
uint &m_hash;
};
//! \endcond //! \endcond
} // namespace Private } // namespace Private
@@ -475,6 +484,35 @@ namespace BlackMisc
static uint baseHash(const void *) { return 0; } static uint baseHash(const void *) { return 0; }
static uint baseHash(const CEmpty *) { return 0; } static uint baseHash(const CEmpty *) { return 0; }
}; };
/*!
* CRTP class template from which a derived class can inherit common methods dealing with hashing instances by metaclass.
*
* \tparam Derived Must be registered with BLACK_DECLARE_TUPLE_CONVERSION.
*/
template <class Derived>
class HashByMetaClass
{
public:
//! qHash overload, needed for storing value in a QSet.
friend uint qHash(const Derived &value, uint seed = 0)
{
return ::qHash(hashImpl(value), seed);
}
private:
static uint hashImpl(const Derived &value)
{
uint hash = baseHash(static_cast<const BaseOfT<Derived> *>(&value));
auto meta = introspect<Derived>().without(MetaFlags<DisabledForHashing>());
meta.forEachMember(value, Private::Hasher { hash });
return hash;
}
template <typename T> static uint baseHash(const T *base) { return qHash(*base); }
static uint baseHash(const void *) { return 0; }
static uint baseHash(const CEmpty *) { return 0; }
};
} }
/*! /*!

View File

@@ -14,6 +14,7 @@
#include "blackmisc/blackmiscexport.h" #include "blackmisc/blackmiscexport.h"
#include "blackmisc/tuple.h" #include "blackmisc/tuple.h"
#include "blackmisc/metaclass.h"
#include "blackmisc/inheritancetraits.h" #include "blackmisc/inheritancetraits.h"
#include "blackmisc/fileutils.h" #include "blackmisc/fileutils.h"
#include <QJsonObject> #include <QJsonObject>
@@ -286,6 +287,60 @@ namespace BlackMisc
static void baseConvertFromJson(CEmpty *, const QJsonObject &) {} static void baseConvertFromJson(CEmpty *, const QJsonObject &) {}
}; };
/*!
* CRTP class template from which a derived class can inherit common methods dealing with JSON by metatuple.
*
* \see BLACKMISC_DECLARE_USING_MIXIN_JSON
*/
template <class Derived>
class JsonByMetaClass : public JsonOperators<Derived>
{
public:
//! Cast to JSON object
QJsonObject toJson() const
{
QJsonObject json;
auto meta = introspect<Derived>().without(MetaFlags<DisabledForJson>());
meta.forEachMemberName(*derived(), [ & ](const auto &member, const QString &name)
{
json << std::pair<QString, const std::decay_t<decltype(member)> &>(name, member); // std::make_pair causes an ambiguous operator<<
});
return Json::appendJsonObject(json, baseToJson(static_cast<const BaseOfT<Derived> *>(derived())));
}
//! Convenience function JSON as string
QString toJsonString(QJsonDocument::JsonFormat format = QJsonDocument::Indented) const
{
QJsonDocument jsonDoc(toJson());
return jsonDoc.toJson(format);
}
//! Assign from JSON object
void convertFromJson(const QJsonObject &json)
{
baseConvertFromJson(static_cast<BaseOfT<Derived> *>(derived()), json);
auto meta = introspect<Derived>().without(MetaFlags<DisabledForJson>());
meta.forEachMemberName(*derived(), [ & ](auto &member, const QString &name) { json.value(name) >> member; });
}
//! Assign from JSON object string
void convertFromJson(const QString &jsonString)
{
convertFromJson(BlackMisc::Json::jsonObjectFromString(jsonString));
}
private:
const Derived *derived() const { return static_cast<const Derived *>(this); }
Derived *derived() { return static_cast<Derived *>(this); }
template <typename T> static QJsonObject baseToJson(const T *base) { return base->toJson(); }
template <typename T> static void baseConvertFromJson(T *base, const QJsonObject &json) { base->convertFromJson(json); }
static QJsonObject baseToJson(const void *) { return {}; }
static void baseConvertFromJson(void *, const QJsonObject &) {}
static QJsonObject baseToJson(const CEmpty *) { return {}; }
static void baseConvertFromJson(CEmpty *, const QJsonObject &) {}
};
/*! /*!
* When a derived class and a base class both inherit from Mixin::JsonByTuple, * When a derived class and a base class both inherit from Mixin::JsonByTuple,
* the derived class uses this macro to disambiguate the inherited members. * the derived class uses this macro to disambiguate the inherited members.

View File

@@ -76,6 +76,16 @@ namespace BlackMisc
struct ModelsQMapKey<T, void_t<decltype(std::declval<T>() < std::declval<T>())>> : public std::true_type {}; struct ModelsQMapKey<T, void_t<decltype(std::declval<T>() < std::declval<T>())>> : public std::true_type {};
//! \endcond //! \endcond
/*!
* Trait which is true if the expression compare(a, b) is valid when a and b are instances of T and U.
*/
template <typename T, typename U, typename = void_t<>>
struct HasCompare : public std::false_type {};
//! \cond
template <typename T, typename U>
struct HasCompare<T, U, void_t<decltype(compare(std::declval<T>(), std::declval<U>()))>> : public std::true_type {};
//! \endcond
} }
#endif #endif

View File

@@ -14,6 +14,7 @@
#include "blackmiscexport.h" #include "blackmiscexport.h"
#include "dbus.h" #include "dbus.h"
#include "metaclass.h"
#include "tuple.h" #include "tuple.h"
#include "json.h" #include "json.h"
#include "compare.h" #include "compare.h"