src: Yearly copyright bump
[quassel.git] / src / client / networkmodel.h
index a97372e..b45767f 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-2018 by the Quassel Project                        *
+ *   Copyright (C) 2005-2019 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -18,8 +18,9 @@
  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
-#ifndef NETWORKMODEL_H
-#define NETWORKMODEL_H
+#pragma once
+
+#include "client-export.h"
 
 #include "bufferinfo.h"
 #include "clientsettings.h"
@@ -40,12 +41,12 @@ class NetworkItem : public PropertyMapItem
     Q_PROPERTY(QString currentServer READ currentServer)
     Q_PROPERTY(int nickCount READ nickCount)
 
-public :
-    NetworkItem(const NetworkId &netid, AbstractTreeItem *parent = 0);
+public:
+    NetworkItem(const NetworkId& netid, AbstractTreeItem* parent = nullptr);
 
-    virtual QStringList propertyOrder() const;
+    QStringList propertyOrder() const override;
 
-    virtual QVariant data(int column, int row) const;
+    QVariant data(int column, int row) const override;
 
     /**
      * Escapes a string as HTML, ready for Qt markup.
@@ -58,29 +59,29 @@ public :
      * If true, replace spaces with non-breaking spaces (i.e. ' '), otherwise only HTML escape.
      * @endparblock
      */
-    static QString escapeHTML(const QString &string, bool useNonbreakingSpaces = false);
+    static QString escapeHTML(const QStringstring, bool useNonbreakingSpaces = false);
 
     inline bool isActive() const { return (bool)_network ? _network->isConnected() : false; }
 
-    inline const NetworkId &networkId() const { return _networkId; }
+    inline const NetworkIdnetworkId() const { return _networkId; }
     inline QString networkName() const { return (bool)_network ? _network->networkName() : QString(); }
     inline QString currentServer() const { return (bool)_network ? _network->currentServer() : QString(); }
     inline int nickCount() const { return (bool)_network ? _network->ircUsers().count() : 0; }
 
-    virtual QString toolTip(int column) const;
+    QString toolTip(int column) const override;
 
-    BufferItem *findBufferItem(BufferId bufferId);
-    inline BufferItem *findBufferItem(const BufferInfo &bufferInfo) { return findBufferItem(bufferInfo.bufferId()); }
-    BufferItem *bufferItem(const BufferInfo &bufferInfo);
-    inline StatusBufferItem *statusBufferItem() const { return _statusBufferItem; }
+    BufferItemfindBufferItem(BufferId bufferId);
+    inline BufferItem* findBufferItem(const BufferInfo& bufferInfo) { return findBufferItem(bufferInfo.bufferId()); }
+    BufferItem* bufferItem(const BufferInfo& bufferInfo);
+    inline StatusBufferItemstatusBufferItem() const { return _statusBufferItem; }
 
 public slots:
-    void setNetworkName(const QString &networkName);
-    void setCurrentServer(const QString &serverName);
+    void setNetworkName(const QStringnetworkName);
+    void setCurrentServer(const QStringserverName);
 
-    void attachNetwork(Network *network);
-    void attachIrcChannel(IrcChannel *channel);
-    void attachIrcUser(IrcUser *ircUser);
+    void attachNetwork(Networknetwork);
+    void attachIrcChannel(IrcChannelchannel);
+    void attachIrcUser(IrcUserircUser);
 
 signals:
     void networkDataChanged(int column = -1);
@@ -91,12 +92,11 @@ private slots:
 
 private:
     NetworkId _networkId;
-    StatusBufferItem *_statusBufferItem;
+    StatusBufferItem_statusBufferItem;
 
     QPointer<Network> _network;
 };
 
-
 /*****************************************
  *  Fancy Buffer Items
  *****************************************/
@@ -107,24 +107,24 @@ class BufferItem : public PropertyMapItem
     Q_PROPERTY(QString topic READ topic)
     Q_PROPERTY(int nickCount READ nickCount)
 
-public :
-    BufferItem(const BufferInfo &bufferInfo, AbstractTreeItem *parent = 0);
+public:
+    BufferItem(BufferInfo bufferInfo, AbstractTreeItem* parent = nullptr);
 
