modernize: Use override instead of virtual

[quassel.git] / src / common / ircuser.h

diff --git a/src/common/ircuser.h b/src/common/ircuser.h
index aa90f47..968ca7a 100644 (file)
--- a/src/common/ircuser.h
+++ b/src/common/ircuser.h
@@ -18,8 +18,9 @@
  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
-#ifndef IRCUSER_H
-#define IRCUSER_H
+#pragma once
+
+#include "common-export.h"
 
 #include <QSet>
 #include <QString>
@@ -34,10 +35,10 @@ class SignalProxy;
 class Network;
 class IrcChannel;
 
-class IrcUser : public SyncableObject
+class COMMON_EXPORT IrcUser : public SyncableObject
 {
-    SYNCABLE_OBJECT
     Q_OBJECT
+    SYNCABLE_OBJECT
 
     Q_PROPERTY(QString user READ user WRITE setUser)
     Q_PROPERTY(QString host READ host WRITE setHost)
@@ -50,9 +51,6 @@ class IrcUser : public SyncableObject
     Q_PROPERTY(QDateTime loginTime READ loginTime WRITE setLoginTime)
     Q_PROPERTY(QString server READ server WRITE setServer)
     Q_PROPERTY(QString ircOperator READ ircOperator WRITE setIrcOperator)
-    // lastAwayMessage is only set by legacy (pre-0.13) cores, which automatically gets converted to
-    // the appropriate lastAwayMessageTime.  Do not use this in new code.
-    Q_PROPERTY(int lastAwayMessage WRITE setLastAwayMessage)
     Q_PROPERTY(QDateTime lastAwayMessageTime READ lastAwayMessageTime WRITE setLastAwayMessageTime)
     Q_PROPERTY(QString whoisServiceReply READ whoisServiceReply WRITE setWhoisServiceReply)
     Q_PROPERTY(QString suserHost READ suserHost WRITE setSuserHost)
@@ -63,7 +61,7 @@ class IrcUser : public SyncableObject
 
 public :
         IrcUser(const QString &hostmask, Network *network);
-    virtual ~IrcUser();
+    ~IrcUser() override;
 
     inline QString user() const { return _user; }
     inline QString host() const { return _host; }
@@ -109,6 +107,31 @@ public :
     inline QDateTime lastSpokenTo(BufferId id) const { return _lastSpokenTo.value(id); }
     void setLastSpokenTo(BufferId id, const QDateTime &time);
 
+    /**
+     * Gets whether or not the away state has changed since it was last acknowledged
+     *
+     * Away state is marked as changed by any modification to away status (away/here, message)
+     *
+     * NOTE: On servers lacking support for IRCv3 away-notify, this won't update until an autoWHO-
+     * run for away/here changes, or until sending a message to the user for away message changes.
+     *
+     * @see IrcUser::acknowledgeAwayChanged()
+     *
+     * @return True if current away state is unchanged from last acknowledgement, otherwise false
+     */
+    inline bool hasAwayChanged() const { return _awayChanged; }
+
+    /**
+     * Sets the last away state change as acknowledged
+     *
+     * @see IrcUser::hasAwayChanged()
+     */
+    inline void acknowledgeAwayChanged()
+    {
+        // Don't sync this as individual clients may suppress different kinds of behaviors
+        _awayChanged = false;
+    }
+
 public slots:
     void setUser(const QString &user);
     void setHost(const QString &host);
@@ -120,7 +143,7 @@ public slots:
      * @param[in] account Account name if logged in, * if logged out, or empty string if unknown
      */
     void setAccount(const QString &account);
-    void setAway(const bool &away);
+    void setAway(bool away);
     void setAwayMessage(const QString &awayMessage);
     void setIdleTime(const QDateTime &idleTime);
     void setLoginTime(const QDateTime &loginTime);
@@ -128,7 +151,7 @@ public slots:
     void setIrcOperator(const QString &ircOperator);
     // setLastAwayMessage is only called by legacy (pre-0.13) cores, which automatically gets
     // converted to setting the appropriate lastAwayMessageTime.  Do not use this in new code.
-    void setLastAwayMessage(const int &lastAwayMessage);
+    void setLastAwayMessage(int lastAwayMessage);
     void setLastAwayMessageTime(const QDateTime &lastAwayMessageTime);
     void setWhoisServiceReply(const QString &whoisServiceReply);
     void setSuserHost(const QString &suserHost);
@@ -194,6 +217,15 @@ private:
         return (_nick.toLower() == nickname.toLower());
     }
 
+    /**
+     * Sets the last away state change as unacknowledged
+     *
+     * @see IrcUser::hasAwayChanged()
+     */
+    inline void markAwayChanged()
+    {
+        _awayChanged = true;
+    }
 
     bool _initialized;
 
@@ -225,7 +257,8 @@ private:
 
     QHash<BufferId, QDateTime> _lastActivity;
     QHash<BufferId, QDateTime> _lastSpokenTo;
-};
-
 
-#endif
+    // Given it's never been acknowledged, assume changes exist on IrcUser creation
+    /// Tracks if changes in away state (away/here, message) have yet to be acknowledged
+    bool _awayChanged = true;
+};