ircresponsetype.h

//------------------------------------------------------------------------------
// ircresponsetype.h
//------------------------------------------------------------------------------
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301  USA
//
//------------------------------------------------------------------------------
// Copyright (C) 2011 "Zalewa" <zalewapl@gmail.com>
//------------------------------------------------------------------------------
#ifndef __IRCRESPONSETYPE_H__
#define __IRCRESPONSETYPE_H__

#include <QString>

class IRCResponseType
{
public:
        enum MsgType
        {
                // === IMPORTANT!!! ===
                // Remember to fix toRfcString() if values here change!
                // Also IRCResponseParser::parseMessage() must be
                // fixed.

                Invalid = 0,

                HelloClient,

                // === Here are types with no text representation ===

                RPLISupport,

                RPLLUserClient,

                RPLLUserOp,

                RPLLUserUnknown,

                RPLLUserChannels,

                RPLAway,

                RPLWhoIsRegnick,

                RPLLUserMe,

                RPLWhoIsUser,

                RPLWhoIsServer,

                RPLWhoIsOperator,

                RPLWhoIsIdle,

                RPLEndOfWhoIs,

                RPLWhoIsChannels,

                RPLWhoIsSpecial,

                RPLChannelUrl,

                RPLCreationTime,

                RPLWhoIsAccount,

                RPLTopic,

                RPLTopicWhoTime,

                RPLWhoIsBot,

                RPLWhoIsActually,

                RPLNamReply,

                RPLEndOfNames,

                RPLMOTD,

                RPLMOTDStart,

                RPLEndOfMOTD,

                RPLWhoIsHost,

                RPLWhoIsModes,

                // === Here are errors with no text representation ===

                ERRNoSuchNick,

                ERRCannotSendToChan,

                ERRErroneousNickname,
                ERRNicknameInUse,

                ERRChannelIsFull, // 471
                ERRInviteOnlyChan, // 473
                ERRBannedFromChan, // 474
                ERRBadChannelKey, // 475
                ERRBadChannelMask, // 476
                ERRNoChanModes, // 477

                ERRChanOpPrivIsNeeded,

                RPLWhoIsSecure,

                // === Here are types which convert to their string counterparts
                // === letter-by-letter

                Join,
                Kick,
                Kill,
                Mode,
                Nick,
                Notice,
                Part,
                Ping,
                PrivMsg,
                Quit,
                Topic,

                NUM_TYPES
        };

        static IRCResponseType fromIntegerResponseValue(int responseType);

        static int toRfcNumber(MsgType type);

        static QString toRfcString(MsgType type);

        static MsgType typeFromRfcString(const QString &typeRepresentation);

        IRCResponseType();

        IRCResponseType(MsgType type);

        IRCResponseType(const QString &typeRepresentation);

        bool isCommandResponse() const
        {
                return d.numericType >= 200 && d.numericType <= 399;
        }

        bool isErrorMessage() const
        {
                return d.numericType >= 400;
        }

        bool isValid() const
        {
                return d.type != Invalid;
        }

        bool operator==(const IRCResponseType &other) const;
        bool operator!=(const IRCResponseType &other) const;

        int numericType() const
        {
                return d.numericType;
        }

        QString toRfcString() const
        {
                return toRfcString(d.type);
        }

        MsgType type() const
        {
                return d.type;
        }

private:
        class PrivData
        {
        public:
                int numericType;
                MsgType type;
        };

        PrivData d;
};

#endif