opensteno_qmk/users/csc027/defines.h
csc027 1b8cb95f2e [Keymap] csc027/macro-sync-keymap (#7873)
* Basic functionality to synchronize the strings and enums using C preprocessor macros.

* Updated all the custom convenience macros to work.

* Removed some duplicate update_tri_layer calls.

* Simplified the convenience accelerator macros for synchronizing enums and strings by removing the short enum names.

* Updated the CUSTOM_MACROS macro to use SS_LCTL instead of SS_LCTRL.

* Fixed a bug where the right side of the convenience layer in the Iris keymap was incorrectly listed twice.

* Removed the tenkey from the convenience layer.  Added Windows 10 virtual desktop shortcuts to the convenience layer.

* Fixed a bug where the macro range was not set correctly.

* Added sigil values for the keycode enum so that additions to the sync macros will not require changes to the process_record_user ranges.

* Hacked send_string_P to work with ChibiOS boards.

* Switched to using I2C for the Iris keyboard.

* Finished a comment.

* Updated comments to explain that for non-AVR MCUs, the PROGMEM macro doesn't do anything.

* Updated the synchronization macros to use the more descriptive "NAME" instead of "CALL".  Moved the Control-Alt-Delete chord macro to the  synchronization macro.

* Simplified the custom macros by consolidating the macros into a context change macro instead of using alt-tab and minimize macros.

* Fixed a formatting issue where several tabs were used instead of 4 spaces.

* Added more comments to explain the synchronization macros.

* Simplified the PARAMS macro, since any parameters could be passed with a space by the declarer instead.

* Consolidated the synchronization macros into a single list.  Simplified the synchronization mechanism.

* Removed the overloading macro, since it is no longer needed.

* Updated the convenience layer comments to reflect the changes made.

* Renamed the git_macros pointer table to custom_macros, since it no longer solely consists of git macros.

* Clarified that the send_string_P function's use of pgm_read_byte is different for AVR and non-AVR compilation targets.
2020-01-13 09:41:13 -08:00

270 lines
17 KiB
C

#pragma once
#include "csc027.h"
#define MC_RSFE RSFT_T(KC_ENT) // Right Shift on hold, Enter on tap
#define MC_LSEC LSFT_T(KC_ESC) // Left Shift on hold, Escape on tap
#define ________________ KC_TRNS
/* QWERTY Layer
*
* The basic layer of this keymap is a QWERTY layer.
*
* - Modifier keys more closely resemble a standard keyboard's layout.
* - There is a "Nxt L" function that cycles through the QWERTY and
* game layers. This has been implemented by hard coding the jump to the
* next layer in each of the layers using the TO() macro. Currently, the
* "Nxt L" function skips over the momentary layers (i.e., Mouse, Git,
* Lower, Raise, and Convenience layers).
* - There is a "Rst L" function that resets the current layer to the
* QWERTY layer.
* - The "Git" one shot function goes to the macro layer which has Git
* commands implemented.
* - The "Convc" momentary function goes to the Convenience layer which has a
* tenkey. Note: The tenkey will operate using the secondary functions if
* the Number Lock is not enabled (e.g., Left and Right instead of 4 and
* 6).
* - The Right Shift key also doubles as an Enter key if it is tapped rather
* than held.
*
* ,-----------------------------------. ,-----------------------------------.
* | Tab | Q | W | E | R | T | | Y | U | I | O | P |BkSpc|
* |-----------------------------------| |-----------------------------------|
* | Esc | A | S | D | F | G | | H | J | K | L | ; | ' |
* |-----------------------------------| |-----------------------------------|
* |Shift| Z | X | C | V | B | | N | M | , | . | / |Sf/En|
* |-----------------------------------| |-----------------------------------|
* |Cntrl|Super| Alt |Convc|Lower|Space| |Space|Raise| \ | Git |Nxt L|Rst L|
* `-----------------------------------' `-----------------------------------'
*/
#define _____________________QWERTY_L1_____________________ KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T
#define _____________________QWERTY_L2_____________________ KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G
#define _____________________QWERTY_L3_____________________ KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B
#define _____________________QWERTY_L4_____________________ KC_LCTL, KC_LGUI, KC_LALT, MO(_CN), LOWER, KC_SPC
#define _____________________QWERTY_R1_____________________ KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC
#define _____________________QWERTY_R2_____________________ KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT
#define _____________________QWERTY_R3_____________________ KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, MC_RSFE
#define _____________________QWERTY_R4_____________________ KC_SPC, RAISE, KC_BSLS, OSL(_GT), TO(_GW), XXXXXXX
/* Raise Layer
*
* The Raise layer accommodates the Home, End, Page Up, and Page Down keys
* in what would be the Vim arrow keys positions. This is done as opposed
* to using C-D, C-U, 0, $, and ^, because it would require a separate layer.
*
* - The top row has the shifted versions of the number row, rather than the
* numbers themselves. This is a change to have a mnemonic where shifted
* elements are on the Raise layer. This also makes it easy to use some of
* Vim style movement controls (e.g. $, %), but makes it harder for others
* (e.g. ^, (, )). Consider swapping the number row with the shifted number
* row if you do not care about the mnemonic.
* - The Left Brace, Right Brace, Underscore, and Plus keys have been moved
* from the right side to the left side. This will take some getting used
* to, as these keys are normally on the right side of the keyboard. An
* alternative would be to keep the keys on the right hand side just under
* the Parentheses. This would prevent the use of Vim arrow keys however.
* - The F keys have been laid across the bottom in the Raise layer, rather
* than the Lower layer to allow easy access to the Alt-F4 chord for
* Windows. When the F keys were put in the Lower layer, it made it hard
* to use this chord, as the Lower key, the Alt key, and the F4 key were
* all right next to each other.
* - A Delete key has been added in this layer to allow easy access to the
* Control-Alt-Delete login chord for Windows.
*
* ,-----------------------------------. ,-----------------------------------.
* | ~ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | Del |
* |-----------------------------------| |-----------------------------------|
* | | _ | + | { | } | Caps| | Home| PgDn| PgUp| End | | |
* |-----------------------------------| |-----------------------------------|
* | | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10 | |
* |-----------------------------------| |-----------------------------------|
* | | | | | | | | | | | | | |
* `-----------------------------------' `-----------------------------------'
*/
#define ______________________RAISE_L1_____________________ KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC
#define ______________________RAISE_L2_____________________ _______, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_CAPS
#define ______________________RAISE_L3_____________________ _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5
#define ______________________RAISE_L4_____________________ _______, _______, _______, _______, _______, _______
#define ______________________RAISE_R1_____________________ KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DELT
#define ______________________RAISE_R2_____________________ KC_HOME, KC_PGDN, KC_PGUP, KC_END, XXXXXXX, XXXXXXX
#define ______________________RAISE_R3_____________________ KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, _______
#define ______________________RAISE_R4_____________________ _______, _______, _______, _______, XXXXXXX, XXXXXXX
/* Lower Layer
*
* The lower layout scheme accommodates the Vim style arrow keys.
*
* - The arrow keys are in the normal Vim positions.
* - The Left Square Bracket, Right Square Bracket, Minus, and Equal keys
* have been moved from the right side to the left side. This will take
* some getting used to, as it is on the left rather than the right.
* - A Delete key has been added in this layer to allow easy access to the
* Control-Alt-Delete login chord for Windows.
* - The remaining F keys are in this layer.
*
* ,-----------------------------------. ,-----------------------------------.
* | ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | Del |
* |-----------------------------------| |-----------------------------------|
* | | - | = | [ | ] | | | Left| Down| Up |Right| | |
* |-----------------------------------| |-----------------------------------|
* | | F11 | F12 | | | | | | | | | | |
* |-----------------------------------| |-----------------------------------|
* | | | | | | | | | | | | | |
* `-----------------------------------' `-----------------------------------'
*/
#define ______________________LOWER_L1_____________________ KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5
#define ______________________LOWER_L2_____________________ _______, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, XXXXXXX
#define ______________________LOWER_L3_____________________ _______, KC_F11, KC_F12, XXXXXXX, XXXXXXX, XXXXXXX
#define ______________________LOWER_L4_____________________ _______, _______, _______, _______, _______, _______
#define ______________________LOWER_R1_____________________ KC_6, KC_7, KC_8, KC_9, KC_0, KC_DELT
#define ______________________LOWER_R2_____________________ KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, XXXXXXX, XXXXXXX
#define ______________________LOWER_R3_____________________ XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______
#define ______________________LOWER_R4_____________________ _______, _______, _______, _______, XXXXXXX, XXXXXXX
/* MIT Layout (Mouse)
*
* The mouse layer adds keys to use the keyboard like a mouse.
*
* ,-----------------------------------. ,-----------------------------------.
* | | | | | | | | | | | | | |
* |-----------------------------------| |-----------------------------------|
* | | | |Ms-Lc|Ms-Rc| | | Ms-L| Ms-D| Ms-U| Ms-R| | |
* |-----------------------------------| |-----------------------------------|
* | | | | | | | | | | | | | |
* |-----------------------------------| |-----------------------------------|
* | | | | | | | | | | | | | |
* `-----------------------------------' `-----------------------------------'
*/
#define ______________________MOUSE_L1_____________________ XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
#define ______________________MOUSE_L2_____________________ _______, XXXXXXX, XXXXXXX, KC_BTN1, KC_BTN2, XXXXXXX
#define ______________________MOUSE_L3_____________________ _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
#define ______________________MOUSE_L4_____________________ _______, _______, _______, _______, _______, _______
#define ______________________MOUSE_R1_____________________ XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
#define ______________________MOUSE_R2_____________________ KC_MS_L, KC_MS_D, KC_MS_U, KC_MS_R, XXXXXXX, XXXXXXX
#define ______________________MOUSE_R3_____________________ XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______
#define ______________________MOUSE_R4_____________________ _______, _______, _______, _______, XXXXXXX, XXXXXXX
/* MIT Layout (Git)
*
* The macro layer that has common git commands.
*
* ,-----------------------------------. ,-----------------------------------.
* | |Chery| Show|Rebas|Reset| Tag | | | Pull| Init|Rmote| Push| |
* |-----------------------------------| |-----------------------------------|
* | | Add |Sttus| Diff|Fetch| Grep| |Stash| |ChkOt| Log | | |
* |-----------------------------------| |-----------------------------------|
* | | | |Comit| Move|Brnch| | |Merge| | | | |
* |-----------------------------------| |-----------------------------------|
* | | | | | | | | | | | | | |
* `-----------------------------------' `-----------------------------------'
*/
#define _______________________GIT_L1______________________ XXXXXXX, MC_cherrypick, MC_show, MC_rebase, MC_reset, MC_tag
#define _______________________GIT_L2______________________ _______, MC_add, MC_status, MC_diff, MC_fetch, MC_grep
#define _______________________GIT_L3______________________ _______, XXXXXXX, XXXXXXX, MC_commit, MC_mv, MC_branch
#define _______________________GIT_L4______________________ _______, _______, _______, _______, _______, _______
#define _______________________GIT_R1______________________ XXXXXXX, MC_pull, MC_init, MC_remote, MC_push, XXXXXXX
#define _______________________GIT_R2______________________ MC_stash, XXXXXXX, MC_checkout, MC_log, XXXXXXX, XXXXXXX
#define _______________________GIT_R3______________________ XXXXXXX, MC_merge, XXXXXXX, XXXXXXX, XXXXXXX, _______
#define _______________________GIT_R4______________________ _______, _______, _______, _______, XXXXXXX, XXXXXXX
/* MIT Layout (Convenience)
*
* The Convenience layer adds miscellaneous chords to the keyboard.
*
* - The Number Lock key is physically in the same spot as the Caps Lock key
* in the raise layer.
* - There is also a Backspace Key for convenience.
* - There is a convenience macro to type the Control-Alt-Delete login chord for Windows.
* - There is a convenience macro to switch context from the Remote Desktop to the local
* machine in Windows.
* - There are convenience macros to switch between virtual desktops in Windows.
* - There are convenience macros to create and delete virtual desktops in Windows.
*
* ,-----------------------------------. ,-----------------------------------.
* | | |Insrt|ScrLk|PrtSc| | | | | | | |BkSpc|
* |-----------------------------------| |-----------------------------------|
* | | | App | LCAD|MRDCC|NmLck| |MVTDL|MVTDC|MVTDN|MVTDR| | |
* |-----------------------------------| |-----------------------------------|
* | | | | | | | | | | | | | |
* |-----------------------------------| |-----------------------------------|
* | | | | | | | | | | | | | |
* `-----------------------------------' `-----------------------------------'
*/
#define ___________________CONVENIENCE_L1__________________ XXXXXXX, XXXXXXX, KC_INS, KC_SLCK, KC_PSCR, XXXXXXX
#define ___________________CONVENIENCE_L2__________________ _______, XXXXXXX, KC_APP, MC_lcad, MC_rdcc, KC_NLCK
#define ___________________CONVENIENCE_L3__________________ _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
#define ___________________CONVENIENCE_L4__________________ _______, _______, _______, _______, _______, _______
#define ___________________CONVENIENCE_R1__________________ XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_BSPC
#define ___________________CONVENIENCE_R2__________________ MC_vtdl, MC_vtdc, MC_vtdn, MC_vtdr, XXXXXXX, XXXXXXX
#define ___________________CONVENIENCE_R3__________________ XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______
#define ___________________CONVENIENCE_R4__________________ _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
/* Convenience macros
*
* These are accelerator macros for simplifying declaration of PROGMEM strings
*/
// Declare variable name
#define CUSTOM_VAR(VAR) mc_##VAR
// Declare PROGMEM string using the variable name
#define CUSTOM_DEF(VAR) const char CUSTOM_VAR(VAR)[] PROGMEM =
// Declare enum name
#define CUSTOM_ENUM(VAR) MC_##VAR
#define CUSTOM_MACRO_STRING(X) X
#define COMMA_DELIM(...) ,
#define SEMI_DELIM(...) ;
#define DROP(...)
/* Keycode synchronization macros
*
* These macros help synchronize the keycodes between the string declaration, string pointer declaration, and enum order.
*/
#define CUSTOM_MACROS(CUSTOM_NAME, CUSTOM_STRING, CUSTOM_DELIM) \
CUSTOM_NAME(add) CUSTOM_STRING("git add ") CUSTOM_DELIM() \
CUSTOM_NAME(branch) CUSTOM_STRING("git branch ") CUSTOM_DELIM() \
CUSTOM_NAME(checkout) CUSTOM_STRING("git checkout ") CUSTOM_DELIM() \
CUSTOM_NAME(cherrypick) CUSTOM_STRING("git cherry-pick ") CUSTOM_DELIM() \
CUSTOM_NAME(commit) CUSTOM_STRING("git commit -m \"\""SS_TAP(X_LEFT)) CUSTOM_DELIM() \
CUSTOM_NAME(diff) CUSTOM_STRING("git diff ") CUSTOM_DELIM() \
CUSTOM_NAME(fetch) CUSTOM_STRING("git fetch ") CUSTOM_DELIM() \
CUSTOM_NAME(grep) CUSTOM_STRING("git grep ") CUSTOM_DELIM() \
CUSTOM_NAME(log) CUSTOM_STRING("git log --decorate --oneline --graph ") CUSTOM_DELIM() \
CUSTOM_NAME(init) CUSTOM_STRING("git init ") CUSTOM_DELIM() \
CUSTOM_NAME(mv) CUSTOM_STRING("git mv ") CUSTOM_DELIM() \
CUSTOM_NAME(merge) CUSTOM_STRING("git merge ") CUSTOM_DELIM() \
CUSTOM_NAME(push) CUSTOM_STRING("git push ") CUSTOM_DELIM() \
CUSTOM_NAME(pull) CUSTOM_STRING("git pull ") CUSTOM_DELIM() \
CUSTOM_NAME(rebase) CUSTOM_STRING("git rebase ") CUSTOM_DELIM() \
CUSTOM_NAME(remote) CUSTOM_STRING("git remote ") CUSTOM_DELIM() \
CUSTOM_NAME(reset) CUSTOM_STRING("git reset ") CUSTOM_DELIM() \
CUSTOM_NAME(show) CUSTOM_STRING("git show ") CUSTOM_DELIM() \
CUSTOM_NAME(stash) CUSTOM_STRING("git stash ") CUSTOM_DELIM() \
CUSTOM_NAME(status) CUSTOM_STRING("git status ") CUSTOM_DELIM() \
CUSTOM_NAME(tag) CUSTOM_STRING("git tag ") CUSTOM_DELIM() \
CUSTOM_NAME(rdcc) CUSTOM_STRING(SS_LCTL(SS_LALT(SS_TAP(X_HOME)))) CUSTOM_DELIM() \
CUSTOM_NAME(lcad) CUSTOM_STRING(SS_LCTL(SS_LALT(SS_TAP(X_DELETE)))) CUSTOM_DELIM() \
CUSTOM_NAME(vtdl) CUSTOM_STRING(SS_LCTL(SS_LGUI(SS_TAP(X_LEFT)))) CUSTOM_DELIM() \
CUSTOM_NAME(vtdc) CUSTOM_STRING(SS_LCTL(SS_LGUI(SS_TAP(X_F4)))) CUSTOM_DELIM() \
CUSTOM_NAME(vtdn) CUSTOM_STRING(SS_LCTL(SS_LGUI("d"))) CUSTOM_DELIM() \
CUSTOM_NAME(vtdr) CUSTOM_STRING(SS_LCTL(SS_LGUI(SS_TAP(X_RIGHT))))