nyx/vim
1
0
Fork 0
mirror of https://github.com/vim/vim synced 2025-03-15 22:37:52 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
vim/src/job.c
Kenta Sato c28e7a2b2f patch 9.0.1527: crash when using negative value for term_cols 
Problem:    Crash when using negative value for term_cols.
Solution:   Check for invalid term_cols value. (Kenta Sato, closes #12362)
2023-05-08 18:26:03 +01:00

2037 lines
46 KiB
C
Raw Permalink Blame History

/* vi:set ts=8 sts=4 sw=4 noet:
*
* VIM - Vi IMproved by Bram Moolenaar
*
* Do ":help uganda" in Vim to read copying and usage conditions.
* Do ":help credits" in Vim to see a list of people who contributed.
*/
/*
* Implements starting jobs and controlling them.
*/
#include "vim.h"
#if defined(FEAT_JOB_CHANNEL) || defined(PROTO)
#define FOR_ALL_JOBS(job) \
for ((job) = first_job; (job) != NULL; (job) = (job)->jv_next)
static int
handle_mode(typval_T *item, jobopt_T *opt, ch_mode_T *modep, int jo)
{
char_u *val = tv_get_string(item);
opt->jo_set |= jo;
if (STRCMP(val, "nl") == 0)
*modep = CH_MODE_NL;
else if (STRCMP(val, "raw") == 0)
*modep = CH_MODE_RAW;
else if (STRCMP(val, "js") == 0)
*modep = CH_MODE_JS;
else if (STRCMP(val, "json") == 0)
*modep = CH_MODE_JSON;
else if (STRCMP(val, "lsp") == 0)
*modep = CH_MODE_LSP;
else
{
semsg(_(e_invalid_argument_str), val);
return FAIL;
}
return OK;
}
static int
handle_io(typval_T *item, ch_part_T part, jobopt_T *opt)
{
char_u *val = tv_get_string(item);
opt->jo_set |= JO_OUT_IO << (part - PART_OUT);
if (STRCMP(val, "null") == 0)
opt->jo_io[part] = JIO_NULL;
else if (STRCMP(val, "pipe") == 0)
opt->jo_io[part] = JIO_PIPE;
else if (STRCMP(val, "file") == 0)
opt->jo_io[part] = JIO_FILE;
else if (STRCMP(val, "buffer") == 0)
opt->jo_io[part] = JIO_BUFFER;
else if (STRCMP(val, "out") == 0 && part == PART_ERR)
opt->jo_io[part] = JIO_OUT;
else
{
semsg(_(e_invalid_argument_str), val);
return FAIL;
}
return OK;
}
/*
* Clear a jobopt_T before using it.
*/
void
clear_job_options(jobopt_T *opt)
{
CLEAR_POINTER(opt);
}
static void
unref_job_callback(callback_T *cb)
{
if (cb->cb_partial != NULL)
partial_unref(cb->cb_partial);
else if (cb->cb_name != NULL)
{
func_unref(cb->cb_name);
if (cb->cb_free_name)
vim_free(cb->cb_name);
}
}
/*
* Free any members of a jobopt_T.
*/
void
free_job_options(jobopt_T *opt)
{
unref_job_callback(&opt->jo_callback);
unref_job_callback(&opt->jo_out_cb);
unref_job_callback(&opt->jo_err_cb);
unref_job_callback(&opt->jo_close_cb);
unref_job_callback(&opt->jo_exit_cb);
if (opt->jo_env != NULL)
dict_unref(opt->jo_env);
}
/*
* Get the PART_ number from the first character of an option name.
*/
static int
part_from_char(int c)
{
return c == 'i' ? PART_IN : c == 'o' ? PART_OUT: PART_ERR;
}
/*
* Get the option entries from the dict in "tv", parse them and put the result
* in "opt".
* Only accept JO_ options in "supported" and JO2_ options in "supported2".
* If an option value is invalid return FAIL.
*/
int
get_job_options(typval_T *tv, jobopt_T *opt, int supported, int supported2)
{
typval_T *item;
char_u *val;
dict_T *dict;
int todo;
hashitem_T *hi;
ch_part_T part;
if (tv->v_type == VAR_UNKNOWN)
return OK;
if (tv->v_type != VAR_DICT)
{
emsg(_(e_dictionary_required));
return FAIL;
}
dict = tv->vval.v_dict;
if (dict == NULL)
return OK;
todo = (int)dict->dv_hashtab.ht_used;
FOR_ALL_HASHTAB_ITEMS(&dict->dv_hashtab, hi, todo)
if (!HASHITEM_EMPTY(hi))
{
item = &dict_lookup(hi)->di_tv;
if (STRCMP(hi->hi_key, "mode") == 0)
{
if (!(supported & JO_MODE))
break;
if (handle_mode(item, opt, &opt->jo_mode, JO_MODE) == FAIL)
return FAIL;
}
else if (STRCMP(hi->hi_key, "in_mode") == 0)
{
if (!(supported & JO_IN_MODE))
break;
if (handle_mode(item, opt, &opt->jo_in_mode, JO_IN_MODE)
== FAIL)
return FAIL;
}
else if (STRCMP(hi->hi_key, "out_mode") == 0)
{
if (!(supported & JO_OUT_MODE))
break;
if (handle_mode(item, opt, &opt->jo_out_mode, JO_OUT_MODE)
== FAIL)
return FAIL;
}
else if (STRCMP(hi->hi_key, "err_mode") == 0)
{
if (!(supported & JO_ERR_MODE))
break;
if (handle_mode(item, opt, &opt->jo_err_mode, JO_ERR_MODE)
== FAIL)
return FAIL;
}
else if (STRCMP(hi->hi_key, "noblock") == 0)
{
if (!(supported & JO_MODE))
break;
opt->jo_noblock = tv_get_bool(item);
}
else if (STRCMP(hi->hi_key, "in_io") == 0
|| STRCMP(hi->hi_key, "out_io") == 0
|| STRCMP(hi->hi_key, "err_io") == 0)
{
if (!(supported & JO_OUT_IO))
break;
if (handle_io(item, part_from_char(*hi->hi_key), opt) == FAIL)
return FAIL;
}
else if (STRCMP(hi->hi_key, "in_name") == 0
|| STRCMP(hi->hi_key, "out_name") == 0
|| STRCMP(hi->hi_key, "err_name") == 0)
{
part = part_from_char(*hi->hi_key);
if (!(supported & JO_OUT_IO))
break;
opt->jo_set |= JO_OUT_NAME << (part - PART_OUT);
opt->jo_io_name[part] = tv_get_string_buf_chk(item,
opt->jo_io_name_buf[part]);
}
else if (STRCMP(hi->hi_key, "pty") == 0)
{
if (!(supported & JO_MODE))
break;
opt->jo_pty = tv_get_bool(item);
}
else if (STRCMP(hi->hi_key, "in_buf") == 0
|| STRCMP(hi->hi_key, "out_buf") == 0
|| STRCMP(hi->hi_key, "err_buf") == 0)
{
part = part_from_char(*hi->hi_key);
if (!(supported & JO_OUT_IO))
break;
opt->jo_set |= JO_OUT_BUF << (part - PART_OUT);
opt->jo_io_buf[part] = tv_get_number(item);
if (opt->jo_io_buf[part] <= 0)
{
semsg(_(e_invalid_value_for_argument_str_str),
hi->hi_key, tv_get_string(item));
return FAIL;
}
if (buflist_findnr(opt->jo_io_buf[part]) == NULL)
{
semsg(_(e_buffer_nr_does_not_exist),
(long)opt->jo_io_buf[part]);
return FAIL;
}
}
else if (STRCMP(hi->hi_key, "out_modifiable") == 0
|| STRCMP(hi->hi_key, "err_modifiable") == 0)
{
part = part_from_char(*hi->hi_key);
if (!(supported & JO_OUT_IO))
break;
opt->jo_set |= JO_OUT_MODIFIABLE << (part - PART_OUT);
opt->jo_modifiable[part] = tv_get_bool(item);
}
else if (STRCMP(hi->hi_key, "out_msg") == 0
|| STRCMP(hi->hi_key, "err_msg") == 0)
{
part = part_from_char(*hi->hi_key);
if (!(supported & JO_OUT_IO))
break;
opt->jo_set2 |= JO2_OUT_MSG << (part - PART_OUT);
opt->jo_message[part] = tv_get_bool(item);
}
else if (STRCMP(hi->hi_key, "in_top") == 0
|| STRCMP(hi->hi_key, "in_bot") == 0)
{
linenr_T *lp;
if (!(supported & JO_OUT_IO))
break;
if (hi->hi_key[3] == 't')
{
lp = &opt->jo_in_top;
opt->jo_set |= JO_IN_TOP;
}
else
{
lp = &opt->jo_in_bot;
opt->jo_set |= JO_IN_BOT;
}
*lp = tv_get_number(item);
if (*lp < 0)
{
semsg(_(e_invalid_value_for_argument_str_str),
hi->hi_key, tv_get_string(item));
return FAIL;
}
}
else if (STRCMP(hi->hi_key, "channel") == 0)
{
if (!(supported & JO_OUT_IO))
break;
opt->jo_set |= JO_CHANNEL;
if (item->v_type != VAR_CHANNEL)
{
semsg(_(e_invalid_value_for_argument_str), "channel");
return FAIL;
}
opt->jo_channel = item->vval.v_channel;
}
else if (STRCMP(hi->hi_key, "callback") == 0)
{
if (!(supported & JO_CALLBACK))
break;
opt->jo_set |= JO_CALLBACK;
opt->jo_callback = get_callback(item);
if (opt->jo_callback.cb_name == NULL)
{
semsg(_(e_invalid_value_for_argument_str), "callback");
return FAIL;
}
}
else if (STRCMP(hi->hi_key, "out_cb") == 0)
{
if (!(supported & JO_OUT_CALLBACK))
break;
opt->jo_set |= JO_OUT_CALLBACK;
opt->jo_out_cb = get_callback(item);
if (opt->jo_out_cb.cb_name == NULL)
{
semsg(_(e_invalid_value_for_argument_str), "out_cb");
return FAIL;
}
}
else if (STRCMP(hi->hi_key, "err_cb") == 0)
{
if (!(supported & JO_ERR_CALLBACK))
break;
opt->jo_set |= JO_ERR_CALLBACK;
opt->jo_err_cb = get_callback(item);
if (opt->jo_err_cb.cb_name == NULL)
{
semsg(_(e_invalid_value_for_argument_str), "err_cb");
return FAIL;
}
}
else if (STRCMP(hi->hi_key, "close_cb") == 0)
{
if (!(supported & JO_CLOSE_CALLBACK))
break;
opt->jo_set |= JO_CLOSE_CALLBACK;
opt->jo_close_cb = get_callback(item);
if (opt->jo_close_cb.cb_name == NULL)
{
semsg(_(e_invalid_value_for_argument_str), "close_cb");
return FAIL;
}
}
else if (STRCMP(hi->hi_key, "drop") == 0)
{
int never = FALSE;
val = tv_get_string(item);
if (STRCMP(val, "never") == 0)
never = TRUE;
else if (STRCMP(val, "auto") != 0)
{
semsg(_(e_invalid_value_for_argument_str_str), "drop", val);
return FAIL;
}
opt->jo_drop_never = never;
}
else if (STRCMP(hi->hi_key, "exit_cb") == 0)
{
if (!(supported & JO_EXIT_CB))
break;
opt->jo_set |= JO_EXIT_CB;
opt->jo_exit_cb = get_callback(item);
if (opt->jo_exit_cb.cb_name == NULL)
{
semsg(_(e_invalid_value_for_argument_str), "exit_cb");
return FAIL;
}
}
#ifdef FEAT_TERMINAL
else if (STRCMP(hi->hi_key, "term_name") == 0)
{
if (!(supported2 & JO2_TERM_NAME))
break;
opt->jo_set2 |= JO2_TERM_NAME;
opt->jo_term_name = tv_get_string_buf_chk(item,
opt->jo_term_name_buf);
if (opt->jo_term_name == NULL)
{
semsg(_(e_invalid_value_for_argument_str), "term_name");
return FAIL;
}
}
else if (STRCMP(hi->hi_key, "term_finish") == 0)
{
if (!(supported2 & JO2_TERM_FINISH))
break;
val = tv_get_string(item);
if (STRCMP(val, "open") != 0 && STRCMP(val, "close") != 0)
{
semsg(_(e_invalid_value_for_argument_str_str),
"term_finish", val);
return FAIL;
}
opt->jo_set2 |= JO2_TERM_FINISH;
opt->jo_term_finish = *val;
}
else if (STRCMP(hi->hi_key, "term_opencmd") == 0)
{
char_u *p;
if (!(supported2 & JO2_TERM_OPENCMD))
break;
opt->jo_set2 |= JO2_TERM_OPENCMD;
p = opt->jo_term_opencmd = tv_get_string_buf_chk(item,
opt->jo_term_opencmd_buf);
if (p != NULL)
{
// Must have %d and no other %.
p = vim_strchr(p, '%');
if (p != NULL && (p[1] != 'd'
|| vim_strchr(p + 2, '%') != NULL))
p = NULL;
}
if (p == NULL)
{
semsg(_(e_invalid_value_for_argument_str), "term_opencmd");
return FAIL;
}
}
else if (STRCMP(hi->hi_key, "eof_chars") == 0)
{
if (!(supported2 & JO2_EOF_CHARS))
break;
opt->jo_set2 |= JO2_EOF_CHARS;
opt->jo_eof_chars = tv_get_string_buf_chk(item,
opt->jo_eof_chars_buf);
if (opt->jo_eof_chars == NULL)
{
semsg(_(e_invalid_value_for_argument_str), "eof_chars");
return FAIL;
}
}
else if (STRCMP(hi->hi_key, "term_rows") == 0)
{
int error = FALSE;
if (!(supported2 & JO2_TERM_ROWS))
break;
opt->jo_set2 |= JO2_TERM_ROWS;
opt->jo_term_rows = tv_get_number_chk(item, &error);
if (error)
return FAIL;
if (opt->jo_term_rows < 0 || opt->jo_term_rows > 1000)
{
semsg(_(e_invalid_value_for_argument_str), "term_rows");
return FAIL;
}
}
else if (STRCMP(hi->hi_key, "term_cols") == 0)
{
int error = FALSE;
if (!(supported2 & JO2_TERM_COLS))
break;
opt->jo_set2 |= JO2_TERM_COLS;
opt->jo_term_cols = tv_get_number_chk(item, &error);
if (error)
return FAIL;
if (opt->jo_term_cols < 0 || opt->jo_term_cols > 1000)
{
semsg(_(e_invalid_value_for_argument_str), "term_cols");
return FAIL;
}
}
else if (STRCMP(hi->hi_key, "vertical") == 0)
{
if (!(supported2 & JO2_VERTICAL))
break;
opt->jo_set2 |= JO2_VERTICAL;
opt->jo_vertical = tv_get_bool(item);
}
else if (STRCMP(hi->hi_key, "curwin") == 0)
{
if (!(supported2 & JO2_CURWIN))
break;
opt->jo_set2 |= JO2_CURWIN;
opt->jo_curwin = tv_get_bool(item);
}
else if (STRCMP(hi->hi_key, "bufnr") == 0)
{
int nr;
if (!(supported2 & JO2_CURWIN))
break;
opt->jo_set2 |= JO2_BUFNR;
nr = tv_get_number(item);
if (nr <= 0)
{
semsg(_(e_invalid_value_for_argument_str_str), hi->hi_key, tv_get_string(item));
return FAIL;
}
opt->jo_bufnr_buf = buflist_findnr(nr);
if (opt->jo_bufnr_buf == NULL)
{
semsg(_(e_buffer_nr_does_not_exist), (long)nr);
return FAIL;
}
if (opt->jo_bufnr_buf->b_nwindows == 0
|| opt->jo_bufnr_buf->b_term == NULL)
{
semsg(_(e_invalid_argument_str), "bufnr");
return FAIL;
}
}
else if (STRCMP(hi->hi_key, "hidden") == 0)
{
if (!(supported2 & JO2_HIDDEN))
break;
opt->jo_set2 |= JO2_HIDDEN;
opt->jo_hidden = tv_get_bool(item);
}
else if (STRCMP(hi->hi_key, "norestore") == 0)
{
if (!(supported2 & JO2_NORESTORE))
break;
opt->jo_set2 |= JO2_NORESTORE;
opt->jo_term_norestore = tv_get_bool(item);
}
else if (STRCMP(hi->hi_key, "term_kill") == 0)
{
if (!(supported2 & JO2_TERM_KILL))
break;
opt->jo_set2 |= JO2_TERM_KILL;
opt->jo_term_kill = tv_get_string_buf_chk(item,
opt->jo_term_kill_buf);
if (opt->jo_term_kill == NULL)
{
semsg(_(e_invalid_value_for_argument_str), "term_kill");
return FAIL;
}
}
else if (STRCMP(hi->hi_key, "tty_type") == 0)
{
char_u *p;
if (!(supported2 & JO2_TTY_TYPE))
break;
opt->jo_set2 |= JO2_TTY_TYPE;
p = tv_get_string_chk(item);
if (p == NULL)
{
semsg(_(e_invalid_value_for_argument_str), "tty_type");
return FAIL;
}
// Allow empty string, "winpty", "conpty".
if (!(*p == NUL || STRCMP(p, "winpty") == 0
|| STRCMP(p, "conpty") == 0))
{
semsg(_(e_invalid_value_for_argument_str), "tty_type");
return FAIL;
}
opt->jo_tty_type = p[0];
}
# if defined(FEAT_GUI) || defined(FEAT_TERMGUICOLORS)
else if (STRCMP(hi->hi_key, "ansi_colors") == 0)
{
int n = 0;
listitem_T *li;
long_u rgb[16];
if (!(supported2 & JO2_ANSI_COLORS))
break;
if (item == NULL || item->v_type != VAR_LIST
|| item->vval.v_list == NULL
|| item->vval.v_list->lv_first == &range_list_item)
{
semsg(_(e_invalid_value_for_argument_str), "ansi_colors");
return FAIL;
}
li = item->vval.v_list->lv_first;
for (; li != NULL && n < 16; li = li->li_next, n++)
{
char_u *color_name;
guicolor_T guicolor;
int called_emsg_before = called_emsg;
color_name = tv_get_string_chk(&li->li_tv);
if (color_name == NULL)
return FAIL;
guicolor = GUI_GET_COLOR(color_name);
if (guicolor == INVALCOLOR)
{
if (called_emsg_before == called_emsg)
// may not get the error if the GUI didn't start
semsg(_(e_cannot_allocate_color_str), color_name);
return FAIL;
}
rgb[n] = GUI_MCH_GET_RGB(guicolor);
}
if (n != 16 || li != NULL)
{
semsg(_(e_invalid_value_for_argument_str), "ansi_colors");
return FAIL;
}
opt->jo_set2 |= JO2_ANSI_COLORS;
memcpy(opt->jo_ansi_colors, rgb, sizeof(rgb));
}
# endif
else if (STRCMP(hi->hi_key, "term_highlight") == 0)
{
char_u *p;
if (!(supported2 & JO2_TERM_HIGHLIGHT))
break;
opt->jo_set2 |= JO2_TERM_HIGHLIGHT;
p = tv_get_string_buf_chk(item, opt->jo_term_highlight_buf);
if (p == NULL || *p == NUL)
{
semsg(_(e_invalid_value_for_argument_str), "term_highlight");
return FAIL;
}
opt->jo_term_highlight = p;
}
else if (STRCMP(hi->hi_key, "term_api") == 0)
{
if (!(supported2 & JO2_TERM_API))
break;
opt->jo_set2 |= JO2_TERM_API;
opt->jo_term_api = tv_get_string_buf_chk(item,
opt->jo_term_api_buf);
if (opt->jo_term_api == NULL)
{
semsg(_(e_invalid_value_for_argument_str), "term_api");
return FAIL;
}
}
#endif
else if (STRCMP(hi->hi_key, "env") == 0)
{
if (!(supported2 & JO2_ENV))
break;
if (item->v_type != VAR_DICT)
{
semsg(_(e_invalid_value_for_argument_str), "env");
return FAIL;
}
opt->jo_set2 |= JO2_ENV;
opt->jo_env = item->vval.v_dict;
if (opt->jo_env != NULL)
++opt->jo_env->dv_refcount;
}
else if (STRCMP(hi->hi_key, "cwd") == 0)
{
if (!(supported2 & JO2_CWD))
break;
opt->jo_cwd = tv_get_string_buf_chk(item, opt->jo_cwd_buf);
if (opt->jo_cwd == NULL || !mch_isdir(opt->jo_cwd)
#ifndef MSWIN // Win32 directories don't have the concept of "executable"
|| mch_access((char *)opt->jo_cwd, X_OK) != 0
#endif
)
{
semsg(_(e_invalid_value_for_argument_str), "cwd");
return FAIL;
}
opt->jo_set2 |= JO2_CWD;
}
else if (STRCMP(hi->hi_key, "waittime") == 0)
{
if (!(supported & JO_WAITTIME))
break;
opt->jo_set |= JO_WAITTIME;
opt->jo_waittime = tv_get_number(item);
}
else if (STRCMP(hi->hi_key, "timeout") == 0)
{
if (!(supported & JO_TIMEOUT))
break;
opt->jo_set |= JO_TIMEOUT;
opt->jo_timeout = tv_get_number(item);
}
else if (STRCMP(hi->hi_key, "out_timeout") == 0)
{
if (!(supported & JO_OUT_TIMEOUT))
break;
opt->jo_set |= JO_OUT_TIMEOUT;
opt->jo_out_timeout = tv_get_number(item);
}
else if (STRCMP(hi->hi_key, "err_timeout") == 0)
{
if (!(supported & JO_ERR_TIMEOUT))
break;
opt->jo_set |= JO_ERR_TIMEOUT;
opt->jo_err_timeout = tv_get_number(item);
}
else if (STRCMP(hi->hi_key, "part") == 0)
{
if (!(supported & JO_PART))
break;
opt->jo_set |= JO_PART;
val = tv_get_string(item);
if (STRCMP(val, "err") == 0)
opt->jo_part = PART_ERR;
else if (STRCMP(val, "out") == 0)
opt->jo_part = PART_OUT;
else
{
semsg(_(e_invalid_value_for_argument_str_str), "part", val);
return FAIL;
}
}
else if (STRCMP(hi->hi_key, "id") == 0)
{
if (!(supported & JO_ID))
break;
opt->jo_set |= JO_ID;
opt->jo_id = tv_get_number(item);
}
else if (STRCMP(hi->hi_key, "stoponexit") == 0)
{
if (!(supported & JO_STOPONEXIT))
break;
opt->jo_set |= JO_STOPONEXIT;
opt->jo_stoponexit = tv_get_string_buf_chk(item,
opt->jo_stoponexit_buf);
if (opt->jo_stoponexit == NULL)
{
semsg(_(e_invalid_value_for_argument_str), "stoponexit");
return FAIL;
}
}
else if (STRCMP(hi->hi_key, "block_write") == 0)
{
if (!(supported & JO_BLOCK_WRITE))
break;
opt->jo_set |= JO_BLOCK_WRITE;
opt->jo_block_write = tv_get_number(item);
}
else
break;
--todo;
}
if (todo > 0)
{
semsg(_(e_invalid_argument_str), hi->hi_key);
return FAIL;
}
return OK;
}
static job_T *first_job = NULL;
static void
job_free_contents(job_T *job)
{
int i;
ch_log(job->jv_channel, "Freeing job");
if (job->jv_channel != NULL)
{
// The link from the channel to the job doesn't count as a reference,
// thus don't decrement the refcount of the job. The reference from
// the job to the channel does count the reference, decrement it and
// NULL the reference. We don't set ch_job_killed, unreferencing the
// job doesn't mean it stops running.
job->jv_channel->ch_job = NULL;
channel_unref(job->jv_channel);
}
mch_clear_job(job);
vim_free(job->jv_tty_in);
vim_free(job->jv_tty_out);
vim_free(job->jv_stoponexit);
#ifdef UNIX
vim_free(job->jv_termsig);
#endif
#ifdef MSWIN
vim_free(job->jv_tty_type);
#endif
free_callback(&job->jv_exit_cb);
if (job->jv_argv != NULL)
{
for (i = 0; job->jv_argv[i] != NULL; i++)
vim_free(job->jv_argv[i]);
vim_free(job->jv_argv);
}
}
/*
* Remove "job" from the list of jobs.
*/
static void
job_unlink(job_T *job)
{
if (job->jv_next != NULL)
job->jv_next->jv_prev = job->jv_prev;
if (job->jv_prev == NULL)
first_job = job->jv_next;
else
job->jv_prev->jv_next = job->jv_next;
}
static void
job_free_job(job_T *job)
{
job_unlink(job);
vim_free(job);
}
static void
job_free(job_T *job)
{
if (in_free_unref_items)
return;
job_free_contents(job);
job_free_job(job);
}
static job_T *jobs_to_free = NULL;
/*
* Put "job" in a list to be freed later, when it's no longer referenced.
*/
static void
job_free_later(job_T *job)
{
job_unlink(job);
job->jv_next = jobs_to_free;
jobs_to_free = job;
}
static void
free_jobs_to_free_later(void)
{
job_T *job;
while (jobs_to_free != NULL)
{
job = jobs_to_free;
jobs_to_free = job->jv_next;
job_free_contents(job);
vim_free(job);
}
}
#if defined(EXITFREE) || defined(PROTO)
void
job_free_all(void)
{
while (first_job != NULL)
job_free(first_job);
free_jobs_to_free_later();
# ifdef FEAT_TERMINAL
free_unused_terminals();
# endif
}
#endif
/*
* Return TRUE if we need to check if the process of "job" has ended.
*/
static int
job_need_end_check(job_T *job)
{
return job->jv_status == JOB_STARTED
&& (job->jv_stoponexit != NULL || job->jv_exit_cb.cb_name != NULL);
}
/*
* Return TRUE if the channel of "job" is still useful.
*/
static int
job_channel_still_useful(job_T *job)
{
return job->jv_channel != NULL && channel_still_useful(job->jv_channel);
}
/*
* Return TRUE if the channel of "job" is closeable.
*/
static int
job_channel_can_close(job_T *job)
{
return job->jv_channel != NULL && channel_can_close(job->jv_channel);
}
/*
* Return TRUE if the job should not be freed yet. Do not free the job when
* it has not ended yet and there is a "stoponexit" flag, an exit callback
* or when the associated channel will do something with the job output.
*/
static int
job_still_useful(job_T *job)
{
return job_need_end_check(job) || job_channel_still_useful(job);
}
#if defined(GUI_MAY_FORK) || defined(GUI_MAY_SPAWN) || defined(PROTO)
/*
* Return TRUE when there is any running job that we care about.
*/
int
job_any_running(void)
{
job_T *job;
FOR_ALL_JOBS(job)
if (job_still_useful(job))
{
ch_log(NULL, "GUI not forking because a job is running");
return TRUE;
}
return FALSE;
}
#endif
// Unix uses argv[] for the command, other systems use a string.
#if defined(UNIX)
# define USE_ARGV
#endif
#if !defined(USE_ARGV) || defined(PROTO)
/*
* Escape one argument for an external command.
* Returns the escaped string in allocated memory. NULL when out of memory.
*/
static char_u *
win32_escape_arg(char_u *arg)
{
int slen, dlen;
int escaping = 0;
int i;
char_u *s, *d;
char_u *escaped_arg;
int has_spaces = FALSE;
// First count the number of extra bytes required.
slen = (int)STRLEN(arg);
dlen = slen;
for (s = arg; *s != NUL; MB_PTR_ADV(s))
{
if (*s == '"' || *s == '\\')
++dlen;
if (*s == ' ' || *s == '\t')
has_spaces = TRUE;
}
if (has_spaces)
dlen += 2;
if (dlen == slen)
return vim_strsave(arg);
// Allocate memory for the result and fill it.
escaped_arg = alloc(dlen + 1);
if (escaped_arg == NULL)
return NULL;
memset(escaped_arg, 0, dlen+1);
d = escaped_arg;
if (has_spaces)
*d++ = '"';
for (s = arg; *s != NUL;)
{
switch (*s)
{
case '"':
for (i = 0; i < escaping; i++)
*d++ = '\\';
escaping = 0;
*d++ = '\\';
*d++ = *s++;
break;
case '\\':
escaping++;
*d++ = *s++;
break;
default:
escaping = 0;
MB_COPY_CHAR(s, d);
break;
}
}
// add terminating quote and finish with a NUL
if (has_spaces)
{
for (i = 0; i < escaping; i++)
*d++ = '\\';
*d++ = '"';
}
*d = NUL;
return escaped_arg;
}
/*
* Build a command line from a list, taking care of escaping.
* The result is put in gap->ga_data.
* Returns FAIL when out of memory.
*/
int
win32_build_cmd(list_T *l, garray_T *gap)
{
listitem_T *li;
char_u *s;
CHECK_LIST_MATERIALIZE(l);
FOR_ALL_LIST_ITEMS(l, li)
{
s = tv_get_string_chk(&li->li_tv);
if (s == NULL)
return FAIL;
s = win32_escape_arg(s);
if (s == NULL)
return FAIL;
ga_concat(gap, s);
vim_free(s);
if (li->li_next != NULL)
ga_append(gap, ' ');
}
return OK;
}
#endif
/*
* NOTE: Must call job_cleanup() only once right after the status of "job"
* changed to JOB_ENDED (i.e. after job_status() returned "dead" first or
* mch_detect_ended_job() returned non-NULL).
* If the job is no longer used it will be removed from the list of jobs, and
* deleted a bit later.
*/
void
job_cleanup(job_T *job)
{
if (job->jv_status != JOB_ENDED)
return;
// Ready to cleanup the job.
job->jv_status = JOB_FINISHED;
// When only channel-in is kept open, close explicitly.
if (job->jv_channel != NULL)
ch_close_part(job->jv_channel, PART_IN);
if (job->jv_exit_cb.cb_name != NULL)
{
typval_T argv[3];
typval_T rettv;
// Invoke the exit callback. Make sure the refcount is > 0.
ch_log(job->jv_channel, "Invoking exit callback %s",
job->jv_exit_cb.cb_name);
++job->jv_refcount;
argv[0].v_type = VAR_JOB;
argv[0].vval.v_job = job;
argv[1].v_type = VAR_NUMBER;
argv[1].vval.v_number = job->jv_exitval;
call_callback(&job->jv_exit_cb, -1, &rettv, 2, argv);
clear_tv(&rettv);
--job->jv_refcount;
channel_need_redraw = TRUE;
}
if (job->jv_channel != NULL && job->jv_channel->ch_anonymous_pipe)
job->jv_channel->ch_killing = TRUE;
// Do not free the job in case the close callback of the associated channel
// isn't invoked yet and may get information by job_info().
if (job->jv_refcount == 0 && !job_channel_still_useful(job))
// The job was already unreferenced and the associated channel was
// detached, now that it ended it can be freed. However, a caller might
// still use it, thus free it a bit later.
job_free_later(job);
}
/*
* Mark references in jobs that are still useful.
*/
int
set_ref_in_job(int copyID)
{
int abort = FALSE;
job_T *job;
typval_T tv;
for (job = first_job; !abort && job != NULL; job = job->jv_next)
if (job_still_useful(job))
{
tv.v_type = VAR_JOB;
tv.vval.v_job = job;
abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
}
return abort;
}
/*
* Dereference "job". Note that after this "job" may have been freed.
*/
void
job_unref(job_T *job)
{
if (job == NULL || --job->jv_refcount > 0)
return;
// Do not free the job if there is a channel where the close callback
// may get the job info.
if (job_channel_still_useful(job))
return;
// Do not free the job when it has not ended yet and there is a
// "stoponexit" flag or an exit callback.
if (!job_need_end_check(job))
{
job_free(job);
}
else if (job->jv_channel != NULL)
{
// Do remove the link to the channel, otherwise it hangs
// around until Vim exits. See job_free() for refcount.
ch_log(job->jv_channel, "detaching channel from job");
job->jv_channel->ch_job = NULL;
channel_unref(job->jv_channel);
job->jv_channel = NULL;
}
}
int
free_unused_jobs_contents(int copyID, int mask)
{
int did_free = FALSE;
job_T *job;
FOR_ALL_JOBS(job)
if ((job->jv_copyID & mask) != (copyID & mask)
&& !job_still_useful(job))
{
// Free the channel and ordinary items it contains, but don't
// recurse into Lists, Dictionaries etc.
job_free_contents(job);
did_free = TRUE;
}
return did_free;
}
void
free_unused_jobs(int copyID, int mask)
{
job_T *job;
job_T *job_next;
for (job = first_job; job != NULL; job = job_next)
{
job_next = job->jv_next;
if ((job->jv_copyID & mask) != (copyID & mask)
&& !job_still_useful(job))
{
// Free the job struct itself.
job_free_job(job);
}
}
}
/*
* Allocate a job. Sets the refcount to one and sets options default.
*/
job_T *
job_alloc(void)
{
job_T *job;
job = ALLOC_CLEAR_ONE(job_T);
if (job == NULL)
return NULL;
job->jv_refcount = 1;
job->jv_stoponexit = vim_strsave((char_u *)"term");
if (first_job != NULL)
{
first_job->jv_prev = job;
job->jv_next = first_job;
}
first_job = job;
return job;
}
void
job_set_options(job_T *job, jobopt_T *opt)
{
if (opt->jo_set & JO_STOPONEXIT)
{
vim_free(job->jv_stoponexit);
if (opt->jo_stoponexit == NULL || *opt->jo_stoponexit == NUL)
job->jv_stoponexit = NULL;
else
job->jv_stoponexit = vim_strsave(opt->jo_stoponexit);
}
if (opt->jo_set & JO_EXIT_CB)
{
free_callback(&job->jv_exit_cb);
if (opt->jo_exit_cb.cb_name == NULL || *opt->jo_exit_cb.cb_name == NUL)
{
job->jv_exit_cb.cb_name = NULL;
job->jv_exit_cb.cb_partial = NULL;
}
else
copy_callback(&job->jv_exit_cb, &opt->jo_exit_cb);
}
}
/*
* Called when Vim is exiting: kill all jobs that have the "stoponexit" flag.
*/
void
job_stop_on_exit(void)
{
job_T *job;
FOR_ALL_JOBS(job)
if (job->jv_status == JOB_STARTED && job->jv_stoponexit != NULL)
mch_signal_job(job, job->jv_stoponexit);
}
/*
* Return TRUE when there is any job that has an exit callback and might exit,
* which means job_check_ended() should be called more often.
*/
int
has_pending_job(void)
{
job_T *job;
FOR_ALL_JOBS(job)
// Only should check if the channel has been closed, if the channel is
// open the job won't exit.
if ((job->jv_status == JOB_STARTED && !job_channel_still_useful(job))
|| (job->jv_status == JOB_FINISHED
&& job_channel_can_close(job)))
return TRUE;
return FALSE;
}
#define MAX_CHECK_ENDED 8
/*
* Called once in a while: check if any jobs that seem useful have ended.
* Returns TRUE if a job did end.
*/
int
job_check_ended(void)
{
int i;
int did_end = FALSE;
// be quick if there are no jobs to check
if (first_job == NULL)
return did_end;
for (i = 0; i < MAX_CHECK_ENDED; ++i)
{
// NOTE: mch_detect_ended_job() must only return a job of which the
// status was just set to JOB_ENDED.
job_T *job = mch_detect_ended_job(first_job);
if (job == NULL)
break;
did_end = TRUE;
job_cleanup(job); // may add "job" to jobs_to_free
}
// Actually free jobs that were cleaned up.
free_jobs_to_free_later();
if (channel_need_redraw)
{
channel_need_redraw = FALSE;
redraw_after_callback(TRUE, FALSE);
}
return did_end;
}
/*
* Create a job and return it. Implements job_start().
* "argv_arg" is only for Unix.
* When "argv_arg" is NULL then "argvars" is used.
* The returned job has a refcount of one.
* Returns NULL when out of memory.
*/
job_T *
job_start(
typval_T *argvars,
char **argv_arg UNUSED,
jobopt_T *opt_arg,
job_T **term_job)
{
job_T *job;
char_u *cmd = NULL;
char **argv = NULL;
int argc = 0;
int i;
#ifndef USE_ARGV
garray_T ga;
#endif
jobopt_T opt;
ch_part_T part;
job = job_alloc();
if (job == NULL)
return NULL;
job->jv_status = JOB_FAILED;
#ifndef USE_ARGV
ga_init2(&ga, sizeof(char*), 20);
#endif
if (opt_arg != NULL)
opt = *opt_arg;
else
{
// Default mode is NL.
clear_job_options(&opt);
opt.jo_mode = CH_MODE_NL;
if (get_job_options(&argvars[1], &opt,
JO_MODE_ALL + JO_CB_ALL + JO_TIMEOUT_ALL + JO_STOPONEXIT
+ JO_EXIT_CB + JO_OUT_IO + JO_BLOCK_WRITE,
JO2_ENV + JO2_CWD) == FAIL)
goto theend;
}
// Check that when io is "file" that there is a file name.
for (part = PART_OUT; part < PART_COUNT; ++part)
if ((opt.jo_set & (JO_OUT_IO << (part - PART_OUT)))
&& opt.jo_io[part] == JIO_FILE
&& (!(opt.jo_set & (JO_OUT_NAME << (part - PART_OUT)))
|| *opt.jo_io_name[part] == NUL))
{
emsg(_(e_io_file_requires_name_to_be_set));
goto theend;
}
if ((opt.jo_set & JO_IN_IO) && opt.jo_io[PART_IN] == JIO_BUFFER)
{
buf_T *buf = NULL;
// check that we can find the buffer before starting the job
if (opt.jo_set & JO_IN_BUF)
{
buf = buflist_findnr(opt.jo_io_buf[PART_IN]);
if (buf == NULL)
semsg(_(e_buffer_nr_does_not_exist),
(long)opt.jo_io_buf[PART_IN]);
}
else if (!(opt.jo_set & JO_IN_NAME))
{
emsg(_(e_in_io_buffer_requires_in_buf_or_in_name_to_be_set));
}
else
buf = buflist_find_by_name(opt.jo_io_name[PART_IN], FALSE);
if (buf == NULL)
goto theend;
if (buf->b_ml.ml_mfp == NULL)
{
char_u numbuf[NUMBUFLEN];
char_u *s;
if (opt.jo_set & JO_IN_BUF)
{
sprintf((char *)numbuf, "%d", opt.jo_io_buf[PART_IN]);
s = numbuf;
}
else
s = opt.jo_io_name[PART_IN];
semsg(_(e_buffer_must_be_loaded_str), s);
goto theend;
}
job->jv_in_buf = buf;
}
job_set_options(job, &opt);
#ifdef USE_ARGV
if (argv_arg != NULL)
{
// Make a copy of argv_arg for job->jv_argv.
for (i = 0; argv_arg[i] != NULL; i++)
argc++;
argv = ALLOC_MULT(char *, argc + 1);
if (argv == NULL)
goto theend;
for (i = 0; i < argc; i++)
argv[i] = (char *)vim_strsave((char_u *)argv_arg[i]);
argv[argc] = NULL;
}
else
#endif
if (argvars[0].v_type == VAR_STRING)
{
// Command is a string.
cmd = argvars[0].vval.v_string;
if (cmd == NULL || *skipwhite(cmd) == NUL)
{
emsg(_(e_invalid_argument));
goto theend;
}
if (build_argv_from_string(cmd, &argv, &argc) == FAIL)
goto theend;
}
else if (argvars[0].v_type != VAR_LIST
|| argvars[0].vval.v_list == NULL
|| argvars[0].vval.v_list->lv_len < 1)
{
emsg(_(e_invalid_argument));
goto theend;
}
else
{
list_T *l = argvars[0].vval.v_list;
if (build_argv_from_list(l, &argv, &argc) == FAIL)
goto theend;
// Empty command is invalid.
if (argc == 0 || *skipwhite((char_u *)argv[0]) == NUL)
{
emsg(_(e_invalid_argument));
goto theend;
}
#ifndef USE_ARGV
if (win32_build_cmd(l, &ga) == FAIL)
goto theend;
cmd = ga.ga_data;
if (cmd == NULL || *skipwhite(cmd) == NUL)
{
emsg(_(e_invalid_argument));
goto theend;
}
#endif
}
// Save the command used to start the job.
job->jv_argv = argv;
if (term_job != NULL)
*term_job = job;
#ifdef USE_ARGV
if (ch_log_active())
{
garray_T ga;
ga_init2(&ga, sizeof(char), 200);
for (i = 0; i < argc; ++i)
{
if (i > 0)
ga_concat(&ga, (char_u *)" ");
ga_concat(&ga, (char_u *)argv[i]);
}
ga_append(&ga, NUL);
ch_log(NULL, "Starting job: %s", (char *)ga.ga_data);
ga_clear(&ga);
}
mch_job_start(argv, job, &opt, term_job != NULL);
#else
ch_log(NULL, "Starting job: %s", (char *)cmd);
mch_job_start((char *)cmd, job, &opt);
#endif
// If the channel is reading from a buffer, write lines now.
if (job->jv_channel != NULL)
channel_write_in(job->jv_channel);
theend:
#ifndef USE_ARGV
vim_free(ga.ga_data);
#endif
if (argv != NULL && argv != job->jv_argv)
{
for (i = 0; argv[i] != NULL; i++)
vim_free(argv[i]);
vim_free(argv);
}
free_job_options(&opt);
return job;
}
/*
* Get the status of "job" and invoke the exit callback when needed.
* The returned string is not allocated.
*/
char *
job_status(job_T *job)
{
char *result;
if (job->jv_status >= JOB_ENDED)
// No need to check, dead is dead.
result = "dead";
else if (job->jv_status == JOB_FAILED)
result = "fail";
else
{
result = mch_job_status(job);
if (job->jv_status == JOB_ENDED)
job_cleanup(job);
}
return result;
}
/*
* Send a signal to "job". Implements job_stop().
* When "type" is not NULL use this for the type.
* Otherwise use argvars[1] for the type.
*/
int
job_stop(job_T *job, typval_T *argvars, char *type)
{
char_u *arg;
if (type != NULL)
arg = (char_u *)type;
else if (argvars[1].v_type == VAR_UNKNOWN)
arg = (char_u *)"";
else
{
arg = tv_get_string_chk(&argvars[1]);
if (arg == NULL)
{
emsg(_(e_invalid_argument));
return 0;
}
}
if (job->jv_status == JOB_FAILED)
{
ch_log(job->jv_channel, "Job failed to start, job_stop() skipped");
return 0;
}
if (job->jv_status == JOB_ENDED)
{
ch_log(job->jv_channel, "Job has already ended, job_stop() skipped");
return 0;
}
ch_log(job->jv_channel, "Stopping job with '%s'", (char *)arg);
if (mch_signal_job(job, arg) == FAIL)
return 0;
// Assume that only "kill" will kill the job.
if (job->jv_channel != NULL && STRCMP(arg, "kill") == 0)
job->jv_channel->ch_job_killed = TRUE;
// We don't try freeing the job, obviously the caller still has a
// reference to it.
return 1;
}
void
invoke_prompt_callback(void)
{
typval_T rettv;
typval_T argv[2];
char_u *text;
char_u *prompt;
linenr_T lnum = curbuf->b_ml.ml_line_count;
// Add a new line for the prompt before invoking the callback, so that
// text can always be inserted above the last line.
ml_append(lnum, (char_u *)"", 0, FALSE);
curwin->w_cursor.lnum = lnum + 1;
curwin->w_cursor.col = 0;
if (curbuf->b_prompt_callback.cb_name == NULL
|| *curbuf->b_prompt_callback.cb_name == NUL)
return;
text = ml_get(lnum);
prompt = prompt_text();
if (STRLEN(text) >= STRLEN(prompt))
text += STRLEN(prompt);
argv[0].v_type = VAR_STRING;
argv[0].vval.v_string = vim_strsave(text);
argv[1].v_type = VAR_UNKNOWN;
call_callback(&curbuf->b_prompt_callback, -1, &rettv, 1, argv);
clear_tv(&argv[0]);
clear_tv(&rettv);
}
/*
* Return TRUE when the interrupt callback was invoked.
*/
int
invoke_prompt_interrupt(void)
{
typval_T rettv;
typval_T argv[1];
int ret;
if (curbuf->b_prompt_interrupt.cb_name == NULL
|| *curbuf->b_prompt_interrupt.cb_name == NUL)
return FALSE;
argv[0].v_type = VAR_UNKNOWN;
got_int = FALSE; // don't skip executing commands
ret = call_callback(&curbuf->b_prompt_interrupt, -1, &rettv, 0, argv);
clear_tv(&rettv);
return ret == FAIL ? FALSE : TRUE;
}
/*
* Return the effective prompt for the specified buffer.
*/
static char_u *
buf_prompt_text(buf_T* buf)
{
if (buf->b_prompt_text == NULL)
return (char_u *)"% ";
return buf->b_prompt_text;
}
/*
* Return the effective prompt for the current buffer.
*/
char_u *
prompt_text(void)
{
return buf_prompt_text(curbuf);
}
/*
* Prepare for prompt mode: Make sure the last line has the prompt text.
* Move the cursor to this line.
*/
void
init_prompt(int cmdchar_todo)
{
char_u *prompt = prompt_text();
char_u *text;
curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
text = ml_get_curline();
if (STRNCMP(text, prompt, STRLEN(prompt)) != 0)
{
// prompt is missing, insert it or append a line with it
if (*text == NUL)
ml_replace(curbuf->b_ml.ml_line_count, prompt, TRUE);
else
ml_append(curbuf->b_ml.ml_line_count, prompt, 0, FALSE);
curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
coladvance((colnr_T)MAXCOL);
changed_bytes(curbuf->b_ml.ml_line_count, 0);
}
// Insert always starts after the prompt, allow editing text after it.
if (Insstart_orig.lnum != curwin->w_cursor.lnum
|| Insstart_orig.col != (int)STRLEN(prompt))
set_insstart(curwin->w_cursor.lnum, (int)STRLEN(prompt));
if (cmdchar_todo == 'A')
coladvance((colnr_T)MAXCOL);
if (curwin->w_cursor.col < (int)STRLEN(prompt))
curwin->w_cursor.col = (int)STRLEN(prompt);
// Make sure the cursor is in a valid position.
check_cursor();
}
/*
* Return TRUE if the cursor is in the editable position of the prompt line.
*/
int
prompt_curpos_editable(void)
{
return curwin->w_cursor.lnum == curbuf->b_ml.ml_line_count
&& curwin->w_cursor.col >= (int)STRLEN(prompt_text());
}
/*
* "prompt_setcallback({buffer}, {callback})" function
*/
void
f_prompt_setcallback(typval_T *argvars, typval_T *rettv UNUSED)
{
buf_T *buf;
callback_T callback;
if (check_secure())
return;
if (in_vim9script() && check_for_buffer_arg(argvars, 0) == FAIL)
return;
buf = tv_get_buf(&argvars[0], FALSE);
if (buf == NULL)
return;
callback = get_callback(&argvars[1]);
if (callback.cb_name == NULL)
return;
free_callback(&buf->b_prompt_callback);
set_callback(&buf->b_prompt_callback, &callback);
if (callback.cb_free_name)
vim_free(callback.cb_name);
}
/*
* "prompt_setinterrupt({buffer}, {callback})" function
*/
void
f_prompt_setinterrupt(typval_T *argvars, typval_T *rettv UNUSED)
{
buf_T *buf;
callback_T callback;
if (check_secure())
return;
if (in_vim9script() && check_for_buffer_arg(argvars, 0) == FAIL)
return;
buf = tv_get_buf(&argvars[0], FALSE);
if (buf == NULL)
return;
callback = get_callback(&argvars[1]);
if (callback.cb_name == NULL)
return;
free_callback(&buf->b_prompt_interrupt);
set_callback(&buf->b_prompt_interrupt, &callback);
if (callback.cb_free_name)
vim_free(callback.cb_name);
}
/*
* "prompt_getprompt({buffer})" function
*/
void
f_prompt_getprompt(typval_T *argvars, typval_T *rettv)
{
buf_T *buf;
// return an empty string by default, e.g. it's not a prompt buffer
rettv->v_type = VAR_STRING;
rettv->vval.v_string = NULL;
if (in_vim9script() && check_for_buffer_arg(argvars, 0) == FAIL)
return;
buf = tv_get_buf_from_arg(&argvars[0]);
if (buf == NULL)
return;
if (!bt_prompt(buf))
return;
rettv->vval.v_string = vim_strsave(buf_prompt_text(buf));
}
/*
* "prompt_setprompt({buffer}, {text})" function
*/
void
f_prompt_setprompt(typval_T *argvars, typval_T *rettv UNUSED)
{
buf_T *buf;
char_u *text;
if (in_vim9script()
&& (check_for_buffer_arg(argvars, 0) == FAIL
|| check_for_string_arg(argvars, 1) == FAIL))
return;
if (check_secure())
return;
buf = tv_get_buf(&argvars[0], FALSE);
if (buf == NULL)
return;
text = tv_get_string(&argvars[1]);
vim_free(buf->b_prompt_text);
buf->b_prompt_text = vim_strsave(text);
}
/*
* Get the job from the argument.
* Returns NULL if the job is invalid.
*/
static job_T *
get_job_arg(typval_T *tv)
{
job_T *job;
if (tv->v_type != VAR_JOB)
{
semsg(_(e_invalid_argument_str), tv_get_string(tv));
return NULL;
}
job = tv->vval.v_job;
if (job == NULL)
emsg(_(e_not_valid_job));
return job;
}
/*
* "job_getchannel()" function
*/
void
f_job_getchannel(typval_T *argvars, typval_T *rettv)
{
job_T *job;
if (in_vim9script() && check_for_job_arg(argvars, 0) == FAIL)
return;
job = get_job_arg(&argvars[0]);
if (job == NULL)
return;
rettv->v_type = VAR_CHANNEL;
rettv->vval.v_channel = job->jv_channel;
if (job->jv_channel != NULL)
++job->jv_channel->ch_refcount;
}
/*
* Implementation of job_info().
*/
static void
job_info(job_T *job, dict_T *dict)
{
dictitem_T *item;
varnumber_T nr;
list_T *l;
int i;
dict_add_string(dict, "status", (char_u *)job_status(job));
item = dictitem_alloc((char_u *)"channel");
if (item == NULL)
return;
item->di_tv.v_type = VAR_CHANNEL;
item->di_tv.vval.v_channel = job->jv_channel;
if (job->jv_channel != NULL)
++job->jv_channel->ch_refcount;
if (dict_add(dict, item) == FAIL)
dictitem_free(item);
#ifdef UNIX
nr = job->jv_pid;
#else
nr = job->jv_proc_info.dwProcessId;
#endif
dict_add_number(dict, "process", nr);
dict_add_string(dict, "tty_in", job->jv_tty_in);
dict_add_string(dict, "tty_out", job->jv_tty_out);
dict_add_number(dict, "exitval", job->jv_exitval);
dict_add_string(dict, "exit_cb", job->jv_exit_cb.cb_name);
dict_add_string(dict, "stoponexit", job->jv_stoponexit);
#ifdef UNIX
dict_add_string(dict, "termsig", job->jv_termsig);
#endif
#ifdef MSWIN
dict_add_string(dict, "tty_type", job->jv_tty_type);
#endif
l = list_alloc();
if (l == NULL)
return;
dict_add_list(dict, "cmd", l);
if (job->jv_argv != NULL)
for (i = 0; job->jv_argv[i] != NULL; i++)
list_append_string(l, (char_u *)job->jv_argv[i], -1);
}
/*
* Implementation of job_info() to return info for all jobs.
*/
static void
job_info_all(list_T *l)
{
job_T *job;
typval_T tv;
FOR_ALL_JOBS(job)
{
tv.v_type = VAR_JOB;
tv.vval.v_job = job;
if (list_append_tv(l, &tv) != OK)
return;
}
}
/*
* "job_info()" function
*/
void
f_job_info(typval_T *argvars, typval_T *rettv)
{
if (in_vim9script() && check_for_opt_job_arg(argvars, 0) == FAIL)
return;
if (argvars[0].v_type != VAR_UNKNOWN)
{
job_T *job;
job = get_job_arg(&argvars[0]);
if (job != NULL && rettv_dict_alloc(rettv) == OK)
job_info(job, rettv->vval.v_dict);
}
else if (rettv_list_alloc(rettv) == OK)
job_info_all(rettv->vval.v_list);
}
/*
* "job_setoptions()" function
*/
void
f_job_setoptions(typval_T *argvars, typval_T *rettv UNUSED)
{
job_T *job;
jobopt_T opt;
if (in_vim9script()
&& (check_for_job_arg(argvars, 0) == FAIL
|| check_for_dict_arg(argvars, 1) == FAIL))
return;
job = get_job_arg(&argvars[0]);
if (job == NULL)
return;
clear_job_options(&opt);
if (get_job_options(&argvars[1], &opt, JO_STOPONEXIT + JO_EXIT_CB, 0) == OK)
job_set_options(job, &opt);
free_job_options(&opt);
}
/*
* "job_start()" function
*/
void
f_job_start(typval_T *argvars, typval_T *rettv)
{
rettv->v_type = VAR_JOB;
if (check_restricted() || check_secure())
return;
if (in_vim9script()
&& (check_for_string_or_list_arg(argvars, 0) == FAIL
|| check_for_opt_dict_arg(argvars, 1) == FAIL))
return;
rettv->vval.v_job = job_start(argvars, NULL, NULL, NULL);
}
/*
* "job_status()" function
*/
void
f_job_status(typval_T *argvars, typval_T *rettv)
{
if (in_vim9script() && check_for_job_arg(argvars, 0) == FAIL)
return;
if (argvars[0].v_type == VAR_JOB && argvars[0].vval.v_job == NULL)
{
// A job that never started returns "fail".
rettv->v_type = VAR_STRING;
rettv->vval.v_string = vim_strsave((char_u *)"fail");
}
else
{
job_T *job = get_job_arg(&argvars[0]);
if (job != NULL)
{
rettv->v_type = VAR_STRING;
rettv->vval.v_string = vim_strsave((char_u *)job_status(job));
}
}
}
/*
* "job_stop()" function
*/
void
f_job_stop(typval_T *argvars, typval_T *rettv)
{
job_T *job;
if (in_vim9script()
&& (check_for_job_arg(argvars, 0) == FAIL
|| check_for_opt_string_or_number_arg(argvars, 1) == FAIL))
return;
job = get_job_arg(&argvars[0]);
if (job != NULL)
rettv->vval.v_number = job_stop(job, argvars, NULL);
}
/*
* Get a string with information about the job in "varp" in "buf".
* "buf" must be at least NUMBUFLEN long.
*/
char_u *
job_to_string_buf(typval_T *varp, char_u *buf)
{
job_T *job = varp->vval.v_job;
char *status;
if (job == NULL)
{
vim_snprintf((char *)buf, NUMBUFLEN, "no process");
return buf;
}
status = job->jv_status == JOB_FAILED ? "fail"
: job->jv_status >= JOB_ENDED ? "dead"
: "run";
# ifdef UNIX
vim_snprintf((char *)buf, NUMBUFLEN,
"process %ld %s", (long)job->jv_pid, status);
# elif defined(MSWIN)
vim_snprintf((char *)buf, NUMBUFLEN,
"process %ld %s",
(long)job->jv_proc_info.dwProcessId,
status);
# else
// fall-back
vim_snprintf((char *)buf, NUMBUFLEN, "process ? %s", status);
# endif
return buf;
}
#endif // FEAT_JOB_CHANNEL
Reference in a new issue View git blame Copy permalink