@gtkx/codegen 1.0.0-rc.4 → 1.1.0

package/dist/khronos/extensions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extensions.js","sourceRoot":"","sources":["../../src/khronos/extensions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAqB1C,MAAM,cAAc,GAAgB,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;AAE9D,MAAM,oBAAoB,GAAG,CAAC,SAAsB,EAAW,EAAE,CAC7D,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;AAE/D,MAAM,eAAe,GAAG,CAAC,KAAuB,EAAE,SAAsB,EAAW,EAAE,CACjF,KAAK,CAAC,IAAI,KAAK,SAAS;IACxB,CAAC,KAAK,CAAC,GAAG,KAAK,SAAS,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,CAAC,GAAG,CAAC;IACxD,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC;AAEzE,MAAM,UAAU,GAAG,CAAC,SAAsB,EAAE,KAAuB,EAAY,EAAE,CAAC;IAC9E,GAAG,CAAC,SAAS,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC/D,GAAG,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;CAC1D,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,KAAmB,EAAE,KAAe,EAAE,SAAiB,EAAE,KAAe,EAAQ,EAAE;IACrG,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,EAAoB,CAAC;QACnE,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;QAC9E,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IACjC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,KAA4B,EAAE,SAAsB,EAAE,SAAsB,EAAQ,EAAE;IAC1G,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;QACnC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC;YACrC,SAAS;QACb,CAAC;QAED,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAC3C,aAAa,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACrE,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACnE,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,WAAkC,EAA4B,EAAE,CACrF,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC3C,IAAI;IACJ,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;CAC7C,CAAC,CAAC,CAAC;AAER,MAAM,aAAa,GAAG,CAAC,OAAqB,EAAyC,EAAE;IACnF,MAAM,KAAK,GAA0C,IAAI,GAAG,EAAE,CAAC;IAE/D,KAAK,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,OAAO,EAAE,CAAC;QACxC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC;IAClD,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,QAAoB,EAAE,SAAsB,EAAoB,EAAE;IAC3F,MAAM,OAAO,GAA0B,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAE,EAAE,KAAK,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;IAEjF,KAAK,MAAM,SAAS,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;QAC1C,IAAI,oBAAoB,CAAC,SAAS,CAAC,EAAE,CAAC;YAClC,cAAc,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QAClD,CAAC;IACL,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;AAC9F,CAAC,CAAC;AAEF,OAAO,EAAE,mBAAmB,EAAsD,CAAC","sourcesContent":["import { sortStrings } from \"@gtkx/utils\";\nimport type { GlExtension, GlInterfaceBlock, GlRegistry } from \"./model.js\";\nimport type { GlSelection } from \"./select.js\";\n\ntype GlExtensionAttribution = {\n    name: string;\n    notes: string[];\n};\n\ntype GlExtensionIndex = {\n    commands: Map<string, GlExtensionAttribution[]>;\n    enums: Map<string, GlExtensionAttribution[]>;\n};\n\ntype PendingIndex = Map<string, Map<string, string[]>>;\n\ntype PendingExtensionIndex = {\n    commands: PendingIndex;\n    enums: PendingIndex;\n};\n\nconst SUPPORTED_APIS: Set<string> = new Set([\"gl\", \"glcore\"]);\n\nconst isExtensionSupported = (extension: GlExtension): boolean =>\n    extension.supported.some((api) => SUPPORTED_APIS.has(api));\n\nconst isBlockIncluded = (block: GlInterfaceBlock, selection: GlSelection): boolean =>\n    block.kind === \"require\" &&\n    (block.api === undefined || block.api === selection.api) &&\n    (block.profile === undefined || block.profile === selection.profile);\n\nconst blockNotes = (extension: GlExtension, block: GlInterfaceBlock): string[] => [\n    ...(extension.comment === undefined ? [] : [extension.comment]),\n    ...(block.comment === undefined ? [] : [block.comment]),\n];\n\nconst appendMembers = (index: PendingIndex, names: string[], extension: string, notes: string[]): void => {\n    for (const name of names) {\n        const byExtension = index.get(name) ?? new Map<string, string[]>();\n        byExtension.set(extension, [...(byExtension.get(extension) ?? []), ...notes]);\n        index.set(name, byExtension);\n    }\n};\n\nconst indexExtension = (index: PendingExtensionIndex, extension: GlExtension, selection: GlSelection): void => {\n    for (const block of extension.blocks) {\n        if (!isBlockIncluded(block, selection)) {\n            continue;\n        }\n\n        const notes = blockNotes(extension, block);\n        appendMembers(index.commands, block.commands, extension.name, notes);\n        appendMembers(index.enums, block.enums, extension.name, notes);\n    }\n};\n\nconst attributionsFor = (byExtension: Map<string, string[]>): GlExtensionAttribution[] =>\n    sortStrings(byExtension.keys()).map((name) => ({\n        name,\n        notes: [...new Set(byExtension.get(name))],\n    }));\n\nconst finalizeIndex = (pending: PendingIndex): Map<string, GlExtensionAttribution[]> => {\n    const index: Map<string, GlExtensionAttribution[]> = new Map();\n\n    for (const [name, byExtension] of pending) {\n        index.set(name, attributionsFor(byExtension));\n    }\n\n    return index;\n};\n\nconst buildExtensionIndex = (registry: GlRegistry, selection: GlSelection): GlExtensionIndex => {\n    const pending: PendingExtensionIndex = { commands: new Map(), enums: new Map() };\n\n    for (const extension of registry.extensions) {\n        if (isExtensionSupported(extension)) {\n            indexExtension(pending, extension, selection);\n        }\n    }\n\n    return { commands: finalizeIndex(pending.commands), enums: finalizeIndex(pending.enums) };\n};\n\nexport { buildExtensionIndex, type GlExtensionAttribution, type GlExtensionIndex };\n"]}

