Luce packages
LuceLuce BaseLuciaOS

dymokomi/luce-browser-engine

Source of release 0.6.0

0.6.0 / src / web / ui_events / mouse_event.lucb

#==============================================================================================
#
#   mouse_event - UIEvents::MouseEvent, and MouseButton.h's button codes
#
#   DESCRIPTION:
#       Port of Libraries/LibWeb/UIEvents/MouseEvent.cpp (lines 1-198) with MouseEvent.h's
#       inline members (the coordinate accessors, which floor the coordinates of untrusted
#       events, and the modifier keys), and of MouseButton.h's mouse_button_to_button_code and
#       button_code_to_mouse_button (lines 26-61).
#
#       Copyright (c) 2020, Andreas Kling <andreas@ladybird.org>
#       Copyright (c) 2021, Tobias Christiansen <tobyase@serenityos.org>
#       Copyright (c) 2022, Andrew Kaster <akaster@serenityos.org>
#       SPDX-License-Identifier: BSD-2-Clause
#
#==============================================================================================

# mark: Button codes ============================================================================

## Ported from MouseButton.h:27 Web::UIEvents::mouse_button_to_button_code.
## https://w3c.github.io/pointerevents/#the-button-property
pub func ui_events_mouse_button_to_button_code(button: UiEventsMouseButton) -> i16:
    return match button:
        .none_ => -1
        .primary => 0
        .middle => 1
        .secondary => 2
        .backward => 3
        .forward => 4
        _ => trap("VERIFY_NOT_REACHED")

## Ported from MouseButton.h:48 Web::UIEvents::button_code_to_mouse_button.
## https://w3c.github.io/pointerevents/#the-button-property
pub func ui_events_button_code_to_mouse_button(button: i16) -> UiEventsMouseButton:
    if button == 0:
        return UiEventsMouseButton.primary
    if button == 1:
        return UiEventsMouseButton.middle
    if button == 2:
        return UiEventsMouseButton.secondary
    if button == 3:
        return UiEventsMouseButton.backward
    if button == 4:
        return UiEventsMouseButton.forward
    return UiEventsMouseButton.none_

## `modifiers & flag`, as a bool.
func ui_events_has_modifier(modifiers: u32, flag: UiEventsKeyModifier) -> bool:
    return (modifiers & (u32)flag) != 0

# mark: Construction ============================================================================

## Ported from MouseEvent.cpp:24 Web::UIEvents::MouseEvent::MouseEvent.
pub func ui_events_mouse_event_construct(this: UiEventsMouseEvent*, realm: Realm*, event_name: ak.FlyString, event_init: UiEventsMouseEventInit, page_x: f64, page_y: f64, offset_x: f64, offset_y: f64):
    let modifier_init = event_init.event_modifier_init
    ui_events_ui_event_construct_ui_event_init(this.ui_events_ui_event(), realm, event_name, modifier_init.ui_event_init)
    this.m_screen_x = event_init.screen_x
    this.m_screen_y = event_init.screen_y
    this.m_page_x = page_x
    this.m_page_y = page_y
    this.m_client_x = event_init.client_x
    this.m_client_y = event_init.client_y
    this.m_offset_x = offset_x
    this.m_offset_y = offset_y
    this.m_ctrl_key = modifier_init.ctrl_key
    this.m_shift_key = modifier_init.shift_key
    this.m_alt_key = modifier_init.alt_key
    this.m_meta_key = modifier_init.meta_key
    this.m_modifier_alt_graph = modifier_init.modifier_alt_graph
    this.m_modifier_caps_lock = modifier_init.modifier_caps_lock
    this.m_modifier_fn = modifier_init.modifier_fn
    this.m_modifier_fn_lock = modifier_init.modifier_fn_lock
    this.m_modifier_hyper = modifier_init.modifier_hyper
    this.m_modifier_num_lock = modifier_init.modifier_num_lock
    this.m_modifier_scroll_lock = modifier_init.modifier_scroll_lock
    this.m_modifier_super = modifier_init.modifier_super
    this.m_modifier_symbol = modifier_init.modifier_symbol
    this.m_modifier_symbol_lock = modifier_init.modifier_symbol_lock
    this.m_movement_x = event_init.movement_x
    this.m_movement_y = event_init.movement_y
    this.m_button = event_init.button
    this.m_buttons = event_init.buttons
    this.m_related_target = event_init.related_target

