aboutsummaryrefslogtreecommitdiff
path: root/jobs/syncjob.h
blob: a9138a656db45d9b3abeb8fd178a4cd8ab851e7c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/******************************************************************************
 * Copyright (C) 2016 Felix Rohrbach <kde@fxrh.de>
 *
 * 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
 */

#ifndef QMATRIXCLIENT_SYNCJOB_H
#define QMATRIXCLIENT_SYNCJOB_H

#include "basejob.h"

#include "../joinstate.h"
#include "../events/event.h"

namespace QMatrixClient
{
    /**
     * @brief A crude wrapper around a container of pointers that owns pointers
     * to contained objects
     *
     * Similar to vector<unique_ptr<>>, upon deletion, EventsHolder
     * will delete all events contained in it.
     */
    template <typename ContainerT>
    class Owning : public ContainerT
    {
        public:
            Owning() = default;
#if defined(_MSC_VER) && _MSC_VER < 1900
            // Workaround: Dangerous (auto_ptr style) copy constructor because
            // VS2013 (unnecessarily) instantiates EventList::QVector<>::toList()
            // which instantiates QList< Owning<> > which needs the contained
            // object to have a non-deleted copy constructor.
            Owning(Owning& other) : ContainerT(std::move(other)) { }
#else
            Owning(Owning&) = delete;
#endif
            Owning(Owning&& other) : ContainerT(std::move(other)) { }
            ~Owning() { for (auto e: *this) delete e; }

            /**
             * @brief returns the underlying events and releases the ownership
             *
             * Acts similar to unique_ptr::release.
             */
            ContainerT release() { return std::move(*this); }
    };

    class SyncRoomData
    {
    public:
        class EventList : public Owning<Events>
        {
            private:
                QString jsonKey;
            public:
                explicit EventList(QString k) : jsonKey(k) { }
                void fromJson(const QJsonObject& roomContents);
        };

        QString roomId;
        JoinState joinState;
        EventList state;
        EventList timeline;
        EventList ephemeral;
        EventList accountData;
        EventList inviteState;

        bool timelineLimited;
        QString timelinePrevBatch;
        int highlightCount;
        int notificationCount;

        SyncRoomData(QString roomId_ = QString(),
                     JoinState joinState_ = JoinState::Join,
                     const QJsonObject& room_ = QJsonObject());
    };
}
Q_DECLARE_TYPEINFO(QMatrixClient::SyncRoomData, Q_MOVABLE_TYPE);

namespace QMatrixClient
{
    // QVector cannot work with non-copiable objects, std::vector can.
    using SyncData = std::vector<SyncRoomData>;

    class ConnectionData;
    class SyncJob: public BaseJob
    {
        public:
            SyncJob(ConnectionData* connection, QString since=QString());
            virtual ~SyncJob();
            
            void setFilter(QString filter);
            void setFullState(bool full);
            void setPresence(QString presence);
            void setTimeout(int timeout);

            SyncData& roomData();
            QString nextBatch() const;

        protected:
            QString apiPath() const override;
            QUrlQuery query() const override;
            Status parseJson(const QJsonDocument& data) override;

        private:
            class Private;
            Private* d;
    };
}

#endif // QMATRIXCLIENT_SYNCJOB_H