dmaax/ladybird
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ladybird/AK/JsonObject.h

120 lines
3.7 KiB
C
Raw Permalink Normal View History

Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 05:38:21 -03:00
/*
Meta: Update my e-mail address everywhere
2024-10-04 08:19:50 -03:00
* Copyright (c) 2018-2020, Andreas Kling <andreas@ladybird.org>
AK: Use east const style in Json{Array,Object}.h
2021-06-28 05:21:20 -03:00
* Copyright (c) 2021, Max Wipfli <mail@maxwipfli.ch>
AK: Move JsonObject implementation out of line
2023-01-04 14:38:01 -03:00
* Copyright (c) 2023, Sam Atkins <atkinssj@serenityos.org>
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 05:38:21 -03:00
*
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt *
2021-04-22 05:24:48 -03:00
* SPDX-License-Identifier: BSD-2-Clause
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 05:38:21 -03:00
*/
AK: Add some classes for JSON encoding. This patch adds JsonValue, JsonObject and JsonArray. You can use them to build up a JsonObject and then serialize it to a string via to_string(). This patch only implements encoding, no decoding yet.
2019-06-17 14:47:35 -03:00
#pragma once
AK: Add JSON object/array for-each methods for fallible callbacks This allows the provided callback to return an ErrorOr-like type to propagate errors back to the caller.
2022-11-17 10:15:01 -03:00
#include <AK/Concepts.h>
#include <AK/Error.h>
AK: Add some classes for JSON encoding. This patch adds JsonValue, JsonObject and JsonArray. You can use them to build up a JsonObject and then serialize it to a string via to_string(). This patch only implements encoding, no decoding yet.
2019-06-17 14:47:35 -03:00
#include <AK/HashMap.h>
JSON: Templatize the JSON serialization code This makes it possible to use something other than a StringBuilder for serialization (and to produce something other than a String.) :^)
2019-08-07 16:28:07 -03:00
#include <AK/JsonArray.h>
AK: Add some classes for JSON encoding. This patch adds JsonValue, JsonObject and JsonArray. You can use them to build up a JsonObject and then serialize it to a string via to_string(). This patch only implements encoding, no decoding yet.
2019-06-17 14:47:35 -03:00
#include <AK/JsonValue.h>
AK+Everywhere: Store JSON object keys as String
2025-02-17 14:18:27 -03:00
#include <AK/String.h>
AK: Add some classes for JSON encoding. This patch adds JsonValue, JsonObject and JsonArray. You can use them to build up a JsonObject and then serialize it to a string via to_string(). This patch only implements encoding, no decoding yet.
2019-06-17 14:47:35 -03:00
AK: Use a single StringBuilder throughout JSON serialization.
2019-06-17 16:34:12 -03:00
namespace AK {
AK: Add some classes for JSON encoding. This patch adds JsonValue, JsonObject and JsonArray. You can use them to build up a JsonObject and then serialize it to a string via to_string(). This patch only implements encoding, no decoding yet.
2019-06-17 14:47:35 -03:00
class JsonObject {
AK: Add JSON object/array for-each methods for fallible callbacks This allows the provided callback to return an ErrorOr-like type to propagate errors back to the caller.
2022-11-17 10:15:01 -03:00
template<typename Callback>
AK+Everywhere: Store JSON object keys as String
2025-02-17 14:18:27 -03:00
using CallbackErrorType = decltype(declval<Callback>()(declval<String const&>(), declval<JsonValue const&>()).release_error());
AK: Add JSON object/array for-each methods for fallible callbacks This allows the provided callback to return an ErrorOr-like type to propagate errors back to the caller.
2022-11-17 10:15:01 -03:00
AK: Add some classes for JSON encoding. This patch adds JsonValue, JsonObject and JsonArray. You can use them to build up a JsonObject and then serialize it to a string via to_string(). This patch only implements encoding, no decoding yet.
2019-06-17 14:47:35 -03:00
public:
AK: Move JsonObject implementation out of line
2023-01-04 14:38:01 -03:00
JsonObject();
~JsonObject();
Json: Add efficient copy and move constructors for Json{Array,Object} This helps avoid copying JsonValues during parsing.
2019-08-04 06:45:16 -03:00
AK: Move JsonObject implementation out of line
2023-01-04 14:38:01 -03:00
JsonObject(JsonObject const& other);
JsonObject(JsonObject&& other);
Json: Add efficient copy and move constructors for Json{Array,Object} This helps avoid copying JsonValues during parsing.
2019-08-04 06:45:16 -03:00
AK: Move JsonObject implementation out of line
2023-01-04 14:38:01 -03:00
JsonObject& operator=(JsonObject const& other);
JsonObject& operator=(JsonObject&& other);
Json: Add efficient copy and move constructors for Json{Array,Object} This helps avoid copying JsonValues during parsing.
2019-08-04 06:45:16 -03:00
AK: Move JsonObject implementation out of line
2023-01-04 14:38:01 -03:00
[[nodiscard]] size_t size() const;
[[nodiscard]] bool is_empty() const;
Json: Add efficient copy and move constructors for Json{Array,Object} This helps avoid copying JsonValues during parsing.
2019-08-04 06:45:16 -03:00
AK: Move JsonObject implementation out of line
2023-01-04 14:38:01 -03:00
[[nodiscard]] bool has(StringView key) const;
AK: Add JsonObject::get_ptr() for copy-free lookup This variant of get() returns a const JsonValue* instead of a JsonValue and can be used when you want to peek into a JsonObject's member fields without making copies.
2019-12-30 10:49:45 -03:00
AK: Move JsonObject implementation out of line
2023-01-04 14:38:01 -03:00
[[nodiscard]] bool has_null(StringView key) const;
[[nodiscard]] bool has_bool(StringView key) const;
[[nodiscard]] bool has_string(StringView key) const;
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.
2022-12-21 09:19:23 -03:00
[[nodiscard]] bool has_i8(StringView key) const;
[[nodiscard]] bool has_u8(StringView key) const;
[[nodiscard]] bool has_i16(StringView key) const;
[[nodiscard]] bool has_u16(StringView key) const;
AK: Move JsonObject implementation out of line
2023-01-04 14:38:01 -03:00
[[nodiscard]] bool has_i32(StringView key) const;
[[nodiscard]] bool has_u32(StringView key) const;
[[nodiscard]] bool has_i64(StringView key) const;
[[nodiscard]] bool has_u64(StringView key) const;
[[nodiscard]] bool has_number(StringView key) const;
[[nodiscard]] bool has_array(StringView key) const;
[[nodiscard]] bool has_object(StringView key) const;
AK: Add JsonObject::has_* methods This adds methods to JsonObject to check if a key exists with a certain type. This simplifies code that validates whether a JsonObject has the expected structure.
2021-06-28 07:00:34 -03:00
AK: Provide a few mutable JSON object/array accessors We have mutable accessors on the JsonValue class already. This will be needed for interaction with Firefox's DevTools, where we will want to mutate the serialized DOM tree we receive from WebContent.
2025-02-14 20:13:40 -03:00
Optional<JsonValue&> get(StringView key);
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.
2022-12-21 09:19:23 -03:00
Optional<JsonValue const&> get(StringView key) const;
template<Integral T>
Optional<T> get_integer(StringView key) const
{
auto maybe_value = get(key);
if (maybe_value.has_value() && maybe_value->is_integer<T>())
return maybe_value->as_integer<T>();
return {};
}
Optional<i8> get_i8(StringView key) const;
Optional<u8> get_u8(StringView key) const;
Optional<i16> get_i16(StringView key) const;
Optional<u16> get_u16(StringView key) const;
Optional<i32> get_i32(StringView key) const;
Optional<u32> get_u32(StringView key) const;
Optional<i64> get_i64(StringView key) const;
Optional<u64> get_u64(StringView key) const;
Optional<FlatPtr> get_addr(StringView key) const;
Optional<bool> get_bool(StringView key) const;
AK+Everywhere: Store JSON strings as String
2025-02-17 15:21:07 -03:00
Optional<String const&> get_string(StringView key) const;
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.
2022-12-21 09:19:23 -03:00
AK: Provide a few mutable JSON object/array accessors We have mutable accessors on the JsonValue class already. This will be needed for interaction with Firefox's DevTools, where we will want to mutate the serialized DOM tree we receive from WebContent.
2025-02-14 20:13:40 -03:00
Optional<JsonObject&> get_object(StringView key);
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.
2022-12-21 09:19:23 -03:00
Optional<JsonObject const&> get_object(StringView key) const;
AK: Provide a few mutable JSON object/array accessors We have mutable accessors on the JsonValue class already. This will be needed for interaction with Firefox's DevTools, where we will want to mutate the serialized DOM tree we receive from WebContent.
2025-02-14 20:13:40 -03:00
Optional<JsonArray&> get_array(StringView key);
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.
2022-12-21 09:19:23 -03:00
Optional<JsonArray const&> get_array(StringView key) const;
AK+Applications: Return value from JsonObject::get_double more often Previously, we were returning an empty optional if key contained a numerical value which was not stored as double. Stop doing that and rename the method to signify the change in the behavior. Apparently, this fixes bug in an InspectorWidget in Ladybird on Serenity: it showed 0 for element's boxes with integer sizes.
2023-11-14 02:36:05 -03:00
Optional<double> get_double_with_precision_loss(StringView key) const;
Optional<float> get_float_with_precision_loss(StringView key) const;
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.
2022-12-21 09:19:23 -03:00
AK+Everywhere: Store JSON object keys as String
2025-02-17 14:18:27 -03:00
void set(String key, JsonValue value);
void set(StringView key, JsonValue value);
AK: Add JsonObject::set(key, &&value) overload. This dodges a whole bunch of value copying in JsonParser.
2019-07-08 08:08:21 -03:00
AK: Add some classes for JSON encoding. This patch adds JsonValue, JsonObject and JsonArray. You can use them to build up a JsonObject and then serialize it to a string via to_string(). This patch only implements encoding, no decoding yet.
2019-06-17 14:47:35 -03:00
template<typename Callback>
void for_each_member(Callback callback) const
{
AK: Add implied const qualifiers to the Json interface As specified by clang-tidy.
2021-12-15 10:49:35 -03:00
for (auto const& member : m_members)
AK: Use OrderedHashMap in JsonObject This changes JsonObject to use the new OrderedHashMap instead of an extra vector for tracking the insertion order. This also adds a default value for the KeyTraits template argument in OrderedHashMap. Furthermore, it fixes two cases where code iterating over a JsonObject relied on the value argument being copied before invoking the callback.
2021-06-28 06:02:18 -03:00
callback(member.key, member.value);
AK: Add some classes for JSON encoding. This patch adds JsonValue, JsonObject and JsonArray. You can use them to build up a JsonObject and then serialize it to a string via to_string(). This patch only implements encoding, no decoding yet.
2019-06-17 14:47:35 -03:00
}
AK+Everywhere: Store JSON object keys as String
2025-02-17 14:18:27 -03:00
template<FallibleFunction<String const&, JsonValue const&> Callback>
AK: Add JSON object/array for-each methods for fallible callbacks This allows the provided callback to return an ErrorOr-like type to propagate errors back to the caller.
2022-11-17 10:15:01 -03:00
ErrorOr<void, CallbackErrorType<Callback>> try_for_each_member(Callback&& callback) const
{
for (auto const& member : m_members)
TRY(callback(member.key, member.value));
return {};
}
AK: Move JsonObject implementation out of line
2023-01-04 14:38:01 -03:00
bool remove(StringView key);
AK: Add JsonObject::remove()
2020-09-06 11:08:37 -03:00
AK+Everywhere: Convert JSON value serialization to String This removes the use of StringBuilder::OutputType (which was ByteString, and only used by the JSON classes). And it removes the StringBuilder template parameter from the serialization methods; this was only ever used with StringBuilder, so a template is pretty overkill here.
2025-02-17 17:08:17 -03:00
String serialized() const;
void serialize(StringBuilder&) const;
JSON: Templatize the JSON serialization code This makes it possible to use something other than a StringBuilder for serialization (and to produce something other than a String.) :^)
2019-08-07 16:28:07 -03:00
AK: Add some classes for JSON encoding. This patch adds JsonValue, JsonObject and JsonArray. You can use them to build up a JsonObject and then serialize it to a string via to_string(). This patch only implements encoding, no decoding yet.
2019-06-17 14:47:35 -03:00
private:
AK+Everywhere: Store JSON object keys as String
2025-02-17 14:18:27 -03:00
OrderedHashMap<String, JsonValue> m_members;
AK: Add some classes for JSON encoding. This patch adds JsonValue, JsonObject and JsonArray. You can use them to build up a JsonObject and then serialize it to a string via to_string(). This patch only implements encoding, no decoding yet.
2019-06-17 14:47:35 -03:00
};
AK: Use a single StringBuilder throughout JSON serialization.
2019-06-17 16:34:12 -03:00
}
AK: Make it possible to not `using` AK classes into the global namespace This patch adds the `USING_AK_GLOBALLY` macro which is enabled by default, but can be overridden by build flags. This is a step towards integrating Jakt and AK types.
2022-11-26 08:18:30 -03:00
#if USING_AK_GLOBALLY
AK: Use a single StringBuilder throughout JSON serialization.
2019-06-17 16:34:12 -03:00
using AK::JsonObject;
AK: Make it possible to not `using` AK classes into the global namespace This patch adds the `USING_AK_GLOBALLY` macro which is enabled by default, but can be overridden by build flags. This is a step towards integrating Jakt and AK types.
2022-11-26 08:18:30 -03:00
#endif
Reference in a new issue Copy permalink