WarnManager.H

Go to the documentation of this file.

/* Copyright 2022 Luca Fedeli
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */

#ifndef ABLASTR_WARN_MANAGER_H_
#define ABLASTR_WARN_MANAGER_H_

#include "ablastr/utils/msg_logger/MsgLogger_fwd.H"

#include <AMReX_ParmParse.H>

#include <memory>
#include <optional>
#include <string>

namespace ablastr::warn_manager
{

    enum class WarnPriority
    {
        low,
        medium,
        high
    };

    class WarnManager
    {
    public:

        WarnManager(WarnManager &other) = delete;

        void operator=(const WarnManager &) = delete;

        static WarnManager& GetInstance();

        void RecordWarning(
            std::string topic,
            std::string text,
            WarnPriority priority = WarnPriority::medium);

        std::string PrintLocalWarnings(
            const std::string& when) const;

        std::string PrintGlobalWarnings(
            const std::string& when) const;

        void SetAlwaysWarnImmediately(bool always_warn_immediately);

        bool GetAlwaysWarnImmediatelyFlag() const;

        void SetAbortThreshold(std::optional<WarnPriority> abort_threshold);

        std::optional<WarnPriority> GetAbortThreshold() const;

        void debug_read_warnings_from_input(amrex::ParmParse& params);

        static const int warn_line_size = 80 ;
        static const int warn_tab_size = 5 ;

    private:

        WarnManager();

        std::string PrintWarnMsg(
            const ablastr::utils::msg_logger::MsgWithCounter& msg_with_counter) const;

        std::string PrintWarnMsg(
            const ablastr::utils::msg_logger::MsgWithCounterAndRanks& msg_with_counter_and_ranks) const;

        static std::string GetHeader(
            const std::string& when,
            const int line_size,
            const bool is_global);

        static std::string MsgFormatter(
            const std::string& msg,
            const int line_size,
            const int tab_size);

        int m_rank = 0 ;
        std::unique_ptr<ablastr::utils::msg_logger::Logger> m_p_logger ;
        bool m_always_warn_immediately = false ;
        std::optional<WarnPriority> m_abort_on_warning_threshold = std::nullopt ;
    };

    WarnManager& GetWMInstance();

    void WMRecordWarning(
        std::string topic,
        std::string text,
        WarnPriority priority = WarnPriority::medium);
}

#endif //ABLASTR_WARN_MANAGER_H_