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