mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-08 01:45:32 +00:00
92 lines
3.2 KiB
TypeScript
92 lines
3.2 KiB
TypeScript
/*
|
|
* Copyright (c) 2018 National Research Council Canada (author: Eddie A. Santos)
|
|
* Copyright (c) 2018 SIL International
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
* this software and associated documentation files (the "Software"), to deal in
|
|
* the Software without restriction, including without limitation the rights to
|
|
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
* the Software, and to permit persons to whom the Software is furnished to do so,
|
|
* subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
|
|
/**
|
|
* A JavaScript string with the restriction that it must only
|
|
* contain Unicode scalar values.
|
|
*
|
|
* This means that any lone high surrogate must be paired with
|
|
* a low surrogate, if it exists. Lone surrogate code units are
|
|
* forbidden.
|
|
*
|
|
* See also: https://developer.mozilla.org/en-US/docs/Web/API/USVString
|
|
*/
|
|
type USVString = string;
|
|
|
|
|
|
/**
|
|
* Describes the capabilities of the keyboard's platform.
|
|
* This includes upper bounds for how much text will be sent on each
|
|
* prediction, as well as what operations the keyboard is allowed to do on the
|
|
* underlying buffer.
|
|
*/
|
|
interface Capabilities {
|
|
/**
|
|
* The maximum amount of UTF-16 code units that the keyboard will provide to
|
|
* the left of the cursor, as an integer.
|
|
*/
|
|
maxLeftContextCodeUnits: number,
|
|
|
|
/**
|
|
* The maximum amount of code units that the keyboard will provide to the
|
|
* right of the cursor, as an integer. The value 0 or the absence of this
|
|
* rule implies that the right contexts are not supported.
|
|
*/
|
|
maxRightContextCodeUnits?: number,
|
|
|
|
/**
|
|
* Whether the platform supports deleting to the right. The absence of this
|
|
* rule implies false.
|
|
*/
|
|
supportsDeleteRight?: false,
|
|
}
|
|
|
|
// TODO: Define what a valid model description is!
|
|
interface ModelDescription {}
|
|
|
|
/**
|
|
* Configuration of the LMLayer, sent back to the keyboard.
|
|
*/
|
|
interface Configuration {
|
|
/**
|
|
* How many UTF-16 code units maximum to send as the context to the
|
|
* left of the cursor ("left" in the Unicode character stream).
|
|
*
|
|
* Affects the `context` property sent in `predict` messages.
|
|
*
|
|
* While the left context MUST NOT bisect surrogate pairs, they MAY
|
|
* bisect graphical clusters.
|
|
*/
|
|
leftContextCodeUnits: number;
|
|
|
|
/**
|
|
* How many UTF-16 code units maximum to send as the context to the
|
|
* right of the cursor ("right" in the Unicode character stream).
|
|
*
|
|
* Affects the `context` property sent in `predict` messages.
|
|
*
|
|
* While the left context MUST NOT bisect surrogate pairs, they MAY
|
|
* bisect graphical clusters.
|
|
*/
|
|
rightContextCodeUnits: number;
|
|
}
|