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

package/lib/generators/dts-inline.js

@@ -0,0 +1,59 @@
+import { promisifyNamespaceFunctions } from "../gir/namespace.js";
+import { override as overrideGLib } from "./dts/glib.js";
+import { override as overrideGObject } from "./dts/gobject.js";
+import { DtsGenerator } from "./dts.js";
+export class DtsInlineGenerator extends DtsGenerator {
+    constructor(namespace, options) {
+        super(namespace, options);
+    }
+    generateNamespace(node) {
+        const { namespace, options } = this;
+        if (options.verbose) {
+            console.debug(`Resolving the types of ${namespace.name}...`);
+        }
+        let suffix = "";
+        if (!options.noAdvancedVariants && node.name === "GLib") {
+            suffix = `\n${overrideGLib(node)}\n`;
+        }
+        else if (node.name === "GObject") {
+            suffix = `\n${overrideGObject(node)}\n`;
+        }
+        try {
+            const { name } = node;
+            const header = `
+/**
+ * ${name} ${node.version}
+ * 
+ * Generated from ${node.package_version.join(".")}
+ */
+`;
+            const base = `
+
+`;
+            if (options.promisify) {
+                promisifyNamespaceFunctions(node);
+            }
+            const content = Array.from(node.members.values())
+                .map(m => {
+                return `${(Array.isArray(m) ? m : [m])
+                    .map(m => (m.emit ? m.asString(this) : ""))
+                    .join("\n")}`;
+            })
+                .join("\n");
+            const output = [header, base, content, suffix].join("\n\n");
+            if (options.verbose) {
+                console.debug(`Printing ${namespace.name}...`);
+            }
+            return Promise.resolve(output);
+        }
+        catch (err) {
+            console.error(`Failed to generate namespace: ${node.name}`);
+            console.error(err);
+            return Promise.resolve(null);
+        }
+    }
+    async stringifyNamespace(node) {
+        return this.generateNamespace(node);
+    }
+}
+//# sourceMappingURL=dts-inline.js.map

package/lib/generators/dts-inline.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dts-inline.js","sourceRoot":"","sources":["../../src/generators/dts-inline.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,2BAA2B,EAAE,MAAM,qBAAqB,CAAC;AAIzF,OAAO,EAAE,QAAQ,IAAI,YAAY,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAGxC,MAAM,OAAO,kBAAmB,SAAQ,YAAY;IAChD,YAAY,SAAgC,EAAE,OAA0B;QACpE,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED,iBAAiB,CAAC,IAA2B;QACzC,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAEpC,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO,CAAC,KAAK,CAAC,0BAA0B,SAAS,CAAC,IAAI,KAAK,CAAC,CAAC;QACjE,CAAC;QAED,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,IAAI,CAAC,OAAO,CAAC,kBAAkB,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YACtD,MAAM,GAAG,KAAK,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;QACzC,CAAC;aAAM,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,GAAG,KAAK,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC;YACD,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YAEtB,MAAM,MAAM,GAAG;;KAEtB,IAAI,IAAI,IAAI,CAAC,OAAO;;oBAEL,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC;;CAEjD,CAAC;YACU,MAAM,IAAI,GAAG;;CAExB,CAAC;YAEU,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;gBACpB,2BAA2B,CAAC,IAAI,CAAC,CAAC;YACtC,CAAC;YAED,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;iBAC5C,GAAG,CAAC,CAAC,CAAC,EAAE;gBACL,OAAO,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;qBACjC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAE,CAAiC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;qBAC3E,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,CAAC,CAAC;iBACD,IAAI,CAAC,IAAI,CAAC,CAAC;YAEhB,MAAM,MAAM,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE5D,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBAClB,OAAO,CAAC,KAAK,CAAC,YAAY,SAAS,CAAC,IAAI,KAAK,CAAC,CAAC;YACnD,CAAC;YAED,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACnC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,iCAAiC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YAC5D,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAEnB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,IAA2B;QAChD,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;CACJ"}

package/lib/generators/dts-modules.d.ts

@@ -0,0 +1,8 @@
+import { IntrospectedNamespace } from "../gir/namespace.js";
+import { GenerationOptions } from "../types.js";
+import { DtsGenerator } from "./dts.js";
+export declare class DtsModuleGenerator extends DtsGenerator {
+    constructor(namespace: IntrospectedNamespace, options: GenerationOptions);
+    generateNamespace(node: IntrospectedNamespace): Promise<string | null>;
+    stringifyNamespace(node: IntrospectedNamespace): Promise<string | null>;
+}

package/lib/generators/dts-modules.js

