@keymanapp/kmc-ldml 18.0.41-alpha → 18.0.45-alpha

package/build/src/compiler/compiler.js

@@ -1,310 +1,307 @@
-
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="5183a68a-b994-5081-b881-0db8ef00163d")}catch(e){}}();
-import { LDMLKeyboardXMLSourceFileReader, KMXPlus, defaultCompilerOptions, KMXBuilder, KvkFileWriter } from '@keymanapp/common-types';
-import { CompilerMessages } from './messages.js';
-import { BkspCompiler, TranCompiler } from './tran.js';
-import { DispCompiler } from './disp.js';
-import { KeysCompiler } from './keys.js';
-import { LayrCompiler } from './layr.js';
-import { LocaCompiler } from './loca.js';
-import { MetaCompiler } from './meta.js';
-import { VarsCompiler } from './vars.js';
-import { StrsCompiler, ElemCompiler, ListCompiler, UsetCompiler } from './empty-compiler.js';
-var KMXPlusFile = KMXPlus.KMXPlusFile;
-import { constants } from '@keymanapp/ldml-keyboard-constants';
-import { KmnCompiler } from '@keymanapp/kmc-kmn';
-import { KMXPlusMetadataCompiler } from './metadata-compiler.js';
-import { LdmlKeyboardVisualKeyboardCompiler } from './visual-keyboard-compiler.js';
-//KMW17.0: import { LdmlKeyboardKeymanWebCompiler } from './keymanweb-compiler.js';
-export const SECTION_COMPILERS = [
-    // These are in dependency order.
-    // First the former 'global' sections
-    StrsCompiler,
-    // meta depends on strs, but potentially needed by anything else using strs
-    MetaCompiler,
-    ListCompiler,
-    ElemCompiler,
-    UsetCompiler,
-    // Next, Vars, which depends on others
-    VarsCompiler,
-    // Now all others:
-    BkspCompiler,
-    DispCompiler,
-    KeysCompiler,
-    LayrCompiler,
-    LocaCompiler,
-    TranCompiler,
-];
-;
-;
-/**
- * @public
- * Compiles a LDML keyboard .xml file to a .kmx (KMXPlus), .kvk, and/or .js. The
- * compiler does not read or write from filesystem or network directly, but
- * relies on callbacks for all external IO.
- */
-export class LdmlKeyboardCompiler {
-    callbacks;
-    options;
-    // uset parser
-    usetparser = undefined;
-    /**
-     * Initialize the compiler, including loading the WASM host for uset parsing.
-     * Copies options.
-     * @param callbacks - Callbacks for external interfaces, including message
-     *                    reporting and file io
-     * @param options   - Compiler options
-     * @returns           false if initialization fails
-     */
-    async init(callbacks, options) {
-        this.options = { ...options };
-        this.callbacks = callbacks;
-        return true;
-    }
-    /**
-     * Compiles a LDML keyboard .xml file to .kmx, .kvk, and/or .js files. Returns
-     * an object containing binary artifacts on success. The files are passed in
-     * by name, and the compiler will use callbacks as passed to the
-     * {@link LdmlKeyboardCompiler.init} function to read any input files by disk.
-     * @param infile  - Path to source file.
-     * @param outfile - Path to output file. The file will not be written to, but
-     *                  will be included in the result for use by
-     *                  {@link LdmlKeyboardCompiler.write}.
-     * @returns         Binary artifacts on success, null on failure.
-     */
-    async run(inputFilename, outputFilename) {
-        let compilerOptions = {
-            ...defaultCompilerOptions,
-            ...this.options,
-        };
-        let source = this.load(inputFilename);
-        if (!source) {
-            return null;
-        }
-        let kmx = await this.compile(source);
-        if (!kmx) {
-            return null;
-        }
-        // In order for the KMX file to be loaded by non-KMXPlus components, it is helpful
-        // to duplicate some of the metadata
-        KMXPlusMetadataCompiler.addKmxMetadata(kmx.kmxplus, kmx.keyboard, compilerOptions);
-        // Use the builder to generate the binary output file
-        const builder = new KMXBuilder(kmx, compilerOptions.saveDebug);
-        const kmx_binary = builder.compile();
-        const vkcompiler = new LdmlKeyboardVisualKeyboardCompiler(this.callbacks);
-        const vk = vkcompiler.compile(source);
-        const writer = new KvkFileWriter();
-        const kvk_binary = writer.write(vk);
-        // Note: we could have a step of generating source files here
-        // KvksFileWriter()...
-        // const tlcompiler = new kmc.TouchLayoutCompiler();
-        // const tl = tlcompiler.compile(source);
-        // const tlwriter = new TouchLayoutFileWriter();
-        //KMW17.0: const kmwcompiler = new LdmlKeyboardKeymanWebCompiler(this.callbacks, compilerOptions);
-        //KMW17.0: const kmw_string = kmwcompiler.compile(inputFilename, source);
-        //KMW17.0: const encoder = new TextEncoder();
-        //KMW17.0: const kmw_binary = encoder.encode(kmw_string);
-        outputFilename = outputFilename ?? inputFilename.replace(/\.xml$/, '.kmx');
-        return {
-            artifacts: {
-                kmx: { data: kmx_binary, filename: outputFilename },
-                kvk: { data: kvk_binary, filename: outputFilename.replace(/\.kmx$/, '.kvk') },
-                //KMW17.0: js: { data: kmw_binary, filename: outputFilename.replace(/\.kmx$/, '.js') },
-            }
-        };
-    }
-    /**
-     * Write artifacts from a successful compile to disk, via callbacks methods.
-     * The artifacts written may include:
-     *
-     * - .kmx file - binary keyboard used by Keyman on desktop platforms
-     * - .kvk file - binary on screen keyboard used by Keyman on desktop platforms
-     * - .js file - Javascript keyboard for web and touch platforms
-     *
-     * @param artifacts - object containing artifact binary data to write out
-     * @returns true on success
-     */
-    async write(artifacts) {
-        if (artifacts.kmx) {
-            this.callbacks.fs.writeFileSync(artifacts.kmx.filename, artifacts.kmx.data);
-        }
-        if (artifacts.kvk) {
-            this.callbacks.fs.writeFileSync(artifacts.kvk.filename, artifacts.kvk.data);
-        }
-        if (artifacts.js) {
-            this.callbacks.fs.writeFileSync(artifacts.js.filename, artifacts.js.data);
-        }
-        return true;
-    }
-    /**
-     * @internal
-     * Construct or return a UnicodeSetParser, aka KmnCompiler
-     * @returns the held UnicodeSetParser
-     */
-    async getUsetParser() {
-        if (this.usetparser === undefined) {
-            // initialize
-            const compiler = new KmnCompiler();
-            const ok = await compiler.init(this.callbacks, null);
-            if (ok) {
-                this.usetparser = compiler;
-            }
-            else {
-                /* c8 ignore next 2 */
-                this.usetparser = null; // Store null on failure
-            }
-        }
-        return this.usetparser;
-    }
-    buildSections(source) {
-        return SECTION_COMPILERS.map(c => new c(source, this.callbacks));
-    }
-    /**
-     * @internal
-     * Loads a LDML Keyboard xml file and compiles into in-memory xml
-     * structures.
-     * @param filename - input filename, will use callback to load from disk
-     * @returns          the source file, or null if invalid
-     */
-    load(filename) {
-        const reader = new LDMLKeyboardXMLSourceFileReader(this.options.readerOptions, this.callbacks);
-        // load the file from disk into a string
-        const data = this.callbacks.loadFile(filename);
-        if (!data) {
-            this.callbacks.reportMessage(CompilerMessages.Error_InvalidFile({ errorText: 'Unable to read XML file' }));
-            return null;
-        }
-        // parse (load) the string into an object tree
-        const source = reader.load(data);
-        if (!source) {
-            this.callbacks.reportMessage(CompilerMessages.Error_InvalidFile({ errorText: 'Unable to load XML file' }));
-            return null;
-        }
-        try {
-            // validate the object tree against the .xsd schema
-            if (!reader.validate(source)) {
-                return null;
-            }
-        }
-        catch (e) {
-            this.callbacks.reportMessage(CompilerMessages.Error_InvalidFile({ errorText: e.toString() }));
-            return null;
-        }
-        return source;
-    }
-    /**
-     * @internal
-     * Loads a LDML Keyboard test data xml file and compiles into in-memory xml
-     * structures.
-     * @param filename - input filename, will use callback to load from disk
-     * @returns          the source file, or null if invalid
-     */
-    loadTestData(filename) {
-        const reader = new LDMLKeyboardXMLSourceFileReader(this.options.readerOptions, this.callbacks);
-        const data = this.callbacks.loadFile(filename);
-        if (!data) {
-            this.callbacks.reportMessage(CompilerMessages.Error_InvalidFile({ errorText: 'Unable to read XML file' }));
-            return null;
-        }
-        const source = reader.loadTestData(data);
-        /* c8 ignore next 4 */
-        if (!source) {
-            this.callbacks.reportMessage(CompilerMessages.Error_InvalidFile({ errorText: 'Unable to load XML file' }));
-            return null;
-        }
-        // TODO-LDML: The unboxed data doesn't match the schema anymore. Skipping validation, for now.
-        // try {
-        //   if (!reader.validate(source)) {
-        //     return null;
-        //   }
-        // } catch(e) {
-        //   this.callbacks.reportMessage(CompilerMessages.Error_InvalidFile({errorText: e.toString()}));
-        //   return null;
-        // }
-        return source;
-    }
-    /**
-     * @internal
-     * Validates that the LDML keyboard source file and lints. Actually just
-     * compiles the keyboard and returns `true` if everything is good...
-     * @param   source - in-memory representation of LDML keyboard xml file
-     * @returns          true if the file validates
-     */
-    async validate(source) {
-        return !!(await this.compile(source, true));
-    }
-    /**
-     * @internal
-     * Transforms in-memory LDML keyboard xml file to an intermediate
-     * representation of a .kmx file.
-     * @param   source - in-memory representation of LDML keyboard xml file
-     * @returns          KMXPlusFile intermediate file
-     */
-    async compile(source, postValidate) {
-        const sections = this.buildSections(source);
-        let passed = true;
-        const kmx = new KMXPlusFile();
-        for (let section of sections) {
-            if (!section.validate()) {
-                // TODO-LDML: coverage
-                passed = false;
-                // We'll keep validating other sections anyway, so we get a full set of
-                // errors for the keyboard developer.
-                continue;
-            }
-            // clone
-            const globalSections = Object.assign({}, kmx.kmxplus);
-            // pre-initialize the usetparser
-            globalSections.usetparser = await this.getUsetParser();
-            const dependencies = section.dependencies;
-            let dependencyProblem = false;
-            Object.keys(constants.section).forEach((sectstr) => {
-                const sectid = constants.section[sectstr];
-                if (dependencies.has(sectid)) {
-                    /* c8 ignore next 4 */
-                    if (!kmx.kmxplus[sectid]) {
-                        if (passed) {
-                            // Internal error useful during section bring-up
-                            throw new Error(`Internal error: section ${section.id} depends on uninitialized dependency ${sectid}, check ordering`);
-                        }
-                        else {
-                            dependencyProblem = true;
-                            return; // Already failed to validate, so no need for the layering message.
-                        }
-                    }
-                }
-                else {
-                    // delete dependencies that aren't referenced
-                    delete globalSections[sectid];
-                }
-            });
-            if (dependencyProblem && !passed) {
-                // Some layering problem, but we've already noted an error (!passed).
-                // Just skip this section.
-                continue;
-            }
-            const sect = section.compile(globalSections);
-            if (!sect) {
-                passed = false;
-                continue;
-            }
-            /* c8 ignore next 4 */
-            if (kmx.kmxplus[section.id]) {
-                // Internal error useful during section bring-up
-                throw new Error(`Internal error: section ${section.id} would be assigned twice`);
-            }
-            kmx.kmxplus[section.id] = sect;
-        }
-        // give all sections a chance to postValidate
-        if (postValidate) {
-            for (let section of sections) {
-                if (!section.postValidate(kmx.kmxplus[section.id])) {
-                    passed = false;
-                }
-            }
-        }
-        return passed ? kmx : null;
-    }
-}
-//# sourceMappingURL=compiler.js.map
-//# debugId=5183a68a-b994-5081-b881-0db8ef00163d
+import { LDMLKeyboardXMLSourceFileReader, KMXPlus, defaultCompilerOptions, KMXBuilder, KvkFileWriter } from '@keymanapp/common-types';
+import { CompilerMessages } from './messages.js';
+import { BkspCompiler, TranCompiler } from './tran.js';
+import { DispCompiler } from './disp.js';
+import { KeysCompiler } from './keys.js';
+import { LayrCompiler } from './layr.js';
+import { LocaCompiler } from './loca.js';
+import { MetaCompiler } from './meta.js';
+import { VarsCompiler } from './vars.js';
+import { StrsCompiler, ElemCompiler, ListCompiler, UsetCompiler } from './empty-compiler.js';
+var KMXPlusFile = KMXPlus.KMXPlusFile;
+import { constants } from '@keymanapp/ldml-keyboard-constants';
+import { KmnCompiler } from '@keymanapp/kmc-kmn';
+import { KMXPlusMetadataCompiler } from './metadata-compiler.js';
+import { LdmlKeyboardVisualKeyboardCompiler } from './visual-keyboard-compiler.js';
+//KMW17.0: import { LdmlKeyboardKeymanWebCompiler } from './keymanweb-compiler.js';
+export const SECTION_COMPILERS = [
+    // These are in dependency order.
+    // First the former 'global' sections
+    StrsCompiler,
+    // meta depends on strs, but potentially needed by anything else using strs
+    MetaCompiler,
+    ListCompiler,
+    ElemCompiler,
+    UsetCompiler,
+    // Next, Vars, which depends on others
+    VarsCompiler,
+    // Now all others:
+    BkspCompiler,
+    DispCompiler,
+    KeysCompiler,
+    LayrCompiler,
+    LocaCompiler,
+    TranCompiler,
+];
+;
+;
+/**
+ * @public
+ * Compiles a LDML keyboard .xml file to a .kmx (KMXPlus), .kvk, and/or .js. The
+ * compiler does not read or write from filesystem or network directly, but
+ * relies on callbacks for all external IO.
+ */
+export class LdmlKeyboardCompiler {
+    callbacks;
+    options;
+    // uset parser
+    usetparser = undefined;
+    /**
+     * Initialize the compiler, including loading the WASM host for uset parsing.
+     * Copies options.
+     * @param callbacks - Callbacks for external interfaces, including message
+     *                    reporting and file io
+     * @param options   - Compiler options
+     * @returns           false if initialization fails
+     */
+    async init(callbacks, options) {
+        this.options = { ...options };
+        this.callbacks = callbacks;
+        return true;
+    }
+    /**
+     * Compiles a LDML keyboard .xml file to .kmx, .kvk, and/or .js files. Returns
+     * an object containing binary artifacts on success. The files are passed in
+     * by name, and the compiler will use callbacks as passed to the
+     * {@link LdmlKeyboardCompiler.init} function to read any input files by disk.
+     * @param infile  - Path to source file.
+     * @param outfile - Path to output file. The file will not be written to, but
+     *                  will be included in the result for use by
+     *                  {@link LdmlKeyboardCompiler.write}.
+     * @returns         Binary artifacts on success, null on failure.
+     */
+    async run(inputFilename, outputFilename) {
+        let compilerOptions = {
+            ...defaultCompilerOptions,
+            ...this.options,
+        };
+        let source = this.load(inputFilename);
+        if (!source) {
+            return null;
+        }
+        let kmx = await this.compile(source);
+        if (!kmx) {
+            return null;
+        }
+        // In order for the KMX file to be loaded by non-KMXPlus components, it is helpful
+        // to duplicate some of the metadata
+        KMXPlusMetadataCompiler.addKmxMetadata(kmx.kmxplus, kmx.keyboard, compilerOptions);
+        // Use the builder to generate the binary output file
+        const builder = new KMXBuilder(kmx, compilerOptions.saveDebug);
+        const kmx_binary = builder.compile();
+        const vkcompiler = new LdmlKeyboardVisualKeyboardCompiler(this.callbacks);
+        const vk = vkcompiler.compile(source);
+        const writer = new KvkFileWriter();
+        const kvk_binary = writer.write(vk);
+        // Note: we could have a step of generating source files here
+        // KvksFileWriter()...
+        // const tlcompiler = new kmc.TouchLayoutCompiler();
+        // const tl = tlcompiler.compile(source);
+        // const tlwriter = new TouchLayoutFileWriter();
+        //KMW17.0: const kmwcompiler = new LdmlKeyboardKeymanWebCompiler(this.callbacks, compilerOptions);
+        //KMW17.0: const kmw_string = kmwcompiler.compile(inputFilename, source);
+        //KMW17.0: const encoder = new TextEncoder();
+        //KMW17.0: const kmw_binary = encoder.encode(kmw_string);
+        outputFilename = outputFilename ?? inputFilename.replace(/\.xml$/, '.kmx');
+        return {
+            artifacts: {
+                kmx: { data: kmx_binary, filename: outputFilename },
+                kvk: { data: kvk_binary, filename: outputFilename.replace(/\.kmx$/, '.kvk') },
+                //KMW17.0: js: { data: kmw_binary, filename: outputFilename.replace(/\.kmx$/, '.js') },
+            }
+        };
+    }
+    /**
+     * Write artifacts from a successful compile to disk, via callbacks methods.
+     * The artifacts written may include:
+     *
+     * - .kmx file - binary keyboard used by Keyman on desktop platforms
+     * - .kvk file - binary on screen keyboard used by Keyman on desktop platforms
+     * - .js file - Javascript keyboard for web and touch platforms
+     *
+     * @param artifacts - object containing artifact binary data to write out
+     * @returns true on success
+     */
+    async write(artifacts) {
+        if (artifacts.kmx) {
+            this.callbacks.fs.writeFileSync(artifacts.kmx.filename, artifacts.kmx.data);
+        }
+        if (artifacts.kvk) {
+            this.callbacks.fs.writeFileSync(artifacts.kvk.filename, artifacts.kvk.data);
+        }
+        if (artifacts.js) {
+            this.callbacks.fs.writeFileSync(artifacts.js.filename, artifacts.js.data);
+        }
+        return true;
+    }
+    /**
+     * @internal
+     * Construct or return a UnicodeSetParser, aka KmnCompiler
+     * @returns the held UnicodeSetParser
+     */
+    async getUsetParser() {
+        if (this.usetparser === undefined) {
+            // initialize
+            const compiler = new KmnCompiler();
+            const ok = await compiler.init(this.callbacks, null);
+            if (ok) {
+                this.usetparser = compiler;
+            }
+            else {
+                /* c8 ignore next 2 */
+                this.usetparser = null; // Store null on failure
+            }
+        }
+        return this.usetparser;
+    }
+    buildSections(source) {
+        return SECTION_COMPILERS.map(c => new c(source, this.callbacks));
+    }
+    /**
+     * @internal
+     * Loads a LDML Keyboard xml file and compiles into in-memory xml
+     * structures.
+     * @param filename - input filename, will use callback to load from disk
+     * @returns          the source file, or null if invalid
+     */
+    load(filename) {
+        const reader = new LDMLKeyboardXMLSourceFileReader(this.options.readerOptions, this.callbacks);
+        // load the file from disk into a string
+        const data = this.callbacks.loadFile(filename);
+        if (!data) {
+            this.callbacks.reportMessage(CompilerMessages.Error_InvalidFile({ errorText: 'Unable to read XML file' }));
+            return null;
+        }
+        // parse (load) the string into an object tree
+        const source = reader.load(data);
+        if (!source) {
+            this.callbacks.reportMessage(CompilerMessages.Error_InvalidFile({ errorText: 'Unable to load XML file' }));
+            return null;
+        }
+        try {
+            // validate the object tree against the .xsd schema
+            if (!reader.validate(source)) {
+                return null;
+            }
+        }
+        catch (e) {
+            this.callbacks.reportMessage(CompilerMessages.Error_InvalidFile({ errorText: e.toString() }));
+            return null;
+        }
+        return source;
+    }
+    /**
+     * @internal
+     * Loads a LDML Keyboard test data xml file and compiles into in-memory xml
+     * structures.
+     * @param filename - input filename, will use callback to load from disk
+     * @returns          the source file, or null if invalid
+     */
+    loadTestData(filename) {
+        const reader = new LDMLKeyboardXMLSourceFileReader(this.options.readerOptions, this.callbacks);
+        const data = this.callbacks.loadFile(filename);
+        if (!data) {
+            this.callbacks.reportMessage(CompilerMessages.Error_InvalidFile({ errorText: 'Unable to read XML file' }));
+            return null;
+        }
+        const source = reader.loadTestData(data);
+        /* c8 ignore next 4 */
+        if (!source) {
+            this.callbacks.reportMessage(CompilerMessages.Error_InvalidFile({ errorText: 'Unable to load XML file' }));
+            return null;
+        }
+        // TODO-LDML: The unboxed data doesn't match the schema anymore. Skipping validation, for now.
+        // try {
+        //   if (!reader.validate(source)) {
+        //     return null;
+        //   }
+        // } catch(e) {
+        //   this.callbacks.reportMessage(CompilerMessages.Error_InvalidFile({errorText: e.toString()}));
+        //   return null;
+        // }
+        return source;
+    }
+    /**
+     * @internal
+     * Validates that the LDML keyboard source file and lints. Actually just
+     * compiles the keyboard and returns `true` if everything is good...
+     * @param   source - in-memory representation of LDML keyboard xml file
+     * @returns          true if the file validates
+     */
+    async validate(source) {
+        return !!(await this.compile(source, true));
+    }
+    /**
+     * @internal
+     * Transforms in-memory LDML keyboard xml file to an intermediate
+     * representation of a .kmx file.
+     * @param   source - in-memory representation of LDML keyboard xml file
+     * @returns          KMXPlusFile intermediate file
+     */
+    async compile(source, postValidate) {
+        const sections = this.buildSections(source);
+        let passed = true;
+        const kmx = new KMXPlusFile();
+        for (let section of sections) {
+            if (!section.validate()) {
+                // TODO-LDML: coverage
+                passed = false;
+                // We'll keep validating other sections anyway, so we get a full set of
+                // errors for the keyboard developer.
+                continue;
+            }
+            // clone
+            const globalSections = Object.assign({}, kmx.kmxplus);
+            // pre-initialize the usetparser
+            globalSections.usetparser = await this.getUsetParser();
+            const dependencies = section.dependencies;
+            let dependencyProblem = false;
+            Object.keys(constants.section).forEach((sectstr) => {
+                const sectid = constants.section[sectstr];
+                if (dependencies.has(sectid)) {
+                    /* c8 ignore next 4 */
+                    if (!kmx.kmxplus[sectid]) {
+                        if (passed) {
+                            // Internal error useful during section bring-up
+                            throw new Error(`Internal error: section ${section.id} depends on uninitialized dependency ${sectid}, check ordering`);
+                        }
+                        else {
+                            dependencyProblem = true;
+                            return; // Already failed to validate, so no need for the layering message.
+                        }
+                    }
+                }
+                else {
+                    // delete dependencies that aren't referenced
+                    delete globalSections[sectid];
+                }
+            });
+            if (dependencyProblem && !passed) {
+                // Some layering problem, but we've already noted an error (!passed).
+                // Just skip this section.
+                continue;
+            }
+            const sect = section.compile(globalSections);
+            if (!sect) {
+                passed = false;
+                continue;
+            }
+            /* c8 ignore next 4 */
+            if (kmx.kmxplus[section.id]) {
+                // Internal error useful during section bring-up
+                throw new Error(`Internal error: section ${section.id} would be assigned twice`);
+            }
+            kmx.kmxplus[section.id] = sect;
+        }
+        // give all sections a chance to postValidate
+        if (postValidate) {
+            for (let section of sections) {
+                if (!section.postValidate(kmx.kmxplus[section.id])) {
+                    passed = false;
+                }
+            }
+        }
+        return passed ? kmx : null;
+    }
+}
+//# sourceMappingURL=compiler.js.map