@gtkx/codegen 0.21.0 → 1.0.0-rc.2

package/dist/khronos/args.js

@@ -0,0 +1,171 @@
+import { toCamelIdentifier } from "@gtkx/utils";
+import { tArray, tBoolean, tBuffer, tFixedArray, tInlineStruct, tRef, tSizedArray, tString, tUint64, } from "../analysis/descriptor.js";
+import { paramPairAt } from "./param-pair.js";
+const OUT_PLAN_KINDS = new Set(["ref-out", "ref-array-out", "ref-fixed-out", "string-out"]);
+const scalarAliasOrGroup = (scalar, group) => group !== undefined && scalar.groupBearing === true ? group : scalar.tsAlias;
+const paramIndexByName = (command, name) => {
+    const index = command.params.findIndex((param) => param.name === name);
+    if (index === -1) {
+        throw new Error(`Command ${command.name} has no parameter named ${name}`);
+    }
+    return index;
+};
+const arrayInTsType = (scalar, group) => {
+    const element = scalarAliasOrGroup(scalar, group);
+    return scalar.viewType === undefined ? `${element}[]` : `${element}[] | ${scalar.viewType}`;
+};
+const inArg = (name, tsType, descriptor) => ({
+    out: false,
+    name,
+    tsType,
+    descriptor,
+});
+const buildInArg = (options, name, track) => {
+    const { command, index, plan } = options;
+    const param = command.params[index];
+    if (param === undefined) {
+        throw new Error(`Parameter index ${String(index)} out of range on ${command.name}`);
+    }
+    switch (plan.kind) {
+        case "scalar": {
+            return inArg(name, track(scalarAliasOrGroup(plan.scalar, param.group)), plan.scalar.descriptor);
+        }
+        case "boolean": {
+            return inArg(name, "boolean", tBoolean);
+        }
+        case "sync": {
+            return inArg(name, track("GLsync"), tInlineStruct());
+        }
+        case "string-in": {
+            return inArg(name, "string", tString("borrowed"));
+        }
+        case "string-array-in": {
+            return inArg(name, "string[]", tArray(tString("borrowed")));
+        }
+        case "array-in": {
+            track(scalarAliasOrGroup(plan.scalar, param.group));
+            return inArg(name, arrayInTsType(plan.scalar, param.group), tArray(plan.scalar.descriptor));
+        }
+        case "buffer": {
+            return inArg(name, `ArrayBufferView | ${track("GLintptr")} | null`, tBuffer);
+        }
+        case "byte-offset": {
+            return inArg(name, track("GLintptr"), tUint64);
+        }
+        case "byte-offset-array": {
+            return inArg(name, `${track("GLintptr")}[]`, tArray(tUint64));
+        }
+        case "ref-array-out":
+        case "ref-fixed-out":
+        case "ref-out":
+        case "string-out": {
+            throw new Error(`Plan kind ${plan.kind} is not an input parameter`);
+        }
+    }
+};
+const outArgFields = (options) => {
+    const { command, plan, param, cellName, track } = options;
+    switch (plan.kind) {
+        case "ref-out": {
+            return {
+                seed: `const ${cellName} = { value: 0 };`,
+                tsType: track(scalarAliasOrGroup(plan.scalar, param.group)),
+                descriptor: tRef(plan.scalar.descriptor),
+            };
+        }
+        case "ref-array-out": {
+            const sizeIndex = paramIndexByName(command, plan.lenParamName);
+            const lenIdentifier = toCamelIdentifier(plan.lenParamName);
+            return {
+                seed: `const ${cellName} = { value: new Array<number>(${lenIdentifier}).fill(0) };`,
+                tsType: `${track(plan.scalar.tsAlias)}[]`,
+                descriptor: tRef(tSizedArray(plan.scalar.descriptor, sizeIndex)),
+            };
+        }
+        case "ref-fixed-out": {
+            return {
+                seed: `const ${cellName} = { value: new Array<number>(${String(plan.length)}).fill(0) };`,
+                tsType: `${track(plan.scalar.tsAlias)}[]`,
+                descriptor: tRef(tFixedArray(plan.scalar.descriptor, plan.length)),
+            };
+        }
+        case "string-out": {
+            return {
+                seed: `const ${cellName} = { value: "" };`,
+                tsType: "string",
+                descriptor: tRef(tString("borrowed", toCamelIdentifier(plan.lenParamName))),
+            };
+        }
+        case "array-in":
+        case "boolean":
+        case "buffer":
+        case "byte-offset":
+        case "byte-offset-array":
+        case "scalar":
+        case "string-array-in":
+        case "string-in":
+        case "sync": {
+            throw new Error(`Plan kind ${plan.kind} is not an output parameter`);
+        }
+    }
+};
+const buildOutArg = (options, track) => {
+    const { command, index, plan, outIndex } = options;
+    const param = command.params[index];
+    if (param === undefined) {
+        throw new Error(`Parameter index ${String(index)} out of range on ${command.name}`);
+    }
+    const cellName = `out${String(outIndex)}`;
+    const cell = { out: true, cellName, paramIndex: index };
+    return { ...cell, ...outArgFields({ command, plan, param, cellName, track }) };
+};
+const isOutPlan = (plan) => OUT_PLAN_KINDS.has(plan.kind);
+const isInArg = (arg) => !arg.out;
+const isOutArg = (arg) => arg.out;
+const buildArg = (options, name, track) => isOutPlan(options.plan) ? buildOutArg(options, track) : buildInArg(options, name, track);
+const trackInto = (usedTypes) => (alias) => {
+    usedTypes.add(alias);
+    return alias;
+};
+const planArgs = (plan, usedTypes) => {
+    const track = trackInto(usedTypes);
+    const args = [];
+    for (const [index, paramPlan] of plan.params.entries()) {
+        const param = plan.command.params[index];
+        if (param === undefined) {
+            throw new Error(`Parameter index ${String(index)} out of range on ${plan.command.name}`);
+        }
+        const options = {
+            command: plan.command,
+            index,
+            plan: paramPlan,
+            outIndex: args.filter(isOutArg).length,
+        };
+        args.push(buildArg(options, toCamelIdentifier(param.name), track));
+    }
+    return { args, ins: args.filter(isInArg), outs: args.filter(isOutArg) };
+};
+const scalarPrefixArg = (plan, index, track) => {
+    const { paramPlan, param } = paramPairAt(plan, index);
+    if (param === undefined) {
+        return undefined;
+    }
+    if (paramPlan?.kind !== "scalar") {
+        return undefined;
+    }
+    return buildInArg({ command: plan.command, index, plan: paramPlan, outIndex: 0 }, toCamelIdentifier(param.name), track);
+};
+const scalarPrefixArgs = (plan, usedTypes) => {
+    const track = trackInto(usedTypes);
+    const prefix = [];
+    for (let index = 0; index < plan.params.length - 2; index++) {
+        const arg = scalarPrefixArg(plan, index, track);
+        if (arg === undefined) {
+            return undefined;
+        }
+        prefix.push(arg);
+    }
+    return prefix;
+};
+export { scalarAliasOrGroup, trackInto, planArgs, scalarPrefixArgs };
+//# sourceMappingURL=args.js.map

