@gtkx/runtime 1.0.0-rc.3 → 1.0.0

package/dist/closure.js

@@ -0,0 +1,99 @@
+import { read } from "@gtkx/native";
+import {} from "@gtkx/utils";
+import { bind } from "./bind.js";
+import { boxedT, callbackT, sizedArrayT, structT, uint32T, uint64T, voidT } from "./descriptors.js";
+import { CLOSURE_SIZE, LIB, VALUE_SIZE, VALUE_T } from "./library.js";
+import { getClassType, getHandle, getWrapperClass, instanceClassName, wrapHandle } from "./registry.js";
+import { resolveBoxedType, typeIsA } from "./type.js";
+import { fromValue, getValueType, intoValue } from "./value.js";
+const CCLOSURE_CALLBACK_OFFSET = CLOSURE_SIZE;
+const N_PARAM_VALUES_INDEX = 2;
+const MARSHAL_DATA_INDEX = 5;
+const CLOSURE_T = boxedT("GClosure", { sharedLibrary: LIB, getTypeFnName: "g_closure_get_type" });
+const OWNED_CLOSURE_T = boxedT("GClosure", {
+    ownership: "full",
+    sharedLibrary: LIB,
+    getTypeFnName: "g_closure_get_type",
+});
+const MARSHAL_VALUE_T = boxedT("GValue", {
+    sharedLibrary: LIB,
+    getTypeFnName: "g_value_get_type",
+    size: VALUE_SIZE,
+    isCallerAllocated: true,
+});
+const MARSHAL_T = callbackT([
+    CLOSURE_T,
+    MARSHAL_VALUE_T,
+    uint32T,
+    sizedArrayT(MARSHAL_VALUE_T, N_PARAM_VALUES_INDEX, "borrowed", VALUE_SIZE),
+    uint64T,
+    uint64T,
+], voidT, {
+    hasUserData: true,
+    userDataIndex: MARSHAL_DATA_INDEX,
+    hasDestroy: true,
+    destroyKind: "closureNotify",
+    scope: "notified",
+});
+const NESTED_VALUE_T = structT("borrowed");
+const gCclosureNew = bind(LIB, "g_cclosure_new", [MARSHAL_T], OWNED_CLOSURE_T);
+const gValueGetBoxed = bind(LIB, "g_value_get_boxed", [VALUE_T], NESTED_VALUE_T);
+const gClosureRef = bind(LIB, "g_closure_ref", [CLOSURE_T], uint64T);
+const gClosureSink = bind(LIB, "g_closure_sink", [CLOSURE_T], voidT);
+const gClosureSetMarshal = bind(LIB, "g_closure_set_marshal", [CLOSURE_T, uint64T], voidT);
+const isClosureInstance = (value) => typeIsA(getClassType(value.constructor), resolveBoxedType(CLOSURE_T));
+const getNestedValue = (param) => wrapHandle(gValueGetBoxed(param), getWrapperClass(resolveBoxedType(VALUE_T)));
+const fromParamValue = (param) => getValueType(param) === resolveBoxedType(VALUE_T) ? getNestedValue(param) : fromValue(param);
+function describeValue(value) {
+    if (value === null) {
+        return "null";
+    }
+    if (typeof value !== "object") {
+        return typeof value;
+    }
+    return instanceClassName(value);
+}
+function marshalFor(callback) {
+    return (_closure, returnValue, _count, paramValues) => {
+        const values = paramValues;
+        const args = values.map((value) => fromParamValue(value));
+        const result = callback(...args);
+        if (returnValue !== null) {
+            intoValue(returnValue, result);
+        }
+    };
+}
+function newClosure(callback) {
+    const handle = gCclosureNew(marshalFor(callback));
+    const marshal = read(handle, uint64T, CCLOSURE_CALLBACK_OFFSET);
+    gClosureRef(handle);
+    gClosureSink(handle);
+    gClosureSetMarshal(handle, marshal);
+    return handle;
+}
+/**
+ * Marshals a value passed where a `GObject.Closure` is expected into a closure handle: a function
+ * becomes a new `GClosure` dispatching into it, and an existing closure yields its own handle.
+ * @param value Function to wrap, or an already-built closure.
+ * @throws {ClosureMarshalError} When the value is neither.
+ */
+function toClosure(value) {
+    if (typeof value === "function") {
+        return newClosure(value);
+    }
+    if (typeof value === "object" && value !== null && isClosureInstance(value)) {
+        return getHandle(value);
+    }
+    throw new ClosureMarshalError(`Cannot marshal ${describeValue(value)} into a GObject.Closure`);
+}
+/** Same as {@link toClosure}, but passes a null or undefined value through as no closure at all. */
+function tryToClosure(value) {
+    return value == null ? undefined : toClosure(value);
+}
+/** Thrown when a value passed where a `GObject.Closure` is expected cannot be marshalled into one. */
+class ClosureMarshalError extends TypeError {
+    /** Name callers match on when the error is caught as a plain `TypeError`. */
+    name = "ClosureMarshalError";
+}
+export { ClosureMarshalError, toClosure, tryToClosure };
+//# sourceMappingURL=closure.js.map