package/dist/khronos/jsdoc.d.ts

@@ -1,21 +1,27 @@
 import type { InArg, OutArg } from "./args.js";
+import type { GlDocContext } from "./doc-context.js";
 import type { GlCommand } from "./model.js";
-import type { ReturnPlan } from "./plan.js";
+import type { CommandPlan } from "./plan.js";
+import type { GlSymbolProvenance } from "./select.js";
+type OkPlan = CommandPlan & {
+    isOk: true;
+};
 type CommandJsDocOptions = {
-    command: GlCommand;
-    feature: string;
+    plan: OkPlan;
+    provenance: GlSymbolProvenance;
     ins: InArg[];
     outs: OutArg[];
-    returnPlan: ReturnPlan;
+    docs: GlDocContext;
 };
-type SingularJsDocOptions = {
-    commandName: string;
-    feature: string;
+type DerivedJsDocOptions = {
+    command: GlCommand;
+    provenance: GlSymbolProvenance;
     summary: string;
     body: string[];
+    docs: GlDocContext;
 };
-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 };
+declare const inParamDocLine: (plan: OkPlan, arg: InArg, docs: GlDocContext) => string;
+declare const derivedJsDoc: ({ command, provenance, summary, body, docs }: DerivedJsDocOptions) => string;
+declare const commandJsDoc: ({ plan, provenance, ins, outs, docs }: CommandJsDocOptions) => string;
+export { commandJsDoc, derivedJsDoc, inParamDocLine };
 //# sourceMappingURL=jsdoc.d.ts.map

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

@@ -1 +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"}
+{"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,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAkB,MAAM,YAAY,CAAC;AAC5D,OAAO,KAAK,EAAE,WAAW,EAAyB,MAAM,WAAW,CAAC;AACpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AActD,KAAK,MAAM,GAAG,WAAW,GAAG;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC;AAO3C,KAAK,mBAAmB,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,kBAAkB,CAAC;IAC/B,GAAG,EAAE,KAAK,EAAE,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,IAAI,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF,KAAK,mBAAmB,GAAG;IACvB,OAAO,EAAE,SAAS,CAAC;IACnB,UAAU,EAAE,kBAAkB,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,IAAI,EAAE,YAAY,CAAC;CACtB,CAAC;AA8FF,QAAA,MAAM,cAAc,GAAI,MAAM,MAAM,EAAE,KAAK,KAAK,EAAE,MAAM,YAAY,KAAG,MAYtE,CAAC;AAiCF,QAAA,MAAM,YAAY,GAAI,8CAA8C,mBAAmB,KAAG,MAQ1E,CAAC;AAEjB,QAAA,MAAM,YAAY,GAAI,uCAAuC,mBAAmB,KAAG,MAkBlF,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC"}

