zhangyiss/FTXUI
1
0
Fork 0
mirror of https://github.com/ArthurSonzogni/FTXUI.git synced 2025-09-18 00:48:09 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve const correctness in the Screen class (#701)

Browse Source 
- Add a const variant to the accessor functions
- Make Print and ToString functions const

This fixes: https://github.com/ArthurSonzogni/FTXUI/issues/700
This commit is contained in:
Igor Bogoslavskyi
2023-07-26 00:41:16 +02:00
committed by GitHub
parent 43240a5fd4
commit b50f1fffc8
2 changed files with 38 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
src/ftxui/screen/screen.cpp
View File

@@ -428,9 +428,11 @@ Screen::Screen(int dimx, int dimy)
#endif
}
/// Produce a std::string that can be used to print the Screen on the terminal.
/// Don't forget to flush stdout. Alternatively, you can use Screen::Print();
std::string Screen::ToString() {
/// 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;
Pixel previous_pixel;
@@ -456,24 +458,39 @@ std::string Screen::ToString() {
return ss.str();
}
void Screen::Print() {
// Print the Screen to the terminal.
void Screen::Print() const {
std::cout << ToString() << '\0' << std::flush;
}
/// @brief Access a character a given position.
/// @param x The character position along the x-axis.
/// @param y The character position along the y-axis.
/// @brief Access a character in a cell at a given position.
/// @param x The cell position along the x-axis.
/// @param y The cell position along the y-axis.
std::string& Screen::at(int x, int y) {
return PixelAt(x, y).character;
}
/// @brief Access a Pixel at a given position.
/// @param x The pixel position along the x-axis.
/// @param y The pixel position along the y-axis.
/// @brief Access a character in a cell at a given position.
/// @param x The cell position along the x-axis.
/// @param y The cell position along the y-axis.
const std::string& Screen::at(int x, int y) const {
return PixelAt(x, y).character;
}
/// @brief Access a cell (Pixel) at a given position.
/// @param x The cell position along the x-axis.
/// @param y The cell position along the y-axis.
Pixel& Screen::PixelAt(int x, int y) {
return stencil.Contain(x, y) ? pixels_[y][x] : dev_null_pixel();
}
/// @brief Access a cell (Pixel) at a given position.
/// @param x The cell position along the x-axis.
/// @param y The cell position along the y-axis.
const Pixel& Screen::PixelAt(int x, int y) const {
return stencil.Contain(x, y) ? pixels_[y][x] : dev_null_pixel();
}
/// @brief Return a string to be printed in order to reset the cursor position
/// to the beginning of the screen.
///