spiegel-keyman/core/include/ldml/keyboardprocessor_ldml.ts
Steven R. Loomis fd4945c5ee fix(core): ldml: goodbye multichar strings 🙀
- use 32 bit hex constants instead

#7098
2022-08-23 11:27:59 -05:00

109 lines
2.7 KiB
TypeScript

/*
Copyright: Copyright (C) 2022 SIL International.
Authors: srl295
This file provides constants for the KMX Plus (LDML support) binary format,
to be shared between TypeScript and C++ via the generator (below)
*/
// Notice!
//
// If you update this file, you *must* be sure to re-run
//
// core/tools/ldml-const-builder/build.sh clean build run
//
// To update keyboardprocessor_ldml.h, and commit the result.
//
// It is not updated automatically.
// 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'
*/
export const constants = {
/**
* The version of the LDML processor
*/
version: '1.0',
/**
* Length of a raw section header, in bytes
*/
length_header: 8,
/**
* Section ID for the keybag
*/
section_keys: 0x7379656B,
/**
* Minimum length of the 'keys' section
* not including variable parts
*/
length_keys: 16,
/**
* Section ID for the locale list
*/
section_loca: 0x61636F6C,
/**
* Minimum length of the 'loca' section
* not including variable parts
*/
length_loca: 12,
/**
* Section ID for the metadata
*/
section_meta: 0x6174656D,
/**
* length of the 'meta' section
*/
length_meta: 36,
/**
* bitwise or value for fallback=omit in meta.settings
*/
meta_settings_fallback_omit: 1,
/**
* bitwise or value for transformFailure=omit in meta.settings
*/
meta_settings_transformFailure_omit: 2,
/**
* bitwise or value for transformPartial=hide in meta.settings
*/
meta_settings_transformPartial_hide: 4,
/**
* Section ID for the section header
*/
section_sect: 0x74636573,
/**
* Minimum length of the 'sect' section, not including entries
*/
length_sect: 16,
/**
* Section ID for the string table
*/
section_strs: 0x73727473,
/**
* Minimum length of the 'strs' section
* not including variable parts
*/
length_strs: 16,
/**
* bitwise or value for extend in keys[key].flags.
* If bit is 1, then 'to' is a string.
* If bit is 0, then 'to' is a UTF-32LE codepoint
*
* `extend = flags & keys_flags_extend`
*/
keys_flags_extend: 1,
/**
* Section ID for the vkeys map
*/
section_vkey: 0x79656b76,
/**
* Minimum length of the 'vkey' section
* not including variable parts
*/
length_vkey: 12,
};
// }