src/common/buffersyncer.h

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