Logging.h

Go to the documentation of this file.

/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * Logging.h
 * Header file for the logging
 * Copyright (C) 2005 Simon Newton
 */
#ifndef INCLUDE_OLA_LOGGING_H_
#define INCLUDE_OLA_LOGGING_H_

#include <ostream>
#include <string>
#include <sstream>

#define OLA_LOG(level) (level <= ola::LogLevel()) && \
                        ola::LogLine(__FILE__, __LINE__, level).stream()

#define OLA_FATAL OLA_LOG(ola::OLA_LOG_FATAL)

#define OLA_WARN OLA_LOG(ola::OLA_LOG_WARN)

#define OLA_INFO OLA_LOG(ola::OLA_LOG_INFO)

#define OLA_DEBUG OLA_LOG(ola::OLA_LOG_DEBUG)

namespace ola {

enum log_level {
  OLA_LOG_NONE,   
  OLA_LOG_FATAL,  
  OLA_LOG_WARN,   
  OLA_LOG_INFO,   
  OLA_LOG_DEBUG,  
  OLA_LOG_MAX,
};

extern log_level logging_level;

typedef enum {
  OLA_LOG_STDERR,  
  OLA_LOG_SYSLOG,  
  OLA_LOG_NULL,
} log_output;

class LogDestination {
 public:
  virtual ~LogDestination() {}

  virtual void Write(log_level level, const std::string &log_line) = 0;
};

class StdErrorLogDestination: public LogDestination {
 public:
  void Write(log_level level, const std::string &log_line);
};

class SyslogDestination: public LogDestination {
 public:
  virtual ~SyslogDestination() {}

  virtual bool Init() = 0;

  virtual void Write(log_level level, const std::string &log_line) = 0;
};

#ifdef _WIN32

class WindowsSyslogDestination : public SyslogDestination {
 public:
  bool Init();

  void Write(log_level level, const std::string &log_line);
 private:
  typedef void* WindowsLogHandle;
  WindowsLogHandle m_eventlog;
};
#else

class UnixSyslogDestination : public SyslogDestination {
 public:
  bool Init();

  void Write(log_level level, const std::string &log_line);
};
#endif

class LogLine {
 public:
  LogLine(const char *file, int line, log_level level);
  ~LogLine();
  void Write();

  std::ostream &stream() { return m_stream; }
 private:
  log_level m_level;
  std::ostringstream m_stream;
  unsigned int m_prefix_length;
};
void SetLogLevel(log_level level);

inline log_level LogLevel() { return logging_level; }

void IncrementLogLevel();

bool InitLoggingFromFlags();

bool InitLogging(log_level level, log_output output);

void InitLogging(log_level level, LogDestination *destination);
/***/
}  // namespace ola
#endif  // INCLUDE_OLA_LOGGING_H_