src: export FFI types as constants

Signed-off-by: Paolo Insogna <paolo@cowtech.it>

Author: ShogunPanda

deps/libffi/libffi.gyp

@@ -178,7 +178,6 @@
                 'preprocess_asm.py',
                 'include/ffi_cfi.h',
                 'src/aarch64/internal.h',
-                'src/aarch64/ksarm64.h',
                 'src/aarch64/win64_armasm.S',
                 '<(INTERMEDIATE_DIR)/ffi.h',
                 '<(INTERMEDIATE_DIR)/fficonfig.h',

deps/libffi/preprocess_asm.py

@@ -72,7 +72,13 @@ def preprocess(args):
         sys.stderr.write(result.stderr)
         raise RuntimeError(f'Preprocessing failed: {" ".join(command)}')
 
-    output.write_text(result.stdout, encoding='utf-8')
+    processed_lines = []
+    for line in result.stdout.splitlines(keepends=True):
+        if line.lstrip().startswith('#'):
+            continue
+        processed_lines.append(line)
+
+    output.write_text(''.join(processed_lines), encoding='utf-8')
 
 
 def main(argv=None):

doc/api/ffi.md

@@ -76,6 +76,29 @@ Supported type names:
 * `arraybuffer`
 * `function`
 
+These type names are also exposed as constants on `ffi.types`:
+
+* `ffi.types.VOID` = `'void'`
+* `ffi.types.POINTER` = `'pointer'`
+* `ffi.types.BUFFER` = `'buffer'`
+* `ffi.types.ARRAY_BUFFER` = `'arraybuffer'`
+* `ffi.types.FUNCTION` = `'function'`
+* `ffi.types.BOOL` = `'bool'`
+* `ffi.types.CHAR` = `'char'`
+* `ffi.types.STRING` = `'string'`
+* `ffi.types.FLOAT` = `'float'`
+* `ffi.types.DOUBLE` = `'double'`
+* `ffi.types.INT_8` = `'int8'`
+* `ffi.types.UINT_8` = `'uint8'`
+* `ffi.types.INT_16` = `'int16'`
+* `ffi.types.UINT_16` = `'uint16'`
+* `ffi.types.INT_32` = `'int32'`
+* `ffi.types.UINT_32` = `'uint32'`
+* `ffi.types.INT_64` = `'int64'`
+* `ffi.types.UINT_64` = `'uint64'`
+* `ffi.types.FLOAT_32` = `'float32'`
+* `ffi.types.FLOAT_64` = `'float64'`
+
 Pointer-like types (`pointer`, `string`, `buffer`, `arraybuffer`, and
 `function`) are all passed through the native layer as pointers.
 

lib/ffi.js

@@ -17,6 +17,7 @@ const {
   validateInteger,
   validateString,
 } = require('internal/validators');
+const { __proto__ } = require('console');
 
 emitExperimentalWarning('FFI');
 
@@ -131,6 +132,31 @@ function exportBuffer(buffer, data, len) {
   buffer.copy(targetBuffer, 0, 0, buffer.length);
 }
 
+const types = ObjectFreeze({
+  __proto__: null,
+  VOID: 'void',
+  POINTER: 'pointer',
+  BUFFER: 'buffer',
+  ARRAY_BUFFER: 'arraybuffer',
+  FUNCTION: 'function',
+  BOOL: 'bool',
+  CHAR: 'char',
+  STRING: 'string',
+  FLOAT: 'float',
+  DOUBLE: 'double',
+  INT_8: 'int8',
+  UINT_8: 'uint8',
+  INT_16: 'int16',
+  UINT_16: 'uint16',
+  INT_32: 'int32',
+  UINT_32: 'uint32',
+  INT_64: 'int64',
+  UINT_64: 'uint64',
+  FLOAT_32: 'float32',
+  FLOAT_64: 'float64',
+});
+
+
 module.exports = {
   DynamicLibrary,
   dlopen,
@@ -161,4 +187,5 @@ module.exports = {
   toString,
   toArrayBuffer,
   toBuffer,
+  types,
 };

test/ffi/test-ffi-module.js

@@ -108,6 +108,7 @@ test('ffi exports expected API surface', () => {
     'toArrayBuffer',
     'toBuffer',
     'toString',
+    'types',
   ];
 
   assert.deepStrictEqual(Object.keys(ffi).sort(), expected);
@@ -140,4 +141,35 @@ test('ffi exports expected API surface', () => {
   assert.strictEqual(typeof ffi.toString, 'function');
   assert.strictEqual(typeof ffi.toBuffer, 'function');
   assert.strictEqual(typeof ffi.toArrayBuffer, 'function');
+  assert.strictEqual(typeof ffi.types, 'object');
+});
+
+test('ffi.types exports canonical type constants', () => {
+  const ffi = require('node:ffi');
+  const expected = {
+    __proto__: null,
+    VOID: 'void',
+    POINTER: 'pointer',
+    BUFFER: 'buffer',
+    ARRAY_BUFFER: 'arraybuffer',
+    FUNCTION: 'function',
+    BOOL: 'bool',
+    CHAR: 'char',
+    STRING: 'string',
+    FLOAT: 'float',
+    DOUBLE: 'double',
+    INT_8: 'int8',
+    UINT_8: 'uint8',
+    INT_16: 'int16',
+    UINT_16: 'uint16',
+    INT_32: 'int32',
+    UINT_32: 'uint32',
+    INT_64: 'int64',
+    UINT_64: 'uint64',
+    FLOAT_32: 'float32',
+    FLOAT_64: 'float64',
+  };
+
+  assert.deepStrictEqual(ffi.types, expected);
+  assert.strictEqual(Object.isFrozen(ffi.types), true);
 });