@gjsify/node-gi 0.13.0 → 0.21.0

package/overrides/mainloop.js

@@ -0,0 +1,60 @@
+// SPDX-License-Identifier: MIT OR LGPL-2.0-or-later
+// SPDX-FileCopyrightText: 2012 Giovanni Campagna <scampa.giovanni@gmail.com>
+//
+// Adapted from GJS (refs/gjs/modules/script/mainloop.js). Copyright (c) 2012
+// Giovanni Campagna. MIT OR LGPL-2.0-or-later.
+// Modifications: the legacy `imports.mainloop` — a thin convenience layer over
+// GLib.MainLoop — ported to @gjsify/node-gi. GJS builds the idle/timeout sources
+// via GObject.source_set_closure; this port routes through GLib.idle_add /
+// GLib.timeout_add directly instead (equivalent behavior, one less indirection —
+// the engine marshals JS functions both as GI callbacks and as GClosures, see
+// test/gclosure-in-args.test.mjs), keeping the same `imports.mainloop.*` surface.
+
+const DEFAULT_IDLE_PRIORITY = 200; // GLib.PRIORITY_DEFAULT_IDLE
+
+/**
+ * Build the `imports.mainloop` object bound to the L1 GLib namespace.
+ * @param {Record<string, any>} GLib
+ * @returns {{ run(name?: string): void, quit(name?: string): void, idle_add: Function, timeout_add: Function, timeout_add_seconds: Function, source_remove: Function }}
+ */
+export function createMainloop(GLib) {
+  const _mainLoops = Object.create(null);
+
+  function run(name = '') {
+    if (!_mainLoops[name]) _mainLoops[name] = GLib.MainLoop.new(null, false);
+    _mainLoops[name].run();
+  }
+
+  function quit(name = '') {
+    if (!_mainLoops[name]) throw new Error('No main loop with this id');
+
+    const loop = _mainLoops[name];
+    _mainLoops[name] = null;
+
+    if (!loop.is_running()) throw new Error('Main loop was stopped already');
+
+    loop.quit();
+  }
+
+  // GJS signature is `idle_add(handler, priority)` — handler first — whereas the
+  // introspected GLib.idle_add is `(priority, handler)`; bridge the argument order.
+  function idle_add(handler, priority = DEFAULT_IDLE_PRIORITY) {
+    return GLib.idle_add(priority, handler);
+  }
+
+  function timeout_add(timeout, handler, priority = GLib.PRIORITY_DEFAULT) {
+    return GLib.timeout_add(priority, timeout, handler);
+  }
+
+  function timeout_add_seconds(timeout, handler, priority = GLib.PRIORITY_DEFAULT) {
+    return GLib.timeout_add_seconds(priority, timeout, handler);
+  }
+
+  function source_remove(id) {
+    return GLib.source_remove(id);
+  }
+
+  return { run, quit, idle_add, timeout_add, timeout_add_seconds, source_remove };
+}
+
+export default createMainloop;

package/overrides/package.js

