@gtkx/gir 0.11.0 → 0.11.2

package/dist/internal/normalizer.js

@@ -151,6 +151,9 @@ const normalizeType = (raw, currentNamespace, ctx) => {
             elementType: normalizeType(raw.elementType, currentNamespace, ctx),
             transferOwnership: raw.transferOwnership,
             nullable: raw.nullable ?? false,
+            lengthParamIndex: raw.lengthParamIndex,
+            zeroTerminated: raw.zeroTerminated,
+            fixedSize: raw.fixedSize,
         });
     }
     if (isArray) {
@@ -161,6 +164,9 @@ const normalizeType = (raw, currentNamespace, ctx) => {
             elementType: null,
             transferOwnership: raw.transferOwnership,
             nullable: raw.nullable ?? false,
+            lengthParamIndex: raw.lengthParamIndex,
+            zeroTerminated: raw.zeroTerminated,
+            fixedSize: raw.fixedSize,
         });
     }
     return new GirType({
@@ -197,6 +203,9 @@ const normalizeClass = (raw, currentNamespace, ctx) => {
         glibTypeName: raw.glibTypeName,
         glibGetType: raw.glibGetType,
         cSymbolPrefix: raw.cSymbolPrefix,
+        fundamental: raw.fundamental ?? false,
+        refFunc: raw.refFunc,
+        unrefFunc: raw.unrefFunc,
         implements: implementsRefs,
         methods: raw.methods.map((m) => normalizeMethod(m, currentNamespace, ctx)),
         constructors: raw.constructors.map((c) => normalizeConstructor(c, currentNamespace, ctx)),
@@ -241,6 +250,8 @@ const normalizeRecord = (raw, currentNamespace, ctx) => {
         glibTypeName: raw.glibTypeName,
         glibGetType: raw.glibGetType,
         isGtypeStructFor: raw.isGtypeStructFor,
+        copyFunction: raw.copyFunction,
+        freeFunction: raw.freeFunction,
         fields: raw.fields.map((f) => normalizeField(f, currentNamespace, ctx)),
         methods: raw.methods.map((m) => normalizeMethod(m, currentNamespace, ctx)),
         constructors: raw.constructors.map((c) => normalizeConstructor(c, currentNamespace, ctx)),
@@ -307,6 +318,8 @@ const normalizeMethod = (raw, currentNamespace, ctx) => {
         doc: raw.doc,
         returnDoc: raw.returnDoc,
         finishFunc: raw.finishFunc,
+        shadows: raw.shadows,
+        shadowedBy: raw.shadowedBy,
     });
 };
 /**
@@ -321,6 +334,8 @@ const normalizeConstructor = (raw, currentNamespace, ctx) => {
         throws: raw.throws ?? false,
         doc: raw.doc,
         returnDoc: raw.returnDoc,
+        shadows: raw.shadows,
+        shadowedBy: raw.shadowedBy,
     });
 };
 /**
@@ -335,6 +350,8 @@ const normalizeFunction = (raw, currentNamespace, ctx) => {
         throws: raw.throws ?? false,
         doc: raw.doc,
         returnDoc: raw.returnDoc,
+        shadows: raw.shadows,
+        shadowedBy: raw.shadowedBy,
     });
 };
 /**

package/dist/internal/parser.js

@@ -122,6 +122,9 @@ export class RawGirParser {
             glibTypeName: cls["@_glib:type-name"] ? String(cls["@_glib:type-name"]) : undefined,
             glibGetType: cls["@_glib:get-type"] ? String(cls["@_glib:get-type"]) : undefined,
             cSymbolPrefix: cls["@_c:symbol-prefix"] ? String(cls["@_c:symbol-prefix"]) : undefined,
+            fundamental: cls["@_glib:fundamental"] === "1",
+            refFunc: cls["@_glib:ref-func"] ? String(cls["@_glib:ref-func"]) : undefined,
+            unrefFunc: cls["@_glib:unref-func"] ? String(cls["@_glib:unref-func"]) : undefined,
             implements: this.parseImplements(cls.implements),
             methods: this.parseMethods(ensureArray(cls.method)),
             constructors: this.parseConstructors(ensureArray(cls.constructor)),
@@ -167,6 +170,8 @@ export class RawGirParser {
             .map((method) => {
             const returnValue = method["return-value"];
             const finishFunc = method["@_glib:finish-func"];
+            const shadows = method["@_shadows"];
+            const shadowedBy = method["@_shadowed-by"];
             return {
                 name: String(method["@_name"] ?? ""),
                 cIdentifier: String(method["@_c:identifier"] ?? ""),
@@ -178,6 +183,8 @@ export class RawGirParser {
                 doc: extractDoc(method),
                 returnDoc: returnValue ? extractDoc(returnValue) : undefined,
                 finishFunc: finishFunc || undefined,
+                shadows: shadows || undefined,
+                shadowedBy: shadowedBy || undefined,
             };
         });
     }
@@ -189,6 +196,8 @@ export class RawGirParser {
             .filter((ctor) => ctor["@_introspectable"] !== "0")
             .map((ctor) => {
             const returnValue = ctor["return-value"];
+            const shadows = ctor["@_shadows"];
+            const shadowedBy = ctor["@_shadowed-by"];
             return {
                 name: String(ctor["@_name"] ?? ""),
                 cIdentifier: String(ctor["@_c:identifier"] ?? ""),
@@ -199,6 +208,8 @@ export class RawGirParser {
                 throws: ctor["@_throws"] === "1",
                 doc: extractDoc(ctor),
                 returnDoc: returnValue ? extractDoc(returnValue) : undefined,
+                shadows: shadows || undefined,
+                shadowedBy: shadowedBy || undefined,
             };
         });
     }
@@ -210,6 +221,8 @@ export class RawGirParser {
             .filter((func) => func["@_introspectable"] !== "0")
             .map((func) => {
             const returnValue = func["return-value"];
+            const shadows = func["@_shadows"];
+            const shadowedBy = func["@_shadowed-by"];
             return {
                 name: String(func["@_name"] ?? ""),
                 cIdentifier: String(func["@_c:identifier"] ?? ""),
@@ -220,6 +233,8 @@ export class RawGirParser {
                 throws: func["@_throws"] === "1",
                 doc: extractDoc(func),
                 returnDoc: returnValue ? extractDoc(returnValue) : undefined,
+                shadows: shadows || undefined,
+                shadowedBy: shadowedBy || undefined,
             };
         });
     }
@@ -283,10 +298,16 @@ export class RawGirParser {
             typeNode["@_fixed-size"] !== undefined ||
             typeNode["@_length"] !== undefined;
         if (isArrayNode) {
+            const lengthAttr = typeNode["@_length"];
+            const zeroTerminatedAttr = typeNode["@_zero-terminated"];
+            const fixedSizeAttr = typeNode["@_fixed-size"];
             return {
                 name: "array",
                 isArray: true,
                 elementType: typeNode.type ? this.parseType(typeNode.type) : undefined,
+                lengthParamIndex: lengthAttr !== undefined ? Number(lengthAttr) : undefined,
+                zeroTerminated: zeroTerminatedAttr !== undefined ? zeroTerminatedAttr !== "0" : undefined,
+                fixedSize: fixedSizeAttr !== undefined ? Number(fixedSizeAttr) : undefined,
             };
         }
         return { name: "void" };
@@ -391,6 +412,8 @@ export class RawGirParser {
             isGtypeStructFor: record["@_glib:is-gtype-struct-for"]
                 ? String(record["@_glib:is-gtype-struct-for"])
                 : undefined,
+            copyFunction: record["@_copy-function"] ? String(record["@_copy-function"]) : undefined,
+            freeFunction: record["@_free-function"] ? String(record["@_free-function"]) : undefined,
             fields: this.parseFields(ensureArray(record.field)),
             methods: this.parseMethods(ensureArray(record.method)),
             constructors: this.parseConstructors(ensureArray(record.constructor)),

package/dist/internal/raw-types.d.ts

@@ -73,6 +73,9 @@ export type RawClass = {
     glibTypeName?: string;
     glibGetType?: string;
     cSymbolPrefix?: string;
+    fundamental?: boolean;
+    refFunc?: string;
+    unrefFunc?: string;
     implements: string[];
     methods: RawMethod[];
     constructors: RawConstructor[];
@@ -92,6 +95,8 @@ export type RawRecord = {
     glibTypeName?: string;
     glibGetType?: string;
     isGtypeStructFor?: string;
+    copyFunction?: string;
+    freeFunction?: string;
     fields: RawField[];
     methods: RawMethod[];
     constructors: RawConstructor[];
@@ -122,6 +127,8 @@ export type RawMethod = {
     returnDoc?: string;
     /** For async methods, the name of the corresponding finish function */
     finishFunc?: string;
+    shadows?: string;
+    shadowedBy?: string;
 };
 /**
  * A constructor for a class or record.
@@ -134,6 +141,8 @@ export type RawConstructor = {
     throws?: boolean;
     doc?: string;
     returnDoc?: string;
+    shadows?: string;
+    shadowedBy?: string;
 };
 /**
  * A standalone function or static method.
@@ -146,6 +155,8 @@ export type RawFunction = {
     throws?: boolean;
     doc?: string;
     returnDoc?: string;
+    shadows?: string;
+    shadowedBy?: string;
 };
 /**
  * A parameter to a function, method, or callback.
@@ -178,6 +189,9 @@ export type RawType = {
     containerType?: ContainerType;
     transferOwnership?: "none" | "full" | "container";
     nullable?: boolean;
+    lengthParamIndex?: number;
+    zeroTerminated?: boolean;
+    fixedSize?: number;
 };
 /**
  * A GObject property definition.

package/dist/types.d.ts

@@ -86,6 +86,9 @@ export declare class GirClass {
     readonly glibTypeName?: string;
     readonly glibGetType?: string;
     readonly cSymbolPrefix?: string;
+    readonly fundamental: boolean;
+    readonly refFunc?: string;
+    readonly unrefFunc?: string;
     readonly implements: QualifiedName[];
     readonly methods: GirMethod[];
     readonly constructors: GirConstructor[];
@@ -104,6 +107,9 @@ export declare class GirClass {
         glibTypeName?: string;
         glibGetType?: string;
         cSymbolPrefix?: string;
+        fundamental?: boolean;
+        refFunc?: string;
+        unrefFunc?: string;
         implements: QualifiedName[];
         methods: GirMethod[];
         constructors: GirConstructor[];
@@ -148,6 +154,8 @@ export declare class GirClass {
     isAbstract(): boolean;
     /** True if this has a GType (most GObject classes do). */
     hasGType(): boolean;
+    /** True if this is a fundamental type with custom ref/unref functions. */
+    isFundamental(): boolean;
     /** Gets direct subclasses of this class. */
     getDirectSubclasses(): GirClass[];
 }
