blob: c0c6aa7ad50ae52537dc0364234a39d4b3bd5f67 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
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 * eval.c: Expression evaluation.
12 */
Bram Moolenaarfefecb02016-02-27 21:27:20 +010013#define USING_FLOAT_STUFF
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15#include "vim.h"
16
Bram Moolenaar8c8de832008-06-24 22:58:06 +000017#if defined(FEAT_EVAL) || defined(PROTO)
18
Bram Moolenaar314f11d2010-08-09 22:07:08 +020019#ifdef VMS
20# include <float.h>
21#endif
22
Bram Moolenaar33570922005-01-25 22:26:29 +000023#define DICT_MAXNEST 100 /* maximum nesting of lists and dicts */
Bram Moolenaar071d4272004-06-13 20:20:40 +000024
Bram Moolenaarc70646c2005-01-04 21:52:38 +000025static char *e_letunexp = N_("E18: Unexpected characters in :let");
Bram Moolenaarc70646c2005-01-04 21:52:38 +000026static char *e_undefvar = N_("E121: Undefined variable: %s");
27static char *e_missbrac = N_("E111: Missing ']'");
Bram Moolenaar9ef486d2005-01-17 22:23:00 +000028static char *e_dictrange = N_("E719: Cannot use [:] with a Dictionary");
29static char *e_letwrong = N_("E734: Wrong variable type for %s=");
Bram Moolenaar92124a32005-06-17 22:03:40 +000030static char *e_illvar = N_("E461: Illegal variable name: %s");
Bram Moolenaar8c0e3222013-06-16 17:32:40 +020031#ifdef FEAT_FLOAT
Bram Moolenaar2a876e42013-06-12 22:08:58 +020032static char *e_float_as_string = N_("E806: using Float as a String");
Bram Moolenaar8c0e3222013-06-16 17:32:40 +020033#endif
Bram Moolenaar8c8de832008-06-24 22:58:06 +000034
Bram Moolenaar9bbf63d2016-01-16 16:49:28 +010035#define NAMESPACE_CHAR (char_u *)"abglstvw"
36
Bram Moolenaar230bb3f2013-04-24 14:07:45 +020037static dictitem_T globvars_var; /* variable used for g: */
Bram Moolenaar33570922005-01-25 22:26:29 +000038#define globvarht globvardict.dv_hashtab
Bram Moolenaar071d4272004-06-13 20:20:40 +000039
40/*
Bram Moolenaar532c7802005-01-27 14:44:31 +000041 * Old Vim variables such as "v:version" are also available without the "v:".
42 * Also in functions. We need a special hashtable for them.
43 */
Bram Moolenaar4debb442005-06-01 21:57:40 +000044static hashtab_T compat_hashtab;
Bram Moolenaar532c7802005-01-27 14:44:31 +000045
46/*
Bram Moolenaard9fba312005-06-26 22:34:35 +000047 * When recursively copying lists and dicts we need to remember which ones we
48 * have done to avoid endless recursiveness. This unique ID is used for that.
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +000049 * The last bit is used for previous_funccal, ignored when comparing.
Bram Moolenaard9fba312005-06-26 22:34:35 +000050 */
51static int current_copyID = 0;
Bram Moolenaar8502c702014-06-17 12:51:16 +020052
Bram Moolenaard9fba312005-06-26 22:34:35 +000053/*
Bram Moolenaar33570922005-01-25 22:26:29 +000054 * Array to hold the hashtab with variables local to each sourced script.
55 * Each item holds a variable (nameless) that points to the dict_T.
Bram Moolenaar071d4272004-06-13 20:20:40 +000056 */
Bram Moolenaar33570922005-01-25 22:26:29 +000057typedef struct
58{
59 dictitem_T sv_var;
60 dict_T sv_dict;
61} scriptvar_T;
62
Bram Moolenaar9577c3e2010-05-14 12:16:25 +020063static garray_T ga_scripts = {0, 0, sizeof(scriptvar_T *), 4, NULL};
64#define SCRIPT_SV(id) (((scriptvar_T **)ga_scripts.ga_data)[(id) - 1])
65#define SCRIPT_VARS(id) (SCRIPT_SV(id)->sv_dict.dv_hashtab)
Bram Moolenaar071d4272004-06-13 20:20:40 +000066
67static int echo_attr = 0; /* attributes used for ":echo" */
68
Bram Moolenaarc9b4b052006-04-30 18:54:39 +000069/* The names of packages that once were loaded are remembered. */
Bram Moolenaaraa35dd12006-04-29 22:03:41 +000070static garray_T ga_loaded = {0, 0, sizeof(char_u *), 4, NULL};
71
Bram Moolenaar071d4272004-06-13 20:20:40 +000072/*
Bram Moolenaar3d60ec22005-01-05 22:19:46 +000073 * Info used by a ":for" loop.
74 */
Bram Moolenaar33570922005-01-25 22:26:29 +000075typedef struct
Bram Moolenaar3d60ec22005-01-05 22:19:46 +000076{
77 int fi_semicolon; /* TRUE if ending in '; var]' */
78 int fi_varcount; /* nr of variables in the list */
Bram Moolenaar33570922005-01-25 22:26:29 +000079 listwatch_T fi_lw; /* keep an eye on the item used. */
80 list_T *fi_list; /* list being used */
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +010081 int fi_bi; /* index of blob */
82 blob_T *fi_blob; /* blob being used */
Bram Moolenaar33570922005-01-25 22:26:29 +000083} forinfo_T;
Bram Moolenaar3d60ec22005-01-05 22:19:46 +000084
Bram Moolenaara7043832005-01-21 11:56:39 +000085
86/*
Bram Moolenaar33570922005-01-25 22:26:29 +000087 * Array to hold the value of v: variables.
88 * The value is in a dictitem, so that it can also be used in the v: scope.
89 * The reason to use this table anyway is for very quick access to the
90 * variables with the VV_ defines.
91 */
Bram Moolenaar33570922005-01-25 22:26:29 +000092
93/* values for vv_flags: */
94#define VV_COMPAT 1 /* compatible, also used without "v:" */
95#define VV_RO 2 /* read-only */
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +000096#define VV_RO_SBX 4 /* read-only in the sandbox */
Bram Moolenaar33570922005-01-25 22:26:29 +000097
Bram Moolenaarbee6c0c2016-03-25 15:40:50 +010098#define VV_NAME(s, t) s, {{t, 0, {0}}, 0, {0}}
Bram Moolenaar33570922005-01-25 22:26:29 +000099
100static struct vimvar
101{
102 char *vv_name; /* name of variable, without v: */
Bram Moolenaarbee6c0c2016-03-25 15:40:50 +0100103 dictitem16_T vv_di; /* value and name for key (max 16 chars!) */
Bram Moolenaar33570922005-01-25 22:26:29 +0000104 char vv_flags; /* VV_COMPAT, VV_RO, VV_RO_SBX */
105} vimvars[VV_LEN] =
106{
107 /*
108 * The order here must match the VV_ defines in vim.h!
109 * Initializing a union does not work, leave tv.vval empty to get zero's.
110 */
111 {VV_NAME("count", VAR_NUMBER), VV_COMPAT+VV_RO},
112 {VV_NAME("count1", VAR_NUMBER), VV_RO},
113 {VV_NAME("prevcount", VAR_NUMBER), VV_RO},
114 {VV_NAME("errmsg", VAR_STRING), VV_COMPAT},
115 {VV_NAME("warningmsg", VAR_STRING), 0},
116 {VV_NAME("statusmsg", VAR_STRING), 0},
117 {VV_NAME("shell_error", VAR_NUMBER), VV_COMPAT+VV_RO},
118 {VV_NAME("this_session", VAR_STRING), VV_COMPAT},
119 {VV_NAME("version", VAR_NUMBER), VV_COMPAT+VV_RO},
120 {VV_NAME("lnum", VAR_NUMBER), VV_RO_SBX},
121 {VV_NAME("termresponse", VAR_STRING), VV_RO},
122 {VV_NAME("fname", VAR_STRING), VV_RO},
123 {VV_NAME("lang", VAR_STRING), VV_RO},
124 {VV_NAME("lc_time", VAR_STRING), VV_RO},
125 {VV_NAME("ctype", VAR_STRING), VV_RO},
126 {VV_NAME("charconvert_from", VAR_STRING), VV_RO},
127 {VV_NAME("charconvert_to", VAR_STRING), VV_RO},
128 {VV_NAME("fname_in", VAR_STRING), VV_RO},
129 {VV_NAME("fname_out", VAR_STRING), VV_RO},
130 {VV_NAME("fname_new", VAR_STRING), VV_RO},
131 {VV_NAME("fname_diff", VAR_STRING), VV_RO},
132 {VV_NAME("cmdarg", VAR_STRING), VV_RO},
133 {VV_NAME("foldstart", VAR_NUMBER), VV_RO_SBX},
134 {VV_NAME("foldend", VAR_NUMBER), VV_RO_SBX},
135 {VV_NAME("folddashes", VAR_STRING), VV_RO_SBX},
136 {VV_NAME("foldlevel", VAR_NUMBER), VV_RO_SBX},
137 {VV_NAME("progname", VAR_STRING), VV_RO},
138 {VV_NAME("servername", VAR_STRING), VV_RO},
139 {VV_NAME("dying", VAR_NUMBER), VV_RO},
140 {VV_NAME("exception", VAR_STRING), VV_RO},
141 {VV_NAME("throwpoint", VAR_STRING), VV_RO},
142 {VV_NAME("register", VAR_STRING), VV_RO},
143 {VV_NAME("cmdbang", VAR_NUMBER), VV_RO},
144 {VV_NAME("insertmode", VAR_STRING), VV_RO},
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +0000145 {VV_NAME("val", VAR_UNKNOWN), VV_RO},
146 {VV_NAME("key", VAR_UNKNOWN), VV_RO},
Bram Moolenaar05159a02005-02-26 23:04:13 +0000147 {VV_NAME("profiling", VAR_NUMBER), VV_RO},
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000148 {VV_NAME("fcs_reason", VAR_STRING), VV_RO},
149 {VV_NAME("fcs_choice", VAR_STRING), 0},
Bram Moolenaare2ac10d2005-03-07 23:26:06 +0000150 {VV_NAME("beval_bufnr", VAR_NUMBER), VV_RO},
151 {VV_NAME("beval_winnr", VAR_NUMBER), VV_RO},
Bram Moolenaarc9721bd2016-06-04 17:41:03 +0200152 {VV_NAME("beval_winid", VAR_NUMBER), VV_RO},
Bram Moolenaare2ac10d2005-03-07 23:26:06 +0000153 {VV_NAME("beval_lnum", VAR_NUMBER), VV_RO},
154 {VV_NAME("beval_col", VAR_NUMBER), VV_RO},
155 {VV_NAME("beval_text", VAR_STRING), VV_RO},
Bram Moolenaar761b1132005-10-03 22:05:45 +0000156 {VV_NAME("scrollstart", VAR_STRING), 0},
Bram Moolenaard5bc83f2005-12-07 21:07:59 +0000157 {VV_NAME("swapname", VAR_STRING), VV_RO},
158 {VV_NAME("swapchoice", VAR_STRING), 0},
Bram Moolenaar63a121b2005-12-11 21:36:39 +0000159 {VV_NAME("swapcommand", VAR_STRING), VV_RO},
Bram Moolenaare659c952011-05-19 17:25:41 +0200160 {VV_NAME("char", VAR_STRING), 0},
Bram Moolenaar219b8702006-11-01 14:32:36 +0000161 {VV_NAME("mouse_win", VAR_NUMBER), 0},
Bram Moolenaar511972d2016-06-04 18:09:59 +0200162 {VV_NAME("mouse_winid", VAR_NUMBER), 0},
Bram Moolenaar219b8702006-11-01 14:32:36 +0000163 {VV_NAME("mouse_lnum", VAR_NUMBER), 0},
164 {VV_NAME("mouse_col", VAR_NUMBER), 0},
Bram Moolenaar8af1fbf2008-01-05 12:35:21 +0000165 {VV_NAME("operator", VAR_STRING), VV_RO},
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000166 {VV_NAME("searchforward", VAR_NUMBER), 0},
Bram Moolenaar8050efa2013-11-08 04:30:20 +0100167 {VV_NAME("hlsearch", VAR_NUMBER), 0},
Bram Moolenaard812df62008-11-09 12:46:09 +0000168 {VV_NAME("oldfiles", VAR_LIST), 0},
Bram Moolenaar727c8762010-10-20 19:17:48 +0200169 {VV_NAME("windowid", VAR_NUMBER), VV_RO},
Bram Moolenaara1706c92014-04-01 19:55:49 +0200170 {VV_NAME("progpath", VAR_STRING), VV_RO},
Bram Moolenaar42a45122015-07-10 17:56:23 +0200171 {VV_NAME("completed_item", VAR_DICT), VV_RO},
Bram Moolenaar53744302015-07-17 17:38:22 +0200172 {VV_NAME("option_new", VAR_STRING), VV_RO},
173 {VV_NAME("option_old", VAR_STRING), VV_RO},
174 {VV_NAME("option_type", VAR_STRING), VV_RO},
Bram Moolenaar43345542015-11-29 17:35:35 +0100175 {VV_NAME("errors", VAR_LIST), 0},
Bram Moolenaar520e1e42016-01-23 19:46:28 +0100176 {VV_NAME("false", VAR_SPECIAL), VV_RO},
177 {VV_NAME("true", VAR_SPECIAL), VV_RO},
178 {VV_NAME("null", VAR_SPECIAL), VV_RO},
179 {VV_NAME("none", VAR_SPECIAL), VV_RO},
Bram Moolenaar14735512016-03-26 21:00:08 +0100180 {VV_NAME("vim_did_enter", VAR_NUMBER), VV_RO},
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +0200181 {VV_NAME("testing", VAR_NUMBER), 0},
Bram Moolenaarf562e722016-07-19 17:25:25 +0200182 {VV_NAME("t_number", VAR_NUMBER), VV_RO},
183 {VV_NAME("t_string", VAR_NUMBER), VV_RO},
184 {VV_NAME("t_func", VAR_NUMBER), VV_RO},
185 {VV_NAME("t_list", VAR_NUMBER), VV_RO},
186 {VV_NAME("t_dict", VAR_NUMBER), VV_RO},
187 {VV_NAME("t_float", VAR_NUMBER), VV_RO},
188 {VV_NAME("t_bool", VAR_NUMBER), VV_RO},
189 {VV_NAME("t_none", VAR_NUMBER), VV_RO},
190 {VV_NAME("t_job", VAR_NUMBER), VV_RO},
191 {VV_NAME("t_channel", VAR_NUMBER), VV_RO},
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +0100192 {VV_NAME("t_blob", VAR_NUMBER), VV_RO},
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +0200193 {VV_NAME("termrfgresp", VAR_STRING), VV_RO},
194 {VV_NAME("termrbgresp", VAR_STRING), VV_RO},
Bram Moolenaarf3af54e2017-08-30 14:53:06 +0200195 {VV_NAME("termu7resp", VAR_STRING), VV_RO},
196 {VV_NAME("termstyleresp", VAR_STRING), VV_RO},
197 {VV_NAME("termblinkresp", VAR_STRING), VV_RO},
Bram Moolenaar7e1652c2017-12-16 18:27:02 +0100198 {VV_NAME("event", VAR_DICT), VV_RO},
Bram Moolenaar33570922005-01-25 22:26:29 +0000199};
200
201/* shorthand */
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000202#define vv_type vv_di.di_tv.v_type
203#define vv_nr vv_di.di_tv.vval.v_number
204#define vv_float vv_di.di_tv.vval.v_float
205#define vv_str vv_di.di_tv.vval.v_string
Bram Moolenaard812df62008-11-09 12:46:09 +0000206#define vv_list vv_di.di_tv.vval.v_list
Bram Moolenaar42a45122015-07-10 17:56:23 +0200207#define vv_dict vv_di.di_tv.vval.v_dict
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +0100208#define vv_blob vv_di.di_tv.vval.v_blob
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000209#define vv_tv vv_di.di_tv
Bram Moolenaar33570922005-01-25 22:26:29 +0000210
Bram Moolenaar230bb3f2013-04-24 14:07:45 +0200211static dictitem_T vimvars_var; /* variable used for v: */
Bram Moolenaar33570922005-01-25 22:26:29 +0000212#define vimvarht vimvardict.dv_hashtab
213
Bram Moolenaar48e697e2016-01-23 22:17:30 +0100214static int ex_let_vars(char_u *arg, typval_T *tv, int copy, int semicolon, int var_count, char_u *nextchars);
215static char_u *skip_var_list(char_u *arg, int *var_count, int *semicolon);
216static char_u *skip_var_one(char_u *arg);
Bram Moolenaar48e697e2016-01-23 22:17:30 +0100217static void list_glob_vars(int *first);
218static void list_buf_vars(int *first);
219static void list_win_vars(int *first);
Bram Moolenaar48e697e2016-01-23 22:17:30 +0100220static void list_tab_vars(int *first);
Bram Moolenaar48e697e2016-01-23 22:17:30 +0100221static void list_vim_vars(int *first);
222static void list_script_vars(int *first);
Bram Moolenaar48e697e2016-01-23 22:17:30 +0100223static char_u *list_arg_vars(exarg_T *eap, char_u *arg, int *first);
224static char_u *ex_let_one(char_u *arg, typval_T *tv, int copy, char_u *endchars, char_u *op);
Bram Moolenaar48e697e2016-01-23 22:17:30 +0100225static void set_var_lval(lval_T *lp, char_u *endp, typval_T *rettv, int copy, char_u *op);
226static int tv_op(typval_T *tv1, typval_T *tv2, char_u *op);
Bram Moolenaar48e697e2016-01-23 22:17:30 +0100227static void ex_unletlock(exarg_T *eap, char_u *argstart, int deep);
228static int do_unlet_var(lval_T *lp, char_u *name_end, int forceit);
229static int do_lock_var(lval_T *lp, char_u *name_end, int deep, int lock);
230static void item_lock(typval_T *tv, int deep, int lock);
Bram Moolenaara40058a2005-07-11 22:42:07 +0000231
Bram Moolenaar48e697e2016-01-23 22:17:30 +0100232static int eval2(char_u **arg, typval_T *rettv, int evaluate);
233static int eval3(char_u **arg, typval_T *rettv, int evaluate);
234static int eval4(char_u **arg, typval_T *rettv, int evaluate);
235static int eval5(char_u **arg, typval_T *rettv, int evaluate);
236static int eval6(char_u **arg, typval_T *rettv, int evaluate, int want_string);
237static int eval7(char_u **arg, typval_T *rettv, int evaluate, int want_string);
Bram Moolenaara40058a2005-07-11 22:42:07 +0000238
Bram Moolenaar48e697e2016-01-23 22:17:30 +0100239static int get_string_tv(char_u **arg, typval_T *rettv, int evaluate);
240static int get_lit_string_tv(char_u **arg, typval_T *rettv, int evaluate);
Bram Moolenaar48e697e2016-01-23 22:17:30 +0100241static int free_unref_items(int copyID);
Bram Moolenaar48e697e2016-01-23 22:17:30 +0100242static int get_env_tv(char_u **arg, typval_T *rettv, int evaluate);
Bram Moolenaar48e697e2016-01-23 22:17:30 +0100243static int get_env_len(char_u **arg);
Bram Moolenaar48e697e2016-01-23 22:17:30 +0100244static char_u * make_expanded_name(char_u *in_start, char_u *expr_start, char_u *expr_end, char_u *in_end);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200245static void check_vars(char_u *name, int len);
Bram Moolenaar48e697e2016-01-23 22:17:30 +0100246static typval_T *alloc_string_tv(char_u *string);
Bram Moolenaar48e697e2016-01-23 22:17:30 +0100247static void delete_var(hashtab_T *ht, hashitem_T *hi);
Bram Moolenaar32526b32019-01-19 17:43:09 +0100248static void list_one_var(dictitem_T *v, char *prefix, int *first);
249static void list_one_var_a(char *prefix, char_u *name, int type, char_u *string, int *first);
Bram Moolenaar05c00c02019-02-11 22:00:11 +0100250static int tv_check_lock(typval_T *tv, char_u *name, int use_gettext);
Bram Moolenaar48e697e2016-01-23 22:17:30 +0100251static char_u *find_option_end(char_u **arg, int *opt_flags);
Bram Moolenaar2c704a72010-06-03 21:17:25 +0200252
Bram Moolenaar73dad1e2016-07-17 22:13:49 +0200253/* for VIM_VERSION_ defines */
254#include "version.h"
255
Bram Moolenaare21c1582019-03-02 11:57:09 +0100256/*
257 * Return "n1" divided by "n2", taking care of dividing by zero.
258 */
259 static varnumber_T
260num_divide(varnumber_T n1, varnumber_T n2)
261{
262 varnumber_T result;
263
264 if (n2 == 0) // give an error message?
265 {
266 if (n1 == 0)
267 result = VARNUM_MIN; // similar to NaN
268 else if (n1 < 0)
269 result = -VARNUM_MAX;
270 else
271 result = VARNUM_MAX;
272 }
273 else
274 result = n1 / n2;
275
276 return result;
277}
278
279/*
280 * Return "n1" modulus "n2", taking care of dividing by zero.
281 */
282 static varnumber_T
283num_modulus(varnumber_T n1, varnumber_T n2)
284{
285 // Give an error when n2 is 0?
286 return (n2 == 0) ? 0 : (n1 % n2);
287}
288
Bram Moolenaara1fa8922017-01-12 20:06:33 +0100289
290#if defined(EBCDIC) || defined(PROTO)
291/*
292 * Compare struct fst by function name.
293 */
294 static int
295compare_func_name(const void *s1, const void *s2)
296{
297 struct fst *p1 = (struct fst *)s1;
298 struct fst *p2 = (struct fst *)s2;
299
300 return STRCMP(p1->f_name, p2->f_name);
301}
302
303/*
304 * Sort the function table by function name.
Bram Moolenaarb5443cc2019-01-15 20:19:40 +0100305 * The sorting of the table above is ASCII dependent.
Bram Moolenaara1fa8922017-01-12 20:06:33 +0100306 * On machines using EBCDIC we have to sort it.
307 */
308 static void
309sortFunctions(void)
310{
311 int funcCnt = (int)(sizeof(functions) / sizeof(struct fst)) - 1;
312
313 qsort(functions, (size_t)funcCnt, sizeof(struct fst), compare_func_name);
314}
315#endif
316
317
Bram Moolenaar33570922005-01-25 22:26:29 +0000318/*
319 * Initialize the global and v: variables.
Bram Moolenaara7043832005-01-21 11:56:39 +0000320 */
321 void
Bram Moolenaar7454a062016-01-30 15:14:10 +0100322eval_init(void)
Bram Moolenaara7043832005-01-21 11:56:39 +0000323{
Bram Moolenaar33570922005-01-25 22:26:29 +0000324 int i;
325 struct vimvar *p;
326
Bram Moolenaarbdb62052012-07-16 17:31:53 +0200327 init_var_dict(&globvardict, &globvars_var, VAR_DEF_SCOPE);
328 init_var_dict(&vimvardict, &vimvars_var, VAR_SCOPE);
Bram Moolenaar32f649e2011-04-11 13:46:13 +0200329 vimvardict.dv_lock = VAR_FIXED;
Bram Moolenaar532c7802005-01-27 14:44:31 +0000330 hash_init(&compat_hashtab);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200331 func_init();
Bram Moolenaar33570922005-01-25 22:26:29 +0000332
333 for (i = 0; i < VV_LEN; ++i)
334 {
335 p = &vimvars[i];
Bram Moolenaaref9d9b92016-03-28 22:44:50 +0200336 if (STRLEN(p->vv_name) > 16)
337 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100338 iemsg("INTERNAL: name too long, increase size of dictitem16_T");
Bram Moolenaaref9d9b92016-03-28 22:44:50 +0200339 getout(1);
340 }
Bram Moolenaar33570922005-01-25 22:26:29 +0000341 STRCPY(p->vv_di.di_key, p->vv_name);
342 if (p->vv_flags & VV_RO)
343 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
344 else if (p->vv_flags & VV_RO_SBX)
345 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
346 else
347 p->vv_di.di_flags = DI_FLAGS_FIX;
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +0000348
349 /* add to v: scope dict, unless the value is not always available */
350 if (p->vv_type != VAR_UNKNOWN)
351 hash_add(&vimvarht, p->vv_di.di_key);
Bram Moolenaar33570922005-01-25 22:26:29 +0000352 if (p->vv_flags & VV_COMPAT)
Bram Moolenaar532c7802005-01-27 14:44:31 +0000353 /* add to compat scope dict */
354 hash_add(&compat_hashtab, p->vv_di.di_key);
Bram Moolenaar33570922005-01-25 22:26:29 +0000355 }
Bram Moolenaara542c682016-01-31 16:28:04 +0100356 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
357
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000358 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
Bram Moolenaar8050efa2013-11-08 04:30:20 +0100359 set_vim_var_nr(VV_HLSEARCH, 1L);
Bram Moolenaar7e1652c2017-12-16 18:27:02 +0100360 set_vim_var_dict(VV_COMPLETED_ITEM, dict_alloc_lock(VAR_FIXED));
Bram Moolenaar4649ded2015-12-03 14:55:55 +0100361 set_vim_var_list(VV_ERRORS, list_alloc());
Bram Moolenaar7e1652c2017-12-16 18:27:02 +0100362 set_vim_var_dict(VV_EVENT, dict_alloc_lock(VAR_FIXED));
Bram Moolenaar520e1e42016-01-23 19:46:28 +0100363
364 set_vim_var_nr(VV_FALSE, VVAL_FALSE);
365 set_vim_var_nr(VV_TRUE, VVAL_TRUE);
366 set_vim_var_nr(VV_NONE, VVAL_NONE);
367 set_vim_var_nr(VV_NULL, VVAL_NULL);
368
Bram Moolenaarf562e722016-07-19 17:25:25 +0200369 set_vim_var_nr(VV_TYPE_NUMBER, VAR_TYPE_NUMBER);
370 set_vim_var_nr(VV_TYPE_STRING, VAR_TYPE_STRING);
371 set_vim_var_nr(VV_TYPE_FUNC, VAR_TYPE_FUNC);
372 set_vim_var_nr(VV_TYPE_LIST, VAR_TYPE_LIST);
373 set_vim_var_nr(VV_TYPE_DICT, VAR_TYPE_DICT);
374 set_vim_var_nr(VV_TYPE_FLOAT, VAR_TYPE_FLOAT);
375 set_vim_var_nr(VV_TYPE_BOOL, VAR_TYPE_BOOL);
376 set_vim_var_nr(VV_TYPE_NONE, VAR_TYPE_NONE);
377 set_vim_var_nr(VV_TYPE_JOB, VAR_TYPE_JOB);
378 set_vim_var_nr(VV_TYPE_CHANNEL, VAR_TYPE_CHANNEL);
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +0100379 set_vim_var_nr(VV_TYPE_BLOB, VAR_TYPE_BLOB);
Bram Moolenaarf562e722016-07-19 17:25:25 +0200380
Bram Moolenaarb429cde2012-04-25 18:24:29 +0200381 set_reg_var(0); /* default for v:register is not 0 but '"' */
Bram Moolenaar2c704a72010-06-03 21:17:25 +0200382
383#ifdef EBCDIC
384 /*
Bram Moolenaar195ea0f2011-11-30 14:57:31 +0100385 * Sort the function table, to enable binary search.
Bram Moolenaar2c704a72010-06-03 21:17:25 +0200386 */
387 sortFunctions();
388#endif
Bram Moolenaara7043832005-01-21 11:56:39 +0000389}
390
Bram Moolenaar29a1c1d2005-06-24 23:11:15 +0000391#if defined(EXITFREE) || defined(PROTO)
392 void
Bram Moolenaar7454a062016-01-30 15:14:10 +0100393eval_clear(void)
Bram Moolenaar29a1c1d2005-06-24 23:11:15 +0000394{
395 int i;
396 struct vimvar *p;
397
398 for (i = 0; i < VV_LEN; ++i)
399 {
400 p = &vimvars[i];
401 if (p->vv_di.di_tv.v_type == VAR_STRING)
Bram Moolenaard23a8232018-02-10 18:45:26 +0100402 VIM_CLEAR(p->vv_str);
Bram Moolenaard812df62008-11-09 12:46:09 +0000403 else if (p->vv_di.di_tv.v_type == VAR_LIST)
404 {
405 list_unref(p->vv_list);
406 p->vv_list = NULL;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000407 }
Bram Moolenaar29a1c1d2005-06-24 23:11:15 +0000408 }
409 hash_clear(&vimvarht);
Bram Moolenaar0f71c6d2008-11-12 14:29:28 +0000410 hash_init(&vimvarht); /* garbage_collect() will access it */
Bram Moolenaar29a1c1d2005-06-24 23:11:15 +0000411 hash_clear(&compat_hashtab);
412
Bram Moolenaard9fba312005-06-26 22:34:35 +0000413 free_scriptnames();
Bram Moolenaarb2c5a5a2013-02-14 22:11:39 +0100414# if defined(FEAT_CMDL_COMPL)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +0200415 free_locales();
Bram Moolenaarb2c5a5a2013-02-14 22:11:39 +0100416# endif
Bram Moolenaar29a1c1d2005-06-24 23:11:15 +0000417
418 /* global variables */
419 vars_clear(&globvarht);
Bram Moolenaard9fba312005-06-26 22:34:35 +0000420
Bram Moolenaaraa35dd12006-04-29 22:03:41 +0000421 /* autoloaded script names */
422 ga_clear_strings(&ga_loaded);
423
Bram Moolenaarcca74132013-09-25 21:00:28 +0200424 /* Script-local variables. First clear all the variables and in a second
425 * loop free the scriptvar_T, because a variable in one script might hold
426 * a reference to the whole scope of another script. */
Bram Moolenaar9577c3e2010-05-14 12:16:25 +0200427 for (i = 1; i <= ga_scripts.ga_len; ++i)
Bram Moolenaar9577c3e2010-05-14 12:16:25 +0200428 vars_clear(&SCRIPT_VARS(i));
Bram Moolenaarcca74132013-09-25 21:00:28 +0200429 for (i = 1; i <= ga_scripts.ga_len; ++i)
Bram Moolenaar9577c3e2010-05-14 12:16:25 +0200430 vim_free(SCRIPT_SV(i));
Bram Moolenaar9577c3e2010-05-14 12:16:25 +0200431 ga_clear(&ga_scripts);
432
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +0000433 /* unreferenced lists and dicts */
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +0200434 (void)garbage_collect(FALSE);
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000435
436 /* functions */
437 free_all_functions();
Bram Moolenaar29a1c1d2005-06-24 23:11:15 +0000438}
439#endif
440
Bram Moolenaar071d4272004-06-13 20:20:40 +0000441
442/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000443 * Set an internal variable to a string value. Creates the variable if it does
444 * not already exist.
445 */
446 void
Bram Moolenaarb7604cc2016-01-15 21:23:22 +0100447set_internal_string_var(char_u *name, char_u *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000448{
Bram Moolenaar49cd9572005-01-03 21:06:01 +0000449 char_u *val;
Bram Moolenaar33570922005-01-25 22:26:29 +0000450 typval_T *tvp;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000451
452 val = vim_strsave(value);
453 if (val != NULL)
454 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +0000455 tvp = alloc_string_tv(val);
Bram Moolenaar49cd9572005-01-03 21:06:01 +0000456 if (tvp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000457 {
Bram Moolenaar49cd9572005-01-03 21:06:01 +0000458 set_var(name, tvp, FALSE);
Bram Moolenaarc70646c2005-01-04 21:52:38 +0000459 free_tv(tvp);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000460 }
461 }
462}
463
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000464static lval_T *redir_lval = NULL;
Bram Moolenaar1e5e1232016-07-07 17:33:02 +0200465#define EVALCMD_BUSY (redir_lval == (lval_T *)&redir_lval)
Bram Moolenaar863b53b2007-01-14 14:28:34 +0000466static garray_T redir_ga; /* only valid when redir_lval is not NULL */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000467static char_u *redir_endp = NULL;
468static char_u *redir_varname = NULL;
469
470/*
471 * Start recording command output to a variable
Bram Moolenaarb7604cc2016-01-15 21:23:22 +0100472 * When "append" is TRUE append to an existing variable.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000473 * Returns OK if successfully completed the setup. FAIL otherwise.
474 */
475 int
Bram Moolenaarb7604cc2016-01-15 21:23:22 +0100476var_redir_start(char_u *name, int append)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000477{
478 int save_emsg;
479 int err;
480 typval_T tv;
481
Bram Moolenaar2f59b5c2009-11-03 13:26:55 +0000482 /* Catch a bad name early. */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +0000483 if (!eval_isnamec1(*name))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000484 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100485 emsg(_(e_invarg));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000486 return FAIL;
487 }
488
Bram Moolenaar2f59b5c2009-11-03 13:26:55 +0000489 /* Make a copy of the name, it is used in redir_lval until redir ends. */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000490 redir_varname = vim_strsave(name);
491 if (redir_varname == NULL)
492 return FAIL;
493
494 redir_lval = (lval_T *)alloc_clear((unsigned)sizeof(lval_T));
495 if (redir_lval == NULL)
496 {
497 var_redir_stop();
498 return FAIL;
499 }
500
Bram Moolenaar863b53b2007-01-14 14:28:34 +0000501 /* The output is stored in growarray "redir_ga" until redirection ends. */
502 ga_init2(&redir_ga, (int)sizeof(char), 500);
503
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000504 /* Parse the variable name (can be a dict or list entry). */
Bram Moolenaar6d977d62014-01-14 15:24:39 +0100505 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, 0,
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +0000506 FNE_CHECK_START);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000507 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
508 {
Bram Moolenaar1dba0fb2010-07-28 18:55:02 +0200509 clear_lval(redir_lval);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000510 if (redir_endp != NULL && *redir_endp != NUL)
511 /* Trailing characters are present after the variable name */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100512 emsg(_(e_trailing));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000513 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100514 emsg(_(e_invarg));
Bram Moolenaar2f59b5c2009-11-03 13:26:55 +0000515 redir_endp = NULL; /* don't store a value, only cleanup */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000516 var_redir_stop();
517 return FAIL;
518 }
519
520 /* check if we can write to the variable: set it to or append an empty
521 * string */
522 save_emsg = did_emsg;
523 did_emsg = FALSE;
524 tv.v_type = VAR_STRING;
525 tv.vval.v_string = (char_u *)"";
526 if (append)
527 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)".");
528 else
529 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)"=");
Bram Moolenaar1dba0fb2010-07-28 18:55:02 +0200530 clear_lval(redir_lval);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000531 err = did_emsg;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +0000532 did_emsg |= save_emsg;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000533 if (err)
534 {
Bram Moolenaar2f59b5c2009-11-03 13:26:55 +0000535 redir_endp = NULL; /* don't store a value, only cleanup */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000536 var_redir_stop();
537 return FAIL;
538 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000539
540 return OK;
541}
542
543/*
Bram Moolenaar863b53b2007-01-14 14:28:34 +0000544 * Append "value[value_len]" to the variable set by var_redir_start().
545 * The actual appending is postponed until redirection ends, because the value
546 * appended may in fact be the string we write to, changing it may cause freed
547 * memory to be used:
548 * :redir => foo
549 * :let foo
550 * :redir END
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000551 */
552 void
Bram Moolenaarb7604cc2016-01-15 21:23:22 +0100553var_redir_str(char_u *value, int value_len)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000554{
Bram Moolenaar5fdec472007-07-24 08:45:13 +0000555 int len;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000556
557 if (redir_lval == NULL)
558 return;
559
Bram Moolenaar863b53b2007-01-14 14:28:34 +0000560 if (value_len == -1)
Bram Moolenaar5fdec472007-07-24 08:45:13 +0000561 len = (int)STRLEN(value); /* Append the entire string */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000562 else
Bram Moolenaar5fdec472007-07-24 08:45:13 +0000563 len = value_len; /* Append only "value_len" characters */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000564
Bram Moolenaar5fdec472007-07-24 08:45:13 +0000565 if (ga_grow(&redir_ga, len) == OK)
Bram Moolenaar863b53b2007-01-14 14:28:34 +0000566 {
567 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
Bram Moolenaar5fdec472007-07-24 08:45:13 +0000568 redir_ga.ga_len += len;
Bram Moolenaar863b53b2007-01-14 14:28:34 +0000569 }
570 else
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000571 var_redir_stop();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000572}
573
574/*
575 * Stop redirecting command output to a variable.
Bram Moolenaar2f59b5c2009-11-03 13:26:55 +0000576 * Frees the allocated memory.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000577 */
578 void
Bram Moolenaar7454a062016-01-30 15:14:10 +0100579var_redir_stop(void)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000580{
Bram Moolenaar863b53b2007-01-14 14:28:34 +0000581 typval_T tv;
582
Bram Moolenaar1e5e1232016-07-07 17:33:02 +0200583 if (EVALCMD_BUSY)
584 {
585 redir_lval = NULL;
586 return;
587 }
588
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000589 if (redir_lval != NULL)
590 {
Bram Moolenaar2f59b5c2009-11-03 13:26:55 +0000591 /* If there was no error: assign the text to the variable. */
592 if (redir_endp != NULL)
593 {
594 ga_append(&redir_ga, NUL); /* Append the trailing NUL. */
595 tv.v_type = VAR_STRING;
596 tv.vval.v_string = redir_ga.ga_data;
Bram Moolenaar1dba0fb2010-07-28 18:55:02 +0200597 /* Call get_lval() again, if it's inside a Dict or List it may
598 * have changed. */
599 redir_endp = get_lval(redir_varname, NULL, redir_lval,
Bram Moolenaar6d977d62014-01-14 15:24:39 +0100600 FALSE, FALSE, 0, FNE_CHECK_START);
Bram Moolenaar1dba0fb2010-07-28 18:55:02 +0200601 if (redir_endp != NULL && redir_lval->ll_name != NULL)
602 set_var_lval(redir_lval, redir_endp, &tv, FALSE, (char_u *)".");
603 clear_lval(redir_lval);
Bram Moolenaar2f59b5c2009-11-03 13:26:55 +0000604 }
Bram Moolenaar863b53b2007-01-14 14:28:34 +0000605
Bram Moolenaar2f59b5c2009-11-03 13:26:55 +0000606 /* free the collected output */
Bram Moolenaard23a8232018-02-10 18:45:26 +0100607 VIM_CLEAR(redir_ga.ga_data);
Bram Moolenaar863b53b2007-01-14 14:28:34 +0000608
Bram Moolenaard23a8232018-02-10 18:45:26 +0100609 VIM_CLEAR(redir_lval);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000610 }
Bram Moolenaard23a8232018-02-10 18:45:26 +0100611 VIM_CLEAR(redir_varname);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000612}
613
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614 int
Bram Moolenaarb7604cc2016-01-15 21:23:22 +0100615eval_charconvert(
616 char_u *enc_from,
617 char_u *enc_to,
618 char_u *fname_from,
619 char_u *fname_to)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620{
621 int err = FALSE;
622
623 set_vim_var_string(VV_CC_FROM, enc_from, -1);
624 set_vim_var_string(VV_CC_TO, enc_to, -1);
625 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
626 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
627 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
628 err = TRUE;
629 set_vim_var_string(VV_CC_FROM, NULL, -1);
630 set_vim_var_string(VV_CC_TO, NULL, -1);
631 set_vim_var_string(VV_FNAME_IN, NULL, -1);
632 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
633
634 if (err)
635 return FAIL;
636 return OK;
637}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000638
639# if defined(FEAT_POSTSCRIPT) || defined(PROTO)
640 int
Bram Moolenaar7454a062016-01-30 15:14:10 +0100641eval_printexpr(char_u *fname, char_u *args)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642{
643 int err = FALSE;
644
645 set_vim_var_string(VV_FNAME_IN, fname, -1);
646 set_vim_var_string(VV_CMDARG, args, -1);
647 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
648 err = TRUE;
649 set_vim_var_string(VV_FNAME_IN, NULL, -1);
650 set_vim_var_string(VV_CMDARG, NULL, -1);
651
652 if (err)
653 {
654 mch_remove(fname);
655 return FAIL;
656 }
657 return OK;
658}
659# endif
660
661# if defined(FEAT_DIFF) || defined(PROTO)
662 void
Bram Moolenaar7454a062016-01-30 15:14:10 +0100663eval_diff(
664 char_u *origfile,
665 char_u *newfile,
666 char_u *outfile)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667{
668 int err = FALSE;
669
670 set_vim_var_string(VV_FNAME_IN, origfile, -1);
671 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
672 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
673 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
674 set_vim_var_string(VV_FNAME_IN, NULL, -1);
675 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
676 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
677}
678
679 void
Bram Moolenaar7454a062016-01-30 15:14:10 +0100680eval_patch(
681 char_u *origfile,
682 char_u *difffile,
683 char_u *outfile)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684{
685 int err;
686
687 set_vim_var_string(VV_FNAME_IN, origfile, -1);
688 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
689 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
690 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
691 set_vim_var_string(VV_FNAME_IN, NULL, -1);
692 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
693 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
694}
695# endif
696
697/*
698 * Top level evaluation function, returning a boolean.
699 * Sets "error" to TRUE if there was an error.
700 * Return TRUE or FALSE.
701 */
702 int
Bram Moolenaar7454a062016-01-30 15:14:10 +0100703eval_to_bool(
704 char_u *arg,
705 int *error,
706 char_u **nextcmd,
707 int skip) /* only parse, don't execute */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708{
Bram Moolenaar33570922005-01-25 22:26:29 +0000709 typval_T tv;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +0200710 varnumber_T retval = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000711
712 if (skip)
713 ++emsg_skip;
Bram Moolenaarc70646c2005-01-04 21:52:38 +0000714 if (eval0(arg, &tv, nextcmd, !skip) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715 *error = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716 else
717 {
718 *error = FALSE;
719 if (!skip)
720 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +0100721 retval = (tv_get_number_chk(&tv, error) != 0);
Bram Moolenaarc70646c2005-01-04 21:52:38 +0000722 clear_tv(&tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 }
724 }
725 if (skip)
726 --emsg_skip;
727
Bram Moolenaar22fcfad2016-07-01 18:17:26 +0200728 return (int)retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000729}
730
Bram Moolenaarce9d50d2019-01-14 22:22:29 +0100731/*
732 * Call eval1() and give an error message if not done at a lower level.
733 */
734 static int
735eval1_emsg(char_u **arg, typval_T *rettv, int evaluate)
736{
Bram Moolenaar6acc79f2019-01-14 22:53:31 +0100737 char_u *start = *arg;
Bram Moolenaarce9d50d2019-01-14 22:22:29 +0100738 int ret;
739 int did_emsg_before = did_emsg;
740 int called_emsg_before = called_emsg;
741
742 ret = eval1(arg, rettv, evaluate);
743 if (ret == FAIL)
744 {
745 // Report the invalid expression unless the expression evaluation has
746 // been cancelled due to an aborting error, an interrupt, or an
747 // exception, or we already gave a more specific error.
748 // Also check called_emsg for when using assert_fails().
749 if (!aborting() && did_emsg == did_emsg_before
750 && called_emsg == called_emsg_before)
Bram Moolenaar6acc79f2019-01-14 22:53:31 +0100751 semsg(_(e_invexpr2), start);
Bram Moolenaarce9d50d2019-01-14 22:22:29 +0100752 }
753 return ret;
754}
755
Bram Moolenaar543c9b12019-04-05 22:50:40 +0200756 int
Bram Moolenaar48570482017-10-30 21:48:41 +0100757eval_expr_typval(typval_T *expr, typval_T *argv, int argc, typval_T *rettv)
758{
759 char_u *s;
760 int dummy;
761 char_u buf[NUMBUFLEN];
762
763 if (expr->v_type == VAR_FUNC)
764 {
765 s = expr->vval.v_string;
766 if (s == NULL || *s == NUL)
767 return FAIL;
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200768 if (call_func(s, -1, rettv, argc, argv, NULL,
Bram Moolenaar48570482017-10-30 21:48:41 +0100769 0L, 0L, &dummy, TRUE, NULL, NULL) == FAIL)
770 return FAIL;
771 }
772 else if (expr->v_type == VAR_PARTIAL)
773 {
774 partial_T *partial = expr->vval.v_partial;
775
776 s = partial_name(partial);
777 if (s == NULL || *s == NUL)
778 return FAIL;
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200779 if (call_func(s, -1, rettv, argc, argv, NULL,
Bram Moolenaar48570482017-10-30 21:48:41 +0100780 0L, 0L, &dummy, TRUE, partial, NULL) == FAIL)
781 return FAIL;
782 }
783 else
784 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +0100785 s = tv_get_string_buf_chk(expr, buf);
Bram Moolenaar48570482017-10-30 21:48:41 +0100786 if (s == NULL)
787 return FAIL;
788 s = skipwhite(s);
Bram Moolenaarce9d50d2019-01-14 22:22:29 +0100789 if (eval1_emsg(&s, rettv, TRUE) == FAIL)
Bram Moolenaar48570482017-10-30 21:48:41 +0100790 return FAIL;
791 if (*s != NUL) /* check for trailing chars after expr */
792 {
Bram Moolenaara43ebe92018-07-14 17:25:01 +0200793 clear_tv(rettv);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100794 semsg(_(e_invexpr2), s);
Bram Moolenaar48570482017-10-30 21:48:41 +0100795 return FAIL;
796 }
797 }
798 return OK;
799}
800
801/*
802 * Like eval_to_bool() but using a typval_T instead of a string.
803 * Works for string, funcref and partial.
804 */
805 int
806eval_expr_to_bool(typval_T *expr, int *error)
807{
808 typval_T rettv;
809 int res;
810
811 if (eval_expr_typval(expr, NULL, 0, &rettv) == FAIL)
812 {
813 *error = TRUE;
814 return FALSE;
815 }
Bram Moolenaard155d7a2018-12-21 16:04:21 +0100816 res = (tv_get_number_chk(&rettv, error) != 0);
Bram Moolenaar48570482017-10-30 21:48:41 +0100817 clear_tv(&rettv);
818 return res;
819}
820
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821/*
822 * Top level evaluation function, returning a string. If "skip" is TRUE,
823 * only parsing to "nextcmd" is done, without reporting errors. Return
824 * pointer to allocated memory, or NULL for failure or when "skip" is TRUE.
825 */
826 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +0100827eval_to_string_skip(
828 char_u *arg,
829 char_u **nextcmd,
830 int skip) /* only parse, don't execute */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831{
Bram Moolenaar33570922005-01-25 22:26:29 +0000832 typval_T tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 char_u *retval;
834
835 if (skip)
836 ++emsg_skip;
Bram Moolenaarc70646c2005-01-04 21:52:38 +0000837 if (eval0(arg, &tv, nextcmd, !skip) == FAIL || skip)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000838 retval = NULL;
839 else
840 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +0100841 retval = vim_strsave(tv_get_string(&tv));
Bram Moolenaarc70646c2005-01-04 21:52:38 +0000842 clear_tv(&tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843 }
844 if (skip)
845 --emsg_skip;
846
847 return retval;
848}
849
850/*
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000851 * Skip over an expression at "*pp".
852 * Return FAIL for an error, OK otherwise.
853 */
854 int
Bram Moolenaar7454a062016-01-30 15:14:10 +0100855skip_expr(char_u **pp)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000856{
Bram Moolenaar33570922005-01-25 22:26:29 +0000857 typval_T rettv;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000858
859 *pp = skipwhite(*pp);
Bram Moolenaarc70646c2005-01-04 21:52:38 +0000860 return eval1(pp, &rettv, FALSE);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000861}
862
863/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 * Top level evaluation function, returning a string.
Bram Moolenaara85fb752008-09-07 11:55:43 +0000865 * When "convert" is TRUE convert a List into a sequence of lines and convert
866 * a Float to a String.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 * Return pointer to allocated memory, or NULL for failure.
868 */
869 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +0100870eval_to_string(
871 char_u *arg,
872 char_u **nextcmd,
873 int convert)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874{
Bram Moolenaar33570922005-01-25 22:26:29 +0000875 typval_T tv;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000876 char_u *retval;
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000877 garray_T ga;
Bram Moolenaar798b30b2009-04-22 10:56:16 +0000878#ifdef FEAT_FLOAT
Bram Moolenaara85fb752008-09-07 11:55:43 +0000879 char_u numbuf[NUMBUFLEN];
Bram Moolenaar798b30b2009-04-22 10:56:16 +0000880#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000881
Bram Moolenaarc70646c2005-01-04 21:52:38 +0000882 if (eval0(arg, &tv, nextcmd, TRUE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 retval = NULL;
884 else
885 {
Bram Moolenaara85fb752008-09-07 11:55:43 +0000886 if (convert && tv.v_type == VAR_LIST)
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000887 {
888 ga_init2(&ga, (int)sizeof(char), 80);
Bram Moolenaar9bf749b2008-07-27 13:57:29 +0000889 if (tv.vval.v_list != NULL)
Bram Moolenaar213b10a2011-08-10 12:38:08 +0200890 {
Bram Moolenaar18dfb442016-05-31 22:31:23 +0200891 list_join(&ga, tv.vval.v_list, (char_u *)"\n", TRUE, FALSE, 0);
Bram Moolenaar213b10a2011-08-10 12:38:08 +0200892 if (tv.vval.v_list->lv_len > 0)
893 ga_append(&ga, NL);
894 }
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000895 ga_append(&ga, NUL);
896 retval = (char_u *)ga.ga_data;
897 }
Bram Moolenaara85fb752008-09-07 11:55:43 +0000898#ifdef FEAT_FLOAT
899 else if (convert && tv.v_type == VAR_FLOAT)
900 {
901 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv.vval.v_float);
902 retval = vim_strsave(numbuf);
903 }
904#endif
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000905 else
Bram Moolenaard155d7a2018-12-21 16:04:21 +0100906 retval = vim_strsave(tv_get_string(&tv));
Bram Moolenaarc70646c2005-01-04 21:52:38 +0000907 clear_tv(&tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000908 }
909
910 return retval;
911}
912
913/*
Bram Moolenaarb71eaae2006-01-20 23:10:18 +0000914 * Call eval_to_string() without using current local variables and using
915 * textlock. When "use_sandbox" is TRUE use the sandbox.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916 */
917 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +0100918eval_to_string_safe(
919 char_u *arg,
920 char_u **nextcmd,
921 int use_sandbox)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922{
923 char_u *retval;
Bram Moolenaar27e80c82018-10-14 21:41:01 +0200924 funccal_entry_T funccal_entry;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925
Bram Moolenaar27e80c82018-10-14 21:41:01 +0200926 save_funccal(&funccal_entry);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +0000927 if (use_sandbox)
928 ++sandbox;
929 ++textlock;
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000930 retval = eval_to_string(arg, nextcmd, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +0000931 if (use_sandbox)
932 --sandbox;
933 --textlock;
Bram Moolenaar27e80c82018-10-14 21:41:01 +0200934 restore_funccal();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935 return retval;
936}
937
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938/*
939 * Top level evaluation function, returning a number.
940 * Evaluates "expr" silently.
941 * Returns -1 for an error.
942 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +0200943 varnumber_T
Bram Moolenaar7454a062016-01-30 15:14:10 +0100944eval_to_number(char_u *expr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945{
Bram Moolenaar33570922005-01-25 22:26:29 +0000946 typval_T rettv;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +0200947 varnumber_T retval;
Bram Moolenaar31c67ef2005-01-11 21:34:41 +0000948 char_u *p = skipwhite(expr);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000949
950 ++emsg_off;
951
Bram Moolenaarc70646c2005-01-04 21:52:38 +0000952 if (eval1(&p, &rettv, TRUE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000953 retval = -1;
954 else
955 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +0100956 retval = tv_get_number_chk(&rettv, NULL);
Bram Moolenaarc70646c2005-01-04 21:52:38 +0000957 clear_tv(&rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000958 }
959 --emsg_off;
960
961 return retval;
962}
963
Bram Moolenaara40058a2005-07-11 22:42:07 +0000964/*
965 * Prepare v: variable "idx" to be used.
966 * Save the current typeval in "save_tv".
967 * When not used yet add the variable to the v: hashtable.
968 */
Bram Moolenaar543c9b12019-04-05 22:50:40 +0200969 void
Bram Moolenaar7454a062016-01-30 15:14:10 +0100970prepare_vimvar(int idx, typval_T *save_tv)
Bram Moolenaara40058a2005-07-11 22:42:07 +0000971{
972 *save_tv = vimvars[idx].vv_tv;
973 if (vimvars[idx].vv_type == VAR_UNKNOWN)
974 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
975}
976
977/*
978 * Restore v: variable "idx" to typeval "save_tv".
979 * When no longer defined, remove the variable from the v: hashtable.
980 */
Bram Moolenaar543c9b12019-04-05 22:50:40 +0200981 void
Bram Moolenaar7454a062016-01-30 15:14:10 +0100982restore_vimvar(int idx, typval_T *save_tv)
Bram Moolenaara40058a2005-07-11 22:42:07 +0000983{
984 hashitem_T *hi;
985
Bram Moolenaara40058a2005-07-11 22:42:07 +0000986 vimvars[idx].vv_tv = *save_tv;
987 if (vimvars[idx].vv_type == VAR_UNKNOWN)
988 {
989 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
990 if (HASHITEM_EMPTY(hi))
Bram Moolenaar95f09602016-11-10 20:01:45 +0100991 internal_error("restore_vimvar()");
Bram Moolenaara40058a2005-07-11 22:42:07 +0000992 else
993 hash_remove(&vimvarht, hi);
994 }
995}
996
Bram Moolenaar3c56a962006-03-12 22:19:04 +0000997#if defined(FEAT_SPELL) || defined(PROTO)
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +0000998/*
999 * Evaluate an expression to a list with suggestions.
1000 * For the "expr:" part of 'spellsuggest'.
Bram Moolenaar9bf749b2008-07-27 13:57:29 +00001001 * Returns NULL when there is an error.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001002 */
1003 list_T *
Bram Moolenaar7454a062016-01-30 15:14:10 +01001004eval_spell_expr(char_u *badword, char_u *expr)
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001005{
1006 typval_T save_val;
1007 typval_T rettv;
1008 list_T *list = NULL;
1009 char_u *p = skipwhite(expr);
1010
1011 /* Set "v:val" to the bad word. */
1012 prepare_vimvar(VV_VAL, &save_val);
1013 vimvars[VV_VAL].vv_type = VAR_STRING;
1014 vimvars[VV_VAL].vv_str = badword;
1015 if (p_verbose == 0)
1016 ++emsg_off;
1017
1018 if (eval1(&p, &rettv, TRUE) == OK)
1019 {
1020 if (rettv.v_type != VAR_LIST)
1021 clear_tv(&rettv);
1022 else
1023 list = rettv.vval.v_list;
1024 }
1025
1026 if (p_verbose == 0)
1027 --emsg_off;
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001028 restore_vimvar(VV_VAL, &save_val);
1029
1030 return list;
1031}
1032
1033/*
1034 * "list" is supposed to contain two items: a word and a number. Return the
1035 * word in "pp" and the number as the return value.
1036 * Return -1 if anything isn't right.
1037 * Used to get the good word and score from the eval_spell_expr() result.
1038 */
1039 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01001040get_spellword(list_T *list, char_u **pp)
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001041{
1042 listitem_T *li;
1043
1044 li = list->lv_first;
1045 if (li == NULL)
1046 return -1;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001047 *pp = tv_get_string(&li->li_tv);
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001048
1049 li = li->li_next;
1050 if (li == NULL)
1051 return -1;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001052 return (int)tv_get_number(&li->li_tv);
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001053}
1054#endif
1055
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001056/*
Bram Moolenaar4770d092006-01-12 23:22:24 +00001057 * Top level evaluation function.
1058 * Returns an allocated typval_T with the result.
1059 * Returns NULL when there is an error.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001060 */
1061 typval_T *
Bram Moolenaar7454a062016-01-30 15:14:10 +01001062eval_expr(char_u *arg, char_u **nextcmd)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001063{
1064 typval_T *tv;
1065
1066 tv = (typval_T *)alloc(sizeof(typval_T));
Bram Moolenaar4770d092006-01-12 23:22:24 +00001067 if (tv != NULL && eval0(arg, tv, nextcmd, TRUE) == FAIL)
Bram Moolenaard23a8232018-02-10 18:45:26 +01001068 VIM_CLEAR(tv);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001069
1070 return tv;
1071}
1072
1073
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074/*
Bram Moolenaarb544f3c2017-02-23 19:03:28 +01001075 * Call some Vim script function and return the result in "*rettv".
Bram Moolenaarffa96842018-06-12 22:05:14 +02001076 * Uses argv[0] to argv[argc - 1] for the function arguments. argv[argc]
1077 * should have type VAR_UNKNOWN.
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00001078 * Returns OK or FAIL.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079 */
Bram Moolenaar82139082011-09-14 16:52:09 +02001080 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01001081call_vim_function(
1082 char_u *func,
1083 int argc,
Bram Moolenaarffa96842018-06-12 22:05:14 +02001084 typval_T *argv,
Bram Moolenaarded27a12018-08-01 19:06:03 +02001085 typval_T *rettv)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086{
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087 int doesrange;
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00001088 int ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00001090 rettv->v_type = VAR_UNKNOWN; /* clear_tv() uses this */
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001091 ret = call_func(func, -1, rettv, argc, argv, NULL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
Bram Moolenaar1735bc92016-03-14 23:05:14 +01001093 &doesrange, TRUE, NULL, NULL);
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00001094 if (ret == FAIL)
1095 clear_tv(rettv);
1096
1097 return ret;
1098}
1099
Bram Moolenaarb2c5a5a2013-02-14 22:11:39 +01001100/*
Bram Moolenaarb544f3c2017-02-23 19:03:28 +01001101 * Call Vim script function "func" and return the result as a number.
Bram Moolenaarb2c5a5a2013-02-14 22:11:39 +01001102 * Returns -1 when calling the function fails.
Bram Moolenaarffa96842018-06-12 22:05:14 +02001103 * Uses argv[0] to argv[argc - 1] for the function arguments. argv[argc] should
1104 * have type VAR_UNKNOWN.
Bram Moolenaarb2c5a5a2013-02-14 22:11:39 +01001105 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001106 varnumber_T
Bram Moolenaar7454a062016-01-30 15:14:10 +01001107call_func_retnr(
1108 char_u *func,
1109 int argc,
Bram Moolenaarded27a12018-08-01 19:06:03 +02001110 typval_T *argv)
Bram Moolenaarb2c5a5a2013-02-14 22:11:39 +01001111{
1112 typval_T rettv;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001113 varnumber_T retval;
Bram Moolenaarb2c5a5a2013-02-14 22:11:39 +01001114
Bram Moolenaarded27a12018-08-01 19:06:03 +02001115 if (call_vim_function(func, argc, argv, &rettv) == FAIL)
Bram Moolenaarb2c5a5a2013-02-14 22:11:39 +01001116 return -1;
1117
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001118 retval = tv_get_number_chk(&rettv, NULL);
Bram Moolenaarb2c5a5a2013-02-14 22:11:39 +01001119 clear_tv(&rettv);
1120 return retval;
1121}
1122
Bram Moolenaarac9fb182019-04-27 13:04:13 +02001123#if defined(FEAT_CMDL_COMPL) \
Bram Moolenaarb2c5a5a2013-02-14 22:11:39 +01001124 || defined(FEAT_COMPL_FUNC) || defined(PROTO)
1125
Bram Moolenaarac9fb182019-04-27 13:04:13 +02001126# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00001127/*
Bram Moolenaarb544f3c2017-02-23 19:03:28 +01001128 * Call Vim script function "func" and return the result as a string.
Bram Moolenaar25ceb222005-07-30 22:45:36 +00001129 * Returns NULL when calling the function fails.
Bram Moolenaarffa96842018-06-12 22:05:14 +02001130 * Uses argv[0] to argv[argc - 1] for the function arguments. argv[argc] should
1131 * have type VAR_UNKNOWN.
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00001132 */
1133 void *
Bram Moolenaar7454a062016-01-30 15:14:10 +01001134call_func_retstr(
1135 char_u *func,
1136 int argc,
Bram Moolenaarded27a12018-08-01 19:06:03 +02001137 typval_T *argv)
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00001138{
1139 typval_T rettv;
Bram Moolenaar25ceb222005-07-30 22:45:36 +00001140 char_u *retval;
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00001141
Bram Moolenaarded27a12018-08-01 19:06:03 +02001142 if (call_vim_function(func, argc, argv, &rettv) == FAIL)
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00001143 return NULL;
1144
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001145 retval = vim_strsave(tv_get_string(&rettv));
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00001146 clear_tv(&rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147 return retval;
1148}
Bram Moolenaar4f688582007-07-24 12:34:30 +00001149# endif
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00001150
Bram Moolenaar25ceb222005-07-30 22:45:36 +00001151/*
Bram Moolenaarb544f3c2017-02-23 19:03:28 +01001152 * Call Vim script function "func" and return the result as a List.
Bram Moolenaarffa96842018-06-12 22:05:14 +02001153 * Uses argv[0] to argv[argc - 1] for the function arguments. argv[argc] should
1154 * have type VAR_UNKNOWN.
Bram Moolenaar9bf749b2008-07-27 13:57:29 +00001155 * Returns NULL when there is something wrong.
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00001156 */
1157 void *
Bram Moolenaar7454a062016-01-30 15:14:10 +01001158call_func_retlist(
1159 char_u *func,
1160 int argc,
Bram Moolenaarded27a12018-08-01 19:06:03 +02001161 typval_T *argv)
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00001162{
1163 typval_T rettv;
1164
Bram Moolenaarded27a12018-08-01 19:06:03 +02001165 if (call_vim_function(func, argc, argv, &rettv) == FAIL)
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00001166 return NULL;
1167
1168 if (rettv.v_type != VAR_LIST)
1169 {
1170 clear_tv(&rettv);
1171 return NULL;
1172 }
1173
1174 return rettv.vval.v_list;
1175}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176#endif
1177
Bram Moolenaar05159a02005-02-26 23:04:13 +00001178
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179#ifdef FEAT_FOLDING
1180/*
1181 * Evaluate 'foldexpr'. Returns the foldlevel, and any character preceding
1182 * it in "*cp". Doesn't give error messages.
1183 */
1184 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01001185eval_foldexpr(char_u *arg, int *cp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186{
Bram Moolenaar33570922005-01-25 22:26:29 +00001187 typval_T tv;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001188 varnumber_T retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001189 char_u *s;
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001190 int use_sandbox = was_set_insecurely((char_u *)"foldexpr",
1191 OPT_LOCAL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001192
1193 ++emsg_off;
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001194 if (use_sandbox)
1195 ++sandbox;
1196 ++textlock;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197 *cp = NUL;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001198 if (eval0(arg, &tv, NULL, TRUE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199 retval = 0;
1200 else
1201 {
1202 /* If the result is a number, just return the number. */
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001203 if (tv.v_type == VAR_NUMBER)
1204 retval = tv.vval.v_number;
Bram Moolenaar758711c2005-02-02 23:11:38 +00001205 else if (tv.v_type != VAR_STRING || tv.vval.v_string == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001206 retval = 0;
1207 else
1208 {
1209 /* If the result is a string, check if there is a non-digit before
1210 * the number. */
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001211 s = tv.vval.v_string;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001212 if (!VIM_ISDIGIT(*s) && *s != '-')
1213 *cp = *s++;
1214 retval = atol((char *)s);
1215 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001216 clear_tv(&tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001217 }
1218 --emsg_off;
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001219 if (use_sandbox)
1220 --sandbox;
1221 --textlock;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001222
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001223 return (int)retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224}
1225#endif
1226
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227/*
Bram Moolenaarf5842c52019-05-19 18:41:26 +02001228 * Get a list of lines from a HERE document. The here document is a list of
1229 * lines surrounded by a marker.
1230 * cmd << {marker}
1231 * {line1}
1232 * {line2}
1233 * ....
1234 * {marker}
1235 *
1236 * The {marker} is a string. If the optional 'trim' word is supplied before the
1237 * marker, then the leading indentation before the lines (matching the
1238 * indentation in the 'cmd' line) is stripped.
1239 * Returns a List with {lines} or NULL.
1240 */
1241 static list_T *
1242heredoc_get(exarg_T *eap, char_u *cmd)
1243{
1244 char_u *theline;
1245 char_u *marker;
1246 list_T *l;
1247 char_u *p;
1248 int indent_len = 0;
1249
1250 if (eap->getline == NULL)
1251 {
1252 emsg(_("E991: cannot use =<< here"));
1253 return NULL;
1254 }
1255
1256 // Check for the optional 'trim' word before the marker
1257 cmd = skipwhite(cmd);
1258 if (STRNCMP(cmd, "trim", 4) == 0 && (cmd[4] == NUL || VIM_ISWHITE(cmd[4])))
1259 {
1260 cmd = skipwhite(cmd + 4);
1261
1262 // Trim the indentation from all the lines in the here document
1263 // The amount of indentation trimmed is the same as the indentation of
1264 // the :let command line.
1265 p = *eap->cmdlinep;
1266 while (VIM_ISWHITE(*p))
1267 {
1268 p++;
1269 indent_len++;
1270 }
1271 }
1272
1273 // The marker is the next word. Default marker is "."
1274 if (*cmd != NUL && *cmd != '"')
1275 {
1276 marker = skipwhite(cmd);
1277 p = skiptowhite(marker);
1278 if (*skipwhite(p) != NUL && *skipwhite(p) != '"')
1279 {
1280 emsg(_(e_trailing));
1281 return NULL;
1282 }
1283 *p = NUL;
1284 }
1285 else
1286 marker = (char_u *)".";
1287
1288 l = list_alloc();
1289 if (l == NULL)
1290 return NULL;
1291
1292 for (;;)
1293 {
1294 int i = 0;
1295
1296 theline = eap->getline(NUL, eap->cookie, 0);
1297 if (theline != NULL && indent_len > 0)
1298 {
1299 // trim the indent matching the first line
1300 if (STRNCMP(theline, *eap->cmdlinep, indent_len) == 0)
1301 i = indent_len;
1302 }
1303
1304 if (theline == NULL)
1305 {
1306 semsg(_("E990: Missing end marker '%s'"), marker);
1307 break;
1308 }
1309 if (STRCMP(marker, theline + i) == 0)
1310 {
1311 vim_free(theline);
1312 break;
1313 }
1314
1315 if (list_append_string(l, theline + i, -1) == FAIL)
1316 break;
1317 vim_free(theline);
1318 }
1319
1320 return l;
1321}
1322
1323/*
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001324 * ":let" list all variable values
1325 * ":let var1 var2" list variable values
1326 * ":let var = expr" assignment command.
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001327 * ":let var += expr" assignment command.
1328 * ":let var -= expr" assignment command.
Bram Moolenaarff697e62019-02-12 22:28:33 +01001329 * ":let var *= expr" assignment command.
1330 * ":let var /= expr" assignment command.
1331 * ":let var %= expr" assignment command.
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001332 * ":let var .= expr" assignment command.
Bram Moolenaar0f248b02019-04-04 15:36:05 +02001333 * ":let var ..= expr" assignment command.
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001334 * ":let [var1, var2] = expr" unpack list.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001335 */
1336 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01001337ex_let(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001338{
1339 char_u *arg = eap->arg;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001340 char_u *expr = NULL;
Bram Moolenaar33570922005-01-25 22:26:29 +00001341 typval_T rettv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342 int i;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001343 int var_count = 0;
1344 int semicolon = 0;
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001345 char_u op[2];
Bram Moolenaardb552d602006-03-23 22:59:57 +00001346 char_u *argend;
Bram Moolenaar7d61a922007-08-30 09:12:23 +00001347 int first = TRUE;
Bram Moolenaar558ca4a2019-04-04 18:15:38 +02001348 int concat;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001349
Bram Moolenaardb552d602006-03-23 22:59:57 +00001350 argend = skip_var_list(arg, &var_count, &semicolon);
1351 if (argend == NULL)
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001352 return;
Bram Moolenaarff697e62019-02-12 22:28:33 +01001353 if (argend > arg && argend[-1] == '.') // for var.='str'
Bram Moolenaar76b92b22006-03-24 22:46:53 +00001354 --argend;
Bram Moolenaara3920382014-03-30 16:49:09 +02001355 expr = skipwhite(argend);
Bram Moolenaar558ca4a2019-04-04 18:15:38 +02001356 concat = expr[0] == '.'
1357 && ((expr[1] == '=' && current_sctx.sc_version < 2)
1358 || (expr[1] == '.' && expr[2] == '='));
1359 if (*expr != '=' && !((vim_strchr((char_u *)"+-*/%", *expr) != NULL
1360 && expr[1] == '=') || concat))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001361 {
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00001362 /*
1363 * ":let" without "=": list variables
1364 */
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001365 if (*arg == '[')
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001366 emsg(_(e_invarg));
Bram Moolenaar558ca4a2019-04-04 18:15:38 +02001367 else if (expr[0] == '.')
1368 emsg(_("E985: .= is not supported with script version 2"));
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001369 else if (!ends_excmd(*arg))
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001370 /* ":let var1 var2" */
Bram Moolenaar7d61a922007-08-30 09:12:23 +00001371 arg = list_arg_vars(eap, arg, &first);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001372 else if (!eap->skip)
Bram Moolenaara7043832005-01-21 11:56:39 +00001373 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001374 /* ":let" */
Bram Moolenaar7d61a922007-08-30 09:12:23 +00001375 list_glob_vars(&first);
1376 list_buf_vars(&first);
1377 list_win_vars(&first);
Bram Moolenaar7d61a922007-08-30 09:12:23 +00001378 list_tab_vars(&first);
Bram Moolenaar7d61a922007-08-30 09:12:23 +00001379 list_script_vars(&first);
1380 list_func_vars(&first);
1381 list_vim_vars(&first);
Bram Moolenaara7043832005-01-21 11:56:39 +00001382 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001383 eap->nextcmd = check_nextcmd(arg);
1384 }
Bram Moolenaarf5842c52019-05-19 18:41:26 +02001385 else if (expr[0] == '=' && expr[1] == '<' && expr[2] == '<')
1386 {
1387 list_T *l;
1388
1389 // HERE document
1390 l = heredoc_get(eap, expr + 3);
1391 if (l != NULL)
1392 {
1393 rettv_list_set(&rettv, l);
1394 op[0] = '=';
1395 op[1] = NUL;
1396 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
1397 op);
1398 clear_tv(&rettv);
1399 }
1400 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 else
1402 {
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001403 op[0] = '=';
1404 op[1] = NUL;
Bram Moolenaara3920382014-03-30 16:49:09 +02001405 if (*expr != '=')
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001406 {
Bram Moolenaarff697e62019-02-12 22:28:33 +01001407 if (vim_strchr((char_u *)"+-*/%.", *expr) != NULL)
Bram Moolenaar0f248b02019-04-04 15:36:05 +02001408 {
Bram Moolenaarff697e62019-02-12 22:28:33 +01001409 op[0] = *expr; // +=, -=, *=, /=, %= or .=
Bram Moolenaar0f248b02019-04-04 15:36:05 +02001410 if (expr[0] == '.' && expr[1] == '.') // ..=
1411 ++expr;
1412 }
Bram Moolenaara3920382014-03-30 16:49:09 +02001413 expr = skipwhite(expr + 2);
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001414 }
Bram Moolenaara3920382014-03-30 16:49:09 +02001415 else
1416 expr = skipwhite(expr + 1);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001417
Bram Moolenaar071d4272004-06-13 20:20:40 +00001418 if (eap->skip)
1419 ++emsg_skip;
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001420 i = eval0(expr, &rettv, &eap->nextcmd, !eap->skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421 if (eap->skip)
1422 {
1423 if (i != FAIL)
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001424 clear_tv(&rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001425 --emsg_skip;
1426 }
1427 else if (i != FAIL)
1428 {
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001429 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001430 op);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001431 clear_tv(&rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001432 }
1433 }
1434}
1435
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001436/*
1437 * Assign the typevalue "tv" to the variable or variables at "arg_start".
1438 * Handles both "var" with any type and "[var, var; var]" with a list type.
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001439 * When "nextchars" is not NULL it points to a string with characters that
1440 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1441 * or concatenate.
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001442 * Returns OK or FAIL;
1443 */
1444 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01001445ex_let_vars(
1446 char_u *arg_start,
1447 typval_T *tv,
1448 int copy, /* copy values from "tv", don't move */
1449 int semicolon, /* from skip_var_list() */
1450 int var_count, /* from skip_var_list() */
1451 char_u *nextchars)
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001452{
1453 char_u *arg = arg_start;
Bram Moolenaar33570922005-01-25 22:26:29 +00001454 list_T *l;
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001455 int i;
Bram Moolenaar33570922005-01-25 22:26:29 +00001456 listitem_T *item;
1457 typval_T ltv;
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001458
1459 if (*arg != '[')
1460 {
1461 /*
1462 * ":let var = expr" or ":for var in list"
1463 */
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001464 if (ex_let_one(arg, tv, copy, nextchars, nextchars) == NULL)
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001465 return FAIL;
1466 return OK;
1467 }
1468
1469 /*
1470 * ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1471 */
Bram Moolenaar758711c2005-02-02 23:11:38 +00001472 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001473 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001474 emsg(_(e_listreq));
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001475 return FAIL;
1476 }
1477
1478 i = list_len(l);
1479 if (semicolon == 0 && var_count < i)
1480 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001481 emsg(_("E687: Less targets than List items"));
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001482 return FAIL;
1483 }
1484 if (var_count - semicolon > i)
1485 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001486 emsg(_("E688: More targets than List items"));
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001487 return FAIL;
1488 }
1489
1490 item = l->lv_first;
1491 while (*arg != ']')
1492 {
1493 arg = skipwhite(arg + 1);
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001494 arg = ex_let_one(arg, &item->li_tv, TRUE, (char_u *)",;]", nextchars);
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001495 item = item->li_next;
1496 if (arg == NULL)
1497 return FAIL;
1498
1499 arg = skipwhite(arg);
1500 if (*arg == ';')
1501 {
1502 /* Put the rest of the list (may be empty) in the var after ';'.
1503 * Create a new list for this. */
1504 l = list_alloc();
1505 if (l == NULL)
1506 return FAIL;
1507 while (item != NULL)
1508 {
1509 list_append_tv(l, &item->li_tv);
1510 item = item->li_next;
1511 }
1512
1513 ltv.v_type = VAR_LIST;
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00001514 ltv.v_lock = 0;
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001515 ltv.vval.v_list = l;
1516 l->lv_refcount = 1;
1517
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001518 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1519 (char_u *)"]", nextchars);
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001520 clear_tv(&ltv);
1521 if (arg == NULL)
1522 return FAIL;
1523 break;
1524 }
1525 else if (*arg != ',' && *arg != ']')
1526 {
Bram Moolenaar95f09602016-11-10 20:01:45 +01001527 internal_error("ex_let_vars()");
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001528 return FAIL;
1529 }
1530 }
1531
1532 return OK;
1533}
1534
1535/*
1536 * Skip over assignable variable "var" or list of variables "[var, var]".
1537 * Used for ":let varvar = expr" and ":for varvar in expr".
1538 * For "[var, var]" increment "*var_count" for each variable.
1539 * for "[var, var; var]" set "semicolon".
1540 * Return NULL for an error.
1541 */
1542 static char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01001543skip_var_list(
1544 char_u *arg,
1545 int *var_count,
1546 int *semicolon)
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001547{
1548 char_u *p, *s;
1549
1550 if (*arg == '[')
1551 {
1552 /* "[var, var]": find the matching ']'. */
1553 p = arg;
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00001554 for (;;)
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001555 {
1556 p = skipwhite(p + 1); /* skip whites after '[', ';' or ',' */
1557 s = skip_var_one(p);
1558 if (s == p)
1559 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001560 semsg(_(e_invarg2), p);
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001561 return NULL;
1562 }
1563 ++*var_count;
1564
1565 p = skipwhite(s);
1566 if (*p == ']')
1567 break;
1568 else if (*p == ';')
1569 {
1570 if (*semicolon == 1)
1571 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001572 emsg(_("Double ; in list of variables"));
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001573 return NULL;
1574 }
1575 *semicolon = 1;
1576 }
1577 else if (*p != ',')
1578 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001579 semsg(_(e_invarg2), p);
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001580 return NULL;
1581 }
1582 }
1583 return p + 1;
1584 }
1585 else
1586 return skip_var_one(arg);
1587}
1588
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001589/*
Bram Moolenaarbae0c162007-05-10 19:30:25 +00001590 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
Bram Moolenaar92124a32005-06-17 22:03:40 +00001591 * l[idx].
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001592 */
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001593 static char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01001594skip_var_one(char_u *arg)
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001595{
Bram Moolenaar92124a32005-06-17 22:03:40 +00001596 if (*arg == '@' && arg[1] != NUL)
1597 return arg + 2;
1598 return find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
1599 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001600}
1601
Bram Moolenaara7043832005-01-21 11:56:39 +00001602/*
Bram Moolenaar33570922005-01-25 22:26:29 +00001603 * List variables for hashtab "ht" with prefix "prefix".
1604 * If "empty" is TRUE also list NULL strings as empty strings.
Bram Moolenaara7043832005-01-21 11:56:39 +00001605 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001606 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01001607list_hashtable_vars(
1608 hashtab_T *ht,
Bram Moolenaar32526b32019-01-19 17:43:09 +01001609 char *prefix,
Bram Moolenaar7454a062016-01-30 15:14:10 +01001610 int empty,
1611 int *first)
Bram Moolenaara7043832005-01-21 11:56:39 +00001612{
Bram Moolenaar33570922005-01-25 22:26:29 +00001613 hashitem_T *hi;
1614 dictitem_T *di;
Bram Moolenaara7043832005-01-21 11:56:39 +00001615 int todo;
Bram Moolenaarf86db782018-10-25 13:31:37 +02001616 char_u buf[IOSIZE];
Bram Moolenaara7043832005-01-21 11:56:39 +00001617
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001618 todo = (int)ht->ht_used;
Bram Moolenaara7043832005-01-21 11:56:39 +00001619 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
1620 {
1621 if (!HASHITEM_EMPTY(hi))
1622 {
1623 --todo;
Bram Moolenaar33570922005-01-25 22:26:29 +00001624 di = HI2DI(hi);
Bram Moolenaarf86db782018-10-25 13:31:37 +02001625
1626 // apply :filter /pat/ to variable name
Bram Moolenaar32526b32019-01-19 17:43:09 +01001627 vim_strncpy((char_u *)buf, (char_u *)prefix, IOSIZE - 1);
1628 vim_strcat((char_u *)buf, di->di_key, IOSIZE);
Bram Moolenaarf86db782018-10-25 13:31:37 +02001629 if (message_filtered(buf))
1630 continue;
1631
Bram Moolenaar33570922005-01-25 22:26:29 +00001632 if (empty || di->di_tv.v_type != VAR_STRING
1633 || di->di_tv.vval.v_string != NULL)
Bram Moolenaar7d61a922007-08-30 09:12:23 +00001634 list_one_var(di, prefix, first);
Bram Moolenaara7043832005-01-21 11:56:39 +00001635 }
1636 }
1637}
1638
1639/*
1640 * List global variables.
1641 */
1642 static void
Bram Moolenaar7454a062016-01-30 15:14:10 +01001643list_glob_vars(int *first)
Bram Moolenaara7043832005-01-21 11:56:39 +00001644{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001645 list_hashtable_vars(&globvarht, "", TRUE, first);
Bram Moolenaara7043832005-01-21 11:56:39 +00001646}
1647
1648/*
1649 * List buffer variables.
1650 */
1651 static void
Bram Moolenaar7454a062016-01-30 15:14:10 +01001652list_buf_vars(int *first)
Bram Moolenaara7043832005-01-21 11:56:39 +00001653{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001654 list_hashtable_vars(&curbuf->b_vars->dv_hashtab, "b:", TRUE, first);
Bram Moolenaara7043832005-01-21 11:56:39 +00001655}
1656
1657/*
1658 * List window variables.
1659 */
1660 static void
Bram Moolenaar7454a062016-01-30 15:14:10 +01001661list_win_vars(int *first)
Bram Moolenaara7043832005-01-21 11:56:39 +00001662{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001663 list_hashtable_vars(&curwin->w_vars->dv_hashtab, "w:", TRUE, first);
Bram Moolenaara7043832005-01-21 11:56:39 +00001664}
1665
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001666/*
1667 * List tab page variables.
1668 */
1669 static void
Bram Moolenaar7454a062016-01-30 15:14:10 +01001670list_tab_vars(int *first)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001671{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001672 list_hashtable_vars(&curtab->tp_vars->dv_hashtab, "t:", TRUE, first);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001673}
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001674
Bram Moolenaara7043832005-01-21 11:56:39 +00001675/*
1676 * List Vim variables.
1677 */
1678 static void
Bram Moolenaar7454a062016-01-30 15:14:10 +01001679list_vim_vars(int *first)
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001680{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001681 list_hashtable_vars(&vimvarht, "v:", FALSE, first);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001682}
1683
1684/*
Bram Moolenaarf0acfce2006-03-17 23:21:19 +00001685 * List script-local variables, if there is a script.
1686 */
1687 static void
Bram Moolenaar7454a062016-01-30 15:14:10 +01001688list_script_vars(int *first)
Bram Moolenaarf0acfce2006-03-17 23:21:19 +00001689{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001690 if (current_sctx.sc_sid > 0 && current_sctx.sc_sid <= ga_scripts.ga_len)
1691 list_hashtable_vars(&SCRIPT_VARS(current_sctx.sc_sid),
Bram Moolenaar32526b32019-01-19 17:43:09 +01001692 "s:", FALSE, first);
Bram Moolenaarf0acfce2006-03-17 23:21:19 +00001693}
1694
1695/*
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001696 * List variables in "arg".
1697 */
1698 static char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01001699list_arg_vars(exarg_T *eap, char_u *arg, int *first)
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001700{
1701 int error = FALSE;
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001702 int len;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001703 char_u *name;
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001704 char_u *name_start;
1705 char_u *arg_subsc;
1706 char_u *tofree;
1707 typval_T tv;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001708
1709 while (!ends_excmd(*arg) && !got_int)
1710 {
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001711 if (error || eap->skip)
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001712 {
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00001713 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
Bram Moolenaar1c465442017-03-12 20:10:05 +01001714 if (!VIM_ISWHITE(*arg) && !ends_excmd(*arg))
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001715 {
1716 emsg_severe = TRUE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001717 emsg(_(e_trailing));
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001718 break;
1719 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001720 }
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001721 else
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001722 {
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001723 /* get_name_len() takes care of expanding curly braces */
1724 name_start = name = arg;
1725 len = get_name_len(&arg, &tofree, TRUE, TRUE);
1726 if (len <= 0)
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001727 {
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001728 /* This is mainly to keep test 49 working: when expanding
1729 * curly braces fails overrule the exception error message. */
1730 if (len < 0 && !aborting())
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001731 {
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001732 emsg_severe = TRUE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001733 semsg(_(e_invarg2), arg);
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001734 break;
1735 }
1736 error = TRUE;
1737 }
1738 else
1739 {
1740 if (tofree != NULL)
1741 name = tofree;
Bram Moolenaar1cd5e612015-05-04 11:10:27 +02001742 if (get_var_tv(name, len, &tv, NULL, TRUE, FALSE) == FAIL)
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001743 error = TRUE;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001744 else
1745 {
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001746 /* handle d.key, l[idx], f(expr) */
1747 arg_subsc = arg;
1748 if (handle_subscript(&arg, &tv, TRUE, TRUE) == FAIL)
Bram Moolenaara7043832005-01-21 11:56:39 +00001749 error = TRUE;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001750 else
Bram Moolenaara7043832005-01-21 11:56:39 +00001751 {
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001752 if (arg == arg_subsc && len == 2 && name[1] == ':')
Bram Moolenaara7043832005-01-21 11:56:39 +00001753 {
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001754 switch (*name)
Bram Moolenaara7043832005-01-21 11:56:39 +00001755 {
Bram Moolenaar7d61a922007-08-30 09:12:23 +00001756 case 'g': list_glob_vars(first); break;
1757 case 'b': list_buf_vars(first); break;
1758 case 'w': list_win_vars(first); break;
Bram Moolenaar7d61a922007-08-30 09:12:23 +00001759 case 't': list_tab_vars(first); break;
Bram Moolenaar7d61a922007-08-30 09:12:23 +00001760 case 'v': list_vim_vars(first); break;
1761 case 's': list_script_vars(first); break;
1762 case 'l': list_func_vars(first); break;
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001763 default:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001764 semsg(_("E738: Can't list variables for %s"), name);
Bram Moolenaara7043832005-01-21 11:56:39 +00001765 }
Bram Moolenaara7043832005-01-21 11:56:39 +00001766 }
1767 else
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001768 {
1769 char_u numbuf[NUMBUFLEN];
1770 char_u *tf;
1771 int c;
1772 char_u *s;
1773
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001774 s = echo_string(&tv, &tf, numbuf, 0);
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001775 c = *arg;
1776 *arg = NUL;
Bram Moolenaar32526b32019-01-19 17:43:09 +01001777 list_one_var_a("",
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001778 arg == arg_subsc ? name : name_start,
Bram Moolenaar7d61a922007-08-30 09:12:23 +00001779 tv.v_type,
1780 s == NULL ? (char_u *)"" : s,
1781 first);
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001782 *arg = c;
1783 vim_free(tf);
1784 }
1785 clear_tv(&tv);
Bram Moolenaara7043832005-01-21 11:56:39 +00001786 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001787 }
1788 }
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001789
1790 vim_free(tofree);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001791 }
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00001792
1793 arg = skipwhite(arg);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001794 }
1795
1796 return arg;
1797}
1798
1799/*
1800 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
1801 * Returns a pointer to the char just after the var name.
1802 * Returns NULL if there is an error.
1803 */
1804 static char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01001805ex_let_one(
1806 char_u *arg, /* points to variable name */
1807 typval_T *tv, /* value to assign to variable */
1808 int copy, /* copy value from "tv" */
1809 char_u *endchars, /* valid chars after variable name or NULL */
1810 char_u *op) /* "+", "-", "." or NULL*/
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001811{
1812 int c1;
1813 char_u *name;
1814 char_u *p;
1815 char_u *arg_end = NULL;
1816 int len;
1817 int opt_flags;
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001818 char_u *tofree = NULL;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001819
1820 /*
1821 * ":let $VAR = expr": Set environment variable.
1822 */
1823 if (*arg == '$')
1824 {
1825 /* Find the end of the name. */
1826 ++arg;
1827 name = arg;
1828 len = get_env_len(&arg);
1829 if (len == 0)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001830 semsg(_(e_invarg2), name - 1);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001831 else
1832 {
Bram Moolenaarff697e62019-02-12 22:28:33 +01001833 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001834 semsg(_(e_letwrong), op);
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001835 else if (endchars != NULL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001836 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001837 emsg(_(e_letunexp));
Bram Moolenaard4ddfaf2010-12-02 14:48:14 +01001838 else if (!check_secure())
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001839 {
1840 c1 = name[len];
1841 name[len] = NUL;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001842 p = tv_get_string_chk(tv);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00001843 if (p != NULL && op != NULL && *op == '.')
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001844 {
1845 int mustfree = FALSE;
1846 char_u *s = vim_getenv(name, &mustfree);
1847
1848 if (s != NULL)
1849 {
1850 p = tofree = concat_str(s, p);
1851 if (mustfree)
1852 vim_free(s);
1853 }
1854 }
1855 if (p != NULL)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00001856 {
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001857 vim_setenv(name, p);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00001858 if (STRICMP(name, "HOME") == 0)
1859 init_homedir();
1860 else if (didset_vim && STRICMP(name, "VIM") == 0)
1861 didset_vim = FALSE;
1862 else if (didset_vimruntime
1863 && STRICMP(name, "VIMRUNTIME") == 0)
1864 didset_vimruntime = FALSE;
1865 arg_end = arg;
1866 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001867 name[len] = c1;
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001868 vim_free(tofree);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001869 }
1870 }
1871 }
1872
1873 /*
1874 * ":let &option = expr": Set option value.
1875 * ":let &l:option = expr": Set local option value.
1876 * ":let &g:option = expr": Set global option value.
1877 */
1878 else if (*arg == '&')
1879 {
1880 /* Find the end of the name. */
1881 p = find_option_end(&arg, &opt_flags);
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001882 if (p == NULL || (endchars != NULL
1883 && vim_strchr(endchars, *skipwhite(p)) == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001884 emsg(_(e_letunexp));
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001885 else
1886 {
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001887 long n;
1888 int opt_type;
1889 long numval;
1890 char_u *stringval = NULL;
1891 char_u *s;
1892
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001893 c1 = *p;
1894 *p = NUL;
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001895
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001896 n = (long)tv_get_number(tv);
1897 s = tv_get_string_chk(tv); /* != NULL if number or string */
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00001898 if (s != NULL && op != NULL && *op != '=')
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001899 {
1900 opt_type = get_option_value(arg, &numval,
1901 &stringval, opt_flags);
1902 if ((opt_type == 1 && *op == '.')
1903 || (opt_type == 0 && *op != '.'))
Bram Moolenaar2a6a6c32017-10-02 19:29:48 +02001904 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001905 semsg(_(e_letwrong), op);
Bram Moolenaarff697e62019-02-12 22:28:33 +01001906 s = NULL; // don't set the value
Bram Moolenaar2a6a6c32017-10-02 19:29:48 +02001907 }
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001908 else
1909 {
Bram Moolenaarff697e62019-02-12 22:28:33 +01001910 if (opt_type == 1) // number
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001911 {
Bram Moolenaarff697e62019-02-12 22:28:33 +01001912 switch (*op)
1913 {
1914 case '+': n = numval + n; break;
1915 case '-': n = numval - n; break;
1916 case '*': n = numval * n; break;
Bram Moolenaare21c1582019-03-02 11:57:09 +01001917 case '/': n = (long)num_divide(numval, n); break;
1918 case '%': n = (long)num_modulus(numval, n); break;
Bram Moolenaarff697e62019-02-12 22:28:33 +01001919 }
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001920 }
Bram Moolenaarff697e62019-02-12 22:28:33 +01001921 else if (opt_type == 0 && stringval != NULL) // string
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001922 {
1923 s = concat_str(stringval, s);
1924 vim_free(stringval);
1925 stringval = s;
1926 }
1927 }
1928 }
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00001929 if (s != NULL)
1930 {
1931 set_option_value(arg, n, s, opt_flags);
1932 arg_end = p;
1933 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001934 *p = c1;
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001935 vim_free(stringval);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001936 }
1937 }
1938
1939 /*
1940 * ":let @r = expr": Set register contents.
1941 */
1942 else if (*arg == '@')
1943 {
1944 ++arg;
Bram Moolenaarff697e62019-02-12 22:28:33 +01001945 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001946 semsg(_(e_letwrong), op);
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001947 else if (endchars != NULL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00001948 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001949 emsg(_(e_letunexp));
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001950 else
1951 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00001952 char_u *ptofree = NULL;
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001953 char_u *s;
1954
Bram Moolenaard155d7a2018-12-21 16:04:21 +01001955 p = tv_get_string_chk(tv);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00001956 if (p != NULL && op != NULL && *op == '.')
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001957 {
Bram Moolenaarb7cb42b2014-04-02 19:55:10 +02001958 s = get_reg_contents(*arg == '@' ? '"' : *arg, GREG_EXPR_SRC);
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001959 if (s != NULL)
1960 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00001961 p = ptofree = concat_str(s, p);
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001962 vim_free(s);
1963 }
1964 }
1965 if (p != NULL)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00001966 {
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001967 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00001968 arg_end = arg + 1;
1969 }
Bram Moolenaar89d40322006-08-29 15:30:07 +00001970 vim_free(ptofree);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001971 }
1972 }
1973
1974 /*
1975 * ":let var = expr": Set internal variable.
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00001976 * ":let {expr} = expr": Idem, name made with curly braces
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001977 */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00001978 else if (eval_isnamec1(*arg) || *arg == '{')
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001979 {
Bram Moolenaar33570922005-01-25 22:26:29 +00001980 lval_T lv;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001981
Bram Moolenaar6d977d62014-01-14 15:24:39 +01001982 p = get_lval(arg, tv, &lv, FALSE, FALSE, 0, FNE_CHECK_START);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00001983 if (p != NULL && lv.ll_name != NULL)
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001984 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00001985 if (endchars != NULL && vim_strchr(endchars, *skipwhite(p)) == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001986 emsg(_(e_letunexp));
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00001987 else
1988 {
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00001989 set_var_lval(&lv, p, tv, copy, op);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00001990 arg_end = p;
1991 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001992 }
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00001993 clear_lval(&lv);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001994 }
1995
1996 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001997 semsg(_(e_invarg2), arg);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00001998
1999 return arg_end;
2000}
2001
2002/*
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002003 * Get an lval: variable, Dict item or List item that can be assigned a value
2004 * to: "name", "na{me}", "name[expr]", "name[expr:expr]", "name[expr][expr]",
2005 * "name.key", "name.key[expr]" etc.
2006 * Indexing only works if "name" is an existing List or Dictionary.
2007 * "name" points to the start of the name.
2008 * If "rettv" is not NULL it points to the value to be assigned.
2009 * "unlet" is TRUE for ":unlet": slightly different behavior when something is
2010 * wrong; must end in space or cmd separator.
2011 *
Bram Moolenaar6d977d62014-01-14 15:24:39 +01002012 * flags:
2013 * GLV_QUIET: do not give error messages
Bram Moolenaar3a257732017-02-21 20:47:13 +01002014 * GLV_READ_ONLY: will not change the variable
Bram Moolenaar6d977d62014-01-14 15:24:39 +01002015 * GLV_NO_AUTOLOAD: do not use script autoloading
2016 *
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002017 * Returns a pointer to just after the name, including indexes.
Bram Moolenaara7043832005-01-21 11:56:39 +00002018 * When an evaluation error occurs "lp->ll_name" is NULL;
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002019 * Returns NULL for a parsing error. Still need to free items in "lp"!
Bram Moolenaarc70646c2005-01-04 21:52:38 +00002020 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002021 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01002022get_lval(
2023 char_u *name,
2024 typval_T *rettv,
2025 lval_T *lp,
2026 int unlet,
2027 int skip,
2028 int flags, /* GLV_ values */
2029 int fne_flags) /* flags for find_name_end() */
Bram Moolenaarc70646c2005-01-04 21:52:38 +00002030{
Bram Moolenaarc70646c2005-01-04 21:52:38 +00002031 char_u *p;
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002032 char_u *expr_start, *expr_end;
2033 int cc;
Bram Moolenaar33570922005-01-25 22:26:29 +00002034 dictitem_T *v;
2035 typval_T var1;
2036 typval_T var2;
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002037 int empty1 = FALSE;
Bram Moolenaar33570922005-01-25 22:26:29 +00002038 listitem_T *ni;
Bram Moolenaar8c711452005-01-14 21:53:12 +00002039 char_u *key = NULL;
Bram Moolenaar8c711452005-01-14 21:53:12 +00002040 int len;
Bram Moolenaar33570922005-01-25 22:26:29 +00002041 hashtab_T *ht;
Bram Moolenaar6d977d62014-01-14 15:24:39 +01002042 int quiet = flags & GLV_QUIET;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00002043
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002044 /* Clear everything in "lp". */
Bram Moolenaar33570922005-01-25 22:26:29 +00002045 vim_memset(lp, 0, sizeof(lval_T));
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002046
2047 if (skip)
2048 {
2049 /* When skipping just find the end of the name. */
2050 lp->ll_name = name;
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002051 return find_name_end(name, NULL, NULL, FNE_INCL_BR | fne_flags);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002052 }
2053
2054 /* Find the end of the name. */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002055 p = find_name_end(name, &expr_start, &expr_end, fne_flags);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002056 if (expr_start != NULL)
2057 {
2058 /* Don't expand the name when we already know there is an error. */
Bram Moolenaar1c465442017-03-12 20:10:05 +01002059 if (unlet && !VIM_ISWHITE(*p) && !ends_excmd(*p)
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002060 && *p != '[' && *p != '.')
2061 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002062 emsg(_(e_trailing));
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002063 return NULL;
2064 }
2065
2066 lp->ll_exp_name = make_expanded_name(name, expr_start, expr_end, p);
2067 if (lp->ll_exp_name == NULL)
2068 {
2069 /* Report an invalid expression in braces, unless the
2070 * expression evaluation has been cancelled due to an
2071 * aborting error, an interrupt, or an exception. */
2072 if (!aborting() && !quiet)
2073 {
Bram Moolenaarce5e58e2005-01-19 22:24:34 +00002074 emsg_severe = TRUE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002075 semsg(_(e_invarg2), name);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002076 return NULL;
2077 }
2078 }
2079 lp->ll_name = lp->ll_exp_name;
2080 }
2081 else
2082 lp->ll_name = name;
2083
2084 /* Without [idx] or .key we are done. */
2085 if ((*p != '[' && *p != '.') || lp->ll_name == NULL)
2086 return p;
2087
2088 cc = *p;
2089 *p = NUL;
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002090 /* Only pass &ht when we would write to the variable, it prevents autoload
2091 * as well. */
2092 v = find_var(lp->ll_name, (flags & GLV_READ_ONLY) ? NULL : &ht,
2093 flags & GLV_NO_AUTOLOAD);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002094 if (v == NULL && !quiet)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002095 semsg(_(e_undefvar), lp->ll_name);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002096 *p = cc;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00002097 if (v == NULL)
2098 return NULL;
2099
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002100 /*
2101 * Loop until no more [idx] or .key is following.
2102 */
Bram Moolenaar33570922005-01-25 22:26:29 +00002103 lp->ll_tv = &v->di_tv;
Bram Moolenaarf06e5a52017-02-23 14:25:17 +01002104 var1.v_type = VAR_UNKNOWN;
2105 var2.v_type = VAR_UNKNOWN;
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002106 while (*p == '[' || (*p == '.' && lp->ll_tv->v_type == VAR_DICT))
Bram Moolenaarc70646c2005-01-04 21:52:38 +00002107 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002108 if (!(lp->ll_tv->v_type == VAR_LIST && lp->ll_tv->vval.v_list != NULL)
2109 && !(lp->ll_tv->v_type == VAR_DICT
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002110 && lp->ll_tv->vval.v_dict != NULL)
2111 && !(lp->ll_tv->v_type == VAR_BLOB
2112 && lp->ll_tv->vval.v_blob != NULL))
Bram Moolenaarc70646c2005-01-04 21:52:38 +00002113 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002114 if (!quiet)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002115 emsg(_("E689: Can only index a List, Dictionary or Blob"));
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002116 return NULL;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00002117 }
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002118 if (lp->ll_range)
Bram Moolenaarc70646c2005-01-04 21:52:38 +00002119 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002120 if (!quiet)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002121 emsg(_("E708: [:] must come last"));
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002122 return NULL;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00002123 }
Bram Moolenaar6cc16192005-01-08 21:49:45 +00002124
Bram Moolenaar8c711452005-01-14 21:53:12 +00002125 len = -1;
2126 if (*p == '.')
2127 {
2128 key = p + 1;
2129 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
2130 ;
2131 if (len == 0)
2132 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002133 if (!quiet)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002134 emsg(_(e_emptykey));
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002135 return NULL;
Bram Moolenaar8c711452005-01-14 21:53:12 +00002136 }
2137 p = key + len;
2138 }
Bram Moolenaar6cc16192005-01-08 21:49:45 +00002139 else
2140 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00002141 /* Get the index [expr] or the first index [expr: ]. */
Bram Moolenaar6cc16192005-01-08 21:49:45 +00002142 p = skipwhite(p + 1);
Bram Moolenaar8c711452005-01-14 21:53:12 +00002143 if (*p == ':')
2144 empty1 = TRUE;
Bram Moolenaar6cc16192005-01-08 21:49:45 +00002145 else
2146 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00002147 empty1 = FALSE;
2148 if (eval1(&p, &var1, TRUE) == FAIL) /* recursive! */
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002149 return NULL;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01002150 if (tv_get_string_chk(&var1) == NULL)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00002151 {
2152 /* not a number or string */
2153 clear_tv(&var1);
2154 return NULL;
2155 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00002156 }
2157
2158 /* Optionally get the second index [ :expr]. */
2159 if (*p == ':')
2160 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002161 if (lp->ll_tv->v_type == VAR_DICT)
Bram Moolenaar8c711452005-01-14 21:53:12 +00002162 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002163 if (!quiet)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002164 emsg(_(e_dictrange));
Bram Moolenaarf06e5a52017-02-23 14:25:17 +01002165 clear_tv(&var1);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002166 return NULL;
Bram Moolenaar6cc16192005-01-08 21:49:45 +00002167 }
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002168 if (rettv != NULL
2169 && !(rettv->v_type == VAR_LIST
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01002170 && rettv->vval.v_list != NULL)
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002171 && !(rettv->v_type == VAR_BLOB
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01002172 && rettv->vval.v_blob != NULL))
Bram Moolenaar8c711452005-01-14 21:53:12 +00002173 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002174 if (!quiet)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002175 emsg(_("E709: [:] requires a List or Blob value"));
Bram Moolenaarf06e5a52017-02-23 14:25:17 +01002176 clear_tv(&var1);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002177 return NULL;
Bram Moolenaar8c711452005-01-14 21:53:12 +00002178 }
2179 p = skipwhite(p + 1);
2180 if (*p == ']')
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002181 lp->ll_empty2 = TRUE;
Bram Moolenaar8c711452005-01-14 21:53:12 +00002182 else
2183 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002184 lp->ll_empty2 = FALSE;
Bram Moolenaar8c711452005-01-14 21:53:12 +00002185 if (eval1(&p, &var2, TRUE) == FAIL) /* recursive! */
2186 {
Bram Moolenaarf06e5a52017-02-23 14:25:17 +01002187 clear_tv(&var1);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002188 return NULL;
Bram Moolenaar8c711452005-01-14 21:53:12 +00002189 }
Bram Moolenaard155d7a2018-12-21 16:04:21 +01002190 if (tv_get_string_chk(&var2) == NULL)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00002191 {
2192 /* not a number or string */
Bram Moolenaarf06e5a52017-02-23 14:25:17 +01002193 clear_tv(&var1);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00002194 clear_tv(&var2);
2195 return NULL;
2196 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00002197 }
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002198 lp->ll_range = TRUE;
Bram Moolenaar6cc16192005-01-08 21:49:45 +00002199 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00002200 else
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002201 lp->ll_range = FALSE;
Bram Moolenaar6cc16192005-01-08 21:49:45 +00002202
Bram Moolenaar8c711452005-01-14 21:53:12 +00002203 if (*p != ']')
Bram Moolenaar6cc16192005-01-08 21:49:45 +00002204 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002205 if (!quiet)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002206 emsg(_(e_missbrac));
Bram Moolenaarf06e5a52017-02-23 14:25:17 +01002207 clear_tv(&var1);
2208 clear_tv(&var2);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002209 return NULL;
Bram Moolenaar8c711452005-01-14 21:53:12 +00002210 }
2211
2212 /* Skip to past ']'. */
2213 ++p;
2214 }
2215
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002216 if (lp->ll_tv->v_type == VAR_DICT)
Bram Moolenaar8c711452005-01-14 21:53:12 +00002217 {
2218 if (len == -1)
2219 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002220 /* "[key]": get key from "var1" */
Bram Moolenaard155d7a2018-12-21 16:04:21 +01002221 key = tv_get_string_chk(&var1); /* is number or string */
Bram Moolenaar0921ecf2016-04-03 22:44:36 +02002222 if (key == NULL)
Bram Moolenaar8c711452005-01-14 21:53:12 +00002223 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00002224 clear_tv(&var1);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002225 return NULL;
Bram Moolenaar8c711452005-01-14 21:53:12 +00002226 }
2227 }
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002228 lp->ll_list = NULL;
2229 lp->ll_dict = lp->ll_tv->vval.v_dict;
Bram Moolenaarce5e58e2005-01-19 22:24:34 +00002230 lp->ll_di = dict_find(lp->ll_dict, key, len);
Bram Moolenaar4228bec2011-03-27 16:03:15 +02002231
Bram Moolenaarbdb62052012-07-16 17:31:53 +02002232 /* When assigning to a scope dictionary check that a function and
2233 * variable name is valid (only variable name unless it is l: or
2234 * g: dictionary). Disallow overwriting a builtin function. */
2235 if (rettv != NULL && lp->ll_dict->dv_scope != 0)
Bram Moolenaar4228bec2011-03-27 16:03:15 +02002236 {
Bram Moolenaarbdb62052012-07-16 17:31:53 +02002237 int prevval;
2238 int wrong;
2239
2240 if (len != -1)
2241 {
2242 prevval = key[len];
2243 key[len] = NUL;
2244 }
Bram Moolenaar4380d1e2013-06-09 20:51:00 +02002245 else
2246 prevval = 0; /* avoid compiler warning */
Bram Moolenaarbdb62052012-07-16 17:31:53 +02002247 wrong = (lp->ll_dict->dv_scope == VAR_DEF_SCOPE
2248 && rettv->v_type == VAR_FUNC
Bram Moolenaar4228bec2011-03-27 16:03:15 +02002249 && var_check_func_name(key, lp->ll_di == NULL))
Bram Moolenaarbdb62052012-07-16 17:31:53 +02002250 || !valid_varname(key);
2251 if (len != -1)
2252 key[len] = prevval;
2253 if (wrong)
Bram Moolenaar4228bec2011-03-27 16:03:15 +02002254 return NULL;
2255 }
2256
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002257 if (lp->ll_di == NULL)
Bram Moolenaar8c711452005-01-14 21:53:12 +00002258 {
Bram Moolenaar31b81602019-02-10 22:14:27 +01002259 // Can't add "v:" or "a:" variable.
2260 if (lp->ll_dict == &vimvardict
2261 || &lp->ll_dict->dv_hashtab == get_funccal_args_ht())
Bram Moolenaar4228bec2011-03-27 16:03:15 +02002262 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002263 semsg(_(e_illvar), name);
Bram Moolenaarab89d7a2019-03-17 14:43:31 +01002264 clear_tv(&var1);
Bram Moolenaar4228bec2011-03-27 16:03:15 +02002265 return NULL;
2266 }
2267
Bram Moolenaar31b81602019-02-10 22:14:27 +01002268 // Key does not exist in dict: may need to add it.
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002269 if (*p == '[' || *p == '.' || unlet)
Bram Moolenaar8c711452005-01-14 21:53:12 +00002270 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002271 if (!quiet)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002272 semsg(_(e_dictkey), key);
Bram Moolenaarf06e5a52017-02-23 14:25:17 +01002273 clear_tv(&var1);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002274 return NULL;
Bram Moolenaar8c711452005-01-14 21:53:12 +00002275 }
2276 if (len == -1)
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002277 lp->ll_newkey = vim_strsave(key);
Bram Moolenaar8c711452005-01-14 21:53:12 +00002278 else
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002279 lp->ll_newkey = vim_strnsave(key, len);
Bram Moolenaarf06e5a52017-02-23 14:25:17 +01002280 clear_tv(&var1);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002281 if (lp->ll_newkey == NULL)
Bram Moolenaar8c711452005-01-14 21:53:12 +00002282 p = NULL;
2283 break;
2284 }
Bram Moolenaar4228bec2011-03-27 16:03:15 +02002285 /* existing variable, need to check if it can be changed */
Bram Moolenaar3a257732017-02-21 20:47:13 +01002286 else if ((flags & GLV_READ_ONLY) == 0
2287 && var_check_ro(lp->ll_di->di_flags, name, FALSE))
Bram Moolenaar49439c42017-02-20 23:07:05 +01002288 {
2289 clear_tv(&var1);
Bram Moolenaar4228bec2011-03-27 16:03:15 +02002290 return NULL;
Bram Moolenaar49439c42017-02-20 23:07:05 +01002291 }
Bram Moolenaar4228bec2011-03-27 16:03:15 +02002292
Bram Moolenaarf06e5a52017-02-23 14:25:17 +01002293 clear_tv(&var1);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002294 lp->ll_tv = &lp->ll_di->di_tv;
Bram Moolenaar8c711452005-01-14 21:53:12 +00002295 }
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002296 else if (lp->ll_tv->v_type == VAR_BLOB)
2297 {
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01002298 long bloblen = blob_len(lp->ll_tv->vval.v_blob);
2299
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002300 /*
2301 * Get the number and item for the only or first index of the List.
2302 */
2303 if (empty1)
2304 lp->ll_n1 = 0;
2305 else
2306 // is number or string
2307 lp->ll_n1 = (long)tv_get_number(&var1);
2308 clear_tv(&var1);
2309
2310 if (lp->ll_n1 < 0
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01002311 || lp->ll_n1 > bloblen
2312 || (lp->ll_range && lp->ll_n1 == bloblen))
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002313 {
2314 if (!quiet)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002315 semsg(_(e_blobidx), lp->ll_n1);
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01002316 clear_tv(&var2);
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002317 return NULL;
2318 }
2319 if (lp->ll_range && !lp->ll_empty2)
2320 {
2321 lp->ll_n2 = (long)tv_get_number(&var2);
2322 clear_tv(&var2);
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01002323 if (lp->ll_n2 < 0
2324 || lp->ll_n2 >= bloblen
2325 || lp->ll_n2 < lp->ll_n1)
2326 {
2327 if (!quiet)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002328 semsg(_(e_blobidx), lp->ll_n2);
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01002329 return NULL;
2330 }
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002331 }
2332 lp->ll_blob = lp->ll_tv->vval.v_blob;
2333 lp->ll_tv = NULL;
Bram Moolenaar61be3762019-03-19 23:04:17 +01002334 break;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002335 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00002336 else
2337 {
2338 /*
2339 * Get the number and item for the only or first index of the List.
2340 */
2341 if (empty1)
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002342 lp->ll_n1 = 0;
Bram Moolenaar8c711452005-01-14 21:53:12 +00002343 else
Bram Moolenaarf06e5a52017-02-23 14:25:17 +01002344 /* is number or string */
Bram Moolenaard155d7a2018-12-21 16:04:21 +01002345 lp->ll_n1 = (long)tv_get_number(&var1);
Bram Moolenaarf06e5a52017-02-23 14:25:17 +01002346 clear_tv(&var1);
2347
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002348 lp->ll_dict = NULL;
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002349 lp->ll_list = lp->ll_tv->vval.v_list;
2350 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2351 if (lp->ll_li == NULL)
Bram Moolenaar8c711452005-01-14 21:53:12 +00002352 {
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00002353 if (lp->ll_n1 < 0)
2354 {
2355 lp->ll_n1 = 0;
2356 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2357 }
2358 }
2359 if (lp->ll_li == NULL)
2360 {
Bram Moolenaarf06e5a52017-02-23 14:25:17 +01002361 clear_tv(&var2);
Bram Moolenaare9623882011-04-21 14:27:28 +02002362 if (!quiet)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002363 semsg(_(e_listidx), lp->ll_n1);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002364 return NULL;
Bram Moolenaar8c711452005-01-14 21:53:12 +00002365 }
2366
2367 /*
2368 * May need to find the item or absolute index for the second
2369 * index of a range.
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002370 * When no index given: "lp->ll_empty2" is TRUE.
2371 * Otherwise "lp->ll_n2" is set to the second index.
Bram Moolenaar8c711452005-01-14 21:53:12 +00002372 */
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002373 if (lp->ll_range && !lp->ll_empty2)
Bram Moolenaar8c711452005-01-14 21:53:12 +00002374 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01002375 lp->ll_n2 = (long)tv_get_number(&var2);
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02002376 /* is number or string */
Bram Moolenaar8c711452005-01-14 21:53:12 +00002377 clear_tv(&var2);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002378 if (lp->ll_n2 < 0)
Bram Moolenaar8c711452005-01-14 21:53:12 +00002379 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002380 ni = list_find(lp->ll_list, lp->ll_n2);
Bram Moolenaar8c711452005-01-14 21:53:12 +00002381 if (ni == NULL)
Bram Moolenaare9623882011-04-21 14:27:28 +02002382 {
2383 if (!quiet)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002384 semsg(_(e_listidx), lp->ll_n2);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002385 return NULL;
Bram Moolenaare9623882011-04-21 14:27:28 +02002386 }
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002387 lp->ll_n2 = list_idx_of_item(lp->ll_list, ni);
Bram Moolenaar8c711452005-01-14 21:53:12 +00002388 }
2389
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002390 /* Check that lp->ll_n2 isn't before lp->ll_n1. */
2391 if (lp->ll_n1 < 0)
2392 lp->ll_n1 = list_idx_of_item(lp->ll_list, lp->ll_li);
2393 if (lp->ll_n2 < lp->ll_n1)
Bram Moolenaare9623882011-04-21 14:27:28 +02002394 {
2395 if (!quiet)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002396 semsg(_(e_listidx), lp->ll_n2);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002397 return NULL;
Bram Moolenaare9623882011-04-21 14:27:28 +02002398 }
Bram Moolenaar6cc16192005-01-08 21:49:45 +00002399 }
2400
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002401 lp->ll_tv = &lp->ll_li->li_tv;
Bram Moolenaar6cc16192005-01-08 21:49:45 +00002402 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00002403 }
2404
Bram Moolenaarf06e5a52017-02-23 14:25:17 +01002405 clear_tv(&var1);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002406 return p;
2407}
2408
2409/*
Bram Moolenaar33570922005-01-25 22:26:29 +00002410 * Clear lval "lp" that was filled by get_lval().
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002411 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002412 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01002413clear_lval(lval_T *lp)
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002414{
2415 vim_free(lp->ll_exp_name);
2416 vim_free(lp->ll_newkey);
2417}
2418
2419/*
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00002420 * Set a variable that was parsed by get_lval() to "rettv".
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002421 * "endp" points to just after the parsed name.
Bram Moolenaarff697e62019-02-12 22:28:33 +01002422 * "op" is NULL, "+" for "+=", "-" for "-=", "*" for "*=", "/" for "/=",
2423 * "%" for "%=", "." for ".=" or "=" for "=".
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002424 */
2425 static void
Bram Moolenaar7454a062016-01-30 15:14:10 +01002426set_var_lval(
2427 lval_T *lp,
2428 char_u *endp,
2429 typval_T *rettv,
2430 int copy,
2431 char_u *op)
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002432{
2433 int cc;
Bram Moolenaar33570922005-01-25 22:26:29 +00002434 listitem_T *ri;
2435 dictitem_T *di;
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002436
2437 if (lp->ll_tv == NULL)
Bram Moolenaarc70646c2005-01-04 21:52:38 +00002438 {
Bram Moolenaar79518e22017-02-17 16:31:35 +01002439 cc = *endp;
2440 *endp = NUL;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002441 if (lp->ll_blob != NULL)
2442 {
2443 int error = FALSE, val;
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01002444
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002445 if (op != NULL && *op != '=')
2446 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002447 semsg(_(e_letwrong), op);
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002448 return;
2449 }
2450
2451 if (lp->ll_range && rettv->v_type == VAR_BLOB)
2452 {
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01002453 int il, ir;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002454
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01002455 if (lp->ll_empty2)
2456 lp->ll_n2 = blob_len(lp->ll_blob) - 1;
2457
2458 if (lp->ll_n2 - lp->ll_n1 + 1 != blob_len(rettv->vval.v_blob))
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002459 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002460 emsg(_("E972: Blob value does not have the right number of bytes"));
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002461 return;
2462 }
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01002463 if (lp->ll_empty2)
2464 lp->ll_n2 = blob_len(lp->ll_blob);
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002465
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01002466 ir = 0;
2467 for (il = lp->ll_n1; il <= lp->ll_n2; il++)
2468 blob_set(lp->ll_blob, il,
2469 blob_get(rettv->vval.v_blob, ir++));
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002470 }
2471 else
2472 {
2473 val = (int)tv_get_number_chk(rettv, &error);
2474 if (!error)
2475 {
2476 garray_T *gap = &lp->ll_blob->bv_ga;
2477
2478 // Allow for appending a byte. Setting a byte beyond
2479 // the end is an error otherwise.
2480 if (lp->ll_n1 < gap->ga_len
2481 || (lp->ll_n1 == gap->ga_len
2482 && ga_grow(&lp->ll_blob->bv_ga, 1) == OK))
2483 {
2484 blob_set(lp->ll_blob, lp->ll_n1, val);
2485 if (lp->ll_n1 == gap->ga_len)
2486 ++gap->ga_len;
2487 }
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01002488 // error for invalid range was already given in get_lval()
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002489 }
2490 }
2491 }
2492 else if (op != NULL && *op != '=')
Bram Moolenaarc70646c2005-01-04 21:52:38 +00002493 {
Bram Moolenaar79518e22017-02-17 16:31:35 +01002494 typval_T tv;
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002495
Bram Moolenaarff697e62019-02-12 22:28:33 +01002496 // handle +=, -=, *=, /=, %= and .=
Bram Moolenaar79518e22017-02-17 16:31:35 +01002497 di = NULL;
2498 if (get_var_tv(lp->ll_name, (int)STRLEN(lp->ll_name),
2499 &tv, &di, TRUE, FALSE) == OK)
2500 {
2501 if ((di == NULL
Bram Moolenaar05c00c02019-02-11 22:00:11 +01002502 || (!var_check_ro(di->di_flags, lp->ll_name, FALSE)
2503 && !tv_check_lock(&di->di_tv, lp->ll_name, FALSE)))
Bram Moolenaar79518e22017-02-17 16:31:35 +01002504 && tv_op(&tv, rettv, op) == OK)
2505 set_var(lp->ll_name, &tv, FALSE);
2506 clear_tv(&tv);
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002507 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00002508 }
Bram Moolenaar79518e22017-02-17 16:31:35 +01002509 else
2510 set_var(lp->ll_name, rettv, copy);
2511 *endp = cc;
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002512 }
Bram Moolenaar05c00c02019-02-11 22:00:11 +01002513 else if (var_check_lock(lp->ll_newkey == NULL
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00002514 ? lp->ll_tv->v_lock
Bram Moolenaar77354e72015-04-21 16:49:05 +02002515 : lp->ll_tv->vval.v_dict->dv_lock, lp->ll_name, FALSE))
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00002516 ;
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002517 else if (lp->ll_range)
2518 {
Bram Moolenaarf2d912e2014-08-29 09:46:10 +02002519 listitem_T *ll_li = lp->ll_li;
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01002520 int ll_n1 = lp->ll_n1;
Bram Moolenaarf2d912e2014-08-29 09:46:10 +02002521
2522 /*
2523 * Check whether any of the list items is locked
2524 */
Bram Moolenaarb2a851f2014-12-07 00:18:33 +01002525 for (ri = rettv->vval.v_list->lv_first; ri != NULL && ll_li != NULL; )
Bram Moolenaarf2d912e2014-08-29 09:46:10 +02002526 {
Bram Moolenaar05c00c02019-02-11 22:00:11 +01002527 if (var_check_lock(ll_li->li_tv.v_lock, lp->ll_name, FALSE))
Bram Moolenaarf2d912e2014-08-29 09:46:10 +02002528 return;
2529 ri = ri->li_next;
2530 if (ri == NULL || (!lp->ll_empty2 && lp->ll_n2 == ll_n1))
2531 break;
2532 ll_li = ll_li->li_next;
2533 ++ll_n1;
2534 }
2535
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002536 /*
2537 * Assign the List values to the list items.
2538 */
2539 for (ri = rettv->vval.v_list->lv_first; ri != NULL; )
Bram Moolenaar6cc16192005-01-08 21:49:45 +00002540 {
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002541 if (op != NULL && *op != '=')
2542 tv_op(&lp->ll_li->li_tv, &ri->li_tv, op);
2543 else
2544 {
2545 clear_tv(&lp->ll_li->li_tv);
2546 copy_tv(&ri->li_tv, &lp->ll_li->li_tv);
2547 }
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002548 ri = ri->li_next;
2549 if (ri == NULL || (!lp->ll_empty2 && lp->ll_n2 == lp->ll_n1))
2550 break;
2551 if (lp->ll_li->li_next == NULL)
Bram Moolenaar6cc16192005-01-08 21:49:45 +00002552 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002553 /* Need to add an empty item. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00002554 if (list_append_number(lp->ll_list, 0) == FAIL)
Bram Moolenaar6cc16192005-01-08 21:49:45 +00002555 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002556 ri = NULL;
2557 break;
Bram Moolenaar6cc16192005-01-08 21:49:45 +00002558 }
Bram Moolenaar6cc16192005-01-08 21:49:45 +00002559 }
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002560 lp->ll_li = lp->ll_li->li_next;
2561 ++lp->ll_n1;
2562 }
2563 if (ri != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002564 emsg(_("E710: List value has more items than target"));
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002565 else if (lp->ll_empty2
2566 ? (lp->ll_li != NULL && lp->ll_li->li_next != NULL)
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002567 : lp->ll_n1 != lp->ll_n2)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002568 emsg(_("E711: List value has not enough items"));
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002569 }
2570 else
2571 {
2572 /*
2573 * Assign to a List or Dictionary item.
2574 */
2575 if (lp->ll_newkey != NULL)
2576 {
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002577 if (op != NULL && *op != '=')
2578 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002579 semsg(_(e_letwrong), op);
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002580 return;
2581 }
2582
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002583 /* Need to add an item to the Dictionary. */
Bram Moolenaarce5e58e2005-01-19 22:24:34 +00002584 di = dictitem_alloc(lp->ll_newkey);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002585 if (di == NULL)
2586 return;
Bram Moolenaarce5e58e2005-01-19 22:24:34 +00002587 if (dict_add(lp->ll_tv->vval.v_dict, di) == FAIL)
2588 {
2589 vim_free(di);
2590 return;
2591 }
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002592 lp->ll_tv = &di->di_tv;
Bram Moolenaar6cc16192005-01-08 21:49:45 +00002593 }
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002594 else if (op != NULL && *op != '=')
2595 {
2596 tv_op(lp->ll_tv, rettv, op);
2597 return;
2598 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00002599 else
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002600 clear_tv(lp->ll_tv);
Bram Moolenaar8c711452005-01-14 21:53:12 +00002601
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002602 /*
2603 * Assign the value to the variable or list item.
2604 */
2605 if (copy)
2606 copy_tv(rettv, lp->ll_tv);
2607 else
2608 {
2609 *lp->ll_tv = *rettv;
Bram Moolenaar758711c2005-02-02 23:11:38 +00002610 lp->ll_tv->v_lock = 0;
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00002611 init_tv(rettv);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00002612 }
2613 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00002614}
2615
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002616/*
Bram Moolenaarff697e62019-02-12 22:28:33 +01002617 * Handle "tv1 += tv2", "tv1 -= tv2", "tv1 *= tv2", "tv1 /= tv2", "tv1 %= tv2"
2618 * and "tv1 .= tv2"
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002619 * Returns OK or FAIL.
2620 */
2621 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01002622tv_op(typval_T *tv1, typval_T *tv2, char_u *op)
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002623{
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02002624 varnumber_T n;
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002625 char_u numbuf[NUMBUFLEN];
2626 char_u *s;
2627
Bram Moolenaar520e1e42016-01-23 19:46:28 +01002628 /* Can't do anything with a Funcref, Dict, v:true on the right. */
2629 if (tv2->v_type != VAR_FUNC && tv2->v_type != VAR_DICT
2630 && tv2->v_type != VAR_SPECIAL)
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002631 {
2632 switch (tv1->v_type)
2633 {
Bram Moolenaar835dc632016-02-07 14:27:38 +01002634 case VAR_UNKNOWN:
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002635 case VAR_DICT:
2636 case VAR_FUNC:
Bram Moolenaar1735bc92016-03-14 23:05:14 +01002637 case VAR_PARTIAL:
Bram Moolenaar520e1e42016-01-23 19:46:28 +01002638 case VAR_SPECIAL:
Bram Moolenaar835dc632016-02-07 14:27:38 +01002639 case VAR_JOB:
Bram Moolenaar77073442016-02-13 23:23:53 +01002640 case VAR_CHANNEL:
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002641 break;
2642
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002643 case VAR_BLOB:
2644 if (*op != '+' || tv2->v_type != VAR_BLOB)
2645 break;
2646 // BLOB += BLOB
2647 if (tv1->vval.v_blob != NULL && tv2->vval.v_blob != NULL)
2648 {
2649 blob_T *b1 = tv1->vval.v_blob;
2650 blob_T *b2 = tv2->vval.v_blob;
2651 int i, len = blob_len(b2);
2652 for (i = 0; i < len; i++)
2653 ga_append(&b1->bv_ga, blob_get(b2, i));
2654 }
2655 return OK;
2656
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002657 case VAR_LIST:
2658 if (*op != '+' || tv2->v_type != VAR_LIST)
2659 break;
Bram Moolenaarff697e62019-02-12 22:28:33 +01002660 // List += List
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002661 if (tv1->vval.v_list != NULL && tv2->vval.v_list != NULL)
2662 list_extend(tv1->vval.v_list, tv2->vval.v_list, NULL);
2663 return OK;
2664
2665 case VAR_NUMBER:
2666 case VAR_STRING:
2667 if (tv2->v_type == VAR_LIST)
2668 break;
Bram Moolenaarff697e62019-02-12 22:28:33 +01002669 if (vim_strchr((char_u *)"+-*/%", *op) != NULL)
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002670 {
Bram Moolenaarff697e62019-02-12 22:28:33 +01002671 // nr += nr , nr -= nr , nr *=nr , nr /= nr , nr %= nr
Bram Moolenaard155d7a2018-12-21 16:04:21 +01002672 n = tv_get_number(tv1);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00002673#ifdef FEAT_FLOAT
2674 if (tv2->v_type == VAR_FLOAT)
2675 {
2676 float_T f = n;
2677
Bram Moolenaarff697e62019-02-12 22:28:33 +01002678 if (*op == '%')
2679 break;
2680 switch (*op)
2681 {
2682 case '+': f += tv2->vval.v_float; break;
2683 case '-': f -= tv2->vval.v_float; break;
2684 case '*': f *= tv2->vval.v_float; break;
2685 case '/': f /= tv2->vval.v_float; break;
2686 }
Bram Moolenaar8c8de832008-06-24 22:58:06 +00002687 clear_tv(tv1);
2688 tv1->v_type = VAR_FLOAT;
2689 tv1->vval.v_float = f;
2690 }
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002691 else
Bram Moolenaar8c8de832008-06-24 22:58:06 +00002692#endif
2693 {
Bram Moolenaarff697e62019-02-12 22:28:33 +01002694 switch (*op)
2695 {
2696 case '+': n += tv_get_number(tv2); break;
2697 case '-': n -= tv_get_number(tv2); break;
2698 case '*': n *= tv_get_number(tv2); break;
Bram Moolenaare21c1582019-03-02 11:57:09 +01002699 case '/': n = num_divide(n, tv_get_number(tv2)); break;
2700 case '%': n = num_modulus(n, tv_get_number(tv2)); break;
Bram Moolenaarff697e62019-02-12 22:28:33 +01002701 }
Bram Moolenaar8c8de832008-06-24 22:58:06 +00002702 clear_tv(tv1);
2703 tv1->v_type = VAR_NUMBER;
2704 tv1->vval.v_number = n;
2705 }
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002706 }
2707 else
2708 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00002709 if (tv2->v_type == VAR_FLOAT)
2710 break;
2711
Bram Moolenaarff697e62019-02-12 22:28:33 +01002712 // str .= str
Bram Moolenaard155d7a2018-12-21 16:04:21 +01002713 s = tv_get_string(tv1);
2714 s = concat_str(s, tv_get_string_buf(tv2, numbuf));
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002715 clear_tv(tv1);
2716 tv1->v_type = VAR_STRING;
2717 tv1->vval.v_string = s;
2718 }
2719 return OK;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00002720
Bram Moolenaar8c8de832008-06-24 22:58:06 +00002721 case VAR_FLOAT:
Bram Moolenaar5fac4672016-03-02 22:16:32 +01002722#ifdef FEAT_FLOAT
Bram Moolenaar8c8de832008-06-24 22:58:06 +00002723 {
2724 float_T f;
2725
Bram Moolenaarff697e62019-02-12 22:28:33 +01002726 if (*op == '%' || *op == '.'
2727 || (tv2->v_type != VAR_FLOAT
Bram Moolenaar8c8de832008-06-24 22:58:06 +00002728 && tv2->v_type != VAR_NUMBER
2729 && tv2->v_type != VAR_STRING))
2730 break;
2731 if (tv2->v_type == VAR_FLOAT)
2732 f = tv2->vval.v_float;
2733 else
Bram Moolenaard155d7a2018-12-21 16:04:21 +01002734 f = tv_get_number(tv2);
Bram Moolenaarff697e62019-02-12 22:28:33 +01002735 switch (*op)
2736 {
2737 case '+': tv1->vval.v_float += f; break;
2738 case '-': tv1->vval.v_float -= f; break;
2739 case '*': tv1->vval.v_float *= f; break;
2740 case '/': tv1->vval.v_float /= f; break;
2741 }
Bram Moolenaar8c8de832008-06-24 22:58:06 +00002742 }
Bram Moolenaar8c8de832008-06-24 22:58:06 +00002743#endif
Bram Moolenaar5fac4672016-03-02 22:16:32 +01002744 return OK;
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002745 }
2746 }
2747
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002748 semsg(_(e_letwrong), op);
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00002749 return FAIL;
2750}
2751
2752/*
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002753 * Evaluate the expression used in a ":for var in expr" command.
2754 * "arg" points to "var".
2755 * Set "*errp" to TRUE for an error, FALSE otherwise;
2756 * Return a pointer that holds the info. Null when there is an error.
2757 */
2758 void *
Bram Moolenaar7454a062016-01-30 15:14:10 +01002759eval_for_line(
2760 char_u *arg,
2761 int *errp,
2762 char_u **nextcmdp,
2763 int skip)
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002764{
Bram Moolenaar33570922005-01-25 22:26:29 +00002765 forinfo_T *fi;
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002766 char_u *expr;
Bram Moolenaar33570922005-01-25 22:26:29 +00002767 typval_T tv;
2768 list_T *l;
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002769
2770 *errp = TRUE; /* default: there is an error */
2771
Bram Moolenaar33570922005-01-25 22:26:29 +00002772 fi = (forinfo_T *)alloc_clear(sizeof(forinfo_T));
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002773 if (fi == NULL)
2774 return NULL;
2775
2776 expr = skip_var_list(arg, &fi->fi_varcount, &fi->fi_semicolon);
2777 if (expr == NULL)
2778 return fi;
2779
2780 expr = skipwhite(expr);
Bram Moolenaar1c465442017-03-12 20:10:05 +01002781 if (expr[0] != 'i' || expr[1] != 'n' || !VIM_ISWHITE(expr[2]))
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002782 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002783 emsg(_("E690: Missing \"in\" after :for"));
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002784 return fi;
2785 }
2786
2787 if (skip)
2788 ++emsg_skip;
2789 if (eval0(skipwhite(expr + 2), &tv, nextcmdp, !skip) == OK)
2790 {
2791 *errp = FALSE;
2792 if (!skip)
2793 {
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002794 if (tv.v_type == VAR_LIST)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002795 {
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002796 l = tv.vval.v_list;
2797 if (l == NULL)
2798 {
2799 // a null list is like an empty list: do nothing
2800 clear_tv(&tv);
2801 }
2802 else
2803 {
2804 // No need to increment the refcount, it's already set for
2805 // the list being used in "tv".
2806 fi->fi_list = l;
2807 list_add_watch(l, &fi->fi_lw);
2808 fi->fi_lw.lw_item = l->lv_first;
2809 }
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002810 }
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002811 else if (tv.v_type == VAR_BLOB)
Bram Moolenaard8585ed2016-05-01 23:05:53 +02002812 {
Bram Moolenaardd29ea12019-01-23 21:56:21 +01002813 fi->fi_bi = 0;
2814 if (tv.vval.v_blob != NULL)
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002815 {
Bram Moolenaardd29ea12019-01-23 21:56:21 +01002816 typval_T btv;
2817
2818 // Make a copy, so that the iteration still works when the
2819 // blob is changed.
2820 blob_copy(&tv, &btv);
2821 fi->fi_blob = btv.vval.v_blob;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002822 }
Bram Moolenaardd29ea12019-01-23 21:56:21 +01002823 clear_tv(&tv);
Bram Moolenaard8585ed2016-05-01 23:05:53 +02002824 }
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002825 else
2826 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002827 emsg(_(e_listreq));
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002828 clear_tv(&tv);
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002829 }
2830 }
2831 }
2832 if (skip)
2833 --emsg_skip;
2834
2835 return fi;
2836}
2837
2838/*
2839 * Use the first item in a ":for" list. Advance to the next.
2840 * Assign the values to the variable (list). "arg" points to the first one.
2841 * Return TRUE when a valid item was found, FALSE when at end of list or
2842 * something wrong.
2843 */
2844 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01002845next_for_item(void *fi_void, char_u *arg)
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002846{
Bram Moolenaarc4b99e02013-06-23 14:30:47 +02002847 forinfo_T *fi = (forinfo_T *)fi_void;
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002848 int result;
Bram Moolenaar33570922005-01-25 22:26:29 +00002849 listitem_T *item;
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002850
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002851 if (fi->fi_blob != NULL)
2852 {
2853 typval_T tv;
2854
2855 if (fi->fi_bi >= blob_len(fi->fi_blob))
2856 return FALSE;
2857 tv.v_type = VAR_NUMBER;
2858 tv.v_lock = VAR_FIXED;
2859 tv.vval.v_number = blob_get(fi->fi_blob, fi->fi_bi);
2860 ++fi->fi_bi;
2861 return ex_let_vars(arg, &tv, TRUE,
2862 fi->fi_semicolon, fi->fi_varcount, NULL) == OK;
2863 }
2864
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002865 item = fi->fi_lw.lw_item;
2866 if (item == NULL)
2867 result = FALSE;
2868 else
2869 {
2870 fi->fi_lw.lw_item = item->li_next;
2871 result = (ex_let_vars(arg, &item->li_tv, TRUE,
2872 fi->fi_semicolon, fi->fi_varcount, NULL) == OK);
2873 }
2874 return result;
2875}
2876
2877/*
2878 * Free the structure used to store info used by ":for".
2879 */
2880 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01002881free_for_info(void *fi_void)
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002882{
Bram Moolenaar33570922005-01-25 22:26:29 +00002883 forinfo_T *fi = (forinfo_T *)fi_void;
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002884
Bram Moolenaarab7013c2005-01-09 21:23:56 +00002885 if (fi != NULL && fi->fi_list != NULL)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002886 {
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002887 list_rem_watch(fi->fi_list, &fi->fi_lw);
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002888 list_unref(fi->fi_list);
2889 }
Bram Moolenaarecc8bc42019-01-13 16:07:21 +01002890 if (fi != NULL && fi->fi_blob != NULL)
2891 blob_unref(fi->fi_blob);
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002892 vim_free(fi);
2893}
2894
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895#if defined(FEAT_CMDL_COMPL) || defined(PROTO)
2896
2897 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01002898set_context_for_expression(
2899 expand_T *xp,
2900 char_u *arg,
2901 cmdidx_T cmdidx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902{
2903 int got_eq = FALSE;
2904 int c;
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002905 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002907 if (cmdidx == CMD_let)
2908 {
2909 xp->xp_context = EXPAND_USER_VARS;
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00002910 if (vim_strpbrk(arg, (char_u *)"\"'+-*/%.=!?~|&$([<>,#") == NULL)
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002911 {
2912 /* ":let var1 var2 ...": find last space. */
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00002913 for (p = arg + STRLEN(arg); p >= arg; )
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002914 {
2915 xp->xp_pattern = p;
Bram Moolenaar91acfff2017-03-12 19:22:36 +01002916 MB_PTR_BACK(arg, p);
Bram Moolenaar1c465442017-03-12 20:10:05 +01002917 if (VIM_ISWHITE(*p))
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00002918 break;
2919 }
2920 return;
2921 }
2922 }
2923 else
2924 xp->xp_context = cmdidx == CMD_call ? EXPAND_FUNCTIONS
2925 : EXPAND_EXPRESSION;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002926 while ((xp->xp_pattern = vim_strpbrk(arg,
2927 (char_u *)"\"'+-*/%.=!?~|&$([<>,#")) != NULL)
2928 {
2929 c = *xp->xp_pattern;
2930 if (c == '&')
2931 {
2932 c = xp->xp_pattern[1];
2933 if (c == '&')
2934 {
2935 ++xp->xp_pattern;
2936 xp->xp_context = cmdidx != CMD_let || got_eq
2937 ? EXPAND_EXPRESSION : EXPAND_NOTHING;
2938 }
2939 else if (c != ' ')
Bram Moolenaar11cbeb12005-03-11 22:51:16 +00002940 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 xp->xp_context = EXPAND_SETTINGS;
Bram Moolenaar11cbeb12005-03-11 22:51:16 +00002942 if ((c == 'l' || c == 'g') && xp->xp_pattern[2] == ':')
2943 xp->xp_pattern += 2;
2944
2945 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946 }
2947 else if (c == '$')
2948 {
2949 /* environment variable */
2950 xp->xp_context = EXPAND_ENV_VARS;
2951 }
2952 else if (c == '=')
2953 {
2954 got_eq = TRUE;
2955 xp->xp_context = EXPAND_EXPRESSION;
2956 }
Bram Moolenaara32095f2016-03-28 19:27:13 +02002957 else if (c == '#'
2958 && xp->xp_context == EXPAND_EXPRESSION)
2959 {
2960 /* Autoload function/variable contains '#'. */
2961 break;
2962 }
Bram Moolenaar8a349ff2014-11-12 20:09:06 +01002963 else if ((c == '<' || c == '#')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 && xp->xp_context == EXPAND_FUNCTIONS
2965 && vim_strchr(xp->xp_pattern, '(') == NULL)
2966 {
Bram Moolenaar8a349ff2014-11-12 20:09:06 +01002967 /* Function name can start with "<SNR>" and contain '#'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968 break;
2969 }
2970 else if (cmdidx != CMD_let || got_eq)
2971 {
2972 if (c == '"') /* string */
2973 {
2974 while ((c = *++xp->xp_pattern) != NUL && c != '"')
2975 if (c == '\\' && xp->xp_pattern[1] != NUL)
2976 ++xp->xp_pattern;
2977 xp->xp_context = EXPAND_NOTHING;
2978 }
2979 else if (c == '\'') /* literal string */
2980 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00002981 /* Trick: '' is like stopping and starting a literal string. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982 while ((c = *++xp->xp_pattern) != NUL && c != '\'')
2983 /* skip */ ;
2984 xp->xp_context = EXPAND_NOTHING;
2985 }
2986 else if (c == '|')
2987 {
2988 if (xp->xp_pattern[1] == '|')
2989 {
2990 ++xp->xp_pattern;
2991 xp->xp_context = EXPAND_EXPRESSION;
2992 }
2993 else
2994 xp->xp_context = EXPAND_COMMANDS;
2995 }
2996 else
2997 xp->xp_context = EXPAND_EXPRESSION;
2998 }
2999 else
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00003000 /* Doesn't look like something valid, expand as an expression
3001 * anyway. */
3002 xp->xp_context = EXPAND_EXPRESSION;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 arg = xp->xp_pattern;
3004 if (*arg != NUL)
3005 while ((c = *++arg) != NUL && (c == ' ' || c == '\t'))
3006 /* skip */ ;
3007 }
3008 xp->xp_pattern = arg;
3009}
3010
3011#endif /* FEAT_CMDL_COMPL */
3012
3013/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014 * ":unlet[!] var1 ... " command.
3015 */
3016 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01003017ex_unlet(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018{
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003019 ex_unletlock(eap, eap->arg, 0);
3020}
3021
3022/*
3023 * ":lockvar" and ":unlockvar" commands
3024 */
3025 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01003026ex_lockvar(exarg_T *eap)
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003027{
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 char_u *arg = eap->arg;
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003029 int deep = 2;
3030
3031 if (eap->forceit)
3032 deep = -1;
3033 else if (vim_isdigit(*arg))
3034 {
3035 deep = getdigits(&arg);
3036 arg = skipwhite(arg);
3037 }
3038
3039 ex_unletlock(eap, arg, deep);
3040}
3041
3042/*
3043 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
3044 */
3045 static void
Bram Moolenaar7454a062016-01-30 15:14:10 +01003046ex_unletlock(
3047 exarg_T *eap,
3048 char_u *argstart,
3049 int deep)
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003050{
3051 char_u *arg = argstart;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 char_u *name_end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 int error = FALSE;
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003054 lval_T lv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055
3056 do
3057 {
Bram Moolenaar137374f2018-05-13 15:59:50 +02003058 if (*arg == '$')
3059 {
3060 char_u *name = ++arg;
3061
3062 if (get_env_len(&arg) == 0)
3063 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003064 semsg(_(e_invarg2), name - 1);
Bram Moolenaar137374f2018-05-13 15:59:50 +02003065 return;
3066 }
3067 vim_unsetenv(name);
3068 arg = skipwhite(arg);
3069 continue;
3070 }
3071
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00003072 /* Parse the name and find the end. */
Bram Moolenaar6d977d62014-01-14 15:24:39 +01003073 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error, 0,
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00003074 FNE_CHECK_START);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00003075 if (lv.ll_name == NULL)
3076 error = TRUE; /* error but continue parsing */
Bram Moolenaar1c465442017-03-12 20:10:05 +01003077 if (name_end == NULL || (!VIM_ISWHITE(*name_end)
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00003078 && !ends_excmd(*name_end)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00003080 if (name_end != NULL)
3081 {
3082 emsg_severe = TRUE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003083 emsg(_(e_trailing));
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00003084 }
3085 if (!(eap->skip || error))
3086 clear_lval(&lv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 break;
3088 }
3089
3090 if (!error && !eap->skip)
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003091 {
3092 if (eap->cmdidx == CMD_unlet)
3093 {
3094 if (do_unlet_var(&lv, name_end, eap->forceit) == FAIL)
3095 error = TRUE;
3096 }
3097 else
3098 {
3099 if (do_lock_var(&lv, name_end, deep,
3100 eap->cmdidx == CMD_lockvar) == FAIL)
3101 error = TRUE;
3102 }
3103 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00003105 if (!eap->skip)
3106 clear_lval(&lv);
3107
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 arg = skipwhite(name_end);
3109 } while (!ends_excmd(*arg));
3110
3111 eap->nextcmd = check_nextcmd(arg);
3112}
3113
Bram Moolenaar8c711452005-01-14 21:53:12 +00003114 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01003115do_unlet_var(
3116 lval_T *lp,
3117 char_u *name_end,
3118 int forceit)
Bram Moolenaar8c711452005-01-14 21:53:12 +00003119{
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00003120 int ret = OK;
3121 int cc;
3122
3123 if (lp->ll_tv == NULL)
Bram Moolenaar8c711452005-01-14 21:53:12 +00003124 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00003125 cc = *name_end;
3126 *name_end = NUL;
3127
3128 /* Normal name or expanded name. */
Bram Moolenaar79518e22017-02-17 16:31:35 +01003129 if (do_unlet(lp->ll_name, forceit) == FAIL)
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00003130 ret = FAIL;
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00003131 *name_end = cc;
Bram Moolenaar8c711452005-01-14 21:53:12 +00003132 }
Bram Moolenaar9bc174b2015-04-13 16:16:38 +02003133 else if ((lp->ll_list != NULL
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003134 && var_check_lock(lp->ll_list->lv_lock, lp->ll_name, FALSE))
Bram Moolenaar9bc174b2015-04-13 16:16:38 +02003135 || (lp->ll_dict != NULL
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003136 && var_check_lock(lp->ll_dict->dv_lock, lp->ll_name, FALSE)))
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003137 return FAIL;
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00003138 else if (lp->ll_range)
3139 {
Bram Moolenaar33570922005-01-25 22:26:29 +00003140 listitem_T *li;
Bram Moolenaarf2d912e2014-08-29 09:46:10 +02003141 listitem_T *ll_li = lp->ll_li;
Bram Moolenaarc9703302016-01-17 21:49:33 +01003142 int ll_n1 = lp->ll_n1;
Bram Moolenaarf2d912e2014-08-29 09:46:10 +02003143
3144 while (ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= ll_n1))
3145 {
3146 li = ll_li->li_next;
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003147 if (var_check_lock(ll_li->li_tv.v_lock, lp->ll_name, FALSE))
Bram Moolenaarf2d912e2014-08-29 09:46:10 +02003148 return FAIL;
3149 ll_li = li;
3150 ++ll_n1;
3151 }
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00003152
3153 /* Delete a range of List items. */
3154 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3155 {
3156 li = lp->ll_li->li_next;
3157 listitem_remove(lp->ll_list, lp->ll_li);
3158 lp->ll_li = li;
3159 ++lp->ll_n1;
3160 }
3161 }
3162 else
3163 {
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00003164 if (lp->ll_list != NULL)
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00003165 /* unlet a List item. */
3166 listitem_remove(lp->ll_list, lp->ll_li);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00003167 else
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00003168 /* unlet a Dictionary item. */
Bram Moolenaarce5e58e2005-01-19 22:24:34 +00003169 dictitem_remove(lp->ll_dict, lp->ll_di);
Bram Moolenaar7480b5c2005-01-16 22:07:38 +00003170 }
3171
3172 return ret;
Bram Moolenaar8c711452005-01-14 21:53:12 +00003173}
3174
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175/*
3176 * "unlet" a variable. Return OK if it existed, FAIL if not.
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003177 * When "forceit" is TRUE don't complain if the variable doesn't exist.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 */
3179 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01003180do_unlet(char_u *name, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181{
Bram Moolenaar33570922005-01-25 22:26:29 +00003182 hashtab_T *ht;
3183 hashitem_T *hi;
Bram Moolenaara7043832005-01-21 11:56:39 +00003184 char_u *varname;
Bram Moolenaar9bc174b2015-04-13 16:16:38 +02003185 dict_T *d;
Bram Moolenaarafbdeb82008-01-05 21:16:31 +00003186 dictitem_T *di;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187
Bram Moolenaar33570922005-01-25 22:26:29 +00003188 ht = find_var_ht(name, &varname);
3189 if (ht != NULL && *varname != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003191 d = get_current_funccal_dict(ht);
Bram Moolenaar71bcfdf2016-01-09 18:20:46 +01003192 if (d == NULL)
3193 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003194 if (ht == &globvarht)
3195 d = &globvardict;
3196 else if (ht == &compat_hashtab)
3197 d = &vimvardict;
3198 else
3199 {
3200 di = find_var_in_ht(ht, *name, (char_u *)"", FALSE);
3201 d = di == NULL ? NULL : di->di_tv.vval.v_dict;
3202 }
3203 if (d == NULL)
3204 {
Bram Moolenaar95f09602016-11-10 20:01:45 +01003205 internal_error("do_unlet()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003206 return FAIL;
3207 }
Bram Moolenaar71bcfdf2016-01-09 18:20:46 +01003208 }
Bram Moolenaar33570922005-01-25 22:26:29 +00003209 hi = hash_find(ht, varname);
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003210 if (HASHITEM_EMPTY(hi))
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02003211 hi = find_hi_in_scoped_ht(name, &ht);
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003212 if (hi != NULL && !HASHITEM_EMPTY(hi))
Bram Moolenaara7043832005-01-21 11:56:39 +00003213 {
Bram Moolenaarafbdeb82008-01-05 21:16:31 +00003214 di = HI2DI(hi);
Bram Moolenaar77354e72015-04-21 16:49:05 +02003215 if (var_check_fixed(di->di_flags, name, FALSE)
Bram Moolenaar71bcfdf2016-01-09 18:20:46 +01003216 || var_check_ro(di->di_flags, name, FALSE)
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003217 || var_check_lock(d->dv_lock, name, FALSE))
Bram Moolenaaraf8af8b2016-01-04 22:05:24 +01003218 return FAIL;
3219
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003220 delete_var(ht, hi);
3221 return OK;
Bram Moolenaara7043832005-01-21 11:56:39 +00003222 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 }
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003224 if (forceit)
3225 return OK;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003226 semsg(_("E108: No such variable: \"%s\""), name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 return FAIL;
3228}
3229
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003230/*
3231 * Lock or unlock variable indicated by "lp".
3232 * "deep" is the levels to go (-1 for unlimited);
3233 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
3234 */
3235 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01003236do_lock_var(
3237 lval_T *lp,
3238 char_u *name_end,
3239 int deep,
3240 int lock)
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003241{
3242 int ret = OK;
3243 int cc;
3244 dictitem_T *di;
3245
3246 if (deep == 0) /* nothing to do */
3247 return OK;
3248
3249 if (lp->ll_tv == NULL)
3250 {
3251 cc = *name_end;
3252 *name_end = NUL;
3253
3254 /* Normal name or expanded name. */
Bram Moolenaar79518e22017-02-17 16:31:35 +01003255 di = find_var(lp->ll_name, NULL, TRUE);
3256 if (di == NULL)
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003257 ret = FAIL;
Bram Moolenaare7877fe2017-02-20 22:35:33 +01003258 else if ((di->di_flags & DI_FLAGS_FIX)
3259 && di->di_tv.v_type != VAR_DICT
3260 && di->di_tv.v_type != VAR_LIST)
3261 /* For historic reasons this error is not given for a list or dict.
3262 * E.g., the b: dict could be locked/unlocked. */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003263 semsg(_("E940: Cannot lock or unlock variable %s"), lp->ll_name);
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003264 else
3265 {
Bram Moolenaar79518e22017-02-17 16:31:35 +01003266 if (lock)
3267 di->di_flags |= DI_FLAGS_LOCK;
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003268 else
Bram Moolenaar79518e22017-02-17 16:31:35 +01003269 di->di_flags &= ~DI_FLAGS_LOCK;
3270 item_lock(&di->di_tv, deep, lock);
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003271 }
3272 *name_end = cc;
3273 }
3274 else if (lp->ll_range)
3275 {
3276 listitem_T *li = lp->ll_li;
3277
3278 /* (un)lock a range of List items. */
3279 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3280 {
3281 item_lock(&li->li_tv, deep, lock);
3282 li = li->li_next;
3283 ++lp->ll_n1;
3284 }
3285 }
3286 else if (lp->ll_list != NULL)
3287 /* (un)lock a List item. */
3288 item_lock(&lp->ll_li->li_tv, deep, lock);
3289 else
Bram Moolenaar641e48c2015-06-25 16:09:26 +02003290 /* (un)lock a Dictionary item. */
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003291 item_lock(&lp->ll_di->di_tv, deep, lock);
3292
3293 return ret;
3294}
3295
3296/*
3297 * Lock or unlock an item. "deep" is nr of levels to go.
3298 */
3299 static void
Bram Moolenaar7454a062016-01-30 15:14:10 +01003300item_lock(typval_T *tv, int deep, int lock)
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003301{
3302 static int recurse = 0;
3303 list_T *l;
3304 listitem_T *li;
3305 dict_T *d;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01003306 blob_T *b;
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003307 hashitem_T *hi;
3308 int todo;
3309
3310 if (recurse >= DICT_MAXNEST)
3311 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003312 emsg(_("E743: variable nested too deep for (un)lock"));
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003313 return;
3314 }
3315 if (deep == 0)
3316 return;
3317 ++recurse;
3318
3319 /* lock/unlock the item itself */
3320 if (lock)
3321 tv->v_lock |= VAR_LOCKED;
3322 else
3323 tv->v_lock &= ~VAR_LOCKED;
3324
3325 switch (tv->v_type)
3326 {
Bram Moolenaara03f2332016-02-06 18:09:59 +01003327 case VAR_UNKNOWN:
3328 case VAR_NUMBER:
3329 case VAR_STRING:
3330 case VAR_FUNC:
Bram Moolenaar1735bc92016-03-14 23:05:14 +01003331 case VAR_PARTIAL:
Bram Moolenaara03f2332016-02-06 18:09:59 +01003332 case VAR_FLOAT:
3333 case VAR_SPECIAL:
Bram Moolenaar835dc632016-02-07 14:27:38 +01003334 case VAR_JOB:
Bram Moolenaar77073442016-02-13 23:23:53 +01003335 case VAR_CHANNEL:
Bram Moolenaara03f2332016-02-06 18:09:59 +01003336 break;
3337
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01003338 case VAR_BLOB:
3339 if ((b = tv->vval.v_blob) != NULL)
3340 {
3341 if (lock)
3342 b->bv_lock |= VAR_LOCKED;
3343 else
3344 b->bv_lock &= ~VAR_LOCKED;
3345 }
3346 break;
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003347 case VAR_LIST:
3348 if ((l = tv->vval.v_list) != NULL)
3349 {
3350 if (lock)
3351 l->lv_lock |= VAR_LOCKED;
3352 else
3353 l->lv_lock &= ~VAR_LOCKED;
3354 if (deep < 0 || deep > 1)
3355 /* recursive: lock/unlock the items the List contains */
3356 for (li = l->lv_first; li != NULL; li = li->li_next)
3357 item_lock(&li->li_tv, deep - 1, lock);
3358 }
3359 break;
3360 case VAR_DICT:
3361 if ((d = tv->vval.v_dict) != NULL)
3362 {
3363 if (lock)
3364 d->dv_lock |= VAR_LOCKED;
3365 else
3366 d->dv_lock &= ~VAR_LOCKED;
3367 if (deep < 0 || deep > 1)
3368 {
3369 /* recursive: lock/unlock the items the List contains */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003370 todo = (int)d->dv_hashtab.ht_used;
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00003371 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
3372 {
3373 if (!HASHITEM_EMPTY(hi))
3374 {
3375 --todo;
3376 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
3377 }
3378 }
3379 }
3380 }
3381 }
3382 --recurse;
3383}
3384
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385#if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
3386/*
3387 * Delete all "menutrans_" variables.
3388 */
3389 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01003390del_menutrans_vars(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391{
Bram Moolenaar33570922005-01-25 22:26:29 +00003392 hashitem_T *hi;
Bram Moolenaara7043832005-01-21 11:56:39 +00003393 int todo;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394
Bram Moolenaar33570922005-01-25 22:26:29 +00003395 hash_lock(&globvarht);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003396 todo = (int)globvarht.ht_used;
Bram Moolenaar33570922005-01-25 22:26:29 +00003397 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara7043832005-01-21 11:56:39 +00003398 {
3399 if (!HASHITEM_EMPTY(hi))
3400 {
3401 --todo;
Bram Moolenaar33570922005-01-25 22:26:29 +00003402 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
3403 delete_var(&globvarht, hi);
Bram Moolenaara7043832005-01-21 11:56:39 +00003404 }
3405 }
Bram Moolenaar33570922005-01-25 22:26:29 +00003406 hash_unlock(&globvarht);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407}
3408#endif
3409
3410#if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3411
3412/*
3413 * Local string buffer for the next two functions to store a variable name
3414 * with its prefix. Allocated in cat_prefix_varname(), freed later in
3415 * get_user_var_name().
3416 */
3417
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418static char_u *varnamebuf = NULL;
3419static int varnamebuflen = 0;
3420
3421/*
3422 * Function to concatenate a prefix and a variable name.
3423 */
3424 static char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01003425cat_prefix_varname(int prefix, char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426{
3427 int len;
3428
3429 len = (int)STRLEN(name) + 3;
3430 if (len > varnamebuflen)
3431 {
3432 vim_free(varnamebuf);
3433 len += 10; /* some additional space */
3434 varnamebuf = alloc(len);
3435 if (varnamebuf == NULL)
3436 {
3437 varnamebuflen = 0;
3438 return NULL;
3439 }
3440 varnamebuflen = len;
3441 }
3442 *varnamebuf = prefix;
3443 varnamebuf[1] = ':';
3444 STRCPY(varnamebuf + 2, name);
3445 return varnamebuf;
3446}
3447
3448/*
3449 * Function given to ExpandGeneric() to obtain the list of user defined
3450 * (global/buffer/window/built-in) variable names.
3451 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01003453get_user_var_name(expand_T *xp, int idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454{
Bram Moolenaar532c7802005-01-27 14:44:31 +00003455 static long_u gdone;
3456 static long_u bdone;
3457 static long_u wdone;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003458 static long_u tdone;
Bram Moolenaar532c7802005-01-27 14:44:31 +00003459 static int vidx;
3460 static hashitem_T *hi;
3461 hashtab_T *ht;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462
3463 if (idx == 0)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003464 {
Bram Moolenaara7043832005-01-21 11:56:39 +00003465 gdone = bdone = wdone = vidx = 0;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003466 tdone = 0;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003467 }
Bram Moolenaar33570922005-01-25 22:26:29 +00003468
3469 /* Global variables */
3470 if (gdone < globvarht.ht_used)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471 {
Bram Moolenaara7043832005-01-21 11:56:39 +00003472 if (gdone++ == 0)
Bram Moolenaar33570922005-01-25 22:26:29 +00003473 hi = globvarht.ht_array;
Bram Moolenaar532c7802005-01-27 14:44:31 +00003474 else
3475 ++hi;
Bram Moolenaara7043832005-01-21 11:56:39 +00003476 while (HASHITEM_EMPTY(hi))
3477 ++hi;
3478 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
3479 return cat_prefix_varname('g', hi->hi_key);
3480 return hi->hi_key;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481 }
Bram Moolenaar33570922005-01-25 22:26:29 +00003482
3483 /* b: variables */
Bram Moolenaar429fa852013-04-15 12:27:36 +02003484 ht = &curbuf->b_vars->dv_hashtab;
Bram Moolenaar33570922005-01-25 22:26:29 +00003485 if (bdone < ht->ht_used)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486 {
Bram Moolenaara7043832005-01-21 11:56:39 +00003487 if (bdone++ == 0)
Bram Moolenaar33570922005-01-25 22:26:29 +00003488 hi = ht->ht_array;
Bram Moolenaar532c7802005-01-27 14:44:31 +00003489 else
3490 ++hi;
Bram Moolenaara7043832005-01-21 11:56:39 +00003491 while (HASHITEM_EMPTY(hi))
3492 ++hi;
3493 return cat_prefix_varname('b', hi->hi_key);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494 }
Bram Moolenaar33570922005-01-25 22:26:29 +00003495
3496 /* w: variables */
Bram Moolenaar429fa852013-04-15 12:27:36 +02003497 ht = &curwin->w_vars->dv_hashtab;
Bram Moolenaar33570922005-01-25 22:26:29 +00003498 if (wdone < ht->ht_used)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 {
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00003500 if (wdone++ == 0)
Bram Moolenaar33570922005-01-25 22:26:29 +00003501 hi = ht->ht_array;
Bram Moolenaar532c7802005-01-27 14:44:31 +00003502 else
3503 ++hi;
Bram Moolenaara7043832005-01-21 11:56:39 +00003504 while (HASHITEM_EMPTY(hi))
3505 ++hi;
3506 return cat_prefix_varname('w', hi->hi_key);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507 }
Bram Moolenaar33570922005-01-25 22:26:29 +00003508
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003509 /* t: variables */
Bram Moolenaar429fa852013-04-15 12:27:36 +02003510 ht = &curtab->tp_vars->dv_hashtab;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003511 if (tdone < ht->ht_used)
3512 {
3513 if (tdone++ == 0)
3514 hi = ht->ht_array;
3515 else
3516 ++hi;
3517 while (HASHITEM_EMPTY(hi))
3518 ++hi;
3519 return cat_prefix_varname('t', hi->hi_key);
3520 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003521
Bram Moolenaar33570922005-01-25 22:26:29 +00003522 /* v: variables */
3523 if (vidx < VV_LEN)
3524 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525
Bram Moolenaard23a8232018-02-10 18:45:26 +01003526 VIM_CLEAR(varnamebuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 varnamebuflen = 0;
3528 return NULL;
3529}
3530
3531#endif /* FEAT_CMDL_COMPL */
3532
3533/*
Bram Moolenaarea6553b2016-03-27 15:13:38 +02003534 * Return TRUE if "pat" matches "text".
3535 * Does not use 'cpo' and always uses 'magic'.
3536 */
3537 static int
3538pattern_match(char_u *pat, char_u *text, int ic)
3539{
3540 int matches = FALSE;
3541 char_u *save_cpo;
3542 regmatch_T regmatch;
3543
3544 /* avoid 'l' flag in 'cpoptions' */
3545 save_cpo = p_cpo;
3546 p_cpo = (char_u *)"";
3547 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
3548 if (regmatch.regprog != NULL)
3549 {
3550 regmatch.rm_ic = ic;
3551 matches = vim_regexec_nl(&regmatch, text, (colnr_T)0);
3552 vim_regfree(regmatch.regprog);
3553 }
3554 p_cpo = save_cpo;
3555 return matches;
3556}
3557
3558/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559 * The "evaluate" argument: When FALSE, the argument is only parsed but not
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003560 * executed. The function may return OK, but the rettv will be of type
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561 * VAR_UNKNOWN. The function still returns FAIL for a syntax error.
3562 */
3563
3564/*
3565 * Handle zero level expression.
3566 * This calls eval1() and handles error message and nextcmd.
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003567 * Put the result in "rettv" when returning OK and "evaluate" is TRUE.
Bram Moolenaar4463f292005-09-25 22:20:24 +00003568 * Note: "rettv.v_lock" is not set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569 * Return OK or FAIL.
3570 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003571 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01003572eval0(
3573 char_u *arg,
3574 typval_T *rettv,
3575 char_u **nextcmd,
3576 int evaluate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577{
3578 int ret;
3579 char_u *p;
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01003580 int did_emsg_before = did_emsg;
3581 int called_emsg_before = called_emsg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582
3583 p = skipwhite(arg);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003584 ret = eval1(&p, rettv, evaluate);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 if (ret == FAIL || !ends_excmd(*p))
3586 {
3587 if (ret != FAIL)
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003588 clear_tv(rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 /*
3590 * Report the invalid expression unless the expression evaluation has
3591 * been cancelled due to an aborting error, an interrupt, or an
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01003592 * exception, or we already gave a more specific error.
3593 * Also check called_emsg for when using assert_fails().
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 */
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01003595 if (!aborting() && did_emsg == did_emsg_before
3596 && called_emsg == called_emsg_before)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003597 semsg(_(e_invexpr2), arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 ret = FAIL;
3599 }
3600 if (nextcmd != NULL)
3601 *nextcmd = check_nextcmd(p);
3602
3603 return ret;
3604}
3605
3606/*
3607 * Handle top level expression:
Bram Moolenaarb67cc162009-02-04 15:27:06 +00003608 * expr2 ? expr1 : expr1
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609 *
3610 * "arg" must point to the first non-white of the expression.
3611 * "arg" is advanced to the next non-white after the recognized expression.
3612 *
Bram Moolenaar4463f292005-09-25 22:20:24 +00003613 * Note: "rettv.v_lock" is not set.
3614 *
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 * Return OK or FAIL.
3616 */
Bram Moolenaarcd524592016-07-17 14:57:05 +02003617 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01003618eval1(char_u **arg, typval_T *rettv, int evaluate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619{
3620 int result;
Bram Moolenaar33570922005-01-25 22:26:29 +00003621 typval_T var2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622
3623 /*
3624 * Get the first variable.
3625 */
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003626 if (eval2(arg, rettv, evaluate) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 return FAIL;
3628
3629 if ((*arg)[0] == '?')
3630 {
3631 result = FALSE;
3632 if (evaluate)
3633 {
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00003634 int error = FALSE;
3635
Bram Moolenaard155d7a2018-12-21 16:04:21 +01003636 if (tv_get_number_chk(rettv, &error) != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 result = TRUE;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003638 clear_tv(rettv);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00003639 if (error)
3640 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 }
3642
3643 /*
3644 * Get the second variable.
3645 */
3646 *arg = skipwhite(*arg + 1);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003647 if (eval1(arg, rettv, evaluate && result) == FAIL) /* recursive! */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 return FAIL;
3649
3650 /*
3651 * Check for the ":".
3652 */
3653 if ((*arg)[0] != ':')
3654 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003655 emsg(_("E109: Missing ':' after '?'"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656 if (evaluate && result)
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003657 clear_tv(rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003658 return FAIL;
3659 }
3660
3661 /*
3662 * Get the third variable.
3663 */
3664 *arg = skipwhite(*arg + 1);
3665 if (eval1(arg, &var2, evaluate && !result) == FAIL) /* recursive! */
3666 {
3667 if (evaluate && result)
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003668 clear_tv(rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 return FAIL;
3670 }
3671 if (evaluate && !result)
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003672 *rettv = var2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 }
3674
3675 return OK;
3676}
3677
3678/*
3679 * Handle first level expression:
3680 * expr2 || expr2 || expr2 logical OR
3681 *
3682 * "arg" must point to the first non-white of the expression.
3683 * "arg" is advanced to the next non-white after the recognized expression.
3684 *
3685 * Return OK or FAIL.
3686 */
3687 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01003688eval2(char_u **arg, typval_T *rettv, int evaluate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689{
Bram Moolenaar33570922005-01-25 22:26:29 +00003690 typval_T var2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 long result;
3692 int first;
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00003693 int error = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694
3695 /*
3696 * Get the first variable.
3697 */
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003698 if (eval3(arg, rettv, evaluate) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 return FAIL;
3700
3701 /*
3702 * Repeat until there is no following "||".
3703 */
3704 first = TRUE;
3705 result = FALSE;
3706 while ((*arg)[0] == '|' && (*arg)[1] == '|')
3707 {
3708 if (evaluate && first)
3709 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01003710 if (tv_get_number_chk(rettv, &error) != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003711 result = TRUE;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003712 clear_tv(rettv);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00003713 if (error)
3714 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715 first = FALSE;
3716 }
3717
3718 /*
3719 * Get the second variable.
3720 */
3721 *arg = skipwhite(*arg + 2);
3722 if (eval3(arg, &var2, evaluate && !result) == FAIL)
3723 return FAIL;
3724
3725 /*
3726 * Compute the result.
3727 */
3728 if (evaluate && !result)
3729 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01003730 if (tv_get_number_chk(&var2, &error) != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731 result = TRUE;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003732 clear_tv(&var2);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00003733 if (error)
3734 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735 }
3736 if (evaluate)
3737 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003738 rettv->v_type = VAR_NUMBER;
3739 rettv->vval.v_number = result;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 }
3741 }
3742
3743 return OK;
3744}
3745
3746/*
3747 * Handle second level expression:
3748 * expr3 && expr3 && expr3 logical AND
3749 *
3750 * "arg" must point to the first non-white of the expression.
3751 * "arg" is advanced to the next non-white after the recognized expression.
3752 *
3753 * Return OK or FAIL.
3754 */
3755 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01003756eval3(char_u **arg, typval_T *rettv, int evaluate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757{
Bram Moolenaar33570922005-01-25 22:26:29 +00003758 typval_T var2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759 long result;
3760 int first;
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00003761 int error = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762
3763 /*
3764 * Get the first variable.
3765 */
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003766 if (eval4(arg, rettv, evaluate) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 return FAIL;
3768
3769 /*
3770 * Repeat until there is no following "&&".
3771 */
3772 first = TRUE;
3773 result = TRUE;
3774 while ((*arg)[0] == '&' && (*arg)[1] == '&')
3775 {
3776 if (evaluate && first)
3777 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01003778 if (tv_get_number_chk(rettv, &error) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 result = FALSE;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003780 clear_tv(rettv);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00003781 if (error)
3782 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 first = FALSE;
3784 }
3785
3786 /*
3787 * Get the second variable.
3788 */
3789 *arg = skipwhite(*arg + 2);
3790 if (eval4(arg, &var2, evaluate && result) == FAIL)
3791 return FAIL;
3792
3793 /*
3794 * Compute the result.
3795 */
3796 if (evaluate && result)
3797 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01003798 if (tv_get_number_chk(&var2, &error) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799 result = FALSE;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003800 clear_tv(&var2);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00003801 if (error)
3802 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 }
3804 if (evaluate)
3805 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003806 rettv->v_type = VAR_NUMBER;
3807 rettv->vval.v_number = result;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 }
3809 }
3810
3811 return OK;
3812}
3813
3814/*
3815 * Handle third level expression:
3816 * var1 == var2
3817 * var1 =~ var2
3818 * var1 != var2
3819 * var1 !~ var2
3820 * var1 > var2
3821 * var1 >= var2
3822 * var1 < var2
3823 * var1 <= var2
Bram Moolenaar8a283e52005-01-06 23:28:25 +00003824 * var1 is var2
3825 * var1 isnot var2
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 *
3827 * "arg" must point to the first non-white of the expression.
3828 * "arg" is advanced to the next non-white after the recognized expression.
3829 *
3830 * Return OK or FAIL.
3831 */
3832 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01003833eval4(char_u **arg, typval_T *rettv, int evaluate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834{
Bram Moolenaar33570922005-01-25 22:26:29 +00003835 typval_T var2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 char_u *p;
3837 int i;
3838 exptype_T type = TYPE_UNKNOWN;
Bram Moolenaar8a283e52005-01-06 23:28:25 +00003839 int type_is = FALSE; /* TRUE for "is" and "isnot" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003840 int len = 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 int ic;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842
3843 /*
3844 * Get the first variable.
3845 */
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003846 if (eval5(arg, rettv, evaluate) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 return FAIL;
3848
3849 p = *arg;
3850 switch (p[0])
3851 {
3852 case '=': if (p[1] == '=')
3853 type = TYPE_EQUAL;
3854 else if (p[1] == '~')
3855 type = TYPE_MATCH;
3856 break;
3857 case '!': if (p[1] == '=')
3858 type = TYPE_NEQUAL;
3859 else if (p[1] == '~')
3860 type = TYPE_NOMATCH;
3861 break;
3862 case '>': if (p[1] != '=')
3863 {
3864 type = TYPE_GREATER;
3865 len = 1;
3866 }
3867 else
3868 type = TYPE_GEQUAL;
3869 break;
3870 case '<': if (p[1] != '=')
3871 {
3872 type = TYPE_SMALLER;
3873 len = 1;
3874 }
3875 else
3876 type = TYPE_SEQUAL;
3877 break;
Bram Moolenaar8a283e52005-01-06 23:28:25 +00003878 case 'i': if (p[1] == 's')
3879 {
3880 if (p[2] == 'n' && p[3] == 'o' && p[4] == 't')
3881 len = 5;
Bram Moolenaar37a8de12015-09-01 16:05:00 +02003882 i = p[len];
3883 if (!isalnum(i) && i != '_')
Bram Moolenaar8a283e52005-01-06 23:28:25 +00003884 {
3885 type = len == 2 ? TYPE_EQUAL : TYPE_NEQUAL;
3886 type_is = TRUE;
3887 }
3888 }
3889 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890 }
3891
3892 /*
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003893 * If there is a comparative operator, use it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 */
3895 if (type != TYPE_UNKNOWN)
3896 {
3897 /* extra question mark appended: ignore case */
3898 if (p[len] == '?')
3899 {
3900 ic = TRUE;
3901 ++len;
3902 }
3903 /* extra '#' appended: match case */
3904 else if (p[len] == '#')
3905 {
3906 ic = FALSE;
3907 ++len;
3908 }
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003909 /* nothing appended: use 'ignorecase' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 else
3911 ic = p_ic;
3912
3913 /*
3914 * Get the second variable.
3915 */
3916 *arg = skipwhite(p + len);
3917 if (eval5(arg, &var2, evaluate) == FAIL)
3918 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00003919 clear_tv(rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920 return FAIL;
3921 }
Bram Moolenaar31988702018-02-13 12:57:42 +01003922 if (evaluate)
3923 {
3924 int ret = typval_compare(rettv, &var2, type, type_is, ic);
3925
3926 clear_tv(&var2);
3927 return ret;
3928 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 }
3930
3931 return OK;
3932}
3933
3934/*
3935 * Handle fourth level expression:
3936 * + number addition
3937 * - number subtraction
Bram Moolenaar558ca4a2019-04-04 18:15:38 +02003938 * . string concatenation (if script version is 1)
Bram Moolenaar0f248b02019-04-04 15:36:05 +02003939 * .. string concatenation
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 *
3941 * "arg" must point to the first non-white of the expression.
3942 * "arg" is advanced to the next non-white after the recognized expression.
3943 *
3944 * Return OK or FAIL.
3945 */
3946 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01003947eval5(char_u **arg, typval_T *rettv, int evaluate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948{
Bram Moolenaar33570922005-01-25 22:26:29 +00003949 typval_T var2;
3950 typval_T var3;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 int op;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02003952 varnumber_T n1, n2;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003953#ifdef FEAT_FLOAT
3954 float_T f1 = 0, f2 = 0;
3955#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 char_u *s1, *s2;
3957 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
3958 char_u *p;
Bram Moolenaar558ca4a2019-04-04 18:15:38 +02003959 int concat;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960
3961 /*
3962 * Get the first variable.
3963 */
Bram Moolenaar8d00f9c2008-06-28 13:09:56 +00003964 if (eval6(arg, rettv, evaluate, FALSE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 return FAIL;
3966
3967 /*
3968 * Repeat computing, until no '+', '-' or '.' is following.
3969 */
3970 for (;;)
3971 {
Bram Moolenaar558ca4a2019-04-04 18:15:38 +02003972 // "." is only string concatenation when scriptversion is 1
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 op = **arg;
Bram Moolenaar558ca4a2019-04-04 18:15:38 +02003974 concat = op == '.'
3975 && (*(*arg + 1) == '.' || current_sctx.sc_version < 2);
3976 if (op != '+' && op != '-' && !concat)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 break;
3978
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01003979 if ((op != '+' || (rettv->v_type != VAR_LIST
3980 && rettv->v_type != VAR_BLOB))
Bram Moolenaar8c8de832008-06-24 22:58:06 +00003981#ifdef FEAT_FLOAT
3982 && (op == '.' || rettv->v_type != VAR_FLOAT)
3983#endif
3984 )
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00003985 {
3986 /* For "list + ...", an illegal use of the first operand as
3987 * a number cannot be determined before evaluating the 2nd
3988 * operand: if this is also a list, all is ok.
3989 * For "something . ...", "something - ..." or "non-list + ...",
3990 * we know that the first operand needs to be a string or number
3991 * without evaluating the 2nd operand. So check before to avoid
3992 * side effects after an error. */
Bram Moolenaard155d7a2018-12-21 16:04:21 +01003993 if (evaluate && tv_get_string_chk(rettv) == NULL)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00003994 {
3995 clear_tv(rettv);
3996 return FAIL;
3997 }
3998 }
3999
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000 /*
4001 * Get the second variable.
4002 */
Bram Moolenaar0f248b02019-04-04 15:36:05 +02004003 if (op == '.' && *(*arg + 1) == '.') // .. string concatenation
4004 ++*arg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 *arg = skipwhite(*arg + 1);
Bram Moolenaar8d00f9c2008-06-28 13:09:56 +00004006 if (eval6(arg, &var2, evaluate, op == '.') == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004008 clear_tv(rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 return FAIL;
4010 }
4011
4012 if (evaluate)
4013 {
4014 /*
4015 * Compute the result.
4016 */
4017 if (op == '.')
4018 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004019 s1 = tv_get_string_buf(rettv, buf1); /* already checked */
4020 s2 = tv_get_string_buf_chk(&var2, buf2);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004021 if (s2 == NULL) /* type error ? */
4022 {
4023 clear_tv(rettv);
4024 clear_tv(&var2);
4025 return FAIL;
4026 }
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00004027 p = concat_str(s1, s2);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004028 clear_tv(rettv);
4029 rettv->v_type = VAR_STRING;
4030 rettv->vval.v_string = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 }
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004032 else if (op == '+' && rettv->v_type == VAR_BLOB
4033 && var2.v_type == VAR_BLOB)
4034 {
4035 blob_T *b1 = rettv->vval.v_blob;
4036 blob_T *b2 = var2.vval.v_blob;
4037 blob_T *b = blob_alloc();
4038 int i;
4039
4040 if (b != NULL)
4041 {
4042 for (i = 0; i < blob_len(b1); i++)
4043 ga_append(&b->bv_ga, blob_get(b1, i));
4044 for (i = 0; i < blob_len(b2); i++)
4045 ga_append(&b->bv_ga, blob_get(b2, i));
4046
4047 clear_tv(rettv);
4048 rettv_blob_set(rettv, b);
4049 }
4050 }
Bram Moolenaare9a41262005-01-15 22:18:47 +00004051 else if (op == '+' && rettv->v_type == VAR_LIST
4052 && var2.v_type == VAR_LIST)
Bram Moolenaar8a283e52005-01-06 23:28:25 +00004053 {
4054 /* concatenate Lists */
4055 if (list_concat(rettv->vval.v_list, var2.vval.v_list,
4056 &var3) == FAIL)
4057 {
4058 clear_tv(rettv);
4059 clear_tv(&var2);
4060 return FAIL;
4061 }
4062 clear_tv(rettv);
4063 *rettv = var3;
4064 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065 else
4066 {
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004067 int error = FALSE;
4068
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004069#ifdef FEAT_FLOAT
4070 if (rettv->v_type == VAR_FLOAT)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004071 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004072 f1 = rettv->vval.v_float;
4073 n1 = 0;
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004074 }
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004075 else
4076#endif
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004077 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004078 n1 = tv_get_number_chk(rettv, &error);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004079 if (error)
4080 {
4081 /* This can only happen for "list + non-list". For
4082 * "non-list + ..." or "something - ...", we returned
4083 * before evaluating the 2nd operand. */
4084 clear_tv(rettv);
4085 return FAIL;
4086 }
4087#ifdef FEAT_FLOAT
4088 if (var2.v_type == VAR_FLOAT)
4089 f1 = n1;
4090#endif
4091 }
4092#ifdef FEAT_FLOAT
4093 if (var2.v_type == VAR_FLOAT)
4094 {
4095 f2 = var2.vval.v_float;
4096 n2 = 0;
4097 }
4098 else
4099#endif
4100 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004101 n2 = tv_get_number_chk(&var2, &error);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004102 if (error)
4103 {
4104 clear_tv(rettv);
4105 clear_tv(&var2);
4106 return FAIL;
4107 }
4108#ifdef FEAT_FLOAT
4109 if (rettv->v_type == VAR_FLOAT)
4110 f2 = n2;
4111#endif
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004112 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004113 clear_tv(rettv);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004114
4115#ifdef FEAT_FLOAT
4116 /* If there is a float on either side the result is a float. */
4117 if (rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4118 {
4119 if (op == '+')
4120 f1 = f1 + f2;
4121 else
4122 f1 = f1 - f2;
4123 rettv->v_type = VAR_FLOAT;
4124 rettv->vval.v_float = f1;
4125 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 else
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004127#endif
4128 {
4129 if (op == '+')
4130 n1 = n1 + n2;
4131 else
4132 n1 = n1 - n2;
4133 rettv->v_type = VAR_NUMBER;
4134 rettv->vval.v_number = n1;
4135 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004137 clear_tv(&var2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 }
4139 }
4140 return OK;
4141}
4142
4143/*
4144 * Handle fifth level expression:
4145 * * number multiplication
4146 * / number division
4147 * % number modulo
4148 *
4149 * "arg" must point to the first non-white of the expression.
4150 * "arg" is advanced to the next non-white after the recognized expression.
4151 *
4152 * Return OK or FAIL.
4153 */
4154 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01004155eval6(
4156 char_u **arg,
4157 typval_T *rettv,
4158 int evaluate,
4159 int want_string) /* after "." operator */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160{
Bram Moolenaar33570922005-01-25 22:26:29 +00004161 typval_T var2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 int op;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004163 varnumber_T n1, n2;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004164#ifdef FEAT_FLOAT
4165 int use_float = FALSE;
Bram Moolenaar1f3601e2019-04-26 20:33:00 +02004166 float_T f1 = 0, f2 = 0;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004167#endif
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004168 int error = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169
4170 /*
4171 * Get the first variable.
4172 */
Bram Moolenaar8d00f9c2008-06-28 13:09:56 +00004173 if (eval7(arg, rettv, evaluate, want_string) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 return FAIL;
4175
4176 /*
4177 * Repeat computing, until no '*', '/' or '%' is following.
4178 */
4179 for (;;)
4180 {
4181 op = **arg;
4182 if (op != '*' && op != '/' && op != '%')
4183 break;
4184
4185 if (evaluate)
4186 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004187#ifdef FEAT_FLOAT
4188 if (rettv->v_type == VAR_FLOAT)
4189 {
4190 f1 = rettv->vval.v_float;
4191 use_float = TRUE;
4192 n1 = 0;
4193 }
4194 else
4195#endif
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004196 n1 = tv_get_number_chk(rettv, &error);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004197 clear_tv(rettv);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004198 if (error)
4199 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 }
4201 else
4202 n1 = 0;
4203
4204 /*
4205 * Get the second variable.
4206 */
4207 *arg = skipwhite(*arg + 1);
Bram Moolenaar8d00f9c2008-06-28 13:09:56 +00004208 if (eval7(arg, &var2, evaluate, FALSE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 return FAIL;
4210
4211 if (evaluate)
4212 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004213#ifdef FEAT_FLOAT
4214 if (var2.v_type == VAR_FLOAT)
4215 {
4216 if (!use_float)
4217 {
4218 f1 = n1;
4219 use_float = TRUE;
4220 }
4221 f2 = var2.vval.v_float;
4222 n2 = 0;
4223 }
4224 else
4225#endif
4226 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004227 n2 = tv_get_number_chk(&var2, &error);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004228 clear_tv(&var2);
4229 if (error)
4230 return FAIL;
4231#ifdef FEAT_FLOAT
4232 if (use_float)
4233 f2 = n2;
4234#endif
4235 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236
4237 /*
4238 * Compute the result.
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004239 * When either side is a float the result is a float.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240 */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004241#ifdef FEAT_FLOAT
4242 if (use_float)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004244 if (op == '*')
4245 f1 = f1 * f2;
4246 else if (op == '/')
4247 {
Bram Moolenaarf878bcf2010-07-30 22:29:41 +02004248# ifdef VMS
4249 /* VMS crashes on divide by zero, work around it */
4250 if (f2 == 0.0)
4251 {
4252 if (f1 == 0)
Bram Moolenaar314f11d2010-08-09 22:07:08 +02004253 f1 = -1 * __F_FLT_MAX - 1L; /* similar to NaN */
Bram Moolenaarf878bcf2010-07-30 22:29:41 +02004254 else if (f1 < 0)
Bram Moolenaar314f11d2010-08-09 22:07:08 +02004255 f1 = -1 * __F_FLT_MAX;
Bram Moolenaarf878bcf2010-07-30 22:29:41 +02004256 else
Bram Moolenaar314f11d2010-08-09 22:07:08 +02004257 f1 = __F_FLT_MAX;
Bram Moolenaarf878bcf2010-07-30 22:29:41 +02004258 }
4259 else
4260 f1 = f1 / f2;
4261# else
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004262 /* We rely on the floating point library to handle divide
4263 * by zero to result in "inf" and not a crash. */
4264 f1 = f1 / f2;
Bram Moolenaarf878bcf2010-07-30 22:29:41 +02004265# endif
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004266 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267 else
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004268 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004269 emsg(_("E804: Cannot use '%' with Float"));
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004270 return FAIL;
4271 }
4272 rettv->v_type = VAR_FLOAT;
4273 rettv->vval.v_float = f1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 }
4275 else
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004276#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004278 if (op == '*')
4279 n1 = n1 * n2;
4280 else if (op == '/')
Bram Moolenaare21c1582019-03-02 11:57:09 +01004281 n1 = num_divide(n1, n2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 else
Bram Moolenaare21c1582019-03-02 11:57:09 +01004283 n1 = num_modulus(n1, n2);
4284
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004285 rettv->v_type = VAR_NUMBER;
4286 rettv->vval.v_number = n1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288 }
4289 }
4290
4291 return OK;
4292}
4293
4294/*
4295 * Handle sixth level expression:
4296 * number number constant
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004297 * 0zFFFFFFFF Blob constant
Bram Moolenaarbae0c162007-05-10 19:30:25 +00004298 * "string" string constant
4299 * 'string' literal string constant
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 * &option-name option value
4301 * @r register contents
4302 * identifier variable value
4303 * function() function call
4304 * $VAR environment variable
4305 * (expression) nested expression
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00004306 * [expr, expr] List
4307 * {key: val, key: val} Dictionary
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 *
4309 * Also handle:
4310 * ! in front logical NOT
4311 * - in front unary minus
4312 * + in front unary plus (ignored)
Bram Moolenaar8c711452005-01-14 21:53:12 +00004313 * trailing [] subscript in String or List
4314 * trailing .name entry in Dictionary
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 *
4316 * "arg" must point to the first non-white of the expression.
4317 * "arg" is advanced to the next non-white after the recognized expression.
4318 *
4319 * Return OK or FAIL.
4320 */
4321 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01004322eval7(
4323 char_u **arg,
4324 typval_T *rettv,
4325 int evaluate,
4326 int want_string UNUSED) /* after "." operator */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327{
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004328 varnumber_T n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329 int len;
4330 char_u *s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004331 char_u *start_leader, *end_leader;
4332 int ret = OK;
4333 char_u *alias;
4334
4335 /*
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004336 * Initialise variable so that clear_tv() can't mistake this for a
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004337 * string and free a string that isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 */
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004339 rettv->v_type = VAR_UNKNOWN;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340
4341 /*
Bram Moolenaaredf3f972016-08-29 22:49:24 +02004342 * Skip '!', '-' and '+' characters. They are handled later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 */
4344 start_leader = *arg;
4345 while (**arg == '!' || **arg == '-' || **arg == '+')
4346 *arg = skipwhite(*arg + 1);
4347 end_leader = *arg;
4348
Bram Moolenaar558ca4a2019-04-04 18:15:38 +02004349 if (**arg == '.' && (!isdigit(*(*arg + 1))
4350#ifdef FEAT_FLOAT
4351 || current_sctx.sc_version < 2
4352#endif
4353 ))
4354 {
4355 semsg(_(e_invexpr2), *arg);
4356 ++*arg;
4357 return FAIL;
4358 }
4359
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 switch (**arg)
4361 {
4362 /*
4363 * Number constant.
4364 */
4365 case '0':
4366 case '1':
4367 case '2':
4368 case '3':
4369 case '4':
4370 case '5':
4371 case '6':
4372 case '7':
4373 case '8':
4374 case '9':
Bram Moolenaar558ca4a2019-04-04 18:15:38 +02004375 case '.':
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004376 {
4377#ifdef FEAT_FLOAT
Bram Moolenaar558ca4a2019-04-04 18:15:38 +02004378 char_u *p;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004379 int get_float = FALSE;
4380
4381 /* We accept a float when the format matches
4382 * "[0-9]\+\.[0-9]\+\([eE][+-]\?[0-9]\+\)\?". This is very
Bram Moolenaar8d00f9c2008-06-28 13:09:56 +00004383 * strict to avoid backwards compatibility problems.
Bram Moolenaar558ca4a2019-04-04 18:15:38 +02004384 * With script version 2 and later the leading digit can be
4385 * omitted.
Bram Moolenaar8d00f9c2008-06-28 13:09:56 +00004386 * Don't look for a float after the "." operator, so that
4387 * ":let vers = 1.2.3" doesn't fail. */
Bram Moolenaar558ca4a2019-04-04 18:15:38 +02004388 if (**arg == '.')
4389 p = *arg;
4390 else
4391 p = skipdigits(*arg + 1);
Bram Moolenaar8d00f9c2008-06-28 13:09:56 +00004392 if (!want_string && p[0] == '.' && vim_isdigit(p[1]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004394 get_float = TRUE;
4395 p = skipdigits(p + 2);
4396 if (*p == 'e' || *p == 'E')
4397 {
4398 ++p;
4399 if (*p == '-' || *p == '+')
4400 ++p;
4401 if (!vim_isdigit(*p))
4402 get_float = FALSE;
4403 else
4404 p = skipdigits(p + 1);
4405 }
4406 if (ASCII_ISALPHA(*p) || *p == '.')
4407 get_float = FALSE;
4408 }
4409 if (get_float)
4410 {
4411 float_T f;
4412
4413 *arg += string2float(*arg, &f);
4414 if (evaluate)
4415 {
4416 rettv->v_type = VAR_FLOAT;
4417 rettv->vval.v_float = f;
4418 }
4419 }
4420 else
4421#endif
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004422 if (**arg == '0' && ((*arg)[1] == 'z' || (*arg)[1] == 'Z'))
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004423 {
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004424 char_u *bp;
Bram Moolenaare519dfd2019-01-13 15:42:02 +01004425 blob_T *blob = NULL; // init for gcc
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004426
4427 // Blob constant: 0z0123456789abcdef
4428 if (evaluate)
4429 blob = blob_alloc();
4430 for (bp = *arg + 2; vim_isxdigit(bp[0]); bp += 2)
4431 {
4432 if (!vim_isxdigit(bp[1]))
4433 {
Bram Moolenaarecc8bc42019-01-13 16:07:21 +01004434 if (blob != NULL)
4435 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004436 emsg(_("E973: Blob literal should have an even number of hex characters"));
Bram Moolenaarecc8bc42019-01-13 16:07:21 +01004437 ga_clear(&blob->bv_ga);
4438 VIM_CLEAR(blob);
4439 }
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004440 ret = FAIL;
4441 break;
4442 }
4443 if (blob != NULL)
4444 ga_append(&blob->bv_ga,
4445 (hex2nr(*bp) << 4) + hex2nr(*(bp+1)));
Bram Moolenaar4131fd52019-01-17 16:32:53 +01004446 if (bp[2] == '.' && vim_isxdigit(bp[3]))
4447 ++bp;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004448 }
4449 if (blob != NULL)
Bram Moolenaarecc8bc42019-01-13 16:07:21 +01004450 rettv_blob_set(rettv, blob);
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004451 *arg = bp;
4452 }
4453 else
4454 {
4455 // decimal, hex or octal number
Bram Moolenaar887c1fe2016-01-02 17:56:35 +01004456 vim_str2nr(*arg, NULL, &len, STR2NR_ALL, &n, NULL, 0);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004457 *arg += len;
4458 if (evaluate)
4459 {
4460 rettv->v_type = VAR_NUMBER;
4461 rettv->vval.v_number = n;
4462 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 }
4464 break;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004465 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466
4467 /*
4468 * String constant: "string".
4469 */
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004470 case '"': ret = get_string_tv(arg, rettv, evaluate);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471 break;
4472
4473 /*
Bram Moolenaar8c711452005-01-14 21:53:12 +00004474 * Literal string constant: 'str''ing'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475 */
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004476 case '\'': ret = get_lit_string_tv(arg, rettv, evaluate);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004477 break;
4478
4479 /*
4480 * List: [expr, expr]
4481 */
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004482 case '[': ret = get_list_tv(arg, rettv, evaluate);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004483 break;
4484
4485 /*
Bram Moolenaar069c1e72016-07-15 21:25:08 +02004486 * Lambda: {arg, arg -> expr}
Bram Moolenaar8c711452005-01-14 21:53:12 +00004487 * Dictionary: {key: val, key: val}
4488 */
Bram Moolenaar069c1e72016-07-15 21:25:08 +02004489 case '{': ret = get_lambda_tv(arg, rettv, evaluate);
4490 if (ret == NOTDONE)
Bram Moolenaar8f667172018-12-14 15:38:31 +01004491 ret = dict_get_tv(arg, rettv, evaluate);
Bram Moolenaar8c711452005-01-14 21:53:12 +00004492 break;
4493
4494 /*
Bram Moolenaare9a41262005-01-15 22:18:47 +00004495 * Option value: &name
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 */
Bram Moolenaare9a41262005-01-15 22:18:47 +00004497 case '&': ret = get_option_tv(arg, rettv, evaluate);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498 break;
4499
4500 /*
4501 * Environment variable: $VAR.
4502 */
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004503 case '$': ret = get_env_tv(arg, rettv, evaluate);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 break;
4505
4506 /*
4507 * Register contents: @r.
4508 */
4509 case '@': ++*arg;
4510 if (evaluate)
4511 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004512 rettv->v_type = VAR_STRING;
Bram Moolenaarb7cb42b2014-04-02 19:55:10 +02004513 rettv->vval.v_string = get_reg_contents(**arg,
4514 GREG_EXPR_SRC);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515 }
4516 if (**arg != NUL)
4517 ++*arg;
4518 break;
4519
4520 /*
4521 * nested expression: (expression).
4522 */
4523 case '(': *arg = skipwhite(*arg + 1);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004524 ret = eval1(arg, rettv, evaluate); /* recursive! */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 if (**arg == ')')
4526 ++*arg;
4527 else if (ret == OK)
4528 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004529 emsg(_("E110: Missing ')'"));
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004530 clear_tv(rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 ret = FAIL;
4532 }
4533 break;
4534
Bram Moolenaar8c711452005-01-14 21:53:12 +00004535 default: ret = NOTDONE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536 break;
4537 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00004538
4539 if (ret == NOTDONE)
4540 {
4541 /*
4542 * Must be a variable or function name.
4543 * Can also be a curly-braces kind of name: {expr}.
4544 */
4545 s = *arg;
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004546 len = get_name_len(arg, &alias, evaluate, TRUE);
Bram Moolenaar8c711452005-01-14 21:53:12 +00004547 if (alias != NULL)
4548 s = alias;
4549
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004550 if (len <= 0)
Bram Moolenaar8c711452005-01-14 21:53:12 +00004551 ret = FAIL;
4552 else
4553 {
4554 if (**arg == '(') /* recursive! */
4555 {
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004556 partial_T *partial;
4557
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004558 if (!evaluate)
4559 check_vars(s, len);
4560
Bram Moolenaar8c711452005-01-14 21:53:12 +00004561 /* If "s" is the name of a variable of type VAR_FUNC
4562 * use its contents. */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004563 s = deref_func_name(s, &len, &partial, !evaluate);
Bram Moolenaar8c711452005-01-14 21:53:12 +00004564
Bram Moolenaar8a01f962016-11-14 21:50:00 +01004565 /* Need to make a copy, in case evaluating the arguments makes
4566 * the name invalid. */
4567 s = vim_strsave(s);
4568 if (s == NULL)
4569 ret = FAIL;
4570 else
4571 /* Invoke the function. */
4572 ret = get_func_tv(s, len, rettv, arg,
4573 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
4574 &len, evaluate, partial, NULL);
4575 vim_free(s);
Bram Moolenaare17c2602013-02-26 19:36:15 +01004576
4577 /* If evaluate is FALSE rettv->v_type was not set in
4578 * get_func_tv, but it's needed in handle_subscript() to parse
4579 * what follows. So set it here. */
4580 if (rettv->v_type == VAR_UNKNOWN && !evaluate && **arg == '(')
4581 {
Bram Moolenaar9ad73232016-06-01 22:08:17 +02004582 rettv->vval.v_string = NULL;
Bram Moolenaare17c2602013-02-26 19:36:15 +01004583 rettv->v_type = VAR_FUNC;
4584 }
4585
Bram Moolenaar8c711452005-01-14 21:53:12 +00004586 /* Stop the expression evaluation when immediately
4587 * aborting on error, or when an interrupt occurred or
4588 * an exception was thrown but not caught. */
4589 if (aborting())
4590 {
4591 if (ret == OK)
4592 clear_tv(rettv);
4593 ret = FAIL;
4594 }
4595 }
4596 else if (evaluate)
Bram Moolenaar1cd5e612015-05-04 11:10:27 +02004597 ret = get_var_tv(s, len, rettv, NULL, TRUE, FALSE);
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00004598 else
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004599 {
4600 check_vars(s, len);
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00004601 ret = OK;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004602 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00004603 }
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01004604 vim_free(alias);
Bram Moolenaar8c711452005-01-14 21:53:12 +00004605 }
4606
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 *arg = skipwhite(*arg);
4608
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004609 /* Handle following '[', '(' and '.' for expr[expr], expr.name,
4610 * expr(expr). */
4611 if (ret == OK)
4612 ret = handle_subscript(arg, rettv, evaluate, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613
4614 /*
4615 * Apply logical NOT and unary '-', from right to left, ignore '+'.
4616 */
4617 if (ret == OK && evaluate && end_leader > start_leader)
4618 {
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004619 int error = FALSE;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004620 varnumber_T val = 0;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004621#ifdef FEAT_FLOAT
4622 float_T f = 0.0;
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004623
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004624 if (rettv->v_type == VAR_FLOAT)
4625 f = rettv->vval.v_float;
4626 else
4627#endif
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004628 val = tv_get_number_chk(rettv, &error);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004629 if (error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 {
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004631 clear_tv(rettv);
4632 ret = FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 }
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004634 else
4635 {
4636 while (end_leader > start_leader)
4637 {
4638 --end_leader;
4639 if (*end_leader == '!')
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004640 {
4641#ifdef FEAT_FLOAT
4642 if (rettv->v_type == VAR_FLOAT)
4643 f = !f;
4644 else
4645#endif
4646 val = !val;
4647 }
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004648 else if (*end_leader == '-')
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004649 {
4650#ifdef FEAT_FLOAT
4651 if (rettv->v_type == VAR_FLOAT)
4652 f = -f;
4653 else
4654#endif
4655 val = -val;
4656 }
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004657 }
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004658#ifdef FEAT_FLOAT
4659 if (rettv->v_type == VAR_FLOAT)
4660 {
4661 clear_tv(rettv);
4662 rettv->vval.v_float = f;
4663 }
4664 else
4665#endif
4666 {
4667 clear_tv(rettv);
4668 rettv->v_type = VAR_NUMBER;
4669 rettv->vval.v_number = val;
4670 }
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004671 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672 }
4673
4674 return ret;
4675}
4676
4677/*
Bram Moolenaar9e54a0e2006-04-14 20:42:25 +00004678 * Evaluate an "[expr]" or "[expr:expr]" index. Also "dict.key".
4679 * "*arg" points to the '[' or '.'.
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004680 * Returns FAIL or OK. "*arg" is advanced to after the ']'.
4681 */
4682 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01004683eval_index(
4684 char_u **arg,
4685 typval_T *rettv,
4686 int evaluate,
4687 int verbose) /* give error messages */
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004688{
4689 int empty1 = FALSE, empty2 = FALSE;
Bram Moolenaar33570922005-01-25 22:26:29 +00004690 typval_T var1, var2;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004691 long i;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004692 long n1, n2 = 0;
Bram Moolenaar8c711452005-01-14 21:53:12 +00004693 long len = -1;
4694 int range = FALSE;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004695 char_u *s;
Bram Moolenaar8c711452005-01-14 21:53:12 +00004696 char_u *key = NULL;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004697
Bram Moolenaara03f2332016-02-06 18:09:59 +01004698 switch (rettv->v_type)
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004699 {
Bram Moolenaara03f2332016-02-06 18:09:59 +01004700 case VAR_FUNC:
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004701 case VAR_PARTIAL:
Bram Moolenaara03f2332016-02-06 18:09:59 +01004702 if (verbose)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004703 emsg(_("E695: Cannot index a Funcref"));
Bram Moolenaara03f2332016-02-06 18:09:59 +01004704 return FAIL;
4705 case VAR_FLOAT:
Bram Moolenaar2a876e42013-06-12 22:08:58 +02004706#ifdef FEAT_FLOAT
Bram Moolenaara03f2332016-02-06 18:09:59 +01004707 if (verbose)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004708 emsg(_(e_float_as_string));
Bram Moolenaara03f2332016-02-06 18:09:59 +01004709 return FAIL;
Bram Moolenaar2a876e42013-06-12 22:08:58 +02004710#endif
Bram Moolenaara03f2332016-02-06 18:09:59 +01004711 case VAR_SPECIAL:
Bram Moolenaar835dc632016-02-07 14:27:38 +01004712 case VAR_JOB:
Bram Moolenaar77073442016-02-13 23:23:53 +01004713 case VAR_CHANNEL:
Bram Moolenaara03f2332016-02-06 18:09:59 +01004714 if (verbose)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004715 emsg(_("E909: Cannot index a special variable"));
Bram Moolenaara03f2332016-02-06 18:09:59 +01004716 return FAIL;
4717 case VAR_UNKNOWN:
4718 if (evaluate)
4719 return FAIL;
4720 /* FALLTHROUGH */
4721
4722 case VAR_STRING:
4723 case VAR_NUMBER:
4724 case VAR_LIST:
4725 case VAR_DICT:
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004726 case VAR_BLOB:
Bram Moolenaara03f2332016-02-06 18:09:59 +01004727 break;
Bram Moolenaar520e1e42016-01-23 19:46:28 +01004728 }
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004729
Bram Moolenaar0a38dd22015-08-25 16:49:01 +02004730 init_tv(&var1);
4731 init_tv(&var2);
Bram Moolenaar8c711452005-01-14 21:53:12 +00004732 if (**arg == '.')
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004733 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00004734 /*
4735 * dict.name
4736 */
4737 key = *arg + 1;
4738 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
4739 ;
4740 if (len == 0)
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004741 return FAIL;
Bram Moolenaar8c711452005-01-14 21:53:12 +00004742 *arg = skipwhite(key + len);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004743 }
4744 else
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004745 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00004746 /*
4747 * something[idx]
4748 *
4749 * Get the (first) variable from inside the [].
4750 */
4751 *arg = skipwhite(*arg + 1);
4752 if (**arg == ':')
4753 empty1 = TRUE;
4754 else if (eval1(arg, &var1, evaluate) == FAIL) /* recursive! */
4755 return FAIL;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004756 else if (evaluate && tv_get_string_chk(&var1) == NULL)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004757 {
4758 /* not a number or string */
4759 clear_tv(&var1);
4760 return FAIL;
4761 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00004762
4763 /*
4764 * Get the second variable from inside the [:].
4765 */
4766 if (**arg == ':')
4767 {
4768 range = TRUE;
4769 *arg = skipwhite(*arg + 1);
4770 if (**arg == ']')
4771 empty2 = TRUE;
4772 else if (eval1(arg, &var2, evaluate) == FAIL) /* recursive! */
4773 {
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004774 if (!empty1)
4775 clear_tv(&var1);
4776 return FAIL;
4777 }
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004778 else if (evaluate && tv_get_string_chk(&var2) == NULL)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004779 {
4780 /* not a number or string */
4781 if (!empty1)
4782 clear_tv(&var1);
4783 clear_tv(&var2);
Bram Moolenaar8c711452005-01-14 21:53:12 +00004784 return FAIL;
4785 }
4786 }
4787
4788 /* Check for the ']'. */
4789 if (**arg != ']')
4790 {
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004791 if (verbose)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004792 emsg(_(e_missbrac));
Bram Moolenaar8c711452005-01-14 21:53:12 +00004793 clear_tv(&var1);
4794 if (range)
4795 clear_tv(&var2);
4796 return FAIL;
4797 }
4798 *arg = skipwhite(*arg + 1); /* skip the ']' */
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004799 }
4800
4801 if (evaluate)
4802 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00004803 n1 = 0;
4804 if (!empty1 && rettv->v_type != VAR_DICT)
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004805 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004806 n1 = tv_get_number(&var1);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004807 clear_tv(&var1);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004808 }
4809 if (range)
4810 {
4811 if (empty2)
4812 n2 = -1;
4813 else
4814 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004815 n2 = tv_get_number(&var2);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004816 clear_tv(&var2);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004817 }
4818 }
4819
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004820 switch (rettv->v_type)
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004821 {
Bram Moolenaar835dc632016-02-07 14:27:38 +01004822 case VAR_UNKNOWN:
Bram Moolenaara03f2332016-02-06 18:09:59 +01004823 case VAR_FUNC:
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004824 case VAR_PARTIAL:
Bram Moolenaara03f2332016-02-06 18:09:59 +01004825 case VAR_FLOAT:
Bram Moolenaar835dc632016-02-07 14:27:38 +01004826 case VAR_SPECIAL:
4827 case VAR_JOB:
Bram Moolenaar77073442016-02-13 23:23:53 +01004828 case VAR_CHANNEL:
Bram Moolenaara03f2332016-02-06 18:09:59 +01004829 break; /* not evaluating, skipping over subscript */
4830
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004831 case VAR_NUMBER:
4832 case VAR_STRING:
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004833 s = tv_get_string(rettv);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004834 len = (long)STRLEN(s);
4835 if (range)
4836 {
4837 /* The resulting variable is a substring. If the indexes
4838 * are out of range the result is empty. */
4839 if (n1 < 0)
4840 {
4841 n1 = len + n1;
4842 if (n1 < 0)
4843 n1 = 0;
4844 }
4845 if (n2 < 0)
4846 n2 = len + n2;
4847 else if (n2 >= len)
4848 n2 = len;
4849 if (n1 >= len || n2 < 0 || n1 > n2)
4850 s = NULL;
4851 else
4852 s = vim_strnsave(s + n1, (int)(n2 - n1 + 1));
4853 }
4854 else
4855 {
4856 /* The resulting variable is a string of a single
4857 * character. If the index is too big or negative the
4858 * result is empty. */
4859 if (n1 >= len || n1 < 0)
4860 s = NULL;
4861 else
4862 s = vim_strnsave(s + n1, 1);
4863 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004864 clear_tv(rettv);
4865 rettv->v_type = VAR_STRING;
4866 rettv->vval.v_string = s;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004867 break;
4868
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004869 case VAR_BLOB:
4870 len = blob_len(rettv->vval.v_blob);
4871 if (range)
4872 {
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01004873 // The resulting variable is a sub-blob. If the indexes
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004874 // are out of range the result is empty.
4875 if (n1 < 0)
4876 {
4877 n1 = len + n1;
4878 if (n1 < 0)
4879 n1 = 0;
4880 }
4881 if (n2 < 0)
4882 n2 = len + n2;
4883 else if (n2 >= len)
4884 n2 = len - 1;
4885 if (n1 >= len || n2 < 0 || n1 > n2)
4886 {
4887 clear_tv(rettv);
4888 rettv->v_type = VAR_BLOB;
4889 rettv->vval.v_blob = NULL;
4890 }
4891 else
4892 {
4893 blob_T *blob = blob_alloc();
4894
4895 if (blob != NULL)
4896 {
4897 if (ga_grow(&blob->bv_ga, n2 - n1 + 1) == FAIL)
4898 {
4899 blob_free(blob);
4900 return FAIL;
4901 }
4902 blob->bv_ga.ga_len = n2 - n1 + 1;
4903 for (i = n1; i <= n2; i++)
4904 blob_set(blob, i - n1,
4905 blob_get(rettv->vval.v_blob, i));
4906
4907 clear_tv(rettv);
4908 rettv_blob_set(rettv, blob);
4909 }
4910 }
4911 }
4912 else
4913 {
Bram Moolenaara5be9b62019-01-24 12:31:44 +01004914 // The resulting variable is a byte value.
4915 // If the index is too big or negative that is an error.
4916 if (n1 < 0)
4917 n1 = len + n1;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004918 if (n1 < len && n1 >= 0)
4919 {
Bram Moolenaara5be9b62019-01-24 12:31:44 +01004920 int v = blob_get(rettv->vval.v_blob, n1);
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004921
4922 clear_tv(rettv);
4923 rettv->v_type = VAR_NUMBER;
4924 rettv->vval.v_number = v;
4925 }
4926 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004927 semsg(_(e_blobidx), n1);
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004928 }
4929 break;
4930
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004931 case VAR_LIST:
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004932 len = list_len(rettv->vval.v_list);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004933 if (n1 < 0)
4934 n1 = len + n1;
4935 if (!empty1 && (n1 < 0 || n1 >= len))
4936 {
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004937 /* For a range we allow invalid values and return an empty
4938 * list. A list index out of range is an error. */
4939 if (!range)
4940 {
4941 if (verbose)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004942 semsg(_(e_listidx), n1);
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004943 return FAIL;
4944 }
4945 n1 = len;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004946 }
4947 if (range)
4948 {
Bram Moolenaar33570922005-01-25 22:26:29 +00004949 list_T *l;
4950 listitem_T *item;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004951
4952 if (n2 < 0)
4953 n2 = len + n2;
Bram Moolenaar9e54a0e2006-04-14 20:42:25 +00004954 else if (n2 >= len)
4955 n2 = len - 1;
4956 if (!empty2 && (n2 < 0 || n2 + 1 < n1))
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004957 n2 = -1;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004958 l = list_alloc();
4959 if (l == NULL)
4960 return FAIL;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004961 for (item = list_find(rettv->vval.v_list, n1);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004962 n1 <= n2; ++n1)
4963 {
4964 if (list_append_tv(l, &item->li_tv) == FAIL)
4965 {
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02004966 list_free(l);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004967 return FAIL;
4968 }
4969 item = item->li_next;
4970 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004971 clear_tv(rettv);
Bram Moolenaar45cf6e92017-04-30 20:25:19 +02004972 rettv_list_set(rettv, l);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004973 }
4974 else
4975 {
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004976 copy_tv(&list_find(rettv->vval.v_list, n1)->li_tv, &var1);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004977 clear_tv(rettv);
4978 *rettv = var1;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004979 }
4980 break;
Bram Moolenaar8c711452005-01-14 21:53:12 +00004981
4982 case VAR_DICT:
4983 if (range)
4984 {
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004985 if (verbose)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004986 emsg(_(e_dictrange));
Bram Moolenaar8c711452005-01-14 21:53:12 +00004987 if (len == -1)
4988 clear_tv(&var1);
4989 return FAIL;
4990 }
4991 {
Bram Moolenaar33570922005-01-25 22:26:29 +00004992 dictitem_T *item;
Bram Moolenaar8c711452005-01-14 21:53:12 +00004993
4994 if (len == -1)
4995 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004996 key = tv_get_string_chk(&var1);
Bram Moolenaar0921ecf2016-04-03 22:44:36 +02004997 if (key == NULL)
Bram Moolenaar8c711452005-01-14 21:53:12 +00004998 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00004999 clear_tv(&var1);
5000 return FAIL;
5001 }
5002 }
5003
Bram Moolenaarce5e58e2005-01-19 22:24:34 +00005004 item = dict_find(rettv->vval.v_dict, key, (int)len);
Bram Moolenaar8c711452005-01-14 21:53:12 +00005005
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00005006 if (item == NULL && verbose)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005007 semsg(_(e_dictkey), key);
Bram Moolenaar8c711452005-01-14 21:53:12 +00005008 if (len == -1)
5009 clear_tv(&var1);
5010 if (item == NULL)
5011 return FAIL;
5012
5013 copy_tv(&item->di_tv, &var1);
5014 clear_tv(rettv);
5015 *rettv = var1;
5016 }
5017 break;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00005018 }
5019 }
5020
Bram Moolenaar49cd9572005-01-03 21:06:01 +00005021 return OK;
5022}
5023
5024/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025 * Get an option value.
5026 * "arg" points to the '&' or '+' before the option name.
5027 * "arg" is advanced to character after the option name.
5028 * Return OK or FAIL.
5029 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02005030 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005031get_option_tv(
5032 char_u **arg,
5033 typval_T *rettv, /* when NULL, only check if option exists */
5034 int evaluate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035{
5036 char_u *option_end;
5037 long numval;
5038 char_u *stringval;
5039 int opt_type;
5040 int c;
5041 int working = (**arg == '+'); /* has("+option") */
5042 int ret = OK;
5043 int opt_flags;
5044
5045 /*
5046 * Isolate the option name and find its value.
5047 */
5048 option_end = find_option_end(arg, &opt_flags);
5049 if (option_end == NULL)
5050 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00005051 if (rettv != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005052 semsg(_("E112: Option name missing: %s"), *arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053 return FAIL;
5054 }
5055
5056 if (!evaluate)
5057 {
5058 *arg = option_end;
5059 return OK;
5060 }
5061
5062 c = *option_end;
5063 *option_end = NUL;
5064 opt_type = get_option_value(*arg, &numval,
Bram Moolenaarc70646c2005-01-04 21:52:38 +00005065 rettv == NULL ? NULL : &stringval, opt_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005066
5067 if (opt_type == -3) /* invalid name */
5068 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00005069 if (rettv != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005070 semsg(_("E113: Unknown option: %s"), *arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071 ret = FAIL;
5072 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00005073 else if (rettv != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 {
5075 if (opt_type == -2) /* hidden string option */
5076 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00005077 rettv->v_type = VAR_STRING;
5078 rettv->vval.v_string = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 }
5080 else if (opt_type == -1) /* hidden number option */
5081 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00005082 rettv->v_type = VAR_NUMBER;
5083 rettv->vval.v_number = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084 }
5085 else if (opt_type == 1) /* number option */
5086 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00005087 rettv->v_type = VAR_NUMBER;
5088 rettv->vval.v_number = numval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089 }
5090 else /* string option */
5091 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00005092 rettv->v_type = VAR_STRING;
5093 rettv->vval.v_string = stringval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005094 }
5095 }
5096 else if (working && (opt_type == -2 || opt_type == -1))
5097 ret = FAIL;
5098
5099 *option_end = c; /* put back for error messages */
5100 *arg = option_end;
5101
5102 return ret;
5103}
5104
5105/*
5106 * Allocate a variable for a string constant.
5107 * Return OK or FAIL.
5108 */
5109 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005110get_string_tv(char_u **arg, typval_T *rettv, int evaluate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111{
5112 char_u *p;
5113 char_u *name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005114 int extra = 0;
5115
5116 /*
5117 * Find the end of the string, skipping backslashed characters.
5118 */
Bram Moolenaar91acfff2017-03-12 19:22:36 +01005119 for (p = *arg + 1; *p != NUL && *p != '"'; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 {
5121 if (*p == '\\' && p[1] != NUL)
5122 {
5123 ++p;
5124 /* A "\<x>" form occupies at least 4 characters, and produces up
5125 * to 6 characters: reserve space for 2 extra */
5126 if (*p == '<')
5127 extra += 2;
5128 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129 }
5130
5131 if (*p != '"')
5132 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005133 semsg(_("E114: Missing quote: %s"), *arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134 return FAIL;
5135 }
5136
5137 /* If only parsing, set *arg and return here */
5138 if (!evaluate)
5139 {
5140 *arg = p + 1;
5141 return OK;
5142 }
5143
5144 /*
5145 * Copy the string into allocated memory, handling backslashed
5146 * characters.
5147 */
5148 name = alloc((unsigned)(p - *arg + extra));
5149 if (name == NULL)
5150 return FAIL;
Bram Moolenaar8c711452005-01-14 21:53:12 +00005151 rettv->v_type = VAR_STRING;
5152 rettv->vval.v_string = name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153
Bram Moolenaar8c711452005-01-14 21:53:12 +00005154 for (p = *arg + 1; *p != NUL && *p != '"'; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 {
5156 if (*p == '\\')
5157 {
5158 switch (*++p)
5159 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00005160 case 'b': *name++ = BS; ++p; break;
5161 case 'e': *name++ = ESC; ++p; break;
5162 case 'f': *name++ = FF; ++p; break;
5163 case 'n': *name++ = NL; ++p; break;
5164 case 'r': *name++ = CAR; ++p; break;
5165 case 't': *name++ = TAB; ++p; break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005166
5167 case 'X': /* hex: "\x1", "\x12" */
5168 case 'x':
5169 case 'u': /* Unicode: "\u0023" */
5170 case 'U':
5171 if (vim_isxdigit(p[1]))
5172 {
5173 int n, nr;
5174 int c = toupper(*p);
5175
5176 if (c == 'X')
5177 n = 2;
Bram Moolenaaracc39882015-06-19 12:08:13 +02005178 else if (*p == 'u')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 n = 4;
Bram Moolenaaracc39882015-06-19 12:08:13 +02005180 else
5181 n = 8;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 nr = 0;
5183 while (--n >= 0 && vim_isxdigit(p[1]))
5184 {
5185 ++p;
5186 nr = (nr << 4) + hex2nr(*p);
5187 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00005188 ++p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189 /* For "\u" store the number according to
5190 * 'encoding'. */
5191 if (c != 'X')
Bram Moolenaar8c711452005-01-14 21:53:12 +00005192 name += (*mb_char2bytes)(nr, name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 else
Bram Moolenaar8c711452005-01-14 21:53:12 +00005194 *name++ = nr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005195 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196 break;
5197
5198 /* octal: "\1", "\12", "\123" */
5199 case '0':
5200 case '1':
5201 case '2':
5202 case '3':
5203 case '4':
5204 case '5':
5205 case '6':
Bram Moolenaar8c711452005-01-14 21:53:12 +00005206 case '7': *name = *p++ - '0';
5207 if (*p >= '0' && *p <= '7')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005208 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00005209 *name = (*name << 3) + *p++ - '0';
5210 if (*p >= '0' && *p <= '7')
5211 *name = (*name << 3) + *p++ - '0';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00005213 ++name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214 break;
5215
5216 /* Special key, e.g.: "\<C-W>" */
Bram Moolenaar35a4cfa2016-08-14 16:07:48 +02005217 case '<': extra = trans_special(&p, name, TRUE, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 if (extra != 0)
5219 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00005220 name += extra;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 break;
5222 }
5223 /* FALLTHROUGH */
5224
Bram Moolenaar8c711452005-01-14 21:53:12 +00005225 default: MB_COPY_CHAR(p, name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 break;
5227 }
5228 }
5229 else
Bram Moolenaar8c711452005-01-14 21:53:12 +00005230 MB_COPY_CHAR(p, name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00005233 *name = NUL;
Bram Moolenaardb249f22016-08-26 16:29:47 +02005234 if (*p != NUL) /* just in case */
5235 ++p;
5236 *arg = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238 return OK;
5239}
5240
5241/*
Bram Moolenaar8c711452005-01-14 21:53:12 +00005242 * Allocate a variable for a 'str''ing' constant.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243 * Return OK or FAIL.
5244 */
5245 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005246get_lit_string_tv(char_u **arg, typval_T *rettv, int evaluate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247{
5248 char_u *p;
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005249 char_u *str;
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005250 int reduce = 0;
5251
5252 /*
Bram Moolenaar8c711452005-01-14 21:53:12 +00005253 * Find the end of the string, skipping ''.
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005254 */
Bram Moolenaar91acfff2017-03-12 19:22:36 +01005255 for (p = *arg + 1; *p != NUL; MB_PTR_ADV(p))
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005256 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00005257 if (*p == '\'')
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005258 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00005259 if (p[1] != '\'')
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005260 break;
5261 ++reduce;
5262 ++p;
5263 }
5264 }
5265
Bram Moolenaar8c711452005-01-14 21:53:12 +00005266 if (*p != '\'')
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005267 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005268 semsg(_("E115: Missing quote: %s"), *arg);
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005269 return FAIL;
5270 }
5271
Bram Moolenaar8c711452005-01-14 21:53:12 +00005272 /* If only parsing return after setting "*arg" */
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005273 if (!evaluate)
5274 {
5275 *arg = p + 1;
5276 return OK;
5277 }
5278
5279 /*
Bram Moolenaar8c711452005-01-14 21:53:12 +00005280 * Copy the string into allocated memory, handling '' to ' reduction.
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005281 */
5282 str = alloc((unsigned)((p - *arg) - reduce));
5283 if (str == NULL)
5284 return FAIL;
Bram Moolenaar8c711452005-01-14 21:53:12 +00005285 rettv->v_type = VAR_STRING;
5286 rettv->vval.v_string = str;
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005287
Bram Moolenaar8c711452005-01-14 21:53:12 +00005288 for (p = *arg + 1; *p != NUL; )
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005289 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00005290 if (*p == '\'')
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005291 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00005292 if (p[1] != '\'')
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005293 break;
5294 ++p;
5295 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00005296 MB_COPY_CHAR(p, str);
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005297 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00005298 *str = NUL;
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005299 *arg = p + 1;
5300
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005301 return OK;
5302}
5303
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005304/*
5305 * Return the function name of the partial.
5306 */
5307 char_u *
5308partial_name(partial_T *pt)
5309{
5310 if (pt->pt_name != NULL)
5311 return pt->pt_name;
5312 return pt->pt_func->uf_name;
5313}
5314
Bram Moolenaarddecc252016-04-06 22:59:37 +02005315 static void
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005316partial_free(partial_T *pt)
Bram Moolenaarddecc252016-04-06 22:59:37 +02005317{
5318 int i;
5319
5320 for (i = 0; i < pt->pt_argc; ++i)
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005321 clear_tv(&pt->pt_argv[i]);
Bram Moolenaarddecc252016-04-06 22:59:37 +02005322 vim_free(pt->pt_argv);
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005323 dict_unref(pt->pt_dict);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005324 if (pt->pt_name != NULL)
5325 {
5326 func_unref(pt->pt_name);
5327 vim_free(pt->pt_name);
5328 }
5329 else
5330 func_ptr_unref(pt->pt_func);
Bram Moolenaarddecc252016-04-06 22:59:37 +02005331 vim_free(pt);
5332}
5333
5334/*
5335 * Unreference a closure: decrement the reference count and free it when it
5336 * becomes zero.
5337 */
5338 void
5339partial_unref(partial_T *pt)
5340{
5341 if (pt != NULL && --pt->pt_refcount <= 0)
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005342 partial_free(pt);
Bram Moolenaarddecc252016-04-06 22:59:37 +02005343}
5344
Bram Moolenaar67b3f992010-11-10 20:41:57 +01005345static int tv_equal_recurse_limit;
5346
Bram Moolenaar8e759ba2016-06-02 17:46:20 +02005347 static int
5348func_equal(
5349 typval_T *tv1,
5350 typval_T *tv2,
5351 int ic) /* ignore case */
5352{
5353 char_u *s1, *s2;
5354 dict_T *d1, *d2;
5355 int a1, a2;
5356 int i;
5357
5358 /* empty and NULL function name considered the same */
5359 s1 = tv1->v_type == VAR_FUNC ? tv1->vval.v_string
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005360 : partial_name(tv1->vval.v_partial);
Bram Moolenaar8e759ba2016-06-02 17:46:20 +02005361 if (s1 != NULL && *s1 == NUL)
5362 s1 = NULL;
5363 s2 = tv2->v_type == VAR_FUNC ? tv2->vval.v_string
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005364 : partial_name(tv2->vval.v_partial);
Bram Moolenaar8e759ba2016-06-02 17:46:20 +02005365 if (s2 != NULL && *s2 == NUL)
5366 s2 = NULL;
5367 if (s1 == NULL || s2 == NULL)
5368 {
5369 if (s1 != s2)
5370 return FALSE;
5371 }
5372 else if (STRCMP(s1, s2) != 0)
5373 return FALSE;
5374
5375 /* empty dict and NULL dict is different */
5376 d1 = tv1->v_type == VAR_FUNC ? NULL : tv1->vval.v_partial->pt_dict;
5377 d2 = tv2->v_type == VAR_FUNC ? NULL : tv2->vval.v_partial->pt_dict;
5378 if (d1 == NULL || d2 == NULL)
5379 {
5380 if (d1 != d2)
5381 return FALSE;
5382 }
5383 else if (!dict_equal(d1, d2, ic, TRUE))
5384 return FALSE;
5385
5386 /* empty list and no list considered the same */
5387 a1 = tv1->v_type == VAR_FUNC ? 0 : tv1->vval.v_partial->pt_argc;
5388 a2 = tv2->v_type == VAR_FUNC ? 0 : tv2->vval.v_partial->pt_argc;
5389 if (a1 != a2)
5390 return FALSE;
5391 for (i = 0; i < a1; ++i)
5392 if (!tv_equal(tv1->vval.v_partial->pt_argv + i,
5393 tv2->vval.v_partial->pt_argv + i, ic, TRUE))
5394 return FALSE;
5395
5396 return TRUE;
5397}
5398
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00005399/*
Bram Moolenaar8a283e52005-01-06 23:28:25 +00005400 * Return TRUE if "tv1" and "tv2" have the same value.
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005401 * Compares the items just like "==" would compare them, but strings and
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005402 * numbers are different. Floats and numbers are also different.
Bram Moolenaar8a283e52005-01-06 23:28:25 +00005403 */
Bram Moolenaarcd524592016-07-17 14:57:05 +02005404 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005405tv_equal(
5406 typval_T *tv1,
5407 typval_T *tv2,
5408 int ic, /* ignore case */
5409 int recursive) /* TRUE when used recursively */
Bram Moolenaar8a283e52005-01-06 23:28:25 +00005410{
5411 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00005412 char_u *s1, *s2;
Bram Moolenaar67b3f992010-11-10 20:41:57 +01005413 static int recursive_cnt = 0; /* catch recursive loops */
Bram Moolenaarb47a2402006-10-15 13:09:12 +00005414 int r;
Bram Moolenaar8a283e52005-01-06 23:28:25 +00005415
Bram Moolenaar8b402a02006-10-17 13:16:39 +00005416 /* Catch lists and dicts that have an endless loop by limiting
Bram Moolenaar67b3f992010-11-10 20:41:57 +01005417 * recursiveness to a limit. We guess they are equal then.
5418 * A fixed limit has the problem of still taking an awful long time.
5419 * Reduce the limit every time running into it. That should work fine for
5420 * deeply linked structures that are not recursively linked and catch
5421 * recursiveness quickly. */
5422 if (!recursive)
5423 tv_equal_recurse_limit = 1000;
5424 if (recursive_cnt >= tv_equal_recurse_limit)
5425 {
5426 --tv_equal_recurse_limit;
Bram Moolenaar8b402a02006-10-17 13:16:39 +00005427 return TRUE;
Bram Moolenaar67b3f992010-11-10 20:41:57 +01005428 }
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005429
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02005430 /* For VAR_FUNC and VAR_PARTIAL compare the function name, bound dict and
5431 * arguments. */
Bram Moolenaar8e759ba2016-06-02 17:46:20 +02005432 if ((tv1->v_type == VAR_FUNC
5433 || (tv1->v_type == VAR_PARTIAL && tv1->vval.v_partial != NULL))
5434 && (tv2->v_type == VAR_FUNC
5435 || (tv2->v_type == VAR_PARTIAL && tv2->vval.v_partial != NULL)))
5436 {
5437 ++recursive_cnt;
5438 r = func_equal(tv1, tv2, ic);
5439 --recursive_cnt;
5440 return r;
5441 }
5442
5443 if (tv1->v_type != tv2->v_type)
5444 return FALSE;
5445
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005446 switch (tv1->v_type)
Bram Moolenaar8a283e52005-01-06 23:28:25 +00005447 {
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005448 case VAR_LIST:
Bram Moolenaar67b3f992010-11-10 20:41:57 +01005449 ++recursive_cnt;
5450 r = list_equal(tv1->vval.v_list, tv2->vval.v_list, ic, TRUE);
5451 --recursive_cnt;
Bram Moolenaarb47a2402006-10-15 13:09:12 +00005452 return r;
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005453
5454 case VAR_DICT:
Bram Moolenaar67b3f992010-11-10 20:41:57 +01005455 ++recursive_cnt;
5456 r = dict_equal(tv1->vval.v_dict, tv2->vval.v_dict, ic, TRUE);
5457 --recursive_cnt;
Bram Moolenaarb47a2402006-10-15 13:09:12 +00005458 return r;
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005459
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01005460 case VAR_BLOB:
5461 return blob_equal(tv1->vval.v_blob, tv2->vval.v_blob);
5462
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005463 case VAR_NUMBER:
5464 return tv1->vval.v_number == tv2->vval.v_number;
5465
5466 case VAR_STRING:
Bram Moolenaard155d7a2018-12-21 16:04:21 +01005467 s1 = tv_get_string_buf(tv1, buf1);
5468 s2 = tv_get_string_buf(tv2, buf2);
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005469 return ((ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2)) == 0);
Bram Moolenaar520e1e42016-01-23 19:46:28 +01005470
5471 case VAR_SPECIAL:
5472 return tv1->vval.v_number == tv2->vval.v_number;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005473
5474 case VAR_FLOAT:
5475#ifdef FEAT_FLOAT
5476 return tv1->vval.v_float == tv2->vval.v_float;
5477#endif
5478 case VAR_JOB:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005479#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar835dc632016-02-07 14:27:38 +01005480 return tv1->vval.v_job == tv2->vval.v_job;
5481#endif
Bram Moolenaar77073442016-02-13 23:23:53 +01005482 case VAR_CHANNEL:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005483#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar77073442016-02-13 23:23:53 +01005484 return tv1->vval.v_channel == tv2->vval.v_channel;
5485#endif
Bram Moolenaarf0e86a02016-03-19 19:38:12 +01005486 case VAR_FUNC:
5487 case VAR_PARTIAL:
Bram Moolenaar835dc632016-02-07 14:27:38 +01005488 case VAR_UNKNOWN:
5489 break;
Bram Moolenaar8a283e52005-01-06 23:28:25 +00005490 }
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005491
Bram Moolenaara03f2332016-02-06 18:09:59 +01005492 /* VAR_UNKNOWN can be the result of a invalid expression, let's say it
5493 * does not equal anything, not even itself. */
5494 return FALSE;
Bram Moolenaar8a283e52005-01-06 23:28:25 +00005495}
5496
5497/*
Bram Moolenaar520e1e42016-01-23 19:46:28 +01005498 * Return the next (unique) copy ID.
5499 * Used for serializing nested structures.
5500 */
5501 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005502get_copyID(void)
Bram Moolenaar520e1e42016-01-23 19:46:28 +01005503{
5504 current_copyID += COPYID_INC;
5505 return current_copyID;
5506}
5507
5508/*
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005509 * Garbage collection for lists and dictionaries.
5510 *
5511 * We use reference counts to be able to free most items right away when they
5512 * are no longer used. But for composite items it's possible that it becomes
5513 * unused while the reference count is > 0: When there is a recursive
5514 * reference. Example:
5515 * :let l = [1, 2, 3]
5516 * :let d = {9: l}
5517 * :let l[1] = d
5518 *
5519 * Since this is quite unusual we handle this with garbage collection: every
5520 * once in a while find out which lists and dicts are not referenced from any
5521 * variable.
5522 *
5523 * Here is a good reference text about garbage collection (refers to Python
5524 * but it applies to all reference-counting mechanisms):
5525 * http://python.ca/nas/python/gc/
Bram Moolenaard9fba312005-06-26 22:34:35 +00005526 */
Bram Moolenaard9fba312005-06-26 22:34:35 +00005527
5528/*
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005529 * Do garbage collection for lists and dicts.
Bram Moolenaar574860b2016-05-24 17:33:34 +02005530 * When "testing" is TRUE this is called from test_garbagecollect_now().
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005531 * Return TRUE if some memory was freed.
Bram Moolenaard9fba312005-06-26 22:34:35 +00005532 */
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005533 int
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02005534garbage_collect(int testing)
Bram Moolenaard9fba312005-06-26 22:34:35 +00005535{
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005536 int copyID;
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005537 int abort = FALSE;
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005538 buf_T *buf;
5539 win_T *wp;
5540 int i;
Bram Moolenaar934b1362015-02-04 23:06:45 +01005541 int did_free = FALSE;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005542 tabpage_T *tp;
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005543
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02005544 if (!testing)
5545 {
5546 /* Only do this once. */
5547 want_garbage_collect = FALSE;
5548 may_garbage_collect = FALSE;
5549 garbage_collect_at_exit = FALSE;
5550 }
Bram Moolenaar9fecb462006-09-05 10:59:47 +00005551
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005552 /* We advance by two because we add one for items referenced through
5553 * previous_funccal. */
Bram Moolenaar520e1e42016-01-23 19:46:28 +01005554 copyID = get_copyID();
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005555
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005556 /*
5557 * 1. Go through all accessible variables and mark all lists and dicts
5558 * with copyID.
5559 */
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005560
5561 /* Don't free variables in the previous_funccal list unless they are only
5562 * referenced through previous_funccal. This must be first, because if
Bram Moolenaar2c2398c2009-06-03 11:22:45 +00005563 * the item is referenced elsewhere the funccal must not be freed. */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005564 abort = abort || set_ref_in_previous_funccal(copyID);
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005565
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005566 /* script-local variables */
5567 for (i = 1; i <= ga_scripts.ga_len; ++i)
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005568 abort = abort || set_ref_in_ht(&SCRIPT_VARS(i), copyID, NULL);
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005569
5570 /* buffer-local variables */
Bram Moolenaar29323592016-07-24 22:04:11 +02005571 FOR_ALL_BUFFERS(buf)
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005572 abort = abort || set_ref_in_item(&buf->b_bufvar.di_tv, copyID,
5573 NULL, NULL);
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005574
5575 /* window-local variables */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005576 FOR_ALL_TAB_WINDOWS(tp, wp)
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005577 abort = abort || set_ref_in_item(&wp->w_winvar.di_tv, copyID,
5578 NULL, NULL);
Bram Moolenaar3bb28552013-04-15 18:25:59 +02005579 if (aucmd_win != NULL)
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005580 abort = abort || set_ref_in_item(&aucmd_win->w_winvar.di_tv, copyID,
5581 NULL, NULL);
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005582
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005583 /* tabpage-local variables */
Bram Moolenaar29323592016-07-24 22:04:11 +02005584 FOR_ALL_TABPAGES(tp)
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005585 abort = abort || set_ref_in_item(&tp->tp_winvar.di_tv, copyID,
5586 NULL, NULL);
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005587 /* global variables */
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005588 abort = abort || set_ref_in_ht(&globvarht, copyID, NULL);
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005589
5590 /* function-local variables */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005591 abort = abort || set_ref_in_call_stack(copyID);
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005592
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005593 /* named functions (matters for closures) */
5594 abort = abort || set_ref_in_functions(copyID);
5595
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02005596 /* function call arguments, if v:testing is set. */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005597 abort = abort || set_ref_in_func_args(copyID);
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02005598
Bram Moolenaard812df62008-11-09 12:46:09 +00005599 /* v: vars */
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005600 abort = abort || set_ref_in_ht(&vimvarht, copyID, NULL);
Bram Moolenaard812df62008-11-09 12:46:09 +00005601
Bram Moolenaar1dced572012-04-05 16:54:08 +02005602#ifdef FEAT_LUA
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005603 abort = abort || set_ref_in_lua(copyID);
Bram Moolenaar1dced572012-04-05 16:54:08 +02005604#endif
5605
Bram Moolenaardb913952012-06-29 12:54:53 +02005606#ifdef FEAT_PYTHON
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005607 abort = abort || set_ref_in_python(copyID);
Bram Moolenaardb913952012-06-29 12:54:53 +02005608#endif
5609
5610#ifdef FEAT_PYTHON3
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005611 abort = abort || set_ref_in_python3(copyID);
Bram Moolenaardb913952012-06-29 12:54:53 +02005612#endif
5613
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005614#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar3780bb92016-04-12 22:18:53 +02005615 abort = abort || set_ref_in_channel(copyID);
Bram Moolenaarb8d49052016-05-01 14:22:16 +02005616 abort = abort || set_ref_in_job(copyID);
Bram Moolenaar4b6a6dc2016-02-04 22:49:49 +01005617#endif
Bram Moolenaar3266c852016-04-30 18:07:05 +02005618#ifdef FEAT_NETBEANS_INTG
5619 abort = abort || set_ref_in_nb_channel(copyID);
5620#endif
Bram Moolenaar4b6a6dc2016-02-04 22:49:49 +01005621
Bram Moolenaare3188e22016-05-31 21:13:04 +02005622#ifdef FEAT_TIMERS
5623 abort = abort || set_ref_in_timer(copyID);
5624#endif
5625
Bram Moolenaar8f77c5a2017-04-30 14:21:00 +02005626#ifdef FEAT_QUICKFIX
5627 abort = abort || set_ref_in_quickfix(copyID);
5628#endif
5629
Bram Moolenaara2c45a12017-07-27 22:14:59 +02005630#ifdef FEAT_TERMINAL
5631 abort = abort || set_ref_in_term(copyID);
5632#endif
5633
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005634 if (!abort)
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005635 {
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005636 /*
5637 * 2. Free lists and dictionaries that are not referenced.
5638 */
5639 did_free = free_unref_items(copyID);
5640
5641 /*
5642 * 3. Check if any funccal can be freed now.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005643 * This may call us back recursively.
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005644 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005645 free_unref_funccal(copyID, testing);
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005646 }
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005647 else if (p_verbose > 0)
5648 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005649 verb_msg(_("Not enough memory to set references, garbage collection aborted!"));
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005650 }
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005651
5652 return did_free;
5653}
5654
5655/*
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005656 * Free lists, dictionaries, channels and jobs that are no longer referenced.
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005657 */
5658 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005659free_unref_items(int copyID)
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005660{
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005661 int did_free = FALSE;
5662
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005663 /* Let all "free" functions know that we are here. This means no
5664 * dictionaries, lists, channels or jobs are to be freed, because we will
5665 * do that here. */
5666 in_free_unref_items = TRUE;
5667
5668 /*
5669 * PASS 1: free the contents of the items. We don't free the items
5670 * themselves yet, so that it is possible to decrement refcount counters
5671 */
5672
Bram Moolenaarcd524592016-07-17 14:57:05 +02005673 /* Go through the list of dicts and free items without the copyID. */
5674 did_free |= dict_free_nonref(copyID);
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005675
Bram Moolenaarda861d62016-07-17 15:46:27 +02005676 /* Go through the list of lists and free items without the copyID. */
5677 did_free |= list_free_nonref(copyID);
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005678
5679#ifdef FEAT_JOB_CHANNEL
5680 /* Go through the list of jobs and free items without the copyID. This
5681 * must happen before doing channels, because jobs refer to channels, but
5682 * the reference from the channel to the job isn't tracked. */
5683 did_free |= free_unused_jobs_contents(copyID, COPYID_MASK);
5684
5685 /* Go through the list of channels and free items without the copyID. */
5686 did_free |= free_unused_channels_contents(copyID, COPYID_MASK);
5687#endif
5688
5689 /*
5690 * PASS 2: free the items themselves.
5691 */
Bram Moolenaarcd524592016-07-17 14:57:05 +02005692 dict_free_items(copyID);
Bram Moolenaarda861d62016-07-17 15:46:27 +02005693 list_free_items(copyID);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005694
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005695#ifdef FEAT_JOB_CHANNEL
5696 /* Go through the list of jobs and free items without the copyID. This
5697 * must happen before doing channels, because jobs refer to channels, but
5698 * the reference from the channel to the job isn't tracked. */
5699 free_unused_jobs(copyID, COPYID_MASK);
5700
5701 /* Go through the list of channels and free items without the copyID. */
5702 free_unused_channels(copyID, COPYID_MASK);
5703#endif
5704
5705 in_free_unref_items = FALSE;
5706
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005707 return did_free;
5708}
5709
5710/*
5711 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005712 * "list_stack" is used to add lists to be marked. Can be NULL.
5713 *
5714 * Returns TRUE if setting references failed somehow.
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005715 */
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005716 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005717set_ref_in_ht(hashtab_T *ht, int copyID, list_stack_T **list_stack)
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005718{
5719 int todo;
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005720 int abort = FALSE;
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005721 hashitem_T *hi;
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005722 hashtab_T *cur_ht;
5723 ht_stack_T *ht_stack = NULL;
5724 ht_stack_T *tempitem;
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005725
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005726 cur_ht = ht;
5727 for (;;)
5728 {
5729 if (!abort)
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005730 {
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005731 /* Mark each item in the hashtab. If the item contains a hashtab
5732 * it is added to ht_stack, if it contains a list it is added to
5733 * list_stack. */
5734 todo = (int)cur_ht->ht_used;
5735 for (hi = cur_ht->ht_array; todo > 0; ++hi)
5736 if (!HASHITEM_EMPTY(hi))
5737 {
5738 --todo;
5739 abort = abort || set_ref_in_item(&HI2DI(hi)->di_tv, copyID,
5740 &ht_stack, list_stack);
5741 }
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005742 }
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005743
5744 if (ht_stack == NULL)
5745 break;
5746
5747 /* take an item from the stack */
5748 cur_ht = ht_stack->ht;
5749 tempitem = ht_stack;
5750 ht_stack = ht_stack->prev;
5751 free(tempitem);
5752 }
5753
5754 return abort;
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005755}
5756
5757/*
5758 * Mark all lists and dicts referenced through list "l" with "copyID".
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005759 * "ht_stack" is used to add hashtabs to be marked. Can be NULL.
5760 *
5761 * Returns TRUE if setting references failed somehow.
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005762 */
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005763 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005764set_ref_in_list(list_T *l, int copyID, ht_stack_T **ht_stack)
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005765{
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005766 listitem_T *li;
5767 int abort = FALSE;
5768 list_T *cur_l;
5769 list_stack_T *list_stack = NULL;
5770 list_stack_T *tempitem;
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005771
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005772 cur_l = l;
5773 for (;;)
5774 {
5775 if (!abort)
5776 /* Mark each item in the list. If the item contains a hashtab
5777 * it is added to ht_stack, if it contains a list it is added to
5778 * list_stack. */
5779 for (li = cur_l->lv_first; !abort && li != NULL; li = li->li_next)
5780 abort = abort || set_ref_in_item(&li->li_tv, copyID,
5781 ht_stack, &list_stack);
5782 if (list_stack == NULL)
5783 break;
5784
5785 /* take an item from the stack */
5786 cur_l = list_stack->list;
5787 tempitem = list_stack;
5788 list_stack = list_stack->prev;
5789 free(tempitem);
5790 }
5791
5792 return abort;
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005793}
5794
5795/*
5796 * Mark all lists and dicts referenced through typval "tv" with "copyID".
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005797 * "list_stack" is used to add lists to be marked. Can be NULL.
5798 * "ht_stack" is used to add hashtabs to be marked. Can be NULL.
5799 *
5800 * Returns TRUE if setting references failed somehow.
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005801 */
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005802 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005803set_ref_in_item(
5804 typval_T *tv,
5805 int copyID,
5806 ht_stack_T **ht_stack,
5807 list_stack_T **list_stack)
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005808{
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005809 int abort = FALSE;
Bram Moolenaard9fba312005-06-26 22:34:35 +00005810
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005811 if (tv->v_type == VAR_DICT)
Bram Moolenaard9fba312005-06-26 22:34:35 +00005812 {
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005813 dict_T *dd = tv->vval.v_dict;
5814
Bram Moolenaara03f2332016-02-06 18:09:59 +01005815 if (dd != NULL && dd->dv_copyID != copyID)
5816 {
5817 /* Didn't see this dict yet. */
5818 dd->dv_copyID = copyID;
5819 if (ht_stack == NULL)
Bram Moolenaard9fba312005-06-26 22:34:35 +00005820 {
Bram Moolenaara03f2332016-02-06 18:09:59 +01005821 abort = set_ref_in_ht(&dd->dv_hashtab, copyID, list_stack);
5822 }
5823 else
5824 {
5825 ht_stack_T *newitem = (ht_stack_T*)malloc(sizeof(ht_stack_T));
5826 if (newitem == NULL)
5827 abort = TRUE;
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005828 else
5829 {
Bram Moolenaara03f2332016-02-06 18:09:59 +01005830 newitem->ht = &dd->dv_hashtab;
5831 newitem->prev = *ht_stack;
5832 *ht_stack = newitem;
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005833 }
Bram Moolenaard9fba312005-06-26 22:34:35 +00005834 }
Bram Moolenaara03f2332016-02-06 18:09:59 +01005835 }
5836 }
5837 else if (tv->v_type == VAR_LIST)
5838 {
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005839 list_T *ll = tv->vval.v_list;
5840
Bram Moolenaara03f2332016-02-06 18:09:59 +01005841 if (ll != NULL && ll->lv_copyID != copyID)
5842 {
5843 /* Didn't see this list yet. */
5844 ll->lv_copyID = copyID;
5845 if (list_stack == NULL)
Bram Moolenaard9fba312005-06-26 22:34:35 +00005846 {
Bram Moolenaara03f2332016-02-06 18:09:59 +01005847 abort = set_ref_in_list(ll, copyID, ht_stack);
5848 }
5849 else
5850 {
5851 list_stack_T *newitem = (list_stack_T*)malloc(
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005852 sizeof(list_stack_T));
Bram Moolenaara03f2332016-02-06 18:09:59 +01005853 if (newitem == NULL)
5854 abort = TRUE;
5855 else
5856 {
5857 newitem->list = ll;
5858 newitem->prev = *list_stack;
5859 *list_stack = newitem;
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005860 }
Bram Moolenaard9fba312005-06-26 22:34:35 +00005861 }
Bram Moolenaara03f2332016-02-06 18:09:59 +01005862 }
Bram Moolenaard9fba312005-06-26 22:34:35 +00005863 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005864 else if (tv->v_type == VAR_FUNC)
5865 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005866 abort = set_ref_in_func(tv->vval.v_string, NULL, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005867 }
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005868 else if (tv->v_type == VAR_PARTIAL)
5869 {
5870 partial_T *pt = tv->vval.v_partial;
5871 int i;
5872
5873 /* A partial does not have a copyID, because it cannot contain itself.
5874 */
5875 if (pt != NULL)
5876 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005877 abort = set_ref_in_func(pt->pt_name, pt->pt_func, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005878
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005879 if (pt->pt_dict != NULL)
5880 {
5881 typval_T dtv;
5882
5883 dtv.v_type = VAR_DICT;
5884 dtv.vval.v_dict = pt->pt_dict;
5885 set_ref_in_item(&dtv, copyID, ht_stack, list_stack);
5886 }
5887
5888 for (i = 0; i < pt->pt_argc; ++i)
5889 abort = abort || set_ref_in_item(&pt->pt_argv[i], copyID,
5890 ht_stack, list_stack);
5891 }
5892 }
5893#ifdef FEAT_JOB_CHANNEL
5894 else if (tv->v_type == VAR_JOB)
5895 {
5896 job_T *job = tv->vval.v_job;
5897 typval_T dtv;
5898
5899 if (job != NULL && job->jv_copyID != copyID)
5900 {
Bram Moolenaar0239acb2016-04-11 21:02:54 +02005901 job->jv_copyID = copyID;
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005902 if (job->jv_channel != NULL)
5903 {
5904 dtv.v_type = VAR_CHANNEL;
5905 dtv.vval.v_channel = job->jv_channel;
5906 set_ref_in_item(&dtv, copyID, ht_stack, list_stack);
5907 }
5908 if (job->jv_exit_partial != NULL)
5909 {
5910 dtv.v_type = VAR_PARTIAL;
5911 dtv.vval.v_partial = job->jv_exit_partial;
5912 set_ref_in_item(&dtv, copyID, ht_stack, list_stack);
5913 }
5914 }
5915 }
5916 else if (tv->v_type == VAR_CHANNEL)
5917 {
5918 channel_T *ch =tv->vval.v_channel;
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02005919 ch_part_T part;
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005920 typval_T dtv;
5921 jsonq_T *jq;
5922 cbq_T *cq;
5923
5924 if (ch != NULL && ch->ch_copyID != copyID)
5925 {
Bram Moolenaar0239acb2016-04-11 21:02:54 +02005926 ch->ch_copyID = copyID;
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02005927 for (part = PART_SOCK; part < PART_COUNT; ++part)
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005928 {
5929 for (jq = ch->ch_part[part].ch_json_head.jq_next; jq != NULL;
5930 jq = jq->jq_next)
5931 set_ref_in_item(jq->jq_value, copyID, ht_stack, list_stack);
5932 for (cq = ch->ch_part[part].ch_cb_head.cq_next; cq != NULL;
5933 cq = cq->cq_next)
5934 if (cq->cq_partial != NULL)
5935 {
5936 dtv.v_type = VAR_PARTIAL;
5937 dtv.vval.v_partial = cq->cq_partial;
5938 set_ref_in_item(&dtv, copyID, ht_stack, list_stack);
5939 }
5940 if (ch->ch_part[part].ch_partial != NULL)
5941 {
5942 dtv.v_type = VAR_PARTIAL;
5943 dtv.vval.v_partial = ch->ch_part[part].ch_partial;
5944 set_ref_in_item(&dtv, copyID, ht_stack, list_stack);
5945 }
5946 }
5947 if (ch->ch_partial != NULL)
5948 {
5949 dtv.v_type = VAR_PARTIAL;
5950 dtv.vval.v_partial = ch->ch_partial;
5951 set_ref_in_item(&dtv, copyID, ht_stack, list_stack);
5952 }
5953 if (ch->ch_close_partial != NULL)
5954 {
5955 dtv.v_type = VAR_PARTIAL;
5956 dtv.vval.v_partial = ch->ch_close_partial;
5957 set_ref_in_item(&dtv, copyID, ht_stack, list_stack);
5958 }
5959 }
5960 }
5961#endif
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005962 return abort;
Bram Moolenaard9fba312005-06-26 22:34:35 +00005963}
5964
Bram Moolenaar17a13432016-01-24 14:22:10 +01005965 static char *
5966get_var_special_name(int nr)
5967{
5968 switch (nr)
5969 {
Bram Moolenaarf48aa162016-01-24 17:54:24 +01005970 case VVAL_FALSE: return "v:false";
Bram Moolenaar65edff82016-02-21 16:40:11 +01005971 case VVAL_TRUE: return "v:true";
5972 case VVAL_NONE: return "v:none";
5973 case VVAL_NULL: return "v:null";
Bram Moolenaar17a13432016-01-24 14:22:10 +01005974 }
Bram Moolenaar95f09602016-11-10 20:01:45 +01005975 internal_error("get_var_special_name()");
Bram Moolenaar17a13432016-01-24 14:22:10 +01005976 return "42";
5977}
5978
Bram Moolenaar8c711452005-01-14 21:53:12 +00005979/*
Bram Moolenaar49cd9572005-01-03 21:06:01 +00005980 * Return a string with the string representation of a variable.
5981 * If the memory is allocated "tofree" is set to it, otherwise NULL.
Bram Moolenaar8a283e52005-01-06 23:28:25 +00005982 * "numbuf" is used for a number.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00005983 * When "copyID" is not NULL replace recursive lists and dicts with "...".
Bram Moolenaar35422f42017-08-05 16:33:56 +02005984 * When both "echo_style" and "composite_val" are FALSE, put quotes around
5985 * stings as "string()", otherwise does not put quotes around strings, as
5986 * ":echo" displays values.
Bram Moolenaar18dfb442016-05-31 22:31:23 +02005987 * When "restore_copyID" is FALSE, repeated items in dictionaries and lists
5988 * are replaced with "...".
Bram Moolenaar92c5aba2007-08-14 20:29:31 +00005989 * May return NULL.
Bram Moolenaar49cd9572005-01-03 21:06:01 +00005990 */
Bram Moolenaarcd524592016-07-17 14:57:05 +02005991 char_u *
Bram Moolenaar18dfb442016-05-31 22:31:23 +02005992echo_string_core(
Bram Moolenaar7454a062016-01-30 15:14:10 +01005993 typval_T *tv,
5994 char_u **tofree,
5995 char_u *numbuf,
Bram Moolenaar18dfb442016-05-31 22:31:23 +02005996 int copyID,
5997 int echo_style,
5998 int restore_copyID,
Bram Moolenaar35422f42017-08-05 16:33:56 +02005999 int composite_val)
Bram Moolenaar49cd9572005-01-03 21:06:01 +00006000{
Bram Moolenaare9a41262005-01-15 22:18:47 +00006001 static int recurse = 0;
6002 char_u *r = NULL;
6003
Bram Moolenaar33570922005-01-25 22:26:29 +00006004 if (recurse >= DICT_MAXNEST)
Bram Moolenaare9a41262005-01-15 22:18:47 +00006005 {
Bram Moolenaar8502c702014-06-17 12:51:16 +02006006 if (!did_echo_string_emsg)
6007 {
6008 /* Only give this message once for a recursive call to avoid
6009 * flooding the user with errors. And stop iterating over lists
6010 * and dicts. */
6011 did_echo_string_emsg = TRUE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006012 emsg(_("E724: variable nested too deep for displaying"));
Bram Moolenaar8502c702014-06-17 12:51:16 +02006013 }
Bram Moolenaare9a41262005-01-15 22:18:47 +00006014 *tofree = NULL;
Bram Moolenaar8502c702014-06-17 12:51:16 +02006015 return (char_u *)"{E724}";
Bram Moolenaare9a41262005-01-15 22:18:47 +00006016 }
6017 ++recurse;
6018
Bram Moolenaar49cd9572005-01-03 21:06:01 +00006019 switch (tv->v_type)
6020 {
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006021 case VAR_STRING:
Bram Moolenaar35422f42017-08-05 16:33:56 +02006022 if (echo_style && !composite_val)
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006023 {
6024 *tofree = NULL;
Bram Moolenaar35422f42017-08-05 16:33:56 +02006025 r = tv->vval.v_string;
6026 if (r == NULL)
6027 r = (char_u *)"";
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006028 }
6029 else
6030 {
6031 *tofree = string_quote(tv->vval.v_string, FALSE);
6032 r = *tofree;
6033 }
6034 break;
6035
Bram Moolenaar49cd9572005-01-03 21:06:01 +00006036 case VAR_FUNC:
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006037 if (echo_style)
6038 {
6039 *tofree = NULL;
6040 r = tv->vval.v_string;
6041 }
6042 else
6043 {
6044 *tofree = string_quote(tv->vval.v_string, TRUE);
6045 r = *tofree;
6046 }
Bram Moolenaare9a41262005-01-15 22:18:47 +00006047 break;
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006048
Bram Moolenaar1735bc92016-03-14 23:05:14 +01006049 case VAR_PARTIAL:
Bram Moolenaar24c77a12016-03-24 21:23:06 +01006050 {
6051 partial_T *pt = tv->vval.v_partial;
6052 char_u *fname = string_quote(pt == NULL ? NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006053 : partial_name(pt), FALSE);
Bram Moolenaar24c77a12016-03-24 21:23:06 +01006054 garray_T ga;
6055 int i;
6056 char_u *tf;
6057
6058 ga_init2(&ga, 1, 100);
6059 ga_concat(&ga, (char_u *)"function(");
6060 if (fname != NULL)
6061 {
6062 ga_concat(&ga, fname);
6063 vim_free(fname);
6064 }
6065 if (pt != NULL && pt->pt_argc > 0)
6066 {
6067 ga_concat(&ga, (char_u *)", [");
6068 for (i = 0; i < pt->pt_argc; ++i)
6069 {
6070 if (i > 0)
6071 ga_concat(&ga, (char_u *)", ");
6072 ga_concat(&ga,
6073 tv2string(&pt->pt_argv[i], &tf, numbuf, copyID));
6074 vim_free(tf);
6075 }
6076 ga_concat(&ga, (char_u *)"]");
6077 }
6078 if (pt != NULL && pt->pt_dict != NULL)
6079 {
6080 typval_T dtv;
6081
6082 ga_concat(&ga, (char_u *)", ");
6083 dtv.v_type = VAR_DICT;
6084 dtv.vval.v_dict = pt->pt_dict;
6085 ga_concat(&ga, tv2string(&dtv, &tf, numbuf, copyID));
6086 vim_free(tf);
6087 }
6088 ga_concat(&ga, (char_u *)")");
6089
6090 *tofree = ga.ga_data;
6091 r = *tofree;
6092 break;
6093 }
Bram Moolenaar1735bc92016-03-14 23:05:14 +01006094
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01006095 case VAR_BLOB:
Bram Moolenaar8c8b8bb2019-01-13 17:48:04 +01006096 r = blob2string(tv->vval.v_blob, tofree, numbuf);
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01006097 break;
6098
Bram Moolenaar49cd9572005-01-03 21:06:01 +00006099 case VAR_LIST:
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006100 if (tv->vval.v_list == NULL)
6101 {
6102 *tofree = NULL;
6103 r = NULL;
6104 }
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006105 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID
6106 && tv->vval.v_list->lv_len > 0)
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006107 {
6108 *tofree = NULL;
6109 r = (char_u *)"[...]";
6110 }
6111 else
6112 {
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006113 int old_copyID = tv->vval.v_list->lv_copyID;
6114
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006115 tv->vval.v_list->lv_copyID = copyID;
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006116 *tofree = list2string(tv, copyID, restore_copyID);
6117 if (restore_copyID)
6118 tv->vval.v_list->lv_copyID = old_copyID;
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006119 r = *tofree;
6120 }
Bram Moolenaare9a41262005-01-15 22:18:47 +00006121 break;
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006122
Bram Moolenaar8c711452005-01-14 21:53:12 +00006123 case VAR_DICT:
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006124 if (tv->vval.v_dict == NULL)
6125 {
6126 *tofree = NULL;
6127 r = NULL;
6128 }
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006129 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID
6130 && tv->vval.v_dict->dv_hashtab.ht_used != 0)
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006131 {
6132 *tofree = NULL;
6133 r = (char_u *)"{...}";
6134 }
6135 else
6136 {
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006137 int old_copyID = tv->vval.v_dict->dv_copyID;
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006138 tv->vval.v_dict->dv_copyID = copyID;
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006139 *tofree = dict2string(tv, copyID, restore_copyID);
6140 if (restore_copyID)
6141 tv->vval.v_dict->dv_copyID = old_copyID;
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006142 r = *tofree;
6143 }
Bram Moolenaare9a41262005-01-15 22:18:47 +00006144 break;
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006145
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006146 case VAR_NUMBER:
Bram Moolenaara03f2332016-02-06 18:09:59 +01006147 case VAR_UNKNOWN:
Bram Moolenaar35422f42017-08-05 16:33:56 +02006148 *tofree = NULL;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01006149 r = tv_get_string_buf(tv, numbuf);
Bram Moolenaar35422f42017-08-05 16:33:56 +02006150 break;
6151
Bram Moolenaar835dc632016-02-07 14:27:38 +01006152 case VAR_JOB:
Bram Moolenaar77073442016-02-13 23:23:53 +01006153 case VAR_CHANNEL:
Bram Moolenaare9a41262005-01-15 22:18:47 +00006154 *tofree = NULL;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01006155 r = tv_get_string_buf(tv, numbuf);
Bram Moolenaar35422f42017-08-05 16:33:56 +02006156 if (composite_val)
6157 {
6158 *tofree = string_quote(r, FALSE);
6159 r = *tofree;
6160 }
Bram Moolenaar49cd9572005-01-03 21:06:01 +00006161 break;
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006162
Bram Moolenaar8c8de832008-06-24 22:58:06 +00006163 case VAR_FLOAT:
Bram Moolenaar835dc632016-02-07 14:27:38 +01006164#ifdef FEAT_FLOAT
Bram Moolenaar8c8de832008-06-24 22:58:06 +00006165 *tofree = NULL;
6166 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
6167 r = numbuf;
6168 break;
6169#endif
6170
Bram Moolenaar520e1e42016-01-23 19:46:28 +01006171 case VAR_SPECIAL:
6172 *tofree = NULL;
Bram Moolenaar17a13432016-01-24 14:22:10 +01006173 r = (char_u *)get_var_special_name(tv->vval.v_number);
Bram Moolenaar520e1e42016-01-23 19:46:28 +01006174 break;
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006175 }
Bram Moolenaare9a41262005-01-15 22:18:47 +00006176
Bram Moolenaar8502c702014-06-17 12:51:16 +02006177 if (--recurse == 0)
6178 did_echo_string_emsg = FALSE;
Bram Moolenaare9a41262005-01-15 22:18:47 +00006179 return r;
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006180}
6181
6182/*
6183 * Return a string with the string representation of a variable.
6184 * If the memory is allocated "tofree" is set to it, otherwise NULL.
6185 * "numbuf" is used for a number.
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006186 * Does not put quotes around strings, as ":echo" displays values.
6187 * When "copyID" is not NULL replace recursive lists and dicts with "...".
6188 * May return NULL.
6189 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006190 char_u *
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006191echo_string(
6192 typval_T *tv,
6193 char_u **tofree,
6194 char_u *numbuf,
6195 int copyID)
6196{
6197 return echo_string_core(tv, tofree, numbuf, copyID, TRUE, FALSE, FALSE);
6198}
6199
6200/*
6201 * Return a string with the string representation of a variable.
6202 * If the memory is allocated "tofree" is set to it, otherwise NULL.
6203 * "numbuf" is used for a number.
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006204 * Puts quotes around strings, so that they can be parsed back by eval().
Bram Moolenaar92c5aba2007-08-14 20:29:31 +00006205 * May return NULL.
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006206 */
Bram Moolenaar8110a092016-04-14 15:56:09 +02006207 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01006208tv2string(
6209 typval_T *tv,
6210 char_u **tofree,
6211 char_u *numbuf,
6212 int copyID)
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006213{
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006214 return echo_string_core(tv, tofree, numbuf, copyID, FALSE, TRUE, FALSE);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00006215}
6216
6217/*
Bram Moolenaar33570922005-01-25 22:26:29 +00006218 * Return string "str" in ' quotes, doubling ' characters.
6219 * If "str" is NULL an empty string is assumed.
Bram Moolenaar8c711452005-01-14 21:53:12 +00006220 * If "function" is TRUE make it function('string').
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006221 */
Bram Moolenaarcd524592016-07-17 14:57:05 +02006222 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01006223string_quote(char_u *str, int function)
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006224{
Bram Moolenaar33570922005-01-25 22:26:29 +00006225 unsigned len;
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006226 char_u *p, *r, *s;
6227
Bram Moolenaar33570922005-01-25 22:26:29 +00006228 len = (function ? 13 : 3);
6229 if (str != NULL)
6230 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006231 len += (unsigned)STRLEN(str);
Bram Moolenaar91acfff2017-03-12 19:22:36 +01006232 for (p = str; *p != NUL; MB_PTR_ADV(p))
Bram Moolenaar33570922005-01-25 22:26:29 +00006233 if (*p == '\'')
6234 ++len;
6235 }
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006236 s = r = alloc(len);
6237 if (r != NULL)
6238 {
6239 if (function)
6240 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00006241 STRCPY(r, "function('");
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006242 r += 10;
6243 }
6244 else
Bram Moolenaar8c711452005-01-14 21:53:12 +00006245 *r++ = '\'';
Bram Moolenaar33570922005-01-25 22:26:29 +00006246 if (str != NULL)
6247 for (p = str; *p != NUL; )
6248 {
6249 if (*p == '\'')
6250 *r++ = '\'';
6251 MB_COPY_CHAR(p, r);
6252 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00006253 *r++ = '\'';
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006254 if (function)
6255 *r++ = ')';
6256 *r++ = NUL;
6257 }
6258 return s;
6259}
6260
Bram Moolenaar520e1e42016-01-23 19:46:28 +01006261#if defined(FEAT_FLOAT) || defined(PROTO)
Bram Moolenaar8c8de832008-06-24 22:58:06 +00006262/*
6263 * Convert the string "text" to a floating point number.
6264 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
6265 * this always uses a decimal point.
6266 * Returns the length of the text that was consumed.
6267 */
Bram Moolenaar520e1e42016-01-23 19:46:28 +01006268 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01006269string2float(
6270 char_u *text,
6271 float_T *value) /* result stored here */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00006272{
6273 char *s = (char *)text;
6274 float_T f;
6275
Bram Moolenaar62473612017-01-08 19:25:40 +01006276 /* MS-Windows does not deal with "inf" and "nan" properly. */
6277 if (STRNICMP(text, "inf", 3) == 0)
6278 {
6279 *value = INFINITY;
6280 return 3;
6281 }
6282 if (STRNICMP(text, "-inf", 3) == 0)
6283 {
6284 *value = -INFINITY;
6285 return 4;
6286 }
6287 if (STRNICMP(text, "nan", 3) == 0)
6288 {
6289 *value = NAN;
6290 return 3;
6291 }
Bram Moolenaar8c8de832008-06-24 22:58:06 +00006292 f = strtod(s, &s);
6293 *value = f;
6294 return (int)((char_u *)s - text);
6295}
6296#endif
6297
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006298/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006299 * Get the value of an environment variable.
6300 * "arg" is pointing to the '$'. It is advanced to after the name.
6301 * If the environment variable was not set, silently assume it is empty.
Bram Moolenaare512c8c2014-04-29 17:41:22 +02006302 * Return FAIL if the name is invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006303 */
6304 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01006305get_env_tv(char_u **arg, typval_T *rettv, int evaluate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006306{
6307 char_u *string = NULL;
6308 int len;
6309 int cc;
6310 char_u *name;
Bram Moolenaar05159a02005-02-26 23:04:13 +00006311 int mustfree = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312
6313 ++*arg;
6314 name = *arg;
6315 len = get_env_len(arg);
6316 if (evaluate)
6317 {
Bram Moolenaare512c8c2014-04-29 17:41:22 +02006318 if (len == 0)
Bram Moolenaar615b9972015-01-14 17:15:05 +01006319 return FAIL; /* invalid empty name */
Bram Moolenaar05159a02005-02-26 23:04:13 +00006320
Bram Moolenaare512c8c2014-04-29 17:41:22 +02006321 cc = name[len];
6322 name[len] = NUL;
6323 /* first try vim_getenv(), fast for normal environment vars */
6324 string = vim_getenv(name, &mustfree);
6325 if (string != NULL && *string != NUL)
6326 {
6327 if (!mustfree)
6328 string = vim_strsave(string);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 }
Bram Moolenaare512c8c2014-04-29 17:41:22 +02006330 else
6331 {
6332 if (mustfree)
6333 vim_free(string);
6334
6335 /* next try expanding things like $VIM and ${HOME} */
6336 string = expand_env_save(name - 1);
6337 if (string != NULL && *string == '$')
Bram Moolenaard23a8232018-02-10 18:45:26 +01006338 VIM_CLEAR(string);
Bram Moolenaare512c8c2014-04-29 17:41:22 +02006339 }
6340 name[len] = cc;
6341
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006342 rettv->v_type = VAR_STRING;
6343 rettv->vval.v_string = string;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006344 }
6345
6346 return OK;
6347}
6348
Bram Moolenaard6e256c2011-12-14 15:32:50 +01006349
6350
6351/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 * Translate a String variable into a position.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006353 * Returns NULL when there is an error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006354 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02006355 pos_T *
Bram Moolenaar7454a062016-01-30 15:14:10 +01006356var2fpos(
6357 typval_T *varp,
6358 int dollar_lnum, /* TRUE when $ is last line */
6359 int *fnum) /* set to fnum for '0, 'A, etc. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006360{
Bram Moolenaar261bfea2006-03-01 22:12:31 +00006361 char_u *name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 static pos_T pos;
Bram Moolenaar261bfea2006-03-01 22:12:31 +00006363 pos_T *pp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364
Bram Moolenaara5525202006-03-02 22:52:09 +00006365 /* Argument can be [lnum, col, coladd]. */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006366 if (varp->v_type == VAR_LIST)
6367 {
6368 list_T *l;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006369 int len;
Bram Moolenaara5525202006-03-02 22:52:09 +00006370 int error = FALSE;
Bram Moolenaar477933c2007-07-17 14:32:23 +00006371 listitem_T *li;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006372
6373 l = varp->vval.v_list;
6374 if (l == NULL)
6375 return NULL;
6376
6377 /* Get the line number */
Bram Moolenaara5525202006-03-02 22:52:09 +00006378 pos.lnum = list_find_nr(l, 0L, &error);
6379 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006380 return NULL; /* invalid line number */
6381
6382 /* Get the column number */
Bram Moolenaara5525202006-03-02 22:52:09 +00006383 pos.col = list_find_nr(l, 1L, &error);
6384 if (error)
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006385 return NULL;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006386 len = (long)STRLEN(ml_get(pos.lnum));
Bram Moolenaar477933c2007-07-17 14:32:23 +00006387
6388 /* We accept "$" for the column number: last column. */
6389 li = list_find(l, 1L);
6390 if (li != NULL && li->li_tv.v_type == VAR_STRING
6391 && li->li_tv.vval.v_string != NULL
6392 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
6393 pos.col = len + 1;
6394
Bram Moolenaara5525202006-03-02 22:52:09 +00006395 /* Accept a position up to the NUL after the line. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00006396 if (pos.col == 0 || (int)pos.col > len + 1)
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006397 return NULL; /* invalid column number */
Bram Moolenaara5525202006-03-02 22:52:09 +00006398 --pos.col;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006399
Bram Moolenaara5525202006-03-02 22:52:09 +00006400 /* Get the virtual offset. Defaults to zero. */
6401 pos.coladd = list_find_nr(l, 2L, &error);
6402 if (error)
6403 pos.coladd = 0;
Bram Moolenaara5525202006-03-02 22:52:09 +00006404
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006405 return &pos;
6406 }
6407
Bram Moolenaard155d7a2018-12-21 16:04:21 +01006408 name = tv_get_string_chk(varp);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00006409 if (name == NULL)
6410 return NULL;
Bram Moolenaar9ecd0232008-06-20 15:31:51 +00006411 if (name[0] == '.') /* cursor */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 return &curwin->w_cursor;
Bram Moolenaar9ecd0232008-06-20 15:31:51 +00006413 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
6414 {
6415 if (VIsual_active)
6416 return &VIsual;
6417 return &curwin->w_cursor;
6418 }
Bram Moolenaar9ecd0232008-06-20 15:31:51 +00006419 if (name[0] == '\'') /* mark */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420 {
Bram Moolenaar9d182dd2013-01-23 15:53:15 +01006421 pp = getmark_buf_fnum(curbuf, name[1], FALSE, fnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
6423 return NULL;
6424 return pp;
6425 }
Bram Moolenaara5525202006-03-02 22:52:09 +00006426
Bram Moolenaara5525202006-03-02 22:52:09 +00006427 pos.coladd = 0;
Bram Moolenaara5525202006-03-02 22:52:09 +00006428
Bram Moolenaar477933c2007-07-17 14:32:23 +00006429 if (name[0] == 'w' && dollar_lnum)
Bram Moolenaarf52c7252006-02-10 23:23:57 +00006430 {
6431 pos.col = 0;
6432 if (name[1] == '0') /* "w0": first visible line */
6433 {
Bram Moolenaarf740b292006-02-16 22:11:02 +00006434 update_topline();
Bram Moolenaara1d5fa62017-04-03 22:02:55 +02006435 /* In silent Ex mode topline is zero, but that's not a valid line
6436 * number; use one instead. */
6437 pos.lnum = curwin->w_topline > 0 ? curwin->w_topline : 1;
Bram Moolenaarf52c7252006-02-10 23:23:57 +00006438 return &pos;
6439 }
6440 else if (name[1] == '$') /* "w$": last visible line */
6441 {
Bram Moolenaarf740b292006-02-16 22:11:02 +00006442 validate_botline();
Bram Moolenaara1d5fa62017-04-03 22:02:55 +02006443 /* In silent Ex mode botline is zero, return zero then. */
6444 pos.lnum = curwin->w_botline > 0 ? curwin->w_botline - 1 : 0;
Bram Moolenaarf52c7252006-02-10 23:23:57 +00006445 return &pos;
6446 }
6447 }
6448 else if (name[0] == '$') /* last column or line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006449 {
Bram Moolenaar477933c2007-07-17 14:32:23 +00006450 if (dollar_lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 {
6452 pos.lnum = curbuf->b_ml.ml_line_count;
6453 pos.col = 0;
6454 }
6455 else
6456 {
6457 pos.lnum = curwin->w_cursor.lnum;
6458 pos.col = (colnr_T)STRLEN(ml_get_curline());
6459 }
6460 return &pos;
6461 }
6462 return NULL;
6463}
6464
6465/*
Bram Moolenaar0e34f622006-03-03 23:00:03 +00006466 * Convert list in "arg" into a position and optional file number.
6467 * When "fnump" is NULL there is no file number, only 3 items.
6468 * Note that the column is passed on as-is, the caller may want to decrement
6469 * it to use 1 for the first column.
6470 * Return FAIL when conversion is not possible, doesn't check the position for
6471 * validity.
6472 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02006473 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01006474list2fpos(
6475 typval_T *arg,
6476 pos_T *posp,
6477 int *fnump,
6478 colnr_T *curswantp)
Bram Moolenaar0e34f622006-03-03 23:00:03 +00006479{
6480 list_T *l = arg->vval.v_list;
6481 long i = 0;
6482 long n;
6483
Bram Moolenaar493c1782014-05-28 14:34:46 +02006484 /* List must be: [fnum, lnum, col, coladd, curswant], where "fnum" is only
6485 * there when "fnump" isn't NULL; "coladd" and "curswant" are optional. */
Bram Moolenaarbde35262006-07-23 20:12:24 +00006486 if (arg->v_type != VAR_LIST
6487 || l == NULL
6488 || l->lv_len < (fnump == NULL ? 2 : 3)
Bram Moolenaar493c1782014-05-28 14:34:46 +02006489 || l->lv_len > (fnump == NULL ? 4 : 5))
Bram Moolenaar0e34f622006-03-03 23:00:03 +00006490 return FAIL;
6491
6492 if (fnump != NULL)
6493 {
6494 n = list_find_nr(l, i++, NULL); /* fnum */
6495 if (n < 0)
6496 return FAIL;
6497 if (n == 0)
6498 n = curbuf->b_fnum; /* current buffer */
6499 *fnump = n;
6500 }
6501
6502 n = list_find_nr(l, i++, NULL); /* lnum */
6503 if (n < 0)
6504 return FAIL;
6505 posp->lnum = n;
6506
6507 n = list_find_nr(l, i++, NULL); /* col */
6508 if (n < 0)
6509 return FAIL;
6510 posp->col = n;
6511
Bram Moolenaar493c1782014-05-28 14:34:46 +02006512 n = list_find_nr(l, i, NULL); /* off */
Bram Moolenaar0e34f622006-03-03 23:00:03 +00006513 if (n < 0)
Bram Moolenaarbde35262006-07-23 20:12:24 +00006514 posp->coladd = 0;
6515 else
6516 posp->coladd = n;
Bram Moolenaar0e34f622006-03-03 23:00:03 +00006517
Bram Moolenaar493c1782014-05-28 14:34:46 +02006518 if (curswantp != NULL)
6519 *curswantp = list_find_nr(l, i + 1, NULL); /* curswant */
6520
Bram Moolenaar0e34f622006-03-03 23:00:03 +00006521 return OK;
6522}
6523
6524/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525 * Get the length of an environment variable name.
6526 * Advance "arg" to the first character after the name.
6527 * Return 0 for error.
6528 */
6529 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01006530get_env_len(char_u **arg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006531{
6532 char_u *p;
6533 int len;
6534
6535 for (p = *arg; vim_isIDc(*p); ++p)
6536 ;
6537 if (p == *arg) /* no name found */
6538 return 0;
6539
6540 len = (int)(p - *arg);
6541 *arg = p;
6542 return len;
6543}
6544
6545/*
6546 * Get the length of the name of a function or internal variable.
6547 * "arg" is advanced to the first non-white character after the name.
6548 * Return 0 if something is wrong.
6549 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006550 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01006551get_id_len(char_u **arg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006552{
6553 char_u *p;
6554 int len;
6555
6556 /* Find the end of the name. */
6557 for (p = *arg; eval_isnamec(*p); ++p)
Bram Moolenaar9bbf63d2016-01-16 16:49:28 +01006558 {
6559 if (*p == ':')
6560 {
6561 /* "s:" is start of "s:var", but "n:" is not and can be used in
6562 * slice "[n:]". Also "xx:" is not a namespace. */
6563 len = (int)(p - *arg);
6564 if ((len == 1 && vim_strchr(NAMESPACE_CHAR, **arg) == NULL)
6565 || len > 1)
6566 break;
6567 }
6568 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569 if (p == *arg) /* no name found */
6570 return 0;
6571
6572 len = (int)(p - *arg);
6573 *arg = skipwhite(p);
6574
6575 return len;
6576}
6577
6578/*
Bram Moolenaara7043832005-01-21 11:56:39 +00006579 * Get the length of the name of a variable or function.
6580 * Only the name is recognized, does not handle ".key" or "[idx]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 * "arg" is advanced to the first non-white character after the name.
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00006582 * Return -1 if curly braces expansion failed.
6583 * Return 0 if something else is wrong.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006584 * If the name contains 'magic' {}'s, expand them and return the
6585 * expanded name in an allocated string via 'alias' - caller must free.
6586 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02006587 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01006588get_name_len(
6589 char_u **arg,
6590 char_u **alias,
6591 int evaluate,
6592 int verbose)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006593{
6594 int len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 char_u *p;
6596 char_u *expr_start;
6597 char_u *expr_end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006598
6599 *alias = NULL; /* default to no alias */
6600
6601 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
6602 && (*arg)[2] == (int)KE_SNR)
6603 {
6604 /* hard coded <SNR>, already translated */
6605 *arg += 3;
6606 return get_id_len(arg) + 3;
6607 }
6608 len = eval_fname_script(*arg);
6609 if (len > 0)
6610 {
6611 /* literal "<SID>", "s:" or "<SNR>" */
6612 *arg += len;
6613 }
6614
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615 /*
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006616 * Find the end of the name; check for {} construction.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00006618 p = find_name_end(*arg, &expr_start, &expr_end,
6619 len > 0 ? 0 : FNE_CHECK_START);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 if (expr_start != NULL)
6621 {
6622 char_u *temp_string;
6623
6624 if (!evaluate)
6625 {
6626 len += (int)(p - *arg);
6627 *arg = skipwhite(p);
6628 return len;
6629 }
6630
6631 /*
6632 * Include any <SID> etc in the expanded string:
6633 * Thus the -len here.
6634 */
6635 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
6636 if (temp_string == NULL)
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00006637 return -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006638 *alias = temp_string;
6639 *arg = skipwhite(p);
6640 return (int)STRLEN(temp_string);
6641 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006642
6643 len += get_id_len(arg);
Bram Moolenaar8309b052019-01-13 16:46:22 +01006644 // Only give an error when there is something, otherwise it will be
6645 // reported at a higher level.
6646 if (len == 0 && verbose && **arg != NUL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006647 semsg(_(e_invexpr2), *arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648
6649 return len;
6650}
6651
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006652/*
6653 * Find the end of a variable or function name, taking care of magic braces.
6654 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
6655 * start and end of the first magic braces item.
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00006656 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006657 * Return a pointer to just after the name. Equal to "arg" if there is no
6658 * valid name.
6659 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006660 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01006661find_name_end(
6662 char_u *arg,
6663 char_u **expr_start,
6664 char_u **expr_end,
6665 int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006666{
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006667 int mb_nest = 0;
6668 int br_nest = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 char_u *p;
Bram Moolenaar9bbf63d2016-01-16 16:49:28 +01006670 int len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006672 if (expr_start != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006674 *expr_start = NULL;
6675 *expr_end = NULL;
6676 }
6677
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00006678 /* Quick check for valid starting character. */
6679 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
6680 return arg;
6681
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006682 for (p = arg; *p != NUL
6683 && (eval_isnamec(*p)
Bram Moolenaare9a41262005-01-15 22:18:47 +00006684 || *p == '{'
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00006685 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006686 || mb_nest != 0
Bram Moolenaar91acfff2017-03-12 19:22:36 +01006687 || br_nest != 0); MB_PTR_ADV(p))
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006688 {
Bram Moolenaar8af24422005-08-08 22:06:28 +00006689 if (*p == '\'')
6690 {
6691 /* skip over 'string' to avoid counting [ and ] inside it. */
Bram Moolenaar91acfff2017-03-12 19:22:36 +01006692 for (p = p + 1; *p != NUL && *p != '\''; MB_PTR_ADV(p))
Bram Moolenaar8af24422005-08-08 22:06:28 +00006693 ;
6694 if (*p == NUL)
6695 break;
6696 }
6697 else if (*p == '"')
6698 {
6699 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
Bram Moolenaar91acfff2017-03-12 19:22:36 +01006700 for (p = p + 1; *p != NUL && *p != '"'; MB_PTR_ADV(p))
Bram Moolenaar8af24422005-08-08 22:06:28 +00006701 if (*p == '\\' && p[1] != NUL)
6702 ++p;
6703 if (*p == NUL)
6704 break;
6705 }
Bram Moolenaar9bbf63d2016-01-16 16:49:28 +01006706 else if (br_nest == 0 && mb_nest == 0 && *p == ':')
6707 {
6708 /* "s:" is start of "s:var", but "n:" is not and can be used in
Bram Moolenaar4119cf82016-01-17 14:59:01 +01006709 * slice "[n:]". Also "xx:" is not a namespace. But {ns}: is. */
Bram Moolenaar9bbf63d2016-01-16 16:49:28 +01006710 len = (int)(p - arg);
6711 if ((len == 1 && vim_strchr(NAMESPACE_CHAR, *arg) == NULL)
Bram Moolenaar4119cf82016-01-17 14:59:01 +01006712 || (len > 1 && p[-1] != '}'))
Bram Moolenaar9bbf63d2016-01-16 16:49:28 +01006713 break;
6714 }
Bram Moolenaar8af24422005-08-08 22:06:28 +00006715
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006716 if (mb_nest == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006718 if (*p == '[')
6719 ++br_nest;
6720 else if (*p == ']')
6721 --br_nest;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 }
Bram Moolenaar8af24422005-08-08 22:06:28 +00006723
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006724 if (br_nest == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006725 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006726 if (*p == '{')
6727 {
6728 mb_nest++;
6729 if (expr_start != NULL && *expr_start == NULL)
6730 *expr_start = p;
6731 }
6732 else if (*p == '}')
6733 {
6734 mb_nest--;
6735 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
6736 *expr_end = p;
6737 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006739 }
6740
6741 return p;
6742}
6743
6744/*
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00006745 * Expands out the 'magic' {}'s in a variable/function name.
6746 * Note that this can call itself recursively, to deal with
6747 * constructs like foo{bar}{baz}{bam}
6748 * The four pointer arguments point to "foo{expre}ss{ion}bar"
6749 * "in_start" ^
6750 * "expr_start" ^
6751 * "expr_end" ^
6752 * "in_end" ^
6753 *
6754 * Returns a new allocated string, which the caller must free.
6755 * Returns NULL for failure.
6756 */
6757 static char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01006758make_expanded_name(
6759 char_u *in_start,
6760 char_u *expr_start,
6761 char_u *expr_end,
6762 char_u *in_end)
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00006763{
6764 char_u c1;
6765 char_u *retval = NULL;
6766 char_u *temp_result;
6767 char_u *nextcmd = NULL;
6768
6769 if (expr_end == NULL || in_end == NULL)
6770 return NULL;
6771 *expr_start = NUL;
6772 *expr_end = NUL;
6773 c1 = *in_end;
6774 *in_end = NUL;
6775
Bram Moolenaar362e1a32006-03-06 23:29:24 +00006776 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00006777 if (temp_result != NULL && nextcmd == NULL)
6778 {
6779 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
6780 + (in_end - expr_end) + 1));
6781 if (retval != NULL)
6782 {
6783 STRCPY(retval, in_start);
6784 STRCAT(retval, temp_result);
6785 STRCAT(retval, expr_end + 1);
6786 }
6787 }
6788 vim_free(temp_result);
6789
6790 *in_end = c1; /* put char back for error messages */
6791 *expr_start = '{';
6792 *expr_end = '}';
6793
6794 if (retval != NULL)
6795 {
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00006796 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00006797 if (expr_start != NULL)
6798 {
6799 /* Further expansion! */
6800 temp_result = make_expanded_name(retval, expr_start,
6801 expr_end, temp_result);
6802 vim_free(retval);
6803 retval = temp_result;
6804 }
6805 }
6806
6807 return retval;
6808}
6809
6810/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811 * Return TRUE if character "c" can be used in a variable or function name.
Bram Moolenaare9a41262005-01-15 22:18:47 +00006812 * Does not include '{' or '}' for magic braces.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006814 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01006815eval_isnamec(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816{
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00006817 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
6818}
6819
6820/*
6821 * Return TRUE if character "c" can be used as the first character in a
6822 * variable or function name (excluding '{' and '}').
6823 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006824 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01006825eval_isnamec1(int c)
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00006826{
6827 return (ASCII_ISALPHA(c) || c == '_');
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828}
6829
6830/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831 * Set number v: variable to "val".
6832 */
6833 void
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02006834set_vim_var_nr(int idx, varnumber_T val)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835{
Bram Moolenaare9a41262005-01-15 22:18:47 +00006836 vimvars[idx].vv_nr = val;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837}
6838
6839/*
Bram Moolenaar19a09a12005-03-04 23:39:37 +00006840 * Get number v: variable value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02006842 varnumber_T
Bram Moolenaar7454a062016-01-30 15:14:10 +01006843get_vim_var_nr(int idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844{
Bram Moolenaare9a41262005-01-15 22:18:47 +00006845 return vimvars[idx].vv_nr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846}
6847
Bram Moolenaar19a09a12005-03-04 23:39:37 +00006848/*
6849 * Get string v: variable value. Uses a static buffer, can only be used once.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01006850 * If the String variable has never been set, return an empty string.
6851 * Never returns NULL;
Bram Moolenaar19a09a12005-03-04 23:39:37 +00006852 */
6853 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01006854get_vim_var_str(int idx)
Bram Moolenaar19a09a12005-03-04 23:39:37 +00006855{
Bram Moolenaard155d7a2018-12-21 16:04:21 +01006856 return tv_get_string(&vimvars[idx].vv_tv);
Bram Moolenaar19a09a12005-03-04 23:39:37 +00006857}
Bram Moolenaar19a09a12005-03-04 23:39:37 +00006858
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859/*
Bram Moolenaard812df62008-11-09 12:46:09 +00006860 * Get List v: variable value. Caller must take care of reference count when
6861 * needed.
6862 */
6863 list_T *
Bram Moolenaar7454a062016-01-30 15:14:10 +01006864get_vim_var_list(int idx)
Bram Moolenaard812df62008-11-09 12:46:09 +00006865{
6866 return vimvars[idx].vv_list;
6867}
6868
6869/*
Bram Moolenaar7e1652c2017-12-16 18:27:02 +01006870 * Get Dict v: variable value. Caller must take care of reference count when
6871 * needed.
6872 */
6873 dict_T *
6874get_vim_var_dict(int idx)
6875{
6876 return vimvars[idx].vv_dict;
6877}
6878
6879/*
Bram Moolenaarda9591e2009-09-30 13:17:02 +00006880 * Set v:char to character "c".
6881 */
6882 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01006883set_vim_var_char(int c)
Bram Moolenaarda9591e2009-09-30 13:17:02 +00006884{
Bram Moolenaar9a920d82012-06-01 15:21:02 +02006885 char_u buf[MB_MAXBYTES + 1];
Bram Moolenaarda9591e2009-09-30 13:17:02 +00006886
Bram Moolenaarda9591e2009-09-30 13:17:02 +00006887 if (has_mbyte)
6888 buf[(*mb_char2bytes)(c, buf)] = NUL;
6889 else
Bram Moolenaarda9591e2009-09-30 13:17:02 +00006890 {
6891 buf[0] = c;
6892 buf[1] = NUL;
6893 }
6894 set_vim_var_string(VV_CHAR, buf, -1);
6895}
6896
6897/*
Bram Moolenaar8df74be2008-11-20 15:12:02 +00006898 * Set v:count to "count" and v:count1 to "count1".
6899 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006900 */
6901 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01006902set_vcount(
6903 long count,
6904 long count1,
6905 int set_prevcount)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906{
Bram Moolenaar8df74be2008-11-20 15:12:02 +00006907 if (set_prevcount)
6908 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
Bram Moolenaare9a41262005-01-15 22:18:47 +00006909 vimvars[VV_COUNT].vv_nr = count;
6910 vimvars[VV_COUNT1].vv_nr = count1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911}
6912
6913/*
Bram Moolenaarb0f42ba2018-05-12 15:38:26 +02006914 * Save variables that might be changed as a side effect. Used when executing
6915 * a timer callback.
6916 */
6917 void
6918save_vimvars(vimvars_save_T *vvsave)
6919{
6920 vvsave->vv_prevcount = vimvars[VV_PREVCOUNT].vv_nr;
6921 vvsave->vv_count = vimvars[VV_COUNT].vv_nr;
6922 vvsave->vv_count1 = vimvars[VV_COUNT1].vv_nr;
6923}
6924
6925/*
6926 * Restore variables saved by save_vimvars().
6927 */
6928 void
6929restore_vimvars(vimvars_save_T *vvsave)
6930{
6931 vimvars[VV_PREVCOUNT].vv_nr = vvsave->vv_prevcount;
6932 vimvars[VV_COUNT].vv_nr = vvsave->vv_count;
6933 vimvars[VV_COUNT1].vv_nr = vvsave->vv_count1;
6934}
6935
6936/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006937 * Set string v: variable to a copy of "val".
6938 */
6939 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01006940set_vim_var_string(
6941 int idx,
6942 char_u *val,
6943 int len) /* length of "val" to use or -1 (whole string) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006944{
Bram Moolenaara542c682016-01-31 16:28:04 +01006945 clear_tv(&vimvars[idx].vv_di.di_tv);
6946 vimvars[idx].vv_type = VAR_STRING;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006947 if (val == NULL)
Bram Moolenaare9a41262005-01-15 22:18:47 +00006948 vimvars[idx].vv_str = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949 else if (len == -1)
Bram Moolenaare9a41262005-01-15 22:18:47 +00006950 vimvars[idx].vv_str = vim_strsave(val);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006951 else
Bram Moolenaare9a41262005-01-15 22:18:47 +00006952 vimvars[idx].vv_str = vim_strnsave(val, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006953}
6954
6955/*
Bram Moolenaard812df62008-11-09 12:46:09 +00006956 * Set List v: variable to "val".
6957 */
6958 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01006959set_vim_var_list(int idx, list_T *val)
Bram Moolenaard812df62008-11-09 12:46:09 +00006960{
Bram Moolenaara542c682016-01-31 16:28:04 +01006961 clear_tv(&vimvars[idx].vv_di.di_tv);
6962 vimvars[idx].vv_type = VAR_LIST;
Bram Moolenaard812df62008-11-09 12:46:09 +00006963 vimvars[idx].vv_list = val;
6964 if (val != NULL)
6965 ++val->lv_refcount;
6966}
6967
6968/*
Bram Moolenaar42a45122015-07-10 17:56:23 +02006969 * Set Dictionary v: variable to "val".
6970 */
6971 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01006972set_vim_var_dict(int idx, dict_T *val)
Bram Moolenaar42a45122015-07-10 17:56:23 +02006973{
Bram Moolenaara542c682016-01-31 16:28:04 +01006974 clear_tv(&vimvars[idx].vv_di.di_tv);
6975 vimvars[idx].vv_type = VAR_DICT;
Bram Moolenaar42a45122015-07-10 17:56:23 +02006976 vimvars[idx].vv_dict = val;
6977 if (val != NULL)
6978 {
6979 ++val->dv_refcount;
Bram Moolenaar7e1652c2017-12-16 18:27:02 +01006980 dict_set_items_ro(val);
Bram Moolenaar42a45122015-07-10 17:56:23 +02006981 }
6982}
6983
6984/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985 * Set v:register if needed.
6986 */
6987 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01006988set_reg_var(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989{
6990 char_u regname;
6991
6992 if (c == 0 || c == ' ')
6993 regname = '"';
6994 else
6995 regname = c;
6996 /* Avoid free/alloc when the value is already right. */
Bram Moolenaare9a41262005-01-15 22:18:47 +00006997 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006998 set_vim_var_string(VV_REG, &regname, 1);
6999}
7000
7001/*
7002 * Get or set v:exception. If "oldval" == NULL, return the current value.
7003 * Otherwise, restore the value to "oldval" and return NULL.
7004 * Must always be called in pairs to save and restore v:exception! Does not
7005 * take care of memory allocations.
7006 */
7007 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007008v_exception(char_u *oldval)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009{
7010 if (oldval == NULL)
Bram Moolenaare9a41262005-01-15 22:18:47 +00007011 return vimvars[VV_EXCEPTION].vv_str;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007012
Bram Moolenaare9a41262005-01-15 22:18:47 +00007013 vimvars[VV_EXCEPTION].vv_str = oldval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 return NULL;
7015}
7016
7017/*
7018 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
7019 * Otherwise, restore the value to "oldval" and return NULL.
7020 * Must always be called in pairs to save and restore v:throwpoint! Does not
7021 * take care of memory allocations.
7022 */
7023 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007024v_throwpoint(char_u *oldval)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007025{
7026 if (oldval == NULL)
Bram Moolenaare9a41262005-01-15 22:18:47 +00007027 return vimvars[VV_THROWPOINT].vv_str;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028
Bram Moolenaare9a41262005-01-15 22:18:47 +00007029 vimvars[VV_THROWPOINT].vv_str = oldval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 return NULL;
7031}
7032
Bram Moolenaar071d4272004-06-13 20:20:40 +00007033/*
7034 * Set v:cmdarg.
7035 * If "eap" != NULL, use "eap" to generate the value and return the old value.
7036 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
7037 * Must always be called in pairs!
7038 */
7039 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007040set_cmdarg(exarg_T *eap, char_u *oldarg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041{
7042 char_u *oldval;
7043 char_u *newval;
7044 unsigned len;
7045
Bram Moolenaare9a41262005-01-15 22:18:47 +00007046 oldval = vimvars[VV_CMDARG].vv_str;
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007047 if (eap == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048 {
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007049 vim_free(oldval);
Bram Moolenaare9a41262005-01-15 22:18:47 +00007050 vimvars[VV_CMDARG].vv_str = oldarg;
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007051 return NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007052 }
7053
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007054 if (eap->force_bin == FORCE_BIN)
7055 len = 6;
7056 else if (eap->force_bin == FORCE_NOBIN)
7057 len = 8;
7058 else
7059 len = 0;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007060
7061 if (eap->read_edit)
7062 len += 7;
7063
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007064 if (eap->force_ff != 0)
Bram Moolenaar333b80a2018-04-04 22:57:29 +02007065 len += 10; /* " ++ff=unix" */
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007066 if (eap->force_enc != 0)
7067 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
Bram Moolenaar34b4daf2010-05-16 13:26:25 +02007068 if (eap->bad_char != 0)
7069 len += 7 + 4; /* " ++bad=" + "keep" or "drop" */
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007070
7071 newval = alloc(len + 1);
7072 if (newval == NULL)
7073 return NULL;
7074
7075 if (eap->force_bin == FORCE_BIN)
7076 sprintf((char *)newval, " ++bin");
7077 else if (eap->force_bin == FORCE_NOBIN)
7078 sprintf((char *)newval, " ++nobin");
7079 else
7080 *newval = NUL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007081
7082 if (eap->read_edit)
7083 STRCAT(newval, " ++edit");
7084
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007085 if (eap->force_ff != 0)
7086 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
Bram Moolenaar333b80a2018-04-04 22:57:29 +02007087 eap->force_ff == 'u' ? "unix"
7088 : eap->force_ff == 'd' ? "dos"
7089 : "mac");
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007090 if (eap->force_enc != 0)
7091 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
7092 eap->cmd + eap->force_enc);
Bram Moolenaar34b4daf2010-05-16 13:26:25 +02007093 if (eap->bad_char == BAD_KEEP)
7094 STRCPY(newval + STRLEN(newval), " ++bad=keep");
7095 else if (eap->bad_char == BAD_DROP)
7096 STRCPY(newval + STRLEN(newval), " ++bad=drop");
7097 else if (eap->bad_char != 0)
7098 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
Bram Moolenaare9a41262005-01-15 22:18:47 +00007099 vimvars[VV_CMDARG].vv_str = newval;
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007100 return oldval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007101}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102
7103/*
7104 * Get the value of internal variable "name".
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01007105 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007106 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02007107 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01007108get_var_tv(
7109 char_u *name,
7110 int len, /* length of "name" */
7111 typval_T *rettv, /* NULL when only checking existence */
7112 dictitem_T **dip, /* non-NULL when typval's dict item is needed */
7113 int verbose, /* may give error message */
7114 int no_autoload) /* do not use script autoloading */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115{
7116 int ret = OK;
Bram Moolenaar33570922005-01-25 22:26:29 +00007117 typval_T *tv = NULL;
Bram Moolenaar33570922005-01-25 22:26:29 +00007118 dictitem_T *v;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119 int cc;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120
7121 /* truncate the name, so that we can use strcmp() */
7122 cc = name[len];
7123 name[len] = NUL;
7124
7125 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126 * Check for user-defined variables.
7127 */
Bram Moolenaar79518e22017-02-17 16:31:35 +01007128 v = find_var(name, NULL, no_autoload);
7129 if (v != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 {
Bram Moolenaar79518e22017-02-17 16:31:35 +01007131 tv = &v->di_tv;
7132 if (dip != NULL)
7133 *dip = v;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 }
7135
Bram Moolenaare9a41262005-01-15 22:18:47 +00007136 if (tv == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137 {
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00007138 if (rettv != NULL && verbose)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007139 semsg(_(e_undefvar), name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007140 ret = FAIL;
7141 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007142 else if (rettv != NULL)
Bram Moolenaare9a41262005-01-15 22:18:47 +00007143 copy_tv(tv, rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007144
7145 name[len] = cc;
7146
7147 return ret;
7148}
7149
7150/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02007151 * Check if variable "name[len]" is a local variable or an argument.
7152 * If so, "*eval_lavars_used" is set to TRUE.
7153 */
7154 static void
7155check_vars(char_u *name, int len)
7156{
7157 int cc;
7158 char_u *varname;
7159 hashtab_T *ht;
7160
7161 if (eval_lavars_used == NULL)
7162 return;
7163
7164 /* truncate the name, so that we can use strcmp() */
7165 cc = name[len];
7166 name[len] = NUL;
7167
7168 ht = find_var_ht(name, &varname);
7169 if (ht == get_funccal_local_ht() || ht == get_funccal_args_ht())
7170 {
7171 if (find_var(name, NULL, TRUE) != NULL)
7172 *eval_lavars_used = TRUE;
7173 }
7174
7175 name[len] = cc;
7176}
7177
7178/*
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00007179 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
7180 * Also handle function call with Funcref variable: func(expr)
7181 * Can all be combined: dict.func(expr)[idx]['func'](expr)
7182 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007183 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01007184handle_subscript(
7185 char_u **arg,
7186 typval_T *rettv,
7187 int evaluate, /* do more than finding the end */
7188 int verbose) /* give error messages */
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00007189{
7190 int ret = OK;
7191 dict_T *selfdict = NULL;
7192 char_u *s;
7193 int len;
Bram Moolenaard9fba312005-06-26 22:34:35 +00007194 typval_T functv;
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00007195
7196 while (ret == OK
7197 && (**arg == '['
7198 || (**arg == '.' && rettv->v_type == VAR_DICT)
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007199 || (**arg == '(' && (!evaluate || rettv->v_type == VAR_FUNC
7200 || rettv->v_type == VAR_PARTIAL)))
Bram Moolenaar1c465442017-03-12 20:10:05 +01007201 && !VIM_ISWHITE(*(*arg - 1)))
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00007202 {
7203 if (**arg == '(')
7204 {
Bram Moolenaar3f242a82016-03-18 19:39:25 +01007205 partial_T *pt = NULL;
7206
Bram Moolenaard9fba312005-06-26 22:34:35 +00007207 /* need to copy the funcref so that we can clear rettv */
Bram Moolenaar0f8de8d2013-11-11 04:25:53 +01007208 if (evaluate)
7209 {
7210 functv = *rettv;
7211 rettv->v_type = VAR_UNKNOWN;
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00007212
Bram Moolenaar0f8de8d2013-11-11 04:25:53 +01007213 /* Invoke the function. Recursive! */
Bram Moolenaarab1fa392016-03-15 19:33:34 +01007214 if (functv.v_type == VAR_PARTIAL)
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007215 {
7216 pt = functv.vval.v_partial;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02007217 s = partial_name(pt);
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007218 }
7219 else
7220 s = functv.vval.v_string;
Bram Moolenaar0f8de8d2013-11-11 04:25:53 +01007221 }
7222 else
7223 s = (char_u *)"";
Bram Moolenaar6ed88192019-05-11 18:37:44 +02007224 ret = get_func_tv(s, -1, rettv, arg,
Bram Moolenaard9fba312005-06-26 22:34:35 +00007225 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007226 &len, evaluate, pt, selfdict);
Bram Moolenaard9fba312005-06-26 22:34:35 +00007227
7228 /* Clear the funcref afterwards, so that deleting it while
7229 * evaluating the arguments is possible (see test55). */
Bram Moolenaar0f8de8d2013-11-11 04:25:53 +01007230 if (evaluate)
7231 clear_tv(&functv);
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00007232
7233 /* Stop the expression evaluation when immediately aborting on
7234 * error, or when an interrupt occurred or an exception was thrown
7235 * but not caught. */
7236 if (aborting())
7237 {
7238 if (ret == OK)
7239 clear_tv(rettv);
7240 ret = FAIL;
7241 }
7242 dict_unref(selfdict);
7243 selfdict = NULL;
7244 }
7245 else /* **arg == '[' || **arg == '.' */
7246 {
7247 dict_unref(selfdict);
7248 if (rettv->v_type == VAR_DICT)
7249 {
7250 selfdict = rettv->vval.v_dict;
7251 if (selfdict != NULL)
7252 ++selfdict->dv_refcount;
7253 }
7254 else
7255 selfdict = NULL;
7256 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
7257 {
7258 clear_tv(rettv);
7259 ret = FAIL;
7260 }
7261 }
7262 }
Bram Moolenaarab1fa392016-03-15 19:33:34 +01007263
Bram Moolenaar1d429612016-05-24 15:44:17 +02007264 /* Turn "dict.Func" into a partial for "Func" bound to "dict".
7265 * Don't do this when "Func" is already a partial that was bound
7266 * explicitly (pt_auto is FALSE). */
7267 if (selfdict != NULL
7268 && (rettv->v_type == VAR_FUNC
7269 || (rettv->v_type == VAR_PARTIAL
7270 && (rettv->vval.v_partial->pt_auto
7271 || rettv->vval.v_partial->pt_dict == NULL))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007272 selfdict = make_partial(selfdict, rettv);
Bram Moolenaarab1fa392016-03-15 19:33:34 +01007273
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00007274 dict_unref(selfdict);
7275 return ret;
7276}
7277
7278/*
Bram Moolenaar8c8de832008-06-24 22:58:06 +00007279 * Allocate memory for a variable type-value, and make it empty (0 or NULL
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007280 * value).
7281 */
Bram Moolenaar11e0afa2016-02-01 22:41:00 +01007282 typval_T *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007283alloc_tv(void)
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007284{
Bram Moolenaar33570922005-01-25 22:26:29 +00007285 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007286}
7287
7288/*
7289 * Allocate memory for a variable type-value, and assign a string to it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007290 * The string "s" must have been allocated, it is consumed.
7291 * Return NULL for out of memory, the variable otherwise.
7292 */
Bram Moolenaar33570922005-01-25 22:26:29 +00007293 static typval_T *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007294alloc_string_tv(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007295{
Bram Moolenaar33570922005-01-25 22:26:29 +00007296 typval_T *rettv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007297
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007298 rettv = alloc_tv();
7299 if (rettv != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007301 rettv->v_type = VAR_STRING;
7302 rettv->vval.v_string = s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007303 }
7304 else
7305 vim_free(s);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007306 return rettv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007307}
7308
7309/*
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007310 * Free the memory for a variable type-value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007311 */
Bram Moolenaar4770d092006-01-12 23:22:24 +00007312 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007313free_tv(typval_T *varp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007314{
7315 if (varp != NULL)
7316 {
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007317 switch (varp->v_type)
7318 {
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007319 case VAR_FUNC:
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00007320 func_unref(varp->vval.v_string);
Bram Moolenaar2f40d122017-10-24 21:49:36 +02007321 /* FALLTHROUGH */
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00007322 case VAR_STRING:
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007323 vim_free(varp->vval.v_string);
7324 break;
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007325 case VAR_PARTIAL:
7326 partial_unref(varp->vval.v_partial);
7327 break;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007328 case VAR_BLOB:
7329 blob_unref(varp->vval.v_blob);
7330 break;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007331 case VAR_LIST:
7332 list_unref(varp->vval.v_list);
7333 break;
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00007334 case VAR_DICT:
7335 dict_unref(varp->vval.v_dict);
7336 break;
Bram Moolenaar835dc632016-02-07 14:27:38 +01007337 case VAR_JOB:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007338#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar835dc632016-02-07 14:27:38 +01007339 job_unref(varp->vval.v_job);
7340 break;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00007341#endif
Bram Moolenaar77073442016-02-13 23:23:53 +01007342 case VAR_CHANNEL:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007343#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar77073442016-02-13 23:23:53 +01007344 channel_unref(varp->vval.v_channel);
7345 break;
7346#endif
Bram Moolenaar835dc632016-02-07 14:27:38 +01007347 case VAR_NUMBER:
7348 case VAR_FLOAT:
Bram Moolenaar758711c2005-02-02 23:11:38 +00007349 case VAR_UNKNOWN:
Bram Moolenaar6650a692016-01-26 19:59:10 +01007350 case VAR_SPECIAL:
Bram Moolenaar758711c2005-02-02 23:11:38 +00007351 break;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007352 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007353 vim_free(varp);
7354 }
7355}
7356
7357/*
7358 * Free the memory for a variable value and set the value to NULL or 0.
7359 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00007360 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007361clear_tv(typval_T *varp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007362{
7363 if (varp != NULL)
7364 {
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007365 switch (varp->v_type)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366 {
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007367 case VAR_FUNC:
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00007368 func_unref(varp->vval.v_string);
Bram Moolenaar2f40d122017-10-24 21:49:36 +02007369 /* FALLTHROUGH */
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00007370 case VAR_STRING:
Bram Moolenaard23a8232018-02-10 18:45:26 +01007371 VIM_CLEAR(varp->vval.v_string);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007372 break;
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007373 case VAR_PARTIAL:
7374 partial_unref(varp->vval.v_partial);
7375 varp->vval.v_partial = NULL;
7376 break;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007377 case VAR_BLOB:
7378 blob_unref(varp->vval.v_blob);
7379 varp->vval.v_blob = NULL;
7380 break;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007381 case VAR_LIST:
7382 list_unref(varp->vval.v_list);
Bram Moolenaarce5e58e2005-01-19 22:24:34 +00007383 varp->vval.v_list = NULL;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007384 break;
Bram Moolenaar8c711452005-01-14 21:53:12 +00007385 case VAR_DICT:
7386 dict_unref(varp->vval.v_dict);
Bram Moolenaarce5e58e2005-01-19 22:24:34 +00007387 varp->vval.v_dict = NULL;
Bram Moolenaar8c711452005-01-14 21:53:12 +00007388 break;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007389 case VAR_NUMBER:
Bram Moolenaar520e1e42016-01-23 19:46:28 +01007390 case VAR_SPECIAL:
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007391 varp->vval.v_number = 0;
7392 break;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00007393 case VAR_FLOAT:
Bram Moolenaar835dc632016-02-07 14:27:38 +01007394#ifdef FEAT_FLOAT
Bram Moolenaar8c8de832008-06-24 22:58:06 +00007395 varp->vval.v_float = 0.0;
7396 break;
7397#endif
Bram Moolenaar835dc632016-02-07 14:27:38 +01007398 case VAR_JOB:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007399#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar835dc632016-02-07 14:27:38 +01007400 job_unref(varp->vval.v_job);
7401 varp->vval.v_job = NULL;
7402#endif
7403 break;
Bram Moolenaar77073442016-02-13 23:23:53 +01007404 case VAR_CHANNEL:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007405#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar77073442016-02-13 23:23:53 +01007406 channel_unref(varp->vval.v_channel);
7407 varp->vval.v_channel = NULL;
7408#endif
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007409 case VAR_UNKNOWN:
7410 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007411 }
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00007412 varp->v_lock = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413 }
7414}
7415
7416/*
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007417 * Set the value of a variable to NULL without freeing items.
7418 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02007419 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007420init_tv(typval_T *varp)
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007421{
7422 if (varp != NULL)
Bram Moolenaar33570922005-01-25 22:26:29 +00007423 vim_memset(varp, 0, sizeof(typval_T));
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007424}
7425
7426/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007427 * Get the number value of a variable.
7428 * If it is a String variable, uses vim_str2nr().
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007429 * For incompatible types, return 0.
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007430 * tv_get_number_chk() is similar to tv_get_number(), but informs the
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007431 * caller of incompatible types: it sets *denote to TRUE if "denote"
7432 * is not NULL or returns -1 otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007433 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02007434 varnumber_T
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007435tv_get_number(typval_T *varp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436{
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007437 int error = FALSE;
7438
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007439 return tv_get_number_chk(varp, &error); /* return 0L on error */
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007440}
7441
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02007442 varnumber_T
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007443tv_get_number_chk(typval_T *varp, int *denote)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007444{
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02007445 varnumber_T n = 0L;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007447 switch (varp->v_type)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007448 {
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007449 case VAR_NUMBER:
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02007450 return varp->vval.v_number;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00007451 case VAR_FLOAT:
Bram Moolenaar835dc632016-02-07 14:27:38 +01007452#ifdef FEAT_FLOAT
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007453 emsg(_("E805: Using a Float as a Number"));
Bram Moolenaar8c8de832008-06-24 22:58:06 +00007454 break;
7455#endif
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007456 case VAR_FUNC:
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007457 case VAR_PARTIAL:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007458 emsg(_("E703: Using a Funcref as a Number"));
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007459 break;
7460 case VAR_STRING:
7461 if (varp->vval.v_string != NULL)
7462 vim_str2nr(varp->vval.v_string, NULL, NULL,
Bram Moolenaar887c1fe2016-01-02 17:56:35 +01007463 STR2NR_ALL, &n, NULL, 0);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007464 return n;
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00007465 case VAR_LIST:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007466 emsg(_("E745: Using a List as a Number"));
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00007467 break;
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00007468 case VAR_DICT:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007469 emsg(_("E728: Using a Dictionary as a Number"));
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00007470 break;
Bram Moolenaar17a13432016-01-24 14:22:10 +01007471 case VAR_SPECIAL:
7472 return varp->vval.v_number == VVAL_TRUE ? 1 : 0;
7473 break;
Bram Moolenaar835dc632016-02-07 14:27:38 +01007474 case VAR_JOB:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007475#ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007476 emsg(_("E910: Using a Job as a Number"));
Bram Moolenaar835dc632016-02-07 14:27:38 +01007477 break;
7478#endif
Bram Moolenaar77073442016-02-13 23:23:53 +01007479 case VAR_CHANNEL:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007480#ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007481 emsg(_("E913: Using a Channel as a Number"));
Bram Moolenaar77073442016-02-13 23:23:53 +01007482 break;
7483#endif
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007484 case VAR_BLOB:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007485 emsg(_("E974: Using a Blob as a Number"));
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007486 break;
Bram Moolenaara03f2332016-02-06 18:09:59 +01007487 case VAR_UNKNOWN:
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007488 internal_error("tv_get_number(UNKNOWN)");
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007489 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490 }
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007491 if (denote == NULL) /* useful for values that must be unsigned */
7492 n = -1;
7493 else
7494 *denote = TRUE;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007495 return n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496}
7497
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007498#ifdef FEAT_FLOAT
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02007499 float_T
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007500tv_get_float(typval_T *varp)
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007501{
7502 switch (varp->v_type)
7503 {
7504 case VAR_NUMBER:
7505 return (float_T)(varp->vval.v_number);
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007506 case VAR_FLOAT:
7507 return varp->vval.v_float;
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007508 case VAR_FUNC:
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007509 case VAR_PARTIAL:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007510 emsg(_("E891: Using a Funcref as a Float"));
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007511 break;
7512 case VAR_STRING:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007513 emsg(_("E892: Using a String as a Float"));
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007514 break;
7515 case VAR_LIST:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007516 emsg(_("E893: Using a List as a Float"));
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007517 break;
7518 case VAR_DICT:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007519 emsg(_("E894: Using a Dictionary as a Float"));
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007520 break;
Bram Moolenaara03f2332016-02-06 18:09:59 +01007521 case VAR_SPECIAL:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007522 emsg(_("E907: Using a special value as a Float"));
Bram Moolenaara03f2332016-02-06 18:09:59 +01007523 break;
Bram Moolenaar835dc632016-02-07 14:27:38 +01007524 case VAR_JOB:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007525# ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007526 emsg(_("E911: Using a Job as a Float"));
Bram Moolenaar835dc632016-02-07 14:27:38 +01007527 break;
7528# endif
Bram Moolenaar77073442016-02-13 23:23:53 +01007529 case VAR_CHANNEL:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007530# ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007531 emsg(_("E914: Using a Channel as a Float"));
Bram Moolenaar77073442016-02-13 23:23:53 +01007532 break;
7533# endif
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007534 case VAR_BLOB:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007535 emsg(_("E975: Using a Blob as a Float"));
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007536 break;
Bram Moolenaara03f2332016-02-06 18:09:59 +01007537 case VAR_UNKNOWN:
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007538 internal_error("tv_get_float(UNKNOWN)");
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007539 break;
7540 }
7541 return 0;
7542}
7543#endif
7544
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546 * Get the string value of a variable.
7547 * If it is a Number variable, the number is converted into a string.
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007548 * tv_get_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
7549 * tv_get_string_buf() uses a given buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007550 * If the String variable has never been set, return an empty string.
7551 * Never returns NULL;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007552 * tv_get_string_chk() and tv_get_string_buf_chk() are similar, but return
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007553 * NULL on error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 */
Bram Moolenaar8e2c9422016-03-12 13:43:33 +01007555 char_u *
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007556tv_get_string(typval_T *varp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557{
7558 static char_u mybuf[NUMBUFLEN];
7559
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007560 return tv_get_string_buf(varp, mybuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007561}
7562
Bram Moolenaar8e2c9422016-03-12 13:43:33 +01007563 char_u *
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007564tv_get_string_buf(typval_T *varp, char_u *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007565{
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007566 char_u *res = tv_get_string_buf_chk(varp, buf);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007567
7568 return res != NULL ? res : (char_u *)"";
7569}
7570
Bram Moolenaar7d647822014-04-05 21:28:56 +02007571/*
7572 * Careful: This uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
7573 */
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007574 char_u *
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007575tv_get_string_chk(typval_T *varp)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007576{
7577 static char_u mybuf[NUMBUFLEN];
7578
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007579 return tv_get_string_buf_chk(varp, mybuf);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007580}
7581
Bram Moolenaar520e1e42016-01-23 19:46:28 +01007582 char_u *
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007583tv_get_string_buf_chk(typval_T *varp, char_u *buf)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007584{
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007585 switch (varp->v_type)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 {
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007587 case VAR_NUMBER:
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02007588 vim_snprintf((char *)buf, NUMBUFLEN, "%lld",
Bram Moolenaar88c86eb2019-01-17 17:13:30 +01007589 (long_long_T)varp->vval.v_number);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007590 return buf;
7591 case VAR_FUNC:
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007592 case VAR_PARTIAL:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007593 emsg(_("E729: using Funcref as a String"));
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007594 break;
7595 case VAR_LIST:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007596 emsg(_("E730: using List as a String"));
Bram Moolenaar8c711452005-01-14 21:53:12 +00007597 break;
7598 case VAR_DICT:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007599 emsg(_("E731: using Dictionary as a String"));
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007600 break;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00007601 case VAR_FLOAT:
Bram Moolenaar835dc632016-02-07 14:27:38 +01007602#ifdef FEAT_FLOAT
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007603 emsg(_(e_float_as_string));
Bram Moolenaar8c8de832008-06-24 22:58:06 +00007604 break;
7605#endif
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007606 case VAR_STRING:
7607 if (varp->vval.v_string != NULL)
7608 return varp->vval.v_string;
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007609 return (char_u *)"";
Bram Moolenaar17a13432016-01-24 14:22:10 +01007610 case VAR_SPECIAL:
7611 STRCPY(buf, get_var_special_name(varp->vval.v_number));
7612 return buf;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007613 case VAR_BLOB:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007614 emsg(_("E976: using Blob as a String"));
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007615 break;
Bram Moolenaar835dc632016-02-07 14:27:38 +01007616 case VAR_JOB:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007617#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar835dc632016-02-07 14:27:38 +01007618 {
7619 job_T *job = varp->vval.v_job;
Bram Moolenaar839fd112016-03-06 21:34:03 +01007620 char *status;
7621
7622 if (job == NULL)
7623 return (char_u *)"no process";
7624 status = job->jv_status == JOB_FAILED ? "fail"
Bram Moolenaar7df915d2016-11-17 17:25:32 +01007625 : job->jv_status >= JOB_ENDED ? "dead"
Bram Moolenaar835dc632016-02-07 14:27:38 +01007626 : "run";
7627# ifdef UNIX
7628 vim_snprintf((char *)buf, NUMBUFLEN,
7629 "process %ld %s", (long)job->jv_pid, status);
Bram Moolenaar4f974752019-02-17 17:44:42 +01007630# elif defined(MSWIN)
Bram Moolenaar4d8747c2016-02-09 20:39:26 +01007631 vim_snprintf((char *)buf, NUMBUFLEN,
Bram Moolenaar76467df2016-02-12 19:30:26 +01007632 "process %ld %s",
7633 (long)job->jv_proc_info.dwProcessId,
Bram Moolenaar4d8747c2016-02-09 20:39:26 +01007634 status);
Bram Moolenaar835dc632016-02-07 14:27:38 +01007635# else
Bram Moolenaar4d8747c2016-02-09 20:39:26 +01007636 /* fall-back */
Bram Moolenaar835dc632016-02-07 14:27:38 +01007637 vim_snprintf((char *)buf, NUMBUFLEN, "process ? %s", status);
7638# endif
7639 return buf;
7640 }
7641#endif
7642 break;
Bram Moolenaar77073442016-02-13 23:23:53 +01007643 case VAR_CHANNEL:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007644#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar77073442016-02-13 23:23:53 +01007645 {
7646 channel_T *channel = varp->vval.v_channel;
Bram Moolenaar0e77b762016-09-26 22:58:58 +02007647 char *status = channel_status(channel, -1);
Bram Moolenaar77073442016-02-13 23:23:53 +01007648
Bram Moolenaar5cefd402016-02-16 12:44:26 +01007649 if (channel == NULL)
7650 vim_snprintf((char *)buf, NUMBUFLEN, "channel %s", status);
7651 else
7652 vim_snprintf((char *)buf, NUMBUFLEN,
Bram Moolenaar77073442016-02-13 23:23:53 +01007653 "channel %d %s", channel->ch_id, status);
7654 return buf;
7655 }
7656#endif
7657 break;
Bram Moolenaara03f2332016-02-06 18:09:59 +01007658 case VAR_UNKNOWN:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007659 emsg(_("E908: using an invalid value as a String"));
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007660 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007661 }
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007662 return NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007663}
7664
7665/*
Bram Moolenaar461a7fc2018-12-22 13:28:07 +01007666 * Turn a typeval into a string. Similar to tv_get_string_buf() but uses
7667 * string() on Dict, List, etc.
7668 */
7669 char_u *
7670tv_stringify(typval_T *varp, char_u *buf)
7671{
7672 if (varp->v_type == VAR_LIST
7673 || varp->v_type == VAR_DICT
7674 || varp->v_type == VAR_FUNC
7675 || varp->v_type == VAR_PARTIAL
7676 || varp->v_type == VAR_FLOAT)
7677 {
7678 typval_T tmp;
7679
7680 f_string(varp, &tmp);
7681 tv_get_string_buf(&tmp, buf);
7682 clear_tv(varp);
7683 *varp = tmp;
7684 return tmp.vval.v_string;
7685 }
7686 return tv_get_string_buf(varp, buf);
7687}
7688
7689/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690 * Find variable "name" in the list of variables.
7691 * Return a pointer to it if found, NULL if not found.
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007692 * Careful: "a:0" variables don't have a name.
Bram Moolenaara7043832005-01-21 11:56:39 +00007693 * When "htp" is not NULL we are writing to the variable, set "htp" to the
Bram Moolenaar33570922005-01-25 22:26:29 +00007694 * hashtab_T used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007695 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007696 dictitem_T *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007697find_var(char_u *name, hashtab_T **htp, int no_autoload)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007698{
Bram Moolenaar071d4272004-06-13 20:20:40 +00007699 char_u *varname;
Bram Moolenaar33570922005-01-25 22:26:29 +00007700 hashtab_T *ht;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02007701 dictitem_T *ret = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007702
Bram Moolenaara7043832005-01-21 11:56:39 +00007703 ht = find_var_ht(name, &varname);
7704 if (htp != NULL)
7705 *htp = ht;
7706 if (ht == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007707 return NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02007708 ret = find_var_in_ht(ht, *name, varname, no_autoload || htp != NULL);
7709 if (ret != NULL)
7710 return ret;
7711
7712 /* Search in parent scope for lambda */
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02007713 return find_var_in_scoped_ht(name, no_autoload || htp != NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007714}
7715
7716/*
Bram Moolenaar332ac062013-04-15 13:06:21 +02007717 * Find variable "varname" in hashtab "ht" with name "htname".
Bram Moolenaara7043832005-01-21 11:56:39 +00007718 * Returns NULL if not found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02007720 dictitem_T *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007721find_var_in_ht(
7722 hashtab_T *ht,
7723 int htname,
7724 char_u *varname,
7725 int no_autoload)
Bram Moolenaara7043832005-01-21 11:56:39 +00007726{
Bram Moolenaar33570922005-01-25 22:26:29 +00007727 hashitem_T *hi;
7728
7729 if (*varname == NUL)
7730 {
7731 /* Must be something like "s:", otherwise "ht" would be NULL. */
Bram Moolenaar332ac062013-04-15 13:06:21 +02007732 switch (htname)
Bram Moolenaar33570922005-01-25 22:26:29 +00007733 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02007734 case 's': return &SCRIPT_SV(current_sctx.sc_sid)->sv_var;
Bram Moolenaar33570922005-01-25 22:26:29 +00007735 case 'g': return &globvars_var;
7736 case 'v': return &vimvars_var;
7737 case 'b': return &curbuf->b_bufvar;
7738 case 'w': return &curwin->w_winvar;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007739 case 't': return &curtab->tp_winvar;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007740 case 'l': return get_funccal_local_var();
7741 case 'a': return get_funccal_args_var();
Bram Moolenaar33570922005-01-25 22:26:29 +00007742 }
7743 return NULL;
7744 }
Bram Moolenaara7043832005-01-21 11:56:39 +00007745
7746 hi = hash_find(ht, varname);
7747 if (HASHITEM_EMPTY(hi))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00007748 {
7749 /* For global variables we may try auto-loading the script. If it
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00007750 * worked find the variable again. Don't auto-load a script if it was
7751 * loaded already, otherwise it would be loaded every time when
7752 * checking if a function name is a Funcref variable. */
Bram Moolenaar6d977d62014-01-14 15:24:39 +01007753 if (ht == &globvarht && !no_autoload)
Bram Moolenaar8000baf2011-11-30 15:19:28 +01007754 {
7755 /* Note: script_autoload() may make "hi" invalid. It must either
7756 * be obtained again or not used. */
7757 if (!script_autoload(varname, FALSE) || aborting())
7758 return NULL;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00007759 hi = hash_find(ht, varname);
Bram Moolenaar8000baf2011-11-30 15:19:28 +01007760 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00007761 if (HASHITEM_EMPTY(hi))
7762 return NULL;
7763 }
Bram Moolenaar33570922005-01-25 22:26:29 +00007764 return HI2DI(hi);
Bram Moolenaara7043832005-01-21 11:56:39 +00007765}
7766
7767/*
Bram Moolenaar33570922005-01-25 22:26:29 +00007768 * Find the hashtab used for a variable name.
Bram Moolenaar73627d02015-08-11 15:46:09 +02007769 * Return NULL if the name is not valid.
Bram Moolenaara7043832005-01-21 11:56:39 +00007770 * Set "varname" to the start of name without ':'.
7771 */
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02007772 hashtab_T *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007773find_var_ht(char_u *name, char_u **varname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007774{
Bram Moolenaar75c50c42005-06-04 22:06:24 +00007775 hashitem_T *hi;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007776 hashtab_T *ht;
Bram Moolenaar75c50c42005-06-04 22:06:24 +00007777
Bram Moolenaar73627d02015-08-11 15:46:09 +02007778 if (name[0] == NUL)
7779 return NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007780 if (name[1] != ':')
7781 {
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00007782 /* The name must not start with a colon or #. */
7783 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007784 return NULL;
7785 *varname = name;
Bram Moolenaar532c7802005-01-27 14:44:31 +00007786
Bram Moolenaard2e716e2019-04-20 14:39:52 +02007787 // "version" is "v:version" in all scopes if scriptversion < 3.
7788 // Same for a few other variables marked with VV_COMPAT.
7789 if (current_sctx.sc_version < 3)
7790 {
7791 hi = hash_find(&compat_hashtab, name);
7792 if (!HASHITEM_EMPTY(hi))
7793 return &compat_hashtab;
7794 }
Bram Moolenaar532c7802005-01-27 14:44:31 +00007795
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007796 ht = get_funccal_local_ht();
7797 if (ht == NULL)
Bram Moolenaar33570922005-01-25 22:26:29 +00007798 return &globvarht; /* global variable */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007799 return ht; /* local variable */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007800 }
7801 *varname = name + 2;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00007802 if (*name == 'g') /* global variable */
7803 return &globvarht;
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00007804 /* There must be no ':' or '#' in the rest of the name, unless g: is used
7805 */
7806 if (vim_strchr(name + 2, ':') != NULL
7807 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00007808 return NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809 if (*name == 'b') /* buffer variable */
Bram Moolenaar429fa852013-04-15 12:27:36 +02007810 return &curbuf->b_vars->dv_hashtab;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007811 if (*name == 'w') /* window variable */
Bram Moolenaar429fa852013-04-15 12:27:36 +02007812 return &curwin->w_vars->dv_hashtab;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007813 if (*name == 't') /* tab page variable */
Bram Moolenaar429fa852013-04-15 12:27:36 +02007814 return &curtab->tp_vars->dv_hashtab;
Bram Moolenaar33570922005-01-25 22:26:29 +00007815 if (*name == 'v') /* v: variable */
7816 return &vimvarht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007817 if (*name == 'a') /* a: function argument */
7818 return get_funccal_args_ht();
7819 if (*name == 'l') /* l: local function variable */
7820 return get_funccal_local_ht();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821 if (*name == 's' /* script variable */
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02007822 && current_sctx.sc_sid > 0 && current_sctx.sc_sid <= ga_scripts.ga_len)
7823 return &SCRIPT_VARS(current_sctx.sc_sid);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007824 return NULL;
7825}
7826
7827/*
7828 * Get the string value of a (global/local) variable.
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007829 * Note: see tv_get_string() for how long the pointer remains valid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007830 * Returns NULL when it doesn't exist.
7831 */
7832 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007833get_var_value(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007834{
Bram Moolenaar33570922005-01-25 22:26:29 +00007835 dictitem_T *v;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007836
Bram Moolenaar6d977d62014-01-14 15:24:39 +01007837 v = find_var(name, NULL, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007838 if (v == NULL)
7839 return NULL;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007840 return tv_get_string(&v->di_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007841}
7842
7843/*
Bram Moolenaar33570922005-01-25 22:26:29 +00007844 * Allocate a new hashtab for a sourced script. It will be used while
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 * sourcing this script and when executing functions defined in the script.
7846 */
7847 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007848new_script_vars(scid_T id)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007849{
Bram Moolenaara7043832005-01-21 11:56:39 +00007850 int i;
Bram Moolenaar33570922005-01-25 22:26:29 +00007851 hashtab_T *ht;
7852 scriptvar_T *sv;
Bram Moolenaara7043832005-01-21 11:56:39 +00007853
Bram Moolenaar071d4272004-06-13 20:20:40 +00007854 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
7855 {
Bram Moolenaara7043832005-01-21 11:56:39 +00007856 /* Re-allocating ga_data means that an ht_array pointing to
7857 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
Bram Moolenaar33570922005-01-25 22:26:29 +00007858 * at its init value. Also reset "v_dict", it's always the same. */
Bram Moolenaara7043832005-01-21 11:56:39 +00007859 for (i = 1; i <= ga_scripts.ga_len; ++i)
7860 {
7861 ht = &SCRIPT_VARS(i);
7862 if (ht->ht_mask == HT_INIT_SIZE - 1)
7863 ht->ht_array = ht->ht_smallarray;
Bram Moolenaar9577c3e2010-05-14 12:16:25 +02007864 sv = SCRIPT_SV(i);
Bram Moolenaar33570922005-01-25 22:26:29 +00007865 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
Bram Moolenaara7043832005-01-21 11:56:39 +00007866 }
7867
Bram Moolenaar071d4272004-06-13 20:20:40 +00007868 while (ga_scripts.ga_len < id)
7869 {
Bram Moolenaar2c704a72010-06-03 21:17:25 +02007870 sv = SCRIPT_SV(ga_scripts.ga_len + 1) =
Bram Moolenaar9577c3e2010-05-14 12:16:25 +02007871 (scriptvar_T *)alloc_clear(sizeof(scriptvar_T));
Bram Moolenaarbdb62052012-07-16 17:31:53 +02007872 init_var_dict(&sv->sv_dict, &sv->sv_var, VAR_SCOPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873 ++ga_scripts.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007874 }
7875 }
7876}
7877
7878/*
Bram Moolenaar33570922005-01-25 22:26:29 +00007879 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
7880 * point to it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007881 */
7882 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007883init_var_dict(dict_T *dict, dictitem_T *dict_var, int scope)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884{
Bram Moolenaar33570922005-01-25 22:26:29 +00007885 hash_init(&dict->dv_hashtab);
Bram Moolenaared465602012-06-20 14:13:06 +02007886 dict->dv_lock = 0;
Bram Moolenaarbdb62052012-07-16 17:31:53 +02007887 dict->dv_scope = scope;
Bram Moolenaar8ba1bd22008-12-23 22:52:58 +00007888 dict->dv_refcount = DO_NOT_FREE_CNT;
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00007889 dict->dv_copyID = 0;
Bram Moolenaar33570922005-01-25 22:26:29 +00007890 dict_var->di_tv.vval.v_dict = dict;
7891 dict_var->di_tv.v_type = VAR_DICT;
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00007892 dict_var->di_tv.v_lock = VAR_FIXED;
Bram Moolenaar33570922005-01-25 22:26:29 +00007893 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
7894 dict_var->di_key[0] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007895}
7896
7897/*
Bram Moolenaar429fa852013-04-15 12:27:36 +02007898 * Unreference a dictionary initialized by init_var_dict().
7899 */
7900 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007901unref_var_dict(dict_T *dict)
Bram Moolenaar429fa852013-04-15 12:27:36 +02007902{
7903 /* Now the dict needs to be freed if no one else is using it, go back to
7904 * normal reference counting. */
7905 dict->dv_refcount -= DO_NOT_FREE_CNT - 1;
7906 dict_unref(dict);
7907}
7908
7909/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007910 * Clean up a list of internal variables.
Bram Moolenaar33570922005-01-25 22:26:29 +00007911 * Frees all allocated variables and the value they contain.
7912 * Clears hashtab "ht", does not free it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 */
7914 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007915vars_clear(hashtab_T *ht)
Bram Moolenaar33570922005-01-25 22:26:29 +00007916{
7917 vars_clear_ext(ht, TRUE);
7918}
7919
7920/*
7921 * Like vars_clear(), but only free the value if "free_val" is TRUE.
7922 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007923 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007924vars_clear_ext(hashtab_T *ht, int free_val)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925{
Bram Moolenaara7043832005-01-21 11:56:39 +00007926 int todo;
Bram Moolenaar33570922005-01-25 22:26:29 +00007927 hashitem_T *hi;
7928 dictitem_T *v;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007929
Bram Moolenaar33570922005-01-25 22:26:29 +00007930 hash_lock(ht);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007931 todo = (int)ht->ht_used;
Bram Moolenaara7043832005-01-21 11:56:39 +00007932 for (hi = ht->ht_array; todo > 0; ++hi)
7933 {
7934 if (!HASHITEM_EMPTY(hi))
7935 {
7936 --todo;
7937
Bram Moolenaar33570922005-01-25 22:26:29 +00007938 /* Free the variable. Don't remove it from the hashtab,
Bram Moolenaara7043832005-01-21 11:56:39 +00007939 * ht_array might change then. hash_clear() takes care of it
7940 * later. */
Bram Moolenaar33570922005-01-25 22:26:29 +00007941 v = HI2DI(hi);
7942 if (free_val)
7943 clear_tv(&v->di_tv);
Bram Moolenaar9bc174b2015-04-13 16:16:38 +02007944 if (v->di_flags & DI_FLAGS_ALLOC)
Bram Moolenaar33570922005-01-25 22:26:29 +00007945 vim_free(v);
Bram Moolenaara7043832005-01-21 11:56:39 +00007946 }
7947 }
7948 hash_clear(ht);
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00007949 ht->ht_used = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950}
7951
Bram Moolenaara7043832005-01-21 11:56:39 +00007952/*
Bram Moolenaar33570922005-01-25 22:26:29 +00007953 * Delete a variable from hashtab "ht" at item "hi".
7954 * Clear the variable value and free the dictitem.
Bram Moolenaara7043832005-01-21 11:56:39 +00007955 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956 static void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007957delete_var(hashtab_T *ht, hashitem_T *hi)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007958{
Bram Moolenaar33570922005-01-25 22:26:29 +00007959 dictitem_T *di = HI2DI(hi);
Bram Moolenaara7043832005-01-21 11:56:39 +00007960
7961 hash_remove(ht, hi);
Bram Moolenaar33570922005-01-25 22:26:29 +00007962 clear_tv(&di->di_tv);
7963 vim_free(di);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007964}
7965
7966/*
7967 * List the value of one internal variable.
7968 */
7969 static void
Bram Moolenaar32526b32019-01-19 17:43:09 +01007970list_one_var(dictitem_T *v, char *prefix, int *first)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971{
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007972 char_u *tofree;
7973 char_u *s;
Bram Moolenaar8a283e52005-01-06 23:28:25 +00007974 char_u numbuf[NUMBUFLEN];
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007975
Bram Moolenaar520e1e42016-01-23 19:46:28 +01007976 s = echo_string(&v->di_tv, &tofree, numbuf, get_copyID());
Bram Moolenaar33570922005-01-25 22:26:29 +00007977 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
Bram Moolenaar7d61a922007-08-30 09:12:23 +00007978 s == NULL ? (char_u *)"" : s, first);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007979 vim_free(tofree);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007980}
7981
Bram Moolenaar071d4272004-06-13 20:20:40 +00007982 static void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007983list_one_var_a(
Bram Moolenaar32526b32019-01-19 17:43:09 +01007984 char *prefix,
Bram Moolenaar7454a062016-01-30 15:14:10 +01007985 char_u *name,
7986 int type,
7987 char_u *string,
7988 int *first) /* when TRUE clear rest of screen and set to FALSE */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007989{
Bram Moolenaar31859182007-08-14 20:41:13 +00007990 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
7991 msg_start();
7992 msg_puts(prefix);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007993 if (name != NULL) /* "a:" vars don't have a name stored */
Bram Moolenaar32526b32019-01-19 17:43:09 +01007994 msg_puts((char *)name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 msg_putchar(' ');
7996 msg_advance(22);
7997 if (type == VAR_NUMBER)
7998 msg_putchar('#');
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007999 else if (type == VAR_FUNC || type == VAR_PARTIAL)
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008000 msg_putchar('*');
8001 else if (type == VAR_LIST)
8002 {
8003 msg_putchar('[');
8004 if (*string == '[')
8005 ++string;
8006 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00008007 else if (type == VAR_DICT)
8008 {
8009 msg_putchar('{');
8010 if (*string == '{')
8011 ++string;
8012 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 else
8014 msg_putchar(' ');
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008015
Bram Moolenaar071d4272004-06-13 20:20:40 +00008016 msg_outtrans(string);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008017
Bram Moolenaar1735bc92016-03-14 23:05:14 +01008018 if (type == VAR_FUNC || type == VAR_PARTIAL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008019 msg_puts("()");
Bram Moolenaar7d61a922007-08-30 09:12:23 +00008020 if (*first)
8021 {
8022 msg_clr_eos();
8023 *first = FALSE;
8024 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008025}
8026
8027/*
Bram Moolenaarc70646c2005-01-04 21:52:38 +00008028 * Set variable "name" to value in "tv".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008029 * If the variable already exists, the value is updated.
8030 * Otherwise the variable is created.
8031 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008032 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01008033set_var(
8034 char_u *name,
8035 typval_T *tv,
8036 int copy) /* make copy of value in "tv" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008037{
Bram Moolenaar33570922005-01-25 22:26:29 +00008038 dictitem_T *v;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 char_u *varname;
Bram Moolenaar33570922005-01-25 22:26:29 +00008040 hashtab_T *ht;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008041
Bram Moolenaarbaff0fe2010-03-17 19:53:49 +01008042 ht = find_var_ht(name, &varname);
8043 if (ht == NULL || *varname == NUL)
8044 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008045 semsg(_(e_illvar), name);
Bram Moolenaarbaff0fe2010-03-17 19:53:49 +01008046 return;
8047 }
Bram Moolenaar332ac062013-04-15 13:06:21 +02008048 v = find_var_in_ht(ht, 0, varname, TRUE);
Bram Moolenaarbaff0fe2010-03-17 19:53:49 +01008049
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02008050 /* Search in parent scope which is possible to reference from lambda */
8051 if (v == NULL)
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02008052 v = find_var_in_scoped_ht(name, TRUE);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02008053
Bram Moolenaar1735bc92016-03-14 23:05:14 +01008054 if ((tv->v_type == VAR_FUNC || tv->v_type == VAR_PARTIAL)
8055 && var_check_func_name(name, v == NULL))
Bram Moolenaar4228bec2011-03-27 16:03:15 +02008056 return;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008057
Bram Moolenaar33570922005-01-25 22:26:29 +00008058 if (v != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008059 {
Bram Moolenaar33570922005-01-25 22:26:29 +00008060 /* existing variable, need to clear the value */
Bram Moolenaar77354e72015-04-21 16:49:05 +02008061 if (var_check_ro(v->di_flags, name, FALSE)
Bram Moolenaar05c00c02019-02-11 22:00:11 +01008062 || var_check_lock(v->di_tv.v_lock, name, FALSE))
Bram Moolenaar33570922005-01-25 22:26:29 +00008063 return;
Bram Moolenaar33570922005-01-25 22:26:29 +00008064
8065 /*
Bram Moolenaar1cd5e612015-05-04 11:10:27 +02008066 * Handle setting internal v: variables separately where needed to
8067 * prevent changing the type.
Bram Moolenaar33570922005-01-25 22:26:29 +00008068 */
8069 if (ht == &vimvarht)
8070 {
8071 if (v->di_tv.v_type == VAR_STRING)
8072 {
Bram Moolenaar4b9e91f2019-01-24 13:58:11 +01008073 VIM_CLEAR(v->di_tv.vval.v_string);
Bram Moolenaar33570922005-01-25 22:26:29 +00008074 if (copy || tv->v_type != VAR_STRING)
Bram Moolenaar4b9e91f2019-01-24 13:58:11 +01008075 {
8076 char_u *val = tv_get_string(tv);
8077
8078 // Careful: when assigning to v:errmsg and tv_get_string()
8079 // causes an error message the variable will alrady be set.
8080 if (v->di_tv.vval.v_string == NULL)
8081 v->di_tv.vval.v_string = vim_strsave(val);
8082 }
Bram Moolenaar33570922005-01-25 22:26:29 +00008083 else
8084 {
8085 /* Take over the string to avoid an extra alloc/free. */
8086 v->di_tv.vval.v_string = tv->vval.v_string;
8087 tv->vval.v_string = NULL;
8088 }
Bram Moolenaar1cd5e612015-05-04 11:10:27 +02008089 return;
Bram Moolenaar33570922005-01-25 22:26:29 +00008090 }
Bram Moolenaar1cd5e612015-05-04 11:10:27 +02008091 else if (v->di_tv.v_type == VAR_NUMBER)
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008092 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008093 v->di_tv.vval.v_number = tv_get_number(tv);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008094 if (STRCMP(varname, "searchforward") == 0)
8095 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
Bram Moolenaar8050efa2013-11-08 04:30:20 +01008096#ifdef FEAT_SEARCH_EXTRA
8097 else if (STRCMP(varname, "hlsearch") == 0)
8098 {
8099 no_hlsearch = !v->di_tv.vval.v_number;
8100 redraw_all_later(SOME_VALID);
8101 }
8102#endif
Bram Moolenaar1cd5e612015-05-04 11:10:27 +02008103 return;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008104 }
Bram Moolenaar1cd5e612015-05-04 11:10:27 +02008105 else if (v->di_tv.v_type != tv->v_type)
Bram Moolenaar88b53fd2018-12-05 18:43:28 +01008106 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008107 semsg(_("E963: setting %s to value with wrong type"), name);
Bram Moolenaar88b53fd2018-12-05 18:43:28 +01008108 return;
8109 }
Bram Moolenaar33570922005-01-25 22:26:29 +00008110 }
8111
8112 clear_tv(&v->di_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113 }
8114 else /* add a new variable */
8115 {
Bram Moolenaar31b81602019-02-10 22:14:27 +01008116 // Can't add "v:" or "a:" variable.
8117 if (ht == &vimvarht || ht == get_funccal_args_ht())
Bram Moolenaar5fcc3fe2006-06-22 15:35:14 +00008118 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008119 semsg(_(e_illvar), name);
Bram Moolenaar5fcc3fe2006-06-22 15:35:14 +00008120 return;
8121 }
8122
Bram Moolenaar31b81602019-02-10 22:14:27 +01008123 // Make sure the variable name is valid.
Bram Moolenaar4228bec2011-03-27 16:03:15 +02008124 if (!valid_varname(varname))
8125 return;
Bram Moolenaar92124a32005-06-17 22:03:40 +00008126
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00008127 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
8128 + STRLEN(varname)));
Bram Moolenaara7043832005-01-21 11:56:39 +00008129 if (v == NULL)
8130 return;
Bram Moolenaar33570922005-01-25 22:26:29 +00008131 STRCPY(v->di_key, varname);
Bram Moolenaar33570922005-01-25 22:26:29 +00008132 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008133 {
Bram Moolenaara7043832005-01-21 11:56:39 +00008134 vim_free(v);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008135 return;
8136 }
Bram Moolenaar9bc174b2015-04-13 16:16:38 +02008137 v->di_flags = DI_FLAGS_ALLOC;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008138 }
Bram Moolenaara7043832005-01-21 11:56:39 +00008139
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008140 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
Bram Moolenaar33570922005-01-25 22:26:29 +00008141 copy_tv(tv, &v->di_tv);
Bram Moolenaar1c2fda22005-01-02 11:43:19 +00008142 else
8143 {
Bram Moolenaar33570922005-01-25 22:26:29 +00008144 v->di_tv = *tv;
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00008145 v->di_tv.v_lock = 0;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00008146 init_tv(tv);
Bram Moolenaar1c2fda22005-01-02 11:43:19 +00008147 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008148}
8149
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008150/*
Bram Moolenaar4e957af2006-09-02 11:41:07 +00008151 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
Bram Moolenaar33570922005-01-25 22:26:29 +00008152 * Also give an error message.
8153 */
Bram Moolenaarcd524592016-07-17 14:57:05 +02008154 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01008155var_check_ro(int flags, char_u *name, int use_gettext)
Bram Moolenaar33570922005-01-25 22:26:29 +00008156{
8157 if (flags & DI_FLAGS_RO)
8158 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008159 semsg(_(e_readonlyvar), use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar33570922005-01-25 22:26:29 +00008160 return TRUE;
8161 }
8162 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
8163 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008164 semsg(_(e_readonlysbx), use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar33570922005-01-25 22:26:29 +00008165 return TRUE;
8166 }
8167 return FALSE;
8168}
8169
8170/*
Bram Moolenaar4e957af2006-09-02 11:41:07 +00008171 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
8172 * Also give an error message.
8173 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008174 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01008175var_check_fixed(int flags, char_u *name, int use_gettext)
Bram Moolenaar4e957af2006-09-02 11:41:07 +00008176{
8177 if (flags & DI_FLAGS_FIX)
8178 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008179 semsg(_("E795: Cannot delete variable %s"),
Bram Moolenaar77354e72015-04-21 16:49:05 +02008180 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar4e957af2006-09-02 11:41:07 +00008181 return TRUE;
8182 }
8183 return FALSE;
8184}
8185
8186/*
Bram Moolenaar4228bec2011-03-27 16:03:15 +02008187 * Check if a funcref is assigned to a valid variable name.
8188 * Return TRUE and give an error if not.
8189 */
Bram Moolenaarcd524592016-07-17 14:57:05 +02008190 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01008191var_check_func_name(
8192 char_u *name, /* points to start of variable name */
8193 int new_var) /* TRUE when creating the variable */
Bram Moolenaar4228bec2011-03-27 16:03:15 +02008194{
Bram Moolenaarcbc67722014-05-22 14:19:56 +02008195 /* Allow for w: b: s: and t:. */
8196 if (!(vim_strchr((char_u *)"wbst", name[0]) != NULL && name[1] == ':')
Bram Moolenaar4228bec2011-03-27 16:03:15 +02008197 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
8198 ? name[2] : name[0]))
8199 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008200 semsg(_("E704: Funcref variable name must start with a capital: %s"),
Bram Moolenaar4228bec2011-03-27 16:03:15 +02008201 name);
8202 return TRUE;
8203 }
8204 /* Don't allow hiding a function. When "v" is not NULL we might be
8205 * assigning another function to the same var, the type is checked
8206 * below. */
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02008207 if (new_var && function_exists(name, FALSE))
Bram Moolenaar4228bec2011-03-27 16:03:15 +02008208 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008209 semsg(_("E705: Variable name conflicts with existing function: %s"),
Bram Moolenaar4228bec2011-03-27 16:03:15 +02008210 name);
8211 return TRUE;
8212 }
8213 return FALSE;
8214}
8215
8216/*
Bram Moolenaar05c00c02019-02-11 22:00:11 +01008217 * Return TRUE if "flags" indicates variable "name" is locked (immutable).
Bram Moolenaar77354e72015-04-21 16:49:05 +02008218 * Also give an error message, using "name" or _("name") when use_gettext is
8219 * TRUE.
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00008220 */
Bram Moolenaarcd524592016-07-17 14:57:05 +02008221 int
Bram Moolenaar05c00c02019-02-11 22:00:11 +01008222var_check_lock(int lock, char_u *name, int use_gettext)
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00008223{
8224 if (lock & VAR_LOCKED)
8225 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008226 semsg(_("E741: Value is locked: %s"),
Bram Moolenaar77354e72015-04-21 16:49:05 +02008227 name == NULL ? (char_u *)_("Unknown")
8228 : use_gettext ? (char_u *)_(name)
8229 : name);
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00008230 return TRUE;
8231 }
8232 if (lock & VAR_FIXED)
8233 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008234 semsg(_("E742: Cannot change value of %s"),
Bram Moolenaar77354e72015-04-21 16:49:05 +02008235 name == NULL ? (char_u *)_("Unknown")
8236 : use_gettext ? (char_u *)_(name)
8237 : name);
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00008238 return TRUE;
8239 }
8240 return FALSE;
8241}
8242
8243/*
Bram Moolenaar05c00c02019-02-11 22:00:11 +01008244 * Return TRUE if typeval "tv" and its value are set to be locked (immutable).
8245 * Also give an error message, using "name" or _("name") when use_gettext is
8246 * TRUE.
8247 */
8248 static int
8249tv_check_lock(typval_T *tv, char_u *name, int use_gettext)
8250{
8251 int lock = 0;
8252
8253 switch (tv->v_type)
8254 {
8255 case VAR_BLOB:
8256 if (tv->vval.v_blob != NULL)
8257 lock = tv->vval.v_blob->bv_lock;
8258 break;
8259 case VAR_LIST:
8260 if (tv->vval.v_list != NULL)
8261 lock = tv->vval.v_list->lv_lock;
8262 break;
8263 case VAR_DICT:
8264 if (tv->vval.v_dict != NULL)
8265 lock = tv->vval.v_dict->dv_lock;
8266 break;
8267 default:
8268 break;
8269 }
8270 return var_check_lock(tv->v_lock, name, use_gettext)
8271 || (lock != 0 && var_check_lock(lock, name, use_gettext));
8272}
8273
8274/*
8275 * Check if a variable name is valid.
8276 * Return FALSE and give an error if not.
8277 */
8278 int
8279valid_varname(char_u *varname)
8280{
8281 char_u *p;
8282
8283 for (p = varname; *p != NUL; ++p)
8284 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
8285 && *p != AUTOLOAD_CHAR)
8286 {
8287 semsg(_(e_illvar), varname);
8288 return FALSE;
8289 }
8290 return TRUE;
8291}
8292
8293/*
Bram Moolenaar33570922005-01-25 22:26:29 +00008294 * Copy the values from typval_T "from" to typval_T "to".
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008295 * When needed allocates string or increases reference count.
Bram Moolenaardd29ea12019-01-23 21:56:21 +01008296 * Does not make a copy of a list, blob or dict but copies the reference!
Bram Moolenaar8ba1bd22008-12-23 22:52:58 +00008297 * It is OK for "from" and "to" to point to the same item. This is used to
8298 * make a copy later.
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008299 */
Bram Moolenaar7e506b62010-01-19 15:55:06 +01008300 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01008301copy_tv(typval_T *from, typval_T *to)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302{
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008303 to->v_type = from->v_type;
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00008304 to->v_lock = 0;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008305 switch (from->v_type)
8306 {
8307 case VAR_NUMBER:
Bram Moolenaar520e1e42016-01-23 19:46:28 +01008308 case VAR_SPECIAL:
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008309 to->vval.v_number = from->vval.v_number;
8310 break;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008311 case VAR_FLOAT:
Bram Moolenaar835dc632016-02-07 14:27:38 +01008312#ifdef FEAT_FLOAT
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008313 to->vval.v_float = from->vval.v_float;
8314 break;
8315#endif
Bram Moolenaar835dc632016-02-07 14:27:38 +01008316 case VAR_JOB:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01008317#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar835dc632016-02-07 14:27:38 +01008318 to->vval.v_job = from->vval.v_job;
Bram Moolenaaree1cffc2016-02-21 19:14:41 +01008319 if (to->vval.v_job != NULL)
8320 ++to->vval.v_job->jv_refcount;
Bram Moolenaar835dc632016-02-07 14:27:38 +01008321 break;
8322#endif
Bram Moolenaar77073442016-02-13 23:23:53 +01008323 case VAR_CHANNEL:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01008324#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar77073442016-02-13 23:23:53 +01008325 to->vval.v_channel = from->vval.v_channel;
Bram Moolenaar5cefd402016-02-16 12:44:26 +01008326 if (to->vval.v_channel != NULL)
8327 ++to->vval.v_channel->ch_refcount;
Bram Moolenaar77073442016-02-13 23:23:53 +01008328 break;
8329#endif
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008330 case VAR_STRING:
8331 case VAR_FUNC:
8332 if (from->vval.v_string == NULL)
8333 to->vval.v_string = NULL;
8334 else
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00008335 {
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008336 to->vval.v_string = vim_strsave(from->vval.v_string);
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00008337 if (from->v_type == VAR_FUNC)
8338 func_ref(to->vval.v_string);
8339 }
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008340 break;
Bram Moolenaar1735bc92016-03-14 23:05:14 +01008341 case VAR_PARTIAL:
8342 if (from->vval.v_partial == NULL)
8343 to->vval.v_partial = NULL;
8344 else
8345 {
8346 to->vval.v_partial = from->vval.v_partial;
8347 ++to->vval.v_partial->pt_refcount;
8348 }
8349 break;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01008350 case VAR_BLOB:
8351 if (from->vval.v_blob == NULL)
8352 to->vval.v_blob = NULL;
8353 else
8354 {
8355 to->vval.v_blob = from->vval.v_blob;
8356 ++to->vval.v_blob->bv_refcount;
8357 }
8358 break;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008359 case VAR_LIST:
8360 if (from->vval.v_list == NULL)
8361 to->vval.v_list = NULL;
8362 else
8363 {
8364 to->vval.v_list = from->vval.v_list;
8365 ++to->vval.v_list->lv_refcount;
8366 }
8367 break;
Bram Moolenaar8c711452005-01-14 21:53:12 +00008368 case VAR_DICT:
8369 if (from->vval.v_dict == NULL)
8370 to->vval.v_dict = NULL;
8371 else
8372 {
8373 to->vval.v_dict = from->vval.v_dict;
8374 ++to->vval.v_dict->dv_refcount;
8375 }
8376 break;
Bram Moolenaara03f2332016-02-06 18:09:59 +01008377 case VAR_UNKNOWN:
Bram Moolenaar95f09602016-11-10 20:01:45 +01008378 internal_error("copy_tv(UNKNOWN)");
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008379 break;
8380 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008381}
8382
8383/*
Bram Moolenaare9a41262005-01-15 22:18:47 +00008384 * Make a copy of an item.
8385 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008386 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
8387 * reference to an already copied list/dict can be used.
8388 * Returns FAIL or OK.
Bram Moolenaare9a41262005-01-15 22:18:47 +00008389 */
Bram Moolenaarcd524592016-07-17 14:57:05 +02008390 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01008391item_copy(
8392 typval_T *from,
8393 typval_T *to,
8394 int deep,
8395 int copyID)
Bram Moolenaare9a41262005-01-15 22:18:47 +00008396{
8397 static int recurse = 0;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008398 int ret = OK;
Bram Moolenaare9a41262005-01-15 22:18:47 +00008399
Bram Moolenaar33570922005-01-25 22:26:29 +00008400 if (recurse >= DICT_MAXNEST)
Bram Moolenaare9a41262005-01-15 22:18:47 +00008401 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008402 emsg(_("E698: variable nested too deep for making a copy"));
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008403 return FAIL;
Bram Moolenaare9a41262005-01-15 22:18:47 +00008404 }
8405 ++recurse;
8406
8407 switch (from->v_type)
8408 {
8409 case VAR_NUMBER:
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008410 case VAR_FLOAT:
Bram Moolenaare9a41262005-01-15 22:18:47 +00008411 case VAR_STRING:
8412 case VAR_FUNC:
Bram Moolenaar1735bc92016-03-14 23:05:14 +01008413 case VAR_PARTIAL:
Bram Moolenaar15550002016-01-31 18:45:24 +01008414 case VAR_SPECIAL:
Bram Moolenaar835dc632016-02-07 14:27:38 +01008415 case VAR_JOB:
Bram Moolenaar77073442016-02-13 23:23:53 +01008416 case VAR_CHANNEL:
Bram Moolenaare9a41262005-01-15 22:18:47 +00008417 copy_tv(from, to);
8418 break;
8419 case VAR_LIST:
8420 to->v_type = VAR_LIST;
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00008421 to->v_lock = 0;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008422 if (from->vval.v_list == NULL)
8423 to->vval.v_list = NULL;
8424 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
8425 {
8426 /* use the copy made earlier */
8427 to->vval.v_list = from->vval.v_list->lv_copylist;
8428 ++to->vval.v_list->lv_refcount;
8429 }
8430 else
8431 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
8432 if (to->vval.v_list == NULL)
8433 ret = FAIL;
Bram Moolenaare9a41262005-01-15 22:18:47 +00008434 break;
Bram Moolenaar3d28b582019-01-15 22:44:17 +01008435 case VAR_BLOB:
Bram Moolenaardd29ea12019-01-23 21:56:21 +01008436 ret = blob_copy(from, to);
Bram Moolenaar3d28b582019-01-15 22:44:17 +01008437 break;
Bram Moolenaare9a41262005-01-15 22:18:47 +00008438 case VAR_DICT:
8439 to->v_type = VAR_DICT;
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00008440 to->v_lock = 0;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008441 if (from->vval.v_dict == NULL)
8442 to->vval.v_dict = NULL;
8443 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
8444 {
8445 /* use the copy made earlier */
8446 to->vval.v_dict = from->vval.v_dict->dv_copydict;
8447 ++to->vval.v_dict->dv_refcount;
8448 }
8449 else
8450 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
8451 if (to->vval.v_dict == NULL)
8452 ret = FAIL;
Bram Moolenaare9a41262005-01-15 22:18:47 +00008453 break;
Bram Moolenaara03f2332016-02-06 18:09:59 +01008454 case VAR_UNKNOWN:
Bram Moolenaar95f09602016-11-10 20:01:45 +01008455 internal_error("item_copy(UNKNOWN)");
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008456 ret = FAIL;
Bram Moolenaare9a41262005-01-15 22:18:47 +00008457 }
8458 --recurse;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008459 return ret;
Bram Moolenaare9a41262005-01-15 22:18:47 +00008460}
8461
8462/*
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008463 * This function is used by f_input() and f_inputdialog() functions. The third
8464 * argument to f_input() specifies the type of completion to use at the
8465 * prompt. The third argument to f_inputdialog() specifies the value to return
8466 * when the user cancels the prompt.
8467 */
8468 void
8469get_user_input(
8470 typval_T *argvars,
8471 typval_T *rettv,
8472 int inputdialog,
8473 int secret)
8474{
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008475 char_u *prompt = tv_get_string_chk(&argvars[0]);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008476 char_u *p = NULL;
8477 int c;
8478 char_u buf[NUMBUFLEN];
8479 int cmd_silent_save = cmd_silent;
8480 char_u *defstr = (char_u *)"";
8481 int xp_type = EXPAND_NOTHING;
8482 char_u *xp_arg = NULL;
8483
8484 rettv->v_type = VAR_STRING;
8485 rettv->vval.v_string = NULL;
8486
8487#ifdef NO_CONSOLE_INPUT
Bram Moolenaar91d348a2017-07-29 20:16:03 +02008488 /* While starting up, there is no place to enter text. When running tests
8489 * with --not-a-term we assume feedkeys() will be used. */
8490 if (no_console_input() && !is_not_a_term())
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008491 return;
8492#endif
8493
8494 cmd_silent = FALSE; /* Want to see the prompt. */
8495 if (prompt != NULL)
8496 {
8497 /* Only the part of the message after the last NL is considered as
8498 * prompt for the command line */
8499 p = vim_strrchr(prompt, '\n');
8500 if (p == NULL)
8501 p = prompt;
8502 else
8503 {
8504 ++p;
8505 c = *p;
8506 *p = NUL;
8507 msg_start();
8508 msg_clr_eos();
Bram Moolenaar32526b32019-01-19 17:43:09 +01008509 msg_puts_attr((char *)prompt, echo_attr);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008510 msg_didout = FALSE;
8511 msg_starthere();
8512 *p = c;
8513 }
8514 cmdline_row = msg_row;
8515
8516 if (argvars[1].v_type != VAR_UNKNOWN)
8517 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008518 defstr = tv_get_string_buf_chk(&argvars[1], buf);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008519 if (defstr != NULL)
8520 stuffReadbuffSpec(defstr);
8521
8522 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
8523 {
8524 char_u *xp_name;
8525 int xp_namelen;
8526 long argt;
8527
8528 /* input() with a third argument: completion */
8529 rettv->vval.v_string = NULL;
8530
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008531 xp_name = tv_get_string_buf_chk(&argvars[2], buf);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008532 if (xp_name == NULL)
8533 return;
8534
8535 xp_namelen = (int)STRLEN(xp_name);
8536
8537 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
8538 &xp_arg) == FAIL)
8539 return;
8540 }
8541 }
8542
8543 if (defstr != NULL)
8544 {
8545 int save_ex_normal_busy = ex_normal_busy;
Bram Moolenaar6dff58f2018-09-30 21:43:26 +02008546
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008547 ex_normal_busy = 0;
8548 rettv->vval.v_string =
8549 getcmdline_prompt(secret ? NUL : '@', p, echo_attr,
8550 xp_type, xp_arg);
8551 ex_normal_busy = save_ex_normal_busy;
8552 }
8553 if (inputdialog && rettv->vval.v_string == NULL
8554 && argvars[1].v_type != VAR_UNKNOWN
8555 && argvars[2].v_type != VAR_UNKNOWN)
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008556 rettv->vval.v_string = vim_strsave(tv_get_string_buf(
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008557 &argvars[2], buf));
8558
8559 vim_free(xp_arg);
8560
8561 /* since the user typed this, no need to wait for return */
8562 need_wait_return = FALSE;
8563 msg_didout = FALSE;
8564 }
8565 cmd_silent = cmd_silent_save;
8566}
8567
8568/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008569 * ":echo expr1 ..." print each argument separated with a space, add a
8570 * newline at the end.
8571 * ":echon expr1 ..." print each argument plain.
8572 */
8573 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01008574ex_echo(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008575{
8576 char_u *arg = eap->arg;
Bram Moolenaar33570922005-01-25 22:26:29 +00008577 typval_T rettv;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008578 char_u *tofree;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579 char_u *p;
8580 int needclr = TRUE;
8581 int atstart = TRUE;
Bram Moolenaar8a283e52005-01-06 23:28:25 +00008582 char_u numbuf[NUMBUFLEN];
Bram Moolenaar76a63452018-11-28 20:38:37 +01008583 int did_emsg_before = did_emsg;
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01008584 int called_emsg_before = called_emsg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008585
8586 if (eap->skip)
8587 ++emsg_skip;
8588 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
8589 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008590 /* If eval1() causes an error message the text from the command may
8591 * still need to be cleared. E.g., "echo 22,44". */
8592 need_clr_eos = needclr;
8593
Bram Moolenaar071d4272004-06-13 20:20:40 +00008594 p = arg;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00008595 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008596 {
8597 /*
8598 * Report the invalid expression unless the expression evaluation
8599 * has been cancelled due to an aborting error, an interrupt, or an
8600 * exception.
8601 */
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01008602 if (!aborting() && did_emsg == did_emsg_before
8603 && called_emsg == called_emsg_before)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008604 semsg(_(e_invexpr2), p);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008605 need_clr_eos = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008606 break;
8607 }
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008608 need_clr_eos = FALSE;
8609
Bram Moolenaar071d4272004-06-13 20:20:40 +00008610 if (!eap->skip)
8611 {
8612 if (atstart)
8613 {
8614 atstart = FALSE;
8615 /* Call msg_start() after eval1(), evaluating the expression
8616 * may cause a message to appear. */
8617 if (eap->cmdidx == CMD_echo)
Bram Moolenaar12b02902012-03-23 15:18:24 +01008618 {
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02008619 /* Mark the saved text as finishing the line, so that what
8620 * follows is displayed on a new line when scrolling back
8621 * at the more prompt. */
8622 msg_sb_eol();
Bram Moolenaar071d4272004-06-13 20:20:40 +00008623 msg_start();
Bram Moolenaar12b02902012-03-23 15:18:24 +01008624 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625 }
8626 else if (eap->cmdidx == CMD_echo)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008627 msg_puts_attr(" ", echo_attr);
Bram Moolenaar520e1e42016-01-23 19:46:28 +01008628 p = echo_string(&rettv, &tofree, numbuf, get_copyID());
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008629 if (p != NULL)
8630 for ( ; *p != NUL && !got_int; ++p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008631 {
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008632 if (*p == '\n' || *p == '\r' || *p == TAB)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008633 {
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008634 if (*p != TAB && needclr)
8635 {
8636 /* remove any text still there from the command */
8637 msg_clr_eos();
8638 needclr = FALSE;
8639 }
8640 msg_putchar_attr(*p, echo_attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008641 }
8642 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008643 {
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008644 if (has_mbyte)
8645 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00008646 int i = (*mb_ptr2len)(p);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008647
8648 (void)msg_outtrans_len_attr(p, i, echo_attr);
8649 p += i - 1;
8650 }
8651 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008652 (void)msg_outtrans_len_attr(p, 1, echo_attr);
8653 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008654 }
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008655 vim_free(tofree);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00008657 clear_tv(&rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008658 arg = skipwhite(arg);
8659 }
8660 eap->nextcmd = check_nextcmd(arg);
8661
8662 if (eap->skip)
8663 --emsg_skip;
8664 else
8665 {
8666 /* remove text that may still be there from the command */
8667 if (needclr)
8668 msg_clr_eos();
8669 if (eap->cmdidx == CMD_echo)
8670 msg_end();
8671 }
8672}
8673
8674/*
8675 * ":echohl {name}".
8676 */
8677 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01008678ex_echohl(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008679{
Bram Moolenaar1b9645d2017-09-17 23:03:31 +02008680 echo_attr = syn_name2attr(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681}
8682
8683/*
8684 * ":execute expr1 ..." execute the result of an expression.
8685 * ":echomsg expr1 ..." Print a message
8686 * ":echoerr expr1 ..." Print an error
8687 * Each gets spaces around each argument and a newline at the end for
8688 * echo commands
8689 */
8690 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01008691ex_execute(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008692{
8693 char_u *arg = eap->arg;
Bram Moolenaar33570922005-01-25 22:26:29 +00008694 typval_T rettv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008695 int ret = OK;
8696 char_u *p;
8697 garray_T ga;
8698 int len;
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01008699 int save_did_emsg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008700
8701 ga_init2(&ga, 1, 80);
8702
8703 if (eap->skip)
8704 ++emsg_skip;
8705 while (*arg != NUL && *arg != '|' && *arg != '\n')
8706 {
Bram Moolenaarce9d50d2019-01-14 22:22:29 +01008707 ret = eval1_emsg(&arg, &rettv, !eap->skip);
8708 if (ret == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710
8711 if (!eap->skip)
8712 {
Bram Moolenaar461a7fc2018-12-22 13:28:07 +01008713 char_u buf[NUMBUFLEN];
8714
8715 if (eap->cmdidx == CMD_execute)
8716 p = tv_get_string_buf(&rettv, buf);
8717 else
8718 p = tv_stringify(&rettv, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008719 len = (int)STRLEN(p);
8720 if (ga_grow(&ga, len + 2) == FAIL)
8721 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00008722 clear_tv(&rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008723 ret = FAIL;
8724 break;
8725 }
8726 if (ga.ga_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008727 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008729 ga.ga_len += len;
8730 }
8731
Bram Moolenaarc70646c2005-01-04 21:52:38 +00008732 clear_tv(&rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008733 arg = skipwhite(arg);
8734 }
8735
8736 if (ret != FAIL && ga.ga_data != NULL)
8737 {
Bram Moolenaar57002ad2017-03-16 19:04:19 +01008738 if (eap->cmdidx == CMD_echomsg || eap->cmdidx == CMD_echoerr)
8739 {
8740 /* Mark the already saved text as finishing the line, so that what
8741 * follows is displayed on a new line when scrolling back at the
8742 * more prompt. */
8743 msg_sb_eol();
Bram Moolenaar57002ad2017-03-16 19:04:19 +01008744 }
8745
Bram Moolenaar071d4272004-06-13 20:20:40 +00008746 if (eap->cmdidx == CMD_echomsg)
Bram Moolenaar4770d092006-01-12 23:22:24 +00008747 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01008748 msg_attr(ga.ga_data, echo_attr);
Bram Moolenaar4770d092006-01-12 23:22:24 +00008749 out_flush();
8750 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751 else if (eap->cmdidx == CMD_echoerr)
8752 {
8753 /* We don't want to abort following commands, restore did_emsg. */
8754 save_did_emsg = did_emsg;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008755 emsg(ga.ga_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008756 if (!force_abort)
8757 did_emsg = save_did_emsg;
8758 }
8759 else if (eap->cmdidx == CMD_execute)
8760 do_cmdline((char_u *)ga.ga_data,
8761 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
8762 }
8763
8764 ga_clear(&ga);
8765
8766 if (eap->skip)
8767 --emsg_skip;
8768
8769 eap->nextcmd = check_nextcmd(arg);
8770}
8771
8772/*
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008773 * Find window specified by "vp" in tabpage "tp".
8774 */
8775 win_T *
8776find_win_by_nr(
8777 typval_T *vp,
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01008778 tabpage_T *tp) /* NULL for current tab page */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008779{
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008780 win_T *wp;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008781 int nr = (int)tv_get_number_chk(vp, NULL);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008782
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008783 if (nr < 0)
8784 return NULL;
8785 if (nr == 0)
8786 return curwin;
8787
Bram Moolenaar29323592016-07-24 22:04:11 +02008788 FOR_ALL_WINDOWS_IN_TAB(tp, wp)
8789 {
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008790 if (nr >= LOWEST_WIN_ID)
8791 {
8792 if (wp->w_id == nr)
8793 return wp;
8794 }
8795 else if (--nr <= 0)
8796 break;
Bram Moolenaar29323592016-07-24 22:04:11 +02008797 }
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008798 if (nr >= LOWEST_WIN_ID)
8799 return NULL;
8800 return wp;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008801}
8802
8803/*
Bram Moolenaare6e39892018-10-25 12:32:11 +02008804 * Find a window: When using a Window ID in any tab page, when using a number
8805 * in the current tab page.
8806 */
8807 win_T *
8808find_win_by_nr_or_id(typval_T *vp)
8809{
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008810 int nr = (int)tv_get_number_chk(vp, NULL);
Bram Moolenaare6e39892018-10-25 12:32:11 +02008811
8812 if (nr >= LOWEST_WIN_ID)
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01008813 return win_id2wp(tv_get_number(vp));
Bram Moolenaare6e39892018-10-25 12:32:11 +02008814 return find_win_by_nr(vp, NULL);
8815}
8816
8817/*
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008818 * Find window specified by "wvp" in tabpage "tvp".
Bram Moolenaar00aa0692019-04-27 20:37:57 +02008819 * Returns the tab page in 'ptp'
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008820 */
8821 win_T *
8822find_tabwin(
Bram Moolenaar00aa0692019-04-27 20:37:57 +02008823 typval_T *wvp, // VAR_UNKNOWN for current window
8824 typval_T *tvp, // VAR_UNKNOWN for current tab page
8825 tabpage_T **ptp)
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008826{
8827 win_T *wp = NULL;
8828 tabpage_T *tp = NULL;
8829 long n;
8830
8831 if (wvp->v_type != VAR_UNKNOWN)
8832 {
8833 if (tvp->v_type != VAR_UNKNOWN)
8834 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008835 n = (long)tv_get_number(tvp);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008836 if (n >= 0)
8837 tp = find_tabpage(n);
8838 }
8839 else
8840 tp = curtab;
8841
8842 if (tp != NULL)
Bram Moolenaar00aa0692019-04-27 20:37:57 +02008843 {
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008844 wp = find_win_by_nr(wvp, tp);
Bram Moolenaar00aa0692019-04-27 20:37:57 +02008845 if (wp == NULL && wvp->v_type == VAR_NUMBER
8846 && wvp->vval.v_number != -1)
8847 // A window with the specified number is not found
8848 tp = NULL;
8849 }
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008850 }
8851 else
Bram Moolenaar00aa0692019-04-27 20:37:57 +02008852 {
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008853 wp = curwin;
Bram Moolenaar00aa0692019-04-27 20:37:57 +02008854 tp = curtab;
8855 }
8856
8857 if (ptp != NULL)
8858 *ptp = tp;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008859
8860 return wp;
8861}
8862
8863/*
8864 * getwinvar() and gettabwinvar()
8865 */
8866 void
8867getwinvar(
8868 typval_T *argvars,
8869 typval_T *rettv,
8870 int off) /* 1 for gettabwinvar() */
8871{
8872 win_T *win;
8873 char_u *varname;
8874 dictitem_T *v;
8875 tabpage_T *tp = NULL;
8876 int done = FALSE;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008877 win_T *oldcurwin;
8878 tabpage_T *oldtabpage;
8879 int need_switch_win;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008880
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008881 if (off == 1)
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008882 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008883 else
8884 tp = curtab;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008885 win = find_win_by_nr(&argvars[off], tp);
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008886 varname = tv_get_string_chk(&argvars[off + 1]);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008887 ++emsg_off;
8888
8889 rettv->v_type = VAR_STRING;
8890 rettv->vval.v_string = NULL;
8891
8892 if (win != NULL && varname != NULL)
8893 {
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008894 /* Set curwin to be our win, temporarily. Also set the tabpage,
8895 * otherwise the window is not valid. Only do this when needed,
8896 * autocommands get blocked. */
8897 need_switch_win = !(tp == curtab && win == curwin);
8898 if (!need_switch_win
8899 || switch_win(&oldcurwin, &oldtabpage, win, tp, TRUE) == OK)
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008900 {
Bram Moolenaar30567352016-08-27 21:25:44 +02008901 if (*varname == '&')
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008902 {
Bram Moolenaar30567352016-08-27 21:25:44 +02008903 if (varname[1] == NUL)
8904 {
8905 /* get all window-local options in a dict */
8906 dict_T *opts = get_winbuf_options(FALSE);
8907
8908 if (opts != NULL)
8909 {
Bram Moolenaar45cf6e92017-04-30 20:25:19 +02008910 rettv_dict_set(rettv, opts);
Bram Moolenaar30567352016-08-27 21:25:44 +02008911 done = TRUE;
8912 }
8913 }
8914 else if (get_option_tv(&varname, rettv, 1) == OK)
8915 /* window-local-option */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008916 done = TRUE;
8917 }
8918 else
8919 {
8920 /* Look up the variable. */
8921 /* Let getwinvar({nr}, "") return the "w:" dictionary. */
8922 v = find_var_in_ht(&win->w_vars->dv_hashtab, 'w',
8923 varname, FALSE);
8924 if (v != NULL)
8925 {
8926 copy_tv(&v->di_tv, rettv);
8927 done = TRUE;
8928 }
8929 }
8930 }
8931
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008932 if (need_switch_win)
8933 /* restore previous notion of curwin */
8934 restore_win(oldcurwin, oldtabpage, TRUE);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008935 }
8936
8937 if (!done && argvars[off + 2].v_type != VAR_UNKNOWN)
8938 /* use the default return value */
8939 copy_tv(&argvars[off + 2], rettv);
8940
8941 --emsg_off;
8942}
8943
8944/*
8945 * "setwinvar()" and "settabwinvar()" functions
8946 */
8947 void
8948setwinvar(typval_T *argvars, typval_T *rettv UNUSED, int off)
8949{
8950 win_T *win;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008951 win_T *save_curwin;
8952 tabpage_T *save_curtab;
8953 int need_switch_win;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008954 char_u *varname, *winvarname;
8955 typval_T *varp;
8956 char_u nbuf[NUMBUFLEN];
8957 tabpage_T *tp = NULL;
8958
Bram Moolenaare0fb7d12019-02-12 20:48:10 +01008959 if (check_secure())
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008960 return;
8961
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008962 if (off == 1)
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008963 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008964 else
8965 tp = curtab;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008966 win = find_win_by_nr(&argvars[off], tp);
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008967 varname = tv_get_string_chk(&argvars[off + 1]);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008968 varp = &argvars[off + 2];
8969
8970 if (win != NULL && varname != NULL && varp != NULL)
8971 {
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008972 need_switch_win = !(tp == curtab && win == curwin);
8973 if (!need_switch_win
8974 || switch_win(&save_curwin, &save_curtab, win, tp, TRUE) == OK)
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008975 {
8976 if (*varname == '&')
8977 {
8978 long numval;
8979 char_u *strval;
8980 int error = FALSE;
8981
8982 ++varname;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008983 numval = (long)tv_get_number_chk(varp, &error);
8984 strval = tv_get_string_buf_chk(varp, nbuf);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008985 if (!error && strval != NULL)
8986 set_option_value(varname, numval, strval, OPT_LOCAL);
8987 }
8988 else
8989 {
8990 winvarname = alloc((unsigned)STRLEN(varname) + 3);
8991 if (winvarname != NULL)
8992 {
8993 STRCPY(winvarname, "w:");
8994 STRCPY(winvarname + 2, varname);
8995 set_var(winvarname, varp, TRUE);
8996 vim_free(winvarname);
8997 }
8998 }
8999 }
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009000 if (need_switch_win)
9001 restore_win(save_curwin, save_curtab, TRUE);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009002 }
9003}
9004
9005/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009006 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
9007 * "arg" points to the "&" or '+' when called, to "option" when returning.
9008 * Returns NULL when no option name found. Otherwise pointer to the char
9009 * after the option name.
9010 */
9011 static char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01009012find_option_end(char_u **arg, int *opt_flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009013{
9014 char_u *p = *arg;
9015
9016 ++p;
9017 if (*p == 'g' && p[1] == ':')
9018 {
9019 *opt_flags = OPT_GLOBAL;
9020 p += 2;
9021 }
9022 else if (*p == 'l' && p[1] == ':')
9023 {
9024 *opt_flags = OPT_LOCAL;
9025 p += 2;
9026 }
9027 else
9028 *opt_flags = 0;
9029
9030 if (!ASCII_ISALPHA(*p))
9031 return NULL;
9032 *arg = p;
9033
9034 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
9035 p += 4; /* termcap option */
9036 else
9037 while (ASCII_ISALPHA(*p))
9038 ++p;
9039 return p;
9040}
9041
9042/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02009043 * Return the autoload script name for a function or variable name.
9044 * Returns NULL when out of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009045 */
Bram Moolenaara1544c02013-05-30 12:35:52 +02009046 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02009047autoload_name(char_u *name)
Bram Moolenaara1544c02013-05-30 12:35:52 +02009048{
Bram Moolenaara1544c02013-05-30 12:35:52 +02009049 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02009050 char_u *scriptname;
Bram Moolenaara1544c02013-05-30 12:35:52 +02009051
Bram Moolenaara9b579f2016-07-17 18:29:19 +02009052 /* Get the script file name: replace '#' with '/', append ".vim". */
9053 scriptname = alloc((unsigned)(STRLEN(name) + 14));
9054 if (scriptname == NULL)
Bram Moolenaar9bdfb002014-04-23 17:43:42 +02009055 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02009056 STRCPY(scriptname, "autoload/");
9057 STRCAT(scriptname, name);
9058 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
9059 STRCAT(scriptname, ".vim");
9060 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
9061 *p = '/';
9062 return scriptname;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00009063}
9064
9065/*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00009066 * If "name" has a package name try autoloading the script for it.
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00009067 * Return TRUE if a package was loaded.
9068 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02009069 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01009070script_autoload(
9071 char_u *name,
9072 int reload) /* load script again when already loaded */
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00009073{
9074 char_u *p;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00009075 char_u *scriptname, *tofree;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00009076 int ret = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00009077 int i;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00009078
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00009079 /* If there is no '#' after name[0] there is no package name. */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00009080 p = vim_strchr(name, AUTOLOAD_CHAR);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00009081 if (p == NULL || p == name)
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00009082 return FALSE;
9083
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00009084 tofree = scriptname = autoload_name(name);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00009085
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00009086 /* Find the name in the list of previously loaded package names. Skip
9087 * "autoload/", it's always the same. */
9088 for (i = 0; i < ga_loaded.ga_len; ++i)
9089 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
9090 break;
9091 if (!reload && i < ga_loaded.ga_len)
9092 ret = FALSE; /* was loaded already */
9093 else
9094 {
9095 /* Remember the name if it wasn't loaded already. */
9096 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
9097 {
9098 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
9099 tofree = NULL;
9100 }
9101
9102 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01009103 if (source_runtime(scriptname, 0) == OK)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00009104 ret = TRUE;
9105 }
9106
9107 vim_free(tofree);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00009108 return ret;
9109}
9110
Bram Moolenaar071d4272004-06-13 20:20:40 +00009111#if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
9112typedef enum
9113{
Bram Moolenaar8c8de832008-06-24 22:58:06 +00009114 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
9115 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
9116 VAR_FLAVOUR_VIMINFO /* all uppercase */
Bram Moolenaar071d4272004-06-13 20:20:40 +00009117} var_flavour_T;
9118
Bram Moolenaar071d4272004-06-13 20:20:40 +00009119 static var_flavour_T
Bram Moolenaar7454a062016-01-30 15:14:10 +01009120var_flavour(char_u *varname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009121{
9122 char_u *p = varname;
9123
9124 if (ASCII_ISUPPER(*p))
9125 {
9126 while (*(++p))
9127 if (ASCII_ISLOWER(*p))
9128 return VAR_FLAVOUR_SESSION;
9129 return VAR_FLAVOUR_VIMINFO;
9130 }
9131 else
9132 return VAR_FLAVOUR_DEFAULT;
9133}
9134#endif
9135
9136#if defined(FEAT_VIMINFO) || defined(PROTO)
9137/*
9138 * Restore global vars that start with a capital from the viminfo file
9139 */
9140 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01009141read_viminfo_varlist(vir_T *virp, int writing)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009142{
9143 char_u *tab;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00009144 int type = VAR_NUMBER;
Bram Moolenaar33570922005-01-25 22:26:29 +00009145 typval_T tv;
Bram Moolenaar27e80c82018-10-14 21:41:01 +02009146 funccal_entry_T funccal_entry;
Bram Moolenaar071d4272004-06-13 20:20:40 +00009147
9148 if (!writing && (find_viminfo_parameter('!') != NULL))
9149 {
9150 tab = vim_strchr(virp->vir_line + 1, '\t');
9151 if (tab != NULL)
9152 {
9153 *tab++ = '\0'; /* isolate the variable name */
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009154 switch (*tab)
9155 {
9156 case 'S': type = VAR_STRING; break;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00009157#ifdef FEAT_FLOAT
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009158 case 'F': type = VAR_FLOAT; break;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00009159#endif
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009160 case 'D': type = VAR_DICT; break;
9161 case 'L': type = VAR_LIST; break;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01009162 case 'B': type = VAR_BLOB; break;
Bram Moolenaara03f2332016-02-06 18:09:59 +01009163 case 'X': type = VAR_SPECIAL; break;
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009164 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00009165
9166 tab = vim_strchr(tab, '\t');
9167 if (tab != NULL)
9168 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00009169 tv.v_type = type;
Bram Moolenaar8c8b8bb2019-01-13 17:48:04 +01009170 if (type == VAR_STRING || type == VAR_DICT
9171 || type == VAR_LIST || type == VAR_BLOB)
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00009172 tv.vval.v_string = viminfo_readstring(virp,
Bram Moolenaar071d4272004-06-13 20:20:40 +00009173 (int)(tab - virp->vir_line + 1), TRUE);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00009174#ifdef FEAT_FLOAT
9175 else if (type == VAR_FLOAT)
9176 (void)string2float(tab + 1, &tv.vval.v_float);
9177#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00009178 else
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00009179 tv.vval.v_number = atol((char *)tab + 1);
Bram Moolenaar8c8b8bb2019-01-13 17:48:04 +01009180 if (type == VAR_DICT || type == VAR_LIST)
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009181 {
9182 typval_T *etv = eval_expr(tv.vval.v_string, NULL);
9183
9184 if (etv == NULL)
9185 /* Failed to parse back the dict or list, use it as a
9186 * string. */
9187 tv.v_type = VAR_STRING;
9188 else
9189 {
9190 vim_free(tv.vval.v_string);
9191 tv = *etv;
Bram Moolenaar507cc8a2012-03-23 15:37:02 +01009192 vim_free(etv);
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009193 }
9194 }
Bram Moolenaar8c8b8bb2019-01-13 17:48:04 +01009195 else if (type == VAR_BLOB)
9196 {
9197 blob_T *blob = string2blob(tv.vval.v_string);
9198
9199 if (blob == NULL)
9200 // Failed to parse back the blob, use it as a string.
9201 tv.v_type = VAR_STRING;
9202 else
9203 {
9204 vim_free(tv.vval.v_string);
9205 tv.v_type = VAR_BLOB;
9206 tv.vval.v_blob = blob;
9207 }
9208 }
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009209
Bram Moolenaarb20e3342016-01-18 23:29:01 +01009210 /* when in a function use global variables */
Bram Moolenaar27e80c82018-10-14 21:41:01 +02009211 save_funccal(&funccal_entry);
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00009212 set_var(virp->vir_line + 1, &tv, FALSE);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02009213 restore_funccal();
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009214
9215 if (tv.v_type == VAR_STRING)
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00009216 vim_free(tv.vval.v_string);
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01009217 else if (tv.v_type == VAR_DICT || tv.v_type == VAR_LIST ||
9218 tv.v_type == VAR_BLOB)
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009219 clear_tv(&tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00009220 }
9221 }
9222 }
9223
9224 return viminfo_readline(virp);
9225}
9226
9227/*
9228 * Write global vars that start with a capital to the viminfo file
9229 */
9230 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01009231write_viminfo_varlist(FILE *fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009232{
Bram Moolenaar33570922005-01-25 22:26:29 +00009233 hashitem_T *hi;
9234 dictitem_T *this_var;
Bram Moolenaara7043832005-01-21 11:56:39 +00009235 int todo;
Bram Moolenaar2fc83fc2016-02-08 22:57:24 +01009236 char *s = "";
Bram Moolenaar81bf7082005-02-12 14:31:42 +00009237 char_u *p;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00009238 char_u *tofree;
Bram Moolenaar8a283e52005-01-06 23:28:25 +00009239 char_u numbuf[NUMBUFLEN];
Bram Moolenaar071d4272004-06-13 20:20:40 +00009240
9241 if (find_viminfo_parameter('!') == NULL)
9242 return;
9243
Bram Moolenaar9577c3e2010-05-14 12:16:25 +02009244 fputs(_("\n# global variables:\n"), fp);
Bram Moolenaara7043832005-01-21 11:56:39 +00009245
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00009246 todo = (int)globvarht.ht_used;
Bram Moolenaar33570922005-01-25 22:26:29 +00009247 for (hi = globvarht.ht_array; todo > 0; ++hi)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009248 {
Bram Moolenaara7043832005-01-21 11:56:39 +00009249 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar071d4272004-06-13 20:20:40 +00009250 {
Bram Moolenaara7043832005-01-21 11:56:39 +00009251 --todo;
Bram Moolenaar33570922005-01-25 22:26:29 +00009252 this_var = HI2DI(hi);
9253 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
Bram Moolenaarc70646c2005-01-04 21:52:38 +00009254 {
Bram Moolenaar33570922005-01-25 22:26:29 +00009255 switch (this_var->di_tv.v_type)
Bram Moolenaara7043832005-01-21 11:56:39 +00009256 {
9257 case VAR_STRING: s = "STR"; break;
9258 case VAR_NUMBER: s = "NUM"; break;
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009259 case VAR_FLOAT: s = "FLO"; break;
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009260 case VAR_DICT: s = "DIC"; break;
9261 case VAR_LIST: s = "LIS"; break;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01009262 case VAR_BLOB: s = "BLO"; break;
Bram Moolenaara03f2332016-02-06 18:09:59 +01009263 case VAR_SPECIAL: s = "XPL"; break;
9264
9265 case VAR_UNKNOWN:
9266 case VAR_FUNC:
Bram Moolenaar1735bc92016-03-14 23:05:14 +01009267 case VAR_PARTIAL:
Bram Moolenaar835dc632016-02-07 14:27:38 +01009268 case VAR_JOB:
Bram Moolenaar77073442016-02-13 23:23:53 +01009269 case VAR_CHANNEL:
Bram Moolenaara03f2332016-02-06 18:09:59 +01009270 continue;
Bram Moolenaara7043832005-01-21 11:56:39 +00009271 }
Bram Moolenaar33570922005-01-25 22:26:29 +00009272 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
Bram Moolenaar8c8b8bb2019-01-13 17:48:04 +01009273 if (this_var->di_tv.v_type == VAR_SPECIAL)
9274 {
9275 sprintf((char *)numbuf, "%ld",
9276 (long)this_var->di_tv.vval.v_number);
9277 p = numbuf;
9278 tofree = NULL;
9279 }
9280 else
9281 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00009282 if (p != NULL)
9283 viminfo_writestring(fp, p);
Bram Moolenaara7043832005-01-21 11:56:39 +00009284 vim_free(tofree);
9285 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00009286 }
9287 }
9288}
9289#endif
9290
9291#if defined(FEAT_SESSION) || defined(PROTO)
9292 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01009293store_session_globals(FILE *fd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009294{
Bram Moolenaar33570922005-01-25 22:26:29 +00009295 hashitem_T *hi;
9296 dictitem_T *this_var;
Bram Moolenaara7043832005-01-21 11:56:39 +00009297 int todo;
Bram Moolenaar071d4272004-06-13 20:20:40 +00009298 char_u *p, *t;
9299
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00009300 todo = (int)globvarht.ht_used;
Bram Moolenaar33570922005-01-25 22:26:29 +00009301 for (hi = globvarht.ht_array; todo > 0; ++hi)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009302 {
Bram Moolenaara7043832005-01-21 11:56:39 +00009303 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar071d4272004-06-13 20:20:40 +00009304 {
Bram Moolenaara7043832005-01-21 11:56:39 +00009305 --todo;
Bram Moolenaar33570922005-01-25 22:26:29 +00009306 this_var = HI2DI(hi);
9307 if ((this_var->di_tv.v_type == VAR_NUMBER
9308 || this_var->di_tv.v_type == VAR_STRING)
9309 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00009310 {
Bram Moolenaara7043832005-01-21 11:56:39 +00009311 /* Escape special characters with a backslash. Turn a LF and
9312 * CR into \n and \r. */
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009313 p = vim_strsave_escaped(tv_get_string(&this_var->di_tv),
Bram Moolenaara7043832005-01-21 11:56:39 +00009314 (char_u *)"\\\"\n\r");
9315 if (p == NULL) /* out of memory */
9316 break;
9317 for (t = p; *t != NUL; ++t)
9318 if (*t == '\n')
9319 *t = 'n';
9320 else if (*t == '\r')
9321 *t = 'r';
9322 if ((fprintf(fd, "let %s = %c%s%c",
Bram Moolenaar33570922005-01-25 22:26:29 +00009323 this_var->di_key,
9324 (this_var->di_tv.v_type == VAR_STRING) ? '"'
9325 : ' ',
9326 p,
9327 (this_var->di_tv.v_type == VAR_STRING) ? '"'
9328 : ' ') < 0)
Bram Moolenaara7043832005-01-21 11:56:39 +00009329 || put_eol(fd) == FAIL)
9330 {
9331 vim_free(p);
9332 return FAIL;
9333 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00009334 vim_free(p);
9335 }
Bram Moolenaar8c8de832008-06-24 22:58:06 +00009336#ifdef FEAT_FLOAT
9337 else if (this_var->di_tv.v_type == VAR_FLOAT
9338 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
9339 {
9340 float_T f = this_var->di_tv.vval.v_float;
9341 int sign = ' ';
9342
9343 if (f < 0)
9344 {
9345 f = -f;
9346 sign = '-';
9347 }
Bram Moolenaar2b04b192012-01-26 11:45:30 +01009348 if ((fprintf(fd, "let %s = %c%f",
Bram Moolenaar8c8de832008-06-24 22:58:06 +00009349 this_var->di_key, sign, f) < 0)
9350 || put_eol(fd) == FAIL)
9351 return FAIL;
9352 }
9353#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00009354 }
9355 }
9356 return OK;
9357}
9358#endif
9359
Bram Moolenaar661b1822005-07-28 22:36:45 +00009360/*
9361 * Display script name where an item was last set.
9362 * Should only be invoked when 'verbose' is non-zero.
9363 */
9364 void
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02009365last_set_msg(sctx_T script_ctx)
Bram Moolenaar661b1822005-07-28 22:36:45 +00009366{
Bram Moolenaarcafda4f2005-09-06 19:25:11 +00009367 char_u *p;
9368
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02009369 if (script_ctx.sc_sid != 0)
Bram Moolenaar661b1822005-07-28 22:36:45 +00009370 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02009371 p = home_replace_save(NULL, get_scriptname(script_ctx.sc_sid));
Bram Moolenaarcafda4f2005-09-06 19:25:11 +00009372 if (p != NULL)
9373 {
9374 verbose_enter();
Bram Moolenaar32526b32019-01-19 17:43:09 +01009375 msg_puts(_("\n\tLast set from "));
9376 msg_puts((char *)p);
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02009377 if (script_ctx.sc_lnum > 0)
9378 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01009379 msg_puts(_(" line "));
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02009380 msg_outnum((long)script_ctx.sc_lnum);
9381 }
Bram Moolenaarcafda4f2005-09-06 19:25:11 +00009382 verbose_leave();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02009383 vim_free(p);
Bram Moolenaarcafda4f2005-09-06 19:25:11 +00009384 }
Bram Moolenaar661b1822005-07-28 22:36:45 +00009385 }
9386}
9387
Bram Moolenaar61be3762019-03-19 23:04:17 +01009388/*
9389 * Reset v:option_new, v:option_old and v:option_type.
9390 */
Bram Moolenaar53744302015-07-17 17:38:22 +02009391 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01009392reset_v_option_vars(void)
Bram Moolenaar53744302015-07-17 17:38:22 +02009393{
9394 set_vim_var_string(VV_OPTION_NEW, NULL, -1);
9395 set_vim_var_string(VV_OPTION_OLD, NULL, -1);
9396 set_vim_var_string(VV_OPTION_TYPE, NULL, -1);
9397}
9398
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009399/*
9400 * Prepare "gap" for an assert error and add the sourcing position.
9401 */
9402 void
9403prepare_assert_error(garray_T *gap)
9404{
9405 char buf[NUMBUFLEN];
9406
9407 ga_init2(gap, 1, 100);
9408 if (sourcing_name != NULL)
9409 {
9410 ga_concat(gap, sourcing_name);
9411 if (sourcing_lnum > 0)
9412 ga_concat(gap, (char_u *)" ");
9413 }
9414 if (sourcing_lnum > 0)
9415 {
9416 sprintf(buf, "line %ld", (long)sourcing_lnum);
9417 ga_concat(gap, (char_u *)buf);
9418 }
9419 if (sourcing_name != NULL || sourcing_lnum > 0)
9420 ga_concat(gap, (char_u *)": ");
9421}
9422
9423/*
9424 * Add an assert error to v:errors.
9425 */
9426 void
9427assert_error(garray_T *gap)
9428{
9429 struct vimvar *vp = &vimvars[VV_ERRORS];
9430
9431 if (vp->vv_type != VAR_LIST || vimvars[VV_ERRORS].vv_list == NULL)
9432 /* Make sure v:errors is a list. */
9433 set_vim_var_list(VV_ERRORS, list_alloc());
9434 list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
9435}
9436
Bram Moolenaar65a54642018-04-28 16:56:53 +02009437 int
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009438assert_equal_common(typval_T *argvars, assert_type_T atype)
9439{
9440 garray_T ga;
9441
9442 if (tv_equal(&argvars[0], &argvars[1], FALSE, FALSE)
9443 != (atype == ASSERT_EQUAL))
9444 {
9445 prepare_assert_error(&ga);
9446 fill_assert_error(&ga, &argvars[2], NULL, &argvars[0], &argvars[1],
9447 atype);
9448 assert_error(&ga);
9449 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009450 return 1;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009451 }
Bram Moolenaar65a54642018-04-28 16:56:53 +02009452 return 0;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009453}
9454
Bram Moolenaar65a54642018-04-28 16:56:53 +02009455 int
Bram Moolenaard96ff162018-02-18 22:13:29 +01009456assert_equalfile(typval_T *argvars)
9457{
9458 char_u buf1[NUMBUFLEN];
9459 char_u buf2[NUMBUFLEN];
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009460 char_u *fname1 = tv_get_string_buf_chk(&argvars[0], buf1);
9461 char_u *fname2 = tv_get_string_buf_chk(&argvars[1], buf2);
Bram Moolenaard96ff162018-02-18 22:13:29 +01009462 garray_T ga;
9463 FILE *fd1;
9464 FILE *fd2;
9465
9466 if (fname1 == NULL || fname2 == NULL)
Bram Moolenaar65a54642018-04-28 16:56:53 +02009467 return 0;
Bram Moolenaard96ff162018-02-18 22:13:29 +01009468
9469 IObuff[0] = NUL;
9470 fd1 = mch_fopen((char *)fname1, READBIN);
9471 if (fd1 == NULL)
9472 {
9473 vim_snprintf((char *)IObuff, IOSIZE, (char *)e_notread, fname1);
9474 }
9475 else
9476 {
9477 fd2 = mch_fopen((char *)fname2, READBIN);
9478 if (fd2 == NULL)
9479 {
9480 fclose(fd1);
9481 vim_snprintf((char *)IObuff, IOSIZE, (char *)e_notread, fname2);
9482 }
9483 else
9484 {
9485 int c1, c2;
9486 long count = 0;
9487
9488 for (;;)
9489 {
9490 c1 = fgetc(fd1);
9491 c2 = fgetc(fd2);
9492 if (c1 == EOF)
9493 {
9494 if (c2 != EOF)
9495 STRCPY(IObuff, "first file is shorter");
9496 break;
9497 }
9498 else if (c2 == EOF)
9499 {
9500 STRCPY(IObuff, "second file is shorter");
9501 break;
9502 }
9503 else if (c1 != c2)
9504 {
9505 vim_snprintf((char *)IObuff, IOSIZE,
9506 "difference at byte %ld", count);
9507 break;
9508 }
9509 ++count;
9510 }
Bram Moolenaar30494182018-02-20 21:46:05 +01009511 fclose(fd1);
9512 fclose(fd2);
Bram Moolenaard96ff162018-02-18 22:13:29 +01009513 }
9514 }
9515 if (IObuff[0] != NUL)
9516 {
9517 prepare_assert_error(&ga);
9518 ga_concat(&ga, IObuff);
9519 assert_error(&ga);
9520 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009521 return 1;
Bram Moolenaard96ff162018-02-18 22:13:29 +01009522 }
Bram Moolenaar65a54642018-04-28 16:56:53 +02009523 return 0;
Bram Moolenaard96ff162018-02-18 22:13:29 +01009524}
9525
Bram Moolenaar65a54642018-04-28 16:56:53 +02009526 int
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009527assert_match_common(typval_T *argvars, assert_type_T atype)
9528{
9529 garray_T ga;
9530 char_u buf1[NUMBUFLEN];
9531 char_u buf2[NUMBUFLEN];
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009532 char_u *pat = tv_get_string_buf_chk(&argvars[0], buf1);
9533 char_u *text = tv_get_string_buf_chk(&argvars[1], buf2);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009534
9535 if (pat == NULL || text == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01009536 emsg(_(e_invarg));
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009537 else if (pattern_match(pat, text, FALSE) != (atype == ASSERT_MATCH))
9538 {
9539 prepare_assert_error(&ga);
9540 fill_assert_error(&ga, &argvars[2], NULL, &argvars[0], &argvars[1],
9541 atype);
9542 assert_error(&ga);
9543 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009544 return 1;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009545 }
Bram Moolenaar65a54642018-04-28 16:56:53 +02009546 return 0;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009547}
9548
Bram Moolenaar65a54642018-04-28 16:56:53 +02009549 int
Bram Moolenaar61c04492016-07-23 15:35:35 +02009550assert_inrange(typval_T *argvars)
9551{
9552 garray_T ga;
9553 int error = FALSE;
Bram Moolenaar61c04492016-07-23 15:35:35 +02009554 char_u *tofree;
9555 char msg[200];
9556 char_u numbuf[NUMBUFLEN];
9557
Bram Moolenaar38f08e72019-02-20 22:04:32 +01009558#ifdef FEAT_FLOAT
9559 if (argvars[0].v_type == VAR_FLOAT
9560 || argvars[1].v_type == VAR_FLOAT
9561 || argvars[2].v_type == VAR_FLOAT)
Bram Moolenaar61c04492016-07-23 15:35:35 +02009562 {
Bram Moolenaar38f08e72019-02-20 22:04:32 +01009563 float_T flower = tv_get_float(&argvars[0]);
9564 float_T fupper = tv_get_float(&argvars[1]);
9565 float_T factual = tv_get_float(&argvars[2]);
9566
9567 if (factual < flower || factual > fupper)
Bram Moolenaar61c04492016-07-23 15:35:35 +02009568 {
Bram Moolenaar38f08e72019-02-20 22:04:32 +01009569 prepare_assert_error(&ga);
9570 if (argvars[3].v_type != VAR_UNKNOWN)
9571 {
9572 ga_concat(&ga, tv2string(&argvars[3], &tofree, numbuf, 0));
9573 vim_free(tofree);
9574 }
9575 else
9576 {
9577 vim_snprintf(msg, 200, "Expected range %g - %g, but got %g",
9578 flower, fupper, factual);
9579 ga_concat(&ga, (char_u *)msg);
9580 }
9581 assert_error(&ga);
9582 ga_clear(&ga);
9583 return 1;
Bram Moolenaar61c04492016-07-23 15:35:35 +02009584 }
Bram Moolenaar38f08e72019-02-20 22:04:32 +01009585 }
9586 else
9587#endif
9588 {
9589 varnumber_T lower = tv_get_number_chk(&argvars[0], &error);
9590 varnumber_T upper = tv_get_number_chk(&argvars[1], &error);
9591 varnumber_T actual = tv_get_number_chk(&argvars[2], &error);
9592
9593 if (error)
9594 return 0;
9595 if (actual < lower || actual > upper)
Bram Moolenaar61c04492016-07-23 15:35:35 +02009596 {
Bram Moolenaar38f08e72019-02-20 22:04:32 +01009597 prepare_assert_error(&ga);
9598 if (argvars[3].v_type != VAR_UNKNOWN)
9599 {
9600 ga_concat(&ga, tv2string(&argvars[3], &tofree, numbuf, 0));
9601 vim_free(tofree);
9602 }
9603 else
9604 {
9605 vim_snprintf(msg, 200, "Expected range %ld - %ld, but got %ld",
Bram Moolenaar61c04492016-07-23 15:35:35 +02009606 (long)lower, (long)upper, (long)actual);
Bram Moolenaar38f08e72019-02-20 22:04:32 +01009607 ga_concat(&ga, (char_u *)msg);
9608 }
9609 assert_error(&ga);
9610 ga_clear(&ga);
9611 return 1;
Bram Moolenaar61c04492016-07-23 15:35:35 +02009612 }
Bram Moolenaar61c04492016-07-23 15:35:35 +02009613 }
Bram Moolenaar65a54642018-04-28 16:56:53 +02009614 return 0;
Bram Moolenaar61c04492016-07-23 15:35:35 +02009615}
9616
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009617/*
9618 * Common for assert_true() and assert_false().
Bram Moolenaar65a54642018-04-28 16:56:53 +02009619 * Return non-zero for failure.
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009620 */
Bram Moolenaar65a54642018-04-28 16:56:53 +02009621 int
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009622assert_bool(typval_T *argvars, int isTrue)
9623{
9624 int error = FALSE;
9625 garray_T ga;
9626
9627 if (argvars[0].v_type == VAR_SPECIAL
9628 && argvars[0].vval.v_number == (isTrue ? VVAL_TRUE : VVAL_FALSE))
Bram Moolenaar65a54642018-04-28 16:56:53 +02009629 return 0;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009630 if (argvars[0].v_type != VAR_NUMBER
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009631 || (tv_get_number_chk(&argvars[0], &error) == 0) == isTrue
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009632 || error)
9633 {
9634 prepare_assert_error(&ga);
9635 fill_assert_error(&ga, &argvars[1],
9636 (char_u *)(isTrue ? "True" : "False"),
9637 NULL, &argvars[0], ASSERT_OTHER);
9638 assert_error(&ga);
9639 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009640 return 1;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009641 }
Bram Moolenaar65a54642018-04-28 16:56:53 +02009642 return 0;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009643}
9644
Bram Moolenaar65a54642018-04-28 16:56:53 +02009645 int
Bram Moolenaar42205552017-03-18 19:42:22 +01009646assert_report(typval_T *argvars)
9647{
9648 garray_T ga;
9649
9650 prepare_assert_error(&ga);
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009651 ga_concat(&ga, tv_get_string(&argvars[0]));
Bram Moolenaar42205552017-03-18 19:42:22 +01009652 assert_error(&ga);
9653 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009654 return 1;
Bram Moolenaar42205552017-03-18 19:42:22 +01009655}
9656
Bram Moolenaar65a54642018-04-28 16:56:53 +02009657 int
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009658assert_exception(typval_T *argvars)
9659{
9660 garray_T ga;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009661 char_u *error = tv_get_string_chk(&argvars[0]);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009662
9663 if (vimvars[VV_EXCEPTION].vv_str == NULL)
9664 {
9665 prepare_assert_error(&ga);
9666 ga_concat(&ga, (char_u *)"v:exception is not set");
9667 assert_error(&ga);
9668 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009669 return 1;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009670 }
9671 else if (error != NULL
9672 && strstr((char *)vimvars[VV_EXCEPTION].vv_str, (char *)error) == NULL)
9673 {
9674 prepare_assert_error(&ga);
9675 fill_assert_error(&ga, &argvars[1], NULL, &argvars[0],
9676 &vimvars[VV_EXCEPTION].vv_tv, ASSERT_OTHER);
9677 assert_error(&ga);
9678 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009679 return 1;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009680 }
Bram Moolenaar65a54642018-04-28 16:56:53 +02009681 return 0;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009682}
9683
Bram Moolenaar65a54642018-04-28 16:56:53 +02009684 int
Bram Moolenaarb48e96f2018-02-13 12:26:14 +01009685assert_beeps(typval_T *argvars)
9686{
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009687 char_u *cmd = tv_get_string_chk(&argvars[0]);
Bram Moolenaarb48e96f2018-02-13 12:26:14 +01009688 garray_T ga;
Bram Moolenaar65a54642018-04-28 16:56:53 +02009689 int ret = 0;
Bram Moolenaarb48e96f2018-02-13 12:26:14 +01009690
9691 called_vim_beep = FALSE;
9692 suppress_errthrow = TRUE;
9693 emsg_silent = FALSE;
9694 do_cmdline_cmd(cmd);
9695 if (!called_vim_beep)
9696 {
9697 prepare_assert_error(&ga);
9698 ga_concat(&ga, (char_u *)"command did not beep: ");
9699 ga_concat(&ga, cmd);
9700 assert_error(&ga);
9701 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009702 ret = 1;
Bram Moolenaarb48e96f2018-02-13 12:26:14 +01009703 }
9704
9705 suppress_errthrow = FALSE;
9706 emsg_on_display = FALSE;
Bram Moolenaar65a54642018-04-28 16:56:53 +02009707 return ret;
Bram Moolenaarb48e96f2018-02-13 12:26:14 +01009708}
9709
Bram Moolenaar25190db2019-05-04 15:05:28 +02009710 static void
9711assert_append_cmd_or_arg(garray_T *gap, typval_T *argvars, char_u *cmd)
9712{
9713 char_u *tofree;
9714 char_u numbuf[NUMBUFLEN];
9715
9716 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
9717 {
9718 ga_concat(gap, echo_string(&argvars[2], &tofree, numbuf, 0));
9719 vim_free(tofree);
9720 }
9721 else
9722 ga_concat(gap, cmd);
9723}
9724
Bram Moolenaar65a54642018-04-28 16:56:53 +02009725 int
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009726assert_fails(typval_T *argvars)
9727{
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009728 char_u *cmd = tv_get_string_chk(&argvars[0]);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009729 garray_T ga;
Bram Moolenaar65a54642018-04-28 16:56:53 +02009730 int ret = 0;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009731
9732 called_emsg = FALSE;
9733 suppress_errthrow = TRUE;
9734 emsg_silent = TRUE;
9735 do_cmdline_cmd(cmd);
9736 if (!called_emsg)
9737 {
9738 prepare_assert_error(&ga);
9739 ga_concat(&ga, (char_u *)"command did not fail: ");
Bram Moolenaar25190db2019-05-04 15:05:28 +02009740 assert_append_cmd_or_arg(&ga, argvars, cmd);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009741 assert_error(&ga);
9742 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009743 ret = 1;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009744 }
9745 else if (argvars[1].v_type != VAR_UNKNOWN)
9746 {
9747 char_u buf[NUMBUFLEN];
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009748 char *error = (char *)tv_get_string_buf_chk(&argvars[1], buf);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009749
9750 if (error == NULL
9751 || strstr((char *)vimvars[VV_ERRMSG].vv_str, error) == NULL)
9752 {
9753 prepare_assert_error(&ga);
9754 fill_assert_error(&ga, &argvars[2], NULL, &argvars[1],
9755 &vimvars[VV_ERRMSG].vv_tv, ASSERT_OTHER);
Bram Moolenaar25190db2019-05-04 15:05:28 +02009756 ga_concat(&ga, (char_u *)": ");
9757 assert_append_cmd_or_arg(&ga, argvars, cmd);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009758 assert_error(&ga);
9759 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009760 ret = 1;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009761 }
9762 }
9763
9764 called_emsg = FALSE;
9765 suppress_errthrow = FALSE;
9766 emsg_silent = FALSE;
9767 emsg_on_display = FALSE;
9768 set_vim_var_string(VV_ERRMSG, NULL, 0);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009769 return ret;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009770}
9771
9772/*
Bram Moolenaar86576712019-01-25 20:48:33 +01009773 * Append "p[clen]" to "gap", escaping unprintable characters.
9774 * Changes NL to \n, CR to \r, etc.
9775 */
9776 static void
9777ga_concat_esc(garray_T *gap, char_u *p, int clen)
9778{
9779 char_u buf[NUMBUFLEN];
9780
9781 if (clen > 1)
9782 {
9783 mch_memmove(buf, p, clen);
9784 buf[clen] = NUL;
9785 ga_concat(gap, buf);
9786 }
9787 else switch (*p)
9788 {
9789 case BS: ga_concat(gap, (char_u *)"\\b"); break;
9790 case ESC: ga_concat(gap, (char_u *)"\\e"); break;
9791 case FF: ga_concat(gap, (char_u *)"\\f"); break;
9792 case NL: ga_concat(gap, (char_u *)"\\n"); break;
9793 case TAB: ga_concat(gap, (char_u *)"\\t"); break;
9794 case CAR: ga_concat(gap, (char_u *)"\\r"); break;
9795 case '\\': ga_concat(gap, (char_u *)"\\\\"); break;
9796 default:
9797 if (*p < ' ')
9798 {
9799 vim_snprintf((char *)buf, NUMBUFLEN, "\\x%02x", *p);
9800 ga_concat(gap, buf);
9801 }
9802 else
9803 ga_append(gap, *p);
9804 break;
9805 }
9806}
9807
9808/*
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009809 * Append "str" to "gap", escaping unprintable characters.
9810 * Changes NL to \n, CR to \r, etc.
9811 */
9812 static void
Bram Moolenaar86576712019-01-25 20:48:33 +01009813ga_concat_shorten_esc(garray_T *gap, char_u *str)
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009814{
9815 char_u *p;
Bram Moolenaar86576712019-01-25 20:48:33 +01009816 char_u *s;
9817 int c;
9818 int clen;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009819 char_u buf[NUMBUFLEN];
Bram Moolenaar86576712019-01-25 20:48:33 +01009820 int same_len;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009821
9822 if (str == NULL)
9823 {
9824 ga_concat(gap, (char_u *)"NULL");
9825 return;
9826 }
9827
9828 for (p = str; *p != NUL; ++p)
Bram Moolenaar86576712019-01-25 20:48:33 +01009829 {
9830 same_len = 1;
9831 s = p;
9832 c = mb_ptr2char_adv(&s);
9833 clen = s - p;
9834 while (*s != NUL && c == mb_ptr2char(s))
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009835 {
Bram Moolenaar86576712019-01-25 20:48:33 +01009836 ++same_len;
9837 s += clen;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009838 }
Bram Moolenaar86576712019-01-25 20:48:33 +01009839 if (same_len > 20)
9840 {
9841 ga_concat(gap, (char_u *)"\\[");
9842 ga_concat_esc(gap, p, clen);
9843 ga_concat(gap, (char_u *)" occurs ");
9844 vim_snprintf((char *)buf, NUMBUFLEN, "%d", same_len);
9845 ga_concat(gap, buf);
9846 ga_concat(gap, (char_u *)" times]");
9847 p = s - 1;
9848 }
9849 else
9850 ga_concat_esc(gap, p, clen);
9851 }
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009852}
9853
9854/*
9855 * Fill "gap" with information about an assert error.
9856 */
9857 void
9858fill_assert_error(
9859 garray_T *gap,
9860 typval_T *opt_msg_tv,
9861 char_u *exp_str,
9862 typval_T *exp_tv,
9863 typval_T *got_tv,
9864 assert_type_T atype)
9865{
9866 char_u numbuf[NUMBUFLEN];
9867 char_u *tofree;
9868
9869 if (opt_msg_tv->v_type != VAR_UNKNOWN)
9870 {
Bram Moolenaarc7b831c2017-01-28 18:08:12 +01009871 ga_concat(gap, echo_string(opt_msg_tv, &tofree, numbuf, 0));
9872 vim_free(tofree);
9873 ga_concat(gap, (char_u *)": ");
9874 }
9875
9876 if (atype == ASSERT_MATCH || atype == ASSERT_NOTMATCH)
9877 ga_concat(gap, (char_u *)"Pattern ");
9878 else if (atype == ASSERT_NOTEQUAL)
9879 ga_concat(gap, (char_u *)"Expected not equal to ");
9880 else
9881 ga_concat(gap, (char_u *)"Expected ");
9882 if (exp_str == NULL)
9883 {
Bram Moolenaar86576712019-01-25 20:48:33 +01009884 ga_concat_shorten_esc(gap, tv2string(exp_tv, &tofree, numbuf, 0));
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009885 vim_free(tofree);
9886 }
9887 else
Bram Moolenaar86576712019-01-25 20:48:33 +01009888 ga_concat_shorten_esc(gap, exp_str);
Bram Moolenaarc7b831c2017-01-28 18:08:12 +01009889 if (atype != ASSERT_NOTEQUAL)
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009890 {
Bram Moolenaarc7b831c2017-01-28 18:08:12 +01009891 if (atype == ASSERT_MATCH)
9892 ga_concat(gap, (char_u *)" does not match ");
9893 else if (atype == ASSERT_NOTMATCH)
9894 ga_concat(gap, (char_u *)" does match ");
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009895 else
Bram Moolenaarc7b831c2017-01-28 18:08:12 +01009896 ga_concat(gap, (char_u *)" but got ");
Bram Moolenaar86576712019-01-25 20:48:33 +01009897 ga_concat_shorten_esc(gap, tv2string(got_tv, &tofree, numbuf, 0));
Bram Moolenaarc7b831c2017-01-28 18:08:12 +01009898 vim_free(tofree);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009899 }
9900}
9901
Bram Moolenaar31988702018-02-13 12:57:42 +01009902/*
9903 * Compare "typ1" and "typ2". Put the result in "typ1".
9904 */
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01009905 int
9906typval_compare(
9907 typval_T *typ1, /* first operand */
9908 typval_T *typ2, /* second operand */
9909 exptype_T type, /* operator */
9910 int type_is, /* TRUE for "is" and "isnot" */
Bram Moolenaar31988702018-02-13 12:57:42 +01009911 int ic) /* ignore case */
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01009912{
9913 int i;
9914 varnumber_T n1, n2;
9915 char_u *s1, *s2;
9916 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
9917
Bram Moolenaar31988702018-02-13 12:57:42 +01009918 if (type_is && typ1->v_type != typ2->v_type)
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01009919 {
Bram Moolenaar31988702018-02-13 12:57:42 +01009920 /* For "is" a different type always means FALSE, for "notis"
9921 * it means TRUE. */
9922 n1 = (type == TYPE_NEQUAL);
9923 }
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01009924 else if (typ1->v_type == VAR_BLOB || typ2->v_type == VAR_BLOB)
9925 {
9926 if (type_is)
9927 {
9928 n1 = (typ1->v_type == typ2->v_type
9929 && typ1->vval.v_blob == typ2->vval.v_blob);
9930 if (type == TYPE_NEQUAL)
9931 n1 = !n1;
9932 }
9933 else if (typ1->v_type != typ2->v_type
9934 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
9935 {
9936 if (typ1->v_type != typ2->v_type)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01009937 emsg(_("E977: Can only compare Blob with Blob"));
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01009938 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01009939 emsg(_(e_invalblob));
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01009940 clear_tv(typ1);
9941 return FAIL;
9942 }
9943 else
9944 {
9945 // Compare two Blobs for being equal or unequal.
9946 n1 = blob_equal(typ1->vval.v_blob, typ2->vval.v_blob);
9947 if (type == TYPE_NEQUAL)
9948 n1 = !n1;
9949 }
9950 }
Bram Moolenaar31988702018-02-13 12:57:42 +01009951 else if (typ1->v_type == VAR_LIST || typ2->v_type == VAR_LIST)
9952 {
9953 if (type_is)
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01009954 {
Bram Moolenaar31988702018-02-13 12:57:42 +01009955 n1 = (typ1->v_type == typ2->v_type
9956 && typ1->vval.v_list == typ2->vval.v_list);
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01009957 if (type == TYPE_NEQUAL)
9958 n1 = !n1;
9959 }
Bram Moolenaar31988702018-02-13 12:57:42 +01009960 else if (typ1->v_type != typ2->v_type
9961 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01009962 {
Bram Moolenaar31988702018-02-13 12:57:42 +01009963 if (typ1->v_type != typ2->v_type)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01009964 emsg(_("E691: Can only compare List with List"));
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01009965 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01009966 emsg(_("E692: Invalid operation for List"));
Bram Moolenaar31988702018-02-13 12:57:42 +01009967 clear_tv(typ1);
9968 return FAIL;
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01009969 }
9970 else
9971 {
Bram Moolenaar31988702018-02-13 12:57:42 +01009972 /* Compare two Lists for being equal or unequal. */
9973 n1 = list_equal(typ1->vval.v_list, typ2->vval.v_list,
9974 ic, FALSE);
9975 if (type == TYPE_NEQUAL)
9976 n1 = !n1;
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01009977 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01009978 }
Bram Moolenaar31988702018-02-13 12:57:42 +01009979
9980 else if (typ1->v_type == VAR_DICT || typ2->v_type == VAR_DICT)
9981 {
9982 if (type_is)
9983 {
9984 n1 = (typ1->v_type == typ2->v_type
9985 && typ1->vval.v_dict == typ2->vval.v_dict);
9986 if (type == TYPE_NEQUAL)
9987 n1 = !n1;
9988 }
9989 else if (typ1->v_type != typ2->v_type
9990 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
9991 {
9992 if (typ1->v_type != typ2->v_type)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01009993 emsg(_("E735: Can only compare Dictionary with Dictionary"));
Bram Moolenaar31988702018-02-13 12:57:42 +01009994 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01009995 emsg(_("E736: Invalid operation for Dictionary"));
Bram Moolenaar31988702018-02-13 12:57:42 +01009996 clear_tv(typ1);
9997 return FAIL;
9998 }
9999 else
10000 {
10001 /* Compare two Dictionaries for being equal or unequal. */
10002 n1 = dict_equal(typ1->vval.v_dict, typ2->vval.v_dict,
10003 ic, FALSE);
10004 if (type == TYPE_NEQUAL)
10005 n1 = !n1;
10006 }
10007 }
10008
10009 else if (typ1->v_type == VAR_FUNC || typ2->v_type == VAR_FUNC
10010 || typ1->v_type == VAR_PARTIAL || typ2->v_type == VAR_PARTIAL)
10011 {
10012 if (type != TYPE_EQUAL && type != TYPE_NEQUAL)
10013 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +010010014 emsg(_("E694: Invalid operation for Funcrefs"));
Bram Moolenaar31988702018-02-13 12:57:42 +010010015 clear_tv(typ1);
10016 return FAIL;
10017 }
10018 if ((typ1->v_type == VAR_PARTIAL
10019 && typ1->vval.v_partial == NULL)
10020 || (typ2->v_type == VAR_PARTIAL
10021 && typ2->vval.v_partial == NULL))
10022 /* when a partial is NULL assume not equal */
10023 n1 = FALSE;
10024 else if (type_is)
10025 {
10026 if (typ1->v_type == VAR_FUNC && typ2->v_type == VAR_FUNC)
10027 /* strings are considered the same if their value is
10028 * the same */
10029 n1 = tv_equal(typ1, typ2, ic, FALSE);
10030 else if (typ1->v_type == VAR_PARTIAL
10031 && typ2->v_type == VAR_PARTIAL)
10032 n1 = (typ1->vval.v_partial == typ2->vval.v_partial);
10033 else
10034 n1 = FALSE;
10035 }
10036 else
10037 n1 = tv_equal(typ1, typ2, ic, FALSE);
10038 if (type == TYPE_NEQUAL)
10039 n1 = !n1;
10040 }
10041
10042#ifdef FEAT_FLOAT
10043 /*
10044 * If one of the two variables is a float, compare as a float.
10045 * When using "=~" or "!~", always compare as string.
10046 */
10047 else if ((typ1->v_type == VAR_FLOAT || typ2->v_type == VAR_FLOAT)
10048 && type != TYPE_MATCH && type != TYPE_NOMATCH)
10049 {
10050 float_T f1, f2;
10051
Bram Moolenaar38f08e72019-02-20 22:04:32 +010010052 f1 = tv_get_float(typ1);
10053 f2 = tv_get_float(typ2);
Bram Moolenaar31988702018-02-13 12:57:42 +010010054 n1 = FALSE;
10055 switch (type)
10056 {
10057 case TYPE_EQUAL: n1 = (f1 == f2); break;
10058 case TYPE_NEQUAL: n1 = (f1 != f2); break;
10059 case TYPE_GREATER: n1 = (f1 > f2); break;
10060 case TYPE_GEQUAL: n1 = (f1 >= f2); break;
10061 case TYPE_SMALLER: n1 = (f1 < f2); break;
10062 case TYPE_SEQUAL: n1 = (f1 <= f2); break;
10063 case TYPE_UNKNOWN:
10064 case TYPE_MATCH:
10065 case TYPE_NOMATCH: break; /* avoid gcc warning */
10066 }
10067 }
10068#endif
10069
10070 /*
10071 * If one of the two variables is a number, compare as a number.
10072 * When using "=~" or "!~", always compare as string.
10073 */
10074 else if ((typ1->v_type == VAR_NUMBER || typ2->v_type == VAR_NUMBER)
10075 && type != TYPE_MATCH && type != TYPE_NOMATCH)
10076 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +010010077 n1 = tv_get_number(typ1);
10078 n2 = tv_get_number(typ2);
Bram Moolenaar31988702018-02-13 12:57:42 +010010079 switch (type)
10080 {
10081 case TYPE_EQUAL: n1 = (n1 == n2); break;
10082 case TYPE_NEQUAL: n1 = (n1 != n2); break;
10083 case TYPE_GREATER: n1 = (n1 > n2); break;
10084 case TYPE_GEQUAL: n1 = (n1 >= n2); break;
10085 case TYPE_SMALLER: n1 = (n1 < n2); break;
10086 case TYPE_SEQUAL: n1 = (n1 <= n2); break;
10087 case TYPE_UNKNOWN:
10088 case TYPE_MATCH:
10089 case TYPE_NOMATCH: break; /* avoid gcc warning */
10090 }
10091 }
10092 else
10093 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +010010094 s1 = tv_get_string_buf(typ1, buf1);
10095 s2 = tv_get_string_buf(typ2, buf2);
Bram Moolenaar31988702018-02-13 12:57:42 +010010096 if (type != TYPE_MATCH && type != TYPE_NOMATCH)
10097 i = ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2);
10098 else
10099 i = 0;
10100 n1 = FALSE;
10101 switch (type)
10102 {
10103 case TYPE_EQUAL: n1 = (i == 0); break;
10104 case TYPE_NEQUAL: n1 = (i != 0); break;
10105 case TYPE_GREATER: n1 = (i > 0); break;
10106 case TYPE_GEQUAL: n1 = (i >= 0); break;
10107 case TYPE_SMALLER: n1 = (i < 0); break;
10108 case TYPE_SEQUAL: n1 = (i <= 0); break;
10109
10110 case TYPE_MATCH:
10111 case TYPE_NOMATCH:
10112 n1 = pattern_match(s2, s1, ic);
10113 if (type == TYPE_NOMATCH)
10114 n1 = !n1;
10115 break;
10116
10117 case TYPE_UNKNOWN: break; /* avoid gcc warning */
10118 }
10119 }
10120 clear_tv(typ1);
10121 typ1->v_type = VAR_NUMBER;
10122 typ1->vval.v_number = n1;
10123
Bram Moolenaarc6f9f732018-02-11 19:06:26 +010010124 return OK;
10125}
10126
Bram Moolenaarc6f9f732018-02-11 19:06:26 +010010127 char_u *
Bram Moolenaar6f8d2ac2018-07-25 19:49:45 +020010128typval_tostring(typval_T *arg)
Bram Moolenaarc6f9f732018-02-11 19:06:26 +010010129{
10130 char_u *tofree;
10131 char_u numbuf[NUMBUFLEN];
10132 char_u *ret = NULL;
10133
10134 if (arg == NULL)
10135 return vim_strsave((char_u *)"(does not exist)");
10136 ret = tv2string(arg, &tofree, numbuf, 0);
10137 /* Make a copy if we have a value but it's not in allocated memory. */
10138 if (ret != NULL && tofree == NULL)
10139 ret = vim_strsave(ret);
10140 return ret;
10141}
10142
10143 int
10144var_exists(char_u *var)
10145{
10146 char_u *name;
10147 char_u *tofree;
10148 typval_T tv;
10149 int len = 0;
10150 int n = FALSE;
10151
10152 /* get_name_len() takes care of expanding curly braces */
10153 name = var;
10154 len = get_name_len(&var, &tofree, TRUE, FALSE);
10155 if (len > 0)
10156 {
10157 if (tofree != NULL)
10158 name = tofree;
10159 n = (get_var_tv(name, len, &tv, NULL, FALSE, TRUE) == OK);
10160 if (n)
10161 {
10162 /* handle d.key, l[idx], f(expr) */
10163 n = (handle_subscript(&var, &tv, TRUE, FALSE) == OK);
10164 if (n)
10165 clear_tv(&tv);
10166 }
10167 }
10168 if (*var != NUL)
10169 n = FALSE;
10170
10171 vim_free(tofree);
10172 return n;
10173}
10174
Bram Moolenaar071d4272004-06-13 20:20:40 +000010175#endif /* FEAT_EVAL */
10176
Bram Moolenaar071d4272004-06-13 20:20:40 +000010177
Bram Moolenaar8c8de832008-06-24 22:58:06 +000010178#if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010179
Bram Moolenaar4f974752019-02-17 17:44:42 +010010180#ifdef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +000010181/*
10182 * Functions for ":8" filename modifier: get 8.3 version of a filename.
10183 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000010184
10185/*
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010186 * Get the short path (8.3) for the filename in "fnamep".
10187 * Only works for a valid file name.
10188 * When the path gets longer "fnamep" is changed and the allocated buffer
10189 * is put in "bufp".
10190 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
10191 * Returns OK on success, FAIL on failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010192 */
10193 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +010010194get_short_pathname(char_u **fnamep, char_u **bufp, int *fnamelen)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010195{
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010196 int l, len;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010197 char_u *newbuf;
10198
10199 len = *fnamelen;
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +010010200 l = GetShortPathName((LPSTR)*fnamep, (LPSTR)*fnamep, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010201 if (l > len - 1)
10202 {
10203 /* If that doesn't work (not enough space), then save the string
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010204 * and try again with a new buffer big enough. */
Bram Moolenaar071d4272004-06-13 20:20:40 +000010205 newbuf = vim_strnsave(*fnamep, l);
10206 if (newbuf == NULL)
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010207 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010208
10209 vim_free(*bufp);
10210 *fnamep = *bufp = newbuf;
10211
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010212 /* Really should always succeed, as the buffer is big enough. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +010010213 l = GetShortPathName((LPSTR)*fnamep, (LPSTR)*fnamep, l+1);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010214 }
10215
10216 *fnamelen = l;
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010217 return OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010218}
10219
10220/*
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010221 * Get the short path (8.3) for the filename in "fname". The converted
10222 * path is returned in "bufp".
10223 *
10224 * Some of the directories specified in "fname" may not exist. This function
10225 * will shorten the existing directories at the beginning of the path and then
10226 * append the remaining non-existing path.
10227 *
10228 * fname - Pointer to the filename to shorten. On return, contains the
Bram Moolenaar2c704a72010-06-03 21:17:25 +020010229 * pointer to the shortened pathname
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010230 * bufp - Pointer to an allocated buffer for the filename.
10231 * fnamelen - Length of the filename pointed to by fname
10232 *
10233 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
Bram Moolenaar071d4272004-06-13 20:20:40 +000010234 */
10235 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +010010236shortpath_for_invalid_fname(
10237 char_u **fname,
10238 char_u **bufp,
10239 int *fnamelen)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010240{
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010241 char_u *short_fname, *save_fname, *pbuf_unused;
10242 char_u *endp, *save_endp;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010243 char_u ch;
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010244 int old_len, len;
10245 int new_len, sfx_len;
10246 int retval = OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010247
10248 /* Make a copy */
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010249 old_len = *fnamelen;
10250 save_fname = vim_strnsave(*fname, old_len);
10251 pbuf_unused = NULL;
10252 short_fname = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010253
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010254 endp = save_fname + old_len - 1; /* Find the end of the copy */
10255 save_endp = endp;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010256
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010257 /*
10258 * Try shortening the supplied path till it succeeds by removing one
10259 * directory at a time from the tail of the path.
10260 */
10261 len = 0;
10262 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010263 {
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010264 /* go back one path-separator */
10265 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
10266 --endp;
10267 if (endp <= save_fname)
10268 break; /* processed the complete path */
10269
10270 /*
10271 * Replace the path separator with a NUL and try to shorten the
10272 * resulting path.
10273 */
10274 ch = *endp;
10275 *endp = 0;
10276 short_fname = save_fname;
Bram Moolenaarc236c162008-07-13 17:41:49 +000010277 len = (int)STRLEN(short_fname) + 1;
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010278 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
10279 {
10280 retval = FAIL;
10281 goto theend;
10282 }
10283 *endp = ch; /* preserve the string */
10284
10285 if (len > 0)
10286 break; /* successfully shortened the path */
10287
10288 /* failed to shorten the path. Skip the path separator */
10289 --endp;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010290 }
10291
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010292 if (len > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010293 {
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010294 /*
10295 * Succeeded in shortening the path. Now concatenate the shortened
10296 * path with the remaining path at the tail.
10297 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000010298
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010299 /* Compute the length of the new path. */
10300 sfx_len = (int)(save_endp - endp) + 1;
10301 new_len = len + sfx_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010302
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010303 *fnamelen = new_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010304 vim_free(*bufp);
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010305 if (new_len > old_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010306 {
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010307 /* There is not enough space in the currently allocated string,
10308 * copy it to a buffer big enough. */
10309 *fname = *bufp = vim_strnsave(short_fname, new_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010310 if (*fname == NULL)
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010311 {
10312 retval = FAIL;
10313 goto theend;
10314 }
Bram Moolenaar071d4272004-06-13 20:20:40 +000010315 }
10316 else
10317 {
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010318 /* Transfer short_fname to the main buffer (it's big enough),
10319 * unless get_short_pathname() did its work in-place. */
10320 *fname = *bufp = save_fname;
10321 if (short_fname != save_fname)
10322 vim_strncpy(save_fname, short_fname, len);
10323 save_fname = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010324 }
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010325
10326 /* concat the not-shortened part of the path */
10327 vim_strncpy(*fname + len, endp, sfx_len);
10328 (*fname)[new_len] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010329 }
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010330
10331theend:
10332 vim_free(pbuf_unused);
10333 vim_free(save_fname);
10334
10335 return retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010336}
10337
10338/*
10339 * Get a pathname for a partial path.
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010340 * Returns OK for success, FAIL for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010341 */
10342 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +010010343shortpath_for_partial(
10344 char_u **fnamep,
10345 char_u **bufp,
10346 int *fnamelen)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010347{
10348 int sepcount, len, tflen;
10349 char_u *p;
10350 char_u *pbuf, *tfname;
10351 int hasTilde;
10352
Bram Moolenaar8c8de832008-06-24 22:58:06 +000010353 /* Count up the path separators from the RHS.. so we know which part
10354 * of the path to return. */
Bram Moolenaar071d4272004-06-13 20:20:40 +000010355 sepcount = 0;
Bram Moolenaar91acfff2017-03-12 19:22:36 +010010356 for (p = *fnamep; p < *fnamep + *fnamelen; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +000010357 if (vim_ispathsep(*p))
10358 ++sepcount;
10359
10360 /* Need full path first (use expand_env() to remove a "~/") */
10361 hasTilde = (**fnamep == '~');
10362 if (hasTilde)
10363 pbuf = tfname = expand_env_save(*fnamep);
10364 else
10365 pbuf = tfname = FullName_save(*fnamep, FALSE);
10366
Bram Moolenaara93fa7e2006-04-17 22:14:47 +000010367 len = tflen = (int)STRLEN(tfname);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010368
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010369 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
10370 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010371
10372 if (len == 0)
10373 {
10374 /* Don't have a valid filename, so shorten the rest of the
10375 * path if we can. This CAN give us invalid 8.3 filenames, but
10376 * there's not a lot of point in guessing what it might be.
10377 */
10378 len = tflen;
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010379 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
10380 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010381 }
10382
10383 /* Count the paths backward to find the beginning of the desired string. */
10384 for (p = tfname + len - 1; p >= tfname; --p)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000010385 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000010386 if (has_mbyte)
10387 p -= mb_head_off(tfname, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010388 if (vim_ispathsep(*p))
10389 {
10390 if (sepcount == 0 || (hasTilde && sepcount == 1))
10391 break;
10392 else
10393 sepcount --;
10394 }
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000010395 }
Bram Moolenaar071d4272004-06-13 20:20:40 +000010396 if (hasTilde)
10397 {
10398 --p;
10399 if (p >= tfname)
10400 *p = '~';
10401 else
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010402 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010403 }
10404 else
10405 ++p;
10406
10407 /* Copy in the string - p indexes into tfname - allocated at pbuf */
10408 vim_free(*bufp);
10409 *fnamelen = (int)STRLEN(p);
10410 *bufp = pbuf;
10411 *fnamep = p;
10412
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010413 return OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010414}
Bram Moolenaar4f974752019-02-17 17:44:42 +010010415#endif // MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +000010416
10417/*
10418 * Adjust a filename, according to a string of modifiers.
10419 * *fnamep must be NUL terminated when called. When returning, the length is
10420 * determined by *fnamelen.
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010421 * Returns VALID_ flags or -1 for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010422 * When there is an error, *fnamep is set to NULL.
10423 */
10424 int
Bram Moolenaar7454a062016-01-30 15:14:10 +010010425modify_fname(
Bram Moolenaar00136dc2018-07-25 21:19:13 +020010426 char_u *src, // string with modifiers
10427 int tilde_file, // "~" is a file name, not $HOME
10428 int *usedlen, // characters after src that are used
10429 char_u **fnamep, // file name so far
10430 char_u **bufp, // buffer for allocated file name or NULL
10431 int *fnamelen) // length of fnamep
Bram Moolenaar071d4272004-06-13 20:20:40 +000010432{
10433 int valid = 0;
10434 char_u *tail;
10435 char_u *s, *p, *pbuf;
10436 char_u dirname[MAXPATHL];
10437 int c;
10438 int has_fullname = 0;
Bram Moolenaar4f974752019-02-17 17:44:42 +010010439#ifdef MSWIN
Bram Moolenaardc935552011-08-17 15:23:23 +020010440 char_u *fname_start = *fnamep;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010441 int has_shortname = 0;
10442#endif
10443
10444repeat:
10445 /* ":p" - full path/file_name */
10446 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
10447 {
10448 has_fullname = 1;
10449
10450 valid |= VALID_PATH;
10451 *usedlen += 2;
10452
10453 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
10454 if ((*fnamep)[0] == '~'
10455#if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
10456 && ((*fnamep)[1] == '/'
10457# ifdef BACKSLASH_IN_FILENAME
10458 || (*fnamep)[1] == '\\'
10459# endif
10460 || (*fnamep)[1] == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010461#endif
Bram Moolenaar00136dc2018-07-25 21:19:13 +020010462 && !(tilde_file && (*fnamep)[1] == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010463 )
10464 {
10465 *fnamep = expand_env_save(*fnamep);
10466 vim_free(*bufp); /* free any allocated file name */
10467 *bufp = *fnamep;
10468 if (*fnamep == NULL)
10469 return -1;
10470 }
10471
10472 /* When "/." or "/.." is used: force expansion to get rid of it. */
Bram Moolenaar91acfff2017-03-12 19:22:36 +010010473 for (p = *fnamep; *p != NUL; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +000010474 {
10475 if (vim_ispathsep(*p)
10476 && p[1] == '.'
10477 && (p[2] == NUL
10478 || vim_ispathsep(p[2])
10479 || (p[2] == '.'
10480 && (p[3] == NUL || vim_ispathsep(p[3])))))
10481 break;
10482 }
10483
10484 /* FullName_save() is slow, don't use it when not needed. */
10485 if (*p != NUL || !vim_isAbsName(*fnamep))
10486 {
10487 *fnamep = FullName_save(*fnamep, *p != NUL);
10488 vim_free(*bufp); /* free any allocated file name */
10489 *bufp = *fnamep;
10490 if (*fnamep == NULL)
10491 return -1;
10492 }
10493
Bram Moolenaar4f974752019-02-17 17:44:42 +010010494#ifdef MSWIN
Bram Moolenaar9158f9e2012-06-20 14:02:27 +020010495# if _WIN32_WINNT >= 0x0500
10496 if (vim_strchr(*fnamep, '~') != NULL)
10497 {
Bram Moolenaar2d04a912019-03-30 20:04:08 +010010498 // Expand 8.3 filename to full path. Needed to make sure the same
10499 // file does not have two different names.
10500 // Note: problem does not occur if _WIN32_WINNT < 0x0500.
10501 WCHAR *wfname = enc_to_utf16(*fnamep, NULL);
10502 WCHAR buf[_MAX_PATH];
10503
10504 if (wfname != NULL)
Bram Moolenaar9158f9e2012-06-20 14:02:27 +020010505 {
Bram Moolenaar2d04a912019-03-30 20:04:08 +010010506 if (GetLongPathNameW(wfname, buf, _MAX_PATH))
Bram Moolenaar9158f9e2012-06-20 14:02:27 +020010507 {
Bram Moolenaar2d04a912019-03-30 20:04:08 +010010508 char_u *p = utf16_to_enc(buf, NULL);
10509
10510 if (p != NULL)
10511 {
10512 vim_free(*bufp); // free any allocated file name
10513 *bufp = *fnamep = p;
10514 }
Bram Moolenaar9158f9e2012-06-20 14:02:27 +020010515 }
Bram Moolenaar2d04a912019-03-30 20:04:08 +010010516 vim_free(wfname);
Bram Moolenaar9158f9e2012-06-20 14:02:27 +020010517 }
10518 }
10519# endif
10520#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000010521 /* Append a path separator to a directory. */
10522 if (mch_isdir(*fnamep))
10523 {
10524 /* Make room for one or two extra characters. */
10525 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
10526 vim_free(*bufp); /* free any allocated file name */
10527 *bufp = *fnamep;
10528 if (*fnamep == NULL)
10529 return -1;
10530 add_pathsep(*fnamep);
10531 }
10532 }
10533
10534 /* ":." - path relative to the current directory */
10535 /* ":~" - path relative to the home directory */
10536 /* ":8" - shortname path - postponed till after */
10537 while (src[*usedlen] == ':'
10538 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
10539 {
10540 *usedlen += 2;
10541 if (c == '8')
10542 {
Bram Moolenaar4f974752019-02-17 17:44:42 +010010543#ifdef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +000010544 has_shortname = 1; /* Postpone this. */
10545#endif
10546 continue;
10547 }
10548 pbuf = NULL;
10549 /* Need full path first (use expand_env() to remove a "~/") */
10550 if (!has_fullname)
10551 {
10552 if (c == '.' && **fnamep == '~')
10553 p = pbuf = expand_env_save(*fnamep);
10554 else
10555 p = pbuf = FullName_save(*fnamep, FALSE);
10556 }
10557 else
10558 p = *fnamep;
10559
10560 has_fullname = 0;
10561
10562 if (p != NULL)
10563 {
10564 if (c == '.')
10565 {
10566 mch_dirname(dirname, MAXPATHL);
10567 s = shorten_fname(p, dirname);
10568 if (s != NULL)
10569 {
10570 *fnamep = s;
10571 if (pbuf != NULL)
10572 {
10573 vim_free(*bufp); /* free any allocated file name */
10574 *bufp = pbuf;
10575 pbuf = NULL;
10576 }
10577 }
10578 }
10579 else
10580 {
10581 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
10582 /* Only replace it when it starts with '~' */
10583 if (*dirname == '~')
10584 {
10585 s = vim_strsave(dirname);
10586 if (s != NULL)
10587 {
10588 *fnamep = s;
10589 vim_free(*bufp);
10590 *bufp = s;
10591 }
10592 }
10593 }
10594 vim_free(pbuf);
10595 }
10596 }
10597
10598 tail = gettail(*fnamep);
10599 *fnamelen = (int)STRLEN(*fnamep);
10600
10601 /* ":h" - head, remove "/file_name", can be repeated */
10602 /* Don't remove the first "/" or "c:\" */
10603 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
10604 {
10605 valid |= VALID_HEAD;
10606 *usedlen += 2;
10607 s = get_past_head(*fnamep);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000010608 while (tail > s && after_pathsep(s, tail))
Bram Moolenaar91acfff2017-03-12 19:22:36 +010010609 MB_PTR_BACK(*fnamep, tail);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010610 *fnamelen = (int)(tail - *fnamep);
10611#ifdef VMS
10612 if (*fnamelen > 0)
10613 *fnamelen += 1; /* the path separator is part of the path */
10614#endif
Bram Moolenaar5461cfe2007-09-25 18:40:14 +000010615 if (*fnamelen == 0)
10616 {
10617 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
10618 p = vim_strsave((char_u *)".");
10619 if (p == NULL)
10620 return -1;
10621 vim_free(*bufp);
10622 *bufp = *fnamep = tail = p;
10623 *fnamelen = 1;
10624 }
10625 else
10626 {
10627 while (tail > s && !after_pathsep(s, tail))
Bram Moolenaar91acfff2017-03-12 19:22:36 +010010628 MB_PTR_BACK(*fnamep, tail);
Bram Moolenaar5461cfe2007-09-25 18:40:14 +000010629 }
Bram Moolenaar071d4272004-06-13 20:20:40 +000010630 }
10631
10632 /* ":8" - shortname */
10633 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
10634 {
10635 *usedlen += 2;
Bram Moolenaar4f974752019-02-17 17:44:42 +010010636#ifdef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +000010637 has_shortname = 1;
10638#endif
10639 }
10640
Bram Moolenaar4f974752019-02-17 17:44:42 +010010641#ifdef MSWIN
Bram Moolenaardc935552011-08-17 15:23:23 +020010642 /*
10643 * Handle ":8" after we have done 'heads' and before we do 'tails'.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010644 */
10645 if (has_shortname)
10646 {
Bram Moolenaardc935552011-08-17 15:23:23 +020010647 /* Copy the string if it is shortened by :h and when it wasn't copied
10648 * yet, because we are going to change it in place. Avoids changing
10649 * the buffer name for "%:8". */
10650 if (*fnamelen < (int)STRLEN(*fnamep) || *fnamep == fname_start)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010651 {
10652 p = vim_strnsave(*fnamep, *fnamelen);
Bram Moolenaardc935552011-08-17 15:23:23 +020010653 if (p == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010654 return -1;
10655 vim_free(*bufp);
10656 *bufp = *fnamep = p;
10657 }
10658
10659 /* Split into two implementations - makes it easier. First is where
Bram Moolenaardc935552011-08-17 15:23:23 +020010660 * there isn't a full name already, second is where there is. */
Bram Moolenaar071d4272004-06-13 20:20:40 +000010661 if (!has_fullname && !vim_isAbsName(*fnamep))
10662 {
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010663 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010664 return -1;
10665 }
10666 else
10667 {
Bram Moolenaardc935552011-08-17 15:23:23 +020010668 int l = *fnamelen;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010669
Bram Moolenaardc935552011-08-17 15:23:23 +020010670 /* Simple case, already have the full-name.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010671 * Nearly always shorter, so try first time. */
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010672 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010673 return -1;
10674
10675 if (l == 0)
10676 {
Bram Moolenaardc935552011-08-17 15:23:23 +020010677 /* Couldn't find the filename, search the paths. */
Bram Moolenaar071d4272004-06-13 20:20:40 +000010678 l = *fnamelen;
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010679 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010680 return -1;
10681 }
10682 *fnamelen = l;
10683 }
10684 }
Bram Moolenaar4f974752019-02-17 17:44:42 +010010685#endif // MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +000010686
10687 /* ":t" - tail, just the basename */
10688 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
10689 {
10690 *usedlen += 2;
10691 *fnamelen -= (int)(tail - *fnamep);
10692 *fnamep = tail;
10693 }
10694
10695 /* ":e" - extension, can be repeated */
10696 /* ":r" - root, without extension, can be repeated */
10697 while (src[*usedlen] == ':'
10698 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
10699 {
10700 /* find a '.' in the tail:
10701 * - for second :e: before the current fname
10702 * - otherwise: The last '.'
10703 */
10704 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
10705 s = *fnamep - 2;
10706 else
10707 s = *fnamep + *fnamelen - 1;
10708 for ( ; s > tail; --s)
10709 if (s[0] == '.')
10710 break;
10711 if (src[*usedlen + 1] == 'e') /* :e */
10712 {
10713 if (s > tail)
10714 {
10715 *fnamelen += (int)(*fnamep - (s + 1));
10716 *fnamep = s + 1;
10717#ifdef VMS
10718 /* cut version from the extension */
10719 s = *fnamep + *fnamelen - 1;
10720 for ( ; s > *fnamep; --s)
10721 if (s[0] == ';')
10722 break;
10723 if (s > *fnamep)
10724 *fnamelen = s - *fnamep;
10725#endif
10726 }
10727 else if (*fnamep <= tail)
10728 *fnamelen = 0;
10729 }
10730 else /* :r */
10731 {
10732 if (s > tail) /* remove one extension */
10733 *fnamelen = (int)(s - *fnamep);
10734 }
10735 *usedlen += 2;
10736 }
10737
10738 /* ":s?pat?foo?" - substitute */
10739 /* ":gs?pat?foo?" - global substitute */
10740 if (src[*usedlen] == ':'
10741 && (src[*usedlen + 1] == 's'
10742 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
10743 {
10744 char_u *str;
10745 char_u *pat;
10746 char_u *sub;
10747 int sep;
10748 char_u *flags;
10749 int didit = FALSE;
10750
10751 flags = (char_u *)"";
10752 s = src + *usedlen + 2;
10753 if (src[*usedlen + 1] == 'g')
10754 {
10755 flags = (char_u *)"g";
10756 ++s;
10757 }
10758
10759 sep = *s++;
10760 if (sep)
10761 {
10762 /* find end of pattern */
10763 p = vim_strchr(s, sep);
10764 if (p != NULL)
10765 {
10766 pat = vim_strnsave(s, (int)(p - s));
10767 if (pat != NULL)
10768 {
10769 s = p + 1;
10770 /* find end of substitution */
10771 p = vim_strchr(s, sep);
10772 if (p != NULL)
10773 {
10774 sub = vim_strnsave(s, (int)(p - s));
10775 str = vim_strnsave(*fnamep, *fnamelen);
10776 if (sub != NULL && str != NULL)
10777 {
10778 *usedlen = (int)(p + 1 - src);
Bram Moolenaar72ab7292016-07-19 19:10:51 +020010779 s = do_string_sub(str, pat, sub, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010780 if (s != NULL)
10781 {
10782 *fnamep = s;
10783 *fnamelen = (int)STRLEN(s);
10784 vim_free(*bufp);
10785 *bufp = s;
10786 didit = TRUE;
10787 }
10788 }
10789 vim_free(sub);
10790 vim_free(str);
10791 }
10792 vim_free(pat);
10793 }
10794 }
10795 /* after using ":s", repeat all the modifiers */
10796 if (didit)
10797 goto repeat;
10798 }
10799 }
10800
Bram Moolenaar26df0922014-02-23 23:39:13 +010010801 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'S')
10802 {
Bram Moolenaar5ca84ce2016-03-23 22:28:25 +010010803 /* vim_strsave_shellescape() needs a NUL terminated string. */
Bram Moolenaard4caf5c2016-03-24 19:14:35 +010010804 c = (*fnamep)[*fnamelen];
Bram Moolenaar52c6eaf2016-03-25 18:42:46 +010010805 if (c != NUL)
10806 (*fnamep)[*fnamelen] = NUL;
Bram Moolenaar26df0922014-02-23 23:39:13 +010010807 p = vim_strsave_shellescape(*fnamep, FALSE, FALSE);
Bram Moolenaar52c6eaf2016-03-25 18:42:46 +010010808 if (c != NUL)
10809 (*fnamep)[*fnamelen] = c;
Bram Moolenaar26df0922014-02-23 23:39:13 +010010810 if (p == NULL)
10811 return -1;
10812 vim_free(*bufp);
10813 *bufp = *fnamep = p;
10814 *fnamelen = (int)STRLEN(p);
10815 *usedlen += 2;
10816 }
10817
Bram Moolenaar071d4272004-06-13 20:20:40 +000010818 return valid;
10819}
10820
10821/*
10822 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
Bram Moolenaar72ab7292016-07-19 19:10:51 +020010823 * When "sub" is NULL "expr" is used, must be a VAR_FUNC or VAR_PARTIAL.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010824 * "flags" can be "g" to do a global substitute.
10825 * Returns an allocated string, NULL for error.
10826 */
10827 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +010010828do_string_sub(
10829 char_u *str,
10830 char_u *pat,
10831 char_u *sub,
Bram Moolenaar72ab7292016-07-19 19:10:51 +020010832 typval_T *expr,
Bram Moolenaar7454a062016-01-30 15:14:10 +010010833 char_u *flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010834{
10835 int sublen;
10836 regmatch_T regmatch;
10837 int i;
10838 int do_all;
10839 char_u *tail;
Bram Moolenaare90c8532014-11-05 16:03:44 +010010840 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010841 garray_T ga;
10842 char_u *ret;
10843 char_u *save_cpo;
Bram Moolenaar8af26912014-01-23 20:09:34 +010010844 char_u *zero_width = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010845
10846 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
10847 save_cpo = p_cpo;
Bram Moolenaar9c24ccc2008-07-14 21:05:15 +000010848 p_cpo = empty_option;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010849
10850 ga_init2(&ga, 1, 200);
10851
10852 do_all = (flags[0] == 'g');
10853
10854 regmatch.rm_ic = p_ic;
10855 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
10856 if (regmatch.regprog != NULL)
10857 {
10858 tail = str;
Bram Moolenaare90c8532014-11-05 16:03:44 +010010859 end = str + STRLEN(str);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010860 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
10861 {
Bram Moolenaar8af26912014-01-23 20:09:34 +010010862 /* Skip empty match except for first match. */
10863 if (regmatch.startp[0] == regmatch.endp[0])
10864 {
10865 if (zero_width == regmatch.startp[0])
10866 {
10867 /* avoid getting stuck on a match with an empty string */
Bram Moolenaar8e7048c2014-06-12 18:39:22 +020010868 i = MB_PTR2LEN(tail);
10869 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail,
10870 (size_t)i);
10871 ga.ga_len += i;
10872 tail += i;
Bram Moolenaar8af26912014-01-23 20:09:34 +010010873 continue;
10874 }
10875 zero_width = regmatch.startp[0];
10876 }
10877
Bram Moolenaar071d4272004-06-13 20:20:40 +000010878 /*
10879 * Get some space for a temporary buffer to do the substitution
10880 * into. It will contain:
10881 * - The text up to where the match is.
10882 * - The substituted text.
10883 * - The text after the match.
10884 */
Bram Moolenaar72ab7292016-07-19 19:10:51 +020010885 sublen = vim_regsub(&regmatch, sub, expr, tail, FALSE, TRUE, FALSE);
Bram Moolenaare90c8532014-11-05 16:03:44 +010010886 if (ga_grow(&ga, (int)((end - tail) + sublen -
Bram Moolenaar071d4272004-06-13 20:20:40 +000010887 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
10888 {
10889 ga_clear(&ga);
10890 break;
10891 }
10892
10893 /* copy the text up to where the match is */
10894 i = (int)(regmatch.startp[0] - tail);
10895 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
10896 /* add the substituted text */
Bram Moolenaar72ab7292016-07-19 19:10:51 +020010897 (void)vim_regsub(&regmatch, sub, expr, (char_u *)ga.ga_data
Bram Moolenaar071d4272004-06-13 20:20:40 +000010898 + ga.ga_len + i, TRUE, TRUE, FALSE);
10899 ga.ga_len += i + sublen - 1;
Bram Moolenaarceb84af2013-09-29 21:11:05 +020010900 tail = regmatch.endp[0];
10901 if (*tail == NUL)
10902 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010903 if (!do_all)
10904 break;
10905 }
10906
10907 if (ga.ga_data != NULL)
10908 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
10909
Bram Moolenaar473de612013-06-08 18:19:48 +020010910 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010911 }
10912
10913 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
10914 ga_clear(&ga);
Bram Moolenaar9c24ccc2008-07-14 21:05:15 +000010915 if (p_cpo == empty_option)
10916 p_cpo = save_cpo;
10917 else
Bram Moolenaar72ab7292016-07-19 19:10:51 +020010918 /* Darn, evaluating {sub} expression or {expr} changed the value. */
Bram Moolenaar9c24ccc2008-07-14 21:05:15 +000010919 free_string_option(save_cpo);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010920
10921 return ret;
10922}
10923
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020010924 static int
10925filter_map_one(typval_T *tv, typval_T *expr, int map, int *remp)
10926{
10927 typval_T rettv;
10928 typval_T argv[3];
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020010929 int retval = FAIL;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020010930
10931 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
10932 argv[0] = vimvars[VV_KEY].vv_tv;
10933 argv[1] = vimvars[VV_VAL].vv_tv;
Bram Moolenaar48570482017-10-30 21:48:41 +010010934 if (eval_expr_typval(expr, argv, 2, &rettv) == FAIL)
10935 goto theend;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020010936 if (map)
10937 {
10938 /* map(): replace the list item value */
10939 clear_tv(tv);
10940 rettv.v_lock = 0;
10941 *tv = rettv;
10942 }
10943 else
10944 {
10945 int error = FALSE;
10946
10947 /* filter(): when expr is zero remove the item */
Bram Moolenaard155d7a2018-12-21 16:04:21 +010010948 *remp = (tv_get_number_chk(&rettv, &error) == 0);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020010949 clear_tv(&rettv);
10950 /* On type error, nothing has been removed; return FAIL to stop the
Bram Moolenaard155d7a2018-12-21 16:04:21 +010010951 * loop. The error message was given by tv_get_number_chk(). */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020010952 if (error)
10953 goto theend;
10954 }
10955 retval = OK;
10956theend:
10957 clear_tv(&vimvars[VV_VAL].vv_tv);
10958 return retval;
10959}
10960
10961
10962/*
10963 * Implementation of map() and filter().
10964 */
10965 void
10966filter_map(typval_T *argvars, typval_T *rettv, int map)
10967{
10968 typval_T *expr;
10969 listitem_T *li, *nli;
10970 list_T *l = NULL;
10971 dictitem_T *di;
10972 hashtab_T *ht;
10973 hashitem_T *hi;
10974 dict_T *d = NULL;
10975 typval_T save_val;
10976 typval_T save_key;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +010010977 blob_T *b = NULL;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020010978 int rem;
10979 int todo;
10980 char_u *ermsg = (char_u *)(map ? "map()" : "filter()");
10981 char_u *arg_errmsg = (char_u *)(map ? N_("map() argument")
10982 : N_("filter() argument"));
10983 int save_did_emsg;
10984 int idx = 0;
10985
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +010010986 if (argvars[0].v_type == VAR_BLOB)
10987 {
10988 if ((b = argvars[0].vval.v_blob) == NULL)
10989 return;
10990 }
10991 else if (argvars[0].v_type == VAR_LIST)
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020010992 {
10993 if ((l = argvars[0].vval.v_list) == NULL
Bram Moolenaar05c00c02019-02-11 22:00:11 +010010994 || (!map && var_check_lock(l->lv_lock, arg_errmsg, TRUE)))
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020010995 return;
10996 }
10997 else if (argvars[0].v_type == VAR_DICT)
10998 {
10999 if ((d = argvars[0].vval.v_dict) == NULL
Bram Moolenaar05c00c02019-02-11 22:00:11 +010011000 || (!map && var_check_lock(d->dv_lock, arg_errmsg, TRUE)))
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020011001 return;
11002 }
11003 else
11004 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +010011005 semsg(_(e_listdictarg), ermsg);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020011006 return;
11007 }
11008
11009 expr = &argvars[1];
11010 /* On type errors, the preceding call has already displayed an error
11011 * message. Avoid a misleading error message for an empty string that
11012 * was not passed as argument. */
11013 if (expr->v_type != VAR_UNKNOWN)
11014 {
11015 prepare_vimvar(VV_VAL, &save_val);
11016
11017 /* We reset "did_emsg" to be able to detect whether an error
11018 * occurred during evaluation of the expression. */
11019 save_did_emsg = did_emsg;
11020 did_emsg = FALSE;
11021
11022 prepare_vimvar(VV_KEY, &save_key);
11023 if (argvars[0].v_type == VAR_DICT)
11024 {
11025 vimvars[VV_KEY].vv_type = VAR_STRING;
11026
11027 ht = &d->dv_hashtab;
11028 hash_lock(ht);
11029 todo = (int)ht->ht_used;
11030 for (hi = ht->ht_array; todo > 0; ++hi)
11031 {
11032 if (!HASHITEM_EMPTY(hi))
11033 {
11034 int r;
11035
11036 --todo;
11037 di = HI2DI(hi);
Bram Moolenaar05c00c02019-02-11 22:00:11 +010011038 if (map && (var_check_lock(di->di_tv.v_lock,
11039 arg_errmsg, TRUE)
11040 || var_check_ro(di->di_flags,
11041 arg_errmsg, TRUE)))
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020011042 break;
11043 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
11044 r = filter_map_one(&di->di_tv, expr, map, &rem);
11045 clear_tv(&vimvars[VV_KEY].vv_tv);
11046 if (r == FAIL || did_emsg)
11047 break;
11048 if (!map && rem)
11049 {
11050 if (var_check_fixed(di->di_flags, arg_errmsg, TRUE)
11051 || var_check_ro(di->di_flags, arg_errmsg, TRUE))
11052 break;
11053 dictitem_remove(d, di);
11054 }
11055 }
11056 }
11057 hash_unlock(ht);
11058 }
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +010011059 else if (argvars[0].v_type == VAR_BLOB)
11060 {
11061 int i;
11062 typval_T tv;
11063
11064 vimvars[VV_KEY].vv_type = VAR_NUMBER;
11065 for (i = 0; i < b->bv_ga.ga_len; i++)
11066 {
11067 tv.v_type = VAR_NUMBER;
11068 tv.vval.v_number = blob_get(b, i);
11069 vimvars[VV_KEY].vv_nr = idx;
11070 if (filter_map_one(&tv, expr, map, &rem) == FAIL || did_emsg)
11071 break;
11072 if (tv.v_type != VAR_NUMBER)
11073 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +010011074 emsg(_(e_invalblob));
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +010011075 return;
11076 }
11077 tv.v_type = VAR_NUMBER;
11078 blob_set(b, i, tv.vval.v_number);
11079 if (!map && rem)
11080 {
11081 char_u *p = (char_u *)argvars[0].vval.v_blob->bv_ga.ga_data;
11082
11083 mch_memmove(p + idx, p + i + 1,
11084 (size_t)b->bv_ga.ga_len - i - 1);
11085 --b->bv_ga.ga_len;
11086 --i;
11087 }
11088 }
11089 }
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020011090 else
11091 {
Bram Moolenaarce9d50d2019-01-14 22:22:29 +010011092 // argvars[0].v_type == VAR_LIST
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020011093 vimvars[VV_KEY].vv_type = VAR_NUMBER;
11094
11095 for (li = l->lv_first; li != NULL; li = nli)
11096 {
Bram Moolenaar05c00c02019-02-11 22:00:11 +010011097 if (map && var_check_lock(li->li_tv.v_lock, arg_errmsg, TRUE))
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020011098 break;
11099 nli = li->li_next;
11100 vimvars[VV_KEY].vv_nr = idx;
11101 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
11102 || did_emsg)
11103 break;
11104 if (!map && rem)
11105 listitem_remove(l, li);
11106 ++idx;
11107 }
11108 }
11109
11110 restore_vimvar(VV_KEY, &save_key);
11111 restore_vimvar(VV_VAL, &save_val);
11112
11113 did_emsg |= save_did_emsg;
11114 }
11115
11116 copy_tv(&argvars[0], rettv);
11117}
11118
Bram Moolenaar071d4272004-06-13 20:20:40 +000011119#endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */