Terminal.cpp 26 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027
  1. /*
  2. * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
  3. * All rights reserved.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. *
  8. * 1. Redistributions of source code must retain the above copyright notice, this
  9. * list of conditions and the following disclaimer.
  10. *
  11. * 2. Redistributions in binary form must reproduce the above copyright notice,
  12. * this list of conditions and the following disclaimer in the documentation
  13. * and/or other materials provided with the distribution.
  14. *
  15. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  16. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  19. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  22. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  23. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25. */
  26. #include <AK/StringBuilder.h>
  27. #include <LibVT/Terminal.h>
  28. //#define TERMINAL_DEBUG
  29. namespace VT {
  30. Terminal::Terminal(TerminalClient& client)
  31. : m_client(client)
  32. {
  33. }
  34. Terminal::~Terminal()
  35. {
  36. }
  37. Terminal::Line::Line(u16 length)
  38. {
  39. set_length(length);
  40. }
  41. Terminal::Line::~Line()
  42. {
  43. delete[] characters;
  44. delete[] attributes;
  45. }
  46. void Terminal::Line::set_length(u16 new_length)
  47. {
  48. if (m_length == new_length)
  49. return;
  50. auto* new_characters = new u8[new_length];
  51. auto* new_attributes = new Attribute[new_length];
  52. memset(new_characters, ' ', new_length);
  53. if (characters && attributes) {
  54. memcpy(new_characters, characters, min(m_length, new_length));
  55. memcpy(new_attributes, attributes, min(m_length, new_length) * sizeof(Attribute));
  56. }
  57. delete[] characters;
  58. delete[] attributes;
  59. characters = new_characters;
  60. attributes = new_attributes;
  61. m_length = new_length;
  62. }
  63. void Terminal::Line::clear(Attribute attribute)
  64. {
  65. if (dirty) {
  66. memset(characters, ' ', m_length);
  67. for (u16 i = 0; i < m_length; ++i)
  68. attributes[i] = attribute;
  69. return;
  70. }
  71. for (unsigned i = 0; i < m_length; ++i) {
  72. if (characters[i] != ' ')
  73. dirty = true;
  74. characters[i] = ' ';
  75. }
  76. for (unsigned i = 0; i < m_length; ++i) {
  77. if (attributes[i] != attribute)
  78. dirty = true;
  79. attributes[i] = attribute;
  80. }
  81. }
  82. bool Terminal::Line::has_only_one_background_color() const
  83. {
  84. if (!m_length)
  85. return true;
  86. // FIXME: Cache this result?
  87. auto color = attributes[0].background_color;
  88. for (size_t i = 1; i < m_length; ++i) {
  89. if (attributes[i].background_color != color)
  90. return false;
  91. }
  92. return true;
  93. }
  94. void Terminal::clear()
  95. {
  96. for (size_t i = 0; i < rows(); ++i)
  97. line(i).clear(m_current_attribute);
  98. set_cursor(0, 0);
  99. }
  100. inline bool is_valid_parameter_character(u8 ch)
  101. {
  102. return ch >= 0x30 && ch <= 0x3f;
  103. }
  104. inline bool is_valid_intermediate_character(u8 ch)
  105. {
  106. return ch >= 0x20 && ch <= 0x2f;
  107. }
  108. inline bool is_valid_final_character(u8 ch)
  109. {
  110. return ch >= 0x40 && ch <= 0x7e;
  111. }
  112. void Terminal::escape$h_l(bool should_set, bool question_param, const ParamVector& params)
  113. {
  114. int mode = 2;
  115. if (params.size() > 0) {
  116. mode = params[0];
  117. }
  118. if (!question_param) {
  119. switch (mode) {
  120. // FIXME: implement *something* for this
  121. default:
  122. unimplemented_escape();
  123. break;
  124. }
  125. } else {
  126. switch (mode) {
  127. case 25:
  128. // Hide cursor command, but doesn't need to be run (for now, because
  129. // we don't do inverse control codes anyways)
  130. if (should_set)
  131. dbgprintf("Terminal: Hide Cursor escapecode recieved. Not needed: ignored.\n");
  132. else
  133. dbgprintf("Terminal: Show Cursor escapecode recieved. Not needed: ignored.\n");
  134. break;
  135. default:
  136. break;
  137. }
  138. }
  139. }
  140. void Terminal::escape$m(const ParamVector& params)
  141. {
  142. if (params.is_empty()) {
  143. m_current_attribute.reset();
  144. return;
  145. }
  146. if (params.size() == 3 && params[1] == 5) {
  147. if (params[0] == 38) {
  148. m_current_attribute.foreground_color = params[2];
  149. return;
  150. } else if (params[0] == 48) {
  151. m_current_attribute.background_color = params[2];
  152. return;
  153. }
  154. }
  155. for (auto param : params) {
  156. switch (param) {
  157. case 0:
  158. // Reset
  159. m_current_attribute.reset();
  160. break;
  161. case 1:
  162. m_current_attribute.flags |= Attribute::Bold;
  163. break;
  164. case 3:
  165. m_current_attribute.flags |= Attribute::Italic;
  166. break;
  167. case 4:
  168. m_current_attribute.flags |= Attribute::Underline;
  169. break;
  170. case 5:
  171. m_current_attribute.flags |= Attribute::Blink;
  172. break;
  173. case 7:
  174. m_current_attribute.flags |= Attribute::Negative;
  175. break;
  176. case 22:
  177. m_current_attribute.flags &= ~Attribute::Bold;
  178. break;
  179. case 23:
  180. m_current_attribute.flags &= ~Attribute::Italic;
  181. break;
  182. case 24:
  183. m_current_attribute.flags &= ~Attribute::Underline;
  184. break;
  185. case 25:
  186. m_current_attribute.flags &= ~Attribute::Blink;
  187. break;
  188. case 27:
  189. m_current_attribute.flags &= ~Attribute::Negative;
  190. break;
  191. case 30:
  192. case 31:
  193. case 32:
  194. case 33:
  195. case 34:
  196. case 35:
  197. case 36:
  198. case 37:
  199. // Foreground color
  200. if (m_current_attribute.flags & Attribute::Bold)
  201. param += 8;
  202. m_current_attribute.foreground_color = param - 30;
  203. break;
  204. case 39:
  205. // reset foreground
  206. m_current_attribute.foreground_color = Attribute::default_foreground_color;
  207. break;
  208. case 40:
  209. case 41:
  210. case 42:
  211. case 43:
  212. case 44:
  213. case 45:
  214. case 46:
  215. case 47:
  216. // Background color
  217. if (m_current_attribute.flags & Attribute::Bold)
  218. param += 8;
  219. m_current_attribute.background_color = param - 40;
  220. break;
  221. case 49:
  222. // reset background
  223. m_current_attribute.background_color = Attribute::default_background_color;
  224. break;
  225. default:
  226. dbgprintf("FIXME: escape$m: p: %u\n", param);
  227. }
  228. }
  229. }
  230. void Terminal::escape$s(const ParamVector&)
  231. {
  232. m_saved_cursor_row = m_cursor_row;
  233. m_saved_cursor_column = m_cursor_column;
  234. }
  235. void Terminal::escape$u(const ParamVector&)
  236. {
  237. set_cursor(m_saved_cursor_row, m_saved_cursor_column);
  238. }
  239. void Terminal::escape$t(const ParamVector& params)
  240. {
  241. if (params.size() < 1)
  242. return;
  243. dbgprintf("FIXME: escape$t: Ps: %u (param count: %d)\n", params[0], params.size());
  244. }
  245. void Terminal::escape$r(const ParamVector& params)
  246. {
  247. unsigned top = 1;
  248. unsigned bottom = m_rows;
  249. if (params.size() >= 1)
  250. top = params[0];
  251. if (params.size() >= 2)
  252. bottom = params[1];
  253. if ((bottom - top) < 2 || bottom > m_rows) {
  254. dbgprintf("Error: escape$r: scrolling region invalid: %u-%u\n", top, bottom);
  255. return;
  256. }
  257. m_scroll_region_top = top - 1;
  258. m_scroll_region_bottom = bottom - 1;
  259. set_cursor(0, 0);
  260. }
  261. void Terminal::escape$H(const ParamVector& params)
  262. {
  263. unsigned row = 1;
  264. unsigned col = 1;
  265. if (params.size() >= 1)
  266. row = params[0];
  267. if (params.size() >= 2)
  268. col = params[1];
  269. set_cursor(row - 1, col - 1);
  270. }
  271. void Terminal::escape$f(const ParamVector& params)
  272. {
  273. // HVP – Horizontal and Vertical Position
  274. unsigned row = 1;
  275. unsigned col = 1;
  276. if (params.size() >= 1)
  277. row = params[0];
  278. if (params.size() >= 2)
  279. col = params[1];
  280. set_cursor(row - 1, col - 1);
  281. }
  282. void Terminal::escape$A(const ParamVector& params)
  283. {
  284. int num = 1;
  285. if (params.size() >= 1)
  286. num = params[0];
  287. if (num == 0)
  288. num = 1;
  289. int new_row = (int)m_cursor_row - num;
  290. if (new_row < 0)
  291. new_row = 0;
  292. set_cursor(new_row, m_cursor_column);
  293. }
  294. void Terminal::escape$B(const ParamVector& params)
  295. {
  296. int num = 1;
  297. if (params.size() >= 1)
  298. num = params[0];
  299. if (num == 0)
  300. num = 1;
  301. int new_row = (int)m_cursor_row + num;
  302. if (new_row >= m_rows)
  303. new_row = m_rows - 1;
  304. set_cursor(new_row, m_cursor_column);
  305. }
  306. void Terminal::escape$C(const ParamVector& params)
  307. {
  308. int num = 1;
  309. if (params.size() >= 1)
  310. num = params[0];
  311. if (num == 0)
  312. num = 1;
  313. int new_column = (int)m_cursor_column + num;
  314. if (new_column >= m_columns)
  315. new_column = m_columns - 1;
  316. set_cursor(m_cursor_row, new_column);
  317. }
  318. void Terminal::escape$D(const ParamVector& params)
  319. {
  320. int num = 1;
  321. if (params.size() >= 1)
  322. num = params[0];
  323. if (num == 0)
  324. num = 1;
  325. int new_column = (int)m_cursor_column - num;
  326. if (new_column < 0)
  327. new_column = 0;
  328. set_cursor(m_cursor_row, new_column);
  329. }
  330. void Terminal::escape$G(const ParamVector& params)
  331. {
  332. int new_column = 1;
  333. if (params.size() >= 1)
  334. new_column = params[0] - 1;
  335. if (new_column < 0)
  336. new_column = 0;
  337. set_cursor(m_cursor_row, new_column);
  338. }
  339. void Terminal::escape$b(const ParamVector& params)
  340. {
  341. if (params.size() < 1)
  342. return;
  343. for (unsigned i = 0; i < params[0]; ++i)
  344. put_character_at(m_cursor_row, m_cursor_column++, m_last_char);
  345. }
  346. void Terminal::escape$d(const ParamVector& params)
  347. {
  348. int new_row = 1;
  349. if (params.size() >= 1)
  350. new_row = params[0] - 1;
  351. if (new_row < 0)
  352. new_row = 0;
  353. set_cursor(new_row, m_cursor_column);
  354. }
  355. void Terminal::escape$X(const ParamVector& params)
  356. {
  357. // Erase characters (without moving cursor)
  358. int num = 1;
  359. if (params.size() >= 1)
  360. num = params[0];
  361. if (num == 0)
  362. num = 1;
  363. // Clear from cursor to end of line.
  364. for (int i = m_cursor_column; i < num; ++i) {
  365. put_character_at(m_cursor_row, i, ' ');
  366. }
  367. }
  368. void Terminal::escape$K(const ParamVector& params)
  369. {
  370. int mode = 0;
  371. if (params.size() >= 1)
  372. mode = params[0];
  373. switch (mode) {
  374. case 0:
  375. // Clear from cursor to end of line.
  376. for (int i = m_cursor_column; i < m_columns; ++i) {
  377. put_character_at(m_cursor_row, i, ' ');
  378. }
  379. break;
  380. case 1:
  381. // Clear from cursor to beginning of line.
  382. for (int i = 0; i < m_cursor_column; ++i) {
  383. put_character_at(m_cursor_row, i, ' ');
  384. }
  385. break;
  386. case 2:
  387. // Clear the complete line
  388. for (int i = 0; i < m_columns; ++i) {
  389. put_character_at(m_cursor_row, i, ' ');
  390. }
  391. break;
  392. default:
  393. unimplemented_escape();
  394. break;
  395. }
  396. }
  397. void Terminal::escape$J(const ParamVector& params)
  398. {
  399. int mode = 0;
  400. if (params.size() >= 1)
  401. mode = params[0];
  402. switch (mode) {
  403. case 0:
  404. // Clear from cursor to end of screen.
  405. for (int i = m_cursor_column; i < m_columns; ++i)
  406. put_character_at(m_cursor_row, i, ' ');
  407. for (int row = m_cursor_row + 1; row < m_rows; ++row) {
  408. for (int column = 0; column < m_columns; ++column) {
  409. put_character_at(row, column, ' ');
  410. }
  411. }
  412. break;
  413. case 1:
  414. /// Clear from cursor to beginning of screen
  415. for (int i = m_cursor_column - 1; i >= 0; --i)
  416. put_character_at(m_cursor_row, i, ' ');
  417. for (int row = m_cursor_row - 1; row >= 0; --row) {
  418. for (int column = 0; column < m_columns; ++column) {
  419. put_character_at(row, column, ' ');
  420. }
  421. }
  422. break;
  423. case 2:
  424. clear();
  425. break;
  426. case 3:
  427. // FIXME: <esc>[3J should also clear the scrollback buffer.
  428. clear();
  429. break;
  430. default:
  431. unimplemented_escape();
  432. break;
  433. }
  434. }
  435. void Terminal::escape$S(const ParamVector& params)
  436. {
  437. int count = 1;
  438. if (params.size() >= 1)
  439. count = params[0];
  440. for (u16 i = 0; i < count; i++)
  441. scroll_up();
  442. }
  443. void Terminal::escape$T(const ParamVector& params)
  444. {
  445. int count = 1;
  446. if (params.size() >= 1)
  447. count = params[0];
  448. for (u16 i = 0; i < count; i++)
  449. scroll_down();
  450. }
  451. void Terminal::escape$L(const ParamVector& params)
  452. {
  453. int count = 1;
  454. if (params.size() >= 1)
  455. count = params[0];
  456. invalidate_cursor();
  457. for (; count > 0; --count) {
  458. m_lines.insert(m_cursor_row + m_scroll_region_top, make<Line>(m_columns));
  459. if (m_scroll_region_bottom + 1 < m_lines.size())
  460. m_lines.remove(m_scroll_region_bottom + 1);
  461. else
  462. m_lines.remove(m_lines.size() - 1);
  463. }
  464. m_need_full_flush = true;
  465. }
  466. void Terminal::escape$c(const ParamVector&)
  467. {
  468. // DA - Device Attributes
  469. emit_string("\033[?1;0c");
  470. }
  471. void Terminal::escape$M(const ParamVector& params)
  472. {
  473. int count = 1;
  474. if (params.size() >= 1)
  475. count = params[0];
  476. if (count == 1 && m_cursor_row == 0) {
  477. scroll_up();
  478. return;
  479. }
  480. int max_count = m_rows - (m_scroll_region_top + m_cursor_row);
  481. count = min(count, max_count);
  482. for (int c = count; c > 0; --c) {
  483. m_lines.remove(m_cursor_row + m_scroll_region_top);
  484. if (m_scroll_region_bottom < m_lines.size())
  485. m_lines.insert(m_scroll_region_bottom, make<Line>(m_columns));
  486. else
  487. m_lines.append(make<Line>(m_columns));
  488. }
  489. }
  490. void Terminal::escape$P(const ParamVector& params)
  491. {
  492. int num = 1;
  493. if (params.size() >= 1)
  494. num = params[0];
  495. if (num == 0)
  496. num = 1;
  497. auto& line = this->line(m_cursor_row);
  498. // Move n characters of line to the left
  499. for (int i = m_cursor_column; i < line.m_length - num; i++)
  500. line.characters[i] = line.characters[i + num];
  501. // Fill remainder of line with blanks
  502. for (int i = line.m_length - num; i < line.m_length; i++)
  503. line.characters[i] = ' ';
  504. line.dirty = true;
  505. }
  506. void Terminal::execute_xterm_command()
  507. {
  508. m_final = '@';
  509. bool ok;
  510. unsigned value = String::copy(m_xterm_param1).to_uint(ok);
  511. if (ok) {
  512. switch (value) {
  513. case 0:
  514. case 1:
  515. case 2:
  516. m_client.set_window_title(String::copy(m_xterm_param2));
  517. break;
  518. default:
  519. unimplemented_xterm_escape();
  520. break;
  521. }
  522. }
  523. m_xterm_param1.clear_with_capacity();
  524. m_xterm_param2.clear_with_capacity();
  525. }
  526. void Terminal::execute_escape_sequence(u8 final)
  527. {
  528. bool question_param = false;
  529. m_final = final;
  530. ParamVector params;
  531. if (m_parameters.size() > 0 && m_parameters[0] == '?') {
  532. question_param = true;
  533. m_parameters.remove(0);
  534. }
  535. auto paramparts = String::copy(m_parameters).split(';');
  536. for (auto& parampart : paramparts) {
  537. bool ok;
  538. unsigned value = parampart.to_uint(ok);
  539. if (!ok) {
  540. // FIXME: Should we do something else?
  541. m_parameters.clear_with_capacity();
  542. m_intermediates.clear_with_capacity();
  543. return;
  544. }
  545. params.append(value);
  546. }
  547. #if defined(TERMINAL_DEBUG)
  548. dbgprintf("Terminal::execute_escape_sequence: Handled final '%c'\n", final);
  549. dbgprintf("Params: ");
  550. for (auto& p : params) {
  551. dbgprintf("%d ", p);
  552. }
  553. dbgprintf("\b\n");
  554. #endif
  555. switch (final) {
  556. case 'A':
  557. escape$A(params);
  558. break;
  559. case 'B':
  560. escape$B(params);
  561. break;
  562. case 'C':
  563. escape$C(params);
  564. break;
  565. case 'D':
  566. escape$D(params);
  567. break;
  568. case 'H':
  569. escape$H(params);
  570. break;
  571. case 'J':
  572. escape$J(params);
  573. break;
  574. case 'K':
  575. escape$K(params);
  576. break;
  577. case 'M':
  578. escape$M(params);
  579. break;
  580. case 'P':
  581. escape$P(params);
  582. break;
  583. case 'S':
  584. escape$S(params);
  585. break;
  586. case 'T':
  587. escape$T(params);
  588. break;
  589. case 'L':
  590. escape$L(params);
  591. break;
  592. case 'G':
  593. escape$G(params);
  594. break;
  595. case 'X':
  596. escape$X(params);
  597. break;
  598. case 'b':
  599. escape$b(params);
  600. break;
  601. case 'd':
  602. escape$d(params);
  603. break;
  604. case 'm':
  605. escape$m(params);
  606. break;
  607. case 's':
  608. escape$s(params);
  609. break;
  610. case 'u':
  611. escape$u(params);
  612. break;
  613. case 't':
  614. escape$t(params);
  615. break;
  616. case 'r':
  617. escape$r(params);
  618. break;
  619. case 'l':
  620. escape$h_l(true, question_param, params);
  621. break;
  622. case 'h':
  623. escape$h_l(false, question_param, params);
  624. break;
  625. case 'c':
  626. escape$c(params);
  627. break;
  628. case 'f':
  629. escape$f(params);
  630. break;
  631. default:
  632. dbgprintf("Terminal::execute_escape_sequence: Unhandled final '%c'\n", final);
  633. break;
  634. }
  635. #if defined(TERMINAL_DEBUG)
  636. dbgprintf("\n");
  637. for (auto& line : m_lines) {
  638. dbgprintf("Terminal: Line: ");
  639. for (int i = 0; i < line.m_length; i++) {
  640. dbgprintf("%c", line.characters[i]);
  641. }
  642. dbgprintf("\n");
  643. }
  644. #endif
  645. m_parameters.clear_with_capacity();
  646. m_intermediates.clear_with_capacity();
  647. }
  648. void Terminal::newline()
  649. {
  650. u16 new_row = m_cursor_row;
  651. if (m_cursor_row == m_scroll_region_bottom) {
  652. scroll_up();
  653. } else {
  654. ++new_row;
  655. }
  656. set_cursor(new_row, 0);
  657. }
  658. void Terminal::scroll_up()
  659. {
  660. // NOTE: We have to invalidate the cursor first.
  661. invalidate_cursor();
  662. if (m_scroll_region_top == 0) {
  663. auto line = move(m_lines.ptr_at(m_scroll_region_top));
  664. m_history.append(move(line));
  665. while (m_history.size() > max_history_size())
  666. m_history.take_first();
  667. m_client.terminal_history_changed();
  668. }
  669. m_lines.remove(m_scroll_region_top);
  670. m_lines.insert(m_scroll_region_bottom, make<Line>(m_columns));
  671. m_need_full_flush = true;
  672. }
  673. void Terminal::scroll_down()
  674. {
  675. // NOTE: We have to invalidate the cursor first.
  676. invalidate_cursor();
  677. m_lines.remove(m_scroll_region_bottom);
  678. m_lines.insert(m_scroll_region_top, make<Line>(m_columns));
  679. m_need_full_flush = true;
  680. }
  681. void Terminal::set_cursor(unsigned a_row, unsigned a_column)
  682. {
  683. unsigned row = min(a_row, m_rows - 1u);
  684. unsigned column = min(a_column, m_columns - 1u);
  685. if (row == m_cursor_row && column == m_cursor_column)
  686. return;
  687. ASSERT(row < rows());
  688. ASSERT(column < columns());
  689. invalidate_cursor();
  690. m_cursor_row = row;
  691. m_cursor_column = column;
  692. m_stomp = false;
  693. invalidate_cursor();
  694. }
  695. void Terminal::put_character_at(unsigned row, unsigned column, u8 ch)
  696. {
  697. ASSERT(row < rows());
  698. ASSERT(column < columns());
  699. auto& line = this->line(row);
  700. line.characters[column] = ch;
  701. line.attributes[column] = m_current_attribute;
  702. line.attributes[column].flags |= Attribute::Touched;
  703. line.dirty = true;
  704. m_last_char = ch;
  705. }
  706. void Terminal::NEL()
  707. {
  708. // NEL - Next Line
  709. newline();
  710. }
  711. void Terminal::IND()
  712. {
  713. // IND - Index (move down)
  714. escape$B({});
  715. }
  716. void Terminal::RI()
  717. {
  718. // RI - Reverse Index (move up)
  719. escape$A({});
  720. }
  721. void Terminal::on_char(u8 ch)
  722. {
  723. #ifdef TERMINAL_DEBUG
  724. dbgprintf("Terminal::on_char: %b (%c), fg=%u, bg=%u\n", ch, ch, m_current_attribute.foreground_color, m_current_attribute.background_color);
  725. #endif
  726. switch (m_escape_state) {
  727. case GotEscape:
  728. if (ch == '[') {
  729. m_escape_state = ExpectParameter;
  730. } else if (ch == '(') {
  731. m_swallow_current = true;
  732. m_escape_state = ExpectParameter;
  733. } else if (ch == ']') {
  734. m_escape_state = ExpectXtermParameter1;
  735. } else if (ch == '#') {
  736. m_escape_state = ExpectHashtagDigit;
  737. } else if (ch == 'D') {
  738. IND();
  739. m_escape_state = Normal;
  740. return;
  741. } else if (ch == 'M') {
  742. RI();
  743. m_escape_state = Normal;
  744. return;
  745. } else if (ch == 'E') {
  746. NEL();
  747. m_escape_state = Normal;
  748. return;
  749. } else {
  750. dbg() << "Unexpected character in GotEscape '" << (char)ch << "'";
  751. m_escape_state = Normal;
  752. }
  753. return;
  754. case ExpectHashtagDigit:
  755. if (ch >= '0' && ch <= '9') {
  756. execute_hashtag(ch);
  757. m_escape_state = Normal;
  758. }
  759. break;
  760. case ExpectXtermParameter1:
  761. if (ch != ';') {
  762. m_xterm_param1.append(ch);
  763. return;
  764. }
  765. m_escape_state = ExpectXtermParameter2;
  766. return;
  767. case ExpectXtermParameter2:
  768. if (ch != '\007') {
  769. m_xterm_param2.append(ch);
  770. return;
  771. }
  772. m_escape_state = ExpectXtermFinal;
  773. [[fallthrough]];
  774. case ExpectXtermFinal:
  775. m_escape_state = Normal;
  776. if (ch == '\007')
  777. execute_xterm_command();
  778. return;
  779. case ExpectParameter:
  780. if (is_valid_parameter_character(ch)) {
  781. m_parameters.append(ch);
  782. return;
  783. }
  784. m_escape_state = ExpectIntermediate;
  785. [[fallthrough]];
  786. case ExpectIntermediate:
  787. if (is_valid_intermediate_character(ch)) {
  788. m_intermediates.append(ch);
  789. return;
  790. }
  791. m_escape_state = ExpectFinal;
  792. [[fallthrough]];
  793. case ExpectFinal:
  794. if (is_valid_final_character(ch)) {
  795. m_escape_state = Normal;
  796. if (!m_swallow_current)
  797. execute_escape_sequence(ch);
  798. m_swallow_current = false;
  799. return;
  800. }
  801. m_escape_state = Normal;
  802. m_swallow_current = false;
  803. return;
  804. case Normal:
  805. break;
  806. }
  807. switch (ch) {
  808. case '\0':
  809. return;
  810. case '\033':
  811. m_escape_state = GotEscape;
  812. m_swallow_current = false;
  813. return;
  814. case 8: // Backspace
  815. if (m_cursor_column) {
  816. set_cursor(m_cursor_row, m_cursor_column - 1);
  817. return;
  818. }
  819. return;
  820. case '\a':
  821. m_client.beep();
  822. return;
  823. case '\t': {
  824. for (unsigned i = m_cursor_column + 1; i < columns(); ++i) {
  825. if (m_horizontal_tabs[i]) {
  826. set_cursor(m_cursor_row, i);
  827. return;
  828. }
  829. }
  830. return;
  831. }
  832. case '\r':
  833. set_cursor(m_cursor_row, 0);
  834. return;
  835. case '\n':
  836. newline();
  837. return;
  838. }
  839. auto new_column = m_cursor_column + 1;
  840. if (new_column < columns()) {
  841. put_character_at(m_cursor_row, m_cursor_column, ch);
  842. set_cursor(m_cursor_row, new_column);
  843. } else {
  844. if (m_stomp) {
  845. m_stomp = false;
  846. newline();
  847. put_character_at(m_cursor_row, m_cursor_column, ch);
  848. set_cursor(m_cursor_row, 1);
  849. } else {
  850. // Curious: We wait once on the right-hand side
  851. m_stomp = true;
  852. put_character_at(m_cursor_row, m_cursor_column, ch);
  853. }
  854. }
  855. }
  856. void Terminal::inject_string(const StringView& str)
  857. {
  858. for (size_t i = 0; i < str.length(); ++i)
  859. on_char(str[i]);
  860. }
  861. void Terminal::emit_string(const StringView& str)
  862. {
  863. for (size_t i = 0; i < str.length(); ++i)
  864. m_client.emit_char(str[i]);
  865. }
  866. void Terminal::unimplemented_escape()
  867. {
  868. StringBuilder builder;
  869. builder.appendf("((Unimplemented escape: %c", m_final);
  870. if (!m_parameters.is_empty()) {
  871. builder.append(" parameters:");
  872. for (int i = 0; i < m_parameters.size(); ++i)
  873. builder.append((char)m_parameters[i]);
  874. }
  875. if (!m_intermediates.is_empty()) {
  876. builder.append(" intermediates:");
  877. for (int i = 0; i < m_intermediates.size(); ++i)
  878. builder.append((char)m_intermediates[i]);
  879. }
  880. builder.append("))");
  881. inject_string(builder.to_string());
  882. }
  883. void Terminal::unimplemented_xterm_escape()
  884. {
  885. auto message = String::format("((Unimplemented xterm escape: %c))\n", m_final);
  886. inject_string(message);
  887. }
  888. void Terminal::set_size(u16 columns, u16 rows)
  889. {
  890. if (!columns)
  891. columns = 1;
  892. if (!rows)
  893. rows = 1;
  894. if (columns == m_columns && rows == m_rows)
  895. return;
  896. #if defined(TERMINAL_DEBUG)
  897. dbgprintf("Terminal: RESIZE to: %d rows\n", rows);
  898. #endif
  899. if (rows > m_rows) {
  900. while (m_lines.size() < rows)
  901. m_lines.append(make<Line>(columns));
  902. } else {
  903. m_lines.shrink(rows);
  904. }
  905. for (int i = 0; i < rows; ++i)
  906. m_lines[i].set_length(columns);
  907. m_columns = columns;
  908. m_rows = rows;
  909. m_scroll_region_top = 0;
  910. m_scroll_region_bottom = rows - 1;
  911. m_cursor_row = min((int)m_cursor_row, m_rows - 1);
  912. m_cursor_column = min((int)m_cursor_column, m_columns - 1);
  913. m_saved_cursor_row = min((int)m_saved_cursor_row, m_rows - 1);
  914. m_saved_cursor_column = min((int)m_saved_cursor_column, m_columns - 1);
  915. m_horizontal_tabs.resize(columns);
  916. for (unsigned i = 0; i < columns; ++i)
  917. m_horizontal_tabs[i] = (i % 8) == 0;
  918. // Rightmost column is always last tab on line.
  919. m_horizontal_tabs[columns - 1] = 1;
  920. m_client.terminal_did_resize(m_columns, m_rows);
  921. }
  922. void Terminal::invalidate_cursor()
  923. {
  924. line(m_cursor_row).dirty = true;
  925. }
  926. void Terminal::execute_hashtag(u8 hashtag)
  927. {
  928. switch (hashtag) {
  929. case '8':
  930. // Confidence Test - Fill screen with E's
  931. for (size_t row = 0; row < m_rows; ++row) {
  932. for (size_t column = 0; column < m_columns; ++column) {
  933. put_character_at(row, column, 'E');
  934. }
  935. }
  936. break;
  937. default:
  938. dbg() << "Unknown hashtag: '" << hashtag << "'";
  939. }
  940. }
  941. }