@gtkx/codegen 1.0.0-rc.4 → 1.1.0

package/dist/analysis/interface-conflicts.js

@@ -0,0 +1,144 @@
+import { resolveClassOrInterface, resolveInterfaces } from "../gir/ancestry.js";
+import { isOutParameter } from "../gir/parameter.js";
+import { memberName } from "../store/gi/method.js";
+import { protectedChainSlotKeys, vfuncCallables, vfuncMemberNames } from "../store/gi/vtable.js";
+import { forEachAncestor } from "./inheritance.js";
+import { inputParameters } from "./param-structure.js";
+import { typeKey } from "./type-key.js";
+const CHAINABLE_SIGNAL_MEMBERS = ["addEventListener", "off", "on", "once", "removeEventListener"];
+const callableKeys = (library, fn) => ({
+    inputs: inputParameters(library, fn).map((entry) => typeKey(library, entry.parameter.type)),
+    outputs: [
+        typeKey(library, fn.returnValue.type),
+        ...fn.parameters
+            .filter((parameter) => isOutParameter(parameter))
+            .map((parameter) => typeKey(library, parameter.type)),
+    ],
+});
+const areKeysEqual = (left, right) => left.length === right.length && left.every((key, index) => key === right[index]);
+const callableKeyPair = (library, own, other) => ({
+    own: callableKeys(library, own),
+    other: callableKeys(library, other),
+});
+const areCallablesIdentical = (library, own, other) => {
+    const keys = callableKeyPair(library, own, other);
+    return areKeysEqual(keys.own.inputs, keys.other.inputs) && areKeysEqual(keys.own.outputs, keys.other.outputs);
+};
+const areCallablesAssignable = (library, own, other) => {
+    const keys = callableKeyPair(library, own, other);
+    if (keys.own.inputs.length > keys.other.inputs.length) {
+        return false;
+    }
+    if (keys.own.inputs.some((key, index) => key !== keys.other.inputs[index])) {
+        return false;
+    }
+    return areKeysEqual(keys.other.outputs, ["void"]) || areKeysEqual(keys.own.outputs, keys.other.outputs);
+};
+const collectMethods = (klass, members) => {
+    for (const method of klass.methods) {
+        const name = memberName(method.name);
+        if (method.introspectable && !members.has(name)) {
+            members.set(name, method);
+        }
+    }
+};
+const inheritedMembers = (context, klass) => {
+    const inherited = new Map();
+    forEachAncestor(context, klass, (ancestor) => {
+        collectMethods(ancestor.klass, inherited);
+    });
+    return { inherited, interfaces: new Map() };
+};
+const interfaceMembers = (options) => {
+    const members = new Map();
+    collectMethods(options.iface, members);
+    for (const [key, callable] of vfuncCallables(options.context, options.ifaceNamespace, options.iface)) {
+        members.set(key, callable);
+    }
+    return members;
+};
+const claimInterfaceMembers = (options, claimed) => {
+    for (const [key, callable] of interfaceMembers(options)) {
+        if (!claimed.interfaces.has(key)) {
+            claimed.interfaces.set(key, callable);
+        }
+    }
+};
+const isConflictingMember = (library, claimed, entry) => {
+    const [name, method] = entry;
+    const owned = claimed.inherited.get(name);
+    if (owned !== undefined) {
+        return !areCallablesAssignable(library, owned, method);
+    }
+    const sibling = claimed.interfaces.get(name);
+    return sibling !== undefined && !areCallablesIdentical(library, sibling, method);
+};
+const conflictingMemberNames = (options, claimed) => [...interfaceMembers(options)]
+    .filter((entry) => isConflictingMember(options.context.library, claimed, entry))
+    .map(([name]) => name);
+const protectedVfuncNames = (options) => {
+    const { context, klass, iface, ifaceNamespace } = options;
+    const protectedKeys = protectedChainSlotKeys(context, klass);
+    return vfuncMemberNames(context, ifaceNamespace, iface).filter((key) => protectedKeys.has(key));
+};
+const interfaceConflicts = (options, claimed) => {
+    const names = [...conflictingMemberNames(options, claimed), ...protectedVfuncNames(options)];
+    return names.length === 0 ? names : [...new Set([...names, ...CHAINABLE_SIGNAL_MEMBERS])];
+};
+const rootPrerequisite = (library) => {
+    const root = resolveClassOrInterface(library, "GObject", "Object");
+    return root === undefined ? [] : [root];
+};
+const interfaceSupertypes = (library, entry) => {
+    const prerequisites = entry.klass.prerequisites
+        .map((name) => resolveClassOrInterface(library, entry.namespaceName, name))
+        .filter((prerequisite) => prerequisite !== undefined);
+    return prerequisites.length === 0 ? rootPrerequisite(library) : prerequisites;
+};
+const classSupertypes = (library, entry) => {
+    const interfaces = resolveInterfaces(library, entry.namespaceName, entry.klass.implements);
+    if (entry.klass.parent === undefined) {
+        return interfaces;
+    }
+    const parent = resolveClassOrInterface(library, entry.namespaceName, entry.klass.parent);
+    return parent === undefined ? interfaces : [parent, ...interfaces];
+};
+const directSupertypes = (library, entry) => entry.klass.isInterface ? interfaceSupertypes(library, entry) : classSupertypes(library, entry);
+const collectSupertypeMembers = (library, entry, visited, members) => {
+    const key = `${entry.namespaceName}.${entry.klass.name}`;
+    if (visited.has(key)) {
+        return;
+    }
+    visited.add(key);
+    collectMethods(entry.klass, members);
+    for (const supertype of directSupertypes(library, entry)) {
+        collectSupertypeMembers(library, supertype, visited, members);
+    }
+};
+const supertypeMembers = (library, base) => {
+    const members = new Map();
+    collectSupertypeMembers(library, base, new Set(), members);
+    return members;
+};
+const prerequisiteConflicts = (library, iface, base) => {
+    const members = new Map();
+    collectMethods(iface, members);
+    const inherited = supertypeMembers(library, base);
+    const names = [];
+    for (const [name, method] of members) {
+        const owned = inherited.get(name);
+        if (owned !== undefined && !areCallablesAssignable(library, method, owned)) {
+            names.push(name);
+        }
+    }
+    return names;
+};
+const omittedTypeRef = (typeRef, omissions) => {
+    if (omissions.length === 0) {
+        return typeRef;
+    }
+    const keys = [...new Set(omissions)].map((name) => JSON.stringify(name)).join(" | ");
+    return `Omit<${typeRef}, ${keys}>`;
+};
+export { claimInterfaceMembers, inheritedMembers, interfaceConflicts, omittedTypeRef, prerequisiteConflicts, };
+//# sourceMappingURL=interface-conflicts.js.map

