koffi 1.3.1 → 1.3.2

package/CMakeLists.txt

@@ -11,12 +11,16 @@
 # 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.12)
+cmake_minimum_required(VERSION 3.6)
 project(koffi C CXX ASM)
 
 find_package(CNoke)
 
-set(CMAKE_CXX_STANDARD 17)
+if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.8.0")
+    set(CMAKE_CXX_STANDARD 17)
+else()
+    set(CMAKE_CXX_STANDARD 14)
+endif()
 if(MSVC)
     add_compile_options(/W4 /wd4200 /wd4458 /wd4706 /wd4100 /wd4127 /wd4702 /wd4201 /wd4324)
 

package/ChangeLog.md

@@ -0,0 +1,65 @@
+# Koffi 1.3.2
+
+## Main fixes
+
+- Support compilation in C++14 mode (graceful degradation)
+- Support older toolchains on Linux (tested on Debian 9)
+
+# Koffi 1.3.1
+
+## Main fixes
+
+- The prebuilt binary is tested when Koffi is installed, and a rebuild happens if it fails to load
+
+# Koffi 1.3.0
+
+## Major changes
+
+- Expand and move documentation to https://koffi.dev/
+- Support JS arrays and TypedArrays for pointer arguments (input, output and mixed)
+
+## Other changes
+
+- Convert NULL string pointers to null instead of crashing (return values, struct and array members, callbacks)
+- Default to 'string' array hint for char, char16 and char16_t arrays
+- Fix definition of long types on Windows x64 (LLP64 model)
+- Restrict automatic string conversion to signed char types
+- Detect floating-point ABI before using prebuilt binaries (ARM32, RISC-V)
+- Forbid duplicate member names in struct types
+
+# Koffi 1.2.4
+
+## New features
+
+- Windows ARM64 is now supported
+
+# Koffi 1.2.3
+
+## New features
+
+- A prebuilt binary for macOS ARM64 (M1) is now included
+
+# Koffi 1.2.1
+
+This entry documents changes since version 1.1.0.
+
+## New features
+
+- JS functions can be used as C callbacks (cdecl, stdcall) on all platforms
+- RISC-V 64 LP64D ABI is supported (LP64 is untested)
+- Expose settings for memory usage of synchronous and asynchronous calls
+- Transparent conversion between C buffers and strings
+- Tentative support for Windows ARM64 (untested)
+
+## Main fixes
+
+- Fix excessive stack alignment of structs on x86 platforms
+- Fix potential problems with big int64_t/uint64_t values
+- Fix possible struct layout errors in push/pop code
+- Fix alignment issues in ARM32 push code
+- Fix incomplete/buggy support for HFA structs on ARM32 and ARM64
+- Fix crashes on OpenBSD caused by missing MAP_STACK flag
+- Fix non-sense "duplicate array type" errors
+- Fix value `koffi.internal` to false in module (normal) builds
+- Make sure we have a redzone below the stack for all architectures
+- Use slower allocation for big objects instead of failing

package/doc/conf.py

@@ -3,8 +3,8 @@
 project = 'Koffi'
 copyright = '2022, Niels Martignène'
 author = 'Niels Martignène'
-version = '1.3.1'
-revision = '1.3.1'
+version = '1.3.2'
+revision = '1.3.2'
 
 # -- General configuration ---------------------------------------------------
 

package/doc/dist/html/_static/pygments.css

