542cb0a8ce
* Convert Dynamic Macro to a Core Feature This imports the code from Dynamic Macro into the core code, and handles it, as such. This deprecates the old method but does not remove it, for legacy support. This way, no existing user files need to be touched. Additionally, this reorganizes the documentation to better reflect the changes. Also, it adds user hooks to the feature so users can customize the existing functionality. Based heavily on and closes #2976 * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Cleanup based on feedback * Add short-form keycodes and document them - add short-form keycodes to quantum/quantum_keycodes.h - document the new aliases in docs/feature_dynamic_macros.md * Add Dynamic Macros section and keycodes to docs/keycodes.md * Make anti-nesting optional * Add documentation for DYNAMIC_MACRO_NO_NESTING option * Fix Merge artifacts * Fix formatting typo in docs Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Remove DYNAMIC_MACRO_RANGE as it's not needed * Fix includes and layer var type
42 lines
1.6 KiB
C
42 lines
1.6 KiB
C
/* Copyright 2016 Jack Humbert
|
|
* Copyright 2019 Drashna Jael're (@drashna, aka Christopher Courtney)
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/* Author: Wojciech Siewierski < wojciech dot siewierski at onet dot pl > */
|
|
#pragma once
|
|
|
|
#include "quantum.h"
|
|
|
|
/* May be overridden with a custom value. Be aware that the effective
|
|
* macro length is half of this value: each keypress is recorded twice
|
|
* because of the down-event and up-event. This is not a bug, it's the
|
|
* intended behavior.
|
|
*
|
|
* Usually it should be fine to set the macro size to at least 256 but
|
|
* there have been reports of it being too much in some users' cases,
|
|
* so 128 is considered a safe default.
|
|
*/
|
|
#ifndef DYNAMIC_MACRO_SIZE
|
|
# define DYNAMIC_MACRO_SIZE 128
|
|
#endif
|
|
|
|
void dynamic_macro_led_blink(void);
|
|
bool process_dynamic_macro(uint16_t keycode, keyrecord_t *record);
|
|
void dynamic_macro_record_start_user(void);
|
|
void dynamic_macro_play_user(int8_t direction);
|
|
void dynamic_macro_record_key_user(int8_t direction, keyrecord_t *record);
|
|
void dynamic_macro_record_end_user(int8_t direction);
|