package/dist/closure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"closure.js","sourceRoot":"","sources":["../src/closure.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoC,IAAI,EAAE,MAAM,cAAc,CAAC;AACtE,OAAO,EAAiB,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACpG,OAAO,EAAE,YAAY,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACtE,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,eAAe,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AACxG,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAYhE,MAAM,wBAAwB,GAAG,YAAY,CAAC;AAC9C,MAAM,oBAAoB,GAAG,CAAC,CAAC;AAC/B,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAC7B,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,EAAE,EAAE,aAAa,EAAE,GAAG,EAAE,aAAa,EAAE,oBAAoB,EAAE,CAAC,CAAC;AAElG,MAAM,eAAe,GAAG,MAAM,CAAC,UAAU,EAAE;IACvC,SAAS,EAAE,MAAM;IACjB,aAAa,EAAE,GAAG;IAClB,aAAa,EAAE,oBAAoB;CACtC,CAAC,CAAC;AAEH,MAAM,eAAe,GAAG,MAAM,CAAC,QAAQ,EAAE;IACrC,aAAa,EAAE,GAAG;IAClB,aAAa,EAAE,kBAAkB;IACjC,IAAI,EAAE,UAAU;IAChB,iBAAiB,EAAE,IAAI;CAC1B,CAAC,CAAC;AAEH,MAAM,SAAS,GAAG,SAAS,CACvB;IACI,SAAS;IACT,eAAe;IACf,OAAO;IACP,WAAW,CAAC,eAAe,EAAE,oBAAoB,EAAE,UAAU,EAAE,UAAU,CAAC;IAC1E,OAAO;IACP,OAAO;CACV,EACD,KAAK,EACL;IACI,WAAW,EAAE,IAAI;IACjB,aAAa,EAAE,kBAAkB;IACjC,UAAU,EAAE,IAAI;IAChB,WAAW,EAAE,eAAe;IAC5B,KAAK,EAAE,UAAU;CACpB,CACJ,CAAC;AAEF,MAAM,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAC3C,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,EAAE,gBAAgB,EAAE,CAAC,SAAS,CAAC,EAAE,eAAe,CAAC,CAAC;AAC/E,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE,mBAAmB,EAAE,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC;AACjF,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,eAAe,EAAE,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;AACrE,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,EAAE,gBAAgB,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,CAAC;AACrE,MAAM,kBAAkB,GAAG,IAAI,CAAC,GAAG,EAAE,uBAAuB,EAAE,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC;AAE3F,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAW,EAAE,CACjD,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,WAAuB,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;AAEtF,MAAM,cAAc,GAAG,CAAC,KAA6B,EAAiB,EAAE,CACpE,UAAU,CAAC,cAAc,CAAC,KAAK,CAAkC,EAAE,eAAe,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAEnH,MAAM,cAAc,GAAG,CAAC,KAA6B,EAAW,EAAE,CAC9D,YAAY,CAAC,KAAK,CAAC,KAAK,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AAEjG,SAAS,aAAa,CAAC,KAAc;IACjC,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACjB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,OAAO,KAAK,CAAC;IACxB,CAAC;IAED,OAAO,iBAAiB,CAAC,KAAK,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,UAAU,CAAC,QAAyB;IACzC,OAAO,CAAC,QAAiB,EAAE,WAAoB,EAAE,MAAe,EAAE,WAAoB,EAAQ,EAAE;QAC5F,MAAM,MAAM,GAAG,WAAuC,CAAC;QACvD,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAI,QAA8C,CAAC,GAAI,IAAgB,CAAC,CAAC;QAErF,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;YACvB,SAAS,CAAC,WAAqC,EAAE,MAAM,CAAC,CAAC;QAC7D,CAAC;IACL,CAAC,CAAC;AACN,CAAC;AAED,SAAS,UAAU,CAAC,QAAyB;IACzC,MAAM,MAAM,GAAG,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,CAA2B,CAAC;IAC5E,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,wBAAwB,CAAC,CAAC;IAChE,WAAW,CAAC,MAAM,CAAC,CAAC;IACpB,YAAY,CAAC,MAAM,CAAC,CAAC;IACrB,kBAAkB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEpC,OAAO,MAAM,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,SAAS,SAAS,CAAC,KAAc;IAC7B,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAC9B,OAAO,UAAU,CAAC,KAAwB,CAAC,CAAC;IAChD,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1E,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED,MAAM,IAAI,mBAAmB,CAAC,kBAAkB,aAAa,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;AACnG,CAAC;AAED,oGAAoG;AACpG,SAAS,YAAY,CAAC,KAAc;IAChC,OAAO,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AACxD,CAAC;AAED,sGAAsG;AACtG,MAAM,mBAAoB,SAAQ,SAAS;IACvC,6EAA6E;IAC7D,IAAI,GAAG,qBAAqB,CAAC;CAChD;AAED,OAAO,EAAwB,mBAAmB,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC","sourcesContent":["import { type ExternalObject, type Handle, read } from \"@gtkx/native\";\nimport { type AnyClass } from \"@gtkx/utils\";\nimport { bind } from \"./bind.js\";\nimport { boxedT, callbackT, sizedArrayT, structT, uint32T, uint64T, voidT } from \"./descriptors.js\";\nimport { CLOSURE_SIZE, LIB, VALUE_SIZE, VALUE_T } from \"./library.js\";\nimport { getClassType, getHandle, getWrapperClass, instanceClassName, wrapHandle } from \"./registry.js\";\nimport { resolveBoxedType, typeIsA } from \"./type.js\";\nimport { fromValue, getValueType, intoValue } from \"./value.js\";\n\n/**\n * Handler backing a `GClosure`. It receives the closure's parameters already converted from their\n * `GValue`s, and its result is written back into the closure's return `GValue` when it has one.\n *\n * A parameter that is itself a `GValue`, such as the target a property binding transform fills in,\n * arrives as the caller's own `GObject.Value` rather than a copy, so writing to it is how the\n * handler produces that parameter's value. It stops being valid once the handler returns.\n */\ntype ClosureCallback = (...args: never[]) => unknown;\n\nconst CCLOSURE_CALLBACK_OFFSET = CLOSURE_SIZE;\nconst N_PARAM_VALUES_INDEX = 2;\nconst MARSHAL_DATA_INDEX = 5;\nconst CLOSURE_T = boxedT(\"GClosure\", { sharedLibrary: LIB, getTypeFnName: \"g_closure_get_type\" });\n\nconst OWNED_CLOSURE_T = boxedT(\"GClosure\", {\n    ownership: \"full\",\n    sharedLibrary: LIB,\n    getTypeFnName: \"g_closure_get_type\",\n});\n\nconst MARSHAL_VALUE_T = boxedT(\"GValue\", {\n    sharedLibrary: LIB,\n    getTypeFnName: \"g_value_get_type\",\n    size: VALUE_SIZE,\n    isCallerAllocated: true,\n});\n\nconst MARSHAL_T = callbackT(\n    [\n        CLOSURE_T,\n        MARSHAL_VALUE_T,\n        uint32T,\n        sizedArrayT(MARSHAL_VALUE_T, N_PARAM_VALUES_INDEX, \"borrowed\", VALUE_SIZE),\n        uint64T,\n        uint64T,\n    ],\n    voidT,\n    {\n        hasUserData: true,\n        userDataIndex: MARSHAL_DATA_INDEX,\n        hasDestroy: true,\n        destroyKind: \"closureNotify\",\n        scope: \"notified\",\n    },\n);\n\nconst NESTED_VALUE_T = structT(\"borrowed\");\nconst gCclosureNew = bind(LIB, \"g_cclosure_new\", [MARSHAL_T], OWNED_CLOSURE_T);\nconst gValueGetBoxed = bind(LIB, \"g_value_get_boxed\", [VALUE_T], NESTED_VALUE_T);\nconst gClosureRef = bind(LIB, \"g_closure_ref\", [CLOSURE_T], uint64T);\nconst gClosureSink = bind(LIB, \"g_closure_sink\", [CLOSURE_T], voidT);\nconst gClosureSetMarshal = bind(LIB, \"g_closure_set_marshal\", [CLOSURE_T, uint64T], voidT);\n\nconst isClosureInstance = (value: object): boolean =>\n    typeIsA(getClassType(value.constructor as AnyClass), resolveBoxedType(CLOSURE_T));\n\nconst getNestedValue = (param: ExternalObject<Handle>): object | null =>\n    wrapHandle(gValueGetBoxed(param) as ExternalObject<Handle> | null, getWrapperClass(resolveBoxedType(VALUE_T)));\n\nconst fromParamValue = (param: ExternalObject<Handle>): unknown =>\n    getValueType(param) === resolveBoxedType(VALUE_T) ? getNestedValue(param) : fromValue(param);\n\nfunction describeValue(value: unknown): string {\n    if (value === null) {\n        return \"null\";\n    }\n\n    if (typeof value !== \"object\") {\n        return typeof value;\n    }\n\n    return instanceClassName(value);\n}\n\nfunction marshalFor(callback: ClosureCallback): (...args: unknown[]) => void {\n    return (_closure: unknown, returnValue: unknown, _count: unknown, paramValues: unknown): void => {\n        const values = paramValues as ExternalObject<Handle>[];\n        const args = values.map((value) => fromParamValue(value));\n        const result = (callback as (...values: unknown[]) => unknown)(...(args as never[]));\n\n        if (returnValue !== null) {\n            intoValue(returnValue as ExternalObject<Handle>, result);\n        }\n    };\n}\n\nfunction newClosure(callback: ClosureCallback): ExternalObject<Handle> {\n    const handle = gCclosureNew(marshalFor(callback)) as ExternalObject<Handle>;\n    const marshal = read(handle, uint64T, CCLOSURE_CALLBACK_OFFSET);\n    gClosureRef(handle);\n    gClosureSink(handle);\n    gClosureSetMarshal(handle, marshal);\n\n    return handle;\n}\n\n/**\n * Marshals a value passed where a `GObject.Closure` is expected into a closure handle: a function\n * becomes a new `GClosure` dispatching into it, and an existing closure yields its own handle.\n * @param value Function to wrap, or an already-built closure.\n * @throws {ClosureMarshalError} When the value is neither.\n */\nfunction toClosure(value: unknown): ExternalObject<Handle> {\n    if (typeof value === \"function\") {\n        return newClosure(value as ClosureCallback);\n    }\n\n    if (typeof value === \"object\" && value !== null && isClosureInstance(value)) {\n        return getHandle(value);\n    }\n\n    throw new ClosureMarshalError(`Cannot marshal ${describeValue(value)} into a GObject.Closure`);\n}\n\n/** Same as {@link toClosure}, but passes a null or undefined value through as no closure at all. */\nfunction tryToClosure(value: unknown): ExternalObject<Handle> | undefined {\n    return value == null ? undefined : toClosure(value);\n}\n\n/** Thrown when a value passed where a `GObject.Closure` is expected cannot be marshalled into one. */\nclass ClosureMarshalError extends TypeError {\n    /** Name callers match on when the error is caught as a plain `TypeError`. */\n    public override name = \"ClosureMarshalError\";\n}\n\nexport { type ClosureCallback, ClosureMarshalError, toClosure, tryToClosure };\n"]}