package/dist/analysis/interface-conflicts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface-conflicts.js","sourceRoot":"","sources":["../../src/analysis/interface-conflicts.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,uBAAuB,EAAyB,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvG,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACjG,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AA0BxC,MAAM,wBAAwB,GAAG,CAAC,kBAAkB,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,qBAAqB,CAAC,CAAC;AAElG,MAAM,YAAY,GAAG,CAAC,OAAgB,EAAE,EAAe,EAAgB,EAAE,CAAC,CAAC;IACvE,MAAM,EAAE,eAAe,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC3F,OAAO,EAAE;QACL,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC;QACrC,GAAG,EAAE,CAAC,UAAU;aACX,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;aAChD,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;KAC5D;CACJ,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,CAAC,IAAc,EAAE,KAAe,EAAW,EAAE,CAC9D,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;AAErF,MAAM,eAAe,GAAG,CAAC,OAAgB,EAAE,GAAgB,EAAE,KAAkB,EAAmB,EAAE,CAAC,CAAC;IAClG,GAAG,EAAE,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC;IAC/B,KAAK,EAAE,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC;CACtC,CAAC,CAAC;AAEH,MAAM,qBAAqB,GAAG,CAAC,OAAgB,EAAE,GAAgB,EAAE,KAAkB,EAAW,EAAE;IAC9F,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IAElD,OAAO,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAClH,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,OAAgB,EAAE,GAAgB,EAAE,KAAkB,EAAW,EAAE;IAC/F,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IAElD,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACpD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACzE,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC5G,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,KAAe,EAAE,OAAoB,EAAQ,EAAE;IACnE,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;QACjC,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAErC,IAAI,MAAM,CAAC,cAAc,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9C,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9B,CAAC;IACL,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,OAAsB,EAAE,KAAe,EAAkB,EAAE;IACjF,MAAM,SAAS,GAAgB,IAAI,GAAG,EAAE,CAAC;IAEzC,eAAe,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE;QACzC,cAAc,CAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,OAAiC,EAAe,EAAE;IACxE,MAAM,OAAO,GAAgB,IAAI,GAAG,EAAE,CAAC;IACvC,cAAc,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAEvC,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACnG,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,OAAiC,EAAE,OAAuB,EAAQ,EAAE;IAC/F,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;QACtD,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/B,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAC1C,CAAC;IACL,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,OAAgB,EAAE,OAAuB,EAAE,KAA4B,EAAW,EAAE;IAC7G,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC;IAC7B,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAE1C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,CAAC,sBAAsB,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAE7C,OAAO,OAAO,KAAK,SAAS,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AACrF,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,OAAiC,EAAE,OAAuB,EAAY,EAAE,CACpG,CAAC,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;KACzB,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;KAC/E,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;AAE/B,MAAM,mBAAmB,GAAG,CAAC,OAAiC,EAAY,EAAE;IACxE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;IAC1D,MAAM,aAAa,GAAG,sBAAsB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAE7D,OAAO,gBAAgB,CAAC,OAAO,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;AACpG,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,OAAiC,EAAE,OAAuB,EAAY,EAAE;IAChG,MAAM,KAAK,GAAG,CAAC,GAAG,sBAAsB,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC;IAE7F,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,KAAK,EAAE,GAAG,wBAAwB,CAAC,CAAC,CAAC,CAAC;AAC9F,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,OAAgB,EAAsB,EAAE;IAC9D,MAAM,IAAI,GAAG,uBAAuB,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAEnE,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAC5C,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,OAAgB,EAAE,KAAuB,EAAsB,EAAE;IAC1F,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC,aAAa;SAC1C,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,uBAAuB,CAAC,OAAO,EAAE,KAAK,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;SAC1E,MAAM,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC;IAE1D,OAAO,aAAa,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;AAClF,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,OAAgB,EAAE,KAAuB,EAAsB,EAAE;IACtF,MAAM,UAAU,GAAG,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC,aAAa,EAAE,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAE3F,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACnC,OAAO,UAAU,CAAC;IACtB,CAAC;IAED,MAAM,MAAM,GAAG,uBAAuB,CAAC,OAAO,EAAE,KAAK,CAAC,aAAa,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzF,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,UAAU,CAAC,CAAC;AACvE,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,OAAgB,EAAE,KAAuB,EAAsB,EAAE,CACvF,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAEpG,MAAM,uBAAuB,GAAG,CAC5B,OAAgB,EAChB,KAAuB,EACvB,OAAoB,EACpB,OAAoB,EAChB,EAAE;IACN,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAEzD,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QACnB,OAAO;IACX,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACjB,cAAc,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAErC,KAAK,MAAM,SAAS,IAAI,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;QACvD,uBAAuB,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,OAAgB,EAAE,IAAsB,EAAe,EAAE;IAC/E,MAAM,OAAO,GAAgB,IAAI,GAAG,EAAE,CAAC;IACvC,uBAAuB,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;IAE3D,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,OAAgB,EAAE,KAAe,EAAE,IAAsB,EAAY,EAAE;IAClG,MAAM,OAAO,GAAgB,IAAI,GAAG,EAAE,CAAC;IACvC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC/B,MAAM,SAAS,GAAG,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAClD,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;QACnC,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAElC,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;YACzE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrB,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,OAAe,EAAE,SAAmB,EAAU,EAAE;IACpE,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAErF,OAAO,QAAQ,OAAO,KAAK,IAAI,GAAG,CAAC;AACvC,CAAC,CAAC;AAEF,OAAO,EAEH,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,qBAAqB,GACxB,CAAC","sourcesContent":["import type { GirClass } from \"../gir/class.js\";\nimport type { GirFunction } from \"../gir/function.js\";\nimport type { Library } from \"../gir/library.js\";\nimport type { ModuleContext } from \"../writer/context.js\";\nimport { resolveClassOrInterface, type ResolvedAncestor, resolveInterfaces } from \"../gir/ancestry.js\";\nimport { isOutParameter } from \"../gir/parameter.js\";\nimport { memberName } from \"../store/gi/method.js\";\nimport { protectedChainSlotKeys, vfuncCallables, vfuncMemberNames } from \"../store/gi/vtable.js\";\nimport { forEachAncestor } from \"./inheritance.js\";\nimport { inputParameters } from \"./param-structure.js\";\nimport { typeKey } from \"./type-key.js\";\n\ntype MemberTable = Map<string, GirFunction>;\n\ntype ClaimedMembers = {\n    inherited: MemberTable;\n    interfaces: MemberTable;\n};\n\ntype InterfaceConflictOptions = {\n    context: ModuleContext;\n    klass: GirClass;\n    iface: GirClass;\n    ifaceNamespace: string;\n};\n\ntype CallableKeys = {\n    inputs: string[];\n    outputs: string[];\n};\n\ntype CallableKeyPair = {\n    own: CallableKeys;\n    other: CallableKeys;\n};\n\nconst CHAINABLE_SIGNAL_MEMBERS = [\"addEventListener\", \"off\", \"on\", \"once\", \"removeEventListener\"];\n\nconst callableKeys = (library: Library, fn: GirFunction): CallableKeys => ({\n    inputs: inputParameters(library, fn).map((entry) => typeKey(library, entry.parameter.type)),\n    outputs: [\n        typeKey(library, fn.returnValue.type),\n        ...fn.parameters\n            .filter((parameter) => isOutParameter(parameter))\n            .map((parameter) => typeKey(library, parameter.type)),\n    ],\n});\n\nconst areKeysEqual = (left: string[], right: string[]): boolean =>\n    left.length === right.length && left.every((key, index) => key === right[index]);\n\nconst callableKeyPair = (library: Library, own: GirFunction, other: GirFunction): CallableKeyPair => ({\n    own: callableKeys(library, own),\n    other: callableKeys(library, other),\n});\n\nconst areCallablesIdentical = (library: Library, own: GirFunction, other: GirFunction): boolean => {\n    const keys = callableKeyPair(library, own, other);\n\n    return areKeysEqual(keys.own.inputs, keys.other.inputs) && areKeysEqual(keys.own.outputs, keys.other.outputs);\n};\n\nconst areCallablesAssignable = (library: Library, own: GirFunction, other: GirFunction): boolean => {\n    const keys = callableKeyPair(library, own, other);\n\n    if (keys.own.inputs.length > keys.other.inputs.length) {\n        return false;\n    }\n\n    if (keys.own.inputs.some((key, index) => key !== keys.other.inputs[index])) {\n        return false;\n    }\n\n    return areKeysEqual(keys.other.outputs, [\"void\"]) || areKeysEqual(keys.own.outputs, keys.other.outputs);\n};\n\nconst collectMethods = (klass: GirClass, members: MemberTable): void => {\n    for (const method of klass.methods) {\n        const name = memberName(method.name);\n\n        if (method.introspectable && !members.has(name)) {\n            members.set(name, method);\n        }\n    }\n};\n\nconst inheritedMembers = (context: ModuleContext, klass: GirClass): ClaimedMembers => {\n    const inherited: MemberTable = new Map();\n\n    forEachAncestor(context, klass, (ancestor) => {\n        collectMethods(ancestor.klass, inherited);\n    });\n\n    return { inherited, interfaces: new Map() };\n};\n\nconst interfaceMembers = (options: InterfaceConflictOptions): MemberTable => {\n    const members: MemberTable = new Map();\n    collectMethods(options.iface, members);\n\n    for (const [key, callable] of vfuncCallables(options.context, options.ifaceNamespace, options.iface)) {\n        members.set(key, callable);\n    }\n\n    return members;\n};\n\nconst claimInterfaceMembers = (options: InterfaceConflictOptions, claimed: ClaimedMembers): void => {\n    for (const [key, callable] of interfaceMembers(options)) {\n        if (!claimed.interfaces.has(key)) {\n            claimed.interfaces.set(key, callable);\n        }\n    }\n};\n\nconst isConflictingMember = (library: Library, claimed: ClaimedMembers, entry: [string, GirFunction]): boolean => {\n    const [name, method] = entry;\n    const owned = claimed.inherited.get(name);\n\n    if (owned !== undefined) {\n        return !areCallablesAssignable(library, owned, method);\n    }\n\n    const sibling = claimed.interfaces.get(name);\n\n    return sibling !== undefined && !areCallablesIdentical(library, sibling, method);\n};\n\nconst conflictingMemberNames = (options: InterfaceConflictOptions, claimed: ClaimedMembers): string[] =>\n    [...interfaceMembers(options)]\n        .filter((entry) => isConflictingMember(options.context.library, claimed, entry))\n        .map(([name]) => name);\n\nconst protectedVfuncNames = (options: InterfaceConflictOptions): string[] => {\n    const { context, klass, iface, ifaceNamespace } = options;\n    const protectedKeys = protectedChainSlotKeys(context, klass);\n\n    return vfuncMemberNames(context, ifaceNamespace, iface).filter((key) => protectedKeys.has(key));\n};\n\nconst interfaceConflicts = (options: InterfaceConflictOptions, claimed: ClaimedMembers): string[] => {\n    const names = [...conflictingMemberNames(options, claimed), ...protectedVfuncNames(options)];\n\n    return names.length === 0 ? names : [...new Set([...names, ...CHAINABLE_SIGNAL_MEMBERS])];\n};\n\nconst rootPrerequisite = (library: Library): ResolvedAncestor[] => {\n    const root = resolveClassOrInterface(library, \"GObject\", \"Object\");\n\n    return root === undefined ? [] : [root];\n};\n\nconst interfaceSupertypes = (library: Library, entry: ResolvedAncestor): ResolvedAncestor[] => {\n    const prerequisites = entry.klass.prerequisites\n        .map((name) => resolveClassOrInterface(library, entry.namespaceName, name))\n        .filter((prerequisite) => prerequisite !== undefined);\n\n    return prerequisites.length === 0 ? rootPrerequisite(library) : prerequisites;\n};\n\nconst classSupertypes = (library: Library, entry: ResolvedAncestor): ResolvedAncestor[] => {\n    const interfaces = resolveInterfaces(library, entry.namespaceName, entry.klass.implements);\n\n    if (entry.klass.parent === undefined) {\n        return interfaces;\n    }\n\n    const parent = resolveClassOrInterface(library, entry.namespaceName, entry.klass.parent);\n\n    return parent === undefined ? interfaces : [parent, ...interfaces];\n};\n\nconst directSupertypes = (library: Library, entry: ResolvedAncestor): ResolvedAncestor[] =>\n    entry.klass.isInterface ? interfaceSupertypes(library, entry) : classSupertypes(library, entry);\n\nconst collectSupertypeMembers = (\n    library: Library,\n    entry: ResolvedAncestor,\n    visited: Set<string>,\n    members: MemberTable,\n): void => {\n    const key = `${entry.namespaceName}.${entry.klass.name}`;\n\n    if (visited.has(key)) {\n        return;\n    }\n\n    visited.add(key);\n    collectMethods(entry.klass, members);\n\n    for (const supertype of directSupertypes(library, entry)) {\n        collectSupertypeMembers(library, supertype, visited, members);\n    }\n};\n\nconst supertypeMembers = (library: Library, base: ResolvedAncestor): MemberTable => {\n    const members: MemberTable = new Map();\n    collectSupertypeMembers(library, base, new Set(), members);\n\n    return members;\n};\n\nconst prerequisiteConflicts = (library: Library, iface: GirClass, base: ResolvedAncestor): string[] => {\n    const members: MemberTable = new Map();\n    collectMethods(iface, members);\n    const inherited = supertypeMembers(library, base);\n    const names: string[] = [];\n\n    for (const [name, method] of members) {\n        const owned = inherited.get(name);\n\n        if (owned !== undefined && !areCallablesAssignable(library, method, owned)) {\n            names.push(name);\n        }\n    }\n\n    return names;\n};\n\nconst omittedTypeRef = (typeRef: string, omissions: string[]): string => {\n    if (omissions.length === 0) {\n        return typeRef;\n    }\n\n    const keys = [...new Set(omissions)].map((name) => JSON.stringify(name)).join(\" | \");\n\n    return `Omit<${typeRef}, ${keys}>`;\n};\n\nexport {\n    type ClaimedMembers,\n    claimInterfaceMembers,\n    inheritedMembers,\n    interfaceConflicts,\n    omittedTypeRef,\n    prerequisiteConflicts,\n};\n"]}

package/dist/analysis/nul-terminated-bytes.d.ts

@@ -0,0 +1,5 @@
+import type { Library } from "../gir/library.js";
+import type { GirCallable, GirParameter } from "../gir/parameter.js";
+declare const nulTerminatedByteParams: (library: Library, callable: GirCallable) => GirParameter[];
+export { nulTerminatedByteParams };
+//# sourceMappingURL=nul-terminated-bytes.d.ts.map

package/dist/analysis/nul-terminated-bytes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nul-terminated-bytes.d.ts","sourceRoot":"","sources":["../../src/analysis/nul-terminated-bytes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAwBrE,QAAA,MAAM,uBAAuB,GAAI,SAAS,OAAO,EAAE,UAAU,WAAW,KAAG,YAAY,EAGlF,CAAC;AAEN,OAAO,EAAE,uBAAuB,EAAE,CAAC"}

package/dist/analysis/nul-terminated-bytes.js

@@ -0,0 +1,18 @@
+import { isOutParameter } from "../gir/parameter.js";
+import { carrayFor, isUnboundedArray, primitiveCategoryFor } from "./type-shape.js";
+const BYTE_CATEGORIES = new Set(["int8", "uint8"]);
+const CHAR_POINTER = /char\s*\*/;
+const isByteElement = (library, element) => {
+    const category = primitiveCategoryFor(library, element);
+    return category !== undefined && BYTE_CATEGORIES.has(category);
+};
+const isNulTerminatedBytes = (library, ref) => {
+    const type = carrayFor(library, ref);
+    if (type?.arrayCType === undefined || !CHAR_POINTER.test(type.arrayCType)) {
+        return false;
+    }
+    return isUnboundedArray(type) && isByteElement(library, type.element);
+};
+const nulTerminatedByteParams = (library, callable) => callable.parameters.filter((parameter) => !isOutParameter(parameter) && isNulTerminatedBytes(library, parameter.type));
+export { nulTerminatedByteParams };
+//# sourceMappingURL=nul-terminated-bytes.js.map