package/dist/khronos/args.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"args.js","sourceRoot":"","sources":["../../src/khronos/args.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAGhD,OAAO,EACH,MAAM,EACN,QAAQ,EACR,OAAO,EACP,WAAW,EACX,aAAa,EACb,IAAI,EACJ,WAAW,EACX,OAAO,EACP,OAAO,GACV,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAqC9C,MAAM,cAAc,GAAgB,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,eAAe,EAAE,eAAe,EAAE,YAAY,CAAC,CAAC,CAAC;AAEzG,MAAM,kBAAkB,GAAG,CAAC,MAAgB,EAAE,KAAyB,EAAU,EAAE,CAC/E,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,YAAY,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;AAEjF,MAAM,gBAAgB,GAAG,CAAC,OAAkB,EAAE,IAAY,EAAU,EAAE;IAClE,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IAEvE,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,WAAW,OAAO,CAAC,IAAI,2BAA2B,IAAI,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,MAAgB,EAAE,KAAyB,EAAU,EAAE;IAC1E,MAAM,OAAO,GAAG,kBAAkB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAElD,OAAO,MAAM,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC,CAAC,GAAG,OAAO,QAAQ,MAAM,CAAC,QAAQ,EAAE,CAAC;AAChG,CAAC,CAAC;AAEF,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,MAAc,EAAE,UAAkB,EAAS,EAAE,CAAC,CAAC;IACxE,GAAG,EAAE,KAAK;IACV,IAAI;IACJ,MAAM;IACN,UAAU;CACb,CAAC,CAAC;AAEH,MAAM,UAAU,GAAG,CAAC,OAAwB,EAAE,IAAY,EAAE,KAAgC,EAAS,EAAE;IACnG,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IACzC,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEpC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,mBAAmB,MAAM,CAAC,KAAK,CAAC,oBAAoB,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACxF,CAAC;IAED,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAChB,KAAK,QAAQ,CAAC,CAAC,CAAC;YACZ,OAAO,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACpG,CAAC;QACD,KAAK,SAAS,CAAC,CAAC,CAAC;YACb,OAAO,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC5C,CAAC;QACD,KAAK,MAAM,CAAC,CAAC,CAAC;YACV,OAAO,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC;QACzD,CAAC;QACD,KAAK,WAAW,CAAC,CAAC,CAAC;YACf,OAAO,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;QACtD,CAAC;QACD,KAAK,iBAAiB,CAAC,CAAC,CAAC;YACrB,OAAO,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAChE,CAAC;QACD,KAAK,UAAU,CAAC,CAAC,CAAC;YACd,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YAEpD,OAAO,KAAK,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QAChG,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACZ,OAAO,KAAK,CAAC,IAAI,EAAE,qBAAqB,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACjF,CAAC;QACD,KAAK,aAAa,CAAC,CAAC,CAAC;YACjB,OAAO,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,CAAC;QACnD,CAAC;QACD,KAAK,mBAAmB,CAAC,CAAC,CAAC;YACvB,OAAO,KAAK,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QAClE,CAAC;QACD,KAAK,eAAe,CAAC;QACrB,KAAK,eAAe,CAAC;QACrB,KAAK,SAAS,CAAC;QACf,KAAK,YAAY,CAAC,CAAC,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,CAAC,IAAI,4BAA4B,CAAC,CAAC;QACxE,CAAC;IACL,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,OAA4B,EAAgB,EAAE;IAChE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAE1D,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAChB,KAAK,SAAS,CAAC,CAAC,CAAC;YACb,OAAO;gBACH,IAAI,EAAE,SAAS,QAAQ,kBAAkB;gBACzC,MAAM,EAAE,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;gBAC3D,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;aAC3C,CAAC;QACN,CAAC;QACD,KAAK,eAAe,CAAC,CAAC,CAAC;YACnB,MAAM,SAAS,GAAG,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;YAC/D,MAAM,aAAa,GAAG,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAE3D,OAAO;gBACH,IAAI,EAAE,SAAS,QAAQ,iCAAiC,aAAa,cAAc;gBACnF,MAAM,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI;gBACzC,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;aACnE,CAAC;QACN,CAAC;QACD,KAAK,eAAe,CAAC,CAAC,CAAC;YACnB,OAAO;gBACH,IAAI,EAAE,SAAS,QAAQ,iCAAiC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc;gBACzF,MAAM,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI;gBACzC,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;aACrE,CAAC;QACN,CAAC;QACD,KAAK,YAAY,CAAC,CAAC,CAAC;YAChB,OAAO;gBACH,IAAI,EAAE,SAAS,QAAQ,mBAAmB;gBAC1C,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;aAC9E,CAAC;QACN,CAAC;QACD,KAAK,UAAU,CAAC;QAChB,KAAK,SAAS,CAAC;QACf,KAAK,QAAQ,CAAC;QACd,KAAK,aAAa,CAAC;QACnB,KAAK,mBAAmB,CAAC;QACzB,KAAK,QAAQ,CAAC;QACd,KAAK,iBAAiB,CAAC;QACvB,KAAK,WAAW,CAAC;QACjB,KAAK,MAAM,CAAC,CAAC,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,CAAC,IAAI,6BAA6B,CAAC,CAAC;QACzE,CAAC;IACL,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,OAAwB,EAAE,KAAgC,EAAU,EAAE;IACvF,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IACnD,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEpC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,mBAAmB,MAAM,CAAC,KAAK,CAAC,oBAAoB,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACxF,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC1C,MAAM,IAAI,GAAe,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;IAEpE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;AACnF,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,IAAe,EAAW,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9E,MAAM,OAAO,GAAG,CAAC,GAAe,EAAgB,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;AAC5D,MAAM,QAAQ,GAAG,CAAC,GAAe,EAAiB,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;AAE7D,MAAM,QAAQ,GAAG,CAAC,OAAwB,EAAE,IAAY,EAAE,KAAgC,EAAc,EAAE,CACtG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;AAE7F,MAAM,SAAS,GACX,CAAC,SAAsB,EAAE,EAAE,CACvB,CAAC,KAAa,EAAU,EAAE;IACtB,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAErB,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEV,MAAM,QAAQ,GAAG,CACb,IAAgC,EAChC,SAAsB,EAC8B,EAAE;IACtD,MAAM,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;IACnC,MAAM,IAAI,GAAiB,EAAE,CAAC;IAE9B,KAAK,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;QACrD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAEzC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,mBAAmB,MAAM,CAAC,KAAK,CAAC,oBAAoB,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAC7F,CAAC;QAED,MAAM,OAAO,GAAoB;YAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK;YACL,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM;SACzC,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IACvE,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;AAC5E,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CACpB,IAAgC,EAChC,KAAa,EACb,KAAgC,EACf,EAAE;IACnB,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAEtD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,IAAI,SAAS,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,OAAO,UAAU,CACb,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAE,EAC9D,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,EAC7B,KAAK,CACR,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,IAAgC,EAAE,SAAsB,EAAuB,EAAE;IACvG,MAAM,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;IACnC,MAAM,MAAM,GAAY,EAAE,CAAC;IAE3B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;QAC1D,MAAM,GAAG,GAAG,eAAe,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAEhD,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACpB,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrB,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AAEF,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,QAAQ,EAAE,gBAAgB,EAA2B,CAAC","sourcesContent":["import { toCamelIdentifier } from \"@gtkx/utils\";\nimport type { GlCommand, GlParam } from \"./model.js\";\nimport type { CommandPlan, GlScalar, ParamPlan } from \"./plan.js\";\nimport {\n    tArray,\n    tBoolean,\n    tBuffer,\n    tFixedArray,\n    tInlineStruct,\n    tRef,\n    tSizedArray,\n    tString,\n    tUint64,\n} from \"../analysis/descriptor.js\";\nimport { paramPairAt } from \"./param-pair.js\";\n\ntype InArg = {\n    out: false;\n    name: string;\n    tsType: string;\n    descriptor: string;\n};\n\ntype OutArg = {\n    out: true;\n    cellName: string;\n    seed: string;\n    tsType: string;\n    descriptor: string;\n    paramIndex: number;\n};\n\ntype PlannedArg = InArg | OutArg;\ntype OutArgCell = Pick<OutArg, \"out\" | \"cellName\" | \"paramIndex\">;\ntype OutArgFields = Pick<OutArg, \"seed\" | \"tsType\" | \"descriptor\">;\n\ntype OutArgFieldsOptions = {\n    command: GlCommand;\n    plan: ParamPlan;\n    param: GlParam;\n    cellName: string;\n    track: (alias: string) => string;\n};\n\ntype BuildArgOptions = {\n    command: GlCommand;\n    index: number;\n    plan: ParamPlan;\n    outIndex: number;\n};\n\nconst OUT_PLAN_KINDS: Set<string> = new Set([\"ref-out\", \"ref-array-out\", \"ref-fixed-out\", \"string-out\"]);\n\nconst scalarAliasOrGroup = (scalar: GlScalar, group: string | undefined): string =>\n    group !== undefined && scalar.groupBearing === true ? group : scalar.tsAlias;\n\nconst paramIndexByName = (command: GlCommand, name: string): number => {\n    const index = command.params.findIndex((param) => param.name === name);\n\n    if (index === -1) {\n        throw new Error(`Command ${command.name} has no parameter named ${name}`);\n    }\n\n    return index;\n};\n\nconst arrayInTsType = (scalar: GlScalar, group: string | undefined): string => {\n    const element = scalarAliasOrGroup(scalar, group);\n\n    return scalar.viewType === undefined ? `${element}[]` : `${element}[] | ${scalar.viewType}`;\n};\n\nconst inArg = (name: string, tsType: string, descriptor: string): InArg => ({\n    out: false,\n    name,\n    tsType,\n    descriptor,\n});\n\nconst buildInArg = (options: BuildArgOptions, name: string, track: (alias: string) => string): InArg => {\n    const { command, index, plan } = options;\n    const param = command.params[index];\n\n    if (param === undefined) {\n        throw new Error(`Parameter index ${String(index)} out of range on ${command.name}`);\n    }\n\n    switch (plan.kind) {\n        case \"scalar\": {\n            return inArg(name, track(scalarAliasOrGroup(plan.scalar, param.group)), plan.scalar.descriptor);\n        }\n        case \"boolean\": {\n            return inArg(name, \"boolean\", tBoolean);\n        }\n        case \"sync\": {\n            return inArg(name, track(\"GLsync\"), tInlineStruct());\n        }\n        case \"string-in\": {\n            return inArg(name, \"string\", tString(\"borrowed\"));\n        }\n        case \"string-array-in\": {\n            return inArg(name, \"string[]\", tArray(tString(\"borrowed\")));\n        }\n        case \"array-in\": {\n            track(scalarAliasOrGroup(plan.scalar, param.group));\n\n            return inArg(name, arrayInTsType(plan.scalar, param.group), tArray(plan.scalar.descriptor));\n        }\n        case \"buffer\": {\n            return inArg(name, `ArrayBufferView | ${track(\"GLintptr\")} | null`, tBuffer);\n        }\n        case \"byte-offset\": {\n            return inArg(name, track(\"GLintptr\"), tUint64);\n        }\n        case \"byte-offset-array\": {\n            return inArg(name, `${track(\"GLintptr\")}[]`, tArray(tUint64));\n        }\n        case \"ref-array-out\":\n        case \"ref-fixed-out\":\n        case \"ref-out\":\n        case \"string-out\": {\n            throw new Error(`Plan kind ${plan.kind} is not an input parameter`);\n        }\n    }\n};\n\nconst outArgFields = (options: OutArgFieldsOptions): OutArgFields => {\n    const { command, plan, param, cellName, track } = options;\n\n    switch (plan.kind) {\n        case \"ref-out\": {\n            return {\n                seed: `const ${cellName} = { value: 0 };`,\n                tsType: track(scalarAliasOrGroup(plan.scalar, param.group)),\n                descriptor: tRef(plan.scalar.descriptor),\n            };\n        }\n        case \"ref-array-out\": {\n            const sizeIndex = paramIndexByName(command, plan.lenParamName);\n            const lenIdentifier = toCamelIdentifier(plan.lenParamName);\n\n            return {\n                seed: `const ${cellName} = { value: new Array<number>(${lenIdentifier}).fill(0) };`,\n                tsType: `${track(plan.scalar.tsAlias)}[]`,\n                descriptor: tRef(tSizedArray(plan.scalar.descriptor, sizeIndex)),\n            };\n        }\n        case \"ref-fixed-out\": {\n            return {\n                seed: `const ${cellName} = { value: new Array<number>(${String(plan.length)}).fill(0) };`,\n                tsType: `${track(plan.scalar.tsAlias)}[]`,\n                descriptor: tRef(tFixedArray(plan.scalar.descriptor, plan.length)),\n            };\n        }\n        case \"string-out\": {\n            return {\n                seed: `const ${cellName} = { value: \"\" };`,\n                tsType: \"string\",\n                descriptor: tRef(tString(\"borrowed\", toCamelIdentifier(plan.lenParamName))),\n            };\n        }\n        case \"array-in\":\n        case \"boolean\":\n        case \"buffer\":\n        case \"byte-offset\":\n        case \"byte-offset-array\":\n        case \"scalar\":\n        case \"string-array-in\":\n        case \"string-in\":\n        case \"sync\": {\n            throw new Error(`Plan kind ${plan.kind} is not an output parameter`);\n        }\n    }\n};\n\nconst buildOutArg = (options: BuildArgOptions, track: (alias: string) => string): OutArg => {\n    const { command, index, plan, outIndex } = options;\n    const param = command.params[index];\n\n    if (param === undefined) {\n        throw new Error(`Parameter index ${String(index)} out of range on ${command.name}`);\n    }\n\n    const cellName = `out${String(outIndex)}`;\n    const cell: OutArgCell = { out: true, cellName, paramIndex: index };\n\n    return { ...cell, ...outArgFields({ command, plan, param, cellName, track }) };\n};\n\nconst isOutPlan = (plan: ParamPlan): boolean => OUT_PLAN_KINDS.has(plan.kind);\nconst isInArg = (arg: PlannedArg): arg is InArg => !arg.out;\nconst isOutArg = (arg: PlannedArg): arg is OutArg => arg.out;\n\nconst buildArg = (options: BuildArgOptions, name: string, track: (alias: string) => string): PlannedArg =>\n    isOutPlan(options.plan) ? buildOutArg(options, track) : buildInArg(options, name, track);\n\nconst trackInto =\n    (usedTypes: Set<string>) =>\n        (alias: string): string => {\n            usedTypes.add(alias);\n\n            return alias;\n        };\n\nconst planArgs = (\n    plan: CommandPlan & { ok: true },\n    usedTypes: Set<string>,\n): { args: PlannedArg[]; ins: InArg[]; outs: OutArg[] } => {\n    const track = trackInto(usedTypes);\n    const args: PlannedArg[] = [];\n\n    for (const [index, paramPlan] of plan.params.entries()) {\n        const param = plan.command.params[index];\n\n        if (param === undefined) {\n            throw new Error(`Parameter index ${String(index)} out of range on ${plan.command.name}`);\n        }\n\n        const options: BuildArgOptions = {\n            command: plan.command,\n            index,\n            plan: paramPlan,\n            outIndex: args.filter(isOutArg).length,\n        };\n\n        args.push(buildArg(options, toCamelIdentifier(param.name), track));\n    }\n\n    return { args, ins: args.filter(isInArg), outs: args.filter(isOutArg) };\n};\n\nconst scalarPrefixArg = (\n    plan: CommandPlan & { ok: true },\n    index: number,\n    track: (alias: string) => string,\n): InArg | undefined => {\n    const { paramPlan, param } = paramPairAt(plan, index);\n\n    if (param === undefined) {\n        return undefined;\n    }\n\n    if (paramPlan?.kind !== \"scalar\") {\n        return undefined;\n    }\n\n    return buildInArg(\n        { command: plan.command, index, plan: paramPlan, outIndex: 0 },\n        toCamelIdentifier(param.name),\n        track,\n    );\n};\n\nconst scalarPrefixArgs = (plan: CommandPlan & { ok: true }, usedTypes: Set<string>): InArg[] | undefined => {\n    const track = trackInto(usedTypes);\n    const prefix: InArg[] = [];\n\n    for (let index = 0; index < plan.params.length - 2; index++) {\n        const arg = scalarPrefixArg(plan, index, track);\n\n        if (arg === undefined) {\n            return undefined;\n        }\n\n        prefix.push(arg);\n    }\n\n    return prefix;\n};\n\nexport { scalarAliasOrGroup, trackInto, planArgs, scalarPrefixArgs, type InArg, type OutArg };\n"]}