## Ported from MouseEvent.cpp:57 Web::UIEvents::MouseEvent::initialize (override).
pub func ui_events_mouse_event_initialize_impl(base: JsCell*, realm: Realm*):
    web_set_prototype_for_interface(base, realm, BindInterfaceName.mouse_event)
    ui_events_ui_event_initialize_impl(base, realm)

## Ported from MouseEvent.cpp:63 Web::UIEvents::MouseEvent::visit_edges (override).
pub func ui_events_mouse_event_visit_edges_impl(base: gc.Cell*, visitor: gc.CellVisitor*):
    let this = (UiEventsMouseEvent*)base
    ui_events_ui_event_visit_edges_impl(base, visitor)
    gc.cell_visitor_visit_t(visitor, this.m_related_target)

## Ported from MouseEvent.h:120 Web::UIEvents::MouseEvent::is_mouse_event (override).
pub func ui_events_mouse_event_is_mouse_event_impl(this: DomEvent*) -> bool:
    return true

## Ported from MouseEvent.cpp:146 Web::UIEvents::MouseEvent::create.
pub func ui_events_mouse_event_create(realm: Realm*, event_name: ak.FlyString, event_init: UiEventsMouseEventInit = UiEventsMouseEventInit(), page_x: f64 = 0.0, page_y: f64 = 0.0, offset_x: f64 = 0.0, offset_y: f64 = 0.0) -> UiEventsMouseEvent*:
    return realm_create_ui_events_mouse_event(realm, realm, event_name, event_init, page_x, page_y, offset_x, offset_y)

## Ported from MouseEvent.cpp:151 Web::UIEvents::MouseEvent::construct_impl.
pub func ui_events_mouse_event_construct_impl(realm: Realm*, event_name: ak.FlyString, event_init: UiEventsMouseEventInit) -> UiEventsMouseEvent*!:
    # https://drafts.csswg.org/cssom-view/#dom-mouseevent-pagex
    # For a newly constructed event, pageX/pageY default to clientX/clientY (scrollX/scrollY are 0).
    # https://drafts.csswg.org/cssom-view/#dom-mouseevent-offsetx
    # For a newly constructed event with no target, offsetX/offsetY default to clientX/clientY.
    return ui_events_mouse_event_create(realm, event_name, event_init, event_init.client_x, event_init.client_y, event_init.client_x, event_init.client_y)

## Ported from MouseEvent.cpp:198 Web::UIEvents::MouseEvent::create_from_platform_event.
pub func ui_events_mouse_event_create_from_platform_event(realm: Realm*, window_proxy: HtmlWindowProxy*?, event_name: ak.FlyString, screen: gfx.CssPixelPoint, page: gfx.CssPixelPoint, client: gfx.CssPixelPoint, offset: gfx.CssPixelPoint, movement: gfx.CssPixelPoint?, button: u32, buttons: u32, modifiers: u32, detail: i32 = 0) -> UiEventsMouseEvent*!:
    var event_init = UiEventsMouseEventInit()
    event_init.event_modifier_init.ui_event_init.detail = detail
    event_init.event_modifier_init.ctrl_key = ui_events_has_modifier(modifiers, UiEventsKeyModifier.mod_ctrl)
    event_init.event_modifier_init.shift_key = ui_events_has_modifier(modifiers, UiEventsKeyModifier.mod_shift)
    event_init.event_modifier_init.alt_key = ui_events_has_modifier(modifiers, UiEventsKeyModifier.mod_alt)
    event_init.event_modifier_init.meta_key = ui_events_has_modifier(modifiers, UiEventsKeyModifier.mod_super)
    event_init.screen_x = ui_events_css_x(&screen)
    event_init.screen_y = ui_events_css_y(&screen)
    event_init.client_x = ui_events_css_x(&client)
    event_init.client_y = ui_events_css_y(&client)
    event_init.event_modifier_init.ui_event_init.view = window_proxy
    if let moved = movement:
        event_init.movement_x = ui_events_css_x(&moved)
        event_init.movement_y = ui_events_css_y(&moved)
    event_init.button = ui_events_mouse_button_to_button_code((UiEventsMouseButton)(u8)button)
    event_init.buttons = (u16)buttons
    let event = ui_events_mouse_event_create(realm, event_name, event_init, ui_events_css_x(&page), ui_events_css_y(&page), ui_events_css_x(&offset), ui_events_css_y(&offset))
    dom_event_set_is_trusted(event.dom_event(), true)
    dom_event_set_bubbles(event.dom_event(), true)
    dom_event_set_cancelable(event.dom_event(), true)
    dom_event_set_composed(event.dom_event(), true)
    return event

