RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-25 19:57:35 +00:00
Code Issues Activity Actions

Ladybird/Qt: Port the Inspector to the WebView InspectorClient

Browse source
This commit is contained in:
Timothy Flynn 2023-11-23 20:04:54 -05:00 • committed by Andreas Kling
parent 39e32e80cd
commit 52b5bcdb6d
3 changed files with 72 additions and 190 deletions
Download patch file Download diff file Expand all files Collapse all files

168
Ladybird/Qt/InspectorWidget.cpp
View file

@ -6,48 +6,56 @@
#include "InspectorWidget.h" #include "InspectorWidget.h"
#include <AK/JsonObject.h> #include <AK/JsonObject.h>
#include <LibWebView/InspectorClient.h>
#include <QCloseEvent> #include <QCloseEvent>
#include <QHeaderView> #include <QHeaderView>
#include <QSplitter> #include <QSplitter>
#include <QStringList>
#include <QTabWidget> #include <QTabWidget>
#include <QTableView> #include <QTableView>
#include <QTreeView>
#include <QVBoxLayout> #include <QVBoxLayout>
namespace Ladybird { namespace Ladybird {
InspectorWidget::InspectorWidget() extern bool is_using_dark_system_theme(QWidget&);
{
setLayout(new QVBoxLayout);
auto splitter = new QSplitter(this);
layout()->addWidget(splitter);
splitter->setOrientation(Qt::Vertical);
auto add_tab = [&](auto* tab_widget, auto* widget, auto name) { InspectorWidget::InspectorWidget(WebContentView& content_view)
auto container = new QWidget; {
container->setLayout(new QVBoxLayout); m_inspector_view = make<WebContentView>(StringView {}, WebView::EnableCallgrindProfiling::No, UseLagomNetworking::No, WebView::EnableGPUPainting::No);
container->layout()->addWidget(widget);
tab_widget->addTab(container, name); if (is_using_dark_system_theme(*this))
m_inspector_view->update_palette(WebContentView::PaletteMode::Dark);
m_inspector_client = make<WebView::InspectorClient>(content_view, *m_inspector_view);
m_inspector_client->on_dom_node_properties_received = [this](auto properties_or_error) {
if (properties_or_error.is_error()) {
clear_style_json();
} else {
auto properties = properties_or_error.release_value();
load_style_json(properties.computed_style_json, properties.resolved_style_json, properties.custom_properties_json);
}
}; };
auto* top_tab_widget = new QTabWidget; setLayout(new QVBoxLayout);
splitter->addWidget(top_tab_widget);
m_dom_tree_view = new QTreeView; auto* splitter = new QSplitter(this);
m_dom_tree_view->setHeaderHidden(true); splitter->setOrientation(Qt::Vertical);
add_tab(top_tab_widget, m_dom_tree_view, "DOM"); layout()->addWidget(splitter);
m_accessibility_tree_view = new QTreeView; splitter->addWidget(m_inspector_view.ptr());
m_accessibility_tree_view->setHeaderHidden(true); splitter->setStretchFactor(0, 2);
add_tab(top_tab_widget, m_accessibility_tree_view, "Accessibility");
auto add_table_tab = [&](auto* tab_widget, auto name) { auto add_table_tab = [&](auto* tab_widget, auto name) {
auto* table_view = new QTableView; auto* table_view = new QTableView;
table_view->horizontalHeader()->setSectionResizeMode(QHeaderView::Stretch); table_view->horizontalHeader()->setSectionResizeMode(QHeaderView::Stretch);
table_view->verticalHeader()->setVisible(false); table_view->verticalHeader()->setVisible(false);
table_view->horizontalHeader()->setVisible(false); table_view->horizontalHeader()->setVisible(false);
add_tab(tab_widget, table_view, name);
auto* container = new QWidget;
container->setLayout(new QVBoxLayout);
container->layout()->addWidget(table_view);
tab_widget->addTab(container, name);
return table_view; return table_view;
}; };
@ -56,44 +64,32 @@ InspectorWidget::InspectorWidget()
m_resolved_style_table = add_table_tab(node_tabs, "Resolved"); m_resolved_style_table = add_table_tab(node_tabs, "Resolved");
m_custom_properties_table = add_table_tab(node_tabs, "Variables"); m_custom_properties_table = add_table_tab(node_tabs, "Variables");
splitter->addWidget(node_tabs); splitter->addWidget(node_tabs);
setWindowTitle("Inspector");
resize(875, 825);
} }
void InspectorWidget::set_dom_json(StringView dom_json) InspectorWidget::~InspectorWidget() = default;
void InspectorWidget::inspect()
{ {
m_dom_model = TreeModel::create(TreeModel::Type::DOMTree, dom_json).release_value_but_fixme_should_propagate_errors(); m_inspector_client->inspect();
m_dom_tree_view->setModel(m_dom_model);
m_dom_loaded = true;
QObject::connect(m_dom_tree_view->selectionModel(), &QItemSelectionModel::selectionChanged,
[this](QItemSelection const& selected, QItemSelection const&) {
if (auto indexes = selected.indexes(); !indexes.empty())
set_selection(indexes.first());
});
if (m_pending_selection.has_value())
set_selection(m_pending_selection.release_value());
else
select_default_node();
} }
void InspectorWidget::set_accessibility_json(StringView accessibility_json) void InspectorWidget::reset()
{ {
m_accessibility_model = TreeModel::create(TreeModel::Type::AccessibilityTree, accessibility_json).release_value_but_fixme_should_propagate_errors(); m_inspector_client->reset();
m_accessibility_tree_view->setModel(m_accessibility_model);
}
void InspectorWidget::clear_dom_json()
{
m_dom_tree_view->setModel(nullptr);
m_dom_model = nullptr;
// The accessibility tree is pretty much another form of the DOM tree, so should be cleared at the time time.
m_accessibility_tree_view->setModel(nullptr);
m_accessibility_model = nullptr;
clear_style_json(); clear_style_json();
clear_selection(); }
m_dom_loaded = false;
void InspectorWidget::select_hovered_node()
{
m_inspector_client->select_hovered_node();
}
void InspectorWidget::select_default_node()
{
m_inspector_client->select_default_node();
} }
void InspectorWidget::load_style_json(StringView computed_style_json, StringView resolved_style_json, StringView custom_properties_json) void InspectorWidget::load_style_json(StringView computed_style_json, StringView resolved_style_json, StringView custom_properties_json)
@ -118,76 +114,12 @@ void InspectorWidget::clear_style_json()
m_custom_properties_table->setModel(nullptr); m_custom_properties_table->setModel(nullptr);
m_custom_properties_model = nullptr; m_custom_properties_model = nullptr;
clear_selection();
} }
void InspectorWidget::closeEvent(QCloseEvent* event) void InspectorWidget::closeEvent(QCloseEvent* event)
{ {
event->accept(); event->accept();
if (on_close) m_inspector_client->clear_selection();
on_close();
clear_selection();
}
void InspectorWidget::clear_selection()
{
m_selection = {};
m_dom_tree_view->clearSelection();
}
void InspectorWidget::set_selection(Selection selection)
{
if (!m_dom_loaded) {
m_pending_selection = selection;
return;
}
auto index = m_dom_model->index_for_node(selection.dom_node_id, selection.pseudo_element);
if (!index.isValid()) {
dbgln("Failed to set DOM inspector selection! Could not find valid model index for node: {}", selection.dom_node_id);
return;
}
m_dom_tree_view->scrollTo(index);
m_dom_tree_view->setCurrentIndex(index);
}
void InspectorWidget::select_default_node()
{
clear_style_json();
m_dom_tree_view->collapseAll();
m_dom_tree_view->setCurrentIndex({});
}
void InspectorWidget::set_selection(QModelIndex const& index)
{
if (!index.isValid())
return;
auto const* json = static_cast<JsonObject const*>(index.constInternalPointer());
VERIFY(json);
Selection selection {};
if (json->has_u32("pseudo-element"sv)) {
selection.dom_node_id = json->get_i32("parent-id"sv).value();
selection.pseudo_element = static_cast<Web::CSS::Selector::PseudoElement>(json->get_u32("pseudo-element"sv).value());
} else {
selection.dom_node_id = json->get_i32("id"sv).value();
}
if (selection == m_selection)
return;
m_selection = selection;
VERIFY(on_dom_node_inspected);
auto maybe_inspected_node_properties = on_dom_node_inspected(m_selection.dom_node_id, m_selection.pseudo_element);
if (!maybe_inspected_node_properties.is_error()) {
auto properties = maybe_inspected_node_properties.release_value();
load_style_json(properties.computed_style_json, properties.resolved_style_json, properties.custom_properties_json);
} else {
clear_style_json();
}
} }
} }

