mirror of
https://github.com/dolphin-emu/dolphin.git
synced 2025-12-16 04:09:39 +00:00
2d48043b61
Preserve the configured logging verbosity unless the user actually changes it, rather than capping it to LINFO on release builds. Rename LogManager::m_level to m_effective_level and distinguish between the config and effective level in various function/variable names. Make m_effective_level atomic to prevent data races when setting the effective log level from the config changed callback.
100 lines
2.7 KiB
C++
100 lines
2.7 KiB
C++
// Copyright 2009 Dolphin Emulator Project
|
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
#pragma once
|
|
|
|
#include <array>
|
|
#include <atomic>
|
|
#include <cstdarg>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "Common/BitSet.h"
|
|
#include "Common/Config/Config.h"
|
|
#include "Common/EnumMap.h"
|
|
#include "Common/Logging/Log.h"
|
|
|
|
namespace Common::Log
|
|
{
|
|
// This variable should only be read to update the effective log level, and its base layer should
|
|
// only be set when the user selects a new verbosity. Everything else should use the effective log
|
|
// level instead. When running a release build this prevents overwriting the LDEBUG config value
|
|
// with the clamped LINFO level.
|
|
extern const Config::Info<LogLevel> LOGGER_VERBOSITY;
|
|
|
|
// pure virtual interface
|
|
class LogListener
|
|
{
|
|
public:
|
|
virtual ~LogListener() = default;
|
|
virtual void Log(LogLevel level, const char* msg) = 0;
|
|
|
|
enum LISTENER
|
|
{
|
|
FILE_LISTENER = 0,
|
|
CONSOLE_LISTENER,
|
|
LOG_WINDOW_LISTENER,
|
|
|
|
NUMBER_OF_LISTENERS // Must be last
|
|
};
|
|
};
|
|
|
|
class LogManager final
|
|
{
|
|
public:
|
|
struct LogContainer
|
|
{
|
|
const char* m_short_name;
|
|
const char* m_full_name;
|
|
bool m_enable = false;
|
|
};
|
|
|
|
~LogManager();
|
|
|
|
static LogManager* GetInstance();
|
|
static void Init();
|
|
static void Shutdown();
|
|
|
|
void Log(LogLevel level, LogType type, const char* file, int line, const char* message);
|
|
void LogWithFullPath(LogLevel level, LogType type, const char* file, int line,
|
|
const char* message);
|
|
|
|
// Use this function instead of LOGGER_VERBOSITY to determine which logs should be printed.
|
|
LogLevel GetEffectiveLogLevel() const;
|
|
void SetConfigLogLevel(LogLevel level);
|
|
|
|
void SetEnable(LogType type, bool enable);
|
|
bool IsEnabled(LogType type, LogLevel level = LogLevel::LNOTICE) const;
|
|
|
|
std::vector<LogContainer> GetLogTypes();
|
|
|
|
const char* GetShortName(LogType type) const;
|
|
const char* GetFullName(LogType type) const;
|
|
|
|
void RegisterListener(LogListener::LISTENER id, std::unique_ptr<LogListener> listener);
|
|
void EnableListener(LogListener::LISTENER id, bool enable);
|
|
bool IsListenerEnabled(LogListener::LISTENER id) const;
|
|
|
|
void SaveSettings();
|
|
|
|
private:
|
|
LogManager();
|
|
|
|
LogManager(const LogManager&) = delete;
|
|
LogManager& operator=(const LogManager&) = delete;
|
|
LogManager(LogManager&&) = delete;
|
|
LogManager& operator=(LogManager&&) = delete;
|
|
|
|
static std::string GetTimestamp();
|
|
void SetEffectiveLogLevel();
|
|
|
|
std::atomic<LogLevel> m_effective_level;
|
|
Config::ConfigChangedCallbackID m_config_changed_callback_id;
|
|
EnumMap<LogContainer, LAST_LOG_TYPE> m_log{};
|
|
std::array<std::unique_ptr<LogListener>, LogListener::NUMBER_OF_LISTENERS> m_listeners{};
|
|
BitSet32 m_listener_ids;
|
|
size_t m_path_cutoff_point = 0;
|
|
};
|
|
} // namespace Common::Log
|