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

Userland: Properly define IPC::encode and IPC::decode specializations

In order to avoid the base encode/decode methods from being used (and
failing a static assertion), we must be sure to declare/define the
custom type implementations as template specializations.

After this, LibIPC is no longer sensitive to include order.
This commit is contained in:
Timothy Flynn 2022-11-15 11:24:59 -05:00 committed by Tim Flynn
parent b1ea418d14
commit 05f41382bb
25 changed files with 75 additions and 2 deletions

View file

@ -74,7 +74,10 @@ private:
namespace IPC { namespace IPC {
template<>
bool encode(Encoder&, Core::AnonymousBuffer const&); bool encode(Encoder&, Core::AnonymousBuffer const&);
template<>
ErrorOr<void> decode(Decoder&, Core::AnonymousBuffer&); ErrorOr<void> decode(Decoder&, Core::AnonymousBuffer&);
} }

View file

@ -54,7 +54,10 @@ private:
namespace IPC { namespace IPC {
template<>
bool encode(Encoder&, Core::DateTime const&); bool encode(Encoder&, Core::DateTime const&);
template<>
ErrorOr<void> decode(Decoder&, Core::DateTime&); ErrorOr<void> decode(Decoder&, Core::DateTime&);
} }

View file

@ -52,6 +52,11 @@ struct ProxyData {
} }
namespace IPC { namespace IPC {
template<>
bool encode(Encoder&, Core::ProxyData const&); bool encode(Encoder&, Core::ProxyData const&);
template<>
ErrorOr<void> decode(Decoder&, Core::ProxyData&); ErrorOr<void> decode(Decoder&, Core::ProxyData&);
} }

View file

