Chat-O-Matic/libs/libgloox/logsink.h

/*
  Copyright (c) 2005-2009 by Jakob Schroeter <js@camaya.net>
  This file is part of the gloox library. http://camaya.net/gloox

  This software is distributed under a license. The full license
  agreement can be found in the file LICENSE in this distribution.
  This software may not be copied, modified, sold or distributed
  other than expressed in the named license agreement.

  This software is distributed without any warranty.
*/


#ifndef LOGSINK_H__
#define LOGSINK_H__

#include "gloox.h"
#include "loghandler.h"

#include <string>
// #include <fstream>

namespace gloox
{

  /**
   * @brief An implementation of log sink and source.
   *
   * To log the output of your Client or Component, use ClientBase's
   * @link ClientBase::logInstance() logInstance() @endlink to get hold of the LogSink
   * object for that ClientBase. Register your LogHandler with that instance.
   *
   * You should not need to use this class directly.
   *
   * @author Jakob Schroeter <js@camaya.net>
   * @since 0.8
   */
  class GLOOX_API LogSink
  {
    public:
      /**
       * Constructor.
       */
      LogSink();

      /**
       * Virtual destructor.
       */
      virtual ~LogSink();

      /**
       * Use this function to log a message with given LogLevel and LogIdentifier.
       * dbg(), warn(), and err() are alternative shortcuts.
       * @param level The severity of the logged event.
       * @param area The part of the program/library the message comes from.
       * @param message The actual log message.
       */
      void log( LogLevel level, LogArea area, const std::string& message ) const;

      /**
       * Use this function to log a debug message with given LogIdentifier.
       * This is a convenience wrapper around log().
       * @param area The part of the program/library the message comes from.
       * @param message The actual log message.
       */
      void dbg( LogArea area, const std::string& message ) const
        { log( LogLevelDebug, area, message ); }

      /**
       * Use this function to log a warning message with given LogIdentifier.
       * This is a convenience wrapper around log().
       * @param area The part of the program/library the message comes from.
       * @param message The actual log message.
       */
      void warn( LogArea area, const std::string& message ) const
        { log( LogLevelWarning, area, message ); }

      /**
       * Use this function to log a error message with given LogIdentifier.
       * This is a convenience wrapper around log().
       * @param area The part of the program/library the message comes from.
       * @param message The actual log message.
       */
      void err( LogArea area, const std::string& message ) const
        { log( LogLevelError, area, message ); }

      /**
       * Registers @c lh as object that receives all debug messages of the specified type.
       * Suitable for logging to a file, etc.
       * @param level The LogLevel for this handler.
       * @param areas Bit-wise ORed LogAreas the LogHandler wants to be informed about.
       * @param lh The object to receive exchanged data.
       */
      void registerLogHandler( LogLevel level, int areas, LogHandler* lh );

      /**
       * Removes the given object from the list of log handlers.
       * @param lh The object to remove from the list.
       */
      void removeLogHandler( LogHandler* lh );

    private:
      struct LogInfo
      {
        LogLevel level;
        int areas;
      };

      LogSink( const LogSink& /*copy*/ );

      typedef std::map<LogHandler*, LogInfo> LogHandlerMap;
      LogHandlerMap m_logHandlers;

  };

}

#endif // LOGSINK_H__