polybar-dwm/src/drawtypes/label.cpp
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

317 lines
9.8 KiB
C++

#include "drawtypes/label.hpp"
#include <cmath>
#include <utility>
#include "utils/string.hpp"
POLYBAR_NS
namespace drawtypes {
/**
* Gets the text from the label as it should be rendered
*
* Here tokens are replaced with values and minlen and maxlen properties are applied
*/
string label::get() const {
const size_t len = string_util::char_len(m_tokenized);
if (len >= m_minlen) {
string text = m_tokenized;
if (m_maxlen > 0 && len > m_maxlen) {
if (m_ellipsis) {
text = string_util::utf8_truncate(std::move(text), m_maxlen - 3) + "...";
} else {
text = string_util::utf8_truncate(std::move(text), m_maxlen);
}
}
return text;
}
const size_t num_fill_chars = m_minlen - len;
size_t right_fill_len = 0;
size_t left_fill_len = 0;
if (m_alignment == alignment::RIGHT) {
left_fill_len = num_fill_chars;
} else if (m_alignment == alignment::LEFT) {
right_fill_len = num_fill_chars;
} else {
right_fill_len = std::ceil(num_fill_chars / 2.0);
left_fill_len = right_fill_len;
// The text is positioned one character to the left if we can't perfectly center it
if (len + left_fill_len + right_fill_len > m_minlen) {
--left_fill_len;
}
}
return string(left_fill_len, ' ') + m_tokenized + string(right_fill_len, ' ');
}
label::operator bool() {
return !m_tokenized.empty();
}
label_t label::clone() {
vector<token> tokens;
if (!m_tokens.empty()) {
std::back_insert_iterator<decltype(tokens)> back_it(tokens);
std::copy(m_tokens.begin(), m_tokens.end(), back_it);
}
return std::make_shared<label>(m_text, m_foreground, m_background, m_underline, m_overline, m_font, m_padding,
m_margin, m_minlen, m_maxlen, m_alignment, m_ellipsis, move(tokens));
}
void label::clear() {
m_tokenized.clear();
}
void label::reset_tokens() {
m_tokenized = m_text;
}
void label::reset_tokens(const string& tokenized) {
m_tokenized = tokenized;
}
bool label::has_token(const string& token) const {
return m_tokenized.find(token) != string::npos;
}
void label::replace_token(const string& token, string replacement) {
if (!has_token(token)) {
return;
}
for (auto&& tok : m_tokens) {
string repl{replacement};
if (token == tok.token) {
if (tok.max != 0_z && string_util::char_len(repl) > tok.max) {
repl = string_util::utf8_truncate(std::move(repl), tok.max) + tok.suffix;
} else if (tok.min != 0_z && repl.length() < tok.min) {
repl.insert(0_z, tok.min - repl.length(), tok.zpad ? '0' : ' ');
}
/*
* Only replace first occurence, so that the proper token objects can be used
*/
m_tokenized = string_util::replace(m_tokenized, token, move(repl));
}
}
}
void label::replace_defined_values(const label_t& label) {
if (label->m_foreground.has_color()) {
m_foreground = label->m_foreground;
}
if (label->m_background.has_color()) {
m_background = label->m_background;
}
if (label->m_underline.has_color()) {
m_underline = label->m_underline;
}
if (label->m_overline.has_color()) {
m_overline = label->m_overline;
}
if (label->m_font != 0) {
m_font = label->m_font;
}
if (label->m_padding.left) {
m_padding.left = label->m_padding.left;
}
if (label->m_padding.right) {
m_padding.right = label->m_padding.right;
}
if (label->m_margin.left) {
m_margin.left = label->m_margin.left;
}
if (label->m_margin.right) {
m_margin.right = label->m_margin.right;
}
if (label->m_maxlen != 0_z) {
m_maxlen = label->m_maxlen;
m_ellipsis = label->m_ellipsis;
}
}
void label::copy_undefined(const label_t& label) {
if (!m_foreground.has_color() && label->m_foreground.has_color()) {
m_foreground = label->m_foreground;
}
if (!m_background.has_color() && label->m_background.has_color()) {
m_background = label->m_background;
}
if (!m_underline.has_color() && label->m_underline.has_color()) {
m_underline = label->m_underline;
}
if (!m_overline.has_color() && label->m_overline.has_color()) {
m_overline = label->m_overline;
}
if (m_font == 0 && label->m_font != 0) {
m_font = label->m_font;
}
if (!m_padding.left && label->m_padding.left) {
m_padding.left = label->m_padding.left;
}
if (!m_padding.right && label->m_padding.right) {
m_padding.right = label->m_padding.right;
}
if (!m_margin.left && label->m_margin.left) {
m_margin.left = label->m_margin.left;
}
if (!m_margin.right && label->m_margin.right) {
m_margin.right = label->m_margin.right;
}
if (m_maxlen == 0_z && label->m_maxlen != 0_z) {
m_maxlen = label->m_maxlen;
m_ellipsis = label->m_ellipsis;
}
}
/**
* Create a label by loading values from the configuration
*/
label_t load_label(const config& conf, const string& section, string name, bool required, string def) {
vector<token> tokens;
size_t start, end, pos;
name = string_util::ltrim(string_util::rtrim(move(name), '>'), '<');
string text;
struct side_values padding {
}, margin{};
if (required) {
text = conf.get(section, name);
} else {
text = conf.get(section, name, def);
}
const auto get_left_right = [&](string&& key) {
const auto parse_or_throw = [&](const string& key, spacing_val default_value) {
try {
return conf.get(section, key, default_value);
} catch (const std::exception& err) {
throw application_error(
sstream() << "Failed to set " << section << "." << key << " (reason: " << err.what() << ")");
}
};
auto value = parse_or_throw(key, ZERO_SPACE);
auto left = parse_or_throw(key + "-left", value);
auto right = parse_or_throw(key + "-right", value);
return side_values{left, right};
};
padding = get_left_right(name + "-padding");
margin = get_left_right(name + "-margin");
string line{text};
while ((start = line.find('%')) != string::npos && (end = line.find('%', start + 1)) != string::npos) {
auto token_str = line.substr(start, end - start + 1);
// ignore false positives
// lemonbar tags %{...}
// trailing percentage signs %token%%
if (token_str.find_first_of("abcdefghijklmnopqrstuvwxyz") != 1) {
line.erase(0, end);
continue;
}
line.erase(start, end - start + 1);
tokens.emplace_back(token{token_str, 0_z, 0_z});
auto& token = tokens.back();
// find min delimiter
if ((pos = token_str.find(':')) == string::npos) {
continue;
}
// strip min/max specifiers from the label string token
token.token = token_str.substr(0, pos) + '%';
text = string_util::replace(text, token_str, token.token);
try {
token.min = std::stoul(&token_str[pos + 1], nullptr, 10);
// When the number starts with 0 the string is 0-padded
token.zpad = token_str[pos + 1] == '0';
} catch (const std::invalid_argument& err) {
continue;
}
// find max delimiter
if ((pos = token_str.find(':', pos + 1)) == string::npos) {
continue;
}
try {
token.max = std::stoul(&token_str[pos + 1], nullptr, 10);
} catch (const std::invalid_argument& err) {
continue;
}
// ignore max lengths less than min
if (token.max < token.min) {
token.max = 0_z;
}
// find suffix delimiter
if ((pos = token_str.find(':', pos + 1)) != string::npos) {
token.suffix = token_str.substr(pos + 1, token_str.size() - pos - 2);
}
}
size_t minlen = conf.get(section, name + "-minlen", 0_z);
string alignment_conf_value = conf.get(section, name + "-alignment", "left"s);
alignment label_alignment;
if (alignment_conf_value == "right") {
label_alignment = alignment::RIGHT;
} else if (alignment_conf_value == "left") {
label_alignment = alignment::LEFT;
} else if (alignment_conf_value == "center") {
label_alignment = alignment::CENTER;
} else {
throw application_error(sstream() << "Label " << section << "." << name << " has invalid alignment "
<< alignment_conf_value << ", expecting one of: right, left, center.");
}
size_t maxlen = conf.get(section, name + "-maxlen", 0_z);
if (maxlen > 0 && maxlen < minlen) {
throw application_error(sstream() << "Label " << section << "." << name << " has maxlen " << maxlen
<< " which is smaller than minlen " << minlen);
}
bool ellipsis = conf.get(section, name + "-ellipsis", true);
// clang-format off
if (ellipsis && maxlen > 0 && maxlen < 3) {
throw application_error(sstream() << "Label " << section << "." << name << " has maxlen " << maxlen
<< ", which is smaller than length of ellipsis (3)");
}
// clang-format on
// clang-format off
return std::make_shared<label>(text,
conf.get(section, name + "-foreground", rgba{}),
conf.get(section, name + "-background", rgba{}),
conf.get(section, name + "-underline", rgba{}),
conf.get(section, name + "-overline", rgba{}),
conf.get(section, name + "-font", 0),
padding,
margin,
minlen,
maxlen,
label_alignment,
ellipsis,
move(tokens));
// clang-format on
}
/**
* Create a label by loading optional values from the configuration
*/
label_t load_optional_label(const config& conf, string section, string name, string def) {
return load_label(conf, section, move(name), false, move(def));
}
} // namespace drawtypes
POLYBAR_NS_END