beenull/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-11-26 01:20:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6
ladybird/Userland/Libraries/LibWeb/Page/Page.h

123 lines
5.2 KiB
C
Raw Normal View History

LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
/*
LibWeb: Remove low-hanging LibGUI fruit from LibWeb We'll want to remove the LibGUI dependency from the WebContent process. This is the first basic step of removing unnecessary LibGUI includes and swapping out GUI::Painter for Gfx::Painter.
2021-02-10 07:25:35 +00:00
* Copyright (c) 2020-2021, Andreas Kling <kling@serenityos.org>
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
*
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt *
2021-04-22 08:24:48 +00:00
* SPDX-License-Identifier: BSD-2-Clause
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
*/
#pragma once
#include <AK/Noncopyable.h>
#include <AK/OwnPtr.h>
#include <AK/RefPtr.h>
ProtocolServer+LibWeb: Support more detailed HTTP requests This patch adds the ability for ProtocolServer clients to specify which HTTP method to use, and also to include an optional HTTP request body.
2020-09-28 09:55:26 +00:00
#include <AK/URL.h>
LibWeb: Remove low-hanging LibGUI fruit from LibWeb We'll want to remove the LibGUI dependency from the WebContent process. This is the first basic step of removing unnecessary LibGUI includes and swapping out GUI::Painter for Gfx::Painter.
2021-02-10 07:25:35 +00:00
#include <AK/WeakPtr.h>
#include <AK/Weakable.h>
LibWeb: Allow inserting text at the cursor by typing characters :^) This works everywhere right now, but it's obviously not going to stay that way forever. :^) Note that this does not advance the cursor correctly for whitespace since the cursor is DOM-based and doesn't take whitespace collapsing into account yet.
2020-08-02 10:10:01 +00:00
#include <Kernel/API/KeyCode.h>
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
#include <LibGfx/Forward.h>
#include <LibGfx/Palette.h>
LibWeb: Remove low-hanging LibGUI fruit from LibWeb We'll want to remove the LibGUI dependency from the WebContent process. This is the first basic step of removing unnecessary LibGUI includes and swapping out GUI::Painter for Gfx::Painter.
2021-02-10 07:25:35 +00:00
#include <LibGfx/StandardCursor.h>
LibWeb+WebContent: Add set_preferred_color_scheme IPC call This allows the owner of a WebView to override whether to use a dark theme or not, instead of just using the system theme's IsDark property.
2021-10-26 16:00:10 +00:00
#include <LibWeb/CSS/PreferredColorScheme.h>
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
#include <LibWeb/Forward.h>
Browser+LibWeb+WebContent: Allow Browser to load local files To achieve this goal: - The Browser unveils "/tmp/portal/filesystemaccess" - Pass the page through LoadRequest => ResourceLoader - ResourceLoader requests a file to the FileSystemAccessServer via IPC - OutOfProcessWebView handles it and sends a file descriptor back to the Page.
2022-02-26 16:50:31 +00:00
#include <LibWeb/Loader/FileRequest.h>
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
namespace Web {
class PageClient;
LibWeb: Make Frame point weakly to Page This patch makes Page weakable and allows page-less frames to exist. Page is single-owner, and Frame is multiple-owner, so it's not sound for Frame to assume its containing Page will stick around for its own entire lifetime. Fixes #3976.
2020-11-12 17:23:05 +00:00
class Page : public Weakable<Page> {
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
AK_MAKE_NONCOPYABLE(Page);
AK_MAKE_NONMOVABLE(Page);
public:
explicit Page(PageClient&);
~Page();
PageClient& client() { return m_client; }
Everywhere: Run clang-format
2022-04-01 17:58:27 +00:00
PageClient const& client() const { return m_client; }
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
LibWeb: Move BrowsingContext into HTML/ Browsing contexts are defined by the HTML specification, so let's move them into the HTML directory. :^)
2021-11-18 14:01:28 +00:00
HTML::BrowsingContext& top_level_browsing_context() { return *m_top_level_browsing_context; }
HTML::BrowsingContext const& top_level_browsing_context() const { return *m_top_level_browsing_context; }
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
LibWeb: Move BrowsingContext into HTML/ Browsing contexts are defined by the HTML specification, so let's move them into the HTML directory. :^)
2021-11-18 14:01:28 +00:00
HTML::BrowsingContext& focused_context();
HTML::BrowsingContext const& focused_context() const { return const_cast<Page*>(this)->focused_context(); }
LibWeb: Add "focused frame" concept, one focused Frame per Page Focus currently only moves when doing a mousedown in a frame.
2020-08-14 09:33:20 +00:00
LibWeb: Move BrowsingContext into HTML/ Browsing contexts are defined by the HTML specification, so let's move them into the HTML directory. :^)
2021-11-18 14:01:28 +00:00
void set_focused_browsing_context(Badge<EventHandler>, HTML::BrowsingContext&);
LibWeb: Add "focused frame" concept, one focused Frame per Page Focus currently only moves when doing a mousedown in a frame.
2020-08-14 09:33:20 +00:00
LibWeb: Add the Web::URL namespace and move URLEncoder to it This namespace will be used for all interfaces defined in the URL specification, like URL and URLSearchParams. This has the unfortunate side-effect of requiring us to use the fully qualified AK::URL name whenever we want to refer to the AK class, so this commit also fixes all such references.
2021-09-12 21:33:23 +00:00
void load(const AK::URL&);
LibWeb: Start tracking elapsed time when a resource is loaded
2021-09-12 04:15:15 +00:00
void load(LoadRequest&);
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
Everywhere: Pass AK::StringView by value
2021-11-10 23:55:02 +00:00
void load_html(StringView, const AK::URL&);
LibWeb: Add OutOfProcessWebView::load_html()
2020-10-08 20:11:01 +00:00
Everywhere: Run clang-format
2022-04-01 17:58:27 +00:00
bool handle_mouseup(Gfx::IntPoint const&, unsigned button, unsigned modifiers);
bool handle_mousedown(Gfx::IntPoint const&, unsigned button, unsigned modifiers);
bool handle_mousemove(Gfx::IntPoint const&, unsigned buttons, unsigned modifiers);
bool handle_mousewheel(Gfx::IntPoint const&, unsigned button, unsigned modifiers, int wheel_delta_x, int wheel_delta_y);
LibWeb+LibWebView+WebContent: Get doubleclick events from LibGUI
2022-06-14 17:38:32 +00:00
bool handle_doubleclick(Gfx::IntPoint const&, unsigned buttons, unsigned modifiers);
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
LibWeb: Allow inserting text at the cursor by typing characters :^) This works everywhere right now, but it's obviously not going to stay that way forever. :^) Note that this does not advance the cursor correctly for whitespace since the cursor is DOM-based and doesn't take whitespace collapsing into account yet.
2020-08-02 10:10:01 +00:00
bool handle_keydown(KeyCode, unsigned modifiers, u32 code_point);
LibWeb: Fire "keyup" events as well :^) This was easy, now that we have KeyboardEvent.
2021-09-28 13:39:35 +00:00
bool handle_keyup(KeyCode, unsigned modifiers, u32 code_point);
LibWeb: Allow inserting text at the cursor by typing characters :^) This works everywhere right now, but it's obviously not going to stay that way forever. :^) Note that this does not advance the cursor correctly for whitespace since the cursor is DOM-based and doesn't take whitespace collapsing into account yet.
2020-08-02 10:10:01 +00:00
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
Gfx::Palette palette() const;
LibWeb+WebContent: Keep track of screen rect It is now possible to get the up-to-date screen rect from a Web::Page.
2021-04-03 22:12:37 +00:00
Gfx::IntRect screen_rect() const;
LibWeb+WebContent: Add set_preferred_color_scheme IPC call This allows the owner of a WebView to override whether to use a dark theme or not, instead of just using the system theme's IsDark property.
2021-10-26 16:00:10 +00:00
CSS::PreferredColorScheme preferred_color_scheme() const;
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
LibWeb+Browser: Add Debug menu action for toggling Same-Origin Policy Sometimes it's useful to turn off the SOP for testing purposes. Let's make that easy by having a Debug menu item for it. :^)
2021-09-12 00:10:43 +00:00
bool is_same_origin_policy_enabled() const { return m_same_origin_policy_enabled; }
void set_same_origin_policy_enabled(bool b) { m_same_origin_policy_enabled = b; }
LibWeb: Add 'is scripting enabled' concept to EnvironmentSettingsObject This is now the source of truth for 'user enabled/disabled scripting', but it has to ask the window's page, which actually stores the setting. Also use this new functionality in two places where it was previously marked as a FIXME.
2022-03-30 21:42:09 +00:00
bool is_scripting_enabled() const { return m_is_scripting_enabled; }
void set_is_scripting_enabled(bool b) { m_is_scripting_enabled = b; }
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
private:
PageClient& m_client;
LibWeb: Move BrowsingContext into HTML/ Browsing contexts are defined by the HTML specification, so let's move them into the HTML directory. :^)
2021-11-18 14:01:28 +00:00
RefPtr<HTML::BrowsingContext> m_top_level_browsing_context;
WeakPtr<HTML::BrowsingContext> m_focused_context;
LibWeb+Browser: Add Debug menu action for toggling Same-Origin Policy Sometimes it's useful to turn off the SOP for testing purposes. Let's make that easy by having a Debug menu item for it. :^)
2021-09-12 00:10:43 +00:00
LibWeb+Browser: Disable Same-Origin Policy by default for now Until we have CORS preflight checks working, this is only getting in the way of testing and I have to disable it manually all the time.
2021-10-03 21:39:07 +00:00
// FIXME: Enable this by default once CORS preflight checks are supported.
bool m_same_origin_policy_enabled { false };
LibWeb: Add 'is scripting enabled' concept to EnvironmentSettingsObject This is now the source of truth for 'user enabled/disabled scripting', but it has to ask the window's page, which actually stores the setting. Also use this new functionality in two places where it was previously marked as a FIXME.
2022-03-30 21:42:09 +00:00
bool m_is_scripting_enabled { true };
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
};
class PageClient {
public:
LibWeb: Add PageClient::palette() for view-agnostic palette access
2020-06-17 18:26:59 +00:00
virtual Gfx::Palette palette() const = 0;
LibWeb+WebContent: Keep track of screen rect It is now possible to get the up-to-date screen rect from a Web::Page.
2021-04-03 22:12:37 +00:00
virtual Gfx::IntRect screen_rect() const = 0;
LibWeb+WebContent: Add set_preferred_color_scheme IPC call This allows the owner of a WebView to override whether to use a dark theme or not, instead of just using the system theme's IsDark property.
2021-10-26 16:00:10 +00:00
virtual CSS::PreferredColorScheme preferred_color_scheme() const = 0;
Everywhere: Run clang-format
2022-04-01 17:58:27 +00:00
virtual void page_did_change_title(String const&) { }
LibWeb: Add the Web::URL namespace and move URLEncoder to it This namespace will be used for all interfaces defined in the URL specification, like URL and URLSearchParams. This has the unfortunate side-effect of requiring us to use the fully qualified AK::URL name whenever we want to refer to the AK class, so this commit also fixes all such references.
2021-09-12 21:33:23 +00:00
virtual void page_did_start_loading(const AK::URL&) { }
LibWeb+WebContent: Setup the js console client earlier This allows us to print messages in inline scripts. Also add an example of this in the welcome page to test this.
2022-09-21 15:12:00 +00:00
virtual void page_did_create_main_document() { }
LibWeb: Add the Web::URL namespace and move URLEncoder to it This namespace will be used for all interfaces defined in the URL specification, like URL and URLSearchParams. This has the unfortunate side-effect of requiring us to use the fully qualified AK::URL name whenever we want to refer to the AK class, so this commit also fixes all such references.
2021-09-12 21:33:23 +00:00
virtual void page_did_finish_loading(const AK::URL&) { }
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
virtual void page_did_change_selection() { }
LibGfx: Move StandardCursor enum to LibGfx This enum existed both in LibGUI and WindowServer which was silly and error-prone.
2020-09-10 17:25:13 +00:00
virtual void page_did_request_cursor_change(Gfx::StandardCursor) { }
Everywhere: Run clang-format
2022-04-01 17:58:27 +00:00
virtual void page_did_request_context_menu(Gfx::IntPoint const&) { }
virtual void page_did_request_link_context_menu(Gfx::IntPoint const&, const AK::URL&, [[maybe_unused]] String const& target, [[maybe_unused]] unsigned modifiers) { }
virtual void page_did_request_image_context_menu(Gfx::IntPoint const&, const AK::URL&, [[maybe_unused]] String const& target, [[maybe_unused]] unsigned modifiers, Gfx::Bitmap const*) { }
virtual void page_did_click_link(const AK::URL&, [[maybe_unused]] String const& target, [[maybe_unused]] unsigned modifiers) { }
virtual void page_did_middle_click_link(const AK::URL&, [[maybe_unused]] String const& target, [[maybe_unused]] unsigned modifiers) { }
virtual void page_did_enter_tooltip_area(Gfx::IntPoint const&, String const&) { }
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
virtual void page_did_leave_tooltip_area() { }
LibWeb: Add the Web::URL namespace and move URLEncoder to it This namespace will be used for all interfaces defined in the URL specification, like URL and URLSearchParams. This has the unfortunate side-effect of requiring us to use the fully qualified AK::URL name whenever we want to refer to the AK class, so this commit also fixes all such references.
2021-09-12 21:33:23 +00:00
virtual void page_did_hover_link(const AK::URL&) { }
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
virtual void page_did_unhover_link() { }
Everywhere: Run clang-format
2022-04-01 17:58:27 +00:00
virtual void page_did_invalidate(Gfx::IntRect const&) { }
virtual void page_did_change_favicon(Gfx::Bitmap const&) { }
LibWeb: Update PageView content size on page relayout If the layout changes and the page becomes taller or shorter for some reason, we need to update the PageView's scrollable content size.
2020-06-23 16:02:08 +00:00
virtual void page_did_layout() { }
LibWeb+WebContent: Modify did_request_scroll() IPC to take x&y deltas This is in preparation for implementing JS scrolling functions, which specify both x and y scrolling deltas. The visible behavior has not changed. Also, moved the "mouse wheel delta * 20" calculation to the `EventHandler` since the JS calls will want to work directly in pixels.
2021-09-08 10:22:44 +00:00
virtual void page_did_request_scroll(i32, i32) { }
LibWeb+WebContent: Add WebContentClient::did_request_scroll_to() call This call sets the absolute scroll position for the window.
2021-09-08 10:44:36 +00:00
virtual void page_did_request_scroll_to(Gfx::IntPoint const&) { }
Everywhere: Run clang-format
2022-04-01 17:58:27 +00:00
virtual void page_did_request_scroll_into_view(Gfx::IntRect const&) { }
virtual void page_did_request_alert(String const&) { }
virtual bool page_did_request_confirm(String const&) { return false; }
virtual String page_did_request_prompt(String const&, String const&) { return {}; }
LibWeb: Add the Web::URL namespace and move URLEncoder to it This namespace will be used for all interfaces defined in the URL specification, like URL and URLSearchParams. This has the unfortunate side-effect of requiring us to use the fully qualified AK::URL name whenever we want to refer to the AK class, so this commit also fixes all such references.
2021-09-12 21:33:23 +00:00
virtual String page_did_request_cookie(const AK::URL&, Cookie::Source) { return {}; }
Everywhere: Run clang-format
2022-04-01 17:58:27 +00:00
virtual void page_did_set_cookie(const AK::URL&, Cookie::ParsedCookie const&, Cookie::Source) { }
Browser: Show currently loading host and remaining resource count
2022-02-20 22:03:39 +00:00
virtual void page_did_update_resource_count(i32) { }
LibWeb: Implement the "close" algorithm for browsing contexts This is used by window.close() programmatically, but of course the user can also decide to close a top-level browsing context at any time by closing the tab.
2022-09-20 23:17:01 +00:00
virtual void page_did_close_browsing_context(HTML::BrowsingContext const&) { }
Everything: Add `-Wnon-virtual-dtor` flag This flag warns on classes which have `virtual` functions but do not have a `virtual` destructor. This patch adds both the flag and missing destructors. The access level of the destructors was determined by a two rules of thumb: 1. A destructor should have a similar or lower access level to that of a constructor. 2. Having a `private` destructor implicitly deletes the default constructor, which is probably undesirable for "interface" types (classes with only virtual functions and no data). In short, most of the added destructors are `protected`, unless the compiler complained about access.
2021-04-15 17:43:29 +00:00
Browser+LibWeb+WebContent: Allow Browser to load local files To achieve this goal: - The Browser unveils "/tmp/portal/filesystemaccess" - Pass the page through LoadRequest => ResourceLoader - ResourceLoader requests a file to the FileSystemAccessServer via IPC - OutOfProcessWebView handles it and sends a file descriptor back to the Page.
2022-02-26 16:50:31 +00:00
virtual void request_file(NonnullRefPtr<FileRequest>&) = 0;
Everything: Add `-Wnon-virtual-dtor` flag This flag warns on classes which have `virtual` functions but do not have a `virtual` destructor. This patch adds both the flag and missing destructors. The access level of the destructors was determined by a two rules of thumb: 1. A destructor should have a similar or lower access level to that of a constructor. 2. Having a `private` destructor implicitly deletes the default constructor, which is probably undesirable for "interface" types (classes with only virtual functions and no data). In short, most of the added destructors are `protected`, unless the compiler complained about access.
2021-04-15 17:43:29 +00:00
protected:
virtual ~PageClient() = default;
LibWeb: Add Page abstraction between PageView and main Frame * A PageView is a view onto a Page object. * A Page always has a main Frame (root of Frame tree.) * Page has a PageClient. PageView is a PageClient. The goal here is to allow building another kind of view onto a Page while keeping the rest of LibWeb intact.
2020-06-08 18:31:49 +00:00
};
}
Reference in a new issue Copy permalink