Some improvements in vc
[emacs.git] / src / window.c
blobcf7fa44ae41dc05e8df01fb877f29af27c65f0cc
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, swindow IF_LINT (= Qnil), delta;
2914 ptrdiff_t startpos IF_LINT (= 0), startbyte IF_LINT (= 0);
2915 int top IF_LINT (= 0), new_top;
2916 bool resize_failed = false;
2918 w = decode_valid_window (window);
2919 XSETWINDOW (window, w);
2920 f = XFRAME (w->frame);
2922 if (NILP (root))
2923 /* ROOT is the frame's root window. */
2925 root = FRAME_ROOT_WINDOW (f);
2926 r = XWINDOW (root);
2928 else
2929 /* ROOT must be an ancestor of WINDOW. */
2931 r = decode_valid_window (root);
2932 pwindow = XWINDOW (window)->parent;
2933 while (!NILP (pwindow))
2934 if (EQ (pwindow, root))
2935 break;
2936 else
2937 pwindow = XWINDOW (pwindow)->parent;
2938 if (!EQ (pwindow, root))
2939 error ("Specified root is not an ancestor of specified window");
2942 if (EQ (window, root))
2943 /* A noop. */
2944 return Qnil;
2945 /* I don't understand the "top > 0" part below. If we deal with a
2946 standalone minibuffer it would have been caught by the preceding
2947 test. */
2948 else if (MINI_WINDOW_P (w)) /* && top > 0) */
2949 error ("Can't expand minibuffer to full frame");
2951 if (BUFFERP (w->contents))
2953 startpos = marker_position (w->start);
2954 startbyte = marker_byte_position (w->start);
2955 top = (WINDOW_TOP_EDGE_LINE (w)
2956 - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w))));
2957 /* Make sure WINDOW is the frame's selected window. */
2958 if (!EQ (window, FRAME_SELECTED_WINDOW (f)))
2960 if (EQ (selected_frame, w->frame))
2961 Fselect_window (window, Qnil);
2962 else
2963 fset_selected_window (f, window);
2966 else
2968 /* See if the frame's selected window is a part of the window
2969 subtree rooted at WINDOW, by finding all the selected window's
2970 parents and comparing each one with WINDOW. If it isn't we
2971 need a new selected window for this frame. */
2972 swindow = FRAME_SELECTED_WINDOW (f);
2973 while (true)
2975 pwindow = swindow;
2976 while (!NILP (pwindow) && !EQ (window, pwindow))
2977 pwindow = XWINDOW (pwindow)->parent;
2979 if (EQ (window, pwindow))
2980 /* If WINDOW is an ancestor of SWINDOW, then SWINDOW is ok
2981 as the new selected window. */
2982 break;
2983 else
2984 /* Else try the previous window of SWINDOW. */
2985 swindow = Fprevious_window (swindow, Qlambda, Qnil);
2988 if (!EQ (swindow, FRAME_SELECTED_WINDOW (f)))
2990 if (EQ (selected_frame, w->frame))
2991 Fselect_window (swindow, Qnil);
2992 else
2993 fset_selected_window (f, swindow);
2997 block_input ();
2998 if (!FRAME_INITIAL_P (f))
3000 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
3002 /* We are going to free the glyph matrices of WINDOW, and with
3003 that we might lose any information about glyph rows that have
3004 some of their glyphs highlighted in mouse face. (These rows
3005 are marked with a mouse_face_p flag.) If WINDOW
3006 indeed has some glyphs highlighted in mouse face, signal to
3007 frame's up-to-date hook that mouse highlight was overwritten,
3008 so that it will arrange for redisplaying the highlight. */
3009 if (EQ (hlinfo->mouse_face_window, window))
3010 reset_mouse_highlight (hlinfo);
3012 free_window_matrices (r);
3014 fset_redisplay (f);
3015 Vwindow_list = Qnil;
3017 if (!WINDOW_LEAF_P (w))
3019 /* Resize child windows vertically. */
3020 XSETINT (delta, r->pixel_height - w->pixel_height);
3021 w->pixel_top = r->pixel_top;
3022 w->top_line = r->top_line;
3023 resize_root_window (window, delta, Qnil, Qnil, Qt);
3024 if (window_resize_check (w, false))
3026 window_resize_apply (w, false);
3027 window_pixel_to_total (w->frame, Qnil);
3029 else
3031 resize_root_window (window, delta, Qnil, Qt, Qt);
3032 if (window_resize_check (w, false))
3034 window_resize_apply (w, false);
3035 window_pixel_to_total (w->frame, Qnil);
3037 else
3038 resize_failed = true;
3041 /* Resize child windows horizontally. */
3042 if (!resize_failed)
3044 w->left_col = r->left_col;
3045 w->pixel_left = r->pixel_left;
3046 XSETINT (delta, r->pixel_width - w->pixel_width);
3047 resize_root_window (window, delta, Qt, Qnil, Qt);
3048 if (window_resize_check (w, true))
3050 window_resize_apply (w, true);
3051 window_pixel_to_total (w->frame, Qt);
3053 else
3055 resize_root_window (window, delta, Qt, Qt, Qt);
3056 if (window_resize_check (w, true))
3058 window_resize_apply (w, true);
3059 window_pixel_to_total (w->frame, Qt);
3061 else
3062 resize_failed = true;
3066 if (resize_failed)
3067 /* Play safe, if we still can ... */
3069 window = swindow;
3070 w = XWINDOW (window);
3074 /* Cleanly unlink WINDOW from window-tree. */
3075 if (!NILP (w->prev))
3076 /* Get SIBLING above (on the left of) WINDOW. */
3078 sibling = w->prev;
3079 s = XWINDOW (sibling);
3080 wset_next (s, w->next);
3081 if (!NILP (s->next))
3082 wset_prev (XWINDOW (s->next), sibling);
3084 else
3085 /* Get SIBLING below (on the right of) WINDOW. */
3087 sibling = w->next;
3088 s = XWINDOW (sibling);
3089 wset_prev (s, Qnil);
3090 wset_combination (XWINDOW (w->parent),
3091 XWINDOW (w->parent)->horizontal, sibling);
3094 /* Delete ROOT and all child windows of ROOT. */
3095 if (WINDOWP (r->contents))
3097 delete_all_child_windows (r->contents);
3098 wset_combination (r, false, Qnil);
3101 replace_window (root, window, true);
3103 /* This must become SWINDOW anyway ....... */
3104 if (BUFFERP (w->contents) && !resize_failed)
3106 /* Try to minimize scrolling, by setting the window start to the
3107 point will cause the text at the old window start to be at the
3108 same place on the frame. But don't try to do this if the
3109 window start is outside the visible portion (as might happen
3110 when the display is not current, due to typeahead). */
3111 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
3112 if (new_top != top
3113 && startpos >= BUF_BEGV (XBUFFER (w->contents))
3114 && startpos <= BUF_ZV (XBUFFER (w->contents)))
3116 struct position pos;
3117 struct buffer *obuf = current_buffer;
3119 Fset_buffer (w->contents);
3120 /* This computation used to temporarily move point, but that
3121 can have unwanted side effects due to text properties. */
3122 pos = *vmotion (startpos, startbyte, -top, w);
3124 set_marker_both (w->start, w->contents, pos.bufpos, pos.bytepos);
3125 w->window_end_valid = false;
3126 w->start_at_line_beg = (pos.bytepos == BEGV_BYTE
3127 || FETCH_BYTE (pos.bytepos - 1) == '\n');
3128 /* We need to do this, so that the window-scroll-functions
3129 get called. */
3130 w->optional_new_start = true;
3132 set_buffer_internal (obuf);
3136 adjust_frame_glyphs (f);
3137 unblock_input ();
3139 run_window_configuration_change_hook (f);
3141 return Qnil;
3145 void
3146 replace_buffer_in_windows (Lisp_Object buffer)
3148 call1 (Qreplace_buffer_in_windows, buffer);
3151 /* If BUFFER is shown in a window, safely replace it with some other
3152 buffer in all windows of all frames, even those on other keyboards. */
3154 void
3155 replace_buffer_in_windows_safely (Lisp_Object buffer)
3157 if (buffer_window_count (XBUFFER (buffer)))
3159 Lisp_Object tail, frame;
3161 /* A single call to window_loop won't do the job because it only
3162 considers frames on the current keyboard. So loop manually over
3163 frames, and handle each one. */
3164 FOR_EACH_FRAME (tail, frame)
3165 window_loop (REPLACE_BUFFER_IN_WINDOWS_SAFELY, buffer, true, frame);
3169 /* The following three routines are needed for running a window's
3170 configuration change hook. */
3171 static void
3172 run_funs (Lisp_Object funs)
3174 for (; CONSP (funs); funs = XCDR (funs))
3175 if (!EQ (XCAR (funs), Qt))
3176 call0 (XCAR (funs));
3179 static void
3180 select_window_norecord (Lisp_Object window)
3182 if (WINDOW_LIVE_P (window))
3183 Fselect_window (window, Qt);
3186 static void
3187 select_frame_norecord (Lisp_Object frame)
3189 if (FRAME_LIVE_P (XFRAME (frame)))
3190 Fselect_frame (frame, Qt);
3193 static void
3194 run_window_configuration_change_hook (struct frame *f)
3196 ptrdiff_t count = SPECPDL_INDEX ();
3197 Lisp_Object frame, global_wcch
3198 = Fdefault_value (Qwindow_configuration_change_hook);
3199 XSETFRAME (frame, f);
3201 if (NILP (Vrun_hooks)
3202 || !(f->can_x_set_window_size)
3203 || !(f->after_make_frame))
3204 return;
3206 /* Use the right buffer. Matters when running the local hooks. */
3207 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
3209 record_unwind_current_buffer ();
3210 Fset_buffer (Fwindow_buffer (Qnil));
3213 if (SELECTED_FRAME () != f)
3215 record_unwind_protect (select_frame_norecord, selected_frame);
3216 select_frame_norecord (frame);
3219 /* Look for buffer-local values. */
3221 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
3222 for (; CONSP (windows); windows = XCDR (windows))
3224 Lisp_Object window = XCAR (windows);
3225 Lisp_Object buffer = Fwindow_buffer (window);
3226 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
3227 buffer)))
3229 ptrdiff_t inner_count = SPECPDL_INDEX ();
3230 record_unwind_protect (select_window_norecord, selected_window);
3231 select_window_norecord (window);
3232 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
3233 buffer));
3234 unbind_to (inner_count, Qnil);
3239 run_funs (global_wcch);
3240 unbind_to (count, Qnil);
3243 DEFUN ("run-window-configuration-change-hook", Frun_window_configuration_change_hook,
3244 Srun_window_configuration_change_hook, 0, 1, 0,
3245 doc: /* Run `window-configuration-change-hook' for FRAME.
3246 If FRAME is omitted or nil, it defaults to the selected frame. */)
3247 (Lisp_Object frame)
3249 run_window_configuration_change_hook (decode_live_frame (frame));
3250 return Qnil;
3253 DEFUN ("run-window-scroll-functions", Frun_window_scroll_functions,
3254 Srun_window_scroll_functions, 0, 1, 0,
3255 doc: /* Run `window-scroll-functions' for WINDOW.
3256 If WINDOW is omitted or nil, it defaults to the selected window. */)
3257 (Lisp_Object window)
3259 if (! NILP (Vwindow_scroll_functions))
3260 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3261 Fmarker_position (decode_live_window (window)->start));
3262 return Qnil;
3266 /* Compare old and present pixel sizes of windows in tree rooted at W.
3267 Return true iff any of these windows differs in size. */
3269 static bool
3270 window_size_changed (struct window *w)
3272 if (w->pixel_width != w->pixel_width_before_size_change
3273 || w->pixel_height != w->pixel_height_before_size_change)
3274 return true;
3276 if (WINDOW_INTERNAL_P (w))
3278 w = XWINDOW (w->contents);
3279 while (w)
3281 if (window_size_changed (w))
3282 return true;
3284 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3288 return false;
3291 /* Set before size change pixel sizes of windows in tree rooted at W to
3292 their present pixel sizes. */
3294 static void
3295 window_set_before_size_change_sizes (struct window *w)
3297 w->pixel_width_before_size_change = w->pixel_width;
3298 w->pixel_height_before_size_change = w->pixel_height;
3300 if (WINDOW_INTERNAL_P (w))
3302 w = XWINDOW (w->contents);
3303 while (w)
3305 window_set_before_size_change_sizes (w);
3306 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3312 void
3313 run_window_size_change_functions (Lisp_Object frame)
3315 struct frame *f = XFRAME (frame);
3316 struct window *r = XWINDOW (FRAME_ROOT_WINDOW (f));
3317 Lisp_Object functions = Vwindow_size_change_functions;
3319 if (FRAME_WINDOW_CONFIGURATION_CHANGED (f)
3320 || window_size_changed (r))
3322 while (CONSP (functions))
3324 if (!EQ (XCAR (functions), Qt))
3325 safe_call1 (XCAR (functions), frame);
3326 functions = XCDR (functions);
3329 window_set_before_size_change_sizes (r);
3330 FRAME_WINDOW_CONFIGURATION_CHANGED (f) = false;
3335 /* Make WINDOW display BUFFER. RUN_HOOKS_P means it's allowed
3336 to run hooks. See make_frame for a case where it's not allowed.
3337 KEEP_MARGINS_P means that the current margins, fringes, and
3338 scroll-bar settings of the window are not reset from the buffer's
3339 local settings. */
3341 void
3342 set_window_buffer (Lisp_Object window, Lisp_Object buffer,
3343 bool run_hooks_p, bool keep_margins_p)
3345 struct window *w = XWINDOW (window);
3346 struct buffer *b = XBUFFER (buffer);
3347 ptrdiff_t count = SPECPDL_INDEX ();
3348 bool samebuf = EQ (buffer, w->contents);
3350 wset_buffer (w, buffer);
3352 if (EQ (window, selected_window))
3353 bset_last_selected_window (b, window);
3355 /* Let redisplay errors through. */
3356 b->display_error_modiff = 0;
3358 /* Update time stamps of buffer display. */
3359 if (INTEGERP (BVAR (b, display_count)))
3360 bset_display_count (b, make_number (XINT (BVAR (b, display_count)) + 1));
3361 bset_display_time (b, Fcurrent_time ());
3363 w->window_end_pos = 0;
3364 w->window_end_vpos = 0;
3365 w->last_cursor_vpos = 0;
3367 if (!(keep_margins_p && samebuf))
3368 { /* If we're not actually changing the buffer, don't reset hscroll
3369 and vscroll. Resetting hscroll and vscroll here is problematic
3370 for things like image-mode and doc-view-mode since it resets
3371 the image's position whenever we resize the frame. */
3372 w->hscroll = w->min_hscroll = w->hscroll_whole = 0;
3373 w->suspend_auto_hscroll = false;
3374 w->vscroll = 0;
3375 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3376 set_marker_both (w->old_pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3377 set_marker_restricted (w->start,
3378 make_number (b->last_window_start),
3379 buffer);
3380 w->start_at_line_beg = false;
3381 w->force_start = false;
3384 wset_redisplay (w);
3385 wset_update_mode_line (w);
3387 /* We must select BUFFER to run the window-scroll-functions and to look up
3388 the buffer-local value of Vwindow_point_insertion_type. */
3389 record_unwind_current_buffer ();
3390 Fset_buffer (buffer);
3392 XMARKER (w->pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3393 XMARKER (w->old_pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3395 if (!keep_margins_p)
3397 /* Set left and right marginal area width etc. from buffer. */
3398 set_window_fringes (w, BVAR (b, left_fringe_width),
3399 BVAR (b, right_fringe_width),
3400 BVAR (b, fringes_outside_margins));
3401 set_window_scroll_bars (w, BVAR (b, scroll_bar_width),
3402 BVAR (b, vertical_scroll_bar_type),
3403 BVAR (b, scroll_bar_height),
3404 BVAR (b, horizontal_scroll_bar_type));
3405 set_window_margins (w, BVAR (b, left_margin_cols),
3406 BVAR (b, right_margin_cols));
3407 apply_window_adjustment (w);
3410 if (run_hooks_p)
3412 if (!NILP (Vwindow_scroll_functions))
3413 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3414 Fmarker_position (w->start));
3415 if (!samebuf)
3416 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3419 unbind_to (count, Qnil);
3422 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3423 doc: /* Make WINDOW display BUFFER-OR-NAME.
3424 WINDOW must be a live window and defaults to the selected one.
3425 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3427 Optional third argument KEEP-MARGINS non-nil means that WINDOW's current
3428 display margins, fringe widths, and scroll bar settings are preserved;
3429 the default is to reset these from the local settings for BUFFER-OR-NAME
3430 or the frame defaults. Return nil.
3432 This function throws an error when WINDOW is strongly dedicated to its
3433 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3434 already display BUFFER-OR-NAME.
3436 This function runs `window-scroll-functions' before running
3437 `window-configuration-change-hook'. */)
3438 (register Lisp_Object window, Lisp_Object buffer_or_name, Lisp_Object keep_margins)
3440 register Lisp_Object tem, buffer;
3441 register struct window *w = decode_live_window (window);
3443 XSETWINDOW (window, w);
3444 buffer = Fget_buffer (buffer_or_name);
3445 CHECK_BUFFER (buffer);
3446 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
3447 error ("Attempt to display deleted buffer");
3449 tem = w->contents;
3450 if (NILP (tem))
3451 error ("Window is deleted");
3452 else
3454 if (!EQ (tem, buffer))
3456 if (EQ (w->dedicated, Qt))
3457 /* WINDOW is strongly dedicated to its buffer, signal an
3458 error. */
3459 error ("Window is dedicated to `%s'", SDATA (BVAR (XBUFFER (tem), name)));
3460 else
3461 /* WINDOW is weakly dedicated to its buffer, reset
3462 dedication. */
3463 wset_dedicated (w, Qnil);
3465 call1 (Qrecord_window_buffer, window);
3468 unshow_buffer (w);
3471 set_window_buffer (window, buffer, true, !NILP (keep_margins));
3473 return Qnil;
3476 static Lisp_Object
3477 display_buffer (Lisp_Object buffer, Lisp_Object not_this_window_p, Lisp_Object override_frame)
3479 return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame);
3482 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3483 0, 1, 0,
3484 doc: /* Force all windows to be updated on next redisplay.
3485 If optional arg OBJECT is a window, force redisplay of that window only.
3486 If OBJECT is a buffer or buffer name, force redisplay of all windows
3487 displaying that buffer. */)
3488 (Lisp_Object object)
3490 if (NILP (object))
3492 windows_or_buffers_changed = 29;
3493 update_mode_lines = 28;
3494 return Qt;
3497 if (WINDOWP (object))
3499 struct window *w = XWINDOW (object);
3500 mark_window_display_accurate (object, false);
3501 w->update_mode_line = true;
3502 if (BUFFERP (w->contents))
3503 XBUFFER (w->contents)->prevent_redisplay_optimizations_p = true;
3504 update_mode_lines = 29;
3505 return Qt;
3508 if (STRINGP (object))
3509 object = Fget_buffer (object);
3510 if (BUFFERP (object) && BUFFER_LIVE_P (XBUFFER (object))
3511 && buffer_window_count (XBUFFER (object)))
3513 /* If buffer is live and shown in at least one window, find
3514 all windows showing this buffer and force update of them. */
3515 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, false, Qvisible);
3516 return NILP (object) ? Qnil : Qt;
3519 /* If nothing suitable was found, just return.
3520 We could signal an error, but this feature will typically be used
3521 asynchronously in timers or process sentinels, so we don't. */
3522 return Qnil;
3525 /* Obsolete since 24.3. */
3526 void
3527 temp_output_buffer_show (register Lisp_Object buf)
3529 register struct buffer *old = current_buffer;
3530 register Lisp_Object window;
3531 register struct window *w;
3533 bset_directory (XBUFFER (buf), BVAR (current_buffer, directory));
3535 Fset_buffer (buf);
3536 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3537 BEGV = BEG;
3538 ZV = Z;
3539 SET_PT (BEG);
3540 set_buffer_internal (old);
3542 if (!NILP (Vtemp_buffer_show_function))
3543 call1 (Vtemp_buffer_show_function, buf);
3544 else if (WINDOW_LIVE_P (window = display_buffer (buf, Qnil, Qnil)))
3546 if (!EQ (XWINDOW (window)->frame, selected_frame))
3547 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3548 Vminibuf_scroll_window = window;
3549 w = XWINDOW (window);
3550 w->hscroll = w->min_hscroll = w->hscroll_whole = 0;
3551 w->suspend_auto_hscroll = false;
3552 set_marker_restricted_both (w->start, buf, BEG, BEG);
3553 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
3554 set_marker_restricted_both (w->old_pointm, buf, BEG, BEG);
3556 /* Run temp-buffer-show-hook, with the chosen window selected
3557 and its buffer current. */
3559 ptrdiff_t count = SPECPDL_INDEX ();
3560 Lisp_Object prev_window, prev_buffer;
3561 prev_window = selected_window;
3562 XSETBUFFER (prev_buffer, old);
3564 /* Select the window that was chosen, for running the hook.
3565 Note: Both Fselect_window and select_window_norecord may
3566 set-buffer to the buffer displayed in the window,
3567 so we need to save the current buffer. --stef */
3568 record_unwind_protect (restore_buffer, prev_buffer);
3569 record_unwind_protect (select_window_norecord, prev_window);
3570 Fselect_window (window, Qt);
3571 Fset_buffer (w->contents);
3572 run_hook (Qtemp_buffer_show_hook);
3573 unbind_to (count, Qnil);
3578 /* Allocate basically initialized window. */
3580 static struct window *
3581 allocate_window (void)
3583 return ALLOCATE_ZEROED_PSEUDOVECTOR
3584 (struct window, current_matrix, PVEC_WINDOW);
3587 /* Make new window, have it replace WINDOW in window-tree, and make
3588 WINDOW its only vertical child (HORFLAG means make WINDOW its only
3589 horizontal child). */
3590 static void
3591 make_parent_window (Lisp_Object window, bool horflag)
3593 Lisp_Object parent;
3594 register struct window *o, *p;
3596 o = XWINDOW (window);
3597 p = allocate_window ();
3598 memcpy ((char *) p + sizeof (struct vectorlike_header),
3599 (char *) o + sizeof (struct vectorlike_header),
3600 word_size * VECSIZE (struct window));
3601 /* P's buffer slot may change from nil to a buffer... */
3602 adjust_window_count (p, 1);
3603 XSETWINDOW (parent, p);
3605 p->sequence_number = ++sequence_number;
3607 replace_window (window, parent, true);
3609 wset_next (o, Qnil);
3610 wset_prev (o, Qnil);
3611 wset_parent (o, parent);
3612 /* ...but now P becomes an internal window. */
3613 wset_start (p, Qnil);
3614 wset_pointm (p, Qnil);
3615 wset_old_pointm (p, Qnil);
3616 wset_buffer (p, Qnil);
3617 wset_combination (p, horflag, window);
3618 wset_combination_limit (p, Qnil);
3619 wset_window_parameters (p, Qnil);
3622 /* Make new window from scratch. */
3623 Lisp_Object
3624 make_window (void)
3626 Lisp_Object window;
3627 register struct window *w;
3629 w = allocate_window ();
3630 /* Initialize Lisp data. Note that allocate_window initializes all
3631 Lisp data to nil, so do it only for slots which should not be nil. */
3632 wset_normal_lines (w, make_float (1.0));
3633 wset_normal_cols (w, make_float (1.0));
3634 wset_new_total (w, make_number (0));
3635 wset_new_normal (w, make_number (0));
3636 wset_new_pixel (w, make_number (0));
3637 wset_start (w, Fmake_marker ());
3638 wset_pointm (w, Fmake_marker ());
3639 wset_old_pointm (w, Fmake_marker ());
3640 wset_vertical_scroll_bar_type (w, Qt);
3641 wset_horizontal_scroll_bar_type (w, Qt);
3642 /* These Lisp fields are marked specially so they're not set to nil by
3643 allocate_window. */
3644 wset_prev_buffers (w, Qnil);
3645 wset_next_buffers (w, Qnil);
3647 /* Initialize non-Lisp data. Note that allocate_window zeroes out all
3648 non-Lisp data, so do it only for slots which should not be zero. */
3649 w->nrows_scale_factor = w->ncols_scale_factor = 1;
3650 w->left_fringe_width = w->right_fringe_width = -1;
3651 w->mode_line_height = w->header_line_height = -1;
3652 #ifdef HAVE_WINDOW_SYSTEM
3653 w->phys_cursor_type = NO_CURSOR;
3654 w->phys_cursor_width = -1;
3655 #endif
3656 w->sequence_number = ++sequence_number;
3657 w->pixel_width_before_size_change = 0;
3658 w->pixel_height_before_size_change = 0;
3659 w->scroll_bar_width = -1;
3660 w->scroll_bar_height = -1;
3661 w->column_number_displayed = -1;
3662 /* Reset window_list. */
3663 Vwindow_list = Qnil;
3664 /* Return window. */
3665 XSETWINDOW (window, w);
3666 return window;
3669 DEFUN ("set-window-new-pixel", Fset_window_new_pixel, Sset_window_new_pixel, 2, 3, 0,
3670 doc: /* Set new pixel size of WINDOW to SIZE.
3671 WINDOW must be a valid window and defaults to the selected one.
3672 Return SIZE.
3674 Optional argument ADD non-nil means add SIZE to the new pixel size of
3675 WINDOW and return the sum.
3677 The new pixel size of WINDOW, if valid, will be shortly installed as
3678 WINDOW's pixel height (see `window-pixel-height') or pixel width (see
3679 `window-pixel-width').
3681 Note: This function does not operate on any child windows of WINDOW. */)
3682 (Lisp_Object window, Lisp_Object size, Lisp_Object add)
3684 struct window *w = decode_valid_window (window);
3685 EMACS_INT size_min = NILP (add) ? 0 : - XINT (w->new_pixel);
3686 EMACS_INT size_max = size_min + min (INT_MAX, MOST_POSITIVE_FIXNUM);
3688 CHECK_RANGED_INTEGER (size, size_min, size_max);
3689 if (NILP (add))
3690 wset_new_pixel (w, size);
3691 else
3692 wset_new_pixel (w, make_number (XINT (w->new_pixel) + XINT (size)));
3694 return w->new_pixel;
3697 DEFUN ("set-window-new-total", Fset_window_new_total, Sset_window_new_total, 2, 3, 0,
3698 doc: /* Set new total size of WINDOW to SIZE.
3699 WINDOW must be a valid window and defaults to the selected one.
3700 Return SIZE.
3702 Optional argument ADD non-nil means add SIZE to the new total size of
3703 WINDOW and return the sum.
3705 The new total size of WINDOW, if valid, will be shortly installed as
3706 WINDOW's total height (see `window-total-height') or total width (see
3707 `window-total-width').
3709 Note: This function does not operate on any child windows of WINDOW. */)
3710 (Lisp_Object window, Lisp_Object size, Lisp_Object add)
3712 struct window *w = decode_valid_window (window);
3714 CHECK_NUMBER (size);
3715 if (NILP (add))
3716 wset_new_total (w, size);
3717 else
3718 wset_new_total (w, make_number (XINT (w->new_total) + XINT (size)));
3720 return w->new_total;
3723 DEFUN ("set-window-new-normal", Fset_window_new_normal, Sset_window_new_normal, 1, 2, 0,
3724 doc: /* Set new normal size of WINDOW to SIZE.
3725 WINDOW must be a valid window and defaults to the selected one.
3726 Return SIZE.
3728 The new normal size of WINDOW, if valid, will be shortly installed as
3729 WINDOW's normal size (see `window-normal-size').
3731 Note: This function does not operate on any child windows of WINDOW. */)
3732 (Lisp_Object window, Lisp_Object size)
3734 wset_new_normal (decode_valid_window (window), size);
3735 return size;
3738 /* Return true if setting w->pixel_height (w->pixel_width if HORFLAG)
3739 to w->new_pixel would result in correct heights (widths)
3740 for window W and recursively all child windows of W.
3742 Note: This function does not check any of `window-fixed-size-p',
3743 `window-min-height' or `window-min-width'. It does check that window
3744 sizes do not drop below one line (two columns). */
3745 static bool
3746 window_resize_check (struct window *w, bool horflag)
3748 struct frame *f = XFRAME (w->frame);
3749 struct window *c;
3751 if (WINDOW_VERTICAL_COMBINATION_P (w))
3752 /* W is a vertical combination. */
3754 c = XWINDOW (w->contents);
3755 if (horflag)
3756 /* All child windows of W must have the same width as W. */
3758 while (c)
3760 if (XINT (c->new_pixel) != XINT (w->new_pixel)
3761 || !window_resize_check (c, horflag))
3762 return false;
3764 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3767 return true;
3769 else
3770 /* The sum of the heights of the child windows of W must equal
3771 W's height. */
3773 int remaining_pixels = XINT (w->new_pixel);
3775 while (c)
3777 if (!window_resize_check (c, horflag))
3778 return false;
3780 remaining_pixels -= XINT (c->new_pixel);
3781 if (remaining_pixels < 0)
3782 return false;
3783 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3786 return remaining_pixels == 0;
3789 else if (WINDOW_HORIZONTAL_COMBINATION_P (w))
3790 /* W is a horizontal combination. */
3792 c = XWINDOW (w->contents);
3793 if (horflag)
3794 /* The sum of the widths of the child windows of W must equal W's
3795 width. */
3797 int remaining_pixels = XINT (w->new_pixel);
3799 while (c)
3801 if (!window_resize_check (c, horflag))
3802 return false;
3804 remaining_pixels -= XINT (c->new_pixel);
3805 if (remaining_pixels < 0)
3806 return false;
3807 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3810 return remaining_pixels == 0;
3812 else
3813 /* All child windows of W must have the same height as W. */
3815 while (c)
3817 if (XINT (c->new_pixel) != XINT (w->new_pixel)
3818 || !window_resize_check (c, horflag))
3819 return false;
3821 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3824 return true;
3827 else
3828 /* A leaf window. Make sure it's not too small. The following
3829 hardcodes the values of `window-safe-min-width' (2) and
3830 `window-safe-min-height' (1) which are defined in window.el. */
3831 return (XINT (w->new_pixel) >= (horflag
3832 ? (2 * FRAME_COLUMN_WIDTH (f))
3833 : FRAME_LINE_HEIGHT (f)));
3837 /* Set w->pixel_height (w->pixel_width if HORFLAG) to
3838 w->new_pixel for window W and recursively all child windows of W.
3839 Also calculate and assign the new vertical (horizontal) pixel start
3840 positions of each of these windows.
3842 This function does not perform any error checks. Make sure you have
3843 run window_resize_check on W before applying this function. */
3844 static void
3845 window_resize_apply (struct window *w, bool horflag)
3847 struct window *c;
3848 int edge;
3849 int unit = (horflag
3850 ? FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w))
3851 : FRAME_LINE_HEIGHT (WINDOW_XFRAME (w)));
3853 /* Note: Assigning new_normal requires that the new total size of the
3854 parent window has been set *before*. */
3855 if (horflag)
3857 w->pixel_width = XFASTINT (w->new_pixel);
3858 w->total_cols = w->pixel_width / unit;
3859 if (NUMBERP (w->new_normal))
3860 wset_normal_cols (w, w->new_normal);
3862 edge = w->pixel_left;
3864 else
3866 w->pixel_height = XFASTINT (w->new_pixel);
3867 w->total_lines = w->pixel_height / unit;
3868 if (NUMBERP (w->new_normal))
3869 wset_normal_lines (w, w->new_normal);
3871 edge = w->pixel_top;
3874 if (WINDOW_VERTICAL_COMBINATION_P (w))
3875 /* W is a vertical combination. */
3877 c = XWINDOW (w->contents);
3878 while (c)
3880 if (horflag)
3882 c->pixel_left = edge;
3883 c->left_col = edge / unit;
3885 else
3887 c->pixel_top = edge;
3888 c->top_line = edge / unit;
3890 window_resize_apply (c, horflag);
3891 if (!horflag)
3892 edge = edge + c->pixel_height;
3894 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3897 else if (WINDOW_HORIZONTAL_COMBINATION_P (w))
3898 /* W is a horizontal combination. */
3900 c = XWINDOW (w->contents);
3901 while (c)
3903 if (horflag)
3905 c->pixel_left = edge;
3906 c->left_col = edge / unit;
3908 else
3910 c->pixel_top = edge;
3911 c->top_line = edge / unit;
3914 window_resize_apply (c, horflag);
3915 if (horflag)
3916 edge = edge + c->pixel_width;
3918 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3921 else
3922 /* Bug#15957. */
3923 w->window_end_valid = false;
3927 /* Set w->total_lines (w->total_cols if HORFLAG) to
3928 w->new_total for window W and recursively all child windows of W.
3929 Also calculate and assign the new vertical (horizontal) start
3930 positions of each of these windows. */
3931 static void
3932 window_resize_apply_total (struct window *w, bool horflag)
3934 struct window *c;
3935 int edge;
3937 /* Note: Assigning new_normal requires that the new total size of the
3938 parent window has been set *before*. */
3939 if (horflag)
3941 w->total_cols = XFASTINT (w->new_total);
3942 edge = w->left_col;
3944 else
3946 w->total_lines = XFASTINT (w->new_total);
3947 edge = w->top_line;
3950 if (WINDOW_VERTICAL_COMBINATION_P (w))
3951 /* W is a vertical combination. */
3953 c = XWINDOW (w->contents);
3954 while (c)
3956 if (horflag)
3957 c->left_col = edge;
3958 else
3959 c->top_line = edge;
3961 window_resize_apply_total (c, horflag);
3962 if (!horflag)
3963 edge = edge + c->total_lines;
3965 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3968 else if (WINDOW_HORIZONTAL_COMBINATION_P (w))
3969 /* W is a horizontal combination. */
3971 c = XWINDOW (w->contents);
3972 while (c)
3974 if (horflag)
3975 c->left_col = edge;
3976 else
3977 c->top_line = edge;
3979 window_resize_apply_total (c, horflag);
3980 if (horflag)
3981 edge = edge + c->total_cols;
3983 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3988 DEFUN ("window-resize-apply", Fwindow_resize_apply, Swindow_resize_apply, 0, 2, 0,
3989 doc: /* Apply requested size values for window-tree of FRAME.
3990 If FRAME is omitted or nil, it defaults to the selected frame.
3992 Optional argument HORIZONTAL omitted or nil means apply requested
3993 height values. HORIZONTAL non-nil means apply requested width values.
3995 The requested size values are those set by `set-window-new-pixel' and
3996 `set-window-new-normal'. This function checks whether the requested
3997 values sum up to a valid window layout, recursively assigns the new
3998 sizes of all child windows and calculates and assigns the new start
3999 positions of these windows.
4001 Return t if the requested values have been applied correctly, nil
4002 otherwise.
4004 Note: This function does not check any of `window-fixed-size-p',
4005 `window-min-height' or `window-min-width'. All these checks have to
4006 be applied on the Elisp level. */)
4007 (Lisp_Object frame, Lisp_Object horizontal)
4009 struct frame *f = decode_live_frame (frame);
4010 struct window *r = XWINDOW (FRAME_ROOT_WINDOW (f));
4011 bool horflag = !NILP (horizontal);
4013 if (!window_resize_check (r, horflag)
4014 || (XINT (r->new_pixel)
4015 != (horflag ? r->pixel_width : r->pixel_height)))
4016 return Qnil;
4018 block_input ();
4019 window_resize_apply (r, horflag);
4021 fset_redisplay (f);
4023 adjust_frame_glyphs (f);
4024 unblock_input ();
4026 return Qt;
4030 DEFUN ("window-resize-apply-total", Fwindow_resize_apply_total, Swindow_resize_apply_total, 0, 2, 0,
4031 doc: /* Apply requested total size values for window-tree of FRAME.
4032 If FRAME is omitted or nil, it defaults to the selected frame.
4034 This function does not assign pixel or normal size values. You should
4035 have run `window-resize-apply' before running this.
4037 Optional argument HORIZONTAL omitted or nil means apply requested
4038 height values. HORIZONTAL non-nil means apply requested width
4039 values. */)
4040 (Lisp_Object frame, Lisp_Object horizontal)
4042 struct frame *f = decode_live_frame (frame);
4043 struct window *r = XWINDOW (FRAME_ROOT_WINDOW (f));
4045 block_input ();
4046 /* Necessary when deleting the top-/or leftmost window. */
4047 r->left_col = 0;
4048 r->top_line = FRAME_TOP_MARGIN (f);
4049 window_resize_apply_total (r, !NILP (horizontal));
4050 /* Handle the mini window. */
4051 if (FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
4053 struct window *m = XWINDOW (f->minibuffer_window);
4055 if (NILP (horizontal))
4057 m->top_line = r->top_line + r->total_lines;
4058 m->total_lines = XFASTINT (m->new_total);
4060 else
4061 m->total_cols = XFASTINT (m->new_total);
4064 unblock_input ();
4066 return Qt;
4070 /* Resize frame F's windows when F's width or height is set to SIZE.
4071 If HORFLAG is zero, F's width was set to SIZE, otherwise its height
4072 was set. SIZE is interpreted in F's canonical character units
4073 (a.k.a. "columns" or "lines"), unless PIXELWISE is non-zero, which
4074 means to interpret SIZE in pixel units. */
4075 void
4076 resize_frame_windows (struct frame *f, int size, bool horflag, bool pixelwise)
4078 Lisp_Object root = f->root_window;
4079 struct window *r = XWINDOW (root);
4080 Lisp_Object mini = f->minibuffer_window;
4081 struct window *m;
4082 /* old_size is the old size of the frame's root window. */
4083 int old_size = horflag ? r->total_cols : r->total_lines;
4084 int old_pixel_size = horflag ? r->pixel_width : r->pixel_height;
4085 /* new_size is the new size of the frame's root window. */
4086 int new_size, new_pixel_size;
4087 int unit = horflag ? FRAME_COLUMN_WIDTH (f) : FRAME_LINE_HEIGHT (f);
4089 /* Don't let the size drop below one unit. This is more comforting
4090 when we are called from x_set_tool_bar_lines since the latter may
4091 have implicitly given us a zero or negative height. */
4092 if (pixelwise)
4094 /* Note: This does not include the size for internal borders
4095 since these are not part of the frame's text area. */
4096 new_pixel_size = max (horflag
4097 ? size
4098 : (size
4099 - ((FRAME_HAS_MINIBUF_P (f)
4100 && !FRAME_MINIBUF_ONLY_P (f))
4101 ? FRAME_LINE_HEIGHT (f) : 0)),
4102 unit);
4103 new_size = new_pixel_size / unit;
4105 else
4107 new_size = max (size - (!horflag
4108 && FRAME_HAS_MINIBUF_P (f)
4109 && !FRAME_MINIBUF_ONLY_P (f)),
4111 new_pixel_size = new_size * unit;
4114 if (new_pixel_size == old_pixel_size
4115 && (horflag || r->pixel_top == FRAME_TOP_MARGIN_HEIGHT (f)))
4117 else if (WINDOW_LEAF_P (r))
4118 /* For a leaf root window just set the size. */
4119 if (horflag)
4121 r->total_cols = new_size;
4122 r->pixel_width = new_pixel_size;
4124 else
4126 r->top_line = FRAME_TOP_MARGIN (f);
4127 r->pixel_top = FRAME_TOP_MARGIN_HEIGHT (f);
4129 r->total_lines = new_size;
4130 r->pixel_height = new_pixel_size;
4132 else
4134 Lisp_Object delta;
4136 if (!horflag)
4138 r->top_line = FRAME_TOP_MARGIN (f);
4139 r->pixel_top = FRAME_TOP_MARGIN_HEIGHT (f);
4142 if (pixelwise)
4143 XSETINT (delta, new_pixel_size - old_pixel_size);
4144 else
4145 XSETINT (delta, new_size - old_size);
4147 /* Try a "normal" resize first. */
4148 resize_root_window (root, delta, horflag ? Qt : Qnil, Qnil,
4149 pixelwise ? Qt : Qnil);
4150 if (window_resize_check (r, horflag)
4151 && new_pixel_size == XINT (r->new_pixel))
4153 window_resize_apply (r, horflag);
4154 window_pixel_to_total (r->frame, horflag ? Qt : Qnil);
4156 else
4158 /* Try with "reasonable" minimum sizes next. */
4159 resize_root_window (root, delta, horflag ? Qt : Qnil, Qt,
4160 pixelwise ? Qt : Qnil);
4161 if (window_resize_check (r, horflag)
4162 && new_pixel_size == XINT (r->new_pixel))
4164 window_resize_apply (r, horflag);
4165 window_pixel_to_total (r->frame, horflag ? Qt : Qnil);
4170 if (FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
4172 m = XWINDOW (mini);
4173 if (horflag)
4175 m->total_cols = new_size;
4176 m->pixel_width = new_pixel_size;
4178 else
4180 /* Are we sure we always want 1 line here? */
4181 m->total_lines = 1;
4182 m->pixel_height = FRAME_LINE_HEIGHT (f);
4183 m->top_line = r->top_line + r->total_lines;
4184 m->pixel_top = r->pixel_top + r->pixel_height;
4188 fset_redisplay (f);
4192 DEFUN ("split-window-internal", Fsplit_window_internal, Ssplit_window_internal, 4, 4, 0,
4193 doc: /* Split window OLD.
4194 Second argument PIXEL-SIZE specifies the number of pixels of the
4195 new window. It must be a positive integer.
4197 Third argument SIDE nil (or `below') specifies that the new window shall
4198 be located below WINDOW. SIDE `above' means the new window shall be
4199 located above WINDOW. In both cases PIXEL-SIZE specifies the pixel
4200 height of the new window including space reserved for the mode and/or
4201 header line.
4203 SIDE t (or `right') specifies that the new window shall be located on
4204 the right side of WINDOW. SIDE `left' means the new window shall be
4205 located on the left of WINDOW. In both cases PIXEL-SIZE specifies the
4206 width of the new window including space reserved for fringes and the
4207 scrollbar or a divider column.
4209 Fourth argument NORMAL-SIZE specifies the normal size of the new window
4210 according to the SIDE argument.
4212 The new pixel and normal sizes of all involved windows must have been
4213 set correctly. See the code of `split-window' for how this is done. */)
4214 (Lisp_Object old, Lisp_Object pixel_size, Lisp_Object side, Lisp_Object normal_size)
4216 /* OLD (*o) is the window we have to split. (*p) is either OLD's
4217 parent window or an internal window we have to install as OLD's new
4218 parent. REFERENCE (*r) must denote a live window, or is set to OLD
4219 provided OLD is a leaf window, or to the frame's selected window.
4220 NEW (*n) is the new window created with some parameters taken from
4221 REFERENCE (*r). */
4222 Lisp_Object new, frame, reference;
4223 struct window *o, *p, *n, *r, *c;
4224 struct frame *f;
4225 bool horflag
4226 /* HORFLAG is true when we split side-by-side, false otherwise. */
4227 = EQ (side, Qt) || EQ (side, Qleft) || EQ (side, Qright);
4229 CHECK_WINDOW (old);
4230 o = XWINDOW (old);
4231 frame = WINDOW_FRAME (o);
4232 f = XFRAME (frame);
4234 CHECK_NUMBER (pixel_size);
4235 EMACS_INT total_size
4236 = XINT (pixel_size) / (horflag
4237 ? FRAME_COLUMN_WIDTH (f)
4238 : FRAME_LINE_HEIGHT (f));
4240 /* Set combination_limit if we have to make a new parent window.
4241 We do that if either `window-combination-limit' is t, or OLD has no
4242 parent, or OLD is ortho-combined. */
4243 bool combination_limit
4244 = (EQ (Vwindow_combination_limit, Qt)
4245 || NILP (o->parent)
4246 || (horflag
4247 ? WINDOW_VERTICAL_COMBINATION_P (XWINDOW (o->parent))
4248 : WINDOW_HORIZONTAL_COMBINATION_P (XWINDOW (o->parent))));
4250 /* We need a live reference window to initialize some parameters. */
4251 if (WINDOW_LIVE_P (old))
4252 /* OLD is live, use it as reference window. */
4253 reference = old;
4254 else
4255 /* Use the frame's selected window as reference window. */
4256 reference = FRAME_SELECTED_WINDOW (f);
4257 r = XWINDOW (reference);
4259 /* The following bugs are caught by `split-window'. */
4260 if (MINI_WINDOW_P (o))
4261 error ("Attempt to split minibuffer window");
4262 else if (total_size < (horflag ? 2 : 1))
4263 error ("Size of new window too small (after split)");
4264 else if (!combination_limit && !NILP (Vwindow_combination_resize))
4265 /* `window-combination-resize' non-nil means try to resize OLD's siblings
4266 proportionally. */
4268 p = XWINDOW (o->parent);
4269 /* Temporarily pretend we split the parent window. */
4270 wset_new_pixel
4271 (p, make_number ((horflag ? p->pixel_width : p->pixel_height)
4272 - XINT (pixel_size)));
4273 if (!window_resize_check (p, horflag))
4274 error ("Window sizes don't fit");
4275 else
4276 /* Undo the temporary pretension. */
4277 wset_new_pixel (p, make_number (horflag ? p->pixel_width : p->pixel_height));
4279 else
4281 if (!window_resize_check (o, horflag))
4282 error ("Resizing old window failed");
4283 else if (XINT (pixel_size) + XINT (o->new_pixel)
4284 != (horflag ? o->pixel_width : o->pixel_height))
4285 error ("Sum of sizes of old and new window don't fit");
4288 /* This is our point of no return. */
4289 if (combination_limit)
4291 /* Save the old value of o->normal_cols/lines. It gets corrupted
4292 by make_parent_window and we need it below for assigning it to
4293 p->new_normal. */
4294 Lisp_Object new_normal
4295 = horflag ? o->normal_cols : o->normal_lines;
4297 make_parent_window (old, horflag);
4298 p = XWINDOW (o->parent);
4299 if (EQ (Vwindow_combination_limit, Qt))
4300 /* Store t in the new parent's combination_limit slot to avoid
4301 that its children get merged into another window. */
4302 wset_combination_limit (p, Qt);
4303 /* These get applied below. */
4304 wset_new_pixel
4305 (p, make_number (horflag ? o->pixel_width : o->pixel_height));
4306 wset_new_total
4307 (p, make_number (horflag ? o->total_cols : o->total_lines));
4308 wset_new_normal (p, new_normal);
4310 else
4311 p = XWINDOW (o->parent);
4313 fset_redisplay (f);
4314 new = make_window ();
4315 n = XWINDOW (new);
4316 wset_frame (n, frame);
4317 wset_parent (n, o->parent);
4319 if (EQ (side, Qabove) || EQ (side, Qleft))
4321 wset_prev (n, o->prev);
4322 if (NILP (n->prev))
4323 wset_combination (p, horflag, new);
4324 else
4325 wset_next (XWINDOW (n->prev), new);
4326 wset_next (n, old);
4327 wset_prev (o, new);
4329 else
4331 wset_next (n, o->next);
4332 if (!NILP (n->next))
4333 wset_prev (XWINDOW (n->next), new);
4334 wset_prev (n, old);
4335 wset_next (o, new);
4338 n->window_end_valid = false;
4339 n->last_cursor_vpos = 0;
4341 /* Get special geometry settings from reference window. */
4342 n->left_margin_cols = r->left_margin_cols;
4343 n->right_margin_cols = r->right_margin_cols;
4344 n->left_fringe_width = r->left_fringe_width;
4345 n->right_fringe_width = r->right_fringe_width;
4346 n->fringes_outside_margins = r->fringes_outside_margins;
4347 n->scroll_bar_width = r->scroll_bar_width;
4348 n->scroll_bar_height = r->scroll_bar_height;
4349 wset_vertical_scroll_bar_type (n, r->vertical_scroll_bar_type);
4350 wset_horizontal_scroll_bar_type (n, r->horizontal_scroll_bar_type);
4352 /* Directly assign orthogonal coordinates and sizes. */
4353 if (horflag)
4355 n->pixel_top = o->pixel_top;
4356 n->top_line = o->top_line;
4357 n->pixel_height = o->pixel_height;
4358 n->total_lines = o->total_lines;
4360 else
4362 n->pixel_left = o->pixel_left;
4363 n->left_col = o->left_col;
4364 n->pixel_width = o->pixel_width;
4365 n->total_cols = o->total_cols;
4368 /* Iso-coordinates and sizes are assigned by window_resize_apply,
4369 get them ready here. */
4370 wset_new_pixel (n, pixel_size);
4371 EMACS_INT sum = 0;
4372 c = XWINDOW (p->contents);
4373 while (c)
4375 if (c != n)
4376 sum = sum + XINT (c->new_total);
4377 c = NILP (c->next) ? 0 : XWINDOW (c->next);
4379 wset_new_total (n, make_number ((horflag
4380 ? p->total_cols
4381 : p->total_lines)
4382 - sum));
4383 wset_new_normal (n, normal_size);
4385 block_input ();
4386 window_resize_apply (p, horflag);
4387 adjust_frame_glyphs (f);
4388 /* Set buffer of NEW to buffer of reference window. Don't run
4389 any hooks. */
4390 set_window_buffer (new, r->contents, false, true);
4391 unblock_input ();
4393 /* Maybe we should run the scroll functions in Elisp (which already
4394 runs the configuration change hook). */
4395 if (! NILP (Vwindow_scroll_functions))
4396 run_hook_with_args_2 (Qwindow_scroll_functions, new,
4397 Fmarker_position (n->start));
4398 /* Return NEW. */
4399 return new;
4403 DEFUN ("delete-window-internal", Fdelete_window_internal, Sdelete_window_internal, 1, 1, 0,
4404 doc: /* Remove WINDOW from its frame.
4405 WINDOW defaults to the selected window. Return nil.
4406 Signal an error when WINDOW is the only window on its frame. */)
4407 (Lisp_Object window)
4409 Lisp_Object parent, sibling, frame, root;
4410 struct window *w, *p, *s, *r;
4411 struct frame *f;
4412 bool horflag, before_sibling = false;
4414 w = decode_any_window (window);
4415 XSETWINDOW (window, w);
4416 if (NILP (w->contents))
4417 /* It's a no-op to delete an already deleted window. */
4418 return Qnil;
4420 parent = w->parent;
4421 if (NILP (parent))
4422 /* Never delete a minibuffer or frame root window. */
4423 error ("Attempt to delete minibuffer or sole ordinary window");
4424 else if (NILP (w->prev) && NILP (w->next))
4425 /* Rather bow out here, this case should be handled on the Elisp
4426 level. */
4427 error ("Attempt to delete sole window of parent");
4429 p = XWINDOW (parent);
4430 horflag = WINDOW_HORIZONTAL_COMBINATION_P (p);
4432 frame = WINDOW_FRAME (w);
4433 f = XFRAME (frame);
4435 root = FRAME_ROOT_WINDOW (f);
4436 r = XWINDOW (root);
4438 /* Unlink WINDOW from window tree. */
4439 if (NILP (w->prev))
4440 /* Get SIBLING below (on the right of) WINDOW. */
4442 /* before_sibling means WINDOW is the first child of its
4443 parent and thus before the sibling. */
4444 before_sibling = true;
4445 sibling = w->next;
4446 s = XWINDOW (sibling);
4447 wset_prev (s, Qnil);
4448 wset_combination (p, horflag, sibling);
4450 else
4451 /* Get SIBLING above (on the left of) WINDOW. */
4453 sibling = w->prev;
4454 s = XWINDOW (sibling);
4455 wset_next (s, w->next);
4456 if (!NILP (s->next))
4457 wset_prev (XWINDOW (s->next), sibling);
4460 if (window_resize_check (r, horflag)
4461 && (XINT (r->new_pixel)
4462 == (horflag ? r->pixel_width : r->pixel_height)))
4463 /* We can delete WINDOW now. */
4466 /* Block input. */
4467 block_input ();
4468 xwidget_view_delete_all_in_window (w);
4469 window_resize_apply (p, horflag);
4470 /* If this window is referred to by the dpyinfo's mouse
4471 highlight, invalidate that slot to be safe (Bug#9904). */
4472 if (!FRAME_INITIAL_P (f))
4474 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
4476 if (EQ (hlinfo->mouse_face_window, window))
4477 hlinfo->mouse_face_window = Qnil;
4480 fset_redisplay (f);
4481 Vwindow_list = Qnil;
4483 wset_next (w, Qnil); /* Don't delete w->next too. */
4484 free_window_matrices (w);
4486 if (WINDOWP (w->contents))
4488 delete_all_child_windows (w->contents);
4489 wset_combination (w, false, Qnil);
4491 else
4493 unshow_buffer (w);
4494 unchain_marker (XMARKER (w->pointm));
4495 unchain_marker (XMARKER (w->old_pointm));
4496 unchain_marker (XMARKER (w->start));
4497 wset_buffer (w, Qnil);
4500 if (NILP (s->prev) && NILP (s->next))
4501 /* A matrjoshka where SIBLING has become the only child of
4502 PARENT. */
4504 /* Put SIBLING into PARENT's place. */
4505 replace_window (parent, sibling, false);
4506 /* Have SIBLING inherit the following three slot values from
4507 PARENT (the combination_limit slot is not inherited). */
4508 wset_normal_cols (s, p->normal_cols);
4509 wset_normal_lines (s, p->normal_lines);
4510 /* Mark PARENT as deleted. */
4511 wset_combination (p, false, Qnil);
4512 /* Try to merge SIBLING into its new parent. */
4513 recombine_windows (sibling);
4516 adjust_frame_glyphs (f);
4518 if (!WINDOW_LIVE_P (FRAME_SELECTED_WINDOW (f)))
4519 /* We deleted the frame's selected window. */
4521 /* Use the frame's first window as fallback ... */
4522 Lisp_Object new_selected_window = Fframe_first_window (frame);
4523 /* ... but preferably use its most recently used window. */
4524 Lisp_Object mru_window;
4526 /* `get-mru-window' might fail for some reason so play it safe
4527 - promote the first window _without recording it_ first. */
4528 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
4529 Fselect_window (new_selected_window, Qt);
4530 else
4531 fset_selected_window (f, new_selected_window);
4533 unblock_input ();
4535 /* Now look whether `get-mru-window' gets us something. */
4536 mru_window = call1 (Qget_mru_window, frame);
4537 if (WINDOW_LIVE_P (mru_window)
4538 && EQ (XWINDOW (mru_window)->frame, frame))
4539 new_selected_window = mru_window;
4541 /* If all ended up well, we now promote the mru window. */
4542 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
4543 Fselect_window (new_selected_window, Qnil);
4544 else
4545 fset_selected_window (f, new_selected_window);
4547 else
4548 unblock_input ();
4550 else
4551 /* We failed: Relink WINDOW into window tree. */
4553 if (before_sibling)
4555 wset_prev (s, window);
4556 wset_combination (p, horflag, window);
4558 else
4560 wset_next (s, window);
4561 if (!NILP (w->next))
4562 wset_prev (XWINDOW (w->next), window);
4564 error ("Deletion failed");
4567 return Qnil;
4570 /***********************************************************************
4571 Resizing Mini-Windows
4572 ***********************************************************************/
4574 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we
4575 can. */
4576 void
4577 grow_mini_window (struct window *w, int delta, bool pixelwise)
4579 struct frame *f = XFRAME (w->frame);
4580 struct window *r;
4581 Lisp_Object root, height;
4582 int line_height, pixel_height;
4584 eassert (MINI_WINDOW_P (w));
4585 eassert (delta >= 0);
4587 if (delta > 0)
4589 root = FRAME_ROOT_WINDOW (f);
4590 r = XWINDOW (root);
4591 height = call3 (Qwindow__resize_root_window_vertically,
4592 root, make_number (- delta), pixelwise ? Qt : Qnil);
4593 if (INTEGERP (height) && window_resize_check (r, false))
4595 block_input ();
4596 window_resize_apply (r, false);
4598 if (pixelwise)
4600 pixel_height = min (-XINT (height), INT_MAX - w->pixel_height);
4601 line_height = pixel_height / FRAME_LINE_HEIGHT (f);
4603 else
4605 line_height = min (-XINT (height),
4606 ((INT_MAX - w->pixel_height)
4607 / FRAME_LINE_HEIGHT (f)));
4608 pixel_height = line_height * FRAME_LINE_HEIGHT (f);
4611 /* Grow the mini-window. */
4612 w->pixel_top = r->pixel_top + r->pixel_height;
4613 w->top_line = r->top_line + r->total_lines;
4614 /* Make sure the mini-window has always at least one line. */
4615 w->pixel_height = max (w->pixel_height + pixel_height,
4616 FRAME_LINE_HEIGHT (f));
4617 w->total_lines = max (w->total_lines + line_height, 1);
4619 /* Enforce full redisplay of the frame. */
4620 /* FIXME: Shouldn't window--resize-root-window-vertically do it? */
4621 fset_redisplay (f);
4622 adjust_frame_glyphs (f);
4623 unblock_input ();
4625 else
4626 error ("Failed to grow minibuffer window");
4631 /* Shrink mini-window W to one line. */
4632 void
4633 shrink_mini_window (struct window *w, bool pixelwise)
4635 struct frame *f = XFRAME (w->frame);
4636 struct window *r;
4637 Lisp_Object root, delta;
4638 EMACS_INT height, unit;
4640 eassert (MINI_WINDOW_P (w));
4642 height = pixelwise ? w->pixel_height : w->total_lines;
4643 unit = pixelwise ? FRAME_LINE_HEIGHT (f) : 1;
4644 if (height > unit)
4646 root = FRAME_ROOT_WINDOW (f);
4647 r = XWINDOW (root);
4648 delta = call3 (Qwindow__resize_root_window_vertically,
4649 root, make_number (height - unit),
4650 pixelwise ? Qt : Qnil);
4651 if (INTEGERP (delta) && window_resize_check (r, false))
4653 block_input ();
4654 window_resize_apply (r, false);
4656 /* Shrink the mini-window. */
4657 w->top_line = r->top_line + r->total_lines;
4658 w->total_lines = 1;
4659 w->pixel_top = r->pixel_top + r->pixel_height;
4660 w->pixel_height = FRAME_LINE_HEIGHT (f);
4661 /* Enforce full redisplay of the frame. */
4662 /* FIXME: Shouldn't window--resize-root-window-vertically do it? */
4663 fset_redisplay (f);
4664 adjust_frame_glyphs (f);
4665 unblock_input ();
4667 /* If the above failed for whatever strange reason we must make a
4668 one window frame here. The same routine will be needed when
4669 shrinking the frame (and probably when making the initial
4670 *scratch* window). For the moment leave things as they are. */
4671 else
4672 error ("Failed to shrink minibuffer window");
4676 DEFUN ("resize-mini-window-internal", Fresize_mini_window_internal, Sresize_mini_window_internal, 1, 1, 0,
4677 doc: /* Resize minibuffer window WINDOW. */)
4678 (Lisp_Object window)
4680 struct window *w = XWINDOW (window);
4681 struct window *r;
4682 struct frame *f;
4683 int height;
4685 CHECK_WINDOW (window);
4686 f = XFRAME (w->frame);
4688 if (!EQ (FRAME_MINIBUF_WINDOW (XFRAME (w->frame)), window))
4689 error ("Not a valid minibuffer window");
4690 else if (FRAME_MINIBUF_ONLY_P (f))
4691 error ("Cannot resize a minibuffer-only frame");
4693 r = XWINDOW (FRAME_ROOT_WINDOW (f));
4694 height = r->pixel_height + w->pixel_height;
4695 if (window_resize_check (r, false)
4696 && XINT (w->new_pixel) > 0
4697 && height == XINT (r->new_pixel) + XINT (w->new_pixel))
4699 block_input ();
4700 window_resize_apply (r, false);
4702 w->pixel_height = XFASTINT (w->new_pixel);
4703 w->total_lines = w->pixel_height / FRAME_LINE_HEIGHT (f);
4704 w->pixel_top = r->pixel_top + r->pixel_height;
4705 w->top_line = r->top_line + r->total_lines;
4707 fset_redisplay (f);
4708 adjust_frame_glyphs (f);
4709 unblock_input ();
4710 return Qt;
4712 else
4713 error ("Failed to resize minibuffer window");
4716 /* Mark window cursors off for all windows in the window tree rooted
4717 at W by setting their phys_cursor_on_p flag to zero. Called from
4718 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4719 the frame are cleared. */
4721 void
4722 mark_window_cursors_off (struct window *w)
4724 while (w)
4726 if (WINDOWP (w->contents))
4727 mark_window_cursors_off (XWINDOW (w->contents));
4728 else
4729 w->phys_cursor_on_p = false;
4731 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4736 /* Return number of lines of text (not counting mode lines) in W. */
4739 window_internal_height (struct window *w)
4741 int ht = w->total_lines;
4743 if (!MINI_WINDOW_P (w))
4745 if (!NILP (w->parent)
4746 || WINDOWP (w->contents)
4747 || !NILP (w->next)
4748 || !NILP (w->prev)
4749 || WINDOW_WANTS_MODELINE_P (w))
4750 --ht;
4752 if (WINDOW_WANTS_HEADER_LINE_P (w))
4753 --ht;
4756 return ht;
4760 /************************************************************************
4761 Window Scrolling
4762 ***********************************************************************/
4764 /* Scroll contents of window WINDOW up. If WHOLE, scroll
4765 N screen-fulls, which is defined as the height of the window minus
4766 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4767 instead. Negative values of N mean scroll down. NOERROR
4768 means don't signal an error if we try to move over BEGV or ZV,
4769 respectively. */
4771 static void
4772 window_scroll (Lisp_Object window, EMACS_INT n, bool whole, bool noerror)
4774 ptrdiff_t count = SPECPDL_INDEX ();
4776 immediate_quit = true;
4777 n = clip_to_bounds (INT_MIN, n, INT_MAX);
4779 wset_redisplay (XWINDOW (window));
4781 if (whole && Vfast_but_imprecise_scrolling)
4782 specbind (Qfontification_functions, Qnil);
4784 /* If we must, use the pixel-based version which is much slower than
4785 the line-based one but can handle varying line heights. */
4786 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4787 window_scroll_pixel_based (window, n, whole, noerror);
4788 else
4789 window_scroll_line_based (window, n, whole, noerror);
4791 unbind_to (count, Qnil);
4793 /* Bug#15957. */
4794 XWINDOW (window)->window_end_valid = false;
4795 immediate_quit = false;
4799 /* Implementation of window_scroll that works based on pixel line
4800 heights. See the comment of window_scroll for parameter
4801 descriptions. */
4803 static void
4804 window_scroll_pixel_based (Lisp_Object window, int n, bool whole, bool noerror)
4806 struct it it;
4807 struct window *w = XWINDOW (window);
4808 struct text_pos start;
4809 int this_scroll_margin;
4810 /* True if we fiddled the window vscroll field without really scrolling. */
4811 bool vscrolled = false;
4812 int x, y, rtop, rbot, rowh, vpos;
4813 void *itdata = NULL;
4814 int window_total_lines;
4815 int frame_line_height = default_line_pixel_height (w);
4816 bool adjust_old_pointm = !NILP (Fequal (Fwindow_point (window),
4817 Fwindow_old_point (window)));
4819 SET_TEXT_POS_FROM_MARKER (start, w->start);
4820 /* Scrolling a minibuffer window via scroll bar when the echo area
4821 shows long text sometimes resets the minibuffer contents behind
4822 our backs. */
4823 if (CHARPOS (start) > ZV)
4824 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
4826 /* If PT is not visible in WINDOW, move back one half of
4827 the screen. Allow PT to be partially visible, otherwise
4828 something like (scroll-down 1) with PT in the line before
4829 the partially visible one would recenter. */
4831 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
4833 itdata = bidi_shelve_cache ();
4834 /* Move backward half the height of the window. Performance note:
4835 vmotion used here is about 10% faster, but would give wrong
4836 results for variable height lines. */
4837 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4838 it.current_y = it.last_visible_y;
4839 move_it_vertically_backward (&it, window_box_height (w) / 2);
4841 /* The function move_iterator_vertically may move over more than
4842 the specified y-distance. If it->w is small, e.g. a
4843 mini-buffer window, we may end up in front of the window's
4844 display area. Start displaying at the start of the line
4845 containing PT in this case. */
4846 if (it.current_y <= 0)
4848 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4849 move_it_vertically_backward (&it, 0);
4850 it.current_y = 0;
4853 start = it.current.pos;
4854 bidi_unshelve_cache (itdata, false);
4856 else if (auto_window_vscroll_p)
4858 if (rtop || rbot) /* Partially visible. */
4860 int px;
4861 int dy = frame_line_height;
4862 /* In the below we divide the window box height by the
4863 frame's line height to make the result predictable when
4864 the window box is not an integral multiple of the line
4865 height. This is important to ensure we get back to the
4866 same position when scrolling up, then down. */
4867 if (whole)
4868 dy = max ((window_box_height (w) / dy
4869 - next_screen_context_lines) * dy,
4870 dy);
4871 dy *= n;
4873 if (n < 0)
4875 /* Only vscroll backwards if already vscrolled forwards. */
4876 if (w->vscroll < 0 && rtop > 0)
4878 px = max (0, -w->vscroll - min (rtop, -dy));
4879 Fset_window_vscroll (window, make_number (px), Qt);
4880 return;
4883 if (n > 0)
4885 /* Do vscroll if already vscrolled or only display line. */
4886 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
4888 px = max (0, -w->vscroll + min (rbot, dy));
4889 Fset_window_vscroll (window, make_number (px), Qt);
4890 return;
4893 /* Maybe modify window start instead of scrolling. */
4894 if (rbot > 0 || w->vscroll < 0)
4896 ptrdiff_t spos;
4898 Fset_window_vscroll (window, make_number (0), Qt);
4899 /* If there are other text lines above the current row,
4900 move window start to current row. Else to next row. */
4901 if (rbot > 0)
4902 spos = XINT (Fline_beginning_position (Qnil));
4903 else
4904 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
4905 set_marker_restricted (w->start, make_number (spos),
4906 w->contents);
4907 w->start_at_line_beg = true;
4908 wset_update_mode_line (w);
4909 /* Set force_start so that redisplay_window will run the
4910 window-scroll-functions. */
4911 w->force_start = true;
4912 return;
4916 /* Cancel previous vscroll. */
4917 Fset_window_vscroll (window, make_number (0), Qt);
4920 itdata = bidi_shelve_cache ();
4921 /* If scroll_preserve_screen_position is non-nil, we try to set
4922 point in the same window line as it is now, so get that line. */
4923 if (!NILP (Vscroll_preserve_screen_position))
4925 /* We preserve the goal pixel coordinate across consecutive
4926 calls to scroll-up, scroll-down and other commands that
4927 have the `scroll-command' property. This avoids the
4928 possibility of point becoming "stuck" on a tall line when
4929 scrolling by one line. */
4930 if (window_scroll_pixel_based_preserve_y < 0
4931 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4932 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4934 start_display (&it, w, start);
4935 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4936 window_scroll_pixel_based_preserve_y = it.current_y;
4937 window_scroll_pixel_based_preserve_x = it.current_x;
4940 else
4941 window_scroll_pixel_based_preserve_y
4942 = window_scroll_pixel_based_preserve_x = -1;
4944 /* Move iterator it from start the specified distance forward or
4945 backward. The result is the new window start. */
4946 start_display (&it, w, start);
4947 if (whole)
4949 ptrdiff_t start_pos = IT_CHARPOS (it);
4950 int dy = frame_line_height;
4951 /* In the below we divide the window box height by the frame's
4952 line height to make the result predictable when the window
4953 box is not an integral multiple of the line height. This is
4954 important to ensure we get back to the same position when
4955 scrolling up, then down. */
4956 dy = max ((window_box_height (w) / dy - next_screen_context_lines) * dy,
4957 dy) * n;
4959 /* Note that move_it_vertically always moves the iterator to the
4960 start of a line. So, if the last line doesn't have a newline,
4961 we would end up at the start of the line ending at ZV. */
4962 if (dy <= 0)
4964 move_it_vertically_backward (&it, -dy);
4965 /* Ensure we actually do move, e.g. in case we are currently
4966 looking at an image that is taller that the window height. */
4967 while (start_pos == IT_CHARPOS (it)
4968 && start_pos > BEGV)
4969 move_it_by_lines (&it, -1);
4971 else if (dy > 0)
4973 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4974 MOVE_TO_POS | MOVE_TO_Y);
4975 /* Ensure we actually do move, e.g. in case we are currently
4976 looking at an image that is taller that the window height. */
4977 while (start_pos == IT_CHARPOS (it)
4978 && start_pos < ZV)
4979 move_it_by_lines (&it, 1);
4982 else
4983 move_it_by_lines (&it, n);
4985 /* We failed if we find ZV is already on the screen (scrolling up,
4986 means there's nothing past the end), or if we can't start any
4987 earlier (scrolling down, means there's nothing past the top). */
4988 if ((n > 0 && IT_CHARPOS (it) == ZV)
4989 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4991 if (IT_CHARPOS (it) == ZV)
4993 if (it.current_y < it.last_visible_y
4994 && (it.current_y + it.max_ascent + it.max_descent
4995 > it.last_visible_y))
4997 /* The last line was only partially visible, make it fully
4998 visible. */
4999 w->vscroll = (it.last_visible_y
5000 - it.current_y + it.max_ascent + it.max_descent);
5001 adjust_frame_glyphs (it.f);
5003 else
5005 bidi_unshelve_cache (itdata, false);
5006 if (noerror)
5007 return;
5008 else if (n < 0) /* could happen with empty buffers */
5009 xsignal0 (Qbeginning_of_buffer);
5010 else
5011 xsignal0 (Qend_of_buffer);
5014 else
5016 if (w->vscroll != 0)
5017 /* The first line was only partially visible, make it fully
5018 visible. */
5019 w->vscroll = 0;
5020 else
5022 bidi_unshelve_cache (itdata, false);
5023 if (noerror)
5024 return;
5025 else
5026 xsignal0 (Qbeginning_of_buffer);
5030 /* If control gets here, then we vscrolled. */
5032 XBUFFER (w->contents)->prevent_redisplay_optimizations_p = true;
5034 /* Don't try to change the window start below. */
5035 vscrolled = true;
5038 if (! vscrolled)
5040 ptrdiff_t pos = IT_CHARPOS (it);
5041 ptrdiff_t bytepos;
5043 /* If in the middle of a multi-glyph character move forward to
5044 the next character. */
5045 if (in_display_vector_p (&it))
5047 ++pos;
5048 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
5051 /* Set the window start, and set up the window for redisplay. */
5052 set_marker_restricted_both (w->start, w->contents, IT_CHARPOS (it),
5053 IT_BYTEPOS (it));
5054 bytepos = marker_byte_position (w->start);
5055 w->start_at_line_beg = (pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n');
5056 wset_update_mode_line (w);
5057 /* Set force_start so that redisplay_window will run the
5058 window-scroll-functions. */
5059 w->force_start = true;
5062 /* The rest of this function uses current_y in a nonstandard way,
5063 not including the height of the header line if any. */
5064 it.current_y = it.vpos = 0;
5066 /* Move PT out of scroll margins.
5067 This code wants current_y to be zero at the window start position
5068 even if there is a header line. */
5069 window_total_lines
5070 = w->total_lines * WINDOW_FRAME_LINE_HEIGHT (w) / frame_line_height;
5071 this_scroll_margin = max (0, scroll_margin);
5072 this_scroll_margin
5073 = min (this_scroll_margin, window_total_lines / 4);
5074 this_scroll_margin *= frame_line_height;
5076 if (n > 0)
5078 int last_y = it.last_visible_y - this_scroll_margin - 1;
5080 /* We moved the window start towards ZV, so PT may be now
5081 in the scroll margin at the top. */
5082 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
5083 if (IT_CHARPOS (it) == PT
5084 && it.current_y >= this_scroll_margin
5085 && it.current_y <= last_y - WINDOW_HEADER_LINE_HEIGHT (w)
5086 && (NILP (Vscroll_preserve_screen_position)
5087 || EQ (Vscroll_preserve_screen_position, Qt)))
5088 /* We found PT at a legitimate height. Leave it alone. */
5090 else
5092 if (window_scroll_pixel_based_preserve_y >= 0)
5094 /* Don't enter the scroll margin at the end of the window. */
5095 int goal_y = min (last_y, window_scroll_pixel_based_preserve_y);
5097 /* If we have a header line, take account of it. This
5098 is necessary because we set it.current_y to 0, above. */
5099 move_it_to (&it, -1,
5100 window_scroll_pixel_based_preserve_x,
5101 goal_y - WINDOW_HEADER_LINE_HEIGHT (w),
5102 -1, MOVE_TO_Y | MOVE_TO_X);
5105 /* Get out of the scroll margin at the top of the window. */
5106 while (it.current_y < this_scroll_margin)
5108 int prev = it.current_y;
5109 move_it_by_lines (&it, 1);
5110 if (prev == it.current_y)
5111 break;
5113 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5116 else if (n < 0)
5118 ptrdiff_t charpos, bytepos;
5119 bool partial_p;
5121 /* Save our position, for the
5122 window_scroll_pixel_based_preserve_y case. */
5123 charpos = IT_CHARPOS (it);
5124 bytepos = IT_BYTEPOS (it);
5126 /* We moved the window start towards BEGV, so PT may be now
5127 in the scroll margin at the bottom. */
5128 move_it_to (&it, PT, -1,
5129 (it.last_visible_y - WINDOW_HEADER_LINE_HEIGHT (w)
5130 - this_scroll_margin - 1),
5132 MOVE_TO_POS | MOVE_TO_Y);
5134 /* Save our position, in case it's correct. */
5135 charpos = IT_CHARPOS (it);
5136 bytepos = IT_BYTEPOS (it);
5138 /* If PT is in the screen line at the last fully visible line,
5139 move_it_to will stop at X = 0 in that line, because the
5140 required Y coordinate is reached there. See if we can get to
5141 PT without descending lower in Y, and if we can, it means we
5142 reached PT before the scroll margin. */
5143 if (charpos != PT)
5145 struct it it2;
5146 void *it_data;
5148 it2 = it;
5149 it_data = bidi_shelve_cache ();
5150 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
5151 if (IT_CHARPOS (it) == PT && it.current_y == it2.current_y)
5153 charpos = IT_CHARPOS (it);
5154 bytepos = IT_BYTEPOS (it);
5155 bidi_unshelve_cache (it_data, true);
5157 else
5159 it = it2;
5160 bidi_unshelve_cache (it_data, false);
5164 /* See if point is on a partially visible line at the end. */
5165 if (it.what == IT_EOB)
5166 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
5167 else
5169 move_it_by_lines (&it, 1);
5170 partial_p = it.current_y > it.last_visible_y;
5173 if (charpos == PT && !partial_p
5174 && (NILP (Vscroll_preserve_screen_position)
5175 || EQ (Vscroll_preserve_screen_position, Qt)))
5176 /* We found PT before we found the display margin, so PT is ok. */
5178 else if (window_scroll_pixel_based_preserve_y >= 0)
5180 int goal_y = min (it.last_visible_y - this_scroll_margin - 1,
5181 window_scroll_pixel_based_preserve_y);
5183 /* Don't let the preserved screen Y coordinate put us inside
5184 any of the two margins. */
5185 if (goal_y < this_scroll_margin)
5186 goal_y = this_scroll_margin;
5187 SET_TEXT_POS_FROM_MARKER (start, w->start);
5188 start_display (&it, w, start);
5189 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
5190 here because we called start_display again and did not
5191 alter it.current_y this time. */
5192 move_it_to (&it, -1, window_scroll_pixel_based_preserve_x,
5193 goal_y, -1, MOVE_TO_Y | MOVE_TO_X);
5194 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5196 else
5198 if (partial_p)
5199 /* The last line was only partially visible, so back up two
5200 lines to make sure we're on a fully visible line. */
5202 move_it_by_lines (&it, -2);
5203 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5205 else
5206 /* No, the position we saved is OK, so use it. */
5207 SET_PT_BOTH (charpos, bytepos);
5210 bidi_unshelve_cache (itdata, false);
5212 if (adjust_old_pointm)
5213 Fset_marker (w->old_pointm,
5214 ((w == XWINDOW (selected_window))
5215 ? make_number (BUF_PT (XBUFFER (w->contents)))
5216 : Fmarker_position (w->pointm)),
5217 w->contents);
5221 /* Implementation of window_scroll that works based on screen lines.
5222 See the comment of window_scroll for parameter descriptions. */
5224 static void
5225 window_scroll_line_based (Lisp_Object window, int n, bool whole, bool noerror)
5227 struct window *w = XWINDOW (window);
5228 /* Fvertical_motion enters redisplay, which can trigger
5229 fontification, which in turn can modify buffer text (e.g., if the
5230 fontification functions replace escape sequences with faces, as
5231 in `grep-mode-font-lock-keywords'). So we use a marker to record
5232 the old point position, to prevent crashes in SET_PT_BOTH. */
5233 Lisp_Object opoint_marker = Fpoint_marker ();
5234 register ptrdiff_t pos, pos_byte;
5235 register int ht = window_internal_height (w);
5236 register Lisp_Object tem;
5237 bool lose;
5238 Lisp_Object bolp;
5239 ptrdiff_t startpos = marker_position (w->start);
5240 ptrdiff_t startbyte = marker_byte_position (w->start);
5241 Lisp_Object original_pos = Qnil;
5242 bool adjust_old_pointm = !NILP (Fequal (Fwindow_point (window),
5243 Fwindow_old_point (window)));
5245 /* If scrolling screen-fulls, compute the number of lines to
5246 scroll from the window's height. */
5247 if (whole)
5248 n *= max (1, ht - next_screen_context_lines);
5250 if (!NILP (Vscroll_preserve_screen_position))
5252 if (window_scroll_preserve_vpos <= 0
5253 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
5254 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
5256 struct position posit
5257 = *compute_motion (startpos, startbyte, 0, 0, false,
5258 PT, ht, 0, -1, w->hscroll, 0, w);
5260 window_scroll_preserve_vpos = posit.vpos;
5261 window_scroll_preserve_hpos = posit.hpos + w->hscroll;
5264 original_pos = Fcons (make_number (window_scroll_preserve_hpos),
5265 make_number (window_scroll_preserve_vpos));
5268 XSETFASTINT (tem, PT);
5269 tem = Fpos_visible_in_window_p (tem, window, Qnil);
5271 if (NILP (tem))
5273 Fvertical_motion (make_number (- (ht / 2)), window, Qnil);
5274 startpos = PT;
5275 startbyte = PT_BYTE;
5278 SET_PT_BOTH (startpos, startbyte);
5279 lose = n < 0 && PT == BEGV;
5280 Fvertical_motion (make_number (n), window, Qnil);
5281 pos = PT;
5282 pos_byte = PT_BYTE;
5283 bolp = Fbolp ();
5284 SET_PT_BOTH (marker_position (opoint_marker),
5285 marker_byte_position (opoint_marker));
5287 if (lose)
5289 if (noerror)
5290 return;
5291 else
5292 xsignal0 (Qbeginning_of_buffer);
5295 if (pos < ZV)
5297 /* Don't use a scroll margin that is negative or too large. */
5298 int this_scroll_margin =
5299 max (0, min (scroll_margin, w->total_lines / 4));
5301 set_marker_restricted_both (w->start, w->contents, pos, pos_byte);
5302 w->start_at_line_beg = !NILP (bolp);
5303 wset_update_mode_line (w);
5304 /* Set force_start so that redisplay_window will run
5305 the window-scroll-functions. */
5306 w->force_start = true;
5308 if (!NILP (Vscroll_preserve_screen_position)
5309 && this_scroll_margin == 0
5310 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
5312 SET_PT_BOTH (pos, pos_byte);
5313 Fvertical_motion (original_pos, window, Qnil);
5315 /* If we scrolled forward, put point enough lines down
5316 that it is outside the scroll margin. */
5317 else if (n > 0)
5319 int top_margin;
5321 if (this_scroll_margin > 0)
5323 SET_PT_BOTH (pos, pos_byte);
5324 Fvertical_motion (make_number (this_scroll_margin), window, Qnil);
5325 top_margin = PT;
5327 else
5328 top_margin = pos;
5330 if (top_margin <= marker_position (opoint_marker))
5331 SET_PT_BOTH (marker_position (opoint_marker),
5332 marker_byte_position (opoint_marker));
5333 else if (!NILP (Vscroll_preserve_screen_position))
5335 int nlines = window_scroll_preserve_vpos;
5337 SET_PT_BOTH (pos, pos_byte);
5338 if (window_scroll_preserve_vpos < this_scroll_margin)
5339 nlines = this_scroll_margin;
5340 else if (window_scroll_preserve_vpos
5341 >= w->total_lines - this_scroll_margin)
5342 nlines = w->total_lines - this_scroll_margin - 1;
5343 Fvertical_motion (Fcons (make_number (window_scroll_preserve_hpos),
5344 make_number (nlines)), window, Qnil);
5346 else
5347 SET_PT (top_margin);
5349 else if (n < 0)
5351 int bottom_margin;
5353 /* If we scrolled backward, put point near the end of the window
5354 but not within the scroll margin. */
5355 SET_PT_BOTH (pos, pos_byte);
5356 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window,
5357 Qnil);
5358 if (XFASTINT (tem) == ht - this_scroll_margin)
5359 bottom_margin = PT;
5360 else
5361 bottom_margin = PT + 1;
5363 if (bottom_margin > marker_position (opoint_marker))
5364 SET_PT_BOTH (marker_position (opoint_marker),
5365 marker_byte_position (opoint_marker));
5366 else
5368 if (!NILP (Vscroll_preserve_screen_position))
5370 int nlines = window_scroll_preserve_vpos;
5372 SET_PT_BOTH (pos, pos_byte);
5373 if (window_scroll_preserve_vpos < this_scroll_margin)
5374 nlines = this_scroll_margin;
5375 else if (window_scroll_preserve_vpos
5376 >= ht - this_scroll_margin)
5377 nlines = ht - this_scroll_margin - 1;
5378 Fvertical_motion (Fcons (make_number (window_scroll_preserve_hpos),
5379 make_number (nlines)), window, Qnil);
5381 else
5382 Fvertical_motion (make_number (-1), window, Qnil);
5386 else
5388 if (noerror)
5389 return;
5390 else
5391 xsignal0 (Qend_of_buffer);
5394 if (adjust_old_pointm)
5395 Fset_marker (w->old_pointm,
5396 ((w == XWINDOW (selected_window))
5397 ? make_number (BUF_PT (XBUFFER (w->contents)))
5398 : Fmarker_position (w->pointm)),
5399 w->contents);
5403 /* Scroll selected_window up or down. If N is nil, scroll a
5404 screen-full which is defined as the height of the window minus
5405 next_screen_context_lines. If N is the symbol `-', scroll.
5406 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
5407 up. This is the guts of Fscroll_up and Fscroll_down. */
5409 static void
5410 scroll_command (Lisp_Object n, int direction)
5412 ptrdiff_t count = SPECPDL_INDEX ();
5414 eassert (eabs (direction) == 1);
5416 /* If selected window's buffer isn't current, make it current for
5417 the moment. But don't screw up if window_scroll gets an error. */
5418 if (XBUFFER (XWINDOW (selected_window)->contents) != current_buffer)
5420 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5421 Fset_buffer (XWINDOW (selected_window)->contents);
5424 if (NILP (n))
5425 window_scroll (selected_window, direction, true, false);
5426 else if (EQ (n, Qminus))
5427 window_scroll (selected_window, -direction, true, false);
5428 else
5430 n = Fprefix_numeric_value (n);
5431 window_scroll (selected_window, XINT (n) * direction, false, false);
5434 unbind_to (count, Qnil);
5437 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
5438 doc: /* Scroll text of selected window upward ARG lines.
5439 If ARG is omitted or nil, scroll upward by a near full screen.
5440 A near full screen is `next-screen-context-lines' less than a full screen.
5441 Negative ARG means scroll downward.
5442 If ARG is the atom `-', scroll downward by nearly full screen.
5443 When calling from a program, supply as argument a number, nil, or `-'. */)
5444 (Lisp_Object arg)
5446 scroll_command (arg, 1);
5447 return Qnil;
5450 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
5451 doc: /* Scroll text of selected window down ARG lines.
5452 If ARG is omitted or nil, scroll down by a near full screen.
5453 A near full screen is `next-screen-context-lines' less than a full screen.
5454 Negative ARG means scroll upward.
5455 If ARG is the atom `-', scroll upward by nearly full screen.
5456 When calling from a program, supply as argument a number, nil, or `-'. */)
5457 (Lisp_Object arg)
5459 scroll_command (arg, -1);
5460 return Qnil;
5463 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
5464 doc: /* Return the other window for \"other window scroll\" commands.
5465 If `other-window-scroll-buffer' is non-nil, a window
5466 showing that buffer is used.
5467 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5468 specifies the window. This takes precedence over
5469 `other-window-scroll-buffer'. */)
5470 (void)
5472 Lisp_Object window;
5474 if (MINI_WINDOW_P (XWINDOW (selected_window))
5475 && !NILP (Vminibuf_scroll_window))
5476 window = Vminibuf_scroll_window;
5477 /* If buffer is specified and live, scroll that buffer. */
5478 else if (!NILP (Vother_window_scroll_buffer)
5479 && BUFFERP (Vother_window_scroll_buffer)
5480 && BUFFER_LIVE_P (XBUFFER (Vother_window_scroll_buffer)))
5482 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
5483 if (NILP (window))
5484 window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil);
5486 else
5488 /* Nothing specified; look for a neighboring window on the same
5489 frame. */
5490 window = Fnext_window (selected_window, Qnil, Qnil);
5492 if (EQ (window, selected_window))
5493 /* That didn't get us anywhere; look for a window on another
5494 visible frame. */
5496 window = Fnext_window (window, Qnil, Qt);
5497 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
5498 && ! EQ (window, selected_window));
5501 CHECK_LIVE_WINDOW (window);
5503 if (EQ (window, selected_window))
5504 error ("There is no other window");
5506 return window;
5509 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
5510 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
5511 A near full screen is `next-screen-context-lines' less than a full screen.
5512 The next window is the one below the current one; or the one at the top
5513 if the current one is at the bottom. Negative ARG means scroll downward.
5514 If ARG is the atom `-', scroll downward by nearly full screen.
5515 When calling from a program, supply as argument a number, nil, or `-'.
5517 If `other-window-scroll-buffer' is non-nil, scroll the window
5518 showing that buffer, popping the buffer up if necessary.
5519 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5520 specifies the window to scroll. This takes precedence over
5521 `other-window-scroll-buffer'. */)
5522 (Lisp_Object arg)
5524 Lisp_Object window;
5525 struct window *w;
5526 ptrdiff_t count = SPECPDL_INDEX ();
5528 window = Fother_window_for_scrolling ();
5529 w = XWINDOW (window);
5531 /* Don't screw up if window_scroll gets an error. */
5532 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5534 Fset_buffer (w->contents);
5535 SET_PT_BOTH (marker_position (w->pointm), marker_byte_position (w->pointm));
5536 SET_PT_BOTH (marker_position (w->old_pointm), marker_byte_position (w->old_pointm));
5538 if (NILP (arg))
5539 window_scroll (window, 1, true, true);
5540 else if (EQ (arg, Qminus))
5541 window_scroll (window, -1, true, true);
5542 else
5544 if (CONSP (arg))
5545 arg = XCAR (arg);
5546 CHECK_NUMBER (arg);
5547 window_scroll (window, XINT (arg), false, true);
5550 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
5551 set_marker_both (w->old_pointm, Qnil, PT, PT_BYTE);
5552 unbind_to (count, Qnil);
5554 return Qnil;
5557 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
5558 doc: /* Scroll selected window display ARG columns left.
5559 Default for ARG is window width minus 2.
5560 Value is the total amount of leftward horizontal scrolling in
5561 effect after the change.
5562 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5563 lower bound for automatic scrolling, i.e. automatic scrolling
5564 will not scroll a window to a column less than the value returned
5565 by this function. This happens in an interactive call. */)
5566 (register Lisp_Object arg, Lisp_Object set_minimum)
5568 struct window *w = XWINDOW (selected_window);
5569 EMACS_INT requested_arg = (NILP (arg)
5570 ? window_body_width (w, 0) - 2
5571 : XINT (Fprefix_numeric_value (arg)));
5572 Lisp_Object result = set_window_hscroll (w, w->hscroll + requested_arg);
5574 if (!NILP (set_minimum))
5575 w->min_hscroll = w->hscroll;
5577 w->suspend_auto_hscroll = true;
5579 return result;
5582 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
5583 doc: /* Scroll selected window display ARG columns right.
5584 Default for ARG is window width minus 2.
5585 Value is the total amount of leftward horizontal scrolling in
5586 effect after the change.
5587 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5588 lower bound for automatic scrolling, i.e. automatic scrolling
5589 will not scroll a window to a column less than the value returned
5590 by this function. This happens in an interactive call. */)
5591 (register Lisp_Object arg, Lisp_Object set_minimum)
5593 struct window *w = XWINDOW (selected_window);
5594 EMACS_INT requested_arg = (NILP (arg)
5595 ? window_body_width (w, 0) - 2
5596 : XINT (Fprefix_numeric_value (arg)));
5597 Lisp_Object result = set_window_hscroll (w, w->hscroll - requested_arg);
5599 if (!NILP (set_minimum))
5600 w->min_hscroll = w->hscroll;
5602 w->suspend_auto_hscroll = true;
5604 return result;
5607 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
5608 doc: /* Return the window which was selected when entering the minibuffer.
5609 Returns nil, if selected window is not a minibuffer window. */)
5610 (void)
5612 if (minibuf_level > 0
5613 && MINI_WINDOW_P (XWINDOW (selected_window))
5614 && WINDOW_LIVE_P (minibuf_selected_window))
5615 return minibuf_selected_window;
5617 return Qnil;
5620 /* Value is the number of lines actually displayed in window W,
5621 as opposed to its height. */
5623 static int
5624 displayed_window_lines (struct window *w)
5626 struct it it;
5627 struct text_pos start;
5628 int height = window_box_height (w);
5629 struct buffer *old_buffer;
5630 int bottom_y;
5631 void *itdata = NULL;
5633 if (XBUFFER (w->contents) != current_buffer)
5635 old_buffer = current_buffer;
5636 set_buffer_internal (XBUFFER (w->contents));
5638 else
5639 old_buffer = NULL;
5641 /* In case W->start is out of the accessible range, do something
5642 reasonable. This happens in Info mode when Info-scroll-down
5643 calls (recenter -1) while W->start is 1. */
5644 CLIP_TEXT_POS_FROM_MARKER (start, w->start);
5646 itdata = bidi_shelve_cache ();
5647 start_display (&it, w, start);
5648 move_it_vertically (&it, height);
5649 bottom_y = line_bottom_y (&it);
5650 bidi_unshelve_cache (itdata, false);
5652 /* rms: On a non-window display,
5653 the value of it.vpos at the bottom of the screen
5654 seems to be 1 larger than window_box_height (w).
5655 This kludge fixes a bug whereby (move-to-window-line -1)
5656 when ZV is on the last screen line
5657 moves to the previous screen line instead of the last one. */
5658 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
5659 height++;
5661 /* Add in empty lines at the bottom of the window. */
5662 if (bottom_y < height)
5664 int uy = FRAME_LINE_HEIGHT (it.f);
5665 it.vpos += (height - bottom_y + uy - 1) / uy;
5668 if (old_buffer)
5669 set_buffer_internal (old_buffer);
5671 return it.vpos;
5675 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
5676 doc: /* Center point in selected window and maybe redisplay frame.
5677 With a numeric prefix argument ARG, recenter putting point on screen line ARG
5678 relative to the selected window. If ARG is negative, it counts up from the
5679 bottom of the window. (ARG should be less than the height of the window.)
5681 If ARG is omitted or nil, then recenter with point on the middle line of
5682 the selected window; if the variable `recenter-redisplay' is non-nil,
5683 also erase the entire frame and redraw it (when `auto-resize-tool-bars'
5684 is set to `grow-only', this resets the tool-bar's height to the minimum
5685 height needed); if `recenter-redisplay' has the special value `tty',
5686 then only tty frames are redrawn.
5688 Just C-u as prefix means put point in the center of the window
5689 and redisplay normally--don't erase and redraw the frame. */)
5690 (register Lisp_Object arg)
5692 struct window *w = XWINDOW (selected_window);
5693 struct buffer *buf = XBUFFER (w->contents);
5694 bool center_p = false;
5695 ptrdiff_t charpos, bytepos;
5696 EMACS_INT iarg IF_LINT (= 0);
5697 int this_scroll_margin;
5699 if (buf != current_buffer)
5700 error ("`recenter'ing a window that does not display current-buffer.");
5702 /* If redisplay is suppressed due to an error, try again. */
5703 buf->display_error_modiff = 0;
5705 if (NILP (arg))
5707 if (!NILP (Vrecenter_redisplay)
5708 && (!EQ (Vrecenter_redisplay, Qtty)
5709 || !NILP (Ftty_type (selected_frame))))
5711 ptrdiff_t i;
5713 /* Invalidate pixel data calculated for all compositions. */
5714 for (i = 0; i < n_compositions; i++)
5715 composition_table[i]->font = NULL;
5716 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5717 WINDOW_XFRAME (w)->minimize_tool_bar_window_p = 1;
5718 #endif
5719 Fredraw_frame (WINDOW_FRAME (w));
5720 SET_FRAME_GARBAGED (WINDOW_XFRAME (w));
5723 center_p = true;
5725 else if (CONSP (arg)) /* Just C-u. */
5726 center_p = true;
5727 else
5729 arg = Fprefix_numeric_value (arg);
5730 CHECK_NUMBER (arg);
5731 iarg = XINT (arg);
5734 /* Do this after making BUF current
5735 in case scroll_margin is buffer-local. */
5736 this_scroll_margin
5737 = max (0, min (scroll_margin, w->total_lines / 4));
5739 /* Don't use redisplay code for initial frames, as the necessary
5740 data structures might not be set up yet then. */
5741 if (!FRAME_INITIAL_P (XFRAME (w->frame)))
5743 if (center_p)
5745 struct it it;
5746 struct text_pos pt;
5747 void *itdata = bidi_shelve_cache ();
5749 SET_TEXT_POS (pt, PT, PT_BYTE);
5750 start_display (&it, w, pt);
5751 move_it_vertically_backward (&it, window_box_height (w) / 2);
5752 charpos = IT_CHARPOS (it);
5753 bytepos = IT_BYTEPOS (it);
5754 bidi_unshelve_cache (itdata, false);
5756 else if (iarg < 0)
5758 struct it it;
5759 struct text_pos pt;
5760 ptrdiff_t nlines = min (PTRDIFF_MAX, -iarg);
5761 int extra_line_spacing;
5762 int h = window_box_height (w);
5763 int ht = window_internal_height (w);
5764 void *itdata = bidi_shelve_cache ();
5766 nlines = clip_to_bounds (this_scroll_margin + 1, nlines,
5767 ht - this_scroll_margin);
5769 SET_TEXT_POS (pt, PT, PT_BYTE);
5770 start_display (&it, w, pt);
5772 /* Be sure we have the exact height of the full line containing PT. */
5773 move_it_by_lines (&it, 0);
5775 /* The amount of pixels we have to move back is the window
5776 height minus what's displayed in the line containing PT,
5777 and the lines below. */
5778 it.current_y = 0;
5779 it.vpos = 0;
5780 move_it_by_lines (&it, nlines);
5782 if (it.vpos == nlines)
5783 h -= it.current_y;
5784 else
5786 /* Last line has no newline. */
5787 h -= line_bottom_y (&it);
5788 it.vpos++;
5791 /* Don't reserve space for extra line spacing of last line. */
5792 extra_line_spacing = it.max_extra_line_spacing;
5794 /* If we can't move down NLINES lines because we hit
5795 the end of the buffer, count in some empty lines. */
5796 if (it.vpos < nlines)
5798 nlines -= it.vpos;
5799 extra_line_spacing = it.extra_line_spacing;
5800 h -= nlines * (FRAME_LINE_HEIGHT (it.f) + extra_line_spacing);
5802 if (h <= 0)
5804 bidi_unshelve_cache (itdata, false);
5805 return Qnil;
5808 /* Now find the new top line (starting position) of the window. */
5809 start_display (&it, w, pt);
5810 it.current_y = 0;
5811 move_it_vertically_backward (&it, h);
5813 /* If extra line spacing is present, we may move too far
5814 back. This causes the last line to be only partially
5815 visible (which triggers redisplay to recenter that line
5816 in the middle), so move forward.
5817 But ignore extra line spacing on last line, as it is not
5818 considered to be part of the visible height of the line.
5820 h += extra_line_spacing;
5821 while (-it.current_y > h)
5822 move_it_by_lines (&it, 1);
5824 charpos = IT_CHARPOS (it);
5825 bytepos = IT_BYTEPOS (it);
5827 bidi_unshelve_cache (itdata, false);
5829 else
5831 struct it it;
5832 struct text_pos pt;
5833 ptrdiff_t nlines = min (PTRDIFF_MAX, iarg);
5834 int ht = window_internal_height (w);
5835 void *itdata = bidi_shelve_cache ();
5837 nlines = clip_to_bounds (this_scroll_margin, nlines,
5838 ht - this_scroll_margin - 1);
5840 SET_TEXT_POS (pt, PT, PT_BYTE);
5841 start_display (&it, w, pt);
5843 /* Move to the beginning of screen line containing PT. */
5844 move_it_by_lines (&it, 0);
5846 /* Move back to find the point which is ARG screen lines above PT. */
5847 if (nlines > 0)
5849 it.current_y = 0;
5850 it.vpos = 0;
5851 move_it_by_lines (&it, -nlines);
5854 charpos = IT_CHARPOS (it);
5855 bytepos = IT_BYTEPOS (it);
5857 bidi_unshelve_cache (itdata, false);
5860 else
5862 struct position pos;
5863 int ht = window_internal_height (w);
5865 if (center_p)
5866 iarg = ht / 2;
5867 else if (iarg < 0)
5868 iarg += ht;
5870 /* Don't let it get into the margin at either top or bottom. */
5871 iarg = clip_to_bounds (this_scroll_margin, iarg,
5872 ht - this_scroll_margin - 1);
5874 pos = *vmotion (PT, PT_BYTE, - iarg, w);
5875 charpos = pos.bufpos;
5876 bytepos = pos.bytepos;
5879 /* Set the new window start. */
5880 set_marker_both (w->start, w->contents, charpos, bytepos);
5881 w->window_end_valid = false;
5883 w->optional_new_start = true;
5885 w->start_at_line_beg = (bytepos == BEGV_BYTE
5886 || FETCH_BYTE (bytepos - 1) == '\n');
5888 wset_redisplay (w);
5890 return Qnil;
5893 DEFUN ("window-text-width", Fwindow_text_width, Swindow_text_width,
5894 0, 2, 0,
5895 doc: /* Return the width in columns of the text display area of WINDOW.
5896 WINDOW must be a live window and defaults to the selected one.
5898 The returned width does not include dividers, scrollbars, margins,
5899 fringes, nor any partial-width columns at the right of the text
5900 area.
5902 Optional argument PIXELWISE non-nil, means to return the width in
5903 pixels. */)
5904 (Lisp_Object window, Lisp_Object pixelwise)
5906 struct window *w = decode_live_window (window);
5908 if (NILP (pixelwise))
5909 return make_number (window_box_width (w, TEXT_AREA)
5910 / FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w)));
5911 else
5912 return make_number (window_box_width (w, TEXT_AREA));
5915 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5916 0, 2, 0,
5917 doc: /* Return the height in lines of the text display area of WINDOW.
5918 WINDOW must be a live window and defaults to the selected one.
5920 The returned height does not include dividers, the mode line, any header
5921 line, nor any partial-height lines at the bottom of the text area.
5923 Optional argument PIXELWISE non-nil, means to return the height in
5924 pixels. */)
5925 (Lisp_Object window, Lisp_Object pixelwise)
5927 struct window *w = decode_live_window (window);
5929 if (NILP (pixelwise))
5930 return make_number (window_box_height (w)
5931 / FRAME_LINE_HEIGHT (WINDOW_XFRAME (w)));
5932 else
5933 return make_number (window_box_height (w));
5936 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
5937 1, 1, "P",
5938 doc: /* Position point relative to window.
5939 ARG nil means position point at center of window.
5940 Else, ARG specifies vertical position within the window;
5941 zero means top of window, negative means relative to bottom of window. */)
5942 (Lisp_Object arg)
5944 struct window *w = XWINDOW (selected_window);
5945 int lines, start;
5946 Lisp_Object window;
5947 #if false
5948 int this_scroll_margin;
5949 #endif
5951 if (!(BUFFERP (w->contents) && XBUFFER (w->contents) == current_buffer))
5952 /* This test is needed to make sure PT/PT_BYTE make sense in w->contents
5953 when passed below to set_marker_both. */
5954 error ("move-to-window-line called from unrelated buffer");
5956 window = selected_window;
5957 start = marker_position (w->start);
5958 if (start < BEGV || start > ZV)
5960 int height = window_internal_height (w);
5961 Fvertical_motion (make_number (- (height / 2)), window, Qnil);
5962 set_marker_both (w->start, w->contents, PT, PT_BYTE);
5963 w->start_at_line_beg = !NILP (Fbolp ());
5964 w->force_start = true;
5966 else
5967 Fgoto_char (w->start);
5969 lines = displayed_window_lines (w);
5971 #if false
5972 this_scroll_margin = max (0, min (scroll_margin, lines / 4));
5973 #endif
5975 if (NILP (arg))
5976 XSETFASTINT (arg, lines / 2);
5977 else
5979 EMACS_INT iarg = XINT (Fprefix_numeric_value (arg));
5981 if (iarg < 0)
5982 iarg = iarg + lines;
5984 #if false /* This code would prevent move-to-window-line from moving point
5985 to a place inside the scroll margins (which would cause the
5986 next redisplay to scroll). I wrote this code, but then concluded
5987 it is probably better not to install it. However, it is here
5988 inside #if false so as not to lose it. -- rms. */
5990 /* Don't let it get into the margin at either top or bottom. */
5991 iarg = max (iarg, this_scroll_margin);
5992 iarg = min (iarg, lines - this_scroll_margin - 1);
5993 #endif
5995 arg = make_number (iarg);
5998 /* Skip past a partially visible first line. */
5999 if (w->vscroll)
6000 XSETINT (arg, XINT (arg) + 1);
6002 return Fvertical_motion (arg, window, Qnil);
6007 /***********************************************************************
6008 Window Configuration
6009 ***********************************************************************/
6011 struct save_window_data
6013 struct vectorlike_header header;
6014 Lisp_Object selected_frame;
6015 Lisp_Object current_window;
6016 Lisp_Object current_buffer;
6017 Lisp_Object minibuf_scroll_window;
6018 Lisp_Object minibuf_selected_window;
6019 Lisp_Object root_window;
6020 Lisp_Object focus_frame;
6021 /* A vector, each of whose elements is a struct saved_window
6022 for one window. */
6023 Lisp_Object saved_windows;
6025 /* All fields above are traced by the GC.
6026 From `frame-cols' down, the fields are ignored by the GC. */
6027 /* We should be able to do without the following two. */
6028 int frame_cols, frame_lines;
6029 /* These two should get eventually replaced by their pixel
6030 counterparts. */
6031 int frame_menu_bar_lines, frame_tool_bar_lines;
6032 int frame_text_width, frame_text_height;
6033 /* These are currently unused. We need them as soon as we convert
6034 to pixels. */
6035 int frame_menu_bar_height, frame_tool_bar_height;
6038 /* This is saved as a Lisp_Vector. */
6039 struct saved_window
6041 struct vectorlike_header header;
6043 Lisp_Object window, buffer, start, pointm, old_pointm;
6044 Lisp_Object pixel_left, pixel_top, pixel_height, pixel_width;
6045 Lisp_Object pixel_height_before_size_change, pixel_width_before_size_change;
6046 Lisp_Object left_col, top_line, total_cols, total_lines;
6047 Lisp_Object normal_cols, normal_lines;
6048 Lisp_Object hscroll, min_hscroll, hscroll_whole, suspend_auto_hscroll;
6049 Lisp_Object parent, prev;
6050 Lisp_Object start_at_line_beg;
6051 Lisp_Object display_table;
6052 Lisp_Object left_margin_cols, right_margin_cols;
6053 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
6054 Lisp_Object scroll_bar_width, vertical_scroll_bar_type, dedicated;
6055 Lisp_Object scroll_bar_height, horizontal_scroll_bar_type;
6056 Lisp_Object combination_limit, window_parameters;
6059 #define SAVED_WINDOW_N(swv,n) \
6060 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
6062 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
6063 doc: /* Return t if OBJECT is a window-configuration object. */)
6064 (Lisp_Object object)
6066 return WINDOW_CONFIGURATIONP (object) ? Qt : Qnil;
6069 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
6070 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
6071 (Lisp_Object config)
6073 register struct save_window_data *data;
6074 struct Lisp_Vector *saved_windows;
6076 CHECK_WINDOW_CONFIGURATION (config);
6078 data = (struct save_window_data *) XVECTOR (config);
6079 saved_windows = XVECTOR (data->saved_windows);
6080 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
6083 DEFUN ("set-window-configuration", Fset_window_configuration,
6084 Sset_window_configuration, 1, 1, 0,
6085 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
6086 CONFIGURATION must be a value previously returned
6087 by `current-window-configuration' (which see).
6088 If CONFIGURATION was made from a frame that is now deleted,
6089 only frame-independent values can be restored. In this case,
6090 the return value is nil. Otherwise the value is t. */)
6091 (Lisp_Object configuration)
6093 register struct save_window_data *data;
6094 struct Lisp_Vector *saved_windows;
6095 Lisp_Object new_current_buffer;
6096 Lisp_Object frame;
6097 struct frame *f;
6098 ptrdiff_t old_point = -1;
6099 USE_SAFE_ALLOCA;
6101 CHECK_WINDOW_CONFIGURATION (configuration);
6103 data = (struct save_window_data *) XVECTOR (configuration);
6104 saved_windows = XVECTOR (data->saved_windows);
6106 new_current_buffer = data->current_buffer;
6107 if (!BUFFER_LIVE_P (XBUFFER (new_current_buffer)))
6108 new_current_buffer = Qnil;
6109 else
6111 if (XBUFFER (new_current_buffer) == current_buffer)
6112 /* The code further down "preserves point" by saving here PT in
6113 old_point and then setting it later back into PT. When the
6114 current-selected-window and the final-selected-window both show
6115 the current buffer, this suffers from the problem that the
6116 current PT is the window-point of the current-selected-window,
6117 while the final PT is the point of the final-selected-window, so
6118 this copy from one PT to the other would end up moving the
6119 window-point of the final-selected-window to the window-point of
6120 the current-selected-window. So we have to be careful which
6121 point of the current-buffer we copy into old_point. */
6122 if (EQ (XWINDOW (data->current_window)->contents, new_current_buffer)
6123 && WINDOWP (selected_window)
6124 && EQ (XWINDOW (selected_window)->contents, new_current_buffer)
6125 && !EQ (selected_window, data->current_window))
6126 old_point = marker_position (XWINDOW (data->current_window)->pointm);
6127 else
6128 old_point = PT;
6129 else
6130 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
6131 point in new_current_buffer as of the last time this buffer was
6132 used. This can be non-deterministic since it can be changed by
6133 things like jit-lock by mere temporary selection of some random
6134 window that happens to show this buffer.
6135 So if possible we want this arbitrary choice of "which point" to
6136 be the one from the to-be-selected-window so as to prevent this
6137 window's cursor from being copied from another window. */
6138 if (EQ (XWINDOW (data->current_window)->contents, new_current_buffer)
6139 /* If current_window = selected_window, its point is in BUF_PT. */
6140 && !EQ (selected_window, data->current_window))
6141 old_point = marker_position (XWINDOW (data->current_window)->pointm);
6142 else
6143 old_point = BUF_PT (XBUFFER (new_current_buffer));
6146 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
6147 f = XFRAME (frame);
6149 /* If f is a dead frame, don't bother rebuilding its window tree.
6150 However, there is other stuff we should still try to do below. */
6151 if (FRAME_LIVE_P (f))
6153 Lisp_Object window;
6154 Lisp_Object dead_windows = Qnil;
6155 Lisp_Object tem, par, pers;
6156 struct window *w;
6157 struct saved_window *p;
6158 struct window *root_window;
6159 struct window **leaf_windows;
6160 ptrdiff_t i, k, n_leaf_windows;
6161 /* Records whether a window has been added or removed wrt the
6162 original configuration. */
6163 bool window_changed = false;
6164 /* Records whether a window has changed its buffer wrt the
6165 original configuration. */
6166 bool buffer_changed = false;
6168 /* Don't do this within the main loop below: This may call Lisp
6169 code and is thus potentially unsafe while input is blocked. */
6170 for (k = 0; k < saved_windows->header.size; k++)
6172 p = SAVED_WINDOW_N (saved_windows, k);
6173 window = p->window;
6174 w = XWINDOW (window);
6176 if (NILP (w->contents))
6177 /* A dead window that will be resurrected, the window
6178 configuration will change. */
6179 window_changed = true;
6181 if (BUFFERP (w->contents)
6182 && !EQ (w->contents, p->buffer)
6183 && BUFFER_LIVE_P (XBUFFER (p->buffer)))
6184 /* If a window we restore gets another buffer, record the
6185 window's old buffer. */
6186 call1 (Qrecord_window_buffer, window);
6189 /* Disallow x_set_window_size, temporarily. */
6190 f->can_x_set_window_size = false;
6191 /* The mouse highlighting code could get screwed up
6192 if it runs during this. */
6193 block_input ();
6195 /* "Swap out" point from the selected window's buffer
6196 into the window itself. (Normally the pointm of the selected
6197 window holds garbage.) We do this now, before
6198 restoring the window contents, and prevent it from
6199 being done later on when we select a new window. */
6200 if (! NILP (XWINDOW (selected_window)->contents))
6202 w = XWINDOW (selected_window);
6203 set_marker_both (w->pointm,
6204 w->contents,
6205 BUF_PT (XBUFFER (w->contents)),
6206 BUF_PT_BYTE (XBUFFER (w->contents)));
6209 fset_redisplay (f);
6211 /* Problem: Freeing all matrices and later allocating them again
6212 is a serious redisplay flickering problem. What we would
6213 really like to do is to free only those matrices not reused
6214 below. */
6215 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
6216 ptrdiff_t nwindows = count_windows (root_window);
6217 SAFE_NALLOCA (leaf_windows, 1, nwindows);
6218 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
6220 /* Kludge Alert!
6221 Mark all windows now on frame as "deleted".
6222 Restoring the new configuration "undeletes" any that are in it.
6224 Save their current buffers in their height fields, since we may
6225 need it later, if a buffer saved in the configuration is now
6226 dead. */
6227 delete_all_child_windows (FRAME_ROOT_WINDOW (f));
6229 for (k = 0; k < saved_windows->header.size; k++)
6231 p = SAVED_WINDOW_N (saved_windows, k);
6232 window = p->window;
6233 w = XWINDOW (window);
6234 wset_next (w, Qnil);
6236 if (!NILP (p->parent))
6237 wset_parent
6238 (w, SAVED_WINDOW_N (saved_windows, XFASTINT (p->parent))->window);
6239 else
6240 wset_parent (w, Qnil);
6242 if (!NILP (p->prev))
6244 wset_prev
6245 (w, SAVED_WINDOW_N (saved_windows, XFASTINT (p->prev))->window);
6246 wset_next (XWINDOW (w->prev), p->window);
6248 else
6250 wset_prev (w, Qnil);
6251 if (!NILP (w->parent))
6252 wset_combination (XWINDOW (w->parent),
6253 (XINT (p->total_cols)
6254 != XWINDOW (w->parent)->total_cols),
6255 p->window);
6258 /* If we squirreled away the buffer, restore it now. */
6259 if (BUFFERP (w->combination_limit))
6260 wset_buffer (w, w->combination_limit);
6261 w->pixel_left = XFASTINT (p->pixel_left);
6262 w->pixel_top = XFASTINT (p->pixel_top);
6263 w->pixel_width = XFASTINT (p->pixel_width);
6264 w->pixel_height = XFASTINT (p->pixel_height);
6265 w->pixel_width_before_size_change
6266 = XFASTINT (p->pixel_width_before_size_change);
6267 w->pixel_height_before_size_change
6268 = XFASTINT (p->pixel_height_before_size_change);
6269 w->left_col = XFASTINT (p->left_col);
6270 w->top_line = XFASTINT (p->top_line);
6271 w->total_cols = XFASTINT (p->total_cols);
6272 w->total_lines = XFASTINT (p->total_lines);
6273 wset_normal_cols (w, p->normal_cols);
6274 wset_normal_lines (w, p->normal_lines);
6275 w->hscroll = XFASTINT (p->hscroll);
6276 w->suspend_auto_hscroll = !NILP (p->suspend_auto_hscroll);
6277 w->min_hscroll = XFASTINT (p->min_hscroll);
6278 w->hscroll_whole = XFASTINT (p->hscroll_whole);
6279 wset_display_table (w, p->display_table);
6280 w->left_margin_cols = XINT (p->left_margin_cols);
6281 w->right_margin_cols = XINT (p->right_margin_cols);
6282 w->left_fringe_width = XINT (p->left_fringe_width);
6283 w->right_fringe_width = XINT (p->right_fringe_width);
6284 w->fringes_outside_margins = !NILP (p->fringes_outside_margins);
6285 w->scroll_bar_width = XINT (p->scroll_bar_width);
6286 w->scroll_bar_height = XINT (p->scroll_bar_height);
6287 wset_vertical_scroll_bar_type (w, p->vertical_scroll_bar_type);
6288 wset_horizontal_scroll_bar_type (w, p->horizontal_scroll_bar_type);
6289 wset_dedicated (w, p->dedicated);
6290 wset_combination_limit (w, p->combination_limit);
6291 /* Restore any window parameters that have been saved.
6292 Parameters that have not been saved are left alone. */
6293 for (tem = p->window_parameters; CONSP (tem); tem = XCDR (tem))
6295 pers = XCAR (tem);
6296 if (CONSP (pers))
6298 if (NILP (XCDR (pers)))
6300 par = Fassq (XCAR (pers), w->window_parameters);
6301 if (CONSP (par) && !NILP (XCDR (par)))
6302 /* Reset a parameter to nil if and only if it
6303 has a non-nil association. Don't make new
6304 associations. */
6305 Fsetcdr (par, Qnil);
6307 else
6308 /* Always restore a non-nil value. */
6309 Fset_window_parameter (window, XCAR (pers), XCDR (pers));
6313 if (BUFFERP (p->buffer) && BUFFER_LIVE_P (XBUFFER (p->buffer)))
6314 /* If saved buffer is alive, install it. */
6316 if (!EQ (w->contents, p->buffer))
6317 /* Record buffer configuration change. */
6318 buffer_changed = true;
6319 wset_buffer (w, p->buffer);
6320 w->start_at_line_beg = !NILP (p->start_at_line_beg);
6321 set_marker_restricted (w->start, p->start, w->contents);
6322 set_marker_restricted (w->pointm, p->pointm, w->contents);
6323 set_marker_restricted (w->old_pointm, p->old_pointm, w->contents);
6324 /* As documented in Fcurrent_window_configuration, don't
6325 restore the location of point in the buffer which was
6326 current when the window configuration was recorded. */
6327 if (!EQ (p->buffer, new_current_buffer)
6328 && XBUFFER (p->buffer) == current_buffer)
6329 Fgoto_char (w->pointm);
6331 else if (BUFFERP (w->contents) && BUFFER_LIVE_P (XBUFFER (w->contents)))
6332 /* Keep window's old buffer; make sure the markers are real. */
6334 /* Set window markers at start of visible range. */
6335 if (XMARKER (w->start)->buffer == 0)
6336 set_marker_restricted_both (w->start, w->contents, 0, 0);
6337 if (XMARKER (w->pointm)->buffer == 0)
6338 set_marker_restricted_both
6339 (w->pointm, w->contents,
6340 BUF_PT (XBUFFER (w->contents)),
6341 BUF_PT_BYTE (XBUFFER (w->contents)));
6342 if (XMARKER (w->old_pointm)->buffer == 0)
6343 set_marker_restricted_both
6344 (w->old_pointm, w->contents,
6345 BUF_PT (XBUFFER (w->contents)),
6346 BUF_PT_BYTE (XBUFFER (w->contents)));
6347 w->start_at_line_beg = true;
6349 else if (!NILP (w->start))
6350 /* Leaf window has no live buffer, get one. */
6352 /* Record buffer configuration change. */
6353 buffer_changed = true;
6354 /* Get the buffer via other_buffer_safely in order to
6355 avoid showing an unimportant buffer and, if necessary, to
6356 recreate *scratch* in the course (part of Juanma's bs-show
6357 scenario from March 2011). */
6358 wset_buffer (w, other_buffer_safely (Fcurrent_buffer ()));
6359 /* This will set the markers to beginning of visible
6360 range. */
6361 set_marker_restricted_both (w->start, w->contents, 0, 0);
6362 set_marker_restricted_both (w->pointm, w->contents, 0, 0);
6363 set_marker_restricted_both (w->old_pointm, w->contents, 0, 0);
6364 w->start_at_line_beg = true;
6365 if (!NILP (w->dedicated))
6366 /* Record this window as dead. */
6367 dead_windows = Fcons (window, dead_windows);
6368 /* Make sure window is no more dedicated. */
6369 wset_dedicated (w, Qnil);
6373 fset_root_window (f, data->root_window);
6374 /* Arrange *not* to restore point in the buffer that was
6375 current when the window configuration was saved. */
6376 if (EQ (XWINDOW (data->current_window)->contents, new_current_buffer))
6377 set_marker_restricted (XWINDOW (data->current_window)->pointm,
6378 make_number (old_point),
6379 XWINDOW (data->current_window)->contents);
6381 /* In the following call to `select-window', prevent "swapping out
6382 point" in the old selected window using the buffer that has
6383 been restored into it. We already swapped out that point from
6384 that window's old buffer.
6386 Do not record the buffer here. We do that in a separate call
6387 to select_window below. See also Bug#16207. */
6388 select_window (data->current_window, Qt, true);
6389 BVAR (XBUFFER (XWINDOW (selected_window)->contents),
6390 last_selected_window)
6391 = selected_window;
6393 if (NILP (data->focus_frame)
6394 || (FRAMEP (data->focus_frame)
6395 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
6396 Fredirect_frame_focus (frame, data->focus_frame);
6398 /* Now, free glyph matrices in windows that were not reused. */
6399 for (i = 0; i < n_leaf_windows; i++)
6400 if (NILP (leaf_windows[i]->contents))
6402 free_window_matrices (leaf_windows[i]);
6403 window_changed = true;
6406 /* Allow x_set_window_size again and apply frame size changes if
6407 needed. */
6408 f->can_x_set_window_size = true;
6409 adjust_frame_size (f, -1, -1, 1, false, Qset_window_configuration);
6411 adjust_frame_glyphs (f);
6412 unblock_input ();
6414 /* Scan dead buffer windows. */
6415 for (; CONSP (dead_windows); dead_windows = XCDR (dead_windows))
6417 window = XCAR (dead_windows);
6418 if (WINDOW_LIVE_P (window) && !EQ (window, FRAME_ROOT_WINDOW (f)))
6419 delete_deletable_window (window);
6422 /* Record the selected window's buffer here. The window should
6423 already be the selected one from the call above. */
6424 if (WINDOW_LIVE_P (data->current_window))
6425 select_window (data->current_window, Qnil, false);
6427 /* Fselect_window will have made f the selected frame, so we
6428 reselect the proper frame here. Fhandle_switch_frame will change the
6429 selected window too, but that doesn't make the call to
6430 Fselect_window above totally superfluous; it still sets f's
6431 selected window. */
6432 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
6433 do_switch_frame (data->selected_frame, 0, 0, Qnil);
6435 if (window_changed)
6436 /* At least one window has been added or removed. Run
6437 `window-configuration-change-hook' and make sure
6438 `window-size-change-functions' get run later.
6440 We have to do this in order to capture the following
6441 scenario: Suppose our frame contains two live windows W1 and
6442 W2 and ‘set-window-configuration’ replaces them by two
6443 windows W3 and W4 that were dead the last time
6444 run_window_size_change_functions was run. If W3 and W4 have
6445 the same values for their old and new pixel sizes but these
6446 values differ from those of W1 and W2, the sizes of our
6447 frame's two live windows changed but window_size_changed has
6448 no means to detect that fact.
6450 Obviously, this will get us false positives, for example,
6451 when we restore the original configuration with W1 and W2
6452 before run_window_size_change_functions gets called. */
6454 run_window_configuration_change_hook (f);
6455 FRAME_WINDOW_CONFIGURATION_CHANGED (f) = true;
6457 else if (buffer_changed)
6458 /* At least one window has changed its buffer. Run
6459 `window-configuration-change-hook' only. */
6460 run_window_configuration_change_hook (f);
6463 if (!NILP (new_current_buffer))
6465 Fset_buffer (new_current_buffer);
6466 /* If the new current buffer doesn't appear in the selected
6467 window, go to its old point (see bug#12208). */
6468 if (!EQ (XWINDOW (data->current_window)->contents, new_current_buffer))
6469 Fgoto_char (make_number (old_point));
6472 Vminibuf_scroll_window = data->minibuf_scroll_window;
6473 minibuf_selected_window = data->minibuf_selected_window;
6475 SAFE_FREE ();
6476 return (FRAME_LIVE_P (f) ? Qt : Qnil);
6480 void
6481 restore_window_configuration (Lisp_Object configuration)
6483 Fset_window_configuration (configuration);
6487 /* If WINDOW is an internal window, recursively delete all child windows
6488 reachable via the next and contents slots of WINDOW. Otherwise setup
6489 WINDOW to not show any buffer. */
6491 void
6492 delete_all_child_windows (Lisp_Object window)
6494 register struct window *w;
6496 w = XWINDOW (window);
6498 if (!NILP (w->next))
6499 /* Delete WINDOW's siblings (we traverse postorderly). */
6500 delete_all_child_windows (w->next);
6502 if (WINDOWP (w->contents))
6504 delete_all_child_windows (w->contents);
6505 wset_combination (w, false, Qnil);
6507 else if (BUFFERP (w->contents))
6509 unshow_buffer (w);
6510 unchain_marker (XMARKER (w->pointm));
6511 unchain_marker (XMARKER (w->old_pointm));
6512 unchain_marker (XMARKER (w->start));
6513 /* Since combination limit makes sense for an internal windows
6514 only, we use this slot to save the buffer for the sake of
6515 possible resurrection in Fset_window_configuration. */
6516 wset_combination_limit (w, w->contents);
6517 wset_buffer (w, Qnil);
6520 Vwindow_list = Qnil;
6523 static ptrdiff_t
6524 count_windows (struct window *window)
6526 ptrdiff_t count = 1;
6527 if (!NILP (window->next))
6528 count += count_windows (XWINDOW (window->next));
6529 if (WINDOWP (window->contents))
6530 count += count_windows (XWINDOW (window->contents));
6531 return count;
6535 /* Fill vector FLAT with leaf windows under W, starting at index I.
6536 Value is last index + 1. */
6537 static ptrdiff_t
6538 get_leaf_windows (struct window *w, struct window **flat, ptrdiff_t i)
6540 while (w)
6542 if (WINDOWP (w->contents))
6543 i = get_leaf_windows (XWINDOW (w->contents), flat, i);
6544 else
6545 flat[i++] = w;
6547 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6550 return i;
6554 /* Return a pointer to the glyph W's physical cursor is on. Value is
6555 null if W's current matrix is invalid, so that no meaningful glyph
6556 can be returned. */
6557 struct glyph *
6558 get_phys_cursor_glyph (struct window *w)
6560 struct glyph_row *row;
6561 struct glyph *glyph;
6562 int hpos = w->phys_cursor.hpos;
6564 if (!(w->phys_cursor.vpos >= 0
6565 && w->phys_cursor.vpos < w->current_matrix->nrows))
6566 return NULL;
6568 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
6569 if (!row->enabled_p)
6570 return NULL;
6572 if (w->hscroll)
6574 /* When the window is hscrolled, cursor hpos can legitimately be
6575 out of bounds, but we draw the cursor at the corresponding
6576 window margin in that case. */
6577 if (!row->reversed_p && hpos < 0)
6578 hpos = 0;
6579 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
6580 hpos = row->used[TEXT_AREA] - 1;
6583 if (0 <= hpos && hpos < row->used[TEXT_AREA])
6584 glyph = row->glyphs[TEXT_AREA] + hpos;
6585 else
6586 glyph = NULL;
6588 return glyph;
6592 static ptrdiff_t
6593 save_window_save (Lisp_Object window, struct Lisp_Vector *vector, ptrdiff_t i)
6595 struct saved_window *p;
6596 struct window *w;
6597 Lisp_Object tem, pers, par;
6599 for (; !NILP (window); window = w->next)
6601 p = SAVED_WINDOW_N (vector, i);
6602 w = XWINDOW (window);
6604 wset_temslot (w, make_number (i)); i++;
6605 p->window = window;
6606 p->buffer = (WINDOW_LEAF_P (w) ? w->contents : Qnil);
6607 p->pixel_left = make_number (w->pixel_left);
6608 p->pixel_top = make_number (w->pixel_top);
6609 p->pixel_width = make_number (w->pixel_width);
6610 p->pixel_height = make_number (w->pixel_height);
6611 p->pixel_width_before_size_change
6612 = make_number (w->pixel_width_before_size_change);
6613 p->pixel_height_before_size_change
6614 = make_number (w->pixel_height_before_size_change);
6615 p->left_col = make_number (w->left_col);
6616 p->top_line = make_number (w->top_line);
6617 p->total_cols = make_number (w->total_cols);
6618 p->total_lines = make_number (w->total_lines);
6619 p->normal_cols = w->normal_cols;
6620 p->normal_lines = w->normal_lines;
6621 XSETFASTINT (p->hscroll, w->hscroll);
6622 p->suspend_auto_hscroll = w->suspend_auto_hscroll ? Qt : Qnil;
6623 XSETFASTINT (p->min_hscroll, w->min_hscroll);
6624 XSETFASTINT (p->hscroll_whole, w->hscroll_whole);
6625 p->display_table = w->display_table;
6626 p->left_margin_cols = make_number (w->left_margin_cols);
6627 p->right_margin_cols = make_number (w->right_margin_cols);
6628 p->left_fringe_width = make_number (w->left_fringe_width);
6629 p->right_fringe_width = make_number (w->right_fringe_width);
6630 p->fringes_outside_margins = w->fringes_outside_margins ? Qt : Qnil;
6631 p->scroll_bar_width = make_number (w->scroll_bar_width);
6632 p->scroll_bar_height = make_number (w->scroll_bar_height);
6633 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
6634 p->horizontal_scroll_bar_type = w->horizontal_scroll_bar_type;
6635 p->dedicated = w->dedicated;
6636 p->combination_limit = w->combination_limit;
6637 p->window_parameters = Qnil;
6639 if (!NILP (Vwindow_persistent_parameters))
6641 /* Run cycle detection on Vwindow_persistent_parameters. */
6642 Lisp_Object tortoise, hare;
6644 hare = tortoise = Vwindow_persistent_parameters;
6645 while (CONSP (hare))
6647 hare = XCDR (hare);
6648 if (!CONSP (hare))
6649 break;
6651 hare = XCDR (hare);
6652 tortoise = XCDR (tortoise);
6654 if (EQ (hare, tortoise))
6655 /* Reset Vwindow_persistent_parameters to Qnil. */
6657 Vwindow_persistent_parameters = Qnil;
6658 break;
6662 for (tem = Vwindow_persistent_parameters; CONSP (tem);
6663 tem = XCDR (tem))
6665 pers = XCAR (tem);
6666 /* Save values for persistent window parameters. */
6667 if (CONSP (pers) && !NILP (XCDR (pers)))
6669 par = Fassq (XCAR (pers), w->window_parameters);
6670 if (NILP (par))
6671 /* If the window has no value for the parameter,
6672 make one. */
6673 p->window_parameters = Fcons (Fcons (XCAR (pers), Qnil),
6674 p->window_parameters);
6675 else
6676 /* If the window has a value for the parameter,
6677 save it. */
6678 p->window_parameters = Fcons (Fcons (XCAR (par),
6679 XCDR (par)),
6680 p->window_parameters);
6685 if (BUFFERP (w->contents))
6687 /* Save w's value of point in the window configuration. If w
6688 is the selected window, then get the value of point from
6689 the buffer; pointm is garbage in the selected window. */
6690 if (EQ (window, selected_window))
6691 p->pointm = build_marker (XBUFFER (w->contents),
6692 BUF_PT (XBUFFER (w->contents)),
6693 BUF_PT_BYTE (XBUFFER (w->contents)));
6694 else
6695 p->pointm = Fcopy_marker (w->pointm, Qnil);
6696 p->old_pointm = Fcopy_marker (w->old_pointm, Qnil);
6697 XMARKER (p->pointm)->insertion_type
6698 = !NILP (buffer_local_value /* Don't signal error if void. */
6699 (Qwindow_point_insertion_type, w->contents));
6700 XMARKER (p->old_pointm)->insertion_type
6701 = !NILP (buffer_local_value /* Don't signal error if void. */
6702 (Qwindow_point_insertion_type, w->contents));
6704 p->start = Fcopy_marker (w->start, Qnil);
6705 p->start_at_line_beg = w->start_at_line_beg ? Qt : Qnil;
6707 else
6709 p->pointm = Qnil;
6710 p->old_pointm = Qnil;
6711 p->start = Qnil;
6712 p->start_at_line_beg = Qnil;
6715 p->parent = NILP (w->parent) ? Qnil : XWINDOW (w->parent)->temslot;
6716 p->prev = NILP (w->prev) ? Qnil : XWINDOW (w->prev)->temslot;
6718 if (WINDOWP (w->contents))
6719 i = save_window_save (w->contents, vector, i);
6722 return i;
6725 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
6726 Scurrent_window_configuration, 0, 1, 0,
6727 doc: /* Return an object representing the current window configuration of FRAME.
6728 If FRAME is nil or omitted, use the selected frame.
6729 This describes the number of windows, their sizes and current buffers,
6730 and for each displayed buffer, where display starts, and the position of
6731 point. An exception is made for point in the current buffer:
6732 its value is -not- saved.
6733 This also records the currently selected frame, and FRAME's focus
6734 redirection (see `redirect-frame-focus'). The variable
6735 `window-persistent-parameters' specifies which window parameters are
6736 saved by this function. */)
6737 (Lisp_Object frame)
6739 Lisp_Object tem;
6740 ptrdiff_t i, n_windows;
6741 struct save_window_data *data;
6742 struct frame *f = decode_live_frame (frame);
6744 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6745 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
6746 PVEC_WINDOW_CONFIGURATION);
6748 data->frame_cols = FRAME_COLS (f);
6749 data->frame_lines = FRAME_LINES (f);
6750 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6751 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6752 data->frame_text_width = FRAME_TEXT_WIDTH (f);
6753 data->frame_text_height = FRAME_TEXT_HEIGHT (f);
6754 data->frame_menu_bar_height = FRAME_MENU_BAR_HEIGHT (f);
6755 data->frame_tool_bar_height = FRAME_TOOL_BAR_HEIGHT (f);
6756 data->selected_frame = selected_frame;
6757 data->current_window = FRAME_SELECTED_WINDOW (f);
6758 XSETBUFFER (data->current_buffer, current_buffer);
6759 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
6760 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
6761 data->root_window = FRAME_ROOT_WINDOW (f);
6762 data->focus_frame = FRAME_FOCUS_FRAME (f);
6763 tem = make_uninit_vector (n_windows);
6764 data->saved_windows = tem;
6765 for (i = 0; i < n_windows; i++)
6766 ASET (tem, i,
6767 Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil));
6768 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
6769 XSETWINDOW_CONFIGURATION (tem, data);
6770 return (tem);
6773 /* Called after W's margins, fringes or scroll bars was adjusted. */
6775 static void
6776 apply_window_adjustment (struct window *w)
6778 eassert (w);
6779 clear_glyph_matrix (w->current_matrix);
6780 w->window_end_valid = false;
6781 wset_redisplay (w);
6782 adjust_frame_glyphs (XFRAME (WINDOW_FRAME (w)));
6786 /***********************************************************************
6787 Marginal Areas
6788 ***********************************************************************/
6790 static int
6791 extract_dimension (Lisp_Object dimension)
6793 if (NILP (dimension))
6794 return -1;
6795 CHECK_RANGED_INTEGER (dimension, 0, INT_MAX);
6796 return XINT (dimension);
6799 static struct window *
6800 set_window_margins (struct window *w, Lisp_Object left_width,
6801 Lisp_Object right_width)
6803 int unit = WINDOW_FRAME_COLUMN_WIDTH (w);
6804 int left = NILP (left_width) ? 0 : extract_dimension (left_width);
6805 int right = NILP (right_width) ? 0 : extract_dimension (right_width);
6807 if (w->left_margin_cols != left || w->right_margin_cols != right)
6809 /* Don't change anything if new margins won't fit. */
6810 if ((WINDOW_PIXEL_WIDTH (w)
6811 - WINDOW_FRINGES_WIDTH (w)
6812 - WINDOW_SCROLL_BAR_AREA_WIDTH (w)
6813 - (left + right) * unit)
6814 >= MIN_SAFE_WINDOW_PIXEL_WIDTH (w))
6816 w->left_margin_cols = left;
6817 w->right_margin_cols = right;
6819 return w;
6821 else
6822 return NULL;
6824 else
6825 return NULL;
6828 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
6829 2, 3, 0,
6830 doc: /* Set width of marginal areas of window WINDOW.
6831 WINDOW must be a live window and defaults to the selected one.
6833 Second arg LEFT-WIDTH specifies the number of character cells to
6834 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6835 does the same for the right marginal area. A nil width parameter
6836 means no margin.
6838 Return t if any margin was actually changed and nil otherwise. */)
6839 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width)
6841 struct window *w = set_window_margins (decode_live_window (window),
6842 left_width, right_width);
6843 return w ? (apply_window_adjustment (w), Qt) : Qnil;
6847 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
6848 0, 1, 0,
6849 doc: /* Get width of marginal areas of window WINDOW.
6850 WINDOW must be a live window and defaults to the selected one.
6852 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6853 If a marginal area does not exist, its width will be returned
6854 as nil. */)
6855 (Lisp_Object window)
6857 struct window *w = decode_live_window (window);
6858 return Fcons (w->left_margin_cols
6859 ? make_number (w->left_margin_cols) : Qnil,
6860 w->right_margin_cols
6861 ? make_number (w->right_margin_cols) : Qnil);
6866 /***********************************************************************
6867 Fringes
6868 ***********************************************************************/
6870 static struct window *
6871 set_window_fringes (struct window *w, Lisp_Object left_width,
6872 Lisp_Object right_width, Lisp_Object outside_margins)
6874 bool outside = !NILP (outside_margins);
6875 int left = extract_dimension (left_width);
6876 int right = extract_dimension (right_width);
6878 /* Do nothing on a tty or if nothing to actually change. */
6879 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6880 && (w->left_fringe_width != left
6881 || w->right_fringe_width != right
6882 || w->fringes_outside_margins != outside))
6884 if (left > 0 || right > 0)
6886 /* Don't change anything if new fringes don't fit. */
6887 if ((WINDOW_PIXEL_WIDTH (w)
6888 - WINDOW_MARGINS_WIDTH (w)
6889 - WINDOW_SCROLL_BAR_AREA_WIDTH (w)
6890 - max (left, 0) - max (right, 0))
6891 < MIN_SAFE_WINDOW_PIXEL_WIDTH (w))
6892 return NULL;
6895 w->left_fringe_width = left;
6896 w->right_fringe_width = right;
6897 w->fringes_outside_margins = outside;
6899 return w;
6901 else
6902 return NULL;
6905 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6906 2, 4, 0,
6907 doc: /* Set the fringe widths of window WINDOW.
6908 WINDOW must be a live window and defaults to the selected one.
6910 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6911 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6912 fringe width. If a fringe width arg is nil, that means to use the
6913 frame's default fringe width. Default fringe widths can be set with
6914 the command `set-fringe-style'.
6915 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6916 outside of the display margins. By default, fringes are drawn between
6917 display marginal areas and the text area.
6919 Return t if any fringe was actually changed and nil otherwise. */)
6920 (Lisp_Object window, Lisp_Object left_width,
6921 Lisp_Object right_width, Lisp_Object outside_margins)
6923 struct window *w
6924 = set_window_fringes (decode_live_window (window),
6925 left_width, right_width, outside_margins);
6926 return w ? (apply_window_adjustment (w), Qt) : Qnil;
6930 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6931 0, 1, 0,
6932 doc: /* Get width of fringes of window WINDOW.
6933 WINDOW must be a live window and defaults to the selected one.
6935 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6936 (Lisp_Object window)
6938 struct window *w = decode_live_window (window);
6940 return list3 (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6941 make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6942 WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w) ? Qt : Qnil);
6947 /***********************************************************************
6948 Scroll bars
6949 ***********************************************************************/
6951 static struct window *
6952 set_window_scroll_bars (struct window *w, Lisp_Object width,
6953 Lisp_Object vertical_type, Lisp_Object height,
6954 Lisp_Object horizontal_type)
6956 int iwidth = extract_dimension (width);
6957 bool changed = false;
6959 if (iwidth == 0)
6960 vertical_type = Qnil;
6962 if (!(NILP (vertical_type)
6963 || EQ (vertical_type, Qleft)
6964 || EQ (vertical_type, Qright)
6965 || EQ (vertical_type, Qt)))
6966 error ("Invalid type of vertical scroll bar");
6968 if (w->scroll_bar_width != iwidth
6969 || !EQ (w->vertical_scroll_bar_type, vertical_type))
6971 /* Don't change anything if new scroll bar won't fit. */
6972 if ((WINDOW_PIXEL_WIDTH (w)
6973 - WINDOW_MARGINS_WIDTH (w)
6974 - WINDOW_FRINGES_WIDTH (w)
6975 - max (iwidth, 0))
6976 >= MIN_SAFE_WINDOW_PIXEL_WIDTH (w))
6978 w->scroll_bar_width = iwidth;
6979 wset_vertical_scroll_bar_type (w, vertical_type);
6980 changed = true;
6984 #if USE_HORIZONTAL_SCROLL_BARS
6986 int iheight = extract_dimension (height);
6988 if (MINI_WINDOW_P (w) || iheight == 0)
6989 horizontal_type = Qnil;
6991 if (!(NILP (horizontal_type)
6992 || EQ (horizontal_type, Qbottom)
6993 || EQ (horizontal_type, Qt)))
6994 error ("Invalid type of horizontal scroll bar");
6996 if (w->scroll_bar_height != iheight
6997 || !EQ (w->horizontal_scroll_bar_type, horizontal_type))
6999 /* Don't change anything if new scroll bar won't fit. */
7000 if ((WINDOW_PIXEL_HEIGHT (w)
7001 - WINDOW_HEADER_LINE_HEIGHT (w)
7002 - WINDOW_MODE_LINE_HEIGHT (w)
7003 - max (iheight, 0))
7004 >= MIN_SAFE_WINDOW_PIXEL_HEIGHT (w))
7006 w->scroll_bar_height = iheight;
7007 wset_horizontal_scroll_bar_type (w, horizontal_type);
7008 changed = true;
7012 #else
7013 wset_horizontal_scroll_bar_type (w, Qnil);
7014 #endif
7016 return changed ? w : NULL;
7019 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars,
7020 Sset_window_scroll_bars, 1, 5, 0,
7021 doc: /* Set width and type of scroll bars of window WINDOW.
7022 WINDOW must be a live window and defaults to the selected one.
7024 Second parameter WIDTH specifies the pixel width for the vertical scroll
7025 bar. If WIDTH is nil, use the scroll-bar width of WINDOW's frame.
7026 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
7027 bar: left, right, or nil. If VERTICAL-TYPE is t, this means use the
7028 frame's scroll-bar type.
7030 Fourth parameter HEIGHT specifies the pixel height for the horizontal
7031 scroll bar. If HEIGHT is nil, use the scroll-bar height of WINDOW's
7032 frame. Fifth parameter HORIZONTAL-TYPE specifies the type of the
7033 horizontal scroll bar: nil, bottom, or t. If HORIZONTAL-TYPE is t, this
7034 means to use the frame's horizontal scroll-bar type.
7036 Return t if scroll bars were actually changed and nil otherwise. */)
7037 (Lisp_Object window, Lisp_Object width, Lisp_Object vertical_type,
7038 Lisp_Object height, Lisp_Object horizontal_type)
7040 struct window *w
7041 = set_window_scroll_bars (decode_live_window (window),
7042 width, vertical_type, height, horizontal_type);
7043 return w ? (apply_window_adjustment (w), Qt) : Qnil;
7047 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
7048 0, 1, 0,
7049 doc: /* Get width and type of scroll bars of window WINDOW.
7050 WINDOW must be a live window and defaults to the selected one.
7052 Value is a list of the form (WIDTH COLUMNS VERTICAL-TYPE HEIGHT LINES
7053 HORIZONTAL-TYPE). If WIDTH or HEIGHT is nil or VERTICAL-TYPE or
7054 HORIZONTAL-TYPE is t, the window is using the frame's corresponding
7055 value. */)
7056 (Lisp_Object window)
7058 struct window *w = decode_live_window (window);
7060 return Fcons (((w->scroll_bar_width >= 0)
7061 ? make_number (w->scroll_bar_width)
7062 : Qnil),
7063 list5 (make_number (WINDOW_SCROLL_BAR_COLS (w)),
7064 w->vertical_scroll_bar_type,
7065 ((w->scroll_bar_height >= 0)
7066 ? make_number (w->scroll_bar_height)
7067 : Qnil),
7068 make_number (WINDOW_SCROLL_BAR_LINES (w)),
7069 w->horizontal_scroll_bar_type));
7072 /***********************************************************************
7073 Smooth scrolling
7074 ***********************************************************************/
7076 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
7077 doc: /* Return the amount by which WINDOW is scrolled vertically.
7078 If WINDOW is omitted or nil, it defaults to the selected window.
7079 Normally, value is a multiple of the canonical character height of WINDOW;
7080 optional second arg PIXELS-P means value is measured in pixels. */)
7081 (Lisp_Object window, Lisp_Object pixels_p)
7083 Lisp_Object result;
7084 struct window *w = decode_live_window (window);
7085 struct frame *f = XFRAME (w->frame);
7087 if (FRAME_WINDOW_P (f))
7088 result = (NILP (pixels_p)
7089 ? FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll)
7090 : make_number (-w->vscroll));
7091 else
7092 result = make_number (0);
7093 return result;
7097 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
7098 2, 3, 0,
7099 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
7100 WINDOW nil means use the selected window. Normally, VSCROLL is a
7101 non-negative multiple of the canonical character height of WINDOW;
7102 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
7103 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
7104 corresponds to an integral number of pixels. The return value is the
7105 result of this rounding.
7106 If PIXELS-P is non-nil, the return value is VSCROLL. */)
7107 (Lisp_Object window, Lisp_Object vscroll, Lisp_Object pixels_p)
7109 struct window *w = decode_live_window (window);
7110 struct frame *f = XFRAME (w->frame);
7112 CHECK_NUMBER_OR_FLOAT (vscroll);
7114 if (FRAME_WINDOW_P (f))
7116 int old_dy = w->vscroll;
7118 w->vscroll = - (NILP (pixels_p)
7119 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
7120 : XFLOATINT (vscroll));
7121 w->vscroll = min (w->vscroll, 0);
7123 if (w->vscroll != old_dy)
7125 /* Adjust glyph matrix of the frame if the virtual display
7126 area becomes larger than before. */
7127 if (w->vscroll < 0 && w->vscroll < old_dy)
7128 adjust_frame_glyphs (f);
7130 /* Prevent redisplay shortcuts. */
7131 XBUFFER (w->contents)->prevent_redisplay_optimizations_p = true;
7135 return Fwindow_vscroll (window, pixels_p);
7139 /* Call FN for all leaf windows on frame F. FN is called with the
7140 first argument being a pointer to the leaf window, and with
7141 additional argument USER_DATA. Stops when FN returns 0. */
7143 static void
7144 foreach_window (struct frame *f, bool (*fn) (struct window *, void *),
7145 void *user_data)
7147 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
7148 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
7149 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
7153 /* Helper function for foreach_window. Call FN for all leaf windows
7154 reachable from W. FN is called with the first argument being a
7155 pointer to the leaf window, and with additional argument USER_DATA.
7156 Stop when FN returns false. Value is false if stopped by FN. */
7158 static bool
7159 foreach_window_1 (struct window *w, bool (*fn) (struct window *, void *),
7160 void *user_data)
7162 bool cont;
7164 for (cont = true; w && cont;)
7166 if (WINDOWP (w->contents))
7167 cont = foreach_window_1 (XWINDOW (w->contents), fn, user_data);
7168 else
7169 cont = fn (w, user_data);
7171 w = NILP (w->next) ? 0 : XWINDOW (w->next);
7174 return cont;
7177 /***********************************************************************
7178 Initialization
7179 ***********************************************************************/
7181 /* Return true if window configurations CONFIGURATION1 and CONFIGURATION2
7182 describe the same state of affairs. This is used by Fequal.
7184 IGNORE_POSITIONS means ignore non-matching scroll positions
7185 and the like.
7187 This ignores a couple of things like the dedication status of
7188 window, combination_limit and the like. This might have to be
7189 fixed. */
7191 bool
7192 compare_window_configurations (Lisp_Object configuration1,
7193 Lisp_Object configuration2,
7194 bool ignore_positions)
7196 register struct save_window_data *d1, *d2;
7197 struct Lisp_Vector *sws1, *sws2;
7198 ptrdiff_t i;
7200 CHECK_WINDOW_CONFIGURATION (configuration1);
7201 CHECK_WINDOW_CONFIGURATION (configuration2);
7203 d1 = (struct save_window_data *) XVECTOR (configuration1);
7204 d2 = (struct save_window_data *) XVECTOR (configuration2);
7205 sws1 = XVECTOR (d1->saved_windows);
7206 sws2 = XVECTOR (d2->saved_windows);
7208 /* Frame settings must match. */
7209 if (d1->frame_cols != d2->frame_cols
7210 || d1->frame_lines != d2->frame_lines
7211 || d1->frame_menu_bar_lines != d2->frame_menu_bar_lines
7212 || !EQ (d1->selected_frame, d2->selected_frame)
7213 || !EQ (d1->current_buffer, d2->current_buffer)
7214 || (!ignore_positions
7215 && (!EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window)
7216 || !EQ (d1->minibuf_selected_window, d2->minibuf_selected_window)))
7217 || !EQ (d1->focus_frame, d2->focus_frame)
7218 /* Verify that the two configurations have the same number of windows. */
7219 || sws1->header.size != sws2->header.size)
7220 return false;
7222 for (i = 0; i < sws1->header.size; i++)
7224 struct saved_window *sw1, *sw2;
7226 sw1 = SAVED_WINDOW_N (sws1, i);
7227 sw2 = SAVED_WINDOW_N (sws2, i);
7229 if (
7230 /* The "current" windows in the two configurations must
7231 correspond to each other. */
7232 EQ (d1->current_window, sw1->window)
7233 != EQ (d2->current_window, sw2->window)
7234 /* Windows' buffers must match. */
7235 || !EQ (sw1->buffer, sw2->buffer)
7236 || !EQ (sw1->pixel_left, sw2->pixel_left)
7237 || !EQ (sw1->pixel_top, sw2->pixel_top)
7238 || !EQ (sw1->pixel_height, sw2->pixel_height)
7239 || !EQ (sw1->pixel_width, sw2->pixel_width)
7240 || !EQ (sw1->left_col, sw2->left_col)
7241 || !EQ (sw1->top_line, sw2->top_line)
7242 || !EQ (sw1->total_cols, sw2->total_cols)
7243 || !EQ (sw1->total_lines, sw2->total_lines)
7244 || !EQ (sw1->display_table, sw2->display_table)
7245 /* The next two disjuncts check the window structure for
7246 equality. */
7247 || !EQ (sw1->parent, sw2->parent)
7248 || !EQ (sw1->prev, sw2->prev)
7249 || (!ignore_positions
7250 && (!EQ (sw1->hscroll, sw2->hscroll)
7251 || !EQ (sw1->min_hscroll, sw2->min_hscroll)
7252 || !EQ (sw1->start_at_line_beg, sw2->start_at_line_beg)
7253 || NILP (Fequal (sw1->start, sw2->start))
7254 || NILP (Fequal (sw1->pointm, sw2->pointm))))
7255 || !EQ (sw1->left_margin_cols, sw2->left_margin_cols)
7256 || !EQ (sw1->right_margin_cols, sw2->right_margin_cols)
7257 || !EQ (sw1->left_fringe_width, sw2->left_fringe_width)
7258 || !EQ (sw1->right_fringe_width, sw2->right_fringe_width)
7259 || !EQ (sw1->fringes_outside_margins, sw2->fringes_outside_margins)
7260 || !EQ (sw1->scroll_bar_width, sw2->scroll_bar_width)
7261 || !EQ (sw1->scroll_bar_height, sw2->scroll_bar_height)
7262 || !EQ (sw1->vertical_scroll_bar_type, sw2->vertical_scroll_bar_type)
7263 || !EQ (sw1->horizontal_scroll_bar_type, sw2->horizontal_scroll_bar_type))
7264 return false;
7267 return true;
7270 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
7271 Scompare_window_configurations, 2, 2, 0,
7272 doc: /* Compare two window configurations as regards the structure of windows.
7273 This function ignores details such as the values of point
7274 and scrolling positions. */)
7275 (Lisp_Object x, Lisp_Object y)
7277 if (compare_window_configurations (x, y, true))
7278 return Qt;
7279 return Qnil;
7282 void
7283 init_window_once (void)
7285 struct frame *f = make_initial_frame ();
7286 XSETFRAME (selected_frame, f);
7287 Vterminal_frame = selected_frame;
7288 minibuf_window = f->minibuffer_window;
7289 selected_window = f->selected_window;
7292 void
7293 init_window (void)
7295 Vwindow_list = Qnil;
7298 void
7299 syms_of_window (void)
7301 DEFSYM (Qscroll_up, "scroll-up");
7302 DEFSYM (Qscroll_down, "scroll-down");
7303 DEFSYM (Qscroll_command, "scroll-command");
7305 Fput (Qscroll_up, Qscroll_command, Qt);
7306 Fput (Qscroll_down, Qscroll_command, Qt);
7308 DEFSYM (Qwindow_configuration_change_hook, "window-configuration-change-hook");
7309 DEFSYM (Qwindowp, "windowp");
7310 DEFSYM (Qwindow_configuration_p, "window-configuration-p");
7311 DEFSYM (Qwindow_live_p, "window-live-p");
7312 DEFSYM (Qwindow_valid_p, "window-valid-p");
7313 DEFSYM (Qwindow_deletable_p, "window-deletable-p");
7314 DEFSYM (Qdelete_window, "delete-window");
7315 DEFSYM (Qwindow__resize_root_window, "window--resize-root-window");
7316 DEFSYM (Qwindow__resize_root_window_vertically,
7317 "window--resize-root-window-vertically");
7318 DEFSYM (Qwindow__sanitize_window_sizes, "window--sanitize-window-sizes");
7319 DEFSYM (Qwindow__pixel_to_total, "window--pixel-to-total");
7320 DEFSYM (Qsafe, "safe");
7321 DEFSYM (Qdisplay_buffer, "display-buffer");
7322 DEFSYM (Qreplace_buffer_in_windows, "replace-buffer-in-windows");
7323 DEFSYM (Qrecord_window_buffer, "record-window-buffer");
7324 DEFSYM (Qget_mru_window, "get-mru-window");
7325 DEFSYM (Qwindow_size, "window-size");
7326 DEFSYM (Qtemp_buffer_show_hook, "temp-buffer-show-hook");
7327 DEFSYM (Qabove, "above");
7328 DEFSYM (Qclone_of, "clone-of");
7329 DEFSYM (Qfloor, "floor");
7330 DEFSYM (Qceiling, "ceiling");
7332 staticpro (&Vwindow_list);
7334 minibuf_selected_window = Qnil;
7335 staticpro (&minibuf_selected_window);
7337 window_scroll_pixel_based_preserve_x = -1;
7338 window_scroll_pixel_based_preserve_y = -1;
7339 window_scroll_preserve_hpos = -1;
7340 window_scroll_preserve_vpos = -1;
7342 DEFVAR_LISP ("temp-buffer-show-function", Vtemp_buffer_show_function,
7343 doc: /* Non-nil means call as function to display a help buffer.
7344 The function is called with one argument, the buffer to be displayed.
7345 Used by `with-output-to-temp-buffer'.
7346 If this function is used, then it must do the entire job of showing
7347 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
7348 Vtemp_buffer_show_function = Qnil;
7350 DEFVAR_LISP ("minibuffer-scroll-window", Vminibuf_scroll_window,
7351 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
7352 Vminibuf_scroll_window = Qnil;
7354 DEFVAR_BOOL ("mode-line-in-non-selected-windows", mode_line_in_non_selected_windows,
7355 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
7356 If the minibuffer is active, the `minibuffer-scroll-window' mode line
7357 is displayed in the `mode-line' face. */);
7358 mode_line_in_non_selected_windows = true;
7360 DEFVAR_LISP ("other-window-scroll-buffer", Vother_window_scroll_buffer,
7361 doc: /* If this is a live buffer, \\[scroll-other-window] should scroll its window. */);
7362 Vother_window_scroll_buffer = Qnil;
7364 DEFVAR_BOOL ("auto-window-vscroll", auto_window_vscroll_p,
7365 doc: /* Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
7366 auto_window_vscroll_p = true;
7368 DEFVAR_INT ("next-screen-context-lines", next_screen_context_lines,
7369 doc: /* Number of lines of continuity when scrolling by screenfuls. */);
7370 next_screen_context_lines = 2;
7372 DEFVAR_LISP ("scroll-preserve-screen-position",
7373 Vscroll_preserve_screen_position,
7374 doc: /* Controls if scroll commands move point to keep its screen position unchanged.
7375 A value of nil means point does not keep its screen position except
7376 at the scroll margin or window boundary respectively.
7377 A value of t means point keeps its screen position if the scroll
7378 command moved it vertically out of the window, e.g. when scrolling
7379 by full screens.
7380 Any other value means point always keeps its screen position.
7381 Scroll commands should have the `scroll-command' property
7382 on their symbols to be controlled by this variable. */);
7383 Vscroll_preserve_screen_position = Qnil;
7385 DEFVAR_LISP ("window-point-insertion-type", Vwindow_point_insertion_type,
7386 doc: /* Type of marker to use for `window-point'. */);
7387 Vwindow_point_insertion_type = Qnil;
7388 DEFSYM (Qwindow_point_insertion_type, "window_point_insertion_type");
7390 DEFVAR_LISP ("window-configuration-change-hook",
7391 Vwindow_configuration_change_hook,
7392 doc: /* Functions to call when window configuration changes.
7393 The buffer-local part is run once per window, with the relevant window
7394 selected; while the global part is run only once for the modified frame,
7395 with the relevant frame selected. */);
7396 Vwindow_configuration_change_hook = Qnil;
7398 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions,
7399 doc: /* Functions called during redisplay, if window sizes have changed.
7400 The value should be a list of functions that take one argument.
7401 During the first part of redisplay, for each frame, if any of its windows
7402 have changed size since the last redisplay, or have been split or deleted,
7403 all the functions in the list are called, with the frame as argument.
7404 If redisplay decides to resize the minibuffer window, it calls these
7405 functions on behalf of that as well. */);
7406 Vwindow_size_change_functions = Qnil;
7408 DEFVAR_LISP ("recenter-redisplay", Vrecenter_redisplay,
7409 doc: /* Non-nil means `recenter' redraws entire frame.
7410 If this option is non-nil, then the `recenter' command with a nil
7411 argument will redraw the entire frame; the special value `tty' causes
7412 the frame to be redrawn only if it is a tty frame. */);
7413 Vrecenter_redisplay = Qtty;
7415 DEFVAR_LISP ("window-combination-resize", Vwindow_combination_resize,
7416 doc: /* If t, resize window combinations proportionally.
7417 If this variable is nil, splitting a window gets the entire screen space
7418 for displaying the new window from the window to split. Deleting and
7419 resizing a window preferably resizes one adjacent window only.
7421 If this variable is t, splitting a window tries to get the space
7422 proportionally from all windows in the same combination. This also
7423 allows splitting a window that is otherwise too small or of fixed size.
7424 Resizing and deleting a window proportionally resize all windows in the
7425 same combination.
7427 Other values are reserved for future use.
7429 This variable takes no effect if the variable `window-combination-limit' is
7430 non-nil. */);
7431 Vwindow_combination_resize = Qnil;
7433 DEFVAR_LISP ("window-combination-limit", Vwindow_combination_limit,
7434 doc: /* If non-nil, splitting a window makes a new parent window.
7435 The following values are recognized:
7437 nil means splitting a window will create a new parent window only if the
7438 window has no parent window or the window shall become part of a
7439 combination orthogonal to the one it is part of.
7441 `window-size' means that splitting a window for displaying a buffer
7442 makes a new parent window provided `display-buffer' is supposed to
7443 explicitly set the window's size due to the presence of a
7444 `window-height' or `window-width' entry in the alist used by
7445 `display-buffer'. Otherwise, this value is handled like nil.
7447 `temp-buffer' means that splitting a window for displaying a temporary
7448 buffer always makes a new parent window. Otherwise, this value is
7449 handled like nil.
7451 `display-buffer' means that splitting a window for displaying a buffer
7452 always makes a new parent window. Since temporary buffers are
7453 displayed by the function `display-buffer', this value is stronger
7454 than `temp-buffer'. Splitting a window for other purpose makes a
7455 new parent window only if needed.
7457 t means that splitting a window always creates a new parent window. If
7458 all splits behave this way, each frame's window tree is a binary
7459 tree and every window but the frame's root window has exactly one
7460 sibling.
7462 Other values are reserved for future use. */);
7463 Vwindow_combination_limit = Qwindow_size;
7465 DEFVAR_LISP ("window-persistent-parameters", Vwindow_persistent_parameters,
7466 doc: /* Alist of persistent window parameters.
7467 This alist specifies which window parameters shall get saved by
7468 `current-window-configuration' and `window-state-get' and subsequently
7469 restored to their previous values by `set-window-configuration' and
7470 `window-state-put'.
7472 The car of each entry of this alist is the symbol specifying the
7473 parameter. The cdr is one of the following:
7475 nil means the parameter is neither saved by `window-state-get' nor by
7476 `current-window-configuration'.
7478 t means the parameter is saved by `current-window-configuration' and,
7479 provided its WRITABLE argument is nil, by `window-state-get'.
7481 The symbol `writable' means the parameter is saved unconditionally by
7482 both `current-window-configuration' and `window-state-get'. Do not use
7483 this value for parameters without read syntax (like windows or frames).
7485 Parameters not saved by `current-window-configuration' or
7486 `window-state-get' are left alone by `set-window-configuration'
7487 respectively are not installed by `window-state-put'. */);
7488 Vwindow_persistent_parameters = list1 (Fcons (Qclone_of, Qt));
7490 DEFVAR_BOOL ("window-resize-pixelwise", window_resize_pixelwise,
7491 doc: /* Non-nil means resize windows pixelwise.
7492 This currently affects the functions: `split-window', `maximize-window',
7493 `minimize-window', `fit-window-to-buffer' and `fit-frame-to-buffer', and
7494 all functions that symmetrically resize a parent window.
7496 Note that when a frame's pixel size is not a multiple of the
7497 frame's character size, at least one window may get resized
7498 pixelwise even if this option is nil. */);
7499 window_resize_pixelwise = false;
7501 DEFVAR_BOOL ("fast-but-imprecise-scrolling",
7502 Vfast_but_imprecise_scrolling,
7503 doc: /* When non-nil, accelerate scrolling operations.
7504 This comes into play when scrolling rapidly over previously
7505 unfontified buffer regions. Only those portions of the buffer which
7506 are actually going to be displayed get fontified.
7508 Note that this optimization can cause the portion of the buffer
7509 displayed after a scrolling operation to be somewhat inaccurate. */);
7510 Vfast_but_imprecise_scrolling = false;
7512 defsubr (&Sselected_window);
7513 defsubr (&Sminibuffer_window);
7514 defsubr (&Swindow_minibuffer_p);
7515 defsubr (&Swindowp);
7516 defsubr (&Swindow_valid_p);
7517 defsubr (&Swindow_live_p);
7518 defsubr (&Swindow_frame);
7519 defsubr (&Sframe_root_window);
7520 defsubr (&Sframe_first_window);
7521 defsubr (&Sframe_selected_window);
7522 defsubr (&Sset_frame_selected_window);
7523 defsubr (&Spos_visible_in_window_p);
7524 defsubr (&Swindow_line_height);
7525 defsubr (&Swindow_buffer);
7526 defsubr (&Swindow_parent);
7527 defsubr (&Swindow_top_child);
7528 defsubr (&Swindow_left_child);
7529 defsubr (&Swindow_next_sibling);
7530 defsubr (&Swindow_prev_sibling);
7531 defsubr (&Swindow_combination_limit);
7532 defsubr (&Sset_window_combination_limit);
7533 defsubr (&Swindow_use_time);
7534 defsubr (&Swindow_pixel_width);
7535 defsubr (&Swindow_pixel_height);
7536 defsubr (&Swindow_pixel_width_before_size_change);
7537 defsubr (&Swindow_pixel_height_before_size_change);
7538 defsubr (&Swindow_total_width);
7539 defsubr (&Swindow_total_height);
7540 defsubr (&Swindow_normal_size);
7541 defsubr (&Swindow_new_pixel);
7542 defsubr (&Swindow_new_total);
7543 defsubr (&Swindow_new_normal);
7544 defsubr (&Swindow_pixel_left);
7545 defsubr (&Swindow_pixel_top);
7546 defsubr (&Swindow_left_column);
7547 defsubr (&Swindow_top_line);
7548 defsubr (&Sset_window_new_pixel);
7549 defsubr (&Sset_window_new_total);
7550 defsubr (&Sset_window_new_normal);
7551 defsubr (&Swindow_resize_apply);
7552 defsubr (&Swindow_resize_apply_total);
7553 defsubr (&Swindow_body_height);
7554 defsubr (&Swindow_body_width);
7555 defsubr (&Swindow_hscroll);
7556 defsubr (&Sset_window_hscroll);
7557 defsubr (&Swindow_redisplay_end_trigger);
7558 defsubr (&Sset_window_redisplay_end_trigger);
7559 defsubr (&Swindow_mode_line_height);
7560 defsubr (&Swindow_header_line_height);
7561 defsubr (&Swindow_right_divider_width);
7562 defsubr (&Swindow_bottom_divider_width);
7563 defsubr (&Swindow_scroll_bar_width);
7564 defsubr (&Swindow_scroll_bar_height);
7565 defsubr (&Scoordinates_in_window_p);
7566 defsubr (&Swindow_at);
7567 defsubr (&Swindow_point);
7568 defsubr (&Swindow_old_point);
7569 defsubr (&Swindow_start);
7570 defsubr (&Swindow_end);
7571 defsubr (&Sset_window_point);
7572 defsubr (&Sset_window_start);
7573 defsubr (&Swindow_dedicated_p);
7574 defsubr (&Sset_window_dedicated_p);
7575 defsubr (&Swindow_display_table);
7576 defsubr (&Sset_window_display_table);
7577 defsubr (&Snext_window);
7578 defsubr (&Sprevious_window);
7579 defsubr (&Swindow__sanitize_window_sizes);
7580 defsubr (&Sget_buffer_window);
7581 defsubr (&Sdelete_other_windows_internal);
7582 defsubr (&Sdelete_window_internal);
7583 defsubr (&Sresize_mini_window_internal);
7584 defsubr (&Sset_window_buffer);
7585 defsubr (&Srun_window_configuration_change_hook);
7586 defsubr (&Srun_window_scroll_functions);
7587 defsubr (&Sselect_window);
7588 defsubr (&Sforce_window_update);
7589 defsubr (&Ssplit_window_internal);
7590 defsubr (&Sscroll_up);
7591 defsubr (&Sscroll_down);
7592 defsubr (&Sscroll_left);
7593 defsubr (&Sscroll_right);
7594 defsubr (&Sother_window_for_scrolling);
7595 defsubr (&Sscroll_other_window);
7596 defsubr (&Sminibuffer_selected_window);
7597 defsubr (&Srecenter);
7598 defsubr (&Swindow_text_width);
7599 defsubr (&Swindow_text_height);
7600 defsubr (&Smove_to_window_line);
7601 defsubr (&Swindow_configuration_p);
7602 defsubr (&Swindow_configuration_frame);
7603 defsubr (&Sset_window_configuration);
7604 defsubr (&Scurrent_window_configuration);
7605 defsubr (&Sset_window_margins);
7606 defsubr (&Swindow_margins);
7607 defsubr (&Sset_window_fringes);
7608 defsubr (&Swindow_fringes);
7609 defsubr (&Sset_window_scroll_bars);
7610 defsubr (&Swindow_scroll_bars);
7611 defsubr (&Swindow_vscroll);
7612 defsubr (&Sset_window_vscroll);
7613 defsubr (&Scompare_window_configurations);
7614 defsubr (&Swindow_list);
7615 defsubr (&Swindow_list_1);
7616 defsubr (&Swindow_prev_buffers);
7617 defsubr (&Sset_window_prev_buffers);
7618 defsubr (&Swindow_next_buffers);
7619 defsubr (&Sset_window_next_buffers);
7620 defsubr (&Swindow_parameters);
7621 defsubr (&Swindow_parameter);
7622 defsubr (&Sset_window_parameter);
7625 void
7626 keys_of_window (void)
7628 initial_define_key (control_x_map, '<', "scroll-left");
7629 initial_define_key (control_x_map, '>', "scroll-right");
7631 initial_define_key (global_map, Ctl ('V'), "scroll-up-command");
7632 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
7633 initial_define_key (meta_map, 'v', "scroll-down-command");