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,
47 /* Blink the LEDs to notify the user about some event. */
48 void dynamic_macro_led_blink(void)
56 * Start recording of the dynamic macro.
58 * @param[out] macro_pointer The new macro buffer iterator.
59 * @param[in] macro_buffer The macro buffer used to initialize macro_pointer.
61 void dynamic_macro_record_start(
62 keyrecord_t **macro_pointer, keyrecord_t *macro_buffer)
64 dynamic_macro_led_blink();
68 *macro_pointer = macro_buffer;
72 * Play the dynamic macro.
74 * @param macro_buffer[in] The beginning of the macro buffer being played.
75 * @param macro_end[in] The element after the last macro buffer element.
76 * @param direction[in] Either +1 or -1, which way to iterate the buffer.
78 void dynamic_macro_play(
79 keyrecord_t *macro_buffer, keyrecord_t *macro_end, int8_t direction)
81 uint32_t saved_layer_state = layer_state;
86 while (macro_buffer != macro_end) {
87 process_record(macro_buffer);
88 macro_buffer += direction;
93 layer_state = saved_layer_state;
97 * Record a single key in a dynamic macro.
99 * @param macro_pointer[in,out] The current buffer position.
100 * @param macro_end2[in] The end of the other macro which shouldn't be overwritten.
101 * @param direction[in] Either +1 or -1, which way to iterate the buffer.
102 * @param record[in] The current keypress.
104 void dynamic_macro_record_key(
105 keyrecord_t **macro_pointer,
106 keyrecord_t *macro_end2,
110 if (*macro_pointer + direction != macro_end2) {
111 **macro_pointer = *record;
112 *macro_pointer += direction;
114 /* Notify about the end of buffer. The blinks are paired
115 * because they should happen on both down and up events. */
121 * End recording of the dynamic macro. Essentially just update the
122 * pointer to the end of the macro.
124 void dynamic_macro_record_end(keyrecord_t *macro_pointer, keyrecord_t **macro_end)
126 dynamic_macro_led_blink();
128 *macro_end = macro_pointer;
131 /* Handle the key events related to the dynamic macros. Should be
132 * called from process_record_user() like this:
134 * bool process_record_user(uint16_t keycode, keyrecord_t *record) {
135 * if (!process_record_dynamic_macro(keycode, record)) {
138 * <...THE REST OF THE FUNCTION...>
141 bool process_record_dynamic_macro(uint16_t keycode, keyrecord_t *record)
143 /* Both macros use the same buffer but read/write on different
146 * Macro1 is written left-to-right starting from the beginning of
149 * Macro2 is written right-to-left starting from the end of the
152 * ¯o_buffer macro_end
154 * +------------------------------------------------------------+
155 * |>>>>>> MACRO1 >>>>>>| |<<<<<<<<<<<<< MACRO2 <<<<<<<<<<<<<|
156 * +------------------------------------------------------------+
158 * r_macro_end r_macro_buffer
160 * During the recording when one macro encounters the end of the
161 * other macro, the recording is stopped. Apart from this, there
162 * are no arbitrary limits for the macros' length in relation to
163 * each other: for example one can either have two medium sized
164 * macros or one long macro and one short macro. Or even one empty
165 * and one using the whole buffer.
167 static keyrecord_t macro_buffer[DYNAMIC_MACRO_SIZE];
169 /* Pointer to the first buffer element after the first macro.
170 * Initially points to the very beginning of the buffer since the
172 static keyrecord_t *macro_end = macro_buffer;
174 /* The other end of the macro buffer. Serves as the beginning of
175 * the second macro. */
176 static keyrecord_t *const r_macro_buffer = macro_buffer + DYNAMIC_MACRO_SIZE - 1;
178 /* Like macro_end but for the second macro. */
179 static keyrecord_t *r_macro_end = r_macro_buffer;
181 /* A persistent pointer to the current macro position (iterator)
182 * used during the recording. */
183 static keyrecord_t *macro_pointer = NULL;
185 /* 0 - no macro is being recorded right now
186 * 1,2 - either macro 1 or 2 is being recorded */
187 static uint8_t macro_id = 0;
190 /* No macro recording in progress. */
191 if (!record->event.pressed) {
194 dynamic_macro_record_start(¯o_pointer, macro_buffer);
198 dynamic_macro_record_start(¯o_pointer, r_macro_buffer);
201 case DYN_MACRO_PLAY1:
202 dynamic_macro_play(macro_buffer, macro_end, +1);
204 case DYN_MACRO_PLAY2:
205 dynamic_macro_play(r_macro_buffer, r_macro_end, -1);
210 /* A macro is being recorded right now. */
213 /* Use the layer key used to access the macro recording as
215 if (record->event.pressed) { /* Ignore the initial release
216 * just after the recoding
220 dynamic_macro_record_end(macro_pointer, ¯o_end);
223 dynamic_macro_record_end(macro_pointer, &r_macro_end);
230 /* Store the key in the macro buffer and process it normally. */
233 dynamic_macro_record_key(¯o_pointer, r_macro_end, +1, record);
236 dynamic_macro_record_key(¯o_pointer, macro_end, -1, record);