From ad3f46214d791b98364dd95719ee49c9446f20a5 Mon Sep 17 00:00:00 2001
From: John Fredriksson <94405030+jfred9@users.noreply.github.com>
Date: Mon, 15 Nov 2021 21:23:36 +0100
Subject: [PATCH] river/tags: Add possibility for mouse clicks
Left mouse click - set-focused-tags
Right mouse click - toggle-focused-tags
---
include/modules/river/tags.hpp | 6 ++
man/waybar-river-tags.5.scd | 5 ++
protocol/meson.build | 1 +
protocol/river-control-unstable-v1.xml | 85 ++++++++++++++++++++++++++
src/modules/river/tags.cpp | 72 +++++++++++++++++++++-
5 files changed, 168 insertions(+), 1 deletion(-)
create mode 100644 protocol/river-control-unstable-v1.xml
diff --git a/include/modules/river/tags.hpp b/include/modules/river/tags.hpp
index 9b75fbd3..c49ec60d 100644
--- a/include/modules/river/tags.hpp
+++ b/include/modules/river/tags.hpp
@@ -6,6 +6,7 @@
#include "AModule.hpp"
#include "bar.hpp"
#include "river-status-unstable-v1-client-protocol.h"
+#include "river-control-unstable-v1-client-protocol.h"
#include "xdg-output-unstable-v1-client-protocol.h"
namespace waybar::modules::river {
@@ -20,7 +21,12 @@ class Tags : public waybar::AModule {
void handle_view_tags(struct wl_array *tags);
void handle_urgent_tags(uint32_t tags);
+ void handle_primary_clicked(uint32_t tag);
+ bool handle_button_press(GdkEventButton *event_button, uint32_t tag);
+
struct zriver_status_manager_v1 *status_manager_;
+ struct zriver_control_v1 *control_;
+ struct wl_seat *seat_;
private:
const waybar::Bar & bar_;
diff --git a/man/waybar-river-tags.5.scd b/man/waybar-river-tags.5.scd
index 65b90332..7814ee49 100644
--- a/man/waybar-river-tags.5.scd
+++ b/man/waybar-river-tags.5.scd
@@ -21,6 +21,11 @@ Addressed by *river/tags*
typeof: array ++
The label to display for each tag.
+*disable-click*: ++
+ typeof: bool ++
+ default: false ++
+ If set to false, you can left click to set focused tag. Right click to toggle tag focus. If set to true this behaviour is disabled.
+
# EXAMPLE
```
diff --git a/protocol/meson.build b/protocol/meson.build
index 07d524ae..ea988efc 100644
--- a/protocol/meson.build
+++ b/protocol/meson.build
@@ -28,6 +28,7 @@ client_protocols = [
['wlr-layer-shell-unstable-v1.xml'],
['wlr-foreign-toplevel-management-unstable-v1.xml'],
['river-status-unstable-v1.xml'],
+ ['river-control-unstable-v1.xml'],
]
client_protos_src = []
diff --git a/protocol/river-control-unstable-v1.xml b/protocol/river-control-unstable-v1.xml
new file mode 100644
index 00000000..b8faa45c
--- /dev/null
+++ b/protocol/river-control-unstable-v1.xml
@@ -0,0 +1,85 @@
+
+
+
+ Copyright 2020 The River Developers
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+
+
+
+ This interface allows clients to run compositor commands and receive a
+ success/failure response with output or a failure message respectively.
+
+ Each command is built up in a series of add_argument requests and
+ executed with a run_command request. The first argument is the command
+ to be run.
+
+ A complete list of commands should be made available in the man page of
+ the compositor.
+
+
+
+
+ This request indicates that the client will not use the
+ river_control object any more. Objects that have been created
+ through this instance are not affected.
+
+
+
+
+
+ Arguments are stored by the server in the order they were sent until
+ the run_command request is made.
+
+
+
+
+
+
+ Execute the command built up using the add_argument request for the
+ given seat.
+
+
+
+
+
+
+
+
+ This object is created by the run_command request. Exactly one of the
+ success or failure events will be sent. This object will be destroyed
+ by the compositor after one of the events is sent.
+
+
+
+
+ Sent when the command has been successfully received and executed by
+ the compositor. Some commands may produce output, in which case the
+ output argument will be a non-empty string.
+
+
+
+
+
+
+ Sent when the command could not be carried out. This could be due to
+ sending a non-existent command, no command, not enough arguments, too
+ many arguments, invalid arguments, etc.
+
+
+
+
+
diff --git a/src/modules/river/tags.cpp b/src/modules/river/tags.cpp
index 2628af2d..87655beb 100644
--- a/src/modules/river/tags.cpp
+++ b/src/modules/river/tags.cpp
@@ -7,7 +7,6 @@
#include "client.hpp"
#include "modules/river/tags.hpp"
-#include "river-status-unstable-v1-client-protocol.h"
#include "xdg-output-unstable-v1-client-protocol.h"
namespace waybar::modules::river {
@@ -33,6 +32,23 @@ static const zriver_output_status_v1_listener output_status_listener_impl{
.urgent_tags = listen_urgent_tags,
};
+static void listen_command_success(void *data,
+ struct zriver_command_callback_v1 *zriver_command_callback_v1,
+ const char *output) {
+ // Do nothing but keep listener to avoid crashing when command was successful
+}
+
+static void listen_command_failure(void *data,
+ struct zriver_command_callback_v1 *zriver_command_callback_v1,
+ const char *output) {
+ spdlog::error("failure when selecting/toggling tags {}", output);
+}
+
+static const zriver_command_callback_v1_listener command_callback_listener_impl {
+ .success = listen_command_success,
+ .failure = listen_command_failure,
+};
+
static void handle_global(void *data, struct wl_registry *registry, uint32_t name,
const char *interface, uint32_t version) {
if (std::strcmp(interface, zriver_status_manager_v1_interface.name) == 0) {
@@ -43,18 +59,33 @@ static void handle_global(void *data, struct wl_registry *registry, uint32_t nam
static_cast(data)->status_manager_ = static_cast(
wl_registry_bind(registry, name, &zriver_status_manager_v1_interface, version));
}
+
+ if (std::strcmp(interface, zriver_control_v1_interface.name) == 0) {
+ version = std::min(version, 1);
+ static_cast(data)->control_ = static_cast(
+ wl_registry_bind(registry, name, &zriver_control_v1_interface, version));
+ }
+
+ if (std::strcmp(interface, wl_seat_interface.name) == 0) {
+ version = std::min(version, 1);
+ static_cast(data)->seat_ = static_cast(
+ wl_registry_bind(registry, name, &wl_seat_interface, version));
+ }
}
static void handle_global_remove(void *data, struct wl_registry *registry, uint32_t name) {
/* Ignore event */
}
+
static const wl_registry_listener registry_listener_impl = {.global = handle_global,
.global_remove = handle_global_remove};
Tags::Tags(const std::string &id, const waybar::Bar &bar, const Json::Value &config)
: waybar::AModule(config, "tags", id, false, false),
status_manager_{nullptr},
+ control_{nullptr},
+ seat_{nullptr},
bar_(bar),
box_{bar.vertical ? Gtk::ORIENTATION_VERTICAL : Gtk::ORIENTATION_HORIZONTAL, 0},
output_status_{nullptr} {
@@ -68,6 +99,14 @@ Tags::Tags(const std::string &id, const waybar::Bar &bar, const Json::Value &con
return;
}
+ if (!control_) {
+ spdlog::error("river_control_v1 not advertised");
+ }
+
+ if (!seat_) {
+ spdlog::error("wl_seat not advertised");
+ }
+
box_.set_name("tags");
if (!id.empty()) {
box_.get_style_context()->add_class(id);
@@ -89,11 +128,17 @@ Tags::Tags(const std::string &id, const waybar::Bar &bar, const Json::Value &con
}
}
+ uint32_t i = 1;
for (const auto &tag_label : tag_labels) {
Gtk::Button &button = buttons_.emplace_back(tag_label);
button.set_relief(Gtk::RELIEF_NONE);
box_.pack_start(button, false, false, 0);
+ if (!config_["disable-click"].asBool()) {
+ button.signal_clicked().connect(sigc::bind(sigc::mem_fun(*this, &Tags::handle_primary_clicked), i));
+ button.signal_button_press_event().connect(sigc::bind(sigc::mem_fun(*this, &Tags::handle_button_press), i));
+ }
button.show();
+ i <<= 1;
}
struct wl_output *output = gdk_wayland_monitor_get_wl_output(bar_.output->monitor->gobj());
@@ -107,6 +152,31 @@ Tags::~Tags() {
if (output_status_) {
zriver_output_status_v1_destroy(output_status_);
}
+
+ if (control_) {
+ zriver_control_v1_destroy(control_);
+ }
+}
+
+void Tags::handle_primary_clicked(uint32_t tag) {
+ // Send river command to select tag on left mouse click
+ zriver_command_callback_v1 *callback;
+ zriver_control_v1_add_argument(control_, "set-focused-tags");
+ zriver_control_v1_add_argument(control_, std::to_string(tag).c_str());
+ callback = zriver_control_v1_run_command(control_, seat_);
+ zriver_command_callback_v1_add_listener(callback, &command_callback_listener_impl, nullptr);
+}
+
+bool Tags::handle_button_press(GdkEventButton *event_button, uint32_t tag) {
+ if (event_button->type == GDK_BUTTON_PRESS && event_button->button == 3) {
+ // Send river command to toggle tag on right mouse click
+ zriver_command_callback_v1 *callback;
+ zriver_control_v1_add_argument(control_, "toggle-focused-tags");
+ zriver_control_v1_add_argument(control_, std::to_string(tag).c_str());
+ callback = zriver_control_v1_run_command(control_, seat_);
+ zriver_command_callback_v1_add_listener(callback, &command_callback_listener_impl, nullptr);
+ }
+ return true;
}
void Tags::handle_focused_tags(uint32_t tags) {