aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorThiago de Arruda <tpadilha84@gmail.com>2015-03-29 21:07:56 -0300
committerThiago de Arruda <tpadilha84@gmail.com>2015-03-29 21:07:56 -0300
commit960b9108c2928b6cf0adcabdb829d06996635211 (patch)
treeccae254cda1e902971d2689210d14d8f44ebc4b8 /src
parent2c7e8c38e0f483cf803eb225720cd11ae370ae75 (diff)
parentb94f29004b8d74e80156853695a1aaeec857085d (diff)
downloadrneovim-960b9108c2928b6cf0adcabdb829d06996635211.tar.gz
rneovim-960b9108c2928b6cf0adcabdb829d06996635211.tar.bz2
rneovim-960b9108c2928b6cf0adcabdb829d06996635211.zip
Merge PR #2247 'Refactor/enhance job api'
Diffstat (limited to 'src')
-rw-r--r--src/nvim/eval.c543
-rw-r--r--src/nvim/eval.h1
-rw-r--r--src/nvim/fileio.c2
-rw-r--r--src/nvim/fileio.h1
-rw-r--r--src/nvim/main.c4
-rw-r--r--src/nvim/msgpack_rpc/channel.c2
-rw-r--r--src/nvim/os/job.c24
-rw-r--r--src/nvim/os/job_defs.h3
-rw-r--r--src/nvim/os/job_private.h2
9 files changed, 442 insertions, 140 deletions
diff --git a/src/nvim/eval.c b/src/nvim/eval.c
index ae00888233..3b1b034b33 100644
--- a/src/nvim/eval.c
+++ b/src/nvim/eval.c
@@ -427,7 +427,6 @@ static struct vimvar {
{VV_NAME("oldfiles", VAR_LIST), 0},
{VV_NAME("windowid", VAR_NUMBER), VV_RO},
{VV_NAME("progpath", VAR_STRING), VV_RO},
- {VV_NAME("job_data", VAR_LIST), 0},
{VV_NAME("command_output", VAR_STRING), 0}
};
@@ -446,8 +445,11 @@ typedef struct {
Job *job;
Terminal *term;
bool exited;
+ bool stdin_closed;
int refcount;
- char *autocmd_file;
+ ufunc_T *on_stdout, *on_stderr, *on_exit;
+ dict_T *self;
+ int *status_ptr;
} TerminalJobData;
@@ -460,13 +462,17 @@ typedef struct {
valid character */
// Memory pool for reusing JobEvent structures
typedef struct {
- int id;
- char *name, *type;
+ int job_id;
+ TerminalJobData *data;
+ ufunc_T *callback;
+ const char *type;
list_T *received;
+ int status;
} JobEvent;
#define JobEventFreer(x)
KMEMPOOL_INIT(JobEventPool, JobEvent, JobEventFreer)
static kmempool_t(JobEventPool) *job_event_pool = NULL;
+static bool defer_job_callbacks = true;
/*
* Initialize the global and v: variables.
@@ -5933,6 +5939,41 @@ dictitem_T *dict_find(dict_T *d, char_u *key, int len)
return HI2DI(hi);
}
+// Get a function from a dictionary
+static ufunc_T *get_dict_callback(dict_T *d, char *key)
+{
+ dictitem_T *di = dict_find(d, (uint8_t *)key, -1);
+
+ if (di == NULL) {
+ return NULL;
+ }
+
+ if (di->di_tv.v_type != VAR_FUNC && di->di_tv.v_type != VAR_STRING) {
+ EMSG(_("Argument is not a function or function name"));
+ return NULL;
+ }
+
+ uint8_t *name = di->di_tv.vval.v_string;
+ uint8_t *n = name;
+ ufunc_T *rv;
+ if (*n > '9' || *n < '0') {
+ n = trans_function_name(&n, false, TFN_INT|TFN_QUIET, NULL);
+ rv = find_func(n);
+ free(n);
+ } else {
+ // dict function, name is already translated
+ rv = find_func(n);
+ }
+
+ if (!rv) {
+ EMSG2(_("Function %s doesn't exist"), name);
+ return NULL;
+ }
+ rv->uf_refcount++;
+
+ return rv;
+}
+
/*
* Get a string item from a dictionary.
* When "save" is TRUE allocate memory for it.
@@ -6495,10 +6536,12 @@ static struct fst {
{"isdirectory", 1, 1, f_isdirectory},
{"islocked", 1, 1, f_islocked},
{"items", 1, 1, f_items},
+ {"jobclose", 1, 2, f_jobclose},
{"jobresize", 3, 3, f_jobresize},
{"jobsend", 2, 2, f_jobsend},
- {"jobstart", 2, 4, f_jobstart},
+ {"jobstart", 1, 2, f_jobstart},
{"jobstop", 1, 1, f_jobstop},
+ {"jobwait", 1, 2, f_jobwait},
{"join", 1, 2, f_join},
{"keys", 1, 1, f_keys},
{"last_buffer_nr", 0, 0, f_last_buffer_nr}, /* obsolete */
@@ -6917,24 +6960,9 @@ call_func (
else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
error = ERROR_DICT;
else {
- /*
- * Call the user function.
- * Save and restore search patterns, script variables and
- * redo buffer.
- */
- save_search_patterns();
- saveRedobuff();
- ++fp->uf_calls;
- call_user_func(fp, argcount, argvars, rettv,
- firstline, lastline,
+ // Call the user function.
+ call_user_func(fp, argcount, argvars, rettv, firstline, lastline,
(fp->uf_flags & FC_DICT) ? selfdict : NULL);
- if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name)
- && fp->uf_refcount <= 0)
- /* Function was unreferenced while being used, free it
- * now. */
- func_free(fp);
- restoreRedobuff();
- restore_search_patterns();
error = ERROR_NONE;
}
}
@@ -10632,6 +10660,48 @@ static void f_items(typval_T *argvars, typval_T *rettv)
dict_list(argvars, rettv, 2);
}
+// "jobclose(id[, stream])" function
+static void f_jobclose(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_NUMBER || (argvars[1].v_type != VAR_STRING
+ && argvars[1].v_type != VAR_UNKNOWN)) {
+ EMSG(_(e_invarg));
+ return;
+ }
+
+ Job *job = job_find(argvars[0].vval.v_number);
+
+ if (!is_user_job(job)) {
+ // Invalid job id
+ EMSG(_(e_invjob));
+ return;
+ }
+
+ if (argvars[1].v_type == VAR_STRING) {
+ char *stream = (char *)argvars[1].vval.v_string;
+ if (!strcmp(stream, "stdin")) {
+ job_close_in(job);
+ ((TerminalJobData *)job_data(job))->stdin_closed = true;
+ } else if (!strcmp(stream, "stdout")) {
+ job_close_out(job);
+ } else if (!strcmp(stream, "stderr")) {
+ job_close_err(job);
+ } else {
+ EMSG2(_("Invalid job stream \"%s\""), stream);
+ }
+ } else {
+ ((TerminalJobData *)job_data(job))->stdin_closed = true;
+ job_close_streams(job);
+ }
+}
+
// "jobsend()" function
static void f_jobsend(typval_T *argvars, typval_T *rettv)
{
@@ -10651,12 +10721,17 @@ static void f_jobsend(typval_T *argvars, typval_T *rettv)
Job *job = job_find(argvars[0].vval.v_number);
- if (!job) {
+ if (!is_user_job(job)) {
// Invalid job id
EMSG(_(e_invjob));
return;
}
+ if (((TerminalJobData *)job_data(job))->stdin_closed) {
+ EMSG(_("Can't send data to the job: stdin is closed"));
+ return;
+ }
+
ssize_t input_len;
char *input = (char *) save_tv_as_string(&argvars[1], &input_len, false);
if (!input) {
@@ -10669,7 +10744,7 @@ static void f_jobsend(typval_T *argvars, typval_T *rettv)
rettv->vval.v_number = job_write(job, buf);
}
-// "jobresize()" function
+// "jobresize(job, width, height)" function
static void f_jobresize(typval_T *argvars, typval_T *rettv)
{
rettv->v_type = VAR_NUMBER;
@@ -10688,7 +10763,7 @@ static void f_jobresize(typval_T *argvars, typval_T *rettv)
Job *job = job_find(argvars[0].vval.v_number);
- if (!job) {
+ if (!is_user_job(job)) {
// Probably an invalid job id
EMSG(_(e_invjob));
return;
@@ -10705,11 +10780,6 @@ static void f_jobresize(typval_T *argvars, typval_T *rettv)
// "jobstart()" function
static void f_jobstart(typval_T *argvars, typval_T *rettv)
{
- list_T *args = NULL;
- listitem_T *arg;
- int i, argvl, argsl;
- char **argv = NULL;
-
rettv->v_type = VAR_NUMBER;
rettv->vval.v_number = 0;
@@ -10717,55 +10787,60 @@ static void f_jobstart(typval_T *argvars, typval_T *rettv)
return;
}
- if (argvars[0].v_type != VAR_STRING
- || argvars[1].v_type != VAR_STRING
- || (argvars[2].v_type != VAR_LIST && argvars[2].v_type != VAR_UNKNOWN)) {
+ 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;
}
- argsl = 0;
- if (argvars[2].v_type == VAR_LIST) {
- args = argvars[2].vval.v_list;
- argsl = args->lv_len;
- // Assert that all list items are strings
- for (arg = args->lv_first; arg != NULL; arg = arg->li_next) {
- if (arg->li_tv.v_type != VAR_STRING) {
- 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;
}
}
- if (!os_can_exe(get_tv_string(&argvars[1]), NULL)) {
- // String is not executable
- EMSG2(e_jobexe, get_tv_string(&argvars[1]));
+ int argc = args->lv_len;
+ if (!argc) {
+ EMSG(_("Argument vector must have at least one item"));
return;
}
- // Allocate extra memory for the argument vector and the NULL pointer
- argvl = argsl + 2;
- argv = xmalloc(sizeof(char_u *) * argvl);
-
- // Copy program name
- argv[0] = xstrdup((char *)get_tv_string(&argvars[1]));
+ if (!os_can_exe(args->lv_first->li_tv.vval.v_string, NULL)) {
+ // String is not executable
+ EMSG2(e_jobexe, args->lv_first->li_tv.vval.v_string);
+ return;
+ }
- i = 1;
- // Copy arguments to the vector
- if (argsl > 0) {
- for (arg = args->lv_first; arg != NULL; arg = arg->li_next) {
- argv[i++] = xstrdup((char *)get_tv_string(&arg->li_tv));
+ dict_T *job_opts = NULL;
+ ufunc_T *on_stdout = NULL, *on_stderr = NULL, *on_exit = NULL;
+ if (argvars[1].v_type == VAR_DICT) {
+ job_opts = argvars[1].vval.v_dict;
+ common_job_callbacks(job_opts, &on_stdout, &on_stderr, &on_exit);
+ if (did_emsg) {
+ return;
}
}
- // The last item of argv must be NULL
- argv[i] = NULL;
- JobOptions opts = common_job_options(argv, (char *)argvars[0].vval.v_string);
+ // 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 *)arg->li_tv.vval.v_string);
+ }
+
+ JobOptions opts = common_job_options(argv, on_stdout, on_stderr, on_exit,
+ job_opts);
+
+ if (!job_opts) {
+ goto start;
+ }
- if (args && argvars[3].v_type == VAR_DICT) {
- dict_T *job_opts = argvars[3].vval.v_dict;
- opts.pty = true;
+ opts.pty = get_dict_number(job_opts, (uint8_t *)"pty");
+ if (opts.pty) {
uint16_t width = get_dict_number(job_opts, (uint8_t *)"width");
if (width > 0) {
opts.width = width;
@@ -10780,6 +10855,13 @@ static void f_jobstart(typval_T *argvars, typval_T *rettv)
}
}
+start:
+ if (!on_stdout) {
+ opts.stdout_cb = NULL;
+ }
+ if (!on_stderr) {
+ opts.stderr_cb = NULL;
+ }
common_job_start(opts, rettv);
}
@@ -10801,8 +10883,7 @@ static void f_jobstop(typval_T *argvars, typval_T *rettv)
Job *job = job_find(argvars[0].vval.v_number);
- if (!job) {
- // Probably an invalid job id
+ if (!is_user_job(job)) {
EMSG(_(e_invjob));
return;
}
@@ -10811,6 +10892,105 @@ static void f_jobstop(typval_T *argvars, typval_T *rettv)
rettv->vval.v_number = 1;
}
+// "jobwait(ids[, timeout])" function
+static void f_jobwait(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_NUMBER
+ && argvars[1].v_type != VAR_UNKNOWN)) {
+ EMSG(_(e_invarg));
+ return;
+ }
+
+ list_T *args = argvars[0].vval.v_list;
+ list_T *rv = list_alloc();
+
+ // must temporarily disable job event deferring so the callbacks are
+ // processed while waiting.
+ defer_job_callbacks = false;
+ // For each item in the input list append an integer to the output list. -3
+ // is used to represent an invalid job id, -2 is for a interrupted job and
+ // -1 for jobs that were skipped or timed out.
+ for (listitem_T *arg = args->lv_first; arg != NULL; arg = arg->li_next) {
+ Job *job = NULL;
+ if (arg->li_tv.v_type != VAR_NUMBER
+ || !(job = job_find(arg->li_tv.vval.v_number))
+ || !is_user_job(job)) {
+ list_append_number(rv, -3);
+ } else {
+ TerminalJobData *data = job_data(job);
+ // append the list item and set the status pointer so we'll collect the
+ // status code when the job exits
+ list_append_number(rv, -1);
+ data->status_ptr = &rv->lv_last->li_tv.vval.v_number;
+ }
+ }
+
+ int remaining = -1;
+ uint64_t before = 0;
+ if (argvars[1].v_type == VAR_NUMBER && argvars[1].vval.v_number >= 0) {
+ remaining = argvars[1].vval.v_number;
+ before = os_hrtime();
+ }
+
+ for (listitem_T *arg = args->lv_first; arg != NULL; arg = arg->li_next) {
+ Job *job = NULL;
+ if (remaining == 0) {
+ // timed out
+ break;
+ }
+ if (arg->li_tv.v_type != VAR_NUMBER
+ || !(job = job_find(arg->li_tv.vval.v_number))
+ || !is_user_job(job)) {
+ continue;
+ }
+ TerminalJobData *data = job_data(job);
+ int status = job_wait(job, remaining);
+ if (status < 0) {
+ // interrupted or timed out, skip remaining jobs.
+ if (status == -2) {
+ // set the status so the user can distinguish between interrupted and
+ // skipped/timeout jobs.
+ *data->status_ptr = -2;
+ }
+ break;
+ }
+ if (remaining > 0) {
+ uint64_t now = os_hrtime();
+ remaining -= (int) ((now - before) / 1000000);
+ before = now;
+ if (remaining <= 0) {
+ break;
+ }
+ }
+ }
+
+ for (listitem_T *arg = args->lv_first; arg != NULL; arg = arg->li_next) {
+ Job *job = NULL;
+ if (arg->li_tv.v_type != VAR_NUMBER
+ || !(job = job_find(arg->li_tv.vval.v_number))
+ || !is_user_job(job)) {
+ continue;
+ }
+ TerminalJobData *data = job_data(job);
+ // remove the status pointer because the list may be freed before the
+ // job exits
+ data->status_ptr = NULL;
+ }
+ // restore defer flag
+ defer_job_callbacks = true;
+
+ rv->lv_refcount++;
+ rettv->v_type = VAR_LIST;
+ rettv->vval.v_list = rv;
+}
+
/*
* "join()" function
*/
@@ -14881,15 +15061,25 @@ static void f_termopen(typval_T *argvars, typval_T *rettv)
}
if (argvars[0].v_type != VAR_STRING
- || (argvars[1].v_type != VAR_STRING
- && argvars[1].v_type != VAR_UNKNOWN)) {
+ || (argvars[1].v_type != VAR_DICT && argvars[1].v_type != VAR_UNKNOWN)) {
// Wrong argument types
EMSG(_(e_invarg));
return;
}
+ ufunc_T *on_stdout = NULL, *on_stderr = NULL, *on_exit = NULL;
+ dict_T *job_opts = NULL;
+ if (argvars[1].v_type == VAR_DICT) {
+ job_opts = argvars[1].vval.v_dict;
+ common_job_callbacks(job_opts, &on_stdout, &on_stderr, &on_exit);
+ if (did_emsg) {
+ return;
+ }
+ }
+
char **argv = shell_build_argv((char *)argvars[0].vval.v_string, NULL);
- JobOptions opts = common_job_options(argv, NULL);
+ JobOptions opts = common_job_options(argv, on_stdout, on_stderr, on_exit,
+ job_opts);
opts.pty = true;
opts.width = curwin->w_width;
opts.height = curwin->w_height;
@@ -14921,7 +15111,6 @@ static void f_termopen(typval_T *argvars, typval_T *rettv)
// the 'swapfile' option to ensure no swap file will be created
curbuf->b_p_swf = false;
(void)setfname(curbuf, (uint8_t *)buf, NULL, true);
- data->autocmd_file = xstrdup(buf);
// Save the job id and pid in b:terminal_job_{id,pid}
Error err;
dict_set_value(curbuf->b_vars, cstr_as_string("terminal_job_id"),
@@ -17836,7 +18025,6 @@ void ex_function(exarg_T *eap)
fudi.fd_di->di_tv.v_type = VAR_FUNC;
fudi.fd_di->di_tv.v_lock = 0;
fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
- fp->uf_refcount = 1;
/* behave like "dict" was used */
flags |= FC_DICT;
@@ -17846,6 +18034,7 @@ void ex_function(exarg_T *eap)
STRCPY(fp->uf_name, name);
hash_add(&func_hashtab, UF2HIKEY(fp));
}
+ fp->uf_refcount = 1;
fp->uf_args = newargs;
fp->uf_lines = newlines;
fp->uf_tml_count = NULL;
@@ -18519,6 +18708,11 @@ void ex_delfunction(exarg_T *eap)
EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
return;
}
+ if (fp->uf_refcount > 1) {
+ EMSG2(_("Cannot delete function %s: It is being used internally"),
+ eap->arg);
+ return;
+ }
if (fudi.fd_dict != NULL) {
/* Delete the dict item that refers to the function, it will
@@ -18563,13 +18757,21 @@ void func_unref(char_u *name)
if (name != NULL && isdigit(*name)) {
fp = find_func(name);
- if (fp == NULL)
+ if (fp == NULL) {
EMSG2(_(e_intern2), "func_unref()");
- else if (--fp->uf_refcount <= 0) {
- /* Only delete it when it's not being used. Otherwise it's done
- * when "uf_calls" becomes zero. */
- if (fp->uf_calls == 0)
- func_free(fp);
+ } else {
+ user_func_unref(fp);
+ }
+ }
+}
+
+static void user_func_unref(ufunc_T *fp)
+{
+ if (--fp->uf_refcount <= 0) {
+ // Only delete it when it's not being used. Otherwise it's done
+ // when "uf_calls" becomes zero.
+ if (fp->uf_calls == 0) {
+ func_free(fp);
}
}
}
@@ -18626,9 +18828,13 @@ call_user_func (
return;
}
++depth;
-
- line_breakcheck(); /* check for CTRL-C hit */
-
+ // Save search patterns and redo buffer.
+ save_search_patterns();
+ saveRedobuff();
+ ++fp->uf_calls;
+ // check for CTRL-C hit
+ line_breakcheck();
+ // prepare the funccall_T structure
fc = xmalloc(sizeof(funccall_T));
fc->caller = current_funccal;
current_funccal = fc;
@@ -18924,6 +19130,14 @@ call_user_func (
for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
copy_tv(&li->li_tv, &li->li_tv);
}
+
+ if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name) && fp->uf_refcount <= 0) {
+ // Function was unreferenced while being used, free it now.
+ func_free(fp);
+ }
+ // restore search patterns and redo buffer
+ restoreRedobuff();
+ restore_search_patterns();
}
/*
@@ -19814,12 +20028,14 @@ char_u *do_string_sub(char_u *str, char_u *pat, char_u *sub, char_u *flags)
return ret;
}
-static inline JobOptions common_job_options(char **argv, char *autocmd_file)
+static inline JobOptions common_job_options(char **argv, ufunc_T *on_stdout,
+ ufunc_T *on_stderr, ufunc_T *on_exit, dict_T *self)
{
TerminalJobData *data = xcalloc(1, sizeof(TerminalJobData));
- if (autocmd_file) {
- data->autocmd_file = xstrdup(autocmd_file);
- }
+ data->on_stdout = on_stdout;
+ data->on_stderr = on_stderr;
+ data->on_exit = on_exit;
+ data->self = self;
JobOptions opts = JOB_OPTIONS_INIT;
opts.argv = argv;
opts.data = data;
@@ -19829,6 +20045,28 @@ static inline JobOptions common_job_options(char **argv, char *autocmd_file)
return opts;
}
+static inline void common_job_callbacks(dict_T *vopts, ufunc_T **on_stdout,
+ ufunc_T **on_stderr, ufunc_T **on_exit)
+{
+ *on_stdout = get_dict_callback(vopts, "on_stdout");
+ *on_stderr = get_dict_callback(vopts, "on_stderr");
+ *on_exit = get_dict_callback(vopts, "on_exit");
+ if (did_emsg) {
+ if (*on_stdout) {
+ user_func_unref(*on_stdout);
+ }
+ if (*on_stderr) {
+ user_func_unref(*on_stderr);
+ }
+ if (*on_exit) {
+ user_func_unref(*on_exit);
+ }
+ return;
+ }
+
+ vopts->dv_refcount++;
+}
+
static inline Job *common_job_start(JobOptions opts, typval_T *rettv)
{
TerminalJobData *data = opts.data;
@@ -19839,8 +20077,7 @@ static inline Job *common_job_start(JobOptions opts, typval_T *rettv)
if (rettv->vval.v_number == 0) {
EMSG(_(e_jobtblfull));
free(opts.term_name);
- free(data->autocmd_file);
- free(data);
+ free_term_job_data(data);
} else {
EMSG(_(e_jobexe));
}
@@ -19850,10 +20087,33 @@ static inline Job *common_job_start(JobOptions opts, typval_T *rettv)
return job;
}
-// JobActivity autocommands will execute vimscript code, so it must be executed
-// on Nvim main loop
-static inline void push_job_event(Job *job, char *type, char *data,
- size_t count)
+static inline void free_term_job_data(TerminalJobData *data) {
+ if (data->on_stdout) {
+ user_func_unref(data->on_stdout);
+ }
+ if (data->on_stderr) {
+ user_func_unref(data->on_stderr);
+ }
+ if (data->on_exit) {
+ user_func_unref(data->on_exit);
+ }
+ dict_unref(data->self);
+ free(data);
+}
+
+static inline bool is_user_job(Job *job)
+{
+ if (!job) {
+ return false;
+ }
+
+ JobOptions *opts = job_opts(job);
+ return opts->exit_cb == on_job_exit;
+}
+
+// vimscript job callbacks must be executed on Nvim main loop
+static inline void push_job_event(Job *job, ufunc_T *callback,
+ const char *type, char *data, size_t count, int status)
{
JobEvent *event_data = kmp_alloc(JobEventPool, job_event_pool);
event_data->received = NULL;
@@ -19880,28 +20140,33 @@ static inline void push_job_event(Job *job, char *type, char *data,
off++;
}
list_append_string(event_data->received, (uint8_t *)ptr, off);
+ } else {
+ event_data->status = status;
}
- TerminalJobData *d = job_data(job);
- event_data->id = job_id(job);
- event_data->name = d->autocmd_file;
+ event_data->job_id = job_id(job);
+ event_data->data = job_data(job);
+ event_data->callback = callback;
event_data->type = type;
event_push((Event) {
.handler = on_job_event,
.data = event_data
- }, true);
+ }, defer_job_callbacks);
}
-static void on_job_stdout(RStream *rstream, void *data, bool eof)
+static void on_job_stdout(RStream *rstream, void *job, bool eof)
{
- on_job_output(rstream, data, eof, "stdout");
+ TerminalJobData *data = job_data(job);
+ on_job_output(rstream, job, eof, data->on_stdout, "stdout");
}
-static void on_job_stderr(RStream *rstream, void *data, bool eof)
+static void on_job_stderr(RStream *rstream, void *job, bool eof)
{
- on_job_output(rstream, data, eof, "stderr");
+ TerminalJobData *data = job_data(job);
+ on_job_output(rstream, job, eof, data->on_stderr, "stderr");
}
-static void on_job_output(RStream *rstream, Job *job, bool eof, char *type)
+static void on_job_output(RStream *rstream, Job *job, bool eof,
+ ufunc_T *callback, const char *type)
{
if (eof) {
return;
@@ -19917,21 +20182,28 @@ static void on_job_output(RStream *rstream, Job *job, bool eof, char *type)
terminal_receive(data->term, ptr, len);
}
- push_job_event(job, type, ptr, len);
+ if (callback) {
+ push_job_event(job, callback, type, ptr, len, 0);
+ }
+
rbuffer_consumed(rstream_buffer(rstream), len);
}
-static void on_job_exit(Job *job, void *d)
+static void on_job_exit(Job *job, int status, void *d)
{
TerminalJobData *data = d;
- push_job_event(job, "exit", NULL, 0);
if (data->term && !data->exited) {
data->exited = true;
terminal_close(data->term,
_("\r\n[Program exited, press any key to close]"));
}
- term_job_data_decref(data);
+
+ if (data->status_ptr) {
+ *data->status_ptr = status;
+ }
+
+ push_job_event(job, data->on_exit, "exit", NULL, 0, status);
}
static void term_write(char *buf, size_t size, void *data)
@@ -19960,42 +20232,57 @@ static void term_close(void *d)
static void term_job_data_decref(TerminalJobData *data)
{
if (!(--data->refcount)) {
- free(data);
+ free_term_job_data(data);
}
}
static void on_job_event(Event event)
{
- JobEvent *data = event.data;
- apply_job_autocmds(data->id, data->name, data->type, data->received);
- kmp_free(JobEventPool, job_event_pool, data);
-}
+ JobEvent *ev = event.data;
-static void apply_job_autocmds(int id, char *name, char *type,
- list_T *received)
-{
- // Create the list which will be set to v:job_data
- list_T *list = list_alloc();
- list_append_number(list, id);
- list_append_string(list, (uint8_t *)type, -1);
+ if (!ev->callback) {
+ goto end;
+ }
- if (received) {
- listitem_T *str_slot = listitem_alloc();
- str_slot->li_tv.v_type = VAR_LIST;
- str_slot->li_tv.v_lock = 0;
- str_slot->li_tv.vval.v_list = received;
- str_slot->li_tv.vval.v_list->lv_refcount++;
- list_append(list, str_slot);
+ typval_T argv[3];
+ int argc = ev->callback->uf_args.ga_len;
+
+ if (argc > 0) {
+ argv[0].v_type = VAR_NUMBER;
+ argv[0].v_lock = 0;
+ argv[0].vval.v_number = ev->job_id;
}
- // Update v:job_data for the autocommands
- set_vim_var_list(VV_JOB_DATA, list);
- // Call JobActivity autocommands
- apply_autocmds(EVENT_JOBACTIVITY, (uint8_t *)name, NULL, TRUE, NULL);
+ if (argc > 1) {
+ if (ev->received) {
+ argv[1].v_type = VAR_LIST;
+ argv[1].v_lock = 0;
+ argv[1].vval.v_list = ev->received;
+ argv[1].vval.v_list->lv_refcount++;
+ } else {
+ argv[1].v_type = VAR_NUMBER;
+ argv[1].v_lock = 0;
+ argv[1].vval.v_number = ev->status;
+ }
+ }
- if (!received) {
- // This must be the exit event. Free the name.
- free(name);
+ if (argc > 2) {
+ argv[2].v_type = VAR_STRING;
+ argv[2].v_lock = 0;
+ argv[2].vval.v_string = (uint8_t *)ev->type;
+ }
+
+ typval_T rettv;
+ init_tv(&rettv);
+ call_user_func(ev->callback, argc, argv, &rettv, curwin->w_cursor.lnum,
+ curwin->w_cursor.lnum, ev->data->self);
+ clear_tv(&rettv);
+
+end:
+ kmp_free(JobEventPool, job_event_pool, ev);
+ if (!ev->received) {
+ // exit event, safe to free job data now
+ term_job_data_decref(ev->data);
}
}
diff --git a/src/nvim/eval.h b/src/nvim/eval.h
index e96106dfb3..61a65df7c6 100644
--- a/src/nvim/eval.h
+++ b/src/nvim/eval.h
@@ -63,7 +63,6 @@ enum {
VV_OLDFILES,
VV_WINDOWID,
VV_PROGPATH,
- VV_JOB_DATA,
VV_COMMAND_OUTPUT,
VV_LEN, /* number of v: vars */
};
diff --git a/src/nvim/fileio.c b/src/nvim/fileio.c
index 29bcaec84a..80f843048a 100644
--- a/src/nvim/fileio.c
+++ b/src/nvim/fileio.c
@@ -5187,7 +5187,6 @@ static struct event_name {
{"InsertEnter", EVENT_INSERTENTER},
{"InsertLeave", EVENT_INSERTLEAVE},
{"InsertCharPre", EVENT_INSERTCHARPRE},
- {"JobActivity", EVENT_JOBACTIVITY},
{"MenuPopup", EVENT_MENUPOPUP},
{"QuickFixCmdPost", EVENT_QUICKFIXCMDPOST},
{"QuickFixCmdPre", EVENT_QUICKFIXCMDPRE},
@@ -6595,7 +6594,6 @@ apply_autocmds_group (
|| event == EVENT_QUICKFIXCMDPRE
|| event == EVENT_COLORSCHEME
|| event == EVENT_QUICKFIXCMDPOST
- || event == EVENT_JOBACTIVITY
|| event == EVENT_TABCLOSED)
fname = vim_strsave(fname);
else
diff --git a/src/nvim/fileio.h b/src/nvim/fileio.h
index 833a4fade6..3b37d359d7 100644
--- a/src/nvim/fileio.h
+++ b/src/nvim/fileio.h
@@ -63,7 +63,6 @@ typedef enum auto_event {
EVENT_INSERTCHANGE, /* when changing Insert/Replace mode */
EVENT_INSERTENTER, /* when entering Insert mode */
EVENT_INSERTLEAVE, /* when leaving Insert mode */
- EVENT_JOBACTIVITY, /* when job sent some data */
EVENT_MENUPOPUP, /* just before popup menu is displayed */
EVENT_QUICKFIXCMDPOST, /* after :make, :grep etc. */
EVENT_QUICKFIXCMDPRE, /* before :make, :grep etc. */
diff --git a/src/nvim/main.c b/src/nvim/main.c
index 47bb2bc515..55935564b8 100644
--- a/src/nvim/main.c
+++ b/src/nvim/main.c
@@ -293,8 +293,8 @@ int main(int argc, char **argv)
"matchstr(expand(\"<amatch>\"), "
"'\\c\\mterm://\\%(.\\{-}//\\%(\\d\\+:\\)\\?\\)\\?\\zs.*'), "
// capture the working directory
- "get(matchlist(expand(\"<amatch>\"), "
- "'\\c\\mterm://\\(.\\{-}\\)//'), 1, ''))");
+ "{'cwd': get(matchlist(expand(\"<amatch>\"), "
+ "'\\c\\mterm://\\(.\\{-}\\)//'), 1, '')})");
/* Execute --cmd arguments. */
exe_pre_commands(&params);
diff --git a/src/nvim/msgpack_rpc/channel.c b/src/nvim/msgpack_rpc/channel.c
index e8dab05ba0..b1f0798528 100644
--- a/src/nvim/msgpack_rpc/channel.c
+++ b/src/nvim/msgpack_rpc/channel.c
@@ -347,7 +347,7 @@ static void job_err(RStream *rstream, void *data, bool eof)
}
}
-static void job_exit(Job *job, void *data)
+static void job_exit(Job *job, int status, void *data)
{
decref(data);
}
diff --git a/src/nvim/os/job.c b/src/nvim/os/job.c
index ccd7891601..8fe44c7a53 100644
--- a/src/nvim/os/job.c
+++ b/src/nvim/os/job.c
@@ -24,7 +24,6 @@
// before we send SIGNAL to it
#define TERM_TIMEOUT 1000000000
#define KILL_TIMEOUT (TERM_TIMEOUT * 2)
-#define MAX_RUNNING_JOBS 100
#define JOB_BUFFER_SIZE 0xFFFF
#define close_job_stream(job, stream, type) \
@@ -234,11 +233,12 @@ void job_stop(Job *job)
/// @return returns the status code of the exited job. -1 if the job is
/// still running and the `timeout` has expired. Note that this is
/// indistinguishable from the process returning -1 by itself. Which
-/// is possible on some OS.
+/// is possible on some OS. Returns -2 if the job was interrupted.
int job_wait(Job *job, int ms) FUNC_ATTR_NONNULL_ALL
{
// The default status is -1, which represents a timeout
int status = -1;
+ bool interrupted = false;
// Increase refcount to stop the job from being freed before we have a
// chance to get the status.
@@ -251,6 +251,7 @@ int job_wait(Job *job, int ms) FUNC_ATTR_NONNULL_ALL
// we'll assume that a user frantically hitting interrupt doesn't like
// the current job. Signal that it has to be killed.
if (got_int) {
+ interrupted = true;
got_int = false;
job_stop(job);
if (ms == -1) {
@@ -265,7 +266,7 @@ int job_wait(Job *job, int ms) FUNC_ATTR_NONNULL_ALL
if (job->refcount == 1) {
// Job exited, collect status and manually invoke close_cb to free the job
// resources
- status = job->status;
+ status = interrupted ? -2 : job->status;
job_close_streams(job);
job_decref(job);
} else {
@@ -289,6 +290,18 @@ void job_close_in(Job *job) FUNC_ATTR_NONNULL_ALL
close_job_in(job);
}
+// Close the job stdout stream.
+void job_close_out(Job *job) FUNC_ATTR_NONNULL_ALL
+{
+ close_job_out(job);
+}
+
+// Close the job stderr stream.
+void job_close_err(Job *job) FUNC_ATTR_NONNULL_ALL
+{
+ close_job_out(job);
+}
+
/// All writes that complete after calling this function will be reported
/// to `cb`.
///
@@ -357,6 +370,11 @@ void job_close_streams(Job *job)
close_job_err(job);
}
+JobOptions *job_opts(Job *job)
+{
+ return &job->opts;
+}
+
/// Iterates the table, sending SIGTERM to stopped jobs and SIGKILL to those
/// that didn't die from SIGTERM after a while(exit_timeout is 0).
static void job_stop_timer_cb(uv_timer_t *handle)
diff --git a/src/nvim/os/job_defs.h b/src/nvim/os/job_defs.h
index ac9a37b366..7fee900ac0 100644
--- a/src/nvim/os/job_defs.h
+++ b/src/nvim/os/job_defs.h
@@ -5,13 +5,14 @@
#include "nvim/os/rstream_defs.h"
#include "nvim/os/wstream_defs.h"
+#define MAX_RUNNING_JOBS 100
typedef struct job Job;
/// Function called when the job reads data
///
/// @param id The job id
/// @param data Some data associated with the job by the caller
-typedef void (*job_exit_cb)(Job *job, void *data);
+typedef void (*job_exit_cb)(Job *job, int status, void *data);
// Job startup options
// job_exit_cb Callback that will be invoked when the job exits
diff --git a/src/nvim/os/job_private.h b/src/nvim/os/job_private.h
index b1d5e13feb..af13d2e636 100644
--- a/src/nvim/os/job_private.h
+++ b/src/nvim/os/job_private.h
@@ -88,7 +88,7 @@ static inline void job_exit_callback(Job *job)
if (job->opts.exit_cb) {
// Invoke the exit callback
- job->opts.exit_cb(job, job->opts.data);
+ job->opts.exit_cb(job, job->status, job->opts.data);
}
if (stop_requests && !--stop_requests) {