1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985-1987, 1993-1998, 2000-2011
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
35 #include "dispextern.h"
36 #include "blockinput.h"
37 #include "intervals.h"
38 #include "termhooks.h" /* For FRAME_TERMINAL. */
42 #endif /* HAVE_X_WINDOWS */
53 Lisp_Object Qwindowp
, Qwindow_live_p
;
54 static Lisp_Object Qwindow_configuration_p
, Qrecord_window_buffer
;
55 static Lisp_Object Qwindow_deletable_p
, Qdelete_window
, Qdisplay_buffer
;
56 static Lisp_Object Qreplace_buffer_in_windows
, Qget_mru_window
;
57 static Lisp_Object Qwindow_resize_root_window
, Qwindow_resize_root_window_vertically
;
58 static Lisp_Object Qscroll_up
, Qscroll_down
, Qscroll_command
;
59 static Lisp_Object Qsafe
, Qabove
, Qbelow
;
60 static Lisp_Object Qauto_buffer_name
;
62 static int displayed_window_lines (struct window
*);
63 static struct window
*decode_window (Lisp_Object
);
64 static int count_windows (struct window
*);
65 static int get_leaf_windows (struct window
*, struct window
**, int);
66 static void window_scroll (Lisp_Object
, EMACS_INT
, int, int);
67 static void window_scroll_pixel_based (Lisp_Object
, int, int, int);
68 static void window_scroll_line_based (Lisp_Object
, int, int, int);
69 static int freeze_window_start (struct window
*, void *);
70 static Lisp_Object
window_list (void);
71 static int add_window_to_list (struct window
*, void *);
72 static int candidate_window_p (Lisp_Object
, Lisp_Object
, Lisp_Object
,
74 static Lisp_Object
next_window (Lisp_Object
, Lisp_Object
,
76 static void decode_next_window_args (Lisp_Object
*, Lisp_Object
*,
78 static void foreach_window (struct frame
*,
79 int (* fn
) (struct window
*, void *),
81 static int foreach_window_1 (struct window
*,
82 int (* fn
) (struct window
*, void *),
84 static Lisp_Object
window_list_1 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
85 static int window_resize_check (struct window
*, int);
86 static void window_resize_apply (struct window
*, int);
87 static Lisp_Object
select_window (Lisp_Object
, Lisp_Object
, int);
89 /* This is the window in which the terminal's cursor should
90 be left when nothing is being done with it. This must
91 always be a leaf window, and its buffer is selected by
92 the top level editing loop at the end of each command.
94 This value is always the same as
95 FRAME_SELECTED_WINDOW (selected_frame). */
96 Lisp_Object selected_window
;
98 /* A list of all windows for use by next_window and Fwindow_list.
99 Functions creating or deleting windows should invalidate this cache
100 by setting it to nil. */
101 Lisp_Object Vwindow_list
;
103 /* The mini-buffer window of the selected frame.
104 Note that you cannot test for mini-bufferness of an arbitrary window
105 by comparing against this; but you can test for mini-bufferness of
106 the selected window. */
107 Lisp_Object minibuf_window
;
109 /* Non-nil means it is the window whose mode line should be
110 shown as the selected window when the minibuffer is selected. */
111 Lisp_Object minibuf_selected_window
;
113 /* Hook run at end of temp_output_buffer_show. */
114 static Lisp_Object Qtemp_buffer_show_hook
;
116 /* Incremented for each window created. */
117 static int sequence_number
;
119 /* Nonzero after init_window_once has finished. */
120 static int window_initialized
;
122 /* Hook to run when window config changes. */
123 static Lisp_Object Qwindow_configuration_change_hook
;
125 /* Used by the function window_scroll_pixel_based */
126 static int window_scroll_pixel_based_preserve_x
;
127 static int window_scroll_pixel_based_preserve_y
;
129 /* Same for window_scroll_line_based. */
130 static EMACS_INT window_scroll_preserve_hpos
;
131 static EMACS_INT window_scroll_preserve_vpos
;
133 static struct window
*
134 decode_window (register Lisp_Object window
)
137 return XWINDOW (selected_window
);
139 CHECK_LIVE_WINDOW (window
);
140 return XWINDOW (window
);
143 static struct window
*
144 decode_any_window (register Lisp_Object window
)
147 return XWINDOW (selected_window
);
149 CHECK_WINDOW (window
);
150 return XWINDOW (window
);
153 DEFUN ("windowp", Fwindowp
, Swindowp
, 1, 1, 0,
154 doc
: /* Return t if OBJECT is a window and nil otherwise. */)
157 return WINDOWP (object
) ? Qt
: Qnil
;
160 DEFUN ("window-live-p", Fwindow_live_p
, Swindow_live_p
, 1, 1, 0,
161 doc
: /* Return t if OBJECT is a live window and nil otherwise.
162 A live window is a window that displays a buffer. */)
165 return WINDOW_LIVE_P (object
) ? Qt
: Qnil
;
168 /* Frames and windows. */
169 DEFUN ("window-frame", Fwindow_frame
, Swindow_frame
, 1, 1, 0,
170 doc
: /* Return the frame that window WINDOW is on.
171 WINDOW can be any window and defaults to the selected one. */)
174 return decode_any_window (window
)->frame
;
177 DEFUN ("frame-root-window", Fframe_root_window
, Sframe_root_window
, 0, 1, 0,
178 doc
: /* Return the root window of FRAME_OR_WINDOW.
179 If omitted, FRAME_OR_WINDOW defaults to the currently selected frame.
180 Else if FRAME_OR_WINDOW denotes any window, return the root window of
181 that window's frame. If FRAME_OR_WINDOW denotes a live frame, return
182 the root window of that frame. */)
183 (Lisp_Object frame_or_window
)
187 if (NILP (frame_or_window
))
188 window
= SELECTED_FRAME ()->root_window
;
189 else if (WINDOWP (frame_or_window
))
190 window
= XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window
)))->root_window
;
193 CHECK_LIVE_FRAME (frame_or_window
);
194 window
= XFRAME (frame_or_window
)->root_window
;
200 DEFUN ("minibuffer-window", Fminibuffer_window
, Sminibuffer_window
, 0, 1, 0,
201 doc
: /* Return the window used now for minibuffers.
202 If the optional argument FRAME is specified, return the minibuffer window
203 used by that frame. */)
207 frame
= selected_frame
;
208 CHECK_LIVE_FRAME (frame
);
209 return FRAME_MINIBUF_WINDOW (XFRAME (frame
));
212 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p
,
213 Swindow_minibuffer_p
, 0, 1, 0,
214 doc
: /* Return non-nil if WINDOW is a minibuffer window.
215 WINDOW can be any window and defaults to the selected one. */)
218 return MINI_WINDOW_P (decode_any_window (window
)) ? Qt
: Qnil
;
221 /* Don't move this to window.el - this must be a safe routine. */
222 DEFUN ("frame-first-window", Fframe_first_window
, Sframe_first_window
, 0, 1, 0,
223 doc
: /* Return the topmost, leftmost live window on FRAME_OR_WINDOW.
224 If omitted, FRAME_OR_WINDOW defaults to the currently selected frame.
225 Else if FRAME_OR_WINDOW denotes any window, return the first window of
226 that window's frame. If FRAME_OR_WINDOW denotes a live frame, return
227 the first window of that frame. */)
228 (Lisp_Object frame_or_window
)
232 if (NILP (frame_or_window
))
233 window
= SELECTED_FRAME ()->root_window
;
234 else if (WINDOWP (frame_or_window
))
235 window
= XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window
)))->root_window
;
238 CHECK_LIVE_FRAME (frame_or_window
);
239 window
= XFRAME (frame_or_window
)->root_window
;
242 while (NILP (XWINDOW (window
)->buffer
))
244 if (! NILP (XWINDOW (window
)->hchild
))
245 window
= XWINDOW (window
)->hchild
;
246 else if (! NILP (XWINDOW (window
)->vchild
))
247 window
= XWINDOW (window
)->vchild
;
255 DEFUN ("frame-selected-window", Fframe_selected_window
,
256 Sframe_selected_window
, 0, 1, 0,
257 doc
: /* Return the selected window of FRAME_OR_WINDOW.
258 If omitted, FRAME_OR_WINDOW defaults to the currently selected frame.
259 Else if FRAME_OR_WINDOW denotes any window, return the selected window
260 of that window's frame. If FRAME_OR_WINDOW denotes a live frame, return
261 the selected window of that frame. */)
262 (Lisp_Object frame_or_window
)
266 if (NILP (frame_or_window
))
267 window
= SELECTED_FRAME ()->selected_window
;
268 else if (WINDOWP (frame_or_window
))
269 window
= XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window
)))->selected_window
;
272 CHECK_LIVE_FRAME (frame_or_window
);
273 window
= XFRAME (frame_or_window
)->selected_window
;
279 DEFUN ("set-frame-selected-window", Fset_frame_selected_window
,
280 Sset_frame_selected_window
, 2, 3, 0,
281 doc
: /* Set selected window of FRAME to WINDOW.
282 FRAME must be a live frame and defaults to the selected one. If FRAME
283 is the selected frame, this makes WINDOW the selected window. Optional
284 argument NORECORD non-nil means to neither change the order of recently
285 selected windows nor the buffer list. WINDOW must denote a live window.
287 (Lisp_Object frame
, Lisp_Object window
, Lisp_Object norecord
)
290 frame
= selected_frame
;
292 CHECK_LIVE_FRAME (frame
);
293 CHECK_LIVE_WINDOW (window
);
295 if (! EQ (frame
, WINDOW_FRAME (XWINDOW (window
))))
296 error ("In `set-frame-selected-window', WINDOW is not on FRAME");
298 if (EQ (frame
, selected_frame
))
299 return Fselect_window (window
, norecord
);
301 return XFRAME (frame
)->selected_window
= window
;
304 DEFUN ("selected-window", Fselected_window
, Sselected_window
, 0, 0, 0,
305 doc
: /* Return the selected window.
306 The selected window is the window in which the standard cursor for
307 selected windows appears and to which many commands apply. */)
310 return selected_window
;
313 int window_select_count
;
315 /* If select_window is called with inhibit_point_swap non-zero it will
316 not store point of the old selected window's buffer back into that
317 window's pointm slot. This is needed by Fset_window_configuration to
318 avoid that the display routine is called with selected_window set to
319 Qnil causing a subsequent crash. */
321 select_window (Lisp_Object window
, Lisp_Object norecord
, int inhibit_point_swap
)
323 register struct window
*w
;
324 register struct window
*ow
;
327 CHECK_LIVE_WINDOW (window
);
329 w
= XWINDOW (window
);
330 w
->frozen_window_start_p
= 0;
334 ++window_select_count
;
335 XSETFASTINT (w
->use_time
, window_select_count
);
336 record_buffer (w
->buffer
);
339 if (EQ (window
, selected_window
) && !inhibit_point_swap
)
342 sf
= SELECTED_FRAME ();
343 if (XFRAME (WINDOW_FRAME (w
)) != sf
)
345 XFRAME (WINDOW_FRAME (w
))->selected_window
= window
;
346 /* Use this rather than Fhandle_switch_frame
347 so that FRAME_FOCUS_FRAME is moved appropriately as we
348 move around in the state where a minibuffer in a separate
350 Fselect_frame (WINDOW_FRAME (w
), norecord
);
351 /* Fselect_frame called us back so we've done all the work already. */
352 eassert (EQ (window
, selected_window
));
356 sf
->selected_window
= window
;
358 /* Store the current buffer's actual point into the
359 old selected window. It belongs to that window,
360 and when the window is not selected, must be in the window. */
361 if (!inhibit_point_swap
)
363 ow
= XWINDOW (selected_window
);
364 if (! NILP (ow
->buffer
))
365 set_marker_both (ow
->pointm
, ow
->buffer
,
366 BUF_PT (XBUFFER (ow
->buffer
)),
367 BUF_PT_BYTE (XBUFFER (ow
->buffer
)));
370 selected_window
= window
;
372 Fset_buffer (w
->buffer
);
374 BVAR (XBUFFER (w
->buffer
), last_selected_window
) = window
;
376 /* Go to the point recorded in the window.
377 This is important when the buffer is in more
378 than one window. It also matters when
379 redisplay_window has altered point after scrolling,
380 because it makes the change only in the window. */
382 register ptrdiff_t new_point
= marker_position (w
->pointm
);
383 if (new_point
< BEGV
)
385 else if (new_point
> ZV
)
391 windows_or_buffers_changed
++;
395 DEFUN ("select-window", Fselect_window
, Sselect_window
, 1, 2, 0,
396 doc
: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
397 Also make WINDOW's buffer current and make WINDOW the frame's selected
398 window. Return WINDOW.
400 Optional second arg NORECORD non-nil means do not put this buffer at the
401 front of the buffer list and do not make this window the most recently
404 Note that the main editor command loop sets the current buffer to the
405 buffer of the selected window before each command. */)
406 (register Lisp_Object window
, Lisp_Object norecord
)
408 return select_window (window
, norecord
, 0);
411 DEFUN ("window-buffer", Fwindow_buffer
, Swindow_buffer
, 0, 1, 0,
412 doc
: /* Return the buffer that WINDOW is displaying.
413 WINDOW can be any window and defaults to the selected one.
414 If WINDOW is an internal window return nil. */)
417 return decode_any_window (window
)->buffer
;
420 DEFUN ("window-parent", Fwindow_parent
, Swindow_parent
, 0, 1, 0,
421 doc
: /* Return WINDOW's parent window.
422 WINDOW can be any window and defaults to the selected one.
423 Return nil if WINDOW has no parent. */)
426 return decode_any_window (window
)->parent
;
429 DEFUN ("window-top-child", Fwindow_top_child
, Swindow_top_child
, 0, 1, 0,
430 doc
: /* Return WINDOW's topmost child window.
431 WINDOW can be any window and defaults to the selected one.
432 Return nil if WINDOW is not a vertical combination. */)
435 return decode_any_window (window
)->vchild
;
438 DEFUN ("window-left-child", Fwindow_left_child
, Swindow_left_child
, 0, 1, 0,
439 doc
: /* Return WINDOW's leftmost child window.
440 WINDOW can be any window and defaults to the selected one.
441 Return nil if WINDOW is not a horizontal combination. */)
444 return decode_any_window (window
)->hchild
;
447 DEFUN ("window-next-sibling", Fwindow_next_sibling
, Swindow_next_sibling
, 0, 1, 0,
448 doc
: /* Return WINDOW's next sibling window.
449 WINDOW can be any window and defaults to the selected one.
450 Return nil if WINDOW has no next sibling. */)
453 return decode_any_window (window
)->next
;
456 DEFUN ("window-prev-sibling", Fwindow_prev_sibling
, Swindow_prev_sibling
, 0, 1, 0,
457 doc
: /* Return WINDOW's previous sibling window.
458 WINDOW can be any window and defaults to the selected one.
459 Return nil if WINDOW has no previous sibling. */)
462 return decode_any_window (window
)->prev
;
465 DEFUN ("window-splits", Fwindow_splits
, Swindow_splits
, 0, 1, 0,
466 doc
: /* Return splits status for WINDOW.
467 WINDOW can be any window and defaults to the selected one.
469 If the value returned by this function is nil and WINDOW is resized, the
470 corresponding space is preferably taken from (or given to) WINDOW's
471 right sibling. When WINDOW is deleted, its space is given to its left
474 If the value returned by this function is non-nil, resizing and deleting
475 WINDOW may resize all windows in the same combination. */)
478 return decode_any_window (window
)->splits
;
481 DEFUN ("set-window-splits", Fset_window_splits
, Sset_window_splits
, 2, 2, 0,
482 doc
: /* Set splits status of WINDOW to STATUS.
483 WINDOW can be any window and defaults to the selected one. Return
486 If STATUS is nil and WINDOW is later resized, the corresponding space is
487 preferably taken from (or given to) WINDOW's right sibling. When WINDOW
488 is deleted, its space is given to its left sibling.
490 If STATUS is non-nil, resizing and deleting WINDOW may resize all
491 windows in the same combination. */)
492 (Lisp_Object window
, Lisp_Object status
)
494 register struct window
*w
= decode_any_window (window
);
501 DEFUN ("window-nest", Fwindow_nest
, Swindow_nest
, 0, 1, 0,
502 doc
: /* Return nest status of WINDOW.
503 WINDOW can be any window and defaults to the selected one.
505 If the return value is nil, subwindows of WINDOW can be recombined with
506 WINDOW's siblings. A return value of non-nil means that subwindows of
507 WINDOW are never \(re-)combined with WINDOW's siblings. */)
510 return decode_any_window (window
)->nest
;
513 DEFUN ("set-window-nest", Fset_window_nest
, Sset_window_nest
, 2, 2, 0,
514 doc
: /* Set nest status of WINDOW to STATUS.
515 WINDOW can be any window and defaults to the selected one. Return
518 If STATUS is nil, subwindows of WINDOW can be recombined with WINDOW's
519 siblings. STATUS non-nil means that subwindows of WINDOW are never
520 \(re-)combined with WINDOW's siblings. */)
521 (Lisp_Object window
, Lisp_Object status
)
523 register struct window
*w
= decode_any_window (window
);
530 DEFUN ("window-use-time", Fwindow_use_time
, Swindow_use_time
, 0, 1, 0,
531 doc
: /* Return WINDOW's use time.
532 WINDOW defaults to the selected window. The window with the highest use
533 time is the most recently selected one. The window with the lowest use
534 time is the least recently selected one. */)
537 return decode_window (window
)->use_time
;
540 DEFUN ("window-total-size", Fwindow_total_size
, Swindow_total_size
, 0, 2, 0,
541 doc
: /* Return the total number of lines of WINDOW.
542 WINDOW can be any window and defaults to the selected one. The return
543 value includes WINDOW's mode line and header line, if any. If WINDOW
544 is internal, the return value is the sum of the total number of lines
545 of WINDOW's child windows if these are vertically combined and the
546 height of WINDOW's first child otherwise.
548 Optional argument HORIZONTAL non-nil means return the total number of
549 columns of WINDOW. In this case the return value includes any vertical
550 dividers or scrollbars of WINDOW. If WINDOW is internal, the return
551 value is the sum of the total number of columns of WINDOW's child
552 windows if they are horizontally combined and the width of WINDOW's
553 first child otherwise. */)
554 (Lisp_Object window
, Lisp_Object horizontal
)
556 if (NILP (horizontal
))
557 return decode_any_window (window
)->total_lines
;
559 return decode_any_window (window
)->total_cols
;
562 DEFUN ("window-new-total", Fwindow_new_total
, Swindow_new_total
, 0, 1, 0,
563 doc
: /* Return new total size of WINDOW.
564 WINDOW defaults to the selected window. */)
567 return decode_any_window (window
)->new_total
;
570 DEFUN ("window-normal-size", Fwindow_normal_size
, Swindow_normal_size
, 0, 2, 0,
571 doc
: /* Return normal height of WINDOW.
572 WINDOW can be any window and defaults to the selected one. Optional
573 argument HORIZONTAL non-nil means return normal width of WINDOW. */)
574 (Lisp_Object window
, Lisp_Object horizontal
)
576 if (NILP (horizontal
))
577 return decode_any_window (window
)->normal_lines
;
579 return decode_any_window (window
)->normal_cols
;
582 DEFUN ("window-new-normal", Fwindow_new_normal
, Swindow_new_normal
, 0, 1, 0,
583 doc
: /* Return new normal size of WINDOW.
584 WINDOW can be any window and defaults to the selected one. */)
587 return decode_any_window (window
)->new_normal
;
590 DEFUN ("window-left-column", Fwindow_left_column
, Swindow_left_column
, 0, 1, 0,
591 doc
: /* Return left column of WINDOW.
592 WINDOW can be any window and defaults to the selected one. */)
595 return decode_any_window (window
)->left_col
;
598 DEFUN ("window-top-line", Fwindow_top_line
, Swindow_top_line
, 0, 1, 0,
599 doc
: /* Return top line of WINDOW.
600 WINDOW can be any window and defaults to the selected one. */)
603 return decode_any_window (window
)->top_line
;
606 /* Return the number of lines of W's body. Don't count any mode or
610 window_body_lines (struct window
*w
)
612 int height
= XFASTINT (w
->total_lines
);
614 if (!MINI_WINDOW_P (w
))
616 if (WINDOW_WANTS_MODELINE_P (w
))
618 if (WINDOW_WANTS_HEADER_LINE_P (w
))
625 /* Return the number of columns of W's body. Don't count columns
626 occupied by the scroll bar or the vertical bar separating W from its
627 right sibling. On window-systems don't count fringes or display
631 window_body_cols (struct window
*w
)
633 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
634 int width
= XINT (w
->total_cols
);
636 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
637 /* Scroll bars occupy a few columns. */
638 width
-= WINDOW_CONFIG_SCROLL_BAR_COLS (w
);
639 else if (!FRAME_WINDOW_P (f
)
640 && !WINDOW_RIGHTMOST_P (w
) && !WINDOW_FULL_WIDTH_P (w
))
641 /* The column of `|' characters separating side-by-side windows
642 occupies one column only. */
645 if (FRAME_WINDOW_P (f
))
646 /* On window-systems, fringes and display margins cannot be
647 used for normal text. */
648 width
-= (WINDOW_FRINGE_COLS (w
)
649 + WINDOW_LEFT_MARGIN_COLS (w
)
650 + WINDOW_RIGHT_MARGIN_COLS (w
));
655 DEFUN ("window-body-size", Fwindow_body_size
, Swindow_body_size
, 0, 2, 0,
656 doc
: /* Return the number of lines of WINDOW's body.
657 WINDOW must be a live window and defaults to the selected one. The
658 return value does not include WINDOW's mode line and header line, if
661 Optional argument HORIZONTAL non-nil means return the number of columns
662 of WINDOW's body. In this case, the return value does not include any
663 vertical dividers or scroll bars owned by WINDOW. On a window-system
664 the return value does not include the number of columns used for
665 WINDOW's fringes or display margins either. */)
666 (Lisp_Object window
, Lisp_Object horizontal
)
668 struct window
*w
= decode_any_window (window
);
670 if (NILP (horizontal
))
671 return make_number (window_body_lines (w
));
673 return make_number (window_body_cols (w
));
676 DEFUN ("window-hscroll", Fwindow_hscroll
, Swindow_hscroll
, 0, 1, 0,
677 doc
: /* Return the number of columns by which WINDOW is scrolled from left margin.
678 WINDOW must be a live window and defaults to the selected one. */)
681 return decode_window (window
)->hscroll
;
684 DEFUN ("set-window-hscroll", Fset_window_hscroll
, Sset_window_hscroll
, 2, 2, 0,
685 doc
: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
686 If WINDOW is nil, the selected window is used.
687 Return NCOL. NCOL should be zero or positive.
689 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
690 window so that the location of point moves off-window. */)
691 (Lisp_Object window
, Lisp_Object ncol
)
693 struct window
*w
= decode_window (window
);
697 hscroll
= clip_to_bounds (0, XINT (ncol
), PTRDIFF_MAX
);
699 /* Prevent redisplay shortcuts when changing the hscroll. */
700 if (XINT (w
->hscroll
) != hscroll
)
701 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
703 w
->hscroll
= make_number (hscroll
);
707 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger
,
708 Swindow_redisplay_end_trigger
, 0, 1, 0,
709 doc
: /* Return WINDOW's redisplay end trigger value.
710 WINDOW defaults to the selected window.
711 See `set-window-redisplay-end-trigger' for more information. */)
714 return decode_window (window
)->redisplay_end_trigger
;
717 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger
,
718 Sset_window_redisplay_end_trigger
, 2, 2, 0,
719 doc
: /* Set WINDOW's redisplay end trigger value to VALUE.
720 VALUE should be a buffer position (typically a marker) or nil.
721 If it is a buffer position, then if redisplay in WINDOW reaches a position
722 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
723 with two arguments: WINDOW, and the end trigger value.
724 Afterwards the end-trigger value is reset to nil. */)
725 (register Lisp_Object window
, Lisp_Object value
)
727 register struct window
*w
;
729 w
= decode_window (window
);
730 w
->redisplay_end_trigger
= value
;
734 DEFUN ("window-edges", Fwindow_edges
, Swindow_edges
, 0, 1, 0,
735 doc
: /* Return a list of the edge coordinates of WINDOW.
736 The list has the form (LEFT TOP RIGHT BOTTOM).
737 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
738 all relative to 0, 0 at top left corner of frame.
740 RIGHT is one more than the rightmost column occupied by WINDOW.
741 BOTTOM is one more than the bottommost row occupied by WINDOW.
742 The edges include the space used by WINDOW's scroll bar, display
743 margins, fringes, header line, and/or mode line. For the edges of
744 just the text area, use `window-inside-edges'. */)
747 register struct window
*w
= decode_any_window (window
);
749 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w
)),
750 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w
)),
751 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w
)),
752 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w
)),
756 DEFUN ("window-pixel-edges", Fwindow_pixel_edges
, Swindow_pixel_edges
, 0, 1, 0,
757 doc
: /* Return a list of the edge pixel coordinates of WINDOW.
758 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
759 the top left corner of the frame.
761 RIGHT is one more than the rightmost x position occupied by WINDOW.
762 BOTTOM is one more than the bottommost y position occupied by WINDOW.
763 The pixel edges include the space used by WINDOW's scroll bar, display
764 margins, fringes, header line, and/or mode line. For the pixel edges
765 of just the text area, use `window-inside-pixel-edges'. */)
768 register struct window
*w
= decode_any_window (window
);
770 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w
)),
771 Fcons (make_number (WINDOW_TOP_EDGE_Y (w
)),
772 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w
)),
773 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w
)),
778 calc_absolute_offset (struct window
*w
, int *add_x
, int *add_y
)
780 struct frame
*f
= XFRAME (w
->frame
);
782 #ifdef FRAME_MENUBAR_HEIGHT
783 *add_y
+= FRAME_MENUBAR_HEIGHT (f
);
785 #ifdef FRAME_TOOLBAR_TOP_HEIGHT
786 *add_y
+= FRAME_TOOLBAR_TOP_HEIGHT (f
);
787 #elif FRAME_TOOLBAR_HEIGHT
788 *add_y
+= FRAME_TOOLBAR_HEIGHT (f
);
790 #ifdef FRAME_NS_TITLEBAR_HEIGHT
791 *add_y
+= FRAME_NS_TITLEBAR_HEIGHT (f
);
793 *add_x
= f
->left_pos
;
794 #ifdef FRAME_TOOLBAR_LEFT_WIDTH
795 *add_x
+= FRAME_TOOLBAR_LEFT_WIDTH (f
);
799 DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges
,
800 Swindow_absolute_pixel_edges
, 0, 1, 0,
801 doc
: /* Return a list of the edge pixel coordinates of WINDOW.
802 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
803 the top left corner of the display.
805 RIGHT is one more than the rightmost x position occupied by WINDOW.
806 BOTTOM is one more than the bottommost y position occupied by WINDOW.
807 The pixel edges include the space used by WINDOW's scroll bar, display
808 margins, fringes, header line, and/or mode line. For the pixel edges
809 of just the text area, use `window-inside-absolute-pixel-edges'. */)
812 register struct window
*w
= decode_any_window (window
);
814 calc_absolute_offset (w
, &add_x
, &add_y
);
816 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w
) + add_x
),
817 Fcons (make_number (WINDOW_TOP_EDGE_Y (w
) + add_y
),
818 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w
) + add_x
),
819 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w
) + add_y
),
823 DEFUN ("window-inside-edges", Fwindow_inside_edges
, Swindow_inside_edges
, 0, 1, 0,
824 doc
: /* Return a list of the edge coordinates of WINDOW.
825 The list has the form (LEFT TOP RIGHT BOTTOM).
826 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
827 all relative to 0, 0 at top left corner of frame.
829 RIGHT is one more than the rightmost column of WINDOW's text area.
830 BOTTOM is one more than the bottommost row of WINDOW's text area.
831 The inside edges do not include the space used by the WINDOW's scroll
832 bar, display margins, fringes, header line, and/or mode line. */)
835 register struct window
*w
= decode_any_window (window
);
837 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w
)
838 + WINDOW_LEFT_MARGIN_COLS (w
)
839 + WINDOW_LEFT_FRINGE_COLS (w
)),
840 make_number (WINDOW_TOP_EDGE_LINE (w
)
841 + WINDOW_HEADER_LINE_LINES (w
)),
842 make_number (WINDOW_BOX_RIGHT_EDGE_COL (w
)
843 - WINDOW_RIGHT_MARGIN_COLS (w
)
844 - WINDOW_RIGHT_FRINGE_COLS (w
)),
845 make_number (WINDOW_BOTTOM_EDGE_LINE (w
)
846 - WINDOW_MODE_LINE_LINES (w
)));
849 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges
, Swindow_inside_pixel_edges
, 0, 1, 0,
850 doc
: /* Return a list of the edge pixel coordinates of WINDOW.
851 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
852 the top left corner of the frame.
854 RIGHT is one more than the rightmost x position of WINDOW's text area.
855 BOTTOM is one more than the bottommost y position of WINDOW's text area.
856 The inside edges do not include the space used by WINDOW's scroll bar,
857 display margins, fringes, header line, and/or mode line. */)
860 register struct window
*w
= decode_any_window (window
);
862 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w
)
863 + WINDOW_LEFT_MARGIN_WIDTH (w
)
864 + WINDOW_LEFT_FRINGE_WIDTH (w
)),
865 make_number (WINDOW_TOP_EDGE_Y (w
)
866 + WINDOW_HEADER_LINE_HEIGHT (w
)),
867 make_number (WINDOW_BOX_RIGHT_EDGE_X (w
)
868 - WINDOW_RIGHT_MARGIN_WIDTH (w
)
869 - WINDOW_RIGHT_FRINGE_WIDTH (w
)),
870 make_number (WINDOW_BOTTOM_EDGE_Y (w
)
871 - WINDOW_MODE_LINE_HEIGHT (w
)));
874 DEFUN ("window-inside-absolute-pixel-edges",
875 Fwindow_inside_absolute_pixel_edges
,
876 Swindow_inside_absolute_pixel_edges
, 0, 1, 0,
877 doc
: /* Return a list of the edge pixel coordinates of WINDOW.
878 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
879 the top left corner of the display.
881 RIGHT is one more than the rightmost x position of WINDOW's text area.
882 BOTTOM is one more than the bottommost y position of WINDOW's text area.
883 The inside edges do not include the space used by WINDOW's scroll bar,
884 display margins, fringes, header line, and/or mode line. */)
887 register struct window
*w
= decode_any_window (window
);
889 calc_absolute_offset (w
, &add_x
, &add_y
);
891 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w
)
892 + WINDOW_LEFT_MARGIN_WIDTH (w
)
893 + WINDOW_LEFT_FRINGE_WIDTH (w
) + add_x
),
894 make_number (WINDOW_TOP_EDGE_Y (w
)
895 + WINDOW_HEADER_LINE_HEIGHT (w
) + add_y
),
896 make_number (WINDOW_BOX_RIGHT_EDGE_X (w
)
897 - WINDOW_RIGHT_MARGIN_WIDTH (w
)
898 - WINDOW_RIGHT_FRINGE_WIDTH (w
) + add_x
),
899 make_number (WINDOW_BOTTOM_EDGE_Y (w
)
900 - WINDOW_MODE_LINE_HEIGHT (w
) + add_y
));
903 /* Test if the character at column X, row Y is within window W.
904 If it is not, return ON_NOTHING;
905 if it is in the window's text area, return ON_TEXT;
906 if it is on the window's modeline, return ON_MODE_LINE;
907 if it is on the border between the window and its right sibling,
908 return ON_VERTICAL_BORDER.
909 if it is on a scroll bar, return ON_SCROLL_BAR.
910 if it is on the window's top line, return ON_HEADER_LINE;
911 if it is in left or right fringe of the window,
912 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
913 if it is in the marginal area to the left/right of the window,
914 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
916 X and Y are frame relative pixel coordinates. */
918 static enum window_part
919 coordinates_in_window (register struct window
*w
, int x
, int y
)
921 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
923 enum window_part part
;
924 int ux
= FRAME_COLUMN_WIDTH (f
);
925 int x0
= WINDOW_LEFT_EDGE_X (w
);
926 int x1
= WINDOW_RIGHT_EDGE_X (w
);
927 /* The width of the area where the vertical line can be dragged.
928 (Between mode lines for instance. */
929 int grabbable_width
= ux
;
930 int lmargin_width
, rmargin_width
, text_left
, text_right
;
931 int top_y
= WINDOW_TOP_EDGE_Y (w
);
932 int bottom_y
= WINDOW_BOTTOM_EDGE_Y (w
);
934 /* Outside any interesting row? */
935 if (y
< top_y
|| y
>= bottom_y
)
938 /* In what's below, we subtract 1 when computing right_x because we
939 want the rightmost pixel, which is given by left_pixel+width-1. */
940 if (w
->pseudo_window_p
)
943 right_x
= WINDOW_TOTAL_WIDTH (w
) - 1;
947 left_x
= WINDOW_BOX_LEFT_EDGE_X (w
);
948 right_x
= WINDOW_BOX_RIGHT_EDGE_X (w
) - 1;
951 /* On the mode line or header line? If it's near the start of
952 the mode or header line of window that's has a horizontal
953 sibling, say it's on the vertical line. That's to be able
954 to resize windows horizontally in case we're using toolkit
957 if (WINDOW_WANTS_MODELINE_P (w
)
958 && y
>= bottom_y
- CURRENT_MODE_LINE_HEIGHT (w
))
962 header_vertical_border_check
:
963 /* We're somewhere on the mode line. We consider the place
964 between mode lines of horizontally adjacent mode lines
965 as the vertical border. If scroll bars on the left,
966 return the right window. */
967 if ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
968 || WINDOW_RIGHTMOST_P (w
))
969 && !WINDOW_LEFTMOST_P (w
)
970 && eabs (x
- x0
) < grabbable_width
)
971 return ON_VERTICAL_BORDER
;
973 /* Make sure we're not at the rightmost position of a
974 mode-/header-line and there's yet another window on the
976 else if ((WINDOW_RIGHTMOST_P (w
) || x
< x1
)
977 && eabs (x
- x1
) < grabbable_width
)
978 return ON_VERTICAL_BORDER
;
980 if (x
< x0
|| x
>= x1
)
986 if (WINDOW_WANTS_HEADER_LINE_P (w
)
987 && y
< top_y
+ CURRENT_HEADER_LINE_HEIGHT (w
))
989 part
= ON_HEADER_LINE
;
990 goto header_vertical_border_check
;
993 if (x
< x0
|| x
>= x1
) return ON_NOTHING
;
995 /* Outside any interesting column? */
996 if (x
< left_x
|| x
> right_x
)
997 return ON_SCROLL_BAR
;
999 lmargin_width
= window_box_width (w
, LEFT_MARGIN_AREA
);
1000 rmargin_width
= window_box_width (w
, RIGHT_MARGIN_AREA
);
1002 text_left
= window_box_left (w
, TEXT_AREA
);
1003 text_right
= text_left
+ window_box_width (w
, TEXT_AREA
);
1005 if (FRAME_WINDOW_P (f
))
1007 if (!w
->pseudo_window_p
1008 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
1009 && !WINDOW_RIGHTMOST_P (w
)
1010 && (eabs (x
- right_x
) < grabbable_width
))
1011 return ON_VERTICAL_BORDER
;
1013 /* Need to say "x > right_x" rather than >=, since on character
1014 terminals, the vertical line's x coordinate is right_x. */
1015 else if (!w
->pseudo_window_p
1016 && !WINDOW_RIGHTMOST_P (w
)
1017 && x
> right_x
- ux
)
1018 return ON_VERTICAL_BORDER
;
1022 if (lmargin_width
> 0
1023 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1024 ? (x
>= left_x
+ WINDOW_LEFT_FRINGE_WIDTH (w
))
1025 : (x
< left_x
+ lmargin_width
)))
1026 return ON_LEFT_MARGIN
;
1028 return ON_LEFT_FRINGE
;
1031 if (x
>= text_right
)
1033 if (rmargin_width
> 0
1034 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1035 ? (x
< right_x
- WINDOW_RIGHT_FRINGE_WIDTH (w
))
1036 : (x
>= right_x
- rmargin_width
)))
1037 return ON_RIGHT_MARGIN
;
1039 return ON_RIGHT_FRINGE
;
1042 /* Everything special ruled out - must be on text area */
1046 /* Take X is the frame-relative pixel x-coordinate, and return the
1047 x-coordinate relative to part PART of window W. */
1049 window_relative_x_coord (struct window
*w
, enum window_part part
, int x
)
1051 int left_x
= (w
->pseudo_window_p
) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w
);
1056 return x
- window_box_left (w
, TEXT_AREA
);
1058 case ON_LEFT_FRINGE
:
1061 case ON_RIGHT_FRINGE
:
1062 return x
- left_x
- WINDOW_LEFT_FRINGE_WIDTH (w
);
1064 case ON_LEFT_MARGIN
:
1066 - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1067 ? WINDOW_LEFT_FRINGE_WIDTH (w
) : 0));
1069 case ON_RIGHT_MARGIN
:
1071 - ((w
->pseudo_window_p
)
1072 ? WINDOW_TOTAL_WIDTH (w
)
1073 : WINDOW_BOX_RIGHT_EDGE_X (w
))
1074 + window_box_width (w
, RIGHT_MARGIN_AREA
)
1075 + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1076 ? WINDOW_RIGHT_FRINGE_WIDTH (w
) : 0));
1079 /* ON_SCROLL_BAR, ON_NOTHING, and ON_VERTICAL_BORDER: */
1084 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p
,
1085 Scoordinates_in_window_p
, 2, 2, 0,
1086 doc
: /* Return non-nil if COORDINATES are in WINDOW.
1087 COORDINATES is a cons of the form (X . Y), X and Y being distances
1088 measured in characters from the upper-left corner of the frame.
1089 \(0 . 0) denotes the character in the upper left corner of the
1091 If COORDINATES are in the text portion of WINDOW,
1092 the coordinates relative to the window are returned.
1093 If they are in the mode line of WINDOW, `mode-line' is returned.
1094 If they are in the top mode line of WINDOW, `header-line' is returned.
1095 If they are in the left fringe of WINDOW, `left-fringe' is returned.
1096 If they are in the right fringe of WINDOW, `right-fringe' is returned.
1097 If they are on the border between WINDOW and its right sibling,
1098 `vertical-line' is returned.
1099 If they are in the windows's left or right marginal areas, `left-margin'\n\
1100 or `right-margin' is returned. */)
1101 (register Lisp_Object coordinates
, Lisp_Object window
)
1108 CHECK_WINDOW (window
);
1109 w
= XWINDOW (window
);
1110 f
= XFRAME (w
->frame
);
1111 CHECK_CONS (coordinates
);
1112 lx
= Fcar (coordinates
);
1113 ly
= Fcdr (coordinates
);
1114 CHECK_NUMBER_OR_FLOAT (lx
);
1115 CHECK_NUMBER_OR_FLOAT (ly
);
1116 x
= FRAME_PIXEL_X_FROM_CANON_X (f
, lx
) + FRAME_INTERNAL_BORDER_WIDTH (f
);
1117 y
= FRAME_PIXEL_Y_FROM_CANON_Y (f
, ly
) + FRAME_INTERNAL_BORDER_WIDTH (f
);
1119 switch (coordinates_in_window (w
, x
, y
))
1125 /* Convert X and Y to window relative pixel coordinates, and
1126 return the canonical char units. */
1127 x
-= window_box_left (w
, TEXT_AREA
);
1128 y
-= WINDOW_TOP_EDGE_Y (w
);
1129 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f
, x
),
1130 FRAME_CANON_Y_FROM_PIXEL_Y (f
, y
));
1135 case ON_VERTICAL_BORDER
:
1136 return Qvertical_line
;
1138 case ON_HEADER_LINE
:
1139 return Qheader_line
;
1141 case ON_LEFT_FRINGE
:
1142 return Qleft_fringe
;
1144 case ON_RIGHT_FRINGE
:
1145 return Qright_fringe
;
1147 case ON_LEFT_MARGIN
:
1148 return Qleft_margin
;
1150 case ON_RIGHT_MARGIN
:
1151 return Qright_margin
;
1154 /* Historically we are supposed to return nil in this case. */
1163 /* Callback for foreach_window, used in window_from_coordinates.
1164 Check if window W contains coordinates specified by USER_DATA which
1165 is actually a pointer to a struct check_window_data CW.
1167 Check if window W contains coordinates *CW->x and *CW->y. If it
1168 does, return W in *CW->window, as Lisp_Object, and return in
1169 *CW->part the part of the window under coordinates *X,*Y. Return
1170 zero from this function to stop iterating over windows. */
1172 struct check_window_data
1174 Lisp_Object
*window
;
1176 enum window_part
*part
;
1180 check_window_containing (struct window
*w
, void *user_data
)
1182 struct check_window_data
*cw
= (struct check_window_data
*) user_data
;
1183 enum window_part found
;
1186 found
= coordinates_in_window (w
, cw
->x
, cw
->y
);
1187 if (found
!= ON_NOTHING
)
1190 XSETWINDOW (*cw
->window
, w
);
1198 /* Find the window containing frame-relative pixel position X/Y and
1199 return it as a Lisp_Object.
1201 If X, Y is on one of the window's special `window_part' elements,
1202 set *PART to the id of that element.
1204 If there is no window under X, Y return nil and leave *PART
1205 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1207 This function was previously implemented with a loop cycling over
1208 windows with Fnext_window, and starting with the frame's selected
1209 window. It turned out that this doesn't work with an
1210 implementation of next_window using Vwindow_list, because
1211 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1212 tree of F when this function is called asynchronously from
1213 note_mouse_highlight. The original loop didn't terminate in this
1217 window_from_coordinates (struct frame
*f
, int x
, int y
,
1218 enum window_part
*part
, int tool_bar_p
)
1221 struct check_window_data cw
;
1222 enum window_part dummy
;
1228 cw
.window
= &window
, cw
.x
= x
, cw
.y
= y
; cw
.part
= part
;
1229 foreach_window (f
, check_window_containing
, &cw
);
1231 /* If not found above, see if it's in the tool bar window, if a tool
1235 && WINDOWP (f
->tool_bar_window
)
1236 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0
1237 && (coordinates_in_window (XWINDOW (f
->tool_bar_window
), x
, y
)
1241 window
= f
->tool_bar_window
;
1247 DEFUN ("window-at", Fwindow_at
, Swindow_at
, 2, 3, 0,
1248 doc
: /* Return window containing coordinates X and Y on FRAME.
1249 FRAME must be a live frame and defaults to the selected one.
1250 The top left corner of the frame is considered to be row 0,
1252 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame
)
1257 frame
= selected_frame
;
1258 CHECK_LIVE_FRAME (frame
);
1261 /* Check that arguments are integers or floats. */
1262 CHECK_NUMBER_OR_FLOAT (x
);
1263 CHECK_NUMBER_OR_FLOAT (y
);
1265 return window_from_coordinates (f
,
1266 (FRAME_PIXEL_X_FROM_CANON_X (f
, x
)
1267 + FRAME_INTERNAL_BORDER_WIDTH (f
)),
1268 (FRAME_PIXEL_Y_FROM_CANON_Y (f
, y
)
1269 + FRAME_INTERNAL_BORDER_WIDTH (f
)),
1273 DEFUN ("window-point", Fwindow_point
, Swindow_point
, 0, 1, 0,
1274 doc
: /* Return current value of point in WINDOW.
1275 WINDOW must be a live window and defaults to the selected one.
1277 For a nonselected window, this is the value point would have
1278 if that window were selected.
1280 Note that, when WINDOW is the selected window and its buffer
1281 is also currently selected, the value returned is the same as (point).
1282 It would be more strictly correct to return the `top-level' value
1283 of point, outside of any save-excursion forms.
1284 But that is hard to define. */)
1285 (Lisp_Object window
)
1287 register struct window
*w
= decode_window (window
);
1289 if (w
== XWINDOW (selected_window
)
1290 && current_buffer
== XBUFFER (w
->buffer
))
1292 return Fmarker_position (w
->pointm
);
1295 DEFUN ("window-start", Fwindow_start
, Swindow_start
, 0, 1, 0,
1296 doc
: /* Return position at which display currently starts in WINDOW.
1297 WINDOW must be a live window and defaults to the selected one.
1298 This is updated by redisplay or by calling `set-window-start'. */)
1299 (Lisp_Object window
)
1301 return Fmarker_position (decode_window (window
)->start
);
1304 /* This is text temporarily removed from the doc string below.
1306 This function returns nil if the position is not currently known.
1307 That happens when redisplay is preempted and doesn't finish.
1308 If in that case you want to compute where the end of the window would
1309 have been if redisplay had finished, do this:
1311 (goto-char (window-start window))
1312 (vertical-motion (1- (window-height window)) window)
1315 DEFUN ("window-end", Fwindow_end
, Swindow_end
, 0, 2, 0,
1316 doc
: /* Return position at which display currently ends in WINDOW.
1317 WINDOW must be a live window and defaults to the selected one.
1318 This is updated by redisplay, when it runs to completion.
1319 Simply changing the buffer text or setting `window-start'
1320 does not update this value.
1321 Return nil if there is no recorded value. \(This can happen if the
1322 last redisplay of WINDOW was preempted, and did not finish.)
1323 If UPDATE is non-nil, compute the up-to-date position
1324 if it isn't already recorded. */)
1325 (Lisp_Object window
, Lisp_Object update
)
1328 struct window
*w
= decode_window (window
);
1336 #if 0 /* This change broke some things. We should make it later. */
1337 /* If we don't know the end position, return nil.
1338 The user can compute it with vertical-motion if he wants to.
1339 It would be nicer to do it automatically,
1340 but that's so slow that it would probably bother people. */
1341 if (NILP (w
->window_end_valid
))
1346 && ! (! NILP (w
->window_end_valid
)
1347 && XFASTINT (w
->last_modified
) >= BUF_MODIFF (b
)
1348 && XFASTINT (w
->last_overlay_modified
) >= BUF_OVERLAY_MODIFF (b
))
1351 struct text_pos startp
;
1353 struct buffer
*old_buffer
= NULL
;
1354 void *itdata
= NULL
;
1356 /* Cannot use Fvertical_motion because that function doesn't
1357 cope with variable-height lines. */
1358 if (b
!= current_buffer
)
1360 old_buffer
= current_buffer
;
1361 set_buffer_internal (b
);
1364 /* In case W->start is out of the range, use something
1365 reasonable. This situation occurred when loading a file with
1366 `-l' containing a call to `rmail' with subsequent other
1367 commands. At the end, W->start happened to be BEG, while
1368 rmail had already narrowed the buffer. */
1369 if (XMARKER (w
->start
)->charpos
< BEGV
)
1370 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
1371 else if (XMARKER (w
->start
)->charpos
> ZV
)
1372 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
1374 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
1376 itdata
= bidi_shelve_cache ();
1377 start_display (&it
, w
, startp
);
1378 move_it_vertically (&it
, window_box_height (w
));
1379 if (it
.current_y
< it
.last_visible_y
)
1380 move_it_past_eol (&it
);
1381 value
= make_number (IT_CHARPOS (it
));
1382 bidi_unshelve_cache (itdata
, 0);
1385 set_buffer_internal (old_buffer
);
1388 XSETINT (value
, BUF_Z (b
) - XFASTINT (w
->window_end_pos
));
1393 DEFUN ("set-window-point", Fset_window_point
, Sset_window_point
, 2, 2, 0,
1394 doc
: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1396 (Lisp_Object window
, Lisp_Object pos
)
1398 register struct window
*w
= decode_window (window
);
1400 CHECK_NUMBER_COERCE_MARKER (pos
);
1401 if (w
== XWINDOW (selected_window
)
1402 && XBUFFER (w
->buffer
) == current_buffer
)
1405 set_marker_restricted (w
->pointm
, pos
, w
->buffer
);
1407 /* We have to make sure that redisplay updates the window to show
1408 the new value of point. */
1409 if (!EQ (window
, selected_window
))
1410 ++windows_or_buffers_changed
;
1415 DEFUN ("set-window-start", Fset_window_start
, Sset_window_start
, 2, 3, 0,
1416 doc
: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1417 If WINDOW is nil, the selected window is used. Return POS.
1418 Optional third arg NOFORCE non-nil inhibits next redisplay from
1419 overriding motion of point in order to display at this exact start. */)
1420 (Lisp_Object window
, Lisp_Object pos
, Lisp_Object noforce
)
1422 register struct window
*w
= decode_window (window
);
1424 CHECK_NUMBER_COERCE_MARKER (pos
);
1425 set_marker_restricted (w
->start
, pos
, w
->buffer
);
1426 /* this is not right, but much easier than doing what is right. */
1427 w
->start_at_line_beg
= Qnil
;
1429 w
->force_start
= Qt
;
1430 w
->update_mode_line
= Qt
;
1431 XSETFASTINT (w
->last_modified
, 0);
1432 XSETFASTINT (w
->last_overlay_modified
, 0);
1433 if (!EQ (window
, selected_window
))
1434 windows_or_buffers_changed
++;
1439 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p
,
1440 Spos_visible_in_window_p
, 0, 3, 0,
1441 doc
: /* Return non-nil if position POS is currently on the frame in WINDOW.
1442 Return nil if that position is scrolled vertically out of view.
1443 If a character is only partially visible, nil is returned, unless the
1444 optional argument PARTIALLY is non-nil.
1445 If POS is only out of view because of horizontal scrolling, return non-nil.
1446 If POS is t, it specifies the position of the last visible glyph in WINDOW.
1447 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
1449 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
1450 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
1451 where X and Y are the pixel coordinates relative to the top left corner
1452 of the window. The remaining elements are omitted if the character after
1453 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
1454 off-window at the top and bottom of the row, ROWH is the height of the
1455 display row, and VPOS is the row number (0-based) containing POS. */)
1456 (Lisp_Object pos
, Lisp_Object window
, Lisp_Object partially
)
1458 register struct window
*w
;
1459 register EMACS_INT posint
;
1460 register struct buffer
*buf
;
1461 struct text_pos top
;
1462 Lisp_Object in_window
= Qnil
;
1463 int rtop
, rbot
, rowh
, vpos
, fully_p
= 1;
1466 w
= decode_window (window
);
1467 buf
= XBUFFER (w
->buffer
);
1468 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1472 else if (!NILP (pos
))
1474 CHECK_NUMBER_COERCE_MARKER (pos
);
1475 posint
= XINT (pos
);
1477 else if (w
== XWINDOW (selected_window
))
1480 posint
= XMARKER (w
->pointm
)->charpos
;
1482 /* If position is above window start or outside buffer boundaries,
1483 or if window start is out of range, position is not visible. */
1485 || (posint
>= CHARPOS (top
) && posint
<= BUF_ZV (buf
)))
1486 && CHARPOS (top
) >= BUF_BEGV (buf
)
1487 && CHARPOS (top
) <= BUF_ZV (buf
)
1488 && pos_visible_p (w
, posint
, &x
, &y
, &rtop
, &rbot
, &rowh
, &vpos
)
1489 && (fully_p
= !rtop
&& !rbot
, (!NILP (partially
) || fully_p
)))
1492 if (!NILP (in_window
) && !NILP (partially
))
1494 Lisp_Object part
= Qnil
;
1496 part
= list4 (make_number (rtop
), make_number (rbot
),
1497 make_number (rowh
), make_number (vpos
));
1498 in_window
= Fcons (make_number (x
),
1499 Fcons (make_number (y
), part
));
1505 DEFUN ("window-line-height", Fwindow_line_height
,
1506 Swindow_line_height
, 0, 2, 0,
1507 doc
: /* Return height in pixels of text line LINE in window WINDOW.
1508 WINDOW defaults to the selected window.
1510 Return height of current line if LINE is omitted or nil. Return height of
1511 header or mode line if LINE is `header-line' or `mode-line'.
1512 Otherwise, LINE is a text line number starting from 0. A negative number
1513 counts from the end of the window.
1515 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
1516 in pixels of the visible part of the line, VPOS and YPOS are the
1517 vertical position in lines and pixels of the line, relative to the top
1518 of the first text line, and OFFBOT is the number of off-window pixels at
1519 the bottom of the text line. If there are off-window pixels at the top
1520 of the (first) text line, YPOS is negative.
1522 Return nil if window display is not up-to-date. In that case, use
1523 `pos-visible-in-window-p' to obtain the information. */)
1524 (Lisp_Object line
, Lisp_Object window
)
1526 register struct window
*w
;
1527 register struct buffer
*b
;
1528 struct glyph_row
*row
, *end_row
;
1532 w
= decode_window (window
);
1534 if (noninteractive
|| w
->pseudo_window_p
)
1537 CHECK_BUFFER (w
->buffer
);
1538 b
= XBUFFER (w
->buffer
);
1540 /* Fail if current matrix is not up-to-date. */
1541 if (NILP (w
->window_end_valid
)
1542 || current_buffer
->clip_changed
1543 || current_buffer
->prevent_redisplay_optimizations_p
1544 || XFASTINT (w
->last_modified
) < BUF_MODIFF (b
)
1545 || XFASTINT (w
->last_overlay_modified
) < BUF_OVERLAY_MODIFF (b
))
1551 if (i
< 0 || i
>= w
->current_matrix
->nrows
1552 || (row
= MATRIX_ROW (w
->current_matrix
, i
), !row
->enabled_p
))
1554 max_y
= window_text_bottom_y (w
);
1558 if (EQ (line
, Qheader_line
))
1560 if (!WINDOW_WANTS_HEADER_LINE_P (w
))
1562 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
1563 if (!row
->enabled_p
)
1565 return list4 (make_number (row
->height
),
1566 make_number (0), make_number (0),
1570 if (EQ (line
, Qmode_line
))
1572 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
1573 if (!row
->enabled_p
)
1575 return list4 (make_number (row
->height
),
1576 make_number (0), /* not accurate */
1577 make_number (WINDOW_HEADER_LINE_HEIGHT (w
)
1578 + window_text_bottom_y (w
)),
1582 CHECK_NUMBER (line
);
1585 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1586 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
1587 max_y
= window_text_bottom_y (w
);
1590 while ((n
< 0 || i
< n
)
1591 && row
<= end_row
&& row
->enabled_p
1592 && row
->y
+ row
->height
< max_y
)
1595 if (row
> end_row
|| !row
->enabled_p
)
1607 crop
= max (0, (row
->y
+ row
->height
) - max_y
);
1608 return list4 (make_number (row
->height
+ min (0, row
->y
) - crop
),
1610 make_number (row
->y
),
1611 make_number (crop
));
1614 DEFUN ("window-dedicated-p", Fwindow_dedicated_p
, Swindow_dedicated_p
,
1616 doc
: /* Return non-nil when WINDOW is dedicated to its buffer.
1617 More precisely, return the value assigned by the last call of
1618 `set-window-dedicated-p' for WINDOW. Return nil if that function was
1619 never called with WINDOW as its argument, or the value set by that
1620 function was internally reset since its last call. WINDOW defaults to
1621 the selected window.
1623 When a window is dedicated to its buffer, `display-buffer' will refrain
1624 from displaying another buffer in it. `get-lru-window' and
1625 `get-largest-window' treat dedicated windows specially.
1626 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1627 `kill-buffer' can delete a dedicated window and the containing frame.
1629 Functions like `set-window-buffer' may change the buffer displayed by a
1630 window, unless that window is "strongly" dedicated to its buffer, that
1631 is the value returned by `window-dedicated-p' is t. */)
1632 (Lisp_Object window
)
1634 return decode_window (window
)->dedicated
;
1637 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p
,
1638 Sset_window_dedicated_p
, 2, 2, 0,
1639 doc
: /* Mark WINDOW as dedicated according to FLAG.
1640 WINDOW must be a live window and defaults to the selected one. FLAG
1641 non-nil means mark WINDOW as dedicated to its buffer. FLAG nil means
1642 mark WINDOW as non-dedicated. Return FLAG.
1644 When a window is dedicated to its buffer, `display-buffer' will refrain
1645 from displaying another buffer in it. `get-lru-window' and
1646 `get-largest-window' treat dedicated windows specially.
1647 `delete-windows-on', `replace-buffer-in-windows', `quit-window',
1648 `quit-restore-window' and `kill-buffer' can delete a dedicated window
1649 and the containing frame.
1651 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
1652 its buffer. Functions like `set-window-buffer' may change the buffer
1653 displayed by a window, unless that window is strongly dedicated to its
1654 buffer. If and when `set-window-buffer' displays another buffer in a
1655 window, it also makes sure that the window is no more dedicated. */)
1656 (Lisp_Object window
, Lisp_Object flag
)
1658 register struct window
*w
= decode_window (window
);
1660 w
->dedicated
= flag
;
1661 return w
->dedicated
;
1664 DEFUN ("window-prev-buffers", Fwindow_prev_buffers
, Swindow_prev_buffers
,
1666 doc
: /* Return buffers previously shown in WINDOW.
1667 WINDOW must be a live window and defaults to the selected one.
1669 The return value is either nil or a list of <buffer, window-start,
1670 window-point> triples where buffer was previously shown in WINDOW. */)
1671 (Lisp_Object window
)
1673 return decode_window (window
)->prev_buffers
;
1676 DEFUN ("set-window-prev-buffers", Fset_window_prev_buffers
,
1677 Sset_window_prev_buffers
, 2, 2, 0,
1678 doc
: /* Set WINDOW's previous buffers to PREV-BUFFERS.
1679 WINDOW must be a live window and defaults to the selected one. Return
1682 PREV-BUFFERS should be either nil or a list of <buffer, window-start,
1683 window-point> triples where buffer was previously shown in WINDOW. */)
1684 (Lisp_Object window
, Lisp_Object prev_buffers
)
1686 return decode_window (window
)->prev_buffers
= prev_buffers
;
1689 DEFUN ("window-next-buffers", Fwindow_next_buffers
, Swindow_next_buffers
,
1691 doc
: /* Return list of buffers recently re-shown in WINDOW.
1692 WINDOW must be a live window and defaults to the selected one. */)
1693 (Lisp_Object window
)
1695 return decode_window (window
)->next_buffers
;
1698 DEFUN ("set-window-next-buffers", Fset_window_next_buffers
,
1699 Sset_window_next_buffers
, 2, 2, 0,
1700 doc
: /* Set WINDOW's next buffers to NEXT-BUFFERS.
1701 WINDOW must be a live window and defaults to the selected one. Return
1704 NEXT-BUFFERS should be either nil or a list of buffers that have been
1705 recently re-shown in WINDOW. */)
1706 (Lisp_Object window
, Lisp_Object next_buffers
)
1708 return decode_window (window
)->next_buffers
= next_buffers
;
1711 DEFUN ("window-parameters", Fwindow_parameters
, Swindow_parameters
,
1713 doc
: /* Return the parameters of WINDOW and their values.
1714 WINDOW defaults to the selected window. The return value is a list of
1715 elements of the form (PARAMETER . VALUE). */)
1716 (Lisp_Object window
)
1718 return Fcopy_alist (decode_any_window (window
)->window_parameters
);
1721 DEFUN ("window-parameter", Fwindow_parameter
, Swindow_parameter
,
1723 doc
: /* Return WINDOW's value for PARAMETER.
1724 WINDOW defaults to the selected window. */)
1725 (Lisp_Object window
, Lisp_Object parameter
)
1729 result
= Fassq (parameter
, decode_any_window (window
)->window_parameters
);
1730 return CDR_SAFE (result
);
1733 DEFUN ("set-window-parameter", Fset_window_parameter
,
1734 Sset_window_parameter
, 3, 3, 0,
1735 doc
: /* Set WINDOW's value of PARAMETER to VALUE.
1736 WINDOW defaults to the selected window. Return VALUE. */)
1737 (Lisp_Object window
, Lisp_Object parameter
, Lisp_Object value
)
1739 register struct window
*w
= decode_any_window (window
);
1740 Lisp_Object old_alist_elt
;
1742 old_alist_elt
= Fassq (parameter
, w
->window_parameters
);
1743 if (NILP (old_alist_elt
))
1744 w
->window_parameters
= Fcons (Fcons (parameter
, value
), w
->window_parameters
);
1746 Fsetcdr (old_alist_elt
, value
);
1750 DEFUN ("window-display-table", Fwindow_display_table
, Swindow_display_table
,
1752 doc
: /* Return the display-table that WINDOW is using.
1753 WINDOW defaults to the selected window. */)
1754 (Lisp_Object window
)
1756 return decode_window (window
)->display_table
;
1759 /* Get the display table for use on window W. This is either W's
1760 display table or W's buffer's display table. Ignore the specified
1761 tables if they are not valid; if no valid table is specified,
1764 struct Lisp_Char_Table
*
1765 window_display_table (struct window
*w
)
1767 struct Lisp_Char_Table
*dp
= NULL
;
1769 if (DISP_TABLE_P (w
->display_table
))
1770 dp
= XCHAR_TABLE (w
->display_table
);
1771 else if (BUFFERP (w
->buffer
))
1773 struct buffer
*b
= XBUFFER (w
->buffer
);
1775 if (DISP_TABLE_P (BVAR (b
, display_table
)))
1776 dp
= XCHAR_TABLE (BVAR (b
, display_table
));
1777 else if (DISP_TABLE_P (Vstandard_display_table
))
1778 dp
= XCHAR_TABLE (Vstandard_display_table
);
1784 DEFUN ("set-window-display-table", Fset_window_display_table
, Sset_window_display_table
, 2, 2, 0,
1785 doc
: /* Set WINDOW's display-table to TABLE. */)
1786 (register Lisp_Object window
, Lisp_Object table
)
1788 register struct window
*w
;
1790 w
= decode_window (window
);
1791 w
->display_table
= table
;
1795 /* Record info on buffer window W is displaying
1796 when it is about to cease to display that buffer. */
1798 unshow_buffer (register struct window
*w
)
1805 if (b
!= XMARKER (w
->pointm
)->buffer
)
1809 if (w
== XWINDOW (selected_window
)
1810 || ! EQ (buf
, XWINDOW (selected_window
)->buffer
))
1811 /* Do this except when the selected window's buffer
1812 is being removed from some other window. */
1814 /* last_window_start records the start position that this buffer
1815 had in the last window to be disconnected from it.
1816 Now that this statement is unconditional,
1817 it is possible for the buffer to be displayed in the
1818 selected window, while last_window_start reflects another
1819 window which was recently showing the same buffer.
1820 Some people might say that might be a good thing. Let's see. */
1821 b
->last_window_start
= marker_position (w
->start
);
1823 /* Point in the selected window's buffer
1824 is actually stored in that buffer, and the window's pointm isn't used.
1825 So don't clobber point in that buffer. */
1826 if (! EQ (buf
, XWINDOW (selected_window
)->buffer
)
1827 /* This line helps to fix Horsley's testbug.el bug. */
1828 && !(WINDOWP (BVAR (b
, last_selected_window
))
1829 && w
!= XWINDOW (BVAR (b
, last_selected_window
))
1830 && EQ (buf
, XWINDOW (BVAR (b
, last_selected_window
))->buffer
)))
1831 temp_set_point_both (b
,
1832 clip_to_bounds (BUF_BEGV (b
),
1833 XMARKER (w
->pointm
)->charpos
,
1835 clip_to_bounds (BUF_BEGV_BYTE (b
),
1836 marker_byte_position (w
->pointm
),
1839 if (WINDOWP (BVAR (b
, last_selected_window
))
1840 && w
== XWINDOW (BVAR (b
, last_selected_window
)))
1841 BVAR (b
, last_selected_window
) = Qnil
;
1844 /* Put NEW into the window structure in place of OLD. SETFLAG zero
1845 means change window structure only. Otherwise store geometry and
1846 other settings as well. */
1848 replace_window (Lisp_Object old
, Lisp_Object
new, int setflag
)
1850 register Lisp_Object tem
;
1851 register struct window
*o
= XWINDOW (old
), *n
= XWINDOW (new);
1853 /* If OLD is its frame's root window, then NEW is the new
1854 root window for that frame. */
1855 if (EQ (old
, FRAME_ROOT_WINDOW (XFRAME (o
->frame
))))
1856 FRAME_ROOT_WINDOW (XFRAME (o
->frame
)) = new;
1860 n
->left_col
= o
->left_col
;
1861 n
->top_line
= o
->top_line
;
1862 n
->total_cols
= o
->total_cols
;
1863 n
->total_lines
= o
->total_lines
;
1864 n
->normal_cols
= o
->normal_cols
;
1865 o
->normal_cols
= make_float (1.0);
1866 n
->normal_lines
= o
->normal_lines
;
1867 o
->normal_lines
= make_float (1.0);
1868 n
->desired_matrix
= n
->current_matrix
= 0;
1870 memset (&n
->cursor
, 0, sizeof (n
->cursor
));
1871 memset (&n
->last_cursor
, 0, sizeof (n
->last_cursor
));
1872 memset (&n
->phys_cursor
, 0, sizeof (n
->phys_cursor
));
1873 n
->phys_cursor_type
= -1;
1874 n
->phys_cursor_width
= -1;
1875 n
->must_be_updated_p
= 0;
1876 n
->pseudo_window_p
= 0;
1877 XSETFASTINT (n
->window_end_vpos
, 0);
1878 XSETFASTINT (n
->window_end_pos
, 0);
1879 n
->window_end_valid
= Qnil
;
1880 n
->frozen_window_start_p
= 0;
1883 n
->next
= tem
= o
->next
;
1885 XWINDOW (tem
)->prev
= new;
1887 n
->prev
= tem
= o
->prev
;
1889 XWINDOW (tem
)->next
= new;
1891 n
->parent
= tem
= o
->parent
;
1894 if (EQ (XWINDOW (tem
)->vchild
, old
))
1895 XWINDOW (tem
)->vchild
= new;
1896 if (EQ (XWINDOW (tem
)->hchild
, old
))
1897 XWINDOW (tem
)->hchild
= new;
1901 /* If window WINDOW and its parent window are iso-combined, merge
1902 WINDOW's children into those of its parent window and mark WINDOW as
1906 recombine_windows (Lisp_Object window
)
1908 struct window
*w
, *p
, *c
;
1909 Lisp_Object parent
, child
;
1912 w
= XWINDOW (window
);
1914 if (!NILP (parent
) && NILP (w
->nest
))
1916 p
= XWINDOW (parent
);
1917 if (((!NILP (p
->vchild
) && !NILP (w
->vchild
))
1918 || (!NILP (p
->hchild
) && !NILP (w
->hchild
))))
1919 /* WINDOW and PARENT are both either a vertical or a horizontal
1922 horflag
= NILP (w
->vchild
);
1923 child
= horflag
? w
->hchild
: w
->vchild
;
1924 c
= XWINDOW (child
);
1926 /* Splice WINDOW's children into its parent's children and
1927 assign new normal sizes. */
1936 XWINDOW (w
->prev
)->next
= child
;
1945 = make_float (XFLOATINT (c
->total_cols
)
1946 / XFLOATINT (p
->total_cols
));
1949 = make_float (XFLOATINT (c
->total_lines
)
1950 / XFLOATINT (p
->total_lines
));
1954 if (!NILP (w
->next
))
1957 XWINDOW (c
->next
)->prev
= child
;
1965 c
= XWINDOW (child
);
1969 /* WINDOW can be deleted now. */
1970 w
->vchild
= w
->hchild
= Qnil
;
1975 /* If WINDOW can be deleted, delete it. */
1977 delete_deletable_window (Lisp_Object window
)
1979 if (!NILP (call1 (Qwindow_deletable_p
, window
)))
1980 call1 (Qdelete_window
, window
);
1983 /***********************************************************************
1985 ***********************************************************************/
1987 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1988 pointer. This is a callback function for foreach_window, used in
1989 the window_list function. */
1992 add_window_to_list (struct window
*w
, void *user_data
)
1994 Lisp_Object
*list
= (Lisp_Object
*) user_data
;
1996 XSETWINDOW (window
, w
);
1997 *list
= Fcons (window
, *list
);
2002 /* Return a list of all windows, for use by next_window. If
2003 Vwindow_list is a list, return that list. Otherwise, build a new
2004 list, cache it in Vwindow_list, and return that. */
2009 if (!CONSP (Vwindow_list
))
2013 Vwindow_list
= Qnil
;
2014 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
2016 Lisp_Object args
[2];
2018 /* We are visiting windows in canonical order, and add
2019 new windows at the front of args[1], which means we
2020 have to reverse this list at the end. */
2022 foreach_window (XFRAME (XCAR (tail
)), add_window_to_list
, &args
[1]);
2023 args
[0] = Vwindow_list
;
2024 args
[1] = Fnreverse (args
[1]);
2025 Vwindow_list
= Fnconc (2, args
);
2029 return Vwindow_list
;
2033 /* Value is non-zero if WINDOW satisfies the constraints given by
2034 OWINDOW, MINIBUF and ALL_FRAMES.
2036 MINIBUF t means WINDOW may be minibuffer windows.
2037 `lambda' means WINDOW may not be a minibuffer window.
2038 a window means a specific minibuffer window
2040 ALL_FRAMES t means search all frames,
2041 nil means search just current frame,
2042 `visible' means search just visible frames on the
2044 0 means search visible and iconified frames on the
2046 a window means search the frame that window belongs to,
2047 a frame means consider windows on that frame, only. */
2050 candidate_window_p (Lisp_Object window
, Lisp_Object owindow
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2052 struct window
*w
= XWINDOW (window
);
2053 struct frame
*f
= XFRAME (w
->frame
);
2054 int candidate_p
= 1;
2056 if (!BUFFERP (w
->buffer
))
2058 else if (MINI_WINDOW_P (w
)
2059 && (EQ (minibuf
, Qlambda
)
2060 || (WINDOWP (minibuf
) && !EQ (minibuf
, window
))))
2062 /* If MINIBUF is `lambda' don't consider any mini-windows.
2063 If it is a window, consider only that one. */
2066 else if (EQ (all_frames
, Qt
))
2068 else if (NILP (all_frames
))
2070 xassert (WINDOWP (owindow
));
2071 candidate_p
= EQ (w
->frame
, XWINDOW (owindow
)->frame
);
2073 else if (EQ (all_frames
, Qvisible
))
2075 FRAME_SAMPLE_VISIBILITY (f
);
2076 candidate_p
= FRAME_VISIBLE_P (f
)
2077 && (FRAME_TERMINAL (XFRAME (w
->frame
))
2078 == FRAME_TERMINAL (XFRAME (selected_frame
)));
2081 else if (INTEGERP (all_frames
) && XINT (all_frames
) == 0)
2083 FRAME_SAMPLE_VISIBILITY (f
);
2084 candidate_p
= (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)
2085 #ifdef HAVE_X_WINDOWS
2086 /* Yuck!! If we've just created the frame and the
2087 window-manager requested the user to place it
2088 manually, the window may still not be considered
2089 `visible'. I'd argue it should be at least
2090 something like `iconified', but don't know how to do
2092 || (FRAME_X_P (f
) && f
->output_data
.x
->asked_for_visible
2093 && !f
->output_data
.x
->has_been_visible
)
2096 && (FRAME_TERMINAL (XFRAME (w
->frame
))
2097 == FRAME_TERMINAL (XFRAME (selected_frame
)));
2099 else if (WINDOWP (all_frames
))
2100 candidate_p
= (EQ (FRAME_MINIBUF_WINDOW (f
), all_frames
)
2101 || EQ (XWINDOW (all_frames
)->frame
, w
->frame
)
2102 || EQ (XWINDOW (all_frames
)->frame
, FRAME_FOCUS_FRAME (f
)));
2103 else if (FRAMEP (all_frames
))
2104 candidate_p
= EQ (all_frames
, w
->frame
);
2110 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
2111 Fwindow_list. See candidate_window_p for the meaning of WINDOW,
2112 MINIBUF, and ALL_FRAMES. */
2115 decode_next_window_args (Lisp_Object
*window
, Lisp_Object
*minibuf
, Lisp_Object
*all_frames
)
2118 *window
= selected_window
;
2120 CHECK_LIVE_WINDOW (*window
);
2122 /* MINIBUF nil may or may not include minibuffers. Decide if it
2124 if (NILP (*minibuf
))
2125 *minibuf
= minibuf_level
? minibuf_window
: Qlambda
;
2126 else if (!EQ (*minibuf
, Qt
))
2129 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
2130 => count none of them, or a specific minibuffer window (the
2131 active one) to count. */
2133 /* ALL_FRAMES nil doesn't specify which frames to include. */
2134 if (NILP (*all_frames
))
2135 *all_frames
= (!EQ (*minibuf
, Qlambda
)
2136 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window
)->frame
))
2138 else if (EQ (*all_frames
, Qvisible
))
2140 else if (EQ (*all_frames
, make_number (0)))
2142 else if (FRAMEP (*all_frames
))
2144 else if (!EQ (*all_frames
, Qt
))
2149 /* Return the next or previous window of WINDOW in cyclic ordering
2150 of windows. NEXT_P non-zero means return the next window. See the
2151 documentation string of next-window for the meaning of MINIBUF and
2155 next_window (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
, int next_p
)
2157 decode_next_window_args (&window
, &minibuf
, &all_frames
);
2159 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
2160 return the first window on the frame. */
2161 if (FRAMEP (all_frames
)
2162 && !EQ (all_frames
, XWINDOW (window
)->frame
))
2163 return Fframe_first_window (all_frames
);
2169 /* Find WINDOW in the list of all windows. */
2170 list
= Fmemq (window
, window_list ());
2172 /* Scan forward from WINDOW to the end of the window list. */
2174 for (list
= XCDR (list
); CONSP (list
); list
= XCDR (list
))
2175 if (candidate_window_p (XCAR (list
), window
, minibuf
, all_frames
))
2178 /* Scan from the start of the window list up to WINDOW. */
2180 for (list
= Vwindow_list
;
2181 CONSP (list
) && !EQ (XCAR (list
), window
);
2183 if (candidate_window_p (XCAR (list
), window
, minibuf
, all_frames
))
2187 window
= XCAR (list
);
2191 Lisp_Object candidate
, list
;
2193 /* Scan through the list of windows for candidates. If there are
2194 candidate windows in front of WINDOW, the last one of these
2195 is the one we want. If there are candidates following WINDOW
2196 in the list, again the last one of these is the one we want. */
2198 for (list
= window_list (); CONSP (list
); list
= XCDR (list
))
2200 if (EQ (XCAR (list
), window
))
2202 if (WINDOWP (candidate
))
2205 else if (candidate_window_p (XCAR (list
), window
, minibuf
,
2207 candidate
= XCAR (list
);
2210 if (WINDOWP (candidate
))
2218 DEFUN ("next-window", Fnext_window
, Snext_window
, 0, 3, 0,
2219 doc
: /* Return window following WINDOW in cyclic ordering of windows.
2220 WINDOW must be a live window and defaults to the selected one. The
2221 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2224 MINIBUF nil or omitted means consider the minibuffer window only if the
2225 minibuffer is active. MINIBUF t means consider the minibuffer window
2226 even if the minibuffer is not active. Any other value means do not
2227 consider the minibuffer window even if the minibuffer is active.
2229 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2230 plus the minibuffer window if specified by the MINIBUF argument. If the
2231 minibuffer counts, consider all windows on all frames that share that
2232 minibuffer too. The following non-nil values of ALL-FRAMES have special
2235 - t means consider all windows on all existing frames.
2237 - `visible' means consider all windows on all visible frames.
2239 - 0 (the number zero) means consider all windows on all visible and
2242 - A frame means consider all windows on that frame only.
2244 Anything else means consider all windows on WINDOW's frame and no
2247 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2248 `next-window' to iterate through the entire cycle of acceptable
2249 windows, eventually ending up back at the window you started with.
2250 `previous-window' traverses the same cycle, in the reverse order. */)
2251 (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2253 return next_window (window
, minibuf
, all_frames
, 1);
2257 DEFUN ("previous-window", Fprevious_window
, Sprevious_window
, 0, 3, 0,
2258 doc
: /* Return window preceding WINDOW in cyclic ordering of windows.
2259 WINDOW must be a live window and defaults to the selected one. The
2260 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2263 MINIBUF nil or omitted means consider the minibuffer window only if the
2264 minibuffer is active. MINIBUF t means consider the minibuffer window
2265 even if the minibuffer is not active. Any other value means do not
2266 consider the minibuffer window even if the minibuffer is active.
2268 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2269 plus the minibuffer window if specified by the MINIBUF argument. If the
2270 minibuffer counts, consider all windows on all frames that share that
2271 minibuffer too. The following non-nil values of ALL-FRAMES have special
2274 - t means consider all windows on all existing frames.
2276 - `visible' means consider all windows on all visible frames.
2278 - 0 (the number zero) means consider all windows on all visible and
2281 - A frame means consider all windows on that frame only.
2283 Anything else means consider all windows on WINDOW's frame and no
2286 If you use consistent values for MINIBUF and ALL-FRAMES, you can
2287 use `previous-window' to iterate through the entire cycle of
2288 acceptable windows, eventually ending up back at the window you
2289 started with. `next-window' traverses the same cycle, in the
2291 (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2293 return next_window (window
, minibuf
, all_frames
, 0);
2297 /* Return a list of windows in cyclic ordering. Arguments are like
2298 for `next-window'. */
2301 window_list_1 (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2303 Lisp_Object tail
, list
, rest
;
2305 decode_next_window_args (&window
, &minibuf
, &all_frames
);
2308 for (tail
= window_list (); CONSP (tail
); tail
= XCDR (tail
))
2309 if (candidate_window_p (XCAR (tail
), window
, minibuf
, all_frames
))
2310 list
= Fcons (XCAR (tail
), list
);
2312 /* Rotate the list to start with WINDOW. */
2313 list
= Fnreverse (list
);
2314 rest
= Fmemq (window
, list
);
2315 if (!NILP (rest
) && !EQ (rest
, list
))
2317 for (tail
= list
; !EQ (XCDR (tail
), rest
); tail
= XCDR (tail
))
2319 XSETCDR (tail
, Qnil
);
2320 list
= nconc2 (rest
, list
);
2326 DEFUN ("window-list", Fwindow_list
, Swindow_list
, 0, 3, 0,
2327 doc
: /* Return a list of windows on FRAME, starting with WINDOW.
2328 FRAME nil or omitted means use the selected frame.
2329 WINDOW nil or omitted means use the selected window.
2330 MINIBUF t means include the minibuffer window, even if it isn't active.
2331 MINIBUF nil or omitted means include the minibuffer window only
2333 MINIBUF neither nil nor t means never include the minibuffer window. */)
2334 (Lisp_Object frame
, Lisp_Object minibuf
, Lisp_Object window
)
2337 window
= FRAMEP (frame
) ? XFRAME (frame
)->selected_window
: selected_window
;
2338 CHECK_WINDOW (window
);
2340 frame
= selected_frame
;
2342 if (!EQ (frame
, XWINDOW (window
)->frame
))
2343 error ("Window is on a different frame");
2345 return window_list_1 (window
, minibuf
, frame
);
2349 DEFUN ("window-list-1", Fwindow_list_1
, Swindow_list_1
, 0, 3, 0,
2350 doc
: /* Return a list of all live windows.
2351 WINDOW specifies the first window to list and defaults to the selected
2354 Optional argument MINIBUF nil or omitted means consider the minibuffer
2355 window only if the minibuffer is active. MINIBUF t means consider the
2356 minibuffer window even if the minibuffer is not active. Any other value
2357 means do not consider the minibuffer window even if the minibuffer is
2360 Optional argument ALL-FRAMES nil or omitted means consider all windows
2361 on WINDOW's frame, plus the minibuffer window if specified by the
2362 MINIBUF argument. If the minibuffer counts, consider all windows on all
2363 frames that share that minibuffer too. The following non-nil values of
2364 ALL-FRAMES have special meanings:
2366 - t means consider all windows on all existing frames.
2368 - `visible' means consider all windows on all visible frames.
2370 - 0 (the number zero) means consider all windows on all visible and
2373 - A frame means consider all windows on that frame only.
2375 Anything else means consider all windows on WINDOW's frame and no
2378 If WINDOW is not on the list of windows returned, some other window will
2379 be listed first but no error is signalled. */)
2380 (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2382 return window_list_1 (window
, minibuf
, all_frames
);
2385 /* Look at all windows, performing an operation specified by TYPE
2387 If FRAMES is Qt, look at all frames;
2388 Qnil, look at just the selected frame;
2389 Qvisible, look at visible frames;
2390 a frame, just look at windows on that frame.
2391 If MINI is non-zero, perform the operation on minibuffer windows too. */
2396 GET_BUFFER_WINDOW
, /* Arg is buffer */
2397 REPLACE_BUFFER_IN_WINDOWS_SAFELY
, /* Arg is buffer */
2398 REDISPLAY_BUFFER_WINDOWS
, /* Arg is buffer */
2403 window_loop (enum window_loop type
, Lisp_Object obj
, int mini
, Lisp_Object frames
)
2405 Lisp_Object window
, windows
, best_window
, frame_arg
;
2406 int frame_best_window_flag
= 0;
2408 struct gcpro gcpro1
;
2410 /* If we're only looping through windows on a particular frame,
2411 frame points to that frame. If we're looping through windows
2412 on all frames, frame is 0. */
2413 if (FRAMEP (frames
))
2414 f
= XFRAME (frames
);
2415 else if (NILP (frames
))
2416 f
= SELECTED_FRAME ();
2421 frame_arg
= Qlambda
;
2422 else if (EQ (frames
, make_number (0)))
2424 else if (EQ (frames
, Qvisible
))
2429 /* frame_arg is Qlambda to stick to one frame,
2430 Qvisible to consider all visible frames,
2433 /* Pick a window to start with. */
2437 window
= FRAME_SELECTED_WINDOW (f
);
2439 window
= FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2441 windows
= window_list_1 (window
, mini
? Qt
: Qnil
, frame_arg
);
2445 for (; CONSP (windows
); windows
= XCDR (windows
))
2449 window
= XCAR (windows
);
2450 w
= XWINDOW (window
);
2452 /* Note that we do not pay attention here to whether the frame
2453 is visible, since Fwindow_list skips non-visible frames if
2454 that is desired, under the control of frame_arg. */
2455 if (!MINI_WINDOW_P (w
)
2456 /* For REPLACE_BUFFER_IN_WINDOWS_SAFELY, we must always
2457 consider all windows. */
2458 || type
== REPLACE_BUFFER_IN_WINDOWS_SAFELY
2459 || (mini
&& minibuf_level
> 0))
2462 case GET_BUFFER_WINDOW
:
2463 if (EQ (w
->buffer
, obj
)
2464 /* Don't find any minibuffer window except the one that
2465 is currently in use. */
2466 && (MINI_WINDOW_P (w
) ? EQ (window
, minibuf_window
) : 1))
2468 if (EQ (window
, selected_window
))
2469 /* Preferably return the selected window. */
2470 RETURN_UNGCPRO (window
);
2471 else if (EQ (XWINDOW (window
)->frame
, selected_frame
)
2472 && !frame_best_window_flag
)
2473 /* Prefer windows on the current frame (but don't
2474 choose another one if we have one already). */
2476 best_window
= window
;
2477 frame_best_window_flag
= 1;
2479 else if (NILP (best_window
))
2480 best_window
= window
;
2484 case REPLACE_BUFFER_IN_WINDOWS_SAFELY
:
2485 /* We could simply check whether the buffer shown by window
2486 is live, and show another buffer in case it isn't. */
2487 if (EQ (w
->buffer
, obj
))
2489 /* Undedicate WINDOW. */
2490 w
->dedicated
= Qnil
;
2491 /* Make WINDOW show the buffer returned by
2492 other_buffer_safely, don't run any hooks. */
2494 (window
, other_buffer_safely (w
->buffer
), 0, 0);
2495 /* If WINDOW is the selected window, make its buffer
2496 current. But do so only if the window shows the
2497 current buffer (Bug#6454). */
2498 if (EQ (window
, selected_window
)
2499 && XBUFFER (w
->buffer
) == current_buffer
)
2500 Fset_buffer (w
->buffer
);
2504 case REDISPLAY_BUFFER_WINDOWS
:
2505 if (EQ (w
->buffer
, obj
))
2507 mark_window_display_accurate (window
, 0);
2508 w
->update_mode_line
= Qt
;
2509 XBUFFER (obj
)->prevent_redisplay_optimizations_p
= 1;
2510 ++update_mode_lines
;
2511 best_window
= window
;
2515 /* Check for a window that has a killed buffer. */
2516 case CHECK_ALL_WINDOWS
:
2517 if (! NILP (w
->buffer
)
2518 && NILP (BVAR (XBUFFER (w
->buffer
), name
)))
2522 case WINDOW_LOOP_UNUSED
:
2531 /* Used for debugging. Abort if any window has a dead buffer. */
2533 extern void check_all_windows (void) EXTERNALLY_VISIBLE
;
2535 check_all_windows (void)
2537 window_loop (CHECK_ALL_WINDOWS
, Qnil
, 1, Qt
);
2540 DEFUN ("get-buffer-window", Fget_buffer_window
, Sget_buffer_window
, 0, 2, 0,
2541 doc
: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2542 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to
2545 The optional argument ALL-FRAMES specifies the frames to consider:
2547 - t means consider all windows on all existing frames.
2549 - `visible' means consider all windows on all visible frames.
2551 - 0 (the number zero) means consider all windows on all visible
2552 and iconified frames.
2554 - A frame means consider all windows on that frame only.
2556 Any other value of ALL-FRAMES means consider all windows on the
2557 selected frame and no others. */)
2558 (Lisp_Object buffer_or_name
, Lisp_Object all_frames
)
2562 if (NILP (buffer_or_name
))
2563 buffer
= Fcurrent_buffer ();
2565 buffer
= Fget_buffer (buffer_or_name
);
2567 if (BUFFERP (buffer
))
2568 return window_loop (GET_BUFFER_WINDOW
, buffer
, 1, all_frames
);
2574 resize_root_window (Lisp_Object window
, Lisp_Object delta
, Lisp_Object horizontal
, Lisp_Object ignore
)
2576 return call4 (Qwindow_resize_root_window
, window
, delta
, horizontal
, ignore
);
2580 DEFUN ("delete-other-windows-internal", Fdelete_other_windows_internal
,
2581 Sdelete_other_windows_internal
, 0, 2, "",
2582 doc
: /* Make WINDOW fill its frame.
2583 Only the frame WINDOW is on is affected. WINDOW may be any window and
2584 defaults to the selected one.
2586 Optional argument ROOT, if non-nil, must specify an internal window
2587 containing WINDOW as a subwindow. If this is the case, replace ROOT by
2588 WINDOW and leave alone any windows not contained in ROOT.
2590 When WINDOW is live try to reduce display jumps by keeping the text
2591 previously visible in WINDOW in the same place on the frame. Doing this
2592 depends on the value of (window-start WINDOW), so if calling this
2593 function in a program gives strange scrolling, make sure the
2594 window-start value is reasonable when this function is called. */)
2595 (Lisp_Object window
, Lisp_Object root
)
2597 struct window
*w
, *r
, *s
;
2599 Lisp_Object sibling
, pwindow
, swindow
IF_LINT (= Qnil
), delta
;
2600 ptrdiff_t startpos
IF_LINT (= 0);
2601 int top
IF_LINT (= 0), new_top
, resize_failed
;
2603 w
= decode_any_window (window
);
2604 XSETWINDOW (window
, w
);
2605 f
= XFRAME (w
->frame
);
2608 /* ROOT is the frame's root window. */
2610 root
= FRAME_ROOT_WINDOW (f
);
2614 /* ROOT must be an ancestor of WINDOW. */
2616 r
= decode_any_window (root
);
2617 pwindow
= XWINDOW (window
)->parent
;
2618 while (!NILP (pwindow
))
2619 if (EQ (pwindow
, root
))
2622 pwindow
= XWINDOW (pwindow
)->parent
;
2623 if (!EQ (pwindow
, root
))
2624 error ("Specified root is not an ancestor of specified window");
2627 if (EQ (window
, root
))
2630 /* I don't understand the "top > 0" part below. If we deal with a
2631 standalone minibuffer it would have been caught by the preceding
2633 else if (MINI_WINDOW_P (w
)) /* && top > 0) */
2634 error ("Can't expand minibuffer to full frame");
2636 if (!NILP (w
->buffer
))
2638 startpos
= marker_position (w
->start
);
2639 top
= WINDOW_TOP_EDGE_LINE (w
)
2640 - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w
)));
2641 /* Make sure WINDOW is the frame's selected window. */
2642 if (!EQ (window
, FRAME_SELECTED_WINDOW (f
)))
2644 if (EQ (selected_frame
, w
->frame
))
2645 Fselect_window (window
, Qnil
);
2647 FRAME_SELECTED_WINDOW (f
) = window
;
2652 /* See if the frame's selected window is a subwindow of WINDOW, by
2653 finding all the selected window's parents and comparing each
2654 one with WINDOW. If it isn't we need a new selected window for
2656 swindow
= FRAME_SELECTED_WINDOW (f
);
2660 while (!NILP (pwindow
) && !EQ (window
, pwindow
))
2661 pwindow
= XWINDOW (pwindow
)->parent
;
2663 if (EQ (window
, pwindow
))
2664 /* If WINDOW is an ancestor of SWINDOW, then SWINDOW is ok
2665 as the new selected window. */
2668 /* Else try the previous window of SWINDOW. */
2669 swindow
= Fprevious_window (swindow
, Qlambda
, Qnil
);
2672 if (!EQ (swindow
, FRAME_SELECTED_WINDOW (f
)))
2674 if (EQ (selected_frame
, w
->frame
))
2675 Fselect_window (swindow
, Qnil
);
2677 FRAME_SELECTED_WINDOW (f
) = swindow
;
2682 free_window_matrices (r
);
2684 windows_or_buffers_changed
++;
2685 Vwindow_list
= Qnil
;
2686 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
2689 if (NILP (w
->buffer
))
2691 /* Resize subwindows vertically. */
2692 XSETINT (delta
, XINT (r
->total_lines
) - XINT (w
->total_lines
));
2693 w
->top_line
= r
->top_line
;
2694 resize_root_window (window
, delta
, Qnil
, Qnil
);
2695 if (window_resize_check (w
, 0))
2696 window_resize_apply (w
, 0);
2699 resize_root_window (window
, delta
, Qnil
, Qt
);
2700 if (window_resize_check (w
, 0))
2701 window_resize_apply (w
, 0);
2706 /* Resize subwindows horizontally. */
2709 w
->left_col
= r
->left_col
;
2710 XSETINT (delta
, XINT (r
->total_cols
) - XINT (w
->total_cols
));
2711 w
->left_col
= r
->left_col
;
2712 resize_root_window (window
, delta
, Qt
, Qnil
);
2713 if (window_resize_check (w
, 1))
2714 window_resize_apply (w
, 1);
2717 resize_root_window (window
, delta
, Qt
, Qt
);
2718 if (window_resize_check (w
, 1))
2719 window_resize_apply (w
, 1);
2726 /* Play safe, if we still can ... */
2729 w
= XWINDOW (window
);
2733 /* Cleanly unlink WINDOW from window-tree. */
2734 if (!NILP (w
->prev
))
2735 /* Get SIBLING above (on the left of) WINDOW. */
2738 s
= XWINDOW (sibling
);
2740 if (!NILP (s
->next
))
2741 XWINDOW (s
->next
)->prev
= sibling
;
2744 /* Get SIBLING below (on the right of) WINDOW. */
2747 s
= XWINDOW (sibling
);
2749 if (!NILP (XWINDOW (w
->parent
)->vchild
))
2750 XWINDOW (w
->parent
)->vchild
= sibling
;
2752 XWINDOW (w
->parent
)->hchild
= sibling
;
2755 /* Delete ROOT and all subwindows of ROOT. */
2756 if (!NILP (r
->vchild
))
2758 delete_all_subwindows (r
->vchild
);
2761 else if (!NILP (r
->hchild
))
2763 delete_all_subwindows (r
->hchild
);
2767 replace_window (root
, window
, 1);
2769 /* Reset WINDOW's splits status. */
2772 /* This must become SWINDOW anyway ....... */
2773 if (!NILP (w
->buffer
) && !resize_failed
)
2775 /* Try to minimize scrolling, by setting the window start to the
2776 point will cause the text at the old window start to be at the
2777 same place on the frame. But don't try to do this if the
2778 window start is outside the visible portion (as might happen
2779 when the display is not current, due to typeahead). */
2780 new_top
= WINDOW_TOP_EDGE_LINE (w
) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w
)));
2782 && startpos
>= BUF_BEGV (XBUFFER (w
->buffer
))
2783 && startpos
<= BUF_ZV (XBUFFER (w
->buffer
)))
2785 struct position pos
;
2786 struct buffer
*obuf
= current_buffer
;
2788 Fset_buffer (w
->buffer
);
2789 /* This computation used to temporarily move point, but that
2790 can have unwanted side effects due to text properties. */
2791 pos
= *vmotion (startpos
, -top
, w
);
2793 set_marker_both (w
->start
, w
->buffer
, pos
.bufpos
, pos
.bytepos
);
2794 w
->window_end_valid
= Qnil
;
2795 w
->start_at_line_beg
= ((pos
.bytepos
== BEGV_BYTE
2796 || FETCH_BYTE (pos
.bytepos
- 1) == '\n') ? Qt
2798 /* We need to do this, so that the window-scroll-functions
2800 w
->optional_new_start
= Qt
;
2802 set_buffer_internal (obuf
);
2809 run_window_configuration_change_hook (f
);
2816 replace_buffer_in_windows (Lisp_Object buffer
)
2818 call1 (Qreplace_buffer_in_windows
, buffer
);
2822 /* Safely replace BUFFER with some other buffer in all windows of all
2823 frames, even those on other keyboards. */
2826 replace_buffer_in_windows_safely (Lisp_Object buffer
)
2828 Lisp_Object tail
, frame
;
2830 /* A single call to window_loop won't do the job because it only
2831 considers frames on the current keyboard. So loop manually over
2832 frames, and handle each one. */
2833 FOR_EACH_FRAME (tail
, frame
)
2834 window_loop (REPLACE_BUFFER_IN_WINDOWS_SAFELY
, buffer
, 1, frame
);
2837 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2838 minimum allowable size. */
2841 check_frame_size (FRAME_PTR frame
, int *rows
, int *cols
)
2843 /* For height, we have to see:
2844 how many windows the frame has at minimum (one or two),
2845 and whether it has a menu bar or other special stuff at the top. */
2847 = ((FRAME_MINIBUF_ONLY_P (frame
) || ! FRAME_HAS_MINIBUF_P (frame
))
2848 ? MIN_SAFE_WINDOW_HEIGHT
2849 : 2 * MIN_SAFE_WINDOW_HEIGHT
);
2851 if (FRAME_TOP_MARGIN (frame
) > 0)
2852 min_height
+= FRAME_TOP_MARGIN (frame
);
2854 if (*rows
< min_height
)
2856 if (*cols
< MIN_SAFE_WINDOW_WIDTH
)
2857 *cols
= MIN_SAFE_WINDOW_WIDTH
;
2860 /* Adjust the margins of window W if text area is too small.
2861 Return 1 if window width is ok after adjustment; 0 if window
2862 is still too narrow. */
2865 adjust_window_margins (struct window
*w
)
2867 int box_cols
= (WINDOW_TOTAL_COLS (w
)
2868 - WINDOW_FRINGE_COLS (w
)
2869 - WINDOW_SCROLL_BAR_COLS (w
));
2870 int margin_cols
= (WINDOW_LEFT_MARGIN_COLS (w
)
2871 + WINDOW_RIGHT_MARGIN_COLS (w
));
2873 if (box_cols
- margin_cols
>= MIN_SAFE_WINDOW_WIDTH
)
2876 if (margin_cols
< 0 || box_cols
< MIN_SAFE_WINDOW_WIDTH
)
2879 /* Window's text area is too narrow, but reducing the window
2880 margins will fix that. */
2881 margin_cols
= box_cols
- MIN_SAFE_WINDOW_WIDTH
;
2882 if (WINDOW_RIGHT_MARGIN_COLS (w
) > 0)
2884 if (WINDOW_LEFT_MARGIN_COLS (w
) > 0)
2885 w
->left_margin_cols
= w
->right_margin_cols
2886 = make_number (margin_cols
/2);
2888 w
->right_margin_cols
= make_number (margin_cols
);
2891 w
->left_margin_cols
= make_number (margin_cols
);
2895 static Lisp_Object
Fset_window_margins (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2896 static Lisp_Object
Fset_window_fringes (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2898 static Lisp_Object
Fset_window_scroll_bars (Lisp_Object
, Lisp_Object
,
2899 Lisp_Object
, Lisp_Object
);
2900 static Lisp_Object
Fset_window_vscroll (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2902 /* The following three routines are needed for running a window's
2903 configuration change hook. */
2905 run_funs (Lisp_Object funs
)
2907 for (; CONSP (funs
); funs
= XCDR (funs
))
2908 if (!EQ (XCAR (funs
), Qt
))
2909 call0 (XCAR (funs
));
2913 select_window_norecord (Lisp_Object window
)
2915 return WINDOW_LIVE_P (window
)
2916 ? Fselect_window (window
, Qt
) : selected_window
;
2920 select_frame_norecord (Lisp_Object frame
)
2922 return FRAME_LIVE_P (XFRAME (frame
))
2923 ? Fselect_frame (frame
, Qt
) : selected_frame
;
2927 run_window_configuration_change_hook (struct frame
*f
)
2929 ptrdiff_t count
= SPECPDL_INDEX ();
2930 Lisp_Object frame
, global_wcch
2931 = Fdefault_value (Qwindow_configuration_change_hook
);
2932 XSETFRAME (frame
, f
);
2934 if (NILP (Vrun_hooks
))
2937 /* Use the right buffer. Matters when running the local hooks. */
2938 if (current_buffer
!= XBUFFER (Fwindow_buffer (Qnil
)))
2940 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
2941 Fset_buffer (Fwindow_buffer (Qnil
));
2944 if (SELECTED_FRAME () != f
)
2946 record_unwind_protect (select_frame_norecord
, Fselected_frame ());
2947 select_frame_norecord (frame
);
2950 /* Look for buffer-local values. */
2952 Lisp_Object windows
= Fwindow_list (frame
, Qlambda
, Qnil
);
2953 for (; CONSP (windows
); windows
= XCDR (windows
))
2955 Lisp_Object window
= XCAR (windows
);
2956 Lisp_Object buffer
= Fwindow_buffer (window
);
2957 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook
,
2960 ptrdiff_t inner_count
= SPECPDL_INDEX ();
2961 record_unwind_protect (select_window_norecord
, Fselected_window ());
2962 select_window_norecord (window
);
2963 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook
,
2965 unbind_to (inner_count
, Qnil
);
2970 run_funs (global_wcch
);
2971 unbind_to (count
, Qnil
);
2974 DEFUN ("run-window-configuration-change-hook", Frun_window_configuration_change_hook
,
2975 Srun_window_configuration_change_hook
, 1, 1, 0,
2976 doc
: /* Run `window-configuration-change-hook' for FRAME. */)
2979 CHECK_LIVE_FRAME (frame
);
2980 run_window_configuration_change_hook (XFRAME (frame
));
2984 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
2985 means it's allowed to run hooks. See make_frame for a case where
2986 it's not allowed. KEEP_MARGINS_P non-zero means that the current
2987 margins, fringes, and scroll-bar settings of the window are not
2988 reset from the buffer's local settings. */
2991 set_window_buffer (Lisp_Object window
, Lisp_Object buffer
, int run_hooks_p
, int keep_margins_p
)
2993 struct window
*w
= XWINDOW (window
);
2994 struct buffer
*b
= XBUFFER (buffer
);
2995 ptrdiff_t count
= SPECPDL_INDEX ();
2996 int samebuf
= EQ (buffer
, w
->buffer
);
3000 if (EQ (window
, selected_window
))
3001 BVAR (b
, last_selected_window
) = window
;
3003 /* Let redisplay errors through. */
3004 b
->display_error_modiff
= 0;
3006 /* Update time stamps of buffer display. */
3007 if (INTEGERP (BVAR (b
, display_count
)))
3008 XSETINT (BVAR (b
, display_count
), XINT (BVAR (b
, display_count
)) + 1);
3009 BVAR (b
, display_time
) = Fcurrent_time ();
3011 XSETFASTINT (w
->window_end_pos
, 0);
3012 XSETFASTINT (w
->window_end_vpos
, 0);
3013 memset (&w
->last_cursor
, 0, sizeof w
->last_cursor
);
3014 w
->window_end_valid
= Qnil
;
3015 if (!(keep_margins_p
&& samebuf
))
3016 { /* If we're not actually changing the buffer, don't reset hscroll and
3017 vscroll. This case happens for example when called from
3018 change_frame_size_1, where we use a dummy call to
3019 Fset_window_buffer on the frame's selected window (and no other)
3020 just in order to run window-configuration-change-hook.
3021 Resetting hscroll and vscroll here is problematic for things like
3022 image-mode and doc-view-mode since it resets the image's position
3023 whenever we resize the frame. */
3024 w
->hscroll
= w
->min_hscroll
= make_number (0);
3026 set_marker_both (w
->pointm
, buffer
, BUF_PT (b
), BUF_PT_BYTE (b
));
3027 set_marker_restricted (w
->start
,
3028 make_number (b
->last_window_start
),
3030 w
->start_at_line_beg
= Qnil
;
3031 w
->force_start
= Qnil
;
3032 XSETFASTINT (w
->last_modified
, 0);
3033 XSETFASTINT (w
->last_overlay_modified
, 0);
3035 /* Maybe we could move this into the `if' but it's not obviously safe and
3036 I doubt it's worth the trouble. */
3037 windows_or_buffers_changed
++;
3039 /* We must select BUFFER for running the window-scroll-functions. */
3040 /* We can't check ! NILP (Vwindow_scroll_functions) here
3041 because that might itself be a local variable. */
3042 if (window_initialized
)
3044 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3045 Fset_buffer (buffer
);
3048 XMARKER (w
->pointm
)->insertion_type
= !NILP (Vwindow_point_insertion_type
);
3050 if (!keep_margins_p
)
3052 /* Set left and right marginal area width etc. from buffer. */
3054 /* This may call adjust_window_margins three times, so
3055 temporarily disable window margins. */
3056 Lisp_Object save_left
= w
->left_margin_cols
;
3057 Lisp_Object save_right
= w
->right_margin_cols
;
3059 w
->left_margin_cols
= w
->right_margin_cols
= Qnil
;
3061 Fset_window_fringes (window
,
3062 BVAR (b
, left_fringe_width
), BVAR (b
, right_fringe_width
),
3063 BVAR (b
, fringes_outside_margins
));
3065 Fset_window_scroll_bars (window
,
3066 BVAR (b
, scroll_bar_width
),
3067 BVAR (b
, vertical_scroll_bar_type
), Qnil
);
3069 w
->left_margin_cols
= save_left
;
3070 w
->right_margin_cols
= save_right
;
3072 Fset_window_margins (window
,
3073 BVAR (b
, left_margin_cols
), BVAR (b
, right_margin_cols
));
3078 if (! NILP (Vwindow_scroll_functions
))
3079 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
3080 Fmarker_position (w
->start
));
3081 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w
)));
3084 unbind_to (count
, Qnil
);
3087 DEFUN ("set-window-buffer", Fset_window_buffer
, Sset_window_buffer
, 2, 3, 0,
3088 doc
: /* Make WINDOW display BUFFER-OR-NAME as its contents.
3089 WINDOW has to be a live window and defaults to the selected one.
3090 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3092 Optional third argument KEEP-MARGINS non-nil means that WINDOW's current
3093 display margins, fringe widths, and scroll bar settings are preserved;
3094 the default is to reset these from the local settings for BUFFER-OR-NAME
3095 or the frame defaults. Return nil.
3097 This function throws an error when WINDOW is strongly dedicated to its
3098 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3099 already display BUFFER-OR-NAME.
3101 This function runs `window-scroll-functions' before running
3102 `window-configuration-change-hook'. */)
3103 (register Lisp_Object window
, Lisp_Object buffer_or_name
, Lisp_Object keep_margins
)
3105 register Lisp_Object tem
, buffer
;
3106 register struct window
*w
= decode_window (window
);
3108 XSETWINDOW (window
, w
);
3109 buffer
= Fget_buffer (buffer_or_name
);
3110 CHECK_BUFFER (buffer
);
3111 if (NILP (BVAR (XBUFFER (buffer
), name
)))
3112 error ("Attempt to display deleted buffer");
3116 error ("Window is deleted");
3117 else if (!EQ (tem
, Qt
))
3118 /* w->buffer is t when the window is first being set up. */
3120 if (!EQ (tem
, buffer
))
3122 if (EQ (w
->dedicated
, Qt
))
3123 /* WINDOW is strongly dedicated to its buffer, signal an
3125 error ("Window is dedicated to `%s'", SDATA (BVAR (XBUFFER (tem
), name
)));
3127 /* WINDOW is weakly dedicated to its buffer, reset
3129 w
->dedicated
= Qnil
;
3131 call1 (Qrecord_window_buffer
, window
);
3137 set_window_buffer (window
, buffer
, 1, !NILP (keep_margins
));
3143 display_buffer (Lisp_Object buffer
, Lisp_Object not_this_window_p
, Lisp_Object override_frame
)
3145 return call3 (Qdisplay_buffer
, buffer
, not_this_window_p
, override_frame
);
3148 DEFUN ("force-window-update", Fforce_window_update
, Sforce_window_update
,
3150 doc
: /* Force all windows to be updated on next redisplay.
3151 If optional arg OBJECT is a window, force redisplay of that window only.
3152 If OBJECT is a buffer or buffer name, force redisplay of all windows
3153 displaying that buffer. */)
3154 (Lisp_Object object
)
3158 windows_or_buffers_changed
++;
3159 update_mode_lines
++;
3163 if (WINDOWP (object
))
3165 struct window
*w
= XWINDOW (object
);
3166 mark_window_display_accurate (object
, 0);
3167 w
->update_mode_line
= Qt
;
3168 if (BUFFERP (w
->buffer
))
3169 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
3170 ++update_mode_lines
;
3174 if (STRINGP (object
))
3175 object
= Fget_buffer (object
);
3176 if (BUFFERP (object
) && !NILP (BVAR (XBUFFER (object
), name
)))
3178 /* Walk all windows looking for buffer, and force update
3179 of each of those windows. */
3181 object
= window_loop (REDISPLAY_BUFFER_WINDOWS
, object
, 0, Qvisible
);
3182 return NILP (object
) ? Qnil
: Qt
;
3185 /* If nothing suitable was found, just return.
3186 We could signal an error, but this feature will typically be used
3187 asynchronously in timers or process sentinels, so we don't. */
3193 temp_output_buffer_show (register Lisp_Object buf
)
3195 register struct buffer
*old
= current_buffer
;
3196 register Lisp_Object window
;
3197 register struct window
*w
;
3199 BVAR (XBUFFER (buf
), directory
) = BVAR (current_buffer
, directory
);
3202 BUF_SAVE_MODIFF (XBUFFER (buf
)) = MODIFF
;
3206 set_buffer_internal (old
);
3208 if (!NILP (Vtemp_buffer_show_function
))
3209 call1 (Vtemp_buffer_show_function
, buf
);
3212 window
= display_buffer (buf
, Vtemp_buffer_show_specifiers
, Qnil
);
3213 /* Reset Vtemp_buffer_show_specifiers immediately so it won't
3214 affect subsequent calls. */
3215 Vtemp_buffer_show_specifiers
= Qnil
;
3217 if (!EQ (XWINDOW (window
)->frame
, selected_frame
))
3218 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window
)));
3219 Vminibuf_scroll_window
= window
;
3220 w
= XWINDOW (window
);
3221 XSETFASTINT (w
->hscroll
, 0);
3222 XSETFASTINT (w
->min_hscroll
, 0);
3223 set_marker_restricted_both (w
->start
, buf
, BEG
, BEG
);
3224 set_marker_restricted_both (w
->pointm
, buf
, BEG
, BEG
);
3226 /* Run temp-buffer-show-hook, with the chosen window selected
3227 and its buffer current. */
3229 ptrdiff_t count
= SPECPDL_INDEX ();
3230 Lisp_Object prev_window
, prev_buffer
;
3231 prev_window
= selected_window
;
3232 XSETBUFFER (prev_buffer
, old
);
3234 /* Select the window that was chosen, for running the hook.
3235 Note: Both Fselect_window and select_window_norecord may
3236 set-buffer to the buffer displayed in the window,
3237 so we need to save the current buffer. --stef */
3238 record_unwind_protect (Fset_buffer
, prev_buffer
);
3239 record_unwind_protect (select_window_norecord
, prev_window
);
3240 Fselect_window (window
, Qt
);
3241 Fset_buffer (w
->buffer
);
3242 Frun_hooks (1, &Qtemp_buffer_show_hook
);
3243 unbind_to (count
, Qnil
);
3248 DEFUN ("internal-temp-output-buffer-show",
3249 Ftemp_output_buffer_show
, Stemp_output_buffer_show
,
3251 doc
: /* Internal function for `with-output-to-temp-buffer''. */)
3254 temp_output_buffer_show (buf
);
3258 /* Make new window, have it replace WINDOW in window-tree, and make
3259 WINDOW its only vertical child (HORFLAG 1 means make WINDOW its only
3260 horizontal child). */
3262 make_parent_window (Lisp_Object window
, int horflag
)
3265 register struct window
*o
, *p
;
3268 o
= XWINDOW (window
);
3269 p
= allocate_window ();
3270 for (i
= 0; i
< VECSIZE (struct window
); ++i
)
3271 ((struct Lisp_Vector
*) p
)->contents
[i
]
3272 = ((struct Lisp_Vector
*) o
)->contents
[i
];
3273 XSETWINDOW (parent
, p
);
3276 XSETFASTINT (p
->sequence_number
, sequence_number
);
3278 replace_window (window
, parent
, 1);
3284 p
->hchild
= horflag
? window
: Qnil
;
3285 p
->vchild
= horflag
? Qnil
: window
;
3291 p
->window_parameters
= Qnil
;
3294 /* Make new window from scratch. */
3299 register struct window
*w
;
3301 w
= allocate_window ();
3302 /* Initialize all Lisp data. */
3303 w
->frame
= w
->mini_p
= Qnil
;
3304 w
->next
= w
->prev
= w
->hchild
= w
->vchild
= w
->parent
= Qnil
;
3305 XSETFASTINT (w
->left_col
, 0);
3306 XSETFASTINT (w
->top_line
, 0);
3307 XSETFASTINT (w
->total_lines
, 0);
3308 XSETFASTINT (w
->total_cols
, 0);
3309 w
->normal_lines
= make_float (1.0);
3310 w
->normal_cols
= make_float (1.0);
3311 XSETFASTINT (w
->new_total
, 0);
3312 XSETFASTINT (w
->new_normal
, 0);
3314 w
->start
= Fmake_marker ();
3315 w
->pointm
= Fmake_marker ();
3316 w
->force_start
= w
->optional_new_start
= Qnil
;
3317 XSETFASTINT (w
->hscroll
, 0);
3318 XSETFASTINT (w
->min_hscroll
, 0);
3319 XSETFASTINT (w
->use_time
, 0);
3321 XSETFASTINT (w
->sequence_number
, sequence_number
);
3322 w
->temslot
= w
->last_modified
= w
->last_overlay_modified
= Qnil
;
3323 XSETFASTINT (w
->last_point
, 0);
3324 w
->last_had_star
= w
->vertical_scroll_bar
= Qnil
;
3325 w
->left_margin_cols
= w
->right_margin_cols
= Qnil
;
3326 w
->left_fringe_width
= w
->right_fringe_width
= Qnil
;
3327 w
->fringes_outside_margins
= Qnil
;
3328 w
->scroll_bar_width
= Qnil
;
3329 w
->vertical_scroll_bar_type
= Qt
;
3330 w
->last_mark_x
= w
->last_mark_y
= Qnil
;
3331 XSETFASTINT (w
->window_end_pos
, 0);
3332 XSETFASTINT (w
->window_end_vpos
, 0);
3333 w
->window_end_valid
= w
->update_mode_line
= Qnil
;
3334 w
->start_at_line_beg
= w
->display_table
= w
->dedicated
= Qnil
;
3335 w
->base_line_number
= w
->base_line_pos
= w
->region_showing
= Qnil
;
3336 w
->column_number_displayed
= w
->redisplay_end_trigger
= Qnil
;
3337 w
->splits
= w
->nest
= w
->window_parameters
= Qnil
;
3338 w
->prev_buffers
= w
->next_buffers
= Qnil
;
3339 /* Initialize non-Lisp data. */
3340 w
->desired_matrix
= w
->current_matrix
= 0;
3341 w
->nrows_scale_factor
= w
->ncols_scale_factor
= 1;
3342 memset (&w
->cursor
, 0, sizeof (w
->cursor
));
3343 memset (&w
->last_cursor
, 0, sizeof (w
->last_cursor
));
3344 memset (&w
->phys_cursor
, 0, sizeof (w
->phys_cursor
));
3345 w
->phys_cursor_type
= -1;
3346 w
->phys_cursor_width
= -1;
3347 w
->last_cursor_off_p
= w
->cursor_off_p
= 0;
3348 w
->must_be_updated_p
= 0;
3349 w
->pseudo_window_p
= 0;
3350 w
->frozen_window_start_p
= 0;
3352 /* Reset window_list. */
3353 Vwindow_list
= Qnil
;
3354 /* Return window. */
3355 XSETWINDOW (window
, w
);
3359 DEFUN ("set-window-new-total", Fset_window_new_total
, Sset_window_new_total
, 2, 3, 0,
3360 doc
: /* Set new total size of WINDOW to SIZE.
3363 Optional argument ADD non-nil means add SIZE to the new total size of
3364 WINDOW and return the sum.
3366 Note: This function does not operate on any subwindows of WINDOW. */)
3367 (Lisp_Object window
, Lisp_Object size
, Lisp_Object add
)
3369 struct window
*w
= decode_any_window (window
);
3371 CHECK_NUMBER (size
);
3373 XSETINT (w
->new_total
, XINT (size
));
3375 XSETINT (w
->new_total
, XINT (w
->new_total
) + XINT (size
));
3377 return w
->new_total
;
3380 DEFUN ("set-window-new-normal", Fset_window_new_normal
, Sset_window_new_normal
, 1, 2, 0,
3381 doc
: /* Set new normal size of WINDOW to SIZE.
3384 Note: This function does not operate on any subwindows of WINDOW. */)
3385 (Lisp_Object window
, Lisp_Object size
)
3387 struct window
*w
= decode_any_window (window
);
3389 w
->new_normal
= size
;
3390 return w
->new_normal
;
3393 /* Return 1 if setting w->total_lines (w->total_cols if HORFLAG is
3394 non-zero) to w->new_total would result in correct heights (widths)
3395 for window W and recursively all subwindows of W.
3397 Note: This function does not check any of `window-fixed-size-p',
3398 `window-min-height' or `window-min-width'. It does check that window
3399 sizes do not drop below one line (two columns). */
3401 window_resize_check (struct window
*w
, int horflag
)
3405 if (!NILP (w
->vchild
))
3406 /* W is a vertical combination. */
3408 c
= XWINDOW (w
->vchild
);
3410 /* All subwindows of W must have the same width as W. */
3414 if ((XINT (c
->new_total
) != XINT (w
->new_total
))
3415 || !window_resize_check (c
, horflag
))
3417 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3422 /* The sum of the heights of the subwindows of W must equal W's
3425 int sum_of_sizes
= 0;
3428 if (!window_resize_check (c
, horflag
))
3430 sum_of_sizes
= sum_of_sizes
+ XINT (c
->new_total
);
3431 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3433 return (sum_of_sizes
== XINT (w
->new_total
));
3436 else if (!NILP (w
->hchild
))
3437 /* W is a horizontal combination. */
3439 c
= XWINDOW (w
->hchild
);
3441 /* The sum of the widths of the subwindows of W must equal W's
3444 int sum_of_sizes
= 0;
3447 if (!window_resize_check (c
, horflag
))
3449 sum_of_sizes
= sum_of_sizes
+ XINT (c
->new_total
);
3450 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3452 return (sum_of_sizes
== XINT (w
->new_total
));
3455 /* All subwindows of W must have the same height as W. */
3459 if ((XINT (c
->new_total
) != XINT (w
->new_total
))
3460 || !window_resize_check (c
, horflag
))
3462 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3468 /* A leaf window. Make sure it's not too small. The following
3469 hardcodes the values of `window-safe-min-width' (2) and
3470 `window-safe-min-height' (1) which are defined in window.el. */
3471 return XINT (w
->new_total
) >= (horflag
? 2 : 1);
3474 /* Set w->total_lines (w->total_cols if HORIZONTAL is non-zero) to
3475 w->new_total for window W and recursively all subwindows of W. Also
3476 calculate and assign the new vertical (horizontal) start positions of
3477 each of these windows.
3479 This function does not perform any error checks. Make sure you have
3480 run window_resize_check on W before applying this function. */
3482 window_resize_apply (struct window
*w
, int horflag
)
3487 /* Note: Assigning new_normal requires that the new total size of the
3488 parent window has been set *before*. */
3491 w
->total_cols
= w
->new_total
;
3492 if (NUMBERP (w
->new_normal
))
3493 w
->normal_cols
= w
->new_normal
;
3495 pos
= XINT (w
->left_col
);
3499 w
->total_lines
= w
->new_total
;
3500 if (NUMBERP (w
->new_normal
))
3501 w
->normal_lines
= w
->new_normal
;
3503 pos
= XINT (w
->top_line
);
3506 if (!NILP (w
->vchild
))
3507 /* W is a vertical combination. */
3509 c
= XWINDOW (w
->vchild
);
3513 XSETFASTINT (c
->left_col
, pos
);
3515 XSETFASTINT (c
->top_line
, pos
);
3516 window_resize_apply (c
, horflag
);
3518 pos
= pos
+ XINT (c
->total_lines
);
3519 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3522 else if (!NILP (w
->hchild
))
3523 /* W is a horizontal combination. */
3525 c
= XWINDOW (w
->hchild
);
3529 XSETFASTINT (c
->left_col
, pos
);
3531 XSETFASTINT (c
->top_line
, pos
);
3532 window_resize_apply (c
, horflag
);
3534 pos
= pos
+ XINT (c
->total_cols
);
3535 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3539 /* Clear out some redisplay caches. */
3540 XSETFASTINT (w
->last_modified
, 0);
3541 XSETFASTINT (w
->last_overlay_modified
, 0);
3545 DEFUN ("window-resize-apply", Fwindow_resize_apply
, Swindow_resize_apply
, 1, 2, 0,
3546 doc
: /* Apply requested size values for window-tree of FRAME.
3547 Optional argument HORIZONTAL omitted or nil means apply requested height
3548 values. HORIZONTAL non-nil means apply requested width values.
3550 This function checks whether the requested values sum up to a valid
3551 window layout, recursively assigns the new sizes of all subwindows and
3552 calculates and assigns the new start positions of these windows.
3554 Note: This function does not check any of `window-fixed-size-p',
3555 `window-min-height' or `window-min-width'. All these checks have to
3556 be applied on the Elisp level. */)
3557 (Lisp_Object frame
, Lisp_Object horizontal
)
3561 int horflag
= !NILP (horizontal
);
3564 frame
= selected_frame
;
3565 CHECK_LIVE_FRAME (frame
);
3568 r
= XWINDOW (FRAME_ROOT_WINDOW (f
));
3570 if (!window_resize_check (r
, horflag
)
3571 || ! EQ (r
->new_total
, (horflag
? r
->total_cols
: r
->total_lines
)))
3575 window_resize_apply (r
, horflag
);
3577 windows_or_buffers_changed
++;
3578 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
3583 run_window_configuration_change_hook (f
);
3589 /* Resize frame F's windows when number of lines of F is set to SIZE.
3590 HORFLAG 1 means resize windows when number of columns of F is set to
3593 This function can delete all windows but the selected one in order to
3594 satisfy the request. The result will be meaningful if and only if
3595 F's windows have meaningful sizes when you call this. */
3597 resize_frame_windows (struct frame
*f
, int size
, int horflag
)
3599 Lisp_Object root
= f
->root_window
;
3600 struct window
*r
= XWINDOW (root
);
3601 Lisp_Object mini
= f
->minibuffer_window
;
3603 /* new_size is the new size of the frame's root window. */
3604 int new_size
= (horflag
3607 - FRAME_TOP_MARGIN (f
)
3608 - ((FRAME_HAS_MINIBUF_P (f
) && !FRAME_MINIBUF_ONLY_P (f
))
3611 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
3612 if (NILP (r
->vchild
) && NILP (r
->hchild
))
3613 /* For a leaf root window just set the size. */
3615 XSETFASTINT (r
->total_cols
, new_size
);
3617 XSETFASTINT (r
->total_lines
, new_size
);
3620 /* old_size is the old size of the frame's root window. */
3621 int old_size
= XFASTINT (horflag
? r
->total_cols
: r
->total_lines
);
3624 XSETINT (delta
, new_size
- old_size
);
3625 /* Try a "normal" resize first. */
3626 resize_root_window (root
, delta
, horflag
? Qt
: Qnil
, Qnil
);
3627 if (window_resize_check (r
, horflag
) && new_size
== XINT (r
->new_total
))
3628 window_resize_apply (r
, horflag
);
3631 /* Try with "reasonable" minimum sizes next. */
3632 resize_root_window (root
, delta
, horflag
? Qt
: Qnil
, Qt
);
3633 if (window_resize_check (r
, horflag
)
3634 && new_size
== XINT (r
->new_total
))
3635 window_resize_apply (r
, horflag
);
3638 /* Finally, try with "safe" minimum sizes. */
3639 resize_root_window (root
, delta
, horflag
? Qt
: Qnil
, Qsafe
);
3640 if (window_resize_check (r
, horflag
)
3641 && new_size
== XINT (r
->new_total
))
3642 window_resize_apply (r
, horflag
);
3645 /* We lost. Delete all windows but the frame's
3647 root
= f
->selected_window
;
3648 Fdelete_other_windows_internal (root
, Qnil
);
3650 XSETFASTINT (XWINDOW (root
)->total_cols
, new_size
);
3652 XSETFASTINT (XWINDOW (root
)->total_lines
, new_size
);
3658 if (FRAME_HAS_MINIBUF_P (f
) && !FRAME_MINIBUF_ONLY_P (f
))
3662 XSETFASTINT (m
->total_cols
, size
);
3665 /* Are we sure we always want 1 line here? */
3666 XSETFASTINT (m
->total_lines
, 1);
3667 XSETFASTINT (m
->top_line
, XINT (r
->top_line
) + XINT (r
->total_lines
));
3673 DEFUN ("split-window-internal", Fsplit_window_internal
, Ssplit_window_internal
, 4, 4, 0,
3674 doc
: /* Split window OLD.
3675 Second argument TOTAL-SIZE specifies the number of lines or columns of the
3676 new window. In any case TOTAL-SIZE must be a positive integer.
3678 Third argument SIDE nil (or `below') specifies that the new window shall
3679 be located below WINDOW. SIDE `above' means the new window shall be
3680 located above WINDOW. In both cases TOTAL-SIZE specifies the number of
3681 lines of the new window including space reserved for the mode and/or
3684 SIDE t (or `right') specifies that the new window shall be located on
3685 the right side of WINDOW. SIDE `left' means the new window shall be
3686 located on the left of WINDOW. In both cases TOTAL-SIZE specifies the
3687 number of columns of the new window including space reserved for fringes
3688 and the scrollbar or a divider column.
3690 Fourth argument NORMAL-SIZE specifies the normal size of the new window
3691 according to the SIDE argument.
3693 The new total and normal sizes of all involved windows must have been
3694 set correctly. See the code of `split-window' for how this is done. */)
3695 (Lisp_Object old
, Lisp_Object total_size
, Lisp_Object side
, Lisp_Object normal_size
)
3697 /* OLD (*o) is the window we have to split. (*p) is either OLD's
3698 parent window or an internal window we have to install as OLD's new
3699 parent. REFERENCE (*r) must denote a live window, or is set to OLD
3700 provided OLD is a leaf window, or to the frame's selected window.
3701 NEW (*n) is the new window created with some parameters taken from
3703 register Lisp_Object
new, frame
, reference
;
3704 register struct window
*o
, *p
, *n
, *r
;
3707 /* HORFLAG is 1 when we split side-by-side, 0 otherwise. */
3708 = EQ (side
, Qt
) || EQ (side
, Qleft
) || EQ (side
, Qright
);
3713 frame
= WINDOW_FRAME (o
);
3716 CHECK_NUMBER (total_size
);
3718 /* Set do_nest to 1 if we have to make a new parent window. We do
3719 that if either `window-nest' is non-nil, or OLD has no parent, or
3720 OLD is ortho-combined. */
3722 !NILP (Vwindow_nest
)
3725 ? (XWINDOW (o
->parent
)->hchild
)
3726 : (XWINDOW (o
->parent
)->vchild
));
3728 /* We need a live reference window to initialize some parameters. */
3729 if (WINDOW_LIVE_P (old
))
3730 /* OLD is live, use it as reference window. */
3733 /* Use the frame's selected window as reference window. */
3734 reference
= FRAME_SELECTED_WINDOW (f
);
3735 r
= XWINDOW (reference
);
3737 /* The following bugs are caught by `split-window'. */
3738 if (MINI_WINDOW_P (o
))
3739 error ("Attempt to split minibuffer window");
3740 else if (XINT (total_size
) < (horflag
? 2 : 1))
3741 error ("Size of new window too small (after split)");
3742 else if (!do_nest
&& !NILP (Vwindow_splits
))
3743 /* `window-splits' non-nil means try to resize OLD's siblings
3746 p
= XWINDOW (o
->parent
);
3747 /* Temporarily pretend we split the parent window. */
3748 XSETINT (p
->new_total
,
3749 XINT (horflag
? p
->total_cols
: p
->total_lines
)
3750 - XINT (total_size
));
3751 if (!window_resize_check (p
, horflag
))
3752 error ("Window sizes don't fit");
3754 /* Undo the temporary pretension. */
3755 p
->new_total
= horflag
? p
->total_cols
: p
->total_lines
;
3759 if (!window_resize_check (o
, horflag
))
3760 error ("Resizing old window failed");
3761 else if (XINT (total_size
) + XINT (o
->new_total
)
3762 != XINT (horflag
? o
->total_cols
: o
->total_lines
))
3763 error ("Sum of sizes of old and new window don't fit");
3766 /* This is our point of no return. */
3769 /* Save the old value of o->normal_cols/lines. It gets corrupted
3770 by make_parent_window and we need it below for assigning it to
3772 Lisp_Object new_normal
= horflag
? o
->normal_cols
: o
->normal_lines
;
3774 make_parent_window (old
, horflag
);
3775 p
= XWINDOW (o
->parent
);
3776 /* Store value of `window-nest' in new parent's nest slot. */
3777 p
->nest
= Vwindow_nest
;
3778 /* Have PARENT inherit splits slot value from OLD. */
3779 p
->splits
= o
->splits
;
3780 /* Store value of `window-splits' in OLD's splits slot. */
3781 o
->splits
= Vwindow_splits
;
3782 /* These get applied below. */
3783 p
->new_total
= horflag
? o
->total_cols
: o
->total_lines
;
3784 p
->new_normal
= new_normal
;
3787 p
= XWINDOW (o
->parent
);
3789 windows_or_buffers_changed
++;
3790 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
3791 new = make_window ();
3794 n
->parent
= o
->parent
;
3795 n
->vchild
= n
->hchild
= Qnil
;
3797 if (EQ (side
, Qabove
) || EQ (side
, Qleft
))
3806 XWINDOW (n
->prev
)->next
= new;
3813 if (!NILP (n
->next
))
3814 XWINDOW (n
->next
)->prev
= new;
3820 n
->window_end_valid
= Qnil
;
3821 memset (&n
->last_cursor
, 0, sizeof n
->last_cursor
);
3823 /* Get special geometry settings from reference window. */
3824 n
->left_margin_cols
= r
->left_margin_cols
;
3825 n
->right_margin_cols
= r
->right_margin_cols
;
3826 n
->left_fringe_width
= r
->left_fringe_width
;
3827 n
->right_fringe_width
= r
->right_fringe_width
;
3828 n
->fringes_outside_margins
= r
->fringes_outside_margins
;
3829 n
->scroll_bar_width
= r
->scroll_bar_width
;
3830 n
->vertical_scroll_bar_type
= r
->vertical_scroll_bar_type
;
3832 /* Store `window-splits' in NEW's splits slot. */
3833 n
->splits
= Vwindow_splits
;
3835 /* Directly assign orthogonal coordinates and sizes. */
3838 n
->top_line
= o
->top_line
;
3839 n
->total_lines
= o
->total_lines
;
3843 n
->left_col
= o
->left_col
;
3844 n
->total_cols
= o
->total_cols
;
3847 /* Iso-coordinates and sizes are assigned by window_resize_apply,
3848 get them ready here. */
3849 n
->new_total
= total_size
;
3850 n
->new_normal
= normal_size
;
3853 window_resize_apply (p
, horflag
);
3855 /* Set buffer of NEW to buffer of reference window. Don't run
3857 set_window_buffer (new, r
->buffer
, 0, 1);
3860 /* Maybe we should run the scroll functions in Elisp (which already
3861 runs the configuration change hook). */
3862 if (! NILP (Vwindow_scroll_functions
))
3863 run_hook_with_args_2 (Qwindow_scroll_functions
, new,
3864 Fmarker_position (n
->start
));
3870 DEFUN ("delete-window-internal", Fdelete_window_internal
, Sdelete_window_internal
, 1, 1, 0,
3871 doc
: /* Remove WINDOW from its frame.
3872 WINDOW defaults to the selected window. Return nil. Signal an error
3873 when WINDOW is the only window on its frame. */)
3874 (register Lisp_Object window
)
3876 register Lisp_Object parent
, sibling
, frame
, root
;
3877 struct window
*w
, *p
, *s
, *r
;
3880 int before_sibling
= 0;
3882 w
= decode_any_window (window
);
3883 XSETWINDOW (window
, w
);
3884 if (NILP (w
->buffer
) && NILP (w
->hchild
) && NILP (w
->vchild
))
3885 /* It's a no-op to delete an already deleted window. */
3890 /* Never delete a minibuffer or frame root window. */
3891 error ("Attempt to delete minibuffer or sole ordinary window");
3892 else if (NILP (w
->prev
) && NILP (w
->next
))
3893 /* Rather bow out here, this case should be handled on the Elisp
3895 error ("Attempt to delete sole window of parent");
3897 p
= XWINDOW (parent
);
3898 horflag
= NILP (p
->vchild
);
3900 frame
= WINDOW_FRAME (w
);
3903 root
= FRAME_ROOT_WINDOW (f
);
3906 /* Unlink WINDOW from window tree. */
3908 /* Get SIBLING below (on the right of) WINDOW. */
3910 /* before_sibling 1 means WINDOW is the first child of its
3911 parent and thus before the sibling. */
3914 s
= XWINDOW (sibling
);
3917 p
->hchild
= sibling
;
3919 p
->vchild
= sibling
;
3922 /* Get SIBLING above (on the left of) WINDOW. */
3925 s
= XWINDOW (sibling
);
3927 if (!NILP (s
->next
))
3928 XWINDOW (s
->next
)->prev
= sibling
;
3931 if (window_resize_check (r
, horflag
)
3932 && EQ (r
->new_total
, (horflag
? r
->total_cols
: r
->total_lines
)))
3933 /* We can delete WINDOW now. */
3937 window_resize_apply (p
, horflag
);
3939 windows_or_buffers_changed
++;
3940 Vwindow_list
= Qnil
;
3941 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
3943 w
->next
= Qnil
; /* Don't delete w->next too. */
3944 free_window_matrices (w
);
3946 if (!NILP (w
->vchild
))
3948 delete_all_subwindows (w
->vchild
);
3951 else if (!NILP (w
->hchild
))
3953 delete_all_subwindows (w
->hchild
);
3956 else if (!NILP (w
->buffer
))
3959 unchain_marker (XMARKER (w
->pointm
));
3960 unchain_marker (XMARKER (w
->start
));
3964 if (NILP (s
->prev
) && NILP (s
->next
))
3965 /* A matrjoshka where SIBLING has become the only child of
3968 /* Put SIBLING into PARENT's place. */
3969 replace_window (parent
, sibling
, 0);
3970 /* Have SIBLING inherit the following three slot values from
3971 PARENT (the nest slot is not inherited). */
3972 s
->normal_cols
= p
->normal_cols
;
3973 s
->normal_lines
= p
->normal_lines
;
3974 s
->splits
= p
->splits
;
3975 /* Mark PARENT as deleted. */
3976 p
->vchild
= p
->hchild
= Qnil
;
3977 /* Try to merge SIBLING into its new parent. */
3978 recombine_windows (sibling
);
3983 if (!WINDOW_LIVE_P (FRAME_SELECTED_WINDOW (f
)))
3984 /* We deleted the frame's selected window. */
3986 /* Use the frame's first window as fallback ... */
3987 Lisp_Object new_selected_window
= Fframe_first_window (frame
);
3988 /* ... but preferably use its most recently used window. */
3989 Lisp_Object mru_window
;
3991 /* `get-mru-window' might fail for some reason so play it safe
3992 - promote the first window _without recording it_ first. */
3993 if (EQ (FRAME_SELECTED_WINDOW (f
), selected_window
))
3994 Fselect_window (new_selected_window
, Qt
);
3996 FRAME_SELECTED_WINDOW (f
) = new_selected_window
;
4000 /* Now look whether `get-mru-window' gets us something. */
4001 mru_window
= call1 (Qget_mru_window
, frame
);
4002 if (WINDOW_LIVE_P (mru_window
)
4003 && EQ (XWINDOW (mru_window
)->frame
, frame
))
4004 new_selected_window
= mru_window
;
4006 /* If all ended up well, we now promote the mru window. */
4007 if (EQ (FRAME_SELECTED_WINDOW (f
), selected_window
))
4008 Fselect_window (new_selected_window
, Qnil
);
4010 FRAME_SELECTED_WINDOW (f
) = new_selected_window
;
4015 /* Must be run by the caller:
4016 run_window_configuration_change_hook (f); */
4019 /* We failed: Relink WINDOW into window tree. */
4032 if (!NILP (w
->next
))
4033 XWINDOW (w
->next
)->prev
= window
;
4035 error ("Deletion failed");
4041 /***********************************************************************
4042 Resizing Mini-Windows
4043 ***********************************************************************/
4045 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we
4048 grow_mini_window (struct window
*w
, int delta
)
4050 struct frame
*f
= XFRAME (w
->frame
);
4052 Lisp_Object root
, value
;
4054 xassert (MINI_WINDOW_P (w
));
4055 xassert (delta
>= 0);
4057 root
= FRAME_ROOT_WINDOW (f
);
4059 value
= call2 (Qwindow_resize_root_window_vertically
,
4060 root
, make_number (- delta
));
4061 if (INTEGERP (value
) && window_resize_check (r
, 0))
4064 window_resize_apply (r
, 0);
4066 /* Grow the mini-window. */
4067 XSETFASTINT (w
->top_line
, XFASTINT (r
->top_line
) + XFASTINT (r
->total_lines
));
4068 XSETFASTINT (w
->total_lines
, XFASTINT (w
->total_lines
) - XINT (value
));
4069 XSETFASTINT (w
->last_modified
, 0);
4070 XSETFASTINT (w
->last_overlay_modified
, 0);
4078 /* Shrink mini-window W. */
4080 shrink_mini_window (struct window
*w
)
4082 struct frame
*f
= XFRAME (w
->frame
);
4084 Lisp_Object root
, value
;
4087 xassert (MINI_WINDOW_P (w
));
4089 size
= XINT (w
->total_lines
);
4092 root
= FRAME_ROOT_WINDOW (f
);
4094 value
= call2 (Qwindow_resize_root_window_vertically
,
4095 root
, make_number (size
- 1));
4096 if (INTEGERP (value
) && window_resize_check (r
, 0))
4099 window_resize_apply (r
, 0);
4101 /* Shrink the mini-window. */
4102 XSETFASTINT (w
->top_line
, XFASTINT (r
->top_line
) + XFASTINT (r
->total_lines
));
4103 XSETFASTINT (w
->total_lines
, 1);
4105 XSETFASTINT (w
->last_modified
, 0);
4106 XSETFASTINT (w
->last_overlay_modified
, 0);
4111 /* If the above failed for whatever strange reason we must make a
4112 one window frame here. The same routine will be needed when
4113 shrinking the frame (and probably when making the initial
4114 *scratch* window). For the moment leave things as they are. */
4118 DEFUN ("resize-mini-window-internal", Fresize_mini_window_internal
, Sresize_mini_window_internal
, 1, 1, 0,
4119 doc
: /* Resize minibuffer window WINDOW. */)
4120 (Lisp_Object window
)
4122 struct window
*w
= XWINDOW (window
);
4127 CHECK_WINDOW (window
);
4128 f
= XFRAME (w
->frame
);
4130 if (!EQ (FRAME_MINIBUF_WINDOW (XFRAME (w
->frame
)), window
))
4131 error ("Not a valid minibuffer window");
4132 else if (FRAME_MINIBUF_ONLY_P (f
))
4133 error ("Cannot resize a minibuffer-only frame");
4135 r
= XWINDOW (FRAME_ROOT_WINDOW (f
));
4136 height
= XINT (r
->total_lines
) + XINT (w
->total_lines
);
4137 if (window_resize_check (r
, 0)
4138 && XINT (w
->new_total
) > 0
4139 && height
== XINT (r
->new_total
) + XINT (w
->new_total
))
4142 window_resize_apply (r
, 0);
4144 w
->total_lines
= w
->new_total
;
4145 XSETFASTINT (w
->top_line
, XINT (r
->top_line
) + XINT (r
->total_lines
));
4147 windows_or_buffers_changed
++;
4148 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
4152 run_window_configuration_change_hook (f
);
4155 else error ("Failed to resize minibuffer window");
4158 /* Mark window cursors off for all windows in the window tree rooted
4159 at W by setting their phys_cursor_on_p flag to zero. Called from
4160 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4161 the frame are cleared. */
4164 mark_window_cursors_off (struct window
*w
)
4168 if (!NILP (w
->hchild
))
4169 mark_window_cursors_off (XWINDOW (w
->hchild
));
4170 else if (!NILP (w
->vchild
))
4171 mark_window_cursors_off (XWINDOW (w
->vchild
));
4173 w
->phys_cursor_on_p
= 0;
4175 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
4180 /* Return number of lines of text (not counting mode lines) in W. */
4183 window_internal_height (struct window
*w
)
4185 int ht
= XFASTINT (w
->total_lines
);
4187 if (!MINI_WINDOW_P (w
))
4189 if (!NILP (w
->parent
)
4190 || !NILP (w
->vchild
)
4191 || !NILP (w
->hchild
)
4194 || WINDOW_WANTS_MODELINE_P (w
))
4197 if (WINDOW_WANTS_HEADER_LINE_P (w
))
4204 /************************************************************************
4206 ***********************************************************************/
4208 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4209 N screen-fulls, which is defined as the height of the window minus
4210 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4211 instead. Negative values of N mean scroll down. NOERROR non-zero
4212 means don't signal an error if we try to move over BEGV or ZV,
4216 window_scroll (Lisp_Object window
, EMACS_INT n
, int whole
, int noerror
)
4219 n
= clip_to_bounds (INT_MIN
, n
, INT_MAX
);
4221 /* If we must, use the pixel-based version which is much slower than
4222 the line-based one but can handle varying line heights. */
4223 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window
)->frame
)))
4224 window_scroll_pixel_based (window
, n
, whole
, noerror
);
4226 window_scroll_line_based (window
, n
, whole
, noerror
);
4232 /* Implementation of window_scroll that works based on pixel line
4233 heights. See the comment of window_scroll for parameter
4237 window_scroll_pixel_based (Lisp_Object window
, int n
, int whole
, int noerror
)
4240 struct window
*w
= XWINDOW (window
);
4241 struct text_pos start
;
4242 int this_scroll_margin
;
4243 /* True if we fiddled the window vscroll field without really scrolling. */
4245 int x
, y
, rtop
, rbot
, rowh
, vpos
;
4246 void *itdata
= NULL
;
4248 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
4250 /* If PT is not visible in WINDOW, move back one half of
4251 the screen. Allow PT to be partially visible, otherwise
4252 something like (scroll-down 1) with PT in the line before
4253 the partially visible one would recenter. */
4255 if (!pos_visible_p (w
, PT
, &x
, &y
, &rtop
, &rbot
, &rowh
, &vpos
))
4257 itdata
= bidi_shelve_cache ();
4258 /* Move backward half the height of the window. Performance note:
4259 vmotion used here is about 10% faster, but would give wrong
4260 results for variable height lines. */
4261 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
4262 it
.current_y
= it
.last_visible_y
;
4263 move_it_vertically_backward (&it
, window_box_height (w
) / 2);
4265 /* The function move_iterator_vertically may move over more than
4266 the specified y-distance. If it->w is small, e.g. a
4267 mini-buffer window, we may end up in front of the window's
4268 display area. This is the case when Start displaying at the
4269 start of the line containing PT in this case. */
4270 if (it
.current_y
<= 0)
4272 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
4273 move_it_vertically_backward (&it
, 0);
4277 start
= it
.current
.pos
;
4278 bidi_unshelve_cache (itdata
, 0);
4280 else if (auto_window_vscroll_p
)
4282 if (rtop
|| rbot
) /* partially visible */
4285 int dy
= WINDOW_FRAME_LINE_HEIGHT (w
);
4287 dy
= max ((window_box_height (w
)
4288 - next_screen_context_lines
* dy
),
4294 /* Only vscroll backwards if already vscrolled forwards. */
4295 if (w
->vscroll
< 0 && rtop
> 0)
4297 px
= max (0, -w
->vscroll
- min (rtop
, -dy
));
4298 Fset_window_vscroll (window
, make_number (px
), Qt
);
4304 /* Do vscroll if already vscrolled or only display line. */
4305 if (rbot
> 0 && (w
->vscroll
< 0 || vpos
== 0))
4307 px
= max (0, -w
->vscroll
+ min (rbot
, dy
));
4308 Fset_window_vscroll (window
, make_number (px
), Qt
);
4312 /* Maybe modify window start instead of scrolling. */
4313 if (rbot
> 0 || w
->vscroll
< 0)
4317 Fset_window_vscroll (window
, make_number (0), Qt
);
4318 /* If there are other text lines above the current row,
4319 move window start to current row. Else to next row. */
4321 spos
= XINT (Fline_beginning_position (Qnil
));
4323 spos
= min (XINT (Fline_end_position (Qnil
)) + 1, ZV
);
4324 set_marker_restricted (w
->start
, make_number (spos
),
4326 w
->start_at_line_beg
= Qt
;
4327 w
->update_mode_line
= Qt
;
4328 XSETFASTINT (w
->last_modified
, 0);
4329 XSETFASTINT (w
->last_overlay_modified
, 0);
4330 /* Set force_start so that redisplay_window will run the
4331 window-scroll-functions. */
4332 w
->force_start
= Qt
;
4337 /* Cancel previous vscroll. */
4338 Fset_window_vscroll (window
, make_number (0), Qt
);
4341 itdata
= bidi_shelve_cache ();
4342 /* If scroll_preserve_screen_position is non-nil, we try to set
4343 point in the same window line as it is now, so get that line. */
4344 if (!NILP (Vscroll_preserve_screen_position
))
4346 /* We preserve the goal pixel coordinate across consecutive
4347 calls to scroll-up, scroll-down and other commands that
4348 have the `scroll-command' property. This avoids the
4349 possibility of point becoming "stuck" on a tall line when
4350 scrolling by one line. */
4351 if (window_scroll_pixel_based_preserve_y
< 0
4352 || !SYMBOLP (KVAR (current_kboard
, Vlast_command
))
4353 || NILP (Fget (KVAR (current_kboard
, Vlast_command
), Qscroll_command
)))
4355 start_display (&it
, w
, start
);
4356 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
4357 window_scroll_pixel_based_preserve_y
= it
.current_y
;
4358 window_scroll_pixel_based_preserve_x
= it
.current_x
;
4362 window_scroll_pixel_based_preserve_y
4363 = window_scroll_pixel_based_preserve_x
= -1;
4365 /* Move iterator it from start the specified distance forward or
4366 backward. The result is the new window start. */
4367 start_display (&it
, w
, start
);
4370 ptrdiff_t start_pos
= IT_CHARPOS (it
);
4371 int dy
= WINDOW_FRAME_LINE_HEIGHT (w
);
4372 dy
= max ((window_box_height (w
)
4373 - next_screen_context_lines
* dy
),
4376 /* Note that move_it_vertically always moves the iterator to the
4377 start of a line. So, if the last line doesn't have a newline,
4378 we would end up at the start of the line ending at ZV. */
4381 move_it_vertically_backward (&it
, -dy
);
4382 /* Ensure we actually do move, e.g. in case we are currently
4383 looking at an image that is taller that the window height. */
4384 while (start_pos
== IT_CHARPOS (it
)
4385 && start_pos
> BEGV
)
4386 move_it_by_lines (&it
, -1);
4390 move_it_to (&it
, ZV
, -1, it
.current_y
+ dy
, -1,
4391 MOVE_TO_POS
| MOVE_TO_Y
);
4392 /* Ensure we actually do move, e.g. in case we are currently
4393 looking at an image that is taller that the window height. */
4394 while (start_pos
== IT_CHARPOS (it
)
4396 move_it_by_lines (&it
, 1);
4400 move_it_by_lines (&it
, n
);
4402 /* We failed if we find ZV is already on the screen (scrolling up,
4403 means there's nothing past the end), or if we can't start any
4404 earlier (scrolling down, means there's nothing past the top). */
4405 if ((n
> 0 && IT_CHARPOS (it
) == ZV
)
4406 || (n
< 0 && IT_CHARPOS (it
) == CHARPOS (start
)))
4408 if (IT_CHARPOS (it
) == ZV
)
4410 if (it
.current_y
< it
.last_visible_y
4411 && (it
.current_y
+ it
.max_ascent
+ it
.max_descent
4412 > it
.last_visible_y
))
4414 /* The last line was only partially visible, make it fully
4416 w
->vscroll
= (it
.last_visible_y
4417 - it
.current_y
+ it
.max_ascent
+ it
.max_descent
);
4418 adjust_glyphs (it
.f
);
4422 bidi_unshelve_cache (itdata
, 0);
4425 else if (n
< 0) /* could happen with empty buffers */
4426 xsignal0 (Qbeginning_of_buffer
);
4428 xsignal0 (Qend_of_buffer
);
4433 if (w
->vscroll
!= 0)
4434 /* The first line was only partially visible, make it fully
4439 bidi_unshelve_cache (itdata
, 0);
4443 xsignal0 (Qbeginning_of_buffer
);
4447 /* If control gets here, then we vscrolled. */
4449 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
4451 /* Don't try to change the window start below. */
4457 ptrdiff_t pos
= IT_CHARPOS (it
);
4460 /* If in the middle of a multi-glyph character move forward to
4461 the next character. */
4462 if (in_display_vector_p (&it
))
4465 move_it_to (&it
, pos
, -1, -1, -1, MOVE_TO_POS
);
4468 /* Set the window start, and set up the window for redisplay. */
4469 set_marker_restricted (w
->start
, make_number (pos
),
4471 bytepos
= XMARKER (w
->start
)->bytepos
;
4472 w
->start_at_line_beg
= ((pos
== BEGV
|| FETCH_BYTE (bytepos
- 1) == '\n')
4474 w
->update_mode_line
= Qt
;
4475 XSETFASTINT (w
->last_modified
, 0);
4476 XSETFASTINT (w
->last_overlay_modified
, 0);
4477 /* Set force_start so that redisplay_window will run the
4478 window-scroll-functions. */
4479 w
->force_start
= Qt
;
4482 /* The rest of this function uses current_y in a nonstandard way,
4483 not including the height of the header line if any. */
4484 it
.current_y
= it
.vpos
= 0;
4486 /* Move PT out of scroll margins.
4487 This code wants current_y to be zero at the window start position
4488 even if there is a header line. */
4489 this_scroll_margin
= max (0, scroll_margin
);
4490 this_scroll_margin
= min (this_scroll_margin
, XFASTINT (w
->total_lines
) / 4);
4491 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
4495 /* We moved the window start towards ZV, so PT may be now
4496 in the scroll margin at the top. */
4497 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
4498 if (IT_CHARPOS (it
) == PT
&& it
.current_y
>= this_scroll_margin
4499 && (NILP (Vscroll_preserve_screen_position
)
4500 || EQ (Vscroll_preserve_screen_position
, Qt
)))
4501 /* We found PT at a legitimate height. Leave it alone. */
4503 else if (window_scroll_pixel_based_preserve_y
>= 0)
4505 /* If we have a header line, take account of it.
4506 This is necessary because we set it.current_y to 0, above. */
4507 move_it_to (&it
, -1,
4508 window_scroll_pixel_based_preserve_x
,
4509 window_scroll_pixel_based_preserve_y
4510 - (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0 ),
4511 -1, MOVE_TO_Y
| MOVE_TO_X
);
4512 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
4516 while (it
.current_y
< this_scroll_margin
)
4518 int prev
= it
.current_y
;
4519 move_it_by_lines (&it
, 1);
4520 if (prev
== it
.current_y
)
4523 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
4528 ptrdiff_t charpos
, bytepos
;
4531 /* Save our position, for the
4532 window_scroll_pixel_based_preserve_y case. */
4533 charpos
= IT_CHARPOS (it
);
4534 bytepos
= IT_BYTEPOS (it
);
4536 /* We moved the window start towards BEGV, so PT may be now
4537 in the scroll margin at the bottom. */
4538 move_it_to (&it
, PT
, -1,
4539 (it
.last_visible_y
- CURRENT_HEADER_LINE_HEIGHT (w
)
4540 - this_scroll_margin
- 1),
4542 MOVE_TO_POS
| MOVE_TO_Y
);
4544 /* Save our position, in case it's correct. */
4545 charpos
= IT_CHARPOS (it
);
4546 bytepos
= IT_BYTEPOS (it
);
4548 /* See if point is on a partially visible line at the end. */
4549 if (it
.what
== IT_EOB
)
4550 partial_p
= it
.current_y
+ it
.ascent
+ it
.descent
> it
.last_visible_y
;
4553 move_it_by_lines (&it
, 1);
4554 partial_p
= it
.current_y
> it
.last_visible_y
;
4557 if (charpos
== PT
&& !partial_p
4558 && (NILP (Vscroll_preserve_screen_position
)
4559 || EQ (Vscroll_preserve_screen_position
, Qt
)))
4560 /* We found PT before we found the display margin, so PT is ok. */
4562 else if (window_scroll_pixel_based_preserve_y
>= 0)
4564 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
4565 start_display (&it
, w
, start
);
4566 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
4567 here because we called start_display again and did not
4568 alter it.current_y this time. */
4569 move_it_to (&it
, -1, window_scroll_pixel_based_preserve_x
,
4570 window_scroll_pixel_based_preserve_y
, -1,
4571 MOVE_TO_Y
| MOVE_TO_X
);
4572 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
4577 /* The last line was only partially visible, so back up two
4578 lines to make sure we're on a fully visible line. */
4580 move_it_by_lines (&it
, -2);
4581 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
4584 /* No, the position we saved is OK, so use it. */
4585 SET_PT_BOTH (charpos
, bytepos
);
4588 bidi_unshelve_cache (itdata
, 0);
4592 /* Implementation of window_scroll that works based on screen lines.
4593 See the comment of window_scroll for parameter descriptions. */
4596 window_scroll_line_based (Lisp_Object window
, int n
, int whole
, int noerror
)
4598 register struct window
*w
= XWINDOW (window
);
4599 /* Fvertical_motion enters redisplay, which can trigger
4600 fontification, which in turn can modify buffer text (e.g., if the
4601 fontification functions replace escape sequences with faces, as
4602 in `grep-mode-font-lock-keywords'). So we use a marker to record
4603 the old point position, to prevent crashes in SET_PT_BOTH. */
4604 Lisp_Object opoint_marker
= Fpoint_marker ();
4605 register ptrdiff_t pos
, pos_byte
;
4606 register int ht
= window_internal_height (w
);
4607 register Lisp_Object tem
;
4611 Lisp_Object original_pos
= Qnil
;
4613 /* If scrolling screen-fulls, compute the number of lines to
4614 scroll from the window's height. */
4616 n
*= max (1, ht
- next_screen_context_lines
);
4618 startpos
= marker_position (w
->start
);
4620 if (!NILP (Vscroll_preserve_screen_position
))
4622 if (window_scroll_preserve_vpos
<= 0
4623 || !SYMBOLP (KVAR (current_kboard
, Vlast_command
))
4624 || NILP (Fget (KVAR (current_kboard
, Vlast_command
), Qscroll_command
)))
4626 struct position posit
4627 = *compute_motion (startpos
, 0, 0, 0,
4629 -1, XINT (w
->hscroll
),
4631 window_scroll_preserve_vpos
= posit
.vpos
;
4632 window_scroll_preserve_hpos
= posit
.hpos
+ XINT (w
->hscroll
);
4635 original_pos
= Fcons (make_number (window_scroll_preserve_hpos
),
4636 make_number (window_scroll_preserve_vpos
));
4639 XSETFASTINT (tem
, PT
);
4640 tem
= Fpos_visible_in_window_p (tem
, window
, Qnil
);
4644 Fvertical_motion (make_number (- (ht
/ 2)), window
);
4649 lose
= n
< 0 && PT
== BEGV
;
4650 Fvertical_motion (make_number (n
), window
);
4654 SET_PT_BOTH (marker_position (opoint_marker
),
4655 marker_byte_position (opoint_marker
));
4662 xsignal0 (Qbeginning_of_buffer
);
4667 /* Don't use a scroll margin that is negative or too large. */
4668 int this_scroll_margin
=
4669 max (0, min (scroll_margin
, XINT (w
->total_lines
) / 4));
4671 set_marker_restricted_both (w
->start
, w
->buffer
, pos
, pos_byte
);
4672 w
->start_at_line_beg
= bolp
;
4673 w
->update_mode_line
= Qt
;
4674 XSETFASTINT (w
->last_modified
, 0);
4675 XSETFASTINT (w
->last_overlay_modified
, 0);
4676 /* Set force_start so that redisplay_window will run
4677 the window-scroll-functions. */
4678 w
->force_start
= Qt
;
4680 if (!NILP (Vscroll_preserve_screen_position
)
4681 && (whole
|| !EQ (Vscroll_preserve_screen_position
, Qt
)))
4683 SET_PT_BOTH (pos
, pos_byte
);
4684 Fvertical_motion (original_pos
, window
);
4686 /* If we scrolled forward, put point enough lines down
4687 that it is outside the scroll margin. */
4692 if (this_scroll_margin
> 0)
4694 SET_PT_BOTH (pos
, pos_byte
);
4695 Fvertical_motion (make_number (this_scroll_margin
), window
);
4701 if (top_margin
<= marker_position (opoint_marker
))
4702 SET_PT_BOTH (marker_position (opoint_marker
),
4703 marker_byte_position (opoint_marker
));
4704 else if (!NILP (Vscroll_preserve_screen_position
))
4706 SET_PT_BOTH (pos
, pos_byte
);
4707 Fvertical_motion (original_pos
, window
);
4710 SET_PT (top_margin
);
4716 /* If we scrolled backward, put point near the end of the window
4717 but not within the scroll margin. */
4718 SET_PT_BOTH (pos
, pos_byte
);
4719 tem
= Fvertical_motion (make_number (ht
- this_scroll_margin
), window
);
4720 if (XFASTINT (tem
) == ht
- this_scroll_margin
)
4723 bottom_margin
= PT
+ 1;
4725 if (bottom_margin
> marker_position (opoint_marker
))
4726 SET_PT_BOTH (marker_position (opoint_marker
),
4727 marker_byte_position (opoint_marker
));
4730 if (!NILP (Vscroll_preserve_screen_position
))
4732 SET_PT_BOTH (pos
, pos_byte
);
4733 Fvertical_motion (original_pos
, window
);
4736 Fvertical_motion (make_number (-1), window
);
4745 xsignal0 (Qend_of_buffer
);
4750 /* Scroll selected_window up or down. If N is nil, scroll a
4751 screen-full which is defined as the height of the window minus
4752 next_screen_context_lines. If N is the symbol `-', scroll.
4753 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
4754 up. This is the guts of Fscroll_up and Fscroll_down. */
4757 scroll_command (Lisp_Object n
, int direction
)
4759 ptrdiff_t count
= SPECPDL_INDEX ();
4761 xassert (eabs (direction
) == 1);
4763 /* If selected window's buffer isn't current, make it current for
4764 the moment. But don't screw up if window_scroll gets an error. */
4765 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
4767 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
4768 Fset_buffer (XWINDOW (selected_window
)->buffer
);
4770 /* Make redisplay consider other windows than just selected_window. */
4771 ++windows_or_buffers_changed
;
4775 window_scroll (selected_window
, direction
, 1, 0);
4776 else if (EQ (n
, Qminus
))
4777 window_scroll (selected_window
, -direction
, 1, 0);
4780 n
= Fprefix_numeric_value (n
);
4781 window_scroll (selected_window
, XINT (n
) * direction
, 0, 0);
4784 unbind_to (count
, Qnil
);
4787 DEFUN ("scroll-up", Fscroll_up
, Sscroll_up
, 0, 1, "^P",
4788 doc
: /* Scroll text of selected window upward ARG lines.
4789 If ARG is omitted or nil, scroll upward by a near full screen.
4790 A near full screen is `next-screen-context-lines' less than a full screen.
4791 Negative ARG means scroll downward.
4792 If ARG is the atom `-', scroll downward by nearly full screen.
4793 When calling from a program, supply as argument a number, nil, or `-'. */)
4796 scroll_command (arg
, 1);
4800 DEFUN ("scroll-down", Fscroll_down
, Sscroll_down
, 0, 1, "^P",
4801 doc
: /* Scroll text of selected window down ARG lines.
4802 If ARG is omitted or nil, scroll down by a near full screen.
4803 A near full screen is `next-screen-context-lines' less than a full screen.
4804 Negative ARG means scroll upward.
4805 If ARG is the atom `-', scroll upward by nearly full screen.
4806 When calling from a program, supply as argument a number, nil, or `-'. */)
4809 scroll_command (arg
, -1);
4813 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling
, Sother_window_for_scrolling
, 0, 0, 0,
4814 doc
: /* Return the other window for \"other window scroll\" commands.
4815 If `other-window-scroll-buffer' is non-nil, a window
4816 showing that buffer is used.
4817 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4818 specifies the window. This takes precedence over
4819 `other-window-scroll-buffer'. */)
4824 if (MINI_WINDOW_P (XWINDOW (selected_window
))
4825 && !NILP (Vminibuf_scroll_window
))
4826 window
= Vminibuf_scroll_window
;
4827 /* If buffer is specified, scroll that buffer. */
4828 else if (!NILP (Vother_window_scroll_buffer
))
4830 window
= Fget_buffer_window (Vother_window_scroll_buffer
, Qnil
);
4832 window
= display_buffer (Vother_window_scroll_buffer
, Qt
, Qnil
);
4836 /* Nothing specified; look for a neighboring window on the same
4838 window
= Fnext_window (selected_window
, Qnil
, Qnil
);
4840 if (EQ (window
, selected_window
))
4841 /* That didn't get us anywhere; look for a window on another
4844 window
= Fnext_window (window
, Qnil
, Qt
);
4845 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window
))))
4846 && ! EQ (window
, selected_window
));
4849 CHECK_LIVE_WINDOW (window
);
4851 if (EQ (window
, selected_window
))
4852 error ("There is no other window");
4857 DEFUN ("scroll-other-window", Fscroll_other_window
, Sscroll_other_window
, 0, 1, "P",
4858 doc
: /* Scroll next window upward ARG lines; or near full screen if no ARG.
4859 A near full screen is `next-screen-context-lines' less than a full screen.
4860 The next window is the one below the current one; or the one at the top
4861 if the current one is at the bottom. Negative ARG means scroll downward.
4862 If ARG is the atom `-', scroll downward by nearly full screen.
4863 When calling from a program, supply as argument a number, nil, or `-'.
4865 If `other-window-scroll-buffer' is non-nil, scroll the window
4866 showing that buffer, popping the buffer up if necessary.
4867 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4868 specifies the window to scroll. This takes precedence over
4869 `other-window-scroll-buffer'. */)
4874 ptrdiff_t count
= SPECPDL_INDEX ();
4876 window
= Fother_window_for_scrolling ();
4877 w
= XWINDOW (window
);
4879 /* Don't screw up if window_scroll gets an error. */
4880 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
4881 ++windows_or_buffers_changed
;
4883 Fset_buffer (w
->buffer
);
4884 SET_PT (marker_position (w
->pointm
));
4887 window_scroll (window
, 1, 1, 1);
4888 else if (EQ (arg
, Qminus
))
4889 window_scroll (window
, -1, 1, 1);
4895 window_scroll (window
, XINT (arg
), 0, 1);
4898 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
4899 unbind_to (count
, Qnil
);
4904 DEFUN ("scroll-left", Fscroll_left
, Sscroll_left
, 0, 2, "^P\np",
4905 doc
: /* Scroll selected window display ARG columns left.
4906 Default for ARG is window width minus 2.
4907 Value is the total amount of leftward horizontal scrolling in
4908 effect after the change.
4909 If SET-MINIMUM is non-nil, the new scroll amount becomes the
4910 lower bound for automatic scrolling, i.e. automatic scrolling
4911 will not scroll a window to a column less than the value returned
4912 by this function. This happens in an interactive call. */)
4913 (register Lisp_Object arg
, Lisp_Object set_minimum
)
4917 struct window
*w
= XWINDOW (selected_window
);
4920 XSETFASTINT (arg
, window_body_cols (w
) - 2);
4922 arg
= Fprefix_numeric_value (arg
);
4924 hscroll
= XINT (w
->hscroll
) + XINT (arg
);
4925 result
= Fset_window_hscroll (selected_window
, make_number (hscroll
));
4927 if (!NILP (set_minimum
))
4928 w
->min_hscroll
= w
->hscroll
;
4933 DEFUN ("scroll-right", Fscroll_right
, Sscroll_right
, 0, 2, "^P\np",
4934 doc
: /* Scroll selected window display ARG columns right.
4935 Default for ARG is window width minus 2.
4936 Value is the total amount of leftward horizontal scrolling in
4937 effect after the change.
4938 If SET-MINIMUM is non-nil, the new scroll amount becomes the
4939 lower bound for automatic scrolling, i.e. automatic scrolling
4940 will not scroll a window to a column less than the value returned
4941 by this function. This happens in an interactive call. */)
4942 (register Lisp_Object arg
, Lisp_Object set_minimum
)
4946 struct window
*w
= XWINDOW (selected_window
);
4949 XSETFASTINT (arg
, window_body_cols (w
) - 2);
4951 arg
= Fprefix_numeric_value (arg
);
4953 hscroll
= XINT (w
->hscroll
) - XINT (arg
);
4954 result
= Fset_window_hscroll (selected_window
, make_number (hscroll
));
4956 if (!NILP (set_minimum
))
4957 w
->min_hscroll
= w
->hscroll
;
4962 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window
, Sminibuffer_selected_window
, 0, 0, 0,
4963 doc
: /* Return the window which was selected when entering the minibuffer.
4964 Returns nil, if selected window is not a minibuffer window. */)
4967 if (minibuf_level
> 0
4968 && MINI_WINDOW_P (XWINDOW (selected_window
))
4969 && WINDOW_LIVE_P (minibuf_selected_window
))
4970 return minibuf_selected_window
;
4975 /* Value is the number of lines actually displayed in window W,
4976 as opposed to its height. */
4979 displayed_window_lines (struct window
*w
)
4982 struct text_pos start
;
4983 int height
= window_box_height (w
);
4984 struct buffer
*old_buffer
;
4986 void *itdata
= NULL
;
4988 if (XBUFFER (w
->buffer
) != current_buffer
)
4990 old_buffer
= current_buffer
;
4991 set_buffer_internal (XBUFFER (w
->buffer
));
4996 /* In case W->start is out of the accessible range, do something
4997 reasonable. This happens in Info mode when Info-scroll-down
4998 calls (recenter -1) while W->start is 1. */
4999 if (XMARKER (w
->start
)->charpos
< BEGV
)
5000 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
5001 else if (XMARKER (w
->start
)->charpos
> ZV
)
5002 SET_TEXT_POS (start
, ZV
, ZV_BYTE
);
5004 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
5006 itdata
= bidi_shelve_cache ();
5007 start_display (&it
, w
, start
);
5008 move_it_vertically (&it
, height
);
5009 bottom_y
= line_bottom_y (&it
);
5010 bidi_unshelve_cache (itdata
, 0);
5012 /* rms: On a non-window display,
5013 the value of it.vpos at the bottom of the screen
5014 seems to be 1 larger than window_box_height (w).
5015 This kludge fixes a bug whereby (move-to-window-line -1)
5016 when ZV is on the last screen line
5017 moves to the previous screen line instead of the last one. */
5018 if (! FRAME_WINDOW_P (XFRAME (w
->frame
)))
5021 /* Add in empty lines at the bottom of the window. */
5022 if (bottom_y
< height
)
5024 int uy
= FRAME_LINE_HEIGHT (it
.f
);
5025 it
.vpos
+= (height
- bottom_y
+ uy
- 1) / uy
;
5029 set_buffer_internal (old_buffer
);
5035 DEFUN ("recenter", Frecenter
, Srecenter
, 0, 1, "P",
5036 doc
: /* Center point in selected window and maybe redisplay frame.
5037 With prefix argument ARG, recenter putting point on screen line ARG
5038 relative to the selected window. If ARG is negative, it counts up from the
5039 bottom of the window. (ARG should be less than the height of the window.)
5041 If ARG is omitted or nil, then recenter with point on the middle line of
5042 the selected window; if the variable `recenter-redisplay' is non-nil,
5043 also erase the entire frame and redraw it (when `auto-resize-tool-bars'
5044 is set to `grow-only', this resets the tool-bar's height to the minimum
5045 height needed); if `recenter-redisplay' has the special value `tty',
5046 then only tty frame are redrawn.
5048 Just C-u as prefix means put point in the center of the window
5049 and redisplay normally--don't erase and redraw the frame. */)
5050 (register Lisp_Object arg
)
5052 struct window
*w
= XWINDOW (selected_window
);
5053 struct buffer
*buf
= XBUFFER (w
->buffer
);
5054 struct buffer
*obuf
= current_buffer
;
5056 ptrdiff_t charpos
, bytepos
;
5057 EMACS_INT iarg
IF_LINT (= 0);
5058 int this_scroll_margin
;
5060 /* If redisplay is suppressed due to an error, try again. */
5061 obuf
->display_error_modiff
= 0;
5065 if (!NILP (Vrecenter_redisplay
)
5066 && (!EQ (Vrecenter_redisplay
, Qtty
)
5067 || !NILP (Ftty_type (selected_frame
))))
5071 /* Invalidate pixel data calculated for all compositions. */
5072 for (i
= 0; i
< n_compositions
; i
++)
5073 composition_table
[i
]->font
= NULL
;
5075 WINDOW_XFRAME (w
)->minimize_tool_bar_window_p
= 1;
5077 Fredraw_frame (WINDOW_FRAME (w
));
5078 SET_FRAME_GARBAGED (WINDOW_XFRAME (w
));
5083 else if (CONSP (arg
)) /* Just C-u. */
5087 arg
= Fprefix_numeric_value (arg
);
5092 set_buffer_internal (buf
);
5094 /* Do this after making BUF current
5095 in case scroll_margin is buffer-local. */
5096 this_scroll_margin
=
5097 max (0, min (scroll_margin
, XFASTINT (w
->total_lines
) / 4));
5099 /* Handle centering on a graphical frame specially. Such frames can
5100 have variable-height lines and centering point on the basis of
5101 line counts would lead to strange effects. */
5102 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
5108 void *itdata
= bidi_shelve_cache ();
5110 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
5111 start_display (&it
, w
, pt
);
5112 move_it_vertically_backward (&it
, window_box_height (w
) / 2);
5113 charpos
= IT_CHARPOS (it
);
5114 bytepos
= IT_BYTEPOS (it
);
5115 bidi_unshelve_cache (itdata
, 0);
5121 int nlines
= min (INT_MAX
, -iarg
);
5122 int extra_line_spacing
;
5123 int h
= window_box_height (w
);
5124 void *itdata
= bidi_shelve_cache ();
5126 iarg
= - max (-iarg
, this_scroll_margin
);
5128 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
5129 start_display (&it
, w
, pt
);
5131 /* Be sure we have the exact height of the full line containing PT. */
5132 move_it_by_lines (&it
, 0);
5134 /* The amount of pixels we have to move back is the window
5135 height minus what's displayed in the line containing PT,
5136 and the lines below. */
5139 move_it_by_lines (&it
, nlines
);
5141 if (it
.vpos
== nlines
)
5145 /* Last line has no newline */
5146 h
-= line_bottom_y (&it
);
5150 /* Don't reserve space for extra line spacing of last line. */
5151 extra_line_spacing
= it
.max_extra_line_spacing
;
5153 /* If we can't move down NLINES lines because we hit
5154 the end of the buffer, count in some empty lines. */
5155 if (it
.vpos
< nlines
)
5158 extra_line_spacing
= it
.extra_line_spacing
;
5159 h
-= nlines
* (FRAME_LINE_HEIGHT (it
.f
) + extra_line_spacing
);
5163 bidi_unshelve_cache (itdata
, 0);
5167 /* Now find the new top line (starting position) of the window. */
5168 start_display (&it
, w
, pt
);
5170 move_it_vertically_backward (&it
, h
);
5172 /* If extra line spacing is present, we may move too far
5173 back. This causes the last line to be only partially
5174 visible (which triggers redisplay to recenter that line
5175 in the middle), so move forward.
5176 But ignore extra line spacing on last line, as it is not
5177 considered to be part of the visible height of the line.
5179 h
+= extra_line_spacing
;
5180 while (-it
.current_y
> h
)
5181 move_it_by_lines (&it
, 1);
5183 charpos
= IT_CHARPOS (it
);
5184 bytepos
= IT_BYTEPOS (it
);
5186 bidi_unshelve_cache (itdata
, 0);
5190 struct position pos
;
5192 iarg
= max (iarg
, this_scroll_margin
);
5194 pos
= *vmotion (PT
, -iarg
, w
);
5195 charpos
= pos
.bufpos
;
5196 bytepos
= pos
.bytepos
;
5201 struct position pos
;
5202 int ht
= window_internal_height (w
);
5209 /* Don't let it get into the margin at either top or bottom. */
5210 iarg
= max (iarg
, this_scroll_margin
);
5211 iarg
= min (iarg
, ht
- this_scroll_margin
- 1);
5213 pos
= *vmotion (PT
, - iarg
, w
);
5214 charpos
= pos
.bufpos
;
5215 bytepos
= pos
.bytepos
;
5218 /* Set the new window start. */
5219 set_marker_both (w
->start
, w
->buffer
, charpos
, bytepos
);
5220 w
->window_end_valid
= Qnil
;
5222 w
->optional_new_start
= Qt
;
5224 if (bytepos
== BEGV_BYTE
|| FETCH_BYTE (bytepos
- 1) == '\n')
5225 w
->start_at_line_beg
= Qt
;
5227 w
->start_at_line_beg
= Qnil
;
5229 set_buffer_internal (obuf
);
5233 DEFUN ("window-text-height", Fwindow_text_height
, Swindow_text_height
,
5235 doc
: /* Return the height in lines of the text display area of WINDOW.
5236 WINDOW defaults to the selected window.
5238 The return value does not include the mode line, any header line, nor
5239 any partial-height lines in the text display area. */)
5240 (Lisp_Object window
)
5242 struct window
*w
= decode_window (window
);
5243 int pixel_height
= window_box_height (w
);
5244 int line_height
= pixel_height
/ FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
5245 return make_number (line_height
);
5250 DEFUN ("move-to-window-line", Fmove_to_window_line
, Smove_to_window_line
,
5252 doc
: /* Position point relative to window.
5253 With no argument, position point at center of window.
5254 An argument specifies vertical position within the window;
5255 zero means top of window, negative means relative to bottom of window. */)
5258 struct window
*w
= XWINDOW (selected_window
);
5262 int this_scroll_margin
;
5265 if (!(BUFFERP (w
->buffer
)
5266 && XBUFFER (w
->buffer
) == current_buffer
))
5267 /* This test is needed to make sure PT/PT_BYTE make sense in w->buffer
5268 when passed below to set_marker_both. */
5269 error ("move-to-window-line called from unrelated buffer");
5271 window
= selected_window
;
5272 start
= marker_position (w
->start
);
5273 if (start
< BEGV
|| start
> ZV
)
5275 int height
= window_internal_height (w
);
5276 Fvertical_motion (make_number (- (height
/ 2)), window
);
5277 set_marker_both (w
->start
, w
->buffer
, PT
, PT_BYTE
);
5278 w
->start_at_line_beg
= Fbolp ();
5279 w
->force_start
= Qt
;
5282 Fgoto_char (w
->start
);
5284 lines
= displayed_window_lines (w
);
5287 this_scroll_margin
= max (0, min (scroll_margin
, lines
/ 4));
5291 XSETFASTINT (arg
, lines
/ 2);
5294 EMACS_INT iarg
= XINT (Fprefix_numeric_value (arg
));
5297 iarg
= iarg
+ lines
;
5299 #if 0 /* This code would prevent move-to-window-line from moving point
5300 to a place inside the scroll margins (which would cause the
5301 next redisplay to scroll). I wrote this code, but then concluded
5302 it is probably better not to install it. However, it is here
5303 inside #if 0 so as not to lose it. -- rms. */
5305 /* Don't let it get into the margin at either top or bottom. */
5306 iarg
= max (iarg
, this_scroll_margin
);
5307 iarg
= min (iarg
, lines
- this_scroll_margin
- 1);
5310 arg
= make_number (iarg
);
5313 /* Skip past a partially visible first line. */
5315 XSETINT (arg
, XINT (arg
) + 1);
5317 return Fvertical_motion (arg
, window
);
5322 /***********************************************************************
5323 Window Configuration
5324 ***********************************************************************/
5326 struct save_window_data
5328 struct vectorlike_header header
;
5329 Lisp_Object selected_frame
;
5330 Lisp_Object current_window
;
5331 Lisp_Object current_buffer
;
5332 Lisp_Object minibuf_scroll_window
;
5333 Lisp_Object minibuf_selected_window
;
5334 Lisp_Object root_window
;
5335 Lisp_Object focus_frame
;
5336 /* A vector, each of whose elements is a struct saved_window
5338 Lisp_Object saved_windows
;
5340 /* All fields above are traced by the GC.
5341 From `fame-cols' down, the fields are ignored by the GC. */
5343 int frame_cols
, frame_lines
, frame_menu_bar_lines
;
5344 int frame_tool_bar_lines
;
5347 /* This is saved as a Lisp_Vector */
5350 struct vectorlike_header header
;
5352 Lisp_Object window
, buffer
, start
, pointm
, mark
;
5353 Lisp_Object left_col
, top_line
, total_cols
, total_lines
;
5354 Lisp_Object normal_cols
, normal_lines
;
5355 Lisp_Object hscroll
, min_hscroll
;
5356 Lisp_Object parent
, prev
;
5357 Lisp_Object start_at_line_beg
;
5358 Lisp_Object display_table
;
5359 Lisp_Object left_margin_cols
, right_margin_cols
;
5360 Lisp_Object left_fringe_width
, right_fringe_width
, fringes_outside_margins
;
5361 Lisp_Object scroll_bar_width
, vertical_scroll_bar_type
, dedicated
;
5362 Lisp_Object splits
, nest
, window_parameters
;
5365 #define SAVED_WINDOW_N(swv,n) \
5366 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5368 DEFUN ("window-configuration-p", Fwindow_configuration_p
, Swindow_configuration_p
, 1, 1, 0,
5369 doc
: /* Return t if OBJECT is a window-configuration object. */)
5370 (Lisp_Object object
)
5372 return WINDOW_CONFIGURATIONP (object
) ? Qt
: Qnil
;
5375 DEFUN ("window-configuration-frame", Fwindow_configuration_frame
, Swindow_configuration_frame
, 1, 1, 0,
5376 doc
: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5377 (Lisp_Object config
)
5379 register struct save_window_data
*data
;
5380 struct Lisp_Vector
*saved_windows
;
5382 CHECK_WINDOW_CONFIGURATION (config
);
5384 data
= (struct save_window_data
*) XVECTOR (config
);
5385 saved_windows
= XVECTOR (data
->saved_windows
);
5386 return XWINDOW (SAVED_WINDOW_N (saved_windows
, 0)->window
)->frame
;
5389 DEFUN ("set-window-configuration", Fset_window_configuration
,
5390 Sset_window_configuration
, 1, 1, 0,
5391 doc
: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5392 CONFIGURATION must be a value previously returned
5393 by `current-window-configuration' (which see).
5394 If CONFIGURATION was made from a frame that is now deleted,
5395 only frame-independent values can be restored. In this case,
5396 the return value is nil. Otherwise the value is t. */)
5397 (Lisp_Object configuration
)
5399 register struct save_window_data
*data
;
5400 struct Lisp_Vector
*saved_windows
;
5401 Lisp_Object new_current_buffer
;
5403 Lisp_Object auto_buffer_name
;
5405 ptrdiff_t old_point
= -1;
5407 CHECK_WINDOW_CONFIGURATION (configuration
);
5409 data
= (struct save_window_data
*) XVECTOR (configuration
);
5410 saved_windows
= XVECTOR (data
->saved_windows
);
5412 new_current_buffer
= data
->current_buffer
;
5413 if (NILP (BVAR (XBUFFER (new_current_buffer
), name
)))
5414 new_current_buffer
= Qnil
;
5417 if (XBUFFER (new_current_buffer
) == current_buffer
)
5418 /* The code further down "preserves point" by saving here PT in
5419 old_point and then setting it later back into PT. When the
5420 current-selected-window and the final-selected-window both show
5421 the current buffer, this suffers from the problem that the
5422 current PT is the window-point of the current-selected-window,
5423 while the final PT is the point of the final-selected-window, so
5424 this copy from one PT to the other would end up moving the
5425 window-point of the final-selected-window to the window-point of
5426 the current-selected-window. So we have to be careful which
5427 point of the current-buffer we copy into old_point. */
5428 if (EQ (XWINDOW (data
->current_window
)->buffer
, new_current_buffer
)
5429 && WINDOWP (selected_window
)
5430 && EQ (XWINDOW (selected_window
)->buffer
, new_current_buffer
)
5431 && !EQ (selected_window
, data
->current_window
))
5432 old_point
= XMARKER (XWINDOW (data
->current_window
)->pointm
)->charpos
;
5436 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
5437 point in new_current_buffer as of the last time this buffer was
5438 used. This can be non-deterministic since it can be changed by
5439 things like jit-lock by mere temporary selection of some random
5440 window that happens to show this buffer.
5441 So if possible we want this arbitrary choice of "which point" to
5442 be the one from the to-be-selected-window so as to prevent this
5443 window's cursor from being copied from another window. */
5444 if (EQ (XWINDOW (data
->current_window
)->buffer
, new_current_buffer
)
5445 /* If current_window = selected_window, its point is in BUF_PT. */
5446 && !EQ (selected_window
, data
->current_window
))
5447 old_point
= XMARKER (XWINDOW (data
->current_window
)->pointm
)->charpos
;
5449 old_point
= BUF_PT (XBUFFER (new_current_buffer
));
5452 frame
= XWINDOW (SAVED_WINDOW_N (saved_windows
, 0)->window
)->frame
;
5455 /* If f is a dead frame, don't bother rebuilding its window tree.
5456 However, there is other stuff we should still try to do below. */
5457 if (FRAME_LIVE_P (f
))
5460 Lisp_Object dead_windows
= Qnil
;
5461 register struct window
*w
;
5462 register struct saved_window
*p
;
5463 struct window
*root_window
;
5464 struct window
**leaf_windows
;
5469 /* If the frame has been resized since this window configuration was
5470 made, we change the frame to the size specified in the
5471 configuration, restore the configuration, and then resize it
5472 back. We keep track of the prevailing height in these variables. */
5473 int previous_frame_lines
= FRAME_LINES (f
);
5474 int previous_frame_cols
= FRAME_COLS (f
);
5475 int previous_frame_menu_bar_lines
= FRAME_MENU_BAR_LINES (f
);
5476 int previous_frame_tool_bar_lines
= FRAME_TOOL_BAR_LINES (f
);
5478 /* The mouse highlighting code could get screwed up
5479 if it runs during this. */
5482 if (data
->frame_lines
!= previous_frame_lines
5483 || data
->frame_cols
!= previous_frame_cols
)
5484 change_frame_size (f
, data
->frame_lines
,
5485 data
->frame_cols
, 0, 0, 0);
5486 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5487 if (data
->frame_menu_bar_lines
5488 != previous_frame_menu_bar_lines
)
5489 x_set_menu_bar_lines (f
, make_number (data
->frame_menu_bar_lines
),
5491 #ifdef HAVE_WINDOW_SYSTEM
5492 if (data
->frame_tool_bar_lines
5493 != previous_frame_tool_bar_lines
)
5494 x_set_tool_bar_lines (f
, make_number (data
->frame_tool_bar_lines
),
5499 /* "Swap out" point from the selected window's buffer
5500 into the window itself. (Normally the pointm of the selected
5501 window holds garbage.) We do this now, before
5502 restoring the window contents, and prevent it from
5503 being done later on when we select a new window. */
5504 if (! NILP (XWINDOW (selected_window
)->buffer
))
5506 w
= XWINDOW (selected_window
);
5507 set_marker_both (w
->pointm
,
5509 BUF_PT (XBUFFER (w
->buffer
)),
5510 BUF_PT_BYTE (XBUFFER (w
->buffer
)));
5513 windows_or_buffers_changed
++;
5514 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
5516 /* Problem: Freeing all matrices and later allocating them again
5517 is a serious redisplay flickering problem. What we would
5518 really like to do is to free only those matrices not reused
5520 root_window
= XWINDOW (FRAME_ROOT_WINDOW (f
));
5522 = (struct window
**) alloca (count_windows (root_window
)
5523 * sizeof (struct window
*));
5524 n_leaf_windows
= get_leaf_windows (root_window
, leaf_windows
, 0);
5527 Mark all windows now on frame as "deleted".
5528 Restoring the new configuration "undeletes" any that are in it.
5530 Save their current buffers in their height fields, since we may
5531 need it later, if a buffer saved in the configuration is now
5533 delete_all_subwindows (FRAME_ROOT_WINDOW (f
));
5535 for (k
= 0; k
< saved_windows
->header
.size
; k
++)
5537 p
= SAVED_WINDOW_N (saved_windows
, k
);
5539 w
= XWINDOW (window
);
5542 if (!NILP (p
->parent
))
5543 w
->parent
= SAVED_WINDOW_N (saved_windows
,
5544 XFASTINT (p
->parent
))->window
;
5548 if (!NILP (p
->prev
))
5550 w
->prev
= SAVED_WINDOW_N (saved_windows
,
5551 XFASTINT (p
->prev
))->window
;
5552 XWINDOW (w
->prev
)->next
= p
->window
;
5557 if (!NILP (w
->parent
))
5559 if (EQ (p
->total_cols
, XWINDOW (w
->parent
)->total_cols
))
5561 XWINDOW (w
->parent
)->vchild
= p
->window
;
5562 XWINDOW (w
->parent
)->hchild
= Qnil
;
5566 XWINDOW (w
->parent
)->hchild
= p
->window
;
5567 XWINDOW (w
->parent
)->vchild
= Qnil
;
5572 /* If we squirreled away the buffer in the window's height,
5574 if (BUFFERP (w
->total_lines
))
5575 w
->buffer
= w
->total_lines
;
5576 w
->left_col
= p
->left_col
;
5577 w
->top_line
= p
->top_line
;
5578 w
->total_cols
= p
->total_cols
;
5579 w
->total_lines
= p
->total_lines
;
5580 w
->normal_cols
= p
->normal_cols
;
5581 w
->normal_lines
= p
->normal_lines
;
5582 w
->hscroll
= p
->hscroll
;
5583 w
->min_hscroll
= p
->min_hscroll
;
5584 w
->display_table
= p
->display_table
;
5585 w
->left_margin_cols
= p
->left_margin_cols
;
5586 w
->right_margin_cols
= p
->right_margin_cols
;
5587 w
->left_fringe_width
= p
->left_fringe_width
;
5588 w
->right_fringe_width
= p
->right_fringe_width
;
5589 w
->fringes_outside_margins
= p
->fringes_outside_margins
;
5590 w
->scroll_bar_width
= p
->scroll_bar_width
;
5591 w
->vertical_scroll_bar_type
= p
->vertical_scroll_bar_type
;
5592 w
->dedicated
= p
->dedicated
;
5593 w
->splits
= p
->splits
;
5595 w
->window_parameters
= p
->window_parameters
;
5596 XSETFASTINT (w
->last_modified
, 0);
5597 XSETFASTINT (w
->last_overlay_modified
, 0);
5599 /* Reinstall the saved buffer and pointers into it. */
5600 if (NILP (p
->buffer
))
5601 /* An internal window. */
5602 w
->buffer
= p
->buffer
;
5603 else if (!NILP (BVAR (XBUFFER (p
->buffer
), name
)))
5604 /* If saved buffer is alive, install it. */
5606 w
->buffer
= p
->buffer
;
5607 w
->start_at_line_beg
= p
->start_at_line_beg
;
5608 set_marker_restricted (w
->start
, p
->start
, w
->buffer
);
5609 set_marker_restricted (w
->pointm
, p
->pointm
, w
->buffer
);
5610 Fset_marker (BVAR (XBUFFER (w
->buffer
), mark
),
5611 p
->mark
, w
->buffer
);
5613 /* As documented in Fcurrent_window_configuration, don't
5614 restore the location of point in the buffer which was
5615 current when the window configuration was recorded. */
5616 if (!EQ (p
->buffer
, new_current_buffer
)
5617 && XBUFFER (p
->buffer
) == current_buffer
)
5618 Fgoto_char (w
->pointm
);
5620 else if (!NILP (w
->buffer
) && !NILP (BVAR (XBUFFER (w
->buffer
), name
)))
5621 /* Keep window's old buffer; make sure the markers are
5624 /* Set window markers at start of visible range. */
5625 if (XMARKER (w
->start
)->buffer
== 0)
5626 set_marker_restricted (w
->start
, make_number (0),
5628 if (XMARKER (w
->pointm
)->buffer
== 0)
5629 set_marker_restricted_both (w
->pointm
, w
->buffer
,
5630 BUF_PT (XBUFFER (w
->buffer
)),
5631 BUF_PT_BYTE (XBUFFER (w
->buffer
)));
5632 w
->start_at_line_beg
= Qt
;
5634 else if (STRINGP (auto_buffer_name
=
5635 Fwindow_parameter (window
, Qauto_buffer_name
))
5636 && SCHARS (auto_buffer_name
) != 0
5637 && !NILP (w
->buffer
= Fget_buffer_create (auto_buffer_name
)))
5639 set_marker_restricted (w
->start
, make_number (0), w
->buffer
);
5640 set_marker_restricted (w
->pointm
, make_number (0), w
->buffer
);
5641 w
->start_at_line_beg
= Qt
;
5644 /* Window has no live buffer, get one. */
5646 /* Get the buffer via other_buffer_safely in order to
5647 avoid showing an unimportant buffer and, if necessary, to
5648 recreate *scratch* in the course (part of Juanma's bs-show
5649 scenario from March 2011). */
5650 w
->buffer
= other_buffer_safely (Fcurrent_buffer ());
5651 /* This will set the markers to beginning of visible
5653 set_marker_restricted (w
->start
, make_number (0), w
->buffer
);
5654 set_marker_restricted (w
->pointm
, make_number (0), w
->buffer
);
5655 w
->start_at_line_beg
= Qt
;
5656 if (!NILP (w
->dedicated
))
5657 /* Record this window as dead. */
5658 dead_windows
= Fcons (window
, dead_windows
);
5659 /* Make sure window is no more dedicated. */
5660 w
->dedicated
= Qnil
;
5664 FRAME_ROOT_WINDOW (f
) = data
->root_window
;
5665 /* Arrange *not* to restore point in the buffer that was
5666 current when the window configuration was saved. */
5667 if (EQ (XWINDOW (data
->current_window
)->buffer
, new_current_buffer
))
5668 set_marker_restricted (XWINDOW (data
->current_window
)->pointm
,
5669 make_number (old_point
),
5670 XWINDOW (data
->current_window
)->buffer
);
5672 /* In the following call to `select-window', prevent "swapping out
5673 point" in the old selected window using the buffer that has
5674 been restored into it. We already swapped out that point from
5675 that window's old buffer. */
5676 select_window (data
->current_window
, Qnil
, 1);
5677 BVAR (XBUFFER (XWINDOW (selected_window
)->buffer
), last_selected_window
)
5680 if (NILP (data
->focus_frame
)
5681 || (FRAMEP (data
->focus_frame
)
5682 && FRAME_LIVE_P (XFRAME (data
->focus_frame
))))
5683 Fredirect_frame_focus (frame
, data
->focus_frame
);
5685 /* Set the screen height to the value it had before this function. */
5686 if (previous_frame_lines
!= FRAME_LINES (f
)
5687 || previous_frame_cols
!= FRAME_COLS (f
))
5688 change_frame_size (f
, previous_frame_lines
, previous_frame_cols
,
5690 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5691 if (previous_frame_menu_bar_lines
!= FRAME_MENU_BAR_LINES (f
))
5692 x_set_menu_bar_lines (f
, make_number (previous_frame_menu_bar_lines
),
5694 #ifdef HAVE_WINDOW_SYSTEM
5695 if (previous_frame_tool_bar_lines
!= FRAME_TOOL_BAR_LINES (f
))
5696 x_set_tool_bar_lines (f
, make_number (previous_frame_tool_bar_lines
),
5701 /* Now, free glyph matrices in windows that were not reused. */
5702 for (i
= n
= 0; i
< n_leaf_windows
; ++i
)
5704 if (NILP (leaf_windows
[i
]->buffer
))
5706 /* Assert it's not reused as a combination. */
5707 xassert (NILP (leaf_windows
[i
]->hchild
)
5708 && NILP (leaf_windows
[i
]->vchild
));
5709 free_window_matrices (leaf_windows
[i
]);
5711 else if (EQ (leaf_windows
[i
]->buffer
, new_current_buffer
))
5718 /* Scan dead buffer windows. */
5719 for (; CONSP (dead_windows
); dead_windows
= XCDR (dead_windows
))
5721 window
= XCAR (dead_windows
);
5722 if (WINDOW_LIVE_P (window
) && !EQ (window
, FRAME_ROOT_WINDOW (f
)))
5723 delete_deletable_window (window
);
5726 /* Fselect_window will have made f the selected frame, so we
5727 reselect the proper frame here. Fhandle_switch_frame will change the
5728 selected window too, but that doesn't make the call to
5729 Fselect_window above totally superfluous; it still sets f's
5731 if (FRAME_LIVE_P (XFRAME (data
->selected_frame
)))
5732 do_switch_frame (data
->selected_frame
, 0, 0, Qnil
);
5734 run_window_configuration_change_hook (f
);
5737 if (!NILP (new_current_buffer
))
5738 Fset_buffer (new_current_buffer
);
5740 Vminibuf_scroll_window
= data
->minibuf_scroll_window
;
5741 minibuf_selected_window
= data
->minibuf_selected_window
;
5743 return (FRAME_LIVE_P (f
) ? Qt
: Qnil
);
5747 /* Delete all subwindows reachable via the next, vchild, and hchild
5750 delete_all_subwindows (Lisp_Object window
)
5752 register struct window
*w
;
5754 w
= XWINDOW (window
);
5756 if (!NILP (w
->next
))
5757 /* Delete WINDOW's siblings (we traverse postorderly). */
5758 delete_all_subwindows (w
->next
);
5760 w
->total_lines
= w
->buffer
; /* See Fset_window_configuration for excuse. */
5762 if (!NILP (w
->vchild
))
5764 delete_all_subwindows (w
->vchild
);
5767 else if (!NILP (w
->hchild
))
5769 delete_all_subwindows (w
->hchild
);
5772 else if (!NILP (w
->buffer
))
5775 unchain_marker (XMARKER (w
->pointm
));
5776 unchain_marker (XMARKER (w
->start
));
5780 Vwindow_list
= Qnil
;
5784 count_windows (register struct window
*window
)
5786 register int count
= 1;
5787 if (!NILP (window
->next
))
5788 count
+= count_windows (XWINDOW (window
->next
));
5789 if (!NILP (window
->vchild
))
5790 count
+= count_windows (XWINDOW (window
->vchild
));
5791 if (!NILP (window
->hchild
))
5792 count
+= count_windows (XWINDOW (window
->hchild
));
5797 /* Fill vector FLAT with leaf windows under W, starting at index I.
5798 Value is last index + 1. */
5800 get_leaf_windows (struct window
*w
, struct window
**flat
, int i
)
5804 if (!NILP (w
->hchild
))
5805 i
= get_leaf_windows (XWINDOW (w
->hchild
), flat
, i
);
5806 else if (!NILP (w
->vchild
))
5807 i
= get_leaf_windows (XWINDOW (w
->vchild
), flat
, i
);
5811 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
5818 /* Return a pointer to the glyph W's physical cursor is on. Value is
5819 null if W's current matrix is invalid, so that no meaningfull glyph
5822 get_phys_cursor_glyph (struct window
*w
)
5824 struct glyph_row
*row
;
5825 struct glyph
*glyph
;
5827 if (w
->phys_cursor
.vpos
>= 0
5828 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
5829 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
5831 && row
->used
[TEXT_AREA
] > w
->phys_cursor
.hpos
)
5832 glyph
= row
->glyphs
[TEXT_AREA
] + w
->phys_cursor
.hpos
;
5841 save_window_save (Lisp_Object window
, struct Lisp_Vector
*vector
, int i
)
5843 register struct saved_window
*p
;
5844 register struct window
*w
;
5845 register Lisp_Object tem
;
5847 for (;!NILP (window
); window
= w
->next
)
5849 p
= SAVED_WINDOW_N (vector
, i
);
5850 w
= XWINDOW (window
);
5852 XSETFASTINT (w
->temslot
, i
); i
++;
5854 p
->buffer
= w
->buffer
;
5855 p
->left_col
= w
->left_col
;
5856 p
->top_line
= w
->top_line
;
5857 p
->total_cols
= w
->total_cols
;
5858 p
->total_lines
= w
->total_lines
;
5859 p
->normal_cols
= w
->normal_cols
;
5860 p
->normal_lines
= w
->normal_lines
;
5861 p
->hscroll
= w
->hscroll
;
5862 p
->min_hscroll
= w
->min_hscroll
;
5863 p
->display_table
= w
->display_table
;
5864 p
->left_margin_cols
= w
->left_margin_cols
;
5865 p
->right_margin_cols
= w
->right_margin_cols
;
5866 p
->left_fringe_width
= w
->left_fringe_width
;
5867 p
->right_fringe_width
= w
->right_fringe_width
;
5868 p
->fringes_outside_margins
= w
->fringes_outside_margins
;
5869 p
->scroll_bar_width
= w
->scroll_bar_width
;
5870 p
->vertical_scroll_bar_type
= w
->vertical_scroll_bar_type
;
5871 p
->dedicated
= w
->dedicated
;
5872 p
->splits
= w
->splits
;
5874 p
->window_parameters
= w
->window_parameters
;
5875 if (!NILP (w
->buffer
))
5877 /* Save w's value of point in the window configuration.
5878 If w is the selected window, then get the value of point
5879 from the buffer; pointm is garbage in the selected window. */
5880 if (EQ (window
, selected_window
))
5882 p
->pointm
= Fmake_marker ();
5883 set_marker_both (p
->pointm
, w
->buffer
,
5884 BUF_PT (XBUFFER (w
->buffer
)),
5885 BUF_PT_BYTE (XBUFFER (w
->buffer
)));
5888 p
->pointm
= Fcopy_marker (w
->pointm
, Qnil
);
5890 p
->start
= Fcopy_marker (w
->start
, Qnil
);
5891 p
->start_at_line_beg
= w
->start_at_line_beg
;
5893 tem
= BVAR (XBUFFER (w
->buffer
), mark
);
5894 p
->mark
= Fcopy_marker (tem
, Qnil
);
5901 p
->start_at_line_beg
= Qnil
;
5904 if (NILP (w
->parent
))
5907 p
->parent
= XWINDOW (w
->parent
)->temslot
;
5912 p
->prev
= XWINDOW (w
->prev
)->temslot
;
5914 if (!NILP (w
->vchild
))
5915 i
= save_window_save (w
->vchild
, vector
, i
);
5916 if (!NILP (w
->hchild
))
5917 i
= save_window_save (w
->hchild
, vector
, i
);
5923 DEFUN ("current-window-configuration", Fcurrent_window_configuration
,
5924 Scurrent_window_configuration
, 0, 1, 0,
5925 doc
: /* Return an object representing the current window configuration of FRAME.
5926 If FRAME is nil or omitted, use the selected frame.
5927 This describes the number of windows, their sizes and current buffers,
5928 and for each displayed buffer, where display starts, and the positions of
5929 point and mark. An exception is made for point in the current buffer:
5930 its value is -not- saved.
5931 This also records the currently selected frame, and FRAME's focus
5932 redirection (see `redirect-frame-focus'). */)
5935 register Lisp_Object tem
;
5936 register int n_windows
;
5937 register struct save_window_data
*data
;
5942 frame
= selected_frame
;
5943 CHECK_LIVE_FRAME (frame
);
5946 n_windows
= count_windows (XWINDOW (FRAME_ROOT_WINDOW (f
)));
5947 data
= ALLOCATE_PSEUDOVECTOR (struct save_window_data
, frame_cols
,
5948 PVEC_WINDOW_CONFIGURATION
);
5950 data
->frame_cols
= FRAME_COLS (f
);
5951 data
->frame_lines
= FRAME_LINES (f
);
5952 data
->frame_menu_bar_lines
= FRAME_MENU_BAR_LINES (f
);
5953 data
->frame_tool_bar_lines
= FRAME_TOOL_BAR_LINES (f
);
5954 data
->selected_frame
= selected_frame
;
5955 data
->current_window
= FRAME_SELECTED_WINDOW (f
);
5956 XSETBUFFER (data
->current_buffer
, current_buffer
);
5957 data
->minibuf_scroll_window
= minibuf_level
> 0 ? Vminibuf_scroll_window
: Qnil
;
5958 data
->minibuf_selected_window
= minibuf_level
> 0 ? minibuf_selected_window
: Qnil
;
5959 data
->root_window
= FRAME_ROOT_WINDOW (f
);
5960 data
->focus_frame
= FRAME_FOCUS_FRAME (f
);
5961 tem
= Fmake_vector (make_number (n_windows
), Qnil
);
5962 data
->saved_windows
= tem
;
5963 for (i
= 0; i
< n_windows
; i
++)
5964 XVECTOR (tem
)->contents
[i
]
5965 = Fmake_vector (make_number (VECSIZE (struct saved_window
)), Qnil
);
5966 save_window_save (FRAME_ROOT_WINDOW (f
), XVECTOR (tem
), 0);
5967 XSETWINDOW_CONFIGURATION (tem
, data
);
5971 /***********************************************************************
5973 ***********************************************************************/
5975 DEFUN ("set-window-margins", Fset_window_margins
, Sset_window_margins
,
5977 doc
: /* Set width of marginal areas of window WINDOW.
5978 If WINDOW is nil, set margins of the currently selected window.
5979 Second arg LEFT-WIDTH specifies the number of character cells to
5980 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
5981 does the same for the right marginal area. A nil width parameter
5982 means no margin. */)
5983 (Lisp_Object window
, Lisp_Object left_width
, Lisp_Object right_width
)
5985 struct window
*w
= decode_window (window
);
5987 /* Translate negative or zero widths to nil.
5988 Margins that are too wide have to be checked elsewhere. */
5990 if (!NILP (left_width
))
5992 CHECK_NUMBER (left_width
);
5993 if (XINT (left_width
) <= 0)
5997 if (!NILP (right_width
))
5999 CHECK_NUMBER (right_width
);
6000 if (XINT (right_width
) <= 0)
6004 if (!EQ (w
->left_margin_cols
, left_width
)
6005 || !EQ (w
->right_margin_cols
, right_width
))
6007 w
->left_margin_cols
= left_width
;
6008 w
->right_margin_cols
= right_width
;
6010 adjust_window_margins (w
);
6012 ++windows_or_buffers_changed
;
6013 adjust_glyphs (XFRAME (WINDOW_FRAME (w
)));
6020 DEFUN ("window-margins", Fwindow_margins
, Swindow_margins
,
6022 doc
: /* Get width of marginal areas of window WINDOW.
6023 If WINDOW is omitted or nil, use the currently selected window.
6024 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6025 If a marginal area does not exist, its width will be returned
6027 (Lisp_Object window
)
6029 struct window
*w
= decode_window (window
);
6030 return Fcons (w
->left_margin_cols
, w
->right_margin_cols
);
6035 /***********************************************************************
6037 ***********************************************************************/
6039 DEFUN ("set-window-fringes", Fset_window_fringes
, Sset_window_fringes
,
6041 doc
: /* Set the fringe widths of window WINDOW.
6042 If WINDOW is nil, set the fringe widths of the currently selected
6044 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6045 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6046 fringe width. If a fringe width arg is nil, that means to use the
6047 frame's default fringe width. Default fringe widths can be set with
6048 the command `set-fringe-style'.
6049 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6050 outside of the display margins. By default, fringes are drawn between
6051 display marginal areas and the text area. */)
6052 (Lisp_Object window
, Lisp_Object left_width
, Lisp_Object right_width
, Lisp_Object outside_margins
)
6054 struct window
*w
= decode_window (window
);
6056 if (!NILP (left_width
))
6057 CHECK_NATNUM (left_width
);
6058 if (!NILP (right_width
))
6059 CHECK_NATNUM (right_width
);
6061 /* Do nothing on a tty. */
6062 if (FRAME_WINDOW_P (WINDOW_XFRAME (w
))
6063 && (!EQ (w
->left_fringe_width
, left_width
)
6064 || !EQ (w
->right_fringe_width
, right_width
)
6065 || !EQ (w
->fringes_outside_margins
, outside_margins
)))
6067 w
->left_fringe_width
= left_width
;
6068 w
->right_fringe_width
= right_width
;
6069 w
->fringes_outside_margins
= outside_margins
;
6071 adjust_window_margins (w
);
6073 clear_glyph_matrix (w
->current_matrix
);
6074 w
->window_end_valid
= Qnil
;
6076 ++windows_or_buffers_changed
;
6077 adjust_glyphs (XFRAME (WINDOW_FRAME (w
)));
6084 DEFUN ("window-fringes", Fwindow_fringes
, Swindow_fringes
,
6086 doc
: /* Get width of fringes of window WINDOW.
6087 If WINDOW is omitted or nil, use the currently selected window.
6088 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6089 (Lisp_Object window
)
6091 struct window
*w
= decode_window (window
);
6093 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w
)),
6094 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w
)),
6095 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
6096 ? Qt
: Qnil
), Qnil
)));
6101 /***********************************************************************
6103 ***********************************************************************/
6105 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars
,
6106 Sset_window_scroll_bars
, 2, 4, 0,
6107 doc
: /* Set width and type of scroll bars of window WINDOW.
6108 If window is nil, set scroll bars of the currently selected window.
6109 Second parameter WIDTH specifies the pixel width for the scroll bar;
6110 this is automatically adjusted to a multiple of the frame column width.
6111 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6112 bar: left, right, or nil.
6113 If WIDTH is nil, use the frame's scroll-bar width.
6114 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6115 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6116 (Lisp_Object window
, Lisp_Object width
, Lisp_Object vertical_type
, Lisp_Object horizontal_type
)
6118 struct window
*w
= decode_window (window
);
6122 CHECK_RANGED_INTEGER (0, width
, INT_MAX
);
6124 if (XINT (width
) == 0)
6125 vertical_type
= Qnil
;
6128 if (!(NILP (vertical_type
)
6129 || EQ (vertical_type
, Qleft
)
6130 || EQ (vertical_type
, Qright
)
6131 || EQ (vertical_type
, Qt
)))
6132 error ("Invalid type of vertical scroll bar");
6134 if (!EQ (w
->scroll_bar_width
, width
)
6135 || !EQ (w
->vertical_scroll_bar_type
, vertical_type
))
6137 w
->scroll_bar_width
= width
;
6138 w
->vertical_scroll_bar_type
= vertical_type
;
6140 adjust_window_margins (w
);
6142 clear_glyph_matrix (w
->current_matrix
);
6143 w
->window_end_valid
= Qnil
;
6145 ++windows_or_buffers_changed
;
6146 adjust_glyphs (XFRAME (WINDOW_FRAME (w
)));
6153 DEFUN ("window-scroll-bars", Fwindow_scroll_bars
, Swindow_scroll_bars
,
6155 doc
: /* Get width and type of scroll bars of window WINDOW.
6156 If WINDOW is omitted or nil, use the currently selected window.
6157 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6158 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6160 (Lisp_Object window
)
6162 struct window
*w
= decode_window (window
);
6163 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w
)
6164 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w
)
6165 : WINDOW_SCROLL_BAR_AREA_WIDTH (w
))),
6166 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w
)),
6167 Fcons (w
->vertical_scroll_bar_type
,
6168 Fcons (Qnil
, Qnil
))));
6173 /***********************************************************************
6175 ***********************************************************************/
6177 DEFUN ("window-vscroll", Fwindow_vscroll
, Swindow_vscroll
, 0, 2, 0,
6178 doc
: /* Return the amount by which WINDOW is scrolled vertically.
6179 Use the selected window if WINDOW is nil or omitted.
6180 Normally, value is a multiple of the canonical character height of WINDOW;
6181 optional second arg PIXELS-P means value is measured in pixels. */)
6182 (Lisp_Object window
, Lisp_Object pixels_p
)
6189 window
= selected_window
;
6191 CHECK_WINDOW (window
);
6192 w
= XWINDOW (window
);
6193 f
= XFRAME (w
->frame
);
6195 if (FRAME_WINDOW_P (f
))
6196 result
= (NILP (pixels_p
)
6197 ? FRAME_CANON_Y_FROM_PIXEL_Y (f
, -w
->vscroll
)
6198 : make_number (-w
->vscroll
));
6200 result
= make_number (0);
6205 DEFUN ("set-window-vscroll", Fset_window_vscroll
, Sset_window_vscroll
,
6207 doc
: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
6208 WINDOW nil means use the selected window. Normally, VSCROLL is a
6209 non-negative multiple of the canonical character height of WINDOW;
6210 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
6211 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
6212 corresponds to an integral number of pixels. The return value is the
6213 result of this rounding.
6214 If PIXELS-P is non-nil, the return value is VSCROLL. */)
6215 (Lisp_Object window
, Lisp_Object vscroll
, Lisp_Object pixels_p
)
6221 window
= selected_window
;
6223 CHECK_WINDOW (window
);
6224 CHECK_NUMBER_OR_FLOAT (vscroll
);
6226 w
= XWINDOW (window
);
6227 f
= XFRAME (w
->frame
);
6229 if (FRAME_WINDOW_P (f
))
6231 int old_dy
= w
->vscroll
;
6233 w
->vscroll
= - (NILP (pixels_p
)
6234 ? FRAME_LINE_HEIGHT (f
) * XFLOATINT (vscroll
)
6235 : XFLOATINT (vscroll
));
6236 w
->vscroll
= min (w
->vscroll
, 0);
6238 if (w
->vscroll
!= old_dy
)
6240 /* Adjust glyph matrix of the frame if the virtual display
6241 area becomes larger than before. */
6242 if (w
->vscroll
< 0 && w
->vscroll
< old_dy
)
6245 /* Prevent redisplay shortcuts. */
6246 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
6250 return Fwindow_vscroll (window
, pixels_p
);
6254 /* Call FN for all leaf windows on frame F. FN is called with the
6255 first argument being a pointer to the leaf window, and with
6256 additional argument USER_DATA. Stops when FN returns 0. */
6259 foreach_window (struct frame
*f
, int (*fn
) (struct window
*, void *),
6262 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6263 if (WINDOWP (FRAME_ROOT_WINDOW (f
)))
6264 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f
)), fn
, user_data
);
6268 /* Helper function for foreach_window. Call FN for all leaf windows
6269 reachable from W. FN is called with the first argument being a
6270 pointer to the leaf window, and with additional argument USER_DATA.
6271 Stop when FN returns 0. Value is 0 if stopped by FN. */
6274 foreach_window_1 (struct window
*w
, int (*fn
) (struct window
*, void *), void *user_data
)
6278 for (cont
= 1; w
&& cont
;)
6280 if (!NILP (w
->hchild
))
6281 cont
= foreach_window_1 (XWINDOW (w
->hchild
), fn
, user_data
);
6282 else if (!NILP (w
->vchild
))
6283 cont
= foreach_window_1 (XWINDOW (w
->vchild
), fn
, user_data
);
6285 cont
= fn (w
, user_data
);
6287 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
6294 /* Freeze or unfreeze the window start of W unless it is a
6295 mini-window or the selected window. FREEZE_P non-null means freeze
6296 the window start. */
6299 freeze_window_start (struct window
*w
, void *freeze_p
)
6301 if (MINI_WINDOW_P (w
)
6302 || (WINDOWP (selected_window
) /* Can be nil in corner cases. */
6303 && (w
== XWINDOW (selected_window
)
6304 || (MINI_WINDOW_P (XWINDOW (selected_window
))
6305 && ! NILP (Vminibuf_scroll_window
)
6306 && w
== XWINDOW (Vminibuf_scroll_window
)))))
6309 w
->frozen_window_start_p
= freeze_p
!= NULL
;
6314 /* Freeze or unfreeze the window starts of all leaf windows on frame
6315 F, except the selected window and a mini-window. FREEZE_P non-zero
6316 means freeze the window start. */
6319 freeze_window_starts (struct frame
*f
, int freeze_p
)
6321 foreach_window (f
, freeze_window_start
, (void *) (freeze_p
? f
: 0));
6325 /***********************************************************************
6327 ***********************************************************************/
6329 /* Return 1 if window configurations CONFIGURATION1 and CONFIGURATION2
6330 describe the same state of affairs. This is used by Fequal.
6332 ignore_positions non-zero means ignore non-matching scroll positions
6335 This ignores a couple of things like the dedicatedness status of
6336 window, splits, nest and the like. This might have to be fixed. */
6339 compare_window_configurations (Lisp_Object configuration1
, Lisp_Object configuration2
, int ignore_positions
)
6341 register struct save_window_data
*d1
, *d2
;
6342 struct Lisp_Vector
*sws1
, *sws2
;
6345 CHECK_WINDOW_CONFIGURATION (configuration1
);
6346 CHECK_WINDOW_CONFIGURATION (configuration2
);
6348 d1
= (struct save_window_data
*) XVECTOR (configuration1
);
6349 d2
= (struct save_window_data
*) XVECTOR (configuration2
);
6350 sws1
= XVECTOR (d1
->saved_windows
);
6351 sws2
= XVECTOR (d2
->saved_windows
);
6353 /* Frame settings must match. */
6354 if (d1
->frame_cols
!= d2
->frame_cols
6355 || d1
->frame_lines
!= d2
->frame_lines
6356 || d1
->frame_menu_bar_lines
!= d2
->frame_menu_bar_lines
6357 || !EQ (d1
->selected_frame
, d2
->selected_frame
)
6358 || !EQ (d1
->current_buffer
, d2
->current_buffer
)
6359 || (!ignore_positions
6360 && (!EQ (d1
->minibuf_scroll_window
, d2
->minibuf_scroll_window
)
6361 || !EQ (d1
->minibuf_selected_window
, d2
->minibuf_selected_window
)))
6362 || !EQ (d1
->focus_frame
, d2
->focus_frame
)
6363 /* Verify that the two configurations have the same number of windows. */
6364 || sws1
->header
.size
!= sws2
->header
.size
)
6367 for (i
= 0; i
< sws1
->header
.size
; i
++)
6369 struct saved_window
*sw1
, *sw2
;
6371 sw1
= SAVED_WINDOW_N (sws1
, i
);
6372 sw2
= SAVED_WINDOW_N (sws2
, i
);
6375 /* The "current" windows in the two configurations must
6376 correspond to each other. */
6377 EQ (d1
->current_window
, sw1
->window
)
6378 != EQ (d2
->current_window
, sw2
->window
)
6379 /* Windows' buffers must match. */
6380 || !EQ (sw1
->buffer
, sw2
->buffer
)
6381 || !EQ (sw1
->left_col
, sw2
->left_col
)
6382 || !EQ (sw1
->top_line
, sw2
->top_line
)
6383 || !EQ (sw1
->total_cols
, sw2
->total_cols
)
6384 || !EQ (sw1
->total_lines
, sw2
->total_lines
)
6385 || !EQ (sw1
->display_table
, sw2
->display_table
)
6386 /* The next two disjuncts check the window structure for
6388 || !EQ (sw1
->parent
, sw2
->parent
)
6389 || !EQ (sw1
->prev
, sw2
->prev
)
6390 || (!ignore_positions
6391 && (!EQ (sw1
->hscroll
, sw2
->hscroll
)
6392 || !EQ (sw1
->min_hscroll
, sw2
->min_hscroll
)
6393 || !EQ (sw1
->start_at_line_beg
, sw2
->start_at_line_beg
)
6394 || NILP (Fequal (sw1
->start
, sw2
->start
))
6395 || NILP (Fequal (sw1
->pointm
, sw2
->pointm
))
6396 || NILP (Fequal (sw1
->mark
, sw2
->mark
))))
6397 || !EQ (sw1
->left_margin_cols
, sw2
->left_margin_cols
)
6398 || !EQ (sw1
->right_margin_cols
, sw2
->right_margin_cols
)
6399 || !EQ (sw1
->left_fringe_width
, sw2
->left_fringe_width
)
6400 || !EQ (sw1
->right_fringe_width
, sw2
->right_fringe_width
)
6401 || !EQ (sw1
->fringes_outside_margins
, sw2
->fringes_outside_margins
)
6402 || !EQ (sw1
->scroll_bar_width
, sw2
->scroll_bar_width
)
6403 || !EQ (sw1
->vertical_scroll_bar_type
, sw2
->vertical_scroll_bar_type
))
6410 DEFUN ("compare-window-configurations", Fcompare_window_configurations
,
6411 Scompare_window_configurations
, 2, 2, 0,
6412 doc
: /* Compare two window configurations as regards the structure of windows.
6413 This function ignores details such as the values of point and mark
6414 and scrolling positions. */)
6415 (Lisp_Object x
, Lisp_Object y
)
6417 if (compare_window_configurations (x
, y
, 1))
6423 init_window_once (void)
6425 struct frame
*f
= make_initial_frame ();
6426 XSETFRAME (selected_frame
, f
);
6427 Vterminal_frame
= selected_frame
;
6428 minibuf_window
= f
->minibuffer_window
;
6429 selected_window
= f
->selected_window
;
6430 last_nonminibuf_frame
= f
;
6432 window_initialized
= 1;
6438 Vwindow_list
= Qnil
;
6442 syms_of_window (void)
6444 DEFSYM (Qscroll_up
, "scroll-up");
6445 DEFSYM (Qscroll_down
, "scroll-down");
6446 DEFSYM (Qscroll_command
, "scroll-command");
6448 Fput (Qscroll_up
, Qscroll_command
, Qt
);
6449 Fput (Qscroll_down
, Qscroll_command
, Qt
);
6451 DEFSYM (Qwindow_configuration_change_hook
, "window-configuration-change-hook");
6452 DEFSYM (Qwindowp
, "windowp");
6453 DEFSYM (Qwindow_configuration_p
, "window-configuration-p");
6454 DEFSYM (Qwindow_live_p
, "window-live-p");
6455 DEFSYM (Qwindow_deletable_p
, "window-deletable-p");
6456 DEFSYM (Qdelete_window
, "delete-window");
6457 DEFSYM (Qwindow_resize_root_window
, "window--resize-root-window");
6458 DEFSYM (Qwindow_resize_root_window_vertically
, "window--resize-root-window-vertically");
6459 DEFSYM (Qsafe
, "safe");
6460 DEFSYM (Qdisplay_buffer
, "display-buffer");
6461 DEFSYM (Qreplace_buffer_in_windows
, "replace-buffer-in-windows");
6462 DEFSYM (Qrecord_window_buffer
, "record-window-buffer");
6463 DEFSYM (Qget_mru_window
, "get-mru-window");
6464 DEFSYM (Qtemp_buffer_show_hook
, "temp-buffer-show-hook");
6465 DEFSYM (Qabove
, "above");
6466 DEFSYM (Qbelow
, "below");
6467 DEFSYM (Qauto_buffer_name
, "auto-buffer-name");
6469 staticpro (&Vwindow_list
);
6471 minibuf_selected_window
= Qnil
;
6472 staticpro (&minibuf_selected_window
);
6474 window_scroll_pixel_based_preserve_x
= -1;
6475 window_scroll_pixel_based_preserve_y
= -1;
6476 window_scroll_preserve_hpos
= -1;
6477 window_scroll_preserve_vpos
= -1;
6479 DEFVAR_LISP ("temp-buffer-show-function", Vtemp_buffer_show_function
,
6480 doc
: /* Non-nil means call as function to display a help buffer.
6481 The function is called with one argument, the buffer to be displayed.
6482 Used by `with-output-to-temp-buffer'.
6483 If this function is used, then it must do the entire job of showing
6484 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
6485 Vtemp_buffer_show_function
= Qnil
;
6487 DEFVAR_LISP ("temp-buffer-show-specifiers", Vtemp_buffer_show_specifiers
,
6488 doc
: /* Buffer display specifiers used by `with-output-to-temp-buffer'.
6489 These specifiers are passed by `with-output-to-temp-buffer' as second
6490 argument to `display-buffer'. Applications should only let-bind this
6491 around a call to `with-output-to-temp-buffer'.
6493 For a description of buffer display specifiers see the variable
6494 `display-buffer-alist'. */);
6495 Vtemp_buffer_show_specifiers
= Qnil
;
6497 DEFVAR_LISP ("minibuffer-scroll-window", Vminibuf_scroll_window
,
6498 doc
: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
6499 Vminibuf_scroll_window
= Qnil
;
6501 DEFVAR_BOOL ("mode-line-in-non-selected-windows", mode_line_in_non_selected_windows
,
6502 doc
: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
6503 If the minibuffer is active, the `minibuffer-scroll-window' mode line
6504 is displayed in the `mode-line' face. */);
6505 mode_line_in_non_selected_windows
= 1;
6507 DEFVAR_LISP ("other-window-scroll-buffer", Vother_window_scroll_buffer
,
6508 doc
: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
6509 Vother_window_scroll_buffer
= Qnil
;
6511 DEFVAR_BOOL ("auto-window-vscroll", auto_window_vscroll_p
,
6512 doc
: /* Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
6513 auto_window_vscroll_p
= 1;
6515 DEFVAR_INT ("next-screen-context-lines", next_screen_context_lines
,
6516 doc
: /* Number of lines of continuity when scrolling by screenfuls. */);
6517 next_screen_context_lines
= 2;
6519 DEFVAR_LISP ("scroll-preserve-screen-position",
6520 Vscroll_preserve_screen_position
,
6521 doc
: /* Controls if scroll commands move point to keep its screen position unchanged.
6522 A value of nil means point does not keep its screen position except
6523 at the scroll margin or window boundary respectively.
6524 A value of t means point keeps its screen position if the scroll
6525 command moved it vertically out of the window, e.g. when scrolling
6527 Any other value means point always keeps its screen position.
6528 Scroll commands should have the `scroll-command' property
6529 on their symbols to be controlled by this variable. */);
6530 Vscroll_preserve_screen_position
= Qnil
;
6532 DEFVAR_LISP ("window-point-insertion-type", Vwindow_point_insertion_type
,
6533 doc
: /* Type of marker to use for `window-point'. */);
6534 Vwindow_point_insertion_type
= Qnil
;
6536 DEFVAR_LISP ("window-configuration-change-hook",
6537 Vwindow_configuration_change_hook
,
6538 doc
: /* Functions to call when window configuration changes.
6539 The buffer-local part is run once per window, with the relevant window
6540 selected; while the global part is run only once for the modified frame,
6541 with the relevant frame selected. */);
6542 Vwindow_configuration_change_hook
= Qnil
;
6544 DEFVAR_LISP ("recenter-redisplay", Vrecenter_redisplay
,
6545 doc
: /* If non-nil, then the `recenter' command with a nil argument
6546 will redraw the entire frame; the special value `tty' causes the
6547 frame to be redrawn only if it is a tty frame. */);
6548 Vrecenter_redisplay
= Qtty
;
6550 DEFVAR_LISP ("window-splits", Vwindow_splits
,
6551 doc
: /* Non-nil means splitting windows is handled specially.
6552 If this variable is nil, splitting a window gets the entire screen space
6553 for displaying the new window from the window to split. If this
6554 variable is non-nil, splitting a window may resize all windows in the
6555 same combination. This also allows to split a window that is otherwise
6556 too small or of fixed size.
6558 The value of this variable is also assigned to the split status of the
6559 new window and, provided the old and new window form a new combination,
6560 to the window that was split as well. The split status of a window can
6561 be retrieved with the function `window-splits' and altered by the
6562 function `set-window-splits'.
6564 If the value of the variable `window-nest' is non-nil, the space for the
6565 new window is exclusively taken from the window that shall be split, but
6566 the split status of the window that is split as well as that of the new
6567 window are still set to the value of this variable. */);
6568 Vwindow_splits
= Qnil
;
6570 DEFVAR_LISP ("window-nest", Vwindow_nest
,
6571 doc
: /* Non-nil means splitting a window makes a new parent window.
6572 If this variable is nil, splitting a window will create a new parent
6573 window only if the window has no parent window or the window shall
6574 become a combination orthogonal to the one it it is part of.
6576 If this variable is non-nil, splitting a window always creates a new
6577 parent window. If all splits behave this way, each frame's window tree
6578 is a binary tree and every window but the frame's root window has
6579 exactly one sibling.
6581 The value of this variable is also assigned to the nest status of the
6582 new parent window. The nest status of a window can be retrieved via the
6583 function `window-nest' and altered by the function `set-window-nest'. */);
6584 Vwindow_nest
= Qnil
;
6586 defsubr (&Sselected_window
);
6587 defsubr (&Sminibuffer_window
);
6588 defsubr (&Swindow_minibuffer_p
);
6589 defsubr (&Swindowp
);
6590 defsubr (&Swindow_live_p
);
6591 defsubr (&Swindow_frame
);
6592 defsubr (&Sframe_root_window
);
6593 defsubr (&Sframe_first_window
);
6594 defsubr (&Sframe_selected_window
);
6595 defsubr (&Sset_frame_selected_window
);
6596 defsubr (&Spos_visible_in_window_p
);
6597 defsubr (&Swindow_line_height
);
6598 defsubr (&Swindow_buffer
);
6599 defsubr (&Swindow_parent
);
6600 defsubr (&Swindow_top_child
);
6601 defsubr (&Swindow_left_child
);
6602 defsubr (&Swindow_next_sibling
);
6603 defsubr (&Swindow_prev_sibling
);
6604 defsubr (&Swindow_splits
);
6605 defsubr (&Sset_window_splits
);
6606 defsubr (&Swindow_nest
);
6607 defsubr (&Sset_window_nest
);
6608 defsubr (&Swindow_use_time
);
6609 defsubr (&Swindow_top_line
);
6610 defsubr (&Swindow_left_column
);
6611 defsubr (&Swindow_total_size
);
6612 defsubr (&Swindow_normal_size
);
6613 defsubr (&Swindow_new_total
);
6614 defsubr (&Swindow_new_normal
);
6615 defsubr (&Sset_window_new_total
);
6616 defsubr (&Sset_window_new_normal
);
6617 defsubr (&Swindow_resize_apply
);
6618 defsubr (&Swindow_body_size
);
6619 defsubr (&Swindow_hscroll
);
6620 defsubr (&Sset_window_hscroll
);
6621 defsubr (&Swindow_redisplay_end_trigger
);
6622 defsubr (&Sset_window_redisplay_end_trigger
);
6623 defsubr (&Swindow_edges
);
6624 defsubr (&Swindow_pixel_edges
);
6625 defsubr (&Swindow_absolute_pixel_edges
);
6626 defsubr (&Swindow_inside_edges
);
6627 defsubr (&Swindow_inside_pixel_edges
);
6628 defsubr (&Swindow_inside_absolute_pixel_edges
);
6629 defsubr (&Scoordinates_in_window_p
);
6630 defsubr (&Swindow_at
);
6631 defsubr (&Swindow_point
);
6632 defsubr (&Swindow_start
);
6633 defsubr (&Swindow_end
);
6634 defsubr (&Sset_window_point
);
6635 defsubr (&Sset_window_start
);
6636 defsubr (&Swindow_dedicated_p
);
6637 defsubr (&Sset_window_dedicated_p
);
6638 defsubr (&Swindow_display_table
);
6639 defsubr (&Sset_window_display_table
);
6640 defsubr (&Snext_window
);
6641 defsubr (&Sprevious_window
);
6642 defsubr (&Sget_buffer_window
);
6643 defsubr (&Sdelete_other_windows_internal
);
6644 defsubr (&Sdelete_window_internal
);
6645 defsubr (&Sresize_mini_window_internal
);
6646 defsubr (&Sset_window_buffer
);
6647 defsubr (&Srun_window_configuration_change_hook
);
6648 defsubr (&Sselect_window
);
6649 defsubr (&Sforce_window_update
);
6650 defsubr (&Stemp_output_buffer_show
);
6651 defsubr (&Ssplit_window_internal
);
6652 defsubr (&Sscroll_up
);
6653 defsubr (&Sscroll_down
);
6654 defsubr (&Sscroll_left
);
6655 defsubr (&Sscroll_right
);
6656 defsubr (&Sother_window_for_scrolling
);
6657 defsubr (&Sscroll_other_window
);
6658 defsubr (&Sminibuffer_selected_window
);
6659 defsubr (&Srecenter
);
6660 defsubr (&Swindow_text_height
);
6661 defsubr (&Smove_to_window_line
);
6662 defsubr (&Swindow_configuration_p
);
6663 defsubr (&Swindow_configuration_frame
);
6664 defsubr (&Sset_window_configuration
);
6665 defsubr (&Scurrent_window_configuration
);
6666 defsubr (&Sset_window_margins
);
6667 defsubr (&Swindow_margins
);
6668 defsubr (&Sset_window_fringes
);
6669 defsubr (&Swindow_fringes
);
6670 defsubr (&Sset_window_scroll_bars
);
6671 defsubr (&Swindow_scroll_bars
);
6672 defsubr (&Swindow_vscroll
);
6673 defsubr (&Sset_window_vscroll
);
6674 defsubr (&Scompare_window_configurations
);
6675 defsubr (&Swindow_list
);
6676 defsubr (&Swindow_list_1
);
6677 defsubr (&Swindow_prev_buffers
);
6678 defsubr (&Sset_window_prev_buffers
);
6679 defsubr (&Swindow_next_buffers
);
6680 defsubr (&Sset_window_next_buffers
);
6681 defsubr (&Swindow_parameters
);
6682 defsubr (&Swindow_parameter
);
6683 defsubr (&Sset_window_parameter
);
6687 keys_of_window (void)
6689 initial_define_key (control_x_map
, '<', "scroll-left");
6690 initial_define_key (control_x_map
, '>', "scroll-right");
6692 initial_define_key (global_map
, Ctl ('V'), "scroll-up-command");
6693 initial_define_key (meta_map
, Ctl ('V'), "scroll-other-window");
6694 initial_define_key (meta_map
, 'v', "scroll-down-command");