1 /***************************************************************************
2 * Copyright (C) 2005/06 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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
27 #include <QStringList>
28 #include <QVariantMap>
30 #include "syncableobject.h"
35 class IrcChannel : public SyncableObject {
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)
43 IrcChannel(const QString &channelname, Network *network);
46 bool isKnownUser(IrcUser *ircuser) const;
47 bool isValidChannelUserMode(const QString &mode) const;
49 inline QString name() const { return _name; }
50 inline QString topic() const { return _topic; }
51 inline QString password() const { return _password; }
53 inline QList<IrcUser *> ircUsers() const { return _userModes.keys(); }
55 QString userModes(IrcUser *ircuser) const;
56 QString userModes(const QString &nick) const;
58 bool hasMode(const QChar &mode) const;
59 QString modeValue(const QChar &mode) const;
60 QStringList modeValueList(const QChar &mode) const;
61 QString channelModeString() const;
63 inline QTextCodec *codecForEncoding() const { return _codecForEncoding; }
64 inline QTextCodec *codecForDecoding() const { return _codecForDecoding; }
65 void setCodecForEncoding(const QString &codecName);
66 void setCodecForEncoding(QTextCodec *codec);
67 void setCodecForDecoding(const QString &codecName);
68 void setCodecForDecoding(QTextCodec *codec);
70 QString decodeString(const QByteArray &text) const;
71 QByteArray encodeString(const QString &string) const;
74 void setTopic(const QString &topic);
75 void setPassword(const QString &password);
77 void joinIrcUsers(const QList<IrcUser *> &users, const QStringList &modes);
78 void joinIrcUsers(const QStringList &nicks, const QStringList &modes);
79 void joinIrcUsers(IrcUser *ircuser);
80 void joinIrcUsers(const QString &nick);
82 void part(IrcUser *ircuser);
83 void part(const QString &nick);
85 void setUserModes(IrcUser *ircuser, const QString &modes);
86 void setUserModes(const QString &nick, const QString &modes);
88 void addUserMode(IrcUser *ircuser, const QString &mode);
89 void addUserMode(const QString &nick, const QString &mode);
91 void removeUserMode(IrcUser *ircuser, const QString &mode);
92 void removeUserMode(const QString &nick, const QString &mode);
94 void addChannelMode(const QChar &mode, const QString &value);
95 void removeChannelMode(const QChar &mode, const QString &value);
98 QVariantMap initUserModes() const;
99 QVariantMap initChanModes() const;
102 void initSetUserModes(const QVariantMap &usermodes);
103 void initSetChanModes(const QVariantMap &chanModes);
106 void topicSet(const QString &topic);
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);
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);
122 void parted(); // convenience signal emitted before channels destruction
125 void ircUserDestroyed();
126 void ircUserNickSet(QString nick);
134 QHash<IrcUser *, QString> _userModes;
138 QTextCodec *_codecForEncoding;
139 QTextCodec *_codecForDecoding;
141 QHash<QChar, QStringList> _A_channelModes;
142 QHash<QChar, QString> _B_channelModes;
143 QHash<QChar, QString> _C_channelModes;
144 QSet<QChar> _D_channelModes;