/* Copyright (C) 2015 * 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 and at http://www.swift-project.org/license.html. 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_COMPARE_H #define BLACKMISC_COMPARE_H #include "blackmisc/metaclass.h" #include "blackmisc/inheritancetraits.h" #include "blackmisc/typetraits.h" #include "blackmisc/range.h" #include #include #include namespace BlackMisc { class CEmpty; namespace Mixin { /*! * CRTP class template from which a derived class can inherit operator== implemented using its compare function. * * \tparam Derived Must overload a function bool compare(const Derived &, const Derived &) which can be found by ADL. */ template class EqualsByCompare { public: //! Equals friend bool operator ==(const Derived &a, const Derived &b) { return compare(a, b) == 0; } //! Not equal friend bool operator !=(const Derived &a, const Derived &b) { return compare(a, b) != 0; } }; /*! * CRTP class template from which a derived class can inherit operator== implemented by metaclass. */ template 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().without(MetaFlags()); bool result = baseEquals(static_cast *>(&a), static_cast *>(&b)); meta.forEachMember([ & ](auto member) { result = result && EqualsByMetaClass::membersEqual(member.in(a), member.in(b), member.m_flags); }); return result; } template 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; } template static bool membersEqual(const T &a, const T &b, Flags) { return membersEqual(a, b, std::integral_constant(Flags::value & CaseInsensitiveComparison)>()); } template static bool membersEqual(const T &a, const T &b, std::true_type) { return a.compare(b, Qt::CaseInsensitive) == 0; } template static bool membersEqual(const T &a, const T &b, std::false_type) { return a == b; } }; /*! * CRTP class template from which a derived class can inherit operator< implemented using its compare function. * * \tparam Derived Must overload a function bool compare(const Derived &, const Derived &) which can be found by ADL. */ template class LessThanByCompare { public: //! Less than friend bool operator <(const Derived &a, const Derived &b) { return compare(a, b) < 0; } //! Greater than friend bool operator >(const Derived &a, const Derived &b) { return compare(a, b) > 0; } //! Less than or equal friend bool operator <=(const Derived &a, const Derived &b) { return compare(a, b) <= 0; } //! Greater than or equal friend bool operator >=(const Derived &a, const Derived &b) { return compare(a, b) >= 0; } }; /*! * CRTP class template from which a derived class can inherit operator< implemented by metaclass. */ template 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) { auto meta = introspect().without(MetaFlags()); bool result = baseLess(static_cast *>(&a), static_cast *>(&b)); bool gt = baseLess(static_cast *>(&b), static_cast *>(&a)); meta.forEachMember([ & ](auto member) { result = result || LessThanByMetaClass::membersLess(gt, member.in(a), member.in(b), member.m_flags); }); return result; } template 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; } template static bool membersLess(bool &io_greaterThan, const T &a, const T &b, Flags) { using CaseInsensitive = std::integral_constant(Flags::value & CaseInsensitiveComparison)>; if (io_greaterThan) { return false; } io_greaterThan = membersLess(b, a, CaseInsensitive()); return membersLess(a, b, CaseInsensitive()); } template static bool membersLess(const T &a, const T &b, std::true_type) { return a.compare(b, Qt::CaseInsensitive) < 0; } template static bool membersLess(const T &a, const T &b, std::false_type) { return a < b; } }; /*! * CRTP class template from which a derived class can inherit non-member compare() implemented by metaclass. */ template 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) { auto meta = introspect().without(MetaFlags()); int result = baseCompare(static_cast *>(&a), static_cast *>(&b)); meta.forEachMember([ & ](auto member) { result = result ? result : CompareByMetaClass::membersCompare(member.in(a), member.in(b), member.m_flags); }); return result; } template 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; } template static int membersCompare(const T &a, const T &b, Flags) { using CaseInsensitive = std::integral_constant(Flags::value & CaseInsensitiveComparison)>; return membersCompare(a, b, CaseInsensitive(), THasCompare()); } template static int membersCompare(const T &a, const T &b, std::true_type, U) { return a.compare(b, Qt::CaseInsensitive); } template static int membersCompare(const T &a, const T &b, std::false_type, std::true_type) { return compare(a, b); } template static int membersCompare(const T &a, const T &b, std::false_type, std::false_type) { return a < b ? -1 : b < a ? 1 : 0; } }; } // Mixin /*! * Helps with debugging Mixin::EqualsByMetaClass. */ class CMetaMemberComparator { public: //! Return list of pairs containing member name and bool indicating if member is equal. template ::value, int> = 0> QList> operator ()(const T &a, const T &b) const { auto meta = introspect().without(MetaFlags()); auto result = baseEquals(static_cast *>(&a), static_cast *>(&b)); meta.forEachMember([ & ](auto member) { constexpr auto flags = decltype(member.m_flags)(); result.append(qMakePair(member.latin1Name(), membersEqual(member.in(a), member.in(b), flags & MetaFlags()))); }); return result; } //! Recurse into one of the submembers of T, comparing members of that member. template ::value, int> = 0> QList> operator ()(const T &a, const T &b, QStringList memberNames) const // clazy:exclude=function-args-by-ref { if (memberNames.isEmpty()) { return CMetaMemberComparator()(a, b); } auto meta = introspect().without(MetaFlags()); auto result = baseEquals(static_cast *>(&a), static_cast *>(&b), memberNames); const auto memberName = memberNames.takeFirst(); meta.forEachMember([ & ](auto member) { const auto p = [ & ](const auto &m) { return qMakePair(memberName + '.' + m.first, m.second); }; if (member.latin1Name() == memberName) { result.append(makeRange(CMetaMemberComparator()(member.in(a), member.in(b), memberNames)).transform(p)); } }); return result; } //! Return empty list if T doesn't have a metaclass. template ::value, int> = 0> QList> operator ()(const T &, const T &) const { return {}; } //! Return empty list if T doesn't have a metaclass. template ::value, int> = 0> QList> operator ()(const T &, const T &, QStringList) const { return {}; } // clazy:exclude=function-args-by-ref private: template static auto baseEquals(const T *a, const T *b) { return CMetaMemberComparator()(*a, *b); } template static auto baseEquals(const T *a, const T *b, const QStringList &memberNames) { return CMetaMemberComparator()(*a, *b, memberNames); } static auto baseEquals(const void *, const void *, const QStringList & = {}) { return QList>(); } static auto baseEquals(const CEmpty *, const CEmpty *, const QStringList & = {}) { return QList>(); } template static bool membersEqual(const T &a, const T &b, std::true_type) { return a.compare(b, Qt::CaseInsensitive) == 0; } template static bool membersEqual(const T &a, const T &b, std::false_type) { return a == b; } }; } // BlackMisc #endif