diff --git a/docs/labwc-actions.5.scd b/docs/labwc-actions.5.scd
index fe468cd1..a70c0086 100644
--- a/docs/labwc-actions.5.scd
+++ b/docs/labwc-actions.5.scd
@@ -436,6 +436,10 @@ Actions are used in menus and keyboard/mouse bindings.
If used as the only action for a binding: clear an earlier defined
binding.
+**
+ Toggle visibility of key-state on-screen display (OSD). Note: This is for
+ debugging purposes only.
+
# CONDITIONAL ACTIONS
Actions that execute other actions. Used in keyboard/mouse bindings.
diff --git a/include/input/key-state.h b/include/input/key-state.h
index d9971b74..81374b6c 100644
--- a/include/input/key-state.h
+++ b/include/input/key-state.h
@@ -5,12 +5,17 @@
#include
#include
+struct seat;
+
/*
* All keycodes in these functions are (Linux) libinput evdev scancodes which is
* what 'wlr_keyboard' uses (e.g. 'seat->keyboard_group->keyboard->keycodes').
* Note: These keycodes are different to XKB scancodes by a value of 8.
*/
+void key_state_indicator_update(struct seat *seat);
+void key_state_indicator_toggle(void);
+
/**
* key_state_pressed_sent_keycodes - generate array of pressed+sent keys
* Note: The array is generated by subtracting any bound keys from _all_ pressed
diff --git a/src/action.c b/src/action.c
index 66fa9b20..2cfa6be6 100644
--- a/src/action.c
+++ b/src/action.c
@@ -21,6 +21,7 @@
#include "cycle.h"
#include "debug.h"
#include "input/keyboard.h"
+#include "input/key-state.h"
#include "labwc.h"
#include "magnifier.h"
#include "menu/menu.h"
@@ -133,7 +134,8 @@ struct action_arg_list {
X(ZOOM_IN, "ZoomIn") \
X(ZOOM_OUT, "ZoomOut") \
X(WARP_CURSOR, "WarpCursor") \
- X(HIDE_CURSOR, "HideCursor")
+ X(HIDE_CURSOR, "HideCursor") \
+ X(DEBUG_TOGGLE_KEY_STATE_INDICATOR, "DebugToggleKeyStateIndicator")
/*
* Will expand to:
@@ -1570,6 +1572,9 @@ run_action(struct view *view, struct action *action,
case ACTION_TYPE_HIDE_CURSOR:
cursor_set_visible(&server.seat, false);
break;
+ case ACTION_TYPE_DEBUG_TOGGLE_KEY_STATE_INDICATOR:
+ key_state_indicator_toggle();
+ break;
case ACTION_TYPE_INVALID:
wlr_log(WLR_ERROR, "Not executing unknown action");
break;
diff --git a/src/input/key-state.c b/src/input/key-state.c
index 492f7b0f..5b7d2b4e 100644
--- a/src/input/key-state.c
+++ b/src/input/key-state.c
@@ -4,10 +4,172 @@
#include
#include
#include
+#include
+#include
+#include
+#include "config/rcxml.h"
+#include "common/buf.h"
#include "common/set.h"
+#include "input/keyboard.h"
+#include "labwc.h"
+#include "scaled-buffer/scaled-font-buffer.h"
static struct lab_set pressed, bound, pressed_sent;
+static bool show_debug_indicator;
+static struct indicator_state {
+ struct wlr_scene_tree *tree;
+ struct scaled_font_buffer *sfb_pressed;
+ struct scaled_font_buffer *sfb_bound;
+ struct scaled_font_buffer *sfb_pressed_sent;
+ struct scaled_font_buffer *sfb_modifiers;
+ struct xkb_keymap *keymap;
+} indicator_state;
+
+static const char *
+keycode_to_keyname(struct xkb_keymap *keymap, uint32_t keycode)
+{
+ const xkb_keysym_t *syms;
+ int syms_len = xkb_keymap_key_get_syms_by_level(keymap, keycode + 8, 0, 0, &syms);
+ if (!syms_len) {
+ return NULL;
+ }
+
+ static char buf[256];
+ if (!xkb_keysym_get_name(syms[0], buf, sizeof(buf))) {
+ return NULL;
+ }
+
+ return buf;
+}
+
+static const char *
+modifier_to_name(uint32_t modifier)
+{
+ switch (modifier) {
+ case WLR_MODIFIER_SHIFT:
+ return "S";
+ case WLR_MODIFIER_CAPS:
+ return "caps";
+ case WLR_MODIFIER_CTRL:
+ return "C";
+ case WLR_MODIFIER_ALT:
+ return "A";
+ case WLR_MODIFIER_MOD2:
+ return "mod2";
+ case WLR_MODIFIER_MOD3:
+ return "H";
+ case WLR_MODIFIER_LOGO:
+ return "W";
+ case WLR_MODIFIER_MOD5:
+ return "M";
+ default:
+ return "?";
+ }
+}
+
+static void
+init_indicator(struct indicator_state *state)
+{
+ state->tree = wlr_scene_tree_create(&server.scene->tree);
+ wlr_scene_node_set_enabled(&state->tree->node, false);
+
+ state->sfb_pressed = scaled_font_buffer_create(state->tree);
+ wlr_scene_node_set_position(&state->sfb_pressed->scene_buffer->node, 0, 0);
+ state->sfb_bound = scaled_font_buffer_create(state->tree);
+ wlr_scene_node_set_position(&state->sfb_bound->scene_buffer->node, 0, 20);
+ state->sfb_pressed_sent = scaled_font_buffer_create(state->tree);
+ wlr_scene_node_set_position(&state->sfb_pressed_sent->scene_buffer->node, 0, 40);
+ state->sfb_modifiers = scaled_font_buffer_create(state->tree);
+ wlr_scene_node_set_position(&state->sfb_modifiers->scene_buffer->node, 0, 60);
+
+ struct xkb_rule_names rules = { 0 };
+ struct xkb_context *context = xkb_context_new(XKB_CONTEXT_NO_FLAGS);
+ state->keymap = xkb_map_new_from_names(context, &rules, XKB_KEYMAP_COMPILE_NO_FLAGS);
+}
+
+static void
+update_key_indicator_callback(void *data)
+{
+ struct seat *seat = data;
+ uint32_t all_modifiers = keyboard_get_all_modifiers(seat);
+ float black[4] = {0, 0, 0, 1};
+ float white[4] = {1, 1, 1, 1};
+
+ if (!indicator_state.tree) {
+ init_indicator(&indicator_state);
+ }
+
+ if (show_debug_indicator) {
+ wlr_scene_node_set_enabled(&indicator_state.tree->node, true);
+ } else {
+ wlr_scene_node_set_enabled(&indicator_state.tree->node, false);
+ return;
+ }
+
+ struct buf buf = BUF_INIT;
+
+ buf_reset(&buf);
+ buf_add_fmt(&buf, "pressed=");
+ for (int i = 0; i < pressed.size; i++) {
+ const char *keyname = keycode_to_keyname(indicator_state.keymap,
+ pressed.values[i]);
+ buf_add_fmt(&buf, "%s (%d), ", keyname, pressed.values[i]);
+ }
+ scaled_font_buffer_update(indicator_state.sfb_pressed, buf.data,
+ -1, &rc.font_osd, black, white);
+
+ buf_reset(&buf);
+ buf_add_fmt(&buf, "bound=");
+ for (int i = 0; i < bound.size; i++) {
+ const char *keyname = keycode_to_keyname(indicator_state.keymap,
+ bound.values[i]);
+ buf_add_fmt(&buf, "%s (%d), ", keyname, bound.values[i]);
+ }
+ scaled_font_buffer_update(indicator_state.sfb_bound, buf.data,
+ -1, &rc.font_osd, black, white);
+
+ buf_reset(&buf);
+ buf_add_fmt(&buf, "pressed_sent=");
+ for (int i = 0; i < pressed_sent.size; i++) {
+ const char *keyname = keycode_to_keyname(indicator_state.keymap,
+ pressed_sent.values[i]);
+ buf_add_fmt(&buf, "%s (%d), ", keyname, pressed_sent.values[i]);
+ }
+ scaled_font_buffer_update(indicator_state.sfb_pressed_sent, buf.data, -1,
+ &rc.font_osd, black, white);
+
+ buf_reset(&buf);
+ buf_add_fmt(&buf, "modifiers=");
+ for (int i = 0; i <= 7; i++) {
+ uint32_t mod = 1 << i;
+ if (all_modifiers & mod) {
+ buf_add_fmt(&buf, "%s, ", modifier_to_name(mod));
+ }
+ }
+ buf_add_fmt(&buf, "(%d)", all_modifiers);
+ scaled_font_buffer_update(indicator_state.sfb_modifiers, buf.data, -1,
+ &rc.font_osd, black, white);
+
+ buf_reset(&buf);
+}
+
+void
+key_state_indicator_update(struct seat *seat)
+{
+ if (!show_debug_indicator) {
+ return;
+ }
+ wl_event_loop_add_idle(server.wl_event_loop,
+ update_key_indicator_callback, seat);
+}
+
+void
+key_state_indicator_toggle(void)
+{
+ show_debug_indicator = !show_debug_indicator;
+}
+
static void
report(struct lab_set *key_set, const char *msg)
{
diff --git a/src/input/keyboard.c b/src/input/keyboard.c
index 2d4bde6e..9d8e840d 100644
--- a/src/input/keyboard.c
+++ b/src/input/keyboard.c
@@ -139,6 +139,8 @@ handle_modifiers(struct wl_listener *listener, void *data)
struct seat *seat = keyboard->base.seat;
struct wlr_keyboard *wlr_keyboard = keyboard->wlr_keyboard;
+ key_state_indicator_update(seat);
+
if (server.input_mode == LAB_INPUT_STATE_MOVE) {
/* Any change to the modifier state re-enable region snap */
seat->region_prevent_snap = false;
@@ -622,6 +624,9 @@ handle_key(struct wl_listener *listener, void *data)
struct seat *seat = keyboard->base.seat;
struct wlr_keyboard_key_event *event = data;
struct wlr_seat *wlr_seat = seat->wlr_seat;
+
+ key_state_indicator_update(seat);
+
idle_manager_notify_activity(seat->wlr_seat);
/* any new press/release cancels current keybind repeat */