1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-27 06:07:34 +00:00

LibIPC+Everywhere: Change IPC::encode's return type to ErrorOr

In doing so, this removes all uses of the Encoder's stream operator,
except for where it is currently still used in the generated IPC code.
So the stream operator currently discards any errors, which is the
existing behavior. A subsequent commit will propagate the errors.
This commit is contained in:
Timothy Flynn 2023-01-01 23:37:35 -05:00 committed by Andreas Kling
parent d0f3f3d5ff
commit ab99ed5fba
29 changed files with 224 additions and 238 deletions

View file

@ -14,6 +14,7 @@
#include <LibCore/AnonymousBuffer.h>
#include <LibCore/DateTime.h>
#include <LibCore/Proxy.h>
#include <LibCore/System.h>
#include <LibIPC/Dictionary.h>
#include <LibIPC/Encoder.h>
#include <LibIPC/File.h>
@ -21,132 +22,113 @@
namespace IPC {
template<>
bool encode(Encoder& encoder, float const& value)
ErrorOr<void> encode(Encoder& encoder, float const& value)
{
return encoder.encode(bit_cast<u32>(value));
}
template<>
bool encode(Encoder& encoder, double const& value)
ErrorOr<void> encode(Encoder& encoder, double const& value)
{
return encoder.encode(bit_cast<u64>(value));
}
template<>
bool encode(Encoder& encoder, StringView const& value)
ErrorOr<void> encode(Encoder& encoder, StringView const& value)
{
auto result = encoder.append(reinterpret_cast<u8 const*>(value.characters_without_null_termination()), value.length());
return !result.is_error();
TRY(encoder.append(reinterpret_cast<u8 const*>(value.characters_without_null_termination()), value.length()));
return {};
}
template<>
bool encode(Encoder& encoder, DeprecatedString const& value)
ErrorOr<void> encode(Encoder& encoder, DeprecatedString const& value)
{
if (value.is_null())
return encoder.encode(-1);
if (!encoder.encode(static_cast<i32>(value.length())))
return false;
return encoder.encode(value.view());
TRY(encoder.encode(static_cast<i32>(value.length())));
TRY(encoder.encode(value.view()));
return {};
}
template<>
bool encode(Encoder& encoder, ByteBuffer const& value)
ErrorOr<void> encode(Encoder& encoder, ByteBuffer const& value)
{
if (!encoder.encode(static_cast<i32>(value.size())))
return false;
auto result = encoder.append(value.data(), value.size());
return !result.is_error();
TRY(encoder.encode(static_cast<i32>(value.size())));
TRY(encoder.append(value.data(), value.size()));
return {};
}
template<>
bool encode(Encoder& encoder, JsonValue const& value)
ErrorOr<void> encode(Encoder& encoder, JsonValue const& value)
{
return encoder.encode(value.serialized<StringBuilder>());
}
template<>
bool encode(Encoder& encoder, URL const& value)
ErrorOr<void> encode(Encoder& encoder, URL const& value)
{
return encoder.encode(value.to_deprecated_string());
}
template<>
bool encode(Encoder& encoder, Dictionary const& dictionary)
ErrorOr<void> encode(Encoder& encoder, Dictionary const& dictionary)
{
if (!encoder.encode(static_cast<u64>(dictionary.size())))
return false;
TRY(encoder.encode(static_cast<u64>(dictionary.size())));
bool had_error = false;
TRY(dictionary.try_for_each_entry([&](auto const& key, auto const& value) -> ErrorOr<void> {
TRY(encoder.encode(key));
TRY(encoder.encode(value));
return {};
}));
dictionary.for_each_entry([&](auto const& key, auto const& value) {
if (had_error)
return;
if (!encoder.encode(key) || !encoder.encode(value))
had_error = true;
});
return !had_error;
return {};
}
template<>
bool encode(Encoder& encoder, File const& file)
ErrorOr<void> encode(Encoder& encoder, File const& file)
{
int fd = file.fd();
if (fd != -1) {
auto result = dup(fd);
if (result < 0) {
perror("dup");
VERIFY_NOT_REACHED();
}
fd = result;
}
if (fd != -1)
fd = TRY(Core::System::dup(fd));
if (encoder.append_file_descriptor(fd).is_error())
return false;
return true;
TRY(encoder.append_file_descriptor(fd));
return {};
}
template<>
bool encode(Encoder&, Empty const&)
ErrorOr<void> encode(Encoder&, Empty const&)
{
return true;
return {};
}
template<>
bool encode(Encoder& encoder, Core::AnonymousBuffer const& buffer)
ErrorOr<void> encode(Encoder& encoder, Core::AnonymousBuffer const& buffer)
{
if (!encoder.encode(buffer.is_valid()))
return false;
TRY(encoder.encode(buffer.is_valid()));
if (buffer.is_valid()) {
if (!encoder.encode(static_cast<u32>(buffer.size())))
return false;
if (!encoder.encode(IPC::File { buffer.fd() }))
return false;
TRY(encoder.encode(static_cast<u32>(buffer.size())));
TRY(encoder.encode(IPC::File { buffer.fd() }));
}
return true;
return {};
}
template<>
bool encode(Encoder& encoder, Core::DateTime const& datetime)
ErrorOr<void> encode(Encoder& encoder, Core::DateTime const& datetime)
{
return encoder.encode(static_cast<i64>(datetime.timestamp()));
}
template<>
bool encode(Encoder& encoder, Core::ProxyData const& proxy)
ErrorOr<void> encode(Encoder& encoder, Core::ProxyData const& proxy)
{
if (!encoder.encode(proxy.type))
return false;
if (!encoder.encode(proxy.host_ipv4))
return false;
if (!encoder.encode(proxy.port))
return false;
return true;
TRY(encoder.encode(proxy.type));
TRY(encoder.encode(proxy.host_ipv4));
TRY(encoder.encode(proxy.port));
return {};
}
}

