From c46df89dccf4c7c26cdbd49627be0e583059e220 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sat, 10 Oct 2020 20:22:04 -0700 Subject: [PATCH] Remove the deprecated HID Facade, as we've passed the promise date of 2020-09-16 --- docs/UPGRADING.md | 11 ++-- src/Kaleidoscope.h | 2 - src/kaleidoscope/hid.h | 83 ------------------------ src/kaleidoscope_internal/deprecations.h | 4 -- 4 files changed, 6 insertions(+), 94 deletions(-) delete mode 100644 src/kaleidoscope/hid.h diff --git a/docs/UPGRADING.md b/docs/UPGRADING.md index 888d40a3..6cc4794c 100644 --- a/docs/UPGRADING.md +++ b/docs/UPGRADING.md @@ -13,7 +13,6 @@ If any of this does not make sense to you, or you have trouble updating your .in - [Consistent timing](#consistent-timing) + [Breaking changes](#breaking-changes) - [Layer system switched to activation-order](#layer-system-switched-to-activation-order) - - [Deprecation of the HID facade](#deprecation-of-the-hid-facade) - [Implementation of type Key internally changed from C++ union to class](#implementation-of-type-key-internally-changed-from-union-to-class) - [The `RxCy` macros and peeking into the keyswitch state](#the-rxcy-macros-and-peeking-into-the-keyswitch-state) - [HostOS](#hostos) @@ -335,10 +334,6 @@ This means that the following functions are deprecated, and will be removed by * `Layer.forEachActiveLayer()` to walk the active layers in order (from least recent to most). -### Deprecation of the HID facade - -With the new Device APIs it became possible to replace the HID facade (the `kaleidoscope::hid` family of functions) with a driver. As such, the old APIs are deprecated, and will be removed by **2020-09-16**. Please use `Kaleidoscope.hid()` instead. - ### Implementation of type Key internally changed from C++ union to class The deprecated functions continue to work, but they will be removed by **2020-09-16**. @@ -546,6 +541,12 @@ The following headers and names have changed: # Removed APIs +### Removed on 2020-10-10 + +### Deprecation of the HID facade + +With the new Device APIs it became possible to replace the HID facade (the `kaleidoscope::hid` family of functions) with a driver. As such, the old APIs are deprecated, and was removed on 2020-10-10. Please use `Kaleidoscope.hid()` instead. + ### Removed on 2020-06-16 #### The old device API diff --git a/src/Kaleidoscope.h b/src/Kaleidoscope.h index d0d39c87..57dbbe81 100644 --- a/src/Kaleidoscope.h +++ b/src/Kaleidoscope.h @@ -42,8 +42,6 @@ void setup(); #include "kaleidoscope_internal/device.h" #include "kaleidoscope_internal/deprecations.h" -#include "kaleidoscope/hid.h" - // Note: The CONVERT_TO_KEY macro can be redefined to use different // host_keymap-keymaps on different layers (see key_defs.h for its diff --git a/src/kaleidoscope/hid.h b/src/kaleidoscope/hid.h deleted file mode 100644 index 203c6766..00000000 --- a/src/kaleidoscope/hid.h +++ /dev/null @@ -1,83 +0,0 @@ -/* Kaleidoscope - Firmware for computer input devices - * Copyright (C) 2013-2019 Keyboard.io, Inc. - * - * This program is free software: you can redistribute it and/or modify it under - * the terms of the GNU General Public License as published by the Free Software - * Foundation, version 3. - * - * This program is distributed in the hope that it will be useful, but WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS - * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more - * details. - * - * You should have received a copy of the GNU General Public License along with - * this program. If not, see . - */ - -#pragma once -#include - -#include -#include "kaleidoscope/key_defs.h" -#include "kaleidoscope_internal/deprecations.h" - -namespace kaleidoscope { -namespace hid { - -extern void initializeKeyboard() DEPRECATED(HID_FACADE); -extern void pressKey(Key mappedKey, boolean toggledOn = true) DEPRECATED(HID_FACADE); -extern void releaseKey(Key mappedKey) DEPRECATED(HID_FACADE); -extern void releaseAllKeys() DEPRECATED(HID_FACADE); -extern void pressRawKey(Key mappedKey) DEPRECATED(HID_FACADE); -extern void releaseRawKey(Key mappedKey) DEPRECATED(HID_FACADE); -/** Flushes any pending regular key switch events and sends them out */ -extern void sendKeyboardReport() DEPRECATED(HID_FACADE); - -extern boolean isModifierKeyActive(Key mappedKey) DEPRECATED(HID_FACADE); -extern boolean wasModifierKeyActive(Key mappedKey) DEPRECATED(HID_FACADE); - -extern boolean isAnyModifierKeyActive() DEPRECATED(HID_FACADE); -extern boolean wasAnyModifierKeyActive() DEPRECATED(HID_FACADE); - -extern uint8_t getKeyboardLEDs() DEPRECATED(HID_FACADE); - -extern void initializeConsumerControl() DEPRECATED(HID_FACADE); - -extern void pressConsumerControl(Key mappedKey) DEPRECATED(HID_FACADE); -extern void releaseConsumerControl(Key mappedKey) DEPRECATED(HID_FACADE); - -extern void initializeSystemControl() DEPRECATED(HID_FACADE); - -extern void pressSystemControl(Key mappedKey) DEPRECATED(HID_FACADE); -extern void releaseSystemControl(Key mappedKey) DEPRECATED(HID_FACADE); - -extern void initializeMouse() DEPRECATED(HID_FACADE); - -extern void moveMouse(signed char x, signed char y, signed char vWheel = 0, signed char hWheel = 0) DEPRECATED(HID_FACADE); -/** stopMouse() stops mouse and/or mouse wheel movement in given directions. - * - * Counterpart of moveMouse(), this function allows us to undo whatever movement - * we were supposed to make. The intended use-case is one where we send multiple - * reports per cycle, and want greater control over them, when we don't want to - * clear the whole report, just parts of it. - * - * Any of the arguments that is set to true, will be cleared from the report to - * be sent by the next call to sendMouseReport(). - */ -extern void stopMouse(bool x, bool y, bool vWheel = false, bool hWheel = false) DEPRECATED(HID_FACADE); -extern void clickMouseButtons(uint8_t buttons) DEPRECATED(HID_FACADE); -extern void pressMouseButtons(uint8_t buttons) DEPRECATED(HID_FACADE); -extern void releaseMouseButtons(uint8_t buttons) DEPRECATED(HID_FACADE); -extern void releaseAllMouseButtons(void) DEPRECATED(HID_FACADE); -extern void sendMouseReport(void) DEPRECATED(HID_FACADE); - -extern void initializeAbsoluteMouse() DEPRECATED(HID_FACADE); - -extern void moveAbsoluteMouse(signed char x, signed char y, signed char wheel) DEPRECATED(HID_FACADE); -extern void moveAbsoluteMouseTo(uint16_t x, uint16_t y, signed char wheel) DEPRECATED(HID_FACADE); -extern void clickAbsoluteMouseButtons(uint8_t buttons) DEPRECATED(HID_FACADE); -extern void pressAbsoluteMouseButtons(uint8_t buttons) DEPRECATED(HID_FACADE); -extern void releaseAbsoluteMouseButtons(uint8_t buttons) DEPRECATED(HID_FACADE); - -} -}; diff --git a/src/kaleidoscope_internal/deprecations.h b/src/kaleidoscope_internal/deprecations.h index fdf87b95..275ae183 100644 --- a/src/kaleidoscope_internal/deprecations.h +++ b/src/kaleidoscope_internal/deprecations.h @@ -46,10 +46,6 @@ "Layers are now in activation-order, please use" __NL__ \ "`Layer.forEachActiveLayer()` instead." -#define _DEPRECATED_MESSAGE_HID_FACADE __NL__ \ - "The HID facade in the `kaleidoscope::hid` namespace is deprecated.\n" __NL__ \ - "Please use `Kaleidoscope.hid()` instead." - #define _DEPRECATED_MESSAGE_DIRECT_KEY_MEMBER_ACCESS \ "Direct access to `Key` class' data members is deprecated.\n" \ "Please use `Key::setKeyCode()`/`Key::getKeyCode()` or\n" \