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 '51fef2b33e'
${ noResults }
Kaleidoscope/src/kaleidoscope/key_defs/keymaps.h

80 lines
3.3 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
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 <stdint.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_internal/deprecations.h"
layers: Add a MoveToLayer(n) key While `ShiftToLayer` and `LockLayer` activate the given layer, and keep all others active as well, `MoveToLayer` activates the given layer, and deactivates all others. This allows one to have discrete layers that stand on their own, without any other layers interfering. Basically, this is a different way to work with layers, a less powerful, but also simpler one. Fixes #564. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
5 years ago
static const uint8_t LAYER_OP_OFFSET = 42;
static const uint8_t LAYER_SHIFT_OFFSET = LAYER_OP_OFFSET;
static const uint8_t LAYER_MOVE_OFFSET = LAYER_SHIFT_OFFSET + LAYER_OP_OFFSET;;
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
#define KEYMAP_0 0
#define KEYMAP_1 1
#define KEYMAP_2 2
#define KEYMAP_3 3
#define KEYMAP_4 4
#define KEYMAP_5 5
#define KEYMAP_6 6
#define KEYMAP_7 7
#define KEYMAP_PREVIOUS 33
#define KEYMAP_NEXT 34
Rebuild all key definitions to use the new Key() constructor Brace-initialization has issues, especially with newer compilers that try to do more, and better optimizations. To allow them to do these, we should be striving for better type safety. For this reason, use the new Key() constructors to initialize the various key defines. This gives the compiler much better hints. The code becomes much more readable too. This is fully backwards compatible, we're not removing any existing interface, just using a newly introduced one. The old ways still work. They might produce warnings with newer compilers, but they did so before anyway. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
#define Key_Keymap0 Key(KEYMAP_0, KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP)
#define Key_Keymap1 Key(KEYMAP_1, KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP)
#define Key_Keymap2 Key(KEYMAP_2, KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP)
#define Key_Keymap3 Key(KEYMAP_3, KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP)
#define Key_Keymap4 Key(KEYMAP_4, KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP)
#define Key_Keymap5 Key(KEYMAP_5, KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP)
#define Key_Keymap0_Momentary Key(KEYMAP_0 + LAYER_SHIFT_OFFSET, KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP)
#define Key_Keymap1_Momentary Key(KEYMAP_1 + LAYER_SHIFT_OFFSET, KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP)
#define Key_Keymap2_Momentary Key(KEYMAP_2 + LAYER_SHIFT_OFFSET, KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP)
#define Key_Keymap3_Momentary Key(KEYMAP_3 + LAYER_SHIFT_OFFSET, KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP)
#define Key_Keymap4_Momentary Key(KEYMAP_4 + LAYER_SHIFT_OFFSET, KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP)
#define Key_Keymap5_Momentary Key(KEYMAP_5 + LAYER_SHIFT_OFFSET, KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP)
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
Rebuild all key definitions to use the new Key() constructor Brace-initialization has issues, especially with newer compilers that try to do more, and better optimizations. To allow them to do these, we should be striving for better type safety. For this reason, use the new Key() constructors to initialize the various key defines. This gives the compiler much better hints. The code becomes much more readable too. This is fully backwards compatible, we're not removing any existing interface, just using a newly introduced one. The old ways still work. They might produce warnings with newer compilers, but they did so before anyway. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
#define Key_KeymapNext_Momentary Key(KEYMAP_NEXT + LAYER_SHIFT_OFFSET, KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP)
#define Key_KeymapPrevious_Momentary Key(KEYMAP_PREVIOUS + LAYER_SHIFT_OFFSET, KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP)
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
/** Lock/Unlock layer `n`.
*
* When locking a layer, it will remain active until unlocked explicitly. `n`
* can be a number, or an enum value declared previously.
*/
Rebuild all key definitions to use the new Key() constructor Brace-initialization has issues, especially with newer compilers that try to do more, and better optimizations. To allow them to do these, we should be striving for better type safety. For this reason, use the new Key() constructors to initialize the various key defines. This gives the compiler much better hints. The code becomes much more readable too. This is fully backwards compatible, we're not removing any existing interface, just using a newly introduced one. The old ways still work. They might produce warnings with newer compilers, but they did so before anyway. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
#define LockLayer(n) Key(n, KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP)
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
#define UnlockLayer(n) LockLayer(n)
/** Temporarily shift to layer `n`.
*
* Shifts to layer `n` for as long as the key is held. When the key is
* released, the layer shifts back too. `n` can be a number, or an enum
* value declared previously.
*/
Rebuild all key definitions to use the new Key() constructor Brace-initialization has issues, especially with newer compilers that try to do more, and better optimizations. To allow them to do these, we should be striving for better type safety. For this reason, use the new Key() constructors to initialize the various key defines. This gives the compiler much better hints. The code becomes much more readable too. This is fully backwards compatible, we're not removing any existing interface, just using a newly introduced one. The old ways still work. They might produce warnings with newer compilers, but they did so before anyway. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
#define ShiftToLayer(n) Key(n + LAYER_SHIFT_OFFSET, KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP)
layers: Add a MoveToLayer(n) key While `ShiftToLayer` and `LockLayer` activate the given layer, and keep all others active as well, `MoveToLayer` activates the given layer, and deactivates all others. This allows one to have discrete layers that stand on their own, without any other layers interfering. Basically, this is a different way to work with layers, a less powerful, but also simpler one. Fixes #564. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
5 years ago
/** Move to layer `n`.
*
* Moving to a layer disables all other layers. Unlike locking and shifting to,
* this is a one-way operation.
*/
#define MoveToLayer(n) Key(n + LAYER_MOVE_OFFSET, KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP)