koffi 2.3.1 → 2.3.2

package/CHANGELOG.md

@@ -4,6 +4,19 @@
 
 ### Koffi 2.3
 
+#### Koffi 2.3.2
+
+**Main changes:**
+
+- Fix type parser issues (such as ignoring some [disposable qualifiers](calls.md#heap-allocated-values))
+- Fix crash when using disposable types in output parameters
+- Add basic [koffi.stats()](misc.md#usage-statistics) interface
+
+**Other changes:**
+
+- Avoid CNoke dependencies
+- Clear out development dependencies from package.json
+
 #### Koffi 2.3.1
 
 **Main changes:**

package/doc/misc.md

@@ -95,3 +95,9 @@ async_heap_size      | 512 kiB | Heap size for asynchronous calls
 resident_async_pools | 2       | Number of resident pools for asynchronous calls
 max_async_calls      | 64      | Maximum number of ongoing asynchronous calls
 max_type_size        | 64 MiB  | Maximum size of Koffi types (for arrays and structs)
+
+## Usage statistics
+
+*New in Koffi 2.3.2*
+
+You can use `koffi.stats()` to get a few statistics related to Koffi.

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "koffi",
-    "version": "2.3.1",
-    "stable": "2.3.1",
+    "version": "2.3.2",
+    "stable": "2.3.2",
     "description": "Fast and simple C FFI (foreign function interface) for Node.js",
     "keywords": [
         "foreign",
@@ -21,22 +21,9 @@
     "main": "src/koffi/src/index.js",
     "types": "src/koffi/src/index.d.ts",
     "scripts": {
-        "install": "cnoke --prebuild -d src/koffi"
+        "install": "./src/cnoke/cnoke.js --prebuild -d src/koffi"
     },
     "license": "LGPL-3.0",
-    "dependencies": {
-        "cnoke": "^3.2.2"
-    },
-    "devDependencies": {
-        "chalk": "^4.1.2",
-        "ffi-napi": "^4.0.3",
-        "minimatch": "^5.0.1",
-        "node-ssh": "^12.0.3",
-        "raylib": "^0.9.2",
-        "ref-napi": "^3.0.3",
-        "ref-struct-di": "^1.1.1",
-        "tar": "^6.1.11"
-    },
     "cnoke": {
         "prebuild": "src/koffi/build/{{version}}/koffi_{{platform}}_{{arch}}.tar.gz",
         "require": "./src/koffi/build/koffi.node",

package/src/cnoke/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/src/cnoke/README.md

@@ -0,0 +1,97 @@
+# Table of contents
+
+- [Introduction](#introduction)
+- [Get started](#get-started)
+- [Command usage](#command-usage)
+
+# Introduction
+
+CNoke is a simpler alternative to CMake.js, without any dependency, designed to build
+native Node addons based on CMake.
+
+Install it like this:
+
+```sh
+npm install cnoke
+```
+
+It obviously requires [CMake](http://www.cmake.org/download/) and a proper C/C++ toolchain:
+
+* Windows: Visual C++ Build Tools or a recent version of Visual C++ will do (the free Community version works well)
+* POSIX (Linux, macOS, etc.): Clang or GCC, and Make (Ninja is preferred if available)
+
+# Get started
+
+In order to build a native Node.js addon with CNoke, you can use the following CMakeLists.txt
+template to get started:
+
+```cmake
+cmake_minimum_required(VERSION 3.11)
+project(hello C CXX)
+
+find_package(CNoke)
+
+add_node_addon(NAME hello SOURCES hello.cc)
+```
+
+You can also do it manually (without the module) if you prefer:
+
+```cmake
+cmake_minimum_required(VERSION 3.11)
+project(hello C CXX)
+
+add_library(hello SHARED hello.cc ${NODE_JS_SOURCES})
+set_target_properties(hello PROPERTIES PREFIX "" SUFFIX ".node")
+target_include_directories(hello PRIVATE ${NODE_JS_INCLUDE_DIRS})
+target_link_libraries(hello PRIVATE ${NODE_JS_LIBRARIES})
+target_compile_options(hello PRIVATE ${NODE_JS_COMPILE_FLAGS})
+target_link_options(hello PRIVATE ${NODE_JS_LINK_FLAGS})
+```
+
+In order for this to run when `npm install` runs (directly or when someone else installs
+your dependency), add the following script to package.json:
+
+```json
+"scripts": {
+    "install": "cnoke"
+}
+```
+
+# Command usage
+
+You can find the same help text by running `cnoke --help`:
+
+```
+Usage: cnoke [command] [options...] [targets...]
+
+Commands:
+    configure                            Configure CMake build
+    build                                Build project (configure if needed)
+    clean                                Clean build files
+
+Options:
+    -d, --directory <DIR>                Change project directory
+                                         (default: current working directory)
+
+    -B, --config <CONFIG>                Change build type: RelWithDebInfo, Debug, Release
+                                         (default: RelWithDebInfo)
+    -D, --debug                          Shortcut for --config Debug
+
+        --prebuild <URL>                 Set URL template to download prebuilt binaries
+        --require <PATH>                 Require specified module, drop prebuild if it fails
+
+    -a, --arch <ARCH>                    Change architecture and ABI
+                                         (default: x64)
+    -v, --runtime-version <VERSION>      Change node version
+                                         (default: v16.14.0)
+    -t, --toolset <TOOLSET>              Change default CMake toolset
+    -C, --prefer-clang                   Use Clang instead of default CMake compiler
+
+        --verbose                        Show build commands while building
+```
+
+The ARCH value is similar to process.arch, with the following differences:
+
+- arm is changed to arm32hf or arm32sf depending on the floating-point ABI used (hard-float, soft-float)
+- riscv32 is changed to riscv32sf, riscv32hf32, riscv32hf64 or riscv32hf128 depending on the floating-point ABI
+- riscv64 is changed to riscv64sf, riscv64hf32, riscv64hf64 or riscv64hf128 depending on the floating-point ABI

package/src/cnoke/assets/FindCNoke.cmake

@@ -0,0 +1,71 @@
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
+
+if(CMAKE_BUILD_TYPE STREQUAL "Release" OR CMAKE_BUILD_TYPE STREQUAL "RelWithDebInfo" OR
+   CMAKE_BUILD_TYPE STREQUAL "MinSizeRel")
+    set(USE_UNITY_BUILDS ON CACHE BOOL "Use single-TU builds (aka. Unity builds)")
+else()
+    set(USE_UNITY_BUILDS OFF CACHE BOOL "Use single-TU builds (aka. Unity builds)")
+endif()
+
+function(add_node_addon)
+    cmake_parse_arguments(ARG "" "NAME" "SOURCES" ${ARGN})
+
+    add_library(${ARG_NAME} SHARED ${ARG_SOURCES} ${NODE_JS_SOURCES})
+    set_target_properties(${ARG_NAME} PROPERTIES PREFIX "" SUFFIX ".node")
+    target_include_directories(${ARG_NAME} PRIVATE ${NODE_JS_INCLUDE_DIRS})
+    target_link_libraries(${ARG_NAME} PRIVATE ${NODE_JS_LIBRARIES})
+    target_compile_options(${ARG_NAME} PRIVATE ${NODE_JS_COMPILE_FLAGS})
+    if (NODE_JS_LINK_FLAGS)
+        target_link_options(${ARG_NAME} PRIVATE ${NODE_JS_LINK_FLAGS})
+    endif()
+endfunction()
+
+if(USE_UNITY_BUILDS)
+    function(enable_unity_build TARGET)
+        get_target_property(sources ${TARGET} SOURCES)
+        string(GENEX_STRIP "${sources}" sources)
+
+        set(unity_file_c "${CMAKE_CURRENT_BINARY_DIR}/${TARGET}_unity.c")
+        set(unity_file_cpp "${CMAKE_CURRENT_BINARY_DIR}/${TARGET}_unity.cpp")
+        file(REMOVE ${unity_file_c} ${unity_file_cpp})
+
+        foreach(src ${sources})
+            get_source_file_property(language ${src} LANGUAGE)
+            if(IS_ABSOLUTE ${src})
+                set(src_full ${src})
+            else()
+                set(src_full "${CMAKE_CURRENT_SOURCE_DIR}/${src}")
+            endif()
+            if(language STREQUAL "C")
+                set_source_files_properties(${src} PROPERTIES HEADER_FILE_ONLY 1)
+                file(APPEND ${unity_file_c} "#include \"${src_full}\"\n")
+            elseif(language STREQUAL "CXX")
+                set_source_files_properties(${src} PROPERTIES HEADER_FILE_ONLY 1)
+                file(APPEND ${unity_file_cpp} "#include \"${src_full}\"\n")
+            endif()
+        endforeach()
+
+        if(EXISTS ${unity_file_c})
+            target_sources(${TARGET} PRIVATE ${unity_file_c})
+        endif()
+        if(EXISTS ${unity_file_cpp})
+            target_sources(${TARGET} PRIVATE ${unity_file_cpp})
+        endif()
+
+        target_compile_definitions(${TARGET} PRIVATE -DUNITY_BUILD=1)
+    endfunction()
+else()
+    function(enable_unity_build TARGET)
+    endfunction()
+endif()

package/src/cnoke/assets/win_delay_hook.c

@@ -0,0 +1,34 @@
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Lesser General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License
+// along with this program. If not, see https://www.gnu.org/licenses/.
+
+#include <stdlib.h>
+#ifndef NOMINMAX
+    #define NOMINMAX
+#endif
+#ifndef WIN32_LEAN_AND_MEAN
+    #define WIN32_LEAN_AND_MEAN
+#endif
+#include <windows.h>
+#include <delayimp.h>
+
+static FARPROC WINAPI self_exe_hook(unsigned int event, DelayLoadInfo *info)
+{
+    if (event == dliNotePreLoadLibrary && !stricmp(info->szDll, "node.exe")) {
+        HMODULE h = GetModuleHandle(NULL);
+        return (FARPROC)h;
+    }
+
+    return NULL;
+}
+
+const PfnDliHook __pfnDliNotifyHook2 = self_exe_hook;