Rework sync protocol for highlight rules

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

diff --git a/src/common/highlightrulemanager.h b/src/common/highlightrulemanager.h
index 427b658..0e50954 100644 (file)
--- a/src/common/highlightrulemanager.h
+++ b/src/common/highlightrulemanager.h
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-2016 by the Quassel Project                        *
+ *   Copyright (C) 2005-2018 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -18,20 +18,26 @@
  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
-#ifndef HIGHLIGHTRULELISTMANAGER_H
-#define HIGHLIGHTRULELISTMANAGER_H
+#pragma once
 
-#include <QString>
-#include <QRegExp>
 #include <utility>
 
+#include <QRegExp>
+#include <QString>
+#include <QStringList>
+#include <QVariantList>
+#include <QVariantMap>
+
 #include "message.h"
 #include "syncableobject.h"
 
 class HighlightRuleManager : public SyncableObject
 {
     SYNCABLE_OBJECT
-        Q_OBJECT
+    Q_OBJECT
+
+    Q_PROPERTY(int highlightNick READ highlightNick WRITE setHighlightNick)
+    Q_PROPERTY(bool nicksCaseSensitive READ nicksCaseSensitive WRITE setNicksCaseSensitive)
 public:
     enum HighlightNickType {
         NoNick = 0x00,
@@ -43,6 +49,7 @@ public:
     HighlightRuleManager &operator=(const HighlightRuleManager &other);
 
     struct HighlightRule {
+        int id;
         QString name;
         bool isRegEx = false;
         bool isCaseSensitive = false;
@@ -51,14 +58,15 @@ public:
         QString sender;
         QString chanName;
         HighlightRule() {}
-        HighlightRule(QString name_, bool isRegEx_, bool isCaseSensitive_, bool isEnabled_, bool isInverse_,
+        HighlightRule(int id_, QString name_, bool isRegEx_, bool isCaseSensitive_, bool isEnabled_, bool isInverse_,
                       QString sender_, QString chanName_)
-            : name(std::move(name_)), isRegEx(isRegEx_), isCaseSensitive(isCaseSensitive_), isEnabled(isEnabled_),
-              isInverse(isInverse_), sender(std::move(sender_)), chanName(std::move(chanName_)) {
+            : id(id_), name(std::move(name_)), isRegEx(isRegEx_), isCaseSensitive(isCaseSensitive_),
+              isEnabled(isEnabled_), isInverse(isInverse_), sender(std::move(sender_)), chanName(std::move(chanName_)) {
         }
-        bool operator!=(const HighlightRule &other)
-        {
-            return (name != other.name ||
+
+        bool operator!=(const HighlightRule &other) {
+            return (id != other.id ||
+                    name != other.name ||
                     isRegEx != other.isRegEx ||
                     isCaseSensitive != other.isCaseSensitive ||
                     isEnabled != other.isEnabled ||
@@ -69,8 +77,8 @@ public:
     };
     typedef QList<HighlightRule> HighlightRuleList;
 
-    int indexOf(const QString &rule) const;
-    inline bool contains(const QString &rule) const { return indexOf(rule) != -1; }
+    int indexOf(int rule) const;
+    inline bool contains(int rule) const { return indexOf(rule) != -1; }
     inline bool isEmpty() const { return _highlightRuleList.isEmpty(); }
     inline int count() const { return _highlightRuleList.count(); }
     inline void removeAt(int index) { _highlightRuleList.removeAt(index); }
@@ -79,8 +87,10 @@ public:
     inline const HighlightRule &operator[](int i) const { return _highlightRuleList.at(i); }
     inline const HighlightRuleList &highlightRuleList() const { return _highlightRuleList; }
 
-    inline HighlightNickType highlightNick() { return _highlightNick; }
-    inline bool  nicksCaseSensitive() { return _nicksCaseSensitive; }
+    int nextId();
+
+    inline int highlightNick() { return _highlightNick; }
+    inline bool nicksCaseSensitive() { return _nicksCaseSensitive; }
 
     //! Check if a message matches the HighlightRule
     /** This method checks if a message matches the users highlight rules.
@@ -97,16 +107,16 @@ public slots:
       * and get that synced with the core immediately.
       * \param highlightRule A valid ignore rule
       */
-    virtual inline void requestRemoveHighlightRule(const QString &highlightRule) { REQUEST(ARG(highlightRule)) }
-    virtual void removeHighlightRule(const QString &highlightRule);
+    virtual inline void requestRemoveHighlightRule(int highlightRule) { REQUEST(ARG(highlightRule)) }
+    virtual void removeHighlightRule(int highlightRule);
 
     //! Request toggling of "isEnabled" flag of a given ignore rule.
     /** Use this method if you want to toggle the "isEnabled" flag of a single ignore rule
       * and get that synced with the core immediately.
       * \param highlightRule A valid ignore rule
       */
-    virtual inline void requestToggleHighlightRule(const QString &highlightRule) { REQUEST(ARG(highlightRule)) }
-    virtual void toggleHighlightRule(const QString &highlightRule);
+    virtual inline void requestToggleHighlightRule(int highlightRule) { REQUEST(ARG(highlightRule)) }
+    virtual void toggleHighlightRule(int highlightRule);
 
     //! Request an HighlightRule to be added to the ignore list
     /** Items added to the list with this method, get immediately synced with the core
@@ -116,21 +126,22 @@ public slots:
       * \param isEnabled If the rule is active
       * @param chanName The channel in which the rule should apply
       */
-    virtual inline void requestAddHighlightRule(const QString &name, bool isRegEx, bool isCaseSensitive, bool isEnabled,
+    virtual inline void requestAddHighlightRule(int id, const QString &name, bool isRegEx, bool isCaseSensitive, bool isEnabled,
                                                 bool isInverse, const QString &sender, const QString &chanName)
     {
-        REQUEST(ARG(name), ARG(isRegEx), ARG(isCaseSensitive), ARG(isEnabled), ARG(isInverse), ARG(sender), ARG(chanName))
+        REQUEST(ARG(id), ARG(name), ARG(isRegEx), ARG(isCaseSensitive), ARG(isEnabled), ARG(isInverse), ARG(sender),
+                ARG(chanName))
     }
 
 
-    virtual void addHighlightRule(const QString &name, bool isRegEx, bool isCaseSensitive, bool isEnabled,
+    virtual void addHighlightRule(int id, const QString &name, bool isRegEx, bool isCaseSensitive, bool isEnabled,
                                   bool isInverse, const QString &sender, const QString &chanName);
 
-    virtual inline void requestSetHighlightNick(HighlightNickType highlightNick)
+    virtual inline void requestSetHighlightNick(int highlightNick)
     {
         REQUEST(ARG(highlightNick))
     }
-    inline void setHighlightNick(HighlightNickType highlightNick) { _highlightNick = highlightNick; }
+    inline void setHighlightNick(int highlightNick) { _highlightNick = static_cast<HighlightNickType>(highlightNick); }
 
     virtual inline void requestSetNicksCaseSensitive(bool nicksCaseSensitive)
     {
@@ -141,7 +152,13 @@ public slots:
 protected:
     void setHighlightRuleList(const QList<HighlightRule> &HighlightRuleList) { _highlightRuleList = HighlightRuleList; }
 
-    bool _match(const QString &msgContents, const QString &msgSender, Message::Type msgType, Message::Flags msgFlags, const QString &bufferName, const QString &currentNick, const QStringList identityNicks);
+    bool match(const QString &msgContents,
+               const QString &msgSender,
+               Message::Type msgType,
+               Message::Flags msgFlags,
+               const QString &bufferName,
+               const QString &currentNick,
+               const QStringList identityNicks);
 
 signals:
     void ruleAdded(QString name, bool isRegEx, bool isCaseSensitive, bool isEnabled, bool isInverse, QString sender, QString chanName);
@@ -151,6 +168,3 @@ private:
     HighlightNickType _highlightNick = HighlightNickType::CurrentNick;
     bool _nicksCaseSensitive = false;
 };
-
-
-#endif // HIGHLIGHTRULELISTMANAGER_H