log.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2006,2007 INRIA
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */
 
#ifndef NS3_LOG_H
#define NS3_LOG_H
 
#include <string>
#include <iostream>
#include <stdint.h>
#include <map>
#include <vector>
 
#include "node-printer.h"
#include "time-printer.h"
#include "log-macros-enabled.h"
#include "log-macros-disabled.h"
 
namespace ns3 {
 
enum LogLevel
{
  LOG_NONE           = 0x00000000, 
 
  LOG_ERROR          = 0x00000001, 
  LOG_LEVEL_ERROR    = 0x00000001, 
 
  LOG_WARN           = 0x00000002, 
  LOG_LEVEL_WARN     = 0x00000003, 
 
  LOG_DEBUG          = 0x00000004, 
  LOG_LEVEL_DEBUG    = 0x00000007, 
 
  LOG_INFO           = 0x00000008, 
  LOG_LEVEL_INFO     = 0x0000000f, 
 
  LOG_FUNCTION       = 0x00000010, 
  LOG_LEVEL_FUNCTION = 0x0000001f, 
 
  LOG_LOGIC          = 0x00000020, 
  LOG_LEVEL_LOGIC    = 0x0000003f, 
 
  LOG_ALL            = 0x0fffffff, 
  LOG_LEVEL_ALL      = LOG_ALL,    
 
  LOG_PREFIX_FUNC    = 0x80000000, 
  LOG_PREFIX_TIME    = 0x40000000, 
  LOG_PREFIX_NODE    = 0x20000000, 
  LOG_PREFIX_LEVEL   = 0x10000000, 
  LOG_PREFIX_ALL     = 0xf0000000  
};
 
void LogComponentEnable (char const *name, enum LogLevel level);
 
void LogComponentEnableAll (enum LogLevel level);
 
 
void LogComponentDisable (char const *name, enum LogLevel level);
 
void LogComponentDisableAll (enum LogLevel level);
 
 
} // namespace ns3
 
 
#define NS_LOG_COMPONENT_DEFINE(name)                           \
  static ns3::LogComponent g_log = ns3::LogComponent (name, __FILE__)
 
#define NS_LOG_COMPONENT_DEFINE_MASK(name, mask)                \
  static ns3::LogComponent g_log = ns3::LogComponent (name, __FILE__, mask)
 
#define NS_LOG_TEMPLATE_DECLARE  LogComponent & g_log
 
#define NS_LOG_TEMPLATE_DEFINE(name)  g_log (GetLogComponent (name))
 
#define NS_LOG_STATIC_TEMPLATE_DEFINE(name) \
  [[maybe_unused]] static LogComponent & g_log = GetLogComponent (name)
 
#define NS_LOG_ERROR(msg) \
  NS_LOG (ns3::LOG_ERROR, msg)
 
#define NS_LOG_WARN(msg) \
  NS_LOG (ns3::LOG_WARN, msg)
 
#define NS_LOG_DEBUG(msg) \
  NS_LOG (ns3::LOG_DEBUG, msg)
 
#define NS_LOG_INFO(msg) \
  NS_LOG (ns3::LOG_INFO, msg)
 
#define NS_LOG_LOGIC(msg) \
  NS_LOG (ns3::LOG_LOGIC, msg)
 
 
namespace ns3 {
 
void LogComponentPrintList (void);
 
void LogSetTimePrinter (TimePrinter lp);
TimePrinter LogGetTimePrinter (void);
 
void LogSetNodePrinter (NodePrinter np);
NodePrinter LogGetNodePrinter (void);
 
 
class LogComponent
{
public:
  LogComponent (const std::string & name,
                const std::string & file,
                const enum LogLevel mask = LOG_NONE);
  bool IsEnabled (const enum LogLevel level) const;
  bool IsNoneEnabled (void) const;
  void Enable (const enum LogLevel level);
  void Disable (const enum LogLevel level);
  char const * Name (void) const;
  std::string File (void) const;
  static std::string GetLevelLabel (const enum LogLevel level);
  void SetMask (const enum LogLevel level);
 
  typedef std::map<std::string, LogComponent *> ComponentList;
 
  static ComponentList * GetComponentList (void);
 
private:
  void EnvVarCheck (void);
 
  int32_t     m_levels;  
  int32_t     m_mask;    
  std::string m_name;    
  std::string m_file;    
 
};  // class LogComponent
 
LogComponent & GetLogComponent (const std::string name);
 
class ParameterLogger
{
  bool m_first;        
  std::ostream &m_os;  
 
public:
  ParameterLogger (std::ostream &os);
 
  template<typename T>
  ParameterLogger& operator<< (T param);
 
  template<typename T>
  ParameterLogger& operator<< (std::vector<T> vector);
 
};
 
template<typename T>
ParameterLogger&
ParameterLogger::operator<< (T param)
{
  if (m_first)
    {
      m_os << param;
      m_first = false;
    }
  else
    {
      m_os << ", " << param;
    }
  return *this;
}
 
template<typename T>
ParameterLogger&
ParameterLogger::operator<< (std::vector<T> vector)
{
  for (auto i : vector)
    {
      *this << i;
    }
  return *this;
}
 
template<>
ParameterLogger &
ParameterLogger::operator<< <std::string> (const std::string param);
 
template<>
ParameterLogger &
ParameterLogger::operator<< <const char *> (const char * param);
 
template<>
ParameterLogger &
ParameterLogger::operator<< <int8_t> (int8_t param);
 
template<>
ParameterLogger &
ParameterLogger::operator<< <uint8_t> (uint8_t param);
 
} // namespace ns3
  // \ingroup logging
 
#endif /* NS3_LOG_H */