fix(struct-alias): Support struct typedef aliasing

package.json

@@ -5,7 +5,7 @@
   "description": "lerna workspace for clangffi, libclang-bindings tools",
   "scripts": {
     "clangffi": "node packages/clangffi/dist/bin/clangffi.js",
-    "generate-dogfood": "npm run clangffi -- -i vendor/llvm-project/clang/include/clang-c/Index.h -I vendor/llvm-project/clang/include/ -o packages/libclang-bindings/src/libclang.ts --include *time*_t --include-file vendor/llvm-project/clang/include/clang-c/",
+    "generate-dogfood": "npm run clangffi -- --clean-enum-constants=false -i vendor/llvm-project/clang/include/clang-c/Index.h -I vendor/llvm-project/clang/include/ -o packages/libclang-bindings/src/libclang.ts --include *time*_t --include-file vendor/llvm-project/clang/include/clang-c/",
     "bootstrap": "lerna bootstrap",
     "build": "lerna run build --stream",
     "test": "lerna run test --stream"
@@ -14,5 +14,8 @@
   "license": "MIT",
   "devDependencies": {
     "lerna": "^4.0.0"
+  },
+  "volta": {
+    "node": "17.9.1"
   }
 }

packages/clangffi/README.md

@@ -45,6 +45,7 @@ Options:
       --include-file         File paths to explicitly include symbols from, in addition to the default. If a directory path is given symbols from all files in that directory will be included.                                         [array] [default: []]
       --exclude              Symbols to explicitly exclude from the bindings. Overrides `include` if there is a conflict.                                                                                                               [array] [default: []]
       --hard-remap, --remap  Custom native to node symbol mappings that override the default.                                                                                                                                           [array] [default: []]
+      --clean-enum-constants  Convert constant names like `ENUM_NAME_FOO_BAR` to `FooBar` in enums.                                                                                                                                 [boolean] [default: true]
       --help                 Show help                                                                                                                                                                                                              [boolean]
 
 Examples:

packages/clangffi/src/lib/parser.ts

@@ -21,7 +21,7 @@ import {
   CXTypeKind,
 } from "libclang-bindings";
 import { ISourceGenerator } from "./types.js";
-import { formatPath, resolveName } from "./util.js";
+import { formatPath, resolveName, simpleDesugar } from "./util.js";
 import { matches, SelectorData } from "./selector.js";
 
 const log = debug("clangffi:parser");
@@ -192,9 +192,20 @@ export class Parser {
       if (decl instanceof TypedefDecl) {
         const td = decl as TypedefDecl;
 
+        const canonicalType = td.underlyingTypeClass.isCanonical
+          ? td.underlyingTypeClass
+          : td.underlyingTypeClass.canonicalType;
+        const canonicalName = canonicalType
+          ? simpleDesugar(canonicalType)
+          : td.name;
+
         // elaborated types will be auto walked already
         // for non elaborate types we need to manually walk em
-        if (td.underlyingTypeClass.kind != CXTypeKind.CXType_Elaborated) {
+        // we also manually walk if the typedef name and the underlying class name don't align
+        if (
+          td.underlyingTypeClass.kind != CXTypeKind.CXType_Elaborated ||
+          symbolName !== canonicalName
+        ) {
           this.opts.generator.openTypedef(td);
           visit(decl, this.visit.bind(this));
           this.opts.generator.closeTypedef(td);

packages/clangffi/src/lib/tsgen/resolve.ts

@@ -244,6 +244,13 @@ export function resolveType(type: Type, resolver: ITypeNameResolver): string {
     // here we pull off the struct sugar before creating the resolved type
     sb.append(resolver.createStruct(type.name.substring("struct ".length)));
   }
+  // union (not just all records, only those that are unions)
+  else if (type.isRecordType && type.name.startsWith("union ")) {
+    resolveLog(`${type.name} is union`);
+
+    // here we pull off the union sugar before creating the resolved type
+    sb.append(resolver.createUnion(type.name.substring("union ".length)));
+  }
   // array
   else if (type.isArrayType && type.elementType) {
     resolveLog(`${type.name} is array`);

packages/clangffi/src/lib/util.ts

@@ -29,6 +29,21 @@ export function simpleDesugar(type: Type) {
     desugarLog(`removed const: '${desugared}'`);
   }
 
+  if (desugared.startsWith("struct ")) {
+    desugared = desugared.replace("struct ", "");
+    desugarLog(`removed struct prefix: '${desugared}'`);
+  }
+
+  if (desugared.startsWith("enum ")) {
+    desugared = desugared.replace("enum ", "");
+    desugarLog(`removed enum prefix: '${desugared}'`);
+  }
+
+  if (desugared.startsWith("union ")) {
+    desugared = desugared.replace("union ", "");
+    desugarLog(`removed union prefix: '${desugared}'`);
+  }
+
   return desugared;
 }
 

packages/libclang-bindings/package.json

@@ -34,6 +34,7 @@
     "@types/ref-array-di": "^1.2.3",
     "@types/ref-napi": "^3.0.4",
     "@types/ref-struct-di": "^1.1.5",
+    "@types/ref-union-di": "^1.0.3",
     "babel-jest": "^27.4.5",
     "jest": "^27.4.5",
     "typescript": "^4.5.4"
@@ -42,7 +43,8 @@
     "ffi-napi": "^4.0.3",
     "ref-array-di": "^1.2.2",
     "ref-napi": "^3.0.3",
-    "ref-struct-di": "^1.1.1"
+    "ref-struct-di": "^1.1.1",
+    "ref-union-di": "^1.0.1"
   },
   "engines": {
     "node": ">=17.x"

packages/libclang-bindings/src/libclang.ts

@@ -2,8 +2,9 @@ import ffi from "ffi-napi";
 import ref, { Pointer as TypedPointer, UnderlyingType } from "ref-napi";
 import refStructDi, { StructObject } from "ref-struct-di";
 import refArrayDi, { TypedArray } from "ref-array-di";
-
+import refUnionDi from "ref-union-di";
 const Struct = refStructDi(ref);
+const Union = refUnionDi(ref);
 const ArrayType = refArrayDi(ref);
 const Pointer = ref.refType;
 export type __time32_t = number;