controller: Print error for duplicate modules (#1534)
* refactor: Use flat module list if possible Before if you wanted to iterate over all loaded modules you had to first iterate over all blocks and then over their modules even if you didn't care about alignment. * refactor: setup modules in separate function * controller: Print error for duplicate modules You can't use the same name twice inside the module lists E.g. modules-left = a b c modules-center = a modules-right = b would print an error. We only print an error for now because we don't want to break existing configs. But in the future this should be properly enforced.
This commit is contained in:
Patrick Ziegler
GitHub
parent
52f0623315
commit
a119c3386b
@ -1,13 +1,14 @@
|
||||
#pragma once
|
||||
|
||||
#include <moodycamel/blockingconcurrentqueue.h>
|
||||
|
||||
#include <thread>
|
||||
|
||||
#include "common.hpp"
|
||||
#include "settings.hpp"
|
||||
#include "events/signal_fwd.hpp"
|
||||
#include "events/signal_receiver.hpp"
|
||||
#include "events/types.hpp"
|
||||
#include "settings.hpp"
|
||||
#include "utils/file.hpp"
|
||||
#include "x11/types.hpp"
|
||||
|
||||
@ -27,16 +28,17 @@ class signal_emitter;
|
||||
namespace modules {
|
||||
struct module_interface;
|
||||
class input_handler;
|
||||
}
|
||||
using module_t = unique_ptr<modules::module_interface>;
|
||||
} // namespace modules
|
||||
using module_t = shared_ptr<modules::module_interface>;
|
||||
using modulemap_t = std::map<alignment, vector<module_t>>;
|
||||
|
||||
// }}}
|
||||
|
||||
class controller : public signal_receiver<SIGN_PRIORITY_CONTROLLER, signals::eventqueue::exit_terminate, signals::eventqueue::exit_reload,
|
||||
signals::eventqueue::notify_change, signals::eventqueue::notify_forcechange, signals::eventqueue::check_state, signals::ipc::action,
|
||||
signals::ipc::command, signals::ipc::hook, signals::ui::ready, signals::ui::button_press,
|
||||
signals::ui::update_background> {
|
||||
class controller
|
||||
: public signal_receiver<SIGN_PRIORITY_CONTROLLER, signals::eventqueue::exit_terminate,
|
||||
signals::eventqueue::exit_reload, signals::eventqueue::notify_change, signals::eventqueue::notify_forcechange,
|
||||
signals::eventqueue::check_state, signals::ipc::action, signals::ipc::command, signals::ipc::hook,
|
||||
signals::ui::ready, signals::ui::button_press, signals::ui::update_background> {
|
||||
public:
|
||||
using make_type = unique_ptr<controller>;
|
||||
static make_type make(unique_ptr<ipc>&& ipc, unique_ptr<inotify_watch>&& config_watch);
|
||||
@ -69,6 +71,8 @@ class controller : public signal_receiver<SIGN_PRIORITY_CONTROLLER, signals::eve
|
||||
bool on(const signals::ui::update_background& evt);
|
||||
|
||||
private:
|
||||
size_t setup_modules(alignment align);
|
||||
|
||||
connection& m_connection;
|
||||
signal_emitter& m_sig;
|
||||
const logger& m_log;
|
||||
@ -103,7 +107,12 @@ class controller : public signal_receiver<SIGN_PRIORITY_CONTROLLER, signals::eve
|
||||
/**
|
||||
* \brief Loaded modules
|
||||
*/
|
||||
modulemap_t m_modules;
|
||||
vector<module_t> m_modules;
|
||||
|
||||
/**
|
||||
* \brief Loaded modules grouped by block
|
||||
*/
|
||||
modulemap_t m_blocks;
|
||||
|
||||
/**
|
||||
* \brief Module input handlers
|
||||
|
||||
@ -1,8 +1,9 @@
|
||||
#include "components/controller.hpp"
|
||||
|
||||
#include <csignal>
|
||||
|
||||
#include "components/bar.hpp"
|
||||
#include "components/config.hpp"
|
||||
#include "components/controller.hpp"
|
||||
#include "components/ipc.hpp"
|
||||
#include "components/logger.hpp"
|
||||
#include "components/types.hpp"
|
||||
@ -17,7 +18,6 @@
|
||||
#include "utils/time.hpp"
|
||||
#include "x11/connection.hpp"
|
||||
#include "x11/extensions/all.hpp"
|
||||
#include "x11/types.hpp"
|
||||
|
||||
POLYBAR_NS
|
||||
|
||||
@ -80,42 +80,37 @@ controller::controller(connection& conn, signal_emitter& emitter, const logger&
|
||||
|
||||
m_log.trace("controller: Setup user-defined modules");
|
||||
size_t created_modules{0};
|
||||
|
||||
for (int i = 0; i < 3; i++) {
|
||||
alignment align{static_cast<alignment>(i + 1)};
|
||||
string configured_modules;
|
||||
|
||||
if (align == alignment::LEFT) {
|
||||
configured_modules = m_conf.get(m_conf.section(), "modules-left", ""s);
|
||||
} else if (align == alignment::CENTER) {
|
||||
configured_modules = m_conf.get(m_conf.section(), "modules-center", ""s);
|
||||
} else if (align == alignment::RIGHT) {
|
||||
configured_modules = m_conf.get(m_conf.section(), "modules-right", ""s);
|
||||
}
|
||||
|
||||
for (auto& module_name : string_util::split(configured_modules, ' ')) {
|
||||
if (module_name.empty()) {
|
||||
continue;
|
||||
}
|
||||
|
||||
try {
|
||||
auto type = m_conf.get("module/" + module_name, "type");
|
||||
|
||||
if (type == "custom/ipc" && !m_ipc) {
|
||||
throw application_error("Inter-process messaging needs to be enabled");
|
||||
}
|
||||
|
||||
m_modules[align].emplace_back(make_module(move(type), m_bar->settings(), module_name, m_log));
|
||||
created_modules++;
|
||||
} catch (const runtime_error& err) {
|
||||
m_log.err("Disabling module \"%s\" (reason: %s)", module_name, err.what());
|
||||
}
|
||||
}
|
||||
}
|
||||
created_modules += setup_modules(alignment::LEFT);
|
||||
created_modules += setup_modules(alignment::CENTER);
|
||||
created_modules += setup_modules(alignment::RIGHT);
|
||||
|
||||
if (!created_modules) {
|
||||
throw application_error("No modules created");
|
||||
}
|
||||
|
||||
/*
|
||||
* Check if each module name only appears once
|
||||
*/
|
||||
std::sort(m_modules.begin(), m_modules.end(), [](const auto& m1, const auto& m2) { return m1->name() < m2->name(); });
|
||||
|
||||
auto dup_it = m_modules.cbegin();
|
||||
|
||||
do {
|
||||
auto equal_predicate = [](const auto& m1, const auto& m2) { return m1->name() == m2->name(); };
|
||||
dup_it = std::adjacent_find(dup_it, m_modules.cend(), equal_predicate);
|
||||
|
||||
if (dup_it != m_modules.cend()) {
|
||||
m_log.err(
|
||||
"The module \"%s\" appears multiple times in your modules list. "
|
||||
"This is deprecated and should be avoided, as it can lead to inconsistent behavior. "
|
||||
"Both modules will be displayed for now.",
|
||||
(*dup_it)->name());
|
||||
|
||||
dup_it = std::find_if_not(dup_it, m_modules.cend(), std::bind(equal_predicate, *dup_it, std::placeholders::_1));
|
||||
} else {
|
||||
break;
|
||||
}
|
||||
} while (true);
|
||||
}
|
||||
|
||||
/**
|
||||
@ -137,16 +132,11 @@ controller::~controller() {
|
||||
m_sig.detach(this);
|
||||
|
||||
m_log.trace("controller: Stop modules");
|
||||
for (auto&& block : m_modules) {
|
||||
for (auto&& module : block.second) {
|
||||
for (auto&& module : m_modules) {
|
||||
auto module_name = module->name();
|
||||
auto cleanup_ms = time_util::measure([&module] {
|
||||
module->stop();
|
||||
module.reset();
|
||||
});
|
||||
auto cleanup_ms = time_util::measure([&module] { module->stop(); });
|
||||
m_log.info("Deconstruction of %s took %lu ms.", module_name, cleanup_ms);
|
||||
}
|
||||
}
|
||||
|
||||
m_log.trace("controller: Joining threads");
|
||||
for (auto&& t : m_threads) {
|
||||
@ -171,8 +161,7 @@ bool controller::run(bool writeback, string snapshot_dst) {
|
||||
m_sig.attach(this);
|
||||
|
||||
size_t started_modules{0};
|
||||
for (const auto& block : m_modules) {
|
||||
for (const auto& module : block.second) {
|
||||
for (const auto& module : m_modules) {
|
||||
auto inp_handler = dynamic_cast<input_handler*>(&*module);
|
||||
auto evt_handler = dynamic_cast<event_handler_interface*>(&*module);
|
||||
|
||||
@ -192,7 +181,6 @@ bool controller::run(bool writeback, string snapshot_dst) {
|
||||
m_log.err("Failed to start '%s' (reason: %s)", module->name(), err.what());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (!started_modules) {
|
||||
throw application_error("No modules started");
|
||||
@ -284,7 +272,6 @@ void controller::read_events() {
|
||||
|
||||
// Check for errors
|
||||
if (events == -1) {
|
||||
|
||||
/*
|
||||
* The Interrupt errno is generated when polybar is stopped, so it
|
||||
* shouldn't generate an error message
|
||||
@ -320,7 +307,8 @@ void controller::read_events() {
|
||||
// file to a different location (and subsequently deleting it).
|
||||
//
|
||||
// We need to re-attach the watch to the new file in this case.
|
||||
fds.erase(std::remove_if(fds.begin(), fds.end(), [fd_confwatch](int fd) { return fd == fd_confwatch; }), fds.end());
|
||||
fds.erase(
|
||||
std::remove_if(fds.begin(), fds.end(), [fd_confwatch](int fd) { return fd == fd_confwatch; }), fds.end());
|
||||
m_confwatch = inotify_util::make_watch(m_confwatch->path());
|
||||
m_confwatch->attach(IN_MODIFY | IN_IGNORED);
|
||||
fds.emplace_back((fd_confwatch = m_confwatch->get_file_descriptor()));
|
||||
@ -465,7 +453,7 @@ bool controller::process_update(bool force) {
|
||||
string margin_left(bar.module_margin.left, ' ');
|
||||
string margin_right(bar.module_margin.right, ' ');
|
||||
|
||||
for (const auto& block : m_modules) {
|
||||
for (const auto& block : m_blocks) {
|
||||
string block_contents;
|
||||
bool is_left = false;
|
||||
bool is_center = false;
|
||||
@ -552,6 +540,64 @@ bool controller::process_update(bool force) {
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates module instances for all the modules in the given alignment block
|
||||
*/
|
||||
size_t controller::setup_modules(alignment align) {
|
||||
size_t count{0};
|
||||
|
||||
string key;
|
||||
|
||||
switch (align) {
|
||||
case alignment::LEFT:
|
||||
key = "modules-left";
|
||||
break;
|
||||
|
||||
case alignment::CENTER:
|
||||
key = "modules-center";
|
||||
break;
|
||||
|
||||
case alignment::RIGHT:
|
||||
key = "modules-right";
|
||||
break;
|
||||
|
||||
case alignment::NONE:
|
||||
m_log.err("controller: Tried to setup modules for alignment NONE");
|
||||
break;
|
||||
}
|
||||
|
||||
string configured_modules;
|
||||
if (!key.empty()) {
|
||||
configured_modules = m_conf.get(m_conf.section(), key, ""s);
|
||||
}
|
||||
|
||||
for (auto& module_name : string_util::split(configured_modules, ' ')) {
|
||||
if (module_name.empty()) {
|
||||
continue;
|
||||
}
|
||||
|
||||
try {
|
||||
auto type = m_conf.get("module/" + module_name, "type");
|
||||
|
||||
if (type == "custom/ipc" && !m_ipc) {
|
||||
throw application_error("Inter-process messaging needs to be enabled");
|
||||
}
|
||||
|
||||
auto ptr = make_module(move(type), m_bar->settings(), module_name, m_log);
|
||||
module_t module = shared_ptr<modules::module_interface>(ptr);
|
||||
ptr = nullptr;
|
||||
|
||||
m_modules.push_back(module);
|
||||
m_blocks[align].push_back(module);
|
||||
count++;
|
||||
} catch (const runtime_error& err) {
|
||||
m_log.err("Disabling module \"%s\" (reason: %s)", module_name, err.what());
|
||||
}
|
||||
}
|
||||
|
||||
return count;
|
||||
}
|
||||
|
||||
/**
|
||||
* Process broadcast events
|
||||
*/
|
||||
@ -586,13 +632,11 @@ bool controller::on(const signals::eventqueue::exit_reload&) {
|
||||
* Process eventqueue check event
|
||||
*/
|
||||
bool controller::on(const signals::eventqueue::check_state&) {
|
||||
for (const auto& block : m_modules) {
|
||||
for (const auto& module : block.second) {
|
||||
for (const auto& module : m_modules) {
|
||||
if (module->running()) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
m_log.warn("No running modules...");
|
||||
on(signals::eventqueue::exit_terminate{});
|
||||
return true;
|
||||
@ -681,17 +725,15 @@ bool controller::on(const signals::ipc::command& evt) {
|
||||
bool controller::on(const signals::ipc::hook& evt) {
|
||||
string hook{evt.cast()};
|
||||
|
||||
for (const auto& block : m_modules) {
|
||||
for (const auto& module : block.second) {
|
||||
for (const auto& module : m_modules) {
|
||||
if (!module->running()) {
|
||||
continue;
|
||||
}
|
||||
auto ipc = dynamic_cast<ipc_module*>(module.get());
|
||||
auto ipc = std::dynamic_pointer_cast<ipc_module>(module);
|
||||
if (ipc != nullptr) {
|
||||
ipc->on_message(hook);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user