package/dist/khronos/jsdoc.js

@@ -1,72 +1,130 @@
 import { toCamelIdentifier } from "@gtkx/utils";
-const REFPAGES_BASE = "https://registry.khronos.org/OpenGL-Refpages/gl4/html";
+import { returnPlanTsType, scalarAliasOrGroup } from "./args.js";
+import { asSentence, backtick, backtickList, commandExportName, kindDescriptions, metadataNotes, provenanceLines, } from "./notes.js";
+import { paramPairAt } from "./param-pair.js";
+const GROUPED_PLAN_KINDS = new Set(["scalar", "array-in", "ref-out", "ref-array-out"]);
+const LENGTHLESS_PLAN_KINDS = new Set(["byte-offset", "byte-offset-array", "ref-out"]);
+const OFFSET_NOTES = new Map([
+    ["byte-offset", "byte offset into the bound buffer"],
+    ["byte-offset-array", "byte offsets into the bound buffer"],
+]);
 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}\``);
+const glxLine = (glx) => {
+    const opcode = ` * GLX ${glx.type} opcode ${glx.opcode}.`;
+    return glx.comment === undefined ? opcode : `${opcode} ${asSentence(glx.comment)}`;
+};
+const aliasLine = (aliases) => ` * Also known as ${backtickList(aliases)}.`;
+const vectorFormLines = (command, docs) => {
+    const target = command.vecEquiv;
+    if (target === undefined || !docs.emittedCommands.has(target)) {
+        return [];
     }
-    return ` * @param ${arg.name} - ${notes.join(", ")}`;
+    return [` * Vector form: ${backtick(commandExportName(target))}.`];
+};
+const commandNotes = (command, docs) => {
+    const aliases = docs.aliasTargets.get(command.name) ?? [];
+    return [
+        ...(command.comment === undefined ? [] : [` * Registry note: ${command.comment}`]),
+        ...(aliases.length > 0 ? [aliasLine(aliases)] : []),
+        ...vectorFormLines(command, docs),
+        ...(command.glx === undefined ? [] : [glxLine(command.glx)]),
+    ];
+};
+const isGroupFolded = (plan, group) => GROUPED_PLAN_KINDS.has(plan.kind) &&
+    "scalar" in plan &&
+    scalarAliasOrGroup(plan.scalar, group) !== plan.scalar.tsAlias;
+const groupEntry = (param, paramPlan) => param.group === undefined || isGroupFolded(paramPlan, param.group) ? {} : { group: param.group };
+const lengthEntry = (param, paramPlan) => param.len === undefined || LENGTHLESS_PLAN_KINDS.has(paramPlan.kind) ? {} : { len: param.len };
+const paramShape = (param, paramPlan, type) => {
+    const note = OFFSET_NOTES.get(paramPlan.kind);
+    return {
+        type,
+        ...groupEntry(param, paramPlan),
+        ...lengthEntry(param, paramPlan),
+        ...(param.objectClass !== undefined && { objectClass: param.objectClass }),
+        ...(note !== undefined && { note }),
+        kinds: param.kinds,
+    };
 };
-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}`);
+const returnShape = (plan) => {
+    const { command, returnPlan } = plan;
+    const group = command.returnGroup;
+    return {
+        type: returnPlanTsType(returnPlan, group),
+        ...(group !== undefined && !isGroupFolded(returnPlan, group) && { group }),
+        ...(command.returnObjectClass !== undefined && { objectClass: command.returnObjectClass }),
+        kinds: command.returnKinds,
+    };
+};
+const paramPairFor = (plan, argName) => {
+    const index = plan.command.params.findIndex((candidate) => toCamelIdentifier(candidate.name) === argName);
+    const { param, paramPlan } = paramPairAt(plan, index);
+    if (param === undefined || paramPlan === undefined) {
+        return undefined;
     }
-    return `\`${param.name}\` (\`${param.cType}\`)`;
+    return { param, paramPlan };
 };
