Nick.h

Go to the documentation of this file.

/*
 * Copyright (C) 2004-2014 ZNC, see the NOTICE file for details.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _NICK_H
#define _NICK_H

#include <znc/zncconfig.h>
#include <znc/ZNCString.h>
#include <vector>

// Forward Decl
class CIRCNetwork;
class CChan;
// !Forward Decl

class CNick
{
public:
        CNick();
        CNick(const CString& sNick);
        ~CNick();

        void Reset();
        void Parse(const CString& sNickMask);
        CString GetHostMask() const;
        size_t GetCommonChans(std::vector<CChan*>& vChans, CIRCNetwork* pNetwork) const;
        bool NickEquals(const CString& nickname) const;

        // Setters
        void SetNetwork(CIRCNetwork* pNetwork);
        void SetNick(const CString& s);
        void SetIdent(const CString& s);
        void SetHost(const CString& s);
        bool AddPerm(unsigned char uPerm);
        bool RemPerm(unsigned char uPerm);
        // !Setters

        // Getters
        CString GetPermStr() const;
        unsigned char GetPermChar() const;
        bool HasPerm(unsigned char uPerm) const;
        const CString& GetNick() const;
        const CString& GetIdent() const;
        const CString& GetHost() const;
        CString GetNickMask() const;
        // !Getters

        void Clone(const CNick& SourceNick);
private:
protected:
        CString      m_sChanPerms;
        CIRCNetwork* m_pNetwork;
        CString      m_sNick;
        CString      m_sIdent;
        CString      m_sHost;
};

#endif // !_NICK_H