bare-pointer 0.0.0 → 0.1.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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
+
+       http://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/README.md

@@ -0,0 +1,39 @@
+# bare-pointer
+
+Simulated pointer input for testing Bare apps. It presses, moves and releases a pointer over a view of the platform toolkit, so that what is under it sees the same events a user would cause.
+
+```
+npm i bare-pointer
+```
+
+## Usage
+
+```js
+const Pointer = require('bare-pointer')
+
+const pointer = new Pointer()
+
+await pointer.tap(button)
+
+await pointer.down(view, 10, 10)
+await pointer.move(view, 50, 10)
+await pointer.up()
+
+pointer.destroy()
+```
+
+## Platforms
+
+| Platform | Views          | Input                                                  |
+| -------- | -------------- | ------------------------------------------------------ |
+| macOS    | `bare-app-kit` | Mouse events sent to the window of the view            |
+| iOS      | `bare-ui-kit`  | Touches synthesized through `bare-ui-kit-touch`        |
+| Linux    | `bare-gtk`     | XTest through `bare-x11-xtest`, which needs GDK on X11 |
+| Android  | `bare-ndk`     | Motion events dispatched to the root of the view       |
+| Windows  | `bare-win-ui`  | `SendInput()` through `bare-user32`                    |
+
+On Linux and Windows the input goes through the system, so the window of the view has to be the one on top at the point. On macOS, a control tracks the mouse until it is released, so press one with `tap()` rather than `down()`.
+
+## License
+
+Apache-2.0

package/index.d.ts

@@ -0,0 +1,33 @@
+/**
+ * A view of the platform toolkit: an `NSView`, `UIView`, `GtkWidget`, `android.view.View` or
+ * `UIElement`, as wrapped by its Bare binding.
+ */
+type View = unknown
+
+/** One simulated pointer, which is a mouse on desktop platforms and a finger on mobile ones. */
+declare class Pointer {
+  constructor()
+
+  /** Whether the pointer is down. */
+  readonly pressed: boolean
+
+  /**
+   * Press at `x`, `y` in the coordinates of `view`, which default to its middle. Resolves once the
+   * press has been delivered and a frame has passed.
+   */
+  down(view: View, x?: number, y?: number): Promise<void>
+
+  /** Move the pressed pointer to `x`, `y` in the coordinates of `view`. */
+  move(view: View, x?: number, y?: number): Promise<void>
+
+  /** Release the pointer where it is. */
+  up(): Promise<void>
+
+  /** Press and release at `x`, `y` in the coordinates of `view`. */
+  tap(view: View, x?: number, y?: number): Promise<void>
+
+  /** Release the pointer if it is down, and close any connection to the display server. */
+  destroy(): void
+}
+
+export = Pointer

package/index.js

@@ -0,0 +1,79 @@
+const AnimationFrameProvider = require('bare-animation-frame')
+const Backend = require('#backend')
+
+module.exports = class Pointer {
+  constructor() {
+    this._backend = new Backend()
+    this._view = null
+  }
+
+  get pressed() {
+    return this._view !== null
+  }
+
+  async down(view, x, y) {
+    if (this._view !== null) throw new Error('Pointer is already down')
+
+    this._backend.down(view, ...this._point(view, x, y))
+    this._view = view
+
+    await frame(view)
+  }
+
+  async move(view, x, y) {
+    if (this._view === null) throw new Error('Pointer is not down')
+
+    this._backend.move(view, ...this._point(view, x, y))
+
+    await frame(view)
+  }
+
+  async up() {
+    if (this._view === null) throw new Error('Pointer is not down')
+
+    const view = this._view
+
+    this._backend.up()
+    this._view = null
+
+    await frame(view)
+  }
+
+  async tap(view, x, y) {
+    if (this._view !== null) throw new Error('Pointer is already down')
+
+    const point = this._point(view, x, y)
+
+    if (this._backend.tap) {
+      this._backend.tap(view, ...point)
+    } else {
+      this._backend.down(view, ...point)
+
+      // UIKit controls only see a press that lasts past a frame.
+      await frame(view)
+
+      this._backend.up()
+    }
+
+    await frame(view)
+  }
+
+  destroy() {
+    if (this._view !== null) this._backend.up()
+
+    this._view = null
+    this._backend.destroy()
+  }
+
+  _point(view, x, y) {
+    if (x !== undefined && y !== undefined) return [x, y]
+
+    const [width, height] = this._backend.size(view)
+
+    return [x === undefined ? width / 2 : x, y === undefined ? height / 2 : y]
+  }
+}
+
+function frame(view) {
+  return new AnimationFrameProvider(view).afterAnimationFrame()
+}

