@ts-for-gir/cli 3.0.0-beta.10

package/src/html-doc-generator.ts

@@ -0,0 +1,23 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { Logger } from './logger.js'
+import { Generator } from './generator.js'
+import { DANGER_HTML_DOC_GENERATOR_NOT_IMPLEMENTED } from './messages.js'
+import type { GenerateConfig, GirModulesGrouped, InheritanceTable } from './types/index.js'
+import type { GirModule } from './gir-module.js'
+
+/**
+ * A template that can be used to implement an HTML Documentation Generator
+ */
+export default class HtmlDocGenerator implements Generator {
+    protected log: Logger
+    constructor(protected readonly config: GenerateConfig) {
+        this.log = new Logger(config.environment, config.verbose, HtmlDocGenerator.name)
+    }
+    public async start(
+        girModules: GirModule[],
+        girModulesGrouped: GirModulesGrouped[],
+        inheritanceTable: InheritanceTable,
+    ) {
+        return Promise.resolve(this.log.danger(DANGER_HTML_DOC_GENERATOR_NOT_IMPLEMENTED))
+    }
+}

package/src/index.ts

@@ -0,0 +1,17 @@
+export * from './types/index.js'
+export * from './injection/index.js'
+export * from './commands/index.js'
+export * from './config.js'
+export * from './conflict-resolver.js'
+export * from './constants.js'
+export * from './generation-handler.js'
+export * from './gir-factory.js'
+export * from './gir-module.js'
+export * from './logger.js'
+export * from './messages.js'
+export * from './module-loader.js'
+export * from './symtable.js'
+export * from './template-processor.js'
+export * from './transformation.js'
+export * from './utils.js'
+export { default as templateProcessor } from './template-processor.js'

package/src/injection/callbacks/gjs/Gio-2.0.ts

@@ -0,0 +1,37 @@
+import type { InjectionCallback } from '../../../types/index.js'
+
+export const callbacksGio20Gjs: InjectionCallback[] = [
+    {
+        versions: ['2.0'],
+        namespace: 'Gio',
+        name: 'AsyncReadyCallback',
+        // Generics for callback parameters
+        // TODO only use `this` if there is also a _finish method
+        generics: [
+            {
+                name: 'T',
+                value: 'this',
+            },
+        ],
+        inParams: [
+            // Type changed
+            {
+                name: 'source_object',
+                type: [{ type: 'T' }],
+            },
+            // Not changed
+            {
+                name: 'res',
+                type: [{ type: 'Gio.AsyncResult' }],
+            },
+        ],
+        tsCallbackInterface: {
+            generics: [
+                {
+                    name: 'T',
+                    value: 'GObject.Object',
+                },
+            ],
+        },
+    },
+]

package/src/injection/callbacks/gjs/index.ts

@@ -0,0 +1,5 @@
+import type { InjectionCallback } from '../../../types/index.js'
+
+import { callbacksGio20Gjs } from './Gio-2.0.js'
+
+export const callbacksGjs: InjectionCallback[] = [...callbacksGio20Gjs]

package/src/injection/callbacks/index.ts

@@ -0,0 +1,6 @@
+import type { InjectionCallback } from '../../types/index.js'
+
+export { callbacksGjs } from './gjs/index.js'
+export { callbacksNode } from './node-gtk/index.js'
+
+export const callbacksAll: InjectionCallback[] = []

package/src/injection/callbacks/node-gtk/index.ts

@@ -0,0 +1,3 @@
+import type { InjectionCallback } from '../../../types/index.js'
+
+export const callbacksNode: InjectionCallback[] = []

package/src/injection/classes/GLib-2-0.ts

@@ -0,0 +1,36 @@
+import type { InjectionClass } from '../../types/index.js'
+
+export const classesGLib20All: InjectionClass[] = [
+    {
+        versions: ['2.0'],
+        qualifiedName: 'GLib.List',
+        generics: [
+            {
+                name: 'A',
+                value: 'any',
+            },
+        ],
+    },
+    {
+        versions: ['2.0'],
+        qualifiedName: 'GLib.HashTable',
+        // TODO
+        // [key: A]: B;
+        // properties: [
+        //     {
+        //         name: '[key: A]'
+        //         type: 'B'
+        //     }
+        // ],
+        generics: [
+            {
+                name: 'A',
+                value: 'symbol | string | number',
+            },
+            {
+                name: 'B',
+                value: 'string | number | boolean',
+            },
+        ],
+    },
+]

package/src/injection/classes/gjs/GLib-2.0.ts

