1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985-1987, 1993-1998, 2000-2012
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.
163 Internal windows and deleted windows are not live. */)
166 return WINDOW_LIVE_P (object
) ? Qt
: Qnil
;
169 /* Frames and windows. */
170 DEFUN ("window-frame", Fwindow_frame
, Swindow_frame
, 1, 1, 0,
171 doc
: /* Return the frame that window WINDOW is on.
172 If WINDOW is omitted or nil, it defaults to the selected window. */)
175 return decode_any_window (window
)->frame
;
178 DEFUN ("frame-root-window", Fframe_root_window
, Sframe_root_window
, 0, 1, 0,
179 doc
: /* Return the root window of FRAME-OR-WINDOW.
180 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
181 With a frame argument, return that frame's root window.
182 With a window argument, return the root window of that window's 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 minibuffer window for frame FRAME.
202 If FRAME is omitted or nil, it defaults to the selected frame. */)
206 frame
= selected_frame
;
207 CHECK_LIVE_FRAME (frame
);
208 return FRAME_MINIBUF_WINDOW (XFRAME (frame
));
211 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p
,
212 Swindow_minibuffer_p
, 0, 1, 0,
213 doc
: /* Return non-nil if WINDOW is a minibuffer window.
214 If WINDOW is omitted or nil, it defaults to the selected window. */)
217 return MINI_WINDOW_P (decode_any_window (window
)) ? Qt
: Qnil
;
220 /* Don't move this to window.el - this must be a safe routine. */
221 DEFUN ("frame-first-window", Fframe_first_window
, Sframe_first_window
, 0, 1, 0,
222 doc
: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
223 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
224 Else if FRAME-OR-WINDOW denotes any window, return the first window of
225 that window's frame. If FRAME-OR-WINDOW denotes a live frame, return
226 the first window of that frame. */)
227 (Lisp_Object frame_or_window
)
231 if (NILP (frame_or_window
))
232 window
= SELECTED_FRAME ()->root_window
;
233 else if (WINDOWP (frame_or_window
))
234 window
= XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window
)))->root_window
;
237 CHECK_LIVE_FRAME (frame_or_window
);
238 window
= XFRAME (frame_or_window
)->root_window
;
241 while (NILP (XWINDOW (window
)->buffer
))
243 if (! NILP (XWINDOW (window
)->hchild
))
244 window
= XWINDOW (window
)->hchild
;
245 else if (! NILP (XWINDOW (window
)->vchild
))
246 window
= XWINDOW (window
)->vchild
;
254 DEFUN ("frame-selected-window", Fframe_selected_window
,
255 Sframe_selected_window
, 0, 1, 0,
256 doc
: /* Return the selected window of FRAME-OR-WINDOW.
257 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
258 Else if FRAME-OR-WINDOW denotes any window, return the selected window
259 of that window's frame. If FRAME-OR-WINDOW denotes a live frame, return
260 the selected window of that frame. */)
261 (Lisp_Object frame_or_window
)
265 if (NILP (frame_or_window
))
266 window
= SELECTED_FRAME ()->selected_window
;
267 else if (WINDOWP (frame_or_window
))
268 window
= XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window
)))->selected_window
;
271 CHECK_LIVE_FRAME (frame_or_window
);
272 window
= XFRAME (frame_or_window
)->selected_window
;
278 DEFUN ("set-frame-selected-window", Fset_frame_selected_window
,
279 Sset_frame_selected_window
, 2, 3, 0,
280 doc
: /* Set selected window of FRAME to WINDOW.
281 FRAME must be a live frame and defaults to the selected one. If FRAME
282 is the selected frame, this makes WINDOW the selected window. Optional
283 argument NORECORD non-nil means to neither change the order of recently
284 selected windows nor the buffer list. WINDOW must denote a live window.
286 (Lisp_Object frame
, Lisp_Object window
, Lisp_Object norecord
)
289 frame
= selected_frame
;
291 CHECK_LIVE_FRAME (frame
);
292 CHECK_LIVE_WINDOW (window
);
294 if (! EQ (frame
, WINDOW_FRAME (XWINDOW (window
))))
295 error ("In `set-frame-selected-window', WINDOW is not on FRAME");
297 if (EQ (frame
, selected_frame
))
298 return Fselect_window (window
, norecord
);
300 return XFRAME (frame
)->selected_window
= window
;
303 DEFUN ("selected-window", Fselected_window
, Sselected_window
, 0, 0, 0,
304 doc
: /* Return the selected window.
305 The selected window is the window in which the standard cursor for
306 selected windows appears and to which many commands apply. */)
309 return selected_window
;
312 int window_select_count
;
314 /* If select_window is called with inhibit_point_swap non-zero it will
315 not store point of the old selected window's buffer back into that
316 window's pointm slot. This is needed by Fset_window_configuration to
317 avoid that the display routine is called with selected_window set to
318 Qnil causing a subsequent crash. */
320 select_window (Lisp_Object window
, Lisp_Object norecord
, int inhibit_point_swap
)
322 register struct window
*w
;
323 register struct window
*ow
;
326 CHECK_LIVE_WINDOW (window
);
328 w
= XWINDOW (window
);
329 w
->frozen_window_start_p
= 0;
333 ++window_select_count
;
334 XSETFASTINT (w
->use_time
, window_select_count
);
335 record_buffer (w
->buffer
);
338 if (EQ (window
, selected_window
) && !inhibit_point_swap
)
341 sf
= SELECTED_FRAME ();
342 if (XFRAME (WINDOW_FRAME (w
)) != sf
)
344 XFRAME (WINDOW_FRAME (w
))->selected_window
= window
;
345 /* Use this rather than Fhandle_switch_frame
346 so that FRAME_FOCUS_FRAME is moved appropriately as we
347 move around in the state where a minibuffer in a separate
349 Fselect_frame (WINDOW_FRAME (w
), norecord
);
350 /* Fselect_frame called us back so we've done all the work already. */
351 eassert (EQ (window
, selected_window
));
355 sf
->selected_window
= window
;
357 /* Store the current buffer's actual point into the
358 old selected window. It belongs to that window,
359 and when the window is not selected, must be in the window. */
360 if (!inhibit_point_swap
)
362 ow
= XWINDOW (selected_window
);
363 if (! NILP (ow
->buffer
))
364 set_marker_both (ow
->pointm
, ow
->buffer
,
365 BUF_PT (XBUFFER (ow
->buffer
)),
366 BUF_PT_BYTE (XBUFFER (ow
->buffer
)));
369 selected_window
= window
;
371 Fset_buffer (w
->buffer
);
373 BVAR (XBUFFER (w
->buffer
), last_selected_window
) = window
;
375 /* Go to the point recorded in the window.
376 This is important when the buffer is in more
377 than one window. It also matters when
378 redisplay_window has altered point after scrolling,
379 because it makes the change only in the window. */
381 register ptrdiff_t new_point
= marker_position (w
->pointm
);
382 if (new_point
< BEGV
)
384 else if (new_point
> ZV
)
390 windows_or_buffers_changed
++;
394 DEFUN ("select-window", Fselect_window
, Sselect_window
, 1, 2, 0,
395 doc
: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
396 Also make WINDOW's buffer current and make WINDOW the frame's selected
397 window. Return WINDOW.
399 Optional second arg NORECORD non-nil means do not put this buffer at the
400 front of the buffer list and do not make this window the most recently
403 Note that the main editor command loop sets the current buffer to the
404 buffer of the selected window before each command. */)
405 (register Lisp_Object window
, Lisp_Object norecord
)
407 return select_window (window
, norecord
, 0);
410 DEFUN ("window-buffer", Fwindow_buffer
, Swindow_buffer
, 0, 1, 0,
411 doc
: /* Return the buffer displayed in window WINDOW.
412 If WINDOW is omitted or nil, it defaults to the selected window.
413 Return nil for an internal window or a deleted window. */)
416 return decode_any_window (window
)->buffer
;
419 DEFUN ("window-parent", Fwindow_parent
, Swindow_parent
, 0, 1, 0,
420 doc
: /* Return the parent window of window WINDOW.
421 If WINDOW is omitted or nil, it defaults to the selected window.
422 Return nil for a window with no parent (e.g. a root window). */)
425 return decode_any_window (window
)->parent
;
428 DEFUN ("window-top-child", Fwindow_top_child
, Swindow_top_child
, 1, 1, 0,
429 doc
: /* Return the topmost child window of window WINDOW.
430 Return nil if WINDOW is a live window (live windows have no children).
431 Return nil if WINDOW is an internal window whose children form a
432 horizontal combination. */)
435 CHECK_WINDOW (window
);
436 return decode_any_window (window
)->vchild
;
439 DEFUN ("window-left-child", Fwindow_left_child
, Swindow_left_child
, 1, 1, 0,
440 doc
: /* Return the leftmost child window of window WINDOW.
441 Return nil if WINDOW is a live window (live windows have no children).
442 Return nil if WINDOW is an internal window whose children form a
443 vertical combination. */)
446 CHECK_WINDOW (window
);
447 return decode_any_window (window
)->hchild
;
450 DEFUN ("window-next-sibling", Fwindow_next_sibling
, Swindow_next_sibling
, 0, 1, 0,
451 doc
: /* Return the next sibling window of window WINDOW.
452 If WINDOW is omitted or nil, it defaults to the selected window.
453 Return nil if WINDOW has no next sibling. */)
456 return decode_any_window (window
)->next
;
459 DEFUN ("window-prev-sibling", Fwindow_prev_sibling
, Swindow_prev_sibling
, 0, 1, 0,
460 doc
: /* Return the previous sibling window of window WINDOW.
461 If WINDOW is omitted or nil, it defaults to the selected window.
462 Return nil if WINDOW has no previous sibling. */)
465 return decode_any_window (window
)->prev
;
468 DEFUN ("window-combination-limit", Fwindow_combination_limit
, Swindow_combination_limit
, 1, 1, 0,
469 doc
: /* Return combination limit of window WINDOW.
470 If the return value is nil, child windows of WINDOW can be recombined with
471 WINDOW's siblings. A return value of t means that child windows of
472 WINDOW are never \(re-)combined with WINDOW's siblings. */)
475 return decode_any_window (window
)->combination_limit
;
478 DEFUN ("set-window-combination-limit", Fset_window_combination_limit
, Sset_window_combination_limit
, 2, 2, 0,
479 doc
: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
480 If LIMIT is nil, child windows of WINDOW can be recombined with
481 WINDOW's siblings. LIMIT t means that child windows of WINDOW are
482 never \(re-)combined with WINDOW's siblings. Other values are reserved
484 (Lisp_Object window
, Lisp_Object limit
)
486 register struct window
*w
= decode_any_window (window
);
488 w
->combination_limit
= limit
;
490 return w
->combination_limit
;
493 DEFUN ("window-use-time", Fwindow_use_time
, Swindow_use_time
, 0, 1, 0,
494 doc
: /* Return the use time of window WINDOW.
495 If WINDOW is omitted or nil, it defaults to the selected window.
496 The window with the highest use time is the most recently selected
497 one. The window with the lowest use time is the least recently
501 return decode_window (window
)->use_time
;
504 DEFUN ("window-total-height", Fwindow_total_height
, Swindow_total_height
, 0, 1, 0,
505 doc
: /* Return the total height, in lines, of window WINDOW.
506 If WINDOW is omitted or nil, it defaults to the selected window.
508 The return value includes the mode line and header line, if any.
509 If WINDOW is an internal window, the total height is the height
510 of the screen areas spanned by its children.
512 On a graphical display, this total height is reported as an
513 integer multiple of the default character height. */)
516 return decode_any_window (window
)->total_lines
;
519 DEFUN ("window-total-width", Fwindow_total_width
, Swindow_total_width
, 0, 1, 0,
520 doc
: /* Return the total width, in columns, of window WINDOW.
521 If WINDOW is omitted or nil, it defaults to the selected window.
523 The return value includes any vertical dividers or scroll bars
524 belonging to WINDOW. If WINDOW is an internal window, the total width
525 is the width of the screen areas spanned by its children.
527 On a graphical display, this total width is reported as an
528 integer multiple of the default character width. */)
531 return decode_any_window (window
)->total_cols
;
534 DEFUN ("window-new-total", Fwindow_new_total
, Swindow_new_total
, 0, 1, 0,
535 doc
: /* Return the new total size of window WINDOW.
536 If WINDOW is omitted or nil, it defaults to the selected window. */)
539 return decode_any_window (window
)->new_total
;
542 DEFUN ("window-normal-size", Fwindow_normal_size
, Swindow_normal_size
, 0, 2, 0,
543 doc
: /* Return the normal height of window WINDOW.
544 If WINDOW is omitted or nil, it defaults to the selected window.
545 If HORIZONTAL is non-nil, return the normal width of WINDOW. */)
546 (Lisp_Object window
, Lisp_Object horizontal
)
548 if (NILP (horizontal
))
549 return decode_any_window (window
)->normal_lines
;
551 return decode_any_window (window
)->normal_cols
;
554 DEFUN ("window-new-normal", Fwindow_new_normal
, Swindow_new_normal
, 0, 1, 0,
555 doc
: /* Return new normal size of window WINDOW.
556 If WINDOW is omitted or nil, it defaults to the selected window. */)
559 return decode_any_window (window
)->new_normal
;
562 DEFUN ("window-left-column", Fwindow_left_column
, Swindow_left_column
, 0, 1, 0,
563 doc
: /* Return left column of window WINDOW.
564 This is the distance, in columns, between the left edge of WINDOW and
565 the left edge of the frame's window area. For instance, the return
566 value is 0 if there is no window to the left of WINDOW.
568 If WINDOW is omitted or nil, it defaults to the selected window. */)
571 return decode_any_window (window
)->left_col
;
574 DEFUN ("window-top-line", Fwindow_top_line
, Swindow_top_line
, 0, 1, 0,
575 doc
: /* Return top line of window WINDOW.
576 This is the distance, in lines, between the top of WINDOW and the top
577 of the frame's window area. For instance, the return value is 0 if
578 there is no window above WINDOW.
580 If WINDOW is omitted or nil, it defaults to the selected window. */)
583 return decode_any_window (window
)->top_line
;
586 /* Return the number of lines of W's body. Don't count any mode or
590 window_body_lines (struct window
*w
)
592 int height
= XFASTINT (w
->total_lines
);
594 if (!MINI_WINDOW_P (w
))
596 if (WINDOW_WANTS_MODELINE_P (w
))
598 if (WINDOW_WANTS_HEADER_LINE_P (w
))
605 /* Return the number of columns of W's body. Don't count columns
606 occupied by the scroll bar or the vertical bar separating W from its
607 right sibling. On window-systems don't count fringes or display
611 window_body_cols (struct window
*w
)
613 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
614 int width
= XINT (w
->total_cols
);
616 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
617 /* Scroll bars occupy a few columns. */
618 width
-= WINDOW_CONFIG_SCROLL_BAR_COLS (w
);
619 else if (!FRAME_WINDOW_P (f
)
620 && !WINDOW_RIGHTMOST_P (w
) && !WINDOW_FULL_WIDTH_P (w
))
621 /* The column of `|' characters separating side-by-side windows
622 occupies one column only. */
625 if (FRAME_WINDOW_P (f
))
626 /* On window-systems, fringes and display margins cannot be
627 used for normal text. */
628 width
-= (WINDOW_FRINGE_COLS (w
)
629 + WINDOW_LEFT_MARGIN_COLS (w
)
630 + WINDOW_RIGHT_MARGIN_COLS (w
));
635 DEFUN ("window-body-height", Fwindow_body_height
, Swindow_body_height
, 0, 1, 0,
636 doc
: /* Return the height, in lines, of WINDOW's text area.
637 If WINDOW is omitted or nil, it defaults to the selected window.
638 Signal an error if the window is not live.
640 The returned height does not include the mode line or header line.
641 On a graphical display, the height is expressed as an integer multiple
642 of the default character height. If a line at the bottom of the text
643 area is only partially visible, that counts as a whole line; to
644 exclude partially-visible lines, use `window-text-height'. */)
647 struct window
*w
= decode_window (window
);
648 return make_number (window_body_lines (w
));
651 DEFUN ("window-body-width", Fwindow_body_width
, Swindow_body_width
, 0, 1, 0,
652 doc
: /* Return the width, in columns, of WINDOW's text area.
653 If WINDOW is omitted or nil, it defaults to the selected window.
654 Signal an error if the window is not live.
656 The return value does not include any vertical dividers, fringe or
657 marginal areas, or scroll bars. On a graphical display, the width is
658 expressed as an integer multiple of the default character width. */)
661 struct window
*w
= decode_window (window
);
662 return make_number (window_body_cols (w
));
665 DEFUN ("window-hscroll", Fwindow_hscroll
, Swindow_hscroll
, 0, 1, 0,
666 doc
: /* Return the number of columns by which WINDOW is scrolled from left margin.
667 WINDOW must be a live window and defaults to the selected one. */)
670 return decode_window (window
)->hscroll
;
673 DEFUN ("set-window-hscroll", Fset_window_hscroll
, Sset_window_hscroll
, 2, 2, 0,
674 doc
: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
675 If WINDOW is nil, the selected window is used.
676 Return NCOL. NCOL should be zero or positive.
678 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
679 window so that the location of point moves off-window. */)
680 (Lisp_Object window
, Lisp_Object ncol
)
682 struct window
*w
= decode_window (window
);
686 hscroll
= clip_to_bounds (0, XINT (ncol
), PTRDIFF_MAX
);
688 /* Prevent redisplay shortcuts when changing the hscroll. */
689 if (XINT (w
->hscroll
) != hscroll
)
690 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
692 w
->hscroll
= make_number (hscroll
);
696 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger
,
697 Swindow_redisplay_end_trigger
, 0, 1, 0,
698 doc
: /* Return WINDOW's redisplay end trigger value.
699 WINDOW defaults to the selected window.
700 See `set-window-redisplay-end-trigger' for more information. */)
703 return decode_window (window
)->redisplay_end_trigger
;
706 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger
,
707 Sset_window_redisplay_end_trigger
, 2, 2, 0,
708 doc
: /* Set WINDOW's redisplay end trigger value to VALUE.
709 VALUE should be a buffer position (typically a marker) or nil.
710 If it is a buffer position, then if redisplay in WINDOW reaches a position
711 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
712 with two arguments: WINDOW, and the end trigger value.
713 Afterwards the end-trigger value is reset to nil. */)
714 (register Lisp_Object window
, Lisp_Object value
)
716 register struct window
*w
;
718 w
= decode_window (window
);
719 w
->redisplay_end_trigger
= value
;
723 DEFUN ("window-edges", Fwindow_edges
, Swindow_edges
, 0, 1, 0,
724 doc
: /* Return a list of the edge coordinates of WINDOW.
725 The list has the form (LEFT TOP RIGHT BOTTOM).
726 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
727 all relative to 0, 0 at top left corner of frame.
729 RIGHT is one more than the rightmost column occupied by WINDOW.
730 BOTTOM is one more than the bottommost row occupied by WINDOW.
731 The edges include the space used by WINDOW's scroll bar, display
732 margins, fringes, header line, and/or mode line. For the edges of
733 just the text area, use `window-inside-edges'. */)
736 register struct window
*w
= decode_any_window (window
);
738 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w
)),
739 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w
)),
740 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w
)),
741 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w
)),
745 DEFUN ("window-pixel-edges", Fwindow_pixel_edges
, Swindow_pixel_edges
, 0, 1, 0,
746 doc
: /* Return a list of the edge pixel coordinates of WINDOW.
747 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
748 the top left corner of the frame.
750 RIGHT is one more than the rightmost x position occupied by WINDOW.
751 BOTTOM is one more than the bottommost y position occupied by WINDOW.
752 The pixel edges include the space used by WINDOW's scroll bar, display
753 margins, fringes, header line, and/or mode line. For the pixel edges
754 of just the text area, use `window-inside-pixel-edges'. */)
757 register struct window
*w
= decode_any_window (window
);
759 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w
)),
760 Fcons (make_number (WINDOW_TOP_EDGE_Y (w
)),
761 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w
)),
762 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w
)),
767 calc_absolute_offset (struct window
*w
, int *add_x
, int *add_y
)
769 struct frame
*f
= XFRAME (w
->frame
);
771 #ifdef FRAME_MENUBAR_HEIGHT
772 *add_y
+= FRAME_MENUBAR_HEIGHT (f
);
774 #ifdef FRAME_TOOLBAR_TOP_HEIGHT
775 *add_y
+= FRAME_TOOLBAR_TOP_HEIGHT (f
);
776 #elif FRAME_TOOLBAR_HEIGHT
777 *add_y
+= FRAME_TOOLBAR_HEIGHT (f
);
779 #ifdef FRAME_NS_TITLEBAR_HEIGHT
780 *add_y
+= FRAME_NS_TITLEBAR_HEIGHT (f
);
782 *add_x
= f
->left_pos
;
783 #ifdef FRAME_TOOLBAR_LEFT_WIDTH
784 *add_x
+= FRAME_TOOLBAR_LEFT_WIDTH (f
);
788 DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges
,
789 Swindow_absolute_pixel_edges
, 0, 1, 0,
790 doc
: /* Return a list of the edge pixel coordinates of WINDOW.
791 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
792 the top left corner of the display.
794 RIGHT is one more than the rightmost x position occupied by WINDOW.
795 BOTTOM is one more than the bottommost y position occupied by WINDOW.
796 The pixel edges include the space used by WINDOW's scroll bar, display
797 margins, fringes, header line, and/or mode line. For the pixel edges
798 of just the text area, use `window-inside-absolute-pixel-edges'. */)
801 register struct window
*w
= decode_any_window (window
);
803 calc_absolute_offset (w
, &add_x
, &add_y
);
805 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w
) + add_x
),
806 Fcons (make_number (WINDOW_TOP_EDGE_Y (w
) + add_y
),
807 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w
) + add_x
),
808 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w
) + add_y
),
812 DEFUN ("window-inside-edges", Fwindow_inside_edges
, Swindow_inside_edges
, 0, 1, 0,
813 doc
: /* Return a list of the edge coordinates of WINDOW.
814 The list has the form (LEFT TOP RIGHT BOTTOM).
815 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
816 all relative to 0, 0 at top left corner of frame.
818 RIGHT is one more than the rightmost column of WINDOW's text area.
819 BOTTOM is one more than the bottommost row of WINDOW's text area.
820 The inside edges do not include the space used by the WINDOW's scroll
821 bar, display margins, fringes, header line, and/or mode line. */)
824 register struct window
*w
= decode_window (window
);
826 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w
)
827 + WINDOW_LEFT_MARGIN_COLS (w
)
828 + WINDOW_LEFT_FRINGE_COLS (w
)),
829 make_number (WINDOW_TOP_EDGE_LINE (w
)
830 + WINDOW_HEADER_LINE_LINES (w
)),
831 make_number (WINDOW_BOX_RIGHT_EDGE_COL (w
)
832 - WINDOW_RIGHT_MARGIN_COLS (w
)
833 - WINDOW_RIGHT_FRINGE_COLS (w
)),
834 make_number (WINDOW_BOTTOM_EDGE_LINE (w
)
835 - WINDOW_MODE_LINE_LINES (w
)));
838 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges
, Swindow_inside_pixel_edges
, 0, 1, 0,
839 doc
: /* Return a list of the edge pixel coordinates of WINDOW's text area.
840 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to (0,0)
841 at the top left corner of the frame's window area.
843 RIGHT is one more than the rightmost x position of WINDOW's text area.
844 BOTTOM is one more than the bottommost y position of WINDOW's text area.
845 The inside edges do not include the space used by WINDOW's scroll bar,
846 display margins, fringes, header line, and/or mode line. */)
849 register struct window
*w
= decode_window (window
);
851 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w
)
852 + WINDOW_LEFT_MARGIN_WIDTH (w
)
853 + WINDOW_LEFT_FRINGE_WIDTH (w
)),
854 make_number (WINDOW_TOP_EDGE_Y (w
)
855 + WINDOW_HEADER_LINE_HEIGHT (w
)),
856 make_number (WINDOW_BOX_RIGHT_EDGE_X (w
)
857 - WINDOW_RIGHT_MARGIN_WIDTH (w
)
858 - WINDOW_RIGHT_FRINGE_WIDTH (w
)),
859 make_number (WINDOW_BOTTOM_EDGE_Y (w
)
860 - WINDOW_MODE_LINE_HEIGHT (w
)));
863 DEFUN ("window-inside-absolute-pixel-edges",
864 Fwindow_inside_absolute_pixel_edges
,
865 Swindow_inside_absolute_pixel_edges
, 0, 1, 0,
866 doc
: /* Return a list of the edge pixel coordinates of WINDOW's text area.
867 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to (0,0)
868 at the top left corner of the frame's window area.
870 RIGHT is one more than the rightmost x position of WINDOW's text area.
871 BOTTOM is one more than the bottommost y position of WINDOW's text area.
872 The inside edges do not include the space used by WINDOW's scroll bar,
873 display margins, fringes, header line, and/or mode line. */)
876 register struct window
*w
= decode_window (window
);
878 calc_absolute_offset (w
, &add_x
, &add_y
);
880 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w
)
881 + WINDOW_LEFT_MARGIN_WIDTH (w
)
882 + WINDOW_LEFT_FRINGE_WIDTH (w
) + add_x
),
883 make_number (WINDOW_TOP_EDGE_Y (w
)
884 + WINDOW_HEADER_LINE_HEIGHT (w
) + add_y
),
885 make_number (WINDOW_BOX_RIGHT_EDGE_X (w
)
886 - WINDOW_RIGHT_MARGIN_WIDTH (w
)
887 - WINDOW_RIGHT_FRINGE_WIDTH (w
) + add_x
),
888 make_number (WINDOW_BOTTOM_EDGE_Y (w
)
889 - WINDOW_MODE_LINE_HEIGHT (w
) + add_y
));
892 /* Test if the character at column X, row Y is within window W.
893 If it is not, return ON_NOTHING;
894 if it is in the window's text area, return ON_TEXT;
895 if it is on the window's modeline, return ON_MODE_LINE;
896 if it is on the border between the window and its right sibling,
897 return ON_VERTICAL_BORDER.
898 if it is on a scroll bar, return ON_SCROLL_BAR.
899 if it is on the window's top line, return ON_HEADER_LINE;
900 if it is in left or right fringe of the window,
901 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
902 if it is in the marginal area to the left/right of the window,
903 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
905 X and Y are frame relative pixel coordinates. */
907 static enum window_part
908 coordinates_in_window (register struct window
*w
, int x
, int y
)
910 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
911 enum window_part part
;
912 int ux
= FRAME_COLUMN_WIDTH (f
);
913 int left_x
= WINDOW_LEFT_EDGE_X (w
);
914 int right_x
= WINDOW_RIGHT_EDGE_X (w
);
915 int top_y
= WINDOW_TOP_EDGE_Y (w
);
916 int bottom_y
= WINDOW_BOTTOM_EDGE_Y (w
);
917 /* The width of the area where the vertical line can be dragged.
918 (Between mode lines for instance. */
919 int grabbable_width
= ux
;
920 int lmargin_width
, rmargin_width
, text_left
, text_right
;
922 /* Outside any interesting row or column? */
923 if (y
< top_y
|| y
>= bottom_y
|| x
< left_x
|| x
>= right_x
)
926 /* On the mode line or header line? */
927 if ((WINDOW_WANTS_MODELINE_P (w
)
928 && y
>= bottom_y
- CURRENT_MODE_LINE_HEIGHT (w
)
929 && (part
= ON_MODE_LINE
))
930 || (WINDOW_WANTS_HEADER_LINE_P (w
)
931 && y
< top_y
+ CURRENT_HEADER_LINE_HEIGHT (w
)
932 && (part
= ON_HEADER_LINE
)))
934 /* If it's under/over the scroll bar portion of the mode/header
935 line, say it's on the vertical line. That's to be able to
936 resize windows horizontally in case we're using toolkit scroll
937 bars. Note: If scrollbars are on the left, the window that
938 must be eventually resized is that on the left of WINDOW. */
939 if ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
940 && !WINDOW_LEFTMOST_P (w
)
941 && eabs (x
- left_x
) < grabbable_width
)
942 || (!WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
943 && !WINDOW_RIGHTMOST_P (w
)
944 && eabs (x
- right_x
) < grabbable_width
))
945 return ON_VERTICAL_BORDER
;
950 /* In what's below, we subtract 1 when computing right_x because we
951 want the rightmost pixel, which is given by left_pixel+width-1. */
952 if (w
->pseudo_window_p
)
955 right_x
= WINDOW_TOTAL_WIDTH (w
) - 1;
959 left_x
= WINDOW_BOX_LEFT_EDGE_X (w
);
960 right_x
= WINDOW_BOX_RIGHT_EDGE_X (w
) - 1;
963 /* Outside any interesting column? */
964 if (x
< left_x
|| x
> right_x
)
965 return ON_SCROLL_BAR
;
967 lmargin_width
= window_box_width (w
, LEFT_MARGIN_AREA
);
968 rmargin_width
= window_box_width (w
, RIGHT_MARGIN_AREA
);
970 text_left
= window_box_left (w
, TEXT_AREA
);
971 text_right
= text_left
+ window_box_width (w
, TEXT_AREA
);
973 if (FRAME_WINDOW_P (f
))
975 if (!w
->pseudo_window_p
976 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
977 && !WINDOW_RIGHTMOST_P (w
)
978 && (eabs (x
- right_x
) < grabbable_width
))
979 return ON_VERTICAL_BORDER
;
981 /* Need to say "x > right_x" rather than >=, since on character
982 terminals, the vertical line's x coordinate is right_x. */
983 else if (!w
->pseudo_window_p
984 && !WINDOW_RIGHTMOST_P (w
)
986 return ON_VERTICAL_BORDER
;
990 if (lmargin_width
> 0
991 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
992 ? (x
>= left_x
+ WINDOW_LEFT_FRINGE_WIDTH (w
))
993 : (x
< left_x
+ lmargin_width
)))
994 return ON_LEFT_MARGIN
;
996 return ON_LEFT_FRINGE
;
1001 if (rmargin_width
> 0
1002 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1003 ? (x
< right_x
- WINDOW_RIGHT_FRINGE_WIDTH (w
))
1004 : (x
>= right_x
- rmargin_width
)))
1005 return ON_RIGHT_MARGIN
;
1007 return ON_RIGHT_FRINGE
;
1010 /* Everything special ruled out - must be on text area */
1014 /* Take X is the frame-relative pixel x-coordinate, and return the
1015 x-coordinate relative to part PART of window W. */
1017 window_relative_x_coord (struct window
*w
, enum window_part part
, int x
)
1019 int left_x
= (w
->pseudo_window_p
) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w
);
1024 return x
- window_box_left (w
, TEXT_AREA
);
1026 case ON_LEFT_FRINGE
:
1029 case ON_RIGHT_FRINGE
:
1030 return x
- left_x
- WINDOW_LEFT_FRINGE_WIDTH (w
);
1032 case ON_LEFT_MARGIN
:
1034 - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1035 ? WINDOW_LEFT_FRINGE_WIDTH (w
) : 0));
1037 case ON_RIGHT_MARGIN
:
1039 - ((w
->pseudo_window_p
)
1040 ? WINDOW_TOTAL_WIDTH (w
)
1041 : WINDOW_BOX_RIGHT_EDGE_X (w
))
1042 + window_box_width (w
, RIGHT_MARGIN_AREA
)
1043 + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1044 ? WINDOW_RIGHT_FRINGE_WIDTH (w
) : 0));
1047 /* ON_SCROLL_BAR, ON_NOTHING, and ON_VERTICAL_BORDER: */
1052 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p
,
1053 Scoordinates_in_window_p
, 2, 2, 0,
1054 doc
: /* Return non-nil if COORDINATES are in WINDOW.
1055 WINDOW must be a live window.
1056 COORDINATES is a cons of the form (X . Y), X and Y being distances
1057 measured in characters from the upper-left corner of the frame.
1058 \(0 . 0) denotes the character in the upper left corner of the
1060 If COORDINATES are in the text portion of WINDOW,
1061 the coordinates relative to the window are returned.
1062 If they are in the mode line of WINDOW, `mode-line' is returned.
1063 If they are in the top mode line of WINDOW, `header-line' is returned.
1064 If they are in the left fringe of WINDOW, `left-fringe' is returned.
1065 If they are in the right fringe of WINDOW, `right-fringe' is returned.
1066 If they are on the border between WINDOW and its right sibling,
1067 `vertical-line' is returned.
1068 If they are in the windows's left or right marginal areas, `left-margin'\n\
1069 or `right-margin' is returned. */)
1070 (register Lisp_Object coordinates
, Lisp_Object window
)
1077 CHECK_LIVE_WINDOW (window
);
1078 w
= XWINDOW (window
);
1079 f
= XFRAME (w
->frame
);
1080 CHECK_CONS (coordinates
);
1081 lx
= Fcar (coordinates
);
1082 ly
= Fcdr (coordinates
);
1083 CHECK_NUMBER_OR_FLOAT (lx
);
1084 CHECK_NUMBER_OR_FLOAT (ly
);
1085 x
= FRAME_PIXEL_X_FROM_CANON_X (f
, lx
) + FRAME_INTERNAL_BORDER_WIDTH (f
);
1086 y
= FRAME_PIXEL_Y_FROM_CANON_Y (f
, ly
) + FRAME_INTERNAL_BORDER_WIDTH (f
);
1088 switch (coordinates_in_window (w
, x
, y
))
1094 /* Convert X and Y to window relative pixel coordinates, and
1095 return the canonical char units. */
1096 x
-= window_box_left (w
, TEXT_AREA
);
1097 y
-= WINDOW_TOP_EDGE_Y (w
);
1098 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f
, x
),
1099 FRAME_CANON_Y_FROM_PIXEL_Y (f
, y
));
1104 case ON_VERTICAL_BORDER
:
1105 return Qvertical_line
;
1107 case ON_HEADER_LINE
:
1108 return Qheader_line
;
1110 case ON_LEFT_FRINGE
:
1111 return Qleft_fringe
;
1113 case ON_RIGHT_FRINGE
:
1114 return Qright_fringe
;
1116 case ON_LEFT_MARGIN
:
1117 return Qleft_margin
;
1119 case ON_RIGHT_MARGIN
:
1120 return Qright_margin
;
1123 /* Historically we are supposed to return nil in this case. */
1132 /* Callback for foreach_window, used in window_from_coordinates.
1133 Check if window W contains coordinates specified by USER_DATA which
1134 is actually a pointer to a struct check_window_data CW.
1136 Check if window W contains coordinates *CW->x and *CW->y. If it
1137 does, return W in *CW->window, as Lisp_Object, and return in
1138 *CW->part the part of the window under coordinates *X,*Y. Return
1139 zero from this function to stop iterating over windows. */
1141 struct check_window_data
1143 Lisp_Object
*window
;
1145 enum window_part
*part
;
1149 check_window_containing (struct window
*w
, void *user_data
)
1151 struct check_window_data
*cw
= (struct check_window_data
*) user_data
;
1152 enum window_part found
;
1155 found
= coordinates_in_window (w
, cw
->x
, cw
->y
);
1156 if (found
!= ON_NOTHING
)
1159 XSETWINDOW (*cw
->window
, w
);
1167 /* Find the window containing frame-relative pixel position X/Y and
1168 return it as a Lisp_Object.
1170 If X, Y is on one of the window's special `window_part' elements,
1171 set *PART to the id of that element.
1173 If there is no window under X, Y return nil and leave *PART
1174 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1176 This function was previously implemented with a loop cycling over
1177 windows with Fnext_window, and starting with the frame's selected
1178 window. It turned out that this doesn't work with an
1179 implementation of next_window using Vwindow_list, because
1180 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1181 tree of F when this function is called asynchronously from
1182 note_mouse_highlight. The original loop didn't terminate in this
1186 window_from_coordinates (struct frame
*f
, int x
, int y
,
1187 enum window_part
*part
, int tool_bar_p
)
1190 struct check_window_data cw
;
1191 enum window_part dummy
;
1197 cw
.window
= &window
, cw
.x
= x
, cw
.y
= y
; cw
.part
= part
;
1198 foreach_window (f
, check_window_containing
, &cw
);
1200 /* If not found above, see if it's in the tool bar window, if a tool
1204 && WINDOWP (f
->tool_bar_window
)
1205 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0
1206 && (coordinates_in_window (XWINDOW (f
->tool_bar_window
), x
, y
)
1210 window
= f
->tool_bar_window
;
1216 DEFUN ("window-at", Fwindow_at
, Swindow_at
, 2, 3, 0,
1217 doc
: /* Return window containing coordinates X and Y on FRAME.
1218 FRAME must be a live frame and defaults to the selected one.
1219 The top left corner of the frame is considered to be row 0,
1221 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame
)
1226 frame
= selected_frame
;
1227 CHECK_LIVE_FRAME (frame
);
1230 /* Check that arguments are integers or floats. */
1231 CHECK_NUMBER_OR_FLOAT (x
);
1232 CHECK_NUMBER_OR_FLOAT (y
);
1234 return window_from_coordinates (f
,
1235 (FRAME_PIXEL_X_FROM_CANON_X (f
, x
)
1236 + FRAME_INTERNAL_BORDER_WIDTH (f
)),
1237 (FRAME_PIXEL_Y_FROM_CANON_Y (f
, y
)
1238 + FRAME_INTERNAL_BORDER_WIDTH (f
)),
1242 DEFUN ("window-point", Fwindow_point
, Swindow_point
, 0, 1, 0,
1243 doc
: /* Return current value of point in WINDOW.
1244 WINDOW must be a live window and defaults to the selected one.
1246 For a nonselected window, this is the value point would have
1247 if that window were selected.
1249 Note that, when WINDOW is the selected window and its buffer
1250 is also currently selected, the value returned is the same as (point).
1251 It would be more strictly correct to return the `top-level' value
1252 of point, outside of any save-excursion forms.
1253 But that is hard to define. */)
1254 (Lisp_Object window
)
1256 register struct window
*w
= decode_window (window
);
1258 if (w
== XWINDOW (selected_window
)
1259 && current_buffer
== XBUFFER (w
->buffer
))
1261 return Fmarker_position (w
->pointm
);
1264 DEFUN ("window-start", Fwindow_start
, Swindow_start
, 0, 1, 0,
1265 doc
: /* Return position at which display currently starts in WINDOW.
1266 WINDOW must be a live window and defaults to the selected one.
1267 This is updated by redisplay or by calling `set-window-start'. */)
1268 (Lisp_Object window
)
1270 return Fmarker_position (decode_window (window
)->start
);
1273 /* This is text temporarily removed from the doc string below.
1275 This function returns nil if the position is not currently known.
1276 That happens when redisplay is preempted and doesn't finish.
1277 If in that case you want to compute where the end of the window would
1278 have been if redisplay had finished, do this:
1280 (goto-char (window-start window))
1281 (vertical-motion (1- (window-height window)) window)
1284 DEFUN ("window-end", Fwindow_end
, Swindow_end
, 0, 2, 0,
1285 doc
: /* Return position at which display currently ends in WINDOW.
1286 WINDOW must be a live window and defaults to the selected one.
1287 This is updated by redisplay, when it runs to completion.
1288 Simply changing the buffer text or setting `window-start'
1289 does not update this value.
1290 Return nil if there is no recorded value. (This can happen if the
1291 last redisplay of WINDOW was preempted, and did not finish.)
1292 If UPDATE is non-nil, compute the up-to-date position
1293 if it isn't already recorded. */)
1294 (Lisp_Object window
, Lisp_Object update
)
1297 struct window
*w
= decode_window (window
);
1305 #if 0 /* This change broke some things. We should make it later. */
1306 /* If we don't know the end position, return nil.
1307 The user can compute it with vertical-motion if he wants to.
1308 It would be nicer to do it automatically,
1309 but that's so slow that it would probably bother people. */
1310 if (NILP (w
->window_end_valid
))
1315 && ! (! NILP (w
->window_end_valid
)
1316 && XFASTINT (w
->last_modified
) >= BUF_MODIFF (b
)
1317 && XFASTINT (w
->last_overlay_modified
) >= BUF_OVERLAY_MODIFF (b
))
1320 struct text_pos startp
;
1322 struct buffer
*old_buffer
= NULL
;
1323 void *itdata
= NULL
;
1325 /* Cannot use Fvertical_motion because that function doesn't
1326 cope with variable-height lines. */
1327 if (b
!= current_buffer
)
1329 old_buffer
= current_buffer
;
1330 set_buffer_internal (b
);
1333 /* In case W->start is out of the range, use something
1334 reasonable. This situation occurred when loading a file with
1335 `-l' containing a call to `rmail' with subsequent other
1336 commands. At the end, W->start happened to be BEG, while
1337 rmail had already narrowed the buffer. */
1338 if (XMARKER (w
->start
)->charpos
< BEGV
)
1339 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
1340 else if (XMARKER (w
->start
)->charpos
> ZV
)
1341 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
1343 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
1345 itdata
= bidi_shelve_cache ();
1346 start_display (&it
, w
, startp
);
1347 move_it_vertically (&it
, window_box_height (w
));
1348 if (it
.current_y
< it
.last_visible_y
)
1349 move_it_past_eol (&it
);
1350 value
= make_number (IT_CHARPOS (it
));
1351 bidi_unshelve_cache (itdata
, 0);
1354 set_buffer_internal (old_buffer
);
1357 XSETINT (value
, BUF_Z (b
) - XFASTINT (w
->window_end_pos
));
1362 DEFUN ("set-window-point", Fset_window_point
, Sset_window_point
, 2, 2, 0,
1363 doc
: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1365 (Lisp_Object window
, Lisp_Object pos
)
1367 register struct window
*w
= decode_window (window
);
1369 CHECK_NUMBER_COERCE_MARKER (pos
);
1370 if (w
== XWINDOW (selected_window
)
1371 && XBUFFER (w
->buffer
) == current_buffer
)
1374 set_marker_restricted (w
->pointm
, pos
, w
->buffer
);
1376 /* We have to make sure that redisplay updates the window to show
1377 the new value of point. */
1378 if (!EQ (window
, selected_window
))
1379 ++windows_or_buffers_changed
;
1384 DEFUN ("set-window-start", Fset_window_start
, Sset_window_start
, 2, 3, 0,
1385 doc
: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1386 If WINDOW is nil, the selected window is used. Return POS.
1387 Optional third arg NOFORCE non-nil inhibits next redisplay from
1388 overriding motion of point in order to display at this exact start. */)
1389 (Lisp_Object window
, Lisp_Object pos
, Lisp_Object noforce
)
1391 register struct window
*w
= decode_window (window
);
1393 CHECK_NUMBER_COERCE_MARKER (pos
);
1394 set_marker_restricted (w
->start
, pos
, w
->buffer
);
1395 /* this is not right, but much easier than doing what is right. */
1396 w
->start_at_line_beg
= Qnil
;
1398 w
->force_start
= Qt
;
1399 w
->update_mode_line
= Qt
;
1400 XSETFASTINT (w
->last_modified
, 0);
1401 XSETFASTINT (w
->last_overlay_modified
, 0);
1402 if (!EQ (window
, selected_window
))
1403 windows_or_buffers_changed
++;
1408 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p
,
1409 Spos_visible_in_window_p
, 0, 3, 0,
1410 doc
: /* Return non-nil if position POS is currently on the frame in WINDOW.
1411 Return nil if that position is scrolled vertically out of view.
1412 If a character is only partially visible, nil is returned, unless the
1413 optional argument PARTIALLY is non-nil.
1414 If POS is only out of view because of horizontal scrolling, return non-nil.
1415 If POS is t, it specifies the position of the last visible glyph in WINDOW.
1416 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
1418 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
1419 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
1420 where X and Y are the pixel coordinates relative to the top left corner
1421 of the window. The remaining elements are omitted if the character after
1422 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
1423 off-window at the top and bottom of the row, ROWH is the height of the
1424 display row, and VPOS is the row number (0-based) containing POS. */)
1425 (Lisp_Object pos
, Lisp_Object window
, Lisp_Object partially
)
1427 register struct window
*w
;
1428 register EMACS_INT posint
;
1429 register struct buffer
*buf
;
1430 struct text_pos top
;
1431 Lisp_Object in_window
= Qnil
;
1432 int rtop
, rbot
, rowh
, vpos
, fully_p
= 1;
1435 w
= decode_window (window
);
1436 buf
= XBUFFER (w
->buffer
);
1437 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1441 else if (!NILP (pos
))
1443 CHECK_NUMBER_COERCE_MARKER (pos
);
1444 posint
= XINT (pos
);
1446 else if (w
== XWINDOW (selected_window
))
1449 posint
= XMARKER (w
->pointm
)->charpos
;
1451 /* If position is above window start or outside buffer boundaries,
1452 or if window start is out of range, position is not visible. */
1454 || (posint
>= CHARPOS (top
) && posint
<= BUF_ZV (buf
)))
1455 && CHARPOS (top
) >= BUF_BEGV (buf
)
1456 && CHARPOS (top
) <= BUF_ZV (buf
)
1457 && pos_visible_p (w
, posint
, &x
, &y
, &rtop
, &rbot
, &rowh
, &vpos
)
1458 && (fully_p
= !rtop
&& !rbot
, (!NILP (partially
) || fully_p
)))
1461 if (!NILP (in_window
) && !NILP (partially
))
1463 Lisp_Object part
= Qnil
;
1465 part
= list4 (make_number (rtop
), make_number (rbot
),
1466 make_number (rowh
), make_number (vpos
));
1467 in_window
= Fcons (make_number (x
),
1468 Fcons (make_number (y
), part
));
1474 DEFUN ("window-line-height", Fwindow_line_height
,
1475 Swindow_line_height
, 0, 2, 0,
1476 doc
: /* Return height in pixels of text line LINE in window WINDOW.
1477 WINDOW defaults to the selected window.
1479 Return height of current line if LINE is omitted or nil. Return height of
1480 header or mode line if LINE is `header-line' or `mode-line'.
1481 Otherwise, LINE is a text line number starting from 0. A negative number
1482 counts from the end of the window.
1484 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
1485 in pixels of the visible part of the line, VPOS and YPOS are the
1486 vertical position in lines and pixels of the line, relative to the top
1487 of the first text line, and OFFBOT is the number of off-window pixels at
1488 the bottom of the text line. If there are off-window pixels at the top
1489 of the (first) text line, YPOS is negative.
1491 Return nil if window display is not up-to-date. In that case, use
1492 `pos-visible-in-window-p' to obtain the information. */)
1493 (Lisp_Object line
, Lisp_Object window
)
1495 register struct window
*w
;
1496 register struct buffer
*b
;
1497 struct glyph_row
*row
, *end_row
;
1501 w
= decode_window (window
);
1503 if (noninteractive
|| w
->pseudo_window_p
)
1506 CHECK_BUFFER (w
->buffer
);
1507 b
= XBUFFER (w
->buffer
);
1509 /* Fail if current matrix is not up-to-date. */
1510 if (NILP (w
->window_end_valid
)
1511 || current_buffer
->clip_changed
1512 || current_buffer
->prevent_redisplay_optimizations_p
1513 || XFASTINT (w
->last_modified
) < BUF_MODIFF (b
)
1514 || XFASTINT (w
->last_overlay_modified
) < BUF_OVERLAY_MODIFF (b
))
1520 if (i
< 0 || i
>= w
->current_matrix
->nrows
1521 || (row
= MATRIX_ROW (w
->current_matrix
, i
), !row
->enabled_p
))
1523 max_y
= window_text_bottom_y (w
);
1527 if (EQ (line
, Qheader_line
))
1529 if (!WINDOW_WANTS_HEADER_LINE_P (w
))
1531 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
1532 if (!row
->enabled_p
)
1534 return list4 (make_number (row
->height
),
1535 make_number (0), make_number (0),
1539 if (EQ (line
, Qmode_line
))
1541 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
1542 if (!row
->enabled_p
)
1544 return list4 (make_number (row
->height
),
1545 make_number (0), /* not accurate */
1546 make_number (WINDOW_HEADER_LINE_HEIGHT (w
)
1547 + window_text_bottom_y (w
)),
1551 CHECK_NUMBER (line
);
1554 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1555 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
1556 max_y
= window_text_bottom_y (w
);
1559 while ((n
< 0 || i
< n
)
1560 && row
<= end_row
&& row
->enabled_p
1561 && row
->y
+ row
->height
< max_y
)
1564 if (row
> end_row
|| !row
->enabled_p
)
1576 crop
= max (0, (row
->y
+ row
->height
) - max_y
);
1577 return list4 (make_number (row
->height
+ min (0, row
->y
) - crop
),
1579 make_number (row
->y
),
1580 make_number (crop
));
1583 DEFUN ("window-dedicated-p", Fwindow_dedicated_p
, Swindow_dedicated_p
,
1585 doc
: /* Return non-nil when WINDOW is dedicated to its buffer.
1586 More precisely, return the value assigned by the last call of
1587 `set-window-dedicated-p' for WINDOW. Return nil if that function was
1588 never called with WINDOW as its argument, or the value set by that
1589 function was internally reset since its last call. WINDOW defaults to
1590 the selected window.
1592 When a window is dedicated to its buffer, `display-buffer' will refrain
1593 from displaying another buffer in it. `get-lru-window' and
1594 `get-largest-window' treat dedicated windows specially.
1595 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1596 `kill-buffer' can delete a dedicated window and the containing frame.
1598 Functions like `set-window-buffer' may change the buffer displayed by a
1599 window, unless that window is "strongly" dedicated to its buffer, that
1600 is the value returned by `window-dedicated-p' is t. */)
1601 (Lisp_Object window
)
1603 return decode_window (window
)->dedicated
;
1606 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p
,
1607 Sset_window_dedicated_p
, 2, 2, 0,
1608 doc
: /* Mark WINDOW as dedicated according to FLAG.
1609 WINDOW must be a live window and defaults to the selected one. FLAG
1610 non-nil means mark WINDOW as dedicated to its buffer. FLAG nil means
1611 mark WINDOW as non-dedicated. Return FLAG.
1613 When a window is dedicated to its buffer, `display-buffer' will refrain
1614 from displaying another buffer in it. `get-lru-window' and
1615 `get-largest-window' treat dedicated windows specially.
1616 `delete-windows-on', `replace-buffer-in-windows', `quit-window',
1617 `quit-restore-window' and `kill-buffer' can delete a dedicated window
1618 and the containing frame.
1620 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
1621 its buffer. Functions like `set-window-buffer' may change the buffer
1622 displayed by a window, unless that window is strongly dedicated to its
1623 buffer. If and when `set-window-buffer' displays another buffer in a
1624 window, it also makes sure that the window is no more dedicated. */)
1625 (Lisp_Object window
, Lisp_Object flag
)
1627 register struct window
*w
= decode_window (window
);
1629 w
->dedicated
= flag
;
1630 return w
->dedicated
;
1633 DEFUN ("window-prev-buffers", Fwindow_prev_buffers
, Swindow_prev_buffers
,
1635 doc
: /* Return buffers previously shown in WINDOW.
1636 WINDOW must be a live window and defaults to the selected one.
1638 The return value is a list of elements (BUFFER WINDOW-START POS),
1639 where BUFFER is a buffer, WINDOW-START is the start position of the
1640 window for that buffer, and POS is a window-specific point value. */)
1641 (Lisp_Object window
)
1643 return decode_window (window
)->prev_buffers
;
1646 DEFUN ("set-window-prev-buffers", Fset_window_prev_buffers
,
1647 Sset_window_prev_buffers
, 2, 2, 0,
1648 doc
: /* Set WINDOW's previous buffers to PREV-BUFFERS.
1649 WINDOW must be a live window and defaults to the selected one.
1651 PREV-BUFFERS should be a list of elements (BUFFER WINDOW-START POS),
1652 where BUFFER is a buffer, WINDOW-START is the start position of the
1653 window for that buffer, and POS is a window-specific point value. */)
1654 (Lisp_Object window
, Lisp_Object prev_buffers
)
1656 return decode_window (window
)->prev_buffers
= prev_buffers
;
1659 DEFUN ("window-next-buffers", Fwindow_next_buffers
, Swindow_next_buffers
,
1661 doc
: /* Return list of buffers recently re-shown in WINDOW.
1662 WINDOW must be a live window and defaults to the selected one. */)
1663 (Lisp_Object window
)
1665 return decode_window (window
)->next_buffers
;
1668 DEFUN ("set-window-next-buffers", Fset_window_next_buffers
,
1669 Sset_window_next_buffers
, 2, 2, 0,
1670 doc
: /* Set WINDOW's next buffers to NEXT-BUFFERS.
1671 WINDOW must be a live window and defaults to the selected one.
1672 NEXT-BUFFERS should be a list of buffers. */)
1673 (Lisp_Object window
, Lisp_Object next_buffers
)
1675 return decode_window (window
)->next_buffers
= next_buffers
;
1678 DEFUN ("window-parameters", Fwindow_parameters
, Swindow_parameters
,
1680 doc
: /* Return the parameters of WINDOW and their values.
1681 WINDOW defaults to the selected window. The return value is a list of
1682 elements of the form (PARAMETER . VALUE). */)
1683 (Lisp_Object window
)
1685 return Fcopy_alist (decode_any_window (window
)->window_parameters
);
1688 DEFUN ("window-parameter", Fwindow_parameter
, Swindow_parameter
,
1690 doc
: /* Return WINDOW's value for PARAMETER.
1691 WINDOW defaults to the selected window. */)
1692 (Lisp_Object window
, Lisp_Object parameter
)
1696 result
= Fassq (parameter
, decode_any_window (window
)->window_parameters
);
1697 return CDR_SAFE (result
);
1700 DEFUN ("set-window-parameter", Fset_window_parameter
,
1701 Sset_window_parameter
, 3, 3, 0,
1702 doc
: /* Set WINDOW's value of PARAMETER to VALUE.
1703 WINDOW defaults to the selected window. Return VALUE. */)
1704 (Lisp_Object window
, Lisp_Object parameter
, Lisp_Object value
)
1706 register struct window
*w
= decode_any_window (window
);
1707 Lisp_Object old_alist_elt
;
1709 old_alist_elt
= Fassq (parameter
, w
->window_parameters
);
1710 if (NILP (old_alist_elt
))
1711 w
->window_parameters
= Fcons (Fcons (parameter
, value
), w
->window_parameters
);
1713 Fsetcdr (old_alist_elt
, value
);
1717 DEFUN ("window-display-table", Fwindow_display_table
, Swindow_display_table
,
1719 doc
: /* Return the display-table that WINDOW is using.
1720 WINDOW defaults to the selected window. */)
1721 (Lisp_Object window
)
1723 return decode_window (window
)->display_table
;
1726 /* Get the display table for use on window W. This is either W's
1727 display table or W's buffer's display table. Ignore the specified
1728 tables if they are not valid; if no valid table is specified,
1731 struct Lisp_Char_Table
*
1732 window_display_table (struct window
*w
)
1734 struct Lisp_Char_Table
*dp
= NULL
;
1736 if (DISP_TABLE_P (w
->display_table
))
1737 dp
= XCHAR_TABLE (w
->display_table
);
1738 else if (BUFFERP (w
->buffer
))
1740 struct buffer
*b
= XBUFFER (w
->buffer
);
1742 if (DISP_TABLE_P (BVAR (b
, display_table
)))
1743 dp
= XCHAR_TABLE (BVAR (b
, display_table
));
1744 else if (DISP_TABLE_P (Vstandard_display_table
))
1745 dp
= XCHAR_TABLE (Vstandard_display_table
);
1751 DEFUN ("set-window-display-table", Fset_window_display_table
, Sset_window_display_table
, 2, 2, 0,
1752 doc
: /* Set WINDOW's display-table to TABLE. */)
1753 (register Lisp_Object window
, Lisp_Object table
)
1755 register struct window
*w
;
1757 w
= decode_window (window
);
1758 w
->display_table
= table
;
1762 /* Record info on buffer window W is displaying
1763 when it is about to cease to display that buffer. */
1765 unshow_buffer (register struct window
*w
)
1772 if (b
!= XMARKER (w
->pointm
)->buffer
)
1776 if (w
== XWINDOW (selected_window
)
1777 || ! EQ (buf
, XWINDOW (selected_window
)->buffer
))
1778 /* Do this except when the selected window's buffer
1779 is being removed from some other window. */
1781 /* last_window_start records the start position that this buffer
1782 had in the last window to be disconnected from it.
1783 Now that this statement is unconditional,
1784 it is possible for the buffer to be displayed in the
1785 selected window, while last_window_start reflects another
1786 window which was recently showing the same buffer.
1787 Some people might say that might be a good thing. Let's see. */
1788 b
->last_window_start
= marker_position (w
->start
);
1790 /* Point in the selected window's buffer
1791 is actually stored in that buffer, and the window's pointm isn't used.
1792 So don't clobber point in that buffer. */
1793 if (! EQ (buf
, XWINDOW (selected_window
)->buffer
)
1794 /* This line helps to fix Horsley's testbug.el bug. */
1795 && !(WINDOWP (BVAR (b
, last_selected_window
))
1796 && w
!= XWINDOW (BVAR (b
, last_selected_window
))
1797 && EQ (buf
, XWINDOW (BVAR (b
, last_selected_window
))->buffer
)))
1798 temp_set_point_both (b
,
1799 clip_to_bounds (BUF_BEGV (b
),
1800 XMARKER (w
->pointm
)->charpos
,
1802 clip_to_bounds (BUF_BEGV_BYTE (b
),
1803 marker_byte_position (w
->pointm
),
1806 if (WINDOWP (BVAR (b
, last_selected_window
))
1807 && w
== XWINDOW (BVAR (b
, last_selected_window
)))
1808 BVAR (b
, last_selected_window
) = Qnil
;
1811 /* Put NEW into the window structure in place of OLD. SETFLAG zero
1812 means change window structure only. Otherwise store geometry and
1813 other settings as well. */
1815 replace_window (Lisp_Object old
, Lisp_Object
new, int setflag
)
1817 register Lisp_Object tem
;
1818 register struct window
*o
= XWINDOW (old
), *n
= XWINDOW (new);
1820 /* If OLD is its frame's root window, then NEW is the new
1821 root window for that frame. */
1822 if (EQ (old
, FRAME_ROOT_WINDOW (XFRAME (o
->frame
))))
1823 FRAME_ROOT_WINDOW (XFRAME (o
->frame
)) = new;
1827 n
->left_col
= o
->left_col
;
1828 n
->top_line
= o
->top_line
;
1829 n
->total_cols
= o
->total_cols
;
1830 n
->total_lines
= o
->total_lines
;
1831 n
->normal_cols
= o
->normal_cols
;
1832 o
->normal_cols
= make_float (1.0);
1833 n
->normal_lines
= o
->normal_lines
;
1834 o
->normal_lines
= make_float (1.0);
1835 n
->desired_matrix
= n
->current_matrix
= 0;
1837 memset (&n
->cursor
, 0, sizeof (n
->cursor
));
1838 memset (&n
->last_cursor
, 0, sizeof (n
->last_cursor
));
1839 memset (&n
->phys_cursor
, 0, sizeof (n
->phys_cursor
));
1840 n
->phys_cursor_type
= -1;
1841 n
->phys_cursor_width
= -1;
1842 n
->must_be_updated_p
= 0;
1843 n
->pseudo_window_p
= 0;
1844 XSETFASTINT (n
->window_end_vpos
, 0);
1845 XSETFASTINT (n
->window_end_pos
, 0);
1846 n
->window_end_valid
= Qnil
;
1847 n
->frozen_window_start_p
= 0;
1850 n
->next
= tem
= o
->next
;
1852 XWINDOW (tem
)->prev
= new;
1854 n
->prev
= tem
= o
->prev
;
1856 XWINDOW (tem
)->next
= new;
1858 n
->parent
= tem
= o
->parent
;
1861 if (EQ (XWINDOW (tem
)->vchild
, old
))
1862 XWINDOW (tem
)->vchild
= new;
1863 if (EQ (XWINDOW (tem
)->hchild
, old
))
1864 XWINDOW (tem
)->hchild
= new;
1868 /* If window WINDOW and its parent window are iso-combined, merge
1869 WINDOW's children into those of its parent window and mark WINDOW as
1873 recombine_windows (Lisp_Object window
)
1875 struct window
*w
, *p
, *c
;
1876 Lisp_Object parent
, child
;
1879 w
= XWINDOW (window
);
1881 if (!NILP (parent
) && NILP (w
->combination_limit
))
1883 p
= XWINDOW (parent
);
1884 if (((!NILP (p
->vchild
) && !NILP (w
->vchild
))
1885 || (!NILP (p
->hchild
) && !NILP (w
->hchild
))))
1886 /* WINDOW and PARENT are both either a vertical or a horizontal
1889 horflag
= NILP (w
->vchild
);
1890 child
= horflag
? w
->hchild
: w
->vchild
;
1891 c
= XWINDOW (child
);
1893 /* Splice WINDOW's children into its parent's children and
1894 assign new normal sizes. */
1903 XWINDOW (w
->prev
)->next
= child
;
1912 = make_float (XFLOATINT (c
->total_cols
)
1913 / XFLOATINT (p
->total_cols
));
1916 = make_float (XFLOATINT (c
->total_lines
)
1917 / XFLOATINT (p
->total_lines
));
1921 if (!NILP (w
->next
))
1924 XWINDOW (c
->next
)->prev
= child
;
1932 c
= XWINDOW (child
);
1936 /* WINDOW can be deleted now. */
1937 w
->vchild
= w
->hchild
= Qnil
;
1942 /* If WINDOW can be deleted, delete it. */
1944 delete_deletable_window (Lisp_Object window
)
1946 if (!NILP (call1 (Qwindow_deletable_p
, window
)))
1947 call1 (Qdelete_window
, window
);
1950 /***********************************************************************
1952 ***********************************************************************/
1954 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1955 pointer. This is a callback function for foreach_window, used in
1956 the window_list function. */
1959 add_window_to_list (struct window
*w
, void *user_data
)
1961 Lisp_Object
*list
= (Lisp_Object
*) user_data
;
1963 XSETWINDOW (window
, w
);
1964 *list
= Fcons (window
, *list
);
1969 /* Return a list of all windows, for use by next_window. If
1970 Vwindow_list is a list, return that list. Otherwise, build a new
1971 list, cache it in Vwindow_list, and return that. */
1976 if (!CONSP (Vwindow_list
))
1980 Vwindow_list
= Qnil
;
1981 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
1983 Lisp_Object args
[2];
1985 /* We are visiting windows in canonical order, and add
1986 new windows at the front of args[1], which means we
1987 have to reverse this list at the end. */
1989 foreach_window (XFRAME (XCAR (tail
)), add_window_to_list
, &args
[1]);
1990 args
[0] = Vwindow_list
;
1991 args
[1] = Fnreverse (args
[1]);
1992 Vwindow_list
= Fnconc (2, args
);
1996 return Vwindow_list
;
2000 /* Value is non-zero if WINDOW satisfies the constraints given by
2001 OWINDOW, MINIBUF and ALL_FRAMES.
2003 MINIBUF t means WINDOW may be minibuffer windows.
2004 `lambda' means WINDOW may not be a minibuffer window.
2005 a window means a specific minibuffer window
2007 ALL_FRAMES t means search all frames,
2008 nil means search just current frame,
2009 `visible' means search just visible frames on the
2011 0 means search visible and iconified frames on the
2013 a window means search the frame that window belongs to,
2014 a frame means consider windows on that frame, only. */
2017 candidate_window_p (Lisp_Object window
, Lisp_Object owindow
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2019 struct window
*w
= XWINDOW (window
);
2020 struct frame
*f
= XFRAME (w
->frame
);
2021 int candidate_p
= 1;
2023 if (!BUFFERP (w
->buffer
))
2025 else if (MINI_WINDOW_P (w
)
2026 && (EQ (minibuf
, Qlambda
)
2027 || (WINDOWP (minibuf
) && !EQ (minibuf
, window
))))
2029 /* If MINIBUF is `lambda' don't consider any mini-windows.
2030 If it is a window, consider only that one. */
2033 else if (EQ (all_frames
, Qt
))
2035 else if (NILP (all_frames
))
2037 xassert (WINDOWP (owindow
));
2038 candidate_p
= EQ (w
->frame
, XWINDOW (owindow
)->frame
);
2040 else if (EQ (all_frames
, Qvisible
))
2042 FRAME_SAMPLE_VISIBILITY (f
);
2043 candidate_p
= FRAME_VISIBLE_P (f
)
2044 && (FRAME_TERMINAL (XFRAME (w
->frame
))
2045 == FRAME_TERMINAL (XFRAME (selected_frame
)));
2048 else if (INTEGERP (all_frames
) && XINT (all_frames
) == 0)
2050 FRAME_SAMPLE_VISIBILITY (f
);
2051 candidate_p
= (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)
2052 #ifdef HAVE_X_WINDOWS
2053 /* Yuck!! If we've just created the frame and the
2054 window-manager requested the user to place it
2055 manually, the window may still not be considered
2056 `visible'. I'd argue it should be at least
2057 something like `iconified', but don't know how to do
2059 || (FRAME_X_P (f
) && f
->output_data
.x
->asked_for_visible
2060 && !f
->output_data
.x
->has_been_visible
)
2063 && (FRAME_TERMINAL (XFRAME (w
->frame
))
2064 == FRAME_TERMINAL (XFRAME (selected_frame
)));
2066 else if (WINDOWP (all_frames
))
2067 candidate_p
= (EQ (FRAME_MINIBUF_WINDOW (f
), all_frames
)
2068 || EQ (XWINDOW (all_frames
)->frame
, w
->frame
)
2069 || EQ (XWINDOW (all_frames
)->frame
, FRAME_FOCUS_FRAME (f
)));
2070 else if (FRAMEP (all_frames
))
2071 candidate_p
= EQ (all_frames
, w
->frame
);
2077 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
2078 Fwindow_list. See candidate_window_p for the meaning of WINDOW,
2079 MINIBUF, and ALL_FRAMES. */
2082 decode_next_window_args (Lisp_Object
*window
, Lisp_Object
*minibuf
, Lisp_Object
*all_frames
)
2085 *window
= selected_window
;
2087 CHECK_LIVE_WINDOW (*window
);
2089 /* MINIBUF nil may or may not include minibuffers. Decide if it
2091 if (NILP (*minibuf
))
2092 *minibuf
= minibuf_level
? minibuf_window
: Qlambda
;
2093 else if (!EQ (*minibuf
, Qt
))
2096 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
2097 => count none of them, or a specific minibuffer window (the
2098 active one) to count. */
2100 /* ALL_FRAMES nil doesn't specify which frames to include. */
2101 if (NILP (*all_frames
))
2102 *all_frames
= (!EQ (*minibuf
, Qlambda
)
2103 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window
)->frame
))
2105 else if (EQ (*all_frames
, Qvisible
))
2107 else if (EQ (*all_frames
, make_number (0)))
2109 else if (FRAMEP (*all_frames
))
2111 else if (!EQ (*all_frames
, Qt
))
2116 /* Return the next or previous window of WINDOW in cyclic ordering
2117 of windows. NEXT_P non-zero means return the next window. See the
2118 documentation string of next-window for the meaning of MINIBUF and
2122 next_window (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
, int next_p
)
2124 decode_next_window_args (&window
, &minibuf
, &all_frames
);
2126 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
2127 return the first window on the frame. */
2128 if (FRAMEP (all_frames
)
2129 && !EQ (all_frames
, XWINDOW (window
)->frame
))
2130 return Fframe_first_window (all_frames
);
2136 /* Find WINDOW in the list of all windows. */
2137 list
= Fmemq (window
, window_list ());
2139 /* Scan forward from WINDOW to the end of the window list. */
2141 for (list
= XCDR (list
); CONSP (list
); list
= XCDR (list
))
2142 if (candidate_window_p (XCAR (list
), window
, minibuf
, all_frames
))
2145 /* Scan from the start of the window list up to WINDOW. */
2147 for (list
= Vwindow_list
;
2148 CONSP (list
) && !EQ (XCAR (list
), window
);
2150 if (candidate_window_p (XCAR (list
), window
, minibuf
, all_frames
))
2154 window
= XCAR (list
);
2158 Lisp_Object candidate
, list
;
2160 /* Scan through the list of windows for candidates. If there are
2161 candidate windows in front of WINDOW, the last one of these
2162 is the one we want. If there are candidates following WINDOW
2163 in the list, again the last one of these is the one we want. */
2165 for (list
= window_list (); CONSP (list
); list
= XCDR (list
))
2167 if (EQ (XCAR (list
), window
))
2169 if (WINDOWP (candidate
))
2172 else if (candidate_window_p (XCAR (list
), window
, minibuf
,
2174 candidate
= XCAR (list
);
2177 if (WINDOWP (candidate
))
2185 DEFUN ("next-window", Fnext_window
, Snext_window
, 0, 3, 0,
2186 doc
: /* Return live window after WINDOW in the cyclic ordering of windows.
2187 WINDOW must be a live window and defaults to the selected one. The
2188 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2191 MINIBUF nil or omitted means consider the minibuffer window only if the
2192 minibuffer is active. MINIBUF t means consider the minibuffer window
2193 even if the minibuffer is not active. Any other value means do not
2194 consider the minibuffer window even if the minibuffer is active.
2196 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2197 plus the minibuffer window if specified by the MINIBUF argument. If the
2198 minibuffer counts, consider all windows on all frames that share that
2199 minibuffer too. The following non-nil values of ALL-FRAMES have special
2202 - t means consider all windows on all existing frames.
2204 - `visible' means consider all windows on all visible frames.
2206 - 0 (the number zero) means consider all windows on all visible and
2209 - A frame means consider all windows on that frame only.
2211 Anything else means consider all windows on WINDOW's frame and no
2214 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2215 `next-window' to iterate through the entire cycle of acceptable
2216 windows, eventually ending up back at the window you started with.
2217 `previous-window' traverses the same cycle, in the reverse order. */)
2218 (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2220 return next_window (window
, minibuf
, all_frames
, 1);
2224 DEFUN ("previous-window", Fprevious_window
, Sprevious_window
, 0, 3, 0,
2225 doc
: /* Return live window before WINDOW in the cyclic ordering of windows.
2226 WINDOW must be a live window and defaults to the selected one. The
2227 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2230 MINIBUF nil or omitted means consider the minibuffer window only if the
2231 minibuffer is active. MINIBUF t means consider the minibuffer window
2232 even if the minibuffer is not active. Any other value means do not
2233 consider the minibuffer window even if the minibuffer is active.
2235 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2236 plus the minibuffer window if specified by the MINIBUF argument. If the
2237 minibuffer counts, consider all windows on all frames that share that
2238 minibuffer too. The following non-nil values of ALL-FRAMES have special
2241 - t means consider all windows on all existing frames.
2243 - `visible' means consider all windows on all visible frames.
2245 - 0 (the number zero) means consider all windows on all visible and
2248 - A frame means consider all windows on that frame only.
2250 Anything else means consider all windows on WINDOW's frame and no
2253 If you use consistent values for MINIBUF and ALL-FRAMES, you can
2254 use `previous-window' to iterate through the entire cycle of
2255 acceptable windows, eventually ending up back at the window you
2256 started with. `next-window' traverses the same cycle, in the
2258 (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2260 return next_window (window
, minibuf
, all_frames
, 0);
2264 /* Return a list of windows in cyclic ordering. Arguments are like
2265 for `next-window'. */
2268 window_list_1 (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2270 Lisp_Object tail
, list
, rest
;
2272 decode_next_window_args (&window
, &minibuf
, &all_frames
);
2275 for (tail
= window_list (); CONSP (tail
); tail
= XCDR (tail
))
2276 if (candidate_window_p (XCAR (tail
), window
, minibuf
, all_frames
))
2277 list
= Fcons (XCAR (tail
), list
);
2279 /* Rotate the list to start with WINDOW. */
2280 list
= Fnreverse (list
);
2281 rest
= Fmemq (window
, list
);
2282 if (!NILP (rest
) && !EQ (rest
, list
))
2284 for (tail
= list
; !EQ (XCDR (tail
), rest
); tail
= XCDR (tail
))
2286 XSETCDR (tail
, Qnil
);
2287 list
= nconc2 (rest
, list
);
2293 DEFUN ("window-list", Fwindow_list
, Swindow_list
, 0, 3, 0,
2294 doc
: /* Return a list of windows on FRAME, starting with WINDOW.
2295 FRAME nil or omitted means use the selected frame.
2296 WINDOW nil or omitted means use the window selected within FRAME.
2297 MINIBUF t means include the minibuffer window, even if it isn't active.
2298 MINIBUF nil or omitted means include the minibuffer window only
2300 MINIBUF neither nil nor t means never include the minibuffer window. */)
2301 (Lisp_Object frame
, Lisp_Object minibuf
, Lisp_Object window
)
2304 window
= FRAMEP (frame
) ? XFRAME (frame
)->selected_window
: selected_window
;
2305 CHECK_WINDOW (window
);
2307 frame
= selected_frame
;
2309 if (!EQ (frame
, XWINDOW (window
)->frame
))
2310 error ("Window is on a different frame");
2312 return window_list_1 (window
, minibuf
, frame
);
2316 DEFUN ("window-list-1", Fwindow_list_1
, Swindow_list_1
, 0, 3, 0,
2317 doc
: /* Return a list of all live windows.
2318 WINDOW specifies the first window to list and defaults to the selected
2321 Optional argument MINIBUF nil or omitted means consider the minibuffer
2322 window only if the minibuffer is active. MINIBUF t means consider the
2323 minibuffer window even if the minibuffer is not active. Any other value
2324 means do not consider the minibuffer window even if the minibuffer is
2327 Optional argument ALL-FRAMES nil or omitted means consider all windows
2328 on WINDOW's frame, plus the minibuffer window if specified by the
2329 MINIBUF argument. If the minibuffer counts, consider all windows on all
2330 frames that share that minibuffer too. The following non-nil values of
2331 ALL-FRAMES have special meanings:
2333 - t means consider all windows on all existing frames.
2335 - `visible' means consider all windows on all visible frames.
2337 - 0 (the number zero) means consider all windows on all visible and
2340 - A frame means consider all windows on that frame only.
2342 Anything else means consider all windows on WINDOW's frame and no
2345 If WINDOW is not on the list of windows returned, some other window will
2346 be listed first but no error is signaled. */)
2347 (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2349 return window_list_1 (window
, minibuf
, all_frames
);
2352 /* Look at all windows, performing an operation specified by TYPE
2354 If FRAMES is Qt, look at all frames;
2355 Qnil, look at just the selected frame;
2356 Qvisible, look at visible frames;
2357 a frame, just look at windows on that frame.
2358 If MINI is non-zero, perform the operation on minibuffer windows too. */
2363 GET_BUFFER_WINDOW
, /* Arg is buffer */
2364 REPLACE_BUFFER_IN_WINDOWS_SAFELY
, /* Arg is buffer */
2365 REDISPLAY_BUFFER_WINDOWS
, /* Arg is buffer */
2370 window_loop (enum window_loop type
, Lisp_Object obj
, int mini
, Lisp_Object frames
)
2372 Lisp_Object window
, windows
, best_window
, frame_arg
;
2373 int frame_best_window_flag
= 0;
2375 struct gcpro gcpro1
;
2377 /* If we're only looping through windows on a particular frame,
2378 frame points to that frame. If we're looping through windows
2379 on all frames, frame is 0. */
2380 if (FRAMEP (frames
))
2381 f
= XFRAME (frames
);
2382 else if (NILP (frames
))
2383 f
= SELECTED_FRAME ();
2388 frame_arg
= Qlambda
;
2389 else if (EQ (frames
, make_number (0)))
2391 else if (EQ (frames
, Qvisible
))
2396 /* frame_arg is Qlambda to stick to one frame,
2397 Qvisible to consider all visible frames,
2400 /* Pick a window to start with. */
2404 window
= FRAME_SELECTED_WINDOW (f
);
2406 window
= FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2408 windows
= window_list_1 (window
, mini
? Qt
: Qnil
, frame_arg
);
2412 for (; CONSP (windows
); windows
= XCDR (windows
))
2416 window
= XCAR (windows
);
2417 w
= XWINDOW (window
);
2419 /* Note that we do not pay attention here to whether the frame
2420 is visible, since Fwindow_list skips non-visible frames if
2421 that is desired, under the control of frame_arg. */
2422 if (!MINI_WINDOW_P (w
)
2423 /* For REPLACE_BUFFER_IN_WINDOWS_SAFELY, we must always
2424 consider all windows. */
2425 || type
== REPLACE_BUFFER_IN_WINDOWS_SAFELY
2426 || (mini
&& minibuf_level
> 0))
2429 case GET_BUFFER_WINDOW
:
2430 if (EQ (w
->buffer
, obj
)
2431 /* Don't find any minibuffer window except the one that
2432 is currently in use. */
2433 && (MINI_WINDOW_P (w
) ? EQ (window
, minibuf_window
) : 1))
2435 if (EQ (window
, selected_window
))
2436 /* Preferably return the selected window. */
2437 RETURN_UNGCPRO (window
);
2438 else if (EQ (XWINDOW (window
)->frame
, selected_frame
)
2439 && !frame_best_window_flag
)
2440 /* Prefer windows on the current frame (but don't
2441 choose another one if we have one already). */
2443 best_window
= window
;
2444 frame_best_window_flag
= 1;
2446 else if (NILP (best_window
))
2447 best_window
= window
;
2451 case REPLACE_BUFFER_IN_WINDOWS_SAFELY
:
2452 /* We could simply check whether the buffer shown by window
2453 is live, and show another buffer in case it isn't. */
2454 if (EQ (w
->buffer
, obj
))
2456 /* Undedicate WINDOW. */
2457 w
->dedicated
= Qnil
;
2458 /* Make WINDOW show the buffer returned by
2459 other_buffer_safely, don't run any hooks. */
2461 (window
, other_buffer_safely (w
->buffer
), 0, 0);
2462 /* If WINDOW is the selected window, make its buffer
2463 current. But do so only if the window shows the
2464 current buffer (Bug#6454). */
2465 if (EQ (window
, selected_window
)
2466 && XBUFFER (w
->buffer
) == current_buffer
)
2467 Fset_buffer (w
->buffer
);
2471 case REDISPLAY_BUFFER_WINDOWS
:
2472 if (EQ (w
->buffer
, obj
))
2474 mark_window_display_accurate (window
, 0);
2475 w
->update_mode_line
= Qt
;
2476 XBUFFER (obj
)->prevent_redisplay_optimizations_p
= 1;
2477 ++update_mode_lines
;
2478 best_window
= window
;
2482 /* Check for a window that has a killed buffer. */
2483 case CHECK_ALL_WINDOWS
:
2484 if (! NILP (w
->buffer
)
2485 && NILP (BVAR (XBUFFER (w
->buffer
), name
)))
2489 case WINDOW_LOOP_UNUSED
:
2498 /* Used for debugging. Abort if any window has a dead buffer. */
2500 extern void check_all_windows (void) EXTERNALLY_VISIBLE
;
2502 check_all_windows (void)
2504 window_loop (CHECK_ALL_WINDOWS
, Qnil
, 1, Qt
);
2507 DEFUN ("get-buffer-window", Fget_buffer_window
, Sget_buffer_window
, 0, 2, 0,
2508 doc
: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2509 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to
2512 The optional argument ALL-FRAMES specifies the frames to consider:
2514 - t means consider all windows on all existing frames.
2516 - `visible' means consider all windows on all visible frames.
2518 - 0 (the number zero) means consider all windows on all visible
2519 and iconified frames.
2521 - A frame means consider all windows on that frame only.
2523 Any other value of ALL-FRAMES means consider all windows on the
2524 selected frame and no others. */)
2525 (Lisp_Object buffer_or_name
, Lisp_Object all_frames
)
2529 if (NILP (buffer_or_name
))
2530 buffer
= Fcurrent_buffer ();
2532 buffer
= Fget_buffer (buffer_or_name
);
2534 if (BUFFERP (buffer
))
2535 return window_loop (GET_BUFFER_WINDOW
, buffer
, 1, all_frames
);
2541 resize_root_window (Lisp_Object window
, Lisp_Object delta
, Lisp_Object horizontal
, Lisp_Object ignore
)
2543 return call4 (Qwindow_resize_root_window
, window
, delta
, horizontal
, ignore
);
2547 DEFUN ("delete-other-windows-internal", Fdelete_other_windows_internal
,
2548 Sdelete_other_windows_internal
, 0, 2, "",
2549 doc
: /* Make WINDOW fill its frame.
2550 Only the frame WINDOW is on is affected. WINDOW may be any window and
2551 defaults to the selected one.
2553 Optional argument ROOT, if non-nil, must specify an internal window such
2554 that WINDOW is in its window subtree. If this is the case, replace ROOT
2555 by WINDOW and leave alone any windows not part of ROOT's subtree.
2557 When WINDOW is live try to reduce display jumps by keeping the text
2558 previously visible in WINDOW in the same place on the frame. Doing this
2559 depends on the value of (window-start WINDOW), so if calling this
2560 function in a program gives strange scrolling, make sure the
2561 window-start value is reasonable when this function is called. */)
2562 (Lisp_Object window
, Lisp_Object root
)
2564 struct window
*w
, *r
, *s
;
2566 Lisp_Object sibling
, pwindow
, swindow
IF_LINT (= Qnil
), delta
;
2567 ptrdiff_t startpos
IF_LINT (= 0);
2568 int top
IF_LINT (= 0), new_top
, resize_failed
;
2570 w
= decode_any_window (window
);
2571 XSETWINDOW (window
, w
);
2572 f
= XFRAME (w
->frame
);
2575 /* ROOT is the frame's root window. */
2577 root
= FRAME_ROOT_WINDOW (f
);
2581 /* ROOT must be an ancestor of WINDOW. */
2583 r
= decode_any_window (root
);
2584 pwindow
= XWINDOW (window
)->parent
;
2585 while (!NILP (pwindow
))
2586 if (EQ (pwindow
, root
))
2589 pwindow
= XWINDOW (pwindow
)->parent
;
2590 if (!EQ (pwindow
, root
))
2591 error ("Specified root is not an ancestor of specified window");
2594 if (EQ (window
, root
))
2597 /* I don't understand the "top > 0" part below. If we deal with a
2598 standalone minibuffer it would have been caught by the preceding
2600 else if (MINI_WINDOW_P (w
)) /* && top > 0) */
2601 error ("Can't expand minibuffer to full frame");
2603 if (!NILP (w
->buffer
))
2605 startpos
= marker_position (w
->start
);
2606 top
= WINDOW_TOP_EDGE_LINE (w
)
2607 - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w
)));
2608 /* Make sure WINDOW is the frame's selected window. */
2609 if (!EQ (window
, FRAME_SELECTED_WINDOW (f
)))
2611 if (EQ (selected_frame
, w
->frame
))
2612 Fselect_window (window
, Qnil
);
2614 FRAME_SELECTED_WINDOW (f
) = window
;
2619 /* See if the frame's selected window is a part of the window
2620 subtree rooted at WINDOW, by finding all the selected window's
2621 parents and comparing each one with WINDOW. If it isn't we
2622 need a new selected window for this frame. */
2623 swindow
= FRAME_SELECTED_WINDOW (f
);
2627 while (!NILP (pwindow
) && !EQ (window
, pwindow
))
2628 pwindow
= XWINDOW (pwindow
)->parent
;
2630 if (EQ (window
, pwindow
))
2631 /* If WINDOW is an ancestor of SWINDOW, then SWINDOW is ok
2632 as the new selected window. */
2635 /* Else try the previous window of SWINDOW. */
2636 swindow
= Fprevious_window (swindow
, Qlambda
, Qnil
);
2639 if (!EQ (swindow
, FRAME_SELECTED_WINDOW (f
)))
2641 if (EQ (selected_frame
, w
->frame
))
2642 Fselect_window (swindow
, Qnil
);
2644 FRAME_SELECTED_WINDOW (f
) = swindow
;
2649 free_window_matrices (r
);
2651 windows_or_buffers_changed
++;
2652 Vwindow_list
= Qnil
;
2653 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
2656 if (NILP (w
->buffer
))
2658 /* Resize child windows vertically. */
2659 XSETINT (delta
, XINT (r
->total_lines
) - XINT (w
->total_lines
));
2660 w
->top_line
= r
->top_line
;
2661 resize_root_window (window
, delta
, Qnil
, Qnil
);
2662 if (window_resize_check (w
, 0))
2663 window_resize_apply (w
, 0);
2666 resize_root_window (window
, delta
, Qnil
, Qt
);
2667 if (window_resize_check (w
, 0))
2668 window_resize_apply (w
, 0);
2673 /* Resize child windows horizontally. */
2676 w
->left_col
= r
->left_col
;
2677 XSETINT (delta
, XINT (r
->total_cols
) - XINT (w
->total_cols
));
2678 w
->left_col
= r
->left_col
;
2679 resize_root_window (window
, delta
, Qt
, Qnil
);
2680 if (window_resize_check (w
, 1))
2681 window_resize_apply (w
, 1);
2684 resize_root_window (window
, delta
, Qt
, Qt
);
2685 if (window_resize_check (w
, 1))
2686 window_resize_apply (w
, 1);
2693 /* Play safe, if we still can ... */
2696 w
= XWINDOW (window
);
2700 /* Cleanly unlink WINDOW from window-tree. */
2701 if (!NILP (w
->prev
))
2702 /* Get SIBLING above (on the left of) WINDOW. */
2705 s
= XWINDOW (sibling
);
2707 if (!NILP (s
->next
))
2708 XWINDOW (s
->next
)->prev
= sibling
;
2711 /* Get SIBLING below (on the right of) WINDOW. */
2714 s
= XWINDOW (sibling
);
2716 if (!NILP (XWINDOW (w
->parent
)->vchild
))
2717 XWINDOW (w
->parent
)->vchild
= sibling
;
2719 XWINDOW (w
->parent
)->hchild
= sibling
;
2722 /* Delete ROOT and all child windows of ROOT. */
2723 if (!NILP (r
->vchild
))
2725 delete_all_child_windows (r
->vchild
);
2728 else if (!NILP (r
->hchild
))
2730 delete_all_child_windows (r
->hchild
);
2734 replace_window (root
, window
, 1);
2736 /* This must become SWINDOW anyway ....... */
2737 if (!NILP (w
->buffer
) && !resize_failed
)
2739 /* Try to minimize scrolling, by setting the window start to the
2740 point will cause the text at the old window start to be at the
2741 same place on the frame. But don't try to do this if the
2742 window start is outside the visible portion (as might happen
2743 when the display is not current, due to typeahead). */
2744 new_top
= WINDOW_TOP_EDGE_LINE (w
) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w
)));
2746 && startpos
>= BUF_BEGV (XBUFFER (w
->buffer
))
2747 && startpos
<= BUF_ZV (XBUFFER (w
->buffer
)))
2749 struct position pos
;
2750 struct buffer
*obuf
= current_buffer
;
2752 Fset_buffer (w
->buffer
);
2753 /* This computation used to temporarily move point, but that
2754 can have unwanted side effects due to text properties. */
2755 pos
= *vmotion (startpos
, -top
, w
);
2757 set_marker_both (w
->start
, w
->buffer
, pos
.bufpos
, pos
.bytepos
);
2758 w
->window_end_valid
= Qnil
;
2759 w
->start_at_line_beg
= ((pos
.bytepos
== BEGV_BYTE
2760 || FETCH_BYTE (pos
.bytepos
- 1) == '\n') ? Qt
2762 /* We need to do this, so that the window-scroll-functions
2764 w
->optional_new_start
= Qt
;
2766 set_buffer_internal (obuf
);
2773 run_window_configuration_change_hook (f
);
2780 replace_buffer_in_windows (Lisp_Object buffer
)
2782 call1 (Qreplace_buffer_in_windows
, buffer
);
2786 /* Safely replace BUFFER with some other buffer in all windows of all
2787 frames, even those on other keyboards. */
2790 replace_buffer_in_windows_safely (Lisp_Object buffer
)
2792 Lisp_Object tail
, frame
;
2794 /* A single call to window_loop won't do the job because it only
2795 considers frames on the current keyboard. So loop manually over
2796 frames, and handle each one. */
2797 FOR_EACH_FRAME (tail
, frame
)
2798 window_loop (REPLACE_BUFFER_IN_WINDOWS_SAFELY
, buffer
, 1, frame
);
2801 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2802 minimum allowable size. */
2805 check_frame_size (FRAME_PTR frame
, int *rows
, int *cols
)
2807 /* For height, we have to see:
2808 how many windows the frame has at minimum (one or two),
2809 and whether it has a menu bar or other special stuff at the top. */
2811 = ((FRAME_MINIBUF_ONLY_P (frame
) || ! FRAME_HAS_MINIBUF_P (frame
))
2812 ? MIN_SAFE_WINDOW_HEIGHT
2813 : 2 * MIN_SAFE_WINDOW_HEIGHT
);
2815 if (FRAME_TOP_MARGIN (frame
) > 0)
2816 min_height
+= FRAME_TOP_MARGIN (frame
);
2818 if (*rows
< min_height
)
2820 if (*cols
< MIN_SAFE_WINDOW_WIDTH
)
2821 *cols
= MIN_SAFE_WINDOW_WIDTH
;
2824 /* Adjust the margins of window W if text area is too small.
2825 Return 1 if window width is ok after adjustment; 0 if window
2826 is still too narrow. */
2829 adjust_window_margins (struct window
*w
)
2831 int box_cols
= (WINDOW_TOTAL_COLS (w
)
2832 - WINDOW_FRINGE_COLS (w
)
2833 - WINDOW_SCROLL_BAR_COLS (w
));
2834 int margin_cols
= (WINDOW_LEFT_MARGIN_COLS (w
)
2835 + WINDOW_RIGHT_MARGIN_COLS (w
));
2837 if (box_cols
- margin_cols
>= MIN_SAFE_WINDOW_WIDTH
)
2840 if (margin_cols
< 0 || box_cols
< MIN_SAFE_WINDOW_WIDTH
)
2843 /* Window's text area is too narrow, but reducing the window
2844 margins will fix that. */
2845 margin_cols
= box_cols
- MIN_SAFE_WINDOW_WIDTH
;
2846 if (WINDOW_RIGHT_MARGIN_COLS (w
) > 0)
2848 if (WINDOW_LEFT_MARGIN_COLS (w
) > 0)
2849 w
->left_margin_cols
= w
->right_margin_cols
2850 = make_number (margin_cols
/2);
2852 w
->right_margin_cols
= make_number (margin_cols
);
2855 w
->left_margin_cols
= make_number (margin_cols
);
2859 static Lisp_Object
Fset_window_margins (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2860 static Lisp_Object
Fset_window_fringes (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2862 static Lisp_Object
Fset_window_scroll_bars (Lisp_Object
, Lisp_Object
,
2863 Lisp_Object
, Lisp_Object
);
2864 static Lisp_Object
Fset_window_vscroll (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2866 /* The following three routines are needed for running a window's
2867 configuration change hook. */
2869 run_funs (Lisp_Object funs
)
2871 for (; CONSP (funs
); funs
= XCDR (funs
))
2872 if (!EQ (XCAR (funs
), Qt
))
2873 call0 (XCAR (funs
));
2877 select_window_norecord (Lisp_Object window
)
2879 return WINDOW_LIVE_P (window
)
2880 ? Fselect_window (window
, Qt
) : selected_window
;
2884 select_frame_norecord (Lisp_Object frame
)
2886 return FRAME_LIVE_P (XFRAME (frame
))
2887 ? Fselect_frame (frame
, Qt
) : selected_frame
;
2891 run_window_configuration_change_hook (struct frame
*f
)
2893 ptrdiff_t count
= SPECPDL_INDEX ();
2894 Lisp_Object frame
, global_wcch
2895 = Fdefault_value (Qwindow_configuration_change_hook
);
2896 XSETFRAME (frame
, f
);
2898 if (NILP (Vrun_hooks
))
2901 /* Use the right buffer. Matters when running the local hooks. */
2902 if (current_buffer
!= XBUFFER (Fwindow_buffer (Qnil
)))
2904 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
2905 Fset_buffer (Fwindow_buffer (Qnil
));
2908 if (SELECTED_FRAME () != f
)
2910 record_unwind_protect (select_frame_norecord
, Fselected_frame ());
2911 select_frame_norecord (frame
);
2914 /* Look for buffer-local values. */
2916 Lisp_Object windows
= Fwindow_list (frame
, Qlambda
, Qnil
);
2917 for (; CONSP (windows
); windows
= XCDR (windows
))
2919 Lisp_Object window
= XCAR (windows
);
2920 Lisp_Object buffer
= Fwindow_buffer (window
);
2921 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook
,
2924 ptrdiff_t inner_count
= SPECPDL_INDEX ();
2925 record_unwind_protect (select_window_norecord
, Fselected_window ());
2926 select_window_norecord (window
);
2927 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook
,
2929 unbind_to (inner_count
, Qnil
);
2934 run_funs (global_wcch
);
2935 unbind_to (count
, Qnil
);
2938 DEFUN ("run-window-configuration-change-hook", Frun_window_configuration_change_hook
,
2939 Srun_window_configuration_change_hook
, 1, 1, 0,
2940 doc
: /* Run `window-configuration-change-hook' for FRAME. */)
2943 CHECK_LIVE_FRAME (frame
);
2944 run_window_configuration_change_hook (XFRAME (frame
));
2948 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
2949 means it's allowed to run hooks. See make_frame for a case where
2950 it's not allowed. KEEP_MARGINS_P non-zero means that the current
2951 margins, fringes, and scroll-bar settings of the window are not
2952 reset from the buffer's local settings. */
2955 set_window_buffer (Lisp_Object window
, Lisp_Object buffer
, int run_hooks_p
, int keep_margins_p
)
2957 struct window
*w
= XWINDOW (window
);
2958 struct buffer
*b
= XBUFFER (buffer
);
2959 ptrdiff_t count
= SPECPDL_INDEX ();
2960 int samebuf
= EQ (buffer
, w
->buffer
);
2964 if (EQ (window
, selected_window
))
2965 BVAR (b
, last_selected_window
) = window
;
2967 /* Let redisplay errors through. */
2968 b
->display_error_modiff
= 0;
2970 /* Update time stamps of buffer display. */
2971 if (INTEGERP (BVAR (b
, display_count
)))
2972 XSETINT (BVAR (b
, display_count
), XINT (BVAR (b
, display_count
)) + 1);
2973 BVAR (b
, display_time
) = Fcurrent_time ();
2975 XSETFASTINT (w
->window_end_pos
, 0);
2976 XSETFASTINT (w
->window_end_vpos
, 0);
2977 memset (&w
->last_cursor
, 0, sizeof w
->last_cursor
);
2978 w
->window_end_valid
= Qnil
;
2979 if (!(keep_margins_p
&& samebuf
))
2980 { /* If we're not actually changing the buffer, don't reset hscroll and
2981 vscroll. This case happens for example when called from
2982 change_frame_size_1, where we use a dummy call to
2983 Fset_window_buffer on the frame's selected window (and no other)
2984 just in order to run window-configuration-change-hook.
2985 Resetting hscroll and vscroll here is problematic for things like
2986 image-mode and doc-view-mode since it resets the image's position
2987 whenever we resize the frame. */
2988 w
->hscroll
= w
->min_hscroll
= make_number (0);
2990 set_marker_both (w
->pointm
, buffer
, BUF_PT (b
), BUF_PT_BYTE (b
));
2991 set_marker_restricted (w
->start
,
2992 make_number (b
->last_window_start
),
2994 w
->start_at_line_beg
= Qnil
;
2995 w
->force_start
= Qnil
;
2996 XSETFASTINT (w
->last_modified
, 0);
2997 XSETFASTINT (w
->last_overlay_modified
, 0);
2999 /* Maybe we could move this into the `if' but it's not obviously safe and
3000 I doubt it's worth the trouble. */
3001 windows_or_buffers_changed
++;
3003 /* We must select BUFFER for running the window-scroll-functions. */
3004 /* We can't check ! NILP (Vwindow_scroll_functions) here
3005 because that might itself be a local variable. */
3006 if (window_initialized
)
3008 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3009 Fset_buffer (buffer
);
3012 XMARKER (w
->pointm
)->insertion_type
= !NILP (Vwindow_point_insertion_type
);
3014 if (!keep_margins_p
)
3016 /* Set left and right marginal area width etc. from buffer. */
3018 /* This may call adjust_window_margins three times, so
3019 temporarily disable window margins. */
3020 Lisp_Object save_left
= w
->left_margin_cols
;
3021 Lisp_Object save_right
= w
->right_margin_cols
;
3023 w
->left_margin_cols
= w
->right_margin_cols
= Qnil
;
3025 Fset_window_fringes (window
,
3026 BVAR (b
, left_fringe_width
), BVAR (b
, right_fringe_width
),
3027 BVAR (b
, fringes_outside_margins
));
3029 Fset_window_scroll_bars (window
,
3030 BVAR (b
, scroll_bar_width
),
3031 BVAR (b
, vertical_scroll_bar_type
), Qnil
);
3033 w
->left_margin_cols
= save_left
;
3034 w
->right_margin_cols
= save_right
;
3036 Fset_window_margins (window
,
3037 BVAR (b
, left_margin_cols
), BVAR (b
, right_margin_cols
));
3042 if (! NILP (Vwindow_scroll_functions
))
3043 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
3044 Fmarker_position (w
->start
));
3045 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w
)));
3048 unbind_to (count
, Qnil
);
3051 DEFUN ("set-window-buffer", Fset_window_buffer
, Sset_window_buffer
, 2, 3, 0,
3052 doc
: /* Make WINDOW display BUFFER-OR-NAME as its contents.
3053 WINDOW has to be a live window and defaults to the selected one.
3054 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3056 Optional third argument KEEP-MARGINS non-nil means that WINDOW's current
3057 display margins, fringe widths, and scroll bar settings are preserved;
3058 the default is to reset these from the local settings for BUFFER-OR-NAME
3059 or the frame defaults. Return nil.
3061 This function throws an error when WINDOW is strongly dedicated to its
3062 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3063 already display BUFFER-OR-NAME.
3065 This function runs `window-scroll-functions' before running
3066 `window-configuration-change-hook'. */)
3067 (register Lisp_Object window
, Lisp_Object buffer_or_name
, Lisp_Object keep_margins
)
3069 register Lisp_Object tem
, buffer
;
3070 register struct window
*w
= decode_window (window
);
3072 XSETWINDOW (window
, w
);
3073 buffer
= Fget_buffer (buffer_or_name
);
3074 CHECK_BUFFER (buffer
);
3075 if (NILP (BVAR (XBUFFER (buffer
), name
)))
3076 error ("Attempt to display deleted buffer");
3080 error ("Window is deleted");
3081 else if (!EQ (tem
, Qt
))
3082 /* w->buffer is t when the window is first being set up. */
3084 if (!EQ (tem
, buffer
))
3086 if (EQ (w
->dedicated
, Qt
))
3087 /* WINDOW is strongly dedicated to its buffer, signal an
3089 error ("Window is dedicated to `%s'", SDATA (BVAR (XBUFFER (tem
), name
)));
3091 /* WINDOW is weakly dedicated to its buffer, reset
3093 w
->dedicated
= Qnil
;
3095 call1 (Qrecord_window_buffer
, window
);
3101 set_window_buffer (window
, buffer
, 1, !NILP (keep_margins
));
3107 display_buffer (Lisp_Object buffer
, Lisp_Object not_this_window_p
, Lisp_Object override_frame
)
3109 return call3 (Qdisplay_buffer
, buffer
, not_this_window_p
, override_frame
);
3112 DEFUN ("force-window-update", Fforce_window_update
, Sforce_window_update
,
3114 doc
: /* Force all windows to be updated on next redisplay.
3115 If optional arg OBJECT is a window, force redisplay of that window only.
3116 If OBJECT is a buffer or buffer name, force redisplay of all windows
3117 displaying that buffer. */)
3118 (Lisp_Object object
)
3122 windows_or_buffers_changed
++;
3123 update_mode_lines
++;
3127 if (WINDOWP (object
))
3129 struct window
*w
= XWINDOW (object
);
3130 mark_window_display_accurate (object
, 0);
3131 w
->update_mode_line
= Qt
;
3132 if (BUFFERP (w
->buffer
))
3133 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
3134 ++update_mode_lines
;
3138 if (STRINGP (object
))
3139 object
= Fget_buffer (object
);
3140 if (BUFFERP (object
) && !NILP (BVAR (XBUFFER (object
), name
)))
3142 /* Walk all windows looking for buffer, and force update
3143 of each of those windows. */
3145 object
= window_loop (REDISPLAY_BUFFER_WINDOWS
, object
, 0, Qvisible
);
3146 return NILP (object
) ? Qnil
: Qt
;
3149 /* If nothing suitable was found, just return.
3150 We could signal an error, but this feature will typically be used
3151 asynchronously in timers or process sentinels, so we don't. */
3157 temp_output_buffer_show (register Lisp_Object buf
)
3159 register struct buffer
*old
= current_buffer
;
3160 register Lisp_Object window
;
3161 register struct window
*w
;
3163 BVAR (XBUFFER (buf
), directory
) = BVAR (current_buffer
, directory
);
3166 BUF_SAVE_MODIFF (XBUFFER (buf
)) = MODIFF
;
3170 set_buffer_internal (old
);
3172 if (!NILP (Vtemp_buffer_show_function
))
3173 call1 (Vtemp_buffer_show_function
, buf
);
3176 window
= display_buffer (buf
, Qnil
, Qnil
);
3178 if (!EQ (XWINDOW (window
)->frame
, selected_frame
))
3179 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window
)));
3180 Vminibuf_scroll_window
= window
;
3181 w
= XWINDOW (window
);
3182 XSETFASTINT (w
->hscroll
, 0);
3183 XSETFASTINT (w
->min_hscroll
, 0);
3184 set_marker_restricted_both (w
->start
, buf
, BEG
, BEG
);
3185 set_marker_restricted_both (w
->pointm
, buf
, BEG
, BEG
);
3187 /* Run temp-buffer-show-hook, with the chosen window selected
3188 and its buffer current. */
3190 ptrdiff_t count
= SPECPDL_INDEX ();
3191 Lisp_Object prev_window
, prev_buffer
;
3192 prev_window
= selected_window
;
3193 XSETBUFFER (prev_buffer
, old
);
3195 /* Select the window that was chosen, for running the hook.
3196 Note: Both Fselect_window and select_window_norecord may
3197 set-buffer to the buffer displayed in the window,
3198 so we need to save the current buffer. --stef */
3199 record_unwind_protect (Fset_buffer
, prev_buffer
);
3200 record_unwind_protect (select_window_norecord
, prev_window
);
3201 Fselect_window (window
, Qt
);
3202 Fset_buffer (w
->buffer
);
3203 Frun_hooks (1, &Qtemp_buffer_show_hook
);
3204 unbind_to (count
, Qnil
);
3209 DEFUN ("internal-temp-output-buffer-show",
3210 Ftemp_output_buffer_show
, Stemp_output_buffer_show
,
3212 doc
: /* Internal function for `with-output-to-temp-buffer'. */)
3215 temp_output_buffer_show (buf
);
3219 /* Make new window, have it replace WINDOW in window-tree, and make
3220 WINDOW its only vertical child (HORFLAG 1 means make WINDOW its only
3221 horizontal child). */
3223 make_parent_window (Lisp_Object window
, int horflag
)
3226 register struct window
*o
, *p
;
3229 o
= XWINDOW (window
);
3230 p
= allocate_window ();
3231 for (i
= 0; i
< VECSIZE (struct window
); ++i
)
3232 ((struct Lisp_Vector
*) p
)->contents
[i
]
3233 = ((struct Lisp_Vector
*) o
)->contents
[i
];
3234 XSETWINDOW (parent
, p
);
3237 XSETFASTINT (p
->sequence_number
, sequence_number
);
3239 replace_window (window
, parent
, 1);
3245 p
->hchild
= horflag
? window
: Qnil
;
3246 p
->vchild
= horflag
? Qnil
: window
;
3250 p
->combination_limit
= Qnil
;
3251 p
->window_parameters
= Qnil
;
3254 /* Make new window from scratch. */
3259 register struct window
*w
;
3261 w
= allocate_window ();
3262 /* Initialize all Lisp data. */
3263 w
->frame
= w
->mini_p
= Qnil
;
3264 w
->next
= w
->prev
= w
->hchild
= w
->vchild
= w
->parent
= Qnil
;
3265 XSETFASTINT (w
->left_col
, 0);
3266 XSETFASTINT (w
->top_line
, 0);
3267 XSETFASTINT (w
->total_lines
, 0);
3268 XSETFASTINT (w
->total_cols
, 0);
3269 w
->normal_lines
= make_float (1.0);
3270 w
->normal_cols
= make_float (1.0);
3271 XSETFASTINT (w
->new_total
, 0);
3272 XSETFASTINT (w
->new_normal
, 0);
3274 w
->start
= Fmake_marker ();
3275 w
->pointm
= Fmake_marker ();
3276 w
->force_start
= w
->optional_new_start
= Qnil
;
3277 XSETFASTINT (w
->hscroll
, 0);
3278 XSETFASTINT (w
->min_hscroll
, 0);
3279 XSETFASTINT (w
->use_time
, 0);
3281 XSETFASTINT (w
->sequence_number
, sequence_number
);
3282 w
->temslot
= w
->last_modified
= w
->last_overlay_modified
= Qnil
;
3283 XSETFASTINT (w
->last_point
, 0);
3284 w
->last_had_star
= w
->vertical_scroll_bar
= Qnil
;
3285 w
->left_margin_cols
= w
->right_margin_cols
= Qnil
;
3286 w
->left_fringe_width
= w
->right_fringe_width
= Qnil
;
3287 w
->fringes_outside_margins
= Qnil
;
3288 w
->scroll_bar_width
= Qnil
;
3289 w
->vertical_scroll_bar_type
= Qt
;
3290 w
->last_mark_x
= w
->last_mark_y
= Qnil
;
3291 XSETFASTINT (w
->window_end_pos
, 0);
3292 XSETFASTINT (w
->window_end_vpos
, 0);
3293 w
->window_end_valid
= w
->update_mode_line
= Qnil
;
3294 w
->start_at_line_beg
= w
->display_table
= w
->dedicated
= Qnil
;
3295 w
->base_line_number
= w
->base_line_pos
= w
->region_showing
= Qnil
;
3296 w
->column_number_displayed
= w
->redisplay_end_trigger
= Qnil
;
3297 w
->combination_limit
= w
->window_parameters
= Qnil
;
3298 w
->prev_buffers
= w
->next_buffers
= Qnil
;
3299 /* Initialize non-Lisp data. */
3300 w
->desired_matrix
= w
->current_matrix
= 0;
3301 w
->nrows_scale_factor
= w
->ncols_scale_factor
= 1;
3302 memset (&w
->cursor
, 0, sizeof (w
->cursor
));
3303 memset (&w
->last_cursor
, 0, sizeof (w
->last_cursor
));
3304 memset (&w
->phys_cursor
, 0, sizeof (w
->phys_cursor
));
3305 w
->phys_cursor_type
= -1;
3306 w
->phys_cursor_width
= -1;
3307 w
->phys_cursor_on_p
= 0;
3308 w
->last_cursor_off_p
= w
->cursor_off_p
= 0;
3309 w
->must_be_updated_p
= 0;
3310 w
->pseudo_window_p
= 0;
3311 w
->frozen_window_start_p
= 0;
3313 /* Reset window_list. */
3314 Vwindow_list
= Qnil
;
3315 /* Return window. */
3316 XSETWINDOW (window
, w
);
3320 DEFUN ("set-window-new-total", Fset_window_new_total
, Sset_window_new_total
, 2, 3, 0,
3321 doc
: /* Set new total size of WINDOW to SIZE.
3324 Optional argument ADD non-nil means add SIZE to the new total size of
3325 WINDOW and return the sum.
3327 Note: This function does not operate on any child windows of WINDOW. */)
3328 (Lisp_Object window
, Lisp_Object size
, Lisp_Object add
)
3330 struct window
*w
= decode_any_window (window
);
3332 CHECK_NUMBER (size
);
3334 XSETINT (w
->new_total
, XINT (size
));
3336 XSETINT (w
->new_total
, XINT (w
->new_total
) + XINT (size
));
3338 return w
->new_total
;
3341 DEFUN ("set-window-new-normal", Fset_window_new_normal
, Sset_window_new_normal
, 1, 2, 0,
3342 doc
: /* Set new normal size of WINDOW to SIZE.
3345 Note: This function does not operate on any child windows of WINDOW. */)
3346 (Lisp_Object window
, Lisp_Object size
)
3348 struct window
*w
= decode_any_window (window
);
3350 w
->new_normal
= size
;
3351 return w
->new_normal
;
3354 /* Return 1 if setting w->total_lines (w->total_cols if HORFLAG is
3355 non-zero) to w->new_total would result in correct heights (widths)
3356 for window W and recursively all child windows of W.
3358 Note: This function does not check any of `window-fixed-size-p',
3359 `window-min-height' or `window-min-width'. It does check that window
3360 sizes do not drop below one line (two columns). */
3362 window_resize_check (struct window
*w
, int horflag
)
3366 if (!NILP (w
->vchild
))
3367 /* W is a vertical combination. */
3369 c
= XWINDOW (w
->vchild
);
3371 /* All child windows of W must have the same width as W. */
3375 if ((XINT (c
->new_total
) != XINT (w
->new_total
))
3376 || !window_resize_check (c
, horflag
))
3378 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3383 /* The sum of the heights of the child windows of W must equal
3386 int sum_of_sizes
= 0;
3389 if (!window_resize_check (c
, horflag
))
3391 sum_of_sizes
= sum_of_sizes
+ XINT (c
->new_total
);
3392 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3394 return (sum_of_sizes
== XINT (w
->new_total
));
3397 else if (!NILP (w
->hchild
))
3398 /* W is a horizontal combination. */
3400 c
= XWINDOW (w
->hchild
);
3402 /* The sum of the widths of the child windows of W must equal W's
3405 int sum_of_sizes
= 0;
3408 if (!window_resize_check (c
, horflag
))
3410 sum_of_sizes
= sum_of_sizes
+ XINT (c
->new_total
);
3411 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3413 return (sum_of_sizes
== XINT (w
->new_total
));
3416 /* All child windows of W must have the same height as W. */
3420 if ((XINT (c
->new_total
) != XINT (w
->new_total
))
3421 || !window_resize_check (c
, horflag
))
3423 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3429 /* A leaf window. Make sure it's not too small. The following
3430 hardcodes the values of `window-safe-min-width' (2) and
3431 `window-safe-min-height' (1) which are defined in window.el. */
3432 return XINT (w
->new_total
) >= (horflag
? 2 : 1);
3435 /* Set w->total_lines (w->total_cols if HORIZONTAL is non-zero) to
3436 w->new_total for window W and recursively all child windows of W.
3437 Also calculate and assign the new vertical (horizontal) start
3438 positions of each of these windows.
3440 This function does not perform any error checks. Make sure you have
3441 run window_resize_check on W before applying this function. */
3443 window_resize_apply (struct window
*w
, int horflag
)
3448 /* Note: Assigning new_normal requires that the new total size of the
3449 parent window has been set *before*. */
3452 w
->total_cols
= w
->new_total
;
3453 if (NUMBERP (w
->new_normal
))
3454 w
->normal_cols
= w
->new_normal
;
3456 pos
= XINT (w
->left_col
);
3460 w
->total_lines
= w
->new_total
;
3461 if (NUMBERP (w
->new_normal
))
3462 w
->normal_lines
= w
->new_normal
;
3464 pos
= XINT (w
->top_line
);
3467 if (!NILP (w
->vchild
))
3468 /* W is a vertical combination. */
3470 c
= XWINDOW (w
->vchild
);
3474 XSETFASTINT (c
->left_col
, pos
);
3476 XSETFASTINT (c
->top_line
, pos
);
3477 window_resize_apply (c
, horflag
);
3479 pos
= pos
+ XINT (c
->total_lines
);
3480 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3483 else if (!NILP (w
->hchild
))
3484 /* W is a horizontal combination. */
3486 c
= XWINDOW (w
->hchild
);
3490 XSETFASTINT (c
->left_col
, pos
);
3492 XSETFASTINT (c
->top_line
, pos
);
3493 window_resize_apply (c
, horflag
);
3495 pos
= pos
+ XINT (c
->total_cols
);
3496 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3500 /* Clear out some redisplay caches. */
3501 XSETFASTINT (w
->last_modified
, 0);
3502 XSETFASTINT (w
->last_overlay_modified
, 0);
3506 DEFUN ("window-resize-apply", Fwindow_resize_apply
, Swindow_resize_apply
, 1, 2, 0,
3507 doc
: /* Apply requested size values for window-tree of FRAME.
3508 Optional argument HORIZONTAL omitted or nil means apply requested height
3509 values. HORIZONTAL non-nil means apply requested width values.
3511 This function checks whether the requested values sum up to a valid
3512 window layout, recursively assigns the new sizes of all child windows
3513 and calculates and assigns the new start positions of these windows.
3515 Note: This function does not check any of `window-fixed-size-p',
3516 `window-min-height' or `window-min-width'. All these checks have to
3517 be applied on the Elisp level. */)
3518 (Lisp_Object frame
, Lisp_Object horizontal
)
3522 int horflag
= !NILP (horizontal
);
3525 frame
= selected_frame
;
3526 CHECK_LIVE_FRAME (frame
);
3529 r
= XWINDOW (FRAME_ROOT_WINDOW (f
));
3531 if (!window_resize_check (r
, horflag
)
3532 || ! EQ (r
->new_total
, (horflag
? r
->total_cols
: r
->total_lines
)))
3536 window_resize_apply (r
, horflag
);
3538 windows_or_buffers_changed
++;
3539 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
3544 run_window_configuration_change_hook (f
);
3550 /* Resize frame F's windows when number of lines of F is set to SIZE.
3551 HORFLAG 1 means resize windows when number of columns of F is set to
3554 This function can delete all windows but the selected one in order to
3555 satisfy the request. The result will be meaningful if and only if
3556 F's windows have meaningful sizes when you call this. */
3558 resize_frame_windows (struct frame
*f
, int size
, int horflag
)
3560 Lisp_Object root
= f
->root_window
;
3561 struct window
*r
= XWINDOW (root
);
3562 Lisp_Object mini
= f
->minibuffer_window
;
3564 /* new_size is the new size of the frame's root window. */
3565 int new_size
= (horflag
3568 - FRAME_TOP_MARGIN (f
)
3569 - ((FRAME_HAS_MINIBUF_P (f
) && !FRAME_MINIBUF_ONLY_P (f
))
3572 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
3573 if (NILP (r
->vchild
) && NILP (r
->hchild
))
3574 /* For a leaf root window just set the size. */
3576 XSETFASTINT (r
->total_cols
, new_size
);
3578 XSETFASTINT (r
->total_lines
, new_size
);
3581 /* old_size is the old size of the frame's root window. */
3582 int old_size
= XFASTINT (horflag
? r
->total_cols
: r
->total_lines
);
3585 XSETINT (delta
, new_size
- old_size
);
3586 /* Try a "normal" resize first. */
3587 resize_root_window (root
, delta
, horflag
? Qt
: Qnil
, Qnil
);
3588 if (window_resize_check (r
, horflag
) && new_size
== XINT (r
->new_total
))
3589 window_resize_apply (r
, horflag
);
3592 /* Try with "reasonable" minimum sizes next. */
3593 resize_root_window (root
, delta
, horflag
? Qt
: Qnil
, Qt
);
3594 if (window_resize_check (r
, horflag
)
3595 && new_size
== XINT (r
->new_total
))
3596 window_resize_apply (r
, horflag
);
3599 /* Finally, try with "safe" minimum sizes. */
3600 resize_root_window (root
, delta
, horflag
? Qt
: Qnil
, Qsafe
);
3601 if (window_resize_check (r
, horflag
)
3602 && new_size
== XINT (r
->new_total
))
3603 window_resize_apply (r
, horflag
);
3606 /* We lost. Delete all windows but the frame's
3608 root
= f
->selected_window
;
3609 Fdelete_other_windows_internal (root
, Qnil
);
3611 XSETFASTINT (XWINDOW (root
)->total_cols
, new_size
);
3613 XSETFASTINT (XWINDOW (root
)->total_lines
, new_size
);
3619 if (FRAME_HAS_MINIBUF_P (f
) && !FRAME_MINIBUF_ONLY_P (f
))
3623 XSETFASTINT (m
->total_cols
, size
);
3626 /* Are we sure we always want 1 line here? */
3627 XSETFASTINT (m
->total_lines
, 1);
3628 XSETFASTINT (m
->top_line
, XINT (r
->top_line
) + XINT (r
->total_lines
));
3634 DEFUN ("split-window-internal", Fsplit_window_internal
, Ssplit_window_internal
, 4, 4, 0,
3635 doc
: /* Split window OLD.
3636 Second argument TOTAL-SIZE specifies the number of lines or columns of the
3637 new window. In any case TOTAL-SIZE must be a positive integer.
3639 Third argument SIDE nil (or `below') specifies that the new window shall
3640 be located below WINDOW. SIDE `above' means the new window shall be
3641 located above WINDOW. In both cases TOTAL-SIZE specifies the number of
3642 lines of the new window including space reserved for the mode and/or
3645 SIDE t (or `right') specifies that the new window shall be located on
3646 the right side of WINDOW. SIDE `left' means the new window shall be
3647 located on the left of WINDOW. In both cases TOTAL-SIZE specifies the
3648 number of columns of the new window including space reserved for fringes
3649 and the scrollbar or a divider column.
3651 Fourth argument NORMAL-SIZE specifies the normal size of the new window
3652 according to the SIDE argument.
3654 The new total and normal sizes of all involved windows must have been
3655 set correctly. See the code of `split-window' for how this is done. */)
3656 (Lisp_Object old
, Lisp_Object total_size
, Lisp_Object side
, Lisp_Object normal_size
)
3658 /* OLD (*o) is the window we have to split. (*p) is either OLD's
3659 parent window or an internal window we have to install as OLD's new
3660 parent. REFERENCE (*r) must denote a live window, or is set to OLD
3661 provided OLD is a leaf window, or to the frame's selected window.
3662 NEW (*n) is the new window created with some parameters taken from
3664 register Lisp_Object
new, frame
, reference
;
3665 register struct window
*o
, *p
, *n
, *r
;
3668 /* HORFLAG is 1 when we split side-by-side, 0 otherwise. */
3669 = EQ (side
, Qt
) || EQ (side
, Qleft
) || EQ (side
, Qright
);
3670 int combination_limit
= 0;
3674 frame
= WINDOW_FRAME (o
);
3677 CHECK_NUMBER (total_size
);
3679 /* Set combination_limit to 1 if we have to make a new parent window.
3680 We do that if either `window-combination-limit' is t, or OLD has no
3681 parent, or OLD is ortho-combined. */
3683 !NILP (Vwindow_combination_limit
)
3686 ? (XWINDOW (o
->parent
)->hchild
)
3687 : (XWINDOW (o
->parent
)->vchild
));
3689 /* We need a live reference window to initialize some parameters. */
3690 if (WINDOW_LIVE_P (old
))
3691 /* OLD is live, use it as reference window. */
3694 /* Use the frame's selected window as reference window. */
3695 reference
= FRAME_SELECTED_WINDOW (f
);
3696 r
= XWINDOW (reference
);
3698 /* The following bugs are caught by `split-window'. */
3699 if (MINI_WINDOW_P (o
))
3700 error ("Attempt to split minibuffer window");
3701 else if (XINT (total_size
) < (horflag
? 2 : 1))
3702 error ("Size of new window too small (after split)");
3703 else if (!combination_limit
&& !NILP (Vwindow_combination_resize
))
3704 /* `window-combination-resize' non-nil means try to resize OLD's siblings
3707 p
= XWINDOW (o
->parent
);
3708 /* Temporarily pretend we split the parent window. */
3709 XSETINT (p
->new_total
,
3710 XINT (horflag
? p
->total_cols
: p
->total_lines
)
3711 - XINT (total_size
));
3712 if (!window_resize_check (p
, horflag
))
3713 error ("Window sizes don't fit");
3715 /* Undo the temporary pretension. */
3716 p
->new_total
= horflag
? p
->total_cols
: p
->total_lines
;
3720 if (!window_resize_check (o
, horflag
))
3721 error ("Resizing old window failed");
3722 else if (XINT (total_size
) + XINT (o
->new_total
)
3723 != XINT (horflag
? o
->total_cols
: o
->total_lines
))
3724 error ("Sum of sizes of old and new window don't fit");
3727 /* This is our point of no return. */
3728 if (combination_limit
)
3730 /* Save the old value of o->normal_cols/lines. It gets corrupted
3731 by make_parent_window and we need it below for assigning it to
3733 Lisp_Object new_normal
= horflag
? o
->normal_cols
: o
->normal_lines
;
3735 make_parent_window (old
, horflag
);
3736 p
= XWINDOW (o
->parent
);
3737 /* Store value of `window-combination-limit' in new parent's
3738 combination_limit slot. */
3739 p
->combination_limit
= Vwindow_combination_limit
;
3740 /* These get applied below. */
3741 p
->new_total
= horflag
? o
->total_cols
: o
->total_lines
;
3742 p
->new_normal
= new_normal
;
3745 p
= XWINDOW (o
->parent
);
3747 windows_or_buffers_changed
++;
3748 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
3749 new = make_window ();
3752 n
->parent
= o
->parent
;
3753 n
->vchild
= n
->hchild
= Qnil
;
3755 if (EQ (side
, Qabove
) || EQ (side
, Qleft
))
3764 XWINDOW (n
->prev
)->next
= new;
3771 if (!NILP (n
->next
))
3772 XWINDOW (n
->next
)->prev
= new;
3778 n
->window_end_valid
= Qnil
;
3779 memset (&n
->last_cursor
, 0, sizeof n
->last_cursor
);
3781 /* Get special geometry settings from reference window. */
3782 n
->left_margin_cols
= r
->left_margin_cols
;
3783 n
->right_margin_cols
= r
->right_margin_cols
;
3784 n
->left_fringe_width
= r
->left_fringe_width
;
3785 n
->right_fringe_width
= r
->right_fringe_width
;
3786 n
->fringes_outside_margins
= r
->fringes_outside_margins
;
3787 n
->scroll_bar_width
= r
->scroll_bar_width
;
3788 n
->vertical_scroll_bar_type
= r
->vertical_scroll_bar_type
;
3790 /* Directly assign orthogonal coordinates and sizes. */
3793 n
->top_line
= o
->top_line
;
3794 n
->total_lines
= o
->total_lines
;
3798 n
->left_col
= o
->left_col
;
3799 n
->total_cols
= o
->total_cols
;
3802 /* Iso-coordinates and sizes are assigned by window_resize_apply,
3803 get them ready here. */
3804 n
->new_total
= total_size
;
3805 n
->new_normal
= normal_size
;
3808 window_resize_apply (p
, horflag
);
3810 /* Set buffer of NEW to buffer of reference window. Don't run
3812 set_window_buffer (new, r
->buffer
, 0, 1);
3815 /* Maybe we should run the scroll functions in Elisp (which already
3816 runs the configuration change hook). */
3817 if (! NILP (Vwindow_scroll_functions
))
3818 run_hook_with_args_2 (Qwindow_scroll_functions
, new,
3819 Fmarker_position (n
->start
));
3825 DEFUN ("delete-window-internal", Fdelete_window_internal
, Sdelete_window_internal
, 1, 1, 0,
3826 doc
: /* Remove WINDOW from its frame.
3827 WINDOW defaults to the selected window. Return nil.
3828 Signal an error when WINDOW is the only window on its frame. */)
3829 (register Lisp_Object window
)
3831 register Lisp_Object parent
, sibling
, frame
, root
;
3832 struct window
*w
, *p
, *s
, *r
;
3835 int before_sibling
= 0;
3837 w
= decode_any_window (window
);
3838 XSETWINDOW (window
, w
);
3839 if (NILP (w
->buffer
) && NILP (w
->hchild
) && NILP (w
->vchild
))
3840 /* It's a no-op to delete an already deleted window. */
3845 /* Never delete a minibuffer or frame root window. */
3846 error ("Attempt to delete minibuffer or sole ordinary window");
3847 else if (NILP (w
->prev
) && NILP (w
->next
))
3848 /* Rather bow out here, this case should be handled on the Elisp
3850 error ("Attempt to delete sole window of parent");
3852 p
= XWINDOW (parent
);
3853 horflag
= NILP (p
->vchild
);
3855 frame
= WINDOW_FRAME (w
);
3858 root
= FRAME_ROOT_WINDOW (f
);
3861 /* Unlink WINDOW from window tree. */
3863 /* Get SIBLING below (on the right of) WINDOW. */
3865 /* before_sibling 1 means WINDOW is the first child of its
3866 parent and thus before the sibling. */
3869 s
= XWINDOW (sibling
);
3872 p
->hchild
= sibling
;
3874 p
->vchild
= sibling
;
3877 /* Get SIBLING above (on the left of) WINDOW. */
3880 s
= XWINDOW (sibling
);
3882 if (!NILP (s
->next
))
3883 XWINDOW (s
->next
)->prev
= sibling
;
3886 if (window_resize_check (r
, horflag
)
3887 && EQ (r
->new_total
, (horflag
? r
->total_cols
: r
->total_lines
)))
3888 /* We can delete WINDOW now. */
3892 window_resize_apply (p
, horflag
);
3894 windows_or_buffers_changed
++;
3895 Vwindow_list
= Qnil
;
3896 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
3898 w
->next
= Qnil
; /* Don't delete w->next too. */
3899 free_window_matrices (w
);
3901 if (!NILP (w
->vchild
))
3903 delete_all_child_windows (w
->vchild
);
3906 else if (!NILP (w
->hchild
))
3908 delete_all_child_windows (w
->hchild
);
3911 else if (!NILP (w
->buffer
))
3914 unchain_marker (XMARKER (w
->pointm
));
3915 unchain_marker (XMARKER (w
->start
));
3919 if (NILP (s
->prev
) && NILP (s
->next
))
3920 /* A matrjoshka where SIBLING has become the only child of
3923 /* Put SIBLING into PARENT's place. */
3924 replace_window (parent
, sibling
, 0);
3925 /* Have SIBLING inherit the following three slot values from
3926 PARENT (the combination_limit slot is not inherited). */
3927 s
->normal_cols
= p
->normal_cols
;
3928 s
->normal_lines
= p
->normal_lines
;
3929 /* Mark PARENT as deleted. */
3930 p
->vchild
= p
->hchild
= Qnil
;
3931 /* Try to merge SIBLING into its new parent. */
3932 recombine_windows (sibling
);
3937 if (!WINDOW_LIVE_P (FRAME_SELECTED_WINDOW (f
)))
3938 /* We deleted the frame's selected window. */
3940 /* Use the frame's first window as fallback ... */
3941 Lisp_Object new_selected_window
= Fframe_first_window (frame
);
3942 /* ... but preferably use its most recently used window. */
3943 Lisp_Object mru_window
;
3945 /* `get-mru-window' might fail for some reason so play it safe
3946 - promote the first window _without recording it_ first. */
3947 if (EQ (FRAME_SELECTED_WINDOW (f
), selected_window
))
3948 Fselect_window (new_selected_window
, Qt
);
3950 FRAME_SELECTED_WINDOW (f
) = new_selected_window
;
3954 /* Now look whether `get-mru-window' gets us something. */
3955 mru_window
= call1 (Qget_mru_window
, frame
);
3956 if (WINDOW_LIVE_P (mru_window
)
3957 && EQ (XWINDOW (mru_window
)->frame
, frame
))
3958 new_selected_window
= mru_window
;
3960 /* If all ended up well, we now promote the mru window. */
3961 if (EQ (FRAME_SELECTED_WINDOW (f
), selected_window
))
3962 Fselect_window (new_selected_window
, Qnil
);
3964 FRAME_SELECTED_WINDOW (f
) = new_selected_window
;
3969 /* Must be run by the caller:
3970 run_window_configuration_change_hook (f); */
3973 /* We failed: Relink WINDOW into window tree. */
3986 if (!NILP (w
->next
))
3987 XWINDOW (w
->next
)->prev
= window
;
3989 error ("Deletion failed");
3995 /***********************************************************************
3996 Resizing Mini-Windows
3997 ***********************************************************************/
3999 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we
4002 grow_mini_window (struct window
*w
, int delta
)
4004 struct frame
*f
= XFRAME (w
->frame
);
4006 Lisp_Object root
, value
;
4008 xassert (MINI_WINDOW_P (w
));
4009 xassert (delta
>= 0);
4011 root
= FRAME_ROOT_WINDOW (f
);
4013 value
= call2 (Qwindow_resize_root_window_vertically
,
4014 root
, make_number (- delta
));
4015 if (INTEGERP (value
) && window_resize_check (r
, 0))
4018 window_resize_apply (r
, 0);
4020 /* Grow the mini-window. */
4021 XSETFASTINT (w
->top_line
, XFASTINT (r
->top_line
) + XFASTINT (r
->total_lines
));
4022 XSETFASTINT (w
->total_lines
, XFASTINT (w
->total_lines
) - XINT (value
));
4023 XSETFASTINT (w
->last_modified
, 0);
4024 XSETFASTINT (w
->last_overlay_modified
, 0);
4032 /* Shrink mini-window W. */
4034 shrink_mini_window (struct window
*w
)
4036 struct frame
*f
= XFRAME (w
->frame
);
4038 Lisp_Object root
, value
;
4041 xassert (MINI_WINDOW_P (w
));
4043 size
= XINT (w
->total_lines
);
4046 root
= FRAME_ROOT_WINDOW (f
);
4048 value
= call2 (Qwindow_resize_root_window_vertically
,
4049 root
, make_number (size
- 1));
4050 if (INTEGERP (value
) && window_resize_check (r
, 0))
4053 window_resize_apply (r
, 0);
4055 /* Shrink the mini-window. */
4056 XSETFASTINT (w
->top_line
, XFASTINT (r
->top_line
) + XFASTINT (r
->total_lines
));
4057 XSETFASTINT (w
->total_lines
, 1);
4059 XSETFASTINT (w
->last_modified
, 0);
4060 XSETFASTINT (w
->last_overlay_modified
, 0);
4065 /* If the above failed for whatever strange reason we must make a
4066 one window frame here. The same routine will be needed when
4067 shrinking the frame (and probably when making the initial
4068 *scratch* window). For the moment leave things as they are. */
4072 DEFUN ("resize-mini-window-internal", Fresize_mini_window_internal
, Sresize_mini_window_internal
, 1, 1, 0,
4073 doc
: /* Resize minibuffer window WINDOW. */)
4074 (Lisp_Object window
)
4076 struct window
*w
= XWINDOW (window
);
4081 CHECK_WINDOW (window
);
4082 f
= XFRAME (w
->frame
);
4084 if (!EQ (FRAME_MINIBUF_WINDOW (XFRAME (w
->frame
)), window
))
4085 error ("Not a valid minibuffer window");
4086 else if (FRAME_MINIBUF_ONLY_P (f
))
4087 error ("Cannot resize a minibuffer-only frame");
4089 r
= XWINDOW (FRAME_ROOT_WINDOW (f
));
4090 height
= XINT (r
->total_lines
) + XINT (w
->total_lines
);
4091 if (window_resize_check (r
, 0)
4092 && XINT (w
->new_total
) > 0
4093 && height
== XINT (r
->new_total
) + XINT (w
->new_total
))
4096 window_resize_apply (r
, 0);
4098 w
->total_lines
= w
->new_total
;
4099 XSETFASTINT (w
->top_line
, XINT (r
->top_line
) + XINT (r
->total_lines
));
4101 windows_or_buffers_changed
++;
4102 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
4106 run_window_configuration_change_hook (f
);
4109 else error ("Failed to resize minibuffer window");
4112 /* Mark window cursors off for all windows in the window tree rooted
4113 at W by setting their phys_cursor_on_p flag to zero. Called from
4114 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4115 the frame are cleared. */
4118 mark_window_cursors_off (struct window
*w
)
4122 if (!NILP (w
->hchild
))
4123 mark_window_cursors_off (XWINDOW (w
->hchild
));
4124 else if (!NILP (w
->vchild
))
4125 mark_window_cursors_off (XWINDOW (w
->vchild
));
4127 w
->phys_cursor_on_p
= 0;
4129 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
4134 /* Return number of lines of text (not counting mode lines) in W. */
4137 window_internal_height (struct window
*w
)
4139 int ht
= XFASTINT (w
->total_lines
);
4141 if (!MINI_WINDOW_P (w
))
4143 if (!NILP (w
->parent
)
4144 || !NILP (w
->vchild
)
4145 || !NILP (w
->hchild
)
4148 || WINDOW_WANTS_MODELINE_P (w
))
4151 if (WINDOW_WANTS_HEADER_LINE_P (w
))
4158 /************************************************************************
4160 ***********************************************************************/
4162 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4163 N screen-fulls, which is defined as the height of the window minus
4164 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4165 instead. Negative values of N mean scroll down. NOERROR non-zero
4166 means don't signal an error if we try to move over BEGV or ZV,
4170 window_scroll (Lisp_Object window
, EMACS_INT n
, int whole
, int noerror
)
4173 n
= clip_to_bounds (INT_MIN
, n
, INT_MAX
);
4175 /* If we must, use the pixel-based version which is much slower than
4176 the line-based one but can handle varying line heights. */
4177 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window
)->frame
)))
4178 window_scroll_pixel_based (window
, n
, whole
, noerror
);
4180 window_scroll_line_based (window
, n
, whole
, noerror
);
4186 /* Implementation of window_scroll that works based on pixel line
4187 heights. See the comment of window_scroll for parameter
4191 window_scroll_pixel_based (Lisp_Object window
, int n
, int whole
, int noerror
)
4194 struct window
*w
= XWINDOW (window
);
4195 struct text_pos start
;
4196 int this_scroll_margin
;
4197 /* True if we fiddled the window vscroll field without really scrolling. */
4199 int x
, y
, rtop
, rbot
, rowh
, vpos
;
4200 void *itdata
= NULL
;
4202 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
4204 /* If PT is not visible in WINDOW, move back one half of
4205 the screen. Allow PT to be partially visible, otherwise
4206 something like (scroll-down 1) with PT in the line before
4207 the partially visible one would recenter. */
4209 if (!pos_visible_p (w
, PT
, &x
, &y
, &rtop
, &rbot
, &rowh
, &vpos
))
4211 itdata
= bidi_shelve_cache ();
4212 /* Move backward half the height of the window. Performance note:
4213 vmotion used here is about 10% faster, but would give wrong
4214 results for variable height lines. */
4215 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
4216 it
.current_y
= it
.last_visible_y
;
4217 move_it_vertically_backward (&it
, window_box_height (w
) / 2);
4219 /* The function move_iterator_vertically may move over more than
4220 the specified y-distance. If it->w is small, e.g. a
4221 mini-buffer window, we may end up in front of the window's
4222 display area. This is the case when Start displaying at the
4223 start of the line containing PT in this case. */
4224 if (it
.current_y
<= 0)
4226 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
4227 move_it_vertically_backward (&it
, 0);
4231 start
= it
.current
.pos
;
4232 bidi_unshelve_cache (itdata
, 0);
4234 else if (auto_window_vscroll_p
)
4236 if (rtop
|| rbot
) /* partially visible */
4239 int dy
= WINDOW_FRAME_LINE_HEIGHT (w
);
4241 dy
= max ((window_box_height (w
)
4242 - next_screen_context_lines
* dy
),
4248 /* Only vscroll backwards if already vscrolled forwards. */
4249 if (w
->vscroll
< 0 && rtop
> 0)
4251 px
= max (0, -w
->vscroll
- min (rtop
, -dy
));
4252 Fset_window_vscroll (window
, make_number (px
), Qt
);
4258 /* Do vscroll if already vscrolled or only display line. */
4259 if (rbot
> 0 && (w
->vscroll
< 0 || vpos
== 0))
4261 px
= max (0, -w
->vscroll
+ min (rbot
, dy
));
4262 Fset_window_vscroll (window
, make_number (px
), Qt
);
4266 /* Maybe modify window start instead of scrolling. */
4267 if (rbot
> 0 || w
->vscroll
< 0)
4271 Fset_window_vscroll (window
, make_number (0), Qt
);
4272 /* If there are other text lines above the current row,
4273 move window start to current row. Else to next row. */
4275 spos
= XINT (Fline_beginning_position (Qnil
));
4277 spos
= min (XINT (Fline_end_position (Qnil
)) + 1, ZV
);
4278 set_marker_restricted (w
->start
, make_number (spos
),
4280 w
->start_at_line_beg
= Qt
;
4281 w
->update_mode_line
= Qt
;
4282 XSETFASTINT (w
->last_modified
, 0);
4283 XSETFASTINT (w
->last_overlay_modified
, 0);
4284 /* Set force_start so that redisplay_window will run the
4285 window-scroll-functions. */
4286 w
->force_start
= Qt
;
4291 /* Cancel previous vscroll. */
4292 Fset_window_vscroll (window
, make_number (0), Qt
);
4295 itdata
= bidi_shelve_cache ();
4296 /* If scroll_preserve_screen_position is non-nil, we try to set
4297 point in the same window line as it is now, so get that line. */
4298 if (!NILP (Vscroll_preserve_screen_position
))
4300 /* We preserve the goal pixel coordinate across consecutive
4301 calls to scroll-up, scroll-down and other commands that
4302 have the `scroll-command' property. This avoids the
4303 possibility of point becoming "stuck" on a tall line when
4304 scrolling by one line. */
4305 if (window_scroll_pixel_based_preserve_y
< 0
4306 || !SYMBOLP (KVAR (current_kboard
, Vlast_command
))
4307 || NILP (Fget (KVAR (current_kboard
, Vlast_command
), Qscroll_command
)))
4309 start_display (&it
, w
, start
);
4310 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
4311 window_scroll_pixel_based_preserve_y
= it
.current_y
;
4312 window_scroll_pixel_based_preserve_x
= it
.current_x
;
4316 window_scroll_pixel_based_preserve_y
4317 = window_scroll_pixel_based_preserve_x
= -1;
4319 /* Move iterator it from start the specified distance forward or
4320 backward. The result is the new window start. */
4321 start_display (&it
, w
, start
);
4324 ptrdiff_t start_pos
= IT_CHARPOS (it
);
4325 int dy
= WINDOW_FRAME_LINE_HEIGHT (w
);
4326 dy
= max ((window_box_height (w
)
4327 - next_screen_context_lines
* dy
),
4330 /* Note that move_it_vertically always moves the iterator to the
4331 start of a line. So, if the last line doesn't have a newline,
4332 we would end up at the start of the line ending at ZV. */
4335 move_it_vertically_backward (&it
, -dy
);
4336 /* Ensure we actually do move, e.g. in case we are currently
4337 looking at an image that is taller that the window height. */
4338 while (start_pos
== IT_CHARPOS (it
)
4339 && start_pos
> BEGV
)
4340 move_it_by_lines (&it
, -1);
4344 move_it_to (&it
, ZV
, -1, it
.current_y
+ dy
, -1,
4345 MOVE_TO_POS
| MOVE_TO_Y
);
4346 /* Ensure we actually do move, e.g. in case we are currently
4347 looking at an image that is taller that the window height. */
4348 while (start_pos
== IT_CHARPOS (it
)
4350 move_it_by_lines (&it
, 1);
4354 move_it_by_lines (&it
, n
);
4356 /* We failed if we find ZV is already on the screen (scrolling up,
4357 means there's nothing past the end), or if we can't start any
4358 earlier (scrolling down, means there's nothing past the top). */
4359 if ((n
> 0 && IT_CHARPOS (it
) == ZV
)
4360 || (n
< 0 && IT_CHARPOS (it
) == CHARPOS (start
)))
4362 if (IT_CHARPOS (it
) == ZV
)
4364 if (it
.current_y
< it
.last_visible_y
4365 && (it
.current_y
+ it
.max_ascent
+ it
.max_descent
4366 > it
.last_visible_y
))
4368 /* The last line was only partially visible, make it fully
4370 w
->vscroll
= (it
.last_visible_y
4371 - it
.current_y
+ it
.max_ascent
+ it
.max_descent
);
4372 adjust_glyphs (it
.f
);
4376 bidi_unshelve_cache (itdata
, 0);
4379 else if (n
< 0) /* could happen with empty buffers */
4380 xsignal0 (Qbeginning_of_buffer
);
4382 xsignal0 (Qend_of_buffer
);
4387 if (w
->vscroll
!= 0)
4388 /* The first line was only partially visible, make it fully
4393 bidi_unshelve_cache (itdata
, 0);
4397 xsignal0 (Qbeginning_of_buffer
);
4401 /* If control gets here, then we vscrolled. */
4403 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
4405 /* Don't try to change the window start below. */
4411 ptrdiff_t pos
= IT_CHARPOS (it
);
4414 /* If in the middle of a multi-glyph character move forward to
4415 the next character. */
4416 if (in_display_vector_p (&it
))
4419 move_it_to (&it
, pos
, -1, -1, -1, MOVE_TO_POS
);
4422 /* Set the window start, and set up the window for redisplay. */
4423 set_marker_restricted (w
->start
, make_number (pos
),
4425 bytepos
= XMARKER (w
->start
)->bytepos
;
4426 w
->start_at_line_beg
= ((pos
== BEGV
|| FETCH_BYTE (bytepos
- 1) == '\n')
4428 w
->update_mode_line
= Qt
;
4429 XSETFASTINT (w
->last_modified
, 0);
4430 XSETFASTINT (w
->last_overlay_modified
, 0);
4431 /* Set force_start so that redisplay_window will run the
4432 window-scroll-functions. */
4433 w
->force_start
= Qt
;
4436 /* The rest of this function uses current_y in a nonstandard way,
4437 not including the height of the header line if any. */
4438 it
.current_y
= it
.vpos
= 0;
4440 /* Move PT out of scroll margins.
4441 This code wants current_y to be zero at the window start position
4442 even if there is a header line. */
4443 this_scroll_margin
= max (0, scroll_margin
);
4444 this_scroll_margin
= min (this_scroll_margin
, XFASTINT (w
->total_lines
) / 4);
4445 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
4449 /* We moved the window start towards ZV, so PT may be now
4450 in the scroll margin at the top. */
4451 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
4452 if (IT_CHARPOS (it
) == PT
&& it
.current_y
>= this_scroll_margin
4453 && (NILP (Vscroll_preserve_screen_position
)
4454 || EQ (Vscroll_preserve_screen_position
, Qt
)))
4455 /* We found PT at a legitimate height. Leave it alone. */
4457 else if (window_scroll_pixel_based_preserve_y
>= 0)
4459 /* If we have a header line, take account of it.
4460 This is necessary because we set it.current_y to 0, above. */
4461 move_it_to (&it
, -1,
4462 window_scroll_pixel_based_preserve_x
,
4463 window_scroll_pixel_based_preserve_y
4464 - (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0 ),
4465 -1, MOVE_TO_Y
| MOVE_TO_X
);
4466 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
4470 while (it
.current_y
< this_scroll_margin
)
4472 int prev
= it
.current_y
;
4473 move_it_by_lines (&it
, 1);
4474 if (prev
== it
.current_y
)
4477 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
4482 ptrdiff_t charpos
, bytepos
;
4485 /* Save our position, for the
4486 window_scroll_pixel_based_preserve_y case. */
4487 charpos
= IT_CHARPOS (it
);
4488 bytepos
= IT_BYTEPOS (it
);
4490 /* We moved the window start towards BEGV, so PT may be now
4491 in the scroll margin at the bottom. */
4492 move_it_to (&it
, PT
, -1,
4493 (it
.last_visible_y
- CURRENT_HEADER_LINE_HEIGHT (w
)
4494 - this_scroll_margin
- 1),
4496 MOVE_TO_POS
| MOVE_TO_Y
);
4498 /* Save our position, in case it's correct. */
4499 charpos
= IT_CHARPOS (it
);
4500 bytepos
= IT_BYTEPOS (it
);
4502 /* See if point is on a partially visible line at the end. */
4503 if (it
.what
== IT_EOB
)
4504 partial_p
= it
.current_y
+ it
.ascent
+ it
.descent
> it
.last_visible_y
;
4507 move_it_by_lines (&it
, 1);
4508 partial_p
= it
.current_y
> it
.last_visible_y
;
4511 if (charpos
== PT
&& !partial_p
4512 && (NILP (Vscroll_preserve_screen_position
)
4513 || EQ (Vscroll_preserve_screen_position
, Qt
)))
4514 /* We found PT before we found the display margin, so PT is ok. */
4516 else if (window_scroll_pixel_based_preserve_y
>= 0)
4518 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
4519 start_display (&it
, w
, start
);
4520 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
4521 here because we called start_display again and did not
4522 alter it.current_y this time. */
4523 move_it_to (&it
, -1, window_scroll_pixel_based_preserve_x
,
4524 window_scroll_pixel_based_preserve_y
, -1,
4525 MOVE_TO_Y
| MOVE_TO_X
);
4526 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
4531 /* The last line was only partially visible, so back up two
4532 lines to make sure we're on a fully visible line. */
4534 move_it_by_lines (&it
, -2);
4535 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
4538 /* No, the position we saved is OK, so use it. */
4539 SET_PT_BOTH (charpos
, bytepos
);
4542 bidi_unshelve_cache (itdata
, 0);
4546 /* Implementation of window_scroll that works based on screen lines.
4547 See the comment of window_scroll for parameter descriptions. */
4550 window_scroll_line_based (Lisp_Object window
, int n
, int whole
, int noerror
)
4552 register struct window
*w
= XWINDOW (window
);
4553 /* Fvertical_motion enters redisplay, which can trigger
4554 fontification, which in turn can modify buffer text (e.g., if the
4555 fontification functions replace escape sequences with faces, as
4556 in `grep-mode-font-lock-keywords'). So we use a marker to record
4557 the old point position, to prevent crashes in SET_PT_BOTH. */
4558 Lisp_Object opoint_marker
= Fpoint_marker ();
4559 register ptrdiff_t pos
, pos_byte
;
4560 register int ht
= window_internal_height (w
);
4561 register Lisp_Object tem
;
4565 Lisp_Object original_pos
= Qnil
;
4567 /* If scrolling screen-fulls, compute the number of lines to
4568 scroll from the window's height. */
4570 n
*= max (1, ht
- next_screen_context_lines
);
4572 startpos
= marker_position (w
->start
);
4574 if (!NILP (Vscroll_preserve_screen_position
))
4576 if (window_scroll_preserve_vpos
<= 0
4577 || !SYMBOLP (KVAR (current_kboard
, Vlast_command
))
4578 || NILP (Fget (KVAR (current_kboard
, Vlast_command
), Qscroll_command
)))
4580 struct position posit
4581 = *compute_motion (startpos
, 0, 0, 0,
4583 -1, XINT (w
->hscroll
),
4585 window_scroll_preserve_vpos
= posit
.vpos
;
4586 window_scroll_preserve_hpos
= posit
.hpos
+ XINT (w
->hscroll
);
4589 original_pos
= Fcons (make_number (window_scroll_preserve_hpos
),
4590 make_number (window_scroll_preserve_vpos
));
4593 XSETFASTINT (tem
, PT
);
4594 tem
= Fpos_visible_in_window_p (tem
, window
, Qnil
);
4598 Fvertical_motion (make_number (- (ht
/ 2)), window
);
4603 lose
= n
< 0 && PT
== BEGV
;
4604 Fvertical_motion (make_number (n
), window
);
4608 SET_PT_BOTH (marker_position (opoint_marker
),
4609 marker_byte_position (opoint_marker
));
4616 xsignal0 (Qbeginning_of_buffer
);
4621 /* Don't use a scroll margin that is negative or too large. */
4622 int this_scroll_margin
=
4623 max (0, min (scroll_margin
, XINT (w
->total_lines
) / 4));
4625 set_marker_restricted_both (w
->start
, w
->buffer
, pos
, pos_byte
);
4626 w
->start_at_line_beg
= bolp
;
4627 w
->update_mode_line
= Qt
;
4628 XSETFASTINT (w
->last_modified
, 0);
4629 XSETFASTINT (w
->last_overlay_modified
, 0);
4630 /* Set force_start so that redisplay_window will run
4631 the window-scroll-functions. */
4632 w
->force_start
= Qt
;
4634 if (!NILP (Vscroll_preserve_screen_position
)
4635 && (whole
|| !EQ (Vscroll_preserve_screen_position
, Qt
)))
4637 SET_PT_BOTH (pos
, pos_byte
);
4638 Fvertical_motion (original_pos
, window
);
4640 /* If we scrolled forward, put point enough lines down
4641 that it is outside the scroll margin. */
4646 if (this_scroll_margin
> 0)
4648 SET_PT_BOTH (pos
, pos_byte
);
4649 Fvertical_motion (make_number (this_scroll_margin
), window
);
4655 if (top_margin
<= marker_position (opoint_marker
))
4656 SET_PT_BOTH (marker_position (opoint_marker
),
4657 marker_byte_position (opoint_marker
));
4658 else if (!NILP (Vscroll_preserve_screen_position
))
4660 SET_PT_BOTH (pos
, pos_byte
);
4661 Fvertical_motion (original_pos
, window
);
4664 SET_PT (top_margin
);
4670 /* If we scrolled backward, put point near the end of the window
4671 but not within the scroll margin. */
4672 SET_PT_BOTH (pos
, pos_byte
);
4673 tem
= Fvertical_motion (make_number (ht
- this_scroll_margin
), window
);
4674 if (XFASTINT (tem
) == ht
- this_scroll_margin
)
4677 bottom_margin
= PT
+ 1;
4679 if (bottom_margin
> marker_position (opoint_marker
))
4680 SET_PT_BOTH (marker_position (opoint_marker
),
4681 marker_byte_position (opoint_marker
));
4684 if (!NILP (Vscroll_preserve_screen_position
))
4686 SET_PT_BOTH (pos
, pos_byte
);
4687 Fvertical_motion (original_pos
, window
);
4690 Fvertical_motion (make_number (-1), window
);
4699 xsignal0 (Qend_of_buffer
);
4704 /* Scroll selected_window up or down. If N is nil, scroll a
4705 screen-full which is defined as the height of the window minus
4706 next_screen_context_lines. If N is the symbol `-', scroll.
4707 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
4708 up. This is the guts of Fscroll_up and Fscroll_down. */
4711 scroll_command (Lisp_Object n
, int direction
)
4713 ptrdiff_t count
= SPECPDL_INDEX ();
4715 xassert (eabs (direction
) == 1);
4717 /* If selected window's buffer isn't current, make it current for
4718 the moment. But don't screw up if window_scroll gets an error. */
4719 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
4721 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
4722 Fset_buffer (XWINDOW (selected_window
)->buffer
);
4724 /* Make redisplay consider other windows than just selected_window. */
4725 ++windows_or_buffers_changed
;
4729 window_scroll (selected_window
, direction
, 1, 0);
4730 else if (EQ (n
, Qminus
))
4731 window_scroll (selected_window
, -direction
, 1, 0);
4734 n
= Fprefix_numeric_value (n
);
4735 window_scroll (selected_window
, XINT (n
) * direction
, 0, 0);
4738 unbind_to (count
, Qnil
);
4741 DEFUN ("scroll-up", Fscroll_up
, Sscroll_up
, 0, 1, "^P",
4742 doc
: /* Scroll text of selected window upward ARG lines.
4743 If ARG is omitted or nil, scroll upward by a near full screen.
4744 A near full screen is `next-screen-context-lines' less than a full screen.
4745 Negative ARG means scroll downward.
4746 If ARG is the atom `-', scroll downward by nearly full screen.
4747 When calling from a program, supply as argument a number, nil, or `-'. */)
4750 scroll_command (arg
, 1);
4754 DEFUN ("scroll-down", Fscroll_down
, Sscroll_down
, 0, 1, "^P",
4755 doc
: /* Scroll text of selected window down ARG lines.
4756 If ARG is omitted or nil, scroll down by a near full screen.
4757 A near full screen is `next-screen-context-lines' less than a full screen.
4758 Negative ARG means scroll upward.
4759 If ARG is the atom `-', scroll upward by nearly full screen.
4760 When calling from a program, supply as argument a number, nil, or `-'. */)
4763 scroll_command (arg
, -1);
4767 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling
, Sother_window_for_scrolling
, 0, 0, 0,
4768 doc
: /* Return the other window for \"other window scroll\" commands.
4769 If `other-window-scroll-buffer' is non-nil, a window
4770 showing that buffer is used.
4771 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4772 specifies the window. This takes precedence over
4773 `other-window-scroll-buffer'. */)
4778 if (MINI_WINDOW_P (XWINDOW (selected_window
))
4779 && !NILP (Vminibuf_scroll_window
))
4780 window
= Vminibuf_scroll_window
;
4781 /* If buffer is specified, scroll that buffer. */
4782 else if (!NILP (Vother_window_scroll_buffer
))
4784 window
= Fget_buffer_window (Vother_window_scroll_buffer
, Qnil
);
4786 window
= display_buffer (Vother_window_scroll_buffer
, Qt
, Qnil
);
4790 /* Nothing specified; look for a neighboring window on the same
4792 window
= Fnext_window (selected_window
, Qnil
, Qnil
);
4794 if (EQ (window
, selected_window
))
4795 /* That didn't get us anywhere; look for a window on another
4798 window
= Fnext_window (window
, Qnil
, Qt
);
4799 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window
))))
4800 && ! EQ (window
, selected_window
));
4803 CHECK_LIVE_WINDOW (window
);
4805 if (EQ (window
, selected_window
))
4806 error ("There is no other window");
4811 DEFUN ("scroll-other-window", Fscroll_other_window
, Sscroll_other_window
, 0, 1, "P",
4812 doc
: /* Scroll next window upward ARG lines; or near full screen if no ARG.
4813 A near full screen is `next-screen-context-lines' less than a full screen.
4814 The next window is the one below the current one; or the one at the top
4815 if the current one is at the bottom. Negative ARG means scroll downward.
4816 If ARG is the atom `-', scroll downward by nearly full screen.
4817 When calling from a program, supply as argument a number, nil, or `-'.
4819 If `other-window-scroll-buffer' is non-nil, scroll the window
4820 showing that buffer, popping the buffer up if necessary.
4821 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4822 specifies the window to scroll. This takes precedence over
4823 `other-window-scroll-buffer'. */)
4828 ptrdiff_t count
= SPECPDL_INDEX ();
4830 window
= Fother_window_for_scrolling ();
4831 w
= XWINDOW (window
);
4833 /* Don't screw up if window_scroll gets an error. */
4834 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
4835 ++windows_or_buffers_changed
;
4837 Fset_buffer (w
->buffer
);
4838 SET_PT (marker_position (w
->pointm
));
4841 window_scroll (window
, 1, 1, 1);
4842 else if (EQ (arg
, Qminus
))
4843 window_scroll (window
, -1, 1, 1);
4849 window_scroll (window
, XINT (arg
), 0, 1);
4852 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
4853 unbind_to (count
, Qnil
);
4858 DEFUN ("scroll-left", Fscroll_left
, Sscroll_left
, 0, 2, "^P\np",
4859 doc
: /* Scroll selected window display ARG columns left.
4860 Default for ARG is window width minus 2.
4861 Value is the total amount of leftward horizontal scrolling in
4862 effect after the change.
4863 If SET-MINIMUM is non-nil, the new scroll amount becomes the
4864 lower bound for automatic scrolling, i.e. automatic scrolling
4865 will not scroll a window to a column less than the value returned
4866 by this function. This happens in an interactive call. */)
4867 (register Lisp_Object arg
, Lisp_Object set_minimum
)
4871 struct window
*w
= XWINDOW (selected_window
);
4874 XSETFASTINT (arg
, window_body_cols (w
) - 2);
4876 arg
= Fprefix_numeric_value (arg
);
4878 hscroll
= XINT (w
->hscroll
) + XINT (arg
);
4879 result
= Fset_window_hscroll (selected_window
, make_number (hscroll
));
4881 if (!NILP (set_minimum
))
4882 w
->min_hscroll
= w
->hscroll
;
4887 DEFUN ("scroll-right", Fscroll_right
, Sscroll_right
, 0, 2, "^P\np",
4888 doc
: /* Scroll selected window display ARG columns right.
4889 Default for ARG is window width minus 2.
4890 Value is the total amount of leftward horizontal scrolling in
4891 effect after the change.
4892 If SET-MINIMUM is non-nil, the new scroll amount becomes the
4893 lower bound for automatic scrolling, i.e. automatic scrolling
4894 will not scroll a window to a column less than the value returned
4895 by this function. This happens in an interactive call. */)
4896 (register Lisp_Object arg
, Lisp_Object set_minimum
)
4900 struct window
*w
= XWINDOW (selected_window
);
4903 XSETFASTINT (arg
, window_body_cols (w
) - 2);
4905 arg
= Fprefix_numeric_value (arg
);
4907 hscroll
= XINT (w
->hscroll
) - XINT (arg
);
4908 result
= Fset_window_hscroll (selected_window
, make_number (hscroll
));
4910 if (!NILP (set_minimum
))
4911 w
->min_hscroll
= w
->hscroll
;
4916 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window
, Sminibuffer_selected_window
, 0, 0, 0,
4917 doc
: /* Return the window which was selected when entering the minibuffer.
4918 Returns nil, if selected window is not a minibuffer window. */)
4921 if (minibuf_level
> 0
4922 && MINI_WINDOW_P (XWINDOW (selected_window
))
4923 && WINDOW_LIVE_P (minibuf_selected_window
))
4924 return minibuf_selected_window
;
4929 /* Value is the number of lines actually displayed in window W,
4930 as opposed to its height. */
4933 displayed_window_lines (struct window
*w
)
4936 struct text_pos start
;
4937 int height
= window_box_height (w
);
4938 struct buffer
*old_buffer
;
4940 void *itdata
= NULL
;
4942 if (XBUFFER (w
->buffer
) != current_buffer
)
4944 old_buffer
= current_buffer
;
4945 set_buffer_internal (XBUFFER (w
->buffer
));
4950 /* In case W->start is out of the accessible range, do something
4951 reasonable. This happens in Info mode when Info-scroll-down
4952 calls (recenter -1) while W->start is 1. */
4953 if (XMARKER (w
->start
)->charpos
< BEGV
)
4954 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
4955 else if (XMARKER (w
->start
)->charpos
> ZV
)
4956 SET_TEXT_POS (start
, ZV
, ZV_BYTE
);
4958 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
4960 itdata
= bidi_shelve_cache ();
4961 start_display (&it
, w
, start
);
4962 move_it_vertically (&it
, height
);
4963 bottom_y
= line_bottom_y (&it
);
4964 bidi_unshelve_cache (itdata
, 0);
4966 /* rms: On a non-window display,
4967 the value of it.vpos at the bottom of the screen
4968 seems to be 1 larger than window_box_height (w).
4969 This kludge fixes a bug whereby (move-to-window-line -1)
4970 when ZV is on the last screen line
4971 moves to the previous screen line instead of the last one. */
4972 if (! FRAME_WINDOW_P (XFRAME (w
->frame
)))
4975 /* Add in empty lines at the bottom of the window. */
4976 if (bottom_y
< height
)
4978 int uy
= FRAME_LINE_HEIGHT (it
.f
);
4979 it
.vpos
+= (height
- bottom_y
+ uy
- 1) / uy
;
4983 set_buffer_internal (old_buffer
);
4989 DEFUN ("recenter", Frecenter
, Srecenter
, 0, 1, "P",
4990 doc
: /* Center point in selected window and maybe redisplay frame.
4991 With prefix argument ARG, recenter putting point on screen line ARG
4992 relative to the selected window. If ARG is negative, it counts up from the
4993 bottom of the window. (ARG should be less than the height of the window.)
4995 If ARG is omitted or nil, then recenter with point on the middle line of
4996 the selected window; if the variable `recenter-redisplay' is non-nil,
4997 also erase the entire frame and redraw it (when `auto-resize-tool-bars'
4998 is set to `grow-only', this resets the tool-bar's height to the minimum
4999 height needed); if `recenter-redisplay' has the special value `tty',
5000 then only tty frames are redrawn.
5002 Just C-u as prefix means put point in the center of the window
5003 and redisplay normally--don't erase and redraw the frame. */)
5004 (register Lisp_Object arg
)
5006 struct window
*w
= XWINDOW (selected_window
);
5007 struct buffer
*buf
= XBUFFER (w
->buffer
);
5008 struct buffer
*obuf
= current_buffer
;
5010 ptrdiff_t charpos
, bytepos
;
5011 EMACS_INT iarg
IF_LINT (= 0);
5012 int this_scroll_margin
;
5014 /* If redisplay is suppressed due to an error, try again. */
5015 obuf
->display_error_modiff
= 0;
5019 if (!NILP (Vrecenter_redisplay
)
5020 && (!EQ (Vrecenter_redisplay
, Qtty
)
5021 || !NILP (Ftty_type (selected_frame
))))
5025 /* Invalidate pixel data calculated for all compositions. */
5026 for (i
= 0; i
< n_compositions
; i
++)
5027 composition_table
[i
]->font
= NULL
;
5029 WINDOW_XFRAME (w
)->minimize_tool_bar_window_p
= 1;
5031 Fredraw_frame (WINDOW_FRAME (w
));
5032 SET_FRAME_GARBAGED (WINDOW_XFRAME (w
));
5037 else if (CONSP (arg
)) /* Just C-u. */
5041 arg
= Fprefix_numeric_value (arg
);
5046 set_buffer_internal (buf
);
5048 /* Do this after making BUF current
5049 in case scroll_margin is buffer-local. */
5050 this_scroll_margin
=
5051 max (0, min (scroll_margin
, XFASTINT (w
->total_lines
) / 4));
5053 /* Handle centering on a graphical frame specially. Such frames can
5054 have variable-height lines and centering point on the basis of
5055 line counts would lead to strange effects. */
5056 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
5062 void *itdata
= bidi_shelve_cache ();
5064 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
5065 start_display (&it
, w
, pt
);
5066 move_it_vertically_backward (&it
, window_box_height (w
) / 2);
5067 charpos
= IT_CHARPOS (it
);
5068 bytepos
= IT_BYTEPOS (it
);
5069 bidi_unshelve_cache (itdata
, 0);
5075 ptrdiff_t nlines
= min (PTRDIFF_MAX
, -iarg
);
5076 int extra_line_spacing
;
5077 int h
= window_box_height (w
);
5078 void *itdata
= bidi_shelve_cache ();
5080 iarg
= - max (-iarg
, this_scroll_margin
);
5082 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
5083 start_display (&it
, w
, pt
);
5085 /* Be sure we have the exact height of the full line containing PT. */
5086 move_it_by_lines (&it
, 0);
5088 /* The amount of pixels we have to move back is the window
5089 height minus what's displayed in the line containing PT,
5090 and the lines below. */
5093 move_it_by_lines (&it
, nlines
);
5095 if (it
.vpos
== nlines
)
5099 /* Last line has no newline */
5100 h
-= line_bottom_y (&it
);
5104 /* Don't reserve space for extra line spacing of last line. */
5105 extra_line_spacing
= it
.max_extra_line_spacing
;
5107 /* If we can't move down NLINES lines because we hit
5108 the end of the buffer, count in some empty lines. */
5109 if (it
.vpos
< nlines
)
5112 extra_line_spacing
= it
.extra_line_spacing
;
5113 h
-= nlines
* (FRAME_LINE_HEIGHT (it
.f
) + extra_line_spacing
);
5117 bidi_unshelve_cache (itdata
, 0);
5121 /* Now find the new top line (starting position) of the window. */
5122 start_display (&it
, w
, pt
);
5124 move_it_vertically_backward (&it
, h
);
5126 /* If extra line spacing is present, we may move too far
5127 back. This causes the last line to be only partially
5128 visible (which triggers redisplay to recenter that line
5129 in the middle), so move forward.
5130 But ignore extra line spacing on last line, as it is not
5131 considered to be part of the visible height of the line.
5133 h
+= extra_line_spacing
;
5134 while (-it
.current_y
> h
)
5135 move_it_by_lines (&it
, 1);
5137 charpos
= IT_CHARPOS (it
);
5138 bytepos
= IT_BYTEPOS (it
);
5140 bidi_unshelve_cache (itdata
, 0);
5144 struct position pos
;
5146 iarg
= max (iarg
, this_scroll_margin
);
5148 pos
= *vmotion (PT
, -iarg
, w
);
5149 charpos
= pos
.bufpos
;
5150 bytepos
= pos
.bytepos
;
5155 struct position pos
;
5156 int ht
= window_internal_height (w
);
5163 /* Don't let it get into the margin at either top or bottom. */
5164 iarg
= max (iarg
, this_scroll_margin
);
5165 iarg
= min (iarg
, ht
- this_scroll_margin
- 1);
5167 pos
= *vmotion (PT
, - iarg
, w
);
5168 charpos
= pos
.bufpos
;
5169 bytepos
= pos
.bytepos
;
5172 /* Set the new window start. */
5173 set_marker_both (w
->start
, w
->buffer
, charpos
, bytepos
);
5174 w
->window_end_valid
= Qnil
;
5176 w
->optional_new_start
= Qt
;
5178 if (bytepos
== BEGV_BYTE
|| FETCH_BYTE (bytepos
- 1) == '\n')
5179 w
->start_at_line_beg
= Qt
;
5181 w
->start_at_line_beg
= Qnil
;
5183 set_buffer_internal (obuf
);
5187 DEFUN ("window-text-height", Fwindow_text_height
, Swindow_text_height
,
5189 doc
: /* Return the height in lines of the text display area of WINDOW.
5190 If WINDOW is omitted or nil, it defaults to the selected window.
5192 The returned height does not include the mode line, any header line,
5193 nor any partial-height lines at the bottom of the text area. */)
5194 (Lisp_Object window
)
5196 struct window
*w
= decode_window (window
);
5197 int pixel_height
= window_box_height (w
);
5198 int line_height
= pixel_height
/ FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
5199 return make_number (line_height
);
5204 DEFUN ("move-to-window-line", Fmove_to_window_line
, Smove_to_window_line
,
5206 doc
: /* Position point relative to window.
5207 ARG nil means position point at center of window.
5208 Else, ARG specifies vertical position within the window;
5209 zero means top of window, negative means relative to bottom of window. */)
5212 struct window
*w
= XWINDOW (selected_window
);
5216 int this_scroll_margin
;
5219 if (!(BUFFERP (w
->buffer
)
5220 && XBUFFER (w
->buffer
) == current_buffer
))
5221 /* This test is needed to make sure PT/PT_BYTE make sense in w->buffer
5222 when passed below to set_marker_both. */
5223 error ("move-to-window-line called from unrelated buffer");
5225 window
= selected_window
;
5226 start
= marker_position (w
->start
);
5227 if (start
< BEGV
|| start
> ZV
)
5229 int height
= window_internal_height (w
);
5230 Fvertical_motion (make_number (- (height
/ 2)), window
);
5231 set_marker_both (w
->start
, w
->buffer
, PT
, PT_BYTE
);
5232 w
->start_at_line_beg
= Fbolp ();
5233 w
->force_start
= Qt
;
5236 Fgoto_char (w
->start
);
5238 lines
= displayed_window_lines (w
);
5241 this_scroll_margin
= max (0, min (scroll_margin
, lines
/ 4));
5245 XSETFASTINT (arg
, lines
/ 2);
5248 EMACS_INT iarg
= XINT (Fprefix_numeric_value (arg
));
5251 iarg
= iarg
+ lines
;
5253 #if 0 /* This code would prevent move-to-window-line from moving point
5254 to a place inside the scroll margins (which would cause the
5255 next redisplay to scroll). I wrote this code, but then concluded
5256 it is probably better not to install it. However, it is here
5257 inside #if 0 so as not to lose it. -- rms. */
5259 /* Don't let it get into the margin at either top or bottom. */
5260 iarg
= max (iarg
, this_scroll_margin
);
5261 iarg
= min (iarg
, lines
- this_scroll_margin
- 1);
5264 arg
= make_number (iarg
);
5267 /* Skip past a partially visible first line. */
5269 XSETINT (arg
, XINT (arg
) + 1);
5271 return Fvertical_motion (arg
, window
);
5276 /***********************************************************************
5277 Window Configuration
5278 ***********************************************************************/
5280 struct save_window_data
5282 struct vectorlike_header header
;
5283 Lisp_Object selected_frame
;
5284 Lisp_Object current_window
;
5285 Lisp_Object current_buffer
;
5286 Lisp_Object minibuf_scroll_window
;
5287 Lisp_Object minibuf_selected_window
;
5288 Lisp_Object root_window
;
5289 Lisp_Object focus_frame
;
5290 /* A vector, each of whose elements is a struct saved_window
5292 Lisp_Object saved_windows
;
5294 /* All fields above are traced by the GC.
5295 From `fame-cols' down, the fields are ignored by the GC. */
5297 int frame_cols
, frame_lines
, frame_menu_bar_lines
;
5298 int frame_tool_bar_lines
;
5301 /* This is saved as a Lisp_Vector */
5304 struct vectorlike_header header
;
5306 Lisp_Object window
, buffer
, start
, pointm
, mark
;
5307 Lisp_Object left_col
, top_line
, total_cols
, total_lines
;
5308 Lisp_Object normal_cols
, normal_lines
;
5309 Lisp_Object hscroll
, min_hscroll
;
5310 Lisp_Object parent
, prev
;
5311 Lisp_Object start_at_line_beg
;
5312 Lisp_Object display_table
;
5313 Lisp_Object left_margin_cols
, right_margin_cols
;
5314 Lisp_Object left_fringe_width
, right_fringe_width
, fringes_outside_margins
;
5315 Lisp_Object scroll_bar_width
, vertical_scroll_bar_type
, dedicated
;
5316 Lisp_Object combination_limit
, window_parameters
;
5319 #define SAVED_WINDOW_N(swv,n) \
5320 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5322 DEFUN ("window-configuration-p", Fwindow_configuration_p
, Swindow_configuration_p
, 1, 1, 0,
5323 doc
: /* Return t if OBJECT is a window-configuration object. */)
5324 (Lisp_Object object
)
5326 return WINDOW_CONFIGURATIONP (object
) ? Qt
: Qnil
;
5329 DEFUN ("window-configuration-frame", Fwindow_configuration_frame
, Swindow_configuration_frame
, 1, 1, 0,
5330 doc
: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5331 (Lisp_Object config
)
5333 register struct save_window_data
*data
;
5334 struct Lisp_Vector
*saved_windows
;
5336 CHECK_WINDOW_CONFIGURATION (config
);
5338 data
= (struct save_window_data
*) XVECTOR (config
);
5339 saved_windows
= XVECTOR (data
->saved_windows
);
5340 return XWINDOW (SAVED_WINDOW_N (saved_windows
, 0)->window
)->frame
;
5343 DEFUN ("set-window-configuration", Fset_window_configuration
,
5344 Sset_window_configuration
, 1, 1, 0,
5345 doc
: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5346 CONFIGURATION must be a value previously returned
5347 by `current-window-configuration' (which see).
5348 If CONFIGURATION was made from a frame that is now deleted,
5349 only frame-independent values can be restored. In this case,
5350 the return value is nil. Otherwise the value is t. */)
5351 (Lisp_Object configuration
)
5353 register struct save_window_data
*data
;
5354 struct Lisp_Vector
*saved_windows
;
5355 Lisp_Object new_current_buffer
;
5357 Lisp_Object auto_buffer_name
;
5359 ptrdiff_t old_point
= -1;
5361 CHECK_WINDOW_CONFIGURATION (configuration
);
5363 data
= (struct save_window_data
*) XVECTOR (configuration
);
5364 saved_windows
= XVECTOR (data
->saved_windows
);
5366 new_current_buffer
= data
->current_buffer
;
5367 if (NILP (BVAR (XBUFFER (new_current_buffer
), name
)))
5368 new_current_buffer
= Qnil
;
5371 if (XBUFFER (new_current_buffer
) == current_buffer
)
5372 /* The code further down "preserves point" by saving here PT in
5373 old_point and then setting it later back into PT. When the
5374 current-selected-window and the final-selected-window both show
5375 the current buffer, this suffers from the problem that the
5376 current PT is the window-point of the current-selected-window,
5377 while the final PT is the point of the final-selected-window, so
5378 this copy from one PT to the other would end up moving the
5379 window-point of the final-selected-window to the window-point of
5380 the current-selected-window. So we have to be careful which
5381 point of the current-buffer we copy into old_point. */
5382 if (EQ (XWINDOW (data
->current_window
)->buffer
, new_current_buffer
)
5383 && WINDOWP (selected_window
)
5384 && EQ (XWINDOW (selected_window
)->buffer
, new_current_buffer
)
5385 && !EQ (selected_window
, data
->current_window
))
5386 old_point
= XMARKER (XWINDOW (data
->current_window
)->pointm
)->charpos
;
5390 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
5391 point in new_current_buffer as of the last time this buffer was
5392 used. This can be non-deterministic since it can be changed by
5393 things like jit-lock by mere temporary selection of some random
5394 window that happens to show this buffer.
5395 So if possible we want this arbitrary choice of "which point" to
5396 be the one from the to-be-selected-window so as to prevent this
5397 window's cursor from being copied from another window. */
5398 if (EQ (XWINDOW (data
->current_window
)->buffer
, new_current_buffer
)
5399 /* If current_window = selected_window, its point is in BUF_PT. */
5400 && !EQ (selected_window
, data
->current_window
))
5401 old_point
= XMARKER (XWINDOW (data
->current_window
)->pointm
)->charpos
;
5403 old_point
= BUF_PT (XBUFFER (new_current_buffer
));
5406 frame
= XWINDOW (SAVED_WINDOW_N (saved_windows
, 0)->window
)->frame
;
5409 /* If f is a dead frame, don't bother rebuilding its window tree.
5410 However, there is other stuff we should still try to do below. */
5411 if (FRAME_LIVE_P (f
))
5414 Lisp_Object dead_windows
= Qnil
;
5415 register struct window
*w
;
5416 register struct saved_window
*p
;
5417 struct window
*root_window
;
5418 struct window
**leaf_windows
;
5423 /* If the frame has been resized since this window configuration was
5424 made, we change the frame to the size specified in the
5425 configuration, restore the configuration, and then resize it
5426 back. We keep track of the prevailing height in these variables. */
5427 int previous_frame_lines
= FRAME_LINES (f
);
5428 int previous_frame_cols
= FRAME_COLS (f
);
5429 int previous_frame_menu_bar_lines
= FRAME_MENU_BAR_LINES (f
);
5430 int previous_frame_tool_bar_lines
= FRAME_TOOL_BAR_LINES (f
);
5432 /* The mouse highlighting code could get screwed up
5433 if it runs during this. */
5436 if (data
->frame_lines
!= previous_frame_lines
5437 || data
->frame_cols
!= previous_frame_cols
)
5438 change_frame_size (f
, data
->frame_lines
,
5439 data
->frame_cols
, 0, 0, 0);
5440 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5441 if (data
->frame_menu_bar_lines
5442 != previous_frame_menu_bar_lines
)
5443 x_set_menu_bar_lines (f
, make_number (data
->frame_menu_bar_lines
),
5445 #ifdef HAVE_WINDOW_SYSTEM
5446 if (data
->frame_tool_bar_lines
5447 != previous_frame_tool_bar_lines
)
5448 x_set_tool_bar_lines (f
, make_number (data
->frame_tool_bar_lines
),
5453 /* "Swap out" point from the selected window's buffer
5454 into the window itself. (Normally the pointm of the selected
5455 window holds garbage.) We do this now, before
5456 restoring the window contents, and prevent it from
5457 being done later on when we select a new window. */
5458 if (! NILP (XWINDOW (selected_window
)->buffer
))
5460 w
= XWINDOW (selected_window
);
5461 set_marker_both (w
->pointm
,
5463 BUF_PT (XBUFFER (w
->buffer
)),
5464 BUF_PT_BYTE (XBUFFER (w
->buffer
)));
5467 windows_or_buffers_changed
++;
5468 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
5470 /* Problem: Freeing all matrices and later allocating them again
5471 is a serious redisplay flickering problem. What we would
5472 really like to do is to free only those matrices not reused
5474 root_window
= XWINDOW (FRAME_ROOT_WINDOW (f
));
5476 = (struct window
**) alloca (count_windows (root_window
)
5477 * sizeof (struct window
*));
5478 n_leaf_windows
= get_leaf_windows (root_window
, leaf_windows
, 0);
5481 Mark all windows now on frame as "deleted".
5482 Restoring the new configuration "undeletes" any that are in it.
5484 Save their current buffers in their height fields, since we may
5485 need it later, if a buffer saved in the configuration is now
5487 delete_all_child_windows (FRAME_ROOT_WINDOW (f
));
5489 for (k
= 0; k
< saved_windows
->header
.size
; k
++)
5491 p
= SAVED_WINDOW_N (saved_windows
, k
);
5493 w
= XWINDOW (window
);
5496 if (!NILP (p
->parent
))
5497 w
->parent
= SAVED_WINDOW_N (saved_windows
,
5498 XFASTINT (p
->parent
))->window
;
5502 if (!NILP (p
->prev
))
5504 w
->prev
= SAVED_WINDOW_N (saved_windows
,
5505 XFASTINT (p
->prev
))->window
;
5506 XWINDOW (w
->prev
)->next
= p
->window
;
5511 if (!NILP (w
->parent
))
5513 if (EQ (p
->total_cols
, XWINDOW (w
->parent
)->total_cols
))
5515 XWINDOW (w
->parent
)->vchild
= p
->window
;
5516 XWINDOW (w
->parent
)->hchild
= Qnil
;
5520 XWINDOW (w
->parent
)->hchild
= p
->window
;
5521 XWINDOW (w
->parent
)->vchild
= Qnil
;
5526 /* If we squirreled away the buffer in the window's height,
5528 if (BUFFERP (w
->total_lines
))
5529 w
->buffer
= w
->total_lines
;
5530 w
->left_col
= p
->left_col
;
5531 w
->top_line
= p
->top_line
;
5532 w
->total_cols
= p
->total_cols
;
5533 w
->total_lines
= p
->total_lines
;
5534 w
->normal_cols
= p
->normal_cols
;
5535 w
->normal_lines
= p
->normal_lines
;
5536 w
->hscroll
= p
->hscroll
;
5537 w
->min_hscroll
= p
->min_hscroll
;
5538 w
->display_table
= p
->display_table
;
5539 w
->left_margin_cols
= p
->left_margin_cols
;
5540 w
->right_margin_cols
= p
->right_margin_cols
;
5541 w
->left_fringe_width
= p
->left_fringe_width
;
5542 w
->right_fringe_width
= p
->right_fringe_width
;
5543 w
->fringes_outside_margins
= p
->fringes_outside_margins
;
5544 w
->scroll_bar_width
= p
->scroll_bar_width
;
5545 w
->vertical_scroll_bar_type
= p
->vertical_scroll_bar_type
;
5546 w
->dedicated
= p
->dedicated
;
5547 w
->combination_limit
= p
->combination_limit
;
5548 w
->window_parameters
= p
->window_parameters
;
5549 XSETFASTINT (w
->last_modified
, 0);
5550 XSETFASTINT (w
->last_overlay_modified
, 0);
5552 /* Reinstall the saved buffer and pointers into it. */
5553 if (NILP (p
->buffer
))
5554 /* An internal window. */
5555 w
->buffer
= p
->buffer
;
5556 else if (!NILP (BVAR (XBUFFER (p
->buffer
), name
)))
5557 /* If saved buffer is alive, install it. */
5559 w
->buffer
= p
->buffer
;
5560 w
->start_at_line_beg
= p
->start_at_line_beg
;
5561 set_marker_restricted (w
->start
, p
->start
, w
->buffer
);
5562 set_marker_restricted (w
->pointm
, p
->pointm
, w
->buffer
);
5563 Fset_marker (BVAR (XBUFFER (w
->buffer
), mark
),
5564 p
->mark
, w
->buffer
);
5566 /* As documented in Fcurrent_window_configuration, don't
5567 restore the location of point in the buffer which was
5568 current when the window configuration was recorded. */
5569 if (!EQ (p
->buffer
, new_current_buffer
)
5570 && XBUFFER (p
->buffer
) == current_buffer
)
5571 Fgoto_char (w
->pointm
);
5573 else if (!NILP (w
->buffer
) && !NILP (BVAR (XBUFFER (w
->buffer
), name
)))
5574 /* Keep window's old buffer; make sure the markers are
5577 /* Set window markers at start of visible range. */
5578 if (XMARKER (w
->start
)->buffer
== 0)
5579 set_marker_restricted (w
->start
, make_number (0),
5581 if (XMARKER (w
->pointm
)->buffer
== 0)
5582 set_marker_restricted_both (w
->pointm
, w
->buffer
,
5583 BUF_PT (XBUFFER (w
->buffer
)),
5584 BUF_PT_BYTE (XBUFFER (w
->buffer
)));
5585 w
->start_at_line_beg
= Qt
;
5587 else if (STRINGP (auto_buffer_name
=
5588 Fwindow_parameter (window
, Qauto_buffer_name
))
5589 && SCHARS (auto_buffer_name
) != 0
5590 && !NILP (w
->buffer
= Fget_buffer_create (auto_buffer_name
)))
5592 set_marker_restricted (w
->start
, make_number (0), w
->buffer
);
5593 set_marker_restricted (w
->pointm
, make_number (0), w
->buffer
);
5594 w
->start_at_line_beg
= Qt
;
5597 /* Window has no live buffer, get one. */
5599 /* Get the buffer via other_buffer_safely in order to
5600 avoid showing an unimportant buffer and, if necessary, to
5601 recreate *scratch* in the course (part of Juanma's bs-show
5602 scenario from March 2011). */
5603 w
->buffer
= other_buffer_safely (Fcurrent_buffer ());
5604 /* This will set the markers to beginning of visible
5606 set_marker_restricted (w
->start
, make_number (0), w
->buffer
);
5607 set_marker_restricted (w
->pointm
, make_number (0), w
->buffer
);
5608 w
->start_at_line_beg
= Qt
;
5609 if (!NILP (w
->dedicated
))
5610 /* Record this window as dead. */
5611 dead_windows
= Fcons (window
, dead_windows
);
5612 /* Make sure window is no more dedicated. */
5613 w
->dedicated
= Qnil
;
5617 FRAME_ROOT_WINDOW (f
) = data
->root_window
;
5618 /* Arrange *not* to restore point in the buffer that was
5619 current when the window configuration was saved. */
5620 if (EQ (XWINDOW (data
->current_window
)->buffer
, new_current_buffer
))
5621 set_marker_restricted (XWINDOW (data
->current_window
)->pointm
,
5622 make_number (old_point
),
5623 XWINDOW (data
->current_window
)->buffer
);
5625 /* In the following call to `select-window', prevent "swapping out
5626 point" in the old selected window using the buffer that has
5627 been restored into it. We already swapped out that point from
5628 that window's old buffer. */
5629 select_window (data
->current_window
, Qnil
, 1);
5630 BVAR (XBUFFER (XWINDOW (selected_window
)->buffer
), last_selected_window
)
5633 if (NILP (data
->focus_frame
)
5634 || (FRAMEP (data
->focus_frame
)
5635 && FRAME_LIVE_P (XFRAME (data
->focus_frame
))))
5636 Fredirect_frame_focus (frame
, data
->focus_frame
);
5638 /* Set the screen height to the value it had before this function. */
5639 if (previous_frame_lines
!= FRAME_LINES (f
)
5640 || previous_frame_cols
!= FRAME_COLS (f
))
5641 change_frame_size (f
, previous_frame_lines
, previous_frame_cols
,
5643 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5644 if (previous_frame_menu_bar_lines
!= FRAME_MENU_BAR_LINES (f
))
5645 x_set_menu_bar_lines (f
, make_number (previous_frame_menu_bar_lines
),
5647 #ifdef HAVE_WINDOW_SYSTEM
5648 if (previous_frame_tool_bar_lines
!= FRAME_TOOL_BAR_LINES (f
))
5649 x_set_tool_bar_lines (f
, make_number (previous_frame_tool_bar_lines
),
5654 /* Now, free glyph matrices in windows that were not reused. */
5655 for (i
= n
= 0; i
< n_leaf_windows
; ++i
)
5657 if (NILP (leaf_windows
[i
]->buffer
))
5659 /* Assert it's not reused as a combination. */
5660 xassert (NILP (leaf_windows
[i
]->hchild
)
5661 && NILP (leaf_windows
[i
]->vchild
));
5662 free_window_matrices (leaf_windows
[i
]);
5664 else if (EQ (leaf_windows
[i
]->buffer
, new_current_buffer
))
5671 /* Scan dead buffer windows. */
5672 for (; CONSP (dead_windows
); dead_windows
= XCDR (dead_windows
))
5674 window
= XCAR (dead_windows
);
5675 if (WINDOW_LIVE_P (window
) && !EQ (window
, FRAME_ROOT_WINDOW (f
)))
5676 delete_deletable_window (window
);
5679 /* Fselect_window will have made f the selected frame, so we
5680 reselect the proper frame here. Fhandle_switch_frame will change the
5681 selected window too, but that doesn't make the call to
5682 Fselect_window above totally superfluous; it still sets f's
5684 if (FRAME_LIVE_P (XFRAME (data
->selected_frame
)))
5685 do_switch_frame (data
->selected_frame
, 0, 0, Qnil
);
5687 run_window_configuration_change_hook (f
);
5690 if (!NILP (new_current_buffer
))
5691 Fset_buffer (new_current_buffer
);
5693 Vminibuf_scroll_window
= data
->minibuf_scroll_window
;
5694 minibuf_selected_window
= data
->minibuf_selected_window
;
5696 return (FRAME_LIVE_P (f
) ? Qt
: Qnil
);
5700 /* Recursively delete all child windows reachable via the next, vchild,
5701 and hchild slots of WINDOW. */
5703 delete_all_child_windows (Lisp_Object window
)
5705 register struct window
*w
;
5707 w
= XWINDOW (window
);
5709 if (!NILP (w
->next
))
5710 /* Delete WINDOW's siblings (we traverse postorderly). */
5711 delete_all_child_windows (w
->next
);
5713 w
->total_lines
= w
->buffer
; /* See Fset_window_configuration for excuse. */
5715 if (!NILP (w
->vchild
))
5717 delete_all_child_windows (w
->vchild
);
5720 else if (!NILP (w
->hchild
))
5722 delete_all_child_windows (w
->hchild
);
5725 else if (!NILP (w
->buffer
))
5728 unchain_marker (XMARKER (w
->pointm
));
5729 unchain_marker (XMARKER (w
->start
));
5733 Vwindow_list
= Qnil
;
5737 count_windows (register struct window
*window
)
5739 register int count
= 1;
5740 if (!NILP (window
->next
))
5741 count
+= count_windows (XWINDOW (window
->next
));
5742 if (!NILP (window
->vchild
))
5743 count
+= count_windows (XWINDOW (window
->vchild
));
5744 if (!NILP (window
->hchild
))
5745 count
+= count_windows (XWINDOW (window
->hchild
));
5750 /* Fill vector FLAT with leaf windows under W, starting at index I.
5751 Value is last index + 1. */
5753 get_leaf_windows (struct window
*w
, struct window
**flat
, int i
)
5757 if (!NILP (w
->hchild
))
5758 i
= get_leaf_windows (XWINDOW (w
->hchild
), flat
, i
);
5759 else if (!NILP (w
->vchild
))
5760 i
= get_leaf_windows (XWINDOW (w
->vchild
), flat
, i
);
5764 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
5771 /* Return a pointer to the glyph W's physical cursor is on. Value is
5772 null if W's current matrix is invalid, so that no meaningful glyph
5775 get_phys_cursor_glyph (struct window
*w
)
5777 struct glyph_row
*row
;
5778 struct glyph
*glyph
;
5779 int hpos
= w
->phys_cursor
.hpos
;
5781 if (!(w
->phys_cursor
.vpos
>= 0
5782 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
))
5785 row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
);
5786 if (!row
->enabled_p
)
5789 if (XINT (w
->hscroll
))
5791 /* When the window is hscrolled, cursor hpos can legitimately be
5792 out of bounds, but we draw the cursor at the corresponding
5793 window margin in that case. */
5794 if (!row
->reversed_p
&& hpos
< 0)
5796 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
5797 hpos
= row
->used
[TEXT_AREA
] - 1;
5800 if (row
->used
[TEXT_AREA
] > hpos
5802 glyph
= row
->glyphs
[TEXT_AREA
] + hpos
;
5811 save_window_save (Lisp_Object window
, struct Lisp_Vector
*vector
, int i
)
5813 register struct saved_window
*p
;
5814 register struct window
*w
;
5815 register Lisp_Object tem
;
5817 for (;!NILP (window
); window
= w
->next
)
5819 p
= SAVED_WINDOW_N (vector
, i
);
5820 w
= XWINDOW (window
);
5822 XSETFASTINT (w
->temslot
, i
); i
++;
5824 p
->buffer
= w
->buffer
;
5825 p
->left_col
= w
->left_col
;
5826 p
->top_line
= w
->top_line
;
5827 p
->total_cols
= w
->total_cols
;
5828 p
->total_lines
= w
->total_lines
;
5829 p
->normal_cols
= w
->normal_cols
;
5830 p
->normal_lines
= w
->normal_lines
;
5831 p
->hscroll
= w
->hscroll
;
5832 p
->min_hscroll
= w
->min_hscroll
;
5833 p
->display_table
= w
->display_table
;
5834 p
->left_margin_cols
= w
->left_margin_cols
;
5835 p
->right_margin_cols
= w
->right_margin_cols
;
5836 p
->left_fringe_width
= w
->left_fringe_width
;
5837 p
->right_fringe_width
= w
->right_fringe_width
;
5838 p
->fringes_outside_margins
= w
->fringes_outside_margins
;
5839 p
->scroll_bar_width
= w
->scroll_bar_width
;
5840 p
->vertical_scroll_bar_type
= w
->vertical_scroll_bar_type
;
5841 p
->dedicated
= w
->dedicated
;
5842 p
->combination_limit
= w
->combination_limit
;
5843 p
->window_parameters
= w
->window_parameters
;
5844 if (!NILP (w
->buffer
))
5846 /* Save w's value of point in the window configuration.
5847 If w is the selected window, then get the value of point
5848 from the buffer; pointm is garbage in the selected window. */
5849 if (EQ (window
, selected_window
))
5851 p
->pointm
= Fmake_marker ();
5852 set_marker_both (p
->pointm
, w
->buffer
,
5853 BUF_PT (XBUFFER (w
->buffer
)),
5854 BUF_PT_BYTE (XBUFFER (w
->buffer
)));
5857 p
->pointm
= Fcopy_marker (w
->pointm
, Qnil
);
5859 p
->start
= Fcopy_marker (w
->start
, Qnil
);
5860 p
->start_at_line_beg
= w
->start_at_line_beg
;
5862 tem
= BVAR (XBUFFER (w
->buffer
), mark
);
5863 p
->mark
= Fcopy_marker (tem
, Qnil
);
5870 p
->start_at_line_beg
= Qnil
;
5873 if (NILP (w
->parent
))
5876 p
->parent
= XWINDOW (w
->parent
)->temslot
;
5881 p
->prev
= XWINDOW (w
->prev
)->temslot
;
5883 if (!NILP (w
->vchild
))
5884 i
= save_window_save (w
->vchild
, vector
, i
);
5885 if (!NILP (w
->hchild
))
5886 i
= save_window_save (w
->hchild
, vector
, i
);
5892 DEFUN ("current-window-configuration", Fcurrent_window_configuration
,
5893 Scurrent_window_configuration
, 0, 1, 0,
5894 doc
: /* Return an object representing the current window configuration of FRAME.
5895 If FRAME is nil or omitted, use the selected frame.
5896 This describes the number of windows, their sizes and current buffers,
5897 and for each displayed buffer, where display starts, and the positions of
5898 point and mark. An exception is made for point in the current buffer:
5899 its value is -not- saved.
5900 This also records the currently selected frame, and FRAME's focus
5901 redirection (see `redirect-frame-focus'). */)
5904 register Lisp_Object tem
;
5905 register int n_windows
;
5906 register struct save_window_data
*data
;
5911 frame
= selected_frame
;
5912 CHECK_LIVE_FRAME (frame
);
5915 n_windows
= count_windows (XWINDOW (FRAME_ROOT_WINDOW (f
)));
5916 data
= ALLOCATE_PSEUDOVECTOR (struct save_window_data
, frame_cols
,
5917 PVEC_WINDOW_CONFIGURATION
);
5919 data
->frame_cols
= FRAME_COLS (f
);
5920 data
->frame_lines
= FRAME_LINES (f
);
5921 data
->frame_menu_bar_lines
= FRAME_MENU_BAR_LINES (f
);
5922 data
->frame_tool_bar_lines
= FRAME_TOOL_BAR_LINES (f
);
5923 data
->selected_frame
= selected_frame
;
5924 data
->current_window
= FRAME_SELECTED_WINDOW (f
);
5925 XSETBUFFER (data
->current_buffer
, current_buffer
);
5926 data
->minibuf_scroll_window
= minibuf_level
> 0 ? Vminibuf_scroll_window
: Qnil
;
5927 data
->minibuf_selected_window
= minibuf_level
> 0 ? minibuf_selected_window
: Qnil
;
5928 data
->root_window
= FRAME_ROOT_WINDOW (f
);
5929 data
->focus_frame
= FRAME_FOCUS_FRAME (f
);
5930 tem
= Fmake_vector (make_number (n_windows
), Qnil
);
5931 data
->saved_windows
= tem
;
5932 for (i
= 0; i
< n_windows
; i
++)
5933 XVECTOR (tem
)->contents
[i
]
5934 = Fmake_vector (make_number (VECSIZE (struct saved_window
)), Qnil
);
5935 save_window_save (FRAME_ROOT_WINDOW (f
), XVECTOR (tem
), 0);
5936 XSETWINDOW_CONFIGURATION (tem
, data
);
5940 /***********************************************************************
5942 ***********************************************************************/
5944 DEFUN ("set-window-margins", Fset_window_margins
, Sset_window_margins
,
5946 doc
: /* Set width of marginal areas of window WINDOW.
5947 If WINDOW is nil, set margins of the currently selected window.
5948 Second arg LEFT-WIDTH specifies the number of character cells to
5949 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
5950 does the same for the right marginal area. A nil width parameter
5951 means no margin. */)
5952 (Lisp_Object window
, Lisp_Object left_width
, Lisp_Object right_width
)
5954 struct window
*w
= decode_window (window
);
5956 /* Translate negative or zero widths to nil.
5957 Margins that are too wide have to be checked elsewhere. */
5959 if (!NILP (left_width
))
5961 CHECK_NUMBER (left_width
);
5962 if (XINT (left_width
) <= 0)
5966 if (!NILP (right_width
))
5968 CHECK_NUMBER (right_width
);
5969 if (XINT (right_width
) <= 0)
5973 if (!EQ (w
->left_margin_cols
, left_width
)
5974 || !EQ (w
->right_margin_cols
, right_width
))
5976 w
->left_margin_cols
= left_width
;
5977 w
->right_margin_cols
= right_width
;
5979 adjust_window_margins (w
);
5981 ++windows_or_buffers_changed
;
5982 adjust_glyphs (XFRAME (WINDOW_FRAME (w
)));
5989 DEFUN ("window-margins", Fwindow_margins
, Swindow_margins
,
5991 doc
: /* Get width of marginal areas of window WINDOW.
5992 If WINDOW is omitted or nil, it defaults to the selected window.
5993 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
5994 If a marginal area does not exist, its width will be returned
5996 (Lisp_Object window
)
5998 struct window
*w
= decode_window (window
);
5999 return Fcons (w
->left_margin_cols
, w
->right_margin_cols
);
6004 /***********************************************************************
6006 ***********************************************************************/
6008 DEFUN ("set-window-fringes", Fset_window_fringes
, Sset_window_fringes
,
6010 doc
: /* Set the fringe widths of window WINDOW.
6011 If WINDOW is nil, set the fringe widths of the currently selected
6013 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6014 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6015 fringe width. If a fringe width arg is nil, that means to use the
6016 frame's default fringe width. Default fringe widths can be set with
6017 the command `set-fringe-style'.
6018 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6019 outside of the display margins. By default, fringes are drawn between
6020 display marginal areas and the text area. */)
6021 (Lisp_Object window
, Lisp_Object left_width
, Lisp_Object right_width
, Lisp_Object outside_margins
)
6023 struct window
*w
= decode_window (window
);
6025 if (!NILP (left_width
))
6026 CHECK_NATNUM (left_width
);
6027 if (!NILP (right_width
))
6028 CHECK_NATNUM (right_width
);
6030 /* Do nothing on a tty. */
6031 if (FRAME_WINDOW_P (WINDOW_XFRAME (w
))
6032 && (!EQ (w
->left_fringe_width
, left_width
)
6033 || !EQ (w
->right_fringe_width
, right_width
)
6034 || !EQ (w
->fringes_outside_margins
, outside_margins
)))
6036 w
->left_fringe_width
= left_width
;
6037 w
->right_fringe_width
= right_width
;
6038 w
->fringes_outside_margins
= outside_margins
;
6040 adjust_window_margins (w
);
6042 clear_glyph_matrix (w
->current_matrix
);
6043 w
->window_end_valid
= Qnil
;
6045 ++windows_or_buffers_changed
;
6046 adjust_glyphs (XFRAME (WINDOW_FRAME (w
)));
6053 DEFUN ("window-fringes", Fwindow_fringes
, Swindow_fringes
,
6055 doc
: /* Get width of fringes of window WINDOW.
6056 If WINDOW is omitted or nil, it defaults to the selected window.
6057 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6058 (Lisp_Object window
)
6060 struct window
*w
= decode_window (window
);
6062 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w
)),
6063 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w
)),
6064 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
6065 ? Qt
: Qnil
), Qnil
)));
6070 /***********************************************************************
6072 ***********************************************************************/
6074 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars
,
6075 Sset_window_scroll_bars
, 2, 4, 0,
6076 doc
: /* Set width and type of scroll bars of window WINDOW.
6077 If window is nil, set scroll bars of the currently selected window.
6078 Second parameter WIDTH specifies the pixel width for the scroll bar;
6079 this is automatically adjusted to a multiple of the frame column width.
6080 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6081 bar: left, right, or nil.
6082 If WIDTH is nil, use the frame's scroll-bar width.
6083 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6084 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6085 (Lisp_Object window
, Lisp_Object width
, Lisp_Object vertical_type
, Lisp_Object horizontal_type
)
6087 struct window
*w
= decode_window (window
);
6091 CHECK_RANGED_INTEGER (0, width
, INT_MAX
);
6093 if (XINT (width
) == 0)
6094 vertical_type
= Qnil
;
6097 if (!(NILP (vertical_type
)
6098 || EQ (vertical_type
, Qleft
)
6099 || EQ (vertical_type
, Qright
)
6100 || EQ (vertical_type
, Qt
)))
6101 error ("Invalid type of vertical scroll bar");
6103 if (!EQ (w
->scroll_bar_width
, width
)
6104 || !EQ (w
->vertical_scroll_bar_type
, vertical_type
))
6106 w
->scroll_bar_width
= width
;
6107 w
->vertical_scroll_bar_type
= vertical_type
;
6109 adjust_window_margins (w
);
6111 clear_glyph_matrix (w
->current_matrix
);
6112 w
->window_end_valid
= Qnil
;
6114 ++windows_or_buffers_changed
;
6115 adjust_glyphs (XFRAME (WINDOW_FRAME (w
)));
6122 DEFUN ("window-scroll-bars", Fwindow_scroll_bars
, Swindow_scroll_bars
,
6124 doc
: /* Get width and type of scroll bars of window WINDOW.
6125 If WINDOW is omitted or nil, it defaults to the selected window.
6126 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6127 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6129 (Lisp_Object window
)
6131 struct window
*w
= decode_window (window
);
6132 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w
)
6133 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w
)
6134 : WINDOW_SCROLL_BAR_AREA_WIDTH (w
))),
6135 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w
)),
6136 Fcons (w
->vertical_scroll_bar_type
,
6137 Fcons (Qnil
, Qnil
))));
6142 /***********************************************************************
6144 ***********************************************************************/
6146 DEFUN ("window-vscroll", Fwindow_vscroll
, Swindow_vscroll
, 0, 2, 0,
6147 doc
: /* Return the amount by which WINDOW is scrolled vertically.
6148 If WINDOW is omitted or nil, it defaults to the selected window.
6149 Normally, value is a multiple of the canonical character height of WINDOW;
6150 optional second arg PIXELS-P means value is measured in pixels. */)
6151 (Lisp_Object window
, Lisp_Object pixels_p
)
6158 window
= selected_window
;
6160 CHECK_WINDOW (window
);
6161 w
= XWINDOW (window
);
6162 f
= XFRAME (w
->frame
);
6164 if (FRAME_WINDOW_P (f
))
6165 result
= (NILP (pixels_p
)
6166 ? FRAME_CANON_Y_FROM_PIXEL_Y (f
, -w
->vscroll
)
6167 : make_number (-w
->vscroll
));
6169 result
= make_number (0);
6174 DEFUN ("set-window-vscroll", Fset_window_vscroll
, Sset_window_vscroll
,
6176 doc
: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
6177 WINDOW nil means use the selected window. Normally, VSCROLL is a
6178 non-negative multiple of the canonical character height of WINDOW;
6179 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
6180 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
6181 corresponds to an integral number of pixels. The return value is the
6182 result of this rounding.
6183 If PIXELS-P is non-nil, the return value is VSCROLL. */)
6184 (Lisp_Object window
, Lisp_Object vscroll
, Lisp_Object pixels_p
)
6190 window
= selected_window
;
6192 CHECK_WINDOW (window
);
6193 CHECK_NUMBER_OR_FLOAT (vscroll
);
6195 w
= XWINDOW (window
);
6196 f
= XFRAME (w
->frame
);
6198 if (FRAME_WINDOW_P (f
))
6200 int old_dy
= w
->vscroll
;
6202 w
->vscroll
= - (NILP (pixels_p
)
6203 ? FRAME_LINE_HEIGHT (f
) * XFLOATINT (vscroll
)
6204 : XFLOATINT (vscroll
));
6205 w
->vscroll
= min (w
->vscroll
, 0);
6207 if (w
->vscroll
!= old_dy
)
6209 /* Adjust glyph matrix of the frame if the virtual display
6210 area becomes larger than before. */
6211 if (w
->vscroll
< 0 && w
->vscroll
< old_dy
)
6214 /* Prevent redisplay shortcuts. */
6215 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
6219 return Fwindow_vscroll (window
, pixels_p
);
6223 /* Call FN for all leaf windows on frame F. FN is called with the
6224 first argument being a pointer to the leaf window, and with
6225 additional argument USER_DATA. Stops when FN returns 0. */
6228 foreach_window (struct frame
*f
, int (*fn
) (struct window
*, void *),
6231 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6232 if (WINDOWP (FRAME_ROOT_WINDOW (f
)))
6233 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f
)), fn
, user_data
);
6237 /* Helper function for foreach_window. Call FN for all leaf windows
6238 reachable from W. FN is called with the first argument being a
6239 pointer to the leaf window, and with additional argument USER_DATA.
6240 Stop when FN returns 0. Value is 0 if stopped by FN. */
6243 foreach_window_1 (struct window
*w
, int (*fn
) (struct window
*, void *), void *user_data
)
6247 for (cont
= 1; w
&& cont
;)
6249 if (!NILP (w
->hchild
))
6250 cont
= foreach_window_1 (XWINDOW (w
->hchild
), fn
, user_data
);
6251 else if (!NILP (w
->vchild
))
6252 cont
= foreach_window_1 (XWINDOW (w
->vchild
), fn
, user_data
);
6254 cont
= fn (w
, user_data
);
6256 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
6263 /* Freeze or unfreeze the window start of W unless it is a
6264 mini-window or the selected window. FREEZE_P non-null means freeze
6265 the window start. */
6268 freeze_window_start (struct window
*w
, void *freeze_p
)
6270 if (MINI_WINDOW_P (w
)
6271 || (WINDOWP (selected_window
) /* Can be nil in corner cases. */
6272 && (w
== XWINDOW (selected_window
)
6273 || (MINI_WINDOW_P (XWINDOW (selected_window
))
6274 && ! NILP (Vminibuf_scroll_window
)
6275 && w
== XWINDOW (Vminibuf_scroll_window
)))))
6278 w
->frozen_window_start_p
= freeze_p
!= NULL
;
6283 /* Freeze or unfreeze the window starts of all leaf windows on frame
6284 F, except the selected window and a mini-window. FREEZE_P non-zero
6285 means freeze the window start. */
6288 freeze_window_starts (struct frame
*f
, int freeze_p
)
6290 foreach_window (f
, freeze_window_start
, (void *) (freeze_p
? f
: 0));
6294 /***********************************************************************
6296 ***********************************************************************/
6298 /* Return 1 if window configurations CONFIGURATION1 and CONFIGURATION2
6299 describe the same state of affairs. This is used by Fequal.
6301 ignore_positions non-zero means ignore non-matching scroll positions
6304 This ignores a couple of things like the dedication status of
6305 window, combination_limit and the like. This might have to be
6309 compare_window_configurations (Lisp_Object configuration1
, Lisp_Object configuration2
, int ignore_positions
)
6311 register struct save_window_data
*d1
, *d2
;
6312 struct Lisp_Vector
*sws1
, *sws2
;
6315 CHECK_WINDOW_CONFIGURATION (configuration1
);
6316 CHECK_WINDOW_CONFIGURATION (configuration2
);
6318 d1
= (struct save_window_data
*) XVECTOR (configuration1
);
6319 d2
= (struct save_window_data
*) XVECTOR (configuration2
);
6320 sws1
= XVECTOR (d1
->saved_windows
);
6321 sws2
= XVECTOR (d2
->saved_windows
);
6323 /* Frame settings must match. */
6324 if (d1
->frame_cols
!= d2
->frame_cols
6325 || d1
->frame_lines
!= d2
->frame_lines
6326 || d1
->frame_menu_bar_lines
!= d2
->frame_menu_bar_lines
6327 || !EQ (d1
->selected_frame
, d2
->selected_frame
)
6328 || !EQ (d1
->current_buffer
, d2
->current_buffer
)
6329 || (!ignore_positions
6330 && (!EQ (d1
->minibuf_scroll_window
, d2
->minibuf_scroll_window
)
6331 || !EQ (d1
->minibuf_selected_window
, d2
->minibuf_selected_window
)))
6332 || !EQ (d1
->focus_frame
, d2
->focus_frame
)
6333 /* Verify that the two configurations have the same number of windows. */
6334 || sws1
->header
.size
!= sws2
->header
.size
)
6337 for (i
= 0; i
< sws1
->header
.size
; i
++)
6339 struct saved_window
*sw1
, *sw2
;
6341 sw1
= SAVED_WINDOW_N (sws1
, i
);
6342 sw2
= SAVED_WINDOW_N (sws2
, i
);
6345 /* The "current" windows in the two configurations must
6346 correspond to each other. */
6347 EQ (d1
->current_window
, sw1
->window
)
6348 != EQ (d2
->current_window
, sw2
->window
)
6349 /* Windows' buffers must match. */
6350 || !EQ (sw1
->buffer
, sw2
->buffer
)
6351 || !EQ (sw1
->left_col
, sw2
->left_col
)
6352 || !EQ (sw1
->top_line
, sw2
->top_line
)
6353 || !EQ (sw1
->total_cols
, sw2
->total_cols
)
6354 || !EQ (sw1
->total_lines
, sw2
->total_lines
)
6355 || !EQ (sw1
->display_table
, sw2
->display_table
)
6356 /* The next two disjuncts check the window structure for
6358 || !EQ (sw1
->parent
, sw2
->parent
)
6359 || !EQ (sw1
->prev
, sw2
->prev
)
6360 || (!ignore_positions
6361 && (!EQ (sw1
->hscroll
, sw2
->hscroll
)
6362 || !EQ (sw1
->min_hscroll
, sw2
->min_hscroll
)
6363 || !EQ (sw1
->start_at_line_beg
, sw2
->start_at_line_beg
)
6364 || NILP (Fequal (sw1
->start
, sw2
->start
))
6365 || NILP (Fequal (sw1
->pointm
, sw2
->pointm
))
6366 || NILP (Fequal (sw1
->mark
, sw2
->mark
))))
6367 || !EQ (sw1
->left_margin_cols
, sw2
->left_margin_cols
)
6368 || !EQ (sw1
->right_margin_cols
, sw2
->right_margin_cols
)
6369 || !EQ (sw1
->left_fringe_width
, sw2
->left_fringe_width
)
6370 || !EQ (sw1
->right_fringe_width
, sw2
->right_fringe_width
)
6371 || !EQ (sw1
->fringes_outside_margins
, sw2
->fringes_outside_margins
)
6372 || !EQ (sw1
->scroll_bar_width
, sw2
->scroll_bar_width
)
6373 || !EQ (sw1
->vertical_scroll_bar_type
, sw2
->vertical_scroll_bar_type
))
6380 DEFUN ("compare-window-configurations", Fcompare_window_configurations
,
6381 Scompare_window_configurations
, 2, 2, 0,
6382 doc
: /* Compare two window configurations as regards the structure of windows.
6383 This function ignores details such as the values of point and mark
6384 and scrolling positions. */)
6385 (Lisp_Object x
, Lisp_Object y
)
6387 if (compare_window_configurations (x
, y
, 1))
6393 init_window_once (void)
6395 struct frame
*f
= make_initial_frame ();
6396 XSETFRAME (selected_frame
, f
);
6397 Vterminal_frame
= selected_frame
;
6398 minibuf_window
= f
->minibuffer_window
;
6399 selected_window
= f
->selected_window
;
6400 last_nonminibuf_frame
= f
;
6402 window_initialized
= 1;
6408 Vwindow_list
= Qnil
;
6412 syms_of_window (void)
6414 DEFSYM (Qscroll_up
, "scroll-up");
6415 DEFSYM (Qscroll_down
, "scroll-down");
6416 DEFSYM (Qscroll_command
, "scroll-command");
6418 Fput (Qscroll_up
, Qscroll_command
, Qt
);
6419 Fput (Qscroll_down
, Qscroll_command
, Qt
);
6421 DEFSYM (Qwindow_configuration_change_hook
, "window-configuration-change-hook");
6422 DEFSYM (Qwindowp
, "windowp");
6423 DEFSYM (Qwindow_configuration_p
, "window-configuration-p");
6424 DEFSYM (Qwindow_live_p
, "window-live-p");
6425 DEFSYM (Qwindow_deletable_p
, "window-deletable-p");
6426 DEFSYM (Qdelete_window
, "delete-window");
6427 DEFSYM (Qwindow_resize_root_window
, "window--resize-root-window");
6428 DEFSYM (Qwindow_resize_root_window_vertically
, "window--resize-root-window-vertically");
6429 DEFSYM (Qsafe
, "safe");
6430 DEFSYM (Qdisplay_buffer
, "display-buffer");
6431 DEFSYM (Qreplace_buffer_in_windows
, "replace-buffer-in-windows");
6432 DEFSYM (Qrecord_window_buffer
, "record-window-buffer");
6433 DEFSYM (Qget_mru_window
, "get-mru-window");
6434 DEFSYM (Qtemp_buffer_show_hook
, "temp-buffer-show-hook");
6435 DEFSYM (Qabove
, "above");
6436 DEFSYM (Qbelow
, "below");
6437 DEFSYM (Qauto_buffer_name
, "auto-buffer-name");
6439 staticpro (&Vwindow_list
);
6441 minibuf_selected_window
= Qnil
;
6442 staticpro (&minibuf_selected_window
);
6444 window_scroll_pixel_based_preserve_x
= -1;
6445 window_scroll_pixel_based_preserve_y
= -1;
6446 window_scroll_preserve_hpos
= -1;
6447 window_scroll_preserve_vpos
= -1;
6449 DEFVAR_LISP ("temp-buffer-show-function", Vtemp_buffer_show_function
,
6450 doc
: /* Non-nil means call as function to display a help buffer.
6451 The function is called with one argument, the buffer to be displayed.
6452 Used by `with-output-to-temp-buffer'.
6453 If this function is used, then it must do the entire job of showing
6454 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
6455 Vtemp_buffer_show_function
= Qnil
;
6457 DEFVAR_LISP ("minibuffer-scroll-window", Vminibuf_scroll_window
,
6458 doc
: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
6459 Vminibuf_scroll_window
= Qnil
;
6461 DEFVAR_BOOL ("mode-line-in-non-selected-windows", mode_line_in_non_selected_windows
,
6462 doc
: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
6463 If the minibuffer is active, the `minibuffer-scroll-window' mode line
6464 is displayed in the `mode-line' face. */);
6465 mode_line_in_non_selected_windows
= 1;
6467 DEFVAR_LISP ("other-window-scroll-buffer", Vother_window_scroll_buffer
,
6468 doc
: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
6469 Vother_window_scroll_buffer
= Qnil
;
6471 DEFVAR_BOOL ("auto-window-vscroll", auto_window_vscroll_p
,
6472 doc
: /* Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
6473 auto_window_vscroll_p
= 1;
6475 DEFVAR_INT ("next-screen-context-lines", next_screen_context_lines
,
6476 doc
: /* Number of lines of continuity when scrolling by screenfuls. */);
6477 next_screen_context_lines
= 2;
6479 DEFVAR_LISP ("scroll-preserve-screen-position",
6480 Vscroll_preserve_screen_position
,
6481 doc
: /* Controls if scroll commands move point to keep its screen position unchanged.
6482 A value of nil means point does not keep its screen position except
6483 at the scroll margin or window boundary respectively.
6484 A value of t means point keeps its screen position if the scroll
6485 command moved it vertically out of the window, e.g. when scrolling
6487 Any other value means point always keeps its screen position.
6488 Scroll commands should have the `scroll-command' property
6489 on their symbols to be controlled by this variable. */);
6490 Vscroll_preserve_screen_position
= Qnil
;
6492 DEFVAR_LISP ("window-point-insertion-type", Vwindow_point_insertion_type
,
6493 doc
: /* Type of marker to use for `window-point'. */);
6494 Vwindow_point_insertion_type
= Qnil
;
6496 DEFVAR_LISP ("window-configuration-change-hook",
6497 Vwindow_configuration_change_hook
,
6498 doc
: /* Functions to call when window configuration changes.
6499 The buffer-local part is run once per window, with the relevant window
6500 selected; while the global part is run only once for the modified frame,
6501 with the relevant frame selected. */);
6502 Vwindow_configuration_change_hook
= Qnil
;
6504 DEFVAR_LISP ("recenter-redisplay", Vrecenter_redisplay
,
6505 doc
: /* Non-nil means `recenter' redraws entire frame.
6506 If this option is non-nil, then the `recenter' command with a nil
6507 argument will redraw the entire frame; the special value `tty' causes
6508 the frame to be redrawn only if it is a tty frame. */);
6509 Vrecenter_redisplay
= Qtty
;
6511 DEFVAR_LISP ("window-combination-resize", Vwindow_combination_resize
,
6512 doc
: /* If t, resize window combinations proportionally.
6513 If this variable is nil, splitting a window gets the entire screen space
6514 for displaying the new window from the window to split. Deleting and
6515 resizing a window preferably resizes one adjacent window only.
6517 If this variable is t, splitting a window tries to get the space
6518 proportionally from all windows in the same combination. This also
6519 allows to split a window that is otherwise too small or of fixed size.
6520 Resizing and deleting a window proportionally resize all windows in the
6523 Other values are reserved for future use.
6525 This variable takes no effect if `window-combination-limit' is non-nil. */);
6526 Vwindow_combination_resize
= Qnil
;
6528 DEFVAR_LISP ("window-combination-limit", Vwindow_combination_limit
,
6529 doc
: /* If t, splitting a window makes a new parent window.
6530 If this variable is nil, splitting a window will create a new parent
6531 window only if the window has no parent window or the window shall
6532 become a combination orthogonal to the one it is part of.
6534 If this variable is t, splitting a window always creates a new parent
6535 window. If all splits behave this way, each frame's window tree is a
6536 binary tree and every window but the frame's root window has exactly one
6539 Other values are reserved for future use.
6541 The value of this variable is also assigned to the combination limit of
6542 the new parent window. The combination limit of a window can be
6543 retrieved via the function `window-combination-limit' and altered by the
6544 function `set-window-combination-limit'. */);
6545 Vwindow_combination_limit
= Qnil
;
6547 defsubr (&Sselected_window
);
6548 defsubr (&Sminibuffer_window
);
6549 defsubr (&Swindow_minibuffer_p
);
6550 defsubr (&Swindowp
);
6551 defsubr (&Swindow_live_p
);
6552 defsubr (&Swindow_frame
);
6553 defsubr (&Sframe_root_window
);
6554 defsubr (&Sframe_first_window
);
6555 defsubr (&Sframe_selected_window
);
6556 defsubr (&Sset_frame_selected_window
);
6557 defsubr (&Spos_visible_in_window_p
);
6558 defsubr (&Swindow_line_height
);
6559 defsubr (&Swindow_buffer
);
6560 defsubr (&Swindow_parent
);
6561 defsubr (&Swindow_top_child
);
6562 defsubr (&Swindow_left_child
);
6563 defsubr (&Swindow_next_sibling
);
6564 defsubr (&Swindow_prev_sibling
);
6565 defsubr (&Swindow_combination_limit
);
6566 defsubr (&Sset_window_combination_limit
);
6567 defsubr (&Swindow_use_time
);
6568 defsubr (&Swindow_top_line
);
6569 defsubr (&Swindow_left_column
);
6570 defsubr (&Swindow_total_height
);
6571 defsubr (&Swindow_total_width
);
6572 defsubr (&Swindow_normal_size
);
6573 defsubr (&Swindow_new_total
);
6574 defsubr (&Swindow_new_normal
);
6575 defsubr (&Sset_window_new_total
);
6576 defsubr (&Sset_window_new_normal
);
6577 defsubr (&Swindow_resize_apply
);
6578 defsubr (&Swindow_body_height
);
6579 defsubr (&Swindow_body_width
);
6580 defsubr (&Swindow_hscroll
);
6581 defsubr (&Sset_window_hscroll
);
6582 defsubr (&Swindow_redisplay_end_trigger
);
6583 defsubr (&Sset_window_redisplay_end_trigger
);
6584 defsubr (&Swindow_edges
);
6585 defsubr (&Swindow_pixel_edges
);
6586 defsubr (&Swindow_absolute_pixel_edges
);
6587 defsubr (&Swindow_inside_edges
);
6588 defsubr (&Swindow_inside_pixel_edges
);
6589 defsubr (&Swindow_inside_absolute_pixel_edges
);
6590 defsubr (&Scoordinates_in_window_p
);
6591 defsubr (&Swindow_at
);
6592 defsubr (&Swindow_point
);
6593 defsubr (&Swindow_start
);
6594 defsubr (&Swindow_end
);
6595 defsubr (&Sset_window_point
);
6596 defsubr (&Sset_window_start
);
6597 defsubr (&Swindow_dedicated_p
);
6598 defsubr (&Sset_window_dedicated_p
);
6599 defsubr (&Swindow_display_table
);
6600 defsubr (&Sset_window_display_table
);
6601 defsubr (&Snext_window
);
6602 defsubr (&Sprevious_window
);
6603 defsubr (&Sget_buffer_window
);
6604 defsubr (&Sdelete_other_windows_internal
);
6605 defsubr (&Sdelete_window_internal
);
6606 defsubr (&Sresize_mini_window_internal
);
6607 defsubr (&Sset_window_buffer
);
6608 defsubr (&Srun_window_configuration_change_hook
);
6609 defsubr (&Sselect_window
);
6610 defsubr (&Sforce_window_update
);
6611 defsubr (&Stemp_output_buffer_show
);
6612 defsubr (&Ssplit_window_internal
);
6613 defsubr (&Sscroll_up
);
6614 defsubr (&Sscroll_down
);
6615 defsubr (&Sscroll_left
);
6616 defsubr (&Sscroll_right
);
6617 defsubr (&Sother_window_for_scrolling
);
6618 defsubr (&Sscroll_other_window
);
6619 defsubr (&Sminibuffer_selected_window
);
6620 defsubr (&Srecenter
);
6621 defsubr (&Swindow_text_height
);
6622 defsubr (&Smove_to_window_line
);
6623 defsubr (&Swindow_configuration_p
);
6624 defsubr (&Swindow_configuration_frame
);
6625 defsubr (&Sset_window_configuration
);
6626 defsubr (&Scurrent_window_configuration
);
6627 defsubr (&Sset_window_margins
);
6628 defsubr (&Swindow_margins
);
6629 defsubr (&Sset_window_fringes
);
6630 defsubr (&Swindow_fringes
);
6631 defsubr (&Sset_window_scroll_bars
);
6632 defsubr (&Swindow_scroll_bars
);
6633 defsubr (&Swindow_vscroll
);
6634 defsubr (&Sset_window_vscroll
);
6635 defsubr (&Scompare_window_configurations
);
6636 defsubr (&Swindow_list
);
6637 defsubr (&Swindow_list_1
);
6638 defsubr (&Swindow_prev_buffers
);
6639 defsubr (&Sset_window_prev_buffers
);
6640 defsubr (&Swindow_next_buffers
);
6641 defsubr (&Sset_window_next_buffers
);
6642 defsubr (&Swindow_parameters
);
6643 defsubr (&Swindow_parameter
);
6644 defsubr (&Sset_window_parameter
);
6648 keys_of_window (void)
6650 initial_define_key (control_x_map
, '<', "scroll-left");
6651 initial_define_key (control_x_map
, '>', "scroll-right");
6653 initial_define_key (global_map
, Ctl ('V'), "scroll-up-command");
6654 initial_define_key (meta_map
, Ctl ('V'), "scroll-other-window");
6655 initial_define_key (meta_map
, 'v', "scroll-down-command");