package/dist/descriptors.d.ts

@@ -1,158 +1,257 @@
 import type { ArrayKind, Descriptor, Ownership } from "@gtkx/native";
 import type { AnyClass } from "@gtkx/utils";
+/** Descriptor variant for a `gint8`. */
 type Int8Descriptor = Extract<Descriptor, {
     kind: "int8";
 }>;
+/** Descriptor variant for a `guint8`. */
 type Uint8Descriptor = Extract<Descriptor, {
     kind: "uint8";
 }>;
+/** Descriptor variant for a `gint16`. */
 type Int16Descriptor = Extract<Descriptor, {
     kind: "int16";
 }>;
+/** Descriptor variant for a `guint16`. */
 type Uint16Descriptor = Extract<Descriptor, {
     kind: "uint16";
 }>;
+/** Descriptor variant for a `gint32`. */
 type Int32Descriptor = Extract<Descriptor, {
     kind: "int32";
 }>;
+/** Descriptor variant for a `guint32`. */
 type Uint32Descriptor = Extract<Descriptor, {
     kind: "uint32";
 }>;
+/** Descriptor variant for a `gint64` marshalled as a number. */
 type Int64Descriptor = Extract<Descriptor, {
     kind: "int64";
 }>;
+/** Descriptor variant for a `guint64` marshalled as a number. */
 type Uint64Descriptor = Extract<Descriptor, {
     kind: "uint64";
 }>;
+/** Descriptor variant for a `gint64` marshalled as a bigint. */
 type BigInt64Descriptor = Extract<Descriptor, {
     kind: "bigint64";
 }>;
+/** Descriptor variant for a `guint64` marshalled as a bigint. */
 type BigUint64Descriptor = Extract<Descriptor, {
     kind: "biguint64";
 }>;
+/** Descriptor variant for a `gfloat`. */
 type Float32Descriptor = Extract<Descriptor, {
     kind: "float32";
 }>;
+/** Descriptor variant for a `gdouble`. */
 type Float64Descriptor = Extract<Descriptor, {
     kind: "float64";
 }>;
+/** Descriptor variant for an enumeration, carrying the library and `get_type` symbol its GType comes from. */
 type EnumDescriptor = Extract<Descriptor, {
     kind: "enum";
 }>;
+/** Descriptor variant for a flags type, carrying the library and `get_type` symbol its GType comes from. */
 type FlagsDescriptor = Extract<Descriptor, {
     kind: "flags";
 }>;
+/** Descriptor variant for a `gboolean`. */
 type BooleanDescriptor = Extract<Descriptor, {
     kind: "boolean";
 }>;
+/** Descriptor variant for a C string. */
 type StringDescriptor = Extract<Descriptor, {
     kind: "string";
 }>;
+/** Descriptor variant for a `GObject`. */
 type ObjectDescriptor = Extract<Descriptor, {
     kind: "object";
 }>;
+/** Descriptor variant for a `gunichar`. */
 type UnicharDescriptor = Extract<Descriptor, {
     kind: "unichar";
 }>;
+/** Descriptor variant for the absence of a value. */
 type VoidDescriptor = Extract<Descriptor, {
     kind: "void";
 }>;
+/** Descriptor variant for an opaque `gpointer`. */
 type BufferDescriptor = Extract<Descriptor, {
     kind: "buffer";
 }>;
+/** Descriptor variant for a `GBoxed` value. */
 type BoxedDescriptor = Extract<Descriptor, {
     kind: "boxed";
 }>;
+/** Descriptor variant for a plain C struct, extended with the class its decoded value is wrapped in. */
 type StructDescriptor = Extract<Descriptor, {
     kind: "struct";
 }> & {
+    /** Class a decoded value is wrapped in; without it the wrapper comes from the value's own GType. */
     wrapperClass?: AnyClass;
 };
+/** Descriptor variant for a ref-counted fundamental type, extended with the class its decoded value is wrapped in. */
 type FundamentalDescriptor = Extract<Descriptor, {
     kind: "fundamental";
 }> & {
+    /** Class a decoded value is wrapped in; without it the wrapper comes from the type named by `typeName`. */
     wrapperClass?: AnyClass;
 };
+/** Descriptor variant for an array of items in one of the supported container layouts. */
 type ArrayDescriptor = Extract<Descriptor, {
     kind: "array";
 }>;
+/** Descriptor variant for a `GHashTable`, marshalled as an array of key/value pairs. */
 type HashTableDescriptor = Extract<Descriptor, {
     kind: "hashtable";
 }>;
+/** Descriptor variant for a function pointer a JavaScript function is marshalled into. */
 type CallbackDescriptor = Extract<Descriptor, {
     kind: "callback";
 }>;
+/** Descriptor variant for a pointer to another descriptor's value, for an output or inout argument. */
 type RefDescriptor = Extract<Descriptor, {
     kind: "ref";
 }>;
+/** Descriptor for a `GType`: a `guint64` marked so it resolves to `G_TYPE_GTYPE` rather than an integer. */
 type TypeDescriptor = BigUint64Descriptor & {
+    /** Distinguishes a GType from a plain `guint64` when the GLib type and the GValue type are resolved. */
     type: true;
 };
+/** How a boxed value is stored, and where its GType and free function are resolved from. */
 type BoxedOptions = {
-    callerAllocated?: boolean;
-    inline?: boolean;
+    /** The caller owns the storage the callee fills, so a decoded value is borrowed instead of copied. */
+    isCallerAllocated?: boolean;
+    /** The value is embedded in the containing struct rather than reached through a pointer. */
+    isInline?: boolean;
+    /** Whether a decoded value is owned by the caller; defaults to `"borrowed"`. */
     ownership?: Ownership;
+    /** Library `getTypeFnName` and `freeFnName` are resolved in. */
     sharedLibrary?: string;
+    /** Symbol returning the boxed GType, used when the type is not already registered under its name. */
     getTypeFnName?: string;
+    /** Symbol that frees the value, for a boxed type with no GType of its own. */
     freeFnName?: string;
+    /** Byte size of the value, needed to copy it into an inline field. */
     size?: number;
 };