@@ -202,6 +210,8 @@ export declare class GirRecord {
     readonly glibTypeName?: string;
     readonly glibGetType?: string;
     readonly isGtypeStructFor?: string;
+    readonly copyFunction?: string;
+    readonly freeFunction?: string;
     readonly fields: GirField[];
     readonly methods: GirMethod[];
     readonly constructors: GirConstructor[];
@@ -216,12 +226,16 @@ export declare class GirRecord {
         glibTypeName?: string;
         glibGetType?: string;
         isGtypeStructFor?: string;
+        copyFunction?: string;
+        freeFunction?: string;
         fields: GirField[];
         methods: GirMethod[];
         constructors: GirConstructor[];
         staticFunctions: GirFunction[];
         doc?: string;
     });
+    /** True if this is a fundamental type with custom copy/free functions. */
+    isFundamental(): boolean;
     /** True if this is a GLib boxed type (has glibTypeName). */
     isBoxed(): boolean;
     /** True if this is a GType struct (vtable for a class/interface). */
@@ -326,6 +340,8 @@ export declare class GirMethod {
     readonly returnDoc?: string;
     /** For async methods, the name of the corresponding finish function */
     readonly finishFunc?: string;
+    readonly shadows?: string;
+    readonly shadowedBy?: string;
     constructor(data: {
         name: string;
         cIdentifier: string;
@@ -335,6 +351,8 @@ export declare class GirMethod {
         doc?: string;
         returnDoc?: string;
         finishFunc?: string;
+        shadows?: string;
+        shadowedBy?: string;
     });
     /** True if this follows the async/finish pattern. */
     isAsync(): boolean;
@@ -362,6 +380,8 @@ export declare class GirConstructor {
     readonly throws: boolean;
     readonly doc?: string;
     readonly returnDoc?: string;
+    readonly shadows?: string;
+    readonly shadowedBy?: string;
     constructor(data: {
         name: string;
         cIdentifier: string;
@@ -370,6 +390,8 @@ export declare class GirConstructor {
         throws: boolean;
         doc?: string;
         returnDoc?: string;
+        shadows?: string;
+        shadowedBy?: string;
     });
     /** Gets required (non-optional, non-nullable) parameters. */
     getRequiredParameters(): GirParameter[];
@@ -385,6 +407,8 @@ export declare class GirFunction {
     readonly throws: boolean;
     readonly doc?: string;
     readonly returnDoc?: string;
+    readonly shadows?: string;
+    readonly shadowedBy?: string;
     constructor(data: {
         name: string;
         cIdentifier: string;
@@ -393,6 +417,8 @@ export declare class GirFunction {
         throws: boolean;
         doc?: string;
         returnDoc?: string;
+        shadows?: string;
+        shadowedBy?: string;
     });
     /** True if this follows the async/finish pattern. */
     isAsync(): boolean;
@@ -524,6 +550,9 @@ export declare class GirType {
     readonly containerType?: ContainerType;
     readonly transferOwnership?: "none" | "full" | "container";
     readonly nullable: boolean;
+    readonly lengthParamIndex?: number;
+    readonly zeroTerminated?: boolean;
+    readonly fixedSize?: number;
     constructor(data: {
         name: QualifiedName | string;
         cType?: string;
@@ -533,6 +562,9 @@ export declare class GirType {
         containerType?: ContainerType;
         transferOwnership?: "none" | "full" | "container";
         nullable: boolean;
+        lengthParamIndex?: number;
+        zeroTerminated?: boolean;
+        fixedSize?: number;
     });
     /** True if this is an intrinsic/primitive type. */
     isIntrinsic(): boolean;

package/dist/types.js

@@ -66,6 +66,9 @@ export class GirClass {
     glibTypeName;
     glibGetType;
     cSymbolPrefix;
+    fundamental;
+    refFunc;
+    unrefFunc;
     implements;
     methods;
     constructors;
@@ -84,6 +87,9 @@ export class GirClass {
         this.glibTypeName = data.glibTypeName;
         this.glibGetType = data.glibGetType;
         this.cSymbolPrefix = data.cSymbolPrefix;
+        this.fundamental = data.fundamental ?? false;
+        this.refFunc = data.refFunc;
+        this.unrefFunc = data.unrefFunc;
         this.implements = data.implements;
         this.methods = data.methods;
         this.constructors = data.constructors;
@@ -215,6 +221,10 @@ export class GirClass {
     hasGType() {
         return this.glibTypeName !== undefined;
     }
+    /** True if this is a fundamental type with custom ref/unref functions. */
+    isFundamental() {
+        return this.fundamental && this.refFunc !== undefined && this.unrefFunc !== undefined;
+    }
     /** Gets direct subclasses of this class. */
     getDirectSubclasses() {
         if (!this._repo)
@@ -305,6 +315,8 @@ export class GirRecord {
     glibTypeName;
     glibGetType;
     isGtypeStructFor;
+    copyFunction;
+    freeFunction;
     fields;
     methods;
     constructors;
@@ -319,12 +331,18 @@ export class GirRecord {
         this.glibTypeName = data.glibTypeName;
         this.glibGetType = data.glibGetType;
         this.isGtypeStructFor = data.isGtypeStructFor;
+        this.copyFunction = data.copyFunction;
+        this.freeFunction = data.freeFunction;
         this.fields = data.fields;
         this.methods = data.methods;
         this.constructors = data.constructors;
         this.staticFunctions = data.staticFunctions;
         this.doc = data.doc;
     }
+    /** True if this is a fundamental type with custom copy/free functions. */
+    isFundamental() {
+        return this.copyFunction !== undefined && this.freeFunction !== undefined;
+    }
     /** True if this is a GLib boxed type (has glibTypeName). */
     isBoxed() {
         return this.glibTypeName !== undefined;
@@ -449,6 +467,8 @@ export class GirMethod {
     returnDoc;
     /** For async methods, the name of the corresponding finish function */
     finishFunc;
+    shadows;
+    shadowedBy;
     constructor(data) {
         this.name = data.name;
         this.cIdentifier = data.cIdentifier;
@@ -458,6 +478,8 @@ export class GirMethod {
         this.doc = data.doc;
         this.returnDoc = data.returnDoc;
         this.finishFunc = data.finishFunc;
+        this.shadows = data.shadows;
+        this.shadowedBy = data.shadowedBy;
     }
     /** True if this follows the async/finish pattern. */
     isAsync() {
@@ -502,6 +524,8 @@ export class GirConstructor {
     throws;
     doc;
     returnDoc;
+    shadows;
+    shadowedBy;
     constructor(data) {
         this.name = data.name;
         this.cIdentifier = data.cIdentifier;
@@ -510,6 +534,8 @@ export class GirConstructor {
         this.throws = data.throws;
         this.doc = data.doc;
         this.returnDoc = data.returnDoc;
+        this.shadows = data.shadows;
+        this.shadowedBy = data.shadowedBy;
     }
     /** Gets required (non-optional, non-nullable) parameters. */
     getRequiredParameters() {
@@ -527,6 +553,8 @@ export class GirFunction {
     throws;
     doc;
     returnDoc;
+    shadows;
+    shadowedBy;
     constructor(data) {
         this.name = data.name;
         this.cIdentifier = data.cIdentifier;
@@ -535,6 +563,8 @@ export class GirFunction {
         this.throws = data.throws;
         this.doc = data.doc;
         this.returnDoc = data.returnDoc;
+        this.shadows = data.shadows;
+        this.shadowedBy = data.shadowedBy;
     }
     /** True if this follows the async/finish pattern. */
     isAsync() {
@@ -692,6 +722,9 @@ export class GirType {
     containerType;
     transferOwnership;
     nullable;
+    lengthParamIndex;
+    zeroTerminated;
+    fixedSize;
     constructor(data) {
         this.name = data.name;
         this.cType = data.cType;
@@ -701,6 +734,9 @@ export class GirType {
         this.containerType = data.containerType;
         this.transferOwnership = data.transferOwnership;
         this.nullable = data.nullable;
+        this.lengthParamIndex = data.lengthParamIndex;
+        this.zeroTerminated = data.zeroTerminated;
+        this.fixedSize = data.fixedSize;
     }
     /** True if this is an intrinsic/primitive type. */
     isIntrinsic() {

package/package.json

@@ -1,14 +1,16 @@
 {
   "name": "@gtkx/gir",
-  "version": "0.11.0",
+  "version": "0.11.2",
   "description": "GObject Introspection file parser for GTKX",
   "keywords": [
+    "gtkx",
     "gtk",
     "gtk4",
     "gir",
     "gobject",
     "introspection",
-    "parser"
+    "parser",
+    "typescript"
   ],
   "homepage": "https://eugeniodepalo.github.io/gtkx",
   "bugs": {