alpha
/
Kaleidoscope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '67155b84ad'
${ noResults }
Kaleidoscope/src/kaleidoscope_internal/device.cpp

22 lines
810 B
Raw Normal View History Unescape

Redesign how the hardware objects are defined Instead of having to define `HARDWARE_IMPLEMENTATION` to the class name of the device, and define `KeyboardHardware` from within the plugin, let all devices set `kaleidoscope::Device` to their own class via a typedef. Furthermore, instead of `KeyboardHardware`, use `Kaleidoscope.device()` instead. This makes device plugins a little bit simpler, and our naming more consistent. Because some parts of the firmware need to access the device object before the `Kaleidoscope` object is available, we can't make it a member of that. For this reason, the device object is `kaleidoscope_internal::device`, and `Kaleidoscope.device()` wraps it. In general, the wrapper should be used. But if access to the device is required before `Kaleidoscope` is available, then that's also available. The `Kaleidoscope` object grew a few more wrappers: `storage()` and `serialPort()`, so that one doesn't need to use `Kaleidoscope.device()` directly, but can use the wrappers, which are noticably shorter to write. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
5 years ago
/* kaleidoscope_internal::device - Global device object for internal use
* Copyright (C) 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 <http://www.gnu.org/licenses/>.
*/
Extracted and renamed class Kaleidoscope->Runtime This was done to enable separate inclusion of the central runtime class without having to include the central header kaleidoscope/Kaleidoscope.h which used to pull in a lot of stuff that is not required in many compilation units. The new class `Runtime_` lives in namespace kaleidoscope its singleton instance is `kaleidoscope::Runtime`. It is now only available internally in library Kaleidoscope but not from the sketch. The original class name `Kaleidoscope_` in global scope has been deprecated. The original instance name `Kaleidoscope` in global scope has been preserved to be used by end users in their sketches. Signed-off-by: Florian Fleissner <florian.fleissner@inpartik.de>
5 years ago
#include "kaleidoscope_internal/device.h"
Redesign how the hardware objects are defined Instead of having to define `HARDWARE_IMPLEMENTATION` to the class name of the device, and define `KeyboardHardware` from within the plugin, let all devices set `kaleidoscope::Device` to their own class via a typedef. Furthermore, instead of `KeyboardHardware`, use `Kaleidoscope.device()` instead. This makes device plugins a little bit simpler, and our naming more consistent. Because some parts of the firmware need to access the device object before the `Kaleidoscope` object is available, we can't make it a member of that. For this reason, the device object is `kaleidoscope_internal::device`, and `Kaleidoscope.device()` wraps it. In general, the wrapper should be used. But if access to the device is required before `Kaleidoscope` is available, then that's also available. The `Kaleidoscope` object grew a few more wrappers: `storage()` and `serialPort()`, so that one doesn't need to use `Kaleidoscope.device()` directly, but can use the wrappers, which are noticably shorter to write. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
5 years ago
namespace kaleidoscope_internal {
kaleidoscope::Device device;
}