package/dist/khronos/jsdoc.d.ts

@@ -0,0 +1,21 @@
+import type { InArg, OutArg } from "./args.js";
+import type { GlCommand } from "./model.js";
+import type { ReturnPlan } from "./plan.js";
+type CommandJsDocOptions = {
+    command: GlCommand;
+    feature: string;
+    ins: InArg[];
+    outs: OutArg[];
+    returnPlan: ReturnPlan;
+};
+type SingularJsDocOptions = {
+    commandName: string;
+    feature: string;
+    summary: string;
+    body: string[];
+};
+declare const inParamDocLine: (command: GlCommand, arg: InArg) => string;
+declare const singularJsDoc: ({ commandName, feature, summary, body }: SingularJsDocOptions) => string;
+declare const commandJsDoc: ({ command, feature, ins, outs, returnPlan }: CommandJsDocOptions) => string;
+export { inParamDocLine, singularJsDoc, commandJsDoc };
+//# sourceMappingURL=jsdoc.d.ts.map

package/dist/khronos/jsdoc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsdoc.d.ts","sourceRoot":"","sources":["../../src/khronos/jsdoc.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAE5C,KAAK,mBAAmB,GAAG;IACvB,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,KAAK,EAAE,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,UAAU,EAAE,UAAU,CAAC;CAC1B,CAAC;AAEF,KAAK,oBAAoB,GAAG;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAYF,QAAA,MAAM,cAAc,GAAI,SAAS,SAAS,EAAE,KAAK,KAAK,KAAG,MAsBxD,CAAC;AAoCF,QAAA,MAAM,aAAa,GAAI,yCAAyC,oBAAoB,KAAG,MASvE,CAAC;AAEjB,QAAA,MAAM,YAAY,GAAI,6CAA6C,mBAAmB,KAAG,MAYxF,CAAC;AAEF,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC"}

