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/>. */
26 #include "character.h"
36 #include "dispextern.h"
37 #include "blockinput.h"
38 #include "intervals.h"
39 #include "termhooks.h" /* For FRAME_TERMINAL. */
43 #endif /* HAVE_X_WINDOWS */
54 Lisp_Object Qwindowp
, Qwindow_live_p
;
55 static Lisp_Object Qwindow_configuration_p
, Qrecord_window_buffer
;
56 static Lisp_Object Qwindow_deletable_p
, Qdelete_window
, Qdisplay_buffer
;
57 static Lisp_Object Qreplace_buffer_in_windows
, Qget_mru_window
;
58 static Lisp_Object Qwindow_resize_root_window
, Qwindow_resize_root_window_vertically
;
59 static Lisp_Object Qscroll_up
, Qscroll_down
, Qscroll_command
;
60 static Lisp_Object Qsafe
, Qabove
, Qbelow
;
61 static Lisp_Object Qauto_buffer_name
, Qclone_of
;
63 static int displayed_window_lines (struct window
*);
64 static struct window
*decode_window (Lisp_Object
);
65 static int count_windows (struct window
*);
66 static int get_leaf_windows (struct window
*, struct window
**, int);
67 static void window_scroll (Lisp_Object
, EMACS_INT
, int, int);
68 static void window_scroll_pixel_based (Lisp_Object
, int, int, int);
69 static void window_scroll_line_based (Lisp_Object
, int, int, int);
70 static int freeze_window_start (struct window
*, void *);
71 static Lisp_Object
window_list (void);
72 static int add_window_to_list (struct window
*, void *);
73 static int candidate_window_p (Lisp_Object
, Lisp_Object
, Lisp_Object
,
75 static Lisp_Object
next_window (Lisp_Object
, Lisp_Object
,
77 static void decode_next_window_args (Lisp_Object
*, Lisp_Object
*,
79 static void foreach_window (struct frame
*,
80 int (* fn
) (struct window
*, void *),
82 static int foreach_window_1 (struct window
*,
83 int (* fn
) (struct window
*, void *),
85 static Lisp_Object
window_list_1 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
86 static int window_resize_check (struct window
*, int);
87 static void window_resize_apply (struct window
*, int);
88 static Lisp_Object
select_window (Lisp_Object
, Lisp_Object
, int);
90 /* This is the window in which the terminal's cursor should
91 be left when nothing is being done with it. This must
92 always be a leaf window, and its buffer is selected by
93 the top level editing loop at the end of each command.
95 This value is always the same as
96 FRAME_SELECTED_WINDOW (selected_frame). */
97 Lisp_Object selected_window
;
99 /* A list of all windows for use by next_window and Fwindow_list.
100 Functions creating or deleting windows should invalidate this cache
101 by setting it to nil. */
102 Lisp_Object Vwindow_list
;
104 /* The mini-buffer window of the selected frame.
105 Note that you cannot test for mini-bufferness of an arbitrary window
106 by comparing against this; but you can test for mini-bufferness of
107 the selected window. */
108 Lisp_Object minibuf_window
;
110 /* Non-nil means it is the window whose mode line should be
111 shown as the selected window when the minibuffer is selected. */
112 Lisp_Object minibuf_selected_window
;
114 /* Hook run at end of temp_output_buffer_show. */
115 static Lisp_Object Qtemp_buffer_show_hook
;
117 /* Incremented for each window created. */
118 static int sequence_number
;
120 /* Nonzero after init_window_once has finished. */
121 static int window_initialized
;
123 /* Hook to run when window config changes. */
124 static Lisp_Object Qwindow_configuration_change_hook
;
126 /* Used by the function window_scroll_pixel_based */
127 static int window_scroll_pixel_based_preserve_x
;
128 static int window_scroll_pixel_based_preserve_y
;
130 /* Same for window_scroll_line_based. */
131 static EMACS_INT window_scroll_preserve_hpos
;
132 static EMACS_INT window_scroll_preserve_vpos
;
134 static struct window
*
135 decode_window (register Lisp_Object window
)
138 return XWINDOW (selected_window
);
140 CHECK_LIVE_WINDOW (window
);
141 return XWINDOW (window
);
144 static struct window
*
145 decode_any_window (register Lisp_Object window
)
148 return XWINDOW (selected_window
);
150 CHECK_WINDOW (window
);
151 return XWINDOW (window
);
154 DEFUN ("windowp", Fwindowp
, Swindowp
, 1, 1, 0,
155 doc
: /* Return t if OBJECT is a window and nil otherwise. */)
158 return WINDOWP (object
) ? Qt
: Qnil
;
161 DEFUN ("window-live-p", Fwindow_live_p
, Swindow_live_p
, 1, 1, 0,
162 doc
: /* Return t if OBJECT is a live window and nil otherwise.
163 A live window is a window that displays a buffer.
164 Internal windows and deleted windows are not live. */)
167 return WINDOW_LIVE_P (object
) ? Qt
: Qnil
;
170 /* Frames and windows. */
171 DEFUN ("window-frame", Fwindow_frame
, Swindow_frame
, 1, 1, 0,
172 doc
: /* Return the frame that window WINDOW is on.
173 If WINDOW is omitted or nil, it defaults to the selected window. */)
176 return decode_any_window (window
)->frame
;
179 DEFUN ("frame-root-window", Fframe_root_window
, Sframe_root_window
, 0, 1, 0,
180 doc
: /* Return the root window of FRAME-OR-WINDOW.
181 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
182 With a frame argument, return that frame's root window.
183 With a window argument, return the root window of that window's frame. */)
184 (Lisp_Object frame_or_window
)
188 if (NILP (frame_or_window
))
189 window
= SELECTED_FRAME ()->root_window
;
190 else if (WINDOWP (frame_or_window
))
191 window
= XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window
)))->root_window
;
194 CHECK_LIVE_FRAME (frame_or_window
);
195 window
= XFRAME (frame_or_window
)->root_window
;
201 DEFUN ("minibuffer-window", Fminibuffer_window
, Sminibuffer_window
, 0, 1, 0,
202 doc
: /* Return the minibuffer window for frame FRAME.
203 If FRAME is omitted or nil, it defaults to the selected frame. */)
207 frame
= selected_frame
;
208 CHECK_LIVE_FRAME (frame
);
209 return FRAME_MINIBUF_WINDOW (XFRAME (frame
));
212 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p
,
213 Swindow_minibuffer_p
, 0, 1, 0,
214 doc
: /* Return non-nil if WINDOW is a minibuffer window.
215 If WINDOW is omitted or nil, it defaults to the selected window. */)
218 return MINI_WINDOW_P (decode_any_window (window
)) ? Qt
: Qnil
;
221 /* Don't move this to window.el - this must be a safe routine. */
222 DEFUN ("frame-first-window", Fframe_first_window
, Sframe_first_window
, 0, 1, 0,
223 doc
: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
224 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
225 Else if FRAME-OR-WINDOW denotes any window, return the first window of
226 that window's frame. If FRAME-OR-WINDOW denotes a live frame, return
227 the first window of that frame. */)
228 (Lisp_Object frame_or_window
)
232 if (NILP (frame_or_window
))
233 window
= SELECTED_FRAME ()->root_window
;
234 else if (WINDOWP (frame_or_window
))
235 window
= XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window
)))->root_window
;
238 CHECK_LIVE_FRAME (frame_or_window
);
239 window
= XFRAME (frame_or_window
)->root_window
;
242 while (NILP (XWINDOW (window
)->buffer
))
244 if (! NILP (XWINDOW (window
)->hchild
))
245 window
= XWINDOW (window
)->hchild
;
246 else if (! NILP (XWINDOW (window
)->vchild
))
247 window
= XWINDOW (window
)->vchild
;
255 DEFUN ("frame-selected-window", Fframe_selected_window
,
256 Sframe_selected_window
, 0, 1, 0,
257 doc
: /* Return the selected window of FRAME-OR-WINDOW.
258 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
259 Else if FRAME-OR-WINDOW denotes any window, return the selected window
260 of that window's frame. If FRAME-OR-WINDOW denotes a live frame, return
261 the selected window of that frame. */)
262 (Lisp_Object frame_or_window
)
266 if (NILP (frame_or_window
))
267 window
= SELECTED_FRAME ()->selected_window
;
268 else if (WINDOWP (frame_or_window
))
269 window
= XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window
)))->selected_window
;
272 CHECK_LIVE_FRAME (frame_or_window
);
273 window
= XFRAME (frame_or_window
)->selected_window
;
279 DEFUN ("set-frame-selected-window", Fset_frame_selected_window
,
280 Sset_frame_selected_window
, 2, 3, 0,
281 doc
: /* Set selected window of FRAME to WINDOW.
282 FRAME must be a live frame and defaults to the selected one. If FRAME
283 is the selected frame, this makes WINDOW the selected window. Optional
284 argument NORECORD non-nil means to neither change the order of recently
285 selected windows nor the buffer list. WINDOW must denote a live window.
287 (Lisp_Object frame
, Lisp_Object window
, Lisp_Object norecord
)
290 frame
= selected_frame
;
292 CHECK_LIVE_FRAME (frame
);
293 CHECK_LIVE_WINDOW (window
);
295 if (! EQ (frame
, WINDOW_FRAME (XWINDOW (window
))))
296 error ("In `set-frame-selected-window', WINDOW is not on FRAME");
298 if (EQ (frame
, selected_frame
))
299 return Fselect_window (window
, norecord
);
301 return XFRAME (frame
)->selected_window
= window
;
304 DEFUN ("selected-window", Fselected_window
, Sselected_window
, 0, 0, 0,
305 doc
: /* Return the selected window.
306 The selected window is the window in which the standard cursor for
307 selected windows appears and to which many commands apply. */)
310 return selected_window
;
313 int window_select_count
;
315 /* If select_window is called with inhibit_point_swap non-zero it will
316 not store point of the old selected window's buffer back into that
317 window's pointm slot. This is needed by Fset_window_configuration to
318 avoid that the display routine is called with selected_window set to
319 Qnil causing a subsequent crash. */
321 select_window (Lisp_Object window
, Lisp_Object norecord
, int inhibit_point_swap
)
323 register struct window
*w
;
324 register struct window
*ow
;
327 CHECK_LIVE_WINDOW (window
);
329 w
= XWINDOW (window
);
330 w
->frozen_window_start_p
= 0;
334 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 make_number (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 make_number (decode_window (window
)->hscroll
);
673 /* Set W's horizontal scroll amount to HSCROLL clipped to a reasonable
674 range, returning the new amount as a fixnum. */
676 set_window_hscroll (struct window
*w
, EMACS_INT hscroll
)
678 /* Horizontal scrolling has problems with large scroll amounts.
679 It's too slow with long lines, and even with small lines the
680 display can be messed up. For now, though, impose only the limits
681 required by the internal representation: horizontal scrolling must
682 fit in fixnum (since it's visible to Elisp) and into ptrdiff_t
683 (since it's stored in a ptrdiff_t). */
684 ptrdiff_t hscroll_max
= min (MOST_POSITIVE_FIXNUM
, PTRDIFF_MAX
);
685 ptrdiff_t new_hscroll
= clip_to_bounds (0, hscroll
, hscroll_max
);
687 /* Prevent redisplay shortcuts when changing the hscroll. */
688 if (w
->hscroll
!= new_hscroll
)
689 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
691 w
->hscroll
= new_hscroll
;
692 return make_number (new_hscroll
);
695 DEFUN ("set-window-hscroll", Fset_window_hscroll
, Sset_window_hscroll
, 2, 2, 0,
696 doc
: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
697 If WINDOW is nil, the selected window is used.
698 Clip the number to a reasonable value if out of range.
699 Return the new number. NCOL should be zero or positive.
701 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
702 window so that the location of point moves off-window. */)
703 (Lisp_Object window
, Lisp_Object ncol
)
705 struct window
*w
= decode_window (window
);
708 return set_window_hscroll (w
, XINT (ncol
));
711 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger
,
712 Swindow_redisplay_end_trigger
, 0, 1, 0,
713 doc
: /* Return WINDOW's redisplay end trigger value.
714 WINDOW defaults to the selected window.
715 See `set-window-redisplay-end-trigger' for more information. */)
718 return decode_window (window
)->redisplay_end_trigger
;
721 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger
,
722 Sset_window_redisplay_end_trigger
, 2, 2, 0,
723 doc
: /* Set WINDOW's redisplay end trigger value to VALUE.
724 VALUE should be a buffer position (typically a marker) or nil.
725 If it is a buffer position, then if redisplay in WINDOW reaches a position
726 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
727 with two arguments: WINDOW, and the end trigger value.
728 Afterwards the end-trigger value is reset to nil. */)
729 (register Lisp_Object window
, Lisp_Object value
)
731 register struct window
*w
;
733 w
= decode_window (window
);
734 w
->redisplay_end_trigger
= value
;
738 DEFUN ("window-edges", Fwindow_edges
, Swindow_edges
, 0, 1, 0,
739 doc
: /* Return a list of the edge coordinates of WINDOW.
740 The list has the form (LEFT TOP RIGHT BOTTOM).
741 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
742 all relative to 0, 0 at top left corner of frame.
744 RIGHT is one more than the rightmost column occupied by WINDOW.
745 BOTTOM is one more than the bottommost row occupied by WINDOW.
746 The edges include the space used by WINDOW's scroll bar, display
747 margins, fringes, header line, and/or mode line. For the edges of
748 just the text area, use `window-inside-edges'. */)
751 register struct window
*w
= decode_any_window (window
);
753 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w
)),
754 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w
)),
755 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w
)),
756 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w
)),
760 DEFUN ("window-pixel-edges", Fwindow_pixel_edges
, Swindow_pixel_edges
, 0, 1, 0,
761 doc
: /* Return a list of the edge pixel coordinates of WINDOW.
762 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
763 the top left corner of the frame.
765 RIGHT is one more than the rightmost x position occupied by WINDOW.
766 BOTTOM is one more than the bottommost y position occupied by WINDOW.
767 The pixel edges include the space used by WINDOW's scroll bar, display
768 margins, fringes, header line, and/or mode line. For the pixel edges
769 of just the text area, use `window-inside-pixel-edges'. */)
772 register struct window
*w
= decode_any_window (window
);
774 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w
)),
775 Fcons (make_number (WINDOW_TOP_EDGE_Y (w
)),
776 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w
)),
777 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w
)),
782 calc_absolute_offset (struct window
*w
, int *add_x
, int *add_y
)
784 struct frame
*f
= XFRAME (w
->frame
);
786 #ifdef FRAME_MENUBAR_HEIGHT
787 *add_y
+= FRAME_MENUBAR_HEIGHT (f
);
789 #ifdef FRAME_TOOLBAR_TOP_HEIGHT
790 *add_y
+= FRAME_TOOLBAR_TOP_HEIGHT (f
);
791 #elif FRAME_TOOLBAR_HEIGHT
792 *add_y
+= FRAME_TOOLBAR_HEIGHT (f
);
794 #ifdef FRAME_NS_TITLEBAR_HEIGHT
795 *add_y
+= FRAME_NS_TITLEBAR_HEIGHT (f
);
797 *add_x
= f
->left_pos
;
798 #ifdef FRAME_TOOLBAR_LEFT_WIDTH
799 *add_x
+= FRAME_TOOLBAR_LEFT_WIDTH (f
);
803 DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges
,
804 Swindow_absolute_pixel_edges
, 0, 1, 0,
805 doc
: /* Return a list of the edge pixel coordinates of WINDOW.
806 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
807 the top left corner of the display.
809 RIGHT is one more than the rightmost x position occupied by WINDOW.
810 BOTTOM is one more than the bottommost y position occupied by WINDOW.
811 The pixel edges include the space used by WINDOW's scroll bar, display
812 margins, fringes, header line, and/or mode line. For the pixel edges
813 of just the text area, use `window-inside-absolute-pixel-edges'. */)
816 register struct window
*w
= decode_any_window (window
);
818 calc_absolute_offset (w
, &add_x
, &add_y
);
820 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w
) + add_x
),
821 Fcons (make_number (WINDOW_TOP_EDGE_Y (w
) + add_y
),
822 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w
) + add_x
),
823 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w
) + add_y
),
827 DEFUN ("window-inside-edges", Fwindow_inside_edges
, Swindow_inside_edges
, 0, 1, 0,
828 doc
: /* Return a list of the edge coordinates of WINDOW.
829 The list has the form (LEFT TOP RIGHT BOTTOM).
830 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
831 all relative to 0, 0 at top left corner of frame.
833 RIGHT is one more than the rightmost column of WINDOW's text area.
834 BOTTOM is one more than the bottommost row of WINDOW's text area.
835 The inside edges do not include the space used by the WINDOW's scroll
836 bar, display margins, fringes, header line, and/or mode line. */)
839 register struct window
*w
= decode_window (window
);
841 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w
)
842 + WINDOW_LEFT_MARGIN_COLS (w
)
843 + WINDOW_LEFT_FRINGE_COLS (w
)),
844 make_number (WINDOW_TOP_EDGE_LINE (w
)
845 + WINDOW_HEADER_LINE_LINES (w
)),
846 make_number (WINDOW_BOX_RIGHT_EDGE_COL (w
)
847 - WINDOW_RIGHT_MARGIN_COLS (w
)
848 - WINDOW_RIGHT_FRINGE_COLS (w
)),
849 make_number (WINDOW_BOTTOM_EDGE_LINE (w
)
850 - WINDOW_MODE_LINE_LINES (w
)));
853 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges
, Swindow_inside_pixel_edges
, 0, 1, 0,
854 doc
: /* Return a list of the edge pixel coordinates of WINDOW's text area.
855 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to (0,0)
856 at the top left corner of the frame's window area.
858 RIGHT is one more than the rightmost x position of WINDOW's text area.
859 BOTTOM is one more than the bottommost y position of WINDOW's text area.
860 The inside edges do not include the space used by WINDOW's scroll bar,
861 display margins, fringes, header line, and/or mode line. */)
864 register struct window
*w
= decode_window (window
);
866 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w
)
867 + WINDOW_LEFT_MARGIN_WIDTH (w
)
868 + WINDOW_LEFT_FRINGE_WIDTH (w
)),
869 make_number (WINDOW_TOP_EDGE_Y (w
)
870 + WINDOW_HEADER_LINE_HEIGHT (w
)),
871 make_number (WINDOW_BOX_RIGHT_EDGE_X (w
)
872 - WINDOW_RIGHT_MARGIN_WIDTH (w
)
873 - WINDOW_RIGHT_FRINGE_WIDTH (w
)),
874 make_number (WINDOW_BOTTOM_EDGE_Y (w
)
875 - WINDOW_MODE_LINE_HEIGHT (w
)));
878 DEFUN ("window-inside-absolute-pixel-edges",
879 Fwindow_inside_absolute_pixel_edges
,
880 Swindow_inside_absolute_pixel_edges
, 0, 1, 0,
881 doc
: /* Return a list of the edge pixel coordinates of WINDOW's text area.
882 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to (0,0)
883 at the top left corner of the frame's window area.
885 RIGHT is one more than the rightmost x position of WINDOW's text area.
886 BOTTOM is one more than the bottommost y position of WINDOW's text area.
887 The inside edges do not include the space used by WINDOW's scroll bar,
888 display margins, fringes, header line, and/or mode line. */)
891 register struct window
*w
= decode_window (window
);
893 calc_absolute_offset (w
, &add_x
, &add_y
);
895 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w
)
896 + WINDOW_LEFT_MARGIN_WIDTH (w
)
897 + WINDOW_LEFT_FRINGE_WIDTH (w
) + add_x
),
898 make_number (WINDOW_TOP_EDGE_Y (w
)
899 + WINDOW_HEADER_LINE_HEIGHT (w
) + add_y
),
900 make_number (WINDOW_BOX_RIGHT_EDGE_X (w
)
901 - WINDOW_RIGHT_MARGIN_WIDTH (w
)
902 - WINDOW_RIGHT_FRINGE_WIDTH (w
) + add_x
),
903 make_number (WINDOW_BOTTOM_EDGE_Y (w
)
904 - WINDOW_MODE_LINE_HEIGHT (w
) + add_y
));
907 /* Test if the character at column X, row Y is within window W.
908 If it is not, return ON_NOTHING;
909 if it is in the window's text area, return ON_TEXT;
910 if it is on the window's modeline, return ON_MODE_LINE;
911 if it is on the border between the window and its right sibling,
912 return ON_VERTICAL_BORDER.
913 if it is on a scroll bar, return ON_SCROLL_BAR.
914 if it is on the window's top line, return ON_HEADER_LINE;
915 if it is in left or right fringe of the window,
916 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
917 if it is in the marginal area to the left/right of the window,
918 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
920 X and Y are frame relative pixel coordinates. */
922 static enum window_part
923 coordinates_in_window (register struct window
*w
, int x
, int y
)
925 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
926 enum window_part part
;
927 int ux
= FRAME_COLUMN_WIDTH (f
);
928 int left_x
= WINDOW_LEFT_EDGE_X (w
);
929 int right_x
= WINDOW_RIGHT_EDGE_X (w
);
930 int top_y
= WINDOW_TOP_EDGE_Y (w
);
931 int bottom_y
= WINDOW_BOTTOM_EDGE_Y (w
);
932 /* The width of the area where the vertical line can be dragged.
933 (Between mode lines for instance. */
934 int grabbable_width
= ux
;
935 int lmargin_width
, rmargin_width
, text_left
, text_right
;
937 /* Outside any interesting row or column? */
938 if (y
< top_y
|| y
>= bottom_y
|| x
< left_x
|| x
>= right_x
)
941 /* On the mode line or header line? */
942 if ((WINDOW_WANTS_MODELINE_P (w
)
943 && y
>= bottom_y
- CURRENT_MODE_LINE_HEIGHT (w
)
944 && (part
= ON_MODE_LINE
))
945 || (WINDOW_WANTS_HEADER_LINE_P (w
)
946 && y
< top_y
+ CURRENT_HEADER_LINE_HEIGHT (w
)
947 && (part
= ON_HEADER_LINE
)))
949 /* If it's under/over the scroll bar portion of the mode/header
950 line, say it's on the vertical line. That's to be able to
951 resize windows horizontally in case we're using toolkit scroll
952 bars. Note: If scrollbars are on the left, the window that
953 must be eventually resized is that on the left of WINDOW. */
954 if ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
955 && !WINDOW_LEFTMOST_P (w
)
956 && eabs (x
- left_x
) < grabbable_width
)
957 || (!WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
958 && !WINDOW_RIGHTMOST_P (w
)
959 && eabs (x
- right_x
) < grabbable_width
))
960 return ON_VERTICAL_BORDER
;
965 /* In what's below, we subtract 1 when computing right_x because we
966 want the rightmost pixel, which is given by left_pixel+width-1. */
967 if (w
->pseudo_window_p
)
970 right_x
= WINDOW_TOTAL_WIDTH (w
) - 1;
974 left_x
= WINDOW_BOX_LEFT_EDGE_X (w
);
975 right_x
= WINDOW_BOX_RIGHT_EDGE_X (w
) - 1;
978 /* Outside any interesting column? */
979 if (x
< left_x
|| x
> right_x
)
980 return ON_SCROLL_BAR
;
982 lmargin_width
= window_box_width (w
, LEFT_MARGIN_AREA
);
983 rmargin_width
= window_box_width (w
, RIGHT_MARGIN_AREA
);
985 text_left
= window_box_left (w
, TEXT_AREA
);
986 text_right
= text_left
+ window_box_width (w
, TEXT_AREA
);
988 if (FRAME_WINDOW_P (f
))
990 if (!w
->pseudo_window_p
991 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
992 && !WINDOW_RIGHTMOST_P (w
)
993 && (eabs (x
- right_x
) < grabbable_width
))
994 return ON_VERTICAL_BORDER
;
996 /* Need to say "x > right_x" rather than >=, since on character
997 terminals, the vertical line's x coordinate is right_x. */
998 else if (!w
->pseudo_window_p
999 && !WINDOW_RIGHTMOST_P (w
)
1000 && x
> right_x
- ux
)
1001 return ON_VERTICAL_BORDER
;
1005 if (lmargin_width
> 0
1006 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1007 ? (x
>= left_x
+ WINDOW_LEFT_FRINGE_WIDTH (w
))
1008 : (x
< left_x
+ lmargin_width
)))
1009 return ON_LEFT_MARGIN
;
1011 return ON_LEFT_FRINGE
;
1014 if (x
>= text_right
)
1016 if (rmargin_width
> 0
1017 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1018 ? (x
< right_x
- WINDOW_RIGHT_FRINGE_WIDTH (w
))
1019 : (x
>= right_x
- rmargin_width
)))
1020 return ON_RIGHT_MARGIN
;
1022 return ON_RIGHT_FRINGE
;
1025 /* Everything special ruled out - must be on text area */
1029 /* Take X is the frame-relative pixel x-coordinate, and return the
1030 x-coordinate relative to part PART of window W. */
1032 window_relative_x_coord (struct window
*w
, enum window_part part
, int x
)
1034 int left_x
= (w
->pseudo_window_p
) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w
);
1039 return x
- window_box_left (w
, TEXT_AREA
);
1041 case ON_LEFT_FRINGE
:
1044 case ON_RIGHT_FRINGE
:
1045 return x
- left_x
- WINDOW_LEFT_FRINGE_WIDTH (w
);
1047 case ON_LEFT_MARGIN
:
1049 - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1050 ? WINDOW_LEFT_FRINGE_WIDTH (w
) : 0));
1052 case ON_RIGHT_MARGIN
:
1054 - ((w
->pseudo_window_p
)
1055 ? WINDOW_TOTAL_WIDTH (w
)
1056 : WINDOW_BOX_RIGHT_EDGE_X (w
))
1057 + window_box_width (w
, RIGHT_MARGIN_AREA
)
1058 + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1059 ? WINDOW_RIGHT_FRINGE_WIDTH (w
) : 0));
1062 /* ON_SCROLL_BAR, ON_NOTHING, and ON_VERTICAL_BORDER: */
1067 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p
,
1068 Scoordinates_in_window_p
, 2, 2, 0,
1069 doc
: /* Return non-nil if COORDINATES are in WINDOW.
1070 WINDOW must be a live window.
1071 COORDINATES is a cons of the form (X . Y), X and Y being distances
1072 measured in characters from the upper-left corner of the frame.
1073 \(0 . 0) denotes the character in the upper left corner of the
1075 If COORDINATES are in the text portion of WINDOW,
1076 the coordinates relative to the window are returned.
1077 If they are in the mode line of WINDOW, `mode-line' is returned.
1078 If they are in the top mode line of WINDOW, `header-line' is returned.
1079 If they are in the left fringe of WINDOW, `left-fringe' is returned.
1080 If they are in the right fringe of WINDOW, `right-fringe' is returned.
1081 If they are on the border between WINDOW and its right sibling,
1082 `vertical-line' is returned.
1083 If they are in the windows's left or right marginal areas, `left-margin'\n\
1084 or `right-margin' is returned. */)
1085 (register Lisp_Object coordinates
, Lisp_Object window
)
1092 CHECK_LIVE_WINDOW (window
);
1093 w
= XWINDOW (window
);
1094 f
= XFRAME (w
->frame
);
1095 CHECK_CONS (coordinates
);
1096 lx
= Fcar (coordinates
);
1097 ly
= Fcdr (coordinates
);
1098 CHECK_NUMBER_OR_FLOAT (lx
);
1099 CHECK_NUMBER_OR_FLOAT (ly
);
1100 x
= FRAME_PIXEL_X_FROM_CANON_X (f
, lx
) + FRAME_INTERNAL_BORDER_WIDTH (f
);
1101 y
= FRAME_PIXEL_Y_FROM_CANON_Y (f
, ly
) + FRAME_INTERNAL_BORDER_WIDTH (f
);
1103 switch (coordinates_in_window (w
, x
, y
))
1109 /* Convert X and Y to window relative pixel coordinates, and
1110 return the canonical char units. */
1111 x
-= window_box_left (w
, TEXT_AREA
);
1112 y
-= WINDOW_TOP_EDGE_Y (w
);
1113 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f
, x
),
1114 FRAME_CANON_Y_FROM_PIXEL_Y (f
, y
));
1119 case ON_VERTICAL_BORDER
:
1120 return Qvertical_line
;
1122 case ON_HEADER_LINE
:
1123 return Qheader_line
;
1125 case ON_LEFT_FRINGE
:
1126 return Qleft_fringe
;
1128 case ON_RIGHT_FRINGE
:
1129 return Qright_fringe
;
1131 case ON_LEFT_MARGIN
:
1132 return Qleft_margin
;
1134 case ON_RIGHT_MARGIN
:
1135 return Qright_margin
;
1138 /* Historically we are supposed to return nil in this case. */
1147 /* Callback for foreach_window, used in window_from_coordinates.
1148 Check if window W contains coordinates specified by USER_DATA which
1149 is actually a pointer to a struct check_window_data CW.
1151 Check if window W contains coordinates *CW->x and *CW->y. If it
1152 does, return W in *CW->window, as Lisp_Object, and return in
1153 *CW->part the part of the window under coordinates *X,*Y. Return
1154 zero from this function to stop iterating over windows. */
1156 struct check_window_data
1158 Lisp_Object
*window
;
1160 enum window_part
*part
;
1164 check_window_containing (struct window
*w
, void *user_data
)
1166 struct check_window_data
*cw
= (struct check_window_data
*) user_data
;
1167 enum window_part found
;
1170 found
= coordinates_in_window (w
, cw
->x
, cw
->y
);
1171 if (found
!= ON_NOTHING
)
1174 XSETWINDOW (*cw
->window
, w
);
1182 /* Find the window containing frame-relative pixel position X/Y and
1183 return it as a Lisp_Object.
1185 If X, Y is on one of the window's special `window_part' elements,
1186 set *PART to the id of that element.
1188 If there is no window under X, Y return nil and leave *PART
1189 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1191 This function was previously implemented with a loop cycling over
1192 windows with Fnext_window, and starting with the frame's selected
1193 window. It turned out that this doesn't work with an
1194 implementation of next_window using Vwindow_list, because
1195 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1196 tree of F when this function is called asynchronously from
1197 note_mouse_highlight. The original loop didn't terminate in this
1201 window_from_coordinates (struct frame
*f
, int x
, int y
,
1202 enum window_part
*part
, int tool_bar_p
)
1205 struct check_window_data cw
;
1206 enum window_part dummy
;
1212 cw
.window
= &window
, cw
.x
= x
, cw
.y
= y
; cw
.part
= part
;
1213 foreach_window (f
, check_window_containing
, &cw
);
1215 /* If not found above, see if it's in the tool bar window, if a tool
1219 && WINDOWP (f
->tool_bar_window
)
1220 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0
1221 && (coordinates_in_window (XWINDOW (f
->tool_bar_window
), x
, y
)
1225 window
= f
->tool_bar_window
;
1231 DEFUN ("window-at", Fwindow_at
, Swindow_at
, 2, 3, 0,
1232 doc
: /* Return window containing coordinates X and Y on FRAME.
1233 FRAME must be a live frame and defaults to the selected one.
1234 The top left corner of the frame is considered to be row 0,
1236 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame
)
1241 frame
= selected_frame
;
1242 CHECK_LIVE_FRAME (frame
);
1245 /* Check that arguments are integers or floats. */
1246 CHECK_NUMBER_OR_FLOAT (x
);
1247 CHECK_NUMBER_OR_FLOAT (y
);
1249 return window_from_coordinates (f
,
1250 (FRAME_PIXEL_X_FROM_CANON_X (f
, x
)
1251 + FRAME_INTERNAL_BORDER_WIDTH (f
)),
1252 (FRAME_PIXEL_Y_FROM_CANON_Y (f
, y
)
1253 + FRAME_INTERNAL_BORDER_WIDTH (f
)),
1257 DEFUN ("window-point", Fwindow_point
, Swindow_point
, 0, 1, 0,
1258 doc
: /* Return current value of point in WINDOW.
1259 WINDOW must be a live window and defaults to the selected one.
1261 For a nonselected window, this is the value point would have
1262 if that window were selected.
1264 Note that, when WINDOW is the selected window and its buffer
1265 is also currently selected, the value returned is the same as (point).
1266 It would be more strictly correct to return the `top-level' value
1267 of point, outside of any save-excursion forms.
1268 But that is hard to define. */)
1269 (Lisp_Object window
)
1271 register struct window
*w
= decode_window (window
);
1273 if (w
== XWINDOW (selected_window
)
1274 && current_buffer
== XBUFFER (w
->buffer
))
1276 return Fmarker_position (w
->pointm
);
1279 DEFUN ("window-start", Fwindow_start
, Swindow_start
, 0, 1, 0,
1280 doc
: /* Return position at which display currently starts in WINDOW.
1281 WINDOW must be a live window and defaults to the selected one.
1282 This is updated by redisplay or by calling `set-window-start'. */)
1283 (Lisp_Object window
)
1285 return Fmarker_position (decode_window (window
)->start
);
1288 /* This is text temporarily removed from the doc string below.
1290 This function returns nil if the position is not currently known.
1291 That happens when redisplay is preempted and doesn't finish.
1292 If in that case you want to compute where the end of the window would
1293 have been if redisplay had finished, do this:
1295 (goto-char (window-start window))
1296 (vertical-motion (1- (window-height window)) window)
1299 DEFUN ("window-end", Fwindow_end
, Swindow_end
, 0, 2, 0,
1300 doc
: /* Return position at which display currently ends in WINDOW.
1301 WINDOW must be a live window and defaults to the selected one.
1302 This is updated by redisplay, when it runs to completion.
1303 Simply changing the buffer text or setting `window-start'
1304 does not update this value.
1305 Return nil if there is no recorded value. (This can happen if the
1306 last redisplay of WINDOW was preempted, and did not finish.)
1307 If UPDATE is non-nil, compute the up-to-date position
1308 if it isn't already recorded. */)
1309 (Lisp_Object window
, Lisp_Object update
)
1312 struct window
*w
= decode_window (window
);
1320 #if 0 /* This change broke some things. We should make it later. */
1321 /* If we don't know the end position, return nil.
1322 The user can compute it with vertical-motion if he wants to.
1323 It would be nicer to do it automatically,
1324 but that's so slow that it would probably bother people. */
1325 if (NILP (w
->window_end_valid
))
1330 && ! (! NILP (w
->window_end_valid
)
1331 && w
->last_modified
>= BUF_MODIFF (b
)
1332 && w
->last_overlay_modified
>= BUF_OVERLAY_MODIFF (b
))
1335 struct text_pos startp
;
1337 struct buffer
*old_buffer
= NULL
;
1338 void *itdata
= NULL
;
1340 /* Cannot use Fvertical_motion because that function doesn't
1341 cope with variable-height lines. */
1342 if (b
!= current_buffer
)
1344 old_buffer
= current_buffer
;
1345 set_buffer_internal (b
);
1348 /* In case W->start is out of the range, use something
1349 reasonable. This situation occurred when loading a file with
1350 `-l' containing a call to `rmail' with subsequent other
1351 commands. At the end, W->start happened to be BEG, while
1352 rmail had already narrowed the buffer. */
1353 if (XMARKER (w
->start
)->charpos
< BEGV
)
1354 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
1355 else if (XMARKER (w
->start
)->charpos
> ZV
)
1356 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
1358 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
1360 itdata
= bidi_shelve_cache ();
1361 start_display (&it
, w
, startp
);
1362 move_it_vertically (&it
, window_box_height (w
));
1363 if (it
.current_y
< it
.last_visible_y
)
1364 move_it_past_eol (&it
);
1365 value
= make_number (IT_CHARPOS (it
));
1366 bidi_unshelve_cache (itdata
, 0);
1369 set_buffer_internal (old_buffer
);
1372 XSETINT (value
, BUF_Z (b
) - XFASTINT (w
->window_end_pos
));
1377 DEFUN ("set-window-point", Fset_window_point
, Sset_window_point
, 2, 2, 0,
1378 doc
: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1380 (Lisp_Object window
, Lisp_Object pos
)
1382 register struct window
*w
= decode_window (window
);
1384 CHECK_NUMBER_COERCE_MARKER (pos
);
1385 if (w
== XWINDOW (selected_window
)
1386 && XBUFFER (w
->buffer
) == current_buffer
)
1389 set_marker_restricted (w
->pointm
, pos
, w
->buffer
);
1391 /* We have to make sure that redisplay updates the window to show
1392 the new value of point. */
1393 if (!EQ (window
, selected_window
))
1394 ++windows_or_buffers_changed
;
1399 DEFUN ("set-window-start", Fset_window_start
, Sset_window_start
, 2, 3, 0,
1400 doc
: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1401 If WINDOW is nil, the selected window is used. Return POS.
1402 Optional third arg NOFORCE non-nil inhibits next redisplay from
1403 overriding motion of point in order to display at this exact start. */)
1404 (Lisp_Object window
, Lisp_Object pos
, Lisp_Object noforce
)
1406 register struct window
*w
= decode_window (window
);
1408 CHECK_NUMBER_COERCE_MARKER (pos
);
1409 set_marker_restricted (w
->start
, pos
, w
->buffer
);
1410 /* this is not right, but much easier than doing what is right. */
1411 w
->start_at_line_beg
= 0;
1414 w
->update_mode_line
= 1;
1415 w
->last_modified
= 0;
1416 w
->last_overlay_modified
= 0;
1417 if (!EQ (window
, selected_window
))
1418 windows_or_buffers_changed
++;
1423 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p
,
1424 Spos_visible_in_window_p
, 0, 3, 0,
1425 doc
: /* Return non-nil if position POS is currently on the frame in WINDOW.
1426 Return nil if that position is scrolled vertically out of view.
1427 If a character is only partially visible, nil is returned, unless the
1428 optional argument PARTIALLY is non-nil.
1429 If POS is only out of view because of horizontal scrolling, return non-nil.
1430 If POS is t, it specifies the position of the last visible glyph in WINDOW.
1431 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
1433 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
1434 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
1435 where X and Y are the pixel coordinates relative to the top left corner
1436 of the window. The remaining elements are omitted if the character after
1437 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
1438 off-window at the top and bottom of the row, ROWH is the height of the
1439 display row, and VPOS is the row number (0-based) containing POS. */)
1440 (Lisp_Object pos
, Lisp_Object window
, Lisp_Object partially
)
1442 register struct window
*w
;
1443 register EMACS_INT posint
;
1444 register struct buffer
*buf
;
1445 struct text_pos top
;
1446 Lisp_Object in_window
= Qnil
;
1447 int rtop
, rbot
, rowh
, vpos
, fully_p
= 1;
1450 w
= decode_window (window
);
1451 buf
= XBUFFER (w
->buffer
);
1452 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1456 else if (!NILP (pos
))
1458 CHECK_NUMBER_COERCE_MARKER (pos
);
1459 posint
= XINT (pos
);
1461 else if (w
== XWINDOW (selected_window
))
1464 posint
= XMARKER (w
->pointm
)->charpos
;
1466 /* If position is above window start or outside buffer boundaries,
1467 or if window start is out of range, position is not visible. */
1469 || (posint
>= CHARPOS (top
) && posint
<= BUF_ZV (buf
)))
1470 && CHARPOS (top
) >= BUF_BEGV (buf
)
1471 && CHARPOS (top
) <= BUF_ZV (buf
)
1472 && pos_visible_p (w
, posint
, &x
, &y
, &rtop
, &rbot
, &rowh
, &vpos
)
1473 && (fully_p
= !rtop
&& !rbot
, (!NILP (partially
) || fully_p
)))
1476 if (!NILP (in_window
) && !NILP (partially
))
1478 Lisp_Object part
= Qnil
;
1480 part
= list4 (make_number (rtop
), make_number (rbot
),
1481 make_number (rowh
), make_number (vpos
));
1482 in_window
= Fcons (make_number (x
),
1483 Fcons (make_number (y
), part
));
1489 DEFUN ("window-line-height", Fwindow_line_height
,
1490 Swindow_line_height
, 0, 2, 0,
1491 doc
: /* Return height in pixels of text line LINE in window WINDOW.
1492 WINDOW defaults to the selected window.
1494 Return height of current line if LINE is omitted or nil. Return height of
1495 header or mode line if LINE is `header-line' or `mode-line'.
1496 Otherwise, LINE is a text line number starting from 0. A negative number
1497 counts from the end of the window.
1499 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
1500 in pixels of the visible part of the line, VPOS and YPOS are the
1501 vertical position in lines and pixels of the line, relative to the top
1502 of the first text line, and OFFBOT is the number of off-window pixels at
1503 the bottom of the text line. If there are off-window pixels at the top
1504 of the (first) text line, YPOS is negative.
1506 Return nil if window display is not up-to-date. In that case, use
1507 `pos-visible-in-window-p' to obtain the information. */)
1508 (Lisp_Object line
, Lisp_Object window
)
1510 register struct window
*w
;
1511 register struct buffer
*b
;
1512 struct glyph_row
*row
, *end_row
;
1516 w
= decode_window (window
);
1518 if (noninteractive
|| w
->pseudo_window_p
)
1521 CHECK_BUFFER (w
->buffer
);
1522 b
= XBUFFER (w
->buffer
);
1524 /* Fail if current matrix is not up-to-date. */
1525 if (NILP (w
->window_end_valid
)
1526 || current_buffer
->clip_changed
1527 || current_buffer
->prevent_redisplay_optimizations_p
1528 || w
->last_modified
< BUF_MODIFF (b
)
1529 || w
->last_overlay_modified
< BUF_OVERLAY_MODIFF (b
))
1535 if (i
< 0 || i
>= w
->current_matrix
->nrows
1536 || (row
= MATRIX_ROW (w
->current_matrix
, i
), !row
->enabled_p
))
1538 max_y
= window_text_bottom_y (w
);
1542 if (EQ (line
, Qheader_line
))
1544 if (!WINDOW_WANTS_HEADER_LINE_P (w
))
1546 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
1547 if (!row
->enabled_p
)
1549 return list4 (make_number (row
->height
),
1550 make_number (0), make_number (0),
1554 if (EQ (line
, Qmode_line
))
1556 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
1557 if (!row
->enabled_p
)
1559 return list4 (make_number (row
->height
),
1560 make_number (0), /* not accurate */
1561 make_number (WINDOW_HEADER_LINE_HEIGHT (w
)
1562 + window_text_bottom_y (w
)),
1566 CHECK_NUMBER (line
);
1569 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1570 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
1571 max_y
= window_text_bottom_y (w
);
1574 while ((n
< 0 || i
< n
)
1575 && row
<= end_row
&& row
->enabled_p
1576 && row
->y
+ row
->height
< max_y
)
1579 if (row
> end_row
|| !row
->enabled_p
)
1591 crop
= max (0, (row
->y
+ row
->height
) - max_y
);
1592 return list4 (make_number (row
->height
+ min (0, row
->y
) - crop
),
1594 make_number (row
->y
),
1595 make_number (crop
));
1598 DEFUN ("window-dedicated-p", Fwindow_dedicated_p
, Swindow_dedicated_p
,
1600 doc
: /* Return non-nil when WINDOW is dedicated to its buffer.
1601 More precisely, return the value assigned by the last call of
1602 `set-window-dedicated-p' for WINDOW. Return nil if that function was
1603 never called with WINDOW as its argument, or the value set by that
1604 function was internally reset since its last call. WINDOW defaults to
1605 the selected window.
1607 When a window is dedicated to its buffer, `display-buffer' will refrain
1608 from displaying another buffer in it. `get-lru-window' and
1609 `get-largest-window' treat dedicated windows specially.
1610 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1611 `kill-buffer' can delete a dedicated window and the containing frame.
1613 Functions like `set-window-buffer' may change the buffer displayed by a
1614 window, unless that window is "strongly" dedicated to its buffer, that
1615 is the value returned by `window-dedicated-p' is t. */)
1616 (Lisp_Object window
)
1618 return decode_window (window
)->dedicated
;
1621 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p
,
1622 Sset_window_dedicated_p
, 2, 2, 0,
1623 doc
: /* Mark WINDOW as dedicated according to FLAG.
1624 WINDOW must be a live window and defaults to the selected one. FLAG
1625 non-nil means mark WINDOW as dedicated to its buffer. FLAG nil means
1626 mark WINDOW as non-dedicated. Return FLAG.
1628 When a window is dedicated to its buffer, `display-buffer' will refrain
1629 from displaying another buffer in it. `get-lru-window' and
1630 `get-largest-window' treat dedicated windows specially.
1631 `delete-windows-on', `replace-buffer-in-windows', `quit-window',
1632 `quit-restore-window' and `kill-buffer' can delete a dedicated window
1633 and the containing frame.
1635 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
1636 its buffer. Functions like `set-window-buffer' may change the buffer
1637 displayed by a window, unless that window is strongly dedicated to its
1638 buffer. If and when `set-window-buffer' displays another buffer in a
1639 window, it also makes sure that the window is no more dedicated. */)
1640 (Lisp_Object window
, Lisp_Object flag
)
1642 register struct window
*w
= decode_window (window
);
1644 w
->dedicated
= flag
;
1645 return w
->dedicated
;
1648 DEFUN ("window-prev-buffers", Fwindow_prev_buffers
, Swindow_prev_buffers
,
1650 doc
: /* Return buffers previously shown in WINDOW.
1651 WINDOW must be a live window and defaults to the selected one.
1653 The return value is a list of elements (BUFFER WINDOW-START POS),
1654 where BUFFER is a buffer, WINDOW-START is the start position of the
1655 window for that buffer, and POS is a window-specific point value. */)
1656 (Lisp_Object window
)
1658 return decode_window (window
)->prev_buffers
;
1661 DEFUN ("set-window-prev-buffers", Fset_window_prev_buffers
,
1662 Sset_window_prev_buffers
, 2, 2, 0,
1663 doc
: /* Set WINDOW's previous buffers to PREV-BUFFERS.
1664 WINDOW must be a live window and defaults to the selected one.
1666 PREV-BUFFERS should be a list of elements (BUFFER WINDOW-START POS),
1667 where BUFFER is a buffer, WINDOW-START is the start position of the
1668 window for that buffer, and POS is a window-specific point value. */)
1669 (Lisp_Object window
, Lisp_Object prev_buffers
)
1671 return decode_window (window
)->prev_buffers
= prev_buffers
;
1674 DEFUN ("window-next-buffers", Fwindow_next_buffers
, Swindow_next_buffers
,
1676 doc
: /* Return list of buffers recently re-shown in WINDOW.
1677 WINDOW must be a live window and defaults to the selected one. */)
1678 (Lisp_Object window
)
1680 return decode_window (window
)->next_buffers
;
1683 DEFUN ("set-window-next-buffers", Fset_window_next_buffers
,
1684 Sset_window_next_buffers
, 2, 2, 0,
1685 doc
: /* Set WINDOW's next buffers to NEXT-BUFFERS.
1686 WINDOW must be a live window and defaults to the selected one.
1687 NEXT-BUFFERS should be a list of buffers. */)
1688 (Lisp_Object window
, Lisp_Object next_buffers
)
1690 return decode_window (window
)->next_buffers
= next_buffers
;
1693 DEFUN ("window-parameters", Fwindow_parameters
, Swindow_parameters
,
1695 doc
: /* Return the parameters of WINDOW and their values.
1696 WINDOW defaults to the selected window. The return value is a list of
1697 elements of the form (PARAMETER . VALUE). */)
1698 (Lisp_Object window
)
1700 return Fcopy_alist (decode_any_window (window
)->window_parameters
);
1703 DEFUN ("window-parameter", Fwindow_parameter
, Swindow_parameter
,
1705 doc
: /* Return WINDOW's value for PARAMETER.
1706 WINDOW defaults to the selected window. */)
1707 (Lisp_Object window
, Lisp_Object parameter
)
1711 result
= Fassq (parameter
, decode_any_window (window
)->window_parameters
);
1712 return CDR_SAFE (result
);
1715 DEFUN ("set-window-parameter", Fset_window_parameter
,
1716 Sset_window_parameter
, 3, 3, 0,
1717 doc
: /* Set WINDOW's value of PARAMETER to VALUE.
1718 WINDOW defaults to the selected window. Return VALUE. */)
1719 (Lisp_Object window
, Lisp_Object parameter
, Lisp_Object value
)
1721 register struct window
*w
= decode_any_window (window
);
1722 Lisp_Object old_alist_elt
;
1724 old_alist_elt
= Fassq (parameter
, w
->window_parameters
);
1725 if (NILP (old_alist_elt
))
1726 w
->window_parameters
= Fcons (Fcons (parameter
, value
), w
->window_parameters
);
1728 Fsetcdr (old_alist_elt
, value
);
1732 DEFUN ("window-display-table", Fwindow_display_table
, Swindow_display_table
,
1734 doc
: /* Return the display-table that WINDOW is using.
1735 WINDOW defaults to the selected window. */)
1736 (Lisp_Object window
)
1738 return decode_window (window
)->display_table
;
1741 /* Get the display table for use on window W. This is either W's
1742 display table or W's buffer's display table. Ignore the specified
1743 tables if they are not valid; if no valid table is specified,
1746 struct Lisp_Char_Table
*
1747 window_display_table (struct window
*w
)
1749 struct Lisp_Char_Table
*dp
= NULL
;
1751 if (DISP_TABLE_P (w
->display_table
))
1752 dp
= XCHAR_TABLE (w
->display_table
);
1753 else if (BUFFERP (w
->buffer
))
1755 struct buffer
*b
= XBUFFER (w
->buffer
);
1757 if (DISP_TABLE_P (BVAR (b
, display_table
)))
1758 dp
= XCHAR_TABLE (BVAR (b
, display_table
));
1759 else if (DISP_TABLE_P (Vstandard_display_table
))
1760 dp
= XCHAR_TABLE (Vstandard_display_table
);
1766 DEFUN ("set-window-display-table", Fset_window_display_table
, Sset_window_display_table
, 2, 2, 0,
1767 doc
: /* Set WINDOW's display-table to TABLE. */)
1768 (register Lisp_Object window
, Lisp_Object table
)
1770 register struct window
*w
;
1772 w
= decode_window (window
);
1773 w
->display_table
= table
;
1777 /* Record info on buffer window W is displaying
1778 when it is about to cease to display that buffer. */
1780 unshow_buffer (register struct window
*w
)
1787 if (b
!= XMARKER (w
->pointm
)->buffer
)
1791 if (w
== XWINDOW (selected_window
)
1792 || ! EQ (buf
, XWINDOW (selected_window
)->buffer
))
1793 /* Do this except when the selected window's buffer
1794 is being removed from some other window. */
1796 /* last_window_start records the start position that this buffer
1797 had in the last window to be disconnected from it.
1798 Now that this statement is unconditional,
1799 it is possible for the buffer to be displayed in the
1800 selected window, while last_window_start reflects another
1801 window which was recently showing the same buffer.
1802 Some people might say that might be a good thing. Let's see. */
1803 b
->last_window_start
= marker_position (w
->start
);
1805 /* Point in the selected window's buffer
1806 is actually stored in that buffer, and the window's pointm isn't used.
1807 So don't clobber point in that buffer. */
1808 if (! EQ (buf
, XWINDOW (selected_window
)->buffer
)
1809 /* This line helps to fix Horsley's testbug.el bug. */
1810 && !(WINDOWP (BVAR (b
, last_selected_window
))
1811 && w
!= XWINDOW (BVAR (b
, last_selected_window
))
1812 && EQ (buf
, XWINDOW (BVAR (b
, last_selected_window
))->buffer
)))
1813 temp_set_point_both (b
,
1814 clip_to_bounds (BUF_BEGV (b
),
1815 XMARKER (w
->pointm
)->charpos
,
1817 clip_to_bounds (BUF_BEGV_BYTE (b
),
1818 marker_byte_position (w
->pointm
),
1821 if (WINDOWP (BVAR (b
, last_selected_window
))
1822 && w
== XWINDOW (BVAR (b
, last_selected_window
)))
1823 BVAR (b
, last_selected_window
) = Qnil
;
1826 /* Put NEW into the window structure in place of OLD. SETFLAG zero
1827 means change window structure only. Otherwise store geometry and
1828 other settings as well. */
1830 replace_window (Lisp_Object old
, Lisp_Object
new, int setflag
)
1832 register Lisp_Object tem
;
1833 register struct window
*o
= XWINDOW (old
), *n
= XWINDOW (new);
1835 /* If OLD is its frame's root window, then NEW is the new
1836 root window for that frame. */
1837 if (EQ (old
, FRAME_ROOT_WINDOW (XFRAME (o
->frame
))))
1838 FRAME_ROOT_WINDOW (XFRAME (o
->frame
)) = new;
1842 n
->left_col
= o
->left_col
;
1843 n
->top_line
= o
->top_line
;
1844 n
->total_cols
= o
->total_cols
;
1845 n
->total_lines
= o
->total_lines
;
1846 n
->normal_cols
= o
->normal_cols
;
1847 o
->normal_cols
= make_float (1.0);
1848 n
->normal_lines
= o
->normal_lines
;
1849 o
->normal_lines
= make_float (1.0);
1850 n
->desired_matrix
= n
->current_matrix
= 0;
1852 memset (&n
->cursor
, 0, sizeof (n
->cursor
));
1853 memset (&n
->last_cursor
, 0, sizeof (n
->last_cursor
));
1854 memset (&n
->phys_cursor
, 0, sizeof (n
->phys_cursor
));
1855 n
->phys_cursor_type
= -1;
1856 n
->phys_cursor_width
= -1;
1857 n
->must_be_updated_p
= 0;
1858 n
->pseudo_window_p
= 0;
1859 XSETFASTINT (n
->window_end_vpos
, 0);
1860 XSETFASTINT (n
->window_end_pos
, 0);
1861 n
->window_end_valid
= Qnil
;
1862 n
->frozen_window_start_p
= 0;
1865 n
->next
= tem
= o
->next
;
1867 XWINDOW (tem
)->prev
= new;
1869 n
->prev
= tem
= o
->prev
;
1871 XWINDOW (tem
)->next
= new;
1873 n
->parent
= tem
= o
->parent
;
1876 if (EQ (XWINDOW (tem
)->vchild
, old
))
1877 XWINDOW (tem
)->vchild
= new;
1878 if (EQ (XWINDOW (tem
)->hchild
, old
))
1879 XWINDOW (tem
)->hchild
= new;
1883 /* If window WINDOW and its parent window are iso-combined, merge
1884 WINDOW's children into those of its parent window and mark WINDOW as
1888 recombine_windows (Lisp_Object window
)
1890 struct window
*w
, *p
, *c
;
1891 Lisp_Object parent
, child
;
1894 w
= XWINDOW (window
);
1896 if (!NILP (parent
) && NILP (w
->combination_limit
))
1898 p
= XWINDOW (parent
);
1899 if (((!NILP (p
->vchild
) && !NILP (w
->vchild
))
1900 || (!NILP (p
->hchild
) && !NILP (w
->hchild
))))
1901 /* WINDOW and PARENT are both either a vertical or a horizontal
1904 horflag
= NILP (w
->vchild
);
1905 child
= horflag
? w
->hchild
: w
->vchild
;
1906 c
= XWINDOW (child
);
1908 /* Splice WINDOW's children into its parent's children and
1909 assign new normal sizes. */
1918 XWINDOW (w
->prev
)->next
= child
;
1927 = make_float (XFLOATINT (c
->total_cols
)
1928 / XFLOATINT (p
->total_cols
));
1931 = make_float (XFLOATINT (c
->total_lines
)
1932 / XFLOATINT (p
->total_lines
));
1936 if (!NILP (w
->next
))
1939 XWINDOW (c
->next
)->prev
= child
;
1947 c
= XWINDOW (child
);
1951 /* WINDOW can be deleted now. */
1952 w
->vchild
= w
->hchild
= Qnil
;
1957 /* If WINDOW can be deleted, delete it. */
1959 delete_deletable_window (Lisp_Object window
)
1961 if (!NILP (call1 (Qwindow_deletable_p
, window
)))
1962 call1 (Qdelete_window
, window
);
1965 /***********************************************************************
1967 ***********************************************************************/
1969 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1970 pointer. This is a callback function for foreach_window, used in
1971 the window_list function. */
1974 add_window_to_list (struct window
*w
, void *user_data
)
1976 Lisp_Object
*list
= (Lisp_Object
*) user_data
;
1978 XSETWINDOW (window
, w
);
1979 *list
= Fcons (window
, *list
);
1984 /* Return a list of all windows, for use by next_window. If
1985 Vwindow_list is a list, return that list. Otherwise, build a new
1986 list, cache it in Vwindow_list, and return that. */
1991 if (!CONSP (Vwindow_list
))
1995 Vwindow_list
= Qnil
;
1996 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
1998 Lisp_Object args
[2];
2000 /* We are visiting windows in canonical order, and add
2001 new windows at the front of args[1], which means we
2002 have to reverse this list at the end. */
2004 foreach_window (XFRAME (XCAR (tail
)), add_window_to_list
, &args
[1]);
2005 args
[0] = Vwindow_list
;
2006 args
[1] = Fnreverse (args
[1]);
2007 Vwindow_list
= Fnconc (2, args
);
2011 return Vwindow_list
;
2015 /* Value is non-zero if WINDOW satisfies the constraints given by
2016 OWINDOW, MINIBUF and ALL_FRAMES.
2018 MINIBUF t means WINDOW may be minibuffer windows.
2019 `lambda' means WINDOW may not be a minibuffer window.
2020 a window means a specific minibuffer window
2022 ALL_FRAMES t means search all frames,
2023 nil means search just current frame,
2024 `visible' means search just visible frames on the
2026 0 means search visible and iconified frames on the
2028 a window means search the frame that window belongs to,
2029 a frame means consider windows on that frame, only. */
2032 candidate_window_p (Lisp_Object window
, Lisp_Object owindow
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2034 struct window
*w
= XWINDOW (window
);
2035 struct frame
*f
= XFRAME (w
->frame
);
2036 int candidate_p
= 1;
2038 if (!BUFFERP (w
->buffer
))
2040 else if (MINI_WINDOW_P (w
)
2041 && (EQ (minibuf
, Qlambda
)
2042 || (WINDOWP (minibuf
) && !EQ (minibuf
, window
))))
2044 /* If MINIBUF is `lambda' don't consider any mini-windows.
2045 If it is a window, consider only that one. */
2048 else if (EQ (all_frames
, Qt
))
2050 else if (NILP (all_frames
))
2052 eassert (WINDOWP (owindow
));
2053 candidate_p
= EQ (w
->frame
, XWINDOW (owindow
)->frame
);
2055 else if (EQ (all_frames
, Qvisible
))
2057 FRAME_SAMPLE_VISIBILITY (f
);
2058 candidate_p
= FRAME_VISIBLE_P (f
)
2059 && (FRAME_TERMINAL (XFRAME (w
->frame
))
2060 == FRAME_TERMINAL (XFRAME (selected_frame
)));
2063 else if (INTEGERP (all_frames
) && XINT (all_frames
) == 0)
2065 FRAME_SAMPLE_VISIBILITY (f
);
2066 candidate_p
= (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)
2067 #ifdef HAVE_X_WINDOWS
2068 /* Yuck!! If we've just created the frame and the
2069 window-manager requested the user to place it
2070 manually, the window may still not be considered
2071 `visible'. I'd argue it should be at least
2072 something like `iconified', but don't know how to do
2074 || (FRAME_X_P (f
) && f
->output_data
.x
->asked_for_visible
2075 && !f
->output_data
.x
->has_been_visible
)
2078 && (FRAME_TERMINAL (XFRAME (w
->frame
))
2079 == FRAME_TERMINAL (XFRAME (selected_frame
)));
2081 else if (WINDOWP (all_frames
))
2082 candidate_p
= (EQ (FRAME_MINIBUF_WINDOW (f
), all_frames
)
2083 || EQ (XWINDOW (all_frames
)->frame
, w
->frame
)
2084 || EQ (XWINDOW (all_frames
)->frame
, FRAME_FOCUS_FRAME (f
)));
2085 else if (FRAMEP (all_frames
))
2086 candidate_p
= EQ (all_frames
, w
->frame
);
2092 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
2093 Fwindow_list. See candidate_window_p for the meaning of WINDOW,
2094 MINIBUF, and ALL_FRAMES. */
2097 decode_next_window_args (Lisp_Object
*window
, Lisp_Object
*minibuf
, Lisp_Object
*all_frames
)
2100 *window
= selected_window
;
2102 CHECK_LIVE_WINDOW (*window
);
2104 /* MINIBUF nil may or may not include minibuffers. Decide if it
2106 if (NILP (*minibuf
))
2107 *minibuf
= minibuf_level
? minibuf_window
: Qlambda
;
2108 else if (!EQ (*minibuf
, Qt
))
2111 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
2112 => count none of them, or a specific minibuffer window (the
2113 active one) to count. */
2115 /* ALL_FRAMES nil doesn't specify which frames to include. */
2116 if (NILP (*all_frames
))
2117 *all_frames
= (!EQ (*minibuf
, Qlambda
)
2118 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window
)->frame
))
2120 else if (EQ (*all_frames
, Qvisible
))
2122 else if (EQ (*all_frames
, make_number (0)))
2124 else if (FRAMEP (*all_frames
))
2126 else if (!EQ (*all_frames
, Qt
))
2131 /* Return the next or previous window of WINDOW in cyclic ordering
2132 of windows. NEXT_P non-zero means return the next window. See the
2133 documentation string of next-window for the meaning of MINIBUF and
2137 next_window (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
, int next_p
)
2139 decode_next_window_args (&window
, &minibuf
, &all_frames
);
2141 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
2142 return the first window on the frame. */
2143 if (FRAMEP (all_frames
)
2144 && !EQ (all_frames
, XWINDOW (window
)->frame
))
2145 return Fframe_first_window (all_frames
);
2151 /* Find WINDOW in the list of all windows. */
2152 list
= Fmemq (window
, window_list ());
2154 /* Scan forward from WINDOW to the end of the window list. */
2156 for (list
= XCDR (list
); CONSP (list
); list
= XCDR (list
))
2157 if (candidate_window_p (XCAR (list
), window
, minibuf
, all_frames
))
2160 /* Scan from the start of the window list up to WINDOW. */
2162 for (list
= Vwindow_list
;
2163 CONSP (list
) && !EQ (XCAR (list
), window
);
2165 if (candidate_window_p (XCAR (list
), window
, minibuf
, all_frames
))
2169 window
= XCAR (list
);
2173 Lisp_Object candidate
, list
;
2175 /* Scan through the list of windows for candidates. If there are
2176 candidate windows in front of WINDOW, the last one of these
2177 is the one we want. If there are candidates following WINDOW
2178 in the list, again the last one of these is the one we want. */
2180 for (list
= window_list (); CONSP (list
); list
= XCDR (list
))
2182 if (EQ (XCAR (list
), window
))
2184 if (WINDOWP (candidate
))
2187 else if (candidate_window_p (XCAR (list
), window
, minibuf
,
2189 candidate
= XCAR (list
);
2192 if (WINDOWP (candidate
))
2200 DEFUN ("next-window", Fnext_window
, Snext_window
, 0, 3, 0,
2201 doc
: /* Return live window after WINDOW in the cyclic ordering of windows.
2202 WINDOW must be a live window and defaults to the selected one. The
2203 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2206 MINIBUF nil or omitted means consider the minibuffer window only if the
2207 minibuffer is active. MINIBUF t means consider the minibuffer window
2208 even if the minibuffer is not active. Any other value means do not
2209 consider the minibuffer window even if the minibuffer is active.
2211 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2212 plus the minibuffer window if specified by the MINIBUF argument. If the
2213 minibuffer counts, consider all windows on all frames that share that
2214 minibuffer too. The following non-nil values of ALL-FRAMES have special
2217 - t means consider all windows on all existing frames.
2219 - `visible' means consider all windows on all visible frames.
2221 - 0 (the number zero) means consider all windows on all visible and
2224 - A frame means consider all windows on that frame only.
2226 Anything else means consider all windows on WINDOW's frame and no
2229 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2230 `next-window' to iterate through the entire cycle of acceptable
2231 windows, eventually ending up back at the window you started with.
2232 `previous-window' traverses the same cycle, in the reverse order. */)
2233 (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2235 return next_window (window
, minibuf
, all_frames
, 1);
2239 DEFUN ("previous-window", Fprevious_window
, Sprevious_window
, 0, 3, 0,
2240 doc
: /* Return live window before WINDOW in the cyclic ordering of windows.
2241 WINDOW must be a live window and defaults to the selected one. The
2242 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2245 MINIBUF nil or omitted means consider the minibuffer window only if the
2246 minibuffer is active. MINIBUF t means consider the minibuffer window
2247 even if the minibuffer is not active. Any other value means do not
2248 consider the minibuffer window even if the minibuffer is active.
2250 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2251 plus the minibuffer window if specified by the MINIBUF argument. If the
2252 minibuffer counts, consider all windows on all frames that share that
2253 minibuffer too. The following non-nil values of ALL-FRAMES have special
2256 - t means consider all windows on all existing frames.
2258 - `visible' means consider all windows on all visible frames.
2260 - 0 (the number zero) means consider all windows on all visible and
2263 - A frame means consider all windows on that frame only.
2265 Anything else means consider all windows on WINDOW's frame and no
2268 If you use consistent values for MINIBUF and ALL-FRAMES, you can
2269 use `previous-window' to iterate through the entire cycle of
2270 acceptable windows, eventually ending up back at the window you
2271 started with. `next-window' traverses the same cycle, in the
2273 (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2275 return next_window (window
, minibuf
, all_frames
, 0);
2279 /* Return a list of windows in cyclic ordering. Arguments are like
2280 for `next-window'. */
2283 window_list_1 (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2285 Lisp_Object tail
, list
, rest
;
2287 decode_next_window_args (&window
, &minibuf
, &all_frames
);
2290 for (tail
= window_list (); CONSP (tail
); tail
= XCDR (tail
))
2291 if (candidate_window_p (XCAR (tail
), window
, minibuf
, all_frames
))
2292 list
= Fcons (XCAR (tail
), list
);
2294 /* Rotate the list to start with WINDOW. */
2295 list
= Fnreverse (list
);
2296 rest
= Fmemq (window
, list
);
2297 if (!NILP (rest
) && !EQ (rest
, list
))
2299 for (tail
= list
; !EQ (XCDR (tail
), rest
); tail
= XCDR (tail
))
2301 XSETCDR (tail
, Qnil
);
2302 list
= nconc2 (rest
, list
);
2308 DEFUN ("window-list", Fwindow_list
, Swindow_list
, 0, 3, 0,
2309 doc
: /* Return a list of windows on FRAME, starting with WINDOW.
2310 FRAME nil or omitted means use the selected frame.
2311 WINDOW nil or omitted means use the window selected within FRAME.
2312 MINIBUF t means include the minibuffer window, even if it isn't active.
2313 MINIBUF nil or omitted means include the minibuffer window only
2315 MINIBUF neither nil nor t means never include the minibuffer window. */)
2316 (Lisp_Object frame
, Lisp_Object minibuf
, Lisp_Object window
)
2319 window
= FRAMEP (frame
) ? XFRAME (frame
)->selected_window
: selected_window
;
2320 CHECK_WINDOW (window
);
2322 frame
= selected_frame
;
2324 if (!EQ (frame
, XWINDOW (window
)->frame
))
2325 error ("Window is on a different frame");
2327 return window_list_1 (window
, minibuf
, frame
);
2331 DEFUN ("window-list-1", Fwindow_list_1
, Swindow_list_1
, 0, 3, 0,
2332 doc
: /* Return a list of all live windows.
2333 WINDOW specifies the first window to list and defaults to the selected
2336 Optional argument MINIBUF nil or omitted means consider the minibuffer
2337 window only if the minibuffer is active. MINIBUF t means consider the
2338 minibuffer window even if the minibuffer is not active. Any other value
2339 means do not consider the minibuffer window even if the minibuffer is
2342 Optional argument ALL-FRAMES nil or omitted means consider all windows
2343 on WINDOW's frame, plus the minibuffer window if specified by the
2344 MINIBUF argument. If the minibuffer counts, consider all windows on all
2345 frames that share that minibuffer too. The following non-nil values of
2346 ALL-FRAMES have special meanings:
2348 - t means consider all windows on all existing frames.
2350 - `visible' means consider all windows on all visible frames.
2352 - 0 (the number zero) means consider all windows on all visible and
2355 - A frame means consider all windows on that frame only.
2357 Anything else means consider all windows on WINDOW's frame and no
2360 If WINDOW is not on the list of windows returned, some other window will
2361 be listed first but no error is signaled. */)
2362 (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2364 return window_list_1 (window
, minibuf
, all_frames
);
2367 /* Look at all windows, performing an operation specified by TYPE
2369 If FRAMES is Qt, look at all frames;
2370 Qnil, look at just the selected frame;
2371 Qvisible, look at visible frames;
2372 a frame, just look at windows on that frame.
2373 If MINI is non-zero, perform the operation on minibuffer windows too. */
2378 GET_BUFFER_WINDOW
, /* Arg is buffer */
2379 REPLACE_BUFFER_IN_WINDOWS_SAFELY
, /* Arg is buffer */
2380 REDISPLAY_BUFFER_WINDOWS
, /* Arg is buffer */
2385 window_loop (enum window_loop type
, Lisp_Object obj
, int mini
, Lisp_Object frames
)
2387 Lisp_Object window
, windows
, best_window
, frame_arg
;
2388 int frame_best_window_flag
= 0;
2390 struct gcpro gcpro1
;
2392 /* If we're only looping through windows on a particular frame,
2393 frame points to that frame. If we're looping through windows
2394 on all frames, frame is 0. */
2395 if (FRAMEP (frames
))
2396 f
= XFRAME (frames
);
2397 else if (NILP (frames
))
2398 f
= SELECTED_FRAME ();
2403 frame_arg
= Qlambda
;
2404 else if (EQ (frames
, make_number (0)))
2406 else if (EQ (frames
, Qvisible
))
2411 /* frame_arg is Qlambda to stick to one frame,
2412 Qvisible to consider all visible frames,
2415 /* Pick a window to start with. */
2419 window
= FRAME_SELECTED_WINDOW (f
);
2421 window
= FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2423 windows
= window_list_1 (window
, mini
? Qt
: Qnil
, frame_arg
);
2427 for (; CONSP (windows
); windows
= XCDR (windows
))
2431 window
= XCAR (windows
);
2432 w
= XWINDOW (window
);
2434 /* Note that we do not pay attention here to whether the frame
2435 is visible, since Fwindow_list skips non-visible frames if
2436 that is desired, under the control of frame_arg. */
2437 if (!MINI_WINDOW_P (w
)
2438 /* For REPLACE_BUFFER_IN_WINDOWS_SAFELY, we must always
2439 consider all windows. */
2440 || type
== REPLACE_BUFFER_IN_WINDOWS_SAFELY
2441 || (mini
&& minibuf_level
> 0))
2444 case GET_BUFFER_WINDOW
:
2445 if (EQ (w
->buffer
, obj
)
2446 /* Don't find any minibuffer window except the one that
2447 is currently in use. */
2448 && (MINI_WINDOW_P (w
) ? EQ (window
, minibuf_window
) : 1))
2450 if (EQ (window
, selected_window
))
2451 /* Preferably return the selected window. */
2452 RETURN_UNGCPRO (window
);
2453 else if (EQ (XWINDOW (window
)->frame
, selected_frame
)
2454 && !frame_best_window_flag
)
2455 /* Prefer windows on the current frame (but don't
2456 choose another one if we have one already). */
2458 best_window
= window
;
2459 frame_best_window_flag
= 1;
2461 else if (NILP (best_window
))
2462 best_window
= window
;
2466 case REPLACE_BUFFER_IN_WINDOWS_SAFELY
:
2467 /* We could simply check whether the buffer shown by window
2468 is live, and show another buffer in case it isn't. */
2469 if (EQ (w
->buffer
, obj
))
2471 /* Undedicate WINDOW. */
2472 w
->dedicated
= Qnil
;
2473 /* Make WINDOW show the buffer returned by
2474 other_buffer_safely, don't run any hooks. */
2476 (window
, other_buffer_safely (w
->buffer
), 0, 0);
2477 /* If WINDOW is the selected window, make its buffer
2478 current. But do so only if the window shows the
2479 current buffer (Bug#6454). */
2480 if (EQ (window
, selected_window
)
2481 && XBUFFER (w
->buffer
) == current_buffer
)
2482 Fset_buffer (w
->buffer
);
2486 case REDISPLAY_BUFFER_WINDOWS
:
2487 if (EQ (w
->buffer
, obj
))
2489 mark_window_display_accurate (window
, 0);
2490 w
->update_mode_line
= 1;
2491 XBUFFER (obj
)->prevent_redisplay_optimizations_p
= 1;
2492 ++update_mode_lines
;
2493 best_window
= window
;
2497 /* Check for a window that has a killed buffer. */
2498 case CHECK_ALL_WINDOWS
:
2499 if (! NILP (w
->buffer
)
2500 && NILP (BVAR (XBUFFER (w
->buffer
), name
)))
2504 case WINDOW_LOOP_UNUSED
:
2513 /* Used for debugging. Abort if any window has a dead buffer. */
2515 extern void check_all_windows (void) EXTERNALLY_VISIBLE
;
2517 check_all_windows (void)
2519 window_loop (CHECK_ALL_WINDOWS
, Qnil
, 1, Qt
);
2522 DEFUN ("get-buffer-window", Fget_buffer_window
, Sget_buffer_window
, 0, 2, 0,
2523 doc
: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2524 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to
2527 The optional argument ALL-FRAMES specifies the frames to consider:
2529 - t means consider all windows on all existing frames.
2531 - `visible' means consider all windows on all visible frames.
2533 - 0 (the number zero) means consider all windows on all visible
2534 and iconified frames.
2536 - A frame means consider all windows on that frame only.
2538 Any other value of ALL-FRAMES means consider all windows on the
2539 selected frame and no others. */)
2540 (Lisp_Object buffer_or_name
, Lisp_Object all_frames
)
2544 if (NILP (buffer_or_name
))
2545 buffer
= Fcurrent_buffer ();
2547 buffer
= Fget_buffer (buffer_or_name
);
2549 if (BUFFERP (buffer
))
2550 return window_loop (GET_BUFFER_WINDOW
, buffer
, 1, all_frames
);
2556 resize_root_window (Lisp_Object window
, Lisp_Object delta
, Lisp_Object horizontal
, Lisp_Object ignore
)
2558 return call4 (Qwindow_resize_root_window
, window
, delta
, horizontal
, ignore
);
2562 DEFUN ("delete-other-windows-internal", Fdelete_other_windows_internal
,
2563 Sdelete_other_windows_internal
, 0, 2, "",
2564 doc
: /* Make WINDOW fill its frame.
2565 Only the frame WINDOW is on is affected. WINDOW may be any window and
2566 defaults to the selected one.
2568 Optional argument ROOT, if non-nil, must specify an internal window such
2569 that WINDOW is in its window subtree. If this is the case, replace ROOT
2570 by WINDOW and leave alone any windows not part of ROOT's subtree.
2572 When WINDOW is live try to reduce display jumps by keeping the text
2573 previously visible in WINDOW in the same place on the frame. Doing this
2574 depends on the value of (window-start WINDOW), so if calling this
2575 function in a program gives strange scrolling, make sure the
2576 window-start value is reasonable when this function is called. */)
2577 (Lisp_Object window
, Lisp_Object root
)
2579 struct window
*w
, *r
, *s
;
2581 Lisp_Object sibling
, pwindow
, swindow
IF_LINT (= Qnil
), delta
;
2582 ptrdiff_t startpos
IF_LINT (= 0);
2583 int top
IF_LINT (= 0), new_top
, resize_failed
;
2585 w
= decode_any_window (window
);
2586 XSETWINDOW (window
, w
);
2587 f
= XFRAME (w
->frame
);
2590 /* ROOT is the frame's root window. */
2592 root
= FRAME_ROOT_WINDOW (f
);
2596 /* ROOT must be an ancestor of WINDOW. */
2598 r
= decode_any_window (root
);
2599 pwindow
= XWINDOW (window
)->parent
;
2600 while (!NILP (pwindow
))
2601 if (EQ (pwindow
, root
))
2604 pwindow
= XWINDOW (pwindow
)->parent
;
2605 if (!EQ (pwindow
, root
))
2606 error ("Specified root is not an ancestor of specified window");
2609 if (EQ (window
, root
))
2612 /* I don't understand the "top > 0" part below. If we deal with a
2613 standalone minibuffer it would have been caught by the preceding
2615 else if (MINI_WINDOW_P (w
)) /* && top > 0) */
2616 error ("Can't expand minibuffer to full frame");
2618 if (!NILP (w
->buffer
))
2620 startpos
= marker_position (w
->start
);
2621 top
= WINDOW_TOP_EDGE_LINE (w
)
2622 - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w
)));
2623 /* Make sure WINDOW is the frame's selected window. */
2624 if (!EQ (window
, FRAME_SELECTED_WINDOW (f
)))
2626 if (EQ (selected_frame
, w
->frame
))
2627 Fselect_window (window
, Qnil
);
2629 FRAME_SELECTED_WINDOW (f
) = window
;
2634 /* See if the frame's selected window is a part of the window
2635 subtree rooted at WINDOW, by finding all the selected window's
2636 parents and comparing each one with WINDOW. If it isn't we
2637 need a new selected window for this frame. */
2638 swindow
= FRAME_SELECTED_WINDOW (f
);
2642 while (!NILP (pwindow
) && !EQ (window
, pwindow
))
2643 pwindow
= XWINDOW (pwindow
)->parent
;
2645 if (EQ (window
, pwindow
))
2646 /* If WINDOW is an ancestor of SWINDOW, then SWINDOW is ok
2647 as the new selected window. */
2650 /* Else try the previous window of SWINDOW. */
2651 swindow
= Fprevious_window (swindow
, Qlambda
, Qnil
);
2654 if (!EQ (swindow
, FRAME_SELECTED_WINDOW (f
)))
2656 if (EQ (selected_frame
, w
->frame
))
2657 Fselect_window (swindow
, Qnil
);
2659 FRAME_SELECTED_WINDOW (f
) = swindow
;
2664 if (!FRAME_INITIAL_P (f
))
2666 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
2668 /* We are going to free the glyph matrices of WINDOW, and with
2669 that we might lose any information about glyph rows that have
2670 some of their glyphs highlighted in mouse face. (These rows
2671 are marked with a non-zero mouse_face_p flag.) If WINDOW
2672 indeed has some glyphs highlighted in mouse face, signal to
2673 frame's up-to-date hook that mouse highlight was overwritten,
2674 so that it will arrange for redisplaying the highlight. */
2675 if (EQ (hlinfo
->mouse_face_window
, window
))
2677 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
2678 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
2679 hlinfo
->mouse_face_window
= Qnil
;
2682 free_window_matrices (r
);
2684 windows_or_buffers_changed
++;
2685 Vwindow_list
= Qnil
;
2686 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
2689 if (NILP (w
->buffer
))
2691 /* Resize child windows vertically. */
2692 XSETINT (delta
, XINT (r
->total_lines
) - XINT (w
->total_lines
));
2693 w
->top_line
= r
->top_line
;
2694 resize_root_window (window
, delta
, Qnil
, Qnil
);
2695 if (window_resize_check (w
, 0))
2696 window_resize_apply (w
, 0);
2699 resize_root_window (window
, delta
, Qnil
, Qt
);
2700 if (window_resize_check (w
, 0))
2701 window_resize_apply (w
, 0);
2706 /* Resize child windows horizontally. */
2709 w
->left_col
= r
->left_col
;
2710 XSETINT (delta
, XINT (r
->total_cols
) - XINT (w
->total_cols
));
2711 w
->left_col
= r
->left_col
;
2712 resize_root_window (window
, delta
, Qt
, Qnil
);
2713 if (window_resize_check (w
, 1))
2714 window_resize_apply (w
, 1);
2717 resize_root_window (window
, delta
, Qt
, Qt
);
2718 if (window_resize_check (w
, 1))
2719 window_resize_apply (w
, 1);
2726 /* Play safe, if we still can ... */
2729 w
= XWINDOW (window
);
2733 /* Cleanly unlink WINDOW from window-tree. */
2734 if (!NILP (w
->prev
))
2735 /* Get SIBLING above (on the left of) WINDOW. */
2738 s
= XWINDOW (sibling
);
2740 if (!NILP (s
->next
))
2741 XWINDOW (s
->next
)->prev
= sibling
;
2744 /* Get SIBLING below (on the right of) WINDOW. */
2747 s
= XWINDOW (sibling
);
2749 if (!NILP (XWINDOW (w
->parent
)->vchild
))
2750 XWINDOW (w
->parent
)->vchild
= sibling
;
2752 XWINDOW (w
->parent
)->hchild
= sibling
;
2755 /* Delete ROOT and all child windows of ROOT. */
2756 if (!NILP (r
->vchild
))
2758 delete_all_child_windows (r
->vchild
);
2761 else if (!NILP (r
->hchild
))
2763 delete_all_child_windows (r
->hchild
);
2767 replace_window (root
, window
, 1);
2769 /* This must become SWINDOW anyway ....... */
2770 if (!NILP (w
->buffer
) && !resize_failed
)
2772 /* Try to minimize scrolling, by setting the window start to the
2773 point will cause the text at the old window start to be at the
2774 same place on the frame. But don't try to do this if the
2775 window start is outside the visible portion (as might happen
2776 when the display is not current, due to typeahead). */
2777 new_top
= WINDOW_TOP_EDGE_LINE (w
) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w
)));
2779 && startpos
>= BUF_BEGV (XBUFFER (w
->buffer
))
2780 && startpos
<= BUF_ZV (XBUFFER (w
->buffer
)))
2782 struct position pos
;
2783 struct buffer
*obuf
= current_buffer
;
2785 Fset_buffer (w
->buffer
);
2786 /* This computation used to temporarily move point, but that
2787 can have unwanted side effects due to text properties. */
2788 pos
= *vmotion (startpos
, -top
, w
);
2790 set_marker_both (w
->start
, w
->buffer
, pos
.bufpos
, pos
.bytepos
);
2791 w
->window_end_valid
= Qnil
;
2792 w
->start_at_line_beg
= (pos
.bytepos
== BEGV_BYTE
2793 || FETCH_BYTE (pos
.bytepos
- 1) == '\n');
2794 /* We need to do this, so that the window-scroll-functions
2796 w
->optional_new_start
= 1;
2798 set_buffer_internal (obuf
);
2805 run_window_configuration_change_hook (f
);
2812 replace_buffer_in_windows (Lisp_Object buffer
)
2814 call1 (Qreplace_buffer_in_windows
, buffer
);
2818 /* Safely replace BUFFER with some other buffer in all windows of all
2819 frames, even those on other keyboards. */
2822 replace_buffer_in_windows_safely (Lisp_Object buffer
)
2824 Lisp_Object tail
, frame
;
2826 /* A single call to window_loop won't do the job because it only
2827 considers frames on the current keyboard. So loop manually over
2828 frames, and handle each one. */
2829 FOR_EACH_FRAME (tail
, frame
)
2830 window_loop (REPLACE_BUFFER_IN_WINDOWS_SAFELY
, buffer
, 1, frame
);
2833 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2834 minimum allowable size. */
2837 check_frame_size (FRAME_PTR frame
, int *rows
, int *cols
)
2839 /* For height, we have to see:
2840 how many windows the frame has at minimum (one or two),
2841 and whether it has a menu bar or other special stuff at the top. */
2843 = ((FRAME_MINIBUF_ONLY_P (frame
) || ! FRAME_HAS_MINIBUF_P (frame
))
2844 ? MIN_SAFE_WINDOW_HEIGHT
2845 : 2 * MIN_SAFE_WINDOW_HEIGHT
);
2847 if (FRAME_TOP_MARGIN (frame
) > 0)
2848 min_height
+= FRAME_TOP_MARGIN (frame
);
2850 if (*rows
< min_height
)
2852 if (*cols
< MIN_SAFE_WINDOW_WIDTH
)
2853 *cols
= MIN_SAFE_WINDOW_WIDTH
;
2856 /* Adjust the margins of window W if text area is too small.
2857 Return 1 if window width is ok after adjustment; 0 if window
2858 is still too narrow. */
2861 adjust_window_margins (struct window
*w
)
2863 int box_cols
= (WINDOW_TOTAL_COLS (w
)
2864 - WINDOW_FRINGE_COLS (w
)
2865 - WINDOW_SCROLL_BAR_COLS (w
));
2866 int margin_cols
= (WINDOW_LEFT_MARGIN_COLS (w
)
2867 + WINDOW_RIGHT_MARGIN_COLS (w
));
2869 if (box_cols
- margin_cols
>= MIN_SAFE_WINDOW_WIDTH
)
2872 if (margin_cols
< 0 || box_cols
< MIN_SAFE_WINDOW_WIDTH
)
2875 /* Window's text area is too narrow, but reducing the window
2876 margins will fix that. */
2877 margin_cols
= box_cols
- MIN_SAFE_WINDOW_WIDTH
;
2878 if (WINDOW_RIGHT_MARGIN_COLS (w
) > 0)
2880 if (WINDOW_LEFT_MARGIN_COLS (w
) > 0)
2881 w
->left_margin_cols
= w
->right_margin_cols
2882 = make_number (margin_cols
/2);
2884 w
->right_margin_cols
= make_number (margin_cols
);
2887 w
->left_margin_cols
= make_number (margin_cols
);
2891 /* The following three routines are needed for running a window's
2892 configuration change hook. */
2894 run_funs (Lisp_Object funs
)
2896 for (; CONSP (funs
); funs
= XCDR (funs
))
2897 if (!EQ (XCAR (funs
), Qt
))
2898 call0 (XCAR (funs
));
2902 select_window_norecord (Lisp_Object window
)
2904 return WINDOW_LIVE_P (window
)
2905 ? Fselect_window (window
, Qt
) : selected_window
;
2909 select_frame_norecord (Lisp_Object frame
)
2911 return FRAME_LIVE_P (XFRAME (frame
))
2912 ? Fselect_frame (frame
, Qt
) : selected_frame
;
2916 run_window_configuration_change_hook (struct frame
*f
)
2918 ptrdiff_t count
= SPECPDL_INDEX ();
2919 Lisp_Object frame
, global_wcch
2920 = Fdefault_value (Qwindow_configuration_change_hook
);
2921 XSETFRAME (frame
, f
);
2923 if (NILP (Vrun_hooks
) || !NILP (inhibit_lisp_code
))
2926 /* Use the right buffer. Matters when running the local hooks. */
2927 if (current_buffer
!= XBUFFER (Fwindow_buffer (Qnil
)))
2929 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
2930 Fset_buffer (Fwindow_buffer (Qnil
));
2933 if (SELECTED_FRAME () != f
)
2935 record_unwind_protect (select_frame_norecord
, Fselected_frame ());
2936 select_frame_norecord (frame
);
2939 /* Look for buffer-local values. */
2941 Lisp_Object windows
= Fwindow_list (frame
, Qlambda
, Qnil
);
2942 for (; CONSP (windows
); windows
= XCDR (windows
))
2944 Lisp_Object window
= XCAR (windows
);
2945 Lisp_Object buffer
= Fwindow_buffer (window
);
2946 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook
,
2949 ptrdiff_t inner_count
= SPECPDL_INDEX ();
2950 record_unwind_protect (select_window_norecord
, Fselected_window ());
2951 select_window_norecord (window
);
2952 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook
,
2954 unbind_to (inner_count
, Qnil
);
2959 run_funs (global_wcch
);
2960 unbind_to (count
, Qnil
);
2963 DEFUN ("run-window-configuration-change-hook", Frun_window_configuration_change_hook
,
2964 Srun_window_configuration_change_hook
, 1, 1, 0,
2965 doc
: /* Run `window-configuration-change-hook' for FRAME. */)
2968 CHECK_LIVE_FRAME (frame
);
2969 run_window_configuration_change_hook (XFRAME (frame
));
2973 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
2974 means it's allowed to run hooks. See make_frame for a case where
2975 it's not allowed. KEEP_MARGINS_P non-zero means that the current
2976 margins, fringes, and scroll-bar settings of the window are not
2977 reset from the buffer's local settings. */
2980 set_window_buffer (Lisp_Object window
, Lisp_Object buffer
, int run_hooks_p
, int keep_margins_p
)
2982 struct window
*w
= XWINDOW (window
);
2983 struct buffer
*b
= XBUFFER (buffer
);
2984 ptrdiff_t count
= SPECPDL_INDEX ();
2985 int samebuf
= EQ (buffer
, w
->buffer
);
2989 if (EQ (window
, selected_window
))
2990 BVAR (b
, last_selected_window
) = window
;
2992 /* Let redisplay errors through. */
2993 b
->display_error_modiff
= 0;
2995 /* Update time stamps of buffer display. */
2996 if (INTEGERP (BVAR (b
, display_count
)))
2997 XSETINT (BVAR (b
, display_count
), XINT (BVAR (b
, display_count
)) + 1);
2998 BVAR (b
, display_time
) = Fcurrent_time ();
3000 XSETFASTINT (w
->window_end_pos
, 0);
3001 XSETFASTINT (w
->window_end_vpos
, 0);
3002 memset (&w
->last_cursor
, 0, sizeof w
->last_cursor
);
3003 w
->window_end_valid
= Qnil
;
3004 if (!(keep_margins_p
&& samebuf
))
3005 { /* If we're not actually changing the buffer, don't reset hscroll and
3006 vscroll. This case happens for example when called from
3007 change_frame_size_1, where we use a dummy call to
3008 Fset_window_buffer on the frame's selected window (and no other)
3009 just in order to run window-configuration-change-hook.
3010 Resetting hscroll and vscroll here is problematic for things like
3011 image-mode and doc-view-mode since it resets the image's position
3012 whenever we resize the frame. */
3013 w
->hscroll
= w
->min_hscroll
= 0;
3015 set_marker_both (w
->pointm
, buffer
, BUF_PT (b
), BUF_PT_BYTE (b
));
3016 set_marker_restricted (w
->start
,
3017 make_number (b
->last_window_start
),
3019 w
->start_at_line_beg
= 0;
3021 w
->last_modified
= 0;
3022 w
->last_overlay_modified
= 0;
3024 /* Maybe we could move this into the `if' but it's not obviously safe and
3025 I doubt it's worth the trouble. */
3026 windows_or_buffers_changed
++;
3028 /* We must select BUFFER for running the window-scroll-functions. */
3029 /* We can't check ! NILP (Vwindow_scroll_functions) here
3030 because that might itself be a local variable. */
3031 if (window_initialized
)
3033 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3034 Fset_buffer (buffer
);
3037 XMARKER (w
->pointm
)->insertion_type
= !NILP (Vwindow_point_insertion_type
);
3039 if (!keep_margins_p
)
3041 /* Set left and right marginal area width etc. from buffer. */
3043 /* This may call adjust_window_margins three times, so
3044 temporarily disable window margins. */
3045 Lisp_Object save_left
= w
->left_margin_cols
;
3046 Lisp_Object save_right
= w
->right_margin_cols
;
3048 w
->left_margin_cols
= w
->right_margin_cols
= Qnil
;
3050 Fset_window_fringes (window
,
3051 BVAR (b
, left_fringe_width
), BVAR (b
, right_fringe_width
),
3052 BVAR (b
, fringes_outside_margins
));
3054 Fset_window_scroll_bars (window
,
3055 BVAR (b
, scroll_bar_width
),
3056 BVAR (b
, vertical_scroll_bar_type
), Qnil
);
3058 w
->left_margin_cols
= save_left
;
3059 w
->right_margin_cols
= save_right
;
3061 Fset_window_margins (window
,
3062 BVAR (b
, left_margin_cols
), BVAR (b
, right_margin_cols
));
3067 if (! NILP (Vwindow_scroll_functions
))
3068 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
3069 Fmarker_position (w
->start
));
3070 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w
)));
3073 unbind_to (count
, Qnil
);
3076 DEFUN ("set-window-buffer", Fset_window_buffer
, Sset_window_buffer
, 2, 3, 0,
3077 doc
: /* Make WINDOW display BUFFER-OR-NAME as its contents.
3078 WINDOW has to be a live window and defaults to the selected one.
3079 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3081 Optional third argument KEEP-MARGINS non-nil means that WINDOW's current
3082 display margins, fringe widths, and scroll bar settings are preserved;
3083 the default is to reset these from the local settings for BUFFER-OR-NAME
3084 or the frame defaults. Return nil.
3086 This function throws an error when WINDOW is strongly dedicated to its
3087 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3088 already display BUFFER-OR-NAME.
3090 This function runs `window-scroll-functions' before running
3091 `window-configuration-change-hook'. */)
3092 (register Lisp_Object window
, Lisp_Object buffer_or_name
, Lisp_Object keep_margins
)
3094 register Lisp_Object tem
, buffer
;
3095 register struct window
*w
= decode_window (window
);
3097 XSETWINDOW (window
, w
);
3098 buffer
= Fget_buffer (buffer_or_name
);
3099 CHECK_BUFFER (buffer
);
3100 if (NILP (BVAR (XBUFFER (buffer
), name
)))
3101 error ("Attempt to display deleted buffer");
3105 error ("Window is deleted");
3106 else if (!EQ (tem
, Qt
))
3107 /* w->buffer is t when the window is first being set up. */
3109 if (!EQ (tem
, buffer
))
3111 if (EQ (w
->dedicated
, Qt
))
3112 /* WINDOW is strongly dedicated to its buffer, signal an
3114 error ("Window is dedicated to `%s'", SDATA (BVAR (XBUFFER (tem
), name
)));
3116 /* WINDOW is weakly dedicated to its buffer, reset
3118 w
->dedicated
= Qnil
;
3120 call1 (Qrecord_window_buffer
, window
);
3126 set_window_buffer (window
, buffer
, 1, !NILP (keep_margins
));
3132 display_buffer (Lisp_Object buffer
, Lisp_Object not_this_window_p
, Lisp_Object override_frame
)
3134 return call3 (Qdisplay_buffer
, buffer
, not_this_window_p
, override_frame
);
3137 DEFUN ("force-window-update", Fforce_window_update
, Sforce_window_update
,
3139 doc
: /* Force all windows to be updated on next redisplay.
3140 If optional arg OBJECT is a window, force redisplay of that window only.
3141 If OBJECT is a buffer or buffer name, force redisplay of all windows
3142 displaying that buffer. */)
3143 (Lisp_Object object
)
3147 windows_or_buffers_changed
++;
3148 update_mode_lines
++;
3152 if (WINDOWP (object
))
3154 struct window
*w
= XWINDOW (object
);
3155 mark_window_display_accurate (object
, 0);
3156 w
->update_mode_line
= 1;
3157 if (BUFFERP (w
->buffer
))
3158 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
3159 ++update_mode_lines
;
3163 if (STRINGP (object
))
3164 object
= Fget_buffer (object
);
3165 if (BUFFERP (object
) && !NILP (BVAR (XBUFFER (object
), name
)))
3167 /* Walk all windows looking for buffer, and force update
3168 of each of those windows. */
3170 object
= window_loop (REDISPLAY_BUFFER_WINDOWS
, object
, 0, Qvisible
);
3171 return NILP (object
) ? Qnil
: Qt
;
3174 /* If nothing suitable was found, just return.
3175 We could signal an error, but this feature will typically be used
3176 asynchronously in timers or process sentinels, so we don't. */
3182 temp_output_buffer_show (register Lisp_Object buf
)
3184 register struct buffer
*old
= current_buffer
;
3185 register Lisp_Object window
;
3186 register struct window
*w
;
3188 BVAR (XBUFFER (buf
), directory
) = BVAR (current_buffer
, directory
);
3191 BUF_SAVE_MODIFF (XBUFFER (buf
)) = MODIFF
;
3195 set_buffer_internal (old
);
3197 if (!NILP (Vtemp_buffer_show_function
))
3198 call1 (Vtemp_buffer_show_function
, buf
);
3201 window
= display_buffer (buf
, Qnil
, Qnil
);
3203 if (!EQ (XWINDOW (window
)->frame
, selected_frame
))
3204 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window
)));
3205 Vminibuf_scroll_window
= window
;
3206 w
= XWINDOW (window
);
3209 set_marker_restricted_both (w
->start
, buf
, BEG
, BEG
);
3210 set_marker_restricted_both (w
->pointm
, buf
, BEG
, BEG
);
3212 /* Run temp-buffer-show-hook, with the chosen window selected
3213 and its buffer current. */
3215 ptrdiff_t count
= SPECPDL_INDEX ();
3216 Lisp_Object prev_window
, prev_buffer
;
3217 prev_window
= selected_window
;
3218 XSETBUFFER (prev_buffer
, old
);
3220 /* Select the window that was chosen, for running the hook.
3221 Note: Both Fselect_window and select_window_norecord may
3222 set-buffer to the buffer displayed in the window,
3223 so we need to save the current buffer. --stef */
3224 record_unwind_protect (Fset_buffer
, prev_buffer
);
3225 record_unwind_protect (select_window_norecord
, prev_window
);
3226 Fselect_window (window
, Qt
);
3227 Fset_buffer (w
->buffer
);
3228 Frun_hooks (1, &Qtemp_buffer_show_hook
);
3229 unbind_to (count
, Qnil
);
3234 DEFUN ("internal-temp-output-buffer-show",
3235 Ftemp_output_buffer_show
, Stemp_output_buffer_show
,
3237 doc
: /* Internal function for `with-output-to-temp-buffer'. */)
3240 temp_output_buffer_show (buf
);
3244 /* Make new window, have it replace WINDOW in window-tree, and make
3245 WINDOW its only vertical child (HORFLAG 1 means make WINDOW its only
3246 horizontal child). */
3248 make_parent_window (Lisp_Object window
, int horflag
)
3251 register struct window
*o
, *p
;
3253 o
= XWINDOW (window
);
3254 p
= allocate_window ();
3255 memcpy ((char *) p
+ sizeof (struct vectorlike_header
),
3256 (char *) o
+ sizeof (struct vectorlike_header
),
3257 sizeof (Lisp_Object
) * VECSIZE (struct window
));
3258 XSETWINDOW (parent
, p
);
3260 p
->sequence_number
= ++sequence_number
;
3262 replace_window (window
, parent
, 1);
3268 p
->hchild
= horflag
? window
: Qnil
;
3269 p
->vchild
= horflag
? Qnil
: window
;
3273 p
->combination_limit
= Qnil
;
3274 p
->window_parameters
= Qnil
;
3277 /* Make new window from scratch. */
3282 register struct window
*w
;
3284 w
= allocate_window ();
3285 /* Initialize Lisp data. Note that allocate_window initializes all
3286 Lisp data to nil, so do it only for slots which should not be nil. */
3287 XSETFASTINT (w
->left_col
, 0);
3288 XSETFASTINT (w
->top_line
, 0);
3289 XSETFASTINT (w
->total_lines
, 0);
3290 XSETFASTINT (w
->total_cols
, 0);
3291 w
->normal_lines
= make_float (1.0);
3292 w
->normal_cols
= make_float (1.0);
3293 XSETFASTINT (w
->new_total
, 0);
3294 XSETFASTINT (w
->new_normal
, 0);
3295 w
->start
= Fmake_marker ();
3296 w
->pointm
= Fmake_marker ();
3297 w
->vertical_scroll_bar_type
= Qt
;
3298 XSETFASTINT (w
->window_end_pos
, 0);
3299 XSETFASTINT (w
->window_end_vpos
, 0);
3301 /* Initialize non-Lisp data. Note that allocate_window zeroes out all
3302 non-Lisp data, so do it only for slots which should not be zero. */
3303 w
->nrows_scale_factor
= w
->ncols_scale_factor
= 1;
3304 w
->phys_cursor_type
= -1;
3305 w
->phys_cursor_width
= -1;
3306 w
->sequence_number
= ++sequence_number
;
3308 /* Reset window_list. */
3309 Vwindow_list
= Qnil
;
3310 /* Return window. */
3311 XSETWINDOW (window
, w
);
3315 DEFUN ("set-window-new-total", Fset_window_new_total
, Sset_window_new_total
, 2, 3, 0,
3316 doc
: /* Set new total size of WINDOW to SIZE.
3319 Optional argument ADD non-nil means add SIZE to the new total size of
3320 WINDOW and return the sum.
3322 Note: This function does not operate on any child windows of WINDOW. */)
3323 (Lisp_Object window
, Lisp_Object size
, Lisp_Object add
)
3325 struct window
*w
= decode_any_window (window
);
3327 CHECK_NUMBER (size
);
3329 XSETINT (w
->new_total
, XINT (size
));
3331 XSETINT (w
->new_total
, XINT (w
->new_total
) + XINT (size
));
3333 return w
->new_total
;
3336 DEFUN ("set-window-new-normal", Fset_window_new_normal
, Sset_window_new_normal
, 1, 2, 0,
3337 doc
: /* Set new normal size of WINDOW to SIZE.
3340 Note: This function does not operate on any child windows of WINDOW. */)
3341 (Lisp_Object window
, Lisp_Object size
)
3343 struct window
*w
= decode_any_window (window
);
3345 w
->new_normal
= size
;
3346 return w
->new_normal
;
3349 /* Return 1 if setting w->total_lines (w->total_cols if HORFLAG is
3350 non-zero) to w->new_total would result in correct heights (widths)
3351 for window W and recursively all child windows of W.
3353 Note: This function does not check any of `window-fixed-size-p',
3354 `window-min-height' or `window-min-width'. It does check that window
3355 sizes do not drop below one line (two columns). */
3357 window_resize_check (struct window
*w
, int horflag
)
3361 if (!NILP (w
->vchild
))
3362 /* W is a vertical combination. */
3364 c
= XWINDOW (w
->vchild
);
3366 /* All child windows of W must have the same width as W. */
3370 if ((XINT (c
->new_total
) != XINT (w
->new_total
))
3371 || !window_resize_check (c
, horflag
))
3373 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3378 /* The sum of the heights of the child windows of W must equal
3381 int sum_of_sizes
= 0;
3384 if (!window_resize_check (c
, horflag
))
3386 sum_of_sizes
= sum_of_sizes
+ XINT (c
->new_total
);
3387 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3389 return (sum_of_sizes
== XINT (w
->new_total
));
3392 else if (!NILP (w
->hchild
))
3393 /* W is a horizontal combination. */
3395 c
= XWINDOW (w
->hchild
);
3397 /* The sum of the widths of the child windows of W must equal W's
3400 int sum_of_sizes
= 0;
3403 if (!window_resize_check (c
, horflag
))
3405 sum_of_sizes
= sum_of_sizes
+ XINT (c
->new_total
);
3406 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3408 return (sum_of_sizes
== XINT (w
->new_total
));
3411 /* All child windows of W must have the same height as W. */
3415 if ((XINT (c
->new_total
) != XINT (w
->new_total
))
3416 || !window_resize_check (c
, horflag
))
3418 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3424 /* A leaf window. Make sure it's not too small. The following
3425 hardcodes the values of `window-safe-min-width' (2) and
3426 `window-safe-min-height' (1) which are defined in window.el. */
3427 return XINT (w
->new_total
) >= (horflag
? 2 : 1);
3430 /* Set w->total_lines (w->total_cols if HORIZONTAL is non-zero) to
3431 w->new_total for window W and recursively all child windows of W.
3432 Also calculate and assign the new vertical (horizontal) start
3433 positions of each of these windows.
3435 This function does not perform any error checks. Make sure you have
3436 run window_resize_check on W before applying this function. */
3438 window_resize_apply (struct window
*w
, int horflag
)
3443 /* Note: Assigning new_normal requires that the new total size of the
3444 parent window has been set *before*. */
3447 w
->total_cols
= w
->new_total
;
3448 if (NUMBERP (w
->new_normal
))
3449 w
->normal_cols
= w
->new_normal
;
3451 pos
= XINT (w
->left_col
);
3455 w
->total_lines
= w
->new_total
;
3456 if (NUMBERP (w
->new_normal
))
3457 w
->normal_lines
= w
->new_normal
;
3459 pos
= XINT (w
->top_line
);
3462 if (!NILP (w
->vchild
))
3463 /* W is a vertical combination. */
3465 c
= XWINDOW (w
->vchild
);
3469 XSETFASTINT (c
->left_col
, pos
);
3471 XSETFASTINT (c
->top_line
, pos
);
3472 window_resize_apply (c
, horflag
);
3474 pos
= pos
+ XINT (c
->total_lines
);
3475 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3478 else if (!NILP (w
->hchild
))
3479 /* W is a horizontal combination. */
3481 c
= XWINDOW (w
->hchild
);
3485 XSETFASTINT (c
->left_col
, pos
);
3487 XSETFASTINT (c
->top_line
, pos
);
3488 window_resize_apply (c
, horflag
);
3490 pos
= pos
+ XINT (c
->total_cols
);
3491 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3495 /* Clear out some redisplay caches. */
3496 w
->last_modified
= 0;
3497 w
->last_overlay_modified
= 0;
3501 DEFUN ("window-resize-apply", Fwindow_resize_apply
, Swindow_resize_apply
, 1, 2, 0,
3502 doc
: /* Apply requested size values for window-tree of FRAME.
3503 Optional argument HORIZONTAL omitted or nil means apply requested height
3504 values. HORIZONTAL non-nil means apply requested width values.
3506 This function checks whether the requested values sum up to a valid
3507 window layout, recursively assigns the new sizes of all child windows
3508 and calculates and assigns the new start positions of these windows.
3510 Note: This function does not check any of `window-fixed-size-p',
3511 `window-min-height' or `window-min-width'. All these checks have to
3512 be applied on the Elisp level. */)
3513 (Lisp_Object frame
, Lisp_Object horizontal
)
3517 int horflag
= !NILP (horizontal
);
3520 frame
= selected_frame
;
3521 CHECK_LIVE_FRAME (frame
);
3524 r
= XWINDOW (FRAME_ROOT_WINDOW (f
));
3526 if (!window_resize_check (r
, horflag
)
3527 || ! EQ (r
->new_total
, (horflag
? r
->total_cols
: r
->total_lines
)))
3531 window_resize_apply (r
, horflag
);
3533 windows_or_buffers_changed
++;
3534 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
3539 run_window_configuration_change_hook (f
);
3545 /* Resize frame F's windows when number of lines of F is set to SIZE.
3546 HORFLAG 1 means resize windows when number of columns of F is set to
3549 This function can delete all windows but the selected one in order to
3550 satisfy the request. The result will be meaningful if and only if
3551 F's windows have meaningful sizes when you call this. */
3553 resize_frame_windows (struct frame
*f
, int size
, int horflag
)
3555 Lisp_Object root
= f
->root_window
;
3556 struct window
*r
= XWINDOW (root
);
3557 Lisp_Object mini
= f
->minibuffer_window
;
3559 /* new_size is the new size of the frame's root window. */
3560 int new_size
= (horflag
3563 - FRAME_TOP_MARGIN (f
)
3564 - ((FRAME_HAS_MINIBUF_P (f
) && !FRAME_MINIBUF_ONLY_P (f
))
3567 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
3568 if (NILP (r
->vchild
) && NILP (r
->hchild
))
3569 /* For a leaf root window just set the size. */
3571 XSETFASTINT (r
->total_cols
, new_size
);
3573 XSETFASTINT (r
->total_lines
, new_size
);
3576 /* old_size is the old size of the frame's root window. */
3577 int old_size
= XFASTINT (horflag
? r
->total_cols
: r
->total_lines
);
3580 XSETINT (delta
, new_size
- old_size
);
3581 /* Try a "normal" resize first. */
3582 resize_root_window (root
, delta
, horflag
? Qt
: Qnil
, Qnil
);
3583 if (window_resize_check (r
, horflag
) && new_size
== XINT (r
->new_total
))
3584 window_resize_apply (r
, horflag
);
3587 /* Try with "reasonable" minimum sizes next. */
3588 resize_root_window (root
, delta
, horflag
? Qt
: Qnil
, Qt
);
3589 if (window_resize_check (r
, horflag
)
3590 && new_size
== XINT (r
->new_total
))
3591 window_resize_apply (r
, horflag
);
3594 /* Finally, try with "safe" minimum sizes. */
3595 resize_root_window (root
, delta
, horflag
? Qt
: Qnil
, Qsafe
);
3596 if (window_resize_check (r
, horflag
)
3597 && new_size
== XINT (r
->new_total
))
3598 window_resize_apply (r
, horflag
);
3601 /* We lost. Delete all windows but the frame's
3603 root
= f
->selected_window
;
3604 Fdelete_other_windows_internal (root
, Qnil
);
3606 XSETFASTINT (XWINDOW (root
)->total_cols
, new_size
);
3608 XSETFASTINT (XWINDOW (root
)->total_lines
, new_size
);
3614 if (FRAME_HAS_MINIBUF_P (f
) && !FRAME_MINIBUF_ONLY_P (f
))
3618 XSETFASTINT (m
->total_cols
, size
);
3621 /* Are we sure we always want 1 line here? */
3622 XSETFASTINT (m
->total_lines
, 1);
3623 XSETFASTINT (m
->top_line
, XINT (r
->top_line
) + XINT (r
->total_lines
));
3629 DEFUN ("split-window-internal", Fsplit_window_internal
, Ssplit_window_internal
, 4, 4, 0,
3630 doc
: /* Split window OLD.
3631 Second argument TOTAL-SIZE specifies the number of lines or columns of the
3632 new window. In any case TOTAL-SIZE must be a positive integer.
3634 Third argument SIDE nil (or `below') specifies that the new window shall
3635 be located below WINDOW. SIDE `above' means the new window shall be
3636 located above WINDOW. In both cases TOTAL-SIZE specifies the number of
3637 lines of the new window including space reserved for the mode and/or
3640 SIDE t (or `right') specifies that the new window shall be located on
3641 the right side of WINDOW. SIDE `left' means the new window shall be
3642 located on the left of WINDOW. In both cases TOTAL-SIZE specifies the
3643 number of columns of the new window including space reserved for fringes
3644 and the scrollbar or a divider column.
3646 Fourth argument NORMAL-SIZE specifies the normal size of the new window
3647 according to the SIDE argument.
3649 The new total and normal sizes of all involved windows must have been
3650 set correctly. See the code of `split-window' for how this is done. */)
3651 (Lisp_Object old
, Lisp_Object total_size
, Lisp_Object side
, Lisp_Object normal_size
)
3653 /* OLD (*o) is the window we have to split. (*p) is either OLD's
3654 parent window or an internal window we have to install as OLD's new
3655 parent. REFERENCE (*r) must denote a live window, or is set to OLD
3656 provided OLD is a leaf window, or to the frame's selected window.
3657 NEW (*n) is the new window created with some parameters taken from
3659 register Lisp_Object
new, frame
, reference
;
3660 register struct window
*o
, *p
, *n
, *r
;
3663 /* HORFLAG is 1 when we split side-by-side, 0 otherwise. */
3664 = EQ (side
, Qt
) || EQ (side
, Qleft
) || EQ (side
, Qright
);
3665 int combination_limit
= 0;
3669 frame
= WINDOW_FRAME (o
);
3672 CHECK_NUMBER (total_size
);
3674 /* Set combination_limit to 1 if we have to make a new parent window.
3675 We do that if either `window-combination-limit' is t, or OLD has no
3676 parent, or OLD is ortho-combined. */
3678 !NILP (Vwindow_combination_limit
)
3681 ? (XWINDOW (o
->parent
)->hchild
)
3682 : (XWINDOW (o
->parent
)->vchild
));
3684 /* We need a live reference window to initialize some parameters. */
3685 if (WINDOW_LIVE_P (old
))
3686 /* OLD is live, use it as reference window. */
3689 /* Use the frame's selected window as reference window. */
3690 reference
= FRAME_SELECTED_WINDOW (f
);
3691 r
= XWINDOW (reference
);
3693 /* The following bugs are caught by `split-window'. */
3694 if (MINI_WINDOW_P (o
))
3695 error ("Attempt to split minibuffer window");
3696 else if (XINT (total_size
) < (horflag
? 2 : 1))
3697 error ("Size of new window too small (after split)");
3698 else if (!combination_limit
&& !NILP (Vwindow_combination_resize
))
3699 /* `window-combination-resize' non-nil means try to resize OLD's siblings
3702 p
= XWINDOW (o
->parent
);
3703 /* Temporarily pretend we split the parent window. */
3704 XSETINT (p
->new_total
,
3705 XINT (horflag
? p
->total_cols
: p
->total_lines
)
3706 - XINT (total_size
));
3707 if (!window_resize_check (p
, horflag
))
3708 error ("Window sizes don't fit");
3710 /* Undo the temporary pretension. */
3711 p
->new_total
= horflag
? p
->total_cols
: p
->total_lines
;
3715 if (!window_resize_check (o
, horflag
))
3716 error ("Resizing old window failed");
3717 else if (XINT (total_size
) + XINT (o
->new_total
)
3718 != XINT (horflag
? o
->total_cols
: o
->total_lines
))
3719 error ("Sum of sizes of old and new window don't fit");
3722 /* This is our point of no return. */
3723 if (combination_limit
)
3725 /* Save the old value of o->normal_cols/lines. It gets corrupted
3726 by make_parent_window and we need it below for assigning it to
3728 Lisp_Object new_normal
= horflag
? o
->normal_cols
: o
->normal_lines
;
3730 make_parent_window (old
, horflag
);
3731 p
= XWINDOW (o
->parent
);
3732 /* Store value of `window-combination-limit' in new parent's
3733 combination_limit slot. */
3734 p
->combination_limit
= Vwindow_combination_limit
;
3735 /* These get applied below. */
3736 p
->new_total
= horflag
? o
->total_cols
: o
->total_lines
;
3737 p
->new_normal
= new_normal
;
3740 p
= XWINDOW (o
->parent
);
3742 windows_or_buffers_changed
++;
3743 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
3744 new = make_window ();
3747 n
->parent
= o
->parent
;
3748 n
->vchild
= n
->hchild
= Qnil
;
3750 if (EQ (side
, Qabove
) || EQ (side
, Qleft
))
3759 XWINDOW (n
->prev
)->next
= new;
3766 if (!NILP (n
->next
))
3767 XWINDOW (n
->next
)->prev
= new;
3773 n
->window_end_valid
= Qnil
;
3774 memset (&n
->last_cursor
, 0, sizeof n
->last_cursor
);
3776 /* Get special geometry settings from reference window. */
3777 n
->left_margin_cols
= r
->left_margin_cols
;
3778 n
->right_margin_cols
= r
->right_margin_cols
;
3779 n
->left_fringe_width
= r
->left_fringe_width
;
3780 n
->right_fringe_width
= r
->right_fringe_width
;
3781 n
->fringes_outside_margins
= r
->fringes_outside_margins
;
3782 n
->scroll_bar_width
= r
->scroll_bar_width
;
3783 n
->vertical_scroll_bar_type
= r
->vertical_scroll_bar_type
;
3785 /* Directly assign orthogonal coordinates and sizes. */
3788 n
->top_line
= o
->top_line
;
3789 n
->total_lines
= o
->total_lines
;
3793 n
->left_col
= o
->left_col
;
3794 n
->total_cols
= o
->total_cols
;
3797 /* Iso-coordinates and sizes are assigned by window_resize_apply,
3798 get them ready here. */
3799 n
->new_total
= total_size
;
3800 n
->new_normal
= normal_size
;
3803 window_resize_apply (p
, horflag
);
3805 /* Set buffer of NEW to buffer of reference window. Don't run
3807 set_window_buffer (new, r
->buffer
, 0, 1);
3810 /* Maybe we should run the scroll functions in Elisp (which already
3811 runs the configuration change hook). */
3812 if (! NILP (Vwindow_scroll_functions
))
3813 run_hook_with_args_2 (Qwindow_scroll_functions
, new,
3814 Fmarker_position (n
->start
));
3820 DEFUN ("delete-window-internal", Fdelete_window_internal
, Sdelete_window_internal
, 1, 1, 0,
3821 doc
: /* Remove WINDOW from its frame.
3822 WINDOW defaults to the selected window. Return nil.
3823 Signal an error when WINDOW is the only window on its frame. */)
3824 (register Lisp_Object window
)
3826 register Lisp_Object parent
, sibling
, frame
, root
;
3827 struct window
*w
, *p
, *s
, *r
;
3830 int before_sibling
= 0;
3832 w
= decode_any_window (window
);
3833 XSETWINDOW (window
, w
);
3834 if (NILP (w
->buffer
) && NILP (w
->hchild
) && NILP (w
->vchild
))
3835 /* It's a no-op to delete an already deleted window. */
3840 /* Never delete a minibuffer or frame root window. */
3841 error ("Attempt to delete minibuffer or sole ordinary window");
3842 else if (NILP (w
->prev
) && NILP (w
->next
))
3843 /* Rather bow out here, this case should be handled on the Elisp
3845 error ("Attempt to delete sole window of parent");
3847 p
= XWINDOW (parent
);
3848 horflag
= NILP (p
->vchild
);
3850 frame
= WINDOW_FRAME (w
);
3853 root
= FRAME_ROOT_WINDOW (f
);
3856 /* Unlink WINDOW from window tree. */
3858 /* Get SIBLING below (on the right of) WINDOW. */
3860 /* before_sibling 1 means WINDOW is the first child of its
3861 parent and thus before the sibling. */
3864 s
= XWINDOW (sibling
);
3867 p
->hchild
= sibling
;
3869 p
->vchild
= sibling
;
3872 /* Get SIBLING above (on the left of) WINDOW. */
3875 s
= XWINDOW (sibling
);
3877 if (!NILP (s
->next
))
3878 XWINDOW (s
->next
)->prev
= sibling
;
3881 if (window_resize_check (r
, horflag
)
3882 && EQ (r
->new_total
, (horflag
? r
->total_cols
: r
->total_lines
)))
3883 /* We can delete WINDOW now. */
3888 window_resize_apply (p
, horflag
);
3890 /* If this window is referred to by the dpyinfo's mouse
3891 highlight, invalidate that slot to be safe (Bug#9904). */
3892 if (!FRAME_INITIAL_P (f
))
3894 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
3896 if (EQ (hlinfo
->mouse_face_window
, window
))
3897 hlinfo
->mouse_face_window
= Qnil
;
3900 windows_or_buffers_changed
++;
3901 Vwindow_list
= Qnil
;
3902 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
3904 w
->next
= Qnil
; /* Don't delete w->next too. */
3905 free_window_matrices (w
);
3907 if (!NILP (w
->vchild
))
3909 delete_all_child_windows (w
->vchild
);
3912 else if (!NILP (w
->hchild
))
3914 delete_all_child_windows (w
->hchild
);
3917 else if (!NILP (w
->buffer
))
3920 unchain_marker (XMARKER (w
->pointm
));
3921 unchain_marker (XMARKER (w
->start
));
3925 if (NILP (s
->prev
) && NILP (s
->next
))
3926 /* A matrjoshka where SIBLING has become the only child of
3929 /* Put SIBLING into PARENT's place. */
3930 replace_window (parent
, sibling
, 0);
3931 /* Have SIBLING inherit the following three slot values from
3932 PARENT (the combination_limit slot is not inherited). */
3933 s
->normal_cols
= p
->normal_cols
;
3934 s
->normal_lines
= p
->normal_lines
;
3935 /* Mark PARENT as deleted. */
3936 p
->vchild
= p
->hchild
= Qnil
;
3937 /* Try to merge SIBLING into its new parent. */
3938 recombine_windows (sibling
);
3943 if (!WINDOW_LIVE_P (FRAME_SELECTED_WINDOW (f
)))
3944 /* We deleted the frame's selected window. */
3946 /* Use the frame's first window as fallback ... */
3947 Lisp_Object new_selected_window
= Fframe_first_window (frame
);
3948 /* ... but preferably use its most recently used window. */
3949 Lisp_Object mru_window
;
3951 /* `get-mru-window' might fail for some reason so play it safe
3952 - promote the first window _without recording it_ first. */
3953 if (EQ (FRAME_SELECTED_WINDOW (f
), selected_window
))
3954 Fselect_window (new_selected_window
, Qt
);
3956 FRAME_SELECTED_WINDOW (f
) = new_selected_window
;
3960 /* Now look whether `get-mru-window' gets us something. */
3961 mru_window
= call1 (Qget_mru_window
, frame
);
3962 if (WINDOW_LIVE_P (mru_window
)
3963 && EQ (XWINDOW (mru_window
)->frame
, frame
))
3964 new_selected_window
= mru_window
;
3966 /* If all ended up well, we now promote the mru window. */
3967 if (EQ (FRAME_SELECTED_WINDOW (f
), selected_window
))
3968 Fselect_window (new_selected_window
, Qnil
);
3970 FRAME_SELECTED_WINDOW (f
) = new_selected_window
;
3975 /* Must be run by the caller:
3976 run_window_configuration_change_hook (f); */
3979 /* We failed: Relink WINDOW into window tree. */
3992 if (!NILP (w
->next
))
3993 XWINDOW (w
->next
)->prev
= window
;
3995 error ("Deletion failed");
4001 /***********************************************************************
4002 Resizing Mini-Windows
4003 ***********************************************************************/
4005 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we
4008 grow_mini_window (struct window
*w
, int delta
)
4010 struct frame
*f
= XFRAME (w
->frame
);
4012 Lisp_Object root
, value
;
4014 eassert (MINI_WINDOW_P (w
));
4015 eassert (delta
>= 0);
4017 root
= FRAME_ROOT_WINDOW (f
);
4019 value
= call2 (Qwindow_resize_root_window_vertically
,
4020 root
, make_number (- delta
));
4021 if (INTEGERP (value
) && window_resize_check (r
, 0))
4024 window_resize_apply (r
, 0);
4026 /* Grow the mini-window. */
4027 XSETFASTINT (w
->top_line
, XFASTINT (r
->top_line
) + XFASTINT (r
->total_lines
));
4028 XSETFASTINT (w
->total_lines
, XFASTINT (w
->total_lines
) - XINT (value
));
4029 w
->last_modified
= 0;
4030 w
->last_overlay_modified
= 0;
4038 /* Shrink mini-window W. */
4040 shrink_mini_window (struct window
*w
)
4042 struct frame
*f
= XFRAME (w
->frame
);
4044 Lisp_Object root
, value
;
4047 eassert (MINI_WINDOW_P (w
));
4049 size
= XINT (w
->total_lines
);
4052 root
= FRAME_ROOT_WINDOW (f
);
4054 value
= call2 (Qwindow_resize_root_window_vertically
,
4055 root
, make_number (size
- 1));
4056 if (INTEGERP (value
) && window_resize_check (r
, 0))
4059 window_resize_apply (r
, 0);
4061 /* Shrink the mini-window. */
4062 XSETFASTINT (w
->top_line
, XFASTINT (r
->top_line
) + XFASTINT (r
->total_lines
));
4063 XSETFASTINT (w
->total_lines
, 1);
4065 w
->last_modified
= 0;
4066 w
->last_overlay_modified
= 0;
4071 /* If the above failed for whatever strange reason we must make a
4072 one window frame here. The same routine will be needed when
4073 shrinking the frame (and probably when making the initial
4074 *scratch* window). For the moment leave things as they are. */
4078 DEFUN ("resize-mini-window-internal", Fresize_mini_window_internal
, Sresize_mini_window_internal
, 1, 1, 0,
4079 doc
: /* Resize minibuffer window WINDOW. */)
4080 (Lisp_Object window
)
4082 struct window
*w
= XWINDOW (window
);
4087 CHECK_WINDOW (window
);
4088 f
= XFRAME (w
->frame
);
4090 if (!EQ (FRAME_MINIBUF_WINDOW (XFRAME (w
->frame
)), window
))
4091 error ("Not a valid minibuffer window");
4092 else if (FRAME_MINIBUF_ONLY_P (f
))
4093 error ("Cannot resize a minibuffer-only frame");
4095 r
= XWINDOW (FRAME_ROOT_WINDOW (f
));
4096 height
= XINT (r
->total_lines
) + XINT (w
->total_lines
);
4097 if (window_resize_check (r
, 0)
4098 && XINT (w
->new_total
) > 0
4099 && height
== XINT (r
->new_total
) + XINT (w
->new_total
))
4102 window_resize_apply (r
, 0);
4104 w
->total_lines
= w
->new_total
;
4105 XSETFASTINT (w
->top_line
, XINT (r
->top_line
) + XINT (r
->total_lines
));
4107 windows_or_buffers_changed
++;
4108 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
4112 run_window_configuration_change_hook (f
);
4115 else error ("Failed to resize minibuffer window");
4118 /* Mark window cursors off for all windows in the window tree rooted
4119 at W by setting their phys_cursor_on_p flag to zero. Called from
4120 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4121 the frame are cleared. */
4124 mark_window_cursors_off (struct window
*w
)
4128 if (!NILP (w
->hchild
))
4129 mark_window_cursors_off (XWINDOW (w
->hchild
));
4130 else if (!NILP (w
->vchild
))
4131 mark_window_cursors_off (XWINDOW (w
->vchild
));
4133 w
->phys_cursor_on_p
= 0;
4135 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
4140 /* Return number of lines of text (not counting mode lines) in W. */
4143 window_internal_height (struct window
*w
)
4145 int ht
= XFASTINT (w
->total_lines
);
4147 if (!MINI_WINDOW_P (w
))
4149 if (!NILP (w
->parent
)
4150 || !NILP (w
->vchild
)
4151 || !NILP (w
->hchild
)
4154 || WINDOW_WANTS_MODELINE_P (w
))
4157 if (WINDOW_WANTS_HEADER_LINE_P (w
))
4164 /************************************************************************
4166 ***********************************************************************/
4168 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4169 N screen-fulls, which is defined as the height of the window minus
4170 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4171 instead. Negative values of N mean scroll down. NOERROR non-zero
4172 means don't signal an error if we try to move over BEGV or ZV,
4176 window_scroll (Lisp_Object window
, EMACS_INT n
, int whole
, int noerror
)
4179 n
= clip_to_bounds (INT_MIN
, n
, INT_MAX
);
4181 /* If we must, use the pixel-based version which is much slower than
4182 the line-based one but can handle varying line heights. */
4183 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window
)->frame
)))
4184 window_scroll_pixel_based (window
, n
, whole
, noerror
);
4186 window_scroll_line_based (window
, n
, whole
, noerror
);
4192 /* Implementation of window_scroll that works based on pixel line
4193 heights. See the comment of window_scroll for parameter
4197 window_scroll_pixel_based (Lisp_Object window
, int n
, int whole
, int noerror
)
4200 struct window
*w
= XWINDOW (window
);
4201 struct text_pos start
;
4202 int this_scroll_margin
;
4203 /* True if we fiddled the window vscroll field without really scrolling. */
4205 int x
, y
, rtop
, rbot
, rowh
, vpos
;
4206 void *itdata
= NULL
;
4208 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
4209 /* Scrolling a minibuffer window via scroll bar when the echo area
4210 shows long text sometimes resets the minibuffer contents behind
4212 if (CHARPOS (start
) > ZV
)
4213 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
4215 /* If PT is not visible in WINDOW, move back one half of
4216 the screen. Allow PT to be partially visible, otherwise
4217 something like (scroll-down 1) with PT in the line before
4218 the partially visible one would recenter. */
4220 if (!pos_visible_p (w
, PT
, &x
, &y
, &rtop
, &rbot
, &rowh
, &vpos
))
4222 itdata
= bidi_shelve_cache ();
4223 /* Move backward half the height of the window. Performance note:
4224 vmotion used here is about 10% faster, but would give wrong
4225 results for variable height lines. */
4226 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
4227 it
.current_y
= it
.last_visible_y
;
4228 move_it_vertically_backward (&it
, window_box_height (w
) / 2);
4230 /* The function move_iterator_vertically may move over more than
4231 the specified y-distance. If it->w is small, e.g. a
4232 mini-buffer window, we may end up in front of the window's
4233 display area. This is the case when Start displaying at the
4234 start of the line containing PT in this case. */
4235 if (it
.current_y
<= 0)
4237 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
4238 move_it_vertically_backward (&it
, 0);
4242 start
= it
.current
.pos
;
4243 bidi_unshelve_cache (itdata
, 0);
4245 else if (auto_window_vscroll_p
)
4247 if (rtop
|| rbot
) /* partially visible */
4250 int dy
= WINDOW_FRAME_LINE_HEIGHT (w
);
4252 dy
= max ((window_box_height (w
)
4253 - next_screen_context_lines
* dy
),
4259 /* Only vscroll backwards if already vscrolled forwards. */
4260 if (w
->vscroll
< 0 && rtop
> 0)
4262 px
= max (0, -w
->vscroll
- min (rtop
, -dy
));
4263 Fset_window_vscroll (window
, make_number (px
), Qt
);
4269 /* Do vscroll if already vscrolled or only display line. */
4270 if (rbot
> 0 && (w
->vscroll
< 0 || vpos
== 0))
4272 px
= max (0, -w
->vscroll
+ min (rbot
, dy
));
4273 Fset_window_vscroll (window
, make_number (px
), Qt
);
4277 /* Maybe modify window start instead of scrolling. */
4278 if (rbot
> 0 || w
->vscroll
< 0)
4282 Fset_window_vscroll (window
, make_number (0), Qt
);
4283 /* If there are other text lines above the current row,
4284 move window start to current row. Else to next row. */
4286 spos
= XINT (Fline_beginning_position (Qnil
));
4288 spos
= min (XINT (Fline_end_position (Qnil
)) + 1, ZV
);
4289 set_marker_restricted (w
->start
, make_number (spos
),
4291 w
->start_at_line_beg
= 1;
4292 w
->update_mode_line
= 1;
4293 w
->last_modified
= 0;
4294 w
->last_overlay_modified
= 0;
4295 /* Set force_start so that redisplay_window will run the
4296 window-scroll-functions. */
4302 /* Cancel previous vscroll. */
4303 Fset_window_vscroll (window
, make_number (0), Qt
);
4306 itdata
= bidi_shelve_cache ();
4307 /* If scroll_preserve_screen_position is non-nil, we try to set
4308 point in the same window line as it is now, so get that line. */
4309 if (!NILP (Vscroll_preserve_screen_position
))
4311 /* We preserve the goal pixel coordinate across consecutive
4312 calls to scroll-up, scroll-down and other commands that
4313 have the `scroll-command' property. This avoids the
4314 possibility of point becoming "stuck" on a tall line when
4315 scrolling by one line. */
4316 if (window_scroll_pixel_based_preserve_y
< 0
4317 || !SYMBOLP (KVAR (current_kboard
, Vlast_command
))
4318 || NILP (Fget (KVAR (current_kboard
, Vlast_command
), Qscroll_command
)))
4320 start_display (&it
, w
, start
);
4321 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
4322 window_scroll_pixel_based_preserve_y
= it
.current_y
;
4323 window_scroll_pixel_based_preserve_x
= it
.current_x
;
4327 window_scroll_pixel_based_preserve_y
4328 = window_scroll_pixel_based_preserve_x
= -1;
4330 /* Move iterator it from start the specified distance forward or
4331 backward. The result is the new window start. */
4332 start_display (&it
, w
, start
);
4335 ptrdiff_t start_pos
= IT_CHARPOS (it
);
4336 int dy
= WINDOW_FRAME_LINE_HEIGHT (w
);
4337 dy
= max ((window_box_height (w
)
4338 - next_screen_context_lines
* dy
),
4341 /* Note that move_it_vertically always moves the iterator to the
4342 start of a line. So, if the last line doesn't have a newline,
4343 we would end up at the start of the line ending at ZV. */
4346 move_it_vertically_backward (&it
, -dy
);
4347 /* Ensure we actually do move, e.g. in case we are currently
4348 looking at an image that is taller that the window height. */
4349 while (start_pos
== IT_CHARPOS (it
)
4350 && start_pos
> BEGV
)
4351 move_it_by_lines (&it
, -1);
4355 move_it_to (&it
, ZV
, -1, it
.current_y
+ dy
, -1,
4356 MOVE_TO_POS
| MOVE_TO_Y
);
4357 /* Ensure we actually do move, e.g. in case we are currently
4358 looking at an image that is taller that the window height. */
4359 while (start_pos
== IT_CHARPOS (it
)
4361 move_it_by_lines (&it
, 1);
4365 move_it_by_lines (&it
, n
);
4367 /* We failed if we find ZV is already on the screen (scrolling up,
4368 means there's nothing past the end), or if we can't start any
4369 earlier (scrolling down, means there's nothing past the top). */
4370 if ((n
> 0 && IT_CHARPOS (it
) == ZV
)
4371 || (n
< 0 && IT_CHARPOS (it
) == CHARPOS (start
)))
4373 if (IT_CHARPOS (it
) == ZV
)
4375 if (it
.current_y
< it
.last_visible_y
4376 && (it
.current_y
+ it
.max_ascent
+ it
.max_descent
4377 > it
.last_visible_y
))
4379 /* The last line was only partially visible, make it fully
4381 w
->vscroll
= (it
.last_visible_y
4382 - it
.current_y
+ it
.max_ascent
+ it
.max_descent
);
4383 adjust_glyphs (it
.f
);
4387 bidi_unshelve_cache (itdata
, 0);
4390 else if (n
< 0) /* could happen with empty buffers */
4391 xsignal0 (Qbeginning_of_buffer
);
4393 xsignal0 (Qend_of_buffer
);
4398 if (w
->vscroll
!= 0)
4399 /* The first line was only partially visible, make it fully
4404 bidi_unshelve_cache (itdata
, 0);
4408 xsignal0 (Qbeginning_of_buffer
);
4412 /* If control gets here, then we vscrolled. */
4414 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
4416 /* Don't try to change the window start below. */
4422 ptrdiff_t pos
= IT_CHARPOS (it
);
4425 /* If in the middle of a multi-glyph character move forward to
4426 the next character. */
4427 if (in_display_vector_p (&it
))
4430 move_it_to (&it
, pos
, -1, -1, -1, MOVE_TO_POS
);
4433 /* Set the window start, and set up the window for redisplay. */
4434 set_marker_restricted (w
->start
, make_number (pos
),
4436 bytepos
= XMARKER (w
->start
)->bytepos
;
4437 w
->start_at_line_beg
= (pos
== BEGV
|| FETCH_BYTE (bytepos
- 1) == '\n');
4438 w
->update_mode_line
= 1;
4439 w
->last_modified
= 0;
4440 w
->last_overlay_modified
= 0;
4441 /* Set force_start so that redisplay_window will run the
4442 window-scroll-functions. */
4446 /* The rest of this function uses current_y in a nonstandard way,
4447 not including the height of the header line if any. */
4448 it
.current_y
= it
.vpos
= 0;
4450 /* Move PT out of scroll margins.
4451 This code wants current_y to be zero at the window start position
4452 even if there is a header line. */
4453 this_scroll_margin
= max (0, scroll_margin
);
4454 this_scroll_margin
= min (this_scroll_margin
, XFASTINT (w
->total_lines
) / 4);
4455 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
4459 /* We moved the window start towards ZV, so PT may be now
4460 in the scroll margin at the top. */
4461 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
4462 if (IT_CHARPOS (it
) == PT
&& it
.current_y
>= this_scroll_margin
4463 && (NILP (Vscroll_preserve_screen_position
)
4464 || EQ (Vscroll_preserve_screen_position
, Qt
)))
4465 /* We found PT at a legitimate height. Leave it alone. */
4467 else if (window_scroll_pixel_based_preserve_y
>= 0)
4469 /* If we have a header line, take account of it.
4470 This is necessary because we set it.current_y to 0, above. */
4471 move_it_to (&it
, -1,
4472 window_scroll_pixel_based_preserve_x
,
4473 window_scroll_pixel_based_preserve_y
4474 - (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0 ),
4475 -1, MOVE_TO_Y
| MOVE_TO_X
);
4476 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
4480 while (it
.current_y
< this_scroll_margin
)
4482 int prev
= it
.current_y
;
4483 move_it_by_lines (&it
, 1);
4484 if (prev
== it
.current_y
)
4487 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
4492 ptrdiff_t charpos
, bytepos
;
4495 /* Save our position, for the
4496 window_scroll_pixel_based_preserve_y case. */
4497 charpos
= IT_CHARPOS (it
);
4498 bytepos
= IT_BYTEPOS (it
);
4500 /* We moved the window start towards BEGV, so PT may be now
4501 in the scroll margin at the bottom. */
4502 move_it_to (&it
, PT
, -1,
4503 (it
.last_visible_y
- CURRENT_HEADER_LINE_HEIGHT (w
)
4504 - this_scroll_margin
- 1),
4506 MOVE_TO_POS
| MOVE_TO_Y
);
4508 /* Save our position, in case it's correct. */
4509 charpos
= IT_CHARPOS (it
);
4510 bytepos
= IT_BYTEPOS (it
);
4512 /* See if point is on a partially visible line at the end. */
4513 if (it
.what
== IT_EOB
)
4514 partial_p
= it
.current_y
+ it
.ascent
+ it
.descent
> it
.last_visible_y
;
4517 move_it_by_lines (&it
, 1);
4518 partial_p
= it
.current_y
> it
.last_visible_y
;
4521 if (charpos
== PT
&& !partial_p
4522 && (NILP (Vscroll_preserve_screen_position
)
4523 || EQ (Vscroll_preserve_screen_position
, Qt
)))
4524 /* We found PT before we found the display margin, so PT is ok. */
4526 else if (window_scroll_pixel_based_preserve_y
>= 0)
4528 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
4529 start_display (&it
, w
, start
);
4530 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
4531 here because we called start_display again and did not
4532 alter it.current_y this time. */
4533 move_it_to (&it
, -1, window_scroll_pixel_based_preserve_x
,
4534 window_scroll_pixel_based_preserve_y
, -1,
4535 MOVE_TO_Y
| MOVE_TO_X
);
4536 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
4541 /* The last line was only partially visible, so back up two
4542 lines to make sure we're on a fully visible line. */
4544 move_it_by_lines (&it
, -2);
4545 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
4548 /* No, the position we saved is OK, so use it. */
4549 SET_PT_BOTH (charpos
, bytepos
);
4552 bidi_unshelve_cache (itdata
, 0);
4556 /* Implementation of window_scroll that works based on screen lines.
4557 See the comment of window_scroll for parameter descriptions. */
4560 window_scroll_line_based (Lisp_Object window
, int n
, int whole
, int noerror
)
4562 register struct window
*w
= XWINDOW (window
);
4563 /* Fvertical_motion enters redisplay, which can trigger
4564 fontification, which in turn can modify buffer text (e.g., if the
4565 fontification functions replace escape sequences with faces, as
4566 in `grep-mode-font-lock-keywords'). So we use a marker to record
4567 the old point position, to prevent crashes in SET_PT_BOTH. */
4568 Lisp_Object opoint_marker
= Fpoint_marker ();
4569 register ptrdiff_t pos
, pos_byte
;
4570 register int ht
= window_internal_height (w
);
4571 register Lisp_Object tem
;
4575 Lisp_Object original_pos
= Qnil
;
4577 /* If scrolling screen-fulls, compute the number of lines to
4578 scroll from the window's height. */
4580 n
*= max (1, ht
- next_screen_context_lines
);
4582 startpos
= marker_position (w
->start
);
4584 if (!NILP (Vscroll_preserve_screen_position
))
4586 if (window_scroll_preserve_vpos
<= 0
4587 || !SYMBOLP (KVAR (current_kboard
, Vlast_command
))
4588 || NILP (Fget (KVAR (current_kboard
, Vlast_command
), Qscroll_command
)))
4590 struct position posit
4591 = *compute_motion (startpos
, 0, 0, 0,
4595 window_scroll_preserve_vpos
= posit
.vpos
;
4596 window_scroll_preserve_hpos
= posit
.hpos
+ w
->hscroll
;
4599 original_pos
= Fcons (make_number (window_scroll_preserve_hpos
),
4600 make_number (window_scroll_preserve_vpos
));
4603 XSETFASTINT (tem
, PT
);
4604 tem
= Fpos_visible_in_window_p (tem
, window
, Qnil
);
4608 Fvertical_motion (make_number (- (ht
/ 2)), window
);
4613 lose
= n
< 0 && PT
== BEGV
;
4614 Fvertical_motion (make_number (n
), window
);
4618 SET_PT_BOTH (marker_position (opoint_marker
),
4619 marker_byte_position (opoint_marker
));
4626 xsignal0 (Qbeginning_of_buffer
);
4631 /* Don't use a scroll margin that is negative or too large. */
4632 int this_scroll_margin
=
4633 max (0, min (scroll_margin
, XINT (w
->total_lines
) / 4));
4635 set_marker_restricted_both (w
->start
, w
->buffer
, pos
, pos_byte
);
4636 w
->start_at_line_beg
= !NILP (bolp
);
4637 w
->update_mode_line
= 1;
4638 w
->last_modified
= 0;
4639 w
->last_overlay_modified
= 0;
4640 /* Set force_start so that redisplay_window will run
4641 the window-scroll-functions. */
4644 if (!NILP (Vscroll_preserve_screen_position
)
4645 && (whole
|| !EQ (Vscroll_preserve_screen_position
, Qt
)))
4647 SET_PT_BOTH (pos
, pos_byte
);
4648 Fvertical_motion (original_pos
, window
);
4650 /* If we scrolled forward, put point enough lines down
4651 that it is outside the scroll margin. */
4656 if (this_scroll_margin
> 0)
4658 SET_PT_BOTH (pos
, pos_byte
);
4659 Fvertical_motion (make_number (this_scroll_margin
), window
);
4665 if (top_margin
<= marker_position (opoint_marker
))
4666 SET_PT_BOTH (marker_position (opoint_marker
),
4667 marker_byte_position (opoint_marker
));
4668 else if (!NILP (Vscroll_preserve_screen_position
))
4670 SET_PT_BOTH (pos
, pos_byte
);
4671 Fvertical_motion (original_pos
, window
);
4674 SET_PT (top_margin
);
4680 /* If we scrolled backward, put point near the end of the window
4681 but not within the scroll margin. */
4682 SET_PT_BOTH (pos
, pos_byte
);
4683 tem
= Fvertical_motion (make_number (ht
- this_scroll_margin
), window
);
4684 if (XFASTINT (tem
) == ht
- this_scroll_margin
)
4687 bottom_margin
= PT
+ 1;
4689 if (bottom_margin
> marker_position (opoint_marker
))
4690 SET_PT_BOTH (marker_position (opoint_marker
),
4691 marker_byte_position (opoint_marker
));
4694 if (!NILP (Vscroll_preserve_screen_position
))
4696 SET_PT_BOTH (pos
, pos_byte
);
4697 Fvertical_motion (original_pos
, window
);
4700 Fvertical_motion (make_number (-1), window
);
4709 xsignal0 (Qend_of_buffer
);
4714 /* Scroll selected_window up or down. If N is nil, scroll a
4715 screen-full which is defined as the height of the window minus
4716 next_screen_context_lines. If N is the symbol `-', scroll.
4717 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
4718 up. This is the guts of Fscroll_up and Fscroll_down. */
4721 scroll_command (Lisp_Object n
, int direction
)
4723 ptrdiff_t count
= SPECPDL_INDEX ();
4725 eassert (eabs (direction
) == 1);
4727 /* If selected window's buffer isn't current, make it current for
4728 the moment. But don't screw up if window_scroll gets an error. */
4729 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
4731 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
4732 Fset_buffer (XWINDOW (selected_window
)->buffer
);
4734 /* Make redisplay consider other windows than just selected_window. */
4735 ++windows_or_buffers_changed
;
4739 window_scroll (selected_window
, direction
, 1, 0);
4740 else if (EQ (n
, Qminus
))
4741 window_scroll (selected_window
, -direction
, 1, 0);
4744 n
= Fprefix_numeric_value (n
);
4745 window_scroll (selected_window
, XINT (n
) * direction
, 0, 0);
4748 unbind_to (count
, Qnil
);
4751 DEFUN ("scroll-up", Fscroll_up
, Sscroll_up
, 0, 1, "^P",
4752 doc
: /* Scroll text of selected window upward ARG lines.
4753 If ARG is omitted or nil, scroll upward by a near full screen.
4754 A near full screen is `next-screen-context-lines' less than a full screen.
4755 Negative ARG means scroll downward.
4756 If ARG is the atom `-', scroll downward by nearly full screen.
4757 When calling from a program, supply as argument a number, nil, or `-'. */)
4760 scroll_command (arg
, 1);
4764 DEFUN ("scroll-down", Fscroll_down
, Sscroll_down
, 0, 1, "^P",
4765 doc
: /* Scroll text of selected window down ARG lines.
4766 If ARG is omitted or nil, scroll down by a near full screen.
4767 A near full screen is `next-screen-context-lines' less than a full screen.
4768 Negative ARG means scroll upward.
4769 If ARG is the atom `-', scroll upward by nearly full screen.
4770 When calling from a program, supply as argument a number, nil, or `-'. */)
4773 scroll_command (arg
, -1);
4777 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling
, Sother_window_for_scrolling
, 0, 0, 0,
4778 doc
: /* Return the other window for \"other window scroll\" commands.
4779 If `other-window-scroll-buffer' is non-nil, a window
4780 showing that buffer is used.
4781 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4782 specifies the window. This takes precedence over
4783 `other-window-scroll-buffer'. */)
4788 if (MINI_WINDOW_P (XWINDOW (selected_window
))
4789 && !NILP (Vminibuf_scroll_window
))
4790 window
= Vminibuf_scroll_window
;
4791 /* If buffer is specified, scroll that buffer. */
4792 else if (!NILP (Vother_window_scroll_buffer
))
4794 window
= Fget_buffer_window (Vother_window_scroll_buffer
, Qnil
);
4796 window
= display_buffer (Vother_window_scroll_buffer
, Qt
, Qnil
);
4800 /* Nothing specified; look for a neighboring window on the same
4802 window
= Fnext_window (selected_window
, Qnil
, Qnil
);
4804 if (EQ (window
, selected_window
))
4805 /* That didn't get us anywhere; look for a window on another
4808 window
= Fnext_window (window
, Qnil
, Qt
);
4809 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window
))))
4810 && ! EQ (window
, selected_window
));
4813 CHECK_LIVE_WINDOW (window
);
4815 if (EQ (window
, selected_window
))
4816 error ("There is no other window");
4821 DEFUN ("scroll-other-window", Fscroll_other_window
, Sscroll_other_window
, 0, 1, "P",
4822 doc
: /* Scroll next window upward ARG lines; or near full screen if no ARG.
4823 A near full screen is `next-screen-context-lines' less than a full screen.
4824 The next window is the one below the current one; or the one at the top
4825 if the current one is at the bottom. Negative ARG means scroll downward.
4826 If ARG is the atom `-', scroll downward by nearly full screen.
4827 When calling from a program, supply as argument a number, nil, or `-'.
4829 If `other-window-scroll-buffer' is non-nil, scroll the window
4830 showing that buffer, popping the buffer up if necessary.
4831 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4832 specifies the window to scroll. This takes precedence over
4833 `other-window-scroll-buffer'. */)
4838 ptrdiff_t count
= SPECPDL_INDEX ();
4840 window
= Fother_window_for_scrolling ();
4841 w
= XWINDOW (window
);
4843 /* Don't screw up if window_scroll gets an error. */
4844 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
4845 ++windows_or_buffers_changed
;
4847 Fset_buffer (w
->buffer
);
4848 SET_PT (marker_position (w
->pointm
));
4851 window_scroll (window
, 1, 1, 1);
4852 else if (EQ (arg
, Qminus
))
4853 window_scroll (window
, -1, 1, 1);
4859 window_scroll (window
, XINT (arg
), 0, 1);
4862 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
4863 unbind_to (count
, Qnil
);
4868 DEFUN ("scroll-left", Fscroll_left
, Sscroll_left
, 0, 2, "^P\np",
4869 doc
: /* Scroll selected window display ARG columns left.
4870 Default for ARG is window width minus 2.
4871 Value is the total amount of leftward horizontal scrolling in
4872 effect after the change.
4873 If SET-MINIMUM is non-nil, the new scroll amount becomes the
4874 lower bound for automatic scrolling, i.e. automatic scrolling
4875 will not scroll a window to a column less than the value returned
4876 by this function. This happens in an interactive call. */)
4877 (register Lisp_Object arg
, Lisp_Object set_minimum
)
4879 struct window
*w
= XWINDOW (selected_window
);
4880 EMACS_INT requested_arg
= (NILP (arg
)
4881 ? window_body_cols (w
) - 2
4882 : XINT (Fprefix_numeric_value (arg
)));
4883 Lisp_Object result
= set_window_hscroll (w
, w
->hscroll
+ requested_arg
);
4885 if (!NILP (set_minimum
))
4886 w
->min_hscroll
= w
->hscroll
;
4891 DEFUN ("scroll-right", Fscroll_right
, Sscroll_right
, 0, 2, "^P\np",
4892 doc
: /* Scroll selected window display ARG columns right.
4893 Default for ARG is window width minus 2.
4894 Value is the total amount of leftward horizontal scrolling in
4895 effect after the change.
4896 If SET-MINIMUM is non-nil, the new scroll amount becomes the
4897 lower bound for automatic scrolling, i.e. automatic scrolling
4898 will not scroll a window to a column less than the value returned
4899 by this function. This happens in an interactive call. */)
4900 (register Lisp_Object arg
, Lisp_Object set_minimum
)
4902 struct window
*w
= XWINDOW (selected_window
);
4903 EMACS_INT requested_arg
= (NILP (arg
)
4904 ? window_body_cols (w
) - 2
4905 : XINT (Fprefix_numeric_value (arg
)));
4906 Lisp_Object result
= set_window_hscroll (w
, w
->hscroll
- requested_arg
);
4908 if (!NILP (set_minimum
))
4909 w
->min_hscroll
= w
->hscroll
;
4914 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window
, Sminibuffer_selected_window
, 0, 0, 0,
4915 doc
: /* Return the window which was selected when entering the minibuffer.
4916 Returns nil, if selected window is not a minibuffer window. */)
4919 if (minibuf_level
> 0
4920 && MINI_WINDOW_P (XWINDOW (selected_window
))
4921 && WINDOW_LIVE_P (minibuf_selected_window
))
4922 return minibuf_selected_window
;
4927 /* Value is the number of lines actually displayed in window W,
4928 as opposed to its height. */
4931 displayed_window_lines (struct window
*w
)
4934 struct text_pos start
;
4935 int height
= window_box_height (w
);
4936 struct buffer
*old_buffer
;
4938 void *itdata
= NULL
;
4940 if (XBUFFER (w
->buffer
) != current_buffer
)
4942 old_buffer
= current_buffer
;
4943 set_buffer_internal (XBUFFER (w
->buffer
));
4948 /* In case W->start is out of the accessible range, do something
4949 reasonable. This happens in Info mode when Info-scroll-down
4950 calls (recenter -1) while W->start is 1. */
4951 if (XMARKER (w
->start
)->charpos
< BEGV
)
4952 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
4953 else if (XMARKER (w
->start
)->charpos
> ZV
)
4954 SET_TEXT_POS (start
, ZV
, ZV_BYTE
);
4956 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
4958 itdata
= bidi_shelve_cache ();
4959 start_display (&it
, w
, start
);
4960 move_it_vertically (&it
, height
);
4961 bottom_y
= line_bottom_y (&it
);
4962 bidi_unshelve_cache (itdata
, 0);
4964 /* rms: On a non-window display,
4965 the value of it.vpos at the bottom of the screen
4966 seems to be 1 larger than window_box_height (w).
4967 This kludge fixes a bug whereby (move-to-window-line -1)
4968 when ZV is on the last screen line
4969 moves to the previous screen line instead of the last one. */
4970 if (! FRAME_WINDOW_P (XFRAME (w
->frame
)))
4973 /* Add in empty lines at the bottom of the window. */
4974 if (bottom_y
< height
)
4976 int uy
= FRAME_LINE_HEIGHT (it
.f
);
4977 it
.vpos
+= (height
- bottom_y
+ uy
- 1) / uy
;
4981 set_buffer_internal (old_buffer
);
4987 DEFUN ("recenter", Frecenter
, Srecenter
, 0, 1, "P",
4988 doc
: /* Center point in selected window and maybe redisplay frame.
4989 With prefix argument ARG, recenter putting point on screen line ARG
4990 relative to the selected window. If ARG is negative, it counts up from the
4991 bottom of the window. (ARG should be less than the height of the window.)
4993 If ARG is omitted or nil, then recenter with point on the middle line of
4994 the selected window; if the variable `recenter-redisplay' is non-nil,
4995 also erase the entire frame and redraw it (when `auto-resize-tool-bars'
4996 is set to `grow-only', this resets the tool-bar's height to the minimum
4997 height needed); if `recenter-redisplay' has the special value `tty',
4998 then only tty frames are redrawn.
5000 Just C-u as prefix means put point in the center of the window
5001 and redisplay normally--don't erase and redraw the frame. */)
5002 (register Lisp_Object arg
)
5004 struct window
*w
= XWINDOW (selected_window
);
5005 struct buffer
*buf
= XBUFFER (w
->buffer
);
5006 struct buffer
*obuf
= current_buffer
;
5008 ptrdiff_t charpos
, bytepos
;
5009 EMACS_INT iarg
IF_LINT (= 0);
5010 int this_scroll_margin
;
5012 /* If redisplay is suppressed due to an error, try again. */
5013 obuf
->display_error_modiff
= 0;
5017 if (!NILP (Vrecenter_redisplay
)
5018 && (!EQ (Vrecenter_redisplay
, Qtty
)
5019 || !NILP (Ftty_type (selected_frame
))))
5023 /* Invalidate pixel data calculated for all compositions. */
5024 for (i
= 0; i
< n_compositions
; i
++)
5025 composition_table
[i
]->font
= NULL
;
5027 WINDOW_XFRAME (w
)->minimize_tool_bar_window_p
= 1;
5029 Fredraw_frame (WINDOW_FRAME (w
));
5030 SET_FRAME_GARBAGED (WINDOW_XFRAME (w
));
5035 else if (CONSP (arg
)) /* Just C-u. */
5039 arg
= Fprefix_numeric_value (arg
);
5044 set_buffer_internal (buf
);
5046 /* Do this after making BUF current
5047 in case scroll_margin is buffer-local. */
5048 this_scroll_margin
=
5049 max (0, min (scroll_margin
, XFASTINT (w
->total_lines
) / 4));
5051 /* Handle centering on a graphical frame specially. Such frames can
5052 have variable-height lines and centering point on the basis of
5053 line counts would lead to strange effects. */
5054 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
5060 void *itdata
= bidi_shelve_cache ();
5062 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
5063 start_display (&it
, w
, pt
);
5064 move_it_vertically_backward (&it
, window_box_height (w
) / 2);
5065 charpos
= IT_CHARPOS (it
);
5066 bytepos
= IT_BYTEPOS (it
);
5067 bidi_unshelve_cache (itdata
, 0);
5073 ptrdiff_t nlines
= min (PTRDIFF_MAX
, -iarg
);
5074 int extra_line_spacing
;
5075 int h
= window_box_height (w
);
5076 void *itdata
= bidi_shelve_cache ();
5078 iarg
= - max (-iarg
, this_scroll_margin
);
5080 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
5081 start_display (&it
, w
, pt
);
5083 /* Be sure we have the exact height of the full line containing PT. */
5084 move_it_by_lines (&it
, 0);
5086 /* The amount of pixels we have to move back is the window
5087 height minus what's displayed in the line containing PT,
5088 and the lines below. */
5091 move_it_by_lines (&it
, nlines
);
5093 if (it
.vpos
== nlines
)
5097 /* Last line has no newline */
5098 h
-= line_bottom_y (&it
);
5102 /* Don't reserve space for extra line spacing of last line. */
5103 extra_line_spacing
= it
.max_extra_line_spacing
;
5105 /* If we can't move down NLINES lines because we hit
5106 the end of the buffer, count in some empty lines. */
5107 if (it
.vpos
< nlines
)
5110 extra_line_spacing
= it
.extra_line_spacing
;
5111 h
-= nlines
* (FRAME_LINE_HEIGHT (it
.f
) + extra_line_spacing
);
5115 bidi_unshelve_cache (itdata
, 0);
5119 /* Now find the new top line (starting position) of the window. */
5120 start_display (&it
, w
, pt
);
5122 move_it_vertically_backward (&it
, h
);
5124 /* If extra line spacing is present, we may move too far
5125 back. This causes the last line to be only partially
5126 visible (which triggers redisplay to recenter that line
5127 in the middle), so move forward.
5128 But ignore extra line spacing on last line, as it is not
5129 considered to be part of the visible height of the line.
5131 h
+= extra_line_spacing
;
5132 while (-it
.current_y
> h
)
5133 move_it_by_lines (&it
, 1);
5135 charpos
= IT_CHARPOS (it
);
5136 bytepos
= IT_BYTEPOS (it
);
5138 bidi_unshelve_cache (itdata
, 0);
5142 struct position pos
;
5144 iarg
= max (iarg
, this_scroll_margin
);
5146 pos
= *vmotion (PT
, -iarg
, w
);
5147 charpos
= pos
.bufpos
;
5148 bytepos
= pos
.bytepos
;
5153 struct position pos
;
5154 int ht
= window_internal_height (w
);
5161 /* Don't let it get into the margin at either top or bottom. */
5162 iarg
= max (iarg
, this_scroll_margin
);
5163 iarg
= min (iarg
, ht
- this_scroll_margin
- 1);
5165 pos
= *vmotion (PT
, - iarg
, w
);
5166 charpos
= pos
.bufpos
;
5167 bytepos
= pos
.bytepos
;
5170 /* Set the new window start. */
5171 set_marker_both (w
->start
, w
->buffer
, charpos
, bytepos
);
5172 w
->window_end_valid
= Qnil
;
5174 w
->optional_new_start
= 1;
5176 w
->start_at_line_beg
= (bytepos
== BEGV_BYTE
||
5177 FETCH_BYTE (bytepos
- 1) == '\n');
5179 set_buffer_internal (obuf
);
5183 DEFUN ("window-text-height", Fwindow_text_height
, Swindow_text_height
,
5185 doc
: /* Return the height in lines of the text display area of WINDOW.
5186 If WINDOW is omitted or nil, it defaults to the selected window.
5188 The returned height does not include the mode line, any header line,
5189 nor any partial-height lines at the bottom of the text area. */)
5190 (Lisp_Object window
)
5192 struct window
*w
= decode_window (window
);
5193 int pixel_height
= window_box_height (w
);
5194 int line_height
= pixel_height
/ FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
5195 return make_number (line_height
);
5200 DEFUN ("move-to-window-line", Fmove_to_window_line
, Smove_to_window_line
,
5202 doc
: /* Position point relative to window.
5203 ARG nil means position point at center of window.
5204 Else, ARG specifies vertical position within the window;
5205 zero means top of window, negative means relative to bottom of window. */)
5208 struct window
*w
= XWINDOW (selected_window
);
5212 int this_scroll_margin
;
5215 if (!(BUFFERP (w
->buffer
)
5216 && XBUFFER (w
->buffer
) == current_buffer
))
5217 /* This test is needed to make sure PT/PT_BYTE make sense in w->buffer
5218 when passed below to set_marker_both. */
5219 error ("move-to-window-line called from unrelated buffer");
5221 window
= selected_window
;
5222 start
= marker_position (w
->start
);
5223 if (start
< BEGV
|| start
> ZV
)
5225 int height
= window_internal_height (w
);
5226 Fvertical_motion (make_number (- (height
/ 2)), window
);
5227 set_marker_both (w
->start
, w
->buffer
, PT
, PT_BYTE
);
5228 w
->start_at_line_beg
= !NILP (Fbolp ());
5232 Fgoto_char (w
->start
);
5234 lines
= displayed_window_lines (w
);
5237 this_scroll_margin
= max (0, min (scroll_margin
, lines
/ 4));
5241 XSETFASTINT (arg
, lines
/ 2);
5244 EMACS_INT iarg
= XINT (Fprefix_numeric_value (arg
));
5247 iarg
= iarg
+ lines
;
5249 #if 0 /* This code would prevent move-to-window-line from moving point
5250 to a place inside the scroll margins (which would cause the
5251 next redisplay to scroll). I wrote this code, but then concluded
5252 it is probably better not to install it. However, it is here
5253 inside #if 0 so as not to lose it. -- rms. */
5255 /* Don't let it get into the margin at either top or bottom. */
5256 iarg
= max (iarg
, this_scroll_margin
);
5257 iarg
= min (iarg
, lines
- this_scroll_margin
- 1);
5260 arg
= make_number (iarg
);
5263 /* Skip past a partially visible first line. */
5265 XSETINT (arg
, XINT (arg
) + 1);
5267 return Fvertical_motion (arg
, window
);
5272 /***********************************************************************
5273 Window Configuration
5274 ***********************************************************************/
5276 struct save_window_data
5278 struct vectorlike_header header
;
5279 Lisp_Object selected_frame
;
5280 Lisp_Object current_window
;
5281 Lisp_Object current_buffer
;
5282 Lisp_Object minibuf_scroll_window
;
5283 Lisp_Object minibuf_selected_window
;
5284 Lisp_Object root_window
;
5285 Lisp_Object focus_frame
;
5286 /* A vector, each of whose elements is a struct saved_window
5288 Lisp_Object saved_windows
;
5290 /* All fields above are traced by the GC.
5291 From `fame-cols' down, the fields are ignored by the GC. */
5293 int frame_cols
, frame_lines
, frame_menu_bar_lines
;
5294 int frame_tool_bar_lines
;
5297 /* This is saved as a Lisp_Vector */
5300 struct vectorlike_header header
;
5302 Lisp_Object window
, buffer
, start
, pointm
, mark
;
5303 Lisp_Object left_col
, top_line
, total_cols
, total_lines
;
5304 Lisp_Object normal_cols
, normal_lines
;
5305 Lisp_Object hscroll
, min_hscroll
;
5306 Lisp_Object parent
, prev
;
5307 Lisp_Object start_at_line_beg
;
5308 Lisp_Object display_table
;
5309 Lisp_Object left_margin_cols
, right_margin_cols
;
5310 Lisp_Object left_fringe_width
, right_fringe_width
, fringes_outside_margins
;
5311 Lisp_Object scroll_bar_width
, vertical_scroll_bar_type
, dedicated
;
5312 Lisp_Object combination_limit
, window_parameters
;
5315 #define SAVED_WINDOW_N(swv,n) \
5316 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5318 DEFUN ("window-configuration-p", Fwindow_configuration_p
, Swindow_configuration_p
, 1, 1, 0,
5319 doc
: /* Return t if OBJECT is a window-configuration object. */)
5320 (Lisp_Object object
)
5322 return WINDOW_CONFIGURATIONP (object
) ? Qt
: Qnil
;
5325 DEFUN ("window-configuration-frame", Fwindow_configuration_frame
, Swindow_configuration_frame
, 1, 1, 0,
5326 doc
: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5327 (Lisp_Object config
)
5329 register struct save_window_data
*data
;
5330 struct Lisp_Vector
*saved_windows
;
5332 CHECK_WINDOW_CONFIGURATION (config
);
5334 data
= (struct save_window_data
*) XVECTOR (config
);
5335 saved_windows
= XVECTOR (data
->saved_windows
);
5336 return XWINDOW (SAVED_WINDOW_N (saved_windows
, 0)->window
)->frame
;
5339 DEFUN ("set-window-configuration", Fset_window_configuration
,
5340 Sset_window_configuration
, 1, 1, 0,
5341 doc
: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5342 CONFIGURATION must be a value previously returned
5343 by `current-window-configuration' (which see).
5344 If CONFIGURATION was made from a frame that is now deleted,
5345 only frame-independent values can be restored. In this case,
5346 the return value is nil. Otherwise the value is t. */)
5347 (Lisp_Object configuration
)
5349 register struct save_window_data
*data
;
5350 struct Lisp_Vector
*saved_windows
;
5351 Lisp_Object new_current_buffer
;
5353 Lisp_Object auto_buffer_name
;
5355 ptrdiff_t old_point
= -1;
5357 CHECK_WINDOW_CONFIGURATION (configuration
);
5359 data
= (struct save_window_data
*) XVECTOR (configuration
);
5360 saved_windows
= XVECTOR (data
->saved_windows
);
5362 new_current_buffer
= data
->current_buffer
;
5363 if (NILP (BVAR (XBUFFER (new_current_buffer
), name
)))
5364 new_current_buffer
= Qnil
;
5367 if (XBUFFER (new_current_buffer
) == current_buffer
)
5368 /* The code further down "preserves point" by saving here PT in
5369 old_point and then setting it later back into PT. When the
5370 current-selected-window and the final-selected-window both show
5371 the current buffer, this suffers from the problem that the
5372 current PT is the window-point of the current-selected-window,
5373 while the final PT is the point of the final-selected-window, so
5374 this copy from one PT to the other would end up moving the
5375 window-point of the final-selected-window to the window-point of
5376 the current-selected-window. So we have to be careful which
5377 point of the current-buffer we copy into old_point. */
5378 if (EQ (XWINDOW (data
->current_window
)->buffer
, new_current_buffer
)
5379 && WINDOWP (selected_window
)
5380 && EQ (XWINDOW (selected_window
)->buffer
, new_current_buffer
)
5381 && !EQ (selected_window
, data
->current_window
))
5382 old_point
= XMARKER (XWINDOW (data
->current_window
)->pointm
)->charpos
;
5386 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
5387 point in new_current_buffer as of the last time this buffer was
5388 used. This can be non-deterministic since it can be changed by
5389 things like jit-lock by mere temporary selection of some random
5390 window that happens to show this buffer.
5391 So if possible we want this arbitrary choice of "which point" to
5392 be the one from the to-be-selected-window so as to prevent this
5393 window's cursor from being copied from another window. */
5394 if (EQ (XWINDOW (data
->current_window
)->buffer
, new_current_buffer
)
5395 /* If current_window = selected_window, its point is in BUF_PT. */
5396 && !EQ (selected_window
, data
->current_window
))
5397 old_point
= XMARKER (XWINDOW (data
->current_window
)->pointm
)->charpos
;
5399 old_point
= BUF_PT (XBUFFER (new_current_buffer
));
5402 frame
= XWINDOW (SAVED_WINDOW_N (saved_windows
, 0)->window
)->frame
;
5405 /* If f is a dead frame, don't bother rebuilding its window tree.
5406 However, there is other stuff we should still try to do below. */
5407 if (FRAME_LIVE_P (f
))
5410 Lisp_Object dead_windows
= Qnil
;
5411 register Lisp_Object tem
, par
, pers
;
5412 register struct window
*w
;
5413 register struct saved_window
*p
;
5414 struct window
*root_window
;
5415 struct window
**leaf_windows
;
5420 /* If the frame has been resized since this window configuration was
5421 made, we change the frame to the size specified in the
5422 configuration, restore the configuration, and then resize it
5423 back. We keep track of the prevailing height in these variables. */
5424 int previous_frame_lines
= FRAME_LINES (f
);
5425 int previous_frame_cols
= FRAME_COLS (f
);
5426 int previous_frame_menu_bar_lines
= FRAME_MENU_BAR_LINES (f
);
5427 int previous_frame_tool_bar_lines
= FRAME_TOOL_BAR_LINES (f
);
5429 /* The mouse highlighting code could get screwed up
5430 if it runs during this. */
5433 if (data
->frame_lines
!= previous_frame_lines
5434 || data
->frame_cols
!= previous_frame_cols
)
5435 change_frame_size (f
, data
->frame_lines
,
5436 data
->frame_cols
, 0, 0, 0);
5437 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5438 if (data
->frame_menu_bar_lines
5439 != previous_frame_menu_bar_lines
)
5440 x_set_menu_bar_lines (f
, make_number (data
->frame_menu_bar_lines
),
5442 #ifdef HAVE_WINDOW_SYSTEM
5443 if (data
->frame_tool_bar_lines
5444 != previous_frame_tool_bar_lines
)
5445 x_set_tool_bar_lines (f
, make_number (data
->frame_tool_bar_lines
),
5450 /* "Swap out" point from the selected window's buffer
5451 into the window itself. (Normally the pointm of the selected
5452 window holds garbage.) We do this now, before
5453 restoring the window contents, and prevent it from
5454 being done later on when we select a new window. */
5455 if (! NILP (XWINDOW (selected_window
)->buffer
))
5457 w
= XWINDOW (selected_window
);
5458 set_marker_both (w
->pointm
,
5460 BUF_PT (XBUFFER (w
->buffer
)),
5461 BUF_PT_BYTE (XBUFFER (w
->buffer
)));
5464 windows_or_buffers_changed
++;
5465 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
5467 /* Problem: Freeing all matrices and later allocating them again
5468 is a serious redisplay flickering problem. What we would
5469 really like to do is to free only those matrices not reused
5471 root_window
= XWINDOW (FRAME_ROOT_WINDOW (f
));
5472 leaf_windows
= alloca (count_windows (root_window
)
5473 * sizeof *leaf_windows
);
5474 n_leaf_windows
= get_leaf_windows (root_window
, leaf_windows
, 0);
5477 Mark all windows now on frame as "deleted".
5478 Restoring the new configuration "undeletes" any that are in it.
5480 Save their current buffers in their height fields, since we may
5481 need it later, if a buffer saved in the configuration is now
5483 delete_all_child_windows (FRAME_ROOT_WINDOW (f
));
5485 for (k
= 0; k
< saved_windows
->header
.size
; k
++)
5487 p
= SAVED_WINDOW_N (saved_windows
, k
);
5489 w
= XWINDOW (window
);
5492 if (!NILP (p
->parent
))
5493 w
->parent
= SAVED_WINDOW_N (saved_windows
,
5494 XFASTINT (p
->parent
))->window
;
5498 if (!NILP (p
->prev
))
5500 w
->prev
= SAVED_WINDOW_N (saved_windows
,
5501 XFASTINT (p
->prev
))->window
;
5502 XWINDOW (w
->prev
)->next
= p
->window
;
5507 if (!NILP (w
->parent
))
5509 if (EQ (p
->total_cols
, XWINDOW (w
->parent
)->total_cols
))
5511 XWINDOW (w
->parent
)->vchild
= p
->window
;
5512 XWINDOW (w
->parent
)->hchild
= Qnil
;
5516 XWINDOW (w
->parent
)->hchild
= p
->window
;
5517 XWINDOW (w
->parent
)->vchild
= Qnil
;
5522 /* If we squirreled away the buffer in the window's height,
5524 if (BUFFERP (w
->total_lines
))
5525 w
->buffer
= w
->total_lines
;
5526 w
->left_col
= p
->left_col
;
5527 w
->top_line
= p
->top_line
;
5528 w
->total_cols
= p
->total_cols
;
5529 w
->total_lines
= p
->total_lines
;
5530 w
->normal_cols
= p
->normal_cols
;
5531 w
->normal_lines
= p
->normal_lines
;
5532 w
->hscroll
= XFASTINT (p
->hscroll
);
5533 w
->min_hscroll
= XFASTINT (p
->min_hscroll
);
5534 w
->display_table
= p
->display_table
;
5535 w
->left_margin_cols
= p
->left_margin_cols
;
5536 w
->right_margin_cols
= p
->right_margin_cols
;
5537 w
->left_fringe_width
= p
->left_fringe_width
;
5538 w
->right_fringe_width
= p
->right_fringe_width
;
5539 w
->fringes_outside_margins
= !NILP (p
->fringes_outside_margins
);
5540 w
->scroll_bar_width
= p
->scroll_bar_width
;
5541 w
->vertical_scroll_bar_type
= p
->vertical_scroll_bar_type
;
5542 w
->dedicated
= p
->dedicated
;
5543 w
->combination_limit
= p
->combination_limit
;
5544 /* Restore any window parameters that have been saved.
5545 Parameters that have not been saved are left alone. */
5546 for (tem
= p
->window_parameters
; CONSP (tem
); tem
= XCDR (tem
))
5551 if (NILP (XCDR (pers
)))
5553 par
= Fassq (XCAR (pers
), w
->window_parameters
);
5554 if (CONSP (par
) && !NILP (XCDR (par
)))
5555 /* Reset a parameter to nil if and only if it
5556 has a non-nil association. Don't make new
5558 Fsetcdr (par
, Qnil
);
5561 /* Always restore a non-nil value. */
5562 Fset_window_parameter (window
, XCAR (pers
), XCDR (pers
));
5566 w
->last_modified
= 0;
5567 w
->last_overlay_modified
= 0;
5569 /* Reinstall the saved buffer and pointers into it. */
5570 if (NILP (p
->buffer
))
5571 /* An internal window. */
5572 w
->buffer
= p
->buffer
;
5573 else if (!NILP (BVAR (XBUFFER (p
->buffer
), name
)))
5574 /* If saved buffer is alive, install it. */
5576 w
->buffer
= p
->buffer
;
5577 w
->start_at_line_beg
= !NILP (p
->start_at_line_beg
);
5578 set_marker_restricted (w
->start
, p
->start
, w
->buffer
);
5579 set_marker_restricted (w
->pointm
, p
->pointm
, w
->buffer
);
5580 Fset_marker (BVAR (XBUFFER (w
->buffer
), mark
),
5581 p
->mark
, w
->buffer
);
5583 /* As documented in Fcurrent_window_configuration, don't
5584 restore the location of point in the buffer which was
5585 current when the window configuration was recorded. */
5586 if (!EQ (p
->buffer
, new_current_buffer
)
5587 && XBUFFER (p
->buffer
) == current_buffer
)
5588 Fgoto_char (w
->pointm
);
5590 else if (!NILP (w
->buffer
) && !NILP (BVAR (XBUFFER (w
->buffer
), name
)))
5591 /* Keep window's old buffer; make sure the markers are
5594 /* Set window markers at start of visible range. */
5595 if (XMARKER (w
->start
)->buffer
== 0)
5596 set_marker_restricted (w
->start
, make_number (0),
5598 if (XMARKER (w
->pointm
)->buffer
== 0)
5599 set_marker_restricted_both (w
->pointm
, w
->buffer
,
5600 BUF_PT (XBUFFER (w
->buffer
)),
5601 BUF_PT_BYTE (XBUFFER (w
->buffer
)));
5602 w
->start_at_line_beg
= 1;
5604 else if (STRINGP (auto_buffer_name
=
5605 Fwindow_parameter (window
, Qauto_buffer_name
))
5606 && SCHARS (auto_buffer_name
) != 0
5607 && !NILP (w
->buffer
= Fget_buffer_create (auto_buffer_name
)))
5609 set_marker_restricted (w
->start
, make_number (0), w
->buffer
);
5610 set_marker_restricted (w
->pointm
, make_number (0), w
->buffer
);
5611 w
->start_at_line_beg
= 1;
5614 /* Window has no live buffer, get one. */
5616 /* Get the buffer via other_buffer_safely in order to
5617 avoid showing an unimportant buffer and, if necessary, to
5618 recreate *scratch* in the course (part of Juanma's bs-show
5619 scenario from March 2011). */
5620 w
->buffer
= other_buffer_safely (Fcurrent_buffer ());
5621 /* This will set the markers to beginning of visible
5623 set_marker_restricted (w
->start
, make_number (0), w
->buffer
);
5624 set_marker_restricted (w
->pointm
, make_number (0), w
->buffer
);
5625 w
->start_at_line_beg
= 1;
5626 if (!NILP (w
->dedicated
))
5627 /* Record this window as dead. */
5628 dead_windows
= Fcons (window
, dead_windows
);
5629 /* Make sure window is no more dedicated. */
5630 w
->dedicated
= Qnil
;
5634 FRAME_ROOT_WINDOW (f
) = data
->root_window
;
5635 /* Arrange *not* to restore point in the buffer that was
5636 current when the window configuration was saved. */
5637 if (EQ (XWINDOW (data
->current_window
)->buffer
, new_current_buffer
))
5638 set_marker_restricted (XWINDOW (data
->current_window
)->pointm
,
5639 make_number (old_point
),
5640 XWINDOW (data
->current_window
)->buffer
);
5642 /* In the following call to `select-window', prevent "swapping out
5643 point" in the old selected window using the buffer that has
5644 been restored into it. We already swapped out that point from
5645 that window's old buffer. */
5646 select_window (data
->current_window
, Qnil
, 1);
5647 BVAR (XBUFFER (XWINDOW (selected_window
)->buffer
), last_selected_window
)
5650 if (NILP (data
->focus_frame
)
5651 || (FRAMEP (data
->focus_frame
)
5652 && FRAME_LIVE_P (XFRAME (data
->focus_frame
))))
5653 Fredirect_frame_focus (frame
, data
->focus_frame
);
5655 /* Set the screen height to the value it had before this function. */
5656 if (previous_frame_lines
!= FRAME_LINES (f
)
5657 || previous_frame_cols
!= FRAME_COLS (f
))
5658 change_frame_size (f
, previous_frame_lines
, previous_frame_cols
,
5660 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5661 if (previous_frame_menu_bar_lines
!= FRAME_MENU_BAR_LINES (f
))
5662 x_set_menu_bar_lines (f
, make_number (previous_frame_menu_bar_lines
),
5664 #ifdef HAVE_WINDOW_SYSTEM
5665 if (previous_frame_tool_bar_lines
!= FRAME_TOOL_BAR_LINES (f
))
5666 x_set_tool_bar_lines (f
, make_number (previous_frame_tool_bar_lines
),
5671 /* Now, free glyph matrices in windows that were not reused. */
5672 for (i
= n
= 0; i
< n_leaf_windows
; ++i
)
5674 if (NILP (leaf_windows
[i
]->buffer
))
5676 /* Assert it's not reused as a combination. */
5677 eassert (NILP (leaf_windows
[i
]->hchild
)
5678 && NILP (leaf_windows
[i
]->vchild
));
5679 free_window_matrices (leaf_windows
[i
]);
5681 else if (EQ (leaf_windows
[i
]->buffer
, new_current_buffer
))
5688 /* Scan dead buffer windows. */
5689 for (; CONSP (dead_windows
); dead_windows
= XCDR (dead_windows
))
5691 window
= XCAR (dead_windows
);
5692 if (WINDOW_LIVE_P (window
) && !EQ (window
, FRAME_ROOT_WINDOW (f
)))
5693 delete_deletable_window (window
);
5696 /* Fselect_window will have made f the selected frame, so we
5697 reselect the proper frame here. Fhandle_switch_frame will change the
5698 selected window too, but that doesn't make the call to
5699 Fselect_window above totally superfluous; it still sets f's
5701 if (FRAME_LIVE_P (XFRAME (data
->selected_frame
)))
5702 do_switch_frame (data
->selected_frame
, 0, 0, Qnil
);
5704 run_window_configuration_change_hook (f
);
5707 if (!NILP (new_current_buffer
))
5708 Fset_buffer (new_current_buffer
);
5710 Vminibuf_scroll_window
= data
->minibuf_scroll_window
;
5711 minibuf_selected_window
= data
->minibuf_selected_window
;
5713 return (FRAME_LIVE_P (f
) ? Qt
: Qnil
);
5717 /* Recursively delete all child windows reachable via the next, vchild,
5718 and hchild slots of WINDOW. */
5720 delete_all_child_windows (Lisp_Object window
)
5722 register struct window
*w
;
5724 w
= XWINDOW (window
);
5726 if (!NILP (w
->next
))
5727 /* Delete WINDOW's siblings (we traverse postorderly). */
5728 delete_all_child_windows (w
->next
);
5730 w
->total_lines
= w
->buffer
; /* See Fset_window_configuration for excuse. */
5732 if (!NILP (w
->vchild
))
5734 delete_all_child_windows (w
->vchild
);
5737 else if (!NILP (w
->hchild
))
5739 delete_all_child_windows (w
->hchild
);
5742 else if (!NILP (w
->buffer
))
5745 unchain_marker (XMARKER (w
->pointm
));
5746 unchain_marker (XMARKER (w
->start
));
5750 Vwindow_list
= Qnil
;
5754 count_windows (register struct window
*window
)
5756 register int count
= 1;
5757 if (!NILP (window
->next
))
5758 count
+= count_windows (XWINDOW (window
->next
));
5759 if (!NILP (window
->vchild
))
5760 count
+= count_windows (XWINDOW (window
->vchild
));
5761 if (!NILP (window
->hchild
))
5762 count
+= count_windows (XWINDOW (window
->hchild
));
5767 /* Fill vector FLAT with leaf windows under W, starting at index I.
5768 Value is last index + 1. */
5770 get_leaf_windows (struct window
*w
, struct window
**flat
, int i
)
5774 if (!NILP (w
->hchild
))
5775 i
= get_leaf_windows (XWINDOW (w
->hchild
), flat
, i
);
5776 else if (!NILP (w
->vchild
))
5777 i
= get_leaf_windows (XWINDOW (w
->vchild
), flat
, i
);
5781 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
5788 /* Return a pointer to the glyph W's physical cursor is on. Value is
5789 null if W's current matrix is invalid, so that no meaningful glyph
5792 get_phys_cursor_glyph (struct window
*w
)
5794 struct glyph_row
*row
;
5795 struct glyph
*glyph
;
5796 int hpos
= w
->phys_cursor
.hpos
;
5798 if (!(w
->phys_cursor
.vpos
>= 0
5799 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
))
5802 row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
);
5803 if (!row
->enabled_p
)
5808 /* When the window is hscrolled, cursor hpos can legitimately be
5809 out of bounds, but we draw the cursor at the corresponding
5810 window margin in that case. */
5811 if (!row
->reversed_p
&& hpos
< 0)
5813 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
5814 hpos
= row
->used
[TEXT_AREA
] - 1;
5817 if (row
->used
[TEXT_AREA
] > hpos
5819 glyph
= row
->glyphs
[TEXT_AREA
] + hpos
;
5828 save_window_save (Lisp_Object window
, struct Lisp_Vector
*vector
, int i
)
5830 register struct saved_window
*p
;
5831 register struct window
*w
;
5832 register Lisp_Object tem
, pers
, par
;
5834 for (;!NILP (window
); window
= w
->next
)
5836 p
= SAVED_WINDOW_N (vector
, i
);
5837 w
= XWINDOW (window
);
5839 XSETFASTINT (w
->temslot
, i
); i
++;
5841 p
->buffer
= w
->buffer
;
5842 p
->left_col
= w
->left_col
;
5843 p
->top_line
= w
->top_line
;
5844 p
->total_cols
= w
->total_cols
;
5845 p
->total_lines
= w
->total_lines
;
5846 p
->normal_cols
= w
->normal_cols
;
5847 p
->normal_lines
= w
->normal_lines
;
5848 XSETFASTINT (p
->hscroll
, w
->hscroll
);
5849 XSETFASTINT (p
->min_hscroll
, w
->min_hscroll
);
5850 p
->display_table
= w
->display_table
;
5851 p
->left_margin_cols
= w
->left_margin_cols
;
5852 p
->right_margin_cols
= w
->right_margin_cols
;
5853 p
->left_fringe_width
= w
->left_fringe_width
;
5854 p
->right_fringe_width
= w
->right_fringe_width
;
5855 p
->fringes_outside_margins
= w
->fringes_outside_margins
? Qt
: Qnil
;
5856 p
->scroll_bar_width
= w
->scroll_bar_width
;
5857 p
->vertical_scroll_bar_type
= w
->vertical_scroll_bar_type
;
5858 p
->dedicated
= w
->dedicated
;
5859 p
->combination_limit
= w
->combination_limit
;
5860 p
->window_parameters
= Qnil
;
5862 if (!NILP (Vwindow_persistent_parameters
))
5864 /* Run cycle detection on Vwindow_persistent_parameters. */
5865 Lisp_Object tortoise
, hare
;
5867 hare
= tortoise
= Vwindow_persistent_parameters
;
5868 while (CONSP (hare
))
5875 tortoise
= XCDR (tortoise
);
5877 if (EQ (hare
, tortoise
))
5878 /* Reset Vwindow_persistent_parameters to Qnil. */
5880 Vwindow_persistent_parameters
= Qnil
;
5885 for (tem
= Vwindow_persistent_parameters
; CONSP (tem
);
5889 /* Save values for persistent window parameters. */
5890 if (CONSP (pers
) && !NILP (XCDR (pers
)))
5892 par
= Fassq (XCAR (pers
), w
->window_parameters
);
5894 /* If the window has no value for the parameter,
5896 p
->window_parameters
= Fcons (Fcons (XCAR (pers
), Qnil
),
5897 p
->window_parameters
);
5899 /* If the window has a value for the parameter,
5901 p
->window_parameters
= Fcons (Fcons (XCAR (par
),
5903 p
->window_parameters
);
5908 if (!NILP (w
->buffer
))
5910 /* Save w's value of point in the window configuration. If w
5911 is the selected window, then get the value of point from
5912 the buffer; pointm is garbage in the selected window. */
5913 if (EQ (window
, selected_window
))
5914 p
->pointm
= build_marker (XBUFFER (w
->buffer
),
5915 BUF_PT (XBUFFER (w
->buffer
)),
5916 BUF_PT_BYTE (XBUFFER (w
->buffer
)));
5918 p
->pointm
= Fcopy_marker (w
->pointm
, Qnil
);
5919 XMARKER (p
->pointm
)->insertion_type
5920 = !NILP (Vwindow_point_insertion_type
);
5922 p
->start
= Fcopy_marker (w
->start
, Qnil
);
5923 p
->start_at_line_beg
= w
->start_at_line_beg
? Qt
: Qnil
;
5925 tem
= BVAR (XBUFFER (w
->buffer
), mark
);
5926 p
->mark
= Fcopy_marker (tem
, Qnil
);
5933 p
->start_at_line_beg
= Qnil
;
5936 if (NILP (w
->parent
))
5939 p
->parent
= XWINDOW (w
->parent
)->temslot
;
5944 p
->prev
= XWINDOW (w
->prev
)->temslot
;
5946 if (!NILP (w
->vchild
))
5947 i
= save_window_save (w
->vchild
, vector
, i
);
5948 if (!NILP (w
->hchild
))
5949 i
= save_window_save (w
->hchild
, vector
, i
);
5955 DEFUN ("current-window-configuration", Fcurrent_window_configuration
,
5956 Scurrent_window_configuration
, 0, 1, 0,
5957 doc
: /* Return an object representing the current window configuration of FRAME.
5958 If FRAME is nil or omitted, use the selected frame.
5959 This describes the number of windows, their sizes and current buffers,
5960 and for each displayed buffer, where display starts, and the positions of
5961 point and mark. An exception is made for point in the current buffer:
5962 its value is -not- saved.
5963 This also records the currently selected frame, and FRAME's focus
5964 redirection (see `redirect-frame-focus'). The variable
5965 `window-persistent-parameters' specifies which window parameters are
5966 saved by this function. */)
5969 register Lisp_Object tem
;
5970 register int n_windows
;
5971 register struct save_window_data
*data
;
5976 frame
= selected_frame
;
5977 CHECK_LIVE_FRAME (frame
);
5980 n_windows
= count_windows (XWINDOW (FRAME_ROOT_WINDOW (f
)));
5981 data
= ALLOCATE_PSEUDOVECTOR (struct save_window_data
, frame_cols
,
5982 PVEC_WINDOW_CONFIGURATION
);
5984 data
->frame_cols
= FRAME_COLS (f
);
5985 data
->frame_lines
= FRAME_LINES (f
);
5986 data
->frame_menu_bar_lines
= FRAME_MENU_BAR_LINES (f
);
5987 data
->frame_tool_bar_lines
= FRAME_TOOL_BAR_LINES (f
);
5988 data
->selected_frame
= selected_frame
;
5989 data
->current_window
= FRAME_SELECTED_WINDOW (f
);
5990 XSETBUFFER (data
->current_buffer
, current_buffer
);
5991 data
->minibuf_scroll_window
= minibuf_level
> 0 ? Vminibuf_scroll_window
: Qnil
;
5992 data
->minibuf_selected_window
= minibuf_level
> 0 ? minibuf_selected_window
: Qnil
;
5993 data
->root_window
= FRAME_ROOT_WINDOW (f
);
5994 data
->focus_frame
= FRAME_FOCUS_FRAME (f
);
5995 tem
= Fmake_vector (make_number (n_windows
), Qnil
);
5996 data
->saved_windows
= tem
;
5997 for (i
= 0; i
< n_windows
; i
++)
5999 Fmake_vector (make_number (VECSIZE (struct saved_window
)), Qnil
));
6000 save_window_save (FRAME_ROOT_WINDOW (f
), XVECTOR (tem
), 0);
6001 XSETWINDOW_CONFIGURATION (tem
, data
);
6005 /***********************************************************************
6007 ***********************************************************************/
6009 DEFUN ("set-window-margins", Fset_window_margins
, Sset_window_margins
,
6011 doc
: /* Set width of marginal areas of window WINDOW.
6012 If WINDOW is nil, set margins of the currently selected window.
6013 Second arg LEFT-WIDTH specifies the number of character cells to
6014 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6015 does the same for the right marginal area. A nil width parameter
6016 means no margin. */)
6017 (Lisp_Object window
, Lisp_Object left_width
, Lisp_Object right_width
)
6019 struct window
*w
= decode_window (window
);
6021 /* Translate negative or zero widths to nil.
6022 Margins that are too wide have to be checked elsewhere. */
6024 if (!NILP (left_width
))
6026 CHECK_NUMBER (left_width
);
6027 if (XINT (left_width
) <= 0)
6031 if (!NILP (right_width
))
6033 CHECK_NUMBER (right_width
);
6034 if (XINT (right_width
) <= 0)
6038 if (!EQ (w
->left_margin_cols
, left_width
)
6039 || !EQ (w
->right_margin_cols
, right_width
))
6041 w
->left_margin_cols
= left_width
;
6042 w
->right_margin_cols
= right_width
;
6044 adjust_window_margins (w
);
6046 ++windows_or_buffers_changed
;
6047 adjust_glyphs (XFRAME (WINDOW_FRAME (w
)));
6054 DEFUN ("window-margins", Fwindow_margins
, Swindow_margins
,
6056 doc
: /* Get width of marginal areas of window WINDOW.
6057 If WINDOW is omitted or nil, it defaults to the selected window.
6058 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6059 If a marginal area does not exist, its width will be returned
6061 (Lisp_Object window
)
6063 struct window
*w
= decode_window (window
);
6064 return Fcons (w
->left_margin_cols
, w
->right_margin_cols
);
6069 /***********************************************************************
6071 ***********************************************************************/
6073 DEFUN ("set-window-fringes", Fset_window_fringes
, Sset_window_fringes
,
6075 doc
: /* Set the fringe widths of window WINDOW.
6076 If WINDOW is nil, set the fringe widths of the currently selected
6078 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6079 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6080 fringe width. If a fringe width arg is nil, that means to use the
6081 frame's default fringe width. Default fringe widths can be set with
6082 the command `set-fringe-style'.
6083 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6084 outside of the display margins. By default, fringes are drawn between
6085 display marginal areas and the text area. */)
6086 (Lisp_Object window
, Lisp_Object left_width
, Lisp_Object right_width
, Lisp_Object outside_margins
)
6088 struct window
*w
= decode_window (window
);
6089 int outside
= !NILP (outside_margins
);
6091 if (!NILP (left_width
))
6092 CHECK_NATNUM (left_width
);
6093 if (!NILP (right_width
))
6094 CHECK_NATNUM (right_width
);
6096 /* Do nothing on a tty. */
6097 if (FRAME_WINDOW_P (WINDOW_XFRAME (w
))
6098 && (!EQ (w
->left_fringe_width
, left_width
)
6099 || !EQ (w
->right_fringe_width
, right_width
)
6100 || w
->fringes_outside_margins
!= outside
))
6102 w
->left_fringe_width
= left_width
;
6103 w
->right_fringe_width
= right_width
;
6104 w
->fringes_outside_margins
= outside
;
6106 adjust_window_margins (w
);
6108 clear_glyph_matrix (w
->current_matrix
);
6109 w
->window_end_valid
= Qnil
;
6111 ++windows_or_buffers_changed
;
6112 adjust_glyphs (XFRAME (WINDOW_FRAME (w
)));
6119 DEFUN ("window-fringes", Fwindow_fringes
, Swindow_fringes
,
6121 doc
: /* Get width of fringes of window WINDOW.
6122 If WINDOW is omitted or nil, it defaults to the selected window.
6123 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6124 (Lisp_Object window
)
6126 struct window
*w
= decode_window (window
);
6128 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w
)),
6129 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w
)),
6130 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
6131 ? Qt
: Qnil
), Qnil
)));
6136 /***********************************************************************
6138 ***********************************************************************/
6140 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars
,
6141 Sset_window_scroll_bars
, 2, 4, 0,
6142 doc
: /* Set width and type of scroll bars of window WINDOW.
6143 If window is nil, set scroll bars of the currently selected window.
6144 Second parameter WIDTH specifies the pixel width for the scroll bar;
6145 this is automatically adjusted to a multiple of the frame column width.
6146 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6147 bar: left, right, or nil.
6148 If WIDTH is nil, use the frame's scroll-bar width.
6149 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6150 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6151 (Lisp_Object window
, Lisp_Object width
, Lisp_Object vertical_type
, Lisp_Object horizontal_type
)
6153 struct window
*w
= decode_window (window
);
6157 CHECK_RANGED_INTEGER (width
, 0, INT_MAX
);
6159 if (XINT (width
) == 0)
6160 vertical_type
= Qnil
;
6163 if (!(NILP (vertical_type
)
6164 || EQ (vertical_type
, Qleft
)
6165 || EQ (vertical_type
, Qright
)
6166 || EQ (vertical_type
, Qt
)))
6167 error ("Invalid type of vertical scroll bar");
6169 if (!EQ (w
->scroll_bar_width
, width
)
6170 || !EQ (w
->vertical_scroll_bar_type
, vertical_type
))
6172 w
->scroll_bar_width
= width
;
6173 w
->vertical_scroll_bar_type
= vertical_type
;
6175 adjust_window_margins (w
);
6177 clear_glyph_matrix (w
->current_matrix
);
6178 w
->window_end_valid
= Qnil
;
6180 ++windows_or_buffers_changed
;
6181 adjust_glyphs (XFRAME (WINDOW_FRAME (w
)));
6188 DEFUN ("window-scroll-bars", Fwindow_scroll_bars
, Swindow_scroll_bars
,
6190 doc
: /* Get width and type of scroll bars of window WINDOW.
6191 If WINDOW is omitted or nil, it defaults to the selected window.
6192 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6193 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6195 (Lisp_Object window
)
6197 struct window
*w
= decode_window (window
);
6198 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w
)
6199 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w
)
6200 : WINDOW_SCROLL_BAR_AREA_WIDTH (w
))),
6201 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w
)),
6202 Fcons (w
->vertical_scroll_bar_type
,
6203 Fcons (Qnil
, Qnil
))));
6208 /***********************************************************************
6210 ***********************************************************************/
6212 DEFUN ("window-vscroll", Fwindow_vscroll
, Swindow_vscroll
, 0, 2, 0,
6213 doc
: /* Return the amount by which WINDOW is scrolled vertically.
6214 If WINDOW is omitted or nil, it defaults to the selected window.
6215 Normally, value is a multiple of the canonical character height of WINDOW;
6216 optional second arg PIXELS-P means value is measured in pixels. */)
6217 (Lisp_Object window
, Lisp_Object pixels_p
)
6224 window
= selected_window
;
6226 CHECK_WINDOW (window
);
6227 w
= XWINDOW (window
);
6228 f
= XFRAME (w
->frame
);
6230 if (FRAME_WINDOW_P (f
))
6231 result
= (NILP (pixels_p
)
6232 ? FRAME_CANON_Y_FROM_PIXEL_Y (f
, -w
->vscroll
)
6233 : make_number (-w
->vscroll
));
6235 result
= make_number (0);
6240 DEFUN ("set-window-vscroll", Fset_window_vscroll
, Sset_window_vscroll
,
6242 doc
: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
6243 WINDOW nil means use the selected window. Normally, VSCROLL is a
6244 non-negative multiple of the canonical character height of WINDOW;
6245 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
6246 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
6247 corresponds to an integral number of pixels. The return value is the
6248 result of this rounding.
6249 If PIXELS-P is non-nil, the return value is VSCROLL. */)
6250 (Lisp_Object window
, Lisp_Object vscroll
, Lisp_Object pixels_p
)
6256 window
= selected_window
;
6258 CHECK_WINDOW (window
);
6259 CHECK_NUMBER_OR_FLOAT (vscroll
);
6261 w
= XWINDOW (window
);
6262 f
= XFRAME (w
->frame
);
6264 if (FRAME_WINDOW_P (f
))
6266 int old_dy
= w
->vscroll
;
6268 w
->vscroll
= - (NILP (pixels_p
)
6269 ? FRAME_LINE_HEIGHT (f
) * XFLOATINT (vscroll
)
6270 : XFLOATINT (vscroll
));
6271 w
->vscroll
= min (w
->vscroll
, 0);
6273 if (w
->vscroll
!= old_dy
)
6275 /* Adjust glyph matrix of the frame if the virtual display
6276 area becomes larger than before. */
6277 if (w
->vscroll
< 0 && w
->vscroll
< old_dy
)
6280 /* Prevent redisplay shortcuts. */
6281 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
6285 return Fwindow_vscroll (window
, pixels_p
);
6289 /* Call FN for all leaf windows on frame F. FN is called with the
6290 first argument being a pointer to the leaf window, and with
6291 additional argument USER_DATA. Stops when FN returns 0. */
6294 foreach_window (struct frame
*f
, int (*fn
) (struct window
*, void *),
6297 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6298 if (WINDOWP (FRAME_ROOT_WINDOW (f
)))
6299 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f
)), fn
, user_data
);
6303 /* Helper function for foreach_window. Call FN for all leaf windows
6304 reachable from W. FN is called with the first argument being a
6305 pointer to the leaf window, and with additional argument USER_DATA.
6306 Stop when FN returns 0. Value is 0 if stopped by FN. */
6309 foreach_window_1 (struct window
*w
, int (*fn
) (struct window
*, void *), void *user_data
)
6313 for (cont
= 1; w
&& cont
;)
6315 if (!NILP (w
->hchild
))
6316 cont
= foreach_window_1 (XWINDOW (w
->hchild
), fn
, user_data
);
6317 else if (!NILP (w
->vchild
))
6318 cont
= foreach_window_1 (XWINDOW (w
->vchild
), fn
, user_data
);
6320 cont
= fn (w
, user_data
);
6322 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
6329 /* Freeze or unfreeze the window start of W unless it is a
6330 mini-window or the selected window. FREEZE_P non-null means freeze
6331 the window start. */
6334 freeze_window_start (struct window
*w
, void *freeze_p
)
6336 if (MINI_WINDOW_P (w
)
6337 || (WINDOWP (selected_window
) /* Can be nil in corner cases. */
6338 && (w
== XWINDOW (selected_window
)
6339 || (MINI_WINDOW_P (XWINDOW (selected_window
))
6340 && ! NILP (Vminibuf_scroll_window
)
6341 && w
== XWINDOW (Vminibuf_scroll_window
)))))
6344 w
->frozen_window_start_p
= freeze_p
!= NULL
;
6349 /* Freeze or unfreeze the window starts of all leaf windows on frame
6350 F, except the selected window and a mini-window. FREEZE_P non-zero
6351 means freeze the window start. */
6354 freeze_window_starts (struct frame
*f
, int freeze_p
)
6356 foreach_window (f
, freeze_window_start
, (void *) (freeze_p
? f
: 0));
6360 /***********************************************************************
6362 ***********************************************************************/
6364 /* Return 1 if window configurations CONFIGURATION1 and CONFIGURATION2
6365 describe the same state of affairs. This is used by Fequal.
6367 ignore_positions non-zero means ignore non-matching scroll positions
6370 This ignores a couple of things like the dedication status of
6371 window, combination_limit and the like. This might have to be
6375 compare_window_configurations (Lisp_Object configuration1
, Lisp_Object configuration2
, int ignore_positions
)
6377 register struct save_window_data
*d1
, *d2
;
6378 struct Lisp_Vector
*sws1
, *sws2
;
6381 CHECK_WINDOW_CONFIGURATION (configuration1
);
6382 CHECK_WINDOW_CONFIGURATION (configuration2
);
6384 d1
= (struct save_window_data
*) XVECTOR (configuration1
);
6385 d2
= (struct save_window_data
*) XVECTOR (configuration2
);
6386 sws1
= XVECTOR (d1
->saved_windows
);
6387 sws2
= XVECTOR (d2
->saved_windows
);
6389 /* Frame settings must match. */
6390 if (d1
->frame_cols
!= d2
->frame_cols
6391 || d1
->frame_lines
!= d2
->frame_lines
6392 || d1
->frame_menu_bar_lines
!= d2
->frame_menu_bar_lines
6393 || !EQ (d1
->selected_frame
, d2
->selected_frame
)
6394 || !EQ (d1
->current_buffer
, d2
->current_buffer
)
6395 || (!ignore_positions
6396 && (!EQ (d1
->minibuf_scroll_window
, d2
->minibuf_scroll_window
)
6397 || !EQ (d1
->minibuf_selected_window
, d2
->minibuf_selected_window
)))
6398 || !EQ (d1
->focus_frame
, d2
->focus_frame
)
6399 /* Verify that the two configurations have the same number of windows. */
6400 || sws1
->header
.size
!= sws2
->header
.size
)
6403 for (i
= 0; i
< sws1
->header
.size
; i
++)
6405 struct saved_window
*sw1
, *sw2
;
6407 sw1
= SAVED_WINDOW_N (sws1
, i
);
6408 sw2
= SAVED_WINDOW_N (sws2
, i
);
6411 /* The "current" windows in the two configurations must
6412 correspond to each other. */
6413 EQ (d1
->current_window
, sw1
->window
)
6414 != EQ (d2
->current_window
, sw2
->window
)
6415 /* Windows' buffers must match. */
6416 || !EQ (sw1
->buffer
, sw2
->buffer
)
6417 || !EQ (sw1
->left_col
, sw2
->left_col
)
6418 || !EQ (sw1
->top_line
, sw2
->top_line
)
6419 || !EQ (sw1
->total_cols
, sw2
->total_cols
)
6420 || !EQ (sw1
->total_lines
, sw2
->total_lines
)
6421 || !EQ (sw1
->display_table
, sw2
->display_table
)
6422 /* The next two disjuncts check the window structure for
6424 || !EQ (sw1
->parent
, sw2
->parent
)
6425 || !EQ (sw1
->prev
, sw2
->prev
)
6426 || (!ignore_positions
6427 && (!EQ (sw1
->hscroll
, sw2
->hscroll
)
6428 || !EQ (sw1
->min_hscroll
, sw2
->min_hscroll
)
6429 || !EQ (sw1
->start_at_line_beg
, sw2
->start_at_line_beg
)
6430 || NILP (Fequal (sw1
->start
, sw2
->start
))
6431 || NILP (Fequal (sw1
->pointm
, sw2
->pointm
))
6432 || NILP (Fequal (sw1
->mark
, sw2
->mark
))))
6433 || !EQ (sw1
->left_margin_cols
, sw2
->left_margin_cols
)
6434 || !EQ (sw1
->right_margin_cols
, sw2
->right_margin_cols
)
6435 || !EQ (sw1
->left_fringe_width
, sw2
->left_fringe_width
)
6436 || !EQ (sw1
->right_fringe_width
, sw2
->right_fringe_width
)
6437 || !EQ (sw1
->fringes_outside_margins
, sw2
->fringes_outside_margins
)
6438 || !EQ (sw1
->scroll_bar_width
, sw2
->scroll_bar_width
)
6439 || !EQ (sw1
->vertical_scroll_bar_type
, sw2
->vertical_scroll_bar_type
))
6446 DEFUN ("compare-window-configurations", Fcompare_window_configurations
,
6447 Scompare_window_configurations
, 2, 2, 0,
6448 doc
: /* Compare two window configurations as regards the structure of windows.
6449 This function ignores details such as the values of point and mark
6450 and scrolling positions. */)
6451 (Lisp_Object x
, Lisp_Object y
)
6453 if (compare_window_configurations (x
, y
, 1))
6459 init_window_once (void)
6461 struct frame
*f
= make_initial_frame ();
6462 XSETFRAME (selected_frame
, f
);
6463 Vterminal_frame
= selected_frame
;
6464 minibuf_window
= f
->minibuffer_window
;
6465 selected_window
= f
->selected_window
;
6466 last_nonminibuf_frame
= f
;
6468 window_initialized
= 1;
6474 Vwindow_list
= Qnil
;
6478 syms_of_window (void)
6480 DEFSYM (Qscroll_up
, "scroll-up");
6481 DEFSYM (Qscroll_down
, "scroll-down");
6482 DEFSYM (Qscroll_command
, "scroll-command");
6484 Fput (Qscroll_up
, Qscroll_command
, Qt
);
6485 Fput (Qscroll_down
, Qscroll_command
, Qt
);
6487 DEFSYM (Qwindow_configuration_change_hook
, "window-configuration-change-hook");
6488 DEFSYM (Qwindowp
, "windowp");
6489 DEFSYM (Qwindow_configuration_p
, "window-configuration-p");
6490 DEFSYM (Qwindow_live_p
, "window-live-p");
6491 DEFSYM (Qwindow_deletable_p
, "window-deletable-p");
6492 DEFSYM (Qdelete_window
, "delete-window");
6493 DEFSYM (Qwindow_resize_root_window
, "window--resize-root-window");
6494 DEFSYM (Qwindow_resize_root_window_vertically
, "window--resize-root-window-vertically");
6495 DEFSYM (Qsafe
, "safe");
6496 DEFSYM (Qdisplay_buffer
, "display-buffer");
6497 DEFSYM (Qreplace_buffer_in_windows
, "replace-buffer-in-windows");
6498 DEFSYM (Qrecord_window_buffer
, "record-window-buffer");
6499 DEFSYM (Qget_mru_window
, "get-mru-window");
6500 DEFSYM (Qtemp_buffer_show_hook
, "temp-buffer-show-hook");
6501 DEFSYM (Qabove
, "above");
6502 DEFSYM (Qbelow
, "below");
6503 DEFSYM (Qauto_buffer_name
, "auto-buffer-name");
6504 DEFSYM (Qclone_of
, "clone-of");
6506 staticpro (&Vwindow_list
);
6508 minibuf_selected_window
= Qnil
;
6509 staticpro (&minibuf_selected_window
);
6511 window_scroll_pixel_based_preserve_x
= -1;
6512 window_scroll_pixel_based_preserve_y
= -1;
6513 window_scroll_preserve_hpos
= -1;
6514 window_scroll_preserve_vpos
= -1;
6516 DEFVAR_LISP ("temp-buffer-show-function", Vtemp_buffer_show_function
,
6517 doc
: /* Non-nil means call as function to display a help buffer.
6518 The function is called with one argument, the buffer to be displayed.
6519 Used by `with-output-to-temp-buffer'.
6520 If this function is used, then it must do the entire job of showing
6521 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
6522 Vtemp_buffer_show_function
= Qnil
;
6524 DEFVAR_LISP ("minibuffer-scroll-window", Vminibuf_scroll_window
,
6525 doc
: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
6526 Vminibuf_scroll_window
= Qnil
;
6528 DEFVAR_BOOL ("mode-line-in-non-selected-windows", mode_line_in_non_selected_windows
,
6529 doc
: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
6530 If the minibuffer is active, the `minibuffer-scroll-window' mode line
6531 is displayed in the `mode-line' face. */);
6532 mode_line_in_non_selected_windows
= 1;
6534 DEFVAR_LISP ("other-window-scroll-buffer", Vother_window_scroll_buffer
,
6535 doc
: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
6536 Vother_window_scroll_buffer
= Qnil
;
6538 DEFVAR_BOOL ("auto-window-vscroll", auto_window_vscroll_p
,
6539 doc
: /* Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
6540 auto_window_vscroll_p
= 1;
6542 DEFVAR_INT ("next-screen-context-lines", next_screen_context_lines
,
6543 doc
: /* Number of lines of continuity when scrolling by screenfuls. */);
6544 next_screen_context_lines
= 2;
6546 DEFVAR_LISP ("scroll-preserve-screen-position",
6547 Vscroll_preserve_screen_position
,
6548 doc
: /* Controls if scroll commands move point to keep its screen position unchanged.
6549 A value of nil means point does not keep its screen position except
6550 at the scroll margin or window boundary respectively.
6551 A value of t means point keeps its screen position if the scroll
6552 command moved it vertically out of the window, e.g. when scrolling
6554 Any other value means point always keeps its screen position.
6555 Scroll commands should have the `scroll-command' property
6556 on their symbols to be controlled by this variable. */);
6557 Vscroll_preserve_screen_position
= Qnil
;
6559 DEFVAR_LISP ("window-point-insertion-type", Vwindow_point_insertion_type
,
6560 doc
: /* Type of marker to use for `window-point'. */);
6561 Vwindow_point_insertion_type
= Qnil
;
6563 DEFVAR_LISP ("window-configuration-change-hook",
6564 Vwindow_configuration_change_hook
,
6565 doc
: /* Functions to call when window configuration changes.
6566 The buffer-local part is run once per window, with the relevant window
6567 selected; while the global part is run only once for the modified frame,
6568 with the relevant frame selected. */);
6569 Vwindow_configuration_change_hook
= Qnil
;
6571 DEFVAR_LISP ("recenter-redisplay", Vrecenter_redisplay
,
6572 doc
: /* Non-nil means `recenter' redraws entire frame.
6573 If this option is non-nil, then the `recenter' command with a nil
6574 argument will redraw the entire frame; the special value `tty' causes
6575 the frame to be redrawn only if it is a tty frame. */);
6576 Vrecenter_redisplay
= Qtty
;
6578 DEFVAR_LISP ("window-combination-resize", Vwindow_combination_resize
,
6579 doc
: /* If t, resize window combinations proportionally.
6580 If this variable is nil, splitting a window gets the entire screen space
6581 for displaying the new window from the window to split. Deleting and
6582 resizing a window preferably resizes one adjacent window only.
6584 If this variable is t, splitting a window tries to get the space
6585 proportionally from all windows in the same combination. This also
6586 allows to split a window that is otherwise too small or of fixed size.
6587 Resizing and deleting a window proportionally resize all windows in the
6590 Other values are reserved for future use.
6592 This variable takes no effect if `window-combination-limit' is non-nil. */);
6593 Vwindow_combination_resize
= Qnil
;
6595 DEFVAR_LISP ("window-combination-limit", Vwindow_combination_limit
,
6596 doc
: /* If t, splitting a window makes a new parent window.
6597 If this variable is nil, splitting a window will create a new parent
6598 window only if the window has no parent window or the window shall
6599 become a combination orthogonal to the one it is part of.
6601 If this variable is t, splitting a window always creates a new parent
6602 window. If all splits behave this way, each frame's window tree is a
6603 binary tree and every window but the frame's root window has exactly one
6606 Other values are reserved for future use.
6608 The value of this variable is also assigned to the combination limit of
6609 the new parent window. The combination limit of a window can be
6610 retrieved via the function `window-combination-limit' and altered by the
6611 function `set-window-combination-limit'. */);
6612 Vwindow_combination_limit
= Qnil
;
6614 DEFVAR_LISP ("window-persistent-parameters", Vwindow_persistent_parameters
,
6615 doc
: /* Alist of persistent window parameters.
6616 This alist specifies which window parameters shall get saved by
6617 `current-window-configuration' and `window-state-get' and subsequently
6618 restored to their previous values by `set-window-configuration' and
6621 The car of each entry of this alist is the symbol specifying the
6622 parameter. The cdr is one of the following:
6624 nil means the parameter is neither saved by `window-state-get' nor by
6625 `current-window-configuration'.
6627 t means the parameter is saved by `current-window-configuration' and,
6628 provided its WRITABLE argument is nil, by `window-state-get'.
6630 The symbol `writable' means the parameter is saved unconditionally by
6631 both `current-window-configuration' and `window-state-get'. Do not use
6632 this value for parameters without read syntax (like windows or frames).
6634 Parameters not saved by `current-window-configuration' or
6635 `window-state-get' are left alone by `set-window-configuration'
6636 respectively are not installed by `window-state-put'. */);
6637 Vwindow_persistent_parameters
= list1 (Fcons (Qclone_of
, Qt
));
6639 defsubr (&Sselected_window
);
6640 defsubr (&Sminibuffer_window
);
6641 defsubr (&Swindow_minibuffer_p
);
6642 defsubr (&Swindowp
);
6643 defsubr (&Swindow_live_p
);
6644 defsubr (&Swindow_frame
);
6645 defsubr (&Sframe_root_window
);
6646 defsubr (&Sframe_first_window
);
6647 defsubr (&Sframe_selected_window
);
6648 defsubr (&Sset_frame_selected_window
);
6649 defsubr (&Spos_visible_in_window_p
);
6650 defsubr (&Swindow_line_height
);
6651 defsubr (&Swindow_buffer
);
6652 defsubr (&Swindow_parent
);
6653 defsubr (&Swindow_top_child
);
6654 defsubr (&Swindow_left_child
);
6655 defsubr (&Swindow_next_sibling
);
6656 defsubr (&Swindow_prev_sibling
);
6657 defsubr (&Swindow_combination_limit
);
6658 defsubr (&Sset_window_combination_limit
);
6659 defsubr (&Swindow_use_time
);
6660 defsubr (&Swindow_top_line
);
6661 defsubr (&Swindow_left_column
);
6662 defsubr (&Swindow_total_height
);
6663 defsubr (&Swindow_total_width
);
6664 defsubr (&Swindow_normal_size
);
6665 defsubr (&Swindow_new_total
);
6666 defsubr (&Swindow_new_normal
);
6667 defsubr (&Sset_window_new_total
);
6668 defsubr (&Sset_window_new_normal
);
6669 defsubr (&Swindow_resize_apply
);
6670 defsubr (&Swindow_body_height
);
6671 defsubr (&Swindow_body_width
);
6672 defsubr (&Swindow_hscroll
);
6673 defsubr (&Sset_window_hscroll
);
6674 defsubr (&Swindow_redisplay_end_trigger
);
6675 defsubr (&Sset_window_redisplay_end_trigger
);
6676 defsubr (&Swindow_edges
);
6677 defsubr (&Swindow_pixel_edges
);
6678 defsubr (&Swindow_absolute_pixel_edges
);
6679 defsubr (&Swindow_inside_edges
);
6680 defsubr (&Swindow_inside_pixel_edges
);
6681 defsubr (&Swindow_inside_absolute_pixel_edges
);
6682 defsubr (&Scoordinates_in_window_p
);
6683 defsubr (&Swindow_at
);
6684 defsubr (&Swindow_point
);
6685 defsubr (&Swindow_start
);
6686 defsubr (&Swindow_end
);
6687 defsubr (&Sset_window_point
);
6688 defsubr (&Sset_window_start
);
6689 defsubr (&Swindow_dedicated_p
);
6690 defsubr (&Sset_window_dedicated_p
);
6691 defsubr (&Swindow_display_table
);
6692 defsubr (&Sset_window_display_table
);
6693 defsubr (&Snext_window
);
6694 defsubr (&Sprevious_window
);
6695 defsubr (&Sget_buffer_window
);
6696 defsubr (&Sdelete_other_windows_internal
);
6697 defsubr (&Sdelete_window_internal
);
6698 defsubr (&Sresize_mini_window_internal
);
6699 defsubr (&Sset_window_buffer
);
6700 defsubr (&Srun_window_configuration_change_hook
);
6701 defsubr (&Sselect_window
);
6702 defsubr (&Sforce_window_update
);
6703 defsubr (&Stemp_output_buffer_show
);
6704 defsubr (&Ssplit_window_internal
);
6705 defsubr (&Sscroll_up
);
6706 defsubr (&Sscroll_down
);
6707 defsubr (&Sscroll_left
);
6708 defsubr (&Sscroll_right
);
6709 defsubr (&Sother_window_for_scrolling
);
6710 defsubr (&Sscroll_other_window
);
6711 defsubr (&Sminibuffer_selected_window
);
6712 defsubr (&Srecenter
);
6713 defsubr (&Swindow_text_height
);
6714 defsubr (&Smove_to_window_line
);
6715 defsubr (&Swindow_configuration_p
);
6716 defsubr (&Swindow_configuration_frame
);
6717 defsubr (&Sset_window_configuration
);
6718 defsubr (&Scurrent_window_configuration
);
6719 defsubr (&Sset_window_margins
);
6720 defsubr (&Swindow_margins
);
6721 defsubr (&Sset_window_fringes
);
6722 defsubr (&Swindow_fringes
);
6723 defsubr (&Sset_window_scroll_bars
);
6724 defsubr (&Swindow_scroll_bars
);
6725 defsubr (&Swindow_vscroll
);
6726 defsubr (&Sset_window_vscroll
);
6727 defsubr (&Scompare_window_configurations
);
6728 defsubr (&Swindow_list
);
6729 defsubr (&Swindow_list_1
);
6730 defsubr (&Swindow_prev_buffers
);
6731 defsubr (&Sset_window_prev_buffers
);
6732 defsubr (&Swindow_next_buffers
);
6733 defsubr (&Sset_window_next_buffers
);
6734 defsubr (&Swindow_parameters
);
6735 defsubr (&Swindow_parameter
);
6736 defsubr (&Sset_window_parameter
);
6740 keys_of_window (void)
6742 initial_define_key (control_x_map
, '<', "scroll-left");
6743 initial_define_key (control_x_map
, '>', "scroll-right");
6745 initial_define_key (global_map
, Ctl ('V'), "scroll-up-command");
6746 initial_define_key (meta_map
, Ctl ('V'), "scroll-other-window");
6747 initial_define_key (meta_map
, 'v', "scroll-down-command");