polybar-dwm/include/components/types.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

277 lines
5.3 KiB
C++

#pragma once
#include <xcb/xcb.h>
#include <string>
#include <unordered_map>
#include "common.hpp"
#include "utils/color.hpp"
POLYBAR_NS
// fwd {{{
struct randr_output;
using monitor_t = shared_ptr<randr_output>;
namespace drawtypes {
class label;
}
using label_t = shared_ptr<drawtypes::label>;
// }}}
struct enum_hash {
template <typename T>
inline typename std::enable_if<std::is_enum<T>::value, size_t>::type operator()(T const value) const {
return static_cast<size_t>(value);
}
};
enum class edge { NONE = 0, TOP, BOTTOM, LEFT, RIGHT, ALL };
enum class alignment { NONE = 0, LEFT, CENTER, RIGHT };
enum class mousebtn {
NONE = 0,
LEFT,
MIDDLE,
RIGHT,
SCROLL_UP,
SCROLL_DOWN,
DOUBLE_LEFT,
DOUBLE_MIDDLE,
DOUBLE_RIGHT,
// Terminator value, do not use
BTN_COUNT,
};
static inline mousebtn mousebtn_get_double(mousebtn btn) {
switch (btn) {
case mousebtn::LEFT:
return mousebtn::DOUBLE_LEFT;
case mousebtn::MIDDLE:
return mousebtn::DOUBLE_MIDDLE;
case mousebtn::RIGHT:
return mousebtn::DOUBLE_RIGHT;
default:
return mousebtn::NONE;
}
}
enum class strut {
LEFT = 0,
RIGHT,
TOP,
BOTTOM,
LEFT_START_Y,
LEFT_END_Y,
RIGHT_START_Y,
RIGHT_END_Y,
TOP_START_X,
TOP_END_X,
BOTTOM_START_X,
BOTTOM_END_X,
};
struct position {
int x{0};
int y{0};
};
struct size {
unsigned int w{1U};
unsigned int h{1U};
};
enum class spacing_type { SPACE, POINT, PIXEL };
enum class extent_type { POINT, PIXEL };
struct spacing_val {
spacing_type type{spacing_type::SPACE};
/**
* Numerical spacing value. Is truncated to an integer for pixels and spaces.
* Must be non-negative.
*/
float value{0};
/**
* Any non-positive number is interpreted as no spacing.
*/
operator bool() const {
return value > 0;
}
};
static constexpr spacing_val ZERO_SPACE = {spacing_type::SPACE, 0};
/*
* Defines the signed length of something as either a number of pixels or points.
*
* Used for widths, heights, and offsets
*/
struct extent_val {
extent_type type{extent_type::PIXEL};
float value{0};
operator bool() const {
return value != 0;
}
};
static constexpr extent_val ZERO_PX_EXTENT = {extent_type::PIXEL, 0};
struct side_values {
spacing_val left{ZERO_SPACE};
spacing_val right{ZERO_SPACE};
};
struct percentage_with_offset {
double percentage{0};
extent_val offset{ZERO_PX_EXTENT};
};
struct edge_values {
unsigned int left{0U};
unsigned int right{0U};
unsigned int top{0U};
unsigned int bottom{0U};
};
struct radius {
double top_left{0.0};
double top_right{0.0};
double bottom_left{0.0};
double bottom_right{0.0};
operator bool() const {
return top_left != 0.0 || top_right != 0.0 || bottom_left != 0.0 || bottom_right != 0.0;
}
};
struct border_settings {
rgba color{0xFF000000};
unsigned int size{0U};
};
struct line_settings {
rgba color{0xFF000000};
unsigned int size{0U};
};
struct action {
mousebtn button{mousebtn::NONE};
string command{};
};
struct bar_settings {
explicit bar_settings() = default;
bar_settings(const bar_settings& other) = default;
xcb_window_t window{XCB_NONE};
monitor_t monitor{};
bool monitor_strict{false};
bool monitor_exact{true};
edge origin{edge::TOP};
struct size size {
1U, 1U
};
double dpi_x{0.};
double dpi_y{0.};
position pos{0, 0};
position offset{0, 0};
side_values padding{ZERO_SPACE, ZERO_SPACE};
side_values module_margin{ZERO_SPACE, ZERO_SPACE};
edge_values strut{0U, 0U, 0U, 0U};
rgba background{0xFF000000};
rgba foreground{0xFFFFFFFF};
vector<rgba> background_steps;
line_settings underline{};
line_settings overline{};
std::unordered_map<edge, border_settings, enum_hash> borders{};
struct radius radius {};
/**
* TODO deprecated
*/
spacing_val spacing{ZERO_SPACE};
label_t separator{};
string wmname{};
string locale{};
bool override_redirect{false};
int double_click_interval{400};
string cursor{};
string cursor_click{};
string cursor_scroll{};
vector<action> actions{};
bool dimmed{false};
double dimvalue{1.0};
const xcb_rectangle_t inner_area(bool abspos = false) const {
xcb_rectangle_t rect = this->outer_area(abspos);
if (borders.find(edge::TOP) != borders.end()) {
rect.y += borders.at(edge::TOP).size;
rect.height -= borders.at(edge::TOP).size;
}
if (borders.find(edge::BOTTOM) != borders.end()) {
rect.height -= borders.at(edge::BOTTOM).size;
}
if (borders.find(edge::LEFT) != borders.end()) {
rect.x += borders.at(edge::LEFT).size;
rect.width -= borders.at(edge::LEFT).size;
}
if (borders.find(edge::RIGHT) != borders.end()) {
rect.width -= borders.at(edge::RIGHT).size;
}
return rect;
}
const xcb_rectangle_t outer_area(bool abspos = false) const {
xcb_rectangle_t rect{0, 0, 0, 0};
rect.width += size.w;
rect.height += size.h;
if (abspos) {
rect.x = pos.x;
rect.y = pos.y;
}
return rect;
}
};
struct event_timer {
xcb_timestamp_t event{0L};
xcb_timestamp_t offset{1L};
bool allow(xcb_timestamp_t time) {
bool pass = time >= event + offset;
event = time;
return pass;
};
bool deny(xcb_timestamp_t time) {
return !allow(time);
};
};
enum class output_policy {
REDIRECTED,
IGNORED,
};
POLYBAR_NS_END