@gtkx/codegen 1.0.0-rc.3 → 1.0.0

package/dist/writer/module.js.map

@@ -1 +1 @@
-{"version":3,"file":"module.js","sourceRoot":"","sources":["../../src/writer/module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,MAAM,aAAa;IACP,QAAQ,GAAa,EAAE,CAAC;IACxB,YAAY,GAAgB,IAAI,GAAG,EAAE,CAAC;IACtC,kBAAkB,GAAwB,IAAI,GAAG,EAAE,CAAC;IACpD,YAAY,GAAa,EAAE,CAAC;IAC5B,aAAa,GAAa,EAAE,CAAC;IAC9B,OAAO,GAAmB,IAAI,cAAc,EAAE,CAAC;IAEtD,aAAa,CAAC,IAAY,EAAE,IAAa;QACrC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACrB,IAAI,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,OAAO;YACX,CAAC;YAED,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,eAAe,CAAC,UAAkB;QAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAEzD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,QAAQ,CAAC;QACpB,CAAC;QAED,MAAM,IAAI,GAAG,QAAQ,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5D,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,aAAa,CAAC,SAAS,IAAI,MAAM,UAAU,GAAG,EAAE,IAAI,CAAC,CAAC;QAE3D,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,iBAAiB,CAAC,IAAY;QAC1B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,kBAAkB,CAAC,IAAY;QAC3B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,QAAQ;QACJ,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QAE7C,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1C,CAAC;QAED,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAC9C,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IACxC,CAAC;CACJ;AAED,OAAO,EAAE,aAAa,EAAE,CAAC","sourcesContent":["import { ImportsBuilder } from \"./imports.js\";\n\nclass ModuleBuilder {\n    private bindings: string[] = [];\n    private bindingNames: Set<string> = new Set();\n    private hoistedDescriptors: Map<string, string> = new Map();\n    private declarations: string[] = [];\n    private registrations: string[] = [];\n    public imports: ImportsBuilder = new ImportsBuilder();\n\n    appendBinding(code: string, name?: string): void {\n        if (name !== undefined) {\n            if (this.bindingNames.has(name)) {\n                return;\n            }\n\n            this.bindingNames.add(name);\n        }\n\n        this.bindings.push(code);\n    }\n\n    hoistDescriptor(expression: string): string {\n        const existing = this.hoistedDescriptors.get(expression);\n\n        if (existing !== undefined) {\n            return existing;\n        }\n\n        const name = `_desc${String(this.hoistedDescriptors.size)}`;\n        this.hoistedDescriptors.set(expression, name);\n        this.appendBinding(`const ${name} = ${expression};`, name);\n\n        return name;\n    }\n\n    appendDeclaration(code: string): void {\n        this.declarations.push(code);\n    }\n\n    appendRegistration(code: string): void {\n        this.registrations.push(code);\n    }\n\n    toSource(): string {\n        const sections: string[] = [];\n        const importsBlock = this.imports.toSource();\n\n        if (importsBlock.length > 0) {\n            sections.push(importsBlock.trimEnd());\n        }\n\n        if (this.declarations.length > 0) {\n            sections.push(this.declarations.join(\"\\n\\n\"));\n        }\n\n        if (this.bindings.length > 0) {\n            sections.push(this.bindings.join(\"\\n\\n\"));\n        }\n\n        if (this.registrations.length > 0) {\n            sections.push(this.registrations.join(\"\\n\\n\"));\n        }\n\n        return `${sections.join(\"\\n\\n\")}\\n`;\n    }\n}\n\nexport { ModuleBuilder };\n"]}
+{"version":3,"file":"module.js","sourceRoot":"","sources":["../../src/writer/module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAO9C,MAAM,aAAa;IACP,QAAQ,GAAa,EAAE,CAAC;IACxB,YAAY,GAAgB,IAAI,GAAG,EAAE,CAAC;IACtC,kBAAkB,GAAwB,IAAI,GAAG,EAAE,CAAC;IACpD,YAAY,GAAa,EAAE,CAAC;IAC5B,aAAa,GAAwB,IAAI,GAAG,EAAE,CAAC;IAC/C,aAAa,GAAa,EAAE,CAAC;IAC9B,OAAO,GAAmB,IAAI,cAAc,EAAE,CAAC;IAE9C,aAAa,CAAC,QAAsB;QACxC,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEpD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,QAAQ,CAAC,KAAK,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CACX,uBAAuB,QAAQ,CAAC,IAAI,0BAA0B,KAAK,QAAQ,QAAQ,CAAC,KAAK,IAAI;gBAC7F,mEAAmE,CACtE,CAAC;QACN,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED,aAAa,CAAC,IAAY,EAAE,IAAa;QACrC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACrB,IAAI,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,OAAO;YACX,CAAC;YAED,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,eAAe,CAAC,UAAkB;QAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAEzD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,QAAQ,CAAC;QACpB,CAAC;QAED,MAAM,IAAI,GAAG,QAAQ,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5D,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,aAAa,CAAC,SAAS,IAAI,MAAM,UAAU,GAAG,EAAE,IAAI,CAAC,CAAC;QAE3D,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,iBAAiB,CAAC,IAAY,EAAE,QAAuB;QACnD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,kBAAkB,CAAC,IAAY;QAC3B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,QAAQ;QACJ,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QAE7C,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1C,CAAC;QAED,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAC9C,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IACxC,CAAC;CACJ;AAED,OAAO,EAAqB,aAAa,EAAE,CAAC","sourcesContent":["import { ImportsBuilder } from \"./imports.js\";\n\ntype DeclaredType = {\n    name: string;\n    owner: string;\n};\n\nclass ModuleBuilder {\n    private bindings: string[] = [];\n    private bindingNames: Set<string> = new Set();\n    private hoistedDescriptors: Map<string, string> = new Map();\n    private declarations: string[] = [];\n    private declaredTypes: Map<string, string> = new Map();\n    private registrations: string[] = [];\n    public imports: ImportsBuilder = new ImportsBuilder();\n\n    private claimTypeName(declared: DeclaredType): void {\n        const owner = this.declaredTypes.get(declared.name);\n\n        if (owner !== undefined && owner !== declared.owner) {\n            throw new Error(\n                `The generated type '${declared.name}' is declared for both ${owner} and ${declared.owner}. ` +\n                \"Rename one of them, or drop the namespace from the configuration.\",\n            );\n        }\n\n        this.declaredTypes.set(declared.name, declared.owner);\n    }\n\n    appendBinding(code: string, name?: string): void {\n        if (name !== undefined) {\n            if (this.bindingNames.has(name)) {\n                return;\n            }\n\n            this.bindingNames.add(name);\n        }\n\n        this.bindings.push(code);\n    }\n\n    hoistDescriptor(expression: string): string {\n        const existing = this.hoistedDescriptors.get(expression);\n\n        if (existing !== undefined) {\n            return existing;\n        }\n\n        const name = `_desc${String(this.hoistedDescriptors.size)}`;\n        this.hoistedDescriptors.set(expression, name);\n        this.appendBinding(`const ${name} = ${expression};`, name);\n\n        return name;\n    }\n\n    appendDeclaration(code: string, declared?: DeclaredType): void {\n        if (declared !== undefined) {\n            this.claimTypeName(declared);\n        }\n\n        this.declarations.push(code);\n    }\n\n    appendRegistration(code: string): void {\n        this.registrations.push(code);\n    }\n\n    toSource(): string {\n        const sections: string[] = [];\n        const importsBlock = this.imports.toSource();\n\n        if (importsBlock.length > 0) {\n            sections.push(importsBlock.trimEnd());\n        }\n\n        if (this.declarations.length > 0) {\n            sections.push(this.declarations.join(\"\\n\\n\"));\n        }\n\n        if (this.bindings.length > 0) {\n            sections.push(this.bindings.join(\"\\n\\n\"));\n        }\n\n        if (this.registrations.length > 0) {\n            sections.push(this.registrations.join(\"\\n\\n\"));\n        }\n\n        return `${sections.join(\"\\n\\n\")}\\n`;\n    }\n}\n\nexport { type DeclaredType, ModuleBuilder };\n"]}

package/overrides/gdk/rgba.ts.ejs

@@ -1,11 +1,37 @@
 import { RGBA as GeneratedRGBA } from "../gdk.js";
 
+/**
+ * Parses a CSS color string into a new `RGBA`.
+ *
+ * @param value a CSS color string, such as `#rgb`, `rgb(r,g,b)`, or a named color
+ * @returns the parsed color
+ */
 const create = (value: string): GeneratedRGBA => {
     const rgba = new GeneratedRGBA();
     rgba.parse(value);
     return rgba;
 };
 
+/**
+ * Represents a color, in a way that is compatible with cairo's notion of color.
+ *
+ * `GdkRGBA` is a convenient way to pass colors around. It's based on
+ * cairo's way to deal with colors and mirrors its behavior. All values
+ * are in the range from 0.0 to 1.0 inclusive. So the color
+ * (0.0, 0.0, 0.0, 0.0) represents transparent black and
+ * (1.0, 1.0, 1.0, 1.0) is opaque white. Other values will
+ * be clamped to this range when drawing.
+ */
 export const RGBA: typeof GeneratedRGBA & { create: typeof create } = Object.assign(GeneratedRGBA, { create });
 
+/**
+ * Represents a color, in a way that is compatible with cairo's notion of color.
+ *
+ * `GdkRGBA` is a convenient way to pass colors around. It's based on
+ * cairo's way to deal with colors and mirrors its behavior. All values
+ * are in the range from 0.0 to 1.0 inclusive. So the color
+ * (0.0, 0.0, 0.0, 0.0) represents transparent black and
+ * (1.0, 1.0, 1.0, 1.0) is opaque white. Other values will
+ * be clamped to this range when drawing.
+ */
 export type RGBA = GeneratedRGBA;

package/overrides/gobject/object.ts.ejs

@@ -1,42 +1,87 @@
-import { offSignal, onceSignal, onSignal } from "@gtkx/runtime";
-import { Object as GObject, signalHandlerDisconnect, type Type } from "../gobject.js";
+import { disconnectSignal, offSignal, onceSignal, onSignal } from "@gtkx/runtime";
+import { Object as GObject, type Type } from "../gobject.js";
 
 type Listener = (...args: unknown[]) => unknown;
 
 declare module "../gobject.js" {
     interface Object {
+        /** GType the instance's class is registered under, carried on the prototype. */
         __type__: Type;
 
+        /**
+         * Disconnects the handler `connect` returned the given id for.
+         *
+         * @param handlerId Id of the handler to disconnect.
+         */
         disconnect(handlerId: number): void;
 
-        on(sigName: string, callback: (...args: unknown[]) => unknown, after?: boolean): Object;
+        /**
+         * Connects a handler that runs on every emission of `sigName`, remembering it so `off` can
+         * take the same callback back off again.
+         *
+         * @param sigName Signal to connect to.
+         * @param callback Handler invoked on each emission.
+         * @param isAfter Run the handler after the default handler rather than before it.
+         * @returns The same object, so calls chain.
+         */
+        on(sigName: string, callback: (...args: unknown[]) => unknown, isAfter?: boolean): Object;
 
-        once(sigName: string, callback: (...args: unknown[]) => unknown, after?: boolean): Object;
+        /**
+         * Connects a handler that runs at most once and disconnects itself after the first emission.
+         *
+         * @param sigName Signal to connect to.
+         * @param callback Handler invoked on the first emission.
+         * @param isAfter Run the handler after the default handler rather than before it.
+         * @returns The same object, so calls chain.
+         */
+        once(sigName: string, callback: (...args: unknown[]) => unknown, isAfter?: boolean): Object;
 
+        /**
+         * Disconnects a handler previously connected with `on` or `once`, given the same callback.
+         *
+         * @param sigName Signal the handler was connected to.
+         * @param callback The handler that was connected.
+         * @returns The same object, so calls chain.
+         */
         off(sigName: string, callback: (...args: unknown[]) => unknown): Object;
 
-        addEventListener(sigName: string, callback: (...args: unknown[]) => unknown, after?: boolean): Object;
+        /**
+         * Alias of `on`, for callers who prefer the DOM spelling.
+         *
+         * @param sigName Signal to connect to.
+         * @param callback Handler invoked on each emission.
+         * @param isAfter Run the handler after the default handler rather than before it.
+         * @returns The same object, so calls chain.
+         */
+        addEventListener(sigName: string, callback: (...args: unknown[]) => unknown, isAfter?: boolean): Object;
 
+        /**
+         * Alias of `off`, for callers who prefer the DOM spelling.
+         *
+         * @param sigName Signal the handler was connected to.
+         * @param callback The handler that was connected.
+         * @returns The same object, so calls chain.
+         */
         removeEventListener(sigName: string, callback: (...args: unknown[]) => unknown): Object;
     }
 }
 
 type GObjectWithConnect = GObject & {
-    connect(sigName: string, callback: Listener, after?: boolean): number;
+    connect(sigName: string, callback: Listener, isAfter?: boolean): number;
 };
 
 GObject.prototype.disconnect = function disconnect(handlerId: number): void {
-    signalHandlerDisconnect(this, BigInt(handlerId));
+    disconnectSignal(this, handlerId);
 };
 
-function onImpl(this: GObjectWithConnect, sigName: string, callback: Listener, after?: boolean): GObject {
-    onSignal(this, sigName, callback, after);
+function onImpl(this: GObjectWithConnect, sigName: string, callback: Listener, isAfter?: boolean): GObject {
+    onSignal(this, sigName, callback, isAfter);
     return this;
 }
 GObject.prototype.on = onImpl;
 
-function onceImpl(this: GObjectWithConnect, sigName: string, callback: Listener, after?: boolean): GObject {
-    onceSignal(this, sigName, callback, after);
+function onceImpl(this: GObjectWithConnect, sigName: string, callback: Listener, isAfter?: boolean): GObject {
+    onceSignal(this, sigName, callback, isAfter);
     return this;
 }
 GObject.prototype.once = onceImpl;

package/overrides/gobject/value.ts.ejs

@@ -1,6 +1,13 @@
 import { getBoxedValue, getHandle, setBoxedValue } from "@gtkx/runtime";
 import { type Type, Value } from "../gobject.js";
 
+/**
+ * Allocates a `Value`, initializes it to `gtype`, and hands it to `populate` to fill in.
+ *
+ * @param gtype GType the value holds.
+ * @param populate Called with the initialized value to write the contents.
+ * @returns The populated value.
+ */
 export const buildValue = (gtype: Type, populate: (value: Value) => void): Value => {
     const value = new Value();
     value.init(gtype);

package/overrides/graphene/structs.ts.ejs

@@ -1,37 +1,92 @@
 import { Point as GeneratedPoint, Rect as GeneratedRect, Size as GeneratedSize } from "../graphene.js";
 
+/**
+ * Allocates a new `Point` and initializes it to the given coordinates.
+ *
+ * @param x the X coordinate
+ * @param y the Y coordinate
+ * @returns the initialized point
+ */
 const createPoint = (x: number, y: number): GeneratedPoint => {
     const point = GeneratedPoint.alloc();
     point.init(x, y);
     return point;
 };
 
+/**
+ * Allocates a new `Rect` and initializes it to the given origin and size.
+ *
+ * @param x the X coordinate of the origin
+ * @param y the Y coordinate of the origin
+ * @param width the width of the rectangle
+ * @param height the height of the rectangle
+ * @returns the initialized rectangle
+ */
 const createRect = (x: number, y: number, width: number, height: number): GeneratedRect => {
     const rect = GeneratedRect.alloc();
     rect.init(x, y, width, height);
     return rect;
 };
 
+/**
+ * Allocates a new `Size` and initializes it to the given width and height.
+ *
+ * @param width the width
+ * @param height the height
+ * @returns the initialized size
+ */
 const createSize = (width: number, height: number): GeneratedSize => {
     const size = GeneratedSize.alloc();
     size.init(width, height);
     return size;
 };
 
+/** A point with two coordinates. */
 export const Point: typeof GeneratedPoint & { create: typeof createPoint } = Object.assign(GeneratedPoint, {
     create: createPoint,
 });
 
+/** A point with two coordinates. */
 export type Point = GeneratedPoint;
 
+/**
+ * The location and size of a rectangle region.
+ *
+ * The width and height of a `graphene_rect_t` can be negative; for instance,
+ * a `graphene_rect_t` with an origin of [ 0, 0 ] and a size of [ 10, 10 ] is
+ * equivalent to a `graphene_rect_t` with an origin of [ 10, 10 ] and a size
+ * of [ -10, -10 ].
+ *
+ * Application code can normalize rectangles using `graphene_rect_normalize()`;
+ * this function will ensure that the width and height of a rectangle are
+ * positive values. All functions taking a `graphene_rect_t` as an argument
+ * will internally operate on a normalized copy; all functions returning a
+ * `graphene_rect_t` will always return a normalized rectangle.
+ */
 export const Rect: typeof GeneratedRect & { create: typeof createRect } = Object.assign(GeneratedRect, {
     create: createRect,
 });
 
+/**
+ * The location and size of a rectangle region.
+ *
+ * The width and height of a `graphene_rect_t` can be negative; for instance,
+ * a `graphene_rect_t` with an origin of [ 0, 0 ] and a size of [ 10, 10 ] is
+ * equivalent to a `graphene_rect_t` with an origin of [ 10, 10 ] and a size
+ * of [ -10, -10 ].
+ *
+ * Application code can normalize rectangles using `graphene_rect_normalize()`;
+ * this function will ensure that the width and height of a rectangle are
+ * positive values. All functions taking a `graphene_rect_t` as an argument
+ * will internally operate on a normalized copy; all functions returning a
+ * `graphene_rect_t` will always return a normalized rectangle.
+ */
 export type Rect = GeneratedRect;
 
+/** A size. */
 export const Size: typeof GeneratedSize & { create: typeof createSize } = Object.assign(GeneratedSize, {
     create: createSize,
 });
 
+/** A size. */
 export type Size = GeneratedSize;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gtkx/codegen",
-  "version": "1.0.0-rc.3",
+  "version": "1.0.0",
   "description": "Generates the typed GTKX bindings and API reference from GIR and OpenGL registry data",
   "keywords": [
     "gtkx",
@@ -29,13 +29,9 @@
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
-    "./gi": {
-      "types": "./dist/gi.d.ts",
-      "default": "./dist/gi.js"
-    },
-    "./jsx": {
-      "types": "./dist/jsx.d.ts",
-      "default": "./dist/jsx.js"
+    "./internal": {
+      "types": "./dist/internal.d.ts",
+      "default": "./dist/internal.js"
     }
   },
   "sideEffects": false,
@@ -48,11 +44,11 @@
     "node": ">=24"
   },
   "dependencies": {
-    "@types/node": "^26.1.2",
+    "@types/node": "^26.2.0",
     "fast-xml-parser": "^5.10.1",
     "typescript": "^6.0.3",
-    "@gtkx/react": "1.0.0-rc.3",
-    "@gtkx/utils": "1.0.0-rc.3"
+    "@gtkx/utils": "1.0.0",
+    "@gtkx/react": "1.0.0"
   },
   "scripts": {
     "release": "tsx ../../scripts/release-package.ts"

package/src/analysis/descriptor-render.ts

@@ -48,20 +48,21 @@ import {
     tUint64,
     tVoid,
 } from "./descriptor.js";
+import { carrayFor, isUnboundedArray, primitiveCategoryFor } from "./type-shape.js";
 
 type RenderDescriptorOptions = {
     argIndexOffset?: number;
-    /** GIR parameter index to emitted argument index, for callables that drop parameters. */
     argIndexMap?: Map<number, number> | undefined;
-    callerAllocated?: boolean;
+    hasOutIndirection?: boolean;
+    isCallerAllocated?: boolean;
     isInline?: boolean;
-    /** Set on the return value of a callable with no instance parameter, which creates what it returns. */
     isNewlyCreated?: boolean;
 };
 
 type ArgIndexOptions = {
     argIndexOffset: number;
     argIndexMap: Map<number, number> | undefined;
+    hasOutIndirection: boolean;
 };
 
 type RecordPlacement = {
@@ -76,7 +77,7 @@ type FundamentalDescriptor = {
     typeName: string | undefined;
     ownership: Ownership;
     wrapperClass?: string | undefined;
-    inline?: boolean | undefined;
+    isInline?: boolean | undefined;
 };
 
 type AncestorFundamental = {
@@ -94,7 +95,7 @@ type FundamentalRecordOptions = {
     unrefFunc: string;
     ownership: Ownership;
     wrapperClass: string | undefined;
-    inline: boolean;
+    isInline: boolean;
 };
 
 const LIST_HELPERS: Record<Exclude<ListFlavor, "gbytearray">, ListDescriptorName> = {
@@ -104,17 +105,8 @@ const LIST_HELPERS: Record<Exclude<ListFlavor, "gbytearray">, ListDescriptorName
     garray: "gArray",
 };
 
-/**
- * `glib:type-name` of every fundamental whose instances are born with a floating reference, so a
- * callable that creates one hands back a claim nobody has taken rather than an owned reference.
- * GIR annotates those returns `transfer-ownership="full"` all the same, so the annotation alone
- * cannot tell them apart from a genuinely owned return such as `g_param_spec_ref`.
- */
 const FLOATING_FUNDAMENTALS: Set<string> = new Set(["GParam"]);
 
-// A callable that drops parameters (varargs, and the closure/destroy slots folded into a callback)
-// shifts every later parameter left, so a GIR length index has to be looked up in the emitted list
-// rather than shifted by the instance offset alone.
 const mapArgIndex = (options: ArgIndexOptions, girIndex: number): number =>
     options.argIndexMap?.get(girIndex) ?? girIndex + options.argIndexOffset;
 
@@ -133,15 +125,8 @@ const transferOwnership = (transfer: ParameterTransfer): Ownership => {
 const deriveElementTransfer = (transfer: ParameterTransfer): ParameterTransfer =>
     transfer === "container" ? "none" : transfer;
 
-const isVoidRef = (library: Library, ref: TypeId | undefined): boolean => {
-    if (ref === undefined) {
-        return true;
-    }
-
-    const type = library.typeFor(ref);
-
-    return type?.kind === "primitive" && type.category === "void";
-};
+const isVoidRef = (library: Library, ref: TypeId | undefined): boolean =>
+    ref === undefined || primitiveCategoryFor(library, ref) === "void";
 
 const isInlineCallbackRef = (library: Library, ref: TypeId | undefined): boolean =>
     ref !== undefined && library.typeFor(ref)?.kind === "callback" && library.nameFor(ref) === undefined;
@@ -149,6 +134,12 @@ const isInlineCallbackRef = (library: Library, ref: TypeId | undefined): boolean
 const shouldOmitPrimaryReturn = (library: Library, returnValue: GirReturnValue): boolean =>
     isVoidRef(library, returnValue.type) || returnValue.skip;
 
+const argIndexOptions = (options: RenderDescriptorOptions): ArgIndexOptions => ({
+    argIndexOffset: options.argIndexOffset ?? 0,
+    argIndexMap: options.argIndexMap,
+    hasOutIndirection: options.hasOutIndirection === true,
+});
+
 const renderDescriptor = (
     context: ModuleContext,
     ref: TypeId | undefined,
@@ -159,8 +150,7 @@ const renderDescriptor = (
         return tVoid;
     }
 
-    const { argIndexOffset = 0 } = options;
-    const indexOptions: ArgIndexOptions = { argIndexOffset, argIndexMap: options.argIndexMap };
+    const indexOptions = argIndexOptions(options);
     const ownership = transferOwnership(transfer);
     const type = context.library.typeFor(ref);
 
@@ -175,9 +165,6 @@ const renderDescriptor = (
         case "varargs": {
             return tVoid;
         }
-        // A callback in a slot no `renderCallbackType` covers (a vtable entry, a signal argument, a
-        // record field) is still a function pointer occupying a pointer-sized slot. `t.void` would
-        // hand the implementation `undefined` where the pointer belongs.
         case "callback": {
             return tUint64;
         }
@@ -269,8 +256,19 @@ const isScalarRef = (library: Library, ref: TypeId | undefined): boolean => {
     return type !== undefined && isScalarType(library, type);
 };
 
+const isStrvRef = (library: Library, ref: TypeId | undefined): boolean => {
+    const type = carrayFor(library, ref);
+
+    if (type === undefined) {
+        return false;
+    }
+
+    return isUnboundedArray(type) && primitiveCategoryFor(library, type.element) === "string";
+};
+
 const isCellInout = (library: Library, parameter: GirParameter): boolean =>
-    isInoutParameter(parameter) && isScalarRef(library, parameter.type);
+    isInoutParameter(parameter) &&
+    (isScalarRef(library, parameter.type) || isStrvRef(library, parameter.type));
 
 const renderParamDescriptor = (
     context: ModuleContext,
@@ -278,23 +276,22 @@ const renderParamDescriptor = (
     ref: TypeId | undefined,
     argIndex: Partial<ArgIndexOptions> = {},
 ): string => {
+    const behindRef: RenderDescriptorOptions = { ...argIndex, hasOutIndirection: true };
+
     if (isCellInout(context.library, parameter)) {
-        return tRef(renderDescriptor(context, ref, parameter.transferOwnership, argIndex), true);
+        return tRef(renderDescriptor(context, ref, parameter.transferOwnership, behindRef), true);
     }
 
     if (isOutParameter(parameter)) {
-        return tRef(renderDescriptor(context, ref, parameter.transferOwnership, argIndex));
+        return tRef(renderDescriptor(context, ref, parameter.transferOwnership, behindRef));
     }
 
     return renderDescriptor(context, ref, parameter.transferOwnership, {
         ...argIndex,
-        callerAllocated: isCallerAllocatedOut(parameter) || isRecordInout(context, parameter),
+        isCallerAllocated: isCallerAllocatedOut(parameter) || isRecordInout(context, parameter),
     });
 };
 
-// `closure=` on a callback's own parameter states which slot carries the user data, and it is what
-// the TypeScript signature already goes by. The name scan stays as a fallback: 88 callbacks across
-// the installed GIRs carry no `closure=` at all.
 const userDataIndexByName = (parameters: GirParameter[]): number | undefined => {
     let userDataIndex: number | undefined;
 
@@ -320,6 +317,10 @@ const callbackOptionsArg = (owningParameter: GirParameter, userDataIndex: number
         options.push("hasDestroy: true");
     }
 
+    if (owningParameter.closureIndex !== undefined) {
+        options.push("hasUserData: true");
+    }
+
     if (userDataIndex !== undefined) {
         options.push(`userDataIndex: ${String(userDataIndex)}`);
     }
@@ -379,19 +380,16 @@ const primitiveExpression = (category: PrimitiveCategory, ownership: Ownership):
 };
 
 const renderFundamental = (descriptor: FundamentalDescriptor): string => {
-    const { lib, refFunc, unrefFunc, typeName, ownership, wrapperClass, inline } = descriptor;
+    const { lib, refFunc, unrefFunc, typeName, ownership, wrapperClass, isInline } = descriptor;
 
     return tFundamental(lib, refFunc, unrefFunc, {
         ownership,
         typeName,
         wrapperClass,
-        inline,
+        isInline,
     });
 };
 
-// A freshly created floating instance is claimed by sinking it, which is what the fundamental's
-// declared ref function does, so it is marshalled as transfer-none: adopting the floating reference
-// instead would leave the handle releasing a claim it never took.
 const sunkOwnership = (
     ancestor: AncestorFundamental,
     ownership: Ownership,
@@ -404,8 +402,6 @@ const sunkOwnership = (
     return FLOATING_FUNDAMENTALS.has(ancestor.typeName) ? "borrowed" : ownership;
 };
 
-// GIR marks only the root of a fundamental hierarchy with `glib:fundamental` and its ref/unref pair,
-// so a derived type such as GtkPropertyExpression carries neither and has to inherit both.
 const classOrInterfaceExpression = (
     context: ModuleContext,
     resolved: Extract<EntityType, { kind: "class" | "interface" }>,
@@ -480,10 +476,11 @@ const fundamentalAncestor = (
 const classSelfDescriptor = (
     context: ModuleContext,
     type: Extract<EntityType, { kind: "class" | "interface" }>,
+    ownership: Ownership,
 ): string => {
     const ancestor = fundamentalAncestor(context, type);
 
-    return ancestor === undefined ? tObject("borrowed") : renderFundamental({ ...ancestor, ownership: "borrowed" });
+    return ancestor === undefined ? tObject(ownership) : renderFundamental({ ...ancestor, ownership });
 };
 
 const renderSelfDescriptor = (context: ModuleContext, instance: GirParameter): string => {
@@ -500,7 +497,7 @@ const renderSelfDescriptor = (context: ModuleContext, instance: GirParameter): s
     }
 
     if (isClassOrInterface(type)) {
-        return classSelfDescriptor(context, type);
+        return classSelfDescriptor(context, type, transferOwnership(instance.transferOwnership));
     }
 
     if (type.kind === "record") {
@@ -510,9 +507,6 @@ const renderSelfDescriptor = (context: ModuleContext, instance: GirParameter): s
     return tObject("borrowed");
 };
 
-// A record expresses its acquire/release pair as `copy-function`/`free-function`: no `<record>` in
-// any installed GIR carries `glib:ref-func`, and GVariant's copy function really is
-// `g_variant_ref_sink`.
 const recordRefPair = (record: ResolvedRecord): { refFunc: string | undefined; unrefFunc: string | undefined } => ({
     refFunc: record.glibRefFunc ?? record.copyFunc,
     unrefFunc: record.glibUnrefFunc ?? record.freeFunc,
@@ -532,7 +526,7 @@ const structExpression = (
     context: ModuleContext,
     resolved: Extract<EntityType, { kind: "record" }>,
     ownership: Ownership,
-    options: { callerAllocated: boolean; inline: boolean },
+    options: { isCallerAllocated: boolean; isInline: boolean },
 ): string => {
     const { size } = computeRecordFieldSlots(context, resolved.value.fields, resolved.value.isUnion);
     const wrapperClass = context.qualify(resolved.namespace.name, resolved.value.name);
@@ -541,13 +535,13 @@ const structExpression = (
     return tStruct(ownership, {
         size: isCopyable && size > 0 ? size : undefined,
         wrapperClass,
-        callerAllocated: options.callerAllocated,
-        inline: options.inline,
+        isCallerAllocated: options.isCallerAllocated,
+        isInline: options.isInline,
     });
 };
 
 const fundamentalRecordExpression = (options: FundamentalRecordOptions): string => {
-    const { resolved, refFunc, unrefFunc, ownership, wrapperClass, inline } = options;
+    const { resolved, refFunc, unrefFunc, ownership, wrapperClass, isInline } = options;
 
     return renderFundamental({
         lib: resolved.namespace.sharedLibrary ?? "",
@@ -556,7 +550,7 @@ const fundamentalRecordExpression = (options: FundamentalRecordOptions): string
         typeName: resolved.value.glibTypeName,
         ownership,
         wrapperClass,
-        inline,
+        isInline,
     });
 };
 
@@ -564,11 +558,11 @@ const boxedRecordExpression = (options: {
     context: ModuleContext;
     resolved: Extract<EntityType, { kind: "record" }>;
     ownership: Ownership;
-    callerAllocated: boolean;
-    inline: boolean;
+    isCallerAllocated: boolean;
+    isInline: boolean;
     typeFnName: string;
 }): string => {
-    const { context, resolved, ownership, callerAllocated, inline, typeFnName } = options;
+    const { context, resolved, ownership, isCallerAllocated, isInline, typeFnName } = options;
     const record = resolved.value;
     const glibName = record.glibTypeName ?? record.cType ?? record.name;
     const { size } = computeRecordFieldSlots(context, record.fields, record.isUnion);
@@ -577,8 +571,8 @@ const boxedRecordExpression = (options: {
         ownership,
         sharedLibrary: resolved.namespace.sharedLibrary,
         getTypeFnName: typeFnName,
-        callerAllocated,
-        inline,
+        isCallerAllocated,
+        isInline,
         size: size > 0 ? size : undefined,
     });
 };
@@ -592,8 +586,8 @@ const plainRecordExpression = (
     const record = resolved.value;
 
     const layout = {
-        callerAllocated: placement.isCallerAllocated ?? false,
-        inline: placement.isInline ?? false,
+        isCallerAllocated: placement.isCallerAllocated ?? false,
+        isInline: placement.isInline ?? false,
     };
 
     if (record.glibGetType === undefined) {
@@ -623,7 +617,7 @@ const recordExpression = (
             unrefFunc,
             ownership,
             wrapperClass,
-            inline: placement.isInline ?? false,
+            isInline: placement.isInline ?? false,
         });
     }
 
@@ -660,7 +654,7 @@ const expressionForResolved = (
         }
         case "record": {
             return recordExpression(context, resolved, ownership, {
-                isCallerAllocated: options.callerAllocated ?? false,
+                isCallerAllocated: options.isCallerAllocated ?? false,
                 isInline: options.isInline ?? false,
             });
         }
@@ -684,8 +678,9 @@ const arrayExpression = (
     }
 
     const ownership = transferOwnership(transfer);
-    const element = renderDescriptor(context, ref.element, deriveElementTransfer(transfer), options);
-    const size = inlineElementSize(context, ref.element, ref.elementCType);
+    const elementOptions: ArgIndexOptions = { ...options, hasOutIndirection: false };
+    const element = renderDescriptor(context, ref.element, deriveElementTransfer(transfer), elementOptions);
+    const size = inlineElementSize(context, ref, options.hasOutIndirection);
 
     if (ref.lengthParameterIndex !== undefined) {
         return tSizedArray(element, mapArgIndex(options, ref.lengthParameterIndex), ownership, size);
@@ -708,20 +703,18 @@ const recordInlineSize = (context: ModuleContext, record: ResolvedRecord): numbe
     return size > 0 ? size : undefined;
 };
 
-const inlineElementSize = (
-    context: ModuleContext,
-    element: TypeId | undefined,
-    elementCType: string | undefined,
-): number | undefined => {
-    if (element === undefined) {
-        return undefined;
-    }
+const elementPointerDepth = (elementCType: string | undefined, hasOutIndirection: boolean): number => {
+    const declared = elementCType === undefined ? 0 : elementCType.split("*").length - 1;
+
+    return hasOutIndirection ? declared - 1 : declared;
+};
 
-    if (elementCType?.includes("*")) {
+const inlineElementSize = (context: ModuleContext, ref: CArrayType, hasOutIndirection: boolean): number | undefined => {
+    if (elementPointerDepth(ref.elementCType, hasOutIndirection) > 0) {
         return undefined;
     }
 
-    const type = context.library.typeFor(element);
+    const type = context.library.typeFor(ref.element);
 
     if (type?.kind !== "record") {
         return undefined;
@@ -749,6 +742,7 @@ export {
     renderDescriptor,
     isScalarRef,
     isCellInout,
+    recordInlineSize,
     renderParamDescriptor,
     renderCallbackType,
     renderSelfDescriptor,