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
|
|
|
#include "utils/units.hpp"
|
|
|
|
|
|
|
|
#include "common.hpp"
|
|
|
|
#include "components/types.hpp"
|
|
|
|
#include "errors.hpp"
|
|
|
|
#include "utils/math.hpp"
|
|
|
|
|
|
|
|
POLYBAR_NS
|
|
|
|
|
|
|
|
namespace units_utils {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Converts points to pixels under the given DPI (PPI).
|
|
|
|
*
|
|
|
|
* 1 pt = 1/72in, so point / 72 * DPI = #pixels
|
|
|
|
*/
|
|
|
|
int point_to_pixel(double point, double dpi) {
|
|
|
|
return dpi * point / 72.0;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Converts an extent value to a pixel value according to the given DPI (if needed).
|
|
|
|
*/
|
|
|
|
int extent_to_pixel(const extent_val size, double dpi) {
|
|
|
|
if (size.type == extent_type::PIXEL) {
|
|
|
|
return size.value;
|
|
|
|
}
|
|
|
|
|
|
|
|
return point_to_pixel(size.value, dpi);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Same as extent_to_pixel but is capped below at 0 pixels.
|
|
|
|
*/
|
|
|
|
unsigned extent_to_pixel_nonnegative(const extent_val size, double dpi) {
|
|
|
|
return std::max(0, extent_to_pixel(size, dpi));
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Converts a percentage with offset into pixels
|
|
|
|
*/
|
2022-03-03 21:19:37 +00:00
|
|
|
int percentage_with_offset_to_pixel(percentage_with_offset g_format, double max, double dpi) {
|
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
|
|
|
int offset_pixel = extent_to_pixel(g_format.offset, dpi);
|
|
|
|
|
2022-03-03 21:19:37 +00:00
|
|
|
return static_cast<int>(math_util::percentage_to_value<double, double>(g_format.percentage, max) + offset_pixel);
|
|
|
|
}
|
|
|
|
|
|
|
|
unsigned percentage_with_offset_to_pixel_nonnegative(percentage_with_offset g_format, double max, double dpi) {
|
|
|
|
return std::max<int>(0, percentage_with_offset_to_pixel(g_format, max, dpi));
|
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
|
|
|
}
|
|
|
|
|
|
|
|
extent_type parse_extent_unit(const string& str) {
|
|
|
|
if (!str.empty()) {
|
|
|
|
if (str == "px") {
|
|
|
|
return extent_type::PIXEL;
|
|
|
|
} else if (str == "pt") {
|
|
|
|
return extent_type::POINT;
|
|
|
|
} else {
|
|
|
|
throw std::runtime_error("Unrecognized unit '" + str + "'");
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
return extent_type::PIXEL;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
extent_val parse_extent(const string& str) {
|
|
|
|
size_t pos;
|
|
|
|
auto size_value = std::stof(str, &pos);
|
|
|
|
|
|
|
|
string unit = string_util::trim(str.substr(pos));
|
|
|
|
extent_type type = parse_extent_unit(unit);
|
|
|
|
|
|
|
|
// Pixel values should be integers
|
|
|
|
if (type == extent_type::PIXEL) {
|
|
|
|
size_value = std::trunc(size_value);
|
|
|
|
}
|
|
|
|
|
|
|
|
return {type, size_value};
|
|
|
|
}
|
|
|
|
|
|
|
|
string extent_to_string(extent_val extent) {
|
|
|
|
std::stringstream ss;
|
|
|
|
|
|
|
|
switch (extent.type) {
|
|
|
|
case extent_type::POINT:
|
|
|
|
ss << extent.value << "pt";
|
|
|
|
break;
|
|
|
|
case extent_type::PIXEL:
|
|
|
|
ss << static_cast<int>(extent.value) << "px";
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
return ss.str();
|
|
|
|
}
|
|
|
|
|
|
|
|
spacing_type parse_spacing_unit(const string& str) {
|
|
|
|
if (!str.empty()) {
|
|
|
|
if (str == "px") {
|
|
|
|
return spacing_type::PIXEL;
|
|
|
|
} else if (str == "pt") {
|
|
|
|
return spacing_type::POINT;
|
|
|
|
} else {
|
|
|
|
throw std::runtime_error("Unrecognized unit '" + str + "'");
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
return spacing_type::SPACE;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
spacing_val parse_spacing(const string& str) {
|
|
|
|
size_t pos;
|
|
|
|
auto size_value = std::stof(str, &pos);
|
|
|
|
|
|
|
|
if (size_value < 0) {
|
|
|
|
throw runtime_error(sstream() << "value '" << str << "' must not be negative");
|
|
|
|
}
|
|
|
|
|
|
|
|
spacing_type type;
|
|
|
|
|
|
|
|
string unit = string_util::trim(str.substr(pos));
|
|
|
|
if (!unit.empty()) {
|
|
|
|
if (unit == "px") {
|
|
|
|
type = spacing_type::PIXEL;
|
|
|
|
size_value = std::trunc(size_value);
|
|
|
|
} else if (unit == "pt") {
|
|
|
|
type = spacing_type::POINT;
|
|
|
|
} else {
|
|
|
|
throw runtime_error("Unrecognized unit '" + unit + "'");
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
type = spacing_type::SPACE;
|
|
|
|
size_value = std::trunc(size_value);
|
|
|
|
}
|
|
|
|
|
|
|
|
return {type, size_value};
|
|
|
|
}
|
|
|
|
|
|
|
|
} // namespace units_utils
|
|
|
|
|
|
|
|
POLYBAR_NS_END
|