package/lib/android.js

@@ -0,0 +1,62 @@
+const NDKMotionEvent = require('bare-ndk/motion-event')
+const SystemClock = require('bare-ndk/system-clock')
+
+const { ACTION } = NDKMotionEvent
+
+module.exports = class AndroidPointer {
+  constructor() {
+    this._root = null
+    this._downTime = 0
+    this._x = 0
+    this._y = 0
+  }
+
+  size(view) {
+    return [view.width, view.height]
+  }
+
+  down(view, x, y) {
+    this._downTime = SystemClock.uptimeMillis()
+    this._dispatch(ACTION.DOWN, view, x, y)
+  }
+
+  move(view, x, y) {
+    this._dispatch(ACTION.MOVE, view, x, y)
+  }
+
+  up() {
+    this._send(ACTION.UP)
+  }
+
+  destroy() {}
+
+  // The root is not always at the origin of the window, so the view is placed
+  // by its offset from the root.
+  _dispatch(action, view, x, y) {
+    const root = view.rootView
+    const here = view.locationInWindow
+    const there = root.locationInWindow
+
+    this._root = root
+    this._x = here.x - there.x + x
+    this._y = here.y - there.y + y
+
+    this._send(action)
+  }
+
+  _send(action) {
+    const event = NDKMotionEvent.obtain(
+      this._downTime,
+      SystemClock.uptimeMillis(),
+      action,
+      this._x,
+      this._y
+    )
+
+    try {
+      this._root.dispatchTouchEvent(event)
+    } finally {
+      event.recycle()
+    }
+  }
+}

package/lib/darwin.js

@@ -0,0 +1,53 @@
+const AppKitApplication = require('bare-app-kit/application')
+const AppKitEvent = require('bare-app-kit/event')
+
+const { TYPE } = AppKitEvent
+
+module.exports = class DarwinPointer {
+  constructor() {
+    this._window = null
+    this._point = null
+  }
+
+  size(view) {
+    const { width, height } = view.bounds
+
+    return [width, height]
+  }
+
+  down(view, x, y) {
+    this._send(TYPE.LEFT_MOUSE_DOWN, view, x, y)
+  }
+
+  move(view, x, y) {
+    this._send(TYPE.LEFT_MOUSE_DRAGGED, view, x, y)
+  }
+
+  up() {
+    this._window.sendEvent(this._event(TYPE.LEFT_MOUSE_UP, this._window, this._point))
+  }
+
+  // A control tracks the mouse by reading the event queue until it is released,
+  // and a press that could start a double click is held back until the event
+  // after it, so both have to go through the queue in order.
+  tap(view, x, y) {
+    const window = view.window
+    const point = view.convertPointToView(x, y, null)
+
+    AppKitApplication.postEvent(this._event(TYPE.LEFT_MOUSE_DOWN, window, point))
+    AppKitApplication.postEvent(this._event(TYPE.LEFT_MOUSE_UP, window, point))
+  }
+
+  destroy() {}
+
+  _send(type, view, x, y) {
+    this._window = view.window
+    this._point = view.convertPointToView(x, y, null)
+
+    this._window.sendEvent(this._event(type, this._window, this._point))
+  }
+
+  _event(type, window, point) {
+    return AppKitEvent.mouseEvent(type, point.x, point.y, 0, 0, window.windowNumber)
+  }
+}

