Move out common message event content classes

ImageContent is usable outside of m.room.message (in particular, m.room.avatar
uses the same structure for content. And EventContent::Base is very suitable to
derive from even for standard event content structures (such as in room name
events), let alone non-standard ones.
Also, renamed MessageEventContent to EventContent (for obvious reasons).

4 files changed, 326 insertions, 270 deletions

diff --git a/events/eventcontent.cpp b/events/eventcontent.cpp
new file mode 100644
index 00000000..205d404b
--- /dev/null
+++ b/events/eventcontent.cpp
@@ -0,0 +1,71 @@
+/******************************************************************************
+ * Copyright (C) 2017 Kitsune Ral <kitsune-ral@users.sf.net>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+#include "eventcontent.h"
+
+#include <QtCore/QUrl>
+#include <QtCore/QMimeDatabase>
+
+using namespace QMatrixClient::EventContent;
+
+QJsonObject Base::toJson() const
+{
+    QJsonObject o;
+    fillJson(&o);
+    return o;
+}
+
+QJsonObject InfoBase::toInfoJson() const
+{
+    QJsonObject info;
+    fillInfoJson(&info);
+    return info;
+}
+
+FileInfo::FileInfo(const QUrl& u, int payloadSize, const QMimeType& mimeType,
+                   const QString& originalFilename)
+    : InfoBase(mimeType), url(u), payloadSize(payloadSize)
+    , originalName(originalFilename)
+{ }
+
+FileInfo::FileInfo(const QUrl& u, const QJsonObject& infoJson,
+                   const QString& originalFilename)
+    : FileInfo(u, infoJson["size"].toInt(),
+               QMimeDatabase().mimeTypeForName(infoJson["mimetype"].toString()),
+               originalFilename)
+{
+    if (!mimeType.isValid())
+        mimeType = QMimeDatabase().mimeTypeForData(QByteArray());
+}
+
+void FileInfo::fillInfoJson(QJsonObject* infoJson) const
+{
+    Q_ASSERT(infoJson);
+    infoJson->insert("size", payloadSize);
+    infoJson->insert("mimetype", mimeType.name());
+}
+
+void FileInfo::fillJson(QJsonObject* json) const
+{
+    Q_ASSERT(json);
+    json->insert("url", url.toString());
+    if (!originalName.isEmpty())
+        json->insert("filename", originalName);
+    json->insert("info", toInfoJson());
+}
+
diff --git a/events/eventcontent.h b/events/eventcontent.h
new file mode 100644
index 00000000..2c8d7f3f
--- /dev/null
+++ b/events/eventcontent.h
@@ -0,0 +1,245 @@
+/******************************************************************************
+ * Copyright (C) 2017 Kitsune Ral <kitsune-ral@users.sf.net>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+#pragma once
+
+// This file contains generic event content definitions, applicable to room
+// message events as well as other events (e.g., avatars).
+
+#include <QtCore/QJsonObject>
+#include <QtCore/QMimeType>
+#include <QtCore/QUrl>
+#include <QtCore/QSize>
+
+namespace QMatrixClient
+{
+    namespace EventContent
+    {
+        /**
+         * A base class for all content types that can be stored
+         * in a RoomMessageEvent
+         *
+         * Each content type class should have a constructor taking
+         * a QJsonObject and override fillJson() with an implementation
+         * that will fill the target QJsonObject with stored values. It is
+         * assumed but not required that a content object can also be created
+         * from plain data. fillJson() should only fill the main JSON object
+         * but not the "info" subobject if it exists for a certain content type;
+         * use \p InfoBase to de/serialize "info" parts with an optional URL
+         * on the top level.
+         */
+        class Base
+        {
+            public:
+                virtual ~Base() = default;
+
+                QJsonObject toJson() const;
+
+                QMimeType mimeType;
+
+            protected:
+                Base() = default;
+                explicit Base(const QMimeType& type) : mimeType(type) { }
+
+                virtual void fillJson(QJsonObject* o) const = 0;
+        };
+
+        /**
+         * A base class for content types that have an "info" object in their
+         * JSON representation
+         *
+         * These include most multimedia types currently in the CS API spec.
+         * Derived classes should override fillInfoJson() to fill the "info"
+         * subobject, BUT NOT the main JSON object. Most but not all "info"
+         * classes (specifically, those deriving from FileInfo) should also
+         * have a constructor that accepts two parameters, QUrl and QJsonObject,
+         * in order to load the URL+info part from JSON.
+         */
+        class InfoBase: public Base
+        {
+            public:
+                QJsonObject toInfoJson() const;
+
+            protected:
+                using Base::Base;
+
+                virtual void fillInfoJson(QJsonObject* /*infoJson*/) const { }
+        };
+
+        // The below structures fairly follow CS spec 11.2.1.6. The overall
+        // set of attributes for each content types is a superset of the spec
+        // but specific aggregation structure is altered. See doc comments to
+        // each type for the list of available attributes.
+
+        /**
+         * Base class for content types that consist of a URL along with
+         * additional information. Most of message types except textual fall
+         * under this category.
+         */
+        class FileInfo: public InfoBase
+        {
+            public:
+                explicit FileInfo(const QUrl& u, int payloadSize = -1,
+                                  const QMimeType& mimeType = {},
+                                  const QString& originalFilename = {});
+                FileInfo(const QUrl& u, const QJsonObject& infoJson,
+                         const QString& originalFilename = {});
+
+                QUrl url;
+                int payloadSize;
+                QString originalName;
+
+            protected:
+                void fillJson(QJsonObject* json) const override;
+                void fillInfoJson(QJsonObject* infoJson) const override;
+        };
+
+        /**
+         * A base class for image info types: image, thumbnail, video
+         *
+         * \tparam InfoT base info class; should derive from \p InfoBase
+         */
+        template <class InfoT = FileInfo>
+        class ImageInfo : public InfoT
+        {
+            public:
+                explicit ImageInfo(const QUrl& u, int fileSize = -1,
+                                   QMimeType mimeType = {},
+                                   const QSize& imageSize = {})
+                    : InfoT(u, fileSize, mimeType), imageSize(imageSize)
+                { }
+                ImageInfo(const QUrl& u, const QJsonObject& infoJson,
+                          const QString& originalFilename = {})
+                    : InfoT(u, infoJson, originalFilename)
+                    , imageSize(infoJson["w"].toInt(), infoJson["h"].toInt())
+                { }
+
+                void fillInfoJson(QJsonObject* infoJson) const override
+                {
+                    InfoT::fillInfoJson(infoJson);
+                    infoJson->insert("w", imageSize.width());
+                    infoJson->insert("h", imageSize.height());
+                }
+
+                QSize imageSize;
+        };
+
+        /**
+         * A base class for an info type that carries a thumbnail
+         *
+         * This class decorates the underlying type, adding ability to save/load
+         * a thumbnail to/from "info" subobject of the JSON representation of
+         * event content; namely, "info/thumbnail_url" and "info/thumbnail_info"
+         * fields are used.
+         *
+         * \tparam InfoT base info class; should derive from \p InfoBase
+         */
+        template <class InfoT = InfoBase>
+        class Thumbnailed : public InfoT
+        {
+            public:
+                template <typename... ArgTs>
+                explicit Thumbnailed(const ImageInfo<>& thumbnail,
+                                     ArgTs&&... infoArgs)
+                    : InfoT(std::forward<ArgTs>(infoArgs)...)
+                    , thumbnail(thumbnail)
+                { }
+
+                explicit Thumbnailed(const QJsonObject& infoJson)
+                    : thumbnail(infoJson["thumbnail_url"].toString(),
+                                infoJson["thumbnail_info"].toObject())
+                { }
+
+                Thumbnailed(const QUrl& u, const QJsonObject& infoJson,
+                            const QString& originalFilename = {})
+                    : InfoT(u, infoJson, originalFilename)
+                    , thumbnail(infoJson["thumbnail_url"].toString(),
+                                infoJson["thumbnail_info"].toObject())
+                { }
+
+                void fillInfoJson(QJsonObject* infoJson) const override
+                {
+                    InfoT::fillInfoJson(infoJson);
+                    infoJson->insert("thumbnail_url", thumbnail.url.toString());
+                    infoJson->insert("thumbnail_info", thumbnail.toInfoJson());
+                }
+
+                ImageInfo<> thumbnail;
+        };
+
+        /**
+         * One more facility base class for content types that have a URL and
+         * additional info
+         *
+         * Types that derive from UrlWith<InfoT> take "url" and, optionally,
+         * "filename" values from the top-level JSON object and the rest of
+         * information from the "info" subobject.
+         *
+         * \tparam InfoT base info class; should derive from \p FileInfo or
+         * provide a constructor with a compatible signature
+         */
+        template <class InfoT> // InfoT : public FileInfo
+        class UrlWith : public InfoT
+        {
+            public:
+                using InfoT::InfoT;
+                explicit UrlWith(const QJsonObject& json)
+                    : InfoT(json["url"].toString(), json["info"].toObject(),
+                            json["filename"].toString())
+                { }
+        };
+
+        /**
+         * Content class for m.image
+         *
+         * Available fields:
+         * - corresponding to the top-level JSON:
+         *   - url
+         *   - filename (extension to the spec)
+         * - corresponding to the "info" subobject:
+         *   - payloadSize ("size" in JSON)
+         *   - mimeType ("mimetype" in JSON)
+         *   - imageSize (QSize for a combination of "h" and "w" in JSON)
+         *   - thumbnail.url ("thumbnail_url" in JSON)
+         * - corresponding to the "info/thumbnail_info" subobject: contents of
+         *   thumbnail field, in the same vein as for the main image:
+         *   - payloadSize
+         *   - mimeType
+         *   - imageSize
+         */
+        using ImageContent = UrlWith<Thumbnailed<ImageInfo<>>>;
+
+        /**
+         * Content class for m.file
+         *
+         * Available fields:
+         * - corresponding to the top-level JSON:
+         *   - url
+         *   - filename
+         * - corresponding to the "info" subobject:
+         *   - payloadSize ("size" in JSON)
+         *   - mimeType ("mimetype" in JSON)
+         *   - thumbnail.url ("thumbnail_url" in JSON)
+         * - corresponding to the "info/thumbnail_info" subobject:
+         *   - thumbnail.payloadSize
+         *   - thumbnail.mimeType
+         *   - thumbnail.imageSize (QSize for "h" and "w" in JSON)
+         */
+        using FileContent = UrlWith<Thumbnailed<FileInfo>>;
+    }  // namespace EventContent
+}  // namespace QMatrixClient
diff --git a/events/roommessageevent.cpp b/events/roommessageevent.cpp
index 3fb0226a..82bd07b6 100644
--- a/events/roommessageevent.cpp
+++ b/events/roommessageevent.cpp
@@ -23,7 +23,7 @@
 #include <QtCore/QMimeDatabase>
 
 using namespace QMatrixClient;
