Remove two uses of 'min' in Fwindow_text_pixel_size
[emacs.git] / src / window.c
blobfe10241c45cfc3a67bca3b877ddfd0d1d3da9ba4
1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985-1987, 1993-1998, 2000-2016 Free Software
4 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 (at
11 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/>. */
21 #include <config.h>
23 #include <stdio.h>
25 #include "lisp.h"
26 #include "buffer.h"
27 #include "keyboard.h"
28 #include "keymap.h"
29 #include "frame.h"
30 #include "window.h"
31 #include "commands.h"
32 #include "indent.h"
33 #include "termchar.h"
34 #include "disptab.h"
35 #include "dispextern.h"
36 #include "blockinput.h"
37 #include "termhooks.h" /* For FRAME_TERMINAL. */
38 #include "xwidget.h"
39 #ifdef HAVE_WINDOW_SYSTEM
40 #include TERM_HEADER
41 #endif /* HAVE_WINDOW_SYSTEM */
42 #ifdef MSDOS
43 #include "msdos.h"
44 #endif
46 static ptrdiff_t count_windows (struct window *);
47 static ptrdiff_t get_leaf_windows (struct window *, struct window **,
48 ptrdiff_t);
49 static void window_scroll_pixel_based (Lisp_Object, int, bool, bool);
50 static void window_scroll_line_based (Lisp_Object, int, bool, bool);
51 static void foreach_window (struct frame *,
52 bool (* fn) (struct window *, void *),
53 void *);
54 static bool foreach_window_1 (struct window *,
55 bool (* fn) (struct window *, void *),
56 void *);
57 static bool window_resize_check (struct window *, bool);
58 static void window_resize_apply (struct window *, bool);
59 static void select_window_1 (Lisp_Object, bool);
60 static void run_window_configuration_change_hook (struct frame *);
62 static struct window *set_window_fringes (struct window *, Lisp_Object,
63 Lisp_Object, Lisp_Object);
64 static struct window *set_window_margins (struct window *, Lisp_Object,
65 Lisp_Object);
66 static struct window *set_window_scroll_bars (struct window *, Lisp_Object,
67 Lisp_Object, Lisp_Object,
68 Lisp_Object);
69 static void apply_window_adjustment (struct window *);
71 /* This is the window in which the terminal's cursor should
72 be left when nothing is being done with it. This must
73 always be a leaf window, and its buffer is selected by
74 the top level editing loop at the end of each command.
76 This value is always the same as
77 FRAME_SELECTED_WINDOW (selected_frame). */
78 Lisp_Object selected_window;
80 /* A list of all windows for use by next_window and Fwindow_list.
81 Functions creating or deleting windows should invalidate this cache
82 by setting it to nil. */
83 Lisp_Object Vwindow_list;
85 /* The mini-buffer window of the selected frame.
86 Note that you cannot test for mini-bufferness of an arbitrary window
87 by comparing against this; but you can test for mini-bufferness of
88 the selected window. */
89 Lisp_Object minibuf_window;
91 /* Non-nil means it is the window whose mode line should be
92 shown as the selected window when the minibuffer is selected. */
93 Lisp_Object minibuf_selected_window;
95 /* Incremented for each window created. */
96 static EMACS_INT sequence_number;
98 /* Used by the function window_scroll_pixel_based. */
99 static int window_scroll_pixel_based_preserve_x;
100 static int window_scroll_pixel_based_preserve_y;
102 /* Same for window_scroll_line_based. */
103 static EMACS_INT window_scroll_preserve_hpos;
104 static EMACS_INT window_scroll_preserve_vpos;
106 static void
107 CHECK_WINDOW_CONFIGURATION (Lisp_Object x)
109 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x);
112 /* These setters are used only in this file, so they can be private. */
113 static void
114 wset_combination_limit (struct window *w, Lisp_Object val)
116 w->combination_limit = val;
119 static void
120 wset_dedicated (struct window *w, Lisp_Object val)
122 w->dedicated = val;
125 static void
126 wset_display_table (struct window *w, Lisp_Object val)
128 w->display_table = val;
131 static void
132 wset_new_normal (struct window *w, Lisp_Object val)
134 w->new_normal = val;
137 static void
138 wset_new_total (struct window *w, Lisp_Object val)
140 w->new_total = val;
143 static void
144 wset_normal_cols (struct window *w, Lisp_Object val)
146 w->normal_cols = val;
149 static void
150 wset_normal_lines (struct window *w, Lisp_Object val)
152 w->normal_lines = val;
155 static void
156 wset_parent (struct window *w, Lisp_Object val)
158 w->parent = val;
161 static void
162 wset_pointm (struct window *w, Lisp_Object val)
164 w->pointm = val;
167 static void
168 wset_old_pointm (struct window *w, Lisp_Object val)
170 w->old_pointm = val;
173 static void
174 wset_start (struct window *w, Lisp_Object val)
176 w->start = val;
179 static void
180 wset_temslot (struct window *w, Lisp_Object val)
182 w->temslot = val;
185 static void
186 wset_vertical_scroll_bar_type (struct window *w, Lisp_Object val)
188 w->vertical_scroll_bar_type = val;
191 static void
192 wset_window_parameters (struct window *w, Lisp_Object val)
194 w->window_parameters = val;
197 static void
198 wset_combination (struct window *w, bool horflag, Lisp_Object val)
200 /* Since leaf windows never becomes non-leaf, there should
201 be no buffer and markers in start and pointm fields of W. */
202 eassert (!BUFFERP (w->contents) && NILP (w->start) && NILP (w->pointm));
203 w->contents = val;
204 /* When an internal window is deleted and VAL is nil, HORFLAG
205 is meaningless. */
206 if (!NILP (val))
207 w->horizontal = horflag;
210 static void
211 wset_update_mode_line (struct window *w)
213 /* If this window is the selected window on its frame, set the
214 global variable update_mode_lines, so that x_consider_frame_title
215 will consider this frame's title for redisplay. */
216 Lisp_Object fselected_window = XFRAME (WINDOW_FRAME (w))->selected_window;
218 if (WINDOWP (fselected_window) && XWINDOW (fselected_window) == w)
219 update_mode_lines = 42;
220 else
221 w->update_mode_line = true;
224 /* True if leaf window W doesn't reflect the actual state
225 of displayed buffer due to its text or overlays change. */
227 bool
228 window_outdated (struct window *w)
230 struct buffer *b = XBUFFER (w->contents);
231 return (w->last_modified < BUF_MODIFF (b)
232 || w->last_overlay_modified < BUF_OVERLAY_MODIFF (b));
235 struct window *
236 decode_live_window (register Lisp_Object window)
238 if (NILP (window))
239 return XWINDOW (selected_window);
241 CHECK_LIVE_WINDOW (window);
242 return XWINDOW (window);
245 struct window *
246 decode_any_window (register Lisp_Object window)
248 struct window *w;
250 if (NILP (window))
251 return XWINDOW (selected_window);
253 CHECK_WINDOW (window);
254 w = XWINDOW (window);
255 return w;
258 static struct window *
259 decode_valid_window (register Lisp_Object window)
261 struct window *w;
263 if (NILP (window))
264 return XWINDOW (selected_window);
266 CHECK_VALID_WINDOW (window);
267 w = XWINDOW (window);
268 return w;
271 /* Called when W's buffer slot is changed. ARG -1 means that W is about to
272 cease its buffer, and 1 means that W is about to set up the new one. */
274 static void
275 adjust_window_count (struct window *w, int arg)
277 eassert (eabs (arg) == 1);
278 if (BUFFERP (w->contents))
280 struct buffer *b = XBUFFER (w->contents);
282 if (b->base_buffer)
283 b = b->base_buffer;
284 b->window_count += arg;
285 eassert (b->window_count >= 0);
286 /* These should be recalculated by redisplay code. */
287 w->window_end_valid = false;
288 w->base_line_pos = 0;
292 /* Set W's buffer slot to VAL and recompute number
293 of windows showing VAL if it is a buffer. */
295 void
296 wset_buffer (struct window *w, Lisp_Object val)
298 adjust_window_count (w, -1);
299 if (BUFFERP (val))
300 /* Make sure that we do not assign the buffer
301 to an internal window. */
302 eassert (MARKERP (w->start) && MARKERP (w->pointm));
303 w->contents = val;
304 adjust_window_count (w, 1);
307 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
308 doc: /* Return t if OBJECT is a window and nil otherwise. */)
309 (Lisp_Object object)
311 return WINDOWP (object) ? Qt : Qnil;
314 DEFUN ("window-valid-p", Fwindow_valid_p, Swindow_valid_p, 1, 1, 0,
315 doc: /* Return t if OBJECT is a valid window and nil otherwise.
316 A valid window is either a window that displays a buffer or an internal
317 window. Windows that have been deleted are not valid. */)
318 (Lisp_Object object)
320 return WINDOW_VALID_P (object) ? Qt : Qnil;
323 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
324 doc: /* Return t if OBJECT is a live window and nil otherwise.
325 A live window is a window that displays a buffer.
326 Internal windows and deleted windows are not live. */)
327 (Lisp_Object object)
329 return WINDOW_LIVE_P (object) ? Qt : Qnil;
332 /* Frames and windows. */
333 DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 0, 1, 0,
334 doc: /* Return the frame that window WINDOW is on.
335 WINDOW must be a valid window and defaults to the selected one. */)
336 (Lisp_Object window)
338 return decode_valid_window (window)->frame;
341 DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
342 doc: /* Return the root window of FRAME-OR-WINDOW.
343 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
344 With a frame argument, return that frame's root window.
345 With a window argument, return the root window of that window's frame. */)
346 (Lisp_Object frame_or_window)
348 Lisp_Object window;
350 if (NILP (frame_or_window))
351 window = SELECTED_FRAME ()->root_window;
352 else if (WINDOW_VALID_P (frame_or_window))
353 window = XFRAME (XWINDOW (frame_or_window)->frame)->root_window;
354 else
356 CHECK_LIVE_FRAME (frame_or_window);
357 window = XFRAME (frame_or_window)->root_window;
360 return window;
363 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
364 doc: /* Return the minibuffer window for frame FRAME.
365 If FRAME is omitted or nil, it defaults to the selected frame. */)
366 (Lisp_Object frame)
368 return FRAME_MINIBUF_WINDOW (decode_live_frame (frame));
371 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
372 Swindow_minibuffer_p, 0, 1, 0,
373 doc: /* Return non-nil if WINDOW is a minibuffer window.
374 WINDOW must be a valid window and defaults to the selected one. */)
375 (Lisp_Object window)
377 return MINI_WINDOW_P (decode_valid_window (window)) ? Qt : Qnil;
380 /* Don't move this to window.el - this must be a safe routine. */
381 DEFUN ("frame-first-window", Fframe_first_window, Sframe_first_window, 0, 1, 0,
382 doc: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
383 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
384 Else if FRAME-OR-WINDOW denotes a valid window, return the first window
385 of that window's frame. If FRAME-OR-WINDOW denotes a live frame, return
386 the first window of that frame. */)
387 (Lisp_Object frame_or_window)
389 Lisp_Object window;
391 if (NILP (frame_or_window))
392 window = SELECTED_FRAME ()->root_window;
393 else if (WINDOW_VALID_P (frame_or_window))
394 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
395 else
397 CHECK_LIVE_FRAME (frame_or_window);
398 window = XFRAME (frame_or_window)->root_window;
401 while (WINDOWP (XWINDOW (window)->contents))
402 window = XWINDOW (window)->contents;
404 return window;
407 DEFUN ("frame-selected-window", Fframe_selected_window,
408 Sframe_selected_window, 0, 1, 0,
409 doc: /* Return the selected window of FRAME-OR-WINDOW.
410 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
411 Else if FRAME-OR-WINDOW denotes a valid window, return the selected
412 window of that window's frame. If FRAME-OR-WINDOW denotes a live frame,
413 return the selected window of that frame. */)
414 (Lisp_Object frame_or_window)
416 Lisp_Object window;
418 if (NILP (frame_or_window))
419 window = SELECTED_FRAME ()->selected_window;
420 else if (WINDOW_VALID_P (frame_or_window))
421 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
422 else
424 CHECK_LIVE_FRAME (frame_or_window);
425 window = XFRAME (frame_or_window)->selected_window;
428 return window;
431 DEFUN ("set-frame-selected-window", Fset_frame_selected_window,
432 Sset_frame_selected_window, 2, 3, 0,
433 doc: /* Set selected window of FRAME to WINDOW.
434 FRAME must be a live frame and defaults to the selected one. If FRAME
435 is the selected frame, this makes WINDOW the selected window. Optional
436 argument NORECORD non-nil means to neither change the order of recently
437 selected windows nor the buffer list. WINDOW must denote a live window.
438 Return WINDOW. */)
439 (Lisp_Object frame, Lisp_Object window, Lisp_Object norecord)
441 if (NILP (frame))
442 frame = selected_frame;
444 CHECK_LIVE_FRAME (frame);
445 CHECK_LIVE_WINDOW (window);
447 if (! EQ (frame, WINDOW_FRAME (XWINDOW (window))))
448 error ("In `set-frame-selected-window', WINDOW is not on FRAME");
450 if (EQ (frame, selected_frame))
451 return Fselect_window (window, norecord);
452 else
454 fset_selected_window (XFRAME (frame), window);
455 return window;
459 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
460 doc: /* Return the selected window.
461 The selected window is the window in which the standard cursor for
462 selected windows appears and to which many commands apply. */)
463 (void)
465 return selected_window;
468 EMACS_INT window_select_count;
470 /* If select_window is called with inhibit_point_swap true it will
471 not store point of the old selected window's buffer back into that
472 window's pointm slot. This is needed by Fset_window_configuration to
473 avoid that the display routine is called with selected_window set to
474 Qnil causing a subsequent crash. */
475 static Lisp_Object
476 select_window (Lisp_Object window, Lisp_Object norecord,
477 bool inhibit_point_swap)
479 struct window *w;
480 struct frame *sf;
482 CHECK_LIVE_WINDOW (window);
484 w = XWINDOW (window);
486 /* Make the selected window's buffer current. */
487 Fset_buffer (w->contents);
489 if (EQ (window, selected_window) && !inhibit_point_swap)
490 /* `switch-to-buffer' uses (select-window (selected-window)) as a "clever"
491 way to call record_buffer from Elisp, so it's important that we call
492 record_buffer before returning here. */
493 goto record_and_return;
495 if (NILP (norecord))
496 { /* Mark the window for redisplay since the selected-window has
497 a different mode-line. */
498 wset_redisplay (XWINDOW (selected_window));
499 wset_redisplay (w);
501 else
502 redisplay_other_windows ();
504 sf = SELECTED_FRAME ();
505 if (XFRAME (WINDOW_FRAME (w)) != sf)
507 fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
508 /* Use this rather than Fhandle_switch_frame
509 so that FRAME_FOCUS_FRAME is moved appropriately as we
510 move around in the state where a minibuffer in a separate
511 frame is active. */
512 Fselect_frame (WINDOW_FRAME (w), norecord);
513 /* Fselect_frame called us back so we've done all the work already. */
514 eassert (EQ (window, selected_window));
515 return window;
517 else
518 fset_selected_window (sf, window);
520 select_window_1 (window, inhibit_point_swap);
521 bset_last_selected_window (XBUFFER (w->contents), window);
523 record_and_return:
524 /* record_buffer can run QUIT, so make sure it is run only after we have
525 re-established the invariant between selected_window and selected_frame,
526 otherwise the temporary broken invariant might "escape" (bug#14161). */
527 if (NILP (norecord))
529 w->use_time = ++window_select_count;
530 record_buffer (w->contents);
533 return window;
536 /* Select window with a minimum of fuss, i.e. don't record the change anywhere
537 (not even for redisplay's benefit), and assume that the window's frame is
538 already selected. */
539 static void
540 select_window_1 (Lisp_Object window, bool inhibit_point_swap)
542 /* Store the old selected window's buffer's point in pointm of the old
543 selected window. It belongs to that window, and when the window is
544 not selected, must be in the window. */
545 if (!inhibit_point_swap)
547 struct window *ow = XWINDOW (selected_window);
548 if (BUFFERP (ow->contents))
549 set_marker_both (ow->pointm, ow->contents,
550 BUF_PT (XBUFFER (ow->contents)),
551 BUF_PT_BYTE (XBUFFER (ow->contents)));
554 selected_window = window;
556 /* Go to the point recorded in the window.
557 This is important when the buffer is in more
558 than one window. It also matters when
559 redisplay_window has altered point after scrolling,
560 because it makes the change only in the window. */
561 set_point_from_marker (XWINDOW (window)->pointm);
564 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
565 doc: /* Select WINDOW which must be a live window.
566 Also make WINDOW's frame the selected frame and WINDOW that frame's
567 selected window. In addition, make WINDOW's buffer current and set its
568 buffer's value of `point' to the value of WINDOW's `window-point'.
569 Return WINDOW.
571 Optional second arg NORECORD non-nil means do not put this buffer at the
572 front of the buffer list and do not make this window the most recently
573 selected one.
575 Run `buffer-list-update-hook' unless NORECORD is non-nil. Note that
576 applications and internal routines often select a window temporarily for
577 various purposes; mostly, to simplify coding. As a rule, such
578 selections should be not recorded and therefore will not pollute
579 `buffer-list-update-hook'. Selections that "really count" are those
580 causing a visible change in the next redisplay of WINDOW's frame and
581 should be always recorded. So if you think of running a function each
582 time a window gets selected put it on `buffer-list-update-hook'.
584 Also note that the main editor command loop sets the current buffer to
585 the buffer of the selected window before each command. */)
586 (Lisp_Object window, Lisp_Object norecord)
588 return select_window (window, norecord, false);
591 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
592 doc: /* Return the buffer displayed in window WINDOW.
593 If WINDOW is omitted or nil, it defaults to the selected window.
594 Return nil for an internal window or a deleted window. */)
595 (Lisp_Object window)
597 struct window *w = decode_any_window (window);
598 return WINDOW_LEAF_P (w) ? w->contents : Qnil;
601 DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
602 doc: /* Return the parent window of window WINDOW.
603 WINDOW must be a valid window and defaults to the selected one.
604 Return nil for a window with no parent (e.g. a root window). */)
605 (Lisp_Object window)
607 return decode_valid_window (window)->parent;
610 DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
611 doc: /* Return the topmost child window of window WINDOW.
612 WINDOW must be a valid window and defaults to the selected one.
613 Return nil if WINDOW is a live window (live windows have no children).
614 Return nil if WINDOW is an internal window whose children form a
615 horizontal combination. */)
616 (Lisp_Object window)
618 struct window *w = decode_valid_window (window);
619 return WINDOW_VERTICAL_COMBINATION_P (w) ? w->contents : Qnil;
622 DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
623 doc: /* Return the leftmost child window of window WINDOW.
624 WINDOW must be a valid window and defaults to the selected one.
625 Return nil if WINDOW is a live window (live windows have no children).
626 Return nil if WINDOW is an internal window whose children form a
627 vertical combination. */)
628 (Lisp_Object window)
630 struct window *w = decode_valid_window (window);
631 return WINDOW_HORIZONTAL_COMBINATION_P (w) ? w->contents : Qnil;
634 DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
635 doc: /* Return the next sibling window of window WINDOW.
636 WINDOW must be a valid window and defaults to the selected one.
637 Return nil if WINDOW has no next sibling. */)
638 (Lisp_Object window)
640 return decode_valid_window (window)->next;
643 DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
644 doc: /* Return the previous sibling window of window WINDOW.
645 WINDOW must be a valid window and defaults to the selected one.
646 Return nil if WINDOW has no previous sibling. */)
647 (Lisp_Object window)
649 return decode_valid_window (window)->prev;
652 DEFUN ("window-combination-limit", Fwindow_combination_limit, Swindow_combination_limit, 1, 1, 0,
653 doc: /* Return combination limit of window WINDOW.
654 WINDOW must be a valid window used in horizontal or vertical combination.
655 If the return value is nil, child windows of WINDOW can be recombined with
656 WINDOW's siblings. A return value of t means that child windows of
657 WINDOW are never (re-)combined with WINDOW's siblings. */)
658 (Lisp_Object window)
660 struct window *w;
662 CHECK_VALID_WINDOW (window);
663 w = XWINDOW (window);
664 if (WINDOW_LEAF_P (w))
665 error ("Combination limit is meaningful for internal windows only");
666 return w->combination_limit;
669 DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
670 doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
671 WINDOW must be a valid window used in horizontal or vertical combination.
672 If LIMIT is nil, child windows of WINDOW can be recombined with WINDOW's
673 siblings. LIMIT t means that child windows of WINDOW are never
674 \(re-)combined with WINDOW's siblings. Other values are reserved for
675 future use. */)
676 (Lisp_Object window, Lisp_Object limit)
678 struct window *w;
680 CHECK_VALID_WINDOW (window);
681 w = XWINDOW (window);
682 if (WINDOW_LEAF_P (w))
683 error ("Combination limit is meaningful for internal windows only");
684 wset_combination_limit (w, limit);
685 return limit;
688 DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
689 doc: /* Return the use time of window WINDOW.
690 WINDOW must be a live window and defaults to the selected one.
691 The window with the highest use time is the most recently selected
692 one. The window with the lowest use time is the least recently
693 selected one. */)
694 (Lisp_Object window)
696 return make_number (decode_live_window (window)->use_time);
699 DEFUN ("window-pixel-width", Fwindow_pixel_width, Swindow_pixel_width, 0, 1, 0,
700 doc: /* Return the width of window WINDOW in pixels.
701 WINDOW must be a valid window and defaults to the selected one.
703 The return value includes the fringes and margins of WINDOW as well as
704 any vertical dividers or scroll bars belonging to WINDOW. If WINDOW is
705 an internal window, its pixel width is the width of the screen areas
706 spanned by its children. */)
707 (Lisp_Object window)
709 return make_number (decode_valid_window (window)->pixel_width);
712 DEFUN ("window-pixel-height", Fwindow_pixel_height, Swindow_pixel_height, 0, 1, 0,
713 doc: /* Return the height of window WINDOW in pixels.
714 WINDOW must be a valid window and defaults to the selected one.
716 The return value includes the mode line and header line and the bottom
717 divider, if any. If WINDOW is an internal window, its pixel height is
718 the height of the screen areas spanned by its children. */)
719 (Lisp_Object window)
721 return make_number (decode_valid_window (window)->pixel_height);
724 DEFUN ("window-pixel-width-before-size-change",
725 Fwindow_pixel_width_before_size_change,
726 Swindow_pixel_width_before_size_change, 0, 1, 0,
727 doc: /* Return pixel width of window WINDOW before last size changes.
728 WINDOW must be a valid window and defaults to the selected one.
730 The return value is the pixel width of WINDOW at the last time
731 `window-size-change-functions' was run. It's zero if WINDOW was made
732 after that. */)
733 (Lisp_Object window)
735 return (make_number
736 (decode_valid_window (window)->pixel_width_before_size_change));
739 DEFUN ("window-pixel-height-before-size-change",
740 Fwindow_pixel_height_before_size_change,
741 Swindow_pixel_height_before_size_change, 0, 1, 0,
742 doc: /* Return pixel height of window WINDOW before last size changes.
743 WINDOW must be a valid window and defaults to the selected one.
745 The return value is the pixel height of WINDOW at the last time
746 `window-size-change-functions' was run. It's zero if WINDOW was made
747 after that. */)
748 (Lisp_Object window)
750 return (make_number
751 (decode_valid_window (window)->pixel_height_before_size_change));
754 DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 2, 0,
755 doc: /* Return the height of window WINDOW in lines.
756 WINDOW must be a valid window and defaults to the selected one.
758 The return value includes the heights of WINDOW's mode and header line
759 and its bottom divider, if any. If WINDOW is an internal window, the
760 total height is the height of the screen areas spanned by its children.
762 If WINDOW's pixel height is not an integral multiple of its frame's
763 character height, the number of lines occupied by WINDOW is rounded
764 internally. This is done in a way such that, if WINDOW is a parent
765 window, the sum of the total heights of all its children internally
766 equals the total height of WINDOW.
768 If the optional argument ROUND is `ceiling', return the smallest integer
769 larger than WINDOW's pixel height divided by the character height of
770 WINDOW's frame. ROUND `floor' means to return the largest integer
771 smaller than WINDOW's pixel height divided by the character height of
772 WINDOW's frame. Any other value of ROUND means to return the internal
773 total height of WINDOW. */)
774 (Lisp_Object window, Lisp_Object round)
776 struct window *w = decode_valid_window (window);
778 if (! EQ (round, Qfloor) && ! EQ (round, Qceiling))
779 return make_number (w->total_lines);
780 else
782 int unit = FRAME_LINE_HEIGHT (WINDOW_XFRAME (w));
784 return make_number (EQ (round, Qceiling)
785 ? ((w->pixel_height + unit - 1) /unit)
786 : (w->pixel_height / unit));
790 DEFUN ("window-total-width", Fwindow_total_width, Swindow_total_width, 0, 2, 0,
791 doc: /* Return the total width of window WINDOW in columns.
792 WINDOW must be a valid window and defaults to the selected one.
794 The return value includes the widths of WINDOW's fringes, margins,
795 scroll bars and its right divider, if any. If WINDOW is an internal
796 window, the total width is the width of the screen areas spanned by its
797 children.
799 If WINDOW's pixel width is not an integral multiple of its frame's
800 character width, the number of lines occupied by WINDOW is rounded
801 internally. This is done in a way such that, if WINDOW is a parent
802 window, the sum of the total widths of all its children internally
803 equals the total width of WINDOW.
805 If the optional argument ROUND is `ceiling', return the smallest integer
806 larger than WINDOW's pixel width divided by the character width of
807 WINDOW's frame. ROUND `floor' means to return the largest integer
808 smaller than WINDOW's pixel width divided by the character width of
809 WINDOW's frame. Any other value of ROUND means to return the internal
810 total width of WINDOW. */)
811 (Lisp_Object window, Lisp_Object round)
813 struct window *w = decode_valid_window (window);
815 if (! EQ (round, Qfloor) && ! EQ (round, Qceiling))
816 return make_number (w->total_cols);
817 else
819 int unit = FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w));
821 return make_number (EQ (round, Qceiling)
822 ? ((w->pixel_width + unit - 1) /unit)
823 : (w->pixel_width / unit));
827 DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
828 doc: /* Return the new total size of window WINDOW.
829 WINDOW must be a valid window and defaults to the selected one.
831 The new total size of WINDOW is the value set by the last call of
832 `set-window-new-total' for WINDOW. If it is valid, it will be shortly
833 installed as WINDOW's total height (see `window-total-height') or total
834 width (see `window-total-width'). */)
835 (Lisp_Object window)
837 return decode_valid_window (window)->new_total;
840 DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
841 doc: /* Return the normal height of window WINDOW.
842 WINDOW must be a valid window and defaults to the selected one.
843 If HORIZONTAL is non-nil, return the normal width of WINDOW.
845 The normal height of a frame's root window or a window that is
846 horizontally combined (a window that has a left or right sibling) is
847 1.0. The normal height of a window that is vertically combined (has a
848 sibling above or below) is the fraction of the window's height with
849 respect to its parent. The sum of the normal heights of all windows in a
850 vertical combination equals 1.0.
852 Similarly, the normal width of a frame's root window or a window that is
853 vertically combined equals 1.0. The normal width of a window that is
854 horizontally combined is the fraction of the window's width with respect
855 to its parent. The sum of the normal widths of all windows in a
856 horizontal combination equals 1.0.
858 The normal sizes of windows are used to restore the proportional sizes
859 of windows after they have been shrunk to their minimum sizes; for
860 example when a frame is temporarily made very small and afterwards gets
861 re-enlarged to its previous size. */)
862 (Lisp_Object window, Lisp_Object horizontal)
864 struct window *w = decode_valid_window (window);
866 return NILP (horizontal) ? w->normal_lines : w->normal_cols;
869 DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
870 doc: /* Return new normal size of window WINDOW.
871 WINDOW must be a valid window and defaults to the selected one.
873 The new normal size of WINDOW is the value set by the last call of
874 `set-window-new-normal' for WINDOW. If valid, it will be shortly
875 installed as WINDOW's normal size (see `window-normal-size'). */)
876 (Lisp_Object window)
878 return decode_valid_window (window)->new_normal;
881 DEFUN ("window-new-pixel", Fwindow_new_pixel, Swindow_new_pixel, 0, 1, 0,
882 doc: /* Return new pixel size of window WINDOW.
883 WINDOW must be a valid window and defaults to the selected one.
885 The new pixel size of WINDOW is the value set by the last call of
886 `set-window-new-pixel' for WINDOW. If it is valid, it will be shortly
887 installed as WINDOW's pixel height (see `window-pixel-height') or pixel
888 width (see `window-pixel-width'). */)
889 (Lisp_Object window)
891 return decode_valid_window (window)->new_pixel;
894 DEFUN ("window-pixel-left", Fwindow_pixel_left, Swindow_pixel_left, 0, 1, 0,
895 doc: /* Return left pixel edge of window WINDOW.
896 WINDOW must be a valid window and defaults to the selected one. */)
897 (Lisp_Object window)
899 return make_number (decode_valid_window (window)->pixel_left);
902 DEFUN ("window-pixel-top", Fwindow_pixel_top, Swindow_pixel_top, 0, 1, 0,
903 doc: /* Return top pixel edge of window WINDOW.
904 WINDOW must be a valid window and defaults to the selected one. */)
905 (Lisp_Object window)
907 return make_number (decode_valid_window (window)->pixel_top);
910 DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
911 doc: /* Return left column of window WINDOW.
912 This is the distance, in columns, between the left edge of WINDOW and
913 the left edge of the frame's window area. For instance, the return
914 value is 0 if there is no window to the left of WINDOW.
916 WINDOW must be a valid window and defaults to the selected one. */)
917 (Lisp_Object window)
919 return make_number (decode_valid_window (window)->left_col);
922 DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
923 doc: /* Return top line of window WINDOW.
924 This is the distance, in lines, between the top of WINDOW and the top
925 of the frame's window area. For instance, the return value is 0 if
926 there is no window above WINDOW.
928 WINDOW must be a valid window and defaults to the selected one. */)
929 (Lisp_Object window)
931 return make_number (decode_valid_window (window)->top_line);
934 /* Return the number of lines/pixels of W's body. Don't count any mode
935 or header line or horizontal divider of W. Rounds down to nearest
936 integer when not working pixelwise. */
937 static int
938 window_body_height (struct window *w, bool pixelwise)
940 int height = (w->pixel_height
941 - WINDOW_HEADER_LINE_HEIGHT (w)
942 - (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w)
943 ? WINDOW_SCROLL_BAR_AREA_HEIGHT (w)
944 : 0)
945 - WINDOW_MODE_LINE_HEIGHT (w)
946 - WINDOW_BOTTOM_DIVIDER_WIDTH (w));
948 /* Don't return a negative value. */
949 return max (pixelwise
950 ? height
951 : height / FRAME_LINE_HEIGHT (WINDOW_XFRAME (w)),
955 /* Return the number of columns/pixels of W's body. Don't count columns
956 occupied by the scroll bar or the divider/vertical bar separating W
957 from its right sibling or margins. On window-systems don't count
958 fringes either. Round down to nearest integer when not working
959 pixelwise. */
961 window_body_width (struct window *w, bool pixelwise)
963 struct frame *f = XFRAME (WINDOW_FRAME (w));
965 int width = (w->pixel_width
966 - WINDOW_RIGHT_DIVIDER_WIDTH (w)
967 - (WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
968 ? WINDOW_SCROLL_BAR_AREA_WIDTH (w)
969 : (/* A vertical bar is either 1 or 0. */
970 !FRAME_WINDOW_P (f)
971 && !WINDOW_RIGHTMOST_P (w)
972 && !WINDOW_RIGHT_DIVIDER_WIDTH (w)))
973 - WINDOW_MARGINS_WIDTH (w)
974 - (FRAME_WINDOW_P (f)
975 ? WINDOW_FRINGES_WIDTH (w)
976 : 0));
978 /* Don't return a negative value. */
979 return max (pixelwise
980 ? width
981 : width / FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w)),
985 DEFUN ("window-body-height", Fwindow_body_height, Swindow_body_height, 0, 2, 0,
986 doc: /* Return the height of WINDOW's text area.
987 WINDOW must be a live window and defaults to the selected one. Optional
988 argument PIXELWISE non-nil means return the height of WINDOW's text area
989 in pixels. The return value does not include the mode line or header
990 line or any horizontal divider.
992 If PIXELWISE is nil, return the largest integer smaller than WINDOW's
993 pixel height divided by the character height of WINDOW's frame. This
994 means that if a line at the bottom of the text area is only partially
995 visible, that line is not counted. */)
996 (Lisp_Object window, Lisp_Object pixelwise)
998 return make_number (window_body_height (decode_live_window (window),
999 !NILP (pixelwise)));
1002 DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 2, 0,
1003 doc: /* Return the width of WINDOW's text area.
1004 WINDOW must be a live window and defaults to the selected one. Optional
1005 argument PIXELWISE non-nil means return the width in pixels. The return
1006 value does not include any vertical dividers, fringes or marginal areas,
1007 or scroll bars.
1009 If PIXELWISE is nil, return the largest integer smaller than WINDOW's
1010 pixel width divided by the character width of WINDOW's frame. This
1011 means that if a column at the right of the text area is only partially
1012 visible, that column is not counted.
1014 Note that the returned value includes the column reserved for the
1015 continuation glyph. */)
1016 (Lisp_Object window, Lisp_Object pixelwise)
1018 return make_number (window_body_width (decode_live_window (window),
1019 !NILP (pixelwise)));
1022 DEFUN ("window-mode-line-height", Fwindow_mode_line_height,
1023 Swindow_mode_line_height, 0, 1, 0,
1024 doc: /* Return the height in pixels of WINDOW's mode-line.
1025 WINDOW must be a live window and defaults to the selected one. */)
1026 (Lisp_Object window)
1028 return (make_number (WINDOW_MODE_LINE_HEIGHT (decode_live_window (window))));
1031 DEFUN ("window-header-line-height", Fwindow_header_line_height,
1032 Swindow_header_line_height, 0, 1, 0,
1033 doc: /* Return the height in pixels of WINDOW's header-line.
1034 WINDOW must be a live window and defaults to the selected one. */)
1035 (Lisp_Object window)
1037 return (make_number (WINDOW_HEADER_LINE_HEIGHT (decode_live_window (window))));
1040 DEFUN ("window-right-divider-width", Fwindow_right_divider_width,
1041 Swindow_right_divider_width, 0, 1, 0,
1042 doc: /* Return the width in pixels of WINDOW's right divider.
1043 WINDOW must be a live window and defaults to the selected one. */)
1044 (Lisp_Object window)
1046 return (make_number (WINDOW_RIGHT_DIVIDER_WIDTH (decode_live_window (window))));
1049 DEFUN ("window-bottom-divider-width", Fwindow_bottom_divider_width,
1050 Swindow_bottom_divider_width, 0, 1, 0,
1051 doc: /* Return the width in pixels of WINDOW's bottom divider.
1052 WINDOW must be a live window and defaults to the selected one. */)
1053 (Lisp_Object window)
1055 return (make_number (WINDOW_BOTTOM_DIVIDER_WIDTH (decode_live_window (window))));
1058 DEFUN ("window-scroll-bar-width", Fwindow_scroll_bar_width,
1059 Swindow_scroll_bar_width, 0, 1, 0,
1060 doc: /* Return the width in pixels of WINDOW's vertical scrollbar.
1061 WINDOW must be a live window and defaults to the selected one. */)
1062 (Lisp_Object window)
1064 return (make_number (WINDOW_SCROLL_BAR_AREA_WIDTH (decode_live_window (window))));
1067 DEFUN ("window-scroll-bar-height", Fwindow_scroll_bar_height,
1068 Swindow_scroll_bar_height, 0, 1, 0,
1069 doc: /* Return the height in pixels of WINDOW's horizontal scrollbar.
1070 WINDOW must be a live window and defaults to the selected one. */)
1071 (Lisp_Object window)
1073 return (make_number (WINDOW_SCROLL_BAR_AREA_HEIGHT (decode_live_window (window))));
1076 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
1077 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
1078 WINDOW must be a live window and defaults to the selected one. */)
1079 (Lisp_Object window)
1081 return make_number (decode_live_window (window)->hscroll);
1084 /* Set W's horizontal scroll amount to HSCROLL clipped to a reasonable
1085 range, returning the new amount as a fixnum. */
1086 static Lisp_Object
1087 set_window_hscroll (struct window *w, EMACS_INT hscroll)
1089 /* Horizontal scrolling has problems with large scroll amounts.
1090 It's too slow with long lines, and even with small lines the
1091 display can be messed up. For now, though, impose only the limits
1092 required by the internal representation: horizontal scrolling must
1093 fit in fixnum (since it's visible to Elisp) and into ptrdiff_t
1094 (since it's stored in a ptrdiff_t). */
1095 ptrdiff_t hscroll_max = min (MOST_POSITIVE_FIXNUM, PTRDIFF_MAX);
1096 ptrdiff_t new_hscroll = clip_to_bounds (0, hscroll, hscroll_max);
1098 /* Prevent redisplay shortcuts when changing the hscroll. */
1099 if (w->hscroll != new_hscroll)
1100 XBUFFER (w->contents)->prevent_redisplay_optimizations_p = true;
1102 w->hscroll = new_hscroll;
1103 w->suspend_auto_hscroll = true;
1105 return make_number (new_hscroll);
1108 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
1109 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
1110 WINDOW must be a live window and defaults to the selected one.
1111 Clip the number to a reasonable value if out of range.
1112 Return the new number. NCOL should be zero or positive.
1114 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
1115 window so that the location of point moves off-window. */)
1116 (Lisp_Object window, Lisp_Object ncol)
1118 CHECK_NUMBER (ncol);
1119 return set_window_hscroll (decode_live_window (window), XINT (ncol));
1122 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
1123 Swindow_redisplay_end_trigger, 0, 1, 0,
1124 doc: /* Return WINDOW's redisplay end trigger value.
1125 WINDOW must be a live window and defaults to the selected one.
1126 See `set-window-redisplay-end-trigger' for more information. */)
1127 (Lisp_Object window)
1129 return decode_live_window (window)->redisplay_end_trigger;
1132 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
1133 Sset_window_redisplay_end_trigger, 2, 2, 0,
1134 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
1135 WINDOW must be a live window and defaults to the selected one. VALUE
1136 should be a buffer position (typically a marker) or nil. If it is a
1137 buffer position, then if redisplay in WINDOW reaches a position beyond
1138 VALUE, the functions in `redisplay-end-trigger-functions' are called
1139 with two arguments: WINDOW, and the end trigger value. Afterwards the
1140 end-trigger value is reset to nil. */)
1141 (register Lisp_Object window, Lisp_Object value)
1143 wset_redisplay_end_trigger (decode_live_window (window), value);
1144 return value;
1147 /* Test if the character at column X, row Y is within window W.
1148 If it is not, return ON_NOTHING;
1149 if it is on the window's vertical divider, return
1150 ON_RIGHT_DIVIDER;
1151 if it is on the window's horizontal divider, return
1152 ON_BOTTOM_DIVIDER;
1153 if it is in the window's text area, return ON_TEXT;
1154 if it is on the window's modeline, return ON_MODE_LINE;
1155 if it is on the border between the window and its right sibling,
1156 return ON_VERTICAL_BORDER;
1157 if it is on a scroll bar, return ON_SCROLL_BAR;
1158 if it is on the window's top line, return ON_HEADER_LINE;
1159 if it is in left or right fringe of the window,
1160 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
1161 if it is in the marginal area to the left/right of the window,
1162 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
1164 X and Y are frame relative pixel coordinates. */
1166 static enum window_part
1167 coordinates_in_window (register struct window *w, int x, int y)
1169 struct frame *f = XFRAME (WINDOW_FRAME (w));
1170 enum window_part part;
1171 int ux = FRAME_COLUMN_WIDTH (f);
1172 int left_x = WINDOW_LEFT_EDGE_X (w);
1173 int right_x = WINDOW_RIGHT_EDGE_X (w);
1174 int top_y = WINDOW_TOP_EDGE_Y (w);
1175 int bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
1176 /* The width of the area where the vertical line can be dragged.
1177 (Between mode lines for instance. */
1178 int grabbable_width = ux;
1179 int lmargin_width, rmargin_width, text_left, text_right;
1181 /* Outside any interesting row or column? */
1182 if (y < top_y || y >= bottom_y || x < left_x || x >= right_x)
1183 return ON_NOTHING;
1185 /* On the horizontal window divider (which prevails the vertical
1186 divider)? */
1187 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w) > 0
1188 && y >= (bottom_y - WINDOW_BOTTOM_DIVIDER_WIDTH (w))
1189 && y <= bottom_y)
1190 return ON_BOTTOM_DIVIDER;
1191 /* On vertical window divider? */
1192 else if (!WINDOW_RIGHTMOST_P (w)
1193 && WINDOW_RIGHT_DIVIDER_WIDTH (w) > 0
1194 && x >= right_x - WINDOW_RIGHT_DIVIDER_WIDTH (w)
1195 && x <= right_x)
1196 return ON_RIGHT_DIVIDER;
1197 /* On the horizontal scroll bar? (Including the empty space at its
1198 right!) */
1199 else if ((WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w)
1200 && y >= (bottom_y
1201 - WINDOW_SCROLL_BAR_AREA_HEIGHT (w)
1202 - CURRENT_MODE_LINE_HEIGHT (w)
1203 - WINDOW_BOTTOM_DIVIDER_WIDTH (w))
1204 && y <= (bottom_y
1205 - CURRENT_MODE_LINE_HEIGHT (w)
1206 - WINDOW_BOTTOM_DIVIDER_WIDTH (w))))
1207 return ON_HORIZONTAL_SCROLL_BAR;
1208 /* On the mode or header line? */
1209 else if ((WINDOW_WANTS_MODELINE_P (w)
1210 && y >= (bottom_y
1211 - CURRENT_MODE_LINE_HEIGHT (w)
1212 - WINDOW_BOTTOM_DIVIDER_WIDTH (w))
1213 && y <= bottom_y - WINDOW_BOTTOM_DIVIDER_WIDTH (w)
1214 && (part = ON_MODE_LINE))
1215 || (WINDOW_WANTS_HEADER_LINE_P (w)
1216 && y < top_y + CURRENT_HEADER_LINE_HEIGHT (w)
1217 && (part = ON_HEADER_LINE)))
1219 /* If it's under/over the scroll bar portion of the mode/header
1220 line, say it's on the vertical line. That's to be able to
1221 resize windows horizontally in case we're using toolkit scroll
1222 bars. Note: If scrollbars are on the left, the window that
1223 must be eventually resized is that on the left of WINDOW. */
1224 if ((WINDOW_RIGHT_DIVIDER_WIDTH (w) == 0)
1225 && ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
1226 && !WINDOW_LEFTMOST_P (w)
1227 && eabs (x - left_x) < grabbable_width)
1228 || (!WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
1229 && !WINDOW_RIGHTMOST_P (w)
1230 && eabs (x - right_x) < grabbable_width)))
1231 return ON_VERTICAL_BORDER;
1232 else
1233 return part;
1236 /* In what's below, we subtract 1 when computing right_x because we
1237 want the rightmost pixel, which is given by left_pixel+width-1. */
1238 if (w->pseudo_window_p)
1240 left_x = 0;
1241 right_x = WINDOW_PIXEL_WIDTH (w) - 1;
1243 else
1245 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
1246 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
1249 /* Outside any interesting column? */
1250 if (x < left_x || x > right_x)
1251 return ON_VERTICAL_SCROLL_BAR;
1253 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
1254 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
1256 text_left = window_box_left (w, TEXT_AREA);
1257 text_right = text_left + window_box_width (w, TEXT_AREA);
1259 if (FRAME_WINDOW_P (f))
1261 if (!w->pseudo_window_p
1262 && WINDOW_RIGHT_DIVIDER_WIDTH (w) == 0
1263 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
1264 && !WINDOW_RIGHTMOST_P (w)
1265 && (eabs (x - right_x) < grabbable_width))
1266 return ON_VERTICAL_BORDER;
1268 /* Need to say "x > right_x" rather than >=, since on character
1269 terminals, the vertical line's x coordinate is right_x. */
1270 else if (!w->pseudo_window_p
1271 && WINDOW_RIGHT_DIVIDER_WIDTH (w) == 0
1272 && !WINDOW_RIGHTMOST_P (w)
1273 /* Why check ux if we are not the rightmost window? Also
1274 shouldn't a pseudo window always be rightmost? */
1275 && x > right_x - ux)
1276 return ON_VERTICAL_BORDER;
1278 if (x < text_left)
1280 if (lmargin_width > 0
1281 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1282 ? (x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
1283 : (x < left_x + lmargin_width)))
1284 return ON_LEFT_MARGIN;
1285 else
1286 return ON_LEFT_FRINGE;
1289 if (x >= text_right)
1291 if (rmargin_width > 0
1292 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1293 ? (x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
1294 : (x >= right_x - rmargin_width)))
1295 return ON_RIGHT_MARGIN;
1296 else
1297 return ON_RIGHT_FRINGE;
1300 /* Everything special ruled out - must be on text area */
1301 return ON_TEXT;
1304 /* Take X is the frame-relative pixel x-coordinate, and return the
1305 x-coordinate relative to part PART of window W. */
1307 window_relative_x_coord (struct window *w, enum window_part part, int x)
1309 int left_x = (w->pseudo_window_p) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w);
1311 switch (part)
1313 case ON_TEXT:
1314 return x - window_box_left (w, TEXT_AREA);
1316 case ON_HEADER_LINE:
1317 case ON_MODE_LINE:
1318 case ON_LEFT_FRINGE:
1319 return x - left_x;
1321 case ON_RIGHT_FRINGE:
1322 return x - left_x - WINDOW_LEFT_FRINGE_WIDTH (w);
1324 case ON_LEFT_MARGIN:
1325 return (x - left_x
1326 - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1327 ? WINDOW_LEFT_FRINGE_WIDTH (w) : 0));
1329 case ON_RIGHT_MARGIN:
1330 return (x + 1
1331 - ((w->pseudo_window_p)
1332 ? WINDOW_PIXEL_WIDTH (w)
1333 : WINDOW_BOX_RIGHT_EDGE_X (w))
1334 + window_box_width (w, RIGHT_MARGIN_AREA)
1335 + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1336 ? WINDOW_RIGHT_FRINGE_WIDTH (w) : 0));
1338 case ON_NOTHING:
1339 case ON_VERTICAL_BORDER:
1340 case ON_VERTICAL_SCROLL_BAR:
1341 case ON_HORIZONTAL_SCROLL_BAR:
1342 case ON_RIGHT_DIVIDER:
1343 case ON_BOTTOM_DIVIDER:
1344 return 0;
1346 default:
1347 emacs_abort ();
1352 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
1353 Scoordinates_in_window_p, 2, 2, 0,
1354 doc: /* Return non-nil if COORDINATES are in WINDOW.
1355 WINDOW must be a live window and defaults to the selected one.
1356 COORDINATES is a cons of the form (X . Y), X and Y being distances
1357 measured in characters from the upper-left corner of the frame.
1358 \(0 . 0) denotes the character in the upper left corner of the
1359 frame.
1360 If COORDINATES are in the text portion of WINDOW,
1361 the coordinates relative to the window are returned.
1362 If they are in the bottom divider of WINDOW, `bottom-divider' is returned.
1363 If they are in the right divider of WINDOW, `right-divider' is returned.
1364 If they are in the mode line of WINDOW, `mode-line' is returned.
1365 If they are in the header line of WINDOW, `header-line' is returned.
1366 If they are in the left fringe of WINDOW, `left-fringe' is returned.
1367 If they are in the right fringe of WINDOW, `right-fringe' is returned.
1368 If they are on the border between WINDOW and its right sibling,
1369 `vertical-line' is returned.
1370 If they are in the windows's left or right marginal areas, `left-margin'\n\
1371 or `right-margin' is returned. */)
1372 (register Lisp_Object coordinates, Lisp_Object window)
1374 struct window *w;
1375 struct frame *f;
1376 int x, y;
1377 Lisp_Object lx, ly;
1379 w = decode_live_window (window);
1380 f = XFRAME (w->frame);
1381 CHECK_CONS (coordinates);
1382 lx = Fcar (coordinates);
1383 ly = Fcdr (coordinates);
1384 CHECK_NUMBER_OR_FLOAT (lx);
1385 CHECK_NUMBER_OR_FLOAT (ly);
1386 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
1387 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
1389 switch (coordinates_in_window (w, x, y))
1391 case ON_NOTHING:
1392 return Qnil;
1394 case ON_TEXT:
1395 /* Convert X and Y to window relative pixel coordinates, and
1396 return the canonical char units. */
1397 x -= window_box_left (w, TEXT_AREA);
1398 y -= WINDOW_TOP_EDGE_Y (w);
1399 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
1400 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
1402 case ON_MODE_LINE:
1403 return Qmode_line;
1405 case ON_VERTICAL_BORDER:
1406 return Qvertical_line;
1408 case ON_HEADER_LINE:
1409 return Qheader_line;
1411 case ON_LEFT_FRINGE:
1412 return Qleft_fringe;
1414 case ON_RIGHT_FRINGE:
1415 return Qright_fringe;
1417 case ON_LEFT_MARGIN:
1418 return Qleft_margin;
1420 case ON_RIGHT_MARGIN:
1421 return Qright_margin;
1423 case ON_VERTICAL_SCROLL_BAR:
1424 /* Historically we are supposed to return nil in this case. */
1425 return Qnil;
1427 case ON_HORIZONTAL_SCROLL_BAR:
1428 return Qnil;
1430 case ON_RIGHT_DIVIDER:
1431 return Qright_divider;
1433 case ON_BOTTOM_DIVIDER:
1434 return Qbottom_divider;
1436 default:
1437 emacs_abort ();
1442 /* Callback for foreach_window, used in window_from_coordinates.
1443 Check if window W contains coordinates specified by USER_DATA which
1444 is actually a pointer to a struct check_window_data CW.
1446 Check if window W contains coordinates *CW->x and *CW->y. If it
1447 does, return W in *CW->window, as Lisp_Object, and return in
1448 *CW->part the part of the window under coordinates *X,*Y. Return
1449 false from this function to stop iterating over windows. */
1451 struct check_window_data
1453 Lisp_Object *window;
1454 int x, y;
1455 enum window_part *part;
1458 static bool
1459 check_window_containing (struct window *w, void *user_data)
1461 struct check_window_data *cw = user_data;
1462 enum window_part found = coordinates_in_window (w, cw->x, cw->y);
1463 if (found == ON_NOTHING)
1464 return true;
1465 else
1467 *cw->part = found;
1468 XSETWINDOW (*cw->window, w);
1469 return false;
1474 /* Find the window containing frame-relative pixel position X/Y and
1475 return it as a Lisp_Object.
1477 If X, Y is on one of the window's special `window_part' elements,
1478 set *PART to the id of that element.
1480 If there is no window under X, Y return nil and leave *PART
1481 unmodified. TOOL_BAR_P means detect tool-bar windows.
1483 This function was previously implemented with a loop cycling over
1484 windows with Fnext_window, and starting with the frame's selected
1485 window. It turned out that this doesn't work with an
1486 implementation of next_window using Vwindow_list, because
1487 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1488 tree of F when this function is called asynchronously from
1489 note_mouse_highlight. The original loop didn't terminate in this
1490 case. */
1492 Lisp_Object
1493 window_from_coordinates (struct frame *f, int x, int y,
1494 enum window_part *part, bool tool_bar_p)
1496 Lisp_Object window;
1497 struct check_window_data cw;
1498 enum window_part dummy;
1500 if (part == 0)
1501 part = &dummy;
1503 window = Qnil;
1504 cw.window = &window, cw.x = x, cw.y = y; cw.part = part;
1505 foreach_window (f, check_window_containing, &cw);
1507 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
1508 /* If not found above, see if it's in the tool bar window, if a tool
1509 bar exists. */
1510 if (NILP (window)
1511 && tool_bar_p
1512 && WINDOWP (f->tool_bar_window)
1513 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1514 && (coordinates_in_window (XWINDOW (f->tool_bar_window), x, y)
1515 != ON_NOTHING))
1517 *part = ON_TEXT;
1518 window = f->tool_bar_window;
1520 #endif
1522 return window;
1525 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1526 doc: /* Return window containing coordinates X and Y on FRAME.
1527 FRAME must be a live frame and defaults to the selected one.
1528 The top left corner of the frame is considered to be row 0,
1529 column 0. */)
1530 (Lisp_Object x, Lisp_Object y, Lisp_Object frame)
1532 struct frame *f = decode_live_frame (frame);
1534 /* Check that arguments are integers or floats. */
1535 CHECK_NUMBER_OR_FLOAT (x);
1536 CHECK_NUMBER_OR_FLOAT (y);
1538 return window_from_coordinates (f,
1539 (FRAME_PIXEL_X_FROM_CANON_X (f, x)
1540 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1541 (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
1542 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1543 0, false);
1546 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1547 doc: /* Return current value of point in WINDOW.
1548 WINDOW must be a live window and defaults to the selected one.
1550 For a nonselected window, this is the value point would have if that
1551 window were selected.
1553 Note that, when WINDOW is selected, the value returned is the same as
1554 that returned by `point' for WINDOW's buffer. It would be more strictly
1555 correct to return the top-level value of `point', outside of any
1556 `save-excursion' forms. But that is hard to define. */)
1557 (Lisp_Object window)
1559 register struct window *w = decode_live_window (window);
1561 if (w == XWINDOW (selected_window))
1562 return make_number (BUF_PT (XBUFFER (w->contents)));
1563 else
1564 return Fmarker_position (w->pointm);
1567 DEFUN ("window-old-point", Fwindow_old_point, Swindow_old_point, 0, 1, 0,
1568 doc: /* Return old value of point in WINDOW.
1569 WINDOW must be a live window and defaults to the selected one. */)
1570 (Lisp_Object window)
1572 return Fmarker_position (decode_live_window (window)->old_pointm);
1575 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1576 doc: /* Return position at which display currently starts in WINDOW.
1577 WINDOW must be a live window and defaults to the selected one.
1578 This is updated by redisplay or by calling `set-window-start'. */)
1579 (Lisp_Object window)
1581 return Fmarker_position (decode_live_window (window)->start);
1584 /* This is text temporarily removed from the doc string below.
1586 This function returns nil if the position is not currently known.
1587 That happens when redisplay is preempted and doesn't finish.
1588 If in that case you want to compute where the end of the window would
1589 have been if redisplay had finished, do this:
1590 (save-excursion
1591 (goto-char (window-start window))
1592 (vertical-motion (1- (window-height window)) window)
1593 (point))") */
1595 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1596 doc: /* Return position at which display currently ends in WINDOW.
1597 WINDOW must be a live window and defaults to the selected one.
1598 This is updated by redisplay, when it runs to completion.
1599 Simply changing the buffer text or setting `window-start'
1600 does not update this value.
1601 Return nil if there is no recorded value. (This can happen if the
1602 last redisplay of WINDOW was preempted, and did not finish.)
1603 If UPDATE is non-nil, compute the up-to-date position
1604 if it isn't already recorded. */)
1605 (Lisp_Object window, Lisp_Object update)
1607 Lisp_Object value;
1608 struct window *w = decode_live_window (window);
1609 Lisp_Object buf;
1610 struct buffer *b;
1612 buf = w->contents;
1613 CHECK_BUFFER (buf);
1614 b = XBUFFER (buf);
1616 if (! NILP (update)
1617 && (windows_or_buffers_changed
1618 || !w->window_end_valid
1619 || b->clip_changed
1620 || b->prevent_redisplay_optimizations_p
1621 || window_outdated (w))
1622 /* Don't call display routines if we didn't yet create any real
1623 frames, because the glyph matrices are not yet allocated in
1624 that case. This could happen in some code that runs in the
1625 daemon during initialization (e.g., see bug#20565). */
1626 && !(noninteractive || FRAME_INITIAL_P (WINDOW_XFRAME (w))))
1628 struct text_pos startp;
1629 struct it it;
1630 struct buffer *old_buffer = NULL;
1631 void *itdata = NULL;
1633 /* Cannot use Fvertical_motion because that function doesn't
1634 cope with variable-height lines. */
1635 if (b != current_buffer)
1637 old_buffer = current_buffer;
1638 set_buffer_internal (b);
1641 /* In case W->start is out of the range, use something
1642 reasonable. This situation occurred when loading a file with
1643 `-l' containing a call to `rmail' with subsequent other
1644 commands. At the end, W->start happened to be BEG, while
1645 rmail had already narrowed the buffer. */
1646 CLIP_TEXT_POS_FROM_MARKER (startp, w->start);
1648 itdata = bidi_shelve_cache ();
1649 start_display (&it, w, startp);
1650 move_it_vertically (&it, window_box_height (w));
1651 if (it.current_y < it.last_visible_y)
1652 move_it_past_eol (&it);
1653 value = make_number (IT_CHARPOS (it));
1654 bidi_unshelve_cache (itdata, false);
1656 if (old_buffer)
1657 set_buffer_internal (old_buffer);
1659 else
1660 XSETINT (value, BUF_Z (b) - w->window_end_pos);
1662 return value;
1665 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1666 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1667 WINDOW must be a live window and defaults to the selected one.
1668 Return POS. */)
1669 (Lisp_Object window, Lisp_Object pos)
1671 register struct window *w = decode_live_window (window);
1673 /* Type of POS is checked by Fgoto_char or set_marker_restricted ... */
1675 if (w == XWINDOW (selected_window))
1677 if (XBUFFER (w->contents) == current_buffer)
1678 Fgoto_char (pos);
1679 else
1681 struct buffer *old_buffer = current_buffer;
1683 /* ... but here we want to catch type error before buffer change. */
1684 CHECK_NUMBER_COERCE_MARKER (pos);
1685 set_buffer_internal (XBUFFER (w->contents));
1686 Fgoto_char (pos);
1687 set_buffer_internal (old_buffer);
1690 else
1692 set_marker_restricted (w->pointm, pos, w->contents);
1693 /* We have to make sure that redisplay updates the window to show
1694 the new value of point. */
1695 wset_redisplay (w);
1698 return pos;
1701 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1702 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1703 WINDOW must be a live window and defaults to the selected one. Return
1704 POS. Optional third arg NOFORCE non-nil inhibits next redisplay from
1705 overriding motion of point in order to display at this exact start. */)
1706 (Lisp_Object window, Lisp_Object pos, Lisp_Object noforce)
1708 register struct window *w = decode_live_window (window);
1710 set_marker_restricted (w->start, pos, w->contents);
1711 /* This is not right, but much easier than doing what is right. */
1712 w->start_at_line_beg = false;
1713 if (NILP (noforce))
1714 w->force_start = true;
1715 wset_update_mode_line (w);
1716 /* Bug#15957. */
1717 w->window_end_valid = false;
1718 wset_redisplay (w);
1720 return pos;
1723 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
1724 Spos_visible_in_window_p, 0, 3, 0,
1725 doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
1726 WINDOW must be a live window and defaults to the selected one.
1728 Return nil if that position is scrolled vertically out of view. If a
1729 character is only partially visible, nil is returned, unless the
1730 optional argument PARTIALLY is non-nil. If POS is only out of view
1731 because of horizontal scrolling, return non-nil. If POS is t, it
1732 specifies either the first position displayed on the last visible
1733 screen line in WINDOW, or the end-of-buffer position, whichever comes
1734 first. POS defaults to point in WINDOW; WINDOW defaults to the
1735 selected window.
1737 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
1738 the return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
1739 where X and Y are the pixel coordinates relative to the top left corner
1740 of the window. The remaining elements are omitted if the character after
1741 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
1742 off-window at the top and bottom of the screen line ("row") containing
1743 POS, ROWH is the visible height of that row, and VPOS is the row number
1744 \(zero-based). */)
1745 (Lisp_Object pos, Lisp_Object window, Lisp_Object partially)
1747 struct window *w;
1748 EMACS_INT posint;
1749 struct buffer *buf;
1750 struct text_pos top;
1751 Lisp_Object in_window = Qnil;
1752 int rtop, rbot, rowh, vpos;
1753 bool fully_p = true;
1754 int x, y;
1756 w = decode_live_window (window);
1757 buf = XBUFFER (w->contents);
1758 SET_TEXT_POS_FROM_MARKER (top, w->start);
1760 if (EQ (pos, Qt))
1761 posint = -1;
1762 else if (!NILP (pos))
1764 CHECK_NUMBER_COERCE_MARKER (pos);
1765 posint = XINT (pos);
1767 else if (w == XWINDOW (selected_window))
1768 posint = PT;
1769 else
1770 posint = marker_position (w->pointm);
1772 /* If position is above window start or outside buffer boundaries,
1773 or if window start is out of range, position is not visible. */
1774 if ((EQ (pos, Qt)
1775 || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
1776 && CHARPOS (top) >= BUF_BEGV (buf)
1777 && CHARPOS (top) <= BUF_ZV (buf)
1778 && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos))
1780 fully_p = !rtop && !rbot;
1781 if (!NILP (partially) || fully_p)
1782 in_window = Qt;
1785 if (!NILP (in_window) && !NILP (partially))
1787 Lisp_Object part = Qnil;
1788 if (!fully_p)
1789 part = list4i (rtop, rbot, rowh, vpos);
1790 in_window = Fcons (make_number (x),
1791 Fcons (make_number (y), part));
1794 return in_window;
1797 DEFUN ("window-line-height", Fwindow_line_height,
1798 Swindow_line_height, 0, 2, 0,
1799 doc: /* Return height in pixels of text line LINE in window WINDOW.
1800 WINDOW must be a live window and defaults to the selected one.
1802 Return height of current line if LINE is omitted or nil. Return height of
1803 header or mode line if LINE is `header-line' or `mode-line'.
1804 Otherwise, LINE is a text line number starting from 0. A negative number
1805 counts from the end of the window.
1807 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
1808 in pixels of the visible part of the line, VPOS and YPOS are the
1809 vertical position in lines and pixels of the line, relative to the top
1810 of the first text line, and OFFBOT is the number of off-window pixels at
1811 the bottom of the text line. If there are off-window pixels at the top
1812 of the (first) text line, YPOS is negative.
1814 Return nil if window display is not up-to-date. In that case, use
1815 `pos-visible-in-window-p' to obtain the information. */)
1816 (Lisp_Object line, Lisp_Object window)
1818 register struct window *w;
1819 register struct buffer *b;
1820 struct glyph_row *row, *end_row;
1821 int max_y, crop, i;
1822 EMACS_INT n;
1824 w = decode_live_window (window);
1826 if (noninteractive || w->pseudo_window_p)
1827 return Qnil;
1829 CHECK_BUFFER (w->contents);
1830 b = XBUFFER (w->contents);
1832 /* Fail if current matrix is not up-to-date. */
1833 if (!w->window_end_valid
1834 || windows_or_buffers_changed
1835 || b->clip_changed
1836 || b->prevent_redisplay_optimizations_p
1837 || window_outdated (w))
1838 return Qnil;
1840 if (NILP (line))
1842 i = w->cursor.vpos;
1843 if (i < 0 || i >= w->current_matrix->nrows
1844 || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
1845 return Qnil;
1846 max_y = window_text_bottom_y (w);
1847 goto found_row;
1850 if (EQ (line, Qheader_line))
1852 if (!WINDOW_WANTS_HEADER_LINE_P (w))
1853 return Qnil;
1854 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
1855 return row->enabled_p ? list4i (row->height, 0, 0, 0) : Qnil;
1858 if (EQ (line, Qmode_line))
1860 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
1861 return (row->enabled_p ?
1862 list4i (row->height,
1863 0, /* not accurate */
1864 (WINDOW_HEADER_LINE_HEIGHT (w)
1865 + window_text_bottom_y (w)),
1867 : Qnil);
1870 CHECK_NUMBER (line);
1871 n = XINT (line);
1873 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
1874 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
1875 max_y = window_text_bottom_y (w);
1876 i = 0;
1878 while ((n < 0 || i < n)
1879 && row <= end_row && row->enabled_p
1880 && row->y + row->height < max_y)
1881 row++, i++;
1883 if (row > end_row || !row->enabled_p)
1884 return Qnil;
1886 if (++n < 0)
1888 if (-n > i)
1889 return Qnil;
1890 row += n;
1891 i += n;
1894 found_row:
1895 crop = max (0, (row->y + row->height) - max_y);
1896 return list4i (row->height + min (0, row->y) - crop, i, row->y, crop);
1899 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1900 0, 1, 0,
1901 doc: /* Return non-nil when WINDOW is dedicated to its buffer.
1902 More precisely, return the value assigned by the last call of
1903 `set-window-dedicated-p' for WINDOW. Return nil if that function was
1904 never called with WINDOW as its argument, or the value set by that
1905 function was internally reset since its last call. WINDOW must be a
1906 live window and defaults to the selected one.
1908 When a window is dedicated to its buffer, `display-buffer' will refrain
1909 from displaying another buffer in it. `get-lru-window' and
1910 `get-largest-window' treat dedicated windows specially.
1911 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1912 `kill-buffer' can delete a dedicated window and the containing frame.
1914 Functions like `set-window-buffer' may change the buffer displayed by a
1915 window, unless that window is "strongly" dedicated to its buffer, that
1916 is the value returned by `window-dedicated-p' is t. */)
1917 (Lisp_Object window)
1919 return decode_live_window (window)->dedicated;
1922 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1923 Sset_window_dedicated_p, 2, 2, 0,
1924 doc: /* Mark WINDOW as dedicated according to FLAG.
1925 WINDOW must be a live window and defaults to the selected one. FLAG
1926 non-nil means mark WINDOW as dedicated to its buffer. FLAG nil means
1927 mark WINDOW as non-dedicated. Return FLAG.
1929 When a window is dedicated to its buffer, `display-buffer' will refrain
1930 from displaying another buffer in it. `get-lru-window' and
1931 `get-largest-window' treat dedicated windows specially.
1932 `delete-windows-on', `replace-buffer-in-windows', `quit-window',
1933 `quit-restore-window' and `kill-buffer' can delete a dedicated window
1934 and the containing frame.
1936 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
1937 its buffer. Functions like `set-window-buffer' may change the buffer
1938 displayed by a window, unless that window is strongly dedicated to its
1939 buffer. If and when `set-window-buffer' displays another buffer in a
1940 window, it also makes sure that the window is no more dedicated. */)
1941 (Lisp_Object window, Lisp_Object flag)
1943 wset_dedicated (decode_live_window (window), flag);
1944 return flag;
1947 DEFUN ("window-prev-buffers", Fwindow_prev_buffers, Swindow_prev_buffers,
1948 0, 1, 0,
1949 doc: /* Return buffers previously shown in WINDOW.
1950 WINDOW must be a live window and defaults to the selected one.
1952 The return value is a list of elements (BUFFER WINDOW-START POS),
1953 where BUFFER is a buffer, WINDOW-START is the start position of the
1954 window for that buffer, and POS is a window-specific point value. */)
1955 (Lisp_Object window)
1957 return decode_live_window (window)->prev_buffers;
1960 DEFUN ("set-window-prev-buffers", Fset_window_prev_buffers,
1961 Sset_window_prev_buffers, 2, 2, 0,
1962 doc: /* Set WINDOW's previous buffers to PREV-BUFFERS.
1963 WINDOW must be a live window and defaults to the selected one.
1965 PREV-BUFFERS should be a list of elements (BUFFER WINDOW-START POS),
1966 where BUFFER is a buffer, WINDOW-START is the start position of the
1967 window for that buffer, and POS is a window-specific point value. */)
1968 (Lisp_Object window, Lisp_Object prev_buffers)
1970 wset_prev_buffers (decode_live_window (window), prev_buffers);
1971 return prev_buffers;
1974 DEFUN ("window-next-buffers", Fwindow_next_buffers, Swindow_next_buffers,
1975 0, 1, 0,
1976 doc: /* Return list of buffers recently re-shown in WINDOW.
1977 WINDOW must be a live window and defaults to the selected one. */)
1978 (Lisp_Object window)
1980 return decode_live_window (window)->next_buffers;
1983 DEFUN ("set-window-next-buffers", Fset_window_next_buffers,
1984 Sset_window_next_buffers, 2, 2, 0,
1985 doc: /* Set WINDOW's next buffers to NEXT-BUFFERS.
1986 WINDOW must be a live window and defaults to the selected one.
1987 NEXT-BUFFERS should be a list of buffers. */)
1988 (Lisp_Object window, Lisp_Object next_buffers)
1990 wset_next_buffers (decode_live_window (window), next_buffers);
1991 return next_buffers;
1994 DEFUN ("window-parameters", Fwindow_parameters, Swindow_parameters,
1995 0, 1, 0,
1996 doc: /* Return the parameters of WINDOW and their values.
1997 WINDOW must be a valid window and defaults to the selected one. The
1998 return value is a list of elements of the form (PARAMETER . VALUE). */)
1999 (Lisp_Object window)
2001 return Fcopy_alist (decode_valid_window (window)->window_parameters);
2004 DEFUN ("window-parameter", Fwindow_parameter, Swindow_parameter,
2005 2, 2, 0,
2006 doc: /* Return WINDOW's value for PARAMETER.
2007 WINDOW can be any window and defaults to the selected one. */)
2008 (Lisp_Object window, Lisp_Object parameter)
2010 Lisp_Object result;
2012 result = Fassq (parameter, decode_any_window (window)->window_parameters);
2013 return CDR_SAFE (result);
2016 DEFUN ("set-window-parameter", Fset_window_parameter,
2017 Sset_window_parameter, 3, 3, 0,
2018 doc: /* Set WINDOW's value of PARAMETER to VALUE.
2019 WINDOW can be any window and defaults to the selected one.
2020 Return VALUE. */)
2021 (Lisp_Object window, Lisp_Object parameter, Lisp_Object value)
2023 register struct window *w = decode_any_window (window);
2024 Lisp_Object old_alist_elt;
2026 old_alist_elt = Fassq (parameter, w->window_parameters);
2027 if (NILP (old_alist_elt))
2028 wset_window_parameters
2029 (w, Fcons (Fcons (parameter, value), w->window_parameters));
2030 else
2031 Fsetcdr (old_alist_elt, value);
2032 return value;
2035 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
2036 0, 1, 0,
2037 doc: /* Return the display-table that WINDOW is using.
2038 WINDOW must be a live window and defaults to the selected one. */)
2039 (Lisp_Object window)
2041 return decode_live_window (window)->display_table;
2044 /* Get the display table for use on window W. This is either W's
2045 display table or W's buffer's display table. Ignore the specified
2046 tables if they are not valid; if no valid table is specified,
2047 return 0. */
2049 struct Lisp_Char_Table *
2050 window_display_table (struct window *w)
2052 struct Lisp_Char_Table *dp = NULL;
2054 if (DISP_TABLE_P (w->display_table))
2055 dp = XCHAR_TABLE (w->display_table);
2056 else if (BUFFERP (w->contents))
2058 struct buffer *b = XBUFFER (w->contents);
2060 if (DISP_TABLE_P (BVAR (b, display_table)))
2061 dp = XCHAR_TABLE (BVAR (b, display_table));
2062 else if (DISP_TABLE_P (Vstandard_display_table))
2063 dp = XCHAR_TABLE (Vstandard_display_table);
2066 return dp;
2069 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
2070 doc: /* Set WINDOW's display-table to TABLE.
2071 WINDOW must be a live window and defaults to the selected one. */)
2072 (register Lisp_Object window, Lisp_Object table)
2074 wset_display_table (decode_live_window (window), table);
2075 return table;
2078 /* Record info on buffer window W is displaying
2079 when it is about to cease to display that buffer. */
2080 static void
2081 unshow_buffer (register struct window *w)
2083 Lisp_Object buf = w->contents;
2084 struct buffer *b = XBUFFER (buf);
2086 eassert (b == XMARKER (w->pointm)->buffer);
2088 #if false
2089 if (w == XWINDOW (selected_window)
2090 || ! EQ (buf, XWINDOW (selected_window)->contents))
2091 /* Do this except when the selected window's buffer
2092 is being removed from some other window. */
2093 #endif
2094 /* last_window_start records the start position that this buffer
2095 had in the last window to be disconnected from it.
2096 Now that this statement is unconditional,
2097 it is possible for the buffer to be displayed in the
2098 selected window, while last_window_start reflects another
2099 window which was recently showing the same buffer.
2100 Some people might say that might be a good thing. Let's see. */
2101 b->last_window_start = marker_position (w->start);
2103 /* Point in the selected window's buffer
2104 is actually stored in that buffer, and the window's pointm isn't used.
2105 So don't clobber point in that buffer. */
2106 if (! EQ (buf, XWINDOW (selected_window)->contents)
2107 /* Don't clobber point in current buffer either (this could be
2108 useful in connection with bug#12208).
2109 && XBUFFER (buf) != current_buffer */
2110 /* This line helps to fix Horsley's testbug.el bug. */
2111 && !(WINDOWP (BVAR (b, last_selected_window))
2112 && w != XWINDOW (BVAR (b, last_selected_window))
2113 && EQ (buf, XWINDOW (BVAR (b, last_selected_window))->contents)))
2114 temp_set_point_both (b,
2115 clip_to_bounds (BUF_BEGV (b),
2116 marker_position (w->pointm),
2117 BUF_ZV (b)),
2118 clip_to_bounds (BUF_BEGV_BYTE (b),
2119 marker_byte_position (w->pointm),
2120 BUF_ZV_BYTE (b)));
2122 if (WINDOWP (BVAR (b, last_selected_window))
2123 && w == XWINDOW (BVAR (b, last_selected_window)))
2124 bset_last_selected_window (b, Qnil);
2127 /* Put NEW into the window structure in place of OLD. SETFLAG false
2128 means change window structure only. Otherwise store geometry and
2129 other settings as well. */
2130 static void
2131 replace_window (Lisp_Object old, Lisp_Object new, bool setflag)
2133 Lisp_Object tem;
2134 struct window *o = XWINDOW (old), *n = XWINDOW (new);
2136 /* If OLD is its frame's root window, then NEW is the new
2137 root window for that frame. */
2138 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
2139 fset_root_window (XFRAME (o->frame), new);
2141 if (setflag)
2143 n->pixel_left = o->pixel_left;
2144 n->pixel_top = o->pixel_top;
2145 n->pixel_width = o->pixel_width;
2146 n->pixel_height = o->pixel_height;
2147 n->left_col = o->left_col;
2148 n->top_line = o->top_line;
2149 n->total_cols = o->total_cols;
2150 n->total_lines = o->total_lines;
2151 wset_normal_cols (n, o->normal_cols);
2152 wset_normal_cols (o, make_float (1.0));
2153 wset_normal_lines (n, o->normal_lines);
2154 wset_normal_lines (o, make_float (1.0));
2155 n->desired_matrix = n->current_matrix = 0;
2156 n->vscroll = 0;
2157 memset (&n->cursor, 0, sizeof (n->cursor));
2158 memset (&n->phys_cursor, 0, sizeof (n->phys_cursor));
2159 n->last_cursor_vpos = 0;
2160 #ifdef HAVE_WINDOW_SYSTEM
2161 n->phys_cursor_type = NO_CURSOR;
2162 n->phys_cursor_width = -1;
2163 #endif
2164 n->must_be_updated_p = false;
2165 n->pseudo_window_p = false;
2166 n->window_end_vpos = 0;
2167 n->window_end_pos = 0;
2168 n->window_end_valid = false;
2171 tem = o->next;
2172 wset_next (n, tem);
2173 if (!NILP (tem))
2174 wset_prev (XWINDOW (tem), new);
2176 tem = o->prev;
2177 wset_prev (n, tem);
2178 if (!NILP (tem))
2179 wset_next (XWINDOW (tem), new);
2181 tem = o->parent;
2182 wset_parent (n, tem);
2183 if (!NILP (tem) && EQ (XWINDOW (tem)->contents, old))
2184 wset_combination (XWINDOW (tem), XWINDOW (tem)->horizontal, new);
2187 /* If window WINDOW and its parent window are iso-combined, merge
2188 WINDOW's children into those of its parent window and mark WINDOW as
2189 deleted. */
2191 static void
2192 recombine_windows (Lisp_Object window)
2194 struct window *w, *p, *c;
2195 Lisp_Object parent, child;
2196 bool horflag;
2198 w = XWINDOW (window);
2199 parent = w->parent;
2200 if (!NILP (parent) && NILP (w->combination_limit))
2202 p = XWINDOW (parent);
2203 if (WINDOWP (p->contents) && WINDOWP (w->contents)
2204 && p->horizontal == w->horizontal)
2205 /* WINDOW and PARENT are both either a vertical or a horizontal
2206 combination. */
2208 horflag = WINDOW_HORIZONTAL_COMBINATION_P (w);
2209 child = w->contents;
2210 c = XWINDOW (child);
2212 /* Splice WINDOW's children into its parent's children and
2213 assign new normal sizes. */
2214 if (NILP (w->prev))
2215 wset_combination (p, horflag, child);
2216 else
2218 wset_prev (c, w->prev);
2219 wset_next (XWINDOW (w->prev), child);
2222 while (c)
2224 wset_parent (c, parent);
2226 if (horflag)
2227 wset_normal_cols
2228 (c, make_float ((double) c->pixel_width
2229 / (double) p->pixel_width));
2230 else
2231 wset_normal_lines
2232 (c, make_float ((double) c->pixel_height
2233 / (double) p->pixel_height));
2235 if (NILP (c->next))
2237 if (!NILP (w->next))
2239 wset_next (c, w->next);
2240 wset_prev (XWINDOW (c->next), child);
2243 c = 0;
2245 else
2247 child = c->next;
2248 c = XWINDOW (child);
2252 /* WINDOW can be deleted now. */
2253 wset_combination (w, false, Qnil);
2258 /* If WINDOW can be deleted, delete it. */
2259 static void
2260 delete_deletable_window (Lisp_Object window)
2262 if (!NILP (call1 (Qwindow_deletable_p, window)))
2263 call1 (Qdelete_window, window);
2266 /***********************************************************************
2267 Window List
2268 ***********************************************************************/
2270 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
2271 pointer. This is a callback function for foreach_window, used in
2272 the window_list function. */
2274 static bool
2275 add_window_to_list (struct window *w, void *user_data)
2277 Lisp_Object *list = user_data;
2278 Lisp_Object window;
2279 XSETWINDOW (window, w);
2280 *list = Fcons (window, *list);
2281 return true;
2285 /* Return a list of all windows, for use by next_window. If
2286 Vwindow_list is a list, return that list. Otherwise, build a new
2287 list, cache it in Vwindow_list, and return that. */
2289 Lisp_Object
2290 window_list (void)
2292 if (!CONSP (Vwindow_list))
2294 Lisp_Object tail, frame;
2296 Vwindow_list = Qnil;
2297 FOR_EACH_FRAME (tail, frame)
2299 Lisp_Object arglist = Qnil;
2301 /* We are visiting windows in canonical order, and add
2302 new windows at the front of args[1], which means we
2303 have to reverse this list at the end. */
2304 foreach_window (XFRAME (frame), add_window_to_list, &arglist);
2305 arglist = Fnreverse (arglist);
2306 Vwindow_list = CALLN (Fnconc, Vwindow_list, arglist);
2310 return Vwindow_list;
2314 /* Value is true if WINDOW satisfies the constraints given by
2315 OWINDOW, MINIBUF and ALL_FRAMES.
2317 MINIBUF t means WINDOW may be minibuffer windows.
2318 `lambda' means WINDOW may not be a minibuffer window.
2319 a window means a specific minibuffer window
2321 ALL_FRAMES t means search all frames,
2322 nil means search just current frame,
2323 `visible' means search just visible frames on the
2324 current terminal,
2325 0 means search visible and iconified frames on the
2326 current terminal,
2327 a window means search the frame that window belongs to,
2328 a frame means consider windows on that frame, only. */
2330 static bool
2331 candidate_window_p (Lisp_Object window, Lisp_Object owindow,
2332 Lisp_Object minibuf, Lisp_Object all_frames)
2334 struct window *w = XWINDOW (window);
2335 struct frame *f = XFRAME (w->frame);
2336 bool candidate_p = true;
2338 if (!BUFFERP (w->contents))
2339 candidate_p = false;
2340 else if (MINI_WINDOW_P (w)
2341 && (EQ (minibuf, Qlambda)
2342 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
2344 /* If MINIBUF is `lambda' don't consider any mini-windows.
2345 If it is a window, consider only that one. */
2346 candidate_p = false;
2348 else if (EQ (all_frames, Qt))
2349 candidate_p = true;
2350 else if (NILP (all_frames))
2352 eassert (WINDOWP (owindow));
2353 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
2355 else if (EQ (all_frames, Qvisible))
2357 candidate_p = FRAME_VISIBLE_P (f)
2358 && (FRAME_TERMINAL (XFRAME (w->frame))
2359 == FRAME_TERMINAL (XFRAME (selected_frame)));
2362 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
2364 candidate_p = (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)
2365 #ifdef HAVE_X_WINDOWS
2366 /* Yuck!! If we've just created the frame and the
2367 window-manager requested the user to place it
2368 manually, the window may still not be considered
2369 `visible'. I'd argue it should be at least
2370 something like `iconified', but don't know how to do
2371 that yet. --Stef */
2372 || (FRAME_X_P (f) && f->output_data.x->asked_for_visible
2373 && !f->output_data.x->has_been_visible)
2374 #endif
2376 && (FRAME_TERMINAL (XFRAME (w->frame))
2377 == FRAME_TERMINAL (XFRAME (selected_frame)));
2379 else if (WINDOWP (all_frames))
2380 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
2381 || EQ (XWINDOW (all_frames)->frame, w->frame)
2382 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
2383 else if (FRAMEP (all_frames))
2384 candidate_p = EQ (all_frames, w->frame);
2386 return candidate_p;
2390 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
2391 Fwindow_list. See candidate_window_p for the meaning of WINDOW,
2392 MINIBUF, and ALL_FRAMES. */
2394 static void
2395 decode_next_window_args (Lisp_Object *window, Lisp_Object *minibuf, Lisp_Object *all_frames)
2397 struct window *w = decode_live_window (*window);
2399 XSETWINDOW (*window, w);
2400 /* MINIBUF nil may or may not include minibuffers. Decide if it
2401 does. */
2402 if (NILP (*minibuf))
2403 *minibuf = minibuf_level ? minibuf_window : Qlambda;
2404 else if (!EQ (*minibuf, Qt))
2405 *minibuf = Qlambda;
2407 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
2408 => count none of them, or a specific minibuffer window (the
2409 active one) to count. */
2411 /* ALL_FRAMES nil doesn't specify which frames to include. */
2412 if (NILP (*all_frames))
2413 *all_frames
2414 = (!EQ (*minibuf, Qlambda)
2415 ? FRAME_MINIBUF_WINDOW (XFRAME (w->frame))
2416 : Qnil);
2417 else if (EQ (*all_frames, Qvisible))
2419 else if (EQ (*all_frames, make_number (0)))
2421 else if (FRAMEP (*all_frames))
2423 else if (!EQ (*all_frames, Qt))
2424 *all_frames = Qnil;
2428 /* Return the next or previous window of WINDOW in cyclic ordering
2429 of windows. NEXT_P means return the next window. See the
2430 documentation string of next-window for the meaning of MINIBUF and
2431 ALL_FRAMES. */
2433 static Lisp_Object
2434 next_window (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames,
2435 bool next_p)
2437 decode_next_window_args (&window, &minibuf, &all_frames);
2439 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
2440 return the first window on the frame. */
2441 if (FRAMEP (all_frames)
2442 && !EQ (all_frames, XWINDOW (window)->frame))
2443 return Fframe_first_window (all_frames);
2445 if (next_p)
2447 Lisp_Object list;
2449 /* Find WINDOW in the list of all windows. */
2450 list = Fmemq (window, window_list ());
2452 /* Scan forward from WINDOW to the end of the window list. */
2453 if (CONSP (list))
2454 for (list = XCDR (list); CONSP (list); list = XCDR (list))
2455 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2456 break;
2458 /* Scan from the start of the window list up to WINDOW. */
2459 if (!CONSP (list))
2460 for (list = Vwindow_list;
2461 CONSP (list) && !EQ (XCAR (list), window);
2462 list = XCDR (list))
2463 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2464 break;
2466 if (CONSP (list))
2467 window = XCAR (list);
2469 else
2471 Lisp_Object candidate, list;
2473 /* Scan through the list of windows for candidates. If there are
2474 candidate windows in front of WINDOW, the last one of these
2475 is the one we want. If there are candidates following WINDOW
2476 in the list, again the last one of these is the one we want. */
2477 candidate = Qnil;
2478 for (list = window_list (); CONSP (list); list = XCDR (list))
2480 if (EQ (XCAR (list), window))
2482 if (WINDOWP (candidate))
2483 break;
2485 else if (candidate_window_p (XCAR (list), window, minibuf,
2486 all_frames))
2487 candidate = XCAR (list);
2490 if (WINDOWP (candidate))
2491 window = candidate;
2494 return window;
2498 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
2499 doc: /* Return live window after WINDOW in the cyclic ordering of windows.
2500 WINDOW must be a live window and defaults to the selected one. The
2501 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2502 consider.
2504 MINIBUF nil or omitted means consider the minibuffer window only if the
2505 minibuffer is active. MINIBUF t means consider the minibuffer window
2506 even if the minibuffer is not active. Any other value means do not
2507 consider the minibuffer window even if the minibuffer is active.
2509 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2510 plus the minibuffer window if specified by the MINIBUF argument. If the
2511 minibuffer counts, consider all windows on all frames that share that
2512 minibuffer too. The following non-nil values of ALL-FRAMES have special
2513 meanings:
2515 - t means consider all windows on all existing frames.
2517 - `visible' means consider all windows on all visible frames.
2519 - 0 (the number zero) means consider all windows on all visible and
2520 iconified frames.
2522 - A frame means consider all windows on that frame only.
2524 Anything else means consider all windows on WINDOW's frame and no
2525 others.
2527 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2528 `next-window' to iterate through the entire cycle of acceptable
2529 windows, eventually ending up back at the window you started with.
2530 `previous-window' traverses the same cycle, in the reverse order. */)
2531 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2533 return next_window (window, minibuf, all_frames, true);
2537 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
2538 doc: /* Return live window before WINDOW in the cyclic ordering of windows.
2539 WINDOW must be a live window and defaults to the selected one. The
2540 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2541 consider.
2543 MINIBUF nil or omitted means consider the minibuffer window only if the
2544 minibuffer is active. MINIBUF t means consider the minibuffer window
2545 even if the minibuffer is not active. Any other value means do not
2546 consider the minibuffer window even if the minibuffer is active.
2548 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2549 plus the minibuffer window if specified by the MINIBUF argument. If the
2550 minibuffer counts, consider all windows on all frames that share that
2551 minibuffer too. The following non-nil values of ALL-FRAMES have special
2552 meanings:
2554 - t means consider all windows on all existing frames.
2556 - `visible' means consider all windows on all visible frames.
2558 - 0 (the number zero) means consider all windows on all visible and
2559 iconified frames.
2561 - A frame means consider all windows on that frame only.
2563 Anything else means consider all windows on WINDOW's frame and no
2564 others.
2566 If you use consistent values for MINIBUF and ALL-FRAMES, you can
2567 use `previous-window' to iterate through the entire cycle of
2568 acceptable windows, eventually ending up back at the window you
2569 started with. `next-window' traverses the same cycle, in the
2570 reverse order. */)
2571 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2573 return next_window (window, minibuf, all_frames, false);
2577 /* Return a list of windows in cyclic ordering. Arguments are like
2578 for `next-window'. */
2580 static Lisp_Object
2581 window_list_1 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2583 Lisp_Object tail, list, rest;
2585 decode_next_window_args (&window, &minibuf, &all_frames);
2586 list = Qnil;
2588 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
2589 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
2590 list = Fcons (XCAR (tail), list);
2592 /* Rotate the list to start with WINDOW. */
2593 list = Fnreverse (list);
2594 rest = Fmemq (window, list);
2595 if (!NILP (rest) && !EQ (rest, list))
2597 for (tail = list; !EQ (XCDR (tail), rest); tail = XCDR (tail))
2599 XSETCDR (tail, Qnil);
2600 list = nconc2 (rest, list);
2602 return list;
2606 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
2607 doc: /* Return a list of windows on FRAME, starting with WINDOW.
2608 FRAME nil or omitted means use the selected frame.
2609 WINDOW nil or omitted means use the window selected within FRAME.
2610 MINIBUF t means include the minibuffer window, even if it isn't active.
2611 MINIBUF nil or omitted means include the minibuffer window only
2612 if it's active.
2613 MINIBUF neither nil nor t means never include the minibuffer window. */)
2614 (Lisp_Object frame, Lisp_Object minibuf, Lisp_Object window)
2616 if (NILP (window))
2617 window = FRAMEP (frame) ? XFRAME (frame)->selected_window : selected_window;
2618 CHECK_WINDOW (window);
2619 if (NILP (frame))
2620 frame = selected_frame;
2622 if (!EQ (frame, XWINDOW (window)->frame))
2623 error ("Window is on a different frame");
2625 return window_list_1 (window, minibuf, frame);
2629 DEFUN ("window-list-1", Fwindow_list_1, Swindow_list_1, 0, 3, 0,
2630 doc: /* Return a list of all live windows.
2631 WINDOW specifies the first window to list and defaults to the selected
2632 window.
2634 Optional argument MINIBUF nil or omitted means consider the minibuffer
2635 window only if the minibuffer is active. MINIBUF t means consider the
2636 minibuffer window even if the minibuffer is not active. Any other value
2637 means do not consider the minibuffer window even if the minibuffer is
2638 active.
2640 Optional argument ALL-FRAMES nil or omitted means consider all windows
2641 on WINDOW's frame, plus the minibuffer window if specified by the
2642 MINIBUF argument. If the minibuffer counts, consider all windows on all
2643 frames that share that minibuffer too. The following non-nil values of
2644 ALL-FRAMES have special meanings:
2646 - t means consider all windows on all existing frames.
2648 - `visible' means consider all windows on all visible frames.
2650 - 0 (the number zero) means consider all windows on all visible and
2651 iconified frames.
2653 - A frame means consider all windows on that frame only.
2655 Anything else means consider all windows on WINDOW's frame and no
2656 others.
2658 If WINDOW is not on the list of windows returned, some other window will
2659 be listed first but no error is signaled. */)
2660 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2662 return window_list_1 (window, minibuf, all_frames);
2665 /* Look at all windows, performing an operation specified by TYPE
2666 with argument OBJ.
2667 If FRAMES is Qt, look at all frames;
2668 Qnil, look at just the selected frame;
2669 Qvisible, look at visible frames;
2670 a frame, just look at windows on that frame.
2671 If MINI, perform the operation on minibuffer windows too. */
2673 enum window_loop
2675 WINDOW_LOOP_UNUSED,
2676 GET_BUFFER_WINDOW, /* Arg is buffer */
2677 REPLACE_BUFFER_IN_WINDOWS_SAFELY, /* Arg is buffer */
2678 REDISPLAY_BUFFER_WINDOWS, /* Arg is buffer */
2679 CHECK_ALL_WINDOWS /* Arg is ignored */
2682 static Lisp_Object
2683 window_loop (enum window_loop type, Lisp_Object obj, bool mini,
2684 Lisp_Object frames)
2686 Lisp_Object window, windows, best_window, frame_arg;
2687 bool frame_best_window_flag = false;
2688 struct frame *f;
2690 /* If we're only looping through windows on a particular frame,
2691 frame points to that frame. If we're looping through windows
2692 on all frames, frame is 0. */
2693 if (FRAMEP (frames))
2694 f = XFRAME (frames);
2695 else if (NILP (frames))
2696 f = SELECTED_FRAME ();
2697 else
2698 f = NULL;
2700 if (f)
2701 frame_arg = Qlambda;
2702 else if (EQ (frames, make_number (0)))
2703 frame_arg = frames;
2704 else if (EQ (frames, Qvisible))
2705 frame_arg = frames;
2706 else
2707 frame_arg = Qt;
2709 /* frame_arg is Qlambda to stick to one frame,
2710 Qvisible to consider all visible frames,
2711 or Qt otherwise. */
2713 /* Pick a window to start with. */
2714 if (WINDOWP (obj))
2715 window = obj;
2716 else if (f)
2717 window = FRAME_SELECTED_WINDOW (f);
2718 else
2719 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2721 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
2722 best_window = Qnil;
2724 for (; CONSP (windows); windows = XCDR (windows))
2726 struct window *w;
2728 window = XCAR (windows);
2729 w = XWINDOW (window);
2731 /* Note that we do not pay attention here to whether the frame
2732 is visible, since Fwindow_list skips non-visible frames if
2733 that is desired, under the control of frame_arg. */
2734 if (!MINI_WINDOW_P (w)
2735 /* For REPLACE_BUFFER_IN_WINDOWS_SAFELY, we must always
2736 consider all windows. */
2737 || type == REPLACE_BUFFER_IN_WINDOWS_SAFELY
2738 || (mini && minibuf_level > 0))
2739 switch (type)
2741 case GET_BUFFER_WINDOW:
2742 if (EQ (w->contents, obj)
2743 /* Don't find any minibuffer window except the one that
2744 is currently in use. */
2745 && (!MINI_WINDOW_P (w) || EQ (window, minibuf_window)))
2747 if (EQ (window, selected_window))
2748 /* Preferably return the selected window. */
2749 return window;
2750 else if (EQ (XWINDOW (window)->frame, selected_frame)
2751 && !frame_best_window_flag)
2752 /* Prefer windows on the current frame (but don't
2753 choose another one if we have one already). */
2755 best_window = window;
2756 frame_best_window_flag = true;
2758 else if (NILP (best_window))
2759 best_window = window;
2761 break;
2763 case REPLACE_BUFFER_IN_WINDOWS_SAFELY:
2764 /* We could simply check whether the buffer shown by window
2765 is live, and show another buffer in case it isn't. */
2766 if (EQ (w->contents, obj))
2768 /* Undedicate WINDOW. */
2769 wset_dedicated (w, Qnil);
2770 /* Make WINDOW show the buffer returned by
2771 other_buffer_safely, don't run any hooks. */
2772 set_window_buffer
2773 (window, other_buffer_safely (w->contents), false, false);
2774 /* If WINDOW is the selected window, make its buffer
2775 current. But do so only if the window shows the
2776 current buffer (Bug#6454). */
2777 if (EQ (window, selected_window)
2778 && XBUFFER (w->contents) == current_buffer)
2779 Fset_buffer (w->contents);
2781 break;
2783 case REDISPLAY_BUFFER_WINDOWS:
2784 if (EQ (w->contents, obj))
2786 mark_window_display_accurate (window, false);
2787 w->update_mode_line = true;
2788 XBUFFER (obj)->prevent_redisplay_optimizations_p = true;
2789 update_mode_lines = 27;
2790 best_window = window;
2792 break;
2794 /* Check for a leaf window that has a killed buffer
2795 or broken markers. */
2796 case CHECK_ALL_WINDOWS:
2797 if (BUFFERP (w->contents))
2799 struct buffer *b = XBUFFER (w->contents);
2801 if (!BUFFER_LIVE_P (b))
2802 emacs_abort ();
2803 if (!MARKERP (w->start) || XMARKER (w->start)->buffer != b)
2804 emacs_abort ();
2805 if (!MARKERP (w->pointm) || XMARKER (w->pointm)->buffer != b)
2806 emacs_abort ();
2808 break;
2810 case WINDOW_LOOP_UNUSED:
2811 break;
2815 return best_window;
2818 /* Used for debugging. Abort if any window has a dead buffer. */
2820 extern void check_all_windows (void) EXTERNALLY_VISIBLE;
2821 void
2822 check_all_windows (void)
2824 window_loop (CHECK_ALL_WINDOWS, Qnil, true, Qt);
2827 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 0, 2, 0,
2828 doc: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2829 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to
2830 the current buffer.
2832 The optional argument ALL-FRAMES specifies the frames to consider:
2834 - t means consider all windows on all existing frames.
2836 - `visible' means consider all windows on all visible frames.
2838 - 0 (the number zero) means consider all windows on all visible
2839 and iconified frames.
2841 - A frame means consider all windows on that frame only.
2843 Any other value of ALL-FRAMES means consider all windows on the
2844 selected frame and no others. */)
2845 (Lisp_Object buffer_or_name, Lisp_Object all_frames)
2847 Lisp_Object buffer;
2849 if (NILP (buffer_or_name))
2850 buffer = Fcurrent_buffer ();
2851 else
2852 buffer = Fget_buffer (buffer_or_name);
2854 if (BUFFERP (buffer))
2855 return window_loop (GET_BUFFER_WINDOW, buffer, true, all_frames);
2856 else
2857 return Qnil;
2861 static Lisp_Object
2862 resize_root_window (Lisp_Object window, Lisp_Object delta,
2863 Lisp_Object horizontal, Lisp_Object ignore,
2864 Lisp_Object pixelwise)
2866 return call5 (Qwindow__resize_root_window, window, delta,
2867 horizontal, ignore, pixelwise);
2870 /* Placeholder used by temacs -nw before window.el is loaded. */
2871 DEFUN ("window--sanitize-window-sizes", Fwindow__sanitize_window_sizes,
2872 Swindow__sanitize_window_sizes, 2, 2, 0,
2873 doc: /* */
2874 attributes: const)
2875 (Lisp_Object frame, Lisp_Object horizontal)
2877 return Qnil;
2880 Lisp_Object
2881 sanitize_window_sizes (Lisp_Object frame, Lisp_Object horizontal)
2883 return call2 (Qwindow__sanitize_window_sizes, frame, horizontal);
2887 static Lisp_Object
2888 window_pixel_to_total (Lisp_Object frame, Lisp_Object horizontal)
2890 return call2 (Qwindow__pixel_to_total, frame, horizontal);
2894 DEFUN ("delete-other-windows-internal", Fdelete_other_windows_internal,
2895 Sdelete_other_windows_internal, 0, 2, "",
2896 doc: /* Make WINDOW fill its frame.
2897 Only the frame WINDOW is on is affected. WINDOW must be a valid window
2898 and defaults to the selected one.
2900 Optional argument ROOT, if non-nil, must specify an internal window such
2901 that WINDOW is in its window subtree. If this is the case, replace ROOT
2902 by WINDOW and leave alone any windows not part of ROOT's subtree.
2904 When WINDOW is live try to reduce display jumps by keeping the text
2905 previously visible in WINDOW in the same place on the frame. Doing this
2906 depends on the value of (window-start WINDOW), so if calling this
2907 function in a program gives strange scrolling, make sure the
2908 window-start value is reasonable when this function is called. */)
2909 (Lisp_Object window, Lisp_Object root)
2911 struct window *w, *r, *s;
2912 struct frame *f;
2913 Lisp_Object sibling, pwindow, delta;
2914 Lisp_Object swindow UNINIT;
2915 ptrdiff_t startpos UNINIT, startbyte UNINIT;
2916 int top UNINIT;
2917 int new_top;
2918 bool resize_failed = false;
2920 w = decode_valid_window (window);
2921 XSETWINDOW (window, w);
2922 f = XFRAME (w->frame);
2924 if (NILP (root))
2925 /* ROOT is the frame's root window. */
2927 root = FRAME_ROOT_WINDOW (f);
2928 r = XWINDOW (root);
2930 else
2931 /* ROOT must be an ancestor of WINDOW. */
2933 r = decode_valid_window (root);
2934 pwindow = XWINDOW (window)->parent;
2935 while (!NILP (pwindow))
2936 if (EQ (pwindow, root))
2937 break;
2938 else
2939 pwindow = XWINDOW (pwindow)->parent;
2940 if (!EQ (pwindow, root))
2941 error ("Specified root is not an ancestor of specified window");
2944 if (EQ (window, root))
2945 /* A noop. */
2946 return Qnil;
2947 /* I don't understand the "top > 0" part below. If we deal with a
2948 standalone minibuffer it would have been caught by the preceding
2949 test. */
2950 else if (MINI_WINDOW_P (w)) /* && top > 0) */
2951 error ("Can't expand minibuffer to full frame");
2953 if (BUFFERP (w->contents))
2955 startpos = marker_position (w->start);
2956 startbyte = marker_byte_position (w->start);
2957 top = (WINDOW_TOP_EDGE_LINE (w)
2958 - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w))));
2959 /* Make sure WINDOW is the frame's selected window. */
2960 if (!EQ (window, FRAME_SELECTED_WINDOW (f)))
2962 if (EQ (selected_frame, w->frame))
2963 Fselect_window (window, Qnil);
2964 else
2965 fset_selected_window (f, window);
2968 else
2970 /* See if the frame's selected window is a part of the window
2971 subtree rooted at WINDOW, by finding all the selected window's
2972 parents and comparing each one with WINDOW. If it isn't we
2973 need a new selected window for this frame. */
2974 swindow = FRAME_SELECTED_WINDOW (f);
2975 while (true)
2977 pwindow = swindow;
2978 while (!NILP (pwindow) && !EQ (window, pwindow))
2979 pwindow = XWINDOW (pwindow)->parent;
2981 if (EQ (window, pwindow))
2982 /* If WINDOW is an ancestor of SWINDOW, then SWINDOW is ok
2983 as the new selected window. */
2984 break;
2985 else
2986 /* Else try the previous window of SWINDOW. */
2987 swindow = Fprevious_window (swindow, Qlambda, Qnil);
2990 if (!EQ (swindow, FRAME_SELECTED_WINDOW (f)))
2992 if (EQ (selected_frame, w->frame))
2993 Fselect_window (swindow, Qnil);
2994 else
2995 fset_selected_window (f, swindow);
2999 block_input ();
3000 if (!FRAME_INITIAL_P (f))
3002 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
3004 /* We are going to free the glyph matrices of WINDOW, and with
3005 that we might lose any information about glyph rows that have
3006 some of their glyphs highlighted in mouse face. (These rows
3007 are marked with a mouse_face_p flag.) If WINDOW
3008 indeed has some glyphs highlighted in mouse face, signal to
3009 frame's up-to-date hook that mouse highlight was overwritten,
3010 so that it will arrange for redisplaying the highlight. */
3011 if (EQ (hlinfo->mouse_face_window, window))
3012 reset_mouse_highlight (hlinfo);
3014 free_window_matrices (r);
3016 fset_redisplay (f);
3017 Vwindow_list = Qnil;
3019 if (!WINDOW_LEAF_P (w))
3021 /* Resize child windows vertically. */
3022 XSETINT (delta, r->pixel_height - w->pixel_height);
3023 w->pixel_top = r->pixel_top;
3024 w->top_line = r->top_line;
3025 resize_root_window (window, delta, Qnil, Qnil, Qt);
3026 if (window_resize_check (w, false))
3028 window_resize_apply (w, false);
3029 window_pixel_to_total (w->frame, Qnil);
3031 else
3033 resize_root_window (window, delta, Qnil, Qt, Qt);
3034 if (window_resize_check (w, false))
3036 window_resize_apply (w, false);
3037 window_pixel_to_total (w->frame, Qnil);
3039 else
3040 resize_failed = true;
3043 /* Resize child windows horizontally. */
3044 if (!resize_failed)
3046 w->left_col = r->left_col;
3047 w->pixel_left = r->pixel_left;
3048 XSETINT (delta, r->pixel_width - w->pixel_width);
3049 resize_root_window (window, delta, Qt, Qnil, Qt);
3050 if (window_resize_check (w, true))
3052 window_resize_apply (w, true);
3053 window_pixel_to_total (w->frame, Qt);
3055 else
3057 resize_root_window (window, delta, Qt, Qt, Qt);
3058 if (window_resize_check (w, true))
3060 window_resize_apply (w, true);
3061 window_pixel_to_total (w->frame, Qt);
3063 else
3064 resize_failed = true;
3068 if (resize_failed)
3069 /* Play safe, if we still can ... */
3071 window = swindow;
3072 w = XWINDOW (window);
3076 /* Cleanly unlink WINDOW from window-tree. */
3077 if (!NILP (w->prev))
3078 /* Get SIBLING above (on the left of) WINDOW. */
3080 sibling = w->prev;
3081 s = XWINDOW (sibling);
3082 wset_next (s, w->next);
3083 if (!NILP (s->next))
3084 wset_prev (XWINDOW (s->next), sibling);
3086 else
3087 /* Get SIBLING below (on the right of) WINDOW. */
3089 sibling = w->next;
3090 s = XWINDOW (sibling);
3091 wset_prev (s, Qnil);
3092 wset_combination (XWINDOW (w->parent),
3093 XWINDOW (w->parent)->horizontal, sibling);
3096 /* Delete ROOT and all child windows of ROOT. */
3097 if (WINDOWP (r->contents))
3099 delete_all_child_windows (r->contents);
3100 wset_combination (r, false, Qnil);
3103 replace_window (root, window, true);
3105 /* This must become SWINDOW anyway ....... */
3106 if (BUFFERP (w->contents) && !resize_failed)
3108 /* Try to minimize scrolling, by setting the window start to the
3109 point will cause the text at the old window start to be at the
3110 same place on the frame. But don't try to do this if the
3111 window start is outside the visible portion (as might happen
3112 when the display is not current, due to typeahead). */
3113 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
3114 if (new_top != top
3115 && startpos >= BUF_BEGV (XBUFFER (w->contents))
3116 && startpos <= BUF_ZV (XBUFFER (w->contents)))
3118 struct position pos;
3119 struct buffer *obuf = current_buffer;
3121 Fset_buffer (w->contents);
3122 /* This computation used to temporarily move point, but that
3123 can have unwanted side effects due to text properties. */
3124 pos = *vmotion (startpos, startbyte, -top, w);
3126 set_marker_both (w->start, w->contents, pos.bufpos, pos.bytepos);
3127 w->window_end_valid = false;
3128 w->start_at_line_beg = (pos.bytepos == BEGV_BYTE
3129 || FETCH_BYTE (pos.bytepos - 1) == '\n');
3130 /* We need to do this, so that the window-scroll-functions
3131 get called. */
3132 w->optional_new_start = true;
3134 set_buffer_internal (obuf);
3138 adjust_frame_glyphs (f);
3139 unblock_input ();
3141 run_window_configuration_change_hook (f);
3143 return Qnil;
3147 void
3148 replace_buffer_in_windows (Lisp_Object buffer)
3150 call1 (Qreplace_buffer_in_windows, buffer);
3153 /* If BUFFER is shown in a window, safely replace it with some other
3154 buffer in all windows of all frames, even those on other keyboards. */
3156 void
3157 replace_buffer_in_windows_safely (Lisp_Object buffer)
3159 if (buffer_window_count (XBUFFER (buffer)))
3161 Lisp_Object tail, frame;
3163 /* A single call to window_loop won't do the job because it only
3164 considers frames on the current keyboard. So loop manually over
3165 frames, and handle each one. */
3166 FOR_EACH_FRAME (tail, frame)
3167 window_loop (REPLACE_BUFFER_IN_WINDOWS_SAFELY, buffer, true, frame);
3171 /* The following three routines are needed for running a window's
3172 configuration change hook. */
3173 static void
3174 run_funs (Lisp_Object funs)
3176 for (; CONSP (funs); funs = XCDR (funs))
3177 if (!EQ (XCAR (funs), Qt))
3178 call0 (XCAR (funs));
3181 static void
3182 select_window_norecord (Lisp_Object window)
3184 if (WINDOW_LIVE_P (window))
3185 Fselect_window (window, Qt);
3188 static void
3189 select_frame_norecord (Lisp_Object frame)
3191 if (FRAME_LIVE_P (XFRAME (frame)))
3192 Fselect_frame (frame, Qt);
3195 static void
3196 run_window_configuration_change_hook (struct frame *f)
3198 ptrdiff_t count = SPECPDL_INDEX ();
3199 Lisp_Object frame, global_wcch
3200 = Fdefault_value (Qwindow_configuration_change_hook);
3201 XSETFRAME (frame, f);
3203 if (NILP (Vrun_hooks)
3204 || !(f->can_x_set_window_size)
3205 || !(f->after_make_frame))
3206 return;
3208 /* Use the right buffer. Matters when running the local hooks. */
3209 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
3211 record_unwind_current_buffer ();
3212 Fset_buffer (Fwindow_buffer (Qnil));
3215 if (SELECTED_FRAME () != f)
3217 record_unwind_protect (select_frame_norecord, selected_frame);
3218 select_frame_norecord (frame);
3221 /* Look for buffer-local values. */
3223 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
3224 for (; CONSP (windows); windows = XCDR (windows))
3226 Lisp_Object window = XCAR (windows);
3227 Lisp_Object buffer = Fwindow_buffer (window);
3228 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
3229 buffer)))
3231 ptrdiff_t inner_count = SPECPDL_INDEX ();
3232 record_unwind_protect (select_window_norecord, selected_window);
3233 select_window_norecord (window);
3234 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
3235 buffer));
3236 unbind_to (inner_count, Qnil);
3241 run_funs (global_wcch);
3242 unbind_to (count, Qnil);
3245 DEFUN ("run-window-configuration-change-hook", Frun_window_configuration_change_hook,
3246 Srun_window_configuration_change_hook, 0, 1, 0,
3247 doc: /* Run `window-configuration-change-hook' for FRAME.
3248 If FRAME is omitted or nil, it defaults to the selected frame. */)
3249 (Lisp_Object frame)
3251 run_window_configuration_change_hook (decode_live_frame (frame));
3252 return Qnil;
3255 DEFUN ("run-window-scroll-functions", Frun_window_scroll_functions,
3256 Srun_window_scroll_functions, 0, 1, 0,
3257 doc: /* Run `window-scroll-functions' for WINDOW.
3258 If WINDOW is omitted or nil, it defaults to the selected window. */)
3259 (Lisp_Object window)
3261 if (! NILP (Vwindow_scroll_functions))
3262 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3263 Fmarker_position (decode_live_window (window)->start));
3264 return Qnil;
3268 /* Compare old and present pixel sizes of windows in tree rooted at W.
3269 Return true iff any of these windows differs in size. */
3271 static bool
3272 window_size_changed (struct window *w)
3274 if (w->pixel_width != w->pixel_width_before_size_change
3275 || w->pixel_height != w->pixel_height_before_size_change)
3276 return true;
3278 if (WINDOW_INTERNAL_P (w))
3280 w = XWINDOW (w->contents);
3281 while (w)
3283 if (window_size_changed (w))
3284 return true;
3286 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3290 return false;
3293 /* Set before size change pixel sizes of windows in tree rooted at W to
3294 their present pixel sizes. */
3296 static void
3297 window_set_before_size_change_sizes (struct window *w)
3299 w->pixel_width_before_size_change = w->pixel_width;
3300 w->pixel_height_before_size_change = w->pixel_height;
3302 if (WINDOW_INTERNAL_P (w))
3304 w = XWINDOW (w->contents);
3305 while (w)
3307 window_set_before_size_change_sizes (w);
3308 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3314 void
3315 run_window_size_change_functions (Lisp_Object frame)
3317 struct frame *f = XFRAME (frame);
3318 struct window *r = XWINDOW (FRAME_ROOT_WINDOW (f));
3319 Lisp_Object functions = Vwindow_size_change_functions;
3321 if (FRAME_WINDOW_CONFIGURATION_CHANGED (f)
3322 || window_size_changed (r))
3324 while (CONSP (functions))
3326 if (!EQ (XCAR (functions), Qt))
3327 safe_call1 (XCAR (functions), frame);
3328 functions = XCDR (functions);
3331 window_set_before_size_change_sizes (r);
3332 FRAME_WINDOW_CONFIGURATION_CHANGED (f) = false;
3337 /* Make WINDOW display BUFFER. RUN_HOOKS_P means it's allowed
3338 to run hooks. See make_frame for a case where it's not allowed.
3339 KEEP_MARGINS_P means that the current margins, fringes, and
3340 scroll-bar settings of the window are not reset from the buffer's
3341 local settings. */
3343 void
3344 set_window_buffer (Lisp_Object window, Lisp_Object buffer,
3345 bool run_hooks_p, bool keep_margins_p)
3347 struct window *w = XWINDOW (window);
3348 struct buffer *b = XBUFFER (buffer);
3349 ptrdiff_t count = SPECPDL_INDEX ();
3350 bool samebuf = EQ (buffer, w->contents);
3352 wset_buffer (w, buffer);
3354 if (EQ (window, selected_window))
3355 bset_last_selected_window (b, window);
3357 /* Let redisplay errors through. */
3358 b->display_error_modiff = 0;
3360 /* Update time stamps of buffer display. */
3361 if (INTEGERP (BVAR (b, display_count)))
3362 bset_display_count (b, make_number (XINT (BVAR (b, display_count)) + 1));
3363 bset_display_time (b, Fcurrent_time ());
3365 w->window_end_pos = 0;
3366 w->window_end_vpos = 0;
3367 w->last_cursor_vpos = 0;
3369 if (!(keep_margins_p && samebuf))
3370 { /* If we're not actually changing the buffer, don't reset hscroll
3371 and vscroll. Resetting hscroll and vscroll here is problematic
3372 for things like image-mode and doc-view-mode since it resets
3373 the image's position whenever we resize the frame. */
3374 w->hscroll = w->min_hscroll = w->hscroll_whole = 0;
3375 w->suspend_auto_hscroll = false;
3376 w->vscroll = 0;
3377 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3378 set_marker_both (w->old_pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3379 set_marker_restricted (w->start,
3380 make_number (b->last_window_start),
3381 buffer);
3382 w->start_at_line_beg = false;
3383 w->force_start = false;
3386 wset_redisplay (w);
3387 wset_update_mode_line (w);
3389 /* We must select BUFFER to run the window-scroll-functions and to look up
3390 the buffer-local value of Vwindow_point_insertion_type. */
3391 record_unwind_current_buffer ();
3392 Fset_buffer (buffer);
3394 XMARKER (w->pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3395 XMARKER (w->old_pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3397 if (!keep_margins_p)
3399 /* Set left and right marginal area width etc. from buffer. */
3400 set_window_fringes (w, BVAR (b, left_fringe_width),
3401 BVAR (b, right_fringe_width),
3402 BVAR (b, fringes_outside_margins));
3403 set_window_scroll_bars (w, BVAR (b, scroll_bar_width),
3404 BVAR (b, vertical_scroll_bar_type),
3405 BVAR (b, scroll_bar_height),
3406 BVAR (b, horizontal_scroll_bar_type));
3407 set_window_margins (w, BVAR (b, left_margin_cols),
3408 BVAR (b, right_margin_cols));
3409 apply_window_adjustment (w);
3412 if (run_hooks_p)
3414 if (!NILP (Vwindow_scroll_functions))
3415 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3416 Fmarker_position (w->start));
3417 if (!samebuf)
3418 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3421 unbind_to (count, Qnil);
3424 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3425 doc: /* Make WINDOW display BUFFER-OR-NAME.
3426 WINDOW must be a live window and defaults to the selected one.
3427 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3429 Optional third argument KEEP-MARGINS non-nil means that WINDOW's current
3430 display margins, fringe widths, and scroll bar settings are preserved;
3431 the default is to reset these from the local settings for BUFFER-OR-NAME
3432 or the frame defaults. Return nil.
3434 This function throws an error when WINDOW is strongly dedicated to its
3435 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3436 already display BUFFER-OR-NAME.
3438 This function runs `window-scroll-functions' before running
3439 `window-configuration-change-hook'. */)
3440 (register Lisp_Object window, Lisp_Object buffer_or_name, Lisp_Object keep_margins)
3442 register Lisp_Object tem, buffer;
3443 register struct window *w = decode_live_window (window);
3445 XSETWINDOW (window, w);
3446 buffer = Fget_buffer (buffer_or_name);
3447 CHECK_BUFFER (buffer);
3448 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
3449 error ("Attempt to display deleted buffer");
3451 tem = w->contents;
3452 if (NILP (tem))
3453 error ("Window is deleted");
3454 else
3456 if (!EQ (tem, buffer))
3458 if (EQ (w->dedicated, Qt))
3459 /* WINDOW is strongly dedicated to its buffer, signal an
3460 error. */
3461 error ("Window is dedicated to `%s'", SDATA (BVAR (XBUFFER (tem), name)));
3462 else
3463 /* WINDOW is weakly dedicated to its buffer, reset
3464 dedication. */
3465 wset_dedicated (w, Qnil);
3467 call1 (Qrecord_window_buffer, window);
3470 unshow_buffer (w);
3473 set_window_buffer (window, buffer, true, !NILP (keep_margins));
3475 return Qnil;
3478 static Lisp_Object
3479 display_buffer (Lisp_Object buffer, Lisp_Object not_this_window_p, Lisp_Object override_frame)
3481 return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame);
3484 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3485 0, 1, 0,
3486 doc: /* Force all windows to be updated on next redisplay.
3487 If optional arg OBJECT is a window, force redisplay of that window only.
3488 If OBJECT is a buffer or buffer name, force redisplay of all windows
3489 displaying that buffer. */)
3490 (Lisp_Object object)
3492 if (NILP (object))
3494 windows_or_buffers_changed = 29;
3495 update_mode_lines = 28;
3496 return Qt;
3499 if (WINDOWP (object))
3501 struct window *w = XWINDOW (object);
3502 mark_window_display_accurate (object, false);
3503 w->update_mode_line = true;
3504 if (BUFFERP (w->contents))
3505 XBUFFER (w->contents)->prevent_redisplay_optimizations_p = true;
3506 update_mode_lines = 29;
3507 return Qt;
3510 if (STRINGP (object))
3511 object = Fget_buffer (object);
3512 if (BUFFERP (object) && BUFFER_LIVE_P (XBUFFER (object))
3513 && buffer_window_count (XBUFFER (object)))
3515 /* If buffer is live and shown in at least one window, find
3516 all windows showing this buffer and force update of them. */
3517 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, false, Qvisible);
3518 return NILP (object) ? Qnil : Qt;
3521 /* If nothing suitable was found, just return.
3522 We could signal an error, but this feature will typically be used
3523 asynchronously in timers or process sentinels, so we don't. */
3524 return Qnil;
3527 /* Obsolete since 24.3. */
3528 void
3529 temp_output_buffer_show (register Lisp_Object buf)
3531 register struct buffer *old = current_buffer;
3532 register Lisp_Object window;
3533 register struct window *w;
3535 bset_directory (XBUFFER (buf), BVAR (current_buffer, directory));
3537 Fset_buffer (buf);
3538 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3539 BEGV = BEG;
3540 ZV = Z;
3541 SET_PT (BEG);
3542 set_buffer_internal (old);
3544 if (!NILP (Vtemp_buffer_show_function))
3545 call1 (Vtemp_buffer_show_function, buf);
3546 else if (WINDOW_LIVE_P (window = display_buffer (buf, Qnil, Qnil)))
3548 if (!EQ (XWINDOW (window)->frame, selected_frame))
3549 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3550 Vminibuf_scroll_window = window;
3551 w = XWINDOW (window);
3552 w->hscroll = w->min_hscroll = w->hscroll_whole = 0;
3553 w->suspend_auto_hscroll = false;
3554 set_marker_restricted_both (w->start, buf, BEG, BEG);
3555 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
3556 set_marker_restricted_both (w->old_pointm, buf, BEG, BEG);
3558 /* Run temp-buffer-show-hook, with the chosen window selected
3559 and its buffer current. */
3561 ptrdiff_t count = SPECPDL_INDEX ();
3562 Lisp_Object prev_window, prev_buffer;
3563 prev_window = selected_window;
3564 XSETBUFFER (prev_buffer, old);
3566 /* Select the window that was chosen, for running the hook.
3567 Note: Both Fselect_window and select_window_norecord may
3568 set-buffer to the buffer displayed in the window,
3569 so we need to save the current buffer. --stef */
3570 record_unwind_protect (restore_buffer, prev_buffer);
3571 record_unwind_protect (select_window_norecord, prev_window);
3572 Fselect_window (window, Qt);
3573 Fset_buffer (w->contents);
3574 run_hook (Qtemp_buffer_show_hook);
3575 unbind_to (count, Qnil);
3580 /* Allocate basically initialized window. */
3582 static struct window *
3583 allocate_window (void)
3585 return ALLOCATE_ZEROED_PSEUDOVECTOR
3586 (struct window, current_matrix, PVEC_WINDOW);
3589 /* Make new window, have it replace WINDOW in window-tree, and make
3590 WINDOW its only vertical child (HORFLAG means make WINDOW its only
3591 horizontal child). */
3592 static void
3593 make_parent_window (Lisp_Object window, bool horflag)
3595 Lisp_Object parent;
3596 register struct window *o, *p;
3598 o = XWINDOW (window);
3599 p = allocate_window ();
3600 memcpy ((char *) p + sizeof (struct vectorlike_header),
3601 (char *) o + sizeof (struct vectorlike_header),
3602 word_size * VECSIZE (struct window));
3603 /* P's buffer slot may change from nil to a buffer... */
3604 adjust_window_count (p, 1);
3605 XSETWINDOW (parent, p);
3607 p->sequence_number = ++sequence_number;
3609 replace_window (window, parent, true);
3611 wset_next (o, Qnil);
3612 wset_prev (o, Qnil);
3613 wset_parent (o, parent);
3614 /* ...but now P becomes an internal window. */
3615 wset_start (p, Qnil);
3616 wset_pointm (p, Qnil);
3617 wset_old_pointm (p, Qnil);
3618 wset_buffer (p, Qnil);
3619 wset_combination (p, horflag, window);
3620 wset_combination_limit (p, Qnil);
3621 wset_window_parameters (p, Qnil);
3624 /* Make new window from scratch. */
3625 Lisp_Object
3626 make_window (void)
3628 Lisp_Object window;
3629 register struct window *w;
3631 w = allocate_window ();
3632 /* Initialize Lisp data. Note that allocate_window initializes all
3633 Lisp data to nil, so do it only for slots which should not be nil. */
3634 wset_normal_lines (w, make_float (1.0));
3635 wset_normal_cols (w, make_float (1.0));
3636 wset_new_total (w, make_number (0));
3637 wset_new_normal (w, make_number (0));
3638 wset_new_pixel (w, make_number (0));
3639 wset_start (w, Fmake_marker ());
3640 wset_pointm (w, Fmake_marker ());
3641 wset_old_pointm (w, Fmake_marker ());
3642 wset_vertical_scroll_bar_type (w, Qt);
3643 wset_horizontal_scroll_bar_type (w, Qt);
3644 /* These Lisp fields are marked specially so they're not set to nil by
3645 allocate_window. */
3646 wset_prev_buffers (w, Qnil);
3647 wset_next_buffers (w, Qnil);
3649 /* Initialize non-Lisp data. Note that allocate_window zeroes out all
3650 non-Lisp data, so do it only for slots which should not be zero. */
3651 w->nrows_scale_factor = w->ncols_scale_factor = 1;
3652 w->left_fringe_width = w->right_fringe_width = -1;
3653 w->mode_line_height = w->header_line_height = -1;
3654 #ifdef HAVE_WINDOW_SYSTEM
3655 w->phys_cursor_type = NO_CURSOR;
3656 w->phys_cursor_width = -1;
3657 #endif
3658 w->sequence_number = ++sequence_number;
3659 w->pixel_width_before_size_change = 0;
3660 w->pixel_height_before_size_change = 0;
3661 w->scroll_bar_width = -1;
3662 w->scroll_bar_height = -1;
3663 w->column_number_displayed = -1;
3664 /* Reset window_list. */
3665 Vwindow_list = Qnil;
3666 /* Return window. */
3667 XSETWINDOW (window, w);
3668 return window;
3671 DEFUN ("set-window-new-pixel", Fset_window_new_pixel, Sset_window_new_pixel, 2, 3, 0,
3672 doc: /* Set new pixel size of WINDOW to SIZE.
3673 WINDOW must be a valid window and defaults to the selected one.
3674 Return SIZE.
3676 Optional argument ADD non-nil means add SIZE to the new pixel size of
3677 WINDOW and return the sum.
3679 The new pixel size of WINDOW, if valid, will be shortly installed as
3680 WINDOW's pixel height (see `window-pixel-height') or pixel width (see
3681 `window-pixel-width').
3683 Note: This function does not operate on any child windows of WINDOW. */)
3684 (Lisp_Object window, Lisp_Object size, Lisp_Object add)
3686 struct window *w = decode_valid_window (window);
3687 EMACS_INT size_min = NILP (add) ? 0 : - XINT (w->new_pixel);
3688 EMACS_INT size_max = size_min + min (INT_MAX, MOST_POSITIVE_FIXNUM);
3690 CHECK_RANGED_INTEGER (size, size_min, size_max);
3691 if (NILP (add))
3692 wset_new_pixel (w, size);
3693 else
3694 wset_new_pixel (w, make_number (XINT (w->new_pixel) + XINT (size)));
3696 return w->new_pixel;
3699 DEFUN ("set-window-new-total", Fset_window_new_total, Sset_window_new_total, 2, 3, 0,
3700 doc: /* Set new total size of WINDOW to SIZE.
3701 WINDOW must be a valid window and defaults to the selected one.
3702 Return SIZE.
3704 Optional argument ADD non-nil means add SIZE to the new total size of
3705 WINDOW and return the sum.
3707 The new total size of WINDOW, if valid, will be shortly installed as
3708 WINDOW's total height (see `window-total-height') or total width (see
3709 `window-total-width').
3711 Note: This function does not operate on any child windows of WINDOW. */)
3712 (Lisp_Object window, Lisp_Object size, Lisp_Object add)
3714 struct window *w = decode_valid_window (window);
3716 CHECK_NUMBER (size);
3717 if (NILP (add))
3718 wset_new_total (w, size);
3719 else
3720 wset_new_total (w, make_number (XINT (w->new_total) + XINT (size)));
3722 return w->new_total;
3725 DEFUN ("set-window-new-normal", Fset_window_new_normal, Sset_window_new_normal, 1, 2, 0,
3726 doc: /* Set new normal size of WINDOW to SIZE.
3727 WINDOW must be a valid window and defaults to the selected one.
3728 Return SIZE.
3730 The new normal size of WINDOW, if valid, will be shortly installed as
3731 WINDOW's normal size (see `window-normal-size').
3733 Note: This function does not operate on any child windows of WINDOW. */)
3734 (Lisp_Object window, Lisp_Object size)
3736 wset_new_normal (decode_valid_window (window), size);
3737 return size;
3740 /* Return true if setting w->pixel_height (w->pixel_width if HORFLAG)
3741 to w->new_pixel would result in correct heights (widths)
3742 for window W and recursively all child windows of W.
3744 Note: This function does not check any of `window-fixed-size-p',
3745 `window-min-height' or `window-min-width'. It does check that window
3746 sizes do not drop below one line (two columns). */
3747 static bool
3748 window_resize_check (struct window *w, bool horflag)
3750 struct frame *f = XFRAME (w->frame);
3751 struct window *c;
3753 if (WINDOW_VERTICAL_COMBINATION_P (w))
3754 /* W is a vertical combination. */
3756 c = XWINDOW (w->contents);
3757 if (horflag)
3758 /* All child windows of W must have the same width as W. */
3760 while (c)
3762 if (XINT (c->new_pixel) != XINT (w->new_pixel)
3763 || !window_resize_check (c, horflag))
3764 return false;
3766 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3769 return true;
3771 else
3772 /* The sum of the heights of the child windows of W must equal
3773 W's height. */
3775 int remaining_pixels = XINT (w->new_pixel);
3777 while (c)
3779 if (!window_resize_check (c, horflag))
3780 return false;
3782 remaining_pixels -= XINT (c->new_pixel);
3783 if (remaining_pixels < 0)
3784 return false;
3785 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3788 return remaining_pixels == 0;
3791 else if (WINDOW_HORIZONTAL_COMBINATION_P (w))
3792 /* W is a horizontal combination. */
3794 c = XWINDOW (w->contents);
3795 if (horflag)
3796 /* The sum of the widths of the child windows of W must equal W's
3797 width. */
3799 int remaining_pixels = XINT (w->new_pixel);
3801 while (c)
3803 if (!window_resize_check (c, horflag))
3804 return false;
3806 remaining_pixels -= XINT (c->new_pixel);
3807 if (remaining_pixels < 0)
3808 return false;
3809 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3812 return remaining_pixels == 0;
3814 else
3815 /* All child windows of W must have the same height as W. */
3817 while (c)
3819 if (XINT (c->new_pixel) != XINT (w->new_pixel)
3820 || !window_resize_check (c, horflag))
3821 return false;
3823 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3826 return true;
3829 else
3830 /* A leaf window. Make sure it's not too small. The following
3831 hardcodes the values of `window-safe-min-width' (2) and
3832 `window-safe-min-height' (1) which are defined in window.el. */
3833 return (XINT (w->new_pixel) >= (horflag
3834 ? (2 * FRAME_COLUMN_WIDTH (f))
3835 : FRAME_LINE_HEIGHT (f)));
3839 /* Set w->pixel_height (w->pixel_width if HORFLAG) to
3840 w->new_pixel for window W and recursively all child windows of W.
3841 Also calculate and assign the new vertical (horizontal) pixel start
3842 positions of each of these windows.
3844 This function does not perform any error checks. Make sure you have
3845 run window_resize_check on W before applying this function. */
3846 static void
3847 window_resize_apply (struct window *w, bool horflag)
3849 struct window *c;
3850 int edge;
3851 int unit = (horflag
3852 ? FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w))
3853 : FRAME_LINE_HEIGHT (WINDOW_XFRAME (w)));
3855 /* Note: Assigning new_normal requires that the new total size of the
3856 parent window has been set *before*. */
3857 if (horflag)
3859 w->pixel_width = XFASTINT (w->new_pixel);
3860 w->total_cols = w->pixel_width / unit;
3861 if (NUMBERP (w->new_normal))
3862 wset_normal_cols (w, w->new_normal);
3864 edge = w->pixel_left;
3866 else
3868 w->pixel_height = XFASTINT (w->new_pixel);
3869 w->total_lines = w->pixel_height / unit;
3870 if (NUMBERP (w->new_normal))
3871 wset_normal_lines (w, w->new_normal);
3873 edge = w->pixel_top;
3876 if (WINDOW_VERTICAL_COMBINATION_P (w))
3877 /* W is a vertical combination. */
3879 c = XWINDOW (w->contents);
3880 while (c)
3882 if (horflag)
3884 c->pixel_left = edge;
3885 c->left_col = edge / unit;
3887 else
3889 c->pixel_top = edge;
3890 c->top_line = edge / unit;
3892 window_resize_apply (c, horflag);
3893 if (!horflag)
3894 edge = edge + c->pixel_height;
3896 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3899 else if (WINDOW_HORIZONTAL_COMBINATION_P (w))
3900 /* W is a horizontal combination. */
3902 c = XWINDOW (w->contents);
3903 while (c)
3905 if (horflag)
3907 c->pixel_left = edge;
3908 c->left_col = edge / unit;
3910 else
3912 c->pixel_top = edge;
3913 c->top_line = edge / unit;
3916 window_resize_apply (c, horflag);
3917 if (horflag)
3918 edge = edge + c->pixel_width;
3920 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3923 else
3924 /* Bug#15957. */
3925 w->window_end_valid = false;
3929 /* Set w->total_lines (w->total_cols if HORFLAG) to
3930 w->new_total for window W and recursively all child windows of W.
3931 Also calculate and assign the new vertical (horizontal) start
3932 positions of each of these windows. */
3933 static void
3934 window_resize_apply_total (struct window *w, bool horflag)
3936 struct window *c;
3937 int edge;
3939 /* Note: Assigning new_normal requires that the new total size of the
3940 parent window has been set *before*. */
3941 if (horflag)
3943 w->total_cols = XFASTINT (w->new_total);
3944 edge = w->left_col;
3946 else
3948 w->total_lines = XFASTINT (w->new_total);
3949 edge = w->top_line;
3952 if (WINDOW_VERTICAL_COMBINATION_P (w))
3953 /* W is a vertical combination. */
3955 c = XWINDOW (w->contents);
3956 while (c)
3958 if (horflag)
3959 c->left_col = edge;
3960 else
3961 c->top_line = edge;
3963 window_resize_apply_total (c, horflag);
3964 if (!horflag)
3965 edge = edge + c->total_lines;
3967 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3970 else if (WINDOW_HORIZONTAL_COMBINATION_P (w))
3971 /* W is a horizontal combination. */
3973 c = XWINDOW (w->contents);
3974 while (c)
3976 if (horflag)
3977 c->left_col = edge;
3978 else
3979 c->top_line = edge;
3981 window_resize_apply_total (c, horflag);
3982 if (horflag)
3983 edge = edge + c->total_cols;
3985 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3990 DEFUN ("window-resize-apply", Fwindow_resize_apply, Swindow_resize_apply, 0, 2, 0,
3991 doc: /* Apply requested size values for window-tree of FRAME.
3992 If FRAME is omitted or nil, it defaults to the selected frame.
3994 Optional argument HORIZONTAL omitted or nil means apply requested
3995 height values. HORIZONTAL non-nil means apply requested width values.
3997 The requested size values are those set by `set-window-new-pixel' and
3998 `set-window-new-normal'. This function checks whether the requested
3999 values sum up to a valid window layout, recursively assigns the new
4000 sizes of all child windows and calculates and assigns the new start
4001 positions of these windows.
4003 Return t if the requested values have been applied correctly, nil
4004 otherwise.
4006 Note: This function does not check any of `window-fixed-size-p',
4007 `window-min-height' or `window-min-width'. All these checks have to
4008 be applied on the Elisp level. */)
4009 (Lisp_Object frame, Lisp_Object horizontal)
4011 struct frame *f = decode_live_frame (frame);
4012 struct window *r = XWINDOW (FRAME_ROOT_WINDOW (f));
4013 bool horflag = !NILP (horizontal);
4015 if (!window_resize_check (r, horflag)
4016 || (XINT (r->new_pixel)
4017 != (horflag ? r->pixel_width : r->pixel_height)))
4018 return Qnil;
4020 block_input ();
4021 window_resize_apply (r, horflag);
4023 fset_redisplay (f);
4025 adjust_frame_glyphs (f);
4026 unblock_input ();
4028 return Qt;
4032 DEFUN ("window-resize-apply-total", Fwindow_resize_apply_total, Swindow_resize_apply_total, 0, 2, 0,
4033 doc: /* Apply requested total size values for window-tree of FRAME.
4034 If FRAME is omitted or nil, it defaults to the selected frame.
4036 This function does not assign pixel or normal size values. You should
4037 have run `window-resize-apply' before running this.
4039 Optional argument HORIZONTAL omitted or nil means apply requested
4040 height values. HORIZONTAL non-nil means apply requested width
4041 values. */)
4042 (Lisp_Object frame, Lisp_Object horizontal)
4044 struct frame *f = decode_live_frame (frame);
4045 struct window *r = XWINDOW (FRAME_ROOT_WINDOW (f));
4047 block_input ();
4048 /* Necessary when deleting the top-/or leftmost window. */
4049 r->left_col = 0;
4050 r->top_line = FRAME_TOP_MARGIN (f);
4051 window_resize_apply_total (r, !NILP (horizontal));
4052 /* Handle the mini window. */
4053 if (FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
4055 struct window *m = XWINDOW (f->minibuffer_window);
4057 if (NILP (horizontal))
4059 m->top_line = r->top_line + r->total_lines;
4060 m->total_lines = XFASTINT (m->new_total);
4062 else
4063 m->total_cols = XFASTINT (m->new_total);
4066 unblock_input ();
4068 return Qt;
4072 /* Resize frame F's windows when F's width or height is set to SIZE.
4073 If HORFLAG is zero, F's width was set to SIZE, otherwise its height
4074 was set. SIZE is interpreted in F's canonical character units
4075 (a.k.a. "columns" or "lines"), unless PIXELWISE is non-zero, which
4076 means to interpret SIZE in pixel units. */
4077 void
4078 resize_frame_windows (struct frame *f, int size, bool horflag, bool pixelwise)
4080 Lisp_Object root = f->root_window;
4081 struct window *r = XWINDOW (root);
4082 Lisp_Object mini = f->minibuffer_window;
4083 struct window *m;
4084 /* old_size is the old size of the frame's root window. */
4085 int old_size = horflag ? r->total_cols : r->total_lines;
4086 int old_pixel_size = horflag ? r->pixel_width : r->pixel_height;
4087 /* new_size is the new size of the frame's root window. */
4088 int new_size, new_pixel_size;
4089 int unit = horflag ? FRAME_COLUMN_WIDTH (f) : FRAME_LINE_HEIGHT (f);
4091 /* Don't let the size drop below one unit. This is more comforting
4092 when we are called from x_set_tool_bar_lines since the latter may
4093 have implicitly given us a zero or negative height. */
4094 if (pixelwise)
4096 /* Note: This does not include the size for internal borders
4097 since these are not part of the frame's text area. */
4098 new_pixel_size = max (horflag
4099 ? size
4100 : (size
4101 - ((FRAME_HAS_MINIBUF_P (f)
4102 && !FRAME_MINIBUF_ONLY_P (f))
4103 ? FRAME_LINE_HEIGHT (f) : 0)),
4104 unit);
4105 new_size = new_pixel_size / unit;
4107 else
4109 new_size = max (size - (!horflag
4110 && FRAME_HAS_MINIBUF_P (f)
4111 && !FRAME_MINIBUF_ONLY_P (f)),
4113 new_pixel_size = new_size * unit;
4116 if (new_pixel_size == old_pixel_size
4117 && (horflag || r->pixel_top == FRAME_TOP_MARGIN_HEIGHT (f)))
4119 else if (WINDOW_LEAF_P (r))
4120 /* For a leaf root window just set the size. */
4121 if (horflag)
4123 r->total_cols = new_size;
4124 r->pixel_width = new_pixel_size;
4126 else
4128 r->top_line = FRAME_TOP_MARGIN (f);
4129 r->pixel_top = FRAME_TOP_MARGIN_HEIGHT (f);
4131 r->total_lines = new_size;
4132 r->pixel_height = new_pixel_size;
4134 else
4136 Lisp_Object delta;
4138 if (!horflag)
4140 r->top_line = FRAME_TOP_MARGIN (f);
4141 r->pixel_top = FRAME_TOP_MARGIN_HEIGHT (f);
4144 if (pixelwise)
4145 XSETINT (delta, new_pixel_size - old_pixel_size);
4146 else
4147 XSETINT (delta, new_size - old_size);
4149 /* Try a "normal" resize first. */
4150 resize_root_window (root, delta, horflag ? Qt : Qnil, Qnil,
4151 pixelwise ? Qt : Qnil);
4152 if (window_resize_check (r, horflag)
4153 && new_pixel_size == XINT (r->new_pixel))
4155 window_resize_apply (r, horflag);
4156 window_pixel_to_total (r->frame, horflag ? Qt : Qnil);
4158 else
4160 /* Try with "reasonable" minimum sizes next. */
4161 resize_root_window (root, delta, horflag ? Qt : Qnil, Qt,
4162 pixelwise ? Qt : Qnil);
4163 if (window_resize_check (r, horflag)
4164 && new_pixel_size == XINT (r->new_pixel))
4166 window_resize_apply (r, horflag);
4167 window_pixel_to_total (r->frame, horflag ? Qt : Qnil);
4172 if (FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
4174 m = XWINDOW (mini);
4175 if (horflag)
4177 m->total_cols = new_size;
4178 m->pixel_width = new_pixel_size;
4180 else
4182 /* Are we sure we always want 1 line here? */
4183 m->total_lines = 1;
4184 m->pixel_height = FRAME_LINE_HEIGHT (f);
4185 m->top_line = r->top_line + r->total_lines;
4186 m->pixel_top = r->pixel_top + r->pixel_height;
4190 fset_redisplay (f);
4194 DEFUN ("split-window-internal", Fsplit_window_internal, Ssplit_window_internal, 4, 4, 0,
4195 doc: /* Split window OLD.
4196 Second argument PIXEL-SIZE specifies the number of pixels of the
4197 new window. It must be a positive integer.
4199 Third argument SIDE nil (or `below') specifies that the new window shall
4200 be located below WINDOW. SIDE `above' means the new window shall be
4201 located above WINDOW. In both cases PIXEL-SIZE specifies the pixel
4202 height of the new window including space reserved for the mode and/or
4203 header line.
4205 SIDE t (or `right') specifies that the new window shall be located on
4206 the right side of WINDOW. SIDE `left' means the new window shall be
4207 located on the left of WINDOW. In both cases PIXEL-SIZE specifies the
4208 width of the new window including space reserved for fringes and the
4209 scrollbar or a divider column.
4211 Fourth argument NORMAL-SIZE specifies the normal size of the new window
4212 according to the SIDE argument.
4214 The new pixel and normal sizes of all involved windows must have been
4215 set correctly. See the code of `split-window' for how this is done. */)
4216 (Lisp_Object old, Lisp_Object pixel_size, Lisp_Object side, Lisp_Object normal_size)
4218 /* OLD (*o) is the window we have to split. (*p) is either OLD's
4219 parent window or an internal window we have to install as OLD's new
4220 parent. REFERENCE (*r) must denote a live window, or is set to OLD
4221 provided OLD is a leaf window, or to the frame's selected window.
4222 NEW (*n) is the new window created with some parameters taken from
4223 REFERENCE (*r). */
4224 Lisp_Object new, frame, reference;
4225 struct window *o, *p, *n, *r, *c;
4226 struct frame *f;
4227 bool horflag
4228 /* HORFLAG is true when we split side-by-side, false otherwise. */
4229 = EQ (side, Qt) || EQ (side, Qleft) || EQ (side, Qright);
4231 CHECK_WINDOW (old);
4232 o = XWINDOW (old);
4233 frame = WINDOW_FRAME (o);
4234 f = XFRAME (frame);
4236 CHECK_NUMBER (pixel_size);
4237 EMACS_INT total_size
4238 = XINT (pixel_size) / (horflag
4239 ? FRAME_COLUMN_WIDTH (f)
4240 : FRAME_LINE_HEIGHT (f));
4242 /* Set combination_limit if we have to make a new parent window.
4243 We do that if either `window-combination-limit' is t, or OLD has no
4244 parent, or OLD is ortho-combined. */
4245 bool combination_limit
4246 = (EQ (Vwindow_combination_limit, Qt)
4247 || NILP (o->parent)
4248 || (horflag
4249 ? WINDOW_VERTICAL_COMBINATION_P (XWINDOW (o->parent))
4250 : WINDOW_HORIZONTAL_COMBINATION_P (XWINDOW (o->parent))));
4252 /* We need a live reference window to initialize some parameters. */
4253 if (WINDOW_LIVE_P (old))
4254 /* OLD is live, use it as reference window. */
4255 reference = old;
4256 else
4257 /* Use the frame's selected window as reference window. */
4258 reference = FRAME_SELECTED_WINDOW (f);
4259 r = XWINDOW (reference);
4261 /* The following bugs are caught by `split-window'. */
4262 if (MINI_WINDOW_P (o))
4263 error ("Attempt to split minibuffer window");
4264 else if (total_size < (horflag ? 2 : 1))
4265 error ("Size of new window too small (after split)");
4266 else if (!combination_limit && !NILP (Vwindow_combination_resize))
4267 /* `window-combination-resize' non-nil means try to resize OLD's siblings
4268 proportionally. */
4270 p = XWINDOW (o->parent);
4271 /* Temporarily pretend we split the parent window. */
4272 wset_new_pixel
4273 (p, make_number ((horflag ? p->pixel_width : p->pixel_height)
4274 - XINT (pixel_size)));
4275 if (!window_resize_check (p, horflag))
4276 error ("Window sizes don't fit");
4277 else
4278 /* Undo the temporary pretension. */
4279 wset_new_pixel (p, make_number (horflag ? p->pixel_width : p->pixel_height));
4281 else
4283 if (!window_resize_check (o, horflag))
4284 error ("Resizing old window failed");
4285 else if (XINT (pixel_size) + XINT (o->new_pixel)
4286 != (horflag ? o->pixel_width : o->pixel_height))
4287 error ("Sum of sizes of old and new window don't fit");
4290 /* This is our point of no return. */
4291 if (combination_limit)
4293 /* Save the old value of o->normal_cols/lines. It gets corrupted
4294 by make_parent_window and we need it below for assigning it to
4295 p->new_normal. */
4296 Lisp_Object new_normal
4297 = horflag ? o->normal_cols : o->normal_lines;
4299 make_parent_window (old, horflag);
4300 p = XWINDOW (o->parent);
4301 if (EQ (Vwindow_combination_limit, Qt))
4302 /* Store t in the new parent's combination_limit slot to avoid
4303 that its children get merged into another window. */
4304 wset_combination_limit (p, Qt);
4305 /* These get applied below. */
4306 wset_new_pixel
4307 (p, make_number (horflag ? o->pixel_width : o->pixel_height));
4308 wset_new_total
4309 (p, make_number (horflag ? o->total_cols : o->total_lines));
4310 wset_new_normal (p, new_normal);
4312 else
4313 p = XWINDOW (o->parent);
4315 fset_redisplay (f);
4316 new = make_window ();
4317 n = XWINDOW (new);
4318 wset_frame (n, frame);
4319 wset_parent (n, o->parent);
4321 if (EQ (side, Qabove) || EQ (side, Qleft))
4323 wset_prev (n, o->prev);
4324 if (NILP (n->prev))
4325 wset_combination (p, horflag, new);
4326 else
4327 wset_next (XWINDOW (n->prev), new);
4328 wset_next (n, old);
4329 wset_prev (o, new);
4331 else
4333 wset_next (n, o->next);
4334 if (!NILP (n->next))
4335 wset_prev (XWINDOW (n->next), new);
4336 wset_prev (n, old);
4337 wset_next (o, new);
4340 n->window_end_valid = false;
4341 n->last_cursor_vpos = 0;
4343 /* Get special geometry settings from reference window. */
4344 n->left_margin_cols = r->left_margin_cols;
4345 n->right_margin_cols = r->right_margin_cols;
4346 n->left_fringe_width = r->left_fringe_width;
4347 n->right_fringe_width = r->right_fringe_width;
4348 n->fringes_outside_margins = r->fringes_outside_margins;
4349 n->scroll_bar_width = r->scroll_bar_width;
4350 n->scroll_bar_height = r->scroll_bar_height;
4351 wset_vertical_scroll_bar_type (n, r->vertical_scroll_bar_type);
4352 wset_horizontal_scroll_bar_type (n, r->horizontal_scroll_bar_type);
4354 /* Directly assign orthogonal coordinates and sizes. */
4355 if (horflag)
4357 n->pixel_top = o->pixel_top;
4358 n->top_line = o->top_line;
4359 n->pixel_height = o->pixel_height;
4360 n->total_lines = o->total_lines;
4362 else
4364 n->pixel_left = o->pixel_left;
4365 n->left_col = o->left_col;
4366 n->pixel_width = o->pixel_width;
4367 n->total_cols = o->total_cols;
4370 /* Iso-coordinates and sizes are assigned by window_resize_apply,
4371 get them ready here. */
4372 wset_new_pixel (n, pixel_size);
4373 EMACS_INT sum = 0;
4374 c = XWINDOW (p->contents);
4375 while (c)
4377 if (c != n)
4378 sum = sum + XINT (c->new_total);
4379 c = NILP (c->next) ? 0 : XWINDOW (c->next);
4381 wset_new_total (n, make_number ((horflag
4382 ? p->total_cols
4383 : p->total_lines)
4384 - sum));
4385 wset_new_normal (n, normal_size);
4387 block_input ();
4388 window_resize_apply (p, horflag);
4389 adjust_frame_glyphs (f);
4390 /* Set buffer of NEW to buffer of reference window. Don't run
4391 any hooks. */
4392 set_window_buffer (new, r->contents, false, true);
4393 unblock_input ();
4395 /* Maybe we should run the scroll functions in Elisp (which already
4396 runs the configuration change hook). */
4397 if (! NILP (Vwindow_scroll_functions))
4398 run_hook_with_args_2 (Qwindow_scroll_functions, new,
4399 Fmarker_position (n->start));
4400 /* Return NEW. */
4401 return new;
4405 DEFUN ("delete-window-internal", Fdelete_window_internal, Sdelete_window_internal, 1, 1, 0,
4406 doc: /* Remove WINDOW from its frame.
4407 WINDOW defaults to the selected window. Return nil.
4408 Signal an error when WINDOW is the only window on its frame. */)
4409 (Lisp_Object window)
4411 Lisp_Object parent, sibling, frame, root;
4412 struct window *w, *p, *s, *r;
4413 struct frame *f;
4414 bool horflag, before_sibling = false;
4416 w = decode_any_window (window);
4417 XSETWINDOW (window, w);
4418 if (NILP (w->contents))
4419 /* It's a no-op to delete an already deleted window. */
4420 return Qnil;
4422 parent = w->parent;
4423 if (NILP (parent))
4424 /* Never delete a minibuffer or frame root window. */
4425 error ("Attempt to delete minibuffer or sole ordinary window");
4426 else if (NILP (w->prev) && NILP (w->next))
4427 /* Rather bow out here, this case should be handled on the Elisp
4428 level. */
4429 error ("Attempt to delete sole window of parent");
4431 p = XWINDOW (parent);
4432 horflag = WINDOW_HORIZONTAL_COMBINATION_P (p);
4434 frame = WINDOW_FRAME (w);
4435 f = XFRAME (frame);
4437 root = FRAME_ROOT_WINDOW (f);
4438 r = XWINDOW (root);
4440 /* Unlink WINDOW from window tree. */
4441 if (NILP (w->prev))
4442 /* Get SIBLING below (on the right of) WINDOW. */
4444 /* before_sibling means WINDOW is the first child of its
4445 parent and thus before the sibling. */
4446 before_sibling = true;
4447 sibling = w->next;
4448 s = XWINDOW (sibling);
4449 wset_prev (s, Qnil);
4450 wset_combination (p, horflag, sibling);
4452 else
4453 /* Get SIBLING above (on the left of) WINDOW. */
4455 sibling = w->prev;
4456 s = XWINDOW (sibling);
4457 wset_next (s, w->next);
4458 if (!NILP (s->next))
4459 wset_prev (XWINDOW (s->next), sibling);
4462 if (window_resize_check (r, horflag)
4463 && (XINT (r->new_pixel)
4464 == (horflag ? r->pixel_width : r->pixel_height)))
4465 /* We can delete WINDOW now. */
4468 /* Block input. */
4469 block_input ();
4470 xwidget_view_delete_all_in_window (w);
4471 window_resize_apply (p, horflag);
4472 /* If this window is referred to by the dpyinfo's mouse
4473 highlight, invalidate that slot to be safe (Bug#9904). */
4474 if (!FRAME_INITIAL_P (f))
4476 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
4478 if (EQ (hlinfo->mouse_face_window, window))
4479 hlinfo->mouse_face_window = Qnil;
4482 fset_redisplay (f);
4483 Vwindow_list = Qnil;
4485 wset_next (w, Qnil); /* Don't delete w->next too. */
4486 free_window_matrices (w);
4488 if (WINDOWP (w->contents))
4490 delete_all_child_windows (w->contents);
4491 wset_combination (w, false, Qnil);
4493 else
4495 unshow_buffer (w);
4496 unchain_marker (XMARKER (w->pointm));
4497 unchain_marker (XMARKER (w->old_pointm));
4498 unchain_marker (XMARKER (w->start));
4499 wset_buffer (w, Qnil);
4502 if (NILP (s->prev) && NILP (s->next))
4503 /* A matrjoshka where SIBLING has become the only child of
4504 PARENT. */
4506 /* Put SIBLING into PARENT's place. */
4507 replace_window (parent, sibling, false);
4508 /* Have SIBLING inherit the following three slot values from
4509 PARENT (the combination_limit slot is not inherited). */
4510 wset_normal_cols (s, p->normal_cols);
4511 wset_normal_lines (s, p->normal_lines);
4512 /* Mark PARENT as deleted. */
4513 wset_combination (p, false, Qnil);
4514 /* Try to merge SIBLING into its new parent. */
4515 recombine_windows (sibling);
4518 adjust_frame_glyphs (f);
4520 if (!WINDOW_LIVE_P (FRAME_SELECTED_WINDOW (f)))
4521 /* We deleted the frame's selected window. */
4523 /* Use the frame's first window as fallback ... */
4524 Lisp_Object new_selected_window = Fframe_first_window (frame);
4525 /* ... but preferably use its most recently used window. */
4526 Lisp_Object mru_window;
4528 /* `get-mru-window' might fail for some reason so play it safe
4529 - promote the first window _without recording it_ first. */
4530 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
4531 Fselect_window (new_selected_window, Qt);
4532 else
4533 fset_selected_window (f, new_selected_window);
4535 unblock_input ();
4537 /* Now look whether `get-mru-window' gets us something. */
4538 mru_window = call1 (Qget_mru_window, frame);
4539 if (WINDOW_LIVE_P (mru_window)
4540 && EQ (XWINDOW (mru_window)->frame, frame))
4541 new_selected_window = mru_window;
4543 /* If all ended up well, we now promote the mru window. */
4544 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
4545 Fselect_window (new_selected_window, Qnil);
4546 else
4547 fset_selected_window (f, new_selected_window);
4549 else
4550 unblock_input ();
4552 else
4553 /* We failed: Relink WINDOW into window tree. */
4555 if (before_sibling)
4557 wset_prev (s, window);
4558 wset_combination (p, horflag, window);
4560 else
4562 wset_next (s, window);
4563 if (!NILP (w->next))
4564 wset_prev (XWINDOW (w->next), window);
4566 error ("Deletion failed");
4569 return Qnil;
4572 /***********************************************************************
4573 Resizing Mini-Windows
4574 ***********************************************************************/
4576 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we
4577 can. */
4578 void
4579 grow_mini_window (struct window *w, int delta, bool pixelwise)
4581 struct frame *f = XFRAME (w->frame);
4582 struct window *r;
4583 Lisp_Object root, height;
4584 int line_height, pixel_height;
4586 eassert (MINI_WINDOW_P (w));
4587 eassert (delta >= 0);
4589 if (delta > 0)
4591 root = FRAME_ROOT_WINDOW (f);
4592 r = XWINDOW (root);
4593 height = call3 (Qwindow__resize_root_window_vertically,
4594 root, make_number (- delta), pixelwise ? Qt : Qnil);
4595 if (INTEGERP (height) && window_resize_check (r, false))
4597 block_input ();
4598 window_resize_apply (r, false);
4600 if (pixelwise)
4602 pixel_height = min (-XINT (height), INT_MAX - w->pixel_height);
4603 line_height = pixel_height / FRAME_LINE_HEIGHT (f);
4605 else
4607 line_height = min (-XINT (height),
4608 ((INT_MAX - w->pixel_height)
4609 / FRAME_LINE_HEIGHT (f)));
4610 pixel_height = line_height * FRAME_LINE_HEIGHT (f);
4613 /* Grow the mini-window. */
4614 w->pixel_top = r->pixel_top + r->pixel_height;
4615 w->top_line = r->top_line + r->total_lines;
4616 /* Make sure the mini-window has always at least one line. */
4617 w->pixel_height = max (w->pixel_height + pixel_height,
4618 FRAME_LINE_HEIGHT (f));
4619 w->total_lines = max (w->total_lines + line_height, 1);
4621 /* Enforce full redisplay of the frame. */
4622 /* FIXME: Shouldn't window--resize-root-window-vertically do it? */
4623 fset_redisplay (f);
4624 adjust_frame_glyphs (f);
4625 unblock_input ();
4627 else
4628 error ("Failed to grow minibuffer window");
4633 /* Shrink mini-window W to one line. */
4634 void
4635 shrink_mini_window (struct window *w, bool pixelwise)
4637 struct frame *f = XFRAME (w->frame);
4638 struct window *r;
4639 Lisp_Object root, delta;
4640 EMACS_INT height, unit;
4642 eassert (MINI_WINDOW_P (w));
4644 height = pixelwise ? w->pixel_height : w->total_lines;
4645 unit = pixelwise ? FRAME_LINE_HEIGHT (f) : 1;
4646 if (height > unit)
4648 root = FRAME_ROOT_WINDOW (f);
4649 r = XWINDOW (root);
4650 delta = call3 (Qwindow__resize_root_window_vertically,
4651 root, make_number (height - unit),
4652 pixelwise ? Qt : Qnil);
4653 if (INTEGERP (delta) && window_resize_check (r, false))
4655 block_input ();
4656 window_resize_apply (r, false);
4658 /* Shrink the mini-window. */
4659 w->top_line = r->top_line + r->total_lines;
4660 w->total_lines = 1;
4661 w->pixel_top = r->pixel_top + r->pixel_height;
4662 w->pixel_height = FRAME_LINE_HEIGHT (f);
4663 /* Enforce full redisplay of the frame. */
4664 /* FIXME: Shouldn't window--resize-root-window-vertically do it? */
4665 fset_redisplay (f);
4666 adjust_frame_glyphs (f);
4667 unblock_input ();
4669 /* If the above failed for whatever strange reason we must make a
4670 one window frame here. The same routine will be needed when
4671 shrinking the frame (and probably when making the initial
4672 *scratch* window). For the moment leave things as they are. */
4673 else
4674 error ("Failed to shrink minibuffer window");
4678 DEFUN ("resize-mini-window-internal", Fresize_mini_window_internal, Sresize_mini_window_internal, 1, 1, 0,
4679 doc: /* Resize minibuffer window WINDOW. */)
4680 (Lisp_Object window)
4682 struct window *w = XWINDOW (window);
4683 struct window *r;
4684 struct frame *f;
4685 int height;
4687 CHECK_WINDOW (window);
4688 f = XFRAME (w->frame);
4690 if (!EQ (FRAME_MINIBUF_WINDOW (XFRAME (w->frame)), window))
4691 error ("Not a valid minibuffer window");
4692 else if (FRAME_MINIBUF_ONLY_P (f))
4693 error ("Cannot resize a minibuffer-only frame");
4695 r = XWINDOW (FRAME_ROOT_WINDOW (f));
4696 height = r->pixel_height + w->pixel_height;
4697 if (window_resize_check (r, false)
4698 && XINT (w->new_pixel) > 0
4699 && height == XINT (r->new_pixel) + XINT (w->new_pixel))
4701 block_input ();
4702 window_resize_apply (r, false);
4704 w->pixel_height = XFASTINT (w->new_pixel);
4705 w->total_lines = w->pixel_height / FRAME_LINE_HEIGHT (f);
4706 w->pixel_top = r->pixel_top + r->pixel_height;
4707 w->top_line = r->top_line + r->total_lines;
4709 fset_redisplay (f);
4710 adjust_frame_glyphs (f);
4711 unblock_input ();
4712 return Qt;
4714 else
4715 error ("Failed to resize minibuffer window");
4718 /* Mark window cursors off for all windows in the window tree rooted
4719 at W by setting their phys_cursor_on_p flag to zero. Called from
4720 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4721 the frame are cleared. */
4723 void
4724 mark_window_cursors_off (struct window *w)
4726 while (w)
4728 if (WINDOWP (w->contents))
4729 mark_window_cursors_off (XWINDOW (w->contents));
4730 else
4731 w->phys_cursor_on_p = false;
4733 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4738 /* Return number of lines of text (not counting mode lines) in W. */
4741 window_internal_height (struct window *w)
4743 int ht = w->total_lines;
4745 if (!MINI_WINDOW_P (w))
4747 if (!NILP (w->parent)
4748 || WINDOWP (w->contents)
4749 || !NILP (w->next)
4750 || !NILP (w->prev)
4751 || WINDOW_WANTS_MODELINE_P (w))
4752 --ht;
4754 if (WINDOW_WANTS_HEADER_LINE_P (w))
4755 --ht;
4758 return ht;
4762 /************************************************************************
4763 Window Scrolling
4764 ***********************************************************************/
4766 /* Scroll contents of window WINDOW up. If WHOLE, scroll
4767 N screen-fulls, which is defined as the height of the window minus
4768 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4769 instead. Negative values of N mean scroll down. NOERROR
4770 means don't signal an error if we try to move over BEGV or ZV,
4771 respectively. */
4773 static void
4774 window_scroll (Lisp_Object window, EMACS_INT n, bool whole, bool noerror)
4776 ptrdiff_t count = SPECPDL_INDEX ();
4778 immediate_quit = true;
4779 n = clip_to_bounds (INT_MIN, n, INT_MAX);
4781 wset_redisplay (XWINDOW (window));
4783 if (whole && Vfast_but_imprecise_scrolling)
4784 specbind (Qfontification_functions, Qnil);
4786 /* If we must, use the pixel-based version which is much slower than
4787 the line-based one but can handle varying line heights. */
4788 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4789 window_scroll_pixel_based (window, n, whole, noerror);
4790 else
4791 window_scroll_line_based (window, n, whole, noerror);
4793 unbind_to (count, Qnil);
4795 /* Bug#15957. */
4796 XWINDOW (window)->window_end_valid = false;
4797 immediate_quit = false;
4801 /* Implementation of window_scroll that works based on pixel line
4802 heights. See the comment of window_scroll for parameter
4803 descriptions. */
4805 static void
4806 window_scroll_pixel_based (Lisp_Object window, int n, bool whole, bool noerror)
4808 struct it it;
4809 struct window *w = XWINDOW (window);
4810 struct text_pos start;
4811 int this_scroll_margin;
4812 /* True if we fiddled the window vscroll field without really scrolling. */
4813 bool vscrolled = false;
4814 int x, y, rtop, rbot, rowh, vpos;
4815 void *itdata = NULL;
4816 int window_total_lines;
4817 int frame_line_height = default_line_pixel_height (w);
4818 bool adjust_old_pointm = !NILP (Fequal (Fwindow_point (window),
4819 Fwindow_old_point (window)));
4821 SET_TEXT_POS_FROM_MARKER (start, w->start);
4822 /* Scrolling a minibuffer window via scroll bar when the echo area
4823 shows long text sometimes resets the minibuffer contents behind
4824 our backs. */
4825 if (CHARPOS (start) > ZV)
4826 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
4828 /* If PT is not visible in WINDOW, move back one half of
4829 the screen. Allow PT to be partially visible, otherwise
4830 something like (scroll-down 1) with PT in the line before
4831 the partially visible one would recenter. */
4833 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
4835 itdata = bidi_shelve_cache ();
4836 /* Move backward half the height of the window. Performance note:
4837 vmotion used here is about 10% faster, but would give wrong
4838 results for variable height lines. */
4839 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4840 it.current_y = it.last_visible_y;
4841 move_it_vertically_backward (&it, window_box_height (w) / 2);
4843 /* The function move_iterator_vertically may move over more than
4844 the specified y-distance. If it->w is small, e.g. a
4845 mini-buffer window, we may end up in front of the window's
4846 display area. Start displaying at the start of the line
4847 containing PT in this case. */
4848 if (it.current_y <= 0)
4850 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4851 move_it_vertically_backward (&it, 0);
4852 it.current_y = 0;
4855 start = it.current.pos;
4856 bidi_unshelve_cache (itdata, false);
4858 else if (auto_window_vscroll_p)
4860 if (rtop || rbot) /* Partially visible. */
4862 int px;
4863 int dy = frame_line_height;
4864 /* In the below we divide the window box height by the
4865 frame's line height to make the result predictable when
4866 the window box is not an integral multiple of the line
4867 height. This is important to ensure we get back to the
4868 same position when scrolling up, then down. */
4869 if (whole)
4870 dy = max ((window_box_height (w) / dy
4871 - next_screen_context_lines) * dy,
4872 dy);
4873 dy *= n;
4875 if (n < 0)
4877 /* Only vscroll backwards if already vscrolled forwards. */
4878 if (w->vscroll < 0 && rtop > 0)
4880 px = max (0, -w->vscroll - min (rtop, -dy));
4881 Fset_window_vscroll (window, make_number (px), Qt);
4882 return;
4885 if (n > 0)
4887 /* Do vscroll if already vscrolled or only display line. */
4888 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
4890 px = max (0, -w->vscroll + min (rbot, dy));
4891 Fset_window_vscroll (window, make_number (px), Qt);
4892 return;
4895 /* Maybe modify window start instead of scrolling. */
4896 if (rbot > 0 || w->vscroll < 0)
4898 ptrdiff_t spos;
4900 Fset_window_vscroll (window, make_number (0), Qt);
4901 /* If there are other text lines above the current row,
4902 move window start to current row. Else to next row. */
4903 if (rbot > 0)
4904 spos = XINT (Fline_beginning_position (Qnil));
4905 else
4906 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
4907 set_marker_restricted (w->start, make_number (spos),
4908 w->contents);
4909 w->start_at_line_beg = true;
4910 wset_update_mode_line (w);
4911 /* Set force_start so that redisplay_window will run the
4912 window-scroll-functions. */
4913 w->force_start = true;
4914 return;
4918 /* Cancel previous vscroll. */
4919 Fset_window_vscroll (window, make_number (0), Qt);
4922 itdata = bidi_shelve_cache ();
4923 /* If scroll_preserve_screen_position is non-nil, we try to set
4924 point in the same window line as it is now, so get that line. */
4925 if (!NILP (Vscroll_preserve_screen_position))
4927 /* We preserve the goal pixel coordinate across consecutive
4928 calls to scroll-up, scroll-down and other commands that
4929 have the `scroll-command' property. This avoids the
4930 possibility of point becoming "stuck" on a tall line when
4931 scrolling by one line. */
4932 if (window_scroll_pixel_based_preserve_y < 0
4933 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4934 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4936 start_display (&it, w, start);
4937 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4938 window_scroll_pixel_based_preserve_y = it.current_y;
4939 window_scroll_pixel_based_preserve_x = it.current_x;
4942 else
4943 window_scroll_pixel_based_preserve_y
4944 = window_scroll_pixel_based_preserve_x = -1;
4946 /* Move iterator it from start the specified distance forward or
4947 backward. The result is the new window start. */
4948 start_display (&it, w, start);
4949 if (whole)
4951 ptrdiff_t start_pos = IT_CHARPOS (it);
4952 int dy = frame_line_height;
4953 /* In the below we divide the window box height by the frame's
4954 line height to make the result predictable when the window
4955 box is not an integral multiple of the line height. This is
4956 important to ensure we get back to the same position when
4957 scrolling up, then down. */
4958 dy = max ((window_box_height (w) / dy - next_screen_context_lines) * dy,
4959 dy) * n;
4961 /* Note that move_it_vertically always moves the iterator to the
4962 start of a line. So, if the last line doesn't have a newline,
4963 we would end up at the start of the line ending at ZV. */
4964 if (dy <= 0)
4966 move_it_vertically_backward (&it, -dy);
4967 /* Ensure we actually do move, e.g. in case we are currently
4968 looking at an image that is taller that the window height. */
4969 while (start_pos == IT_CHARPOS (it)
4970 && start_pos > BEGV)
4971 move_it_by_lines (&it, -1);
4973 else if (dy > 0)
4975 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4976 MOVE_TO_POS | MOVE_TO_Y);
4977 /* Ensure we actually do move, e.g. in case we are currently
4978 looking at an image that is taller that the window height. */
4979 while (start_pos == IT_CHARPOS (it)
4980 && start_pos < ZV)
4981 move_it_by_lines (&it, 1);
4984 else
4985 move_it_by_lines (&it, n);
4987 /* We failed if we find ZV is already on the screen (scrolling up,
4988 means there's nothing past the end), or if we can't start any
4989 earlier (scrolling down, means there's nothing past the top). */
4990 if ((n > 0 && IT_CHARPOS (it) == ZV)
4991 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4993 if (IT_CHARPOS (it) == ZV)
4995 if (it.current_y < it.last_visible_y
4996 && (it.current_y + it.max_ascent + it.max_descent
4997 > it.last_visible_y))
4999 /* The last line was only partially visible, make it fully
5000 visible. */
5001 w->vscroll = (it.last_visible_y
5002 - it.current_y + it.max_ascent + it.max_descent);
5003 adjust_frame_glyphs (it.f);
5005 else
5007 bidi_unshelve_cache (itdata, false);
5008 if (noerror)
5009 return;
5010 else if (n < 0) /* could happen with empty buffers */
5011 xsignal0 (Qbeginning_of_buffer);
5012 else
5013 xsignal0 (Qend_of_buffer);
5016 else
5018 if (w->vscroll != 0)
5019 /* The first line was only partially visible, make it fully
5020 visible. */
5021 w->vscroll = 0;
5022 else
5024 bidi_unshelve_cache (itdata, false);
5025 if (noerror)
5026 return;
5027 else
5028 xsignal0 (Qbeginning_of_buffer);
5032 /* If control gets here, then we vscrolled. */
5034 XBUFFER (w->contents)->prevent_redisplay_optimizations_p = true;
5036 /* Don't try to change the window start below. */
5037 vscrolled = true;
5040 if (! vscrolled)
5042 ptrdiff_t pos = IT_CHARPOS (it);
5043 ptrdiff_t bytepos;
5045 /* If in the middle of a multi-glyph character move forward to
5046 the next character. */
5047 if (in_display_vector_p (&it))
5049 ++pos;
5050 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
5053 /* Set the window start, and set up the window for redisplay. */
5054 set_marker_restricted_both (w->start, w->contents, IT_CHARPOS (it),
5055 IT_BYTEPOS (it));
5056 bytepos = marker_byte_position (w->start);
5057 w->start_at_line_beg = (pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n');
5058 wset_update_mode_line (w);
5059 /* Set force_start so that redisplay_window will run the
5060 window-scroll-functions. */
5061 w->force_start = true;
5064 /* The rest of this function uses current_y in a nonstandard way,
5065 not including the height of the header line if any. */
5066 it.current_y = it.vpos = 0;
5068 /* Move PT out of scroll margins.
5069 This code wants current_y to be zero at the window start position
5070 even if there is a header line. */
5071 window_total_lines
5072 = w->total_lines * WINDOW_FRAME_LINE_HEIGHT (w) / frame_line_height;
5073 this_scroll_margin = max (0, scroll_margin);
5074 this_scroll_margin
5075 = min (this_scroll_margin, window_total_lines / 4);
5076 this_scroll_margin *= frame_line_height;
5078 if (n > 0)
5080 int last_y = it.last_visible_y - this_scroll_margin - 1;
5082 /* We moved the window start towards ZV, so PT may be now
5083 in the scroll margin at the top. */
5084 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
5085 if (IT_CHARPOS (it) == PT
5086 && it.current_y >= this_scroll_margin
5087 && it.current_y <= last_y - WINDOW_HEADER_LINE_HEIGHT (w)
5088 && (NILP (Vscroll_preserve_screen_position)
5089 || EQ (Vscroll_preserve_screen_position, Qt)))
5090 /* We found PT at a legitimate height. Leave it alone. */
5092 else
5094 if (window_scroll_pixel_based_preserve_y >= 0)
5096 /* Don't enter the scroll margin at the end of the window. */
5097 int goal_y = min (last_y, window_scroll_pixel_based_preserve_y);
5099 /* If we have a header line, take account of it. This
5100 is necessary because we set it.current_y to 0, above. */
5101 move_it_to (&it, -1,
5102 window_scroll_pixel_based_preserve_x,
5103 goal_y - WINDOW_HEADER_LINE_HEIGHT (w),
5104 -1, MOVE_TO_Y | MOVE_TO_X);
5107 /* Get out of the scroll margin at the top of the window. */
5108 while (it.current_y < this_scroll_margin)
5110 int prev = it.current_y;
5111 move_it_by_lines (&it, 1);
5112 if (prev == it.current_y)
5113 break;
5115 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5118 else if (n < 0)
5120 ptrdiff_t charpos, bytepos;
5121 bool partial_p;
5123 /* Save our position, for the
5124 window_scroll_pixel_based_preserve_y case. */
5125 charpos = IT_CHARPOS (it);
5126 bytepos = IT_BYTEPOS (it);
5128 /* We moved the window start towards BEGV, so PT may be now
5129 in the scroll margin at the bottom. */
5130 move_it_to (&it, PT, -1,
5131 (it.last_visible_y - WINDOW_HEADER_LINE_HEIGHT (w)
5132 - this_scroll_margin - 1),
5134 MOVE_TO_POS | MOVE_TO_Y);
5136 /* Save our position, in case it's correct. */
5137 charpos = IT_CHARPOS (it);
5138 bytepos = IT_BYTEPOS (it);
5140 /* If PT is in the screen line at the last fully visible line,
5141 move_it_to will stop at X = 0 in that line, because the
5142 required Y coordinate is reached there. See if we can get to
5143 PT without descending lower in Y, and if we can, it means we
5144 reached PT before the scroll margin. */
5145 if (charpos != PT)
5147 struct it it2;
5148 void *it_data;
5150 it2 = it;
5151 it_data = bidi_shelve_cache ();
5152 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
5153 if (IT_CHARPOS (it) == PT && it.current_y == it2.current_y)
5155 charpos = IT_CHARPOS (it);
5156 bytepos = IT_BYTEPOS (it);
5157 bidi_unshelve_cache (it_data, true);
5159 else
5161 it = it2;
5162 bidi_unshelve_cache (it_data, false);
5166 /* See if point is on a partially visible line at the end. */
5167 if (it.what == IT_EOB)
5168 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
5169 else
5171 move_it_by_lines (&it, 1);
5172 partial_p = it.current_y > it.last_visible_y;
5175 if (charpos == PT && !partial_p
5176 && (NILP (Vscroll_preserve_screen_position)
5177 || EQ (Vscroll_preserve_screen_position, Qt)))
5178 /* We found PT before we found the display margin, so PT is ok. */
5180 else if (window_scroll_pixel_based_preserve_y >= 0)
5182 int goal_y = min (it.last_visible_y - this_scroll_margin - 1,
5183 window_scroll_pixel_based_preserve_y);
5185 /* Don't let the preserved screen Y coordinate put us inside
5186 any of the two margins. */
5187 if (goal_y < this_scroll_margin)
5188 goal_y = this_scroll_margin;
5189 SET_TEXT_POS_FROM_MARKER (start, w->start);
5190 start_display (&it, w, start);
5191 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
5192 here because we called start_display again and did not
5193 alter it.current_y this time. */
5194 move_it_to (&it, -1, window_scroll_pixel_based_preserve_x,
5195 goal_y, -1, MOVE_TO_Y | MOVE_TO_X);
5196 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5198 else
5200 if (partial_p)
5201 /* The last line was only partially visible, so back up two
5202 lines to make sure we're on a fully visible line. */
5204 move_it_by_lines (&it, -2);
5205 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5207 else
5208 /* No, the position we saved is OK, so use it. */
5209 SET_PT_BOTH (charpos, bytepos);
5212 bidi_unshelve_cache (itdata, false);
5214 if (adjust_old_pointm)
5215 Fset_marker (w->old_pointm,
5216 ((w == XWINDOW (selected_window))
5217 ? make_number (BUF_PT (XBUFFER (w->contents)))
5218 : Fmarker_position (w->pointm)),
5219 w->contents);
5223 /* Implementation of window_scroll that works based on screen lines.
5224 See the comment of window_scroll for parameter descriptions. */
5226 static void
5227 window_scroll_line_based (Lisp_Object window, int n, bool whole, bool noerror)
5229 struct window *w = XWINDOW (window);
5230 /* Fvertical_motion enters redisplay, which can trigger
5231 fontification, which in turn can modify buffer text (e.g., if the
5232 fontification functions replace escape sequences with faces, as
5233 in `grep-mode-font-lock-keywords'). So we use a marker to record
5234 the old point position, to prevent crashes in SET_PT_BOTH. */
5235 Lisp_Object opoint_marker = Fpoint_marker ();
5236 register ptrdiff_t pos, pos_byte;
5237 register int ht = window_internal_height (w);
5238 register Lisp_Object tem;
5239 bool lose;
5240 Lisp_Object bolp;
5241 ptrdiff_t startpos = marker_position (w->start);
5242 ptrdiff_t startbyte = marker_byte_position (w->start);
5243 Lisp_Object original_pos = Qnil;
5244 bool adjust_old_pointm = !NILP (Fequal (Fwindow_point (window),
5245 Fwindow_old_point (window)));
5247 /* If scrolling screen-fulls, compute the number of lines to
5248 scroll from the window's height. */
5249 if (whole)
5250 n *= max (1, ht - next_screen_context_lines);
5252 if (!NILP (Vscroll_preserve_screen_position))
5254 if (window_scroll_preserve_vpos <= 0
5255 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
5256 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
5258 struct position posit
5259 = *compute_motion (startpos, startbyte, 0, 0, false,
5260 PT, ht, 0, -1, w->hscroll, 0, w);
5262 window_scroll_preserve_vpos = posit.vpos;
5263 window_scroll_preserve_hpos = posit.hpos + w->hscroll;
5266 original_pos = Fcons (make_number (window_scroll_preserve_hpos),
5267 make_number (window_scroll_preserve_vpos));
5270 XSETFASTINT (tem, PT);
5271 tem = Fpos_visible_in_window_p (tem, window, Qnil);
5273 if (NILP (tem))
5275 Fvertical_motion (make_number (- (ht / 2)), window, Qnil);
5276 startpos = PT;
5277 startbyte = PT_BYTE;
5280 SET_PT_BOTH (startpos, startbyte);
5281 lose = n < 0 && PT == BEGV;
5282 Fvertical_motion (make_number (n), window, Qnil);
5283 pos = PT;
5284 pos_byte = PT_BYTE;
5285 bolp = Fbolp ();
5286 SET_PT_BOTH (marker_position (opoint_marker),
5287 marker_byte_position (opoint_marker));
5289 if (lose)
5291 if (noerror)
5292 return;
5293 else
5294 xsignal0 (Qbeginning_of_buffer);
5297 if (pos < ZV)
5299 /* Don't use a scroll margin that is negative or too large. */
5300 int this_scroll_margin =
5301 max (0, min (scroll_margin, w->total_lines / 4));
5303 set_marker_restricted_both (w->start, w->contents, pos, pos_byte);
5304 w->start_at_line_beg = !NILP (bolp);
5305 wset_update_mode_line (w);
5306 /* Set force_start so that redisplay_window will run
5307 the window-scroll-functions. */
5308 w->force_start = true;
5310 if (!NILP (Vscroll_preserve_screen_position)
5311 && this_scroll_margin == 0
5312 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
5314 SET_PT_BOTH (pos, pos_byte);
5315 Fvertical_motion (original_pos, window, Qnil);
5317 /* If we scrolled forward, put point enough lines down
5318 that it is outside the scroll margin. */
5319 else if (n > 0)
5321 int top_margin;
5323 if (this_scroll_margin > 0)
5325 SET_PT_BOTH (pos, pos_byte);
5326 Fvertical_motion (make_number (this_scroll_margin), window, Qnil);
5327 top_margin = PT;
5329 else
5330 top_margin = pos;
5332 if (top_margin <= marker_position (opoint_marker))
5333 SET_PT_BOTH (marker_position (opoint_marker),
5334 marker_byte_position (opoint_marker));
5335 else if (!NILP (Vscroll_preserve_screen_position))
5337 int nlines = window_scroll_preserve_vpos;
5339 SET_PT_BOTH (pos, pos_byte);
5340 if (window_scroll_preserve_vpos < this_scroll_margin)
5341 nlines = this_scroll_margin;
5342 else if (window_scroll_preserve_vpos
5343 >= w->total_lines - this_scroll_margin)
5344 nlines = w->total_lines - this_scroll_margin - 1;
5345 Fvertical_motion (Fcons (make_number (window_scroll_preserve_hpos),
5346 make_number (nlines)), window, Qnil);
5348 else
5349 SET_PT (top_margin);
5351 else if (n < 0)
5353 int bottom_margin;
5355 /* If we scrolled backward, put point near the end of the window
5356 but not within the scroll margin. */
5357 SET_PT_BOTH (pos, pos_byte);
5358 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window,
5359 Qnil);
5360 if (XFASTINT (tem) == ht - this_scroll_margin)
5361 bottom_margin = PT;
5362 else
5363 bottom_margin = PT + 1;
5365 if (bottom_margin > marker_position (opoint_marker))
5366 SET_PT_BOTH (marker_position (opoint_marker),
5367 marker_byte_position (opoint_marker));
5368 else
5370 if (!NILP (Vscroll_preserve_screen_position))
5372 int nlines = window_scroll_preserve_vpos;
5374 SET_PT_BOTH (pos, pos_byte);
5375 if (window_scroll_preserve_vpos < this_scroll_margin)
5376 nlines = this_scroll_margin;
5377 else if (window_scroll_preserve_vpos
5378 >= ht - this_scroll_margin)
5379 nlines = ht - this_scroll_margin - 1;
5380 Fvertical_motion (Fcons (make_number (window_scroll_preserve_hpos),
5381 make_number (nlines)), window, Qnil);
5383 else
5384 Fvertical_motion (make_number (-1), window, Qnil);
5388 else
5390 if (noerror)
5391 return;
5392 else
5393 xsignal0 (Qend_of_buffer);
5396 if (adjust_old_pointm)
5397 Fset_marker (w->old_pointm,
5398 ((w == XWINDOW (selected_window))
5399 ? make_number (BUF_PT (XBUFFER (w->contents)))
5400 : Fmarker_position (w->pointm)),
5401 w->contents);
5405 /* Scroll selected_window up or down. If N is nil, scroll a
5406 screen-full which is defined as the height of the window minus
5407 next_screen_context_lines. If N is the symbol `-', scroll.
5408 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
5409 up. This is the guts of Fscroll_up and Fscroll_down. */
5411 static void
5412 scroll_command (Lisp_Object n, int direction)
5414 ptrdiff_t count = SPECPDL_INDEX ();
5416 eassert (eabs (direction) == 1);
5418 /* If selected window's buffer isn't current, make it current for
5419 the moment. But don't screw up if window_scroll gets an error. */
5420 if (XBUFFER (XWINDOW (selected_window)->contents) != current_buffer)
5422 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5423 Fset_buffer (XWINDOW (selected_window)->contents);
5426 if (NILP (n))
5427 window_scroll (selected_window, direction, true, false);
5428 else if (EQ (n, Qminus))
5429 window_scroll (selected_window, -direction, true, false);
5430 else
5432 n = Fprefix_numeric_value (n);
5433 window_scroll (selected_window, XINT (n) * direction, false, false);
5436 unbind_to (count, Qnil);
5439 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
5440 doc: /* Scroll text of selected window upward ARG lines.
5441 If ARG is omitted or nil, scroll upward by a near full screen.
5442 A near full screen is `next-screen-context-lines' less than a full screen.
5443 Negative ARG means scroll downward.
5444 If ARG is the atom `-', scroll downward by nearly full screen.
5445 When calling from a program, supply as argument a number, nil, or `-'. */)
5446 (Lisp_Object arg)
5448 scroll_command (arg, 1);
5449 return Qnil;
5452 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
5453 doc: /* Scroll text of selected window down ARG lines.
5454 If ARG is omitted or nil, scroll down by a near full screen.
5455 A near full screen is `next-screen-context-lines' less than a full screen.
5456 Negative ARG means scroll upward.
5457 If ARG is the atom `-', scroll upward by nearly full screen.
5458 When calling from a program, supply as argument a number, nil, or `-'. */)
5459 (Lisp_Object arg)
5461 scroll_command (arg, -1);
5462 return Qnil;
5465 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
5466 doc: /* Return the other window for \"other window scroll\" commands.
5467 If `other-window-scroll-buffer' is non-nil, a window
5468 showing that buffer is used.
5469 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5470 specifies the window. This takes precedence over
5471 `other-window-scroll-buffer'. */)
5472 (void)
5474 Lisp_Object window;
5476 if (MINI_WINDOW_P (XWINDOW (selected_window))
5477 && !NILP (Vminibuf_scroll_window))
5478 window = Vminibuf_scroll_window;
5479 /* If buffer is specified and live, scroll that buffer. */
5480 else if (!NILP (Vother_window_scroll_buffer)
5481 && BUFFERP (Vother_window_scroll_buffer)
5482 && BUFFER_LIVE_P (XBUFFER (Vother_window_scroll_buffer)))
5484 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
5485 if (NILP (window))
5486 window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil);
5488 else
5490 /* Nothing specified; look for a neighboring window on the same
5491 frame. */
5492 window = Fnext_window (selected_window, Qnil, Qnil);
5494 if (EQ (window, selected_window))
5495 /* That didn't get us anywhere; look for a window on another
5496 visible frame. */
5498 window = Fnext_window (window, Qnil, Qt);
5499 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
5500 && ! EQ (window, selected_window));
5503 CHECK_LIVE_WINDOW (window);
5505 if (EQ (window, selected_window))
5506 error ("There is no other window");
5508 return window;
5511 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
5512 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
5513 A near full screen is `next-screen-context-lines' less than a full screen.
5514 The next window is the one below the current one; or the one at the top
5515 if the current one is at the bottom. Negative ARG means scroll downward.
5516 If ARG is the atom `-', scroll downward by nearly full screen.
5517 When calling from a program, supply as argument a number, nil, or `-'.
5519 If `other-window-scroll-buffer' is non-nil, scroll the window
5520 showing that buffer, popping the buffer up if necessary.
5521 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5522 specifies the window to scroll. This takes precedence over
5523 `other-window-scroll-buffer'. */)
5524 (Lisp_Object arg)
5526 Lisp_Object window;
5527 struct window *w;
5528 ptrdiff_t count = SPECPDL_INDEX ();
5530 window = Fother_window_for_scrolling ();
5531 w = XWINDOW (window);
5533 /* Don't screw up if window_scroll gets an error. */
5534 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5536 Fset_buffer (w->contents);
5537 SET_PT_BOTH (marker_position (w->pointm), marker_byte_position (w->pointm));
5538 SET_PT_BOTH (marker_position (w->old_pointm), marker_byte_position (w->old_pointm));
5540 if (NILP (arg))
5541 window_scroll (window, 1, true, true);
5542 else if (EQ (arg, Qminus))
5543 window_scroll (window, -1, true, true);
5544 else
5546 if (CONSP (arg))
5547 arg = XCAR (arg);
5548 CHECK_NUMBER (arg);
5549 window_scroll (window, XINT (arg), false, true);
5552 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
5553 set_marker_both (w->old_pointm, Qnil, PT, PT_BYTE);
5554 unbind_to (count, Qnil);
5556 return Qnil;
5559 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
5560 doc: /* Scroll selected window display ARG columns left.
5561 Default for ARG is window width minus 2.
5562 Value is the total amount of leftward horizontal scrolling in
5563 effect after the change.
5564 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5565 lower bound for automatic scrolling, i.e. automatic scrolling
5566 will not scroll a window to a column less than the value returned
5567 by this function. This happens in an interactive call. */)
5568 (register Lisp_Object arg, Lisp_Object set_minimum)
5570 struct window *w = XWINDOW (selected_window);
5571 EMACS_INT requested_arg = (NILP (arg)
5572 ? window_body_width (w, 0) - 2
5573 : XINT (Fprefix_numeric_value (arg)));
5574 Lisp_Object result = set_window_hscroll (w, w->hscroll + requested_arg);
5576 if (!NILP (set_minimum))
5577 w->min_hscroll = w->hscroll;
5579 w->suspend_auto_hscroll = true;
5581 return result;
5584 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
5585 doc: /* Scroll selected window display ARG columns right.
5586 Default for ARG is window width minus 2.
5587 Value is the total amount of leftward horizontal scrolling in
5588 effect after the change.
5589 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5590 lower bound for automatic scrolling, i.e. automatic scrolling
5591 will not scroll a window to a column less than the value returned
5592 by this function. This happens in an interactive call. */)
5593 (register Lisp_Object arg, Lisp_Object set_minimum)
5595 struct window *w = XWINDOW (selected_window);
5596 EMACS_INT requested_arg = (NILP (arg)
5597 ? window_body_width (w, 0) - 2
5598 : XINT (Fprefix_numeric_value (arg)));
5599 Lisp_Object result = set_window_hscroll (w, w->hscroll - requested_arg);
5601 if (!NILP (set_minimum))
5602 w->min_hscroll = w->hscroll;
5604 w->suspend_auto_hscroll = true;
5606 return result;
5609 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
5610 doc: /* Return the window which was selected when entering the minibuffer.
5611 Returns nil, if selected window is not a minibuffer window. */)
5612 (void)
5614 if (minibuf_level > 0
5615 && MINI_WINDOW_P (XWINDOW (selected_window))
5616 && WINDOW_LIVE_P (minibuf_selected_window))
5617 return minibuf_selected_window;
5619 return Qnil;
5622 /* Value is the number of lines actually displayed in window W,
5623 as opposed to its height. */
5625 static int
5626 displayed_window_lines (struct window *w)
5628 struct it it;
5629 struct text_pos start;
5630 int height = window_box_height (w);
5631 struct buffer *old_buffer;
5632 int bottom_y;
5633 void *itdata = NULL;
5635 if (XBUFFER (w->contents) != current_buffer)
5637 old_buffer = current_buffer;
5638 set_buffer_internal (XBUFFER (w->contents));
5640 else
5641 old_buffer = NULL;
5643 /* In case W->start is out of the accessible range, do something
5644 reasonable. This happens in Info mode when Info-scroll-down
5645 calls (recenter -1) while W->start is 1. */
5646 CLIP_TEXT_POS_FROM_MARKER (start, w->start);
5648 itdata = bidi_shelve_cache ();
5649 start_display (&it, w, start);
5650 move_it_vertically (&it, height);
5651 bottom_y = line_bottom_y (&it);
5652 bidi_unshelve_cache (itdata, false);
5654 /* rms: On a non-window display,
5655 the value of it.vpos at the bottom of the screen
5656 seems to be 1 larger than window_box_height (w).
5657 This kludge fixes a bug whereby (move-to-window-line -1)
5658 when ZV is on the last screen line
5659 moves to the previous screen line instead of the last one. */
5660 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
5661 height++;
5663 /* Add in empty lines at the bottom of the window. */
5664 if (bottom_y < height)
5666 int uy = FRAME_LINE_HEIGHT (it.f);
5667 it.vpos += (height - bottom_y + uy - 1) / uy;
5670 if (old_buffer)
5671 set_buffer_internal (old_buffer);
5673 return it.vpos;
5677 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
5678 doc: /* Center point in selected window and maybe redisplay frame.
5679 With a numeric prefix argument ARG, recenter putting point on screen line ARG
5680 relative to the selected window. If ARG is negative, it counts up from the
5681 bottom of the window. (ARG should be less than the height of the window.)
5683 If ARG is omitted or nil, then recenter with point on the middle line of
5684 the selected window; if the variable `recenter-redisplay' is non-nil,
5685 also erase the entire frame and redraw it (when `auto-resize-tool-bars'
5686 is set to `grow-only', this resets the tool-bar's height to the minimum
5687 height needed); if `recenter-redisplay' has the special value `tty',
5688 then only tty frames are redrawn.
5690 Just C-u as prefix means put point in the center of the window
5691 and redisplay normally--don't erase and redraw the frame. */)
5692 (register Lisp_Object arg)
5694 struct window *w = XWINDOW (selected_window);
5695 struct buffer *buf = XBUFFER (w->contents);
5696 bool center_p = false;
5697 ptrdiff_t charpos, bytepos;
5698 EMACS_INT iarg;
5699 int this_scroll_margin;
5701 if (buf != current_buffer)
5702 error ("`recenter'ing a window that does not display current-buffer.");
5704 /* If redisplay is suppressed due to an error, try again. */
5705 buf->display_error_modiff = 0;
5707 if (NILP (arg))
5709 if (!NILP (Vrecenter_redisplay)
5710 && (!EQ (Vrecenter_redisplay, Qtty)
5711 || !NILP (Ftty_type (selected_frame))))
5713 ptrdiff_t i;
5715 /* Invalidate pixel data calculated for all compositions. */
5716 for (i = 0; i < n_compositions; i++)
5717 composition_table[i]->font = NULL;
5718 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5719 WINDOW_XFRAME (w)->minimize_tool_bar_window_p = 1;
5720 #endif
5721 Fredraw_frame (WINDOW_FRAME (w));
5722 SET_FRAME_GARBAGED (WINDOW_XFRAME (w));
5725 center_p = true;
5727 else if (CONSP (arg)) /* Just C-u. */
5728 center_p = true;
5729 else
5731 arg = Fprefix_numeric_value (arg);
5732 CHECK_NUMBER (arg);
5733 iarg = XINT (arg);
5736 /* Do this after making BUF current
5737 in case scroll_margin is buffer-local. */
5738 this_scroll_margin
5739 = max (0, min (scroll_margin, w->total_lines / 4));
5741 /* Don't use redisplay code for initial frames, as the necessary
5742 data structures might not be set up yet then. */
5743 if (!FRAME_INITIAL_P (XFRAME (w->frame)))
5745 if (center_p)
5747 struct it it;
5748 struct text_pos pt;
5749 void *itdata = bidi_shelve_cache ();
5751 SET_TEXT_POS (pt, PT, PT_BYTE);
5752 start_display (&it, w, pt);
5753 move_it_vertically_backward (&it, window_box_height (w) / 2);
5754 charpos = IT_CHARPOS (it);
5755 bytepos = IT_BYTEPOS (it);
5756 bidi_unshelve_cache (itdata, false);
5758 else if (iarg < 0)
5760 struct it it;
5761 struct text_pos pt;
5762 ptrdiff_t nlines = min (PTRDIFF_MAX, -iarg);
5763 int extra_line_spacing;
5764 int h = window_box_height (w);
5765 int ht = window_internal_height (w);
5766 void *itdata = bidi_shelve_cache ();
5768 nlines = clip_to_bounds (this_scroll_margin + 1, nlines,
5769 ht - this_scroll_margin);
5771 SET_TEXT_POS (pt, PT, PT_BYTE);
5772 start_display (&it, w, pt);
5774 /* Be sure we have the exact height of the full line containing PT. */
5775 move_it_by_lines (&it, 0);
5777 /* The amount of pixels we have to move back is the window
5778 height minus what's displayed in the line containing PT,
5779 and the lines below. */
5780 it.current_y = 0;
5781 it.vpos = 0;
5782 move_it_by_lines (&it, nlines);
5784 if (it.vpos == nlines)
5785 h -= it.current_y;
5786 else
5788 /* Last line has no newline. */
5789 h -= line_bottom_y (&it);
5790 it.vpos++;
5793 /* Don't reserve space for extra line spacing of last line. */
5794 extra_line_spacing = it.max_extra_line_spacing;
5796 /* If we can't move down NLINES lines because we hit
5797 the end of the buffer, count in some empty lines. */
5798 if (it.vpos < nlines)
5800 nlines -= it.vpos;
5801 extra_line_spacing = it.extra_line_spacing;
5802 h -= nlines * (FRAME_LINE_HEIGHT (it.f) + extra_line_spacing);
5804 if (h <= 0)
5806 bidi_unshelve_cache (itdata, false);
5807 return Qnil;
5810 /* Now find the new top line (starting position) of the window. */
5811 start_display (&it, w, pt);
5812 it.current_y = 0;
5813 move_it_vertically_backward (&it, h);
5815 /* If extra line spacing is present, we may move too far
5816 back. This causes the last line to be only partially
5817 visible (which triggers redisplay to recenter that line
5818 in the middle), so move forward.
5819 But ignore extra line spacing on last line, as it is not
5820 considered to be part of the visible height of the line.
5822 h += extra_line_spacing;
5823 while (-it.current_y > h)
5824 move_it_by_lines (&it, 1);
5826 charpos = IT_CHARPOS (it);
5827 bytepos = IT_BYTEPOS (it);
5829 bidi_unshelve_cache (itdata, false);
5831 else
5833 struct it it;
5834 struct text_pos pt;
5835 ptrdiff_t nlines = min (PTRDIFF_MAX, iarg);
5836 int ht = window_internal_height (w);
5837 void *itdata = bidi_shelve_cache ();
5839 nlines = clip_to_bounds (this_scroll_margin, nlines,
5840 ht - this_scroll_margin - 1);
5842 SET_TEXT_POS (pt, PT, PT_BYTE);
5843 start_display (&it, w, pt);
5845 /* Move to the beginning of screen line containing PT. */
5846 move_it_by_lines (&it, 0);
5848 /* Move back to find the point which is ARG screen lines above PT. */
5849 if (nlines > 0)
5851 it.current_y = 0;
5852 it.vpos = 0;
5853 move_it_by_lines (&it, -nlines);
5856 charpos = IT_CHARPOS (it);
5857 bytepos = IT_BYTEPOS (it);
5859 bidi_unshelve_cache (itdata, false);
5862 else
5864 struct position pos;
5865 int ht = window_internal_height (w);
5867 if (center_p)
5868 iarg = ht / 2;
5869 else if (iarg < 0)
5870 iarg += ht;
5872 /* Don't let it get into the margin at either top or bottom. */
5873 iarg = clip_to_bounds (this_scroll_margin, iarg,
5874 ht - this_scroll_margin - 1);
5876 pos = *vmotion (PT, PT_BYTE, - iarg, w);
5877 charpos = pos.bufpos;
5878 bytepos = pos.bytepos;
5881 /* Set the new window start. */
5882 set_marker_both (w->start, w->contents, charpos, bytepos);
5883 w->window_end_valid = false;
5885 w->optional_new_start = true;
5887 w->start_at_line_beg = (bytepos == BEGV_BYTE
5888 || FETCH_BYTE (bytepos - 1) == '\n');
5890 wset_redisplay (w);
5892 return Qnil;
5895 DEFUN ("window-text-width", Fwindow_text_width, Swindow_text_width,
5896 0, 2, 0,
5897 doc: /* Return the width in columns of the text display area of WINDOW.
5898 WINDOW must be a live window and defaults to the selected one.
5900 The returned width does not include dividers, scrollbars, margins,
5901 fringes, nor any partial-width columns at the right of the text
5902 area.
5904 Optional argument PIXELWISE non-nil, means to return the width in
5905 pixels. */)
5906 (Lisp_Object window, Lisp_Object pixelwise)
5908 struct window *w = decode_live_window (window);
5910 if (NILP (pixelwise))
5911 return make_number (window_box_width (w, TEXT_AREA)
5912 / FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w)));
5913 else
5914 return make_number (window_box_width (w, TEXT_AREA));
5917 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5918 0, 2, 0,
5919 doc: /* Return the height in lines of the text display area of WINDOW.
5920 WINDOW must be a live window and defaults to the selected one.
5922 The returned height does not include dividers, the mode line, any header
5923 line, nor any partial-height lines at the bottom of the text area.
5925 Optional argument PIXELWISE non-nil, means to return the height in
5926 pixels. */)
5927 (Lisp_Object window, Lisp_Object pixelwise)
5929 struct window *w = decode_live_window (window);
5931 if (NILP (pixelwise))
5932 return make_number (window_box_height (w)
5933 / FRAME_LINE_HEIGHT (WINDOW_XFRAME (w)));
5934 else
5935 return make_number (window_box_height (w));
5938 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
5939 1, 1, "P",
5940 doc: /* Position point relative to window.
5941 ARG nil means position point at center of window.
5942 Else, ARG specifies vertical position within the window;
5943 zero means top of window, negative means relative to bottom of window. */)
5944 (Lisp_Object arg)
5946 struct window *w = XWINDOW (selected_window);
5947 int lines, start;
5948 Lisp_Object window;
5949 #if false
5950 int this_scroll_margin;
5951 #endif
5953 if (!(BUFFERP (w->contents) && XBUFFER (w->contents) == current_buffer))
5954 /* This test is needed to make sure PT/PT_BYTE make sense in w->contents
5955 when passed below to set_marker_both. */
5956 error ("move-to-window-line called from unrelated buffer");
5958 window = selected_window;
5959 start = marker_position (w->start);
5960 if (start < BEGV || start > ZV)
5962 int height = window_internal_height (w);
5963 Fvertical_motion (make_number (- (height / 2)), window, Qnil);
5964 set_marker_both (w->start, w->contents, PT, PT_BYTE);
5965 w->start_at_line_beg = !NILP (Fbolp ());
5966 w->force_start = true;
5968 else
5969 Fgoto_char (w->start);
5971 lines = displayed_window_lines (w);
5973 #if false
5974 this_scroll_margin = max (0, min (scroll_margin, lines / 4));
5975 #endif
5977 if (NILP (arg))
5978 XSETFASTINT (arg, lines / 2);
5979 else
5981 EMACS_INT iarg = XINT (Fprefix_numeric_value (arg));
5983 if (iarg < 0)
5984 iarg = iarg + lines;
5986 #if false /* This code would prevent move-to-window-line from moving point
5987 to a place inside the scroll margins (which would cause the
5988 next redisplay to scroll). I wrote this code, but then concluded
5989 it is probably better not to install it. However, it is here
5990 inside #if false so as not to lose it. -- rms. */
5992 /* Don't let it get into the margin at either top or bottom. */
5993 iarg = max (iarg, this_scroll_margin);
5994 iarg = min (iarg, lines - this_scroll_margin - 1);
5995 #endif
5997 arg = make_number (iarg);
6000 /* Skip past a partially visible first line. */
6001 if (w->vscroll)
6002 XSETINT (arg, XINT (arg) + 1);
6004 return Fvertical_motion (arg, window, Qnil);
6009 /***********************************************************************
6010 Window Configuration
6011 ***********************************************************************/
6013 struct save_window_data
6015 struct vectorlike_header header;
6016 Lisp_Object selected_frame;
6017 Lisp_Object current_window;
6018 Lisp_Object current_buffer;
6019 Lisp_Object minibuf_scroll_window;
6020 Lisp_Object minibuf_selected_window;
6021 Lisp_Object root_window;
6022 Lisp_Object focus_frame;
6023 /* A vector, each of whose elements is a struct saved_window
6024 for one window. */
6025 Lisp_Object saved_windows;
6027 /* All fields above are traced by the GC.
6028 From `frame-cols' down, the fields are ignored by the GC. */
6029 /* We should be able to do without the following two. */
6030 int frame_cols, frame_lines;
6031 /* These two should get eventually replaced by their pixel
6032 counterparts. */
6033 int frame_menu_bar_lines, frame_tool_bar_lines;
6034 int frame_text_width, frame_text_height;
6035 /* These are currently unused. We need them as soon as we convert
6036 to pixels. */
6037 int frame_menu_bar_height, frame_tool_bar_height;
6040 /* This is saved as a Lisp_Vector. */
6041 struct saved_window
6043 struct vectorlike_header header;
6045 Lisp_Object window, buffer, start, pointm, old_pointm;
6046 Lisp_Object pixel_left, pixel_top, pixel_height, pixel_width;
6047 Lisp_Object pixel_height_before_size_change, pixel_width_before_size_change;
6048 Lisp_Object left_col, top_line, total_cols, total_lines;
6049 Lisp_Object normal_cols, normal_lines;
6050 Lisp_Object hscroll, min_hscroll, hscroll_whole, suspend_auto_hscroll;
6051 Lisp_Object parent, prev;
6052 Lisp_Object start_at_line_beg;
6053 Lisp_Object display_table;
6054 Lisp_Object left_margin_cols, right_margin_cols;
6055 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
6056 Lisp_Object scroll_bar_width, vertical_scroll_bar_type, dedicated;
6057 Lisp_Object scroll_bar_height, horizontal_scroll_bar_type;
6058 Lisp_Object combination_limit, window_parameters;
6061 #define SAVED_WINDOW_N(swv,n) \
6062 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
6064 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
6065 doc: /* Return t if OBJECT is a window-configuration object. */)
6066 (Lisp_Object object)
6068 return WINDOW_CONFIGURATIONP (object) ? Qt : Qnil;
6071 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
6072 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
6073 (Lisp_Object config)
6075 register struct save_window_data *data;
6076 struct Lisp_Vector *saved_windows;
6078 CHECK_WINDOW_CONFIGURATION (config);
6080 data = (struct save_window_data *) XVECTOR (config);
6081 saved_windows = XVECTOR (data->saved_windows);
6082 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
6085 DEFUN ("set-window-configuration", Fset_window_configuration,
6086 Sset_window_configuration, 1, 1, 0,
6087 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
6088 CONFIGURATION must be a value previously returned
6089 by `current-window-configuration' (which see).
6090 If CONFIGURATION was made from a frame that is now deleted,
6091 only frame-independent values can be restored. In this case,
6092 the return value is nil. Otherwise the value is t. */)
6093 (Lisp_Object configuration)
6095 register struct save_window_data *data;
6096 struct Lisp_Vector *saved_windows;
6097 Lisp_Object new_current_buffer;
6098 Lisp_Object frame;
6099 struct frame *f;
6100 ptrdiff_t old_point = -1;
6101 USE_SAFE_ALLOCA;
6103 CHECK_WINDOW_CONFIGURATION (configuration);
6105 data = (struct save_window_data *) XVECTOR (configuration);
6106 saved_windows = XVECTOR (data->saved_windows);
6108 new_current_buffer = data->current_buffer;
6109 if (!BUFFER_LIVE_P (XBUFFER (new_current_buffer)))
6110 new_current_buffer = Qnil;
6111 else
6113 if (XBUFFER (new_current_buffer) == current_buffer)
6114 /* The code further down "preserves point" by saving here PT in
6115 old_point and then setting it later back into PT. When the
6116 current-selected-window and the final-selected-window both show
6117 the current buffer, this suffers from the problem that the
6118 current PT is the window-point of the current-selected-window,
6119 while the final PT is the point of the final-selected-window, so
6120 this copy from one PT to the other would end up moving the
6121 window-point of the final-selected-window to the window-point of
6122 the current-selected-window. So we have to be careful which
6123 point of the current-buffer we copy into old_point. */
6124 if (EQ (XWINDOW (data->current_window)->contents, new_current_buffer)
6125 && WINDOWP (selected_window)
6126 && EQ (XWINDOW (selected_window)->contents, new_current_buffer)
6127 && !EQ (selected_window, data->current_window))
6128 old_point = marker_position (XWINDOW (data->current_window)->pointm);
6129 else
6130 old_point = PT;
6131 else
6132 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
6133 point in new_current_buffer as of the last time this buffer was
6134 used. This can be non-deterministic since it can be changed by
6135 things like jit-lock by mere temporary selection of some random
6136 window that happens to show this buffer.
6137 So if possible we want this arbitrary choice of "which point" to
6138 be the one from the to-be-selected-window so as to prevent this
6139 window's cursor from being copied from another window. */
6140 if (EQ (XWINDOW (data->current_window)->contents, new_current_buffer)
6141 /* If current_window = selected_window, its point is in BUF_PT. */
6142 && !EQ (selected_window, data->current_window))
6143 old_point = marker_position (XWINDOW (data->current_window)->pointm);
6144 else
6145 old_point = BUF_PT (XBUFFER (new_current_buffer));
6148 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
6149 f = XFRAME (frame);
6151 /* If f is a dead frame, don't bother rebuilding its window tree.
6152 However, there is other stuff we should still try to do below. */
6153 if (FRAME_LIVE_P (f))
6155 Lisp_Object window;
6156 Lisp_Object dead_windows = Qnil;
6157 Lisp_Object tem, par, pers;
6158 struct window *w;
6159 struct saved_window *p;
6160 struct window *root_window;
6161 struct window **leaf_windows;
6162 ptrdiff_t i, k, n_leaf_windows;
6163 /* Records whether a window has been added or removed wrt the
6164 original configuration. */
6165 bool window_changed = false;
6166 /* Records whether a window has changed its buffer wrt the
6167 original configuration. */
6168 bool buffer_changed = false;
6170 /* Don't do this within the main loop below: This may call Lisp
6171 code and is thus potentially unsafe while input is blocked. */
6172 for (k = 0; k < saved_windows->header.size; k++)
6174 p = SAVED_WINDOW_N (saved_windows, k);
6175 window = p->window;
6176 w = XWINDOW (window);
6178 if (NILP (w->contents))
6179 /* A dead window that will be resurrected, the window
6180 configuration will change. */
6181 window_changed = true;
6183 if (BUFFERP (w->contents)
6184 && !EQ (w->contents, p->buffer)
6185 && BUFFER_LIVE_P (XBUFFER (p->buffer)))
6186 /* If a window we restore gets another buffer, record the
6187 window's old buffer. */
6188 call1 (Qrecord_window_buffer, window);
6191 /* Disallow x_set_window_size, temporarily. */
6192 f->can_x_set_window_size = false;
6193 /* The mouse highlighting code could get screwed up
6194 if it runs during this. */
6195 block_input ();
6197 /* "Swap out" point from the selected window's buffer
6198 into the window itself. (Normally the pointm of the selected
6199 window holds garbage.) We do this now, before
6200 restoring the window contents, and prevent it from
6201 being done later on when we select a new window. */
6202 if (! NILP (XWINDOW (selected_window)->contents))
6204 w = XWINDOW (selected_window);
6205 set_marker_both (w->pointm,
6206 w->contents,
6207 BUF_PT (XBUFFER (w->contents)),
6208 BUF_PT_BYTE (XBUFFER (w->contents)));
6211 fset_redisplay (f);
6213 /* Problem: Freeing all matrices and later allocating them again
6214 is a serious redisplay flickering problem. What we would
6215 really like to do is to free only those matrices not reused
6216 below. */
6217 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
6218 ptrdiff_t nwindows = count_windows (root_window);
6219 SAFE_NALLOCA (leaf_windows, 1, nwindows);
6220 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
6222 /* Kludge Alert!
6223 Mark all windows now on frame as "deleted".
6224 Restoring the new configuration "undeletes" any that are in it.
6226 Save their current buffers in their height fields, since we may
6227 need it later, if a buffer saved in the configuration is now
6228 dead. */
6229 delete_all_child_windows (FRAME_ROOT_WINDOW (f));
6231 for (k = 0; k < saved_windows->header.size; k++)
6233 p = SAVED_WINDOW_N (saved_windows, k);
6234 window = p->window;
6235 w = XWINDOW (window);
6236 wset_next (w, Qnil);
6238 if (!NILP (p->parent))
6239 wset_parent
6240 (w, SAVED_WINDOW_N (saved_windows, XFASTINT (p->parent))->window);
6241 else
6242 wset_parent (w, Qnil);
6244 if (!NILP (p->prev))
6246 wset_prev
6247 (w, SAVED_WINDOW_N (saved_windows, XFASTINT (p->prev))->window);
6248 wset_next (XWINDOW (w->prev), p->window);
6250 else
6252 wset_prev (w, Qnil);
6253 if (!NILP (w->parent))
6254 wset_combination (XWINDOW (w->parent),
6255 (XINT (p->total_cols)
6256 != XWINDOW (w->parent)->total_cols),
6257 p->window);
6260 /* If we squirreled away the buffer, restore it now. */
6261 if (BUFFERP (w->combination_limit))
6262 wset_buffer (w, w->combination_limit);
6263 w->pixel_left = XFASTINT (p->pixel_left);
6264 w->pixel_top = XFASTINT (p->pixel_top);
6265 w->pixel_width = XFASTINT (p->pixel_width);
6266 w->pixel_height = XFASTINT (p->pixel_height);
6267 w->pixel_width_before_size_change
6268 = XFASTINT (p->pixel_width_before_size_change);
6269 w->pixel_height_before_size_change
6270 = XFASTINT (p->pixel_height_before_size_change);
6271 w->left_col = XFASTINT (p->left_col);
6272 w->top_line = XFASTINT (p->top_line);
6273 w->total_cols = XFASTINT (p->total_cols);
6274 w->total_lines = XFASTINT (p->total_lines);
6275 wset_normal_cols (w, p->normal_cols);
6276 wset_normal_lines (w, p->normal_lines);
6277 w->hscroll = XFASTINT (p->hscroll);
6278 w->suspend_auto_hscroll = !NILP (p->suspend_auto_hscroll);
6279 w->min_hscroll = XFASTINT (p->min_hscroll);
6280 w->hscroll_whole = XFASTINT (p->hscroll_whole);
6281 wset_display_table (w, p->display_table);
6282 w->left_margin_cols = XINT (p->left_margin_cols);
6283 w->right_margin_cols = XINT (p->right_margin_cols);
6284 w->left_fringe_width = XINT (p->left_fringe_width);
6285 w->right_fringe_width = XINT (p->right_fringe_width);
6286 w->fringes_outside_margins = !NILP (p->fringes_outside_margins);
6287 w->scroll_bar_width = XINT (p->scroll_bar_width);
6288 w->scroll_bar_height = XINT (p->scroll_bar_height);
6289 wset_vertical_scroll_bar_type (w, p->vertical_scroll_bar_type);
6290 wset_horizontal_scroll_bar_type (w, p->horizontal_scroll_bar_type);
6291 wset_dedicated (w, p->dedicated);
6292 wset_combination_limit (w, p->combination_limit);
6293 /* Restore any window parameters that have been saved.
6294 Parameters that have not been saved are left alone. */
6295 for (tem = p->window_parameters; CONSP (tem); tem = XCDR (tem))
6297 pers = XCAR (tem);
6298 if (CONSP (pers))
6300 if (NILP (XCDR (pers)))
6302 par = Fassq (XCAR (pers), w->window_parameters);
6303 if (CONSP (par) && !NILP (XCDR (par)))
6304 /* Reset a parameter to nil if and only if it
6305 has a non-nil association. Don't make new
6306 associations. */
6307 Fsetcdr (par, Qnil);
6309 else
6310 /* Always restore a non-nil value. */
6311 Fset_window_parameter (window, XCAR (pers), XCDR (pers));
6315 if (BUFFERP (p->buffer) && BUFFER_LIVE_P (XBUFFER (p->buffer)))
6316 /* If saved buffer is alive, install it. */
6318 if (!EQ (w->contents, p->buffer))
6319 /* Record buffer configuration change. */
6320 buffer_changed = true;
6321 wset_buffer (w, p->buffer);
6322 w->start_at_line_beg = !NILP (p->start_at_line_beg);
6323 set_marker_restricted (w->start, p->start, w->contents);
6324 set_marker_restricted (w->pointm, p->pointm, w->contents);
6325 set_marker_restricted (w->old_pointm, p->old_pointm, w->contents);
6326 /* As documented in Fcurrent_window_configuration, don't
6327 restore the location of point in the buffer which was
6328 current when the window configuration was recorded. */
6329 if (!EQ (p->buffer, new_current_buffer)
6330 && XBUFFER (p->buffer) == current_buffer)
6331 Fgoto_char (w->pointm);
6333 else if (BUFFERP (w->contents) && BUFFER_LIVE_P (XBUFFER (w->contents)))
6334 /* Keep window's old buffer; make sure the markers are real. */
6336 /* Set window markers at start of visible range. */
6337 if (XMARKER (w->start)->buffer == 0)
6338 set_marker_restricted_both (w->start, w->contents, 0, 0);
6339 if (XMARKER (w->pointm)->buffer == 0)
6340 set_marker_restricted_both
6341 (w->pointm, w->contents,
6342 BUF_PT (XBUFFER (w->contents)),
6343 BUF_PT_BYTE (XBUFFER (w->contents)));
6344 if (XMARKER (w->old_pointm)->buffer == 0)
6345 set_marker_restricted_both
6346 (w->old_pointm, w->contents,
6347 BUF_PT (XBUFFER (w->contents)),
6348 BUF_PT_BYTE (XBUFFER (w->contents)));
6349 w->start_at_line_beg = true;
6351 else if (!NILP (w->start))
6352 /* Leaf window has no live buffer, get one. */
6354 /* Record buffer configuration change. */
6355 buffer_changed = true;
6356 /* Get the buffer via other_buffer_safely in order to
6357 avoid showing an unimportant buffer and, if necessary, to
6358 recreate *scratch* in the course (part of Juanma's bs-show
6359 scenario from March 2011). */
6360 wset_buffer (w, other_buffer_safely (Fcurrent_buffer ()));
6361 /* This will set the markers to beginning of visible
6362 range. */
6363 set_marker_restricted_both (w->start, w->contents, 0, 0);
6364 set_marker_restricted_both (w->pointm, w->contents, 0, 0);
6365 set_marker_restricted_both (w->old_pointm, w->contents, 0, 0);
6366 w->start_at_line_beg = true;
6367 if (!NILP (w->dedicated))
6368 /* Record this window as dead. */
6369 dead_windows = Fcons (window, dead_windows);
6370 /* Make sure window is no more dedicated. */
6371 wset_dedicated (w, Qnil);
6375 fset_root_window (f, data->root_window);
6376 /* Arrange *not* to restore point in the buffer that was
6377 current when the window configuration was saved. */
6378 if (EQ (XWINDOW (data->current_window)->contents, new_current_buffer))
6379 set_marker_restricted (XWINDOW (data->current_window)->pointm,
6380 make_number (old_point),
6381 XWINDOW (data->current_window)->contents);
6383 /* In the following call to `select-window', prevent "swapping out
6384 point" in the old selected window using the buffer that has
6385 been restored into it. We already swapped out that point from
6386 that window's old buffer.
6388 Do not record the buffer here. We do that in a separate call
6389 to select_window below. See also Bug#16207. */
6390 select_window (data->current_window, Qt, true);
6391 BVAR (XBUFFER (XWINDOW (selected_window)->contents),
6392 last_selected_window)
6393 = selected_window;
6395 if (NILP (data->focus_frame)
6396 || (FRAMEP (data->focus_frame)
6397 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
6398 Fredirect_frame_focus (frame, data->focus_frame);
6400 /* Now, free glyph matrices in windows that were not reused. */
6401 for (i = 0; i < n_leaf_windows; i++)
6402 if (NILP (leaf_windows[i]->contents))
6404 free_window_matrices (leaf_windows[i]);
6405 window_changed = true;
6408 /* Allow x_set_window_size again and apply frame size changes if
6409 needed. */
6410 f->can_x_set_window_size = true;
6411 adjust_frame_size (f, -1, -1, 1, false, Qset_window_configuration);
6413 adjust_frame_glyphs (f);
6414 unblock_input ();
6416 /* Scan dead buffer windows. */
6417 for (; CONSP (dead_windows); dead_windows = XCDR (dead_windows))
6419 window = XCAR (dead_windows);
6420 if (WINDOW_LIVE_P (window) && !EQ (window, FRAME_ROOT_WINDOW (f)))
6421 delete_deletable_window (window);
6424 /* Record the selected window's buffer here. The window should
6425 already be the selected one from the call above. */
6426 if (WINDOW_LIVE_P (data->current_window))
6427 select_window (data->current_window, Qnil, false);
6429 /* Fselect_window will have made f the selected frame, so we
6430 reselect the proper frame here. Fhandle_switch_frame will change the
6431 selected window too, but that doesn't make the call to
6432 Fselect_window above totally superfluous; it still sets f's
6433 selected window. */
6434 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
6435 do_switch_frame (data->selected_frame, 0, 0, Qnil);
6437 if (window_changed)
6438 /* At least one window has been added or removed. Run
6439 `window-configuration-change-hook' and make sure
6440 `window-size-change-functions' get run later.
6442 We have to do this in order to capture the following
6443 scenario: Suppose our frame contains two live windows W1 and
6444 W2 and ‘set-window-configuration’ replaces them by two
6445 windows W3 and W4 that were dead the last time
6446 run_window_size_change_functions was run. If W3 and W4 have
6447 the same values for their old and new pixel sizes but these
6448 values differ from those of W1 and W2, the sizes of our
6449 frame's two live windows changed but window_size_changed has
6450 no means to detect that fact.
6452 Obviously, this will get us false positives, for example,
6453 when we restore the original configuration with W1 and W2
6454 before run_window_size_change_functions gets called. */
6456 run_window_configuration_change_hook (f);
6457 FRAME_WINDOW_CONFIGURATION_CHANGED (f) = true;
6459 else if (buffer_changed)
6460 /* At least one window has changed its buffer. Run
6461 `window-configuration-change-hook' only. */
6462 run_window_configuration_change_hook (f);
6465 if (!NILP (new_current_buffer))
6467 Fset_buffer (new_current_buffer);
6468 /* If the new current buffer doesn't appear in the selected
6469 window, go to its old point (see bug#12208). */
6470 if (!EQ (XWINDOW (data->current_window)->contents, new_current_buffer))
6471 Fgoto_char (make_number (old_point));
6474 Vminibuf_scroll_window = data->minibuf_scroll_window;
6475 minibuf_selected_window = data->minibuf_selected_window;
6477 SAFE_FREE ();
6478 return (FRAME_LIVE_P (f) ? Qt : Qnil);
6482 void
6483 restore_window_configuration (Lisp_Object configuration)
6485 Fset_window_configuration (configuration);
6489 /* If WINDOW is an internal window, recursively delete all child windows
6490 reachable via the next and contents slots of WINDOW. Otherwise setup
6491 WINDOW to not show any buffer. */
6493 void
6494 delete_all_child_windows (Lisp_Object window)
6496 register struct window *w;
6498 w = XWINDOW (window);
6500 if (!NILP (w->next))
6501 /* Delete WINDOW's siblings (we traverse postorderly). */
6502 delete_all_child_windows (w->next);
6504 if (WINDOWP (w->contents))
6506 delete_all_child_windows (w->contents);
6507 wset_combination (w, false, Qnil);
6509 else if (BUFFERP (w->contents))
6511 unshow_buffer (w);
6512 unchain_marker (XMARKER (w->pointm));
6513 unchain_marker (XMARKER (w->old_pointm));
6514 unchain_marker (XMARKER (w->start));
6515 /* Since combination limit makes sense for an internal windows
6516 only, we use this slot to save the buffer for the sake of
6517 possible resurrection in Fset_window_configuration. */
6518 wset_combination_limit (w, w->contents);
6519 wset_buffer (w, Qnil);
6522 Vwindow_list = Qnil;
6525 static ptrdiff_t
6526 count_windows (struct window *window)
6528 ptrdiff_t count = 1;
6529 if (!NILP (window->next))
6530 count += count_windows (XWINDOW (window->next));
6531 if (WINDOWP (window->contents))
6532 count += count_windows (XWINDOW (window->contents));
6533 return count;
6537 /* Fill vector FLAT with leaf windows under W, starting at index I.
6538 Value is last index + 1. */
6539 static ptrdiff_t
6540 get_leaf_windows (struct window *w, struct window **flat, ptrdiff_t i)
6542 while (w)
6544 if (WINDOWP (w->contents))
6545 i = get_leaf_windows (XWINDOW (w->contents), flat, i);
6546 else
6547 flat[i++] = w;
6549 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6552 return i;
6556 /* Return a pointer to the glyph W's physical cursor is on. Value is
6557 null if W's current matrix is invalid, so that no meaningful glyph
6558 can be returned. */
6559 struct glyph *
6560 get_phys_cursor_glyph (struct window *w)
6562 struct glyph_row *row;
6563 struct glyph *glyph;
6564 int hpos = w->phys_cursor.hpos;
6566 if (!(w->phys_cursor.vpos >= 0
6567 && w->phys_cursor.vpos < w->current_matrix->nrows))
6568 return NULL;
6570 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
6571 if (!row->enabled_p)
6572 return NULL;
6574 if (w->hscroll)
6576 /* When the window is hscrolled, cursor hpos can legitimately be
6577 out of bounds, but we draw the cursor at the corresponding
6578 window margin in that case. */
6579 if (!row->reversed_p && hpos < 0)
6580 hpos = 0;
6581 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
6582 hpos = row->used[TEXT_AREA] - 1;
6585 if (0 <= hpos && hpos < row->used[TEXT_AREA])
6586 glyph = row->glyphs[TEXT_AREA] + hpos;
6587 else
6588 glyph = NULL;
6590 return glyph;
6594 static ptrdiff_t
6595 save_window_save (Lisp_Object window, struct Lisp_Vector *vector, ptrdiff_t i)
6597 struct saved_window *p;
6598 struct window *w;
6599 Lisp_Object tem, pers, par;
6601 for (; !NILP (window); window = w->next)
6603 p = SAVED_WINDOW_N (vector, i);
6604 w = XWINDOW (window);
6606 wset_temslot (w, make_number (i)); i++;
6607 p->window = window;
6608 p->buffer = (WINDOW_LEAF_P (w) ? w->contents : Qnil);
6609 p->pixel_left = make_number (w->pixel_left);
6610 p->pixel_top = make_number (w->pixel_top);
6611 p->pixel_width = make_number (w->pixel_width);
6612 p->pixel_height = make_number (w->pixel_height);
6613 p->pixel_width_before_size_change
6614 = make_number (w->pixel_width_before_size_change);
6615 p->pixel_height_before_size_change
6616 = make_number (w->pixel_height_before_size_change);
6617 p->left_col = make_number (w->left_col);
6618 p->top_line = make_number (w->top_line);
6619 p->total_cols = make_number (w->total_cols);
6620 p->total_lines = make_number (w->total_lines);
6621 p->normal_cols = w->normal_cols;
6622 p->normal_lines = w->normal_lines;
6623 XSETFASTINT (p->hscroll, w->hscroll);
6624 p->suspend_auto_hscroll = w->suspend_auto_hscroll ? Qt : Qnil;
6625 XSETFASTINT (p->min_hscroll, w->min_hscroll);
6626 XSETFASTINT (p->hscroll_whole, w->hscroll_whole);
6627 p->display_table = w->display_table;
6628 p->left_margin_cols = make_number (w->left_margin_cols);
6629 p->right_margin_cols = make_number (w->right_margin_cols);
6630 p->left_fringe_width = make_number (w->left_fringe_width);
6631 p->right_fringe_width = make_number (w->right_fringe_width);
6632 p->fringes_outside_margins = w->fringes_outside_margins ? Qt : Qnil;
6633 p->scroll_bar_width = make_number (w->scroll_bar_width);
6634 p->scroll_bar_height = make_number (w->scroll_bar_height);
6635 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
6636 p->horizontal_scroll_bar_type = w->horizontal_scroll_bar_type;
6637 p->dedicated = w->dedicated;
6638 p->combination_limit = w->combination_limit;
6639 p->window_parameters = Qnil;
6641 if (!NILP (Vwindow_persistent_parameters))
6643 /* Run cycle detection on Vwindow_persistent_parameters. */
6644 Lisp_Object tortoise, hare;
6646 hare = tortoise = Vwindow_persistent_parameters;
6647 while (CONSP (hare))
6649 hare = XCDR (hare);
6650 if (!CONSP (hare))
6651 break;
6653 hare = XCDR (hare);
6654 tortoise = XCDR (tortoise);
6656 if (EQ (hare, tortoise))
6657 /* Reset Vwindow_persistent_parameters to Qnil. */
6659 Vwindow_persistent_parameters = Qnil;
6660 break;
6664 for (tem = Vwindow_persistent_parameters; CONSP (tem);
6665 tem = XCDR (tem))
6667 pers = XCAR (tem);
6668 /* Save values for persistent window parameters. */
6669 if (CONSP (pers) && !NILP (XCDR (pers)))
6671 par = Fassq (XCAR (pers), w->window_parameters);
6672 if (NILP (par))
6673 /* If the window has no value for the parameter,
6674 make one. */
6675 p->window_parameters = Fcons (Fcons (XCAR (pers), Qnil),
6676 p->window_parameters);
6677 else
6678 /* If the window has a value for the parameter,
6679 save it. */
6680 p->window_parameters = Fcons (Fcons (XCAR (par),
6681 XCDR (par)),
6682 p->window_parameters);
6687 if (BUFFERP (w->contents))
6689 /* Save w's value of point in the window configuration. If w
6690 is the selected window, then get the value of point from
6691 the buffer; pointm is garbage in the selected window. */
6692 if (EQ (window, selected_window))
6693 p->pointm = build_marker (XBUFFER (w->contents),
6694 BUF_PT (XBUFFER (w->contents)),
6695 BUF_PT_BYTE (XBUFFER (w->contents)));
6696 else
6697 p->pointm = Fcopy_marker (w->pointm, Qnil);
6698 p->old_pointm = Fcopy_marker (w->old_pointm, Qnil);
6699 XMARKER (p->pointm)->insertion_type
6700 = !NILP (buffer_local_value /* Don't signal error if void. */
6701 (Qwindow_point_insertion_type, w->contents));
6702 XMARKER (p->old_pointm)->insertion_type
6703 = !NILP (buffer_local_value /* Don't signal error if void. */
6704 (Qwindow_point_insertion_type, w->contents));
6706 p->start = Fcopy_marker (w->start, Qnil);
6707 p->start_at_line_beg = w->start_at_line_beg ? Qt : Qnil;
6709 else
6711 p->pointm = Qnil;
6712 p->old_pointm = Qnil;
6713 p->start = Qnil;
6714 p->start_at_line_beg = Qnil;
6717 p->parent = NILP (w->parent) ? Qnil : XWINDOW (w->parent)->temslot;
6718 p->prev = NILP (w->prev) ? Qnil : XWINDOW (w->prev)->temslot;
6720 if (WINDOWP (w->contents))
6721 i = save_window_save (w->contents, vector, i);
6724 return i;
6727 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
6728 Scurrent_window_configuration, 0, 1, 0,
6729 doc: /* Return an object representing the current window configuration of FRAME.
6730 If FRAME is nil or omitted, use the selected frame.
6731 This describes the number of windows, their sizes and current buffers,
6732 and for each displayed buffer, where display starts, and the position of
6733 point. An exception is made for point in the current buffer:
6734 its value is -not- saved.
6735 This also records the currently selected frame, and FRAME's focus
6736 redirection (see `redirect-frame-focus'). The variable
6737 `window-persistent-parameters' specifies which window parameters are
6738 saved by this function. */)
6739 (Lisp_Object frame)
6741 Lisp_Object tem;
6742 ptrdiff_t i, n_windows;
6743 struct save_window_data *data;
6744 struct frame *f = decode_live_frame (frame);
6746 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6747 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
6748 PVEC_WINDOW_CONFIGURATION);
6750 data->frame_cols = FRAME_COLS (f);
6751 data->frame_lines = FRAME_LINES (f);
6752 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6753 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6754 data->frame_text_width = FRAME_TEXT_WIDTH (f);
6755 data->frame_text_height = FRAME_TEXT_HEIGHT (f);
6756 data->frame_menu_bar_height = FRAME_MENU_BAR_HEIGHT (f);
6757 data->frame_tool_bar_height = FRAME_TOOL_BAR_HEIGHT (f);
6758 data->selected_frame = selected_frame;
6759 data->current_window = FRAME_SELECTED_WINDOW (f);
6760 XSETBUFFER (data->current_buffer, current_buffer);
6761 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
6762 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
6763 data->root_window = FRAME_ROOT_WINDOW (f);
6764 data->focus_frame = FRAME_FOCUS_FRAME (f);
6765 tem = make_uninit_vector (n_windows);
6766 data->saved_windows = tem;
6767 for (i = 0; i < n_windows; i++)
6768 ASET (tem, i,
6769 Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil));
6770 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
6771 XSETWINDOW_CONFIGURATION (tem, data);
6772 return (tem);
6775 /* Called after W's margins, fringes or scroll bars was adjusted. */
6777 static void
6778 apply_window_adjustment (struct window *w)
6780 eassert (w);
6781 clear_glyph_matrix (w->current_matrix);
6782 w->window_end_valid = false;
6783 wset_redisplay (w);
6784 adjust_frame_glyphs (XFRAME (WINDOW_FRAME (w)));
6788 /***********************************************************************
6789 Marginal Areas
6790 ***********************************************************************/
6792 static int
6793 extract_dimension (Lisp_Object dimension)
6795 if (NILP (dimension))
6796 return -1;
6797 CHECK_RANGED_INTEGER (dimension, 0, INT_MAX);
6798 return XINT (dimension);
6801 static struct window *
6802 set_window_margins (struct window *w, Lisp_Object left_width,
6803 Lisp_Object right_width)
6805 int unit = WINDOW_FRAME_COLUMN_WIDTH (w);
6806 int left = NILP (left_width) ? 0 : extract_dimension (left_width);
6807 int right = NILP (right_width) ? 0 : extract_dimension (right_width);
6809 if (w->left_margin_cols != left || w->right_margin_cols != right)
6811 /* Don't change anything if new margins won't fit. */
6812 if ((WINDOW_PIXEL_WIDTH (w)
6813 - WINDOW_FRINGES_WIDTH (w)
6814 - WINDOW_SCROLL_BAR_AREA_WIDTH (w)
6815 - (left + right) * unit)
6816 >= MIN_SAFE_WINDOW_PIXEL_WIDTH (w))
6818 w->left_margin_cols = left;
6819 w->right_margin_cols = right;
6821 return w;
6823 else
6824 return NULL;
6826 else
6827 return NULL;
6830 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
6831 2, 3, 0,
6832 doc: /* Set width of marginal areas of window WINDOW.
6833 WINDOW must be a live window and defaults to the selected one.
6835 Second arg LEFT-WIDTH specifies the number of character cells to
6836 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6837 does the same for the right marginal area. A nil width parameter
6838 means no margin.
6840 Return t if any margin was actually changed and nil otherwise. */)
6841 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width)
6843 struct window *w = set_window_margins (decode_live_window (window),
6844 left_width, right_width);
6845 return w ? (apply_window_adjustment (w), Qt) : Qnil;
6849 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
6850 0, 1, 0,
6851 doc: /* Get width of marginal areas of window WINDOW.
6852 WINDOW must be a live window and defaults to the selected one.
6854 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6855 If a marginal area does not exist, its width will be returned
6856 as nil. */)
6857 (Lisp_Object window)
6859 struct window *w = decode_live_window (window);
6860 return Fcons (w->left_margin_cols
6861 ? make_number (w->left_margin_cols) : Qnil,
6862 w->right_margin_cols
6863 ? make_number (w->right_margin_cols) : Qnil);
6868 /***********************************************************************
6869 Fringes
6870 ***********************************************************************/
6872 static struct window *
6873 set_window_fringes (struct window *w, Lisp_Object left_width,
6874 Lisp_Object right_width, Lisp_Object outside_margins)
6876 bool outside = !NILP (outside_margins);
6877 int left = extract_dimension (left_width);
6878 int right = extract_dimension (right_width);
6880 /* Do nothing on a tty or if nothing to actually change. */
6881 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6882 && (w->left_fringe_width != left
6883 || w->right_fringe_width != right
6884 || w->fringes_outside_margins != outside))
6886 if (left > 0 || right > 0)
6888 /* Don't change anything if new fringes don't fit. */
6889 if ((WINDOW_PIXEL_WIDTH (w)
6890 - WINDOW_MARGINS_WIDTH (w)
6891 - WINDOW_SCROLL_BAR_AREA_WIDTH (w)
6892 - max (left, 0) - max (right, 0))
6893 < MIN_SAFE_WINDOW_PIXEL_WIDTH (w))
6894 return NULL;
6897 w->left_fringe_width = left;
6898 w->right_fringe_width = right;
6899 w->fringes_outside_margins = outside;
6901 return w;
6903 else
6904 return NULL;
6907 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6908 2, 4, 0,
6909 doc: /* Set the fringe widths of window WINDOW.
6910 WINDOW must be a live window and defaults to the selected one.
6912 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6913 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6914 fringe width. If a fringe width arg is nil, that means to use the
6915 frame's default fringe width. Default fringe widths can be set with
6916 the command `set-fringe-style'.
6917 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6918 outside of the display margins. By default, fringes are drawn between
6919 display marginal areas and the text area.
6921 Return t if any fringe was actually changed and nil otherwise. */)
6922 (Lisp_Object window, Lisp_Object left_width,
6923 Lisp_Object right_width, Lisp_Object outside_margins)
6925 struct window *w
6926 = set_window_fringes (decode_live_window (window),
6927 left_width, right_width, outside_margins);
6928 return w ? (apply_window_adjustment (w), Qt) : Qnil;
6932 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6933 0, 1, 0,
6934 doc: /* Get width of fringes of window WINDOW.
6935 WINDOW must be a live window and defaults to the selected one.
6937 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6938 (Lisp_Object window)
6940 struct window *w = decode_live_window (window);
6942 return list3 (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6943 make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6944 WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w) ? Qt : Qnil);
6949 /***********************************************************************
6950 Scroll bars
6951 ***********************************************************************/
6953 static struct window *
6954 set_window_scroll_bars (struct window *w, Lisp_Object width,
6955 Lisp_Object vertical_type, Lisp_Object height,
6956 Lisp_Object horizontal_type)
6958 int iwidth = extract_dimension (width);
6959 bool changed = false;
6961 if (iwidth == 0)
6962 vertical_type = Qnil;
6964 if (!(NILP (vertical_type)
6965 || EQ (vertical_type, Qleft)
6966 || EQ (vertical_type, Qright)
6967 || EQ (vertical_type, Qt)))
6968 error ("Invalid type of vertical scroll bar");
6970 if (w->scroll_bar_width != iwidth
6971 || !EQ (w->vertical_scroll_bar_type, vertical_type))
6973 /* Don't change anything if new scroll bar won't fit. */
6974 if ((WINDOW_PIXEL_WIDTH (w)
6975 - WINDOW_MARGINS_WIDTH (w)
6976 - WINDOW_FRINGES_WIDTH (w)
6977 - max (iwidth, 0))
6978 >= MIN_SAFE_WINDOW_PIXEL_WIDTH (w))
6980 w->scroll_bar_width = iwidth;
6981 wset_vertical_scroll_bar_type (w, vertical_type);
6982 changed = true;
6986 #if USE_HORIZONTAL_SCROLL_BARS
6988 int iheight = extract_dimension (height);
6990 if (MINI_WINDOW_P (w) || iheight == 0)
6991 horizontal_type = Qnil;
6993 if (!(NILP (horizontal_type)
6994 || EQ (horizontal_type, Qbottom)
6995 || EQ (horizontal_type, Qt)))
6996 error ("Invalid type of horizontal scroll bar");
6998 if (w->scroll_bar_height != iheight
6999 || !EQ (w->horizontal_scroll_bar_type, horizontal_type))
7001 /* Don't change anything if new scroll bar won't fit. */
7002 if ((WINDOW_PIXEL_HEIGHT (w)
7003 - WINDOW_HEADER_LINE_HEIGHT (w)
7004 - WINDOW_MODE_LINE_HEIGHT (w)
7005 - max (iheight, 0))
7006 >= MIN_SAFE_WINDOW_PIXEL_HEIGHT (w))
7008 w->scroll_bar_height = iheight;
7009 wset_horizontal_scroll_bar_type (w, horizontal_type);
7010 changed = true;
7014 #else
7015 wset_horizontal_scroll_bar_type (w, Qnil);
7016 #endif
7018 return changed ? w : NULL;
7021 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars,
7022 Sset_window_scroll_bars, 1, 5, 0,
7023 doc: /* Set width and type of scroll bars of window WINDOW.
7024 WINDOW must be a live window and defaults to the selected one.
7026 Second parameter WIDTH specifies the pixel width for the vertical scroll
7027 bar. If WIDTH is nil, use the scroll-bar width of WINDOW's frame.
7028 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
7029 bar: left, right, or nil. If VERTICAL-TYPE is t, this means use the
7030 frame's scroll-bar type.
7032 Fourth parameter HEIGHT specifies the pixel height for the horizontal
7033 scroll bar. If HEIGHT is nil, use the scroll-bar height of WINDOW's
7034 frame. Fifth parameter HORIZONTAL-TYPE specifies the type of the
7035 horizontal scroll bar: nil, bottom, or t. If HORIZONTAL-TYPE is t, this
7036 means to use the frame's horizontal scroll-bar type.
7038 Return t if scroll bars were actually changed and nil otherwise. */)
7039 (Lisp_Object window, Lisp_Object width, Lisp_Object vertical_type,
7040 Lisp_Object height, Lisp_Object horizontal_type)
7042 struct window *w
7043 = set_window_scroll_bars (decode_live_window (window),
7044 width, vertical_type, height, horizontal_type);
7045 return w ? (apply_window_adjustment (w), Qt) : Qnil;
7049 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
7050 0, 1, 0,
7051 doc: /* Get width and type of scroll bars of window WINDOW.
7052 WINDOW must be a live window and defaults to the selected one.
7054 Value is a list of the form (WIDTH COLUMNS VERTICAL-TYPE HEIGHT LINES
7055 HORIZONTAL-TYPE). If WIDTH or HEIGHT is nil or VERTICAL-TYPE or
7056 HORIZONTAL-TYPE is t, the window is using the frame's corresponding
7057 value. */)
7058 (Lisp_Object window)
7060 struct window *w = decode_live_window (window);
7062 return Fcons (((w->scroll_bar_width >= 0)
7063 ? make_number (w->scroll_bar_width)
7064 : Qnil),
7065 list5 (make_number (WINDOW_SCROLL_BAR_COLS (w)),
7066 w->vertical_scroll_bar_type,
7067 ((w->scroll_bar_height >= 0)
7068 ? make_number (w->scroll_bar_height)
7069 : Qnil),
7070 make_number (WINDOW_SCROLL_BAR_LINES (w)),
7071 w->horizontal_scroll_bar_type));
7074 /***********************************************************************
7075 Smooth scrolling
7076 ***********************************************************************/
7078 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
7079 doc: /* Return the amount by which WINDOW is scrolled vertically.
7080 If WINDOW is omitted or nil, it defaults to the selected window.
7081 Normally, value is a multiple of the canonical character height of WINDOW;
7082 optional second arg PIXELS-P means value is measured in pixels. */)
7083 (Lisp_Object window, Lisp_Object pixels_p)
7085 Lisp_Object result;
7086 struct window *w = decode_live_window (window);
7087 struct frame *f = XFRAME (w->frame);
7089 if (FRAME_WINDOW_P (f))
7090 result = (NILP (pixels_p)
7091 ? FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll)
7092 : make_number (-w->vscroll));
7093 else
7094 result = make_number (0);
7095 return result;
7099 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
7100 2, 3, 0,
7101 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
7102 WINDOW nil means use the selected window. Normally, VSCROLL is a
7103 non-negative multiple of the canonical character height of WINDOW;
7104 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
7105 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
7106 corresponds to an integral number of pixels. The return value is the
7107 result of this rounding.
7108 If PIXELS-P is non-nil, the return value is VSCROLL. */)
7109 (Lisp_Object window, Lisp_Object vscroll, Lisp_Object pixels_p)
7111 struct window *w = decode_live_window (window);
7112 struct frame *f = XFRAME (w->frame);
7114 CHECK_NUMBER_OR_FLOAT (vscroll);
7116 if (FRAME_WINDOW_P (f))
7118 int old_dy = w->vscroll;
7120 w->vscroll = - (NILP (pixels_p)
7121 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
7122 : XFLOATINT (vscroll));
7123 w->vscroll = min (w->vscroll, 0);
7125 if (w->vscroll != old_dy)
7127 /* Adjust glyph matrix of the frame if the virtual display
7128 area becomes larger than before. */
7129 if (w->vscroll < 0 && w->vscroll < old_dy)
7130 adjust_frame_glyphs (f);
7132 /* Prevent redisplay shortcuts. */
7133 XBUFFER (w->contents)->prevent_redisplay_optimizations_p = true;
7137 return Fwindow_vscroll (window, pixels_p);
7141 /* Call FN for all leaf windows on frame F. FN is called with the
7142 first argument being a pointer to the leaf window, and with
7143 additional argument USER_DATA. Stops when FN returns 0. */
7145 static void
7146 foreach_window (struct frame *f, bool (*fn) (struct window *, void *),
7147 void *user_data)
7149 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
7150 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
7151 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
7155 /* Helper function for foreach_window. Call FN for all leaf windows
7156 reachable from W. FN is called with the first argument being a
7157 pointer to the leaf window, and with additional argument USER_DATA.
7158 Stop when FN returns false. Value is false if stopped by FN. */
7160 static bool
7161 foreach_window_1 (struct window *w, bool (*fn) (struct window *, void *),
7162 void *user_data)
7164 bool cont;
7166 for (cont = true; w && cont;)
7168 if (WINDOWP (w->contents))
7169 cont = foreach_window_1 (XWINDOW (w->contents), fn, user_data);
7170 else
7171 cont = fn (w, user_data);
7173 w = NILP (w->next) ? 0 : XWINDOW (w->next);
7176 return cont;
7179 /***********************************************************************
7180 Initialization
7181 ***********************************************************************/
7183 /* Return true if window configurations CONFIGURATION1 and CONFIGURATION2
7184 describe the same state of affairs. This is used by Fequal.
7186 IGNORE_POSITIONS means ignore non-matching scroll positions
7187 and the like.
7189 This ignores a couple of things like the dedication status of
7190 window, combination_limit and the like. This might have to be
7191 fixed. */
7193 bool
7194 compare_window_configurations (Lisp_Object configuration1,
7195 Lisp_Object configuration2,
7196 bool ignore_positions)
7198 register struct save_window_data *d1, *d2;
7199 struct Lisp_Vector *sws1, *sws2;
7200 ptrdiff_t i;
7202 CHECK_WINDOW_CONFIGURATION (configuration1);
7203 CHECK_WINDOW_CONFIGURATION (configuration2);
7205 d1 = (struct save_window_data *) XVECTOR (configuration1);
7206 d2 = (struct save_window_data *) XVECTOR (configuration2);
7207 sws1 = XVECTOR (d1->saved_windows);
7208 sws2 = XVECTOR (d2->saved_windows);
7210 /* Frame settings must match. */
7211 if (d1->frame_cols != d2->frame_cols
7212 || d1->frame_lines != d2->frame_lines
7213 || d1->frame_menu_bar_lines != d2->frame_menu_bar_lines
7214 || !EQ (d1->selected_frame, d2->selected_frame)
7215 || !EQ (d1->current_buffer, d2->current_buffer)
7216 || (!ignore_positions
7217 && (!EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window)
7218 || !EQ (d1->minibuf_selected_window, d2->minibuf_selected_window)))
7219 || !EQ (d1->focus_frame, d2->focus_frame)
7220 /* Verify that the two configurations have the same number of windows. */
7221 || sws1->header.size != sws2->header.size)
7222 return false;
7224 for (i = 0; i < sws1->header.size; i++)
7226 struct saved_window *sw1, *sw2;
7228 sw1 = SAVED_WINDOW_N (sws1, i);
7229 sw2 = SAVED_WINDOW_N (sws2, i);
7231 if (
7232 /* The "current" windows in the two configurations must
7233 correspond to each other. */
7234 EQ (d1->current_window, sw1->window)
7235 != EQ (d2->current_window, sw2->window)
7236 /* Windows' buffers must match. */
7237 || !EQ (sw1->buffer, sw2->buffer)
7238 || !EQ (sw1->pixel_left, sw2->pixel_left)
7239 || !EQ (sw1->pixel_top, sw2->pixel_top)
7240 || !EQ (sw1->pixel_height, sw2->pixel_height)
7241 || !EQ (sw1->pixel_width, sw2->pixel_width)
7242 || !EQ (sw1->left_col, sw2->left_col)
7243 || !EQ (sw1->top_line, sw2->top_line)
7244 || !EQ (sw1->total_cols, sw2->total_cols)
7245 || !EQ (sw1->total_lines, sw2->total_lines)
7246 || !EQ (sw1->display_table, sw2->display_table)
7247 /* The next two disjuncts check the window structure for
7248 equality. */
7249 || !EQ (sw1->parent, sw2->parent)
7250 || !EQ (sw1->prev, sw2->prev)
7251 || (!ignore_positions
7252 && (!EQ (sw1->hscroll, sw2->hscroll)
7253 || !EQ (sw1->min_hscroll, sw2->min_hscroll)
7254 || !EQ (sw1->start_at_line_beg, sw2->start_at_line_beg)
7255 || NILP (Fequal (sw1->start, sw2->start))
7256 || NILP (Fequal (sw1->pointm, sw2->pointm))))
7257 || !EQ (sw1->left_margin_cols, sw2->left_margin_cols)
7258 || !EQ (sw1->right_margin_cols, sw2->right_margin_cols)
7259 || !EQ (sw1->left_fringe_width, sw2->left_fringe_width)
7260 || !EQ (sw1->right_fringe_width, sw2->right_fringe_width)
7261 || !EQ (sw1->fringes_outside_margins, sw2->fringes_outside_margins)
7262 || !EQ (sw1->scroll_bar_width, sw2->scroll_bar_width)
7263 || !EQ (sw1->scroll_bar_height, sw2->scroll_bar_height)
7264 || !EQ (sw1->vertical_scroll_bar_type, sw2->vertical_scroll_bar_type)
7265 || !EQ (sw1->horizontal_scroll_bar_type, sw2->horizontal_scroll_bar_type))
7266 return false;
7269 return true;
7272 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
7273 Scompare_window_configurations, 2, 2, 0,
7274 doc: /* Compare two window configurations as regards the structure of windows.
7275 This function ignores details such as the values of point
7276 and scrolling positions. */)
7277 (Lisp_Object x, Lisp_Object y)
7279 if (compare_window_configurations (x, y, true))
7280 return Qt;
7281 return Qnil;
7284 void
7285 init_window_once (void)
7287 struct frame *f = make_initial_frame ();
7288 XSETFRAME (selected_frame, f);
7289 Vterminal_frame = selected_frame;
7290 minibuf_window = f->minibuffer_window;
7291 selected_window = f->selected_window;
7294 void
7295 init_window (void)
7297 Vwindow_list = Qnil;
7300 void
7301 syms_of_window (void)
7303 DEFSYM (Qscroll_up, "scroll-up");
7304 DEFSYM (Qscroll_down, "scroll-down");
7305 DEFSYM (Qscroll_command, "scroll-command");
7307 Fput (Qscroll_up, Qscroll_command, Qt);
7308 Fput (Qscroll_down, Qscroll_command, Qt);
7310 DEFSYM (Qwindow_configuration_change_hook, "window-configuration-change-hook");
7311 DEFSYM (Qwindowp, "windowp");
7312 DEFSYM (Qwindow_configuration_p, "window-configuration-p");
7313 DEFSYM (Qwindow_live_p, "window-live-p");
7314 DEFSYM (Qwindow_valid_p, "window-valid-p");
7315 DEFSYM (Qwindow_deletable_p, "window-deletable-p");
7316 DEFSYM (Qdelete_window, "delete-window");
7317 DEFSYM (Qwindow__resize_root_window, "window--resize-root-window");
7318 DEFSYM (Qwindow__resize_root_window_vertically,
7319 "window--resize-root-window-vertically");
7320 DEFSYM (Qwindow__sanitize_window_sizes, "window--sanitize-window-sizes");
7321 DEFSYM (Qwindow__pixel_to_total, "window--pixel-to-total");
7322 DEFSYM (Qsafe, "safe");
7323 DEFSYM (Qdisplay_buffer, "display-buffer");
7324 DEFSYM (Qreplace_buffer_in_windows, "replace-buffer-in-windows");
7325 DEFSYM (Qrecord_window_buffer, "record-window-buffer");
7326 DEFSYM (Qget_mru_window, "get-mru-window");
7327 DEFSYM (Qwindow_size, "window-size");
7328 DEFSYM (Qtemp_buffer_show_hook, "temp-buffer-show-hook");
7329 DEFSYM (Qabove, "above");
7330 DEFSYM (Qclone_of, "clone-of");
7331 DEFSYM (Qfloor, "floor");
7332 DEFSYM (Qceiling, "ceiling");
7334 staticpro (&Vwindow_list);
7336 minibuf_selected_window = Qnil;
7337 staticpro (&minibuf_selected_window);
7339 window_scroll_pixel_based_preserve_x = -1;
7340 window_scroll_pixel_based_preserve_y = -1;
7341 window_scroll_preserve_hpos = -1;
7342 window_scroll_preserve_vpos = -1;
7344 DEFVAR_LISP ("temp-buffer-show-function", Vtemp_buffer_show_function,
7345 doc: /* Non-nil means call as function to display a help buffer.
7346 The function is called with one argument, the buffer to be displayed.
7347 Used by `with-output-to-temp-buffer'.
7348 If this function is used, then it must do the entire job of showing
7349 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
7350 Vtemp_buffer_show_function = Qnil;
7352 DEFVAR_LISP ("minibuffer-scroll-window", Vminibuf_scroll_window,
7353 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
7354 Vminibuf_scroll_window = Qnil;
7356 DEFVAR_BOOL ("mode-line-in-non-selected-windows", mode_line_in_non_selected_windows,
7357 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
7358 If the minibuffer is active, the `minibuffer-scroll-window' mode line
7359 is displayed in the `mode-line' face. */);
7360 mode_line_in_non_selected_windows = true;
7362 DEFVAR_LISP ("other-window-scroll-buffer", Vother_window_scroll_buffer,
7363 doc: /* If this is a live buffer, \\[scroll-other-window] should scroll its window. */);
7364 Vother_window_scroll_buffer = Qnil;
7366 DEFVAR_BOOL ("auto-window-vscroll", auto_window_vscroll_p,
7367 doc: /* Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
7368 auto_window_vscroll_p = true;
7370 DEFVAR_INT ("next-screen-context-lines", next_screen_context_lines,
7371 doc: /* Number of lines of continuity when scrolling by screenfuls. */);
7372 next_screen_context_lines = 2;
7374 DEFVAR_LISP ("scroll-preserve-screen-position",
7375 Vscroll_preserve_screen_position,
7376 doc: /* Controls if scroll commands move point to keep its screen position unchanged.
7377 A value of nil means point does not keep its screen position except
7378 at the scroll margin or window boundary respectively.
7379 A value of t means point keeps its screen position if the scroll
7380 command moved it vertically out of the window, e.g. when scrolling
7381 by full screens.
7382 Any other value means point always keeps its screen position.
7383 Scroll commands should have the `scroll-command' property
7384 on their symbols to be controlled by this variable. */);
7385 Vscroll_preserve_screen_position = Qnil;
7387 DEFVAR_LISP ("window-point-insertion-type", Vwindow_point_insertion_type,
7388 doc: /* Type of marker to use for `window-point'. */);
7389 Vwindow_point_insertion_type = Qnil;
7390 DEFSYM (Qwindow_point_insertion_type, "window_point_insertion_type");
7392 DEFVAR_LISP ("window-configuration-change-hook",
7393 Vwindow_configuration_change_hook,
7394 doc: /* Functions to call when window configuration changes.
7395 The buffer-local part is run once per window, with the relevant window
7396 selected; while the global part is run only once for the modified frame,
7397 with the relevant frame selected. */);
7398 Vwindow_configuration_change_hook = Qnil;
7400 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions,
7401 doc: /* Functions called during redisplay, if window sizes have changed.
7402 The value should be a list of functions that take one argument.
7403 During the first part of redisplay, for each frame, if any of its windows
7404 have changed size since the last redisplay, or have been split or deleted,
7405 all the functions in the list are called, with the frame as argument.
7406 If redisplay decides to resize the minibuffer window, it calls these
7407 functions on behalf of that as well. */);
7408 Vwindow_size_change_functions = Qnil;
7410 DEFVAR_LISP ("recenter-redisplay", Vrecenter_redisplay,
7411 doc: /* Non-nil means `recenter' redraws entire frame.
7412 If this option is non-nil, then the `recenter' command with a nil
7413 argument will redraw the entire frame; the special value `tty' causes
7414 the frame to be redrawn only if it is a tty frame. */);
7415 Vrecenter_redisplay = Qtty;
7417 DEFVAR_LISP ("window-combination-resize", Vwindow_combination_resize,
7418 doc: /* If t, resize window combinations proportionally.
7419 If this variable is nil, splitting a window gets the entire screen space
7420 for displaying the new window from the window to split. Deleting and
7421 resizing a window preferably resizes one adjacent window only.
7423 If this variable is t, splitting a window tries to get the space
7424 proportionally from all windows in the same combination. This also
7425 allows splitting a window that is otherwise too small or of fixed size.
7426 Resizing and deleting a window proportionally resize all windows in the
7427 same combination.
7429 Other values are reserved for future use.
7431 This variable takes no effect if the variable `window-combination-limit' is
7432 non-nil. */);
7433 Vwindow_combination_resize = Qnil;
7435 DEFVAR_LISP ("window-combination-limit", Vwindow_combination_limit,
7436 doc: /* If non-nil, splitting a window makes a new parent window.
7437 The following values are recognized:
7439 nil means splitting a window will create a new parent window only if the
7440 window has no parent window or the window shall become part of a
7441 combination orthogonal to the one it is part of.
7443 `window-size' means that splitting a window for displaying a buffer
7444 makes a new parent window provided `display-buffer' is supposed to
7445 explicitly set the window's size due to the presence of a
7446 `window-height' or `window-width' entry in the alist used by
7447 `display-buffer'. Otherwise, this value is handled like nil.
7449 `temp-buffer' means that splitting a window for displaying a temporary
7450 buffer always makes a new parent window. Otherwise, this value is
7451 handled like nil.
7453 `display-buffer' means that splitting a window for displaying a buffer
7454 always makes a new parent window. Since temporary buffers are
7455 displayed by the function `display-buffer', this value is stronger
7456 than `temp-buffer'. Splitting a window for other purpose makes a
7457 new parent window only if needed.
7459 t means that splitting a window always creates a new parent window. If
7460 all splits behave this way, each frame's window tree is a binary
7461 tree and every window but the frame's root window has exactly one
7462 sibling.
7464 Other values are reserved for future use. */);
7465 Vwindow_combination_limit = Qwindow_size;
7467 DEFVAR_LISP ("window-persistent-parameters", Vwindow_persistent_parameters,
7468 doc: /* Alist of persistent window parameters.
7469 This alist specifies which window parameters shall get saved by
7470 `current-window-configuration' and `window-state-get' and subsequently
7471 restored to their previous values by `set-window-configuration' and
7472 `window-state-put'.
7474 The car of each entry of this alist is the symbol specifying the
7475 parameter. The cdr is one of the following:
7477 nil means the parameter is neither saved by `window-state-get' nor by
7478 `current-window-configuration'.
7480 t means the parameter is saved by `current-window-configuration' and,
7481 provided its WRITABLE argument is nil, by `window-state-get'.
7483 The symbol `writable' means the parameter is saved unconditionally by
7484 both `current-window-configuration' and `window-state-get'. Do not use
7485 this value for parameters without read syntax (like windows or frames).
7487 Parameters not saved by `current-window-configuration' or
7488 `window-state-get' are left alone by `set-window-configuration'
7489 respectively are not installed by `window-state-put'. */);
7490 Vwindow_persistent_parameters = list1 (Fcons (Qclone_of, Qt));
7492 DEFVAR_BOOL ("window-resize-pixelwise", window_resize_pixelwise,
7493 doc: /* Non-nil means resize windows pixelwise.
7494 This currently affects the functions: `split-window', `maximize-window',
7495 `minimize-window', `fit-window-to-buffer' and `fit-frame-to-buffer', and
7496 all functions that symmetrically resize a parent window.
7498 Note that when a frame's pixel size is not a multiple of the
7499 frame's character size, at least one window may get resized
7500 pixelwise even if this option is nil. */);
7501 window_resize_pixelwise = false;
7503 DEFVAR_BOOL ("fast-but-imprecise-scrolling",
7504 Vfast_but_imprecise_scrolling,
7505 doc: /* When non-nil, accelerate scrolling operations.
7506 This comes into play when scrolling rapidly over previously
7507 unfontified buffer regions. Only those portions of the buffer which
7508 are actually going to be displayed get fontified.
7510 Note that this optimization can cause the portion of the buffer
7511 displayed after a scrolling operation to be somewhat inaccurate. */);
7512 Vfast_but_imprecise_scrolling = false;
7514 defsubr (&Sselected_window);
7515 defsubr (&Sminibuffer_window);
7516 defsubr (&Swindow_minibuffer_p);
7517 defsubr (&Swindowp);
7518 defsubr (&Swindow_valid_p);
7519 defsubr (&Swindow_live_p);
7520 defsubr (&Swindow_frame);
7521 defsubr (&Sframe_root_window);
7522 defsubr (&Sframe_first_window);
7523 defsubr (&Sframe_selected_window);
7524 defsubr (&Sset_frame_selected_window);
7525 defsubr (&Spos_visible_in_window_p);
7526 defsubr (&Swindow_line_height);
7527 defsubr (&Swindow_buffer);
7528 defsubr (&Swindow_parent);
7529 defsubr (&Swindow_top_child);
7530 defsubr (&Swindow_left_child);
7531 defsubr (&Swindow_next_sibling);
7532 defsubr (&Swindow_prev_sibling);
7533 defsubr (&Swindow_combination_limit);
7534 defsubr (&Sset_window_combination_limit);
7535 defsubr (&Swindow_use_time);
7536 defsubr (&Swindow_pixel_width);
7537 defsubr (&Swindow_pixel_height);
7538 defsubr (&Swindow_pixel_width_before_size_change);
7539 defsubr (&Swindow_pixel_height_before_size_change);
7540 defsubr (&Swindow_total_width);
7541 defsubr (&Swindow_total_height);
7542 defsubr (&Swindow_normal_size);
7543 defsubr (&Swindow_new_pixel);
7544 defsubr (&Swindow_new_total);
7545 defsubr (&Swindow_new_normal);
7546 defsubr (&Swindow_pixel_left);
7547 defsubr (&Swindow_pixel_top);
7548 defsubr (&Swindow_left_column);
7549 defsubr (&Swindow_top_line);
7550 defsubr (&Sset_window_new_pixel);
7551 defsubr (&Sset_window_new_total);
7552 defsubr (&Sset_window_new_normal);
7553 defsubr (&Swindow_resize_apply);
7554 defsubr (&Swindow_resize_apply_total);
7555 defsubr (&Swindow_body_height);
7556 defsubr (&Swindow_body_width);
7557 defsubr (&Swindow_hscroll);
7558 defsubr (&Sset_window_hscroll);
7559 defsubr (&Swindow_redisplay_end_trigger);
7560 defsubr (&Sset_window_redisplay_end_trigger);
7561 defsubr (&Swindow_mode_line_height);
7562 defsubr (&Swindow_header_line_height);
7563 defsubr (&Swindow_right_divider_width);
7564 defsubr (&Swindow_bottom_divider_width);
7565 defsubr (&Swindow_scroll_bar_width);
7566 defsubr (&Swindow_scroll_bar_height);
7567 defsubr (&Scoordinates_in_window_p);
7568 defsubr (&Swindow_at);
7569 defsubr (&Swindow_point);
7570 defsubr (&Swindow_old_point);
7571 defsubr (&Swindow_start);
7572 defsubr (&Swindow_end);
7573 defsubr (&Sset_window_point);
7574 defsubr (&Sset_window_start);
7575 defsubr (&Swindow_dedicated_p);
7576 defsubr (&Sset_window_dedicated_p);
7577 defsubr (&Swindow_display_table);
7578 defsubr (&Sset_window_display_table);
7579 defsubr (&Snext_window);
7580 defsubr (&Sprevious_window);
7581 defsubr (&Swindow__sanitize_window_sizes);
7582 defsubr (&Sget_buffer_window);
7583 defsubr (&Sdelete_other_windows_internal);
7584 defsubr (&Sdelete_window_internal);
7585 defsubr (&Sresize_mini_window_internal);
7586 defsubr (&Sset_window_buffer);
7587 defsubr (&Srun_window_configuration_change_hook);
7588 defsubr (&Srun_window_scroll_functions);
7589 defsubr (&Sselect_window);
7590 defsubr (&Sforce_window_update);
7591 defsubr (&Ssplit_window_internal);
7592 defsubr (&Sscroll_up);
7593 defsubr (&Sscroll_down);
7594 defsubr (&Sscroll_left);
7595 defsubr (&Sscroll_right);
7596 defsubr (&Sother_window_for_scrolling);
7597 defsubr (&Sscroll_other_window);
7598 defsubr (&Sminibuffer_selected_window);
7599 defsubr (&Srecenter);
7600 defsubr (&Swindow_text_width);
7601 defsubr (&Swindow_text_height);
7602 defsubr (&Smove_to_window_line);
7603 defsubr (&Swindow_configuration_p);
7604 defsubr (&Swindow_configuration_frame);
7605 defsubr (&Sset_window_configuration);
7606 defsubr (&Scurrent_window_configuration);
7607 defsubr (&Sset_window_margins);
7608 defsubr (&Swindow_margins);
7609 defsubr (&Sset_window_fringes);
7610 defsubr (&Swindow_fringes);
7611 defsubr (&Sset_window_scroll_bars);
7612 defsubr (&Swindow_scroll_bars);
7613 defsubr (&Swindow_vscroll);
7614 defsubr (&Sset_window_vscroll);
7615 defsubr (&Scompare_window_configurations);
7616 defsubr (&Swindow_list);
7617 defsubr (&Swindow_list_1);
7618 defsubr (&Swindow_prev_buffers);
7619 defsubr (&Sset_window_prev_buffers);
7620 defsubr (&Swindow_next_buffers);
7621 defsubr (&Sset_window_next_buffers);
7622 defsubr (&Swindow_parameters);
7623 defsubr (&Swindow_parameter);
7624 defsubr (&Sset_window_parameter);
7627 void
7628 keys_of_window (void)
7630 initial_define_key (control_x_map, '<', "scroll-left");
7631 initial_define_key (control_x_map, '>', "scroll-right");
7633 initial_define_key (global_map, Ctl ('V'), "scroll-up-command");
7634 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
7635 initial_define_key (meta_map, 'v', "scroll-down-command");