Ladybird/WebView: Move our PageClient to its own file

And rename it to PageClientLadybird while we're at it, it's not
"headless" by any means.
This commit is contained in:
Andreas Kling 2022-09-19 11:06:23 +02:00 committed by Andrew Kaster
parent 97964bc710
commit 4cc82ac638
Notes: sideshowbarker 2024-07-17 06:51:10 +09:00
7 changed files with 414 additions and 290 deletions

View File

@ -54,6 +54,7 @@ set(SOURCES
EventLoopPluginQt.cpp
FontPluginQt.cpp
ImageCodecPluginLadybird.cpp
PageClientLadybird.cpp
RequestManagerQt.cpp
main.cpp
WebView.cpp
@ -62,6 +63,7 @@ set(SOURCES
SettingsDialog.cpp
Tab.cpp
TimerQt.cpp
Utilities.cpp
)
qt_add_executable(ladybird ${SOURCES}

View File

@ -0,0 +1,288 @@
/*
* Copyright (c) 2022, Andreas Kling <kling@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#define AK_DONT_REPLACE_STD
#include "PageClientLadybird.h"
#include "Utilities.h"
#include "WebView.h"
#include <LibCore/System.h>
#include <LibGfx/Painter.h>
#include <LibJS/Runtime/ConsoleObject.h>
#include <LibWeb/DOM/Document.h>
#include <LibWeb/HTML/BrowsingContext.h>
#include <LibWeb/Layout/InitialContainingBlock.h>
#include <LibWeb/Painting/PaintableBox.h>
#include <QIcon>
#include <QMessageBox>
#include <QScrollBar>
#include <QToolTip>
namespace Ladybird {
NonnullOwnPtr<PageClientLadybird> PageClientLadybird::create(WebView& view)
{
return adopt_own(*new PageClientLadybird(view));
}
PageClientLadybird::PageClientLadybird(WebView& view)
: m_view(view)
, m_page(make<Web::Page>(*this))
{
}
Web::Layout::InitialContainingBlock* PageClientLadybird::layout_root()
{
auto* document = page().top_level_browsing_context().active_document();
if (!document)
return nullptr;
return document->layout_node();
}
void PageClientLadybird::load(AK::URL const& url)
{
if (!url.is_valid())
return;
page().load(url);
}
void PageClientLadybird::paint(Gfx::IntRect const& content_rect, Gfx::Bitmap& target)
{
Gfx::Painter painter(target);
if (auto* document = page().top_level_browsing_context().active_document())
document->update_layout();
painter.fill_rect({ {}, content_rect.size() }, palette().base());
auto* layout_root = this->layout_root();
if (!layout_root) {
return;
}
Web::PaintContext context(painter, palette(), content_rect.top_left());
context.set_should_show_line_box_borders(m_should_show_line_box_borders);
context.set_viewport_rect(content_rect);
context.set_has_focus(true);
layout_root->paint_all_phases(context);
}
void PageClientLadybird::setup_palette(Core::AnonymousBuffer theme_buffer)
{
m_palette_impl = Gfx::PaletteImpl::create_with_anonymous_buffer(theme_buffer);
}
void PageClientLadybird::set_viewport_rect(Gfx::IntRect rect)
{
m_viewport_rect = rect;
page().top_level_browsing_context().set_viewport_rect(rect);
}
Gfx::Palette PageClientLadybird::palette() const
{
return Gfx::Palette(*m_palette_impl);
}
Gfx::IntRect PageClientLadybird::screen_rect() const
{
// FIXME: Return the actual screen rect.
return m_viewport_rect;
}
Gfx::IntRect PageClientLadybird::viewport_rect() const
{
return m_viewport_rect;
}
Web::CSS::PreferredColorScheme PageClientLadybird::preferred_color_scheme() const
{
return m_preferred_color_scheme;
}
void PageClientLadybird::page_did_change_title(String const& title)
{
emit m_view.title_changed(title.characters());
}
void PageClientLadybird::page_did_start_loading(AK::URL const& url)
{
emit m_view.load_started(url);
}
void PageClientLadybird::page_did_finish_loading(AK::URL const&)
{
initialize_js_console();
m_console_client->send_messages(0);
}
void PageClientLadybird::initialize_js_console()
{
auto* document = page().top_level_browsing_context().active_document();
auto realm = document->realm().make_weak_ptr();
if (m_realm && m_realm.ptr() == realm.ptr())
return;
m_realm = realm;
auto& console_object = *document->realm().intrinsics().console_object();
m_console_client = make<Ladybird::ConsoleClient>(console_object.console(), *realm, m_view);
console_object.console().set_client(*m_console_client.ptr());
}
void PageClientLadybird::page_did_change_selection()
{
}
void PageClientLadybird::page_did_request_cursor_change(Gfx::StandardCursor cursor)
{
switch (cursor) {
case Gfx::StandardCursor::Hand:
m_view.setCursor(Qt::PointingHandCursor);
break;
case Gfx::StandardCursor::IBeam:
m_view.setCursor(Qt::IBeamCursor);
break;
case Gfx::StandardCursor::Arrow:
default:
m_view.setCursor(Qt::ArrowCursor);
break;
}
}
void PageClientLadybird::page_did_request_context_menu(Gfx::IntPoint const&)
{
}
void PageClientLadybird::page_did_request_link_context_menu(Gfx::IntPoint const&, AK::URL const&, String const&, unsigned)
{
}
void PageClientLadybird::page_did_request_image_context_menu(Gfx::IntPoint const&, AK::URL const&, String const&, unsigned, Gfx::Bitmap const*)
{
}
void PageClientLadybird::page_did_click_link(AK::URL const&, String const&, unsigned)
{
}
void PageClientLadybird::page_did_middle_click_link(AK::URL const&, String const&, unsigned)
{
}
void PageClientLadybird::page_did_enter_tooltip_area(Gfx::IntPoint const& content_position, String const& tooltip)
{
auto widget_position = m_view.to_widget(content_position);
QToolTip::showText(
m_view.mapToGlobal(QPoint(widget_position.x(), widget_position.y())),
qstring_from_akstring(tooltip),
&m_view);
}
void PageClientLadybird::page_did_leave_tooltip_area()
{
QToolTip::hideText();
}
void PageClientLadybird::page_did_hover_link(AK::URL const& url)
{
emit m_view.link_hovered(url.to_string().characters());
}
void PageClientLadybird::page_did_unhover_link()
{
emit m_view.link_unhovered();
}
void PageClientLadybird::page_did_invalidate(Gfx::IntRect const&)
{
m_view.viewport()->update();
}
void PageClientLadybird::page_did_change_favicon(Gfx::Bitmap const& bitmap)
{
auto qimage = QImage(bitmap.scanline_u8(0), bitmap.width(), bitmap.height(), QImage::Format_ARGB32);
if (qimage.isNull())
return;
auto qpixmap = QPixmap::fromImage(qimage);
if (qpixmap.isNull())
return;
emit m_view.favicon_changed(QIcon(qpixmap));
}
void PageClientLadybird::page_did_layout()
{
auto* layout_root = this->layout_root();
VERIFY(layout_root);
Gfx::IntSize content_size;
if (layout_root->paint_box()->has_overflow())
content_size = enclosing_int_rect(layout_root->paint_box()->scrollable_overflow_rect().value()).size();
else
content_size = enclosing_int_rect(layout_root->paint_box()->absolute_rect()).size();
m_view.verticalScrollBar()->setMaximum(content_size.height() - m_viewport_rect.height());
m_view.verticalScrollBar()->setPageStep(m_viewport_rect.height());
m_view.horizontalScrollBar()->setMaximum(content_size.width() - m_viewport_rect.width());
m_view.horizontalScrollBar()->setPageStep(m_viewport_rect.width());
}
void PageClientLadybird::page_did_request_scroll_into_view(Gfx::IntRect const& rect)
{
if (m_viewport_rect.contains(rect))
return;
if (rect.top() < m_viewport_rect.top()) {
m_view.verticalScrollBar()->setValue(rect.top());
} else if (rect.top() > m_viewport_rect.top() && rect.bottom() > m_viewport_rect.bottom()) {
m_view.verticalScrollBar()->setValue(rect.bottom() - m_viewport_rect.height() + 1);
}
}
void PageClientLadybird::page_did_request_alert(String const& message)
{
QMessageBox::warning(&m_view, "Ladybird", qstring_from_akstring(message));
}
bool PageClientLadybird::page_did_request_confirm(String const& message)
{
auto result = QMessageBox::question(&m_view, "Ladybird", qstring_from_akstring(message),
QMessageBox::StandardButton::Ok | QMessageBox::StandardButton::Cancel);
return result == QMessageBox::StandardButton::Ok;
}
String PageClientLadybird::page_did_request_prompt(String const&, String const&)
{
return String::empty();
}
String PageClientLadybird::page_did_request_cookie(AK::URL const& url, Web::Cookie::Source source)
{
return m_cookie_jar.get_cookie(url, source);
}
void PageClientLadybird::page_did_set_cookie(AK::URL const& url, Web::Cookie::ParsedCookie const& cookie, Web::Cookie::Source source)
{
m_cookie_jar.set_cookie(url, cookie, source);
}
void PageClientLadybird::dump_cookies() const
{
m_cookie_jar.dump_cookies();
}
void PageClientLadybird::request_file(NonnullRefPtr<Web::FileRequest>& request)
{
auto const file = Core::System::open(request->path(), O_RDONLY);
request->on_file_request_finish(file);
}
void PageClientLadybird::set_should_show_line_box_borders(bool state)
{
m_should_show_line_box_borders = state;
}
}

View File

@ -0,0 +1,85 @@
/*
* Copyright (c) 2022, Andreas Kling <kling@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include "ConsoleClient.h"
#include "CookieJar.h"
#include <LibGfx/Rect.h>
#include <LibWeb/Page/Page.h>
class WebView;
namespace Ladybird {
class PageClientLadybird final : public Web::PageClient {
public:
static NonnullOwnPtr<PageClientLadybird> create(WebView&);
Web::Page& page() { return *m_page; }
Web::Page const& page() const { return *m_page; }
Web::Layout::InitialContainingBlock* layout_root();
void load(AK::URL const&);
void paint(Gfx::IntRect const& content_rect, Gfx::Bitmap& target);
void setup_palette(Core::AnonymousBuffer theme_buffer);
Gfx::IntRect viewport_rect() const;
void set_viewport_rect(Gfx::IntRect);
// ^Web::PageClient
virtual Gfx::Palette palette() const override;
virtual Gfx::IntRect screen_rect() const override;
virtual Web::CSS::PreferredColorScheme preferred_color_scheme() const override;
virtual void page_did_change_title(String const& title) override;
virtual void page_did_start_loading(AK::URL const& url) override;
virtual void page_did_finish_loading(AK::URL const&) override;
void initialize_js_console();
virtual void page_did_change_selection() override;
virtual void page_did_request_cursor_change(Gfx::StandardCursor) override;
virtual void page_did_request_context_menu(Gfx::IntPoint const&) override;
virtual void page_did_request_link_context_menu(Gfx::IntPoint const&, AK::URL const&, String const&, unsigned) override;
virtual void page_did_request_image_context_menu(Gfx::IntPoint const&, AK::URL const&, String const&, unsigned, Gfx::Bitmap const*) override;
virtual void page_did_click_link(AK::URL const&, String const&, unsigned) override;
virtual void page_did_middle_click_link(AK::URL const&, String const&, unsigned) override;
virtual void page_did_enter_tooltip_area(Gfx::IntPoint const& content_position, String const& tooltip) override;
virtual void page_did_leave_tooltip_area() override;
virtual void page_did_hover_link(AK::URL const& url) override;
virtual void page_did_unhover_link() override;
virtual void page_did_invalidate(Gfx::IntRect const&) override;
virtual void page_did_change_favicon(Gfx::Bitmap const&) override;
virtual void page_did_layout() override;
virtual void page_did_request_scroll_into_view(Gfx::IntRect const&) override;
virtual void page_did_request_alert(String const& message) override;
virtual bool page_did_request_confirm(String const& message) override;
virtual String page_did_request_prompt(String const&, String const&) override;
virtual String page_did_request_cookie(AK::URL const&, Web::Cookie::Source) override;
virtual void page_did_set_cookie(AK::URL const&, Web::Cookie::ParsedCookie const&, Web::Cookie::Source) override;
void dump_cookies() const;
void request_file(NonnullRefPtr<Web::FileRequest>& request) override;
void set_should_show_line_box_borders(bool);
explicit PageClientLadybird(WebView&);
WebView& m_view;
NonnullOwnPtr<Web::Page> m_page;
Browser::CookieJar m_cookie_jar;
OwnPtr<Ladybird::ConsoleClient> m_console_client;
WeakPtr<JS::Realm> m_realm;
RefPtr<Gfx::PaletteImpl> m_palette_impl;
Gfx::IntRect m_viewport_rect { 0, 0, 800, 600 };
Web::CSS::PreferredColorScheme m_preferred_color_scheme { Web::CSS::PreferredColorScheme::Auto };
bool m_should_show_line_box_borders { false };
};
}

19
Ladybird/Utilities.cpp Normal file
View File

@ -0,0 +1,19 @@
/*
* Copyright (c) 2022, Andreas Kling <kling@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#define AK_DONT_REPLACE_STD
#include "Utilities.h"
AK::String akstring_from_qstring(QString const& qstring)
{
return AK::String(qstring.toUtf8().data());
}
QString qstring_from_akstring(AK::String const& akstring)
{
return QString::fromUtf8(akstring.characters(), akstring.length());
}

13
Ladybird/Utilities.h Normal file
View File

@ -0,0 +1,13 @@
/*
* Copyright (c) 2022, Andreas Kling <kling@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/String.h>
#include <QString>
AK::String akstring_from_qstring(QString const&);
QString qstring_from_akstring(AK::String const&);

View File

@ -13,7 +13,9 @@
#include "EventLoopPluginQt.h"
#include "FontPluginQt.h"
#include "ImageCodecPluginLadybird.h"
#include "PageClientLadybird.h"
#include "RequestManagerQt.h"
#include "Utilities.h"
#include <AK/Assertions.h>
#include <AK/ByteBuffer.h>
#include <AK/Format.h>
@ -67,300 +69,13 @@
#include <QToolTip>
#include <QVBoxLayout>
AK::String akstring_from_qstring(QString const& qstring)
{
return AK::String(qstring.toUtf8().data());
}
QString qstring_from_akstring(AK::String const& akstring)
{
return QString::fromUtf8(akstring.characters(), akstring.length());
}
String s_serenity_resource_root;
class HeadlessBrowserPageClient final : public Web::PageClient {
public:
static NonnullOwnPtr<HeadlessBrowserPageClient> create(WebView& view)
{
return adopt_own(*new HeadlessBrowserPageClient(view));
}
Web::Page& page() { return *m_page; }
Web::Page const& page() const { return *m_page; }
Web::Layout::InitialContainingBlock* layout_root()
{
auto* document = page().top_level_browsing_context().active_document();
if (!document)
return nullptr;
return document->layout_node();
}
void load(AK::URL const& url)
{
if (!url.is_valid())
return;
page().load(url);
}
void paint(Gfx::IntRect const& content_rect, Gfx::Bitmap& target)
{
Gfx::Painter painter(target);
if (auto* document = page().top_level_browsing_context().active_document())
document->update_layout();
painter.fill_rect({ {}, content_rect.size() }, palette().base());
auto* layout_root = this->layout_root();
if (!layout_root) {
return;
}
Web::PaintContext context(painter, palette(), content_rect.top_left());
context.set_should_show_line_box_borders(m_should_show_line_box_borders);
context.set_viewport_rect(content_rect);
context.set_has_focus(true);
layout_root->paint_all_phases(context);
}
void setup_palette(Core::AnonymousBuffer theme_buffer)
{
m_palette_impl = Gfx::PaletteImpl::create_with_anonymous_buffer(theme_buffer);
}
void set_viewport_rect(Gfx::IntRect rect)
{
m_viewport_rect = rect;
page().top_level_browsing_context().set_viewport_rect(rect);
}
// ^Web::PageClient
virtual Gfx::Palette palette() const override
{
return Gfx::Palette(*m_palette_impl);
}
virtual Gfx::IntRect screen_rect() const override
{
// FIXME: Return the actual screen rect.
return m_viewport_rect;
}
Gfx::IntRect viewport_rect() const
{
return m_viewport_rect;
}
virtual Web::CSS::PreferredColorScheme preferred_color_scheme() const override
{
return m_preferred_color_scheme;
}
virtual void page_did_change_title(String const& title) override
{
emit m_view.title_changed(title.characters());
}
virtual void page_did_start_loading(AK::URL const& url) override
{
emit m_view.load_started(url);
}
virtual void page_did_finish_loading(AK::URL const&) override
{
initialize_js_console();
m_console_client->send_messages(0);
}
void initialize_js_console()
{
auto* document = page().top_level_browsing_context().active_document();
auto realm = document->realm().make_weak_ptr();
if (m_realm && m_realm.ptr() == realm.ptr())
return;
m_realm = realm;
auto& console_object = *document->realm().intrinsics().console_object();
m_console_client = make<Ladybird::ConsoleClient>(console_object.console(), *realm, m_view);
console_object.console().set_client(*m_console_client.ptr());
}
virtual void page_did_change_selection() override
{
}
virtual void page_did_request_cursor_change(Gfx::StandardCursor cursor) override
{
switch (cursor) {
case Gfx::StandardCursor::Hand:
m_view.setCursor(Qt::PointingHandCursor);
break;
case Gfx::StandardCursor::IBeam:
m_view.setCursor(Qt::IBeamCursor);
break;
case Gfx::StandardCursor::Arrow:
default:
m_view.setCursor(Qt::ArrowCursor);
break;
}
}
virtual void page_did_request_context_menu(Gfx::IntPoint const&) override
{
}
virtual void page_did_request_link_context_menu(Gfx::IntPoint const&, AK::URL const&, String const&, unsigned) override
{
}
virtual void page_did_request_image_context_menu(Gfx::IntPoint const&, AK::URL const&, String const&, unsigned, Gfx::Bitmap const*) override
{
}
virtual void page_did_click_link(AK::URL const&, String const&, unsigned) override
{
}
virtual void page_did_middle_click_link(AK::URL const&, String const&, unsigned) override
{
}
virtual void page_did_enter_tooltip_area(Gfx::IntPoint const& content_position, String const& tooltip) override
{
auto widget_position = m_view.to_widget(content_position);
QToolTip::showText(
m_view.mapToGlobal(QPoint(widget_position.x(), widget_position.y())),
qstring_from_akstring(tooltip),
&m_view);
}
virtual void page_did_leave_tooltip_area() override
{
QToolTip::hideText();
}
virtual void page_did_hover_link(AK::URL const& url) override
{
emit m_view.link_hovered(url.to_string().characters());
}
virtual void page_did_unhover_link() override
{
emit m_view.link_unhovered();
}
virtual void page_did_invalidate(Gfx::IntRect const&) override
{
m_view.viewport()->update();
}
virtual void page_did_change_favicon(Gfx::Bitmap const& bitmap) override
{
auto qimage = QImage(bitmap.scanline_u8(0), bitmap.width(), bitmap.height(), QImage::Format_ARGB32);
if (qimage.isNull())
return;
auto qpixmap = QPixmap::fromImage(qimage);
if (qpixmap.isNull())
return;
emit m_view.favicon_changed(QIcon(qpixmap));
}
virtual void page_did_layout() override
{
auto* layout_root = this->layout_root();
VERIFY(layout_root);
Gfx::IntSize content_size;
if (layout_root->paint_box()->has_overflow())
content_size = enclosing_int_rect(layout_root->paint_box()->scrollable_overflow_rect().value()).size();
else
content_size = enclosing_int_rect(layout_root->paint_box()->absolute_rect()).size();
m_view.verticalScrollBar()->setMaximum(content_size.height() - m_viewport_rect.height());
m_view.verticalScrollBar()->setPageStep(m_viewport_rect.height());
m_view.horizontalScrollBar()->setMaximum(content_size.width() - m_viewport_rect.width());
m_view.horizontalScrollBar()->setPageStep(m_viewport_rect.width());
}
virtual void page_did_request_scroll_into_view(Gfx::IntRect const& rect) override
{
if (m_viewport_rect.contains(rect))
return;
if (rect.top() < m_viewport_rect.top()) {
m_view.verticalScrollBar()->setValue(rect.top());
} else if (rect.top() > m_viewport_rect.top() && rect.bottom() > m_viewport_rect.bottom()) {
m_view.verticalScrollBar()->setValue(rect.bottom() - m_viewport_rect.height() + 1);
}
}
virtual void page_did_request_alert(String const& message) override
{
QMessageBox::warning(&m_view, "Ladybird", qstring_from_akstring(message));
}
virtual bool page_did_request_confirm(String const& message) override
{
auto result = QMessageBox::question(&m_view, "Ladybird", qstring_from_akstring(message),
QMessageBox::StandardButton::Ok | QMessageBox::StandardButton::Cancel);
return result == QMessageBox::StandardButton::Ok;
}
virtual String page_did_request_prompt(String const&, String const&) override
{
return String::empty();
}
virtual String page_did_request_cookie(AK::URL const& url, Web::Cookie::Source source) override
{
return m_cookie_jar.get_cookie(url, source);
}
virtual void page_did_set_cookie(AK::URL const& url, Web::Cookie::ParsedCookie const& cookie, Web::Cookie::Source source) override
{
m_cookie_jar.set_cookie(url, cookie, source);
}
void dump_cookies() const
{
m_cookie_jar.dump_cookies();
}
void request_file(NonnullRefPtr<Web::FileRequest>& request) override
{
auto const file = Core::System::open(request->path(), O_RDONLY);
request->on_file_request_finish(file);
}
void set_should_show_line_box_borders(bool state) { m_should_show_line_box_borders = state; }
HeadlessBrowserPageClient(WebView& view)
: m_view(view)
, m_page(make<Web::Page>(*this))
{
}
WebView& m_view;
NonnullOwnPtr<Web::Page> m_page;
Browser::CookieJar m_cookie_jar;
OwnPtr<Ladybird::ConsoleClient> m_console_client;
WeakPtr<JS::Realm> m_realm;
RefPtr<Gfx::PaletteImpl> m_palette_impl;
Gfx::IntRect m_viewport_rect { 0, 0, 800, 600 };
Web::CSS::PreferredColorScheme m_preferred_color_scheme { Web::CSS::PreferredColorScheme::Auto };
bool m_should_show_line_box_borders { false };
};
WebView::WebView()
{
setMouseTracking(true);
m_page_client = HeadlessBrowserPageClient::create(*this);
m_page_client = Ladybird::PageClientLadybird::create(*this);
m_page_client->setup_palette(Gfx::load_system_theme(String::formatted("{}/res/themes/Default.ini", s_serenity_resource_root)));

View File

@ -17,7 +17,9 @@
class QTextEdit;
class QLineEdit;
class HeadlessBrowserPageClient;
namespace Ladybird {
class PageClientLadybird;
}
enum class ColorScheme {
Auto,
@ -67,7 +69,7 @@ signals:
private:
void update_viewport_rect();
OwnPtr<HeadlessBrowserPageClient> m_page_client;
OwnPtr<Ladybird::PageClientLadybird> m_page_client;
qreal m_inverse_pixel_scaling_ratio { 1.0 };
bool m_should_show_line_box_borders { false };