package/lib/ios.js

@@ -0,0 +1,32 @@
+const UIKitTouch = require('bare-ui-kit-touch')
+
+module.exports = class IOSPointer {
+  constructor() {
+    this._touch = null
+  }
+
+  size(view) {
+    const { width, height } = view.bounds
+
+    return [width, height]
+  }
+
+  down(view, x, y) {
+    const point = view.convertPointToView(x, y, null)
+
+    this._touch = UIKitTouch.begin(view.window, point.x, point.y)
+  }
+
+  move(view, x, y) {
+    const point = view.convertPointToView(x, y, null)
+
+    this._touch.move(point.x, point.y)
+  }
+
+  up() {
+    this._touch.end()
+    this._touch = null
+  }
+
+  destroy() {}
+}

package/lib/linux.js

@@ -0,0 +1,64 @@
+const { Display } = require('bare-x11')
+const xtest = require('bare-x11-xtest')
+
+module.exports = class LinuxPointer {
+  constructor() {
+    this._display = Display.open()
+  }
+
+  size(view) {
+    return [view.width, view.height]
+  }
+
+  down(view, x, y) {
+    this._move(view, x, y)
+
+    xtest.fakeButtonEvent(this._display, 1, true)
+
+    this._display.sync()
+  }
+
+  move(view, x, y) {
+    this._move(view, x, y)
+
+    this._display.sync()
+  }
+
+  up() {
+    xtest.fakeButtonEvent(this._display, 1, false)
+
+    this._display.sync()
+  }
+
+  destroy() {
+    this._display.close()
+  }
+
+  _move(view, x, y) {
+    const point = this._point(view, x, y)
+
+    xtest.fakeMotionEvent(this._display, xtest.CURRENT_SCREEN, point.x, point.y)
+  }
+
+  // A point in the widget becomes one in its native, then in the surface of
+  // that, which is drawn in device pixels on an X11 window that the server can
+  // place on the root.
+  _point(view, x, y) {
+    const native = view.native
+    const surface = native.surface
+    const xid = surface === null ? null : surface.xid
+
+    if (xid === null) throw new Error('Simulated input needs GDK to run on X11')
+
+    const [left, top] = view.computePoint(native, x, y)
+    const [dx, dy] = native.surfaceTransform
+    const scale = surface.scaleFactor
+
+    return this._display.translateCoordinates(
+      xid,
+      this._display.defaultRootWindow,
+      Math.round((left + dx) * scale),
+      Math.round((top + dy) * scale)
+    )
+  }
+}

package/lib/unsupported.js

@@ -0,0 +1,5 @@
+module.exports = class UnsupportedPointer {
+  constructor() {
+    throw new Error('Simulated input is not supported on this platform')
+  }
+}

package/lib/win32.js

