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/Userland/Libraries/LibWeb/Page/Page.h

107 lines
4.3 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 20:31:49 +02: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 08:25:35 +01: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 20:31:49 +02: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 01:24:48 -07: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 20:31:49 +02: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 11:55:26 +02: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 08:25:35 +01: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 12:10:01 +02: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 20:31:49 +02: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 08:25:35 +01:00
#include <LibGfx/StandardCursor.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 20:31:49 +02:00
#include <LibWeb/Forward.h>
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 18:23:05 +01: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 20:31:49 +02:00
AK_MAKE_NONCOPYABLE(Page);
AK_MAKE_NONMOVABLE(Page);
public:
explicit Page(PageClient&);
~Page();
PageClient& client() { return m_client; }
const PageClient& client() const { return m_client; }
LibWeb: Rename Web::Frame to Web::BrowsingContext Our "frame" concept very closely matches what the web specs call a "browsing context", so let's rename it to that. :^) The "main frame" becomes the "top-level browsing context", and "sub-frames" are now "nested browsing contexts".
2021-05-30 12:36:53 +02:00
Web::BrowsingContext& top_level_browsing_context() { return *m_top_level_browsing_context; }
const Web::BrowsingContext& 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 20:31:49 +02:00
LibWeb: Rename Web::Frame to Web::BrowsingContext Our "frame" concept very closely matches what the web specs call a "browsing context", so let's rename it to that. :^) The "main frame" becomes the "top-level browsing context", and "sub-frames" are now "nested browsing contexts".
2021-05-30 12:36:53 +02:00
Web::BrowsingContext& focused_context();
const Web::BrowsingContext& 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 11:33:20 +02:00
LibWeb: Rename Web::Frame to Web::BrowsingContext Our "frame" concept very closely matches what the web specs call a "browsing context", so let's rename it to that. :^) The "main frame" becomes the "top-level browsing context", and "sub-frames" are now "nested browsing contexts".
2021-05-30 12:36:53 +02:00
void set_focused_browsing_context(Badge<EventHandler>, 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 11:33:20 +02: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 20:31:49 +02:00
void load(const URL&);
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 11:55:26 +02:00
void load(const 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 20:31:49 +02:00
LibWeb: Add OutOfProcessWebView::load_html()
2020-10-08 21:11:01 +01:00
void load_html(const StringView&, const URL&);
LibGfx: Rename Rect,Point,Size => IntRect,IntPoint,IntSize This fits nicer with FloatRect,FloatPoint,FloatSize and gives a much better visual clue about what type of metric is being used.
2020-06-10 10:57:59 +02:00
bool handle_mouseup(const Gfx::IntPoint&, unsigned button, unsigned modifiers);
bool handle_mousedown(const Gfx::IntPoint&, unsigned button, unsigned modifiers);
bool handle_mousemove(const Gfx::IntPoint&, unsigned buttons, unsigned modifiers);
LibWeb: Plumb wheel events from widget layer to EventHandler
2021-02-22 19:45:41 +01:00
bool handle_mousewheel(const Gfx::IntPoint&, unsigned button, unsigned modifiers, int wheel_delta);
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 20:31:49 +02: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 12:10:01 +02:00
bool handle_keydown(KeyCode, unsigned modifiers, u32 code_point);
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 20:31:49 +02: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-04 00:12:37 +02:00
Gfx::IntRect screen_rect() 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 20:31:49 +02: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 02:10:43 +02: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 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 20:31:49 +02:00
private:
PageClient& m_client;
LibWeb: Rename Web::Frame to Web::BrowsingContext Our "frame" concept very closely matches what the web specs call a "browsing context", so let's rename it to that. :^) The "main frame" becomes the "top-level browsing context", and "sub-frames" are now "nested browsing contexts".
2021-05-30 12:36:53 +02:00
RefPtr<BrowsingContext> m_top_level_browsing_context;
WeakPtr<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 02:10:43 +02:00
bool m_same_origin_policy_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 20:31:49 +02:00
};
class PageClient {
public:
LibWeb: Add PageClient::palette() for view-agnostic palette access
2020-06-17 20:26:59 +02: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-04 00:12:37 +02:00
virtual Gfx::IntRect screen_rect() const = 0;
LibWeb: Rename Web::Frame to Web::BrowsingContext Our "frame" concept very closely matches what the web specs call a "browsing context", so let's rename it to that. :^) The "main frame" becomes the "top-level browsing context", and "sub-frames" are now "nested browsing contexts".
2021-05-30 12:36:53 +02:00
virtual void page_did_set_document_in_top_level_browsing_context(DOM::Document*) { }
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 20:31:49 +02:00
virtual void page_did_change_title(const String&) { }
virtual void page_did_start_loading(const URL&) { }
LibWeb+WebContent: Add on_load_finish hook to web views This isn't entirely symmetrical with on_load_start as it will also fire on reloads and back/forward navigations. However, it's good enough for some basic use cases, and we can do more sophisticated notifications later on when we need them.
2020-12-08 21:44:42 +01:00
virtual void page_did_finish_loading(const 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 20:31:49 +02: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 19:25:13 +02:00
virtual void page_did_request_cursor_change(Gfx::StandardCursor) { }
LibWeb: Add Page context menu request Pages can request a context menu on right click. This is plumbed through the PageClient.
2020-06-27 14:21:58 -06:00
virtual void page_did_request_context_menu(const Gfx::IntPoint&) { }
LibWeb: Make the link context menu hook include the destination URL
2020-07-06 20:00:56 +02:00
virtual void page_did_request_link_context_menu(const Gfx::IntPoint&, const URL&, [[maybe_unused]] const String& target, [[maybe_unused]] unsigned modifiers) { }
LibWeb: Add a PageClient callback for image context menu requests When the user right-clicks on an image, you might want to show a special context menu, separate from the regular link context menu. This patch only implements enough of the functionality to get this working in a single-process context.
2020-10-02 19:01:51 +02:00
virtual void page_did_request_image_context_menu(const Gfx::IntPoint&, const URL&, [[maybe_unused]] const String& target, [[maybe_unused]] unsigned modifiers, const Gfx::Bitmap*) { }
LibWeb: Make the link click hooks include the destination URL We have all the context needed for relative URL resolution inside the engine, so let's not make embedders worry about this.
2020-07-06 19:41:10 +02:00
virtual void page_did_click_link(const URL&, [[maybe_unused]] const String& target, [[maybe_unused]] unsigned modifiers) { }
virtual void page_did_middle_click_link(const URL&, [[maybe_unused]] const String& target, [[maybe_unused]] unsigned modifiers) { }
LibGfx: Rename Rect,Point,Size => IntRect,IntPoint,IntSize This fits nicer with FloatRect,FloatPoint,FloatSize and gives a much better visual clue about what type of metric is being used.
2020-06-10 10:57:59 +02:00
virtual void page_did_enter_tooltip_area(const Gfx::IntPoint&, const String&) { }
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 20:31:49 +02:00
virtual void page_did_leave_tooltip_area() { }
virtual void page_did_hover_link(const URL&) { }
virtual void page_did_unhover_link() { }
LibGfx: Rename Rect,Point,Size => IntRect,IntPoint,IntSize This fits nicer with FloatRect,FloatPoint,FloatSize and gives a much better visual clue about what type of metric is being used.
2020-06-10 10:57:59 +02:00
virtual void page_did_invalidate(const Gfx::IntRect&) { }
LibWeb: Unbreak favicon notifications after Page refactoring Favicon updates now get plumbed from FrameLoader to the PageClient.
2020-06-08 21:35:31 +02:00
virtual void page_did_change_favicon(const Gfx::Bitmap&) { }
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 18:02:08 +02: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 11:22:44 +01: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 11:44:36 +01:00
virtual void page_did_request_scroll_to(Gfx::IntPoint const&) { }
LibWeb: Move fragment link handling to Frame Activating a "#foo" fragment link will now be handled internally by the Frame instead of involving the widget layer. If the viewport needs to be scrolled as a result, we will simply ask the PageClient to scroll a new rect into view.
2020-07-05 14:50:38 +02:00
virtual void page_did_request_scroll_into_view(const Gfx::IntRect&) { }
LibWeb: Support window.alert() in multi-process context Alerts are now delegated to the embedding GUI process.
2020-09-12 11:56:13 +02:00
virtual void page_did_request_alert(const String&) { }
LibWeb: Move window.confirm() to using a PageClient callback This allows us to move the GUI::MessageBox out of DOM::Window and up to the widget layer.
2021-02-10 08:37:13 +01:00
virtual bool page_did_request_confirm(const String&) { return false; }
LibWeb: Implement Window.prompt()
2021-02-20 12:05:18 +01:00
virtual String page_did_request_prompt(const String&, const String&) { return {}; }
Browser+LibWeb+WebContent: Track the source of document.cookie requests To implement the HttpOnly attribute, the CookieJar needs to know where a request originated from. Namely, it needs to distinguish between HTTP / non-HTTP (i.e. JavaScript) requests. When the HttpOnly attribute is set, requests from JavaScript are to be blocked.
2021-04-13 17:30:41 -04:00
virtual String page_did_request_cookie(const URL&, Cookie::Source) { return {}; }
Browser+LibWeb+WebContent: Parse cookies in the OOP tab To protect the main Browser process against nefarious cookies, parse the cookies out-of-process and then send the parsed result over IPC to the main process. This way, if the cookie parser blows up, only that tab will be affected.
2021-04-15 10:36:20 -04:00
virtual void page_did_set_cookie(const URL&, const Cookie::ParsedCookie&, Cookie::Source) { }
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 10:43:29 -07: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 20:31:49 +02:00
};
}
Reference in a new issue Copy permalink