xref: /vim-8.2.3635/src/evalbuffer.c (revision 5ef1c6a4)
1 /* 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
21 set_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;
29 	typval_T tv;
30 
31 	for (lnr = bp->b_listener; !abort && lnr != NULL; lnr = lnr->lr_next)
32 	{
33 	    if (lnr->lr_callback.cb_partial != NULL)
34 	    {
35 		tv.v_type = VAR_PARTIAL;
36 		tv.vval.v_partial = lnr->lr_callback.cb_partial;
37 		abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
38 	    }
39 	}
40 # ifdef FEAT_JOB_CHANNEL
41 	if (!abort && bp->b_prompt_callback.cb_partial != NULL)
42 	{
43 	    tv.v_type = VAR_PARTIAL;
44 	    tv.vval.v_partial = bp->b_prompt_callback.cb_partial;
45 	    abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
46 	}
47 	if (!abort && bp->b_prompt_interrupt.cb_partial != NULL)
48 	{
49 	    tv.v_type = VAR_PARTIAL;
50 	    tv.vval.v_partial = bp->b_prompt_interrupt.cb_partial;
51 	    abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
52 	}
53 # endif
54 	if (abort)
55 	    break;
56     }
57     return abort;
58 }
59 
60     buf_T *
61 buflist_find_by_name(char_u *name, int curtab_only)
62 {
63     int		save_magic;
64     char_u	*save_cpo;
65     buf_T	*buf;
66 
67     // Ignore 'magic' and 'cpoptions' here to make scripts portable
68     save_magic = p_magic;
69     p_magic = TRUE;
70     save_cpo = p_cpo;
71     p_cpo = (char_u *)"";
72 
73     buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
74 						    TRUE, FALSE, curtab_only));
75 
76     p_magic = save_magic;
77     p_cpo = save_cpo;
78     return buf;
79 }
80 
81 /*
82  * Find a buffer by number or exact name.
83  */
84     buf_T *
85 find_buffer(typval_T *avar)
86 {
87     buf_T	*buf = NULL;
88 
89     if (avar->v_type == VAR_NUMBER)
90 	buf = buflist_findnr((int)avar->vval.v_number);
91     else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
92     {
93 	buf = buflist_findname_exp(avar->vval.v_string);
94 	if (buf == NULL)
95 	{
96 	    // No full path name match, try a match with a URL or a "nofile"
97 	    // buffer, these don't use the full path.
98 	    FOR_ALL_BUFFERS(buf)
99 		if (buf->b_fname != NULL
100 			&& (path_with_url(buf->b_fname)
101 #ifdef FEAT_QUICKFIX
102 			    || bt_nofilename(buf)
103 #endif
104 			   )
105 			&& STRCMP(buf->b_fname, avar->vval.v_string) == 0)
106 		    break;
107 	}
108     }
109     return buf;
110 }
111 
112 /*
113  * If there is a window for "curbuf", make it the current window.
114  */
115     static void
116 find_win_for_curbuf(void)
117 {
118     wininfo_T *wip;
119 
120     for (wip = curbuf->b_wininfo; wip != NULL; wip = wip->wi_next)
121     {
122 	if (wip->wi_win != NULL)
123 	{
124 	    curwin = wip->wi_win;
125 	    break;
126 	}
127     }
128 }
129 
130 /*
131  * Set line or list of lines in buffer "buf".
132  */
133     static void
134 set_buffer_lines(
135 	buf_T	    *buf,
136 	linenr_T    lnum_arg,
137 	int	    append,
138 	typval_T    *lines,
139 	typval_T    *rettv)
140 {
141     linenr_T    lnum = lnum_arg + (append ? 1 : 0);
142     char_u	*line = NULL;
143     list_T	*l = NULL;
144     listitem_T	*li = NULL;
145     long	added = 0;
146     linenr_T	append_lnum;
147     buf_T	*curbuf_save = NULL;
148     win_T	*curwin_save = NULL;
149     int		is_curbuf = buf == curbuf;
150 
151     // When using the current buffer ml_mfp will be set if needed.  Useful when
152     // setline() is used on startup.  For other buffers the buffer must be
153     // loaded.
154     if (buf == NULL || (!is_curbuf && buf->b_ml.ml_mfp == NULL) || lnum < 1)
155     {
156 	rettv->vval.v_number = 1;	// FAIL
157 	return;
158     }
159 
160     if (!is_curbuf)
161     {
162 	curbuf_save = curbuf;
163 	curwin_save = curwin;
164 	curbuf = buf;
165 	find_win_for_curbuf();
166     }
167 
168     if (append)
169 	// appendbufline() uses the line number below which we insert
170 	append_lnum = lnum - 1;
171     else
172 	// setbufline() uses the line number above which we insert, we only
173 	// append if it's below the last line
174 	append_lnum = curbuf->b_ml.ml_line_count;
175 
176     if (lines->v_type == VAR_LIST)
177     {
178 	l = lines->vval.v_list;
179 	li = l->lv_first;
180     }
181     else
182 	line = tv_get_string_chk(lines);
183 
184     // default result is zero == OK
185     for (;;)
186     {
187 	if (l != NULL)
188 	{
189 	    // list argument, get next string
190 	    if (li == NULL)
191 		break;
192 	    line = tv_get_string_chk(&li->li_tv);
193 	    li = li->li_next;
194 	}
195 
196 	rettv->vval.v_number = 1;	// FAIL
197 	if (line == NULL || lnum > curbuf->b_ml.ml_line_count + 1)
198 	    break;
199 
200 	// When coming here from Insert mode, sync undo, so that this can be
201 	// undone separately from what was previously inserted.
202 	if (u_sync_once == 2)
203 	{
204 	    u_sync_once = 1; // notify that u_sync() was called
205 	    u_sync(TRUE);
206 	}
207 
208 	if (!append && lnum <= curbuf->b_ml.ml_line_count)
209 	{
210 	    // Existing line, replace it.
211 	    // Removes any existing text properties.
212 	    if (u_savesub(lnum) == OK && ml_replace_len(
213 		      lnum, line, (colnr_T)STRLEN(line) + 1, TRUE, TRUE) == OK)
214 	    {
215 		changed_bytes(lnum, 0);
216 		if (is_curbuf && lnum == curwin->w_cursor.lnum)
217 		    check_cursor_col();
218 		rettv->vval.v_number = 0;	// OK
219 	    }
220 	}
221 	else if (added > 0 || u_save(lnum - 1, lnum) == OK)
222 	{
223 	    // append the line
224 	    ++added;
225 	    if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
226 		rettv->vval.v_number = 0;	// OK
227 	}
228 
229 	if (l == NULL)			// only one string argument
230 	    break;
231 	++lnum;
232     }
233 
234     if (added > 0)
235     {
236 	win_T	    *wp;
237 	tabpage_T   *tp;
238 
239 	appended_lines_mark(append_lnum, added);
240 
241 	// Only adjust the cursor for buffers other than the current, unless it
242 	// is the current window.  For curbuf and other windows it has been
243 	// done in mark_adjust_internal().
244 	FOR_ALL_TAB_WINDOWS(tp, wp)
245 	    if (wp->w_buffer == buf
246 		    && (wp->w_buffer != curbuf || wp == curwin)
247 		    && wp->w_cursor.lnum > append_lnum)
248 		wp->w_cursor.lnum += added;
249 	check_cursor_col();
250 	update_topline();
251     }
252 
253     if (!is_curbuf)
254     {
255 	curbuf = curbuf_save;
256 	curwin = curwin_save;
257     }
258 }
259 
260 /*
261  * "append(lnum, string/list)" function
262  */
263     void
264 f_append(typval_T *argvars, typval_T *rettv)
265 {
266     linenr_T	lnum = tv_get_lnum(&argvars[0]);
267 
268     set_buffer_lines(curbuf, lnum, TRUE, &argvars[1], rettv);
269 }
270 
271 /*
272  * "appendbufline(buf, lnum, string/list)" function
273  */
274     void
275 f_appendbufline(typval_T *argvars, typval_T *rettv)
276 {
277     linenr_T	lnum;
278     buf_T	*buf;
279 
280     buf = tv_get_buf(&argvars[0], FALSE);
281     if (buf == NULL)
282 	rettv->vval.v_number = 1; // FAIL
283     else
284     {
285 	lnum = tv_get_lnum_buf(&argvars[1], buf);
286 	set_buffer_lines(buf, lnum, TRUE, &argvars[2], rettv);
287     }
288 }
289 
290 /*
291  * "bufadd(expr)" function
292  */
293     void
294 f_bufadd(typval_T *argvars, typval_T *rettv)
295 {
296     char_u *name = tv_get_string(&argvars[0]);
297 
298     rettv->vval.v_number = buflist_add(*name == NUL ? NULL : name, 0);
299 }
300 
301 /*
302  * "bufexists(expr)" function
303  */
304     void
305 f_bufexists(typval_T *argvars, typval_T *rettv)
306 {
307     rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
308 }
309 
310 /*
311  * "buflisted(expr)" function
312  */
313     void
314 f_buflisted(typval_T *argvars, typval_T *rettv)
315 {
316     buf_T	*buf;
317 
318     buf = find_buffer(&argvars[0]);
319     rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
320 }
321 
322 /*
323  * "bufload(expr)" function
324  */
325     void
326 f_bufload(typval_T *argvars, typval_T *rettv UNUSED)
327 {
328     buf_T	*buf = get_buf_arg(&argvars[0]);
329 
330     if (buf != NULL)
331 	buffer_ensure_loaded(buf);
332 }
333 
334 /*
335  * "bufloaded(expr)" function
336  */
337     void
338 f_bufloaded(typval_T *argvars, typval_T *rettv)
339 {
340     buf_T	*buf;
341 
342     buf = find_buffer(&argvars[0]);
343     rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
344 }
345 
346 /*
347  * "bufname(expr)" function
348  */
349     void
350 f_bufname(typval_T *argvars, typval_T *rettv)
351 {
352     buf_T	*buf;
353 
354     if (argvars[0].v_type == VAR_UNKNOWN)
355 	buf = curbuf;
356     else
357     {
358 	(void)tv_get_number(&argvars[0]);	// issue errmsg if type error
359 	++emsg_off;
360 	buf = tv_get_buf(&argvars[0], FALSE);
361 	--emsg_off;
362     }
363     rettv->v_type = VAR_STRING;
364     if (buf != NULL && buf->b_fname != NULL)
365 	rettv->vval.v_string = vim_strsave(buf->b_fname);
366     else
367 	rettv->vval.v_string = NULL;
368 }
369 
370 /*
371  * "bufnr(expr)" function
372  */
373     void
374 f_bufnr(typval_T *argvars, typval_T *rettv)
375 {
376     buf_T	*buf;
377     int		error = FALSE;
378     char_u	*name;
379 
380     if (argvars[0].v_type == VAR_UNKNOWN)
381 	buf = curbuf;
382     else
383     {
384 	(void)tv_get_number(&argvars[0]);    // issue errmsg if type error
385 	++emsg_off;
386 	buf = tv_get_buf(&argvars[0], FALSE);
387 	--emsg_off;
388     }
389 
390     // If the buffer isn't found and the second argument is not zero create a
391     // new buffer.
392     if (buf == NULL
393 	    && argvars[1].v_type != VAR_UNKNOWN
394 	    && tv_get_number_chk(&argvars[1], &error) != 0
395 	    && !error
396 	    && (name = tv_get_string_chk(&argvars[0])) != NULL
397 	    && !error)
398 	buf = buflist_new(name, NULL, (linenr_T)1, 0);
399 
400     if (buf != NULL)
401 	rettv->vval.v_number = buf->b_fnum;
402     else
403 	rettv->vval.v_number = -1;
404 }
405 
406     static void
407 buf_win_common(typval_T *argvars, typval_T *rettv, int get_nr)
408 {
409     win_T	*wp;
410     int		winnr = 0;
411     buf_T	*buf;
412 
413     (void)tv_get_number(&argvars[0]);	    // issue errmsg if type error
414     ++emsg_off;
415     buf = tv_get_buf(&argvars[0], TRUE);
416     FOR_ALL_WINDOWS(wp)
417     {
418 	++winnr;
419 	if (wp->w_buffer == buf)
420 	    break;
421     }
422     rettv->vval.v_number = (wp != NULL ? (get_nr ? winnr : wp->w_id) : -1);
423     --emsg_off;
424 }
425 
426 /*
427  * "bufwinid(nr)" function
428  */
429     void
430 f_bufwinid(typval_T *argvars, typval_T *rettv)
431 {
432     buf_win_common(argvars, rettv, FALSE);
433 }
434 
435 /*
436  * "bufwinnr(nr)" function
437  */
438     void
439 f_bufwinnr(typval_T *argvars, typval_T *rettv)
440 {
441     buf_win_common(argvars, rettv, TRUE);
442 }
443 
444 /*
445  * "deletebufline()" function
446  */
447     void
448 f_deletebufline(typval_T *argvars, typval_T *rettv)
449 {
450     buf_T	*buf;
451     linenr_T	first, last;
452     linenr_T	lnum;
453     long	count;
454     int		is_curbuf;
455     buf_T	*curbuf_save = NULL;
456     win_T	*curwin_save = NULL;
457     tabpage_T	*tp;
458     win_T	*wp;
459 
460     buf = tv_get_buf(&argvars[0], FALSE);
461     if (buf == NULL)
462     {
463 	rettv->vval.v_number = 1; // FAIL
464 	return;
465     }
466     is_curbuf = buf == curbuf;
467 
468     first = tv_get_lnum_buf(&argvars[1], buf);
469     if (argvars[2].v_type != VAR_UNKNOWN)
470 	last = tv_get_lnum_buf(&argvars[2], buf);
471     else
472 	last = first;
473 
474     if (buf->b_ml.ml_mfp == NULL || first < 1
475 			   || first > buf->b_ml.ml_line_count || last < first)
476     {
477 	rettv->vval.v_number = 1;	// FAIL
478 	return;
479     }
480 
481     if (!is_curbuf)
482     {
483 	curbuf_save = curbuf;
484 	curwin_save = curwin;
485 	curbuf = buf;
486 	find_win_for_curbuf();
487     }
488     if (last > curbuf->b_ml.ml_line_count)
489 	last = curbuf->b_ml.ml_line_count;
490     count = last - first + 1;
491 
492     // When coming here from Insert mode, sync undo, so that this can be
493     // undone separately from what was previously inserted.
494     if (u_sync_once == 2)
495     {
496 	u_sync_once = 1; // notify that u_sync() was called
497 	u_sync(TRUE);
498     }
499 
500     if (u_save(first - 1, last + 1) == FAIL)
501     {
502 	rettv->vval.v_number = 1;	// FAIL
503 	return;
504     }
505 
506     for (lnum = first; lnum <= last; ++lnum)
507 	ml_delete(first, TRUE);
508 
509     FOR_ALL_TAB_WINDOWS(tp, wp)
510 	if (wp->w_buffer == buf)
511 	{
512 	    if (wp->w_cursor.lnum > last)
513 		wp->w_cursor.lnum -= count;
514 	    else if (wp->w_cursor.lnum> first)
515 		wp->w_cursor.lnum = first;
516 	    if (wp->w_cursor.lnum > wp->w_buffer->b_ml.ml_line_count)
517 		wp->w_cursor.lnum = wp->w_buffer->b_ml.ml_line_count;
518 	}
519     check_cursor_col();
520     deleted_lines_mark(first, count);
521 
522     if (!is_curbuf)
523     {
524 	curbuf = curbuf_save;
525 	curwin = curwin_save;
526     }
527 }
528 
529 /*
530  * Returns buffer options, variables and other attributes in a dictionary.
531  */
532     static dict_T *
533 get_buffer_info(buf_T *buf)
534 {
535     dict_T	*dict;
536     tabpage_T	*tp;
537     win_T	*wp;
538     list_T	*windows;
539 
540     dict = dict_alloc();
541     if (dict == NULL)
542 	return NULL;
543 
544     dict_add_number(dict, "bufnr", buf->b_fnum);
545     dict_add_string(dict, "name", buf->b_ffname);
546     dict_add_number(dict, "lnum", buf == curbuf ? curwin->w_cursor.lnum
547 						     : buflist_findlnum(buf));
548     dict_add_number(dict, "loaded", buf->b_ml.ml_mfp != NULL);
549     dict_add_number(dict, "listed", buf->b_p_bl);
550     dict_add_number(dict, "changed", bufIsChanged(buf));
551     dict_add_number(dict, "changedtick", CHANGEDTICK(buf));
552     dict_add_number(dict, "hidden",
553 			    buf->b_ml.ml_mfp != NULL && buf->b_nwindows == 0);
554 
555     // Get a reference to buffer variables
556     dict_add_dict(dict, "variables", buf->b_vars);
557 
558     // List of windows displaying this buffer
559     windows = list_alloc();
560     if (windows != NULL)
561     {
562 	FOR_ALL_TAB_WINDOWS(tp, wp)
563 	    if (wp->w_buffer == buf)
564 		list_append_number(windows, (varnumber_T)wp->w_id);
565 	dict_add_list(dict, "windows", windows);
566     }
567 
568 #ifdef FEAT_TEXT_PROP
569     // List of popup windows displaying this buffer
570     windows = list_alloc();
571     if (windows != NULL)
572     {
573 	for (wp = first_popupwin; wp != NULL; wp = wp->w_next)
574 	    if (wp->w_buffer == buf)
575 		list_append_number(windows, (varnumber_T)wp->w_id);
576 	FOR_ALL_TABPAGES(tp)
577 	    for (wp = tp->tp_first_popupwin; wp != NULL; wp = wp->w_next)
578 		if (wp->w_buffer == buf)
579 		    list_append_number(windows, (varnumber_T)wp->w_id);
580 
581 	dict_add_list(dict, "popups", windows);
582     }
583 #endif
584 
585 #ifdef FEAT_SIGNS
586     if (buf->b_signlist != NULL)
587     {
588 	// List of signs placed in this buffer
589 	list_T	*signs = list_alloc();
590 	if (signs != NULL)
591 	{
592 	    get_buffer_signs(buf, signs);
593 	    dict_add_list(dict, "signs", signs);
594 	}
595     }
596 #endif
597 
598 #ifdef FEAT_VIMINFO
599     dict_add_number(dict, "lastused", buf->b_last_used);
600 #endif
601 
602     return dict;
603 }
604 
605 /*
606  * "getbufinfo()" function
607  */
608     void
609 f_getbufinfo(typval_T *argvars, typval_T *rettv)
610 {
611     buf_T	*buf = NULL;
612     buf_T	*argbuf = NULL;
613     dict_T	*d;
614     int		filtered = FALSE;
615     int		sel_buflisted = FALSE;
616     int		sel_bufloaded = FALSE;
617     int		sel_bufmodified = FALSE;
618 
619     if (rettv_list_alloc(rettv) != OK)
620 	return;
621 
622     // List of all the buffers or selected buffers
623     if (argvars[0].v_type == VAR_DICT)
624     {
625 	dict_T	*sel_d = argvars[0].vval.v_dict;
626 
627 	if (sel_d != NULL)
628 	{
629 	    dictitem_T	*di;
630 
631 	    filtered = TRUE;
632 
633 	    di = dict_find(sel_d, (char_u *)"buflisted", -1);
634 	    if (di != NULL && tv_get_number(&di->di_tv))
635 		sel_buflisted = TRUE;
636 
637 	    di = dict_find(sel_d, (char_u *)"bufloaded", -1);
638 	    if (di != NULL && tv_get_number(&di->di_tv))
639 		sel_bufloaded = TRUE;
640 
641 	    di = dict_find(sel_d, (char_u *)"bufmodified", -1);
642 	    if (di != NULL && tv_get_number(&di->di_tv))
643 		sel_bufmodified = TRUE;
644 	}
645     }
646     else if (argvars[0].v_type != VAR_UNKNOWN)
647     {
648 	// Information about one buffer.  Argument specifies the buffer
649 	(void)tv_get_number(&argvars[0]);   // issue errmsg if type error
650 	++emsg_off;
651 	argbuf = tv_get_buf(&argvars[0], FALSE);
652 	--emsg_off;
653 	if (argbuf == NULL)
654 	    return;
655     }
656 
657     // Return information about all the buffers or a specified buffer
658     FOR_ALL_BUFFERS(buf)
659     {
660 	if (argbuf != NULL && argbuf != buf)
661 	    continue;
662 	if (filtered && ((sel_bufloaded && buf->b_ml.ml_mfp == NULL)
663 			|| (sel_buflisted && !buf->b_p_bl)
664 			|| (sel_bufmodified && !buf->b_changed)))
665 	    continue;
666 
667 	d = get_buffer_info(buf);
668 	if (d != NULL)
669 	    list_append_dict(rettv->vval.v_list, d);
670 	if (argbuf != NULL)
671 	    return;
672     }
673 }
674 
675 /*
676  * Get line or list of lines from buffer "buf" into "rettv".
677  * Return a range (from start to end) of lines in rettv from the specified
678  * buffer.
679  * If 'retlist' is TRUE, then the lines are returned as a Vim List.
680  */
681     static void
682 get_buffer_lines(
683     buf_T	*buf,
684     linenr_T	start,
685     linenr_T	end,
686     int		retlist,
687     typval_T	*rettv)
688 {
689     char_u	*p;
690 
691     rettv->v_type = VAR_STRING;
692     rettv->vval.v_string = NULL;
693     if (retlist && rettv_list_alloc(rettv) == FAIL)
694 	return;
695 
696     if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
697 	return;
698 
699     if (!retlist)
700     {
701 	if (start >= 1 && start <= buf->b_ml.ml_line_count)
702 	    p = ml_get_buf(buf, start, FALSE);
703 	else
704 	    p = (char_u *)"";
705 	rettv->vval.v_string = vim_strsave(p);
706     }
707     else
708     {
709 	if (end < start)
710 	    return;
711 
712 	if (start < 1)
713 	    start = 1;
714 	if (end > buf->b_ml.ml_line_count)
715 	    end = buf->b_ml.ml_line_count;
716 	while (start <= end)
717 	    if (list_append_string(rettv->vval.v_list,
718 				 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
719 		break;
720     }
721 }
722 
723 /*
724  * "getbufline()" function
725  */
726     void
727 f_getbufline(typval_T *argvars, typval_T *rettv)
728 {
729     linenr_T	lnum;
730     linenr_T	end;
731     buf_T	*buf;
732 
733     (void)tv_get_number(&argvars[0]);	    // issue errmsg if type error
734     ++emsg_off;
735     buf = tv_get_buf(&argvars[0], FALSE);
736     --emsg_off;
737 
738     lnum = tv_get_lnum_buf(&argvars[1], buf);
739     if (argvars[2].v_type == VAR_UNKNOWN)
740 	end = lnum;
741     else
742 	end = tv_get_lnum_buf(&argvars[2], buf);
743 
744     get_buffer_lines(buf, lnum, end, TRUE, rettv);
745 }
746 
747 /*
748  * "getline(lnum, [end])" function
749  */
750     void
751 f_getline(typval_T *argvars, typval_T *rettv)
752 {
753     linenr_T	lnum;
754     linenr_T	end;
755     int		retlist;
756 
757     lnum = tv_get_lnum(argvars);
758     if (argvars[1].v_type == VAR_UNKNOWN)
759     {
760 	end = 0;
761 	retlist = FALSE;
762     }
763     else
764     {
765 	end = tv_get_lnum(&argvars[1]);
766 	retlist = TRUE;
767     }
768 
769     get_buffer_lines(curbuf, lnum, end, retlist, rettv);
770 }
771 
772 /*
773  * "setbufline()" function
774  */
775     void
776 f_setbufline(typval_T *argvars, typval_T *rettv)
777 {
778     linenr_T	lnum;
779     buf_T	*buf;
780 
781     buf = tv_get_buf(&argvars[0], FALSE);
782     if (buf == NULL)
783 	rettv->vval.v_number = 1; // FAIL
784     else
785     {
786 	lnum = tv_get_lnum_buf(&argvars[1], buf);
787 	set_buffer_lines(buf, lnum, FALSE, &argvars[2], rettv);
788     }
789 }
790 
791 /*
792  * "setline()" function
793  */
794     void
795 f_setline(typval_T *argvars, typval_T *rettv)
796 {
797     linenr_T	lnum = tv_get_lnum(&argvars[0]);
798 
799     set_buffer_lines(curbuf, lnum, FALSE, &argvars[1], rettv);
800 }
801 #endif  // FEAT_EVAL
802 
803 #if defined(FEAT_JOB_CHANNEL) \
804 	|| defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) \
805 	|| defined(PROTO)
806 /*
807  * Make "buf" the current buffer.  restore_buffer() MUST be called to undo.
808  * No autocommands will be executed.  Use aucmd_prepbuf() if there are any.
809  */
810     void
811 switch_buffer(bufref_T *save_curbuf, buf_T *buf)
812 {
813     block_autocmds();
814     set_bufref(save_curbuf, curbuf);
815     --curbuf->b_nwindows;
816     curbuf = buf;
817     curwin->w_buffer = buf;
818     ++curbuf->b_nwindows;
819 }
820 
821 /*
822  * Restore the current buffer after using switch_buffer().
823  */
824     void
825 restore_buffer(bufref_T *save_curbuf)
826 {
827     unblock_autocmds();
828     /* Check for valid buffer, just in case. */
829     if (bufref_valid(save_curbuf))
830     {
831 	--curbuf->b_nwindows;
832 	curwin->w_buffer = save_curbuf->br_buf;
833 	curbuf = save_curbuf->br_buf;
834 	++curbuf->b_nwindows;
835     }
836 }
837 
838 /*
839  * Find a window for buffer "buf".
840  * If found OK is returned and "wp" and "tp" are set to the window and tabpage.
841  * If not found FAIL is returned.
842  */
843     static int
844 find_win_for_buf(
845     buf_T     *buf,
846     win_T     **wp,
847     tabpage_T **tp)
848 {
849     FOR_ALL_TAB_WINDOWS(*tp, *wp)
850 	if ((*wp)->w_buffer == buf)
851 	    return OK;
852     return FAIL;
853 }
854 
855 /*
856  * Find a window that contains "buf" and switch to it.
857  * If there is no such window, use the current window and change "curbuf".
858  * Caller must initialize save_curbuf to NULL.
859  * restore_win_for_buf() MUST be called later!
860  */
861     void
862 switch_to_win_for_buf(
863     buf_T	*buf,
864     win_T	**save_curwinp,
865     tabpage_T	**save_curtabp,
866     bufref_T	*save_curbuf)
867 {
868     win_T	*wp;
869     tabpage_T	*tp;
870 
871     if (find_win_for_buf(buf, &wp, &tp) == FAIL)
872 	switch_buffer(save_curbuf, buf);
873     else if (switch_win(save_curwinp, save_curtabp, wp, tp, TRUE) == FAIL)
874     {
875 	restore_win(*save_curwinp, *save_curtabp, TRUE);
876 	switch_buffer(save_curbuf, buf);
877     }
878 }
879 
880     void
881 restore_win_for_buf(
882     win_T	*save_curwin,
883     tabpage_T	*save_curtab,
884     bufref_T	*save_curbuf)
885 {
886     if (save_curbuf->br_buf == NULL)
887 	restore_win(save_curwin, save_curtab, TRUE);
888     else
889 	restore_buffer(save_curbuf);
890 }
891 #endif
892