node-gtk 0.10.0 → 0.12.0

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
-
-Following how to setup the configuration to at least try building this project.
+### How to build on Windows
 
-#### How to build on Windows (experimental)
+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).
 
-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.
 
@@ -218,13 +179,26 @@ cd ~/oss
 git clone https://github.com/romgrk/node-gtk
 cd node-gtk
 
+# don't include /mingw64/include directly since it conflicts with
+# Windows SDK headers. we copy needed headers to __extra__ directory:
+./windows/mingw_include_extra.sh
+
+# if MSYS2 is NOT installed in C:/msys64 run:
+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,
@@ -242,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
+```
 
-#### Known issues building on Windows
+If you'll see a little window saying hello that's it: it works!
 
-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!
+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
+```
 
 ## Contributing
 

package/binding.gyp

@@ -39,23 +39,23 @@
             "include_dirs" : [
                 "<!(node -e \"require('nan')\")"
             ],
-            "cflags": [
-                "<!@(pkg-config --cflags gobject-introspection-1.0 cairo) -Wall -g",
-            ],
-            "ldflags": [
-                "-Wl,-no-as-needed",
-                "<!@(pkg-config --libs gobject-introspection-1.0 cairo)",
-            ],
             "conditions": [
-                ['OS != "linux"', {
+                ['OS == "linux"', {
                     "defines": [
-                        "ulong=unsigned long",
                         "PLATFORM_LINUX=1",
-                    ]
+                    ],
+                    "cflags": [
+                        "<!@(pkg-config --cflags gobject-introspection-1.0 cairo)",
+                        "-Wall",
+                        "-g",
+                    ],
+                    "ldflags": [
+                        "-Wl,-no-as-needed",
+                        "<!@(pkg-config --libs gobject-introspection-1.0 cairo)",
+                    ],
                 }],
                 ['OS == "mac"', {
                     "defines": [
-                        "ulong=unsigned long",
                         "PLATFORM_MAC=1",
                     ],
                     "xcode_settings": {
@@ -69,16 +69,34 @@
                 }],
                 ['OS == "win"', {
                     "defines": [
-                        "uint=unsigned int",
                         "PLATFORM_WIN=1",
                     ],
+                    "variables": {
+                        # If MSYS2 is NOT installed in C:/msys64 run:
+                        # $ export MINGW_WINDOWS_PATH=$(./windows/mingw_windows_path.sh)
+                        # before compiling
+                        "MINGW_PREFIX": "<!(bash -c 'echo ${MINGW_WINDOWS_PATH:-/msys64}')",
+                    },
                     "include_dirs": [
-                        "include",
-                        "/msys64/mingw64/include/gobject-introspection-1.0",
-                        "/msys64/mingw64/lib/libffi-3.2.1/include",
-                        "/msys64/mingw64/include/glib-2.0",
-                        "/msys64/mingw64/lib/glib-2.0/include",
-                        "/msys64/mingw64/include/cairo"
+                        # Don't include /mingw64/include directly.
+                        # To make extra include dir run:
+                        # $ ./windows/mingw_include_extra.sh
+                        # before compiling
+                        "<(MINGW_PREFIX)/mingw64/include/__extra__",
+
+                        "<(MINGW_PREFIX)/mingw64/include/gobject-introspection-1.0",
+                        "<(MINGW_PREFIX)/mingw64/include/glib-2.0",
+                        "<(MINGW_PREFIX)/mingw64/lib/glib-2.0/include",
+                        "<(MINGW_PREFIX)/mingw64/include/cairo",
+                        "<(MINGW_PREFIX)/mingw64/include/freetype2",
+                    ],
+                    "libraries": [
+                        "<(MINGW_PREFIX)/mingw64/lib/libglib-2.0.dll.a",
+                        "<(MINGW_PREFIX)/mingw64/lib/libgmodule-2.0.dll.a",
+                        "<(MINGW_PREFIX)/mingw64/lib/libgobject-2.0.dll.a",
+                        "<(MINGW_PREFIX)/mingw64/lib/libffi.dll.a",
+                        "<(MINGW_PREFIX)/mingw64/lib/libgirepository-1.0.dll.a",
+                        "<(MINGW_PREFIX)/mingw64/lib/libcairo.dll.a",
                     ]
                 }]
             ]

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/package.json

@@ -1,14 +1,14 @@
 {
   "name": "node-gtk",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "GNOME Gtk+ bindings for NodeJS",
   "main": "lib/index.js",
   "scripts": {
-    "install": "if [ \"$(uname)\" = \"Darwin\" ] && [ \"$(which brew)\" != \"\" ]; then export PKG_CONFIG_PATH=$(brew --prefix libffi)/lib/pkgconfig; fi; node-pre-gyp install --fallback-to-build",
+    "install": "npx node-pre-gyp install --fallback-to-build",
     "test": "mocha tests/__run__.js",
-    "build": "node-pre-gyp build",
-    "build:full": "node-pre-gyp rebuild",
-    "configure": "node-pre-gyp configure --debug"
+    "build": "npx node-pre-gyp build",
+    "build:full": "npx node-pre-gyp rebuild",
+    "configure": "npx node-pre-gyp configure --debug"
   },
   "repository": {
     "type": "git",
@@ -32,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"
   },

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/boxed.cc

@@ -183,7 +183,7 @@ static void BoxedConstructor(const Nan::FunctionCallbackInfo<Value> &info) {
                 boxed = g_boxed_copy (gtype, boxed);
             }
             else if ((size = Boxed::GetSize(gi_info)) != 0) {
-                void *boxedCopy = malloc(size);
+                void *boxedCopy = g_malloc(size);
                 memcpy(boxedCopy, boxed, size);
                 boxed = boxedCopy;
             }
@@ -223,7 +223,7 @@ static void BoxedConstructor(const Nan::FunctionCallbackInfo<Value> &info) {
             boxed = return_value.v_pointer;
 
         } else if ((size = Boxed::GetSize(gi_info)) != 0) {
-            boxed = calloc(1, size);
+            boxed = g_malloc0(size);
 
         } else {
             Nan::ThrowError("Boxed allocation failed: no constructor found");
@@ -267,7 +267,7 @@ static void BoxedDestroyed(const Nan::WeakCallbackInfo<Boxed> &info) {
         }
         else if (box->size != 0) {
             // Allocated in ./function.cc @ AllocateArgument
-            free(box->data);
+            g_free(box->data);
         }
         else if (box->data != NULL) {
             /*

package/src/callback.cc

@@ -18,11 +18,10 @@ using v8::Isolate;
 using v8::Local;
 using v8::Object;
 using v8::Value;
-using Nan::TryCatch;
 
 namespace GNodeJS {
 
-static uint callbackLevel = 0;
+static guint callbackLevel = 0;
 static GSList* notifiedCallbacks = NULL;
 
 static Local<Object> GetSelfInstance(GIArgument **args) {
@@ -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);
 }
 
@@ -91,10 +90,10 @@ void Callback::Execute (GIArgument *result, GIArgument **args, Callback *callbac
 
     /* Skip the object instance in first place */
     int args_offset = isVFunc ? 1 : 0;
-    uint n_native_args = (uint) g_callable_info_get_n_args(callback->info);
-    uint n_return_values = 1;
+    guint n_native_args = (guint) g_callable_info_get_n_args(callback->info);
+    guint n_return_values = 1;
 
-    uint primitive_out_arguments_mask = 0;
+    guint primitive_out_arguments_mask = 0;
 
     #ifndef __linux__
         Local<Value>* js_args = new Local<Value>[n_native_args];
@@ -102,7 +101,7 @@ void Callback::Execute (GIArgument *result, GIArgument **args, Callback *callbac
         Local<Value> js_args[n_native_args];
     #endif
 
-    for (uint i = 0; i < n_native_args; i++) {
+    for (guint i = 0; i < n_native_args; i++) {
         GIArgInfo arg_info;
         GITypeInfo arg_type;
         g_callable_info_load_arg (callback->info, i, &arg_info);
@@ -144,12 +143,11 @@ void Callback::Execute (GIArgument *result, GIArgument **args, Callback *callbac
         auto jsReturnValue = maybeReturnValue.ToLocalChecked();
         auto jsRealReturnValue = jsReturnValue;
         Local<Array> jsReturnArray;
-        uint returnIndex = 0;
+        guint returnIndex = 0;
         bool success;
         bool isOutPrimitive;
-        uint n_js_return_values = n_return_values - (hasVoidReturn ? 1 : 0);
+        guint n_js_return_values = n_return_values - (hasVoidReturn ? 1 : 0);
 
-        uint i;
         GIArgInfo arg_info;
         GITypeInfo arg_type;
 
@@ -172,7 +170,7 @@ void Callback::Execute (GIArgument *result, GIArgument **args, Callback *callbac
             else
                 jsRealReturnValue = Nan::Get(jsReturnArray, returnIndex++).ToLocalChecked();
 
-            for (i = 0; i < n_native_args; i++) {
+            for (guint i = 0; i < n_native_args; i++) {
                 isOutPrimitive = (primitive_out_arguments_mask & (1 << i)) != 0;
                 if (!isOutPrimitive)
                     continue;

package/src/closure.cc

@@ -35,7 +35,7 @@ GClosure *Closure::New (Local<Function> function, GICallableInfo* info, guint si
 
 void Closure::Execute(GICallableInfo *info, guint signal_id,
                       const Nan::Persistent<v8::Function> &persFn,
-                      GValue *g_return_value, uint n_param_values,
+                      GValue *g_return_value, guint n_param_values,
                       const GValue *param_values) {
     Nan::HandleScope scope;
     auto func = Nan::New<Function>(persFn);
@@ -45,7 +45,7 @@ void Closure::Execute(GICallableInfo *info, guint signal_id,
     g_signal_query(signal_id, &signal_query);
 
     // We don't pass the implicit instance as first argument
-    uint n_js_args = n_param_values - 1;
+    auto n_js_args = n_param_values - 1;
 
     #ifndef __linux__
         Local<Value>* js_args = new Local<Value>[n_js_args];
@@ -58,7 +58,7 @@ void Closure::Execute(GICallableInfo *info, guint signal_id,
         GIArgument argument;
         GIArgInfo arg_info;
         GITypeInfo type_info;
-        for (uint i = 1; i < n_param_values; i++) {
+        for (guint i = 1; i < n_param_values; i++) {
             memcpy(&argument, &param_values[i].data[0], sizeof(GIArgument));
             g_callable_info_load_arg(info, i - 1, &arg_info);
             g_arg_info_load_type(&arg_info, &type_info);
@@ -76,7 +76,7 @@ void Closure::Execute(GICallableInfo *info, guint signal_id,
         }
     } else {
         /* CallableInfo is not available: use GValueToV8 */
-        for (uint i = 1; i < n_param_values; i++) {
+        for (guint i = 1; i < n_param_values; i++) {
             bool mustCopy = true;
 
             if (signal_query.signal_id) {
@@ -123,7 +123,7 @@ throw_exception:
 
 void Closure::Marshal(GClosure     *base,
                       GValue       *g_return_value,
-                      uint          n_param_values,
+                      guint         n_param_values,
                       const GValue *param_values,
                       gpointer      invocation_hint,
                       gpointer      marshal_data) {

package/src/closure.h

@@ -30,12 +30,12 @@ struct Closure {
 
     static void Execute(GICallableInfo *info, guint signal_id,
                         const Nan::Persistent<v8::Function> &persFn,
-                        GValue *g_return_value, uint n_param_values,
+                        GValue *g_return_value, guint n_param_values,
                         const GValue *param_values);
 
     static void Marshal(GClosure *closure,
                         GValue   *g_return_value,
-                        uint argc, const GValue *g_argv,
+                        guint argc, const GValue *g_argv,
                         gpointer  invocation_hint,
                         gpointer  marshal_data);
 

package/src/debug.cc

@@ -158,7 +158,7 @@ void print_callable_info (GICallableInfo *info) {
     g_callable_info_load_return_type(info, &return_info);
     auto typeName = GetTypeName(&return_info);
     printf("%s %s (", typeName, g_base_info_get_name(info));
-    free(typeName);
+    g_free(typeName);
 
     int n_args = g_callable_info_get_n_args(info);
     for (int i = 0; i < n_args; i++) {
@@ -168,7 +168,7 @@ void print_callable_info (GICallableInfo *info) {
         g_arg_info_load_type(&arg_info, &type_info);
         auto typeName = GetTypeName(&type_info);
         printf("%s %s", typeName, g_base_info_get_name(&arg_info));
-        free(typeName);
+        g_free(typeName);
         if (i < n_args - 1)
             printf(", ");
     }