Add Irish keymap (#8528)
[jackhill/qmk/firmware.git] / quantum / keymap_extras / keymap_irish.h
1 /* Copyright 2020
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
17 #pragma once
18
19 #include "keymap.h"
20
21 // clang-format off
22
23 /*
24 * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
25 * │ ` │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ - │ = │       │
26 * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
27 * │     │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │ [ │ ] │     │
28 * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┐    │
29 * │      │ A │ S │ D │ F │ G │ H │ J │ K │ L │ ; │ ' │ # │    │
30 * ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴────┤
31 * │    │ \ │ Z │ X │ C │ V │ B │ N │ M │ , │ . │ / │          │
32 * ├────┼───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤
33 * │    │    │    │                        │    │    │    │    │
34 * └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘
35 */
36 // Row 1
37 #define IE_GRV KC_GRV // `
38 #define IE_1 KC_1 // 1
39 #define IE_2 KC_2 // 2
40 #define IE_3 KC_3 // 3
41 #define IE_4 KC_4 // 4
42 #define IE_5 KC_5 // 5
43 #define IE_6 KC_6 // 6
44 #define IE_7 KC_7 // 7
45 #define IE_8 KC_8 // 8
46 #define IE_9 KC_9 // 9
47 #define IE_0 KC_0 // 0
48 #define IE_MINS KC_MINS // -
49 #define IE_EQL KC_EQL // =
50 // Row 2
51 #define IE_Q KC_Q // Q
52 #define IE_W KC_W // W
53 #define IE_E KC_E // E
54 #define IE_R KC_R // R
55 #define IE_T KC_T // T
56 #define IE_Y KC_Y // Y
57 #define IE_U KC_U // U
58 #define IE_I KC_I // I
59 #define IE_O KC_O // O
60 #define IE_P KC_P // P
61 #define IE_LBRC KC_LBRC // [
62 #define IE_RBRC KC_RBRC // ]
63 // Row 3
64 #define IE_A KC_A // A
65 #define IE_S KC_S // S
66 #define IE_D KC_D // D
67 #define IE_F KC_F // F
68 #define IE_G KC_G // G
69 #define IE_H KC_H // H
70 #define IE_J KC_J // J
71 #define IE_K KC_K // K
72 #define IE_L KC_L // L
73 #define IE_SCLN KC_SCLN // ;
74 #define IE_QUOT KC_QUOT // '
75 #define IE_HASH KC_NUHS // #
76 // Row 4
77 #define IE_BSLS KC_NUBS // (backslash)
78 #define IE_Z KC_Z // Z
79 #define IE_X KC_X // X
80 #define IE_C KC_C // C
81 #define IE_V KC_V // V
82 #define IE_B KC_B // B
83 #define IE_N KC_N // N
84 #define IE_M KC_M // M
85 #define IE_COMM KC_COMM // ,
86 #define IE_DOT KC_DOT // .
87 #define IE_SLSH KC_SLSH // /
88
89 /* Shifted symbols
90 * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
91 * │ ¬ │ ! │ " │ £ │ $ │ % │ ^ │ & │ * │ ( │ ) │ _ │ + │       │
92 * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
93 * │     │   │   │   │   │   │   │   │   │   │   │ { │ } │     │
94 * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┐    │
95 * │      │   │   │   │   │   │   │   │   │   │ : │ @ │ ~ │    │
96 * ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴────┤
97 * │    │ | │   │   │   │   │   │   │   │ < │ > │ ? │          │
98 * ├────┼───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤
99 * │    │    │    │                        │    │    │    │    │
100 * └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘
101 */
102 // Row 1
103 #define IE_NOT S(IE_GRV) // ¬
104 #define IE_EXLM S(IE_1) // !
105 #define IE_DQUO S(IE_2) // "
106 #define IE_PND S(IE_3) // £
107 #define IE_DLR S(IE_4) // $
108 #define IE_PERC S(IE_5) // %
109 #define IE_CIRC S(IE_6) // ^
110 #define IE_AMPR S(IE_7) // &
111 #define IE_ASTR S(IE_8) // *
112 #define IE_LPRN S(IE_9) // (
113 #define IE_RPRN S(IE_0) // )
114 #define IE_UNDS S(IE_MINS) // _
115 #define IE_PLUS S(IE_EQL) // +
116 // Row 2
117 #define IE_LCBR S(IE_LBRC) // {
118 #define IE_RCBR S(IE_RBRC) // }
119 // Row 3
120 #define IE_COLN S(IE_SCLN) // :
121 #define IE_AT S(IE_QUOT) // @
122 #define IE_TILD S(IE_HASH) // ~
123 // Row 4
124 #define IE_PIPE S(IE_BSLS) // |
125 #define IE_LABK S(IE_COMM) // <
126 #define IE_RABK S(IE_DOT) // >
127 #define IE_QUES S(IE_SLSH) // ?
128
129 /* AltGr symbols
130 * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
131 * │ ¦ │   │   │   │ € │   │   │   │   │   │   │   │   │       │
132 * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
133 * │     │   │   │ É │   │   │   │ Ú │ Í │ Ó │   │   │   │     │
134 * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┐    │
135 * │      │ Á │   │   │   │   │   │   │   │   │   │ ´ │   │    │
136 * ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴────┤
137 * │    │   │   │   │   │   │   │   │   │   │   │   │          │
138 * ├────┼───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤
139 * │    │    │    │                        │    │    │    │    │
140 * └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘
141 */
142 // Row 1
143 #define IE_BRKP ALGR(IE_GRV) // ¦
144 #define IE_EURO ALGR(IE_4) // €
145 // Row 2
146 #define IE_EACU ALGR(IE_E) // É
147 #define IE_UACU ALGR(IE_U) // Ú
148 #define IE_IACU ALGR(IE_I) // Í
149 #define IE_OACU ALGR(IE_O) // Ó
150 // Row 3
151 #define IE_AACU ALGR(IE_A) // Á
152 #define IE_ACUT ALGR(IE_QUOT) // ´ (dead)