polybar-dwm/include/components/controller.hpp
Patrick Ziegler ce93188a4a
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 21:08:57 +01:00

153 lines
4.0 KiB
C++

#pragma once
#include <mutex>
#include <queue>
#include "common.hpp"
#include "components/eventloop.hpp"
#include "components/types.hpp"
#include "events/signal_fwd.hpp"
#include "events/signal_receiver.hpp"
#include "settings.hpp"
#include "utils/actions.hpp"
#include "utils/file.hpp"
#include "x11/types.hpp"
POLYBAR_NS
using std::queue;
// fwd decl {{{
enum class alignment;
class bar;
class config;
class connection;
class inotify_watch;
class logger;
class signal_emitter;
namespace modules {
struct 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_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:
using make_type = unique_ptr<controller>;
static make_type make(bool has_ipc, eventloop::loop&);
explicit controller(connection&, signal_emitter&, const logger&, const config&, bool has_ipc, eventloop::loop&);
~controller();
bool run(bool writeback, string snapshot_dst, bool confwatch);
void trigger_action(string&& input_data);
void trigger_quit(bool reload);
void trigger_update(bool force);
void stop(bool reload);
void signal_handler(int signum);
void conn_cb();
void confwatch_handler(const char* fname);
void notifier_handler();
void screenshot_handler();
protected:
void trigger_notification();
void read_events(bool confwatch);
void process_inputdata(string&& cmd);
bool process_update(bool force);
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;
private:
struct notifications_t {
bool quit;
bool reload;
bool update;
bool force_update;
queue<string> inputdata;
notifications_t() : quit(false), reload(false), update(false), force_update(false), inputdata(queue<string>{}) {}
};
size_t setup_modules(alignment align);
bool forward_action(const actions_util::action& cmd);
bool try_forward_legacy_action(const string& cmd);
connection& m_connection;
signal_emitter& m_sig;
const logger& m_log;
const config& m_conf;
eventloop::loop& m_loop;
unique_ptr<bar> m_bar;
bool m_has_ipc;
/**
* \brief Async handle to notify the eventloop
*
* This handle is used to notify the eventloop of changes which are not otherwise covered by other handles.
* E.g. click actions.
*/
eventloop::AsyncHandle& m_notifier{m_loop.handle<eventloop::AsyncHandle>([this]() { notifier_handler(); })};
/**
* Notification data for the controller.
*
* Triggers, potentially from other threads, update this structure and notify the controller through m_notifier.
*/
notifications_t m_notifications{};
/**
* \brief Protected m_notifications.
*
* All accesses to m_notifications must hold this mutex.
*/
std::mutex m_notification_mutex{};
/**
* \brief Destination path of generated snapshot
*/
string m_snapshot_dst;
/**
* \brief Controls weather the output gets printed to stdout
*/
bool m_writeback{false};
/**
* \brief Loaded modules
*/
vector<module_t> m_modules;
/**
* \brief Loaded modules grouped by block
*/
modulemap_t m_blocks;
/**
* \brief Flag to trigger reload after shutdown
*/
bool m_reload{false};
};
POLYBAR_NS_END