IpAddress.h

[詳解]

/// @file
/// @brief IPv4のIPアドレスを表す構造体 IpAddress のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_UTIL_IPADDRESS_H
#define AMDAEMON_UTIL_IPADDRESS_H

#include "amdaemon/env.h"

#include <string>
#include <cstdint>
#include <cstddef>

namespace amdaemon
{
namespace util
{
/// @addtogroup g_util
/// @{

    //--------------------
    // IpAddress 構造体定義
    //--------------------

    /// @brief IPv4のIPアドレスを表す構造体。
    /// @note memcpy 可能。
    /// @ingroup g_network
    struct IpAddress
    {
        /// 内部値の表現型。
        typedef std::uint32_t value_type;

        /// ネットワークバイトオーダーのIPアドレス直値。
        value_type value;

        /// @brief "0.0.0.0" のIPアドレス値を作成する。
        /// @return "0.0.0.0" のIPアドレス値。
        static IpAddress zero()
        {
            IpAddress result = { 0 };
            return result;
        }

        /// @brief ホストバイトオーダーのIPアドレス直値からIPアドレス値を作成する。
        /// @param[in] hostValue ホストバイトオーダーのIPアドレス直値。
        /// @return 作成されたIPアドレス値。
        static IpAddress make(value_type hostValue);

        /// @brief IPアドレス値を作成可能な各オクテット値であるか否かを調べる。
        /// @param[in] octet1 第1オクテット値。 0 以上 255 以下。
        /// @param[in] octet2 第2オクテット値。 0 以上 255 以下。
        /// @param[in] octet3 第3オクテット値。 0 以上 255 以下。
        /// @param[in] octet4 第4オクテット値。 0 以上 255 以下。
        /// @retval true  作成可能である場合。
        /// @retval false 作成不可能である場合。
        /// @see make(value_type, value_type, value_type, value_type)
        ///
        /// この関数が true を返す場合、同じ引数を静的メンバ関数
        /// make(value_type, value_type, value_type, value_type) に渡すことで、
        /// 例外を発生させることなくIPアドレス値を作成可能であることが保証される。
        static bool canMake(
            value_type octet1,
            value_type octet2,
            value_type octet3,
            value_type octet4);

        /// @brief 各オクテット値からIPアドレス値を作成する。
        /// @param[in] octet1 第1オクテット値。 0 以上 255 以下。
        /// @param[in] octet2 第2オクテット値。 0 以上 255 以下。
        /// @param[in] octet3 第3オクテット値。 0 以上 255 以下。
        /// @param[in] octet4 第4オクテット値。 0 以上 255 以下。
        /// @return 作成されたIPアドレス値。
        /// @see canMake(value_type, value_type, value_type, value_type)
        ///
        /// @exception Exception
        /// いずれかの引数に 255 よりも大きい値を指定した場合。
        static IpAddress make(
            value_type octet1,
            value_type octet2,
            value_type octet3,
            value_type octet4);

        /// @brief IPアドレス値を作成可能なIPアドレス文字列であるか否かを調べる。
        /// @param[in] address IPアドレス文字列。 "192.168.0.1" 等。
        /// @retval true  作成可能である場合。
        /// @retval false 作成不可能である場合。
        /// @see make(const wchar_t*)
        ///
        /// この関数が true を返す場合、同じ引数を静的メンバ関数
        /// make(const wchar_t*) に渡すことで、
        /// 例外を発生させることなくIPアドレス値を作成可能であることが保証される。
        static bool canMake(const wchar_t* address);

        /// @brief IPアドレス文字列からIPアドレス値を作成する。
        /// @param[in] address IPアドレス文字列。 "192.168.0.1" 等。
        /// @return 作成されたIPアドレス値。
        /// @see canMake(const wchar_t*)
        ///
        /// @exception Exception
        /// - 引数 address に nullptr を指定した場合。
        /// - 引数 address をIPアドレス値に変換できなかった場合。
        static IpAddress make(const wchar_t* address);

        /// @brief ホストバイトオーダーのIPアドレス直値を取得する。
        /// @return ホストバイトオーダーのIPアドレス直値。
        value_type getHostValue() const;

        /// @brief オクテット値を取得する。
        /// @param[in] index オクテットインデックス。 0 以上 3 以下。
        /// @return オクテット値。
        ///
        /// @exception Exception
        /// 引数 index に 4 以上の値を指定した場合。
        value_type getOctet(std::size_t index) const;

        /// @brief 文字列表現値を作成する。
        /// @return 文字列表現値。
        std::wstring toString() const;

        /// @brief ビット積代入演算子のオーバロード。
        /// @param[in] r 右辺値。
        /// @return 自身の参照。
        IpAddress& operator&=(const IpAddress& r)
        {
            this->value &= r.value;
            return *this;
        }

        /// @brief ビット和代入演算子のオーバロード。
        /// @param[in] r 右辺値。
        /// @return 自身の参照。
        IpAddress& operator|=(const IpAddress& r)
        {
            this->value |= r.value;
            return *this;
        }
    };

/// @}

    //--------------------
    // インライン関数定義
    //--------------------

    /// @brief ビット反転演算子のオーバロード。
    /// @param[in] r 右辺値。
    /// @return 演算結果値。
    /// @relatesalso IpAddress
    inline IpAddress operator‾(const IpAddress& r)
    {
        IpAddress result = { ‾r.value };
        return result;
    }

    /// @brief ビット積演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 演算結果値。
    /// @relatesalso IpAddress
    inline IpAddress operator&(const IpAddress& l, const IpAddress& r)
    {
        IpAddress result = { l.value & r.value };
        return result;
    }

    /// @brief ビット和演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 演算結果値。
    /// @relatesalso IpAddress
    inline IpAddress operator|(const IpAddress& l, const IpAddress& r)
    {
        IpAddress result = { l.value | r.value };
        return result;
    }

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

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

    /// @brief 小なり比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso IpAddress
    ///
    /// ホストバイトオーダーでの大小を比較する。
    inline bool operator<(const IpAddress& l, const IpAddress& r)
    {
        return (l.getHostValue() < r.getHostValue());
    }

    /// @brief 大なり比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso IpAddress
    ///
    /// ホストバイトオーダーでの大小を比較する。
    inline bool operator>(const IpAddress& l, const IpAddress& r)
    {
        return (r < l);
    }

    /// @brief 小なり等価比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso IpAddress
    ///
    /// ホストバイトオーダーでの大小を比較する。
    inline bool operator<=(const IpAddress& l, const IpAddress& r)
    {
        return !(r < l);
    }

    /// @brief 大なり等価比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso IpAddress
    ///
    /// ホストバイトオーダーでの大小を比較する。
    inline bool operator>=(const IpAddress& l, const IpAddress& r)
    {
        return !(l < r);
    }
} // namespace util
} // namespace amdaemon

#endif // AMDAEMON_UTIL_IPADDRESS_H