@ts-for-gir/lib 3.0.0-beta.11

package/lib/gir-factory.js

@@ -0,0 +1,376 @@
+import { GENERIC_NAMES } from './constants.js';
+/**
+ * Creates new gir and ts objects
+ */
+export class GirFactory {
+    newGenerics(generics) {
+        const tsGenerics = [];
+        for (let i = 0; i < generics.length; i++) {
+            const generic = generics[i];
+            const tsGeneric = {
+                name: generic.name || GENERIC_NAMES[i],
+                ...generic,
+            };
+            tsGenerics.push(tsGeneric);
+        }
+        return tsGenerics;
+    }
+    girTypeNameToTsTypeName(girTypeName, isStatic) {
+        switch (girTypeName) {
+            case 'alias':
+                return 'type';
+            case 'enum':
+            case 'bitfield':
+                return 'enum';
+            case 'enum-member':
+            case 'bitfield-member':
+                return 'enum-member';
+            case 'callback':
+                return 'interface';
+            case 'class':
+            case 'interface':
+            case 'union':
+            case 'record':
+                return 'class';
+            case 'constant':
+                return 'constant';
+            case 'constructor':
+                return 'constructor';
+            case 'method':
+            case 'virtual':
+                return 'method';
+            case 'signal':
+                return 'event-methods';
+            case 'static-function':
+                return 'static-function';
+            case 'function':
+                if (typeof isStatic === 'undefined') {
+                    throw new Error('You must specify if the function is static or not if you want to convert the type of a function!');
+                }
+                if (isStatic) {
+                    return 'static-function';
+                }
+                return 'function';
+            case 'field':
+            case 'property':
+                if (typeof isStatic === 'undefined') {
+                    throw new Error('You must specify if the property is static or not if you want to convert the type of a function!');
+                }
+                if (isStatic) {
+                    return 'static-property';
+                }
+                return 'property';
+        }
+        throw new Error(`Unknown gir type: "${String(girTypeName)}"!`);
+    }
+    newGirFunctions(injectFunctions, parent, overrideToAll = {}) {
+        const girFunctionElements = [];
+        for (let injectFunction of injectFunctions) {
+            injectFunction = { ...injectFunction, ...overrideToAll };
+            girFunctionElements.push(this.newGirFunction(injectFunction, parent));
+        }
+        return girFunctionElements;
+    }
+    newGirFunction(tsData, parent) {
+        const _tsData = this.newTsFunction(tsData, parent);
+        return {
+            $: this.newGirAttr(_tsData.name),
+            ...this.newGirDocElement(),
+            _tsData,
+        };
+    }
+    newGirCallableParamElement(tsData, parent) {
+        return {
+            $: this.newGirAttr(),
+            ...this.newGirDocElement(),
+            _tsData: this.newTsParameter(tsData, parent),
+        };
+    }
+    newGirCallableParamElements(injectionParams = [], parent) {
+        const result = [];
+        for (const injectionParam of injectionParams) {
+            result.push(this.newGirCallableParamElement(injectionParam, parent));
+        }
+        return result;
+    }
+    newGirInstanceParameter(data) {
+        const tsData = data._tsData
+            ? data._tsData
+            : data;
+        return {
+            $: this.newGirAttr(),
+            ...this.newGirDocElement(),
+            _tsData: tsData,
+        };
+    }
+    newGirInstanceParameters(injectionInstanceParams = []) {
+        const result = [];
+        for (const injectionInstanceParam of injectionInstanceParams) {
+            result.push(this.newGirInstanceParameter(injectionInstanceParam));
+        }
+        return result;
+    }
+    newGirProperty(tsData) {
+        const _tsData = this.newTsProperty(tsData);
+        if (!_tsData.name)
+            throw new Error('The name property is required!');
+        return {
+            $: {
+                ...this.newGirAttr(_tsData.name),
+            },
+            annotation: [],
+            ...this.newGirDocElement(),
+            _tsData,
+        };
+    }
+    newGirProperties(InjectionProps, overrideToAll = {}) {
+        const result = [];
+        for (const InjectionProp of InjectionProps) {
+            result.push(this.newGirProperty({ ...InjectionProp, ...overrideToAll }));
+        }
+        return result;
+    }
+    newTsFunction(tsData, parent) {
+        const tsFunc = {
+            ...tsData,
+            returnTypes: this.newTsTypes(tsData.returnTypes || []),
+            isArrowType: tsData.isArrowType || false,
+            isStatic: tsData.isStatic || false,
+            isGlobal: tsData.isGlobal || false,
+            isVirtual: tsData.isVirtual || false,
+            isInjected: tsData.isInjected || false,
+            retTypeIsVoid: tsData.returnTypes?.length === 1 && tsData.returnTypes[0]?.type === 'void',
+            generics: this.newGenerics(tsData.generics || []),
+            overloads: tsData.overloads || [],
+            doc: this.newTsDoc(tsData.doc),
+            tsTypeName: this.girTypeNameToTsTypeName(tsData.girTypeName, tsData.isStatic || false),
+            inParams: [],
+            outParams: [],
+            instanceParameters: [],
+            parent,
+        };
+        tsFunc.inParams.push(...this.newGirCallableParamElements(tsData.inParams, tsFunc));
+        tsFunc.outParams.push(...this.newGirCallableParamElements(tsData.outParams, tsFunc));
+        tsFunc.instanceParameters.push(...this.newGirInstanceParameters(tsData.instanceParameters));
+        return tsFunc;
+    }
+    newTsProperty(tsData) {
+        tsData.type ||= [this.newTsType()];
+        const tsProp = {
+            ...tsData,
+            readonly: tsData.readonly || false,
+            isStatic: tsData.isStatic || false,
+            isInjected: tsData.isInjected || false,
+            type: this.newTsTypes(tsData.type || []),
+            doc: this.newTsDoc(tsData.doc),
+            tsTypeName: this.girTypeNameToTsTypeName(tsData.girTypeName, tsData.isStatic || false),
+        };
+        return tsProp;
+    }
+    newTsType(tsData = {}) {
+        tsData.callbacks ||= [];
+        tsData.generics ||= [];
+        tsData.nullable ||= false;
+        tsData.optional ||= false;
+        const newTsData = {
+            type: tsData.type || 'void',
+            callbacks: tsData.callbacks || [],
+            generics: tsData.generics || [],
+            nullable: tsData.nullable || false,
+            optional: tsData.optional || false,
+            isArray: tsData.isArray || false,
+            isCallback: tsData.isCallback || false,
+            isFunction: tsData.isFunction || false,
+            leftSeparator: tsData.leftSeparator || '|',
+        };
+        return newTsData;
+    }
+    newTsTypes(tsDataArr) {
+        const types = [];
+        for (const tsData of tsDataArr) {
+            types.push(this.newTsType(tsData));
+        }
+        if (tsDataArr.length === 0) {
+            types.push(this.newTsType({}));
+        }
+        return types;
+    }
+    newTsParameter(tsData, parent) {
+        const types = [];
+        const tsTypes = tsData._tsData?.type || tsData.type || [];
+        for (const type of tsTypes) {
+            type.type = type.type || 'any';
+            types.push(this.newTsType(type));
+        }
+        const name = tsData.name || tsData._tsData?.name;
+        const isRest = tsData.isRest || tsData._tsData?.isRest || false;
+        const doc = tsData.doc || tsData._tsData?.doc;
+        if (!name)
+            throw new Error('[GirFactory.newTsParameter] The name property is required!');
+        const newTsData = {
+            type: types,
+            name: name,
+            isRest: isRest,
+            girTypeName: 'callable-param',
+            doc: this.newTsDoc(doc),
+            parent,
+        };
+        return newTsData;
+    }
+    newTsParameters(datas, parent) {
+        const tsParameters = [];
+        for (const data of datas) {
+            tsParameters.push(this.newTsParameter(data, parent));
+        }
+        return tsParameters;
+    }
+    /**
+     * Generates signal methods like `connect`, `connect_after` and `emit` on Gjs or `connect`, `on`, `once`, `off` and `emit` an node-gtk
+     * for a default gir signal element
+     * @param signalName The signal name
+     * @param callbackType The callback type
+     * @param emitInParams
+     * @param environment
+     * @param withDisconnect If `true` this also generates a `disconnect` method
+     * @returns
+     */
+    newTsSignalMethods(signalName, callbackType, emitInParams, parentClass, environment, withDisconnect = false) {
+        const tsMethods = [];
+        const girTypeName = 'signal';
+        const sigNameInParam = {
+            name: 'sigName',
+            type: [
+                this.newTsType({
+                    type: signalName ? `"${signalName}"` : 'string',
+                }),
+            ],
+            doc: this.newTsDoc(),
+        };
+        const anyArgsInParam = {
+            name: 'args',
+            isRest: true,
+            type: [
+                this.newTsType({
+                    type: `any`,
+                    isArray: true,
+                }),
+            ],
+            doc: this.newTsDoc(),
+        };
+        emitInParams.push(anyArgsInParam);
+        const callbackInParam = {
+            name: 'callback',
+            type: [
+                this.newTsType({
+                    type: callbackType || '(...args: any[]) => void',
+                }),
+            ],
+            doc: this.newTsDoc(),
+        };
+        const numberReturnType = this.newTsType({
+            type: 'number',
+        });
+        const connectTsFn = this.newTsFunction({
+            name: 'connect',
+            inParams: [sigNameInParam, callbackInParam],
+            returnTypes: [numberReturnType],
+            girTypeName,
+        }, parentClass);
+        tsMethods.push(connectTsFn);
+        if (environment === 'gjs') {
+            const connectAfterTsFn = this.newTsFunction({
+                name: 'connect_after',
+                inParams: [sigNameInParam, callbackInParam],
+                returnTypes: [numberReturnType],
+                girTypeName,
+            }, parentClass);
+            tsMethods.push(connectAfterTsFn);
+        }
+        else if (environment === 'node') {
+            const afterInParam = {
+                name: 'after',
+                type: [
+                    this.newTsType({
+                        type: 'boolean',
+                        optional: true,
+                    }),
+                ],
+                doc: this.newTsDoc(),
+            };
+            const nodeEventEmitterReturnType = this.newTsType({
+                type: 'NodeJS.EventEmitter',
+            });
+            const onTsFn = this.newTsFunction({
+                name: 'on',
+                inParams: [sigNameInParam, callbackInParam, afterInParam],
+                returnTypes: [nodeEventEmitterReturnType],
+                girTypeName,
+            }, parentClass);
+            const onceTsFn = this.newTsFunction({
+                name: 'once',
+                inParams: [sigNameInParam, callbackInParam, afterInParam],
+                returnTypes: [nodeEventEmitterReturnType],
+                girTypeName,
+            }, parentClass);
+            const offTsFn = this.newTsFunction({
+                name: 'off',
+                inParams: [sigNameInParam, callbackInParam],
+                returnTypes: [nodeEventEmitterReturnType],
+                girTypeName,
+            }, parentClass);
+            tsMethods.push(onTsFn, onceTsFn, offTsFn);
+        }
+        const emitTsFn = this.newTsFunction({
+            name: 'emit',
+            inParams: [sigNameInParam, ...emitInParams],
+            girTypeName,
+        }, parentClass);
+        tsMethods.push(emitTsFn);
+        if (withDisconnect && environment === 'gjs') {
+            const idInParam = {
+                name: 'id',
+                type: [
+                    this.newTsType({
+                        type: 'number',
+                    }),
+                ],
+                doc: this.newTsDoc(),
+            };
+            const emitTsFn = this.newTsFunction({
+                name: 'disconnect',
+                inParams: [idInParam],
+                girTypeName,
+            }, parentClass);
+            tsMethods.push(emitTsFn);
+        }
+        return tsMethods;
+    }
+    newGirAttr(name = '') {
+        return {
+            name,
+            'glib:set-property': '',
+            'glib:get-property': '',
+        };
+    }
+    newGirAnnotation(data = {}) {
+        data.name ||= '';
+        data.value ||= [];
+        return {
+            $: data,
+        };
+    }
+    newGirDocElement(text = '', filename = '', line = '', column = '') {
+        return {
+            doc: [{ $: { filename, line, column }, _: text }],
+            'doc-deprecated': [{ $: {}, _: '' }],
+            'source-position': [{ filename: '', line: '', column: [''] }],
+        };
+    }
+    newTsDoc(data = {}) {
+        return {
+            tags: data.tags || [],
+            text: data.text || '',
+        };
+    }
+}
+//# sourceMappingURL=gir-factory.js.map

package/lib/gir-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gir-factory.js","sourceRoot":"","sources":["../src/gir-factory.ts"],"names":[],"mappings":"AAoCA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAE9C;;GAEG;AACH,MAAM,OAAO,UAAU;IACnB,WAAW,CAAC,QAAqC;QAC7C,MAAM,UAAU,GAAyB,EAAE,CAAA;QAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACtC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;YAC3B,MAAM,SAAS,GAAuB;gBAClC,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,aAAa,CAAC,CAAC,CAAC;gBACtC,GAAG,OAAO;aACb,CAAA;YACD,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;SAC7B;QACD,OAAO,UAAU,CAAA;IACrB,CAAC;IAkBD,uBAAuB,CAAC,WAA2B,EAAE,QAAiB;QAClE,QAAQ,WAAW,EAAE;YACjB,KAAK,OAAO;gBACR,OAAO,MAAM,CAAA;YACjB,KAAK,MAAM,CAAC;YACZ,KAAK,UAAU;gBACX,OAAO,MAAM,CAAA;YACjB,KAAK,aAAa,CAAC;YACnB,KAAK,iBAAiB;gBAClB,OAAO,aAAa,CAAA;YACxB,KAAK,UAAU;gBACX,OAAO,WAAW,CAAA;YACtB,KAAK,OAAO,CAAC;YACb,KAAK,WAAW,CAAC;YACjB,KAAK,OAAO,CAAC;YACb,KAAK,QAAQ;gBACT,OAAO,OAAO,CAAA;YAClB,KAAK,UAAU;gBACX,OAAO,UAAU,CAAA;YACrB,KAAK,aAAa;gBACd,OAAO,aAAa,CAAA;YACxB,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS;gBACV,OAAO,QAAQ,CAAA;YACnB,KAAK,QAAQ;gBACT,OAAO,eAAe,CAAA;YAC1B,KAAK,iBAAiB;gBAClB,OAAO,iBAAiB,CAAA;YAC5B,KAAK,UAAU;gBACX,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE;oBACjC,MAAM,IAAI,KAAK,CACX,kGAAkG,CACrG,CAAA;iBACJ;gBACD,IAAI,QAAQ,EAAE;oBACV,OAAO,iBAAiB,CAAA;iBAC3B;gBACD,OAAO,UAAU,CAAA;YACrB,KAAK,OAAO,CAAC;YACb,KAAK,UAAU;gBACX,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE;oBACjC,MAAM,IAAI,KAAK,CACX,kGAAkG,CACrG,CAAA;iBACJ;gBACD,IAAI,QAAQ,EAAE;oBACV,OAAO,iBAAiB,CAAA;iBAC3B;gBACD,OAAO,UAAU,CAAA;SACxB;QACD,MAAM,IAAI,KAAK,CAAC,sBAAsB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;IAClE,CAAC;IAED,eAAe,CACX,eAAoC,EACpC,MAAsB,EACtB,gBAA4C,EAAE;QAE9C,MAAM,mBAAmB,GAErB,EAAE,CAAA;QACN,KAAK,IAAI,cAAc,IAAI,eAAe,EAAE;YACxC,cAAc,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,aAAa,EAAE,CAAA;YACxD,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAA;SACxE;QACD,OAAO,mBAAmB,CAAA;IAC9B,CAAC;IAED,cAAc,CACV,MAAyB,EACzB,MAAsB;QAEtB,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAClD,OAAO;YACH,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC;YAChC,GAAG,IAAI,CAAC,gBAAgB,EAAE;YAC1B,OAAO;SACV,CAAA;IACL,CAAC;IAED,0BAA0B,CACtB,MAAoD,EACpD,MAAkB;QAElB,OAAO;YACH,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE;YACpB,GAAG,IAAI,CAAC,gBAAgB,EAAE;YAC1B,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC;SAC/C,CAAA;IACL,CAAC;IAED,2BAA2B,CACvB,kBAAuE,EAAE,EACzE,MAAkB;QAElB,MAAM,MAAM,GAA8B,EAAE,CAAA;QAC5C,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE;YAC1C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAA;SACvE;QACD,OAAO,MAAM,CAAA;IACjB,CAAC;IAED,uBAAuB,CACnB,IAA6E;QAE7E,MAAM,MAAM,GAAI,IAA6B,CAAC,OAAO;YACjD,CAAC,CAAE,IAA6B,CAAC,OAAO;YACxC,CAAC,CAAE,IAAyD,CAAA;QAEhE,OAAO;YACH,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE;YACpB,GAAG,IAAI,CAAC,gBAAgB,EAAE;YAC1B,OAAO,EAAE,MAAM;SAClB,CAAA;IACL,CAAC;IAED,wBAAwB,CACpB,0BAAoF,EAAE;QAEtF,MAAM,MAAM,GAA2B,EAAE,CAAA;QACzC,KAAK,MAAM,sBAAsB,IAAI,uBAAuB,EAAE;YAC1D,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,sBAAsB,CAAC,CAAC,CAAA;SACpE;QACD,OAAO,MAAM,CAAA;IACjB,CAAC;IAED,cAAc,CAAC,MAAyB;QACpC,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;QAC1C,IAAI,CAAC,OAAO,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;QACpE,OAAO;YACH,CAAC,EAAE;gBACC,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC;aACnC;YACD,UAAU,EAAE,EAAE;YACd,GAAG,IAAI,CAAC,gBAAgB,EAAE;YAC1B,OAAO;SACV,CAAA;IACL,CAAC;IAED,gBAAgB,CACZ,cAAmC,EACnC,gBAA4C,EAAE;QAE9C,MAAM,MAAM,GAAyB,EAAE,CAAA;QACvC,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE;YACxC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,GAAG,aAAa,EAAE,GAAG,aAAa,EAAE,CAAC,CAAC,CAAA;SAC3E;QACD,OAAO,MAAM,CAAA;IACjB,CAAC;IAED,aAAa,CAAC,MAAyB,EAAE,MAAsB;QAC3D,MAAM,MAAM,GAA0B;YAClC,GAAG,MAAM;YACT,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC;YACtD,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,KAAK;YACxC,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,KAAK;YAClC,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,KAAK;YAClC,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,KAAK;YACpC,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,KAAK;YACtC,aAAa,EAAE,MAAM,CAAC,WAAW,EAAE,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,MAAM;YACzF,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC;YACjD,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,EAAE;YACjC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC;YAC9B,UAAU,EAAE,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,QAAQ,IAAI,KAAK,CAAC;YACtF,QAAQ,EAAE,EAAE;YACZ,SAAS,EAAE,EAAE;YACb,kBAAkB,EAAE,EAAE;YACtB,MAAM;SACT,CAAA;QAED,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,2BAA2B,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAA;QAClF,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,2BAA2B,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAA;QACpF,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAA;QAE3F,OAAO,MAAM,CAAA;IACjB,CAAC;IAED,aAAa,CAAC,MAAyB;QACnC,MAAM,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;QAClC,MAAM,MAAM,GAAe;YACvB,GAAG,MAAM;YACT,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,KAAK;YAClC,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,KAAK;YAClC,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,KAAK;YACtC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC;YAC9B,UAAU,EAAE,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,QAAQ,IAAI,KAAK,CAAC;SACzF,CAAA;QACD,OAAO,MAAM,CAAA;IACjB,CAAC;IAED,SAAS,CAAC,SAAwB,EAAE;QAChC,MAAM,CAAC,SAAS,KAAK,EAAE,CAAA;QACvB,MAAM,CAAC,QAAQ,KAAK,EAAE,CAAA;QACtB,MAAM,CAAC,QAAQ,KAAK,KAAK,CAAA;QACzB,MAAM,CAAC,QAAQ,KAAK,KAAK,CAAA;QAEzB,MAAM,SAAS,GAAW;YACtB,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,MAAM;YAC3B,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,EAAE;YACjC,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,EAAE;YAC/B,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,KAAK;YAClC,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,KAAK;YAClC,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,KAAK;YAChC,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,KAAK;YACtC,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,KAAK;YACtC,aAAa,EAAE,MAAM,CAAC,aAAa,IAAI,GAAG;SAC7C,CAAA;QAED,OAAO,SAAS,CAAA;IACpB,CAAC;IAED,UAAU,CAAC,SAA0B;QACjC,MAAM,KAAK,GAAa,EAAE,CAAA;QAC1B,KAAK,MAAM,MAAM,IAAI,SAAS,EAAE;YAC5B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAA;SACrC;QAED,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;YACxB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAA;SACjC;QAED,OAAO,KAAK,CAAA;IAChB,CAAC;IAED,cAAc,CAAC,MAAoD,EAAE,MAAkB;QACnF,MAAM,KAAK,GAAa,EAAE,CAAA;QAC1B,MAAM,OAAO,GAAI,MAAkC,CAAC,OAAO,EAAE,IAAI,IAAK,MAA6B,CAAC,IAAI,IAAI,EAAE,CAAA;QAC9G,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE;YACxB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,KAAK,CAAA;YAC9B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;SACnC;QAED,MAAM,IAAI,GAAI,MAA6B,CAAC,IAAI,IAAK,MAAkC,CAAC,OAAO,EAAE,IAAI,CAAA;QACrG,MAAM,MAAM,GACP,MAA6B,CAAC,MAAM,IAAK,MAAkC,CAAC,OAAO,EAAE,MAAM,IAAI,KAAK,CAAA;QACzG,MAAM,GAAG,GAAI,MAA6B,CAAC,GAAG,IAAK,MAAkC,CAAC,OAAO,EAAE,GAAG,CAAA;QAElG,IAAI,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAA;QAExF,MAAM,SAAS,GAAgB;YAC3B,IAAI,EAAE,KAAK;YACX,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,WAAW,EAAE,gBAAgB;YAC7B,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YACvB,MAAM;SACT,CAAA;QAED,OAAO,SAAS,CAAA;IACpB,CAAC;IAED,eAAe,CAAC,KAA0D,EAAE,MAAkB;QAC1F,MAAM,YAAY,GAAkB,EAAE,CAAA;QACtC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACtB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;SACvD;QACD,OAAO,YAAY,CAAA;IACvB,CAAC;IAED;;;;;;;;;OASG;IACH,kBAAkB,CACd,UAA8B,EAC9B,YAAgC,EAChC,YAAkC,EAClC,WAAoB,EACpB,WAAwB,EACxB,cAAc,GAAG,KAAK;QAEtB,MAAM,SAAS,GAAe,EAAE,CAAA;QAChC,MAAM,WAAW,GAAoB,QAAQ,CAAA;QAE7C,MAAM,cAAc,GAAuB;YACvC,IAAI,EAAE,SAAS;YACf,IAAI,EAAE;gBACF,IAAI,CAAC,SAAS,CAAC;oBACX,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,UAAU,GAAG,CAAC,CAAC,CAAC,QAAQ;iBAClD,CAAC;aACL;YACD,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE;SACvB,CAAA;QAED,MAAM,cAAc,GAAuB;YACvC,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,IAAI;YACZ,IAAI,EAAE;gBACF,IAAI,CAAC,SAAS,CAAC;oBACX,IAAI,EAAE,KAAK;oBACX,OAAO,EAAE,IAAI;iBAChB,CAAC;aACL;YACD,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE;SACvB,CAAA;QAED,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QAEjC,MAAM,eAAe,GAAuB;YACxC,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE;gBACF,IAAI,CAAC,SAAS,CAAC;oBACX,IAAI,EAAE,YAAY,IAAI,0BAA0B;iBACnD,CAAC;aACL;YACD,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE;SACvB,CAAA;QAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC;YACpC,IAAI,EAAE,QAAQ;SACjB,CAAC,CAAA;QAEF,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,CAClC;YACI,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,CAAC,cAAc,EAAE,eAAe,CAAC;YAC3C,WAAW,EAAE,CAAC,gBAAgB,CAAC;YAC/B,WAAW;SACd,EACD,WAAW,CACd,CAAA;QACD,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QAE3B,IAAI,WAAW,KAAK,KAAK,EAAE;YACvB,MAAM,gBAAgB,GAAG,IAAI,CAAC,aAAa,CACvC;gBACI,IAAI,EAAE,eAAe;gBACrB,QAAQ,EAAE,CAAC,cAAc,EAAE,eAAe,CAAC;gBAC3C,WAAW,EAAE,CAAC,gBAAgB,CAAC;gBAC/B,WAAW;aACd,EACD,WAAW,CACd,CAAA;YACD,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;SACnC;aAAM,IAAI,WAAW,KAAK,MAAM,EAAE;YAC/B,MAAM,YAAY,GAAuB;gBACrC,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE;oBACF,IAAI,CAAC,SAAS,CAAC;wBACX,IAAI,EAAE,SAAS;wBACf,QAAQ,EAAE,IAAI;qBACjB,CAAC;iBACL;gBACD,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE;aACvB,CAAA;YAED,MAAM,0BAA0B,GAAG,IAAI,CAAC,SAAS,CAAC;gBAC9C,IAAI,EAAE,qBAAqB;aAC9B,CAAC,CAAA;YAEF,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAC7B;gBACI,IAAI,EAAE,IAAI;gBACV,QAAQ,EAAE,CAAC,cAAc,EAAE,eAAe,EAAE,YAAY,CAAC;gBACzD,WAAW,EAAE,CAAC,0BAA0B,CAAC;gBACzC,WAAW;aACd,EACD,WAAW,CACd,CAAA;YACD,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAC/B;gBACI,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE,CAAC,cAAc,EAAE,eAAe,EAAE,YAAY,CAAC;gBACzD,WAAW,EAAE,CAAC,0BAA0B,CAAC;gBACzC,WAAW;aACd,EACD,WAAW,CACd,CAAA;YACD,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAC9B;gBACI,IAAI,EAAE,KAAK;gBACX,QAAQ,EAAE,CAAC,cAAc,EAAE,eAAe,CAAC;gBAC3C,WAAW,EAAE,CAAC,0BAA0B,CAAC;gBACzC,WAAW;aACd,EACD,WAAW,CACd,CAAA;YACD,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;SAC5C;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAC/B;YACI,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,CAAC,cAAc,EAAE,GAAG,YAAY,CAAC;YAC3C,WAAW;SACd,EACD,WAAW,CACd,CAAA;QACD,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAExB,IAAI,cAAc,IAAI,WAAW,KAAK,KAAK,EAAE;YACzC,MAAM,SAAS,GAAuB;gBAClC,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE;oBACF,IAAI,CAAC,SAAS,CAAC;wBACX,IAAI,EAAE,QAAQ;qBACjB,CAAC;iBACL;gBACD,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE;aACvB,CAAA;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAC/B;gBACI,IAAI,EAAE,YAAY;gBAClB,QAAQ,EAAE,CAAC,SAAS,CAAC;gBACrB,WAAW;aACd,EACD,WAAW,CACd,CAAA;YACD,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;SAC3B;QAED,OAAO,SAAS,CAAA;IACpB,CAAC;IAED,UAAU,CACN,IAAI,GAAG,EAAE;QAET,OAAO;YACH,IAAI;YACJ,mBAAmB,EAAE,EAAE;YACvB,mBAAmB,EAAE,EAAE;SAC1B,CAAA;IACL,CAAC;IAED,gBAAgB,CAAC,OAAoC,EAAE;QACnD,IAAI,CAAC,IAAI,KAAK,EAAE,CAAA;QAChB,IAAI,CAAC,KAAK,KAAK,EAAE,CAAA;QACjB,OAAO;YACH,CAAC,EAAE,IAA0B;SAChC,CAAA;IACL,CAAC;IAED,gBAAgB,CAAC,IAAI,GAAG,EAAE,EAAE,QAAQ,GAAG,EAAE,EAAE,IAAI,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE;QAC7D,OAAO;YACH,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC;YACjD,gBAAgB,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;YACpC,iBAAiB,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;SAChE,CAAA;IACL,CAAC;IAED,QAAQ,CAAC,OAAuB,EAAE;QAC9B,OAAO;YACH,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE;YACrB,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE;SACxB,CAAA;IACL,CAAC;CACJ"}

package/lib/gir-module.d.ts

@@ -0,0 +1,259 @@
+import { Transformation } from './transformation.js';
+import { Logger } from './logger.js';
+import { Injector } from './injection/injector.js';
+import { GirFactory } from './gir-factory.js';
+import { ConflictResolver } from './conflict-resolver.js';
+import { DependencyManager } from './dependency-manager.js';
+import { SymTable } from './symtable.js';
+import type { Dependency, GirRepository, GirNamespace, GirAliasElement, GirFunctionElement, GirType, GirCallableParamElement, GirCallableReturn, GirConstantElement, GirFieldElement, GirPropertyElement, InheritanceTable, ParsedGir, GenerateConfig, ClassParent } from './types/index.js';
+export declare class GirModule {
+    private readonly config;
+    /**
+     * Array of all gir modules
+     */
+    static allGirModules: GirModule[];
+    /**
+     * E.g. 'Gtk'
+     */
+    namespace: string;
+    /**
+     * E.g. '3.0'
+     */
+    version: string;
+    /**
+     * E.g. 'Gtk-3.0'
+     */
+    packageName: string;
+    /**
+     * E.g. 'Gtk30'
+     * Is used in the generated index.d.ts, for example: `import * as Gtk30 from "./Gtk-3.0.js";`
+     */
+    importName: string;
+    dependencies: Dependency[];
+    private _transitiveDependencies;
+    set transitiveDependencies(deps: Dependency[]);
+    get transitiveDependencies(): Dependency[];
+    get allDependencies(): Dependency[];
+    repo: GirRepository;
+    ns: GirNamespace;
+    /**
+     * Used to find namespaces that are used in other modules
+     */
+    symTable: SymTable;
+    transformation: Transformation;
+    girFactory: GirFactory;
+    dependencyManager: DependencyManager;
+    conflictResolver: ConflictResolver;
+    log: Logger;
+    inject: Injector;
+    extends?: string;
+    /**
+     * To prevent constants from being exported twice, the names already exported are saved here for comparison.
+     * Please note: Such a case is only known for Zeitgeist-2.0 with the constant "ATTACHMENT"
+     */
+    constNames: {
+        [varName: string]: GirConstantElement;
+    };
+    constructor(xml: ParsedGir, config: GenerateConfig);
+    private checkTransitiveDependencies;
+    private getTsDoc;
+    private getTsDocGirElementTags;
+    private getTsDocReturnTags;
+    private getTsDocInParamTags;
+    private annotateFunctionArguments;
+    private annotateFunctionReturn;
+    /**
+     * Functions which are not part of a class
+     * @param girFuncs
+     */
+    private annotateFunctions;
+    /**
+     * Functions and methods of a class
+     */
+    private annotateMethods;
+    /**
+     * Variables which are not part of a class
+     */
+    private annotateVariables;
+    private annotateFields;
+    private annotateClass;
+    /**
+     * Annotates the custom `_module`, `_fullSymName` and `_girType` properties.
+     * Also registers the element on the `symTable`.
+     * @param girElements
+     * @param girType
+     */
+    private annotateAndRegisterGirElement;
+    /**
+     * TODO: find better name for this method
+     * @param girVar
+     * @param fullTypeName
+     * @returns e.g.
+     * ```ts
+     * {
+     *      namespace: "Gtk",
+     *      resValue: "Gtk.Widget"
+     * }
+     *
+     */
+    private fullTypeLookup;
+    /**
+     * this method needs to be refactored, an array can also be an array of an array for example
+     * @param girVar
+     * @returns
+     */
+    getArrayData(girVar: GirCallableReturn | GirAliasElement | GirFieldElement | GirCallableParamElement | GirPropertyElement | GirConstantElement): {
+        arrCType: string | undefined;
+        arrayType: GirType | null;
+        isArray: boolean;
+        overrideTypeName: string | undefined;
+    };
+    /**
+     * Get the typescript type of a GirElement like a `GirPropertyElement` or `GirCallableReturn`
+     * @param girVar
+     */
+    private getTsType;
+    /**
+     *
+     * @param girFunc
+     * @returns
+     */
+    private getReturnType;
+    private arrayLengthIndexLookup;
+    private closureDataIndexLookup;
+    private destroyDataIndexLookup;
+    private processParams;
+    /**
+     * Checks if the parameter is nullable (which results in ` | null`).
+     *
+     * @param girVar girVar to test
+     */
+    private typeIsNullable;
+    /**
+     * Checks if the parameter is optional (which results in `foo?: bar`).
+     * @param girVar girVar to test
+     */
+    private typeIsOptional;
+    private setParameterTsData;
+    private getInstanceParameterTsData;
+    private setParametersTsData;
+    private getVariableTsData;
+    private getPropertyTsData;
+    /**
+     *
+     * @param girFunc
+     * @param prefix E.g. vfunc
+     * @param overrideReturnType
+     * @param isArrowType
+     * @param indentCount
+     */
+    private getFunctionTsData;
+    overloadPromisifiedFunctions(girFunctions: GirFunctionElement[]): void;
+    private getCallbackInterfaceTsData;
+    private setCallbackTsData;
+    private getSignalCallbackInterfaceTsData;
+    private getConstructorFunctionTsData;
+    private getSignalCallbackTsData;
+    /**
+     * Generates signal methods like `connect`, `connect_after` and `emit` on Gjs or `connect`, `on`, `once`, `off` and `emit` an node-gtk
+     * for a default gir signal element
+     * @param girSignal
+     * @returns
+     */
+    private getClassSignalMethodsTsData;
+    /**
+     * Generates signal methods for the GObject properties of a gir class element
+     * @param girClass
+     */
+    private getClassPropertySignalsMethods;
+    private getGeneralSignalsMethods;
+    private setSignalTsData;
+    private fixEnumerationDuplicateIdentifier;
+    private getEnumerationMemberTsData;
+    private getEnumerationTsData;
+    private getAliasTsData;
+    private getConstantTsData;
+    private getClassConstructPropsTsData;
+    /**
+     * Some class/static methods are defined in a separate record which is not
+     * exported, but the methods are available as members of the JS constructor.
+     * In gjs one can use an instance of the object, a JS constructor or a GType
+     * as the method's instance-parameter.
+     * @see https://discourse.gnome.org/t/using-class-methods-like-gtk-widget-class-get-css-name-from-gjs/4001
+     * @param girClass
+     */
+    private getClassRecordMethods;
+    /**
+     * Instance methods
+     * @param girClass
+     * @param localNames
+     */
+    private getClassMethodsTsData;
+    private getClassFieldsTsData;
+    private getGObjectProperties;
+    private getClassPropertiesTsData;
+    private getClassNonStaticPropertyNames;
+    private getClassConstructorsTsData;
+    private getClassVirtualMethodsTsData;
+    /**
+     *
+     * @param girClass This is the class / interface the `parentClass` implements signals from
+     * @returns
+     */
+    private getClassSignalsTsData;
+    getClassParentObject(parentName: string, namespace: string, type: 'parent' | 'prerequisite' | 'implements'): ClassParent;
+    private getClassParents;
+    private setClassBaseTsData;
+    private setClassTsData;
+    private isDerivedFromGObject;
+    private getClassParent;
+    private traverseInheritanceTree;
+    private forEachInterface;
+    /**
+     *
+     * @param girElement
+     * @param localNames Can be (constructor) properties, fields or methods
+     * @param type
+     */
+    private checkOrSetLocalName;
+    private isGtypeStructFor;
+    /**
+     * E.g GObject.ObjectClass is a abstract class and required by UPowerGlib-1.0, UDisks-2.0 and others
+     * @param girClass
+     * @returns `true` if this is this a abstract class.
+     */
+    private isAbstractClass;
+    /**
+     *
+     * @param girClass
+     * @returns
+     */
+    private getOtherStaticFunctions;
+    private getStaticNewFunctions;
+    /**
+     * Static methods, <constructor> and <function>
+     * @param girClass
+     * @param constructorTypeName Used to overwrite the constructor return type
+     * @param useReference This value should be `false` for inherited and implemented classes / interfaces.
+     * Otherwise other modules would overwrite the return value of the constructor methods
+     */
+    private getClassStaticFunctionsTsData;
+    private setModuleTsData;
+    /**
+     * TODO: find better name for this method
+     * @param fullTypeName
+     * @returns
+     */
+    private fullTypeLookupWithNamespace;
+    private loadInheritance;
+    private loadTypes;
+    /**
+     * Before processing the typescript data, each module should be initialized first.
+     * This is done in the `GenerationHandler`.
+     */
+    init(inheritanceTable: InheritanceTable): void;
+    /**
+     * Start processing the typescript data
+     */
+    start(): void;
+}