@@ -0,0 +1,100 @@
+import { promisifyNamespaceFunctions } from "../gir/namespace.js";
+import { override as overrideGLib } from "./dts/glib.js";
+import { override as overrideGObject } from "./dts/gobject.js";
+import { DtsGenerator } from "./dts.js";
+export class DtsModuleGenerator extends DtsGenerator {
+    constructor(namespace, options) {
+        super(namespace, options);
+    }
+    generateNamespace(node) {
+        const { namespace, options } = this;
+        if (options.verbose) {
+            console.debug(`Resolving the types of ${namespace.name}...`);
+        }
+        let suffix = "";
+        if (!options.noAdvancedVariants && node.name === "GLib") {
+            suffix = `\n${overrideGLib(node)}\n`;
+        }
+        else if (node.name === "GObject") {
+            suffix = `\n${overrideGObject(node)}\n`;
+        }
+        try {
+            const { name } = node;
+            const header = `
+/**
+ * ${name} ${node.version}
+ * 
+ * Generated from ${node.package_version.join(".")}
+ */
+`;
+            const base = `
+
+`;
+            if (options.promisify) {
+                promisifyNamespaceFunctions(node);
+            }
+            const content = Array.from(node.members.values())
+                .map(m => {
+                return `${(Array.isArray(m) ? m : [m])
+                    .map(m => {
+                    const content = m.asString(this);
+                    return m.emit ? content : "";
+                })
+                    .join("\n")}`;
+            })
+                .join("\n");
+            // Resolve imports after we stringify everything else, sometimes we have to ad-hoc add an import.
+            const imports = [];
+            const metadata = `
+        /**
+ * Name of the imported GIR library
+ * @see https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
+ */
+export const __name__: string;
+/**
+ * Version of the imported GIR library
+ * @see https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189
+ */
+export const __version__: string;
+`;
+            const moduleIdentifier = `gi://${name}`;
+            const versionedNamespaceIdentifier = `${name}${node.version.split(".")[0].replace(/[^A-z0-9_]/g, "_")}`;
+            const versionedModuleIdentifier = `${moduleIdentifier}?version=${node.version}`;
+            const [versionedModuleHeader, versionedModuleSuffix] = [
+                `declare module "${versionedModuleIdentifier}" {
+          namespace ${versionedNamespaceIdentifier} {`,
+                `};
+
+        export default ${versionedNamespaceIdentifier};
+      }`
+            ];
+            const moduleDefinition = `declare module "${moduleIdentifier}" {
+        export * from "${versionedModuleIdentifier}";
+      }`;
+            const output = [
+                header,
+                versionedModuleHeader,
+                imports,
+                base,
+                content,
+                suffix,
+                metadata,
+                versionedModuleSuffix,
+                moduleDefinition
+            ].join("\n\n");
+            if (options.verbose) {
+                console.debug(`Printing ${namespace.name}...`);
+            }
+            return Promise.resolve(output);
+        }
+        catch (err) {
+            console.error(`Failed to generate namespace: ${node.name}`);
+            console.error(err);
+            return Promise.resolve(null);
+        }
+    }
+    async stringifyNamespace(node) {
+        return this.generateNamespace(node);
+    }
+}
+//# sourceMappingURL=dts-modules.js.map

package/lib/generators/dts-modules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dts-modules.js","sourceRoot":"","sources":["../../src/generators/dts-modules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,2BAA2B,EAAE,MAAM,qBAAqB,CAAC;AAIzF,OAAO,EAAE,QAAQ,IAAI,YAAY,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAGxC,MAAM,OAAO,kBAAmB,SAAQ,YAAY;IAChD,YAAY,SAAgC,EAAE,OAA0B;QACpE,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED,iBAAiB,CAAC,IAA2B;QACzC,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAEpC,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO,CAAC,KAAK,CAAC,0BAA0B,SAAS,CAAC,IAAI,KAAK,CAAC,CAAC;QACjE,CAAC;QAED,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,IAAI,CAAC,OAAO,CAAC,kBAAkB,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YACtD,MAAM,GAAG,KAAK,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;QACzC,CAAC;aAAM,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,GAAG,KAAK,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC;YACD,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YAEtB,MAAM,MAAM,GAAG;;KAEtB,IAAI,IAAI,IAAI,CAAC,OAAO;;oBAEL,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC;;CAEjD,CAAC;YACU,MAAM,IAAI,GAAG;;CAExB,CAAC;YAEU,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;gBACpB,2BAA2B,CAAC,IAAI,CAAC,CAAC;YACtC,CAAC;YAED,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;iBAC5C,GAAG,CAAC,CAAC,CAAC,EAAE;gBACL,OAAO,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;qBACjC,GAAG,CAAC,CAAC,CAAC,EAAE;oBACL,MAAM,OAAO,GAAI,CAAiC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;oBAElE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;gBACjC,CAAC,CAAC;qBACD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,CAAC,CAAC;iBACD,IAAI,CAAC,IAAI,CAAC,CAAC;YAEhB,iGAAiG;YACjG,MAAM,OAAO,GAAG,EAAE,CAAC;YAEnB,MAAM,QAAQ,GAAG;;;;;;;;;;;CAW5B,CAAC;YAEU,MAAM,gBAAgB,GAAG,QAAQ,IAAI,EAAE,CAAC;YACxC,MAAM,4BAA4B,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC,EAAE,CAAC;YACxG,MAAM,yBAAyB,GAAG,GAAG,gBAAgB,YAAY,IAAI,CAAC,OAAO,EAAE,CAAC;YAEhF,MAAM,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,GAAG;gBACnD,mBAAmB,yBAAyB;sBACtC,4BAA4B,IAAI;gBACtC;;yBAES,4BAA4B;QAC7C;aACK,CAAC;YACF,MAAM,gBAAgB,GAAG,mBAAmB,gBAAgB;yBAC/C,yBAAyB;QAC1C,CAAC;YAEG,MAAM,MAAM,GAAG;gBACX,MAAM;gBACN,qBAAqB;gBACrB,OAAO;gBACP,IAAI;gBACJ,OAAO;gBACP,MAAM;gBACN,QAAQ;gBACR,qBAAqB;gBACrB,gBAAgB;aACnB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAEf,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBAClB,OAAO,CAAC,KAAK,CAAC,YAAY,SAAS,CAAC,IAAI,KAAK,CAAC,CAAC;YACnD,CAAC;YAED,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACnC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,iCAAiC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YAC5D,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAEnB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,IAA2B;QAChD,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;CACJ"}

