src/common/buffersyncer.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2015 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
  27 class BufferSyncer : public SyncableObject
  28 {
  29     SYNCABLE_OBJECT
  30         Q_OBJECT
  31
  32 public:
  33     explicit BufferSyncer(QObject *parent);
  34     explicit BufferSyncer(const QHash<BufferId, MsgId> &lastSeenMsg, const QHash<BufferId, MsgId> &markerLines, QObject *parent);
  35
  36     inline virtual const QMetaObject *syncMetaObject() const { return &staticMetaObject; }
  37
  38     MsgId lastSeenMsg(BufferId buffer) const;
  39     MsgId markerLine(BufferId buffer) const;
  40
  41 public slots:
  42     QVariantList initLastSeenMsg() const;
  43     void initSetLastSeenMsg(const QVariantList &);
  44
  45     QVariantList initMarkerLines() const;
  46     void initSetMarkerLines(const QVariantList &);
  47
  48     virtual inline void requestSetLastSeenMsg(BufferId buffer, const MsgId &msgId) { REQUEST(ARG(buffer), ARG(msgId)) }
  49     virtual inline void requestSetMarkerLine(BufferId buffer, const MsgId &msgId) { REQUEST(ARG(buffer), ARG(msgId)) setMarkerLine(buffer, msgId); }
  50
  51     virtual inline void requestRemoveBuffer(BufferId buffer) { REQUEST(ARG(buffer)) }
  52     virtual void removeBuffer(BufferId buffer);
  53
  54     virtual inline void requestRenameBuffer(BufferId buffer, QString newName) { REQUEST(ARG(buffer), ARG(newName)) }
  55     virtual inline void renameBuffer(BufferId buffer, QString newName) { SYNC(ARG(buffer), ARG(newName)) emit bufferRenamed(buffer, newName); }
  56
  57     virtual inline void requestMergeBuffersPermanently(BufferId buffer1, BufferId buffer2) { emit REQUEST(ARG(buffer1), ARG(buffer2)) }
  58     virtual void mergeBuffersPermanently(BufferId buffer1, BufferId buffer2);
  59
  60     virtual inline void requestPurgeBufferIds() { REQUEST(NO_ARG); }
  61
  62     virtual inline void requestMarkBufferAsRead(BufferId buffer) { REQUEST(ARG(buffer)) emit bufferMarkedAsRead(buffer); }
  63     virtual inline void markBufferAsRead(BufferId buffer) { SYNC(ARG(buffer)) emit bufferMarkedAsRead(buffer); }
  64
  65 signals:
  66     void lastSeenMsgSet(BufferId buffer, const MsgId &msgId);
  67     void markerLineSet(BufferId buffer, const MsgId &msgId);
  68     void bufferRemoved(BufferId buffer);
  69     void bufferRenamed(BufferId buffer, QString newName);
  70     void buffersPermanentlyMerged(BufferId buffer1, BufferId buffer2);
  71     void bufferMarkedAsRead(BufferId buffer);
  72
  73 protected slots:
  74     bool setLastSeenMsg(BufferId buffer, const MsgId &msgId);
  75     bool setMarkerLine(BufferId buffer, const MsgId &msgId);
  76
  77 protected:
  78     inline QList<BufferId> lastSeenBufferIds() const { return _lastSeenMsg.keys(); }
  79     inline QList<BufferId> markerLineBufferIds() const { return _markerLines.keys(); }
  80     inline QHash<BufferId, MsgId> markerLines() const { return _markerLines; }
  81
  82 private:
  83     QHash<BufferId, MsgId> _lastSeenMsg;
  84     QHash<BufferId, MsgId> _markerLines;
  85 };
  86
  87
  88 #endif