Terminal.cpp 33 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252
  1. #include "Terminal.h"
  2. #include "XtermColors.h"
  3. #include <AK/AKString.h>
  4. #include <AK/StdLibExtras.h>
  5. #include <AK/StringBuilder.h>
  6. #include <Kernel/KeyCode.h>
  7. #include <LibGUI/GApplication.h>
  8. #include <LibGUI/GClipboard.h>
  9. #include <LibGUI/GPainter.h>
  10. #include <LibGUI/GWindow.h>
  11. #include <SharedGraphics/Font.h>
  12. #include <errno.h>
  13. #include <stdio.h>
  14. #include <stdlib.h>
  15. #include <string.h>
  16. #include <sys/ioctl.h>
  17. #include <unistd.h>
  18. //#define TERMINAL_DEBUG
  19. byte Terminal::Attribute::default_foreground_color = 7;
  20. byte Terminal::Attribute::default_background_color = 0;
  21. Terminal::Terminal(int ptm_fd, RefPtr<CConfigFile> config)
  22. : m_ptm_fd(ptm_fd)
  23. , m_notifier(ptm_fd, CNotifier::Read)
  24. , m_config(config)
  25. {
  26. set_frame_shape(FrameShape::Container);
  27. set_frame_shadow(FrameShadow::Sunken);
  28. set_frame_thickness(2);
  29. dbgprintf("Terminal: Load config file from %s\n", m_config->file_name().characters());
  30. m_cursor_blink_timer.set_interval(m_config->read_num_entry("Text",
  31. "CursorBlinkInterval",
  32. 500));
  33. m_cursor_blink_timer.on_timeout = [this] {
  34. m_cursor_blink_state = !m_cursor_blink_state;
  35. update_cursor();
  36. };
  37. auto font_entry = m_config->read_entry("Text", "Font", "default");
  38. if (font_entry == "default")
  39. set_font(Font::default_fixed_width_font());
  40. else
  41. set_font(Font::load_from_file(font_entry));
  42. m_notifier.on_ready_to_read = [this] {
  43. byte buffer[BUFSIZ];
  44. ssize_t nread = read(m_ptm_fd, buffer, sizeof(buffer));
  45. if (nread < 0) {
  46. dbgprintf("Terminal read error: %s\n", strerror(errno));
  47. perror("read(ptm)");
  48. GApplication::the().quit(1);
  49. return;
  50. }
  51. if (nread == 0) {
  52. dbgprintf("Terminal: EOF on master pty, closing.\n");
  53. GApplication::the().quit(0);
  54. return;
  55. }
  56. for (ssize_t i = 0; i < nread; ++i)
  57. on_char(buffer[i]);
  58. flush_dirty_lines();
  59. };
  60. m_line_height = font().glyph_height() + m_line_spacing;
  61. set_size(m_config->read_num_entry("Window", "Width", 80),
  62. m_config->read_num_entry("Window", "Height", 25));
  63. }
  64. Terminal::Line::Line(word length)
  65. {
  66. set_length(length);
  67. }
  68. Terminal::Line::~Line()
  69. {
  70. delete[] characters;
  71. delete[] attributes;
  72. }
  73. void Terminal::Line::set_length(word new_length)
  74. {
  75. if (m_length == new_length)
  76. return;
  77. auto* new_characters = new byte[new_length];
  78. auto* new_attributes = new Attribute[new_length];
  79. memset(new_characters, ' ', new_length);
  80. delete[] characters;
  81. delete[] attributes;
  82. characters = new_characters;
  83. attributes = new_attributes;
  84. m_length = new_length;
  85. }
  86. void Terminal::Line::clear(Attribute attribute)
  87. {
  88. if (dirty) {
  89. memset(characters, ' ', m_length);
  90. for (word i = 0; i < m_length; ++i)
  91. attributes[i] = attribute;
  92. return;
  93. }
  94. for (unsigned i = 0; i < m_length; ++i) {
  95. if (characters[i] != ' ')
  96. dirty = true;
  97. characters[i] = ' ';
  98. }
  99. for (unsigned i = 0; i < m_length; ++i) {
  100. if (attributes[i] != attribute)
  101. dirty = true;
  102. attributes[i] = attribute;
  103. }
  104. }
  105. Terminal::~Terminal()
  106. {
  107. }
  108. void Terminal::clear()
  109. {
  110. for (size_t i = 0; i < rows(); ++i)
  111. line(i).clear(m_current_attribute);
  112. set_cursor(0, 0);
  113. }
  114. inline bool is_valid_parameter_character(byte ch)
  115. {
  116. return ch >= 0x30 && ch <= 0x3f;
  117. }
  118. inline bool is_valid_intermediate_character(byte ch)
  119. {
  120. return ch >= 0x20 && ch <= 0x2f;
  121. }
  122. inline bool is_valid_final_character(byte ch)
  123. {
  124. return ch >= 0x40 && ch <= 0x7e;
  125. }
  126. static inline Color lookup_color(unsigned color)
  127. {
  128. return Color::from_rgb(xterm_colors[color]);
  129. }
  130. void Terminal::escape$h_l(bool should_set, bool question_param, const ParamVector& params)
  131. {
  132. int mode = 2;
  133. if (params.size() > 0) {
  134. mode = params[0];
  135. }
  136. if (!question_param) {
  137. switch (mode) {
  138. // FIXME: implement *something* for this
  139. default:
  140. unimplemented_escape();
  141. break;
  142. }
  143. } else {
  144. switch (mode) {
  145. case 25:
  146. // Hide cursor command, but doesn't need to be run (for now, because
  147. // we don't do inverse control codes anyways)
  148. if (should_set)
  149. dbgprintf("Terminal: Hide Cursor escapecode recieved. Not needed: ignored.\n");
  150. else
  151. dbgprintf("Terminal: Show Cursor escapecode recieved. Not needed: ignored.\n");
  152. break;
  153. default:
  154. break;
  155. }
  156. }
  157. }
  158. void Terminal::escape$m(const ParamVector& params)
  159. {
  160. if (params.is_empty()) {
  161. m_current_attribute.reset();
  162. return;
  163. }
  164. if (params.size() == 3 && params[1] == 5) {
  165. if (params[0] == 38) {
  166. m_current_attribute.foreground_color = params[2];
  167. return;
  168. } else if (params[0] == 48) {
  169. m_current_attribute.background_color = params[2];
  170. return;
  171. }
  172. }
  173. for (auto param : params) {
  174. switch (param) {
  175. case 0:
  176. // Reset
  177. m_current_attribute.reset();
  178. break;
  179. case 1:
  180. m_current_attribute.flags |= Attribute::Bold;
  181. break;
  182. case 3:
  183. m_current_attribute.flags |= Attribute::Italic;
  184. break;
  185. case 4:
  186. m_current_attribute.flags |= Attribute::Underline;
  187. break;
  188. case 5:
  189. m_current_attribute.flags |= Attribute::Blink;
  190. break;
  191. case 7:
  192. m_current_attribute.flags |= Attribute::Negative;
  193. break;
  194. case 22:
  195. m_current_attribute.flags &= ~Attribute::Bold;
  196. break;
  197. case 23:
  198. m_current_attribute.flags &= ~Attribute::Italic;
  199. break;
  200. case 24:
  201. m_current_attribute.flags &= ~Attribute::Underline;
  202. break;
  203. case 25:
  204. m_current_attribute.flags &= ~Attribute::Blink;
  205. break;
  206. case 27:
  207. m_current_attribute.flags &= ~Attribute::Negative;
  208. break;
  209. case 30:
  210. case 31:
  211. case 32:
  212. case 33:
  213. case 34:
  214. case 35:
  215. case 36:
  216. case 37:
  217. // Foreground color
  218. if (m_current_attribute.flags & Attribute::Bold)
  219. param += 8;
  220. m_current_attribute.foreground_color = param - 30;
  221. break;
  222. case 39:
  223. // reset foreground
  224. m_current_attribute.foreground_color = Attribute::default_foreground_color;
  225. break;
  226. case 40:
  227. case 41:
  228. case 42:
  229. case 43:
  230. case 44:
  231. case 45:
  232. case 46:
  233. case 47:
  234. // Background color
  235. if (m_current_attribute.flags & Attribute::Bold)
  236. param += 8;
  237. m_current_attribute.background_color = param - 40;
  238. break;
  239. case 49:
  240. // reset background
  241. m_current_attribute.background_color = Attribute::default_background_color;
  242. break;
  243. default:
  244. dbgprintf("FIXME: escape$m: p: %u\n", param);
  245. }
  246. }
  247. }
  248. void Terminal::escape$s(const ParamVector&)
  249. {
  250. m_saved_cursor_row = m_cursor_row;
  251. m_saved_cursor_column = m_cursor_column;
  252. }
  253. void Terminal::escape$u(const ParamVector&)
  254. {
  255. set_cursor(m_saved_cursor_row, m_saved_cursor_column);
  256. }
  257. void Terminal::escape$t(const ParamVector& params)
  258. {
  259. if (params.size() < 1)
  260. return;
  261. dbgprintf("FIXME: escape$t: Ps: %u (param count: %d)\n", params[0], params.size());
  262. }
  263. void Terminal::escape$r(const ParamVector& params)
  264. {
  265. unsigned top = 1;
  266. unsigned bottom = m_rows;
  267. if (params.size() >= 1)
  268. top = params[0];
  269. if (params.size() >= 2)
  270. bottom = params[1];
  271. if ((bottom - top) < 2 || bottom > m_rows) {
  272. dbgprintf("Error: escape$r: scrolling region invalid: %u-%u\n", top, bottom);
  273. return;
  274. }
  275. m_scroll_region_top = top - 1;
  276. m_scroll_region_bottom = bottom - 1;
  277. set_cursor(0, 0);
  278. }
  279. void Terminal::escape$H(const ParamVector& params)
  280. {
  281. unsigned row = 1;
  282. unsigned col = 1;
  283. if (params.size() >= 1)
  284. row = params[0];
  285. if (params.size() >= 2)
  286. col = params[1];
  287. set_cursor(row - 1, col - 1);
  288. }
  289. void Terminal::escape$A(const ParamVector& params)
  290. {
  291. int num = 1;
  292. if (params.size() >= 1)
  293. num = params[0];
  294. if (num == 0)
  295. num = 1;
  296. int new_row = (int)m_cursor_row - num;
  297. if (new_row < 0)
  298. new_row = 0;
  299. set_cursor(new_row, m_cursor_column);
  300. }
  301. void Terminal::escape$B(const ParamVector& params)
  302. {
  303. int num = 1;
  304. if (params.size() >= 1)
  305. num = params[0];
  306. if (num == 0)
  307. num = 1;
  308. int new_row = (int)m_cursor_row + num;
  309. if (new_row >= m_rows)
  310. new_row = m_rows - 1;
  311. set_cursor(new_row, m_cursor_column);
  312. }
  313. void Terminal::escape$C(const ParamVector& params)
  314. {
  315. int num = 1;
  316. if (params.size() >= 1)
  317. num = params[0];
  318. if (num == 0)
  319. num = 1;
  320. int new_column = (int)m_cursor_column + num;
  321. if (new_column >= m_columns)
  322. new_column = m_columns - 1;
  323. set_cursor(m_cursor_row, new_column);
  324. }
  325. void Terminal::escape$D(const ParamVector& params)
  326. {
  327. int num = 1;
  328. if (params.size() >= 1)
  329. num = params[0];
  330. if (num == 0)
  331. num = 1;
  332. int new_column = (int)m_cursor_column - num;
  333. if (new_column < 0)
  334. new_column = 0;
  335. set_cursor(m_cursor_row, new_column);
  336. }
  337. void Terminal::escape$G(const ParamVector& params)
  338. {
  339. int new_column = 1;
  340. if (params.size() >= 1)
  341. new_column = params[0] - 1;
  342. if (new_column < 0)
  343. new_column = 0;
  344. set_cursor(m_cursor_row, new_column);
  345. }
  346. void Terminal::escape$b(const ParamVector& params)
  347. {
  348. if (params.size() < 1)
  349. return;
  350. for (unsigned i = 0; i < params[0]; ++i)
  351. put_character_at(m_cursor_row, m_cursor_column++, m_last_char);
  352. }
  353. void Terminal::escape$d(const ParamVector& params)
  354. {
  355. int new_row = 1;
  356. if (params.size() >= 1)
  357. new_row = params[0] - 1;
  358. if (new_row < 0)
  359. new_row = 0;
  360. set_cursor(new_row, m_cursor_column);
  361. }
  362. void Terminal::escape$X(const ParamVector& params)
  363. {
  364. // Erase characters (without moving cursor)
  365. int num = 1;
  366. if (params.size() >= 1)
  367. num = params[0];
  368. if (num == 0)
  369. num = 1;
  370. // Clear from cursor to end of line.
  371. for (int i = m_cursor_column; i < num; ++i) {
  372. put_character_at(m_cursor_row, i, ' ');
  373. }
  374. }
  375. void Terminal::escape$K(const ParamVector& params)
  376. {
  377. int mode = 0;
  378. if (params.size() >= 1)
  379. mode = params[0];
  380. switch (mode) {
  381. case 0:
  382. // Clear from cursor to end of line.
  383. for (int i = m_cursor_column; i < m_columns; ++i) {
  384. put_character_at(m_cursor_row, i, ' ');
  385. }
  386. break;
  387. case 1:
  388. // Clear from cursor to beginning of line.
  389. for (int i = 0; i < m_cursor_column; ++i) {
  390. put_character_at(m_cursor_row, i, ' ');
  391. }
  392. break;
  393. case 2:
  394. // Clear the complete line
  395. for (int i = 0; i < m_columns; ++i) {
  396. put_character_at(m_cursor_row, i, ' ');
  397. }
  398. break;
  399. default:
  400. unimplemented_escape();
  401. break;
  402. }
  403. }
  404. void Terminal::escape$J(const ParamVector& params)
  405. {
  406. int mode = 0;
  407. if (params.size() >= 1)
  408. mode = params[0];
  409. switch (mode) {
  410. case 0:
  411. // Clear from cursor to end of screen.
  412. for (int i = m_cursor_column; i < m_columns; ++i)
  413. put_character_at(m_cursor_row, i, ' ');
  414. for (int row = m_cursor_row + 1; row < m_rows; ++row) {
  415. for (int column = 0; column < m_columns; ++column) {
  416. put_character_at(row, column, ' ');
  417. }
  418. }
  419. break;
  420. case 1:
  421. /// Clear from cursor to beginning of screen
  422. for (int i = m_cursor_column - 1; i >= 0; --i)
  423. put_character_at(m_cursor_row, i, ' ');
  424. for (int row = m_cursor_row - 1; row >= 0; --row) {
  425. for (int column = 0; column < m_columns; ++column) {
  426. put_character_at(row, column, ' ');
  427. }
  428. }
  429. break;
  430. case 2:
  431. clear();
  432. break;
  433. case 3:
  434. // FIXME: <esc>[3J should also clear the scrollback buffer.
  435. clear();
  436. break;
  437. default:
  438. unimplemented_escape();
  439. break;
  440. }
  441. }
  442. void Terminal::escape$S(const ParamVector& params)
  443. {
  444. int count = 1;
  445. if (params.size() >= 1)
  446. count = params[0];
  447. for (word i = 0; i < count; i++)
  448. scroll_up();
  449. }
  450. void Terminal::escape$T(const ParamVector& params)
  451. {
  452. int count = 1;
  453. if (params.size() >= 1)
  454. count = params[0];
  455. for (word i = 0; i < count; i++)
  456. scroll_down();
  457. }
  458. void Terminal::escape$L(const ParamVector& params)
  459. {
  460. int count = 1;
  461. if (params.size() >= 1)
  462. count = params[0];
  463. invalidate_cursor();
  464. for (; count > 0; --count) {
  465. m_lines.insert(m_cursor_row + m_scroll_region_top, make<Line>(m_columns));
  466. if (m_scroll_region_bottom + 1 < m_lines.size())
  467. m_lines.remove(m_scroll_region_bottom + 1);
  468. else
  469. m_lines.remove(m_lines.size() - 1);
  470. }
  471. m_need_full_flush = true;
  472. }
  473. void Terminal::escape$M(const ParamVector& params)
  474. {
  475. int count = 1;
  476. if (params.size() >= 1)
  477. count = params[0];
  478. if (count == 1 && m_cursor_row == 0) {
  479. scroll_up();
  480. return;
  481. }
  482. int max_count = m_rows - (m_scroll_region_top + m_cursor_row);
  483. count = min(count, max_count);
  484. for (int c = count; c > 0; --c) {
  485. m_lines.remove(m_cursor_row + m_scroll_region_top);
  486. if (m_scroll_region_bottom < m_lines.size())
  487. m_lines.insert(m_scroll_region_bottom, make<Line>(m_columns));
  488. else
  489. m_lines.append(make<Line>(m_columns));
  490. }
  491. }
  492. void Terminal::escape$P(const ParamVector& params)
  493. {
  494. int num = 1;
  495. if (params.size() >= 1)
  496. num = params[0];
  497. if (num == 0)
  498. num = 1;
  499. auto& line = this->line(m_cursor_row);
  500. // Move n characters of line to the left
  501. for (int i = m_cursor_column; i < line.m_length - num; i++)
  502. line.characters[i] = line.characters[i + num];
  503. // Fill remainder of line with blanks
  504. for (int i = line.m_length - num; i < line.m_length; i++)
  505. line.characters[i] = ' ';
  506. line.dirty = true;
  507. }
  508. void Terminal::execute_xterm_command()
  509. {
  510. m_final = '@';
  511. bool ok;
  512. unsigned value = String::copy(m_xterm_param1).to_uint(ok);
  513. if (ok) {
  514. switch (value) {
  515. case 0:
  516. case 1:
  517. case 2:
  518. set_window_title(String::copy(m_xterm_param2));
  519. break;
  520. default:
  521. unimplemented_xterm_escape();
  522. break;
  523. }
  524. }
  525. m_xterm_param1.clear_with_capacity();
  526. m_xterm_param2.clear_with_capacity();
  527. }
  528. void Terminal::execute_escape_sequence(byte final)
  529. {
  530. bool question_param = false;
  531. m_final = final;
  532. ParamVector params;
  533. if (m_parameters.size() > 0 && m_parameters[0] == '?') {
  534. question_param = true;
  535. m_parameters.remove(0);
  536. }
  537. auto paramparts = String::copy(m_parameters).split(';');
  538. for (auto& parampart : paramparts) {
  539. bool ok;
  540. unsigned value = parampart.to_uint(ok);
  541. if (!ok) {
  542. // FIXME: Should we do something else?
  543. m_parameters.clear_with_capacity();
  544. m_intermediates.clear_with_capacity();
  545. return;
  546. }
  547. params.append(value);
  548. }
  549. #if defined(TERMINAL_DEBUG)
  550. dbgprintf("Terminal::execute_escape_sequence: Handled final '%c'\n", final);
  551. dbgprintf("Params: ");
  552. for (auto& p : params) {
  553. dbgprintf("%d ", p);
  554. }
  555. dbgprintf("\b\n");
  556. #endif
  557. switch (final) {
  558. case 'A':
  559. escape$A(params);
  560. break;
  561. case 'B':
  562. escape$B(params);
  563. break;
  564. case 'C':
  565. escape$C(params);
  566. break;
  567. case 'D':
  568. escape$D(params);
  569. break;
  570. case 'H':
  571. escape$H(params);
  572. break;
  573. case 'J':
  574. escape$J(params);
  575. break;
  576. case 'K':
  577. escape$K(params);
  578. break;
  579. case 'M':
  580. escape$M(params);
  581. break;
  582. case 'P':
  583. escape$P(params);
  584. break;
  585. case 'S':
  586. escape$S(params);
  587. break;
  588. case 'T':
  589. escape$T(params);
  590. break;
  591. case 'L':
  592. escape$L(params);
  593. break;
  594. case 'G':
  595. escape$G(params);
  596. break;
  597. case 'X':
  598. escape$X(params);
  599. break;
  600. case 'b':
  601. escape$b(params);
  602. break;
  603. case 'd':
  604. escape$d(params);
  605. break;
  606. case 'm':
  607. escape$m(params);
  608. break;
  609. case 's':
  610. escape$s(params);
  611. break;
  612. case 'u':
  613. escape$u(params);
  614. break;
  615. case 't':
  616. escape$t(params);
  617. break;
  618. case 'r':
  619. escape$r(params);
  620. break;
  621. case 'l':
  622. escape$h_l(true, question_param, params);
  623. break;
  624. case 'h':
  625. escape$h_l(false, question_param, params);
  626. break;
  627. default:
  628. dbgprintf("Terminal::execute_escape_sequence: Unhandled final '%c'\n", final);
  629. break;
  630. }
  631. #if defined(TERMINAL_DEBUG)
  632. dbgprintf("\n");
  633. for (auto& line : m_lines) {
  634. dbgprintf("Terminal: Line: ");
  635. for (int i = 0; i < line->length; i++) {
  636. dbgprintf("%c", line->characters[i]);
  637. }
  638. dbgprintf("\n");
  639. }
  640. #endif
  641. m_parameters.clear_with_capacity();
  642. m_intermediates.clear_with_capacity();
  643. }
  644. void Terminal::newline()
  645. {
  646. word new_row = m_cursor_row;
  647. if (m_cursor_row == m_scroll_region_bottom) {
  648. scroll_up();
  649. } else {
  650. ++new_row;
  651. }
  652. set_cursor(new_row, 0);
  653. }
  654. void Terminal::scroll_up()
  655. {
  656. // NOTE: We have to invalidate the cursor first.
  657. invalidate_cursor();
  658. m_lines.remove(m_scroll_region_top);
  659. m_lines.insert(m_scroll_region_bottom, make<Line>(m_columns));
  660. m_need_full_flush = true;
  661. }
  662. void Terminal::scroll_down()
  663. {
  664. // NOTE: We have to invalidate the cursor first.
  665. invalidate_cursor();
  666. m_lines.remove(m_scroll_region_bottom);
  667. m_lines.insert(m_scroll_region_top, make<Line>(m_columns));
  668. m_need_full_flush = true;
  669. }
  670. void Terminal::set_cursor(unsigned a_row, unsigned a_column)
  671. {
  672. unsigned row = min(a_row, m_rows - 1u);
  673. unsigned column = min(a_column, m_columns - 1u);
  674. if (row == m_cursor_row && column == m_cursor_column)
  675. return;
  676. ASSERT(row < rows());
  677. ASSERT(column < columns());
  678. invalidate_cursor();
  679. m_cursor_row = row;
  680. m_cursor_column = column;
  681. if (column != columns() - 1u)
  682. m_stomp = false;
  683. invalidate_cursor();
  684. }
  685. void Terminal::put_character_at(unsigned row, unsigned column, byte ch)
  686. {
  687. ASSERT(row < rows());
  688. ASSERT(column < columns());
  689. auto& line = this->line(row);
  690. line.characters[column] = ch;
  691. line.attributes[column] = m_current_attribute;
  692. line.dirty = true;
  693. m_last_char = ch;
  694. }
  695. void Terminal::on_char(byte ch)
  696. {
  697. #ifdef TERMINAL_DEBUG
  698. dbgprintf("Terminal::on_char: %b (%c), fg=%u, bg=%u\n", ch, ch, m_current_attribute.foreground_color, m_current_attribute.background_color);
  699. #endif
  700. switch (m_escape_state) {
  701. case ExpectBracket:
  702. if (ch == '[')
  703. m_escape_state = ExpectParameter;
  704. else if (ch == '(') {
  705. m_swallow_current = true;
  706. m_escape_state = ExpectParameter;
  707. } else if (ch == ']')
  708. m_escape_state = ExpectXtermParameter1;
  709. else
  710. m_escape_state = Normal;
  711. return;
  712. case ExpectXtermParameter1:
  713. if (ch != ';') {
  714. m_xterm_param1.append(ch);
  715. return;
  716. }
  717. m_escape_state = ExpectXtermParameter2;
  718. return;
  719. case ExpectXtermParameter2:
  720. if (ch != '\007') {
  721. m_xterm_param2.append(ch);
  722. return;
  723. }
  724. m_escape_state = ExpectXtermFinal;
  725. [[fallthrough]];
  726. case ExpectXtermFinal:
  727. m_escape_state = Normal;
  728. if (ch == '\007')
  729. execute_xterm_command();
  730. return;
  731. case ExpectParameter:
  732. if (is_valid_parameter_character(ch)) {
  733. m_parameters.append(ch);
  734. return;
  735. }
  736. m_escape_state = ExpectIntermediate;
  737. [[fallthrough]];
  738. case ExpectIntermediate:
  739. if (is_valid_intermediate_character(ch)) {
  740. m_intermediates.append(ch);
  741. return;
  742. }
  743. m_escape_state = ExpectFinal;
  744. [[fallthrough]];
  745. case ExpectFinal:
  746. if (is_valid_final_character(ch)) {
  747. m_escape_state = Normal;
  748. if (!m_swallow_current)
  749. execute_escape_sequence(ch);
  750. m_swallow_current = false;
  751. return;
  752. }
  753. m_escape_state = Normal;
  754. m_swallow_current = false;
  755. return;
  756. case Normal:
  757. break;
  758. }
  759. switch (ch) {
  760. case '\0':
  761. return;
  762. case '\033':
  763. m_escape_state = ExpectBracket;
  764. m_swallow_current = false;
  765. return;
  766. case 8: // Backspace
  767. if (m_cursor_column) {
  768. set_cursor(m_cursor_row, m_cursor_column - 1);
  769. put_character_at(m_cursor_row, m_cursor_column, ' ');
  770. return;
  771. }
  772. return;
  773. case '\a':
  774. if (m_should_beep)
  775. sysbeep();
  776. else {
  777. m_visual_beep_timer.restart(200);
  778. m_visual_beep_timer.set_single_shot(true);
  779. m_visual_beep_timer.on_timeout = [this] {
  780. force_repaint();
  781. };
  782. force_repaint();
  783. }
  784. return;
  785. case '\t': {
  786. for (unsigned i = m_cursor_column; i < columns(); ++i) {
  787. if (m_horizontal_tabs[i]) {
  788. set_cursor(m_cursor_row, i);
  789. return;
  790. }
  791. }
  792. return;
  793. }
  794. case '\r':
  795. set_cursor(m_cursor_row, 0);
  796. return;
  797. case '\n':
  798. newline();
  799. return;
  800. }
  801. auto new_column = m_cursor_column + 1;
  802. if (new_column < columns()) {
  803. put_character_at(m_cursor_row, m_cursor_column, ch);
  804. set_cursor(m_cursor_row, new_column);
  805. } else {
  806. if (m_stomp) {
  807. m_stomp = false;
  808. newline();
  809. put_character_at(m_cursor_row, m_cursor_column, ch);
  810. set_cursor(m_cursor_row, 1);
  811. } else {
  812. // Curious: We wait once on the right-hand side
  813. m_stomp = true;
  814. put_character_at(m_cursor_row, m_cursor_column, ch);
  815. }
  816. }
  817. }
  818. void Terminal::inject_string(const String& str)
  819. {
  820. for (int i = 0; i < str.length(); ++i)
  821. on_char(str[i]);
  822. }
  823. void Terminal::unimplemented_escape()
  824. {
  825. StringBuilder builder;
  826. builder.appendf("((Unimplemented escape: %c", m_final);
  827. if (!m_parameters.is_empty()) {
  828. builder.append(" parameters:");
  829. for (int i = 0; i < m_parameters.size(); ++i)
  830. builder.append((char)m_parameters[i]);
  831. }
  832. if (!m_intermediates.is_empty()) {
  833. builder.append(" intermediates:");
  834. for (int i = 0; i < m_intermediates.size(); ++i)
  835. builder.append((char)m_intermediates[i]);
  836. }
  837. builder.append("))");
  838. inject_string(builder.to_string());
  839. }
  840. void Terminal::unimplemented_xterm_escape()
  841. {
  842. auto message = String::format("((Unimplemented xterm escape: %c))\n", m_final);
  843. inject_string(message);
  844. }
  845. void Terminal::set_size(word columns, word rows)
  846. {
  847. if (columns == m_columns && rows == m_rows)
  848. return;
  849. #if defined(TERMINAL_DEBUG)
  850. dbgprintf("Terminal: RESIZE to: %d rows\n", rows);
  851. #endif
  852. if (rows > m_rows) {
  853. while (m_lines.size() < rows)
  854. m_lines.append(make<Line>(columns));
  855. } else {
  856. m_lines.resize(rows);
  857. }
  858. for (int i = 0; i < rows; ++i)
  859. m_lines[i]->set_length(columns);
  860. m_columns = columns;
  861. m_rows = rows;
  862. m_scroll_region_top = 0;
  863. m_scroll_region_bottom = rows - 1;
  864. m_cursor_row = 0;
  865. m_cursor_column = 0;
  866. m_saved_cursor_row = 0;
  867. m_saved_cursor_column = 0;
  868. m_horizontal_tabs.resize(columns);
  869. for (unsigned i = 0; i < columns; ++i)
  870. m_horizontal_tabs[i] = (i % 8) == 0;
  871. // Rightmost column is always last tab on line.
  872. m_horizontal_tabs[columns - 1] = 1;
  873. m_pixel_width = (frame_thickness() * 2) + (m_inset * 2) + (m_columns * font().glyph_width('x'));
  874. m_pixel_height = (frame_thickness() * 2) + (m_inset * 2) + (m_rows * (font().glyph_height() + m_line_spacing)) - m_line_spacing;
  875. set_size_policy(SizePolicy::Fixed, SizePolicy::Fixed);
  876. set_preferred_size({ m_pixel_width, m_pixel_height });
  877. m_needs_background_fill = true;
  878. force_repaint();
  879. winsize ws;
  880. ws.ws_row = rows;
  881. ws.ws_col = columns;
  882. int rc = ioctl(m_ptm_fd, TIOCSWINSZ, &ws);
  883. ASSERT(rc == 0);
  884. }
  885. Rect Terminal::glyph_rect(word row, word column)
  886. {
  887. int y = row * m_line_height;
  888. int x = column * font().glyph_width('x');
  889. return { x + frame_thickness() + m_inset, y + frame_thickness() + m_inset, font().glyph_width('x'), font().glyph_height() };
  890. }
  891. Rect Terminal::row_rect(word row)
  892. {
  893. int y = row * m_line_height;
  894. Rect rect = { frame_thickness() + m_inset, y + frame_thickness() + m_inset, font().glyph_width('x') * m_columns, font().glyph_height() };
  895. rect.inflate(0, m_line_spacing);
  896. return rect;
  897. }
  898. bool Terminal::Line::has_only_one_background_color() const
  899. {
  900. if (!m_length)
  901. return true;
  902. // FIXME: Cache this result?
  903. auto color = attributes[0].background_color;
  904. for (size_t i = 1; i < m_length; ++i) {
  905. if (attributes[i].background_color != color)
  906. return false;
  907. }
  908. return true;
  909. }
  910. void Terminal::event(CEvent& event)
  911. {
  912. if (event.type() == GEvent::WindowBecameActive || event.type() == GEvent::WindowBecameInactive) {
  913. m_in_active_window = event.type() == GEvent::WindowBecameActive;
  914. if (!m_in_active_window) {
  915. m_cursor_blink_timer.stop();
  916. } else {
  917. m_cursor_blink_state = true;
  918. m_cursor_blink_timer.start();
  919. }
  920. invalidate_cursor();
  921. update();
  922. }
  923. return GWidget::event(event);
  924. }
  925. void Terminal::keydown_event(GKeyEvent& event)
  926. {
  927. char ch = !event.text().is_empty() ? event.text()[0] : 0;
  928. if (event.ctrl()) {
  929. if (ch >= 'a' && ch <= 'z') {
  930. ch = ch - 'a' + 1;
  931. } else if (ch == '\\') {
  932. ch = 0x1c;
  933. }
  934. }
  935. switch (event.key()) {
  936. case KeyCode::Key_Up:
  937. write(m_ptm_fd, "\033[A", 3);
  938. break;
  939. case KeyCode::Key_Down:
  940. write(m_ptm_fd, "\033[B", 3);
  941. break;
  942. case KeyCode::Key_Right:
  943. write(m_ptm_fd, "\033[C", 3);
  944. break;
  945. case KeyCode::Key_Left:
  946. write(m_ptm_fd, "\033[D", 3);
  947. break;
  948. case KeyCode::Key_Home:
  949. write(m_ptm_fd, "\033[H", 3);
  950. break;
  951. case KeyCode::Key_End:
  952. write(m_ptm_fd, "\033[F", 3);
  953. break;
  954. case KeyCode::Key_RightShift:
  955. // Prevent RightShift from being sent to whatever's running in the
  956. // terminal. Prevents `~@` (null) character from being sent after every
  957. // character entered with right shift.
  958. break;
  959. default:
  960. write(m_ptm_fd, &ch, 1);
  961. break;
  962. }
  963. }
  964. void Terminal::paint_event(GPaintEvent& event)
  965. {
  966. GFrame::paint_event(event);
  967. GPainter painter(*this);
  968. if (m_visual_beep_timer.is_active())
  969. painter.fill_rect(frame_inner_rect(), Color::Red);
  970. else
  971. painter.fill_rect(frame_inner_rect(), Color(Color::Black).with_alpha(m_opacity));
  972. invalidate_cursor();
  973. for (word row = 0; row < m_rows; ++row) {
  974. auto& line = this->line(row);
  975. bool has_only_one_background_color = line.has_only_one_background_color();
  976. if (m_visual_beep_timer.is_active())
  977. painter.fill_rect(row_rect(row), Color::Red);
  978. else if (has_only_one_background_color)
  979. painter.fill_rect(row_rect(row), lookup_color(line.attributes[0].background_color).with_alpha(m_opacity));
  980. for (word column = 0; column < m_columns; ++column) {
  981. char ch = line.characters[column];
  982. bool should_reverse_fill_for_cursor_or_selection = (m_cursor_blink_state && m_in_active_window && row == m_cursor_row && column == m_cursor_column)
  983. || selection_contains({ row, column });
  984. auto& attribute = line.attributes[column];
  985. auto character_rect = glyph_rect(row, column);
  986. if (!has_only_one_background_color || should_reverse_fill_for_cursor_or_selection) {
  987. auto cell_rect = character_rect.inflated(0, m_line_spacing);
  988. painter.fill_rect(cell_rect, lookup_color(should_reverse_fill_for_cursor_or_selection ? attribute.foreground_color : attribute.background_color).with_alpha(m_opacity));
  989. }
  990. if (ch == ' ')
  991. continue;
  992. painter.draw_glyph(character_rect.location(), ch, lookup_color(should_reverse_fill_for_cursor_or_selection ? attribute.background_color : attribute.foreground_color));
  993. }
  994. }
  995. if (!m_in_active_window) {
  996. auto cell_rect = glyph_rect(m_cursor_row, m_cursor_column).inflated(0, m_line_spacing);
  997. painter.draw_rect(cell_rect, lookup_color(line(m_cursor_row).attributes[m_cursor_column].foreground_color));
  998. }
  999. }
  1000. void Terminal::set_window_title(const String& title)
  1001. {
  1002. auto* w = window();
  1003. if (!w)
  1004. return;
  1005. w->set_title(title);
  1006. }
  1007. void Terminal::invalidate_cursor()
  1008. {
  1009. line(m_cursor_row).dirty = true;
  1010. }
  1011. void Terminal::flush_dirty_lines()
  1012. {
  1013. if (m_need_full_flush) {
  1014. update();
  1015. m_need_full_flush = false;
  1016. return;
  1017. }
  1018. Rect rect;
  1019. for (int i = 0; i < m_rows; ++i) {
  1020. if (line(i).dirty)
  1021. rect = rect.united(row_rect(i));
  1022. }
  1023. update(rect);
  1024. }
  1025. void Terminal::force_repaint()
  1026. {
  1027. m_needs_background_fill = true;
  1028. for (int i = 0; i < m_rows; ++i)
  1029. line(i).dirty = true;
  1030. update();
  1031. }
  1032. void Terminal::resize_event(GResizeEvent& event)
  1033. {
  1034. int new_columns = (event.size().width() - frame_thickness() * 2 - m_inset * 2) / font().glyph_width('x');
  1035. int new_rows = (event.size().height() - frame_thickness() * 2 - m_inset * 2) / m_line_height;
  1036. set_size(new_columns, new_rows);
  1037. }
  1038. void Terminal::apply_size_increments_to_window(GWindow& window)
  1039. {
  1040. window.set_size_increment({ font().glyph_width('x'), m_line_height });
  1041. window.set_base_size({ frame_thickness() * 2 + m_inset * 2, frame_thickness() * 2 + m_inset * 2 });
  1042. }
  1043. void Terminal::update_cursor()
  1044. {
  1045. invalidate_cursor();
  1046. flush_dirty_lines();
  1047. }
  1048. void Terminal::set_opacity(byte new_opacity)
  1049. {
  1050. if (m_opacity == new_opacity)
  1051. return;
  1052. window()->set_has_alpha_channel(new_opacity < 255);
  1053. m_opacity = new_opacity;
  1054. force_repaint();
  1055. }
  1056. BufferPosition Terminal::normalized_selection_start() const
  1057. {
  1058. if (m_selection_start < m_selection_end)
  1059. return m_selection_start;
  1060. return m_selection_end;
  1061. }
  1062. BufferPosition Terminal::normalized_selection_end() const
  1063. {
  1064. if (m_selection_start < m_selection_end)
  1065. return m_selection_end;
  1066. return m_selection_start;
  1067. }
  1068. bool Terminal::has_selection() const
  1069. {
  1070. return m_selection_start.is_valid() && m_selection_end.is_valid();
  1071. }
  1072. bool Terminal::selection_contains(const BufferPosition& position) const
  1073. {
  1074. if (!has_selection())
  1075. return false;
  1076. return position >= normalized_selection_start() && position <= normalized_selection_end();
  1077. }
  1078. BufferPosition Terminal::buffer_position_at(const Point& position) const
  1079. {
  1080. auto adjusted_position = position.translated(-(frame_thickness() + m_inset), -(frame_thickness() + m_inset));
  1081. int row = adjusted_position.y() / m_line_height;
  1082. int column = adjusted_position.x() / font().glyph_width('x');
  1083. if (row < 0)
  1084. row = 0;
  1085. if (column < m_columns)
  1086. column = 0;
  1087. if (row >= m_rows)
  1088. row = m_rows - 1;
  1089. if (column >= m_columns)
  1090. column = m_columns - 1;
  1091. return { row, column };
  1092. }
  1093. void Terminal::mousedown_event(GMouseEvent& event)
  1094. {
  1095. if (event.button() == GMouseButton::Left) {
  1096. m_selection_start = buffer_position_at(event.position());
  1097. m_selection_end = {};
  1098. update();
  1099. } else if (event.button() == GMouseButton::Right) {
  1100. auto text = GClipboard::the().data();
  1101. if (text.is_empty())
  1102. return;
  1103. int nwritten = write(m_ptm_fd, text.characters(), text.length());
  1104. if (nwritten < 0) {
  1105. perror("write");
  1106. ASSERT_NOT_REACHED();
  1107. }
  1108. }
  1109. }
  1110. void Terminal::mousemove_event(GMouseEvent& event)
  1111. {
  1112. if (!(event.buttons() & GMouseButton::Left))
  1113. return;
  1114. auto old_selection_end = m_selection_end;
  1115. m_selection_end = buffer_position_at(event.position());
  1116. if (old_selection_end != m_selection_end)
  1117. update();
  1118. }
  1119. void Terminal::mouseup_event(GMouseEvent& event)
  1120. {
  1121. if (event.button() != GMouseButton::Left)
  1122. return;
  1123. if (!has_selection())
  1124. return;
  1125. GClipboard::the().set_data(selected_text());
  1126. }
  1127. String Terminal::selected_text() const
  1128. {
  1129. StringBuilder builder;
  1130. auto start = normalized_selection_start();
  1131. auto end = normalized_selection_end();
  1132. for (int row = start.row(); row <= end.row(); ++row) {
  1133. int first_column = row == start.row() ? start.column() : 0;
  1134. int last_column = row == end.row() ? end.column() : m_columns - 1;
  1135. for (int column = first_column; column <= last_column; ++column)
  1136. builder.append(line(row).characters[column]);
  1137. }
  1138. return builder.to_string();
  1139. }