45
Ladybird/Qt/InspectorWidget.h
View file

@ -8,66 +8,45 @@
#include "ModelAdapter.h" #include "ModelAdapter.h"
#include "WebContentView.h" #include "WebContentView.h"
#include <AK/Optional.h>
#include <AK/StringView.h> #include <AK/StringView.h>
#include <LibWeb/CSS/Selector.h> #include <LibWebView/Forward.h>
#include <QWidget> #include <QWidget>
class QTreeView;
class QTableView; class QTableView;
namespace Ladybird { namespace Ladybird {
class WebContentView;
class InspectorWidget final : public QWidget { class InspectorWidget final : public QWidget {
Q_OBJECT Q_OBJECT
public: public:
InspectorWidget(); explicit InspectorWidget(WebContentView& content_view);
virtual ~InspectorWidget() = default; virtual ~InspectorWidget() override;
struct Selection { void inspect();
i32 dom_node_id { 0 }; void reset();
Optional<Web::CSS::Selector::PseudoElement> pseudo_element {};
bool operator==(Selection const& other) const = default;
};
bool dom_loaded() const { return m_dom_loaded; }
void set_selection(Selection);
void clear_selection();
void select_hovered_node();
void select_default_node(); void select_default_node();
void clear_dom_json(); private:
void set_dom_json(StringView dom_json);
void set_accessibility_json(StringView accessibility_json);
void load_style_json(StringView computed_style_json, StringView resolved_style_json, StringView custom_properties_json); void load_style_json(StringView computed_style_json, StringView resolved_style_json, StringView custom_properties_json);
void clear_style_json(); void clear_style_json();
Function<ErrorOr<WebContentView::DOMNodeProperties>(i32, Optional<Web::CSS::Selector::PseudoElement>)> on_dom_node_inspected;
Function<void()> on_close;
private:
void set_selection(QModelIndex const&);
void closeEvent(QCloseEvent*) override; void closeEvent(QCloseEvent*) override;
Selection m_selection; OwnPtr<WebContentView> m_inspector_view;
OwnPtr<WebView::InspectorClient> m_inspector_client;
OwnPtr<TreeModel> m_dom_model;
OwnPtr<TreeModel> m_accessibility_model;
OwnPtr<PropertyTableModel> m_computed_style_model; OwnPtr<PropertyTableModel> m_computed_style_model;
OwnPtr<PropertyTableModel> m_resolved_style_model; OwnPtr<PropertyTableModel> m_resolved_style_model;
OwnPtr<PropertyTableModel> m_custom_properties_model; OwnPtr<PropertyTableModel> m_custom_properties_model;
QTreeView* m_dom_tree_view { nullptr };
QTreeView* m_accessibility_tree_view { nullptr };
QTableView* m_computed_style_table { nullptr }; QTableView* m_computed_style_table { nullptr };
QTableView* m_resolved_style_table { nullptr }; QTableView* m_resolved_style_table { nullptr };
QTableView* m_custom_properties_table { nullptr }; QTableView* m_custom_properties_table { nullptr };
bool m_dom_loaded { false };
Optional<Selection> m_pending_selection {};
}; };
} }

