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

package/lib/symtable.js

@@ -0,0 +1,63 @@
+import { Logger } from './logger.js';
+import { WARN_NOT_FOUND_PACKAGE_NAME } from './messages.js';
+/**
+ * The SymTable is used to get any Type from any dependency to compare or to get information from
+ */
+export class SymTable {
+    config;
+    modPackageName;
+    modNamespace;
+    /**
+     * The items are static because any GirModule has the same items to be able to access the types of dependencies as well
+     */
+    static items = {};
+    log;
+    constructor(config, modPackageName, modNamespace) {
+        this.config = config;
+        this.modPackageName = modPackageName;
+        this.modNamespace = modNamespace;
+        this.log = new Logger(this.config.environment, this.config.verbose, 'SymTable');
+    }
+    /**
+     * Get symTable key, we use this method to prepend the package version to each key to prevent version conflicts e.g. in 'Gtk-3.0' and 'Gtk-4.0'
+     * @param implementation E.g. Gtk.Window
+     * @returns E.g. 'Gtk-3.0.Gtk.Window'
+     */
+    getKey(dependencies, implementation) {
+        if (implementation.startsWith(this.modPackageName + '.')) {
+            return implementation;
+        }
+        if (implementation.startsWith(this.modNamespace + '.')) {
+            return this.modPackageName + '.' + implementation;
+        }
+        if (!implementation.includes('.')) {
+            return this.modPackageName + '.' + this.modNamespace + '.' + implementation;
+        }
+        const split = implementation.split('.');
+        const namespace = split[0];
+        const packageName = dependencies.find((dependency) => dependency.startsWith(namespace + '-'));
+        if (!packageName) {
+            this.log.warn(WARN_NOT_FOUND_PACKAGE_NAME(namespace, implementation));
+            return null;
+        }
+        return packageName + '.' + implementation;
+    }
+    get(dependencies, fullTypeName) {
+        const key = this.getKey(dependencies, fullTypeName);
+        if (!key || !SymTable.items[key]) {
+            return null;
+        }
+        const result = SymTable.items[key] || null;
+        return result;
+    }
+    getByHand(key) {
+        return (SymTable.items[key] || null);
+    }
+    set(dependencies, fullTypeName, GirElement) {
+        const key = this.getKey(dependencies, fullTypeName);
+        if (key) {
+            SymTable.items[key] = GirElement;
+        }
+    }
+}
+//# sourceMappingURL=symtable.js.map

package/lib/symtable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"symtable.js","sourceRoot":"","sources":["../src/symtable.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAA;AAE3D;;GAEG;AACH,MAAM,OAAO,QAAQ;IAQI;IACA;IACA;IATrB;;OAEG;IACK,MAAM,CAAC,KAAK,GAAkB,EAAE,CAAA;IAChC,GAAG,CAAQ;IAEnB,YACqB,MAAsB,EACtB,cAAsB,EACtB,YAAoB;QAFpB,WAAM,GAAN,MAAM,CAAgB;QACtB,mBAAc,GAAd,cAAc,CAAQ;QACtB,iBAAY,GAAZ,YAAY,CAAQ;QAErC,IAAI,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;IACnF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAsB,EAAE,cAAsB;QACxD,IAAI,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,EAAE;YACtD,OAAO,cAAc,CAAA;SACxB;QAED,IAAI,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,EAAE;YACpD,OAAO,IAAI,CAAC,cAAc,GAAG,GAAG,GAAG,cAAc,CAAA;SACpD;QAED,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC/B,OAAO,IAAI,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC,YAAY,GAAG,GAAG,GAAG,cAAc,CAAA;SAC9E;QAED,MAAM,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACvC,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;QAC1B,MAAM,WAAW,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,CAAA;QAC7F,IAAI,CAAC,WAAW,EAAE;YACd,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,2BAA2B,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,CAAA;YACrE,OAAO,IAAI,CAAA;SACd;QACD,OAAO,WAAW,GAAG,GAAG,GAAG,cAAc,CAAA;IAC7C,CAAC;IAEM,GAAG,CAAI,YAAsB,EAAE,YAAoB;QACtD,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,YAAY,CAAC,CAAA;QACnD,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YAC9B,OAAO,IAAI,CAAA;SACd;QACD,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,IAAI,CAAA;QAC1C,OAAO,MAA6B,CAAA;IACxC,CAAC;IAEM,SAAS,CAAoB,GAAW;QAC3C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,IAAI,CAAwB,CAAA;IAC/D,CAAC;IAEM,GAAG,CAAC,YAAsB,EAAE,YAAoB,EAAE,UAAyB;QAC9E,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,YAAY,CAAC,CAAA;QACnD,IAAI,GAAG,EAAE;YACL,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,UAAU,CAAA;SACnC;IACL,CAAC"}

