erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-09 02:15:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

docs(common): More readme improvements

Browse source
This commit is contained in:
Eberhard Beilharz 2021-03-02 19:16:06 +01:00
parent 268a42cba4
commit 958fb3ac1f
No known key found for this signature in database
GPG key ID: 64A39A9E98B53105
2 changed files with 21 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
common/core/desktop/doc/markdown_files/index.md
View file

@ -1,6 +1,7 @@
# Keyman Keyboard Processor API
## Requirements
1. Cross platform.
2. Cross language.
3. Facilitate stateless operation of the Engine.
@ -9,8 +10,8 @@
6. Support querying Keyboard attributes.
7. Idempotent
## Design decisions in support of requirements:
- Use C or C99 types and calling convention for the interface, it has the
broadest language FFI support. [1,2]
- Have client (platform glue) code load keyboards, manage & pass state. [3,4,7]
@ -18,8 +19,8 @@
engine [5,6]
- Provide get/set calls for client accessible keyboard state information [3,4]
## Glossary
- __Platform layer:__
the code that consumes the Keyman Keyboard Processor API, and provides the
operating system-specific handling of keystroke events and integration with
@ -29,22 +30,32 @@ the application that has the focus and receives text events from the Platform
layer.
- __Context:__ Text preceding the insertion point
- __Marker:__ Positional state that can be placed in the Context.
- __Keyboard:__ A set of rules for execution my an Engine
- __Keyboard:__ A set of rules for execution by an Engine
- __Option:__ A variable in a dynamic or static key value store.
- __Processor:__
The component that implements this API and can parse and execute a particular
keyboard.
- __State:__ An object that hold internal state of the Processor for a given
- __State:__ An object that holds internal state of the Processor for a given
insertion point
- __Action:__
A directive output by the processor detailing how the Platform layer should
transform the Client Application's text buffer. There may be several items
produced by a single keyboard event.
- __Keyboard Event:__
A virtual key board event and modifier map recevied from the platform to be
A virtual key board event and modifier map recevied from the Platform layer to be
processed with the state object for this Client application.
- __Virtual Key:__
A code based on the US English layout, with values matching the Windows
virtual key codes. See `keyboardprocessor_vkeys.h` for definitions.
- __Modifier Key:__
The set of Control, Shift, Alt, Caps Lock keys. On some platforms these may
have other names (e.g. Alt is called Option on macOS); other platform-specific
modifiers such as Windows key are excluded from this set. Some modifiers are
transient, such as Control, and others have long-lasting state, such as
Caps Lock.
## API
### Namespace
All calls, types and enums are prefixed with the namespace identifier `km_kbp_`

8
common/core/desktop/include/keyman/keyboardprocessor.h.in
View file

@ -41,23 +41,23 @@ The application that has the focus and receives text events from the Platform
layer.
- __Context:__ Text preceding the insertion point
- __Marker:__ Positional state that can be placed in the Context.
- __Keyboard:__ A set of rules for execution my an Engine
- __Keyboard:__ A set of rules for execution by an Engine
- __Option:__ A variable in a dynamic or static key value store.
- __Processor:__
The component that implements this API and can parse and execute a particular
keyboard.
- __State:__ An object that hold internal state of the Processor for a given
- __State:__ An object that holds internal state of the Processor for a given
insertion point
- __Action:__
A directive output by the processor detailing how the Platform layer should
transform the Client Application's text buffer. There may be several items
produced by a single keyboard event.
- __Keyboard Event:__
A virtual key event and modifier map received from the platform to be
A virtual key event and modifier map received from the Platform layer to be
processed with the state object for this Client application.
- __Virtual Key:__
A code based on the US English layout, with values matching the Windows
virtual key codes. See keyboardprocessor_vkeys.h for definitions.
virtual key codes. See `keyboardprocessor_vkeys.h` for definitions.
- __Modifier Key:__
The set of Control, Shift, Alt, Caps Lock keys. On some platforms these may
have other names (e.g. Alt is called Option on macOS); other platform-specific