+/** How the callee takes a callback's closure, and how long that closure has to stay alive. */
 type CallbackOptions = {
+    /** The callee also takes a destroy notify, which frees the closure once it is done with it. */
     hasDestroy?: boolean;
+    /** Signature of that destroy notify; defaults to `destroyNotify`, a one-argument `GDestroyNotify`. */
+    destroyKind?: CallbackDescriptor["destroyKind"];
+    /** The callee also takes a `user_data` pointer; without one the closure can never be freed. */
+    hasUserData?: boolean;
+    /** Position of `user_data` among the callback's own arguments, dropped before the closure is called. */
     userDataIndex?: number;
+    /** Lifetime of the closure; defaults to `notified` when `hasDestroy` is set and `call` otherwise. */
     scope?: CallbackDescriptor["scope"];
 };
+/** The lengths and strides a C array layout needs beyond its element type. */
 type ArrayOptions = {
+    /** Stride in bytes between elements stored inline in the array. */
     elementSize?: number | undefined;
+    /** Position of the argument carrying the element count, for a length-bounded array. */
     sizeParamIndex?: number | undefined;
+    /** Element count of a fixed-length array. */
     fixedSize?: number | undefined;
 };
+/** How a ref-counted fundamental value is named, wrapped and stored. */
 type FundamentalOptions = {
+    /** Whether a decoded value is owned by the caller; defaults to `"borrowed"`. */
     ownership?: Ownership;
+    /** GLib type name the wrapper class is looked up by. */
     typeName?: string;
+    /** Class a decoded value is wrapped in, instead of the one registered for `typeName`. */
     wrapperClass?: AnyClass;
-    inline?: boolean;
+    /** The value is embedded in the containing struct rather than reached through a pointer. */
+    isInline?: boolean;
 };
+/** How a plain C struct is stored and wrapped. */
 type StructOptions = {
-    callerAllocated?: boolean;
-    inline?: boolean;
+    /** The caller owns the storage the callee fills, so a decoded value is borrowed instead of copied. */
+    isCallerAllocated?: boolean;
+    /** The value is embedded in the containing struct rather than reached through a pointer. */
+    isInline?: boolean;
+    /** Byte size of the struct, needed to copy it rather than borrow the pointer. */
     size?: number;
+    /** Class a decoded value is wrapped in, instead of the one registered for its GType. */
     wrapperClass?: AnyClass;
 };
+/** Descriptor for a `gint8`, marshalled as a number. */
 declare const int8T: Int8Descriptor;
+/** Descriptor for a `guint8`, marshalled as a number. */
 declare const uint8T: Uint8Descriptor;
+/** Descriptor for a `gint16`, marshalled as a number. */
 declare const int16T: Int16Descriptor;
+/** Descriptor for a `guint16`, marshalled as a number. */
 declare const uint16T: Uint16Descriptor;
+/** Descriptor for a `gint32`, marshalled as a number. */
 declare const int32T: Int32Descriptor;
+/** Descriptor for a `guint32`, marshalled as a number. */
 declare const uint32T: Uint32Descriptor;
+/** Descriptor for a `gint64`, marshalled as a number and rejected outside the 2^53 safe range. */
 declare const int64T: Int64Descriptor;
+/** Descriptor for a `guint64`, marshalled as a number and rejected outside the 2^53 safe range. */
 declare const uint64T: Uint64Descriptor;
+/** Descriptor for a `gint64`, marshalled as a bigint so the full 64-bit range survives. */
 declare const bigint64T: BigInt64Descriptor;
+/** Descriptor for a `guint64`, marshalled as a bigint so the full 64-bit range survives. */
 declare const biguint64T: BigUint64Descriptor;
+/** Descriptor for a `GType`, marshalled as a bigint and recognized as a GType by GValue conversion. */
 declare const gtypeT: TypeDescriptor;
+/** Descriptor for a `gfloat`. */
 declare const float32T: Float32Descriptor;
+/** Descriptor for a `gdouble`. */
 declare const float64T: Float64Descriptor;
+/** Descriptor for a `gboolean`, marshalled as a JavaScript boolean. */
 declare const booleanT: BooleanDescriptor;
+/** Descriptor for the absence of a value, used as the return descriptor of a `void` function. */
 declare const voidT: VoidDescriptor;
+/** Descriptor for a `gunichar`, marshalled as a single-character string or a codepoint number. */
 declare const unicharT: UnicharDescriptor;
+/** Descriptor for an opaque `gpointer`, taken from a typed array's memory or a numeric address. */
 declare const bufferT: BufferDescriptor;
+/**
+ * Builds a descriptor for a C string, whose optional length sizes the caller-allocated buffer
+ * used when the string is passed by reference.
+ */
 declare const stringT: (ownership?: Ownership, length?: number) => StringDescriptor;
+/** Builds a descriptor for a `GObject`, wrapped in the class registered for its runtime GType. */
 declare const objectT: (ownership?: Ownership) => ObjectDescriptor;
+/** Wraps a descriptor in a pointer to it, for an output or inout argument. */
 declare const refT: (innerDescriptor: Descriptor, isInout?: boolean) => RefDescriptor;
+/** Builds a descriptor for a `GHashTable`, marshalled as an array of key/value pairs. */
 declare const hashTableT: (keyDescriptor: Descriptor, valueDescriptor: Descriptor, ownership?: Ownership) => HashTableDescriptor;
+/** Builds a descriptor for an enumeration, resolving its GType from the named `get_type` function. */
 declare const enumT: (sharedLibrary: string, typeFnName: string, isSigned: boolean) => EnumDescriptor;
+/** Builds a descriptor for a flags type, resolving its GType from the named `get_type` function. */
 declare const flagsT: (sharedLibrary: string, typeFnName: string, isSigned: boolean) => FlagsDescriptor;
+/** Builds a descriptor for a `GBoxed` value of the named type. */
 declare const boxedT: (typeName: string, options?: BoxedOptions) => BoxedDescriptor;
+/** Builds a descriptor for a plain C struct. */
 declare const structT: (ownership?: Ownership, options?: StructOptions) => StructDescriptor;
+/** Builds a descriptor for a fundamental type whose lifetime is managed by named ref and unref functions. */
 declare const fundamentalT: (sharedLibrary: string, refFnName: string, unrefFnName: string, options?: FundamentalOptions) => FundamentalDescriptor;
+/** Builds a descriptor for an array of items in one of the supported container layouts. */
 declare const arrayT: (itemDescriptor: Descriptor, arrayKind?: ArrayKind, ownership?: Ownership, options?: ArrayOptions) => ArrayDescriptor;
+/** Builds a descriptor for a `GList` of items. */
 declare const listT: (itemDescriptor: Descriptor, ownership?: Ownership) => ArrayDescriptor;
+/** Builds a descriptor for a `GSList` of items. */
 declare const slistT: (itemDescriptor: Descriptor, ownership?: Ownership) => ArrayDescriptor;
+/** Builds a descriptor for a `GPtrArray` of items. */
 declare const ptrArrayT: (itemDescriptor: Descriptor, ownership?: Ownership) => ArrayDescriptor;
+/** Builds a descriptor for a `GArray` of items, optionally with an explicit element size. */
 declare const gArrayT: (itemDescriptor: Descriptor, ownership?: Ownership, elementSize?: number) => ArrayDescriptor;
+/** Builds a descriptor for a `GByteArray`. */
 declare const byteArrayT: (ownership?: Ownership) => ArrayDescriptor;
+/** Builds a descriptor for a C array whose length is carried by another argument. */
 declare const sizedArrayT: (itemDescriptor: Descriptor, sizeParamIndex: number, ownership?: Ownership, elementSize?: number) => ArrayDescriptor;
