LibWebView: Rename a couple of console-related callbacks for clarity

The "on_received_console_message" and "on_received_console_messages"
were indistinguishable in purpose based on their name. This renames them
to:

on_console_message_available - WebContent has output a console message
and it is available for the client to retrieve.

on_received_styled_console_messages - WebContent has replied to a
request for the available console messages.

The "styled" qualifier is used here to indicate that the messages have
been styled with CSS for display in a WebView. This is to prepare for
an upcoming patch where DevToolsConsoleClient will not stylize the
output; DevTools will want the raw JS values.
This commit is contained in:
Timothy Flynn 2025-03-04 07:56:42 -05:00 committed by Tim Flynn
commit 848ac11495
Notes: github-actions[bot] 2025-03-04 20:34:57 +00:00
9 changed files with 23 additions and 23 deletions

View file

@ -118,12 +118,12 @@ InspectorClient::InspectorClient(ViewImplementation& content_web_view, ViewImple
m_content_web_view.on_insert_clipboard_entry(html, "unspecified"_string, "text/plain"_string);
};
m_content_web_view.on_received_console_message = [this](auto message_index) {
handle_console_message(message_index);
m_content_web_view.on_console_message_available = [this](auto message_index) {
console_message_available(message_index);
};
m_content_web_view.on_received_console_messages = [this](auto start_index, auto const& message_types, auto const& messages) {
handle_console_messages(start_index, message_types, messages);
m_content_web_view.on_received_styled_console_messages = [this](auto start_index, auto const& message_types, auto const& messages) {
console_messages_received(start_index, message_types, messages);
};
m_inspector_web_view.enable_inspector_prototype();
@ -257,8 +257,8 @@ InspectorClient::~InspectorClient()
{
m_content_web_view.on_finshed_editing_dom_node = nullptr;
m_content_web_view.on_received_accessibility_tree = nullptr;
m_content_web_view.on_received_console_message = nullptr;
m_content_web_view.on_received_console_messages = nullptr;
m_content_web_view.on_console_message_available = nullptr;
m_content_web_view.on_received_styled_console_messages = nullptr;
m_content_web_view.on_received_dom_node_html = nullptr;
m_content_web_view.on_received_dom_node_properties = nullptr;
m_content_web_view.on_received_dom_tree = nullptr;
@ -700,7 +700,7 @@ void InspectorClient::request_console_messages()
m_waiting_for_messages = true;
}
void InspectorClient::handle_console_message(i32 message_index)
void InspectorClient::console_message_available(i32 message_index)
{
if (message_index <= m_highest_received_message_index) {
dbgln("Notified about console message we already have");
@ -717,7 +717,7 @@ void InspectorClient::handle_console_message(i32 message_index)
request_console_messages();
}
void InspectorClient::handle_console_messages(i32 start_index, ReadonlySpan<String> message_types, ReadonlySpan<String> messages)
void InspectorClient::console_messages_received(i32 start_index, ReadonlySpan<String> message_types, ReadonlySpan<String> messages)
{
auto end_index = start_index + static_cast<i32>(message_types.size()) - 1;
if (end_index <= m_highest_received_message_index) {

View file

@ -57,8 +57,8 @@ private:
void load_cookies();
void request_console_messages();
void handle_console_message(i32 message_index);
void handle_console_messages(i32 start_index, ReadonlySpan<String> message_types, ReadonlySpan<String> messages);
void console_message_available(i32 message_index);
void console_messages_received(i32 start_index, ReadonlySpan<String> message_types, ReadonlySpan<String> messages);
void append_console_source(StringView);
void append_console_message(StringView);

View file

@ -216,8 +216,8 @@ public:
Function<void(Optional<Web::UniqueNodeID> const& node_id)> on_finshed_editing_dom_node;
Function<void(String const&)> on_received_dom_node_html;
Function<void(JsonValue)> on_received_js_console_result;
Function<void(i32 message_id)> on_received_console_message;
Function<void(i32 start_index, Vector<String> const& message_types, Vector<String> const& messages)> on_received_console_messages;
Function<void(i32 message_id)> on_console_message_available;
Function<void(i32 start_index, Vector<String> const& message_types, Vector<String> const& messages)> on_received_styled_console_messages;
Function<void(i32 count_waiting)> on_resource_status_change;
Function<void()> on_restore_window;
Function<void(Gfx::IntPoint)> on_reposition_window;

View file

@ -372,16 +372,16 @@ void WebContentClient::did_execute_js_console_input(u64 page_id, JsonValue const
void WebContentClient::did_output_js_console_message(u64 page_id, i32 message_index)
{
if (auto view = view_for_page_id(page_id); view.has_value()) {
if (view->on_received_console_message)
view->on_received_console_message(message_index);
if (view->on_console_message_available)
view->on_console_message_available(message_index);
}
}
void WebContentClient::did_get_js_console_messages(u64 page_id, i32 start_index, Vector<String> const& message_types, Vector<String> const& messages)
void WebContentClient::did_get_styled_js_console_messages(u64 page_id, i32 start_index, Vector<String> const& message_types, Vector<String> const& messages)
{
if (auto view = view_for_page_id(page_id); view.has_value()) {
if (view->on_received_console_messages)
view->on_received_console_messages(start_index, message_types, messages);
if (view->on_received_styled_console_messages)
view->on_received_styled_console_messages(start_index, message_types, messages);
}
}

View file

@ -81,7 +81,7 @@ private:
virtual void did_get_internal_page_info(u64 page_id, PageInfoType, String const&) override;
virtual void did_execute_js_console_input(u64 page_id, JsonValue const&) override;
virtual void did_output_js_console_message(u64 page_id, i32 message_index) override;
virtual void did_get_js_console_messages(u64 page_id, i32 start_index, Vector<String> const& message_types, Vector<String> const& messages) override;
virtual void did_get_styled_js_console_messages(u64 page_id, i32 start_index, Vector<String> const& message_types, Vector<String> const& messages) override;
virtual void did_change_favicon(u64 page_id, Gfx::ShareableBitmap const&) override;
virtual void did_request_alert(u64 page_id, String const&) override;
virtual void did_request_confirm(u64 page_id, String const&) override;

View file

@ -110,7 +110,7 @@ void InspectorConsoleClient::send_messages(i32 start_index)
messages.append(message.data);
}
m_client->did_get_js_console_messages(start_index, move(message_types), move(messages));
m_client->did_get_styled_js_console_messages(start_index, move(message_types), move(messages));
}
// 2.3. Printer(logLevel, args[, options]), https://console.spec.whatwg.org/#printer

View file

@ -805,9 +805,9 @@ void PageClient::console_peer_did_misbehave(char const* reason)
client().did_misbehave(reason);
}
void PageClient::did_get_js_console_messages(i32 start_index, Vector<String> message_types, Vector<String> messages)
void PageClient::did_get_styled_js_console_messages(i32 start_index, Vector<String> message_types, Vector<String> messages)
{
client().async_did_get_js_console_messages(m_id, start_index, move(message_types), move(messages));
client().async_did_get_styled_js_console_messages(m_id, start_index, move(message_types), move(messages));
}
static void gather_style_sheets(Vector<Web::CSS::StyleSheetIdentifier>& results, Web::CSS::CSSStyleSheet& sheet)

View file

@ -90,7 +90,7 @@ public:
void js_console_request_messages(i32 start_index);
void did_output_js_console_message(i32 message_index);
void console_peer_did_misbehave(char const* reason);
void did_get_js_console_messages(i32 start_index, Vector<String> message_types, Vector<String> messages);
void did_get_styled_js_console_messages(i32 start_index, Vector<String> message_types, Vector<String> messages);
Vector<Web::CSS::StyleSheetIdentifier> list_style_sheets() const;

View file

@ -94,7 +94,7 @@ endpoint WebContentClient
did_execute_js_console_input(u64 page_id, JsonValue result) =|
did_output_js_console_message(u64 page_id, i32 message_index) =|
did_get_js_console_messages(u64 page_id, i32 start_index, Vector<String> message_types, Vector<String> messages) =|
did_get_styled_js_console_messages(u64 page_id, i32 start_index, Vector<String> message_types, Vector<String> messages) =|
did_finish_text_test(u64 page_id, String text) =|
did_set_test_timeout(u64 page_id, double milliseconds) =|