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_BaseFwd.H>
 
#include <memory>
#include <optional>
#include <string>
 
namespace ablastr::warn_manager
{

    enum class WarnPriority
    {
        low,
        medium,
        high
    };

    class WarnManager
    {
    public:

        WarnManager( const WarnManager& ) = delete;

        WarnManager( WarnManager&& ) = delete;

        WarnManager& operator=( const WarnManager & ) = delete;

        WarnManager& operator=( const WarnManager&& ) = delete;

        ~WarnManager() = default;
 
        static WarnManager& GetInstance();

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

        [[nodiscard]] std::string PrintLocalWarnings(
            const std::string& when) const;

        [[nodiscard]] std::string PrintGlobalWarnings(
            const std::string& when) const;

        void SetAlwaysWarnImmediately(bool always_warn_immediately);

        [[nodiscard]] bool GetAlwaysWarnImmediatelyFlag() const;

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

        [[nodiscard]] std::optional<WarnPriority> GetAbortThreshold() const;

        void debug_read_warnings_from_input(const amrex::ParmParse& params);
 
        static const int warn_line_size = 80 ;
        static const int warn_tab_size = 5 ;
 
    private:

        WarnManager();

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

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

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

        static std::string MsgFormatter(
            const std::string& msg,
            int line_size,
            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(
        const std::string& topic,
        const std::string& text,
        const WarnPriority& priority = WarnPriority::medium);
}
 
#endif //ABLASTR_WARN_MANAGER_H_