swaylock: Add caps lock state to indicator

Implements customization for the indicator as proposed in #2788 with comments from #3367 in mind.
The default behaviour does not change exept for the caps lock text color.

4 files changed, 171 insertions, 39 deletions

diff --git a/include/swaylock/swaylock.h b/include/swaylock/swaylock.h
index 18af7ab4..516a56f4 100644
--- a/include/swaylock/swaylock.h
+++ b/include/swaylock/swaylock.h
@@ -22,6 +22,7 @@ enum auth_state {
 struct swaylock_colorset {
 	uint32_t input;
 	uint32_t cleared;
+	uint32_t caps_lock;
 	uint32_t verifying;
 	uint32_t wrong;
 };
@@ -30,6 +31,8 @@ struct swaylock_colors {
 	uint32_t background;
 	uint32_t bs_highlight;
 	uint32_t key_highlight;
+	uint32_t caps_lock_bs_highlight;
+	uint32_t caps_lock_key_highlight;
 	uint32_t separator;
 	struct swaylock_colorset inside;
 	struct swaylock_colorset line;
@@ -45,6 +48,8 @@ struct swaylock_args {
 	uint32_t thickness;
 	bool ignore_empty;
 	bool show_indicator;
+	bool show_caps_lock_text;
+	bool show_caps_lock_indicator;
 	bool daemonize;
 };
 
diff --git a/swaylock/main.c b/swaylock/main.c
index 9a4f3b58..0b167da1 100644
--- a/swaylock/main.c
+++ b/swaylock/main.c
@@ -396,28 +396,34 @@ static void set_default_colors(struct swaylock_colors *colors) {
 	colors->background = 0xFFFFFFFF;
 	colors->bs_highlight = 0xDB3300FF;
 	colors->key_highlight = 0x33DB00FF;
+	colors->caps_lock_bs_highlight = 0xDB3300FF;
+	colors->caps_lock_key_highlight = 0x33DB00FF;
 	colors->separator = 0x000000FF;
 	colors->inside = (struct swaylock_colorset){
 		.input = 0x000000C0,
 		.cleared = 0xE5A445C0,
+		.caps_lock = 0x000000C0,
 		.verifying = 0x0072FFC0,
 		.wrong = 0xFA0000C0,
 	};
 	colors->line = (struct swaylock_colorset){
 		.input = 0x000000FF,
 		.cleared = 0x000000FF,
+		.caps_lock = 0x000000FF,
 		.verifying = 0x000000FF,
 		.wrong = 0x000000FF,
 	};
 	colors->ring = (struct swaylock_colorset){
 		.input = 0x337D00FF,
 		.cleared = 0xE5A445FF,
+		.caps_lock = 0xE5A445FF,
 		.verifying = 0x3300FFFF,
 		.wrong = 0x7D3300FF,
 	};
 	colors->text = (struct swaylock_colorset){
 		.input = 0xE5A445FF,
 		.cleared = 0x000000FF,
+		.caps_lock = 0xE5A445FF,
 		.verifying = 0x000000FF,
 		.wrong = 0x000000FF,
 	};
@@ -433,25 +439,31 @@ static int parse_options(int argc, char **argv, struct swaylock_state *state,
 		enum line_mode *line_mode, char **config_path) {
 	enum long_option_codes {
 		LO_BS_HL_COLOR = 256,
+		LO_CAPS_LOCK_BS_HL_COLOR,
+		LO_CAPS_LOCK_KEY_HL_COLOR,
 		LO_FONT,
 		LO_IND_RADIUS,
 		LO_IND_THICKNESS,
 		LO_INSIDE_COLOR,
 		LO_INSIDE_CLEAR_COLOR,
+		LO_INSIDE_CAPS_LOCK_COLOR,
 		LO_INSIDE_VER_COLOR,
 		LO_INSIDE_WRONG_COLOR,
 		LO_KEY_HL_COLOR,
 		LO_LINE_COLOR,
 		LO_LINE_CLEAR_COLOR,
+		LO_LINE_CAPS_LOCK_COLOR,
 		LO_LINE_VER_COLOR,
 		LO_LINE_WRONG_COLOR,
 		LO_RING_COLOR,
 		LO_RING_CLEAR_COLOR,
+		LO_RING_CAPS_LOCK_COLOR,
 		LO_RING_VER_COLOR,
 		LO_RING_WRONG_COLOR,
 		LO_SEP_COLOR,
 		LO_TEXT_COLOR,
 		LO_TEXT_CLEAR_COLOR,
+		LO_TEXT_CAPS_LOCK_COLOR,
 		LO_TEXT_VER_COLOR,
 		LO_TEXT_WRONG_COLOR,
 	};
@@ -463,6 +475,8 @@ static int parse_options(int argc, char **argv, struct swaylock_state *state,
 		{"daemonize", no_argument, NULL, 'f'},
 		{"help", no_argument, NULL, 'h'},
 		{"image", required_argument, NULL, 'i'},
+		{"disable-caps-lock-text", no_argument, NULL, 'L'},
+		{"indicator-caps-lock", no_argument, NULL, 'l'},
 		{"line-uses-inside", no_argument, NULL, 'n'},
 		{"socket", required_argument, NULL, 'p'},
 		{"line-uses-ring", no_argument, NULL, 'r'},
@@ -471,25 +485,31 @@ static int parse_options(int argc, char **argv, struct swaylock_state *state,
 		{"no-unlock-indicator", no_argument, NULL, 'u'},
 		{"version", no_argument, NULL, 'v'},
 		{"bs-hl-color", required_argument, NULL, LO_BS_HL_COLOR},
+		{"caps-lock-bs-hl-color", required_argument, NULL, LO_CAPS_LOCK_BS_HL_COLOR},
+		{"caps-lock-key-hl-color", required_argument, NULL, LO_CAPS_LOCK_KEY_HL_COLOR},
 		{"font", required_argument, NULL, LO_FONT},
 		{"indicator-radius", required_argument, NULL, LO_IND_RADIUS},
 		{"indicator-thickness", required_argument, NULL, LO_IND_THICKNESS},
 		{"inside-color", required_argument, NULL, LO_INSIDE_COLOR},
 		{"inside-clear-color", required_argument, NULL, LO_INSIDE_CLEAR_COLOR},
+		{"inside-caps-lock-color", required_argument, NULL, LO_INSIDE_CAPS_LOCK_COLOR},
 		{"inside-ver-color", required_argument, NULL, LO_INSIDE_VER_COLOR},
 		{"inside-wrong-color", required_argument, NULL, LO_INSIDE_WRONG_COLOR},
 		{"key-hl-color", required_argument, NULL, LO_KEY_HL_COLOR},
 		{"line-color", required_argument, NULL, LO_LINE_COLOR},
 		{"line-clear-color", required_argument, NULL, LO_LINE_CLEAR_COLOR},
+		{"line-caps-lock-color", required_argument, NULL, LO_LINE_CAPS_LOCK_COLOR},
 		{"line-ver-color", required_argument, NULL, LO_LINE_VER_COLOR},
 		{"line-wrong-color", required_argument, NULL, LO_LINE_WRONG_COLOR},
 		{"ring-color", required_argument, NULL, LO_RING_COLOR},
 		{"ring-clear-color", required_argument, NULL, LO_RING_CLEAR_COLOR},
+		{"ring-caps-lock-color", required_argument, NULL, LO_RING_CAPS_LOCK_COLOR},
 		{"ring-ver-color", required_argument, NULL, LO_RING_VER_COLOR},
 		{"ring-wrong-color", required_argument, NULL, LO_RING_WRONG_COLOR},
 		{"separator-color", required_argument, NULL, LO_SEP_COLOR},
 		{"text-color", required_argument, NULL, LO_TEXT_COLOR},
 		{"text-clear-color", required_argument, NULL, LO_TEXT_CLEAR_COLOR},
+		{"text-caps-lock-color", required_argument, NULL, LO_TEXT_CAPS_LOCK_COLOR},
 		{"text-ver-color", required_argument, NULL, LO_TEXT_VER_COLOR},
 		{"text-wrong-color", required_argument, NULL, LO_TEXT_WRONG_COLOR},
 		{0, 0, 0, 0}
@@ -498,76 +518,97 @@ static int parse_options(int argc, char **argv, struct swaylock_state *state,
 	const char usage[] =
 		"Usage: swaylock [options...]\n"
 		"\n"
-		"  -C, --config <config_file>     "
+		"  -C, --config <config_file>       "
 			"Path to the config file.\n"
-		"  -c, --color <color>            "
+		"  -c, --color <color>              "
 			"Turn the screen into the given color instead of white.\n"
-		"  -e, --ignore-empty-password    "
+		"  -e, --ignore-empty-password      "
 			"When an empty password is provided, do not validate it.\n"
-		"  -f, --daemonize                "
+		"  -f, --daemonize                  "
 			"Detach from the controlling terminal after locking.\n"
-		"  -h, --help                     "
+		"  -h, --help                       "
 			"Show help message and quit.\n"
-		"  -i, --image [<output>:]<path>  "
+		"  -i, --image [<output>:]<path>    "
 			"Display the given image.\n"
-		"  -s, --scaling <mode>           "
+		"  -L, --disable-caps-lock-text     "
+			"Disable the Caps Lock text.\n"
+		"  -l, --indicator-caps-lock        "
+			"Show the current Caps Lock state also on the indicator.\n"
+		"  -s, --scaling <mode>             "
 			"Scaling mode: stretch, fill, fit, center, tile.\n"
-		"  -t, --tiling                   "
+		"  -t, --tiling                     "
 			"Same as --scaling=tile.\n"
-		"  -u, --no-unlock-indicator      "
+		"  -u, --no-unlock-indicator        "
 			"Disable the unlock indicator.\n"
-		"  -v, --version                  "
+		"  -v, --version                    "
 			"Show the version number and quit.\n"
-		"  --bs-hl-color <color>          "
+		"  --bs-hl-color <color>            "
 			"Sets the color of backspace highlight segments.\n"
-		"  --font <font>                  "
+		"  --caps-lock-bs-hl-color <color>  "
+			"Sets the color of backspace highlight segments when Caps Lock "
+			"is active.\n"
+		"  --caps-lock-key-hl-color <color> "
+			"Sets the color of the key press highlight segments when "
+			"Caps Lock is active.\n"
+		"  --font <font>                    "
 			"Sets the font of the text.\n"
-		"  --indicator-radius <radius>    "
+		"  --indicator-radius <radius>      "
 			"Sets the indicator radius.\n"
-		"  --indicator-thickness <thick>  "
+		"  --indicator-thickness <thick>    "
 			"Sets the indicator thickness.\n"
-		"  --inside-color <color>         "
+		"  --inside-color <color>           "
 			"Sets the color of the inside of the indicator.\n"
-		"  --inside-clear-color <color>   "
+		"  --inside-clear-color <color>     "
 			"Sets the color of the inside of the indicator when cleared.\n"
-		"  --inside-ver-color <color>     "
+		"  --inside-caps-lock-color <color> "
+			"Sets the color of the inside of the indicator when Caps Lock "
+			"is active.\n"
+		"  --inside-ver-color <color>       "
 			"Sets the color of the inside of the indicator when verifying.\n"
-		"  --inside-wrong-color <color>   "
+		"  --inside-wrong-color <color>     "
 			"Sets the color of the inside of the indicator when invalid.\n"
-		"  --key-hl-color <color>         "
+		"  --key-hl-color <color>           "
 			"Sets the color of the key press highlight segments.\n"
-		"  --line-color <color>           "
+		"  --line-color <color>             "
 			"Sets the color of the line between the inside and ring.\n"
-		"  --line-clear-color <color>     "
+		"  --line-clear-color <color>       "
 			"Sets the color of the line between the inside and ring when "
 			"cleared.\n"
-		"  --line-ver-color <color>       "
+		"  --line-caps-lock-color <color>   "
+			"Sets the color of the line between the inside and ring when "
+			"Caps Lock is active.\n"
+		"  --line-ver-color <color>         "
 			"Sets the color of the line between the inside and ring when "
 			"verifying.\n"
-		"  --line-wrong-color <color>     "
+		"  --line-wrong-color <color>       "
 			"Sets the color of the line between the inside and ring when "
 			"invalid.\n"
-		"  -n, --line-uses-inside         "
+		"  -n, --line-uses-inside           "
 			"Use the inside color for the line between the inside and ring.\n"
-		"  -r, --line-uses-ring           "
+		"  -r, --line-uses-ring             "
 			"Use the ring color for the line between the inside and ring.\n"
-		"  --ring-color <color>           "
+		"  --ring-color <color>             "
 			"Sets the color of the ring of the indicator.\n"
-		"  --ring-clear-color <color>     "
+		"  --ring-clear-color <color>       "
 			"Sets the color of the ring of the indicator when cleared.\n"
-		"  --ring-ver-color <color>       "
+		"  --ring-caps-lock-color <color>   "
+			"Sets the color of the ring of the indicator when Caps Lock "
+			"is active.\n"
+		"  --ring-ver-color <color>         "
 			"Sets the color of the ring of the indicator when verifying.\n"
-		"  --ring-wrong-color <color>     "
+		"  --ring-wrong-color <color>       "
 			"Sets the color of the ring of the indicator when invalid.\n"
-		"  --separator-color <color>      "
+		"  --separator-color <color>        "
 			"Sets the color of the lines that separate highlight segments.\n"
-		"  --text-color <color>           "
+		"  --text-color <color>             "
 			"Sets the color of the text.\n"
-		"  --text-clear-color <color>     "
+		"  --text-clear-color <color>       "
 			"Sets the color of the text when cleared.\n"
-		"  --text-ver-color <color>       "
+		"  --text-caps-lock-color <color>   "
+			"Sets the color of the text when Caps Lock is active.\n"
+		"  --text-ver-color <color>         "
 			"Sets the color of the text when verifying.\n"
-		"  --text-wrong-color <color>     "
+		"  --text-wrong-color <color>       "
 			"Sets the color of the text when invalid.\n"
 		"\n"
 		"All <color> options are of the form <rrggbb[aa]>.\n";
@@ -576,7 +617,7 @@ static int parse_options(int argc, char **argv, struct swaylock_state *state,
 	optind = 1;
 	while (1) {
 		int opt_idx = 0;
-		c = getopt_long(argc, argv, "c:efhi:nrs:tuvC:", long_options, &opt_idx);
+		c = getopt_long(argc, argv, "c:efhi:Llnrs:tuvC:", long_options, &opt_idx);
 		if (c == -1) {
 			break;
 		}
@@ -607,6 +648,16 @@ static int parse_options(int argc, char **argv, struct swaylock_state *state,
 				load_image(optarg, state);
 			}
 			break;
+		case 'L':
+			if (state) {
+				state->args.show_caps_lock_text = false;
+			}
+			break;
+		case 'l':
+			if (state) {
+				state->args.show_caps_lock_indicator = true;
+			}
+			break;
 		case 'n':
 			if (line_mode) {
 				*line_mode = LM_INSIDE;
@@ -644,6 +695,16 @@ static int parse_options(int argc, char **argv, struct swaylock_state *state,
 				state->args.colors.bs_highlight = parse_color(optarg);
 			}
 			break;
+		case LO_CAPS_LOCK_BS_HL_COLOR:
+			if (state) {
+				state->args.colors.caps_lock_bs_highlight = parse_color(optarg);
+			}
+			break;
+		case LO_CAPS_LOCK_KEY_HL_COLOR:
+			if (state) {
+				state->args.colors.caps_lock_key_highlight = parse_color(optarg);
+			}
+			break;
 		case LO_FONT:
 			if (state) {
 				free(state->args.font);
@@ -670,6 +731,11 @@ static int parse_options(int argc, char **argv, struct swaylock_state *state,
 				state->args.colors.inside.cleared = parse_color(optarg);
 			}
 			break;
+		case LO_INSIDE_CAPS_LOCK_COLOR:
+			if (state) {
+				state->args.colors.inside.caps_lock = parse_color(optarg);
+			}
+			break;
 		case LO_INSIDE_VER_COLOR:
 			if (state) {
 				state->args.colors.inside.verifying = parse_color(optarg);
@@ -695,6 +761,11 @@ static int parse_options(int argc, char **argv, struct swaylock_state *state,
 				state->args.colors.line.cleared = parse_color(optarg);
 			}
 			break;
+		case LO_LINE_CAPS_LOCK_COLOR:
+			if (state) {
+				state->args.colors.line.caps_lock = parse_color(optarg);
+			}
+			break;
 		case LO_LINE_VER_COLOR:
 			if (state) {
 				state->args.colors.line.verifying = parse_color(optarg);
@@ -715,6 +786,11 @@ static int parse_options(int argc, char **argv, struct swaylock_state *state,
 				state->args.colors.ring.cleared = parse_color(optarg);
 			}
 			break;
+		case LO_RING_CAPS_LOCK_COLOR:
+			if (state) {
+				state->args.colors.ring.caps_lock = parse_color(optarg);
+			}
+			break;
 		case LO_RING_VER_COLOR:
 			if (state) {
 				state->args.colors.ring.verifying = parse_color(optarg);
@@ -740,6 +816,11 @@ static int parse_options(int argc, char **argv, struct swaylock_state *state,
 				state->args.colors.text.cleared = parse_color(optarg);
 			}
 			break;
+		case LO_TEXT_CAPS_LOCK_COLOR:
+			if (state) {
+				state->args.colors.text.caps_lock = parse_color(optarg);
+			}
+			break;
 		case LO_TEXT_VER_COLOR:
 			if (state) {
 				state->args.colors.text.verifying = parse_color(optarg);
@@ -857,6 +938,8 @@ int main(int argc, char **argv) {
 		.thickness = 10,
 		.ignore_empty = false,
 		.show_indicator = true,
+		.show_caps_lock_indicator = false,
+		.show_caps_lock_text = true
 	};
 	wl_list_init(&state.images);
 	set_default_colors(&state.args.colors);
diff --git a/swaylock/render.c b/swaylock/render.c
index cbd5d01d..5aedaad5 100644
--- a/swaylock/render.c
+++ b/swaylock/render.c
@@ -18,7 +18,17 @@ static void set_color_for_state(cairo_t *cairo, struct swaylock_state *state,
 	} else if (state->auth_state == AUTH_STATE_CLEAR) {
 		cairo_set_source_u32(cairo, colorset->cleared);
 	} else {
-		cairo_set_source_u32(cairo, colorset->input);
+		if (state->xkb.caps_lock && state->args.show_caps_lock_indicator) {
+			cairo_set_source_u32(cairo, colorset->caps_lock);
+		} else if (state->xkb.caps_lock && !state->args.show_caps_lock_indicator &&
+				state->args.show_caps_lock_text) {
+			uint32_t inputtextcolor = state->args.colors.text.input;
+			state->args.colors.text.input = state->args.colors.text.caps_lock;
+			cairo_set_source_u32(cairo, colorset->input);
+			state->args.colors.text.input = inputtextcolor;
+		} else {
+			cairo_set_source_u32(cairo, colorset->input);
+		}
 	}
 }
 
@@ -92,7 +102,8 @@ void render_frame(struct swaylock_surface *surface) {
 			break;
 		case AUTH_STATE_INPUT:
 		case AUTH_STATE_INPUT_NOP:
-			if (state->xkb.caps_lock) {
+		case AUTH_STATE_BACKSPACE:
+			if (state->xkb.caps_lock && state->args.show_caps_lock_text) {
 				text = "Caps Lock";
 			}
 			break;
@@ -125,9 +136,17 @@ void render_frame(struct swaylock_surface *surface) {
 					arc_radius, highlight_start,
 					highlight_start + TYPE_INDICATOR_RANGE);
 			if (state->auth_state == AUTH_STATE_INPUT) {
-				cairo_set_source_u32(cairo, state->args.colors.key_highlight);
+				if (state->xkb.caps_lock && state->args.show_caps_lock_indicator) {
+					cairo_set_source_u32(cairo, state->args.colors.caps_lock_key_highlight);
+				} else {
+					cairo_set_source_u32(cairo, state->args.colors.key_highlight);
+				}
 			} else {
-				cairo_set_source_u32(cairo, state->args.colors.bs_highlight);
+				if (state->xkb.caps_lock && state->args.show_caps_lock_indicator) {
+					cairo_set_source_u32(cairo, state->args.colors.caps_lock_bs_highlight);
+				} else {
+					cairo_set_source_u32(cairo, state->args.colors.bs_highlight);
+				}
 			}
 			cairo_stroke(cairo);
 
diff --git a/swaylock/swaylock.1.scd b/swaylock/swaylock.1.scd
index 9f39a913..2c7979be 100644
--- a/swaylock/swaylock.1.scd
+++ b/swaylock/swaylock.1.scd
@@ -44,6 +44,12 @@ Locks your Wayland session.
 	Display the given image, optionally only on the given output. Use -c to set
 	a background color.
 
+*-L, --disable-caps-lock-text*
+	Disable the Caps Lock Text.
+
+*-l, --indicator-caps-lock*
+	Show the current Caps Lock state also on the indicator.
+
 *-s, --scaling*
 	Scaling mode for images: _stretch_, _fill_, _fit_, _center_, or _tile_.
 
@@ -58,6 +64,12 @@ Locks your Wayland session.
 *--bs-hl-color* <rrggbb[aa]>
 	Sets the color of backspace highlight segments.
 
+*--caps-lock-bs-hl-color* <rrggbb[aa]>
+	Sets the color of backspace highlight segments when Caps Lock is active.
+
+*--caps-lock-bs-hl-color* <rrggbb[aa]>
+	Sets the color of the key press highlight segments when Caps Lock is active.
+
 *--font* <font>
 	Sets the font of the text inside the indicator.
 
@@ -75,6 +87,9 @@ Locks your Wayland session.
 *--inside-clear-color* <rrggbb[aa]>
 	Sets the color of the inside of the indicator when cleared.
 
+*--inside-caps-lock-color* <rrggbb[aa]>
+	Sets the color of the inside of the indicator when Caps Lock is active.
+
 *--inside-ver-color* <rrggbb[aa]>
 	Sets the color of the inside of the indicator when verifying.
 
@@ -92,6 +107,10 @@ Locks your Wayland session.
 	Sets the color of the lines that separate the inside and outside of the
 	indicator when cleared.
 
+*--line-caps-lock-color* <rrggbb[aa]>
+	Sets the color of the line between the inside and ring when Caps Lock
+	is active.
+
 *--line-ver-color* <rrggbb[aa]>
 	Sets the color of the lines that separate the inside and outside of the
 	indicator when verifying.
@@ -114,6 +133,9 @@ Locks your Wayland session.
 *--ring-clear-color* <rrggbb[aa]>
 	Sets the color of the outside of the indicator when cleared.
 
+*--ring-caps-lock-color* <rrggbb[aa]>
+	Sets the color of the ring of the indicator when Caps Lock is active.
+
 *--ring-ver-color* <rrggbb[aa]>
 	Sets the color of the outside of the indicator when verifying.
 
@@ -129,6 +151,9 @@ Locks your Wayland session.
 *--text-clear-color* <rrggbb[aa]>
 	Sets the color of the text inside the indicator when cleared.
 
+*--text-caps-lock-color* <rrggbb[aa]>
+	Sets the color of the text when Caps Lock is active.
+
 *--text-ver-color* <rrggbb[aa]>
 	Sets the color of the text inside the indicator when verifying.