Merge pull request #1305 from njoyard/feat/groups

Add module group feature

include/bar.hpp

@@ -73,7 +73,7 @@ class Bar {
  private:
   void onMap(GdkEventAny *);
   auto setupWidgets() -> void;
-  void getModules(const Factory &, const std::string &);
+  void getModules(const Factory &, const std::string &, Gtk::Box*);
   void setupAltFormatKeyForModule(const std::string &module_name);
   void setupAltFormatKeyForModuleList(const char *module_list_name);
 
@@ -86,6 +86,7 @@ class Bar {
   std::vector<std::unique_ptr<waybar::AModule>> modules_left_;
   std::vector<std::unique_ptr<waybar::AModule>> modules_center_;
   std::vector<std::unique_ptr<waybar::AModule>> modules_right_;
+  std::vector<std::unique_ptr<waybar::AModule>> modules_all_;
 };
 
 }  // namespace waybar

include/group.hpp

@@ -0,0 +1,21 @@
+#pragma once
+
+#include <gtkmm/widget.h>
+#include <gtkmm/box.h>
+#include <json/json.h>
+#include "AModule.hpp"
+#include "bar.hpp"
+#include "factory.hpp"
+
+namespace waybar {
+
+class Group : public AModule {
+ public:
+  Group(const std::string&, const Bar&, const Json::Value&);
+  ~Group() = default;
+  auto update() -> void;
+  operator Gtk::Widget &();
+  Gtk::Box box;
+};
+
+}  // namespace waybar

man/waybar.5.scd.in

@@ -203,6 +203,28 @@ When positioning Waybar on the left or right side of the screen, sometimes it's
 
 Valid options for the "rotate" property are: 0, 90, 180 and 270.
 
+## Grouping modules
+
+Module groups allow stacking modules in the direction orthogonal to the bar direction. When the bar is positioned on the top or bottom of the screen, modules in a group are stacked vertically. Likewise, when positioned on the left or right, modules in a group are stacked horizontally.
+
+A module group is defined by specifying a module named "group/some-group-name". The group must also be configured with a list of contained modules. Example:
+
+```
+{
+	"modules-right": ["group/hardware", "clock"],
+
+	"group/hardware": {
+		"modules": [
+			"cpu",
+			"memory",
+			"battery"
+		]
+	},
+
+	...
+}
+```
+
 # SUPPORTED MODULES
 
 - *waybar-backlight(5)*

meson.build

@@ -150,6 +150,7 @@ src_files = files(
     'src/bar.cpp',
     'src/client.cpp',
     'src/config.cpp',
+    'src/group.cpp',
     'src/util/ustring_clen.cpp'
 )
 

src/bar.cpp

@@ -9,6 +9,7 @@
 #include "bar.hpp"
 #include "client.hpp"
 #include "factory.hpp"
+#include "group.hpp"
 #include "wlr-layer-shell-unstable-v1-client-protocol.h"
 
 namespace waybar {
@@ -594,19 +595,7 @@ void waybar::Bar::setupAltFormatKeyForModuleList(const char* module_list_name) {
 }
 
 void waybar::Bar::handleSignal(int signal) {
-  for (auto& module : modules_left_) {
-    auto* custom = dynamic_cast<waybar::modules::Custom*>(module.get());
-    if (custom != nullptr) {
-      custom->refresh(signal);
-    }
-  }
-  for (auto& module : modules_center_) {
-    auto* custom = dynamic_cast<waybar::modules::Custom*>(module.get());
-    if (custom != nullptr) {
-      custom->refresh(signal);
-    }
-  }
-  for (auto& module : modules_right_) {
+  for (auto& module : modules_all_) {
     auto* custom = dynamic_cast<waybar::modules::Custom*>(module.get());
     if (custom != nullptr) {
       custom->refresh(signal);
@@ -614,19 +603,35 @@ void waybar::Bar::handleSignal(int signal) {
   }
 }
 
-void waybar::Bar::getModules(const Factory& factory, const std::string& pos) {
-  if (config[pos].isArray()) {
-    for (const auto& name : config[pos]) {
+void waybar::Bar::getModules(const Factory& factory, const std::string& pos, Gtk::Box* group = nullptr) {
+  auto module_list = group ? config[pos]["modules"] : config[pos];
+  if (module_list.isArray()) {
+    for (const auto& name : module_list) {
       try {
-        auto module = factory.makeModule(name.asString());
-        if (pos == "modules-left") {
-          modules_left_.emplace_back(module);
+        auto ref = name.asString();
+        AModule* module;
+
+        if (ref.compare(0, 6, "group/") == 0 && ref.size() > 6) {
+          auto group_module = new waybar::Group(ref, *this, config[ref]);
+          getModules(factory, ref, &group_module->box);
+          module = group_module;
+        } else {
+          module = factory.makeModule(ref);
         }
-        if (pos == "modules-center") {
-          modules_center_.emplace_back(module);
-        }
-        if (pos == "modules-right") {
-          modules_right_.emplace_back(module);
+
+        modules_all_.emplace_back(module);
+        if (group) {
+          group->pack_start(*module, false, false);
+        } else {
+          if (pos == "modules-left") {
+            modules_left_.emplace_back(module);
+          }
+          if (pos == "modules-center") {
+            modules_center_.emplace_back(module);
+          }
+          if (pos == "modules-right") {
+            modules_right_.emplace_back(module);
+          }
         }
         module->dp.connect([module, &name] {
           try {

src/group.cpp

@@ -0,0 +1,19 @@
+#include "group.hpp"
+#include <fmt/format.h>
+#include <util/command.hpp>
+
+namespace waybar {
+
+Group::Group(const std::string& name, const Bar& bar, const Json::Value& config)
+    : AModule(config, name, "", false, false),
+      box{bar.vertical ? Gtk::ORIENTATION_HORIZONTAL : Gtk::ORIENTATION_VERTICAL, 0}
+    {
+}
+
+auto Group::update() -> void {
+  // noop
+}
+
+Group::operator Gtk::Widget&() { return box; }
+
+}  // namespace waybar