@daugasauron/dolly-host-touch 0.1.4 → 0.1.5

package/README.md

@@ -1,4 +1,4 @@
 # @daugasauron/dolly-host-touch
 
-Dolly's `touch@0` host module: fingers on a touchscreen: every one that is down, each with its id. Give the URL of its
+Dolly's `touch@0` host module: fingers on a touchscreen, every one that is down with its id, and a program's buttons. Give the URL of its
 `module.json` to `boot()`'s `modules`; @daugasauron/dolly's README says how.

package/abi.mjs

@@ -10,10 +10,17 @@ export const DOLLY_TOUCH_DOWN = 1;
 export const DOLLY_TOUCH_MOVE = 2;
 export const DOLLY_TOUCH_UP = 3;
 export const DOLLY_TOUCH_CANCEL = 4;
+export const DOLLY_TOUCH_PRESS = 5;
 export const DOLLY_TOUCH_FINGERS = 10;
+export const DOLLY_TOUCH_BUTTONS_OFFSET = 16400;
+export const DOLLY_TOUCH_LABEL_COUNT_OFFSET = 16404;
+export const DOLLY_TOUCH_LABELS_OFFSET = 16408;
+export const DOLLY_TOUCH_BUTTON_COUNT = 12;
+export const DOLLY_TOUCH_LABEL_SIZE = 32;
 export const DOLLY_TOUCH_ACQUIRE = 92;
 export const DOLLY_TOUCH_READ = 93;
 export const DOLLY_TOUCH_RELEASE = 94;
+export const DOLLY_TOUCH_BUTTONS = 95;
 export const DOLLY_TOUCH_READ_RECORDS = 64;
 export const DOLLY_ERRNO = Object.freeze({ E2BIG: 1, EACCES: 2, EADDRINUSE: 3, EADDRNOTAVAIL: 4, EAFNOSUPPORT: 5, EAGAIN: 6, EALREADY: 7, EBADF: 8, EBADMSG: 9, EBUSY: 10, ECANCELED: 11, ECHILD: 12, ECONNABORTED: 13, ECONNREFUSED: 14, ECONNRESET: 15, EDEADLK: 16, EDESTADDRREQ: 17, EDOM: 18, EDQUOT: 19, EEXIST: 20, EFAULT: 21, EFBIG: 22, EHOSTUNREACH: 23, EIDRM: 24, EILSEQ: 25, EINPROGRESS: 26, EINTR: 27, EINVAL: 28, EIO: 29, EISCONN: 30, EISDIR: 31, ELOOP: 32, EMFILE: 33, EMLINK: 34, EMSGSIZE: 35, EMULTIHOP: 36, ENAMETOOLONG: 37, ENETDOWN: 38, ENETRESET: 39, ENETUNREACH: 40, ENFILE: 41, ENOBUFS: 42, ENODEV: 43, ENOENT: 44, ENOEXEC: 45, ENOLCK: 46, ENOLINK: 47, ENOMEM: 48, ENOMSG: 49, ENOPROTOOPT: 50, ENOSPC: 51, ENOSYS: 52, ENOTCONN: 53, ENOTDIR: 54, ENOTEMPTY: 55, ENOTRECOVERABLE: 56, ENOTSOCK: 57, ENOTTY: 59, ENXIO: 60, EOVERFLOW: 61, EOWNERDEAD: 62, EPERM: 63, EPIPE: 64, EPROTO: 65, EPROTONOSUPPORT: 66, EPROTOTYPE: 67, ERANGE: 68, EROFS: 69, ESPIPE: 70, ESRCH: 71, ESTALE: 72, ETIMEDOUT: 73, ETXTBSY: 74, EXDEV: 75, ENODATA: 116, ENOTSUP: 138 });
-export const DOLLY_TOUCH_ABI_DIGEST = "515bdcabf63b7396d485abded3a066c0c55771b0eedf4de824f3f728e645cf1c";
+export const DOLLY_TOUCH_ABI_DIGEST = "a666fc4a91ca78e6a7f42e9357d4e3aa8586d6aa662049f7a590794408caa67d";

package/module.json

