src/common/ircchannel.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005/06 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  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifndef _IRCCHANNEL_H_
  22 #define _IRCCHANNEL_H_
  23
  24 #include <QHash>
  25 #include <QSet>
  26 #include <QString>
  27 #include <QStringList>
  28 #include <QVariantMap>
  29
  30 #include "syncableobject.h"
  31
  32 class IrcUser;
  33 class Network;
  34
  35 class IrcChannel : public SyncableObject {
  36   Q_OBJECT
  37
  38   Q_PROPERTY(QString name READ name STORED false)
  39   Q_PROPERTY(QString topic READ topic WRITE setTopic STORED false)
  40   Q_PROPERTY(QString password READ password WRITE setPassword STORED false)
  41
  42 public:
  43   IrcChannel(const QString &channelname, Network *network);
  44
  45   bool isKnownUser(IrcUser *ircuser) const;
  46   bool isValidChannelUserMode(const QString &mode) const;
  47
  48   inline QString name() const { return _name; }
  49   inline QString topic() const { return _topic; }
  50   inline QString password() const { return _password; }
  51
  52   inline QList<IrcUser *> ircUsers() const { return _userModes.keys(); }
  53
  54   QString userModes(IrcUser *ircuser) const;
  55   QString userModes(const QString &nick) const;
  56
  57   bool hasMode(const QChar &mode) const;
  58   QString modeValue(const QChar &mode) const;
  59   QStringList modeValueList(const QChar &mode) const;
  60   QString channelModeString() const;
  61
  62   inline QTextCodec *codecForEncoding() const { return _codecForEncoding; }
  63   inline QTextCodec *codecForDecoding() const { return _codecForDecoding; }
  64   void setCodecForEncoding(const QString &codecName);
  65   void setCodecForEncoding(QTextCodec *codec);
  66   void setCodecForDecoding(const QString &codecName);
  67   void setCodecForDecoding(QTextCodec *codec);
  68
  69   QString decodeString(const QByteArray &text) const;
  70   QByteArray encodeString(const QString &string) const;
  71
  72 public slots:
  73   void setTopic(const QString &topic);
  74   void setPassword(const QString &password);
  75
  76   void joinIrcUsers(const QList<IrcUser *> &users, const QStringList &modes);
  77   void joinIrcUsers(const QStringList &nicks, const QStringList &modes);
  78   void joinIrcUsers(IrcUser *ircuser);
  79   void joinIrcUsers(const QString &nick);
  80
  81   void part(IrcUser *ircuser);
  82   void part(const QString &nick);
  83
  84   void setUserModes(IrcUser *ircuser, const QString &modes);
  85   void setUserModes(const QString &nick, const QString &modes);
  86
  87   void addUserMode(IrcUser *ircuser, const QString &mode);
  88   void addUserMode(const QString &nick, const QString &mode);
  89
  90   void removeUserMode(IrcUser *ircuser, const QString &mode);
  91   void removeUserMode(const QString &nick, const QString &mode);
  92
  93   void addChannelMode(const QChar &mode, const QString &value);
  94   void removeChannelMode(const QChar &mode, const QString &value);
  95
  96   // init geters
  97   QVariantMap initUserModes() const;
  98   QVariantMap initChanModes() const;
  99
 100   // init seters
 101   void initSetUserModes(const QVariantMap &usermodes);
 102   void initSetChanModes(const QVariantMap &chanModes);
 103
 104 signals:
 105   void topicSet(const QString &topic);
 106   void passwordSet(const QString &password);
 107   void userModesSet(QString nick, QString modes);
 108   void userModeAdded(QString nick, QString mode);
 109   void userModeRemoved(QString nick, QString mode);
 110   void channelModeAdded(const QChar &mode, const QString &value);
 111   void channelModeRemoved(const QChar &mode, const QString &value);
 112
 113   void ircUsersJoined(QList<IrcUser *> ircusers);
 114   void ircUsersJoined(QStringList nicks, QStringList modes);
 115   void ircUserParted(IrcUser *ircuser);
 116   void ircUserNickSet(IrcUser *ircuser, QString nick);
 117   void ircUserModeAdded(IrcUser *ircuser, QString mode);
 118   void ircUserModeRemoved(IrcUser *ircuser, QString mode);
 119   void ircUserModesSet(IrcUser *ircuser, QString modes);
 120
 121 private slots:
 122    void ircUserDestroyed();
 123    void ircUserNickSet(QString nick);
 124
 125 private:
 126   bool _initialized;
 127   QString _name;
 128   QString _topic;
 129   QString _password;
 130
 131   QHash<IrcUser *, QString> _userModes;
 132
 133   Network *network;
 134
 135   QTextCodec *_codecForEncoding;
 136   QTextCodec *_codecForDecoding;
 137
 138   QHash<QChar, QStringList> _A_channelModes;
 139   QHash<QChar, QString> _B_channelModes;
 140   QHash<QChar, QString> _C_channelModes;
 141   QSet<QChar> _D_channelModes;
 142
 143 };
 144
 145 #endif