@@ -0,0 +1,167 @@
+// SPDX-License-Identifier: MIT OR LGPL-2.0-or-later
+// SPDX-FileCopyrightText: 2013 Giovanni Campagna <scampa.giovanni@gmail.com>
+//
+// Adapted from GJS (refs/gjs/modules/script/package.js). Copyright (c) 2013
+// Giovanni Campagna. MIT OR LGPL-2.0-or-later.
+// Modifications: the legacy `imports.package` — the GJS application bootstrap
+// (`pkg.init` / `initGettext` / `initFormat`) — ported to @gjsify/node-gi. A GNOME
+// app's entry point does `imports.package.init({ name, version, prefix, libdir })`
+// then `pkg.initGettext()` / `pkg.initFormat()`. The GJS original's heavy
+// source-tree detection + GResource registration + module-search machinery is NOT
+// load-bearing for a node-gi consumer (the app carries its own dir constants and
+// registers its own resources — see easy6502 app-gnome resources.ts), so this is
+// the minimal, honest init: set `globalThis.pkg`, wire `_`/`C_`/`N_` and
+// `String.prototype.format`, and keep `imports.searchPath` / `GLib.set_prgname`
+// calls safe. Mirrors overrides/mainloop.js's `createX(deps)` shape.
+
+/**
+ * Build the `imports.package` object bound to the L1 backend.
+ * @param {{ requireGi: Function, gettext: any, imports: Record<string, any> }} deps
+ */
+export function createPackage({ requireGi, gettext, imports }) {
+  const pkg = {
+    // Public fields GJS source may read. Populated by init().
+    name: undefined,
+    version: undefined,
+    prefix: undefined,
+    libdir: undefined,
+    datadir: undefined,
+    pkgdatadir: undefined,
+    pkglibdir: undefined,
+    moduledir: undefined,
+    localedir: undefined,
+
+    /**
+     * @param {{ name?: string, version?: string, prefix?: string, libdir?: string, datadir?: string }} params
+     */
+    init(params = {}) {
+      // The accessor GJS apps use right after: `pkg.initGettext()`.
+      globalThis.pkg = pkg;
+
+      pkg.name = params.name;
+      pkg.version = params.version;
+      pkg.prefix = params.prefix;
+      pkg.libdir = params.libdir;
+      pkg.datadir = params.datadir ?? (params.prefix ? `${params.prefix}/share` : undefined);
+
+      // Installed-layout dirs — NOT load-bearing on node-gi (apps carry their own
+      // constants + register their own resources), computed for source-compat only.
+      if (pkg.name) {
+        if (pkg.datadir) {
+          pkg.pkgdatadir = `${pkg.datadir}/${pkg.name}`;
+          pkg.moduledir = pkg.pkgdatadir;
+          pkg.localedir = `${pkg.datadir}/locale`;
+        }
+        if (pkg.libdir) pkg.pkglibdir = `${pkg.libdir}/${pkg.name}`;
+      }
+
+      // Cheap + safe: keeps ARGV[0]/app-id semantics (window-manager grouping etc.).
+      try {
+        const GLib = requireGi('GLib', '2.0');
+        if (pkg.name && typeof GLib.set_prgname === 'function') GLib.set_prgname(pkg.name);
+      } catch {
+        /* GLib not loadable in this context — skip */
+      }
+
+      // GJS unshifts moduledir onto imports.searchPath (script-import machinery).
+      // node-gi apps use ESM + gi://, so the search path is inert here — but keep
+      // the array present + the unshift safe so source that reads it doesn't throw.
+      if (!Array.isArray(imports.searchPath)) imports.searchPath = [];
+      if (pkg.moduledir) imports.searchPath.unshift(pkg.moduledir);
+    },
+
+    initGettext() {
+      if (pkg.name) {
+        try {
+          gettext.bindtextdomain?.(pkg.name, pkg.localedir ?? null);
+          gettext.textdomain?.(pkg.name);
+        } catch {
+          /* passthrough gettext — no catalog, ignore */
+        }
+      }
+      // The globals GJS apps + compiled Blueprint use pervasively.
+      globalThis._ = (msgid) => gettext.gettext(msgid);
+      globalThis.C_ = (context, msgid) => gettext.pgettext(context, msgid);
+      globalThis.N_ = (msgid) => msgid;
+    },
+
+    initFormat() {
+      // GJS sets `String.prototype.format = imports.format.format` (backed by the
+      // native `_format` vprintf). node-gi has no `imports.format`, so supply an
+      // equivalent JS vprintf here (see makeVprintf).
+      const vprintf = makeVprintf();
+      Object.defineProperty(String.prototype, 'format', {
+        configurable: true,
+        writable: true,
+        enumerable: false,
+        value: function format(...args) {
+          return vprintf(this, args);
+        },
+      });
+    },
+
+    // Script-import machinery is not ported — node-gi apps use ESM + gi://. These
+    // keep the surface present for source that references them (Learn6502 does not).
+    require() {
+      /* no-op: apps import via ESM / gi:// on node-gi */
+    },
+    requireSymbol() {
+      return true;
+    },
+    checkSymbol() {
+      return true;
+    },
+    start(params = {}) {
+      pkg.init(params);
+      if (typeof params.main === 'function') params.main(globalThis.ARGV ? ['', ...globalThis.ARGV] : []);
+    },
+    run() {
+      /* the app drives its own main() on node-gi */
+    },
+    initSubmodule() {
+      /* n/a on node-gi */
+    },
+  };
+
+  return pkg;
+}
+
+// A small vprintf covering the GJS `String.prototype.format` spec
+// (refs/gjs/modules/script/format.js): `%s %d %x %f`, `%.Nf` precision, `%Ns`/`%Nd`
+// width, `0`-padding for numerics, and `%%` → literal `%`. Positional `%N$s` is
+// supported (GJS honours it). Learn6502 only uses `%s`; the rest is fidelity.
+function makeVprintf() {
+  return function vprintf(fmt, args) {
+    let auto = 0;
+    return String(fmt).replace(
+      /%(?:(\d+)\$)?(0)?(\d+)?(?:\.(\d+))?([%sdxf])/g,
+      (match, pos, zero, width, prec, spec) => {
+        if (spec === '%') return '%';
+        const arg = pos !== undefined ? args[Number(pos) - 1] : args[auto++];
+        let str;
+        switch (spec) {
+          case 's':
+            str = String(arg);
+            break;
+          case 'd':
+            str = String(Math.trunc(Number(arg)));
+            break;
+          case 'x':
+            str = Math.trunc(Number(arg)).toString(16);
+            break;
+          case 'f':
+            str = prec !== undefined ? Number(arg).toFixed(Number(prec)) : String(Number(arg));
+            break;
+          default:
+            return match;
+        }
+        if (width !== undefined) {
+          const w = Number(width);
+          const pad = zero && spec !== 's' ? '0' : ' ';
+          while (str.length < w) str = pad + str;
+        }
+        return str;
+      },
+    );
+  };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gjsify/node-gi",
-  "version": "0.13.0",
+  "version": "0.21.0",
   "description": "GObject-Introspection runtime for Node.js — load gi:// namespaces (GLib/GObject/Gio/…) with GJS-compatible semantics. Vendored + rewritten from node-gtk under MIT.",
   "type": "module",
   "license": "MIT",
@@ -19,6 +19,22 @@
     "./globals": {
       "types": "./globals.d.ts",
       "default": "./globals.js"
+    },
+    "./system": {
+      "types": "./system.d.ts",
+      "default": "./system.js"
+    },
+    "./gettext": {
+      "types": "./gettext.d.ts",
+      "default": "./gettext.js"
+    },
+    "./cairo": {
+      "types": "./cairo.d.ts",
+      "default": "./cairo.js"
+    },
+    "./gtk-runtime": {
+      "types": "./gtk-runtime.d.ts",
+      "default": "./gtk-runtime.js"
     }
   },
   "files": [
@@ -26,8 +42,17 @@
     "index.d.ts",
     "gi.js",
     "gi.d.ts",
+    "gtk-runtime.js",
+    "gtk-runtime.d.ts",
     "globals.js",
     "globals.d.ts",
+    "system.js",
+    "system.d.ts",
+    "gettext.js",
+    "gettext.d.ts",
+    "cairo.js",
+    "cairo.d.ts",
+    "overrides",
     "src",
     "binding.gyp",
     "prebuilds"
@@ -38,16 +63,32 @@
       "node": "polyfill",
       "browser": "none",
       "nativescript": "none"
-    }
+    },
+    "tier": 2
   },
   "scripts": {
     "install": "node-gyp rebuild",
     "build": "node-gyp rebuild",
     "build:native": "node-gyp rebuild",
+    "build:prebuild": "node-gyp rebuild && node scripts/stage-prebuild.mjs",
     "rebuild": "node-gyp rebuild",
     "clean": "node-gyp clean",
-    "test": "node --test",
-    "test:node": "node --test"
+    "test": "NODE_GI_NATIVE=build node --test",
+    "test:node": "NODE_GI_NATIVE=build node --test",
+    "test:gc": "NODE_GI_NATIVE=build node --test --expose-gc",
+    "test:dbus": "dbus-run-session -- env NODE_GI_NATIVE=build node --test --expose-gc test/dbus.test.mjs test/dbus-async.test.mjs",
+    "test:bun": "node scripts/cross-runtime.mjs bun",
+    "test:conformance": "node scripts/conformance.mjs",
+    "test:gimarshalling": "node scripts/gimarshalling.mjs",
+    "test:deno": "node scripts/cross-runtime.mjs deno",
+    "test:cairo": "NODE_GI_NATIVE=build node --test test/cairo.test.mjs",
+    "test:cairo-canvas2d": "NODE_GI_NATIVE=build node --test test/cairo-canvas2d.test.mjs",
+    "test:gtk": "NODE_GI_NATIVE=build node --test test/gtk-smoke.test.mjs",
+    "test:gtk-cairo": "NODE_GI_NATIVE=build node --test test/cairo-drawfunc.test.mjs",
+    "test:adw": "NODE_GI_NATIVE=build node --test test/adw-smoke.test.mjs",
+    "test:gtk-template": "NODE_GI_NATIVE=build node --test test/gtk-template.test.mjs",
+    "test:gtk-template-callbacks": "NODE_GI_NATIVE=build node --test test/gtk-template-callbacks.test.mjs",
+    "test:gtk-template-signals": "NODE_GI_NATIVE=build node --test test/gtk-template-signals.test.mjs"
   },
   "dependencies": {
     "node-addon-api": "^8.0.0"