KviIrcMask.h

Go to the documentation of this file.

#ifndef _KVI_IRCMASK_H_
#define _KVI_IRCMASK_H_

//=============================================================================
//
//   File : KviIrcMask.h
//   Creation date : Fri Jan 8 1999 19:50:35 by Szymon Stefanek
//
//   This file is part of the KVIrc IRC client distribution
//   Copyright (C) 1999-2010 Szymon Stefanek (pragma at kvirc dot net)
//
//   This program is FREE software. You can redistribute it and/or
//   modify it under the terms of the GNU General Public License
//   as published by the Free Software Foundation; either version 2
//   of the License, or (at your option) any later version.
//
//   This program 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 General Public License for more details.
//
//   You should have received a copy of the GNU General Public License
//   along with this program. If not, write to the Free Software Foundation,
//   Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
//=============================================================================
// originally this file was named kvi_ircuser.h and the class was KviIrcUser
// ported to UNICODE on 2004.10.28 1:50 am
//=============================================================================

#include "kvi_settings.h"
#include "KviHeapObject.h"
#include "KviQString.h"

class KVILIB_API KviIrcMask : public KviHeapObject
{
        friend class KviIrcUserList;
        friend class KviIrcUserChanList;

private:
        QString m_szNick;
        QString m_szUser;
        QString m_szHost;
        static QString m_szWild;

public:
        KviIrcMask();

        KviIrcMask(const QString & szMask);

        KviIrcMask(const KviIrcMask & ircUser)
            : m_szNick(ircUser.m_szNick), m_szUser(ircUser.m_szUser), m_szHost(ircUser.m_szHost){};

        KviIrcMask(const QString & nick, const QString & user, const QString & host)
            : m_szNick(nick), m_szUser(user), m_szHost(host){};

        enum MaskType
        {
                NickUserHost = 0,           
                NickUserNet = 1,            
                NickUser = 2,               
                NickHost = 3,               
                NickNet = 4,                
                Nick = 5,                   
                UserHost = 6,               
                UserNet = 7,                
                User = 8,                   
                Host = 9,                   
                Net = 10,                   
                NickCleanUserHost = 11,     
                NickCleanUserNet = 12,      
                NickCleanUser = 13,         
                CleanUserHost = 14,         
                CleanUserNet = 15,          
                CleanUser = 16,             
                NickUserLargeNet = 17,      
                NickLargeNet = 18,          
                UserLargeNet = 19,          
                NickCleanUserLargeNet = 20, 
                CleanUserLargeNet = 21,     
                NickUserSmartNet = 22,      
                NickSmartNet = 23,          
                UserSmartNet = 24,          
                NickCleanUserSmartNet = 25, 
                CleanUserSmartNet = 26      
        };

public:
        void setNick(const QString & szNick) { m_szNick = szNick.isEmpty() ? m_szWild : szNick; };

        void setUsername(const QString & szUser) { m_szUser = szUser.isEmpty() ? m_szWild : szUser; };

        void setUser(const QString & szUser) { m_szUser = szUser.isEmpty() ? m_szWild : szUser; };

        void setHost(const QString & szHost) { m_szHost = szHost.isEmpty() ? m_szWild : szHost; };

        const QString & nick() const { return m_szNick; };

        const QString & user() const { return m_szUser; };

        const QString & host() const { return m_szHost; };

        bool hasUser() const { return !(m_szUser.isEmpty() || (m_szUser == m_szWild)); };

        bool hasHost() const { return !(m_szHost.isEmpty() || (m_szHost == m_szWild)); };

        bool hasNumericHost() const;

        void mask(QString & szMask, MaskType eMaskType = NickCleanUserHost) const;

        bool hasWildNick();

        bool matches(const KviIrcMask & mask) const;

        bool matchesFixed(const QString & szNick, const QString & szUser, const QString & szHost) const;

        bool matchesFixed(const KviIrcMask & mask) const;

        bool matchedBy(const KviIrcMask & mask) const { return mask.matchesFixed(*this); };

        bool matchWildString(const QString & szExp, const QString & szStr) const;

        int nonWildChars();

        bool operator==(const KviIrcMask & user);

private:
        int getIpDomainMaskLen() const;

        int getLargeIpDomainMaskLen() const;

        QString getHostDomainMask() const;

        QString getLargeHostDomainMask() const;

        bool hasMaskedIp() const;
};

#endif //_KVI_IRCMASK_H_