@keymanapp/ldml-keyboard-constants 17.0.87-alpha

package/build/keyboardprocessor_ldml.d.ts

@@ -0,0 +1,377 @@
+/**
+ * Defines the section identifiers and ensures that we include each and every
+ * one of them in the `sections` block and gives us a type which we can iterate
+ * through.
+ */
+export type SectionIdent = 'sect' | 'bksp' | 'disp' | 'elem' | 'finl' | 'keys' | 'layr' | 'list' | 'loca' | 'meta' | 'name' | 'ordr' | 'strs' | 'tran' | 'vkey';
+type SectionMap = {
+    [id in SectionIdent]: SectionIdent;
+};
+/**
+ * Constants for the KMXPlus data format
+ * These are shared between the data access layer and the compiler.
+ * Note that the section IDs (section_keys etc.) are 32 bit hex
+ * values that are designed to appear as text when written in little endian
+ * format, so 0x7379656b = 'keys'
+ */
+declare class Constants {
+    /**
+     * The version of the LDML processor
+     */
+    readonly version = "1.0";
+    /**
+     * The techpreview CLDR version
+     */
+    readonly cldr_version_techpreview = "techpreview";
+    /**
+     * The latest CLDR version
+     */
+    readonly cldr_version_latest = "techpreview";
+    /**
+     * import base
+     */
+    readonly cldr_import_base = "cldr";
+    /**
+     * implied keys file
+     */
+    readonly cldr_implied_keys_import: string;
+    /**
+     * Length of a raw section header, in bytes
+     */
+    readonly length_header = 8;
+    /**
+     * Minimum length of the 'sect' section, not including entries
+     */
+    readonly length_sect = 16;
+    /**
+     *  Length of each item in the 'sect' section variable part
+     */
+    readonly length_sect_item = 8;
+    /**
+     * Minimum length of the 'bksp' section, not including entries
+     */
+    readonly length_bksp = 12;
+    /**
+     *  Length of each item in the 'bksp' section variable part
+     */
+    readonly length_bksp_item = 16;
+    /**
+     * bitwise or value for error="fail" in transform
+     */
+    readonly bksp_flags_error = 1;
+    /**
+     * Minimum length of the 'disp' section, not including entries
+     */
+    readonly length_disp = 16;
+    /**
+     *  Length of each entry in the 'disp' variable part
+     */
+    readonly length_disp_item = 8;
+    /**
+     * Minimum length of the 'elem' section, not including entries
+     */
+    readonly length_elem = 12;
+    /**
+     *  Length of each elem string in the 'elem' section variable part
+     */
+    readonly length_elem_item = 8;
+    /**
+     * Length of each element in an elem string
+     */
+    readonly length_elem_item_element = 8;
+    /**
+     * bitwise or value for unicode_set in elem[elemstr][element].flags.
+     * If bit is 1, then 'element' is a UnicodeSet string.
+     * If bit is 0, then 'element' is a UTF-32LE codepoint
+     *
+     * `unicode_set = flags & elem_flags_unicode_set`
+     */
+    readonly elem_flags_unicode_set = 1;
+    /**
+     * bitwise or value for tertiary_base in elem[elemstr][element].flags.
+     * If bit is 1, then tertiary_base is true.
+     * If bit is 0, then tertiary_base is false.
+     *
+     * Used only for `ordr`-type element strings.
+     *
+     * `tertiary_base = flags & elem_flags_tertiary_base`
+     */
+    readonly elem_flags_tertiary_base = 2;
+    /**
+     * bitwise or value for tertiary_base in elem[elemstr][element].flags.
+     * If bit is 1, then prebase is true.
+     * If bit is 0, then prebase is false.
+     *
+     * Used only for `ordr`-type element strings.
+     *
+     * `prebase = flags & elem_flags_prebase`
+     */
+    readonly elem_flags_prebase = 4;
+    /**
+     * bitwise mask for order in elem[elemstr][element].flags.
+     *
+     * Used only for `ordr`-type element strings. 1 byte signed integer.
+     *
+     * `order = (flags & elem_flags_order_mask) >> elem_flags_order_bitshift`
+     */
+    readonly elem_flags_order_mask = 16711680;
+    /**
+     * bit shift for order in elem[elemstr][element].flags.
+     *
+     * Used only for `ordr`-type element strings.
+     *
+     * `order = (flags & elem_flags_order_mask) >> elem_flags_order_bitshift`
+     */
+    readonly elem_flags_order_bitshift = 16;
+    /**
+     * bitwise mask for tertiary sort in elem[elemstr][element].flags.
+     *
+     * Used only for `ordr`-type element strings. 1 byte signed integer.
+     *
+     * `tertiary = (flags & elem_flags_tertiary_mask) >> elem_flags_tertiary_bitshift`
+     */
+    readonly elem_flags_tertiary_mask = 4278190080;
+    /**
+     * bit shift for tertiary sort in elem[elemstr][element].flags.
+     *
+     * Used only for `ordr`-type element strings. 1 byte signed integer.
+     *
+     * `order = (flags & elem_flags_tertiary_mask) >> elem_flags_tertiary_bitshift`
+     */
+    readonly elem_flags_tertiary_bitshift = 24;
+    /**
+     * Minimum length of the 'finl' section, not including entries
+     */
+    readonly length_finl = 8;
+    /**
+     *  Length of each item in the 'finl' section variable part
+     */
+    readonly length_finl_item = 16;
+    /**
+     * bitwise or value for error="fail" in transform
+     */
+    readonly finl_flags_error = 1;
+    /**
+     * Constant for no modifiers
+     */
+    readonly keys_mod_none = 0;
+    /**
+     * bitmask for Left Alt modifier key
+     */
+    readonly keys_mod_altL = 4;
+    /**
+     * bitmask for Right Alt (AltGr) modifier key
+     */
+    readonly keys_mod_altR = 8;
+    /**
+     * bitmask for either Alt (Windows) or Option (Apple) modifier keys
+     */
+    readonly keys_mod_alt = 64;
+    /**
+     * bitmask for Caps modifier key
+     */
+    readonly keys_mod_caps = 256;
+    /**
+     * bitmask for Left control modifier key
+     */
+    readonly keys_mod_ctrlL = 1;
+    /**
+     * bitmask for Right control modifier key
+     */
+    readonly keys_mod_ctrlR = 2;
+    /**
+     * bitmask for either Control modifier key
+     */
+    readonly keys_mod_ctrl = 32;
+    /**
+     * bitmask for either shift.
+     */
+    readonly keys_mod_shift = 16;
+    /**
+     * Convenience map for modifiers
+     */
+    readonly keys_mod_map: Map<string, number>;
+    /**
+     * a mask combining all valid modifier bits
+     */
+    readonly keys_mod_all: number;
+    /**
+     * Minimum length of the 'keys' section not including variable parts
+     */
+    readonly length_keys = 24;
+    /**
+     *  Length of each item in the 'keys' keys sub-table
+     */
+    readonly length_keys_key = 36;
+    /**
+     *  Length of each item in the 'keys' flick lists sub-table
+     */
+    readonly length_keys_flick_list = 12;
+    /**
+     *  Length of each item in the 'keys' flick elements sub-table
+     */
+    readonly length_keys_flick_element = 12;
+    /**
+     * Length of each item in the 'keys.kmap' key map subtable
+     */
+    readonly length_keys_kmap = 12;
+    /**
+     * 0 if to is a char, 1 if it is a string
+     */
+    readonly keys_key_flags_extend = 1;
+    /**
+     * 1 if the key is a gap
+     */
+    readonly keys_key_flags_gap = 2;
+    /**
+     * 1 if the key is transform=no
+     */
+    readonly keys_key_flags_notransform = 4;
+    /**
+     * 0 if to is a char, 1 if it is a string
+     */
+    readonly keys_flick_flags_extend = 1;
+    /**
+     * Minimum length of the 'layr' section not including variable parts
+     */
+    readonly length_layr = 24;
+    /**
+     *  Length of each layer list in the 'layr' section variable part
+     */
+    readonly length_layr_list = 16;
+    /**
+     * for the 'hardware' field indicating a touch keyboard, non-hardware
+     */
+    readonly layr_list_hardware_touch = 0;
+    /**
+     * for the 'hardware' field indicating an abnt2 layout
+     */
+    readonly layr_list_hardware_abnt2 = 1;
+    /**
+     * for the 'hardware' field indicating an iso layout
+     */
+    readonly layr_list_hardware_iso = 2;
+    /**
+     * for the 'hardware' field indicating a jis layout
+     */
+    readonly layr_list_hardware_jis = 3;
+    /**
+     * for the 'hardware' field indicating a us layout
+     */
+    readonly layr_list_hardware_us = 4;
+    /**
+     * Convenience map of layr_list_hardware field values
+     */
+    readonly layr_list_hardware_map: Map<String, number>;
+    /**
+     * Length of each layer entry in the 'layr' section variable part
+     */
+    readonly length_layr_entry = 16;
+    /**
+     * Length of each row entry in the 'layr' section variable part
+     */
+    readonly length_layr_row = 8;
+    /**
+     * Length of each key entry in the 'layr' section variable part
+     */
+    readonly length_layr_key = 4;
+    /**
+     * Minimum length of the 'list' section not including variable parts
+     */
+    readonly length_list = 16;
+    /**
+     *  Length of each list item in the 'list' list section variable part
+     */
+    readonly length_list_item = 8;
+    /**
+     *  Length of each list item in the 'list' indices section variable part
+     */
+    readonly length_list_index = 4;
+    /**
+     * Minimum length of the 'loca' section not including variable parts
+     */
+    readonly length_loca = 12;
+    /**
+     *  Length of each item in the 'loca' section variable part
+     */
+    readonly length_loca_item = 4;
+    /**
+     * length of the 'meta' section
+     */
+    readonly length_meta = 36;
+    /**
+     * bitwise or value for fallback=omit in meta.settings
+     */
+    readonly meta_settings_fallback_omit = 1;
+    /**
+     * bitwise or value for transformFailure=omit in meta.settings
+     */
+    readonly meta_settings_transformFailure_omit = 2;
+    /**
+     * bitwise or value for transformPartial=hide in meta.settings
+     */
+    readonly meta_settings_transformPartial_hide = 4;
+    /**
+     * Minimum length of the 'name' section not including variable parts
+     */
+    readonly length_name = 12;
+    /**
+     *  Length of each item in the 'name' section variable part
+     */
+    readonly length_name_item = 4;
+    /**
+     * Minimum length of the 'ordr' section, not including entries
+     */
+    readonly length_ordr = 12;
+    /**
+     *  Length of each item in the 'ordr' section variable part
+     */
+    readonly length_ordr_item = 8;
+    /**
+     * Minimum length of the 'strs' section not including variable parts
+     */
+    readonly length_strs = 12;
+    /**
+     * Length of each item in the 'strs' section variable part
+     */
+    readonly length_strs_item = 8;
+    /**
+     * Minimum length of the 'tran' section, not including entries
+     */
+    readonly length_tran = 12;
+    /**
+     *  Length of each item in the 'tran' section variable part
+     */
+    readonly length_tran_item = 16;
+    /**
+     * bitwise or value for error="fail" in transform
+     */
+    readonly tran_flags_error = 1;
+    /**
+     * Minimum length of the 'vkey' section not including variable parts
+     */
+    readonly length_vkey = 12;
+    /**
+     *  Length of each item in the 'vkey' section variable part
+     */
+    readonly length_vkey_item = 8;
+    /**
+     * All section IDs.
+     */
+    readonly section: SectionMap;
+    /**
+     * Use to convert 4-char string into hex
+     * @param id section id such as 'sect'
+     * @returns hex ID such as 0x74636573
+     */
+    hex_section_id(id: string): number;
+    /**
+     * Use to convert hex into 4-char string
+     * @param hex section ID such as 0x74636573
+     * @returns string such as 'sect'
+     */
+    str_section_id(hex: number): string;
+}
+export declare const constants: Constants;
+export {};
+//# sourceMappingURL=keyboardprocessor_ldml.d.ts.map

