skir-cc-gen 0.0.1

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "skir-cc-gen",
+  "version": "0.0.1",
+  "description": "",
+  "keywords": [],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gepheum/skir-cc-gen.git"
+  },
+  "license": "ISC",
+  "author": "Tyler Fibonacci <gepheum@gmail.com>",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js"
+    }
+  },
+  "module": "./dist/index.js",
+  "files": [
+    "dist",
+    "src",
+    "client"
+  ],
+  "scripts": {
+    "build": "tsc && cd e2e-test && skir gen && cd ..",
+    "copy-to-client": "cp e2e-test/skir.h client && cp e2e-test/skir.cc client && cp e2e-test/skir.testing.h client",
+    "copy-to-client:check": "diff -s e2e-test/skir.h client/skir.h && diff -s e2e-test/skir.cc client/skir.cc && diff -s e2e-test/skir.testing.h client/skir.testing.h",
+    "format-skir": "cd e2e-test && skir format && cd ..",
+    "format-skir:check": "cd e2e-test && skir format check && cd ..",
+    "format-cc": "find e2e-test -not -path 'e2e-test/skirout/*' \\( -iname '*.cc' -o -iname '*.h' \\) | xargs clang-format --Werror -i",
+    "format-cc:check": "find e2e-test -not -path 'e2e-test/skirout/*' \\( -iname '*.cc' -o -iname '*.h' \\) | xargs clang-format --dry-run --Werror -i",
+    "format": "prettier --write \"**/*.ts\" && npm run format-skir && npm run format-cc",
+    "format:check": "prettier --check \"**/*.ts\" && npm run format-skir:check && npm run format-cc:check",
+    "gen-clang-json": "cd e2e-test && bazel run @hedron_compile_commands//:refresh_all && cd ..",
+    "test-cc": "cd e2e-test && CC=clang BAZEL_COMPILER=llvm bazel test --copt=-DADDRESS_SANITIZER --copt=-fsanitize=address --linkopt=-fsanitize=address --test_output=errors :all && cd ..",
+    "build-client": "cd client && bazel build :skir && bazel build :skir.testing && cd ..",
+    "test": "npm run build && npm run test-cc && npm run build-client",
+    "lint": "eslint src/**/*.ts",
+    "lint:fix": "eslint src/**/*.ts --fix"
+  },
+  "dependencies": {
+    "skir-internal": "^0.0.6"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.5",
+    "@typescript-eslint/eslint-plugin": "^6.13.0",
+    "@typescript-eslint/parser": "^6.13.0",
+    "eslint": "^8.54.0",
+    "prettier": "^3.2.4",
+    "prettier-plugin-organize-imports": "^4.2.0",
+    "skir": "^0.0.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3"
+  }
+}

package/src/enum_variant.ts

@@ -0,0 +1,126 @@
+import { Doc, Field, ResolvedType, convertCase } from "skir-internal";
+import { TypeSpeller } from "./type_speller.js";
+
+interface MutableEnumVariant {
+  /** As specified in the .skir file. */
+  readonly variantName: string;
+  /** Examples: "bool", "Foo". Empty if the variant is a constant. */
+  readonly valueType: string;
+  /** Examples: "bool", "foo::Foo". Empty if the variant is a constant. */
+  readonly valueTypeWithNamespace: string;
+  /** As specified in the .skir file. */
+  variantNumber: number;
+  /** Whether the variant is the special UNKNOWN variant. */
+  isUnknownVariant: boolean;
+  /** Examples: "k_variant", "wrap_variant". */
+  readonly structType: string;
+  /** Example: "wrap_variant_type". Empty if the variant is a constant. */
+  readonly typeAlias: string;
+  /** kVariant or wrap_variant. */
+  readonly identifier: string;
+  /** kConstVariant or kValVariant */
+  readonly kindEnumerator: string;
+  /**
+   * True if the variant is a wrapper and the value should be allocated on the heap.
+   */
+  readonly usePointer: boolean;
+  readonly doc: Doc;
+}
+
+export type EnumVariant = Readonly<MutableEnumVariant>;
+
+export function getEnumVariants(
+  variants: readonly Field[],
+  typeSpeller: TypeSpeller,
+): readonly EnumVariant[] {
+  const result: MutableEnumVariant[] = [];
+  result.push(makeUnknownVariant());
+  for (const inVariant of variants) {
+    let outVariant: MutableEnumVariant;
+    if (inVariant.type) {
+      outVariant = makeWrapperVariant(inVariant, inVariant.doc, typeSpeller);
+    } else {
+      outVariant = makeConstantVariant(inVariant.name.text, inVariant.doc);
+    }
+    outVariant.variantNumber = inVariant.number;
+    result.push(outVariant);
+  }
+  return result;
+}
+
+function makeUnknownVariant(): MutableEnumVariant {
+  return {
+    variantName: "?",
+    valueType: "",
+    valueTypeWithNamespace: "",
+    variantNumber: 0,
+    isUnknownVariant: true,
+    structType: `k_unknown`,
+    typeAlias: "",
+    identifier: `kUnknown`,
+    kindEnumerator: `kUnknown`,
+    usePointer: false,
+    doc: { text: "", pieces: [] },
+  };
+}
+
+function makeConstantVariant(
+  variantName: string,
+  doc: Doc,
+): MutableEnumVariant {
+  const lowerUnderscore = convertCase(variantName, "lower_underscore");
+  const upperCamel = convertCase(variantName, "UpperCamel");
+  return {
+    variantName: variantName,
+    valueType: "",
+    valueTypeWithNamespace: "",
+    variantNumber: 0,
+    isUnknownVariant: false,
+    structType: `k_${lowerUnderscore}`,
+    typeAlias: "",
+    identifier: `k${upperCamel}`,
+    kindEnumerator: `k${upperCamel}Const`,
+    usePointer: false,
+    doc: doc,
+  };
+}
+
+function makeWrapperVariant(
+  variant: Field,
+  doc: Doc,
+  typeSpeller: TypeSpeller,
+): MutableEnumVariant {
+  const variantName = variant.name.text;
+  const upperCamel = convertCase(variantName, "UpperCamel");
+  const type = variant.type!;
+  return {
+    variantName: variantName,
+    valueType: typeSpeller.getCcType(type),
+    valueTypeWithNamespace: typeSpeller.getCcType(type, {
+      forceNamespace: true,
+    }),
+    variantNumber: 0,
+    isUnknownVariant: false,
+    structType: `wrap_${variantName}`,
+    typeAlias: `wrap_${variantName}_type`,
+    identifier: `wrap_${variantName}`,
+    kindEnumerator: `k${upperCamel}Wrapper`,
+    usePointer: usePointer(variant.type!),
+    doc: doc,
+  };
+}
+
+function usePointer(type: ResolvedType): boolean {
+  if (type.kind !== "primitive") return true;
+  switch (type.primitive) {
+    case "bool":
+    case "int32":
+    case "int64":
+    case "uint64":
+    case "float32":
+    case "float64":
+    case "timestamp":
+      return false;
+  }
+  return true;
+}