Add + to macros.

Author: rvaiya

CHANGELOG.md

@@ -1,4 +1,8 @@
-# v2.0-beta
+# v2.0.1-beta
+
+ - Added + syntax to macros to allow for simultaenously held keys.
+
+# v2.0.0-beta
 
 Major version update. 
 

Makefile

@@ -7,7 +7,7 @@ LOCK_FILE="/var/lock/keyd.lock"
 LOG_FILE="/var/log/keyd.log"
 CONFIG_DIR="/etc/keyd"
 
-VERSION=2.0.0-beta
+VERSION=2.0.1-beta
 GIT_HASH=$(shell git describe --no-match --always --abbrev=40 --dirty)
 
 CFLAGS+=-DVERSION=\"$(VERSION)\" \

keyd.1.gz

@@ -12,18 +12,18 @@
 
 keyd is a system wide key remapping daemon which supports features like
 layering, oneshot modifiers, and macros. In its most basic form it can be used
-to define a custom key layout that persists accross display server boundaries
+to define a custom key layout that persists across display server boundaries
 (e.g wayland/X/tty).
 
 The program is intended to run as a systemd service but is capable of running
-as a standalone daemon. The default behaviour is to run in the forground and print
+as a standalone daemon. The default behaviour is to run in the foreground and print
 to stderr, unless **-d** is supplied, in which case in which case log output
 will be stored in */var/log/keyd.log*.
 
 **NOTE**
 
-Becuase keyd modifies your primary input device it is possible to render your
-machine unusuable with a bad config file. If you find yourself in this
+Because keyd modifies your primary input device it is possible to render your
+machine unusable with a bad config file. If you find yourself in this
 situation the sequence *\<backspace\>+\<backslash\>+\<enter\>* will force keyd
 to terminate.
 
@@ -141,7 +141,7 @@ Layouts also have the additional property of being affected by the active modifi
 set. That is, unlike layouts, key sequences mapped within them are not
 interpreted literally.
 
-If you wish to use an alternative letter arrangement, this is the appropriate
+If you wish to use an alternative letter arrangement this is the appropriate
 place to define it.
 
 E.G
@@ -181,9 +181,9 @@ For example:
 Will cause the leftalt key to behave as alt in all instances except when
 alt+1 is pressed, in which case the key sequence `C-A-f1` will be emitted.
 
-By default each modifier is mapped to an eponymously named layer.
+By default each modifier key is mapped to an eponymously named modifier layer.
 
-Thus, the above config can be shortened to:
+Thus the above config can be shortened to:
 
 	[A]
 
@@ -239,7 +239,7 @@ distinct from `layout()` which should be used for letter layouts.
 
 : Activates the given layer while held and emits the given key sequence when
 tapped. A timeout in milliseconds may optionally be supplied to disambiguate
-between a tap and a hold. 
+a tap and a hold. 
 
 	If a timeout is present depression of the corresponding key is only interpreted
 as a layer activation in the event that it is sustained for more than
@@ -267,6 +267,7 @@ Where `<macro>` has the form `<token1> [<token2>...]` where each token is one of
 
 - a valid key sequence.
 - a contiguous group of characters each of which is a valid key sequence.
+- a group of key codes delimited by + to be depressed as a unit.
 - a timeout of the form `<time>ms` (where `<time>` < 1024).
 
 Examples:
@@ -280,6 +281,15 @@ Examples:
 	# Identical to the above
 	macro(Hello space World)
 
+	# Produces control + b
+	macro(control + b)
+
+	# Produces the sequence <control down> <b down> <control up> <b up>
+	macro(control+b)
+
+	# Produces the sequence <control down> <control up> <b down> <b up>
+	macro(control b)
+
 # EXAMPLES
 
 ## Example 1

man.md