package/dist/analysis/nul-terminated-bytes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nul-terminated-bytes.js","sourceRoot":"","sources":["../../src/analysis/nul-terminated-bytes.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAEpF,MAAM,eAAe,GAAgB,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAChE,MAAM,YAAY,GAAG,WAAW,CAAC;AAEjC,MAAM,aAAa,GAAG,CAAC,OAAgB,EAAE,OAAe,EAAW,EAAE;IACjE,MAAM,QAAQ,GAAG,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAExD,OAAO,QAAQ,KAAK,SAAS,IAAI,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AACnE,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,OAAgB,EAAE,GAAuB,EAAW,EAAE;IAChF,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IAErC,IAAI,IAAI,EAAE,UAAU,KAAK,SAAS,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QACxE,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;AAC1E,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,OAAgB,EAAE,QAAqB,EAAkB,EAAE,CACxF,QAAQ,CAAC,UAAU,CAAC,MAAM,CACtB,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,oBAAoB,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAC7F,CAAC;AAEN,OAAO,EAAE,uBAAuB,EAAE,CAAC","sourcesContent":["import type { Library } from \"../gir/library.js\";\nimport type { GirCallable, GirParameter } from \"../gir/parameter.js\";\nimport type { TypeId } from \"../gir/type-id.js\";\nimport { isOutParameter } from \"../gir/parameter.js\";\nimport { carrayFor, isUnboundedArray, primitiveCategoryFor } from \"./type-shape.js\";\n\nconst BYTE_CATEGORIES: Set<string> = new Set([\"int8\", \"uint8\"]);\nconst CHAR_POINTER = /char\\s*\\*/;\n\nconst isByteElement = (library: Library, element: TypeId): boolean => {\n    const category = primitiveCategoryFor(library, element);\n\n    return category !== undefined && BYTE_CATEGORIES.has(category);\n};\n\nconst isNulTerminatedBytes = (library: Library, ref: TypeId | undefined): boolean => {\n    const type = carrayFor(library, ref);\n\n    if (type?.arrayCType === undefined || !CHAR_POINTER.test(type.arrayCType)) {\n        return false;\n    }\n\n    return isUnboundedArray(type) && isByteElement(library, type.element);\n};\n\nconst nulTerminatedByteParams = (library: Library, callable: GirCallable): GirParameter[] =>\n    callable.parameters.filter(\n        (parameter) => !isOutParameter(parameter) && isNulTerminatedBytes(library, parameter.type),\n    );\n\nexport { nulTerminatedByteParams };\n"]}

package/dist/analysis/param-capability.d.ts

@@ -0,0 +1,5 @@
+import type { GirCallable } from "../gir/parameter.js";
+import type { ModuleContext } from "../writer/context.js";
+declare const hasUnmarshalableParam: (context: ModuleContext, callable: GirCallable) => boolean;
+export { hasUnmarshalableParam };
+//# sourceMappingURL=param-capability.d.ts.map

package/dist/analysis/param-capability.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"param-capability.d.ts","sourceRoot":"","sources":["../../src/analysis/param-capability.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAgB,MAAM,qBAAqB,CAAC;AAGrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAkK1D,QAAA,MAAM,qBAAqB,GAAI,SAAS,aAAa,EAAE,UAAU,WAAW,KAAG,OACU,CAAC;AAE1F,OAAO,EAAE,qBAAqB,EAAE,CAAC"}

package/dist/analysis/param-capability.js

@@ -0,0 +1,129 @@
+import { isCallerAllocatedOut, isInoutParameter } from "../gir/parameter.js";
+import { isCollectibleCallerOut, isHandlePassedInPlace, underlyingType } from "../store/gi/param-marshal.js";
+import { recordInlineSize } from "../store/gi/record-layout.js";
+import { isScalarRef } from "./descriptor-render.js";
+const POINTER_DEPTH = 1;
+const isPointerType = (context, type) => {
+    switch (type.kind) {
+        case "primitive": {
+            return type.category === "string";
+        }
+        case "record": {
+            return recordInlineSize(context, type.value) === undefined;
+        }
+        case "class":
+        case "interface":
+        case "carray":
+        case "list":
+        case "hashtable": {
+            return true;
+        }
+        case "alias":
+        case "callback":
+        case "enum":
+        case "varargs": {
+            return false;
+        }
+    }
+};
+const isPointerElement = (context, element) => {
+    if (isScalarRef(context.library, element)) {
+        return false;
+    }
+    const type = underlyingType(context, element);
+    return type !== undefined && isPointerType(context, type);
+};
+const carrayIndirection = (context, type) => POINTER_DEPTH + (isPointerElement(context, type.element) ? POINTER_DEPTH : 0);
+const typeIndirection = (context, type) => {
+    switch (type.kind) {
+        case "primitive": {
+            return type.category === "string" ? POINTER_DEPTH : undefined;
+        }
+        case "callback":
+        case "class":
+        case "hashtable":
+        case "interface":
+        case "list":
+        case "record": {
+            return POINTER_DEPTH;
+        }
+        case "carray": {
+            return carrayIndirection(context, type);
+        }
+        case "alias":
+        case "enum":
+        case "varargs": {
+            return undefined;
+        }
+    }
+};
+const baseIndirection = (context, ref) => {
+    if (isScalarRef(context.library, ref)) {
+        return 0;
+    }
+    const type = ref === undefined ? undefined : underlyingType(context, ref);
+    return type === undefined ? undefined : typeIndirection(context, type);
+};
+const declaredIndirection = (parameter) => {
+    const cType = parameter.cType;
+    if (cType === undefined) {
+        return undefined;
+    }
+    return cType.split("*").length - 1;
+};
+const marshalledIndirection = (context, parameter) => {
+    const base = baseIndirection(context, parameter.type);
+    if (base === undefined) {
+        return undefined;
+    }
+    if (isCallerAllocatedOut(parameter) || isHandlePassedInPlace(context, parameter)) {
+        return base;
+    }
+    if (isInoutParameter(parameter) && !isScalarRef(context.library, parameter.type)) {
+        return base;
+    }
+    return base + POINTER_DEPTH;
+};
+const hasCallerSuppliedLength = (context, parameter) => {
+    const type = parameter.type === undefined ? undefined : underlyingType(context, parameter.type);
+    return type?.kind === "carray" && type.lengthParameterIndex !== undefined;
+};
+const isUnmarshalableCallerOut = (context, parameter) => {
+    if (hasCallerSuppliedLength(context, parameter)) {
+        return true;
+    }
+    return !isCollectibleCallerOut(context, parameter) && !parameter.optional;
+};
+const hasIndirectionMismatch = (context, parameter) => {
+    const declared = declaredIndirection(parameter);
+    const marshalled = marshalledIndirection(context, parameter);
+    if (declared === undefined || marshalled === undefined) {
+        return false;
+    }
+    return declared !== marshalled;
+};
+const isTypeErasedCallback = (context, parameter) => {
+    if (parameter.closureIndex === undefined) {
+        return false;
+    }
+    const type = parameter.type === undefined ? undefined : underlyingType(context, parameter.type);
+    return type?.kind === "callback" && type.value.parameters.length === 0;
+};
+const isUnmarshalableCallParam = (context, parameter) => {
+    if (parameter.isVarargs) {
+        return false;
+    }
+    if (isTypeErasedCallback(context, parameter)) {
+        return true;
+    }
+    if (parameter.direction === "in") {
+        return false;
+    }
+    if (isCallerAllocatedOut(parameter)) {
+        return isUnmarshalableCallerOut(context, parameter);
+    }
+    return hasIndirectionMismatch(context, parameter);
+};
+const hasUnmarshalableParam = (context, callable) => callable.parameters.some((parameter) => isUnmarshalableCallParam(context, parameter));
+export { hasUnmarshalableParam };
+//# sourceMappingURL=param-capability.js.map

package/dist/analysis/param-capability.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"param-capability.js","sourceRoot":"","sources":["../../src/analysis/param-capability.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC7E,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC7G,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD,MAAM,aAAa,GAAG,CAAC,CAAC;AAExB,MAAM,aAAa,GAAG,CAAC,OAAsB,EAAE,IAAa,EAAW,EAAE;IACrE,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAChB,KAAK,WAAW,CAAC,CAAC,CAAC;YACf,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC;QACtC,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACZ,OAAO,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,SAAS,CAAC;QAC/D,CAAC;QACD,KAAK,OAAO,CAAC;QACb,KAAK,WAAW,CAAC;QACjB,KAAK,QAAQ,CAAC;QACd,KAAK,MAAM,CAAC;QACZ,KAAK,WAAW,CAAC,CAAC,CAAC;YACf,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,KAAK,OAAO,CAAC;QACb,KAAK,UAAU,CAAC;QAChB,KAAK,MAAM,CAAC;QACZ,KAAK,SAAS,CAAC,CAAC,CAAC;YACb,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,OAAsB,EAAE,OAAe,EAAW,EAAE;IAC1E,IAAI,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAE9C,OAAO,IAAI,KAAK,SAAS,IAAI,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AAC9D,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,OAAsB,EAAE,IAAgB,EAAU,EAAE,CAC3E,aAAa,GAAG,CAAC,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAElF,MAAM,eAAe,GAAG,CAAC,OAAsB,EAAE,IAAa,EAAsB,EAAE;IAClF,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAChB,KAAK,WAAW,CAAC,CAAC,CAAC;YACf,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;QAClE,CAAC;QACD,KAAK,UAAU,CAAC;QAChB,KAAK,OAAO,CAAC;QACb,KAAK,WAAW,CAAC;QACjB,KAAK,WAAW,CAAC;QACjB,KAAK,MAAM,CAAC;QACZ,KAAK,QAAQ,CAAC,CAAC,CAAC;YACZ,OAAO,aAAa,CAAC;QACzB,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACZ,OAAO,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC5C,CAAC;QACD,KAAK,OAAO,CAAC;QACb,KAAK,MAAM,CAAC;QACZ,KAAK,SAAS,CAAC,CAAC,CAAC;YACb,OAAO,SAAS,CAAC;QACrB,CAAC;IACL,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,OAAsB,EAAE,GAAuB,EAAsB,EAAE;IAC5F,IAAI,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC;QACpC,OAAO,CAAC,CAAC;IACb,CAAC;IAED,MAAM,IAAI,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IAE1E,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AAC3E,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,SAAuB,EAAsB,EAAE;IACxE,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC;IAE9B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,OAAsB,EAAE,SAAuB,EAAsB,EAAE;IAClG,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IAEtD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,IAAI,oBAAoB,CAAC,SAAS,CAAC,IAAI,qBAAqB,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;QAC/E,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAI,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/E,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,IAAI,GAAG,aAAa,CAAC;AAChC,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,OAAsB,EAAE,SAAuB,EAAW,EAAE;IACzF,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IAEhG,OAAO,IAAI,EAAE,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,oBAAoB,KAAK,SAAS,CAAC;AAC9E,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,OAAsB,EAAE,SAAuB,EAAW,EAAE;IAC1F,IAAI,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;QAC9C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,CAAC,sBAAsB,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;AAC9E,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,OAAsB,EAAE,SAAuB,EAAW,EAAE;IACxF,MAAM,QAAQ,GAAG,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAChD,MAAM,UAAU,GAAG,qBAAqB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAE7D,IAAI,QAAQ,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QACrD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,QAAQ,KAAK,UAAU,CAAC;AACnC,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,OAAsB,EAAE,SAAuB,EAAW,EAAE;IACtF,IAAI,SAAS,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IAEhG,OAAO,IAAI,EAAE,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC;AAC3E,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,OAAsB,EAAE,SAAuB,EAAW,EAAE;IAC1F,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,oBAAoB,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;QAC3C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAI,SAAS,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,oBAAoB,CAAC,SAAS,CAAC,EAAE,CAAC;QAClC,OAAO,wBAAwB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,sBAAsB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;AACtD,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,OAAsB,EAAE,QAAqB,EAAW,EAAE,CACrF,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,wBAAwB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;AAE1F,OAAO,EAAE,qBAAqB,EAAE,CAAC","sourcesContent":["import type { GirCallable, GirParameter } from \"../gir/parameter.js\";\nimport type { CArrayType, TypeId } from \"../gir/type-id.js\";\nimport type { GirType } from \"../gir/type.js\";\nimport type { ModuleContext } from \"../writer/context.js\";\nimport { isCallerAllocatedOut, isInoutParameter } from \"../gir/parameter.js\";\nimport { isCollectibleCallerOut, isHandlePassedInPlace, underlyingType } from \"../store/gi/param-marshal.js\";\nimport { recordInlineSize } from \"../store/gi/record-layout.js\";\nimport { isScalarRef } from \"./descriptor-render.js\";\n\nconst POINTER_DEPTH = 1;\n\nconst isPointerType = (context: ModuleContext, type: GirType): boolean => {\n    switch (type.kind) {\n        case \"primitive\": {\n            return type.category === \"string\";\n        }\n        case \"record\": {\n            return recordInlineSize(context, type.value) === undefined;\n        }\n        case \"class\":\n        case \"interface\":\n        case \"carray\":\n        case \"list\":\n        case \"hashtable\": {\n            return true;\n        }\n        case \"alias\":\n        case \"callback\":\n        case \"enum\":\n        case \"varargs\": {\n            return false;\n        }\n    }\n};\n\nconst isPointerElement = (context: ModuleContext, element: TypeId): boolean => {\n    if (isScalarRef(context.library, element)) {\n        return false;\n    }\n\n    const type = underlyingType(context, element);\n\n    return type !== undefined && isPointerType(context, type);\n};\n\nconst carrayIndirection = (context: ModuleContext, type: CArrayType): number =>\n    POINTER_DEPTH + (isPointerElement(context, type.element) ? POINTER_DEPTH : 0);\n\nconst typeIndirection = (context: ModuleContext, type: GirType): number | undefined => {\n    switch (type.kind) {\n        case \"primitive\": {\n            return type.category === \"string\" ? POINTER_DEPTH : undefined;\n        }\n        case \"callback\":\n        case \"class\":\n        case \"hashtable\":\n        case \"interface\":\n        case \"list\":\n        case \"record\": {\n            return POINTER_DEPTH;\n        }\n        case \"carray\": {\n            return carrayIndirection(context, type);\n        }\n        case \"alias\":\n        case \"enum\":\n        case \"varargs\": {\n            return undefined;\n        }\n    }\n};\n\nconst baseIndirection = (context: ModuleContext, ref: TypeId | undefined): number | undefined => {\n    if (isScalarRef(context.library, ref)) {\n        return 0;\n    }\n\n    const type = ref === undefined ? undefined : underlyingType(context, ref);\n\n    return type === undefined ? undefined : typeIndirection(context, type);\n};\n\nconst declaredIndirection = (parameter: GirParameter): number | undefined => {\n    const cType = parameter.cType;\n\n    if (cType === undefined) {\n        return undefined;\n    }\n\n    return cType.split(\"*\").length - 1;\n};\n\nconst marshalledIndirection = (context: ModuleContext, parameter: GirParameter): number | undefined => {\n    const base = baseIndirection(context, parameter.type);\n\n    if (base === undefined) {\n        return undefined;\n    }\n\n    if (isCallerAllocatedOut(parameter) || isHandlePassedInPlace(context, parameter)) {\n        return base;\n    }\n\n    if (isInoutParameter(parameter) && !isScalarRef(context.library, parameter.type)) {\n        return base;\n    }\n\n    return base + POINTER_DEPTH;\n};\n\nconst hasCallerSuppliedLength = (context: ModuleContext, parameter: GirParameter): boolean => {\n    const type = parameter.type === undefined ? undefined : underlyingType(context, parameter.type);\n\n    return type?.kind === \"carray\" && type.lengthParameterIndex !== undefined;\n};\n\nconst isUnmarshalableCallerOut = (context: ModuleContext, parameter: GirParameter): boolean => {\n    if (hasCallerSuppliedLength(context, parameter)) {\n        return true;\n    }\n\n    return !isCollectibleCallerOut(context, parameter) && !parameter.optional;\n};\n\nconst hasIndirectionMismatch = (context: ModuleContext, parameter: GirParameter): boolean => {\n    const declared = declaredIndirection(parameter);\n    const marshalled = marshalledIndirection(context, parameter);\n\n    if (declared === undefined || marshalled === undefined) {\n        return false;\n    }\n\n    return declared !== marshalled;\n};\n\nconst isTypeErasedCallback = (context: ModuleContext, parameter: GirParameter): boolean => {\n    if (parameter.closureIndex === undefined) {\n        return false;\n    }\n\n    const type = parameter.type === undefined ? undefined : underlyingType(context, parameter.type);\n\n    return type?.kind === \"callback\" && type.value.parameters.length === 0;\n};\n\nconst isUnmarshalableCallParam = (context: ModuleContext, parameter: GirParameter): boolean => {\n    if (parameter.isVarargs) {\n        return false;\n    }\n\n    if (isTypeErasedCallback(context, parameter)) {\n        return true;\n    }\n\n    if (parameter.direction === \"in\") {\n        return false;\n    }\n\n    if (isCallerAllocatedOut(parameter)) {\n        return isUnmarshalableCallerOut(context, parameter);\n    }\n\n    return hasIndirectionMismatch(context, parameter);\n};\n\nconst hasUnmarshalableParam = (context: ModuleContext, callable: GirCallable): boolean =>\n    callable.parameters.some((parameter) => isUnmarshalableCallParam(context, parameter));\n\nexport { hasUnmarshalableParam };\n"]}

package/dist/analysis/param-structure.d.ts

@@ -1,6 +1,7 @@
 import type { GirFunction } from "../gir/function.js";
 import type { Library } from "../gir/library.js";
 import type { TypeId } from "../gir/type-id.js";
