From 3964f8649de0c2ea1424096b0e439a57e90be635 Mon Sep 17 00:00:00 2001 From: nikneym Date: Wed, 10 Sep 2025 17:14:34 +0300 Subject: [PATCH 1/8] initial keyboard event --- src/browser/events/event.zig | 11 +++- src/browser/events/keyboard_event.zig | 80 +++++++++++++++++++++++++++ src/browser/netsurf.zig | 2 +- src/tests/events/keyboard.html | 22 ++++++++ 4 files changed, 113 insertions(+), 2 deletions(-) create mode 100644 src/browser/events/keyboard_event.zig create mode 100644 src/tests/events/keyboard.html diff --git a/src/browser/events/event.zig b/src/browser/events/event.zig index cc82ab574..9e3c36df2 100644 --- a/src/browser/events/event.zig +++ b/src/browser/events/event.zig @@ -33,11 +33,20 @@ const AbortSignal = @import("../html/AbortController.zig").AbortSignal; const CustomEvent = @import("custom_event.zig").CustomEvent; const ProgressEvent = @import("../xhr/progress_event.zig").ProgressEvent; const MouseEvent = @import("mouse_event.zig").MouseEvent; +const KeyboardEvent = @import("keyboard_event.zig").KeyboardEvent; const ErrorEvent = @import("../html/error_event.zig").ErrorEvent; const MessageEvent = @import("../dom/MessageChannel.zig").MessageEvent; // Event interfaces -pub const Interfaces = .{ Event, CustomEvent, ProgressEvent, MouseEvent, ErrorEvent, MessageEvent }; +pub const Interfaces = .{ + Event, + CustomEvent, + ProgressEvent, + MouseEvent, + KeyboardEvent, + ErrorEvent, + MessageEvent, +}; pub const Union = generate.Union(Interfaces); diff --git a/src/browser/events/keyboard_event.zig b/src/browser/events/keyboard_event.zig new file mode 100644 index 000000000..2a5a27c9a --- /dev/null +++ b/src/browser/events/keyboard_event.zig @@ -0,0 +1,80 @@ +const std = @import("std"); +const log = @import("../../log.zig"); + +const netsurf = @import("../netsurf.zig"); +const Event = @import("event.zig").Event; +const JsObject = @import("../env.zig").JsObject; + +const c = @cImport({ + @cInclude("dom/dom.h"); + @cInclude("core/pi.h"); + @cInclude("dom/bindings/hubbub/parser.h"); + @cInclude("events/event_target.h"); + @cInclude("events/event.h"); + @cInclude("events/mouse_event.h"); + @cInclude("events/keyboard_event.h"); + @cInclude("utils/validate.h"); + @cInclude("html/html_element.h"); + @cInclude("html/html_document.h"); +}); + +// TODO: We currently don't have a UIEvent interface so we skip it in the prototype chain. +// https://developer.mozilla.org/en-US/docs/Web/API/UIEvent +const UIEvent = Event; + +// https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent +pub const KeyboardEvent = struct { + pub const Self = netsurf.KeyboardEvent; + pub const prototype = *UIEvent; + + pub const KeyLocationCode = enum(u16) { + standard = 0x00, + left = 0x01, + right = 0x02, + numpad = 0x03, + mobile = 0x04, // Non-standard, deprecated. + joystick = 0x05, // Non-standard, deprecated. + }; + + pub const ConstructorOptions = struct { + key: []const u8 = "", + code: []const u8 = "", + location: KeyLocationCode = .standard, + char_code: u32 = 0, + key_code: u32 = 0, + which: u32 = 0, + repeat: bool = false, + ctrl_key: bool = false, + shift_key: bool = false, + alt_key: bool = false, + meta_key: bool = false, + is_composing: bool = false, + }; + + pub fn constructor(event_type: []const u8, maybe_options: ?ConstructorOptions) !*netsurf.KeyboardEvent { + const options = maybe_options orelse ConstructorOptions{}; + + const event = try netsurf.keyboardEventCreate(); + try netsurf.keyboardEventInit( + event, + event_type, + .{ + .bubbles = false, + .cancelable = false, + .key = options.key, + .code = options.code, + .alt = options.alt_key, + .ctrl = options.ctrl_key, + .meta = options.meta_key, + .shift = options.shift_key, + }, + ); + + return event; + } +}; + +const testing = @import("../../testing.zig"); +test "Browser: Events.Keyboard" { + try testing.htmlRunner("events/keyboard.html"); +} diff --git a/src/browser/netsurf.zig b/src/browser/netsurf.zig index a663037b5..d8ef79e3b 100644 --- a/src/browser/netsurf.zig +++ b/src/browser/netsurf.zig @@ -388,7 +388,7 @@ pub const DOMError = error{ const DOMException = c.dom_exception; -fn DOMErr(except: DOMException) DOMError!void { +pub fn DOMErr(except: DOMException) DOMError!void { return switch (except) { c.DOM_NO_ERR => return, c.DOM_INDEX_SIZE_ERR => DOMError.IndexSize, diff --git a/src/tests/events/keyboard.html b/src/tests/events/keyboard.html new file mode 100644 index 000000000..b3941fddf --- /dev/null +++ b/src/tests/events/keyboard.html @@ -0,0 +1,22 @@ + + + + From 8895c70c7ffea80aeb7f9bcaffdabe50f6b59c47 Mon Sep 17 00:00:00 2001 From: nikneym Date: Thu, 11 Sep 2025 13:08:32 +0300 Subject: [PATCH 2/8] make `toInterface` be aware of `KeyboardEvent` --- src/browser/events/event.zig | 1 + src/browser/netsurf.zig | 1 + 2 files changed, 2 insertions(+) diff --git a/src/browser/events/event.zig b/src/browser/events/event.zig index 9e3c36df2..52057a2d5 100644 --- a/src/browser/events/event.zig +++ b/src/browser/events/event.zig @@ -72,6 +72,7 @@ pub const Event = struct { .mouse_event => .{ .MouseEvent = @as(*parser.MouseEvent, @ptrCast(evt)) }, .error_event => .{ .ErrorEvent = @as(*ErrorEvent, @ptrCast(evt)).* }, .message_event => .{ .MessageEvent = @as(*MessageEvent, @ptrCast(evt)).* }, + .keyboard_event => .{ .KeyboardEvent = @as(*parser.KeyboardEvent, @ptrCast(evt)) }, }; } diff --git a/src/browser/netsurf.zig b/src/browser/netsurf.zig index d8ef79e3b..a86095f37 100644 --- a/src/browser/netsurf.zig +++ b/src/browser/netsurf.zig @@ -548,6 +548,7 @@ pub const EventType = enum(u8) { abort_signal = 5, xhr_event = 6, message_event = 7, + keyboard_event = 8, }; pub const MutationEvent = c.dom_mutation_event; From 68e237eec510852f4d3ba596c9d7f083c7c9972d Mon Sep 17 00:00:00 2001 From: nikneym Date: Thu, 11 Sep 2025 13:09:37 +0300 Subject: [PATCH 3/8] add license --- src/browser/events/keyboard_event.zig | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/src/browser/events/keyboard_event.zig b/src/browser/events/keyboard_event.zig index 2a5a27c9a..70560aa50 100644 --- a/src/browser/events/keyboard_event.zig +++ b/src/browser/events/keyboard_event.zig @@ -1,3 +1,21 @@ +// Copyright (C) 2023-2024 Lightpanda (Selecy SAS) +// +// Francis Bouvier +// Pierre Tachoire +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as +// published by the Free Software Foundation, either version 3 of the +// License, or (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + const std = @import("std"); const log = @import("../../log.zig"); From f79f25bcf46379d6911fa0d330ddcc74859f08a4 Mon Sep 17 00:00:00 2001 From: nikneym Date: Thu, 11 Sep 2025 13:13:36 +0300 Subject: [PATCH 4/8] implement `KeyboardEvent` properties and methods --- src/browser/events/keyboard_event.zig | 140 +++++++++++++++++++------- src/browser/netsurf.zig | 57 ++++++++--- src/browser/page.zig | 8 +- 3 files changed, 148 insertions(+), 57 deletions(-) diff --git a/src/browser/events/keyboard_event.zig b/src/browser/events/keyboard_event.zig index 70560aa50..a3404a8e8 100644 --- a/src/browser/events/keyboard_event.zig +++ b/src/browser/events/keyboard_event.zig @@ -18,24 +18,12 @@ const std = @import("std"); const log = @import("../../log.zig"); +const builtin = @import("builtin"); const netsurf = @import("../netsurf.zig"); const Event = @import("event.zig").Event; const JsObject = @import("../env.zig").JsObject; -const c = @cImport({ - @cInclude("dom/dom.h"); - @cInclude("core/pi.h"); - @cInclude("dom/bindings/hubbub/parser.h"); - @cInclude("events/event_target.h"); - @cInclude("events/event.h"); - @cInclude("events/mouse_event.h"); - @cInclude("events/keyboard_event.h"); - @cInclude("utils/validate.h"); - @cInclude("html/html_element.h"); - @cInclude("html/html_document.h"); -}); - // TODO: We currently don't have a UIEvent interface so we skip it in the prototype chain. // https://developer.mozilla.org/en-US/docs/Web/API/UIEvent const UIEvent = Event; @@ -45,51 +33,125 @@ pub const KeyboardEvent = struct { pub const Self = netsurf.KeyboardEvent; pub const prototype = *UIEvent; - pub const KeyLocationCode = enum(u16) { - standard = 0x00, - left = 0x01, - right = 0x02, - numpad = 0x03, - mobile = 0x04, // Non-standard, deprecated. - joystick = 0x05, // Non-standard, deprecated. - }; - pub const ConstructorOptions = struct { key: []const u8 = "", code: []const u8 = "", - location: KeyLocationCode = .standard, - char_code: u32 = 0, - key_code: u32 = 0, - which: u32 = 0, + location: netsurf.KeyboardEventOpts.LocationCode = .standard, repeat: bool = false, - ctrl_key: bool = false, - shift_key: bool = false, - alt_key: bool = false, - meta_key: bool = false, - is_composing: bool = false, + isComposing: bool = false, + // Currently not supported but we take as argument. + charCode: u32 = 0, + // Currently not supported but we take as argument. + keyCode: u32 = 0, + // Currently not supported but we take as argument. + which: u32 = 0, + ctrlKey: bool = false, + shiftKey: bool = false, + altKey: bool = false, + metaKey: bool = false, }; pub fn constructor(event_type: []const u8, maybe_options: ?ConstructorOptions) !*netsurf.KeyboardEvent { - const options = maybe_options orelse ConstructorOptions{}; + const options: ConstructorOptions = maybe_options orelse .{}; + + var event = try netsurf.keyboardEventCreate(); + try netsurf.eventSetInternalType(@ptrCast(&event), .keyboard_event); - const event = try netsurf.keyboardEventCreate(); try netsurf.keyboardEventInit( event, event_type, .{ - .bubbles = false, - .cancelable = false, .key = options.key, .code = options.code, - .alt = options.alt_key, - .ctrl = options.ctrl_key, - .meta = options.meta_key, - .shift = options.shift_key, + .location = options.location, + .repeat = options.repeat, + .is_composing = options.isComposing, + .ctrl_key = options.ctrlKey, + .shift_key = options.shiftKey, + .alt_key = options.altKey, + .meta_key = options.metaKey, }, ); return event; } + + // Returns the modifier state for given modifier key. + pub fn _getModifierState(self: *Self, key: []const u8) bool { + // Chrome and Firefox do case-sensitive match, here we prefer the same. + if (std.mem.eql(u8, key, "Alt")) { + return get_altKey(self); + } + + if (std.mem.eql(u8, key, "AltGraph")) { + return (get_altKey(self) and get_ctrlKey(self)); + } + + if (std.mem.eql(u8, key, "Control")) { + return get_ctrlKey(self); + } + + if (std.mem.eql(u8, key, "Shift")) { + return get_shiftKey(self); + } + + if (std.mem.eql(u8, key, "Meta") or std.mem.eql(u8, key, "OS")) { + return get_metaKey(self); + } + + // Special case for IE. + if (comptime builtin.os.tag == .windows) { + if (std.mem.eql(u8, key, "Win")) { + return get_metaKey(self); + } + } + + // getModifierState() also accepts a deprecated virtual modifier named "Accel". + // event.getModifierState("Accel") returns true when at least one of + // KeyboardEvent.ctrlKey or KeyboardEvent.metaKey is true. + // + // https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/getModifierState#accel_virtual_modifier + if (std.mem.eql(u8, key, "Accel")) { + return (get_ctrlKey(self) or get_metaKey(self)); + } + + // TODO: Add support for "CapsLock", "ScrollLock". + return false; + } + + // Getters. + + pub fn get_altKey(self: *Self) bool { + return netsurf.keyboardEventKeyIsSet(self, .alt); + } + + pub fn get_ctrlKey(self: *Self) bool { + return netsurf.keyboardEventKeyIsSet(self, .ctrl); + } + + pub fn get_metaKey(self: *Self) bool { + return netsurf.keyboardEventKeyIsSet(self, .meta); + } + + pub fn get_shiftKey(self: *Self) bool { + return netsurf.keyboardEventKeyIsSet(self, .shift); + } + + pub fn get_isComposing(self: *Self) bool { + return self.is_composing; + } + + pub fn get_location(self: *Self) u32 { + return self.location; + } + + pub fn get_key(self: *Self) ![]const u8 { + return netsurf.keyboardEventGetKey(self); + } + + pub fn get_repeat(self: *Self) bool { + return self.repeat; + } }; const testing = @import("../../testing.zig"); diff --git a/src/browser/netsurf.zig b/src/browser/netsurf.zig index a86095f37..41fe86e07 100644 --- a/src/browser/netsurf.zig +++ b/src/browser/netsurf.zig @@ -952,15 +952,44 @@ pub fn keyboardEventDestroy(evt: *KeyboardEvent) void { c._dom_keyboard_event_destroy(evt); } -const KeyboardEventOpts = struct { - key: []const u8, - code: []const u8, +pub inline fn keyboardEventKeyIsSet( + evt: *KeyboardEvent, + comptime key: enum { ctrl, alt, shift, meta }, +) bool { + var is_set: bool = false; + const err = switch (key) { + .ctrl => c._dom_keyboard_event_get_ctrl_key(evt, &is_set), + .alt => c._dom_keyboard_event_get_alt_key(evt, &is_set), + .shift => c._dom_keyboard_event_get_shift_key(evt, &is_set), + .meta => c._dom_keyboard_event_get_meta_key(evt, &is_set), + }; + // None of the earlier can fail. + std.debug.assert(err == c.DOM_NO_ERR); + + return is_set; +} + +pub const KeyboardEventOpts = struct { + key: []const u8 = "", + code: []const u8 = "", + location: LocationCode = .standard, + repeat: bool = false, bubbles: bool = false, cancelable: bool = false, - ctrl: bool = false, - alt: bool = false, - shift: bool = false, - meta: bool = false, + is_composing: bool = false, + ctrl_key: bool = false, + alt_key: bool = false, + shift_key: bool = false, + meta_key: bool = false, + + pub const LocationCode = enum(u32) { + standard = c.DOM_KEY_LOCATION_STANDARD, + left = c.DOM_KEY_LOCATION_LEFT, + right = c.DOM_KEY_LOCATION_RIGHT, + numpad = c.DOM_KEY_LOCATION_NUMPAD, + mobile = 0x04, // Non-standard, deprecated. + joystick = 0x05, // Non-standard, deprecated. + }; }; pub fn keyboardEventInit(evt: *KeyboardEvent, typ: []const u8, opts: KeyboardEventOpts) !void { @@ -973,13 +1002,13 @@ pub fn keyboardEventInit(evt: *KeyboardEvent, typ: []const u8, opts: KeyboardEve null, // dom_abstract_view* ? try strFromData(opts.key), try strFromData(opts.code), - 0, // location 0 == standard - opts.ctrl, - opts.shift, - opts.alt, - opts.meta, - false, // repease - false, // is_composiom + @intFromEnum(opts.location), + opts.ctrl_key, + opts.shift_key, + opts.alt_key, + opts.meta_key, + opts.repeat, // repease + opts.is_composing, // is_composiom ); try DOMErr(err); } diff --git a/src/browser/page.zig b/src/browser/page.zig index 5891a1fe6..870d0fe0b 100644 --- a/src/browser/page.zig +++ b/src/browser/page.zig @@ -942,10 +942,10 @@ pub const Page = struct { .cancelable = true, .key = kbe.key, .code = kbe.code, - .alt = kbe.alt, - .ctrl = kbe.ctrl, - .meta = kbe.meta, - .shift = kbe.shift, + .alt_key = kbe.alt, + .ctrl_key = kbe.ctrl, + .meta_key = kbe.meta, + .shift_key = kbe.shift, }); _ = try parser.elementDispatchEvent(element, @ptrCast(event)); } From 8f31fd778b5b8299ac5ca1d65cf6bf05fd3a0846 Mon Sep 17 00:00:00 2001 From: nikneym Date: Thu, 11 Sep 2025 14:20:07 +0300 Subject: [PATCH 5/8] add `KeyboardEvent` tests --- src/tests/events/keyboard.html | 89 +++++++++++++++++++++++++++++----- 1 file changed, 77 insertions(+), 12 deletions(-) diff --git a/src/tests/events/keyboard.html b/src/tests/events/keyboard.html index b3941fddf..33d655a5d 100644 --- a/src/tests/events/keyboard.html +++ b/src/tests/events/keyboard.html @@ -1,22 +1,87 @@ + - document.addEventListener("DOMContentLoaded", () => { - document.body.appendChild(button); - button.focus(); + + + + + - From 8d675029973d408e5c941e164936e4a5d8817397 Mon Sep 17 00:00:00 2001 From: nikneym Date: Fri, 12 Sep 2025 10:18:50 +0300 Subject: [PATCH 6/8] don't expose `DOMErr` function --- src/browser/netsurf.zig | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/browser/netsurf.zig b/src/browser/netsurf.zig index 41fe86e07..6c51fbe5e 100644 --- a/src/browser/netsurf.zig +++ b/src/browser/netsurf.zig @@ -388,7 +388,7 @@ pub const DOMError = error{ const DOMException = c.dom_exception; -pub fn DOMErr(except: DOMException) DOMError!void { +fn DOMErr(except: DOMException) DOMError!void { return switch (except) { c.DOM_NO_ERR => return, c.DOM_INDEX_SIZE_ERR => DOMError.IndexSize, From 22b4456bce7ce3a6b4f04d3608f20714a6d1041c Mon Sep 17 00:00:00 2001 From: nikneym Date: Fri, 12 Sep 2025 10:22:44 +0300 Subject: [PATCH 7/8] correct indentation in tests --- src/tests/events/keyboard.html | 60 +++++++++++++++++----------------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/src/tests/events/keyboard.html b/src/tests/events/keyboard.html index 33d655a5d..a59490bd2 100644 --- a/src/tests/events/keyboard.html +++ b/src/tests/events/keyboard.html @@ -36,52 +36,52 @@ From 80851f48618e48fed10f0445cb658de61b7b362d Mon Sep 17 00:00:00 2001 From: nikneym Date: Fri, 12 Sep 2025 12:12:15 +0300 Subject: [PATCH 8/8] don't inline `keyboardEventKeyIsSet` --- src/browser/netsurf.zig | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/browser/netsurf.zig b/src/browser/netsurf.zig index 6c51fbe5e..f9bb321d2 100644 --- a/src/browser/netsurf.zig +++ b/src/browser/netsurf.zig @@ -952,7 +952,7 @@ pub fn keyboardEventDestroy(evt: *KeyboardEvent) void { c._dom_keyboard_event_destroy(evt); } -pub inline fn keyboardEventKeyIsSet( +pub fn keyboardEventKeyIsSet( evt: *KeyboardEvent, comptime key: enum { ctrl, alt, shift, meta }, ) bool {