|
|
|
/* Kaleidoscope - Firmware for computer input devices
|
|
|
|
* Copyright (C) 2013-2018 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/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include <Arduino.h>
|
|
|
|
#include "kaleidoscope/key_defs.h"
|
|
|
|
#include "kaleidoscope/keymaps.h"
|
|
|
|
#include "kaleidoscope/device/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
|
|
|
#include "kaleidoscope_internal/device.h"
|
|
|
|
#include "kaleidoscope_internal/sketch_exploration/sketch_exploration.h"
|
|
|
|
|
|
|
|
// Macro for defining the keymap. This should be used in the sketch
|
|
|
|
// file (*.ino) to define the keymap[] array that holds the user's
|
|
|
|
// layers. It also computes the number of layers in that keymap.
|
|
|
|
#define KEYMAPS(layers...) __NL__ \
|
|
|
|
constexpr Key keymaps_linear[][kaleidoscope_internal::device.matrix_rows * kaleidoscope_internal::device.matrix_columns] PROGMEM = { layers }; __NL__ \
|
|
|
|
uint8_t layer_count __NL__ \
|
|
|
|
= sizeof(keymaps_linear) / sizeof(*keymaps_linear); __NL__ \
|
|
|
|
__NL__ \
|
|
|
|
/* This deprecated compatibility wrapper is removed by the linker if __NL__ \
|
|
|
|
it is not accessed nowhere. __NL__ \
|
|
|
|
*/ __NL__ \
|
|
|
|
kaleidoscope::internal::Keymaps2DInterface keymaps; __NL__ \
|
|
|
|
__NL__ \
|
|
|
|
_INIT_SKETCH_EXPLORATION
|
|
|
|
|
|
|
|
extern uint8_t layer_count;
|
|
|
|
|
|
|
|
namespace kaleidoscope {
|
|
|
|
class Layer_ {
|
|
|
|
public:
|
|
|
|
Layer_() {}
|
|
|
|
|
|
|
|
/* There are two lookup functions, because we have two caches, and different
|
|
|
|
* parts of the firmware will want to use either this or that (or perhaps
|
|
|
|
* both, in rare cases).
|
|
|
|
*
|
|
|
|
* First of all, we use caches because looking up a key through all the layers
|
|
|
|
* is costy, and the cost increases dramatically the more layers we have.
|
|
|
|
*
|
|
|
|
* Then, we have the `liveCompositeKeymap`, because to have layer behaviours
|
|
|
|
* we want, that is, if you hold a key on a layer, release the layer key but
|
|
|
|
* continue holding the other, we want for the layered keycode to continue
|
|
|
|
* repeating.
|
|
|
|
*
|
|
|
|
* At the same time, we want other keys to not be affected by the
|
|
|
|
* now-turned-off layer. So we update the keycode in the cache on-demand, when
|
|
|
|
* the key is pressed. (see the top of `handleKeyswitchEvent`).
|
|
|
|
*
|
|
|
|
* On the other hand, we also have plugins that scan the whole keymap, and do
|
|
|
|
* things based on that information, such as highlighting keys that changed
|
|
|
|
* between layers. These need to be able to look at a state of where the
|
|
|
|
* keymap *should* be, not necessarily where it is. The `liveCompositeKeymap`
|
|
|
|
* is not useful here. So we use `activeLayers` which we update whenever
|
|
|
|
* layers change (see `Layer.on` and `Layer.off`), and it updates the cache to
|
|
|
|
* show how the keymap should look, without the `liveCompositeKeymap`-induced
|
|
|
|
* behaviour.
|
|
|
|
*
|
|
|
|
* Thus, if we are curious about what a given key will do, use `lookup`. If we
|
|
|
|
* are curious what the active layer state describes the key as, use
|
|
|
|
* `lookupOnActiveLayer`.
|
|
|
|
*/
|
|
|
|
static Key lookup(KeyAddr key_addr) {
|
|
|
|
return live_composite_keymap_[key_addr.toInt()];
|
|
|
|
}
|
|
|
|
DEPRECATED(ROW_COL_FUNC) static Key lookup(byte row, byte col) {
|
|
|
|
return live_composite_keymap_[KeyAddr(row, col).toInt()];
|
|
|
|
}
|
|
|
|
static Key lookupOnActiveLayer(KeyAddr key_addr) {
|
|
|
|
uint8_t layer = active_layers_[key_addr.toInt()];
|
|
|
|
return (*getKey)(layer, key_addr);
|
|
|
|
}
|
|
|
|
DEPRECATED(ROW_COL_FUNC) static Key lookupOnActiveLayer(byte row, byte col) {
|
|
|
|
KeyAddr key_addr(row, col);
|
|
|
|
uint8_t layer = active_layers_[key_addr.toInt()];
|
|
|
|
return (*getKey)(layer, key_addr);
|
|
|
|
}
|
|
|
|
static uint8_t lookupActiveLayer(KeyAddr key_addr) {
|
|
|
|
return active_layers_[key_addr.toInt()];
|
|
|
|
}
|
|
|
|
DEPRECATED(ROW_COL_FUNC) static uint8_t lookupActiveLayer(byte row, byte col) {
|
|
|
|
return active_layers_[KeyAddr(row, col).toInt()];
|
Layer: Rename a few methods, for better clarity
In general, we want method names to be verbs, because they convey actions. The
`Layer.on()`, `Layer.off()`, etc family of functions weren't like that. It
wasn't immediately obvious that they turn layers on and off.
Furthermore, `Layer.next()` and `Layer.previous()` were even more confusing,
because one could easily think they implied moving to the selected layers, while
in practice, they just activated them.
All of these have new names, that better describe what they do. The old names
are still present, but emit a deprecation warning.
Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
|
|
|
}
|
|
|
|
|
|
|
|
static void activate(uint8_t layer);
|
|
|
|
static void deactivate(uint8_t layer);
|
|
|
|
static void activateNext();
|
|
|
|
static void deactivateTop();
|
|
|
|
static void move(uint8_t layer);
|
|
|
|
|
|
|
|
static uint8_t top(void) {
|
Layer: Rename a few methods, for better clarity
In general, we want method names to be verbs, because they convey actions. The
`Layer.on()`, `Layer.off()`, etc family of functions weren't like that. It
wasn't immediately obvious that they turn layers on and off.
Furthermore, `Layer.next()` and `Layer.previous()` were even more confusing,
because one could easily think they implied moving to the selected layers, while
in practice, they just activated them.
All of these have new names, that better describe what they do. The old names
are still present, but emit a deprecation warning.
Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
|
|
|
return top_active_layer_;
|
|
|
|
}
|
Layer: Rename a few methods, for better clarity
In general, we want method names to be verbs, because they convey actions. The
`Layer.on()`, `Layer.off()`, etc family of functions weren't like that. It
wasn't immediately obvious that they turn layers on and off.
Furthermore, `Layer.next()` and `Layer.previous()` were even more confusing,
because one could easily think they implied moving to the selected layers, while
in practice, they just activated them.
All of these have new names, that better describe what they do. The old names
are still present, but emit a deprecation warning.
Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
|
|
|
static boolean isActive(uint8_t layer);
|
|
|
|
|
Layer: Rename a few methods, for better clarity
In general, we want method names to be verbs, because they convey actions. The
`Layer.on()`, `Layer.off()`, etc family of functions weren't like that. It
wasn't immediately obvious that they turn layers on and off.
Furthermore, `Layer.next()` and `Layer.previous()` were even more confusing,
because one could easily think they implied moving to the selected layers, while
in practice, they just activated them.
All of these have new names, that better describe what they do. The old names
are still present, but emit a deprecation warning.
Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
|
|
|
static uint32_t getLayerState(void) {
|
|
|
|
return layer_state_;
|
|
|
|
}
|
|
|
|
|
|
|
|
static Key eventHandler(Key mappedKey, KeyAddr key_addr, uint8_t keyState);
|
|
|
|
DEPRECATED(ROW_COL_FUNC) static Key eventHandler(Key mappedKey, byte row, byte col, uint8_t keyState) {
|
|
|
|
return eventHandler(mappedKey, KeyAddr(row, col), keyState);
|
|
|
|
}
|
|
|
|
|
|
|
|
typedef Key(*GetKeyFunction)(uint8_t layer, KeyAddr key_addr);
|
|
|
|
static GetKeyFunction getKey;
|
|
|
|
|
|
|
|
static Key getKeyFromPROGMEM(uint8_t layer, KeyAddr key_addr);
|
|
|
|
DEPRECATED(ROW_COL_FUNC) static Key getKeyFromPROGMEM(uint8_t layer, byte row, byte col) {
|
|
|
|
return getKeyFromPROGMEM(layer, KeyAddr(row, col));
|
|
|
|
}
|
|
|
|
|
|
|
|
static void updateLiveCompositeKeymap(KeyAddr key_addr, Key mappedKey) {
|
|
|
|
live_composite_keymap_[key_addr.toInt()] = mappedKey;
|
|
|
|
}
|
|
|
|
DEPRECATED(ROW_COL_FUNC) static void updateLiveCompositeKeymap(byte row, byte col, Key mappedKey) {
|
|
|
|
updateLiveCompositeKeymap(KeyAddr(row, col), mappedKey);
|
|
|
|
}
|
|
|
|
static void updateLiveCompositeKeymap(KeyAddr key_addr);
|
|
|
|
DEPRECATED(ROW_COL_FUNC) static void updateLiveCompositeKeymap(byte row, byte col) {
|
|
|
|
updateLiveCompositeKeymap(KeyAddr(row, col));
|
|
|
|
}
|
|
|
|
static void updateActiveLayers(void);
|
|
|
|
|
|
|
|
private:
|
Layer: Rename a few methods, for better clarity
In general, we want method names to be verbs, because they convey actions. The
`Layer.on()`, `Layer.off()`, etc family of functions weren't like that. It
wasn't immediately obvious that they turn layers on and off.
Furthermore, `Layer.next()` and `Layer.previous()` were even more confusing,
because one could easily think they implied moving to the selected layers, while
in practice, they just activated them.
All of these have new names, that better describe what they do. The old names
are still present, but emit a deprecation warning.
Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
|
|
|
static uint32_t layer_state_;
|
|
|
|
static uint8_t top_active_layer_;
|
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
|
|
|
static Key live_composite_keymap_[kaleidoscope_internal::device.numKeys()];
|
|
|
|
static uint8_t active_layers_[kaleidoscope_internal::device.numKeys()];
|
|
|
|
|
|
|
|
static void handleKeymapKeyswitchEvent(Key keymapEntry, uint8_t keyState);
|
Layer: Rename a few methods, for better clarity
In general, we want method names to be verbs, because they convey actions. The
`Layer.on()`, `Layer.off()`, etc family of functions weren't like that. It
wasn't immediately obvious that they turn layers on and off.
Furthermore, `Layer.next()` and `Layer.previous()` were even more confusing,
because one could easily think they implied moving to the selected layers, while
in practice, they just activated them.
All of these have new names, that better describe what they do. The old names
are still present, but emit a deprecation warning.
Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
|
|
|
static void updateTopActiveLayer(void);
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
extern kaleidoscope::Layer_ Layer;
|