src/common/buffersyncer.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2019 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 #ifndef BUFFERSYNCER_H_
  22 #define BUFFERSYNCER_H_
  23
  24 #include "syncableobject.h"
  25 #include "types.h"
  26 #include "message.h"
  27
  28 class BufferSyncer : public SyncableObject
  29 {
  30     SYNCABLE_OBJECT
  31         Q_OBJECT
  32
  33 public:
  34     explicit BufferSyncer(QObject *parent);
  35     explicit BufferSyncer(const QHash<BufferId, MsgId> &lastSeenMsg, const QHash<BufferId, MsgId> &markerLines, const QHash<BufferId, Message::Types> &activities, const QHash<BufferId, int> &highlightCounts, QObject *parent);
  36
  37     inline virtual const QMetaObject *syncMetaObject() const { return &staticMetaObject; }
  38
  39     MsgId lastSeenMsg(BufferId buffer) const;
  40     MsgId markerLine(BufferId buffer) const;
  41     Message::Types activity(BufferId buffer) const;
  42     int highlightCount(BufferId buffer) const;
  43
  44     void markActivitiesChanged() {
  45         for (auto buffer : _bufferActivities.keys()) {
  46             emit bufferActivityChanged(buffer, activity(buffer));
  47         }
  48     }
  49
  50     void markHighlightCountsChanged() {
  51         for (auto buffer : _highlightCounts.keys()) {
  52             emit highlightCountChanged(buffer, highlightCount(buffer));
  53         }
  54     }
  55
  56 public slots:
  57     QVariantList initLastSeenMsg() const;
  58     void initSetLastSeenMsg(const QVariantList &);
  59
  60     QVariantList initMarkerLines() const;
  61     void initSetMarkerLines(const QVariantList &);
  62
  63     QVariantList initActivities() const;
  64     void initSetActivities(const QVariantList &);
  65
  66     QVariantList initHighlightCounts() const;
  67     void initSetHighlightCounts(const QVariantList &);
  68
  69     virtual inline void requestSetLastSeenMsg(BufferId buffer, const MsgId &msgId) { REQUEST(ARG(buffer), ARG(msgId)) }
  70     virtual inline void requestSetMarkerLine(BufferId buffer, const MsgId &msgId) { REQUEST(ARG(buffer), ARG(msgId)) setMarkerLine(buffer, msgId); }
  71
  72     virtual inline void setBufferActivity(BufferId buffer, int activity) {
  73         auto flags = Message::Types(activity);
  74         SYNC(ARG(buffer), ARG(activity));
  75         _bufferActivities[buffer] = flags;
  76         emit bufferActivityChanged(buffer, flags);
  77     }
  78
  79     virtual inline void setHighlightCount(BufferId buffer, int count) {
  80         SYNC(ARG(buffer), ARG(count));
  81         _highlightCounts[buffer] = count;
  82         emit highlightCountChanged(buffer, count);
  83     }
  84
  85     virtual inline void requestRemoveBuffer(BufferId buffer) { REQUEST(ARG(buffer)) }
  86     virtual void removeBuffer(BufferId buffer);
  87
  88     virtual inline void requestRenameBuffer(BufferId buffer, QString newName) { REQUEST(ARG(buffer), ARG(newName)) }
  89     virtual inline void renameBuffer(BufferId buffer, QString newName) { SYNC(ARG(buffer), ARG(newName)) emit bufferRenamed(buffer, newName); }
  90
  91     virtual inline void requestMergeBuffersPermanently(BufferId buffer1, BufferId buffer2) { emit REQUEST(ARG(buffer1), ARG(buffer2)) }
  92     virtual void mergeBuffersPermanently(BufferId buffer1, BufferId buffer2);
  93
  94     virtual inline void requestPurgeBufferIds() { REQUEST(NO_ARG); }
  95
  96     virtual inline void requestMarkBufferAsRead(BufferId buffer) { REQUEST(ARG(buffer)) emit bufferMarkedAsRead(buffer); }
  97     virtual inline void markBufferAsRead(BufferId buffer) { SYNC(ARG(buffer)) emit bufferMarkedAsRead(buffer); }
  98
  99 signals:
 100     void lastSeenMsgSet(BufferId buffer, const MsgId &msgId);
 101     void markerLineSet(BufferId buffer, const MsgId &msgId);
 102     void bufferRemoved(BufferId buffer);
 103     void bufferRenamed(BufferId buffer, QString newName);
 104     void buffersPermanentlyMerged(BufferId buffer1, BufferId buffer2);
 105     void bufferMarkedAsRead(BufferId buffer);
 106     void bufferActivityChanged(BufferId, Message::Types);
 107     void highlightCountChanged(BufferId, int);
 108
 109 protected slots:
 110     bool setLastSeenMsg(BufferId buffer, const MsgId &msgId);
 111     bool setMarkerLine(BufferId buffer, const MsgId &msgId);
 112
 113 protected:
 114     inline QList<BufferId> lastSeenBufferIds() const { return _lastSeenMsg.keys(); }
 115     inline QList<BufferId> markerLineBufferIds() const { return _markerLines.keys(); }
 116     inline QHash<BufferId, MsgId> markerLines() const { return _markerLines; }
 117
 118 private:
 119     QHash<BufferId, MsgId> _lastSeenMsg;
 120     QHash<BufferId, MsgId> _markerLines;
 121     QHash<BufferId, Message::Types> _bufferActivities;
 122     QHash<BufferId, int> _highlightCounts;
 123 };
 124
 125
 126 #endif