1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-05-31 12:38:12 +00:00
serenity/Userland/Libraries/LibIPC/Encoder.h
Timothy Flynn b1ea418d14 LibIPC: Forward declare the encode() and decode() template functions
For the most part, we try to provide specializations of these functions
in various headers by including "LibIPC/Forward.h" and then declaring
encode() and decode() specializations. However, without any forward
declaration of these types, we aren't actually specializing anything.
Rather, we are just declaring overloads, which trips up the base encode
and decode template definitions.

The result is that LibIPC is very sensitive to include order, and the
DependentFalse<> static assertion would fail if the includes weren't
perfectly ordered.

By properly forward declaring these templates, we can make sure the
specializations receive precedence over the base templates.
2022-11-15 13:25:51 -05:00

126 lines
2.9 KiB
C++

/*
* Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/Concepts.h>
#include <AK/HashMap.h>
#include <AK/StdLibExtras.h>
#include <LibCore/SharedCircularQueue.h>
#include <LibIPC/Forward.h>
#include <LibIPC/Message.h>
namespace IPC {
template<typename T>
bool encode(Encoder&, T const&)
{
static_assert(DependentFalse<T>, "Base IPC::encode() was instantiated");
VERIFY_NOT_REACHED();
}
class Encoder {
public:
explicit Encoder(MessageBuffer& buffer)
: m_buffer(buffer)
{
}
Encoder& operator<<(bool);
Encoder& operator<<(u8);
Encoder& operator<<(u16);
Encoder& operator<<(unsigned);
Encoder& operator<<(unsigned long);
Encoder& operator<<(unsigned long long);
Encoder& operator<<(i8);
Encoder& operator<<(i16);
Encoder& operator<<(i32);
Encoder& operator<<(i64);
Encoder& operator<<(float);
Encoder& operator<<(double);
Encoder& operator<<(char const*);
Encoder& operator<<(StringView);
Encoder& operator<<(String const&);
Encoder& operator<<(ByteBuffer const&);
Encoder& operator<<(JsonValue const&);
Encoder& operator<<(URL const&);
Encoder& operator<<(Dictionary const&);
Encoder& operator<<(File const&);
template<typename K, typename V>
Encoder& operator<<(HashMap<K, V> const& hashmap)
{
*this << (u32)hashmap.size();
for (auto it : hashmap) {
*this << it.key;
*this << it.value;
}
return *this;
}
template<typename K, typename V>
Encoder& operator<<(OrderedHashMap<K, V> const& hashmap)
{
*this << (u32)hashmap.size();
for (auto it : hashmap) {
*this << it.key;
*this << it.value;
}
return *this;
}
template<typename T>
Encoder& operator<<(Vector<T> const& vector)
{
*this << (u64)vector.size();
for (auto& value : vector)
*this << value;
return *this;
}
template<typename T, size_t Size>
Encoder& operator<<(Core::SharedSingleProducerCircularQueue<T, Size> const& queue)
{
*this << IPC::File(queue.fd());
return *this;
}
template<Enum T>
Encoder& operator<<(T const& enum_value)
{
*this << AK::to_underlying(enum_value);
return *this;
}
template<typename T>
Encoder& operator<<(T const& value)
{
encode(value);
return *this;
}
template<typename T>
Encoder& operator<<(Optional<T> const& optional)
{
*this << optional.has_value();
if (optional.has_value())
*this << optional.value();
return *this;
}
template<typename T>
void encode(T const& value)
{
IPC::encode(*this, value);
}
private:
void encode_u32(u32);
void encode_u64(u64);
MessageBuffer& m_buffer;
};
}