## `point.x().to_double()`.
pub func ui_events_css_x(point: const gfx.CssPixelPoint*) -> f64:
    let x = gfx.css_pixel_point_x(point)
    return gfx.css_pixels_to_double_const(&x)

## `point.y().to_double()`.
pub func ui_events_css_y(point: const gfx.CssPixelPoint*) -> f64:
    let y = gfx.css_pixel_point_y(point)
    return gfx.css_pixels_to_double_const(&y)

# mark: Accessors ===============================================================================

## The coordinate as an untrusted event reports it: `is_trusted() ? value : AK::floor(value)`.
func ui_events_mouse_event_trusted_or_floor(this: UiEventsMouseEvent*, value: f64) -> f64:
    return value if dom_event_is_trusted(this.dom_event()) else math.floor(value)

## Ported from MouseEvent.h:40 Web::UIEvents::MouseEvent::screen_x (virtual).
pub func ui_events_mouse_event_screen_x_impl(this: UiEventsMouseEvent*) -> f64:
    return ui_events_mouse_event_trusted_or_floor(this, this.m_screen_x)

## Ported from MouseEvent.h:41 Web::UIEvents::MouseEvent::screen_y (virtual).
pub func ui_events_mouse_event_screen_y_impl(this: UiEventsMouseEvent*) -> f64:
    return ui_events_mouse_event_trusted_or_floor(this, this.m_screen_y)

## Ported from MouseEvent.h:43 Web::UIEvents::MouseEvent::page_x (virtual).
pub func ui_events_mouse_event_page_x_impl(this: UiEventsMouseEvent*) -> f64:
    return ui_events_mouse_event_trusted_or_floor(this, this.m_page_x)

## Ported from MouseEvent.h:44 Web::UIEvents::MouseEvent::page_y (virtual).
pub func ui_events_mouse_event_page_y_impl(this: UiEventsMouseEvent*) -> f64:
    return ui_events_mouse_event_trusted_or_floor(this, this.m_page_y)

## Ported from MouseEvent.h:46 Web::UIEvents::MouseEvent::client_x (virtual).
pub func ui_events_mouse_event_client_x_impl(this: UiEventsMouseEvent*) -> f64:
    return ui_events_mouse_event_trusted_or_floor(this, this.m_client_x)

## Ported from MouseEvent.h:47 Web::UIEvents::MouseEvent::client_y (virtual).
pub func ui_events_mouse_event_client_y_impl(this: UiEventsMouseEvent*) -> f64:
    return ui_events_mouse_event_trusted_or_floor(this, this.m_client_y)

## Ported from MouseEvent.h:52 Web::UIEvents::MouseEvent::offset_x (virtual).
pub func ui_events_mouse_event_offset_x_impl(this: UiEventsMouseEvent*) -> f64:
    return ui_events_mouse_event_trusted_or_floor(this, this.m_offset_x)

## Ported from MouseEvent.h:53 Web::UIEvents::MouseEvent::offset_y (virtual).
pub func ui_events_mouse_event_offset_y_impl(this: UiEventsMouseEvent*) -> f64:
    return ui_events_mouse_event_trusted_or_floor(this, this.m_offset_y)

