ladybird/AK/IPv4Address.h
Shannon Booth e2e7c4d574 Everywhere: Use to_number<T> instead of to_{int,uint,float,double}
In a bunch of cases, this actually ends up simplifying the code as
to_number will handle something such as:

```
Optional<I> opt;
if constexpr (IsSigned<I>)
    opt = view.to_int<I>();
else
    opt = view.to_uint<I>();
```

For us.

The main goal here however is to have a single generic number conversion
API between all of the String classes.
2023-12-23 20:41:07 +01:00

192 lines
4.9 KiB
C++

/*
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/Endian.h>
#include <AK/Format.h>
#include <AK/Optional.h>
#include <AK/SipHash.h>
#include <AK/StringView.h>
#include <AK/Vector.h>
#ifdef KERNEL
# include <AK/Error.h>
# include <Kernel/Library/KString.h>
#else
# include <AK/ByteString.h>
# include <AK/String.h>
#endif
namespace AK {
class [[gnu::packed]] IPv4Address {
enum class SubnetClass : int {
A = 0,
B,
C,
D
};
public:
using in_addr_t = u32;
constexpr IPv4Address() = default;
constexpr IPv4Address(u32 a, u32 b, u32 c, u32 d)
{
m_data = (d << 24) | (c << 16) | (b << 8) | a;
}
constexpr IPv4Address(const u8 data[4])
{
m_data = (u32(data[3]) << 24) | (u32(data[2]) << 16) | (u32(data[1]) << 8) | u32(data[0]);
}
constexpr IPv4Address(NetworkOrdered<u32> address)
: m_data(address)
{
}
constexpr u8 operator[](int i) const
{
VERIFY(i >= 0 && i < 4);
return octet(SubnetClass(i));
}
#ifdef KERNEL
ErrorOr<NonnullOwnPtr<Kernel::KString>> to_string() const
{
return Kernel::KString::formatted("{}.{}.{}.{}",
octet(SubnetClass::A),
octet(SubnetClass::B),
octet(SubnetClass::C),
octet(SubnetClass::D));
}
#else
ByteString to_byte_string() const
{
return ByteString::formatted("{}.{}.{}.{}",
octet(SubnetClass::A),
octet(SubnetClass::B),
octet(SubnetClass::C),
octet(SubnetClass::D));
}
ByteString to_byte_string_reversed() const
{
return ByteString::formatted("{}.{}.{}.{}",
octet(SubnetClass::D),
octet(SubnetClass::C),
octet(SubnetClass::B),
octet(SubnetClass::A));
}
ErrorOr<String> to_string() const
{
return String::formatted("{}.{}.{}.{}",
octet(SubnetClass::A),
octet(SubnetClass::B),
octet(SubnetClass::C),
octet(SubnetClass::D));
}
#endif
static Optional<IPv4Address> from_string(StringView string)
{
if (string.is_null())
return {};
auto const parts = string.split_view('.');
u32 a {};
u32 b {};
u32 c {};
u32 d {};
if (parts.size() == 1) {
d = parts[0].to_number<u32>().value_or(256);
} else if (parts.size() == 2) {
a = parts[0].to_number<u32>().value_or(256);
d = parts[1].to_number<u32>().value_or(256);
} else if (parts.size() == 3) {
a = parts[0].to_number<u32>().value_or(256);
b = parts[1].to_number<u32>().value_or(256);
d = parts[2].to_number<u32>().value_or(256);
} else if (parts.size() == 4) {
a = parts[0].to_number<u32>().value_or(256);
b = parts[1].to_number<u32>().value_or(256);
c = parts[2].to_number<u32>().value_or(256);
d = parts[3].to_number<u32>().value_or(256);
} else {
return {};
}
if (a > 255 || b > 255 || c > 255 || d > 255)
return {};
return IPv4Address(a, b, c, d);
}
static constexpr IPv4Address netmask_from_cidr(int cidr)
{
VERIFY(cidr >= 0 && cidr <= 32);
u32 value = 0xffffffffull << (32 - cidr);
return IPv4Address((value & 0xff000000) >> 24, (value & 0xff0000) >> 16, (value & 0xff00) >> 8, (value & 0xff));
}
constexpr in_addr_t to_in_addr_t() const { return m_data; }
constexpr u32 to_u32() const { return m_data; }
constexpr bool operator==(IPv4Address const& other) const = default;
constexpr bool operator!=(IPv4Address const& other) const = default;
constexpr bool is_zero() const
{
return m_data == 0u;
}
private:
constexpr u32 octet(const SubnetClass subnet) const
{
constexpr auto bits_per_byte = 8;
auto const bits_to_shift = bits_per_byte * int(subnet);
return (m_data >> bits_to_shift) & 0x0000'00FF;
}
u32 m_data {};
};
static_assert(sizeof(IPv4Address) == 4);
template<>
struct Traits<IPv4Address> : public DefaultTraits<IPv4Address> {
static unsigned hash(IPv4Address const& address) { return secure_sip_hash(static_cast<u64>(address.to_u32())); }
};
#ifdef KERNEL
template<>
struct Formatter<IPv4Address> : Formatter<StringView> {
ErrorOr<void> format(FormatBuilder& builder, IPv4Address value)
{
return Formatter<StringView>::format(builder, TRY(value.to_string())->view());
}
};
#else
template<>
struct Formatter<IPv4Address> : Formatter<StringView> {
ErrorOr<void> format(FormatBuilder& builder, IPv4Address value)
{
return Formatter<StringView>::format(builder, value.to_byte_string());
}
};
#endif
}
#if USING_AK_GLOBALLY
using AK::IPv4Address;
#endif