blob: 9ce1d41aeb3a8f5a1241ecbb056fb87aee73d8e8 [file] [log] [blame]
Bram Moolenaar261f3462019-09-07 15:45:32 +02001/* vi:set ts=8 sts=4 sw=4 noet:
2 *
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 * evalbuffer.c: Buffer related builtin functions
12 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
17/*
18 * Mark references in functions of buffers.
19 */
20 int
21set_ref_in_buffers(int copyID)
22{
23 int abort = FALSE;
24 buf_T *bp;
25
26 FOR_ALL_BUFFERS(bp)
27 {
28 listener_T *lnr;
Bram Moolenaar261f3462019-09-07 15:45:32 +020029
30 for (lnr = bp->b_listener; !abort && lnr != NULL; lnr = lnr->lr_next)
Yegappan Lakshmanan6ae8fae2021-12-12 16:26:44 +000031 abort = abort || set_ref_in_callback(&lnr->lr_callback, copyID);
Bram Moolenaar261f3462019-09-07 15:45:32 +020032# ifdef FEAT_JOB_CHANNEL
Yegappan Lakshmanan6ae8fae2021-12-12 16:26:44 +000033 if (!abort)
34 abort = abort || set_ref_in_callback(&bp->b_prompt_callback, copyID);
35 if (!abort)
36 abort = abort || set_ref_in_callback(&bp->b_prompt_interrupt, copyID);
Bram Moolenaar261f3462019-09-07 15:45:32 +020037# endif
Yegappan Lakshmanan6ae8fae2021-12-12 16:26:44 +000038#ifdef FEAT_COMPL_FUNC
39 if (!abort)
40 abort = abort || set_ref_in_callback(&bp->b_cfu_cb, copyID);
41 if (!abort)
42 abort = abort || set_ref_in_callback(&bp->b_ofu_cb, copyID);
43 if (!abort)
44 abort = abort || set_ref_in_callback(&bp->b_tsrfu_cb, copyID);
45#endif
46 if (!abort)
47 abort = abort || set_ref_in_callback(&bp->b_tfu_cb, copyID);
Bram Moolenaar261f3462019-09-07 15:45:32 +020048 if (abort)
49 break;
50 }
51 return abort;
52}
53
54 buf_T *
55buflist_find_by_name(char_u *name, int curtab_only)
56{
57 int save_magic;
58 char_u *save_cpo;
59 buf_T *buf;
60
61 // Ignore 'magic' and 'cpoptions' here to make scripts portable
62 save_magic = p_magic;
63 p_magic = TRUE;
64 save_cpo = p_cpo;
Bram Moolenaare5a2dc82021-01-03 19:52:05 +010065 p_cpo = empty_option;
Bram Moolenaar261f3462019-09-07 15:45:32 +020066
67 buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
68 TRUE, FALSE, curtab_only));
69
70 p_magic = save_magic;
71 p_cpo = save_cpo;
72 return buf;
73}
74
75/*
76 * Find a buffer by number or exact name.
77 */
78 buf_T *
79find_buffer(typval_T *avar)
80{
81 buf_T *buf = NULL;
82
83 if (avar->v_type == VAR_NUMBER)
84 buf = buflist_findnr((int)avar->vval.v_number);
Bram Moolenaar7b45d462021-03-27 19:09:02 +010085 else if (in_vim9script() && check_for_string_arg(avar, 0) == FAIL)
86 return NULL;
Bram Moolenaar261f3462019-09-07 15:45:32 +020087 else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
88 {
89 buf = buflist_findname_exp(avar->vval.v_string);
90 if (buf == NULL)
91 {
92 // No full path name match, try a match with a URL or a "nofile"
93 // buffer, these don't use the full path.
94 FOR_ALL_BUFFERS(buf)
95 if (buf->b_fname != NULL
Bram Moolenaar6d4b2f52022-08-25 15:11:15 +010096 && (path_with_url(buf->b_fname) || bt_nofilename(buf))
Bram Moolenaar261f3462019-09-07 15:45:32 +020097 && STRCMP(buf->b_fname, avar->vval.v_string) == 0)
98 break;
99 }
100 }
101 return buf;
102}
103
104/*
105 * If there is a window for "curbuf", make it the current window.
106 */
107 static void
108find_win_for_curbuf(void)
109{
110 wininfo_T *wip;
111
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200112 FOR_ALL_BUF_WININFO(curbuf, wip)
Bram Moolenaar261f3462019-09-07 15:45:32 +0200113 {
114 if (wip->wi_win != NULL)
115 {
116 curwin = wip->wi_win;
117 break;
118 }
119 }
120}
121
122/*
Bram Moolenaar34453202021-01-31 13:08:38 +0100123 * Set line or list of lines in buffer "buf" to "lines".
124 * Any type is allowed and converted to a string.
Bram Moolenaar261f3462019-09-07 15:45:32 +0200125 */
126 static void
127set_buffer_lines(
128 buf_T *buf,
129 linenr_T lnum_arg,
130 int append,
131 typval_T *lines,
132 typval_T *rettv)
133{
134 linenr_T lnum = lnum_arg + (append ? 1 : 0);
135 char_u *line = NULL;
136 list_T *l = NULL;
137 listitem_T *li = NULL;
138 long added = 0;
139 linenr_T append_lnum;
140 buf_T *curbuf_save = NULL;
141 win_T *curwin_save = NULL;
142 int is_curbuf = buf == curbuf;
Bram Moolenaar0ad00a72022-05-22 11:59:25 +0100143 int save_VIsual_active = VIsual_active;
Bram Moolenaar261f3462019-09-07 15:45:32 +0200144
145 // When using the current buffer ml_mfp will be set if needed. Useful when
146 // setline() is used on startup. For other buffers the buffer must be
147 // loaded.
148 if (buf == NULL || (!is_curbuf && buf->b_ml.ml_mfp == NULL) || lnum < 1)
149 {
150 rettv->vval.v_number = 1; // FAIL
Bram Moolenaar8dac2ac2021-12-27 20:57:06 +0000151 if (in_vim9script() && lnum < 1)
152 semsg(_(e_invalid_line_number_nr), lnum_arg);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200153 return;
154 }
155
156 if (!is_curbuf)
157 {
Bram Moolenaar0ad00a72022-05-22 11:59:25 +0100158 VIsual_active = FALSE;
Bram Moolenaar261f3462019-09-07 15:45:32 +0200159 curbuf_save = curbuf;
160 curwin_save = curwin;
161 curbuf = buf;
162 find_win_for_curbuf();
163 }
164
165 if (append)
166 // appendbufline() uses the line number below which we insert
167 append_lnum = lnum - 1;
168 else
169 // setbufline() uses the line number above which we insert, we only
170 // append if it's below the last line
171 append_lnum = curbuf->b_ml.ml_line_count;
172
173 if (lines->v_type == VAR_LIST)
174 {
175 l = lines->vval.v_list;
Bram Moolenaarad48e6c2020-04-21 22:19:45 +0200176 if (l == NULL || list_len(l) == 0)
177 {
Bram Moolenaarcd9c8d42022-11-05 23:46:43 +0000178 // not appending anything always succeeds
Bram Moolenaarad48e6c2020-04-21 22:19:45 +0200179 goto done;
180 }
Bram Moolenaar7e9f3512020-05-13 22:44:22 +0200181 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200182 li = l->lv_first;
183 }
184 else
Bram Moolenaar34453202021-01-31 13:08:38 +0100185 line = typval_tostring(lines, FALSE);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200186
187 // default result is zero == OK
188 for (;;)
189 {
190 if (l != NULL)
191 {
192 // list argument, get next string
193 if (li == NULL)
194 break;
Bram Moolenaar34453202021-01-31 13:08:38 +0100195 vim_free(line);
196 line = typval_tostring(&li->li_tv, FALSE);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200197 li = li->li_next;
198 }
199
200 rettv->vval.v_number = 1; // FAIL
201 if (line == NULL || lnum > curbuf->b_ml.ml_line_count + 1)
202 break;
203
204 // When coming here from Insert mode, sync undo, so that this can be
205 // undone separately from what was previously inserted.
206 if (u_sync_once == 2)
207 {
208 u_sync_once = 1; // notify that u_sync() was called
209 u_sync(TRUE);
210 }
211
212 if (!append && lnum <= curbuf->b_ml.ml_line_count)
213 {
214 // Existing line, replace it.
215 // Removes any existing text properties.
216 if (u_savesub(lnum) == OK && ml_replace_len(
217 lnum, line, (colnr_T)STRLEN(line) + 1, TRUE, TRUE) == OK)
218 {
219 changed_bytes(lnum, 0);
220 if (is_curbuf && lnum == curwin->w_cursor.lnum)
221 check_cursor_col();
222 rettv->vval.v_number = 0; // OK
223 }
224 }
225 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
226 {
227 // append the line
228 ++added;
229 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
230 rettv->vval.v_number = 0; // OK
231 }
232
233 if (l == NULL) // only one string argument
234 break;
235 ++lnum;
236 }
Bram Moolenaar34453202021-01-31 13:08:38 +0100237 vim_free(line);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200238
239 if (added > 0)
240 {
241 win_T *wp;
242 tabpage_T *tp;
243
244 appended_lines_mark(append_lnum, added);
245
246 // Only adjust the cursor for buffers other than the current, unless it
247 // is the current window. For curbuf and other windows it has been
248 // done in mark_adjust_internal().
249 FOR_ALL_TAB_WINDOWS(tp, wp)
250 if (wp->w_buffer == buf
251 && (wp->w_buffer != curbuf || wp == curwin)
252 && wp->w_cursor.lnum > append_lnum)
253 wp->w_cursor.lnum += added;
254 check_cursor_col();
Bram Moolenaar58a3cae2022-09-08 13:43:10 +0100255
256 // Only update the window view if w_buffer matches curbuf, otherwise
257 // the computations will be wrong.
258 if (curwin->w_buffer == curbuf)
259 update_topline();
Bram Moolenaar261f3462019-09-07 15:45:32 +0200260 }
261
Bram Moolenaarad48e6c2020-04-21 22:19:45 +0200262done:
Bram Moolenaar261f3462019-09-07 15:45:32 +0200263 if (!is_curbuf)
264 {
265 curbuf = curbuf_save;
266 curwin = curwin_save;
Bram Moolenaar0ad00a72022-05-22 11:59:25 +0100267 VIsual_active = save_VIsual_active;
Bram Moolenaar261f3462019-09-07 15:45:32 +0200268 }
269}
270
271/*
272 * "append(lnum, string/list)" function
273 */
274 void
275f_append(typval_T *argvars, typval_T *rettv)
276{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200277 linenr_T lnum;
Bram Moolenaar8b6256f2021-12-28 11:24:49 +0000278 int did_emsg_before = did_emsg;
Bram Moolenaar261f3462019-09-07 15:45:32 +0200279
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200280 if (in_vim9script() && check_for_lnum_arg(argvars, 0) == FAIL)
281 return;
282
283 lnum = tv_get_lnum(&argvars[0]);
Bram Moolenaar8b6256f2021-12-28 11:24:49 +0000284 if (did_emsg == did_emsg_before)
285 set_buffer_lines(curbuf, lnum, TRUE, &argvars[1], rettv);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200286}
287
288/*
Yegappan Lakshmanan4a155042021-07-30 21:32:45 +0200289 * Set or append lines to a buffer.
Bram Moolenaar261f3462019-09-07 15:45:32 +0200290 */
Yegappan Lakshmanan4a155042021-07-30 21:32:45 +0200291 static void
292buf_set_append_line(typval_T *argvars, typval_T *rettv, int append)
Bram Moolenaar261f3462019-09-07 15:45:32 +0200293{
294 linenr_T lnum;
295 buf_T *buf;
Bram Moolenaar8b6256f2021-12-28 11:24:49 +0000296 int did_emsg_before = did_emsg;
Bram Moolenaar261f3462019-09-07 15:45:32 +0200297
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200298 if (in_vim9script()
299 && (check_for_buffer_arg(argvars, 0) == FAIL
300 || check_for_lnum_arg(argvars, 1) == FAIL
301 || check_for_string_or_number_or_list_arg(argvars, 2) == FAIL))
302 return;
303
Bram Moolenaar261f3462019-09-07 15:45:32 +0200304 buf = tv_get_buf(&argvars[0], FALSE);
305 if (buf == NULL)
306 rettv->vval.v_number = 1; // FAIL
307 else
308 {
309 lnum = tv_get_lnum_buf(&argvars[1], buf);
Bram Moolenaar8b6256f2021-12-28 11:24:49 +0000310 if (did_emsg == did_emsg_before)
311 set_buffer_lines(buf, lnum, append, &argvars[2], rettv);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200312 }
313}
314
315/*
Yegappan Lakshmanan4a155042021-07-30 21:32:45 +0200316 * "appendbufline(buf, lnum, string/list)" function
317 */
318 void
319f_appendbufline(typval_T *argvars, typval_T *rettv)
320{
321 buf_set_append_line(argvars, rettv, TRUE);
322}
323
324/*
Bram Moolenaar261f3462019-09-07 15:45:32 +0200325 * "bufadd(expr)" function
326 */
327 void
328f_bufadd(typval_T *argvars, typval_T *rettv)
329{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200330 char_u *name;
Bram Moolenaar261f3462019-09-07 15:45:32 +0200331
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200332 if (in_vim9script() && check_for_string_arg(argvars, 0) == FAIL)
333 return;
334
335 name = tv_get_string(&argvars[0]);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200336 rettv->vval.v_number = buflist_add(*name == NUL ? NULL : name, 0);
337}
338
339/*
340 * "bufexists(expr)" function
341 */
342 void
343f_bufexists(typval_T *argvars, typval_T *rettv)
344{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200345 if (in_vim9script() && check_for_buffer_arg(argvars, 0) == FAIL)
346 return;
347
Bram Moolenaar261f3462019-09-07 15:45:32 +0200348 rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
349}
350
351/*
352 * "buflisted(expr)" function
353 */
354 void
355f_buflisted(typval_T *argvars, typval_T *rettv)
356{
357 buf_T *buf;
358
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200359 if (in_vim9script() && check_for_buffer_arg(argvars, 0) == FAIL)
360 return;
361
Bram Moolenaar261f3462019-09-07 15:45:32 +0200362 buf = find_buffer(&argvars[0]);
363 rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
364}
365
366/*
367 * "bufload(expr)" function
368 */
369 void
370f_bufload(typval_T *argvars, typval_T *rettv UNUSED)
371{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200372 buf_T *buf;
Bram Moolenaar261f3462019-09-07 15:45:32 +0200373
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200374 if (in_vim9script() && check_for_buffer_arg(argvars, 0) == FAIL)
375 return;
376
377 buf = get_buf_arg(&argvars[0]);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200378 if (buf != NULL)
379 buffer_ensure_loaded(buf);
380}
381
382/*
383 * "bufloaded(expr)" function
384 */
385 void
386f_bufloaded(typval_T *argvars, typval_T *rettv)
387{
388 buf_T *buf;
389
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200390 if (in_vim9script() && check_for_buffer_arg(argvars, 0) == FAIL)
391 return;
392
Bram Moolenaar261f3462019-09-07 15:45:32 +0200393 buf = find_buffer(&argvars[0]);
394 rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
395}
396
397/*
398 * "bufname(expr)" function
399 */
400 void
401f_bufname(typval_T *argvars, typval_T *rettv)
402{
403 buf_T *buf;
Bram Moolenaar02aaad92020-08-30 21:26:57 +0200404 typval_T *tv = &argvars[0];
Bram Moolenaar261f3462019-09-07 15:45:32 +0200405
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200406 if (in_vim9script() && check_for_opt_buffer_arg(argvars, 0) == FAIL)
407 return;
408
Bram Moolenaar02aaad92020-08-30 21:26:57 +0200409 if (tv->v_type == VAR_UNKNOWN)
Bram Moolenaar261f3462019-09-07 15:45:32 +0200410 buf = curbuf;
411 else
Bram Moolenaar3767e3a2020-09-01 23:06:01 +0200412 buf = tv_get_buf_from_arg(tv);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200413 rettv->v_type = VAR_STRING;
414 if (buf != NULL && buf->b_fname != NULL)
415 rettv->vval.v_string = vim_strsave(buf->b_fname);
416 else
417 rettv->vval.v_string = NULL;
418}
419
420/*
421 * "bufnr(expr)" function
422 */
423 void
424f_bufnr(typval_T *argvars, typval_T *rettv)
425{
426 buf_T *buf;
427 int error = FALSE;
428 char_u *name;
429
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +0200430 if (in_vim9script()
Yegappan Lakshmanancd917202021-07-21 19:09:09 +0200431 && (check_for_opt_buffer_arg(argvars, 0) == FAIL
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +0200432 || (argvars[0].v_type != VAR_UNKNOWN
433 && check_for_opt_bool_arg(argvars, 1) == FAIL)))
434 return;
435
Bram Moolenaar261f3462019-09-07 15:45:32 +0200436 if (argvars[0].v_type == VAR_UNKNOWN)
437 buf = curbuf;
438 else
Bram Moolenaar3767e3a2020-09-01 23:06:01 +0200439 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200440
441 // If the buffer isn't found and the second argument is not zero create a
442 // new buffer.
443 if (buf == NULL
444 && argvars[1].v_type != VAR_UNKNOWN
Bram Moolenaarfe136c92020-09-04 18:35:26 +0200445 && tv_get_bool_chk(&argvars[1], &error) != 0
Bram Moolenaar261f3462019-09-07 15:45:32 +0200446 && !error
447 && (name = tv_get_string_chk(&argvars[0])) != NULL
448 && !error)
449 buf = buflist_new(name, NULL, (linenr_T)1, 0);
450
451 if (buf != NULL)
452 rettv->vval.v_number = buf->b_fnum;
453 else
454 rettv->vval.v_number = -1;
455}
456
457 static void
458buf_win_common(typval_T *argvars, typval_T *rettv, int get_nr)
459{
460 win_T *wp;
461 int winnr = 0;
462 buf_T *buf;
463
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200464 if (in_vim9script() && check_for_buffer_arg(argvars, 0) == FAIL)
465 return;
466
Bram Moolenaar3767e3a2020-09-01 23:06:01 +0200467 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200468 FOR_ALL_WINDOWS(wp)
469 {
470 ++winnr;
471 if (wp->w_buffer == buf)
472 break;
473 }
474 rettv->vval.v_number = (wp != NULL ? (get_nr ? winnr : wp->w_id) : -1);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200475}
476
477/*
478 * "bufwinid(nr)" function
479 */
480 void
481f_bufwinid(typval_T *argvars, typval_T *rettv)
482{
483 buf_win_common(argvars, rettv, FALSE);
484}
485
486/*
487 * "bufwinnr(nr)" function
488 */
489 void
490f_bufwinnr(typval_T *argvars, typval_T *rettv)
491{
492 buf_win_common(argvars, rettv, TRUE);
493}
494
495/*
496 * "deletebufline()" function
497 */
498 void
499f_deletebufline(typval_T *argvars, typval_T *rettv)
500{
501 buf_T *buf;
502 linenr_T first, last;
503 linenr_T lnum;
504 long count;
505 int is_curbuf;
506 buf_T *curbuf_save = NULL;
507 win_T *curwin_save = NULL;
508 tabpage_T *tp;
509 win_T *wp;
Bram Moolenaar8b6256f2021-12-28 11:24:49 +0000510 int did_emsg_before = did_emsg;
LemonBoy9b2edfd2022-05-22 15:35:53 +0100511 int save_VIsual_active = VIsual_active;
Bram Moolenaar8b6256f2021-12-28 11:24:49 +0000512
513 rettv->vval.v_number = 1; // FAIL by default
Bram Moolenaar261f3462019-09-07 15:45:32 +0200514
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +0200515 if (in_vim9script()
516 && (check_for_buffer_arg(argvars, 0) == FAIL
517 || check_for_lnum_arg(argvars, 1) == FAIL
518 || check_for_opt_lnum_arg(argvars, 2) == FAIL))
519 return;
520
Bram Moolenaar261f3462019-09-07 15:45:32 +0200521 buf = tv_get_buf(&argvars[0], FALSE);
522 if (buf == NULL)
Bram Moolenaar261f3462019-09-07 15:45:32 +0200523 return;
Bram Moolenaar261f3462019-09-07 15:45:32 +0200524 is_curbuf = buf == curbuf;
525
526 first = tv_get_lnum_buf(&argvars[1], buf);
Bram Moolenaar8b6256f2021-12-28 11:24:49 +0000527 if (did_emsg > did_emsg_before)
528 return;
Bram Moolenaar261f3462019-09-07 15:45:32 +0200529 if (argvars[2].v_type != VAR_UNKNOWN)
530 last = tv_get_lnum_buf(&argvars[2], buf);
531 else
532 last = first;
533
534 if (buf->b_ml.ml_mfp == NULL || first < 1
535 || first > buf->b_ml.ml_line_count || last < first)
Bram Moolenaar261f3462019-09-07 15:45:32 +0200536 return;
Bram Moolenaar261f3462019-09-07 15:45:32 +0200537
538 if (!is_curbuf)
539 {
LemonBoy9b2edfd2022-05-22 15:35:53 +0100540 VIsual_active = FALSE;
Bram Moolenaar261f3462019-09-07 15:45:32 +0200541 curbuf_save = curbuf;
542 curwin_save = curwin;
543 curbuf = buf;
544 find_win_for_curbuf();
545 }
546 if (last > curbuf->b_ml.ml_line_count)
547 last = curbuf->b_ml.ml_line_count;
548 count = last - first + 1;
549
550 // When coming here from Insert mode, sync undo, so that this can be
551 // undone separately from what was previously inserted.
552 if (u_sync_once == 2)
553 {
554 u_sync_once = 1; // notify that u_sync() was called
555 u_sync(TRUE);
556 }
557
558 if (u_save(first - 1, last + 1) == FAIL)
559 {
560 rettv->vval.v_number = 1; // FAIL
Bram Moolenaar261f3462019-09-07 15:45:32 +0200561 }
Bram Moolenaar963ffa02021-02-09 20:02:55 +0100562 else
563 {
564 for (lnum = first; lnum <= last; ++lnum)
565 ml_delete_flags(first, ML_DEL_MESSAGE);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200566
Bram Moolenaar963ffa02021-02-09 20:02:55 +0100567 FOR_ALL_TAB_WINDOWS(tp, wp)
568 if (wp->w_buffer == buf)
569 {
570 if (wp->w_cursor.lnum > last)
571 wp->w_cursor.lnum -= count;
Bram Moolenaar63c84732022-10-20 21:14:19 +0100572 else if (wp->w_cursor.lnum > first)
Bram Moolenaar963ffa02021-02-09 20:02:55 +0100573 wp->w_cursor.lnum = first;
574 if (wp->w_cursor.lnum > wp->w_buffer->b_ml.ml_line_count)
575 wp->w_cursor.lnum = wp->w_buffer->b_ml.ml_line_count;
Bram Moolenaar63c84732022-10-20 21:14:19 +0100576 wp->w_valid = 0;
577 if (wp->w_cursor.lnum <= wp->w_topline)
578 wp->w_topline = 1;
Bram Moolenaar963ffa02021-02-09 20:02:55 +0100579 }
580 check_cursor_col();
581 deleted_lines_mark(first, count);
582 }
Bram Moolenaar261f3462019-09-07 15:45:32 +0200583
584 if (!is_curbuf)
585 {
586 curbuf = curbuf_save;
587 curwin = curwin_save;
LemonBoy9b2edfd2022-05-22 15:35:53 +0100588 VIsual_active = save_VIsual_active;
Bram Moolenaar261f3462019-09-07 15:45:32 +0200589 }
Bram Moolenaar8b6256f2021-12-28 11:24:49 +0000590 rettv->vval.v_number = 0; // OK
Bram Moolenaar261f3462019-09-07 15:45:32 +0200591}
592
593/*
594 * Returns buffer options, variables and other attributes in a dictionary.
595 */
596 static dict_T *
597get_buffer_info(buf_T *buf)
598{
599 dict_T *dict;
600 tabpage_T *tp;
601 win_T *wp;
602 list_T *windows;
603
604 dict = dict_alloc();
605 if (dict == NULL)
606 return NULL;
607
608 dict_add_number(dict, "bufnr", buf->b_fnum);
609 dict_add_string(dict, "name", buf->b_ffname);
610 dict_add_number(dict, "lnum", buf == curbuf ? curwin->w_cursor.lnum
611 : buflist_findlnum(buf));
Bram Moolenaara9e96792019-12-17 22:40:15 +0100612 dict_add_number(dict, "linecount", buf->b_ml.ml_line_count);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200613 dict_add_number(dict, "loaded", buf->b_ml.ml_mfp != NULL);
614 dict_add_number(dict, "listed", buf->b_p_bl);
615 dict_add_number(dict, "changed", bufIsChanged(buf));
616 dict_add_number(dict, "changedtick", CHANGEDTICK(buf));
617 dict_add_number(dict, "hidden",
618 buf->b_ml.ml_mfp != NULL && buf->b_nwindows == 0);
619
620 // Get a reference to buffer variables
621 dict_add_dict(dict, "variables", buf->b_vars);
622
623 // List of windows displaying this buffer
624 windows = list_alloc();
625 if (windows != NULL)
626 {
627 FOR_ALL_TAB_WINDOWS(tp, wp)
628 if (wp->w_buffer == buf)
629 list_append_number(windows, (varnumber_T)wp->w_id);
630 dict_add_list(dict, "windows", windows);
631 }
632
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +0100633#ifdef FEAT_PROP_POPUP
Bram Moolenaar261f3462019-09-07 15:45:32 +0200634 // List of popup windows displaying this buffer
635 windows = list_alloc();
636 if (windows != NULL)
637 {
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200638 FOR_ALL_POPUPWINS(wp)
Bram Moolenaar261f3462019-09-07 15:45:32 +0200639 if (wp->w_buffer == buf)
640 list_append_number(windows, (varnumber_T)wp->w_id);
641 FOR_ALL_TABPAGES(tp)
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200642 FOR_ALL_POPUPWINS_IN_TAB(tp, wp)
Bram Moolenaar261f3462019-09-07 15:45:32 +0200643 if (wp->w_buffer == buf)
644 list_append_number(windows, (varnumber_T)wp->w_id);
645
646 dict_add_list(dict, "popups", windows);
647 }
648#endif
649
650#ifdef FEAT_SIGNS
651 if (buf->b_signlist != NULL)
652 {
653 // List of signs placed in this buffer
654 list_T *signs = list_alloc();
655 if (signs != NULL)
656 {
657 get_buffer_signs(buf, signs);
658 dict_add_list(dict, "signs", signs);
659 }
660 }
661#endif
662
Bram Moolenaar52410572019-10-27 05:12:45 +0100663#ifdef FEAT_VIMINFO
664 dict_add_number(dict, "lastused", buf->b_last_used);
665#endif
666
Bram Moolenaar261f3462019-09-07 15:45:32 +0200667 return dict;
668}
669
670/*
671 * "getbufinfo()" function
672 */
673 void
674f_getbufinfo(typval_T *argvars, typval_T *rettv)
675{
676 buf_T *buf = NULL;
677 buf_T *argbuf = NULL;
678 dict_T *d;
679 int filtered = FALSE;
680 int sel_buflisted = FALSE;
681 int sel_bufloaded = FALSE;
682 int sel_bufmodified = FALSE;
683
Bram Moolenaar93a10962022-06-16 11:42:09 +0100684 if (rettv_list_alloc(rettv) == FAIL)
Bram Moolenaar261f3462019-09-07 15:45:32 +0200685 return;
686
Yegappan Lakshmanancd917202021-07-21 19:09:09 +0200687 if (in_vim9script()
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200688 && check_for_opt_buffer_or_dict_arg(argvars, 0) == FAIL)
Yegappan Lakshmanancd917202021-07-21 19:09:09 +0200689 return;
690
Bram Moolenaar261f3462019-09-07 15:45:32 +0200691 // List of all the buffers or selected buffers
692 if (argvars[0].v_type == VAR_DICT)
693 {
694 dict_T *sel_d = argvars[0].vval.v_dict;
695
696 if (sel_d != NULL)
697 {
Bram Moolenaar261f3462019-09-07 15:45:32 +0200698 filtered = TRUE;
Bram Moolenaard61efa52022-07-23 09:52:04 +0100699 sel_buflisted = dict_get_bool(sel_d, "buflisted", FALSE);
700 sel_bufloaded = dict_get_bool(sel_d, "bufloaded", FALSE);
701 sel_bufmodified = dict_get_bool(sel_d, "bufmodified",
Bram Moolenaar036c2cf2020-09-05 17:37:07 +0200702 FALSE);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200703 }
704 }
705 else if (argvars[0].v_type != VAR_UNKNOWN)
706 {
707 // Information about one buffer. Argument specifies the buffer
Bram Moolenaar3767e3a2020-09-01 23:06:01 +0200708 argbuf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200709 if (argbuf == NULL)
710 return;
711 }
712
713 // Return information about all the buffers or a specified buffer
714 FOR_ALL_BUFFERS(buf)
715 {
716 if (argbuf != NULL && argbuf != buf)
717 continue;
718 if (filtered && ((sel_bufloaded && buf->b_ml.ml_mfp == NULL)
719 || (sel_buflisted && !buf->b_p_bl)
720 || (sel_bufmodified && !buf->b_changed)))
721 continue;
722
723 d = get_buffer_info(buf);
724 if (d != NULL)
725 list_append_dict(rettv->vval.v_list, d);
726 if (argbuf != NULL)
727 return;
728 }
729}
730
731/*
732 * Get line or list of lines from buffer "buf" into "rettv".
733 * Return a range (from start to end) of lines in rettv from the specified
734 * buffer.
735 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
736 */
737 static void
738get_buffer_lines(
739 buf_T *buf,
740 linenr_T start,
741 linenr_T end,
742 int retlist,
743 typval_T *rettv)
744{
745 char_u *p;
746
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100747 if (retlist)
748 {
749 if (rettv_list_alloc(rettv) == FAIL)
750 return;
751 }
752 else
753 {
754 rettv->v_type = VAR_STRING;
755 rettv->vval.v_string = NULL;
756 }
Bram Moolenaar261f3462019-09-07 15:45:32 +0200757
758 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
759 return;
760
761 if (!retlist)
762 {
763 if (start >= 1 && start <= buf->b_ml.ml_line_count)
764 p = ml_get_buf(buf, start, FALSE);
765 else
766 p = (char_u *)"";
767 rettv->vval.v_string = vim_strsave(p);
768 }
769 else
770 {
771 if (end < start)
772 return;
773
774 if (start < 1)
775 start = 1;
776 if (end > buf->b_ml.ml_line_count)
777 end = buf->b_ml.ml_line_count;
778 while (start <= end)
779 if (list_append_string(rettv->vval.v_list,
780 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
781 break;
782 }
783}
784
785/*
786 * "getbufline()" function
787 */
788 void
789f_getbufline(typval_T *argvars, typval_T *rettv)
790{
Bram Moolenaare6e70a12020-10-22 18:23:38 +0200791 linenr_T lnum = 1;
792 linenr_T end = 1;
Bram Moolenaar261f3462019-09-07 15:45:32 +0200793 buf_T *buf;
Bram Moolenaar8b6256f2021-12-28 11:24:49 +0000794 int did_emsg_before = did_emsg;
Bram Moolenaar261f3462019-09-07 15:45:32 +0200795
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +0200796 if (in_vim9script()
797 && (check_for_buffer_arg(argvars, 0) == FAIL
798 || check_for_lnum_arg(argvars, 1) == FAIL
799 || check_for_opt_lnum_arg(argvars, 2) == FAIL))
800 return;
801
Bram Moolenaar3767e3a2020-09-01 23:06:01 +0200802 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaare6e70a12020-10-22 18:23:38 +0200803 if (buf != NULL)
804 {
805 lnum = tv_get_lnum_buf(&argvars[1], buf);
Bram Moolenaar8b6256f2021-12-28 11:24:49 +0000806 if (did_emsg > did_emsg_before)
807 return;
Bram Moolenaare6e70a12020-10-22 18:23:38 +0200808 if (argvars[2].v_type == VAR_UNKNOWN)
809 end = lnum;
810 else
811 end = tv_get_lnum_buf(&argvars[2], buf);
812 }
Bram Moolenaar261f3462019-09-07 15:45:32 +0200813
814 get_buffer_lines(buf, lnum, end, TRUE, rettv);
815}
816
817/*
818 * "getline(lnum, [end])" function
819 */
820 void
821f_getline(typval_T *argvars, typval_T *rettv)
822{
823 linenr_T lnum;
824 linenr_T end;
825 int retlist;
826
Yegappan Lakshmanancd917202021-07-21 19:09:09 +0200827 if (in_vim9script()
828 && (check_for_lnum_arg(argvars, 0) == FAIL
829 || check_for_opt_lnum_arg(argvars, 1) == FAIL))
830 return;
831
Bram Moolenaar261f3462019-09-07 15:45:32 +0200832 lnum = tv_get_lnum(argvars);
833 if (argvars[1].v_type == VAR_UNKNOWN)
834 {
835 end = 0;
836 retlist = FALSE;
837 }
838 else
839 {
840 end = tv_get_lnum(&argvars[1]);
841 retlist = TRUE;
842 }
843
844 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
845}
846
847/*
848 * "setbufline()" function
849 */
850 void
851f_setbufline(typval_T *argvars, typval_T *rettv)
852{
Yegappan Lakshmanan4a155042021-07-30 21:32:45 +0200853 buf_set_append_line(argvars, rettv, FALSE);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200854}
855
856/*
857 * "setline()" function
858 */
859 void
860f_setline(typval_T *argvars, typval_T *rettv)
861{
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200862 linenr_T lnum;
Bram Moolenaar8b6256f2021-12-28 11:24:49 +0000863 int did_emsg_before = did_emsg;
Bram Moolenaar261f3462019-09-07 15:45:32 +0200864
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +0200865 if (in_vim9script() && check_for_lnum_arg(argvars, 0) == FAIL)
866 return;
867
868 lnum = tv_get_lnum(&argvars[0]);
Bram Moolenaar8b6256f2021-12-28 11:24:49 +0000869 if (did_emsg == did_emsg_before)
870 set_buffer_lines(curbuf, lnum, FALSE, &argvars[1], rettv);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200871}
872#endif // FEAT_EVAL
873
Dominique Pelle748b3082022-01-08 12:41:16 +0000874#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaar261f3462019-09-07 15:45:32 +0200875/*
876 * Make "buf" the current buffer. restore_buffer() MUST be called to undo.
877 * No autocommands will be executed. Use aucmd_prepbuf() if there are any.
878 */
879 void
880switch_buffer(bufref_T *save_curbuf, buf_T *buf)
881{
882 block_autocmds();
Bram Moolenaar3e0107e2021-01-02 13:53:59 +0100883#ifdef FEAT_FOLDING
884 ++disable_fold_update;
885#endif
Bram Moolenaar261f3462019-09-07 15:45:32 +0200886 set_bufref(save_curbuf, curbuf);
887 --curbuf->b_nwindows;
888 curbuf = buf;
889 curwin->w_buffer = buf;
890 ++curbuf->b_nwindows;
891}
892
893/*
894 * Restore the current buffer after using switch_buffer().
895 */
896 void
897restore_buffer(bufref_T *save_curbuf)
898{
899 unblock_autocmds();
Bram Moolenaar3e0107e2021-01-02 13:53:59 +0100900#ifdef FEAT_FOLDING
901 --disable_fold_update;
902#endif
Bram Moolenaar5d18efe2019-12-01 21:11:22 +0100903 // Check for valid buffer, just in case.
Bram Moolenaar261f3462019-09-07 15:45:32 +0200904 if (bufref_valid(save_curbuf))
905 {
906 --curbuf->b_nwindows;
907 curwin->w_buffer = save_curbuf->br_buf;
908 curbuf = save_curbuf->br_buf;
909 ++curbuf->b_nwindows;
910 }
911}
912
913/*
914 * Find a window for buffer "buf".
915 * If found OK is returned and "wp" and "tp" are set to the window and tabpage.
916 * If not found FAIL is returned.
917 */
918 static int
919find_win_for_buf(
920 buf_T *buf,
921 win_T **wp,
922 tabpage_T **tp)
923{
924 FOR_ALL_TAB_WINDOWS(*tp, *wp)
925 if ((*wp)->w_buffer == buf)
926 return OK;
927 return FAIL;
928}
929
930/*
931 * Find a window that contains "buf" and switch to it.
932 * If there is no such window, use the current window and change "curbuf".
933 * Caller must initialize save_curbuf to NULL.
934 * restore_win_for_buf() MUST be called later!
935 */
936 void
937switch_to_win_for_buf(
Bram Moolenaar18f47402022-01-06 13:24:51 +0000938 buf_T *buf,
939 switchwin_T *switchwin,
940 bufref_T *save_curbuf)
Bram Moolenaar261f3462019-09-07 15:45:32 +0200941{
942 win_T *wp;
943 tabpage_T *tp;
944
945 if (find_win_for_buf(buf, &wp, &tp) == FAIL)
946 switch_buffer(save_curbuf, buf);
Bram Moolenaar18f47402022-01-06 13:24:51 +0000947 else if (switch_win(switchwin, wp, tp, TRUE) == FAIL)
Bram Moolenaar261f3462019-09-07 15:45:32 +0200948 {
Bram Moolenaar18f47402022-01-06 13:24:51 +0000949 restore_win(switchwin, TRUE);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200950 switch_buffer(save_curbuf, buf);
951 }
952}
953
954 void
955restore_win_for_buf(
Bram Moolenaar18f47402022-01-06 13:24:51 +0000956 switchwin_T *switchwin,
957 bufref_T *save_curbuf)
Bram Moolenaar261f3462019-09-07 15:45:32 +0200958{
959 if (save_curbuf->br_buf == NULL)
Bram Moolenaar18f47402022-01-06 13:24:51 +0000960 restore_win(switchwin, TRUE);
Bram Moolenaar261f3462019-09-07 15:45:32 +0200961 else
962 restore_buffer(save_curbuf);
963}
964#endif