Terminal.cpp 54 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775
  1. /*
  2. * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2021, Daniel Bertalan <dani@danielbertalan.dev>
  4. *
  5. * SPDX-License-Identifier: BSD-2-Clause
  6. */
  7. #include <AK/Debug.h>
  8. #include <AK/Queue.h>
  9. #include <AK/StringBuilder.h>
  10. #include <AK/StringView.h>
  11. #include <AK/TemporaryChange.h>
  12. #include <LibVT/Color.h>
  13. #include <LibVT/Terminal.h>
  14. #ifdef KERNEL
  15. # include <Kernel/Devices/TTY/VirtualConsole.h>
  16. #endif
  17. namespace VT {
  18. #ifndef KERNEL
  19. Terminal::Terminal(TerminalClient& client)
  20. #else
  21. Terminal::Terminal(Kernel::VirtualConsole& client)
  22. #endif
  23. : m_client(client)
  24. , m_parser(*this)
  25. {
  26. }
  27. #ifndef KERNEL
  28. void Terminal::clear()
  29. {
  30. dbgln_if(TERMINAL_DEBUG, "Clear the entire screen");
  31. for (size_t i = 0; i < rows(); ++i)
  32. active_buffer()[i]->clear();
  33. set_cursor(0, 0);
  34. m_client.terminal_did_perform_possibly_partial_clear();
  35. }
  36. void Terminal::clear_history()
  37. {
  38. dbgln_if(TERMINAL_DEBUG, "Clear history");
  39. auto previous_history_size = m_history.size();
  40. m_history.clear();
  41. m_history_start = 0;
  42. m_client.terminal_history_changed(-previous_history_size);
  43. }
  44. void Terminal::clear_to_mark(Mark mark)
  45. {
  46. auto cursor_row = this->cursor_row();
  47. ScopeGuard send_sigwinch = [&] {
  48. set_cursor(cursor_row, 1);
  49. mark_cursor();
  50. m_client.terminal_did_perform_possibly_partial_clear();
  51. };
  52. m_valid_marks.remove(mark);
  53. {
  54. auto it = active_buffer().rbegin();
  55. size_t row = m_rows - 1;
  56. // Skip to the cursor line.
  57. for (size_t i = this->cursor_row() + 1; i < active_buffer().size(); ++i, row--)
  58. ++it;
  59. for (; it != active_buffer().rend(); ++it, row--) {
  60. auto& line = *it;
  61. auto line_mark = line->mark();
  62. auto is_target_line = line_mark == mark;
  63. if (line_mark.has_value())
  64. m_valid_marks.remove(*line_mark);
  65. line->clear();
  66. if (is_target_line) {
  67. cursor_row = row;
  68. return;
  69. }
  70. }
  71. }
  72. // If the mark is not found, go through the history.
  73. auto it = AK::find_if(
  74. m_history.rbegin(),
  75. m_history.rend(),
  76. [mark](auto& line) {
  77. return line->mark() == mark;
  78. });
  79. auto index = it == m_history.rend() ? 0 : m_history.size() - it.index();
  80. m_client.terminal_history_changed(m_history.size() - index);
  81. auto count = m_history.size() - index;
  82. for (size_t i = 0; i < count; ++i) {
  83. if (auto mark = m_history[index + i]->mark(); mark.has_value())
  84. m_valid_marks.remove(*mark);
  85. }
  86. m_history.remove(index, count);
  87. cursor_row = 0;
  88. }
  89. void Terminal::mark_cursor()
  90. {
  91. static u32 next_mark_id { 0 };
  92. auto& line = active_buffer()[cursor_row()];
  93. if (line->mark().has_value()) {
  94. return;
  95. }
  96. auto mark = Mark(next_mark_id++);
  97. line->set_marked(mark);
  98. m_valid_marks.set(mark);
  99. }
  100. #endif
  101. void Terminal::alter_ansi_mode(bool should_set, Parameters params)
  102. {
  103. for (auto mode : params) {
  104. switch (mode) {
  105. // FIXME: implement *something* for this
  106. default:
  107. dbgln("Terminal::alter_ansi_mode: Unimplemented mode {} (should_set={})", mode, should_set);
  108. break;
  109. }
  110. }
  111. }
  112. void Terminal::alter_private_mode(bool should_set, Parameters params)
  113. {
  114. for (auto mode : params) {
  115. switch (mode) {
  116. case 1:
  117. // Cursor Keys Mode (DECCKM)
  118. dbgln_if(TERMINAL_DEBUG, "Setting cursor keys mode (should_set={})", should_set);
  119. m_cursor_keys_mode = should_set ? CursorKeysMode::Application : CursorKeysMode::Cursor;
  120. break;
  121. case 3: {
  122. // 80/132-column mode (DECCOLM)
  123. unsigned new_columns = should_set ? 132 : 80;
  124. dbgln_if(TERMINAL_DEBUG, "Setting {}-column mode", new_columns);
  125. set_size(new_columns, rows());
  126. clear();
  127. break;
  128. }
  129. case 12:
  130. if (should_set) {
  131. // Start blinking cursor
  132. m_client.set_cursor_blinking(true);
  133. } else {
  134. // Stop blinking cursor
  135. m_client.set_cursor_blinking(false);
  136. }
  137. break;
  138. case 25:
  139. if (should_set) {
  140. // Show cursor
  141. m_cursor_shape = m_saved_cursor_shape;
  142. m_client.set_cursor_shape(m_cursor_shape);
  143. } else {
  144. // Hide cursor
  145. m_saved_cursor_shape = m_cursor_shape;
  146. m_cursor_shape = VT::CursorShape::None;
  147. m_client.set_cursor_shape(VT::CursorShape::None);
  148. }
  149. break;
  150. case 1047:
  151. #ifndef KERNEL
  152. if (should_set) {
  153. dbgln_if(TERMINAL_DEBUG, "Switching to Alternate Screen Buffer");
  154. m_use_alternate_screen_buffer = true;
  155. clear();
  156. m_client.terminal_history_changed(-m_history.size());
  157. } else {
  158. dbgln_if(TERMINAL_DEBUG, "Switching to Normal Screen Buffer");
  159. m_use_alternate_screen_buffer = false;
  160. m_client.terminal_history_changed(m_history.size());
  161. }
  162. m_need_full_flush = true;
  163. #else
  164. dbgln("Alternate Screen Buffer is not supported");
  165. #endif
  166. break;
  167. case 1048:
  168. if (should_set)
  169. SCOSC();
  170. else
  171. SCORC();
  172. break;
  173. case 1049:
  174. #ifndef KERNEL
  175. if (should_set) {
  176. dbgln_if(TERMINAL_DEBUG, "Switching to Alternate Screen Buffer and saving state");
  177. m_normal_saved_state = m_current_state;
  178. m_use_alternate_screen_buffer = true;
  179. clear();
  180. m_client.terminal_history_changed(-m_history.size());
  181. } else {
  182. dbgln_if(TERMINAL_DEBUG, "Switching to Normal Screen Buffer and restoring state");
  183. m_current_state = m_normal_saved_state;
  184. m_use_alternate_screen_buffer = false;
  185. set_cursor(cursor_row(), cursor_column());
  186. m_client.terminal_history_changed(m_history.size());
  187. }
  188. m_need_full_flush = true;
  189. #else
  190. dbgln("Alternate Screen Buffer is not supported");
  191. #endif
  192. break;
  193. case 2004:
  194. dbgln_if(TERMINAL_DEBUG, "Setting bracketed mode enabled={}", should_set);
  195. m_needs_bracketed_paste = should_set;
  196. break;
  197. default:
  198. dbgln("Terminal::alter_private_mode: Unimplemented private mode {} (should_set={})", mode, should_set);
  199. break;
  200. }
  201. }
  202. }
  203. void Terminal::RM(Parameters params)
  204. {
  205. alter_ansi_mode(false, params);
  206. }
  207. void Terminal::DECRST(Parameters params)
  208. {
  209. alter_private_mode(false, params);
  210. }
  211. void Terminal::SM(Parameters params)
  212. {
  213. alter_ansi_mode(true, params);
  214. }
  215. void Terminal::DECSET(Parameters params)
  216. {
  217. alter_private_mode(true, params);
  218. }
  219. void Terminal::SGR(Parameters params)
  220. {
  221. if (params.is_empty()) {
  222. m_current_state.attribute.reset();
  223. return;
  224. }
  225. auto parse_color = [&]() -> Optional<Color> {
  226. if (params.size() < 2) {
  227. dbgln("Color code has no type");
  228. return {};
  229. }
  230. u32 rgb = 0;
  231. switch (params[1]) {
  232. case 5: // 8-bit
  233. if (params.size() < 3) {
  234. dbgln("8-bit color code has too few parameters");
  235. return {};
  236. }
  237. if (params[2] > 255) {
  238. dbgln("8-bit color code has out-of-bounds value");
  239. return {};
  240. }
  241. return Color::indexed(params[2]);
  242. case 2: // 24-bit
  243. if (params.size() < 5) {
  244. dbgln("24-bit color code has too few parameters");
  245. return {};
  246. }
  247. for (size_t i = 0; i < 3; ++i) {
  248. rgb <<= 8;
  249. rgb |= params[i + 2];
  250. }
  251. return Color::rgb(rgb);
  252. default:
  253. dbgln("Unknown color type {}", params[1]);
  254. return {};
  255. }
  256. };
  257. if (params[0] == 38) {
  258. m_current_state.attribute.foreground_color = parse_color().value_or(m_current_state.attribute.foreground_color);
  259. } else if (params[0] == 48) {
  260. m_current_state.attribute.background_color = parse_color().value_or(m_current_state.attribute.background_color);
  261. } else {
  262. // A single escape sequence may set multiple parameters.
  263. for (auto param : params) {
  264. switch (param) {
  265. case 0:
  266. // Reset
  267. m_current_state.attribute.reset();
  268. break;
  269. case 1:
  270. m_current_state.attribute.flags |= Attribute::Flags::Bold;
  271. break;
  272. case 3:
  273. m_current_state.attribute.flags |= Attribute::Flags::Italic;
  274. break;
  275. case 4:
  276. m_current_state.attribute.flags |= Attribute::Flags::Underline;
  277. break;
  278. case 5:
  279. m_current_state.attribute.flags |= Attribute::Flags::Blink;
  280. break;
  281. case 7:
  282. m_current_state.attribute.flags |= Attribute::Flags::Negative;
  283. break;
  284. case 22:
  285. m_current_state.attribute.flags &= ~Attribute::Flags::Bold;
  286. break;
  287. case 23:
  288. m_current_state.attribute.flags &= ~Attribute::Flags::Italic;
  289. break;
  290. case 24:
  291. m_current_state.attribute.flags &= ~Attribute::Flags::Underline;
  292. break;
  293. case 25:
  294. m_current_state.attribute.flags &= ~Attribute::Flags::Blink;
  295. break;
  296. case 27:
  297. m_current_state.attribute.flags &= ~Attribute::Flags::Negative;
  298. break;
  299. case 30:
  300. case 31:
  301. case 32:
  302. case 33:
  303. case 34:
  304. case 35:
  305. case 36:
  306. case 37:
  307. // Foreground color
  308. m_current_state.attribute.foreground_color = Color::named(static_cast<Color::ANSIColor>(param - 30));
  309. break;
  310. case 39:
  311. // reset foreground
  312. m_current_state.attribute.foreground_color = Attribute::default_foreground_color;
  313. break;
  314. case 40:
  315. case 41:
  316. case 42:
  317. case 43:
  318. case 44:
  319. case 45:
  320. case 46:
  321. case 47:
  322. // Background color
  323. m_current_state.attribute.background_color = Color::named(static_cast<Color::ANSIColor>(param - 40));
  324. break;
  325. case 49:
  326. // reset background
  327. m_current_state.attribute.background_color = Attribute::default_background_color;
  328. break;
  329. case 90:
  330. case 91:
  331. case 92:
  332. case 93:
  333. case 94:
  334. case 95:
  335. case 96:
  336. case 97:
  337. // Bright foreground color
  338. m_current_state.attribute.foreground_color = Color::named(static_cast<Color::ANSIColor>(8 + param - 90));
  339. break;
  340. case 100:
  341. case 101:
  342. case 102:
  343. case 103:
  344. case 104:
  345. case 105:
  346. case 106:
  347. case 107:
  348. // Bright background color
  349. m_current_state.attribute.background_color = Color::named(static_cast<Color::ANSIColor>(8 + param - 100));
  350. break;
  351. default:
  352. dbgln("FIXME: SGR: p: {}", param);
  353. }
  354. }
  355. }
  356. }
  357. void Terminal::SCOSC()
  358. {
  359. dbgln_if(TERMINAL_DEBUG, "Save cursor position");
  360. m_saved_cursor_position = m_current_state.cursor;
  361. }
  362. void Terminal::SCORC()
  363. {
  364. dbgln_if(TERMINAL_DEBUG, "Restore cursor position");
  365. m_current_state.cursor = m_saved_cursor_position;
  366. set_cursor(cursor_row(), cursor_column());
  367. }
  368. void Terminal::DECSC()
  369. {
  370. dbgln_if(TERMINAL_DEBUG, "Save cursor (and other state)");
  371. if (m_use_alternate_screen_buffer) {
  372. m_alternate_saved_state = m_current_state;
  373. } else {
  374. m_normal_saved_state = m_current_state;
  375. }
  376. }
  377. void Terminal::DECRC()
  378. {
  379. dbgln_if(TERMINAL_DEBUG, "Restore cursor (and other state)");
  380. if (m_use_alternate_screen_buffer) {
  381. m_current_state = m_alternate_saved_state;
  382. } else {
  383. m_current_state = m_normal_saved_state;
  384. }
  385. set_cursor(cursor_row(), cursor_column());
  386. }
  387. void Terminal::XTERM_WM(Parameters params)
  388. {
  389. if (params.size() < 1)
  390. return;
  391. switch (params[0]) {
  392. case 22: {
  393. #ifndef KERNEL
  394. if (params.size() > 1 && params[1] == 1) {
  395. dbgln("FIXME: we don't support icon titles");
  396. return;
  397. }
  398. dbgln_if(TERMINAL_DEBUG, "Title stack push: {}", m_current_window_title);
  399. (void)m_title_stack.try_append(move(m_current_window_title));
  400. #endif
  401. break;
  402. }
  403. case 23: {
  404. #ifndef KERNEL
  405. if (params.size() > 1 && params[1] == 1)
  406. return;
  407. if (m_title_stack.is_empty()) {
  408. dbgln("Shenanigans: Tried to pop from empty title stack");
  409. return;
  410. }
  411. m_current_window_title = m_title_stack.take_last();
  412. dbgln_if(TERMINAL_DEBUG, "Title stack pop: {}", m_current_window_title);
  413. m_client.set_window_title(m_current_window_title);
  414. #endif
  415. break;
  416. }
  417. default:
  418. dbgln("FIXME: XTERM_WM: Ps: {} (param count: {})", params[0], params.size());
  419. }
  420. }
  421. void Terminal::DECSTBM(Parameters params)
  422. {
  423. unsigned top = 1;
  424. unsigned bottom = m_rows;
  425. if (params.size() >= 1 && params[0] != 0)
  426. top = params[0];
  427. if (params.size() >= 2 && params[1] != 0)
  428. bottom = params[1];
  429. if ((bottom - top) < 2 || bottom > m_rows) {
  430. dbgln("Error: DECSTBM: scrolling region invalid: {}-{}", top, bottom);
  431. return;
  432. }
  433. if (top >= bottom) {
  434. return;
  435. }
  436. m_scroll_region_top = top - 1;
  437. m_scroll_region_bottom = bottom - 1;
  438. set_cursor(0, 0);
  439. dbgln_if(TERMINAL_DEBUG, "Set scrolling region: {}-{}", m_scroll_region_top, m_scroll_region_bottom);
  440. }
  441. void Terminal::CUP(Parameters params)
  442. {
  443. // CUP – Cursor Position
  444. unsigned row = 1;
  445. unsigned col = 1;
  446. if (params.size() >= 1 && params[0] != 0)
  447. row = params[0];
  448. if (params.size() >= 2 && params[1] != 0)
  449. col = params[1];
  450. set_cursor(row - 1, col - 1);
  451. }
  452. void Terminal::HVP(Parameters params)
  453. {
  454. unsigned row = 1;
  455. unsigned col = 1;
  456. if (params.size() >= 1 && params[0] != 0)
  457. row = params[0];
  458. if (params.size() >= 2 && params[1] != 0)
  459. col = params[1];
  460. set_cursor(row - 1, col - 1);
  461. }
  462. void Terminal::CUU(Parameters params)
  463. {
  464. unsigned num = 1;
  465. if (params.size() >= 1 && params[0] != 0)
  466. num = params[0];
  467. int new_row = cursor_row() - num;
  468. if (new_row < 0)
  469. new_row = 0;
  470. set_cursor(new_row, cursor_column());
  471. }
  472. void Terminal::CUD(Parameters params)
  473. {
  474. unsigned num = 1;
  475. if (params.size() >= 1 && params[0] != 0)
  476. num = params[0];
  477. unsigned new_row = cursor_row() + num;
  478. if (new_row >= m_rows)
  479. new_row = m_rows - 1;
  480. set_cursor(new_row, cursor_column());
  481. }
  482. void Terminal::CUF(Parameters params)
  483. {
  484. unsigned num = 1;
  485. if (params.size() >= 1 && params[0] != 0)
  486. num = params[0];
  487. unsigned new_column = cursor_column() + num;
  488. if (new_column >= m_columns)
  489. new_column = m_columns - 1;
  490. set_cursor(cursor_row(), new_column);
  491. }
  492. void Terminal::CUB(Parameters params)
  493. {
  494. unsigned num = 1;
  495. if (params.size() >= 1 && params[0] != 0)
  496. num = params[0];
  497. int new_column = (int)cursor_column() - num;
  498. if (new_column < 0)
  499. new_column = 0;
  500. set_cursor(cursor_row(), new_column);
  501. }
  502. void Terminal::CNL(Parameters params)
  503. {
  504. unsigned num = 1;
  505. if (params.size() >= 1 && params[0] != 0)
  506. num = params[0];
  507. unsigned new_row = cursor_row() + num;
  508. if (new_row >= m_columns)
  509. new_row = m_columns - 1;
  510. set_cursor(new_row, 0);
  511. }
  512. void Terminal::CPL(Parameters params)
  513. {
  514. unsigned num = 1;
  515. if (params.size() >= 1 && params[0] != 0)
  516. num = params[0];
  517. int new_row = (int)cursor_row() - num;
  518. if (new_row < 0)
  519. new_row = 0;
  520. set_cursor(new_row, 0);
  521. }
  522. void Terminal::CHA(Parameters params)
  523. {
  524. unsigned new_column = 1;
  525. if (params.size() >= 1 && params[0] != 0)
  526. new_column = params[0];
  527. if (new_column > m_columns)
  528. new_column = m_columns;
  529. set_cursor(cursor_row(), new_column - 1);
  530. }
  531. void Terminal::REP(Parameters params)
  532. {
  533. unsigned count = 1;
  534. if (params.size() >= 1 && params[0] != 0)
  535. count = params[0];
  536. for (unsigned i = 0; i < count; ++i)
  537. put_character_at(m_current_state.cursor.row, m_current_state.cursor.column++, m_last_code_point);
  538. }
  539. void Terminal::VPA(Parameters params)
  540. {
  541. unsigned new_row = 1;
  542. if (params.size() >= 1 && params[0] != 0)
  543. new_row = params[0];
  544. if (new_row > m_rows)
  545. new_row = m_rows;
  546. set_cursor(new_row - 1, cursor_column());
  547. }
  548. void Terminal::VPR(Parameters params)
  549. {
  550. unsigned num = 1;
  551. if (params.size() >= 1 && params[0] != 0)
  552. num = params[0];
  553. int new_row = cursor_row() + num;
  554. if (new_row >= m_rows)
  555. new_row = m_rows - 1;
  556. set_cursor(new_row, cursor_column());
  557. }
  558. void Terminal::HPA(Parameters params)
  559. {
  560. unsigned new_column = 1;
  561. if (params.size() >= 1 && params[0] != 0)
  562. new_column = params[0];
  563. if (new_column > m_columns)
  564. new_column = m_columns;
  565. set_cursor(cursor_row(), new_column - 1);
  566. }
  567. void Terminal::HPR(Parameters params)
  568. {
  569. unsigned num = 1;
  570. if (params.size() >= 1 && params[0] != 0)
  571. num = params[0];
  572. unsigned new_column = cursor_column() + num;
  573. if (new_column >= m_columns)
  574. new_column = m_columns - 1;
  575. set_cursor(cursor_row(), new_column);
  576. }
  577. void Terminal::ECH(Parameters params)
  578. {
  579. // Erase characters (without moving cursor)
  580. unsigned num = 1;
  581. if (params.size() >= 1 && params[0] != 0)
  582. num = params[0];
  583. // Clear num characters from the right of the cursor.
  584. auto clear_end = min<unsigned>(m_columns, cursor_column() + num - 1);
  585. dbgln_if(TERMINAL_DEBUG, "Erase characters {}-{} on line {}", cursor_column(), clear_end, cursor_row());
  586. clear_in_line(cursor_row(), cursor_column(), clear_end);
  587. }
  588. void Terminal::EL(Parameters params)
  589. {
  590. unsigned mode = 0;
  591. if (params.size() >= 1)
  592. mode = params[0];
  593. switch (mode) {
  594. case 0:
  595. dbgln_if(TERMINAL_DEBUG, "Clear line {} from cursor column ({}) to the end", cursor_row(), cursor_column());
  596. clear_in_line(cursor_row(), cursor_column(), m_columns - 1);
  597. break;
  598. case 1:
  599. dbgln_if(TERMINAL_DEBUG, "Clear line {} from the start to cursor column ({})", cursor_row(), cursor_column());
  600. clear_in_line(cursor_row(), 0, cursor_column());
  601. break;
  602. case 2:
  603. dbgln_if(TERMINAL_DEBUG, "Clear line {} completely", cursor_row());
  604. clear_in_line(cursor_row(), 0, m_columns - 1);
  605. break;
  606. default:
  607. unimplemented_csi_sequence(params, {}, 'K');
  608. break;
  609. }
  610. }
  611. void Terminal::ED(Parameters params)
  612. {
  613. unsigned mode = 0;
  614. if (params.size() >= 1)
  615. mode = params[0];
  616. switch (mode) {
  617. case 0:
  618. dbgln_if(TERMINAL_DEBUG, "Clear from cursor ({},{}) to end of screen", cursor_row(), cursor_column());
  619. clear_in_line(cursor_row(), cursor_column(), m_columns - 1);
  620. for (int row = cursor_row() + 1; row < m_rows; ++row)
  621. clear_in_line(row, 0, m_columns - 1);
  622. break;
  623. case 1:
  624. dbgln_if(TERMINAL_DEBUG, "Clear from beginning of screen to cursor ({},{})", cursor_row(), cursor_column());
  625. clear_in_line(cursor_row(), 0, cursor_column());
  626. for (int row = cursor_row() - 1; row >= 0; --row)
  627. clear_in_line(row, 0, m_columns - 1);
  628. break;
  629. case 2:
  630. clear();
  631. break;
  632. case 3:
  633. clear_history();
  634. break;
  635. default:
  636. unimplemented_csi_sequence(params, {}, 'J');
  637. break;
  638. }
  639. }
  640. void Terminal::SU(Parameters params)
  641. {
  642. unsigned count = 1;
  643. if (params.size() >= 1 && params[0] != 0)
  644. count = params[0];
  645. scroll_up(count);
  646. }
  647. void Terminal::SD(Parameters params)
  648. {
  649. unsigned count = 1;
  650. if (params.size() >= 1 && params[0] != 0)
  651. count = params[0];
  652. scroll_down(count);
  653. }
  654. void Terminal::DECSCUSR(Parameters params)
  655. {
  656. unsigned style = 1;
  657. if (params.size() >= 1 && params[0] != 0)
  658. style = params[0];
  659. switch (style) {
  660. case 1:
  661. m_client.set_cursor_shape(VT::CursorShape::Block);
  662. m_client.set_cursor_blinking(true);
  663. break;
  664. case 2:
  665. m_client.set_cursor_shape(VT::CursorShape::Block);
  666. m_client.set_cursor_blinking(false);
  667. break;
  668. case 3:
  669. m_client.set_cursor_shape(VT::CursorShape::Underline);
  670. m_client.set_cursor_blinking(true);
  671. break;
  672. case 4:
  673. m_client.set_cursor_shape(VT::CursorShape::Underline);
  674. m_client.set_cursor_blinking(false);
  675. break;
  676. case 5:
  677. m_client.set_cursor_shape(VT::CursorShape::Bar);
  678. m_client.set_cursor_blinking(true);
  679. break;
  680. case 6:
  681. m_client.set_cursor_shape(VT::CursorShape::Bar);
  682. m_client.set_cursor_blinking(false);
  683. break;
  684. default:
  685. dbgln("Unknown cursor style {}", style);
  686. }
  687. }
  688. void Terminal::IL(Parameters params)
  689. {
  690. size_t count = 1;
  691. if (params.size() >= 1 && params[0] != 0)
  692. count = params[0];
  693. if (!is_within_scroll_region(cursor_row())) {
  694. dbgln("Shenanigans! Tried to insert line outside the scroll region");
  695. return;
  696. }
  697. scroll_down(cursor_row(), m_scroll_region_bottom, count);
  698. }
  699. void Terminal::DA(Parameters)
  700. {
  701. emit_string("\033[?1;0c"sv);
  702. }
  703. void Terminal::DL(Parameters params)
  704. {
  705. size_t count = 1;
  706. if (params.size() >= 1 && params[0] != 0)
  707. count = params[0];
  708. if (!is_within_scroll_region(cursor_row())) {
  709. dbgln("Shenanigans! Tried to delete line outside the scroll region");
  710. return;
  711. }
  712. scroll_up(cursor_row(), m_scroll_region_bottom, count);
  713. }
  714. void Terminal::DCH(Parameters params)
  715. {
  716. int num = 1;
  717. if (params.size() >= 1 && params[0] != 0)
  718. num = params[0];
  719. num = min<int>(num, columns() - cursor_column());
  720. scroll_left(cursor_row(), cursor_column(), num);
  721. }
  722. void Terminal::linefeed()
  723. {
  724. u16 new_row = cursor_row();
  725. #ifndef KERNEL
  726. if (!m_controls_are_logically_generated)
  727. active_buffer()[new_row]->set_terminated(m_column_before_carriage_return.value_or(cursor_column()));
  728. #endif
  729. if (cursor_row() == m_scroll_region_bottom) {
  730. scroll_up();
  731. } else {
  732. ++new_row;
  733. };
  734. // We shouldn't jump to the first column after receiving a line feed.
  735. // The TTY will take care of generating the carriage return.
  736. set_cursor(new_row, cursor_column());
  737. }
  738. void Terminal::carriage_return()
  739. {
  740. dbgln_if(TERMINAL_DEBUG, "Carriage return");
  741. m_column_before_carriage_return = cursor_column();
  742. set_cursor(cursor_row(), 0);
  743. }
  744. void Terminal::scroll_up(size_t count)
  745. {
  746. scroll_up(m_scroll_region_top, m_scroll_region_bottom, count);
  747. }
  748. void Terminal::scroll_down(size_t count)
  749. {
  750. scroll_down(m_scroll_region_top, m_scroll_region_bottom, count);
  751. }
  752. #ifndef KERNEL
  753. // Insert `count` blank lines at the bottom of the region. Text moves up, top lines get added to the scrollback.
  754. void Terminal::scroll_up(u16 region_top, u16 region_bottom, size_t count)
  755. {
  756. VERIFY(region_top <= region_bottom);
  757. VERIFY(region_bottom < rows());
  758. // Only the specified region should be affected.
  759. size_t region_size = region_bottom - region_top + 1;
  760. count = min(count, region_size);
  761. dbgln_if(TERMINAL_DEBUG, "Scroll up {} lines in region {}-{}", count, region_top, region_bottom);
  762. // NOTE: We have to invalidate the cursor first.
  763. invalidate_cursor();
  764. int history_delta = -count;
  765. bool should_move_to_scrollback = !m_use_alternate_screen_buffer && max_history_size() != 0;
  766. if (should_move_to_scrollback) {
  767. auto remaining_lines = max_history_size() - history_size();
  768. history_delta = (count > remaining_lines) ? remaining_lines - count : 0;
  769. for (size_t i = 0; i < count; ++i)
  770. add_line_to_history(move(active_buffer().at(region_top + i)));
  771. }
  772. // Move lines into their new place.
  773. for (u16 row = region_top; row + count <= region_bottom; ++row)
  774. swap(active_buffer().at(row), active_buffer().at(row + count));
  775. // Clear 'new' lines at the bottom.
  776. if (should_move_to_scrollback) {
  777. // Since we moved the previous lines into history, we can't just clear them.
  778. for (u16 row = region_bottom + 1 - count; row <= region_bottom; ++row)
  779. active_buffer().at(row) = make<Line>(columns());
  780. } else {
  781. // The new lines haven't been moved and we don't want to leak memory.
  782. for (u16 row = region_bottom + 1 - count; row <= region_bottom; ++row)
  783. active_buffer()[row]->clear();
  784. }
  785. // Set dirty flag on swapped lines.
  786. // The other lines have implicitly been set dirty by being cleared.
  787. for (u16 row = region_top; row + count <= region_bottom; ++row)
  788. active_buffer()[row]->set_dirty(true);
  789. m_client.terminal_history_changed(history_delta);
  790. }
  791. // Insert `count` blank lines at the top of the region. Text moves down. Does not affect the scrollback buffer.
  792. void Terminal::scroll_down(u16 region_top, u16 region_bottom, size_t count)
  793. {
  794. VERIFY(region_top <= region_bottom);
  795. VERIFY(region_bottom < rows());
  796. // Only the specified region should be affected.
  797. size_t region_size = region_bottom - region_top + 1;
  798. count = min(count, region_size);
  799. dbgln_if(TERMINAL_DEBUG, "Scroll down {} lines in region {}-{}", count, region_top, region_bottom);
  800. // NOTE: We have to invalidate the cursor first.
  801. invalidate_cursor();
  802. // Move lines into their new place.
  803. for (int row = region_bottom; row >= static_cast<int>(region_top + count); --row)
  804. swap(active_buffer().at(row), active_buffer().at(row - count));
  805. // Clear the 'new' lines at the top.
  806. for (u16 row = region_top; row < region_top + count; ++row)
  807. active_buffer()[row]->clear();
  808. // Set dirty flag on swapped lines.
  809. // The other lines have implicitly been set dirty by being cleared.
  810. for (u16 row = region_top + count; row <= region_bottom; ++row)
  811. active_buffer()[row]->set_dirty(true);
  812. }
  813. // Insert `count` blank cells at the end of the line. Text moves left.
  814. void Terminal::scroll_left(u16 row, u16 column, size_t count)
  815. {
  816. VERIFY(row < rows());
  817. VERIFY(column < columns());
  818. count = min<size_t>(count, columns() - column);
  819. dbgln_if(TERMINAL_DEBUG, "Scroll left {} columns from line {} column {}", count, row, column);
  820. auto& line = active_buffer()[row];
  821. for (size_t i = column; i < columns() - count; ++i)
  822. swap(line->cell_at(i), line->cell_at(i + count));
  823. clear_in_line(row, columns() - count, columns() - 1);
  824. line->set_dirty(true);
  825. }
  826. // Insert `count` blank cells after `row`. Text moves right.
  827. void Terminal::scroll_right(u16 row, u16 column, size_t count)
  828. {
  829. VERIFY(row < rows());
  830. VERIFY(column < columns());
  831. count = min<size_t>(count, columns() - column);
  832. dbgln_if(TERMINAL_DEBUG, "Scroll right {} columns from line {} column {}", count, row, column);
  833. auto& line = active_buffer()[row];
  834. for (int i = columns() - 1; i >= static_cast<int>(column + count); --i)
  835. swap(line->cell_at(i), line->cell_at(i - count));
  836. clear_in_line(row, column, column + count - 1);
  837. line->set_dirty(true);
  838. }
  839. void Terminal::put_character_at(unsigned row, unsigned column, u32 code_point)
  840. {
  841. VERIFY(row < rows());
  842. VERIFY(column < columns());
  843. auto& line = active_buffer()[row];
  844. line->set_code_point(column, code_point);
  845. line->attribute_at(column) = m_current_state.attribute;
  846. line->attribute_at(column).flags |= Attribute::Flags::Touched;
  847. line->set_dirty(true);
  848. m_last_code_point = code_point;
  849. }
  850. void Terminal::clear_in_line(u16 row, u16 first_column, u16 last_column)
  851. {
  852. VERIFY(row < rows());
  853. active_buffer()[row]->clear_range(first_column, last_column, m_current_state.attribute);
  854. }
  855. #endif
  856. void Terminal::set_cursor(unsigned a_row, unsigned a_column, bool skip_debug)
  857. {
  858. unsigned row = min(a_row, m_rows - 1u);
  859. unsigned column = min(a_column, m_columns - 1u);
  860. m_stomp = false;
  861. if (row == cursor_row() && column == cursor_column())
  862. return;
  863. VERIFY(row < rows());
  864. VERIFY(column < columns());
  865. invalidate_cursor();
  866. m_current_state.cursor.row = row;
  867. m_current_state.cursor.column = column;
  868. invalidate_cursor();
  869. if (!skip_debug)
  870. dbgln_if(TERMINAL_DEBUG, "Set cursor position: {},{}", cursor_row(), cursor_column());
  871. }
  872. void Terminal::NEL()
  873. {
  874. if (cursor_row() == m_scroll_region_bottom)
  875. scroll_up();
  876. else
  877. set_cursor(cursor_row() + 1, 0);
  878. }
  879. void Terminal::IND()
  880. {
  881. // Not equivalent to CUD: if we are at the bottom margin, we have to scroll up.
  882. if (cursor_row() == m_scroll_region_bottom)
  883. scroll_up();
  884. else
  885. set_cursor(cursor_row() + 1, cursor_column());
  886. }
  887. void Terminal::RI()
  888. {
  889. // Not equivalent to CUU : if we at the top margin , we have to scroll down.
  890. if (cursor_row() == m_scroll_region_top)
  891. scroll_down();
  892. else
  893. set_cursor(cursor_row() - 1, cursor_column());
  894. }
  895. void Terminal::DECFI()
  896. {
  897. if (cursor_column() == columns() - 1)
  898. scroll_left(cursor_row(), 0, 1);
  899. else
  900. set_cursor(cursor_row(), cursor_column() + 1);
  901. }
  902. void Terminal::DECBI()
  903. {
  904. if (cursor_column() == 0)
  905. scroll_right(cursor_row(), 0, 1);
  906. else
  907. set_cursor(cursor_row(), cursor_column() - 1);
  908. }
  909. void Terminal::DECIC(Parameters params)
  910. {
  911. unsigned num = 1;
  912. if (params.size() >= 1 && params[0] != 0)
  913. num = params[0];
  914. num = min<unsigned>(num, columns() - cursor_column());
  915. for (unsigned row = cursor_row(); row <= m_scroll_region_bottom; ++row)
  916. scroll_right(row, cursor_column(), num);
  917. }
  918. void Terminal::DECDC(Parameters params)
  919. {
  920. unsigned num = 1;
  921. if (params.size() >= 1 && params[0] != 0)
  922. num = params[0];
  923. num = min<unsigned>(num, columns() - cursor_column());
  924. for (unsigned row = cursor_row(); row <= m_scroll_region_bottom; ++row)
  925. scroll_left(row, cursor_column(), num);
  926. }
  927. void Terminal::DECKPNM()
  928. {
  929. m_in_application_keypad_mode = false;
  930. }
  931. void Terminal::DECKPAM()
  932. {
  933. m_in_application_keypad_mode = true;
  934. }
  935. void Terminal::DSR(Parameters params)
  936. {
  937. if (params.size() == 1 && params[0] == 5) {
  938. // Device status
  939. emit_string("\033[0n"sv); // Terminal status OK!
  940. } else if (params.size() == 1 && params[0] == 6) {
  941. // Cursor position query
  942. StringBuilder builder;
  943. MUST(builder.try_appendff("\e[{};{}R", cursor_row() + 1, cursor_column() + 1)); // StringBuilder's inline capacity of 256 is enough to guarantee no allocations
  944. emit_string(builder.string_view());
  945. } else {
  946. dbgln("Unknown DSR");
  947. }
  948. }
  949. void Terminal::ICH(Parameters params)
  950. {
  951. unsigned num = 1;
  952. if (params.size() >= 1 && params[0] != 0)
  953. num = params[0];
  954. num = min<unsigned>(num, columns() - cursor_column());
  955. scroll_right(cursor_row(), cursor_column(), num);
  956. }
  957. void Terminal::on_input(u8 byte)
  958. {
  959. m_parser.on_input(byte);
  960. }
  961. void Terminal::emit_code_point(u32 code_point)
  962. {
  963. auto working_set = m_working_sets[m_active_working_set_index];
  964. code_point = m_character_set_translator.translate_code_point(working_set, code_point);
  965. auto new_column = cursor_column() + 1;
  966. if (new_column < columns()) {
  967. put_character_at(cursor_row(), cursor_column(), code_point);
  968. set_cursor(cursor_row(), new_column, true);
  969. return;
  970. }
  971. if (m_stomp) {
  972. m_stomp = false;
  973. TemporaryChange change { m_controls_are_logically_generated, true };
  974. carriage_return();
  975. linefeed();
  976. put_character_at(cursor_row(), cursor_column(), code_point);
  977. set_cursor(cursor_row(), 1);
  978. } else {
  979. // Curious: We wait once on the right-hand side
  980. m_stomp = true;
  981. put_character_at(cursor_row(), cursor_column(), code_point);
  982. }
  983. }
  984. void Terminal::execute_control_code(u8 code)
  985. {
  986. ArmedScopeGuard clear_position_before_cr {
  987. [&] {
  988. m_column_before_carriage_return.clear();
  989. }
  990. };
  991. switch (code) {
  992. case '\a':
  993. m_client.beep();
  994. return;
  995. case '\b':
  996. if (cursor_column()) {
  997. set_cursor(cursor_row(), cursor_column() - 1);
  998. return;
  999. }
  1000. return;
  1001. case '\t': {
  1002. for (unsigned i = cursor_column() + 1; i < columns(); ++i) {
  1003. if (m_horizontal_tabs[i]) {
  1004. set_cursor(cursor_row(), i);
  1005. return;
  1006. }
  1007. }
  1008. return;
  1009. }
  1010. case '\n':
  1011. case '\v':
  1012. case '\f':
  1013. if (m_column_before_carriage_return == m_columns - 1)
  1014. m_column_before_carriage_return = m_columns;
  1015. linefeed();
  1016. return;
  1017. case '\r':
  1018. carriage_return();
  1019. clear_position_before_cr.disarm();
  1020. return;
  1021. default:
  1022. unimplemented_control_code(code);
  1023. }
  1024. }
  1025. void Terminal::execute_escape_sequence(Intermediates intermediates, bool ignore, u8 last_byte)
  1026. {
  1027. // FIXME: Handle it somehow?
  1028. if (ignore)
  1029. dbgln("Escape sequence has its ignore flag set.");
  1030. if (intermediates.size() == 0) {
  1031. switch (last_byte) {
  1032. case 'D':
  1033. IND();
  1034. return;
  1035. case 'E':
  1036. NEL();
  1037. return;
  1038. case 'M':
  1039. RI();
  1040. return;
  1041. case '\\':
  1042. // ST (string terminator) -- do nothing
  1043. return;
  1044. case '6':
  1045. DECBI();
  1046. return;
  1047. case '7':
  1048. DECSC();
  1049. return;
  1050. case '8':
  1051. DECRC();
  1052. return;
  1053. case '9':
  1054. DECFI();
  1055. return;
  1056. case '=':
  1057. DECKPAM();
  1058. return;
  1059. case '>':
  1060. DECKPNM();
  1061. return;
  1062. }
  1063. unimplemented_escape_sequence(intermediates, last_byte);
  1064. return;
  1065. }
  1066. char intermediate = intermediates[0];
  1067. switch (intermediate) {
  1068. case '#':
  1069. switch (last_byte) {
  1070. case '8':
  1071. // Confidence Test - Fill screen with E's
  1072. for (size_t row = 0; row < m_rows; ++row) {
  1073. for (size_t column = 0; column < m_columns; ++column) {
  1074. put_character_at(row, column, 'E');
  1075. }
  1076. }
  1077. return;
  1078. }
  1079. break;
  1080. case '(':
  1081. case ')':
  1082. case '*':
  1083. case '+':
  1084. // Determine G0..G3 index
  1085. size_t working_set_index = intermediate - '(';
  1086. CharacterSet new_set;
  1087. switch (last_byte) {
  1088. case 'B':
  1089. new_set = CharacterSet::Iso_8859_1;
  1090. break;
  1091. case '0':
  1092. new_set = CharacterSet::VT100;
  1093. break;
  1094. case 'U':
  1095. new_set = CharacterSet::Null;
  1096. break;
  1097. case 'K':
  1098. new_set = CharacterSet::UserDefined;
  1099. break;
  1100. default:
  1101. unimplemented_escape_sequence(intermediates, last_byte);
  1102. return;
  1103. }
  1104. dbgln_if(TERMINAL_DEBUG, "Setting G{} working set to character set {}", working_set_index, to_underlying(new_set));
  1105. VERIFY(working_set_index <= 3);
  1106. m_working_sets[working_set_index] = new_set;
  1107. return;
  1108. }
  1109. unimplemented_escape_sequence(intermediates, last_byte);
  1110. }
  1111. void Terminal::execute_csi_sequence(Parameters parameters, Intermediates intermediates, bool ignore, u8 last_byte)
  1112. {
  1113. // FIXME: Handle it somehow?
  1114. if (ignore)
  1115. dbgln("CSI sequence has its ignore flag set.");
  1116. if (intermediates.is_empty()) {
  1117. switch (last_byte) {
  1118. case '@':
  1119. return ICH(parameters);
  1120. case 'A':
  1121. return CUU(parameters);
  1122. case 'B':
  1123. return CUD(parameters);
  1124. case 'C':
  1125. return CUF(parameters);
  1126. case 'D':
  1127. return CUB(parameters);
  1128. case 'E':
  1129. return CNL(parameters);
  1130. case 'F':
  1131. return CPL(parameters);
  1132. case 'G':
  1133. return CHA(parameters);
  1134. case 'H':
  1135. return CUP(parameters);
  1136. case 'J':
  1137. return ED(parameters);
  1138. case 'K':
  1139. return EL(parameters);
  1140. case 'L':
  1141. return IL(parameters);
  1142. case 'M':
  1143. return DL(parameters);
  1144. case 'P':
  1145. return DCH(parameters);
  1146. case 'S':
  1147. return SU(parameters);
  1148. case 'T':
  1149. return SD(parameters);
  1150. case 'X':
  1151. return ECH(parameters);
  1152. case '`':
  1153. return HPA(parameters);
  1154. case 'a':
  1155. return HPR(parameters);
  1156. case 'b':
  1157. return REP(parameters);
  1158. case 'c':
  1159. return DA(parameters);
  1160. case 'd':
  1161. return VPA(parameters);
  1162. case 'e':
  1163. return VPR(parameters);
  1164. case 'f':
  1165. return HVP(parameters);
  1166. case 'h':
  1167. return SM(parameters);
  1168. case 'l':
  1169. return RM(parameters);
  1170. case 'm':
  1171. return SGR(parameters);
  1172. case 'n':
  1173. return DSR(parameters);
  1174. case 'r':
  1175. return DECSTBM(parameters);
  1176. case 's':
  1177. return SCOSC();
  1178. case 't':
  1179. return XTERM_WM(parameters);
  1180. case 'u':
  1181. return SCORC();
  1182. }
  1183. } else if (intermediates.size() == 1 && intermediates[0] == '?') {
  1184. switch (last_byte) {
  1185. case 'h':
  1186. return DECSET(parameters);
  1187. case 'l':
  1188. return DECRST(parameters);
  1189. }
  1190. } else if (intermediates.size() == 1 && intermediates[0] == '\'') {
  1191. switch (last_byte) {
  1192. case '}':
  1193. return DECIC(parameters);
  1194. case '~':
  1195. return DECDC(parameters);
  1196. }
  1197. } else if (intermediates.size() == 1 && intermediates[0] == ' ') {
  1198. switch (last_byte) {
  1199. case 'q':
  1200. return DECSCUSR(parameters);
  1201. }
  1202. }
  1203. unimplemented_csi_sequence(parameters, intermediates, last_byte);
  1204. }
  1205. void Terminal::execute_osc_sequence(OscParameters parameters, u8 last_byte)
  1206. {
  1207. auto stringview_ify = [&](size_t param_idx) {
  1208. return StringView(parameters[param_idx]);
  1209. };
  1210. if (parameters.size() == 0 || parameters[0].is_empty()) {
  1211. unimplemented_osc_sequence(parameters, last_byte);
  1212. return;
  1213. }
  1214. auto command_number = stringview_ify(0).to_number<unsigned>();
  1215. if (!command_number.has_value()) {
  1216. unimplemented_osc_sequence(parameters, last_byte);
  1217. return;
  1218. }
  1219. switch (command_number.value()) {
  1220. case 0:
  1221. case 1:
  1222. case 2:
  1223. if (parameters.size() < 2) {
  1224. dbgln("Attempted to set window title without any parameters");
  1225. } else {
  1226. // FIXME: the split breaks titles containing semicolons.
  1227. // Should we expose the raw OSC string from the parser? Or join by semicolon?
  1228. #ifndef KERNEL
  1229. m_current_window_title = stringview_ify(1).to_byte_string();
  1230. m_client.set_window_title(m_current_window_title);
  1231. #endif
  1232. }
  1233. break;
  1234. case 8:
  1235. #ifndef KERNEL
  1236. if (parameters.size() < 3) {
  1237. dbgln("Attempted to set href but gave too few parameters");
  1238. } else if (parameters[1].is_empty() && parameters[2].is_empty()) {
  1239. // Clear hyperlink
  1240. m_current_state.attribute.href = {};
  1241. m_current_state.attribute.href_id = {};
  1242. } else {
  1243. m_current_state.attribute.href = stringview_ify(2);
  1244. // FIXME: Respect the provided ID
  1245. m_current_state.attribute.href_id = ByteString::number(m_next_href_id++);
  1246. }
  1247. #endif
  1248. break;
  1249. case 9:
  1250. if (parameters.size() < 2)
  1251. dbgln("Atttempted to set window progress but gave too few parameters");
  1252. else if (parameters.size() == 2)
  1253. m_client.set_window_progress(stringview_ify(1).to_number<int>().value_or(-1), 0);
  1254. else
  1255. m_client.set_window_progress(stringview_ify(1).to_number<int>().value_or(-1), stringview_ify(2).to_number<int>().value_or(0));
  1256. break;
  1257. default:
  1258. unimplemented_osc_sequence(parameters, last_byte);
  1259. }
  1260. }
  1261. void Terminal::dcs_hook(Parameters, Intermediates, bool, u8)
  1262. {
  1263. dbgln("Received DCS parameters, but we don't support it yet");
  1264. }
  1265. void Terminal::receive_dcs_char(u8 byte)
  1266. {
  1267. dbgln_if(TERMINAL_DEBUG, "DCS string character {:c}", byte);
  1268. }
  1269. void Terminal::execute_dcs_sequence()
  1270. {
  1271. }
  1272. void Terminal::inject_string(StringView str)
  1273. {
  1274. for (size_t i = 0; i < str.length(); ++i)
  1275. on_input(str[i]);
  1276. }
  1277. void Terminal::emit_string(StringView string)
  1278. {
  1279. m_client.emit((u8 const*)string.characters_without_null_termination(), string.length());
  1280. }
  1281. void Terminal::handle_key_press(KeyCode key, u32 code_point, u8 flags)
  1282. {
  1283. bool ctrl = flags & Mod_Ctrl;
  1284. bool alt = flags & Mod_Alt;
  1285. bool shift = flags & Mod_Shift;
  1286. bool keypad = flags & Mod_Keypad;
  1287. unsigned modifier_mask = int(shift) + (int(alt) << 1) + (int(ctrl) << 2);
  1288. auto emit_final_with_modifier = [this, modifier_mask](char final) {
  1289. char escape_character = m_cursor_keys_mode == CursorKeysMode::Application ? 'O' : '[';
  1290. StringBuilder builder;
  1291. if (modifier_mask)
  1292. MUST(builder.try_appendff("\e{}1;{}{:c}", escape_character, modifier_mask + 1, final)); // StringBuilder's inline capacity of 256 is enough to guarantee no allocations
  1293. else
  1294. MUST(builder.try_appendff("\e{}{:c}", escape_character, final)); // StringBuilder's inline capacity of 256 is enough to guarantee no allocations
  1295. emit_string(builder.string_view());
  1296. };
  1297. auto emit_tilde_with_modifier = [this, modifier_mask](unsigned num) {
  1298. StringBuilder builder;
  1299. if (modifier_mask)
  1300. MUST(builder.try_appendff("\e[{};{}~", num, modifier_mask + 1)); // StringBuilder's inline capacity of 256 is enough to guarantee no allocations
  1301. else
  1302. MUST(builder.try_appendff("\e[{}~", num)); // StringBuilder's inline capacity of 256 is enough to guarantee no allocations
  1303. emit_string(builder.string_view());
  1304. };
  1305. auto emit_application_code = [this](KeyCode key) {
  1306. // The table providing mapping from numeric keys to application keys can be found at https://vt100.net/docs/vt100-ug/chapter3.html#T3-7
  1307. StringBuilder builder;
  1308. builder.append("\x1bO"sv);
  1309. switch (key) {
  1310. case KeyCode::Key_0:
  1311. builder.append('p');
  1312. break;
  1313. case KeyCode::Key_1:
  1314. builder.append('q');
  1315. break;
  1316. case KeyCode::Key_2:
  1317. builder.append('r');
  1318. break;
  1319. case KeyCode::Key_3:
  1320. builder.append('s');
  1321. break;
  1322. case KeyCode::Key_4:
  1323. builder.append('t');
  1324. break;
  1325. case KeyCode::Key_5:
  1326. builder.append('u');
  1327. break;
  1328. case KeyCode::Key_6:
  1329. builder.append('v');
  1330. break;
  1331. case KeyCode::Key_7:
  1332. builder.append('w');
  1333. break;
  1334. case KeyCode::Key_8:
  1335. builder.append('x');
  1336. break;
  1337. case KeyCode::Key_9:
  1338. builder.append('y');
  1339. break;
  1340. case KeyCode::Key_Minus:
  1341. builder.append('m');
  1342. break;
  1343. case KeyCode::Key_Comma:
  1344. builder.append('l');
  1345. break;
  1346. case KeyCode::Key_Period:
  1347. builder.append('n');
  1348. break;
  1349. case KeyCode::Key_Return:
  1350. builder.append('M');
  1351. break;
  1352. default:
  1353. break;
  1354. }
  1355. emit_string(builder.string_view());
  1356. };
  1357. if (keypad && m_in_application_keypad_mode) {
  1358. emit_application_code(key);
  1359. return;
  1360. }
  1361. switch (key) {
  1362. case KeyCode::Key_Up:
  1363. emit_final_with_modifier('A');
  1364. return;
  1365. case KeyCode::Key_Down:
  1366. emit_final_with_modifier('B');
  1367. return;
  1368. case KeyCode::Key_Right:
  1369. emit_final_with_modifier('C');
  1370. return;
  1371. case KeyCode::Key_Left:
  1372. emit_final_with_modifier('D');
  1373. return;
  1374. case KeyCode::Key_Insert:
  1375. emit_tilde_with_modifier(2);
  1376. return;
  1377. case KeyCode::Key_Delete:
  1378. emit_tilde_with_modifier(3);
  1379. return;
  1380. case KeyCode::Key_Home:
  1381. emit_final_with_modifier('H');
  1382. return;
  1383. case KeyCode::Key_End:
  1384. emit_final_with_modifier('F');
  1385. return;
  1386. case KeyCode::Key_PageUp:
  1387. emit_tilde_with_modifier(5);
  1388. return;
  1389. case KeyCode::Key_PageDown:
  1390. emit_tilde_with_modifier(6);
  1391. return;
  1392. case KeyCode::Key_Backspace:
  1393. if (ctrl) {
  1394. // This is an extension that allows Editor.cpp to delete whole words when
  1395. // Ctrl+Backspace is pressed. Ctrl cannot be transmitted without a CSI, and
  1396. // ANSI delete (127) is within the valid range for CSI codes in Editor.cpp.
  1397. // The code also has the same behavior as backspace when emitted with no CSI,
  1398. // though the backspace code (8) is preserved when Ctrl is not pressed.
  1399. emit_final_with_modifier(127);
  1400. return;
  1401. }
  1402. break;
  1403. case KeyCode::Key_Return:
  1404. // The standard says that CR should be generated by the return key.
  1405. // The TTY will take care of translating it to CR LF for the terminal.
  1406. emit_string("\r"sv);
  1407. return;
  1408. default:
  1409. break;
  1410. }
  1411. if (!code_point) {
  1412. // Probably a modifier being pressed.
  1413. return;
  1414. }
  1415. if (shift && key == KeyCode::Key_Tab) {
  1416. emit_string("\033[Z"sv);
  1417. return;
  1418. }
  1419. // Key event was not one of the above special cases,
  1420. // attempt to treat it as a character...
  1421. if (ctrl) {
  1422. if (code_point >= 'a' && code_point <= 'z') {
  1423. code_point = code_point - 'a' + 1;
  1424. } else if (code_point == '\\') {
  1425. code_point = 0x1c;
  1426. }
  1427. }
  1428. // Alt modifier sends escape prefix.
  1429. if (alt)
  1430. emit_string("\033"sv);
  1431. StringBuilder sb;
  1432. sb.append_code_point(code_point);
  1433. emit_string(sb.string_view());
  1434. }
  1435. void Terminal::unimplemented_control_code(u8 code)
  1436. {
  1437. dbgln_if(TERMINAL_DEBUG, "Unimplemented control code {:02x}", code);
  1438. }
  1439. void Terminal::unimplemented_escape_sequence(Intermediates intermediates, u8 last_byte)
  1440. {
  1441. StringBuilder builder;
  1442. builder.appendff("Unimplemented escape sequence {:c}", last_byte);
  1443. if (!intermediates.is_empty()) {
  1444. builder.append(", intermediates: "sv);
  1445. for (size_t i = 0; i < intermediates.size(); ++i)
  1446. builder.append((char)intermediates[i]);
  1447. }
  1448. dbgln("{}", builder.string_view());
  1449. }
  1450. void Terminal::unimplemented_csi_sequence(Parameters parameters, Intermediates intermediates, u8 last_byte)
  1451. {
  1452. StringBuilder builder;
  1453. builder.appendff("Unimplemented CSI sequence: {:c}", last_byte);
  1454. if (!parameters.is_empty()) {
  1455. builder.append(", parameters: ["sv);
  1456. for (size_t i = 0; i < parameters.size(); ++i)
  1457. builder.appendff("{}{}", (i == 0) ? "" : ", ", parameters[i]);
  1458. builder.append("]"sv);
  1459. }
  1460. if (!intermediates.is_empty()) {
  1461. builder.append(", intermediates:"sv);
  1462. for (size_t i = 0; i < intermediates.size(); ++i)
  1463. builder.append((char)intermediates[i]);
  1464. }
  1465. dbgln("{}", builder.string_view());
  1466. }
  1467. void Terminal::unimplemented_osc_sequence(OscParameters parameters, u8 last_byte)
  1468. {
  1469. StringBuilder builder;
  1470. builder.appendff("Unimplemented OSC sequence parameters: (bel_terminated={}) [ ", last_byte == '\a');
  1471. bool first = true;
  1472. for (auto parameter : parameters) {
  1473. if (!first)
  1474. builder.append(", "sv);
  1475. builder.append('[');
  1476. for (auto character : parameter)
  1477. builder.append((char)character);
  1478. builder.append(']');
  1479. first = false;
  1480. }
  1481. builder.append(" ]"sv);
  1482. dbgln("{}", builder.string_view());
  1483. }
  1484. #ifndef KERNEL
  1485. void Terminal::set_size(u16 columns, u16 rows)
  1486. {
  1487. if (!columns)
  1488. columns = 1;
  1489. if (!rows)
  1490. rows = 1;
  1491. if (columns == m_columns && rows == m_rows)
  1492. return;
  1493. // If we're making the terminal larger (column-wise), start at the end and go up, taking cells from the line below.
  1494. // otherwise start at the beginning and go down, pushing cells into the line below.
  1495. auto resize_and_rewrap = [&](auto& buffer, auto& old_cursor) {
  1496. auto cursor_on_line = [&](auto index) {
  1497. return index == old_cursor.row ? &old_cursor : nullptr;
  1498. };
  1499. // Two passes, one from top to bottom, another from bottom to top
  1500. for (size_t pass = 0; pass < 2; ++pass) {
  1501. auto forwards = (pass == 0) ^ (columns < m_columns);
  1502. if (forwards) {
  1503. for (size_t i = 1; i <= buffer.size(); ++i) {
  1504. auto is_at_seam = i == 1;
  1505. Line* next_line = is_at_seam ? nullptr : buffer[buffer.size() - i + 1].ptr();
  1506. Line* line = buffer[buffer.size() - i].ptr();
  1507. auto next_cursor = cursor_on_line(buffer.size() - i + 1);
  1508. line->rewrap(columns, next_line, next_cursor ?: cursor_on_line(buffer.size() - i), !!next_cursor);
  1509. }
  1510. } else {
  1511. for (size_t i = 0; i < buffer.size(); ++i) {
  1512. auto is_at_seam = i + 1 == buffer.size();
  1513. Line* next_line = is_at_seam ? nullptr : buffer[i + 1].ptr();
  1514. auto next_cursor = cursor_on_line(i + 1);
  1515. buffer[i]->rewrap(columns, next_line, next_cursor ?: cursor_on_line(i), !!next_cursor);
  1516. }
  1517. }
  1518. Queue<size_t> lines_to_reevaluate;
  1519. for (size_t i = 0; i < buffer.size(); ++i) {
  1520. if (buffer[i]->length() != columns)
  1521. lines_to_reevaluate.enqueue(i);
  1522. }
  1523. while (!lines_to_reevaluate.is_empty()) {
  1524. auto index = lines_to_reevaluate.dequeue();
  1525. auto is_at_seam = index + 1 == buffer.size();
  1526. Line* const next_line = is_at_seam ? nullptr : buffer[index + 1].ptr();
  1527. Line* const line = buffer[index].ptr();
  1528. auto next_cursor = cursor_on_line(index + 1);
  1529. line->rewrap(columns, next_line, next_cursor ?: cursor_on_line(index), !!next_cursor);
  1530. if (line->length() > columns) {
  1531. auto current_cursor = cursor_on_line(index);
  1532. // Split the line into two (or more)
  1533. ++index;
  1534. buffer.insert(index, make<Line>(0));
  1535. VERIFY(buffer[index]->length() == 0);
  1536. line->rewrap(columns, buffer[index].ptr(), current_cursor, false);
  1537. // If we inserted a line and the old cursor was after that line, increment its row
  1538. if (!current_cursor && old_cursor.row >= index)
  1539. ++old_cursor.row;
  1540. if (buffer[index]->length() != columns)
  1541. lines_to_reevaluate.enqueue(index);
  1542. }
  1543. if (next_line && next_line->length() != columns)
  1544. lines_to_reevaluate.enqueue(index + 1);
  1545. }
  1546. }
  1547. for (auto& line : buffer)
  1548. line->set_length(columns);
  1549. return old_cursor;
  1550. };
  1551. auto old_history_size = m_history.size();
  1552. m_history.extend(move(m_normal_screen_buffer));
  1553. CursorPosition cursor_tracker { cursor_row() + old_history_size, cursor_column() };
  1554. resize_and_rewrap(m_history, cursor_tracker);
  1555. if (auto extra_lines = m_history.size() - rows) {
  1556. while (extra_lines > 0) {
  1557. if (m_history.size() <= cursor_tracker.row)
  1558. break;
  1559. if (m_history.last()->is_empty()) {
  1560. if (m_history.size() >= 2 && m_history[m_history.size() - 2]->termination_column().has_value())
  1561. break;
  1562. --extra_lines;
  1563. (void)m_history.take_last();
  1564. continue;
  1565. }
  1566. break;
  1567. }
  1568. }
  1569. // FIXME: This can use a more performant way to move the last N entries
  1570. // from the history into the normal buffer
  1571. m_normal_screen_buffer.ensure_capacity(rows);
  1572. while (m_normal_screen_buffer.size() < rows) {
  1573. if (!m_history.is_empty())
  1574. m_normal_screen_buffer.prepend(m_history.take_last());
  1575. else
  1576. m_normal_screen_buffer.unchecked_append(make<Line>(columns));
  1577. }
  1578. cursor_tracker.row -= m_history.size();
  1579. if (m_history.size() != old_history_size) {
  1580. m_client.terminal_history_changed(-old_history_size);
  1581. m_client.terminal_history_changed(m_history.size());
  1582. }
  1583. CursorPosition dummy_cursor_tracker {};
  1584. resize_and_rewrap(m_alternate_screen_buffer, dummy_cursor_tracker);
  1585. if (m_alternate_screen_buffer.size() > rows)
  1586. m_alternate_screen_buffer.remove(0, m_alternate_screen_buffer.size() - rows);
  1587. if (rows > m_rows) {
  1588. while (m_normal_screen_buffer.size() < rows)
  1589. m_normal_screen_buffer.append(make<Line>(columns));
  1590. while (m_alternate_screen_buffer.size() < rows)
  1591. m_alternate_screen_buffer.append(make<Line>(columns));
  1592. } else {
  1593. m_normal_screen_buffer.shrink(rows);
  1594. m_alternate_screen_buffer.shrink(rows);
  1595. }
  1596. m_columns = columns;
  1597. m_rows = rows;
  1598. m_scroll_region_top = 0;
  1599. m_scroll_region_bottom = rows - 1;
  1600. m_current_state.cursor.clamp(m_rows - 1, m_columns - 1);
  1601. m_normal_saved_state.cursor.clamp(m_rows - 1, m_columns - 1);
  1602. m_alternate_saved_state.cursor.clamp(m_rows - 1, m_columns - 1);
  1603. m_saved_cursor_position.clamp(m_rows - 1, m_columns - 1);
  1604. m_horizontal_tabs.resize(columns);
  1605. for (unsigned i = 0; i < columns; ++i)
  1606. m_horizontal_tabs[i] = (i % 8) == 0;
  1607. // Rightmost column is always last tab on line.
  1608. m_horizontal_tabs[columns - 1] = 1;
  1609. set_cursor(cursor_tracker.row, cursor_tracker.column);
  1610. m_client.terminal_did_resize(m_columns, m_rows);
  1611. dbgln_if(TERMINAL_DEBUG, "Set terminal size: {}x{}", m_rows, m_columns);
  1612. }
  1613. #endif
  1614. #ifndef KERNEL
  1615. void Terminal::invalidate_cursor()
  1616. {
  1617. if (cursor_row() < active_buffer().size())
  1618. active_buffer()[cursor_row()]->set_dirty(true);
  1619. }
  1620. Attribute Terminal::attribute_at(Position const& position) const
  1621. {
  1622. if (!position.is_valid())
  1623. return {};
  1624. if (position.row() >= static_cast<int>(line_count()))
  1625. return {};
  1626. auto& line = this->line(position.row());
  1627. if (static_cast<size_t>(position.column()) >= line.length())
  1628. return {};
  1629. return line.attribute_at(position.column());
  1630. }
  1631. #endif
  1632. }