@ts-for-gir/generator-typescript 4.0.0-beta.6 → 4.0.0-beta.7

package/lib/module-generator.d.ts

@@ -0,0 +1,134 @@
+import { Logger, DependencyManager, TypeExpression, NSRegistry, IntrospectedClass, IntrospectedRecord, IntrospectedInterface, IntrospectedBaseClass, IntrospectedField, GirDirection, TsDocTag, OptionsGeneration, GirModule, IntrospectedFunction, IntrospectedCallback, IntrospectedSignal, IntrospectedProperty, IntrospectedConstant, IntrospectedClassCallback, IntrospectedClassFunction, IntrospectedConstructor, IntrospectedDirectAllocationConstructor, IntrospectedFunctionParameter, IntrospectedStaticClassFunction, IntrospectedVirtualClassFunction, IntrospectedAlias, IntrospectedEnum, IntrospectedSignalType, IntrospectedEnumMember, IntrospectedError, FormatGenerator, Generic } from '@ts-for-gir/lib';
+import { TemplateProcessor } from './template-processor.js';
+import { PackageDataParser } from './package-data-parser.js';
+export declare class ModuleGenerator extends FormatGenerator<string[]> {
+    log: Logger;
+    dependencyManager: DependencyManager;
+    packageData?: PackageDataParser;
+    config: OptionsGeneration;
+    moduleTemplateProcessor: TemplateProcessor;
+    /**
+     * @param _config The config to use without the override config
+     */
+    constructor(namespace: GirModule, config: OptionsGeneration);
+    generateClassCallback(node: IntrospectedClassCallback): string[];
+    generateConstructor(node: IntrospectedConstructor): string[];
+    generateDirectAllocationConstructor(node: IntrospectedDirectAllocationConstructor): string[];
+    protected generateParameters(parameters: IntrospectedFunctionParameter[]): string;
+    generateConstructorFunction(node: IntrospectedConstructor): string[];
+    generateRecord(node: IntrospectedRecord): string[];
+    generateInterface(node: IntrospectedInterface): string[];
+    generateInterfaceNamespace(node: IntrospectedInterface): string[];
+    generateInterfaceDeclaration(node: IntrospectedInterface): string[];
+    generateError(node: IntrospectedError): string[];
+    generateSignal(node: IntrospectedSignal, type?: IntrospectedSignalType): string[];
+    generateStaticClassFunction(node: IntrospectedStaticClassFunction): string[];
+    generateVirtualClassFunction(node: IntrospectedVirtualClassFunction): string[];
+    generateExport(type: string, name: string, definition: string, indentCount?: number): string;
+    generateProperty(tsProp: IntrospectedProperty, construct?: boolean, indentCount?: number): string[];
+    generateField(tsProp: IntrospectedField, indentCount?: number): string[];
+    generateProperties(tsProps: IntrospectedProperty[], comment: string, indentCount?: number): string[];
+    generateFields(tsProps: IntrospectedField[], comment: string, indentCount?: number): string[];
+    generateMemberName(tsVar: IntrospectedProperty | IntrospectedConstant | IntrospectedField): string;
+    /**
+     * @param tsType The type expression
+     * @param namespace Provides the namespace to import relative to, defaults to the current namespace
+     * @returns A string for the type expression
+     */
+    generateType(tsType: TypeExpression): string;
+    generateDirectedType(tsType: TypeExpression, direction: GirDirection): string;
+    generateInParameters(inParams: IntrospectedFunctionParameter[]): string[];
+    /**
+     * Adds documentation comments
+     * @see https://github.com/microsoft/tsdoc
+     * @param lines
+     * @param indentCount
+     */
+    addTSDocCommentLines(lines: string[], indentCount?: number): string[];
+    /**
+     * Adds the documentation as comments
+     * @see https://github.com/microsoft/tsdoc
+     * @param girDoc
+     * @param indentCount
+     * @param overwriteDoc
+     * @returns
+     */
+    addGirDocComment(tsDoc: string | null | undefined, tags?: TsDocTag[], indentCount?: number): string[];
+    /**
+     * Adds an info comment, is used for debugging the generated types
+     * @param comment
+     * @param indentCount
+     * @returns
+     */
+    addInfoComment(comment?: string, indentCount?: number): string[];
+    mergeDescs(descs: string[], comment?: string, indentCount?: number): string[];
+    generateParameter(tsParam: IntrospectedFunctionParameter): string[];
+    /**
+     *
+     * @param tsGenerics
+     * @param isOut If this generic parameters are out do only generate the type parameter names
+     * @returns
+     */
+    generateGenericParameters(nodes: Generic[], withDefaults?: boolean): string;
+    generateFunctionReturn(tsFunction: IntrospectedFunction | IntrospectedClassFunction | IntrospectedClassCallback | IntrospectedCallback): string;
+    generateClassFunction(node: IntrospectedClassFunction): string[];
+    generateFunction(tsFunction: IntrospectedClassFunction | IntrospectedFunction | IntrospectedCallback, indentCount?: number): string[];
+    generateFunctions(tsFunctions: IntrospectedFunction[] | IntrospectedClassFunction[], indentCount?: number, comment?: string): string[];
+    generateCallback(tsCallback: IntrospectedCallback | IntrospectedClassCallback, indentCount?: number, classModuleName?: string): string[];
+    generateCallbackInterfaces(tsCallbacks: Array<IntrospectedCallback | IntrospectedClassCallback>, indentCount: number | undefined, classModuleName: string, comment?: string): string[];
+    generateEnum(girEnum: IntrospectedEnum, indentCount?: number): string[];
+    generateEnumMember(tsMember: IntrospectedEnumMember, indentCount?: number): string[];
+    generateConst(tsConst: IntrospectedConstant, indentCount?: number): string[];
+    generateAlias(girAlias: IntrospectedAlias, indentCount?: number): string[];
+    generateConstructPropsInterface(girClass: IntrospectedClass | IntrospectedRecord | IntrospectedInterface, indentCount?: number): string[];
+    generateClassStaticFields(girClass: IntrospectedClass | IntrospectedRecord | IntrospectedInterface, indentCount?: number): string[];
+    generateClassMemberFields(girClass: IntrospectedClass | IntrospectedRecord | IntrospectedInterface, indentCount?: number): string[];
+    generateClassFields(girClass: IntrospectedClass | IntrospectedRecord, indentCount?: number): string[];
+    generateClassProperties(girClass: IntrospectedClass | IntrospectedRecord | IntrospectedInterface, indentCount?: number): string[];
+    generateClassStaticMethods(girClass: IntrospectedClass | IntrospectedRecord | IntrospectedInterface, indentCount?: number): string[];
+    generateClassMethods(girClass: IntrospectedClass | IntrospectedRecord | IntrospectedInterface, indentCount?: number): string[];
+    generateClassConstructors(girClass: IntrospectedClass | IntrospectedRecord | IntrospectedInterface, indentCount?: number): string[];
+    /**
+     * Instance methods, vfunc_ prefix
+     * @param girClass
+     */
+    generateClassVirtualMethods(girClass: IntrospectedClass | IntrospectedRecord | IntrospectedInterface, indentCount?: number): string[];
+    generateClassSignalInterfaces(girClass: IntrospectedClass, indentCount?: number): string[];
+    generateSignals(girClass: IntrospectedClass): string[];
+    generateClassSignals(girClass: IntrospectedClass): string[];
+    generateClassModules(girClass: IntrospectedClass | IntrospectedRecord | IntrospectedInterface, indentCount?: number): string[];
+    generateClassCallbacks(girClass: IntrospectedClass | IntrospectedInterface | IntrospectedRecord): string[];
+    /**
+     * In Typescript, interfaces and classes can have the same name,
+     * so we use this to generate interfaces with the same name to implement multiple inheritance
+     * @param girClass
+     * @param namespace
+     */
+    generateImplementationInterface(girClass: IntrospectedClass | IntrospectedRecord | IntrospectedInterface): string[];
+    protected extends(node: IntrospectedBaseClass): string;
+    protected implements(node: IntrospectedClass): string;
+    /**
+     * Represents a record, GObject class or interface as a Typescript class
+     * @param girClass
+     * @param namespace
+     */
+    generateClass(girClass: IntrospectedClass | IntrospectedRecord): string[];
+    stringifyNamespace(node: GirModule): Promise<string | null>;
+    exportModuleIndexJS(): Promise<void>;
+    exportModuleIndexTS(): Promise<void>;
+    exportModuleJS(girModule: GirModule): Promise<void>;
+    exportModuleAmbientTS(girModule: GirModule): Promise<void>;
+    protected exportModuleAmbientJS(girModule: GirModule): Promise<void>;
+    protected exportModuleImportTS(girModule: GirModule): Promise<void>;
+    protected exportModuleImportJS(girModule: GirModule): Promise<void>;
+    exportModuleTS(): Promise<void>;
+    generateModule(girModule: GirModule): Promise<string[]>;
+    /**
+     * Generates a namespace for the given GirModule.
+     * @deprecated Use `generateModule` instead @ewlsh
+     * @param girModule The GirModule to generate a namespace for.
+     * @returns A promise that resolves to the generated namespace.
+     */
+    generateNamespace(girModule: GirModule): Promise<string[]>;
+    exportModule(_registry: NSRegistry, girModule: GirModule): Promise<void>;
+}