keyboard/planck/extended_keymap_common.h

   1 /*
   2 Copyright 2012,2013 Jun Wako <wakojun@gmail.com>
   3
   4 This program is free software: you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License as published by
   6 the Free Software Foundation, either version 2 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 */
  17
  18 #ifndef KEYMAP_H
  19 #define KEYMAP_H
  20
  21 #include <stdint.h>
  22 #include <stdbool.h>
  23 #include "action.h"
  24 #include <avr/pgmspace.h>
  25 #include "keycode.h"
  26 #include "keymap.h"
  27 #include "action_macro.h"
  28 #include "report.h"
  29 #include "host.h"
  30 #include "print.h"
  31 #include "debug.h"
  32
  33 #ifdef BOOTMAGIC_ENABLE
  34 /* NOTE: Not portable. Bit field order depends on implementation */
  35 typedef union {
  36     uint16_t raw;
  37     struct {
  38         bool swap_control_capslock:1;
  39         bool capslock_to_control:1;
  40         bool swap_lalt_lgui:1;
  41         bool swap_ralt_rgui:1;
  42         bool no_gui:1;
  43         bool swap_grave_esc:1;
  44         bool swap_backslash_backspace:1;
  45         bool nkro:1;
  46     };
  47 } keymap_config_t;
  48 keymap_config_t keymap_config;
  49 #endif
  50
  51 /* translates key to keycode */
  52 uint16_t keymap_key_to_keycode(uint8_t layer, keypos_t key);
  53
  54 /* translates Fn keycode to action */
  55 action_t keymap_fn_to_action(uint16_t keycode);
  56
  57 /* translates Fn keycode to action */
  58 action_t keymap_func_to_action(uint16_t keycode);
  59
  60 extern const uint16_t keymaps[][MATRIX_ROWS][MATRIX_COLS];
  61 extern const uint16_t fn_actions[];
  62
  63 // Ability to use mods in layouts
  64 #define LCTL(kc) kc | 0x0100
  65 #define LSFT(kc) kc | 0x0200
  66 #define LALT(kc) kc | 0x0400
  67 #define LGUI(kc) kc | 0x0800
  68 #define RCTL(kc) kc | 0x1100
  69 #define RSFT(kc) kc | 0x1200
  70 #define RALT(kc) kc | 0x1400
  71 #define RGUI(kc) kc | 0x1800
  72
  73 // Alias for function layers than expand past FN31
  74 #define FUNC(kc) kc | 0x2000
  75
  76 // Aliases
  77 #define S(kc) LSFT(kc)
  78 #define F(kc) FUNC(kc)
  79
  80 // For software implementation of colemak
  81 #define CM_Q    KC_Q
  82 #define CM_W    KC_W
  83 #define CM_F    KC_E
  84 #define CM_P    KC_R
  85 #define CM_G    KC_T
  86 #define CM_J    KC_Y
  87 #define CM_L    KC_U
  88 #define CM_U    KC_I
  89 #define CM_Y    KC_O
  90 #define CM_SCLN KC_P
  91
  92 #define CM_A    KC_A
  93 #define CM_R    KC_S
  94 #define CM_S    KC_D
  95 #define CM_T    KC_F
  96 #define CM_D    KC_G
  97 #define CM_H    KC_H
  98 #define CM_N    KC_J
  99 #define CM_E    KC_K
 100 #define CM_I    KC_L
 101 #define CM_O    KC_SCLN
 102
 103 #define CM_Z    KC_Z
 104 #define CM_X    KC_X
 105 #define CM_C    KC_C
 106 #define CM_V    KC_V
 107 #define CM_B    KC_B
 108 #define CM_K    KC_N
 109 #define CM_M    KC_M
 110 #define CM_COMM KC_COMM
 111 #define CM_DOT  KC_DOT
 112 #define CM_SLSH KC_SLSH
 113
 114 // Make it easy to support these in macros
 115 #define KC_CM_Q    CM_Q
 116 #define KC_CM_W    CM_W
 117 #define KC_CM_F    CM_F
 118 #define KC_CM_P    CM_P
 119 #define KC_CM_G    CM_G
 120 #define KC_CM_J    CM_J
 121 #define KC_CM_L    CM_L
 122 #define KC_CM_U    CM_U
 123 #define KC_CM_Y    CM_Y
 124 #define KC_CM_SCLN CM_SCLN
 125
 126 #define KC_CM_A    CM_A
 127 #define KC_CM_R    CM_R
 128 #define KC_CM_S    CM_S
 129 #define KC_CM_T    CM_T
 130 #define KC_CM_D    CM_D
 131 #define KC_CM_H    CM_H
 132 #define KC_CM_N    CM_N
 133 #define KC_CM_E    CM_E
 134 #define KC_CM_I    CM_I
 135 #define KC_CM_O    CM_O
 136
 137 #define KC_CM_Z    CM_Z
 138 #define KC_CM_X    CM_X
 139 #define KC_CM_C    CM_C
 140 #define KC_CM_V    CM_V
 141 #define KC_CM_B    CM_B
 142 #define KC_CM_K    CM_K
 143 #define KC_CM_M    CM_M
 144 #define KC_CM_COMM CM_COMM
 145 #define KC_CM_DOT  CM_DOT
 146 #define KC_CM_SLSH CM_SLSH
 147
 148 #define M(kc) kc | 0x3000
 149
 150 #define MACRODOWN(...) (record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)
 151
 152 #endif