-    virtual QStringList propertyOrder() const;
+    QStringList propertyOrder() const override;
 
-    inline const BufferInfo &bufferInfo() const { return _bufferInfo; }
-    virtual QVariant data(int column, int role) const;
-    virtual bool setData(int column, const QVariant &value, int role);
+    inline const BufferInfobufferInfo() const { return _bufferInfo; }
+    QVariant data(int column, int role) const override;
+    bool setData(int column, const QVariant& value, int role) override;
 
     inline BufferId bufferId() const { return _bufferInfo.bufferId(); }
     inline BufferInfo::Type bufferType() const { return _bufferInfo.type(); }
 
-    virtual void setBufferName(const QString &name);
+    virtual void setBufferName(const QStringname);
     virtual inline QString bufferName() const { return _bufferInfo.bufferName(); }
     virtual inline QString topic() const { return QString(); }
     virtual inline int nickCount() const { return 0; }
 
-    virtual inline bool isActive() const { return qobject_cast<NetworkItem *>(parent())->isActive(); }
+    virtual inline bool isActive() const { return qobject_cast<NetworkItem*>(parent())->isActive(); }
 
     inline MsgId lastSeenMsgId() const { return _lastSeenMsgId; }
     inline MsgId markerLineMsgId() const { return _markerLineMsgId; }
@@ -134,17 +134,17 @@ public :
     inline BufferInfo::ActivityLevel activityLevel() const { return _activity; }
     void setActivityLevel(BufferInfo::ActivityLevel level);
     void clearActivityLevel();
-    void updateActivityLevel(const Message &msg);
+    void updateActivityLevel(const Messagemsg);
     void setActivity(Message::Types msg, bool highlight);
     bool addActivity(Message::Types msg, bool highlight);
 
-    inline const MsgId &firstUnreadMsgId() const { return _firstUnreadMsgId; }
+    inline const MsgIdfirstUnreadMsgId() const { return _firstUnreadMsgId; }
 
     bool isCurrentBuffer() const;
-    virtual QString toolTip(int column) const;
+    QString toolTip(int column) const override;
 
 public slots:
-    virtual inline void setTopic(const QString &) { emit dataChanged(1); }
+    virtual inline void setTopic(const QString&) { emit dataChanged(1); }
     virtual inline void setEncrypted(bool) { emit dataChanged(); }
 
 private:
@@ -155,52 +155,49 @@ private:
     MsgId _firstUnreadMsgId;
 };
 
-
 /*****************************************
-*  StatusBufferItem
-*****************************************/
+ *  StatusBufferItem
+ *****************************************/
 class StatusBufferItem : public BufferItem
 {
     Q_OBJECT
 
 public:
-    StatusBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
+    StatusBufferItem(const BufferInfo& bufferInfo, NetworkItem* parent);
 
-    virtual QString toolTip(int column) const;
-    virtual inline QString bufferName() const { return tr("Status Buffer"); }
+    QString toolTip(int column) const override;
+    inline QString bufferName() const override { return tr("Status Buffer"); }
 };
 
-
 /*****************************************
-*  QueryBufferItem
-*****************************************/
+ *  QueryBufferItem
+ *****************************************/
 class QueryBufferItem : public BufferItem
 {
     Q_OBJECT
 
 public:
-    QueryBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
+    QueryBufferItem(const BufferInfo& bufferInfo, NetworkItem* parent);
 
-    virtual QVariant data(int column, int role) const;
-    virtual bool setData(int column, const QVariant &value, int role);
+    QVariant data(int column, int role) const override;
+    bool setData(int column, const QVariant& value, int role) override;
 
-    virtual inline bool isActive() const { return (bool)_ircUser; }
-    virtual QString toolTip(int column) const;
+    inline bool isActive() const override { return (bool)_ircUser; }
+    QString toolTip(int column) const override;
 
-    virtual void setBufferName(const QString &name);
+    void setBufferName(const QString& name) override;
 
 public slots:
-    void setIrcUser(IrcUser *ircUser);
+    void setIrcUser(IrcUserircUser);
     void removeIrcUser();
 
 private:
-    IrcUser *_ircUser;
+    IrcUser_ircUser;
 };
 
