1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-27 04:57:45 +00:00

LibVT: Factor out terminal emulation from Terminal to make it reusable

Now that we're bringing back the in-kernel virtual console, we should
move towards having a single implementation of terminal emulation.

This patch rips out the emulation code from the Terminal application
and turns it into the beginnings of LibVT.

The basic design idea is that users of VT::Terminal will implement and
provide a VT::TerminalClient subclass to handle presentation-specific
things. We'll need to iterate on this, but it's a start. :^)
This commit is contained in:
Andreas Kling 2019-08-12 17:32:16 +02:00
parent 4b44962e03
commit b24b111298
8 changed files with 1236 additions and 1141 deletions

View file

@ -3,7 +3,7 @@ DEFINES += -DUSERLAND
all: $(APP)
$(APP): $(OBJS)
$(LD) -o $(APP) $(LDFLAGS) $(OBJS) -lgui -ldraw -laudio -lipc -lcore -lc
$(LD) -o $(APP) $(LDFLAGS) $(OBJS) -lgui -ldraw -laudio -lipc -lvt -lcore -lc
.cpp.o:
@echo "CXX $<"; $(CXX) $(CXXFLAGS) -o $@ -c $<

File diff suppressed because it is too large Load diff

View file

@ -1,68 +1,22 @@
#pragma once
#include <AK/AKString.h>
#include <AK/NonnullOwnPtrVector.h>
#include <AK/Types.h>
#include <LibCore/CConfigFile.h>
#include <LibCore/CNotifier.h>
#include <LibCore/CTimer.h>
#include <LibDraw/GraphicsBitmap.h>
#include <LibDraw/Rect.h>
#include <LibGUI/GFrame.h>
#include <LibVT/Terminal.h>
class Font;
class BufferPosition {
public:
BufferPosition() {}
BufferPosition(int row, int column)
: m_row(row)
, m_column(column)
{
}
bool is_valid() const { return m_row >= 0 && m_column >= 0; }
int row() const { return m_row; }
int column() const { return m_column; }
bool operator<(const BufferPosition& other) const
{
return m_row < other.m_row || (m_row == other.m_row && m_column < other.m_column);
}
bool operator<=(const BufferPosition& other) const
{
return *this < other || *this == other;
}
bool operator>=(const BufferPosition& other) const
{
return !(*this < other);
}
bool operator==(const BufferPosition& other) const
{
return m_row == other.m_row && m_column == other.m_column;
}
bool operator!=(const BufferPosition& other) const
{
return !(*this == other);
}
private:
int m_row { -1 };
int m_column { -1 };
};
class Terminal final : public GFrame {
class Terminal final : public GFrame
, public VT::TerminalClient {
C_OBJECT(Terminal)
public:
explicit Terminal(int ptm_fd, RefPtr<CConfigFile> config);
virtual ~Terminal() override;
void create_window();
void on_char(u8);
void flush_dirty_lines();
void force_repaint();
@ -77,15 +31,14 @@ public:
RefPtr<CConfigFile> config() const { return m_config; }
bool has_selection() const;
bool selection_contains(const BufferPosition&) const;
bool selection_contains(const VT::BufferPosition&) const;
String selected_text() const;
BufferPosition buffer_position_at(const Point&) const;
BufferPosition normalized_selection_start() const;
BufferPosition normalized_selection_end() const;
VT::BufferPosition buffer_position_at(const Point&) const;
VT::BufferPosition normalized_selection_start() const;
VT::BufferPosition normalized_selection_end() const;
private:
typedef Vector<unsigned, 4> ParamVector;
// ^GWidget
virtual void event(CEvent&) override;
virtual void paint_event(GPaintEvent&) override;
virtual void resize_event(GResizeEvent&) override;
@ -94,155 +47,24 @@ private:
virtual void mousemove_event(GMouseEvent&) override;
virtual void mouseup_event(GMouseEvent&) override;
void scroll_up();
void scroll_down();
void newline();
void set_cursor(unsigned row, unsigned column);
void put_character_at(unsigned row, unsigned column, u8 ch);
void invalidate_cursor();
void set_window_title(const String&);
// ^TerminalClient
virtual void beep() override;
virtual void set_window_title(const StringView&) override;
virtual void terminal_did_resize(u16 columns, u16 rows) override;
void inject_string(const String&);
void unimplemented_escape();
void unimplemented_xterm_escape();
void escape$A(const ParamVector&);
void escape$B(const ParamVector&);
void escape$C(const ParamVector&);
void escape$D(const ParamVector&);
void escape$H(const ParamVector&);
void escape$J(const ParamVector&);
void escape$K(const ParamVector&);
void escape$M(const ParamVector&);
void escape$P(const ParamVector&);
void escape$G(const ParamVector&);
void escape$X(const ParamVector&);
void escape$b(const ParamVector&);
void escape$d(const ParamVector&);
void escape$m(const ParamVector&);
void escape$s(const ParamVector&);
void escape$u(const ParamVector&);
void escape$t(const ParamVector&);
void escape$r(const ParamVector&);
void escape$S(const ParamVector&);
void escape$T(const ParamVector&);
void escape$L(const ParamVector&);
void escape$h_l(bool, bool, const ParamVector&);
void clear();
void set_size(u16 columns, u16 rows);
u16 columns() const { return m_columns; }
u16 rows() const { return m_rows; }
Rect glyph_rect(u16 row, u16 column);
Rect row_rect(u16 row);
void update_cursor();
void invalidate_cursor();
struct Attribute {
Attribute() { reset(); }
VT::Terminal m_terminal;
static u8 default_foreground_color;
static u8 default_background_color;
void reset()
{
foreground_color = default_foreground_color;
background_color = default_background_color;
flags = Flags::NoAttributes;
}
u8 foreground_color;
u8 background_color;
enum Flags {
NoAttributes = 0x00,
Bold = 0x01,
Italic = 0x02,
Underline = 0x04,
Negative = 0x08,
Blink = 0x10,
Touched = 0x20,
};
bool is_untouched() const { return !(flags & Touched); }
// TODO: it would be really nice if we had a helper for enums that
// exposed bit ops for class enums...
int flags = Flags::NoAttributes;
bool operator==(const Attribute& other) const
{
return foreground_color == other.foreground_color && background_color == other.background_color && flags == other.flags;
}
bool operator!=(const Attribute& other) const
{
return !(*this == other);
}
};
struct Line {
explicit Line(u16 columns);
~Line();
void clear(Attribute);
bool has_only_one_background_color() const;
void set_length(u16);
u8* characters { nullptr };
Attribute* attributes { nullptr };
bool dirty { false };
u16 m_length { 0 };
};
Line& line(size_t index)
{
ASSERT(index < m_rows);
return m_lines[index];
}
const Line& line(size_t index) const
{
ASSERT(index < m_rows);
return m_lines[index];
}
NonnullOwnPtrVector<Line> m_lines;
BufferPosition m_selection_start;
BufferPosition m_selection_end;
int m_scroll_region_top { 0 };
int m_scroll_region_bottom { 0 };
u16 m_columns { 0 };
u16 m_rows { 0 };
u16 m_cursor_row { 0 };
u16 m_cursor_column { 0 };
u16 m_saved_cursor_row { 0 };
u16 m_saved_cursor_column { 0 };
bool m_stomp { false };
VT::BufferPosition m_selection_start;
VT::BufferPosition m_selection_end;
bool m_should_beep { false };
Attribute m_current_attribute;
void execute_escape_sequence(u8 final);
void execute_xterm_command();
enum EscapeState {
Normal,
ExpectBracket,
ExpectParameter,
ExpectIntermediate,
ExpectFinal,
ExpectXtermParameter1,
ExpectXtermParameter2,
ExpectXtermFinal,
};
EscapeState m_escape_state { Normal };
Vector<u8> m_parameters;
Vector<u8> m_intermediates;
Vector<u8> m_xterm_param1;
Vector<u8> m_xterm_param2;
Vector<bool> m_horizontal_tabs;
u8 m_final { 0 };
bool m_belling { false };
int m_pixel_width { 0 };
@ -254,10 +76,7 @@ private:
int m_ptm_fd { -1 };
bool m_swallow_current { false };
bool m_in_active_window { false };
bool m_need_full_flush { false };
CNotifier m_notifier;
@ -270,6 +89,4 @@ private:
CTimer m_cursor_blink_timer;
CTimer m_visual_beep_timer;
RefPtr<CConfigFile> m_config;
u8 m_last_char { 0 };
};