package/lib/generators/dts.d.ts

@@ -0,0 +1,45 @@
+import { FormatGenerator } from "./generator.js";
+import { IntrospectedNamespace } from "../gir/namespace.js";
+import { IntrospectedBaseClass, IntrospectedRecord, IntrospectedInterface, IntrospectedClass } from "../gir/class.js";
+import { IntrospectedConstant } from "../gir/const.js";
+import { IntrospectedEnum, IntrospectedError, GirEnumMember } from "../gir/enum.js";
+import { IntrospectedProperty, IntrospectedField } from "../gir/property.js";
+import { IntrospectedSignal, IntrospectedSignalType } from "../gir/signal.js";
+import { IntrospectedFunction, IntrospectedConstructor, IntrospectedFunctionParameter, IntrospectedCallback, IntrospectedDirectAllocationConstructor, IntrospectedClassCallback } from "../gir/function.js";
+import { IntrospectedClassFunction, IntrospectedStaticClassFunction, IntrospectedVirtualClassFunction } from "../gir/function.js";
+import { TypeExpression, Generic } from "../gir.js";
+import { IntrospectedAlias } from "../gir/alias.js";
+import { AnyIntrospectedType } from "../gir/base.js";
+import { GenerateConfig } from "../types/generate-config.js";
+export declare function versionImportFormat(versionFormat: string, namespace: string, version: string): string;
+export declare abstract class DtsGenerator extends FormatGenerator<string> {
+    constructor(namespace: IntrospectedNamespace, options: GenerateConfig);
+    protected generateParameters(parameters: IntrospectedFunctionParameter[]): string;
+    generateGenerics(nodes: Generic[], withDefaults?: boolean): string;
+    generateCallbackType(node: IntrospectedCallback | IntrospectedClassCallback): [string, string];
+    generateCallback(node: IntrospectedCallback | IntrospectedClassCallback): string;
+    generateClassCallback(node: IntrospectedClassCallback): string;
+    generateReturn(return_type: TypeExpression, output_parameters: IntrospectedFunctionParameter[]): string;
+    generateEnum(node: IntrospectedEnum): string;
+    generateError(node: IntrospectedError): string;
+    generateConst(node: IntrospectedConstant): string;
+    protected implements(node: IntrospectedClass): string;
+    protected extends(node: IntrospectedBaseClass): string;
+    generateInterface(node: IntrospectedInterface): string;
+    generateRecord(node: IntrospectedRecord): string;
+    generateClass(node: IntrospectedClass): string;
+    generateField(node: IntrospectedField): string;
+    generateProperty(node: IntrospectedProperty, construct?: boolean): string;
+    generateSignal(node: IntrospectedSignal, type?: IntrospectedSignalType): string;
+    generateEnumMember(node: GirEnumMember): string;
+    generateParameter(node: IntrospectedFunctionParameter): string;
+    docString(node: AnyIntrospectedType): string;
+    generateFunction(node: IntrospectedFunction): string;
+    generateConstructorFunction(node: IntrospectedConstructor): string;
+    generateConstructor(node: IntrospectedConstructor): string;
+    generateDirectAllocationConstructor(node: IntrospectedDirectAllocationConstructor): string;
+    generateClassFunction(node: IntrospectedClassFunction): string;
+    generateStaticClassFunction(node: IntrospectedStaticClassFunction): string;
+    generateAlias(node: IntrospectedAlias): string;
+    generateVirtualClassFunction(node: IntrospectedVirtualClassFunction): string;
+}