Message.h

Go to the documentation of this file.

//-
// =============================================================================
// Copyright 2025 Autodesk, Inc. All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
// =============================================================================
 
//+
 
 
#ifndef AMINO_CORE_MESSAGE_H
#define AMINO_CORE_MESSAGE_H
 
#include <Amino/Core/CoreExport.h>
 
#include <Amino/Core/MessageFwd.h>
#include <Amino/Core/Source.h>
#include <Amino/Core/String.h>
#include <Amino/Core/StringView.h>
#include <Amino/Core/internal/Format.h>
#include <Amino/Core/internal/PImpl.h>
 
#define AMINO_API AMINO_CORE_SHARED_DECL
 
//==============================================================================
// NAMESPACE Amino
//==============================================================================
 
namespace Amino {
 
//==============================================================================
// ENUM MessageKind
//==============================================================================
 
enum class MessageKind : int { //
    eError,
    eWarning,
    eInfo,
    eDebug
};
 
//==============================================================================
// CLASS MessageClass
//==============================================================================
 
class MessageClass final {
public:
    AMINO_API MessageClass();
 
    // NOLINTNEXTLINE(google-explicit-constructor)
    /*implicit*/ constexpr MessageClass(StringLiteral literal) noexcept
        : m_name{literal} {}
 
    StringView getName() const { return m_name; }
 
    AMINO_API bool isDefault() const;
 
    bool operator==(MessageClass const& o) const {
        return static_cast<void const*>(m_name.data()) ==
               static_cast<void const*>(o.m_name.data());
    }
 
    bool operator!=(MessageClass const& o) const { return !operator==(o); }
 
private:
    StringView m_name;
};
 
//==============================================================================
// CLASS MessageText
//==============================================================================
 
class MessageText final {
public:
    // NOLINTNEXTLINE(google-explicit-constructor)
    /*implicit*/ constexpr MessageText(StringLiteral literal) noexcept
        : m_format{literal} {} // LCOV_EXCL_BR_LINE
 
    StringView getFormat() const& { return m_format; }
 
private:
    StringView m_format;
};
 
//==============================================================================
// CLASS Message
//==============================================================================
 
class Message final {
public:
    /*----- static member functions -----*/
 
    static constexpr StringView toString(MessageKind kind) {
        using namespace Amino::StringViewLiterals;
        switch (kind) { // LCOV_EXCL_BR_LINE
            case MessageKind::eError: return "Error"_asv;
            case MessageKind::eWarning: return "Warning"_asv;
            case MessageKind::eInfo: return "Info"_asv;
            case MessageKind::eDebug: return "Debug"_asv;
        }
        return "Unknown"_asv; // LCOV_EXCL_LINE
    }
 
    /*----- member functions -----*/
 
    AMINO_API Message();
 
    AMINO_API Message(
        Source source, MessageKind kind, MessageClass cls, MessageText text);
 
    // LCOV_EXCL_BR_START
    template <typename Arg, typename... Args>
    Message(
        Source       source,
        MessageKind  kind,
        MessageClass cls,
        MessageText  text,
        Arg const&   arg,
        Args const&... args)
        : Message{
              std::move(source), kind, cls, text,
              SpanParam{Internal::FormatArgs{arg, args...}}} {}
    // LCOV_EXCL_BR_STOP
 
    AMINO_API Message(Message const& o);
 
    AMINO_API Message(Message&& o) noexcept;
 
    AMINO_API Message& operator=(Message const& o);
 
    AMINO_API Message& operator=(Message&& o) noexcept;
 
    AMINO_API ~Message();
 
    AMINO_API bool isValid() const;
    explicit       operator bool() const { return isValid(); }
 
    AMINO_API Source const& getSource() const;
 
    AMINO_API MessageKind getKind() const;
 
    AMINO_API MessageClass getClass() const;
 
    AMINO_API String getText() const;
 
    template <typename Os>
    AMINO_INTERNAL_FORCEINLINE void toStream(
        Os& os, bool newline = true) const {
        internal_toStream(toStreamFor<Os>, static_cast<void*>(&os));
        if (newline) os << '\n';
    }
 
    AMINO_API String getFormattedText() const;
 
private:
 
    /*----- types -----*/
 
    using FormatFn =
        void (*)(SpanParam<StringView const> const& strs, void* client);
 
    /*----- static member functions -----*/
 
    // LCOV_EXCL_BR_START
    template <typename Os>
    static void toStreamFor(
        SpanParam<StringView const> const& strs, void* client) {
        Os& os = *static_cast<Os*>(client);
        for (auto const& s : strs) os.write(s.data(), s.size());
    }
    // LCOV_EXCL_BR_STOP
 
    /*----- member functions -----*/
 
    AMINO_API Message(
        Source                                      source,
        MessageKind                                 kind,
        MessageClass                                cls,
        MessageText                                 text,
        SpanParam<Internal::FormatArg const> const& args);
 
    AMINO_API void internal_toStream(FormatFn fn, void* client) const;
 
    /*----- data members -----*/
 
    Internal::PImpl<Message, 2> m_impl;
};
 
//==============================================================================
// CLASS MessageFilter
//==============================================================================
 
class alignas(void*) MessageFilter {
public:
    /*----- types -----*/
 
    enum Level : int {
        eDisabled = -1,
        eError    = static_cast<int>(MessageKind::eError),
        eWarning  = static_cast<int>(MessageKind::eWarning),
        eInfo     = static_cast<int>(MessageKind::eInfo),
        eDebug    = static_cast<int>(MessageKind::eDebug)
    };
 
    /*----- static member functions -----*/
 
    static constexpr Level asLevel(MessageKind kind) {
        return static_cast<Level>(kind);
    }
 
    /*----- member functions -----*/
 
    MessageFilter() noexcept = default;
 
    explicit MessageFilter(MessageKind lvl) noexcept
        : MessageFilter(asLevel(lvl)) {}
    explicit MessageFilter(Level lvl) noexcept : m_level{lvl} {}
 
    Level getLevel() const { return m_level; }
 
    void setLevel(MessageKind lvl) { setLevel(asLevel(lvl)); }
    void setLevel(Level lvl) { m_level = lvl; }
 
    bool isEnabled(MessageKind kind) const { return asLevel(kind) <= m_level; }
 
    bool isEnabled() const { return m_level != eDisabled; }
 
private:
    /*----- data members -----*/
 
    Level m_level = eInfo;
};
 
} // namespace Amino
 
#undef AMINO_API
 
#endif