modernize: Reformat ALL the source... again!
[quassel.git] / src / common / ircchannel.h
index 2bf5f64..4a71e0f 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005/06 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  *
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
-#ifndef _IRCCHANNEL_H_
-#define _IRCCHANNEL_H_
+#pragma once
+
+#include "common-export.h"
 
 #include <QHash>
+#include <QSet>
 #include <QString>
 #include <QStringList>
 #include <QVariantMap>
 
 class IrcUser;
 class Network;
-class SignalProxy;
 
-class IrcChannel : public SyncableObject {
-  Q_OBJECT
+class COMMON_EXPORT IrcChannel : public SyncableObject
+{
+    Q_OBJECT
+    SYNCABLE_OBJECT
 
-  Q_PROPERTY(QString name READ name STORED false)
-  Q_PROPERTY(QString topic READ topic WRITE setTopic STORED false)
+    Q_PROPERTY(QString name READ name)
+    Q_PROPERTY(QString topic READ topic WRITE setTopic)
+    Q_PROPERTY(QString password READ password WRITE setPassword)
+    Q_PROPERTY(bool encrypted READ encrypted WRITE setEncrypted)
 
 public:
-  IrcChannel(const QString &channelname, Network *network);
-  ~IrcChannel();
+    IrcChannel(const QString& channelname, Network* network);
+
+    bool isKnownUser(IrcUser* ircuser) const;
+    bool isValidChannelUserMode(const QString& mode) const;
 
-  bool isKnownUser(IrcUser *ircuser) const;
-  bool isValidChannelUserMode(const QString &mode) const;
+    inline QString name() const { return _name; }
+    inline QString topic() const { return _topic; }
+    inline QString password() const { return _password; }
+    inline bool encrypted() const { return _encrypted; }
+    inline Network* network() const { return _network; }
 
-  QString name() const;
-  QString topic() const;
+    inline QList<IrcUser*> ircUsers() const { return _userModes.keys(); }
 
-  QList<IrcUser *> ircUsers() const;
+    QString userModes(IrcUser* ircuser) const;
+    QString userModes(const QString& nick) const;
 
-  QString userModes(IrcUser *ircuser) const;
-  QString userModes(const QString &nick) const;
+    bool hasMode(const QChar& mode) const;
+    QString modeValue(const QChar& mode) const;
+    QStringList modeValueList(const QChar& mode) const;
+    QString channelModeString() const;
 
-  QTextCodec *codecForEncoding() const;
-  QTextCodec *codecForDecoding() const;
-  void setCodecForEncoding(const QString &codecName);
-  void setCodecForEncoding(QTextCodec *codec);
-  void setCodecForDecoding(const QString &codecName);
-  void setCodecForDecoding(QTextCodec *codec);
+    inline QTextCodec* codecForEncoding() const { return _codecForEncoding; }
+    inline QTextCodec* codecForDecoding() const { return _codecForDecoding; }
+    void setCodecForEncoding(const QString& codecName);
+    void setCodecForEncoding(QTextCodec* codec);
+    void setCodecForDecoding(const QString& codecName);
+    void setCodecForDecoding(QTextCodec* codec);
 
-  QString decodeString(const QByteArray &text) const;
-  QByteArray encodeString(const QString &string) const;
+    QString decodeString(const QByteArray& text) const;
+    QByteArray encodeString(const QString& string) const;
 
 public slots:
-  void setTopic(const QString &topic);
+    void setTopic(const QString& topic);
+    void setPassword(const QString& password);
+    void setEncrypted(bool encrypted);
+
+    void joinIrcUsers(const QList<IrcUser*>& users, const QStringList& modes);
+    void joinIrcUsers(const QStringList& nicks, const QStringList& modes);
+    void joinIrcUser(IrcUser* ircuser);
 
-  void join(IrcUser *ircuser);
-  void join(const QString &nick);
+    void part(IrcUser* ircuser);
+    void part(const QString& nick);
 
-  void part(IrcUser *ircuser);
-  void part(const QString &nick);
+    void setUserModes(IrcUser* ircuser, const QString& modes);
+    void setUserModes(const QString& nick, const QString& modes);
 
-  void setUserModes(IrcUser *ircuser, const QString &modes);
-  void setUserModes(const QString &nick, const QString &modes);
+    void addUserMode(IrcUser* ircuser, const QString& mode);
+    void addUserMode(const QString& nick, const QString& mode);
 
-  void addUserMode(IrcUser *ircuser, const QString &mode);
-  void addUserMode(const QString &nick, const QString &mode);
+    void removeUserMode(IrcUser* ircuser, const QString& mode);
+    void removeUserMode(const QString& nick, const QString& mode);
 
-  void removeUserMode(IrcUser *ircuser, const QString &mode);
-  void removeUserMode(const QString &nick, const QString &mode);
+    void addChannelMode(const QChar& mode, const QString& value);
+    void removeChannelMode(const QChar& mode, const QString& value);
 
-  // init geters
-  QVariantMap initUserModes() const;
+    // init geters
+    QVariantMap initUserModes() const;
+    QVariantMap initChanModes() const;
 
-  // init seters
-  void initSetUserModes(const QVariantMap &usermodes);
+    // init seters
+    void initSetUserModes(const QVariantMap& usermodes);
+    void initSetChanModes(const QVariantMap& chanModes);
 
 signals:
-  void topicSet(QString topic);
-  void userModesSet(QString nick, QString modes);
-  //void userModesSet(IrcUser *ircuser, QString modes);
-  void userModeAdded(QString nick, QString mode);
-  //void userModeAdded(IrcUser *ircuser, QString mode);
-  void userModeRemoved(QString nick, QString mode);
-  //void userModeRemoved(IrcUser *ircuser, QString mode);
-
-  void ircUserJoined(IrcUser *ircuser);
-  void ircUserParted(IrcUser *ircuser);
-  void ircUserNickSet(IrcUser *ircuser, QString nick);
-  void ircUserModeAdded(IrcUser *ircuser, QString mode);
-  void ircUserModeRemoved(IrcUser *ircuser, QString mode);
-  void ircUserModesSet(IrcUser *ircuser, QString modes);
+    void topicSet(const QString& topic);  // needed by NetworkModel
+    void encryptedSet(bool encrypted);
+    //   void passwordSet(const QString &password);
+    //   void userModesSet(QString nick, QString modes);
+    //   void userModeAdded(QString nick, QString mode);
+    //   void userModeRemoved(QString nick, QString mode);
+    //   void channelModeAdded(const QChar &mode, const QString &value);
+    //   void channelModeRemoved(const QChar &mode, const QString &value);
+
+    void ircUsersJoined(const QList<IrcUser*>& ircusers);
+    //   void ircUsersJoined(QStringList nicks, QStringList modes);
+    void ircUserParted(IrcUser* ircuser);
+    void ircUserNickSet(IrcUser* ircuser, QString nick);
+    void ircUserModeAdded(IrcUser* ircuser, QString mode);
+    void ircUserModeRemoved(IrcUser* ircuser, QString mode);
+    void ircUserModesSet(IrcUser* ircuser, QString modes);
+
+    void parted();  // convenience signal emitted before channels destruction
 
 private slots:
-   void ircUserDestroyed();
-   void ircUserNickSet(QString nick);
+    void ircUserDestroyed();
+    void ircUserNickSet(QString nick);
 
 private:
-  bool _initialized;
-  QString _name;
-  QString _topic;
+    bool _initialized;
+    QString _name;
+    QString _topic;
+    QString _password;
+    bool _encrypted;
 
-  QHash<IrcUser *, QString> _userModes;
+    QHash<IrcUser*, QString> _userModes;
 
-  Network *network;
+    Network* _network;
 
-  QTextCodec *_codecForEncoding;
-  QTextCodec *_codecForDecoding;
-};
+    QTextCodec* _codecForEncoding;
+    QTextCodec* _codecForDecoding;
 
-#endif
+    QHash<QChar, QStringList> _A_channelModes;
+    QHash<QChar, QString> _B_channelModes;
+    QHash<QChar, QString> _C_channelModes;
+    QSet<QChar> _D_channelModes;
+};