@@ -1,8 +1,8 @@
 {
   "name": "touch",
   "version": 0,
-  "gives": "fingers on a touchscreen: every one that is down, each with its id",
-  "dependencies": ["runtime@0"],
+  "gives": "fingers on a touchscreen, every one that is down with its id, and a program's buttons",
+  "dependencies": ["runtime@0", "input@0"],
   "phase": "image",
   "imports": [],
   "host": "touch.mjs",

package/package.json

@@ -1,12 +1,12 @@
 {
-  "version": "0.1.4",
+  "version": "0.1.5",
   "type": "module",
   "name": "@daugasauron/dolly-host-touch",
   "license": "MIT",
   "dependencies": {
-    "@daugasauron/dolly": "0.1.4"
+    "@daugasauron/dolly": "0.1.5"
   },
-  "description": "Dolly's touch@0 host module: fingers on a touchscreen: every one that is down, each with its id.",
+  "description": "Dolly's touch@0 host module: fingers on a touchscreen, every one that is down with its id, and a program's buttons.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/daugasauron/dolly.git"

package/touch.mjs

@@ -5,6 +5,7 @@ const word = { read: T.DOLLY_TOUCH_WORD_READ, write: T.DOLLY_TOUCH_WORD_WRITE,
   lease: T.DOLLY_TOUCH_WORD_LEASE, enabled: T.DOLLY_TOUCH_WORD_ENABLED };
 // Moves leave room for every finger's down and its end.
 const moveReserve = 2 * T.DOLLY_TOUCH_FINGERS;
+const buttonsEnd = T.DOLLY_TOUCH_LABELS_OFFSET + T.DOLLY_TOUCH_BUTTON_COUNT * T.DOLLY_TOUCH_LABEL_SIZE;
 
 // The Worker's end of the touch mailbox, the one producer of its records: the
 // page sends it the fingers it took. A finger is delivered under the lease its
@@ -16,7 +17,8 @@ export class TouchTransport {
     if (!(buffer instanceof SharedArrayBuffer)) throw new Error("Dolly touch transport requires shared Wasm memory");
     if (!Number.isSafeInteger(address) || address <= 0 || address % 4 !== 0 || !Number.isSafeInteger(capacity) ||
         capacity <= moveReserve || (capacity & (capacity - 1)) !== 0 ||
-        address > buffer.byteLength - T.DOLLY_TOUCH_HEADER_SIZE - capacity * T.DOLLY_TOUCH_RECORD_SIZE) {
+        T.DOLLY_TOUCH_HEADER_SIZE + capacity * T.DOLLY_TOUCH_RECORD_SIZE > T.DOLLY_TOUCH_BUTTONS_OFFSET ||
+        address > buffer.byteLength - buttonsEnd) {
       throw new Error("Dolly supplied an invalid touch mailbox");
     }
     this.view = new DataView(buffer);
@@ -46,16 +48,23 @@ export class TouchTransport {
     Atomics.store(this.words, this.address / 4 + word.write, (write + 1) | 0);
   }
 
-  // One Pointer Event of a finger as samples ({ x, y, pressure, time }, the
-  // coalesced moves of a pointermove). Returns whether the finger is this
-  // module's, so that it is not also the pointer.
-  finger(phase, pointerId, samples) {
+  // The lease records are written under. A new one ends the fingers of the
+  // one before: they are nobody's until they end.
+  follow() {
     const lease = this.lease();
     if (lease !== this.heldLease) {
       for (const pointer of this.fingers.keys()) this.ignored.add(pointer);
       this.fingers.clear();
       this.heldLease = lease;
     }
+    return lease;
+  }
+
+  // One Pointer Event of a finger as samples ({ x, y, pressure, time }, the
+  // coalesced moves of a pointermove). Returns whether the finger is this
+  // module's, so that it is not also the pointer.
+  finger(phase, pointerId, samples) {
+    const lease = this.follow();
     const id = this.fingers.get(pointerId), ends = phase === T.DOLLY_TOUCH_UP || phase === T.DOLLY_TOUCH_CANCEL;
     if (id === undefined) {
       if (this.ignored.has(pointerId)) {
@@ -86,6 +95,33 @@ export class TouchTransport {
     return true;
   }
 
+  // The holder's labels and the labels word they were read under, or null
+  // while the kernel is changing them.
+  buttons() {
+    const word = (this.address + T.DOLLY_TOUCH_BUTTONS_OFFSET) / 4;
+    const labels = Atomics.load(this.words, word) >>> 0;
+    const count = Math.min(this.view.getUint32(this.address + T.DOLLY_TOUCH_LABEL_COUNT_OFFSET, true),
+      T.DOLLY_TOUCH_BUTTON_COUNT);
+    const texts = Array.from({ length: count }, (_, index) => {
+      const at = this.address + T.DOLLY_TOUCH_LABELS_OFFSET + index * T.DOLLY_TOUCH_LABEL_SIZE;
+      const bytes = new Uint8Array(this.view.buffer, at, T.DOLLY_TOUCH_LABEL_SIZE).slice();
+      return new TextDecoder().decode(bytes.subarray(0, bytes.indexOf(0) >>> 0));
+    });
+    return Atomics.load(this.words, word) >>> 0 === labels ? { labels, texts } : null;
+  }
+
+  // A press of the holder's button index, of the labels read under the word
+  // labels, while the ring keeps room for it and every finger's end.
+  press(index, labels, time) {
+    if (!this.follow()) return;
+    if (this.free() < this.fingers.size + 1) {
+      this.dropped++;
+      return;
+    }
+    this.write(index, T.DOLLY_TOUCH_PRESS, { x: labels, y: 0, pressure: 0, time });
+    Atomics.notify(this.words, this.address / 4 + word.write);
+  }
+
   // Tells the kernel whether this page listens: without it no lease is given.
   enable(enabled) {
     Atomics.store(this.words, this.address / 4 + word.enabled, enabled ? 1 : 0);
@@ -98,8 +134,9 @@ const phases = { pointerdown: T.DOLLY_TOUCH_DOWN, pointermove: T.DOLLY_TOUCH_MOV
 // The page's fingers on the canvas. They are taken before input@0's listeners
 // on the canvas see them, and only while a program holds the lease, as the
 // Worker last reported it: without one the terminal's scroll and pinch are
-// input@0's. A finger taken stays this module's until it ends.
-export function browser({ canvas, surfaceSize, send }) {
+// input@0's. A finger taken stays this module's until it ends. The holder's
+// buttons are input@0's bar's, before its Paste.
+export function browser({ canvas, surfaceSize, send, get }) {
   let started = false, lease = 0;
   const taken = new Set();
   // Positions are pixels of the frame the canvas shows, as input@0's pointer records are.
@@ -130,24 +167,36 @@ export function browser({ canvas, surfaceSize, send }) {
   canvas.addEventListener("contextmenu", menu);
   return {
     page: { get touchTransport() { return started ? { lease: () => lease } : undefined; } },
-    messages: { "touch-lease"(message) { lease = message.lease; } },
+    messages: {
+      "touch-lease"(message) { lease = message.lease; },
+      "touch-buttons"({ labels, texts }) {
+        get("input").buttons(texts, (index, event) =>
+          send({ type: "touch-press", index, labels, time: Math.floor(event.timeStamp) }));
+      },
+    },
     start() { started = true; },
     dispose() {
       for (const type of Object.keys(phases)) window.removeEventListener(type, listen, { capture: true });
       canvas.removeEventListener("contextmenu", menu);
+      get("input")?.buttons([]);
       started = false;
     },
   };
 }
 
-// The holder's lease is read at each service tick and reported when it changes.
+// The holder's lease and labels are read at each service tick and reported when they change.
 export function worker({ get, send }) {
-  let transport, stop, reported = 0;
+  let transport, stop, reported = 0, shown = 0;
   return {
-    messages: { "touch-finger"({ phase, pointerId, samples }) { transport?.finger(phase, pointerId, samples); } },
+    messages: {
+      "touch-finger"({ phase, pointerId, samples }) { transport?.finger(phase, pointerId, samples); },
+      "touch-press"({ index, labels, time }) { transport?.press(index, labels, time); },
+    },
     service() {
       const lease = transport?.lease() ?? 0;
       if (transport && lease !== reported) send({ type: "touch-lease", lease: reported = lease });
+      const buttons = transport?.buttons();
+      if (buttons && buttons.labels !== shown) send({ type: "touch-buttons", ...buttons, labels: shown = buttons.labels });
     },
     start({ kernel, memory }) {
       const address = Number(kernel.dolly_touch_mailbox_address());