@@ -189,7 +189,7 @@ static struct layer *lookup_layer(const char *name, void *_config)
 
 static int parse_header(const char *s,
 			char name[MAX_LAYER_NAME_LEN],
-			char type[MAX_LAYER_NAME_LEN]) 
+			char type[MAX_LAYER_NAME_LEN])
 {
 	char *d;
 	size_t typelen, namelen;
@@ -219,7 +219,7 @@ static int parse_header(const char *s,
 	return 0;
 }
 
-static void parse_id_section(struct config *config, struct ini_section *section) 
+static void parse_id_section(struct config *config, struct ini_section *section)
 {
 	size_t i;
 
@@ -292,7 +292,7 @@ static int parse_config(const char *config_name, char *str, struct config *confi
 	assert(strlen(config_name) < MAX_CONFIG_NAME);
 	strcpy(config->name, config_name);
 
-	/* 
+	/*
 	 * First pass, create layers so they are available
 	 * for lookup during descriptor parsing.
 	 */
@@ -306,7 +306,7 @@ static int parse_config(const char *config_name, char *str, struct config *confi
 		if (!strcmp(section->name, "ids")) {
 			parse_id_section(config, section);
 			continue;
-		} 
+		}
 
 		if (parse_header(section->name, name, type) < 0) {
 			fprintf(stderr,
@@ -351,7 +351,6 @@ static int parse_config(const char *config_name, char *str, struct config *confi
 
 			char *k, *v;
 			uint16_t code;
-			uint16_t mod;
 
 			struct descriptor desc;
 
@@ -389,7 +388,7 @@ static void post_process_config(const struct config *config)
 	size_t i;
 	uint16_t code;
 
-	/* 
+	/*
 	 * Convert all modifier keycodes into their corresponding layer
 	 * counterparts for consistency. This allows us to avoid explicitly
 	 * accounting for modifier layer/modifier keycode overlap within the

src/config.c

@@ -110,14 +110,14 @@ static int parse_key_sequence(const char *s, struct key_sequence *seq)
 		const struct keycode_table_ent *ent = &keycode_table[code];
 
 		if (ent->name) {
-			if (ent->shifted_name && 
+			if (ent->shifted_name &&
 			    !strcmp(ent->shifted_name, c)) {
 
 				seq->mods |= MOD_SHIFT;
 				seq->code = code;
 
 				return 0;
-			} else if (!strcmp(ent->name, c) || 
+			} else if (!strcmp(ent->name, c) ||
 				   (ent->alt_name && !strcmp(ent->alt_name, c))) {
 
 				seq->code = code;
@@ -154,6 +154,8 @@ static struct macro *parse_macro_fn(char *s)
 			assert(sz < MAX_MACRO_SIZE);
 
 			ent.type = MACRO_KEYSEQUENCE;
+
+			assert(macro->sz < MAX_MACRO_SIZE);
 			macro->entries[macro->sz++] = ent;
 		} else if (len > 1 && tok[len-2] == 'm' && tok[len-1] == 's') {
 			int len = atoi(tok);
@@ -162,23 +164,42 @@ static struct macro *parse_macro_fn(char *s)
 			ent.data.timeout = len;
 
 			assert(macro->sz < MAX_MACRO_SIZE);
-
 			macro->entries[macro->sz++] = ent;
 		} else {
 			char *c;
 
-			for (c = tok; *c; c++) {
-				char s[2];
+			if (strchr(tok, '+')) {
+				char *saveptr;
+				char *key;
+
+				for (key = strtok_r(tok, "+", &saveptr); key; key = strtok_r(NULL, "+", &saveptr)) {
+					if (parse_key_sequence(key, &ent.data.sequence) < 0)
+						return NULL;
 
-				s[0] = *c;
-				s[1] = 0;
+					ent.type = MACRO_HOLD;
 
-				if (parse_key_sequence(s, &ent.data.sequence) < 0)
-					return NULL;
+					assert(macro->sz < MAX_MACRO_SIZE);
+					macro->entries[macro->sz++] = ent;
+				}
 
-				ent.type = MACRO_KEYSEQUENCE;
+				ent.type = MACRO_RELEASE;
 				assert(macro->sz < MAX_MACRO_SIZE);
 				macro->entries[macro->sz++] = ent;
+			} else {
+				for (c = tok; *c; c++) {
+					char s[2];
+
+					s[0] = *c;
+					s[1] = 0;
+
+					if (parse_key_sequence(s, &ent.data.sequence) < 0)
+						return NULL;
+
+					ent.type = MACRO_KEYSEQUENCE;
+
+					assert(macro->sz < MAX_MACRO_SIZE);
+					macro->entries[macro->sz++] = ent;
+				}
 			}
 		}
 	}
@@ -188,7 +209,7 @@ static struct macro *parse_macro_fn(char *s)
 	return macro;
 }
 
-/* 
+/*
  * Modifies the input string, consumes a function which which is used for
  * resolving layer names as required.
  */

src/descriptor.c

@@ -31,6 +31,8 @@ struct key_sequence {
 struct macro_entry {
 	enum {
 		MACRO_KEYSEQUENCE,
+		MACRO_HOLD,
+		MACRO_RELEASE,
 		MACRO_TIMEOUT
 	} type;
 
@@ -40,8 +42,8 @@ struct macro_entry {
 	} data;
 };
 
-/* 
- * A series of key sequences optionally punctuated by 
+/*
+ * A series of key sequences optionally punctuated by
  * timeouts
  */
 struct macro {

src/descriptor.h

@@ -28,19 +28,19 @@ struct ini {
 
 /*
  * Reads a file of the form:
- * 
+ *
  *  [section]
- *  
+ *
  *  # Comment
- * 
+ *
  *  entry1
  *  entry2
- * 
+ *
  *  [section2]
  *  ...
- * 
+ *
  *  Stripping comments and empty lines along the way.
- *  Each entry is a non comment, non empty line 
+ *  Each entry is a non comment, non empty line
  *  sripped of leading whitespace. If a default
  *  section name is supplied then entries not
  *  listed under an explicit heading will be

src/ini.h

@@ -23,6 +23,7 @@
 #include <stdint.h>
 #include <unistd.h>
 #include <stdio.h>
+#include <time.h>
 #include "keyboard.h"
 #include "keyd.h"
 #include "descriptor.h"
@@ -254,24 +255,46 @@ static void kbd_swap_layer(struct keyboard *kbd,
 	}
 }
 
-#include <time.h>
-
 static void kbd_execute_macro(struct keyboard *kbd, struct macro *macro)
 {
 	size_t i;
+	int hold_start = -1;
 
 	for (i = 0; i < macro->sz; i++) {
-		struct macro_entry *ent = &macro->entries[i]; 
+		struct macro_entry *ent = &macro->entries[i];
+
+		switch (ent->type) {
+		case MACRO_HOLD:
+			if (hold_start == -1) {
+				hold_start = i;
+				set_mods(0);
+			}
 
-		if (ent->type == MACRO_KEYSEQUENCE) {
+			send_key(ent->data.sequence.code, 1);
+
+			break;
+		case MACRO_RELEASE:
+			if (hold_start != -1) {
+				size_t j;
+
+				for (j = hold_start; j < i; j++) {
+					struct macro_entry *ent = &macro->entries[j];
+					send_key(ent->data.sequence.code, 0);
+				}
+			}
+			break;
+		case MACRO_KEYSEQUENCE:
 			set_mods(ent->data.sequence.mods);
 
 			send_key(ent->data.sequence.code, 1);
 			send_key(ent->data.sequence.code, 0);
-		} else
+			break;
+		case MACRO_TIMEOUT:
 			usleep(ent->data.timeout*1E3);
-	}
+			break;
+		}
 
+	}
 	kbd_reify_mods(kbd);
 }
 
@@ -295,7 +318,6 @@ long kbd_process_key_event(struct keyboard *kbd,
 			   uint16_t code,
 			   int pressed)
 {
-	int i;
 	const struct descriptor *d;
 	const struct layer *dl;
 	static int oneshot_latch = 0;
@@ -320,7 +342,7 @@ long kbd_process_key_event(struct keyboard *kbd,
 	if (pending_overload) {
 		struct layer *layer = pending_overload->args[0].layer;
 		const struct key_sequence *sequence = &pending_overload->args[1].sequence;
-		size_t timeout = pending_overload->args[2].timeout;
+		long timeout = pending_overload->args[2].timeout;
 
 		if ((get_time() - overload_ts) >= timeout) {
 			kbd_activate_layer(kbd, layer, 0);