@@ -0,0 +1,206 @@
+import type { InjectionClass } from '../../../types/index.js'
+
+export const classesGLib20Gjs: InjectionClass[] = [
+    // https://gjs.guide/guides/glib/gvariant.html#unpacking-variants
+    {
+        versions: ['2.0'],
+        qualifiedName: 'GLib.Variant',
+        methods: [
+            {
+                name: 'constructor',
+                isStatic: true,
+                returnTypes: [{ type: 'GLib.Variant' }],
+                inParams: [
+                    {
+                        name: 'sig',
+                        type: [{ type: 'string' }],
+                    },
+                    {
+                        name: 'value',
+                        type: [{ type: 'any' }],
+                    },
+                ],
+                girTypeName: 'constructor',
+            },
+            {
+                name: 'new',
+                returnTypes: [{ type: 'GLib.Variant' }],
+                inParams: [
+                    {
+                        name: 'sig',
+                        type: [{ type: 'string' }],
+                    },
+                    {
+                        name: 'value',
+                        type: [{ type: 'any' }],
+                    },
+                ],
+                girTypeName: 'constructor',
+            },
+            {
+                name: 'unpack',
+                returnTypes: [{ type: 'T' }],
+                girTypeName: 'method',
+                generics: [
+                    {
+                        name: 'T',
+                        value: 'unknown',
+                    },
+                ],
+            },
+            {
+                name: 'deepUnpack',
+                returnTypes: [{ type: 'T' }],
+                girTypeName: 'method',
+                generics: [
+                    {
+                        name: 'T',
+                        value: 'unknown',
+                    },
+                ],
+            },
+            {
+                name: 'recursiveUnpack',
+                returnTypes: [{ type: 'T' }],
+                girTypeName: 'method',
+                generics: [
+                    {
+                        name: 'T',
+                        value: 'unknown',
+                    },
+                ],
+            },
+        ],
+    },
+    {
+        versions: ['2.0'],
+        qualifiedName: 'GLib.Bytes',
+        methods: [
+            {
+                name: 'toArray',
+                returnTypes: [{ type: 'Uint8Array' }],
+                girTypeName: 'method',
+                doc: {
+                    text: 'Convert a [`GLib.Bytes`](https://gjs-docs.gnome.org/glib20/glib.bytes) object to a `Uint8Array` object.',
+                    tags: [
+                        {
+                            tagName: '@returns',
+                            paramName: '',
+                            text: 'A `Uint8Array`',
+                        },
+                    ],
+                },
+            },
+        ],
+    },
+    {
+        versions: ['2.0'],
+        qualifiedName: 'GLib.Error',
+        properties: [
+            // https://gitlab.gnome.org/GNOME/gjs/-/blob/d1cf26179322b2b87fb980e3b244b5e24dba8dd6/gi/gerror.cpp#L298-305
+            {
+                name: 'stack',
+                type: [{ type: 'string' }],
+                girTypeName: 'property',
+                doc: {
+                    text: 'The stack trace of the error.',
+                    tags: [
+                        {
+                            tagName: '@field',
+                            paramName: '',
+                            text: '',
+                        },
+                    ],
+                },
+            },
+            {
+                name: 'source',
+                type: [{ type: 'string' }],
+                girTypeName: 'property',
+                doc: {
+                    text: 'The name of the file where is the source of the error.',
+                    tags: [
+                        {
+                            tagName: '@field',
+                            paramName: '',
+                            text: '',
+                        },
+                    ],
+                },
+            },
+            {
+                name: 'line',
+                type: [{ type: 'number' }],
+                girTypeName: 'property',
+                doc: {
+                    text: 'The line number of the source of the error.',
+                    tags: [
+                        {
+                            tagName: '@field',
+                            paramName: '',
+                            text: '',
+                        },
+                    ],
+                },
+            },
+            {
+                name: 'column',
+                type: [{ type: 'number' }],
+                girTypeName: 'property',
+                doc: {
+                    text: 'The column number of the source of the error.',
+                    tags: [
+                        {
+                            tagName: '@field',
+                            paramName: '',
+                            text: '',
+                        },
+                    ],
+                },
+            },
+        ],
+        methods: [
+            // https://gitlab.gnome.org/GNOME/gjs/-/blob/33d58646d43b84d4c0ffc3681b89d125d5ccdfc6/installed-tests/js/testExceptions.js#L119-123
+            // https://gjs-docs.gnome.org/glib20~2.66.1/glib.error#constructor-new_literal
+            {
+                name: 'constructor',
+                isStatic: true,
+                returnTypes: [{ type: 'GLib.Error' }],
+                inParams: [
+                    {
+                        name: 'domain',
+                        type: [{ type: 'GLib.Quark' }],
+                    },
+                    {
+                        name: 'code',
+                        type: [{ type: 'number' }],
+                    },
+                    {
+                        name: 'message',
+                        type: [{ type: 'string' }],
+                    },
+                ],
+                girTypeName: 'constructor',
+            },
+            {
+                name: 'new',
+                returnTypes: [{ type: 'GLib.Error' }],
+                inParams: [
+                    {
+                        name: 'domain',
+                        type: [{ type: 'GLib.Quark' }],
+                    },
+                    {
+                        name: 'code',
+                        type: [{ type: 'number' }],
+                    },
+                    {
+                        name: 'message',
+                        type: [{ type: 'string' }],
+                    },
+                ],
+                girTypeName: 'constructor',
+            },
+        ],
+    },
+]