ExceptionCategory.h

[詳解]

/// @file
/// @brief AM Daemon の例外カテゴリ列挙 ExceptionCategory のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_EXCEPTIONCATEGORY_H
#define AMDAEMON_EXCEPTIONCATEGORY_H

#include "amdaemon/env.h"

namespace amdaemon
{
/// @addtogroup g_exception
/// @{

    /// AM Daemon の例外カテゴリ列挙。
    enum class ExceptionCategory
    {
        /// @brief 引数間違いなど単純なバグ。
        ///
        /// 例外スローを抑止した場合は例外生成元の関数が失敗値(false など)を返す。
        Logic = 0,

        /// @brief 呼び出し順序間違いなどAPI使用方法のミス。
        ///
        /// 例外スローを抑止した場合は例外生成元の関数が失敗値(false など)を返す。
        Operation,

        /// @brief 実行時の状況によるエラー。
        ///
        /// 例外スローを抑止した場合は例外生成元の関数が失敗値(false など)を返す。
        Runtime,

        /// @brief 共有メモリ確保失敗など回復不能なエラー。
        ///
        /// 例外スローを抑止した場合はまず __debugbreak 関数を呼び出し、
        /// そこを通過した場合は std::unexpected 関数を呼び出す。
        /// std::unexpected 関数は既定ではアプリを強制終了させる。
        Fatal,

        /// @brief 不明。ライブラリ側で明示的にこのカテゴリを用いることはない。
        ///
        /// 例外スローを抑止した場合はまず __debugbreak 関数を呼び出し、
        /// そこを通過した場合は std::unexpected 関数を呼び出す。
        /// std::unexpected 関数は既定ではアプリを強制終了させる。
        Unknown,
    };

    /// @brief @ref ExceptionCategory 列挙値の文字列表現値を取得する。
    /// @param[in] category @ref ExceptionCategory 列挙値。
    /// @return @ref ExceptionCategory 列挙値の文字列表現値。不正値の場合は nullptr 。
    /// @internal ライブラリ実装メモ: enumsToString.cpp で実装。
    const wchar_t* toString(ExceptionCategory category);

/// @}
} // namespace amdaemon

#endif // AMDAEMON_EXCEPTIONCATEGORY_H