blob: fb417c8b419ab5afb30db176d1d6b6cb889bf7a2 [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
Bram Moolenaar18a4ba22019-05-24 19:39:03 +0200494 redir_lval = (lval_T *)alloc_clear(sizeof(lval_T));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +0000495 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 Moolenaar16e9b852019-05-19 19:59:35 +02004456 vim_str2nr(*arg, NULL, &len, STR2NR_ALL, &n, NULL, 0, TRUE);
4457 if (len == 0)
4458 {
4459 semsg(_(e_invexpr2), *arg);
4460 ret = FAIL;
4461 break;
4462 }
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004463 *arg += len;
4464 if (evaluate)
4465 {
4466 rettv->v_type = VAR_NUMBER;
4467 rettv->vval.v_number = n;
4468 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 }
4470 break;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004471 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472
4473 /*
4474 * String constant: "string".
4475 */
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004476 case '"': ret = get_string_tv(arg, rettv, evaluate);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 break;
4478
4479 /*
Bram Moolenaar8c711452005-01-14 21:53:12 +00004480 * Literal string constant: 'str''ing'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481 */
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004482 case '\'': ret = get_lit_string_tv(arg, rettv, evaluate);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004483 break;
4484
4485 /*
4486 * List: [expr, expr]
4487 */
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004488 case '[': ret = get_list_tv(arg, rettv, evaluate);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489 break;
4490
4491 /*
Bram Moolenaar069c1e72016-07-15 21:25:08 +02004492 * Lambda: {arg, arg -> expr}
Bram Moolenaar8c711452005-01-14 21:53:12 +00004493 * Dictionary: {key: val, key: val}
4494 */
Bram Moolenaar069c1e72016-07-15 21:25:08 +02004495 case '{': ret = get_lambda_tv(arg, rettv, evaluate);
4496 if (ret == NOTDONE)
Bram Moolenaar8f667172018-12-14 15:38:31 +01004497 ret = dict_get_tv(arg, rettv, evaluate);
Bram Moolenaar8c711452005-01-14 21:53:12 +00004498 break;
4499
4500 /*
Bram Moolenaare9a41262005-01-15 22:18:47 +00004501 * Option value: &name
Bram Moolenaar071d4272004-06-13 20:20:40 +00004502 */
Bram Moolenaare9a41262005-01-15 22:18:47 +00004503 case '&': ret = get_option_tv(arg, rettv, evaluate);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 break;
4505
4506 /*
4507 * Environment variable: $VAR.
4508 */
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004509 case '$': ret = get_env_tv(arg, rettv, evaluate);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510 break;
4511
4512 /*
4513 * Register contents: @r.
4514 */
4515 case '@': ++*arg;
4516 if (evaluate)
4517 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004518 rettv->v_type = VAR_STRING;
Bram Moolenaarb7cb42b2014-04-02 19:55:10 +02004519 rettv->vval.v_string = get_reg_contents(**arg,
4520 GREG_EXPR_SRC);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004521 }
4522 if (**arg != NUL)
4523 ++*arg;
4524 break;
4525
4526 /*
4527 * nested expression: (expression).
4528 */
4529 case '(': *arg = skipwhite(*arg + 1);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004530 ret = eval1(arg, rettv, evaluate); /* recursive! */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 if (**arg == ')')
4532 ++*arg;
4533 else if (ret == OK)
4534 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004535 emsg(_("E110: Missing ')'"));
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004536 clear_tv(rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537 ret = FAIL;
4538 }
4539 break;
4540
Bram Moolenaar8c711452005-01-14 21:53:12 +00004541 default: ret = NOTDONE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542 break;
4543 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00004544
4545 if (ret == NOTDONE)
4546 {
4547 /*
4548 * Must be a variable or function name.
4549 * Can also be a curly-braces kind of name: {expr}.
4550 */
4551 s = *arg;
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004552 len = get_name_len(arg, &alias, evaluate, TRUE);
Bram Moolenaar8c711452005-01-14 21:53:12 +00004553 if (alias != NULL)
4554 s = alias;
4555
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004556 if (len <= 0)
Bram Moolenaar8c711452005-01-14 21:53:12 +00004557 ret = FAIL;
4558 else
4559 {
4560 if (**arg == '(') /* recursive! */
4561 {
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004562 partial_T *partial;
4563
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004564 if (!evaluate)
4565 check_vars(s, len);
4566
Bram Moolenaar8c711452005-01-14 21:53:12 +00004567 /* If "s" is the name of a variable of type VAR_FUNC
4568 * use its contents. */
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004569 s = deref_func_name(s, &len, &partial, !evaluate);
Bram Moolenaar8c711452005-01-14 21:53:12 +00004570
Bram Moolenaar8a01f962016-11-14 21:50:00 +01004571 /* Need to make a copy, in case evaluating the arguments makes
4572 * the name invalid. */
4573 s = vim_strsave(s);
4574 if (s == NULL)
4575 ret = FAIL;
4576 else
4577 /* Invoke the function. */
4578 ret = get_func_tv(s, len, rettv, arg,
4579 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
4580 &len, evaluate, partial, NULL);
4581 vim_free(s);
Bram Moolenaare17c2602013-02-26 19:36:15 +01004582
4583 /* If evaluate is FALSE rettv->v_type was not set in
4584 * get_func_tv, but it's needed in handle_subscript() to parse
4585 * what follows. So set it here. */
4586 if (rettv->v_type == VAR_UNKNOWN && !evaluate && **arg == '(')
4587 {
Bram Moolenaar9ad73232016-06-01 22:08:17 +02004588 rettv->vval.v_string = NULL;
Bram Moolenaare17c2602013-02-26 19:36:15 +01004589 rettv->v_type = VAR_FUNC;
4590 }
4591
Bram Moolenaar8c711452005-01-14 21:53:12 +00004592 /* Stop the expression evaluation when immediately
4593 * aborting on error, or when an interrupt occurred or
4594 * an exception was thrown but not caught. */
4595 if (aborting())
4596 {
4597 if (ret == OK)
4598 clear_tv(rettv);
4599 ret = FAIL;
4600 }
4601 }
4602 else if (evaluate)
Bram Moolenaar1cd5e612015-05-04 11:10:27 +02004603 ret = get_var_tv(s, len, rettv, NULL, TRUE, FALSE);
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00004604 else
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004605 {
4606 check_vars(s, len);
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00004607 ret = OK;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004608 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00004609 }
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01004610 vim_free(alias);
Bram Moolenaar8c711452005-01-14 21:53:12 +00004611 }
4612
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613 *arg = skipwhite(*arg);
4614
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004615 /* Handle following '[', '(' and '.' for expr[expr], expr.name,
4616 * expr(expr). */
4617 if (ret == OK)
4618 ret = handle_subscript(arg, rettv, evaluate, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619
4620 /*
4621 * Apply logical NOT and unary '-', from right to left, ignore '+'.
4622 */
4623 if (ret == OK && evaluate && end_leader > start_leader)
4624 {
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004625 int error = FALSE;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004626 varnumber_T val = 0;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004627#ifdef FEAT_FLOAT
4628 float_T f = 0.0;
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004629
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004630 if (rettv->v_type == VAR_FLOAT)
4631 f = rettv->vval.v_float;
4632 else
4633#endif
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004634 val = tv_get_number_chk(rettv, &error);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004635 if (error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 {
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004637 clear_tv(rettv);
4638 ret = FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639 }
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004640 else
4641 {
4642 while (end_leader > start_leader)
4643 {
4644 --end_leader;
4645 if (*end_leader == '!')
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004646 {
4647#ifdef FEAT_FLOAT
4648 if (rettv->v_type == VAR_FLOAT)
4649 f = !f;
4650 else
4651#endif
4652 val = !val;
4653 }
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004654 else if (*end_leader == '-')
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004655 {
4656#ifdef FEAT_FLOAT
4657 if (rettv->v_type == VAR_FLOAT)
4658 f = -f;
4659 else
4660#endif
4661 val = -val;
4662 }
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004663 }
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004664#ifdef FEAT_FLOAT
4665 if (rettv->v_type == VAR_FLOAT)
4666 {
4667 clear_tv(rettv);
4668 rettv->vval.v_float = f;
4669 }
4670 else
4671#endif
4672 {
4673 clear_tv(rettv);
4674 rettv->v_type = VAR_NUMBER;
4675 rettv->vval.v_number = val;
4676 }
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004677 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 }
4679
4680 return ret;
4681}
4682
4683/*
Bram Moolenaar9e54a0e2006-04-14 20:42:25 +00004684 * Evaluate an "[expr]" or "[expr:expr]" index. Also "dict.key".
4685 * "*arg" points to the '[' or '.'.
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004686 * Returns FAIL or OK. "*arg" is advanced to after the ']'.
4687 */
4688 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01004689eval_index(
4690 char_u **arg,
4691 typval_T *rettv,
4692 int evaluate,
4693 int verbose) /* give error messages */
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004694{
4695 int empty1 = FALSE, empty2 = FALSE;
Bram Moolenaar33570922005-01-25 22:26:29 +00004696 typval_T var1, var2;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004697 long i;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004698 long n1, n2 = 0;
Bram Moolenaar8c711452005-01-14 21:53:12 +00004699 long len = -1;
4700 int range = FALSE;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004701 char_u *s;
Bram Moolenaar8c711452005-01-14 21:53:12 +00004702 char_u *key = NULL;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004703
Bram Moolenaara03f2332016-02-06 18:09:59 +01004704 switch (rettv->v_type)
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004705 {
Bram Moolenaara03f2332016-02-06 18:09:59 +01004706 case VAR_FUNC:
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004707 case VAR_PARTIAL:
Bram Moolenaara03f2332016-02-06 18:09:59 +01004708 if (verbose)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004709 emsg(_("E695: Cannot index a Funcref"));
Bram Moolenaara03f2332016-02-06 18:09:59 +01004710 return FAIL;
4711 case VAR_FLOAT:
Bram Moolenaar2a876e42013-06-12 22:08:58 +02004712#ifdef FEAT_FLOAT
Bram Moolenaara03f2332016-02-06 18:09:59 +01004713 if (verbose)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004714 emsg(_(e_float_as_string));
Bram Moolenaara03f2332016-02-06 18:09:59 +01004715 return FAIL;
Bram Moolenaar2a876e42013-06-12 22:08:58 +02004716#endif
Bram Moolenaara03f2332016-02-06 18:09:59 +01004717 case VAR_SPECIAL:
Bram Moolenaar835dc632016-02-07 14:27:38 +01004718 case VAR_JOB:
Bram Moolenaar77073442016-02-13 23:23:53 +01004719 case VAR_CHANNEL:
Bram Moolenaara03f2332016-02-06 18:09:59 +01004720 if (verbose)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004721 emsg(_("E909: Cannot index a special variable"));
Bram Moolenaara03f2332016-02-06 18:09:59 +01004722 return FAIL;
4723 case VAR_UNKNOWN:
4724 if (evaluate)
4725 return FAIL;
4726 /* FALLTHROUGH */
4727
4728 case VAR_STRING:
4729 case VAR_NUMBER:
4730 case VAR_LIST:
4731 case VAR_DICT:
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004732 case VAR_BLOB:
Bram Moolenaara03f2332016-02-06 18:09:59 +01004733 break;
Bram Moolenaar520e1e42016-01-23 19:46:28 +01004734 }
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004735
Bram Moolenaar0a38dd22015-08-25 16:49:01 +02004736 init_tv(&var1);
4737 init_tv(&var2);
Bram Moolenaar8c711452005-01-14 21:53:12 +00004738 if (**arg == '.')
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004739 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00004740 /*
4741 * dict.name
4742 */
4743 key = *arg + 1;
4744 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
4745 ;
4746 if (len == 0)
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004747 return FAIL;
Bram Moolenaar8c711452005-01-14 21:53:12 +00004748 *arg = skipwhite(key + len);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004749 }
4750 else
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004751 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00004752 /*
4753 * something[idx]
4754 *
4755 * Get the (first) variable from inside the [].
4756 */
4757 *arg = skipwhite(*arg + 1);
4758 if (**arg == ':')
4759 empty1 = TRUE;
4760 else if (eval1(arg, &var1, evaluate) == FAIL) /* recursive! */
4761 return FAIL;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004762 else if (evaluate && tv_get_string_chk(&var1) == NULL)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004763 {
4764 /* not a number or string */
4765 clear_tv(&var1);
4766 return FAIL;
4767 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00004768
4769 /*
4770 * Get the second variable from inside the [:].
4771 */
4772 if (**arg == ':')
4773 {
4774 range = TRUE;
4775 *arg = skipwhite(*arg + 1);
4776 if (**arg == ']')
4777 empty2 = TRUE;
4778 else if (eval1(arg, &var2, evaluate) == FAIL) /* recursive! */
4779 {
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004780 if (!empty1)
4781 clear_tv(&var1);
4782 return FAIL;
4783 }
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004784 else if (evaluate && tv_get_string_chk(&var2) == NULL)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00004785 {
4786 /* not a number or string */
4787 if (!empty1)
4788 clear_tv(&var1);
4789 clear_tv(&var2);
Bram Moolenaar8c711452005-01-14 21:53:12 +00004790 return FAIL;
4791 }
4792 }
4793
4794 /* Check for the ']'. */
4795 if (**arg != ']')
4796 {
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004797 if (verbose)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004798 emsg(_(e_missbrac));
Bram Moolenaar8c711452005-01-14 21:53:12 +00004799 clear_tv(&var1);
4800 if (range)
4801 clear_tv(&var2);
4802 return FAIL;
4803 }
4804 *arg = skipwhite(*arg + 1); /* skip the ']' */
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004805 }
4806
4807 if (evaluate)
4808 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00004809 n1 = 0;
4810 if (!empty1 && rettv->v_type != VAR_DICT)
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004811 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004812 n1 = tv_get_number(&var1);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004813 clear_tv(&var1);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004814 }
4815 if (range)
4816 {
4817 if (empty2)
4818 n2 = -1;
4819 else
4820 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004821 n2 = tv_get_number(&var2);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004822 clear_tv(&var2);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004823 }
4824 }
4825
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004826 switch (rettv->v_type)
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004827 {
Bram Moolenaar835dc632016-02-07 14:27:38 +01004828 case VAR_UNKNOWN:
Bram Moolenaara03f2332016-02-06 18:09:59 +01004829 case VAR_FUNC:
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004830 case VAR_PARTIAL:
Bram Moolenaara03f2332016-02-06 18:09:59 +01004831 case VAR_FLOAT:
Bram Moolenaar835dc632016-02-07 14:27:38 +01004832 case VAR_SPECIAL:
4833 case VAR_JOB:
Bram Moolenaar77073442016-02-13 23:23:53 +01004834 case VAR_CHANNEL:
Bram Moolenaara03f2332016-02-06 18:09:59 +01004835 break; /* not evaluating, skipping over subscript */
4836
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004837 case VAR_NUMBER:
4838 case VAR_STRING:
Bram Moolenaard155d7a2018-12-21 16:04:21 +01004839 s = tv_get_string(rettv);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004840 len = (long)STRLEN(s);
4841 if (range)
4842 {
4843 /* The resulting variable is a substring. If the indexes
4844 * are out of range the result is empty. */
4845 if (n1 < 0)
4846 {
4847 n1 = len + n1;
4848 if (n1 < 0)
4849 n1 = 0;
4850 }
4851 if (n2 < 0)
4852 n2 = len + n2;
4853 else if (n2 >= len)
4854 n2 = len;
4855 if (n1 >= len || n2 < 0 || n1 > n2)
4856 s = NULL;
4857 else
4858 s = vim_strnsave(s + n1, (int)(n2 - n1 + 1));
4859 }
4860 else
4861 {
4862 /* The resulting variable is a string of a single
4863 * character. If the index is too big or negative the
4864 * result is empty. */
4865 if (n1 >= len || n1 < 0)
4866 s = NULL;
4867 else
4868 s = vim_strnsave(s + n1, 1);
4869 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004870 clear_tv(rettv);
4871 rettv->v_type = VAR_STRING;
4872 rettv->vval.v_string = s;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004873 break;
4874
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004875 case VAR_BLOB:
4876 len = blob_len(rettv->vval.v_blob);
4877 if (range)
4878 {
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01004879 // The resulting variable is a sub-blob. If the indexes
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004880 // are out of range the result is empty.
4881 if (n1 < 0)
4882 {
4883 n1 = len + n1;
4884 if (n1 < 0)
4885 n1 = 0;
4886 }
4887 if (n2 < 0)
4888 n2 = len + n2;
4889 else if (n2 >= len)
4890 n2 = len - 1;
4891 if (n1 >= len || n2 < 0 || n1 > n2)
4892 {
4893 clear_tv(rettv);
4894 rettv->v_type = VAR_BLOB;
4895 rettv->vval.v_blob = NULL;
4896 }
4897 else
4898 {
4899 blob_T *blob = blob_alloc();
4900
4901 if (blob != NULL)
4902 {
4903 if (ga_grow(&blob->bv_ga, n2 - n1 + 1) == FAIL)
4904 {
4905 blob_free(blob);
4906 return FAIL;
4907 }
4908 blob->bv_ga.ga_len = n2 - n1 + 1;
4909 for (i = n1; i <= n2; i++)
4910 blob_set(blob, i - n1,
4911 blob_get(rettv->vval.v_blob, i));
4912
4913 clear_tv(rettv);
4914 rettv_blob_set(rettv, blob);
4915 }
4916 }
4917 }
4918 else
4919 {
Bram Moolenaara5be9b62019-01-24 12:31:44 +01004920 // The resulting variable is a byte value.
4921 // If the index is too big or negative that is an error.
4922 if (n1 < 0)
4923 n1 = len + n1;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004924 if (n1 < len && n1 >= 0)
4925 {
Bram Moolenaara5be9b62019-01-24 12:31:44 +01004926 int v = blob_get(rettv->vval.v_blob, n1);
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004927
4928 clear_tv(rettv);
4929 rettv->v_type = VAR_NUMBER;
4930 rettv->vval.v_number = v;
4931 }
4932 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004933 semsg(_(e_blobidx), n1);
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01004934 }
4935 break;
4936
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004937 case VAR_LIST:
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004938 len = list_len(rettv->vval.v_list);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004939 if (n1 < 0)
4940 n1 = len + n1;
4941 if (!empty1 && (n1 < 0 || n1 >= len))
4942 {
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004943 /* For a range we allow invalid values and return an empty
4944 * list. A list index out of range is an error. */
4945 if (!range)
4946 {
4947 if (verbose)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004948 semsg(_(e_listidx), n1);
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004949 return FAIL;
4950 }
4951 n1 = len;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004952 }
4953 if (range)
4954 {
Bram Moolenaar33570922005-01-25 22:26:29 +00004955 list_T *l;
4956 listitem_T *item;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004957
4958 if (n2 < 0)
4959 n2 = len + n2;
Bram Moolenaar9e54a0e2006-04-14 20:42:25 +00004960 else if (n2 >= len)
4961 n2 = len - 1;
4962 if (!empty2 && (n2 < 0 || n2 + 1 < n1))
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004963 n2 = -1;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004964 l = list_alloc();
4965 if (l == NULL)
4966 return FAIL;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004967 for (item = list_find(rettv->vval.v_list, n1);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004968 n1 <= n2; ++n1)
4969 {
4970 if (list_append_tv(l, &item->li_tv) == FAIL)
4971 {
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02004972 list_free(l);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004973 return FAIL;
4974 }
4975 item = item->li_next;
4976 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004977 clear_tv(rettv);
Bram Moolenaar45cf6e92017-04-30 20:25:19 +02004978 rettv_list_set(rettv, l);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004979 }
4980 else
4981 {
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004982 copy_tv(&list_find(rettv->vval.v_list, n1)->li_tv, &var1);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00004983 clear_tv(rettv);
4984 *rettv = var1;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00004985 }
4986 break;
Bram Moolenaar8c711452005-01-14 21:53:12 +00004987
4988 case VAR_DICT:
4989 if (range)
4990 {
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004991 if (verbose)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004992 emsg(_(e_dictrange));
Bram Moolenaar8c711452005-01-14 21:53:12 +00004993 if (len == -1)
4994 clear_tv(&var1);
4995 return FAIL;
4996 }
4997 {
Bram Moolenaar33570922005-01-25 22:26:29 +00004998 dictitem_T *item;
Bram Moolenaar8c711452005-01-14 21:53:12 +00004999
5000 if (len == -1)
5001 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01005002 key = tv_get_string_chk(&var1);
Bram Moolenaar0921ecf2016-04-03 22:44:36 +02005003 if (key == NULL)
Bram Moolenaar8c711452005-01-14 21:53:12 +00005004 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00005005 clear_tv(&var1);
5006 return FAIL;
5007 }
5008 }
5009
Bram Moolenaarce5e58e2005-01-19 22:24:34 +00005010 item = dict_find(rettv->vval.v_dict, key, (int)len);
Bram Moolenaar8c711452005-01-14 21:53:12 +00005011
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00005012 if (item == NULL && verbose)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005013 semsg(_(e_dictkey), key);
Bram Moolenaar8c711452005-01-14 21:53:12 +00005014 if (len == -1)
5015 clear_tv(&var1);
5016 if (item == NULL)
5017 return FAIL;
5018
5019 copy_tv(&item->di_tv, &var1);
5020 clear_tv(rettv);
5021 *rettv = var1;
5022 }
5023 break;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00005024 }
5025 }
5026
Bram Moolenaar49cd9572005-01-03 21:06:01 +00005027 return OK;
5028}
5029
5030/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031 * Get an option value.
5032 * "arg" points to the '&' or '+' before the option name.
5033 * "arg" is advanced to character after the option name.
5034 * Return OK or FAIL.
5035 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02005036 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005037get_option_tv(
5038 char_u **arg,
5039 typval_T *rettv, /* when NULL, only check if option exists */
5040 int evaluate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005041{
5042 char_u *option_end;
5043 long numval;
5044 char_u *stringval;
5045 int opt_type;
5046 int c;
5047 int working = (**arg == '+'); /* has("+option") */
5048 int ret = OK;
5049 int opt_flags;
5050
5051 /*
5052 * Isolate the option name and find its value.
5053 */
5054 option_end = find_option_end(arg, &opt_flags);
5055 if (option_end == NULL)
5056 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00005057 if (rettv != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005058 semsg(_("E112: Option name missing: %s"), *arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005059 return FAIL;
5060 }
5061
5062 if (!evaluate)
5063 {
5064 *arg = option_end;
5065 return OK;
5066 }
5067
5068 c = *option_end;
5069 *option_end = NUL;
5070 opt_type = get_option_value(*arg, &numval,
Bram Moolenaarc70646c2005-01-04 21:52:38 +00005071 rettv == NULL ? NULL : &stringval, opt_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072
5073 if (opt_type == -3) /* invalid name */
5074 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00005075 if (rettv != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005076 semsg(_("E113: Unknown option: %s"), *arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077 ret = FAIL;
5078 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00005079 else if (rettv != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005080 {
5081 if (opt_type == -2) /* hidden string option */
5082 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00005083 rettv->v_type = VAR_STRING;
5084 rettv->vval.v_string = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005085 }
5086 else if (opt_type == -1) /* hidden number option */
5087 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00005088 rettv->v_type = VAR_NUMBER;
5089 rettv->vval.v_number = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005090 }
5091 else if (opt_type == 1) /* number option */
5092 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00005093 rettv->v_type = VAR_NUMBER;
5094 rettv->vval.v_number = numval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005095 }
5096 else /* string option */
5097 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00005098 rettv->v_type = VAR_STRING;
5099 rettv->vval.v_string = stringval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100 }
5101 }
5102 else if (working && (opt_type == -2 || opt_type == -1))
5103 ret = FAIL;
5104
5105 *option_end = c; /* put back for error messages */
5106 *arg = option_end;
5107
5108 return ret;
5109}
5110
5111/*
5112 * Allocate a variable for a string constant.
5113 * Return OK or FAIL.
5114 */
5115 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005116get_string_tv(char_u **arg, typval_T *rettv, int evaluate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117{
5118 char_u *p;
5119 char_u *name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 int extra = 0;
5121
5122 /*
5123 * Find the end of the string, skipping backslashed characters.
5124 */
Bram Moolenaar91acfff2017-03-12 19:22:36 +01005125 for (p = *arg + 1; *p != NUL && *p != '"'; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126 {
5127 if (*p == '\\' && p[1] != NUL)
5128 {
5129 ++p;
5130 /* A "\<x>" form occupies at least 4 characters, and produces up
5131 * to 6 characters: reserve space for 2 extra */
5132 if (*p == '<')
5133 extra += 2;
5134 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005135 }
5136
5137 if (*p != '"')
5138 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005139 semsg(_("E114: Missing quote: %s"), *arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005140 return FAIL;
5141 }
5142
5143 /* If only parsing, set *arg and return here */
5144 if (!evaluate)
5145 {
5146 *arg = p + 1;
5147 return OK;
5148 }
5149
5150 /*
5151 * Copy the string into allocated memory, handling backslashed
5152 * characters.
5153 */
Bram Moolenaar964b3742019-05-24 18:54:09 +02005154 name = alloc(p - *arg + extra);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 if (name == NULL)
5156 return FAIL;
Bram Moolenaar8c711452005-01-14 21:53:12 +00005157 rettv->v_type = VAR_STRING;
5158 rettv->vval.v_string = name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159
Bram Moolenaar8c711452005-01-14 21:53:12 +00005160 for (p = *arg + 1; *p != NUL && *p != '"'; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161 {
5162 if (*p == '\\')
5163 {
5164 switch (*++p)
5165 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00005166 case 'b': *name++ = BS; ++p; break;
5167 case 'e': *name++ = ESC; ++p; break;
5168 case 'f': *name++ = FF; ++p; break;
5169 case 'n': *name++ = NL; ++p; break;
5170 case 'r': *name++ = CAR; ++p; break;
5171 case 't': *name++ = TAB; ++p; break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172
5173 case 'X': /* hex: "\x1", "\x12" */
5174 case 'x':
5175 case 'u': /* Unicode: "\u0023" */
5176 case 'U':
5177 if (vim_isxdigit(p[1]))
5178 {
5179 int n, nr;
5180 int c = toupper(*p);
5181
5182 if (c == 'X')
5183 n = 2;
Bram Moolenaaracc39882015-06-19 12:08:13 +02005184 else if (*p == 'u')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 n = 4;
Bram Moolenaaracc39882015-06-19 12:08:13 +02005186 else
5187 n = 8;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188 nr = 0;
5189 while (--n >= 0 && vim_isxdigit(p[1]))
5190 {
5191 ++p;
5192 nr = (nr << 4) + hex2nr(*p);
5193 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00005194 ++p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005195 /* For "\u" store the number according to
5196 * 'encoding'. */
5197 if (c != 'X')
Bram Moolenaar8c711452005-01-14 21:53:12 +00005198 name += (*mb_char2bytes)(nr, name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 else
Bram Moolenaar8c711452005-01-14 21:53:12 +00005200 *name++ = nr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 break;
5203
5204 /* octal: "\1", "\12", "\123" */
5205 case '0':
5206 case '1':
5207 case '2':
5208 case '3':
5209 case '4':
5210 case '5':
5211 case '6':
Bram Moolenaar8c711452005-01-14 21:53:12 +00005212 case '7': *name = *p++ - '0';
5213 if (*p >= '0' && *p <= '7')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00005215 *name = (*name << 3) + *p++ - '0';
5216 if (*p >= '0' && *p <= '7')
5217 *name = (*name << 3) + *p++ - '0';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00005219 ++name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220 break;
5221
5222 /* Special key, e.g.: "\<C-W>" */
Bram Moolenaar35a4cfa2016-08-14 16:07:48 +02005223 case '<': extra = trans_special(&p, name, TRUE, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224 if (extra != 0)
5225 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00005226 name += extra;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227 break;
5228 }
5229 /* FALLTHROUGH */
5230
Bram Moolenaar8c711452005-01-14 21:53:12 +00005231 default: MB_COPY_CHAR(p, name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232 break;
5233 }
5234 }
5235 else
Bram Moolenaar8c711452005-01-14 21:53:12 +00005236 MB_COPY_CHAR(p, name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00005239 *name = NUL;
Bram Moolenaardb249f22016-08-26 16:29:47 +02005240 if (*p != NUL) /* just in case */
5241 ++p;
5242 *arg = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243
Bram Moolenaar071d4272004-06-13 20:20:40 +00005244 return OK;
5245}
5246
5247/*
Bram Moolenaar8c711452005-01-14 21:53:12 +00005248 * Allocate a variable for a 'str''ing' constant.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005249 * Return OK or FAIL.
5250 */
5251 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005252get_lit_string_tv(char_u **arg, typval_T *rettv, int evaluate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253{
5254 char_u *p;
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005255 char_u *str;
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005256 int reduce = 0;
5257
5258 /*
Bram Moolenaar8c711452005-01-14 21:53:12 +00005259 * Find the end of the string, skipping ''.
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005260 */
Bram Moolenaar91acfff2017-03-12 19:22:36 +01005261 for (p = *arg + 1; *p != NUL; MB_PTR_ADV(p))
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005262 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00005263 if (*p == '\'')
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005264 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00005265 if (p[1] != '\'')
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005266 break;
5267 ++reduce;
5268 ++p;
5269 }
5270 }
5271
Bram Moolenaar8c711452005-01-14 21:53:12 +00005272 if (*p != '\'')
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005273 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005274 semsg(_("E115: Missing quote: %s"), *arg);
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005275 return FAIL;
5276 }
5277
Bram Moolenaar8c711452005-01-14 21:53:12 +00005278 /* If only parsing return after setting "*arg" */
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005279 if (!evaluate)
5280 {
5281 *arg = p + 1;
5282 return OK;
5283 }
5284
5285 /*
Bram Moolenaar8c711452005-01-14 21:53:12 +00005286 * Copy the string into allocated memory, handling '' to ' reduction.
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005287 */
Bram Moolenaar964b3742019-05-24 18:54:09 +02005288 str = alloc((p - *arg) - reduce);
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005289 if (str == NULL)
5290 return FAIL;
Bram Moolenaar8c711452005-01-14 21:53:12 +00005291 rettv->v_type = VAR_STRING;
5292 rettv->vval.v_string = str;
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005293
Bram Moolenaar8c711452005-01-14 21:53:12 +00005294 for (p = *arg + 1; *p != NUL; )
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005295 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00005296 if (*p == '\'')
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005297 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00005298 if (p[1] != '\'')
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005299 break;
5300 ++p;
5301 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00005302 MB_COPY_CHAR(p, str);
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005303 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00005304 *str = NUL;
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005305 *arg = p + 1;
5306
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00005307 return OK;
5308}
5309
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005310/*
5311 * Return the function name of the partial.
5312 */
5313 char_u *
5314partial_name(partial_T *pt)
5315{
5316 if (pt->pt_name != NULL)
5317 return pt->pt_name;
5318 return pt->pt_func->uf_name;
5319}
5320
Bram Moolenaarddecc252016-04-06 22:59:37 +02005321 static void
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005322partial_free(partial_T *pt)
Bram Moolenaarddecc252016-04-06 22:59:37 +02005323{
5324 int i;
5325
5326 for (i = 0; i < pt->pt_argc; ++i)
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005327 clear_tv(&pt->pt_argv[i]);
Bram Moolenaarddecc252016-04-06 22:59:37 +02005328 vim_free(pt->pt_argv);
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005329 dict_unref(pt->pt_dict);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005330 if (pt->pt_name != NULL)
5331 {
5332 func_unref(pt->pt_name);
5333 vim_free(pt->pt_name);
5334 }
5335 else
5336 func_ptr_unref(pt->pt_func);
Bram Moolenaarddecc252016-04-06 22:59:37 +02005337 vim_free(pt);
5338}
5339
5340/*
5341 * Unreference a closure: decrement the reference count and free it when it
5342 * becomes zero.
5343 */
5344 void
5345partial_unref(partial_T *pt)
5346{
5347 if (pt != NULL && --pt->pt_refcount <= 0)
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005348 partial_free(pt);
Bram Moolenaarddecc252016-04-06 22:59:37 +02005349}
5350
Bram Moolenaar67b3f992010-11-10 20:41:57 +01005351static int tv_equal_recurse_limit;
5352
Bram Moolenaar8e759ba2016-06-02 17:46:20 +02005353 static int
5354func_equal(
5355 typval_T *tv1,
5356 typval_T *tv2,
5357 int ic) /* ignore case */
5358{
5359 char_u *s1, *s2;
5360 dict_T *d1, *d2;
5361 int a1, a2;
5362 int i;
5363
5364 /* empty and NULL function name considered the same */
5365 s1 = tv1->v_type == VAR_FUNC ? tv1->vval.v_string
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005366 : partial_name(tv1->vval.v_partial);
Bram Moolenaar8e759ba2016-06-02 17:46:20 +02005367 if (s1 != NULL && *s1 == NUL)
5368 s1 = NULL;
5369 s2 = tv2->v_type == VAR_FUNC ? tv2->vval.v_string
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005370 : partial_name(tv2->vval.v_partial);
Bram Moolenaar8e759ba2016-06-02 17:46:20 +02005371 if (s2 != NULL && *s2 == NUL)
5372 s2 = NULL;
5373 if (s1 == NULL || s2 == NULL)
5374 {
5375 if (s1 != s2)
5376 return FALSE;
5377 }
5378 else if (STRCMP(s1, s2) != 0)
5379 return FALSE;
5380
5381 /* empty dict and NULL dict is different */
5382 d1 = tv1->v_type == VAR_FUNC ? NULL : tv1->vval.v_partial->pt_dict;
5383 d2 = tv2->v_type == VAR_FUNC ? NULL : tv2->vval.v_partial->pt_dict;
5384 if (d1 == NULL || d2 == NULL)
5385 {
5386 if (d1 != d2)
5387 return FALSE;
5388 }
5389 else if (!dict_equal(d1, d2, ic, TRUE))
5390 return FALSE;
5391
5392 /* empty list and no list considered the same */
5393 a1 = tv1->v_type == VAR_FUNC ? 0 : tv1->vval.v_partial->pt_argc;
5394 a2 = tv2->v_type == VAR_FUNC ? 0 : tv2->vval.v_partial->pt_argc;
5395 if (a1 != a2)
5396 return FALSE;
5397 for (i = 0; i < a1; ++i)
5398 if (!tv_equal(tv1->vval.v_partial->pt_argv + i,
5399 tv2->vval.v_partial->pt_argv + i, ic, TRUE))
5400 return FALSE;
5401
5402 return TRUE;
5403}
5404
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00005405/*
Bram Moolenaar8a283e52005-01-06 23:28:25 +00005406 * Return TRUE if "tv1" and "tv2" have the same value.
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005407 * Compares the items just like "==" would compare them, but strings and
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005408 * numbers are different. Floats and numbers are also different.
Bram Moolenaar8a283e52005-01-06 23:28:25 +00005409 */
Bram Moolenaarcd524592016-07-17 14:57:05 +02005410 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005411tv_equal(
5412 typval_T *tv1,
5413 typval_T *tv2,
5414 int ic, /* ignore case */
5415 int recursive) /* TRUE when used recursively */
Bram Moolenaar8a283e52005-01-06 23:28:25 +00005416{
5417 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00005418 char_u *s1, *s2;
Bram Moolenaar67b3f992010-11-10 20:41:57 +01005419 static int recursive_cnt = 0; /* catch recursive loops */
Bram Moolenaarb47a2402006-10-15 13:09:12 +00005420 int r;
Bram Moolenaar8a283e52005-01-06 23:28:25 +00005421
Bram Moolenaar8b402a02006-10-17 13:16:39 +00005422 /* Catch lists and dicts that have an endless loop by limiting
Bram Moolenaar67b3f992010-11-10 20:41:57 +01005423 * recursiveness to a limit. We guess they are equal then.
5424 * A fixed limit has the problem of still taking an awful long time.
5425 * Reduce the limit every time running into it. That should work fine for
5426 * deeply linked structures that are not recursively linked and catch
5427 * recursiveness quickly. */
5428 if (!recursive)
5429 tv_equal_recurse_limit = 1000;
5430 if (recursive_cnt >= tv_equal_recurse_limit)
5431 {
5432 --tv_equal_recurse_limit;
Bram Moolenaar8b402a02006-10-17 13:16:39 +00005433 return TRUE;
Bram Moolenaar67b3f992010-11-10 20:41:57 +01005434 }
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005435
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02005436 /* For VAR_FUNC and VAR_PARTIAL compare the function name, bound dict and
5437 * arguments. */
Bram Moolenaar8e759ba2016-06-02 17:46:20 +02005438 if ((tv1->v_type == VAR_FUNC
5439 || (tv1->v_type == VAR_PARTIAL && tv1->vval.v_partial != NULL))
5440 && (tv2->v_type == VAR_FUNC
5441 || (tv2->v_type == VAR_PARTIAL && tv2->vval.v_partial != NULL)))
5442 {
5443 ++recursive_cnt;
5444 r = func_equal(tv1, tv2, ic);
5445 --recursive_cnt;
5446 return r;
5447 }
5448
5449 if (tv1->v_type != tv2->v_type)
5450 return FALSE;
5451
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005452 switch (tv1->v_type)
Bram Moolenaar8a283e52005-01-06 23:28:25 +00005453 {
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005454 case VAR_LIST:
Bram Moolenaar67b3f992010-11-10 20:41:57 +01005455 ++recursive_cnt;
5456 r = list_equal(tv1->vval.v_list, tv2->vval.v_list, ic, TRUE);
5457 --recursive_cnt;
Bram Moolenaarb47a2402006-10-15 13:09:12 +00005458 return r;
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005459
5460 case VAR_DICT:
Bram Moolenaar67b3f992010-11-10 20:41:57 +01005461 ++recursive_cnt;
5462 r = dict_equal(tv1->vval.v_dict, tv2->vval.v_dict, ic, TRUE);
5463 --recursive_cnt;
Bram Moolenaarb47a2402006-10-15 13:09:12 +00005464 return r;
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005465
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01005466 case VAR_BLOB:
5467 return blob_equal(tv1->vval.v_blob, tv2->vval.v_blob);
5468
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005469 case VAR_NUMBER:
5470 return tv1->vval.v_number == tv2->vval.v_number;
5471
5472 case VAR_STRING:
Bram Moolenaard155d7a2018-12-21 16:04:21 +01005473 s1 = tv_get_string_buf(tv1, buf1);
5474 s2 = tv_get_string_buf(tv2, buf2);
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005475 return ((ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2)) == 0);
Bram Moolenaar520e1e42016-01-23 19:46:28 +01005476
5477 case VAR_SPECIAL:
5478 return tv1->vval.v_number == tv2->vval.v_number;
Bram Moolenaar835dc632016-02-07 14:27:38 +01005479
5480 case VAR_FLOAT:
5481#ifdef FEAT_FLOAT
5482 return tv1->vval.v_float == tv2->vval.v_float;
5483#endif
5484 case VAR_JOB:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005485#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar835dc632016-02-07 14:27:38 +01005486 return tv1->vval.v_job == tv2->vval.v_job;
5487#endif
Bram Moolenaar77073442016-02-13 23:23:53 +01005488 case VAR_CHANNEL:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005489#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar77073442016-02-13 23:23:53 +01005490 return tv1->vval.v_channel == tv2->vval.v_channel;
5491#endif
Bram Moolenaarf0e86a02016-03-19 19:38:12 +01005492 case VAR_FUNC:
5493 case VAR_PARTIAL:
Bram Moolenaar835dc632016-02-07 14:27:38 +01005494 case VAR_UNKNOWN:
5495 break;
Bram Moolenaar8a283e52005-01-06 23:28:25 +00005496 }
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +00005497
Bram Moolenaara03f2332016-02-06 18:09:59 +01005498 /* VAR_UNKNOWN can be the result of a invalid expression, let's say it
5499 * does not equal anything, not even itself. */
5500 return FALSE;
Bram Moolenaar8a283e52005-01-06 23:28:25 +00005501}
5502
5503/*
Bram Moolenaar520e1e42016-01-23 19:46:28 +01005504 * Return the next (unique) copy ID.
5505 * Used for serializing nested structures.
5506 */
5507 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005508get_copyID(void)
Bram Moolenaar520e1e42016-01-23 19:46:28 +01005509{
5510 current_copyID += COPYID_INC;
5511 return current_copyID;
5512}
5513
5514/*
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005515 * Garbage collection for lists and dictionaries.
5516 *
5517 * We use reference counts to be able to free most items right away when they
5518 * are no longer used. But for composite items it's possible that it becomes
5519 * unused while the reference count is > 0: When there is a recursive
5520 * reference. Example:
5521 * :let l = [1, 2, 3]
5522 * :let d = {9: l}
5523 * :let l[1] = d
5524 *
5525 * Since this is quite unusual we handle this with garbage collection: every
5526 * once in a while find out which lists and dicts are not referenced from any
5527 * variable.
5528 *
5529 * Here is a good reference text about garbage collection (refers to Python
5530 * but it applies to all reference-counting mechanisms):
5531 * http://python.ca/nas/python/gc/
Bram Moolenaard9fba312005-06-26 22:34:35 +00005532 */
Bram Moolenaard9fba312005-06-26 22:34:35 +00005533
5534/*
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005535 * Do garbage collection for lists and dicts.
Bram Moolenaar574860b2016-05-24 17:33:34 +02005536 * When "testing" is TRUE this is called from test_garbagecollect_now().
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005537 * Return TRUE if some memory was freed.
Bram Moolenaard9fba312005-06-26 22:34:35 +00005538 */
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005539 int
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02005540garbage_collect(int testing)
Bram Moolenaard9fba312005-06-26 22:34:35 +00005541{
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005542 int copyID;
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005543 int abort = FALSE;
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005544 buf_T *buf;
5545 win_T *wp;
5546 int i;
Bram Moolenaar934b1362015-02-04 23:06:45 +01005547 int did_free = FALSE;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005548 tabpage_T *tp;
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005549
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02005550 if (!testing)
5551 {
5552 /* Only do this once. */
5553 want_garbage_collect = FALSE;
5554 may_garbage_collect = FALSE;
5555 garbage_collect_at_exit = FALSE;
5556 }
Bram Moolenaar9fecb462006-09-05 10:59:47 +00005557
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005558 /* We advance by two because we add one for items referenced through
5559 * previous_funccal. */
Bram Moolenaar520e1e42016-01-23 19:46:28 +01005560 copyID = get_copyID();
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005561
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005562 /*
5563 * 1. Go through all accessible variables and mark all lists and dicts
5564 * with copyID.
5565 */
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005566
5567 /* Don't free variables in the previous_funccal list unless they are only
5568 * referenced through previous_funccal. This must be first, because if
Bram Moolenaar2c2398c2009-06-03 11:22:45 +00005569 * the item is referenced elsewhere the funccal must not be freed. */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005570 abort = abort || set_ref_in_previous_funccal(copyID);
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005571
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005572 /* script-local variables */
5573 for (i = 1; i <= ga_scripts.ga_len; ++i)
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005574 abort = abort || set_ref_in_ht(&SCRIPT_VARS(i), copyID, NULL);
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005575
5576 /* buffer-local variables */
Bram Moolenaar29323592016-07-24 22:04:11 +02005577 FOR_ALL_BUFFERS(buf)
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005578 abort = abort || set_ref_in_item(&buf->b_bufvar.di_tv, copyID,
5579 NULL, NULL);
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005580
5581 /* window-local variables */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005582 FOR_ALL_TAB_WINDOWS(tp, wp)
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005583 abort = abort || set_ref_in_item(&wp->w_winvar.di_tv, copyID,
5584 NULL, NULL);
Bram Moolenaar3bb28552013-04-15 18:25:59 +02005585 if (aucmd_win != NULL)
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005586 abort = abort || set_ref_in_item(&aucmd_win->w_winvar.di_tv, copyID,
5587 NULL, NULL);
Bram Moolenaar4d784b22019-05-25 19:51:39 +02005588#ifdef FEAT_TEXT_PROP
5589 for (wp = first_popupwin; wp != NULL; wp = wp->w_next)
5590 abort = abort || set_ref_in_item(&wp->w_winvar.di_tv, copyID,
5591 NULL, NULL);
5592 for (wp = first_tab_popupwin; wp != NULL; wp = wp->w_next)
5593 abort = abort || set_ref_in_item(&wp->w_winvar.di_tv, copyID,
5594 NULL, NULL);
5595 FOR_ALL_TABPAGES(tp)
5596 if (tp != curtab)
5597 for (wp = tp->tp_first_popupwin; wp != NULL; wp = wp->w_next)
5598 abort = abort || set_ref_in_item(&wp->w_winvar.di_tv, copyID,
5599 NULL, NULL);
5600#endif
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005601
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005602 /* tabpage-local variables */
Bram Moolenaar29323592016-07-24 22:04:11 +02005603 FOR_ALL_TABPAGES(tp)
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005604 abort = abort || set_ref_in_item(&tp->tp_winvar.di_tv, copyID,
5605 NULL, NULL);
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005606 /* global variables */
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005607 abort = abort || set_ref_in_ht(&globvarht, copyID, NULL);
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005608
5609 /* function-local variables */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005610 abort = abort || set_ref_in_call_stack(copyID);
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005611
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005612 /* named functions (matters for closures) */
5613 abort = abort || set_ref_in_functions(copyID);
5614
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02005615 /* function call arguments, if v:testing is set. */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005616 abort = abort || set_ref_in_func_args(copyID);
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02005617
Bram Moolenaard812df62008-11-09 12:46:09 +00005618 /* v: vars */
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005619 abort = abort || set_ref_in_ht(&vimvarht, copyID, NULL);
Bram Moolenaard812df62008-11-09 12:46:09 +00005620
Bram Moolenaar1dced572012-04-05 16:54:08 +02005621#ifdef FEAT_LUA
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005622 abort = abort || set_ref_in_lua(copyID);
Bram Moolenaar1dced572012-04-05 16:54:08 +02005623#endif
5624
Bram Moolenaardb913952012-06-29 12:54:53 +02005625#ifdef FEAT_PYTHON
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005626 abort = abort || set_ref_in_python(copyID);
Bram Moolenaardb913952012-06-29 12:54:53 +02005627#endif
5628
5629#ifdef FEAT_PYTHON3
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005630 abort = abort || set_ref_in_python3(copyID);
Bram Moolenaardb913952012-06-29 12:54:53 +02005631#endif
5632
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01005633#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar3780bb92016-04-12 22:18:53 +02005634 abort = abort || set_ref_in_channel(copyID);
Bram Moolenaarb8d49052016-05-01 14:22:16 +02005635 abort = abort || set_ref_in_job(copyID);
Bram Moolenaar4b6a6dc2016-02-04 22:49:49 +01005636#endif
Bram Moolenaar3266c852016-04-30 18:07:05 +02005637#ifdef FEAT_NETBEANS_INTG
5638 abort = abort || set_ref_in_nb_channel(copyID);
5639#endif
Bram Moolenaar4b6a6dc2016-02-04 22:49:49 +01005640
Bram Moolenaare3188e22016-05-31 21:13:04 +02005641#ifdef FEAT_TIMERS
5642 abort = abort || set_ref_in_timer(copyID);
5643#endif
5644
Bram Moolenaar8f77c5a2017-04-30 14:21:00 +02005645#ifdef FEAT_QUICKFIX
5646 abort = abort || set_ref_in_quickfix(copyID);
5647#endif
5648
Bram Moolenaara2c45a12017-07-27 22:14:59 +02005649#ifdef FEAT_TERMINAL
5650 abort = abort || set_ref_in_term(copyID);
5651#endif
5652
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005653 if (!abort)
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005654 {
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005655 /*
5656 * 2. Free lists and dictionaries that are not referenced.
5657 */
5658 did_free = free_unref_items(copyID);
5659
5660 /*
5661 * 3. Check if any funccal can be freed now.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005662 * This may call us back recursively.
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005663 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005664 free_unref_funccal(copyID, testing);
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005665 }
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005666 else if (p_verbose > 0)
5667 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01005668 verb_msg(_("Not enough memory to set references, garbage collection aborted!"));
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005669 }
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005670
5671 return did_free;
5672}
5673
5674/*
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005675 * Free lists, dictionaries, channels and jobs that are no longer referenced.
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005676 */
5677 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005678free_unref_items(int copyID)
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005679{
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00005680 int did_free = FALSE;
5681
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005682 /* Let all "free" functions know that we are here. This means no
5683 * dictionaries, lists, channels or jobs are to be freed, because we will
5684 * do that here. */
5685 in_free_unref_items = TRUE;
5686
5687 /*
5688 * PASS 1: free the contents of the items. We don't free the items
5689 * themselves yet, so that it is possible to decrement refcount counters
5690 */
5691
Bram Moolenaarcd524592016-07-17 14:57:05 +02005692 /* Go through the list of dicts and free items without the copyID. */
5693 did_free |= dict_free_nonref(copyID);
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005694
Bram Moolenaarda861d62016-07-17 15:46:27 +02005695 /* Go through the list of lists and free items without the copyID. */
5696 did_free |= list_free_nonref(copyID);
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005697
5698#ifdef FEAT_JOB_CHANNEL
5699 /* Go through the list of jobs and free items without the copyID. This
5700 * must happen before doing channels, because jobs refer to channels, but
5701 * the reference from the channel to the job isn't tracked. */
5702 did_free |= free_unused_jobs_contents(copyID, COPYID_MASK);
5703
5704 /* Go through the list of channels and free items without the copyID. */
5705 did_free |= free_unused_channels_contents(copyID, COPYID_MASK);
5706#endif
5707
5708 /*
5709 * PASS 2: free the items themselves.
5710 */
Bram Moolenaarcd524592016-07-17 14:57:05 +02005711 dict_free_items(copyID);
Bram Moolenaarda861d62016-07-17 15:46:27 +02005712 list_free_items(copyID);
Bram Moolenaar835dc632016-02-07 14:27:38 +01005713
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005714#ifdef FEAT_JOB_CHANNEL
5715 /* Go through the list of jobs and free items without the copyID. This
5716 * must happen before doing channels, because jobs refer to channels, but
5717 * the reference from the channel to the job isn't tracked. */
5718 free_unused_jobs(copyID, COPYID_MASK);
5719
5720 /* Go through the list of channels and free items without the copyID. */
5721 free_unused_channels(copyID, COPYID_MASK);
5722#endif
5723
5724 in_free_unref_items = FALSE;
5725
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005726 return did_free;
5727}
5728
5729/*
5730 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005731 * "list_stack" is used to add lists to be marked. Can be NULL.
5732 *
5733 * Returns TRUE if setting references failed somehow.
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005734 */
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005735 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005736set_ref_in_ht(hashtab_T *ht, int copyID, list_stack_T **list_stack)
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005737{
5738 int todo;
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005739 int abort = FALSE;
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005740 hashitem_T *hi;
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005741 hashtab_T *cur_ht;
5742 ht_stack_T *ht_stack = NULL;
5743 ht_stack_T *tempitem;
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005744
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005745 cur_ht = ht;
5746 for (;;)
5747 {
5748 if (!abort)
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005749 {
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005750 /* Mark each item in the hashtab. If the item contains a hashtab
5751 * it is added to ht_stack, if it contains a list it is added to
5752 * list_stack. */
5753 todo = (int)cur_ht->ht_used;
5754 for (hi = cur_ht->ht_array; todo > 0; ++hi)
5755 if (!HASHITEM_EMPTY(hi))
5756 {
5757 --todo;
5758 abort = abort || set_ref_in_item(&HI2DI(hi)->di_tv, copyID,
5759 &ht_stack, list_stack);
5760 }
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005761 }
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005762
5763 if (ht_stack == NULL)
5764 break;
5765
5766 /* take an item from the stack */
5767 cur_ht = ht_stack->ht;
5768 tempitem = ht_stack;
5769 ht_stack = ht_stack->prev;
5770 free(tempitem);
5771 }
5772
5773 return abort;
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005774}
5775
5776/*
5777 * Mark all lists and dicts referenced through list "l" with "copyID".
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005778 * "ht_stack" is used to add hashtabs to be marked. Can be NULL.
5779 *
5780 * Returns TRUE if setting references failed somehow.
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005781 */
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005782 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005783set_ref_in_list(list_T *l, int copyID, ht_stack_T **ht_stack)
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005784{
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005785 listitem_T *li;
5786 int abort = FALSE;
5787 list_T *cur_l;
5788 list_stack_T *list_stack = NULL;
5789 list_stack_T *tempitem;
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005790
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005791 cur_l = l;
5792 for (;;)
5793 {
5794 if (!abort)
5795 /* Mark each item in the list. If the item contains a hashtab
5796 * it is added to ht_stack, if it contains a list it is added to
5797 * list_stack. */
5798 for (li = cur_l->lv_first; !abort && li != NULL; li = li->li_next)
5799 abort = abort || set_ref_in_item(&li->li_tv, copyID,
5800 ht_stack, &list_stack);
5801 if (list_stack == NULL)
5802 break;
5803
5804 /* take an item from the stack */
5805 cur_l = list_stack->list;
5806 tempitem = list_stack;
5807 list_stack = list_stack->prev;
5808 free(tempitem);
5809 }
5810
5811 return abort;
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005812}
5813
5814/*
5815 * Mark all lists and dicts referenced through typval "tv" with "copyID".
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005816 * "list_stack" is used to add lists to be marked. Can be NULL.
5817 * "ht_stack" is used to add hashtabs to be marked. Can be NULL.
5818 *
5819 * Returns TRUE if setting references failed somehow.
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005820 */
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005821 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01005822set_ref_in_item(
5823 typval_T *tv,
5824 int copyID,
5825 ht_stack_T **ht_stack,
5826 list_stack_T **list_stack)
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00005827{
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005828 int abort = FALSE;
Bram Moolenaard9fba312005-06-26 22:34:35 +00005829
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005830 if (tv->v_type == VAR_DICT)
Bram Moolenaard9fba312005-06-26 22:34:35 +00005831 {
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005832 dict_T *dd = tv->vval.v_dict;
5833
Bram Moolenaara03f2332016-02-06 18:09:59 +01005834 if (dd != NULL && dd->dv_copyID != copyID)
5835 {
5836 /* Didn't see this dict yet. */
5837 dd->dv_copyID = copyID;
5838 if (ht_stack == NULL)
Bram Moolenaard9fba312005-06-26 22:34:35 +00005839 {
Bram Moolenaara03f2332016-02-06 18:09:59 +01005840 abort = set_ref_in_ht(&dd->dv_hashtab, copyID, list_stack);
5841 }
5842 else
5843 {
5844 ht_stack_T *newitem = (ht_stack_T*)malloc(sizeof(ht_stack_T));
5845 if (newitem == NULL)
5846 abort = TRUE;
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005847 else
5848 {
Bram Moolenaara03f2332016-02-06 18:09:59 +01005849 newitem->ht = &dd->dv_hashtab;
5850 newitem->prev = *ht_stack;
5851 *ht_stack = newitem;
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005852 }
Bram Moolenaard9fba312005-06-26 22:34:35 +00005853 }
Bram Moolenaara03f2332016-02-06 18:09:59 +01005854 }
5855 }
5856 else if (tv->v_type == VAR_LIST)
5857 {
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005858 list_T *ll = tv->vval.v_list;
5859
Bram Moolenaara03f2332016-02-06 18:09:59 +01005860 if (ll != NULL && ll->lv_copyID != copyID)
5861 {
5862 /* Didn't see this list yet. */
5863 ll->lv_copyID = copyID;
5864 if (list_stack == NULL)
Bram Moolenaard9fba312005-06-26 22:34:35 +00005865 {
Bram Moolenaara03f2332016-02-06 18:09:59 +01005866 abort = set_ref_in_list(ll, copyID, ht_stack);
5867 }
5868 else
5869 {
5870 list_stack_T *newitem = (list_stack_T*)malloc(
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005871 sizeof(list_stack_T));
Bram Moolenaara03f2332016-02-06 18:09:59 +01005872 if (newitem == NULL)
5873 abort = TRUE;
5874 else
5875 {
5876 newitem->list = ll;
5877 newitem->prev = *list_stack;
5878 *list_stack = newitem;
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005879 }
Bram Moolenaard9fba312005-06-26 22:34:35 +00005880 }
Bram Moolenaara03f2332016-02-06 18:09:59 +01005881 }
Bram Moolenaard9fba312005-06-26 22:34:35 +00005882 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005883 else if (tv->v_type == VAR_FUNC)
5884 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005885 abort = set_ref_in_func(tv->vval.v_string, NULL, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005886 }
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005887 else if (tv->v_type == VAR_PARTIAL)
5888 {
5889 partial_T *pt = tv->vval.v_partial;
5890 int i;
5891
5892 /* A partial does not have a copyID, because it cannot contain itself.
5893 */
5894 if (pt != NULL)
5895 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005896 abort = set_ref_in_func(pt->pt_name, pt->pt_func, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005897
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005898 if (pt->pt_dict != NULL)
5899 {
5900 typval_T dtv;
5901
5902 dtv.v_type = VAR_DICT;
5903 dtv.vval.v_dict = pt->pt_dict;
5904 set_ref_in_item(&dtv, copyID, ht_stack, list_stack);
5905 }
5906
5907 for (i = 0; i < pt->pt_argc; ++i)
5908 abort = abort || set_ref_in_item(&pt->pt_argv[i], copyID,
5909 ht_stack, list_stack);
5910 }
5911 }
5912#ifdef FEAT_JOB_CHANNEL
5913 else if (tv->v_type == VAR_JOB)
5914 {
5915 job_T *job = tv->vval.v_job;
5916 typval_T dtv;
5917
5918 if (job != NULL && job->jv_copyID != copyID)
5919 {
Bram Moolenaar0239acb2016-04-11 21:02:54 +02005920 job->jv_copyID = copyID;
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005921 if (job->jv_channel != NULL)
5922 {
5923 dtv.v_type = VAR_CHANNEL;
5924 dtv.vval.v_channel = job->jv_channel;
5925 set_ref_in_item(&dtv, copyID, ht_stack, list_stack);
5926 }
5927 if (job->jv_exit_partial != NULL)
5928 {
5929 dtv.v_type = VAR_PARTIAL;
5930 dtv.vval.v_partial = job->jv_exit_partial;
5931 set_ref_in_item(&dtv, copyID, ht_stack, list_stack);
5932 }
5933 }
5934 }
5935 else if (tv->v_type == VAR_CHANNEL)
5936 {
5937 channel_T *ch =tv->vval.v_channel;
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02005938 ch_part_T part;
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005939 typval_T dtv;
5940 jsonq_T *jq;
5941 cbq_T *cq;
5942
5943 if (ch != NULL && ch->ch_copyID != copyID)
5944 {
Bram Moolenaar0239acb2016-04-11 21:02:54 +02005945 ch->ch_copyID = copyID;
Bram Moolenaardc0ccae2016-10-09 17:28:01 +02005946 for (part = PART_SOCK; part < PART_COUNT; ++part)
Bram Moolenaar107e1ee2016-04-08 17:07:19 +02005947 {
5948 for (jq = ch->ch_part[part].ch_json_head.jq_next; jq != NULL;
5949 jq = jq->jq_next)
5950 set_ref_in_item(jq->jq_value, copyID, ht_stack, list_stack);
5951 for (cq = ch->ch_part[part].ch_cb_head.cq_next; cq != NULL;
5952 cq = cq->cq_next)
5953 if (cq->cq_partial != NULL)
5954 {
5955 dtv.v_type = VAR_PARTIAL;
5956 dtv.vval.v_partial = cq->cq_partial;
5957 set_ref_in_item(&dtv, copyID, ht_stack, list_stack);
5958 }
5959 if (ch->ch_part[part].ch_partial != NULL)
5960 {
5961 dtv.v_type = VAR_PARTIAL;
5962 dtv.vval.v_partial = ch->ch_part[part].ch_partial;
5963 set_ref_in_item(&dtv, copyID, ht_stack, list_stack);
5964 }
5965 }
5966 if (ch->ch_partial != NULL)
5967 {
5968 dtv.v_type = VAR_PARTIAL;
5969 dtv.vval.v_partial = ch->ch_partial;
5970 set_ref_in_item(&dtv, copyID, ht_stack, list_stack);
5971 }
5972 if (ch->ch_close_partial != NULL)
5973 {
5974 dtv.v_type = VAR_PARTIAL;
5975 dtv.vval.v_partial = ch->ch_close_partial;
5976 set_ref_in_item(&dtv, copyID, ht_stack, list_stack);
5977 }
5978 }
5979 }
5980#endif
Bram Moolenaar2459a5e2015-02-03 12:55:18 +01005981 return abort;
Bram Moolenaard9fba312005-06-26 22:34:35 +00005982}
5983
Bram Moolenaar17a13432016-01-24 14:22:10 +01005984 static char *
5985get_var_special_name(int nr)
5986{
5987 switch (nr)
5988 {
Bram Moolenaarf48aa162016-01-24 17:54:24 +01005989 case VVAL_FALSE: return "v:false";
Bram Moolenaar65edff82016-02-21 16:40:11 +01005990 case VVAL_TRUE: return "v:true";
5991 case VVAL_NONE: return "v:none";
5992 case VVAL_NULL: return "v:null";
Bram Moolenaar17a13432016-01-24 14:22:10 +01005993 }
Bram Moolenaar95f09602016-11-10 20:01:45 +01005994 internal_error("get_var_special_name()");
Bram Moolenaar17a13432016-01-24 14:22:10 +01005995 return "42";
5996}
5997
Bram Moolenaar8c711452005-01-14 21:53:12 +00005998/*
Bram Moolenaar49cd9572005-01-03 21:06:01 +00005999 * Return a string with the string representation of a variable.
6000 * If the memory is allocated "tofree" is set to it, otherwise NULL.
Bram Moolenaar8a283e52005-01-06 23:28:25 +00006001 * "numbuf" is used for a number.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006002 * When "copyID" is not NULL replace recursive lists and dicts with "...".
Bram Moolenaar35422f42017-08-05 16:33:56 +02006003 * When both "echo_style" and "composite_val" are FALSE, put quotes around
6004 * stings as "string()", otherwise does not put quotes around strings, as
6005 * ":echo" displays values.
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006006 * When "restore_copyID" is FALSE, repeated items in dictionaries and lists
6007 * are replaced with "...".
Bram Moolenaar92c5aba2007-08-14 20:29:31 +00006008 * May return NULL.
Bram Moolenaar49cd9572005-01-03 21:06:01 +00006009 */
Bram Moolenaarcd524592016-07-17 14:57:05 +02006010 char_u *
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006011echo_string_core(
Bram Moolenaar7454a062016-01-30 15:14:10 +01006012 typval_T *tv,
6013 char_u **tofree,
6014 char_u *numbuf,
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006015 int copyID,
6016 int echo_style,
6017 int restore_copyID,
Bram Moolenaar35422f42017-08-05 16:33:56 +02006018 int composite_val)
Bram Moolenaar49cd9572005-01-03 21:06:01 +00006019{
Bram Moolenaare9a41262005-01-15 22:18:47 +00006020 static int recurse = 0;
6021 char_u *r = NULL;
6022
Bram Moolenaar33570922005-01-25 22:26:29 +00006023 if (recurse >= DICT_MAXNEST)
Bram Moolenaare9a41262005-01-15 22:18:47 +00006024 {
Bram Moolenaar8502c702014-06-17 12:51:16 +02006025 if (!did_echo_string_emsg)
6026 {
6027 /* Only give this message once for a recursive call to avoid
6028 * flooding the user with errors. And stop iterating over lists
6029 * and dicts. */
6030 did_echo_string_emsg = TRUE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006031 emsg(_("E724: variable nested too deep for displaying"));
Bram Moolenaar8502c702014-06-17 12:51:16 +02006032 }
Bram Moolenaare9a41262005-01-15 22:18:47 +00006033 *tofree = NULL;
Bram Moolenaar8502c702014-06-17 12:51:16 +02006034 return (char_u *)"{E724}";
Bram Moolenaare9a41262005-01-15 22:18:47 +00006035 }
6036 ++recurse;
6037
Bram Moolenaar49cd9572005-01-03 21:06:01 +00006038 switch (tv->v_type)
6039 {
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006040 case VAR_STRING:
Bram Moolenaar35422f42017-08-05 16:33:56 +02006041 if (echo_style && !composite_val)
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006042 {
6043 *tofree = NULL;
Bram Moolenaar35422f42017-08-05 16:33:56 +02006044 r = tv->vval.v_string;
6045 if (r == NULL)
6046 r = (char_u *)"";
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006047 }
6048 else
6049 {
6050 *tofree = string_quote(tv->vval.v_string, FALSE);
6051 r = *tofree;
6052 }
6053 break;
6054
Bram Moolenaar49cd9572005-01-03 21:06:01 +00006055 case VAR_FUNC:
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006056 if (echo_style)
6057 {
6058 *tofree = NULL;
6059 r = tv->vval.v_string;
6060 }
6061 else
6062 {
6063 *tofree = string_quote(tv->vval.v_string, TRUE);
6064 r = *tofree;
6065 }
Bram Moolenaare9a41262005-01-15 22:18:47 +00006066 break;
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006067
Bram Moolenaar1735bc92016-03-14 23:05:14 +01006068 case VAR_PARTIAL:
Bram Moolenaar24c77a12016-03-24 21:23:06 +01006069 {
6070 partial_T *pt = tv->vval.v_partial;
6071 char_u *fname = string_quote(pt == NULL ? NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006072 : partial_name(pt), FALSE);
Bram Moolenaar24c77a12016-03-24 21:23:06 +01006073 garray_T ga;
6074 int i;
6075 char_u *tf;
6076
6077 ga_init2(&ga, 1, 100);
6078 ga_concat(&ga, (char_u *)"function(");
6079 if (fname != NULL)
6080 {
6081 ga_concat(&ga, fname);
6082 vim_free(fname);
6083 }
6084 if (pt != NULL && pt->pt_argc > 0)
6085 {
6086 ga_concat(&ga, (char_u *)", [");
6087 for (i = 0; i < pt->pt_argc; ++i)
6088 {
6089 if (i > 0)
6090 ga_concat(&ga, (char_u *)", ");
6091 ga_concat(&ga,
6092 tv2string(&pt->pt_argv[i], &tf, numbuf, copyID));
6093 vim_free(tf);
6094 }
6095 ga_concat(&ga, (char_u *)"]");
6096 }
6097 if (pt != NULL && pt->pt_dict != NULL)
6098 {
6099 typval_T dtv;
6100
6101 ga_concat(&ga, (char_u *)", ");
6102 dtv.v_type = VAR_DICT;
6103 dtv.vval.v_dict = pt->pt_dict;
6104 ga_concat(&ga, tv2string(&dtv, &tf, numbuf, copyID));
6105 vim_free(tf);
6106 }
6107 ga_concat(&ga, (char_u *)")");
6108
6109 *tofree = ga.ga_data;
6110 r = *tofree;
6111 break;
6112 }
Bram Moolenaar1735bc92016-03-14 23:05:14 +01006113
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01006114 case VAR_BLOB:
Bram Moolenaar8c8b8bb2019-01-13 17:48:04 +01006115 r = blob2string(tv->vval.v_blob, tofree, numbuf);
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01006116 break;
6117
Bram Moolenaar49cd9572005-01-03 21:06:01 +00006118 case VAR_LIST:
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006119 if (tv->vval.v_list == NULL)
6120 {
6121 *tofree = NULL;
6122 r = NULL;
6123 }
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006124 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID
6125 && tv->vval.v_list->lv_len > 0)
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006126 {
6127 *tofree = NULL;
6128 r = (char_u *)"[...]";
6129 }
6130 else
6131 {
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006132 int old_copyID = tv->vval.v_list->lv_copyID;
6133
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006134 tv->vval.v_list->lv_copyID = copyID;
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006135 *tofree = list2string(tv, copyID, restore_copyID);
6136 if (restore_copyID)
6137 tv->vval.v_list->lv_copyID = old_copyID;
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006138 r = *tofree;
6139 }
Bram Moolenaare9a41262005-01-15 22:18:47 +00006140 break;
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006141
Bram Moolenaar8c711452005-01-14 21:53:12 +00006142 case VAR_DICT:
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006143 if (tv->vval.v_dict == NULL)
6144 {
6145 *tofree = NULL;
6146 r = NULL;
6147 }
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006148 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID
6149 && tv->vval.v_dict->dv_hashtab.ht_used != 0)
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006150 {
6151 *tofree = NULL;
6152 r = (char_u *)"{...}";
6153 }
6154 else
6155 {
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006156 int old_copyID = tv->vval.v_dict->dv_copyID;
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006157 tv->vval.v_dict->dv_copyID = copyID;
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006158 *tofree = dict2string(tv, copyID, restore_copyID);
6159 if (restore_copyID)
6160 tv->vval.v_dict->dv_copyID = old_copyID;
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006161 r = *tofree;
6162 }
Bram Moolenaare9a41262005-01-15 22:18:47 +00006163 break;
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006164
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006165 case VAR_NUMBER:
Bram Moolenaara03f2332016-02-06 18:09:59 +01006166 case VAR_UNKNOWN:
Bram Moolenaar35422f42017-08-05 16:33:56 +02006167 *tofree = NULL;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01006168 r = tv_get_string_buf(tv, numbuf);
Bram Moolenaar35422f42017-08-05 16:33:56 +02006169 break;
6170
Bram Moolenaar835dc632016-02-07 14:27:38 +01006171 case VAR_JOB:
Bram Moolenaar77073442016-02-13 23:23:53 +01006172 case VAR_CHANNEL:
Bram Moolenaare9a41262005-01-15 22:18:47 +00006173 *tofree = NULL;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01006174 r = tv_get_string_buf(tv, numbuf);
Bram Moolenaar35422f42017-08-05 16:33:56 +02006175 if (composite_val)
6176 {
6177 *tofree = string_quote(r, FALSE);
6178 r = *tofree;
6179 }
Bram Moolenaar49cd9572005-01-03 21:06:01 +00006180 break;
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006181
Bram Moolenaar8c8de832008-06-24 22:58:06 +00006182 case VAR_FLOAT:
Bram Moolenaar835dc632016-02-07 14:27:38 +01006183#ifdef FEAT_FLOAT
Bram Moolenaar8c8de832008-06-24 22:58:06 +00006184 *tofree = NULL;
6185 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
6186 r = numbuf;
6187 break;
6188#endif
6189
Bram Moolenaar520e1e42016-01-23 19:46:28 +01006190 case VAR_SPECIAL:
6191 *tofree = NULL;
Bram Moolenaar17a13432016-01-24 14:22:10 +01006192 r = (char_u *)get_var_special_name(tv->vval.v_number);
Bram Moolenaar520e1e42016-01-23 19:46:28 +01006193 break;
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006194 }
Bram Moolenaare9a41262005-01-15 22:18:47 +00006195
Bram Moolenaar8502c702014-06-17 12:51:16 +02006196 if (--recurse == 0)
6197 did_echo_string_emsg = FALSE;
Bram Moolenaare9a41262005-01-15 22:18:47 +00006198 return r;
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006199}
6200
6201/*
6202 * Return a string with the string representation of a variable.
6203 * If the memory is allocated "tofree" is set to it, otherwise NULL.
6204 * "numbuf" is used for a number.
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006205 * Does not put quotes around strings, as ":echo" displays values.
6206 * When "copyID" is not NULL replace recursive lists and dicts with "...".
6207 * May return NULL.
6208 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006209 char_u *
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006210echo_string(
6211 typval_T *tv,
6212 char_u **tofree,
6213 char_u *numbuf,
6214 int copyID)
6215{
6216 return echo_string_core(tv, tofree, numbuf, copyID, TRUE, FALSE, FALSE);
6217}
6218
6219/*
6220 * Return a string with the string representation of a variable.
6221 * If the memory is allocated "tofree" is set to it, otherwise NULL.
6222 * "numbuf" is used for a number.
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006223 * Puts quotes around strings, so that they can be parsed back by eval().
Bram Moolenaar92c5aba2007-08-14 20:29:31 +00006224 * May return NULL.
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006225 */
Bram Moolenaar8110a092016-04-14 15:56:09 +02006226 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01006227tv2string(
6228 typval_T *tv,
6229 char_u **tofree,
6230 char_u *numbuf,
6231 int copyID)
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006232{
Bram Moolenaar18dfb442016-05-31 22:31:23 +02006233 return echo_string_core(tv, tofree, numbuf, copyID, FALSE, TRUE, FALSE);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00006234}
6235
6236/*
Bram Moolenaar33570922005-01-25 22:26:29 +00006237 * Return string "str" in ' quotes, doubling ' characters.
6238 * If "str" is NULL an empty string is assumed.
Bram Moolenaar8c711452005-01-14 21:53:12 +00006239 * If "function" is TRUE make it function('string').
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006240 */
Bram Moolenaarcd524592016-07-17 14:57:05 +02006241 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01006242string_quote(char_u *str, int function)
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006243{
Bram Moolenaar33570922005-01-25 22:26:29 +00006244 unsigned len;
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006245 char_u *p, *r, *s;
6246
Bram Moolenaar33570922005-01-25 22:26:29 +00006247 len = (function ? 13 : 3);
6248 if (str != NULL)
6249 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006250 len += (unsigned)STRLEN(str);
Bram Moolenaar91acfff2017-03-12 19:22:36 +01006251 for (p = str; *p != NUL; MB_PTR_ADV(p))
Bram Moolenaar33570922005-01-25 22:26:29 +00006252 if (*p == '\'')
6253 ++len;
6254 }
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006255 s = r = alloc(len);
6256 if (r != NULL)
6257 {
6258 if (function)
6259 {
Bram Moolenaar8c711452005-01-14 21:53:12 +00006260 STRCPY(r, "function('");
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006261 r += 10;
6262 }
6263 else
Bram Moolenaar8c711452005-01-14 21:53:12 +00006264 *r++ = '\'';
Bram Moolenaar33570922005-01-25 22:26:29 +00006265 if (str != NULL)
6266 for (p = str; *p != NUL; )
6267 {
6268 if (*p == '\'')
6269 *r++ = '\'';
6270 MB_COPY_CHAR(p, r);
6271 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00006272 *r++ = '\'';
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006273 if (function)
6274 *r++ = ')';
6275 *r++ = NUL;
6276 }
6277 return s;
6278}
6279
Bram Moolenaar520e1e42016-01-23 19:46:28 +01006280#if defined(FEAT_FLOAT) || defined(PROTO)
Bram Moolenaar8c8de832008-06-24 22:58:06 +00006281/*
6282 * Convert the string "text" to a floating point number.
6283 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
6284 * this always uses a decimal point.
6285 * Returns the length of the text that was consumed.
6286 */
Bram Moolenaar520e1e42016-01-23 19:46:28 +01006287 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01006288string2float(
6289 char_u *text,
6290 float_T *value) /* result stored here */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00006291{
6292 char *s = (char *)text;
6293 float_T f;
6294
Bram Moolenaar62473612017-01-08 19:25:40 +01006295 /* MS-Windows does not deal with "inf" and "nan" properly. */
6296 if (STRNICMP(text, "inf", 3) == 0)
6297 {
6298 *value = INFINITY;
6299 return 3;
6300 }
6301 if (STRNICMP(text, "-inf", 3) == 0)
6302 {
6303 *value = -INFINITY;
6304 return 4;
6305 }
6306 if (STRNICMP(text, "nan", 3) == 0)
6307 {
6308 *value = NAN;
6309 return 3;
6310 }
Bram Moolenaar8c8de832008-06-24 22:58:06 +00006311 f = strtod(s, &s);
6312 *value = f;
6313 return (int)((char_u *)s - text);
6314}
6315#endif
6316
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00006317/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318 * Get the value of an environment variable.
6319 * "arg" is pointing to the '$'. It is advanced to after the name.
6320 * If the environment variable was not set, silently assume it is empty.
Bram Moolenaare512c8c2014-04-29 17:41:22 +02006321 * Return FAIL if the name is invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322 */
6323 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01006324get_env_tv(char_u **arg, typval_T *rettv, int evaluate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325{
6326 char_u *string = NULL;
6327 int len;
6328 int cc;
6329 char_u *name;
Bram Moolenaar05159a02005-02-26 23:04:13 +00006330 int mustfree = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331
6332 ++*arg;
6333 name = *arg;
6334 len = get_env_len(arg);
6335 if (evaluate)
6336 {
Bram Moolenaare512c8c2014-04-29 17:41:22 +02006337 if (len == 0)
Bram Moolenaar615b9972015-01-14 17:15:05 +01006338 return FAIL; /* invalid empty name */
Bram Moolenaar05159a02005-02-26 23:04:13 +00006339
Bram Moolenaare512c8c2014-04-29 17:41:22 +02006340 cc = name[len];
6341 name[len] = NUL;
6342 /* first try vim_getenv(), fast for normal environment vars */
6343 string = vim_getenv(name, &mustfree);
6344 if (string != NULL && *string != NUL)
6345 {
6346 if (!mustfree)
6347 string = vim_strsave(string);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006348 }
Bram Moolenaare512c8c2014-04-29 17:41:22 +02006349 else
6350 {
6351 if (mustfree)
6352 vim_free(string);
6353
6354 /* next try expanding things like $VIM and ${HOME} */
6355 string = expand_env_save(name - 1);
6356 if (string != NULL && *string == '$')
Bram Moolenaard23a8232018-02-10 18:45:26 +01006357 VIM_CLEAR(string);
Bram Moolenaare512c8c2014-04-29 17:41:22 +02006358 }
6359 name[len] = cc;
6360
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006361 rettv->v_type = VAR_STRING;
6362 rettv->vval.v_string = string;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006363 }
6364
6365 return OK;
6366}
6367
Bram Moolenaard6e256c2011-12-14 15:32:50 +01006368
6369
6370/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006371 * Translate a String variable into a position.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006372 * Returns NULL when there is an error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006373 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02006374 pos_T *
Bram Moolenaar7454a062016-01-30 15:14:10 +01006375var2fpos(
6376 typval_T *varp,
6377 int dollar_lnum, /* TRUE when $ is last line */
6378 int *fnum) /* set to fnum for '0, 'A, etc. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379{
Bram Moolenaar261bfea2006-03-01 22:12:31 +00006380 char_u *name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 static pos_T pos;
Bram Moolenaar261bfea2006-03-01 22:12:31 +00006382 pos_T *pp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383
Bram Moolenaara5525202006-03-02 22:52:09 +00006384 /* Argument can be [lnum, col, coladd]. */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006385 if (varp->v_type == VAR_LIST)
6386 {
6387 list_T *l;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006388 int len;
Bram Moolenaara5525202006-03-02 22:52:09 +00006389 int error = FALSE;
Bram Moolenaar477933c2007-07-17 14:32:23 +00006390 listitem_T *li;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006391
6392 l = varp->vval.v_list;
6393 if (l == NULL)
6394 return NULL;
6395
6396 /* Get the line number */
Bram Moolenaara5525202006-03-02 22:52:09 +00006397 pos.lnum = list_find_nr(l, 0L, &error);
6398 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006399 return NULL; /* invalid line number */
6400
6401 /* Get the column number */
Bram Moolenaara5525202006-03-02 22:52:09 +00006402 pos.col = list_find_nr(l, 1L, &error);
6403 if (error)
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006404 return NULL;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006405 len = (long)STRLEN(ml_get(pos.lnum));
Bram Moolenaar477933c2007-07-17 14:32:23 +00006406
6407 /* We accept "$" for the column number: last column. */
6408 li = list_find(l, 1L);
6409 if (li != NULL && li->li_tv.v_type == VAR_STRING
6410 && li->li_tv.vval.v_string != NULL
6411 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
6412 pos.col = len + 1;
6413
Bram Moolenaara5525202006-03-02 22:52:09 +00006414 /* Accept a position up to the NUL after the line. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00006415 if (pos.col == 0 || (int)pos.col > len + 1)
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006416 return NULL; /* invalid column number */
Bram Moolenaara5525202006-03-02 22:52:09 +00006417 --pos.col;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006418
Bram Moolenaara5525202006-03-02 22:52:09 +00006419 /* Get the virtual offset. Defaults to zero. */
6420 pos.coladd = list_find_nr(l, 2L, &error);
6421 if (error)
6422 pos.coladd = 0;
Bram Moolenaara5525202006-03-02 22:52:09 +00006423
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006424 return &pos;
6425 }
6426
Bram Moolenaard155d7a2018-12-21 16:04:21 +01006427 name = tv_get_string_chk(varp);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00006428 if (name == NULL)
6429 return NULL;
Bram Moolenaar9ecd0232008-06-20 15:31:51 +00006430 if (name[0] == '.') /* cursor */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006431 return &curwin->w_cursor;
Bram Moolenaar9ecd0232008-06-20 15:31:51 +00006432 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
6433 {
6434 if (VIsual_active)
6435 return &VIsual;
6436 return &curwin->w_cursor;
6437 }
Bram Moolenaar9ecd0232008-06-20 15:31:51 +00006438 if (name[0] == '\'') /* mark */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006439 {
Bram Moolenaar9d182dd2013-01-23 15:53:15 +01006440 pp = getmark_buf_fnum(curbuf, name[1], FALSE, fnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006441 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
6442 return NULL;
6443 return pp;
6444 }
Bram Moolenaara5525202006-03-02 22:52:09 +00006445
Bram Moolenaara5525202006-03-02 22:52:09 +00006446 pos.coladd = 0;
Bram Moolenaara5525202006-03-02 22:52:09 +00006447
Bram Moolenaar477933c2007-07-17 14:32:23 +00006448 if (name[0] == 'w' && dollar_lnum)
Bram Moolenaarf52c7252006-02-10 23:23:57 +00006449 {
6450 pos.col = 0;
6451 if (name[1] == '0') /* "w0": first visible line */
6452 {
Bram Moolenaarf740b292006-02-16 22:11:02 +00006453 update_topline();
Bram Moolenaara1d5fa62017-04-03 22:02:55 +02006454 /* In silent Ex mode topline is zero, but that's not a valid line
6455 * number; use one instead. */
6456 pos.lnum = curwin->w_topline > 0 ? curwin->w_topline : 1;
Bram Moolenaarf52c7252006-02-10 23:23:57 +00006457 return &pos;
6458 }
6459 else if (name[1] == '$') /* "w$": last visible line */
6460 {
Bram Moolenaarf740b292006-02-16 22:11:02 +00006461 validate_botline();
Bram Moolenaara1d5fa62017-04-03 22:02:55 +02006462 /* In silent Ex mode botline is zero, return zero then. */
6463 pos.lnum = curwin->w_botline > 0 ? curwin->w_botline - 1 : 0;
Bram Moolenaarf52c7252006-02-10 23:23:57 +00006464 return &pos;
6465 }
6466 }
6467 else if (name[0] == '$') /* last column or line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 {
Bram Moolenaar477933c2007-07-17 14:32:23 +00006469 if (dollar_lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 {
6471 pos.lnum = curbuf->b_ml.ml_line_count;
6472 pos.col = 0;
6473 }
6474 else
6475 {
6476 pos.lnum = curwin->w_cursor.lnum;
6477 pos.col = (colnr_T)STRLEN(ml_get_curline());
6478 }
6479 return &pos;
6480 }
6481 return NULL;
6482}
6483
6484/*
Bram Moolenaar0e34f622006-03-03 23:00:03 +00006485 * Convert list in "arg" into a position and optional file number.
6486 * When "fnump" is NULL there is no file number, only 3 items.
6487 * Note that the column is passed on as-is, the caller may want to decrement
6488 * it to use 1 for the first column.
6489 * Return FAIL when conversion is not possible, doesn't check the position for
6490 * validity.
6491 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02006492 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01006493list2fpos(
6494 typval_T *arg,
6495 pos_T *posp,
6496 int *fnump,
6497 colnr_T *curswantp)
Bram Moolenaar0e34f622006-03-03 23:00:03 +00006498{
6499 list_T *l = arg->vval.v_list;
6500 long i = 0;
6501 long n;
6502
Bram Moolenaar493c1782014-05-28 14:34:46 +02006503 /* List must be: [fnum, lnum, col, coladd, curswant], where "fnum" is only
6504 * there when "fnump" isn't NULL; "coladd" and "curswant" are optional. */
Bram Moolenaarbde35262006-07-23 20:12:24 +00006505 if (arg->v_type != VAR_LIST
6506 || l == NULL
6507 || l->lv_len < (fnump == NULL ? 2 : 3)
Bram Moolenaar493c1782014-05-28 14:34:46 +02006508 || l->lv_len > (fnump == NULL ? 4 : 5))
Bram Moolenaar0e34f622006-03-03 23:00:03 +00006509 return FAIL;
6510
6511 if (fnump != NULL)
6512 {
6513 n = list_find_nr(l, i++, NULL); /* fnum */
6514 if (n < 0)
6515 return FAIL;
6516 if (n == 0)
6517 n = curbuf->b_fnum; /* current buffer */
6518 *fnump = n;
6519 }
6520
6521 n = list_find_nr(l, i++, NULL); /* lnum */
6522 if (n < 0)
6523 return FAIL;
6524 posp->lnum = n;
6525
6526 n = list_find_nr(l, i++, NULL); /* col */
6527 if (n < 0)
6528 return FAIL;
6529 posp->col = n;
6530
Bram Moolenaar493c1782014-05-28 14:34:46 +02006531 n = list_find_nr(l, i, NULL); /* off */
Bram Moolenaar0e34f622006-03-03 23:00:03 +00006532 if (n < 0)
Bram Moolenaarbde35262006-07-23 20:12:24 +00006533 posp->coladd = 0;
6534 else
6535 posp->coladd = n;
Bram Moolenaar0e34f622006-03-03 23:00:03 +00006536
Bram Moolenaar493c1782014-05-28 14:34:46 +02006537 if (curswantp != NULL)
6538 *curswantp = list_find_nr(l, i + 1, NULL); /* curswant */
6539
Bram Moolenaar0e34f622006-03-03 23:00:03 +00006540 return OK;
6541}
6542
6543/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544 * Get the length of an environment variable name.
6545 * Advance "arg" to the first character after the name.
6546 * Return 0 for error.
6547 */
6548 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +01006549get_env_len(char_u **arg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550{
6551 char_u *p;
6552 int len;
6553
6554 for (p = *arg; vim_isIDc(*p); ++p)
6555 ;
6556 if (p == *arg) /* no name found */
6557 return 0;
6558
6559 len = (int)(p - *arg);
6560 *arg = p;
6561 return len;
6562}
6563
6564/*
6565 * Get the length of the name of a function or internal variable.
6566 * "arg" is advanced to the first non-white character after the name.
6567 * Return 0 if something is wrong.
6568 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006569 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01006570get_id_len(char_u **arg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571{
6572 char_u *p;
6573 int len;
6574
6575 /* Find the end of the name. */
6576 for (p = *arg; eval_isnamec(*p); ++p)
Bram Moolenaar9bbf63d2016-01-16 16:49:28 +01006577 {
6578 if (*p == ':')
6579 {
6580 /* "s:" is start of "s:var", but "n:" is not and can be used in
6581 * slice "[n:]". Also "xx:" is not a namespace. */
6582 len = (int)(p - *arg);
6583 if ((len == 1 && vim_strchr(NAMESPACE_CHAR, **arg) == NULL)
6584 || len > 1)
6585 break;
6586 }
6587 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 if (p == *arg) /* no name found */
6589 return 0;
6590
6591 len = (int)(p - *arg);
6592 *arg = skipwhite(p);
6593
6594 return len;
6595}
6596
6597/*
Bram Moolenaara7043832005-01-21 11:56:39 +00006598 * Get the length of the name of a variable or function.
6599 * Only the name is recognized, does not handle ".key" or "[idx]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600 * "arg" is advanced to the first non-white character after the name.
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00006601 * Return -1 if curly braces expansion failed.
6602 * Return 0 if something else is wrong.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 * If the name contains 'magic' {}'s, expand them and return the
6604 * expanded name in an allocated string via 'alias' - caller must free.
6605 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02006606 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01006607get_name_len(
6608 char_u **arg,
6609 char_u **alias,
6610 int evaluate,
6611 int verbose)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006612{
6613 int len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 char_u *p;
6615 char_u *expr_start;
6616 char_u *expr_end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617
6618 *alias = NULL; /* default to no alias */
6619
6620 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
6621 && (*arg)[2] == (int)KE_SNR)
6622 {
6623 /* hard coded <SNR>, already translated */
6624 *arg += 3;
6625 return get_id_len(arg) + 3;
6626 }
6627 len = eval_fname_script(*arg);
6628 if (len > 0)
6629 {
6630 /* literal "<SID>", "s:" or "<SNR>" */
6631 *arg += len;
6632 }
6633
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 /*
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006635 * Find the end of the name; check for {} construction.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006636 */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00006637 p = find_name_end(*arg, &expr_start, &expr_end,
6638 len > 0 ? 0 : FNE_CHECK_START);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 if (expr_start != NULL)
6640 {
6641 char_u *temp_string;
6642
6643 if (!evaluate)
6644 {
6645 len += (int)(p - *arg);
6646 *arg = skipwhite(p);
6647 return len;
6648 }
6649
6650 /*
6651 * Include any <SID> etc in the expanded string:
6652 * Thus the -len here.
6653 */
6654 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
6655 if (temp_string == NULL)
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00006656 return -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 *alias = temp_string;
6658 *arg = skipwhite(p);
6659 return (int)STRLEN(temp_string);
6660 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661
6662 len += get_id_len(arg);
Bram Moolenaar8309b052019-01-13 16:46:22 +01006663 // Only give an error when there is something, otherwise it will be
6664 // reported at a higher level.
6665 if (len == 0 && verbose && **arg != NUL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006666 semsg(_(e_invexpr2), *arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667
6668 return len;
6669}
6670
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006671/*
6672 * Find the end of a variable or function name, taking care of magic braces.
6673 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
6674 * start and end of the first magic braces item.
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00006675 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006676 * Return a pointer to just after the name. Equal to "arg" if there is no
6677 * valid name.
6678 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006679 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01006680find_name_end(
6681 char_u *arg,
6682 char_u **expr_start,
6683 char_u **expr_end,
6684 int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685{
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006686 int mb_nest = 0;
6687 int br_nest = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 char_u *p;
Bram Moolenaar9bbf63d2016-01-16 16:49:28 +01006689 int len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006691 if (expr_start != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006693 *expr_start = NULL;
6694 *expr_end = NULL;
6695 }
6696
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00006697 /* Quick check for valid starting character. */
6698 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
6699 return arg;
6700
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006701 for (p = arg; *p != NUL
6702 && (eval_isnamec(*p)
Bram Moolenaare9a41262005-01-15 22:18:47 +00006703 || *p == '{'
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00006704 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006705 || mb_nest != 0
Bram Moolenaar91acfff2017-03-12 19:22:36 +01006706 || br_nest != 0); MB_PTR_ADV(p))
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006707 {
Bram Moolenaar8af24422005-08-08 22:06:28 +00006708 if (*p == '\'')
6709 {
6710 /* skip over 'string' to avoid counting [ and ] inside it. */
Bram Moolenaar91acfff2017-03-12 19:22:36 +01006711 for (p = p + 1; *p != NUL && *p != '\''; MB_PTR_ADV(p))
Bram Moolenaar8af24422005-08-08 22:06:28 +00006712 ;
6713 if (*p == NUL)
6714 break;
6715 }
6716 else if (*p == '"')
6717 {
6718 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
Bram Moolenaar91acfff2017-03-12 19:22:36 +01006719 for (p = p + 1; *p != NUL && *p != '"'; MB_PTR_ADV(p))
Bram Moolenaar8af24422005-08-08 22:06:28 +00006720 if (*p == '\\' && p[1] != NUL)
6721 ++p;
6722 if (*p == NUL)
6723 break;
6724 }
Bram Moolenaar9bbf63d2016-01-16 16:49:28 +01006725 else if (br_nest == 0 && mb_nest == 0 && *p == ':')
6726 {
6727 /* "s:" is start of "s:var", but "n:" is not and can be used in
Bram Moolenaar4119cf82016-01-17 14:59:01 +01006728 * slice "[n:]". Also "xx:" is not a namespace. But {ns}: is. */
Bram Moolenaar9bbf63d2016-01-16 16:49:28 +01006729 len = (int)(p - arg);
6730 if ((len == 1 && vim_strchr(NAMESPACE_CHAR, *arg) == NULL)
Bram Moolenaar4119cf82016-01-17 14:59:01 +01006731 || (len > 1 && p[-1] != '}'))
Bram Moolenaar9bbf63d2016-01-16 16:49:28 +01006732 break;
6733 }
Bram Moolenaar8af24422005-08-08 22:06:28 +00006734
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006735 if (mb_nest == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006736 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006737 if (*p == '[')
6738 ++br_nest;
6739 else if (*p == ']')
6740 --br_nest;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006741 }
Bram Moolenaar8af24422005-08-08 22:06:28 +00006742
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006743 if (br_nest == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006744 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00006745 if (*p == '{')
6746 {
6747 mb_nest++;
6748 if (expr_start != NULL && *expr_start == NULL)
6749 *expr_start = p;
6750 }
6751 else if (*p == '}')
6752 {
6753 mb_nest--;
6754 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
6755 *expr_end = p;
6756 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006757 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 }
6759
6760 return p;
6761}
6762
6763/*
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00006764 * Expands out the 'magic' {}'s in a variable/function name.
6765 * Note that this can call itself recursively, to deal with
6766 * constructs like foo{bar}{baz}{bam}
6767 * The four pointer arguments point to "foo{expre}ss{ion}bar"
6768 * "in_start" ^
6769 * "expr_start" ^
6770 * "expr_end" ^
6771 * "in_end" ^
6772 *
6773 * Returns a new allocated string, which the caller must free.
6774 * Returns NULL for failure.
6775 */
6776 static char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01006777make_expanded_name(
6778 char_u *in_start,
6779 char_u *expr_start,
6780 char_u *expr_end,
6781 char_u *in_end)
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00006782{
6783 char_u c1;
6784 char_u *retval = NULL;
6785 char_u *temp_result;
6786 char_u *nextcmd = NULL;
6787
6788 if (expr_end == NULL || in_end == NULL)
6789 return NULL;
6790 *expr_start = NUL;
6791 *expr_end = NUL;
6792 c1 = *in_end;
6793 *in_end = NUL;
6794
Bram Moolenaar362e1a32006-03-06 23:29:24 +00006795 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00006796 if (temp_result != NULL && nextcmd == NULL)
6797 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02006798 retval = alloc(STRLEN(temp_result) + (expr_start - in_start)
6799 + (in_end - expr_end) + 1);
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00006800 if (retval != NULL)
6801 {
6802 STRCPY(retval, in_start);
6803 STRCAT(retval, temp_result);
6804 STRCAT(retval, expr_end + 1);
6805 }
6806 }
6807 vim_free(temp_result);
6808
6809 *in_end = c1; /* put char back for error messages */
6810 *expr_start = '{';
6811 *expr_end = '}';
6812
6813 if (retval != NULL)
6814 {
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00006815 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00006816 if (expr_start != NULL)
6817 {
6818 /* Further expansion! */
6819 temp_result = make_expanded_name(retval, expr_start,
6820 expr_end, temp_result);
6821 vim_free(retval);
6822 retval = temp_result;
6823 }
6824 }
6825
6826 return retval;
6827}
6828
6829/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 * Return TRUE if character "c" can be used in a variable or function name.
Bram Moolenaare9a41262005-01-15 22:18:47 +00006831 * Does not include '{' or '}' for magic braces.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006833 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01006834eval_isnamec(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835{
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00006836 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
6837}
6838
6839/*
6840 * Return TRUE if character "c" can be used as the first character in a
6841 * variable or function name (excluding '{' and '}').
6842 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006843 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01006844eval_isnamec1(int c)
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00006845{
6846 return (ASCII_ISALPHA(c) || c == '_');
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847}
6848
6849/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006850 * Set number v: variable to "val".
6851 */
6852 void
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02006853set_vim_var_nr(int idx, varnumber_T val)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854{
Bram Moolenaare9a41262005-01-15 22:18:47 +00006855 vimvars[idx].vv_nr = val;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856}
6857
6858/*
Bram Moolenaar19a09a12005-03-04 23:39:37 +00006859 * Get number v: variable value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02006861 varnumber_T
Bram Moolenaar7454a062016-01-30 15:14:10 +01006862get_vim_var_nr(int idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863{
Bram Moolenaare9a41262005-01-15 22:18:47 +00006864 return vimvars[idx].vv_nr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006865}
6866
Bram Moolenaar19a09a12005-03-04 23:39:37 +00006867/*
6868 * Get string v: variable value. Uses a static buffer, can only be used once.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01006869 * If the String variable has never been set, return an empty string.
6870 * Never returns NULL;
Bram Moolenaar19a09a12005-03-04 23:39:37 +00006871 */
6872 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01006873get_vim_var_str(int idx)
Bram Moolenaar19a09a12005-03-04 23:39:37 +00006874{
Bram Moolenaard155d7a2018-12-21 16:04:21 +01006875 return tv_get_string(&vimvars[idx].vv_tv);
Bram Moolenaar19a09a12005-03-04 23:39:37 +00006876}
Bram Moolenaar19a09a12005-03-04 23:39:37 +00006877
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878/*
Bram Moolenaard812df62008-11-09 12:46:09 +00006879 * Get List v: variable value. Caller must take care of reference count when
6880 * needed.
6881 */
6882 list_T *
Bram Moolenaar7454a062016-01-30 15:14:10 +01006883get_vim_var_list(int idx)
Bram Moolenaard812df62008-11-09 12:46:09 +00006884{
6885 return vimvars[idx].vv_list;
6886}
6887
6888/*
Bram Moolenaar7e1652c2017-12-16 18:27:02 +01006889 * Get Dict v: variable value. Caller must take care of reference count when
6890 * needed.
6891 */
6892 dict_T *
6893get_vim_var_dict(int idx)
6894{
6895 return vimvars[idx].vv_dict;
6896}
6897
6898/*
Bram Moolenaarda9591e2009-09-30 13:17:02 +00006899 * Set v:char to character "c".
6900 */
6901 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01006902set_vim_var_char(int c)
Bram Moolenaarda9591e2009-09-30 13:17:02 +00006903{
Bram Moolenaar9a920d82012-06-01 15:21:02 +02006904 char_u buf[MB_MAXBYTES + 1];
Bram Moolenaarda9591e2009-09-30 13:17:02 +00006905
Bram Moolenaarda9591e2009-09-30 13:17:02 +00006906 if (has_mbyte)
6907 buf[(*mb_char2bytes)(c, buf)] = NUL;
6908 else
Bram Moolenaarda9591e2009-09-30 13:17:02 +00006909 {
6910 buf[0] = c;
6911 buf[1] = NUL;
6912 }
6913 set_vim_var_string(VV_CHAR, buf, -1);
6914}
6915
6916/*
Bram Moolenaar8df74be2008-11-20 15:12:02 +00006917 * Set v:count to "count" and v:count1 to "count1".
6918 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 */
6920 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01006921set_vcount(
6922 long count,
6923 long count1,
6924 int set_prevcount)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925{
Bram Moolenaar8df74be2008-11-20 15:12:02 +00006926 if (set_prevcount)
6927 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
Bram Moolenaare9a41262005-01-15 22:18:47 +00006928 vimvars[VV_COUNT].vv_nr = count;
6929 vimvars[VV_COUNT1].vv_nr = count1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930}
6931
6932/*
Bram Moolenaarb0f42ba2018-05-12 15:38:26 +02006933 * Save variables that might be changed as a side effect. Used when executing
6934 * a timer callback.
6935 */
6936 void
6937save_vimvars(vimvars_save_T *vvsave)
6938{
6939 vvsave->vv_prevcount = vimvars[VV_PREVCOUNT].vv_nr;
6940 vvsave->vv_count = vimvars[VV_COUNT].vv_nr;
6941 vvsave->vv_count1 = vimvars[VV_COUNT1].vv_nr;
6942}
6943
6944/*
6945 * Restore variables saved by save_vimvars().
6946 */
6947 void
6948restore_vimvars(vimvars_save_T *vvsave)
6949{
6950 vimvars[VV_PREVCOUNT].vv_nr = vvsave->vv_prevcount;
6951 vimvars[VV_COUNT].vv_nr = vvsave->vv_count;
6952 vimvars[VV_COUNT1].vv_nr = vvsave->vv_count1;
6953}
6954
6955/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 * Set string v: variable to a copy of "val".
6957 */
6958 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01006959set_vim_var_string(
6960 int idx,
6961 char_u *val,
6962 int len) /* length of "val" to use or -1 (whole string) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006963{
Bram Moolenaara542c682016-01-31 16:28:04 +01006964 clear_tv(&vimvars[idx].vv_di.di_tv);
6965 vimvars[idx].vv_type = VAR_STRING;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966 if (val == NULL)
Bram Moolenaare9a41262005-01-15 22:18:47 +00006967 vimvars[idx].vv_str = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006968 else if (len == -1)
Bram Moolenaare9a41262005-01-15 22:18:47 +00006969 vimvars[idx].vv_str = vim_strsave(val);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006970 else
Bram Moolenaare9a41262005-01-15 22:18:47 +00006971 vimvars[idx].vv_str = vim_strnsave(val, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006972}
6973
6974/*
Bram Moolenaard812df62008-11-09 12:46:09 +00006975 * Set List v: variable to "val".
6976 */
6977 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01006978set_vim_var_list(int idx, list_T *val)
Bram Moolenaard812df62008-11-09 12:46:09 +00006979{
Bram Moolenaara542c682016-01-31 16:28:04 +01006980 clear_tv(&vimvars[idx].vv_di.di_tv);
6981 vimvars[idx].vv_type = VAR_LIST;
Bram Moolenaard812df62008-11-09 12:46:09 +00006982 vimvars[idx].vv_list = val;
6983 if (val != NULL)
6984 ++val->lv_refcount;
6985}
6986
6987/*
Bram Moolenaar42a45122015-07-10 17:56:23 +02006988 * Set Dictionary v: variable to "val".
6989 */
6990 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01006991set_vim_var_dict(int idx, dict_T *val)
Bram Moolenaar42a45122015-07-10 17:56:23 +02006992{
Bram Moolenaara542c682016-01-31 16:28:04 +01006993 clear_tv(&vimvars[idx].vv_di.di_tv);
6994 vimvars[idx].vv_type = VAR_DICT;
Bram Moolenaar42a45122015-07-10 17:56:23 +02006995 vimvars[idx].vv_dict = val;
6996 if (val != NULL)
6997 {
6998 ++val->dv_refcount;
Bram Moolenaar7e1652c2017-12-16 18:27:02 +01006999 dict_set_items_ro(val);
Bram Moolenaar42a45122015-07-10 17:56:23 +02007000 }
7001}
7002
7003/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007004 * Set v:register if needed.
7005 */
7006 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007007set_reg_var(int c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008{
7009 char_u regname;
7010
7011 if (c == 0 || c == ' ')
7012 regname = '"';
7013 else
7014 regname = c;
7015 /* Avoid free/alloc when the value is already right. */
Bram Moolenaare9a41262005-01-15 22:18:47 +00007016 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007017 set_vim_var_string(VV_REG, &regname, 1);
7018}
7019
7020/*
7021 * Get or set v:exception. If "oldval" == NULL, return the current value.
7022 * Otherwise, restore the value to "oldval" and return NULL.
7023 * Must always be called in pairs to save and restore v:exception! Does not
7024 * take care of memory allocations.
7025 */
7026 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007027v_exception(char_u *oldval)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028{
7029 if (oldval == NULL)
Bram Moolenaare9a41262005-01-15 22:18:47 +00007030 return vimvars[VV_EXCEPTION].vv_str;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031
Bram Moolenaare9a41262005-01-15 22:18:47 +00007032 vimvars[VV_EXCEPTION].vv_str = oldval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007033 return NULL;
7034}
7035
7036/*
7037 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
7038 * Otherwise, restore the value to "oldval" and return NULL.
7039 * Must always be called in pairs to save and restore v:throwpoint! Does not
7040 * take care of memory allocations.
7041 */
7042 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007043v_throwpoint(char_u *oldval)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044{
7045 if (oldval == NULL)
Bram Moolenaare9a41262005-01-15 22:18:47 +00007046 return vimvars[VV_THROWPOINT].vv_str;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047
Bram Moolenaare9a41262005-01-15 22:18:47 +00007048 vimvars[VV_THROWPOINT].vv_str = oldval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 return NULL;
7050}
7051
Bram Moolenaar071d4272004-06-13 20:20:40 +00007052/*
7053 * Set v:cmdarg.
7054 * If "eap" != NULL, use "eap" to generate the value and return the old value.
7055 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
7056 * Must always be called in pairs!
7057 */
7058 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007059set_cmdarg(exarg_T *eap, char_u *oldarg)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060{
7061 char_u *oldval;
7062 char_u *newval;
7063 unsigned len;
7064
Bram Moolenaare9a41262005-01-15 22:18:47 +00007065 oldval = vimvars[VV_CMDARG].vv_str;
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007066 if (eap == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007067 {
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007068 vim_free(oldval);
Bram Moolenaare9a41262005-01-15 22:18:47 +00007069 vimvars[VV_CMDARG].vv_str = oldarg;
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007070 return NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007071 }
7072
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007073 if (eap->force_bin == FORCE_BIN)
7074 len = 6;
7075 else if (eap->force_bin == FORCE_NOBIN)
7076 len = 8;
7077 else
7078 len = 0;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007079
7080 if (eap->read_edit)
7081 len += 7;
7082
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007083 if (eap->force_ff != 0)
Bram Moolenaar333b80a2018-04-04 22:57:29 +02007084 len += 10; /* " ++ff=unix" */
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007085 if (eap->force_enc != 0)
7086 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
Bram Moolenaar34b4daf2010-05-16 13:26:25 +02007087 if (eap->bad_char != 0)
7088 len += 7 + 4; /* " ++bad=" + "keep" or "drop" */
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007089
7090 newval = alloc(len + 1);
7091 if (newval == NULL)
7092 return NULL;
7093
7094 if (eap->force_bin == FORCE_BIN)
7095 sprintf((char *)newval, " ++bin");
7096 else if (eap->force_bin == FORCE_NOBIN)
7097 sprintf((char *)newval, " ++nobin");
7098 else
7099 *newval = NUL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007100
7101 if (eap->read_edit)
7102 STRCAT(newval, " ++edit");
7103
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007104 if (eap->force_ff != 0)
7105 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
Bram Moolenaar333b80a2018-04-04 22:57:29 +02007106 eap->force_ff == 'u' ? "unix"
7107 : eap->force_ff == 'd' ? "dos"
7108 : "mac");
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007109 if (eap->force_enc != 0)
7110 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
7111 eap->cmd + eap->force_enc);
Bram Moolenaar34b4daf2010-05-16 13:26:25 +02007112 if (eap->bad_char == BAD_KEEP)
7113 STRCPY(newval + STRLEN(newval), " ++bad=keep");
7114 else if (eap->bad_char == BAD_DROP)
7115 STRCPY(newval + STRLEN(newval), " ++bad=drop");
7116 else if (eap->bad_char != 0)
7117 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
Bram Moolenaare9a41262005-01-15 22:18:47 +00007118 vimvars[VV_CMDARG].vv_str = newval;
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00007119 return oldval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007121
7122/*
7123 * Get the value of internal variable "name".
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01007124 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02007126 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01007127get_var_tv(
7128 char_u *name,
7129 int len, /* length of "name" */
7130 typval_T *rettv, /* NULL when only checking existence */
7131 dictitem_T **dip, /* non-NULL when typval's dict item is needed */
7132 int verbose, /* may give error message */
7133 int no_autoload) /* do not use script autoloading */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134{
7135 int ret = OK;
Bram Moolenaar33570922005-01-25 22:26:29 +00007136 typval_T *tv = NULL;
Bram Moolenaar33570922005-01-25 22:26:29 +00007137 dictitem_T *v;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138 int cc;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139
7140 /* truncate the name, so that we can use strcmp() */
7141 cc = name[len];
7142 name[len] = NUL;
7143
7144 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007145 * Check for user-defined variables.
7146 */
Bram Moolenaar79518e22017-02-17 16:31:35 +01007147 v = find_var(name, NULL, no_autoload);
7148 if (v != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 {
Bram Moolenaar79518e22017-02-17 16:31:35 +01007150 tv = &v->di_tv;
7151 if (dip != NULL)
7152 *dip = v;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 }
7154
Bram Moolenaare9a41262005-01-15 22:18:47 +00007155 if (tv == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156 {
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00007157 if (rettv != NULL && verbose)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007158 semsg(_(e_undefvar), name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 ret = FAIL;
7160 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007161 else if (rettv != NULL)
Bram Moolenaare9a41262005-01-15 22:18:47 +00007162 copy_tv(tv, rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163
7164 name[len] = cc;
7165
7166 return ret;
7167}
7168
7169/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02007170 * Check if variable "name[len]" is a local variable or an argument.
7171 * If so, "*eval_lavars_used" is set to TRUE.
7172 */
7173 static void
7174check_vars(char_u *name, int len)
7175{
7176 int cc;
7177 char_u *varname;
7178 hashtab_T *ht;
7179
7180 if (eval_lavars_used == NULL)
7181 return;
7182
7183 /* truncate the name, so that we can use strcmp() */
7184 cc = name[len];
7185 name[len] = NUL;
7186
7187 ht = find_var_ht(name, &varname);
7188 if (ht == get_funccal_local_ht() || ht == get_funccal_args_ht())
7189 {
7190 if (find_var(name, NULL, TRUE) != NULL)
7191 *eval_lavars_used = TRUE;
7192 }
7193
7194 name[len] = cc;
7195}
7196
7197/*
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00007198 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
7199 * Also handle function call with Funcref variable: func(expr)
7200 * Can all be combined: dict.func(expr)[idx]['func'](expr)
7201 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007202 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01007203handle_subscript(
7204 char_u **arg,
7205 typval_T *rettv,
7206 int evaluate, /* do more than finding the end */
7207 int verbose) /* give error messages */
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00007208{
7209 int ret = OK;
7210 dict_T *selfdict = NULL;
7211 char_u *s;
7212 int len;
Bram Moolenaard9fba312005-06-26 22:34:35 +00007213 typval_T functv;
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00007214
7215 while (ret == OK
7216 && (**arg == '['
7217 || (**arg == '.' && rettv->v_type == VAR_DICT)
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007218 || (**arg == '(' && (!evaluate || rettv->v_type == VAR_FUNC
7219 || rettv->v_type == VAR_PARTIAL)))
Bram Moolenaar1c465442017-03-12 20:10:05 +01007220 && !VIM_ISWHITE(*(*arg - 1)))
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00007221 {
7222 if (**arg == '(')
7223 {
Bram Moolenaar3f242a82016-03-18 19:39:25 +01007224 partial_T *pt = NULL;
7225
Bram Moolenaard9fba312005-06-26 22:34:35 +00007226 /* need to copy the funcref so that we can clear rettv */
Bram Moolenaar0f8de8d2013-11-11 04:25:53 +01007227 if (evaluate)
7228 {
7229 functv = *rettv;
7230 rettv->v_type = VAR_UNKNOWN;
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00007231
Bram Moolenaar0f8de8d2013-11-11 04:25:53 +01007232 /* Invoke the function. Recursive! */
Bram Moolenaarab1fa392016-03-15 19:33:34 +01007233 if (functv.v_type == VAR_PARTIAL)
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007234 {
7235 pt = functv.vval.v_partial;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02007236 s = partial_name(pt);
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007237 }
7238 else
7239 s = functv.vval.v_string;
Bram Moolenaar0f8de8d2013-11-11 04:25:53 +01007240 }
7241 else
7242 s = (char_u *)"";
Bram Moolenaar6ed88192019-05-11 18:37:44 +02007243 ret = get_func_tv(s, -1, rettv, arg,
Bram Moolenaard9fba312005-06-26 22:34:35 +00007244 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007245 &len, evaluate, pt, selfdict);
Bram Moolenaard9fba312005-06-26 22:34:35 +00007246
7247 /* Clear the funcref afterwards, so that deleting it while
7248 * evaluating the arguments is possible (see test55). */
Bram Moolenaar0f8de8d2013-11-11 04:25:53 +01007249 if (evaluate)
7250 clear_tv(&functv);
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00007251
7252 /* Stop the expression evaluation when immediately aborting on
7253 * error, or when an interrupt occurred or an exception was thrown
7254 * but not caught. */
7255 if (aborting())
7256 {
7257 if (ret == OK)
7258 clear_tv(rettv);
7259 ret = FAIL;
7260 }
7261 dict_unref(selfdict);
7262 selfdict = NULL;
7263 }
7264 else /* **arg == '[' || **arg == '.' */
7265 {
7266 dict_unref(selfdict);
7267 if (rettv->v_type == VAR_DICT)
7268 {
7269 selfdict = rettv->vval.v_dict;
7270 if (selfdict != NULL)
7271 ++selfdict->dv_refcount;
7272 }
7273 else
7274 selfdict = NULL;
7275 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
7276 {
7277 clear_tv(rettv);
7278 ret = FAIL;
7279 }
7280 }
7281 }
Bram Moolenaarab1fa392016-03-15 19:33:34 +01007282
Bram Moolenaar1d429612016-05-24 15:44:17 +02007283 /* Turn "dict.Func" into a partial for "Func" bound to "dict".
7284 * Don't do this when "Func" is already a partial that was bound
7285 * explicitly (pt_auto is FALSE). */
7286 if (selfdict != NULL
7287 && (rettv->v_type == VAR_FUNC
7288 || (rettv->v_type == VAR_PARTIAL
7289 && (rettv->vval.v_partial->pt_auto
7290 || rettv->vval.v_partial->pt_dict == NULL))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007291 selfdict = make_partial(selfdict, rettv);
Bram Moolenaarab1fa392016-03-15 19:33:34 +01007292
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00007293 dict_unref(selfdict);
7294 return ret;
7295}
7296
7297/*
Bram Moolenaar8c8de832008-06-24 22:58:06 +00007298 * Allocate memory for a variable type-value, and make it empty (0 or NULL
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007299 * value).
7300 */
Bram Moolenaar11e0afa2016-02-01 22:41:00 +01007301 typval_T *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007302alloc_tv(void)
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007303{
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02007304 return (typval_T *)alloc_clear(sizeof(typval_T));
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007305}
7306
7307/*
7308 * Allocate memory for a variable type-value, and assign a string to it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007309 * The string "s" must have been allocated, it is consumed.
7310 * Return NULL for out of memory, the variable otherwise.
7311 */
Bram Moolenaar33570922005-01-25 22:26:29 +00007312 static typval_T *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007313alloc_string_tv(char_u *s)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007314{
Bram Moolenaar33570922005-01-25 22:26:29 +00007315 typval_T *rettv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007317 rettv = alloc_tv();
7318 if (rettv != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007319 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007320 rettv->v_type = VAR_STRING;
7321 rettv->vval.v_string = s;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007322 }
7323 else
7324 vim_free(s);
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007325 return rettv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326}
7327
7328/*
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007329 * Free the memory for a variable type-value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007330 */
Bram Moolenaar4770d092006-01-12 23:22:24 +00007331 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007332free_tv(typval_T *varp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007333{
7334 if (varp != NULL)
7335 {
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007336 switch (varp->v_type)
7337 {
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007338 case VAR_FUNC:
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00007339 func_unref(varp->vval.v_string);
Bram Moolenaar2f40d122017-10-24 21:49:36 +02007340 /* FALLTHROUGH */
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00007341 case VAR_STRING:
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007342 vim_free(varp->vval.v_string);
7343 break;
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007344 case VAR_PARTIAL:
7345 partial_unref(varp->vval.v_partial);
7346 break;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007347 case VAR_BLOB:
7348 blob_unref(varp->vval.v_blob);
7349 break;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007350 case VAR_LIST:
7351 list_unref(varp->vval.v_list);
7352 break;
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00007353 case VAR_DICT:
7354 dict_unref(varp->vval.v_dict);
7355 break;
Bram Moolenaar835dc632016-02-07 14:27:38 +01007356 case VAR_JOB:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007357#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar835dc632016-02-07 14:27:38 +01007358 job_unref(varp->vval.v_job);
7359 break;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00007360#endif
Bram Moolenaar77073442016-02-13 23:23:53 +01007361 case VAR_CHANNEL:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007362#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar77073442016-02-13 23:23:53 +01007363 channel_unref(varp->vval.v_channel);
7364 break;
7365#endif
Bram Moolenaar835dc632016-02-07 14:27:38 +01007366 case VAR_NUMBER:
7367 case VAR_FLOAT:
Bram Moolenaar758711c2005-02-02 23:11:38 +00007368 case VAR_UNKNOWN:
Bram Moolenaar6650a692016-01-26 19:59:10 +01007369 case VAR_SPECIAL:
Bram Moolenaar758711c2005-02-02 23:11:38 +00007370 break;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007371 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007372 vim_free(varp);
7373 }
7374}
7375
7376/*
7377 * Free the memory for a variable value and set the value to NULL or 0.
7378 */
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00007379 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007380clear_tv(typval_T *varp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007381{
7382 if (varp != NULL)
7383 {
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007384 switch (varp->v_type)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385 {
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007386 case VAR_FUNC:
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00007387 func_unref(varp->vval.v_string);
Bram Moolenaar2f40d122017-10-24 21:49:36 +02007388 /* FALLTHROUGH */
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00007389 case VAR_STRING:
Bram Moolenaard23a8232018-02-10 18:45:26 +01007390 VIM_CLEAR(varp->vval.v_string);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007391 break;
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007392 case VAR_PARTIAL:
7393 partial_unref(varp->vval.v_partial);
7394 varp->vval.v_partial = NULL;
7395 break;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007396 case VAR_BLOB:
7397 blob_unref(varp->vval.v_blob);
7398 varp->vval.v_blob = NULL;
7399 break;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007400 case VAR_LIST:
7401 list_unref(varp->vval.v_list);
Bram Moolenaarce5e58e2005-01-19 22:24:34 +00007402 varp->vval.v_list = NULL;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007403 break;
Bram Moolenaar8c711452005-01-14 21:53:12 +00007404 case VAR_DICT:
7405 dict_unref(varp->vval.v_dict);
Bram Moolenaarce5e58e2005-01-19 22:24:34 +00007406 varp->vval.v_dict = NULL;
Bram Moolenaar8c711452005-01-14 21:53:12 +00007407 break;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007408 case VAR_NUMBER:
Bram Moolenaar520e1e42016-01-23 19:46:28 +01007409 case VAR_SPECIAL:
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007410 varp->vval.v_number = 0;
7411 break;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00007412 case VAR_FLOAT:
Bram Moolenaar835dc632016-02-07 14:27:38 +01007413#ifdef FEAT_FLOAT
Bram Moolenaar8c8de832008-06-24 22:58:06 +00007414 varp->vval.v_float = 0.0;
7415 break;
7416#endif
Bram Moolenaar835dc632016-02-07 14:27:38 +01007417 case VAR_JOB:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007418#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar835dc632016-02-07 14:27:38 +01007419 job_unref(varp->vval.v_job);
7420 varp->vval.v_job = NULL;
7421#endif
7422 break;
Bram Moolenaar77073442016-02-13 23:23:53 +01007423 case VAR_CHANNEL:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007424#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar77073442016-02-13 23:23:53 +01007425 channel_unref(varp->vval.v_channel);
7426 varp->vval.v_channel = NULL;
7427#endif
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007428 case VAR_UNKNOWN:
7429 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007430 }
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00007431 varp->v_lock = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 }
7433}
7434
7435/*
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007436 * Set the value of a variable to NULL without freeing items.
7437 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02007438 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007439init_tv(typval_T *varp)
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007440{
7441 if (varp != NULL)
Bram Moolenaar33570922005-01-25 22:26:29 +00007442 vim_memset(varp, 0, sizeof(typval_T));
Bram Moolenaarc70646c2005-01-04 21:52:38 +00007443}
7444
7445/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446 * Get the number value of a variable.
7447 * If it is a String variable, uses vim_str2nr().
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007448 * For incompatible types, return 0.
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007449 * tv_get_number_chk() is similar to tv_get_number(), but informs the
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007450 * caller of incompatible types: it sets *denote to TRUE if "denote"
7451 * is not NULL or returns -1 otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007452 */
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02007453 varnumber_T
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007454tv_get_number(typval_T *varp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455{
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007456 int error = FALSE;
7457
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007458 return tv_get_number_chk(varp, &error); /* return 0L on error */
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007459}
7460
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02007461 varnumber_T
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007462tv_get_number_chk(typval_T *varp, int *denote)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007463{
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02007464 varnumber_T n = 0L;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007466 switch (varp->v_type)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467 {
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007468 case VAR_NUMBER:
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02007469 return varp->vval.v_number;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00007470 case VAR_FLOAT:
Bram Moolenaar835dc632016-02-07 14:27:38 +01007471#ifdef FEAT_FLOAT
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007472 emsg(_("E805: Using a Float as a Number"));
Bram Moolenaar8c8de832008-06-24 22:58:06 +00007473 break;
7474#endif
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007475 case VAR_FUNC:
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007476 case VAR_PARTIAL:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007477 emsg(_("E703: Using a Funcref as a Number"));
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007478 break;
7479 case VAR_STRING:
7480 if (varp->vval.v_string != NULL)
7481 vim_str2nr(varp->vval.v_string, NULL, NULL,
Bram Moolenaar16e9b852019-05-19 19:59:35 +02007482 STR2NR_ALL, &n, NULL, 0, FALSE);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007483 return n;
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00007484 case VAR_LIST:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007485 emsg(_("E745: Using a List as a Number"));
Bram Moolenaar31c67ef2005-01-11 21:34:41 +00007486 break;
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00007487 case VAR_DICT:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007488 emsg(_("E728: Using a Dictionary as a Number"));
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00007489 break;
Bram Moolenaar17a13432016-01-24 14:22:10 +01007490 case VAR_SPECIAL:
7491 return varp->vval.v_number == VVAL_TRUE ? 1 : 0;
7492 break;
Bram Moolenaar835dc632016-02-07 14:27:38 +01007493 case VAR_JOB:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007494#ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007495 emsg(_("E910: Using a Job as a Number"));
Bram Moolenaar835dc632016-02-07 14:27:38 +01007496 break;
7497#endif
Bram Moolenaar77073442016-02-13 23:23:53 +01007498 case VAR_CHANNEL:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007499#ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007500 emsg(_("E913: Using a Channel as a Number"));
Bram Moolenaar77073442016-02-13 23:23:53 +01007501 break;
7502#endif
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007503 case VAR_BLOB:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007504 emsg(_("E974: Using a Blob as a Number"));
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007505 break;
Bram Moolenaara03f2332016-02-06 18:09:59 +01007506 case VAR_UNKNOWN:
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007507 internal_error("tv_get_number(UNKNOWN)");
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007508 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007509 }
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007510 if (denote == NULL) /* useful for values that must be unsigned */
7511 n = -1;
7512 else
7513 *denote = TRUE;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007514 return n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515}
7516
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007517#ifdef FEAT_FLOAT
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02007518 float_T
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007519tv_get_float(typval_T *varp)
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007520{
7521 switch (varp->v_type)
7522 {
7523 case VAR_NUMBER:
7524 return (float_T)(varp->vval.v_number);
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007525 case VAR_FLOAT:
7526 return varp->vval.v_float;
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007527 case VAR_FUNC:
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007528 case VAR_PARTIAL:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007529 emsg(_("E891: Using a Funcref as a Float"));
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007530 break;
7531 case VAR_STRING:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007532 emsg(_("E892: Using a String as a Float"));
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007533 break;
7534 case VAR_LIST:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007535 emsg(_("E893: Using a List as a Float"));
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007536 break;
7537 case VAR_DICT:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007538 emsg(_("E894: Using a Dictionary as a Float"));
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007539 break;
Bram Moolenaara03f2332016-02-06 18:09:59 +01007540 case VAR_SPECIAL:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007541 emsg(_("E907: Using a special value as a Float"));
Bram Moolenaara03f2332016-02-06 18:09:59 +01007542 break;
Bram Moolenaar835dc632016-02-07 14:27:38 +01007543 case VAR_JOB:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007544# ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007545 emsg(_("E911: Using a Job as a Float"));
Bram Moolenaar835dc632016-02-07 14:27:38 +01007546 break;
7547# endif
Bram Moolenaar77073442016-02-13 23:23:53 +01007548 case VAR_CHANNEL:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007549# ifdef FEAT_JOB_CHANNEL
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007550 emsg(_("E914: Using a Channel as a Float"));
Bram Moolenaar77073442016-02-13 23:23:53 +01007551 break;
7552# endif
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007553 case VAR_BLOB:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007554 emsg(_("E975: Using a Blob as a Float"));
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007555 break;
Bram Moolenaara03f2332016-02-06 18:09:59 +01007556 case VAR_UNKNOWN:
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007557 internal_error("tv_get_float(UNKNOWN)");
Bram Moolenaarf7edf402016-01-19 23:36:15 +01007558 break;
7559 }
7560 return 0;
7561}
7562#endif
7563
Bram Moolenaar071d4272004-06-13 20:20:40 +00007564/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007565 * Get the string value of a variable.
7566 * If it is a Number variable, the number is converted into a string.
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007567 * tv_get_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
7568 * tv_get_string_buf() uses a given buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007569 * If the String variable has never been set, return an empty string.
7570 * Never returns NULL;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007571 * tv_get_string_chk() and tv_get_string_buf_chk() are similar, but return
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007572 * NULL on error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 */
Bram Moolenaar8e2c9422016-03-12 13:43:33 +01007574 char_u *
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007575tv_get_string(typval_T *varp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007576{
7577 static char_u mybuf[NUMBUFLEN];
7578
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007579 return tv_get_string_buf(varp, mybuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580}
7581
Bram Moolenaar8e2c9422016-03-12 13:43:33 +01007582 char_u *
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007583tv_get_string_buf(typval_T *varp, char_u *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584{
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007585 char_u *res = tv_get_string_buf_chk(varp, buf);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007586
7587 return res != NULL ? res : (char_u *)"";
7588}
7589
Bram Moolenaar7d647822014-04-05 21:28:56 +02007590/*
7591 * Careful: This uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
7592 */
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007593 char_u *
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007594tv_get_string_chk(typval_T *varp)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007595{
7596 static char_u mybuf[NUMBUFLEN];
7597
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007598 return tv_get_string_buf_chk(varp, mybuf);
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007599}
7600
Bram Moolenaar520e1e42016-01-23 19:46:28 +01007601 char_u *
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007602tv_get_string_buf_chk(typval_T *varp, char_u *buf)
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007603{
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007604 switch (varp->v_type)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007605 {
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007606 case VAR_NUMBER:
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02007607 vim_snprintf((char *)buf, NUMBUFLEN, "%lld",
Bram Moolenaar88c86eb2019-01-17 17:13:30 +01007608 (long_long_T)varp->vval.v_number);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007609 return buf;
7610 case VAR_FUNC:
Bram Moolenaar1735bc92016-03-14 23:05:14 +01007611 case VAR_PARTIAL:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007612 emsg(_("E729: using Funcref as a String"));
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007613 break;
7614 case VAR_LIST:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007615 emsg(_("E730: using List as a String"));
Bram Moolenaar8c711452005-01-14 21:53:12 +00007616 break;
7617 case VAR_DICT:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007618 emsg(_("E731: using Dictionary as a String"));
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007619 break;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00007620 case VAR_FLOAT:
Bram Moolenaar835dc632016-02-07 14:27:38 +01007621#ifdef FEAT_FLOAT
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007622 emsg(_(e_float_as_string));
Bram Moolenaar8c8de832008-06-24 22:58:06 +00007623 break;
7624#endif
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007625 case VAR_STRING:
7626 if (varp->vval.v_string != NULL)
7627 return varp->vval.v_string;
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007628 return (char_u *)"";
Bram Moolenaar17a13432016-01-24 14:22:10 +01007629 case VAR_SPECIAL:
7630 STRCPY(buf, get_var_special_name(varp->vval.v_number));
7631 return buf;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007632 case VAR_BLOB:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007633 emsg(_("E976: using Blob as a String"));
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007634 break;
Bram Moolenaar835dc632016-02-07 14:27:38 +01007635 case VAR_JOB:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007636#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar835dc632016-02-07 14:27:38 +01007637 {
7638 job_T *job = varp->vval.v_job;
Bram Moolenaar839fd112016-03-06 21:34:03 +01007639 char *status;
7640
7641 if (job == NULL)
7642 return (char_u *)"no process";
7643 status = job->jv_status == JOB_FAILED ? "fail"
Bram Moolenaar7df915d2016-11-17 17:25:32 +01007644 : job->jv_status >= JOB_ENDED ? "dead"
Bram Moolenaar835dc632016-02-07 14:27:38 +01007645 : "run";
7646# ifdef UNIX
7647 vim_snprintf((char *)buf, NUMBUFLEN,
7648 "process %ld %s", (long)job->jv_pid, status);
Bram Moolenaar4f974752019-02-17 17:44:42 +01007649# elif defined(MSWIN)
Bram Moolenaar4d8747c2016-02-09 20:39:26 +01007650 vim_snprintf((char *)buf, NUMBUFLEN,
Bram Moolenaar76467df2016-02-12 19:30:26 +01007651 "process %ld %s",
7652 (long)job->jv_proc_info.dwProcessId,
Bram Moolenaar4d8747c2016-02-09 20:39:26 +01007653 status);
Bram Moolenaar835dc632016-02-07 14:27:38 +01007654# else
Bram Moolenaar4d8747c2016-02-09 20:39:26 +01007655 /* fall-back */
Bram Moolenaar835dc632016-02-07 14:27:38 +01007656 vim_snprintf((char *)buf, NUMBUFLEN, "process ? %s", status);
7657# endif
7658 return buf;
7659 }
7660#endif
7661 break;
Bram Moolenaar77073442016-02-13 23:23:53 +01007662 case VAR_CHANNEL:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01007663#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar77073442016-02-13 23:23:53 +01007664 {
7665 channel_T *channel = varp->vval.v_channel;
Bram Moolenaar0e77b762016-09-26 22:58:58 +02007666 char *status = channel_status(channel, -1);
Bram Moolenaar77073442016-02-13 23:23:53 +01007667
Bram Moolenaar5cefd402016-02-16 12:44:26 +01007668 if (channel == NULL)
7669 vim_snprintf((char *)buf, NUMBUFLEN, "channel %s", status);
7670 else
7671 vim_snprintf((char *)buf, NUMBUFLEN,
Bram Moolenaar77073442016-02-13 23:23:53 +01007672 "channel %d %s", channel->ch_id, status);
7673 return buf;
7674 }
7675#endif
7676 break;
Bram Moolenaara03f2332016-02-06 18:09:59 +01007677 case VAR_UNKNOWN:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01007678 emsg(_("E908: using an invalid value as a String"));
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007679 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007680 }
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007681 return NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682}
7683
7684/*
Bram Moolenaar461a7fc2018-12-22 13:28:07 +01007685 * Turn a typeval into a string. Similar to tv_get_string_buf() but uses
7686 * string() on Dict, List, etc.
7687 */
7688 char_u *
7689tv_stringify(typval_T *varp, char_u *buf)
7690{
7691 if (varp->v_type == VAR_LIST
7692 || varp->v_type == VAR_DICT
7693 || varp->v_type == VAR_FUNC
7694 || varp->v_type == VAR_PARTIAL
7695 || varp->v_type == VAR_FLOAT)
7696 {
7697 typval_T tmp;
7698
7699 f_string(varp, &tmp);
7700 tv_get_string_buf(&tmp, buf);
7701 clear_tv(varp);
7702 *varp = tmp;
7703 return tmp.vval.v_string;
7704 }
7705 return tv_get_string_buf(varp, buf);
7706}
7707
7708/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007709 * Find variable "name" in the list of variables.
7710 * Return a pointer to it if found, NULL if not found.
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007711 * Careful: "a:0" variables don't have a name.
Bram Moolenaara7043832005-01-21 11:56:39 +00007712 * When "htp" is not NULL we are writing to the variable, set "htp" to the
Bram Moolenaar33570922005-01-25 22:26:29 +00007713 * hashtab_T used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007714 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007715 dictitem_T *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007716find_var(char_u *name, hashtab_T **htp, int no_autoload)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007717{
Bram Moolenaar071d4272004-06-13 20:20:40 +00007718 char_u *varname;
Bram Moolenaar33570922005-01-25 22:26:29 +00007719 hashtab_T *ht;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02007720 dictitem_T *ret = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007721
Bram Moolenaara7043832005-01-21 11:56:39 +00007722 ht = find_var_ht(name, &varname);
7723 if (htp != NULL)
7724 *htp = ht;
7725 if (ht == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007726 return NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02007727 ret = find_var_in_ht(ht, *name, varname, no_autoload || htp != NULL);
7728 if (ret != NULL)
7729 return ret;
7730
7731 /* Search in parent scope for lambda */
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02007732 return find_var_in_scoped_ht(name, no_autoload || htp != NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733}
7734
7735/*
Bram Moolenaar332ac062013-04-15 13:06:21 +02007736 * Find variable "varname" in hashtab "ht" with name "htname".
Bram Moolenaara7043832005-01-21 11:56:39 +00007737 * Returns NULL if not found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007738 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02007739 dictitem_T *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007740find_var_in_ht(
7741 hashtab_T *ht,
7742 int htname,
7743 char_u *varname,
7744 int no_autoload)
Bram Moolenaara7043832005-01-21 11:56:39 +00007745{
Bram Moolenaar33570922005-01-25 22:26:29 +00007746 hashitem_T *hi;
7747
7748 if (*varname == NUL)
7749 {
7750 /* Must be something like "s:", otherwise "ht" would be NULL. */
Bram Moolenaar332ac062013-04-15 13:06:21 +02007751 switch (htname)
Bram Moolenaar33570922005-01-25 22:26:29 +00007752 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02007753 case 's': return &SCRIPT_SV(current_sctx.sc_sid)->sv_var;
Bram Moolenaar33570922005-01-25 22:26:29 +00007754 case 'g': return &globvars_var;
7755 case 'v': return &vimvars_var;
7756 case 'b': return &curbuf->b_bufvar;
7757 case 'w': return &curwin->w_winvar;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007758 case 't': return &curtab->tp_winvar;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007759 case 'l': return get_funccal_local_var();
7760 case 'a': return get_funccal_args_var();
Bram Moolenaar33570922005-01-25 22:26:29 +00007761 }
7762 return NULL;
7763 }
Bram Moolenaara7043832005-01-21 11:56:39 +00007764
7765 hi = hash_find(ht, varname);
7766 if (HASHITEM_EMPTY(hi))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00007767 {
7768 /* For global variables we may try auto-loading the script. If it
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00007769 * worked find the variable again. Don't auto-load a script if it was
7770 * loaded already, otherwise it would be loaded every time when
7771 * checking if a function name is a Funcref variable. */
Bram Moolenaar6d977d62014-01-14 15:24:39 +01007772 if (ht == &globvarht && !no_autoload)
Bram Moolenaar8000baf2011-11-30 15:19:28 +01007773 {
7774 /* Note: script_autoload() may make "hi" invalid. It must either
7775 * be obtained again or not used. */
7776 if (!script_autoload(varname, FALSE) || aborting())
7777 return NULL;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00007778 hi = hash_find(ht, varname);
Bram Moolenaar8000baf2011-11-30 15:19:28 +01007779 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00007780 if (HASHITEM_EMPTY(hi))
7781 return NULL;
7782 }
Bram Moolenaar33570922005-01-25 22:26:29 +00007783 return HI2DI(hi);
Bram Moolenaara7043832005-01-21 11:56:39 +00007784}
7785
7786/*
Bram Moolenaar33570922005-01-25 22:26:29 +00007787 * Find the hashtab used for a variable name.
Bram Moolenaar73627d02015-08-11 15:46:09 +02007788 * Return NULL if the name is not valid.
Bram Moolenaara7043832005-01-21 11:56:39 +00007789 * Set "varname" to the start of name without ':'.
7790 */
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02007791 hashtab_T *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007792find_var_ht(char_u *name, char_u **varname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007793{
Bram Moolenaar75c50c42005-06-04 22:06:24 +00007794 hashitem_T *hi;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007795 hashtab_T *ht;
Bram Moolenaar75c50c42005-06-04 22:06:24 +00007796
Bram Moolenaar73627d02015-08-11 15:46:09 +02007797 if (name[0] == NUL)
7798 return NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799 if (name[1] != ':')
7800 {
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00007801 /* The name must not start with a colon or #. */
7802 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007803 return NULL;
7804 *varname = name;
Bram Moolenaar532c7802005-01-27 14:44:31 +00007805
Bram Moolenaard2e716e2019-04-20 14:39:52 +02007806 // "version" is "v:version" in all scopes if scriptversion < 3.
7807 // Same for a few other variables marked with VV_COMPAT.
7808 if (current_sctx.sc_version < 3)
7809 {
7810 hi = hash_find(&compat_hashtab, name);
7811 if (!HASHITEM_EMPTY(hi))
7812 return &compat_hashtab;
7813 }
Bram Moolenaar532c7802005-01-27 14:44:31 +00007814
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007815 ht = get_funccal_local_ht();
7816 if (ht == NULL)
Bram Moolenaar33570922005-01-25 22:26:29 +00007817 return &globvarht; /* global variable */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007818 return ht; /* local variable */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819 }
7820 *varname = name + 2;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00007821 if (*name == 'g') /* global variable */
7822 return &globvarht;
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00007823 /* There must be no ':' or '#' in the rest of the name, unless g: is used
7824 */
7825 if (vim_strchr(name + 2, ':') != NULL
7826 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00007827 return NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007828 if (*name == 'b') /* buffer variable */
Bram Moolenaar429fa852013-04-15 12:27:36 +02007829 return &curbuf->b_vars->dv_hashtab;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007830 if (*name == 'w') /* window variable */
Bram Moolenaar429fa852013-04-15 12:27:36 +02007831 return &curwin->w_vars->dv_hashtab;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007832 if (*name == 't') /* tab page variable */
Bram Moolenaar429fa852013-04-15 12:27:36 +02007833 return &curtab->tp_vars->dv_hashtab;
Bram Moolenaar33570922005-01-25 22:26:29 +00007834 if (*name == 'v') /* v: variable */
7835 return &vimvarht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007836 if (*name == 'a') /* a: function argument */
7837 return get_funccal_args_ht();
7838 if (*name == 'l') /* l: local function variable */
7839 return get_funccal_local_ht();
Bram Moolenaar071d4272004-06-13 20:20:40 +00007840 if (*name == 's' /* script variable */
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02007841 && current_sctx.sc_sid > 0 && current_sctx.sc_sid <= ga_scripts.ga_len)
7842 return &SCRIPT_VARS(current_sctx.sc_sid);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007843 return NULL;
7844}
7845
7846/*
7847 * Get the string value of a (global/local) variable.
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007848 * Note: see tv_get_string() for how long the pointer remains valid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007849 * Returns NULL when it doesn't exist.
7850 */
7851 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01007852get_var_value(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007853{
Bram Moolenaar33570922005-01-25 22:26:29 +00007854 dictitem_T *v;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855
Bram Moolenaar6d977d62014-01-14 15:24:39 +01007856 v = find_var(name, NULL, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007857 if (v == NULL)
7858 return NULL;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01007859 return tv_get_string(&v->di_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007860}
7861
7862/*
Bram Moolenaar33570922005-01-25 22:26:29 +00007863 * Allocate a new hashtab for a sourced script. It will be used while
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 * sourcing this script and when executing functions defined in the script.
7865 */
7866 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007867new_script_vars(scid_T id)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007868{
Bram Moolenaara7043832005-01-21 11:56:39 +00007869 int i;
Bram Moolenaar33570922005-01-25 22:26:29 +00007870 hashtab_T *ht;
7871 scriptvar_T *sv;
Bram Moolenaara7043832005-01-21 11:56:39 +00007872
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
7874 {
Bram Moolenaara7043832005-01-21 11:56:39 +00007875 /* Re-allocating ga_data means that an ht_array pointing to
7876 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
Bram Moolenaar33570922005-01-25 22:26:29 +00007877 * at its init value. Also reset "v_dict", it's always the same. */
Bram Moolenaara7043832005-01-21 11:56:39 +00007878 for (i = 1; i <= ga_scripts.ga_len; ++i)
7879 {
7880 ht = &SCRIPT_VARS(i);
7881 if (ht->ht_mask == HT_INIT_SIZE - 1)
7882 ht->ht_array = ht->ht_smallarray;
Bram Moolenaar9577c3e2010-05-14 12:16:25 +02007883 sv = SCRIPT_SV(i);
Bram Moolenaar33570922005-01-25 22:26:29 +00007884 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
Bram Moolenaara7043832005-01-21 11:56:39 +00007885 }
7886
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 while (ga_scripts.ga_len < id)
7888 {
Bram Moolenaar2c704a72010-06-03 21:17:25 +02007889 sv = SCRIPT_SV(ga_scripts.ga_len + 1) =
Bram Moolenaar9577c3e2010-05-14 12:16:25 +02007890 (scriptvar_T *)alloc_clear(sizeof(scriptvar_T));
Bram Moolenaarbdb62052012-07-16 17:31:53 +02007891 init_var_dict(&sv->sv_dict, &sv->sv_var, VAR_SCOPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 ++ga_scripts.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007893 }
7894 }
7895}
7896
7897/*
Bram Moolenaar33570922005-01-25 22:26:29 +00007898 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
7899 * point to it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007900 */
7901 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007902init_var_dict(dict_T *dict, dictitem_T *dict_var, int scope)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903{
Bram Moolenaar33570922005-01-25 22:26:29 +00007904 hash_init(&dict->dv_hashtab);
Bram Moolenaared465602012-06-20 14:13:06 +02007905 dict->dv_lock = 0;
Bram Moolenaarbdb62052012-07-16 17:31:53 +02007906 dict->dv_scope = scope;
Bram Moolenaar8ba1bd22008-12-23 22:52:58 +00007907 dict->dv_refcount = DO_NOT_FREE_CNT;
Bram Moolenaarc0a6fac2009-05-24 11:40:58 +00007908 dict->dv_copyID = 0;
Bram Moolenaar33570922005-01-25 22:26:29 +00007909 dict_var->di_tv.vval.v_dict = dict;
7910 dict_var->di_tv.v_type = VAR_DICT;
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00007911 dict_var->di_tv.v_lock = VAR_FIXED;
Bram Moolenaar33570922005-01-25 22:26:29 +00007912 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
7913 dict_var->di_key[0] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914}
7915
7916/*
Bram Moolenaar429fa852013-04-15 12:27:36 +02007917 * Unreference a dictionary initialized by init_var_dict().
7918 */
7919 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007920unref_var_dict(dict_T *dict)
Bram Moolenaar429fa852013-04-15 12:27:36 +02007921{
7922 /* Now the dict needs to be freed if no one else is using it, go back to
7923 * normal reference counting. */
7924 dict->dv_refcount -= DO_NOT_FREE_CNT - 1;
7925 dict_unref(dict);
7926}
7927
7928/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007929 * Clean up a list of internal variables.
Bram Moolenaar33570922005-01-25 22:26:29 +00007930 * Frees all allocated variables and the value they contain.
7931 * Clears hashtab "ht", does not free it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007932 */
7933 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007934vars_clear(hashtab_T *ht)
Bram Moolenaar33570922005-01-25 22:26:29 +00007935{
7936 vars_clear_ext(ht, TRUE);
7937}
7938
7939/*
7940 * Like vars_clear(), but only free the value if "free_val" is TRUE.
7941 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02007942 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007943vars_clear_ext(hashtab_T *ht, int free_val)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007944{
Bram Moolenaara7043832005-01-21 11:56:39 +00007945 int todo;
Bram Moolenaar33570922005-01-25 22:26:29 +00007946 hashitem_T *hi;
7947 dictitem_T *v;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007948
Bram Moolenaar33570922005-01-25 22:26:29 +00007949 hash_lock(ht);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007950 todo = (int)ht->ht_used;
Bram Moolenaara7043832005-01-21 11:56:39 +00007951 for (hi = ht->ht_array; todo > 0; ++hi)
7952 {
7953 if (!HASHITEM_EMPTY(hi))
7954 {
7955 --todo;
7956
Bram Moolenaar33570922005-01-25 22:26:29 +00007957 /* Free the variable. Don't remove it from the hashtab,
Bram Moolenaara7043832005-01-21 11:56:39 +00007958 * ht_array might change then. hash_clear() takes care of it
7959 * later. */
Bram Moolenaar33570922005-01-25 22:26:29 +00007960 v = HI2DI(hi);
7961 if (free_val)
7962 clear_tv(&v->di_tv);
Bram Moolenaar9bc174b2015-04-13 16:16:38 +02007963 if (v->di_flags & DI_FLAGS_ALLOC)
Bram Moolenaar33570922005-01-25 22:26:29 +00007964 vim_free(v);
Bram Moolenaara7043832005-01-21 11:56:39 +00007965 }
7966 }
7967 hash_clear(ht);
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00007968 ht->ht_used = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007969}
7970
Bram Moolenaara7043832005-01-21 11:56:39 +00007971/*
Bram Moolenaar33570922005-01-25 22:26:29 +00007972 * Delete a variable from hashtab "ht" at item "hi".
7973 * Clear the variable value and free the dictitem.
Bram Moolenaara7043832005-01-21 11:56:39 +00007974 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975 static void
Bram Moolenaar7454a062016-01-30 15:14:10 +01007976delete_var(hashtab_T *ht, hashitem_T *hi)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007977{
Bram Moolenaar33570922005-01-25 22:26:29 +00007978 dictitem_T *di = HI2DI(hi);
Bram Moolenaara7043832005-01-21 11:56:39 +00007979
7980 hash_remove(ht, hi);
Bram Moolenaar33570922005-01-25 22:26:29 +00007981 clear_tv(&di->di_tv);
7982 vim_free(di);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007983}
7984
7985/*
7986 * List the value of one internal variable.
7987 */
7988 static void
Bram Moolenaar32526b32019-01-19 17:43:09 +01007989list_one_var(dictitem_T *v, char *prefix, int *first)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990{
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007991 char_u *tofree;
7992 char_u *s;
Bram Moolenaar8a283e52005-01-06 23:28:25 +00007993 char_u numbuf[NUMBUFLEN];
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007994
Bram Moolenaar520e1e42016-01-23 19:46:28 +01007995 s = echo_string(&v->di_tv, &tofree, numbuf, get_copyID());
Bram Moolenaar33570922005-01-25 22:26:29 +00007996 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
Bram Moolenaar7d61a922007-08-30 09:12:23 +00007997 s == NULL ? (char_u *)"" : s, first);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00007998 vim_free(tofree);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007999}
8000
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001 static void
Bram Moolenaar7454a062016-01-30 15:14:10 +01008002list_one_var_a(
Bram Moolenaar32526b32019-01-19 17:43:09 +01008003 char *prefix,
Bram Moolenaar7454a062016-01-30 15:14:10 +01008004 char_u *name,
8005 int type,
8006 char_u *string,
8007 int *first) /* when TRUE clear rest of screen and set to FALSE */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008{
Bram Moolenaar31859182007-08-14 20:41:13 +00008009 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
8010 msg_start();
8011 msg_puts(prefix);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008012 if (name != NULL) /* "a:" vars don't have a name stored */
Bram Moolenaar32526b32019-01-19 17:43:09 +01008013 msg_puts((char *)name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008014 msg_putchar(' ');
8015 msg_advance(22);
8016 if (type == VAR_NUMBER)
8017 msg_putchar('#');
Bram Moolenaar1735bc92016-03-14 23:05:14 +01008018 else if (type == VAR_FUNC || type == VAR_PARTIAL)
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008019 msg_putchar('*');
8020 else if (type == VAR_LIST)
8021 {
8022 msg_putchar('[');
8023 if (*string == '[')
8024 ++string;
8025 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00008026 else if (type == VAR_DICT)
8027 {
8028 msg_putchar('{');
8029 if (*string == '{')
8030 ++string;
8031 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032 else
8033 msg_putchar(' ');
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008034
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 msg_outtrans(string);
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008036
Bram Moolenaar1735bc92016-03-14 23:05:14 +01008037 if (type == VAR_FUNC || type == VAR_PARTIAL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008038 msg_puts("()");
Bram Moolenaar7d61a922007-08-30 09:12:23 +00008039 if (*first)
8040 {
8041 msg_clr_eos();
8042 *first = FALSE;
8043 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044}
8045
8046/*
Bram Moolenaarc70646c2005-01-04 21:52:38 +00008047 * Set variable "name" to value in "tv".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 * If the variable already exists, the value is updated.
8049 * Otherwise the variable is created.
8050 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008051 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01008052set_var(
8053 char_u *name,
8054 typval_T *tv,
8055 int copy) /* make copy of value in "tv" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008056{
Bram Moolenaar33570922005-01-25 22:26:29 +00008057 dictitem_T *v;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008058 char_u *varname;
Bram Moolenaar33570922005-01-25 22:26:29 +00008059 hashtab_T *ht;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060
Bram Moolenaarbaff0fe2010-03-17 19:53:49 +01008061 ht = find_var_ht(name, &varname);
8062 if (ht == NULL || *varname == NUL)
8063 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008064 semsg(_(e_illvar), name);
Bram Moolenaarbaff0fe2010-03-17 19:53:49 +01008065 return;
8066 }
Bram Moolenaar332ac062013-04-15 13:06:21 +02008067 v = find_var_in_ht(ht, 0, varname, TRUE);
Bram Moolenaarbaff0fe2010-03-17 19:53:49 +01008068
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02008069 /* Search in parent scope which is possible to reference from lambda */
8070 if (v == NULL)
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02008071 v = find_var_in_scoped_ht(name, TRUE);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02008072
Bram Moolenaar1735bc92016-03-14 23:05:14 +01008073 if ((tv->v_type == VAR_FUNC || tv->v_type == VAR_PARTIAL)
8074 && var_check_func_name(name, v == NULL))
Bram Moolenaar4228bec2011-03-27 16:03:15 +02008075 return;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008076
Bram Moolenaar33570922005-01-25 22:26:29 +00008077 if (v != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078 {
Bram Moolenaar33570922005-01-25 22:26:29 +00008079 /* existing variable, need to clear the value */
Bram Moolenaar77354e72015-04-21 16:49:05 +02008080 if (var_check_ro(v->di_flags, name, FALSE)
Bram Moolenaar05c00c02019-02-11 22:00:11 +01008081 || var_check_lock(v->di_tv.v_lock, name, FALSE))
Bram Moolenaar33570922005-01-25 22:26:29 +00008082 return;
Bram Moolenaar33570922005-01-25 22:26:29 +00008083
8084 /*
Bram Moolenaar1cd5e612015-05-04 11:10:27 +02008085 * Handle setting internal v: variables separately where needed to
8086 * prevent changing the type.
Bram Moolenaar33570922005-01-25 22:26:29 +00008087 */
8088 if (ht == &vimvarht)
8089 {
8090 if (v->di_tv.v_type == VAR_STRING)
8091 {
Bram Moolenaar4b9e91f2019-01-24 13:58:11 +01008092 VIM_CLEAR(v->di_tv.vval.v_string);
Bram Moolenaar33570922005-01-25 22:26:29 +00008093 if (copy || tv->v_type != VAR_STRING)
Bram Moolenaar4b9e91f2019-01-24 13:58:11 +01008094 {
8095 char_u *val = tv_get_string(tv);
8096
8097 // Careful: when assigning to v:errmsg and tv_get_string()
8098 // causes an error message the variable will alrady be set.
8099 if (v->di_tv.vval.v_string == NULL)
8100 v->di_tv.vval.v_string = vim_strsave(val);
8101 }
Bram Moolenaar33570922005-01-25 22:26:29 +00008102 else
8103 {
8104 /* Take over the string to avoid an extra alloc/free. */
8105 v->di_tv.vval.v_string = tv->vval.v_string;
8106 tv->vval.v_string = NULL;
8107 }
Bram Moolenaar1cd5e612015-05-04 11:10:27 +02008108 return;
Bram Moolenaar33570922005-01-25 22:26:29 +00008109 }
Bram Moolenaar1cd5e612015-05-04 11:10:27 +02008110 else if (v->di_tv.v_type == VAR_NUMBER)
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008111 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008112 v->di_tv.vval.v_number = tv_get_number(tv);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008113 if (STRCMP(varname, "searchforward") == 0)
8114 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
Bram Moolenaar8050efa2013-11-08 04:30:20 +01008115#ifdef FEAT_SEARCH_EXTRA
8116 else if (STRCMP(varname, "hlsearch") == 0)
8117 {
8118 no_hlsearch = !v->di_tv.vval.v_number;
8119 redraw_all_later(SOME_VALID);
8120 }
8121#endif
Bram Moolenaar1cd5e612015-05-04 11:10:27 +02008122 return;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008123 }
Bram Moolenaar1cd5e612015-05-04 11:10:27 +02008124 else if (v->di_tv.v_type != tv->v_type)
Bram Moolenaar88b53fd2018-12-05 18:43:28 +01008125 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008126 semsg(_("E963: setting %s to value with wrong type"), name);
Bram Moolenaar88b53fd2018-12-05 18:43:28 +01008127 return;
8128 }
Bram Moolenaar33570922005-01-25 22:26:29 +00008129 }
8130
8131 clear_tv(&v->di_tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008132 }
8133 else /* add a new variable */
8134 {
Bram Moolenaar31b81602019-02-10 22:14:27 +01008135 // Can't add "v:" or "a:" variable.
8136 if (ht == &vimvarht || ht == get_funccal_args_ht())
Bram Moolenaar5fcc3fe2006-06-22 15:35:14 +00008137 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008138 semsg(_(e_illvar), name);
Bram Moolenaar5fcc3fe2006-06-22 15:35:14 +00008139 return;
8140 }
8141
Bram Moolenaar31b81602019-02-10 22:14:27 +01008142 // Make sure the variable name is valid.
Bram Moolenaar4228bec2011-03-27 16:03:15 +02008143 if (!valid_varname(varname))
8144 return;
Bram Moolenaar92124a32005-06-17 22:03:40 +00008145
Bram Moolenaar964b3742019-05-24 18:54:09 +02008146 v = (dictitem_T *)alloc(sizeof(dictitem_T) + STRLEN(varname));
Bram Moolenaara7043832005-01-21 11:56:39 +00008147 if (v == NULL)
8148 return;
Bram Moolenaar33570922005-01-25 22:26:29 +00008149 STRCPY(v->di_key, varname);
Bram Moolenaar33570922005-01-25 22:26:29 +00008150 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008151 {
Bram Moolenaara7043832005-01-21 11:56:39 +00008152 vim_free(v);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008153 return;
8154 }
Bram Moolenaar9bc174b2015-04-13 16:16:38 +02008155 v->di_flags = DI_FLAGS_ALLOC;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156 }
Bram Moolenaara7043832005-01-21 11:56:39 +00008157
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008158 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
Bram Moolenaar33570922005-01-25 22:26:29 +00008159 copy_tv(tv, &v->di_tv);
Bram Moolenaar1c2fda22005-01-02 11:43:19 +00008160 else
8161 {
Bram Moolenaar33570922005-01-25 22:26:29 +00008162 v->di_tv = *tv;
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00008163 v->di_tv.v_lock = 0;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00008164 init_tv(tv);
Bram Moolenaar1c2fda22005-01-02 11:43:19 +00008165 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008166}
8167
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008168/*
Bram Moolenaar4e957af2006-09-02 11:41:07 +00008169 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
Bram Moolenaar33570922005-01-25 22:26:29 +00008170 * Also give an error message.
8171 */
Bram Moolenaarcd524592016-07-17 14:57:05 +02008172 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01008173var_check_ro(int flags, char_u *name, int use_gettext)
Bram Moolenaar33570922005-01-25 22:26:29 +00008174{
8175 if (flags & DI_FLAGS_RO)
8176 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008177 semsg(_(e_readonlyvar), use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar33570922005-01-25 22:26:29 +00008178 return TRUE;
8179 }
8180 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
8181 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008182 semsg(_(e_readonlysbx), use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar33570922005-01-25 22:26:29 +00008183 return TRUE;
8184 }
8185 return FALSE;
8186}
8187
8188/*
Bram Moolenaar4e957af2006-09-02 11:41:07 +00008189 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
8190 * Also give an error message.
8191 */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008192 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01008193var_check_fixed(int flags, char_u *name, int use_gettext)
Bram Moolenaar4e957af2006-09-02 11:41:07 +00008194{
8195 if (flags & DI_FLAGS_FIX)
8196 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008197 semsg(_("E795: Cannot delete variable %s"),
Bram Moolenaar77354e72015-04-21 16:49:05 +02008198 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar4e957af2006-09-02 11:41:07 +00008199 return TRUE;
8200 }
8201 return FALSE;
8202}
8203
8204/*
Bram Moolenaar4228bec2011-03-27 16:03:15 +02008205 * Check if a funcref is assigned to a valid variable name.
8206 * Return TRUE and give an error if not.
8207 */
Bram Moolenaarcd524592016-07-17 14:57:05 +02008208 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01008209var_check_func_name(
8210 char_u *name, /* points to start of variable name */
8211 int new_var) /* TRUE when creating the variable */
Bram Moolenaar4228bec2011-03-27 16:03:15 +02008212{
Bram Moolenaarcbc67722014-05-22 14:19:56 +02008213 /* Allow for w: b: s: and t:. */
8214 if (!(vim_strchr((char_u *)"wbst", name[0]) != NULL && name[1] == ':')
Bram Moolenaar4228bec2011-03-27 16:03:15 +02008215 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
8216 ? name[2] : name[0]))
8217 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008218 semsg(_("E704: Funcref variable name must start with a capital: %s"),
Bram Moolenaar4228bec2011-03-27 16:03:15 +02008219 name);
8220 return TRUE;
8221 }
8222 /* Don't allow hiding a function. When "v" is not NULL we might be
8223 * assigning another function to the same var, the type is checked
8224 * below. */
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02008225 if (new_var && function_exists(name, FALSE))
Bram Moolenaar4228bec2011-03-27 16:03:15 +02008226 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008227 semsg(_("E705: Variable name conflicts with existing function: %s"),
Bram Moolenaar4228bec2011-03-27 16:03:15 +02008228 name);
8229 return TRUE;
8230 }
8231 return FALSE;
8232}
8233
8234/*
Bram Moolenaar05c00c02019-02-11 22:00:11 +01008235 * Return TRUE if "flags" indicates variable "name" is locked (immutable).
Bram Moolenaar77354e72015-04-21 16:49:05 +02008236 * Also give an error message, using "name" or _("name") when use_gettext is
8237 * TRUE.
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00008238 */
Bram Moolenaarcd524592016-07-17 14:57:05 +02008239 int
Bram Moolenaar05c00c02019-02-11 22:00:11 +01008240var_check_lock(int lock, char_u *name, int use_gettext)
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00008241{
8242 if (lock & VAR_LOCKED)
8243 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008244 semsg(_("E741: Value is locked: %s"),
Bram Moolenaar77354e72015-04-21 16:49:05 +02008245 name == NULL ? (char_u *)_("Unknown")
8246 : use_gettext ? (char_u *)_(name)
8247 : name);
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00008248 return TRUE;
8249 }
8250 if (lock & VAR_FIXED)
8251 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008252 semsg(_("E742: Cannot change value of %s"),
Bram Moolenaar77354e72015-04-21 16:49:05 +02008253 name == NULL ? (char_u *)_("Unknown")
8254 : use_gettext ? (char_u *)_(name)
8255 : name);
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00008256 return TRUE;
8257 }
8258 return FALSE;
8259}
8260
8261/*
Bram Moolenaar05c00c02019-02-11 22:00:11 +01008262 * Return TRUE if typeval "tv" and its value are set to be locked (immutable).
8263 * Also give an error message, using "name" or _("name") when use_gettext is
8264 * TRUE.
8265 */
8266 static int
8267tv_check_lock(typval_T *tv, char_u *name, int use_gettext)
8268{
8269 int lock = 0;
8270
8271 switch (tv->v_type)
8272 {
8273 case VAR_BLOB:
8274 if (tv->vval.v_blob != NULL)
8275 lock = tv->vval.v_blob->bv_lock;
8276 break;
8277 case VAR_LIST:
8278 if (tv->vval.v_list != NULL)
8279 lock = tv->vval.v_list->lv_lock;
8280 break;
8281 case VAR_DICT:
8282 if (tv->vval.v_dict != NULL)
8283 lock = tv->vval.v_dict->dv_lock;
8284 break;
8285 default:
8286 break;
8287 }
8288 return var_check_lock(tv->v_lock, name, use_gettext)
8289 || (lock != 0 && var_check_lock(lock, name, use_gettext));
8290}
8291
8292/*
8293 * Check if a variable name is valid.
8294 * Return FALSE and give an error if not.
8295 */
8296 int
8297valid_varname(char_u *varname)
8298{
8299 char_u *p;
8300
8301 for (p = varname; *p != NUL; ++p)
8302 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
8303 && *p != AUTOLOAD_CHAR)
8304 {
8305 semsg(_(e_illvar), varname);
8306 return FALSE;
8307 }
8308 return TRUE;
8309}
8310
8311/*
Bram Moolenaar33570922005-01-25 22:26:29 +00008312 * Copy the values from typval_T "from" to typval_T "to".
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008313 * When needed allocates string or increases reference count.
Bram Moolenaardd29ea12019-01-23 21:56:21 +01008314 * Does not make a copy of a list, blob or dict but copies the reference!
Bram Moolenaar8ba1bd22008-12-23 22:52:58 +00008315 * It is OK for "from" and "to" to point to the same item. This is used to
8316 * make a copy later.
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008317 */
Bram Moolenaar7e506b62010-01-19 15:55:06 +01008318 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01008319copy_tv(typval_T *from, typval_T *to)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008320{
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008321 to->v_type = from->v_type;
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00008322 to->v_lock = 0;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008323 switch (from->v_type)
8324 {
8325 case VAR_NUMBER:
Bram Moolenaar520e1e42016-01-23 19:46:28 +01008326 case VAR_SPECIAL:
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008327 to->vval.v_number = from->vval.v_number;
8328 break;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008329 case VAR_FLOAT:
Bram Moolenaar835dc632016-02-07 14:27:38 +01008330#ifdef FEAT_FLOAT
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008331 to->vval.v_float = from->vval.v_float;
8332 break;
8333#endif
Bram Moolenaar835dc632016-02-07 14:27:38 +01008334 case VAR_JOB:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01008335#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar835dc632016-02-07 14:27:38 +01008336 to->vval.v_job = from->vval.v_job;
Bram Moolenaaree1cffc2016-02-21 19:14:41 +01008337 if (to->vval.v_job != NULL)
8338 ++to->vval.v_job->jv_refcount;
Bram Moolenaar835dc632016-02-07 14:27:38 +01008339 break;
8340#endif
Bram Moolenaar77073442016-02-13 23:23:53 +01008341 case VAR_CHANNEL:
Bram Moolenaar509ce2a2016-03-11 22:52:15 +01008342#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar77073442016-02-13 23:23:53 +01008343 to->vval.v_channel = from->vval.v_channel;
Bram Moolenaar5cefd402016-02-16 12:44:26 +01008344 if (to->vval.v_channel != NULL)
8345 ++to->vval.v_channel->ch_refcount;
Bram Moolenaar77073442016-02-13 23:23:53 +01008346 break;
8347#endif
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008348 case VAR_STRING:
8349 case VAR_FUNC:
8350 if (from->vval.v_string == NULL)
8351 to->vval.v_string = NULL;
8352 else
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00008353 {
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008354 to->vval.v_string = vim_strsave(from->vval.v_string);
Bram Moolenaar9ef486d2005-01-17 22:23:00 +00008355 if (from->v_type == VAR_FUNC)
8356 func_ref(to->vval.v_string);
8357 }
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008358 break;
Bram Moolenaar1735bc92016-03-14 23:05:14 +01008359 case VAR_PARTIAL:
8360 if (from->vval.v_partial == NULL)
8361 to->vval.v_partial = NULL;
8362 else
8363 {
8364 to->vval.v_partial = from->vval.v_partial;
8365 ++to->vval.v_partial->pt_refcount;
8366 }
8367 break;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01008368 case VAR_BLOB:
8369 if (from->vval.v_blob == NULL)
8370 to->vval.v_blob = NULL;
8371 else
8372 {
8373 to->vval.v_blob = from->vval.v_blob;
8374 ++to->vval.v_blob->bv_refcount;
8375 }
8376 break;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008377 case VAR_LIST:
8378 if (from->vval.v_list == NULL)
8379 to->vval.v_list = NULL;
8380 else
8381 {
8382 to->vval.v_list = from->vval.v_list;
8383 ++to->vval.v_list->lv_refcount;
8384 }
8385 break;
Bram Moolenaar8c711452005-01-14 21:53:12 +00008386 case VAR_DICT:
8387 if (from->vval.v_dict == NULL)
8388 to->vval.v_dict = NULL;
8389 else
8390 {
8391 to->vval.v_dict = from->vval.v_dict;
8392 ++to->vval.v_dict->dv_refcount;
8393 }
8394 break;
Bram Moolenaara03f2332016-02-06 18:09:59 +01008395 case VAR_UNKNOWN:
Bram Moolenaar95f09602016-11-10 20:01:45 +01008396 internal_error("copy_tv(UNKNOWN)");
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008397 break;
8398 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008399}
8400
8401/*
Bram Moolenaare9a41262005-01-15 22:18:47 +00008402 * Make a copy of an item.
8403 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008404 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
8405 * reference to an already copied list/dict can be used.
8406 * Returns FAIL or OK.
Bram Moolenaare9a41262005-01-15 22:18:47 +00008407 */
Bram Moolenaarcd524592016-07-17 14:57:05 +02008408 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01008409item_copy(
8410 typval_T *from,
8411 typval_T *to,
8412 int deep,
8413 int copyID)
Bram Moolenaare9a41262005-01-15 22:18:47 +00008414{
8415 static int recurse = 0;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008416 int ret = OK;
Bram Moolenaare9a41262005-01-15 22:18:47 +00008417
Bram Moolenaar33570922005-01-25 22:26:29 +00008418 if (recurse >= DICT_MAXNEST)
Bram Moolenaare9a41262005-01-15 22:18:47 +00008419 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008420 emsg(_("E698: variable nested too deep for making a copy"));
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008421 return FAIL;
Bram Moolenaare9a41262005-01-15 22:18:47 +00008422 }
8423 ++recurse;
8424
8425 switch (from->v_type)
8426 {
8427 case VAR_NUMBER:
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008428 case VAR_FLOAT:
Bram Moolenaare9a41262005-01-15 22:18:47 +00008429 case VAR_STRING:
8430 case VAR_FUNC:
Bram Moolenaar1735bc92016-03-14 23:05:14 +01008431 case VAR_PARTIAL:
Bram Moolenaar15550002016-01-31 18:45:24 +01008432 case VAR_SPECIAL:
Bram Moolenaar835dc632016-02-07 14:27:38 +01008433 case VAR_JOB:
Bram Moolenaar77073442016-02-13 23:23:53 +01008434 case VAR_CHANNEL:
Bram Moolenaare9a41262005-01-15 22:18:47 +00008435 copy_tv(from, to);
8436 break;
8437 case VAR_LIST:
8438 to->v_type = VAR_LIST;
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00008439 to->v_lock = 0;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008440 if (from->vval.v_list == NULL)
8441 to->vval.v_list = NULL;
8442 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
8443 {
8444 /* use the copy made earlier */
8445 to->vval.v_list = from->vval.v_list->lv_copylist;
8446 ++to->vval.v_list->lv_refcount;
8447 }
8448 else
8449 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
8450 if (to->vval.v_list == NULL)
8451 ret = FAIL;
Bram Moolenaare9a41262005-01-15 22:18:47 +00008452 break;
Bram Moolenaar3d28b582019-01-15 22:44:17 +01008453 case VAR_BLOB:
Bram Moolenaardd29ea12019-01-23 21:56:21 +01008454 ret = blob_copy(from, to);
Bram Moolenaar3d28b582019-01-15 22:44:17 +01008455 break;
Bram Moolenaare9a41262005-01-15 22:18:47 +00008456 case VAR_DICT:
8457 to->v_type = VAR_DICT;
Bram Moolenaar2e6aff32005-01-31 19:25:36 +00008458 to->v_lock = 0;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008459 if (from->vval.v_dict == NULL)
8460 to->vval.v_dict = NULL;
8461 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
8462 {
8463 /* use the copy made earlier */
8464 to->vval.v_dict = from->vval.v_dict->dv_copydict;
8465 ++to->vval.v_dict->dv_refcount;
8466 }
8467 else
8468 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
8469 if (to->vval.v_dict == NULL)
8470 ret = FAIL;
Bram Moolenaare9a41262005-01-15 22:18:47 +00008471 break;
Bram Moolenaara03f2332016-02-06 18:09:59 +01008472 case VAR_UNKNOWN:
Bram Moolenaar95f09602016-11-10 20:01:45 +01008473 internal_error("item_copy(UNKNOWN)");
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008474 ret = FAIL;
Bram Moolenaare9a41262005-01-15 22:18:47 +00008475 }
8476 --recurse;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008477 return ret;
Bram Moolenaare9a41262005-01-15 22:18:47 +00008478}
8479
8480/*
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008481 * This function is used by f_input() and f_inputdialog() functions. The third
8482 * argument to f_input() specifies the type of completion to use at the
8483 * prompt. The third argument to f_inputdialog() specifies the value to return
8484 * when the user cancels the prompt.
8485 */
8486 void
8487get_user_input(
8488 typval_T *argvars,
8489 typval_T *rettv,
8490 int inputdialog,
8491 int secret)
8492{
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008493 char_u *prompt = tv_get_string_chk(&argvars[0]);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008494 char_u *p = NULL;
8495 int c;
8496 char_u buf[NUMBUFLEN];
8497 int cmd_silent_save = cmd_silent;
8498 char_u *defstr = (char_u *)"";
8499 int xp_type = EXPAND_NOTHING;
8500 char_u *xp_arg = NULL;
8501
8502 rettv->v_type = VAR_STRING;
8503 rettv->vval.v_string = NULL;
8504
8505#ifdef NO_CONSOLE_INPUT
Bram Moolenaar91d348a2017-07-29 20:16:03 +02008506 /* While starting up, there is no place to enter text. When running tests
8507 * with --not-a-term we assume feedkeys() will be used. */
8508 if (no_console_input() && !is_not_a_term())
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008509 return;
8510#endif
8511
8512 cmd_silent = FALSE; /* Want to see the prompt. */
8513 if (prompt != NULL)
8514 {
8515 /* Only the part of the message after the last NL is considered as
8516 * prompt for the command line */
8517 p = vim_strrchr(prompt, '\n');
8518 if (p == NULL)
8519 p = prompt;
8520 else
8521 {
8522 ++p;
8523 c = *p;
8524 *p = NUL;
8525 msg_start();
8526 msg_clr_eos();
Bram Moolenaar32526b32019-01-19 17:43:09 +01008527 msg_puts_attr((char *)prompt, echo_attr);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008528 msg_didout = FALSE;
8529 msg_starthere();
8530 *p = c;
8531 }
8532 cmdline_row = msg_row;
8533
8534 if (argvars[1].v_type != VAR_UNKNOWN)
8535 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008536 defstr = tv_get_string_buf_chk(&argvars[1], buf);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008537 if (defstr != NULL)
8538 stuffReadbuffSpec(defstr);
8539
8540 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
8541 {
8542 char_u *xp_name;
8543 int xp_namelen;
8544 long argt;
8545
8546 /* input() with a third argument: completion */
8547 rettv->vval.v_string = NULL;
8548
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008549 xp_name = tv_get_string_buf_chk(&argvars[2], buf);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008550 if (xp_name == NULL)
8551 return;
8552
8553 xp_namelen = (int)STRLEN(xp_name);
8554
8555 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
8556 &xp_arg) == FAIL)
8557 return;
8558 }
8559 }
8560
8561 if (defstr != NULL)
8562 {
8563 int save_ex_normal_busy = ex_normal_busy;
Bram Moolenaar6dff58f2018-09-30 21:43:26 +02008564
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008565 ex_normal_busy = 0;
8566 rettv->vval.v_string =
8567 getcmdline_prompt(secret ? NUL : '@', p, echo_attr,
8568 xp_type, xp_arg);
8569 ex_normal_busy = save_ex_normal_busy;
8570 }
8571 if (inputdialog && rettv->vval.v_string == NULL
8572 && argvars[1].v_type != VAR_UNKNOWN
8573 && argvars[2].v_type != VAR_UNKNOWN)
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008574 rettv->vval.v_string = vim_strsave(tv_get_string_buf(
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008575 &argvars[2], buf));
8576
8577 vim_free(xp_arg);
8578
8579 /* since the user typed this, no need to wait for return */
8580 need_wait_return = FALSE;
8581 msg_didout = FALSE;
8582 }
8583 cmd_silent = cmd_silent_save;
8584}
8585
8586/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008587 * ":echo expr1 ..." print each argument separated with a space, add a
8588 * newline at the end.
8589 * ":echon expr1 ..." print each argument plain.
8590 */
8591 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01008592ex_echo(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008593{
8594 char_u *arg = eap->arg;
Bram Moolenaar33570922005-01-25 22:26:29 +00008595 typval_T rettv;
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008596 char_u *tofree;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008597 char_u *p;
8598 int needclr = TRUE;
8599 int atstart = TRUE;
Bram Moolenaar8a283e52005-01-06 23:28:25 +00008600 char_u numbuf[NUMBUFLEN];
Bram Moolenaar76a63452018-11-28 20:38:37 +01008601 int did_emsg_before = did_emsg;
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01008602 int called_emsg_before = called_emsg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008603
8604 if (eap->skip)
8605 ++emsg_skip;
8606 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
8607 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008608 /* If eval1() causes an error message the text from the command may
8609 * still need to be cleared. E.g., "echo 22,44". */
8610 need_clr_eos = needclr;
8611
Bram Moolenaar071d4272004-06-13 20:20:40 +00008612 p = arg;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00008613 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008614 {
8615 /*
8616 * Report the invalid expression unless the expression evaluation
8617 * has been cancelled due to an aborting error, an interrupt, or an
8618 * exception.
8619 */
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01008620 if (!aborting() && did_emsg == did_emsg_before
8621 && called_emsg == called_emsg_before)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008622 semsg(_(e_invexpr2), p);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008623 need_clr_eos = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008624 break;
8625 }
Bram Moolenaar8c8de832008-06-24 22:58:06 +00008626 need_clr_eos = FALSE;
8627
Bram Moolenaar071d4272004-06-13 20:20:40 +00008628 if (!eap->skip)
8629 {
8630 if (atstart)
8631 {
8632 atstart = FALSE;
8633 /* Call msg_start() after eval1(), evaluating the expression
8634 * may cause a message to appear. */
8635 if (eap->cmdidx == CMD_echo)
Bram Moolenaar12b02902012-03-23 15:18:24 +01008636 {
Bram Moolenaar6df5e5a2012-03-28 16:49:29 +02008637 /* Mark the saved text as finishing the line, so that what
8638 * follows is displayed on a new line when scrolling back
8639 * at the more prompt. */
8640 msg_sb_eol();
Bram Moolenaar071d4272004-06-13 20:20:40 +00008641 msg_start();
Bram Moolenaar12b02902012-03-23 15:18:24 +01008642 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008643 }
8644 else if (eap->cmdidx == CMD_echo)
Bram Moolenaar32526b32019-01-19 17:43:09 +01008645 msg_puts_attr(" ", echo_attr);
Bram Moolenaar520e1e42016-01-23 19:46:28 +01008646 p = echo_string(&rettv, &tofree, numbuf, get_copyID());
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008647 if (p != NULL)
8648 for ( ; *p != NUL && !got_int; ++p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008649 {
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008650 if (*p == '\n' || *p == '\r' || *p == TAB)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008651 {
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008652 if (*p != TAB && needclr)
8653 {
8654 /* remove any text still there from the command */
8655 msg_clr_eos();
8656 needclr = FALSE;
8657 }
8658 msg_putchar_attr(*p, echo_attr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008659 }
8660 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008661 {
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008662 if (has_mbyte)
8663 {
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00008664 int i = (*mb_ptr2len)(p);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008665
8666 (void)msg_outtrans_len_attr(p, i, echo_attr);
8667 p += i - 1;
8668 }
8669 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00008670 (void)msg_outtrans_len_attr(p, 1, echo_attr);
8671 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008672 }
Bram Moolenaar49cd9572005-01-03 21:06:01 +00008673 vim_free(tofree);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008674 }
Bram Moolenaarc70646c2005-01-04 21:52:38 +00008675 clear_tv(&rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008676 arg = skipwhite(arg);
8677 }
8678 eap->nextcmd = check_nextcmd(arg);
8679
8680 if (eap->skip)
8681 --emsg_skip;
8682 else
8683 {
8684 /* remove text that may still be there from the command */
8685 if (needclr)
8686 msg_clr_eos();
8687 if (eap->cmdidx == CMD_echo)
8688 msg_end();
8689 }
8690}
8691
8692/*
8693 * ":echohl {name}".
8694 */
8695 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01008696ex_echohl(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697{
Bram Moolenaar1b9645d2017-09-17 23:03:31 +02008698 echo_attr = syn_name2attr(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008699}
8700
8701/*
8702 * ":execute expr1 ..." execute the result of an expression.
8703 * ":echomsg expr1 ..." Print a message
8704 * ":echoerr expr1 ..." Print an error
8705 * Each gets spaces around each argument and a newline at the end for
8706 * echo commands
8707 */
8708 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01008709ex_execute(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710{
8711 char_u *arg = eap->arg;
Bram Moolenaar33570922005-01-25 22:26:29 +00008712 typval_T rettv;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008713 int ret = OK;
8714 char_u *p;
8715 garray_T ga;
8716 int len;
Bram Moolenaar2c519cf2019-03-21 21:45:34 +01008717 int save_did_emsg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008718
8719 ga_init2(&ga, 1, 80);
8720
8721 if (eap->skip)
8722 ++emsg_skip;
8723 while (*arg != NUL && *arg != '|' && *arg != '\n')
8724 {
Bram Moolenaarce9d50d2019-01-14 22:22:29 +01008725 ret = eval1_emsg(&arg, &rettv, !eap->skip);
8726 if (ret == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008727 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728
8729 if (!eap->skip)
8730 {
Bram Moolenaar461a7fc2018-12-22 13:28:07 +01008731 char_u buf[NUMBUFLEN];
8732
8733 if (eap->cmdidx == CMD_execute)
8734 p = tv_get_string_buf(&rettv, buf);
8735 else
8736 p = tv_stringify(&rettv, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008737 len = (int)STRLEN(p);
8738 if (ga_grow(&ga, len + 2) == FAIL)
8739 {
Bram Moolenaarc70646c2005-01-04 21:52:38 +00008740 clear_tv(&rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008741 ret = FAIL;
8742 break;
8743 }
8744 if (ga.ga_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
Bram Moolenaar071d4272004-06-13 20:20:40 +00008746 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008747 ga.ga_len += len;
8748 }
8749
Bram Moolenaarc70646c2005-01-04 21:52:38 +00008750 clear_tv(&rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751 arg = skipwhite(arg);
8752 }
8753
8754 if (ret != FAIL && ga.ga_data != NULL)
8755 {
Bram Moolenaar57002ad2017-03-16 19:04:19 +01008756 if (eap->cmdidx == CMD_echomsg || eap->cmdidx == CMD_echoerr)
8757 {
8758 /* Mark the already saved text as finishing the line, so that what
8759 * follows is displayed on a new line when scrolling back at the
8760 * more prompt. */
8761 msg_sb_eol();
Bram Moolenaar57002ad2017-03-16 19:04:19 +01008762 }
8763
Bram Moolenaar071d4272004-06-13 20:20:40 +00008764 if (eap->cmdidx == CMD_echomsg)
Bram Moolenaar4770d092006-01-12 23:22:24 +00008765 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01008766 msg_attr(ga.ga_data, echo_attr);
Bram Moolenaar4770d092006-01-12 23:22:24 +00008767 out_flush();
8768 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008769 else if (eap->cmdidx == CMD_echoerr)
8770 {
8771 /* We don't want to abort following commands, restore did_emsg. */
8772 save_did_emsg = did_emsg;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01008773 emsg(ga.ga_data);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774 if (!force_abort)
8775 did_emsg = save_did_emsg;
8776 }
8777 else if (eap->cmdidx == CMD_execute)
8778 do_cmdline((char_u *)ga.ga_data,
8779 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
8780 }
8781
8782 ga_clear(&ga);
8783
8784 if (eap->skip)
8785 --emsg_skip;
8786
8787 eap->nextcmd = check_nextcmd(arg);
8788}
8789
8790/*
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008791 * Find window specified by "vp" in tabpage "tp".
8792 */
8793 win_T *
8794find_win_by_nr(
8795 typval_T *vp,
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01008796 tabpage_T *tp) /* NULL for current tab page */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008797{
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008798 win_T *wp;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008799 int nr = (int)tv_get_number_chk(vp, NULL);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008800
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008801 if (nr < 0)
8802 return NULL;
8803 if (nr == 0)
8804 return curwin;
8805
Bram Moolenaar29323592016-07-24 22:04:11 +02008806 FOR_ALL_WINDOWS_IN_TAB(tp, wp)
8807 {
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008808 if (nr >= LOWEST_WIN_ID)
8809 {
8810 if (wp->w_id == nr)
8811 return wp;
8812 }
8813 else if (--nr <= 0)
8814 break;
Bram Moolenaar29323592016-07-24 22:04:11 +02008815 }
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008816 if (nr >= LOWEST_WIN_ID)
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008817 {
8818#ifdef FEAT_TEXT_PROP
8819 // popup windows are in a separate list
8820 for (wp = (tp == NULL || tp == curtab)
8821 ? first_tab_popupwin : tp->tp_first_popupwin;
8822 wp != NULL; wp = wp->w_next)
8823 if (wp->w_id == nr)
8824 return wp;
8825 for (wp = first_popupwin; wp != NULL; wp = wp->w_next)
8826 if (wp->w_id == nr)
8827 return wp;
8828#endif
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008829 return NULL;
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008830 }
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008831 return wp;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008832}
8833
8834/*
Bram Moolenaare6e39892018-10-25 12:32:11 +02008835 * Find a window: When using a Window ID in any tab page, when using a number
8836 * in the current tab page.
8837 */
8838 win_T *
8839find_win_by_nr_or_id(typval_T *vp)
8840{
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008841 int nr = (int)tv_get_number_chk(vp, NULL);
Bram Moolenaare6e39892018-10-25 12:32:11 +02008842
8843 if (nr >= LOWEST_WIN_ID)
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01008844 return win_id2wp(tv_get_number(vp));
Bram Moolenaare6e39892018-10-25 12:32:11 +02008845 return find_win_by_nr(vp, NULL);
8846}
8847
8848/*
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008849 * Find window specified by "wvp" in tabpage "tvp".
Bram Moolenaar00aa0692019-04-27 20:37:57 +02008850 * Returns the tab page in 'ptp'
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008851 */
8852 win_T *
8853find_tabwin(
Bram Moolenaar00aa0692019-04-27 20:37:57 +02008854 typval_T *wvp, // VAR_UNKNOWN for current window
8855 typval_T *tvp, // VAR_UNKNOWN for current tab page
8856 tabpage_T **ptp)
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008857{
8858 win_T *wp = NULL;
8859 tabpage_T *tp = NULL;
8860 long n;
8861
8862 if (wvp->v_type != VAR_UNKNOWN)
8863 {
8864 if (tvp->v_type != VAR_UNKNOWN)
8865 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008866 n = (long)tv_get_number(tvp);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008867 if (n >= 0)
8868 tp = find_tabpage(n);
8869 }
8870 else
8871 tp = curtab;
8872
8873 if (tp != NULL)
Bram Moolenaar00aa0692019-04-27 20:37:57 +02008874 {
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008875 wp = find_win_by_nr(wvp, tp);
Bram Moolenaar00aa0692019-04-27 20:37:57 +02008876 if (wp == NULL && wvp->v_type == VAR_NUMBER
8877 && wvp->vval.v_number != -1)
8878 // A window with the specified number is not found
8879 tp = NULL;
8880 }
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008881 }
8882 else
Bram Moolenaar00aa0692019-04-27 20:37:57 +02008883 {
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008884 wp = curwin;
Bram Moolenaar00aa0692019-04-27 20:37:57 +02008885 tp = curtab;
8886 }
8887
8888 if (ptp != NULL)
8889 *ptp = tp;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008890
8891 return wp;
8892}
8893
8894/*
8895 * getwinvar() and gettabwinvar()
8896 */
8897 void
8898getwinvar(
8899 typval_T *argvars,
8900 typval_T *rettv,
8901 int off) /* 1 for gettabwinvar() */
8902{
8903 win_T *win;
8904 char_u *varname;
8905 dictitem_T *v;
8906 tabpage_T *tp = NULL;
8907 int done = FALSE;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008908 win_T *oldcurwin;
8909 tabpage_T *oldtabpage;
8910 int need_switch_win;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008911
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008912 if (off == 1)
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008913 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008914 else
8915 tp = curtab;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008916 win = find_win_by_nr(&argvars[off], tp);
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008917 varname = tv_get_string_chk(&argvars[off + 1]);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008918 ++emsg_off;
8919
8920 rettv->v_type = VAR_STRING;
8921 rettv->vval.v_string = NULL;
8922
8923 if (win != NULL && varname != NULL)
8924 {
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008925 /* Set curwin to be our win, temporarily. Also set the tabpage,
8926 * otherwise the window is not valid. Only do this when needed,
8927 * autocommands get blocked. */
8928 need_switch_win = !(tp == curtab && win == curwin);
8929 if (!need_switch_win
8930 || switch_win(&oldcurwin, &oldtabpage, win, tp, TRUE) == OK)
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008931 {
Bram Moolenaar30567352016-08-27 21:25:44 +02008932 if (*varname == '&')
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008933 {
Bram Moolenaar30567352016-08-27 21:25:44 +02008934 if (varname[1] == NUL)
8935 {
8936 /* get all window-local options in a dict */
8937 dict_T *opts = get_winbuf_options(FALSE);
8938
8939 if (opts != NULL)
8940 {
Bram Moolenaar45cf6e92017-04-30 20:25:19 +02008941 rettv_dict_set(rettv, opts);
Bram Moolenaar30567352016-08-27 21:25:44 +02008942 done = TRUE;
8943 }
8944 }
8945 else if (get_option_tv(&varname, rettv, 1) == OK)
8946 /* window-local-option */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008947 done = TRUE;
8948 }
8949 else
8950 {
8951 /* Look up the variable. */
8952 /* Let getwinvar({nr}, "") return the "w:" dictionary. */
8953 v = find_var_in_ht(&win->w_vars->dv_hashtab, 'w',
8954 varname, FALSE);
8955 if (v != NULL)
8956 {
8957 copy_tv(&v->di_tv, rettv);
8958 done = TRUE;
8959 }
8960 }
8961 }
8962
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008963 if (need_switch_win)
8964 /* restore previous notion of curwin */
8965 restore_win(oldcurwin, oldtabpage, TRUE);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008966 }
8967
8968 if (!done && argvars[off + 2].v_type != VAR_UNKNOWN)
8969 /* use the default return value */
8970 copy_tv(&argvars[off + 2], rettv);
8971
8972 --emsg_off;
8973}
8974
8975/*
8976 * "setwinvar()" and "settabwinvar()" functions
8977 */
8978 void
8979setwinvar(typval_T *argvars, typval_T *rettv UNUSED, int off)
8980{
8981 win_T *win;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008982 win_T *save_curwin;
8983 tabpage_T *save_curtab;
8984 int need_switch_win;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008985 char_u *varname, *winvarname;
8986 typval_T *varp;
8987 char_u nbuf[NUMBUFLEN];
8988 tabpage_T *tp = NULL;
8989
Bram Moolenaare0fb7d12019-02-12 20:48:10 +01008990 if (check_secure())
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008991 return;
8992
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008993 if (off == 1)
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008994 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008995 else
8996 tp = curtab;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008997 win = find_win_by_nr(&argvars[off], tp);
Bram Moolenaard155d7a2018-12-21 16:04:21 +01008998 varname = tv_get_string_chk(&argvars[off + 1]);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02008999 varp = &argvars[off + 2];
9000
9001 if (win != NULL && varname != NULL && varp != NULL)
9002 {
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009003 need_switch_win = !(tp == curtab && win == curwin);
9004 if (!need_switch_win
9005 || switch_win(&save_curwin, &save_curtab, win, tp, TRUE) == OK)
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009006 {
9007 if (*varname == '&')
9008 {
9009 long numval;
9010 char_u *strval;
9011 int error = FALSE;
9012
9013 ++varname;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009014 numval = (long)tv_get_number_chk(varp, &error);
9015 strval = tv_get_string_buf_chk(varp, nbuf);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009016 if (!error && strval != NULL)
9017 set_option_value(varname, numval, strval, OPT_LOCAL);
9018 }
9019 else
9020 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02009021 winvarname = alloc(STRLEN(varname) + 3);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009022 if (winvarname != NULL)
9023 {
9024 STRCPY(winvarname, "w:");
9025 STRCPY(winvarname + 2, varname);
9026 set_var(winvarname, varp, TRUE);
9027 vim_free(winvarname);
9028 }
9029 }
9030 }
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009031 if (need_switch_win)
9032 restore_win(save_curwin, save_curtab, TRUE);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009033 }
9034}
9035
9036/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009037 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
9038 * "arg" points to the "&" or '+' when called, to "option" when returning.
9039 * Returns NULL when no option name found. Otherwise pointer to the char
9040 * after the option name.
9041 */
9042 static char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +01009043find_option_end(char_u **arg, int *opt_flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009044{
9045 char_u *p = *arg;
9046
9047 ++p;
9048 if (*p == 'g' && p[1] == ':')
9049 {
9050 *opt_flags = OPT_GLOBAL;
9051 p += 2;
9052 }
9053 else if (*p == 'l' && p[1] == ':')
9054 {
9055 *opt_flags = OPT_LOCAL;
9056 p += 2;
9057 }
9058 else
9059 *opt_flags = 0;
9060
9061 if (!ASCII_ISALPHA(*p))
9062 return NULL;
9063 *arg = p;
9064
9065 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
9066 p += 4; /* termcap option */
9067 else
9068 while (ASCII_ISALPHA(*p))
9069 ++p;
9070 return p;
9071}
9072
9073/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02009074 * Return the autoload script name for a function or variable name.
9075 * Returns NULL when out of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009076 */
Bram Moolenaara1544c02013-05-30 12:35:52 +02009077 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02009078autoload_name(char_u *name)
Bram Moolenaara1544c02013-05-30 12:35:52 +02009079{
Bram Moolenaara1544c02013-05-30 12:35:52 +02009080 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02009081 char_u *scriptname;
Bram Moolenaara1544c02013-05-30 12:35:52 +02009082
Bram Moolenaara9b579f2016-07-17 18:29:19 +02009083 /* Get the script file name: replace '#' with '/', append ".vim". */
Bram Moolenaar964b3742019-05-24 18:54:09 +02009084 scriptname = alloc(STRLEN(name) + 14);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02009085 if (scriptname == NULL)
Bram Moolenaar9bdfb002014-04-23 17:43:42 +02009086 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02009087 STRCPY(scriptname, "autoload/");
9088 STRCAT(scriptname, name);
9089 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
9090 STRCAT(scriptname, ".vim");
9091 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
9092 *p = '/';
9093 return scriptname;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00009094}
9095
9096/*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00009097 * If "name" has a package name try autoloading the script for it.
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00009098 * Return TRUE if a package was loaded.
9099 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02009100 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01009101script_autoload(
9102 char_u *name,
9103 int reload) /* load script again when already loaded */
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00009104{
9105 char_u *p;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00009106 char_u *scriptname, *tofree;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00009107 int ret = FALSE;
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00009108 int i;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00009109
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00009110 /* If there is no '#' after name[0] there is no package name. */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00009111 p = vim_strchr(name, AUTOLOAD_CHAR);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00009112 if (p == NULL || p == name)
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00009113 return FALSE;
9114
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00009115 tofree = scriptname = autoload_name(name);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00009116
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00009117 /* Find the name in the list of previously loaded package names. Skip
9118 * "autoload/", it's always the same. */
9119 for (i = 0; i < ga_loaded.ga_len; ++i)
9120 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
9121 break;
9122 if (!reload && i < ga_loaded.ga_len)
9123 ret = FALSE; /* was loaded already */
9124 else
9125 {
9126 /* Remember the name if it wasn't loaded already. */
9127 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
9128 {
9129 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
9130 tofree = NULL;
9131 }
9132
9133 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01009134 if (source_runtime(scriptname, 0) == OK)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00009135 ret = TRUE;
9136 }
9137
9138 vim_free(tofree);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00009139 return ret;
9140}
9141
Bram Moolenaar071d4272004-06-13 20:20:40 +00009142#if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
9143typedef enum
9144{
Bram Moolenaar8c8de832008-06-24 22:58:06 +00009145 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
9146 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
9147 VAR_FLAVOUR_VIMINFO /* all uppercase */
Bram Moolenaar071d4272004-06-13 20:20:40 +00009148} var_flavour_T;
9149
Bram Moolenaar071d4272004-06-13 20:20:40 +00009150 static var_flavour_T
Bram Moolenaar7454a062016-01-30 15:14:10 +01009151var_flavour(char_u *varname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009152{
9153 char_u *p = varname;
9154
9155 if (ASCII_ISUPPER(*p))
9156 {
9157 while (*(++p))
9158 if (ASCII_ISLOWER(*p))
9159 return VAR_FLAVOUR_SESSION;
9160 return VAR_FLAVOUR_VIMINFO;
9161 }
9162 else
9163 return VAR_FLAVOUR_DEFAULT;
9164}
9165#endif
9166
9167#if defined(FEAT_VIMINFO) || defined(PROTO)
9168/*
9169 * Restore global vars that start with a capital from the viminfo file
9170 */
9171 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01009172read_viminfo_varlist(vir_T *virp, int writing)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009173{
9174 char_u *tab;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00009175 int type = VAR_NUMBER;
Bram Moolenaar33570922005-01-25 22:26:29 +00009176 typval_T tv;
Bram Moolenaar27e80c82018-10-14 21:41:01 +02009177 funccal_entry_T funccal_entry;
Bram Moolenaar071d4272004-06-13 20:20:40 +00009178
9179 if (!writing && (find_viminfo_parameter('!') != NULL))
9180 {
9181 tab = vim_strchr(virp->vir_line + 1, '\t');
9182 if (tab != NULL)
9183 {
9184 *tab++ = '\0'; /* isolate the variable name */
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009185 switch (*tab)
9186 {
9187 case 'S': type = VAR_STRING; break;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00009188#ifdef FEAT_FLOAT
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009189 case 'F': type = VAR_FLOAT; break;
Bram Moolenaar8c8de832008-06-24 22:58:06 +00009190#endif
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009191 case 'D': type = VAR_DICT; break;
9192 case 'L': type = VAR_LIST; break;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01009193 case 'B': type = VAR_BLOB; break;
Bram Moolenaara03f2332016-02-06 18:09:59 +01009194 case 'X': type = VAR_SPECIAL; break;
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009195 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00009196
9197 tab = vim_strchr(tab, '\t');
9198 if (tab != NULL)
9199 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00009200 tv.v_type = type;
Bram Moolenaar8c8b8bb2019-01-13 17:48:04 +01009201 if (type == VAR_STRING || type == VAR_DICT
9202 || type == VAR_LIST || type == VAR_BLOB)
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00009203 tv.vval.v_string = viminfo_readstring(virp,
Bram Moolenaar071d4272004-06-13 20:20:40 +00009204 (int)(tab - virp->vir_line + 1), TRUE);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00009205#ifdef FEAT_FLOAT
9206 else if (type == VAR_FLOAT)
9207 (void)string2float(tab + 1, &tv.vval.v_float);
9208#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00009209 else
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00009210 tv.vval.v_number = atol((char *)tab + 1);
Bram Moolenaar8c8b8bb2019-01-13 17:48:04 +01009211 if (type == VAR_DICT || type == VAR_LIST)
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009212 {
9213 typval_T *etv = eval_expr(tv.vval.v_string, NULL);
9214
9215 if (etv == NULL)
9216 /* Failed to parse back the dict or list, use it as a
9217 * string. */
9218 tv.v_type = VAR_STRING;
9219 else
9220 {
9221 vim_free(tv.vval.v_string);
9222 tv = *etv;
Bram Moolenaar507cc8a2012-03-23 15:37:02 +01009223 vim_free(etv);
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009224 }
9225 }
Bram Moolenaar8c8b8bb2019-01-13 17:48:04 +01009226 else if (type == VAR_BLOB)
9227 {
9228 blob_T *blob = string2blob(tv.vval.v_string);
9229
9230 if (blob == NULL)
9231 // Failed to parse back the blob, use it as a string.
9232 tv.v_type = VAR_STRING;
9233 else
9234 {
9235 vim_free(tv.vval.v_string);
9236 tv.v_type = VAR_BLOB;
9237 tv.vval.v_blob = blob;
9238 }
9239 }
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009240
Bram Moolenaarb20e3342016-01-18 23:29:01 +01009241 /* when in a function use global variables */
Bram Moolenaar27e80c82018-10-14 21:41:01 +02009242 save_funccal(&funccal_entry);
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00009243 set_var(virp->vir_line + 1, &tv, FALSE);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02009244 restore_funccal();
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009245
9246 if (tv.v_type == VAR_STRING)
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00009247 vim_free(tv.vval.v_string);
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01009248 else if (tv.v_type == VAR_DICT || tv.v_type == VAR_LIST ||
9249 tv.v_type == VAR_BLOB)
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009250 clear_tv(&tv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00009251 }
9252 }
9253 }
9254
9255 return viminfo_readline(virp);
9256}
9257
9258/*
9259 * Write global vars that start with a capital to the viminfo file
9260 */
9261 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01009262write_viminfo_varlist(FILE *fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009263{
Bram Moolenaar33570922005-01-25 22:26:29 +00009264 hashitem_T *hi;
9265 dictitem_T *this_var;
Bram Moolenaara7043832005-01-21 11:56:39 +00009266 int todo;
Bram Moolenaar2fc83fc2016-02-08 22:57:24 +01009267 char *s = "";
Bram Moolenaar81bf7082005-02-12 14:31:42 +00009268 char_u *p;
Bram Moolenaarc70646c2005-01-04 21:52:38 +00009269 char_u *tofree;
Bram Moolenaar8a283e52005-01-06 23:28:25 +00009270 char_u numbuf[NUMBUFLEN];
Bram Moolenaar071d4272004-06-13 20:20:40 +00009271
9272 if (find_viminfo_parameter('!') == NULL)
9273 return;
9274
Bram Moolenaar9577c3e2010-05-14 12:16:25 +02009275 fputs(_("\n# global variables:\n"), fp);
Bram Moolenaara7043832005-01-21 11:56:39 +00009276
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00009277 todo = (int)globvarht.ht_used;
Bram Moolenaar33570922005-01-25 22:26:29 +00009278 for (hi = globvarht.ht_array; todo > 0; ++hi)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009279 {
Bram Moolenaara7043832005-01-21 11:56:39 +00009280 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar071d4272004-06-13 20:20:40 +00009281 {
Bram Moolenaara7043832005-01-21 11:56:39 +00009282 --todo;
Bram Moolenaar33570922005-01-25 22:26:29 +00009283 this_var = HI2DI(hi);
9284 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
Bram Moolenaarc70646c2005-01-04 21:52:38 +00009285 {
Bram Moolenaar33570922005-01-25 22:26:29 +00009286 switch (this_var->di_tv.v_type)
Bram Moolenaara7043832005-01-21 11:56:39 +00009287 {
9288 case VAR_STRING: s = "STR"; break;
9289 case VAR_NUMBER: s = "NUM"; break;
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009290 case VAR_FLOAT: s = "FLO"; break;
Bram Moolenaar680eeca2010-10-20 17:44:42 +02009291 case VAR_DICT: s = "DIC"; break;
9292 case VAR_LIST: s = "LIS"; break;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01009293 case VAR_BLOB: s = "BLO"; break;
Bram Moolenaara03f2332016-02-06 18:09:59 +01009294 case VAR_SPECIAL: s = "XPL"; break;
9295
9296 case VAR_UNKNOWN:
9297 case VAR_FUNC:
Bram Moolenaar1735bc92016-03-14 23:05:14 +01009298 case VAR_PARTIAL:
Bram Moolenaar835dc632016-02-07 14:27:38 +01009299 case VAR_JOB:
Bram Moolenaar77073442016-02-13 23:23:53 +01009300 case VAR_CHANNEL:
Bram Moolenaara03f2332016-02-06 18:09:59 +01009301 continue;
Bram Moolenaara7043832005-01-21 11:56:39 +00009302 }
Bram Moolenaar33570922005-01-25 22:26:29 +00009303 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
Bram Moolenaar8c8b8bb2019-01-13 17:48:04 +01009304 if (this_var->di_tv.v_type == VAR_SPECIAL)
9305 {
9306 sprintf((char *)numbuf, "%ld",
9307 (long)this_var->di_tv.vval.v_number);
9308 p = numbuf;
9309 tofree = NULL;
9310 }
9311 else
9312 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00009313 if (p != NULL)
9314 viminfo_writestring(fp, p);
Bram Moolenaara7043832005-01-21 11:56:39 +00009315 vim_free(tofree);
9316 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00009317 }
9318 }
9319}
9320#endif
9321
9322#if defined(FEAT_SESSION) || defined(PROTO)
9323 int
Bram Moolenaar7454a062016-01-30 15:14:10 +01009324store_session_globals(FILE *fd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009325{
Bram Moolenaar33570922005-01-25 22:26:29 +00009326 hashitem_T *hi;
9327 dictitem_T *this_var;
Bram Moolenaara7043832005-01-21 11:56:39 +00009328 int todo;
Bram Moolenaar071d4272004-06-13 20:20:40 +00009329 char_u *p, *t;
9330
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00009331 todo = (int)globvarht.ht_used;
Bram Moolenaar33570922005-01-25 22:26:29 +00009332 for (hi = globvarht.ht_array; todo > 0; ++hi)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009333 {
Bram Moolenaara7043832005-01-21 11:56:39 +00009334 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar071d4272004-06-13 20:20:40 +00009335 {
Bram Moolenaara7043832005-01-21 11:56:39 +00009336 --todo;
Bram Moolenaar33570922005-01-25 22:26:29 +00009337 this_var = HI2DI(hi);
9338 if ((this_var->di_tv.v_type == VAR_NUMBER
9339 || this_var->di_tv.v_type == VAR_STRING)
9340 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00009341 {
Bram Moolenaara7043832005-01-21 11:56:39 +00009342 /* Escape special characters with a backslash. Turn a LF and
9343 * CR into \n and \r. */
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009344 p = vim_strsave_escaped(tv_get_string(&this_var->di_tv),
Bram Moolenaara7043832005-01-21 11:56:39 +00009345 (char_u *)"\\\"\n\r");
9346 if (p == NULL) /* out of memory */
9347 break;
9348 for (t = p; *t != NUL; ++t)
9349 if (*t == '\n')
9350 *t = 'n';
9351 else if (*t == '\r')
9352 *t = 'r';
9353 if ((fprintf(fd, "let %s = %c%s%c",
Bram Moolenaar33570922005-01-25 22:26:29 +00009354 this_var->di_key,
9355 (this_var->di_tv.v_type == VAR_STRING) ? '"'
9356 : ' ',
9357 p,
9358 (this_var->di_tv.v_type == VAR_STRING) ? '"'
9359 : ' ') < 0)
Bram Moolenaara7043832005-01-21 11:56:39 +00009360 || put_eol(fd) == FAIL)
9361 {
9362 vim_free(p);
9363 return FAIL;
9364 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00009365 vim_free(p);
9366 }
Bram Moolenaar8c8de832008-06-24 22:58:06 +00009367#ifdef FEAT_FLOAT
9368 else if (this_var->di_tv.v_type == VAR_FLOAT
9369 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
9370 {
9371 float_T f = this_var->di_tv.vval.v_float;
9372 int sign = ' ';
9373
9374 if (f < 0)
9375 {
9376 f = -f;
9377 sign = '-';
9378 }
Bram Moolenaar2b04b192012-01-26 11:45:30 +01009379 if ((fprintf(fd, "let %s = %c%f",
Bram Moolenaar8c8de832008-06-24 22:58:06 +00009380 this_var->di_key, sign, f) < 0)
9381 || put_eol(fd) == FAIL)
9382 return FAIL;
9383 }
9384#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00009385 }
9386 }
9387 return OK;
9388}
9389#endif
9390
Bram Moolenaar661b1822005-07-28 22:36:45 +00009391/*
9392 * Display script name where an item was last set.
9393 * Should only be invoked when 'verbose' is non-zero.
9394 */
9395 void
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02009396last_set_msg(sctx_T script_ctx)
Bram Moolenaar661b1822005-07-28 22:36:45 +00009397{
Bram Moolenaarcafda4f2005-09-06 19:25:11 +00009398 char_u *p;
9399
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02009400 if (script_ctx.sc_sid != 0)
Bram Moolenaar661b1822005-07-28 22:36:45 +00009401 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02009402 p = home_replace_save(NULL, get_scriptname(script_ctx.sc_sid));
Bram Moolenaarcafda4f2005-09-06 19:25:11 +00009403 if (p != NULL)
9404 {
9405 verbose_enter();
Bram Moolenaar32526b32019-01-19 17:43:09 +01009406 msg_puts(_("\n\tLast set from "));
9407 msg_puts((char *)p);
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02009408 if (script_ctx.sc_lnum > 0)
9409 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01009410 msg_puts(_(" line "));
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02009411 msg_outnum((long)script_ctx.sc_lnum);
9412 }
Bram Moolenaarcafda4f2005-09-06 19:25:11 +00009413 verbose_leave();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02009414 vim_free(p);
Bram Moolenaarcafda4f2005-09-06 19:25:11 +00009415 }
Bram Moolenaar661b1822005-07-28 22:36:45 +00009416 }
9417}
9418
Bram Moolenaar61be3762019-03-19 23:04:17 +01009419/*
9420 * Reset v:option_new, v:option_old and v:option_type.
9421 */
Bram Moolenaar53744302015-07-17 17:38:22 +02009422 void
Bram Moolenaar7454a062016-01-30 15:14:10 +01009423reset_v_option_vars(void)
Bram Moolenaar53744302015-07-17 17:38:22 +02009424{
9425 set_vim_var_string(VV_OPTION_NEW, NULL, -1);
9426 set_vim_var_string(VV_OPTION_OLD, NULL, -1);
9427 set_vim_var_string(VV_OPTION_TYPE, NULL, -1);
9428}
9429
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009430/*
9431 * Prepare "gap" for an assert error and add the sourcing position.
9432 */
9433 void
9434prepare_assert_error(garray_T *gap)
9435{
9436 char buf[NUMBUFLEN];
9437
9438 ga_init2(gap, 1, 100);
9439 if (sourcing_name != NULL)
9440 {
9441 ga_concat(gap, sourcing_name);
9442 if (sourcing_lnum > 0)
9443 ga_concat(gap, (char_u *)" ");
9444 }
9445 if (sourcing_lnum > 0)
9446 {
9447 sprintf(buf, "line %ld", (long)sourcing_lnum);
9448 ga_concat(gap, (char_u *)buf);
9449 }
9450 if (sourcing_name != NULL || sourcing_lnum > 0)
9451 ga_concat(gap, (char_u *)": ");
9452}
9453
9454/*
9455 * Add an assert error to v:errors.
9456 */
9457 void
9458assert_error(garray_T *gap)
9459{
9460 struct vimvar *vp = &vimvars[VV_ERRORS];
9461
9462 if (vp->vv_type != VAR_LIST || vimvars[VV_ERRORS].vv_list == NULL)
9463 /* Make sure v:errors is a list. */
9464 set_vim_var_list(VV_ERRORS, list_alloc());
9465 list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
9466}
9467
Bram Moolenaar65a54642018-04-28 16:56:53 +02009468 int
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009469assert_equal_common(typval_T *argvars, assert_type_T atype)
9470{
9471 garray_T ga;
9472
9473 if (tv_equal(&argvars[0], &argvars[1], FALSE, FALSE)
9474 != (atype == ASSERT_EQUAL))
9475 {
9476 prepare_assert_error(&ga);
9477 fill_assert_error(&ga, &argvars[2], NULL, &argvars[0], &argvars[1],
9478 atype);
9479 assert_error(&ga);
9480 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009481 return 1;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009482 }
Bram Moolenaar65a54642018-04-28 16:56:53 +02009483 return 0;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009484}
9485
Bram Moolenaar65a54642018-04-28 16:56:53 +02009486 int
Bram Moolenaard96ff162018-02-18 22:13:29 +01009487assert_equalfile(typval_T *argvars)
9488{
9489 char_u buf1[NUMBUFLEN];
9490 char_u buf2[NUMBUFLEN];
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009491 char_u *fname1 = tv_get_string_buf_chk(&argvars[0], buf1);
9492 char_u *fname2 = tv_get_string_buf_chk(&argvars[1], buf2);
Bram Moolenaard96ff162018-02-18 22:13:29 +01009493 garray_T ga;
9494 FILE *fd1;
9495 FILE *fd2;
9496
9497 if (fname1 == NULL || fname2 == NULL)
Bram Moolenaar65a54642018-04-28 16:56:53 +02009498 return 0;
Bram Moolenaard96ff162018-02-18 22:13:29 +01009499
9500 IObuff[0] = NUL;
9501 fd1 = mch_fopen((char *)fname1, READBIN);
9502 if (fd1 == NULL)
9503 {
9504 vim_snprintf((char *)IObuff, IOSIZE, (char *)e_notread, fname1);
9505 }
9506 else
9507 {
9508 fd2 = mch_fopen((char *)fname2, READBIN);
9509 if (fd2 == NULL)
9510 {
9511 fclose(fd1);
9512 vim_snprintf((char *)IObuff, IOSIZE, (char *)e_notread, fname2);
9513 }
9514 else
9515 {
9516 int c1, c2;
9517 long count = 0;
9518
9519 for (;;)
9520 {
9521 c1 = fgetc(fd1);
9522 c2 = fgetc(fd2);
9523 if (c1 == EOF)
9524 {
9525 if (c2 != EOF)
9526 STRCPY(IObuff, "first file is shorter");
9527 break;
9528 }
9529 else if (c2 == EOF)
9530 {
9531 STRCPY(IObuff, "second file is shorter");
9532 break;
9533 }
9534 else if (c1 != c2)
9535 {
9536 vim_snprintf((char *)IObuff, IOSIZE,
9537 "difference at byte %ld", count);
9538 break;
9539 }
9540 ++count;
9541 }
Bram Moolenaar30494182018-02-20 21:46:05 +01009542 fclose(fd1);
9543 fclose(fd2);
Bram Moolenaard96ff162018-02-18 22:13:29 +01009544 }
9545 }
9546 if (IObuff[0] != NUL)
9547 {
9548 prepare_assert_error(&ga);
9549 ga_concat(&ga, IObuff);
9550 assert_error(&ga);
9551 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009552 return 1;
Bram Moolenaard96ff162018-02-18 22:13:29 +01009553 }
Bram Moolenaar65a54642018-04-28 16:56:53 +02009554 return 0;
Bram Moolenaard96ff162018-02-18 22:13:29 +01009555}
9556
Bram Moolenaar65a54642018-04-28 16:56:53 +02009557 int
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009558assert_match_common(typval_T *argvars, assert_type_T atype)
9559{
9560 garray_T ga;
9561 char_u buf1[NUMBUFLEN];
9562 char_u buf2[NUMBUFLEN];
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009563 char_u *pat = tv_get_string_buf_chk(&argvars[0], buf1);
9564 char_u *text = tv_get_string_buf_chk(&argvars[1], buf2);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009565
9566 if (pat == NULL || text == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01009567 emsg(_(e_invarg));
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009568 else if (pattern_match(pat, text, FALSE) != (atype == ASSERT_MATCH))
9569 {
9570 prepare_assert_error(&ga);
9571 fill_assert_error(&ga, &argvars[2], NULL, &argvars[0], &argvars[1],
9572 atype);
9573 assert_error(&ga);
9574 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009575 return 1;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009576 }
Bram Moolenaar65a54642018-04-28 16:56:53 +02009577 return 0;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009578}
9579
Bram Moolenaar65a54642018-04-28 16:56:53 +02009580 int
Bram Moolenaar61c04492016-07-23 15:35:35 +02009581assert_inrange(typval_T *argvars)
9582{
9583 garray_T ga;
9584 int error = FALSE;
Bram Moolenaar61c04492016-07-23 15:35:35 +02009585 char_u *tofree;
9586 char msg[200];
9587 char_u numbuf[NUMBUFLEN];
9588
Bram Moolenaar38f08e72019-02-20 22:04:32 +01009589#ifdef FEAT_FLOAT
9590 if (argvars[0].v_type == VAR_FLOAT
9591 || argvars[1].v_type == VAR_FLOAT
9592 || argvars[2].v_type == VAR_FLOAT)
Bram Moolenaar61c04492016-07-23 15:35:35 +02009593 {
Bram Moolenaar38f08e72019-02-20 22:04:32 +01009594 float_T flower = tv_get_float(&argvars[0]);
9595 float_T fupper = tv_get_float(&argvars[1]);
9596 float_T factual = tv_get_float(&argvars[2]);
9597
9598 if (factual < flower || factual > fupper)
Bram Moolenaar61c04492016-07-23 15:35:35 +02009599 {
Bram Moolenaar38f08e72019-02-20 22:04:32 +01009600 prepare_assert_error(&ga);
9601 if (argvars[3].v_type != VAR_UNKNOWN)
9602 {
9603 ga_concat(&ga, tv2string(&argvars[3], &tofree, numbuf, 0));
9604 vim_free(tofree);
9605 }
9606 else
9607 {
9608 vim_snprintf(msg, 200, "Expected range %g - %g, but got %g",
9609 flower, fupper, factual);
9610 ga_concat(&ga, (char_u *)msg);
9611 }
9612 assert_error(&ga);
9613 ga_clear(&ga);
9614 return 1;
Bram Moolenaar61c04492016-07-23 15:35:35 +02009615 }
Bram Moolenaar38f08e72019-02-20 22:04:32 +01009616 }
9617 else
9618#endif
9619 {
9620 varnumber_T lower = tv_get_number_chk(&argvars[0], &error);
9621 varnumber_T upper = tv_get_number_chk(&argvars[1], &error);
9622 varnumber_T actual = tv_get_number_chk(&argvars[2], &error);
9623
9624 if (error)
9625 return 0;
9626 if (actual < lower || actual > upper)
Bram Moolenaar61c04492016-07-23 15:35:35 +02009627 {
Bram Moolenaar38f08e72019-02-20 22:04:32 +01009628 prepare_assert_error(&ga);
9629 if (argvars[3].v_type != VAR_UNKNOWN)
9630 {
9631 ga_concat(&ga, tv2string(&argvars[3], &tofree, numbuf, 0));
9632 vim_free(tofree);
9633 }
9634 else
9635 {
9636 vim_snprintf(msg, 200, "Expected range %ld - %ld, but got %ld",
Bram Moolenaar61c04492016-07-23 15:35:35 +02009637 (long)lower, (long)upper, (long)actual);
Bram Moolenaar38f08e72019-02-20 22:04:32 +01009638 ga_concat(&ga, (char_u *)msg);
9639 }
9640 assert_error(&ga);
9641 ga_clear(&ga);
9642 return 1;
Bram Moolenaar61c04492016-07-23 15:35:35 +02009643 }
Bram Moolenaar61c04492016-07-23 15:35:35 +02009644 }
Bram Moolenaar65a54642018-04-28 16:56:53 +02009645 return 0;
Bram Moolenaar61c04492016-07-23 15:35:35 +02009646}
9647
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009648/*
9649 * Common for assert_true() and assert_false().
Bram Moolenaar65a54642018-04-28 16:56:53 +02009650 * Return non-zero for failure.
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009651 */
Bram Moolenaar65a54642018-04-28 16:56:53 +02009652 int
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009653assert_bool(typval_T *argvars, int isTrue)
9654{
9655 int error = FALSE;
9656 garray_T ga;
9657
9658 if (argvars[0].v_type == VAR_SPECIAL
9659 && argvars[0].vval.v_number == (isTrue ? VVAL_TRUE : VVAL_FALSE))
Bram Moolenaar65a54642018-04-28 16:56:53 +02009660 return 0;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009661 if (argvars[0].v_type != VAR_NUMBER
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009662 || (tv_get_number_chk(&argvars[0], &error) == 0) == isTrue
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009663 || error)
9664 {
9665 prepare_assert_error(&ga);
9666 fill_assert_error(&ga, &argvars[1],
9667 (char_u *)(isTrue ? "True" : "False"),
9668 NULL, &argvars[0], ASSERT_OTHER);
9669 assert_error(&ga);
9670 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009671 return 1;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009672 }
Bram Moolenaar65a54642018-04-28 16:56:53 +02009673 return 0;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009674}
9675
Bram Moolenaar65a54642018-04-28 16:56:53 +02009676 int
Bram Moolenaar42205552017-03-18 19:42:22 +01009677assert_report(typval_T *argvars)
9678{
9679 garray_T ga;
9680
9681 prepare_assert_error(&ga);
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009682 ga_concat(&ga, tv_get_string(&argvars[0]));
Bram Moolenaar42205552017-03-18 19:42:22 +01009683 assert_error(&ga);
9684 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009685 return 1;
Bram Moolenaar42205552017-03-18 19:42:22 +01009686}
9687
Bram Moolenaar65a54642018-04-28 16:56:53 +02009688 int
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009689assert_exception(typval_T *argvars)
9690{
9691 garray_T ga;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009692 char_u *error = tv_get_string_chk(&argvars[0]);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009693
9694 if (vimvars[VV_EXCEPTION].vv_str == NULL)
9695 {
9696 prepare_assert_error(&ga);
9697 ga_concat(&ga, (char_u *)"v:exception is not set");
9698 assert_error(&ga);
9699 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009700 return 1;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009701 }
9702 else if (error != NULL
9703 && strstr((char *)vimvars[VV_EXCEPTION].vv_str, (char *)error) == NULL)
9704 {
9705 prepare_assert_error(&ga);
9706 fill_assert_error(&ga, &argvars[1], NULL, &argvars[0],
9707 &vimvars[VV_EXCEPTION].vv_tv, ASSERT_OTHER);
9708 assert_error(&ga);
9709 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009710 return 1;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009711 }
Bram Moolenaar65a54642018-04-28 16:56:53 +02009712 return 0;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009713}
9714
Bram Moolenaar65a54642018-04-28 16:56:53 +02009715 int
Bram Moolenaarb48e96f2018-02-13 12:26:14 +01009716assert_beeps(typval_T *argvars)
9717{
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009718 char_u *cmd = tv_get_string_chk(&argvars[0]);
Bram Moolenaarb48e96f2018-02-13 12:26:14 +01009719 garray_T ga;
Bram Moolenaar65a54642018-04-28 16:56:53 +02009720 int ret = 0;
Bram Moolenaarb48e96f2018-02-13 12:26:14 +01009721
9722 called_vim_beep = FALSE;
9723 suppress_errthrow = TRUE;
9724 emsg_silent = FALSE;
9725 do_cmdline_cmd(cmd);
9726 if (!called_vim_beep)
9727 {
9728 prepare_assert_error(&ga);
9729 ga_concat(&ga, (char_u *)"command did not beep: ");
9730 ga_concat(&ga, cmd);
9731 assert_error(&ga);
9732 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009733 ret = 1;
Bram Moolenaarb48e96f2018-02-13 12:26:14 +01009734 }
9735
9736 suppress_errthrow = FALSE;
9737 emsg_on_display = FALSE;
Bram Moolenaar65a54642018-04-28 16:56:53 +02009738 return ret;
Bram Moolenaarb48e96f2018-02-13 12:26:14 +01009739}
9740
Bram Moolenaar25190db2019-05-04 15:05:28 +02009741 static void
9742assert_append_cmd_or_arg(garray_T *gap, typval_T *argvars, char_u *cmd)
9743{
9744 char_u *tofree;
9745 char_u numbuf[NUMBUFLEN];
9746
9747 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
9748 {
9749 ga_concat(gap, echo_string(&argvars[2], &tofree, numbuf, 0));
9750 vim_free(tofree);
9751 }
9752 else
9753 ga_concat(gap, cmd);
9754}
9755
Bram Moolenaar65a54642018-04-28 16:56:53 +02009756 int
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009757assert_fails(typval_T *argvars)
9758{
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009759 char_u *cmd = tv_get_string_chk(&argvars[0]);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009760 garray_T ga;
Bram Moolenaar65a54642018-04-28 16:56:53 +02009761 int ret = 0;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009762
9763 called_emsg = FALSE;
9764 suppress_errthrow = TRUE;
9765 emsg_silent = TRUE;
9766 do_cmdline_cmd(cmd);
9767 if (!called_emsg)
9768 {
9769 prepare_assert_error(&ga);
9770 ga_concat(&ga, (char_u *)"command did not fail: ");
Bram Moolenaar25190db2019-05-04 15:05:28 +02009771 assert_append_cmd_or_arg(&ga, argvars, cmd);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009772 assert_error(&ga);
9773 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009774 ret = 1;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009775 }
9776 else if (argvars[1].v_type != VAR_UNKNOWN)
9777 {
9778 char_u buf[NUMBUFLEN];
Bram Moolenaard155d7a2018-12-21 16:04:21 +01009779 char *error = (char *)tv_get_string_buf_chk(&argvars[1], buf);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009780
9781 if (error == NULL
9782 || strstr((char *)vimvars[VV_ERRMSG].vv_str, error) == NULL)
9783 {
9784 prepare_assert_error(&ga);
9785 fill_assert_error(&ga, &argvars[2], NULL, &argvars[1],
9786 &vimvars[VV_ERRMSG].vv_tv, ASSERT_OTHER);
Bram Moolenaar25190db2019-05-04 15:05:28 +02009787 ga_concat(&ga, (char_u *)": ");
9788 assert_append_cmd_or_arg(&ga, argvars, cmd);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009789 assert_error(&ga);
9790 ga_clear(&ga);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009791 ret = 1;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009792 }
9793 }
9794
9795 called_emsg = FALSE;
9796 suppress_errthrow = FALSE;
9797 emsg_silent = FALSE;
9798 emsg_on_display = FALSE;
9799 set_vim_var_string(VV_ERRMSG, NULL, 0);
Bram Moolenaar65a54642018-04-28 16:56:53 +02009800 return ret;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009801}
9802
9803/*
Bram Moolenaar86576712019-01-25 20:48:33 +01009804 * Append "p[clen]" to "gap", escaping unprintable characters.
9805 * Changes NL to \n, CR to \r, etc.
9806 */
9807 static void
9808ga_concat_esc(garray_T *gap, char_u *p, int clen)
9809{
9810 char_u buf[NUMBUFLEN];
9811
9812 if (clen > 1)
9813 {
9814 mch_memmove(buf, p, clen);
9815 buf[clen] = NUL;
9816 ga_concat(gap, buf);
9817 }
9818 else switch (*p)
9819 {
9820 case BS: ga_concat(gap, (char_u *)"\\b"); break;
9821 case ESC: ga_concat(gap, (char_u *)"\\e"); break;
9822 case FF: ga_concat(gap, (char_u *)"\\f"); break;
9823 case NL: ga_concat(gap, (char_u *)"\\n"); break;
9824 case TAB: ga_concat(gap, (char_u *)"\\t"); break;
9825 case CAR: ga_concat(gap, (char_u *)"\\r"); break;
9826 case '\\': ga_concat(gap, (char_u *)"\\\\"); break;
9827 default:
9828 if (*p < ' ')
9829 {
9830 vim_snprintf((char *)buf, NUMBUFLEN, "\\x%02x", *p);
9831 ga_concat(gap, buf);
9832 }
9833 else
9834 ga_append(gap, *p);
9835 break;
9836 }
9837}
9838
9839/*
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009840 * Append "str" to "gap", escaping unprintable characters.
9841 * Changes NL to \n, CR to \r, etc.
9842 */
9843 static void
Bram Moolenaar86576712019-01-25 20:48:33 +01009844ga_concat_shorten_esc(garray_T *gap, char_u *str)
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009845{
9846 char_u *p;
Bram Moolenaar86576712019-01-25 20:48:33 +01009847 char_u *s;
9848 int c;
9849 int clen;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009850 char_u buf[NUMBUFLEN];
Bram Moolenaar86576712019-01-25 20:48:33 +01009851 int same_len;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009852
9853 if (str == NULL)
9854 {
9855 ga_concat(gap, (char_u *)"NULL");
9856 return;
9857 }
9858
9859 for (p = str; *p != NUL; ++p)
Bram Moolenaar86576712019-01-25 20:48:33 +01009860 {
9861 same_len = 1;
9862 s = p;
9863 c = mb_ptr2char_adv(&s);
9864 clen = s - p;
9865 while (*s != NUL && c == mb_ptr2char(s))
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009866 {
Bram Moolenaar86576712019-01-25 20:48:33 +01009867 ++same_len;
9868 s += clen;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009869 }
Bram Moolenaar86576712019-01-25 20:48:33 +01009870 if (same_len > 20)
9871 {
9872 ga_concat(gap, (char_u *)"\\[");
9873 ga_concat_esc(gap, p, clen);
9874 ga_concat(gap, (char_u *)" occurs ");
9875 vim_snprintf((char *)buf, NUMBUFLEN, "%d", same_len);
9876 ga_concat(gap, buf);
9877 ga_concat(gap, (char_u *)" times]");
9878 p = s - 1;
9879 }
9880 else
9881 ga_concat_esc(gap, p, clen);
9882 }
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009883}
9884
9885/*
9886 * Fill "gap" with information about an assert error.
9887 */
9888 void
9889fill_assert_error(
9890 garray_T *gap,
9891 typval_T *opt_msg_tv,
9892 char_u *exp_str,
9893 typval_T *exp_tv,
9894 typval_T *got_tv,
9895 assert_type_T atype)
9896{
9897 char_u numbuf[NUMBUFLEN];
9898 char_u *tofree;
9899
9900 if (opt_msg_tv->v_type != VAR_UNKNOWN)
9901 {
Bram Moolenaarc7b831c2017-01-28 18:08:12 +01009902 ga_concat(gap, echo_string(opt_msg_tv, &tofree, numbuf, 0));
9903 vim_free(tofree);
9904 ga_concat(gap, (char_u *)": ");
9905 }
9906
9907 if (atype == ASSERT_MATCH || atype == ASSERT_NOTMATCH)
9908 ga_concat(gap, (char_u *)"Pattern ");
9909 else if (atype == ASSERT_NOTEQUAL)
9910 ga_concat(gap, (char_u *)"Expected not equal to ");
9911 else
9912 ga_concat(gap, (char_u *)"Expected ");
9913 if (exp_str == NULL)
9914 {
Bram Moolenaar86576712019-01-25 20:48:33 +01009915 ga_concat_shorten_esc(gap, tv2string(exp_tv, &tofree, numbuf, 0));
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009916 vim_free(tofree);
9917 }
9918 else
Bram Moolenaar86576712019-01-25 20:48:33 +01009919 ga_concat_shorten_esc(gap, exp_str);
Bram Moolenaarc7b831c2017-01-28 18:08:12 +01009920 if (atype != ASSERT_NOTEQUAL)
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009921 {
Bram Moolenaarc7b831c2017-01-28 18:08:12 +01009922 if (atype == ASSERT_MATCH)
9923 ga_concat(gap, (char_u *)" does not match ");
9924 else if (atype == ASSERT_NOTMATCH)
9925 ga_concat(gap, (char_u *)" does match ");
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009926 else
Bram Moolenaarc7b831c2017-01-28 18:08:12 +01009927 ga_concat(gap, (char_u *)" but got ");
Bram Moolenaar86576712019-01-25 20:48:33 +01009928 ga_concat_shorten_esc(gap, tv2string(got_tv, &tofree, numbuf, 0));
Bram Moolenaarc7b831c2017-01-28 18:08:12 +01009929 vim_free(tofree);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +02009930 }
9931}
9932
Bram Moolenaar31988702018-02-13 12:57:42 +01009933/*
9934 * Compare "typ1" and "typ2". Put the result in "typ1".
9935 */
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01009936 int
9937typval_compare(
9938 typval_T *typ1, /* first operand */
9939 typval_T *typ2, /* second operand */
9940 exptype_T type, /* operator */
9941 int type_is, /* TRUE for "is" and "isnot" */
Bram Moolenaar31988702018-02-13 12:57:42 +01009942 int ic) /* ignore case */
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01009943{
9944 int i;
9945 varnumber_T n1, n2;
9946 char_u *s1, *s2;
9947 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
9948
Bram Moolenaar31988702018-02-13 12:57:42 +01009949 if (type_is && typ1->v_type != typ2->v_type)
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01009950 {
Bram Moolenaar31988702018-02-13 12:57:42 +01009951 /* For "is" a different type always means FALSE, for "notis"
9952 * it means TRUE. */
9953 n1 = (type == TYPE_NEQUAL);
9954 }
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01009955 else if (typ1->v_type == VAR_BLOB || typ2->v_type == VAR_BLOB)
9956 {
9957 if (type_is)
9958 {
9959 n1 = (typ1->v_type == typ2->v_type
9960 && typ1->vval.v_blob == typ2->vval.v_blob);
9961 if (type == TYPE_NEQUAL)
9962 n1 = !n1;
9963 }
9964 else if (typ1->v_type != typ2->v_type
9965 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
9966 {
9967 if (typ1->v_type != typ2->v_type)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01009968 emsg(_("E977: Can only compare Blob with Blob"));
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01009969 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01009970 emsg(_(e_invalblob));
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01009971 clear_tv(typ1);
9972 return FAIL;
9973 }
9974 else
9975 {
9976 // Compare two Blobs for being equal or unequal.
9977 n1 = blob_equal(typ1->vval.v_blob, typ2->vval.v_blob);
9978 if (type == TYPE_NEQUAL)
9979 n1 = !n1;
9980 }
9981 }
Bram Moolenaar31988702018-02-13 12:57:42 +01009982 else if (typ1->v_type == VAR_LIST || typ2->v_type == VAR_LIST)
9983 {
9984 if (type_is)
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01009985 {
Bram Moolenaar31988702018-02-13 12:57:42 +01009986 n1 = (typ1->v_type == typ2->v_type
9987 && typ1->vval.v_list == typ2->vval.v_list);
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01009988 if (type == TYPE_NEQUAL)
9989 n1 = !n1;
9990 }
Bram Moolenaar31988702018-02-13 12:57:42 +01009991 else if (typ1->v_type != typ2->v_type
9992 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01009993 {
Bram Moolenaar31988702018-02-13 12:57:42 +01009994 if (typ1->v_type != typ2->v_type)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01009995 emsg(_("E691: Can only compare List with List"));
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01009996 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01009997 emsg(_("E692: Invalid operation for List"));
Bram Moolenaar31988702018-02-13 12:57:42 +01009998 clear_tv(typ1);
9999 return FAIL;
Bram Moolenaarc6f9f732018-02-11 19:06:26 +010010000 }
10001 else
10002 {
Bram Moolenaar31988702018-02-13 12:57:42 +010010003 /* Compare two Lists for being equal or unequal. */
10004 n1 = list_equal(typ1->vval.v_list, typ2->vval.v_list,
10005 ic, FALSE);
10006 if (type == TYPE_NEQUAL)
10007 n1 = !n1;
Bram Moolenaarc6f9f732018-02-11 19:06:26 +010010008 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +010010009 }
Bram Moolenaar31988702018-02-13 12:57:42 +010010010
10011 else if (typ1->v_type == VAR_DICT || typ2->v_type == VAR_DICT)
10012 {
10013 if (type_is)
10014 {
10015 n1 = (typ1->v_type == typ2->v_type
10016 && typ1->vval.v_dict == typ2->vval.v_dict);
10017 if (type == TYPE_NEQUAL)
10018 n1 = !n1;
10019 }
10020 else if (typ1->v_type != typ2->v_type
10021 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
10022 {
10023 if (typ1->v_type != typ2->v_type)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +010010024 emsg(_("E735: Can only compare Dictionary with Dictionary"));
Bram Moolenaar31988702018-02-13 12:57:42 +010010025 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +010010026 emsg(_("E736: Invalid operation for Dictionary"));
Bram Moolenaar31988702018-02-13 12:57:42 +010010027 clear_tv(typ1);
10028 return FAIL;
10029 }
10030 else
10031 {
10032 /* Compare two Dictionaries for being equal or unequal. */
10033 n1 = dict_equal(typ1->vval.v_dict, typ2->vval.v_dict,
10034 ic, FALSE);
10035 if (type == TYPE_NEQUAL)
10036 n1 = !n1;
10037 }
10038 }
10039
10040 else if (typ1->v_type == VAR_FUNC || typ2->v_type == VAR_FUNC
10041 || typ1->v_type == VAR_PARTIAL || typ2->v_type == VAR_PARTIAL)
10042 {
10043 if (type != TYPE_EQUAL && type != TYPE_NEQUAL)
10044 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +010010045 emsg(_("E694: Invalid operation for Funcrefs"));
Bram Moolenaar31988702018-02-13 12:57:42 +010010046 clear_tv(typ1);
10047 return FAIL;
10048 }
10049 if ((typ1->v_type == VAR_PARTIAL
10050 && typ1->vval.v_partial == NULL)
10051 || (typ2->v_type == VAR_PARTIAL
10052 && typ2->vval.v_partial == NULL))
10053 /* when a partial is NULL assume not equal */
10054 n1 = FALSE;
10055 else if (type_is)
10056 {
10057 if (typ1->v_type == VAR_FUNC && typ2->v_type == VAR_FUNC)
10058 /* strings are considered the same if their value is
10059 * the same */
10060 n1 = tv_equal(typ1, typ2, ic, FALSE);
10061 else if (typ1->v_type == VAR_PARTIAL
10062 && typ2->v_type == VAR_PARTIAL)
10063 n1 = (typ1->vval.v_partial == typ2->vval.v_partial);
10064 else
10065 n1 = FALSE;
10066 }
10067 else
10068 n1 = tv_equal(typ1, typ2, ic, FALSE);
10069 if (type == TYPE_NEQUAL)
10070 n1 = !n1;
10071 }
10072
10073#ifdef FEAT_FLOAT
10074 /*
10075 * If one of the two variables is a float, compare as a float.
10076 * When using "=~" or "!~", always compare as string.
10077 */
10078 else if ((typ1->v_type == VAR_FLOAT || typ2->v_type == VAR_FLOAT)
10079 && type != TYPE_MATCH && type != TYPE_NOMATCH)
10080 {
10081 float_T f1, f2;
10082
Bram Moolenaar38f08e72019-02-20 22:04:32 +010010083 f1 = tv_get_float(typ1);
10084 f2 = tv_get_float(typ2);
Bram Moolenaar31988702018-02-13 12:57:42 +010010085 n1 = FALSE;
10086 switch (type)
10087 {
10088 case TYPE_EQUAL: n1 = (f1 == f2); break;
10089 case TYPE_NEQUAL: n1 = (f1 != f2); break;
10090 case TYPE_GREATER: n1 = (f1 > f2); break;
10091 case TYPE_GEQUAL: n1 = (f1 >= f2); break;
10092 case TYPE_SMALLER: n1 = (f1 < f2); break;
10093 case TYPE_SEQUAL: n1 = (f1 <= f2); break;
10094 case TYPE_UNKNOWN:
10095 case TYPE_MATCH:
10096 case TYPE_NOMATCH: break; /* avoid gcc warning */
10097 }
10098 }
10099#endif
10100
10101 /*
10102 * If one of the two variables is a number, compare as a number.
10103 * When using "=~" or "!~", always compare as string.
10104 */
10105 else if ((typ1->v_type == VAR_NUMBER || typ2->v_type == VAR_NUMBER)
10106 && type != TYPE_MATCH && type != TYPE_NOMATCH)
10107 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +010010108 n1 = tv_get_number(typ1);
10109 n2 = tv_get_number(typ2);
Bram Moolenaar31988702018-02-13 12:57:42 +010010110 switch (type)
10111 {
10112 case TYPE_EQUAL: n1 = (n1 == n2); break;
10113 case TYPE_NEQUAL: n1 = (n1 != n2); break;
10114 case TYPE_GREATER: n1 = (n1 > n2); break;
10115 case TYPE_GEQUAL: n1 = (n1 >= n2); break;
10116 case TYPE_SMALLER: n1 = (n1 < n2); break;
10117 case TYPE_SEQUAL: n1 = (n1 <= n2); break;
10118 case TYPE_UNKNOWN:
10119 case TYPE_MATCH:
10120 case TYPE_NOMATCH: break; /* avoid gcc warning */
10121 }
10122 }
10123 else
10124 {
Bram Moolenaard155d7a2018-12-21 16:04:21 +010010125 s1 = tv_get_string_buf(typ1, buf1);
10126 s2 = tv_get_string_buf(typ2, buf2);
Bram Moolenaar31988702018-02-13 12:57:42 +010010127 if (type != TYPE_MATCH && type != TYPE_NOMATCH)
10128 i = ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2);
10129 else
10130 i = 0;
10131 n1 = FALSE;
10132 switch (type)
10133 {
10134 case TYPE_EQUAL: n1 = (i == 0); break;
10135 case TYPE_NEQUAL: n1 = (i != 0); break;
10136 case TYPE_GREATER: n1 = (i > 0); break;
10137 case TYPE_GEQUAL: n1 = (i >= 0); break;
10138 case TYPE_SMALLER: n1 = (i < 0); break;
10139 case TYPE_SEQUAL: n1 = (i <= 0); break;
10140
10141 case TYPE_MATCH:
10142 case TYPE_NOMATCH:
10143 n1 = pattern_match(s2, s1, ic);
10144 if (type == TYPE_NOMATCH)
10145 n1 = !n1;
10146 break;
10147
10148 case TYPE_UNKNOWN: break; /* avoid gcc warning */
10149 }
10150 }
10151 clear_tv(typ1);
10152 typ1->v_type = VAR_NUMBER;
10153 typ1->vval.v_number = n1;
10154
Bram Moolenaarc6f9f732018-02-11 19:06:26 +010010155 return OK;
10156}
10157
Bram Moolenaarc6f9f732018-02-11 19:06:26 +010010158 char_u *
Bram Moolenaar6f8d2ac2018-07-25 19:49:45 +020010159typval_tostring(typval_T *arg)
Bram Moolenaarc6f9f732018-02-11 19:06:26 +010010160{
10161 char_u *tofree;
10162 char_u numbuf[NUMBUFLEN];
10163 char_u *ret = NULL;
10164
10165 if (arg == NULL)
10166 return vim_strsave((char_u *)"(does not exist)");
10167 ret = tv2string(arg, &tofree, numbuf, 0);
10168 /* Make a copy if we have a value but it's not in allocated memory. */
10169 if (ret != NULL && tofree == NULL)
10170 ret = vim_strsave(ret);
10171 return ret;
10172}
10173
10174 int
10175var_exists(char_u *var)
10176{
10177 char_u *name;
10178 char_u *tofree;
10179 typval_T tv;
10180 int len = 0;
10181 int n = FALSE;
10182
10183 /* get_name_len() takes care of expanding curly braces */
10184 name = var;
10185 len = get_name_len(&var, &tofree, TRUE, FALSE);
10186 if (len > 0)
10187 {
10188 if (tofree != NULL)
10189 name = tofree;
10190 n = (get_var_tv(name, len, &tv, NULL, FALSE, TRUE) == OK);
10191 if (n)
10192 {
10193 /* handle d.key, l[idx], f(expr) */
10194 n = (handle_subscript(&var, &tv, TRUE, FALSE) == OK);
10195 if (n)
10196 clear_tv(&tv);
10197 }
10198 }
10199 if (*var != NUL)
10200 n = FALSE;
10201
10202 vim_free(tofree);
10203 return n;
10204}
10205
Bram Moolenaar071d4272004-06-13 20:20:40 +000010206#endif /* FEAT_EVAL */
10207
Bram Moolenaar071d4272004-06-13 20:20:40 +000010208
Bram Moolenaar8c8de832008-06-24 22:58:06 +000010209#if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010210
Bram Moolenaar4f974752019-02-17 17:44:42 +010010211#ifdef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +000010212/*
10213 * Functions for ":8" filename modifier: get 8.3 version of a filename.
10214 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000010215
10216/*
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010217 * Get the short path (8.3) for the filename in "fnamep".
10218 * Only works for a valid file name.
10219 * When the path gets longer "fnamep" is changed and the allocated buffer
10220 * is put in "bufp".
10221 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
10222 * Returns OK on success, FAIL on failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010223 */
10224 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +010010225get_short_pathname(char_u **fnamep, char_u **bufp, int *fnamelen)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010226{
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010227 int l, len;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010228 char_u *newbuf;
10229
10230 len = *fnamelen;
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +010010231 l = GetShortPathName((LPSTR)*fnamep, (LPSTR)*fnamep, len);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010232 if (l > len - 1)
10233 {
10234 /* If that doesn't work (not enough space), then save the string
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010235 * and try again with a new buffer big enough. */
Bram Moolenaar071d4272004-06-13 20:20:40 +000010236 newbuf = vim_strnsave(*fnamep, l);
10237 if (newbuf == NULL)
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010238 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010239
10240 vim_free(*bufp);
10241 *fnamep = *bufp = newbuf;
10242
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010243 /* Really should always succeed, as the buffer is big enough. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +010010244 l = GetShortPathName((LPSTR)*fnamep, (LPSTR)*fnamep, l+1);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010245 }
10246
10247 *fnamelen = l;
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010248 return OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010249}
10250
10251/*
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010252 * Get the short path (8.3) for the filename in "fname". The converted
10253 * path is returned in "bufp".
10254 *
10255 * Some of the directories specified in "fname" may not exist. This function
10256 * will shorten the existing directories at the beginning of the path and then
10257 * append the remaining non-existing path.
10258 *
10259 * fname - Pointer to the filename to shorten. On return, contains the
Bram Moolenaar2c704a72010-06-03 21:17:25 +020010260 * pointer to the shortened pathname
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010261 * bufp - Pointer to an allocated buffer for the filename.
10262 * fnamelen - Length of the filename pointed to by fname
10263 *
10264 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
Bram Moolenaar071d4272004-06-13 20:20:40 +000010265 */
10266 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +010010267shortpath_for_invalid_fname(
10268 char_u **fname,
10269 char_u **bufp,
10270 int *fnamelen)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010271{
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010272 char_u *short_fname, *save_fname, *pbuf_unused;
10273 char_u *endp, *save_endp;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010274 char_u ch;
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010275 int old_len, len;
10276 int new_len, sfx_len;
10277 int retval = OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010278
10279 /* Make a copy */
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010280 old_len = *fnamelen;
10281 save_fname = vim_strnsave(*fname, old_len);
10282 pbuf_unused = NULL;
10283 short_fname = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010284
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010285 endp = save_fname + old_len - 1; /* Find the end of the copy */
10286 save_endp = endp;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010287
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010288 /*
10289 * Try shortening the supplied path till it succeeds by removing one
10290 * directory at a time from the tail of the path.
10291 */
10292 len = 0;
10293 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010294 {
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010295 /* go back one path-separator */
10296 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
10297 --endp;
10298 if (endp <= save_fname)
10299 break; /* processed the complete path */
10300
10301 /*
10302 * Replace the path separator with a NUL and try to shorten the
10303 * resulting path.
10304 */
10305 ch = *endp;
10306 *endp = 0;
10307 short_fname = save_fname;
Bram Moolenaarc236c162008-07-13 17:41:49 +000010308 len = (int)STRLEN(short_fname) + 1;
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010309 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
10310 {
10311 retval = FAIL;
10312 goto theend;
10313 }
10314 *endp = ch; /* preserve the string */
10315
10316 if (len > 0)
10317 break; /* successfully shortened the path */
10318
10319 /* failed to shorten the path. Skip the path separator */
10320 --endp;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010321 }
10322
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010323 if (len > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010324 {
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010325 /*
10326 * Succeeded in shortening the path. Now concatenate the shortened
10327 * path with the remaining path at the tail.
10328 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000010329
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010330 /* Compute the length of the new path. */
10331 sfx_len = (int)(save_endp - endp) + 1;
10332 new_len = len + sfx_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010333
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010334 *fnamelen = new_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010335 vim_free(*bufp);
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010336 if (new_len > old_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010337 {
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010338 /* There is not enough space in the currently allocated string,
10339 * copy it to a buffer big enough. */
10340 *fname = *bufp = vim_strnsave(short_fname, new_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010341 if (*fname == NULL)
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010342 {
10343 retval = FAIL;
10344 goto theend;
10345 }
Bram Moolenaar071d4272004-06-13 20:20:40 +000010346 }
10347 else
10348 {
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010349 /* Transfer short_fname to the main buffer (it's big enough),
10350 * unless get_short_pathname() did its work in-place. */
10351 *fname = *bufp = save_fname;
10352 if (short_fname != save_fname)
10353 vim_strncpy(save_fname, short_fname, len);
10354 save_fname = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010355 }
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010356
10357 /* concat the not-shortened part of the path */
10358 vim_strncpy(*fname + len, endp, sfx_len);
10359 (*fname)[new_len] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010360 }
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010361
10362theend:
10363 vim_free(pbuf_unused);
10364 vim_free(save_fname);
10365
10366 return retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010367}
10368
10369/*
10370 * Get a pathname for a partial path.
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010371 * Returns OK for success, FAIL for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010372 */
10373 static int
Bram Moolenaar7454a062016-01-30 15:14:10 +010010374shortpath_for_partial(
10375 char_u **fnamep,
10376 char_u **bufp,
10377 int *fnamelen)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010378{
10379 int sepcount, len, tflen;
10380 char_u *p;
10381 char_u *pbuf, *tfname;
10382 int hasTilde;
10383
Bram Moolenaar8c8de832008-06-24 22:58:06 +000010384 /* Count up the path separators from the RHS.. so we know which part
10385 * of the path to return. */
Bram Moolenaar071d4272004-06-13 20:20:40 +000010386 sepcount = 0;
Bram Moolenaar91acfff2017-03-12 19:22:36 +010010387 for (p = *fnamep; p < *fnamep + *fnamelen; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +000010388 if (vim_ispathsep(*p))
10389 ++sepcount;
10390
10391 /* Need full path first (use expand_env() to remove a "~/") */
10392 hasTilde = (**fnamep == '~');
10393 if (hasTilde)
10394 pbuf = tfname = expand_env_save(*fnamep);
10395 else
10396 pbuf = tfname = FullName_save(*fnamep, FALSE);
10397
Bram Moolenaara93fa7e2006-04-17 22:14:47 +000010398 len = tflen = (int)STRLEN(tfname);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010399
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010400 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
10401 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010402
10403 if (len == 0)
10404 {
10405 /* Don't have a valid filename, so shorten the rest of the
10406 * path if we can. This CAN give us invalid 8.3 filenames, but
10407 * there's not a lot of point in guessing what it might be.
10408 */
10409 len = tflen;
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010410 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
10411 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010412 }
10413
10414 /* Count the paths backward to find the beginning of the desired string. */
10415 for (p = tfname + len - 1; p >= tfname; --p)
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000010416 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000010417 if (has_mbyte)
10418 p -= mb_head_off(tfname, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010419 if (vim_ispathsep(*p))
10420 {
10421 if (sepcount == 0 || (hasTilde && sepcount == 1))
10422 break;
10423 else
10424 sepcount --;
10425 }
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000010426 }
Bram Moolenaar071d4272004-06-13 20:20:40 +000010427 if (hasTilde)
10428 {
10429 --p;
10430 if (p >= tfname)
10431 *p = '~';
10432 else
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010433 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010434 }
10435 else
10436 ++p;
10437
10438 /* Copy in the string - p indexes into tfname - allocated at pbuf */
10439 vim_free(*bufp);
10440 *fnamelen = (int)STRLEN(p);
10441 *bufp = pbuf;
10442 *fnamep = p;
10443
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010444 return OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010445}
Bram Moolenaar4f974752019-02-17 17:44:42 +010010446#endif // MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +000010447
10448/*
10449 * Adjust a filename, according to a string of modifiers.
10450 * *fnamep must be NUL terminated when called. When returning, the length is
10451 * determined by *fnamelen.
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010452 * Returns VALID_ flags or -1 for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010453 * When there is an error, *fnamep is set to NULL.
10454 */
10455 int
Bram Moolenaar7454a062016-01-30 15:14:10 +010010456modify_fname(
Bram Moolenaar00136dc2018-07-25 21:19:13 +020010457 char_u *src, // string with modifiers
10458 int tilde_file, // "~" is a file name, not $HOME
10459 int *usedlen, // characters after src that are used
10460 char_u **fnamep, // file name so far
10461 char_u **bufp, // buffer for allocated file name or NULL
10462 int *fnamelen) // length of fnamep
Bram Moolenaar071d4272004-06-13 20:20:40 +000010463{
10464 int valid = 0;
10465 char_u *tail;
10466 char_u *s, *p, *pbuf;
10467 char_u dirname[MAXPATHL];
10468 int c;
10469 int has_fullname = 0;
Bram Moolenaar4f974752019-02-17 17:44:42 +010010470#ifdef MSWIN
Bram Moolenaardc935552011-08-17 15:23:23 +020010471 char_u *fname_start = *fnamep;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010472 int has_shortname = 0;
10473#endif
10474
10475repeat:
10476 /* ":p" - full path/file_name */
10477 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
10478 {
10479 has_fullname = 1;
10480
10481 valid |= VALID_PATH;
10482 *usedlen += 2;
10483
10484 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
10485 if ((*fnamep)[0] == '~'
10486#if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
10487 && ((*fnamep)[1] == '/'
10488# ifdef BACKSLASH_IN_FILENAME
10489 || (*fnamep)[1] == '\\'
10490# endif
10491 || (*fnamep)[1] == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010492#endif
Bram Moolenaar00136dc2018-07-25 21:19:13 +020010493 && !(tilde_file && (*fnamep)[1] == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010494 )
10495 {
10496 *fnamep = expand_env_save(*fnamep);
10497 vim_free(*bufp); /* free any allocated file name */
10498 *bufp = *fnamep;
10499 if (*fnamep == NULL)
10500 return -1;
10501 }
10502
10503 /* When "/." or "/.." is used: force expansion to get rid of it. */
Bram Moolenaar91acfff2017-03-12 19:22:36 +010010504 for (p = *fnamep; *p != NUL; MB_PTR_ADV(p))
Bram Moolenaar071d4272004-06-13 20:20:40 +000010505 {
10506 if (vim_ispathsep(*p)
10507 && p[1] == '.'
10508 && (p[2] == NUL
10509 || vim_ispathsep(p[2])
10510 || (p[2] == '.'
10511 && (p[3] == NUL || vim_ispathsep(p[3])))))
10512 break;
10513 }
10514
10515 /* FullName_save() is slow, don't use it when not needed. */
10516 if (*p != NUL || !vim_isAbsName(*fnamep))
10517 {
10518 *fnamep = FullName_save(*fnamep, *p != NUL);
10519 vim_free(*bufp); /* free any allocated file name */
10520 *bufp = *fnamep;
10521 if (*fnamep == NULL)
10522 return -1;
10523 }
10524
Bram Moolenaar4f974752019-02-17 17:44:42 +010010525#ifdef MSWIN
Bram Moolenaar9158f9e2012-06-20 14:02:27 +020010526# if _WIN32_WINNT >= 0x0500
10527 if (vim_strchr(*fnamep, '~') != NULL)
10528 {
Bram Moolenaar2d04a912019-03-30 20:04:08 +010010529 // Expand 8.3 filename to full path. Needed to make sure the same
10530 // file does not have two different names.
10531 // Note: problem does not occur if _WIN32_WINNT < 0x0500.
10532 WCHAR *wfname = enc_to_utf16(*fnamep, NULL);
10533 WCHAR buf[_MAX_PATH];
10534
10535 if (wfname != NULL)
Bram Moolenaar9158f9e2012-06-20 14:02:27 +020010536 {
Bram Moolenaar2d04a912019-03-30 20:04:08 +010010537 if (GetLongPathNameW(wfname, buf, _MAX_PATH))
Bram Moolenaar9158f9e2012-06-20 14:02:27 +020010538 {
Bram Moolenaar2d04a912019-03-30 20:04:08 +010010539 char_u *p = utf16_to_enc(buf, NULL);
10540
10541 if (p != NULL)
10542 {
10543 vim_free(*bufp); // free any allocated file name
10544 *bufp = *fnamep = p;
10545 }
Bram Moolenaar9158f9e2012-06-20 14:02:27 +020010546 }
Bram Moolenaar2d04a912019-03-30 20:04:08 +010010547 vim_free(wfname);
Bram Moolenaar9158f9e2012-06-20 14:02:27 +020010548 }
10549 }
10550# endif
10551#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000010552 /* Append a path separator to a directory. */
10553 if (mch_isdir(*fnamep))
10554 {
10555 /* Make room for one or two extra characters. */
10556 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
10557 vim_free(*bufp); /* free any allocated file name */
10558 *bufp = *fnamep;
10559 if (*fnamep == NULL)
10560 return -1;
10561 add_pathsep(*fnamep);
10562 }
10563 }
10564
10565 /* ":." - path relative to the current directory */
10566 /* ":~" - path relative to the home directory */
10567 /* ":8" - shortname path - postponed till after */
10568 while (src[*usedlen] == ':'
10569 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
10570 {
10571 *usedlen += 2;
10572 if (c == '8')
10573 {
Bram Moolenaar4f974752019-02-17 17:44:42 +010010574#ifdef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +000010575 has_shortname = 1; /* Postpone this. */
10576#endif
10577 continue;
10578 }
10579 pbuf = NULL;
10580 /* Need full path first (use expand_env() to remove a "~/") */
10581 if (!has_fullname)
10582 {
10583 if (c == '.' && **fnamep == '~')
10584 p = pbuf = expand_env_save(*fnamep);
10585 else
10586 p = pbuf = FullName_save(*fnamep, FALSE);
10587 }
10588 else
10589 p = *fnamep;
10590
10591 has_fullname = 0;
10592
10593 if (p != NULL)
10594 {
10595 if (c == '.')
10596 {
10597 mch_dirname(dirname, MAXPATHL);
10598 s = shorten_fname(p, dirname);
10599 if (s != NULL)
10600 {
10601 *fnamep = s;
10602 if (pbuf != NULL)
10603 {
10604 vim_free(*bufp); /* free any allocated file name */
10605 *bufp = pbuf;
10606 pbuf = NULL;
10607 }
10608 }
10609 }
10610 else
10611 {
10612 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
10613 /* Only replace it when it starts with '~' */
10614 if (*dirname == '~')
10615 {
10616 s = vim_strsave(dirname);
10617 if (s != NULL)
10618 {
10619 *fnamep = s;
10620 vim_free(*bufp);
10621 *bufp = s;
10622 }
10623 }
10624 }
10625 vim_free(pbuf);
10626 }
10627 }
10628
10629 tail = gettail(*fnamep);
10630 *fnamelen = (int)STRLEN(*fnamep);
10631
10632 /* ":h" - head, remove "/file_name", can be repeated */
10633 /* Don't remove the first "/" or "c:\" */
10634 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
10635 {
10636 valid |= VALID_HEAD;
10637 *usedlen += 2;
10638 s = get_past_head(*fnamep);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +000010639 while (tail > s && after_pathsep(s, tail))
Bram Moolenaar91acfff2017-03-12 19:22:36 +010010640 MB_PTR_BACK(*fnamep, tail);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010641 *fnamelen = (int)(tail - *fnamep);
10642#ifdef VMS
10643 if (*fnamelen > 0)
10644 *fnamelen += 1; /* the path separator is part of the path */
10645#endif
Bram Moolenaar5461cfe2007-09-25 18:40:14 +000010646 if (*fnamelen == 0)
10647 {
10648 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
10649 p = vim_strsave((char_u *)".");
10650 if (p == NULL)
10651 return -1;
10652 vim_free(*bufp);
10653 *bufp = *fnamep = tail = p;
10654 *fnamelen = 1;
10655 }
10656 else
10657 {
10658 while (tail > s && !after_pathsep(s, tail))
Bram Moolenaar91acfff2017-03-12 19:22:36 +010010659 MB_PTR_BACK(*fnamep, tail);
Bram Moolenaar5461cfe2007-09-25 18:40:14 +000010660 }
Bram Moolenaar071d4272004-06-13 20:20:40 +000010661 }
10662
10663 /* ":8" - shortname */
10664 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
10665 {
10666 *usedlen += 2;
Bram Moolenaar4f974752019-02-17 17:44:42 +010010667#ifdef MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +000010668 has_shortname = 1;
10669#endif
10670 }
10671
Bram Moolenaar4f974752019-02-17 17:44:42 +010010672#ifdef MSWIN
Bram Moolenaardc935552011-08-17 15:23:23 +020010673 /*
10674 * Handle ":8" after we have done 'heads' and before we do 'tails'.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010675 */
10676 if (has_shortname)
10677 {
Bram Moolenaardc935552011-08-17 15:23:23 +020010678 /* Copy the string if it is shortened by :h and when it wasn't copied
10679 * yet, because we are going to change it in place. Avoids changing
10680 * the buffer name for "%:8". */
10681 if (*fnamelen < (int)STRLEN(*fnamep) || *fnamep == fname_start)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010682 {
10683 p = vim_strnsave(*fnamep, *fnamelen);
Bram Moolenaardc935552011-08-17 15:23:23 +020010684 if (p == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010685 return -1;
10686 vim_free(*bufp);
10687 *bufp = *fnamep = p;
10688 }
10689
10690 /* Split into two implementations - makes it easier. First is where
Bram Moolenaardc935552011-08-17 15:23:23 +020010691 * there isn't a full name already, second is where there is. */
Bram Moolenaar071d4272004-06-13 20:20:40 +000010692 if (!has_fullname && !vim_isAbsName(*fnamep))
10693 {
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010694 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010695 return -1;
10696 }
10697 else
10698 {
Bram Moolenaardc935552011-08-17 15:23:23 +020010699 int l = *fnamelen;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010700
Bram Moolenaardc935552011-08-17 15:23:23 +020010701 /* Simple case, already have the full-name.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010702 * Nearly always shorter, so try first time. */
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010703 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010704 return -1;
10705
10706 if (l == 0)
10707 {
Bram Moolenaardc935552011-08-17 15:23:23 +020010708 /* Couldn't find the filename, search the paths. */
Bram Moolenaar071d4272004-06-13 20:20:40 +000010709 l = *fnamelen;
Bram Moolenaarbcebfb62008-05-29 19:47:13 +000010710 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010711 return -1;
10712 }
10713 *fnamelen = l;
10714 }
10715 }
Bram Moolenaar4f974752019-02-17 17:44:42 +010010716#endif // MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +000010717
10718 /* ":t" - tail, just the basename */
10719 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
10720 {
10721 *usedlen += 2;
10722 *fnamelen -= (int)(tail - *fnamep);
10723 *fnamep = tail;
10724 }
10725
10726 /* ":e" - extension, can be repeated */
10727 /* ":r" - root, without extension, can be repeated */
10728 while (src[*usedlen] == ':'
10729 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
10730 {
10731 /* find a '.' in the tail:
10732 * - for second :e: before the current fname
10733 * - otherwise: The last '.'
10734 */
10735 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
10736 s = *fnamep - 2;
10737 else
10738 s = *fnamep + *fnamelen - 1;
10739 for ( ; s > tail; --s)
10740 if (s[0] == '.')
10741 break;
10742 if (src[*usedlen + 1] == 'e') /* :e */
10743 {
10744 if (s > tail)
10745 {
10746 *fnamelen += (int)(*fnamep - (s + 1));
10747 *fnamep = s + 1;
10748#ifdef VMS
10749 /* cut version from the extension */
10750 s = *fnamep + *fnamelen - 1;
10751 for ( ; s > *fnamep; --s)
10752 if (s[0] == ';')
10753 break;
10754 if (s > *fnamep)
10755 *fnamelen = s - *fnamep;
10756#endif
10757 }
10758 else if (*fnamep <= tail)
10759 *fnamelen = 0;
10760 }
10761 else /* :r */
10762 {
10763 if (s > tail) /* remove one extension */
10764 *fnamelen = (int)(s - *fnamep);
10765 }
10766 *usedlen += 2;
10767 }
10768
10769 /* ":s?pat?foo?" - substitute */
10770 /* ":gs?pat?foo?" - global substitute */
10771 if (src[*usedlen] == ':'
10772 && (src[*usedlen + 1] == 's'
10773 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
10774 {
10775 char_u *str;
10776 char_u *pat;
10777 char_u *sub;
10778 int sep;
10779 char_u *flags;
10780 int didit = FALSE;
10781
10782 flags = (char_u *)"";
10783 s = src + *usedlen + 2;
10784 if (src[*usedlen + 1] == 'g')
10785 {
10786 flags = (char_u *)"g";
10787 ++s;
10788 }
10789
10790 sep = *s++;
10791 if (sep)
10792 {
10793 /* find end of pattern */
10794 p = vim_strchr(s, sep);
10795 if (p != NULL)
10796 {
10797 pat = vim_strnsave(s, (int)(p - s));
10798 if (pat != NULL)
10799 {
10800 s = p + 1;
10801 /* find end of substitution */
10802 p = vim_strchr(s, sep);
10803 if (p != NULL)
10804 {
10805 sub = vim_strnsave(s, (int)(p - s));
10806 str = vim_strnsave(*fnamep, *fnamelen);
10807 if (sub != NULL && str != NULL)
10808 {
10809 *usedlen = (int)(p + 1 - src);
Bram Moolenaar72ab7292016-07-19 19:10:51 +020010810 s = do_string_sub(str, pat, sub, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010811 if (s != NULL)
10812 {
10813 *fnamep = s;
10814 *fnamelen = (int)STRLEN(s);
10815 vim_free(*bufp);
10816 *bufp = s;
10817 didit = TRUE;
10818 }
10819 }
10820 vim_free(sub);
10821 vim_free(str);
10822 }
10823 vim_free(pat);
10824 }
10825 }
10826 /* after using ":s", repeat all the modifiers */
10827 if (didit)
10828 goto repeat;
10829 }
10830 }
10831
Bram Moolenaar26df0922014-02-23 23:39:13 +010010832 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'S')
10833 {
Bram Moolenaar5ca84ce2016-03-23 22:28:25 +010010834 /* vim_strsave_shellescape() needs a NUL terminated string. */
Bram Moolenaard4caf5c2016-03-24 19:14:35 +010010835 c = (*fnamep)[*fnamelen];
Bram Moolenaar52c6eaf2016-03-25 18:42:46 +010010836 if (c != NUL)
10837 (*fnamep)[*fnamelen] = NUL;
Bram Moolenaar26df0922014-02-23 23:39:13 +010010838 p = vim_strsave_shellescape(*fnamep, FALSE, FALSE);
Bram Moolenaar52c6eaf2016-03-25 18:42:46 +010010839 if (c != NUL)
10840 (*fnamep)[*fnamelen] = c;
Bram Moolenaar26df0922014-02-23 23:39:13 +010010841 if (p == NULL)
10842 return -1;
10843 vim_free(*bufp);
10844 *bufp = *fnamep = p;
10845 *fnamelen = (int)STRLEN(p);
10846 *usedlen += 2;
10847 }
10848
Bram Moolenaar071d4272004-06-13 20:20:40 +000010849 return valid;
10850}
10851
10852/*
10853 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
Bram Moolenaar72ab7292016-07-19 19:10:51 +020010854 * When "sub" is NULL "expr" is used, must be a VAR_FUNC or VAR_PARTIAL.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010855 * "flags" can be "g" to do a global substitute.
10856 * Returns an allocated string, NULL for error.
10857 */
10858 char_u *
Bram Moolenaar7454a062016-01-30 15:14:10 +010010859do_string_sub(
10860 char_u *str,
10861 char_u *pat,
10862 char_u *sub,
Bram Moolenaar72ab7292016-07-19 19:10:51 +020010863 typval_T *expr,
Bram Moolenaar7454a062016-01-30 15:14:10 +010010864 char_u *flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010865{
10866 int sublen;
10867 regmatch_T regmatch;
10868 int i;
10869 int do_all;
10870 char_u *tail;
Bram Moolenaare90c8532014-11-05 16:03:44 +010010871 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010872 garray_T ga;
10873 char_u *ret;
10874 char_u *save_cpo;
Bram Moolenaar8af26912014-01-23 20:09:34 +010010875 char_u *zero_width = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010876
10877 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
10878 save_cpo = p_cpo;
Bram Moolenaar9c24ccc2008-07-14 21:05:15 +000010879 p_cpo = empty_option;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010880
10881 ga_init2(&ga, 1, 200);
10882
10883 do_all = (flags[0] == 'g');
10884
10885 regmatch.rm_ic = p_ic;
10886 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
10887 if (regmatch.regprog != NULL)
10888 {
10889 tail = str;
Bram Moolenaare90c8532014-11-05 16:03:44 +010010890 end = str + STRLEN(str);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010891 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
10892 {
Bram Moolenaar8af26912014-01-23 20:09:34 +010010893 /* Skip empty match except for first match. */
10894 if (regmatch.startp[0] == regmatch.endp[0])
10895 {
10896 if (zero_width == regmatch.startp[0])
10897 {
10898 /* avoid getting stuck on a match with an empty string */
Bram Moolenaar8e7048c2014-06-12 18:39:22 +020010899 i = MB_PTR2LEN(tail);
10900 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail,
10901 (size_t)i);
10902 ga.ga_len += i;
10903 tail += i;
Bram Moolenaar8af26912014-01-23 20:09:34 +010010904 continue;
10905 }
10906 zero_width = regmatch.startp[0];
10907 }
10908
Bram Moolenaar071d4272004-06-13 20:20:40 +000010909 /*
10910 * Get some space for a temporary buffer to do the substitution
10911 * into. It will contain:
10912 * - The text up to where the match is.
10913 * - The substituted text.
10914 * - The text after the match.
10915 */
Bram Moolenaar72ab7292016-07-19 19:10:51 +020010916 sublen = vim_regsub(&regmatch, sub, expr, tail, FALSE, TRUE, FALSE);
Bram Moolenaare90c8532014-11-05 16:03:44 +010010917 if (ga_grow(&ga, (int)((end - tail) + sublen -
Bram Moolenaar071d4272004-06-13 20:20:40 +000010918 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
10919 {
10920 ga_clear(&ga);
10921 break;
10922 }
10923
10924 /* copy the text up to where the match is */
10925 i = (int)(regmatch.startp[0] - tail);
10926 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
10927 /* add the substituted text */
Bram Moolenaar72ab7292016-07-19 19:10:51 +020010928 (void)vim_regsub(&regmatch, sub, expr, (char_u *)ga.ga_data
Bram Moolenaar071d4272004-06-13 20:20:40 +000010929 + ga.ga_len + i, TRUE, TRUE, FALSE);
10930 ga.ga_len += i + sublen - 1;
Bram Moolenaarceb84af2013-09-29 21:11:05 +020010931 tail = regmatch.endp[0];
10932 if (*tail == NUL)
10933 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +000010934 if (!do_all)
10935 break;
10936 }
10937
10938 if (ga.ga_data != NULL)
10939 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
10940
Bram Moolenaar473de612013-06-08 18:19:48 +020010941 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010942 }
10943
10944 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
10945 ga_clear(&ga);
Bram Moolenaar9c24ccc2008-07-14 21:05:15 +000010946 if (p_cpo == empty_option)
10947 p_cpo = save_cpo;
10948 else
Bram Moolenaar72ab7292016-07-19 19:10:51 +020010949 /* Darn, evaluating {sub} expression or {expr} changed the value. */
Bram Moolenaar9c24ccc2008-07-14 21:05:15 +000010950 free_string_option(save_cpo);
Bram Moolenaar071d4272004-06-13 20:20:40 +000010951
10952 return ret;
10953}
10954
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020010955 static int
10956filter_map_one(typval_T *tv, typval_T *expr, int map, int *remp)
10957{
10958 typval_T rettv;
10959 typval_T argv[3];
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020010960 int retval = FAIL;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020010961
10962 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
10963 argv[0] = vimvars[VV_KEY].vv_tv;
10964 argv[1] = vimvars[VV_VAL].vv_tv;
Bram Moolenaar48570482017-10-30 21:48:41 +010010965 if (eval_expr_typval(expr, argv, 2, &rettv) == FAIL)
10966 goto theend;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020010967 if (map)
10968 {
10969 /* map(): replace the list item value */
10970 clear_tv(tv);
10971 rettv.v_lock = 0;
10972 *tv = rettv;
10973 }
10974 else
10975 {
10976 int error = FALSE;
10977
10978 /* filter(): when expr is zero remove the item */
Bram Moolenaard155d7a2018-12-21 16:04:21 +010010979 *remp = (tv_get_number_chk(&rettv, &error) == 0);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020010980 clear_tv(&rettv);
10981 /* On type error, nothing has been removed; return FAIL to stop the
Bram Moolenaard155d7a2018-12-21 16:04:21 +010010982 * loop. The error message was given by tv_get_number_chk(). */
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020010983 if (error)
10984 goto theend;
10985 }
10986 retval = OK;
10987theend:
10988 clear_tv(&vimvars[VV_VAL].vv_tv);
10989 return retval;
10990}
10991
10992
10993/*
10994 * Implementation of map() and filter().
10995 */
10996 void
10997filter_map(typval_T *argvars, typval_T *rettv, int map)
10998{
10999 typval_T *expr;
11000 listitem_T *li, *nli;
11001 list_T *l = NULL;
11002 dictitem_T *di;
11003 hashtab_T *ht;
11004 hashitem_T *hi;
11005 dict_T *d = NULL;
11006 typval_T save_val;
11007 typval_T save_key;
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +010011008 blob_T *b = NULL;
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020011009 int rem;
11010 int todo;
11011 char_u *ermsg = (char_u *)(map ? "map()" : "filter()");
11012 char_u *arg_errmsg = (char_u *)(map ? N_("map() argument")
11013 : N_("filter() argument"));
11014 int save_did_emsg;
11015 int idx = 0;
11016
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +010011017 if (argvars[0].v_type == VAR_BLOB)
11018 {
11019 if ((b = argvars[0].vval.v_blob) == NULL)
11020 return;
11021 }
11022 else if (argvars[0].v_type == VAR_LIST)
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020011023 {
11024 if ((l = argvars[0].vval.v_list) == NULL
Bram Moolenaar05c00c02019-02-11 22:00:11 +010011025 || (!map && var_check_lock(l->lv_lock, arg_errmsg, TRUE)))
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020011026 return;
11027 }
11028 else if (argvars[0].v_type == VAR_DICT)
11029 {
11030 if ((d = argvars[0].vval.v_dict) == NULL
Bram Moolenaar05c00c02019-02-11 22:00:11 +010011031 || (!map && var_check_lock(d->dv_lock, arg_errmsg, TRUE)))
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020011032 return;
11033 }
11034 else
11035 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +010011036 semsg(_(e_listdictarg), ermsg);
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020011037 return;
11038 }
11039
11040 expr = &argvars[1];
11041 /* On type errors, the preceding call has already displayed an error
11042 * message. Avoid a misleading error message for an empty string that
11043 * was not passed as argument. */
11044 if (expr->v_type != VAR_UNKNOWN)
11045 {
11046 prepare_vimvar(VV_VAL, &save_val);
11047
11048 /* We reset "did_emsg" to be able to detect whether an error
11049 * occurred during evaluation of the expression. */
11050 save_did_emsg = did_emsg;
11051 did_emsg = FALSE;
11052
11053 prepare_vimvar(VV_KEY, &save_key);
11054 if (argvars[0].v_type == VAR_DICT)
11055 {
11056 vimvars[VV_KEY].vv_type = VAR_STRING;
11057
11058 ht = &d->dv_hashtab;
11059 hash_lock(ht);
11060 todo = (int)ht->ht_used;
11061 for (hi = ht->ht_array; todo > 0; ++hi)
11062 {
11063 if (!HASHITEM_EMPTY(hi))
11064 {
11065 int r;
11066
11067 --todo;
11068 di = HI2DI(hi);
Bram Moolenaar05c00c02019-02-11 22:00:11 +010011069 if (map && (var_check_lock(di->di_tv.v_lock,
11070 arg_errmsg, TRUE)
11071 || var_check_ro(di->di_flags,
11072 arg_errmsg, TRUE)))
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020011073 break;
11074 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
11075 r = filter_map_one(&di->di_tv, expr, map, &rem);
11076 clear_tv(&vimvars[VV_KEY].vv_tv);
11077 if (r == FAIL || did_emsg)
11078 break;
11079 if (!map && rem)
11080 {
11081 if (var_check_fixed(di->di_flags, arg_errmsg, TRUE)
11082 || var_check_ro(di->di_flags, arg_errmsg, TRUE))
11083 break;
11084 dictitem_remove(d, di);
11085 }
11086 }
11087 }
11088 hash_unlock(ht);
11089 }
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +010011090 else if (argvars[0].v_type == VAR_BLOB)
11091 {
11092 int i;
11093 typval_T tv;
11094
11095 vimvars[VV_KEY].vv_type = VAR_NUMBER;
11096 for (i = 0; i < b->bv_ga.ga_len; i++)
11097 {
11098 tv.v_type = VAR_NUMBER;
11099 tv.vval.v_number = blob_get(b, i);
11100 vimvars[VV_KEY].vv_nr = idx;
11101 if (filter_map_one(&tv, expr, map, &rem) == FAIL || did_emsg)
11102 break;
11103 if (tv.v_type != VAR_NUMBER)
11104 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +010011105 emsg(_(e_invalblob));
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +010011106 return;
11107 }
11108 tv.v_type = VAR_NUMBER;
11109 blob_set(b, i, tv.vval.v_number);
11110 if (!map && rem)
11111 {
11112 char_u *p = (char_u *)argvars[0].vval.v_blob->bv_ga.ga_data;
11113
11114 mch_memmove(p + idx, p + i + 1,
11115 (size_t)b->bv_ga.ga_len - i - 1);
11116 --b->bv_ga.ga_len;
11117 --i;
11118 }
11119 }
11120 }
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020011121 else
11122 {
Bram Moolenaarce9d50d2019-01-14 22:22:29 +010011123 // argvars[0].v_type == VAR_LIST
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020011124 vimvars[VV_KEY].vv_type = VAR_NUMBER;
11125
11126 for (li = l->lv_first; li != NULL; li = nli)
11127 {
Bram Moolenaar05c00c02019-02-11 22:00:11 +010011128 if (map && var_check_lock(li->li_tv.v_lock, arg_errmsg, TRUE))
Bram Moolenaar73dad1e2016-07-17 22:13:49 +020011129 break;
11130 nli = li->li_next;
11131 vimvars[VV_KEY].vv_nr = idx;
11132 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
11133 || did_emsg)
11134 break;
11135 if (!map && rem)
11136 listitem_remove(l, li);
11137 ++idx;
11138 }
11139 }
11140
11141 restore_vimvar(VV_KEY, &save_key);
11142 restore_vimvar(VV_VAL, &save_val);
11143
11144 did_emsg |= save_did_emsg;
11145 }
11146
11147 copy_tv(&argvars[0], rettv);
11148}
11149
Bram Moolenaar071d4272004-06-13 20:20:40 +000011150#endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */