@gtkx/testing 0.21.0 → 1.0.0-rc.2

package/src/user-event.ts

@@ -1,492 +0,0 @@
-import * as Gdk from "@gtkx/ffi/gdk";
-import { type Object as GObject, signalEmitv, signalLookup, typeFromName, Value } from "@gtkx/ffi/gobject";
-import * as Gtk from "@gtkx/ffi/gtk";
-import { fireEvent } from "./fire-event.js";
-import { tick } from "./timing.js";
-import { isEditable } from "./widget.js";
-
-/**
- * Options for tab navigation.
- */
-export type TabOptions = {
-    /** Navigate backwards (Shift+Tab) instead of forwards */
-    shift?: boolean;
-};
-
-const click = async (element: Gtk.Widget): Promise<void> => {
-    element.activate();
-    await tick();
-};
-
-const emitClickSequence = async (element: Gtk.Widget, nPress: number): Promise<void> => {
-    const controller = getOrCreateController(element, Gtk.GestureClick);
-
-    for (let i = 1; i <= nPress; i++) {
-        const args = [
-            Value.newFromObject(controller),
-            Value.newFromInt(i),
-            Value.newFromDouble(0),
-            Value.newFromDouble(0),
-        ];
-        signalEmitv(args, getSignalId(controller, "pressed"), 0);
-        signalEmitv(args, getSignalId(controller, "released"), 0);
-    }
-
-    await tick();
-};
-
-const dblClick = async (element: Gtk.Widget): Promise<void> => {
-    await emitClickSequence(element, 2);
-};
-
-const tripleClick = async (element: Gtk.Widget): Promise<void> => {
-    await emitClickSequence(element, 3);
-};
-
-const tab = async (element: Gtk.Widget, options?: TabOptions): Promise<void> => {
-    const direction = options?.shift ? Gtk.DirectionType.TAB_BACKWARD : Gtk.DirectionType.TAB_FORWARD;
-    const root = element.getRoot();
-
-    if (root && root instanceof Gtk.Widget) {
-        root.childFocus(direction);
-    }
-
-    await tick();
-};
-
-const type = async (element: Gtk.Widget, text: string): Promise<void> => {
-    if (!isEditable(element)) {
-        throw new Error("Cannot type into element: expected editable widget (TEXT_BOX, SEARCH_BOX, or SPIN_BUTTON)");
-    }
-
-    const currentText = element.getText();
-    element.setText(currentText + text);
-
-    await tick();
-};
-
-const clear = async (element: Gtk.Widget): Promise<void> => {
-    if (!isEditable(element)) {
-        throw new Error("Cannot clear element: expected editable widget (TEXT_BOX, SEARCH_BOX, or SPIN_BUTTON)");
-    }
-
-    element.setText("");
-
-    await tick();
-};
-
-const SELECTABLE_ROLES = new Set([Gtk.AccessibleRole.COMBO_BOX, Gtk.AccessibleRole.LIST]);
-
-const isSelectable = (widget: Gtk.Widget): boolean => {
-    if (!widget) return false;
-    return SELECTABLE_ROLES.has(widget.getAccessibleRole());
-};
-
-const selectListViewItems = (selectionModel: Gtk.SelectionModel, positions: number[], exclusive: boolean): void => {
-    if (positions.length === 0) {
-        selectionModel.unselectRange(0, selectionModel.getNItems());
-        return;
-    }
-
-    if (exclusive && positions.length === 1) {
-        selectionModel.selectItem(positions[0] as number, true);
-        return;
-    }
-
-    const nItems = selectionModel.getNItems();
-    const selected = new Gtk.Bitset();
-    const mask = Gtk.Bitset.newRange(0, nItems);
-
-    for (const pos of positions) {
-        selected.add(pos);
-    }
-
-    selectionModel.setSelection(selected, mask);
-};
-
-const isListView = (widget: Gtk.Widget): widget is Gtk.ListView | Gtk.GridView | Gtk.ColumnView => {
-    return widget instanceof Gtk.ListView || widget instanceof Gtk.GridView || widget instanceof Gtk.ColumnView;
-};
-
-const selectOptions = async (element: Gtk.Widget, values: number | number[]): Promise<void> => {
-    const valueArray = Array.isArray(values) ? values : [values];
-
-    if (isListView(element)) {
-        const selectionModel = element.getModel() as Gtk.SelectionModel;
-        const isMultiSelection = selectionModel instanceof Gtk.MultiSelection;
-        selectListViewItems(selectionModel, valueArray, !isMultiSelection);
-        await tick();
-        return;
-    }
-
-    if (!isSelectable(element)) {
-        throw new Error("Cannot select options: expected selectable widget (COMBO_BOX or LIST)");
-    }
-
-    const role = element.getAccessibleRole();
-
-    if (role === Gtk.AccessibleRole.COMBO_BOX) {
-        if (Array.isArray(values) && values.length > 1) {
-            throw new Error("Cannot select multiple options: ComboBox only supports single selection");
-        }
-        if (element instanceof Gtk.DropDown) {
-            (element as Gtk.DropDown).setSelected(valueArray[0] as number);
-        } else {
-            (element as Gtk.ComboBox).setActive(valueArray[0] as number);
-        }
-    } else if (role === Gtk.AccessibleRole.LIST) {
-        const listBox = element as Gtk.ListBox;
-
-        for (const value of valueArray) {
-            const row = listBox.getRowAtIndex(value);
-
-            if (row) {
-                listBox.selectRow(row);
-                row.activate();
-            }
-        }
-    }
-
-    await tick();
-};
-
-const deselectOptions = async (element: Gtk.Widget, values: number | number[]): Promise<void> => {
-    const valueArray = Array.isArray(values) ? values : [values];
-
-    if (isListView(element)) {
-        const selectionModel = element.getModel() as Gtk.SelectionModel;
-
-        for (const pos of valueArray) {
-            selectionModel.unselectItem(pos);
-        }
-
-        await tick();
-        return;
-    }
-
-    const role = element.getAccessibleRole();
-
-    if (role !== Gtk.AccessibleRole.LIST) {
-        throw new Error("Cannot deselect options: only ListBox supports deselection");
-    }
-
-    const listBox = element as Gtk.ListBox;
-
-    for (const value of valueArray) {
-        const row = listBox.getRowAtIndex(value);
-
-        if (row) {
-            listBox.unselectRow(row as Gtk.ListBoxRow);
-        }
-    }
-
-    await tick();
-};
-
-const getOrCreateController = <T extends Gtk.EventController>(element: Gtk.Widget, controllerType: new () => T): T => {
-    const controllers = element.observeControllers();
-    const nItems = controllers.getNItems();
-
-    for (let i = 0; i < nItems; i++) {
-        const controller = controllers.getObject(i);
-        if (controller instanceof controllerType) {
-            return controller as T;
-        }
-    }
-
-    const controller = new controllerType();
-    element.addController(controller);
-    return controller;
-};
-
-const getSignalId = (target: Gtk.EventController, signalName: string): number => {
-    const gtype = typeFromName((target.constructor as typeof GObject).glibTypeName);
-    return signalLookup(signalName, gtype);
-};
-
-const hover = async (element: Gtk.Widget): Promise<void> => {
-    const controller = getOrCreateController(element, Gtk.EventControllerMotion);
-    signalEmitv(
-        [Value.newFromObject(controller), Value.newFromDouble(0), Value.newFromDouble(0)],
-        getSignalId(controller, "enter"),
-        0,
-    );
-    await tick();
-};
-
-const unhover = async (element: Gtk.Widget): Promise<void> => {
-    const controller = getOrCreateController(element, Gtk.EventControllerMotion);
-    signalEmitv([Value.newFromObject(controller)], getSignalId(controller, "leave"), 0);
-    await tick();
-};
-
-const KEY_MAP: Record<string, number> = {
-    Enter: Gdk.KEY_Return,
-    Tab: Gdk.KEY_Tab,
-    Escape: Gdk.KEY_Escape,
-    Backspace: Gdk.KEY_BackSpace,
-    Delete: Gdk.KEY_Delete,
-    ArrowUp: Gdk.KEY_Up,
-    ArrowDown: Gdk.KEY_Down,
-    ArrowLeft: Gdk.KEY_Left,
-    ArrowRight: Gdk.KEY_Right,
-    Home: Gdk.KEY_Home,
-    End: Gdk.KEY_End,
-    PageUp: Gdk.KEY_Page_Up,
-    PageDown: Gdk.KEY_Page_Down,
-    Space: Gdk.KEY_space,
-    Shift: Gdk.KEY_Shift_L,
-    Control: Gdk.KEY_Control_L,
-    Alt: Gdk.KEY_Alt_L,
-    Meta: Gdk.KEY_Meta_L,
-};
-
-const parseKeyboardInput = (input: string): Array<{ keyval: number; press: boolean }> => {
-    const actions: Array<{ keyval: number; press: boolean }> = [];
-    let i = 0;
-
-    while (i < input.length) {
-        if (input[i] === "{") {
-            const endBrace = input.indexOf("}", i);
-            if (endBrace === -1) break;
-
-            let keyName = input.slice(i + 1, endBrace);
-            let press = true;
-            let release = true;
-
-            if (keyName.startsWith("/")) {
-                keyName = keyName.slice(1);
-                press = false;
-            } else if (keyName.endsWith(">")) {
-                keyName = keyName.slice(0, -1);
-                release = false;
-            }
-
-            const keyval = KEY_MAP[keyName];
-            if (keyval === undefined) {
-                throw new Error(`Unknown key: {${keyName}}`);
-            }
-            if (press) actions.push({ keyval, press: true });
-            if (release) actions.push({ keyval, press: false });
-
-            i = endBrace + 1;
-        } else {
-            const keyval = input.charCodeAt(i);
-            actions.push({ keyval, press: true });
-            actions.push({ keyval, press: false });
-            i++;
-        }
-    }
-
-    return actions;
-};
-
-const MODIFIER_KEYVAL_TO_MASK: Record<number, number> = {
-    [Gdk.KEY_Shift_L]: Gdk.ModifierType.SHIFT_MASK,
-    [Gdk.KEY_Shift_R]: Gdk.ModifierType.SHIFT_MASK,
-    [Gdk.KEY_Control_L]: Gdk.ModifierType.CONTROL_MASK,
-    [Gdk.KEY_Control_R]: Gdk.ModifierType.CONTROL_MASK,
-    [Gdk.KEY_Alt_L]: Gdk.ModifierType.ALT_MASK,
-    [Gdk.KEY_Alt_R]: Gdk.ModifierType.ALT_MASK,
-    [Gdk.KEY_Meta_L]: Gdk.ModifierType.META_MASK,
-    [Gdk.KEY_Meta_R]: Gdk.ModifierType.META_MASK,
-};
-
-let gdkModifierType: number | null = null;
-
-const keyboard = async (element: Gtk.Widget, input: string): Promise<void> => {
-    gdkModifierType ??= typeFromName("GdkModifierType");
-    const controller = getOrCreateController(element, Gtk.EventControllerKey);
-    const actions = parseKeyboardInput(input);
-    let modifierState = 0;
-
-    for (const action of actions) {
-        const mask = MODIFIER_KEYVAL_TO_MASK[action.keyval];
-
-        if (mask) {
-            if (action.press) {
-                modifierState |= mask;
-            } else {
-                modifierState &= ~mask;
-            }
-        }
-
-        const signalName = action.press ? "key-pressed" : "key-released";
-        const returnValue = action.press ? Value.newFromBoolean(false) : undefined;
-        signalEmitv(
-            [
-                Value.newFromObject(controller),
-                Value.newFromUint(action.keyval),
-                Value.newFromUint(0),
-                Value.newFromFlags(gdkModifierType, modifierState),
-            ],
-            getSignalId(controller, signalName),
-            0,
-            returnValue,
-        );
-
-        if (action.press && action.keyval === Gdk.KEY_Return && isEditable(element)) {
-            await fireEvent(element, "activate");
-        }
-    }
-
-    await tick();
-};
-
-/**
- * Pointer input actions for simulating mouse interactions.
- *
- * - `"click"` or `"[MouseLeft]"`: Full click (press + release)
- * - `"down"` or `"[MouseLeft>]"`: Press and hold
- * - `"up"` or `"[/MouseLeft]"`: Release
- */
-export type PointerInput = "click" | "down" | "up" | "[MouseLeft]" | "[MouseLeft>]" | "[/MouseLeft]";
-
-const pointer = async (element: Gtk.Widget, input: PointerInput): Promise<void> => {
-    const controller = getOrCreateController(element, Gtk.GestureClick);
-    const pressedArgs = [
-        Value.newFromObject(controller),
-        Value.newFromInt(1),
-        Value.newFromDouble(0),
-        Value.newFromDouble(0),
-    ];
-    const releasedArgs = [
-        Value.newFromObject(controller),
-        Value.newFromInt(1),
-        Value.newFromDouble(0),
-        Value.newFromDouble(0),
-    ];
-
-    if (input === "[MouseLeft]" || input === "click") {
-        signalEmitv(pressedArgs, getSignalId(controller, "pressed"), 0);
-        signalEmitv(releasedArgs, getSignalId(controller, "released"), 0);
-    } else if (input === "[MouseLeft>]" || input === "down") {
-        signalEmitv(pressedArgs, getSignalId(controller, "pressed"), 0);
-    } else if (input === "[/MouseLeft]" || input === "up") {
-        signalEmitv(releasedArgs, getSignalId(controller, "released"), 0);
-    }
-
-    await tick();
-};
-
-/**
- * User interaction utilities for testing.
- *
- * Simulates user actions like clicking, typing, and selecting.
- * All methods are async and wait for GTK event processing.
- *
- * @example
- * ```tsx
- * import { render, screen, userEvent } from "@gtkx/testing";
- *
- * test("form submission", async () => {
- *   await render(<LoginForm />);
- *
- *   const input = await screen.findByRole(Gtk.AccessibleRole.TEXT_BOX);
- *   await userEvent.type(input, "username");
- *
- *   const button = await screen.findByRole(Gtk.AccessibleRole.BUTTON);
- *   await userEvent.click(button);
- * });
- * ```
- */
-export const userEvent = {
-    /**
-     * Activates a widget.
-     *
-     * Uses GTK's native `Gtk.Widget.activate()` to trigger the widget's
-     * default action — clicking buttons, toggling checkboxes/switches, etc.
-     */
-    click,
-    /**
-     * Double-clicks a widget.
-     *
-     * Emits pressed/released signals with n_press=1, then n_press=2.
-     */
-    dblClick,
-    /**
-     * Triple-clicks a widget.
-     *
-     * Emits pressed/released signals with n_press=1, 2, then 3. Useful for text selection.
-     */
-    tripleClick,
-    /**
-     * Simulates Tab key navigation.
-     *
-     * @param element - Starting element
-     * @param options - Use `shift: true` for backwards navigation
-     */
-    tab,
-    /**
-     * Types text into an editable widget.
-     *
-     * Appends text to the current content. Works with Entry, SearchEntry,
-     * and SpinButton widgets.
-     *
-     * @param element - The editable widget
-     * @param text - Text to type
-     */
-    type,
-    /**
-     * Clears an editable widget's content.
-     *
-     * Sets the text to empty string.
-     */
-    clear,
-    /**
-     * Selects options in a dropdown or list.
-     *
-     * Works with DropDown, ComboBox, ListBox, ListView, GridView, and ColumnView.
-     *
-     * @param element - The selectable widget
-     * @param values - Index or array of indices to select
-     */
-    selectOptions,
-    /**
-     * Deselects options in a list.
-     *
-     * Works with ListBox and multi-selection list views.
-     *
-     * @param element - The selectable widget
-     * @param values - Index or array of indices to deselect
-     */
-    deselectOptions,
-    /**
-     * Simulates mouse entering a widget (hover).
-     *
-     * Triggers the "enter" signal on the widget's EventControllerMotion.
-     */
-    hover,
-    /**
-     * Simulates mouse leaving a widget (unhover).
-     *
-     * Triggers the "leave" signal on the widget's EventControllerMotion.
-     */
-    unhover,
-    /**
-     * Simulates keyboard input.
-     *
-     * Supports special keys in braces: `{Enter}`, `{Tab}`, `{Escape}`, etc.
-     * Use `{Key>}` to hold a key down, `{/Key}` to release.
-     *
-     * @example
-     * ```tsx
-     * await userEvent.keyboard(element, "hello");
-     * await userEvent.keyboard(element, "{Enter}");
-     * await userEvent.keyboard(element, "{Shift>}A{/Shift}");
-     * ```
-     */
-    keyboard,
-    /**
-     * Simulates pointer (mouse) input.
-     *
-     * Supports: `"click"`, `"[MouseLeft]"`, `"down"`, `"up"`.
-     *
-     * @example
-     * ```tsx
-     * await userEvent.pointer(element, "click");
-     * await userEvent.pointer(element, "[MouseLeft]");
-     * ```
-     */
-    pointer,
-};

