/* * Copyright (c) 2022, Andreas Kling * Copyright (c) 2023, Linus Groh * * SPDX-License-Identifier: BSD-2-Clause */ #pragma once #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace WebView { class ViewImplementation { public: virtual ~ViewImplementation(); static void for_each_view(Function); static Optional find_view_by_id(u64); u64 view_id() const { return m_view_id; } void set_url(Badge, URL::URL url) { m_url = move(url); } URL::URL const& url() const { return m_url; } void set_title(Badge, ByteString title) { m_title = move(title); } ByteString const& title() const { return m_title; } String const& handle() const { return m_client_state.client_handle; } void create_new_process_for_cross_site_navigation(URL::URL const&); void server_did_paint(Badge, i32 bitmap_id, Gfx::IntSize size); void set_window_position(Gfx::IntPoint); void set_window_size(Gfx::IntSize); void did_update_window_rect(); void set_system_visibility_state(Web::HTML::VisibilityState); void load(URL::URL const&); void load_html(StringView); void load_empty_document(); void reload(); void traverse_the_history_by_delta(int delta); void zoom_in(); void zoom_out(); void set_zoom(double zoom_level); void reset_zoom(); float zoom_level() const { return m_zoom_level; } float device_pixel_ratio() const { return m_device_pixel_ratio; } void enqueue_input_event(Web::InputEvent); void did_finish_handling_input_event(Badge, Web::EventResult event_result); void set_preferred_color_scheme(Web::CSS::PreferredColorScheme); void set_preferred_contrast(Web::CSS::PreferredContrast); void set_preferred_motion(Web::CSS::PreferredMotion); void set_preferred_languages(ReadonlySpan); void set_enable_do_not_track(bool); void set_enable_autoplay(bool); ByteString selected_text(); Optional selected_text_with_whitespace_collapsed(); void select_all(); void find_in_page(String const& query, CaseSensitivity = CaseSensitivity::CaseInsensitive); void find_in_page_next_match(); void find_in_page_previous_match(); void paste(String const&); void get_source(); void inspect_dom_tree(); void inspect_accessibility_tree(); void get_hovered_node_id(); void inspect_dom_node(Web::UniqueNodeID node_id, DOMNodeProperties::Type, Optional pseudo_element); void clear_inspected_dom_node(); void highlight_dom_node(Web::UniqueNodeID node_id, Optional pseudo_element); void clear_highlighted_dom_node(); void set_listen_for_dom_mutations(bool); void get_dom_node_inner_html(Web::UniqueNodeID node_id); void get_dom_node_outer_html(Web::UniqueNodeID node_id); void set_dom_node_outer_html(Web::UniqueNodeID node_id, String const& html); void set_dom_node_text(Web::UniqueNodeID node_id, String const& text); void set_dom_node_tag(Web::UniqueNodeID node_id, String const& name); void add_dom_node_attributes(Web::UniqueNodeID node_id, ReadonlySpan attributes); void replace_dom_node_attribute(Web::UniqueNodeID node_id, String const& name, ReadonlySpan replacement_attributes); void create_child_element(Web::UniqueNodeID node_id); void create_child_text_node(Web::UniqueNodeID node_id); void insert_dom_node_before(Web::UniqueNodeID node_id, Web::UniqueNodeID parent_node_id, Optional sibling_node_id); void clone_dom_node(Web::UniqueNodeID node_id); void remove_dom_node(Web::UniqueNodeID node_id); void list_style_sheets(); void request_style_sheet_source(Web::CSS::StyleSheetIdentifier const&); void debug_request(ByteString const& request, ByteString const& argument = {}); void run_javascript(String const&); void js_console_input(String const&); void js_console_request_messages(i32 start_index); void alert_closed(); void confirm_closed(bool accepted); void prompt_closed(Optional const& response); void color_picker_update(Optional picked_color, Web::HTML::ColorPickerUpdateState state); void file_picker_closed(Vector selected_files); void select_dropdown_closed(Optional const& selected_item_id); void toggle_media_play_state(); void toggle_media_mute_state(); void toggle_media_loop_state(); void toggle_media_controls_state(); Web::HTML::MuteState page_mute_state() const { return m_mute_state; } void toggle_page_mute_state(); void did_change_audio_play_state(Badge, Web::HTML::AudioPlayState); Web::HTML::AudioPlayState audio_play_state() const { return m_audio_play_state; } void did_update_navigation_buttons_state(Badge, bool back_enabled, bool forward_enabled) const; void did_allocate_backing_stores(Badge, i32 front_bitmap_id, Gfx::ShareableBitmap const&, i32 back_bitmap_id, Gfx::ShareableBitmap const&); #ifdef AK_OS_MACOS void did_allocate_iosurface_backing_stores(i32 front_bitmap_id, Core::MachPort&&, i32 back_bitmap_id, Core::MachPort&&); #endif enum class ScreenshotType { Visible, Full, }; NonnullRefPtr> take_screenshot(ScreenshotType); NonnullRefPtr> take_dom_node_screenshot(Web::UniqueNodeID); virtual void did_receive_screenshot(Badge, Gfx::ShareableBitmap const&); NonnullRefPtr> request_internal_page_info(PageInfoType); void did_receive_internal_page_info(Badge, PageInfoType, String const&); ErrorOr dump_gc_graph(); void set_user_style_sheet(String const& 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(); Function on_ready_to_paint; Function)> on_new_web_view; Function on_activate_tab; Function on_close; Function on_context_menu_request; Function on_link_context_menu_request; Function const&)> on_image_context_menu_request; Function on_media_context_menu_request; Function on_link_hover; Function on_link_unhover; Function on_link_click; Function on_link_middle_click; Function on_title_change; Function on_url_change; Function on_load_start; Function on_load_finish; Function on_request_file; Function on_favicon_change; Function on_cursor_change; Function on_request_tooltip_override; Function on_stop_tooltip_override; Function on_enter_tooltip_area; Function on_leave_tooltip_area; Function on_request_alert; Function on_request_confirm; Function on_request_prompt; Function on_request_set_prompt_text; Function on_request_accept_dialog; Function on_request_dismiss_dialog; Function on_received_source; Function on_received_dom_tree; Function on_received_dom_node_properties; Function on_received_accessibility_tree; Function on_received_hovered_node_id; Function on_dom_mutation_received; Function const& node_id)> on_finshed_editing_dom_node; Function on_received_dom_node_html; Function)> on_received_style_sheet_list; Function on_received_style_sheet_source; Function on_received_js_console_result; Function on_console_message_available; Function const& message_types, Vector const& messages)> on_received_styled_console_messages; Function)> on_received_unstyled_console_messages; Function on_resource_status_change; Function on_restore_window; Function on_reposition_window; Function on_resize_window; Function on_maximize_window; Function on_minimize_window; Function on_fullscreen_window; Function on_request_color_picker; Function on_request_file_picker; Function items)> on_request_select_dropdown; Function on_finish_handling_key_event; Function on_finish_handling_drag_event; Function on_test_finish; Function on_set_test_timeout; Function on_set_browser_zoom; Function const& total_match_count)> on_find_in_page; Function on_theme_color_change; Function on_insert_clipboard_entry; Function on_audio_play_state_changed; Function on_navigation_buttons_state_changed; Function on_web_content_crashed; virtual Web::DevicePixelSize viewport_size() const = 0; virtual Gfx::IntPoint to_content_position(Gfx::IntPoint widget_position) const = 0; virtual Gfx::IntPoint to_widget_position(Gfx::IntPoint content_position) const = 0; protected: static constexpr auto ZOOM_MIN_LEVEL = 0.3f; static constexpr auto ZOOM_MAX_LEVEL = 5.0f; static constexpr auto ZOOM_STEP = 0.1f; ViewImplementation(); WebContentClient& client(); WebContentClient const& client() const; u64 page_id() const; virtual void update_zoom() = 0; void handle_resize(); enum class CreateNewClient { No, Yes, }; virtual void initialize_client(CreateNewClient = CreateNewClient::Yes); enum class LoadErrorPage { No, Yes, }; void handle_web_content_process_crash(LoadErrorPage = LoadErrorPage::Yes); struct SharedBitmap { i32 id { -1 }; Web::DevicePixelSize last_painted_size; RefPtr bitmap; }; struct ClientState { RefPtr client; String client_handle; SharedBitmap front_bitmap; SharedBitmap back_bitmap; u64 page_index { 0 }; bool has_usable_bitmap { false }; } m_client_state; URL::URL m_url; ByteString m_title; float m_zoom_level { 1.0 }; float m_device_pixel_ratio { 1.0 }; Queue m_pending_input_events; RefPtr m_backing_store_shrink_timer; RefPtr m_backup_bitmap; Web::DevicePixelSize m_backup_bitmap_size; size_t m_crash_count = 0; RefPtr m_repeated_crash_timer; RefPtr> m_pending_screenshot; RefPtr> m_pending_info_request; Web::HTML::VisibilityState m_system_visibility_state { Web::HTML::VisibilityState::Hidden }; Web::HTML::AudioPlayState m_audio_play_state { Web::HTML::AudioPlayState::Paused }; size_t m_number_of_elements_playing_audio { 0 }; Web::HTML::MuteState m_mute_state { Web::HTML::MuteState::Unmuted }; // FIXME: Reconcile this ID with `page_id`. The latter is only unique per WebContent connection, whereas the view ID // is required to be globally unique for Firefox DevTools. u64 m_view_id { 0 }; }; }