PolytreeDE/polybar
1
0
Fork 0
mirror of https://github.com/polybar/polybar.git synced 2024-10-27 05:23:39 -04:00
Code Releases Activity
polybar/include/utils/color.hpp

69 lines
1.6 KiB
C++
Raw Normal View History

feat(color_util): Utility functions for color handling
2016-10-30 20:21:24 -04:00
#pragma once
fix(color_util): Add missing header
2017-01-24 06:37:19 -05:00
#include <cstdlib>
feat(color_util): Utility functions for color handling
2016-10-30 20:21:24 -04:00
#include "common.hpp"
fix: project rename
2016-11-19 00:22:44 -05:00
POLYBAR_NS
feat(color_util): Utility functions for color handling
2016-10-30 20:21:24 -04:00
Make rgba class immutable
2020-11-27 14:35:31 -05:00
/**
* Represents immutable 32-bit color values.
*/
class rgba {
public:
New Tag Parser (#2303) * refactor(color): Use enum class for color type * Add testcases for tag parser * Make tag parser a pull-style parser Being able to parse single elements at a time gives us more fine-grained error messages, we can also parse as much as possible and only stop after an exception. * fix(color): Parser did not check for invalid chars * tag parser: First full implementation * tag parser: Fix remaining failing tests * tag parser: Replace old parser * tag parser: Treat alignment as formatting tag Makes the structure less complex and the alignment tags really are formatting tags, they are structurally no different from the %{R} tag. * tag parser: Cleanup type definitions All type definitions for tags now live in tags/types.hpp, the parser.hpp only contains the definitions necessary for actually calling the parser, this shouldn't be included in many places (only places that actually do parsing). But many places need the definitions for the tags themselves. * Rename components/parser to tags/dispatch * tag parser: Cleanup * Add changelog
2020-12-17 14:37:28 -05:00
enum class type { NONE = 0, ARGB, ALPHA_ONLY };
wip(refactor): Cairo drawing
2017-01-18 23:38:42 -05:00
Move most color_util functions into rgba class The intent is for every color to be stored in a rgba instance The rgba class now stores the color in a 32 bit integer to save space This also removes the unused class rgb and moves everything else into a cpp file. Many functions also had weird template parameters. For example alpha_channel<unsigned short int> would give a 2 byte number with the alpha channel byte in both bytes. color_util::hex would return a hex string with alpha channel if unsigned short int was given and without if unsigned char was given. Even more curiously those parameters were passed to *_channel and the result nevertheless truncated to 8bits.
2019-10-27 17:06:25 -04:00
explicit rgba();
New Tag Parser (#2303) * refactor(color): Use enum class for color type * Add testcases for tag parser * Make tag parser a pull-style parser Being able to parse single elements at a time gives us more fine-grained error messages, we can also parse as much as possible and only stop after an exception. * fix(color): Parser did not check for invalid chars * tag parser: First full implementation * tag parser: Fix remaining failing tests * tag parser: Replace old parser * tag parser: Treat alignment as formatting tag Makes the structure less complex and the alignment tags really are formatting tags, they are structurally no different from the %{R} tag. * tag parser: Cleanup type definitions All type definitions for tags now live in tags/types.hpp, the parser.hpp only contains the definitions necessary for actually calling the parser, this shouldn't be included in many places (only places that actually do parsing). But many places need the definitions for the tags themselves. * Rename components/parser to tags/dispatch * tag parser: Cleanup * Add changelog
2020-12-17 14:37:28 -05:00
explicit rgba(uint32_t value, type type = type::ARGB);
Move most color_util functions into rgba class The intent is for every color to be stored in a rgba instance The rgba class now stores the color in a 32 bit integer to save space This also removes the unused class rgb and moves everything else into a cpp file. Many functions also had weird template parameters. For example alpha_channel<unsigned short int> would give a 2 byte number with the alpha channel byte in both bytes. color_util::hex would return a hex string with alpha channel if unsigned short int was given and without if unsigned char was given. Even more curiously those parameters were passed to *_channel and the result nevertheless truncated to 8bits.
2019-10-27 17:06:25 -04:00
explicit rgba(string hex);
operator string() const;
operator uint32_t() const;
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 15:08:57 -05:00
operator bool() const;
Move most color_util functions into rgba class The intent is for every color to be stored in a rgba instance The rgba class now stores the color in a 32 bit integer to save space This also removes the unused class rgb and moves everything else into a cpp file. Many functions also had weird template parameters. For example alpha_channel<unsigned short int> would give a 2 byte number with the alpha channel byte in both bytes. color_util::hex would return a hex string with alpha channel if unsigned short int was given and without if unsigned char was given. Even more curiously those parameters were passed to *_channel and the result nevertheless truncated to 8bits.
2019-10-27 17:06:25 -04:00
bool operator==(const rgba& other) const;
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 15:08:57 -05:00
bool operator!=(const rgba& other) const;
Move most color_util functions into rgba class The intent is for every color to be stored in a rgba instance The rgba class now stores the color in a 32 bit integer to save space This also removes the unused class rgb and moves everything else into a cpp file. Many functions also had weird template parameters. For example alpha_channel<unsigned short int> would give a 2 byte number with the alpha channel byte in both bytes. color_util::hex would return a hex string with alpha channel if unsigned short int was given and without if unsigned char was given. Even more curiously those parameters were passed to *_channel and the result nevertheless truncated to 8bits.
2019-10-27 17:06:25 -04:00
Make rgba class immutable
2020-11-27 14:35:31 -05:00
uint32_t value() const;
fix(color): Rename type() function to get_type In gcc5, this caused compilation errors because the type enum has the same name.
2021-02-23 03:53:54 -05:00
type get_type() const;
Make rgba class immutable
2020-11-27 14:35:31 -05:00
refactor(color): Better channel function names (alpha|red|green|blue)_(d|i) are used for the four channels using doubles or integers, respectively.
2020-11-27 15:05:50 -05:00
double alpha_d() const;
double red_d() const;
double green_d() const;
double blue_d() const;
Move most color_util functions into rgba class The intent is for every color to be stored in a rgba instance The rgba class now stores the color in a 32 bit integer to save space This also removes the unused class rgb and moves everything else into a cpp file. Many functions also had weird template parameters. For example alpha_channel<unsigned short int> would give a 2 byte number with the alpha channel byte in both bytes. color_util::hex would return a hex string with alpha channel if unsigned short int was given and without if unsigned char was given. Even more curiously those parameters were passed to *_channel and the result nevertheless truncated to 8bits.
2019-10-27 17:06:25 -04:00
refactor(color): Better channel function names (alpha|red|green|blue)_(d|i) are used for the four channels using doubles or integers, respectively.
2020-11-27 15:05:50 -05:00
uint8_t alpha_i() const;
uint8_t red_i() const;
uint8_t green_i() const;
uint8_t blue_i() const;
Move most color_util functions into rgba class The intent is for every color to be stored in a rgba instance The rgba class now stores the color in a 32 bit integer to save space This also removes the unused class rgb and moves everything else into a cpp file. Many functions also had weird template parameters. For example alpha_channel<unsigned short int> would give a 2 byte number with the alpha channel byte in both bytes. color_util::hex would return a hex string with alpha channel if unsigned short int was given and without if unsigned char was given. Even more curiously those parameters were passed to *_channel and the result nevertheless truncated to 8bits.
2019-10-27 17:06:25 -04:00
bool has_color() const;
fix(builder): Properly apply alpha for fg and bg It was not quite clear how try_apply_alpha should behave if the given color was not ALPHA_ONLY. The implementation just returned 'this'. However, the build relied on it returning the given color. This broke all bg and fg settings in the entire bar. To clear this up, we switch this around take the alpha channel of 'this' and also return 'this' if it isn't ALPHA_ONLY. Fixes #2255
2020-12-01 08:49:41 -05:00
rgba apply_alpha_to(rgba other) const;
rgba try_apply_alpha_to(rgba other) const;
Make rgba class immutable
2020-11-27 14:35:31 -05:00
private:
/**
* Color value in the form ARGB or A000 depending on the type
*
* Cannot be const because we have to assign to it in the constructor and initializer lists are not possible.
*/
uint32_t m_value;
/**
* NONE marks this instance as invalid. If such a color is encountered, it
* should be treated as if no color was set.
*
* ALPHA_ONLY is used for color strings that only have an alpha channel (#AA)
* these kinds should be combined with another color that has RGB channels
* before they are used to render anything.
*
* Cannot be const because we have to assign to it in the constructor and initializer lists are not possible.
*/
New Tag Parser (#2303) * refactor(color): Use enum class for color type * Add testcases for tag parser * Make tag parser a pull-style parser Being able to parse single elements at a time gives us more fine-grained error messages, we can also parse as much as possible and only stop after an exception. * fix(color): Parser did not check for invalid chars * tag parser: First full implementation * tag parser: Fix remaining failing tests * tag parser: Replace old parser * tag parser: Treat alignment as formatting tag Makes the structure less complex and the alignment tags really are formatting tags, they are structurally no different from the %{R} tag. * tag parser: Cleanup type definitions All type definitions for tags now live in tags/types.hpp, the parser.hpp only contains the definitions necessary for actually calling the parser, this shouldn't be included in many places (only places that actually do parsing). But many places need the definitions for the tags themselves. * Rename components/parser to tags/dispatch * tag parser: Cleanup * Add changelog
2020-12-17 14:37:28 -05:00
enum type m_type { type::NONE };
wip(refactor): Cairo drawing
2017-01-18 23:38:42 -05:00
};
Move most color_util functions into rgba class The intent is for every color to be stored in a rgba instance The rgba class now stores the color in a 32 bit integer to save space This also removes the unused class rgb and moves everything else into a cpp file. Many functions also had weird template parameters. For example alpha_channel<unsigned short int> would give a 2 byte number with the alpha channel byte in both bytes. color_util::hex would return a hex string with alpha channel if unsigned short int was given and without if unsigned char was given. Even more curiously those parameters were passed to *_channel and the result nevertheless truncated to 8bits.
2019-10-27 17:06:25 -04:00
namespace color_util {
string simplify_hex(string hex);
} // namespace color_util
fix: project rename
2016-11-19 00:22:44 -05:00
POLYBAR_NS_END
Copy permalink