@ -100,12 +100,14 @@ ErrorOr<void> AK::Formatter<DNS::RecordClass>::format(AK::FormatBuilder& builder
namespace IPC { namespace IPC {
template<>
bool encode(Encoder& encoder, DNS::Answer const& answer) bool encode(Encoder& encoder, DNS::Answer const& answer)
{ {
encoder << answer.name().as_string() << (u16)answer.type() << (u16)answer.class_code() << answer.ttl() << answer.record_data() << answer.mdns_cache_flush(); encoder << answer.name().as_string() << (u16)answer.type() << (u16)answer.class_code() << answer.ttl() << answer.record_data() << answer.mdns_cache_flush();
return true; return true;
} }
template<>
ErrorOr<void> decode(Decoder& decoder, DNS::Answer& answer) ErrorOr<void> decode(Decoder& decoder, DNS::Answer& answer)
{ {
String name; String name;

View file

@ -94,7 +94,10 @@ struct AK::Formatter<DNS::RecordClass> : StandardFormatter {
namespace IPC { namespace IPC {
template<>
bool encode(Encoder&, DNS::Answer const&); bool encode(Encoder&, DNS::Answer const&);
template<>
ErrorOr<void> decode(Decoder&, DNS::Answer&); ErrorOr<void> decode(Decoder&, DNS::Answer&);
} }

View file

@ -366,12 +366,14 @@ Vector<Color> Color::tints(u32 steps, float max) const
} }
template<>
bool IPC::encode(Encoder& encoder, Color const& color) bool IPC::encode(Encoder& encoder, Color const& color)
{ {
encoder << color.value(); encoder << color.value();
return true; return true;
} }
template<>
ErrorOr<void> IPC::decode(Decoder& decoder, Color& color) ErrorOr<void> IPC::decode(Decoder& decoder, Color& color)
{ {
u32 rgba; u32 rgba;

View file

@ -568,7 +568,10 @@ struct Formatter<Gfx::Color> : public Formatter<StringView> {
namespace IPC { namespace IPC {
template<>
bool encode(Encoder&, Gfx::Color const&); bool encode(Encoder&, Gfx::Color const&);
template<>
ErrorOr<void> decode(Decoder&, Gfx::Color&); ErrorOr<void> decode(Decoder&, Gfx::Color&);
} }

View file

@ -51,12 +51,14 @@ String FloatPoint::to_string() const
namespace IPC { namespace IPC {
template<>
bool encode(Encoder& encoder, Gfx::IntPoint const& point) bool encode(Encoder& encoder, Gfx::IntPoint const& point)
{ {
encoder << point.x() << point.y(); encoder << point.x() << point.y();
return true; return true;
} }
template<>
ErrorOr<void> decode(Decoder& decoder, Gfx::IntPoint& point) ErrorOr<void> decode(Decoder& decoder, Gfx::IntPoint& point)
{ {
int x = 0; int x = 0;

View file

@ -290,7 +290,10 @@ struct Formatter<Gfx::Point<T>> : Formatter<FormatString> {
namespace IPC { namespace IPC {
template<>
bool encode(Encoder&, Gfx::IntPoint const&); bool encode(Encoder&, Gfx::IntPoint const&);
template<>
ErrorOr<void> decode(Decoder&, Gfx::IntPoint&); ErrorOr<void> decode(Decoder&, Gfx::IntPoint&);
} }

View file

@ -30,12 +30,14 @@ String FloatRect::to_string() const
namespace IPC { namespace IPC {
template<>
bool encode(Encoder& encoder, Gfx::IntRect const& rect) bool encode(Encoder& encoder, Gfx::IntRect const& rect)
{ {
encoder << rect.location() << rect.size(); encoder << rect.location() << rect.size();
return true; return true;
} }
template<>
ErrorOr<void> decode(Decoder& decoder, Gfx::IntRect& rect) ErrorOr<void> decode(Decoder& decoder, Gfx::IntRect& rect)
{ {
Gfx::IntPoint point; Gfx::IntPoint point;

View file

@ -1031,7 +1031,10 @@ struct Formatter<Gfx::Rect<T>> : Formatter<FormatString> {
namespace IPC { namespace IPC {
template<>
bool encode(Encoder&, Gfx::IntRect const&); bool encode(Encoder&, Gfx::IntRect const&);
template<>
ErrorOr<void> decode(Decoder&, Gfx::IntRect&); ErrorOr<void> decode(Decoder&, Gfx::IntRect&);
} }

View file

@ -22,6 +22,7 @@ ShareableBitmap::ShareableBitmap(NonnullRefPtr<Bitmap> bitmap, Tag)
namespace IPC { namespace IPC {
template<>
bool encode(Encoder& encoder, Gfx::ShareableBitmap const& shareable_bitmap) bool encode(Encoder& encoder, Gfx::ShareableBitmap const& shareable_bitmap)
{ {
encoder << shareable_bitmap.is_valid(); encoder << shareable_bitmap.is_valid();
@ -39,6 +40,7 @@ bool encode(Encoder& encoder, Gfx::ShareableBitmap const& shareable_bitmap)
return true; return true;
} }
template<>
ErrorOr<void> decode(Decoder& decoder, Gfx::ShareableBitmap& shareable_bitmap) ErrorOr<void> decode(Decoder& decoder, Gfx::ShareableBitmap& shareable_bitmap)
{ {
bool valid = false; bool valid = false;

View file

@ -34,7 +34,10 @@ private:
namespace IPC { namespace IPC {
template<>
bool encode(Encoder&, Gfx::ShareableBitmap const&); bool encode(Encoder&, Gfx::ShareableBitmap const&);
template<>
ErrorOr<void> decode(Decoder&, Gfx::ShareableBitmap&); ErrorOr<void> decode(Decoder&, Gfx::ShareableBitmap&);
} }

View file

@ -27,12 +27,14 @@ String FloatSize::to_string() const
namespace IPC { namespace IPC {
template<>
bool encode(Encoder& encoder, Gfx::IntSize const& size) bool encode(Encoder& encoder, Gfx::IntSize const& size)
{ {
encoder << size.width() << size.height(); encoder << size.width() << size.height();
return true; return true;
} }
template<>
ErrorOr<void> decode(Decoder& decoder, Gfx::IntSize& size) ErrorOr<void> decode(Decoder& decoder, Gfx::IntSize& size)
{ {
int width = 0; int width = 0;

View file

@ -188,7 +188,10 @@ struct Formatter<Gfx::Size<T>> : Formatter<FormatString> {
namespace IPC { namespace IPC {
template<>
bool encode(Encoder&, Gfx::IntSize const&); bool encode(Encoder&, Gfx::IntSize const&);
template<>
ErrorOr<void> decode(Decoder&, Gfx::IntSize&); ErrorOr<void> decode(Decoder&, Gfx::IntSize&);
} }

View file

@ -170,6 +170,7 @@ ErrorOr<void> Decoder::decode([[maybe_unused]] File& file)
return {}; return {};
} }
template<>
ErrorOr<void> decode(Decoder& decoder, Core::AnonymousBuffer& buffer) ErrorOr<void> decode(Decoder& decoder, Core::AnonymousBuffer& buffer)
{ {
bool valid; bool valid;
@ -187,6 +188,7 @@ ErrorOr<void> decode(Decoder& decoder, Core::AnonymousBuffer& buffer)
return {}; return {};
} }
template<>
ErrorOr<void> decode(Decoder& decoder, Core::DateTime& datetime) ErrorOr<void> decode(Decoder& decoder, Core::DateTime& datetime)
{ {
i64 timestamp; i64 timestamp;
@ -195,6 +197,7 @@ ErrorOr<void> decode(Decoder& decoder, Core::DateTime& datetime)
return {}; return {};
} }
template<>
ErrorOr<void> decode(Decoder& decoder, Core::ProxyData& data) ErrorOr<void> decode(Decoder& decoder, Core::ProxyData& data)
{ {
UnderlyingType<decltype(data.type)> type; UnderlyingType<decltype(data.type)> type;

View file

@ -196,6 +196,7 @@ Encoder& Encoder::operator<<(File const& file)
return *this; return *this;
} }
template<>
bool encode(Encoder& encoder, Core::AnonymousBuffer const& buffer) bool encode(Encoder& encoder, Core::AnonymousBuffer const& buffer)
{ {
encoder << buffer.is_valid(); encoder << buffer.is_valid();
@ -206,12 +207,14 @@ bool encode(Encoder& encoder, Core::AnonymousBuffer const& buffer)
return true; return true;
} }
template<>
bool encode(Encoder& encoder, Core::DateTime const& datetime) bool encode(Encoder& encoder, Core::DateTime const& datetime)
{ {
encoder << static_cast<i64>(datetime.timestamp()); encoder << static_cast<i64>(datetime.timestamp());
return true; return true;
} }
template<>
bool encode(Encoder& encoder, Core::ProxyData const& proxy) bool encode(Encoder& encoder, Core::ProxyData const& proxy)
{ {
encoder << to_underlying(proxy.type); encoder << to_underlying(proxy.type);

View file

@ -38,6 +38,7 @@ SameSite same_site_from_string(StringView same_site_mode)
} }
template<>
bool IPC::encode(Encoder& encoder, Web::Cookie::Cookie const& cookie) bool IPC::encode(Encoder& encoder, Web::Cookie::Cookie const& cookie)
{ {
encoder << cookie.name; encoder << cookie.name;
@ -56,6 +57,7 @@ bool IPC::encode(Encoder& encoder, Web::Cookie::Cookie const& cookie)
return true; return true;
} }
template<>
ErrorOr<void> IPC::decode(Decoder& decoder, Web::Cookie::Cookie& cookie) ErrorOr<void> IPC::decode(Decoder& decoder, Web::Cookie::Cookie& cookie)
{ {
TRY(decoder.decode(cookie.name)); TRY(decoder.decode(cookie.name));

View file

@ -46,7 +46,10 @@ SameSite same_site_from_string(StringView same_site_mode);
namespace IPC { namespace IPC {
template<>
bool encode(Encoder&, Web::Cookie::Cookie const&); bool encode(Encoder&, Web::Cookie::Cookie const&);
template<>
ErrorOr<void> decode(Decoder&, Web::Cookie::Cookie&); ErrorOr<void> decode(Decoder&, Web::Cookie::Cookie&);
} }

View file

@ -347,6 +347,7 @@ Optional<Core::DateTime> parse_date_time(StringView date_string)
} }
template<>
bool IPC::encode(Encoder& encoder, Web::Cookie::ParsedCookie const& cookie) bool IPC::encode(Encoder& encoder, Web::Cookie::ParsedCookie const& cookie)
{ {
encoder << cookie.name; encoder << cookie.name;
@ -362,6 +363,7 @@ bool IPC::encode(Encoder& encoder, Web::Cookie::ParsedCookie const& cookie)
return true; return true;
} }
template<>
ErrorOr<void> IPC::decode(Decoder& decoder, Web::Cookie::ParsedCookie& cookie) ErrorOr<void> IPC::decode(Decoder& decoder, Web::Cookie::ParsedCookie& cookie)
{ {
TRY(decoder.decode(cookie.name)); TRY(decoder.decode(cookie.name));

View file

@ -32,7 +32,10 @@ Optional<ParsedCookie> parse_cookie(String const& cookie_string);
namespace IPC { namespace IPC {
template<>
bool encode(Encoder&, Web::Cookie::ParsedCookie const&); bool encode(Encoder&, Web::Cookie::ParsedCookie const&);
template<>
ErrorOr<void> decode(Decoder&, Web::Cookie::ParsedCookie&); ErrorOr<void> decode(Decoder&, Web::Cookie::ParsedCookie&);
} }

View file

@ -27,6 +27,7 @@ Response::Response(Error&& error)
} }
template<>
bool IPC::encode(Encoder& encoder, Web::WebDriver::Response const& response) bool IPC::encode(Encoder& encoder, Web::WebDriver::Response const& response)
{ {
response.visit( response.visit(
@ -46,6 +47,7 @@ bool IPC::encode(Encoder& encoder, Web::WebDriver::Response const& response)
return true; return true;
} }
template<>
ErrorOr<void> IPC::decode(Decoder& decoder, Web::WebDriver::Response& response) ErrorOr<void> IPC::decode(Decoder& decoder, Web::WebDriver::Response& response)
{ {
ResponseType type {}; ResponseType type {};

View file

@ -46,7 +46,10 @@ private:
namespace IPC { namespace IPC {
template<>
bool encode(Encoder&, Web::WebDriver::Response const&); bool encode(Encoder&, Web::WebDriver::Response const&);
template<>
ErrorOr<void> decode(Decoder&, Web::WebDriver::Response&); ErrorOr<void> decode(Decoder&, Web::WebDriver::Response&);
} }

View file

@ -73,9 +73,16 @@ public:
namespace IPC { namespace IPC {
template<>
bool encode(Encoder&, WindowServer::ScreenLayout::Screen const&); bool encode(Encoder&, WindowServer::ScreenLayout::Screen const&);
template<>
ErrorOr<void> decode(Decoder&, WindowServer::ScreenLayout::Screen&); ErrorOr<void> decode(Decoder&, WindowServer::ScreenLayout::Screen&);
template<>
bool encode(Encoder&, WindowServer::ScreenLayout const&); bool encode(Encoder&, WindowServer::ScreenLayout const&);
template<>
ErrorOr<void> decode(Decoder&, WindowServer::ScreenLayout&); ErrorOr<void> decode(Decoder&, WindowServer::ScreenLayout&);
} }

View file

@ -394,12 +394,14 @@ bool ScreenLayout::try_auto_add_display_connector(String const& device_path)
namespace IPC { namespace IPC {
bool encode(Encoder& encoder, const WindowServer::ScreenLayout::Screen& screen) template<>
bool encode(Encoder& encoder, WindowServer::ScreenLayout::Screen const& screen)
{ {
encoder << screen.mode << screen.device << screen.location << screen.resolution << screen.scale_factor; encoder << screen.mode << screen.device << screen.location << screen.resolution << screen.scale_factor;
return true; return true;
} }
template<>
ErrorOr<void> decode(Decoder& decoder, WindowServer::ScreenLayout::Screen& screen) ErrorOr<void> decode(Decoder& decoder, WindowServer::ScreenLayout::Screen& screen)
{ {
WindowServer::ScreenLayout::Screen::Mode mode; WindowServer::ScreenLayout::Screen::Mode mode;
@ -416,12 +418,14 @@ ErrorOr<void> decode(Decoder& decoder, WindowServer::ScreenLayout::Screen& scree
return {}; return {};
} }
bool encode(Encoder& encoder, const WindowServer::ScreenLayout& screen_layout) template<>
bool encode(Encoder& encoder, WindowServer::ScreenLayout const& screen_layout)
{ {
encoder << screen_layout.screens << screen_layout.main_screen_index; encoder << screen_layout.screens << screen_layout.main_screen_index;
return true; return true;
} }
template<>
ErrorOr<void> decode(Decoder& decoder, WindowServer::ScreenLayout& screen_layout) ErrorOr<void> decode(Decoder& decoder, WindowServer::ScreenLayout& screen_layout)
{ {
Vector<WindowServer::ScreenLayout::Screen> screens; Vector<WindowServer::ScreenLayout::Screen> screens;