koffi 2.9.1 → 2.10.0

package/src/koffi/examples/yao-pkg/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "KoffiConfig",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "start": "node index.js",
+    "bundle": "pkg ."
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "koffi": "^2.5.18"
+  },
+  "devDependencies": {
+    "@yao-pkg/pkg": "^6.1.1"
+  },
+  "bin": "index.js",
+  "pkg": {
+    "outputPath": "dist"
+  }
+}

package/src/koffi/src/call.cc

@@ -321,6 +321,7 @@ Size CallData::PushString16Value(Napi::Value value, const char16_t **out_str16)
     size_t len = 0;
     napi_status status;
 
+    mem->heap.ptr = AlignUp(mem->heap.ptr, 2);
     buf.ptr = (char16_t *)mem->heap.ptr;
     buf.len = std::max((Size)0, mem->heap.len - Kibibytes(32)) / 2;
 
@@ -426,6 +427,7 @@ Size CallData::PushString32Value(Napi::Value value, const char32_t **out_str32)
     if (buf16.len < 0) [[unlikely]]
         return -1;
 
+    mem->heap.ptr = AlignUp(mem->heap.ptr, 4);
     buf.ptr = (char32_t *)mem->heap.ptr;
     buf.len = std::max((Size)0, mem->heap.len - Kibibytes(32)) / 4;
 

package/src/koffi/src/ffi.cc

@@ -244,8 +244,9 @@ static Napi::Value CreateStructType(const Napi::CallbackInfo &info, bool pad)
     }
 
     bool named = info.Length() > 1;
+    bool redefine = named && CheckValueTag(instance, info[0], &TypeInfoMarker);
 
-    if (named && !info[0].IsString()) {
+    if (named && !info[0].IsString() && !redefine) {
         ThrowError<Napi::TypeError>(env, "Unexpected %1 value for name, expected string", GetValueType(instance, info[0]));
         return env.Null();
     }
@@ -274,8 +275,20 @@ static Napi::Value CreateStructType(const Napi::CallbackInfo &info, bool pad)
     };
 
     TypeInfo *type = instance->types.AppendDefault();
+    TypeInfo *replace = nullptr;
 
-    if (named) {
+    if (redefine) {
+        Napi::External<TypeInfo> external = name.As<Napi::External<TypeInfo>>();
+        const TypeInfo *raw = external.Data();
+
+        replace = (TypeInfo *)AlignDown(raw, 4);
+        type->name = replace->name;
+
+        if (replace->primitive != PrimitiveKind::Void || replace == instance->void_type) {
+            ThrowError<Napi::TypeError>(env, "Cannot redefine non-opaque type %1", replace->name);
+            return env.Null();
+        }
+    } else if (named) {
         type->name = DuplicateString(name.Utf8Value().c_str(), &instance->str_alloc).ptr;
 
         if (!MapType(env, instance, type, type->name))
@@ -366,6 +379,11 @@ static Napi::Value CreateStructType(const Napi::CallbackInfo &info, bool pad)
     type->flags &= ~(int)TypeFlag::IsIncomplete;
     err_guard.Disable();
 
+    if (replace) {
+        std::swap(*type, *replace);
+        type = replace;
+    }
+
     return WrapType(env, instance, type);
 }
 
@@ -390,8 +408,9 @@ static Napi::Value CreateUnionType(const Napi::CallbackInfo &info)
     }
 
     bool named = info.Length() > 1;
+    bool redefine = named && CheckValueTag(instance, info[0], &TypeInfoMarker);
 
-    if (named && !info[0].IsString()) {
+    if (named && !info[0].IsString() && !redefine) {
         ThrowError<Napi::TypeError>(env, "Unexpected %1 value for name, expected string", GetValueType(instance, info[0]));
         return env.Null();
     }
@@ -420,8 +439,20 @@ static Napi::Value CreateUnionType(const Napi::CallbackInfo &info)
     };
 
     TypeInfo *type = instance->types.AppendDefault();
+    TypeInfo *replace = nullptr;
 
