mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-05 16:35:33 +00:00
671973baab
Relates to #9999. Fixes #10384. The context API endpoints should no longer be considered as part of the standard Core API. The only consumers that have a need to access these APIs are the IMX integration in Engine for Windows, and the Keyman Developer Debugger. These symbols are currently used by Developer: * `km_core_context` struct * `km_core_context_type` enum * `km_core_context_item` struct * `KM_CORE_CONTEXT_ITEM_END` macro * `km_core_state_context()` * `km_core_context_set()` * `km_core_context_clear()` These symbols are currently used by Windows IMX: * `km_core_context` struct * `km_core_context_type` enum * `km_core_context_item` struct * `KM_CORE_CONTEXT_ITEM_END` macro * `km_core_context_items_dispose()` * `km_core_context_item_list_size()` * `km_core_state_get_intermediate_context()` The following functions and symbols are moving to keyman_core_api_context.h: * `km_core_context` struct * `km_core_context_type` enum * `km_core_context_item` struct * `KM_CORE_CONTEXT_ITEM_END` macro * `km_core_state_context()` function * `km_core_state_get_intermediate_context()` function * `km_core_context_set()` function * `km_core_context_clear()` function * `km_core_context_get()` function * `km_core_context_items_from_utf16()` function * `km_core_context_items_from_utf8()` function * `km_core_context_items_to_utf8()` function * `km_core_context_items_to_utf16()` function * `km_core_context_items_to_utf32()` function * `km_core_context_items_dispose()` function * `km_core_context_length()` function * `km_core_context_append()` function * `km_core_context_shrink()` function * `km_core_context_item_list_size()` function
136 lines
3.4 KiB
C++
136 lines
3.4 KiB
C++
/*
|
|
Copyright: © 2018 SIL International.
|
|
Description: Internal keyboard class and adaptor class for the API.
|
|
Create Date: 2 Oct 2018
|
|
Authors: Tim Eves (TSE)
|
|
History: 2 Oct 2018 - TSE - Refactored out of km_core_keyboard_api.cpp
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <string>
|
|
#include <unordered_map>
|
|
|
|
#include "keyman_core.h"
|
|
|
|
#include "keyboard.hpp"
|
|
|
|
namespace km {
|
|
namespace core
|
|
{
|
|
class abstract_processor
|
|
{
|
|
std::unordered_map<std::u16string, std::u16string> _persisted;
|
|
protected:
|
|
keyboard_attributes _attributes;
|
|
|
|
public:
|
|
abstract_processor() {}
|
|
abstract_processor(keyboard_attributes && kb) : _attributes(std::move(kb)) {}
|
|
virtual ~abstract_processor() { };
|
|
|
|
keyboard_attributes const & keyboard() const noexcept {
|
|
return _attributes;
|
|
}
|
|
|
|
auto & persisted_store() const noexcept { return _persisted; }
|
|
auto & persisted_store() noexcept { return _persisted; }
|
|
|
|
virtual km_core_status
|
|
process_event(
|
|
km_core_state *,
|
|
km_core_virtual_key,
|
|
uint16_t modifier_state,
|
|
uint8_t is_key_down,
|
|
uint16_t event_flags
|
|
) = 0;
|
|
|
|
virtual km_core_status
|
|
external_event(
|
|
km_core_state* _kmn_unused(state),
|
|
uint32_t _kmn_unused(event),
|
|
void* _kmn_unused(data)
|
|
) {
|
|
return KM_CORE_STATUS_OK;
|
|
}
|
|
|
|
virtual km_core_attr const & attributes() const = 0;
|
|
virtual km_core_status validate() const = 0;
|
|
|
|
virtual char16_t const *
|
|
lookup_option(
|
|
km_core_option_scope,
|
|
std::u16string const & key
|
|
) const = 0;
|
|
|
|
virtual option
|
|
update_option(
|
|
km_core_option_scope,
|
|
std::u16string const & key,
|
|
std::u16string const & value
|
|
) = 0;
|
|
|
|
/**
|
|
* Requests this keyboard processor to process its queued actions
|
|
* updateing the state as required.
|
|
*
|
|
* @param state An opaque pointer to a state object
|
|
* @return km_core_status `KM_CORE_STATUS_OK`: On success. Else KB_CORE_ error code
|
|
*/
|
|
virtual km_core_status
|
|
process_queued_actions(
|
|
km_core_state * state
|
|
) = 0;
|
|
|
|
/**
|
|
* Add the action items to this keyboard processor queue
|
|
*
|
|
* @param state An opaque pointer to a state object
|
|
* @param action_item
|
|
* @param bool return true if action item list is successfully processed
|
|
*/
|
|
virtual bool
|
|
queue_action(
|
|
km_core_state * state,
|
|
km_core_action_item const* action_item
|
|
) = 0;
|
|
|
|
/**
|
|
* Returns the core context as an array of
|
|
* km_core_context_items. Caller is responsible for freeing
|
|
* the memory
|
|
* @return km_core_context_item*
|
|
*/
|
|
virtual km_core_context_item *
|
|
get_intermediate_context() = 0;
|
|
|
|
/**
|
|
* Returns the list of keys that belong to the keyboard rules. The matching dispose
|
|
* call needs to be called to free the memory.
|
|
*
|
|
* @return km_core_keyboard_key*
|
|
*/
|
|
virtual km_core_keyboard_key *
|
|
get_key_list() const = 0;
|
|
|
|
|
|
/** Get the imx list of external libraries and functions
|
|
* this keyboard calls.
|
|
*
|
|
* @return km_core_keyboard_imx*
|
|
*/
|
|
virtual km_core_keyboard_imx *
|
|
get_imx_list() const = 0;
|
|
|
|
virtual bool
|
|
supports_normalization() const = 0;
|
|
|
|
friend json & operator << (json &j, abstract_processor const &opts);
|
|
};
|
|
|
|
json & operator << (json &j, abstract_processor const &opts);
|
|
|
|
} // namespace core
|
|
} // namespace km
|
|
|
|
struct km_core_keyboard : public km::core::abstract_processor {};
|