diff options
| -rw-r--r-- | CMakeLists.txt | 2 | ||||
| -rw-r--r-- | runtime/doc/eval.txt | 20 | ||||
| -rw-r--r-- | runtime/doc/various.txt | 15 | ||||
| -rw-r--r-- | src/nvim/eval.c | 82 | ||||
| -rw-r--r-- | src/nvim/ex_docmd.c | 25 | ||||
| -rw-r--r-- | test/functional/fixtures/CMakeLists.txt (renamed from test/functional/job/CMakeLists.txt) | 2 | ||||
| -rw-r--r-- | test/functional/fixtures/shell-test.c | 25 | ||||
| -rw-r--r-- | test/functional/fixtures/tty-test.c (renamed from test/functional/job/tty-test.c) | 0 | ||||
| -rw-r--r-- | test/functional/terminal/cursor_spec.lua | 2 | ||||
| -rw-r--r-- | test/functional/terminal/ex_terminal_spec.lua | 61 | ||||
| -rw-r--r-- | test/functional/terminal/helpers.lua | 2 | ||||
| -rw-r--r-- | test/functional/terminal/highlight_spec.lua | 4 | ||||
| -rw-r--r-- | test/functional/terminal/scrollback_spec.lua | 2 |
13 files changed, 187 insertions, 55 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt index 5e176a540d..345d7b8ff6 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -296,7 +296,7 @@ get_compile_flags(NVIM_VERSION_CFLAGS) add_subdirectory(test/includes) add_subdirectory(config) -add_subdirectory(test/functional/job) # compile pty test program +add_subdirectory(test/functional/fixtures) # compile pty/shell test programs # Setup some test-related bits. We do this after going down the tree because we diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt index 0284e6cab8..f151fd84ba 100644 --- a/runtime/doc/eval.txt +++ b/runtime/doc/eval.txt @@ -6299,15 +6299,17 @@ tempname() *tempname()* *temp-file-name* For MS-Windows forward slashes are used when the 'shellslash' option is set or when 'shellcmdflag' starts with '-'. -termopen({command}[, {opts}]) {Nvim} *termopen()* - Spawns {command} using the shell in a new pseudo-terminal - session connected to the current buffer. This function fails - if the current buffer is modified (all buffer contents are - destroyed). The {opts} dict is similar to the one passed to - |jobstart()|, but the `pty`, `width`, `height`, and `TERM` fields are - ignored: `height`/`width` are taken from the current window and - $TERM is set to "xterm-256color". Returns the same values as - |jobstart()|. +termopen({argv}[, {opts}]) {Nvim} *termopen()* + Spawns {argv}(list) in a new pseudo-terminal session connected + to the current buffer. This function fails if the current + buffer is modified (all buffer contents are destroyed). + + The {opts} dict is similar to the one passed to |jobstart()|, + but the `pty`, `width`, `height`, and `TERM` fields are + ignored: `height`/`width` are taken from the current window + and `$TERM` is set to "xterm-256color". An additional option, + `name`, can be used to give the terminal a specific name. + Returns the same values as |jobstart()|. See |nvim-terminal-emulator| for more information. diff --git a/runtime/doc/various.txt b/runtime/doc/various.txt index 8ddfdf272f..13bc089824 100644 --- a/runtime/doc/various.txt +++ b/runtime/doc/various.txt @@ -223,11 +223,18 @@ g8 Print the hex values of the bytes used in the :sh[ell] Removed. |vim-differences| {Nvim} *:term* *:terminal* -:term[inal][!] {cmd} Spawns {command} using the current value of 'shell' - in a new terminal buffer. This is equivalent to: > - - :enew | call termopen('{cmd}') | startinsert +:term[inal][!] {cmd} Spawns {cmd} using the current value of 'shell' and + 'shellcmdflag' in a new terminal buffer. This is + equivalent to: > + + :enew + :call termopen([&sh, &shcf, '{cmd}'], + \{'name':'{cmd}'}) + :startinsert < + If no {cmd} is given, 'shellcmdflag' will not be sent + to |termopen()|. + Like |:enew|, it will fail if the current buffer is modified, but can be forced with "!". See |termopen()| and |nvim-terminal-emulator| for more information. diff --git a/src/nvim/eval.c b/src/nvim/eval.c index 1065f1caf9..ea5dbc8a3f 100644 --- a/src/nvim/eval.c +++ b/src/nvim/eval.c @@ -10779,47 +10779,62 @@ static void f_jobresize(typval_T *argvars, typval_T *rettv) rettv->vval.v_number = 1; } -// "jobstart()" function -static void f_jobstart(typval_T *argvars, typval_T *rettv) +static char **list_to_argv(list_T *args) { - rettv->v_type = VAR_NUMBER; - rettv->vval.v_number = 0; - - if (check_restricted() || check_secure()) { - return; - } - - if (argvars[0].v_type != VAR_LIST - || (argvars[1].v_type != VAR_DICT && argvars[1].v_type != VAR_UNKNOWN)) { - // Wrong argument types - EMSG(_(e_invarg)); - return; - } - - list_T *args = argvars[0].vval.v_list; - // Assert that all list items are strings for (listitem_T *arg = args->lv_first; arg != NULL; arg = arg->li_next) { if (arg->li_tv.v_type != VAR_STRING) { EMSG(_(e_invarg)); - return; + return NULL; } } int argc = args->lv_len; if (!argc) { EMSG(_("Argument vector must have at least one item")); - return; + return NULL; } assert(args->lv_first); - + const char_u *exe = get_tv_string(&args->lv_first->li_tv); if (!os_can_exe(exe, NULL)) { // String is not executable EMSG2(e_jobexe, exe); + return NULL; + } + + // Build the argument vector + int i = 0; + char **argv = xcalloc(argc + 1, sizeof(char *)); + for (listitem_T *arg = args->lv_first; arg != NULL; arg = arg->li_next) { + argv[i++] = xstrdup((char *) get_tv_string(&arg->li_tv)); + } + + return argv; +} + +// "jobstart()" function +static void f_jobstart(typval_T *argvars, typval_T *rettv) +{ + rettv->v_type = VAR_NUMBER; + rettv->vval.v_number = 0; + + if (check_restricted() || check_secure()) { + return; + } + + if (argvars[0].v_type != VAR_LIST + || (argvars[1].v_type != VAR_DICT && argvars[1].v_type != VAR_UNKNOWN)) { + // Wrong argument types + EMSG(_(e_invarg)); return; } + char **argv = list_to_argv(argvars[0].vval.v_list); + if (!argv) { + return; // Did error message in list_to_argv. + } + dict_T *job_opts = NULL; ufunc_T *on_stdout = NULL, *on_stderr = NULL, *on_exit = NULL; if (argvars[1].v_type == VAR_DICT) { @@ -10829,13 +10844,6 @@ static void f_jobstart(typval_T *argvars, typval_T *rettv) } } - // Build the argument vector - int i = 0; - char **argv = xcalloc(argc + 1, sizeof(char *)); - for (listitem_T *arg = args->lv_first; arg != NULL; arg = arg->li_next) { - argv[i++] = xstrdup((char *) get_tv_string(&arg->li_tv)); - } - JobOptions opts = common_job_options(argv, on_stdout, on_stderr, on_exit, job_opts); @@ -15155,13 +15163,18 @@ static void f_termopen(typval_T *argvars, typval_T *rettv) return; } - if (argvars[0].v_type != VAR_STRING + if (argvars[0].v_type != VAR_LIST || (argvars[1].v_type != VAR_DICT && argvars[1].v_type != VAR_UNKNOWN)) { // Wrong argument types EMSG(_(e_invarg)); return; } + char **argv = list_to_argv(argvars[0].vval.v_list); + if (!argv) { + return; // Did error message in list_to_argv. + } + ufunc_T *on_stdout = NULL, *on_stderr = NULL, *on_exit = NULL; dict_T *job_opts = NULL; if (argvars[1].v_type == VAR_DICT) { @@ -15171,7 +15184,6 @@ static void f_termopen(typval_T *argvars, typval_T *rettv) } } - char **argv = shell_build_argv((char *)argvars[0].vval.v_string, NULL); JobOptions opts = common_job_options(argv, on_stdout, on_stderr, on_exit, job_opts); opts.pty = true; @@ -15197,10 +15209,16 @@ static void f_termopen(typval_T *argvars, typval_T *rettv) cwd = (char *)argvars[1].vval.v_string; } int pid = job_pid(job); + + // Get the desired name of the buffer. + char *name = job_opts ? + (char *)get_dict_string(job_opts, (char_u *)"name", false) : NULL; + if (!name) { + name = argv[0]; + } char buf[1024]; // format the title with the pid to conform with the term:// URI - snprintf(buf, sizeof(buf), "term://%s//%d:%s", cwd, pid, - (char *)argvars[0].vval.v_string); + snprintf(buf, sizeof(buf), "term://%s//%d:%s", cwd, pid, name); // at this point the buffer has no terminal instance associated yet, so unset // the 'swapfile' option to ensure no swap file will be created curbuf->b_p_swf = false; diff --git a/src/nvim/ex_docmd.c b/src/nvim/ex_docmd.c index e81f99ccea..656311ae14 100644 --- a/src/nvim/ex_docmd.c +++ b/src/nvim/ex_docmd.c @@ -9410,9 +9410,26 @@ static void ex_folddo(exarg_T *eap) static void ex_terminal(exarg_T *eap) { + char *name = NULL; char cmd[512]; - snprintf(cmd, sizeof(cmd), ":enew%s | call termopen('%s') | startinsert", - eap->forceit==TRUE ? "!" : "", - strcmp((char *)eap->arg, "") ? (char *)eap->arg : (char *)p_sh); - do_cmdline_cmd((uint8_t *)cmd); + if (strcmp((char *)eap->arg, "") == 0) { + snprintf(cmd, sizeof(cmd), "['%s']", (char *)p_sh); + name = (char *)p_sh; + } else { + // Escape quotes and slashes so they get sent literally. + name = (char *)vim_strsave_escaped(eap->arg, (char_u *)"\"\\"); + snprintf(cmd, sizeof(cmd), "['%s','%s',\"%s\"]", + (char *)p_sh, (char *)p_shcf, name); + } + + char ex_cmd[512]; + snprintf(ex_cmd, sizeof(ex_cmd), + ":enew%s | call termopen(%s, {'name':\"%s\"}) | startinsert", + eap->forceit==TRUE ? "!" : "", cmd, name); + + do_cmdline_cmd((uint8_t *)ex_cmd); + + if (name != (char *)p_sh) { + xfree(name); + } } diff --git a/test/functional/job/CMakeLists.txt b/test/functional/fixtures/CMakeLists.txt index 14ec287816..70aee6efa9 100644 --- a/test/functional/job/CMakeLists.txt +++ b/test/functional/fixtures/CMakeLists.txt @@ -1,2 +1,4 @@ add_executable(tty-test tty-test.c) target_link_libraries(tty-test ${LIBUV_LIBRARIES}) + +add_executable(shell-test shell-test.c) diff --git a/test/functional/fixtures/shell-test.c b/test/functional/fixtures/shell-test.c new file mode 100644 index 0000000000..5fa8a58049 --- /dev/null +++ b/test/functional/fixtures/shell-test.c @@ -0,0 +1,25 @@ +// A simple implementation of a shell for testing +// `termopen([&sh, &shcf, '{cmd'}])` and `termopen([&sh])`. +// +// If launched with no arguments, prints "ready $ ", otherwise prints +// "ready $ {cmd}\n". + +#include <stdio.h> +#include <string.h> + +int main(int argc, char **argv) +{ + fprintf(stderr, "ready $ "); + + if (argc == 3) { + // argv should be {"terminal-test", "EXE", "prog args..."} + if (strcmp(argv[1], "EXE") != 0) { + fprintf(stderr, "first argument must be 'EXE'\n"); + return 2; + } + + fprintf(stderr, "%s\n", argv[2]); + } + + return 0; +} diff --git a/test/functional/job/tty-test.c b/test/functional/fixtures/tty-test.c index 40ba131003..40ba131003 100644 --- a/test/functional/job/tty-test.c +++ b/test/functional/fixtures/tty-test.c diff --git a/test/functional/terminal/cursor_spec.lua b/test/functional/terminal/cursor_spec.lua index cecb33de7c..29225f968f 100644 --- a/test/functional/terminal/cursor_spec.lua +++ b/test/functional/terminal/cursor_spec.lua @@ -144,7 +144,7 @@ describe('cursor with customized highlighting', function() [6] = {foreground = 130}, }) screen:attach(false) - execute('term "' ..nvim_dir.. '/tty-test"') + execute('call termopen(["'..nvim_dir..'/tty-test"]) | startinsert') end) it('overrides the default highlighting', function() diff --git a/test/functional/terminal/ex_terminal_spec.lua b/test/functional/terminal/ex_terminal_spec.lua new file mode 100644 index 0000000000..3855cf4b65 --- /dev/null +++ b/test/functional/terminal/ex_terminal_spec.lua @@ -0,0 +1,61 @@ +local helpers = require('test.functional.helpers') +local Screen = require('test.functional.ui.screen') +local clear, wait, nvim = helpers.clear, helpers.wait, helpers.nvim +local nvim_dir = helpers.nvim_dir +local execute, source = helpers.execute, helpers.source +local eq, neq = helpers.eq, helpers.neq + +describe(':terminal', function() + local screen + + before_each(function() + clear() + screen = Screen.new(50, 7) + screen:attach(false) + nvim('set_option', 'shell', nvim_dir..'/shell-test') + nvim('set_option', 'shellcmdflag', 'EXE') + + end) + + it('with no argument, acts like termopen()', function() + execute('terminal') + wait() + screen:expect([[ + ready $ | + [Program exited, press any key to close] | + | + | + | + | + -- TERMINAL -- | + ]]) + end) + + it('executes a given command through the shell', function() + execute('terminal echo hi') + wait() + screen:expect([[ + ready $ echo hi | + | + [Program exited, press any key to close] | + | + | + | + -- TERMINAL -- | + ]]) + end) + + it('allows quotes and slashes', function() + execute([[terminal echo 'hello' \ "world"]]) + wait() + screen:expect([[ + ready $ echo 'hello' \ "world" | + | + [Program exited, press any key to close] | + | + | + | + -- TERMINAL -- | + ]]) + end) +end) diff --git a/test/functional/terminal/helpers.lua b/test/functional/terminal/helpers.lua index 1bc6057a0b..e488495139 100644 --- a/test/functional/terminal/helpers.lua +++ b/test/functional/terminal/helpers.lua @@ -56,7 +56,7 @@ local function screen_setup(extra_height) -- tty-test puts the terminal into raw mode and echoes all input. tests are -- done by feeding it with terminfo codes to control the display and -- verifying output with screen:expect. - execute('term ' ..nvim_dir.. '/tty-test') + execute('enew | call termopen(["'..nvim_dir..'/tty-test"]) | startinsert') -- wait for "tty ready" to be printed before each test or the terminal may -- still be in canonical mode(will echo characters for example) -- diff --git a/test/functional/terminal/highlight_spec.lua b/test/functional/terminal/highlight_spec.lua index 59b0d2c19d..b72527e7b6 100644 --- a/test/functional/terminal/highlight_spec.lua +++ b/test/functional/terminal/highlight_spec.lua @@ -27,7 +27,7 @@ describe('terminal window highlighting', function() [8] = {background = 11} }) screen:attach(false) - execute('term "' ..nvim_dir.. '/tty-test"') + execute('enew | call termopen(["'..nvim_dir..'/tty-test"]) | startinsert') screen:expect([[ tty ready | | @@ -133,7 +133,7 @@ describe('terminal window highlighting with custom palette', function() }) screen:attach(true) nvim('set_var', 'terminal_color_3', '#123456') - execute('term "' ..nvim_dir.. '/tty-test"') + execute('enew | call termopen(["'..nvim_dir..'/tty-test"]) | startinsert') screen:expect([[ tty ready | | diff --git a/test/functional/terminal/scrollback_spec.lua b/test/functional/terminal/scrollback_spec.lua index d9b7534fac..f2381631a9 100644 --- a/test/functional/terminal/scrollback_spec.lua +++ b/test/functional/terminal/scrollback_spec.lua @@ -332,7 +332,7 @@ describe('terminal prints more lines than the screen height and exits', function clear() local screen = Screen.new(50, 7) screen:attach(false) - execute('term ' ..nvim_dir.. '/tty-test 10') + execute('call termopen(["'..nvim_dir..'/tty-test", "10"]) | startinsert') wait() screen:expect([[ line6 | |