2025-02-15 07:57:36 -05:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2025, Tim Flynn <trflynn89@ladybird.org>
|
|
|
|
*
|
|
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
|
|
*/
|
|
|
|
|
2025-03-19 15:50:56 -04:00
|
|
|
#include <AK/JsonArray.h>
|
|
|
|
#include <AK/JsonObject.h>
|
2025-02-21 16:20:53 -05:00
|
|
|
#include <AK/JsonValue.h>
|
|
|
|
#include <LibDevTools/Actors/InspectorActor.h>
|
2025-02-15 07:57:36 -05:00
|
|
|
#include <LibDevTools/Actors/PageStyleActor.h>
|
2025-02-21 16:20:53 -05:00
|
|
|
#include <LibDevTools/Actors/TabActor.h>
|
|
|
|
#include <LibDevTools/Actors/WalkerActor.h>
|
|
|
|
#include <LibDevTools/DevToolsDelegate.h>
|
|
|
|
#include <LibDevTools/DevToolsServer.h>
|
2025-02-15 07:57:36 -05:00
|
|
|
|
|
|
|
namespace DevTools {
|
|
|
|
|
2025-07-02 12:27:26 -04:00
|
|
|
static void received_layout(JsonObject& response, JsonValue const& node_box_sizing)
|
2025-03-11 09:47:41 -04:00
|
|
|
{
|
2025-07-02 12:27:26 -04:00
|
|
|
if (!node_box_sizing.is_object())
|
|
|
|
return;
|
|
|
|
|
2025-03-11 09:47:41 -04:00
|
|
|
response.set("autoMargins"sv, JsonObject {});
|
|
|
|
|
2025-03-19 12:46:36 -04:00
|
|
|
auto pixel_value = [&](auto key) {
|
2025-07-02 12:27:26 -04:00
|
|
|
return node_box_sizing.as_object().get_double_with_precision_loss(key).value_or(0);
|
2025-03-11 09:47:41 -04:00
|
|
|
};
|
2025-03-19 12:46:36 -04:00
|
|
|
auto set_pixel_value = [&](auto key) {
|
|
|
|
response.set(key, MUST(String::formatted("{}px", pixel_value(key))));
|
2025-03-11 09:47:41 -04:00
|
|
|
};
|
2025-03-19 12:46:36 -04:00
|
|
|
auto set_computed_value = [&](auto key) {
|
2025-07-02 12:27:26 -04:00
|
|
|
response.set(key, node_box_sizing.as_object().get_string(key).value_or(String {}));
|
2025-03-11 09:47:41 -04:00
|
|
|
};
|
|
|
|
|
|
|
|
// FIXME: This response should also contain "top", "right", "bottom", and "left", but our box model metrics in
|
|
|
|
// WebContent do not provide this information.
|
|
|
|
|
2025-03-19 12:46:36 -04:00
|
|
|
set_computed_value("width"sv);
|
|
|
|
set_computed_value("height"sv);
|
|
|
|
|
|
|
|
set_pixel_value("border-top-width"sv);
|
|
|
|
set_pixel_value("border-right-width"sv);
|
|
|
|
set_pixel_value("border-bottom-width"sv);
|
|
|
|
set_pixel_value("border-left-width"sv);
|
|
|
|
|
|
|
|
set_pixel_value("margin-top"sv);
|
|
|
|
set_pixel_value("margin-right"sv);
|
|
|
|
set_pixel_value("margin-bottom"sv);
|
|
|
|
set_pixel_value("margin-left"sv);
|
|
|
|
|
|
|
|
set_pixel_value("padding-top"sv);
|
|
|
|
set_pixel_value("padding-right"sv);
|
|
|
|
set_pixel_value("padding-bottom"sv);
|
|
|
|
set_pixel_value("padding-left"sv);
|
|
|
|
|
|
|
|
set_computed_value("box-sizing"sv);
|
|
|
|
set_computed_value("display"sv);
|
|
|
|
set_computed_value("float"sv);
|
|
|
|
set_computed_value("line-height"sv);
|
|
|
|
set_computed_value("position"sv);
|
|
|
|
set_computed_value("z-index"sv);
|
2025-03-11 09:47:41 -04:00
|
|
|
}
|
|
|
|
|
2025-07-02 12:27:26 -04:00
|
|
|
static void received_computed_style(JsonObject& response, JsonValue const& computed_style)
|
2025-03-11 09:47:41 -04:00
|
|
|
{
|
|
|
|
JsonObject computed;
|
|
|
|
|
2025-07-02 12:27:26 -04:00
|
|
|
if (computed_style.is_object()) {
|
|
|
|
computed_style.as_object().for_each_member([&](String const& name, JsonValue const& value) {
|
|
|
|
JsonObject property;
|
|
|
|
property.set("matched"sv, true);
|
|
|
|
property.set("value"sv, value);
|
|
|
|
computed.set(name, move(property));
|
|
|
|
});
|
|
|
|
}
|
2025-03-11 09:47:41 -04:00
|
|
|
|
|
|
|
response.set("computed"sv, move(computed));
|
|
|
|
}
|
|
|
|
|
2025-07-02 12:27:26 -04:00
|
|
|
static void received_fonts(JsonObject& response, JsonValue const& fonts)
|
2025-03-11 16:01:34 -04:00
|
|
|
{
|
|
|
|
JsonArray font_faces;
|
|
|
|
|
2025-07-02 12:27:26 -04:00
|
|
|
if (fonts.is_array()) {
|
|
|
|
fonts.as_array().for_each([&](JsonValue const& font) {
|
|
|
|
if (!font.is_object())
|
|
|
|
return;
|
|
|
|
|
|
|
|
auto name = font.as_object().get_string("name"sv).value_or({});
|
|
|
|
auto weight = font.as_object().get_integer<i64>("weight"sv).value_or(0);
|
|
|
|
|
|
|
|
JsonObject font_face;
|
|
|
|
font_face.set("CSSFamilyName"sv, name);
|
|
|
|
font_face.set("CSSGeneric"sv, JsonValue {});
|
|
|
|
font_face.set("format"sv, ""sv);
|
|
|
|
font_face.set("localName"sv, ""sv);
|
|
|
|
font_face.set("metadata"sv, ""sv);
|
|
|
|
font_face.set("name"sv, name);
|
|
|
|
font_face.set("srcIndex"sv, -1);
|
|
|
|
font_face.set("style"sv, ""sv);
|
|
|
|
font_face.set("URI"sv, ""sv);
|
|
|
|
font_face.set("variationAxes"sv, JsonArray {});
|
|
|
|
font_face.set("variationInstances"sv, JsonArray {});
|
|
|
|
font_face.set("weight"sv, weight);
|
|
|
|
|
|
|
|
font_faces.must_append(move(font_face));
|
|
|
|
});
|
|
|
|
}
|
2025-03-11 16:01:34 -04:00
|
|
|
|
|
|
|
response.set("fontFaces"sv, move(font_faces));
|
|
|
|
}
|
|
|
|
|
2025-02-21 16:20:53 -05:00
|
|
|
NonnullRefPtr<PageStyleActor> PageStyleActor::create(DevToolsServer& devtools, String name, WeakPtr<InspectorActor> inspector)
|
2025-02-15 07:57:36 -05:00
|
|
|
{
|
2025-02-21 16:20:53 -05:00
|
|
|
return adopt_ref(*new PageStyleActor(devtools, move(name), move(inspector)));
|
2025-02-15 07:57:36 -05:00
|
|
|
}
|
|
|
|
|
2025-02-21 16:20:53 -05:00
|
|
|
PageStyleActor::PageStyleActor(DevToolsServer& devtools, String name, WeakPtr<InspectorActor> inspector)
|
2025-02-15 07:57:36 -05:00
|
|
|
: Actor(devtools, move(name))
|
2025-02-21 16:20:53 -05:00
|
|
|
, m_inspector(move(inspector))
|
2025-02-15 07:57:36 -05:00
|
|
|
{
|
2025-03-19 15:50:56 -04:00
|
|
|
if (auto tab = InspectorActor::tab_for(m_inspector)) {
|
|
|
|
devtools.delegate().listen_for_dom_properties(tab->description(),
|
|
|
|
[weak_self = make_weak_ptr<PageStyleActor>()](WebView::DOMNodeProperties const& properties) {
|
|
|
|
if (auto self = weak_self.strong_ref())
|
|
|
|
self->received_dom_node_properties(properties);
|
|
|
|
});
|
|
|
|
}
|
2025-02-15 07:57:36 -05:00
|
|
|
}
|
|
|
|
|
2025-03-19 15:50:56 -04:00
|
|
|
PageStyleActor::~PageStyleActor()
|
|
|
|
{
|
|
|
|
if (auto tab = InspectorActor::tab_for(m_inspector))
|
|
|
|
devtools().delegate().stop_listening_for_dom_properties(tab->description());
|
|
|
|
}
|
2025-02-15 07:57:36 -05:00
|
|
|
|
2025-03-12 08:01:23 -04:00
|
|
|
void PageStyleActor::handle_message(Message const& message)
|
2025-02-15 07:57:36 -05:00
|
|
|
{
|
2025-02-21 16:20:53 -05:00
|
|
|
JsonObject response;
|
|
|
|
|
2025-03-11 16:01:34 -04:00
|
|
|
if (message.type == "getAllUsedFontFaces"sv) {
|
|
|
|
response.set("fontFaces"sv, JsonArray {});
|
|
|
|
send_response(message, move(response));
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2025-03-12 08:01:23 -04:00
|
|
|
if (message.type == "getApplied"sv) {
|
2025-02-21 16:20:53 -05:00
|
|
|
// FIXME: This provides information to the "styles" pane in the inspector tab, which allows toggling and editing
|
|
|
|
// styles live. We do not yet support figuring out the list of styles that apply to a specific node.
|
|
|
|
response.set("entries"sv, JsonArray {});
|
LibDevTools: Re-implement how we handle ordered responses
We must reply to requests received from the client in the order they are
received. The wrench in this requirement is handling requests that must
be performed asynchronously, such as fetching the serialized DOM tree
from the WebContent process.
We currently handle this with a "block token". Async request handlers
hold a token that blocks any subsequent responses from being sent. When
that token is removed (i.e. the async request now has a response to be
sent), the async response is then sent followed by the blocked responses
in-order.
This strategy had a limitation that we could not handle an actor trying
to take 2 block tokens, meaning only one async request could be handled
at a time. This has been fine so far, but an upcoming feature (style
sheet sources) will break this limitation. The client will request N
sources at a time, which would try to take N block tokens.
The new strategy is to assign all requests an ID, and store a list of
request IDs that are awaiting a response. When the server wants to send
a reply, we match the ID of the replied-to message to this list of IDs.
If it is not the first in this list, then we are blocked waiting for an
earlier reply, and just store the response. When the earlier request(s)
receive their response, we can then send out all blocked replies (up to
the next request that has not yet received a response).
2025-03-12 12:26:58 -04:00
|
|
|
send_response(message, move(response));
|
2025-02-21 16:20:53 -05:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2025-03-12 08:01:23 -04:00
|
|
|
if (message.type == "getComputed"sv) {
|
2025-03-19 15:50:56 -04:00
|
|
|
inspect_dom_node(message, WebView::DOMNodeProperties::Type::ComputedStyle);
|
2025-02-21 16:20:53 -05:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2025-03-12 08:01:23 -04:00
|
|
|
if (message.type == "getLayout"sv) {
|
2025-03-19 15:50:56 -04:00
|
|
|
inspect_dom_node(message, WebView::DOMNodeProperties::Type::Layout);
|
2025-02-21 16:20:53 -05:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2025-03-11 16:01:34 -04:00
|
|
|
if (message.type == "getUsedFontFaces"sv) {
|
2025-03-19 15:50:56 -04:00
|
|
|
inspect_dom_node(message, WebView::DOMNodeProperties::Type::UsedFonts);
|
2025-03-11 16:01:34 -04:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2025-03-12 08:01:23 -04:00
|
|
|
if (message.type == "isPositionEditable") {
|
2025-02-21 16:20:53 -05:00
|
|
|
response.set("value"sv, false);
|
LibDevTools: Re-implement how we handle ordered responses
We must reply to requests received from the client in the order they are
received. The wrench in this requirement is handling requests that must
be performed asynchronously, such as fetching the serialized DOM tree
from the WebContent process.
We currently handle this with a "block token". Async request handlers
hold a token that blocks any subsequent responses from being sent. When
that token is removed (i.e. the async request now has a response to be
sent), the async response is then sent followed by the blocked responses
in-order.
This strategy had a limitation that we could not handle an actor trying
to take 2 block tokens, meaning only one async request could be handled
at a time. This has been fine so far, but an upcoming feature (style
sheet sources) will break this limitation. The client will request N
sources at a time, which would try to take N block tokens.
The new strategy is to assign all requests an ID, and store a list of
request IDs that are awaiting a response. When the server wants to send
a reply, we match the ID of the replied-to message to this list of IDs.
If it is not the first in this list, then we are blocked waiting for an
earlier reply, and just store the response. When the earlier request(s)
receive their response, we can then send out all blocked replies (up to
the next request that has not yet received a response).
2025-03-12 12:26:58 -04:00
|
|
|
send_response(message, move(response));
|
2025-02-21 16:20:53 -05:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2025-03-12 08:01:23 -04:00
|
|
|
send_unrecognized_packet_type_error(message);
|
2025-02-15 07:57:36 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
JsonValue PageStyleActor::serialize_style() const
|
|
|
|
{
|
|
|
|
JsonObject traits;
|
|
|
|
traits.set("fontStyleLevel4"sv, true);
|
|
|
|
traits.set("fontWeightLevel4"sv, true);
|
|
|
|
traits.set("fontStretchLevel4"sv, true);
|
|
|
|
traits.set("fontVariations"sv, true);
|
|
|
|
|
|
|
|
JsonObject style;
|
|
|
|
style.set("actor"sv, name());
|
|
|
|
style.set("traits"sv, move(traits));
|
|
|
|
return style;
|
|
|
|
}
|
|
|
|
|
2025-03-19 15:50:56 -04:00
|
|
|
void PageStyleActor::inspect_dom_node(Message const& message, WebView::DOMNodeProperties::Type property_type)
|
2025-02-21 16:20:53 -05:00
|
|
|
{
|
2025-03-19 15:50:56 -04:00
|
|
|
auto node = get_required_parameter<String>(message, "node"sv);
|
|
|
|
if (!node.has_value())
|
|
|
|
return;
|
|
|
|
|
|
|
|
auto dom_node = WalkerActor::dom_node_for(InspectorActor::walker_for(m_inspector), *node);
|
2025-03-11 07:55:05 -04:00
|
|
|
if (!dom_node.has_value()) {
|
2025-03-19 15:50:56 -04:00
|
|
|
send_unknown_actor_error(message, *node);
|
2025-02-21 16:20:53 -05:00
|
|
|
return;
|
2025-03-11 07:55:05 -04:00
|
|
|
}
|
2025-02-21 16:20:53 -05:00
|
|
|
|
2025-03-19 15:50:56 -04:00
|
|
|
devtools().delegate().inspect_dom_node(dom_node->tab->description(), property_type, dom_node->identifier.id, dom_node->identifier.pseudo_element);
|
|
|
|
m_pending_inspect_requests.append({ .id = message.id });
|
|
|
|
}
|
|
|
|
|
|
|
|
void PageStyleActor::received_dom_node_properties(WebView::DOMNodeProperties const& properties)
|
|
|
|
{
|
|
|
|
if (m_pending_inspect_requests.is_empty())
|
|
|
|
return;
|
|
|
|
|
|
|
|
JsonObject response;
|
|
|
|
|
|
|
|
switch (properties.type) {
|
|
|
|
case WebView::DOMNodeProperties::Type::ComputedStyle:
|
2025-07-02 12:27:26 -04:00
|
|
|
received_computed_style(response, properties.properties);
|
2025-03-19 15:50:56 -04:00
|
|
|
break;
|
|
|
|
case WebView::DOMNodeProperties::Type::Layout:
|
2025-07-02 12:27:26 -04:00
|
|
|
received_layout(response, properties.properties);
|
2025-03-19 15:50:56 -04:00
|
|
|
break;
|
|
|
|
case WebView::DOMNodeProperties::Type::UsedFonts:
|
2025-07-02 12:27:26 -04:00
|
|
|
received_fonts(response, properties.properties);
|
2025-03-19 15:50:56 -04:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
auto message = m_pending_inspect_requests.take_first();
|
|
|
|
send_response(message, move(response));
|
2025-02-21 16:20:53 -05:00
|
|
|
}
|
|
|
|
|
2025-02-15 07:57:36 -05:00
|
|
|
}
|