ircproxy  The Ultimate Cyborg

---

debug_ostream_operators.h

Go to the documentation of this file.

// ircproxy -- An intelligent IRC proxy
//
//! @file debug_ostream_operators.h
//! @brief This file contains the declaration of debug related ostream inserters.
//
// Copyright (C) 2005 - 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 DEBUG_OSTREAM_OPERATORS_H
#define DEBUG_OSTREAM_OPERATORS_H

#ifdef CWDEBUG

#ifndef USE_PCH
#include <sys/time.h>
#include <regex.h>                      // regex_t
#include <iosfwd>                       // std::ostream&
#include <utility>                      // std::pair
#include <boost/shared_ptr.hpp>         // boost::shared_ptr
#include <boost/weak_ptr.hpp>           // boost::weak_ptr
#endif

struct timeval;
class Application;
class Server;
class Network;
class MessageIn;
class ClientMessageIn;
class ServerMessageIn;
class UserAnswerRequestData;
class UserAnswer;
class UserAnswerEventRequestBase;
class Identity;
class IdentityReference;
class Authentication;
class Channel;
class Nick;
class ClientSession;
class QuestionTarget;
class NoticeTarget;
class ServerSession;
class Target;
class DestructEventRequestData;
class ServerConnection;
class MessageOutData;
class MessageOut;
class Priority;
class Matcher;
class MatchRequestList;
class MatchRequest;
class MatcherEventType;
class Prefix;
class PseudoMessageEventRequestData;
class Member;
class WhoOptions;
class WhoRequest;
class SignalType;
class ServerVersion;
class AuthState;

extern std::ostream& operator<<(std::ostream& os, Application const& application);              //!< Print debug info for Application instance \a application.
extern std::ostream& operator<<(std::ostream& os, Server const& server);                        //!< Print debug info for Server instance \a server.
extern std::ostream& operator<<(std::ostream& os, Network const& network);                      //!< Print debug info for Network instance \a network.
extern std::ostream& operator<<(std::ostream& os, MessageIn const& msg);                        //!< Print debug info for MessageIn instance \a msg.
extern std::ostream& operator<<(std::ostream& os, ClientMessageIn const& msg);                  //!< Print debug info for ClientMessageIn instance \a msg.
extern std::ostream& operator<<(std::ostream& os, ServerMessageIn const& msg);                  //!< Print debug info for ServerMessageIn instance \a msg.
extern std::ostream& operator<<(std::ostream& os, UserAnswerRequestData const& request_data);   //!< Print debug info for UserAnswerRequestData instance \a request_data.
extern std::ostream& operator<<(std::ostream& os, UserAnswer const& answer);                    //!< Print debug info for UserAnswer instance \a answer.
extern std::ostream& operator<<(std::ostream& os, UserAnswerEventRequestBase const& request);   //!< Print debug info for UserAnswerEventRequestBase instance \a request.
extern std::ostream& operator<<(std::ostream& os, Identity const& identity);                    //!< Print debug info for Identity instance \a identity.
extern std::ostream& operator<<(std::ostream& os, IdentityReference const& identity_reference); //!< Print debug info for IdentityReference instance \a identity_reference.
extern std::ostream& operator<<(std::ostream& os, Authentication const& authentication);        //!< Print debug info for Authentication instance \a authentication.
extern std::ostream& operator<<(std::ostream& os, Channel const& channel);                      //!< Print debug info for Channel instance \a channel.
extern std::ostream& operator<<(std::ostream& os, Nick const& nick);                            //!< Print debug info for Nick instance \a nick.
extern std::ostream& operator<<(std::ostream& os, ClientSession const& client_session);         //!< Print debug info for ClientSession instance \a client_session.
extern std::ostream& operator<<(std::ostream& os, QuestionTarget const& question_target);       //!< Print debug info for QuestionTarget instance \a question_target.
extern std::ostream& operator<<(std::ostream& os, NoticeTarget const& notice_target);           //!< Print debug info for NoticeTarget instance \a notice_target.
extern std::ostream& operator<<(std::ostream& os, ServerSession const& server_session);         //!< Print debug info for ServerSession instance \a  server_session.
extern std::ostream& operator<<(std::ostream& os, Target const& target);                        //!< Print debug info for Target instance \a  target.
extern std::ostream& operator<<(std::ostream& os, DestructEventRequestData const& request_data);//!< Print debug info for DestructEventRequestData instance \a  request_data.
extern std::ostream& operator<<(std::ostream& os, ServerConnection const& server_connection);   //!< Print debug info for ServerConnection instance \a  server_connection.
extern std::ostream& operator<<(std::ostream& os, MessageOutData const& data);                  //!< Print debug info for MessageOutData instance \a  data.
extern std::ostream& operator<<(std::ostream& os, MessageOut const& message);                   //!< Print debug info for MessageOut instance \a message.
extern std::ostream& operator<<(std::ostream& os, Priority const& priority);                    //!< Print debug info for Priority instance \a priority.
extern std::ostream& operator<<(std::ostream& os, timeval const& time);                         //!< Print debug info for timeval instance \a time.
extern std::ostream& operator<<(std::ostream& os, regex_t const& regex);                        //!< Print debug info for regex_t instance \a regex.
extern std::ostream& operator<<(std::ostream& os, Matcher const& matcher);                      //!< Print debug info for Matcher instance \a matcher.
extern std::ostream& operator<<(std::ostream& os, MatchRequestList const& match_request_list);  //!< Print debug info for MatchRequestList instance \a match_request_list.
extern std::ostream& operator<<(std::ostream& os, MatchRequest const& match_request);           //!< Print debug info for MatchRequest instance \a match_request.
extern std::ostream& operator<<(std::ostream& os, MatcherEventType const& event_type);          //!< Print debug info for MatcherEventType instance \a event_type.
extern std::ostream& operator<<(std::ostream& os, Prefix const& prefix);                        //!< Print debug info for Prefix instance \a prefix.
extern std::ostream& operator<<(std::ostream& os, PseudoMessageEventRequestData const& request_data);   //!< Print debug info for PseudoMessageEventRequestData instance \a  request_data.
extern std::ostream& operator<<(std::ostream& os, Member const& member);                        //!< Print debug info for Member instance \a member.
extern std::ostream& operator<<(std::ostream& os, WhoOptions const& who_options);               //!< Print debug info for WhoOptions instance \a who_options.
extern std::ostream& operator<<(std::ostream& os, WhoRequest const& who_request);               //!< Print debug info for WhoRequest instance \a who_request.
extern std::ostream& operator<<(std::ostream& os, SignalType const& signal);                    //!< Print debug info for SignalType instance \a signal.
extern std::ostream& operator<<(std::ostream& os, ServerVersion const& server_version);         //!< Print debug info for ServerVersion instance \a server_version.
extern std::ostream& operator<<(std::ostream& os, AuthState const& auth_state);                 //!< Print debug info for AuthState instance \a auth_state.