package/lib/template-processor.d.ts

@@ -0,0 +1,46 @@
+/**
+ * The TemplateProcessor is used generate strings from templates files or template strings
+ * For example, the signal methods are generated here
+ */
+import ejs from 'ejs';
+import { Logger } from './logger.js';
+import type { GenerateConfig } from './types/index.js';
+export declare class TemplateProcessor {
+    protected readonly data: ejs.Data | undefined;
+    protected readonly packageName: string;
+    protected readonly config: GenerateConfig;
+    protected environmentTemplateDir: string;
+    protected log: Logger;
+    constructor(data: ejs.Data | undefined, packageName: string, config: GenerateConfig);
+    /**
+     * Loads and renders a template and gets the rendered string back
+     * @param templateFilename
+     */
+    load(templateFilename: string): Promise<string>;
+    /**
+     * Loads an template, render the template and write the template to the filesystem
+     * @param templateFilename
+     * @param outputDir
+     * @param outputFilename
+     * @param append
+     * @return The rendered (and if possible prettified) code string
+     */
+    create(templateFilename: string, outputDir: string, outputFilename: string, append?: string): Promise<string>;
+    protected write(content: string, outputDir: string, outputFilename: string): Promise<string>;
+    protected render(templateString: string, additionalData?: Partial<ejs.Options>): Promise<string>;
+    /**
+     * Checks if the template file exists and returns the path if found
+     * Tries first to load the file from the environment-specific template folder and otherwise looks for it in the general template folder
+     * @param templateFilename
+     */
+    exists(templateFilename: string): string | null;
+    prettifySource(source: string, filepath: string): string | null;
+    prettify(path: string, changeFile?: boolean): Promise<string | null>;
+    /**
+     * Reads a template file from filesystem and gets the raw string back
+     * @param templateFilename
+     * @return The raw template content
+     */
+    protected read(templateFilename: string): Promise<string>;
+}
+export default TemplateProcessor;

package/lib/template-processor.js