@@ -88,21 +88,21 @@ body[data-theme="dark"] .highlight td.linenos .special { color: #000000; backgro
 body[data-theme="dark"] .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 body[data-theme="dark"] .highlight .hll { background-color: #404040 }
 body[data-theme="dark"] .highlight { background: #202020; color: #d0d0d0 }
-body[data-theme="dark"] .highlight .c { color: #ababab; font-style: italic } /* Comment */
+body[data-theme="dark"] .highlight .c { color: #999999; font-style: italic } /* Comment */
 body[data-theme="dark"] .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
 body[data-theme="dark"] .highlight .esc { color: #d0d0d0 } /* Escape */
 body[data-theme="dark"] .highlight .g { color: #d0d0d0 } /* Generic */
-body[data-theme="dark"] .highlight .k { color: #6ebf26; font-weight: bold } /* Keyword */
+body[data-theme="dark"] .highlight .k { color: #6ab825; font-weight: bold } /* Keyword */
 body[data-theme="dark"] .highlight .l { color: #d0d0d0 } /* Literal */
 body[data-theme="dark"] .highlight .n { color: #d0d0d0 } /* Name */
 body[data-theme="dark"] .highlight .o { color: #d0d0d0 } /* Operator */
 body[data-theme="dark"] .highlight .x { color: #d0d0d0 } /* Other */
 body[data-theme="dark"] .highlight .p { color: #d0d0d0 } /* Punctuation */
-body[data-theme="dark"] .highlight .ch { color: #ababab; font-style: italic } /* Comment.Hashbang */
-body[data-theme="dark"] .highlight .cm { color: #ababab; font-style: italic } /* Comment.Multiline */
+body[data-theme="dark"] .highlight .ch { color: #999999; font-style: italic } /* Comment.Hashbang */
+body[data-theme="dark"] .highlight .cm { color: #999999; font-style: italic } /* Comment.Multiline */
 body[data-theme="dark"] .highlight .cp { color: #cd2828; font-weight: bold } /* Comment.Preproc */
-body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */
-body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */
+body[data-theme="dark"] .highlight .cpf { color: #999999; font-style: italic } /* Comment.PreprocFile */
+body[data-theme="dark"] .highlight .c1 { color: #999999; font-style: italic } /* Comment.Single */
 body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */
 body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */
 body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */
@@ -114,36 +114,36 @@ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */
 body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */
 body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */
 body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */
-body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */
-body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */
-body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */
-body[data-theme="dark"] .highlight .kp { color: #6ebf26 } /* Keyword.Pseudo */
-body[data-theme="dark"] .highlight .kr { color: #6ebf26; font-weight: bold } /* Keyword.Reserved */
-body[data-theme="dark"] .highlight .kt { color: #6ebf26; font-weight: bold } /* Keyword.Type */
+body[data-theme="dark"] .highlight .kc { color: #6ab825; font-weight: bold } /* Keyword.Constant */
+body[data-theme="dark"] .highlight .kd { color: #6ab825; font-weight: bold } /* Keyword.Declaration */
+body[data-theme="dark"] .highlight .kn { color: #6ab825; font-weight: bold } /* Keyword.Namespace */
+body[data-theme="dark"] .highlight .kp { color: #6ab825 } /* Keyword.Pseudo */
+body[data-theme="dark"] .highlight .kr { color: #6ab825; font-weight: bold } /* Keyword.Reserved */
+body[data-theme="dark"] .highlight .kt { color: #6ab825; font-weight: bold } /* Keyword.Type */
 body[data-theme="dark"] .highlight .ld { color: #d0d0d0 } /* Literal.Date */
-body[data-theme="dark"] .highlight .m { color: #51b2fd } /* Literal.Number */
+body[data-theme="dark"] .highlight .m { color: #3677a9 } /* Literal.Number */
 body[data-theme="dark"] .highlight .s { color: #ed9d13 } /* Literal.String */
 body[data-theme="dark"] .highlight .na { color: #bbbbbb } /* Name.Attribute */
-body[data-theme="dark"] .highlight .nb { color: #2fbccd } /* Name.Builtin */
-body[data-theme="dark"] .highlight .nc { color: #71adff; text-decoration: underline } /* Name.Class */
+body[data-theme="dark"] .highlight .nb { color: #24909d } /* Name.Builtin */
+body[data-theme="dark"] .highlight .nc { color: #447fcf; text-decoration: underline } /* Name.Class */
 body[data-theme="dark"] .highlight .no { color: #40ffff } /* Name.Constant */
 body[data-theme="dark"] .highlight .nd { color: #ffa500 } /* Name.Decorator */
 body[data-theme="dark"] .highlight .ni { color: #d0d0d0 } /* Name.Entity */
 body[data-theme="dark"] .highlight .ne { color: #bbbbbb } /* Name.Exception */
-body[data-theme="dark"] .highlight .nf { color: #71adff } /* Name.Function */
+body[data-theme="dark"] .highlight .nf { color: #447fcf } /* Name.Function */
 body[data-theme="dark"] .highlight .nl { color: #d0d0d0 } /* Name.Label */
-body[data-theme="dark"] .highlight .nn { color: #71adff; text-decoration: underline } /* Name.Namespace */
+body[data-theme="dark"] .highlight .nn { color: #447fcf; text-decoration: underline } /* Name.Namespace */
 body[data-theme="dark"] .highlight .nx { color: #d0d0d0 } /* Name.Other */
 body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */
-body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */
+body[data-theme="dark"] .highlight .nt { color: #6ab825; font-weight: bold } /* Name.Tag */
 body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */
-body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */
+body[data-theme="dark"] .highlight .ow { color: #6ab825; font-weight: bold } /* Operator.Word */
 body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */
-body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */
-body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */
-body[data-theme="dark"] .highlight .mh { color: #51b2fd } /* Literal.Number.Hex */
-body[data-theme="dark"] .highlight .mi { color: #51b2fd } /* Literal.Number.Integer */
-body[data-theme="dark"] .highlight .mo { color: #51b2fd } /* Literal.Number.Oct */
+body[data-theme="dark"] .highlight .mb { color: #3677a9 } /* Literal.Number.Bin */
+body[data-theme="dark"] .highlight .mf { color: #3677a9 } /* Literal.Number.Float */
+body[data-theme="dark"] .highlight .mh { color: #3677a9 } /* Literal.Number.Hex */
+body[data-theme="dark"] .highlight .mi { color: #3677a9 } /* Literal.Number.Integer */
+body[data-theme="dark"] .highlight .mo { color: #3677a9 } /* Literal.Number.Oct */
 body[data-theme="dark"] .highlight .sa { color: #ed9d13 } /* Literal.String.Affix */
 body[data-theme="dark"] .highlight .sb { color: #ed9d13 } /* Literal.String.Backtick */
 body[data-theme="dark"] .highlight .sc { color: #ed9d13 } /* Literal.String.Char */
@@ -157,13 +157,13 @@ body[data-theme="dark"] .highlight .sx { color: #ffa500 } /* Literal.String.Othe
 body[data-theme="dark"] .highlight .sr { color: #ed9d13 } /* Literal.String.Regex */
 body[data-theme="dark"] .highlight .s1 { color: #ed9d13 } /* Literal.String.Single */
 body[data-theme="dark"] .highlight .ss { color: #ed9d13 } /* Literal.String.Symbol */
-body[data-theme="dark"] .highlight .bp { color: #2fbccd } /* Name.Builtin.Pseudo */
-body[data-theme="dark"] .highlight .fm { color: #71adff } /* Name.Function.Magic */
+body[data-theme="dark"] .highlight .bp { color: #24909d } /* Name.Builtin.Pseudo */
+body[data-theme="dark"] .highlight .fm { color: #447fcf } /* Name.Function.Magic */
 body[data-theme="dark"] .highlight .vc { color: #40ffff } /* Name.Variable.Class */
 body[data-theme="dark"] .highlight .vg { color: #40ffff } /* Name.Variable.Global */
 body[data-theme="dark"] .highlight .vi { color: #40ffff } /* Name.Variable.Instance */
 body[data-theme="dark"] .highlight .vm { color: #40ffff } /* Name.Variable.Magic */
-body[data-theme="dark"] .highlight .il { color: #51b2fd } /* Literal.Number.Integer.Long */
+body[data-theme="dark"] .highlight .il { color: #3677a9 } /* Literal.Number.Integer.Long */
 @media (prefers-color-scheme: dark) {
 body:not([data-theme="light"]) .highlight pre { line-height: 125%; }
 body:not([data-theme="light"]) .highlight td.linenos .normal { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; }
@@ -172,21 +172,21 @@ body:not([data-theme="light"]) .highlight td.linenos .special { color: #000000;
 body:not([data-theme="light"]) .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 body:not([data-theme="light"]) .highlight .hll { background-color: #404040 }
 body:not([data-theme="light"]) .highlight { background: #202020; color: #d0d0d0 }
-body:not([data-theme="light"]) .highlight .c { color: #ababab; font-style: italic } /* Comment */
+body:not([data-theme="light"]) .highlight .c { color: #999999; font-style: italic } /* Comment */
 body:not([data-theme="light"]) .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
 body:not([data-theme="light"]) .highlight .esc { color: #d0d0d0 } /* Escape */
 body:not([data-theme="light"]) .highlight .g { color: #d0d0d0 } /* Generic */
-body:not([data-theme="light"]) .highlight .k { color: #6ebf26; font-weight: bold } /* Keyword */
+body:not([data-theme="light"]) .highlight .k { color: #6ab825; font-weight: bold } /* Keyword */
 body:not([data-theme="light"]) .highlight .l { color: #d0d0d0 } /* Literal */
 body:not([data-theme="light"]) .highlight .n { color: #d0d0d0 } /* Name */
 body:not([data-theme="light"]) .highlight .o { color: #d0d0d0 } /* Operator */
 body:not([data-theme="light"]) .highlight .x { color: #d0d0d0 } /* Other */
 body:not([data-theme="light"]) .highlight .p { color: #d0d0d0 } /* Punctuation */
-body:not([data-theme="light"]) .highlight .ch { color: #ababab; font-style: italic } /* Comment.Hashbang */
-body:not([data-theme="light"]) .highlight .cm { color: #ababab; font-style: italic } /* Comment.Multiline */
+body:not([data-theme="light"]) .highlight .ch { color: #999999; font-style: italic } /* Comment.Hashbang */
+body:not([data-theme="light"]) .highlight .cm { color: #999999; font-style: italic } /* Comment.Multiline */
 body:not([data-theme="light"]) .highlight .cp { color: #cd2828; font-weight: bold } /* Comment.Preproc */
-body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */
-body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */
+body:not([data-theme="light"]) .highlight .cpf { color: #999999; font-style: italic } /* Comment.PreprocFile */
+body:not([data-theme="light"]) .highlight .c1 { color: #999999; font-style: italic } /* Comment.Single */
 body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */
 body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */
 body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */
@@ -198,36 +198,36 @@ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prom
 body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */
 body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */
 body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */
-body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */
-body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */
-body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */
-body:not([data-theme="light"]) .highlight .kp { color: #6ebf26 } /* Keyword.Pseudo */
-body:not([data-theme="light"]) .highlight .kr { color: #6ebf26; font-weight: bold } /* Keyword.Reserved */
-body:not([data-theme="light"]) .highlight .kt { color: #6ebf26; font-weight: bold } /* Keyword.Type */
+body:not([data-theme="light"]) .highlight .kc { color: #6ab825; font-weight: bold } /* Keyword.Constant */
+body:not([data-theme="light"]) .highlight .kd { color: #6ab825; font-weight: bold } /* Keyword.Declaration */
+body:not([data-theme="light"]) .highlight .kn { color: #6ab825; font-weight: bold } /* Keyword.Namespace */
+body:not([data-theme="light"]) .highlight .kp { color: #6ab825 } /* Keyword.Pseudo */
+body:not([data-theme="light"]) .highlight .kr { color: #6ab825; font-weight: bold } /* Keyword.Reserved */
+body:not([data-theme="light"]) .highlight .kt { color: #6ab825; font-weight: bold } /* Keyword.Type */
 body:not([data-theme="light"]) .highlight .ld { color: #d0d0d0 } /* Literal.Date */
-body:not([data-theme="light"]) .highlight .m { color: #51b2fd } /* Literal.Number */
+body:not([data-theme="light"]) .highlight .m { color: #3677a9 } /* Literal.Number */
 body:not([data-theme="light"]) .highlight .s { color: #ed9d13 } /* Literal.String */
 body:not([data-theme="light"]) .highlight .na { color: #bbbbbb } /* Name.Attribute */
-body:not([data-theme="light"]) .highlight .nb { color: #2fbccd } /* Name.Builtin */
-body:not([data-theme="light"]) .highlight .nc { color: #71adff; text-decoration: underline } /* Name.Class */
+body:not([data-theme="light"]) .highlight .nb { color: #24909d } /* Name.Builtin */
+body:not([data-theme="light"]) .highlight .nc { color: #447fcf; text-decoration: underline } /* Name.Class */
 body:not([data-theme="light"]) .highlight .no { color: #40ffff } /* Name.Constant */
 body:not([data-theme="light"]) .highlight .nd { color: #ffa500 } /* Name.Decorator */
 body:not([data-theme="light"]) .highlight .ni { color: #d0d0d0 } /* Name.Entity */
 body:not([data-theme="light"]) .highlight .ne { color: #bbbbbb } /* Name.Exception */
-body:not([data-theme="light"]) .highlight .nf { color: #71adff } /* Name.Function */
+body:not([data-theme="light"]) .highlight .nf { color: #447fcf } /* Name.Function */
 body:not([data-theme="light"]) .highlight .nl { color: #d0d0d0 } /* Name.Label */
-body:not([data-theme="light"]) .highlight .nn { color: #71adff; text-decoration: underline } /* Name.Namespace */
+body:not([data-theme="light"]) .highlight .nn { color: #447fcf; text-decoration: underline } /* Name.Namespace */
 body:not([data-theme="light"]) .highlight .nx { color: #d0d0d0 } /* Name.Other */
 body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Property */
-body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */
+body:not([data-theme="light"]) .highlight .nt { color: #6ab825; font-weight: bold } /* Name.Tag */
 body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */
-body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */
+body:not([data-theme="light"]) .highlight .ow { color: #6ab825; font-weight: bold } /* Operator.Word */
 body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */
-body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */
-body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */
-body:not([data-theme="light"]) .highlight .mh { color: #51b2fd } /* Literal.Number.Hex */
-body:not([data-theme="light"]) .highlight .mi { color: #51b2fd } /* Literal.Number.Integer */
-body:not([data-theme="light"]) .highlight .mo { color: #51b2fd } /* Literal.Number.Oct */
+body:not([data-theme="light"]) .highlight .mb { color: #3677a9 } /* Literal.Number.Bin */
+body:not([data-theme="light"]) .highlight .mf { color: #3677a9 } /* Literal.Number.Float */
+body:not([data-theme="light"]) .highlight .mh { color: #3677a9 } /* Literal.Number.Hex */
+body:not([data-theme="light"]) .highlight .mi { color: #3677a9 } /* Literal.Number.Integer */
+body:not([data-theme="light"]) .highlight .mo { color: #3677a9 } /* Literal.Number.Oct */
 body:not([data-theme="light"]) .highlight .sa { color: #ed9d13 } /* Literal.String.Affix */
 body:not([data-theme="light"]) .highlight .sb { color: #ed9d13 } /* Literal.String.Backtick */
 body:not([data-theme="light"]) .highlight .sc { color: #ed9d13 } /* Literal.String.Char */
@@ -241,12 +241,12 @@ body:not([data-theme="light"]) .highlight .sx { color: #ffa500 } /* Literal.Stri
 body:not([data-theme="light"]) .highlight .sr { color: #ed9d13 } /* Literal.String.Regex */
 body:not([data-theme="light"]) .highlight .s1 { color: #ed9d13 } /* Literal.String.Single */
 body:not([data-theme="light"]) .highlight .ss { color: #ed9d13 } /* Literal.String.Symbol */
-body:not([data-theme="light"]) .highlight .bp { color: #2fbccd } /* Name.Builtin.Pseudo */
-body:not([data-theme="light"]) .highlight .fm { color: #71adff } /* Name.Function.Magic */
+body:not([data-theme="light"]) .highlight .bp { color: #24909d } /* Name.Builtin.Pseudo */
+body:not([data-theme="light"]) .highlight .fm { color: #447fcf } /* Name.Function.Magic */
 body:not([data-theme="light"]) .highlight .vc { color: #40ffff } /* Name.Variable.Class */
 body:not([data-theme="light"]) .highlight .vg { color: #40ffff } /* Name.Variable.Global */
 body:not([data-theme="light"]) .highlight .vi { color: #40ffff } /* Name.Variable.Instance */
 body:not([data-theme="light"]) .highlight .vm { color: #40ffff } /* Name.Variable.Magic */
-body:not([data-theme="light"]) .highlight .il { color: #51b2fd } /* Literal.Number.Integer.Long */
+body:not([data-theme="light"]) .highlight .il { color: #3677a9 } /* Literal.Number.Integer.Long */
 }
 }