package/dist/khronos/jsdoc.js

@@ -0,0 +1,72 @@
+import { toCamelIdentifier } from "@gtkx/utils";
+const REFPAGES_BASE = "https://registry.khronos.org/OpenGL-Refpages/gl4/html";
+const formatPrototype = (command) => {
+    const params = command.params
+        .map((param) => (param.cType.endsWith("*") ? `${param.cType}${param.name}` : `${param.cType} ${param.name}`))
+        .join(", ");
+    return `${command.returnCType} ${command.name}(${params})`;
+};
+const inParamDocLine = (command, arg) => {
+    const param = command.params.find((candidate) => toCamelIdentifier(candidate.name) === arg.name);
+    if (param === undefined) {
+        return ` * @param ${arg.name}`;
+    }
+    const notes = [`\`${param.cType}\``];
+    if (param.group !== undefined) {
+        notes.push(`group \`${param.group}\``);
+    }
+    if (param.len !== undefined) {
+        notes.push(`length \`${param.len}\``);
+    }
+    if (param.objectClass !== undefined) {
+        notes.push(`object class \`${param.objectClass}\``);
+    }
+    return ` * @param ${arg.name} - ${notes.join(", ")}`;
+};
+const outMember = (command, out) => {
+    const param = command.params[out.paramIndex];
+    if (param === undefined) {
+        throw new Error(`Output parameter index ${String(out.paramIndex)} out of range on ${command.name}`);
+    }
+    return `\`${param.name}\` (\`${param.cType}\`)`;
+};
+const returnsDocLine = (command, returnPlan, outs) => {
+    const members = [];
+    if (returnPlan.kind !== "void") {
+        members.push(`\`${command.returnCType}\``);
+    }
+    for (const out of outs) {
+        members.push(outMember(command, out));
+    }
+    if (members.length === 0) {
+        return undefined;
+    }
+    const [single] = members;
+    if (single !== undefined && members.length === 1) {
+        return ` * @returns ${single}`;
+    }
+    return ` * @returns Tuple of ${members.join(", ")}`;
+};
+const singularJsDoc = ({ commandName, feature, summary, body }) => [
+    "/**",
+    ` * ${summary}`,
+    " *",
+    ` * Provided by \`${feature}\`.`,
+    ...body,
+    ` * @see ${REFPAGES_BASE}/${commandName}.xhtml`,
+    " */",
+].join("\n");
+const commandJsDoc = ({ command, feature, ins, outs, returnPlan }) => {
+    const returnsLine = returnsDocLine(command, returnPlan, outs);
+    return singularJsDoc({
+        commandName: command.name,
+        feature,
+        summary: `\`${formatPrototype(command)}\``,
+        body: [
+            ...(ins.length > 0 ? [" *", ...ins.map((arg) => inParamDocLine(command, arg))] : []),
+            ...(returnsLine === undefined ? [] : [returnsLine]),
+        ],
+    });
+};
+export { inParamDocLine, singularJsDoc, commandJsDoc };
+//# sourceMappingURL=jsdoc.js.map