49
Ladybird/Qt/Tab.cpp
View file

@ -138,17 +138,15 @@ Tab::Tab(BrowserWindow* window, StringView webdriver_content_ipc_path, WebView::
m_window->reload_action().setEnabled(!m_history.is_empty()); m_window->reload_action().setEnabled(!m_history.is_empty());
if (m_inspector_widget) if (m_inspector_widget)
m_inspector_widget->clear_dom_json(); m_inspector_widget->reset();
if (m_console_widget) if (m_console_widget)
m_console_widget->reset(); m_console_widget->reset();
}; };
view().on_load_finish = [this](auto&) { view().on_load_finish = [this](auto&) {
if (m_inspector_widget != nullptr && m_inspector_widget->isVisible()) { if (m_inspector_widget != nullptr && m_inspector_widget->isVisible())
view().inspect_dom_tree(); m_inspector_widget->inspect();
view().inspect_accessibility_tree();
}
}; };
QObject::connect(m_location_edit, &QLineEdit::returnPressed, this, &Tab::location_edit_return_pressed); QObject::connect(m_location_edit, &QLineEdit::returnPressed, this, &Tab::location_edit_return_pressed);
@ -280,16 +278,6 @@ Tab::Tab(BrowserWindow* window, StringView webdriver_content_ipc_path, WebView::
return Gfx::IntRect { m_window->x(), m_window->y(), m_window->width(), m_window->height() }; return Gfx::IntRect { m_window->x(), m_window->y(), m_window->width(), m_window->height() };
}; };
view().on_received_dom_tree = [this](auto& dom_tree) {
if (m_inspector_widget)
m_inspector_widget->set_dom_json(dom_tree);
};
view().on_received_accessibility_tree = [this](auto& accessibility_tree) {
if (m_inspector_widget)
m_inspector_widget->set_accessibility_json(accessibility_tree);
};
view().on_insert_clipboard_entry = [](auto const& data, auto const&, auto const& mime_type) { view().on_insert_clipboard_entry = [](auto const& data, auto const&, auto const& mime_type) {
QByteArray qdata { data.bytes_as_string_view().characters_without_null_termination(), static_cast<qsizetype>(data.bytes_as_string_view().length()) }; QByteArray qdata { data.bytes_as_string_view().characters_without_null_termination(), static_cast<qsizetype>(data.bytes_as_string_view().length()) };
@ -705,34 +693,17 @@ void Tab::recreate_toolbar_icons()
void Tab::show_inspector_window(InspectorTarget inspector_target) void Tab::show_inspector_window(InspectorTarget inspector_target)
{ {
bool inspector_previously_loaded = m_inspector_widget != nullptr; if (!m_inspector_widget)
m_inspector_widget = new Ladybird::InspectorWidget(view());
if (!m_inspector_widget) {
m_inspector_widget = new Ladybird::InspectorWidget;
m_inspector_widget->setWindowTitle("Inspector");
m_inspector_widget->resize(640, 480);
m_inspector_widget->on_close = [this] {
view().clear_inspected_dom_node();
};
m_inspector_widget->on_dom_node_inspected = [&](auto id, auto pseudo_element) {
return view().inspect_dom_node(id, pseudo_element);
};
}
if (!inspector_previously_loaded || !m_inspector_widget->dom_loaded()) {
view().inspect_dom_tree();
view().inspect_accessibility_tree();
}
m_inspector_widget->show(); m_inspector_widget->show();
m_inspector_widget->activateWindow();
m_inspector_widget->raise();
if (inspector_target == InspectorTarget::HoveredElement) { if (inspector_target == InspectorTarget::HoveredElement)
auto hovered_node = view().get_hovered_node_id(); m_inspector_widget->select_hovered_node();
m_inspector_widget->set_selection({ hovered_node }); else
} else {
m_inspector_widget->select_default_node(); m_inspector_widget->select_default_node();
}
} }
void Tab::show_console_window() void Tab::show_console_window()