2020-01-18 08:38:21 +00:00
|
|
|
/*
|
2021-08-07 10:36:21 +00:00
|
|
|
* Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
|
2021-04-16 19:58:51 +00:00
|
|
|
* Copyright (c) 2021, Liav A. <liavalb@hotmail.co.il>
|
2020-01-18 08:38:21 +00:00
|
|
|
*
|
2021-04-22 08:24:48 +00:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
2020-01-18 08:38:21 +00:00
|
|
|
*/
|
|
|
|
|
2018-10-30 12:59:29 +00:00
|
|
|
#pragma once
|
|
|
|
|
2021-04-16 19:58:51 +00:00
|
|
|
#include <AK/Noncopyable.h>
|
|
|
|
#include <AK/NonnullOwnPtrVector.h>
|
|
|
|
#include <AK/String.h>
|
|
|
|
#include <AK/Vector.h>
|
|
|
|
#include <Kernel/API/KeyCode.h>
|
2021-04-24 14:50:35 +00:00
|
|
|
#include <Kernel/ConsoleDevice.h>
|
2021-04-02 20:21:35 +00:00
|
|
|
#include <Kernel/Devices/HID/HIDManagement.h>
|
2021-04-16 19:58:51 +00:00
|
|
|
#include <Kernel/Graphics/Console/Console.h>
|
2019-05-28 09:53:16 +00:00
|
|
|
#include <Kernel/TTY/TTY.h>
|
2021-04-16 19:58:51 +00:00
|
|
|
#include <LibVT/Attribute.h>
|
2021-05-27 17:19:30 +00:00
|
|
|
#include <LibVT/Color.h>
|
2021-04-16 19:58:51 +00:00
|
|
|
#include <LibVT/Position.h>
|
2020-05-26 21:35:14 +00:00
|
|
|
#include <LibVT/Terminal.h>
|
2018-10-30 12:59:29 +00:00
|
|
|
|
2020-02-16 00:27:42 +00:00
|
|
|
namespace Kernel {
|
|
|
|
|
2021-04-16 19:58:51 +00:00
|
|
|
class ConsoleManagement;
|
|
|
|
class VirtualConsole;
|
|
|
|
// FIXME: This implementation has no knowledge about keeping terminal history...
|
|
|
|
class ConsoleImpl final : public VT::Terminal {
|
|
|
|
public:
|
|
|
|
explicit ConsoleImpl(VirtualConsole&);
|
|
|
|
|
|
|
|
virtual void set_size(u16 columns, u16 rows) override;
|
|
|
|
|
|
|
|
private:
|
|
|
|
virtual void invalidate_cursor() override;
|
|
|
|
virtual void clear() override;
|
2021-06-05 07:29:49 +00:00
|
|
|
virtual void clear_history() override;
|
2021-04-16 19:58:51 +00:00
|
|
|
|
2021-06-02 13:36:31 +00:00
|
|
|
virtual void scroll_up(u16 region_top, u16 region_bottom, size_t count) override;
|
|
|
|
virtual void scroll_down(u16 region_top, u16 region_bottom, size_t count) override;
|
2021-06-05 13:11:45 +00:00
|
|
|
virtual void scroll_left(u16 row, u16 column, size_t count) override;
|
|
|
|
virtual void scroll_right(u16 row, u16 column, size_t count) override;
|
2021-04-16 19:58:51 +00:00
|
|
|
virtual void put_character_at(unsigned row, unsigned column, u32 ch) override;
|
2021-06-05 09:12:00 +00:00
|
|
|
virtual void clear_in_line(u16 row, u16 first_column, u16 last_column) override;
|
2021-04-16 19:58:51 +00:00
|
|
|
};
|
2020-07-15 02:13:29 +00:00
|
|
|
|
2019-05-28 09:53:16 +00:00
|
|
|
class VirtualConsole final : public TTY
|
|
|
|
, public KeyboardClient
|
2020-05-26 21:35:14 +00:00
|
|
|
, public VT::TerminalClient {
|
2018-10-31 22:19:15 +00:00
|
|
|
AK_MAKE_ETERNAL
|
2021-04-16 19:58:51 +00:00
|
|
|
friend class ConsoleManagement;
|
|
|
|
friend class ConsoleImpl;
|
|
|
|
friend class VT::Terminal;
|
|
|
|
|
2018-10-30 12:59:29 +00:00
|
|
|
public:
|
2021-04-16 19:58:51 +00:00
|
|
|
struct Line {
|
|
|
|
bool dirty;
|
2021-05-18 18:34:22 +00:00
|
|
|
size_t length;
|
2021-04-16 19:58:51 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct Cell {
|
|
|
|
void clear()
|
|
|
|
{
|
|
|
|
ch = ' ';
|
|
|
|
attribute.reset();
|
|
|
|
}
|
|
|
|
char ch;
|
|
|
|
VT::Attribute attribute;
|
|
|
|
};
|
|
|
|
|
|
|
|
public:
|
|
|
|
static NonnullRefPtr<VirtualConsole> create(size_t index);
|
2021-05-14 13:39:28 +00:00
|
|
|
static NonnullRefPtr<VirtualConsole> create_with_preset_log(size_t index, const CircularQueue<char, 16384>&);
|
2021-04-16 19:58:51 +00:00
|
|
|
|
2018-10-30 12:59:29 +00:00
|
|
|
virtual ~VirtualConsole() override;
|
|
|
|
|
2021-04-16 19:58:51 +00:00
|
|
|
size_t index() const { return m_index; }
|
2018-10-30 12:59:29 +00:00
|
|
|
|
2021-05-18 18:34:22 +00:00
|
|
|
void refresh_after_resolution_change();
|
|
|
|
|
2019-08-18 02:04:09 +00:00
|
|
|
bool is_graphical() { return m_graphical; }
|
2020-02-18 10:46:52 +00:00
|
|
|
void set_graphical(bool graphical);
|
2019-08-18 02:04:09 +00:00
|
|
|
|
2021-04-16 19:58:51 +00:00
|
|
|
void emit_char(char);
|
|
|
|
|
2018-10-30 12:59:29 +00:00
|
|
|
private:
|
2021-05-14 13:39:28 +00:00
|
|
|
explicit VirtualConsole(const unsigned index);
|
|
|
|
VirtualConsole(const unsigned index, const CircularQueue<char, 16384>&);
|
2018-10-30 12:59:29 +00:00
|
|
|
// ^KeyboardClient
|
2021-04-02 20:21:35 +00:00
|
|
|
virtual void on_key_pressed(KeyEvent) override;
|
2018-10-30 12:59:29 +00:00
|
|
|
|
2018-10-30 14:33:37 +00:00
|
|
|
// ^TTY
|
2021-06-16 13:20:35 +00:00
|
|
|
virtual KResultOr<size_t> on_tty_write(const UserOrKernelBuffer&, size_t) override;
|
2021-05-12 20:47:06 +00:00
|
|
|
virtual String const& tty_name() const override { return m_tty_name; }
|
2019-10-30 12:11:41 +00:00
|
|
|
virtual void echo(u8) override;
|
2018-10-30 14:33:37 +00:00
|
|
|
|
2020-05-26 21:35:14 +00:00
|
|
|
// ^TerminalClient
|
|
|
|
virtual void beep() override;
|
|
|
|
virtual void set_window_title(const StringView&) override;
|
2020-05-30 20:11:35 +00:00
|
|
|
virtual void set_window_progress(int, int) override;
|
2020-05-26 21:35:14 +00:00
|
|
|
virtual void terminal_did_resize(u16 columns, u16 rows) override;
|
2021-06-05 14:46:33 +00:00
|
|
|
virtual void terminal_history_changed(int) override;
|
2020-05-26 21:35:14 +00:00
|
|
|
virtual void emit(const u8*, size_t) override;
|
2021-05-24 07:36:41 +00:00
|
|
|
virtual void set_cursor_style(VT::CursorStyle) override;
|
2020-05-26 21:35:14 +00:00
|
|
|
|
2019-01-21 01:33:01 +00:00
|
|
|
// ^CharacterDevice
|
2021-07-10 23:46:09 +00:00
|
|
|
virtual StringView class_name() const override { return "VirtualConsole"; }
|
2019-01-21 01:33:01 +00:00
|
|
|
|
2021-01-21 17:49:56 +00:00
|
|
|
// ^Device
|
|
|
|
virtual String device_name() const override;
|
|
|
|
|
2018-11-01 13:09:21 +00:00
|
|
|
void set_active(bool);
|
2020-05-26 21:35:14 +00:00
|
|
|
void flush_dirty_lines();
|
2018-11-10 15:25:59 +00:00
|
|
|
|
2018-10-30 12:59:29 +00:00
|
|
|
unsigned m_index;
|
|
|
|
bool m_active { false };
|
2019-08-18 02:04:09 +00:00
|
|
|
bool m_graphical { false };
|
2018-10-30 12:59:29 +00:00
|
|
|
|
2021-04-16 19:58:51 +00:00
|
|
|
String m_tty_name;
|
2018-11-09 20:18:03 +00:00
|
|
|
|
2021-04-16 19:58:51 +00:00
|
|
|
private:
|
2021-05-14 13:39:28 +00:00
|
|
|
void initialize();
|
|
|
|
|
2021-04-16 19:58:51 +00:00
|
|
|
void invalidate_cursor(size_t row);
|
2020-05-26 21:35:14 +00:00
|
|
|
|
2021-04-16 19:58:51 +00:00
|
|
|
void clear();
|
|
|
|
|
|
|
|
void inject_string(const StringView&);
|
|
|
|
|
|
|
|
Cell& cell_at(size_t column, size_t row);
|
|
|
|
|
|
|
|
typedef Vector<unsigned, 4> ParamVector;
|
|
|
|
|
|
|
|
void on_code_point(u32);
|
|
|
|
|
2021-06-02 13:36:31 +00:00
|
|
|
void scroll_down(u16 region_top, u16 region_bottom, size_t count);
|
|
|
|
void scroll_up(u16 region_top, u16 region_bottom, size_t count);
|
2021-06-05 13:11:45 +00:00
|
|
|
void scroll_left(u16 row, u16 column, size_t count);
|
|
|
|
void scroll_right(u16 row, u16 column, size_t count);
|
2021-06-05 09:12:00 +00:00
|
|
|
void clear_line(size_t index)
|
|
|
|
{
|
|
|
|
clear_in_line(index, 0, m_console_impl.columns() - 1);
|
|
|
|
}
|
|
|
|
void clear_in_line(u16 row, u16 first_column, u16 last_column);
|
2021-04-16 19:58:51 +00:00
|
|
|
void put_character_at(unsigned row, unsigned column, u32 ch, const VT::Attribute&);
|
|
|
|
|
2021-08-06 11:49:36 +00:00
|
|
|
OwnPtr<Memory::Region> m_cells;
|
2021-04-16 19:58:51 +00:00
|
|
|
Vector<VirtualConsole::Line> m_lines;
|
|
|
|
ConsoleImpl m_console_impl;
|
2018-10-30 12:59:29 +00:00
|
|
|
};
|
2020-02-16 00:27:42 +00:00
|
|
|
|
|
|
|
}
|