1 /* Copyright 2016 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/>.
17 /* Author: Wojciech Siewierski < wojciech dot siewierski at onet dot pl > */
18 #ifndef DYNAMIC_MACROS_H
19 #define DYNAMIC_MACROS_H
21 #include "action_layer.h"
23 #ifndef DYNAMIC_MACRO_SIZE
24 /* May be overridden with a custom value. Be aware that the effective
25 * macro length is half of this value: each keypress is recorded twice
26 * because of the down-event and up-event. This is not a bug, it's the
29 * Usually it should be fine to set the macro size to at least 256 but
30 * there have been reports of it being too much in some users' cases,
31 * so 128 is considered a safe default.
33 #define DYNAMIC_MACRO_SIZE 128
36 /* DYNAMIC_MACRO_RANGE must be set as the last element of user's
37 * "planck_keycodes" enum prior to including this header. This allows
40 enum dynamic_macro_keycodes {
41 DYN_REC_START1 = DYNAMIC_MACRO_RANGE,
48 /* Blink the LEDs to notify the user about some event. */
49 void dynamic_macro_led_blink(void)
56 /* Convenience macros used for retrieving the debug info. All of them
57 * need a `direction` variable accessible at the call site.
59 #define DYNAMIC_MACRO_CURRENT_SLOT() (direction > 0 ? 1 : 2)
60 #define DYNAMIC_MACRO_CURRENT_LENGTH(BEGIN, POINTER) \
61 ((int)(direction * ((POINTER) - (BEGIN))))
62 #define DYNAMIC_MACRO_CURRENT_CAPACITY(BEGIN, END2) \
63 ((int)(direction * ((END2) - (BEGIN)) + 1))
66 * Start recording of the dynamic macro.
68 * @param[out] macro_pointer The new macro buffer iterator.
69 * @param[in] macro_buffer The macro buffer used to initialize macro_pointer.
71 void dynamic_macro_record_start(
72 keyrecord_t **macro_pointer, keyrecord_t *macro_buffer)
74 dprintln("dynamic macro recording: started");
76 dynamic_macro_led_blink();
80 *macro_pointer = macro_buffer;
84 * Play the dynamic macro.
86 * @param macro_buffer[in] The beginning of the macro buffer being played.
87 * @param macro_end[in] The element after the last macro buffer element.
88 * @param direction[in] Either +1 or -1, which way to iterate the buffer.
90 void dynamic_macro_play(
91 keyrecord_t *macro_buffer, keyrecord_t *macro_end, int8_t direction)
93 dprintf("dynamic macro: slot %d playback\n", DYNAMIC_MACRO_CURRENT_SLOT());
95 uint32_t saved_layer_state = layer_state;
100 while (macro_buffer != macro_end) {
101 process_record(macro_buffer);
102 macro_buffer += direction;
107 layer_state = saved_layer_state;
111 * Record a single key in a dynamic macro.
113 * @param macro_buffer[in] The start of the used macro buffer.
114 * @param macro_pointer[in,out] The current buffer position.
115 * @param macro2_end[in] The end of the other macro.
116 * @param direction[in] Either +1 or -1, which way to iterate the buffer.
117 * @param record[in] The current keypress.
119 void dynamic_macro_record_key(
120 keyrecord_t *macro_buffer,
121 keyrecord_t **macro_pointer,
122 keyrecord_t *macro2_end,
126 /* If we've just started recording, ignore all the key releases. */
127 if (!record->event.pressed && *macro_pointer == macro_buffer) {
128 dprintln("dynamic macro: ignoring a leading key-up event");
132 /* The other end of the other macro is the last buffer element it
133 * is safe to use before overwriting the other macro.
135 if (*macro_pointer - direction != macro2_end) {
136 **macro_pointer = *record;
137 *macro_pointer += direction;
139 dynamic_macro_led_blink();
143 "dynamic macro: slot %d length: %d/%d\n",
144 DYNAMIC_MACRO_CURRENT_SLOT(),
145 DYNAMIC_MACRO_CURRENT_LENGTH(macro_buffer, *macro_pointer),
146 DYNAMIC_MACRO_CURRENT_CAPACITY(macro_buffer, macro2_end));
150 * End recording of the dynamic macro. Essentially just update the
151 * pointer to the end of the macro.
153 void dynamic_macro_record_end(
154 keyrecord_t *macro_buffer,
155 keyrecord_t *macro_pointer,
157 keyrecord_t **macro_end)
159 dynamic_macro_led_blink();
161 /* Do not save the keys being held when stopping the recording,
162 * i.e. the keys used to access the layer DYN_REC_STOP is on.
164 while (macro_pointer != macro_buffer &&
165 (macro_pointer - direction)->event.pressed) {
166 dprintln("dynamic macro: trimming a trailing key-down event");
167 macro_pointer -= direction;
171 "dynamic macro: slot %d saved, length: %d\n",
172 DYNAMIC_MACRO_CURRENT_SLOT(),
173 DYNAMIC_MACRO_CURRENT_LENGTH(macro_buffer, macro_pointer));
175 *macro_end = macro_pointer;
178 /* Handle the key events related to the dynamic macros. Should be
179 * called from process_record_user() like this:
181 * bool process_record_user(uint16_t keycode, keyrecord_t *record) {
182 * if (!process_record_dynamic_macro(keycode, record)) {
185 * <...THE REST OF THE FUNCTION...>
188 bool process_record_dynamic_macro(uint16_t keycode, keyrecord_t *record)
190 /* Both macros use the same buffer but read/write on different
193 * Macro1 is written left-to-right starting from the beginning of
196 * Macro2 is written right-to-left starting from the end of the
199 * ¯o_buffer macro_end
201 * +------------------------------------------------------------+
202 * |>>>>>> MACRO1 >>>>>> <<<<<<<<<<<<< MACRO2 <<<<<<<<<<<<<|
203 * +------------------------------------------------------------+
205 * r_macro_end r_macro_buffer
207 * During the recording when one macro encounters the end of the
208 * other macro, the recording is stopped. Apart from this, there
209 * are no arbitrary limits for the macros' length in relation to
210 * each other: for example one can either have two medium sized
211 * macros or one long macro and one short macro. Or even one empty
212 * and one using the whole buffer.
214 static keyrecord_t macro_buffer[DYNAMIC_MACRO_SIZE];
216 /* Pointer to the first buffer element after the first macro.
217 * Initially points to the very beginning of the buffer since the
219 static keyrecord_t *macro_end = macro_buffer;
221 /* The other end of the macro buffer. Serves as the beginning of
222 * the second macro. */
223 static keyrecord_t *const r_macro_buffer = macro_buffer + DYNAMIC_MACRO_SIZE - 1;
225 /* Like macro_end but for the second macro. */
226 static keyrecord_t *r_macro_end = r_macro_buffer;
228 /* A persistent pointer to the current macro position (iterator)
229 * used during the recording. */
230 static keyrecord_t *macro_pointer = NULL;
232 /* 0 - no macro is being recorded right now
233 * 1,2 - either macro 1 or 2 is being recorded */
234 static uint8_t macro_id = 0;
237 /* No macro recording in progress. */
238 if (!record->event.pressed) {
241 dynamic_macro_record_start(¯o_pointer, macro_buffer);
245 dynamic_macro_record_start(¯o_pointer, r_macro_buffer);
248 case DYN_MACRO_PLAY1:
249 dynamic_macro_play(macro_buffer, macro_end, +1);
251 case DYN_MACRO_PLAY2:
252 dynamic_macro_play(r_macro_buffer, r_macro_end, -1);
257 /* A macro is being recorded right now. */
260 /* Stop the macro recording. */
261 if (record->event.pressed) { /* Ignore the initial release
262 * just after the recoding
266 dynamic_macro_record_end(macro_buffer, macro_pointer, +1, ¯o_end);
269 dynamic_macro_record_end(r_macro_buffer, macro_pointer, -1, &r_macro_end);
276 /* Store the key in the macro buffer and process it normally. */
279 dynamic_macro_record_key(macro_buffer, ¯o_pointer, r_macro_end, +1, record);
282 dynamic_macro_record_key(r_macro_buffer, ¯o_pointer, macro_end, -1, record);
293 #undef DYNAMIC_MACRO_CURRENT_SLOT
294 #undef DYNAMIC_MACRO_CURRENT_LENGTH
295 #undef DYNAMIC_MACRO_CURRENT_CAPACITY