jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2022, Andreas Kling <kling@serenityos.org>
3 * Copyright (c) 2023, Linus Groh <linusg@serenityos.org>
4 *
5 * SPDX-License-Identifier: BSD-2-Clause
6 */
7
8#pragma once
9
10#include <AK/Forward.h>
11#include <AK/String.h>
12#include <LibGfx/Forward.h>
13#include <LibGfx/StandardCursor.h>
14#include <LibWeb/Forward.h>
15#include <LibWebView/Forward.h>
16#include <LibWebView/WebContentClient.h>
17
18namespace WebView {
19
20class ViewImplementation {
21public:
22 virtual ~ViewImplementation() { }
23
24 struct DOMNodeProperties {
25 String computed_style_json;
26 String resolved_style_json;
27 String custom_properties_json;
28 String node_box_sizing_json;
29 };
30
31 AK::URL const& url() const { return m_url; }
32
33 void load(AK::URL const&);
34 void load_html(StringView, AK::URL const&);
35 void load_empty_document();
36
37 void zoom_in();
38 void zoom_out();
39 void reset_zoom();
40
41 void set_preferred_color_scheme(Web::CSS::PreferredColorScheme);
42
43 DeprecatedString selected_text();
44 void select_all();
45
46 void get_source();
47
48 void inspect_dom_tree();
49 void inspect_accessibility_tree();
50 ErrorOr<DOMNodeProperties> inspect_dom_node(i32 node_id, Optional<Web::CSS::Selector::PseudoElement> pseudo_element);
51 void clear_inspected_dom_node();
52 i32 get_hovered_node_id();
53
54 void debug_request(DeprecatedString const& request, DeprecatedString const& argument = {});
55
56 void run_javascript(StringView);
57
58 virtual void notify_server_did_layout(Badge<WebContentClient>, Gfx::IntSize content_size) = 0;
59 virtual void notify_server_did_paint(Badge<WebContentClient>, i32 bitmap_id) = 0;
60 virtual void notify_server_did_invalidate_content_rect(Badge<WebContentClient>, Gfx::IntRect const&) = 0;
61 virtual void notify_server_did_change_selection(Badge<WebContentClient>) = 0;
62 virtual void notify_server_did_request_cursor_change(Badge<WebContentClient>, Gfx::StandardCursor cursor) = 0;
63 virtual void notify_server_did_change_title(Badge<WebContentClient>, DeprecatedString const&) = 0;
64 virtual void notify_server_did_request_scroll(Badge<WebContentClient>, i32, i32) = 0;
65 virtual void notify_server_did_request_scroll_to(Badge<WebContentClient>, Gfx::IntPoint) = 0;
66 virtual void notify_server_did_request_scroll_into_view(Badge<WebContentClient>, Gfx::IntRect const&) = 0;
67 virtual void notify_server_did_enter_tooltip_area(Badge<WebContentClient>, Gfx::IntPoint, DeprecatedString const&) = 0;
68 virtual void notify_server_did_leave_tooltip_area(Badge<WebContentClient>) = 0;
69 virtual void notify_server_did_hover_link(Badge<WebContentClient>, const AK::URL&) = 0;
70 virtual void notify_server_did_unhover_link(Badge<WebContentClient>) = 0;
71 virtual void notify_server_did_click_link(Badge<WebContentClient>, const AK::URL&, DeprecatedString const& target, unsigned modifiers) = 0;
72 virtual void notify_server_did_middle_click_link(Badge<WebContentClient>, const AK::URL&, DeprecatedString const& target, unsigned modifiers) = 0;
73 virtual void notify_server_did_start_loading(Badge<WebContentClient>, const AK::URL&, bool is_redirect) = 0;
74 virtual void notify_server_did_finish_loading(Badge<WebContentClient>, const AK::URL&) = 0;
75 virtual void notify_server_did_request_navigate_back(Badge<WebContentClient>) = 0;
76 virtual void notify_server_did_request_navigate_forward(Badge<WebContentClient>) = 0;
77 virtual void notify_server_did_request_refresh(Badge<WebContentClient>) = 0;
78 virtual void notify_server_did_request_context_menu(Badge<WebContentClient>, Gfx::IntPoint) = 0;
79 virtual void notify_server_did_request_link_context_menu(Badge<WebContentClient>, Gfx::IntPoint, const AK::URL&, DeprecatedString const& target, unsigned modifiers) = 0;
80 virtual void notify_server_did_request_image_context_menu(Badge<WebContentClient>, Gfx::IntPoint, const AK::URL&, DeprecatedString const& target, unsigned modifiers, Gfx::ShareableBitmap const&) = 0;
81 virtual void notify_server_did_request_alert(Badge<WebContentClient>, DeprecatedString const& message) = 0;
82 virtual void notify_server_did_request_confirm(Badge<WebContentClient>, DeprecatedString const& message) = 0;
83 virtual void notify_server_did_request_prompt(Badge<WebContentClient>, DeprecatedString const& message, DeprecatedString const& default_) = 0;
84 virtual void notify_server_did_request_set_prompt_text(Badge<WebContentClient>, DeprecatedString const& message) = 0;
85 virtual void notify_server_did_request_accept_dialog(Badge<WebContentClient>) = 0;
86 virtual void notify_server_did_request_dismiss_dialog(Badge<WebContentClient>) = 0;
87 virtual void notify_server_did_get_source(const AK::URL& url, DeprecatedString const& source) = 0;
88 virtual void notify_server_did_get_dom_tree(DeprecatedString const& dom_tree) = 0;
89 virtual void notify_server_did_get_dom_node_properties(i32 node_id, DeprecatedString const& computed_style, DeprecatedString const& resolved_style, DeprecatedString const& custom_properties, DeprecatedString const& node_box_sizing) = 0;
90 virtual void notify_server_did_get_accessibility_tree(DeprecatedString const& accessibility_tree) = 0;
91 virtual void notify_server_did_output_js_console_message(i32 message_index) = 0;
92 virtual void notify_server_did_get_js_console_messages(i32 start_index, Vector<DeprecatedString> const& message_types, Vector<DeprecatedString> const& messages) = 0;
93 virtual void notify_server_did_change_favicon(Gfx::Bitmap const& favicon) = 0;
94 virtual Vector<Web::Cookie::Cookie> notify_server_did_request_all_cookies(Badge<WebContentClient>, AK::URL const& url) = 0;
95 virtual Optional<Web::Cookie::Cookie> notify_server_did_request_named_cookie(Badge<WebContentClient>, AK::URL const& url, DeprecatedString const& name) = 0;
96 virtual DeprecatedString notify_server_did_request_cookie(Badge<WebContentClient>, const AK::URL& url, Web::Cookie::Source source) = 0;
97 virtual void notify_server_did_set_cookie(Badge<WebContentClient>, const AK::URL& url, Web::Cookie::ParsedCookie const& cookie, Web::Cookie::Source source) = 0;
98 virtual void notify_server_did_update_cookie(Badge<WebContentClient>, Web::Cookie::Cookie const& cookie) = 0;
99 virtual void notify_server_did_close_browsing_context(Badge<WebContentClient>) = 0;
100 virtual void notify_server_did_update_resource_count(i32 count_waiting) = 0;
101 virtual void notify_server_did_request_restore_window() = 0;
102 virtual Gfx::IntPoint notify_server_did_request_reposition_window(Gfx::IntPoint) = 0;
103 virtual Gfx::IntSize notify_server_did_request_resize_window(Gfx::IntSize) = 0;
104 virtual Gfx::IntRect notify_server_did_request_maximize_window() = 0;
105 virtual Gfx::IntRect notify_server_did_request_minimize_window() = 0;
106 virtual Gfx::IntRect notify_server_did_request_fullscreen_window() = 0;
107 virtual void notify_server_did_request_file(Badge<WebContentClient>, DeprecatedString const& path, i32) = 0;
108 virtual void notify_server_did_finish_handling_input_event(bool event_was_accepted) = 0;
109
110protected:
111 static constexpr auto ZOOM_MIN_LEVEL = 0.3f;
112 static constexpr auto ZOOM_MAX_LEVEL = 5.0f;
113 static constexpr auto ZOOM_STEP = 0.1f;
114
115 WebContentClient& client();
116 WebContentClient const& client() const;
117 virtual void create_client() = 0;
118 virtual void update_zoom() = 0;
119
120#if !defined(AK_OS_SERENITY)
121 ErrorOr<NonnullRefPtr<WebView::WebContentClient>> launch_web_content_process(ReadonlySpan<String> candidate_web_content_paths, StringView webdriver_content_ipc_path);
122#endif
123
124 struct SharedBitmap {
125 i32 id { -1 };
126 i32 pending_paints { 0 };
127 RefPtr<Gfx::Bitmap> bitmap;
128 };
129
130 struct ClientState {
131 RefPtr<WebContentClient> client;
132 SharedBitmap front_bitmap;
133 SharedBitmap back_bitmap;
134 i32 next_bitmap_id { 0 };
135 bool has_usable_bitmap { false };
136 bool got_repaint_requests_while_painting { false };
137 } m_client_state;
138
139 AK::URL m_url;
140
141 float m_zoom_level { 1.0 };
142 float m_device_pixel_ratio { 1.0 };
143};
144
145}