node-gtk 0.11.0 → 0.12.1

package/README.md

@@ -19,8 +19,8 @@ Node-Gtk is a [gobject-introspection](https://gi.readthedocs.io/en/latest) libra
 use any introspected library, such as Gtk+, usable.  It is similar in essence to [GJS](https://wiki.gnome.org/action/show/Projects/Gjs) or [PyGObject](https://pygobject.readthedocs.io). Please note this project is currently in a _beta_ state and is being developed. Any contributors willing to help
 will be welcomed.
 
-Supported Node.js versions: **12**, **14**, **15**, **16** (other versions should work but are untested)  
-Pre-built binaries available for: **Linux**, **macOS**
+Supported Node.js versions: **16**, **18** (other versions should work but are untested)<br>
+Pre-built binaries available for: **Linux**, **macOS** (all supported versions except 18)
 
 ### Table of contents
 
@@ -32,8 +32,8 @@ Pre-built binaries available for: **Linux**, **macOS**
   - [How to build on Ubuntu](#how-to-build-on-ubuntu)
   - [How to build on Fedora](#how-to-build-on-fedora)
   - [How to build on ArchLinux](#how-to-build-on-archlinux)
-  - [How to build on macOS](#how-to-build-on-osx)
-  - [Experimental platforms](#experimental-platforms)
+  - [How to build on macOS](#how-to-build-on-macos)
+  - [How to build on Windows](#how-to-build-on-windows)
   - [Testing the project](#testing-the-project)
     - [Browser demo](#browser-demo)
 - [Contributing](#contributing)
@@ -88,17 +88,15 @@ Note that prebuilt binaries are available for common systems, in those cases bui
 
  - **Linux**: prebuilt binaries available
  - **macOS**: prebuilt binaries available
- - **Windows**: unsupported for now ([#241](https://github.com/romgrk/node-gtk/issues/241))
+ - **Windows**: no prebuilt binaries
 
 ### Requirements
 
  - `git`
  - `nodejs@10` or higher
- - `python2` (for `node-gyp`)
+ - `python3` (for `node-gyp`)
  - C compiler (`gcc@8` or higher, or `clang`)
 
-In the _not-working-yet_ Windows platform, all dependencies must be available under [MSYS2 shell](https://msys2.github.io).
-
 ### How to build on Ubuntu
 
 Install basic dependencies.
@@ -155,48 +153,11 @@ brew install git node gobject-introspection gtk+3 cairo
 
 At this point `npm install node-gtk` should already install, fallback and build `node-gtk` without problems.
 
-### Testing the project
-
-If you'd like to test everything builds and work properly, after installing and building you can run any of the
-examples:
-
-```sh
-node ./examples/hello-gtk.js
-```
-
-If you'll see a little window saying hello that's it: it works!
-
-Please note in macOS the window doesn't automatically open above other windows.
-Try <kbd>Cmd</kbd> + <kbd>Tab</kbd> if you don't see it.
-
-#### Browser demo
-
-If you'd like to test `./examples/browser.js` you'll need [WebKit2 GTK+](http://webkitgtk.org/) libary.
-
-- in **Ubuntu**, you can `apt-get install libwebkit2gtk-3.0` (`4.0` works too) and try it out.
-- in **Fedora**, you should run `sudo dnf install webkit2gtk3`
-- in **ArchLinux**, you can `pacman -S --needed webkitgtk` and try it out.
-- in **macOS**, there is no way to run it right now because `webkitgtk` was removed from homebrew
-
-Once installed, you can `./examples/browser.js google.com` or any other page, and you might try the _dark theme_ out too:
-
-```sh
-# macOS needs to have the Adwaita theme installed
-# brew install adwaita-icon-theme
-
-# Usage: ./examples/browser.js <url> [theme]
-./examples/browser.js  google.com  dark
-```
-
-### Experimental platforms
+### How to build on Windows
 
-Following how to setup the configuration to at least try building this project.
+Mandatory dependency is Visual C++ Build Environment: Visual Studio Build Tools (using "Visual C++ build tools" workload) or Visual Studio Community (using the "Desktop development with C++" workload).
 
-#### How to build on Windows (experimental)
-
-Mandatory dependency is _[Visual Studio Community](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx)_ or _Express_ with a C++ compiler (open a new C++ project and install it via IDE if necessary).
-
-The easiest/tested way to at least try building this repository is within a _MinGW shell_ provided by the [MSYS2 installer](https://msys2.github.io/).
+The easiest/tested way to build this repository is within a _MinGW shell_ provided by the [MSYS2 installer](https://msys2.github.io/).
 
 Once VS and its C++ compiler is available and MSYS2 installed, launch the MinGW shell.
 
@@ -226,12 +187,18 @@ cd node-gtk
 export MINGW_WINDOWS_PATH=$(./windows/mingw_windows_path.sh)
 
 # first run might take a while
-GYP_MSVS_VERSION=2015 npm install
+GYP_MSVS_VERSION=2017 npm install
 ```
 
-The `GYP_MSVS_VERSION` could be 2010, 2012, 2013 or 2015.
+The `GYP_MSVS_VERSION` could be 2017 or above.
 Please verify [which version you should use](https://github.com/nodejs/node-gyp#installation)
 
+The below blog post series will help you get started:
+
+1. [Node.js GTK Hello World on Windows](https://ten0s.github.io/blog/2022/07/22/nodejs-gtk-hello-world-on-windows)
+2. [Find DLLs and Typelibs dependencies for Node.js GTK Application on Windows](https://ten0s.github.io/blog/2022/07/25/find-dlls-and-typelibs-dependencies-for-nodejs-gtk-application-on-windows)
+3. [Package Node.js GTK Application on Windows](https://ten0s.github.io/blog/2022/07/27/package-nodejs-gtk-application-on-windows)
+
 #### Possible issue on MinGW shell
 
 In case you are launching the general executable without knowing the correct platform,
@@ -249,11 +216,38 @@ npm run install
 
 This should do the trick. You can also check if there is any python at all via `pacman -Qs python`.
 
-Please remember `python2` is the one needed.
+### Testing the project
+
+If you'd like to test everything builds and work properly, after installing and building you can run any of the
+examples:
+
+```sh
+node ./examples/hello-gtk.js
+```
+
+If you'll see a little window saying hello that's it: it works!
+
+Please note in macOS the window doesn't automatically open above other windows.
+Try <kbd>Cmd</kbd> + <kbd>Tab</kbd> if you don't see it.
+
+#### Browser demo
 
-#### Known issues building on Windows
+If you'd like to test `./examples/browser.js` you'll need [WebKit2 GTK+](http://webkitgtk.org/) libary.
 
-Right now there are few gotchas and the build will most likely fail. Please help with a PR if you know how to solve the issue, thank you!
+- in **Ubuntu**, you can `apt-get install libwebkit2gtk-3.0` (`4.0` works too) and try it out.
+- in **Fedora**, you should run `sudo dnf install webkit2gtk3`
+- in **ArchLinux**, you can `pacman -S --needed webkitgtk` and try it out.
+- in **macOS**, there is no way to run it right now because `webkitgtk` was removed from homebrew
+
+Once installed, you can `./examples/browser.js google.com` or any other page, and you might try the _dark theme_ out too:
+
+```sh
+# macOS needs to have the Adwaita theme installed
+# brew install adwaita-icon-theme
+
+# Usage: ./examples/browser.js <url> [theme]
+./examples/browser.js  google.com  dark
+```
 
 ## Contributing
 

package/binding.gyp

@@ -56,7 +56,6 @@
                 }],
                 ['OS == "mac"', {
                     "defines": [
-                        "ulong=unsigned long",
                         "PLATFORM_MAC=1",
                     ],
                     "xcode_settings": {

package/lib/overrides/Gtk-3.0.js

@@ -32,6 +32,14 @@ exports.apply = (Gtk) => {
         process._tickCallback()
 
         const loopStack = internal.GetLoopStack()
+
+        /*
+         * To keep the nodejs event loop alive, we need to have something running.
+         */
+        if (placeholderIntervalID === undefined) {
+          placeholderIntervalID = setInterval(() => { /* noop */ }, 60 * 60 * 1000)
+        }
+
         loopStack.push(originalQuit)
 
         originalMain()

package/lib/overrides/Gtk-4.0.js

@@ -11,6 +11,22 @@ exports.apply = (Gtk) => {
   Gtk.EVENT_CONTINUE = false
   Gtk.EVENT_STOP     = true
 
+  /**
+   * Gtk.Widget.prototype.containsChild
+   * @param {Gtk.Widget} child
+   * @returns {bool}
+   */
+  Gtk.Widget.prototype.containsChild = function containsChild(child) {
+    let current = child
+    while (current) {
+      if (current === this)
+        return true
+      current = current.getParent()
+    }
+    return false
+  }
+
+
   Gtk.Widget.prototype._addCssClass = Gtk.Widget.prototype.addCssClass
   Gtk.Widget.prototype._removeCssClass = Gtk.Widget.prototype.removeCssClass
 

package/lib/register-class.js

@@ -72,17 +72,14 @@ function setupVirtualFunctions(klass, klassGtype, parentGtype) {
 }
 
 function findVFunc(gtype, parentInfo, name) {
-  let [vfuncInfo, _] = findVFuncOnParents(parentInfo, name)
+  let vfuncInfo = findVFuncOnParents(parentInfo, name)
   if (!vfuncInfo) {
     vfuncInfo = findVFuncOnInterfaces(gtype, name)
-    // definedByParent = false
   }
   return vfuncInfo
 }
 
 function findVFuncOnParents(info, name) {
-  let definedByParent = false;
-
   let parent = info
 
   /* Since it isn't possible to override a vfunc on
@@ -91,15 +88,32 @@ function findVFuncOnParents(info, name) {
   let [vfunc, _] =
     GI.object_info_find_vfunc_using_interfaces(parent, name, null)
 
-  do {
-    if (parent)
-      vfunc = GI.object_info_find_vfunc(info, name)
+  if (vfunc) {
+    return vfunc
+  }
+
+  while (parent) {
+    vfunc = GI.object_info_find_vfunc(info, name)
+
+    if (vfunc) {
+      return vfunc
+    }
+
+    /* HACK: object_info_find_vfunc sometimes fail, so we also search for
+     * the matching entry manually. */
+    const n = GI.object_info_get_n_vfuncs(parent)
+    for (let i = 0; i < n; i++) {
+      const vfunc = GI.object_info_get_vfunc(parent, i)
+      const currentName = GI.BaseInfo_get_name.call(vfunc)
+      if (currentName === name) {
+        return vfunc
+      }
+    }
 
     parent = GI.object_info_get_parent(parent)
-    definedByParent = true
-  } while (!vfunc && parent)
+  }
 
-  return [vfunc, definedByParent]
+  return null
 }
 
 function findVFuncOnInterfaces(gtype, name) {
@@ -163,18 +177,3 @@ function createGTypeName(klass) {
 function sanitizeGType(s) {
   return s.replace(/[^a-z0-9+_-]/gi, '_');
 }
-
-function getParents(klass) {
-  const parents = []
-
-  let current = klass
-  do {
-    let proto = Object.getPrototypeOf(current.prototype)
-    current = proto ? proto.constructor : null
-    if (!current)
-      break
-    parents.push(current)
-  } while (current)
-
-  return parents
-}

package/package.json

@@ -1,8 +1,15 @@
 {
   "name": "node-gtk",
-  "version": "0.11.0",
+  "version": "0.12.1",
   "description": "GNOME Gtk+ bindings for NodeJS",
   "main": "lib/index.js",
+  "scripts": {
+    "install": "npx node-pre-gyp install --fallback-to-build",
+    "test": "mocha tests/__run__.js",
+    "build": "npx node-pre-gyp build",
+    "build:full": "npx node-pre-gyp rebuild",
+    "configure": "npx node-pre-gyp configure --debug"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/romgrk/node-gtk.git"
@@ -25,12 +32,12 @@
   },
   "homepage": "https://github.com/romgrk/node-gtk#readme",
   "dependencies": {
-    "@mapbox/node-pre-gyp": "^1.0.0",
+    "@mapbox/node-pre-gyp": "^1.0.10",
     "lodash.camelcase": "4.3.0",
     "lodash.isequal": "4.5.0",
     "lodash.snakecase": "^4.1.1",
-    "nan": "2.14.2",
-    "node-gyp": "^7.1.2",
+    "nan": "^2.17.0",
+    "node-gyp": "^9.3.1",
     "remove-trailing-spaces": "^1.0.7",
     "unindent": "^2.0.0"
   },
@@ -55,12 +62,5 @@
     "remote_path": "./{module_name}/v{version}/",
     "package_name": "{module_name}-{node_abi}-{platform}-{arch}.tar.gz",
     "host": "https://node-gtk-1.s3.amazonaws.com"
-  },
-  "scripts": {
-    "install": "npx node-pre-gyp install --fallback-to-build",
-    "test": "mocha tests/__run__.js",
-    "build": "npx node-pre-gyp build",
-    "build:full": "npx node-pre-gyp rebuild",
-    "configure": "npx node-pre-gyp configure --debug"
   }
-}
+}

package/scripts/ci.sh

@@ -41,7 +41,11 @@ function npm_test() {
     echo "### Running tests ###";
 
     if [[ $(uname -s) == 'Darwin' ]]; then
-        npm test;
+        export GST_PLUGIN_SYSTEM_PATH=/usr/local/lib/gstreamer-1.0;
+        npx mocha                                 \
+                  --skip=callback                 \
+                  --skip=error                    \
+                  tests/__run__.js
     else
         xvfb-run -a npm test;
     fi;

package/src/callback.cc

@@ -18,7 +18,6 @@ using v8::Isolate;
 using v8::Local;
 using v8::Object;
 using v8::Value;
-using Nan::TryCatch;
 
 namespace GNodeJS {
 
@@ -33,13 +32,13 @@ static Local<Object> GetSelfInstance(GIArgument **args) {
 Callback::Callback(Local<Function> fn, GICallableInfo* callback_info, GIScopeType scope_type_) {
     persistent.Reset(fn);
     info = g_base_info_ref (callback_info);
-    closure = g_callable_info_prepare_closure(info, &cif, Callback::Call, this);
+    closure = g_callable_info_create_closure(info, &cif, Callback::Call, this);
     scope_type = scope_type_;
 }
 
 Callback::~Callback() {
     persistent.Reset();
-    g_callable_info_free_closure (this->info, this->closure);
+    g_callable_info_destroy_closure (this->info, this->closure);
     g_base_info_unref (this->info);
 }
 

package/src/util.h

@@ -55,9 +55,7 @@ inline void SetProtoAccessor(
             setter,
             v8::Local<v8::Value>(),
             v8::DEFAULT,
-            v8::None,
-            v8::AccessorSignature::New(v8::Isolate::GetCurrent(), ctor)
-            );
+            v8::None);
 }
 
 namespace Util

package/src/value.cc

@@ -877,8 +877,6 @@ bool V8ToOutGIArgument(GITypeInfo *type_info, GIArgument *arg, Local<Value> valu
      */
     GITypeTag type_tag = g_type_info_get_tag (type_info);
 
-    memset(arg, 0, sizeof(GIArgument));
-
     if (value->IsUndefined () || value->IsNull ()) {
         arg->v_pointer = NULL;