@@ -0,0 +1,154 @@
+/**
+ * The TemplateProcessor is used generate strings from templates files or template strings
+ * For example, the signal methods are generated here
+ */
+import { existsSync, readFileSync, writeFileSync, mkdirSync } from 'fs';
+import Path from 'path';
+import ejs from 'ejs';
+import { Logger } from './logger.js';
+import { APP_NAME, APP_USAGE, APP_SOURCE } from './constants.js';
+import prettier from 'prettier';
+import { __dirname, getEnvironmentDir, getDestPath } from './utils.js';
+import { WARN_PRETTIFY_ERROR } from './messages.js';
+const TEMPLATE_DIR = Path.join(__dirname, '../templates');
+export class TemplateProcessor {
+    data;
+    packageName;
+    config;
+    environmentTemplateDir;
+    log;
+    constructor(data, packageName, config) {
+        this.data = data;
+        this.packageName = packageName;
+        this.config = config;
+        this.data = {
+            ...this.data,
+            APP_NAME,
+            APP_USAGE,
+            APP_SOURCE,
+        };
+        this.environmentTemplateDir = getEnvironmentDir(config.environment, TEMPLATE_DIR);
+        this.log = new Logger(config.environment, config.verbose, this.packageName);
+    }
+    /**
+     * Loads and renders a template and gets the rendered string back
+     * @param templateFilename
+     */
+    async load(templateFilename) {
+        const fileContent = await this.read(templateFilename);
+        return await this.render(fileContent);
+    }
+    /**
+     * Loads an template, render the template and write the template to the filesystem
+     * @param templateFilename
+     * @param outputDir
+     * @param outputFilename
+     * @param append
+     * @return The rendered (and if possible prettified) code string
+     */
+    async create(templateFilename, outputDir, outputFilename, append = '') {
+        const fileContent = await this.load(templateFilename);
+        const renderedCode = await this.render(fileContent);
+        const destPath = getDestPath(this.config.environment, outputDir, outputFilename);
+        const prettifiedCode = this.config.pretty ? this.prettifySource(renderedCode, destPath) : null;
+        const code = (prettifiedCode || renderedCode) + append;
+        await this.write(code, outputDir, outputFilename);
+        return code;
+    }
+    async write(content, outputDir, outputFilename) {
+        const destPath = getDestPath(this.config.environment, outputDir, outputFilename);
+        // write template result file
+        mkdirSync(outputDir, { recursive: true });
+        writeFileSync(destPath, content, { encoding: 'utf8', flag: 'w' });
+        return Promise.resolve(destPath);
+    }
+    async render(templateString, additionalData = {}) {
+        try {
+            const renderedCode = ejs.render(templateString, {
+                async: true,
+                ...this.config,
+                ...this.data,
+                ...additionalData,
+            });
+            return Promise.resolve(renderedCode);
+        }
+        catch (error) {
+            this.log.error('Error on render', error);
+            return '';
+        }
+    }
+    /**
+     * Checks if the template file exists and returns the path if found
+     * Tries first to load the file from the environment-specific template folder and otherwise looks for it in the general template folder
+     * @param templateFilename
+     */
+    exists(templateFilename) {
+        const fullEnvironmentTemplatePath = Path.join(this.environmentTemplateDir, templateFilename);
+        const fullGeneralTemplatePath = Path.join(TEMPLATE_DIR, templateFilename);
+        if (existsSync(fullEnvironmentTemplatePath)) {
+            return fullEnvironmentTemplatePath;
+        }
+        if (existsSync(fullGeneralTemplatePath)) {
+            return fullGeneralTemplatePath;
+        }
+        return null;
+    }
+    prettifySource(source, filepath) {
+        let prettyCode = null;
+        this.log.info(`   Prettify ${Path.basename(filepath)}...`);
+        let parser = undefined;
+        if (filepath.endsWith('.ts')) {
+            parser = 'typescript';
+        }
+        else if (filepath.endsWith('.js')) {
+            parser = 'espree';
+        }
+        try {
+            prettyCode = prettier.format(source, { parser });
+        }
+        catch (error) {
+            this.log.warn(WARN_PRETTIFY_ERROR(filepath));
+            this.log.warn('Error on prettifySource', error);
+        }
+        return prettyCode;
+    }
+    async prettify(path, changeFile = false) {
+        let hasError = false;
+        let prettyCode = null;
+        const filename = Path.basename(path);
+        this.log.info(`   Prettify ${filename}...`);
+        try {
+            const source = readFileSync(Path.resolve('.', path), 'utf8');
+            prettyCode = this.prettifySource(source, path);
+        }
+        catch (error) {
+            this.log.warn('Error on prettify', error);
+            hasError = true;
+        }
+        if (hasError) {
+            if (!prettyCode) {
+                this.log.warn(WARN_PRETTIFY_ERROR(path));
+            }
+        }
+        else {
+            if (prettyCode && changeFile) {
+                await this.write(prettyCode, Path.dirname(path), Path.basename(path));
+            }
+        }
+        return prettyCode;
+    }
+    /**
+     * Reads a template file from filesystem and gets the raw string back
+     * @param templateFilename
+     * @return The raw template content
+     */
+    async read(templateFilename) {
+        const path = this.exists(templateFilename);
+        if (path) {
+            return Promise.resolve(readFileSync(path, 'utf8'));
+        }
+        throw new Error(`Template '${templateFilename}' not found'`);
+    }
+}
+export default TemplateProcessor;
+//# sourceMappingURL=template-processor.js.map

