2022-10-05 12:32:17 +00:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2022, Andreas Kling <kling@serenityos.org>
|
2023-01-12 20:22:14 +00:00
|
|
|
* Copyright (c) 2023, Linus Groh <linusg@serenityos.org>
|
2022-10-05 12:32:17 +00:00
|
|
|
*
|
|
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
|
|
*/
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include <AK/Forward.h>
|
2023-05-17 16:37:31 +00:00
|
|
|
#include <AK/Function.h>
|
2023-01-12 20:22:14 +00:00
|
|
|
#include <AK/String.h>
|
2022-10-05 12:32:17 +00:00
|
|
|
#include <LibGfx/Forward.h>
|
|
|
|
#include <LibGfx/StandardCursor.h>
|
|
|
|
#include <LibWeb/Forward.h>
|
2023-03-20 22:39:20 +00:00
|
|
|
#include <LibWeb/HTML/ActivateTab.h>
|
2022-10-05 12:32:17 +00:00
|
|
|
#include <LibWebView/Forward.h>
|
2023-01-12 19:27:17 +00:00
|
|
|
#include <LibWebView/WebContentClient.h>
|
2022-10-05 12:32:17 +00:00
|
|
|
|
|
|
|
namespace WebView {
|
|
|
|
|
2023-04-15 00:04:28 +00:00
|
|
|
// Note: This only exists inside Serenity to avoid #ifdefs in all implementors of ViewImplementation.
|
|
|
|
enum class EnableCallgrindProfiling {
|
|
|
|
No,
|
|
|
|
Yes
|
|
|
|
};
|
|
|
|
|
2023-05-06 10:46:14 +00:00
|
|
|
enum class IsLayoutTestMode {
|
|
|
|
No,
|
|
|
|
Yes
|
|
|
|
};
|
|
|
|
|
2022-10-05 12:32:17 +00:00
|
|
|
class ViewImplementation {
|
|
|
|
public:
|
|
|
|
virtual ~ViewImplementation() { }
|
|
|
|
|
2023-01-12 20:22:14 +00:00
|
|
|
struct DOMNodeProperties {
|
|
|
|
String computed_style_json;
|
|
|
|
String resolved_style_json;
|
|
|
|
String custom_properties_json;
|
|
|
|
String node_box_sizing_json;
|
2023-05-21 13:52:03 +00:00
|
|
|
String aria_properties_state_json;
|
2023-01-12 20:22:14 +00:00
|
|
|
};
|
|
|
|
|
2023-05-17 16:37:31 +00:00
|
|
|
void set_url(Badge<WebContentClient>, AK::URL url) { m_url = move(url); }
|
2023-01-12 20:30:06 +00:00
|
|
|
AK::URL const& url() const { return m_url; }
|
|
|
|
|
2023-03-16 15:24:30 +00:00
|
|
|
String const& handle() const { return m_client_state.client_handle; }
|
|
|
|
|
2023-05-20 14:50:05 +00:00
|
|
|
void server_did_paint(Badge<WebContentClient>, i32 bitmap_id, Gfx::IntSize size);
|
2023-05-20 15:04:02 +00:00
|
|
|
void server_did_invalidate_content_rect(Badge<WebContentClient>, Gfx::IntRect rect);
|
|
|
|
void server_did_change_selection(Badge<WebContentClient>);
|
2023-05-20 14:50:05 +00:00
|
|
|
|
2023-01-12 20:30:06 +00:00
|
|
|
void load(AK::URL const&);
|
2023-09-17 15:12:17 +00:00
|
|
|
void load_html(StringView);
|
2023-01-12 20:30:06 +00:00
|
|
|
void load_empty_document();
|
|
|
|
|
2023-01-12 19:49:49 +00:00
|
|
|
void zoom_in();
|
|
|
|
void zoom_out();
|
|
|
|
void reset_zoom();
|
2023-03-26 18:41:56 +00:00
|
|
|
float zoom_level() const { return m_zoom_level; }
|
2023-01-12 20:22:14 +00:00
|
|
|
|
2023-01-12 20:44:42 +00:00
|
|
|
void set_preferred_color_scheme(Web::CSS::PreferredColorScheme);
|
|
|
|
|
2023-01-12 20:42:42 +00:00
|
|
|
DeprecatedString selected_text();
|
|
|
|
void select_all();
|
|
|
|
|
2023-01-12 19:58:00 +00:00
|
|
|
void get_source();
|
2023-01-12 19:49:49 +00:00
|
|
|
|
2023-01-12 20:22:14 +00:00
|
|
|
void inspect_dom_tree();
|
|
|
|
void inspect_accessibility_tree();
|
|
|
|
ErrorOr<DOMNodeProperties> inspect_dom_node(i32 node_id, Optional<Web::CSS::Selector::PseudoElement> pseudo_element);
|
|
|
|
void clear_inspected_dom_node();
|
|
|
|
i32 get_hovered_node_id();
|
|
|
|
|
2023-01-12 20:34:08 +00:00
|
|
|
void debug_request(DeprecatedString const& request, DeprecatedString const& argument = {});
|
|
|
|
|
2023-01-12 20:39:08 +00:00
|
|
|
void run_javascript(StringView);
|
2023-05-17 15:54:36 +00:00
|
|
|
void js_console_input(DeprecatedString const& js_source);
|
|
|
|
void js_console_request_messages(i32 start_index);
|
2023-01-12 20:39:08 +00:00
|
|
|
|
2023-05-17 18:23:34 +00:00
|
|
|
void alert_closed();
|
|
|
|
void confirm_closed(bool accepted);
|
|
|
|
void prompt_closed(Optional<String> response);
|
|
|
|
|
2023-06-16 14:51:38 +00:00
|
|
|
void toggle_media_play_state();
|
2023-06-16 15:29:54 +00:00
|
|
|
void toggle_media_mute_state();
|
2023-06-16 14:51:38 +00:00
|
|
|
void toggle_media_loop_state();
|
|
|
|
void toggle_media_controls_state();
|
2023-05-15 15:17:58 +00:00
|
|
|
|
2023-05-17 13:53:13 +00:00
|
|
|
enum class ScreenshotType {
|
|
|
|
Visible,
|
|
|
|
Full,
|
|
|
|
};
|
|
|
|
ErrorOr<void> take_screenshot(ScreenshotType);
|
|
|
|
|
2023-08-26 17:34:59 +00:00
|
|
|
void set_user_style_sheet(String source);
|
|
|
|
// Load Native.css as the User style sheet, which attempts to make WebView content look as close to
|
|
|
|
// native GUI widgets as possible.
|
|
|
|
void use_native_user_style_sheet();
|
|
|
|
|
2023-08-23 14:33:26 +00:00
|
|
|
Function<void(Gfx::IntSize)> on_did_layout;
|
2023-05-20 14:50:05 +00:00
|
|
|
Function<void()> on_ready_to_paint;
|
2023-05-17 16:37:31 +00:00
|
|
|
Function<String(Web::HTML::ActivateTab)> on_new_tab;
|
|
|
|
Function<void()> on_activate_tab;
|
|
|
|
Function<void()> on_close;
|
|
|
|
Function<void(Gfx::IntPoint screen_position)> on_context_menu_request;
|
|
|
|
Function<void(const AK::URL&, Gfx::IntPoint screen_position)> on_link_context_menu_request;
|
|
|
|
Function<void(const AK::URL&, Gfx::IntPoint screen_position, Gfx::ShareableBitmap const&)> on_image_context_menu_request;
|
2023-06-16 14:51:38 +00:00
|
|
|
Function<void(Gfx::IntPoint screen_position, Web::Page::MediaContextMenu const&)> on_media_context_menu_request;
|
2023-05-17 16:37:31 +00:00
|
|
|
Function<void(const AK::URL&)> on_link_hover;
|
|
|
|
Function<void()> on_link_unhover;
|
|
|
|
Function<void(const AK::URL&, DeprecatedString const& target, unsigned modifiers)> on_link_click;
|
|
|
|
Function<void(const AK::URL&, DeprecatedString const& target, unsigned modifiers)> on_link_middle_click;
|
|
|
|
Function<void(DeprecatedString const&)> on_title_change;
|
|
|
|
Function<void(const AK::URL&, bool)> on_load_start;
|
|
|
|
Function<void(const AK::URL&)> on_load_finish;
|
2023-08-23 10:54:22 +00:00
|
|
|
Function<void(DeprecatedString const& path, i32)> on_request_file;
|
2023-05-17 16:37:31 +00:00
|
|
|
Function<void()> on_navigate_back;
|
|
|
|
Function<void()> on_navigate_forward;
|
|
|
|
Function<void()> on_refresh;
|
|
|
|
Function<void(Gfx::Bitmap const&)> on_favicon_change;
|
2023-08-23 14:57:09 +00:00
|
|
|
Function<void(i32, i32)> on_scroll_by_delta;
|
|
|
|
Function<void(Gfx::IntPoint)> on_scroll_to_point;
|
|
|
|
Function<void(Gfx::IntRect)> on_scroll_into_view;
|
2023-08-23 14:43:27 +00:00
|
|
|
Function<void(Gfx::StandardCursor)> on_cursor_change;
|
2023-08-23 15:11:39 +00:00
|
|
|
Function<void(Gfx::IntPoint, DeprecatedString const&)> on_enter_tooltip_area;
|
|
|
|
Function<void()> on_leave_tooltip_area;
|
2023-05-17 18:23:34 +00:00
|
|
|
Function<void(String const& message)> on_request_alert;
|
|
|
|
Function<void(String const& message)> on_request_confirm;
|
|
|
|
Function<void(String const& message, String const& default_)> on_request_prompt;
|
|
|
|
Function<void(String const& message)> on_request_set_prompt_text;
|
|
|
|
Function<void()> on_request_accept_dialog;
|
|
|
|
Function<void()> on_request_dismiss_dialog;
|
2023-08-23 15:25:24 +00:00
|
|
|
Function<void(const AK::URL&, DeprecatedString const&)> on_received_source;
|
|
|
|
Function<void(DeprecatedString const&)> on_received_dom_tree;
|
|
|
|
Function<void(i32 node_id, DeprecatedString const& computed_style, DeprecatedString const& resolved_style, DeprecatedString const& custom_properties, DeprecatedString const& node_box_sizing, DeprecatedString const& aria_properties_state)> on_received_dom_node_properties;
|
|
|
|
Function<void(DeprecatedString const&)> on_received_accessibility_tree;
|
|
|
|
Function<void(i32 message_id)> on_received_console_message;
|
|
|
|
Function<void(i32 start_index, Vector<DeprecatedString> const& message_types, Vector<DeprecatedString> const& messages)> on_received_console_messages;
|
2023-05-17 16:37:31 +00:00
|
|
|
Function<Vector<Web::Cookie::Cookie>(AK::URL const& url)> on_get_all_cookies;
|
|
|
|
Function<Optional<Web::Cookie::Cookie>(AK::URL const& url, DeprecatedString const& name)> on_get_named_cookie;
|
|
|
|
Function<DeprecatedString(const AK::URL& url, Web::Cookie::Source source)> on_get_cookie;
|
|
|
|
Function<void(const AK::URL& url, Web::Cookie::ParsedCookie const& cookie, Web::Cookie::Source source)> on_set_cookie;
|
|
|
|
Function<void(Web::Cookie::Cookie const& cookie)> on_update_cookie;
|
|
|
|
Function<void(i32 count_waiting)> on_resource_status_change;
|
|
|
|
Function<void()> on_restore_window;
|
|
|
|
Function<Gfx::IntPoint(Gfx::IntPoint)> on_reposition_window;
|
|
|
|
Function<Gfx::IntSize(Gfx::IntSize)> on_resize_window;
|
|
|
|
Function<Gfx::IntRect()> on_maximize_window;
|
|
|
|
Function<Gfx::IntRect()> on_minimize_window;
|
|
|
|
Function<Gfx::IntRect()> on_fullscreen_window;
|
2023-08-23 15:19:21 +00:00
|
|
|
Function<void(bool)> on_finish_handling_input_event;
|
2023-09-14 17:17:32 +00:00
|
|
|
Function<void()> on_text_test_finish;
|
2023-01-12 19:27:17 +00:00
|
|
|
|
2023-05-15 05:59:51 +00:00
|
|
|
virtual Gfx::IntRect viewport_rect() const = 0;
|
2023-05-17 14:12:13 +00:00
|
|
|
virtual Gfx::IntPoint to_content_position(Gfx::IntPoint widget_position) const = 0;
|
|
|
|
virtual Gfx::IntPoint to_widget_position(Gfx::IntPoint content_position) const = 0;
|
2023-05-15 05:59:51 +00:00
|
|
|
|
2023-01-12 19:27:17 +00:00
|
|
|
protected:
|
2023-01-12 19:49:49 +00:00
|
|
|
static constexpr auto ZOOM_MIN_LEVEL = 0.3f;
|
|
|
|
static constexpr auto ZOOM_MAX_LEVEL = 5.0f;
|
|
|
|
static constexpr auto ZOOM_STEP = 0.1f;
|
|
|
|
|
2023-08-07 14:44:20 +00:00
|
|
|
ViewImplementation();
|
2023-05-15 05:59:51 +00:00
|
|
|
|
2023-01-12 19:27:17 +00:00
|
|
|
WebContentClient& client();
|
|
|
|
WebContentClient const& client() const;
|
2023-01-12 19:49:49 +00:00
|
|
|
virtual void update_zoom() = 0;
|
2023-01-12 19:27:17 +00:00
|
|
|
|
2023-05-15 05:59:51 +00:00
|
|
|
enum class WindowResizeInProgress {
|
|
|
|
No,
|
|
|
|
Yes,
|
|
|
|
};
|
|
|
|
void resize_backing_stores_if_needed(WindowResizeInProgress);
|
|
|
|
|
|
|
|
void request_repaint();
|
|
|
|
void handle_resize();
|
|
|
|
|
2023-07-22 10:41:25 +00:00
|
|
|
virtual void create_client(EnableCallgrindProfiling = EnableCallgrindProfiling::No) { }
|
2023-04-15 00:04:28 +00:00
|
|
|
|
2023-05-17 13:53:13 +00:00
|
|
|
void handle_web_content_process_crash();
|
|
|
|
|
2023-01-12 19:27:17 +00:00
|
|
|
struct SharedBitmap {
|
|
|
|
i32 id { -1 };
|
|
|
|
i32 pending_paints { 0 };
|
2023-05-14 16:53:29 +00:00
|
|
|
Gfx::IntSize last_painted_size;
|
2023-01-12 19:27:17 +00:00
|
|
|
RefPtr<Gfx::Bitmap> bitmap;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct ClientState {
|
|
|
|
RefPtr<WebContentClient> client;
|
2023-03-16 15:24:30 +00:00
|
|
|
String client_handle;
|
2023-01-12 19:27:17 +00:00
|
|
|
SharedBitmap front_bitmap;
|
|
|
|
SharedBitmap back_bitmap;
|
|
|
|
i32 next_bitmap_id { 0 };
|
|
|
|
bool has_usable_bitmap { false };
|
|
|
|
bool got_repaint_requests_while_painting { false };
|
|
|
|
} m_client_state;
|
2023-01-12 19:49:49 +00:00
|
|
|
|
2023-01-12 20:30:06 +00:00
|
|
|
AK::URL m_url;
|
|
|
|
|
2023-01-12 19:49:49 +00:00
|
|
|
float m_zoom_level { 1.0 };
|
|
|
|
float m_device_pixel_ratio { 1.0 };
|
2023-05-15 05:59:51 +00:00
|
|
|
|
|
|
|
RefPtr<Core::Timer> m_backing_store_shrink_timer;
|
|
|
|
|
|
|
|
RefPtr<Gfx::Bitmap> m_backup_bitmap;
|
|
|
|
Gfx::IntSize m_backup_bitmap_size;
|
2023-05-27 16:46:45 +00:00
|
|
|
|
|
|
|
size_t m_crash_count = 0;
|
|
|
|
RefPtr<Core::Timer> m_repeated_crash_timer;
|
2022-10-05 12:32:17 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
}
|