mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-09-20 10:38:09 +08:00
f21fcc1995
Some checks failed
Build / Bazel, cl, windows-latest (push) Has been cancelled
Build / Bazel, clang++, macos-latest (push) Has been cancelled
Build / Bazel, clang++, ubuntu-latest (push) Has been cancelled
Build / Bazel, g++, macos-latest (push) Has been cancelled
Build / Bazel, g++, ubuntu-latest (push) Has been cancelled
Build / CMake, cl, windows-latest (push) Has been cancelled
Build / CMake, gcc, ubuntu-latest (push) Has been cancelled
Build / CMake, llvm, ubuntu-latest (push) Has been cancelled
Build / CMake, llvm, macos-latest (push) Has been cancelled
Build / Test modules (llvm, ubuntu-latest) (push) Has been cancelled
Documentation / documentation (push) Has been cancelled
The cursor_ variable was being default initialized, which causes undefined behaviour when accessing properties in ScreenInteractive::Draw. This caused a crash when running with UBSAN. ``` ftxui/src/ftxui/component/screen_interactive.cpp:852:17: runtime error: load of value 4195502944, which is not a valid value for type 'Shape' ``` This change causes the shape variable to be explicitly initialized, similar to the x and y members. Co-authored-by: Benjamin Gwin <bgwin@google.com>
91 lines
2.4 KiB
C++
91 lines
2.4 KiB
C++
// 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.
|
|
#ifndef FTXUI_SCREEN_SCREEN_HPP
|
|
#define FTXUI_SCREEN_SCREEN_HPP
|
|
|
|
#include <cstdint> // for uint8_t
|
|
#include <functional> // for function
|
|
#include <string> // for string, basic_string, allocator
|
|
#include <vector> // for vector
|
|
|
|
#include "ftxui/screen/image.hpp" // for Pixel, Image
|
|
#include "ftxui/screen/terminal.hpp" // for Dimensions
|
|
|
|
namespace ftxui {
|
|
|
|
/// @brief Define how the Screen's dimensions should look like.
|
|
/// @ingroup screen
|
|
namespace Dimension {
|
|
Dimensions Fixed(int);
|
|
Dimensions Full();
|
|
} // namespace Dimension
|
|
|
|
/// @brief A rectangular grid of Pixel.
|
|
/// @ingroup screen
|
|
class Screen : public Image {
|
|
public:
|
|
// Constructors:
|
|
Screen(int dimx, int dimy);
|
|
static Screen Create(Dimensions dimension);
|
|
static Screen Create(Dimensions width, Dimensions height);
|
|
|
|
// Destructor:
|
|
~Screen() override = default;
|
|
|
|
std::string ToString() const;
|
|
|
|
// Print the Screen on to the terminal.
|
|
void Print() const;
|
|
|
|
// Fill the screen with space and reset any screen state, like hyperlinks, and
|
|
// cursor
|
|
void Clear();
|
|
|
|
// Move the terminal cursor n-lines up with n = dimy().
|
|
std::string ResetPosition(bool clear = false) const;
|
|
|
|
void ApplyShader();
|
|
|
|
struct Cursor {
|
|
int x = 0;
|
|
int y = 0;
|
|
|
|
enum Shape {
|
|
Hidden = 0,
|
|
BlockBlinking = 1,
|
|
Block = 2,
|
|
UnderlineBlinking = 3,
|
|
Underline = 4,
|
|
BarBlinking = 5,
|
|
Bar = 6,
|
|
};
|
|
Shape shape = Hidden;
|
|
};
|
|
|
|
Cursor cursor() const { return cursor_; }
|
|
void SetCursor(Cursor cursor) { cursor_ = cursor; }
|
|
|
|
// Store an hyperlink in the screen. Return the id of the hyperlink. The id is
|
|
// used to identify the hyperlink when the user click on it.
|
|
uint8_t RegisterHyperlink(const std::string& link);
|
|
const std::string& Hyperlink(uint8_t id) const;
|
|
|
|
using SelectionStyle = std::function<void(Pixel&)>;
|
|
const SelectionStyle& GetSelectionStyle() const;
|
|
void SetSelectionStyle(SelectionStyle decorator);
|
|
|
|
protected:
|
|
Cursor cursor_;
|
|
std::vector<std::string> hyperlinks_ = {""};
|
|
|
|
// The current selection style. This is overridden by various dom elements.
|
|
SelectionStyle selection_style_ = [](Pixel& pixel) {
|
|
pixel.inverted ^= true;
|
|
};
|
|
};
|
|
|
|
} // namespace ftxui
|
|
|
|
#endif // FTXUI_SCREEN_SCREEN_HPP
|