Extend Qukeys to support adding Qukeys in the keymap #1408
Conversation
| /// This defines a `Key` object that will be handled by the Qukey plugin. | ||
| /// The argument `n` is the index number of the `Qukey` in the array (starting | ||
| /// at zero). | ||
| constexpr kaleidoscope::Key QK(uint8_t n) { | ||
| return kaleidoscope::Key(kaleidoscope::ranges::QK_FIRST + n); | ||
| } |
There was a problem hiding this comment.
Mostly copy/paste from CharShift. I noticed that LayerTapKey and ModTapKey are defined within kaleidoscope::plugin above and that macros are used to expose those in a user friendly way. Any preference on either of those?
EvyBongers
force-pushed
the
feat/inKeymapQukeys
branch
from
0bc87a7
to
3c8edaf
Compare
|
I don't feel like I have time to help much (I haven't even looked at Kaleidoscope code in what seems a very long time), but I can recall that the idea was to have it work in much the same way a CharShift, with essentially the same (or equivalent) It seems like you've got the same idea I had, so 👍. As for how to do deprecation of the old stuff…I'm sure I could remind myself how to go about it at some point. When I did that in the past, I tried to use preprocessor directives to isolate the code that would later be removed, both to make it easier to do the removal correctly, and to make it possibly to compile a smaller binary with the deprecated code stripped out. I'm sure there are a few old PRs that demonstrate how it was done then. I'm sure I can manage to find time to do an actual code review at an appropriate time, if that would be helpful. |
Signed-off-by: Evy Bongers <[email protected]>
Signed-off-by: Evy Bongers <[email protected]>
Signed-off-by: Evy Bongers <[email protected]>
Signed-off-by: Evy Bongers <[email protected]>
EvyBongers
force-pushed
the
feat/inKeymapQukeys
branch
from
3c8edaf
to
00c7fb2
Compare
Signed-off-by: Evy Bongers <[email protected]>
Signed-off-by: Evy Bongers <[email protected]>
Signed-off-by: Evy Bongers <[email protected]>
Signed-off-by: Evy Bongers <[email protected]>
Signed-off-by: Evy Bongers <[email protected]>
Signed-off-by: Evy Bongers <[email protected]>
| @@ -55,6 +57,12 @@ constexpr Key LayerTapKey(uint8_t layer, Key tap_key) { | |||
| (layer << 8) + tap_key.getKeyCode()); | |||
| } | |||
|
|
|||
| constexpr Key Qkey(Key primary_key, Key secondary_key) { | |||
There was a problem hiding this comment.
Gonna need to find a way to fix the name collision with constexpr Qukey(int8_t layer, KeyAddr k, Key alternate_key) below, unless you're okay with keeping it like this.
Signed-off-by: Evy Bongers <[email protected]>
Signed-off-by: Evy Bongers <[email protected]>
| @@ -158,6 +167,10 @@ class Qukeys : public kaleidoscope::Plugin { | |||
| EventHandlerResult afterEachCycle(); | |||
|
|
|||
| private: | |||
| // An array of Qkeys in PROGMEM. | |||
| Key const *qkeys_ PROGMEM; | |||
There was a problem hiding this comment.
I'm not sure if this needs to be initialized somehow.
| constexpr Key Qkey(Key tap_key, Key qkey) { | ||
| uint8_t qkey_index = Qukeys.storeQkey(qkey); | ||
| // TODO(EvyBongers): store the qkey index somewhere, somehow | ||
| return Key(kaleidoscope::ranges::QK_FIRST + tap_key.getRaw()); | ||
| } |
There was a problem hiding this comment.
My first thought was to use the same approach as with the ModTap and LayerTap keys, but if I grokked the logic of storing key code and flags in the Key class correctly, that would not be possible without functionality. Now I just need to find some way to store the reference.
There was a problem hiding this comment.
On second thought, simply using the sum of these values seems bound to go wrong. I might have to store both key values in PROGMEM (or EEPROM) and return the sum of QK_FIRST and the returned index.
Signed-off-by: Evy Bongers <[email protected]>
|
I fail to come up with any way to make this work. I would love to see the full functionality of Qukeys available through Chrysalis, but I'm out of ideas on how to work toward that goal. |
No description provided.