+/** Builds a descriptor for a C array of a fixed length. */
 declare const fixedArrayT: (itemDescriptor: Descriptor, fixedSize: number, ownership?: Ownership, elementSize?: number) => ArrayDescriptor;
+/** Builds a descriptor for a function pointer, marshalling a JavaScript function into a native closure. */
 declare const callbackT: (argDescriptors: Descriptor[], returnDescriptor: Descriptor, options?: CallbackOptions) => CallbackDescriptor;
-export { int8T, uint8T, int16T, uint16T, int32T, uint32T, int64T, uint64T, bigint64T, biguint64T, gtypeT, float32T, float64T, booleanT, voidT, unicharT, bufferT, stringT, objectT, refT, hashTableT, enumT, flagsT, boxedT, structT, fundamentalT, arrayT, listT, slistT, ptrArrayT, gArrayT, byteArrayT, sizedArrayT, fixedArrayT, callbackT, type Int8Descriptor, type Uint8Descriptor, type Int16Descriptor, type Uint16Descriptor, type Int32Descriptor, type Uint32Descriptor, type Int64Descriptor, type Uint64Descriptor, type BigInt64Descriptor, type BigUint64Descriptor, type Float32Descriptor, type Float64Descriptor, type EnumDescriptor, type FlagsDescriptor, type BooleanDescriptor, type StringDescriptor, type ObjectDescriptor, type UnicharDescriptor, type VoidDescriptor, type BufferDescriptor, type BoxedDescriptor, type StructDescriptor, type FundamentalDescriptor, type ArrayDescriptor, type HashTableDescriptor, type CallbackDescriptor, type RefDescriptor, type TypeDescriptor, };
+export { int8T, uint8T, int16T, uint16T, int32T, uint32T, int64T, uint64T, bigint64T, biguint64T, gtypeT, float32T, float64T, booleanT, voidT, unicharT, bufferT, stringT, objectT, refT, hashTableT, enumT, flagsT, boxedT, structT, fundamentalT, arrayT, listT, slistT, ptrArrayT, gArrayT, byteArrayT, sizedArrayT, fixedArrayT, callbackT, type BoxedDescriptor, type StructDescriptor, type FundamentalDescriptor, type ArrayDescriptor, type HashTableDescriptor, type CallbackDescriptor, type RefDescriptor, };
 //# sourceMappingURL=descriptors.d.ts.map

