polybar/include/components/controller.hpp

155 lines
4.1 KiB
C++
Raw Normal View History

2016-06-15 03:32:35 +00:00
#pragma once
2021-09-11 14:06:49 +00:00
#include <mutex>
#include <queue>
2016-12-01 07:41:49 +00:00
2016-06-15 03:32:35 +00:00
#include "common.hpp"
2021-02-20 20:26:45 +00:00
#include "components/eventloop.hpp"
2019-03-07 06:42:10 +00:00
#include "components/types.hpp"
#include "events/signal_fwd.hpp"
#include "events/signal_receiver.hpp"
#include "settings.hpp"
2020-11-25 09:16:26 +00:00
#include "utils/actions.hpp"
2016-12-27 03:58:41 +00:00
#include "utils/file.hpp"
#include "x11/types.hpp"
2016-06-15 03:32:35 +00:00
2016-11-19 05:22:44 +00:00
POLYBAR_NS
2016-06-15 03:32:35 +00:00
using std::queue;
2016-11-20 22:04:31 +00:00
// fwd decl {{{
2017-01-19 10:11:28 +00:00
enum class alignment;
2016-11-20 22:04:31 +00:00
class bar;
2016-12-09 08:40:46 +00:00
class config;
class connection;
class inotify_watch;
2016-12-09 08:40:46 +00:00
class logger;
class signal_emitter;
namespace modules {
struct module_interface;
Add units support (POINT, PIXEL, SPACE) (#2578) * add units support (POINT, PIXEL, SPACE) for polybar - add a size_with_unit struct - add a geometry_format_values struct - move dpi initialisation from renderer.cpp to bar.cpp - add a string to size_with_unit converter - add point support (with pt) - add pixel support (with px) * Fix unit test compilation * clang-format * Better names The old names didn't really capture the purpose of the structs and function. space_type -> spacing_type space_size -> spacing_val size_type -> extent_type geometry -> extent_val geometry_format_values -> percentage_with_offset * Remove parse_size_with_unit No longer needed. The convert<spacing_val> function in config.cpp already does all the work for us and always setting the type to pixel was wrong. In addition, line-size should not be of type spacing_val but extent_val. * Cleanup I tried to address most of my comments on the old PR * Fix renderer width calculation We can't just blindly add the x difference to the width because for example the width should increase if x < width and the increase keeps x < width. Similarly, we can't just add the offset to the width. * Rename geom_format_to_pixels to percentage_with_offset_to_pixel * Cleanup * Apply suggested changes from Patrick on GitHub Co-authored-by: Patrick Ziegler <p.ziegler96@gmail.com> * Update src/components/bar.cpp Co-authored-by: Patrick Ziegler <p.ziegler96@gmail.com> * Update src/components/config.cpp Co-authored-by: Patrick Ziegler <p.ziegler96@gmail.com> * Update src/components/builder.cpp Co-authored-by: Patrick Ziegler <p.ziegler96@gmail.com> * Update src/components/builder.cpp Co-authored-by: Patrick Ziegler <p.ziegler96@gmail.com> * config: Use stod for parsing percentage * Use stof instead of strtof * units: Fix test edge cases * Remove unnecessary clang-format toggle * Use percentage_with_offset for margin-{top,bottom} * Support negative extent values * Rename unit to units and create a cpp file * Move percentage_with_offset_to_pixel unit test to units * Add unit tests for units_utils * Clarify when and how negative spacing/extent is allowed Negative spacing is never allowed and produces a config error. Extents allow negative values in theory, but only a few use-cases accept it. Only the extent value used for the `%{O}` tag and the offset value in percentage_with_offset can be negative. Everything else is capped below at 0. The final pixel value of percentage_with_offset also caps below at 0. * Fix parsing errors not being caught in config * Print a proper error message for uncaught exceptions * Cleanup module::get_output All changes preserve the existing semantics * Stop using remove_trailing_space in module::get_output Instead, we first check if the current tag is built, and only if it is, the spacing is prepended. * Remove unused imports * Restore old behavior If there are two tags and the second one isn't built (module::build returns false), the space in between them is removed. For example in the mpd module: format-online = <toggle> <label-song> foo If mpd is not running, the mpd module will return false when trying to build the `<label-song>` tag. If we don't remove the space between `<toggle>` and `<label-song>`, we end up with two spaces between `<toggle>` and `foo`. This change is to match the old behavior where at least one trailing space character was removed from the builder. * Add changelog entry * Remove unused setting * Use percentage with offset for tray-offset Co-authored-by: Jérôme BOULMIER <jerome.boulmier@outlook.fr> Co-authored-by: Joe Groocock <github@frebib.net>
2022-02-20 20:08:57 +00:00
} // namespace modules
using module_t = shared_ptr<modules::module_interface>;
using modulemap_t = std::map<alignment, vector<module_t>>;
2016-11-20 22:04:31 +00:00
// }}}
2021-09-11 13:14:17 +00:00
class controller : public signal_receiver<SIGN_PRIORITY_CONTROLLER, 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::button_press, signals::ui::update_background> {
public:
2016-12-09 08:40:46 +00:00
using make_type = unique_ptr<controller>;
static make_type make(bool has_ipc, eventloop::loop&);
2016-12-09 08:02:47 +00:00
explicit controller(connection&, signal_emitter&, const logger&, const config&, bool has_ipc, eventloop::loop&);
2016-11-02 19:22:45 +00:00
~controller();
2016-06-15 03:32:35 +00:00
bool run(bool writeback, string snapshot_dst, bool confwatch);
2016-06-15 03:32:35 +00:00
2021-09-11 10:36:52 +00:00
void trigger_action(string&& input_data);
void trigger_quit(bool reload);
void trigger_update(bool force);
2016-06-15 03:32:35 +00:00
2021-09-11 09:46:37 +00:00
void stop(bool reload);
void signal_handler(int signum);
Use sockets for IPC (#2539) Deprecates not using `polybar-msg` for IPC. Fixes #2532 Closes #2465 Fixes #2504 * Create FIFO specific NamedPipeHandle subclass to PipeHandle * Prototype SocketHandle * Move mainloop up to main.cpp * Pass eventloop to ipc class * Deprecate sending ipc over the named pipe Unfortunately, we can only show the warning in the polybar log and not give the user any feedback because the pipe is one-way * Move eventloop into its own namespace * Prototype ipc socket handling * Remove handles from ipc_client Should be independent from eventloop logic * Remove ipc clients when finished * Add tests for ipc_client decoding * Add callback for complete ipc messages * Remove template param from mixins * Move signal handler to new callback system * Move poll handle to new callback system * Move FSEventHandle to new callback system * Move TimerHandle and AsyncHandle to new callback system * Move PipeHandle to new callback system * Implement socket functionality in new callback system * Correctly reset ipc named pipe handle * Let client close handles in error callback * Wrap client pipe and ipc::client in connection class * Better decoder log messages * Socket path logic * Fix CI warnings * Remove UVHandleGeneric * Fix error when socket folder already exists * Proof of concept message writeback * Restructure ipc files * polybar-msg: Use sockets * polybar-msg: Better syntax for actions * Fix memory leak with fifo After EOF, the pipe wasn't closed and EOF was called all the time, each time allocating a new pipe. * Make polybar-msg compile on its own * Rudimentary writeback for polybar-msg * Fix payload reference going out of scope. * Add IPC documentation * Cleanup polybar-msg code * Specify the v0 ipc message format * Close ipc connection after message * Fix ipc tests * Properly close ipc connections * Fix polybar-msg not working with action string * Write polybar-msg manpage * polybar-msg: Stop using exit() * ipc: Print log message with PID * Add tests for ipc util * polybar-msg: Print PID with success message * ipc: Propagate message errors * Rename ipc::client to ipc::decoder * Rename ipc.cpp to polybar-msg.cpp * ipc: Write encoder function and fix decoder bugs * ipc: Use message format for responses * ipc: Handle wrong message types * ipc: Write back error message if ipc message cannot be processed This only happens for commands and empty actions. Non-empty actions are not immediately executed, but deferred until the next loop iteration. * Remove TODO about deleting runtime directory The socket file is not deleted after socket.close() is called, only after libuv executes the close callback. So we can't just call rmdir because it will probably always fail. * CLeanup WriteRequest * Update manpage authors * Cleanup
2022-01-22 19:35:37 +00:00
void conn_cb();
void create_config_watcher(const string& filename);
Use sockets for IPC (#2539) Deprecates not using `polybar-msg` for IPC. Fixes #2532 Closes #2465 Fixes #2504 * Create FIFO specific NamedPipeHandle subclass to PipeHandle * Prototype SocketHandle * Move mainloop up to main.cpp * Pass eventloop to ipc class * Deprecate sending ipc over the named pipe Unfortunately, we can only show the warning in the polybar log and not give the user any feedback because the pipe is one-way * Move eventloop into its own namespace * Prototype ipc socket handling * Remove handles from ipc_client Should be independent from eventloop logic * Remove ipc clients when finished * Add tests for ipc_client decoding * Add callback for complete ipc messages * Remove template param from mixins * Move signal handler to new callback system * Move poll handle to new callback system * Move FSEventHandle to new callback system * Move TimerHandle and AsyncHandle to new callback system * Move PipeHandle to new callback system * Implement socket functionality in new callback system * Correctly reset ipc named pipe handle * Let client close handles in error callback * Wrap client pipe and ipc::client in connection class * Better decoder log messages * Socket path logic * Fix CI warnings * Remove UVHandleGeneric * Fix error when socket folder already exists * Proof of concept message writeback * Restructure ipc files * polybar-msg: Use sockets * polybar-msg: Better syntax for actions * Fix memory leak with fifo After EOF, the pipe wasn't closed and EOF was called all the time, each time allocating a new pipe. * Make polybar-msg compile on its own * Rudimentary writeback for polybar-msg * Fix payload reference going out of scope. * Add IPC documentation * Cleanup polybar-msg code * Specify the v0 ipc message format * Close ipc connection after message * Fix ipc tests * Properly close ipc connections * Fix polybar-msg not working with action string * Write polybar-msg manpage * polybar-msg: Stop using exit() * ipc: Print log message with PID * Add tests for ipc util * polybar-msg: Print PID with success message * ipc: Propagate message errors * Rename ipc::client to ipc::decoder * Rename ipc.cpp to polybar-msg.cpp * ipc: Write encoder function and fix decoder bugs * ipc: Use message format for responses * ipc: Handle wrong message types * ipc: Write back error message if ipc message cannot be processed This only happens for commands and empty actions. Non-empty actions are not immediately executed, but deferred until the next loop iteration. * Remove TODO about deleting runtime directory The socket file is not deleted after socket.close() is called, only after libuv executes the close callback. So we can't just call rmdir because it will probably always fail. * CLeanup WriteRequest * Update manpage authors * Cleanup
2022-01-22 19:35:37 +00:00
void confwatch_handler(const char* fname);
2021-09-11 10:19:00 +00:00
void notifier_handler();
2021-09-11 13:14:17 +00:00
void screenshot_handler();
protected:
2021-09-11 13:58:18 +00:00
void trigger_notification();
void read_events(bool confwatch);
2021-09-11 13:39:22 +00:00
void process_inputdata(string&& cmd);
bool process_update(bool force);
2016-06-15 03:32:35 +00:00
2021-09-11 13:58:18 +00:00
void update_reload(bool reload);
bool on(const signals::eventqueue::notify_change& evt) override;
bool on(const signals::eventqueue::notify_forcechange& evt) override;
bool on(const signals::eventqueue::exit_reload& evt) override;
bool on(const signals::eventqueue::check_state& evt) override;
bool on(const signals::ui::button_press& evt) override;
bool on(const signals::ipc::action& evt) override;
bool on(const signals::ipc::command& evt) override;
bool on(const signals::ipc::hook& evt) override;
bool on(const signals::ui::update_background& evt) override;
2016-12-01 07:41:49 +00:00
2016-06-15 03:32:35 +00:00
private:
2021-09-11 13:39:22 +00:00
struct notifications_t {
bool quit;
bool reload;
bool update;
bool force_update;
queue<string> inputdata;
2021-09-11 13:39:22 +00:00
notifications_t() : quit(false), reload(false), update(false), force_update(false), inputdata(queue<string>{}) {}
2021-09-11 13:39:22 +00:00
};
size_t setup_modules(alignment align);
2020-11-25 09:16:26 +00:00
bool forward_action(const actions_util::action& cmd);
2020-05-31 19:11:36 +00:00
bool try_forward_legacy_action(const string& cmd);
2016-06-15 03:32:35 +00:00
connection& m_connection;
signal_emitter& m_sig;
2016-06-15 03:32:35 +00:00
const logger& m_log;
const config& m_conf;
eventloop::loop& m_loop;
2016-06-15 03:32:35 +00:00
unique_ptr<bar> m_bar;
Use sockets for IPC (#2539) Deprecates not using `polybar-msg` for IPC. Fixes #2532 Closes #2465 Fixes #2504 * Create FIFO specific NamedPipeHandle subclass to PipeHandle * Prototype SocketHandle * Move mainloop up to main.cpp * Pass eventloop to ipc class * Deprecate sending ipc over the named pipe Unfortunately, we can only show the warning in the polybar log and not give the user any feedback because the pipe is one-way * Move eventloop into its own namespace * Prototype ipc socket handling * Remove handles from ipc_client Should be independent from eventloop logic * Remove ipc clients when finished * Add tests for ipc_client decoding * Add callback for complete ipc messages * Remove template param from mixins * Move signal handler to new callback system * Move poll handle to new callback system * Move FSEventHandle to new callback system * Move TimerHandle and AsyncHandle to new callback system * Move PipeHandle to new callback system * Implement socket functionality in new callback system * Correctly reset ipc named pipe handle * Let client close handles in error callback * Wrap client pipe and ipc::client in connection class * Better decoder log messages * Socket path logic * Fix CI warnings * Remove UVHandleGeneric * Fix error when socket folder already exists * Proof of concept message writeback * Restructure ipc files * polybar-msg: Use sockets * polybar-msg: Better syntax for actions * Fix memory leak with fifo After EOF, the pipe wasn't closed and EOF was called all the time, each time allocating a new pipe. * Make polybar-msg compile on its own * Rudimentary writeback for polybar-msg * Fix payload reference going out of scope. * Add IPC documentation * Cleanup polybar-msg code * Specify the v0 ipc message format * Close ipc connection after message * Fix ipc tests * Properly close ipc connections * Fix polybar-msg not working with action string * Write polybar-msg manpage * polybar-msg: Stop using exit() * ipc: Print log message with PID * Add tests for ipc util * polybar-msg: Print PID with success message * ipc: Propagate message errors * Rename ipc::client to ipc::decoder * Rename ipc.cpp to polybar-msg.cpp * ipc: Write encoder function and fix decoder bugs * ipc: Use message format for responses * ipc: Handle wrong message types * ipc: Write back error message if ipc message cannot be processed This only happens for commands and empty actions. Non-empty actions are not immediately executed, but deferred until the next loop iteration. * Remove TODO about deleting runtime directory The socket file is not deleted after socket.close() is called, only after libuv executes the close callback. So we can't just call rmdir because it will probably always fail. * CLeanup WriteRequest * Update manpage authors * Cleanup
2022-01-22 19:35:37 +00:00
bool m_has_ipc;
string m_tray_module_name;
2021-09-11 10:19:00 +00:00
/**
2022-02-20 20:40:48 +00:00
* @brief Async handle to notify the eventloop
2021-09-11 10:19:00 +00:00
*
* This handle is used to notify the eventloop of changes which are not otherwise covered by other handles.
* E.g. click actions.
*/
eventloop::async_handle_t m_notifier{m_loop.handle<eventloop::AsyncHandle>([this]() { notifier_handler(); })};
2021-09-11 10:19:00 +00:00
2021-09-11 13:39:22 +00:00
/**
* Notification data for the controller.
*
* Triggers, potentially from other threads, update this structure and notify the controller through m_notifier.
*/
notifications_t m_notifications{};
/**
2022-02-20 20:40:48 +00:00
* @brief Protected m_notifications.
2021-09-11 13:39:22 +00:00
*
* All accesses to m_notifications must hold this mutex.
*/
std::mutex m_notification_mutex{};
2017-01-24 05:59:58 +00:00
/**
2022-02-20 20:40:48 +00:00
* @brief Destination path of generated snapshot
2017-01-24 05:59:58 +00:00
*/
string m_snapshot_dst;
/**
2022-02-20 20:40:48 +00:00
* @brief Controls weather the output gets printed to stdout
*/
2016-11-13 18:05:30 +00:00
bool m_writeback{false};
/**
2022-02-20 20:40:48 +00:00
* @brief Loaded modules
*/
vector<module_t> m_modules;
/**
2022-02-20 20:40:48 +00:00
* @brief Loaded modules grouped by block
*/
modulemap_t m_blocks;
2021-09-11 13:58:18 +00:00
/**
2022-02-20 20:40:48 +00:00
* @brief Flag to trigger reload after shutdown
2021-09-11 13:58:18 +00:00
*/
bool m_reload{false};
2016-06-15 03:32:35 +00:00
};
2016-11-19 05:22:44 +00:00
POLYBAR_NS_END