-
 /*****************************************
-*  ChannelBufferItem
-*****************************************/
+ *  ChannelBufferItem
+ *****************************************/
 class UserCategoryItem;
 
 class ChannelBufferItem : public BufferItem
@@ -208,16 +205,16 @@ class ChannelBufferItem : public BufferItem
     Q_OBJECT
 
 public:
-    ChannelBufferItem(const BufferInfo &bufferInfo, AbstractTreeItem *parent);
+    ChannelBufferItem(const BufferInfo& bufferInfo, AbstractTreeItem* parent);
 
-    virtual QVariant data(int column, int role) const;
-    virtual inline bool isActive() const { return (bool)_ircChannel; }
-    virtual QString toolTip(int column) const;
+    QVariant data(int column, int role) const override;
+    inline bool isActive() const override { return (bool)_ircChannel; }
+    QString toolTip(int column) const override;
 
-    virtual inline QString topic() const { return (bool)_ircChannel ? _ircChannel->topic() : QString(); }
-    virtual inline int nickCount() const { return (bool)_ircChannel ? _ircChannel->ircUsers().count() : 0; }
+    inline QString topic() const override { return (bool)_ircChannel ? _ircChannel->topic() : QString(); }
+    inline int nickCount() const override { return (bool)_ircChannel ? _ircChannel->ircUsers().count() : 0; }
 
-    void attachIrcChannel(IrcChannel *ircChannel);
+    void attachIrcChannel(IrcChannelircChannel);
 
     /**
      * Gets the list of channel modes for a given nick.
@@ -225,50 +222,50 @@ public:
      * @param[in] nick IrcUser nickname to check
      * @returns Channel modes as a string if any, otherwise empty string
      */
-    QString nickChannelModes(const QString &nick) const;
+    QString nickChannelModes(const QStringnick) const;
 
 public slots:
-    void join(const QList<IrcUser *> &ircUsers);
-    void part(IrcUser *ircUser);
+    void join(const QList<IrcUser*>& ircUsers);
+    void part(IrcUserircUser);
 
-    UserCategoryItem *findCategoryItem(int categoryId);
-    void addUserToCategory(IrcUser *ircUser);
-    void addUsersToCategory(const QList<IrcUser *> &ircUser);
-    void removeUserFromCategory(IrcUser *ircUser);
-    void userModeChanged(IrcUser *ircUser);
+    UserCategoryItemfindCategoryItem(int categoryId);
+    void addUserToCategory(IrcUserircUser);
+    void addUsersToCategory(const QList<IrcUser*>& ircUser);
+    void removeUserFromCategory(IrcUserircUser);
+    void userModeChanged(IrcUserircUser);
 
 private slots:
     void ircChannelParted();
     void ircChannelDestroyed();
 
 private:
-    IrcChannel *_ircChannel;
+    IrcChannel_ircChannel;
 };
 
-
 /*****************************************
-*  User Category Items (like @vh etc.)
-*****************************************/
+ *  User Category Items (like @vh etc.)
+ *****************************************/
 class IrcUserItem;
-class UserCategoryItem : public PropertyMapItem
+
+class CLIENT_EXPORT UserCategoryItem : public PropertyMapItem
 {
     Q_OBJECT
     Q_PROPERTY(QString categoryName READ categoryName)
 
-public :
-    UserCategoryItem(int category, AbstractTreeItem *parent);
+public:
+    UserCategoryItem(int category, AbstractTreeItemparent);
 
-    virtual QStringList propertyOrder() const;
+    QStringList propertyOrder() const override;
 
     QString categoryName() const;
     inline int categoryId() const { return _category; }
-    virtual QVariant data(int column, int role) const;
+    QVariant data(int column, int role) const override;
 
-    IrcUserItem *findIrcUser(IrcUser *ircUser);
-    void addUsers(const QList<IrcUser *> &ircUser);
-    bool removeUser(IrcUser *ircUser);
+    IrcUserItem* findIrcUser(IrcUser* ircUser);
+    void addUsers(const QList<IrcUser*>& ircUser);
+    bool removeUser(IrcUserircUser);
 
-    static int categoryFromModes(const QString &modes);
+    static int categoryFromModes(const QStringmodes);
 
 private:
     int _category;
@@ -276,26 +273,25 @@ private:
     static const QList<QChar> categories;
 };
 
