@gtkx/codegen 0.21.0 → 1.0.0-rc.2

package/README.md

@@ -0,0 +1,173 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/gtkx-org/gtkx/main/logo.svg" alt="GTKX" width="100" />
+</p>
+
+<h1 align="center">GTKX</h1>
+
+<p align="center">
+  The React framework for Linux.<br />
+  Build GTK4 and Adwaita apps in TypeScript, with React components and hooks driving GNOME's own widgets. What you ship is a GNOME app.
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/create-gtkx"><img src="https://img.shields.io/npm/v/create-gtkx?color=cb3837&logo=npm&label=create-gtkx" alt="npm version" /></a>
+  <a href="https://www.npmjs.com/package/create-gtkx"><img src="https://img.shields.io/npm/dm/create-gtkx?color=cb3837&logo=npm&label=downloads" alt="npm downloads" /></a>
+  <img src="https://img.shields.io/badge/node-%E2%89%A524-339933?logo=node.js&logoColor=white" alt="Node >= 24" />
+  <a href="https://github.com/gtkx-org/gtkx/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MPL--2.0-blue.svg" alt="License: MPL-2.0" /></a>
+  <a href="https://github.com/gtkx-org/gtkx/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/gtkx-org/gtkx/ci.yml?branch=main&logo=github&label=CI" alt="CI status" /></a>
+  <img src="https://img.shields.io/badge/TypeScript-strict-3178c6?logo=typescript&logoColor=white" alt="TypeScript" />
+</p>
+
+<p align="center">
+  <a href="https://gtkx.dev">Homepage</a> &middot;
+  <a href="https://gtkx.dev/guide/why-gtkx">Documentation</a> &middot;
+  <a href="https://github.com/gtkx-org/gtkx/tree/main/examples">Examples</a> &middot;
+  <a href="https://github.com/gtkx-org/gtkx/blob/main/CONTRIBUTING.md">Contributing</a>
+</p>
+
+---
+
+GTKX generates fully typed bindings for the entire GTK4 and Adwaita surface directly from GObject-Introspection. On top of those bindings you get the React programming model: components and hooks driving GObject instances, with Fast Refresh while you develop.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/gtkx-org/gtkx/main/examples/tutorial/assets/screenshot.png" alt="The Tasks app: an Adwaita window with a sidebar of smart views and colored lists on the left, and a boxed task list on the right." />
+</p>
+
+<p align="center">
+  <em>The Tasks app you build in the <a href="https://gtkx.dev/tutorial/">tutorial</a>.</em>
+</p>
+
+## Demo
+
+The intrinsic elements in this snippet render GTK4 widgets, and ordinary React hooks and events drive them:
+
+```tsx
+import * as Gtk from "@gtkx/gi/gtk";
+import { GtkApplication, GtkApplicationWindow, GtkBox, GtkButton, GtkLabel } from "@gtkx/jsx/gtk";
+import { createRoot, quit } from "@gtkx/react";
+import { useState } from "react";
+
+const Counter = () => {
+  const [count, setCount] = useState(0);
+
+  return (
+    <GtkApplicationWindow
+      title="Hello GTKX"
+      defaultWidth={400}
+      defaultHeight={300}
+      onCloseRequest={quit}
+    >
+      <GtkBox
+        orientation={Gtk.Orientation.VERTICAL}
+        spacing={20}
+        marginTop={40}
+        marginBottom={40}
+        marginStart={40}
+        marginEnd={40}
+        valign={Gtk.Align.CENTER}
+        halign={Gtk.Align.CENTER}
+      >
+        <GtkLabel cssClasses={["title-1"]}>Welcome to GTKX!</GtkLabel>
+        <GtkLabel cssClasses={["title-2"]}>{`Count: ${count}`}</GtkLabel>
+        <GtkButton
+          label="Increment"
+          onClicked={() => setCount((c) => c + 1)}
+          cssClasses={["suggested-action", "pill"]}
+        />
+      </GtkBox>
+    </GtkApplicationWindow>
+  );
+};
+
+const App = () => (
+  <GtkApplication>
+    <Counter />
+  </GtkApplication>
+);
+
+createRoot().render(<App />);
+```
+
+This is the [`hello-world`](https://github.com/gtkx-org/gtkx/tree/main/examples/hello-world) example, with `app.tsx` and `index.tsx` combined into a single snippet. `@gtkx/gi` and `@gtkx/jsx` are per-project bindings generated by the CLI, not packages you install from npm.
+
+## Why GTKX
+
+### A declarative layer for the GNOME stack
+
+GTK4 is mature, and GtkBuilder XML can lay out a static interface, but nothing re-renders that interface when your application state changes, and nothing hot-reloads it as you work. GTKX adds that missing layer, and the tooling around it, on top of the stack you already know:
+
+- a React reconciler that exposes every GObject as a JSX element,
+- a CLI for scaffolding, development, and production builds,
+- a dev server with Fast Refresh that patches your running UI in place,
+- CSS-in-JS styling and high-level list, grid, and dialog components,
+- a Testing Library-style API for querying and driving your widgets in tests,
+- and a Model Context Protocol (MCP) server that exposes your live app to AI agents.
+
+### The full GNOME API surface
+
+React Native and similar frameworks hide the native toolkit so one API can run everywhere. GTKX exposes it: GTK4, Adwaita, and any other GObject-Introspection library on your system. Linux-only by design.
+
+### Why Node.js, and why generated bindings
+
+GTKX runs on Node.js, which puts native modules, the npm ecosystem, and the tooling built for Node.js APIs within reach. GJS is GNOME's own runtime, built on SpiderMonkey rather than V8; node-gtk runs on Node.js but is lightly maintained, on the older nan/V8 ABI rather than N-API, and still centered on GTK3. The [why-gtkx guide](https://gtkx.dev/guide/why-gtkx) covers the comparison in full.
+
+GTKX generates the TypeScript types and the native FFI calls from the same GObject-Introspection data, so the types cannot drift from the calls they back. Codegen covers the whole GTK4 and Adwaita surface.
+
+At runtime, the native Rust core calls straight into the system GTK4, Adwaita, and GLib libraries through libffi, without loading libgirepository at all.
+
+## Quick start
+
+GTKX is Linux-only and needs Node.js 24 or later. See [Requirements](#requirements).
+
+Scaffold a new app with the `create-gtkx` initializer:
+
+```sh
+npm create gtkx@rc
+```
+
+The same command works with other package managers: `pnpm create gtkx@rc` or `yarn create gtkx@rc`.
+
+Then run your new app:
+
+```sh
+cd my-app
+npm run dev
+```
+
+To go further, follow the [tutorial](https://gtkx.dev/tutorial/).
+
+## Documentation
+
+The documentation at **[gtkx.dev](https://gtkx.dev)** includes a step-by-step tutorial that builds a complete GNOME app, from scaffolding to packaging and shipping, plus guides and a full API reference.
+
+**[Read the docs &rarr;](https://gtkx.dev/guide/why-gtkx)**
+
+## Requirements
+
+GTKX is Linux-only. You need:
+
+- Linux with the GTK4 (4.20 or later), Adwaita (1.8 or later), and GLib development libraries
+- Node.js 24 or later
+
+The `@gtkx/native` addon ships prebuilt for x64 and arm64 glibc Linux; other targets need to build it from the GTKX repository, which requires a Rust toolchain.
+
+## Examples
+
+Explore the [example apps](https://github.com/gtkx-org/gtkx/tree/main/examples):
+
+- [`hello-world`](https://github.com/gtkx-org/gtkx/tree/main/examples/hello-world): the counter above.
+- [`gtk-demo`](https://github.com/gtkx-org/gtkx/tree/main/examples/gtk-demo): a React port of the official GTK4 widget showcase, covering lists, dialogs, gestures, CSS, and OpenGL.
+- [`browser`](https://github.com/gtkx-org/gtkx/tree/main/examples/browser): a WebKitWebView-based web browser.
+- [`tutorial`](https://github.com/gtkx-org/gtkx/tree/main/examples/tutorial): the Tasks app the documentation builds.
+
+## Status
+
+GTKX 1.0 is at the release candidate stage.
+
+## Contributing
+
+Contributions are welcome. See [CONTRIBUTING.md](https://github.com/gtkx-org/gtkx/blob/main/CONTRIBUTING.md), the [Code of Conduct](https://github.com/gtkx-org/gtkx/blob/main/CODE_OF_CONDUCT.md), and the [security policy](https://github.com/gtkx-org/gtkx/blob/main/SECURITY.md). Building the repo needs Node.js 24 or later, pnpm, and a Rust toolchain.
+
+## License
+
+GTKX is licensed under [MPL-2.0](https://github.com/gtkx-org/gtkx/blob/main/LICENSE).

package/dist/analysis/descriptor-render.d.ts

@@ -0,0 +1,25 @@
+import type { Library } from "../gir/library.js";
+import type { ModuleContext } from "../writer/context.js";
+import { type GirParameter, type GirReturnValue, type ParameterTransfer } from "../gir/parameter.js";
+import { type TypeId } from "../gir/type-id.js";
+type RenderDescriptorOptions = {
+    argIndexOffset?: number;
+    /** GIR parameter index to emitted argument index, for callables that drop parameters. */
+    argIndexMap?: Map<number, number> | undefined;
+    callerAllocated?: boolean;
+    isInline?: boolean;
+};
+type ArgIndexOptions = {
+    argIndexOffset: number;
+    argIndexMap: Map<number, number> | undefined;
+};
+declare const isInlineCallbackRef: (library: Library, ref: TypeId | undefined) => boolean;
+declare const shouldOmitPrimaryReturn: (library: Library, returnValue: GirReturnValue) => boolean;
+declare const renderDescriptor: (context: ModuleContext, ref: TypeId | undefined, transfer?: ParameterTransfer, options?: RenderDescriptorOptions) => string;
+declare const isScalarRef: (library: Library, ref: TypeId | undefined) => boolean;
+declare const isCellInout: (library: Library, parameter: GirParameter) => boolean;
+declare const renderParamDescriptor: (context: ModuleContext, parameter: GirParameter, ref: TypeId | undefined, argIndex?: Partial<ArgIndexOptions>) => string;
+declare const renderCallbackType: (context: ModuleContext, ref: TypeId | undefined, owningParameter: GirParameter, argOverrides?: Map<number, string>) => string | undefined;
+declare const renderSelfDescriptor: (context: ModuleContext, instance: GirParameter) => string;
+export { isInlineCallbackRef, shouldOmitPrimaryReturn, renderDescriptor, isScalarRef, isCellInout, renderParamDescriptor, renderCallbackType, renderSelfDescriptor, };
+//# sourceMappingURL=descriptor-render.d.ts.map

package/dist/analysis/descriptor-render.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"descriptor-render.d.ts","sourceRoot":"","sources":["../../src/analysis/descriptor-render.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAGjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EACH,KAAK,YAAY,EACjB,KAAK,cAAc,EAInB,KAAK,iBAAiB,EACzB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAKH,KAAK,MAAM,EACd,MAAM,mBAAmB,CAAC;AA8B3B,KAAK,uBAAuB,GAAG;IAC3B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,yFAAyF;IACzF,WAAW,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IAC9C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,KAAK,eAAe,GAAG;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;CAChD,CAAC;AAyEF,QAAA,MAAM,mBAAmB,GAAI,SAAS,OAAO,EAAE,KAAK,MAAM,GAAG,SAAS,KAAG,OAC+B,CAAC;AAEzG,QAAA,MAAM,uBAAuB,GAAI,SAAS,OAAO,EAAE,aAAa,cAAc,KAAG,OACrB,CAAC;AAE7D,QAAA,MAAM,gBAAgB,GAClB,SAAS,aAAa,EACtB,KAAK,MAAM,GAAG,SAAS,EACvB,WAAU,iBAA0B,EACpC,UAAS,uBAA4B,KACtC,MAgDF,CAAC;AAyDF,QAAA,MAAM,WAAW,GAAI,SAAS,OAAO,EAAE,KAAK,MAAM,GAAG,SAAS,KAAG,OAQhE,CAAC;AAEF,QAAA,MAAM,WAAW,GAAI,SAAS,OAAO,EAAE,WAAW,YAAY,KAAG,OACM,CAAC;AAExE,QAAA,MAAM,qBAAqB,GACvB,SAAS,aAAa,EACtB,WAAW,YAAY,EACvB,KAAK,MAAM,GAAG,SAAS,EACvB,WAAU,OAAO,CAAC,eAAe,CAAM,KACxC,MAaF,CAAC;AAyCF,QAAA,MAAM,kBAAkB,GACpB,SAAS,aAAa,EACtB,KAAK,MAAM,GAAG,SAAS,EACvB,iBAAiB,YAAY,EAC7B,eAAe,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,KACnC,MAAM,GAAG,SAoBX,CAAC;AA8GF,QAAA,MAAM,oBAAoB,GAAI,SAAS,aAAa,EAAE,UAAU,YAAY,KAAG,MAsB9E,CAAC;AA0OF,OAAO,EACH,mBAAmB,EACnB,uBAAuB,EACvB,gBAAgB,EAChB,WAAW,EACX,WAAW,EACX,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,GACvB,CAAC"}

package/dist/analysis/descriptor-render.js

@@ -0,0 +1,420 @@
+import { sourceStringLiteral } from "@gtkx/utils";
+import { isCallerAllocatedOut, isInoutParameter, isOutParameter, } from "../gir/parameter.js";
+import { hasUnknownArrayLength, } from "../gir/type-id.js";
+import { isRecordInout } from "../store/gi/param-marshal.js";
+import { computeRecordFieldSlots } from "../store/gi/record-layout.js";
+import { tArray, tBoxed, tByteArray, tCallback, tEnum, tFixedArray, tFlags, tFundamental, tGtype, tHashTable, tInt32, tList, tObject, tRef, tScalar, tSizedArray, tString, tStruct, tUint32, tUint64, tVoid, } from "./descriptor.js";
+const LIST_HELPERS = {
+    glist: "list",
+    gslist: "slist",
+    gptrarray: "ptrArray",
+    garray: "gArray",
+};
+// 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, girIndex) => options.argIndexMap?.get(girIndex) ?? girIndex + options.argIndexOffset;
+const transferOwnership = (transfer) => {
+    if (transfer === "full") {
+        return "full";
+    }
+    if (transfer === "container") {
+        return "full";
+    }
+    return "borrowed";
+};
+const deriveElementTransfer = (transfer) => transfer === "container" ? "none" : transfer;
+const isVoidRef = (library, ref) => {
+    if (ref === undefined) {
+        return true;
+    }
+    const type = library.typeFor(ref);
+    return type?.kind === "primitive" && type.category === "void";
+};
+const isInlineCallbackRef = (library, ref) => ref !== undefined && library.typeFor(ref)?.kind === "callback" && library.nameFor(ref) === undefined;
+const shouldOmitPrimaryReturn = (library, returnValue) => isVoidRef(library, returnValue.type) || returnValue.skip;
+const renderDescriptor = (context, ref, transfer = "none", options = {}) => {
+    if (ref === undefined) {
+        return tVoid;
+    }
+    const { argIndexOffset = 0 } = options;
+    const indexOptions = { argIndexOffset, argIndexMap: options.argIndexMap };
+    const ownership = transferOwnership(transfer);
+    const type = context.library.typeFor(ref);
+    if (type === undefined) {
+        return tObject(ownership);
+    }
+    switch (type.kind) {
+        case "primitive": {
+            return primitiveExpression(type.category, ownership);
+        }
+        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;
+        }
+        case "class":
+        case "interface":
+        case "record":
+        case "enum":
+        case "alias": {
+            return expressionForResolved(context, type, transfer, options);
+        }
+        case "carray": {
+            return arrayExpression(context, type, transfer, indexOptions);
+        }
+        case "list": {
+            return listExpression(context, type, transfer, indexOptions);
+        }
+        case "hashtable": {
+            const elementTransfer = deriveElementTransfer(transfer);
+            const key = renderDescriptor(context, type.key, elementTransfer, indexOptions);
+            const value = renderDescriptor(context, type.value, elementTransfer, indexOptions);
+            return tHashTable(key, value, ownership);
+        }
+    }
+};
+const listExpression = (context, type, transfer, indexOptions) => {
+    const ownership = transferOwnership(transfer);
+    if (type.flavor === "gbytearray") {
+        return tByteArray(ownership);
+    }
+    const element = renderDescriptor(context, type.element, deriveElementTransfer(transfer), indexOptions);
+    return tList(LIST_HELPERS[type.flavor], element, ownership);
+};
+const resolveCallbackType = (context, ref) => {
+    if (ref === undefined) {
+        return undefined;
+    }
+    const type = context.library.typeFor(ref);
+    if (type?.kind !== "callback") {
+        return undefined;
+    }
+    return type.value;
+};
+const isScalarType = (library, type) => {
+    switch (type.kind) {
+        case "primitive": {
+            return type.category !== "string" && type.category !== "void";
+        }
+        case "enum": {
+            return true;
+        }
+        case "alias": {
+            return type.value.target !== undefined && isScalarRef(library, type.value.target);
+        }
+        case "callback":
+        case "carray":
+        case "class":
+        case "hashtable":
+        case "interface":
+        case "list":
+        case "record":
+        case "varargs": {
+            return false;
+        }
+    }
+};
+const isScalarRef = (library, ref) => {
+    if (ref === undefined) {
+        return false;
+    }
+    const type = library.typeFor(ref);
+    return type !== undefined && isScalarType(library, type);
+};
+const isCellInout = (library, parameter) => isInoutParameter(parameter) && isScalarRef(library, parameter.type);
+const renderParamDescriptor = (context, parameter, ref, argIndex = {}) => {
+    if (isCellInout(context.library, parameter)) {
+        return tRef(renderDescriptor(context, ref, parameter.transferOwnership, argIndex), true);
+    }
+    if (isOutParameter(parameter)) {
+        return tRef(renderDescriptor(context, ref, parameter.transferOwnership, argIndex));
+    }
+    return renderDescriptor(context, ref, parameter.transferOwnership, {
+        ...argIndex,
+        callerAllocated: 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) => {
+    let userDataIndex;
+    for (const [index, parameter] of parameters.entries()) {
+        if (parameter.name === "user_data" || parameter.name === "data") {
+            userDataIndex = index;
+        }
+    }
+    return userDataIndex;
+};
+const findUserDataIndex = (parameters) => {
+    const declared = parameters.find((parameter) => parameter.closureIndex !== undefined);
+    return declared?.closureIndex ?? userDataIndexByName(parameters);
+};
+const callbackOptionsArg = (owningParameter, userDataIndex) => {
+    const options = [];
+    if (owningParameter.destroyIndex !== undefined) {
+        options.push("hasDestroy: true");
+    }
+    if (userDataIndex !== undefined) {
+        options.push(`userDataIndex: ${String(userDataIndex)}`);
+    }
+    if (owningParameter.scope !== undefined) {
+        options.push(`scope: ${sourceStringLiteral(owningParameter.scope)}`);
+    }
+    return options.length > 0 ? `{ ${options.join(", ")} }` : undefined;
+};
+const renderCallbackType = (context, ref, owningParameter, argOverrides) => {
+    const callback = resolveCallbackType(context, ref);
+    if (callback === undefined) {
+        return undefined;
+    }
+    const argTypes = callback.parameters.map((parameter, index) => argOverrides?.get(index) ?? renderParamDescriptor(context, parameter, parameter.type));
+    const returnRef = callback.returnValue.type;
+    const returnType = isVoidRef(context.library, returnRef)
+        ? tVoid
+        : renderDescriptor(context, returnRef, callback.returnValue.transferOwnership);
+    const optionsArg = callbackOptionsArg(owningParameter, findUserDataIndex(callback.parameters));
+    return tCallback(argTypes, returnType, optionsArg);
+};
+const primitiveExpression = (category, ownership) => {
+    if (category === "void") {
+        return tVoid;
+    }
+    if (category === "string") {
+        return tString(ownership);
+    }
+    if (category === "pointer") {
+        return tUint64;
+    }
+    if (category === "gtype") {
+        return tGtype;
+    }
+    return tScalar(category);
+};
+const renderFundamental = (descriptor) => {
+    const { lib, refFunc, unrefFunc, typeName, ownership, wrapperClass, inline } = descriptor;
+    return tFundamental(lib, refFunc, unrefFunc, {
+        ownership,
+        typeName,
+        wrapperClass,
+        inline,
+    });
+};
+// 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, resolved, ownership) => {
+    const ancestor = fundamentalAncestor(context, resolved);
+    return ancestor === undefined ? tObject(ownership) : renderFundamental({ ...ancestor, ownership });
+};
+const isClassOrInterface = (type) => type !== undefined && (type.kind === "class" || type.kind === "interface");
+const getFundamental = (node) => {
+    const cls = node.value;
+    if (!cls.fundamental || cls.glibRefFunc === undefined || cls.glibUnrefFunc === undefined) {
+        return undefined;
+    }
+    return {
+        lib: node.namespace.sharedLibrary ?? "",
+        refFunc: cls.glibRefFunc,
+        unrefFunc: cls.glibUnrefFunc,
+        typeName: cls.glibTypeName,
+    };
+};
+const walkFundamental = (context, current, seen) => {
+    if (!isClassOrInterface(current)) {
+        return undefined;
+    }
+    const key = `${current.namespace.name}.${current.value.name}`;
+    if (seen.has(key)) {
+        return undefined;
+    }
+    seen.add(key);
+    const fundamental = getFundamental(current);
+    if (fundamental !== undefined) {
+        return fundamental;
+    }
+    if (current.value.parent === undefined) {
+        return undefined;
+    }
+    const parent = context.library.resolveType(current.namespace.name, current.value.parent);
+    return walkFundamental(context, parent, seen);
+};
+const fundamentalAncestor = (context, start) => walkFundamental(context, start, new Set());
+const classSelfDescriptor = (context, type) => {
+    const ancestor = fundamentalAncestor(context, type);
+    return ancestor === undefined ? tObject("borrowed") : renderFundamental({ ...ancestor, ownership: "borrowed" });
+};
+const renderSelfDescriptor = (context, instance) => {
+    const ref = instance.type;
+    if (ref === undefined) {
+        return tObject("borrowed");
+    }
+    const type = context.library.typeFor(ref);
+    if (type === undefined) {
+        return tObject("borrowed");
+    }
+    if (isClassOrInterface(type)) {
+        return classSelfDescriptor(context, type);
+    }
+    if (type.kind === "record") {
+        return recordExpression(context, type, transferOwnership(instance.transferOwnership));
+    }
+    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) => ({
+    refFunc: record.glibRefFunc ?? record.copyFunc,
+    unrefFunc: record.glibUnrefFunc ?? record.freeFunc,
+});
+const requiresFallbackClass = (record) => {
+    const { refFunc, unrefFunc } = recordRefPair(record);
+    if (refFunc !== undefined && unrefFunc !== undefined) {
+        return record.glibTypeName === undefined;
+    }
+    return record.glibGetType === undefined;
+};
+const structExpression = (context, resolved, ownership, options) => {
+    const { size } = computeRecordFieldSlots(context, resolved.value.fields, resolved.value.isUnion);
+    const wrapperClass = context.qualify(resolved.namespace.name, resolved.value.name);
+    return tStruct(ownership, {
+        size: size > 0 ? size : undefined,
+        wrapperClass,
+        callerAllocated: options.callerAllocated,
+        inline: options.inline,
+    });
+};
+const fundamentalRecordExpression = (options) => {
+    const { resolved, refFunc, unrefFunc, ownership, wrapperClass, inline } = options;
+    return renderFundamental({
+        lib: resolved.namespace.sharedLibrary ?? "",
+        refFunc,
+        unrefFunc,
+        typeName: resolved.value.glibTypeName,
+        ownership,
+        wrapperClass,
+        inline,
+    });
+};
+const boxedRecordExpression = (options) => {
+    const { context, resolved, ownership, callerAllocated, inline, typeFnName } = options;
+    const record = resolved.value;
+    const glibName = record.glibTypeName ?? record.cType ?? record.name;
+    const { size } = computeRecordFieldSlots(context, record.fields, record.isUnion);
+    return tBoxed(glibName, {
+        ownership,
+        sharedLibrary: resolved.namespace.sharedLibrary,
+        getTypeFnName: typeFnName,
+        callerAllocated,
+        inline,
+        size: size > 0 ? size : undefined,
+    });
+};
+const plainRecordExpression = (context, resolved, ownership, placement) => {
+    const record = resolved.value;
+    const layout = {
+        callerAllocated: placement.isCallerAllocated ?? false,
+        inline: placement.isInline ?? false,
+    };
+    if (record.glibGetType === undefined) {
+        return structExpression(context, resolved, ownership, layout);
+    }
+    return boxedRecordExpression({ context, resolved, ownership, ...layout, typeFnName: record.glibGetType });
+};
+const recordExpression = (context, resolved, ownership, placement = {}) => {
+    const record = resolved.value;
+    const { refFunc, unrefFunc } = recordRefPair(record);
+    if (refFunc !== undefined && unrefFunc !== undefined) {
+        const wrapperClass = requiresFallbackClass(record)
+            ? context.qualify(resolved.namespace.name, record.name)
+            : undefined;
+        return fundamentalRecordExpression({
+            resolved,
+            refFunc,
+            unrefFunc,
+            ownership,
+            wrapperClass,
+            inline: placement.isInline ?? false,
+        });
+    }
+    return plainRecordExpression(context, resolved, ownership, placement);
+};
+const rawEnumDescriptor = (isSigned) => (isSigned ? tInt32 : tUint32);
+const enumExpression = (resolved) => {
+    const getter = resolved.value.glibGetType;
+    const isSigned = resolved.value.members.some((member) => member.value.startsWith("-"));
+    if (getter === undefined || getter === "") {
+        return rawEnumDescriptor(isSigned);
+    }
+    const lib = resolved.namespace.sharedLibrary ?? "";
+    return resolved.value.kind === "bitfield" ? tFlags(lib, getter, isSigned) : tEnum(lib, getter, isSigned);
+};
+const expressionForResolved = (context, resolved, transfer, options) => {
+    const ownership = transferOwnership(transfer);
+    switch (resolved.kind) {
+        case "class":
+        case "interface": {
+            return classOrInterfaceExpression(context, resolved, ownership);
+        }
+        case "record": {
+            return recordExpression(context, resolved, ownership, {
+                isCallerAllocated: options.callerAllocated ?? false,
+                isInline: options.isInline ?? false,
+            });
+        }
+        case "enum": {
+            return enumExpression(resolved);
+        }
+        case "alias": {
+            return aliasExpression(context, resolved.value.target, transfer, options);
+        }
+    }
+};
+const arrayExpression = (context, ref, transfer, options) => {
+    if (hasUnknownArrayLength(ref)) {
+        return tUint64;
+    }
+    const ownership = transferOwnership(transfer);
+    const element = renderDescriptor(context, ref.element, deriveElementTransfer(transfer), options);
+    const size = inlineElementSize(context, ref.element, ref.elementCType);
+    if (ref.lengthParameterIndex !== undefined) {
+        return tSizedArray(element, mapArgIndex(options, ref.lengthParameterIndex), ownership, size);
+    }
+    if (ref.fixedSize !== undefined) {
+        return tFixedArray(element, ref.fixedSize, ownership, size);
+    }
+    return tArray(element, ownership, size);
+};
+const recordInlineSize = (context, record) => {
+    if (record.opaque || record.disguised || record.fields.length === 0) {
+        return undefined;
+    }
+    const { size } = computeRecordFieldSlots(context, record.fields, record.isUnion);
+    return size > 0 ? size : undefined;
+};
+const inlineElementSize = (context, element, elementCType) => {
+    if (element === undefined) {
+        return undefined;
+    }
+    if (elementCType?.includes("*")) {
+        return undefined;
+    }
+    const type = context.library.typeFor(element);
+    if (type?.kind !== "record") {
+        return undefined;
+    }
+    return recordInlineSize(context, type.value);
+};
+const aliasExpression = (context, target, transfer, options) => {
+    if (target === undefined) {
+        return tObject(transferOwnership(transfer));
+    }
+    return renderDescriptor(context, target, transfer, options);
+};
+export { isInlineCallbackRef, shouldOmitPrimaryReturn, renderDescriptor, isScalarRef, isCellInout, renderParamDescriptor, renderCallbackType, renderSelfDescriptor, };
+//# sourceMappingURL=descriptor-render.js.map