@ts-for-gir/lib/src/gir/const.ts

Typescript .d.ts generator from GIR for gjs

import type { FormatGenerator } from "../generators/generator.ts";
import type { TypeExpression } from "../gir.ts";

import type { GirConstantElement } from "../index.ts";
import type { IntrospectedOptions, OptionsLoad } from "../types/index.ts";
import { getType, parseDoc, parseMetadata } from "../utils/gir-parsing.ts";
import { sanitizeIdentifierName } from "../utils/naming.ts";
import type { GirVisitor } from "../visitor.ts";
import { IntrospectedNamespaceMember } from "./introspected-namespace-member.ts";
import type { IntrospectedNamespace } from "./namespace.ts";

export class IntrospectedConstant extends IntrospectedNamespaceMember {
	type: TypeExpression;
	value: string | null;

	constructor({
		name,
		type,
		namespace,
		value,
		...options
	}: IntrospectedOptions<{
		name: string;
		type: TypeExpression;
		namespace: IntrospectedNamespace;
		value: string | null;
		isIntrospectable?: boolean;
	}>) {
		super(name, namespace, options);

		this.type = type;
		this.value = value;
	}

	accept(visitor: GirVisitor): IntrospectedConstant {
		const node = this.copy({
			type: visitor.visitType?.(this.type),
		});

		return visitor.visitConst?.(node) ?? node;
	}

	copy(options: { parent?: IntrospectedNamespace; type?: TypeExpression } = {}): IntrospectedConstant {
		const { type, name, value } = this;

		return new IntrospectedConstant({
			name,
			namespace: options.parent ?? this.namespace,
			type: options.type ?? type,
			value,
		})._copyBaseProperties(this);
	}

	static fromXML(element: GirConstantElement, ns: IntrospectedNamespace, options: OptionsLoad): IntrospectedConstant {
		const c = new IntrospectedConstant({
			name: sanitizeIdentifierName(ns.namespace, element.$.name),
			namespace: ns,
			type: getType(ns, element),
			value: element.$.value ?? null,
		});

		if (options.loadDocs) {
			c.doc = parseDoc(element);
			c.metadata = parseMetadata(element);
		}

		return c;
	}

	asString<T extends FormatGenerator<unknown>>(generator: T): ReturnType<T["generateConst"]> {
		return generator.generateConst(this) as ReturnType<T["generateConst"]>;
	}
}