package/dist/khronos/jsdoc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsdoc.js","sourceRoot":"","sources":["../../src/khronos/jsdoc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAoBhD,MAAM,aAAa,GAAG,uDAAuD,CAAC;AAE9E,MAAM,eAAe,GAAG,CAAC,OAAkB,EAAU,EAAE;IACnD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM;SACxB,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;SAC5G,IAAI,CAAC,IAAI,CAAC,CAAC;IAEhB,OAAO,GAAG,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,IAAI,IAAI,MAAM,GAAG,CAAC;AAC/D,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,OAAkB,EAAE,GAAU,EAAU,EAAE;IAC9D,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC;IAEjG,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,aAAa,GAAG,CAAC,IAAI,EAAE,CAAC;IACnC,CAAC;IAED,MAAM,KAAK,GAAa,CAAC,KAAK,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;IAE/C,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC5B,KAAK,CAAC,IAAI,CAAC,WAAW,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,YAAY,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QAClC,KAAK,CAAC,IAAI,CAAC,kBAAkB,KAAK,CAAC,WAAW,IAAI,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,aAAa,GAAG,CAAC,IAAI,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,OAAkB,EAAE,GAAW,EAAU,EAAE;IAC1D,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAE7C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,0BAA0B,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,oBAAoB,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACxG,CAAC;IAED,OAAO,KAAK,KAAK,CAAC,IAAI,SAAS,KAAK,CAAC,KAAK,KAAK,CAAC;AACpD,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,OAAkB,EAAE,UAAsB,EAAE,IAAc,EAAsB,EAAE;IACtG,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,IAAI,UAAU,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAC7B,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,WAAW,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC;IAEzB,IAAI,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/C,OAAO,eAAe,MAAM,EAAE,CAAC;IACnC,CAAC;IAED,OAAO,wBAAwB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;AACxD,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAwB,EAAU,EAAE,CAC5F;IACI,KAAK;IACL,MAAM,OAAO,EAAE;IACf,IAAI;IACJ,oBAAoB,OAAO,KAAK;IAChC,GAAG,IAAI;IACP,WAAW,aAAa,IAAI,WAAW,QAAQ;IAC/C,KAAK;CACR,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEjB,MAAM,YAAY,GAAG,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAuB,EAAU,EAAE;IAC9F,MAAM,WAAW,GAAG,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;IAE9D,OAAO,aAAa,CAAC;QACjB,WAAW,EAAE,OAAO,CAAC,IAAI;QACzB,OAAO;QACP,OAAO,EAAE,KAAK,eAAe,CAAC,OAAO,CAAC,IAAI;QAC1C,IAAI,EAAE;YACF,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACpF,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;SACtD;KACJ,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC","sourcesContent":["import { toCamelIdentifier } from \"@gtkx/utils\";\nimport type { InArg, OutArg } from \"./args.js\";\nimport type { GlCommand } from \"./model.js\";\nimport type { ReturnPlan } from \"./plan.js\";\n\ntype CommandJsDocOptions = {\n    command: GlCommand;\n    feature: string;\n    ins: InArg[];\n    outs: OutArg[];\n    returnPlan: ReturnPlan;\n};\n\ntype SingularJsDocOptions = {\n    commandName: string;\n    feature: string;\n    summary: string;\n    body: string[];\n};\n\nconst REFPAGES_BASE = \"https://registry.khronos.org/OpenGL-Refpages/gl4/html\";\n\nconst formatPrototype = (command: GlCommand): string => {\n    const params = command.params\n        .map((param) => (param.cType.endsWith(\"*\") ? `${param.cType}${param.name}` : `${param.cType} ${param.name}`))\n        .join(\", \");\n\n    return `${command.returnCType} ${command.name}(${params})`;\n};\n\nconst inParamDocLine = (command: GlCommand, arg: InArg): string => {\n    const param = command.params.find((candidate) => toCamelIdentifier(candidate.name) === arg.name);\n\n    if (param === undefined) {\n        return ` * @param ${arg.name}`;\n    }\n\n    const notes: string[] = [`\\`${param.cType}\\``];\n\n    if (param.group !== undefined) {\n        notes.push(`group \\`${param.group}\\``);\n    }\n\n    if (param.len !== undefined) {\n        notes.push(`length \\`${param.len}\\``);\n    }\n\n    if (param.objectClass !== undefined) {\n        notes.push(`object class \\`${param.objectClass}\\``);\n    }\n\n    return ` * @param ${arg.name} - ${notes.join(\", \")}`;\n};\n\nconst outMember = (command: GlCommand, out: OutArg): string => {\n    const param = command.params[out.paramIndex];\n\n    if (param === undefined) {\n        throw new Error(`Output parameter index ${String(out.paramIndex)} out of range on ${command.name}`);\n    }\n\n    return `\\`${param.name}\\` (\\`${param.cType}\\`)`;\n};\n\nconst returnsDocLine = (command: GlCommand, returnPlan: ReturnPlan, outs: OutArg[]): string | undefined => {\n    const members: string[] = [];\n\n    if (returnPlan.kind !== \"void\") {\n        members.push(`\\`${command.returnCType}\\``);\n    }\n\n    for (const out of outs) {\n        members.push(outMember(command, out));\n    }\n\n    if (members.length === 0) {\n        return undefined;\n    }\n\n    const [single] = members;\n\n    if (single !== undefined && members.length === 1) {\n        return ` * @returns ${single}`;\n    }\n\n    return ` * @returns Tuple of ${members.join(\", \")}`;\n};\n\nconst singularJsDoc = ({ commandName, feature, summary, body }: SingularJsDocOptions): string =>\n    [\n        \"/**\",\n        ` * ${summary}`,\n        \" *\",\n        ` * Provided by \\`${feature}\\`.`,\n        ...body,\n        ` * @see ${REFPAGES_BASE}/${commandName}.xhtml`,\n        \" */\",\n    ].join(\"\\n\");\n\nconst commandJsDoc = ({ command, feature, ins, outs, returnPlan }: CommandJsDocOptions): string => {\n    const returnsLine = returnsDocLine(command, returnPlan, outs);\n\n    return singularJsDoc({\n        commandName: command.name,\n        feature,\n        summary: `\\`${formatPrototype(command)}\\``,\n        body: [\n            ...(ins.length > 0 ? [\" *\", ...ins.map((arg) => inParamDocLine(command, arg))] : []),\n            ...(returnsLine === undefined ? [] : [returnsLine]),\n        ],\n    });\n};\n\nexport { inParamDocLine, singularJsDoc, commandJsDoc };\n"]}

package/dist/khronos/model.d.ts

@@ -0,0 +1,38 @@
+type GlParam = {
+    name: string;
+    cType: string;
+    group?: string;
+    len?: string;
+    objectClass?: string;
+};
+type GlCommand = {
+    name: string;
+    returnCType: string;
+    returnGroup?: string;
+    params: GlParam[];
+};
+type GlEnum = {
+    name: string;
+    value: string;
+    groups: string[];
+};
+type GlInterfaceBlock = {
+    profile?: string;
+    commands: string[];
+    enums: string[];
+};
+type GlFeature = {
+    api: string;
+    name: string;
+    number: number;
+    requires: GlInterfaceBlock[];
+    removes: GlInterfaceBlock[];
+};
+type GlRegistry = {
+    commands: Map<string, GlCommand>;
+    enums: GlEnum[];
+    features: GlFeature[];
+};
+declare const loadGlRegistry: (path: string) => GlRegistry;
+export { loadGlRegistry, type GlParam, type GlCommand, type GlEnum, type GlInterfaceBlock, type GlFeature, type GlRegistry, };
+//# sourceMappingURL=model.d.ts.map

package/dist/khronos/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/khronos/model.ts"],"names":[],"mappings":"AAEA,KAAK,OAAO,GAAG;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,KAAK,SAAS,GAAG;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,OAAO,EAAE,CAAC;CACrB,CAAC;AAEF,KAAK,MAAM,GAAG;IACV,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,KAAK,SAAS,GAAG;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,gBAAgB,EAAE,CAAC;IAC7B,OAAO,EAAE,gBAAgB,EAAE,CAAC;CAC/B,CAAC;AAEF,KAAK,UAAU,GAAG;IACd,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACjC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,SAAS,EAAE,CAAC;CACzB,CAAC;AA+MF,QAAA,MAAM,cAAc,GAAI,MAAM,MAAM,KAAG,UAQtC,CAAC;AAEF,OAAO,EACH,cAAc,EACd,KAAK,OAAO,EACZ,KAAK,SAAS,EACd,KAAK,MAAM,EACX,KAAK,gBAAgB,EACrB,KAAK,SAAS,EACd,KAAK,UAAU,GAClB,CAAC"}