-using namespace MessageEventContent;
+using namespace EventContent;
 
 using MsgType = RoomMessageEvent::MsgType;
 
@@ -124,20 +124,6 @@ QJsonObject RoomMessageEvent::toJson() const
     return obj;
 }
 
-QJsonObject Base::toJson() const
-{
-    QJsonObject o;
-    fillJson(&o);
-    return o;
-}
-
-QJsonObject InfoBase::toInfoJson() const
-{
-    QJsonObject info;
-    fillInfoJson(&info);
-    return info;
-}
-
 TextContent::TextContent(const QString& text, const QString& contentType)
     : Base(QMimeDatabase().mimeTypeForName(contentType)), body(text)
 { }
@@ -167,38 +153,6 @@ void TextContent::fillJson(QJsonObject* json) const
     json->insert("formatted_body", body);
 }
 
-FileInfo::FileInfo(const QUrl& u, int payloadSize, const QMimeType& mimeType,
-                 const QString& originalFilename)
-    : InfoBase(mimeType), url(u), payloadSize(payloadSize)
-    , originalName(originalFilename)
-{ }
-
-FileInfo::FileInfo(const QUrl& u, const QJsonObject& infoJson,
-                 const QString& originalFilename)
-    : FileInfo(u, infoJson["size"].toInt(),
-              QMimeDatabase().mimeTypeForName(infoJson["mimetype"].toString()),
-              originalFilename)
-{
-    if (!mimeType.isValid())
-        mimeType = QMimeDatabase().mimeTypeForData(QByteArray());
-}
-
-void FileInfo::fillInfoJson(QJsonObject* infoJson) const
-{
-    Q_ASSERT(infoJson);
-    infoJson->insert("size", payloadSize);
-    infoJson->insert("mimetype", mimeType.name());
-}
-
-void FileInfo::fillJson(QJsonObject* json) const
-{
-    Q_ASSERT(json);
-    json->insert("url", url.toString());
-    if (!originalName.isEmpty())
-        json->insert("filename", originalName);
-    json->insert("info", toInfoJson());
-}
-
 LocationContent::LocationContent(const QString& geoUri,
                                  const ImageInfo<>& thumbnail)
     : Thumbnailed<>(thumbnail), geoUri(geoUri)
