logger.h

/*
    Lightmetrica : A research-oriented renderer

    Copyright (c) 2014 Hisanari Otsu

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    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, see <http://www.gnu.org/licenses/>.
*/

#pragma once
#ifndef LIB_LIGHTMETRICA_LOGGER_H
#define LIB_LIGHTMETRICA_LOGGER_H

#include "common.h"
#include <string>
#include <memory>
#include <functional>
#include <boost/signals2.hpp>

LM_NAMESPACE_BEGIN

class LM_PUBLIC_API Logger
{
public:

    enum LogOutputMode
    {
        Signal          = 1<<0,     
        Stdout          = 1<<1,     
        Stderr          = 1<<2,     
        File            = 1<<3,     
        FileHtml        = 1<<4,     
        DebugOutput     = 1<<5,     

        NoFileOutput    = Signal | Stdout | Stderr | DebugOutput,   
        FileOutput      = File | FileHtml,                          
    };

    enum class LogUpdateMode
    {
        Manual,         
        Immediate,      
    };

    enum class LogLevel
    {
        Error,          
        Warning,        
        Information,    
        Debug,          
    };

    /*
        Log entry.
        The entry of the log message.
    */
    struct LogEntry
    {
        LogLevel level;         
        std::string time;       
        std::string message;    
    };

private:

    Logger();
    ~Logger();

    LM_DISABLE_COPY_AND_MOVE(Logger);

public:

    static boost::signals2::connection Connect_LogUpdate(const std::function<void (LogEntry*)>& func);

public:

    static void Reset();

    static void Clear();

    static void Error(const std::string& message, const std::string& prefix);

    static void Warn(const std::string& message, const std::string& prefix);

    static void Info(const std::string& message, const std::string& prefix);

    static void Debug(const std::string& message, const std::string& prefix);

    static int CountNoFileOutputEntries();

    static int CountFileOutputEntries();

    static void SetUpdateMode(LogUpdateMode mode);

    static void SetOutputMode(int mode);

    static void SetOutputFrequency(int freq);

    static void SetOutputFrequencyForFileOutput(int freq);

    static void SetOutputFileName(const std::string& fileName);

    static std::string FormattedDebugInfo(const char* fileName, int line);

    static void ProcessOutput();

    static bool Empty();

    static unsigned int Indentation();

    static void SetIndentation(unsigned int indentation);

};

class LogIndenter
{
public:

    LogIndenter() { Logger::SetIndentation(Logger::Indentation() + 1); }
    ~LogIndenter() { Logger::SetIndentation(Logger::Indentation() - 1); }

private:

    LM_DISABLE_COPY_AND_MOVE(LogIndenter);

};

LM_NAMESPACE_END

#if LM_DEBUG_MODE
    #define LM_LOG_ERROR(message) lightmetrica::Logger::Error(message, lightmetrica::Logger::FormattedDebugInfo(__FILE__, __LINE__));
    #define LM_LOG_WARN(message) lightmetrica::Logger::Warn(message, lightmetrica::Logger::FormattedDebugInfo(__FILE__, __LINE__));
    #define LM_LOG_INFO(message) lightmetrica::Logger::Info(message, lightmetrica::Logger::FormattedDebugInfo(__FILE__, __LINE__));
    #define LM_LOG_DEBUG(message) lightmetrica::Logger::Debug(message, lightmetrica::Logger::FormattedDebugInfo(__FILE__, __LINE__));
#else
    #define LM_LOG_ERROR(message) lightmetrica::Logger::Error(message, "");
    #define LM_LOG_WARN(message) lightmetrica::Logger::Warn(message, "");
    #define LM_LOG_INFO(message) lightmetrica::Logger::Info(message, "");
    #define LM_LOG_DEBUG(message) lightmetrica::Logger::Debug(message, "");
#endif
#define LM_LOG_INDENTER() lightmetrica::LogIndenter _logIndenter;

#endif // LIB_LIGHTMETRICA_LOGGER_H