@@ -0,0 +1,80 @@
+const Win32Interop = require('bare-win-ui/win32-interop')
+const user32 = require('bare-user32')
+
+const {
+  SM_XVIRTUALSCREEN,
+  SM_YVIRTUALSCREEN,
+  SM_CXVIRTUALSCREEN,
+  SM_CYVIRTUALSCREEN,
+  INPUT_MOUSE,
+  MOUSEEVENTF_MOVE,
+  MOUSEEVENTF_LEFTDOWN,
+  MOUSEEVENTF_LEFTUP,
+  MOUSEEVENTF_ABSOLUTE,
+  MOUSEEVENTF_VIRTUALDESK
+} = user32.constants
+
+module.exports = class Win32Pointer {
+  constructor() {
+    this._point = null
+  }
+
+  size(view) {
+    return [view.actualWidth, view.actualHeight]
+  }
+
+  down(view, x, y) {
+    this._point = locate(view, x, y)
+    this._send(MOUSEEVENTF_LEFTDOWN)
+  }
+
+  move(view, x, y) {
+    this._point = locate(view, x, y)
+    this._send(0)
+  }
+
+  up() {
+    this._send(MOUSEEVENTF_LEFTUP)
+  }
+
+  destroy() {}
+
+  _send(flags) {
+    const sent = user32.sendInput([
+      {
+        type: INPUT_MOUSE,
+        mi: {
+          ...this._point,
+          flags: flags | MOUSEEVENTF_MOVE | MOUSEEVENTF_ABSOLUTE | MOUSEEVENTF_VIRTUALDESK
+        }
+      }
+    ])
+
+    if (sent === 0) throw new Error('Input was blocked')
+  }
+}
+
+// An element is placed in DIPs from the XAML root, which fills the client area
+// of its window. Absolute input divides the virtual screen into 65536 steps.
+function locate(view, x, y) {
+  const root = view.xamlRoot
+  const scale = root.rasterizationScale
+  const point = view.transformToVisual(null).transformPoint(x, y)
+  const window = Win32Interop.getWindowFromWindowId(root.contentIslandEnvironment.appWindowId)
+
+  const screen = user32.clientToScreen(
+    window,
+    Math.round(point.x * scale),
+    Math.round(point.y * scale)
+  )
+
+  const left = user32.getSystemMetrics(SM_XVIRTUALSCREEN)
+  const top = user32.getSystemMetrics(SM_YVIRTUALSCREEN)
+  const width = user32.getSystemMetrics(SM_CXVIRTUALSCREEN)
+  const height = user32.getSystemMetrics(SM_CYVIRTUALSCREEN)
+
+  return {
+    dx: Math.round(((screen.x - left) * 65536) / width),
+    dy: Math.round(((screen.y - top) * 65536) / height)
+  }
+}

package/package.json

@@ -1 +1,68 @@
-{"name":"bare-pointer","version":"0.0.0"}
+{
+  "name": "bare-pointer",
+  "version": "0.1.1",
+  "description": "Simulated pointer input for testing Bare apps",
+  "exports": {
+    "./package": "./package.json",
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    }
+  },
+  "imports": {
+    "#backend": {
+      "darwin": "./lib/darwin.js",
+      "ios": "./lib/ios.js",
+      "linux": "./lib/linux.js",
+      "android": "./lib/android.js",
+      "win32": "./lib/win32.js",
+      "default": "./lib/unsupported.js"
+    },
+    "#fixture": {
+      "darwin": "./test/fixtures/darwin.js",
+      "ios": "./test/fixtures/ios.js",
+      "linux": "./test/fixtures/linux.js",
+      "android": "./test/fixtures/android.js",
+      "win32": "./test/fixtures/win32.js"
+    }
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "lib"
+  ],
+  "scripts": {
+    "format": "prettier --write . && lunte --fix",
+    "lint": "prettier --check . && lunte",
+    "test": "bare-native-test --runtime ./test/runtime.js test.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/holepunchto/bare-pointer.git"
+  },
+  "author": "Holepunch",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/holepunchto/bare-pointer/issues"
+  },
+  "homepage": "https://github.com/holepunchto/bare-pointer#readme",
+  "dependencies": {
+    "bare-animation-frame": "^0.1.1",
+    "bare-app-kit": "^0.3.1",
+    "bare-ndk": "^0.3.4",
+    "bare-ui-kit-touch": "^0.1.0",
+    "bare-user32": "^0.1.0",
+    "bare-win-ui": "^0.3.7",
+    "bare-x11": "^0.1.0",
+    "bare-x11-xtest": "^0.1.0"
+  },
+  "devDependencies": {
+    "bare-gtk": "^0.4.1",
+    "bare-native-test": "^0.1.3",
+    "bare-tap": "^1.1.0",
+    "bare-ui-kit": "^0.3.1",
+    "lunte": "^1.8.0",
+    "prettier": "^3.4.2",
+    "prettier-config-holepunch": "^2.0.0"
+  }
+}