node-gtk 0.8.1 → 0.11.0

package/README.md

@@ -19,7 +19,7 @@ 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** (other versions should work but are untested)  
+Supported Node.js versions: **12**, **14**, **15**, **16** (other versions should work but are untested)  
 Pre-built binaries available for: **Linux**, **macOS**
 
 ### Table of contents
@@ -40,8 +40,10 @@ Pre-built binaries available for: **Linux**, **macOS**
 
 ## Usage
 
-You can use the [Gtk+ API](https://developer.gnome.org/gtk3/stable) directly, or you can
-use [react-gtk](https://github.com/codejamninja/react-gtk) if your prefer to use React.
+Below is a minimal example of how to use the code, but take a look at
+our [template](https://github.com/romgrk/node-gtk-template) or at
+[react-gtk](https://github.com/codejamninja/react-gtk) to bootstrap your
+project.
 
 ```javascript
 const gi = require('node-gtk')
@@ -216,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
 ```

package/binding.gyp

@@ -39,19 +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": [
@@ -69,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/lib/bootstrap.js

@@ -156,20 +156,6 @@ function addFunction(object, info) {
   define(object, getFunctionDescription(info))
 }
 
-function addVirtualFunction(object, info, implementor) {
-  const fn = internal.MakeVirtualFunction(info, implementor);
-  const name = getInfoName(info);
-  const flags = GI.function_info_get_flags(info);
-  const isMethod = ((flags & GI.FunctionInfoFlags.IS_METHOD) != 0 &&
-    (flags & GI.FunctionInfoFlags.IS_CONSTRUCTOR) == 0);
-  const target = (isMethod) ? object.prototype : object;
-  Object.defineProperty(target, name, {
-    configurable: true,
-    writable: true,
-    value: fn
-  })
-}
-
 function fieldGetter(fieldInfo) {
   return function () {
     return internal.StructFieldGetter(this, fieldInfo);
@@ -227,10 +213,6 @@ function makeFunction(info) {
   return internal.MakeFunction(info)
 }
 
-function makeVirtualFunction(info, implementor) {
-  return internal.MakeVirtualFunction(info, implementor)
-}
-
 function makeEnum(info) {
   const object = {}
 
@@ -395,9 +377,6 @@ function makeInfo(info) {
     case GI.InfoType.FUNCTION:
       return makeFunction(info);
 
-    // case GI.InfoType.VFUNC:
-    // return makeVirtualFunction(info, ...args);
-
     case GI.InfoType.STRUCT:
       if (GI.struct_info_is_gtype_struct(info))
         return undefined;

package/package.json

@@ -1,15 +1,8 @@
 {
   "name": "node-gtk",
-  "version": "0.8.1",
+  "version": "0.11.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",
-    "test": "mocha tests/__run__.js",
-    "build": "node-pre-gyp build",
-    "build:full": "node-pre-gyp rebuild",
-    "configure": "node-pre-gyp configure --debug"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/romgrk/node-gtk.git"
@@ -62,5 +55,12 @@
     "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/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

@@ -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,10 +91,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 +102,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 +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;

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