From 2991b0389e4207949e542e2604a312a3f1785628 Mon Sep 17 00:00:00 2001 From: Arthur Sonzogni Date: Thu, 16 Mar 2023 13:15:14 +0100 Subject: [PATCH] Add colored border. (#595) This resolves: https://github.com/ArthurSonzogni/FTXUI/issues/564 --- CHANGELOG.md | 1 + examples/dom/CMakeLists.txt | 1 + examples/dom/border_colored.cpp | 40 +++++++++++++++++++++ include/ftxui/dom/elements.hpp | 2 ++ src/ftxui/dom/border.cpp | 61 +++++++++++++++++++++++++++------ 5 files changed, 94 insertions(+), 11 deletions(-) create mode 100644 examples/dom/border_colored.cpp diff --git a/CHANGELOG.md b/CHANGELOG.md index 73aa26f..8b5955e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ current (development) ### Dom - Feature: Add the dashed style for border and separator. +- Feature: Add colored borders. ### - Breaking: Direction enum is renamed WidthOrHeight diff --git a/examples/dom/CMakeLists.txt b/examples/dom/CMakeLists.txt index df6e1b9..7923536 100644 --- a/examples/dom/CMakeLists.txt +++ b/examples/dom/CMakeLists.txt @@ -1,6 +1,7 @@ set(DIRECTORY_LIB dom) example(border) +example(border_colored) example(border_style) example(color_gallery) example(color_info_palette256) diff --git a/examples/dom/border_colored.cpp b/examples/dom/border_colored.cpp new file mode 100644 index 0000000..b105754 --- /dev/null +++ b/examples/dom/border_colored.cpp @@ -0,0 +1,40 @@ +#include // for operator|, text, Element, Fit, borderDouble, borderHeavy, borderLight, borderRounded, vbox +#include // for Screen +#include // for endl, cout, ostream +#include // for allocator + +#include "ftxui/dom/node.hpp" // for Render +#include "ftxui/screen/color.hpp" // for ftxui + +int main(int argc, const char* argv[]) { + using namespace ftxui; + + auto make_boxed = [] { + return vbox({ + text("borderLight") | borderStyled(LIGHT, Color::Red), + text("borderDashed") | borderStyled(DASHED, Color::Green), + text("borderHeavy") | borderStyled(HEAVY, Color::Blue), + text("borderDouble") | borderStyled(DOUBLE, Color::Yellow), + text("borderRounded") | borderStyled(ROUNDED, Color::Cyan), + }); + }; + + auto document = hbox({ + make_boxed(), + separator() | color(Color::Red), + make_boxed(), + separator() | color(Color::Red), + make_boxed(), + }) | + borderStyled(ROUNDED, Color::Red); + + auto screen = + Screen::Create(Dimension::Fit(document), Dimension::Fit(document)); + Render(screen, document); + screen.Print(); + std::cout << std::endl; +} + +// Copyright 2020 Arthur Sonzogni. All rights reserved. +// Use of this source code is governed by the MIT license that can be found in +// the LICENSE file. diff --git a/include/ftxui/dom/elements.hpp b/include/ftxui/dom/elements.hpp index 7714041..2b615a2 100644 --- a/include/ftxui/dom/elements.hpp +++ b/include/ftxui/dom/elements.hpp @@ -73,6 +73,8 @@ Element borderDouble(Element); Element borderRounded(Element); Element borderEmpty(Element); Decorator borderStyled(BorderStyle); +Decorator borderStyled(BorderStyle, Color); +Decorator borderStyled(Color); Decorator borderWith(const Pixel&); Element window(Element title, Element content); Element spinner(int charset_index, size_t image_index); diff --git a/src/ftxui/dom/border.cpp b/src/ftxui/dom/border.cpp index 9397e39..a90554b 100644 --- a/src/ftxui/dom/border.cpp +++ b/src/ftxui/dom/border.cpp @@ -1,9 +1,10 @@ #include // for max #include // for array #include // for allocator, make_shared, __shared_ptr_access -#include // for basic_string, string -#include // for move -#include // for __alloc_traits<>::value_type +#include +#include // for basic_string, string +#include // for move +#include // for __alloc_traits<>::value_type #include "ftxui/dom/elements.hpp" // for unpack, Element, Decorator, BorderStyle, ROUNDED, Elements, DOUBLE, EMPTY, HEAVY, LIGHT, border, borderDouble, borderEmpty, borderHeavy, borderLight, borderRounded, borderStyled, borderWith, window #include "ftxui/dom/node.hpp" // for Node, Elements @@ -17,22 +18,26 @@ using Charset = std::array; // NOLINT using Charsets = std::array; // NOLINT // NOLINTNEXTLINE static Charsets simple_border_charset = { - Charset{"┌", "┐", "└", "┘", "─", "│"}, // LIGHT - Charset{"┏", "┓", "┗", "┛", "╍", "╏"}, // DASHED - Charset{"┏", "┓", "┗", "┛", "━", "┃"}, // HEAVY - Charset{"╔", "╗", "╚", "╝", "═", "║"}, // DOUBLE - Charset{"╭", "╮", "╰", "╯", "─", "│"}, // ROUNDED - Charset{" ", " ", " ", " ", " ", " "}, // EMPTY + Charset{"┌", "┐", "└", "┘", "─", "│"}, // LIGHT + Charset{"┏", "┓", "┗", "┛", "╍", "╏"}, // DASHED + Charset{"┏", "┓", "┗", "┛", "━", "┃"}, // HEAVY + Charset{"╔", "╗", "╚", "╝", "═", "║"}, // DOUBLE + Charset{"╭", "╮", "╰", "╯", "─", "│"}, // ROUNDED + Charset{" ", " ", " ", " ", " ", " "}, // EMPTY }; // For reference, here is the charset for normal border: class Border : public Node { public: - Border(Elements children, BorderStyle style) + Border(Elements children, + BorderStyle style, + std::optional foreground_color = std::nullopt) : Node(std::move(children)), - charset_(simple_border_charset[style]) {} // NOLINT + charset_(simple_border_charset[style]), + foreground_color_(foreground_color) {} // NOLINT const Charset& charset_; // NOLINT + std::optional foreground_color_; void ComputeRequirement() override { Node::ComputeRequirement(); @@ -101,6 +106,18 @@ class Border : public Node { if (children_.size() == 2) { children_[1]->Render(screen); } + + // Draw the border color. + if (foreground_color_) { + for (int x = box_.x_min; x <= box_.x_max; ++x) { + screen.PixelAt(x, box_.y_min).foreground_color = *foreground_color_; + screen.PixelAt(x, box_.y_max).foreground_color = *foreground_color_; + } + for (int y = box_.y_min; y <= box_.y_max; ++y) { + screen.PixelAt(box_.x_min, y).foreground_color = *foreground_color_; + screen.PixelAt(box_.x_max, y).foreground_color = *foreground_color_; + } + } } }; @@ -179,6 +196,8 @@ class BorderPixel : public Node { /// @see borderHeavy /// @see borderEmpty /// @see borderRounded +/// @see borderStyled +/// @see borderWith /// /// Add a border around an element /// @@ -221,6 +240,26 @@ Decorator borderStyled(BorderStyle style) { }; } +/// @brief Same as border but with a foreground color. +/// @ingroup dom +/// @see border +Decorator borderStyled(Color foreground_color) { + return [foreground_color](Element child) { + return std::make_shared(unpack(std::move(child)), ROUNDED, + foreground_color); + }; +} + +/// @brief Same as border but with a foreground color and a different style +/// @ingroup dom +/// @see border +Decorator borderStyled(BorderStyle style, Color foreground_color) { + return [style, foreground_color](Element child) { + return std::make_shared(unpack(std::move(child)), style, + foreground_color); + }; +} + /// @brief Draw a light border around the element. /// @ingroup dom /// @see border