@ts-for-gir/lib 3.3.0 → 4.0.0-beta.10

package/lib/gir-module.d.ts

@@ -1,58 +1,57 @@
 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 { LibraryVersion } from './library-version.js';
-import type { Dependency, GirRepository, GirNamespace, GirAliasElement, GirFunctionElement, GirType, GirCallableParamElement, GirCallableReturn, GirConstantElement, GirFieldElement, GirPropertyElement, InheritanceTable, ParsedGir, GenerateConfig, ClassParent } from './types/index.js';
+import type { Dependency, GirConstantElement, TsDocTag, OptionsGeneration } from './types/index.js';
+import { GirNSMember } from './gir.js';
+import { IntrospectedAlias } from './gir/alias.js';
+import { IntrospectedNamespaceMember } from './gir/base.js';
+import { IntrospectedBaseClass } from './gir/class.js';
+import { IntrospectedEnum } from './gir/enum.js';
+import { IntrospectedFunction, IntrospectedFunctionParameter, IntrospectedClassFunction } from './gir/function.js';
+import { NSRegistry } from './gir/registry.js';
+import { GirVisitor } from './visitor.js';
 export declare class GirModule {
-    private readonly config;
-    /**
-     * Array of all gir modules
-     */
-    static allGirModules: GirModule[];
+    readonly dependency: Dependency;
     /**
      * E.g. 'Gtk'
      */
-    namespace: string;
+    get namespace(): string;
     /**
      * E.g. '4.0'
      */
-    version: string;
+    get version(): string;
     /**
      * E.g. 'Gtk-4.0'
      */
-    packageName: string;
+    get packageName(): string;
     /**
      * E.g. 'Gtk40'
      * Is used in the generated index.d.ts, for example: `import * as Gtk40 from "./Gtk-4.0.js";`
      */
-    importNamespace: string;
-    importName: string;
+    get importNamespace(): string;
+    /**
+     * The NPM package name E.g. 'gtk-4.0'
+     */
+    get importName(): string;
+    /**
+     * Import path for the package E.g. './Gtk-4.0.js' or '@girs/Gtk-4.0'
+     */
+    get importPath(): string;
+    prefixes: string[];
     /**
      * The version of the library as an object.
      * E.g. `{ major: 4, minor: 0, patch: 0 }` or as string `4.0.0`'
      */
-    libraryVersion: LibraryVersion;
-    dependencies: Dependency[];
-    private _transitiveDependencies;
-    set transitiveDependencies(deps: Dependency[]);
+    get libraryVersion(): LibraryVersion;
+    protected _dependencies: Dependency[] | null;
+    protected _transitiveDependencies: Dependency[] | null;
+    get dependencies(): 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.
@@ -61,218 +60,47 @@ export declare class GirModule {
     constNames: {
         [varName: string]: GirConstantElement;
     };
-    constructor(xml: ParsedGir, config: GenerateConfig);
+    readonly c_prefixes: string[];
+    private _members?;
+    private _enum_constants?;
+    private _resolve_names;
+    __dts__references?: string[];
+    package_version: readonly [string, string] | readonly [string, string, string];
+    parent: NSRegistry;
+    config: OptionsGeneration;
+    constructor(dependency: Dependency, prefixes: string[], config: OptionsGeneration);
+    initDependencies(): Promise<void>;
+    initTransitiveDependencies(transitiveDependencies: Dependency[]): Promise<void>;
+    get ns(): this;
     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;
-    /**
-     * Checks if the property is readonly.
-     * @param girCallback
-     */
-    private typeIsReadonly;
-    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;
-    /**
-     * Create a clone object of a property with the name in upper camel case
-     * See github.com/gjsify/ts-for-gir/issues/138
-     * @param girProperty
-     * @returns
-     */
-    private clonePropertyForUnderscores;
-    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(girModules: GirModule[]): void;
+    getTsDocReturnTags(girElement?: IntrospectedFunction | IntrospectedClassFunction): TsDocTag[];
+    getTsDocInParamTags(inParams?: IntrospectedFunctionParameter[]): TsDocTag[];
+    registerResolveName(resolveName: string, namespace: string, name: string): void;
+    get members(): Map<string, GirNSMember | GirNSMember[]>;
+    get enum_constants(): Map<string, readonly [string, string]>;
+    accept(visitor: GirVisitor): this;
+    getImportsForCPrefix(c_prefix: string): GirModule[];
+    hasImport(name: string): boolean;
+    private _getImport;
+    getInstalledImport(_namespace: string): GirModule | null;
+    assertInstalledImport(_namespace: string): GirModule;
+    getMembers(name: string): IntrospectedNamespaceMember[];
+    getMemberWithoutOverrides(name: string): GirNSMember | null | undefined;
+    assertClass(name: string): IntrospectedBaseClass;
+    getClass(name: string): IntrospectedBaseClass | null;
+    getEnum(name: string): IntrospectedEnum | null;
+    getAlias(name: string): IntrospectedAlias | null;
+    hasSymbol(name: string): boolean;
+    resolveSymbolFromTypeName(name: string): string | null;
+    findClassCallback(name: string): [string | null, string];
+    /**
+     * This is an internal method to add TypeScript <reference>
+     * comments when overrides use parts of the TypeScript standard
+     * libraries that are newer than default.
+     */
+    ___dts___addReference(reference: string): void;
+    static load(dependency: Dependency, config: OptionsGeneration, registry: NSRegistry): Promise<GirModule>;
+    /** Start to parse all the data from the XML we need for the typescript generation */
+    parse(): void;
 }
+export declare function promisifyNamespaceFunctions(namespace: GirModule): void;