chore(core): rename keyboardprocessor.h to keyman_core_api.h

core/doc/hotdoc.json

@@ -4,7 +4,7 @@
     "sitemap": "@doc_dir@/sitemap.txt",
     "index": "@doc_dir@/markdown_files/index.md",
     "c_sources": [
-      "@include_dir@/keyman/keyboardprocessor.h"
+      "@include_dir@/keyman/keyman_core_api.h"
     ],
     "c_include_directories": [
       "@include_dir@",

core/doc/introspection.schema

@@ -47,7 +47,7 @@
     }
   },
   "properties": {
-    "$schema": { "const": "keyman/keyboardprocessor/doc/introspection.schema" },
+    "$schema": { "const": "keyman/core/doc/introspection.schema" },
     "keyboard": { "$ref": "#/definitions/keyboard" },
     "options": {
       "type": "object",

core/doc/markdown_files/index.md

@@ -46,7 +46,7 @@ A virtual key board event and modifier map recevied from the Platform layer to b
 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 `keyman_core_api_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

core/doc/meson.build

@@ -18,7 +18,7 @@ if hotdoc.found()
                  output: 'hotdoc.json',
                  configuration: cfg)
   deps = files(
-    '../include/keyman/keyboardprocessor.h',
+    '../include/keyman/keyman_core_api.h',
     '../src/jsonpp.hpp',
     '../src/utfcodec.hpp'
   )

core/include/keyman/keyboardprocessor.h → core/include/keyman/keyman_core_api.h

@@ -57,7 +57,7 @@ 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 `keyman_core_api_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
@@ -100,9 +100,9 @@ nothing in that event.
 */
 #include <stdint.h>
 #include <stdlib.h>
-#include <keyman/keyboardprocessor_bits.h>
-#include <keyman/keyboardprocessor_vkeys.h>
-#include <keyman/keyboardprocessor_version.h>
+#include <keyman/keyman_core_api_bits.h>
+#include <keyman/keyman_core_api_vkeys.h>
+#include <keyman/keyman_core_api_version.h>
 
 #if defined(__cplusplus)
 extern "C"
@@ -989,7 +989,7 @@ used in IMX callbacks called during `km_kbp_process_event`.
 In the event the `state` or `action_items` pointer are null.
 ##### Parameters:
 - __state__:        A pointer to the opaque `km_kbp_state` object to be queried.
-- __action_items__: The action items to be added to the keyboardprocessor
+- __action_items__: The action items to be added to the core
                     queue. Must be terminated with a `KM_KBP_IT_END` entry.
 
 ```c

core/include/keyman/keyboardprocessor_debug.h → core/include/keyman/keyman_core_api_debug.h

@@ -15,8 +15,8 @@
 
 #include <stdint.h>
 #include <stdlib.h>
-#include <keyman/keyboardprocessor_bits.h>
-#include <keyman/keyboardprocessor_vkeys.h>
+#include <keyman/keyman_core_api_bits.h>
+#include <keyman/keyman_core_api_vkeys.h>
 
 #if defined(__cplusplus)
 extern "C"

core/include/keyman/keyboardprocessor_vkeys.h → core/include/keyman/keyman_core_api_vkeys.h

@@ -7,7 +7,7 @@
   Create Date:  17 Oct 2018
   Authors:      Tim Eves (TSE)
   History:      17 Oct 2018 - TSE - Moved & refactored km_kbp_modifier_state
-                                    from keyboardprocessor.h.
+                                    from keyman_core_api.h.
                                   - Added VKey and mask definitions.
                  6 Oct 2018 - TSE - Move into keyman folder.
 

core/include/keyman/meson.build

@@ -19,16 +19,16 @@ cfg.set('patchver', project_ver[2])
 
 configure_file(
   configuration: cfg,
-  input: 'keyboardprocessor_version.h.in',
-  output: 'keyboardprocessor_version.h',
+  input: 'keyman_core_api_version.h.in',
+  output: 'keyman_core_api_version.h',
 )
 
-install_headers('keyboardprocessor.h',
-                'keyboardprocessor_bits.h',
-                'keyboardprocessor_consts.h',
-                'keyboardprocessor_debug.h',
-                'keyboardprocessor_vkeys.h',
-                join_paths(meson.current_build_dir(), 'keyboardprocessor_version.h'),
+install_headers('keyman_core_api.h',
+                'keyman_core_api_bits.h',
+                'keyman_core_api_consts.h',
+                'keyman_core_api_debug.h',
+                'keyman_core_api_vkeys.h',
+                join_paths(meson.current_build_dir(), 'keyman_core_api_version.h'),
                 '../../../common/include/km_types.h',
                 '../../../common/include/kmx_file.h',
                 subdir: 'keyman')

core/src/context.hpp

@@ -9,7 +9,7 @@
 #pragma once
 #include <list>
 #include <vector>
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 
 // Forward declarations
 class json;

core/src/debug.hpp

@@ -9,8 +9,8 @@
 #include <cassert>
 #include <vector>
 
-#include <keyman/keyboardprocessor.h>
-#include <keyman/keyboardprocessor_debug.h>
+#include <keyman/keyman_core_api.h>
+#include <keyman/keyman_core_api_debug.h>
 
 namespace km {
 namespace kbp

core/src/debuglog.h

@@ -1,6 +1,6 @@
 /* Debugging */
 
-#include <keyman/keyboardprocessor_bits.h>
+#include <keyman/keyman_core_api_bits.h>
 
 namespace km {
 namespace kbp {

core/src/keyboard.hpp

@@ -11,7 +11,7 @@
 #include <string>
 #include <vector>
 
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 
 #include "option.hpp"
 #include "path.hpp"

core/src/km_kbp_context_api.cpp

@@ -12,7 +12,7 @@
 #include <algorithm>
 #include <vector>
 
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 
 #include "context.hpp"
 #include "jsonpp.hpp"

core/src/km_kbp_debug_api.cpp

@@ -8,7 +8,7 @@
 #include <algorithm>
 #include <sstream>
 
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 
 #include "processor.hpp"
 #include "state.hpp"

core/src/km_kbp_keyboard_api.cpp

@@ -11,7 +11,7 @@
 #include <cassert>
 #include <vector>
 
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 #include "keyboard.hpp"
 #include "processor.hpp"
 #include "kmx/kmx_processor.hpp"

core/src/km_kbp_options_api.cpp

@@ -11,7 +11,7 @@
 #include <cassert>
 #include <sstream>
 
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 #include "processor.hpp"
 
 #include "jsonpp.hpp"

core/src/km_kbp_processevent_api.cpp

@@ -8,7 +8,7 @@
   History:      17 Oct 2018 - TSE - Initial implementation.
 */
 
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 #include "processor.hpp"
 #include "state.hpp"
 

core/src/km_kbp_state_api.cpp

@@ -12,7 +12,7 @@
 #include <algorithm>
 #include <sstream>
 
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 #include "jsonpp.hpp"
 
 #include "processor.hpp"
@@ -212,7 +212,7 @@ km_kbp_status km_kbp_state_to_json(km_kbp_state const *state,
   {
     // Pretty print the document.
     jo << json::object
-        << "$schema" << "keyman/keyboardprocessor/doc/introspection.schema"
+        << "$schema" << "keyman/core/doc/introspection.schema"
         << "keyboard" << state->processor().keyboard()
 //        << "options" << state->options()  TODO: Fix
         << "context" << state->context()

core/src/kmx/kmx_base.h

@@ -1,7 +1,7 @@
 #pragma once
 
-#include <keyman/keyboardprocessor_bits.h>
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api_bits.h>
+#include <keyman/keyman_core_api.h>
 
 #if defined(_WIN32) || defined(_WIN64)
 #define snprintf _snprintf

core/src/kmx/kmx_capslock.cpp

@@ -2,7 +2,7 @@
   Copyright:        Copyright (C) 2003-2018 SIL International.
   Authors:          mcdurdin
 */
-#include <keyman/keyboardprocessor_consts.h>
+#include <keyman/keyman_core_api_consts.h>
 #include <kmx/kmx_processevent.h>
 
 using namespace km::kbp;

core/src/kmx/kmx_environment.cpp

@@ -3,7 +3,7 @@
   Authors:          mcdurdin
 */
 #include <kmx/kmx_processevent.h>
-#include <keyman/keyboardprocessor_consts.h>
+#include <keyman/keyman_core_api_consts.h>
 #include <state.hpp>
 #include <option.hpp>
 

core/src/kmx/kmx_options.h

@@ -4,7 +4,7 @@
 #include <string>
 #include <vector>
 
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 #include "option.hpp"
 
 #include "kmx_base.h"

core/src/kmx/kmx_processevent.cpp

@@ -4,7 +4,7 @@
 */
 #include "kmx_processevent.h"
 #include "state.hpp"
-#include <keyman/keyboardprocessor_consts.h>
+#include <keyman/keyman_core_api_consts.h>
 
 using namespace km::kbp;
 using namespace kmx;

core/src/kmx/kmx_processevent.h

@@ -11,7 +11,7 @@
 #include <assert.h>
 #include <string>
 #include <string.h>
-#include <keyman/keyboardprocessor_bits.h>
+#include <keyman/keyman_core_api_bits.h>
 #include "debuglog.h"
 #include "kmx_base.h"
 #include "kmx_file.h"

core/src/kmx/kmx_processor.cpp

@@ -1,4 +1,4 @@
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 #include "state.hpp"
 #include "kmx/kmx_processor.hpp"
 #include <map>

core/src/kmx/kmx_processor.hpp

@@ -9,7 +9,7 @@
 #pragma once
 
 #include <string>
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 #include "kmx/kmx_processevent.h"
 #include "keyboard.hpp"
 #include "processor.hpp"

core/src/ldml/ldml_processor.hpp

@@ -13,7 +13,7 @@
 #include <utility>
 #include <vector>
 #include <memory>
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 #include "processor.hpp"
 #include "option.hpp"
 #include "ldml_vkeys.hpp"

core/src/ldml/ldml_vkeys.hpp

@@ -13,7 +13,7 @@
 #include <utility>
 #include <vector>
 
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 
 namespace km {
 namespace kbp {

core/src/mock/mock_processor.hpp

@@ -10,7 +10,7 @@
 
 #include <string>
 #include <unordered_map>
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 
 #include "processor.hpp"
 #include "option.hpp"

core/src/option.hpp

@@ -12,7 +12,7 @@
 
 #include <string>
 
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 
 // Forward declarations
 class json;

core/src/path.hpp

@@ -12,7 +12,7 @@
 #include <string>
 #include <type_traits>
 
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 #include "jsonpp.hpp"
 #include "utfcodec.hpp"
 

core/src/processor.hpp

@@ -11,7 +11,7 @@
 #include <string>
 #include <unordered_map>
 
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 
 #include "keyboard.hpp"
 
@@ -96,7 +96,7 @@ namespace kbp
     ) = 0;
 
   /**
-   * Returns the keyboardprocessor context as an array of
+   * Returns the core context as an array of
    * km_kbp_context_items. Caller is responsible for freeing
    * the memory
    * @return km_kbp_context_item*

core/src/state.cpp

@@ -7,7 +7,7 @@
 
 #include "state.hpp"
 #include "processor.hpp"
-#include <keyman/keyboardprocessor_consts.h>
+#include <keyman/keyman_core_api_consts.h>
 
 using namespace km::kbp;
 

core/src/state.hpp

@@ -11,7 +11,7 @@
 #include <cassert>
 #include <vector>
 
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 
 #include "context.hpp"
 #include "option.hpp"

core/src/version.rc

@@ -1,5 +1,5 @@
 #include <windows.h>
-#include "include/keyman/keyboardprocessor_version.h"
+#include "include/keyman/keyman_core_api_version.h"
 
 // Encoding: UTF8 (compile with rc /c65001)
 // Use rc /n to append null to all strings

core/tests/unit/kmnkbd/action_items.hpp

@@ -1,4 +1,4 @@
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 #include <string>
 #include <iostream>
 

core/tests/unit/kmnkbd/context_api.cpp

@@ -10,7 +10,7 @@
                                     mutation functions.
 */
 #include <string>
-#include <keyman/keyboardprocessor.h>
+#include <keyman/keyman_core_api.h>
 
 #include "context.hpp"
 #include "utfcodec.hpp"