## Ported from MouseEvent.h:55 Web::UIEvents::MouseEvent::ctrl_key.
pub func ui_events_mouse_event_ctrl_key(this: UiEventsMouseEvent*) -> bool:
    return this.m_ctrl_key

## Ported from MouseEvent.h:56 Web::UIEvents::MouseEvent::shift_key.
pub func ui_events_mouse_event_shift_key(this: UiEventsMouseEvent*) -> bool:
    return this.m_shift_key

## Ported from MouseEvent.h:57 Web::UIEvents::MouseEvent::alt_key.
pub func ui_events_mouse_event_alt_key(this: UiEventsMouseEvent*) -> bool:
    return this.m_alt_key

## Ported from MouseEvent.h:58 Web::UIEvents::MouseEvent::meta_key.
pub func ui_events_mouse_event_meta_key(this: UiEventsMouseEvent*) -> bool:
    return this.m_meta_key

## Ported from MouseEvent.h:60 Web::UIEvents::MouseEvent::platform_ctrl_key: Meta on macOS, Control elsewhere.
pub func ui_events_mouse_event_platform_ctrl_key(this: UiEventsMouseEvent*) -> bool:
    if os.macos:
        return ui_events_mouse_event_meta_key(this)
    return ui_events_mouse_event_ctrl_key(this)

## Ported from MouseEvent.h:69 Web::UIEvents::MouseEvent::button.
pub func ui_events_mouse_event_button(this: UiEventsMouseEvent*) -> i16:
    return this.m_button

## Ported from MouseEvent.h:70 Web::UIEvents::MouseEvent::buttons.
pub func ui_events_mouse_event_buttons(this: UiEventsMouseEvent*) -> u16:
    return this.m_buttons

## Ported from MouseEvent.h:72 Web::UIEvents::MouseEvent::related_target.
pub func ui_events_mouse_event_related_target(this: UiEventsMouseEvent*) -> DomEventTarget*?:
    return this.m_related_target

## Ported from MouseEvent.h:76 Web::UIEvents::MouseEvent::which (override).
pub func ui_events_mouse_event_which_impl(base: UiEventsUiEvent*) -> u32:
    let this = (UiEventsMouseEvent*)base
    return (u32)((i32)this.m_button + 1)

## Ported from MouseEvent.h:85 Web::UIEvents::MouseEvent::set_offset_x.
pub func ui_events_mouse_event_set_offset_x(this: UiEventsMouseEvent*, offset_x: f64):
    this.m_offset_x = offset_x

## Ported from MouseEvent.h:86 Web::UIEvents::MouseEvent::set_offset_y.
pub func ui_events_mouse_event_set_offset_y(this: UiEventsMouseEvent*, offset_y: f64):
    this.m_offset_y = offset_y

## Ported from MouseEvent.cpp:69 Web::UIEvents::MouseEvent::get_modifier_state.
pub func ui_events_mouse_event_get_modifier_state(this: UiEventsMouseEvent*, key_arg: const ak.String*) -> bool:
    if ak.string_eq_string_view(key_arg, ak.sv("Control")): return this.m_ctrl_key
    if ak.string_eq_string_view(key_arg, ak.sv("Shift")): return this.m_shift_key
    if ak.string_eq_string_view(key_arg, ak.sv("Alt")): return this.m_alt_key
    if ak.string_eq_string_view(key_arg, ak.sv("Meta")): return this.m_meta_key
    if ak.string_eq_string_view(key_arg, ak.sv("AltGraph")): return this.m_modifier_alt_graph
    if ak.string_eq_string_view(key_arg, ak.sv("CapsLock")): return this.m_modifier_caps_lock
    if ak.string_eq_string_view(key_arg, ak.sv("Fn")): return this.m_modifier_fn
    if ak.string_eq_string_view(key_arg, ak.sv("FnLock")): return this.m_modifier_fn_lock
    if ak.string_eq_string_view(key_arg, ak.sv("Hyper")): return this.m_modifier_hyper
    if ak.string_eq_string_view(key_arg, ak.sv("NumLock")): return this.m_modifier_num_lock
    if ak.string_eq_string_view(key_arg, ak.sv("ScrollLock")): return this.m_modifier_scroll_lock
    if ak.string_eq_string_view(key_arg, ak.sv("Super")): return this.m_modifier_super
    if ak.string_eq_string_view(key_arg, ak.sv("Symbol")): return this.m_modifier_symbol
    if ak.string_eq_string_view(key_arg, ak.sv("SymbolLock")): return this.m_modifier_symbol_lock
    return false

