aboutsummaryrefslogtreecommitdiff
path: root/lib/eventitem.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/eventitem.h')
-rw-r--r--lib/eventitem.h249
1 files changed, 124 insertions, 125 deletions
diff --git a/lib/eventitem.h b/lib/eventitem.h
index 5f1d10c9..96e45b38 100644
--- a/lib/eventitem.h
+++ b/lib/eventitem.h
@@ -1,151 +1,150 @@
-/******************************************************************************
- * Copyright (C) 2018 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
- */
+// SPDX-FileCopyrightText: 2018 Kitsune Ral <kitsune-ral@users.sf.net>
+// SPDX-License-Identifier: LGPL-2.1-or-later
#pragma once
+#include "quotient_common.h"
+
+#include "events/callevents.h"
+#include "events/filesourceinfo.h"
#include "events/stateevent.h"
+#include <any>
#include <utility>
-namespace QMatrixClient
-{
- class StateEventBase;
+namespace Quotient {
+
+namespace EventStatus {
+ Q_NAMESPACE_EXPORT(QUOTIENT_API)
+
+ /** Special marks an event can assume
+ *
+ * This is used to hint at a special status of some events in UI.
+ * All values except Redacted and Hidden are mutually exclusive.
+ */
+ enum Code {
+ Normal = 0x0, ///< No special designation
+ Submitted = 0x01, ///< The event has just been submitted for sending
+ FileUploaded = 0x02, ///< The file attached to the event has been
+ /// uploaded to the server
+ Departed = 0x03, ///< The event has left the client
+ ReachedServer = 0x04, ///< The server has received the event
+ SendingFailed = 0x05, ///< The server could not receive the event
+ Redacted = 0x08, ///< The event has been redacted
+ Replaced = 0x10, ///< The event has been replaced
+ Hidden = 0x100, ///< The event should not be shown in the timeline
+ };
+ Q_ENUM_NS(Code)
+} // namespace EventStatus
- class EventStatus
+class QUOTIENT_API EventItemBase {
+public:
+ explicit EventItemBase(RoomEventPtr&& e) : evt(std::move(e))
{
- Q_GADGET
- public:
- /** Special marks an event can assume
- *
- * This is used to hint at a special status of some events in UI.
- * Most status values are mutually exclusive.
- */
- enum Code {
- Normal = 0x0, //< No special designation
- Submitted = 0x01, //< The event has just been submitted for sending
- Departed = 0x02, //< The event has left the client
- ReachedServer = 0x03, //< The server has received the event
- SendingFailed = 0x04, //< The server could not receive the event
- Redacted = 0x08, //< The event has been redacted
- Hidden = 0x10, //< The event should be hidden
- };
- Q_DECLARE_FLAGS(Status, Code)
- Q_FLAG(Status)
- };
+ Q_ASSERT(evt);
+ }
- class EventItemBase
+ const RoomEvent* event() const { return rawPtr(evt); }
+ const RoomEvent* get() const { return event(); }
+ template <EventClass<RoomEvent> EventT>
+ const EventT* viewAs() const
{
- public:
- explicit EventItemBase(RoomEventPtr&& e)
- : evt(std::move(e))
- {
- Q_ASSERT(evt);
- }
-
- const RoomEvent* event() const { return rawPtr(evt); }
- const RoomEvent* get() const { return event(); }
- template <typename EventT>
- const EventT* viewAs() const { return eventCast<const EventT>(evt); }
- const RoomEventPtr& operator->() const { return evt; }
- const RoomEvent& operator*() const { return *evt; }
-
- // Used for event redaction
- RoomEventPtr replaceEvent(RoomEventPtr&& other)
- {
- return std::exchange(evt, move(other));
- }
-
- private:
- RoomEventPtr evt;
- };
+ return eventCast<const EventT>(evt);
+ }
+ const RoomEventPtr& operator->() const { return evt; }
+ const RoomEvent& operator*() const { return *evt; }
- class TimelineItem : public EventItemBase
+ // Used for event redaction
+ RoomEventPtr replaceEvent(RoomEventPtr&& other)
{
- public:
- // For compatibility with Qt containers, even though we use
- // a std:: container now for the room timeline
- using index_t = int;
+ return std::exchange(evt, move(other));
+ }
- TimelineItem(RoomEventPtr&& e, index_t number)
- : EventItemBase(std::move(e)), idx(number)
- { }
+ /// Store arbitrary data with the event item
+ void setUserData(std::any userData) { data = std::move(userData); }
+ /// Obtain custom data previously stored with the event item
+ const std::any& userdata() const { return data; }
+ std::any& userData() { return data; }
- index_t index() const { return idx; }
+protected:
+ template <EventClass<RoomEvent> EventT>
+ EventT* getAs()
+ {
+ return eventCast<EventT>(evt);
+ }
- private:
- index_t idx;
- };
+private:
+ RoomEventPtr evt;
+ std::any data;
+};
+
+class QUOTIENT_API TimelineItem : public EventItemBase {
+public:
+ // For compatibility with Qt containers, even though we use
+ // a std:: container now for the room timeline
+ using index_t = int;
+
+ TimelineItem(RoomEventPtr&& e, index_t number)
+ : EventItemBase(std::move(e)), idx(number)
+ {}
+
+ index_t index() const { return idx; }
- template<>
- inline const StateEventBase* EventItemBase::viewAs<StateEventBase>() const
+private:
+ index_t idx;
+};
+
+template <>
+inline const StateEvent* EventItemBase::viewAs<StateEvent>() const
+{
+ return evt->isStateEvent() ? weakPtrCast<const StateEvent>(evt) : nullptr;
+}
+
+template <>
+inline const CallEvent* EventItemBase::viewAs<CallEvent>() const
+{
+ return evt->is<CallEvent>() ? weakPtrCast<const CallEvent>(evt) : nullptr;
+}
+
+class QUOTIENT_API PendingEventItem : public EventItemBase {
+public:
+ using EventItemBase::EventItemBase;
+
+ EventStatus::Code deliveryStatus() const { return _status; }
+ QDateTime lastUpdated() const { return _lastUpdated; }
+ QString annotation() const { return _annotation; }
+
+ void setDeparted() { setStatus(EventStatus::Departed); }
+ void setFileUploaded(const FileSourceInfo &uploadedFileData);
+ void setReachedServer(const QString& eventId)
{
- return evt->isStateEvent() ? weakPtrCast<const StateEventBase>(evt)
- : nullptr;
+ setStatus(EventStatus::ReachedServer);
+ (*this)->addId(eventId);
}
-
- template<>
- inline const CallEventBase* EventItemBase::viewAs<CallEventBase>() const
+ void setSendingFailed(QString errorText)
{
- return evt->isCallEvent() ? weakPtrCast<const CallEventBase>(evt)
- : nullptr;
+ setStatus(EventStatus::SendingFailed);
+ _annotation = std::move(errorText);
}
+ void resetStatus() { setStatus(EventStatus::Submitted); }
- class PendingEventItem : public EventItemBase
- {
- Q_GADGET
- public:
- using EventItemBase::EventItemBase;
-
- EventStatus::Code deliveryStatus() const { return _status; }
- QDateTime lastUpdated() const { return _lastUpdated; }
- QString annotation() const { return _annotation; }
-
- void setDeparted() { setStatus(EventStatus::Departed); }
- void setReachedServer(const QString& eventId)
- {
- setStatus(EventStatus::ReachedServer);
- (*this)->addId(eventId);
- }
- void setSendingFailed(QString errorText)
- {
- setStatus(EventStatus::SendingFailed);
- _annotation = std::move(errorText);
- }
- void resetStatus() { setStatus(EventStatus::Submitted); }
-
- private:
- EventStatus::Code _status = EventStatus::Submitted;
- QDateTime _lastUpdated = QDateTime::currentDateTimeUtc();
- QString _annotation;
-
- void setStatus(EventStatus::Code status)
- {
- _status = status;
- _lastUpdated = QDateTime::currentDateTimeUtc();
- _annotation.clear();
- }
- };
+private:
+ EventStatus::Code _status = EventStatus::Submitted;
+ QDateTime _lastUpdated = QDateTime::currentDateTimeUtc();
+ QString _annotation;
- inline QDebug& operator<<(QDebug& d, const TimelineItem& ti)
+ void setStatus(EventStatus::Code status)
{
- QDebugStateSaver dss(d);
- d.nospace() << "(" << ti.index() << "|" << ti->id() << ")";
- return d;
+ _status = status;
+ _lastUpdated = QDateTime::currentDateTimeUtc();
+ _annotation.clear();
}
+};
+
+inline QDebug& operator<<(QDebug& d, const TimelineItem& ti)
+{
+ QDebugStateSaver dss(d);
+ d.nospace() << "(" << ti.index() << "|" << ti->id() << ")";
+ return d;
}
-Q_DECLARE_METATYPE(QMatrixClient::EventStatus)
+} // namespace Quotient
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-16 00:56:38 +0000