package/src/widget-text.ts

@@ -1,202 +0,0 @@
-import { getNativeInterface } from "@gtkx/ffi";
-import * as Gtk from "@gtkx/ffi/gtk";
-
-const getLabelText = (widget: Gtk.Widget): string | null => {
-    const asLabel = widget as Gtk.Label;
-    const asInscription = widget as Gtk.Inscription;
-    return asLabel.getLabel?.() ?? asInscription.getText?.() ?? null;
-};
-
-const getDefaultText = (widget: Gtk.Widget): string | null => {
-    if ("getLabel" in widget && typeof widget.getLabel === "function") {
-        return (widget.getLabel() as string) || null;
-    }
-
-    if ("getText" in widget && typeof widget.getText === "function") {
-        return (widget.getText() as string) || null;
-    }
-
-    if ("getTitle" in widget && typeof widget.getTitle === "function") {
-        return (widget.getTitle() as string) || null;
-    }
-
-    return getNativeInterface(widget, Gtk.Editable)?.getText() || null;
-};
-
-const collectDirectChildLabels = (widget: Gtk.Widget): string[] => {
-    const labels: string[] = [];
-    let child = widget.getFirstChild();
-
-    while (child) {
-        if (child.getAccessibleRole() === Gtk.AccessibleRole.LABEL) {
-            const labelText = getLabelText(child);
-            if (labelText) labels.push(labelText);
-        }
-        child = child.getNextSibling();
-    }
-
-    return labels;
-};
-
-const collectChildLabels = (widget: Gtk.Widget): string[] => {
-    const labels: string[] = [];
-    let child = widget.getFirstChild();
-
-    while (child) {
-        if (child.getAccessibleRole() === Gtk.AccessibleRole.LABEL) {
-            const labelText = getLabelText(child);
-            if (labelText) labels.push(labelText);
-        }
-
-        labels.push(...collectChildLabels(child));
-        child = child.getNextSibling();
-    }
-
-    return labels;
-};
-
-/**
- * Returns the text content of a widget, analogous to RTL's getNodeText.
- *
- * Collects direct child GtkLabel text (treated as text nodes) and joins
- * them into a single string. Widget properties like getLabel(), getTitle(),
- * getText() are NOT included — those are attributes, not text content.
- *
- * @param widget - The widget to extract text from
- * @returns The joined text content or null if none found
- */
-export const getWidgetText = (widget: Gtk.Widget): string | null => {
-    const role = widget.getAccessibleRole();
-    if (role === undefined) return null;
-
-    const childLabels = collectDirectChildLabels(widget);
-    return childLabels.length > 0 ? childLabels.join("") : null;
-};
-
-/**
- * Returns the widget's own text from properties (getLabel, getText, getTitle).
- *
- * Used for display/debugging purposes (e.g., prettyWidget). This is
- * analogous to HTML attributes like aria-label, not text content.
- *
- * @param widget - The widget to extract property text from
- * @returns The property text or null if none found
- */
-export const getWidgetPropertyText = (widget: Gtk.Widget): string | null => {
-    return getDefaultText(widget);
-};
-
-/**
- * Computes the accessible name of a widget for role-based queries.
- *
- * Uses the widget's own text properties first, then recursively collects
- * all descendant label text. This mirrors how ARIA accessible name
- * computation works in the DOM.
- *
- * @param widget - The widget to compute the accessible name for
- * @returns The accessible name or null if none found
- */
-export const getWidgetAccessibleName = (widget: Gtk.Widget): string | null => {
-    const role = widget.getAccessibleRole();
-    if (role === undefined) return null;
-
-    if (role === Gtk.AccessibleRole.TAB_PANEL) {
-        const parent = widget.getParent();
-        if (parent) {
-            const stack = parent as Gtk.Stack;
-            const page = stack.getPage?.(widget);
-            if (page) {
-                return page.getTitle() ?? null;
-            }
-        }
-        return null;
-    }
-
-    const ownText = getDefaultText(widget);
-    if (ownText) return ownText;
-
-    const childLabels = collectChildLabels(widget);
-    return childLabels.length > 0 ? childLabels.join(" ") : null;
-};
-
-/**
- * Gets the widget name (gtk_widget_get_name).
- *
- * @param widget - The widget to get the name from
- * @returns The widget name or null if not set
- */
-export const getWidgetName = (widget: Gtk.Widget): string | null => {
-    return widget.getName();
-};
-
-/**
- * Gets the checked state from toggle-like widgets.
- *
- * @param widget - The widget to get the checked state from
- * @returns The checked state or null if not applicable
- */
-export const getWidgetCheckedState = (widget: Gtk.Widget): boolean | null => {
-    const role = widget.getAccessibleRole();
-
-    switch (role) {
-        case Gtk.AccessibleRole.CHECKBOX:
-        case Gtk.AccessibleRole.RADIO:
-            return (widget as Gtk.CheckButton).getActive();
-        case Gtk.AccessibleRole.TOGGLE_BUTTON:
-            return (widget as Gtk.ToggleButton).getActive();
-        case Gtk.AccessibleRole.SWITCH:
-            return (widget as Gtk.Switch).getActive();
-        default:
-            return null;
-    }
-};
-
-/**
- * Gets the pressed state from toggle button widgets.
- *
- * @param widget - The widget to get the pressed state from
- * @returns The pressed state or null if not applicable
- */
-export const getWidgetPressedState = (widget: Gtk.Widget): boolean | null => {
-    const role = widget.getAccessibleRole();
-
-    if (role === Gtk.AccessibleRole.TOGGLE_BUTTON) {
-        return (widget as Gtk.ToggleButton).getActive();
-    }
-
-    return null;
-};
-
-/**
- * Gets the expanded state from expander widgets.
- *
- * @param widget - The widget to get the expanded state from
- * @returns The expanded state or null if not applicable
- */
-export const getWidgetExpandedState = (widget: Gtk.Widget): boolean | null => {
-    if (widget instanceof Gtk.Expander) {
-        return widget.getExpanded();
-    }
-
-    if (widget instanceof Gtk.TreeExpander) {
-        return widget.getListRow()?.getExpanded() ?? null;
-    }
-
-    return null;
-};
-
-/**
- * Gets the selected state from selectable widgets.
- *
- * @param widget - The widget to get the selected state from
- * @returns The selected state or null if not applicable
- */
-export const getWidgetSelectedState = (widget: Gtk.Widget): boolean | null => {
-    const role = widget.getAccessibleRole();
-
-    if (role === Gtk.AccessibleRole.ROW) {
-        return (widget as Gtk.ListBoxRow).isSelected();
-    }
-
-    return null;
-};

package/src/widget.ts

@@ -1,15 +0,0 @@
-import * as Gtk from "@gtkx/ffi/gtk";
-
-const EDITABLE_ROLES = new Set([
-    Gtk.AccessibleRole.TEXT_BOX,
-    Gtk.AccessibleRole.SEARCH_BOX,
-    Gtk.AccessibleRole.SPIN_BUTTON,
-]);
-
-export const isEditable = (widget: unknown): widget is Gtk.Editable => {
-    if (!(widget instanceof Gtk.Widget)) {
-        return false;
-    }
-
-    return EDITABLE_ROLES.has(widget.getAccessibleRole());
-};