## Ported from MouseEvent.cpp:105 Web::UIEvents::MouseEvent::init_mouse_event.
## https://w3c.github.io/uievents/#dom-mouseevent-initmouseevent
pub func ui_events_mouse_event_init_mouse_event(this: UiEventsMouseEvent*, type_: ak.String, bubbles: bool, cancelable: bool, view: HtmlWindowProxy*?, detail: i32, screen_x: i32, screen_y: i32, client_x: i32, client_y: i32,
                                                ctrl_key: bool, alt_key: bool, shift_key: bool, meta_key: bool, button: i16, related_target: DomEventTarget*?):
    # Initializes attributes of a MouseEvent object. This method has the same behavior as UIEvent.initUIEvent().

    # 1. If this’s dispatch flag is set, then return.
    if dom_event_dispatched(this.dom_event()):
        return

    # 2. Initialize this with type, bubbles, and cancelable.
    dom_event_initialize_event(this.dom_event(), type_, bubbles, cancelable)

    # Implementation Defined: Initialise other values.
    this.ui_event.m_view = view
    this.ui_event.m_detail = detail
    this.m_screen_x = (f64)screen_x
    this.m_screen_y = (f64)screen_y
    this.m_client_x = (f64)client_x
    this.m_client_y = (f64)client_y
    this.m_ctrl_key = ctrl_key
    this.m_shift_key = shift_key
    this.m_alt_key = alt_key
    this.m_meta_key = meta_key
    this.m_button = button
    this.m_related_target = related_target

## Ported from MouseEvent.cpp:165 Web::UIEvents::MouseEvent::clone (virtual).
pub func ui_events_mouse_event_clone_impl(this: UiEventsMouseEvent*) -> UiEventsMouseEvent*:
    var init = UiEventsMouseEventInit()
    init.screen_x = this.m_screen_x
    init.screen_y = this.m_screen_y
    init.client_x = this.m_client_x
    init.client_y = this.m_client_y
    init.movement_x = this.m_movement_x
    init.movement_y = this.m_movement_y
    init.button = this.m_button
    init.buttons = this.m_buttons
    init.related_target = this.m_related_target
    init.event_modifier_init.ctrl_key = this.m_ctrl_key
    init.event_modifier_init.shift_key = this.m_shift_key
    init.event_modifier_init.alt_key = this.m_alt_key
    init.event_modifier_init.meta_key = this.m_meta_key
    init.event_modifier_init.modifier_alt_graph = this.m_modifier_alt_graph
    init.event_modifier_init.modifier_caps_lock = this.m_modifier_caps_lock
    init.event_modifier_init.modifier_fn = this.m_modifier_fn
    init.event_modifier_init.modifier_fn_lock = this.m_modifier_fn_lock
    init.event_modifier_init.modifier_hyper = this.m_modifier_hyper
    init.event_modifier_init.modifier_num_lock = this.m_modifier_num_lock
    init.event_modifier_init.modifier_scroll_lock = this.m_modifier_scroll_lock
    init.event_modifier_init.modifier_super = this.m_modifier_super
    init.event_modifier_init.modifier_symbol = this.m_modifier_symbol
    init.event_modifier_init.modifier_symbol_lock = this.m_modifier_symbol_lock
    init.event_modifier_init.ui_event_init.view = ui_events_ui_event_view(this.ui_events_ui_event())
    init.event_modifier_init.ui_event_init.detail = ui_events_ui_event_detail(this.ui_events_ui_event())
    return ui_events_mouse_event_create(bind_platform_object_realm(this.bind_platform_object()), dom_event_type(this.dom_event()), init, this.m_page_x, this.m_page_y, this.m_offset_x, this.m_offset_y)