-const returnsDocLine = (command, returnPlan, outs) => {
-    const members = [];
-    if (returnPlan.kind !== "void") {
-        members.push(`\`${command.returnCType}\``);
+const inParamDocLine = (plan, arg, docs) => {
+    const pair = paramPairFor(plan, arg.name);
+    if (pair === undefined) {
+        return ` * @param ${arg.name}`;
     }
-    for (const out of outs) {
-        members.push(outMember(command, out));
+    const descriptions = kindDescriptions(pair.param.kinds, docs.kinds);
+    const sentence = descriptions.length === 0 ? "" : `. ${descriptions}`;
+    const notes = metadataNotes(paramShape(pair.param, pair.paramPlan, arg.tsType));
+    return ` * @param ${arg.name} - ${notes}${sentence}`;
+};
+const outMember = (plan, out) => {
+    const { param, paramPlan } = paramPairAt(plan, out.paramIndex);
+    if (param === undefined || paramPlan === undefined) {
+        throw new Error(`Output parameter index ${String(out.paramIndex)} out of range on ${plan.command.name}`);
     }
-    if (members.length === 0) {
+    return `${backtick(param.name)} (${metadataNotes(paramShape(param, paramPlan, out.tsType))})`;
+};
+const returnsDocLine = (plan, outs) => {
+    const members = [
+        ...(plan.returnPlan.kind === "void" ? [] : [metadataNotes(returnShape(plan))]),
+        ...outs.map((out) => outMember(plan, out)),
+    ];
+    const [single] = members;
+    if (single === undefined) {
         return undefined;
     }
-    const [single] = members;
-    if (single !== undefined && members.length === 1) {
+    if (members.length === 1) {
         return ` * @returns ${single}`;
     }
     return ` * @returns Tuple of ${members.join(", ")}`;
 };
-const singularJsDoc = ({ commandName, feature, summary, body }) => [
+const tagBlock = (tags) => (tags.length === 0 ? [] : [" *", ...tags]);
+const derivedJsDoc = ({ command, provenance, summary, body, docs }) => [
     "/**",
     ` * ${summary}`,
     " *",
-    ` * Provided by \`${feature}\`.`,
-    ...body,
-    ` * @see ${REFPAGES_BASE}/${commandName}.xhtml`,
+    ...provenanceLines(provenance, docs.extensionCommands.get(command.name) ?? []),
+    ...tagBlock(body),
     " */",
 ].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]),
-        ],
-    });
+const commandJsDoc = ({ plan, provenance, ins, outs, docs }) => {
+    const { command } = plan;
+    const returnsLine = returnsDocLine(plan, outs);
+    const tags = [
+        ...ins.map((arg) => inParamDocLine(plan, arg, docs)),
+        ...(returnsLine === undefined ? [] : [returnsLine]),
+    ];
+    return [
+        "/**",
+        ` * ${backtick(formatPrototype(command))}`,
+        " *",
+        ...provenanceLines(provenance, docs.extensionCommands.get(command.name) ?? []),
+        ...commandNotes(command, docs),
+        ...tagBlock(tags),
+        " */",
+    ].join("\n");
 };
-export { inParamDocLine, singularJsDoc, commandJsDoc };
+export { commandJsDoc, derivedJsDoc, inParamDocLine };
 //# sourceMappingURL=jsdoc.js.map

package/dist/khronos/jsdoc.js.map

@@ -1 +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"]}
+{"version":3,"file":"jsdoc.js","sourceRoot":"","sources":["../../src/khronos/jsdoc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAMhD,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AACjE,OAAO,EACH,UAAU,EACV,QAAQ,EACR,YAAY,EACZ,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EAEb,eAAe,GAClB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAyB9C,MAAM,kBAAkB,GAAgB,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC,CAAC;AACpG,MAAM,qBAAqB,GAAgB,IAAI,GAAG,CAAC,CAAC,aAAa,EAAE,mBAAmB,EAAE,SAAS,CAAC,CAAC,CAAC;AAEpG,MAAM,YAAY,GAAwB,IAAI,GAAG,CAAC;IAC9C,CAAC,aAAa,EAAE,mCAAmC,CAAC;IACpD,CAAC,mBAAmB,EAAE,oCAAoC,CAAC;CAC9D,CAAC,CAAC;AAEH,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,OAAO,GAAG,CAAC,GAAU,EAAU,EAAE;IACnC,MAAM,MAAM,GAAG,UAAU,GAAG,CAAC,IAAI,WAAW,GAAG,CAAC,MAAM,GAAG,CAAC;IAE1D,OAAO,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;AACvF,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,OAAiB,EAAU,EAAE,CAAC,oBAAoB,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC;AAE9F,MAAM,eAAe,GAAG,CAAC,OAAkB,EAAE,IAAkB,EAAY,EAAE;IACzE,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAEhC,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5D,OAAO,EAAE,CAAC;IACd,CAAC;IAED,OAAO,CAAC,mBAAmB,QAAQ,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;AACvE,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,OAAkB,EAAE,IAAkB,EAAY,EAAE;IACtE,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IAE1D,OAAO;QACH,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,qBAAqB,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;QAClF,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACnD,GAAG,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC;QACjC,GAAG,CAAC,OAAO,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;KAC/D,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,IAA4B,EAAE,KAAa,EAAW,EAAE,CAC3E,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC;IACjC,QAAQ,IAAI,IAAI;IAChB,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;AAEnE,MAAM,UAAU,GAAG,CAAC,KAAc,EAAE,SAAoB,EAAsB,EAAE,CAC5E,KAAK,CAAC,KAAK,KAAK,SAAS,IAAI,aAAa,CAAC,SAAS,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;AAErG,MAAM,WAAW,GAAG,CAAC,KAAc,EAAE,SAAoB,EAAoB,EAAE,CAC3E,KAAK,CAAC,GAAG,KAAK,SAAS,IAAI,qBAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC;AAEnG,MAAM,UAAU,GAAG,CAAC,KAAc,EAAE,SAAoB,EAAE,IAAY,EAAwB,EAAE;IAC5F,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAE9C,OAAO;QACH,IAAI;QACJ,GAAG,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC;QAC/B,GAAG,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC;QAChC,GAAG,CAAC,KAAK,CAAC,WAAW,KAAK,SAAS,IAAI,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC;QAC1E,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,IAAI,EAAE,CAAC;QACnC,KAAK,EAAE,KAAK,CAAC,KAAK;KACrB,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,IAAY,EAAwB,EAAE;IACvD,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IACrC,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC;IAElC,OAAO;QACH,IAAI,EAAE,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC;QACzC,GAAG,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;QAC1E,GAAG,CAAC,OAAO,CAAC,iBAAiB,KAAK,SAAS,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAC1F,KAAK,EAAE,OAAO,CAAC,WAAW;KAC7B,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,OAAe,EAAyB,EAAE;IAC1E,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,CAAC;IAC1G,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAEtD,IAAI,KAAK,KAAK,SAAS,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QACjD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;AAChC,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,GAAU,EAAE,IAAkB,EAAU,EAAE;IAC5E,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;IAE1C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,aAAa,GAAG,CAAC,IAAI,EAAE,CAAC;IACnC,CAAC;IAED,MAAM,YAAY,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IACpE,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,YAAY,EAAE,CAAC;IACtE,MAAM,KAAK,GAAG,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhF,OAAO,aAAa,GAAG,CAAC,IAAI,MAAM,KAAK,GAAG,QAAQ,EAAE,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,GAAW,EAAU,EAAE;IACpD,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC;IAE/D,IAAI,KAAK,KAAK,SAAS,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QACjD,MAAM,IAAI,KAAK,CAAC,0BAA0B,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,oBAAoB,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7G,CAAC;IAED,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,aAAa,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC;AAClG,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,IAAc,EAAsB,EAAE;IACxE,MAAM,OAAO,GAAG;QACZ,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC9E,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KAC7C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC;IAEzB,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,eAAe,MAAM,EAAE,CAAC;IACnC,CAAC;IAED,OAAO,wBAAwB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;AACxD,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,IAAc,EAAY,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;AAE1F,MAAM,YAAY,GAAG,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAuB,EAAU,EAAE,CAC/F;IACI,KAAK;IACL,MAAM,OAAO,EAAE;IACf,IAAI;IACJ,GAAG,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IAC9E,GAAG,QAAQ,CAAC,IAAI,CAAC;IACjB,KAAK;CACR,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEjB,MAAM,YAAY,GAAG,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAuB,EAAU,EAAE;IACxF,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IACzB,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAE/C,MAAM,IAAI,GAAG;QACT,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACpD,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;KACtD,CAAC;IAEF,OAAO;QACH,KAAK;QACL,MAAM,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,EAAE;QAC1C,IAAI;QACJ,GAAG,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAC9E,GAAG,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC;QAC9B,GAAG,QAAQ,CAAC,IAAI,CAAC;QACjB,KAAK;KACR,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC","sourcesContent":["import { toCamelIdentifier } from \"@gtkx/utils\";\nimport type { InArg, OutArg } from \"./args.js\";\nimport type { GlDocContext } from \"./doc-context.js\";\nimport type { GlCommand, GlGlx, GlParam } from \"./model.js\";\nimport type { CommandPlan, ParamPlan, ReturnPlan } from \"./plan.js\";\nimport type { GlSymbolProvenance } from \"./select.js\";\nimport { returnPlanTsType, scalarAliasOrGroup } from \"./args.js\";\nimport {\n    asSentence,\n    backtick,\n    backtickList,\n    commandExportName,\n    kindDescriptions,\n    metadataNotes,\n    type MetadataNotesOptions,\n    provenanceLines,\n} from \"./notes.js\";\nimport { paramPairAt } from \"./param-pair.js\";\n\ntype OkPlan = CommandPlan & { isOk: true };\n\ntype ParamPair = {\n    param: GlParam;\n    paramPlan: ParamPlan;\n};\n\ntype CommandJsDocOptions = {\n    plan: OkPlan;\n    provenance: GlSymbolProvenance;\n    ins: InArg[];\n    outs: OutArg[];\n    docs: GlDocContext;\n};\n\ntype DerivedJsDocOptions = {\n    command: GlCommand;\n    provenance: GlSymbolProvenance;\n    summary: string;\n    body: string[];\n    docs: GlDocContext;\n};\n\nconst GROUPED_PLAN_KINDS: Set<string> = new Set([\"scalar\", \"array-in\", \"ref-out\", \"ref-array-out\"]);\nconst LENGTHLESS_PLAN_KINDS: Set<string> = new Set([\"byte-offset\", \"byte-offset-array\", \"ref-out\"]);\n\nconst OFFSET_NOTES: Map<string, string> = new Map([\n    [\"byte-offset\", \"byte offset into the bound buffer\"],\n    [\"byte-offset-array\", \"byte offsets into the bound buffer\"],\n]);\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 glxLine = (glx: GlGlx): string => {\n    const opcode = ` * GLX ${glx.type} opcode ${glx.opcode}.`;\n\n    return glx.comment === undefined ? opcode : `${opcode} ${asSentence(glx.comment)}`;\n};\n\nconst aliasLine = (aliases: string[]): string => ` * Also known as ${backtickList(aliases)}.`;\n\nconst vectorFormLines = (command: GlCommand, docs: GlDocContext): string[] => {\n    const target = command.vecEquiv;\n\n    if (target === undefined || !docs.emittedCommands.has(target)) {\n        return [];\n    }\n\n    return [` * Vector form: ${backtick(commandExportName(target))}.`];\n};\n\nconst commandNotes = (command: GlCommand, docs: GlDocContext): string[] => {\n    const aliases = docs.aliasTargets.get(command.name) ?? [];\n\n    return [\n        ...(command.comment === undefined ? [] : [` * Registry note: ${command.comment}`]),\n        ...(aliases.length > 0 ? [aliasLine(aliases)] : []),\n        ...vectorFormLines(command, docs),\n        ...(command.glx === undefined ? [] : [glxLine(command.glx)]),\n    ];\n};\n\nconst isGroupFolded = (plan: ParamPlan | ReturnPlan, group: string): boolean =>\n    GROUPED_PLAN_KINDS.has(plan.kind) &&\n    \"scalar\" in plan &&\n    scalarAliasOrGroup(plan.scalar, group) !== plan.scalar.tsAlias;\n\nconst groupEntry = (param: GlParam, paramPlan: ParamPlan): { group?: string } =>\n    param.group === undefined || isGroupFolded(paramPlan, param.group) ? {} : { group: param.group };\n\nconst lengthEntry = (param: GlParam, paramPlan: ParamPlan): { len?: string } =>\n    param.len === undefined || LENGTHLESS_PLAN_KINDS.has(paramPlan.kind) ? {} : { len: param.len };\n\nconst paramShape = (param: GlParam, paramPlan: ParamPlan, type: string): MetadataNotesOptions => {\n    const note = OFFSET_NOTES.get(paramPlan.kind);\n\n    return {\n        type,\n        ...groupEntry(param, paramPlan),\n        ...lengthEntry(param, paramPlan),\n        ...(param.objectClass !== undefined && { objectClass: param.objectClass }),\n        ...(note !== undefined && { note }),\n        kinds: param.kinds,\n    };\n};\n\nconst returnShape = (plan: OkPlan): MetadataNotesOptions => {\n    const { command, returnPlan } = plan;\n    const group = command.returnGroup;\n\n    return {\n        type: returnPlanTsType(returnPlan, group),\n        ...(group !== undefined && !isGroupFolded(returnPlan, group) && { group }),\n        ...(command.returnObjectClass !== undefined && { objectClass: command.returnObjectClass }),\n        kinds: command.returnKinds,\n    };\n};\n\nconst paramPairFor = (plan: OkPlan, argName: string): ParamPair | undefined => {\n    const index = plan.command.params.findIndex((candidate) => toCamelIdentifier(candidate.name) === argName);\n    const { param, paramPlan } = paramPairAt(plan, index);\n\n    if (param === undefined || paramPlan === undefined) {\n        return undefined;\n    }\n\n    return { param, paramPlan };\n};\n\nconst inParamDocLine = (plan: OkPlan, arg: InArg, docs: GlDocContext): string => {\n    const pair = paramPairFor(plan, arg.name);\n\n    if (pair === undefined) {\n        return ` * @param ${arg.name}`;\n    }\n\n    const descriptions = kindDescriptions(pair.param.kinds, docs.kinds);\n    const sentence = descriptions.length === 0 ? \"\" : `. ${descriptions}`;\n    const notes = metadataNotes(paramShape(pair.param, pair.paramPlan, arg.tsType));\n\n    return ` * @param ${arg.name} - ${notes}${sentence}`;\n};\n\nconst outMember = (plan: OkPlan, out: OutArg): string => {\n    const { param, paramPlan } = paramPairAt(plan, out.paramIndex);\n\n    if (param === undefined || paramPlan === undefined) {\n        throw new Error(`Output parameter index ${String(out.paramIndex)} out of range on ${plan.command.name}`);\n    }\n\n    return `${backtick(param.name)} (${metadataNotes(paramShape(param, paramPlan, out.tsType))})`;\n};\n\nconst returnsDocLine = (plan: OkPlan, outs: OutArg[]): string | undefined => {\n    const members = [\n        ...(plan.returnPlan.kind === \"void\" ? [] : [metadataNotes(returnShape(plan))]),\n        ...outs.map((out) => outMember(plan, out)),\n    ];\n\n    const [single] = members;\n\n    if (single === undefined) {\n        return undefined;\n    }\n\n    if (members.length === 1) {\n        return ` * @returns ${single}`;\n    }\n\n    return ` * @returns Tuple of ${members.join(\", \")}`;\n};\n\nconst tagBlock = (tags: string[]): string[] => (tags.length === 0 ? [] : [\" *\", ...tags]);\n\nconst derivedJsDoc = ({ command, provenance, summary, body, docs }: DerivedJsDocOptions): string =>\n    [\n        \"/**\",\n        ` * ${summary}`,\n        \" *\",\n        ...provenanceLines(provenance, docs.extensionCommands.get(command.name) ?? []),\n        ...tagBlock(body),\n        \" */\",\n    ].join(\"\\n\");\n\nconst commandJsDoc = ({ plan, provenance, ins, outs, docs }: CommandJsDocOptions): string => {\n    const { command } = plan;\n    const returnsLine = returnsDocLine(plan, outs);\n\n    const tags = [\n        ...ins.map((arg) => inParamDocLine(plan, arg, docs)),\n        ...(returnsLine === undefined ? [] : [returnsLine]),\n    ];\n\n    return [\n        \"/**\",\n        ` * ${backtick(formatPrototype(command))}`,\n        \" *\",\n        ...provenanceLines(provenance, docs.extensionCommands.get(command.name) ?? []),\n        ...commandNotes(command, docs),\n        ...tagBlock(tags),\n        \" */\",\n    ].join(\"\\n\");\n};\n\nexport { commandJsDoc, derivedJsDoc, inParamDocLine };\n"]}

package/dist/khronos/model.d.ts

@@ -4,20 +4,42 @@ type GlParam = {
     group?: string;
     len?: string;
     objectClass?: string;
+    kinds: string[];
+};
+type GlGlx = {
+    type: string;
+    opcode: string;
+    comment?: string;
 };
 type GlCommand = {
     name: string;
     returnCType: string;
     returnGroup?: string;
+    returnObjectClass?: string;
+    returnKinds: string[];
+    comment?: string;
+    aliasTarget?: string;
+    vecEquiv?: string;
+    glx?: GlGlx;
     params: GlParam[];
 };
 type GlEnum = {
     name: string;
     value: string;
     groups: string[];
+    comment?: string;
+    alias?: string;
+    api?: string;
+    valueType?: string;
+    vendor?: string;
+    blockComment?: string;
+    isBitmask: boolean;
 };
 type GlInterfaceBlock = {
+    kind: "require" | "remove";
+    api?: string;
     profile?: string;
+    comment?: string;
     commands: string[];
     enums: string[];
 };
@@ -25,14 +47,31 @@ type GlFeature = {
     api: string;
     name: string;
     number: number;
-    requires: GlInterfaceBlock[];
-    removes: GlInterfaceBlock[];
+    blocks: GlInterfaceBlock[];
+};
+type GlExtension = {
+    name: string;
+    supported: string[];
+    comment?: string;
+    blocks: GlInterfaceBlock[];
+};
+type GlType = {
+    name: string;
+    declaration: string;
+    requires?: string;
+    comment?: string;
 };
 type GlRegistry = {
+    comment?: string;
+    types: Map<string, GlType>;
+    kinds: Map<string, string>;
     commands: Map<string, GlCommand>;
     enums: GlEnum[];
     features: GlFeature[];
+    extensions: GlExtension[];
+    aliasTargets: Map<string, string[]>;
+    bitmaskGroups: Set<string>;
 };
 declare const loadGlRegistry: (path: string) => GlRegistry;
-export { loadGlRegistry, type GlParam, type GlCommand, type GlEnum, type GlInterfaceBlock, type GlFeature, type GlRegistry, };
+export { loadGlRegistry, type GlParam, type GlGlx, type GlCommand, type GlEnum, type GlInterfaceBlock, type GlFeature, type GlExtension, type GlType, type GlRegistry, };
 //# sourceMappingURL=model.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/khronos/model.ts"],"names":[],"mappings":"AAGA,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;IACrB,KAAK,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,KAAK,KAAK,GAAG;IACT,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,KAAK,SAAS,GAAG;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,KAAK,CAAC;IACZ,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;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,OAAO,CAAC;CACtB,CAAC;AASF,KAAK,gBAAgB,GAAG;IACpB,IAAI,EAAE,SAAS,GAAG,QAAQ,CAAC;IAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,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,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC9B,CAAC;AAEF,KAAK,WAAW,GAAG;IACf,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC9B,CAAC;AAEF,KAAK,MAAM,GAAG;IACV,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,KAAK,UAAU,GAAG;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3B,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACjC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,SAAS,EAAE,CAAC;IACtB,UAAU,EAAE,WAAW,EAAE,CAAC;IAC1B,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACpC,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CAC9B,CAAC;AAoYF,QAAA,MAAM,cAAc,GAAI,MAAM,MAAM,KAAG,UAmBtC,CAAC;AAEF,OAAO,EACH,cAAc,EACd,KAAK,OAAO,EACZ,KAAK,KAAK,EACV,KAAK,SAAS,EACd,KAAK,MAAM,EACX,KAAK,gBAAgB,EACrB,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,MAAM,EACX,KAAK,UAAU,GAClB,CAAC"}