MembershipType -> Membership, also used for JoinState

Instead of being defined independently, JoinState now uses values from
the Membership enumeration (former MemberEventContent::MembershipType)
that was moved to quotient_common.h for that purpose. Both enumerations
gained a Q_FLAG_NS decoration and operator<< overrides that strip
"Quotient::" prefix when dumping member/join state values to the log -
obviating toCString(JoinState) along the way. Quotient::MembershipType
alias is deprecated from now.

2 files changed, 45 insertions, 46 deletions

diff --git a/lib/events/roommemberevent.cpp b/lib/events/roommemberevent.cpp
index 9634ca3a..8a6bddd8 100644
--- a/lib/events/roommemberevent.cpp
+++ b/lib/events/roommemberevent.cpp
@@ -7,27 +7,26 @@
 #include "converters.h"
 #include "logging.h"
 
-#include <array>
-
-static const std::array<QString, 5> membershipStrings = {
-    { QStringLiteral("invite"), QStringLiteral("join"), QStringLiteral("knock"),
-      QStringLiteral("leave"), QStringLiteral("ban") }
-};
+#include <QtCore/QtAlgorithms>
 
 namespace Quotient {
 template <>
-struct JsonConverter<MembershipType> {
-    static MembershipType load(const QJsonValue& jv)
+struct JsonConverter<Membership> {
+    static Membership load(const QJsonValue& jv)
     {
-        const auto& membershipString = jv.toString();
-        for (auto it = membershipStrings.begin(); it != membershipStrings.end();
-             ++it)
-            if (membershipString == *it)
-                return MembershipType(it - membershipStrings.begin());
-
-        if (!membershipString.isEmpty())
-            qCWarning(EVENTS) << "Unknown MembershipType: " << membershipString;
-        return MembershipType::Undefined;
+        const auto& ms = jv.toString();
+        if (ms.isEmpty())
+        {
+            qCWarning(EVENTS) << "Empty member state:" << ms;
+            return Membership::Invalid;
+        }
+        const auto it =
+            std::find(MembershipStrings.begin(), MembershipStrings.end(), ms);
+        if (it != MembershipStrings.end())
+            return Membership(1U << (it - MembershipStrings.begin()));
+
+        qCWarning(EVENTS) << "Unknown Membership value: " << ms;
+        return Membership::Invalid;
     }
 };
 } // namespace Quotient
@@ -35,7 +34,7 @@ struct JsonConverter<MembershipType> {
 using namespace Quotient;
 
 MemberEventContent::MemberEventContent(const QJsonObject& json)
-    : membership(fromJson<MembershipType>(json["membership"_ls]))
+    : membership(fromJson<Membership>(json["membership"_ls]))
     , isDirect(json["is_direct"_ls].toBool())
     , displayName(fromJson<Omittable<QString>>(json["displayname"_ls]))
     , avatarUrl(fromJson<Omittable<QString>>(json["avatar_url"_ls]))
@@ -48,10 +47,12 @@ MemberEventContent::MemberEventContent(const QJsonObject& json)
 void MemberEventContent::fillJson(QJsonObject* o) const
 {
     Q_ASSERT(o);
-    Q_ASSERT_X(membership != MembershipType::Undefined, __FUNCTION__,
-               "The key 'membership' must be explicit in MemberEventContent");
-    if (membership != MembershipType::Undefined)
-        o->insert(QStringLiteral("membership"), membershipStrings[membership]);
+    if (membership != Membership::Invalid)
+        o->insert(
+            QStringLiteral("membership"),
+            MembershipStrings[qCountTrailingZeroBits(
+                                  std::underlying_type_t<Membership>(membership))
+                              + 1]);
     if (displayName)
         o->insert(QStringLiteral("displayname"), *displayName);
     if (avatarUrl && avatarUrl->isValid())
@@ -67,37 +68,37 @@ bool RoomMemberEvent::changesMembership() const
 
 bool RoomMemberEvent::isInvite() const
 {
-    return membership() == MembershipType::Invite && changesMembership();
+    return membership() == Membership::Invite && changesMembership();
 }
 
 bool RoomMemberEvent::isRejectedInvite() const
 {
-    return membership() == MembershipType::Leave && prevContent()
-           && prevContent()->membership == MembershipType::Invite;
+    return membership() == Membership::Leave && prevContent()
+           && prevContent()->membership == Membership::Invite;
 }
 
 bool RoomMemberEvent::isJoin() const
 {
-    return membership() == MembershipType::Join && changesMembership();
+    return membership() == Membership::Join && changesMembership();
 }
 
 bool RoomMemberEvent::isLeave() const
 {
-    return membership() == MembershipType::Leave && prevContent()
+    return membership() == Membership::Leave && prevContent()
            && prevContent()->membership != membership()
-           && prevContent()->membership != MembershipType::Ban
-           && prevContent()->membership != MembershipType::Invite;
+           && prevContent()->membership != Membership::Ban
+           && prevContent()->membership != Membership::Invite;
 }
 
 bool RoomMemberEvent::isBan() const
 {
-    return membership() == MembershipType::Ban && changesMembership();
+    return membership() == Membership::Ban && changesMembership();
 }
 
 bool RoomMemberEvent::isUnban() const
 {
-    return membership() == MembershipType::Leave && prevContent()
-           && prevContent()->membership == MembershipType::Ban;
+    return membership() == Membership::Leave && prevContent()
+           && prevContent()->membership == Membership::Ban;
 }
 
 bool RoomMemberEvent::isRename() const
diff --git a/lib/events/roommemberevent.h b/lib/events/roommemberevent.h
index f2fbe689..f3047159 100644
--- a/lib/events/roommemberevent.h
+++ b/lib/events/roommemberevent.h
@@ -7,23 +7,21 @@
 
 #include "eventcontent.h"
 #include "stateevent.h"
+#include "quotient_common.h"
 
 namespace Quotient {
 class MemberEventContent : public EventContent::Base {
 public:
-    enum MembershipType : unsigned char {
-        Invite = 0,
-        Join,
-        Knock,
-        Leave,
-        Ban,
-        Undefined
-    };
+    using MembershipType
+        [[deprecated("Use Quotient::Membership instead")]] = Membership;
 
-    explicit MemberEventContent(MembershipType mt = Join) : membership(mt) {}
+    explicit MemberEventContent(Membership ms = Membership::Join)
+        : membership(ms)
+    {}
     explicit MemberEventContent(const QJsonObject& json);
 
-    MembershipType membership;
+    Membership membership;
+    /// (Only for invites) Whether the invite is to a direct chat
     bool isDirect = false;
     Omittable<QString> displayName;
     Omittable<QUrl> avatarUrl;
@@ -33,15 +31,15 @@ protected:
     void fillJson(QJsonObject* o) const override;
 };
 
-using MembershipType = MemberEventContent::MembershipType;
+using MembershipType [[deprecated("Use Membership instead")]] = Membership;
 
 class RoomMemberEvent : public StateEvent<MemberEventContent> {
     Q_GADGET
 public:
     DEFINE_EVENT_TYPEID("m.room.member", RoomMemberEvent)
 
-    using MembershipType = MemberEventContent::MembershipType;
-    Q_ENUM(MembershipType)
+    using MembershipType
+        [[deprecated("Use Quotient::Membership instead")]] = Membership;
 
     explicit RoomMemberEvent(const QJsonObject& obj) : StateEvent(typeId(), obj)
     {}
@@ -65,7 +63,7 @@ public:
         : StateEvent(type, fullJson)
     {}
 
-    MembershipType membership() const { return content().membership; }
+    Membership membership() const { return content().membership; }
     QString userId() const { return stateKey(); }
     bool isDirect() const { return content().isDirect; }
     Omittable<QString> newDisplayName() const { return content().displayName; }