ircproxy  The Ultimate Cyborg

---

Prefix.h

Go to the documentation of this file.

// ircproxy -- An IRC bouncer.
//
//! @file Prefix.h
//! @brief This file contains the declaration of class Prefix.
//
// Copyright (C) 2007 by
//
// Carlo Wood, Run on IRC <carlo@alinoe.com>
// RSA-1024 0x624ACAD5 1997-01-26                    Sign & Encrypt
// Fingerprint16 = 32 EC A7 B6 AC DB 65 A6  F6 F6 55 DD 1C DC FF 61
//
// This file may be distributed under the terms of the Q Public License
// version 1.0 as appearing in the file LICENSE.QPL included in the
// packaging of this file.

#ifndef PREFIX_H
#define PREFIX_H

#ifndef USE_PCH
#include "debug.h"
#endif

#include "Nick.h"

class ClientMessageIn;
class ServerMessageIn;

//! @brief A class representing a message prefix.
class Prefix {
  private:
    boost::shared_ptr<Nick> M_nick;     //! The underlying Nick, if it's a user.
    std::string M_server_name;          //! The prefix, if it's a server (or any fixed string).
  public:
    //! Default constructor.
    Prefix(void) { Dout(dc::objects, "Constructing empty Prefix."); }
    //! Constructor
    Prefix(ClientMessageIn const& msg);
    //! Constructor
    Prefix(ServerMessageIn const& msg);
    //! Constructor
    Prefix(ServerSession& server_session, std::string const& prefix) { init(server_session, prefix); }
    //! Constructor
    Prefix(ClientSession& client_session, std::string const& prefix) { init(client_session, prefix); }
    //! Constructor
    explicit Prefix(boost::shared_ptr<Nick> const& nick) : M_nick(nick) { ASSERT(nick.get()); Dout(dc::objects, "Constructing Prefix from " << nick); }
    //! Constructor
    Prefix(std::string const& fixed_prefix_str) : M_server_name(fixed_prefix_str) { Dout(dc::objects, "Constructing Prefix from fixed string \"" << fixed_prefix_str << "\"."); }
    //! Constructor
    Prefix(Prefix const& prefix) : M_nick(prefix.M_nick), M_server_name(prefix.M_server_name) { Dout(dc::objects, "Copy-constructing Prefix from " << prefix); }
    //! Destructor
    ~Prefix() { Dout(dc::objects, "Destructing Prefix " << *this); }
    std::string out_prefix(ClientSession const& client_session, bool allow_uninitialized = false) const;
    std::string out_prefix(ServerSession const& server_session, bool allow_uninitialized = false) const;

#ifdef CWDEBUG
    // Accessors for debugging purposes.
    Nick* nick(void) const { return M_nick.get(); }
    std::string const& server_name(void) const { return M_server_name; }
#endif

    //! Return true if there is no prefix.
    bool empty(void) const { return M_nick.get() == NULL && M_server_name.empty(); }

    //! Return shared pointer to underlying nick.
    boost::shared_ptr<Nick> get_nick(void) { return M_nick; }

    //! Return shared pointer to underlying nick constant.
    boost::shared_ptr<Nick const> get_nick(void) const { return M_nick; }

  private:
    template<class SESSION>
    void init(SESSION& session, std::string const& prefix);
};
 
#endif // PREFIX_H

---