package/dist/descriptors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"descriptors.d.ts","sourceRoot":"","sources":["../src/descriptors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5C,KAAK,cAAc,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAC5D,KAAK,eAAe,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAC9D,KAAK,eAAe,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAC9D,KAAK,gBAAgB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC;AAChE,KAAK,eAAe,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAC9D,KAAK,gBAAgB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC;AAChE,KAAK,eAAe,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAC9D,KAAK,gBAAgB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC;AAChE,KAAK,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC,CAAC;AACpE,KAAK,mBAAmB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,CAAC,CAAC;AACtE,KAAK,iBAAiB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC,CAAC;AAClE,KAAK,iBAAiB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC,CAAC;AAClE,KAAK,cAAc,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAC5D,KAAK,eAAe,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAC9D,KAAK,iBAAiB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC,CAAC;AAClE,KAAK,gBAAgB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC;AAChE,KAAK,gBAAgB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC;AAChE,KAAK,iBAAiB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC,CAAC;AAClE,KAAK,cAAc,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAC5D,KAAK,gBAAgB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC;AAChE,KAAK,eAAe,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAC9D,KAAK,gBAAgB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,GAAG;IAAE,YAAY,CAAC,EAAE,QAAQ,CAAA;CAAE,CAAC;AAC9F,KAAK,qBAAqB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,aAAa,CAAA;CAAE,CAAC,GAAG;IAAE,YAAY,CAAC,EAAE,QAAQ,CAAA;CAAE,CAAC;AACxG,KAAK,eAAe,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAC9D,KAAK,mBAAmB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,CAAC,CAAC;AACtE,KAAK,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC,CAAC;AACpE,KAAK,aAAa,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,CAAC,CAAC;AAC1D,KAAK,cAAc,GAAG,mBAAmB,GAAG;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC;AAE3D,KAAK,YAAY,GAAG;IAChB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,KAAK,eAAe,GAAG;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAC;CACvC,CAAC;AAEF,KAAK,YAAY,GAAG;IAChB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB,MAAM,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,KAAK,aAAa,GAAG;IACjB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,QAAQ,CAAC;CAC3B,CAAC;AAEF,QAAA,MAAM,KAAK,EAAE,cAAiC,CAAC;AAC/C,QAAA,MAAM,MAAM,EAAE,eAAmC,CAAC;AAClD,QAAA,MAAM,MAAM,EAAE,eAAmC,CAAC;AAClD,QAAA,MAAM,OAAO,EAAE,gBAAqC,CAAC;AACrD,QAAA,MAAM,MAAM,EAAE,eAAmC,CAAC;AAClD,QAAA,MAAM,OAAO,EAAE,gBAAqC,CAAC;AACrD,QAAA,MAAM,MAAM,EAAE,eAAmC,CAAC;AAClD,QAAA,MAAM,OAAO,EAAE,gBAAqC,CAAC;AACrD,QAAA,MAAM,SAAS,EAAE,kBAAyC,CAAC;AAC3D,QAAA,MAAM,UAAU,EAAE,mBAA2C,CAAC;AAC9D,QAAA,MAAM,MAAM,EAAE,cAAkD,CAAC;AACjE,QAAA,MAAM,QAAQ,EAAE,iBAAuC,CAAC;AACxD,QAAA,MAAM,QAAQ,EAAE,iBAAuC,CAAC;AACxD,QAAA,MAAM,QAAQ,EAAE,iBAAuC,CAAC;AACxD,QAAA,MAAM,KAAK,EAAE,cAAiC,CAAC;AAC/C,QAAA,MAAM,QAAQ,EAAE,iBAAuC,CAAC;AACxD,QAAA,MAAM,OAAO,EAAE,gBAAqC,CAAC;AAErD,QAAA,MAAM,OAAO,GAAI,YAAW,SAAsB,EAAE,SAAS,MAAM,KAAG,gBAC0B,CAAC;AAEjG,QAAA,MAAM,OAAO,GAAI,YAAW,SAAsB,KAAG,gBAAmD,CAAC;AAEzG,QAAA,MAAM,IAAI,GAAI,iBAAiB,UAAU,EAAE,iBAAe,KAAG,aACiC,CAAC;AAE/F,QAAA,MAAM,UAAU,GACZ,eAAe,UAAU,EACzB,iBAAiB,UAAU,EAC3B,YAAW,SAAsB,KAClC,mBAKD,CAAC;AAEH,QAAA,MAAM,KAAK,GAAI,eAAe,MAAM,EAAE,YAAY,MAAM,EAAE,UAAU,OAAO,KAAG,cAK5E,CAAC;AAEH,QAAA,MAAM,MAAM,GAAI,eAAe,MAAM,EAAE,YAAY,MAAM,EAAE,UAAU,OAAO,KAAG,eAK7E,CAAC;AAgCH,QAAA,MAAM,MAAM,GAAI,UAAU,MAAM,EAAE,UAAS,YAAiB,KAAG,eAU9D,CAAC;AAEF,QAAA,MAAM,OAAO,GAAI,YAAW,SAAsB,EAAE,UAAS,aAAkB,KAAG,gBAoBjF,CAAC;AAEF,QAAA,MAAM,YAAY,GACd,eAAe,MAAM,EACrB,WAAW,MAAM,EACjB,aAAa,MAAM,EACnB,UAAS,kBAAuB,KACjC,qBAiBF,CAAC;AAEF,QAAA,MAAM,MAAM,GACR,gBAAgB,UAAU,EAC1B,YAAW,SAAmB,EAC9B,YAAW,SAAsB,EACjC,UAAU,YAAY,KACvB,eAgBF,CAAC;AAEF,QAAA,MAAM,KAAK,GAAI,gBAAgB,UAAU,EAAE,YAAW,SAAsB,KAAG,eACjC,CAAC;AAE/C,QAAA,MAAM,MAAM,GAAI,gBAAgB,UAAU,EAAE,YAAW,SAAsB,KAAG,eACjC,CAAC;AAEhD,QAAA,MAAM,SAAS,GAAI,gBAAgB,UAAU,EAAE,YAAW,SAAsB,KAAG,eACjC,CAAC;AAEnD,QAAA,MAAM,OAAO,GACT,gBAAgB,UAAU,EAC1B,YAAW,SAAsB,EACjC,cAAc,MAAM,KACrB,eACqG,CAAC;AAEzG,QAAA,MAAM,UAAU,GAAI,YAAW,SAAsB,KAAG,eACb,CAAC;AAE5C,QAAA,MAAM,WAAW,GACb,gBAAgB,UAAU,EAC1B,gBAAgB,MAAM,EACtB,YAAW,SAAsB,EACjC,cAAc,MAAM,KACrB,eAA8F,CAAC;AAElG,QAAA,MAAM,WAAW,GACb,gBAAgB,UAAU,EAC1B,WAAW,MAAM,EACjB,YAAW,SAAsB,EACjC,cAAc,MAAM,KACrB,eAAyF,CAAC;AAE7F,QAAA,MAAM,SAAS,GACX,gBAAgB,UAAU,EAAE,EAC5B,kBAAkB,UAAU,EAC5B,UAAU,eAAe,KAC1B,kBAgBF,CAAC;AAEF,OAAO,EACH,KAAK,EACL,MAAM,EACN,MAAM,EACN,OAAO,EACP,MAAM,EACN,OAAO,EACP,MAAM,EACN,OAAO,EACP,SAAS,EACT,UAAU,EACV,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,KAAK,EACL,QAAQ,EACR,OAAO,EACP,OAAO,EACP,OAAO,EACP,IAAI,EACJ,UAAU,EACV,KAAK,EACL,MAAM,EACN,MAAM,EACN,OAAO,EACP,YAAY,EACZ,MAAM,EACN,KAAK,EACL,MAAM,EACN,SAAS,EACT,OAAO,EACP,UAAU,EACV,WAAW,EACX,WAAW,EACX,SAAS,EACT,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,aAAa,EAClB,KAAK,cAAc,GACtB,CAAC"}
+{"version":3,"file":"descriptors.d.ts","sourceRoot":"","sources":["../src/descriptors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5C,wCAAwC;AACxC,KAAK,cAAc,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAC5D,yCAAyC;AACzC,KAAK,eAAe,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAC9D,yCAAyC;AACzC,KAAK,eAAe,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAC9D,0CAA0C;AAC1C,KAAK,gBAAgB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC;AAChE,yCAAyC;AACzC,KAAK,eAAe,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAC9D,0CAA0C;AAC1C,KAAK,gBAAgB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC;AAChE,gEAAgE;AAChE,KAAK,eAAe,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAC9D,iEAAiE;AACjE,KAAK,gBAAgB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC;AAChE,gEAAgE;AAChE,KAAK,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC,CAAC;AACpE,iEAAiE;AACjE,KAAK,mBAAmB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,CAAC,CAAC;AACtE,yCAAyC;AACzC,KAAK,iBAAiB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC,CAAC;AAClE,0CAA0C;AAC1C,KAAK,iBAAiB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC,CAAC;AAClE,8GAA8G;AAC9G,KAAK,cAAc,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAC5D,4GAA4G;AAC5G,KAAK,eAAe,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAC9D,2CAA2C;AAC3C,KAAK,iBAAiB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC,CAAC;AAClE,yCAAyC;AACzC,KAAK,gBAAgB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC;AAChE,0CAA0C;AAC1C,KAAK,gBAAgB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC;AAChE,2CAA2C;AAC3C,KAAK,iBAAiB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC,CAAC;AAClE,qDAAqD;AACrD,KAAK,cAAc,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAC5D,mDAAmD;AACnD,KAAK,gBAAgB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC;AAChE,+CAA+C;AAC/C,KAAK,eAAe,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAE9D,wGAAwG;AACxG,KAAK,gBAAgB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,GAAG;IAC9D,oGAAoG;IACpG,YAAY,CAAC,EAAE,QAAQ,CAAC;CAC3B,CAAC;AAEF,sHAAsH;AACtH,KAAK,qBAAqB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,aAAa,CAAA;CAAE,CAAC,GAAG;IACxE,2GAA2G;IAC3G,YAAY,CAAC,EAAE,QAAQ,CAAC;CAC3B,CAAC;AAEF,0FAA0F;AAC1F,KAAK,eAAe,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAC9D,wFAAwF;AACxF,KAAK,mBAAmB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,CAAC,CAAC;AACtE,0FAA0F;AAC1F,KAAK,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC,CAAC;AACpE,uGAAuG;AACvG,KAAK,aAAa,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,CAAC,CAAC;AAE1D,4GAA4G;AAC5G,KAAK,cAAc,GAAG,mBAAmB,GAAG;IACxC,wGAAwG;IACxG,IAAI,EAAE,IAAI,CAAC;CACd,CAAC;AAEF,4FAA4F;AAC5F,KAAK,YAAY,GAAG;IAChB,sGAAsG;IACtG,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,4FAA4F;IAC5F,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gFAAgF;IAChF,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,gEAAgE;IAChE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qGAAqG;IACrG,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,8EAA8E;IAC9E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sEAAsE;IACtE,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,8FAA8F;AAC9F,KAAK,eAAe,GAAG;IACnB,+FAA+F;IAC/F,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,sGAAsG;IACtG,WAAW,CAAC,EAAE,kBAAkB,CAAC,aAAa,CAAC,CAAC;IAChD,+FAA+F;IAC/F,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,wGAAwG;IACxG,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qGAAqG;IACrG,KAAK,CAAC,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAC;CACvC,CAAC;AAEF,8EAA8E;AAC9E,KAAK,YAAY,GAAG;IAChB,mEAAmE;IACnE,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,uFAAuF;IACvF,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,6CAA6C;IAC7C,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,wEAAwE;AACxE,KAAK,kBAAkB,GAAG;IACtB,gFAAgF;IAChF,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,wDAAwD;IACxD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yFAAyF;IACzF,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB,4FAA4F;IAC5F,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,kDAAkD;AAClD,KAAK,aAAa,GAAG;IACjB,sGAAsG;IACtG,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,4FAA4F;IAC5F,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,iFAAiF;IACjF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wFAAwF;IACxF,YAAY,CAAC,EAAE,QAAQ,CAAC;CAC3B,CAAC;AAEF,wDAAwD;AACxD,QAAA,MAAM,KAAK,EAAE,cAAiC,CAAC;AAC/C,yDAAyD;AACzD,QAAA,MAAM,MAAM,EAAE,eAAmC,CAAC;AAClD,yDAAyD;AACzD,QAAA,MAAM,MAAM,EAAE,eAAmC,CAAC;AAClD,0DAA0D;AAC1D,QAAA,MAAM,OAAO,EAAE,gBAAqC,CAAC;AACrD,yDAAyD;AACzD,QAAA,MAAM,MAAM,EAAE,eAAmC,CAAC;AAClD,0DAA0D;AAC1D,QAAA,MAAM,OAAO,EAAE,gBAAqC,CAAC;AACrD,kGAAkG;AAClG,QAAA,MAAM,MAAM,EAAE,eAAmC,CAAC;AAClD,mGAAmG;AACnG,QAAA,MAAM,OAAO,EAAE,gBAAqC,CAAC;AACrD,2FAA2F;AAC3F,QAAA,MAAM,SAAS,EAAE,kBAAyC,CAAC;AAC3D,4FAA4F;AAC5F,QAAA,MAAM,UAAU,EAAE,mBAA2C,CAAC;AAC9D,uGAAuG;AACvG,QAAA,MAAM,MAAM,EAAE,cAAkD,CAAC;AACjE,iCAAiC;AACjC,QAAA,MAAM,QAAQ,EAAE,iBAAuC,CAAC;AACxD,kCAAkC;AAClC,QAAA,MAAM,QAAQ,EAAE,iBAAuC,CAAC;AACxD,uEAAuE;AACvE,QAAA,MAAM,QAAQ,EAAE,iBAAuC,CAAC;AACxD,iGAAiG;AACjG,QAAA,MAAM,KAAK,EAAE,cAAiC,CAAC;AAC/C,kGAAkG;AAClG,QAAA,MAAM,QAAQ,EAAE,iBAAuC,CAAC;AACxD,mGAAmG;AACnG,QAAA,MAAM,OAAO,EAAE,gBAAqC,CAAC;AAErD;;;GAGG;AACH,QAAA,MAAM,OAAO,GAAI,YAAW,SAAsB,EAAE,SAAS,MAAM,KAAG,gBAC0B,CAAC;AAEjG,kGAAkG;AAClG,QAAA,MAAM,OAAO,GAAI,YAAW,SAAsB,KAAG,gBAAmD,CAAC;AAEzG,8EAA8E;AAC9E,QAAA,MAAM,IAAI,GAAI,iBAAiB,UAAU,EAAE,iBAAe,KAAG,aACiC,CAAC;AAE/F,yFAAyF;AACzF,QAAA,MAAM,UAAU,GACZ,eAAe,UAAU,EACzB,iBAAiB,UAAU,EAC3B,YAAW,SAAsB,KAClC,mBAKD,CAAC;AAEH,sGAAsG;AACtG,QAAA,MAAM,KAAK,GAAI,eAAe,MAAM,EAAE,YAAY,MAAM,EAAE,UAAU,OAAO,KAAG,cAK5E,CAAC;AAEH,oGAAoG;AACpG,QAAA,MAAM,MAAM,GAAI,eAAe,MAAM,EAAE,YAAY,MAAM,EAAE,UAAU,OAAO,KAAG,eAK7E,CAAC;AAgCH,kEAAkE;AAClE,QAAA,MAAM,MAAM,GAAI,UAAU,MAAM,EAAE,UAAS,YAAiB,KAAG,eAU9D,CAAC;AAEF,gDAAgD;AAChD,QAAA,MAAM,OAAO,GAAI,YAAW,SAAsB,EAAE,UAAS,aAAkB,KAAG,gBAoBjF,CAAC;AAEF,6GAA6G;AAC7G,QAAA,MAAM,YAAY,GACd,eAAe,MAAM,EACrB,WAAW,MAAM,EACjB,aAAa,MAAM,EACnB,UAAS,kBAAuB,KACjC,qBAiBF,CAAC;AAEF,2FAA2F;AAC3F,QAAA,MAAM,MAAM,GACR,gBAAgB,UAAU,EAC1B,YAAW,SAAmB,EAC9B,YAAW,SAAsB,EACjC,UAAU,YAAY,KACvB,eAgBF,CAAC;AAEF,kDAAkD;AAClD,QAAA,MAAM,KAAK,GAAI,gBAAgB,UAAU,EAAE,YAAW,SAAsB,KAAG,eACjC,CAAC;AAE/C,mDAAmD;AACnD,QAAA,MAAM,MAAM,GAAI,gBAAgB,UAAU,EAAE,YAAW,SAAsB,KAAG,eACjC,CAAC;AAEhD,sDAAsD;AACtD,QAAA,MAAM,SAAS,GAAI,gBAAgB,UAAU,EAAE,YAAW,SAAsB,KAAG,eACjC,CAAC;AAEnD,6FAA6F;AAC7F,QAAA,MAAM,OAAO,GACT,gBAAgB,UAAU,EAC1B,YAAW,SAAsB,EACjC,cAAc,MAAM,KACrB,eACqG,CAAC;AAEzG,8CAA8C;AAC9C,QAAA,MAAM,UAAU,GAAI,YAAW,SAAsB,KAAG,eACb,CAAC;AAE5C,qFAAqF;AACrF,QAAA,MAAM,WAAW,GACb,gBAAgB,UAAU,EAC1B,gBAAgB,MAAM,EACtB,YAAW,SAAsB,EACjC,cAAc,MAAM,KACrB,eAA8F,CAAC;AAElG,2DAA2D;AAC3D,QAAA,MAAM,WAAW,GACb,gBAAgB,UAAU,EAC1B,WAAW,MAAM,EACjB,YAAW,SAAsB,EACjC,cAAc,MAAM,KACrB,eAAyF,CAAC;AAE7F,2GAA2G;AAC3G,QAAA,MAAM,SAAS,GACX,gBAAgB,UAAU,EAAE,EAC5B,kBAAkB,UAAU,EAC5B,UAAU,eAAe,KAC1B,kBAwBF,CAAC;AAEF,OAAO,EACH,KAAK,EACL,MAAM,EACN,MAAM,EACN,OAAO,EACP,MAAM,EACN,OAAO,EACP,MAAM,EACN,OAAO,EACP,SAAS,EACT,UAAU,EACV,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,KAAK,EACL,QAAQ,EACR,OAAO,EACP,OAAO,EACP,OAAO,EACP,IAAI,EACJ,UAAU,EACV,KAAK,EACL,MAAM,EACN,MAAM,EACN,OAAO,EACP,YAAY,EACZ,MAAM,EACN,KAAK,EACL,MAAM,EACN,SAAS,EACT,OAAO,EACP,UAAU,EACV,WAAW,EACX,WAAW,EACX,SAAS,EACT,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,aAAa,GACrB,CAAC"}

package/dist/descriptors.js

@@ -1,40 +1,66 @@
+/** Descriptor for a `gint8`, marshalled as a number. */
 const int8T = { kind: "int8" };
+/** Descriptor for a `guint8`, marshalled as a number. */
 const uint8T = { kind: "uint8" };
+/** Descriptor for a `gint16`, marshalled as a number. */
 const int16T = { kind: "int16" };
+/** Descriptor for a `guint16`, marshalled as a number. */
 const uint16T = { kind: "uint16" };
+/** Descriptor for a `gint32`, marshalled as a number. */
 const int32T = { kind: "int32" };
+/** Descriptor for a `guint32`, marshalled as a number. */
 const uint32T = { kind: "uint32" };
+/** Descriptor for a `gint64`, marshalled as a number and rejected outside the 2^53 safe range. */
 const int64T = { kind: "int64" };
+/** Descriptor for a `guint64`, marshalled as a number and rejected outside the 2^53 safe range. */
 const uint64T = { kind: "uint64" };
+/** Descriptor for a `gint64`, marshalled as a bigint so the full 64-bit range survives. */
 const bigint64T = { kind: "bigint64" };
+/** Descriptor for a `guint64`, marshalled as a bigint so the full 64-bit range survives. */
 const biguint64T = { kind: "biguint64" };
+/** Descriptor for a `GType`, marshalled as a bigint and recognized as a GType by GValue conversion. */
 const gtypeT = { kind: "biguint64", type: true };
+/** Descriptor for a `gfloat`. */
 const float32T = { kind: "float32" };
+/** Descriptor for a `gdouble`. */
 const float64T = { kind: "float64" };
+/** Descriptor for a `gboolean`, marshalled as a JavaScript boolean. */
 const booleanT = { kind: "boolean" };
+/** Descriptor for the absence of a value, used as the return descriptor of a `void` function. */
 const voidT = { kind: "void" };
+/** Descriptor for a `gunichar`, marshalled as a single-character string or a codepoint number. */
 const unicharT = { kind: "unichar" };
+/** Descriptor for an opaque `gpointer`, taken from a typed array's memory or a numeric address. */
 const bufferT = { kind: "buffer" };
+/**
+ * Builds a descriptor for a C string, whose optional length sizes the caller-allocated buffer
+ * used when the string is passed by reference.
+ */
 const stringT = (ownership = "borrowed", length) => length === undefined ? { kind: "string", ownership } : { kind: "string", ownership, length };
+/** Builds a descriptor for a `GObject`, wrapped in the class registered for its runtime GType. */
 const objectT = (ownership = "borrowed") => ({ kind: "object", ownership });
+/** Wraps a descriptor in a pointer to it, for an output or inout argument. */
 const refT = (innerDescriptor, isInout = false) => isInout ? { kind: "ref", innerDescriptor, inout: true } : { kind: "ref", innerDescriptor };
+/** Builds a descriptor for a `GHashTable`, marshalled as an array of key/value pairs. */
 const hashTableT = (keyDescriptor, valueDescriptor, ownership = "borrowed") => ({
     kind: "hashtable",
     keyDescriptor,
     valueDescriptor,
     ownership,
 });
+/** Builds a descriptor for an enumeration, resolving its GType from the named `get_type` function. */
 const enumT = (sharedLibrary, typeFnName, isSigned) => ({
     kind: "enum",
     sharedLibrary,
     getTypeFnName: typeFnName,
-    signed: isSigned,
+    isSigned,
 });
+/** Builds a descriptor for a flags type, resolving its GType from the named `get_type` function. */
 const flagsT = (sharedLibrary, typeFnName, isSigned) => ({
     kind: "flags",
     sharedLibrary,
     getTypeFnName: typeFnName,
-    signed: isSigned,
+    isSigned,
 });
 const applyBoxedNames = (result, options) => {
     if (options.sharedLibrary !== undefined) {
@@ -49,16 +75,17 @@ const applyBoxedNames = (result, options) => {
 };
 const applyBoxedOptions = (result, options) => {
     applyBoxedNames(result, options);
-    if (options.callerAllocated) {
-        result.callerAllocated = true;
+    if (options.isCallerAllocated) {
+        result.isCallerAllocated = true;
     }
-    if (options.inline) {
-        result.inline = true;
+    if (options.isInline) {
+        result.isInline = true;
     }
     if (options.size !== undefined) {
         result.size = options.size;
     }
 };
+/** Builds a descriptor for a `GBoxed` value of the named type. */
 const boxedT = (typeName, options = {}) => {
     const result = {
         kind: "boxed",
@@ -68,6 +95,7 @@ const boxedT = (typeName, options = {}) => {
     applyBoxedOptions(result, options);
     return result;
 };
+/** Builds a descriptor for a plain C struct. */
 const structT = (ownership = "borrowed", options = {}) => {
     const result = { kind: "struct", ownership };
     if (options.size !== undefined) {
@@ -76,14 +104,15 @@ const structT = (ownership = "borrowed", options = {}) => {
     if (options.wrapperClass !== undefined) {
         result.wrapperClass = options.wrapperClass;
     }
-    if (options.callerAllocated) {
-        result.callerAllocated = true;
+    if (options.isCallerAllocated) {
+        result.isCallerAllocated = true;
     }
-    if (options.inline) {
-        result.inline = true;
+    if (options.isInline) {
+        result.isInline = true;
     }
     return result;
 };
+/** Builds a descriptor for a fundamental type whose lifetime is managed by named ref and unref functions. */
 const fundamentalT = (sharedLibrary, refFnName, unrefFnName, options = {}) => {
     const ownership = options.ownership ?? "borrowed";
     const result = { kind: "fundamental", ownership, sharedLibrary, refFnName, unrefFnName };
@@ -93,11 +122,12 @@ const fundamentalT = (sharedLibrary, refFnName, unrefFnName, options = {}) => {
     if (options.wrapperClass !== undefined) {
         result.wrapperClass = options.wrapperClass;
     }
-    if (options.inline) {
-        result.inline = true;
+    if (options.isInline) {
+        result.isInline = true;
     }
     return result;
 };
+/** Builds a descriptor for an array of items in one of the supported container layouts. */
 const arrayT = (itemDescriptor, arrayKind = "array", ownership = "borrowed", options) => {
     const result = { kind: "array", itemDescriptor, arrayKind, ownership };
     if (options?.elementSize !== undefined) {
@@ -111,18 +141,32 @@ const arrayT = (itemDescriptor, arrayKind = "array", ownership = "borrowed", opt
     }
     return result;
 };
+/** Builds a descriptor for a `GList` of items. */
 const listT = (itemDescriptor, ownership = "borrowed") => arrayT(itemDescriptor, "glist", ownership);
+/** Builds a descriptor for a `GSList` of items. */
 const slistT = (itemDescriptor, ownership = "borrowed") => arrayT(itemDescriptor, "gslist", ownership);
+/** Builds a descriptor for a `GPtrArray` of items. */
 const ptrArrayT = (itemDescriptor, ownership = "borrowed") => arrayT(itemDescriptor, "gptrarray", ownership);
+/** Builds a descriptor for a `GArray` of items, optionally with an explicit element size. */
 const gArrayT = (itemDescriptor, ownership = "borrowed", elementSize) => arrayT(itemDescriptor, "garray", ownership, elementSize === undefined ? undefined : { elementSize });
+/** Builds a descriptor for a `GByteArray`. */
 const byteArrayT = (ownership = "borrowed") => arrayT(uint8T, "gbytearray", ownership);
+/** Builds a descriptor for a C array whose length is carried by another argument. */
 const sizedArrayT = (itemDescriptor, sizeParamIndex, ownership = "borrowed", elementSize) => arrayT(itemDescriptor, "sized", ownership, { sizeParamIndex, elementSize });
+/** Builds a descriptor for a C array of a fixed length. */
 const fixedArrayT = (itemDescriptor, fixedSize, ownership = "borrowed", elementSize) => arrayT(itemDescriptor, "fixed", ownership, { fixedSize, elementSize });
+/** Builds a descriptor for a function pointer, marshalling a JavaScript function into a native closure. */
 const callbackT = (argDescriptors, returnDescriptor, options) => {
     const result = { kind: "callback", argDescriptors, returnDescriptor };
     if (options?.hasDestroy !== undefined) {
         result.hasDestroy = options.hasDestroy;
     }
+    if (options?.destroyKind !== undefined) {
+        result.destroyKind = options.destroyKind;
+    }
+    if (options?.hasUserData !== undefined) {
+        result.hasUserData = options.hasUserData;
+    }
     if (options?.userDataIndex !== undefined) {
         result.userDataIndex = options.userDataIndex;
     }