Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 1 | /* vi:set ts=8 sts=4 sw=4 noet: |
| 2 | * |
| 3 | * VIM - Vi IMproved by Bram Moolenaar |
| 4 | * |
| 5 | * Do ":help uganda" in Vim to read copying and usage conditions. |
| 6 | * Do ":help credits" in Vim to see a list of people who contributed. |
| 7 | * See README.txt for an overview of the Vim source code. |
| 8 | */ |
| 9 | |
| 10 | /* |
| 11 | * Terminal window support, see ":help :terminal". |
| 12 | * |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 13 | * There are three parts: |
| 14 | * 1. Generic code for all systems. |
| 15 | * 2. The MS-Windows implementation. |
| 16 | * Uses a hidden console for the terminal emulator. |
| 17 | * 3. The Unix-like implementation. |
| 18 | * Uses libvterm for the terminal emulator. |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 19 | * |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 20 | * When a terminal window is opened, a job is started that will be connected to |
| 21 | * the terminal emulator. |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 22 | * |
| 23 | * If the terminal window has keyboard focus, typed keys are converted to the |
| 24 | * terminal encoding and writting to the job over a channel. |
| 25 | * |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 26 | * If the job produces output, it is written to the terminal emulator. The |
| 27 | * terminal emulator invokes callbacks when its screen content changes. The |
| 28 | * line range is stored in tl_dirty_row_start and tl_dirty_row_end. Once in a |
| 29 | * while, if the terminal window is visible, the screen contents is drawn. |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 30 | * |
| 31 | * TODO: |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 32 | * - set buffer options to be scratch, hidden, nomodifiable, etc. |
| 33 | * - set buffer name to command, add (1) to avoid duplicates. |
Bram Moolenaar | 96ca27a | 2017-07-17 23:20:24 +0200 | [diff] [blame] | 34 | * - If [command] is not given the 'shell' option is used. |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 35 | * - Add a scrollback buffer (contains lines to scroll off the top). |
| 36 | * Can use the buf_T lines, store attributes somewhere else? |
| 37 | * - When the job ends: |
| 38 | * - Write "-- JOB ENDED --" in the terminal. |
| 39 | * - Put the terminal contents in the scrollback buffer. |
| 40 | * - Free the terminal emulator. |
| 41 | * - Display the scrollback buffer (but with attributes). |
| 42 | * Make the buffer not modifiable, drop attributes when making changes. |
Bram Moolenaar | 938783d | 2017-07-16 20:13:26 +0200 | [diff] [blame] | 43 | * - when closing window and job has not ended, make terminal hidden? |
| 44 | * - Use a pty for I/O with the job. |
| 45 | * - Windows implementation: |
| 46 | * (WiP): https://github.com/mattn/vim/tree/terminal |
| 47 | * src/os_win32.c mch_open_terminal() |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 48 | * Using winpty ? |
| 49 | * - use win_del_lines() to make scroll-up efficient. |
Bram Moolenaar | 938783d | 2017-07-16 20:13:26 +0200 | [diff] [blame] | 50 | * - command line completion for :terminal |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 51 | * - support fixed size when 'termsize' is "rowsXcols". |
| 52 | * - support minimal size when 'termsize' is "rows*cols". |
| 53 | * - support minimal size when 'termsize' is empty. |
| 54 | * - implement ":buf {term-buf-name}" |
Bram Moolenaar | 96ca27a | 2017-07-17 23:20:24 +0200 | [diff] [blame] | 55 | * - implement term_list() list of buffers with a terminal |
| 56 | * - implement term_getsize(buf) |
| 57 | * - implement term_setsize(buf) |
| 58 | * - implement term_sendkeys(buf, keys) send keystrokes to a terminal |
| 59 | * - implement term_wait(buf) wait for screen to be updated |
| 60 | * - implement term_scrape(buf, row) inspect terminal screen |
| 61 | * - implement term_open(command, options) open terminal window |
| 62 | * - implement term_getjob(buf) |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 63 | * - implement 'termkey' |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 64 | */ |
| 65 | |
| 66 | #include "vim.h" |
| 67 | |
| 68 | #ifdef FEAT_TERMINAL |
| 69 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 70 | #ifdef WIN3264 |
| 71 | /* MS-Windows: use a native console. */ |
| 72 | #else |
| 73 | /* Unix-like: use libvterm. */ |
| 74 | # include "libvterm/include/vterm.h" |
| 75 | #endif |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 76 | |
| 77 | /* typedef term_T in structs.h */ |
| 78 | struct terminal_S { |
| 79 | term_T *tl_next; |
| 80 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 81 | #ifdef WIN3264 |
| 82 | /* console handle? */ |
| 83 | #else |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 84 | VTerm *tl_vterm; |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 85 | #endif |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 86 | job_T *tl_job; |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 87 | buf_T *tl_buffer; |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 88 | |
| 89 | /* Range of screen rows to update. Zero based. */ |
| 90 | int tl_dirty_row_start; /* -1 if nothing dirty */ |
| 91 | int tl_dirty_row_end; /* row below last one to update */ |
| 92 | |
| 93 | pos_T tl_cursor; |
| 94 | }; |
| 95 | |
| 96 | #define MAX_ROW 999999 /* used for tl_dirty_row_end to update all rows */ |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 97 | #define KEY_BUF_LEN 200 |
| 98 | |
| 99 | /* Functions implemented for MS-Windows and Unix-like systems. */ |
| 100 | static int term_init(term_T *term, int rows, int cols); |
| 101 | static void term_free(term_T *term); |
| 102 | static void term_write_job_output(term_T *term, char_u *msg, size_t len); |
| 103 | static int term_convert_key(int c, char *buf); |
| 104 | static void term_update_lines(win_T *wp); |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 105 | |
| 106 | /* |
| 107 | * List of all active terminals. |
| 108 | */ |
| 109 | static term_T *first_term = NULL; |
| 110 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 111 | /************************************** |
| 112 | * 1. Generic code for all systems. |
| 113 | */ |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 114 | |
| 115 | /* |
| 116 | * ":terminal": open a terminal window and execute a job in it. |
| 117 | */ |
| 118 | void |
| 119 | ex_terminal(exarg_T *eap) |
| 120 | { |
| 121 | int rows; |
| 122 | int cols; |
| 123 | exarg_T split_ea; |
| 124 | win_T *old_curwin = curwin; |
| 125 | typval_T argvars[2]; |
| 126 | term_T *term; |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 127 | jobopt_T opt; |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 128 | |
| 129 | if (check_restricted() || check_secure()) |
| 130 | return; |
| 131 | |
| 132 | term = (term_T *)alloc_clear(sizeof(term_T)); |
| 133 | if (term == NULL) |
| 134 | return; |
| 135 | term->tl_dirty_row_end = MAX_ROW; |
| 136 | |
| 137 | /* Open a new window or tab. */ |
| 138 | vim_memset(&split_ea, 0, sizeof(split_ea)); |
| 139 | split_ea.cmdidx = CMD_new; |
| 140 | split_ea.cmd = (char_u *)"new"; |
| 141 | split_ea.arg = (char_u *)""; |
| 142 | ex_splitview(&split_ea); |
| 143 | if (curwin == old_curwin) |
| 144 | { |
| 145 | /* split failed */ |
| 146 | vim_free(term); |
| 147 | return; |
| 148 | } |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 149 | term->tl_buffer = curbuf; |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 150 | |
| 151 | curbuf->b_term = term; |
| 152 | term->tl_next = first_term; |
| 153 | first_term = term; |
| 154 | |
| 155 | /* TODO: set buffer type, hidden, etc. */ |
| 156 | |
| 157 | if (*curwin->w_p_tms != NUL) |
| 158 | { |
| 159 | char_u *p = vim_strchr(curwin->w_p_tms, 'x') + 1; |
| 160 | |
| 161 | rows = atoi((char *)curwin->w_p_tms); |
| 162 | cols = atoi((char *)p); |
| 163 | /* TODO: resize window if possible. */ |
| 164 | } |
| 165 | else |
| 166 | { |
| 167 | rows = curwin->w_height; |
| 168 | cols = curwin->w_width; |
| 169 | } |
| 170 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 171 | if (term_init(term, rows, cols) == OK) |
| 172 | { |
| 173 | argvars[0].v_type = VAR_STRING; |
| 174 | argvars[0].vval.v_string = eap->arg; |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 175 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 176 | clear_job_options(&opt); |
| 177 | opt.jo_mode = MODE_RAW; |
| 178 | opt.jo_out_mode = MODE_RAW; |
| 179 | opt.jo_err_mode = MODE_RAW; |
| 180 | opt.jo_set = JO_MODE | JO_OUT_MODE | JO_ERR_MODE; |
| 181 | opt.jo_io[PART_OUT] = JIO_BUFFER; |
| 182 | opt.jo_io[PART_ERR] = JIO_BUFFER; |
| 183 | opt.jo_set |= JO_OUT_IO + (JO_OUT_IO << (PART_ERR - PART_OUT)); |
| 184 | opt.jo_io_buf[PART_OUT] = curbuf->b_fnum; |
| 185 | opt.jo_io_buf[PART_ERR] = curbuf->b_fnum; |
| 186 | opt.jo_set |= JO_OUT_BUF + (JO_OUT_BUF << (PART_ERR - PART_OUT)); |
Bram Moolenaar | 58556cd | 2017-07-20 23:04:46 +0200 | [diff] [blame^] | 187 | opt.jo_term_rows = rows; |
| 188 | opt.jo_term_cols = cols; |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 189 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 190 | term->tl_job = job_start(argvars, &opt); |
| 191 | } |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 192 | |
Bram Moolenaar | 96ca27a | 2017-07-17 23:20:24 +0200 | [diff] [blame] | 193 | if (term->tl_job == NULL) |
| 194 | /* Wiping out the buffer will also close the window. */ |
| 195 | do_buffer(DOBUF_WIPE, DOBUF_CURRENT, FORWARD, 0, TRUE); |
| 196 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 197 | /* TODO: Setup pty, see mch_call_shell(). */ |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 198 | } |
| 199 | |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 200 | /* |
Bram Moolenaar | 96ca27a | 2017-07-17 23:20:24 +0200 | [diff] [blame] | 201 | * Free a terminal and everything it refers to. |
| 202 | * Kills the job if there is one. |
| 203 | * Called when wiping out a buffer. |
| 204 | */ |
| 205 | void |
| 206 | free_terminal(term_T *term) |
| 207 | { |
| 208 | term_T *tp; |
| 209 | |
| 210 | if (term == NULL) |
| 211 | return; |
| 212 | if (first_term == term) |
| 213 | first_term = term->tl_next; |
| 214 | else |
| 215 | for (tp = first_term; tp->tl_next != NULL; tp = tp->tl_next) |
| 216 | if (tp->tl_next == term) |
| 217 | { |
| 218 | tp->tl_next = term->tl_next; |
| 219 | break; |
| 220 | } |
| 221 | |
| 222 | if (term->tl_job != NULL) |
| 223 | { |
| 224 | if (term->tl_job->jv_status != JOB_ENDED) |
| 225 | job_stop(term->tl_job, NULL, "kill"); |
| 226 | job_unref(term->tl_job); |
| 227 | } |
| 228 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 229 | term_free(term); |
Bram Moolenaar | 96ca27a | 2017-07-17 23:20:24 +0200 | [diff] [blame] | 230 | vim_free(term); |
| 231 | } |
| 232 | |
| 233 | /* |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 234 | * Invoked when "msg" output from a job was received. Write it to the terminal |
| 235 | * of "buffer". |
| 236 | */ |
| 237 | void |
| 238 | write_to_term(buf_T *buffer, char_u *msg, channel_T *channel) |
| 239 | { |
| 240 | size_t len = STRLEN(msg); |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 241 | term_T *term = buffer->b_term; |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 242 | |
| 243 | ch_logn(channel, "writing %d bytes to terminal", (int)len); |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 244 | term_write_job_output(term, msg, len); |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 245 | |
| 246 | /* TODO: only update once in a while. */ |
| 247 | update_screen(0); |
| 248 | setcursor(); |
| 249 | out_flush(); |
| 250 | } |
| 251 | |
| 252 | /* |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 253 | * Wait for input and send it to the job. |
Bram Moolenaar | e825d8b | 2017-07-19 23:20:19 +0200 | [diff] [blame] | 254 | * Return when the start of a CTRL-W command is typed or anything else that |
| 255 | * should be handled as a Normal mode command. |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 256 | */ |
| 257 | void |
| 258 | terminal_loop(void) |
| 259 | { |
| 260 | char buf[KEY_BUF_LEN]; |
| 261 | int c; |
| 262 | size_t len; |
Bram Moolenaar | e825d8b | 2017-07-19 23:20:19 +0200 | [diff] [blame] | 263 | static int mouse_was_outside = FALSE; |
| 264 | int dragging_outside = FALSE; |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 265 | |
| 266 | for (;;) |
| 267 | { |
| 268 | /* TODO: skip screen update when handling a sequence of keys. */ |
| 269 | update_screen(0); |
| 270 | setcursor(); |
| 271 | out_flush(); |
Bram Moolenaar | 58556cd | 2017-07-20 23:04:46 +0200 | [diff] [blame^] | 272 | ++no_mapping; |
| 273 | ++allow_keys; |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 274 | c = vgetc(); |
Bram Moolenaar | 58556cd | 2017-07-20 23:04:46 +0200 | [diff] [blame^] | 275 | --no_mapping; |
| 276 | --allow_keys; |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 277 | |
Bram Moolenaar | e825d8b | 2017-07-19 23:20:19 +0200 | [diff] [blame] | 278 | /* Catch keys that need to be handled as in Normal mode. */ |
| 279 | switch (c) |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 280 | { |
Bram Moolenaar | e825d8b | 2017-07-19 23:20:19 +0200 | [diff] [blame] | 281 | case Ctrl_W: |
| 282 | case NUL: |
| 283 | case K_ZERO: |
| 284 | stuffcharReadbuff(c); |
| 285 | return; |
| 286 | |
| 287 | case K_IGNORE: continue; |
| 288 | |
| 289 | case K_LEFTDRAG: |
| 290 | case K_MIDDLEDRAG: |
| 291 | case K_RIGHTDRAG: |
| 292 | case K_X1DRAG: |
| 293 | case K_X2DRAG: |
| 294 | dragging_outside = mouse_was_outside; |
| 295 | /* FALLTHROUGH */ |
| 296 | case K_LEFTMOUSE: |
| 297 | case K_LEFTMOUSE_NM: |
| 298 | case K_LEFTRELEASE: |
| 299 | case K_LEFTRELEASE_NM: |
| 300 | case K_MIDDLEMOUSE: |
| 301 | case K_MIDDLERELEASE: |
| 302 | case K_RIGHTMOUSE: |
| 303 | case K_RIGHTRELEASE: |
| 304 | case K_X1MOUSE: |
| 305 | case K_X1RELEASE: |
| 306 | case K_X2MOUSE: |
| 307 | case K_X2RELEASE: |
| 308 | if (mouse_row < W_WINROW(curwin) |
| 309 | || mouse_row >= (W_WINROW(curwin) + curwin->w_height) |
| 310 | || mouse_col < W_WINCOL(curwin) |
| 311 | || mouse_col >= W_ENDCOL(curwin) |
| 312 | || dragging_outside) |
| 313 | { |
| 314 | /* click outside the current window */ |
| 315 | stuffcharReadbuff(c); |
| 316 | mouse_was_outside = TRUE; |
| 317 | return; |
| 318 | } |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 319 | } |
Bram Moolenaar | e825d8b | 2017-07-19 23:20:19 +0200 | [diff] [blame] | 320 | mouse_was_outside = FALSE; |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 321 | |
| 322 | /* Convert the typed key to a sequence of bytes for the job. */ |
| 323 | len = term_convert_key(c, buf); |
| 324 | if (len > 0) |
| 325 | /* TODO: if FAIL is returned, stop? */ |
| 326 | channel_send(curbuf->b_term->tl_job->jv_channel, PART_IN, |
| 327 | (char_u *)buf, len, NULL); |
| 328 | } |
| 329 | } |
| 330 | |
| 331 | /* |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 332 | * Called to update the window that contains the terminal. |
| 333 | */ |
| 334 | void |
| 335 | term_update_window(win_T *wp) |
| 336 | { |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 337 | term_update_lines(wp); |
| 338 | } |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 339 | |
Bram Moolenaar | 58556cd | 2017-07-20 23:04:46 +0200 | [diff] [blame^] | 340 | static void |
| 341 | position_cursor(win_T *wp, VTermPos *pos) |
| 342 | { |
| 343 | wp->w_wrow = MIN(pos->row, MAX(0, wp->w_height - 1)); |
| 344 | wp->w_wcol = MIN(pos->col, MAX(0, wp->w_width - 1)); |
| 345 | } |
| 346 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 347 | #ifdef WIN3264 |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 348 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 349 | /************************************** |
| 350 | * 2. MS-Windows implementation. |
| 351 | */ |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 352 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 353 | /* |
| 354 | * Create a new terminal of "rows" by "cols" cells. |
| 355 | * Store a reference in "term". |
| 356 | * Return OK or FAIL. |
| 357 | */ |
| 358 | static int |
| 359 | term_init(term_T *term, int rows, int cols) |
| 360 | { |
| 361 | /* TODO: Create a hidden console */ |
| 362 | return FAIL; |
| 363 | } |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 364 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 365 | /* |
| 366 | * Free the terminal emulator part of "term". |
| 367 | */ |
| 368 | static void |
| 369 | term_free(term_T *term) |
| 370 | { |
| 371 | /* TODO */ |
| 372 | } |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 373 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 374 | /* |
| 375 | * Write job output "msg[len]" to the terminal. |
| 376 | */ |
| 377 | static void |
| 378 | term_write_job_output(term_T *term, char_u *msg, size_t len) |
| 379 | { |
| 380 | /* TODO */ |
| 381 | } |
| 382 | |
| 383 | /* |
| 384 | * Convert typed key "c" into bytes to send to the job. |
| 385 | * Return the number of bytes in "buf". |
| 386 | */ |
| 387 | static int |
| 388 | term_convert_key(int c, char *buf) |
| 389 | { |
| 390 | /* TODO */ |
| 391 | return 0; |
| 392 | } |
| 393 | |
| 394 | /* |
| 395 | * Called to update the window that contains the terminal. |
| 396 | */ |
| 397 | static void |
| 398 | term_update_lines(win_T *wp) |
| 399 | { |
| 400 | /* TODO */ |
| 401 | } |
| 402 | |
| 403 | #else |
| 404 | |
| 405 | /************************************** |
| 406 | * 3. Unix-like implementation. |
| 407 | * |
| 408 | * For a terminal one VTerm is constructed. This uses libvterm. A copy of |
| 409 | * that library is in the libvterm directory. |
| 410 | */ |
| 411 | |
| 412 | static int handle_damage(VTermRect rect, void *user); |
| 413 | static int handle_moverect(VTermRect dest, VTermRect src, void *user); |
| 414 | static int handle_movecursor(VTermPos pos, VTermPos oldpos, int visible, void *user); |
| 415 | static int handle_resize(int rows, int cols, void *user); |
| 416 | |
| 417 | static VTermScreenCallbacks screen_callbacks = { |
| 418 | handle_damage, /* damage */ |
| 419 | handle_moverect, /* moverect */ |
| 420 | handle_movecursor, /* movecursor */ |
| 421 | NULL, /* settermprop */ |
| 422 | NULL, /* bell */ |
| 423 | handle_resize, /* resize */ |
| 424 | NULL, /* sb_pushline */ |
| 425 | NULL /* sb_popline */ |
| 426 | }; |
| 427 | |
| 428 | /* |
| 429 | * Create a new terminal of "rows" by "cols" cells. |
| 430 | * Store a reference in "term". |
| 431 | * Return OK or FAIL. |
| 432 | */ |
| 433 | static int |
| 434 | term_init(term_T *term, int rows, int cols) |
| 435 | { |
| 436 | VTerm *vterm = vterm_new(rows, cols); |
| 437 | VTermScreen *screen; |
| 438 | |
| 439 | term->tl_vterm = vterm; |
| 440 | screen = vterm_obtain_screen(vterm); |
| 441 | vterm_screen_set_callbacks(screen, &screen_callbacks, term); |
| 442 | /* TODO: depends on 'encoding'. */ |
| 443 | vterm_set_utf8(vterm, 1); |
| 444 | /* Required to initialize most things. */ |
| 445 | vterm_screen_reset(screen, 1 /* hard */); |
| 446 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 447 | return OK; |
| 448 | } |
| 449 | |
| 450 | /* |
| 451 | * Free the terminal emulator part of "term". |
| 452 | */ |
| 453 | static void |
| 454 | term_free(term_T *term) |
| 455 | { |
| 456 | vterm_free(term->tl_vterm); |
| 457 | } |
| 458 | |
| 459 | /* |
| 460 | * Write job output "msg[len]" to the terminal. |
| 461 | */ |
| 462 | static void |
| 463 | term_write_job_output(term_T *term, char_u *msg, size_t len) |
| 464 | { |
| 465 | VTerm *vterm = term->tl_vterm; |
Bram Moolenaar | e825d8b | 2017-07-19 23:20:19 +0200 | [diff] [blame] | 466 | char_u *p; |
| 467 | size_t done; |
| 468 | size_t len_now; |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 469 | |
Bram Moolenaar | e825d8b | 2017-07-19 23:20:19 +0200 | [diff] [blame] | 470 | for (done = 0; done < len; done += len_now) |
| 471 | { |
| 472 | for (p = msg + done; p < msg + len; ) |
| 473 | { |
| 474 | if (*p == NL) |
| 475 | break; |
| 476 | p += mb_ptr2len_len(p, len - (p - msg)); |
| 477 | } |
| 478 | len_now = p - msg - done; |
| 479 | vterm_input_write(vterm, (char *)msg + done, len_now); |
| 480 | if (p < msg + len && *p == NL) |
| 481 | { |
| 482 | /* Convert NL to CR-NL, that appears to work best. */ |
| 483 | vterm_input_write(vterm, "\r\n", 2); |
| 484 | ++len_now; |
| 485 | } |
| 486 | } |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 487 | vterm_screen_flush_damage(vterm_obtain_screen(vterm)); |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 488 | } |
| 489 | |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 490 | static int |
| 491 | handle_damage(VTermRect rect, void *user) |
| 492 | { |
| 493 | term_T *term = (term_T *)user; |
| 494 | |
| 495 | term->tl_dirty_row_start = MIN(term->tl_dirty_row_start, rect.start_row); |
| 496 | term->tl_dirty_row_end = MAX(term->tl_dirty_row_end, rect.end_row); |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 497 | redraw_buf_later(term->tl_buffer, NOT_VALID); |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 498 | return 1; |
| 499 | } |
| 500 | |
| 501 | static int |
Bram Moolenaar | 58556cd | 2017-07-20 23:04:46 +0200 | [diff] [blame^] | 502 | handle_moverect(VTermRect dest UNUSED, VTermRect src UNUSED, void *user) |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 503 | { |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 504 | term_T *term = (term_T *)user; |
| 505 | |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 506 | /* TODO */ |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 507 | redraw_buf_later(term->tl_buffer, NOT_VALID); |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 508 | return 1; |
| 509 | } |
| 510 | |
| 511 | static int |
Bram Moolenaar | 58556cd | 2017-07-20 23:04:46 +0200 | [diff] [blame^] | 512 | handle_movecursor( |
| 513 | VTermPos pos, |
| 514 | VTermPos oldpos UNUSED, |
| 515 | int visible UNUSED, |
| 516 | void *user) |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 517 | { |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 518 | term_T *term = (term_T *)user; |
| 519 | win_T *wp; |
| 520 | int is_current = FALSE; |
| 521 | |
| 522 | FOR_ALL_WINDOWS(wp) |
| 523 | { |
| 524 | if (wp->w_buffer == term->tl_buffer) |
| 525 | { |
Bram Moolenaar | 58556cd | 2017-07-20 23:04:46 +0200 | [diff] [blame^] | 526 | position_cursor(wp, &pos); |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 527 | if (wp == curwin) |
| 528 | is_current = TRUE; |
| 529 | } |
| 530 | } |
| 531 | |
| 532 | if (is_current) |
| 533 | { |
| 534 | setcursor(); |
| 535 | out_flush(); |
| 536 | } |
| 537 | |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 538 | return 1; |
| 539 | } |
| 540 | |
| 541 | static int |
| 542 | handle_resize(int rows, int cols, void *user) |
| 543 | { |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 544 | term_T *term = (term_T *)user; |
Bram Moolenaar | 58556cd | 2017-07-20 23:04:46 +0200 | [diff] [blame^] | 545 | win_T *wp; |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 546 | |
Bram Moolenaar | 58556cd | 2017-07-20 23:04:46 +0200 | [diff] [blame^] | 547 | FOR_ALL_WINDOWS(wp) |
| 548 | { |
| 549 | if (wp->w_buffer == term->tl_buffer) |
| 550 | { |
| 551 | win_setheight_win(rows, wp); |
| 552 | win_setwidth_win(cols, wp); |
| 553 | } |
| 554 | } |
| 555 | |
Bram Moolenaar | cb8bbe9 | 2017-07-16 13:48:22 +0200 | [diff] [blame] | 556 | redraw_buf_later(term->tl_buffer, NOT_VALID); |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 557 | return 1; |
| 558 | } |
| 559 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 560 | /* |
| 561 | * Convert typed key "c" into bytes to send to the job. |
| 562 | * Return the number of bytes in "buf". |
| 563 | */ |
| 564 | static int |
| 565 | term_convert_key(int c, char *buf) |
| 566 | { |
| 567 | VTerm *vterm = curbuf->b_term->tl_vterm; |
| 568 | VTermKey key = VTERM_KEY_NONE; |
| 569 | VTermModifier mod = VTERM_MOD_NONE; |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 570 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 571 | switch (c) |
| 572 | { |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 573 | case CAR: key = VTERM_KEY_ENTER; break; |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 574 | case ESC: key = VTERM_KEY_ESCAPE; break; |
| 575 | case K_BS: key = VTERM_KEY_BACKSPACE; break; |
| 576 | case K_DEL: key = VTERM_KEY_DEL; break; |
| 577 | case K_DOWN: key = VTERM_KEY_DOWN; break; |
| 578 | case K_END: key = VTERM_KEY_END; break; |
| 579 | case K_F10: key = VTERM_KEY_FUNCTION(10); break; |
| 580 | case K_F11: key = VTERM_KEY_FUNCTION(11); break; |
| 581 | case K_F12: key = VTERM_KEY_FUNCTION(12); break; |
| 582 | case K_F1: key = VTERM_KEY_FUNCTION(1); break; |
| 583 | case K_F2: key = VTERM_KEY_FUNCTION(2); break; |
| 584 | case K_F3: key = VTERM_KEY_FUNCTION(3); break; |
| 585 | case K_F4: key = VTERM_KEY_FUNCTION(4); break; |
| 586 | case K_F5: key = VTERM_KEY_FUNCTION(5); break; |
| 587 | case K_F6: key = VTERM_KEY_FUNCTION(6); break; |
| 588 | case K_F7: key = VTERM_KEY_FUNCTION(7); break; |
| 589 | case K_F8: key = VTERM_KEY_FUNCTION(8); break; |
| 590 | case K_F9: key = VTERM_KEY_FUNCTION(9); break; |
| 591 | case K_HOME: key = VTERM_KEY_HOME; break; |
| 592 | case K_INS: key = VTERM_KEY_INS; break; |
| 593 | case K_K0: key = VTERM_KEY_KP_0; break; |
| 594 | case K_K1: key = VTERM_KEY_KP_1; break; |
| 595 | case K_K2: key = VTERM_KEY_KP_2; break; |
| 596 | case K_K3: key = VTERM_KEY_KP_3; break; |
| 597 | case K_K4: key = VTERM_KEY_KP_4; break; |
| 598 | case K_K5: key = VTERM_KEY_KP_5; break; |
| 599 | case K_K6: key = VTERM_KEY_KP_6; break; |
| 600 | case K_K7: key = VTERM_KEY_KP_7; break; |
| 601 | case K_K8: key = VTERM_KEY_KP_8; break; |
| 602 | case K_K9: key = VTERM_KEY_KP_9; break; |
| 603 | case K_KDEL: key = VTERM_KEY_DEL; break; /* TODO */ |
| 604 | case K_KDIVIDE: key = VTERM_KEY_KP_DIVIDE; break; |
| 605 | case K_KEND: key = VTERM_KEY_KP_1; break; /* TODO */ |
| 606 | case K_KENTER: key = VTERM_KEY_KP_ENTER; break; |
| 607 | case K_KHOME: key = VTERM_KEY_KP_7; break; /* TODO */ |
| 608 | case K_KINS: key = VTERM_KEY_KP_0; break; /* TODO */ |
| 609 | case K_KMINUS: key = VTERM_KEY_KP_MINUS; break; |
| 610 | case K_KMULTIPLY: key = VTERM_KEY_KP_MULT; break; |
| 611 | case K_KPAGEDOWN: key = VTERM_KEY_KP_3; break; /* TODO */ |
| 612 | case K_KPAGEUP: key = VTERM_KEY_KP_9; break; /* TODO */ |
| 613 | case K_KPLUS: key = VTERM_KEY_KP_PLUS; break; |
| 614 | case K_KPOINT: key = VTERM_KEY_KP_PERIOD; break; |
| 615 | case K_LEFT: key = VTERM_KEY_LEFT; break; |
| 616 | case K_PAGEDOWN: key = VTERM_KEY_PAGEDOWN; break; |
| 617 | case K_PAGEUP: key = VTERM_KEY_PAGEUP; break; |
| 618 | case K_RIGHT: key = VTERM_KEY_RIGHT; break; |
| 619 | case K_UP: key = VTERM_KEY_UP; break; |
| 620 | case TAB: key = VTERM_KEY_TAB; break; |
Bram Moolenaar | e825d8b | 2017-07-19 23:20:19 +0200 | [diff] [blame] | 621 | |
| 622 | case K_MOUSEUP: /* TODO */ break; |
| 623 | case K_MOUSEDOWN: /* TODO */ break; |
| 624 | case K_MOUSELEFT: /* TODO */ break; |
| 625 | case K_MOUSERIGHT: /* TODO */ break; |
| 626 | |
| 627 | case K_LEFTMOUSE: /* TODO */ break; |
| 628 | case K_LEFTMOUSE_NM: /* TODO */ break; |
| 629 | case K_LEFTDRAG: /* TODO */ break; |
| 630 | case K_LEFTRELEASE: /* TODO */ break; |
| 631 | case K_LEFTRELEASE_NM: /* TODO */ break; |
| 632 | case K_MIDDLEMOUSE: /* TODO */ break; |
| 633 | case K_MIDDLEDRAG: /* TODO */ break; |
| 634 | case K_MIDDLERELEASE: /* TODO */ break; |
| 635 | case K_RIGHTMOUSE: /* TODO */ break; |
| 636 | case K_RIGHTDRAG: /* TODO */ break; |
| 637 | case K_RIGHTRELEASE: /* TODO */ break; |
| 638 | case K_X1MOUSE: /* TODO */ break; |
| 639 | case K_X1DRAG: /* TODO */ break; |
| 640 | case K_X1RELEASE: /* TODO */ break; |
| 641 | case K_X2MOUSE: /* TODO */ break; |
| 642 | case K_X2DRAG: /* TODO */ break; |
| 643 | case K_X2RELEASE: /* TODO */ break; |
| 644 | |
| 645 | /* TODO: handle all special keys and modifiers that terminal_loop() |
| 646 | * does not handle. */ |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 647 | } |
| 648 | |
| 649 | /* |
| 650 | * Convert special keys to vterm keys: |
| 651 | * - Write keys to vterm: vterm_keyboard_key() |
| 652 | * - Write output to channel. |
| 653 | */ |
| 654 | if (key != VTERM_KEY_NONE) |
| 655 | /* Special key, let vterm convert it. */ |
| 656 | vterm_keyboard_key(vterm, key, mod); |
| 657 | else |
| 658 | /* Normal character, let vterm convert it. */ |
| 659 | vterm_keyboard_unichar(vterm, c, mod); |
| 660 | |
| 661 | /* Read back the converted escape sequence. */ |
| 662 | return vterm_output_read(vterm, buf, KEY_BUF_LEN); |
| 663 | } |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 664 | |
Bram Moolenaar | 938783d | 2017-07-16 20:13:26 +0200 | [diff] [blame] | 665 | /* |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 666 | * Called to update the window that contains the terminal. |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 667 | */ |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 668 | static void |
| 669 | term_update_lines(win_T *wp) |
Bram Moolenaar | 938783d | 2017-07-16 20:13:26 +0200 | [diff] [blame] | 670 | { |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 671 | int vterm_rows; |
| 672 | int vterm_cols; |
| 673 | VTerm *vterm = wp->w_buffer->b_term->tl_vterm; |
| 674 | VTermScreen *screen = vterm_obtain_screen(vterm); |
Bram Moolenaar | 58556cd | 2017-07-20 23:04:46 +0200 | [diff] [blame^] | 675 | VTermState *state = vterm_obtain_state(vterm); |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 676 | VTermPos pos; |
Bram Moolenaar | 938783d | 2017-07-16 20:13:26 +0200 | [diff] [blame] | 677 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 678 | vterm_get_size(vterm, &vterm_rows, &vterm_cols); |
| 679 | |
Bram Moolenaar | 58556cd | 2017-07-20 23:04:46 +0200 | [diff] [blame^] | 680 | if (*wp->w_p_tms == NUL |
| 681 | && (vterm_rows != wp->w_height || vterm_cols != wp->w_width)) |
| 682 | { |
| 683 | vterm_set_size(vterm, wp->w_height, wp->w_width); |
| 684 | /* Get the size again, in case setting the didn't work. */ |
| 685 | vterm_get_size(vterm, &vterm_rows, &vterm_cols); |
| 686 | } |
| 687 | |
| 688 | /* The cursor may have been moved when resizing. */ |
| 689 | vterm_state_get_cursorpos(state, &pos); |
| 690 | position_cursor(wp, &pos); |
| 691 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 692 | /* TODO: Only redraw what changed. */ |
| 693 | for (pos.row = 0; pos.row < wp->w_height; ++pos.row) |
Bram Moolenaar | 938783d | 2017-07-16 20:13:26 +0200 | [diff] [blame] | 694 | { |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 695 | int off = screen_get_current_line_off(); |
Bram Moolenaar | 938783d | 2017-07-16 20:13:26 +0200 | [diff] [blame] | 696 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 697 | if (pos.row < vterm_rows) |
| 698 | for (pos.col = 0; pos.col < wp->w_width && pos.col < vterm_cols; |
| 699 | ++pos.col) |
| 700 | { |
| 701 | VTermScreenCell cell; |
| 702 | int c; |
Bram Moolenaar | 938783d | 2017-07-16 20:13:26 +0200 | [diff] [blame] | 703 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 704 | vterm_screen_get_cell(screen, pos, &cell); |
| 705 | /* TODO: use cell.attrs and colors */ |
| 706 | /* TODO: use cell.width */ |
| 707 | /* TODO: multi-byte chars */ |
| 708 | c = cell.chars[0]; |
| 709 | ScreenLines[off] = c == NUL ? ' ' : c; |
| 710 | ScreenAttrs[off] = 0; |
| 711 | ++off; |
| 712 | } |
Bram Moolenaar | e825d8b | 2017-07-19 23:20:19 +0200 | [diff] [blame] | 713 | else |
| 714 | pos.col = 0; |
Bram Moolenaar | 938783d | 2017-07-16 20:13:26 +0200 | [diff] [blame] | 715 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 716 | screen_line(wp->w_winrow + pos.row, wp->w_wincol, pos.col, wp->w_width, |
| 717 | FALSE); |
Bram Moolenaar | 938783d | 2017-07-16 20:13:26 +0200 | [diff] [blame] | 718 | } |
| 719 | } |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 720 | |
Bram Moolenaar | 8c0095c | 2017-07-18 22:53:21 +0200 | [diff] [blame] | 721 | #endif |
| 722 | |
Bram Moolenaar | e4f25e4 | 2017-07-07 11:54:15 +0200 | [diff] [blame] | 723 | #endif /* FEAT_TERMINAL */ |