+import type { JsDocParam } from "../writer/doc-tags.js";
 import { type GirCallable, type GirParameter } from "../gir/parameter.js";
 type InputParameter = {
     parameter: GirParameter;
@@ -12,16 +13,22 @@ type HandlerResultOptions = {
     renderType: (ref: TypeId | undefined, isNullable: boolean) => string;
     shouldIncludeCallerAllocated: boolean;
     isOptOut: boolean;
+    shouldExcludeOut?: (parameter: GirParameter) => boolean;
 };
 declare const inputParameters: (library: Library, fn: GirFunction) => InputParameter[];
 declare const closureAndDestroyIndices: (fn: GirFunction) => Set<number>;
 declare const emittedArgIndices: (fn: GirFunction, instanceOffset: number) => Map<number, number>;
-declare const arrayLengthSources: (library: Library, fn: GirFunction) => Map<number, number>;
-declare const hasCallerAllocatedArrayLength: (library: Library, fn: GirFunction) => boolean;
-declare const foldedLengthIndices: (library: Library, fn: GirFunction) => Set<number>;
+declare const arrayLengthSources: (library: Library, fn: GirCallable) => Map<number, number>;
+declare const foldedLengthIndices: (library: Library, fn: GirCallable) => Set<number>;
+declare const foldedLengthParameters: (library: Library, fn: GirCallable) => Set<GirParameter>;
 declare const parameterIdentifier: (parameter: GirParameter, index: number) => string;
+declare const handlerParameters: (parameters: GirParameter[], shouldExclude?: (parameter: GirParameter) => boolean) => GirParameter[];
+declare const documentedParameters: (library: Library, fn: GirFunction, shouldSkip?: (parameter: GirParameter) => boolean, renames?: Map<string, string>) => JsDocParam[];
+declare const documentedHandlerParameters: (parameters: GirParameter[]) => JsDocParam[];
+declare const handlerRenames: (parameters: GirParameter[]) => Map<string, string>;
+declare const renamesWithInstance: (parameters: GirParameter[], instance: GirParameter | undefined) => Map<string, string>;
 declare const renderHandlerParameters: (parameters: GirParameter[], renderType: (ref: TypeId | undefined, isNullable: boolean) => string, shouldExclude?: (parameter: GirParameter) => boolean) => string[];
 declare const foldOutParamShape: (primary: string | undefined, outTypes: string[]) => string;
 declare const renderHandlerResultType: (options: HandlerResultOptions) => string;
-export { emittedArgIndices, inputParameters, closureAndDestroyIndices, arrayLengthSources, hasCallerAllocatedArrayLength, foldedLengthIndices, parameterIdentifier, renderHandlerParameters, foldOutParamShape, renderHandlerResultType, };
+export { emittedArgIndices, inputParameters, closureAndDestroyIndices, arrayLengthSources, foldedLengthIndices, foldedLengthParameters, parameterIdentifier, documentedParameters, documentedHandlerParameters, handlerRenames, renamesWithInstance, handlerParameters, renderHandlerParameters, foldOutParamShape, renderHandlerResultType, type InputParameter, };
 //# sourceMappingURL=param-structure.d.ts.map

package/dist/analysis/param-structure.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"param-structure.d.ts","sourceRoot":"","sources":["../../src/analysis/param-structure.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAwC,MAAM,qBAAqB,CAAC;AAGhH,KAAK,cAAc,GAAG;IAClB,SAAS,EAAE,YAAY,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,KAAK,oBAAoB,GAAG;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,WAAW,CAAC;IACpB,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,UAAU,EAAE,OAAO,KAAK,MAAM,CAAC;IACrE,4BAA4B,EAAE,OAAO,CAAC;IACtC,QAAQ,EAAE,OAAO,CAAC;CACrB,CAAC;AA6BF,QAAA,MAAM,eAAe,GAAI,SAAS,OAAO,EAAE,IAAI,WAAW,KAAG,cAAc,EAY1E,CAAC;AAEF,QAAA,MAAM,wBAAwB,GAAI,IAAI,WAAW,KAAG,GAAG,CAAC,MAAM,CAc7D,CAAC;AAEF,QAAA,MAAM,iBAAiB,GAAI,IAAI,WAAW,EAAE,gBAAgB,MAAM,KAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAetF,CAAC;AAkBF,QAAA,MAAM,kBAAkB,GAAI,SAAS,OAAO,EAAE,IAAI,WAAW,KAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAYjF,CAAC;AAEF,QAAA,MAAM,6BAA6B,GAAI,SAAS,OAAO,EAAE,IAAI,WAAW,KAAG,OAU1E,CAAC;AAkBF,QAAA,MAAM,mBAAmB,GAAI,SAAS,OAAO,EAAE,IAAI,WAAW,KAAG,GAAG,CAAC,MAAM,CAQ1E,CAAC;AAEF,QAAA,MAAM,mBAAmB,GAAI,WAAW,YAAY,EAAE,OAAO,MAAM,KAAG,MAMrE,CAAC;AAEF,QAAA,MAAM,uBAAuB,GACzB,YAAY,YAAY,EAAE,EAC1B,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,UAAU,EAAE,OAAO,KAAK,MAAM,EACpE,gBAAe,CAAC,SAAS,EAAE,YAAY,KAAK,OAAqB,KAClE,MAAM,EAMA,CAAC;AAEV,QAAA,MAAM,iBAAiB,GAAI,SAAS,MAAM,GAAG,SAAS,EAAE,UAAU,MAAM,EAAE,KAAG,MAY5E,CAAC;AAgCF,QAAA,MAAM,uBAAuB,GAAI,SAAS,oBAAoB,KAAG,MAgBhE,CAAC;AAEF,OAAO,EACH,iBAAiB,EACjB,eAAe,EACf,wBAAwB,EACxB,kBAAkB,EAClB,6BAA6B,EAC7B,mBAAmB,EACnB,mBAAmB,EACnB,uBAAuB,EACvB,iBAAiB,EACjB,uBAAuB,GAC1B,CAAC"}
+{"version":3,"file":"param-structure.d.ts","sourceRoot":"","sources":["../../src/analysis/param-structure.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAwC,MAAM,qBAAqB,CAAC;AAGhH,KAAK,cAAc,GAAG;IAClB,SAAS,EAAE,YAAY,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,KAAK,oBAAoB,GAAG;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,WAAW,CAAC;IACpB,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,UAAU,EAAE,OAAO,KAAK,MAAM,CAAC;IACrE,4BAA4B,EAAE,OAAO,CAAC;IACtC,QAAQ,EAAE,OAAO,CAAC;IAClB,gBAAgB,CAAC,EAAE,CAAC,SAAS,EAAE,YAAY,KAAK,OAAO,CAAC;CAC3D,CAAC;AA6BF,QAAA,MAAM,eAAe,GAAI,SAAS,OAAO,EAAE,IAAI,WAAW,KAAG,cAAc,EAY1E,CAAC;AAEF,QAAA,MAAM,wBAAwB,GAAI,IAAI,WAAW,KAAG,GAAG,CAAC,MAAM,CAc7D,CAAC;AAEF,QAAA,MAAM,iBAAiB,GAAI,IAAI,WAAW,EAAE,gBAAgB,MAAM,KAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAetF,CAAC;AAkBF,QAAA,MAAM,kBAAkB,GAAI,SAAS,OAAO,EAAE,IAAI,WAAW,KAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAYjF,CAAC;AAkBF,QAAA,MAAM,mBAAmB,GAAI,SAAS,OAAO,EAAE,IAAI,WAAW,KAAG,GAAG,CAAC,MAAM,CAQ1E,CAAC;AAEF,QAAA,MAAM,sBAAsB,GAAI,SAAS,OAAO,EAAE,IAAI,WAAW,KAAG,GAAG,CAAC,YAAY,CAYnF,CAAC;AAEF,QAAA,MAAM,mBAAmB,GAAI,WAAW,YAAY,EAAE,OAAO,MAAM,KAAG,MAMrE,CAAC;AAEF,QAAA,MAAM,iBAAiB,GACnB,YAAY,YAAY,EAAE,EAC1B,gBAAe,CAAC,SAAS,EAAE,YAAY,KAAK,OAAqB,KAClE,YAAY,EAGV,CAAC;AAEN,QAAA,MAAM,oBAAoB,GACtB,SAAS,OAAO,EAChB,IAAI,WAAW,EACf,aAAY,CAAC,SAAS,EAAE,YAAY,KAAK,OAAqB,EAC9D,UAAU,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,KAC9B,UAAU,EAOmC,CAAC;AAEjD,QAAA,MAAM,2BAA2B,GAAI,YAAY,YAAY,EAAE,KAAG,UAAU,EAG5B,CAAC;AAEjD,QAAA,MAAM,cAAc,GAAI,YAAY,YAAY,EAAE,KAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAQtE,CAAC;AAEF,QAAA,MAAM,mBAAmB,GAAI,YAAY,YAAY,EAAE,EAAE,UAAU,YAAY,GAAG,SAAS,KAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAQ/G,CAAC;AAEF,QAAA,MAAM,uBAAuB,GACzB,YAAY,YAAY,EAAE,EAC1B,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,UAAU,EAAE,OAAO,KAAK,MAAM,EACpE,gBAAe,CAAC,SAAS,EAAE,YAAY,KAAK,OAAqB,KAClE,MAAM,EAIJ,CAAC;AAEN,QAAA,MAAM,iBAAiB,GAAI,SAAS,MAAM,GAAG,SAAS,EAAE,UAAU,MAAM,EAAE,KAAG,MAY5E,CAAC;AAgCF,QAAA,MAAM,uBAAuB,GAAI,SAAS,oBAAoB,KAAG,MAqBhE,CAAC;AAEF,OAAO,EACH,iBAAiB,EACjB,eAAe,EACf,wBAAwB,EACxB,kBAAkB,EAClB,mBAAmB,EACnB,sBAAsB,EACtB,mBAAmB,EACnB,oBAAoB,EACpB,2BAA2B,EAC3B,cAAc,EACd,mBAAmB,EACnB,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,uBAAuB,EACvB,KAAK,cAAc,GACtB,CAAC"}

package/dist/analysis/param-structure.js

@@ -1,6 +1,6 @@
 import { toCamelIdentifier } from "@gtkx/utils";
 import { isCallerAllocatedOut, isOutParameter } from "../gir/parameter.js";
-import { isCellInout, shouldOmitPrimaryReturn } from "./descriptor-render.js";
+import { isCellInout, isVoidPrimaryReturn } from "./descriptor-render.js";
 const isInputParameter = (options) => {
     const { parameter, index, lengthIndices, closureIndices } = options;
     if (parameter.isVarargs) {
@@ -74,15 +74,6 @@ const arrayLengthSources = (library, fn) => {
     }
     return map;
 };
-const hasCallerAllocatedArrayLength = (library, fn) => {
-    for (const arrayIndex of arrayLengthSources(library, fn).values()) {
-        const array = fn.parameters[arrayIndex];
-        if (array !== undefined && isCallerAllocatedOut(array)) {
-            return true;
-        }
-    }
-    return false;
-};
 const returnArrayLengthIndices = (library, fn) => {
     const returnType = fn.returnValue.type === undefined ? undefined : library.typeFor(fn.returnValue.type);
     if (returnType?.kind !== "carray") {
@@ -101,15 +92,48 @@ const foldedLengthIndices = (library, fn) => {
     }
     return indices;
 };
+const foldedLengthParameters = (library, fn) => {
+    const folded = new Set();
+    for (const index of foldedLengthIndices(library, fn)) {
+        const parameter = fn.parameters[index];
+        if (parameter !== undefined) {
+            folded.add(parameter);
+        }
+    }
+    return folded;
+};
 const parameterIdentifier = (parameter, index) => {
     if (parameter.name.length === 0) {
         return `arg${String(index)}`;
     }
     return toCamelIdentifier(parameter.name);
 };
-const renderHandlerParameters = (parameters, renderType, shouldExclude = () => false) => parameters
-    .filter((parameter) => !parameter.isVarargs && !isOutParameter(parameter) && !shouldExclude(parameter))
-    .map((parameter, index) => `${parameterIdentifier(parameter, index)}: ${renderType(parameter.type, parameter.nullable)}`);
+const handlerParameters = (parameters, shouldExclude = () => false) => parameters.filter((parameter) => !parameter.isVarargs && !isOutParameter(parameter) && !shouldExclude(parameter));
+const documentedParameters = (library, fn, shouldSkip = () => false, renames) => inputParameters(library, fn)
+    .filter(({ parameter }) => !shouldSkip(parameter))
+    .map(({ parameter, index }) => ({
+    name: renames?.get(parameter.name) ?? parameterIdentifier(parameter, index),
+    doc: parameter.doc ?? "",
+}))
+    .filter((entry) => entry.doc.length > 0);
+const documentedHandlerParameters = (parameters) => handlerParameters(parameters)
+    .map((parameter, index) => ({ name: parameterIdentifier(parameter, index), doc: parameter.doc ?? "" }))
+    .filter((entry) => entry.doc.length > 0);
+const handlerRenames = (parameters) => {
+    const renames = new Map();
+    for (const [index, parameter] of parameters.entries()) {
+        renames.set(parameter.name, parameterIdentifier(parameter, index));
+    }
+    return renames;
+};
+const renamesWithInstance = (parameters, instance) => {
+    const renames = handlerRenames(parameters);
+    if (instance !== undefined && instance.name.length > 0) {
+        renames.set(instance.name, "this");
+    }
+    return renames;
+};
+const renderHandlerParameters = (parameters, renderType, shouldExclude = () => false) => handlerParameters(parameters, shouldExclude).map((parameter, index) => `${parameterIdentifier(parameter, index)}: ${renderType(parameter.type, parameter.nullable)}`);
 const foldOutParamShape = (primary, outTypes) => {
     if (primary !== undefined) {
         return `[${primary}, ${outTypes.join(", ")}]`;
@@ -141,16 +165,18 @@ const scalarResultType = (primary, isOptOut) => {
 };
 const renderHandlerResultType = (options) => {
     const { library, signal, renderType, shouldIncludeCallerAllocated, isOptOut } = options;
-    const primary = shouldOmitPrimaryReturn(library, signal.returnValue)
+    const shouldExcludeOut = options.shouldExcludeOut ?? (() => false);
+    const primary = isVoidPrimaryReturn(library, signal.returnValue)
         ? undefined
         : renderType(signal.returnValue.type, signal.returnValue.nullable);
     const outTypes = signal.parameters
-        .filter((parameter) => isHandlerOutParameter({ library, parameter, shouldIncludeCallerAllocated }))
+        .filter((parameter) => isHandlerOutParameter({ library, parameter, shouldIncludeCallerAllocated }) &&
+        !shouldExcludeOut(parameter))
         .map((parameter) => renderType(parameter.type, parameter.nullable));
     if (outTypes.length === 0) {
         return scalarResultType(primary, isOptOut);
     }
     return foldOutParamShape(primary, outTypes);
 };
-export { emittedArgIndices, inputParameters, closureAndDestroyIndices, arrayLengthSources, hasCallerAllocatedArrayLength, foldedLengthIndices, parameterIdentifier, renderHandlerParameters, foldOutParamShape, renderHandlerResultType, };
+export { emittedArgIndices, inputParameters, closureAndDestroyIndices, arrayLengthSources, foldedLengthIndices, foldedLengthParameters, parameterIdentifier, documentedParameters, documentedHandlerParameters, handlerRenames, renamesWithInstance, handlerParameters, renderHandlerParameters, foldOutParamShape, renderHandlerResultType, };
 //# sourceMappingURL=param-structure.js.map

package/dist/analysis/param-structure.js.map

@@ -1 +1 @@
-{"version":3,"file":"param-structure.js","sourceRoot":"","sources":["../../src/analysis/param-structure.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAIhD,OAAO,EAAuC,oBAAoB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAChH,OAAO,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAe9E,MAAM,gBAAgB,GAAG,CAAC,OAKzB,EAAW,EAAE;IACV,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;IAEpE,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,oBAAoB,CAAC,SAAS,CAAC,EAAE,CAAC;QAClC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,OAAgB,EAAE,EAAe,EAAoB,EAAE;IAC5E,MAAM,aAAa,GAAG,kBAAkB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACtD,MAAM,cAAc,GAAG,wBAAwB,CAAC,EAAE,CAAC,CAAC;IACpD,MAAM,MAAM,GAAqB,EAAE,CAAC;IAEpC,KAAK,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;QACvD,IAAI,gBAAgB,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,CAAC,EAAE,CAAC;YACxE,MAAM,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;QACtC,CAAC;IACL,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,EAAe,EAAe,EAAE;IAC9D,MAAM,OAAO,GAAgB,IAAI,GAAG,EAAE,CAAC;IAEvC,KAAK,MAAM,SAAS,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC;QACpC,IAAI,SAAS,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACvC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,SAAS,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACvC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACxC,CAAC;IACL,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,EAAe,EAAE,cAAsB,EAAuB,EAAE;IACvF,MAAM,cAAc,GAAG,wBAAwB,CAAC,EAAE,CAAC,CAAC;IACpD,MAAM,GAAG,GAAwB,IAAI,GAAG,EAAE,CAAC;IAC3C,IAAI,OAAO,GAAG,cAAc,CAAC;IAE7B,KAAK,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;QACvD,IAAI,SAAS,CAAC,SAAS,IAAI,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACnD,SAAS;QACb,CAAC;QAED,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,OAAO,GAAG,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAAE,EAAe,EAAe,EAAE;IAC1E,MAAM,GAAG,GAAG,kBAAkB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAE5C,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,OAAgB,EAAE,GAAuB,EAAsB,EAAE;IACxF,MAAM,IAAI,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAElE,IAAI,IAAI,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC1B,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,OAAO,IAAI,CAAC,oBAAoB,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAAE,EAAe,EAAuB,EAAE;IAClF,MAAM,GAAG,GAAwB,IAAI,GAAG,EAAE,CAAC;IAE3C,KAAK,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;QACvD,MAAM,WAAW,GAAG,iBAAiB,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;QAE/D,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC5B,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QAChC,CAAC;IACL,CAAC;IAED,OAAO,GAAG,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,6BAA6B,GAAG,CAAC,OAAgB,EAAE,EAAe,EAAW,EAAE;IACjF,KAAK,MAAM,UAAU,IAAI,kBAAkB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;QAChE,MAAM,KAAK,GAAG,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAExC,IAAI,KAAK,KAAK,SAAS,IAAI,oBAAoB,CAAC,KAAK,CAAC,EAAE,CAAC;YACrD,OAAO,IAAI,CAAC;QAChB,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,OAAgB,EAAE,EAAe,EAAe,EAAE;IAChF,MAAM,UAAU,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAExG,IAAI,UAAU,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,IAAI,GAAG,EAAE,CAAC;IACrB,CAAC;IAED,MAAM,WAAW,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAEpD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,IAAI,GAAG,EAAE,CAAC;IACrB,CAAC;IAED,OAAO,IAAI,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,OAAgB,EAAE,EAAe,EAAe,EAAE;IAC3E,MAAM,OAAO,GAAgB,IAAI,GAAG,CAAC,kBAAkB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAE7E,KAAK,MAAM,KAAK,IAAI,wBAAwB,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC;QACxD,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,SAAuB,EAAE,KAAa,EAAU,EAAE;IAC3E,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,MAAM,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IACjC,CAAC;IAED,OAAO,iBAAiB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAC7C,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAC5B,UAA0B,EAC1B,UAAoE,EACpE,gBAAsD,GAAG,EAAE,CAAC,KAAK,EACzD,EAAE,CACV,UAAU;KACL,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;KACtG,GAAG,CACA,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CACjB,GAAG,mBAAmB,CAAC,SAAS,EAAE,KAAK,CAAC,KAAK,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CACpG,CAAC;AAEV,MAAM,iBAAiB,GAAG,CAAC,OAA2B,EAAE,QAAkB,EAAU,EAAE;IAClF,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,IAAI,OAAO,KAAK,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IAClD,CAAC;IAED,MAAM,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,QAAQ,CAAC;IAEnC,IAAI,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5C,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,OAI9B,EAAW,EAAE;IACV,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,4BAA4B,EAAE,GAAG,OAAO,CAAC;IAErE,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAI,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,4BAA4B,IAAI,oBAAoB,CAAC,SAAS,CAAC,CAAC;AAC3E,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,OAA2B,EAAE,QAAiB,EAAU,EAAE;IAChF,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,OAAO,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,OAA6B,EAAU,EAAE;IACtE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,4BAA4B,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAExF,MAAM,OAAO,GAAG,uBAAuB,CAAC,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC;QAChE,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAEvE,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU;SAC7B,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,qBAAqB,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,4BAA4B,EAAE,CAAC,CAAC;SAClG,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IAExE,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,gBAAgB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,OAAO,iBAAiB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF,OAAO,EACH,iBAAiB,EACjB,eAAe,EACf,wBAAwB,EACxB,kBAAkB,EAClB,6BAA6B,EAC7B,mBAAmB,EACnB,mBAAmB,EACnB,uBAAuB,EACvB,iBAAiB,EACjB,uBAAuB,GAC1B,CAAC","sourcesContent":["import { toCamelIdentifier } from \"@gtkx/utils\";\nimport type { GirFunction } from \"../gir/function.js\";\nimport type { Library } from \"../gir/library.js\";\nimport type { TypeId } from \"../gir/type-id.js\";\nimport { type GirCallable, type GirParameter, isCallerAllocatedOut, isOutParameter } from \"../gir/parameter.js\";\nimport { isCellInout, shouldOmitPrimaryReturn } from \"./descriptor-render.js\";\n\ntype InputParameter = {\n    parameter: GirParameter;\n    index: number;\n};\n\ntype HandlerResultOptions = {\n    library: Library;\n    signal: GirCallable;\n    renderType: (ref: TypeId | undefined, isNullable: boolean) => string;\n    shouldIncludeCallerAllocated: boolean;\n    isOptOut: boolean;\n};\n\nconst isInputParameter = (options: {\n    parameter: GirParameter;\n    index: number;\n    lengthIndices: Set<number>;\n    closureIndices: Set<number>;\n}): boolean => {\n    const { parameter, index, lengthIndices, closureIndices } = options;\n\n    if (parameter.isVarargs) {\n        return false;\n    }\n\n    if (isOutParameter(parameter)) {\n        return false;\n    }\n\n    if (isCallerAllocatedOut(parameter)) {\n        return false;\n    }\n\n    if (lengthIndices.has(index)) {\n        return false;\n    }\n\n    return !closureIndices.has(index);\n};\n\nconst inputParameters = (library: Library, fn: GirFunction): InputParameter[] => {\n    const lengthIndices = arrayLengthIndices(library, fn);\n    const closureIndices = closureAndDestroyIndices(fn);\n    const result: InputParameter[] = [];\n\n    for (const [index, parameter] of fn.parameters.entries()) {\n        if (isInputParameter({ parameter, index, lengthIndices, closureIndices })) {\n            result.push({ parameter, index });\n        }\n    }\n\n    return result;\n};\n\nconst closureAndDestroyIndices = (fn: GirFunction): Set<number> => {\n    const indices: Set<number> = new Set();\n\n    for (const parameter of fn.parameters) {\n        if (parameter.closureIndex !== undefined) {\n            indices.add(parameter.closureIndex);\n        }\n\n        if (parameter.destroyIndex !== undefined) {\n            indices.add(parameter.destroyIndex);\n        }\n    }\n\n    return indices;\n};\n\nconst emittedArgIndices = (fn: GirFunction, instanceOffset: number): Map<number, number> => {\n    const closureIndices = closureAndDestroyIndices(fn);\n    const map: Map<number, number> = new Map();\n    let emitted = instanceOffset;\n\n    for (const [index, parameter] of fn.parameters.entries()) {\n        if (parameter.isVarargs || closureIndices.has(index)) {\n            continue;\n        }\n\n        map.set(index, emitted);\n        emitted += 1;\n    }\n\n    return map;\n};\n\nconst arrayLengthIndices = (library: Library, fn: GirFunction): Set<number> => {\n    const map = arrayLengthSources(library, fn);\n\n    return new Set(map.keys());\n};\n\nconst carrayLengthIndex = (library: Library, ref: TypeId | undefined): number | undefined => {\n    const type = ref === undefined ? undefined : library.typeFor(ref);\n\n    if (type?.kind !== \"carray\") {\n        return undefined;\n    }\n\n    return type.lengthParameterIndex;\n};\n\nconst arrayLengthSources = (library: Library, fn: GirFunction): Map<number, number> => {\n    const map: Map<number, number> = new Map();\n\n    for (const [index, parameter] of fn.parameters.entries()) {\n        const lengthIndex = carrayLengthIndex(library, parameter.type);\n\n        if (lengthIndex !== undefined) {\n            map.set(lengthIndex, index);\n        }\n    }\n\n    return map;\n};\n\nconst hasCallerAllocatedArrayLength = (library: Library, fn: GirFunction): boolean => {\n    for (const arrayIndex of arrayLengthSources(library, fn).values()) {\n        const array = fn.parameters[arrayIndex];\n\n        if (array !== undefined && isCallerAllocatedOut(array)) {\n            return true;\n        }\n    }\n\n    return false;\n};\n\nconst returnArrayLengthIndices = (library: Library, fn: GirFunction): Set<number> => {\n    const returnType = fn.returnValue.type === undefined ? undefined : library.typeFor(fn.returnValue.type);\n\n    if (returnType?.kind !== \"carray\") {\n        return new Set();\n    }\n\n    const lengthIndex = returnType.lengthParameterIndex;\n\n    if (lengthIndex === undefined) {\n        return new Set();\n    }\n\n    return new Set([lengthIndex]);\n};\n\nconst foldedLengthIndices = (library: Library, fn: GirFunction): Set<number> => {\n    const indices: Set<number> = new Set(arrayLengthSources(library, fn).keys());\n\n    for (const index of returnArrayLengthIndices(library, fn)) {\n        indices.add(index);\n    }\n\n    return indices;\n};\n\nconst parameterIdentifier = (parameter: GirParameter, index: number): string => {\n    if (parameter.name.length === 0) {\n        return `arg${String(index)}`;\n    }\n\n    return toCamelIdentifier(parameter.name);\n};\n\nconst renderHandlerParameters = (\n    parameters: GirParameter[],\n    renderType: (ref: TypeId | undefined, isNullable: boolean) => string,\n    shouldExclude: (parameter: GirParameter) => boolean = () => false,\n): string[] =>\n    parameters\n        .filter((parameter) => !parameter.isVarargs && !isOutParameter(parameter) && !shouldExclude(parameter))\n        .map(\n            (parameter, index) =>\n                `${parameterIdentifier(parameter, index)}: ${renderType(parameter.type, parameter.nullable)}`,\n        );\n\nconst foldOutParamShape = (primary: string | undefined, outTypes: string[]): string => {\n    if (primary !== undefined) {\n        return `[${primary}, ${outTypes.join(\", \")}]`;\n    }\n\n    const [single, ...rest] = outTypes;\n\n    if (single !== undefined && rest.length === 0) {\n        return single;\n    }\n\n    return `[${outTypes.join(\", \")}]`;\n};\n\nconst isHandlerOutParameter = (options: {\n    library: Library;\n    parameter: GirParameter;\n    shouldIncludeCallerAllocated: boolean;\n}): boolean => {\n    const { library, parameter, shouldIncludeCallerAllocated } = options;\n\n    if (parameter.isVarargs) {\n        return false;\n    }\n\n    if (isOutParameter(parameter)) {\n        return true;\n    }\n\n    if (isCellInout(library, parameter)) {\n        return true;\n    }\n\n    return shouldIncludeCallerAllocated && isCallerAllocatedOut(parameter);\n};\n\nconst scalarResultType = (primary: string | undefined, isOptOut: boolean): string => {\n    if (primary === undefined) {\n        return \"void\";\n    }\n\n    return isOptOut ? `${primary} | undefined` : primary;\n};\n\nconst renderHandlerResultType = (options: HandlerResultOptions): string => {\n    const { library, signal, renderType, shouldIncludeCallerAllocated, isOptOut } = options;\n\n    const primary = shouldOmitPrimaryReturn(library, signal.returnValue)\n        ? undefined\n        : renderType(signal.returnValue.type, signal.returnValue.nullable);\n\n    const outTypes = signal.parameters\n        .filter((parameter) => isHandlerOutParameter({ library, parameter, shouldIncludeCallerAllocated }))\n        .map((parameter) => renderType(parameter.type, parameter.nullable));\n\n    if (outTypes.length === 0) {\n        return scalarResultType(primary, isOptOut);\n    }\n\n    return foldOutParamShape(primary, outTypes);\n};\n\nexport {\n    emittedArgIndices,\n    inputParameters,\n    closureAndDestroyIndices,\n    arrayLengthSources,\n    hasCallerAllocatedArrayLength,\n    foldedLengthIndices,\n    parameterIdentifier,\n    renderHandlerParameters,\n    foldOutParamShape,\n    renderHandlerResultType,\n};\n"]}
+{"version":3,"file":"param-structure.js","sourceRoot":"","sources":["../../src/analysis/param-structure.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAKhD,OAAO,EAAuC,oBAAoB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAChH,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAgB1E,MAAM,gBAAgB,GAAG,CAAC,OAKzB,EAAW,EAAE;IACV,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;IAEpE,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,oBAAoB,CAAC,SAAS,CAAC,EAAE,CAAC;QAClC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,OAAgB,EAAE,EAAe,EAAoB,EAAE;IAC5E,MAAM,aAAa,GAAG,kBAAkB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACtD,MAAM,cAAc,GAAG,wBAAwB,CAAC,EAAE,CAAC,CAAC;IACpD,MAAM,MAAM,GAAqB,EAAE,CAAC;IAEpC,KAAK,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;QACvD,IAAI,gBAAgB,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,CAAC,EAAE,CAAC;YACxE,MAAM,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;QACtC,CAAC;IACL,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,EAAe,EAAe,EAAE;IAC9D,MAAM,OAAO,GAAgB,IAAI,GAAG,EAAE,CAAC;IAEvC,KAAK,MAAM,SAAS,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC;QACpC,IAAI,SAAS,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACvC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,SAAS,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACvC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACxC,CAAC;IACL,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,EAAe,EAAE,cAAsB,EAAuB,EAAE;IACvF,MAAM,cAAc,GAAG,wBAAwB,CAAC,EAAE,CAAC,CAAC;IACpD,MAAM,GAAG,GAAwB,IAAI,GAAG,EAAE,CAAC;IAC3C,IAAI,OAAO,GAAG,cAAc,CAAC;IAE7B,KAAK,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;QACvD,IAAI,SAAS,CAAC,SAAS,IAAI,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACnD,SAAS;QACb,CAAC;QAED,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,OAAO,GAAG,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAAE,EAAe,EAAe,EAAE;IAC1E,MAAM,GAAG,GAAG,kBAAkB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAE5C,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,OAAgB,EAAE,GAAuB,EAAsB,EAAE;IACxF,MAAM,IAAI,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAElE,IAAI,IAAI,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC1B,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,OAAO,IAAI,CAAC,oBAAoB,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAAE,EAAe,EAAuB,EAAE;IAClF,MAAM,GAAG,GAAwB,IAAI,GAAG,EAAE,CAAC;IAE3C,KAAK,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;QACvD,MAAM,WAAW,GAAG,iBAAiB,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;QAE/D,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC5B,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QAChC,CAAC;IACL,CAAC;IAED,OAAO,GAAG,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,OAAgB,EAAE,EAAe,EAAe,EAAE;IAChF,MAAM,UAAU,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAExG,IAAI,UAAU,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,IAAI,GAAG,EAAE,CAAC;IACrB,CAAC;IAED,MAAM,WAAW,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAEpD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,IAAI,GAAG,EAAE,CAAC;IACrB,CAAC;IAED,OAAO,IAAI,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,OAAgB,EAAE,EAAe,EAAe,EAAE;IAC3E,MAAM,OAAO,GAAgB,IAAI,GAAG,CAAC,kBAAkB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAE7E,KAAK,MAAM,KAAK,IAAI,wBAAwB,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC;QACxD,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,OAAgB,EAAE,EAAe,EAAqB,EAAE;IACpF,MAAM,MAAM,GAAsB,IAAI,GAAG,EAAE,CAAC;IAE5C,KAAK,MAAM,KAAK,IAAI,mBAAmB,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC;QACnD,MAAM,SAAS,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAEvC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC1B,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC1B,CAAC;IACL,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,SAAuB,EAAE,KAAa,EAAU,EAAE;IAC3E,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,MAAM,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IACjC,CAAC;IAED,OAAO,iBAAiB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAC7C,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CACtB,UAA0B,EAC1B,gBAAsD,GAAG,EAAE,CAAC,KAAK,EACnD,EAAE,CAChB,UAAU,CAAC,MAAM,CACb,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CACjG,CAAC;AAEN,MAAM,oBAAoB,GAAG,CACzB,OAAgB,EAChB,EAAe,EACf,aAAmD,GAAG,EAAE,CAAC,KAAK,EAC9D,OAA6B,EACjB,EAAE,CACd,eAAe,CAAC,OAAO,EAAE,EAAE,CAAC;KACvB,MAAM,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;KACjD,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5B,IAAI,EAAE,OAAO,EAAE,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,mBAAmB,CAAC,SAAS,EAAE,KAAK,CAAC;IAC3E,GAAG,EAAE,SAAS,CAAC,GAAG,IAAI,EAAE;CAC3B,CAAC,CAAC;KACF,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAEjD,MAAM,2BAA2B,GAAG,CAAC,UAA0B,EAAgB,EAAE,CAC7E,iBAAiB,CAAC,UAAU,CAAC;KACxB,GAAG,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,mBAAmB,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,CAAC;KACtG,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAEjD,MAAM,cAAc,GAAG,CAAC,UAA0B,EAAuB,EAAE;IACvE,MAAM,OAAO,GAAwB,IAAI,GAAG,EAAE,CAAC;IAE/C,KAAK,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;QACpD,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,mBAAmB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;IACvE,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,UAA0B,EAAE,QAAkC,EAAuB,EAAE;IAChH,MAAM,OAAO,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;IAE3C,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrD,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACvC,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAC5B,UAA0B,EAC1B,UAAoE,EACpE,gBAAsD,GAAG,EAAE,CAAC,KAAK,EACzD,EAAE,CACV,iBAAiB,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,GAAG,CAC5C,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CACjB,GAAG,mBAAmB,CAAC,SAAS,EAAE,KAAK,CAAC,KAAK,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CACpG,CAAC;AAEN,MAAM,iBAAiB,GAAG,CAAC,OAA2B,EAAE,QAAkB,EAAU,EAAE;IAClF,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,IAAI,OAAO,KAAK,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IAClD,CAAC;IAED,MAAM,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,QAAQ,CAAC;IAEnC,IAAI,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5C,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,OAI9B,EAAW,EAAE;IACV,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,4BAA4B,EAAE,GAAG,OAAO,CAAC;IAErE,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAI,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,4BAA4B,IAAI,oBAAoB,CAAC,SAAS,CAAC,CAAC;AAC3E,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,OAA2B,EAAE,QAAiB,EAAU,EAAE;IAChF,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,OAAO,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,OAA6B,EAAU,EAAE;IACtE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,4BAA4B,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IACxF,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;IAEnE,MAAM,OAAO,GAAG,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC;QAC5D,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAEvE,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU;SAC7B,MAAM,CACH,CAAC,SAAS,EAAE,EAAE,CACV,qBAAqB,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,4BAA4B,EAAE,CAAC;QAC3E,CAAC,gBAAgB,CAAC,SAAS,CAAC,CACnC;SACA,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IAExE,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,gBAAgB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,OAAO,iBAAiB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF,OAAO,EACH,iBAAiB,EACjB,eAAe,EACf,wBAAwB,EACxB,kBAAkB,EAClB,mBAAmB,EACnB,sBAAsB,EACtB,mBAAmB,EACnB,oBAAoB,EACpB,2BAA2B,EAC3B,cAAc,EACd,mBAAmB,EACnB,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,uBAAuB,GAE1B,CAAC","sourcesContent":["import { toCamelIdentifier } from \"@gtkx/utils\";\nimport type { GirFunction } from \"../gir/function.js\";\nimport type { Library } from \"../gir/library.js\";\nimport type { TypeId } from \"../gir/type-id.js\";\nimport type { JsDocParam } from \"../writer/doc-tags.js\";\nimport { type GirCallable, type GirParameter, isCallerAllocatedOut, isOutParameter } from \"../gir/parameter.js\";\nimport { isCellInout, isVoidPrimaryReturn } from \"./descriptor-render.js\";\n\ntype InputParameter = {\n    parameter: GirParameter;\n    index: number;\n};\n\ntype HandlerResultOptions = {\n    library: Library;\n    signal: GirCallable;\n    renderType: (ref: TypeId | undefined, isNullable: boolean) => string;\n    shouldIncludeCallerAllocated: boolean;\n    isOptOut: boolean;\n    shouldExcludeOut?: (parameter: GirParameter) => boolean;\n};\n\nconst isInputParameter = (options: {\n    parameter: GirParameter;\n    index: number;\n    lengthIndices: Set<number>;\n    closureIndices: Set<number>;\n}): boolean => {\n    const { parameter, index, lengthIndices, closureIndices } = options;\n\n    if (parameter.isVarargs) {\n        return false;\n    }\n\n    if (isOutParameter(parameter)) {\n        return false;\n    }\n\n    if (isCallerAllocatedOut(parameter)) {\n        return false;\n    }\n\n    if (lengthIndices.has(index)) {\n        return false;\n    }\n\n    return !closureIndices.has(index);\n};\n\nconst inputParameters = (library: Library, fn: GirFunction): InputParameter[] => {\n    const lengthIndices = arrayLengthIndices(library, fn);\n    const closureIndices = closureAndDestroyIndices(fn);\n    const result: InputParameter[] = [];\n\n    for (const [index, parameter] of fn.parameters.entries()) {\n        if (isInputParameter({ parameter, index, lengthIndices, closureIndices })) {\n            result.push({ parameter, index });\n        }\n    }\n\n    return result;\n};\n\nconst closureAndDestroyIndices = (fn: GirFunction): Set<number> => {\n    const indices: Set<number> = new Set();\n\n    for (const parameter of fn.parameters) {\n        if (parameter.closureIndex !== undefined) {\n            indices.add(parameter.closureIndex);\n        }\n\n        if (parameter.destroyIndex !== undefined) {\n            indices.add(parameter.destroyIndex);\n        }\n    }\n\n    return indices;\n};\n\nconst emittedArgIndices = (fn: GirFunction, instanceOffset: number): Map<number, number> => {\n    const closureIndices = closureAndDestroyIndices(fn);\n    const map: Map<number, number> = new Map();\n    let emitted = instanceOffset;\n\n    for (const [index, parameter] of fn.parameters.entries()) {\n        if (parameter.isVarargs || closureIndices.has(index)) {\n            continue;\n        }\n\n        map.set(index, emitted);\n        emitted += 1;\n    }\n\n    return map;\n};\n\nconst arrayLengthIndices = (library: Library, fn: GirFunction): Set<number> => {\n    const map = arrayLengthSources(library, fn);\n\n    return new Set(map.keys());\n};\n\nconst carrayLengthIndex = (library: Library, ref: TypeId | undefined): number | undefined => {\n    const type = ref === undefined ? undefined : library.typeFor(ref);\n\n    if (type?.kind !== \"carray\") {\n        return undefined;\n    }\n\n    return type.lengthParameterIndex;\n};\n\nconst arrayLengthSources = (library: Library, fn: GirCallable): Map<number, number> => {\n    const map: Map<number, number> = new Map();\n\n    for (const [index, parameter] of fn.parameters.entries()) {\n        const lengthIndex = carrayLengthIndex(library, parameter.type);\n\n        if (lengthIndex !== undefined) {\n            map.set(lengthIndex, index);\n        }\n    }\n\n    return map;\n};\n\nconst returnArrayLengthIndices = (library: Library, fn: GirCallable): Set<number> => {\n    const returnType = fn.returnValue.type === undefined ? undefined : library.typeFor(fn.returnValue.type);\n\n    if (returnType?.kind !== \"carray\") {\n        return new Set();\n    }\n\n    const lengthIndex = returnType.lengthParameterIndex;\n\n    if (lengthIndex === undefined) {\n        return new Set();\n    }\n\n    return new Set([lengthIndex]);\n};\n\nconst foldedLengthIndices = (library: Library, fn: GirCallable): Set<number> => {\n    const indices: Set<number> = new Set(arrayLengthSources(library, fn).keys());\n\n    for (const index of returnArrayLengthIndices(library, fn)) {\n        indices.add(index);\n    }\n\n    return indices;\n};\n\nconst foldedLengthParameters = (library: Library, fn: GirCallable): Set<GirParameter> => {\n    const folded: Set<GirParameter> = new Set();\n\n    for (const index of foldedLengthIndices(library, fn)) {\n        const parameter = fn.parameters[index];\n\n        if (parameter !== undefined) {\n            folded.add(parameter);\n        }\n    }\n\n    return folded;\n};\n\nconst parameterIdentifier = (parameter: GirParameter, index: number): string => {\n    if (parameter.name.length === 0) {\n        return `arg${String(index)}`;\n    }\n\n    return toCamelIdentifier(parameter.name);\n};\n\nconst handlerParameters = (\n    parameters: GirParameter[],\n    shouldExclude: (parameter: GirParameter) => boolean = () => false,\n): GirParameter[] =>\n    parameters.filter(\n        (parameter) => !parameter.isVarargs && !isOutParameter(parameter) && !shouldExclude(parameter),\n    );\n\nconst documentedParameters = (\n    library: Library,\n    fn: GirFunction,\n    shouldSkip: (parameter: GirParameter) => boolean = () => false,\n    renames?: Map<string, string>,\n): JsDocParam[] =>\n    inputParameters(library, fn)\n        .filter(({ parameter }) => !shouldSkip(parameter))\n        .map(({ parameter, index }) => ({\n            name: renames?.get(parameter.name) ?? parameterIdentifier(parameter, index),\n            doc: parameter.doc ?? \"\",\n        }))\n        .filter((entry) => entry.doc.length > 0);\n\nconst documentedHandlerParameters = (parameters: GirParameter[]): JsDocParam[] =>\n    handlerParameters(parameters)\n        .map((parameter, index) => ({ name: parameterIdentifier(parameter, index), doc: parameter.doc ?? \"\" }))\n        .filter((entry) => entry.doc.length > 0);\n\nconst handlerRenames = (parameters: GirParameter[]): Map<string, string> => {\n    const renames: Map<string, string> = new Map();\n\n    for (const [index, parameter] of parameters.entries()) {\n        renames.set(parameter.name, parameterIdentifier(parameter, index));\n    }\n\n    return renames;\n};\n\nconst renamesWithInstance = (parameters: GirParameter[], instance: GirParameter | undefined): Map<string, string> => {\n    const renames = handlerRenames(parameters);\n\n    if (instance !== undefined && instance.name.length > 0) {\n        renames.set(instance.name, \"this\");\n    }\n\n    return renames;\n};\n\nconst renderHandlerParameters = (\n    parameters: GirParameter[],\n    renderType: (ref: TypeId | undefined, isNullable: boolean) => string,\n    shouldExclude: (parameter: GirParameter) => boolean = () => false,\n): string[] =>\n    handlerParameters(parameters, shouldExclude).map(\n        (parameter, index) =>\n            `${parameterIdentifier(parameter, index)}: ${renderType(parameter.type, parameter.nullable)}`,\n    );\n\nconst foldOutParamShape = (primary: string | undefined, outTypes: string[]): string => {\n    if (primary !== undefined) {\n        return `[${primary}, ${outTypes.join(\", \")}]`;\n    }\n\n    const [single, ...rest] = outTypes;\n\n    if (single !== undefined && rest.length === 0) {\n        return single;\n    }\n\n    return `[${outTypes.join(\", \")}]`;\n};\n\nconst isHandlerOutParameter = (options: {\n    library: Library;\n    parameter: GirParameter;\n    shouldIncludeCallerAllocated: boolean;\n}): boolean => {\n    const { library, parameter, shouldIncludeCallerAllocated } = options;\n\n    if (parameter.isVarargs) {\n        return false;\n    }\n\n    if (isOutParameter(parameter)) {\n        return true;\n    }\n\n    if (isCellInout(library, parameter)) {\n        return true;\n    }\n\n    return shouldIncludeCallerAllocated && isCallerAllocatedOut(parameter);\n};\n\nconst scalarResultType = (primary: string | undefined, isOptOut: boolean): string => {\n    if (primary === undefined) {\n        return \"void\";\n    }\n\n    return isOptOut ? `${primary} | undefined` : primary;\n};\n\nconst renderHandlerResultType = (options: HandlerResultOptions): string => {\n    const { library, signal, renderType, shouldIncludeCallerAllocated, isOptOut } = options;\n    const shouldExcludeOut = options.shouldExcludeOut ?? (() => false);\n\n    const primary = isVoidPrimaryReturn(library, signal.returnValue)\n        ? undefined\n        : renderType(signal.returnValue.type, signal.returnValue.nullable);\n\n    const outTypes = signal.parameters\n        .filter(\n            (parameter) =>\n                isHandlerOutParameter({ library, parameter, shouldIncludeCallerAllocated }) &&\n                !shouldExcludeOut(parameter),\n        )\n        .map((parameter) => renderType(parameter.type, parameter.nullable));\n\n    if (outTypes.length === 0) {\n        return scalarResultType(primary, isOptOut);\n    }\n\n    return foldOutParamShape(primary, outTypes);\n};\n\nexport {\n    emittedArgIndices,\n    inputParameters,\n    closureAndDestroyIndices,\n    arrayLengthSources,\n    foldedLengthIndices,\n    foldedLengthParameters,\n    parameterIdentifier,\n    documentedParameters,\n    documentedHandlerParameters,\n    handlerRenames,\n    renamesWithInstance,\n    handlerParameters,\n    renderHandlerParameters,\n    foldOutParamShape,\n    renderHandlerResultType,\n    type InputParameter,\n};\n"]}

package/dist/analysis/ts-type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ts-type.d.ts","sourceRoot":"","sources":["../../src/analysis/ts-type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAc,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAKH,KAAK,MAAM,EACd,MAAM,mBAAmB,CAAC;AAG3B,KAAK,aAAa,GAAG;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,KAAK,YAAY,GAAG;IAChB,cAAc,EAAE,KAAK,GAAG,QAAQ,CAAC;IACjC,YAAY,EAAE,MAAM,CAAC;IACrB,6BAA6B,EAAE,OAAO,CAAC;IACvC,WAAW,EAAE,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,EAAE,IAAI,EAAE,aAAa,KAAK,MAAM,CAAC;IAC5E,WAAW,EAAE,MAAM,MAAM,CAAC;CAC7B,CAAC;AA4BF,QAAA,MAAM,cAAc,GAAI,SAAS,OAAO,EAAE,QAAQ,YAAY,EAAE,KAAK,MAAM,GAAG,SAAS,KAAG,MAiCzF,CAAC;AAiDF,QAAA,MAAM,YAAY,GAAI,SAAS,aAAa,EAAE,KAAK,MAAM,GAAG,SAAS,EAAE,oBAAkB,KAAG,MAI3F,CAAC;AAEF,QAAA,MAAM,gBAAgB,GAClB,SAAS,OAAO,EAChB,gBAAgB,CAAC,IAAI,EAAE,aAAa,KAAK,MAAM,EAC/C,aAAa,MAAM,MAAM,KAC1B,YAkBF,CAAC;AAEF,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,gBAAgB,EAAE,KAAK,YAAY,EAAE,CAAC"}
+{"version":3,"file":"ts-type.d.ts","sourceRoot":"","sources":["../../src/analysis/ts-type.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAc,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAG1D,OAAO,EAKH,KAAK,MAAM,EACd,MAAM,mBAAmB,CAAC;AAG3B,KAAK,aAAa,GAAG;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,KAAK,YAAY,GAAG;IAChB,cAAc,EAAE,KAAK,GAAG,QAAQ,CAAC;IACjC,YAAY,EAAE,MAAM,CAAC;IACrB,6BAA6B,EAAE,OAAO,CAAC;IACvC,WAAW,EAAE,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,EAAE,IAAI,EAAE,aAAa,KAAK,MAAM,CAAC;IAC5E,WAAW,EAAE,MAAM,MAAM,CAAC;CAC7B,CAAC;AAqBF,QAAA,MAAM,cAAc,GAAI,SAAS,OAAO,EAAE,QAAQ,YAAY,EAAE,KAAK,MAAM,GAAG,SAAS,KAAG,MAkCzF,CAAC;AAiDF,QAAA,MAAM,YAAY,GAAI,SAAS,aAAa,EAAE,KAAK,MAAM,GAAG,SAAS,EAAE,oBAAkB,KAAG,MAI3F,CAAC;AAEF,QAAA,MAAM,gBAAgB,GAClB,SAAS,OAAO,EAChB,gBAAgB,CAAC,IAAI,EAAE,aAAa,KAAK,MAAM,EAC/C,aAAa,MAAM,MAAM,KAC1B,YAkBF,CAAC;AAEF,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,gBAAgB,EAAE,KAAK,YAAY,EAAE,CAAC"}