Remove the deprecated `Kaleidoscope_` class

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
pull/853/head
Gergely Nagy 5 years ago
parent c800d2e425
commit cfe4bb3dce
No known key found for this signature in database
GPG Key ID: AC1E90BAC433F68F

@ -19,7 +19,6 @@ If any of this does not make sense to you, or you have trouble updating your .in
- [TypingBreaks](#typingbreaks) - [TypingBreaks](#typingbreaks)
- [Redial](#redial) - [Redial](#redial)
+ [Deprecated APIs and their replacements](#deprecated-apis-and-their-replacements) + [Deprecated APIs and their replacements](#deprecated-apis-and-their-replacements)
- [Class/global instance Kaleidoscope_/Kaleidoscope renamed to kaleidoscope::Runtime_/kaleidoscope::Runtime](#classglobal-instance-kaleidoscope_kaleidoscope-renamed-to-kaleidoscoperuntime_kaleidoscoperuntime)
- [Transition to linear indexing](#transition-to-linear-indexing) - [Transition to linear indexing](#transition-to-linear-indexing)
- [Source code and namespace rearrangement](#source-code-and-namespace-rearrangement) - [Source code and namespace rearrangement](#source-code-and-namespace-rearrangement)
* [Removed APIs](#removed-apis) * [Removed APIs](#removed-apis)
@ -488,13 +487,6 @@ Older versions of the plugin required one to set up `Key_Redial` manually, and l
## Deprecated APIs and their replacements ## Deprecated APIs and their replacements
### Class/global instance Kaleidoscope_/Kaleidoscope renamed to kaleidoscope::Runtime_/kaleidoscope::Runtime
After the renaming, Kaleidoscope core should be using `kaleidoscope::Runtime`.
The former `Kaleidoscope` global symbol is to be used by sketches only - and
only because to not diverge too much from the Arduino naming style. Deprecated
symbols are scheduled for removal on **2020-03-15**.
### Transition to linear indexing ### Transition to linear indexing
Row/col based indexing was replaced by linear indexing throughout the whole firmware. A compatibility layer of functions was introduced that allows Row/col based indexing was replaced by linear indexing throughout the whole firmware. A compatibility layer of functions was introduced that allows
@ -572,6 +564,14 @@ if (!LEDControl.isEnabled()) {
} }
``` ```
#### Class/global instance Kaleidoscope_/Kaleidoscope renamed to kaleidoscope::Runtime_/kaleidoscope::Runtime
After the renaming, Kaleidoscope core should be using `kaleidoscope::Runtime`.
The former `Kaleidoscope` global symbol is to be used by sketches only - and
only to not diverge too much from the Arduino naming style.
The deprecated `Kaleidoscope_` class has been removed on **2020-06-16**.
### Removed on 2020-01-06 ### Removed on 2020-01-06
#### EEPROMKeymap mode #### EEPROMKeymap mode

@ -105,12 +105,6 @@ static_assert(KALEIDOSCOPE_REQUIRED_API_VERSION == KALEIDOSCOPE_API_VERSION,
// //
#define KALEIDOSCOPE_INIT_PLUGINS(...) _KALEIDOSCOPE_INIT_PLUGINS(__VA_ARGS__) #define KALEIDOSCOPE_INIT_PLUGINS(...) _KALEIDOSCOPE_INIT_PLUGINS(__VA_ARGS__)
// For compatibility reasons we export class Runtime_ as Kaleidoscope_
// in global namespace.
//
DEPRECATED(GLOBAL_TYPENAME_KALEIDOSCOPE)
typedef kaleidoscope::Runtime_ Kaleidoscope_;
// For compatibility/usability reasons we enable the global variable // For compatibility/usability reasons we enable the global variable
// Kaleidoscope in global namespace. // Kaleidoscope in global namespace.
// //

@ -48,11 +48,3 @@
"\n" \ "\n" \
"For further information and examples on how to do that, \n" \ "For further information and examples on how to do that, \n" \
"please see UPGRADING.md." "please see UPGRADING.md."
#define _DEPRECATED_MESSAGE_GLOBAL_VARIABLE_KALEIDOSCOPE \
"Variable `Kaleidoscope` in global namespace has been deprecated.\n" \
"Please use `kaleidoscope::Runtime` instead."
#define _DEPRECATED_MESSAGE_GLOBAL_TYPENAME_KALEIDOSCOPE \
"Type `Kaleidoscope_` in global namespace has been deprecated.\n" \
"Please use `kaleidoscope::Runtime_` instead."

Loading…
Cancel
Save