/* * Copyright (c) 2018-2020, Andreas Kling * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * 1. Redistributions of source code must retain the above copyright notice, this * list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #include #include #include //#define TERMINAL_DEBUG namespace VT { Terminal::Terminal(TerminalClient& client) : m_client(client) { } Terminal::~Terminal() { } Terminal::Line::Line(u16 length) { set_length(length); } Terminal::Line::~Line() { delete[] characters; delete[] attributes; } void Terminal::Line::set_length(u16 new_length) { if (m_length == new_length) return; auto* new_characters = new u8[new_length]; auto* new_attributes = new Attribute[new_length]; memset(new_characters, ' ', new_length); if (characters && attributes) { memcpy(new_characters, characters, min(m_length, new_length)); memcpy(new_attributes, attributes, min(m_length, new_length) * sizeof(Attribute)); } delete[] characters; delete[] attributes; characters = new_characters; attributes = new_attributes; m_length = new_length; } void Terminal::Line::clear(Attribute attribute) { if (dirty) { memset(characters, ' ', m_length); for (u16 i = 0; i < m_length; ++i) attributes[i] = attribute; return; } for (unsigned i = 0; i < m_length; ++i) { if (characters[i] != ' ') dirty = true; characters[i] = ' '; } for (unsigned i = 0; i < m_length; ++i) { if (attributes[i] != attribute) dirty = true; attributes[i] = attribute; } } bool Terminal::Line::has_only_one_background_color() const { if (!m_length) return true; // FIXME: Cache this result? auto color = attributes[0].background_color; for (size_t i = 1; i < m_length; ++i) { if (attributes[i].background_color != color) return false; } return true; } void Terminal::clear() { for (size_t i = 0; i < rows(); ++i) line(i).clear(m_current_attribute); set_cursor(0, 0); } inline bool is_valid_parameter_character(u8 ch) { return ch >= 0x30 && ch <= 0x3f; } inline bool is_valid_intermediate_character(u8 ch) { return ch >= 0x20 && ch <= 0x2f; } inline bool is_valid_final_character(u8 ch) { return ch >= 0x40 && ch <= 0x7e; } void Terminal::alter_mode(bool should_set, bool question_param, const ParamVector& params) { int mode = 2; if (params.size() > 0) { mode = params[0]; } if (!question_param) { switch (mode) { // FIXME: implement *something* for this default: unimplemented_escape(); break; } } else { switch (mode) { case 25: // Hide cursor command, but doesn't need to be run (for now, because // we don't do inverse control codes anyways) if (should_set) dbgprintf("Terminal: Hide Cursor escapecode recieved. Not needed: ignored.\n"); else dbgprintf("Terminal: Show Cursor escapecode recieved. Not needed: ignored.\n"); break; default: break; } } } void Terminal::RM(bool question_param, const ParamVector& params) { // RM – Reset Mode alter_mode(true, question_param, params); } void Terminal::SM(bool question_param, const ParamVector& params) { // SM – Set Mode alter_mode(false, question_param, params); } void Terminal::SGR(const ParamVector& params) { // SGR – Select Graphic Rendition if (params.is_empty()) { m_current_attribute.reset(); return; } if (params.size() == 3 && params[1] == 5) { if (params[0] == 38) { m_current_attribute.foreground_color = params[2]; return; } else if (params[0] == 48) { m_current_attribute.background_color = params[2]; return; } } for (auto param : params) { switch (param) { case 0: // Reset m_current_attribute.reset(); break; case 1: m_current_attribute.flags |= Attribute::Bold; break; case 3: m_current_attribute.flags |= Attribute::Italic; break; case 4: m_current_attribute.flags |= Attribute::Underline; break; case 5: m_current_attribute.flags |= Attribute::Blink; break; case 7: m_current_attribute.flags |= Attribute::Negative; break; case 22: m_current_attribute.flags &= ~Attribute::Bold; break; case 23: m_current_attribute.flags &= ~Attribute::Italic; break; case 24: m_current_attribute.flags &= ~Attribute::Underline; break; case 25: m_current_attribute.flags &= ~Attribute::Blink; break; case 27: m_current_attribute.flags &= ~Attribute::Negative; break; case 30: case 31: case 32: case 33: case 34: case 35: case 36: case 37: // Foreground color if (m_current_attribute.flags & Attribute::Bold) param += 8; m_current_attribute.foreground_color = param - 30; break; case 39: // reset foreground m_current_attribute.foreground_color = Attribute::default_foreground_color; break; case 40: case 41: case 42: case 43: case 44: case 45: case 46: case 47: // Background color if (m_current_attribute.flags & Attribute::Bold) param += 8; m_current_attribute.background_color = param - 40; break; case 49: // reset background m_current_attribute.background_color = Attribute::default_background_color; break; default: dbgprintf("FIXME: SGR: p: %u\n", param); } } } void Terminal::escape$s(const ParamVector&) { m_saved_cursor_row = m_cursor_row; m_saved_cursor_column = m_cursor_column; } void Terminal::escape$u(const ParamVector&) { set_cursor(m_saved_cursor_row, m_saved_cursor_column); } void Terminal::escape$t(const ParamVector& params) { if (params.size() < 1) return; dbgprintf("FIXME: escape$t: Ps: %u (param count: %d)\n", params[0], params.size()); } void Terminal::DECSTBM(const ParamVector& params) { // DECSTBM – Set Top and Bottom Margins ("Scrolling Region") unsigned top = 1; unsigned bottom = m_rows; if (params.size() >= 1) top = params[0]; if (params.size() >= 2) bottom = params[1]; if ((bottom - top) < 2 || bottom > m_rows) { dbgprintf("Error: DECSTBM: scrolling region invalid: %u-%u\n", top, bottom); return; } m_scroll_region_top = top - 1; m_scroll_region_bottom = bottom - 1; set_cursor(0, 0); } void Terminal::CUP(const ParamVector& params) { // CUP – Cursor Position unsigned row = 1; unsigned col = 1; if (params.size() >= 1) row = params[0]; if (params.size() >= 2) col = params[1]; set_cursor(row - 1, col - 1); } void Terminal::HVP(const ParamVector& params) { // HVP – Horizontal and Vertical Position unsigned row = 1; unsigned col = 1; if (params.size() >= 1) row = params[0]; if (params.size() >= 2) col = params[1]; set_cursor(row - 1, col - 1); } void Terminal::CUU(const ParamVector& params) { // CUU – Cursor Up int num = 1; if (params.size() >= 1) num = params[0]; if (num == 0) num = 1; int new_row = (int)m_cursor_row - num; if (new_row < 0) new_row = 0; set_cursor(new_row, m_cursor_column); } void Terminal::CUD(const ParamVector& params) { // CUD – Cursor Down int num = 1; if (params.size() >= 1) num = params[0]; if (num == 0) num = 1; int new_row = (int)m_cursor_row + num; if (new_row >= m_rows) new_row = m_rows - 1; set_cursor(new_row, m_cursor_column); } void Terminal::CUF(const ParamVector& params) { // CUF – Cursor Forward int num = 1; if (params.size() >= 1) num = params[0]; if (num == 0) num = 1; int new_column = (int)m_cursor_column + num; if (new_column >= m_columns) new_column = m_columns - 1; set_cursor(m_cursor_row, new_column); } void Terminal::CUB(const ParamVector& params) { // CUB – Cursor Backward int num = 1; if (params.size() >= 1) num = params[0]; if (num == 0) num = 1; int new_column = (int)m_cursor_column - num; if (new_column < 0) new_column = 0; set_cursor(m_cursor_row, new_column); } void Terminal::escape$G(const ParamVector& params) { int new_column = 1; if (params.size() >= 1) new_column = params[0] - 1; if (new_column < 0) new_column = 0; set_cursor(m_cursor_row, new_column); } void Terminal::escape$b(const ParamVector& params) { if (params.size() < 1) return; for (unsigned i = 0; i < params[0]; ++i) put_character_at(m_cursor_row, m_cursor_column++, m_last_char); } void Terminal::escape$d(const ParamVector& params) { int new_row = 1; if (params.size() >= 1) new_row = params[0] - 1; if (new_row < 0) new_row = 0; set_cursor(new_row, m_cursor_column); } void Terminal::escape$X(const ParamVector& params) { // Erase characters (without moving cursor) int num = 1; if (params.size() >= 1) num = params[0]; if (num == 0) num = 1; // Clear from cursor to end of line. for (int i = m_cursor_column; i < num; ++i) { put_character_at(m_cursor_row, i, ' '); } } void Terminal::EL(const ParamVector& params) { int mode = 0; if (params.size() >= 1) mode = params[0]; switch (mode) { case 0: // Clear from cursor to end of line. for (int i = m_cursor_column; i < m_columns; ++i) { put_character_at(m_cursor_row, i, ' '); } break; case 1: // Clear from cursor to beginning of line. for (int i = 0; i <= m_cursor_column; ++i) { put_character_at(m_cursor_row, i, ' '); } break; case 2: // Clear the complete line for (int i = 0; i < m_columns; ++i) { put_character_at(m_cursor_row, i, ' '); } break; default: unimplemented_escape(); break; } } void Terminal::ED(const ParamVector& params) { // ED - Erase in Display int mode = 0; if (params.size() >= 1) mode = params[0]; switch (mode) { case 0: // Clear from cursor to end of screen. for (int i = m_cursor_column; i < m_columns; ++i) put_character_at(m_cursor_row, i, ' '); for (int row = m_cursor_row + 1; row < m_rows; ++row) { for (int column = 0; column < m_columns; ++column) { put_character_at(row, column, ' '); } } break; case 1: // Clear from cursor to beginning of screen. for (int i = m_cursor_column; i >= 0; --i) put_character_at(m_cursor_row, i, ' '); for (int row = m_cursor_row - 1; row >= 0; --row) { for (int column = 0; column < m_columns; ++column) { put_character_at(row, column, ' '); } } break; case 2: clear(); break; case 3: // FIXME: [3J should also clear the scrollback buffer. clear(); break; default: unimplemented_escape(); break; } } void Terminal::escape$S(const ParamVector& params) { int count = 1; if (params.size() >= 1) count = params[0]; for (u16 i = 0; i < count; i++) scroll_up(); } void Terminal::escape$T(const ParamVector& params) { int count = 1; if (params.size() >= 1) count = params[0]; for (u16 i = 0; i < count; i++) scroll_down(); } void Terminal::escape$L(const ParamVector& params) { int count = 1; if (params.size() >= 1) count = params[0]; invalidate_cursor(); for (; count > 0; --count) { m_lines.insert(m_cursor_row + m_scroll_region_top, make(m_columns)); if (m_scroll_region_bottom + 1 < m_lines.size()) m_lines.remove(m_scroll_region_bottom + 1); else m_lines.remove(m_lines.size() - 1); } m_need_full_flush = true; } void Terminal::DA(const ParamVector&) { // DA - Device Attributes emit_string("\033[?1;0c"); } void Terminal::escape$M(const ParamVector& params) { int count = 1; if (params.size() >= 1) count = params[0]; if (count == 1 && m_cursor_row == 0) { scroll_up(); return; } int max_count = m_rows - (m_scroll_region_top + m_cursor_row); count = min(count, max_count); for (int c = count; c > 0; --c) { m_lines.remove(m_cursor_row + m_scroll_region_top); if (m_scroll_region_bottom < m_lines.size()) m_lines.insert(m_scroll_region_bottom, make(m_columns)); else m_lines.append(make(m_columns)); } } void Terminal::escape$P(const ParamVector& params) { int num = 1; if (params.size() >= 1) num = params[0]; if (num == 0) num = 1; auto& line = this->line(m_cursor_row); // Move n characters of line to the left for (int i = m_cursor_column; i < line.m_length - num; i++) line.characters[i] = line.characters[i + num]; // Fill remainder of line with blanks for (int i = line.m_length - num; i < line.m_length; i++) line.characters[i] = ' '; line.dirty = true; } void Terminal::execute_xterm_command() { m_final = '@'; bool ok; unsigned value = String::copy(m_xterm_param1).to_uint(ok); if (ok) { switch (value) { case 0: case 1: case 2: m_client.set_window_title(String::copy(m_xterm_param2)); break; default: unimplemented_xterm_escape(); break; } } m_xterm_param1.clear_with_capacity(); m_xterm_param2.clear_with_capacity(); } void Terminal::execute_escape_sequence(u8 final) { bool question_param = false; m_final = final; ParamVector params; if (m_parameters.size() > 0 && m_parameters[0] == '?') { question_param = true; m_parameters.remove(0); } auto paramparts = String::copy(m_parameters).split(';'); for (auto& parampart : paramparts) { bool ok; unsigned value = parampart.to_uint(ok); if (!ok) { // FIXME: Should we do something else? m_parameters.clear_with_capacity(); m_intermediates.clear_with_capacity(); return; } params.append(value); } #if defined(TERMINAL_DEBUG) dbgprintf("Terminal::execute_escape_sequence: Handled final '%c'\n", final); dbgprintf("Params: "); for (auto& p : params) { dbgprintf("%d ", p); } dbgprintf("\b\n"); #endif switch (final) { case 'A': CUU(params); break; case 'B': CUD(params); break; case 'C': CUF(params); break; case 'D': CUB(params); break; case 'H': CUP(params); break; case 'J': ED(params); break; case 'K': EL(params); break; case 'M': escape$M(params); break; case 'P': escape$P(params); break; case 'S': escape$S(params); break; case 'T': escape$T(params); break; case 'L': escape$L(params); break; case 'G': escape$G(params); break; case 'X': escape$X(params); break; case 'b': escape$b(params); break; case 'd': escape$d(params); break; case 'm': SGR(params); break; case 's': escape$s(params); break; case 'u': escape$u(params); break; case 't': escape$t(params); break; case 'r': DECSTBM(params); break; case 'l': RM(question_param, params); break; case 'h': SM(question_param, params); break; case 'c': DA(params); break; case 'f': HVP(params); break; default: dbgprintf("Terminal::execute_escape_sequence: Unhandled final '%c'\n", final); break; } #if defined(TERMINAL_DEBUG) dbgprintf("\n"); for (auto& line : m_lines) { dbgprintf("Terminal: Line: "); for (int i = 0; i < line.m_length; i++) { dbgprintf("%c", line.characters[i]); } dbgprintf("\n"); } #endif m_parameters.clear_with_capacity(); m_intermediates.clear_with_capacity(); } void Terminal::newline() { u16 new_row = m_cursor_row; if (m_cursor_row == m_scroll_region_bottom) { scroll_up(); } else { ++new_row; } set_cursor(new_row, 0); } void Terminal::scroll_up() { // NOTE: We have to invalidate the cursor first. invalidate_cursor(); if (m_scroll_region_top == 0) { auto line = move(m_lines.ptr_at(m_scroll_region_top)); m_history.append(move(line)); while (m_history.size() > max_history_size()) m_history.take_first(); m_client.terminal_history_changed(); } m_lines.remove(m_scroll_region_top); m_lines.insert(m_scroll_region_bottom, make(m_columns)); m_need_full_flush = true; } void Terminal::scroll_down() { // NOTE: We have to invalidate the cursor first. invalidate_cursor(); m_lines.remove(m_scroll_region_bottom); m_lines.insert(m_scroll_region_top, make(m_columns)); m_need_full_flush = true; } void Terminal::set_cursor(unsigned a_row, unsigned a_column) { unsigned row = min(a_row, m_rows - 1u); unsigned column = min(a_column, m_columns - 1u); if (row == m_cursor_row && column == m_cursor_column) return; ASSERT(row < rows()); ASSERT(column < columns()); invalidate_cursor(); m_cursor_row = row; m_cursor_column = column; m_stomp = false; invalidate_cursor(); } void Terminal::put_character_at(unsigned row, unsigned column, u8 ch) { ASSERT(row < rows()); ASSERT(column < columns()); auto& line = this->line(row); line.characters[column] = ch; line.attributes[column] = m_current_attribute; line.attributes[column].flags |= Attribute::Touched; line.dirty = true; m_last_char = ch; } void Terminal::NEL() { // NEL - Next Line newline(); } void Terminal::IND() { // IND - Index (move down) CUD({}); } void Terminal::RI() { // RI - Reverse Index (move up) CUU({}); } void Terminal::on_char(u8 ch) { #ifdef TERMINAL_DEBUG dbgprintf("Terminal::on_char: %b (%c), fg=%u, bg=%u\n", ch, ch, m_current_attribute.foreground_color, m_current_attribute.background_color); #endif switch (m_escape_state) { case GotEscape: if (ch == '[') { m_escape_state = ExpectParameter; } else if (ch == '(') { m_swallow_current = true; m_escape_state = ExpectParameter; } else if (ch == ']') { m_escape_state = ExpectXtermParameter1; } else if (ch == '#') { m_escape_state = ExpectHashtagDigit; } else if (ch == 'D') { IND(); m_escape_state = Normal; return; } else if (ch == 'M') { RI(); m_escape_state = Normal; return; } else if (ch == 'E') { NEL(); m_escape_state = Normal; return; } else { dbg() << "Unexpected character in GotEscape '" << (char)ch << "'"; m_escape_state = Normal; } return; case ExpectHashtagDigit: if (ch >= '0' && ch <= '9') { execute_hashtag(ch); m_escape_state = Normal; } break; case ExpectXtermParameter1: if (ch != ';') { m_xterm_param1.append(ch); return; } m_escape_state = ExpectXtermParameter2; return; case ExpectXtermParameter2: if (ch != '\007') { m_xterm_param2.append(ch); return; } m_escape_state = ExpectXtermFinal; [[fallthrough]]; case ExpectXtermFinal: m_escape_state = Normal; if (ch == '\007') execute_xterm_command(); return; case ExpectParameter: if (is_valid_parameter_character(ch)) { m_parameters.append(ch); return; } m_escape_state = ExpectIntermediate; [[fallthrough]]; case ExpectIntermediate: if (is_valid_intermediate_character(ch)) { m_intermediates.append(ch); return; } m_escape_state = ExpectFinal; [[fallthrough]]; case ExpectFinal: if (is_valid_final_character(ch)) { m_escape_state = Normal; if (!m_swallow_current) execute_escape_sequence(ch); m_swallow_current = false; return; } m_escape_state = Normal; m_swallow_current = false; return; case Normal: break; } switch (ch) { case '\0': return; case '\033': m_escape_state = GotEscape; m_swallow_current = false; return; case 8: // Backspace if (m_cursor_column) { set_cursor(m_cursor_row, m_cursor_column - 1); return; } return; case '\a': m_client.beep(); return; case '\t': { for (unsigned i = m_cursor_column + 1; i < columns(); ++i) { if (m_horizontal_tabs[i]) { set_cursor(m_cursor_row, i); return; } } return; } case '\r': set_cursor(m_cursor_row, 0); return; case '\n': newline(); return; } auto new_column = m_cursor_column + 1; if (new_column < columns()) { put_character_at(m_cursor_row, m_cursor_column, ch); set_cursor(m_cursor_row, new_column); } else { if (m_stomp) { m_stomp = false; newline(); put_character_at(m_cursor_row, m_cursor_column, ch); set_cursor(m_cursor_row, 1); } else { // Curious: We wait once on the right-hand side m_stomp = true; put_character_at(m_cursor_row, m_cursor_column, ch); } } } void Terminal::inject_string(const StringView& str) { for (size_t i = 0; i < str.length(); ++i) on_char(str[i]); } void Terminal::emit_string(const StringView& str) { for (size_t i = 0; i < str.length(); ++i) m_client.emit_char(str[i]); } void Terminal::unimplemented_escape() { StringBuilder builder; builder.appendf("((Unimplemented escape: %c", m_final); if (!m_parameters.is_empty()) { builder.append(" parameters:"); for (size_t i = 0; i < m_parameters.size(); ++i) builder.append((char)m_parameters[i]); } if (!m_intermediates.is_empty()) { builder.append(" intermediates:"); for (size_t i = 0; i < m_intermediates.size(); ++i) builder.append((char)m_intermediates[i]); } builder.append("))"); inject_string(builder.to_string()); } void Terminal::unimplemented_xterm_escape() { auto message = String::format("((Unimplemented xterm escape: %c))\n", m_final); inject_string(message); } void Terminal::set_size(u16 columns, u16 rows) { if (!columns) columns = 1; if (!rows) rows = 1; if (columns == m_columns && rows == m_rows) return; #if defined(TERMINAL_DEBUG) dbgprintf("Terminal: RESIZE to: %d rows\n", rows); #endif if (rows > m_rows) { while (m_lines.size() < rows) m_lines.append(make(columns)); } else { m_lines.shrink(rows); } for (int i = 0; i < rows; ++i) m_lines[i].set_length(columns); m_columns = columns; m_rows = rows; m_scroll_region_top = 0; m_scroll_region_bottom = rows - 1; m_cursor_row = min((int)m_cursor_row, m_rows - 1); m_cursor_column = min((int)m_cursor_column, m_columns - 1); m_saved_cursor_row = min((int)m_saved_cursor_row, m_rows - 1); m_saved_cursor_column = min((int)m_saved_cursor_column, m_columns - 1); m_horizontal_tabs.resize(columns); for (unsigned i = 0; i < columns; ++i) m_horizontal_tabs[i] = (i % 8) == 0; // Rightmost column is always last tab on line. m_horizontal_tabs[columns - 1] = 1; m_client.terminal_did_resize(m_columns, m_rows); } void Terminal::invalidate_cursor() { line(m_cursor_row).dirty = true; } void Terminal::execute_hashtag(u8 hashtag) { switch (hashtag) { case '8': // Confidence Test - Fill screen with E's for (size_t row = 0; row < m_rows; ++row) { for (size_t column = 0; column < m_columns; ++column) { put_character_at(row, column, 'E'); } } break; default: dbg() << "Unknown hashtag: '" << hashtag << "'"; } } }