BackupRecord.h

[詳解]

/// @file
/// @brief 不揮発データバックアップレコード情報構造体 BackupRecord のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_BACKUPRECORD_H
#define AMDAEMON_BACKUPRECORD_H

#include "amdaemon/env.h"
#include "amdaemon/BackupDevice.h"
#include "amdaemon/util/traits.h"

#include <type_traits>
#include <cstddef>

namespace amdaemon
{
/// @addtogroup g_backup
/// @{

    /// @brief 不揮発データバックアップレコード情報構造体。
    /// @see Backup
    ///
    /// 不揮発メモリにバックアップするデータ単体の情報を保持する。
    struct BackupRecord
    {
        void* address;          ///< データアドレス。このアドレスに対して読み書きを行う。
        std::size_t size;       ///< データサイズ。
        BackupDevice device;    ///< バックアップ先デバイス。

        /// @brief バックアップレコード情報を作成する。
        /// @param[in] address データアドレス。
        /// @param[in] size データサイズ。
        /// @param[in] device バックアップ先デバイス。
        /// @return バックアップレコード情報。
        static BackupRecord make(void* address, std::size_t size, BackupDevice device)
        {
            BackupRecord record = { address, size, device };
            return record;
        }

        /// @brief データ参照からバックアップレコード情報を作成する。
        /// @tparam Data データ型。後述の要件を満たす型でなければならない。
        /// @param[in] data データ参照。
        /// @param[in] device バックアップ先デバイス。
        /// @return バックアップレコード情報。
        ///
        /// データサイズは sizeof(data) となる。
        ///
        /// 型 Data は下記の要件をすべて満たす必要がある。
        ///
        /// - const 修飾されていない。
        /// - オブジェクト型(スカラ型、配列、クラス＆構造体、共用体のいずれか)である。
        /// - トリビアルコピー可能な型である。
        /// - ポインタ型ではない。
        /// - std::nullptr_t 型ではない。
        ///
        /// 要するに、安全に std::memcpy によるコピーが可能な型である必要がある。
        /// 1つでも満たしていない場合はコンパイルエラーとなる。
        template<class Data>
        static auto make(Data& data, BackupDevice device)
            ->
            typename std::enable_if<
                !std::is_const<Data>::value &&
                ::amdaemon::util::IsBinaryCopyable<Data>::value,
                BackupRecord>::type
        {
            return make(&data, sizeof(data), device);
        }
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_BACKUPRECORD_H