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 '00552193e9'
${ noResults }
Kaleidoscope/src/kaleidoscope/layers.h

123 lines
4.7 KiB
Raw Normal View History Unescape

Move most sources to a kaleidoscope/ subdir and namespace Lots of things were already under the `kaleidoscope` namespace, but were in the "wrong" directory. This big patchset moves everything under `kaleidoscope/`, and namespaces `Layers_`. There are a few un-namespaced things, but because their use is so widespread, and they're used so commonly, we don't want to namespace those (like `handleKeyswitchEvent`), at least not yet. As a minor side-effect, this moves a few global statics that were once in `Layers.cpp` into the `Layer_` class itself, for clarity and encapsulation. Non-namespaced headers that were used outside of Kaleidoscope itself will still work, but will emit a compile-time warning. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
/* 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"
Keymaps converted from 2D to 1D arrays New `PER_KEY_DATA` and `PER_KEY_DATA_STACKED` macros were introduced that can be used to feed keymap associated information to functions, constructors or to initialize the keymap. The user accessed macros `KEYMAP` and `KEYMAP_STACKED` are now wrappers that pass `XXX` as default value for unused keys. The new keymap array is named `keymap_linear`. The old symbol name is now used for a deprecated compatibility wrapper data structure. Signed-off-by: Florian Fleissner <florian.fleissner@inpartik.de>
6 years ago
#include "kaleidoscope/keymaps.h"
Move most sources to a kaleidoscope/ subdir and namespace Lots of things were already under the `kaleidoscope` namespace, but were in the "wrong" directory. This big patchset moves everything under `kaleidoscope/`, and namespaces `Layers_`. There are a few un-namespaced things, but because their use is so widespread, and they're used so commonly, we don't want to namespace those (like `handleKeyswitchEvent`), at least not yet. As a minor side-effect, this moves a few global statics that were once in `Layers.cpp` into the `Layer_` class itself, for clarity and encapsulation. Non-namespaced headers that were used outside of Kaleidoscope itself will still work, but will emit a compile-time warning. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
#include KALEIDOSCOPE_HARDWARE_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.
Keymaps converted from 2D to 1D arrays New `PER_KEY_DATA` and `PER_KEY_DATA_STACKED` macros were introduced that can be used to feed keymap associated information to functions, constructors or to initialize the keymap. The user accessed macros `KEYMAP` and `KEYMAP_STACKED` are now wrappers that pass `XXX` as default value for unused keys. The new keymap array is named `keymap_linear`. The old symbol name is now used for a deprecated compatibility wrapper data structure. Signed-off-by: Florian Fleissner <florian.fleissner@inpartik.de>
6 years ago
#define KEYMAPS(layers...) __NL__ \
const Key keymaps_linear[][ROWS*COLS] 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;
Move most sources to a kaleidoscope/ subdir and namespace Lots of things were already under the `kaleidoscope` namespace, but were in the "wrong" directory. This big patchset moves everything under `kaleidoscope/`, and namespaces `Layers_`. There are a few un-namespaced things, but because their use is so widespread, and they're used so commonly, we don't want to namespace those (like `handleKeyswitchEvent`), at least not yet. As a minor side-effect, this moves a few global statics that were once in `Layers.cpp` into the `Layer_` class itself, for clarity and encapsulation. Non-namespaced headers that were used outside of Kaleidoscope itself will still work, but will emit a compile-time warning. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
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(byte row, byte col) {
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 live_composite_keymap_[row][col];
Move most sources to a kaleidoscope/ subdir and namespace Lots of things were already under the `kaleidoscope` namespace, but were in the "wrong" directory. This big patchset moves everything under `kaleidoscope/`, and namespaces `Layers_`. There are a few un-namespaced things, but because their use is so widespread, and they're used so commonly, we don't want to namespace those (like `handleKeyswitchEvent`), at least not yet. As a minor side-effect, this moves a few global statics that were once in `Layers.cpp` into the `Layer_` class itself, for clarity and encapsulation. Non-namespaced headers that were used outside of Kaleidoscope itself will still work, but will emit a compile-time warning. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
}
static Key lookupOnActiveLayer(byte row, byte col) {
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
uint8_t layer = active_layers_[row][col];
Move most sources to a kaleidoscope/ subdir and namespace Lots of things were already under the `kaleidoscope` namespace, but were in the "wrong" directory. This big patchset moves everything under `kaleidoscope/`, and namespaces `Layers_`. There are a few un-namespaced things, but because their use is so widespread, and they're used so commonly, we don't want to namespace those (like `handleKeyswitchEvent`), at least not yet. As a minor side-effect, this moves a few global statics that were once in `Layers.cpp` into the `Layer_` class itself, for clarity and encapsulation. Non-namespaced headers that were used outside of Kaleidoscope itself will still work, but will emit a compile-time warning. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
return (*getKey)(layer, row, col);
}
static uint8_t lookupActiveLayer(byte row, byte col) {
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 active_layers_[row][col];
}
static void activate(uint8_t layer);
static void deactivate(uint8_t layer);
static void activateNext();
static void deactivateTop();
Move most sources to a kaleidoscope/ subdir and namespace Lots of things were already under the `kaleidoscope` namespace, but were in the "wrong" directory. This big patchset moves everything under `kaleidoscope/`, and namespaces `Layers_`. There are a few un-namespaced things, but because their use is so widespread, and they're used so commonly, we don't want to namespace those (like `handleKeyswitchEvent`), at least not yet. As a minor side-effect, this moves a few global statics that were once in `Layers.cpp` into the `Layer_` class itself, for clarity and encapsulation. Non-namespaced headers that were used outside of Kaleidoscope itself will still work, but will emit a compile-time warning. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
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_;
Move most sources to a kaleidoscope/ subdir and namespace Lots of things were already under the `kaleidoscope` namespace, but were in the "wrong" directory. This big patchset moves everything under `kaleidoscope/`, and namespaces `Layers_`. There are a few un-namespaced things, but because their use is so widespread, and they're used so commonly, we don't want to namespace those (like `handleKeyswitchEvent`), at least not yet. As a minor side-effect, this moves a few global statics that were once in `Layers.cpp` into the `Layer_` class itself, for clarity and encapsulation. Non-namespaced headers that were used outside of Kaleidoscope itself will still work, but will emit a compile-time warning. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
}
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);
Move most sources to a kaleidoscope/ subdir and namespace Lots of things were already under the `kaleidoscope` namespace, but were in the "wrong" directory. This big patchset moves everything under `kaleidoscope/`, and namespaces `Layers_`. There are a few un-namespaced things, but because their use is so widespread, and they're used so commonly, we don't want to namespace those (like `handleKeyswitchEvent`), at least not yet. As a minor side-effect, this moves a few global statics that were once in `Layers.cpp` into the `Layer_` class itself, for clarity and encapsulation. Non-namespaced headers that were used outside of Kaleidoscope itself will still work, but will emit a compile-time warning. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
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_;
}
Move most sources to a kaleidoscope/ subdir and namespace Lots of things were already under the `kaleidoscope` namespace, but were in the "wrong" directory. This big patchset moves everything under `kaleidoscope/`, and namespaces `Layers_`. There are a few un-namespaced things, but because their use is so widespread, and they're used so commonly, we don't want to namespace those (like `handleKeyswitchEvent`), at least not yet. As a minor side-effect, this moves a few global statics that were once in `Layers.cpp` into the `Layer_` class itself, for clarity and encapsulation. Non-namespaced headers that were used outside of Kaleidoscope itself will still work, but will emit a compile-time warning. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
static Key eventHandler(Key mappedKey, byte row, byte col, uint8_t keyState);
static Key(*getKey)(uint8_t layer, byte row, byte col);
static Key getKeyFromPROGMEM(uint8_t layer, byte row, byte col);
static void updateLiveCompositeKeymap(byte row, byte col);
Added alternate method to update live_composite_keymap_ This adds a new version of `updateLiveCompositeKeymap()` which takes three parameters: row, column, and a `Key` value. Instead of looking up the value to update in the key map, it just updates `live_composite_keymap_` with the specified `Key` value. Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
6 years ago
static void updateLiveCompositeKeymap(byte row, byte col, Key mappedKey) {
live_composite_keymap_[row][col] = mappedKey;
}
Move most sources to a kaleidoscope/ subdir and namespace Lots of things were already under the `kaleidoscope` namespace, but were in the "wrong" directory. This big patchset moves everything under `kaleidoscope/`, and namespaces `Layers_`. There are a few un-namespaced things, but because their use is so widespread, and they're used so commonly, we don't want to namespace those (like `handleKeyswitchEvent`), at least not yet. As a minor side-effect, this moves a few global statics that were once in `Layers.cpp` into the `Layer_` class itself, for clarity and encapsulation. Non-namespaced headers that were used outside of Kaleidoscope itself will still work, but will emit a compile-time warning. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
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_;
static Key live_composite_keymap_[ROWS][COLS];
static uint8_t active_layers_[ROWS][COLS];
Move most sources to a kaleidoscope/ subdir and namespace Lots of things were already under the `kaleidoscope` namespace, but were in the "wrong" directory. This big patchset moves everything under `kaleidoscope/`, and namespaces `Layers_`. There are a few un-namespaced things, but because their use is so widespread, and they're used so commonly, we don't want to namespace those (like `handleKeyswitchEvent`), at least not yet. As a minor side-effect, this moves a few global statics that were once in `Layers.cpp` into the `Layer_` class itself, for clarity and encapsulation. Non-namespaced headers that were used outside of Kaleidoscope itself will still work, but will emit a compile-time warning. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
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);
Move most sources to a kaleidoscope/ subdir and namespace Lots of things were already under the `kaleidoscope` namespace, but were in the "wrong" directory. This big patchset moves everything under `kaleidoscope/`, and namespaces `Layers_`. There are a few un-namespaced things, but because their use is so widespread, and they're used so commonly, we don't want to namespace those (like `handleKeyswitchEvent`), at least not yet. As a minor side-effect, this moves a few global statics that were once in `Layers.cpp` into the `Layer_` class itself, for clarity and encapsulation. Non-namespaced headers that were used outside of Kaleidoscope itself will still work, but will emit a compile-time warning. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
};
}
extern kaleidoscope::Layer_ Layer;