SerialId.h

[詳解]

/// @file
/// @brief シリアルID構造体 SerialId のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_SERIALID_H
#define AMDAEMON_SERIALID_H

#include "amdaemon/env.h"

#include <cstddef>

namespace amdaemon
{
/// @addtogroup g_system
/// @{

    //--------------------
    // StandardSerialId 構造体定義
    //--------------------

    /// @brief 標準シリアルID構造体。
    /// @note memcpy 可能。
    /// @internal ライブラリ実装メモ: この型を直接共有メモリに配置する。
    struct StandardSerialId
    {
        /// 標準シリアルID文字列長。
        static const std::size_t Length = 16;

        wchar_t value[Length + 1];  ///< 標準シリアルID文字列。

        /// @brief インスタンスを作成する。
        /// @param[in] value 標準シリアルID文字列。
        /// @return 作成したインスタンス。
        ///
        /// @exception Exception
        /// 引数 value に nullptr を渡した場合。
        static StandardSerialId make(const wchar_t* value);

        /// @brief 標準シリアルID文字列が空であるか否かを取得する。
        /// @retval true  標準シリアルID文字列が空である場合。
        /// @retval false 標準シリアルID文字列が空ではない場合。
        bool empty() const
        {
            return (value[0] == L'¥0');
        }
    };

    //--------------------
    // ShortSerialId 構造体定義
    //--------------------

    /// @brief 短縮シリアルID構造体。
    /// @note memcpy 可能。
    /// @internal ライブラリ実装メモ: この型を直接共有メモリに配置する。
    struct ShortSerialId
    {
        /// 短縮シリアルID文字列長。
        static const std::size_t Length = 11;

        wchar_t value[Length + 1];  ///< 短縮シリアルID文字列。

        /// @brief インスタンスを作成する。
        /// @param[in] value 短縮シリアルID文字列。
        /// @return 作成したインスタンス。
        ///
        /// @exception Exception
        /// 引数 value に nullptr を渡した場合。
        static ShortSerialId make(const wchar_t* value);

        /// @brief 短縮シリアルID文字列が空であるか否かを取得する。
        /// @retval true  短縮シリアルID文字列が空である場合。
        /// @retval false 短縮シリアルID文字列が空ではない場合。
        bool empty() const
        {
            return (value[0] == L'¥0');
        }
    };

    //--------------------
    // SerialId 構造体定義
    //--------------------

    /// @brief シリアルID構造体。
    /// @note memcpy 可能。
    /// @internal ライブラリ実装メモ: この型を直接共有メモリに配置する。
    struct SerialId
    {
        StandardSerialId id;    ///< 標準シリアルID。
        ShortSerialId shortId;  ///< 短縮シリアルID。

        /// @brief インスタンスを作成する。
        /// @param[in] value 標準シリアルID文字列。
        /// @param[in] shortValue 短縮シリアルID文字列。
        /// @return 作成したインスタンス。
        ///
        /// @exception Exception
        /// 引数 value または shortValue に nullptr を渡した場合。
        static SerialId make(const wchar_t* value, const wchar_t* shortValue)
        {
            SerialId result =
                { StandardSerialId::make(value), ShortSerialId::make(shortValue) };
            return result;
        }

        /// @brief シリアルID文字列がすべて空であるか否かを取得する。
        /// @retval true  シリアルID文字列がすべて空である場合。
        /// @retval false いずれかのシリアルID文字列が空ではない場合。
        bool empty() const
        {
            return (id.empty() && shortId.empty());
        }

        /// @brief シリアルID文字列を取得する。
        /// @param[in] useShort 短縮シリアルIDを使うならば true 。
        /// @return シリアルID文字列。
        const wchar_t* toString(bool useShort = false) const
        {
            return useShort ? shortId.value : id.value;
        }
    };

/// @}

    //--------------------
    // 関数定義
    //--------------------

    /// @brief 等価比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso StandardSerialId
    bool operator==(const StandardSerialId& l, const StandardSerialId& r);

    /// @brief 非等価比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso StandardSerialId
    inline bool operator!=(const StandardSerialId& l, const StandardSerialId& r)
    {
        return !(l == r);
    }

    /// @brief 等価比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso ShortSerialId
    bool operator==(const ShortSerialId& l, const ShortSerialId& r);

    /// @brief 非等価比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso ShortSerialId
    inline bool operator!=(const ShortSerialId& l, const ShortSerialId& r)
    {
        return !(l == r);
    }

    /// @brief 等価比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso SerialId
    inline bool operator==(const SerialId& l, const SerialId& r)
    {
        return (l.id == r.id && l.shortId == r.shortId);
    }

    /// @brief 非等価比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso SerialId
    inline bool operator!=(const SerialId& l, const SerialId& r)
    {
        return !(l == r);
    }
} // namespace amdaemon

#endif // AMDAEMON_SERIALID_H