AppImage.h

[詳解]

/// @file
/// @brief アプリイメージ関連情報を提供するMonostateクラス AppImage のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_APPIMAGE_H
#define AMDAEMON_APPIMAGE_H

#include "amdaemon/env.h"
#include "amdaemon/OptionImageInfo.h"
#include "amdaemon/Version.h"
#include "amdaemon/util/DateTime.h"

#include <string>

namespace amdaemon
{
/// @addtogroup g_appimage
/// @{

    /// @brief アプリイメージ関連情報を提供するMonostateクラス。
    ///
    /// Core クラスのメンバ関数 Core#execute 呼び出しによって内容が更新される。
    ///
    /// @ingroup g_common
    class AppImage
    {
    public:
        // 下記は暗黙の定義を用いる。
        //AppImage() = default;
        //‾AppImage() = default;
        //AppImage(const AppImage&) = default;
        //AppImage& operator=(const AppImage&) = default;

        /// @brief 現在稼働中アプリのバージョンを取得する。
        /// @return 現在稼働中アプリのバージョン。
        ///
        /// アプリイメージがインストールされていない場合はゼロ値を返す。
        /// 量産シーケンスではありえないが、開発シーケンスではありうる。
        Version getCurrentVersion() const;

        /// @brief 現在稼働中アプリのイメージ作成日時を取得する。
        /// @return 現在稼働中アプリのイメージ作成日時。
        ///
        /// アプリイメージがインストールされていない場合は util::DateTime::min() を返す。
        /// 量産シーケンスではありえないが、開発シーケンスではありうる。
        const ::amdaemon::util::DateTime& getCreationTime() const;

        /// @brief 公開済みオプションイメージ数を取得する。
        /// @return 公開済みオプションイメージ数。
        std::size_t getOptionCount() const;

        /// @brief 公開済みオプションイメージ情報を取得する。
        /// @param[in] index オプションイメージのインデックス。
        /// @return 公開済みオプションイメージ情報。
        ///
        /// @exception Exception
        /// 引数 index に公開済みオプションイメージ数以上の値を指定した場合。
        /// 公開済みオプションイメージ数はメンバ関数 #getOptionCount で取得できる。
        const OptionImageInfo& getOptionInfo(std::size_t index) const;

        /// @brief 公開済みオプションイメージ情報を識別名から検索する。
        /// @param[in] optionName オプションイメージ識別名。
        /// @return 公開済みオプションイメージ情報。存在しない場合は nullptr 。
        const OptionImageInfo* findOptionInfo(const wchar_t* optionName) const;

        /// @brief 指定した識別名の公開済みオプションイメージが存在するか否かを取得する。
        /// @param[in] optionName オプションイメージ識別名。
        /// @retval true  存在する場合。
        /// @retval false 存在しない場合。
        bool existsOption(const wchar_t* optionName) const
        {
            return (findOptionInfo(optionName) != nullptr);
        }

        /// @brief オプションイメージのマウント先ルートディレクトリパスを取得する。
        /// @return オプションイメージのマウント先ルートディレクトリパス。
        ///
        /// - 通常は固定値 "C:¥¥mount¥¥Option¥¥" を返す。
        /// - エミュレータ環境では任意の設定値を返す。
        ///   ただし設定値が空文字列の場合は ".¥¥" を返す。
        const wchar_t* getOptionMountRootPath() const;

        /// @brief オプションイメージのマウント先ディレクトリパスを作成する。
        /// @param[in] optionName オプションイメージ識別名。
        /// @return オプションイメージのマウント先ディレクトリパス。
        ///
        /// オプションイメージ識別名の正当性はチェックされない。
        std::wstring makeOptionMountPath(const std::wstring& optionName) const;
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_APPIMAGE_H