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 {
  37     SYNCABLE_OBJECT
  38     Q_OBJECT
  39
  40     Q_PROPERTY(QString name READ name STORED false)
  41     Q_PROPERTY(QString topic READ topic WRITE setTopic STORED false)
  42     Q_PROPERTY(QString password READ password WRITE setPassword STORED false)
  43
  44 public :
  45         IrcChannel(const QString &channelname, Network *network);
  46     ~IrcChannel();
  47
  48     bool isKnownUser(IrcUser *ircuser) const;
  49     bool isValidChannelUserMode(const QString &mode) const;
  50
  51     inline QString name() const { return _name; }
  52     inline QString topic() const { return _topic; }
  53     inline QString password() const { return _password; }
  54     inline Network *network() const { return _network; }
  55
  56     inline QList<IrcUser *> ircUsers() const { return _userModes.keys(); }
  57
  58     QString userModes(IrcUser *ircuser) const;
  59     QString userModes(const QString &nick) const;
  60
  61     bool hasMode(const QChar &mode) const;
  62     QString modeValue(const QChar &mode) const;
  63     QStringList modeValueList(const QChar &mode) const;
  64     QString channelModeString() const;
  65
  66     inline QTextCodec *codecForEncoding() const { return _codecForEncoding; }
  67     inline QTextCodec *codecForDecoding() const { return _codecForDecoding; }
  68     void setCodecForEncoding(const QString &codecName);
  69     void setCodecForEncoding(QTextCodec *codec);
  70     void setCodecForDecoding(const QString &codecName);
  71     void setCodecForDecoding(QTextCodec *codec);
  72
  73     QString decodeString(const QByteArray &text) const;
  74     QByteArray encodeString(const QString &string) const;
  75
  76 public slots:
  77     void setTopic(const QString &topic);
  78     void setPassword(const QString &password);
  79
  80     void joinIrcUsers(const QList<IrcUser *> &users, const QStringList &modes);
  81     void joinIrcUsers(const QStringList &nicks, const QStringList &modes);
  82     void joinIrcUser(IrcUser *ircuser);
  83
  84     void part(IrcUser *ircuser);
  85     void part(const QString &nick);
  86
  87     void setUserModes(IrcUser *ircuser, const QString &modes);
  88     void setUserModes(const QString &nick, const QString &modes);
  89
  90     void addUserMode(IrcUser *ircuser, const QString &mode);
  91     void addUserMode(const QString &nick, const QString &mode);
  92
  93     void removeUserMode(IrcUser *ircuser, const QString &mode);
  94     void removeUserMode(const QString &nick, const QString &mode);
  95
  96     void addChannelMode(const QChar &mode, const QString &value);
  97     void removeChannelMode(const QChar &mode, const QString &value);
  98
  99     // init geters
 100     QVariantMap initUserModes() const;
 101     QVariantMap initChanModes() const;
 102
 103     // init seters
 104     void initSetUserModes(const QVariantMap &usermodes);
 105     void initSetChanModes(const QVariantMap &chanModes);
 106
 107 signals:
 108     void topicSet(const QString &topic); // needed by NetworkModel
 109 //   void passwordSet(const QString &password);
 110 //   void userModesSet(QString nick, QString modes);
 111 //   void userModeAdded(QString nick, QString mode);
 112 //   void userModeRemoved(QString nick, QString mode);
 113 //   void channelModeAdded(const QChar &mode, const QString &value);
 114 //   void channelModeRemoved(const QChar &mode, const QString &value);
 115
 116     void ircUsersJoined(QList<IrcUser *> ircusers);
 117 //   void ircUsersJoined(QStringList nicks, QStringList modes);
 118     void ircUserParted(IrcUser *ircuser);
 119     void ircUserNickSet(IrcUser *ircuser, QString nick);
 120     void ircUserModeAdded(IrcUser *ircuser, QString mode);
 121     void ircUserModeRemoved(IrcUser *ircuser, QString mode);
 122     void ircUserModesSet(IrcUser *ircuser, QString modes);
 123
 124     void parted(); // convenience signal emitted before channels destruction
 125
 126 private slots:
 127     void ircUserDestroyed();
 128     void ircUserNickSet(QString nick);
 129
 130 private:
 131     bool _initialized;
 132     QString _name;
 133     QString _topic;
 134     QString _password;
 135
 136     QHash<IrcUser *, QString> _userModes;
 137
 138     Network *_network;
 139
 140     QTextCodec *_codecForEncoding;
 141     QTextCodec *_codecForDecoding;
 142
 143     QHash<QChar, QStringList> _A_channelModes;
 144     QHash<QChar, QString> _B_channelModes;
 145     QHash<QChar, QString> _C_channelModes;
 146     QSet<QChar> _D_channelModes;
 147 };
 148
 149
 150 #endif