PointerEvent

/*
 * Copyright (c) 2002-2026 Gargoyle Software Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.htmlunit.javascript.host.event;

import static org.htmlunit.javascript.configuration.SupportedBrowser.CHROME;
import static org.htmlunit.javascript.configuration.SupportedBrowser.EDGE;
import static org.htmlunit.javascript.configuration.SupportedBrowser.FF;

import org.htmlunit.corejs.javascript.Context;
import org.htmlunit.corejs.javascript.Function;
import org.htmlunit.corejs.javascript.NativeObject;
import org.htmlunit.corejs.javascript.Scriptable;
import org.htmlunit.corejs.javascript.ScriptableObject;
import org.htmlunit.corejs.javascript.VarScope;
import org.htmlunit.html.DomNode;
import org.htmlunit.javascript.JavaScriptEngine;
import org.htmlunit.javascript.configuration.JsxClass;
import org.htmlunit.javascript.configuration.JsxConstructor;
import org.htmlunit.javascript.configuration.JsxGetter;

/**
 * JavaScript object representing a {@code PointerEvent}.
 * @see <a href="http://www.w3.org/TR/pointerevents/">W3C Spec</a>
 * @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent">MDN</a>
 *
 * @author Frank Danek
 * @author Ahmed Ashour
 * @author Ronald Brill
 */
@JsxClass
public class PointerEvent extends MouseEvent {

    private int pointerId_;
    private int width_;
    private int height_;
    private double pressure_;
    private int tiltX_;
    private int tiltY_;
    private double altitudeAngle_;
    private double azimuthAngle_;
    private String pointerType_ = "";
    private boolean isPrimary_;

    /**
     * Default constructor.
     */
    public PointerEvent() {
        super();
    }

    /**
     * JavaScript constructor.
     * @param cx the current context
     * @param scope the scope
     * @param args the arguments to the WebSocket constructor
     * @param ctorObj the function object
     * @param inNewExpr Is new or not
     * @return the java object to allow JavaScript to access
     */
    @JsxConstructor
    public static Scriptable jsConstructor(final Context cx, final VarScope scope,
            final Object[] args, final Function ctorObj, final boolean inNewExpr) {
        final PointerEvent event = new PointerEvent();

        event.setBubbles(false);
        event.setCancelable(false);

        event.altitudeAngle_ = Math.PI / 2d;

        if (args.length != 0) {
            event.setType(JavaScriptEngine.toString(args[0]));
            event.width_ = 1;
            event.height_ = 1;
        }

        if (args.length > 1) {
            final NativeObject object = (NativeObject) args[1];
            event.setBubbles((boolean) getValue(object, "bubbles", event.isBubbles()));

            event.pointerId_ = (int) getValue(object, "pointerId", event.pointerId_);
            event.width_ = (int) getValue(object, "width", event.width_);
            event.height_ = (int) getValue(object, "height", event.height_);
            event.pressure_ = (double) getValue(object, "pressure", event.pressure_);
            event.tiltX_ = (int) getValue(object, "tiltX", event.tiltX_);
            event.tiltY_ = (int) getValue(object, "tiltY", event.tiltY_);
            event.pointerType_ = (String) getValue(object, "pointerType", event.pointerType_);
            event.isPrimary_ = (boolean) getValue(object, "isPrimary", event.isPrimary_);

            if (object.has("tiltX", object) || object.has("tiltY", object)) {
                event.altitudeAngle_ = 1.4105561004354874;
                event.azimuthAngle_ = 0.8628261898537035;
            }
        }
        return event;
    }

    private static Object getValue(final ScriptableObject object, final String name, final Object defaulValue) {
        Object value = object.get(name);
        if (value == null) {
            value = defaulValue;
        }
        else {
            if (defaulValue instanceof String) {
                value = String.valueOf(value);
            }
            else if (defaulValue instanceof Double) {
                value = JavaScriptEngine.toNumber(value);
            }
            else if (defaulValue instanceof Number) {
                value = (int) JavaScriptEngine.toNumber(value);
            }
            else {
                value = JavaScriptEngine.toBoolean(value);
            }
        }
        return value;
    }

    /**
     * Creates a new event instance.
     *
     * @param domNode the DOM node that triggered the event
     * @param type the event type
     * @param shiftKey true if SHIFT is pressed
     * @param ctrlKey true if CTRL is pressed
     * @param altKey true if ALT is pressed
     * @param detail the detail value
     * @param button the button code, must be {@link #BUTTON_LEFT}, {@link #BUTTON_MIDDLE} or {@link #BUTTON_RIGHT}
     */
    public PointerEvent(final DomNode domNode, final String type, final boolean shiftKey,
            final boolean ctrlKey, final boolean altKey, final int button, final int detail) {
        super(domNode, type, shiftKey, ctrlKey, altKey, button, detail);

        pointerId_ = 1;
        width_ = 1;
        height_ = 1;
        pointerType_ = "mouse";
        isPrimary_ = true;
    }

    /**
     * Returns the pointer identifier.
     *
     * @return the pointer identifier
     */
    @JsxGetter
    public long getPointerId() {
        return pointerId_;
    }

    /**
     * Returns the pointer contact width.
     *
     * @return the pointer contact width
     */
    @JsxGetter
    public long getWidth() {
        return width_;
    }

    /**
     * Returns the pointer contact height.
     *
     * @return the pointer contact height
     */
    @JsxGetter
    public long getHeight() {
        return height_;
    }

    /**
     * Returns the normalized pointer pressure.
     *
     * @return the normalized pointer pressure
     */
    @JsxGetter
    public double getPressure() {
        return pressure_;
    }

    /**
     * Returns the pointer tilt along the X axis.
     *
     * @return the pointer tilt along the X axis
     */
    @JsxGetter
    public long getTiltX() {
        return tiltX_;
    }

    /**
     * Returns the pointer tilt along the Y axis.
     *
     * @return the pointer tilt along the Y axis
     */
    @JsxGetter
    public long getTiltY() {
        return tiltY_;
    }

    /**
     * Returns the pointer type.
     *
     * @return the pointer type
     */
    @JsxGetter
    public String getPointerType() {
        return pointerType_;
    }

    /**
     * Returns whether this is the primary pointer.
     *
     * @return whether this is the primary pointer
     */
    @JsxGetter(propertyName = "isPrimary")
    public boolean isPrimary_js() {
        return isPrimary_;
    }

    /**
     * Returns the pointer altitude angle.
     *
     * @return the pointer altitude angle
     */
    @JsxGetter
    @SuppressWarnings("PMD.UseUnderscoresInNumericLiterals")
    public double getAltitudeAngle() {
        return altitudeAngle_;
    }

    /**
     * Returns the pointer azimuth angle.
     *
     * @return the pointer azimuth angle
     */
    @JsxGetter
    public double getAzimuthAngle() {
        return azimuthAngle_;
    }

    /**
     * Returns the persistent device identifier.
     *
     * @return the persistent device identifier
     */
    @JsxGetter({CHROME, EDGE, FF})
    public double getPersistentDeviceId() {
        // dummy but valid regarding the spec
        // https://w3c.github.io/pointerevents/#dom-pointerevent-persistentdeviceid
        return 0d;
    }
}