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