NextProcess.h

[詳解]

/// @file
/// @brief アプリ終了後遷移先列挙 NextProcess のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_NEXTPROCESS_H
#define AMDAEMON_NEXTPROCESS_H

#include "amdaemon/env.h"

namespace amdaemon
{
/// @addtogroup g_core
/// @{

    /// @brief アプリ終了後遷移先列挙。
    ///
    /// Core クラスのメンバ関数 Core#kill の引数に指定し、アプリ終了後の遷移先を選択する。
    enum class NextProcess
    {
        /// @brief Daemonプロセスに遷移先を自動判別させる。
        ///
        /// - 現在ゲームテストモード中である場合は NextProcess::SystemTest が選択される。
        /// - 上記以外の場合は NextProcess::SegaBoot が選択される。
        Auto = 0,

        /// @brief セガブートに遷移し、アプリを再起動する。
        ///
        /// LANインストールやNET配信によるアプリの更新が可能であれば更新処理が行われる。
        SegaBoot,

        /// @brief セガブートに遷移し、エラー表示を行う。
        ///
        /// - 現在 Error クラスにエラーが設定されている場合、
        ///   そのエラーをセガブート画面に表示して進行停止する。
        /// - Error クラスにエラーが設定されていない場合は
        ///   NextProcess::SegaBoot と同一の挙動となる。
        SegaBootError,

        /// システムテストモードに遷移する。
        SystemTest,
    };

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_NEXTPROCESS_H