package/lib/template-processor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-processor.js","sourceRoot":"","sources":["../src/template-processor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,IAAI,CAAA;AACvE,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,GAAG,MAAM,KAAK,CAAA;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAEhE,OAAO,QAAQ,MAAM,UAAU,CAAA;AAC/B,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACtE,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AAEnD,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;AAEzD,MAAM,OAAO,iBAAiB;IAIH;IACA;IACA;IALb,sBAAsB,CAAQ;IAC9B,GAAG,CAAQ;IACrB,YACuB,IAA0B,EAC1B,WAAmB,EACnB,MAAsB;QAFtB,SAAI,GAAJ,IAAI,CAAsB;QAC1B,gBAAW,GAAX,WAAW,CAAQ;QACnB,WAAM,GAAN,MAAM,CAAgB;QAEzC,IAAI,CAAC,IAAI,GAAG;YACR,GAAG,IAAI,CAAC,IAAI;YACZ,QAAQ;YACR,SAAS;YACT,UAAU;SACb,CAAA;QACD,IAAI,CAAC,sBAAsB,GAAG,iBAAiB,CAAC,MAAM,CAAC,WAAW,EAAE,YAAY,CAAC,CAAA;QACjF,IAAI,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;IAC/E,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI,CAAC,gBAAwB;QACtC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QACrD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;IACzC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,MAAM,CACf,gBAAwB,EACxB,SAAiB,EACjB,cAAsB,EACtB,MAAM,GAAG,EAAE;QAEX,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QACrD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;QACnD,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,EAAE,cAAc,CAAC,CAAA;QAChF,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAC9F,MAAM,IAAI,GAAG,CAAC,cAAc,IAAI,YAAY,CAAC,GAAG,MAAM,CAAA;QACtD,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,cAAc,CAAC,CAAA;QACjD,OAAO,IAAI,CAAA;IACf,CAAC;IAES,KAAK,CAAC,KAAK,CAAC,OAAe,EAAE,SAAiB,EAAE,cAAsB;QAC5E,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,EAAE,cAAc,CAAC,CAAA;QAEhF,6BAA6B;QAC7B,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QACzC,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAA;QAEjE,OAAO,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IACpC,CAAC;IAES,KAAK,CAAC,MAAM,CAAC,cAAsB,EAAE,iBAAuC,EAAE;QACpF,IAAI;YACA,MAAM,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE;gBAC5C,KAAK,EAAE,IAAI;gBACX,GAAG,IAAI,CAAC,MAAM;gBACd,GAAG,IAAI,CAAC,IAAI;gBACZ,GAAG,cAAc;aACpB,CAAC,CAAA;YACF,OAAO,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;SACvC;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAA;YACxC,OAAO,EAAE,CAAA;SACZ;IACL,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAwB;QAClC,MAAM,2BAA2B,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE,gBAAgB,CAAC,CAAA;QAC5F,MAAM,uBAAuB,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAA;QACzE,IAAI,UAAU,CAAC,2BAA2B,CAAC,EAAE;YACzC,OAAO,2BAA2B,CAAA;SACrC;QACD,IAAI,UAAU,CAAC,uBAAuB,CAAC,EAAE;YACrC,OAAO,uBAAuB,CAAA;SACjC;QACD,OAAO,IAAI,CAAA;IACf,CAAC;IAEM,cAAc,CAAC,MAAc,EAAE,QAAgB;QAClD,IAAI,UAAU,GAAkB,IAAI,CAAA;QACpC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;QAC1D,IAAI,MAAM,GACN,SAAS,CAAA;QACb,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YAC1B,MAAM,GAAG,YAAY,CAAA;SACxB;aAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YACjC,MAAM,GAAG,QAAQ,CAAA;SACpB;QACD,IAAI;YACA,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;SACnD;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAA;YAC5C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAA;SAClD;QAED,OAAO,UAAU,CAAA;IACrB,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,IAAY,EAAE,UAAU,GAAG,KAAK;QAClD,IAAI,QAAQ,GAAG,KAAK,CAAA;QACpB,IAAI,UAAU,GAAkB,IAAI,CAAA;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QACpC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,QAAQ,KAAK,CAAC,CAAA;QAC3C,IAAI;YACA,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAA;YAC5D,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;SACjD;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAA;YACzC,QAAQ,GAAG,IAAI,CAAA;SAClB;QAED,IAAI,QAAQ,EAAE;YACV,IAAI,CAAC,UAAU,EAAE;gBACb,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAA;aAC3C;SACJ;aAAM;YACH,IAAI,UAAU,IAAI,UAAU,EAAE;gBAC1B,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAA;aACxE;SACJ;QAED,OAAO,UAAU,CAAA;IACrB,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,IAAI,CAAC,gBAAwB;QACzC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAA;QAC1C,IAAI,IAAI,EAAE;YACN,OAAO,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;SACrD;QACD,MAAM,IAAI,KAAK,CAAC,aAAa,gBAAgB,cAAc,CAAC,CAAA;IAChE,CAAC;CACJ;AAED,eAAe,iBAAiB,CAAA"}

