koffi 0.9.4 → 0.9.5

package/CMakeLists.txt

@@ -1,60 +1,60 @@
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Affero 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 Affero General Public License for more details.
-#
-# You should have received a copy of the GNU Affero General Public License
-# along with this program. If not, see https://www.gnu.org/licenses/.
-
-cmake_minimum_required(VERSION 3.11)
-project(koffi C CXX ASM)
-
-set(CMAKE_CXX_STANDARD 17)
-if(MSVC)
-    enable_language(ASM_MASM)
-endif()
-
-set(KOFFI_SRC
-    src/call_arm64.cc
-    src/call_x64_sysv.cc
-    src/call_x64_win.cc
-    src/call_x86.cc
-    src/ffi.cc
-    src/util.cc
-    vendor/libcc/libcc.cc
-)
-if(CMAKE_SIZEOF_VOID_P EQUAL 8)
-    if(WIN32)
-        list(APPEND KOFFI_SRC src/call_x64_win_fwd.asm)
-    elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL aarch64)
-        list(APPEND KOFFI_SRC src/call_arm64_fwd.S)
-    else()
-        list(APPEND KOFFI_SRC src/call_x64_sysv_fwd.S)
-    endif()
-elseif(CMAKE_SIZEOF_VOID_P EQUAL 4)
-    if(WIN32)
-        list(APPEND KOFFI_SRC src/call_x86_fwd.asm)
-    elseif(CMAKE_SYSTEM_PROCESSOR MATCHES "i[3456]86|x86|AMD64")
-        list(APPEND KOFFI_SRC src/call_x86_fwd.S)
-    endif()
-endif()
-
-add_library(koffi SHARED ${KOFFI_SRC} ${CMAKE_JS_SRC})
-set_target_properties(koffi PROPERTIES PREFIX "" SUFFIX ".node")
-target_include_directories(koffi PRIVATE . ${CMAKE_JS_INC} vendor/node-addon-api)
-target_link_libraries(koffi PRIVATE ${CMAKE_JS_LIB})
-
-if(WIN32)
-    target_compile_definitions(koffi PRIVATE _CRT_SECURE_NO_WARNINGS _CRT_NONSTDC_NO_DEPRECATE)
-    target_link_libraries(koffi PRIVATE ws2_32)
-endif()
-if(MSVC)
-    target_compile_options(koffi PRIVATE /wd4200)
-else()
-    target_compile_options(koffi PRIVATE -Wno-missing-field-initializers)
-endif()
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see https://www.gnu.org/licenses/.
+
+cmake_minimum_required(VERSION 3.11)
+project(koffi C CXX ASM)
+
+set(CMAKE_CXX_STANDARD 17)
+if(MSVC)
+    enable_language(ASM_MASM)
+endif()
+
+set(KOFFI_SRC
+    src/call_arm64.cc
+    src/call_x64_sysv.cc
+    src/call_x64_win.cc
+    src/call_x86.cc
+    src/ffi.cc
+    src/util.cc
+    vendor/libcc/libcc.cc
+)
+if(CMAKE_SIZEOF_VOID_P EQUAL 8)
+    if(WIN32)
+        list(APPEND KOFFI_SRC src/call_x64_win_fwd.asm)
+    elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL aarch64)
+        list(APPEND KOFFI_SRC src/call_arm64_fwd.S)
+    else()
+        list(APPEND KOFFI_SRC src/call_x64_sysv_fwd.S)
+    endif()
+elseif(CMAKE_SIZEOF_VOID_P EQUAL 4)
+    if(WIN32)
+        list(APPEND KOFFI_SRC src/call_x86_fwd.asm)
+    elseif(CMAKE_SYSTEM_PROCESSOR MATCHES "i[3456]86|x86|AMD64")
+        list(APPEND KOFFI_SRC src/call_x86_fwd.S)
+    endif()
+endif()
+
+add_library(koffi SHARED ${KOFFI_SRC} ${CMAKE_JS_SRC})
+set_target_properties(koffi PROPERTIES PREFIX "" SUFFIX ".node")
+target_include_directories(koffi PRIVATE . ${CMAKE_JS_INC} vendor/node-addon-api)
+target_link_libraries(koffi PRIVATE ${CMAKE_JS_LIB})
+
+if(WIN32)
+    target_compile_definitions(koffi PRIVATE _CRT_SECURE_NO_WARNINGS _CRT_NONSTDC_NO_DEPRECATE)
+    target_link_libraries(koffi PRIVATE ws2_32)
+endif()
+if(MSVC)
+    target_compile_options(koffi PRIVATE /wd4200)
+else()
+    target_compile_options(koffi PRIVATE -Wno-missing-field-initializers)
+endif()