package/dist/khronos/model.js

@@ -0,0 +1,167 @@
+import { collectText, nodeAttr, nodeChildren, nodeTag, parseRegistryFile } from "./parse.js";
+const NAME_TAG = "name";
+const SKIP_IN_C_TYPE = new Set([NAME_TAG, "comment"]);
+const normalizeWhitespace = (text) => text.replaceAll(/\s+/g, " ").trim();
+const childNamed = (node, tag) => {
+    for (const child of nodeChildren(node)) {
+        if (nodeTag(child) === tag) {
+            return child;
+        }
+    }
+    return undefined;
+};
+const elementName = (node) => {
+    const nameChild = childNamed(node, NAME_TAG);
+    if (nameChild === undefined) {
+        return "";
+    }
+    return normalizeWhitespace(collectText(nameChild, new Set()));
+};
+const parseParam = (node) => {
+    const param = {
+        name: elementName(node),
+        cType: normalizeWhitespace(collectText(node, SKIP_IN_C_TYPE)),
+    };
+    const group = nodeAttr(node, "group");
+    const len = nodeAttr(node, "len");
+    const objectClass = nodeAttr(node, "class");
+    return {
+        ...param,
+        ...((group !== undefined) && { group }),
+        ...((len !== undefined) && { len }),
+        ...((objectClass !== undefined) && { objectClass }),
+    };
+};
+const parseCommand = (node) => {
+    const proto = childNamed(node, "proto");
+    if (proto === undefined) {
+        return undefined;
+    }
+    const params = [];
+    for (const child of nodeChildren(node)) {
+        if (nodeTag(child) === "param") {
+            params.push(parseParam(child));
+        }
+    }
+    const returnGroup = nodeAttr(proto, "group");
+    return {
+        name: elementName(proto),
+        returnCType: normalizeWhitespace(collectText(proto, SKIP_IN_C_TYPE)),
+        ...((returnGroup !== undefined) && { returnGroup }),
+        params,
+    };
+};
+const parseEnum = (child) => {
+    if (nodeTag(child) !== "enum") {
+        return undefined;
+    }
+    const name = nodeAttr(child, "name");
+    const value = nodeAttr(child, "value");
+    if (name === undefined || value === undefined) {
+        return undefined;
+    }
+    const group = nodeAttr(child, "group");
+    return {
+        name,
+        value,
+        groups: group === undefined ? [] : group.split(",").map((part) => part.trim()),
+    };
+};
+const parseEnums = (node, into) => {
+    for (const child of nodeChildren(node)) {
+        const parsed = parseEnum(child);
+        if (parsed !== undefined) {
+            into.push(parsed);
+        }
+    }
+};
+const collectInterfaceMember = (child, commands, enums) => {
+    const name = nodeAttr(child, "name");
+    if (name === undefined) {
+        return;
+    }
+    const tag = nodeTag(child);
+    if (tag === "command") {
+        commands.push(name);
+    }
+    else if (tag === "enum") {
+        enums.push(name);
+    }
+};
+const parseInterfaceBlock = (node) => {
+    const commands = [];
+    const enums = [];
+    for (const child of nodeChildren(node)) {
+        collectInterfaceMember(child, commands, enums);
+    }
+    const profile = nodeAttr(node, "profile");
+    return {
+        ...((profile !== undefined) && { profile }),
+        commands,
+        enums,
+    };
+};
+const collectFeatureBlock = (child, requires, removes) => {
+    const tag = nodeTag(child);
+    if (tag === "require") {
+        requires.push(parseInterfaceBlock(child));
+    }
+    else if (tag === "remove") {
+        removes.push(parseInterfaceBlock(child));
+    }
+};
+const parseFeature = (node) => {
+    const api = nodeAttr(node, "api");
+    const name = nodeAttr(node, "name");
+    const number = nodeAttr(node, "number");
+    if (api === undefined || name === undefined || number === undefined) {
+        return undefined;
+    }
+    const requires = [];
+    const removes = [];
+    for (const child of nodeChildren(node)) {
+        collectFeatureBlock(child, requires, removes);
+    }
+    return { api, name, number: Number(number), requires, removes };
+};
+const addCommand = (child, into) => {
+    if (nodeTag(child) !== "command") {
+        return;
+    }
+    const command = parseCommand(child);
+    if (command !== undefined && command.name.length > 0) {
+        into.set(command.name, command);
+    }
+};
+const parseCommandsSection = (section, into) => {
+    for (const child of nodeChildren(section)) {
+        addCommand(child, into);
+    }
+};
+const parseSection = (section, registry) => {
+    const tag = nodeTag(section);
+    if (tag === "commands") {
+        parseCommandsSection(section, registry.commands);
+        return;
+    }
+    if (tag === "enums") {
+        parseEnums(section, registry.enums);
+        return;
+    }
+    if (tag !== "feature") {
+        return;
+    }
+    const feature = parseFeature(section);
+    if (feature !== undefined) {
+        registry.features.push(feature);
+    }
+};
+const loadGlRegistry = (path) => {
+    const registry = { commands: new Map(), enums: [], features: [] };
+    for (const section of parseRegistryFile(path)) {
+        parseSection(section, registry);
+    }
+    return registry;
+};
+export { loadGlRegistry, };
+//# sourceMappingURL=model.js.map

