@ts-for-gir/lib/src/types/class-function-types.ts

Typescript .d.ts generator from GIR for gjs

import type { IntrospectedEnum } from "../gir/enum.ts";
import type { IntrospectedBaseClass, IntrospectedClassFunction } from "../gir/introspected-classes.ts";
import type { IntrospectedFunctionParameter } from "../gir/parameter.ts";
import type { Generic, TypeExpression } from "../gir.ts";
import type { GirVisitor } from "../visitor.ts";

export interface ClassFunctionCopyOptions<Parent> {
	parent?: Parent;
	name?: string;
	interfaceParent?: IntrospectedBaseClass | IntrospectedEnum; // avoid circular deps by importing types only
	parameters?: IntrospectedFunctionParameter[];
	outputParameters?: IntrospectedFunctionParameter[];
	returnType?: TypeExpression;
}

export interface ClassFunctionOptions<Parent> {
	name: string;
	parameters?: IntrospectedFunctionParameter[];
	output_parameters?: IntrospectedFunctionParameter[];
	return_type?: TypeExpression;
	parent: Parent;
	originalParent?: Parent | null;
	doc?: string | null;
}

// Type discriminators for function types
export const FunctionTypeKind = {
	CLASS_FUNCTION: "CLASS_FUNCTION",
	VIRTUAL_CLASS_FUNCTION: "VIRTUAL_CLASS_FUNCTION",
	STATIC_CLASS_FUNCTION: "STATIC_CLASS_FUNCTION",
	CONSTRUCTOR: "CONSTRUCTOR",
} as const;

export type FunctionTypeKind = (typeof FunctionTypeKind)[keyof typeof FunctionTypeKind];

// Base interface for all class functions to enable type checking
export interface ClassFunctionLike {
	readonly __functionTypeKind: FunctionTypeKind;
	readonly parameters: IntrospectedFunctionParameter[];
	readonly output_parameters: IntrospectedFunctionParameter[];
	readonly generics: Generic[];
	returnTypeDoc?: string | null;
	interfaceParent?: IntrospectedBaseClass | IntrospectedEnum | null;

	anyify(): IntrospectedClassFunction;
	shouldAnyify(): boolean;
	return(): TypeExpression;
	getCallbackParameters(): {
		name: string;
		parent: IntrospectedBaseClass | IntrospectedEnum;
		output_parameters: IntrospectedFunctionParameter[];
		parameters: IntrospectedFunctionParameter[];
		return_type: TypeExpression;
	};
	copy(options?: ClassFunctionCopyOptions<IntrospectedBaseClass | IntrospectedEnum>): IntrospectedClassFunction;
	accept(visitor: GirVisitor): IntrospectedClassFunction;
}