quantum/keymap_extras/keymap_bepo.h

   1 /* Copyright 2016 Didier Loiseau
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16 /* Keymap macros for the French BÉPO layout - http://bepo.fr */
  17 #ifndef KEYMAP_BEPO_H
  18 #define KEYMAP_BEPO_H
  19
  20 #include "keymap.h"
  21
  22 // Alt gr
  23 #ifndef ALTGR
  24 #define ALTGR(kc)   RALT(kc)
  25 #endif
  26 #ifndef ALGR
  27 #define ALGR(kc)    ALTGR(kc)
  28 #endif
  29 #define BP_ALGR KC_RALT
  30
  31 // Normal characters
  32 // First row (on usual keyboards)
  33 #define BP_DOLLAR           KC_GRAVE            // $
  34 #define BP_DLR              BP_DOLLAR
  35 #define BP_DOUBLE_QUOTE     KC_1                // "
  36 #define BP_DQOT             BP_DOUBLE_QUOTE
  37 #define BP_LEFT_GUILLEMET   KC_2                // «
  38 #define BP_LGIL             BP_LEFT_GUILLEMET
  39 #define BP_RIGHT_GUILLEMET  KC_3                // »
  40 #define BP_RGIL             BP_RIGHT_GUILLEMET
  41 #define BP_LEFT_PAREN       KC_4                // (
  42 #define BP_LPRN             BP_LEFT_PAREN
  43 #define BP_RIGHT_PAREN      KC_5                // )
  44 #define BP_RPRN             BP_RIGHT_PAREN
  45 #define BP_AT               KC_6                // @
  46 #define BP_PLUS             KC_7                // +
  47 #define BP_MINUS            KC_8                // -
  48 #define BP_MINS             BP_MINUS
  49 #define BP_SLASH            KC_9                // /
  50 #define BP_SLSH             BP_SLASH
  51 #define BP_ASTERISK         KC_0                // *
  52 #define BP_ASTR             BP_ASTERISK
  53 #define BP_EQUAL            KC_MINUS            // =
  54 #define BP_EQL              BP_EQUAL
  55 #define BP_PERCENT          KC_EQUAL            // %
  56 #define BP_PERC             BP_PERCENT
  57
  58 // Second row
  59 #define BP_B                KC_Q
  60 #define BP_E_ACUTE          KC_W        // é
  61 #define BP_ECUT             BP_E_ACUTE
  62 #define BP_P                KC_E
  63 #define BP_O                KC_R
  64 #define BP_E_GRAVE          KC_T        // è
  65 #define BP_EGRV             BP_E_GRAVE
  66 #define BP_DEAD_CIRCUMFLEX  KC_Y        // dead ^
  67 #define BP_DCRC             BP_DEAD_CIRCUMFLEX
  68 #define BP_V                KC_U
  69 #define BP_D                KC_I
  70 #define BP_L                KC_O
  71 #define BP_J                KC_P
  72 #define BP_Z                KC_LBRACKET
  73 #define BP_W                KC_RBRACKET
  74
  75 // Third row
  76 #define BP_A            KC_A
  77 #define BP_U            KC_S
  78 #define BP_I            KC_D
  79 #define BP_E            KC_F
  80 #define BP_COMMA        KC_G        // ,
  81 #define BP_COMM         BP_COMMA
  82 #define BP_C            KC_H
  83 #define BP_T            KC_J
  84 #define BP_S            KC_K
  85 #define BP_R            KC_L
  86 #define BP_N            KC_SCOLON
  87 #define BP_M            KC_QUOTE
  88 #define BP_C_CEDILLA    KC_BSLASH   // ç
  89 #define BP_CCED         BP_C_CEDILLA
  90
  91 // Fourth row
  92 #define BP_E_CIRCUMFLEX     KC_NONUS_BSLASH // ê
  93 #define BP_ECRC             BP_E_CIRCUMFLEX
  94 #define BP_A_GRAVE          KC_Z            // à
  95 #define BP_AGRV             BP_A_GRAVE
  96 #define BP_Y                KC_X
  97 #define BP_X                KC_C
  98 #define BP_DOT              KC_V            // .
  99 #define BP_K                KC_B
 100 #define BP_APOSTROPHE       KC_N
 101 #define BP_APOS             BP_APOSTROPHE   // '
 102 #define BP_Q                KC_M
 103 #define BP_G                KC_COMMA
 104 #define BP_H                KC_DOT
 105 #define BP_F                KC_SLASH
 106
 107 // Shifted characters
 108 // First row
 109 #define BP_HASH     LSFT(BP_DOLLAR)     // #
 110 #define BP_1        LSFT(KC_1)
 111 #define BP_2        LSFT(KC_2)
 112 #define BP_3        LSFT(KC_3)
 113 #define BP_4        LSFT(KC_4)
 114 #define BP_5        LSFT(KC_5)
 115 #define BP_6        LSFT(KC_6)
 116 #define BP_7        LSFT(KC_7)
 117 #define BP_8        LSFT(KC_8)
 118 #define BP_9        LSFT(KC_9)
 119 #define BP_0        LSFT(KC_0)
 120 #define BP_DEGREE   LSFT(BP_EQUAL)      // °
 121 #define BP_DEGR     BP_DEGREE
 122 #define BP_GRAVE    LSFT(BP_PERCENT)    // `
 123 #define BP_GRV      BP_GRAVE
 124
 125 // Second row
 126 #define BP_EXCLAIM  LSFT(BP_DEAD_CIRCUMFLEX)    // !
 127 #define BP_EXLM     BP_EXCLAIM
 128
 129 // Third row
 130 #define BP_SCOLON   LSFT(BP_COMMA)  // ;
 131 #define BP_SCLN     BP_SCOLON
 132
 133 // Fourth row
 134 #define BP_COLON    LSFT(BP_DOT)    // :
 135 #define BP_COLN     BP_COLON
 136 #define BP_QUESTION LSFT(BP_APOS)  // ?
 137 #define BP_QEST     BP_QUESTION
 138
 139 // Space bar
 140 #define BP_NON_BREAKING_SPACE   LSFT(KC_SPACE)
 141 #define BP_NBSP                 BP_NON_BREAKING_SPACE
 142
 143 // AltGr-ed characters
 144 // First row
 145 #define BP_EN_DASH          ALTGR(BP_DOLLAR)    // –
 146 #define BP_NDSH             BP_EN_DASH
 147 #define BP_EM_DASH          ALTGR(KC_1)         // —
 148 #define BP_MDSH             BP_EM_DASH
 149 #define BP_LESS             ALTGR(KC_2)         // <
 150 #define BP_GREATER          ALTGR(KC_3)         // >
 151 #define BP_GRTR             BP_GREATER
 152 #define BP_LBRACKET         ALTGR(KC_4)         // [
 153 #define BP_LBRC             BP_LBRACKET
 154 #define BP_RBRACKET         ALTGR(KC_5)         // ]
 155 #define BP_RBRC             BP_RBRACKET
 156 #define BP_CIRCUMFLEX       ALTGR(KC_6)         // ^
 157 #define BP_CIRC             BP_CIRCUMFLEX
 158 #define BP_PLUS_MINUS       ALTGR(KC_7)         // ±
 159 #define BP_PSMS             BP_PLUS_MINUS
 160 #define BP_MATH_MINUS       ALTGR(KC_8)         // −
 161 #define BP_MMNS             BP_MATH_MINUS
 162 #define BP_OBELUS           ALTGR(KC_9)         // ÷
 163 #define BP_OBEL             BP_OBELUS
 164 // more conventional name of the symbol
 165 #define BP_DIVISION_SIGN    BP_OBELUS
 166 #define BP_DVSN             BP_DIVISION_SIGN
 167 #define BP_TIMES            ALTGR(KC_0)         // ×
 168 #define BP_TIMS             BP_TIMES
 169 #define BP_DIFFERENT        ALTGR(BP_EQUAL)     // ≠
 170 #define BP_DIFF             BP_DIFFERENT
 171 #define BP_PERMILLE         ALTGR(BP_PERCENT)   // ‰
 172 #define BP_PMIL             BP_PERMILLE
 173
 174 // Second row
 175 #define BP_PIPE                 ALTGR(BP_B)         // |
 176 #define BP_DEAD_ACUTE           ALTGR(BP_E_ACUTE)   // dead ´
 177 #define BP_DACT                 BP_DEAD_ACUTE
 178 #define BP_AMPERSAND            ALTGR(BP_P)         // &
 179 #define BP_AMPR                 BP_AMPERSAND
 180 #define BP_OE_LIGATURE          ALTGR(BP_O)         // œ
 181 #define BP_OE                   BP_OE_LIGATURE
 182 #define BP_DEAD_GRAVE           ALTGR(BP_E_GRAVE)   // `
 183 #define BP_DGRV                 BP_DEAD_GRAVE
 184 #define BP_INVERTED_EXCLAIM     ALTGR(BP_DEAD_CIRCUMFLEX)   // ¡
 185 #define BP_IXLM                 BP_INVERTED_EXCLAIM
 186 #define BP_DEAD_CARON           ALTGR(BP_V)         // dead ˇ
 187 #define BP_DCAR                 BP_DEAD_CARON
 188 #define BP_ETH                  ALTGR(BP_D)         // ð
 189 #define BP_DEAD_SLASH           ALTGR(BP_L)         // dead /
 190 #define BP_DSLH                 BP_DEAD_SLASH
 191 #define BP_IJ_LIGATURE          ALTGR(BP_J)         // ĳ
 192 #define BP_IJ                   BP_IJ_LIGATURE
 193 #define BP_SCHWA                ALTGR(BP_Z)         // ə
 194 #define BP_SCWA                 BP_SCHWA
 195 #define BP_DEAD_BREVE           ALTGR(BP_W)         // dead ˘
 196 #define BP_DBRV                 BP_DEAD_BREVE
 197
 198 // Third row
 199 #define BP_AE_LIGATURE              ALTGR(BP_A)         // æ
 200 #define BP_AE                       BP_AE_LIGATURE
 201 #define BP_U_GRAVE                  ALTGR(BP_U)           // ù
 202 #define BP_UGRV                     BP_U_GRAVE
 203 #define BP_DEAD_TREMA               ALTGR(BP_I)         // dead ¨ (trema/umlaut/diaresis)
 204 #define BP_DTRM                     BP_DEAD_TREMA
 205 #define BP_EURO                     ALTGR(BP_E)         // €
 206 #define BP_TYPOGRAPHICAL_APOSTROPHE ALTGR(BP_COMMMA)    // ’
 207 #define BP_TAPO                     BP_TYPOGRAPHICAL_APOSTROPHE
 208 #define BP_COPYRIGHT                ALTGR(BP_C)         // ©
 209 #define BP_CPRT                     BP_COPYRIGHT
 210 #define BP_THORN                    ALTGR(BP_T)         // þ
 211 #define BP_THRN                     BP_THORN
 212 #define BP_SHARP_S                  ALTGR(BP_S)         // ß
 213 #define BP_SRPS                     BP_SHARP_S
 214 #define BP_REGISTERED_TRADEMARK     ALTGR(BP_R)         // ®
 215 #define BP_RTM                      BP_REGISTERED_TRADEMARK
 216 #define BP_DEAD_TILDE               ALTGR(BP_N)         // dead ~
 217 #define BP_DTLD                     BP_DEAD_TILDE
 218 #define BP_DEAD_MACRON              ALTGR(BP_M)         // dead ¯
 219 #define BP_DMCR                     BP_DEAD_MACRON
 220 #define BP_DEAD_CEDILLA             ALTGR(BP_C_CEDILLA) // dead ¸
 221 #define BP_DCED                     BP_DEAD_CEDILLA
 222
 223 // Fourth row
 224 #define BP_NONUS_SLASH          ALTGR(BP_E_CIRCUMFLEX)  // / on non-us backslash key (102nd key, ê in bépo)
 225 #define BP_NUSL                 BP_NONUS_SLASH
 226 #define BP_BACKSLASH            ALTGR(BP_A_GRAVE)       /* \ */
 227 #define BP_BSLS                 BP_BACKSLASH
 228 #define BP_LEFT_CURLY_BRACE     ALTGR(BP_Y)             // {
 229 #define BP_LCBR                 BP_LEFT_CURLY_BRACE
 230 #define BP_RIGHT_CURLY_BRACE    ALTGR(BP_X)             // }
 231 #define BP_RCBR                 BP_RIGHT_CURLY_BRACE
 232 #define BP_ELLIPSIS             ALTGR(BP_DOT)           // …
 233 #define BP_ELPS                 BP_ELLIPSIS
 234 #define BP_TILDE                ALTGR(BP_K)             // ~
 235 #define BP_TILD                 BP_TILDE
 236 #define BP_INVERTED_QUESTION    ALTGR(BP_QUESTION)      // ¿
 237 #define BP_IQST                 BP_INVERTED_QUESTION
 238 #define BP_DEAD_RING            ALTGR(BP_Q)             // dead °
 239 #define BP_DRNG                 BP_DEAD_RING
 240 #define BP_DEAD_GREEK           ALTGR(BP_G)             // dead Greek key (following key will make a Greek letter)
 241 #define BP_DGRK                 BP_DEAD_GREEK
 242 #define BP_DAGGER               ALTGR(BP_H)             // †
 243 #define BP_DAGR                 BP_DAGGER
 244 #define BP_DEAD_OGONEK          ALTGR(BP_F)             // dead ˛
 245 #define BP_DOGO                 BP_DEAD_OGONEK
 246
 247 // Space bar
 248 #define BP_UNDERSCORE   ALTGR(KC_SPACE)     // _
 249 #define BP_UNDS         BP_UNDERSCORE
 250
 251 // AltGr-Shifted characters (different from capitalised AltGr-ed characters)
 252 // First row
 253 #define BP_PARAGRAPH            ALTGR(BP_HASH)      // ¶
 254 #define BP_PARG                 BP_PARAGRAPH
 255 #define BP_LOW_DOUBLE_QUOTE     ALTGR(BP_1)         // „
 256 #define BP_LWQT                 BP_LOW_DOUBLE_QUOTE
 257 #define BP_LEFT_DOUBLE_QUOTE    ALTGR(BP_2)         // “
 258 #define BP_LDQT                 BP_LEFT_DOUBLE_QUOTE
 259 #define BP_RIGHT_DOUBLE_QUOTE   ALTGR(BP_3)         // ”
 260 #define BP_RDQT                 BP_RIGHT_DOUBLE_QUOTE
 261 #define BP_LESS_OR_EQUAL        ALTGR(BP_4)         // ≤
 262 #define BP_LEQL                 BP_LESS_OR_EQUAL
 263 #define BP_GREATER_OR_EQUAL     ALTGR(BP_5)         // ≥
 264 #define BP_GEQL                 BP_GREATER_OR_EQUAL
 265 // nothing on ALTGR(BP_6)
 266 #define BP_NEGATION             ALTGR(BP_7)         // ¬
 267 #define BP_NEGT                 BP_NEGATION
 268 #define BP_ONE_QUARTER          ALTGR(BP_8)         // ¼
 269 #define BP_1QRT                 BP_ONE_QUARTER
 270 #define BP_ONE_HALF             ALTGR(BP_9)         // ½
 271 #define BP_1HLF                 BP_ONE_HALF
 272 #define BP_THREE_QUARTERS       ALTGR(BP_0)         // ¾
 273 #define BP_3QRT                 BP_THREE_QUARTERS
 274 #define BP_MINUTES              ALTGR(BP_DEGREE)    // ′
 275 #define BP_MNUT                 BP_MINUTES
 276 #define BP_SECONDS              ALTGR(BP_GRAVE)     // ″
 277 #define BP_SCND                 BP_SECONDS
 278
 279 // Second row
 280 #define BP_BROKEN_PIPE          LSFT(BP_PIPE)           // ¦
 281 #define BP_BPIP                 BP_BROKEN_PIPE
 282 #define BP_DEAD_DOUBLE_ACUTE    LSFT(BP_DEAD_ACUTE)     // ˝
 283 #define BP_DDCT                 BP_DEAD_DOUBLE_ACUTE
 284 #define BP_SECTION              ALTGR(LSFT(BP_P))       // §
 285 #define BP_SECT                 BP_SECTION
 286 // LSFT(BP_DEAD_GRAVE) is actually the same character as LSFT(BP_PERCENT)
 287 #define BP_GRAVE_BIS            LSFT(BP_DEAD_GRAVE)     // `
 288 #define BP_GRVB                 BP_GRAVE_BIS
 289
 290 // Third row
 291 #define BP_DEAD_DOT_ABOVE       LSFT(BP_DEAD_TREMA)     // dead ˙
 292 #define BP_DDTA                 BP_DEAD_DOT_ABOVE
 293 #define BP_DEAD_CURRENCY        LSFT(BP_EURO)           // dead ¤ (next key will generate a currency code like ¥ or £)
 294 #define BP_DCUR                 BP_DEAD_CURRENCY
 295 #define BP_DEAD_HORN            LSFT(ALTGR(BP_COMMA))   // dead ̛
 296 #define BP_DHRN                 BP_DEAD_HORN
 297 #define BP_LONG_S               LSFT(ALTGR(BP_C))       // ſ
 298 #define BP_LNGS                 BP_LONG_S
 299 #define BP_TRADEMARK            LSFT(BP_REGISTERED_TRADEMARK)   // ™
 300 #define BP_TM                   BP_TRADEMARK
 301 #define BP_ORDINAL_INDICATOR_O  LSFT(ALTGR(BP_M))               // º
 302 #define BP_ORDO                 BP_ORDINAL_INDICATOR_O
 303 #define BP_DEAD_COMMA           LSFT(BP_DEAD_CEDILLA)   // dead ˛
 304 #define BP_DCOM                 BP_DEAD_COMMA
 305
 306 // Fourth row
 307 #define BP_LEFT_QUOTE           LSFT(ALTGR(BP_Y))       // ‘
 308 #define BP_LQOT                 BP_LEFT_QUOTE
 309 #define BP_RIGHT_QUOTE          LSFT(ALTGR(BP_X))       // ’
 310 #define BP_RQOT                 BP_RIGHT_QUOTE
 311 #define BP_INTERPUNCT           LSFT(ALTGR(BP_DOT))     // ·
 312 #define BP_IPCT                 BP_INTERPUNCT
 313 #define BP_DEAD_HOOK_ABOVE      LSFT(ALTGR(BP_QUESTION))    // dead ̉
 314 #define BP_DHKA                 BP_DEAD_HOOK_ABOVE
 315 #define BP_DEAD_UNDERDOT        LSFT(BP_DEAD_RING)      // dead ̣
 316 #define BP_DUDT                 BP_DEAD_UNDERDOT
 317 #define BP_DOUBLE_DAGGER        LSFT(BP_DAGGER)         // ‡
 318 #define BP_DDGR                 BP_DOUBLE_DAGGER
 319 #define BP_ORDINAL_INDICATOR_A  LSFT(ALTGR(BP_F))       // ª
 320 #define BP_ORDA                 BP_ORDINAL_INDICATOR_A
 321
 322 // Space bar
 323 #define BP_NARROW_NON_BREAKING_SPACE    ALTGR(BP_NON_BREAKING_SPACE)
 324 #define BP_NNBS                         BP_NARROW_NON_BREAKING_SPACE
 325
 326 #endif