package/dist/khronos/model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.js","sourceRoot":"","sources":["../../src/khronos/model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAoB,iBAAiB,EAAE,MAAM,YAAY,CAAC;AA2C/G,MAAM,QAAQ,GAAG,MAAM,CAAC;AACxB,MAAM,cAAc,GAAgB,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;AAEnE,MAAM,mBAAmB,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AAE1F,MAAM,UAAU,GAAG,CAAC,IAAiB,EAAE,GAAW,EAA2B,EAAE;IAC3E,KAAK,MAAM,KAAK,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IAED,OAAO,SAAS,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,IAAiB,EAAU,EAAE;IAC9C,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAE7C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,EAAE,CAAC;IACd,CAAC;IAED,OAAO,mBAAmB,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC;AAClE,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,IAAiB,EAAW,EAAE;IAC9C,MAAM,KAAK,GAAY;QACnB,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC;QACvB,KAAK,EAAE,mBAAmB,CAAC,WAAW,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;KAChE,CAAC;IAEF,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtC,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAClC,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAE5C,OAAO;QACH,GAAG,KAAK;QACR,GAAG,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;QACvC,GAAG,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC;QACnC,GAAG,CAAC,CAAC,WAAW,KAAK,SAAS,CAAC,IAAI,EAAE,WAAW,EAAE,CAAC;KACtD,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,IAAiB,EAAyB,EAAE;IAC9D,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAExC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,MAAM,GAAc,EAAE,CAAC;IAE7B,KAAK,MAAM,KAAK,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,OAAO,EAAE,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;QACnC,CAAC;IACL,CAAC;IAED,MAAM,WAAW,GAAG,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAE7C,OAAO;QACH,IAAI,EAAE,WAAW,CAAC,KAAK,CAAC;QACxB,WAAW,EAAE,mBAAmB,CAAC,WAAW,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QACpE,GAAG,CAAC,CAAC,WAAW,KAAK,SAAS,CAAC,IAAI,EAAE,WAAW,EAAE,CAAC;QACnD,MAAM;KACT,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,KAAkB,EAAsB,EAAE;IACzD,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,MAAM,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAEvC,IAAI,IAAI,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC5C,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAEvC,OAAO;QACH,IAAI;QACJ,KAAK;QACL,MAAM,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;KACjF,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,IAAiB,EAAE,IAAc,EAAQ,EAAE;IAC3D,KAAK,MAAM,KAAK,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;QAEhC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACvB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtB,CAAC;IACL,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,KAAkB,EAAE,QAAkB,EAAE,KAAe,EAAQ,EAAE;IAC7F,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAErC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO;IACX,CAAC;IAED,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAE3B,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACpB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;SAAM,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,IAAiB,EAAoB,EAAE;IAChE,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,MAAM,KAAK,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,sBAAsB,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAE1C,OAAO;QACH,GAAG,CAAC,CAAC,OAAO,KAAK,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC;QAC3C,QAAQ;QACR,KAAK;KACR,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,KAAkB,EAAE,QAA4B,EAAE,OAA2B,EAAQ,EAAE;IAChH,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAE3B,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACpB,QAAQ,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9C,CAAC;SAAM,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC1B,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,IAAiB,EAAyB,EAAE;IAC9D,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAClC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACpC,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAExC,IAAI,GAAG,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAClE,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,QAAQ,GAAuB,EAAE,CAAC;IACxC,MAAM,OAAO,GAAuB,EAAE,CAAC;IAEvC,KAAK,MAAM,KAAK,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,mBAAmB,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AACpE,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,KAAkB,EAAE,IAA4B,EAAQ,EAAE;IAC1E,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO;IACX,CAAC;IAED,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IAEpC,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnD,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACpC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,OAAoB,EAAE,IAA4B,EAAQ,EAAE;IACtF,KAAK,MAAM,KAAK,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;QACxC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,OAAoB,EAAE,QAAoB,EAAQ,EAAE;IACtE,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE7B,IAAI,GAAG,KAAK,UAAU,EAAE,CAAC;QACrB,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEjD,OAAO;IACX,CAAC;IAED,IAAI,GAAG,KAAK,OAAO,EAAE,CAAC;QAClB,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;QAEpC,OAAO;IACX,CAAC;IAED,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACpB,OAAO;IACX,CAAC;IAED,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACxB,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAc,EAAE;IAChD,MAAM,QAAQ,GAAe,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAqB,EAAE,KAAK,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAEjG,KAAK,MAAM,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5C,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED,OAAO,QAAQ,CAAC;AACpB,CAAC,CAAC;AAEF,OAAO,EACH,cAAc,GAOjB,CAAC","sourcesContent":["import { collectText, nodeAttr, nodeChildren, nodeTag, type OrderedNode, parseRegistryFile } from \"./parse.js\";\n\ntype GlParam = {\n    name: string;\n    cType: string;\n    group?: string;\n    len?: string;\n    objectClass?: string;\n};\n\ntype GlCommand = {\n    name: string;\n    returnCType: string;\n    returnGroup?: string;\n    params: GlParam[];\n};\n\ntype GlEnum = {\n    name: string;\n    value: string;\n    groups: string[];\n};\n\ntype GlInterfaceBlock = {\n    profile?: string;\n    commands: string[];\n    enums: string[];\n};\n\ntype GlFeature = {\n    api: string;\n    name: string;\n    number: number;\n    requires: GlInterfaceBlock[];\n    removes: GlInterfaceBlock[];\n};\n\ntype GlRegistry = {\n    commands: Map<string, GlCommand>;\n    enums: GlEnum[];\n    features: GlFeature[];\n};\n\nconst NAME_TAG = \"name\";\nconst SKIP_IN_C_TYPE: Set<string> = new Set([NAME_TAG, \"comment\"]);\n\nconst normalizeWhitespace = (text: string): string => text.replaceAll(/\\s+/g, \" \").trim();\n\nconst childNamed = (node: OrderedNode, tag: string): OrderedNode | undefined => {\n    for (const child of nodeChildren(node)) {\n        if (nodeTag(child) === tag) {\n            return child;\n        }\n    }\n\n    return undefined;\n};\n\nconst elementName = (node: OrderedNode): string => {\n    const nameChild = childNamed(node, NAME_TAG);\n\n    if (nameChild === undefined) {\n        return \"\";\n    }\n\n    return normalizeWhitespace(collectText(nameChild, new Set()));\n};\n\nconst parseParam = (node: OrderedNode): GlParam => {\n    const param: GlParam = {\n        name: elementName(node),\n        cType: normalizeWhitespace(collectText(node, SKIP_IN_C_TYPE)),\n    };\n\n    const group = nodeAttr(node, \"group\");\n    const len = nodeAttr(node, \"len\");\n    const objectClass = nodeAttr(node, \"class\");\n\n    return {\n        ...param,\n        ...((group !== undefined) && { group }),\n        ...((len !== undefined) && { len }),\n        ...((objectClass !== undefined) && { objectClass }),\n    };\n};\n\nconst parseCommand = (node: OrderedNode): GlCommand | undefined => {\n    const proto = childNamed(node, \"proto\");\n\n    if (proto === undefined) {\n        return undefined;\n    }\n\n    const params: GlParam[] = [];\n\n    for (const child of nodeChildren(node)) {\n        if (nodeTag(child) === \"param\") {\n            params.push(parseParam(child));\n        }\n    }\n\n    const returnGroup = nodeAttr(proto, \"group\");\n\n    return {\n        name: elementName(proto),\n        returnCType: normalizeWhitespace(collectText(proto, SKIP_IN_C_TYPE)),\n        ...((returnGroup !== undefined) && { returnGroup }),\n        params,\n    };\n};\n\nconst parseEnum = (child: OrderedNode): GlEnum | undefined => {\n    if (nodeTag(child) !== \"enum\") {\n        return undefined;\n    }\n\n    const name = nodeAttr(child, \"name\");\n    const value = nodeAttr(child, \"value\");\n\n    if (name === undefined || value === undefined) {\n        return undefined;\n    }\n\n    const group = nodeAttr(child, \"group\");\n\n    return {\n        name,\n        value,\n        groups: group === undefined ? [] : group.split(\",\").map((part) => part.trim()),\n    };\n};\n\nconst parseEnums = (node: OrderedNode, into: GlEnum[]): void => {\n    for (const child of nodeChildren(node)) {\n        const parsed = parseEnum(child);\n\n        if (parsed !== undefined) {\n            into.push(parsed);\n        }\n    }\n};\n\nconst collectInterfaceMember = (child: OrderedNode, commands: string[], enums: string[]): void => {\n    const name = nodeAttr(child, \"name\");\n\n    if (name === undefined) {\n        return;\n    }\n\n    const tag = nodeTag(child);\n\n    if (tag === \"command\") {\n        commands.push(name);\n    } else if (tag === \"enum\") {\n        enums.push(name);\n    }\n};\n\nconst parseInterfaceBlock = (node: OrderedNode): GlInterfaceBlock => {\n    const commands: string[] = [];\n    const enums: string[] = [];\n\n    for (const child of nodeChildren(node)) {\n        collectInterfaceMember(child, commands, enums);\n    }\n\n    const profile = nodeAttr(node, \"profile\");\n\n    return {\n        ...((profile !== undefined) && { profile }),\n        commands,\n        enums,\n    };\n};\n\nconst collectFeatureBlock = (child: OrderedNode, requires: GlInterfaceBlock[], removes: GlInterfaceBlock[]): void => {\n    const tag = nodeTag(child);\n\n    if (tag === \"require\") {\n        requires.push(parseInterfaceBlock(child));\n    } else if (tag === \"remove\") {\n        removes.push(parseInterfaceBlock(child));\n    }\n};\n\nconst parseFeature = (node: OrderedNode): GlFeature | undefined => {\n    const api = nodeAttr(node, \"api\");\n    const name = nodeAttr(node, \"name\");\n    const number = nodeAttr(node, \"number\");\n\n    if (api === undefined || name === undefined || number === undefined) {\n        return undefined;\n    }\n\n    const requires: GlInterfaceBlock[] = [];\n    const removes: GlInterfaceBlock[] = [];\n\n    for (const child of nodeChildren(node)) {\n        collectFeatureBlock(child, requires, removes);\n    }\n\n    return { api, name, number: Number(number), requires, removes };\n};\n\nconst addCommand = (child: OrderedNode, into: Map<string, GlCommand>): void => {\n    if (nodeTag(child) !== \"command\") {\n        return;\n    }\n\n    const command = parseCommand(child);\n\n    if (command !== undefined && command.name.length > 0) {\n        into.set(command.name, command);\n    }\n};\n\nconst parseCommandsSection = (section: OrderedNode, into: Map<string, GlCommand>): void => {\n    for (const child of nodeChildren(section)) {\n        addCommand(child, into);\n    }\n};\n\nconst parseSection = (section: OrderedNode, registry: GlRegistry): void => {\n    const tag = nodeTag(section);\n\n    if (tag === \"commands\") {\n        parseCommandsSection(section, registry.commands);\n\n        return;\n    }\n\n    if (tag === \"enums\") {\n        parseEnums(section, registry.enums);\n\n        return;\n    }\n\n    if (tag !== \"feature\") {\n        return;\n    }\n\n    const feature = parseFeature(section);\n\n    if (feature !== undefined) {\n        registry.features.push(feature);\n    }\n};\n\nconst loadGlRegistry = (path: string): GlRegistry => {\n    const registry: GlRegistry = { commands: new Map<string, GlCommand>(), enums: [], features: [] };\n\n    for (const section of parseRegistryFile(path)) {\n        parseSection(section, registry);\n    }\n\n    return registry;\n};\n\nexport {\n    loadGlRegistry,\n    type GlParam,\n    type GlCommand,\n    type GlEnum,\n    type GlInterfaceBlock,\n    type GlFeature,\n    type GlRegistry,\n};\n"]}

