Zander671/Waybar
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

wlr/workspaces: port to ext-workspace-v1

Browse Source 
Rework implementation to match new protocol behavior.
This commit is contained in:
Jens Peters
2025-04-11 08:00:35 +02:00
parent 8516d457ad
commit 255c0ebe28
8 changed files with 585 additions and 964 deletions
Download Patch File Download Diff File Expand all files Collapse all files

214
include/modules/wlr/workspace_manager.hpp
View File

@ -5,168 +5,140 @@
#include <gtkmm/image.h> #include <gtkmm/image.h>
#include <gtkmm/label.h> #include <gtkmm/label.h>
#include <functional>
#include <map> #include <map>
#include <memory> #include <memory>
#include <vector> #include <vector>
#include "AModule.hpp" #include "AModule.hpp"
#include "bar.hpp" #include "bar.hpp"
#include "ext-workspace-unstable-v1-client-protocol.h" #include "ext-workspace-v1-client-protocol.h"
namespace waybar::modules::wlr { namespace waybar::modules::wlr {
class WorkspaceManager;
class WorkspaceGroup; class WorkspaceGroup;
class Workspace;
class Workspace { class WorkspaceManager final : public AModule {
public: public:
Workspace(const waybar::Bar &bar, const Json::Value &config, WorkspaceGroup &workspace_group, WorkspaceManager(const std::string &id, const waybar::Bar &bar, const Json::Value &config);
zext_workspace_handle_v1 *workspace, uint32_t id, std::string name); ~WorkspaceManager() override;
~Workspace(); void register_manager(wl_registry *registry, uint32_t name, uint32_t version);
auto update() -> void; void remove_workspace_group(uint32_t id);
void remove_workspace(uint32_t id);
void set_needs_sorting() { needs_sorting_ = true; }
auto id() const -> uint32_t { return id_; } // wlr events
auto is_active() const -> bool { return state_ & static_cast<uint32_t>(State::ACTIVE); } void handle_workspace_group(ext_workspace_group_handle_v1 *handle);
auto is_urgent() const -> bool { return state_ & static_cast<uint32_t>(State::URGENT); } void handle_workspace(ext_workspace_handle_v1 *handle);
auto is_hidden() const -> bool { return state_ & static_cast<uint32_t>(State::HIDDEN); } void handle_done();
auto is_empty() const -> bool { return state_ & static_cast<uint32_t>(State::EMPTY); } void handle_finished();
auto is_persistent() const -> bool { return persistent_; }
// wlr stuff
auto handle_name(const std::string &name) -> void;
auto handle_coordinates(const std::vector<uint32_t> &coordinates) -> void;
auto handle_state(const std::vector<uint32_t> &state) -> void;
auto handle_remove() -> void;
auto make_persistent() -> void;
auto handle_duplicate() -> void;
auto handle_done() -> void; // wlr requests
auto handle_clicked(GdkEventButton *bt) -> bool; void commit() const;
auto show() -> void;
auto hide() -> void;
auto get_button_ref() -> Gtk::Button & { return button_; }
auto get_name() -> std::string & { return name_; }
auto get_coords() -> std::vector<uint32_t> & { return coordinates_; }
enum class State {
ACTIVE = (1 << 0),
URGENT = (1 << 1),
HIDDEN = (1 << 2),
EMPTY = (1 << 3),
};
private: private:
auto get_icon() -> std::string; void update() override;
bool has_button(const Gtk::Button *button);
void sort_workspaces();
void clear_buttons();
void update_buttons();
const Bar &bar_; static uint32_t group_global_id;
const Json::Value &config_; static uint32_t workspace_global_id;
WorkspaceGroup &workspace_group_; uint32_t workspace_name = 0;
// wlr stuff bool sort_by_id_ = false;
zext_workspace_handle_v1 *workspace_handle_; bool sort_by_name_ = true;
uint32_t state_ = 0; bool sort_by_coordinates_ = false;
bool active_only_ = false;
bool all_outputs_ = false;
uint32_t id_; const waybar::Bar &bar_;
std::string name_; Gtk::Box box_;
std::vector<uint32_t> coordinates_;
static std::map<std::string, std::string> icons_map_;
std::string format_;
bool with_icon_ = false;
bool persistent_ = false;
Gtk::Button button_; ext_workspace_manager_v1 *ext_manager_ = nullptr;
Gtk::Box content_; std::vector<std::unique_ptr<WorkspaceGroup>> groups_;
Gtk::Label label_; std::vector<std::unique_ptr<Workspace>> workspaces_;
bool needs_sorting_ = false;
}; };
class WorkspaceGroup { class WorkspaceGroup {
public: public:
WorkspaceGroup(const waybar::Bar &bar, Gtk::Box &box, const Json::Value &config, WorkspaceGroup(WorkspaceManager &manager, ext_workspace_group_handle_v1 *handle, uint32_t id);
WorkspaceManager &manager, zext_workspace_group_handle_v1 *workspace_group_handle,
uint32_t id);
~WorkspaceGroup(); ~WorkspaceGroup();
auto update() -> void;
auto id() const -> uint32_t { return id_; } u_int32_t id() const { return id_; }
auto is_visible() const -> bool; bool has_output(const wl_output *output);
auto remove_workspace(uint32_t id_) -> void; bool has_workspace(const ext_workspace_handle_v1 *workspace);
auto active_only() const -> bool;
auto creation_delayed() const -> bool;
auto workspaces() -> std::vector<std::unique_ptr<Workspace>> & { return workspaces_; }
auto persistent_workspaces() -> std::vector<std::string> & { return persistent_workspaces_; }
auto sort_workspaces() -> void; // wlr events
auto set_need_to_sort() -> void { need_to_sort = true; } void handle_capabilities(uint32_t capabilities);
auto add_button(Gtk::Button &button) -> void; void handle_output_enter(wl_output *output);
auto remove_button(Gtk::Button &button) -> void; void handle_output_leave(wl_output *output);
auto fill_persistent_workspaces() -> void; void handle_workspace_enter(ext_workspace_handle_v1 *handle);
auto create_persistent_workspaces() -> void; void handle_workspace_leave(ext_workspace_handle_v1 *handle);
void handle_removed();
// wlr stuff
auto handle_workspace_create(zext_workspace_handle_v1 *workspace_handle) -> void;
auto handle_remove() -> void;
auto handle_output_enter(wl_output *output) -> void;
auto handle_output_leave() -> void;
auto handle_done() -> void;
auto commit() -> void;
private: private:
static uint32_t workspace_global_id; WorkspaceManager &workspaces_manager_;
const waybar::Bar &bar_; ext_workspace_group_handle_v1 *ext_handle_;
Gtk::Box &box_;
const Json::Value &config_;
WorkspaceManager &workspace_manager_;
// wlr stuff
zext_workspace_group_handle_v1 *workspace_group_handle_;
wl_output *output_ = nullptr;
uint32_t id_; uint32_t id_;
std::vector<std::unique_ptr<Workspace>> workspaces_; std::vector<wl_output *> outputs_;
bool need_to_sort = false; std::vector<ext_workspace_handle_v1 *> workspaces_;
std::vector<std::string> persistent_workspaces_;
bool persistent_created_ = false;
}; };
class WorkspaceManager : public AModule { class Workspace {
public: public:
WorkspaceManager(const std::string &id, const waybar::Bar &bar, const Json::Value &config); Workspace(const Json::Value &config, WorkspaceManager &manager, ext_workspace_handle_v1 *handle,
~WorkspaceManager() override; uint32_t id, const std::string &name);
auto update() -> void override; ~Workspace();
auto all_outputs() const -> bool { return all_outputs_; } ext_workspace_handle_v1 *handle() const { return ext_handle_; }
auto active_only() const -> bool { return active_only_; } u_int32_t id() const { return id_; }
auto workspace_comparator() const std::string &workspace_id() { return workspace_id_; }
-> std::function<bool(std::unique_ptr<Workspace> &, std::unique_ptr<Workspace> &)>; std::string &name() { return name_; }
auto creation_delayed() const -> bool { return creation_delayed_; } std::vector<u_int32_t> &coordinates() { return coordinates_; }
Gtk::Button &button() { return button_; }
bool is_active() const;
bool is_urgent() const;
bool is_hidden() const;
void update();
auto sort_workspaces() -> void; // wlr events
auto remove_workspace_group(uint32_t id_) -> void; void handle_id(const std::string &id);
void handle_name(const std::string &name);
void handle_coordinates(const std::vector<uint32_t> &coordinates);
void handle_state(uint32_t state);
void handle_capabilities(uint32_t capabilities);
void handle_removed();
// wlr stuff // gdk events
auto register_manager(wl_registry *registry, uint32_t name, uint32_t version) -> void; bool handle_clicked(const GdkEventButton *button) const;
auto handle_workspace_group_create(zext_workspace_group_handle_v1 *workspace_group_handle)
-> void;
auto handle_done() -> void;
auto handle_finished() -> void;
auto commit() -> void;
private: private:
const waybar::Bar &bar_; std::string icon();
Gtk::Box box_;
std::vector<std::unique_ptr<WorkspaceGroup>> groups_;
// wlr stuff WorkspaceManager &workspace_manager_;
zext_workspace_manager_v1 *workspace_manager_ = nullptr; ext_workspace_handle_v1 *ext_handle_ = nullptr;
uint32_t id_;
uint32_t state_ = 0;
std::string workspace_id_;
std::string name_;
std::vector<uint32_t> coordinates_;
static uint32_t group_global_id; std::string format_;
bool with_icon_ = false;
static std::map<std::string, std::string> icon_map_;
std::string on_click_action_;
std::string on_click_middle_action_;
std::string on_click_right_action_;
bool sort_by_name_ = true; Gtk::Button button_;
bool sort_by_coordinates_ = true; Gtk::Box content_;
bool sort_by_number_ = false; Gtk::Label label_;
bool all_outputs_ = false;
bool active_only_ = false; bool needs_updating_ = false;
bool creation_delayed_ = false;
}; };
} // namespace waybar::modules::wlr } // namespace waybar::modules::wlr

10
include/modules/wlr/workspace_manager_binding.hpp
View File

@ -1,10 +1,10 @@
#include "ext-workspace-unstable-v1-client-protocol.h" #include "ext-workspace-v1-client-protocol.h"
namespace waybar::modules::wlr { namespace waybar::modules::wlr {
void add_registry_listener(void *data); void add_registry_listener(void *data);
void add_workspace_listener(zext_workspace_handle_v1 *workspace_handle, void *data); void add_workspace_listener(ext_workspace_handle_v1 *workspace_handle, void *data);
void add_workspace_group_listener(zext_workspace_group_handle_v1 *workspace_group_handle, void add_workspace_group_listener(ext_workspace_group_handle_v1 *workspace_group_handle,
void *data); void *data);
zext_workspace_manager_v1 *workspace_manager_bind(wl_registry *registry, uint32_t name, ext_workspace_manager_v1 *workspace_manager_bind(wl_registry *registry, uint32_t name,
uint32_t version, void *data); uint32_t version, void *data);
} // namespace waybar::modules::wlr } // namespace waybar::modules::wlr

24
man/waybar-wlr-workspaces.5.scd
View File

@ -24,18 +24,18 @@ Addressed by *wlr/workspaces*
*sort-by-name*: ++ *sort-by-name*: ++
typeof: bool ++ typeof: bool ++
default: true ++ default: true ++
Should workspaces be sorted by name. Should workspaces be sorted by name. Workspace names will be sorted numerically when all names are numbers.
*sort-by-coordinates*: ++ *sort-by-coordinates*: ++
typeof: bool ++ typeof: bool ++
default: true ++ default: false ++
Should workspaces be sorted by coordinates. ++ Should workspaces be sorted by coordinates. ++
Note that if both *sort-by-name* and *sort-by-coordinates* are true sort-by name will be first. If both are false - sort by id will be performed. Note that if both *sort-by-name* and *sort-by-coordinates* are true sort-by name will be first. If both are false - sort by id will be performed.
*sort-by-number*: ++ *sort-by-id*: ++
typeof: bool ++ typeof: bool ++
default: false ++ default: false ++
If set to true, workspace names will be sorted numerically. Takes precedence over any other sort-by option. Should workspaces be sorted by ID. Workspace ID will be sorted numerically when all ID are numbers. Takes precedence over any other sort-by option.
*all-outputs*: ++ *all-outputs*: ++
typeof: bool ++ typeof: bool ++
@ -49,7 +49,9 @@ Addressed by *wlr/workspaces*
# FORMAT REPLACEMENTS # FORMAT REPLACEMENTS
*{name}*: Name of workspace assigned by compositor *{name}*: Name of workspace assigned by compositor.
*{id}*: ID of workspace assigned by compositor.
*{icon}*: Icon, as defined in *format-icons*. *{icon}*: Icon, as defined in *format-icons*.
@ -71,16 +73,16 @@ In addition to workspace name matching, the following *format-icons* can be set.
``` ```
"wlr/workspaces": { "wlr/workspaces": {
"format": "{name}: {icon}", "format": "{name}: {icon}",
"on-click": "activate",
"format-icons": { "format-icons": {
"1": "", "Workspace 1": "",
"2": "", "Workspace 2": "",
"3": "", "Workspace 3": "",
"4": "", "Workspace 4": "",
"5": "",
"active": "", "active": "",
"default": "" "default": ""
}, },
"sort-by-number": true "sort-by-id": true
} }
``` ```

22
meson.build
View File

@ -276,6 +276,17 @@ if true
man_files += files('man/waybar-wlr-taskbar.5.scd') man_files += files('man/waybar-wlr-taskbar.5.scd')
endif endif
if wayland_protos.version().version_compare('>=1.39')
add_project_arguments('-DHAVE_WLR_WORKSPACES', language: 'cpp')
src_files += files(
'src/modules/wlr/workspace_manager.cpp',
'src/modules/wlr/workspace_manager_binding.cpp',
)
man_files += files(
'man/waybar-wlr-workspaces.5.scd',
)
endif
if true if true
add_project_arguments('-DHAVE_RIVER', language: 'cpp') add_project_arguments('-DHAVE_RIVER', language: 'cpp')
src_files += files( src_files += files(
@ -485,17 +496,6 @@ else
man_files += files('man/waybar-clock.5.scd') man_files += files('man/waybar-clock.5.scd')
endif endif
if get_option('experimental')
add_project_arguments('-DHAVE_WLR_WORKSPACES', language: 'cpp')
src_files += files(
'src/modules/wlr/workspace_manager.cpp',
'src/modules/wlr/workspace_manager_binding.cpp',
)
man_files += files(
'man/waybar-wlr-workspaces.5.scd',
)
endif
cava = dependency('cava', cava = dependency('cava',
version : '>=0.10.4', version : '>=0.10.4',
required: get_option('cava'), required: get_option('cava'),

306
protocol/ext-workspace-unstable-v1.xml
View File

@ -1,306 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<protocol name="ext_workspace_unstable_v1">
<copyright>
Copyright © 2019 Christopher Billington
Copyright © 2020 Ilia Bozhinov
Permission to use, copy, modify, distribute, and sell this
software and its documentation for any purpose is hereby granted
without fee, provided that the above copyright notice appear in
all copies and that both that copyright notice and this permission
notice appear in supporting documentation, and that the name of
the copyright holders not be used in advertising or publicity
pertaining to distribution of the software without specific,
written prior permission. The copyright holders make no
representations about the suitability of this software for any
purpose. It is provided "as is" without express or implied
warranty.
THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
SPECIAL, 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.
</copyright>
<interface name="zext_workspace_manager_v1" version="1">
<description summary="list and control workspaces">
Workspaces, also called virtual desktops, are groups of surfaces. A
compositor with a concept of workspaces may only show some such groups of
surfaces (those of 'active' workspaces) at a time. 'Activating' a
workspace is a request for the compositor to display that workspace's
surfaces as normal, whereas the compositor may hide or otherwise
de-emphasise surfaces that are associated only with 'inactive' workspaces.
Workspaces are grouped by which sets of outputs they correspond to, and
may contain surfaces only from those outputs. In this way, it is possible
for each output to have its own set of workspaces, or for all outputs (or
any other arbitrary grouping) to share workspaces. Compositors may
optionally conceptually arrange each group of workspaces in an
N-dimensional grid.
The purpose of this protocol is to enable the creation of taskbars and
docks by providing them with a list of workspaces and their properties,
and allowing them to activate and deactivate workspaces.
After a client binds the zext_workspace_manager_v1, each workspace will be
sent via the workspace event.
</description>
<event name="workspace_group">
<description summary="a workspace group has been created">
This event is emitted whenever a new workspace group has been created.
All initial details of the workspace group (workspaces, outputs) will be
sent immediately after this event via the corresponding events in
zext_workspace_group_handle_v1.
</description>
<arg name="workspace_group" type="new_id" interface="zext_workspace_group_handle_v1"/>
</event>
<request name="commit">
<description summary="all requests about the workspaces have been sent">
The client must send this request after it has finished sending other
requests. The compositor must process a series of requests preceding a
commit request atomically.
This allows changes to the workspace properties to be seen as atomic,
even if they happen via multiple events, and even if they involve
multiple zext_workspace_handle_v1 objects, for example, deactivating one
workspace and activating another.
</description>
</request>
<event name="done">
<description summary="all information about the workspace groups has been sent">
This event is sent after all changes in all workspace groups have been
sent.
This allows changes to one or more zext_workspace_group_handle_v1
properties to be seen as atomic, even if they happen via multiple
events. In particular, an output moving from one workspace group to
another sends an output_enter event and an output_leave event to the two
zext_workspace_group_handle_v1 objects in question. The compositor sends
the done event only after updating the output information in both
workspace groups.
</description>
</event>
<event name="finished">
<description summary="the compositor has finished with the workspace_manager">
This event indicates that the compositor is done sending events to the
zext_workspace_manager_v1. The server will destroy the object
immediately after sending this request, so it will become invalid and
the client should free any resources associated with it.
</description>
</event>
<request name="stop">
<description summary="stop sending events">
Indicates the client no longer wishes to receive events for new
workspace groups. However the compositor may emit further workspace
events, until the finished event is emitted.
The client must not send any more requests after this one.
</description>
</request>
</interface>
<interface name="zext_workspace_group_handle_v1" version="1">
<description summary="a workspace group assigned to a set of outputs">
A zext_workspace_group_handle_v1 object represents a a workspace group
that is assigned a set of outputs and contains a number of workspaces.
The set of outputs assigned to the workspace group is conveyed to the client via
output_enter and output_leave events, and its workspaces are conveyed with
workspace events.
For example, a compositor which has a set of workspaces for each output may
advertise a workspace group (and its workspaces) per output, whereas a compositor
where a workspace spans all outputs may advertise a single workspace group for all
outputs.
</description>
<event name="output_enter">
<description summary="output assigned to workspace group">
This event is emitted whenever an output is assigned to the workspace
group.
</description>
<arg name="output" type="object" interface="wl_output"/>
</event>
<event name="output_leave">
<description summary="output removed from workspace group">
This event is emitted whenever an output is removed from the workspace
group.
</description>
<arg name="output" type="object" interface="wl_output"/>
</event>
<event name="workspace">
<description summary="workspace added to workspace group">
This event is emitted whenever a new workspace has been created.
All initial details of the workspace (name, coordinates, state) will
be sent immediately after this event via the corresponding events in
zext_workspace_handle_v1.
</description>
<arg name="workspace" type="new_id" interface="zext_workspace_handle_v1"/>
</event>
<event name="remove">
<description summary="this workspace group has been destroyed">
This event means the zext_workspace_group_handle_v1 has been destroyed.
It is guaranteed there won't be any more events for this
zext_workspace_group_handle_v1. The zext_workspace_group_handle_v1 becomes
inert so any requests will be ignored except the destroy request.
The compositor must remove all workspaces belonging to a workspace group
before removing the workspace group.
</description>
</event>
<request name="create_workspace">
<description summary="create a new workspace">
Request that the compositor create a new workspace with the given name.
There is no guarantee that the compositor will create a new workspace,
or that the created workspace will have the provided name.
</description>
<arg name="workspace" type="string"/>
</request>
<request name="destroy" type="destructor">
<description summary="destroy the zext_workspace_handle_v1 object">
Destroys the zext_workspace_handle_v1 object.
This request should be called either when the client does not want to
use the workspace object any more or after the remove event to finalize
the destruction of the object.
</description>
</request>
</interface>
<interface name="zext_workspace_handle_v1" version="1">
<description summary="a workspace handing a group of surfaces">
A zext_workspace_handle_v1 object represents a a workspace that handles a
group of surfaces.
Each workspace has a name, conveyed to the client with the name event; a
list of states, conveyed to the client with the state event; and
optionally a set of coordinates, conveyed to the client with the
coordinates event. The client may request that the compositor activate or
deactivate the workspace.
Each workspace can belong to only a single workspace group.
Depepending on the compositor policy, there might be workspaces with
the same name in different workspace groups, but these workspaces are still
separate (e.g. one of them might be active while the other is not).
</description>
<event name="name">
<description summary="workspace name changed">
This event is emitted immediately after the zext_workspace_handle_v1 is
created and whenever the name of the workspace changes.
</description>
<arg name="name" type="string"/>
</event>
<event name="coordinates">
<description summary="workspace coordinates changed">
This event is used to organize workspaces into an N-dimensional grid
within a workspace group, and if supported, is emitted immediately after
the zext_workspace_handle_v1 is created and whenever the coordinates of
the workspace change. Compositors may not send this event if they do not
conceptually arrange workspaces in this way. If compositors simply
number workspaces, without any geometric interpretation, they may send
1D coordinates, which clients should not interpret as implying any
geometry. Sending an empty array means that the compositor no longer
orders the workspace geometrically.
Coordinates have an arbitrary number of dimensions N with an uint32
position along each dimension. By convention if N > 1, the first
dimension is X, the second Y, the third Z, and so on. The compositor may
chose to utilize these events for a more novel workspace layout
convention, however. No guarantee is made about the grid being filled or
bounded; there may be a workspace at coordinate 1 and another at
coordinate 1000 and none in between. Within a workspace group, however,
workspaces must have unique coordinates of equal dimensionality.
</description>
<arg name="coordinates" type="array"/>
</event>
<event name="state">
<description summary="the state of the workspace changed">
This event is emitted immediately after the zext_workspace_handle_v1 is
created and each time the workspace state changes, either because of a
compositor action or because of a request in this protocol.
</description>
<arg name="state" type="array"/>
</event>
<enum name="state">
<description summary="types of states on the workspace">
The different states that a workspace can have.
</description>
<entry name="active" value="0" summary="the workspace is active"/>
<entry name="urgent" value="1" summary="the workspace requests attention"/>
<entry name="hidden" value="2">
<description summary="the workspace is not visible">
The workspace is not visible in its workspace group, and clients
attempting to visualize the compositor workspace state should not
display such workspaces.
</description>
</entry>
</enum>
<event name="remove">
<description summary="this workspace has been destroyed">
This event means the zext_workspace_handle_v1 has been destroyed. It is
guaranteed there won't be any more events for this
zext_workspace_handle_v1. The zext_workspace_handle_v1 becomes inert so
any requests will be ignored except the destroy request.
</description>
</event>
<request name="destroy" type="destructor">
<description summary="destroy the zext_workspace_handle_v1 object">
Destroys the zext_workspace_handle_v1 object.
This request should be called either when the client does not want to
use the workspace object any more or after the remove event to finalize
the destruction of the object.
</description>
</request>
<request name="activate">
<description summary="activate the workspace">
Request that this workspace be activated.
There is no guarantee the workspace will be actually activated, and
behaviour may be compositor-dependent. For example, activating a
workspace may or may not deactivate all other workspaces in the same
group.
</description>
</request>
<request name="deactivate">
<description summary="activate the workspace">
Request that this workspace be deactivated.
There is no guarantee the workspace will be actually deactivated.
</description>
</request>
<request name="remove">
<description summary="remove the workspace">
Request that this workspace be removed.
There is no guarantee the workspace will be actually removed.
</description>
</request>
</interface>
</protocol>

7
protocol/meson.build
View File

@ -26,12 +26,17 @@ client_protocols = [
[wl_protocol_dir, 'unstable/xdg-output/xdg-output-unstable-v1.xml'], [wl_protocol_dir, 'unstable/xdg-output/xdg-output-unstable-v1.xml'],
[wl_protocol_dir, 'unstable/idle-inhibit/idle-inhibit-unstable-v1.xml'], [wl_protocol_dir, 'unstable/idle-inhibit/idle-inhibit-unstable-v1.xml'],
['wlr-foreign-toplevel-management-unstable-v1.xml'], ['wlr-foreign-toplevel-management-unstable-v1.xml'],
['ext-workspace-unstable-v1.xml'],
['river-status-unstable-v1.xml'], ['river-status-unstable-v1.xml'],
['river-control-unstable-v1.xml'], ['river-control-unstable-v1.xml'],
['dwl-ipc-unstable-v2.xml'], ['dwl-ipc-unstable-v2.xml'],
] ]
if wayland_protos.version().version_compare('>=1.39')
client_protocols += [
[wl_protocol_dir, 'staging/ext-workspace/ext-workspace-v1.xml']
]
endif
client_protos_src = [] client_protos_src = []
client_protos_headers = [] client_protos_headers = []

859
src/modules/wlr/workspace_manager.cpp
View File

@ -5,8 +5,7 @@
#include <spdlog/spdlog.h> #include <spdlog/spdlog.h>
#include <algorithm> #include <algorithm>
#include <iterator> #include <iostream>
#include <stdexcept>
#include <vector> #include <vector>
#include "client.hpp" #include "client.hpp"
@ -15,39 +14,52 @@
namespace waybar::modules::wlr { namespace waybar::modules::wlr {
uint32_t WorkspaceGroup::workspace_global_id = 0; // WorkspaceManager
uint32_t WorkspaceManager::group_global_id = 0; uint32_t WorkspaceManager::group_global_id = 0;
std::map<std::string, std::string> Workspace::icons_map_; uint32_t WorkspaceManager::workspace_global_id = 0;
std::map<std::string, std::string> Workspace::icon_map_;
WorkspaceManager::WorkspaceManager(const std::string &id, const waybar::Bar &bar, WorkspaceManager::WorkspaceManager(const std::string &id, const waybar::Bar &bar,
const Json::Value &config) const Json::Value &config)
: waybar::AModule(config, "workspaces", id, false, false), bar_(bar), box_(bar.orientation, 0) { : waybar::AModule(config, "workspaces", id, false, false), bar_(bar), box_(bar.orientation, 0) {
auto config_sort_by_name = config_["sort-by-name"]; add_registry_listener(this);
// parse configuration
const auto config_sort_by_number = config_["sort-by-number"];
if (config_sort_by_number.isBool()) {
spdlog::warn("[wlr/workspaces]: Prefer sort-by-id instead of sort-by-number");
sort_by_id_ = config_sort_by_number.asBool();
}
const auto config_sort_by_id = config_["sort-by-id"];
if (config_sort_by_id.isBool()) {
sort_by_id_ = config_sort_by_id.asBool();
}
const auto config_sort_by_name = config_["sort-by-name"];
if (config_sort_by_name.isBool()) { if (config_sort_by_name.isBool()) {
sort_by_name_ = config_sort_by_name.asBool(); sort_by_name_ = config_sort_by_name.asBool();
} }
auto config_sort_by_coordinates = config_["sort-by-coordinates"]; const auto config_sort_by_coordinates = config_["sort-by-coordinates"];
if (config_sort_by_coordinates.isBool()) { if (config_sort_by_coordinates.isBool()) {
sort_by_coordinates_ = config_sort_by_coordinates.asBool(); sort_by_coordinates_ = config_sort_by_coordinates.asBool();
} }
auto config_sort_by_number = config_["sort-by-number"]; const auto config_all_outputs = config_["all-outputs"];
if (config_sort_by_number.isBool()) {
sort_by_number_ = config_sort_by_number.asBool();
}
auto config_all_outputs = config_["all-outputs"];
if (config_all_outputs.isBool()) { if (config_all_outputs.isBool()) {
all_outputs_ = config_all_outputs.asBool(); all_outputs_ = config_all_outputs.asBool();
} }
auto config_active_only = config_["active-only"]; const auto config_active_only = config_["active-only"];
if (config_active_only.isBool()) { if (config_active_only.isBool()) {
active_only_ = config_active_only.asBool(); active_only_ = config_active_only.asBool();
creation_delayed_ = active_only_;
} }
// setup UI
box_.set_name("workspaces"); box_.set_name("workspaces");
if (!id.empty()) { if (!id.empty()) {
box_.get_style_context()->add_class(id); box_.get_style_context()->add_class(id);
@ -55,352 +67,297 @@ WorkspaceManager::WorkspaceManager(const std::string &id, const waybar::Bar &bar
box_.get_style_context()->add_class(MODULE_CLASS); box_.get_style_context()->add_class(MODULE_CLASS);
event_box_.add(box_); event_box_.add(box_);
add_registry_listener(this); spdlog::debug("[wlr/workspaces]: Workspace manager created");
if (!workspace_manager_) {
return;
}
}
auto WorkspaceManager::workspace_comparator() const
-> std::function<bool(std::unique_ptr<Workspace> &, std::unique_ptr<Workspace> &)> {
return [=, this](std::unique_ptr<Workspace> &lhs, std::unique_ptr<Workspace> &rhs) {
auto is_name_less = lhs->get_name() < rhs->get_name();
auto is_name_eq = lhs->get_name() == rhs->get_name();
auto is_coords_less = lhs->get_coords() < rhs->get_coords();
if (sort_by_number_) {
try {
auto is_number_less = std::stoi(lhs->get_name()) < std::stoi(rhs->get_name());
return is_number_less;
} catch (const std::invalid_argument &) {
}
}
if (sort_by_name_) {
if (sort_by_coordinates_) {
return is_name_eq ? is_coords_less : is_name_less;
} else {
return is_name_less;
}
}
if (sort_by_coordinates_) {
return is_coords_less;
}
return lhs->id() < rhs->id();
};
}
auto WorkspaceManager::sort_workspaces() -> void {
std::vector<std::reference_wrapper<std::unique_ptr<Workspace>>> all_workspaces;
for (auto &group : groups_) {
auto &group_workspaces = group->workspaces();
all_workspaces.reserve(all_workspaces.size() +
std::distance(group_workspaces.begin(), group_workspaces.end()));
if (!active_only()) {
all_workspaces.insert(all_workspaces.end(), group_workspaces.begin(), group_workspaces.end());
continue;
}
for (auto &workspace : group_workspaces) {
if (!workspace->is_active()) {
continue;
}
all_workspaces.push_back(workspace);
}
}
std::sort(all_workspaces.begin(), all_workspaces.end(), workspace_comparator());
for (size_t i = 0; i < all_workspaces.size(); ++i) {
box_.reorder_child(all_workspaces[i].get()->get_button_ref(), i);
}
}
auto WorkspaceManager::register_manager(wl_registry *registry, uint32_t name, uint32_t version)
-> void {
if (workspace_manager_) {
spdlog::warn("Register workspace manager again although already registered!");
return;
}
if (version != 1) {
spdlog::warn("Using different workspace manager protocol version: {}", version);
}
workspace_manager_ = workspace_manager_bind(registry, name, version, this);
}
auto WorkspaceManager::handle_workspace_group_create(
zext_workspace_group_handle_v1 *workspace_group_handle) -> void {
auto new_id = ++group_global_id;
groups_.push_back(
std::make_unique<WorkspaceGroup>(bar_, box_, config_, *this, workspace_group_handle, new_id));
spdlog::debug("Workspace group {} created", new_id);
}
auto WorkspaceManager::handle_finished() -> void {
zext_workspace_manager_v1_destroy(workspace_manager_);
workspace_manager_ = nullptr;
}
auto WorkspaceManager::handle_done() -> void {
for (auto &group : groups_) {
group->handle_done();
}
dp.emit();
}
auto WorkspaceManager::update() -> void {
for (auto &group : groups_) {
group->update();
}
if (creation_delayed()) {
creation_delayed_ = false;
sort_workspaces();
}
AModule::update();
} }
WorkspaceManager::~WorkspaceManager() { WorkspaceManager::~WorkspaceManager() {
if (!workspace_manager_) { workspaces_.clear();
return; groups_.clear();
if (ext_manager_ != nullptr) {
auto *display = Client::inst()->wl_display;
// Send `stop` request and wait for one roundtrip.
ext_workspace_manager_v1_stop(ext_manager_);
wl_display_roundtrip(display);
} }
wl_display *display = Client::inst()->wl_display; if (ext_manager_ != nullptr) {
spdlog::warn("[wlr/workspaces]: Destroying workspace manager before .finished event");
// Send `stop` request and wait for one roundtrip. This is not quite correct as ext_workspace_manager_v1_destroy(ext_manager_);
// the protocol encourages us to wait for the .finished event, but it should work
// with wlroots workspace manager implementation.
zext_workspace_manager_v1_stop(workspace_manager_);
wl_display_roundtrip(display);
// If the .finished handler is still not executed, destroy the workspace manager here.
if (workspace_manager_) {
spdlog::warn("Foreign toplevel manager destroyed before .finished event");
zext_workspace_manager_v1_destroy(workspace_manager_);
workspace_manager_ = nullptr;
} }
spdlog::debug("[wlr/workspaces]: Workspace manager destroyed");
} }
auto WorkspaceManager::remove_workspace_group(uint32_t id) -> void { void WorkspaceManager::register_manager(wl_registry *registry, uint32_t name, uint32_t version) {
auto it = std::find_if(groups_.begin(), groups_.end(), if (ext_manager_ != nullptr) {
[id](const std::unique_ptr<WorkspaceGroup> &g) { return g->id() == id; }); spdlog::warn("[wlr/workspaces]: Register workspace manager again although already registered!");
return;
}
if (version != 1) {
spdlog::warn("[wlr/workspaces]: Using different workspace manager protocol version: {}",
version);
}
ext_manager_ = workspace_manager_bind(registry, name, version, this);
}
void WorkspaceManager::remove_workspace_group(uint32_t id) {
const auto it =
std::find_if(groups_.begin(), groups_.end(), [id](const auto &g) { return g->id() == id; });
if (it == groups_.end()) { if (it == groups_.end()) {
spdlog::warn("Can't find group with id {}", id); spdlog::warn("[wlr/workspaces]: Can't find workspace group with id {}", id);
return; return;
} }
groups_.erase(it); groups_.erase(it);
} }
auto WorkspaceManager::commit() -> void { zext_workspace_manager_v1_commit(workspace_manager_); }
WorkspaceGroup::WorkspaceGroup(const Bar &bar, Gtk::Box &box, const Json::Value &config, void WorkspaceManager::remove_workspace(uint32_t id) {
WorkspaceManager &manager, const auto it = std::find_if(workspaces_.begin(), workspaces_.end(),
zext_workspace_group_handle_v1 *workspace_group_handle, uint32_t id) [id](const auto &w) { return w->id() == id; });
: bar_(bar),
box_(box),
config_(config),
workspace_manager_(manager),
workspace_group_handle_(workspace_group_handle),
id_(id) {
add_workspace_group_listener(workspace_group_handle, this);
}
auto WorkspaceGroup::fill_persistent_workspaces() -> void {
if (config_["persistent_workspaces"].isObject()) {
spdlog::warn(
"persistent_workspaces is deprecated. Please change config to use persistent-workspaces.");
}
if ((config_["persistent-workspaces"].isObject() ||
config_["persistent_workspaces"].isObject()) &&
!workspace_manager_.all_outputs()) {
const Json::Value &p_workspaces = config_["persistent-workspaces"].isObject()
? config_["persistent-workspaces"]
: config_["persistent_workspaces"];
const std::vector<std::string> p_workspaces_names = p_workspaces.getMemberNames();
for (const std::string &p_w_name : p_workspaces_names) {
const Json::Value &p_w = p_workspaces[p_w_name];
if (p_w.isArray() && !p_w.empty()) {
// Adding to target outputs
for (const Json::Value &output : p_w) {
if (output.asString() == bar_.output->name) {
persistent_workspaces_.push_back(p_w_name);
break;
}
}
} else {
// Adding to all outputs
persistent_workspaces_.push_back(p_w_name);
}
}
}
}
auto WorkspaceGroup::create_persistent_workspaces() -> void {
for (const std::string &p_w_name : persistent_workspaces_) {
auto new_id = ++workspace_global_id;
workspaces_.push_back(
std::make_unique<Workspace>(bar_, config_, *this, nullptr, new_id, p_w_name));
spdlog::debug("Workspace {} created", new_id);
}
}
auto WorkspaceGroup::active_only() const -> bool { return workspace_manager_.active_only(); }
auto WorkspaceGroup::creation_delayed() const -> bool {
return workspace_manager_.creation_delayed();
}
auto WorkspaceGroup::add_button(Gtk::Button &button) -> void {
box_.pack_start(button, false, false);
}
WorkspaceGroup::~WorkspaceGroup() {
if (!workspace_group_handle_) {
return;
}
zext_workspace_group_handle_v1_destroy(workspace_group_handle_);
workspace_group_handle_ = nullptr;
}
auto WorkspaceGroup::handle_workspace_create(zext_workspace_handle_v1 *workspace) -> void {
auto new_id = ++workspace_global_id;
workspaces_.push_back(std::make_unique<Workspace>(bar_, config_, *this, workspace, new_id, ""));
spdlog::debug("Workspace {} created", new_id);
if (!persistent_created_) {
fill_persistent_workspaces();
create_persistent_workspaces();
persistent_created_ = true;
}
}
auto WorkspaceGroup::handle_remove() -> void {
zext_workspace_group_handle_v1_destroy(workspace_group_handle_);
workspace_group_handle_ = nullptr;
workspace_manager_.remove_workspace_group(id_);
}
auto WorkspaceGroup::handle_output_enter(wl_output *output) -> void {
spdlog::debug("Output {} assigned to {} group", (void *)output, id_);
output_ = output;
if (!is_visible() || workspace_manager_.creation_delayed()) {
return;
}
for (auto &workspace : workspaces_) {
add_button(workspace->get_button_ref());
}
}
auto WorkspaceGroup::is_visible() const -> bool {
return output_ != nullptr &&
(workspace_manager_.all_outputs() ||
output_ == gdk_wayland_monitor_get_wl_output(bar_.output->monitor->gobj()));
}
auto WorkspaceGroup::handle_output_leave() -> void {
spdlog::debug("Output {} remove from {} group", (void *)output_, id_);
output_ = nullptr;
if (output_ != gdk_wayland_monitor_get_wl_output(bar_.output->monitor->gobj())) {
return;
}
for (auto &workspace : workspaces_) {
remove_button(workspace->get_button_ref());
}
}
auto WorkspaceGroup::update() -> void {
for (auto &workspace : workspaces_) {
if (workspace_manager_.creation_delayed()) {
add_button(workspace->get_button_ref());
if (is_visible() && (workspace->is_active() || workspace->is_urgent())) {
workspace->show();
}
}
workspace->update();
}
}
auto WorkspaceGroup::remove_workspace(uint32_t id) -> void {
auto it = std::find_if(workspaces_.begin(), workspaces_.end(),
[id](const std::unique_ptr<Workspace> &w) { return w->id() == id; });
if (it == workspaces_.end()) { if (it == workspaces_.end()) {
spdlog::warn("Can't find workspace with id {}", id); spdlog::warn("[wlr/workspaces]: Can't find workspace with id {}", id);
return; return;
} }
workspaces_.erase(it); workspaces_.erase(it);
} }
auto WorkspaceGroup::handle_done() -> void { void WorkspaceManager::handle_workspace_group(ext_workspace_group_handle_v1 *handle) {
need_to_sort = false; const auto new_id = ++group_global_id;
if (!is_visible()) { groups_.push_back(std::make_unique<WorkspaceGroup>(*this, handle, new_id));
return; spdlog::debug("[wlr/workspaces]: Workspace group {} created", new_id);
} }
for (auto &workspace : workspaces_) { void WorkspaceManager::handle_workspace(ext_workspace_handle_v1 *handle) {
workspace->handle_done(); const auto new_id = ++workspace_global_id;
} const auto new_name = std::to_string(++workspace_name);
workspaces_.push_back(std::make_unique<Workspace>(config_, *this, handle, new_id, new_name));
set_needs_sorting();
spdlog::debug("[wlr/workspaces]: Workspace {} created", new_id);
}
if (creation_delayed()) { void WorkspaceManager::handle_done() { dp.emit(); }
return;
}
if (!workspace_manager_.all_outputs()) { void WorkspaceManager::handle_finished() {
spdlog::debug("[wlr/workspaces]: Finishing workspace manager");
ext_workspace_manager_v1_destroy(ext_manager_);
ext_manager_ = nullptr;
}
void WorkspaceManager::commit() const { ext_workspace_manager_v1_commit(ext_manager_); }
void WorkspaceManager::update() {
spdlog::debug("[wlr/workspaces]: Updating state");
if (needs_sorting_) {
clear_buttons();
sort_workspaces(); sort_workspaces();
} else { needs_sorting_ = false;
workspace_manager_.sort_workspaces(); }
update_buttons();
AModule::update();
}
bool WorkspaceManager::has_button(const Gtk::Button *button) {
const auto buttons = box_.get_children();
return std::find(buttons.begin(), buttons.end(), button) != buttons.end();
}
void WorkspaceManager::sort_workspaces() {
// determine if workspace ID's and names can be sort numerically or literally
auto is_numeric = [](const std::string &s) {
return !s.empty() && std::all_of(s.begin(), s.end(), ::isdigit);
};
auto sort_by_workspace_id_numerically =
std::all_of(workspaces_.begin(), workspaces_.end(),
[&](const auto &w) { return is_numeric(w->workspace_id()); });
auto sort_by_name_numerically = std::all_of(workspaces_.begin(), workspaces_.end(),
[&](const auto &w) { return is_numeric(w->name()); });
// sort based on configuration setting with sort-by-id as fallback
std::sort(workspaces_.begin(), workspaces_.end(), [&](const auto &w1, const auto &w2) {
if (sort_by_id_ || (!sort_by_name_ && !sort_by_coordinates_)) {
if (w1->workspace_id() == w2->workspace_id()) {
return w1->id() < w2->id();
}
if (sort_by_workspace_id_numerically) {
// the idea is that phonetic compare can be applied just to numbers
// with same number of digits
return w1->workspace_id().size() < w2->workspace_id().size() ||
(w1->workspace_id().size() == w2->workspace_id().size() &&
w1->workspace_id() < w2->workspace_id());
}
return w1->workspace_id() < w2->workspace_id();
}
if (sort_by_name_) {
if (w1->name() == w2->name()) {
return w1->id() < w2->id();
}
if (sort_by_name_numerically) {
// see above about numeric sorting
return w1->name().size() < w2->name().size() ||
(w1->name().size() == w2->name().size() && w1->name() < w2->name());
}
return w1->name() < w2->name();
}
if (sort_by_coordinates_) {
if (w1->coordinates() == w2->coordinates()) {
return w1->id() < w2->id();
}
return w1->coordinates() < w2->coordinates();
}
return w1->id() < w2->id();
});
}
void WorkspaceManager::clear_buttons() {
for (const auto &workspace : workspaces_) {
if (has_button(&workspace->button())) {
box_.remove(workspace->button());
}
} }
} }
auto WorkspaceGroup::commit() -> void { workspace_manager_.commit(); } void WorkspaceManager::update_buttons() {
const auto *output = gdk_wayland_monitor_get_wl_output(bar_.output->monitor->gobj());
auto WorkspaceGroup::sort_workspaces() -> void { // go through all workspace
std::sort(workspaces_.begin(), workspaces_.end(), workspace_manager_.workspace_comparator());
for (size_t i = 0; i < workspaces_.size(); ++i) { for (const auto &workspace : workspaces_) {
box_.reorder_child(workspaces_[i]->get_button_ref(), i); const bool workspace_on_any_group_for_output =
std::any_of(groups_.begin(), groups_.end(), [&](const auto &group) {
const bool group_on_output = group->has_output(output) || all_outputs_;
const bool workspace_on_group = group->has_workspace(workspace->handle());
return group_on_output && workspace_on_group;
});
const bool active_or_urgent = workspace->is_active() || workspace->is_urgent();
const bool valid_workspace_state = (active_or_urgent && active_only_) || !active_only_;
const bool show_button = workspace_on_any_group_for_output && valid_workspace_state;
const bool bar_contains_button = has_button(&workspace->button());
// add or remove buttons if needed, update button state
if (show_button) {
if (!bar_contains_button) {
// add button to bar
box_.pack_start(workspace->button(), false, false);
workspace->button().show_all();
}
workspace->update();
} else {
if (bar_contains_button) {
// remove button from bar
box_.remove(workspace->button());
}
}
} }
} }
auto WorkspaceGroup::remove_button(Gtk::Button &button) -> void { box_.remove(button); } // WorkspaceGroup
Workspace::Workspace(const Bar &bar, const Json::Value &config, WorkspaceGroup &workspace_group, WorkspaceGroup::WorkspaceGroup(WorkspaceManager &manager, ext_workspace_group_handle_v1 *handle,
zext_workspace_handle_v1 *workspace, uint32_t id, std::string name) uint32_t id)
: bar_(bar), : workspaces_manager_(manager), ext_handle_(handle), id_(id) {
config_(config), add_workspace_group_listener(ext_handle_, this);
workspace_group_(workspace_group), }
workspace_handle_(workspace),
id_(id), WorkspaceGroup::~WorkspaceGroup() {
name_(name) { if (ext_handle_ != nullptr) {
if (workspace) { ext_workspace_group_handle_v1_destroy(ext_handle_);
add_workspace_listener(workspace, this);
} else {
state_ = (uint32_t)State::EMPTY;
} }
spdlog::debug("[wlr/workspaces]: Workspace group {} destroyed", id_);
}
auto config_format = config["format"]; bool WorkspaceGroup::has_output(const wl_output *output) {
return std::find(outputs_.begin(), outputs_.end(), output) != outputs_.end();
}
bool WorkspaceGroup::has_workspace(const ext_workspace_handle_v1 *workspace) {
return std::find(workspaces_.begin(), workspaces_.end(), workspace) != workspaces_.end();
}
void WorkspaceGroup::handle_capabilities(uint32_t capabilities) {
spdlog::debug("[wlr/workspaces]: Capabilities for workspace group {}:", id_);
if ((capabilities & EXT_WORKSPACE_GROUP_HANDLE_V1_GROUP_CAPABILITIES_CREATE_WORKSPACE) ==
capabilities) {
spdlog::debug("[wlr/workspaces]: create-workspace");
}
}
void WorkspaceGroup::handle_output_enter(wl_output *output) { outputs_.push_back(output); }
void WorkspaceGroup::handle_output_leave(wl_output *output) {
const auto it = std::find(outputs_.begin(), outputs_.end(), output);
if (it != outputs_.end()) {
outputs_.erase(it);
}
}
void WorkspaceGroup::handle_workspace_enter(ext_workspace_handle_v1 *handle) {
workspaces_.push_back(handle);
}
void WorkspaceGroup::handle_workspace_leave(ext_workspace_handle_v1 *handle) {
const auto it = std::find(workspaces_.begin(), workspaces_.end(), handle);
if (it != workspaces_.end()) {
workspaces_.erase(it);
}
}
void WorkspaceGroup::handle_removed() {
spdlog::debug("[wlr/workspaces]: Removing workspace group {}", id_);
workspaces_manager_.remove_workspace_group(id_);
}
// Workspace
Workspace::Workspace(const Json::Value &config, WorkspaceManager &manager,
ext_workspace_handle_v1 *handle, uint32_t id, const std::string &name)
: workspace_manager_(manager), ext_handle_(handle), id_(id), workspace_id_(name), name_(name) {
add_workspace_listener(ext_handle_, this);
// parse configuration
const auto &config_format = config["format"];
format_ = config_format.isString() ? config_format.asString() : "{name}"; format_ = config_format.isString() ? config_format.asString() : "{name}";
with_icon_ = format_.find("{icon}") != std::string::npos; with_icon_ = format_.find("{icon}") != std::string::npos;
if (with_icon_ && icons_map_.empty()) { if (with_icon_ && icon_map_.empty()) {
auto format_icons = config["format-icons"]; const auto &format_icons = config["format-icons"];
for (auto &name : format_icons.getMemberNames()) { for (auto &n : format_icons.getMemberNames()) {
icons_map_.emplace(name, format_icons[name].asString()); icon_map_.emplace(n, format_icons[n].asString());
} }
} }
/* Handle click events if configured */ const bool config_on_click = config["on-click"].isString();
if (config_["on-click"].isString() || config_["on-click-middle"].isString() || if (config_on_click) {
config_["on-click-right"].isString()) { on_click_action_ = config["on-click"].asString();
}
const bool config_on_click_middle = config["on-click-middle"].isString();
if (config_on_click_middle) {
on_click_middle_action_ = config["on-click"].asString();
}
const bool config_on_click_right = config["on-click-right"].isString();
if (config_on_click_right) {
on_click_right_action_ = config["on-click"].asString();
}
// setup UI
if (config_on_click || config_on_click_middle || config_on_click_right) {
button_.add_events(Gdk::BUTTON_PRESS_MASK); button_.add_events(Gdk::BUTTON_PRESS_MASK);
button_.signal_button_press_event().connect(sigc::mem_fun(*this, &Workspace::handle_clicked), button_.signal_button_press_event().connect(sigc::mem_fun(*this, &Workspace::handle_clicked),
false); false);
@ -409,177 +366,145 @@ Workspace::Workspace(const Bar &bar, const Json::Value &config, WorkspaceGroup &
button_.set_relief(Gtk::RELIEF_NONE); button_.set_relief(Gtk::RELIEF_NONE);
content_.set_center_widget(label_); content_.set_center_widget(label_);
button_.add(content_); button_.add(content_);
if (!workspace_group.is_visible()) {
return;
}
workspace_group.add_button(button_);
button_.show_all();
} }
Workspace::~Workspace() { Workspace::~Workspace() {
workspace_group_.remove_button(button_); if (ext_handle_ != nullptr) {
if (!workspace_handle_) { ext_workspace_handle_v1_destroy(ext_handle_);
}
spdlog::debug("[wlr/workspaces]: Workspace {} destroyed", id_);
}
bool Workspace::is_active() const {
return (state_ & EXT_WORKSPACE_HANDLE_V1_STATE_ACTIVE) == EXT_WORKSPACE_HANDLE_V1_STATE_ACTIVE;
}
bool Workspace::is_urgent() const {
return (state_ & EXT_WORKSPACE_HANDLE_V1_STATE_URGENT) == EXT_WORKSPACE_HANDLE_V1_STATE_URGENT;
}
bool Workspace::is_hidden() const {
return (state_ & EXT_WORKSPACE_HANDLE_V1_STATE_HIDDEN) == EXT_WORKSPACE_HANDLE_V1_STATE_HIDDEN;
}
void Workspace::update() {
if (!needs_updating_) {
return; return;
} }
zext_workspace_handle_v1_destroy(workspace_handle_); // update style
workspace_handle_ = nullptr; const auto style_context = button_.get_style_context();
} style_context->remove_class("active");
style_context->remove_class("urgent");
style_context->remove_class("hidden");
auto Workspace::update() -> void {
label_.set_markup(fmt::format(fmt::runtime(format_), fmt::arg("name", name_),
fmt::arg("icon", with_icon_ ? get_icon() : "")));
}
auto Workspace::handle_state(const std::vector<uint32_t> &state) -> void {
state_ = 0;
for (auto state_entry : state) {
switch (state_entry) {
case ZEXT_WORKSPACE_HANDLE_V1_STATE_ACTIVE:
state_ |= (uint32_t)State::ACTIVE;
break;
case ZEXT_WORKSPACE_HANDLE_V1_STATE_URGENT:
state_ |= (uint32_t)State::URGENT;
break;
case ZEXT_WORKSPACE_HANDLE_V1_STATE_HIDDEN:
state_ |= (uint32_t)State::HIDDEN;
break;
}
}
}
auto Workspace::handle_remove() -> void {
if (workspace_handle_) {
zext_workspace_handle_v1_destroy(workspace_handle_);
workspace_handle_ = nullptr;
}
if (!persistent_) {
workspace_group_.remove_workspace(id_);
} else {
state_ = (uint32_t)State::EMPTY;
}
}
auto add_or_remove_class(Glib::RefPtr<Gtk::StyleContext> context, bool condition,
const std::string &class_name) {
if (condition) {
context->add_class(class_name);
} else {
context->remove_class(class_name);
}
}
auto Workspace::handle_done() -> void {
spdlog::debug("Workspace {} changed to state {}", id_, state_);
auto style_context = button_.get_style_context();
add_or_remove_class(style_context, is_active(), "active");
add_or_remove_class(style_context, is_urgent(), "urgent");
add_or_remove_class(style_context, is_hidden(), "hidden");
add_or_remove_class(style_context, is_empty(), "persistent");
if (workspace_group_.creation_delayed()) {
return;
}
if (workspace_group_.active_only() && (is_active() || is_urgent())) {
button_.show_all();
} else if (workspace_group_.active_only() && !(is_active() || is_urgent())) {
button_.hide();
}
}
auto Workspace::get_icon() -> std::string {
if (is_active()) { if (is_active()) {
auto active_icon_it = icons_map_.find("active"); style_context->add_class("active");
if (active_icon_it != icons_map_.end()) { }
if (is_urgent()) {
style_context->add_class("urgent");
}
if (is_hidden()) {
style_context->add_class("hidden");
}
// update label
label_.set_markup(fmt::format(fmt::runtime(format_), fmt::arg("name", name_),
fmt::arg("id", workspace_id_),
fmt::arg("icon", with_icon_ ? icon() : "")));
needs_updating_ = false;
}
void Workspace::handle_id(const std::string &id) {
workspace_id_ = id;
needs_updating_ = true;
workspace_manager_.set_needs_sorting();
}
void Workspace::handle_name(const std::string &name) {
name_ = name;
needs_updating_ = true;
workspace_manager_.set_needs_sorting();
}
void Workspace::handle_coordinates(const std::vector<uint32_t> &coordinates) {
coordinates_ = coordinates;
needs_updating_ = true;
workspace_manager_.set_needs_sorting();
}
void Workspace::handle_state(uint32_t state) {
state_ = state;
needs_updating_ = true;
}
void Workspace::handle_capabilities(uint32_t capabilities) {
spdlog::debug("[wlr/workspaces]: Capabilities for workspace {}:", id_);
if ((capabilities & EXT_WORKSPACE_HANDLE_V1_WORKSPACE_CAPABILITIES_ACTIVATE) == capabilities) {
spdlog::debug("[wlr/workspaces]: activate");
}
if ((capabilities & EXT_WORKSPACE_HANDLE_V1_WORKSPACE_CAPABILITIES_DEACTIVATE) == capabilities) {
spdlog::debug("[wlr/workspaces]: deactivate");
}
if ((capabilities & EXT_WORKSPACE_HANDLE_V1_WORKSPACE_CAPABILITIES_REMOVE) == capabilities) {
spdlog::debug("[wlr/workspaces]: remove");
}
if ((capabilities & EXT_WORKSPACE_HANDLE_V1_WORKSPACE_CAPABILITIES_ASSIGN) == capabilities) {
spdlog::debug("[wlr/workspaces]: assign");
}
needs_updating_ = true;
}
void Workspace::handle_removed() {
spdlog::debug("[wlr/workspaces]: Removing workspace {}", id_);
workspace_manager_.remove_workspace(id_);
}
bool Workspace::handle_clicked(const GdkEventButton *button) const {
std::string action;
if (button->button == GDK_BUTTON_PRIMARY) {
action = on_click_action_;
} else if (button->button == GDK_BUTTON_MIDDLE) {
action = on_click_middle_action_;
} else if (button->button == GDK_BUTTON_SECONDARY) {
action = on_click_right_action_;
}
if (action.empty()) {
return true;
}
if (action == "activate") {
ext_workspace_handle_v1_activate(ext_handle_);
} else if (action == "close") {
ext_workspace_handle_v1_remove(ext_handle_);
} else {
spdlog::warn("[wlr/workspaces]: Unknown action {}", action);
}
workspace_manager_.commit();
return true;
}
std::string Workspace::icon() {
if (is_active()) {
const auto active_icon_it = icon_map_.find("active");
if (active_icon_it != icon_map_.end()) {
return active_icon_it->second; return active_icon_it->second;
} }
} }
auto named_icon_it = icons_map_.find(name_); const auto named_icon_it = icon_map_.find(name_);
if (named_icon_it != icons_map_.end()) { if (named_icon_it != icon_map_.end()) {
return named_icon_it->second; return named_icon_it->second;
} }
if (is_empty()) { const auto default_icon_it = icon_map_.find("default");
auto persistent_icon_it = icons_map_.find("persistent"); if (default_icon_it != icon_map_.end()) {
if (persistent_icon_it != icons_map_.end()) {
return persistent_icon_it->second;
}
}
auto default_icon_it = icons_map_.find("default");
if (default_icon_it != icons_map_.end()) {
return default_icon_it->second; return default_icon_it->second;
} }
return name_; return name_;
} }
auto Workspace::handle_clicked(GdkEventButton *bt) -> bool {
std::string action;
if (config_["on-click"].isString() && bt->button == 1) {
action = config_["on-click"].asString();
} else if (config_["on-click-middle"].isString() && bt->button == 2) {
action = config_["on-click-middle"].asString();
} else if (config_["on-click-right"].isString() && bt->button == 3) {
action = config_["on-click-right"].asString();
}
if (action.empty())
return true;
else if (action == "activate") {
zext_workspace_handle_v1_activate(workspace_handle_);
} else if (action == "close") {
zext_workspace_handle_v1_remove(workspace_handle_);
} else {
spdlog::warn("Unknown action {}", action);
}
workspace_group_.commit();
return true;
}
auto Workspace::show() -> void { button_.show_all(); }
auto Workspace::hide() -> void { button_.hide(); }
auto Workspace::handle_name(const std::string &name) -> void {
if (name_ != name) {
workspace_group_.set_need_to_sort();
}
name_ = name;
spdlog::debug("Workspace {} added to group {}", name, workspace_group_.id());
make_persistent();
handle_duplicate();
}
auto Workspace::make_persistent() -> void {
auto p_workspaces = workspace_group_.persistent_workspaces();
if (std::find(p_workspaces.begin(), p_workspaces.end(), name_) != p_workspaces.end()) {
persistent_ = true;
}
}
auto Workspace::handle_duplicate() -> void {
auto duplicate =
std::find_if(workspace_group_.workspaces().begin(), workspace_group_.workspaces().end(),
[this](const std::unique_ptr<Workspace> &g) {
return g->get_name() == name_ && g->id() != id_;
});
if (duplicate != workspace_group_.workspaces().end()) {
workspace_group_.remove_workspace(duplicate->get()->id());
}
}
auto Workspace::handle_coordinates(const std::vector<uint32_t> &coordinates) -> void {
if (coordinates_ != coordinates) {
workspace_group_.set_need_to_sort();
}
coordinates_ = coordinates;
}
} // namespace waybar::modules::wlr } // namespace waybar::modules::wlr

107
src/modules/wlr/workspace_manager_binding.cpp
View File

@ -11,7 +11,7 @@ namespace waybar::modules::wlr {
static void handle_global(void *data, wl_registry *registry, uint32_t name, const char *interface, static void handle_global(void *data, wl_registry *registry, uint32_t name, const char *interface,
uint32_t version) { uint32_t version) {
if (std::strcmp(interface, zext_workspace_manager_v1_interface.name) == 0) { if (std::strcmp(interface, ext_workspace_manager_v1_interface.name) == 0) {
static_cast<WorkspaceManager *>(data)->register_manager(registry, name, version); static_cast<WorkspaceManager *>(data)->register_manager(registry, name, version);
} }
} }
@ -29,76 +29,97 @@ void add_registry_listener(void *data) {
wl_registry_add_listener(registry, &registry_listener_impl, data); wl_registry_add_listener(registry, &registry_listener_impl, data);
wl_display_roundtrip(display); wl_display_roundtrip(display);
wl_display_roundtrip(display);
} }
static void workspace_manager_handle_workspace_group( static void workspace_manager_handle_workspace_group(
void *data, zext_workspace_manager_v1 *_, zext_workspace_group_handle_v1 *workspace_group) { void *data, ext_workspace_manager_v1 *_, ext_workspace_group_handle_v1 *workspace_group) {
static_cast<WorkspaceManager *>(data)->handle_workspace_group_create(workspace_group); static_cast<WorkspaceManager *>(data)->handle_workspace_group(workspace_group);
} }
static void workspace_manager_handle_done(void *data, zext_workspace_manager_v1 *_) { static void workspace_manager_handle_workspace(void *data, ext_workspace_manager_v1 *_,
ext_workspace_handle_v1 *workspace) {
static_cast<WorkspaceManager *>(data)->handle_workspace(workspace);
}
static void workspace_manager_handle_done(void *data, ext_workspace_manager_v1 *_) {
static_cast<WorkspaceManager *>(data)->handle_done(); static_cast<WorkspaceManager *>(data)->handle_done();
} }
static void workspace_manager_handle_finished(void *data, zext_workspace_manager_v1 *_) { static void workspace_manager_handle_finished(void *data, ext_workspace_manager_v1 *_) {
static_cast<WorkspaceManager *>(data)->handle_finished(); static_cast<WorkspaceManager *>(data)->handle_finished();
} }
static const zext_workspace_manager_v1_listener workspace_manager_impl = { static const ext_workspace_manager_v1_listener workspace_manager_impl = {
.workspace_group = workspace_manager_handle_workspace_group, .workspace_group = workspace_manager_handle_workspace_group,
.workspace = workspace_manager_handle_workspace,
.done = workspace_manager_handle_done, .done = workspace_manager_handle_done,
.finished = workspace_manager_handle_finished, .finished = workspace_manager_handle_finished,
}; };
zext_workspace_manager_v1 *workspace_manager_bind(wl_registry *registry, uint32_t name, ext_workspace_manager_v1 *workspace_manager_bind(wl_registry *registry, uint32_t name,
uint32_t version, void *data) { uint32_t version, void *data) {
auto *workspace_manager = static_cast<zext_workspace_manager_v1 *>( auto *workspace_manager = static_cast<ext_workspace_manager_v1 *>(
wl_registry_bind(registry, name, &zext_workspace_manager_v1_interface, version)); wl_registry_bind(registry, name, &ext_workspace_manager_v1_interface, version));
if (workspace_manager) if (workspace_manager)
zext_workspace_manager_v1_add_listener(workspace_manager, &workspace_manager_impl, data); ext_workspace_manager_v1_add_listener(workspace_manager, &workspace_manager_impl, data);
else else
spdlog::error("Failed to register manager"); spdlog::error("Failed to register manager");
return workspace_manager; return workspace_manager;
} }
static void workspace_group_handle_output_enter(void *data, zext_workspace_group_handle_v1 *_, static void workspace_group_handle_capabilities(void *data, ext_workspace_group_handle_v1 *_,
uint32_t capabilities) {
static_cast<WorkspaceGroup *>(data)->handle_capabilities(capabilities);
}
static void workspace_group_handle_output_enter(void *data, ext_workspace_group_handle_v1 *_,
wl_output *output) { wl_output *output) {
static_cast<WorkspaceGroup *>(data)->handle_output_enter(output); static_cast<WorkspaceGroup *>(data)->handle_output_enter(output);
} }
static void workspace_group_handle_output_leave(void *data, zext_workspace_group_handle_v1 *_, static void workspace_group_handle_output_leave(void *data, ext_workspace_group_handle_v1 *_,
wl_output *output) { wl_output *output) {
static_cast<WorkspaceGroup *>(data)->handle_output_leave(); static_cast<WorkspaceGroup *>(data)->handle_output_leave(output);
} }
static void workspace_group_handle_workspace(void *data, zext_workspace_group_handle_v1 *_, static void workspace_group_handle_workspace_enter(void *data, ext_workspace_group_handle_v1 *_,
zext_workspace_handle_v1 *workspace) { ext_workspace_handle_v1 *workspace) {
static_cast<WorkspaceGroup *>(data)->handle_workspace_create(workspace); static_cast<WorkspaceGroup *>(data)->handle_workspace_enter(workspace);
} }
static void workspace_group_handle_remove(void *data, zext_workspace_group_handle_v1 *_) { static void workspace_group_handle_workspace_leave(void *data, ext_workspace_group_handle_v1 *_,
static_cast<WorkspaceGroup *>(data)->handle_remove(); ext_workspace_handle_v1 *workspace) {
static_cast<WorkspaceGroup *>(data)->handle_workspace_leave(workspace);
} }
static const zext_workspace_group_handle_v1_listener workspace_group_impl = { static void workspace_group_handle_removed(void *data, ext_workspace_group_handle_v1 *_) {
static_cast<WorkspaceGroup *>(data)->handle_removed();
}
static const ext_workspace_group_handle_v1_listener workspace_group_impl = {
.capabilities = workspace_group_handle_capabilities,
.output_enter = workspace_group_handle_output_enter, .output_enter = workspace_group_handle_output_enter,
.output_leave = workspace_group_handle_output_leave, .output_leave = workspace_group_handle_output_leave,
.workspace = workspace_group_handle_workspace, .workspace_enter = workspace_group_handle_workspace_enter,
.remove = workspace_group_handle_remove}; .workspace_leave = workspace_group_handle_workspace_leave,
.removed = workspace_group_handle_removed};
void add_workspace_group_listener(zext_workspace_group_handle_v1 *workspace_group_handle, void add_workspace_group_listener(ext_workspace_group_handle_v1 *workspace_group_handle,
void *data) { void *data) {
zext_workspace_group_handle_v1_add_listener(workspace_group_handle, &workspace_group_impl, data); ext_workspace_group_handle_v1_add_listener(workspace_group_handle, &workspace_group_impl, data);
} }
void workspace_handle_name(void *data, struct zext_workspace_handle_v1 *_, const char *name) { void workspace_handle_name(void *data, struct ext_workspace_handle_v1 *_, const char *name) {
static_cast<Workspace *>(data)->handle_name(name); static_cast<Workspace *>(data)->handle_name(name);
} }
void workspace_handle_coordinates(void *data, struct zext_workspace_handle_v1 *_, void workspace_handle_id(void *data, struct ext_workspace_handle_v1 *_, const char *id) {
static_cast<Workspace *>(data)->handle_id(id);
}
void workspace_handle_coordinates(void *data, struct ext_workspace_handle_v1 *_,
struct wl_array *coordinates) { struct wl_array *coordinates) {
std::vector<uint32_t> coords_vec; std::vector<uint32_t> coords_vec;
auto coords = static_cast<uint32_t *>(coordinates->data); auto coords = static_cast<uint32_t *>(coordinates->data);
@ -109,28 +130,30 @@ void workspace_handle_coordinates(void *data, struct zext_workspace_handle_v1 *_
static_cast<Workspace *>(data)->handle_coordinates(coords_vec); static_cast<Workspace *>(data)->handle_coordinates(coords_vec);
} }
void workspace_handle_state(void *data, struct zext_workspace_handle_v1 *workspace_handle, void workspace_handle_state(void *data, struct ext_workspace_handle_v1 *workspace_handle,
struct wl_array *state) { uint32_t state) {
std::vector<uint32_t> state_vec; static_cast<Workspace *>(data)->handle_state(state);
auto states = static_cast<uint32_t *>(state->data);
for (size_t i = 0; i < state->size / sizeof(uint32_t); ++i) {
state_vec.push_back(states[i]);
}
static_cast<Workspace *>(data)->handle_state(state_vec);
} }
void workspace_handle_remove(void *data, struct zext_workspace_handle_v1 *_) { static void workspace_handle_capabilities(void *data,
static_cast<Workspace *>(data)->handle_remove(); struct ext_workspace_handle_v1 *workspace_handle,
uint32_t capabilities) {
static_cast<Workspace *>(data)->handle_capabilities(capabilities);
} }
static const zext_workspace_handle_v1_listener workspace_impl = { void workspace_handle_removed(void *data, struct ext_workspace_handle_v1 *workspace_handle) {
static_cast<Workspace *>(data)->handle_removed();
}
static const ext_workspace_handle_v1_listener workspace_impl = {
.id = workspace_handle_id,
.name = workspace_handle_name, .name = workspace_handle_name,
.coordinates = workspace_handle_coordinates, .coordinates = workspace_handle_coordinates,
.state = workspace_handle_state, .state = workspace_handle_state,
.remove = workspace_handle_remove}; .capabilities = workspace_handle_capabilities,
.removed = workspace_handle_removed};
void add_workspace_listener(zext_workspace_handle_v1 *workspace_handle, void *data) { void add_workspace_listener(ext_workspace_handle_v1 *workspace_handle, void *data) {
zext_workspace_handle_v1_add_listener(workspace_handle, &workspace_impl, data); ext_workspace_handle_v1_add_listener(workspace_handle, &workspace_impl, data);
} }
} // namespace waybar::modules::wlr } // namespace waybar::modules::wlr