View file

@ -18,7 +18,7 @@
namespace IPC {
template<typename T>
bool encode(Encoder&, T const&)
ErrorOr<void> encode(Encoder&, T const&)
{
static_assert(DependentFalse<T>, "Base IPC::encode() was instantiated");
VERIFY_NOT_REACHED();
@ -34,12 +34,12 @@ public:
template<typename T>
Encoder& operator<<(T const& value)
{
encode(value);
(void)encode(value);
return *this;
}
template<typename T>
bool encode(T const& value);
ErrorOr<void> encode(T const& value);
ErrorOr<void> extend_capacity(size_t capacity)
{
@ -72,10 +72,9 @@ private:
};
template<Arithmetic T>
bool encode(Encoder& encoder, T const& value)
ErrorOr<void> encode(Encoder& encoder, T const& value)
{
if (encoder.extend_capacity(sizeof(T)).is_error())
return false;
TRY(encoder.extend_capacity(sizeof(T)));
if constexpr (sizeof(T) == 1) {
encoder.append(static_cast<u8>(value));
@ -100,97 +99,90 @@ bool encode(Encoder& encoder, T const& value)
static_assert(DependentFalse<T>);
}
return true;
return {};
}
template<Enum T>
bool encode(Encoder& encoder, T const& value)
ErrorOr<void> encode(Encoder& encoder, T const& value)
{
return encoder.encode(to_underlying(value));
}
template<>
bool encode(Encoder&, float const&);
ErrorOr<void> encode(Encoder&, float const&);
template<>
bool encode(Encoder&, double const&);
ErrorOr<void> encode(Encoder&, double const&);
template<>
bool encode(Encoder&, StringView const&);
ErrorOr<void> encode(Encoder&, StringView const&);
template<>
bool encode(Encoder&, DeprecatedString const&);
ErrorOr<void> encode(Encoder&, DeprecatedString const&);
template<>
bool encode(Encoder&, ByteBuffer const&);
ErrorOr<void> encode(Encoder&, ByteBuffer const&);
template<>
bool encode(Encoder&, JsonValue const&);
ErrorOr<void> encode(Encoder&, JsonValue const&);
template<>
bool encode(Encoder&, URL const&);
ErrorOr<void> encode(Encoder&, URL const&);
template<>
bool encode(Encoder&, Dictionary const&);
ErrorOr<void> encode(Encoder&, Dictionary const&);
template<>
bool encode(Encoder&, File const&);
ErrorOr<void> encode(Encoder&, File const&);
template<>
bool encode(Encoder&, Empty const&);
ErrorOr<void> encode(Encoder&, Empty const&);
template<Concepts::Vector T>
bool encode(Encoder& encoder, T const& vector)
ErrorOr<void> encode(Encoder& encoder, T const& vector)
{
if (!encoder.encode(static_cast<u64>(vector.size())))
return false;
TRY(encoder.encode(static_cast<u64>(vector.size())));
for (auto const& value : vector) {
if (!encoder.encode(value))
return false;
}
for (auto const& value : vector)
TRY(encoder.encode(value));
return true;
return {};
}
template<Concepts::HashMap T>
bool encode(Encoder& encoder, T const& hashmap)
ErrorOr<void> encode(Encoder& encoder, T const& hashmap)
{
if (!encoder.encode(static_cast<u32>(hashmap.size())))
return false;
TRY(encoder.encode(static_cast<u32>(hashmap.size())));
for (auto it : hashmap) {
if (!encoder.encode(it.key))
return false;
if (!encoder.encode(it.value))
return false;
TRY(encoder.encode(it.key));
TRY(encoder.encode(it.value));
}
return true;
return {};
}
template<Concepts::SharedSingleProducerCircularQueue T>
bool encode(Encoder& encoder, T const& queue)
ErrorOr<void> encode(Encoder& encoder, T const& queue)
{
return encoder.encode(IPC::File { queue.fd() });
}
template<Concepts::Optional T>
bool encode(Encoder& encoder, T const& optional)
ErrorOr<void> encode(Encoder& encoder, T const& optional)
{
if (!encoder.encode(optional.has_value()))
return false;
TRY(encoder.encode(optional.has_value()));
if (optional.has_value())
return encoder.encode(optional.value());
return true;
TRY(encoder.encode(optional.value()));
return {};
}
template<Concepts::Variant T>
bool encode(Encoder& encoder, T const& variant)
ErrorOr<void> encode(Encoder& encoder, T const& variant)
{
if (!encoder.encode(variant.index()))
return false;
TRY(encoder.encode(variant.index()));
return variant.visit([&](auto const& value) {
return encoder.encode(value);
@ -199,7 +191,7 @@ bool encode(Encoder& encoder, T const& variant)
// This must be last so that it knows about the above specializations.
template<typename T>
bool Encoder::encode(T const& value)
ErrorOr<void> Encoder::encode(T const& value)
{
return IPC::encode(*this, value);
}

View file

@ -6,6 +6,8 @@
#pragma once
#include <AK/Error.h>
namespace IPC {
class Decoder;
@ -16,7 +18,7 @@ class File;
class Stub;
template<typename T>
bool encode(Encoder&, T const&);
ErrorOr<void> encode(Encoder&, T const&);
template<typename T>
ErrorOr<T> decode(Decoder&);