package/build/keyboardprocessor_ldml.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyboardprocessor_ldml.d.ts","sourceRoot":"","sources":["../keyboardprocessor_ldml.ts"],"names":[],"mappings":"AAmBA;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAEtB,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,CAAC;AAGT,KAAK,UAAU,GAAG;KACf,EAAE,IAAI,YAAY,GAAG,YAAY;CACnC,CAAA;AAGD;;;;;;GAMG;AACH,cAAM,SAAS;IACb;;OAEG;IACH,QAAQ,CAAC,OAAO,SAAS;IACzB;;OAEG;IACH,QAAQ,CAAC,wBAAwB,iBAAiB;IAClD;;OAEG;IACH,QAAQ,CAAC,mBAAmB,iBAAiC;IAC7D;;OAEG;IACH,QAAQ,CAAC,gBAAgB,UAAU;IACnC;;OAEG;IACH,QAAQ,CAAC,wBAAwB,SAA4D;IAC7F;;OAEG;IACH,QAAQ,CAAC,aAAa,KAAK;IAM3B;;OAEG;IACH,QAAQ,CAAC,WAAW,MAAM;IAC1B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,KAAK;IAM9B;;OAEG;IACH,QAAQ,CAAC,WAAW,MAAM;IAC1B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,MAAM;IAC/B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,KAAU;IAMnC;;OAEG;IACF,QAAQ,CAAC,WAAW,MAAM;IAC1B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,KAAK;IAM/B;;OAEG;IACH,QAAQ,CAAC,WAAW,MAAM;IAC1B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,KAAK;IAC9B;;OAEG;IACH,QAAQ,CAAC,wBAAwB,KAAK;IAEtC;;;;;;OAMG;IACH,QAAQ,CAAC,sBAAsB,KAAc;IAE7C;;;;;;;;OAQG;IACH,QAAQ,CAAC,wBAAwB,KAAc;IAE/C;;;;;;;;OAQG;IACH,QAAQ,CAAC,kBAAkB,KAAc;IAEzC;;;;;;OAMG;IACH,QAAQ,CAAC,qBAAqB,YAAc;IAE5C;;;;;;OAMG;IACH,QAAQ,CAAC,yBAAyB,MAAM;IAExC;;;;;;OAMG;IACH,QAAQ,CAAC,wBAAwB,cAAc;IAE/C;;;;;;OAMG;IACH,QAAQ,CAAC,4BAA4B,MAAM;IAM3C;;OAEG;IACH,QAAQ,CAAC,WAAW,KAAK;IACzB;;OAEG;IACH,QAAQ,CAAC,gBAAgB,MAAM;IAC/B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,KAAU;IAMnC;;OAEG;IACH,QAAQ,CAAC,aAAa,KAAU;IAChC;;OAEG;IACH,QAAQ,CAAC,aAAa,KAAU;IAChC;;OAEG;IACH,QAAQ,CAAC,aAAa,KAAU;IAChC;;OAEG;IACH,QAAQ,CAAC,YAAY,MAAW;IAChC;;OAEG;IACH,QAAQ,CAAC,aAAa,OAAU;IAChC;;OAEG;IACH,QAAQ,CAAC,cAAc,KAAU;IACjC;;OAEG;IACH,QAAQ,CAAC,cAAc,KAAU;IACjC;;OAEG;IACH,QAAQ,CAAC,aAAa,MAAU;IAChC;;OAEG;IACH,QAAQ,CAAC,cAAc,MAAU;IAEjC;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAYxC;IAEF;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAwF;IAMrH;;OAEG;IACH,QAAQ,CAAC,WAAW,MAAM;IAC1B;;OAEG;IACH,QAAQ,CAAC,eAAe,MAAM;IAC9B;;OAEG;IACH,QAAQ,CAAC,sBAAsB,MAAM;IACrC;;OAEG;IACH,QAAQ,CAAC,yBAAyB,MAAM;IACxC;;OAEG;IACH,QAAQ,CAAC,gBAAgB,MAAM;IAE/B;;OAEG;IACH,QAAQ,CAAC,qBAAqB,KAAmB;IAEjD;;OAEG;IACH,QAAQ,CAAC,kBAAkB,KAAsB;IAEjD;;OAEG;IACH,QAAQ,CAAC,0BAA0B,KAAc;IAEjD;;OAEG;IACH,QAAQ,CAAC,uBAAuB,KAAmB;IAMnD;;OAEG;IACH,QAAQ,CAAC,WAAW,MAAM;IAC1B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,MAAM;IAC/B;;OAEG;IACH,QAAQ,CAAC,wBAAwB,KAAK;IACtC;;OAEG;IACH,QAAQ,CAAC,wBAAwB,KAAK;IACtC;;OAEG;IACH,QAAQ,CAAC,sBAAsB,KAAK;IACpC;;OAEG;IACH,QAAQ,CAAC,sBAAsB,KAAK;IACpC;;OAEG;IACH,QAAQ,CAAC,qBAAqB,KAAK;IACnC;;OAEG;IACH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAQlD;IACF;;OAEG;IACH,QAAQ,CAAC,iBAAiB,MAAM;IAChC;;OAEG;IACH,QAAQ,CAAC,eAAe,KAAK;IAC7B;;OAEG;IACH,QAAQ,CAAC,eAAe,KAAK;IAM7B;;OAEG;IACH,QAAQ,CAAC,WAAW,MAAM;IAC1B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,KAAK;IAC9B;;OAEG;IACF,QAAQ,CAAC,iBAAiB,KAAK;IAMhC;;OAEG;IACH,QAAQ,CAAC,WAAW,MAAM;IAC1B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,KAAK;IAM9B;;OAEG;IACH,QAAQ,CAAC,WAAW,MAAM;IAC1B;;OAEG;IACH,QAAQ,CAAC,2BAA2B,KAAK;IACzC;;OAEG;IACH,QAAQ,CAAC,mCAAmC,KAAK;IACjD;;OAEG;IACH,QAAQ,CAAC,mCAAmC,KAAK;IAMjD;;OAEG;IACH,QAAQ,CAAC,WAAW,MAAM;IAC1B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,KAAK;IAM9B;;OAEG;IACH,QAAQ,CAAC,WAAW,MAAM;IAC1B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,KAAK;IAM9B;;OAEG;IACH,QAAQ,CAAC,WAAW,MAAM;IAC1B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,KAAK;IAM9B;;OAEG;IACH,QAAQ,CAAC,WAAW,MAAM;IAC1B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,MAAM;IAC/B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,KAAU;IAMnC;;OAEG;IACH,QAAQ,CAAC,WAAW,MAAM;IAC1B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,KAAK;IAE9B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,UAAU,CAiB1B;IAEF;;;;OAIG;IACH,cAAc,CAAC,EAAE,EAAC,MAAM;IAWxB;;;;OAIG;IACH,cAAc,CAAC,GAAG,EAAC,MAAM,GAAI,MAAM;CAQpC;AAED,eAAO,MAAM,SAAS,WAAkB,CAAC"}

