InputOutputId.h

[詳解]

/// @file
/// @brief 抽象入出力の識別ID構造体テンプレート InputOutputId のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_INPUTOUTPUTID_H
#define AMDAEMON_INPUTOUTPUTID_H

#include "amdaemon/env.h"

#include <string>
#include <cstddef>
#include <cwchar>

namespace amdaemon
{
    namespace detail
    {
        /// InputOutputId 構造体内部値の最大サイズ。
        static const std::size_t InputOutputIdValueSize = 23 + 1;

        /// @brief InputOutputId 構造体の内部値を設定する。
        /// @param[in] src 設定元の値。
        /// @param[in] dest 設定先の値。
        /// @note アプリ側で直接利用することはない。
        void makeInputOutputIdValue(
            const wchar_t* src,
            wchar_t (&dest)[InputOutputIdValueSize]);
    } // namespace detail

    /// @brief 抽象入出力の識別ID構造体テンプレート。
    /// @tparam Tag 入力と出力を区別するためのタグ型。
    /// @see InputId, OutputId
    /// @note memcpy 可能。
    ///
    /// アプリではこのクラス型から typedef 定義した InputId 型および OutputId 型を用いる。
    ///
    /// @internal ライブラリ実装メモ: この型を直接共有メモリに配置する。
    template<class Tag>
    struct InputOutputId
    {
        /// 内部値の最大文字数。終端文字を含む。
        static const std::size_t MaxSize = ::amdaemon::detail::InputOutputIdValueSize;

        wchar_t value[MaxSize]; ///< 内部値。

        /// @brief 識別IDインスタンスを作成する。
        /// @param[in] value 識別IDの基となる文字列。
        /// @return 識別IDインスタンス。
        ///
        /// @exception Exception
        /// - 引数 value に nullptr を指定した場合。
        /// - 引数 value の文字列長が MaxSize 以上である場合。
        static InputOutputId make(const wchar_t* value)
        {
            InputOutputId id = { };
            ::amdaemon::detail::makeInputOutputIdValue(value, id.value);
            return id;
        }

        /// @brief 識別IDインスタンスを作成する。
        /// @tparam Traits 文字列型の traits_type 。引数から推論される。
        /// @tparam Allocator 文字列型の allocator_type 。引数から推論される。
        /// @param[in] value 識別IDの基となる文字列。
        /// @return 識別IDインスタンス。
        ///
        /// @exception Exception
        /// 引数 value の文字列長が MaxSize 以上である場合。
        template<class Traits, class Allocator>
        static InputOutputId make(
            const std::basic_string<wchar_t, Traits, Allocator>& value)
        {
            InputOutputId id = { };
            ::amdaemon::detail::makeInputOutputIdValue(value.c_str(), id.value);
            return id;
        }

        /// @brief 識別IDが空であるか否かを取得する。
        /// @retval true  空である場合。
        /// @retval false 空ではない場合。
        bool empty() const
        {
            return (value[0] == L'¥0');
        }

        /// 等価比較演算子のオーバロード。
        friend bool operator==(const InputOutputId& l, const InputOutputId& r)
        {
            return (std::wcsncmp(l.value, r.value, MaxSize) == 0);
        }

        /// 非等価比較演算子のオーバロード。
        friend bool operator!=(const InputOutputId& l, const InputOutputId& r)
        {
            return !(l == r);
        }

        /// 小なり比較演算子のオーバロード。
        friend bool operator<(const InputOutputId& l, const InputOutputId& r)
        {
            return (std::wcsncmp(l.value, r.value, MaxSize) < 0);
        }

        /// 大なり比較演算子のオーバロード。
        friend bool operator>(const InputOutputId& l, const InputOutputId& r)
        {
            return (r < l);
        }

        /// 小なり等価比較演算子のオーバロード。
        friend bool operator<=(const InputOutputId& l, const InputOutputId& r)
        {
            return !(r < l);
        }

        /// 大なり等価比較演算子のオーバロード。
        friend bool operator>=(const InputOutputId& l, const InputOutputId& r)
        {
            return !(l < r);
        }
    };
}

namespace std
{
    // 前方宣言
    template<class T> struct hash;

    /// @brief ハッシュ値を求めるファンクタ構造体。
    /// @tparam Tag 入力と出力を区別するためのタグ型。
    ///
    /// std::hash クラステンプレートの
    /// amdaemon::InputOutputId クラステンプレートに対する部分特殊化。
    template<class Tag>
    struct hash< ::amdaemon::InputOutputId<Tag> >
    {
        /// 戻り値の型。
        typedef hash<wstring>::result_type result_type;

        /// 引数の型。
        typedef ::amdaemon::InputOutputId<Tag> argument_type;

        /// @brief 引数のハッシュ値を取得する。
        /// @param[in] id 引数。
        /// @return ハッシュ値。
        result_type operator()(const argument_type& id) const
        {
            return hash<wstring>()(id.value);
        }
    };
} // namespace std

#endif // AMDAEMON_INPUTOUTPUTID_H