diff --git a/events/roommessageevent.h b/events/roommessageevent.h
index ad413943..b98f12d6 100644
--- a/events/roommessageevent.h
+++ b/events/roommessageevent.h
@@ -20,65 +20,11 @@
 
 #include "event.h"
 
-#include <QtCore/QUrl>
-#include <QtCore/QMimeType>
-#include <QtCore/QSize>
+#include "eventcontent.h"
 
 namespace QMatrixClient
 {
-    namespace MessageEventContent
-    {
-        /**
-         * A base class for all content types that can be stored
-         * in a RoomMessageEvent
-         *
-         * Each content type class should have a constructor taking
-         * a QJsonObject and override fillJson() with an implementation
-         * that will fill the target QJsonObject with stored values. It is
-         * assumed but not required that a content object can also be created
-         * from plain data. fillJson() should only fill the main JSON object
-         * but not the "info" subobject if it exists for a certain content type;
-         * use \p InfoBase to de/serialize "info" parts with an optional URL
-         * on the top level.
-         */
-        class Base
-        {
-            public:
-                virtual ~Base() = default;
-
-                QJsonObject toJson() const;
-
-                QMimeType mimeType;
-
-            protected:
-                Base() = default;
-                explicit Base(const QMimeType& type) : mimeType(type) { }
-
-                virtual void fillJson(QJsonObject* o) const = 0;
-        };
-
-        /**
-         * A base class for content types that have an "info" object in their
-         * JSON representation
-         *
-         * These include most multimedia types currently in the CS API spec.
-         * Derived classes should override fillInfoJson() to fill the "info"
-         * subobject, BUT NOT the main JSON object. Most but not all "info"
-         * classes (specifically, those deriving from UrlInfo) should also
-         * have a constructor that accepts two parameters, QUrl and QJsonObject,
-         * in order to load the URL+info part from JSON.
-         */
-        class InfoBase: public Base
-        {
-            public:
-                QJsonObject toInfoJson() const;
-
-            protected:
-                using Base::Base;
-
-                virtual void fillInfoJson(QJsonObject* /*infoJson*/) const { }
-        };
-    }  // namespace MessageEventContent
+    namespace MessageEventContent = EventContent; // Back-compatibility
 
     /**
      * The event class corresponding to m.room.message events
@@ -94,19 +40,19 @@ namespace QMatrixClient
 
             RoomMessageEvent(const QString& plainBody,
                              const QString& jsonMsgType,
-                             MessageEventContent::Base* content = nullptr)
+                             EventContent::Base* content = nullptr)
                 : RoomEvent(Type::RoomMessage)
                 , _msgtype(jsonMsgType), _plainBody(plainBody), _content(content)
             { }
             explicit RoomMessageEvent(const QString& plainBody,
                                       MsgType msgType = MsgType::Text,
-                                      MessageEventContent::Base* content = nullptr);
+                                      EventContent::Base* content = nullptr);
             explicit RoomMessageEvent(const QJsonObject& obj);
 
             MsgType msgtype() const;
             QString rawMsgtype() const       { return _msgtype; }
             const QString& plainBody() const { return _plainBody; }
-            const MessageEventContent::Base* content() const
+            const EventContent::Base* content() const
                                              { return _content.data(); }
             QMimeType mimeType() const;
 
@@ -117,18 +63,15 @@ namespace QMatrixClient
         private:
             QString _msgtype;
             QString _plainBody;
-            QScopedPointer<MessageEventContent::Base> _content;
+            QScopedPointer<EventContent::Base> _content;
 
             REGISTER_ENUM(MsgType)
     };
     using MessageEventType = RoomMessageEvent::MsgType;
 
-    namespace MessageEventContent
+    namespace EventContent
     {
-        // The below structures fairly follow CS spec 11.2.1.6. The overall
-        // set of attributes for each content types is a superset of the spec
-        // but specific aggregation structure is altered. See doc comments to
-        // each type for the list of available attributes.
+        // Additional event content types
 
         /**
          * Rich text content for m.text, m.emote, m.notice
@@ -148,163 +91,6 @@ namespace QMatrixClient
         };
 
         /**
-         * Base class for content types that consist of a URL along with
-         * additional information
-         *
-         * All message types except the (hyper)text mentioned above and
-         * m.location fall under this category.
-         */
-        class FileInfo: public InfoBase
-        {
-            public:
-                explicit FileInfo(const QUrl& u, int payloadSize = -1,
-                                 const QMimeType& mimeType = {},
-                                 const QString& originalFilename = {});
-                FileInfo(const QUrl& u, const QJsonObject& infoJson,
-                        const QString& originalFilename = {});
-
-                QUrl url;
-                int payloadSize;
-                QString originalName;
-
-            protected:
-                void fillJson(QJsonObject* json) const override;
-                void fillInfoJson(QJsonObject* infoJson) const override;
-        };
-
-        /**
-         * A base class for image info types: image, thumbnail, video
-         *
-         * \tparam InfoT base info class; should derive from \p InfoBase
-         */
-        template <class InfoT = FileInfo>
-        class ImageInfo : public InfoT
-        {
-            public:
-                explicit ImageInfo(const QUrl& u, int fileSize = -1,
-                                   QMimeType mimeType = {},
-                                   const QSize& imageSize = {})
-                    : InfoT(u, fileSize, mimeType), imageSize(imageSize)
-                { }
-                ImageInfo(const QUrl& u, const QJsonObject& infoJson,
-                          const QString& originalFilename = {})
-                    : InfoT(u, infoJson, originalFilename)
-                    , imageSize(infoJson["w"].toInt(), infoJson["h"].toInt())
-                { }
-
-                void fillInfoJson(QJsonObject* infoJson) const /* override */
-                {
-                    InfoT::fillInfoJson(infoJson);
-                    infoJson->insert("w", imageSize.width());
-                    infoJson->insert("h", imageSize.height());
-                }
-
-                QSize imageSize;
-        };
-
-        /**
-         * A base class for an info type that carries a thumbnail
-         *
-         * This class provides a means to save/load a thumbnail to/from "info"
-         * subobject of the JSON representation of a message; namely,
-         * "info/thumbnail_url" and "info/thumbnail_info" fields are used.
-         *
-         * \tparam InfoT base info class; should derive from \p InfoBase
-         */
-        template <class InfoT = InfoBase>
-        class Thumbnailed : public InfoT
-        {
-            public:
-                template <typename... ArgTs>
-                explicit Thumbnailed(const ImageInfo<>& thumbnail,
-                                     ArgTs&&... infoArgs)
-                    : InfoT(std::forward<ArgTs>(infoArgs)...)
-                    , thumbnail(thumbnail)
-                { }
-
-                explicit Thumbnailed(const QJsonObject& infoJson)
-                    : thumbnail(infoJson["thumbnail_url"].toString(),
-                                infoJson["thumbnail_info"].toObject())
-                { }
-
-                Thumbnailed(const QUrl& u, const QJsonObject& infoJson,
-                            const QString& originalFilename = {})
-                    : InfoT(u, infoJson, originalFilename)
-                    , thumbnail(infoJson["thumbnail_url"].toString(),
-                                infoJson["thumbnail_info"].toObject())
-                { }
-
-                void fillInfoJson(QJsonObject* infoJson) const /* override */
-                {
-                    InfoT::fillInfoJson(infoJson);
-                    infoJson->insert("thumbnail_url", thumbnail.url.toString());
-                    infoJson->insert("thumbnail_info", thumbnail.toInfoJson());
-                }
-
-                ImageInfo<> thumbnail;
-        };
-
-        /**
-         * One more facility base class for content types that have a URL and
-         * additional info
-         *
-         * The assumed layout for types enabled by a combination of UrlInfo and
-         * UrlWith<> is the following: "url" and, optionally, "filename" in the
-         * top-level JSON and the rest of information inside the "info" subobject.
-         *
-         * \tparam InfoT base info class; should derive from \p UrlInfo or
-         * provide a constructor with a compatible signature
-         */
-        template <class InfoT> // InfoT : public FileInfo
-        class UrlWith : public InfoT
-        {
-            public:
-                using InfoT::InfoT;
-                explicit UrlWith(const QJsonObject& json)
-                    : InfoT(json["url"].toString(), json["info"].toObject(),
-                            json["filename"].toString())
-                { }
-        };
-
-        /**
-         * Content class for m.image
-         *
-         * Available fields:
-         * - corresponding to the top-level JSON:
-         *   - url
-         *   - filename (extension to the spec)
-         * - corresponding to the "info" subobject:
-         *   - payloadSize ("size" in JSON)
-         *   - mimeType ("mimetype" in JSON)
-         *   - imageSize (QSize for a combination of "h" and "w" in JSON)
-         *   - thumbnail.url ("thumbnail_url" in JSON)
-         * - corresponding to the "info/thumbnail_info" subobject: contents of
-         *   thumbnail field, in the same vein as for the main image:
-         *   - payloadSize
-         *   - mimeType
-         *   - imageSize
-         */
-        using ImageContent = UrlWith<Thumbnailed<ImageInfo<>>>;
-
-        /**
-         * Content class for m.file
-         *
-         * Available fields:
-         * - corresponding to the top-level JSON:
-         *   - url
-         *   - filename
-         * - corresponding to the "info" subobject:
-         *   - payloadSize ("size" in JSON)
-         *   - mimeType ("mimetype" in JSON)
-         *   - thumbnail.url ("thumbnail_url" in JSON)
-         * - corresponding to the "info/thumbnail_info" subobject:
-         *   - thumbnail.payloadSize
-         *   - thumbnail.mimeType
-         *   - thumbnail.imageSize (QSize for "h" and "w" in JSON)
-         */
-        using FileContent = UrlWith<Thumbnailed<FileInfo>>;
-
-        /**
          * Content class for m.location
          *
          * Available fields:
@@ -380,5 +166,5 @@ namespace QMatrixClient
          *   - duration
          */
         using AudioContent = UrlWith<PlayableInfo>;
-    }  // namespace MessageEventContent
+    }  // namespace EventContent
 }  // namespace QMatrixClient