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