src/common/bufferinfo.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2020 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 "types.h"
  26
  27 class QString;
  28 class QDataStream;
  29
  30 class COMMON_EXPORT BufferInfo
  31 {
  32 public:
  33     enum Type
  34     {
  35         InvalidBuffer = 0x00,
  36         StatusBuffer = 0x01,
  37         ChannelBuffer = 0x02,
  38         QueryBuffer = 0x04,
  39         GroupBuffer = 0x08
  40     };
  41
  42     enum Activity
  43     {
  44         NoActivity = 0x00,
  45         OtherActivity = 0x01,
  46         NewMessage = 0x02,
  47         Highlight = 0x40
  48     };
  49     Q_DECLARE_FLAGS(ActivityLevel, Activity)
  50
  51     BufferInfo();
  52     BufferInfo(BufferId id, NetworkId networkid, Type type, uint gid = 0, QString buf = QString());
  53
  54     static BufferInfo fakeStatusBuffer(NetworkId networkId);
  55
  56     inline bool isValid() const { return _bufferId != 0; }
  57     inline const BufferId& bufferId() const { return _bufferId; }
  58     inline void setBufferId(BufferId id) { _bufferId = id; }
  59     inline const NetworkId& networkId() const { return _netid; }
  60     inline const Type& type() const { return _type; }
  61     inline const uint& groupId() const { return _groupId; }
  62     void setGroupId(uint gid) { _groupId = gid; }
  63
  64     QString bufferName() const;
  65     bool acceptsRegularMessages() const;
  66
  67     inline bool operator==(const BufferInfo& other) const { return _bufferId == other._bufferId; }
  68
  69 private:
  70     BufferId _bufferId;
  71     NetworkId _netid;
  72     Type _type{InvalidBuffer};
  73     uint _groupId{0};
  74     QString _bufferName;
  75
  76     friend uint qHash(const BufferInfo&);
  77     friend QDataStream& operator<<(QDataStream& out, const BufferInfo& bufferInfo);
  78     friend QDataStream& operator>>(QDataStream& in, BufferInfo& bufferInfo);
  79 };
  80
  81 QDataStream& operator<<(QDataStream& out, const BufferInfo& bufferInfo);
  82 QDataStream& operator>>(QDataStream& in, BufferInfo& bufferInfo);
  83 QDebug operator<<(QDebug dbg, const BufferInfo& b);
  84
  85 Q_DECLARE_METATYPE(BufferInfo)
  86 Q_DECLARE_OPERATORS_FOR_FLAGS(BufferInfo::ActivityLevel)
  87
  88 uint qHash(const BufferInfo&);