1 /* Copyright 2017 Jack Humbert
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.
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.
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/>.
21 #if defined(UNICODE_ENABLE) + defined(UNICODEMAP_ENABLE) + defined(UCIS_ENABLE) > 1
22 #error "Cannot enable more than one Unicode method (UNICODE, UNICODEMAP, UCIS) at the same time"
25 // Keycodes used for starting Unicode input on different platforms
26 #ifndef UNICODE_OSX_KEY
27 #define UNICODE_OSX_KEY KC_LALT
29 #ifndef UNICODE_WINC_KEY
30 #define UNICODE_WINC_KEY KC_RALT
33 // Comma-delimited, ordered list of input modes selected for use (e.g. in cycle)
34 // Example: #define UNICODE_SELECTED_MODES UC_WINC, UC_LNX
35 #ifndef UNICODE_SELECTED_MODES
36 #define UNICODE_SELECTED_MODES -1
39 // Whether input mode changes in cycle should be written to EEPROM
40 #ifndef UNICODE_CYCLE_PERSIST
41 #define UNICODE_CYCLE_PERSIST true
44 // Delay between starting Unicode input and sending a sequence, in ms
45 #ifndef UNICODE_TYPE_DELAY
46 #define UNICODE_TYPE_DELAY 10
49 enum unicode_input_modes {
50 UC_OSX, // Mac OS X using Unicode Hex Input
51 UC_LNX, // Linux using IBus
52 UC_WIN, // Windows using EnableHexNumpad
53 UC_BSD, // BSD (not implemented)
54 UC_WINC, // Windows using WinCompose (https://github.com/samhocevar/wincompose)
55 UC__COUNT // Number of available input modes (always leave at the end)
61 uint8_t input_mode : 8;
65 extern unicode_config_t unicode_config;
67 void unicode_input_mode_init(void);
68 uint8_t get_unicode_input_mode(void);
69 void set_unicode_input_mode(uint8_t mode);
70 void cycle_unicode_input_mode(uint8_t offset);
71 void persist_unicode_input_mode(void);
73 void unicode_input_start(void);
74 void unicode_input_finish(void);
76 void register_hex(uint16_t hex);
77 void send_unicode_hex_string(const char *str);
79 bool process_unicode_common(uint16_t keycode, keyrecord_t *record);
81 #define UC_BSPC UC(0x0008)
82 #define UC_SPC UC(0x0020)
84 #define UC_EXLM UC(0x0021)
85 #define UC_DQUT UC(0x0022)
86 #define UC_HASH UC(0x0023)
87 #define UC_DLR UC(0x0024)
88 #define UC_PERC UC(0x0025)
89 #define UC_AMPR UC(0x0026)
90 #define UC_QUOT UC(0x0027)
91 #define UC_LPRN UC(0x0028)
92 #define UC_RPRN UC(0x0029)
93 #define UC_ASTR UC(0x002A)
94 #define UC_PLUS UC(0x002B)
95 #define UC_COMM UC(0x002C)
96 #define UC_DASH UC(0x002D)
97 #define UC_DOT UC(0x002E)
98 #define UC_SLSH UC(0x002F)
100 #define UC_0 UC(0x0030)
101 #define UC_1 UC(0x0031)
102 #define UC_2 UC(0x0032)
103 #define UC_3 UC(0x0033)
104 #define UC_4 UC(0x0034)
105 #define UC_5 UC(0x0035)
106 #define UC_6 UC(0x0036)
107 #define UC_7 UC(0x0037)
108 #define UC_8 UC(0x0038)
109 #define UC_9 UC(0x0039)
111 #define UC_COLN UC(0x003A)
112 #define UC_SCLN UC(0x003B)
113 #define UC_LT UC(0x003C)
114 #define UC_EQL UC(0x003D)
115 #define UC_GT UC(0x003E)
116 #define UC_QUES UC(0x003F)
117 #define UC_AT UC(0x0040)
119 #define UC_A UC(0x0041)
120 #define UC_B UC(0x0042)
121 #define UC_C UC(0x0043)
122 #define UC_D UC(0x0044)
123 #define UC_E UC(0x0045)
124 #define UC_F UC(0x0046)
125 #define UC_G UC(0x0047)
126 #define UC_H UC(0x0048)
127 #define UC_I UC(0x0049)
128 #define UC_J UC(0x004A)
129 #define UC_K UC(0x004B)
130 #define UC_L UC(0x004C)
131 #define UC_M UC(0x004D)
132 #define UC_N UC(0x004E)
133 #define UC_O UC(0x004F)
134 #define UC_P UC(0x0050)
135 #define UC_Q UC(0x0051)
136 #define UC_R UC(0x0052)
137 #define UC_S UC(0x0053)
138 #define UC_T UC(0x0054)
139 #define UC_U UC(0x0055)
140 #define UC_V UC(0x0056)
141 #define UC_W UC(0x0057)
142 #define UC_X UC(0x0058)
143 #define UC_Y UC(0x0059)
144 #define UC_Z UC(0x005A)
146 #define UC_LBRC UC(0x005B)
147 #define UC_BSLS UC(0x005C)
148 #define UC_RBRC UC(0x005D)
149 #define UC_CIRM UC(0x005E)
150 #define UC_UNDR UC(0x005F)
152 #define UC_GRV UC(0x0060)
154 #define UC_a UC(0x0061)
155 #define UC_b UC(0x0062)
156 #define UC_c UC(0x0063)
157 #define UC_d UC(0x0064)
158 #define UC_e UC(0x0065)
159 #define UC_f UC(0x0066)
160 #define UC_g UC(0x0067)
161 #define UC_h UC(0x0068)
162 #define UC_i UC(0x0069)
163 #define UC_j UC(0x006A)
164 #define UC_k UC(0x006B)
165 #define UC_l UC(0x006C)
166 #define UC_m UC(0x006D)
167 #define UC_n UC(0x006E)
168 #define UC_o UC(0x006F)
169 #define UC_p UC(0x0070)
170 #define UC_q UC(0x0071)
171 #define UC_r UC(0x0072)
172 #define UC_s UC(0x0073)
173 #define UC_t UC(0x0074)
174 #define UC_u UC(0x0075)
175 #define UC_v UC(0x0076)
176 #define UC_w UC(0x0077)
177 #define UC_x UC(0x0078)
178 #define UC_y UC(0x0079)
179 #define UC_z UC(0x007A)
181 #define UC_LCBR UC(0x007B)
182 #define UC_PIPE UC(0x007C)
183 #define UC_RCBR UC(0x007D)
184 #define UC_TILD UC(0x007E)
185 #define UC_DEL UC(0x007F)