//! Print debug info for boost::shared_ptr&lt;T&gt;.
template<typename T>
std::ostream& operator<<(std::ostream& os, boost::shared_ptr<T> const& data)
{
  os << "(boost::shared_ptr<" << libcwd::type_info_of<T>().demangled_name() << ">)({";
  if (data.get())
    os << *data;
  else
    os << "<NULL>";
  return os << "})";
}

//! Print debug info for boost::weak_ptr&lt;T&gt;.
template<typename T>
std::ostream& operator<<(std::ostream& os, boost::weak_ptr<T> const& data)
{
  return os << "(boost::weak_ptr<" << libcwd::type_info_of<T>().demangled_name() << ">)({ " << *boost::shared_ptr<T>(data) << "})";
}

//! Print debug info for std::pair&lt;&gt; instance \a data.
template<typename T1, typename T2>
std::ostream& operator<<(std::ostream& os, std::pair<T1, T2> const& data)
{
  return os << "{first:" << data.first << ", second:" << data.second << '}';
}

//! Print a whole map.
template<typename T1, typename T2, typename T3>
std::ostream& operator<<(std::ostream& os, std::map<T1, T2, T3> const& data)
{
  os << "{map<" << libcwd::type_info_of<T1>().demangled_name() <<
      ", " << libcwd::type_info_of<T2>().demangled_name() <<
      ", " << libcwd::type_info_of<T3>().demangled_name() <<">:";
  typedef std::map<T1, T2, T3> map_type;
  for (typename map_type::const_iterator iter = data.begin(); iter != data.end(); ++iter)
    os << '{' << *iter << '}';
  return os << '}';
}

#endif // CWDEBUG
#endif // DEBUG_OSTREAM_OPERATORS_H

---