1 /***************************************************************************
2 * Copyright (C) 2005-2012 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
27 #include <QStringList>
28 #include <QVariantMap>
30 #include "syncableobject.h"
35 class IrcChannel : public SyncableObject
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)
45 IrcChannel(const QString &channelname, Network *network);
48 bool isKnownUser(IrcUser *ircuser) const;
49 bool isValidChannelUserMode(const QString &mode) const;
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; }
56 inline QList<IrcUser *> ircUsers() const { return _userModes.keys(); }
58 QString userModes(IrcUser *ircuser) const;
59 QString userModes(const QString &nick) const;
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;
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);
73 QString decodeString(const QByteArray &text) const;
74 QByteArray encodeString(const QString &string) const;
77 void setTopic(const QString &topic);
78 void setPassword(const QString &password);
80 void joinIrcUsers(const QList<IrcUser *> &users, const QStringList &modes);
81 void joinIrcUsers(const QStringList &nicks, const QStringList &modes);
82 void joinIrcUser(IrcUser *ircuser);
84 void part(IrcUser *ircuser);
85 void part(const QString &nick);
87 void setUserModes(IrcUser *ircuser, const QString &modes);
88 void setUserModes(const QString &nick, const QString &modes);
90 void addUserMode(IrcUser *ircuser, const QString &mode);
91 void addUserMode(const QString &nick, const QString &mode);
93 void removeUserMode(IrcUser *ircuser, const QString &mode);
94 void removeUserMode(const QString &nick, const QString &mode);
96 void addChannelMode(const QChar &mode, const QString &value);
97 void removeChannelMode(const QChar &mode, const QString &value);
100 QVariantMap initUserModes() const;
101 QVariantMap initChanModes() const;
104 void initSetUserModes(const QVariantMap &usermodes);
105 void initSetChanModes(const QVariantMap &chanModes);
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);
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);
124 void parted(); // convenience signal emitted before channels destruction
127 void ircUserDestroyed();
128 void ircUserNickSet(QString nick);
136 QHash<IrcUser *, QString> _userModes;
140 QTextCodec *_codecForEncoding;
141 QTextCodec *_codecForDecoding;
143 QHash<QChar, QStringList> _A_channelModes;
144 QHash<QChar, QString> _B_channelModes;
145 QHash<QChar, QString> _C_channelModes;
146 QSet<QChar> _D_channelModes;