Add rough instructions for synchronizing the i18n repository
[quassel.git] / src / client / clientbacklogmanager.h
1 /***************************************************************************
2  *   Copyright (C) 2005-2020 by the Quassel Project                        *
3  *   devel@quassel-irc.org                                                 *
4  *                                                                         *
5  *   This program is free software; you can redistribute it and/or modify  *
6  *   it under the terms of the GNU General Public License as published by  *
7  *   the Free Software Foundation; either version 2 of the License, or     *
8  *   (at your option) version 3.                                           *
9  *                                                                         *
10  *   This program is distributed in the hope that it will be useful,       *
11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
13  *   GNU General Public License for more details.                          *
14  *                                                                         *
15  *   You should have received a copy of the GNU General Public License     *
16  *   along with this program; if not, write to the                         *
17  *   Free Software Foundation, Inc.,                                       *
18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
19  ***************************************************************************/
20
21 #pragma once
22
23 #include "client-export.h"
24
25 #include "backlogmanager.h"
26 #include "message.h"
27
28 class BacklogRequester;
29
30 class CLIENT_EXPORT ClientBacklogManager : public BacklogManager
31 {
32     Q_OBJECT
33
34 public:
35     ClientBacklogManager(QObject* parent = nullptr);
36
37     // helper for the backlogRequester, as it isn't a QObject and can't emit itself
38     inline void emitMessagesRequested(const QString& msg) const { emit messagesRequested(msg); }
39
40     void reset();
41
42 public slots:
43     QVariantList requestBacklog(BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1, int additional = 0) override;
44     void receiveBacklog(BufferId bufferId, MsgId first, MsgId last, int limit, int additional, QVariantList msgs) override;
45     void receiveBacklogAll(MsgId first, MsgId last, int limit, int additional, QVariantList msgs) override;
46
47     void requestInitialBacklog();
48
49     void checkForBacklog(BufferId bufferId);
50     void checkForBacklog(const BufferIdList& bufferIds);
51
52 signals:
53     void messagesReceived(BufferId bufferId, int count) const;
54     void messagesRequested(const QString&) const;
55     void messagesProcessed(const QString&) const;
56
57     void updateProgress(int, int);
58
59 private:
60     bool isBuffering();
61     BufferIdList filterNewBufferIds(const BufferIdList& bufferIds);
62
63     void dispatchMessages(const MessageList& messages, bool sort = false);
64
65     BacklogRequester* _requester{nullptr};
66     bool _initBacklogRequested{false};
67     QSet<BufferId> _buffersRequested;
68 };
69
70 // inlines
71 inline void ClientBacklogManager::checkForBacklog(BufferId bufferId)
72 {
73     checkForBacklog(BufferIdList() << bufferId);
74 }