[jackhill/qmk/firmware.git] / docs / feature_macros.md

# Macros

Macros allow you to send multiple keystrokes when pressing just one key. QMK has a number of ways to define and use macros. These can do anything you want: type common phrases for you, copypasta, repetitive game movements, or even help you code.

{% hint style='danger' %}
**Security Note**: While it is possible to use macros to send passwords, credit card numbers, and other sensitive information it is a supremely bad idea to do so. Anyone who gets a hold of your keyboard will be able to access that information by opening a text editor.
{% endhint %}

## The New Way: `SEND_STRING()` & `process_record_user`

Sometimes you just want a key to type out words or phrases. For the most common situations we've provided `SEND_STRING()`, which will type out your string (i.e. a sequence of characters) for you. All ASCII characters that are easily translated to a keycode are supported (e.g. `\n\t`).

Here is an example `keymap.c` for a two-key keyboard:

```c
enum custom_keycodes {
	MY_CUSTOM_MACRO = SAFE_RANGE
};

bool process_record_user(uint16_t keycode, keyrecord_t *record) {
	if (record->event.pressed) {
		switch(keycode) {
			case MY_CUSTOM_MACRO:
				SEND_STRING("QMK is the best thing ever!"); // this is our macro!
				return false;
		}
	}
	return true;
};

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
	[0] = {
	  {MY_CUSTOM_MACRO, KC_ESC}
	}
};
```

What happens here is this:
We first define a new custom keycode in the range not occupied by any other keycodes.
Then we use the `process_record_user` function, which is called whenever a key is pressed or released, to check if our custom keycode has been activated.
If yes, we send the string `"QMK is the best thing ever!"` to the computer via the `SEND_STRING` macro (this is a C preprocessor macro, not to be confused with QMK macros).
We return `false` to indicate to the caller that the key press we just processed need not be processed any further.
Finally, we define the keymap so that the first button activates our macro and the second button is just an escape button.

You might want to add more than one macro.
You can do that by adding another keycode and adding another case to the switch statement, like so:

```c
enum custom_keycodes {
	MY_CUSTOM_MACRO = SAFE_RANGE,
	MY_OTHER_MACRO
};

bool process_record_user(uint16_t keycode, keyrecord_t *record) {
	if (record->event.pressed) {
		switch(keycode) {
			case MY_CUSTOM_MACRO:
				SEND_STRING("QMK is the best thing ever!");
				return false;
			case MY_OTHER_MACRO:
				SEND_STRING(SS_LCTRL("ac")); // selects all and copies
				return false;
		}
	}
	return true;
};

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
	[0] = {
	  {MY_CUSTOM_MACRO, MY_OTHER_MACRO}
	}
};
```

### TAP, DOWN and UP

You may want to use keys in your macros that you can't write down, such as `Ctrl` or `Home`.
You can send arbitrary keycodes by wrapping them in:

* `SS_TAP()` presses and releases a key.
* `SS_DOWN()` presses (but does not release) a key.
* `SS_UP()` releases a key.

For example:

    SEND_STRING(SS_TAP(X_HOME));

Would tap `KC_HOME` - note how the prefix is now `X_`, and not `KC_`. You can also combine this with other strings, like this:

    SEND_STRING("VE"SS_TAP(X_HOME)"LO");

Which would send "VE" followed by a `KC_HOME` tap, and "LO" (spelling "LOVE" if on a newline).

There's also a couple of mod shortcuts you can use:

* `SS_LCTRL(string)`
* `SS_LGUI(string)`
* `SS_LALT(string)`
* `SS_LSFT(string)`
* `SS_RALT(string)`

These press the respective modifier, send the supplied string and then release the modifier.
They can be used like this:

    SEND_STRING(SS_LCTRL("a"));

Which would send LCTRL+a (LCTRL down, a, LCTRL up) - notice that they take strings (eg `"k"`), and not the `X_K` keycodes.

### Alternative Keymaps

By default, it assumes a US keymap with a QWERTY layout; if you want to change that (e.g. if your OS uses software Colemak), include this somewhere in your keymap:

    #include <sendstring_colemak.h>

### Strings in Memory

If for some reason you're manipulating strings and need to print out something you just generated (instead of being a literal, constant string), you can use `send_string()`, like this:

```c
char my_str[4] = "ok.";
send_string(my_str);
```

The shortcuts defined above won't work with `send_string()`, but you can separate things out to different lines if needed:

```c
char my_str[4] = "ok.";
SEND_STRING("I said: ");
send_string(my_str);
SEND_STRING(".."SS_TAP(X_END));
```

## The Old Way: `MACRO()` & `action_get_macro`

{% hint style='info' %}
This is inherited from TMK, and hasn't been updated - it's recommend that you use `SEND_STRING` and `process_record_user` instead.
{% endhint %}

