Magic_Game/src/kiwano/core/Logger.h

// Copyright (c) 2016-2018 Kiwano - Nomango
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

#pragma once
#include <iomanip>
#include <kiwano/core/Common.h>
#include <kiwano/macros.h>
#include <sstream>

#ifndef KGE_SYS_LOG
#ifdef KGE_DEBUG
#define KGE_SYS_LOG(FORMAT, ...) \
    ::kiwano::Logger::GetInstance().Printf(::kiwano::Logger::Level::System, FORMAT, __VA_ARGS__)
#else
#define KGE_SYS_LOG __noop
#endif
#endif

#ifndef KGE_WARN
#define KGE_WARN(FORMAT, ...) ::kiwano::Logger::GetInstance().Printf(::kiwano::Logger::Level::Warning, FORMAT, __VA_ARGS__)
#endif

#ifndef KGE_ERROR
#define KGE_ERROR(FORMAT, ...) ::kiwano::Logger::GetInstance().Printf(::kiwano::Logger::Level::Error, FORMAT, __VA_ARGS__)
#endif

#ifndef KGE_LOG
#define KGE_LOG(...) ::kiwano::Logger::GetInstance().Println(::kiwano::Logger::Level::Info, __VA_ARGS__)
#endif

#ifndef KGE_LOGF
#define KGE_LOGF(FORMAT, ...) ::kiwano::Logger::GetInstance().Printf(::kiwano::Logger::Level::Info, FORMAT, __VA_ARGS__)
#endif

namespace kiwano
{
/**
 * \~chinese
 * @brief <EFBFBD><EFBFBD>־
 */
class KGE_API Logger : public Singleton<Logger>
{
    friend Singleton<Logger>;

public:
    /// \~chinese
    /// @brief <20><>־<EFBFBD><D6BE><EFBFBD><EFBFBD>
    enum class Level
    {
        Info,     ///< <20><>Ϣ
        System,   ///< ϵͳ
        Warning,  ///< <20><><EFBFBD><EFBFBD>
        Error     ///< <20><><EFBFBD><EFBFBD>
    };

    /// \~chinese
    /// @brief <20><>ӡ<EFBFBD><D3A1>־
    /// @param level <20><>־<EFBFBD><D6BE><EFBFBD><EFBFBD>
    /// @param format <20><>ʽ<EFBFBD>ַ<EFBFBD><D6B7><EFBFBD>
    void Printf(Level level, const char* format, ...);

    /// \~chinese
    /// @brief <20><>ӡ<EFBFBD><D3A1>־
    /// @param level <20><>־<EFBFBD><D6BE><EFBFBD><EFBFBD>
    /// @param args <20><><EFBFBD><EFBFBD>
    template <typename... _Args>
    void Print(Level level, _Args&&... args);

    /// \~chinese
    /// @brief <20><>ӡһ<D3A1><D2BB><EFBFBD><EFBFBD>־
    /// @param level <20><>־<EFBFBD><D6BE><EFBFBD><EFBFBD>
    /// @param args <20><><EFBFBD><EFBFBD>
    template <typename... _Args>
    void Println(Level level, _Args&&... args);

    /// \~chinese
    /// @brief <20><>ʾ<EFBFBD><CABE><EFBFBD>رտ<D8B1><D5BF><EFBFBD>̨
    /// @note <20>˲<EFBFBD><CBB2><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    void ShowConsole(bool show);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>־
    void Enable();

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>־
    void Disable();

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    OutputStream& GetOutputStream();

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    OutputStream& GetErrorStream();

    /// \~chinese
    /// @brief <20>ض<EFBFBD><D8B6><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    std::streambuf* RedirectOutputStreamBuffer(std::streambuf* buf);

    /// \~chinese
    /// @brief <20>ض<EFBFBD><D8B6><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    std::streambuf* RedirectErrorStreamBuffer(std::streambuf* buf);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    void ResetOutputStream();

private:
    Logger();

    ~Logger();

    void Prepare(Level level, StringStream& sstream);

    void Output(Level level, StringStream& sstream);

    void ResetConsoleColor() const;

    OutputStream& DefaultOutputColor(OutputStream& out);

private:
    bool enabled_;
    WORD default_stdout_color_;
    WORD default_stderr_color_;

    OutputStream output_stream_;
    OutputStream error_stream_;
};

inline void Logger::Enable()
{
    enabled_ = true;
}

inline void Logger::Disable()
{
    enabled_ = false;
}

template <typename... _Args>
void Logger::Print(Level level, _Args&&... args)
{
    if (!enabled_)
        return;

    StringStream sstream;
    Prepare(level, sstream);

    // Format message
    (void)std::initializer_list<int>{ ((sstream << ' ' << args), 0)... };

    Output(level, sstream);
}

template <typename... _Args>
void Logger::Println(Level level, _Args&&... args)
{
    if (!enabled_)
        return;

    StringStream sstream;
    Prepare(level, sstream);

    // Format message
    (void)std::initializer_list<int>{ ((sstream << ' ' << args), 0)... };

    sstream << "\r\n";

    Output(level, sstream);
}

inline void Logger::ResetConsoleColor() const
{
    ::SetConsoleTextAttribute(::GetStdHandle(STD_OUTPUT_HANDLE), default_stdout_color_);
    ::SetConsoleTextAttribute(::GetStdHandle(STD_ERROR_HANDLE), default_stderr_color_);
}

inline OutputStream& Logger::DefaultOutputColor(OutputStream& out)
{
    ::SetConsoleTextAttribute(::GetStdHandle(STD_OUTPUT_HANDLE), default_stdout_color_);
    return out;
}

inline OutputStream& Logger::GetOutputStream()
{
    return output_stream_;
}

inline OutputStream& Logger::GetErrorStream()
{
    return error_stream_;
}
}  // namespace kiwano