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) {
50 #ifdef BACKLIGHT_ENABLE
57 /* Convenience macros used for retrieving the debug info. All of them
58 * need a `direction` variable accessible at the call site.
60 #define DYNAMIC_MACRO_CURRENT_SLOT() (direction > 0 ? 1 : 2)
61 #define DYNAMIC_MACRO_CURRENT_LENGTH(BEGIN, POINTER) ((int)(direction * ((POINTER) - (BEGIN))))
62 #define DYNAMIC_MACRO_CURRENT_CAPACITY(BEGIN, END2) ((int)(direction * ((END2) - (BEGIN)) + 1))
65 * Start recording of the dynamic macro.
67 * @param[out] macro_pointer The new macro buffer iterator.
68 * @param[in] macro_buffer The macro buffer used to initialize macro_pointer.
70 void dynamic_macro_record_start(keyrecord_t **macro_pointer, keyrecord_t *macro_buffer) {
71 dprintln("dynamic macro recording: started");
73 dynamic_macro_led_blink();
77 *macro_pointer = macro_buffer;
81 * Play the dynamic macro.
83 * @param macro_buffer[in] The beginning of the macro buffer being played.
84 * @param macro_end[in] The element after the last macro buffer element.
85 * @param direction[in] Either +1 or -1, which way to iterate the buffer.
87 void dynamic_macro_play(keyrecord_t *macro_buffer, keyrecord_t *macro_end, int8_t direction) {
88 dprintf("dynamic macro: slot %d playback\n", DYNAMIC_MACRO_CURRENT_SLOT());
90 uint32_t saved_layer_state = layer_state;
95 while (macro_buffer != macro_end) {
96 process_record(macro_buffer);
97 macro_buffer += direction;
102 layer_state = saved_layer_state;
106 * Record a single key in a dynamic macro.
108 * @param macro_buffer[in] The start of the used macro buffer.
109 * @param macro_pointer[in,out] The current buffer position.
110 * @param macro2_end[in] The end of the other macro.
111 * @param direction[in] Either +1 or -1, which way to iterate the buffer.
112 * @param record[in] The current keypress.
114 void dynamic_macro_record_key(keyrecord_t *macro_buffer, keyrecord_t **macro_pointer, keyrecord_t *macro2_end, int8_t direction, keyrecord_t *record) {
115 /* If we've just started recording, ignore all the key releases. */
116 if (!record->event.pressed && *macro_pointer == macro_buffer) {
117 dprintln("dynamic macro: ignoring a leading key-up event");
121 /* The other end of the other macro is the last buffer element it
122 * is safe to use before overwriting the other macro.
124 if (*macro_pointer - direction != macro2_end) {
125 **macro_pointer = *record;
126 *macro_pointer += direction;
128 dynamic_macro_led_blink();
131 dprintf("dynamic macro: slot %d length: %d/%d\n", DYNAMIC_MACRO_CURRENT_SLOT(), DYNAMIC_MACRO_CURRENT_LENGTH(macro_buffer, *macro_pointer), DYNAMIC_MACRO_CURRENT_CAPACITY(macro_buffer, macro2_end));
135 * End recording of the dynamic macro. Essentially just update the
136 * pointer to the end of the macro.
138 void dynamic_macro_record_end(keyrecord_t *macro_buffer, keyrecord_t *macro_pointer, int8_t direction, keyrecord_t **macro_end) {
139 dynamic_macro_led_blink();
141 /* Do not save the keys being held when stopping the recording,
142 * i.e. the keys used to access the layer DYN_REC_STOP is on.
144 while (macro_pointer != macro_buffer && (macro_pointer - direction)->event.pressed) {
145 dprintln("dynamic macro: trimming a trailing key-down event");
146 macro_pointer -= direction;
149 dprintf("dynamic macro: slot %d saved, length: %d\n", DYNAMIC_MACRO_CURRENT_SLOT(), DYNAMIC_MACRO_CURRENT_LENGTH(macro_buffer, macro_pointer));
151 *macro_end = macro_pointer;
154 /* Handle the key events related to the dynamic macros. Should be
155 * called from process_record_user() like this:
157 * bool process_record_user(uint16_t keycode, keyrecord_t *record) {
158 * if (!process_record_dynamic_macro(keycode, record)) {
161 * <...THE REST OF THE FUNCTION...>
164 bool process_record_dynamic_macro(uint16_t keycode, keyrecord_t *record) {
165 /* Both macros use the same buffer but read/write on different
168 * Macro1 is written left-to-right starting from the beginning of
171 * Macro2 is written right-to-left starting from the end of the
174 * ¯o_buffer macro_end
176 * +------------------------------------------------------------+
177 * |>>>>>> MACRO1 >>>>>> <<<<<<<<<<<<< MACRO2 <<<<<<<<<<<<<|
178 * +------------------------------------------------------------+
180 * r_macro_end r_macro_buffer
182 * During the recording when one macro encounters the end of the
183 * other macro, the recording is stopped. Apart from this, there
184 * are no arbitrary limits for the macros' length in relation to
185 * each other: for example one can either have two medium sized
186 * macros or one long macro and one short macro. Or even one empty
187 * and one using the whole buffer.
189 static keyrecord_t macro_buffer[DYNAMIC_MACRO_SIZE];
191 /* Pointer to the first buffer element after the first macro.
192 * Initially points to the very beginning of the buffer since the
194 static keyrecord_t *macro_end = macro_buffer;
196 /* The other end of the macro buffer. Serves as the beginning of
197 * the second macro. */
198 static keyrecord_t *const r_macro_buffer = macro_buffer + DYNAMIC_MACRO_SIZE - 1;
200 /* Like macro_end but for the second macro. */
201 static keyrecord_t *r_macro_end = r_macro_buffer;
203 /* A persistent pointer to the current macro position (iterator)
204 * used during the recording. */
205 static keyrecord_t *macro_pointer = NULL;
207 /* 0 - no macro is being recorded right now
208 * 1,2 - either macro 1 or 2 is being recorded */
209 static uint8_t macro_id = 0;
212 /* No macro recording in progress. */
213 if (!record->event.pressed) {
216 dynamic_macro_record_start(¯o_pointer, macro_buffer);
220 dynamic_macro_record_start(¯o_pointer, r_macro_buffer);
223 case DYN_MACRO_PLAY1:
224 dynamic_macro_play(macro_buffer, macro_end, +1);
226 case DYN_MACRO_PLAY2:
227 dynamic_macro_play(r_macro_buffer, r_macro_end, -1);
232 /* A macro is being recorded right now. */
235 /* Stop the macro recording. */
236 if (record->event.pressed) { /* Ignore the initial release
237 * just after the recoding
241 dynamic_macro_record_end(macro_buffer, macro_pointer, +1, ¯o_end);
244 dynamic_macro_record_end(r_macro_buffer, macro_pointer, -1, &r_macro_end);
250 case DYN_MACRO_PLAY1:
251 case DYN_MACRO_PLAY2:
252 dprintln("dynamic macro: ignoring macro play key while recording");
255 /* Store the key in the macro buffer and process it normally. */
258 dynamic_macro_record_key(macro_buffer, ¯o_pointer, r_macro_end, +1, record);
261 dynamic_macro_record_key(r_macro_buffer, ¯o_pointer, macro_end, -1, record);
272 #undef DYNAMIC_MACRO_CURRENT_SLOT
273 #undef DYNAMIC_MACRO_CURRENT_LENGTH
274 #undef DYNAMIC_MACRO_CURRENT_CAPACITY