Terminal.cpp 32 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228
  1. /*
  2. * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include "Terminal.h"
  7. #include <AK/Debug.h>
  8. #include <AK/StringBuilder.h>
  9. #include <AK/StringView.h>
  10. #include <LibVT/Terminal.h>
  11. #ifdef KERNEL
  12. # include <Kernel/TTY/VirtualConsole.h>
  13. #endif
  14. namespace VT {
  15. #ifndef KERNEL
  16. Terminal::Terminal(TerminalClient& client)
  17. #else
  18. Terminal::Terminal(Kernel::VirtualConsole& client)
  19. #endif
  20. : m_client(client)
  21. , m_parser(*this)
  22. {
  23. }
  24. #ifndef KERNEL
  25. void Terminal::clear()
  26. {
  27. for (size_t i = 0; i < rows(); ++i)
  28. m_lines[i].clear(m_current_attribute);
  29. set_cursor(0, 0);
  30. }
  31. void Terminal::clear_including_history()
  32. {
  33. m_history.clear();
  34. m_history_start = 0;
  35. clear();
  36. m_client.terminal_history_changed();
  37. }
  38. #endif
  39. void Terminal::alter_mode(bool should_set, Parameters params, Intermediates intermediates)
  40. {
  41. auto steady_cursor_to_blinking = [](CursorStyle style) {
  42. switch (style) {
  43. case SteadyBar:
  44. return BlinkingBar;
  45. case SteadyBlock:
  46. return BlinkingBlock;
  47. case SteadyUnderline:
  48. return BlinkingUnderline;
  49. default:
  50. return style;
  51. }
  52. };
  53. auto blinking_cursor_to_steady = [](CursorStyle style) {
  54. switch (style) {
  55. case BlinkingBar:
  56. return SteadyBar;
  57. case BlinkingBlock:
  58. return SteadyBlock;
  59. case BlinkingUnderline:
  60. return SteadyUnderline;
  61. default:
  62. return style;
  63. }
  64. };
  65. if (intermediates.size() > 0 && intermediates[0] == '?') {
  66. for (auto mode : params) {
  67. switch (mode) {
  68. case 3: {
  69. // 80/132-column mode (DECCOLM)
  70. unsigned new_columns = should_set ? 132 : 80;
  71. dbgln_if(TERMINAL_DEBUG, "Setting {}-column mode", new_columns);
  72. set_size(new_columns, rows());
  73. clear();
  74. break;
  75. }
  76. case 12:
  77. if (should_set) {
  78. // Start blinking cursor
  79. m_cursor_style = steady_cursor_to_blinking(m_cursor_style);
  80. } else {
  81. // Stop blinking cursor
  82. m_cursor_style = blinking_cursor_to_steady(m_cursor_style);
  83. }
  84. m_client.set_cursor_style(m_cursor_style);
  85. break;
  86. case 25:
  87. if (should_set) {
  88. // Show cursor
  89. m_cursor_style = m_saved_cursor_style;
  90. m_client.set_cursor_style(m_cursor_style);
  91. } else {
  92. // Hide cursor
  93. m_saved_cursor_style = m_cursor_style;
  94. m_cursor_style = None;
  95. m_client.set_cursor_style(None);
  96. }
  97. break;
  98. default:
  99. dbgln("Terminal::alter_mode: Unimplemented private mode {} (should_set={})", mode, should_set);
  100. break;
  101. }
  102. }
  103. } else {
  104. for (auto mode : params) {
  105. switch (mode) {
  106. // FIXME: implement *something* for this
  107. default:
  108. dbgln("Terminal::alter_mode: Unimplemented mode {} (should_set={})", mode, should_set);
  109. break;
  110. }
  111. }
  112. }
  113. }
  114. void Terminal::RM(Parameters params, Intermediates intermediates)
  115. {
  116. alter_mode(false, params, intermediates);
  117. }
  118. void Terminal::SM(Parameters params, Intermediates intermediates)
  119. {
  120. alter_mode(true, params, intermediates);
  121. }
  122. void Terminal::SGR(Parameters params)
  123. {
  124. if (params.is_empty()) {
  125. m_current_attribute.reset();
  126. return;
  127. }
  128. auto parse_color = [&]() -> Optional<u32> {
  129. if (params.size() < 2) {
  130. dbgln("Color code has no type");
  131. return {};
  132. }
  133. u32 color = 0;
  134. switch (params[1]) {
  135. case 5: // 8-bit
  136. if (params.size() < 3) {
  137. dbgln("8-bit color code has too few parameters");
  138. return {};
  139. }
  140. return xterm_colors[params[2]];
  141. case 2: // 24-bit
  142. if (params.size() < 5) {
  143. dbgln("24-bit color code has too few parameters");
  144. return {};
  145. }
  146. for (size_t i = 0; i < 3; ++i) {
  147. color <<= 8;
  148. color |= params[i + 2];
  149. }
  150. return color;
  151. default:
  152. dbgln("Unknown color type {}", params[1]);
  153. return {};
  154. }
  155. };
  156. if (params[0] == 38) {
  157. m_current_attribute.foreground_color = parse_color().value_or(m_current_attribute.foreground_color);
  158. } else if (params[0] == 48) {
  159. m_current_attribute.background_color = parse_color().value_or(m_current_attribute.background_color);
  160. } else {
  161. // A single escape sequence may set multiple parameters.
  162. for (auto param : params) {
  163. switch (param) {
  164. case 0:
  165. // Reset
  166. m_current_attribute.reset();
  167. break;
  168. case 1:
  169. m_current_attribute.flags |= Attribute::Bold;
  170. break;
  171. case 3:
  172. m_current_attribute.flags |= Attribute::Italic;
  173. break;
  174. case 4:
  175. m_current_attribute.flags |= Attribute::Underline;
  176. break;
  177. case 5:
  178. m_current_attribute.flags |= Attribute::Blink;
  179. break;
  180. case 7:
  181. m_current_attribute.flags |= Attribute::Negative;
  182. break;
  183. case 22:
  184. m_current_attribute.flags &= ~Attribute::Bold;
  185. break;
  186. case 23:
  187. m_current_attribute.flags &= ~Attribute::Italic;
  188. break;
  189. case 24:
  190. m_current_attribute.flags &= ~Attribute::Underline;
  191. break;
  192. case 25:
  193. m_current_attribute.flags &= ~Attribute::Blink;
  194. break;
  195. case 27:
  196. m_current_attribute.flags &= ~Attribute::Negative;
  197. break;
  198. case 30:
  199. case 31:
  200. case 32:
  201. case 33:
  202. case 34:
  203. case 35:
  204. case 36:
  205. case 37:
  206. // Foreground color
  207. if (m_current_attribute.flags & Attribute::Bold)
  208. param += 8;
  209. m_current_attribute.foreground_color = xterm_colors[param - 30];
  210. break;
  211. case 39:
  212. // reset foreground
  213. m_current_attribute.foreground_color = Attribute::default_foreground_color;
  214. break;
  215. case 40:
  216. case 41:
  217. case 42:
  218. case 43:
  219. case 44:
  220. case 45:
  221. case 46:
  222. case 47:
  223. // Background color
  224. if (m_current_attribute.flags & Attribute::Bold)
  225. param += 8;
  226. m_current_attribute.background_color = xterm_colors[param - 40];
  227. break;
  228. case 49:
  229. // reset background
  230. m_current_attribute.background_color = Attribute::default_background_color;
  231. break;
  232. default:
  233. dbgln("FIXME: SGR: p: {}", param);
  234. }
  235. }
  236. }
  237. }
  238. void Terminal::SCOSC()
  239. {
  240. m_saved_cursor_row = m_cursor_row;
  241. m_saved_cursor_column = m_cursor_column;
  242. m_saved_attribute = m_current_attribute;
  243. }
  244. void Terminal::SCORC(Parameters)
  245. {
  246. set_cursor(m_saved_cursor_row, m_saved_cursor_column);
  247. }
  248. void Terminal::XTERM_WM(Parameters params)
  249. {
  250. if (params.size() < 1)
  251. return;
  252. switch (params[0]) {
  253. case 22: {
  254. if (params.size() > 1 && params[1] == 1) {
  255. dbgln("FIXME: we don't support icon titles");
  256. return;
  257. }
  258. dbgln_if(TERMINAL_DEBUG, "Title stack push: {}", m_current_window_title);
  259. [[maybe_unused]] auto rc = m_title_stack.try_append(move(m_current_window_title));
  260. break;
  261. }
  262. case 23: {
  263. if (params.size() > 1 && params[1] == 1)
  264. return;
  265. if (m_title_stack.is_empty()) {
  266. dbgln("Shenanigans: Tried to pop from empty title stack");
  267. return;
  268. }
  269. m_current_window_title = m_title_stack.take_last();
  270. dbgln_if(TERMINAL_DEBUG, "Title stack pop: {}", m_current_window_title);
  271. m_client.set_window_title(m_current_window_title);
  272. break;
  273. }
  274. default:
  275. dbgln("FIXME: XTERM_WM: Ps: {} (param count: {})", params[0], params.size());
  276. }
  277. }
  278. void Terminal::DECSTBM(Parameters params)
  279. {
  280. unsigned top = 1;
  281. unsigned bottom = m_rows;
  282. if (params.size() >= 1)
  283. top = params[0];
  284. if (params.size() >= 2)
  285. bottom = params[1];
  286. if ((bottom - top) < 2 || bottom > m_rows) {
  287. dbgln("Error: DECSTBM: scrolling region invalid: {}-{}", top, bottom);
  288. return;
  289. }
  290. m_scroll_region_top = top - 1;
  291. m_scroll_region_bottom = bottom - 1;
  292. set_cursor(0, 0);
  293. }
  294. void Terminal::CUP(Parameters params)
  295. {
  296. // CUP – Cursor Position
  297. unsigned row = 1;
  298. unsigned col = 1;
  299. if (params.size() >= 1)
  300. row = params[0];
  301. if (params.size() >= 2)
  302. col = params[1];
  303. set_cursor(row - 1, col - 1);
  304. }
  305. void Terminal::HVP(Parameters params)
  306. {
  307. unsigned row = 1;
  308. unsigned col = 1;
  309. if (params.size() >= 1)
  310. row = params[0];
  311. if (params.size() >= 2)
  312. col = params[1];
  313. set_cursor(row - 1, col - 1);
  314. }
  315. void Terminal::CUU(Parameters params)
  316. {
  317. int num = 1;
  318. if (params.size() >= 1)
  319. num = params[0];
  320. if (num == 0)
  321. num = 1;
  322. int new_row = (int)m_cursor_row - num;
  323. if (new_row < 0)
  324. new_row = 0;
  325. set_cursor(new_row, m_cursor_column);
  326. }
  327. void Terminal::CUD(Parameters params)
  328. {
  329. int num = 1;
  330. if (params.size() >= 1)
  331. num = params[0];
  332. if (num == 0)
  333. num = 1;
  334. int new_row = (int)m_cursor_row + num;
  335. if (new_row >= m_rows)
  336. new_row = m_rows - 1;
  337. set_cursor(new_row, m_cursor_column);
  338. }
  339. void Terminal::CUF(Parameters params)
  340. {
  341. int num = 1;
  342. if (params.size() >= 1)
  343. num = params[0];
  344. if (num == 0)
  345. num = 1;
  346. int new_column = (int)m_cursor_column + num;
  347. if (new_column >= m_columns)
  348. new_column = m_columns - 1;
  349. set_cursor(m_cursor_row, new_column);
  350. }
  351. void Terminal::CUB(Parameters params)
  352. {
  353. int num = 1;
  354. if (params.size() >= 1)
  355. num = params[0];
  356. if (num == 0)
  357. num = 1;
  358. int new_column = (int)m_cursor_column - num;
  359. if (new_column < 0)
  360. new_column = 0;
  361. set_cursor(m_cursor_row, new_column);
  362. }
  363. void Terminal::CHA(Parameters params)
  364. {
  365. int new_column = 1;
  366. if (params.size() >= 1)
  367. new_column = params[0] - 1;
  368. if (new_column < 0)
  369. new_column = 0;
  370. set_cursor(m_cursor_row, new_column);
  371. }
  372. void Terminal::REP(Parameters params)
  373. {
  374. if (params.size() < 1)
  375. return;
  376. for (unsigned i = 0; i < params[0]; ++i)
  377. put_character_at(m_cursor_row, m_cursor_column++, m_last_code_point);
  378. }
  379. void Terminal::VPA(Parameters params)
  380. {
  381. int new_row = 1;
  382. if (params.size() >= 1)
  383. new_row = params[0] - 1;
  384. if (new_row < 0)
  385. new_row = 0;
  386. set_cursor(new_row, m_cursor_column);
  387. }
  388. void Terminal::ECH(Parameters params)
  389. {
  390. // Erase characters (without moving cursor)
  391. int num = 1;
  392. if (params.size() >= 1)
  393. num = params[0];
  394. if (num == 0)
  395. num = 1;
  396. // Clear from cursor to end of line.
  397. for (int i = m_cursor_column; i < num; ++i) {
  398. put_character_at(m_cursor_row, i, ' ');
  399. }
  400. }
  401. void Terminal::EL(Parameters params)
  402. {
  403. int mode = 0;
  404. if (params.size() >= 1)
  405. mode = params[0];
  406. switch (mode) {
  407. case 0:
  408. // Clear from cursor to end of line.
  409. for (int i = m_cursor_column; i < m_columns; ++i) {
  410. put_character_at(m_cursor_row, i, ' ');
  411. }
  412. break;
  413. case 1:
  414. // Clear from cursor to beginning of line.
  415. for (int i = 0; i <= m_cursor_column; ++i) {
  416. put_character_at(m_cursor_row, i, ' ');
  417. }
  418. break;
  419. case 2:
  420. // Clear the complete line
  421. for (int i = 0; i < m_columns; ++i) {
  422. put_character_at(m_cursor_row, i, ' ');
  423. }
  424. break;
  425. default:
  426. unimplemented_csi_sequence(params, {}, 'K');
  427. break;
  428. }
  429. }
  430. void Terminal::ED(Parameters params)
  431. {
  432. int mode = 0;
  433. if (params.size() >= 1)
  434. mode = params[0];
  435. switch (mode) {
  436. case 0:
  437. // Clear from cursor to end of screen.
  438. for (int i = m_cursor_column; i < m_columns; ++i)
  439. put_character_at(m_cursor_row, i, ' ');
  440. for (int row = m_cursor_row + 1; row < m_rows; ++row) {
  441. for (int column = 0; column < m_columns; ++column) {
  442. put_character_at(row, column, ' ');
  443. }
  444. }
  445. break;
  446. case 1:
  447. // Clear from cursor to beginning of screen.
  448. for (int i = m_cursor_column; i >= 0; --i)
  449. put_character_at(m_cursor_row, i, ' ');
  450. for (int row = m_cursor_row - 1; row >= 0; --row) {
  451. for (int column = 0; column < m_columns; ++column) {
  452. put_character_at(row, column, ' ');
  453. }
  454. }
  455. break;
  456. case 2:
  457. clear();
  458. break;
  459. case 3:
  460. // FIXME: <esc>[3J should also clear the scrollback buffer.
  461. clear();
  462. break;
  463. default:
  464. unimplemented_csi_sequence(params, {}, 'J');
  465. break;
  466. }
  467. }
  468. void Terminal::SU(Parameters params)
  469. {
  470. int count = 1;
  471. if (params.size() >= 1)
  472. count = params[0];
  473. for (u16 i = 0; i < count; i++)
  474. scroll_up();
  475. }
  476. void Terminal::SD(Parameters params)
  477. {
  478. int count = 1;
  479. if (params.size() >= 1)
  480. count = params[0];
  481. for (u16 i = 0; i < count; i++)
  482. scroll_down();
  483. }
  484. void Terminal::DECSCUSR(Parameters params)
  485. {
  486. unsigned style = 1;
  487. if (params.size() >= 1 && params[0] != 0)
  488. style = params[0];
  489. switch (style) {
  490. case 1:
  491. m_client.set_cursor_style(BlinkingBlock);
  492. break;
  493. case 2:
  494. m_client.set_cursor_style(SteadyBlock);
  495. break;
  496. case 3:
  497. m_client.set_cursor_style(BlinkingUnderline);
  498. break;
  499. case 4:
  500. m_client.set_cursor_style(SteadyUnderline);
  501. break;
  502. case 5:
  503. m_client.set_cursor_style(BlinkingBar);
  504. break;
  505. case 6:
  506. m_client.set_cursor_style(SteadyBar);
  507. break;
  508. default:
  509. dbgln("Unknown cursor style {}", style);
  510. }
  511. }
  512. #ifndef KERNEL
  513. void Terminal::IL(Parameters params)
  514. {
  515. int count = 1;
  516. if (params.size() >= 1)
  517. count = params[0];
  518. invalidate_cursor();
  519. for (; count > 0; --count) {
  520. m_lines.insert(m_cursor_row + m_scroll_region_top, make<Line>(m_columns));
  521. if (m_scroll_region_bottom + 1 < m_lines.size())
  522. m_lines.remove(m_scroll_region_bottom + 1);
  523. else
  524. m_lines.remove(m_lines.size() - 1);
  525. }
  526. m_need_full_flush = true;
  527. }
  528. #endif
  529. void Terminal::DA(Parameters)
  530. {
  531. emit_string("\033[?1;0c");
  532. }
  533. #ifndef KERNEL
  534. void Terminal::DL(Parameters params)
  535. {
  536. int count = 1;
  537. if (params.size() >= 1)
  538. count = params[0];
  539. if (count == 1 && m_cursor_row == 0) {
  540. scroll_up();
  541. return;
  542. }
  543. int max_count = m_rows - (m_scroll_region_top + m_cursor_row);
  544. count = min(count, max_count);
  545. for (int c = count; c > 0; --c) {
  546. m_lines.remove(m_cursor_row + m_scroll_region_top);
  547. if (m_scroll_region_bottom < m_lines.size())
  548. m_lines.insert(m_scroll_region_bottom, make<Line>(m_columns));
  549. else
  550. m_lines.append(make<Line>(m_columns));
  551. }
  552. }
  553. void Terminal::DCH(Parameters params)
  554. {
  555. int num = 1;
  556. if (params.size() >= 1)
  557. num = params[0];
  558. if (num == 0)
  559. num = 1;
  560. auto& line = m_lines[m_cursor_row];
  561. // Move n characters of line to the left
  562. for (size_t i = m_cursor_column; i < line.length() - num; i++)
  563. line.set_code_point(i, line.code_point(i + num));
  564. // Fill remainder of line with blanks
  565. for (size_t i = line.length() - num; i < line.length(); i++)
  566. line.set_code_point(i, ' ');
  567. line.set_dirty(true);
  568. }
  569. #endif
  570. void Terminal::linefeed()
  571. {
  572. u16 new_row = m_cursor_row;
  573. if (m_cursor_row == m_scroll_region_bottom) {
  574. scroll_up();
  575. } else {
  576. ++new_row;
  577. };
  578. // We shouldn't jump to the first column after receiving a line feed.
  579. // The TTY will take care of generating the carriage return.
  580. set_cursor(new_row, m_cursor_column);
  581. }
  582. void Terminal::carriage_return()
  583. {
  584. set_cursor(m_cursor_row, 0);
  585. }
  586. #ifndef KERNEL
  587. void Terminal::scroll_up()
  588. {
  589. // NOTE: We have to invalidate the cursor first.
  590. invalidate_cursor();
  591. if (m_scroll_region_top == 0) {
  592. auto line = move(m_lines.ptr_at(m_scroll_region_top));
  593. add_line_to_history(move(line));
  594. m_client.terminal_history_changed();
  595. }
  596. m_lines.remove(m_scroll_region_top);
  597. m_lines.insert(m_scroll_region_bottom, make<Line>(m_columns));
  598. m_need_full_flush = true;
  599. }
  600. void Terminal::scroll_down()
  601. {
  602. // NOTE: We have to invalidate the cursor first.
  603. invalidate_cursor();
  604. m_lines.remove(m_scroll_region_bottom);
  605. m_lines.insert(m_scroll_region_top, make<Line>(m_columns));
  606. m_need_full_flush = true;
  607. }
  608. void Terminal::put_character_at(unsigned row, unsigned column, u32 code_point)
  609. {
  610. VERIFY(row < rows());
  611. VERIFY(column < columns());
  612. auto& line = m_lines[row];
  613. line.set_code_point(column, code_point);
  614. line.attribute_at(column) = m_current_attribute;
  615. line.attribute_at(column).flags |= Attribute::Touched;
  616. line.set_dirty(true);
  617. m_last_code_point = code_point;
  618. }
  619. #endif
  620. void Terminal::set_cursor(unsigned a_row, unsigned a_column)
  621. {
  622. unsigned row = min(a_row, m_rows - 1u);
  623. unsigned column = min(a_column, m_columns - 1u);
  624. if (row == m_cursor_row && column == m_cursor_column)
  625. return;
  626. VERIFY(row < rows());
  627. VERIFY(column < columns());
  628. invalidate_cursor();
  629. m_cursor_row = row;
  630. m_cursor_column = column;
  631. m_stomp = false;
  632. invalidate_cursor();
  633. }
  634. void Terminal::NEL()
  635. {
  636. linefeed();
  637. carriage_return();
  638. }
  639. void Terminal::IND()
  640. {
  641. CUD({});
  642. }
  643. void Terminal::RI()
  644. {
  645. CUU({});
  646. }
  647. void Terminal::DSR(Parameters params)
  648. {
  649. if (params.size() == 1 && params[0] == 5) {
  650. // Device status
  651. emit_string("\033[0n"); // Terminal status OK!
  652. } else if (params.size() == 1 && params[0] == 6) {
  653. // Cursor position query
  654. emit_string(String::formatted("\e[{};{}R", m_cursor_row + 1, m_cursor_column + 1));
  655. } else {
  656. dbgln("Unknown DSR");
  657. }
  658. }
  659. #ifndef KERNEL
  660. void Terminal::ICH(Parameters params)
  661. {
  662. int num = 0;
  663. if (params.size() >= 1) {
  664. num = params[0];
  665. }
  666. if (num == 0)
  667. num = 1;
  668. auto& line = m_lines[m_cursor_row];
  669. // Move characters after cursor to the right
  670. for (int i = line.length() - num; i >= m_cursor_column; --i)
  671. line.set_code_point(i + num, line.code_point(i));
  672. // Fill n characters after cursor with blanks
  673. for (int i = 0; i < num; i++)
  674. line.set_code_point(m_cursor_column + i, ' ');
  675. line.set_dirty(true);
  676. }
  677. #endif
  678. void Terminal::on_input(u8 byte)
  679. {
  680. m_parser.on_input(byte);
  681. }
  682. void Terminal::emit_code_point(u32 code_point)
  683. {
  684. auto new_column = m_cursor_column + 1;
  685. if (new_column < columns()) {
  686. put_character_at(m_cursor_row, m_cursor_column, code_point);
  687. set_cursor(m_cursor_row, new_column);
  688. return;
  689. }
  690. if (m_stomp) {
  691. m_stomp = false;
  692. carriage_return();
  693. linefeed();
  694. put_character_at(m_cursor_row, m_cursor_column, code_point);
  695. set_cursor(m_cursor_row, 1);
  696. } else {
  697. // Curious: We wait once on the right-hand side
  698. m_stomp = true;
  699. put_character_at(m_cursor_row, m_cursor_column, code_point);
  700. }
  701. }
  702. void Terminal::execute_control_code(u8 code)
  703. {
  704. switch (code) {
  705. case '\a':
  706. m_client.beep();
  707. return;
  708. case '\b':
  709. if (m_cursor_column) {
  710. set_cursor(m_cursor_row, m_cursor_column - 1);
  711. return;
  712. }
  713. return;
  714. case '\t': {
  715. for (unsigned i = m_cursor_column + 1; i < columns(); ++i) {
  716. if (m_horizontal_tabs[i]) {
  717. set_cursor(m_cursor_row, i);
  718. return;
  719. }
  720. }
  721. return;
  722. }
  723. case '\n':
  724. case '\v':
  725. case '\f':
  726. linefeed();
  727. return;
  728. case '\r':
  729. carriage_return();
  730. return;
  731. default:
  732. unimplemented_control_code(code);
  733. }
  734. }
  735. void Terminal::execute_escape_sequence(Intermediates intermediates, bool ignore, u8 last_byte)
  736. {
  737. // FIXME: Handle it somehow?
  738. if (ignore)
  739. dbgln("Escape sequence has its ignore flag set.");
  740. if (intermediates.size() == 0) {
  741. switch (last_byte) {
  742. case 'D':
  743. IND();
  744. return;
  745. case 'E':
  746. NEL();
  747. return;
  748. case 'M':
  749. RI();
  750. return;
  751. case '\\':
  752. // ST (string terminator) -- do nothing
  753. return;
  754. }
  755. } else if (intermediates[0] == '#') {
  756. switch (last_byte) {
  757. case '8':
  758. // Confidence Test - Fill screen with E's
  759. for (size_t row = 0; row < m_rows; ++row) {
  760. for (size_t column = 0; column < m_columns; ++column) {
  761. put_character_at(row, column, 'E');
  762. }
  763. }
  764. return;
  765. }
  766. }
  767. unimplemented_escape_sequence(intermediates, last_byte);
  768. }
  769. void Terminal::execute_csi_sequence(Parameters parameters, Intermediates intermediates, bool ignore, u8 last_byte)
  770. {
  771. // FIXME: Handle it somehow?
  772. if (ignore)
  773. dbgln("CSI sequence has its ignore flag set.");
  774. switch (last_byte) {
  775. case '@':
  776. ICH(parameters);
  777. break;
  778. case 'A':
  779. CUU(parameters);
  780. break;
  781. case 'B':
  782. CUD(parameters);
  783. break;
  784. case 'C':
  785. CUF(parameters);
  786. break;
  787. case 'D':
  788. CUB(parameters);
  789. break;
  790. case 'G':
  791. CHA(parameters);
  792. break;
  793. case 'H':
  794. CUP(parameters);
  795. break;
  796. case 'J':
  797. ED(parameters);
  798. break;
  799. case 'K':
  800. EL(parameters);
  801. break;
  802. case 'L':
  803. IL(parameters);
  804. break;
  805. case 'M':
  806. DL(parameters);
  807. break;
  808. case 'P':
  809. DCH(parameters);
  810. break;
  811. case 'S':
  812. SU(parameters);
  813. break;
  814. case 'T':
  815. SD(parameters);
  816. break;
  817. case 'X':
  818. ECH(parameters);
  819. break;
  820. case 'b':
  821. REP(parameters);
  822. break;
  823. case 'd':
  824. VPA(parameters);
  825. break;
  826. case 'm':
  827. SGR(parameters);
  828. break;
  829. case 's':
  830. SCOSC();
  831. break;
  832. case 'u':
  833. SCORC(parameters);
  834. break;
  835. case 't':
  836. XTERM_WM(parameters);
  837. break;
  838. case 'r':
  839. DECSTBM(parameters);
  840. break;
  841. case 'l':
  842. RM(parameters, intermediates);
  843. break;
  844. case 'h':
  845. SM(parameters, intermediates);
  846. break;
  847. case 'c':
  848. DA(parameters);
  849. break;
  850. case 'f':
  851. HVP(parameters);
  852. break;
  853. case 'n':
  854. DSR(parameters);
  855. break;
  856. case 'q':
  857. if (intermediates.size() >= 1 && intermediates[0] == ' ')
  858. DECSCUSR(parameters);
  859. else
  860. unimplemented_csi_sequence(parameters, intermediates, last_byte);
  861. break;
  862. default:
  863. unimplemented_csi_sequence(parameters, intermediates, last_byte);
  864. }
  865. }
  866. void Terminal::execute_osc_sequence(OscParameters parameters, u8 last_byte)
  867. {
  868. auto stringview_ify = [&](size_t param_idx) {
  869. return StringView(parameters[param_idx]);
  870. };
  871. if (parameters.size() == 0 || parameters[0].is_empty()) {
  872. unimplemented_osc_sequence(parameters, last_byte);
  873. return;
  874. }
  875. auto command_number = stringview_ify(0).to_uint();
  876. if (!command_number.has_value()) {
  877. unimplemented_osc_sequence(parameters, last_byte);
  878. return;
  879. }
  880. switch (command_number.value()) {
  881. case 0:
  882. case 1:
  883. case 2:
  884. if (parameters.size() < 2) {
  885. dbgln("Attempted to set window title without any parameters");
  886. } else {
  887. // FIXME: the split breaks titles containing semicolons.
  888. // Should we expose the raw OSC string from the parser? Or join by semicolon?
  889. m_current_window_title = stringview_ify(1).to_string();
  890. m_client.set_window_title(m_current_window_title);
  891. }
  892. break;
  893. case 8:
  894. #ifndef KERNEL
  895. if (parameters.size() < 3) {
  896. dbgln("Attempted to set href but gave too few parameters");
  897. } else if (parameters[1].is_empty() && parameters[2].is_empty()) {
  898. // Clear hyperlink
  899. m_current_attribute.href = String();
  900. m_current_attribute.href_id = String();
  901. } else {
  902. m_current_attribute.href = stringview_ify(2);
  903. // FIXME: Respect the provided ID
  904. m_current_attribute.href_id = String::number(m_next_href_id++);
  905. }
  906. #endif
  907. break;
  908. case 9:
  909. if (parameters.size() < 2)
  910. dbgln("Atttempted to set window progress but gave too few parameters");
  911. else if (parameters.size() == 2)
  912. m_client.set_window_progress(stringview_ify(1).to_int().value_or(-1), 0);
  913. else
  914. m_client.set_window_progress(stringview_ify(1).to_int().value_or(-1), stringview_ify(2).to_int().value_or(0));
  915. break;
  916. default:
  917. unimplemented_osc_sequence(parameters, last_byte);
  918. }
  919. }
  920. void Terminal::dcs_hook(Parameters, Intermediates, bool, u8)
  921. {
  922. dbgln("Received DCS parameters, but we don't support it yet");
  923. }
  924. void Terminal::receive_dcs_char(u8 byte)
  925. {
  926. dbgln_if(TERMINAL_DEBUG, "DCS string character {:c}", byte);
  927. }
  928. void Terminal::execute_dcs_sequence()
  929. {
  930. }
  931. void Terminal::inject_string(const StringView& str)
  932. {
  933. for (size_t i = 0; i < str.length(); ++i)
  934. on_input(str[i]);
  935. }
  936. void Terminal::emit_string(const StringView& string)
  937. {
  938. m_client.emit((const u8*)string.characters_without_null_termination(), string.length());
  939. }
  940. void Terminal::handle_key_press(KeyCode key, u32 code_point, u8 flags)
  941. {
  942. bool ctrl = flags & Mod_Ctrl;
  943. bool alt = flags & Mod_Alt;
  944. bool shift = flags & Mod_Shift;
  945. unsigned modifier_mask = int(shift) + (int(alt) << 1) + (int(ctrl) << 2);
  946. auto emit_final_with_modifier = [this, modifier_mask](char final) {
  947. if (modifier_mask)
  948. emit_string(String::formatted("\e[1;{}{:c}", modifier_mask + 1, final));
  949. else
  950. emit_string(String::formatted("\e[{:c}", final));
  951. };
  952. auto emit_tilde_with_modifier = [this, modifier_mask](unsigned num) {
  953. if (modifier_mask)
  954. emit_string(String::formatted("\e[{};{}~", num, modifier_mask + 1));
  955. else
  956. emit_string(String::formatted("\e[{}~", num));
  957. };
  958. switch (key) {
  959. case KeyCode::Key_Up:
  960. emit_final_with_modifier('A');
  961. return;
  962. case KeyCode::Key_Down:
  963. emit_final_with_modifier('B');
  964. return;
  965. case KeyCode::Key_Right:
  966. emit_final_with_modifier('C');
  967. return;
  968. case KeyCode::Key_Left:
  969. emit_final_with_modifier('D');
  970. return;
  971. case KeyCode::Key_Insert:
  972. emit_tilde_with_modifier(2);
  973. return;
  974. case KeyCode::Key_Delete:
  975. emit_tilde_with_modifier(3);
  976. return;
  977. case KeyCode::Key_Home:
  978. emit_final_with_modifier('H');
  979. return;
  980. case KeyCode::Key_End:
  981. emit_final_with_modifier('F');
  982. return;
  983. case KeyCode::Key_PageUp:
  984. emit_tilde_with_modifier(5);
  985. return;
  986. case KeyCode::Key_PageDown:
  987. emit_tilde_with_modifier(6);
  988. return;
  989. case KeyCode::Key_Return:
  990. // The standard says that CR should be generated by the return key.
  991. // The TTY will take care of translating it to CR LF for the terminal.
  992. emit_string("\r");
  993. return;
  994. default:
  995. break;
  996. }
  997. if (!code_point) {
  998. // Probably a modifier being pressed.
  999. return;
  1000. }
  1001. if (shift && key == KeyCode::Key_Tab) {
  1002. emit_string("\033[Z");
  1003. return;
  1004. }
  1005. // Key event was not one of the above special cases,
  1006. // attempt to treat it as a character...
  1007. if (ctrl) {
  1008. if (code_point >= 'a' && code_point <= 'z') {
  1009. code_point = code_point - 'a' + 1;
  1010. } else if (code_point == '\\') {
  1011. code_point = 0x1c;
  1012. }
  1013. }
  1014. // Alt modifier sends escape prefix.
  1015. if (alt)
  1016. emit_string("\033");
  1017. StringBuilder sb;
  1018. sb.append_code_point(code_point);
  1019. emit_string(sb.to_string());
  1020. }
  1021. void Terminal::unimplemented_control_code(u8 code)
  1022. {
  1023. dbgln("Unimplemented control code {:02x}", code);
  1024. }
  1025. void Terminal::unimplemented_escape_sequence(Intermediates intermediates, u8 last_byte)
  1026. {
  1027. StringBuilder builder;
  1028. builder.appendff("Unimplemented escape sequence {:c}", last_byte);
  1029. if (!intermediates.is_empty()) {
  1030. builder.append(", intermediates: ");
  1031. for (size_t i = 0; i < intermediates.size(); ++i)
  1032. builder.append((char)intermediates[i]);
  1033. }
  1034. dbgln("{}", builder.string_view());
  1035. }
  1036. void Terminal::unimplemented_csi_sequence(Parameters parameters, Intermediates intermediates, u8 last_byte)
  1037. {
  1038. StringBuilder builder;
  1039. builder.appendff("Unimplemented CSI sequence: {:c}", last_byte);
  1040. if (!parameters.is_empty()) {
  1041. builder.append(", parameters: [");
  1042. for (size_t i = 0; i < parameters.size(); ++i)
  1043. builder.appendff("{}{}", (i == 0) ? "" : ", ", parameters[i]);
  1044. builder.append("]");
  1045. }
  1046. if (!intermediates.is_empty()) {
  1047. builder.append(", intermediates:");
  1048. for (size_t i = 0; i < intermediates.size(); ++i)
  1049. builder.append((char)intermediates[i]);
  1050. }
  1051. dbgln("{}", builder.string_view());
  1052. }
  1053. void Terminal::unimplemented_osc_sequence(OscParameters parameters, u8 last_byte)
  1054. {
  1055. StringBuilder builder;
  1056. builder.appendff("Unimplemented OSC sequence parameters: (bel_terminated={}) [ ", last_byte == '\a');
  1057. bool first = true;
  1058. for (auto parameter : parameters) {
  1059. if (!first)
  1060. builder.append(", ");
  1061. builder.append("[");
  1062. for (auto character : parameter)
  1063. builder.append((char)character);
  1064. builder.append("]");
  1065. first = false;
  1066. }
  1067. builder.append(" ]");
  1068. dbgln("{}", builder.string_view());
  1069. }
  1070. #ifndef KERNEL
  1071. void Terminal::set_size(u16 columns, u16 rows)
  1072. {
  1073. if (!columns)
  1074. columns = 1;
  1075. if (!rows)
  1076. rows = 1;
  1077. if (columns == m_columns && rows == m_rows)
  1078. return;
  1079. if (rows > m_rows) {
  1080. while (m_lines.size() < rows)
  1081. m_lines.append(make<Line>(columns));
  1082. } else {
  1083. m_lines.shrink(rows);
  1084. }
  1085. for (int i = 0; i < rows; ++i)
  1086. m_lines[i].set_length(columns);
  1087. m_columns = columns;
  1088. m_rows = rows;
  1089. m_scroll_region_top = 0;
  1090. m_scroll_region_bottom = rows - 1;
  1091. m_cursor_row = min((int)m_cursor_row, m_rows - 1);
  1092. m_cursor_column = min((int)m_cursor_column, m_columns - 1);
  1093. m_saved_cursor_row = min((int)m_saved_cursor_row, m_rows - 1);
  1094. m_saved_cursor_column = min((int)m_saved_cursor_column, m_columns - 1);
  1095. m_horizontal_tabs.resize(columns);
  1096. for (unsigned i = 0; i < columns; ++i)
  1097. m_horizontal_tabs[i] = (i % 8) == 0;
  1098. // Rightmost column is always last tab on line.
  1099. m_horizontal_tabs[columns - 1] = 1;
  1100. m_client.terminal_did_resize(m_columns, m_rows);
  1101. }
  1102. #endif
  1103. #ifndef KERNEL
  1104. void Terminal::invalidate_cursor()
  1105. {
  1106. m_lines[m_cursor_row].set_dirty(true);
  1107. }
  1108. Attribute Terminal::attribute_at(const Position& position) const
  1109. {
  1110. if (!position.is_valid())
  1111. return {};
  1112. if (position.row() >= static_cast<int>(line_count()))
  1113. return {};
  1114. auto& line = this->line(position.row());
  1115. if (static_cast<size_t>(position.column()) >= line.length())
  1116. return {};
  1117. return line.attribute_at(position.column());
  1118. }
  1119. #endif
  1120. }