package/README.md

@@ -1,153 +1,163 @@
-# Introduction
-
-koffi is a fast and easy-to-use FFI module for Node.js, with support for complex data types such as structs.
-
-The following platforms are supported at the moment:
-* Windows x86 *(cdecl, stdcall)*
-* Windows x86_64
-* Linux x86
-* Linux x86_64
-* Linux AArch64
-
-This is still in development, more platforms and more tests will come in the near future.
-
-# Installation
-
-## Windows
-
-First, make sure the following dependencies are met:
-
-* The "Desktop development with C++" workload from [Visual Studio 2022 or 2019](https://visualstudio.microsoft.com/downloads/) or the "C++ build tools" workload from the [Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022), with the default optional components.
-* [CMake meta build system](https://cmake.org/)
-* [Node 16 LTS](https://nodejs.org/), but a newer version should work too
-
-Once this is done, run this command from the project root:
-
-```sh
-npm install
-```
-
-## Other platforms (Linux, macOS, etc.)
-
-Make sure the following dependencies are met:
-
-* `gcc` and `g++` >= 8.3 or newer
-* GNU Make 3.81 or newer
-* [CMake meta build system](https://cmake.org/)
-
-Once these dependencies are met, simply run the follow command:
-
-```sh
-npm install
-```
-
-# How to use
-
-This section assumes you know how to build C shared libraries.
-
-This examples illustrates how to use koffi with a Raylib shared library:
-
-```js
-const koffi = require('koffi/build/Release/koffi.node');
-
-const Color = koffi.struct('Color', {
-    r: 'uchar',
-    g: 'uchar',
-    b: 'uchar',
-    a: 'uchar'
-});
-
-const Image = koffi.struct('Image', {
-    data: koffi.pointer('void'),
-    width: 'int',
-    height: 'int',
-    mipmaps: 'int',
-    format: 'int'
-});
-
-const GlyphInfo = koffi.struct('GlyphInfo', {
-    value: 'int',
-    offsetX: 'int',
-    offsetY: 'int',
-    advanceX: 'int',
-    image: Image
-});
-
-const Vector2 = koffi.struct('Vector2', {
-    x: 'float',
-    y: 'float'
-});
-
-const Rectangle = koffi.struct('Rectangle', {
-    x: 'float',
-    y: 'float',
-    width: 'float',
-    height: 'float'
-});
-
-const Texture = koffi.struct('Texture', {
-    id: 'uint',
-    width: 'int',
-    height: 'int',
-    mipmaps: 'int',
-    format: 'int'
-});
-
-const Font = koffi.struct('Font', {
-    baseSize: 'int',
-    glyphCount: 'int',
-    glyphPadding: 'int',
-    texture: Texture,
-    recs: koffi.pointer(Rectangle),
-    glyphs: koffi.pointer(GlyphInfo)
-});
-
-// Fix the path to Raylib DLL
-let raylib = koffi.load('Raylib.dll', {
-    InitWindow: ['void', ['int', 'int', 'string']],
-    SetTargetFPS: ['void', ['int']],
-    GetScreenWidth: ['int', []],
-    GetScreenHeight: ['int', []],
-    ClearBackground: ['void', [Color]],
-    BeginDrawing: ['void', []],
-    EndDrawing: ['void', []],
-    WindowShouldClose: ['bool', []],
-    GetFontDefault: [Font, []],
-    MeasureTextEx: [Vector2, [Font, 'string', 'float', 'float']],
-    DrawTextEx: ['void', [Font, 'string', Vector2, 'float', 'float', Color]]
-});
-
-raylib.InitWindow(800, 600, 'Test Raylib');
-raylib.SetTargetFPS(60);
-
-let angle = 0;
-
-while (!raylib.WindowShouldClose()) {
-    raylib.BeginDrawing();
-    raylib.ClearBackground({ r: 0, g: 0, b: 0, a: 255 }); // black
-
-    let win_width = raylib.GetScreenWidth();
-    let win_height = raylib.GetScreenHeight();
-
-    let text = 'Hello World!';
-    let text_width = raylib.MeasureTextEx(raylib.GetFontDefault(), text, 32, 1).x;
-
-    let color = {
-        r: 127.5 + 127.5 * Math.sin(angle),
-        g: 127.5 + 127.5 * Math.sin(angle + Math.PI / 2),
-        b: 127.5 + 127.5 * Math.sin(angle + Math.PI),
-        a: 255
-    };
-    let pos = {
-        x: (win_width / 2 - text_width / 2) + 120 * Math.cos(angle - Math.PI / 2),
-        y: (win_height / 2 - 16) + 120 * Math.sin(angle - Math.PI / 2)
-    };
-
-    raylib.DrawTextEx(raylib.GetFontDefault(), text, pos, 32, 1, color);
-
-    raylib.EndDrawing();
-
-    angle += Math.PI / 180;
-}
-
-```
+# Introduction
+
+koffi is a fast and easy-to-use FFI module for Node.js, with support for complex data types such as structs.
+
+The following platforms __are supported__ at the moment:
+
+* Windows x86 *(cdecl, stdcall)*
+* Windows x86_64
+* Linux x86
+* Linux x86_64
+* Linux ARM64 *(Raspberry Pi OS 64-bit)*
+
+The following platforms are __not yet supported__ but will be soon:
+
+* macOS x86_64
+* macOS ARM64
+* FreeBSD/NetBSD/OpenBSD x86_64
+* FreeBSD/NetBSD/OpenBSD ARM64
+
+Support for ARM32 is not planned, though I don't mind working on it if there is enough demand.
+
+This is still in development, more tests will come in the near future.
+
+# Installation
+
+## Windows
+
+First, make sure the following dependencies are met:
+
+* The "Desktop development with C++" workload from [Visual Studio 2022 or 2019](https://visualstudio.microsoft.com/downloads/) or the "C++ build tools" workload from the [Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022), with the default optional components.
+* [CMake meta build system](https://cmake.org/)
+* [Node 16 LTS](https://nodejs.org/), but a newer version should work too
+
+Once this is done, run this command from the project root:
+
+```sh
+npm install koffi
+```
+
+## Other platforms (Linux, macOS, etc.)
+
+Make sure the following dependencies are met:
+
+* `gcc` and `g++` >= 8.3 or newer
+* GNU Make 3.81 or newer
+* [CMake meta build system](https://cmake.org/)
+
+Once these dependencies are met, simply run the follow command:
+
+```sh
+npm install koffi
+```
+
+# How to use
+
+This section assumes you know how to build C shared libraries.
+
+This examples illustrates how to use koffi with a Raylib shared library:
+
+```js
+const koffi = require('koffi/build/Release/koffi.node');
+
+const Color = koffi.struct('Color', {
+    r: 'uchar',
+    g: 'uchar',
+    b: 'uchar',
+    a: 'uchar'
+});
+
+const Image = koffi.struct('Image', {
+    data: koffi.pointer('void'),
+    width: 'int',
+    height: 'int',
+    mipmaps: 'int',
+    format: 'int'
+});
+
+const GlyphInfo = koffi.struct('GlyphInfo', {
+    value: 'int',
+    offsetX: 'int',
+    offsetY: 'int',
+    advanceX: 'int',
+    image: Image
+});
+
+const Vector2 = koffi.struct('Vector2', {
+    x: 'float',
+    y: 'float'
+});
+
+const Rectangle = koffi.struct('Rectangle', {
+    x: 'float',
+    y: 'float',
+    width: 'float',
+    height: 'float'
+});
+
+const Texture = koffi.struct('Texture', {
+    id: 'uint',
+    width: 'int',
+    height: 'int',
+    mipmaps: 'int',
+    format: 'int'
+});
+
+const Font = koffi.struct('Font', {
+    baseSize: 'int',
+    glyphCount: 'int',
+    glyphPadding: 'int',
+    texture: Texture,
+    recs: koffi.pointer(Rectangle),
+    glyphs: koffi.pointer(GlyphInfo)
+});
+
+// Fix the path to Raylib DLL
+let raylib = koffi.load('Raylib.dll', {
+    InitWindow: ['void', ['int', 'int', 'string']],
+    SetTargetFPS: ['void', ['int']],
+    GetScreenWidth: ['int', []],
+    GetScreenHeight: ['int', []],
+    ClearBackground: ['void', [Color]],
+    BeginDrawing: ['void', []],
+    EndDrawing: ['void', []],
+    WindowShouldClose: ['bool', []],
+    GetFontDefault: [Font, []],
+    MeasureTextEx: [Vector2, [Font, 'string', 'float', 'float']],
+    DrawTextEx: ['void', [Font, 'string', Vector2, 'float', 'float', Color]]
+});
+
+raylib.InitWindow(800, 600, 'Test Raylib');
+raylib.SetTargetFPS(60);
+
+let angle = 0;
+
+while (!raylib.WindowShouldClose()) {
+    raylib.BeginDrawing();
+    raylib.ClearBackground({ r: 0, g: 0, b: 0, a: 255 }); // black
+
+    let win_width = raylib.GetScreenWidth();
+    let win_height = raylib.GetScreenHeight();
+
+    let text = 'Hello World!';
+    let text_width = raylib.MeasureTextEx(raylib.GetFontDefault(), text, 32, 1).x;
+
+    let color = {
+        r: 127.5 + 127.5 * Math.sin(angle),
+        g: 127.5 + 127.5 * Math.sin(angle + Math.PI / 2),
+        b: 127.5 + 127.5 * Math.sin(angle + Math.PI),
+        a: 255
+    };
+    let pos = {
+        x: (win_width / 2 - text_width / 2) + 120 * Math.cos(angle - Math.PI / 2),
+        y: (win_height / 2 - 16) + 120 * Math.sin(angle - Math.PI / 2)
+    };
+
+    raylib.DrawTextEx(raylib.GetFontDefault(), text, pos, 32, 1, color);
+
+    raylib.EndDrawing();
+
+    angle += Math.PI / 180;
+}
+
+```

package/package.json

@@ -1,18 +1,19 @@
-{
-  "name": "koffi",
-  "version": "0.9.4",
-  "description": "Fast and simple FFI (foreign function interface) for Node.js",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Koromix/luigi.git"
-  },
-  "author": "Niels Martignène <niels.martignene@protonmail.com>",
-  "main": "build/Release/koffi.node",
-  "scripts": {
-    "install": "cmake-js"
-  },
-  "license": "AGPL-3.0",
-  "dependencies": {
-    "cmake-js": "^6.3.0"
-  }
-}
+{
+  "name": "koffi",
+  "version": "0.9.5",
+  "description": "Fast and simple FFI (foreign function interface) for Node.js",
+  "keywords": ["foreign", "function", "interface", "ffi", "binding", "c", "napi"],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Koromix/luigi.git"
+  },
+  "author": "Niels Martignène <niels.martignene@protonmail.com>",
+  "main": "build/Release/koffi.node",
+  "scripts": {
+    "install": "cmake-js"
+  },
+  "license": "AGPL-3.0",
+  "dependencies": {
+    "cmake-js": "^6.3.0"
+  }
+}

package/src/call.hh

@@ -1,27 +1,27 @@
-// This program is free software: you can redistribute it and/or modify
-// it under the terms of the GNU Affero 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 Affero General Public License for more details.
-//
-// You should have received a copy of the GNU Affero General Public License
-// along with this program. If not, see https://www.gnu.org/licenses/.
-
-#pragma once
-
-#include "vendor/libcc/libcc.hh"
-
-#include <napi.h>
-
-namespace RG {
-
-struct FunctionInfo;
-
-bool AnalyseFunction(FunctionInfo *func);
-Napi::Value TranslateCall(const Napi::CallbackInfo &info);
-
-}
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero 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 Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see https://www.gnu.org/licenses/.
+
+#pragma once
+
+#include "vendor/libcc/libcc.hh"
+
+#include <napi.h>
+
+namespace RG {
+
+struct FunctionInfo;
+
+bool AnalyseFunction(FunctionInfo *func);
+Napi::Value TranslateCall(const Napi::CallbackInfo &info);
+
+}