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