ipv4-network.hpp

Go to the documentation of this file.

/**
 * @file      ipv4-network.hpp
 * @brief     Provides a set of functions and classes for handling IPv4 networks
 * @author    Vladimir Shaleev
 * @copyright MIT License
 * 
 * This header file defines the ipv4_network_base class and ipv4_network type, which are
 * part of a library for working with IPv4 network addresses. The ipv4_network_base class
 * is derived from the base_v4 class and includes methods for manipulating network addresses.
 * The ipv4_network is a typedef for the ip_network_base class specialized for IPv4, 
 * providing a convenient alias for users of the library.
 */
 
#ifndef IPADDRESS_IPV4_NETWORK_HPP
#define IPADDRESS_IPV4_NETWORK_HPP
 
#include "ipv4-address.hpp"
#include "ip-network-base.hpp"
 
namespace IPADDRESS_NAMESPACE {
 
/**
 * Base class for IPv4 network address manipulation.
 * 
 * The ipv4_network_base class provides foundational functionality for IPv4 network
 * address manipulation by extending the base_v4 class.
 */
IPADDRESS_EXPORT class ipv4_network_base : public base_v4<ipv4_network_base> {
public:
    using ip_address_type = ipv4_address; /**< Alias for the IPv4 address type used within the class. */
 
protected:
    IPADDRESS_NODISCARD static IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE ip_address_type remove_scope_id(const ip_address_type& address) IPADDRESS_NOEXCEPT {
        return address;
    }
 
    IPADDRESS_NODISCARD static IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE ip_network_base<ipv4_network_base> remove_scope_id(const ip_network_base<ipv4_network_base>& network) IPADDRESS_NOEXCEPT {
        return network;
    }
}; // ipv4_network_base
 
/**
 * Alias for the specialized ip_network_base class for IPv4.
 * 
 * The ipv4_network is a convenient alias for the ip_network_base class
 * specialized with ipv4_network_base. It allows users to work with IPv4
 * network addresses using a type that is specifically designed for IPv4,
 * simplifying the interface and usage in code that deals with IPv4 networks.
 */
IPADDRESS_EXPORT using ipv4_network = ip_network_base<ipv4_network_base>;
 
#ifdef IPADDRESS_NONTYPE_TEMPLATE_PARAMETER
 
    /**
     * User-defined literal operator for creating an ipv4_network object from a string literal.
     * 
     * This operator allows the creation of ipv4_network objects using a string literal with the
     * `_ipv4_net` suffix.
     * 
     * @tparam FixedString A string literal representing the IPv4 network.
     * @return An ipv4_network object representing the network specified by the string literal.
     */
    IPADDRESS_EXPORT template <fixed_string FixedString>
    IPADDRESS_NODISCARD IPADDRESS_CONSTEVAL IPADDRESS_FORCE_INLINE ipv4_network operator""_ipv4_net() IPADDRESS_NOEXCEPT {
        return ipv4_network::parse<FixedString>();
    }
 
#else // IPADDRESS_NONTYPE_TEMPLATE_PARAMETER
 
    /**
     * User-defined literal operator for creating an ipv4_network object from a string literal.
     * 
     * This operator allows the creation of ipv4_network objects using a string literal with the
     * `_ipv4_net` suffix.
     * 
     * @param[in] address The string literal representing the IPv4 network.
     * @param[in] size The size of the string literal.
     * @return An ipv4_network object representing the network specified by the string literal.
     */
    IPADDRESS_EXPORT IPADDRESS_NODISCARD_WHEN_NO_EXCEPTIONS IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE ipv4_network operator""_ipv4_net(const char* address, size_t size) IPADDRESS_NOEXCEPT_WHEN_NO_EXCEPTIONS {
        return internal::parse_net_from_literal<ipv4_network_base, char, ipv4_network::base_max_string_len * 2 + 1>(address, size);
    }
 
    /**
     * User-defined literal operator for creating an ipv4_network object from a wide string literal.
     * 
     * This operator allows the creation of ipv4_network objects using a string literal with the
     * `_ipv4_net` suffix.
     * 
     * @param[in] address The string literal representing the IPv4 network.
     * @param[in] size The size of the string literal.
     * @return An ipv4_network object representing the network specified by the string literal.
     */
    IPADDRESS_EXPORT IPADDRESS_NODISCARD_WHEN_NO_EXCEPTIONS IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE ipv4_network operator""_ipv4_net(const wchar_t* address, size_t size) IPADDRESS_NOEXCEPT_WHEN_NO_EXCEPTIONS {
        return internal::parse_net_from_literal<ipv4_network_base, wchar_t, ipv4_network::base_max_string_len * 2 + 1>(address, size);
    }
 
    /**
     * User-defined literal operator for creating an ipv4_network object from UTF-16 string literal.
     * 
     * This operator allows the creation of ipv4_network objects using a string literal with the
     * `_ipv4_net` suffix.
     * 
     * @param[in] address The string literal representing the IPv4 network.
     * @param[in] size The size of the string literal.
     * @return An ipv4_network object representing the network specified by the string literal.
     */
    IPADDRESS_EXPORT IPADDRESS_NODISCARD_WHEN_NO_EXCEPTIONS IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE ipv4_network operator""_ipv4_net(const char16_t* address, size_t size) IPADDRESS_NOEXCEPT_WHEN_NO_EXCEPTIONS {
        return internal::parse_net_from_literal<ipv4_network_base, char16_t, ipv4_network::base_max_string_len * 2 + 1>(address, size);
    }
 
    /**
     * User-defined literal operator for creating an ipv4_network object from UTF-32 string literal.
     * 
     * This operator allows the creation of ipv4_network objects using a string literal with the
     * `_ipv4_net` suffix.
     * 
     * @param[in] address The string literal representing the IPv4 network.
     * @param[in] size The size of the string literal.
     * @return An ipv4_network object representing the network specified by the string literal.
     */
    IPADDRESS_EXPORT IPADDRESS_NODISCARD_WHEN_NO_EXCEPTIONS IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE ipv4_network operator""_ipv4_net(const char32_t* address, size_t size) IPADDRESS_NOEXCEPT_WHEN_NO_EXCEPTIONS {
        return internal::parse_net_from_literal<ipv4_network_base, char32_t, ipv4_network::base_max_string_len * 2 + 1>(address, size);
    }
 
#endif // IPADDRESS_NONTYPE_TEMPLATE_PARAMETER
 
} // namespace IPADDRESS_NAMESPACE
 
#endif // IPADDRESS_IPV4_NETWORK_HPP