@gtkx/codegen 0.21.0 → 1.0.0-rc.2

package/dist/gir/parameter.d.ts

@@ -1,82 +1,40 @@
+import type { ParseContext, TypeId } from "./type-id.js";
 import { type RawNode } from "./parse.js";
-import { type GirTypeRef } from "./type-ref.js";
-/** Direction of a `<parameter>` (`in`, `out`, `inout`). */
 type ParameterDirection = "in" | "out" | "inout";
-/**
- * Lifetime conveyed by `transfer-ownership`. Mirrors the GIR vocabulary one
- * for one; the marshal layer translates to the runtime's `Ownership` set.
- */
-export type ParameterTransfer = "none" | "full" | "container";
-/** Lifetime of a callback parameter (`scope=…`). */
+type ParameterTransfer = "none" | "full" | "container";
 type CallbackScope = "call" | "notified" | "async" | "forever";
-/**
- * A `<parameter>` or `<instance-parameter>` of a callable.
- *
- * Only the bits the FFI writers actually look at are retained; the original
- * raw node is dropped so the domain model is self-describing.
- */
-export type GirParameter = {
-    /** Parameter name as authored in GIR (often snake_case). */
-    readonly name: string;
-    /** Typed slot of the parameter, or `undefined` for `<varargs/>`. */
-    readonly type: GirTypeRef | undefined;
-    readonly direction: ParameterDirection;
-    readonly transferOwnership: ParameterTransfer;
-    readonly nullable: boolean;
-    readonly optional: boolean;
-    /** `caller-allocates="1"` — used in out parameters that fill a caller buffer. */
-    readonly callerAllocates: boolean;
-    /** Lifetime of a callback parameter (defined only when the parameter is a callback). */
-    readonly scope: CallbackScope | undefined;
-    /** Index of the paired `gpointer user_data` parameter in the C signature. */
-    readonly closureIndex: number | undefined;
-    /** Index of the paired `GDestroyNotify` parameter in the C signature. */
-    readonly destroyIndex: number | undefined;
-    /** `true` for `<instance-parameter>` (the implicit `self` of a method). */
-    readonly isInstance: boolean;
-    /** `<varargs/>` parameter; not marshalable. */
-    readonly isVarargs: boolean;
+type GirParameter = {
+    name: string;
+    type: TypeId | undefined;
+    direction: ParameterDirection;
+    transferOwnership: ParameterTransfer;
+    nullable: boolean;
+    optional: boolean;
+    callerAllocates: boolean;
+    scope: CallbackScope | undefined;
+    closureIndex: number | undefined;
+    destroyIndex: number | undefined;
+    isVarargs: boolean;
 };
-/**
- * Builds a {@link GirParameter} from a `<parameter>` or `<instance-parameter>`.
- *
- * @param node - The XML element
- * @param isInstance - Whether the source element was `<instance-parameter>`
- */
-export declare const parameterFromNode: (node: RawNode, isInstance: boolean) => GirParameter;
-/**
- * Whether a parameter is a pure out-parameter: `direction="out"` and not
- * caller-allocated, so it marshals through a `{ value }` cell the callee writes into.
- *
- * @param parameter - The parameter to test
- */
-export declare const isOutParameter: (parameter: GirParameter) => boolean;
-/**
- * Whether a parameter is a caller-allocated out-parameter: `direction="out"`
- * with `caller-allocates="1"`, passed as a pre-built handle the callee fills
- * in place rather than through a `{ value }` cell.
- *
- * @param parameter - The parameter to test
- */
-export declare const isCallerAllocatedOut: (parameter: GirParameter) => boolean;
-/**
- * Whether a parameter is an inout parameter (`direction="inout"`).
- *
- * @param parameter - The parameter to test
- */
-export declare const isInoutParameter: (parameter: GirParameter) => boolean;
-/** A `<return-value>` plus its inferred type and transfer settings. */
-export type GirReturnValue = {
-    readonly type: GirTypeRef | undefined;
-    readonly transferOwnership: ParameterTransfer;
-    readonly nullable: boolean;
+type GirReturnValue = {
+    type: TypeId | undefined;
+    transferOwnership: ParameterTransfer;
+    nullable: boolean;
+    skip: boolean;
 };
-/**
- * Builds a {@link GirReturnValue} from a `<return-value>` element, or returns a
- * void return when the element is missing.
- *
- * @param node - The `<return-value>` element, or `undefined`
- */
-export declare const returnValueFromNode: (node: RawNode | undefined) => GirReturnValue;
-export {};
+type GirCallable = {
+    name: string;
+    doc: string | undefined;
+    parameters: GirParameter[];
+    returnValue: GirReturnValue;
+    throws: boolean;
+    introspectable: boolean;
+};
+declare const transferOwnership: (node: RawNode) => ParameterTransfer;
+declare const parameterFromNode: (node: RawNode, context: ParseContext) => GirParameter;
+declare const isOutParameter: (parameter: GirParameter) => boolean;
+declare const isCallerAllocatedOut: (parameter: GirParameter) => boolean;
+declare const isInoutParameter: (parameter: GirParameter) => boolean;
+declare const parseCallable: (node: RawNode, context: ParseContext) => GirCallable;
+export { transferOwnership, parameterFromNode, isOutParameter, isCallerAllocatedOut, isInoutParameter, parseCallable, type ParameterTransfer, type GirParameter, type GirReturnValue, type GirCallable, };
 //# sourceMappingURL=parameter.d.ts.map

package/dist/gir/parameter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parameter.d.ts","sourceRoot":"","sources":["../../src/gir/parameter.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,KAAK,OAAO,EAAE,MAAM,YAAY,CAAC;AACnE,OAAO,EAAE,KAAK,UAAU,EAAmB,MAAM,eAAe,CAAC;AAEjE,2DAA2D;AAC3D,KAAK,kBAAkB,GAAG,IAAI,GAAG,KAAK,GAAG,OAAO,CAAC;AAEjD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,WAAW,CAAC;AAE9D,oDAAoD;AACpD,KAAK,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,OAAO,GAAG,SAAS,CAAC;AAE/D;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IACvB,4DAA4D;IAC5D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,oEAAoE;IACpE,QAAQ,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;IACvC,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IAC9C,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,iFAAiF;IACjF,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC,wFAAwF;IACxF,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,CAAC;IAC1C,6EAA6E;IAC7E,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C,yEAAyE;IACzE,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C,2EAA2E;IAC3E,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,+CAA+C;IAC/C,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;CAC/B,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,MAAM,OAAO,EAAE,YAAY,OAAO,KAAG,YAmBtE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,WAAW,YAAY,KAAG,OACM,CAAC;AAEhE;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAAI,WAAW,YAAY,KAAG,OACD,CAAC;AAE/D;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAAI,WAAW,YAAY,KAAG,OAA0C,CAAC;AAEtG,uEAAuE;AACvE,MAAM,MAAM,cAAc,GAAG;IACzB,QAAQ,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IAC9C,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,GAAI,MAAM,OAAO,GAAG,SAAS,KAAG,cAS/D,CAAC"}
+{"version":3,"file":"parameter.d.ts","sourceRoot":"","sources":["../../src/gir/parameter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EASH,KAAK,OAAO,EACf,MAAM,YAAY,CAAC;AAGpB,KAAK,kBAAkB,GAAG,IAAI,GAAG,KAAK,GAAG,OAAO,CAAC;AACjD,KAAK,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,WAAW,CAAC;AACvD,KAAK,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,OAAO,GAAG,SAAS,CAAC;AAE/D,KAAK,YAAY,GAAG;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,SAAS,EAAE,kBAAkB,CAAC;IAC9B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,EAAE,OAAO,CAAC;IACzB,KAAK,EAAE,aAAa,GAAG,SAAS,CAAC;IACjC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,SAAS,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,KAAK,cAAc,GAAG;IAClB,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,KAAK,WAAW,GAAG;IACf,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,UAAU,EAAE,YAAY,EAAE,CAAC;IAC3B,WAAW,EAAE,cAAc,CAAC;IAC5B,MAAM,EAAE,OAAO,CAAC;IAChB,cAAc,EAAE,OAAO,CAAC;CAC3B,CAAC;AAMF,QAAA,MAAM,iBAAiB,GAAI,MAAM,OAAO,KAAG,iBACiD,CAAC;AAe7F,QAAA,MAAM,iBAAiB,GAAI,MAAM,OAAO,EAAE,SAAS,YAAY,KAAG,YAYhE,CAAC;AAEH,QAAA,MAAM,cAAc,GAAI,WAAW,YAAY,KAAG,OACa,CAAC;AAEhE,QAAA,MAAM,oBAAoB,GAAI,WAAW,YAAY,KAAG,OACM,CAAC;AAE/D,QAAA,MAAM,gBAAgB,GAAI,WAAW,YAAY,KAAG,OAA0C,CAAC;AAe/F,QAAA,MAAM,aAAa,GAAI,MAAM,OAAO,EAAE,SAAS,YAAY,KAAG,WAY7D,CAAC;AAEF,OAAO,EACH,iBAAiB,EACjB,iBAAiB,EACjB,cAAc,EACd,oBAAoB,EACpB,gBAAgB,EAChB,aAAa,EACb,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,WAAW,GACnB,CAAC"}

package/dist/gir/parameter.js

@@ -1,66 +1,54 @@
-import { attr, attrBool, childOf } from "./parse.js";
-import { typeRefFromSlot } from "./type-ref.js";
-/**
- * Builds a {@link GirParameter} from a `<parameter>` or `<instance-parameter>`.
- *
- * @param node - The XML element
- * @param isInstance - Whether the source element was `<instance-parameter>`
- */
-export const parameterFromNode = (node, isInstance) => {
-    const direction = (attr(node, "direction") ?? "in");
-    const transferOwnership = (attr(node, "transfer-ownership") ?? "none");
-    const closure = attr(node, "closure");
-    const destroy = attr(node, "destroy");
+import { attr, getChild, getChildren, getDoc, intAttr, isAttrTrue, nameAttr, parseEnumAttr, } from "./parse.js";
+import { typeRefFromNode } from "./type-ref.js";
+const DIRECTIONS = new Set(["in", "out", "inout"]);
+const TRANSFERS = new Set(["none", "full", "container"]);
+const SCOPES = new Set(["call", "notified", "async", "forever"]);
+const transferOwnership = (node) => parseEnumAttr(attr(node, "transfer-ownership"), TRANSFERS, "none", "transfer-ownership");
+// `allow-none` is the legacy spelling of two different attributes: on an in-parameter it means the
+// value may be NULL (`nullable`), but on an out-parameter it means the caller may pass a NULL
+// location (`optional`). Folding it into `nullable` for an out-parameter would claim the returned
+// value can be null for the 494 out-parameters across the installed GIRs that only say `allow-none`.
+const isInDirection = (node) => parseEnumAttr(attr(node, "direction"), DIRECTIONS, "in", "direction") === "in";
+const hasNullableAttr = (node) => isAttrTrue(node, "nullable") || (isInDirection(node) && isAttrTrue(node, "allow-none"));
+const hasOptionalAttr = (node) => isAttrTrue(node, "optional") || (!isInDirection(node) && isAttrTrue(node, "allow-none"));
+const parameterFromNode = (node, context) => ({
+    name: nameAttr(node),
+    type: typeRefFromNode(node, context),
+    direction: parseEnumAttr(attr(node, "direction"), DIRECTIONS, "in", "direction"),
+    transferOwnership: transferOwnership(node),
+    nullable: hasNullableAttr(node),
+    optional: hasOptionalAttr(node),
+    callerAllocates: isAttrTrue(node, "caller-allocates"),
+    scope: parseEnumAttr(attr(node, "scope"), SCOPES, undefined, "scope"),
+    closureIndex: intAttr(node, "closure"),
+    destroyIndex: intAttr(node, "destroy"),
+    isVarargs: getChild(node, "varargs") !== undefined,
+});
+const isOutParameter = (parameter) => parameter.direction === "out" && !parameter.callerAllocates;
+const isCallerAllocatedOut = (parameter) => parameter.direction === "out" && parameter.callerAllocates;
+const isInoutParameter = (parameter) => parameter.direction === "inout";
+const returnValueFromNode = (node, context) => {
+    if (node === undefined) {
+        return { type: undefined, transferOwnership: "none", nullable: false, skip: false };
+    }
     return {
-        name: attr(node, "name") ?? "",
-        type: typeRefFromSlot(node),
-        direction,
-        transferOwnership,
-        nullable: attrBool(node, "nullable") || attrBool(node, "allow-none"),
-        optional: attrBool(node, "optional"),
-        callerAllocates: attrBool(node, "caller-allocates"),
-        scope: attr(node, "scope"),
-        closureIndex: closure === undefined ? undefined : Number.parseInt(closure, 10),
-        destroyIndex: destroy === undefined ? undefined : Number.parseInt(destroy, 10),
-        isInstance,
-        isVarargs: childOf(node, "varargs") !== undefined,
+        type: typeRefFromNode(node, context),
+        transferOwnership: transferOwnership(node),
+        nullable: hasNullableAttr(node),
+        skip: isAttrTrue(node, "skip"),
     };
 };
-/**
- * Whether a parameter is a pure out-parameter: `direction="out"` and not
- * caller-allocated, so it marshals through a `{ value }` cell the callee writes into.
- *
- * @param parameter - The parameter to test
- */
-export const isOutParameter = (parameter) => parameter.direction === "out" && !parameter.callerAllocates;
-/**
- * Whether a parameter is a caller-allocated out-parameter: `direction="out"`
- * with `caller-allocates="1"`, passed as a pre-built handle the callee fills
- * in place rather than through a `{ value }` cell.
- *
- * @param parameter - The parameter to test
- */
-export const isCallerAllocatedOut = (parameter) => parameter.direction === "out" && parameter.callerAllocates;
-/**
- * Whether a parameter is an inout parameter (`direction="inout"`).
- *
- * @param parameter - The parameter to test
- */
-export const isInoutParameter = (parameter) => parameter.direction === "inout";
-/**
- * Builds a {@link GirReturnValue} from a `<return-value>` element, or returns a
- * void return when the element is missing.
- *
- * @param node - The `<return-value>` element, or `undefined`
- */
-export const returnValueFromNode = (node) => {
-    if (node === undefined) {
-        return { type: undefined, transferOwnership: "none", nullable: false };
-    }
+const parseCallable = (node, context) => {
+    const parametersNode = getChild(node, "parameters");
+    const parameterNodes = getChildren(parametersNode, "parameter");
     return {
-        type: typeRefFromSlot(node),
-        transferOwnership: (attr(node, "transfer-ownership") ?? "none"),
-        nullable: attrBool(node, "nullable") || attrBool(node, "allow-none"),
+        name: nameAttr(node),
+        doc: getDoc(node),
+        parameters: parameterNodes.map((parameter) => parameterFromNode(parameter, context)),
+        returnValue: returnValueFromNode(getChild(node, "return-value"), context),
+        throws: isAttrTrue(node, "throws"),
+        introspectable: isAttrTrue(node, "introspectable", true),
     };
 };
+export { transferOwnership, parameterFromNode, isOutParameter, isCallerAllocatedOut, isInoutParameter, parseCallable, };
 //# sourceMappingURL=parameter.js.map

package/dist/gir/parameter.js.map

@@ -1 +1 @@
-{"version":3,"file":"parameter.js","sourceRoot":"","sources":["../../src/gir/parameter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAgB,MAAM,YAAY,CAAC;AACnE,OAAO,EAAmB,eAAe,EAAE,MAAM,eAAe,CAAC;AA2CjE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,IAAa,EAAE,UAAmB,EAAgB,EAAE;IAClF,MAAM,SAAS,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,IAAI,CAAuB,CAAC;IAC1E,MAAM,iBAAiB,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,oBAAoB,CAAC,IAAI,MAAM,CAAsB,CAAC;IAC5F,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACtC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACtC,OAAO;QACH,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE;QAC9B,IAAI,EAAE,eAAe,CAAC,IAAI,CAAC;QAC3B,SAAS;QACT,iBAAiB;QACjB,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;QACpE,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;QACpC,eAAe,EAAE,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;QACnD,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,CAA8B;QACvD,YAAY,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC;QAC9E,YAAY,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC;QAC9E,UAAU;QACV,SAAS,EAAE,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,SAAS;KACpD,CAAC;AACN,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,SAAuB,EAAW,EAAE,CAC/D,SAAS,CAAC,SAAS,KAAK,KAAK,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC;AAEhE;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,SAAuB,EAAW,EAAE,CACrE,SAAS,CAAC,SAAS,KAAK,KAAK,IAAI,SAAS,CAAC,eAAe,CAAC;AAE/D;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,SAAuB,EAAW,EAAE,CAAC,SAAS,CAAC,SAAS,KAAK,OAAO,CAAC;AAStG;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAAyB,EAAkB,EAAE;IAC7E,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;IAC3E,CAAC;IACD,OAAO;QACH,IAAI,EAAE,eAAe,CAAC,IAAI,CAAC;QAC3B,iBAAiB,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,oBAAoB,CAAC,IAAI,MAAM,CAAsB;QACpF,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;KACvE,CAAC;AACN,CAAC,CAAC"}
+{"version":3,"file":"parameter.js","sourceRoot":"","sources":["../../src/gir/parameter.ts"],"names":[],"mappings":"AACA,OAAO,EACH,IAAI,EACJ,QAAQ,EACR,WAAW,EACX,MAAM,EACN,OAAO,EACP,UAAU,EACV,QAAQ,EACR,aAAa,GAEhB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAoChD,MAAM,UAAU,GAA4B,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;AAC5E,MAAM,SAAS,GAA2B,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;AACjF,MAAM,MAAM,GAAuB,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;AAErF,MAAM,iBAAiB,GAAG,CAAC,IAAa,EAAqB,EAAE,CAC3D,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,oBAAoB,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,oBAAoB,CAAC,CAAC;AAE7F,mGAAmG;AACnG,8FAA8F;AAC9F,kGAAkG;AAClG,qGAAqG;AACrG,MAAM,aAAa,GAAG,CAAC,IAAa,EAAW,EAAE,CAC7C,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,WAAW,CAAC,KAAK,IAAI,CAAC;AAEnF,MAAM,eAAe,GAAG,CAAC,IAAa,EAAW,EAAE,CAC/C,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC;AAE5F,MAAM,eAAe,GAAG,CAAC,IAAa,EAAW,EAAE,CAC/C,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC;AAE7F,MAAM,iBAAiB,GAAG,CAAC,IAAa,EAAE,OAAqB,EAAgB,EAAE,CAAC,CAAC;IAC/E,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC;IACpB,IAAI,EAAE,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC;IACpC,SAAS,EAAE,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,WAAW,CAAC;IAChF,iBAAiB,EAAE,iBAAiB,CAAC,IAAI,CAAC;IAC1C,QAAQ,EAAE,eAAe,CAAC,IAAI,CAAC;IAC/B,QAAQ,EAAE,eAAe,CAAC,IAAI,CAAC;IAC/B,eAAe,EAAE,UAAU,CAAC,IAAI,EAAE,kBAAkB,CAAC;IACrD,KAAK,EAAE,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC;IACrE,YAAY,EAAE,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC;IACtC,YAAY,EAAE,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC;IACtC,SAAS,EAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,SAAS;CACrD,CAAC,CAAC;AAEH,MAAM,cAAc,GAAG,CAAC,SAAuB,EAAW,EAAE,CACxD,SAAS,CAAC,SAAS,KAAK,KAAK,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC;AAEhE,MAAM,oBAAoB,GAAG,CAAC,SAAuB,EAAW,EAAE,CAC9D,SAAS,CAAC,SAAS,KAAK,KAAK,IAAI,SAAS,CAAC,eAAe,CAAC;AAE/D,MAAM,gBAAgB,GAAG,CAAC,SAAuB,EAAW,EAAE,CAAC,SAAS,CAAC,SAAS,KAAK,OAAO,CAAC;AAE/F,MAAM,mBAAmB,GAAG,CAAC,IAAyB,EAAE,OAAqB,EAAkB,EAAE;IAC7F,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IACxF,CAAC;IAED,OAAO;QACH,IAAI,EAAE,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC;QACpC,iBAAiB,EAAE,iBAAiB,CAAC,IAAI,CAAC;QAC1C,QAAQ,EAAE,eAAe,CAAC,IAAI,CAAC;QAC/B,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC;KACjC,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,IAAa,EAAE,OAAqB,EAAe,EAAE;IACxE,MAAM,cAAc,GAAG,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACpD,MAAM,cAAc,GAAG,WAAW,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;IAEhE,OAAO;QACH,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC;QACpB,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC;QACjB,UAAU,EAAE,cAAc,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACpF,WAAW,EAAE,mBAAmB,CAAC,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,OAAO,CAAC;QACzE,MAAM,EAAE,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC;QAClC,cAAc,EAAE,UAAU,CAAC,IAAI,EAAE,gBAAgB,EAAE,IAAI,CAAC;KAC3D,CAAC;AACN,CAAC,CAAC;AAEF,OAAO,EACH,iBAAiB,EACjB,iBAAiB,EACjB,cAAc,EACd,oBAAoB,EACpB,gBAAgB,EAChB,aAAa,GAKhB,CAAC","sourcesContent":["import type { ParseContext, TypeId } from \"./type-id.js\";\nimport {\n    attr,\n    getChild,\n    getChildren,\n    getDoc,\n    intAttr,\n    isAttrTrue,\n    nameAttr,\n    parseEnumAttr,\n    type RawNode,\n} from \"./parse.js\";\nimport { typeRefFromNode } from \"./type-ref.js\";\n\ntype ParameterDirection = \"in\" | \"out\" | \"inout\";\ntype ParameterTransfer = \"none\" | \"full\" | \"container\";\ntype CallbackScope = \"call\" | \"notified\" | \"async\" | \"forever\";\n\ntype GirParameter = {\n    name: string;\n    type: TypeId | undefined;\n    direction: ParameterDirection;\n    transferOwnership: ParameterTransfer;\n    nullable: boolean;\n    optional: boolean;\n    callerAllocates: boolean;\n    scope: CallbackScope | undefined;\n    closureIndex: number | undefined;\n    destroyIndex: number | undefined;\n    isVarargs: boolean;\n};\n\ntype GirReturnValue = {\n    type: TypeId | undefined;\n    transferOwnership: ParameterTransfer;\n    nullable: boolean;\n    skip: boolean;\n};\n\ntype GirCallable = {\n    name: string;\n    doc: string | undefined;\n    parameters: GirParameter[];\n    returnValue: GirReturnValue;\n    throws: boolean;\n    introspectable: boolean;\n};\n\nconst DIRECTIONS: Set<ParameterDirection> = new Set([\"in\", \"out\", \"inout\"]);\nconst TRANSFERS: Set<ParameterTransfer> = new Set([\"none\", \"full\", \"container\"]);\nconst SCOPES: Set<CallbackScope> = new Set([\"call\", \"notified\", \"async\", \"forever\"]);\n\nconst transferOwnership = (node: RawNode): ParameterTransfer =>\n    parseEnumAttr(attr(node, \"transfer-ownership\"), TRANSFERS, \"none\", \"transfer-ownership\");\n\n// `allow-none` is the legacy spelling of two different attributes: on an in-parameter it means the\n// value may be NULL (`nullable`), but on an out-parameter it means the caller may pass a NULL\n// location (`optional`). Folding it into `nullable` for an out-parameter would claim the returned\n// value can be null for the 494 out-parameters across the installed GIRs that only say `allow-none`.\nconst isInDirection = (node: RawNode): boolean =>\n    parseEnumAttr(attr(node, \"direction\"), DIRECTIONS, \"in\", \"direction\") === \"in\";\n\nconst hasNullableAttr = (node: RawNode): boolean =>\n    isAttrTrue(node, \"nullable\") || (isInDirection(node) && isAttrTrue(node, \"allow-none\"));\n\nconst hasOptionalAttr = (node: RawNode): boolean =>\n    isAttrTrue(node, \"optional\") || (!isInDirection(node) && isAttrTrue(node, \"allow-none\"));\n\nconst parameterFromNode = (node: RawNode, context: ParseContext): GirParameter => ({\n    name: nameAttr(node),\n    type: typeRefFromNode(node, context),\n    direction: parseEnumAttr(attr(node, \"direction\"), DIRECTIONS, \"in\", \"direction\"),\n    transferOwnership: transferOwnership(node),\n    nullable: hasNullableAttr(node),\n    optional: hasOptionalAttr(node),\n    callerAllocates: isAttrTrue(node, \"caller-allocates\"),\n    scope: parseEnumAttr(attr(node, \"scope\"), SCOPES, undefined, \"scope\"),\n    closureIndex: intAttr(node, \"closure\"),\n    destroyIndex: intAttr(node, \"destroy\"),\n    isVarargs: getChild(node, \"varargs\") !== undefined,\n});\n\nconst isOutParameter = (parameter: GirParameter): boolean =>\n    parameter.direction === \"out\" && !parameter.callerAllocates;\n\nconst isCallerAllocatedOut = (parameter: GirParameter): boolean =>\n    parameter.direction === \"out\" && parameter.callerAllocates;\n\nconst isInoutParameter = (parameter: GirParameter): boolean => parameter.direction === \"inout\";\n\nconst returnValueFromNode = (node: RawNode | undefined, context: ParseContext): GirReturnValue => {\n    if (node === undefined) {\n        return { type: undefined, transferOwnership: \"none\", nullable: false, skip: false };\n    }\n\n    return {\n        type: typeRefFromNode(node, context),\n        transferOwnership: transferOwnership(node),\n        nullable: hasNullableAttr(node),\n        skip: isAttrTrue(node, \"skip\"),\n    };\n};\n\nconst parseCallable = (node: RawNode, context: ParseContext): GirCallable => {\n    const parametersNode = getChild(node, \"parameters\");\n    const parameterNodes = getChildren(parametersNode, \"parameter\");\n\n    return {\n        name: nameAttr(node),\n        doc: getDoc(node),\n        parameters: parameterNodes.map((parameter) => parameterFromNode(parameter, context)),\n        returnValue: returnValueFromNode(getChild(node, \"return-value\"), context),\n        throws: isAttrTrue(node, \"throws\"),\n        introspectable: isAttrTrue(node, \"introspectable\", true),\n    };\n};\n\nexport {\n    transferOwnership,\n    parameterFromNode,\n    isOutParameter,\n    isCallerAllocatedOut,\n    isInoutParameter,\n    parseCallable,\n    type ParameterTransfer,\n    type GirParameter,\n    type GirReturnValue,\n    type GirCallable,\n};\n"]}

package/dist/gir/parse.d.ts

@@ -1,78 +1,13 @@
-/**
- * Raw GIR XML element after parsing.
- *
- * Attributes are exposed under `@_<name>` keys (the default
- * `fast-xml-parser` convention). Child elements appear under their tag name.
- * Multi-occurrence tags (every container in {@link MULTI_TAGS}) are always
- * arrays so callers do not need to disambiguate "single child" from "many
- * children" at every access. Single-occurrence tags appear as bare objects.
- */
-export type RawNode = {
-    readonly [attributeOrChild: string]: unknown;
-};
-/**
- * The tag name codegen reads GIR constructors under.
- *
- * GIR spells constructors `<constructor>`, but `fast-xml-parser` rejects the
- * literal names `constructor`, `prototype`, and `__proto__` to guard against
- * prototype pollution, with no opt-out. {@link parseGirFile} rewrites the tag
- * to this token via `transformTagName` before that guard runs, so every
- * downstream lookup of a constructor child must use this constant rather than
- * the raw GIR name.
- */
-export declare const GIR_CONSTRUCTOR_TAG = "gir-constructor";
-/**
- * Parses a GIR XML file from disk and returns its raw tree.
- *
- * The returned object always has a single `repository` property containing
- * the root `<repository>` element. Callers should not interpret the tree
- * directly — pass it to {@link GirRepository.load} (in `./repository.ts`),
- * which builds the typed domain model on top of it.
- *
- * @param path - Absolute path to a `.gir` file
- * @returns The raw repository node
- */
-export declare const parseGirFile: (path: string) => RawNode;
-/**
- * Reads an attribute from a raw GIR node as a string, returning `undefined`
- * when the attribute is absent.
- *
- * The `@_` prefix is added by `fast-xml-parser`; this helper hides that
- * convention from the call sites.
- *
- * @param node - The raw element
- * @param name - The attribute name (without the `@_` prefix)
- */
-export declare const attr: (node: RawNode | undefined, name: string) => string | undefined;
-/**
- * Reads an attribute as a boolean using GIR's `"1"` / `"0"` convention.
- *
- * Attributes that are missing return the supplied default (defaulting to
- * `false`). Any non-`"1"` value is treated as `false`.
- *
- * @param node - The raw element
- * @param name - The attribute name (without the `@_` prefix)
- * @param fallback - Value returned when the attribute is missing
- */
-export declare const attrBool: (node: RawNode | undefined, name: string, fallback?: boolean) => boolean;
-/**
- * Returns the children of a raw node under a given tag name as an array.
- *
- * The parser configuration forces multi-occurrence tags to arrays already;
- * this helper covers the residual case where a tag was registered as
- * single-occurrence at the schema level but a particular file emits zero
- * elements (returning `[]`) or where the caller wants a uniform array view.
- *
- * @param node - The parent element
- * @param tag - The child tag name (with namespace prefix if any)
- */
-export declare const childrenOf: (node: RawNode | undefined, tag: string) => readonly RawNode[];
-/**
- * Returns the single child of a raw node under a given tag, or `undefined`
- * if absent. If multiple are present the first is returned.
- *
- * @param node - The parent element
- * @param tag - The child tag name (with namespace prefix if any)
- */
-export declare const childOf: (node: RawNode | undefined, tag: string) => RawNode | undefined;
+type RawNode = Record<string, unknown>;
+declare const GIR_CONSTRUCTOR_TAG = "gir-constructor";
+declare const parseGirFile: (path: string) => RawNode;
+declare const attr: (node: RawNode | undefined, name: string) => string | undefined;
+declare const isAttrTrue: (node: RawNode | undefined, name: string, isTrueByDefault?: boolean) => boolean;
+declare const nameAttr: (node: RawNode) => string;
+declare const intAttr: (node: RawNode, name: string) => number | undefined;
+declare const parseEnumAttr: <T extends string, F extends T | undefined>(raw: string | undefined, members: Set<T>, fallback: F, label: string) => T | F;
+declare const getChildren: (node: RawNode | undefined, tag: string) => RawNode[];
+declare const getChild: (node: RawNode | undefined, tag: string) => RawNode | undefined;
+declare const getDoc: (node: RawNode | undefined) => string | undefined;
+export { GIR_CONSTRUCTOR_TAG, parseGirFile, attr, isAttrTrue, nameAttr, intAttr, parseEnumAttr, getChildren, getChild, getDoc, type RawNode, };
 //# sourceMappingURL=parse.d.ts.map

package/dist/gir/parse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/gir/parse.ts"],"names":[],"mappings":"AAGA;;;;;;;;GAQG;AACH,MAAM,MAAM,OAAO,GAAG;IAClB,QAAQ,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC;CAChD,CAAC;AAuCF;;;;;;;;;GASG;AACH,eAAO,MAAM,mBAAmB,oBAAoB,CAAC;AAyBrD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,MAAM,KAAG,OAG3C,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,IAAI,GAAI,MAAM,OAAO,GAAG,SAAS,EAAE,MAAM,MAAM,KAAG,MAAM,GAAG,SAIvE,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,QAAQ,GAAI,MAAM,OAAO,GAAG,SAAS,EAAE,MAAM,MAAM,EAAE,kBAAgB,KAAG,OAIpF,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,GAAI,MAAM,OAAO,GAAG,SAAS,EAAE,KAAK,MAAM,KAAG,SAAS,OAAO,EAMnF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,GAAI,MAAM,OAAO,GAAG,SAAS,EAAE,KAAK,MAAM,KAAG,OAAO,GAAG,SAQ1E,CAAC"}
+{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/gir/parse.ts"],"names":[],"mappings":"AAGA,KAAK,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAyBvC,QAAA,MAAM,mBAAmB,oBAAoB,CAAC;AAc9C,QAAA,MAAM,YAAY,GAAI,MAAM,MAAM,KAAG,OAIpC,CAAC;AAEF,QAAA,MAAM,IAAI,GAAI,MAAM,OAAO,GAAG,SAAS,EAAE,MAAM,MAAM,KAAG,MAAM,GAAG,SAQhE,CAAC;AAEF,QAAA,MAAM,UAAU,GAAI,MAAM,OAAO,GAAG,SAAS,EAAE,MAAM,MAAM,EAAE,yBAAuB,KAAG,OAQtF,CAAC;AAEF,QAAA,MAAM,QAAQ,GAAI,MAAM,OAAO,KAAG,MAAkC,CAAC;AAErE,QAAA,MAAM,OAAO,GAAI,MAAM,OAAO,EAAE,MAAM,MAAM,KAAG,MAAM,GAAG,SAIvD,CAAC;AAYF,QAAA,MAAM,aAAa,GAAI,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,CAAC,GAAG,SAAS,EAC5D,KAAK,MAAM,GAAG,SAAS,EACvB,SAAS,GAAG,CAAC,CAAC,CAAC,EACf,UAAU,CAAC,EACX,OAAO,MAAM,KACd,CAAC,GAAG,CAAqE,CAAC;AAE7E,QAAA,MAAM,WAAW,GAAI,MAAM,OAAO,GAAG,SAAS,EAAE,KAAK,MAAM,KAAG,OAAO,EAgBpE,CAAC;AAEF,QAAA,MAAM,QAAQ,GAAI,MAAM,OAAO,GAAG,SAAS,EAAE,KAAK,MAAM,KAAG,OAAO,GAAG,SAgBpE,CAAC;AAgBF,QAAA,MAAM,MAAM,GAAI,MAAM,OAAO,GAAG,SAAS,KAAG,MAAM,GAAG,SAgBpD,CAAC;AAEF,OAAO,EACH,mBAAmB,EACnB,YAAY,EACZ,IAAI,EACJ,UAAU,EACV,QAAQ,EACR,OAAO,EACP,aAAa,EACb,WAAW,EACX,QAAQ,EACR,MAAM,EACN,KAAK,OAAO,GACf,CAAC"}

package/dist/gir/parse.js

@@ -1,17 +1,7 @@
 import { readFileSync } from "node:fs";
-import { XMLParser } from "fast-xml-parser";
-/**
- * Tag names that the GIR schema permits at multi-occurrence positions.
- *
- * `fast-xml-parser` is configured to always materialize these as arrays so
- * downstream traversal never needs to branch on "is this an object or an
- * array of objects". Tags missing from this set may appear as a single
- * object (e.g. `<return-value>`, `<parameters>`, `<type>`, `<doc>`).
- */
+import { createXmlParser } from "../xml.js";
 const MULTI_TAGS = new Set([
     "include",
-    "c:include",
-    "package",
     "class",
     "interface",
     "record",
@@ -19,14 +9,11 @@ const MULTI_TAGS = new Set([
     "bitfield",
     "callback",
     "function",
-    "function-macro",
     "constant",
     "alias",
     "union",
-    "glib:boxed",
     "method",
     "constructor",
-    "virtual-method",
     "property",
     "field",
     "glib:signal",
@@ -34,122 +21,97 @@ const MULTI_TAGS = new Set([
     "prerequisite",
     "member",
     "parameter",
-    "attribute",
 ]);
-/**
- * The tag name codegen reads GIR constructors under.
- *
- * GIR spells constructors `<constructor>`, but `fast-xml-parser` rejects the
- * literal names `constructor`, `prototype`, and `__proto__` to guard against
- * prototype pollution, with no opt-out. {@link parseGirFile} rewrites the tag
- * to this token via `transformTagName` before that guard runs, so every
- * downstream lookup of a constructor child must use this constant rather than
- * the raw GIR name.
- */
-export const GIR_CONSTRUCTOR_TAG = "gir-constructor";
+const GIR_CONSTRUCTOR_TAG = "gir-constructor";
 const RESERVED_TAG_RENAMES = new Map([["constructor", GIR_CONSTRUCTOR_TAG]]);
-/**
- * Maps a GIR tag name to the token the parser exposes it under, rewriting the
- * names {@link RESERVED_TAG_RENAMES} covers and passing every other tag
- * through unchanged.
- *
- * @param tag - The raw GIR tag name
- */
-const renameReservedTag = (tag) => RESERVED_TAG_RENAMES.get(tag) ?? tag;
-const RENAMED_MULTI_TAGS = new Set([...MULTI_TAGS].map(renameReservedTag));
-const PARSER = new XMLParser({
-    ignoreAttributes: false,
-    attributeNamePrefix: "@_",
-    parseAttributeValue: false,
-    parseTagValue: false,
+const RENAMED_MULTI_TAGS = new Set([...MULTI_TAGS].map((tag) => renameReservedTag(tag)));
+const PARSER = createXmlParser({
     trimValues: true,
     transformTagName: renameReservedTag,
     isArray: (name) => RENAMED_MULTI_TAGS.has(name),
 });
-/**
- * Parses a GIR XML file from disk and returns its raw tree.
- *
- * The returned object always has a single `repository` property containing
- * the root `<repository>` element. Callers should not interpret the tree
- * directly — pass it to {@link GirRepository.load} (in `./repository.ts`),
- * which builds the typed domain model on top of it.
- *
- * @param path - Absolute path to a `.gir` file
- * @returns The raw repository node
- */
-export const parseGirFile = (path) => {
-    const xml = readFileSync(path, "utf-8");
+function renameReservedTag(tag) {
+    return RESERVED_TAG_RENAMES.get(tag) ?? tag;
+}
+const parseGirFile = (path) => {
+    const xml = readFileSync(path, "utf8");
     return PARSER.parse(xml);
 };
-/**
- * Reads an attribute from a raw GIR node as a string, returning `undefined`
- * when the attribute is absent.
- *
- * The `@_` prefix is added by `fast-xml-parser`; this helper hides that
- * convention from the call sites.
- *
- * @param node - The raw element
- * @param name - The attribute name (without the `@_` prefix)
- */
-export const attr = (node, name) => {
-    if (node === undefined)
+const attr = (node, name) => {
+    if (node === undefined) {
         return undefined;
+    }
     const value = node[`@_${name}`];
     return typeof value === "string" ? value : undefined;
 };
-/**
- * Reads an attribute as a boolean using GIR's `"1"` / `"0"` convention.
- *
- * Attributes that are missing return the supplied default (defaulting to
- * `false`). Any non-`"1"` value is treated as `false`.
- *
- * @param node - The raw element
- * @param name - The attribute name (without the `@_` prefix)
- * @param fallback - Value returned when the attribute is missing
- */
-export const attrBool = (node, name, fallback = false) => {
+const isAttrTrue = (node, name, isTrueByDefault = false) => {
     const value = attr(node, name);
-    if (value === undefined)
-        return fallback;
+    if (value === undefined) {
+        return isTrueByDefault;
+    }
     return value === "1";
 };
-/**
- * Returns the children of a raw node under a given tag name as an array.
- *
- * The parser configuration forces multi-occurrence tags to arrays already;
- * this helper covers the residual case where a tag was registered as
- * single-occurrence at the schema level but a particular file emits zero
- * elements (returning `[]`) or where the caller wants a uniform array view.
- *
- * @param node - The parent element
- * @param tag - The child tag name (with namespace prefix if any)
- */
-export const childrenOf = (node, tag) => {
-    if (node === undefined)
+const nameAttr = (node) => attr(node, "name") ?? "";
+const intAttr = (node, name) => {
+    const raw = attr(node, name);
+    return raw === undefined ? undefined : Number(raw);
+};
+const enumMember = (raw, members, label) => {
+    for (const member of members) {
+        if (member === raw) {
+            return member;
+        }
+    }
+    throw new Error(`Unknown ${label} value "${raw}"`);
+};
+const parseEnumAttr = (raw, members, fallback, label) => (raw === undefined ? fallback : enumMember(raw, members, label));
+const getChildren = (node, tag) => {
+    if (node === undefined) {
         return [];
+    }
     const value = node[tag];
-    if (value === undefined)
+    if (value === undefined) {
         return [];
-    if (Array.isArray(value))
+    }
+    if (Array.isArray(value)) {
         return value;
+    }
     return [value];
 };
-/**
- * Returns the single child of a raw node under a given tag, or `undefined`
- * if absent. If multiple are present the first is returned.
- *
- * @param node - The parent element
- * @param tag - The child tag name (with namespace prefix if any)
- */
-export const childOf = (node, tag) => {
-    if (node === undefined)
+const getChild = (node, tag) => {
+    if (node === undefined) {
         return undefined;
+    }
     const value = node[tag];
-    if (value === undefined)
+    if (value === undefined) {
         return undefined;
+    }
     if (Array.isArray(value)) {
         return value.length === 0 ? undefined : value[0];
     }
     return value;
 };
+const normalizeDoc = (text) => {
+    const trimmed = text.trim();
+    return trimmed.length === 0 ? undefined : trimmed;
+};
+const firstDocValue = (raw) => (Array.isArray(raw) ? raw[0] : raw);
+const docTextFromObject = (value) => {
+    const text = value["#text"];
+    return typeof text === "string" ? normalizeDoc(text) : undefined;
+};
+const getDoc = (node) => {
+    if (node === undefined) {
+        return undefined;
+    }
+    const value = firstDocValue(node.doc);
+    if (typeof value === "string") {
+        return normalizeDoc(value);
+    }
+    if (value === null || typeof value !== "object") {
+        return undefined;
+    }
+    return docTextFromObject(value);
+};
+export { GIR_CONSTRUCTOR_TAG, parseGirFile, attr, isAttrTrue, nameAttr, intAttr, parseEnumAttr, getChildren, getChild, getDoc, };
 //# sourceMappingURL=parse.js.map

package/dist/gir/parse.js.map

@@ -1 +1 @@
-{"version":3,"file":"parse.js","sourceRoot":"","sources":["../../src/gir/parse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAe5C;;;;;;;GAOG;AACH,MAAM,UAAU,GAAwB,IAAI,GAAG,CAAC;IAC5C,SAAS;IACT,WAAW;IACX,SAAS;IACT,OAAO;IACP,WAAW;IACX,QAAQ;IACR,aAAa;IACb,UAAU;IACV,UAAU;IACV,UAAU;IACV,gBAAgB;IAChB,UAAU;IACV,OAAO;IACP,OAAO;IACP,YAAY;IACZ,QAAQ;IACR,aAAa;IACb,gBAAgB;IAChB,UAAU;IACV,OAAO;IACP,aAAa;IACb,YAAY;IACZ,cAAc;IACd,QAAQ;IACR,WAAW;IACX,WAAW;CACd,CAAC,CAAC;AAEH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,iBAAiB,CAAC;AAErD,MAAM,oBAAoB,GAAgC,IAAI,GAAG,CAAC,CAAC,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;AAE1G;;;;;;GAMG;AACH,MAAM,iBAAiB,GAAG,CAAC,GAAW,EAAU,EAAE,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC;AAExF,MAAM,kBAAkB,GAAwB,IAAI,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC;AAEhG,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;IACzB,gBAAgB,EAAE,KAAK;IACvB,mBAAmB,EAAE,IAAI;IACzB,mBAAmB,EAAE,KAAK;IAC1B,aAAa,EAAE,KAAK;IACpB,UAAU,EAAE,IAAI;IAChB,gBAAgB,EAAE,iBAAiB;IACnC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC;CAClD,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAY,EAAW,EAAE;IAClD,MAAM,GAAG,GAAG,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACxC,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,CAAY,CAAC;AACxC,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,IAAyB,EAAE,IAAY,EAAsB,EAAE;IAChF,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACzC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IAChC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACzD,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,IAAyB,EAAE,IAAY,EAAE,QAAQ,GAAG,KAAK,EAAW,EAAE;IAC3F,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/B,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC;IACzC,OAAO,KAAK,KAAK,GAAG,CAAC;AACzB,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAyB,EAAE,GAAW,EAAsB,EAAE;IACrF,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IAClC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;IACxB,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IACnC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAA2B,CAAC;IAC7D,OAAO,CAAC,KAAgB,CAAC,CAAC;AAC9B,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,IAAyB,EAAE,GAAW,EAAuB,EAAE;IACnF,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACzC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;IACxB,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAE,KAAK,CAAC,CAAC,CAAa,CAAC;IAClE,CAAC;IACD,OAAO,KAAgB,CAAC;AAC5B,CAAC,CAAC"}
+{"version":3,"file":"parse.js","sourceRoot":"","sources":["../../src/gir/parse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAI5C,MAAM,UAAU,GAAgB,IAAI,GAAG,CAAC;IACpC,SAAS;IACT,OAAO;IACP,WAAW;IACX,QAAQ;IACR,aAAa;IACb,UAAU;IACV,UAAU;IACV,UAAU;IACV,UAAU;IACV,OAAO;IACP,OAAO;IACP,QAAQ;IACR,aAAa;IACb,UAAU;IACV,OAAO;IACP,aAAa;IACb,YAAY;IACZ,cAAc;IACd,QAAQ;IACR,WAAW;CACd,CAAC,CAAC;AAEH,MAAM,mBAAmB,GAAG,iBAAiB,CAAC;AAC9C,MAAM,oBAAoB,GAAwB,IAAI,GAAG,CAAC,CAAC,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;AAClG,MAAM,kBAAkB,GAAgB,IAAI,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAEtG,MAAM,MAAM,GAAG,eAAe,CAAC;IAC3B,UAAU,EAAE,IAAI;IAChB,gBAAgB,EAAE,iBAAiB;IACnC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC;CAClD,CAAC,CAAC;AAEH,SAAS,iBAAiB,CAAC,GAAW;IAClC,OAAO,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC;AAChD,CAAC;AAED,MAAM,YAAY,GAAG,CAAC,IAAY,EAAW,EAAE;IAC3C,MAAM,GAAG,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAEvC,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,CAAY,CAAC;AACxC,CAAC,CAAC;AAEF,MAAM,IAAI,GAAG,CAAC,IAAyB,EAAE,IAAY,EAAsB,EAAE;IACzE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IAEhC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,IAAyB,EAAE,IAAY,EAAE,eAAe,GAAG,KAAK,EAAW,EAAE;IAC7F,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAE/B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,eAAe,CAAC;IAC3B,CAAC;IAED,OAAO,KAAK,KAAK,GAAG,CAAC;AACzB,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,IAAa,EAAU,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;AAErE,MAAM,OAAO,GAAG,CAAC,IAAa,EAAE,IAAY,EAAsB,EAAE;IAChE,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAE7B,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACvD,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAmB,GAAW,EAAE,OAAe,EAAE,KAAa,EAAK,EAAE;IACpF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC3B,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACjB,OAAO,MAAM,CAAC;QAClB,CAAC;IACL,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,WAAW,KAAK,WAAW,GAAG,GAAG,CAAC,CAAC;AACvD,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAClB,GAAuB,EACvB,OAAe,EACf,QAAW,EACX,KAAa,EACR,EAAE,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;AAE7E,MAAM,WAAW,GAAG,CAAC,IAAyB,EAAE,GAAW,EAAa,EAAE;IACtE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;IAExB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,KAAkB,CAAC;IAC9B,CAAC;IAED,OAAO,CAAC,KAAgB,CAAC,CAAC;AAC9B,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,IAAyB,EAAE,GAAW,EAAuB,EAAE;IAC7E,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;IAExB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAE,KAAK,CAAC,CAAC,CAAa,CAAC;IAClE,CAAC;IAED,OAAO,KAAgB,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,IAAY,EAAsB,EAAE;IACtD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAE5B,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;AACtD,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,GAAY,EAAW,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAErF,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAsB,EAAE;IAC5D,MAAM,IAAI,GAAI,KAAiB,CAAC,OAAO,CAAC,CAAC;IAEzC,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACrE,CAAC,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,IAAyB,EAAsB,EAAE;IAC7D,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEtC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9C,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,OAAO,iBAAiB,CAAC,KAAK,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF,OAAO,EACH,mBAAmB,EACnB,YAAY,EACZ,IAAI,EACJ,UAAU,EACV,QAAQ,EACR,OAAO,EACP,aAAa,EACb,WAAW,EACX,QAAQ,EACR,MAAM,GAET,CAAC","sourcesContent":["import { readFileSync } from \"node:fs\";\nimport { createXmlParser } from \"../xml.js\";\n\ntype RawNode = Record<string, unknown>;\n\nconst MULTI_TAGS: Set<string> = new Set([\n    \"include\",\n    \"class\",\n    \"interface\",\n    \"record\",\n    \"enumeration\",\n    \"bitfield\",\n    \"callback\",\n    \"function\",\n    \"constant\",\n    \"alias\",\n    \"union\",\n    \"method\",\n    \"constructor\",\n    \"property\",\n    \"field\",\n    \"glib:signal\",\n    \"implements\",\n    \"prerequisite\",\n    \"member\",\n    \"parameter\",\n]);\n\nconst GIR_CONSTRUCTOR_TAG = \"gir-constructor\";\nconst RESERVED_TAG_RENAMES: Map<string, string> = new Map([[\"constructor\", GIR_CONSTRUCTOR_TAG]]);\nconst RENAMED_MULTI_TAGS: Set<string> = new Set([...MULTI_TAGS].map((tag) => renameReservedTag(tag)));\n\nconst PARSER = createXmlParser({\n    trimValues: true,\n    transformTagName: renameReservedTag,\n    isArray: (name) => RENAMED_MULTI_TAGS.has(name),\n});\n\nfunction renameReservedTag(tag: string): string {\n    return RESERVED_TAG_RENAMES.get(tag) ?? tag;\n}\n\nconst parseGirFile = (path: string): RawNode => {\n    const xml = readFileSync(path, \"utf8\");\n\n    return PARSER.parse(xml) as RawNode;\n};\n\nconst attr = (node: RawNode | undefined, name: string): string | undefined => {\n    if (node === undefined) {\n        return undefined;\n    }\n\n    const value = node[`@_${name}`];\n\n    return typeof value === \"string\" ? value : undefined;\n};\n\nconst isAttrTrue = (node: RawNode | undefined, name: string, isTrueByDefault = false): boolean => {\n    const value = attr(node, name);\n\n    if (value === undefined) {\n        return isTrueByDefault;\n    }\n\n    return value === \"1\";\n};\n\nconst nameAttr = (node: RawNode): string => attr(node, \"name\") ?? \"\";\n\nconst intAttr = (node: RawNode, name: string): number | undefined => {\n    const raw = attr(node, name);\n\n    return raw === undefined ? undefined : Number(raw);\n};\n\nconst enumMember = <T extends string>(raw: string, members: Set<T>, label: string): T => {\n    for (const member of members) {\n        if (member === raw) {\n            return member;\n        }\n    }\n\n    throw new Error(`Unknown ${label} value \"${raw}\"`);\n};\n\nconst parseEnumAttr = <T extends string, F extends T | undefined>(\n    raw: string | undefined,\n    members: Set<T>,\n    fallback: F,\n    label: string,\n): T | F => (raw === undefined ? fallback : enumMember(raw, members, label));\n\nconst getChildren = (node: RawNode | undefined, tag: string): RawNode[] => {\n    if (node === undefined) {\n        return [];\n    }\n\n    const value = node[tag];\n\n    if (value === undefined) {\n        return [];\n    }\n\n    if (Array.isArray(value)) {\n        return value as RawNode[];\n    }\n\n    return [value as RawNode];\n};\n\nconst getChild = (node: RawNode | undefined, tag: string): RawNode | undefined => {\n    if (node === undefined) {\n        return undefined;\n    }\n\n    const value = node[tag];\n\n    if (value === undefined) {\n        return undefined;\n    }\n\n    if (Array.isArray(value)) {\n        return value.length === 0 ? undefined : (value[0] as RawNode);\n    }\n\n    return value as RawNode;\n};\n\nconst normalizeDoc = (text: string): string | undefined => {\n    const trimmed = text.trim();\n\n    return trimmed.length === 0 ? undefined : trimmed;\n};\n\nconst firstDocValue = (raw: unknown): unknown => (Array.isArray(raw) ? raw[0] : raw);\n\nconst docTextFromObject = (value: object): string | undefined => {\n    const text = (value as RawNode)[\"#text\"];\n\n    return typeof text === \"string\" ? normalizeDoc(text) : undefined;\n};\n\nconst getDoc = (node: RawNode | undefined): string | undefined => {\n    if (node === undefined) {\n        return undefined;\n    }\n\n    const value = firstDocValue(node.doc);\n\n    if (typeof value === \"string\") {\n        return normalizeDoc(value);\n    }\n\n    if (value === null || typeof value !== \"object\") {\n        return undefined;\n    }\n\n    return docTextFromObject(value);\n};\n\nexport {\n    GIR_CONSTRUCTOR_TAG,\n    parseGirFile,\n    attr,\n    isAttrTrue,\n    nameAttr,\n    intAttr,\n    parseEnumAttr,\n    getChildren,\n    getChild,\n    getDoc,\n    type RawNode,\n};\n"]}