package/dist/khronos/modules.d.ts

@@ -0,0 +1,12 @@
+import type { GlEnum } from "./model.js";
+import type { RenderedCommand } from "./render.js";
+declare const renderEnumsModule: (tokens: {
+    token: GlEnum;
+    exportName: string;
+    literal: string;
+    feature: string;
+}[]) => string;
+declare const renderTypesModule: (groupAliases: Map<string, string>) => string;
+declare const renderCommandsModule: (rendered: RenderedCommand[], singulars: RenderedCommand[], usedTypes: Set<string>) => string;
+export { renderEnumsModule, renderTypesModule, renderCommandsModule };
+//# sourceMappingURL=modules.d.ts.map

package/dist/khronos/modules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modules.d.ts","sourceRoot":"","sources":["../../src/khronos/modules.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAcnD,QAAA,MAAM,iBAAiB,GACnB,QAAQ;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,EAAE,KAClF,MAaF,CAAC;AAEF,QAAA,MAAM,iBAAiB,GAAI,cAAc,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,KAAG,MAsC9D,CAAC;AA0BF,QAAA,MAAM,oBAAoB,GACtB,UAAU,eAAe,EAAE,EAC3B,WAAW,eAAe,EAAE,EAC5B,WAAW,GAAG,CAAC,MAAM,CAAC,KACvB,MAWF,CAAC;AAEF,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,CAAC"}

package/dist/khronos/modules.js

@@ -0,0 +1,73 @@
+import { sortStrings, sortStringsBy } from "@gtkx/utils";
+import { ModuleBuilder } from "../writer/module.js";
+import { GL_SCALARS } from "./plan.js";
+const LIB_CONSTANT = "export const LIB = \"libGL.so.1\";";
+const GENERATED_HEADER = `/**
+ * GENERATED FILE: do not edit.
+ */`;
+const TS_PRIMITIVES = new Set(["boolean", "string", "void", "number"]);
+const quotedGroupList = (groups) => groups.map((group) => `\`${group}\``).join(", ");
+const renderEnumsModule = (tokens) => {
+    const builder = new ModuleBuilder();
+    for (const { token, exportName, literal, feature } of tokens) {
+        const groupNote = token.groups.length > 0 ? ` Groups: ${quotedGroupList(token.groups)}.` : "";
+        builder.appendDeclaration(`/** \`${token.name}\`, provided by \`${feature}\`.${groupNote} */\n` +
+            `export const ${exportName} = ${literal};`);
+    }
+    return `${GENERATED_HEADER}\n\n${builder.toSource()}`;
+};
+const renderTypesModule = (groupAliases) => {
+    const builder = new ModuleBuilder();
+    builder.imports.addNamed("@gtkx/native", "ExternalObject", true);
+    builder.imports.addNamed("@gtkx/native", "Handle", true);
+    builder.appendDeclaration("/** An opaque `GLsync` fence handle. */\nexport type GLsync = ExternalObject<Handle>;");
+    builder.appendDeclaration("/** An opaque native pointer handle (e.g. a `glMapBufferRange` mapping). */\n" +
+        "export type GLpointer = ExternalObject<Handle>;");
+    const seen = new Set();
+    for (const scalar of GL_SCALARS.values()) {
+        if (seen.has(scalar.tsAlias)) {
+            continue;
+        }
+        seen.add(scalar.tsAlias);
+        builder.appendDeclaration(`/** The C \`${scalar.tsAlias}\` scalar. */\nexport type ${scalar.tsAlias} = number;`);
+    }
+    const sortedAliases = sortStringsBy(groupAliases.entries(), ([key]) => key);
+    for (const [group, base] of sortedAliases) {
+        builder.appendDeclaration(`/** Registry enum group \`${group}\`; open and documentation-only, ` +
+            `any \`${base}\` value is accepted. */\nexport type ${group} = ${base};`);
+    }
+    return `${GENERATED_HEADER}\n\n${builder.toSource()}`;
+};
+const appendTypeImports = (builder, usedTypes) => {
+    for (const alias of sortStrings(usedTypes)) {
+        if (TS_PRIMITIVES.has(alias)) {
+            continue;
+        }
+        builder.imports.addNamed("./types.js", alias, true);
+    }
+};
+const appendCommandBindings = (builder, commands) => {
+    for (const command of commands) {
+        if (command.binding !== undefined) {
+            builder.appendBinding(command.binding, command.binding);
+        }
+    }
+};
+const appendCommandDeclarations = (builder, commands) => {
+    for (const command of commands) {
+        builder.appendDeclaration(command.declaration);
+    }
+};
+const renderCommandsModule = (rendered, singulars, usedTypes) => {
+    const builder = new ModuleBuilder();
+    builder.imports.addNamed("@gtkx/runtime", "t");
+    appendTypeImports(builder, usedTypes);
+    builder.appendBinding(LIB_CONSTANT);
+    appendCommandBindings(builder, rendered);
+    appendCommandBindings(builder, singulars);
+    appendCommandDeclarations(builder, rendered);
+    appendCommandDeclarations(builder, singulars);
+    return `${GENERATED_HEADER}\n\n${builder.toSource()}`;
+};
+export { renderEnumsModule, renderTypesModule, renderCommandsModule };
+//# sourceMappingURL=modules.js.map