dymokomi/luce-browser-engine
Source of release 0.6.1
0.6.1 / src / web / page / page_client.lucb
#==============================================================================================
#
# page_client - Web::PageClient's virtual functions: the defaults of the ones a client may
# leave alone, and the pure virtual ones every client overrides
#
# DESCRIPTION:
# Port of the PageClient virtual functions of Libraries/LibWeb/Page/Page.h (lines
# 371-497). A function with a default body (`{ }` or `return {};`) answers that default;
# a pure virtual one (`= 0`) traps when a client does not override it.
#
# Copyright (c) 2020-2022, Andreas Kling <andreas@ladybird.org>
# SPDX-License-Identifier: BSD-2-Clause
#
#==============================================================================================
# mark: PageClient's virtual functions ==========================================================
## Ported from Page.h:371 Web::PageClient::id (virtual).
pub func page_client_id_impl(this: PageClient*) -> u64:
trap("pure virtual: Web::PageClient::id")
## Ported from Page.h:372 Web::PageClient::page (virtual).
pub func page_client_page_impl(this: PageClient*) -> Page*:
trap("pure virtual: Web::PageClient::page")
## Ported from Page.h:373 Web::PageClient::page (virtual).
pub func page_client_page_const_impl(this: PageClient*) -> Page*:
trap("pure virtual: Web::PageClient::page")
## Ported from Page.h:374 Web::PageClient::is_connection_open (virtual).
pub func page_client_is_connection_open_impl(this: PageClient*) -> bool:
trap("pure virtual: Web::PageClient::is_connection_open")
## Ported from Page.h:375 Web::PageClient::is_url_suitable_for_same_process_navigation (virtual).
pub func page_client_is_url_suitable_for_same_process_navigation_impl(this: PageClient*, current_url: web_url.Url, target_url: web_url.Url) -> bool:
return true
## Ported from Page.h:376 Web::PageClient::request_new_process_for_navigation (virtual).
pub func page_client_request_new_process_for_navigation_impl(this: PageClient*, arg0: web_url.Url):
return
## Ported from Page.h:377 Web::PageClient::palette (virtual).
pub func page_client_palette_impl(this: PageClient*) -> gfx.Palette:
trap("pure virtual: Web::PageClient::palette")
## Ported from Page.h:378 Web::PageClient::screen_rect (virtual).
pub func page_client_screen_rect_impl(this: PageClient*) -> gfx.DevicePixelRect:
trap("pure virtual: Web::PageClient::screen_rect")
## Ported from Page.h:379 Web::PageClient::zoom_level (virtual).
pub func page_client_zoom_level_impl(this: PageClient*) -> f64:
trap("pure virtual: Web::PageClient::zoom_level")
## Ported from Page.h:380 Web::PageClient::device_pixel_ratio (virtual).
pub func page_client_device_pixel_ratio_impl(this: PageClient*) -> f64:
trap("pure virtual: Web::PageClient::device_pixel_ratio")
## Ported from Page.h:381 Web::PageClient::device_pixels_per_css_pixel (virtual).
pub func page_client_device_pixels_per_css_pixel_impl(this: PageClient*) -> f64:
trap("pure virtual: Web::PageClient::device_pixels_per_css_pixel")
## Ported from Page.h:382 Web::PageClient::preferred_color_scheme (virtual).
pub func page_client_preferred_color_scheme_impl(this: PageClient*) -> CssPreferredColorScheme:
trap("pure virtual: Web::PageClient::preferred_color_scheme")
## Ported from Page.h:383 Web::PageClient::preferred_contrast (virtual).
pub func page_client_preferred_contrast_impl(this: PageClient*) -> CssPreferredContrast:
trap("pure virtual: Web::PageClient::preferred_contrast")
## Ported from Page.h:384 Web::PageClient::preferred_motion (virtual).
pub func page_client_preferred_motion_impl(this: PageClient*) -> CssPreferredMotion:
trap("pure virtual: Web::PageClient::preferred_motion")
## Ported from Page.h:385 Web::PageClient::screen_count (virtual).
pub func page_client_screen_count_impl(this: PageClient*) -> usize:
trap("pure virtual: Web::PageClient::screen_count")
## Ported from Page.h:386 Web::PageClient::input_event_queue (virtual).
pub func page_client_input_event_queue_impl(this: PageClient*) -> ak.Queue[QueuedInputEvent]*:
trap("pure virtual: Web::PageClient::input_event_queue")
## Ported from Page.h:387 Web::PageClient::report_finished_handling_input_event (virtual).
pub func page_client_report_finished_handling_input_event_impl(this: PageClient*, page_id: u64, event_was_handled: EventResult):
trap("pure virtual: Web::PageClient::report_finished_handling_input_event")
## Ported from Page.h:388 Web::PageClient::request_frame (virtual).
pub func page_client_request_frame_impl(this: PageClient*):
trap("pure virtual: Web::PageClient::request_frame")
## Ported from Page.h:389 Web::PageClient::page_did_change_title (virtual).
pub func page_client_page_did_change_title_impl(this: PageClient*, arg0: ak.Utf16String):
return
## Ported from Page.h:390 Web::PageClient::page_did_change_url (virtual).
pub func page_client_page_did_change_url_impl(this: PageClient*, arg0: web_url.Url):
return
## Ported from Page.h:391 Web::PageClient::page_did_request_refresh (virtual).
pub func page_client_page_did_request_refresh_impl(this: PageClient*):
return
## Ported from Page.h:392 Web::PageClient::page_did_request_resize_window (virtual).
pub func page_client_page_did_request_resize_window_impl(this: PageClient*, arg0: gfx.IntSize):
return
## Ported from Page.h:393 Web::PageClient::page_did_request_reposition_window (virtual).
pub func page_client_page_did_request_reposition_window_impl(this: PageClient*, arg0: gfx.IntPoint):
return
## Ported from Page.h:394 Web::PageClient::page_did_request_restore_window (virtual).
pub func page_client_page_did_request_restore_window_impl(this: PageClient*):
return
## Ported from Page.h:395 Web::PageClient::page_did_request_maximize_window (virtual).
pub func page_client_page_did_request_maximize_window_impl(this: PageClient*):
return
## Ported from Page.h:396 Web::PageClient::page_did_request_minimize_window (virtual).
pub func page_client_page_did_request_minimize_window_impl(this: PageClient*):
return
## Ported from Page.h:397 Web::PageClient::page_did_request_fullscreen_window (virtual).
pub func page_client_page_did_request_fullscreen_window_impl(this: PageClient*):
return
## Ported from Page.h:398 Web::PageClient::page_did_request_exit_fullscreen (virtual).
pub func page_client_page_did_request_exit_fullscreen_impl(this: PageClient*):
return
## Ported from Page.h:399 Web::PageClient::page_did_start_loading (virtual).
pub func page_client_page_did_start_loading_impl(this: PageClient*, arg0: web_url.Url, is_redirect: bool):
return
## Ported from Page.h:400 Web::PageClient::page_did_create_new_document (virtual).
pub func page_client_page_did_create_new_document_impl(this: PageClient*, arg0: DomDocument*):
return
## Ported from Page.h:401 Web::PageClient::page_did_change_active_document_in_top_level_browsing_context (virtual).
pub func page_client_page_did_change_active_document_in_top_level_browsing_context_impl(this: PageClient*, arg0: DomDocument*):
return
## Ported from Page.h:402 Web::PageClient::page_did_finish_loading (virtual).
pub func page_client_page_did_finish_loading_impl(this: PageClient*, arg0: web_url.Url):
return
## Ported from Page.h:403 Web::PageClient::page_did_request_cursor_change (virtual).
pub func page_client_page_did_request_cursor_change_impl(this: PageClient*, arg0: gfx.Cursor):
return
## Ported from Page.h:404 Web::PageClient::page_did_request_context_menu (virtual).
pub func page_client_page_did_request_context_menu_impl(this: PageClient*, arg0: gfx.CssPixelPoint):
return
## Ported from Page.h:405 Web::PageClient::page_did_request_link_context_menu (virtual).
pub func page_client_page_did_request_link_context_menu_impl(this: PageClient*, arg0: gfx.CssPixelPoint, arg1: web_url.Url, target: ak.ByteString, modifiers: u32):
return
## Ported from Page.h:406 Web::PageClient::page_did_request_image_context_menu (virtual).
pub func page_client_page_did_request_image_context_menu_impl(this: PageClient*, arg0: gfx.CssPixelPoint, arg1: web_url.Url, target: ak.ByteString, modifiers: u32, arg4: const gfx.Bitmap*?):
return
## Ported from Page.h:407 Web::PageClient::page_did_request_media_context_menu (virtual).
pub func page_client_page_did_request_media_context_menu_impl(this: PageClient*, arg0: gfx.CssPixelPoint, target: ak.ByteString, modifiers: u32, arg3: PageMediaContextMenu):
return
## Ported from Page.h:408 Web::PageClient::page_did_click_link (virtual).
pub func page_client_page_did_click_link_impl(this: PageClient*, arg0: web_url.Url, target: ak.ByteString, modifiers: u32):
return
## Ported from Page.h:409 Web::PageClient::page_did_middle_click_link (virtual).
pub func page_client_page_did_middle_click_link_impl(this: PageClient*, arg0: web_url.Url, target: ak.ByteString, modifiers: u32):
return
## Ported from Page.h:410 Web::PageClient::page_did_request_tooltip_override (virtual).
pub func page_client_page_did_request_tooltip_override_impl(this: PageClient*, arg0: gfx.CssPixelPoint, arg1: ak.ByteString):
return
## Ported from Page.h:411 Web::PageClient::page_did_stop_tooltip_override (virtual).
pub func page_client_page_did_stop_tooltip_override_impl(this: PageClient*):
return
## Ported from Page.h:412 Web::PageClient::page_did_enter_tooltip_area (virtual).
pub func page_client_page_did_enter_tooltip_area_impl(this: PageClient*, arg0: ak.ByteString):
return
## Ported from Page.h:413 Web::PageClient::page_did_leave_tooltip_area (virtual).
pub func page_client_page_did_leave_tooltip_area_impl(this: PageClient*):
return
## Ported from Page.h:414 Web::PageClient::page_did_hover_link (virtual).
pub func page_client_page_did_hover_link_impl(this: PageClient*, arg0: web_url.Url):
return
## Ported from Page.h:415 Web::PageClient::page_did_unhover_link (virtual).
pub func page_client_page_did_unhover_link_impl(this: PageClient*):
return
## Ported from Page.h:416 Web::PageClient::page_did_change_favicon (virtual).
pub func page_client_page_did_change_favicon_impl(this: PageClient*, arg0: gfx.Bitmap):
return
## Ported from Page.h:417 Web::PageClient::page_did_request_alert (virtual).
pub func page_client_page_did_request_alert_impl(this: PageClient*, arg0: ak.String):
return
## Ported from Page.h:418 Web::PageClient::page_did_request_confirm (virtual).
pub func page_client_page_did_request_confirm_impl(this: PageClient*, arg0: ak.String):
return
## Ported from Page.h:419 Web::PageClient::page_did_request_prompt (virtual).
pub func page_client_page_did_request_prompt_impl(this: PageClient*, arg0: ak.String, arg1: ak.String):
return
## Ported from Page.h:420 Web::PageClient::page_did_request_set_prompt_text (virtual).
pub func page_client_page_did_request_set_prompt_text_impl(this: PageClient*, arg0: ak.String):
return
## Ported from Page.h:421 Web::PageClient::page_did_request_accept_dialog (virtual).
pub func page_client_page_did_request_accept_dialog_impl(this: PageClient*):
return
## Ported from Page.h:422 Web::PageClient::page_did_request_dismiss_dialog (virtual).
pub func page_client_page_did_request_dismiss_dialog_impl(this: PageClient*):
return
## Ported from Page.h:423 Web::PageClient::page_did_request_document_cookie_version (virtual).
pub func page_client_page_did_request_document_cookie_version_impl(this: PageClient*, document_index: u32) -> u64?:
return none
## Ported from Page.h:424 Web::PageClient::page_did_receive_document_cookie_version_buffer (virtual).
pub func page_client_page_did_receive_document_cookie_version_buffer_impl(this: PageClient*, document_cookie_version_buffer: gfx.CoreAnonymousBuffer):
return
## Ported from Page.h:425 Web::PageClient::page_did_request_document_cookie_version_index (virtual).
pub func page_client_page_did_request_document_cookie_version_index_impl(this: PageClient*, document_id: i64, domain: ak.String):
return
## Ported from Page.h:426 Web::PageClient::page_did_receive_document_cookie_version_index (virtual).
pub func page_client_page_did_receive_document_cookie_version_index_impl(this: PageClient*, document_id: i64, document_index: u32):
return
## Ported from Page.h:427 Web::PageClient::page_did_request_all_cookies_webdriver (virtual).
pub func page_client_page_did_request_all_cookies_webdriver_impl(this: PageClient*, arg0: web_url.Url) -> ak.Vector[HttpCookie]:
return ak.Vector[HttpCookie]()
## Ported from Page.h:428 Web::PageClient::page_did_request_all_cookies_cookiestore (virtual).
pub func page_client_page_did_request_all_cookies_cookiestore_impl(this: PageClient*, arg0: web_url.Url) -> ak.Vector[HttpCookie]:
return ak.Vector[HttpCookie]()
## Ported from Page.h:429 Web::PageClient::page_did_request_named_cookie (virtual).
pub func page_client_page_did_request_named_cookie_impl(this: PageClient*, arg0: web_url.Url, arg1: ak.String) -> HttpCookie?:
return none
## Ported from Page.h:430 Web::PageClient::page_did_request_cookie (virtual).
pub func page_client_page_did_request_cookie_impl(this: PageClient*, arg0: web_url.Url, arg1: HttpSource) -> HttpVersionedCookie:
return HttpVersionedCookie(cookie_version = none, cookie = ak.String())
## Ported from Page.h:431 Web::PageClient::page_did_set_cookie (virtual).
pub func page_client_page_did_set_cookie_impl(this: PageClient*, arg0: web_url.Url, arg1: HttpParsedCookie, arg2: HttpSource):
return
## Ported from Page.h:432 Web::PageClient::page_did_update_cookie (virtual).
pub func page_client_page_did_update_cookie_impl(this: PageClient*, arg0: HttpCookie):
return
## Ported from Page.h:433 Web::PageClient::page_did_expire_cookies_with_time_offset (virtual).
pub func page_client_page_did_expire_cookies_with_time_offset_impl(this: PageClient*, arg0: ak.Duration):
return
## Ported from Page.h:434 Web::PageClient::page_did_request_storage_item (virtual).
pub func page_client_page_did_request_storage_item_impl(this: PageClient*, storage_endpoint: StorageApiStorageEndpointType, storage_key: ak.String, bottle_key: ak.String) -> ak.String?:
return none
## Ported from Page.h:435 Web::PageClient::page_did_set_storage_item (virtual).
pub func page_client_page_did_set_storage_item_impl(this: PageClient*, storage_endpoint: StorageApiStorageEndpointType, storage_key: ak.String, bottle_key: ak.String, value: ak.String) -> WebViewStorageSetResult:
return WebViewStorageSetResult.web_view_storage_operation_error(WebViewStorageOperationError.quota_exceeded_error)
## Ported from Page.h:436 Web::PageClient::page_did_remove_storage_item (virtual).
pub func page_client_page_did_remove_storage_item_impl(this: PageClient*, storage_endpoint: StorageApiStorageEndpointType, storage_key: ak.String, bottle_key: ak.String):
return
## Ported from Page.h:437 Web::PageClient::page_did_request_storage_keys (virtual).
pub func page_client_page_did_request_storage_keys_impl(this: PageClient*, storage_endpoint: StorageApiStorageEndpointType, storage_key: ak.String) -> ak.Vector[ak.String]:
return ak.Vector[ak.String]()
## Ported from Page.h:438 Web::PageClient::page_did_clear_storage (virtual).
pub func page_client_page_did_clear_storage_impl(this: PageClient*, storage_endpoint: StorageApiStorageEndpointType, storage_key: ak.String):
return
## Ported from Page.h:439 Web::PageClient::page_did_update_resource_count (virtual).
pub func page_client_page_did_update_resource_count_impl(this: PageClient*, arg0: i32):
return
## Ported from Page.h:444 Web::PageClient::page_did_request_new_web_view (virtual).
pub func page_client_page_did_request_new_web_view_impl(this: PageClient*, arg0: HtmlActivateTab, arg1: HtmlWebViewHints, arg2: HtmlNoOpener) -> PageClientNewWebViewResult:
return PageClientNewWebViewResult(page = none, window_handle = ak.String())
## Ported from Page.h:445 Web::PageClient::page_did_request_activate_tab (virtual).
pub func page_client_page_did_request_activate_tab_impl(this: PageClient*):
return
## Ported from Page.h:446 Web::PageClient::page_did_close_top_level_traversable (virtual).
pub func page_client_page_did_close_top_level_traversable_impl(this: PageClient*):
return
## Ported from Page.h:447 Web::PageClient::page_did_update_navigation_buttons_state (virtual).
pub func page_client_page_did_update_navigation_buttons_state_impl(this: PageClient*, back_enabled: bool, forward_enabled: bool):
return
## Ported from Page.h:448 Web::PageClient::page_did_allocate_backing_stores (virtual).
pub func page_client_page_did_allocate_backing_stores_impl(this: PageClient*, front_bitmap_id: i32, front_backing_store: gfx.SharedImage, back_bitmap_id: i32, back_backing_store: gfx.SharedImage):
return
## Ported from Page.h:450 Web::PageClient::request_file (virtual).
pub func page_client_request_file_impl(this: PageClient*, arg0: FileRequest):
trap("pure virtual: Web::PageClient::request_file")
## Ported from Page.h:453 Web::PageClient::page_did_request_color_picker (virtual).
pub func page_client_page_did_request_color_picker_impl(this: PageClient*, current_color: gfx.Color):
return
## Ported from Page.h:454 Web::PageClient::page_did_request_file_picker (virtual).
pub func page_client_page_did_request_file_picker_impl(this: PageClient*, accepted_file_types: HtmlFileFilter, arg1: HtmlAllowMultipleFiles):
return
## Ported from Page.h:455 Web::PageClient::page_did_request_select_dropdown (virtual).
pub func page_client_page_did_request_select_dropdown_impl(this: PageClient*, content_position: gfx.CssPixelPoint, minimum_width: gfx.CssPixels, items: ak.Vector[HtmlSelectItem]):
return
## Ported from Page.h:457 Web::PageClient::page_did_finish_test (virtual).
pub func page_client_page_did_finish_test_impl(this: PageClient*, text: ak.String):
return
## Ported from Page.h:458 Web::PageClient::page_did_set_test_timeout (virtual).
pub func page_client_page_did_set_test_timeout_impl(this: PageClient*, milliseconds: f64):
return
## Ported from Page.h:459 Web::PageClient::page_did_receive_reference_test_metadata (virtual).
pub func page_client_page_did_receive_reference_test_metadata_impl(this: PageClient*, arg0: ak.JsonValue2):
return
## Ported from Page.h:460 Web::PageClient::page_did_receive_test_variant_metadata (virtual).
pub func page_client_page_did_receive_test_variant_metadata_impl(this: PageClient*, arg0: ak.JsonValue2):
return
## Ported from Page.h:462 Web::PageClient::page_did_set_browser_zoom (virtual).
pub func page_client_page_did_set_browser_zoom_impl(this: PageClient*, factor: f64):
return
## Ported from Page.h:463 Web::PageClient::page_did_set_device_pixel_ratio_for_testing (virtual).
pub func page_client_page_did_set_device_pixel_ratio_for_testing_impl(this: PageClient*, ratio: f64):
return
## Ported from Page.h:465 Web::PageClient::page_did_change_theme_color (virtual).
pub func page_client_page_did_change_theme_color_impl(this: PageClient*, arg0: gfx.Color):
return
## Ported from Page.h:467 Web::PageClient::page_did_insert_clipboard_entry (virtual).
pub func page_client_page_did_insert_clipboard_entry_impl(this: PageClient*, arg0: ClipboardSystemClipboardRepresentation, presentation_style: ak.StringView):
return
## Ported from Page.h:468 Web::PageClient::page_did_request_clipboard_entries (virtual).
pub func page_client_page_did_request_clipboard_entries_impl(this: PageClient*, request_id: u64):
return
## Ported from Page.h:470 Web::PageClient::page_did_change_audio_play_state (virtual).
pub func page_client_page_did_change_audio_play_state_impl(this: PageClient*, arg0: HtmlAudioPlayState):
return
## Ported from Page.h:472 Web::PageClient::page_did_start_network_request (virtual).
pub func page_client_page_did_start_network_request_impl(this: PageClient*, request_id: u64, url: web_url.Url, method: ak.ByteString, request_headers: ak.Vector[HttpHeader], request_body: const u8[], initiator_type: ak.String?):
return
## Ported from Page.h:473 Web::PageClient::page_did_receive_network_response_headers (virtual).
pub func page_client_page_did_receive_network_response_headers_impl(this: PageClient*, request_id: u64, status_code: u32, reason_phrase: ak.String?, response_headers: ak.Vector[HttpHeader]):
return
## Ported from Page.h:474 Web::PageClient::page_did_receive_network_response_body (virtual).
pub func page_client_page_did_receive_network_response_body_impl(this: PageClient*, request_id: u64, data: const u8[]):
return
## Ported from Page.h:475 Web::PageClient::page_did_finish_network_request (virtual).
pub func page_client_page_did_finish_network_request_impl(this: PageClient*, request_id: u64, body_size: u64, timing_info: RequestsRequestTimingInfo, network_error: RequestsNetworkError?):
return
## Ported from Page.h:476 Web::PageClient::page_did_report_worker_exception (virtual).
pub func page_client_page_did_report_worker_exception_impl(this: PageClient*, message: ak.String, filename: ak.String, lineno: u32, colno: u32):
return
## Ported from Page.h:477 Web::PageClient::page_did_post_broadcast_channel_message (virtual).
pub func page_client_page_did_post_broadcast_channel_message_impl(this: PageClient*, message: HtmlBroadcastChannelMessage):
return
## Ported from Page.h:484 Web::PageClient::request_worker_agent (virtual).
pub func page_client_request_worker_agent_impl(this: PageClient*, worker_type: BindAgentType) -> PageClientWorkerAgentResponse:
return PageClientWorkerAgentResponse()
## Ported from Page.h:486 Web::PageClient::page_did_mutate_dom (virtual).
pub func page_client_page_did_mutate_dom_impl(this: PageClient*, type_: ak.FlyString, target: DomNode*, added_nodes: DomNodeList*, removed_nodes: DomNodeList*, previous_sibling: DomNode*?, next_sibling: DomNode*?, attribute_name: ak.String?):
return
## Ported from Page.h:488 Web::PageClient::page_did_paint (virtual).
pub func page_client_page_did_paint_impl(this: PageClient*, content_rect: gfx.DevicePixelRect, bitmap_id: i32):
return
## Ported from Page.h:489 Web::PageClient::page_did_take_screenshot (virtual).
pub func page_client_page_did_take_screenshot_impl(this: PageClient*, arg0: gfx.ShareableBitmap):
return
## Ported from Page.h:491 Web::PageClient::received_message_from_web_ui (virtual).
pub func page_client_received_message_from_web_ui_impl(this: PageClient*, name: ak.String, data: JsValue):
return
## Ported from Page.h:493 Web::PageClient::display_list_player_type (virtual).
pub func page_client_display_list_player_type_impl(this: PageClient*) -> DisplayListPlayerType:
trap("pure virtual: Web::PageClient::display_list_player_type")
## Ported from Page.h:495 Web::PageClient::is_headless (virtual).
pub func page_client_is_headless_impl(this: PageClient*) -> bool:
trap("pure virtual: Web::PageClient::is_headless")
## Ported from Page.h:497 Web::PageClient::is_svg_page_client (virtual).
pub func page_client_is_svg_page_client_impl(this: PageClient*) -> bool:
return false