-    if (named) {
+    if (redefine) {
+        Napi::External<TypeInfo> external = name.As<Napi::External<TypeInfo>>();
+        const TypeInfo *raw = external.Data();
+
+        replace = (TypeInfo *)AlignDown(raw, 4);
+        type->name = replace->name;
+
+        if (replace->primitive != PrimitiveKind::Void || replace == instance->void_type) {
+            ThrowError<Napi::TypeError>(env, "Cannot redefine non-opaque type %1", replace->name);
+            return env.Null();
+        }
+    } else if (named) {
         type->name = DuplicateString(name.Utf8Value().c_str(), &instance->str_alloc).ptr;
 
         if (!MapType(env, instance, type, type->name))
@@ -507,6 +538,11 @@ static Napi::Value CreateUnionType(const Napi::CallbackInfo &info)
     Napi::Function constructor = MagicUnion::InitClass(env, type);
     type->construct.Reset(constructor, 1);
 
+    if (replace) {
+        std::swap(*type, *replace);
+        type = replace;
+    }
+
     return WrapType(env, instance, type);
 }
 

package/src/koffi/src/util.cc

@@ -146,8 +146,8 @@ const TypeInfo *ResolveType(Napi::Value value, int *out_directions)
         return type;
     } else if (CheckValueTag(instance, value, &TypeInfoMarker)) {
         Napi::External<TypeInfo> external = value.As<Napi::External<TypeInfo>>();
-
         const TypeInfo *raw = external.Data();
+
         const TypeInfo *type = AlignDown(raw, 4);
         RG_ASSERT(type);
 

package/doc/Makefile

@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = dist
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

package/doc/changelog.md

@@ -1,5 +0,0 @@
----
-tocdepth: 3
----
-
-{{ "```{include} " ~ root ~ "/CHANGELOG.md" ~ "\n```" }}

package/doc/conf.py

@@ -1,118 +0,0 @@
-import json
-import os
-
-# -- Project information -----------------------------------------------------
-
-project = 'Koffi'
-copyright = '2022, Niels Martignène'
-author = 'Niels Martignène'
-
-root = None
-version = None
-revision = None
-stable = None
-
-names = ['../../src/koffi/package.json', '../package.json']
-
-for name in names:
-    filename = os.path.dirname(__file__) + '/' + name
-
-    if not os.path.exists(filename):
-        continue;
-
-    with open(filename) as f:
-        config = json.load(f)
-
-        root = os.path.dirname(name)
-        version = config['version']
-        revision = config['version']
-        stable = config['stable']
-
-    break
-
-if root is None:
-    raise FileNotFoundError('Cannot find Koffi package.json')
-
-# -- General configuration ---------------------------------------------------
-
-extensions = [
-    'myst_parser',
-    'sphinx.ext.autosectionlabel',
-    'sphinxext.rediraffe'
-]
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['templates']
-
-exclude_patterns = []
-
-# -- Options for HTML output -------------------------------------------------
-
-html_title = project
-
-html_theme = 'furo'
-
-html_static_path = ['static']
-
-html_theme_options = {
-    'light_css_variables': {
-        'font-stack': 'Open Sans',
-        'color-content-foreground': '#383838',
-        'color-brand-primary': '#383838',
-        'color-brand-content': '#e97713'
-    },
-    'dark_css_variables': {
-        'font-stack': 'Open Sans',
-        'color-content-foreground': '#ffffffdd',
-        'color-brand-primary': '#ffffffdd',
-        'color-brand-content': '#e97713'
-    }
-}
-
-html_link_suffix = ''
-
-html_css_files = [
-    'opensans/OpenSans.css',
-    'custom.css'
-]
-
-html_sidebars = {
-    "**": [
-        "logo.html",
-        "sidebar/search.html",
-        "sidebar/scroll-start.html",
-        "sidebar/navigation.html",
-        "sidebar/ethical-ads.html",
-        "badges.html",
-        "sidebar/scroll-end.html",
-        "sidebar/variant-selector.html"
-    ]
-}
-
-html_context = {
-    "root": root,
-    "stable": stable
-}
-
-# -- MyST parser options -------------------------------------------------
-
-myst_enable_extensions = [
-    'linkify',
-    'substitution'
-]
-
-myst_substitutions = html_context
-
-myst_heading_anchors = 3
-
-myst_linkify_fuzzy_links = False
-
-myst_number_code_blocks = ['c', 'js', 'sh', 'batch']
-
-# -- Redirections -------------------------------------------------
-
-rediraffe_redirects = {
-    "changes.md": "changelog.md",
-    "bundling.md": "packaging.md",
-    "parameters.md": "input.md"
-}

package/doc/index.rst

@@ -1,47 +0,0 @@
-Koffi
-=====
-
-Overview
---------
-
-Koffi is a **fast and easy-to-use C FFI module for Node.js**, featuring:
-
-* Low-overhead and fast performance (see :ref:`benchmarks<Benchmarks>`)
-* Support for primitive and aggregate data types (structs and fixed-size arrays), both by reference (pointer) and by value
-* Javascript functions can be used as C callbacks (since 1.2.0)
-* Well-tested code base for :ref:`popular OS/architecture combinations<Supported platforms>`
-
-Koffi requires a recent `Node.js <https://nodejs.org/>`_ version with N-API version 8 support, see :ref:`this page<Node.js>` for more information.
-
-The source code is available here: https://github.com/Koromix/rygel/ (in the *src/koffi* subdirectory).
-
-New releases are frequent, look at the :ref:`changelog<changelog>` for more information.
-
-Table of contents
------------------
-
-.. toctree::
-   :maxdepth: 3
-
-   platforms
-   start
-   functions
-   input
-   pointers
-   output
-   unions
-   variables
-   callbacks
-   misc
-   packaging
-   benchmarks
-   contribute
-   changelog
-   migration
-
-License
--------
-
-This program is free software: you can redistribute it and/or modify it under the terms of the **MIT License**.
-
-Find more information here: https://choosealicense.com/licenses/mit/

package/doc/make.bat

@@ -1,35 +0,0 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=.
-set BUILDDIR=dist
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.https://www.sphinx-doc.org/
-	exit /b 1
-)
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd