@ts-for-gir/cli 3.0.0-beta.8 → 3.0.0

package/lib/gir-module.d.ts

@@ -1,256 +0,0 @@
-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 { SymTable } from './symtable.js';
-import type { GirRepository, GirNamespace, GirAliasElement, 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: string[];
-    private _transitiveDependencies;
-    set transitiveDependencies(deps: string[]);
-    get transitiveDependencies(): string[];
-    get allDependencies(): string[];
-    repo: GirRepository;
-    ns: GirNamespace;
-    /**
-     * Used to find namespaces that are used in other modules
-     */
-    symTable: SymTable;
-    transformation: Transformation;
-    girFactory: GirFactory;
-    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 loadDependencies;
-    private checkTransitiveDependencies;
-    private getTsDoc;
-    private getTsDocGirElementTags;
-    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;
-    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;
-}