Merge pull request #1024 from GrantMoyer/keyboard_state

Keyboard state module

.github/workflows/freebsd.yml

@@ -15,8 +15,9 @@ jobs:
           export CPPFLAGS=-isystem/usr/local/include LDFLAGS=-L/usr/local/lib # sndio
           sed -i '' 's/quarterly/latest/' /etc/pkg/FreeBSD.conf
           pkg install -y git #  subprojects/date
-          pkg install -y gtk-layer-shell gtkmm30 jsoncpp libdbusmenu sndio \
+          pkg install -y evdev-proto gtk-layer-shell gtkmm30 jsoncpp libdbusmenu \
-               libfmt libmpdclient libudev-devd meson pkgconf pulseaudio scdoc spdlog
+            libevdev libfmt libmpdclient libudev-devd meson pkgconf pulseaudio \
+            scdoc sndio spdlog
         run: |
           meson build -Dman-pages=enabled
           ninja -C build

README.md

@@ -68,6 +68,7 @@ libappindicator-gtk3 [Tray module]
 libdbusmenu-gtk3 [Tray module]
 libmpdclient [MPD module]
 libsndio [sndio module]
+libevdev [KeyboardState module]
 ```
 
 **Build dependencies**
@@ -86,6 +87,7 @@ sudo apt install \
   clang-tidy \
   gobject-introspection \
   libdbusmenu-gtk3-dev \
+  libevdev-dev \
   libfmt-dev \
   libgirepository1.0-dev \
   libgtk-3-dev \

include/factory.hpp

@@ -38,6 +38,9 @@
 #ifdef HAVE_LIBUDEV
 #include "modules/backlight.hpp"
 #endif
+#ifdef HAVE_LIBEVDEV
+#include "modules/keyboard_state.hpp"
+#endif
 #ifdef HAVE_LIBPULSE
 #include "modules/pulseaudio.hpp"
 #endif

include/modules/keyboard_state.hpp

@@ -0,0 +1,47 @@
+#pragma once
+
+#include <fmt/format.h>
+#if FMT_VERSION < 60000
+#include <fmt/time.h>
+#else
+#include <fmt/chrono.h>
+#endif
+#include "AModule.hpp"
+#include "bar.hpp"
+#include "util/sleeper_thread.hpp"
+#include <gtkmm/label.h>
+
+extern "C" {
+#include <libevdev/libevdev.h>
+}
+
+namespace waybar::modules {
+
+class KeyboardState : public AModule {
+ public:
+  KeyboardState(const std::string&, const waybar::Bar&, const Json::Value&);
+  ~KeyboardState();
+  auto update() -> void;
+
+ private:
+  static auto openDevice(const std::string&) -> std::pair<int, libevdev*>;
+
+  Gtk::Box    box_;
+  Gtk::Label  numlock_label_;
+  Gtk::Label  capslock_label_;
+  Gtk::Label  scrolllock_label_;
+
+  std::string numlock_format_;
+  std::string capslock_format_;
+  std::string scrolllock_format_;
+  const std::chrono::seconds interval_;
+  std::string icon_locked_;
+  std::string icon_unlocked_;
+
+  int         fd_;
+  libevdev*   dev_;
+
+  util::SleeperThread thread_;
+};
+
+}  // namespace waybar::modules

man/waybar-keyboard-state.5.scd

@@ -0,0 +1,80 @@
+waybar-keyboard-state(5)
+
+# NAME
+
+waybar - keyboard-state module
+
+# DESCRIPTION
+
+The *keyboard-state* module displays the state of number lock, caps lock, and scroll lock.
+
+# CONFIGURATION
+
+*interval*: ++
+	typeof: integer ++
+	default: 1 ++
+	The interval, in seconds, to poll the keyboard state.
+
+*format*: ++
+	typeof: string|object ++
+	default: {name} {icon} ++
+	The format, how information should be displayed. If a string, the same format is used for all keyboard states. If an object, the fields "numlock", "capslock", and "scrolllock" each specify the format for the corresponding state. Any unspecified states use the default format.
+
+*format-icons*: ++
+	typeof: object ++
+	default: {"locked": "locked", "unlocked": "unlocked"} ++
+	Based on the keyboard state, the corresponding icon gets selected. The same set of icons is used for number, caps, and scroll lock, but the icon is selected from the set independently for each. See *icons*.
+
+*numlock*: ++
+	typeof: bool ++
+	default: false ++
+	Display the number lock state.
+
+*capslock*: ++
+	typeof: bool ++
+	default: false ++
+	Display the caps lock state.
+
+*scrolllock*: ++
+	typeof: bool ++
+	default: false ++
+	Display the scroll lock state.
+
+*device-path*: ++
+	typeof: string ++
+	default: chooses first valid input device ++
+	Which libevdev input device to show the state of. Libevdev devices can be found in /dev/input. The device should support number lock, caps lock, and scroll lock events.
+
+# FORMAT REPLACEMENTS
+
+*{name}*: Caps, Num, or Scroll.
+
+*{icon}*: Icon, as defined in *format-icons*.
+
+# ICONS
+
+The following *format-icons* can be set.
+
+- *locked*: Will be shown when the keyboard state is locked. Default "locked".
+- *unlocked*: Will be shown when the keyboard state is not locked. Default "unlocked"
+
+# EXAMPLE:
+
+```
+"keyboard-state": {
+    "numlock": true,
+    "capslock": true,
+    "format": "{name} {icon}",
+    "format-icons": {
+        "locked": "",
+        "unlocked": ""
+    }
+}
+```
+
+# STYLE
+
+- *#keyboard-state*
+- *#keyboard-state label*
+- *#keyboard-state label.locked*
+

man/waybar.5.scd.in

@@ -208,6 +208,7 @@ Valid options for the "rotate" property are: 0, 90, 180 and 270.
 - *waybar-custom(5)*
 - *waybar-disk(5)*
 - *waybar-idle-inhibitor(5)*
+- *waybar-keyboard-state(5)*
 - *waybar-memory(5)*
 - *waybar-mpd(5)*
 - *waybar-network(5)*

meson.build

@@ -94,6 +94,7 @@ libnl = dependency('libnl-3.0', required: get_option('libnl'))
 libnlgen = dependency('libnl-genl-3.0', required: get_option('libnl'))
 libpulse = dependency('libpulse', required: get_option('pulseaudio'))
 libudev = dependency('libudev', required: get_option('libudev'))
+libevdev = dependency('libevdev', required: get_option('libevdev'))
 libmpdclient = dependency('libmpdclient', required: get_option('mpd'))
 xkbregistry = dependency('xkbregistry')
 
@@ -216,6 +217,11 @@ if libudev.found() and (is_linux or libepoll.found())
     src_files += 'src/modules/backlight.cpp'
 endif
 
+if libevdev.found() and (is_linux or libepoll.found())
+    add_project_arguments('-DHAVE_LIBEVDEV', language: 'cpp')
+    src_files += 'src/modules/keyboard_state.cpp'
+endif
+
 if libmpdclient.found()
     add_project_arguments('-DHAVE_LIBMPDCLIENT', language: 'cpp')
     src_files += 'src/modules/mpd/mpd.cpp'
@@ -271,6 +277,7 @@ executable(
         libudev,
         libepoll,
         libmpdclient,
+        libevdev,
         gtk_layer_shell,
         libsndio,
         tz_dep,
@@ -312,6 +319,7 @@ if scdoc.found()
         'waybar-custom.5.scd',
         'waybar-disk.5.scd',
         'waybar-idle-inhibitor.5.scd',
+        'waybar-keyboard-state.5.scd',
         'waybar-memory.5.scd',
         'waybar-mpd.5.scd',
         'waybar-network.5.scd',

meson_options.txt

@@ -1,6 +1,7 @@
 option('libcxx', type : 'boolean', value : false, description : 'Build with Clang\'s libc++ instead of libstdc++ on Linux.')
 option('libnl', type: 'feature', value: 'auto', description: 'Enable libnl support for network related features')
 option('libudev', type: 'feature', value: 'auto', description: 'Enable libudev support for udev related features')
+option('libevdev', type: 'feature', value: 'auto', description: 'Enable libevdev support for evdev related features')
 option('pulseaudio', type: 'feature', value: 'auto', description: 'Enable support for pulseaudio')
 option('systemd', type: 'feature', value: 'auto', description: 'Install systemd user service unit')
 option('dbusmenu-gtk', type: 'feature', value: 'auto', description: 'Enable support for tray')

resources/config

@@ -6,7 +6,7 @@
     // Choose the order of the modules
     "modules-left": ["sway/workspaces", "sway/mode", "custom/media"],
     "modules-center": ["sway/window"],
-    "modules-right": ["mpd", "idle_inhibitor", "pulseaudio", "network", "cpu", "memory", "temperature", "backlight", "sway/language", "battery", "battery#bat2", "clock", "tray"],
+    "modules-right": ["mpd", "idle_inhibitor", "pulseaudio", "network", "cpu", "memory", "temperature", "backlight", "keyboard-state", "sway/language", "battery", "battery#bat2", "clock", "tray"],
     // Modules configuration
     // "sway/workspaces": {
     //     "disable-scroll": true,
@@ -23,6 +23,15 @@
     //         "default": ""
     //     }
     // },
+    "keyboard-state": {
+        "numlock": true,
+        "capslock": true,
+        "format": "{name} {icon}",
+        "format-icons": {
+            "locked": "",
+            "unlocked": ""
+        }
+    },
     "sway/mode": {
         "format": "<span style=\"italic\">{}</span>"
     },
@@ -145,3 +154,4 @@
         // "exec": "$HOME/.config/waybar/mediaplayer.py --player spotify 2> /dev/null" // Filter player based on name
     }
 }
+

resources/style.css

@@ -237,3 +237,19 @@ label:focus {
     margin: 0 5px;
     min-width: 16px;
 }
+
+#keyboard-state {
+    background: #97e1ad;
+    color: #000000;
+    padding: 0 0px;
+    margin: 0 5px;
+    min-width: 16px;
+}
+
+#keyboard-state > label {
+    padding: 0 5px;
+}
+
+#keyboard-state > label.locked {
+    background: rgba(0, 0, 0, 0.2);
+}

src/factory.cpp

@@ -70,6 +70,11 @@ waybar::AModule* waybar::Factory::makeModule(const std::string& name) const {
       return new waybar::modules::Backlight(id, config_[name]);
     }
 #endif
+#ifdef HAVE_LIBEVDEV
+    if (ref == "keyboard-state") {
+      return new waybar::modules::KeyboardState(id, bar_, config_[name]);
+    }
+#endif
 #ifdef HAVE_LIBPULSE
     if (ref == "pulseaudio") {
       return new waybar::modules::Pulseaudio(id, config_[name]);

src/modules/keyboard_state.cpp

@@ -0,0 +1,152 @@
+#include "modules/keyboard_state.hpp"
+#include <filesystem>
+#include <spdlog/spdlog.h>
+
+extern "C" {
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+}
+
+waybar::modules::KeyboardState::KeyboardState(const std::string& id, const Bar& bar, const Json::Value& config)
+    : AModule(config, "keyboard-state", id, false, !config["disable-scroll"].asBool()),
+      box_(bar.vertical ? Gtk::ORIENTATION_VERTICAL : Gtk::ORIENTATION_HORIZONTAL, 0),
+      numlock_label_(""),
+      capslock_label_(""),
+      numlock_format_(config_["format"].isString() ? config_["format"].asString()
+                      : config_["format"]["numlock"].isString() ? config_["format"]["numlock"].asString()
+                      : "{name} {icon}"),
+      capslock_format_(config_["format"].isString() ? config_["format"].asString()
+                       : config_["format"]["capslock"].isString() ? config_["format"]["capslock"].asString()
+                       : "{name} {icon}"),
+      scrolllock_format_(config_["format"].isString() ? config_["format"].asString()
+                         : config_["format"]["scrolllock"].isString() ? config_["format"]["scrolllock"].asString()
+                         : "{name} {icon}"),
+      interval_(std::chrono::seconds(config_["interval"].isUInt() ? config_["interval"].asUInt() : 1)),
+      icon_locked_(config_["format-icons"]["locked"].isString()
+                   ? config_["format-icons"]["locked"].asString()
+                   : "locked"),
+      icon_unlocked_(config_["format-icons"]["unlocked"].isString()
+                     ? config_["format-icons"]["unlocked"].asString()
+                     : "unlocked"),
+      fd_(0),
+      dev_(nullptr) {
+  box_.set_name("keyboard-state");
+  if (config_["numlock"].asBool()) {
+    box_.pack_end(numlock_label_, false, false, 0);
+  }
+  if (config_["capslock"].asBool()) {
+    box_.pack_end(capslock_label_, false, false, 0);
+  }
+  if (config_["scrolllock"].asBool()) {
+    box_.pack_end(scrolllock_label_, false, false, 0);
+  }
+  if (!id.empty()) {
+    box_.get_style_context()->add_class(id);
+  }
+  event_box_.add(box_);
+
+  if (config_["device-path"].isString()) {
+    std::string dev_path = config_["device-path"].asString();
+    std::tie(fd_, dev_) = openDevice(dev_path);
+  } else {
+    DIR* dev_dir = opendir("/dev/input");
+    if (dev_dir == nullptr) {
+      throw std::runtime_error("Failed to open /dev/input");
+    }
+    dirent *ep;
+    while ((ep = readdir(dev_dir))) {
+      if (ep->d_type != DT_CHR) continue;
+      std::string dev_path = std::string("/dev/input/") + ep->d_name;
+      try {
+        std::tie(fd_, dev_) = openDevice(dev_path);
+        spdlog::info("Found device {} at '{}'", libevdev_get_name(dev_),  dev_path);
+        break;
+      } catch (const std::runtime_error& e) {
+        continue;
+      }
+    }
+    if (dev_ == nullptr) {
+      throw std::runtime_error("Failed to find keyboard device");
+    }
+  }
+
+  thread_ = [this] {
+    dp.emit();
+    thread_.sleep_for(interval_);
+  };
+}
+
+waybar::modules::KeyboardState::~KeyboardState() {
+  libevdev_free(dev_);
+  int err = close(fd_);
+  if (err < 0) {
+    // Not much we can do, so ignore it.
+  }
+}
+
+auto waybar::modules::KeyboardState::openDevice(const std::string& path) -> std::pair<int, libevdev*> {
+    int fd = open(path.c_str(), O_NONBLOCK | O_CLOEXEC | O_RDONLY);
+    if (fd < 0) {
+      throw std::runtime_error("Can't open " + path);
+    }
+
+    libevdev* dev;
+    int err = libevdev_new_from_fd(fd, &dev);
+    if (err < 0) {
+      throw std::runtime_error("Can't create libevdev device");
+    }
+    if (!libevdev_has_event_type(dev, EV_LED)) {
+      throw std::runtime_error("Device doesn't support LED events");
+    }
+    if (!libevdev_has_event_code(dev, EV_LED, LED_NUML)
+        || !libevdev_has_event_code(dev, EV_LED, LED_CAPSL)
+        || !libevdev_has_event_code(dev, EV_LED, LED_SCROLLL)) {
+      throw std::runtime_error("Device doesn't support num lock, caps lock, or scroll lock events");
+    }
+
+    return std::make_pair(fd, dev);
+}
+
+auto waybar::modules::KeyboardState::update() -> void {
+  int err = LIBEVDEV_READ_STATUS_SUCCESS;
+  while (err == LIBEVDEV_READ_STATUS_SUCCESS) {
+    input_event ev;
+    err = libevdev_next_event(dev_, LIBEVDEV_READ_FLAG_NORMAL, &ev);
+    while (err == LIBEVDEV_READ_STATUS_SYNC) {
+      err = libevdev_next_event(dev_, LIBEVDEV_READ_FLAG_SYNC, &ev);
+    }
+  }
+  if (err != -EAGAIN) {
+    throw std::runtime_error("Failed to sync evdev device");
+  }
+
+  int numl = libevdev_get_event_value(dev_, EV_LED, LED_NUML);
+  int capsl = libevdev_get_event_value(dev_, EV_LED, LED_CAPSL);
+  int scrolll = libevdev_get_event_value(dev_, EV_LED, LED_SCROLLL);
+
+  struct {
+    bool state;
+    Gtk::Label& label;
+    const std::string& format;
+    const char* name;
+  } label_states[] = {
+    {(bool) numl, numlock_label_, numlock_format_, "Num"},
+    {(bool) capsl, capslock_label_, capslock_format_, "Caps"},
+    {(bool) scrolll, scrolllock_label_, scrolllock_format_, "Scroll"},
+  };
+  for (auto& label_state : label_states) {
+    std::string text;
+    text = fmt::format(label_state.format,
+                       fmt::arg("icon", label_state.state ? icon_locked_ : icon_unlocked_),
+                       fmt::arg("name", label_state.name));
+    label_state.label.set_markup(text);
+    if (label_state.state) {
+      label_state.label.get_style_context()->add_class("locked");
+    } else {
+      label_state.label.get_style_context()->remove_class("locked");
+    }
+  }
+
+  AModule::update();
+}