package/lib/transformation.d.ts

@@ -0,0 +1,156 @@
+/**
+ * This is where transformations take place for gjs and node-gtk.
+ * For example a function names should be transformed to lowerCamelCase for node-gtk but should keep their original name for gjs
+ */
+import { Environment, ConstructName, GenerateConfig, GirCallableParamElement, GirEnumElement, GirBitfieldElement } from './types/index.js';
+export declare const POD_TYPE_MAP_ARRAY: {
+    guint8: string;
+    gint8: string;
+    gunichar: string;
+};
+/**
+ * @see https://developer.gnome.org/glib/stable/glib-Basic-Types.html
+ */
+export declare const POD_TYPE_MAP: {
+    utf8: string;
+    none: string;
+    double: string;
+    'double*': string;
+    guint: string;
+    'guint*': string;
+    guint8: string;
+    'guint8*': string;
+    'guint8**': string;
+    guint16: string;
+    'guint16*': string;
+    gint16: string;
+    'gint16*': string;
+    guint32: string;
+    'guint32*': string;
+    guint64: string;
+    'guint64*': string;
+    gunichar: string;
+    'gunichar*': string;
+    gint: string;
+    'gint*': string;
+    gint8: string;
+    'gint8*': string;
+    gint32: string;
+    'gint32*': string;
+    gint64: string;
+    'gint64*': string;
+    gushort: string;
+    'gushort*': string;
+    gfloat: string;
+    'gfloat*': string;
+    gboolean: string;
+    'gboolean*': string;
+    gpointer: string;
+    'gpointer*': string;
+    gconstpointer: string;
+    gchar: string;
+    guchar: string;
+    glong: string;
+    gulong: string;
+    gdouble: string;
+    gssize: string;
+    gsize: string;
+    long: string;
+    object: string;
+    gshort: string;
+    filename: string;
+    va_list: string;
+    guintptr: string;
+};
+export declare const C_TYPE_MAP: (value: string) => string | undefined;
+export declare const FULL_TYPE_MAP: (environment: Environment, value: string, out?: boolean) => string | undefined;
+/** The reserved variable names listed here cannot be resolved simply by quotation marks */
+export declare const RESERVED_QUOTE_VARIABLE_NAMES: string[];
+export declare const RESERVED_VARIABLE_NAMES: string[];
+export declare const RESERVED_CLASS_NAMES: string[];
+export declare const RESERVED_FUNCTION_NAMES: string[];
+/**
+ * Some classes already have their own `.connect`, `.disconnect` or `.emit` methods,
+ * so these cannot be overwritten with the Gjs signal methods which have the same name.
+ */
+export declare const GOBJECT_SIGNAL_METHOD_NAMES: string[];
+export declare const IGNORE_GIR_TYPE_TS_DOC_TYPES: string[];
+export declare const RESERVED_NAMESPACE_NAMES: {};
+export declare class Transformation {
+    private readonly config;
+    /**
+     * Rules for the name conventions
+     * For node-gtk naming conventions see https://github.com/romgrk/node-gtk#naming-conventions
+     * For gjs see https://gjs-docs.gnome.org/ and https://wiki.gnome.org/Attic/Gjs
+     */
+    private transformations;
+    private log;
+    constructor(moduleName: string | undefined, config: GenerateConfig);
+    transformSignalInterfaceName(name: string): string;
+    transformModuleNamespaceName(name: string): string;
+    transformClassName(name: string): string;
+    /**
+     * // E.g. the NetworkManager-1.0 has enum names starting with 80211
+     * @param girEnum The enum
+     * @returns The transformed name
+     */
+    transformEnumName(girEnum: GirEnumElement | GirBitfieldElement): string;
+    transformEnumMember(memberName: string): string;
+    transformFunctionName(name: string, isVirtual: boolean): string;
+    transformReservedVariableNames(name: string, allowQuotes: boolean): string;
+    /**
+     * E.g. GstVideo-1.0 has a class `VideoScaler` with a method called `2d`
+     * or NetworkManager-1.0 has methods starting with `80211`
+     */
+    transformPropertyName(name: string, allowQuotes: boolean): string;
+    transformConstantName(name: string, allowQuotes: boolean): string;
+    transformFieldName(name: string, allowQuotes: boolean): string;
+    transformParameterName(param: GirCallableParamElement, allowQuotes: boolean): string;
+    /**
+     * Fixes type names, e.g. Return types or enum definitions can not start with numbers
+     * @param typeName
+     */
+    transformTypeName(name: string): string;
+    transform(construct: ConstructName, transformMe: string): string;
+    /**
+     * In JavaScript there can be no variables, methods, class names or enum names that start with a number.
+     * This method converts such names.
+     * TODO: Prepends an `@` to numeric starting names, how does gjs and node-gtk do that?
+     * @param name
+     * @param allowQuotes
+     */
+    private transformNumericName;
+    /**
+     * Replaces "@any_property" with "`any_property`"
+     * @param description E.g. "Creates a binding between @source_property on @source and @target_property on @target."
+     * @returns E.g. "Creates a binding between `source_property` on `source` and `target_property` on `target`."
+     */
+    private transformGirDocHighlights;
+    /**
+     * Replaces:
+     * |[<!-- language="C" -->
+     *   g_object_notify_by_pspec (self, properties[PROP_FOO]);
+     * ]|
+     *
+     * with
+     * ```c
+     *   g_object_notify_by_pspec (self, properties[PROP_FOO]);
+     * ```
+     *
+     * @param description
+     */
+    private transformGirDocCodeBlocks;
+    /**
+     * Transforms the documentation text to markdown
+     * TODO: Transform references to link tags: https://tsdoc.org/pages/tags/link/
+     * @param text
+     * @returns
+     */
+    transformGirDoc(text: string): string;
+    /**
+     * Transforms the tsDoc tag <text> like `@param name <text>`
+     * @param text
+     * @returns
+     */
+    transformGirDocTagText(text: string): string;
+}