feat: windows build (#327)

* Rename CALLBACK defined in Windows headers

* Rename interface defined in Windows headers

* Reuse SET_PROTOTYPE method from util.h

Fixes warning: SET_METHOD redefined

* Don't initialize array with a variable

Fixes MSVC Error C2131

* Remove GCC attribute MSVC doesn't know

At some point something like
https://stackoverflow.com/questions/4226308/msvc-equivalent-of-attribute-warn-unused-result/22759336#22759336
should be used

* Replace uint with guint

https://developer-old.gnome.org/gobject/stable/gobject-Closures.html#GClosureMarshal

* Move cflags & ldflags to Linux only

* Get rid of Darwin and force local node-pre-gyp

* Replace NAN_EXPORT with Nan:Export

Fixes gi.cc(373): error C3861: 'Export': identifier not found
On Windows, for unclear reason the Nan namespace is lost for NAN_EXPORT(exports, RegisterClass)

* Don't call g_source_add_unix_fd on Windows

* Add Windows build config

* Fix Windows include path

* Use g_free where appropriate

Fixes segfault on Windows

* Add GitHub workflow for Windows

* Add Node.js 16 Windows build

* Use appropriate Node.js version

* Ensure arg is zeroed

Fixes some segfaults on Windows, like
const val = new GObject.Value()
val.init(GObject.TYPE_STRING) <- crash

* Improve tests skipping

* Skip tests knows to fail on Windows

* Install gstreamer and libsoop to Windows

* Fix require test on Windows

* Don't free something that is not zero terminated

Fixes some crases on Windows.
Fixes 5 tests

* Ensure allocated memory is zeroed

Fixes 1 test on Windows

* GType is gsize, not gulong

GType is gsize is 8 bytes
gulong is 8 bytes on Linux and 4 bytes Windows

Fixes some segfaults on Windows
Fixes 3 tests on Windows

* Get rid of platform specific uint and ulong

* Use specific types to mute warnings on Linux

* Fix union__fields.js test on Windows

Number.MAX_SAFE_INTEGER is 8 bytes, but
vInt is gulong 4 bytes on Windows and 8 bytes on Linux

* Cleanup

* Cleanup #2

* Install gstreamer plugins

Fixes 1 test on Windows

* Partially enable conversion__array.js on Windows

See comment in code

* Fix generator

* Replace malloc/calloc with g_malloc

On Windows g_free memory allocated with malloc/calloc crashes

* Revert double-space

* Heap allocation on non-Linux only

Author: ten0s

.github/workflows/main.yaml

@@ -1,6 +1,55 @@
 name: main
 on: [push, pull_request]
 jobs:
+  build-windows:
+    name: windows - nodejs ${{ matrix.node }}
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        node:
+          - 16
+          - 12
+    defaults:
+      run:
+        shell: msys2 {0}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+      - uses: msys2/setup-msys2@v2
+        with:
+          msystem: MINGW64
+          path-type: inherit
+          update: true
+          install: |
+            git
+            mingw-w64-x86_64-gobject-introspection
+            mingw-w64-x86_64-gtk3
+            mingw-w64-x86_64-cairo
+            mingw-w64-x86_64-gstreamer
+            mingw-w64-x86_64-gst-plugins-good
+            mingw-w64-x86_64-gst-plugins-bad
+            mingw-w64-x86_64-libsoup
+
+      - name: Install VS 2017
+        shell: cmd
+        run: choco upgrade -y visualstudio2017-workload-vctools
+
+      - name: Install & Build
+        run: |
+          ./windows/mingw_include_extra.sh
+          export MINGW_WINDOWS_PATH=$(./windows/mingw_windows_path.sh)
+          npm config set msvs_version 2017
+          npm install --build-from-source
+
+      - name: Run tests
+        run: |
+          npx mocha                                 \
+                    --skip=callback                 \
+                    --skip=signal__non-introspected \
+                    tests/__run__.js
+
   build:
     name: ${{ matrix.os }} - nodejs ${{ matrix.node }}
     runs-on: ${{ matrix.os }}

README.md

@@ -218,6 +218,13 @@ 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
 ```

binding.gyp

@@ -39,21 +39,20 @@
             "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": [
@@ -71,16 +70,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.json

@@ -4,11 +4,11 @@
   "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",

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) {
             /*

src/callback.cc

@@ -22,7 +22,7 @@ using Nan::TryCatch;
 
 namespace GNodeJS {
 
-static uint callbackLevel = 0;
+static guint callbackLevel = 0;
 static GSList* notifiedCallbacks = NULL;
 
 static Local<Object> GetSelfInstance(GIArgument **args) {
@@ -91,18 +91,18 @@ 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];
     #else
         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 +144,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 +171,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;

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 @@ void Closure::Execute(GICallableInfo *info, guint signal_id,
 
 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) {

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);
 

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(", ");
     }