package/build/keyboardprocessor_ldml.js

@@ -0,0 +1,476 @@
+/*
+  Copyright:        Copyright (C) 2022 SIL International.
+  Authors:          srl295, mcdurdin
+  This file provides constants for the KMX Plus (LDML support) binary format,
+  to be shared between TypeScript and C++ via the generator (below)
+*/
+// TODO-LDML: namespace com.keyman.core.ldml {
+/**
+ * Constants for the KMXPlus data format
+ * These are shared between the data access layer and the compiler.
+ * Note that the section IDs (section_keys etc.) are 32 bit hex
+ * values that are designed to appear as text when written in little endian
+ * format, so 0x7379656b = 'keys'
+ */
+var Constants = /** @class */ (function () {
+    function Constants() {
+        /**
+         * The version of the LDML processor
+         */
+        this.version = '1.0';
+        /**
+         * The techpreview CLDR version
+         */
+        this.cldr_version_techpreview = 'techpreview';
+        /**
+         * The latest CLDR version
+         */
+        this.cldr_version_latest = this.cldr_version_techpreview;
+        /**
+         * import base
+         */
+        this.cldr_import_base = 'cldr';
+        /**
+         * implied keys file
+         */
+        this.cldr_implied_keys_import = "".concat(this.cldr_version_techpreview, "/keys-Latn-implied.xml");
+        /**
+         * Length of a raw section header, in bytes
+         */
+        this.length_header = 8;
+        /* ------------------------------------------------------------------
+          * sect section
+            ------------------------------------------------------------------ */
+        /**
+         * Minimum length of the 'sect' section, not including entries
+         */
+        this.length_sect = 16;
+        /**
+         *  Length of each item in the 'sect' section variable part
+         */
+        this.length_sect_item = 8;
+        /* ------------------------------------------------------------------
+          * bksp section
+            ------------------------------------------------------------------ */
+        /**
+         * Minimum length of the 'bksp' section, not including entries
+         */
+        this.length_bksp = 12;
+        /**
+         *  Length of each item in the 'bksp' section variable part
+         */
+        this.length_bksp_item = 16;
+        /**
+         * bitwise or value for error="fail" in transform
+         */
+        this.bksp_flags_error = 0x0001;
+        /* ------------------------------------------------------------------
+          * disp section
+            ------------------------------------------------------------------ */
+        /**
+         * Minimum length of the 'disp' section, not including entries
+         */
+        this.length_disp = 16;
+        /**
+         *  Length of each entry in the 'disp' variable part
+         */
+        this.length_disp_item = 8;
+        /* ------------------------------------------------------------------
+          * elem section
+            ------------------------------------------------------------------ */
+        /**
+         * Minimum length of the 'elem' section, not including entries
+         */
+        this.length_elem = 12;
+        /**
+         *  Length of each elem string in the 'elem' section variable part
+         */
+        this.length_elem_item = 8;
+        /**
+         * Length of each element in an elem string
+         */
+        this.length_elem_item_element = 8;
+        /**
+         * bitwise or value for unicode_set in elem[elemstr][element].flags.
+         * If bit is 1, then 'element' is a UnicodeSet string.
+         * If bit is 0, then 'element' is a UTF-32LE codepoint
+         *
+         * `unicode_set = flags & elem_flags_unicode_set`
+         */
+        this.elem_flags_unicode_set = 0x00000001;
+        /**
+         * bitwise or value for tertiary_base in elem[elemstr][element].flags.
+         * If bit is 1, then tertiary_base is true.
+         * If bit is 0, then tertiary_base is false.
+         *
+         * Used only for `ordr`-type element strings.
+         *
+         * `tertiary_base = flags & elem_flags_tertiary_base`
+         */
+        this.elem_flags_tertiary_base = 0x00000002;
+        /**
+         * bitwise or value for tertiary_base in elem[elemstr][element].flags.
+         * If bit is 1, then prebase is true.
+         * If bit is 0, then prebase is false.
+         *
+         * Used only for `ordr`-type element strings.
+         *
+         * `prebase = flags & elem_flags_prebase`
+         */
+        this.elem_flags_prebase = 0x00000004;
+        /**
+         * bitwise mask for order in elem[elemstr][element].flags.
+         *
+         * Used only for `ordr`-type element strings. 1 byte signed integer.
+         *
+         * `order = (flags & elem_flags_order_mask) >> elem_flags_order_bitshift`
+         */
+        this.elem_flags_order_mask = 0x00FF0000;
+        /**
+         * bit shift for order in elem[elemstr][element].flags.
+         *
+         * Used only for `ordr`-type element strings.
+         *
+         * `order = (flags & elem_flags_order_mask) >> elem_flags_order_bitshift`
+         */
+        this.elem_flags_order_bitshift = 16;
+        /**
+         * bitwise mask for tertiary sort in elem[elemstr][element].flags.
+         *
+         * Used only for `ordr`-type element strings. 1 byte signed integer.
+         *
+         * `tertiary = (flags & elem_flags_tertiary_mask) >> elem_flags_tertiary_bitshift`
+         */
+        this.elem_flags_tertiary_mask = 0xFF000000;
+        /**
+         * bit shift for tertiary sort in elem[elemstr][element].flags.
+         *
+         * Used only for `ordr`-type element strings. 1 byte signed integer.
+         *
+         * `order = (flags & elem_flags_tertiary_mask) >> elem_flags_tertiary_bitshift`
+         */
+        this.elem_flags_tertiary_bitshift = 24;
+        /* ------------------------------------------------------------------
+          * finl section
+            ------------------------------------------------------------------ */
+        /**
+         * Minimum length of the 'finl' section, not including entries
+         */
+        this.length_finl = 8;
+        /**
+         *  Length of each item in the 'finl' section variable part
+         */
+        this.length_finl_item = 16;
+        /**
+         * bitwise or value for error="fail" in transform
+         */
+        this.finl_flags_error = 0x0001;
+        /* ------------------------------------------------------------------
+          * keys section is now keys.kmap
+            ------------------------------------------------------------------ */
+        /**
+         * Constant for no modifiers
+         */
+        this.keys_mod_none = 0x0000;
+        /**
+         * bitmask for Left Alt modifier key
+         */
+        this.keys_mod_altL = 0x0004;
+        /**
+         * bitmask for Right Alt (AltGr) modifier key
+         */
+        this.keys_mod_altR = 0x0008;
+        /**
+         * bitmask for either Alt (Windows) or Option (Apple) modifier keys
+         */
+        this.keys_mod_alt = 0x0040;
+        /**
+         * bitmask for Caps modifier key
+         */
+        this.keys_mod_caps = 0x0100;
+        /**
+         * bitmask for Left control modifier key
+         */
+        this.keys_mod_ctrlL = 0x0001;
+        /**
+         * bitmask for Right control modifier key
+         */
+        this.keys_mod_ctrlR = 0x0002;
+        /**
+         * bitmask for either Control modifier key
+         */
+        this.keys_mod_ctrl = 0x0020;
+        /**
+         * bitmask for either shift.
+         */
+        this.keys_mod_shift = 0x0010;
+        /**
+         * Convenience map for modifiers
+         */
+        this.keys_mod_map = new Map([
+            ["none", this.keys_mod_none],
+            ["alt", this.keys_mod_alt],
+            ["altL", this.keys_mod_altL],
+            ["altR", this.keys_mod_altR],
+            ["caps", this.keys_mod_caps],
+            ["ctrl", this.keys_mod_ctrl],
+            ["ctrlL", this.keys_mod_ctrlL],
+            ["ctrlR", this.keys_mod_ctrlR],
+            ["shift", this.keys_mod_shift],
+        ]);
+        /**
+         * a mask combining all valid modifier bits
+         */
+        this.keys_mod_all = Array.from(this.keys_mod_map.values()).reduce(function (p, v) { return (p | v); }, this.keys_mod_none);
+        /* ------------------------------------------------------------------
+         * keys section
+          ------------------------------------------------------------------ */
+        /**
+         * Minimum length of the 'keys' section not including variable parts
+         */
+        this.length_keys = 24;
+        /**
+         *  Length of each item in the 'keys' keys sub-table
+         */
+        this.length_keys_key = 36;
+        /**
+         *  Length of each item in the 'keys' flick lists sub-table
+         */
+        this.length_keys_flick_list = 12;
+        /**
+         *  Length of each item in the 'keys' flick elements sub-table
+         */
+        this.length_keys_flick_element = 12;
+        /**
+         * Length of each item in the 'keys.kmap' key map subtable
+         */
+        this.length_keys_kmap = 12;
+        /**
+         * 0 if to is a char, 1 if it is a string
+         */
+        this.keys_key_flags_extend = 0x00000001;
+        /**
+         * 1 if the key is a gap
+         */
+        this.keys_key_flags_gap = 0x00000002;
+        /**
+         * 1 if the key is transform=no
+         */
+        this.keys_key_flags_notransform = 0x00000004;
+        /**
+         * 0 if to is a char, 1 if it is a string
+         */
+        this.keys_flick_flags_extend = 0x00000001;
+        /* ------------------------------------------------------------------
+         * layr section
+           ------------------------------------------------------------------ */
+        /**
+         * Minimum length of the 'layr' section not including variable parts
+         */
+        this.length_layr = 24;
+        /**
+         *  Length of each layer list in the 'layr' section variable part
+         */
+        this.length_layr_list = 16;
+        /**
+         * for the 'hardware' field indicating a touch keyboard, non-hardware
+         */
+        this.layr_list_hardware_touch = 0;
+        /**
+         * for the 'hardware' field indicating an abnt2 layout
+         */
+        this.layr_list_hardware_abnt2 = 1;
+        /**
+         * for the 'hardware' field indicating an iso layout
+         */
+        this.layr_list_hardware_iso = 2;
+        /**
+         * for the 'hardware' field indicating a jis layout
+         */
+        this.layr_list_hardware_jis = 3;
+        /**
+         * for the 'hardware' field indicating a us layout
+         */
+        this.layr_list_hardware_us = 4;
+        /**
+         * Convenience map of layr_list_hardware field values
+         */
+        this.layr_list_hardware_map = new Map([
+            ["touch", this.layr_list_hardware_touch],
+            ["abnt2", this.layr_list_hardware_abnt2],
+            ["iso", this.layr_list_hardware_iso],
+            ["jis", this.layr_list_hardware_jis],
+            ["us", this.layr_list_hardware_us],
+        ]);
+        /**
+         * Length of each layer entry in the 'layr' section variable part
+         */
+        this.length_layr_entry = 16;
+        /**
+         * Length of each row entry in the 'layr' section variable part
+         */
+        this.length_layr_row = 8;
+        /**
+         * Length of each key entry in the 'layr' section variable part
+         */
+        this.length_layr_key = 4;
+        /* ------------------------------------------------------------------
+         * list section
+            ------------------------------------------------------------------ */
+        /**
+         * Minimum length of the 'list' section not including variable parts
+         */
+        this.length_list = 16;
+        /**
+         *  Length of each list item in the 'list' list section variable part
+         */
+        this.length_list_item = 8;
+        /**
+         *  Length of each list item in the 'list' indices section variable part
+         */
+        this.length_list_index = 4;
+        /* ------------------------------------------------------------------
+         * loca section
+         ------------------------------------------------------------------ */
+        /**
+         * Minimum length of the 'loca' section not including variable parts
+         */
+        this.length_loca = 12;
+        /**
+         *  Length of each item in the 'loca' section variable part
+         */
+        this.length_loca_item = 4;
+        /* ------------------------------------------------------------------
+          * meta section
+            ------------------------------------------------------------------ */
+        /**
+         * length of the 'meta' section
+         */
+        this.length_meta = 36;
+        /**
+         * bitwise or value for fallback=omit in meta.settings
+         */
+        this.meta_settings_fallback_omit = 1;
+        /**
+         * bitwise or value for transformFailure=omit in meta.settings
+         */
+        this.meta_settings_transformFailure_omit = 2;
+        /**
+         * bitwise or value for transformPartial=hide in meta.settings
+         */
+        this.meta_settings_transformPartial_hide = 4;
+        /* ------------------------------------------------------------------
+          * name section
+            ------------------------------------------------------------------ */
+        /**
+         * Minimum length of the 'name' section not including variable parts
+         */
+        this.length_name = 12;
+        /**
+         *  Length of each item in the 'name' section variable part
+         */
+        this.length_name_item = 4;
+        /* ------------------------------------------------------------------
+          * ordr section
+            ------------------------------------------------------------------ */
+        /**
+         * Minimum length of the 'ordr' section, not including entries
+         */
+        this.length_ordr = 12;
+        /**
+         *  Length of each item in the 'ordr' section variable part
+         */
+        this.length_ordr_item = 8;
+        /* ------------------------------------------------------------------
+          * strs section
+            ------------------------------------------------------------------ */
+        /**
+         * Minimum length of the 'strs' section not including variable parts
+         */
+        this.length_strs = 12;
+        /**
+         * Length of each item in the 'strs' section variable part
+         */
+        this.length_strs_item = 8;
+        /* ------------------------------------------------------------------
+          * tran section
+            ------------------------------------------------------------------ */
+        /**
+         * Minimum length of the 'tran' section, not including entries
+         */
+        this.length_tran = 12;
+        /**
+         *  Length of each item in the 'tran' section variable part
+         */
+        this.length_tran_item = 16;
+        /**
+         * bitwise or value for error="fail" in transform
+         */
+        this.tran_flags_error = 0x0001;
+        /* ------------------------------------------------------------------
+          * vkey section
+            ------------------------------------------------------------------ */
+        /**
+         * Minimum length of the 'vkey' section not including variable parts
+         */
+        this.length_vkey = 12;
+        /**
+         *  Length of each item in the 'vkey' section variable part
+         */
+        this.length_vkey_item = 8;
+        /**
+         * All section IDs.
+         */
+        this.section = {
+            // keep this sorted
+            bksp: 'bksp',
+            disp: 'disp',
+            elem: 'elem',
+            finl: 'finl',
+            keys: 'keys',
+            layr: 'layr',
+            list: 'list',
+            loca: 'loca',
+            meta: 'meta',
+            name: 'name',
+            ordr: 'ordr',
+            sect: 'sect',
+            strs: 'strs',
+            tran: 'tran',
+            vkey: 'vkey'
+        };
+    }
+    /**
+     * Use to convert 4-char string into hex
+     * @param id section id such as 'sect'
+     * @returns hex ID such as 0x74636573
+     */
+    Constants.prototype.hex_section_id = function (id) {
+        if (!id || typeof id !== 'string' || !id.match(/^[a-z0-9]{4}$/)) {
+            throw Error("hex_section_id(".concat(id, ") - need a 4-character alphanumeric lower-case string"));
+        }
+        var r = 0;
+        for (var i = 3; i >= 0; i--) {
+            r = (r << 8 | id.charCodeAt(i));
+        }
+        return r;
+    };
+    ;
+    /**
+     * Use to convert hex into 4-char string
+     * @param hex section ID such as 0x74636573
+     * @returns string such as 'sect'
+     */
+    Constants.prototype.str_section_id = function (hex) {
+        var chars = [];
+        for (var i = 3; i >= 0; i--) {
+            chars.push(String.fromCharCode(hex & 0xFF));
+            hex >>= 8;
+        }
+        return chars.join('');
+    };
+    return Constants;
+}());
+;
+export var constants = new Constants();
+// }

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@keymanapp/ldml-keyboard-constants",
+  "description": "Keyman LDML keyboard constants",
+  "keywords": [
+    "keyboard",
+    "keyman",
+    "ldml",
+    "unicode"
+  ],
+  "files": [
+    "/build/keyboardprocessor_ldml.*"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "main": "build/keyboardprocessor_ldml.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/keymanapp/keyman.git"
+  },
+  "version": "17.0.87-alpha"
+}