src/common/buffersyncer.h

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