Loading...
Searching...
No Matches
screen.cpp
Go to the documentation of this file.
// 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.
#include <cstddef> // for size_t
#include <cstdint>
#include <iostream> // for operator<<, stringstream, basic_ostream, flush, cout, ostream
#include <limits>
#include <map> // for _Rb_tree_const_iterator, map, operator!=, operator==
#include <sstream> // IWYU pragma: keep
#include <utility> // for pair
#include "ftxui/screen/image.hpp" // for Image
#include "ftxui/screen/pixel.hpp" // for Pixel
#include "ftxui/screen/screen.hpp"
#include "ftxui/screen/string.hpp" // for string_width
#include "ftxui/screen/terminal.hpp" // for Dimensions, Size
#if defined(_WIN32)
#define WIN32_LEAN_AND_MEAN
#ifndef NOMINMAX
#define NOMINMAX
#endif
#include <windows.h>
#endif
// Macro for hinting that an expression is likely to be false.
#if !defined(FTXUI_UNLIKELY)
#if defined(COMPILER_GCC) || defined(__clang__)
#define FTXUI_UNLIKELY(x) __builtin_expect(!!(x), 0)
#else
#define FTXUI_UNLIKELY(x) (x)
#endif // defined(COMPILER_GCC)
#endif // !defined(FTXUI_UNLIKELY)
#if !defined(FTXUI_LIKELY)
#if defined(COMPILER_GCC) || defined(__clang__)
#define FTXUI_LIKELY(x) __builtin_expect(!!(x), 1)
#else
#define FTXUI_LIKELY(x) (x)
#endif // defined(COMPILER_GCC)
#endif // !defined(FTXUI_LIKELY)
namespace ftxui {
namespace {
#if defined(_WIN32)
void WindowsEmulateVT100Terminal() {
static bool done = false;
if (done)
return;
done = true;
// Enable VT processing on stdout and stdin
auto stdout_handle = GetStdHandle(STD_OUTPUT_HANDLE);
DWORD out_mode = 0;
GetConsoleMode(stdout_handle, &out_mode);
// https://docs.microsoft.com/en-us/windows/console/setconsolemode
const int enable_virtual_terminal_processing = 0x0004;
const int disable_newline_auto_return = 0x0008;
out_mode |= enable_virtual_terminal_processing;
out_mode |= disable_newline_auto_return;
SetConsoleMode(stdout_handle, out_mode);
}
#endif
// NOLINTNEXTLINE(readability-function-cognitive-complexity)
void UpdatePixelStyle(const Screen* screen,
std::stringstream& ss,
const Pixel& prev,
const Pixel& next) {
// See https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
if (FTXUI_UNLIKELY(next.hyperlink != prev.hyperlink)) {
ss << "\x1B]8;;" << screen->Hyperlink(next.hyperlink) << "\x1B\\";
}
// Bold
if (FTXUI_UNLIKELY((next.bold ^ prev.bold) | (next.dim ^ prev.dim))) {
// BOLD_AND_DIM_RESET:
ss << ((prev.bold && !next.bold) || (prev.dim && !next.dim) ? "\x1B[22m"
: "");
ss << (next.bold ? "\x1B[1m" : ""); // BOLD_SET
ss << (next.dim ? "\x1B[2m" : ""); // DIM_SET
}
// Underline
if (FTXUI_UNLIKELY(next.underlined != prev.underlined ||
next.underlined_double != prev.underlined_double)) {
ss << (next.underlined ? "\x1B[4m" // UNDERLINE
: next.underlined_double ? "\x1B[21m" // UNDERLINE_DOUBLE
: "\x1B[24m"); // UNDERLINE_RESET
}
// Blink
if (FTXUI_UNLIKELY(next.blink != prev.blink)) {
ss << (next.blink ? "\x1B[5m" // BLINK_SET
: "\x1B[25m"); // BLINK_RESET
}
// Inverted
if (FTXUI_UNLIKELY(next.inverted != prev.inverted)) {
ss << (next.inverted ? "\x1B[7m" // INVERTED_SET
: "\x1B[27m"); // INVERTED_RESET
}
// Italics
if (FTXUI_UNLIKELY(next.italic != prev.italic)) {
ss << (next.italic ? "\x1B[3m" // ITALIC_SET
: "\x1B[23m"); // ITALIC_RESET
}
// StrikeThrough
if (FTXUI_UNLIKELY(next.strikethrough != prev.strikethrough)) {
ss << (next.strikethrough ? "\x1B[9m" // CROSSED_OUT
: "\x1B[29m"); // CROSSED_OUT_RESET
}
if (FTXUI_UNLIKELY(next.foreground_color != prev.foreground_color ||
next.background_color != prev.background_color)) {
ss << "\x1B[" + next.foreground_color.Print(false) + "m";
ss << "\x1B[" + next.background_color.Print(true) + "m";
}
}
struct TileEncoding {
std::uint8_t left : 2;
std::uint8_t top : 2;
std::uint8_t right : 2;
std::uint8_t down : 2;
std::uint8_t round : 1;
// clang-format off
bool operator<(const TileEncoding& other) const {
if (left < other.left) { return true; }
if (left > other.left) { return false; }
if (top < other.top) { return true; }
if (top > other.top) { return false; }
if (right < other.right) { return true; }
if (right > other.right) { return false; }
if (down < other.down) { return true; }
if (down > other.down) { return false; }
if (round < other.round) { return true; }
if (round > other.round) { return false; }
return false;
}
// clang-format on
};
// clang-format off
const std::map<std::string, TileEncoding> tile_encoding = { // NOLINT
{"─", {1, 0, 1, 0, 0}},
{"━", {2, 0, 2, 0, 0}},
{"╍", {2, 0, 2, 0, 0}},
{"│", {0, 1, 0, 1, 0}},
{"┃", {0, 2, 0, 2, 0}},
{"╏", {0, 2, 0, 2, 0}},
{"┌", {0, 0, 1, 1, 0}},
{"┍", {0, 0, 2, 1, 0}},
{"┎", {0, 0, 1, 2, 0}},
{"┏", {0, 0, 2, 2, 0}},
{"┐", {1, 0, 0, 1, 0}},
{"┑", {2, 0, 0, 1, 0}},
{"┒", {1, 0, 0, 2, 0}},
{"┓", {2, 0, 0, 2, 0}},
{"└", {0, 1, 1, 0, 0}},
{"┕", {0, 1, 2, 0, 0}},
{"┖", {0, 2, 1, 0, 0}},
{"┗", {0, 2, 2, 0, 0}},
{"┘", {1, 1, 0, 0, 0}},
{"┙", {2, 1, 0, 0, 0}},
{"┚", {1, 2, 0, 0, 0}},
{"┛", {2, 2, 0, 0, 0}},
{"├", {0, 1, 1, 1, 0}},
{"┝", {0, 1, 2, 1, 0}},
{"┞", {0, 2, 1, 1, 0}},
{"┟", {0, 1, 1, 2, 0}},
{"┠", {0, 2, 1, 2, 0}},
{"┡", {0, 2, 2, 1, 0}},
{"┢", {0, 1, 2, 2, 0}},
{"┣", {0, 2, 2, 2, 0}},
{"┤", {1, 1, 0, 1, 0}},
{"┥", {2, 1, 0, 1, 0}},
{"┦", {1, 2, 0, 1, 0}},
{"┧", {1, 1, 0, 2, 0}},
{"┨", {1, 2, 0, 2, 0}},
{"┩", {2, 2, 0, 1, 0}},
{"┪", {2, 1, 0, 2, 0}},
{"┫", {2, 2, 0, 2, 0}},
{"┬", {1, 0, 1, 1, 0}},
{"┭", {2, 0, 1, 1, 0}},
{"┮", {1, 0, 2, 1, 0}},
{"┯", {2, 0, 2, 1, 0}},
{"┰", {1, 0, 1, 2, 0}},
{"┱", {2, 0, 1, 2, 0}},
{"┲", {1, 0, 2, 2, 0}},
{"┳", {2, 0, 2, 2, 0}},
{"┴", {1, 1, 1, 0, 0}},
{"┵", {2, 1, 1, 0, 0}},
{"┶", {1, 1, 2, 0, 0}},
{"┷", {2, 1, 2, 0, 0}},
{"┸", {1, 2, 1, 0, 0}},
{"┹", {2, 2, 1, 0, 0}},
{"┺", {1, 2, 2, 0, 0}},
{"┻", {2, 2, 2, 0, 0}},
{"┼", {1, 1, 1, 1, 0}},
{"┽", {2, 1, 1, 1, 0}},
{"┾", {1, 1, 2, 1, 0}},
{"┿", {2, 1, 2, 1, 0}},
{"╀", {1, 2, 1, 1, 0}},
{"╁", {1, 1, 1, 2, 0}},
{"╂", {1, 2, 1, 2, 0}},
{"╃", {2, 2, 1, 1, 0}},
{"╄", {1, 2, 2, 1, 0}},
{"╅", {2, 1, 1, 2, 0}},
{"╆", {1, 1, 2, 2, 0}},
{"╇", {2, 2, 2, 1, 0}},
{"╈", {2, 1, 2, 2, 0}},
{"╉", {2, 2, 1, 2, 0}},
{"╊", {1, 2, 2, 2, 0}},
{"╋", {2, 2, 2, 2, 0}},
{"═", {3, 0, 3, 0, 0}},
{"║", {0, 3, 0, 3, 0}},
{"╒", {0, 0, 3, 1, 0}},
{"╓", {0, 0, 1, 3, 0}},
{"╔", {0, 0, 3, 3, 0}},
{"╕", {3, 0, 0, 1, 0}},
{"╖", {1, 0, 0, 3, 0}},
{"╗", {3, 0, 0, 3, 0}},
{"╘", {0, 1, 3, 0, 0}},
{"╙", {0, 3, 1, 0, 0}},
{"╚", {0, 3, 3, 0, 0}},
{"╛", {3, 1, 0, 0, 0}},
{"╜", {1, 3, 0, 0, 0}},
{"╝", {3, 3, 0, 0, 0}},
{"╞", {0, 1, 3, 1, 0}},
{"╟", {0, 3, 1, 3, 0}},
{"╠", {0, 3, 3, 3, 0}},
{"╡", {3, 1, 0, 1, 0}},
{"╢", {1, 3, 0, 3, 0}},
{"╣", {3, 3, 0, 3, 0}},
{"╤", {3, 0, 3, 1, 0}},
{"╥", {1, 0, 1, 3, 0}},
{"╦", {3, 0, 3, 3, 0}},
{"╧", {3, 1, 3, 0, 0}},
{"╨", {1, 3, 1, 0, 0}},
{"╩", {3, 3, 3, 0, 0}},
{"╪", {3, 1, 3, 1, 0}},
{"╫", {1, 3, 1, 3, 0}},
{"╬", {3, 3, 3, 3, 0}},
{"╭", {0, 0, 1, 1, 1}},
{"╮", {1, 0, 0, 1, 1}},
{"╯", {1, 1, 0, 0, 1}},
{"╰", {0, 1, 1, 0, 1}},
{"╴", {1, 0, 0, 0, 0}},
{"╵", {0, 1, 0, 0, 0}},
{"╶", {0, 0, 1, 0, 0}},
{"╷", {0, 0, 0, 1, 0}},
{"╸", {2, 0, 0, 0, 0}},
{"╹", {0, 2, 0, 0, 0}},
{"╺", {0, 0, 2, 0, 0}},
{"╻", {0, 0, 0, 2, 0}},
{"╼", {1, 0, 2, 0, 0}},
{"╽", {0, 1, 0, 2, 0}},
{"╾", {2, 0, 1, 0, 0}},
{"╿", {0, 2, 0, 1, 0}},
};
// clang-format on
template <class A, class B>
std::map<B, A> InvertMap(const std::map<A, B> input) {
std::map<B, A> output;
for (const auto& it : input) {
output[it.second] = it.first;
}
return output;
}
const std::map<TileEncoding, std::string> tile_encoding_inverse = // NOLINT
InvertMap(tile_encoding);
void UpgradeLeftRight(std::string& left, std::string& right) {
const auto it_left = tile_encoding.find(left);
if (it_left == tile_encoding.end()) {
return;
}
const auto it_right = tile_encoding.find(right);
if (it_right == tile_encoding.end()) {
return;
}
if (it_left->second.right == 0 && it_right->second.left != 0) {
TileEncoding encoding_left = it_left->second;
encoding_left.right = it_right->second.left;
const auto it_left_upgrade = tile_encoding_inverse.find(encoding_left);
if (it_left_upgrade != tile_encoding_inverse.end()) {
left = it_left_upgrade->second;
}
}
if (it_right->second.left == 0 && it_left->second.right != 0) {
TileEncoding encoding_right = it_right->second;
encoding_right.left = it_left->second.right;
const auto it_right_upgrade = tile_encoding_inverse.find(encoding_right);
if (it_right_upgrade != tile_encoding_inverse.end()) {
right = it_right_upgrade->second;
}
}
}
void UpgradeTopDown(std::string& top, std::string& down) {
const auto it_top = tile_encoding.find(top);
if (it_top == tile_encoding.end()) {
return;
}
const auto it_down = tile_encoding.find(down);
if (it_down == tile_encoding.end()) {
return;
}
if (it_top->second.down == 0 && it_down->second.top != 0) {
TileEncoding encoding_top = it_top->second;
encoding_top.down = it_down->second.top;
const auto it_top_down = tile_encoding_inverse.find(encoding_top);
if (it_top_down != tile_encoding_inverse.end()) {
top = it_top_down->second;
}
}
if (it_down->second.top == 0 && it_top->second.down != 0) {
TileEncoding encoding_down = it_down->second;
encoding_down.top = it_top->second.down;
const auto it_down_top = tile_encoding_inverse.find(encoding_down);
if (it_down_top != tile_encoding_inverse.end()) {
down = it_down_top->second;
}
}
}
bool ShouldAttemptAutoMerge(Pixel& pixel) {
return pixel.automerge && pixel.character.size() == 3;
}
} // namespace
/// A fixed dimension.
/// @see Fit
/// @see Full
Dimensions Dimension::Fixed(int v) {
return {v, v};
}
/// Use the terminal dimensions.
/// @see Fixed
/// @see Fit
Dimensions Dimension::Full() {
return Terminal::Size();
}
// static
/// Create a screen with the given dimension along the x-axis and y-axis.
Screen Screen::Create(Dimensions width, Dimensions height) {
return {width.dimx, height.dimy};
}
// static
/// Create a screen with the given dimension.
Screen Screen::Create(Dimensions dimension) {
return {dimension.dimx, dimension.dimy};
}
Screen::Screen(int dimx, int dimy) : Image{dimx, dimy} {
#if defined(_WIN32)
// The placement of this call is a bit weird, however we can assume that
// anybody who instantiates a Screen object eventually wants to output
// something to the console. If that is not the case, use an instance of Image
// instead. As we require UTF8 for all input/output operations we will just
// switch to UTF8 encoding here
SetConsoleOutputCP(CP_UTF8);
SetConsoleCP(CP_UTF8);
WindowsEmulateVT100Terminal();
#endif
}
/// Produce a std::string that can be used to print the Screen on the
/// terminal.
/// @note Don't forget to flush stdout. Alternatively, you can use
/// Screen::Print();
std::string Screen::ToString() const {
std::stringstream ss;
const Pixel default_pixel;
const Pixel* previous_pixel_ref = &default_pixel;
for (int y = 0; y < dimy_; ++y) {
// New line in between two lines.
if (y != 0) {
UpdatePixelStyle(this, ss, *previous_pixel_ref, default_pixel);
previous_pixel_ref = &default_pixel;
ss << "\r\n";
}
// After printing a fullwith character, we need to skip the next cell.
bool previous_fullwidth = false;
for (const auto& pixel : pixels_[y]) {
if (!previous_fullwidth) {
UpdatePixelStyle(this, ss, *previous_pixel_ref, pixel);
previous_pixel_ref = &pixel;
if (pixel.character.empty()) {
ss << " ";
} else {
ss << pixel.character;
}
}
previous_fullwidth = (string_width(pixel.character) == 2);
}
}
// Reset the style to default:
UpdatePixelStyle(this, ss, *previous_pixel_ref, default_pixel);
return ss.str();
}
// Print the Screen to the terminal.
void Screen::Print() const {
std::cout << ToString() << '\0' << std::flush;
}
/// @brief Return a string to be printed in order to reset the cursor position
/// to the beginning of the screen.
///
/// ```cpp
/// std::string reset_position;
/// while(true) {
/// auto document = render();
/// auto screen = Screen::Create(Dimension::Full(), Dimension::Fit(document));
/// Render(screen, document);
/// std::cout << reset_position << screen.ToString() << std::flush;
/// reset_position = screen.ResetPosition();
///
/// using namespace std::chrono_literals;
/// std::this_thread::sleep_for(0.01s);
/// }
/// ```
///
/// @return The string to print in order to reset the cursor position to the
/// beginning.
std::string Screen::ResetPosition(bool clear) const {
std::stringstream ss;
if (clear) {
ss << "\r"; // MOVE_LEFT;
ss << "\x1b[2K"; // CLEAR_SCREEN;
for (int y = 1; y < dimy_; ++y) {
ss << "\x1B[1A"; // MOVE_UP;
ss << "\x1B[2K"; // CLEAR_LINE;
}
} else {
ss << "\r"; // MOVE_LEFT;
for (int y = 1; y < dimy_; ++y) {
ss << "\x1B[1A"; // MOVE_UP;
}
}
return ss.str();
}
/// @brief Clear all the pixel from the screen.
void Screen::Clear() {
Image::Clear();
cursor_.x = dimx_ - 1;
cursor_.y = dimy_ - 1;
hyperlinks_ = {
"",
};
}
// clang-format off
void Screen::ApplyShader() {
// Merge box characters togethers.
for (int y = 0; y < dimy_; ++y) {
for (int x = 0; x < dimx_; ++x) {
// Box drawing character uses exactly 3 byte.
Pixel& cur = pixels_[y][x];
if (!ShouldAttemptAutoMerge(cur)) {
continue;
}
if (x > 0) {
Pixel& left = pixels_[y][x-1];
if (ShouldAttemptAutoMerge(left)) {
UpgradeLeftRight(left.character, cur.character);
}
}
if (y > 0) {
Pixel& top = pixels_[y-1][x];
if (ShouldAttemptAutoMerge(top)) {
UpgradeTopDown(top.character, cur.character);
}
}
}
}
}
// clang-format on
std::uint8_t Screen::RegisterHyperlink(const std::string& link) {
for (std::size_t i = 0; i < hyperlinks_.size(); ++i) {
if (hyperlinks_[i] == link) {
return i;
}
}
if (hyperlinks_.size() == std::numeric_limits<std::uint8_t>::max()) {
return 0;
}
hyperlinks_.push_back(link);
return hyperlinks_.size() - 1;
}
const std::string& Screen::Hyperlink(std::uint8_t id) const {
if (id >= hyperlinks_.size()) {
return hyperlinks_[0];
}
return hyperlinks_[id];
}
/// @brief Return the current selection style.
/// @see SetSelectionStyle
const Screen::SelectionStyle& Screen::GetSelectionStyle() const {
return selection_style_;
}
/// @brief Set the current selection style.
/// @see GetSelectionStyle
void Screen::SetSelectionStyle(SelectionStyle decorator) {
selection_style_ = std::move(decorator);
}
} // namespace ftxui
ftxui::Image
A rectangular grid of Pixel.
Definition image.hpp:17
ftxui::Image::dimx_
int dimx_
Definition image.hpp:41
ftxui::Image::dimy_
int dimy_
Definition image.hpp:42
ftxui::Image::Clear
void Clear()
Clear all the pixel from the screen.
Definition image.cpp:55
ftxui::Image::dimx
int dimx() const
Definition image.hpp:32
ftxui::Image::pixels_
std::vector< std::vector< Pixel > > pixels_
Definition image.hpp:43
ftxui::Screen
A rectangular grid of Pixel.
Definition screen.hpp:27
ftxui::Screen::SelectionStyle
std::function< void(Pixel &)> SelectionStyle
Definition screen.hpp:72
ftxui::Screen::ApplyShader
void ApplyShader()
Definition screen.cpp:506
ftxui::Screen::GetSelectionStyle
const SelectionStyle & GetSelectionStyle() const
Return the current selection style.
Definition screen.cpp:555
ftxui::Screen::Hyperlink
const std::string & Hyperlink(uint8_t id) const
Definition screen.cpp:546
ftxui::Screen::ToString
std::string ToString() const
Definition screen.cpp:415
ftxui::Screen::Create
static Screen Create(Dimensions dimension)
Create a screen with the given dimension.
Definition screen.cpp:394
ftxui::Screen::RegisterHyperlink
uint8_t RegisterHyperlink(const std::string &link)
Definition screen.cpp:533
ftxui::Screen::Screen
Screen(int dimx, int dimy)
Definition screen.cpp:398
ftxui::Screen::ResetPosition
std::string ResetPosition(bool clear=false) const
Return a string to be printed in order to reset the cursor position to the beginning of the screen.
Definition screen.cpp:475
ftxui::Screen::cursor_
Cursor cursor_
Definition screen.hpp:77
ftxui::Screen::Clear
void Clear()
Clear all the pixel from the screen.
Definition screen.cpp:494
ftxui::Screen::selection_style_
SelectionStyle selection_style_
Definition screen.hpp:81
ftxui::Screen::SetSelectionStyle
void SetSelectionStyle(SelectionStyle decorator)
Set the current selection style.
Definition screen.cpp:561
ftxui::Screen::hyperlinks_
std::vector< std::string > hyperlinks_
Definition screen.hpp:78
ftxui::Screen::Print
void Print() const
Definition screen.cpp:452
image.hpp
ftxui::Dimension::Fixed
Dimensions Fixed(int)
Definition screen.cpp:375
ftxui::Dimension::Full
Dimensions Full()
Definition screen.cpp:382
ftxui::Terminal::Size
Dimensions Size()
Get the terminal size.
Definition terminal.cpp:94
ftxui
Definition animation.hpp:10
ftxui::Make
std::shared_ptr< T > Make(Args &&... args)
Definition component.hpp:26
ftxui::Dimensions::dimy
int dimy
Definition terminal.hpp:10
ftxui::string_width
int string_width(const std::string &)
Definition string.cpp:1330
ftxui::Dimensions::dimx
int dimx
Definition terminal.hpp:9
ftxui::Dimensions
Definition terminal.hpp:8
pixel.hpp
FTXUI_UNLIKELY
#define FTXUI_UNLIKELY(x)
Definition screen.cpp:31
screen.hpp
string.hpp
ftxui::Pixel
A Unicode character and its associated style.
Definition pixel.hpp:15
ftxui::Pixel::character
std::string character
Definition pixel.hpp:45
ftxui::Screen::Cursor::y
int y
Definition screen.hpp:50
ftxui::Screen::Cursor::x
int x
Definition screen.hpp:49
terminal.hpp