By default QMK assumes you don't have any macros. To define your macros you create an `action_get_macro()` function. For example:

```c
const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
	if (record->event.pressed) {
		switch(id) {
			case 0:
				return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
			case 1:
				return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
		}
	}
	return MACRO_NONE;
};
```

This defines two macros which will be run when the key they are assigned to is pressed. If instead you'd like them to run when the key is released you can change the if statement:

	if (!record->event.pressed) {

### Macro Commands

A macro can include the following commands:

* I() change interval of stroke in milliseconds.
* D() press key.
* U() release key.
* T() type key(press and release).
* W() wait (milliseconds).
* END end mark.

### Mapping a Macro to a Key

Use the `M()` function within your `KEYMAP()` to call a macro. For example, here is the keymap for a 2-key keyboard:

```c
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
	[0] = KEYMAP(
		M(0), M(1)
	),
};

const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
	if (record->event.pressed) {
		switch(id) {
			case 0:
				return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
			case 1:
				return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
		}
	}
	return MACRO_NONE;
};
```

When you press the key on the left it will type "Hi!" and when you press the key on the right it will type "Bye!".

### Naming Your Macros

If you have a bunch of macros you want to refer to from your keymap while keeping the keymap easily readable you can name them using `#define` at the top of your file.

```c
#define M_HI M(0)
#define M_BYE M(1)

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
	[0] = KEYMAP(
		M_HI, M_BYE
	),
};
```

## Advanced Macro Functions

There are some functions you may find useful in macro-writing. Keep in mind that while you can write some fairly advanced code within a macro if your functionality gets too complex you may want to define a custom keycode instead. Macros are meant to be simple.

### `record->event.pressed`

This is a boolean value that can be tested to see if the switch is being pressed or released. An example of this is

```c
	if (record->event.pressed) {
		// on keydown
	} else {
		// on keyup
	}
```

### `register_code(<kc>);`

This sends the `<kc>` keydown event to the computer. Some examples would be `KC_ESC`, `KC_C`, `KC_4`, and even modifiers such as `KC_LSFT` and `KC_LGUI`.

### `unregister_code(<kc>);`

Parallel to `register_code` function, this sends the `<kc>` keyup event to the computer. If you don't use this, the key will be held down until it's sent.

### `clear_keyboard();`

This will clear all mods and keys currently pressed.

### `clear_mods();`

This will clear all mods currently pressed.

### `clear_keyboard_but_mods();`

This will clear all keys besides the mods currently pressed.

## Advanced Example: Single-Key Copy/Paste

This example defines a macro which sends `Ctrl-C` when pressed down, and `Ctrl-V` when released.

```c
const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
	switch(id) {
		case 0: {
			if (record->event.pressed) {
				return MACRO( D(LCTL), T(C), U(LCTL), END  );
			} else {
				return MACRO( D(LCTL), T(V), U(LCTL), END  );
			}
			break;
		}
	}
	return MACRO_NONE;
};
```
Commit	Line	Data
d8e29b53	1	# Macros
ca01d940	2
bb53635f	3	Macros allow you to send multiple keystrokes when pressing just one key. QMK has a number of ways to define and use macros. These can do anything you want: type common phrases for you, copypasta, repetitive game movements, or even help you code.
ca01d940	4
d8e29b53	5	{% hint style='danger' %}
af37bb2f	6	Security Note: While it is possible to use macros to send passwords, credit card numbers, and other sensitive information it is a supremely bad idea to do so. Anyone who gets a hold of your keyboard will be able to access that information by opening a text editor.
d8e29b53	7	{% endhint %}
ca01d940	8
7b0356d1	9	## The New Way: `SEND_STRING()` & `process_record_user`
ca01d940	10
179d64d3	11	Sometimes you just want a key to type out words or phrases. For the most common situations we've provided `SEND_STRING()`, which will type out your string (i.e. a sequence of characters) for you. All ASCII characters that are easily translated to a keycode are supported (e.g. `\n\t`).
7ad924ba	12
858c09f3	13	Here is an example `keymap.c` for a two-key keyboard:
179d64d3 BG	14
	15	```c
	16	enum custom_keycodes {
	17	MY_CUSTOM_MACRO = SAFE_RANGE
	18	};
	19
	20	bool process_record_user(uint16_t keycode, keyrecord_t *record) {
	21	if (record->event.pressed) {
	22	switch(keycode) {
	23	case MY_CUSTOM_MACRO:
858c09f3	24	SEND_STRING("QMK is the best thing ever!"); // this is our macro!
31cae1f1	25	return false;
179d64d3 BG	26	}
	27	}
	28	return true;
	29	};
179d64d3	30
858c09f3 BG	31	const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
	32	[0] = {
	33	{MY_CUSTOM_MACRO, KC_ESC}
	34	}
	35	};
	36	```
179d64d3 BG	37
	38	What happens here is this:
	39	We first define a new custom keycode in the range not occupied by any other keycodes.
	40	Then we use the `process_record_user` function, which is called whenever a key is pressed or released, to check if our custom keycode has been activated.
	41	If yes, we send the string `"QMK is the best thing ever!"` to the computer via the `SEND_STRING` macro (this is a C preprocessor macro, not to be confused with QMK macros).
	42	We return `false` to indicate to the caller that the key press we just processed need not be processed any further.
858c09f3	43	Finally, we define the keymap so that the first button activates our macro and the second button is just an escape button.
179d64d3 BG	44
	45	You might want to add more than one macro.
	46	You can do that by adding another keycode and adding another case to the switch statement, like so:
ca01d940 JH	47
ca01d940 JH	48	```c
7ad924ba	49	enum custom_keycodes {
179d64d3 BG	50	MY_CUSTOM_MACRO = SAFE_RANGE,
179d64d3 BG	51	MY_OTHER_MACRO
7ad924ba JH	52	};
	53
	54	bool process_record_user(uint16_t keycode, keyrecord_t *record) {
ca01d940	55	if (record->event.pressed) {
7ad924ba	56	switch(keycode) {
179d64d3	57	case MY_CUSTOM_MACRO:
7ad924ba	58	SEND_STRING("QMK is the best thing ever!");
31cae1f1	59	return false;
179d64d3 BG	60	case MY_OTHER_MACRO:
179d64d3 BG	61	SEND_STRING(SS_LCTRL("ac")); // selects all and copies
31cae1f1	62	return false;
ca01d940 JH	63	}
ca01d940 JH	64	}
7ad924ba	65	return true;
ca01d940	66	};
858c09f3 BG	67
	68	const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
	69	[0] = {
	70	{MY_CUSTOM_MACRO, MY_OTHER_MACRO}
	71	}
	72	};
ca01d940 JH	73	```
ca01d940 JH	74
179d64d3	75	### TAP, DOWN and UP
7ad924ba	76
179d64d3	77	You may want to use keys in your macros that you can't write down, such as `Ctrl` or `Home`.
af37bb2f	78	You can send arbitrary keycodes by wrapping them in:
7ad924ba	79
179d64d3 BG	80	* `SS_TAP()` presses and releases a key.
	81	* `SS_DOWN()` presses (but does not release) a key.
	82	* `SS_UP()` releases a key.
7ad924ba JH	83
	84	For example:
	85
	86	SEND_STRING(SS_TAP(X_HOME));
	87
	88	Would tap `KC_HOME` - note how the prefix is now `X_`, and not `KC_`. You can also combine this with other strings, like this:
	89
	90	SEND_STRING("VE"SS_TAP(X_HOME)"LO");
	91
	92	Which would send "VE" followed by a `KC_HOME` tap, and "LO" (spelling "LOVE" if on a newline).
	93
	94	There's also a couple of mod shortcuts you can use:
	95
	96	* `SS_LCTRL(string)`
	97	* `SS_LGUI(string)`
	98	* `SS_LALT(string)`
7ff96877	99	* `SS_LSFT(string)`
3f1d1475	100	* `SS_RALT(string)`
7ad924ba	101
179d64d3 BG	102	These press the respective modifier, send the supplied string and then release the modifier.
179d64d3 BG	103	They can be used like this:
7ad924ba JH	104
	105	SEND_STRING(SS_LCTRL("a"));
	106
179d64d3	107	Which would send LCTRL+a (LCTRL down, a, LCTRL up) - notice that they take strings (eg `"k"`), and not the `X_K` keycodes.
7ad924ba	108
7b0356d1	109	### Alternative Keymaps
7ad924ba JH	110
	111	By default, it assumes a US keymap with a QWERTY layout; if you want to change that (e.g. if your OS uses software Colemak), include this somewhere in your keymap:
	112
	113	#include <sendstring_colemak.h>
	114
7b0356d1	115	### Strings in Memory
7ad924ba JH	116
7ad924ba JH	117	If for some reason you're manipulating strings and need to print out something you just generated (instead of being a literal, constant string), you can use `send_string()`, like this:
ca01d940 JH	118
ca01d940 JH	119	```c
7ad924ba JH	120	char my_str[4] = "ok.";
7ad924ba JH	121	send_string(my_str);
ca01d940 JH	122	```
ca01d940 JH	123
7ad924ba	124	The shortcuts defined above won't work with `send_string()`, but you can separate things out to different lines if needed:
ca01d940	125
7ad924ba JH	126	```c
	127	char my_str[4] = "ok.";
	128	SEND_STRING("I said: ");
	129	send_string(my_str);
	130	SEND_STRING(".."SS_TAP(X_END));
	131	```
ca01d940	132
7b0356d1	133	## The Old Way: `MACRO()` & `action_get_macro`
ca01d940	134
7ad924ba JH	135	{% hint style='info' %}
	136	This is inherited from TMK, and hasn't been updated - it's recommend that you use `SEND_STRING` and `process_record_user` instead.
	137	{% endhint %}
ca01d940	138
7ad924ba	139	By default QMK assumes you don't have any macros. To define your macros you create an `action_get_macro()` function. For example:
ca01d940 JH	140
	141	```c
	142	const macro_t action_get_macro(keyrecord_t record, uint8_t id, uint8_t opt) {
	143	if (record->event.pressed) {
	144	switch(id) {
	145	case 0:
7ad924ba JH	146	return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
	147	case 1:
	148	return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
ca01d940 JH	149	}
	150	}
	151	return MACRO_NONE;
	152	};
	153	```
	154
7ad924ba	155	This defines two macros which will be run when the key they are assigned to is pressed. If instead you'd like them to run when the key is released you can change the if statement:
48ff9358	156
7ad924ba JH	157	if (!record->event.pressed) {
	158
	159	### Macro Commands
	160
	161	A macro can include the following commands:
	162
	163	* I() change interval of stroke in milliseconds.
	164	* D() press key.
	165	* U() release key.
	166	* T() type key(press and release).
	167	* W() wait (milliseconds).
	168	* END end mark.
48ff9358	169
7b0356d1	170	### Mapping a Macro to a Key
ca01d940 JH	171
	172	Use the `M()` function within your `KEYMAP()` to call a macro. For example, here is the keymap for a 2-key keyboard:
	173
	174	```c
	175	const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
	176	[0] = KEYMAP(
	177	M(0), M(1)
	178	),
	179	};
	180
	181	const macro_t action_get_macro(keyrecord_t record, uint8_t id, uint8_t opt) {
	182	if (record->event.pressed) {
	183	switch(id) {
	184	case 0:
	185	return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
	186	case 1:
	187	return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
	188	}
	189	}
	190	return MACRO_NONE;
	191	};
	192	```
	193
	194	When you press the key on the left it will type "Hi!" and when you press the key on the right it will type "Bye!".
	195
7b0356d1	196	### Naming Your Macros
ca01d940 JH	197
	198	If you have a bunch of macros you want to refer to from your keymap while keeping the keymap easily readable you can name them using `#define` at the top of your file.
	199
	200	```c
	201	#define M_HI M(0)
	202	#define M_BYE M(1)
	203
	204	const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
	205	[0] = KEYMAP(
	206	M_HI, M_BYE
	207	),
	208	};
	209	```
	210
7b0356d1	211	## Advanced Macro Functions
ca01d940	212
7ad924ba	213	There are some functions you may find useful in macro-writing. Keep in mind that while you can write some fairly advanced code within a macro if your functionality gets too complex you may want to define a custom keycode instead. Macros are meant to be simple.
ca01d940	214
7ad924ba	215	### `record->event.pressed`
ca01d940 JH	216
	217	This is a boolean value that can be tested to see if the switch is being pressed or released. An example of this is
	218
	219	```c
	220	if (record->event.pressed) {
	221	// on keydown
	222	} else {
	223	// on keyup
	224	}
	225	```
	226
7ad924ba	227	### `register_code(<kc>);`
ca01d940 JH	228
	229	This sends the `<kc>` keydown event to the computer. Some examples would be `KC_ESC`, `KC_C`, `KC_4`, and even modifiers such as `KC_LSFT` and `KC_LGUI`.
	230
7ad924ba	231	### `unregister_code(<kc>);`
ca01d940 JH	232
	233	Parallel to `register_code` function, this sends the `<kc>` keyup event to the computer. If you don't use this, the key will be held down until it's sent.
	234
7ad924ba	235	### `clear_keyboard();`
ca01d940 JH	236
	237	This will clear all mods and keys currently pressed.
	238
7ad924ba	239	### `clear_mods();`
ca01d940 JH	240
	241	This will clear all mods currently pressed.
	242
7ad924ba	243	### `clear_keyboard_but_mods();`
ca01d940 JH	244
	245	This will clear all keys besides the mods currently pressed.
	246
7b0356d1	247	## Advanced Example: Single-Key Copy/Paste
ca01d940	248
bb53635f	249	This example defines a macro which sends `Ctrl-C` when pressed down, and `Ctrl-V` when released.
ca01d940 JH	250
	251	```c
	252	const macro_t action_get_macro(keyrecord_t record, uint8_t id, uint8_t opt) {
	253	switch(id) {
	254	case 0: {
	255	if (record->event.pressed) {
	256	return MACRO( D(LCTL), T(C), U(LCTL), END );
	257	} else {
	258	return MACRO( D(LCTL), T(V), U(LCTL), END );
	259	}
	260	break;
	261	}
	262	}
	263	return MACRO_NONE;
	264	};
	265	```