logger.h

/*******************************************************************************
 * Copyright (C) 2026 Commissariat a l'energie atomique et aux energies alternatives (CEA)
 * Copyright (C) 2018-2022 Institute of Bioorganic Chemistry Polish Academy of Science (PSNC)
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * * Neither the name of CEA nor the names of its contributors may be used to
 *   endorse or promote products derived from this software without specific
 *   prior written permission.
 *
 * 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.
 ******************************************************************************/
 
#ifndef PDI_LOGGER_H_
#define PDI_LOGGER_H_
 
#include <string>
#include <utility>
#include <vector>
 
#include <spdlog/logger.h>
#include <spdlog/spdlog.h>
 
#include <pdi/pdi_fwd.h>
#include <pdi/paraconf_wrapper.h>
 
namespace PDI {

class PDI_EXPORT Logger
{
    std::shared_ptr<spdlog::logger> m_logger;

    std::vector<std::reference_wrapper<Logger>> m_default_pattern_observers;

    std::vector<std::string> m_pattern_blocks;

    std::string m_pattern = "[%T][%n] *** %^%l%$: %v";

    bool m_pattern_from_config = false;

    void build_pattern();

    Logger* m_parent_logger = nullptr; //change in c++17 to std::optional
 
public:
    Logger() = default;

    Logger(const std::string& logger_name, PC_tree_t config, spdlog::level::level_enum level = spdlog::level::info);

    Logger(Logger& parent_logger, const std::string& logger_name, PC_tree_t config);

    void setup(const std::string& logger_name, PC_tree_t config, spdlog::level::level_enum level = spdlog::level::info);

    void setup(Logger& parent_logger, const std::string& logger_name, PC_tree_t config);

    void pattern(const std::string& pattern);

    void global_pattern(const std::string& pattern);

    void default_pattern(const std::string& pattern);

    void add_pattern_block(const std::string& block);

    void add_pattern_global_block(const std::string& block);

    const std::string& pattern() const;

    void level(spdlog::level::level_enum log_level);

    spdlog::level::level_enum level() const;

    void evaluate_pattern(Context& ctx) const;

    void evaluate_global_pattern(Context& ctx) const;

    template <typename... Args>
    void trace(fmt::format_string<Args...> fmt, Args&&... args)
    {
        m_logger->trace(fmt, std::forward<Args>(args)...);
    }

    template <typename... Args>
    void debug(fmt::format_string<Args...> fmt, Args&&... args)
    {
        m_logger->debug(fmt, std::forward<Args>(args)...);
    }

    template <typename... Args>
    void info(fmt::format_string<Args...> fmt, Args&&... args)
    {
        m_logger->info(fmt, std::forward<Args>(args)...);
    }

    template <typename... Args>
    void warn(fmt::format_string<Args...> fmt, Args&&... args)
    {
        m_logger->warn(fmt, std::forward<Args>(args)...);
    }

    template <typename... Args>
    void error(fmt::format_string<Args...> fmt, Args&&... args)
    {
        m_logger->error(fmt, std::forward<Args>(args)...);
    }

    std::shared_ptr<spdlog::logger> real_logger();
};
 
} // namespace PDI
 
#endif // PDI_LOGGER_H_