Stowage/ladybird
2
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-10-19 15:43:20 +00:00
Code Issues Projects Releases Packages Wiki Activity
ladybird/Libraries/LibDevTools/DevToolsDelegate.h

62 lines
3 KiB
C
Raw Normal View History

LibDevTools: Introduce a Firefox DevTools server library To aid with debugging web page issues in Ladybird without needing to implement a fully fledged inspector, we can implement the Firefox DevTools protocol and use their DevTools. The protocol is described here: https://firefox-source-docs.mozilla.org/devtools/backend/protocol.html This commit contains just enough to connect to Ladybird from a DevTools client.
2025-02-15 07:35:58 -05:00
/*
* Copyright (c) 2025, Tim Flynn <trflynn89@ladybird.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
LibDevTools: Implement enough of the protocol to inspect tabs There is a lot needed all at once to actually inspect a tab's DOM tree. It begins with requesting a "watcher" from a TabActor. It seems there can be many types of watchers, but here we implement the "frame" watcher only. The watcher creates an "inspector", which in turn creates a "walker", which is the actor ultimately responsible for serializing and inspecting the DOM tree. In between all that, the DevTools client will send a handful of other informational requests. If we do not reply to these, the client will not move forward with the walker. For example, the CSSPropertiesActor will be asked for a list of all known CSS properties.
2025-02-15 07:57:36 -05:00
#include <AK/Error.h>
#include <AK/Function.h>
#include <AK/JsonValue.h>
LibDevTools: Implement enough of the protocol to see a tab list Previously, we could connect to our DevTools server from Firefox, but could not see any information on Ladybird's opened tabs. This implements enough of the protocol to see a tab list, but we cannot yet inspect the tabs.
2025-02-15 07:53:57 -05:00
#include <AK/Vector.h>
LibDevTools: Implement enough of the protocol to inspect tabs There is a lot needed all at once to actually inspect a tab's DOM tree. It begins with requesting a "watcher" from a TabActor. It seems there can be many types of watchers, but here we implement the "frame" watcher only. The watcher creates an "inspector", which in turn creates a "walker", which is the actor ultimately responsible for serializing and inspecting the DOM tree. In between all that, the DevTools client will send a handful of other informational requests. If we do not reply to these, the client will not move forward with the walker. For example, the CSSPropertiesActor will be asked for a list of all known CSS properties.
2025-02-15 07:57:36 -05:00
#include <LibDevTools/Actors/CSSPropertiesActor.h>
LibDevTools+LibWebView: Avoid dependence on LibWebView from LibDevTools LibDevTools was implicitly including generated IPC endpoints from LibWebView. This is not a dependency declared in the CMakeLists.txt. So updates to the IPC file might not have caused the endpoint header to be regenerated by the time LibDevTools is compiled, resulting in a build error. This patch removes that implicit dependency entirely.
2025-02-26 17:23:10 -05:00
#include <LibDevTools/Actors/PageStyleActor.h>
LibDevTools: Implement enough of the protocol to see a tab list Previously, we could connect to our DevTools server from Firefox, but could not see any information on Ladybird's opened tabs. This implements enough of the protocol to see a tab list, but we cannot yet inspect the tabs.
2025-02-15 07:53:57 -05:00
#include <LibDevTools/Actors/TabActor.h>
LibDevTools: Introduce a Firefox DevTools server library To aid with debugging web page issues in Ladybird without needing to implement a fully fledged inspector, we can implement the Firefox DevTools protocol and use their DevTools. The protocol is described here: https://firefox-source-docs.mozilla.org/devtools/backend/protocol.html This commit contains just enough to connect to Ladybird from a DevTools client.
2025-02-15 07:35:58 -05:00
#include <LibDevTools/Forward.h>
LibDevTools: Support highlighting DOM nodes hovered in the inspector
2025-02-20 08:58:35 -05:00
#include <LibWeb/CSS/Selector.h>
#include <LibWeb/Forward.h>
LibDevTools+LibWebView: Implement basic support for console logging This implements support for basic usage of console.log and friends. It does not implement console.assert, console.trace, console.group, etc.
2025-03-04 08:45:36 -05:00
#include <LibWebView/Forward.h>
LibDevTools: Introduce a Firefox DevTools server library To aid with debugging web page issues in Ladybird without needing to implement a fully fledged inspector, we can implement the Firefox DevTools protocol and use their DevTools. The protocol is described here: https://firefox-source-docs.mozilla.org/devtools/backend/protocol.html This commit contains just enough to connect to Ladybird from a DevTools client.
2025-02-15 07:35:58 -05:00
namespace DevTools {
class DevToolsDelegate {
public:
virtual ~DevToolsDelegate() = default;
LibDevTools: Implement enough of the protocol to see a tab list Previously, we could connect to our DevTools server from Firefox, but could not see any information on Ladybird's opened tabs. This implements enough of the protocol to see a tab list, but we cannot yet inspect the tabs.
2025-02-15 07:53:57 -05:00
virtual Vector<TabDescription> tab_list() const { return {}; }
LibDevTools: Implement enough of the protocol to inspect tabs There is a lot needed all at once to actually inspect a tab's DOM tree. It begins with requesting a "watcher" from a TabActor. It seems there can be many types of watchers, but here we implement the "frame" watcher only. The watcher creates an "inspector", which in turn creates a "walker", which is the actor ultimately responsible for serializing and inspecting the DOM tree. In between all that, the DevTools client will send a handful of other informational requests. If we do not reply to these, the client will not move forward with the walker. For example, the CSSPropertiesActor will be asked for a list of all known CSS properties.
2025-02-15 07:57:36 -05:00
virtual Vector<CSSProperty> css_property_list() const { return {}; }
using OnTabInspectionComplete = Function<void(ErrorOr<JsonValue>)>;
virtual void inspect_tab(TabDescription const&, OnTabInspectionComplete) const { }
LibDevTools: Support highlighting DOM nodes hovered in the inspector
2025-02-20 08:58:35 -05:00
LibDevTools+LibWebView: Avoid dependence on LibWebView from LibDevTools LibDevTools was implicitly including generated IPC endpoints from LibWebView. This is not a dependency declared in the CMakeLists.txt. So updates to the IPC file might not have caused the endpoint header to be regenerated by the time LibDevTools is compiled, resulting in a build error. This patch removes that implicit dependency entirely.
2025-02-26 17:23:10 -05:00
using OnDOMNodeInspectionComplete = Function<void(ErrorOr<DOMNodeProperties>)>;
LibDevTools: Support inspecting DOM node box models and computed styles
2025-02-21 16:20:53 -05:00
virtual void inspect_dom_node(TabDescription const&, Web::UniqueNodeID, Optional<Web::CSS::Selector::PseudoElement::Type>, OnDOMNodeInspectionComplete) const { }
virtual void clear_inspected_dom_node(TabDescription const&) const { }
LibDevTools: Support highlighting DOM nodes hovered in the inspector
2025-02-20 08:58:35 -05:00
virtual void highlight_dom_node(TabDescription const&, Web::UniqueNodeID, Optional<Web::CSS::Selector::PseudoElement::Type>) const { }
virtual void clear_highlighted_dom_node(TabDescription const&) const { }
LibDevTools: Begin supporting the JavaScript console This implements enough to execute JavaScript and reply with the result. We do not yet support autocomplete or eager evaluation.
2025-02-24 11:55:46 -05:00
LibDevTools+LibWebView: Inform the DevTools client about DOM mutations
2025-03-06 19:56:03 -05:00
using OnDOMMutationReceived = Function<void(WebView::Mutation)>;
virtual void listen_for_dom_mutations(TabDescription const&, OnDOMMutationReceived) const { }
virtual void stop_listening_for_dom_mutations(TabDescription const&) const { }
LibDevTools+LibWebView: Implement requests to edit DOM node text
2025-03-06 19:56:40 -05:00
using OnDOMNodeEditComplete = Function<void(ErrorOr<Web::UniqueNodeID>)>;
virtual void set_dom_node_text(TabDescription const&, Web::UniqueNodeID, String, OnDOMNodeEditComplete) const { }
LibDevTools+LibWebView: Implement requests to edit DOM node tags
2025-03-07 09:26:36 -05:00
virtual void set_dom_node_tag(TabDescription const&, Web::UniqueNodeID, String, OnDOMNodeEditComplete) const { }
LibDevTools+LibWebView: Implement requests to edit DOM node attributes
2025-03-05 16:58:38 -05:00
virtual void add_dom_node_attributes(TabDescription const&, Web::UniqueNodeID, Vector<WebView::Attribute>, OnDOMNodeEditComplete) const { }
virtual void replace_dom_node_attribute(TabDescription const&, Web::UniqueNodeID, String, Vector<WebView::Attribute>, OnDOMNodeEditComplete) const { }
LibDevTools+LibWebView: Implement requests to delete DOM nodes
2025-03-06 20:08:27 -05:00
virtual void remove_dom_node(TabDescription const&, Web::UniqueNodeID, OnDOMNodeEditComplete) const { }
LibDevTools+LibWebView: Implement requests to edit DOM node text
2025-03-06 19:56:40 -05:00
LibDevTools: Begin supporting the JavaScript console This implements enough to execute JavaScript and reply with the result. We do not yet support autocomplete or eager evaluation.
2025-02-24 11:55:46 -05:00
using OnScriptEvaluationComplete = Function<void(ErrorOr<JsonValue>)>;
virtual void evaluate_javascript(TabDescription const&, String, OnScriptEvaluationComplete) const { }
LibDevTools+LibWebView: Implement basic support for console logging This implements support for basic usage of console.log and friends. It does not implement console.assert, console.trace, console.group, etc.
2025-03-04 08:45:36 -05:00
using OnConsoleMessageAvailable = Function<void(i32 message_id)>;
using OnReceivedConsoleMessages = Function<void(i32 start_index, Vector<WebView::ConsoleOutput>)>;
virtual void listen_for_console_messages(TabDescription const&, OnConsoleMessageAvailable, OnReceivedConsoleMessages) const { }
virtual void stop_listening_for_console_messages(TabDescription const&) const { }
virtual void request_console_messages(TabDescription const&, i32) const { }
LibDevTools: Introduce a Firefox DevTools server library To aid with debugging web page issues in Ladybird without needing to implement a fully fledged inspector, we can implement the Firefox DevTools protocol and use their DevTools. The protocol is described here: https://firefox-source-docs.mozilla.org/devtools/backend/protocol.html This commit contains just enough to connect to Ladybird from a DevTools client.
2025-02-15 07:35:58 -05:00
};
}
Reference in a new issue Copy permalink