-
 /*****************************************
-*  Irc User Items
-*****************************************/
+ *  Irc User Items
+ *****************************************/
 class IrcUserItem : public PropertyMapItem
 {
     Q_OBJECT
     Q_PROPERTY(QString nickName READ nickName)
 
-public :
-    IrcUserItem(IrcUser *ircUser, AbstractTreeItem *parent);
+public:
+    IrcUserItem(IrcUser* ircUser, AbstractTreeItem* parent);
 
-    virtual QStringList propertyOrder() const;
+    QStringList propertyOrder() const override;
 
     inline QString nickName() const { return _ircUser ? _ircUser->nick() : QString(); }
     inline bool isActive() const { return _ircUser ? !_ircUser->isAway() : false; }
 
-    inline IrcUser *ircUser() { return _ircUser; }
-    virtual QVariant data(int column, int role) const;
-    virtual QString toolTip(int column) const;
+    inline IrcUserircUser() { return _ircUser; }
+    QVariant data(int column, int role) const override;
+    QString toolTip(int column) const override;
 
     /**
      * Gets the list of channel modes for this nick if parented to channel.
@@ -311,16 +307,16 @@ private:
     QPointer<IrcUser> _ircUser;
 };
 
-
 /*****************************************
  * NetworkModel
  *****************************************/
-class NetworkModel : public TreeModel
+class CLIENT_EXPORT NetworkModel : public TreeModel
 {
     Q_OBJECT
 
 public:
-    enum Role {
+    enum Role
+    {
         BufferTypeRole = TreeModel::UserRole,
         ItemActiveRole,
         BufferActivityRole,
@@ -335,7 +331,8 @@ public:
         MarkerLineMsgIdRole,
     };
 
-    enum ItemType {
+    enum ItemType
+    {
         NetworkItemType = 0x01,
         BufferItemType = 0x02,
         UserCategoryItemType = 0x04,
@@ -343,25 +340,25 @@ public:
     };
     Q_DECLARE_FLAGS(ItemTypes, ItemType)
 
-    NetworkModel(QObject *parent = 0);
+    NetworkModel(QObject* parent = nullptr);
     static QList<QVariant> defaultHeader();
 
-    static bool mimeContainsBufferList(const QMimeData *mimeData);
-    static QList<QPair<NetworkId, BufferId> > mimeDataToBufferList(const QMimeData *mimeData);
+    static bool mimeContainsBufferList(const QMimeDatamimeData);
+    static QList<QPair<NetworkId, BufferId>> mimeDataToBufferList(const QMimeData* mimeData);
 
-    virtual QStringList mimeTypes() const;
-    virtual QMimeData *mimeData(const QModelIndexList &) const;
+    QStringList mimeTypes() const override;
+    QMimeData* mimeData(const QModelIndexList&) const override;
 
-    void attachNetwork(Network *network);
+    void attachNetwork(Networknetwork);
 
-    bool isBufferIndex(const QModelIndex &) const;
-    //Buffer *getBufferByIndex(const QModelIndex &) const;
+    bool isBufferIndex(const QModelIndex&) const;
+    // Buffer *getBufferByIndex(const QModelIndex &) const;
     QModelIndex networkIndex(NetworkId networkId);
     QModelIndex bufferIndex(BufferId bufferId);
 
-    const Network *networkByIndex(const QModelIndex &index) const;
+    const Network* networkByIndex(const QModelIndex& index) const;
 
-    BufferInfo::ActivityLevel bufferActivity(const BufferInfo &buffer) const;
+    BufferInfo::ActivityLevel bufferActivity(const BufferInfobuffer) const;
 
     //! Finds a buffer with a given name in a given network
     /** This performs a linear search through all BufferItems, hence it is expensive.
@@ -369,7 +366,7 @@ public:
      *  @param bufferName The bufferName we look for
      *  @return The id of the buffer if found, an invalid one else
      */
-    BufferId bufferId(NetworkId networkId, const QString &bufferName, Qt::CaseSensitivity cs = Qt::CaseInsensitive) const;
+    BufferId bufferId(NetworkId networkId, const QStringbufferName, Qt::CaseSensitivity cs = Qt::CaseInsensitive) const;
 
     QString bufferName(BufferId bufferId) const;
     BufferInfo::Type bufferType(BufferId bufferId) const;
@@ -381,18 +378,18 @@ public:
 
     inline QList<BufferId> allBufferIds() const { return _bufferItemCache.keys(); }
     QList<BufferId> allBufferIdsSorted() const;
-    void sortBufferIds(QList<BufferId> &bufferIds) const;
+    void sortBufferIds(QList<BufferId>bufferIds) const;
 
 public slots:
     void bufferUpdated(BufferInfo bufferInfo);
     void removeBuffer(BufferId bufferId);
-    MsgId lastSeenMsgId(const BufferId &bufferId);
-    void setLastSeenMsgId(const BufferId &bufferId, const MsgId &msgId);
-    void setMarkerLineMsgId(const BufferId &bufferId, const MsgId &msgId);
-    void setBufferActivity(const BufferId &bufferId, BufferInfo::ActivityLevel activity);
-    void clearBufferActivity(const BufferId &bufferId);
-    void updateBufferActivity(Message &msg);
-    void networkRemoved(const NetworkId &networkId);
+    MsgId lastSeenMsgId(const BufferIdbufferId);
+    void setLastSeenMsgId(const BufferId& bufferId, const MsgId& msgId);
+    void setMarkerLineMsgId(const BufferId& bufferId, const MsgId& msgId);
+    void setBufferActivity(const BufferIdbufferId, BufferInfo::ActivityLevel activity);
+    void clearBufferActivity(const BufferIdbufferId);
+    void updateBufferActivity(Messagemsg);
+    void networkRemoved(const NetworkIdnetworkId);
     void bufferActivityChanged(BufferId, Message::Types);
     void highlightCountChanged(BufferId, int);
 
@@ -402,30 +399,27 @@ signals:
     void markerLineSet(BufferId buffer, MsgId msg);
 
 private slots:
-    void checkForRemovedBuffers(const QModelIndex &parent, int start, int end);
-    void checkForNewBuffers(const QModelIndex &parent, int start, int end);
+    void checkForRemovedBuffers(const QModelIndexparent, int start, int end);
+    void checkForNewBuffers(const QModelIndexparent, int start, int end);
     void messageRedirectionSettingsChanged();
 
 private:
     int networkRow(NetworkId networkId) const;
-    NetworkItem *findNetworkItem(NetworkId networkId) const;
-    NetworkItem *networkItem(NetworkId networkId);
-    inline BufferItem *findBufferItem(const BufferInfo &bufferInfo) const { return findBufferItem(bufferInfo.bufferId()); }
-    BufferItem *findBufferItem(BufferId bufferId) const;
-    BufferItem *bufferItem(const BufferInfo &bufferInfo);
+    NetworkItemfindNetworkItem(NetworkId networkId) const;
+    NetworkItemnetworkItem(NetworkId networkId);
+    inline BufferItem* findBufferItem(const BufferInfo& bufferInfo) const { return findBufferItem(bufferInfo.bufferId()); }
+    BufferItemfindBufferItem(BufferId bufferId) const;
+    BufferItem* bufferItem(const BufferInfo& bufferInfo);
 
-    void updateBufferActivity(BufferItem *bufferItem, const Message &msg);
+    void updateBufferActivity(BufferItem* bufferItem, const Message& msg);
 
-    static bool bufferItemLessThan(const BufferItem *left, const BufferItem *right);
+    static bool bufferItemLessThan(const BufferItem* left, const BufferItem* right);
 
-    QHash<BufferId, BufferItem *> _bufferItemCache;
+    QHash<BufferId, BufferItem*> _bufferItemCache;
 
     int _userNoticesTarget;
     int _serverNoticesTarget;
     int _errorMsgsTarget;
 };
 
-
 Q_DECLARE_OPERATORS_FOR_FLAGS(NetworkModel::ItemTypes)
-
-#endif // NETWORKMODEL_H