ladybird/AK/JsonObject.cpp
Sam Atkins 8d3b268cca AK: Add JsonObject::get...() methods that return Optional
`get()` is intended as a replacement for `get_deprecated()` and `get_ptr
()`. The former returns the same value for "key not found" and "key
found and contains `null`" which is ambiguous. The latter returns a raw
pointer which is spooky. Returning `Optional<JsonValue const&>` covers
all the previous uses for these.

The `get_foo()` methods are helpers to make user code less verbose. Most
of the time, we only want a specific type of value: if we want a number
and get a string, we respond the same as if the value was not there at
all. These make that easier to express.

This also adjusts the `has_i32()` method and friends to examine the
value instead of just looking at the underlying type.
2023-01-17 19:52:52 -05:00

288 lines
6.1 KiB
C++

/*
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
* Copyright (c) 2021, Max Wipfli <mail@maxwipfli.ch>
* Copyright (c) 2023, Sam Atkins <atkinssj@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include "JsonObject.h"
namespace AK {
JsonObject::JsonObject() = default;
JsonObject::~JsonObject() = default;
JsonObject::JsonObject(JsonObject const& other)
: m_members(other.m_members)
{
}
JsonObject::JsonObject(JsonObject&& other)
: m_members(move(other.m_members))
{
}
JsonObject& JsonObject::operator=(JsonObject const& other)
{
if (this != &other)
m_members = other.m_members;
return *this;
}
JsonObject& JsonObject::operator=(JsonObject&& other)
{
if (this != &other)
m_members = move(other.m_members);
return *this;
}
size_t JsonObject::size() const
{
return m_members.size();
}
bool JsonObject::is_empty() const
{
return m_members.is_empty();
}
JsonValue const& JsonObject::get_deprecated(StringView key) const
{
auto const* value = get_ptr(key);
static JsonValue* s_null_value { nullptr };
if (!value) {
if (!s_null_value)
s_null_value = new JsonValue;
return *s_null_value;
}
return *value;
}
JsonValue const* JsonObject::get_ptr(StringView key) const
{
auto it = m_members.find(key);
if (it == m_members.end())
return nullptr;
return &(*it).value;
}
Optional<JsonValue const&> JsonObject::get(StringView key) const
{
auto it = m_members.find(key);
if (it == m_members.end())
return {};
return it->value;
}
Optional<i8> JsonObject::get_i8(StringView key) const
{
return get_integer<i8>(key);
}
Optional<u8> JsonObject::get_u8(StringView key) const
{
return get_integer<u8>(key);
}
Optional<i16> JsonObject::get_i16(StringView key) const
{
return get_integer<i16>(key);
}
Optional<u16> JsonObject::get_u16(StringView key) const
{
return get_integer<u16>(key);
}
Optional<i32> JsonObject::get_i32(StringView key) const
{
return get_integer<i32>(key);
}
Optional<u32> JsonObject::get_u32(StringView key) const
{
return get_integer<u32>(key);
}
Optional<i64> JsonObject::get_i64(StringView key) const
{
return get_integer<i64>(key);
}
Optional<u64> JsonObject::get_u64(StringView key) const
{
return get_integer<u64>(key);
}
Optional<FlatPtr> JsonObject::get_addr(StringView key) const
{
return get_integer<FlatPtr>(key);
}
Optional<bool> JsonObject::get_bool(StringView key) const
{
auto maybe_value = get(key);
if (maybe_value.has_value() && maybe_value->is_bool())
return maybe_value->as_bool();
return {};
}
#if !defined(KERNEL)
Optional<DeprecatedString> JsonObject::get_deprecated_string(StringView key) const
{
auto maybe_value = get(key);
if (maybe_value.has_value() && maybe_value->is_string())
return maybe_value->as_string();
return {};
}
#endif
Optional<JsonObject const&> JsonObject::get_object(StringView key) const
{
auto maybe_value = get(key);
if (maybe_value.has_value() && maybe_value->is_object())
return maybe_value->as_object();
return {};
}
Optional<JsonArray const&> JsonObject::get_array(StringView key) const
{
auto maybe_value = get(key);
if (maybe_value.has_value() && maybe_value->is_array())
return maybe_value->as_array();
return {};
}
#if !defined(KERNEL)
Optional<double> JsonObject::get_double(StringView key) const
{
auto maybe_value = get(key);
if (maybe_value.has_value() && maybe_value->is_double())
return maybe_value->as_double();
return {};
}
Optional<float> JsonObject::get_float(StringView key) const
{
auto maybe_value = get(key);
if (maybe_value.has_value() && maybe_value->is_double())
return static_cast<float>(maybe_value->as_double());
return {};
}
#endif
bool JsonObject::has(StringView key) const
{
return m_members.contains(key);
}
bool JsonObject::has_null(StringView key) const
{
auto value = get(key);
return value.has_value() && value->is_null();
}
bool JsonObject::has_bool(StringView key) const
{
auto value = get(key);
return value.has_value() && value->is_bool();
}
bool JsonObject::has_string(StringView key) const
{
auto value = get(key);
return value.has_value() && value->is_string();
}
bool JsonObject::has_i8(StringView key) const
{
auto value = get(key);
return value.has_value() && value->is_integer<i8>();
}
bool JsonObject::has_u8(StringView key) const
{
auto value = get(key);
return value.has_value() && value->is_integer<u8>();
}
bool JsonObject::has_i16(StringView key) const
{
auto value = get(key);
return value.has_value() && value->is_integer<i16>();
}
bool JsonObject::has_u16(StringView key) const
{
auto value = get(key);
return value.has_value() && value->is_integer<u16>();
}
bool JsonObject::has_i32(StringView key) const
{
auto value = get(key);
return value.has_value() && value->is_integer<i32>();
}
bool JsonObject::has_u32(StringView key) const
{
auto value = get(key);
return value.has_value() && value->is_integer<u32>();
}
bool JsonObject::has_i64(StringView key) const
{
auto value = get(key);
return value.has_value() && value->is_integer<i64>();
}
bool JsonObject::has_u64(StringView key) const
{
auto value = get(key);
return value.has_value() && value->is_integer<u64>();
}
bool JsonObject::has_number(StringView key) const
{
auto value = get(key);
return value.has_value() && value->is_number();
}
bool JsonObject::has_array(StringView key) const
{
auto value = get(key);
return value.has_value() && value->is_array();
}
bool JsonObject::has_object(StringView key) const
{
auto value = get(key);
return value.has_value() && value->is_object();
}
#ifndef KERNEL
bool JsonObject::has_double(StringView key) const
{
auto value = get(key);
return value.has_value() && value->is_double();
}
#endif
void JsonObject::set(DeprecatedString const& key, JsonValue value)
{
m_members.set(key, move(value));
}
bool JsonObject::remove(StringView key)
{
return m_members.remove(key);
}
DeprecatedString JsonObject::to_deprecated_string() const
{
return serialized<StringBuilder>();
}
}