1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985-1987, 1993-1998, 2000-2015 Free Software
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
26 #include "character.h"
37 #include "dispextern.h"
38 #include "blockinput.h"
39 #include "intervals.h"
40 #include "termhooks.h" /* For FRAME_TERMINAL. */
41 #ifdef HAVE_WINDOW_SYSTEM
43 #endif /* HAVE_WINDOW_SYSTEM */
48 static int displayed_window_lines (struct window
*);
49 static int count_windows (struct window
*);
50 static int get_leaf_windows (struct window
*, struct window
**, int);
51 static void window_scroll (Lisp_Object
, EMACS_INT
, bool, int);
52 static void window_scroll_pixel_based (Lisp_Object
, int, bool, int);
53 static void window_scroll_line_based (Lisp_Object
, int, bool, int);
54 static int add_window_to_list (struct window
*, void *);
55 static Lisp_Object
next_window (Lisp_Object
, Lisp_Object
,
57 static void decode_next_window_args (Lisp_Object
*, Lisp_Object
*,
59 static void foreach_window (struct frame
*,
60 int (* fn
) (struct window
*, void *),
62 static int foreach_window_1 (struct window
*,
63 int (* fn
) (struct window
*, void *),
65 static Lisp_Object
window_list_1 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
66 static int window_resize_check (struct window
*, bool);
67 static void window_resize_apply (struct window
*, bool);
68 static void window_resize_apply_total (struct window
*, bool);
69 static Lisp_Object
select_window (Lisp_Object
, Lisp_Object
, int);
70 static void select_window_1 (Lisp_Object
, bool);
72 static struct window
*set_window_fringes (struct window
*, Lisp_Object
,
73 Lisp_Object
, Lisp_Object
);
74 static struct window
*set_window_margins (struct window
*, Lisp_Object
,
76 static struct window
*set_window_scroll_bars (struct window
*, Lisp_Object
,
77 Lisp_Object
, Lisp_Object
, Lisp_Object
);
78 static void apply_window_adjustment (struct window
*);
80 /* This is the window in which the terminal's cursor should
81 be left when nothing is being done with it. This must
82 always be a leaf window, and its buffer is selected by
83 the top level editing loop at the end of each command.
85 This value is always the same as
86 FRAME_SELECTED_WINDOW (selected_frame). */
87 Lisp_Object selected_window
;
89 /* A list of all windows for use by next_window and Fwindow_list.
90 Functions creating or deleting windows should invalidate this cache
91 by setting it to nil. */
92 Lisp_Object Vwindow_list
;
94 /* The mini-buffer window of the selected frame.
95 Note that you cannot test for mini-bufferness of an arbitrary window
96 by comparing against this; but you can test for mini-bufferness of
97 the selected window. */
98 Lisp_Object minibuf_window
;
100 /* Non-nil means it is the window whose mode line should be
101 shown as the selected window when the minibuffer is selected. */
102 Lisp_Object minibuf_selected_window
;
104 /* Incremented for each window created. */
105 static int sequence_number
;
107 /* Used by the function window_scroll_pixel_based. */
108 static int window_scroll_pixel_based_preserve_x
;
109 static int window_scroll_pixel_based_preserve_y
;
111 /* Same for window_scroll_line_based. */
112 static EMACS_INT window_scroll_preserve_hpos
;
113 static EMACS_INT window_scroll_preserve_vpos
;
116 CHECK_WINDOW_CONFIGURATION (Lisp_Object x
)
118 CHECK_TYPE (WINDOW_CONFIGURATIONP (x
), Qwindow_configuration_p
, x
);
121 /* These setters are used only in this file, so they can be private. */
123 wset_combination_limit (struct window
*w
, Lisp_Object val
)
125 w
->combination_limit
= val
;
129 wset_dedicated (struct window
*w
, Lisp_Object val
)
135 wset_display_table (struct window
*w
, Lisp_Object val
)
137 w
->display_table
= val
;
141 wset_new_normal (struct window
*w
, Lisp_Object val
)
147 wset_new_total (struct window
*w
, Lisp_Object val
)
153 wset_normal_cols (struct window
*w
, Lisp_Object val
)
155 w
->normal_cols
= val
;
159 wset_normal_lines (struct window
*w
, Lisp_Object val
)
161 w
->normal_lines
= val
;
165 wset_parent (struct window
*w
, Lisp_Object val
)
171 wset_pointm (struct window
*w
, Lisp_Object val
)
177 wset_old_pointm (struct window
*w
, Lisp_Object val
)
183 wset_start (struct window
*w
, Lisp_Object val
)
189 wset_temslot (struct window
*w
, Lisp_Object val
)
195 wset_vertical_scroll_bar_type (struct window
*w
, Lisp_Object val
)
197 w
->vertical_scroll_bar_type
= val
;
201 wset_window_parameters (struct window
*w
, Lisp_Object val
)
203 w
->window_parameters
= val
;
207 wset_combination (struct window
*w
, bool horflag
, Lisp_Object val
)
209 /* Since leaf windows never becomes non-leaf, there should
210 be no buffer and markers in start and pointm fields of W. */
211 eassert (!BUFFERP (w
->contents
) && NILP (w
->start
) && NILP (w
->pointm
));
213 /* When an internal window is deleted and VAL is nil, HORFLAG
216 w
->horizontal
= horflag
;
219 /* Nonzero if leaf window W doesn't reflect the actual state
220 of displayed buffer due to its text or overlays change. */
223 window_outdated (struct window
*w
)
225 struct buffer
*b
= XBUFFER (w
->contents
);
226 return (w
->last_modified
< BUF_MODIFF (b
)
227 || w
->last_overlay_modified
< BUF_OVERLAY_MODIFF (b
));
231 decode_live_window (register Lisp_Object window
)
234 return XWINDOW (selected_window
);
236 CHECK_LIVE_WINDOW (window
);
237 return XWINDOW (window
);
241 decode_any_window (register Lisp_Object window
)
246 return XWINDOW (selected_window
);
248 CHECK_WINDOW (window
);
249 w
= XWINDOW (window
);
253 static struct window
*
254 decode_valid_window (register Lisp_Object window
)
259 return XWINDOW (selected_window
);
261 CHECK_VALID_WINDOW (window
);
262 w
= XWINDOW (window
);
266 /* Called when W's buffer slot is changed. ARG -1 means that W is about to
267 cease its buffer, and 1 means that W is about to set up the new one. */
270 adjust_window_count (struct window
*w
, int arg
)
272 eassert (eabs (arg
) == 1);
273 if (BUFFERP (w
->contents
))
275 struct buffer
*b
= XBUFFER (w
->contents
);
279 b
->window_count
+= arg
;
280 eassert (b
->window_count
>= 0);
281 /* These should be recalculated by redisplay code. */
282 w
->window_end_valid
= 0;
283 w
->base_line_pos
= 0;
287 /* Set W's buffer slot to VAL and recompute number
288 of windows showing VAL if it is a buffer. */
291 wset_buffer (struct window
*w
, Lisp_Object val
)
293 adjust_window_count (w
, -1);
295 /* Make sure that we do not assign the buffer
296 to an internal window. */
297 eassert (MARKERP (w
->start
) && MARKERP (w
->pointm
));
299 adjust_window_count (w
, 1);
302 DEFUN ("windowp", Fwindowp
, Swindowp
, 1, 1, 0,
303 doc
: /* Return t if OBJECT is a window and nil otherwise. */)
306 return WINDOWP (object
) ? Qt
: Qnil
;
309 DEFUN ("window-valid-p", Fwindow_valid_p
, Swindow_valid_p
, 1, 1, 0,
310 doc
: /* Return t if OBJECT is a valid window and nil otherwise.
311 A valid window is either a window that displays a buffer or an internal
312 window. Windows that have been deleted are not valid. */)
315 return WINDOW_VALID_P (object
) ? Qt
: Qnil
;
318 DEFUN ("window-live-p", Fwindow_live_p
, Swindow_live_p
, 1, 1, 0,
319 doc
: /* Return t if OBJECT is a live window and nil otherwise.
320 A live window is a window that displays a buffer.
321 Internal windows and deleted windows are not live. */)
324 return WINDOW_LIVE_P (object
) ? Qt
: Qnil
;
327 /* Frames and windows. */
328 DEFUN ("window-frame", Fwindow_frame
, Swindow_frame
, 0, 1, 0,
329 doc
: /* Return the frame that window WINDOW is on.
330 WINDOW must be a valid window and defaults to the selected one. */)
333 return decode_valid_window (window
)->frame
;
336 DEFUN ("frame-root-window", Fframe_root_window
, Sframe_root_window
, 0, 1, 0,
337 doc
: /* Return the root window of FRAME-OR-WINDOW.
338 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
339 With a frame argument, return that frame's root window.
340 With a window argument, return the root window of that window's frame. */)
341 (Lisp_Object frame_or_window
)
345 if (NILP (frame_or_window
))
346 window
= SELECTED_FRAME ()->root_window
;
347 else if (WINDOW_VALID_P (frame_or_window
))
348 window
= XFRAME (XWINDOW (frame_or_window
)->frame
)->root_window
;
351 CHECK_LIVE_FRAME (frame_or_window
);
352 window
= XFRAME (frame_or_window
)->root_window
;
358 DEFUN ("minibuffer-window", Fminibuffer_window
, Sminibuffer_window
, 0, 1, 0,
359 doc
: /* Return the minibuffer window for frame FRAME.
360 If FRAME is omitted or nil, it defaults to the selected frame. */)
363 return FRAME_MINIBUF_WINDOW (decode_live_frame (frame
));
366 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p
,
367 Swindow_minibuffer_p
, 0, 1, 0,
368 doc
: /* Return non-nil if WINDOW is a minibuffer window.
369 WINDOW must be a valid window and defaults to the selected one. */)
372 return MINI_WINDOW_P (decode_valid_window (window
)) ? Qt
: Qnil
;
375 /* Don't move this to window.el - this must be a safe routine. */
376 DEFUN ("frame-first-window", Fframe_first_window
, Sframe_first_window
, 0, 1, 0,
377 doc
: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
378 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
379 Else if FRAME-OR-WINDOW denotes a valid window, return the first window
380 of that window's frame. If FRAME-OR-WINDOW denotes a live frame, return
381 the first window of that frame. */)
382 (Lisp_Object frame_or_window
)
386 if (NILP (frame_or_window
))
387 window
= SELECTED_FRAME ()->root_window
;
388 else if (WINDOW_VALID_P (frame_or_window
))
389 window
= XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window
)))->root_window
;
392 CHECK_LIVE_FRAME (frame_or_window
);
393 window
= XFRAME (frame_or_window
)->root_window
;
396 while (WINDOWP (XWINDOW (window
)->contents
))
397 window
= XWINDOW (window
)->contents
;
402 DEFUN ("frame-selected-window", Fframe_selected_window
,
403 Sframe_selected_window
, 0, 1, 0,
404 doc
: /* Return the selected window of FRAME-OR-WINDOW.
405 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
406 Else if FRAME-OR-WINDOW denotes a valid window, return the selected
407 window of that window's frame. If FRAME-OR-WINDOW denotes a live frame,
408 return the selected window of that frame. */)
409 (Lisp_Object frame_or_window
)
413 if (NILP (frame_or_window
))
414 window
= SELECTED_FRAME ()->selected_window
;
415 else if (WINDOW_VALID_P (frame_or_window
))
416 window
= XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window
)))->selected_window
;
419 CHECK_LIVE_FRAME (frame_or_window
);
420 window
= XFRAME (frame_or_window
)->selected_window
;
426 DEFUN ("set-frame-selected-window", Fset_frame_selected_window
,
427 Sset_frame_selected_window
, 2, 3, 0,
428 doc
: /* Set selected window of FRAME to WINDOW.
429 FRAME must be a live frame and defaults to the selected one. If FRAME
430 is the selected frame, this makes WINDOW the selected window. Optional
431 argument NORECORD non-nil means to neither change the order of recently
432 selected windows nor the buffer list. WINDOW must denote a live window.
434 (Lisp_Object frame
, Lisp_Object window
, Lisp_Object norecord
)
437 frame
= selected_frame
;
439 CHECK_LIVE_FRAME (frame
);
440 CHECK_LIVE_WINDOW (window
);
442 if (! EQ (frame
, WINDOW_FRAME (XWINDOW (window
))))
443 error ("In `set-frame-selected-window', WINDOW is not on FRAME");
445 if (EQ (frame
, selected_frame
))
446 return Fselect_window (window
, norecord
);
449 fset_selected_window (XFRAME (frame
), window
);
454 DEFUN ("selected-window", Fselected_window
, Sselected_window
, 0, 0, 0,
455 doc
: /* Return the selected window.
456 The selected window is the window in which the standard cursor for
457 selected windows appears and to which many commands apply. */)
460 return selected_window
;
463 int window_select_count
;
465 /* If select_window is called with inhibit_point_swap non-zero it will
466 not store point of the old selected window's buffer back into that
467 window's pointm slot. This is needed by Fset_window_configuration to
468 avoid that the display routine is called with selected_window set to
469 Qnil causing a subsequent crash. */
471 select_window (Lisp_Object window
, Lisp_Object norecord
, int inhibit_point_swap
)
473 register struct window
*w
;
476 CHECK_LIVE_WINDOW (window
);
478 w
= XWINDOW (window
);
480 /* Make the selected window's buffer current. */
481 Fset_buffer (w
->contents
);
483 if (EQ (window
, selected_window
) && !inhibit_point_swap
)
484 /* `switch-to-buffer' uses (select-window (selected-window)) as a "clever"
485 way to call record_buffer from Elisp, so it's important that we call
486 record_buffer before returning here. */
487 goto record_and_return
;
490 { /* Mark the window for redisplay since the selected-window has
491 a different mode-line. */
492 wset_redisplay (XWINDOW (selected_window
));
496 redisplay_other_windows ();
498 sf
= SELECTED_FRAME ();
499 if (XFRAME (WINDOW_FRAME (w
)) != sf
)
501 fset_selected_window (XFRAME (WINDOW_FRAME (w
)), window
);
502 /* Use this rather than Fhandle_switch_frame
503 so that FRAME_FOCUS_FRAME is moved appropriately as we
504 move around in the state where a minibuffer in a separate
506 Fselect_frame (WINDOW_FRAME (w
), norecord
);
507 /* Fselect_frame called us back so we've done all the work already. */
508 eassert (EQ (window
, selected_window
));
512 fset_selected_window (sf
, window
);
514 select_window_1 (window
, inhibit_point_swap
);
515 bset_last_selected_window (XBUFFER (w
->contents
), window
);
518 /* record_buffer can run QUIT, so make sure it is run only after we have
519 re-established the invariant between selected_window and selected_frame,
520 otherwise the temporary broken invariant might "escape" (bug#14161). */
523 w
->use_time
= ++window_select_count
;
524 record_buffer (w
->contents
);
530 /* Select window with a minimum of fuss, i.e. don't record the change anywhere
531 (not even for redisplay's benefit), and assume that the window's frame is
534 select_window_1 (Lisp_Object window
, bool inhibit_point_swap
)
536 /* Store the old selected window's buffer's point in pointm of the old
537 selected window. It belongs to that window, and when the window is
538 not selected, must be in the window. */
539 if (!inhibit_point_swap
)
541 struct window
*ow
= XWINDOW (selected_window
);
542 if (BUFFERP (ow
->contents
))
543 set_marker_both (ow
->pointm
, ow
->contents
,
544 BUF_PT (XBUFFER (ow
->contents
)),
545 BUF_PT_BYTE (XBUFFER (ow
->contents
)));
548 selected_window
= window
;
550 /* Go to the point recorded in the window.
551 This is important when the buffer is in more
552 than one window. It also matters when
553 redisplay_window has altered point after scrolling,
554 because it makes the change only in the window. */
555 set_point_from_marker (XWINDOW (window
)->pointm
);
558 DEFUN ("select-window", Fselect_window
, Sselect_window
, 1, 2, 0,
559 doc
: /* Select WINDOW which must be a live window.
560 Also make WINDOW's frame the selected frame and WINDOW that frame's
561 selected window. In addition, make WINDOW's buffer current and set its
562 buffer's value of `point' to the value of WINDOW's `window-point'.
565 Optional second arg NORECORD non-nil means do not put this buffer at the
566 front of the buffer list and do not make this window the most recently
569 Run `buffer-list-update-hook' unless NORECORD is non-nil. Note that
570 applications and internal routines often select a window temporarily for
571 various purposes; mostly, to simplify coding. As a rule, such
572 selections should be not recorded and therefore will not pollute
573 `buffer-list-update-hook'. Selections that "really count" are those
574 causing a visible change in the next redisplay of WINDOW's frame and
575 should be always recorded. So if you think of running a function each
576 time a window gets selected put it on `buffer-list-update-hook'.
578 Also note that the main editor command loop sets the current buffer to
579 the buffer of the selected window before each command. */)
580 (register Lisp_Object window
, Lisp_Object norecord
)
582 return select_window (window
, norecord
, 0);
585 DEFUN ("window-buffer", Fwindow_buffer
, Swindow_buffer
, 0, 1, 0,
586 doc
: /* Return the buffer displayed in window WINDOW.
587 If WINDOW is omitted or nil, it defaults to the selected window.
588 Return nil for an internal window or a deleted window. */)
591 struct window
*w
= decode_any_window (window
);
592 return WINDOW_LEAF_P (w
) ? w
->contents
: Qnil
;
595 DEFUN ("window-parent", Fwindow_parent
, Swindow_parent
, 0, 1, 0,
596 doc
: /* Return the parent window of window WINDOW.
597 WINDOW must be a valid window and defaults to the selected one.
598 Return nil for a window with no parent (e.g. a root window). */)
601 return decode_valid_window (window
)->parent
;
604 DEFUN ("window-top-child", Fwindow_top_child
, Swindow_top_child
, 0, 1, 0,
605 doc
: /* Return the topmost child window of window WINDOW.
606 WINDOW must be a valid window and defaults to the selected one.
607 Return nil if WINDOW is a live window (live windows have no children).
608 Return nil if WINDOW is an internal window whose children form a
609 horizontal combination. */)
612 struct window
*w
= decode_valid_window (window
);
613 return WINDOW_VERTICAL_COMBINATION_P (w
) ? w
->contents
: Qnil
;
616 DEFUN ("window-left-child", Fwindow_left_child
, Swindow_left_child
, 0, 1, 0,
617 doc
: /* Return the leftmost child window of window WINDOW.
618 WINDOW must be a valid window and defaults to the selected one.
619 Return nil if WINDOW is a live window (live windows have no children).
620 Return nil if WINDOW is an internal window whose children form a
621 vertical combination. */)
624 struct window
*w
= decode_valid_window (window
);
625 return WINDOW_HORIZONTAL_COMBINATION_P (w
) ? w
->contents
: Qnil
;
628 DEFUN ("window-next-sibling", Fwindow_next_sibling
, Swindow_next_sibling
, 0, 1, 0,
629 doc
: /* Return the next sibling window of window WINDOW.
630 WINDOW must be a valid window and defaults to the selected one.
631 Return nil if WINDOW has no next sibling. */)
634 return decode_valid_window (window
)->next
;
637 DEFUN ("window-prev-sibling", Fwindow_prev_sibling
, Swindow_prev_sibling
, 0, 1, 0,
638 doc
: /* Return the previous sibling window of window WINDOW.
639 WINDOW must be a valid window and defaults to the selected one.
640 Return nil if WINDOW has no previous sibling. */)
643 return decode_valid_window (window
)->prev
;
646 DEFUN ("window-combination-limit", Fwindow_combination_limit
, Swindow_combination_limit
, 1, 1, 0,
647 doc
: /* Return combination limit of window WINDOW.
648 WINDOW must be a valid window used in horizontal or vertical combination.
649 If the return value is nil, child windows of WINDOW can be recombined with
650 WINDOW's siblings. A return value of t means that child windows of
651 WINDOW are never \(re-)combined with WINDOW's siblings. */)
656 CHECK_VALID_WINDOW (window
);
657 w
= XWINDOW (window
);
658 if (WINDOW_LEAF_P (w
))
659 error ("Combination limit is meaningful for internal windows only");
660 return w
->combination_limit
;
663 DEFUN ("set-window-combination-limit", Fset_window_combination_limit
, Sset_window_combination_limit
, 2, 2, 0,
664 doc
: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
665 WINDOW must be a valid window used in horizontal or vertical combination.
666 If LIMIT is nil, child windows of WINDOW can be recombined with WINDOW's
667 siblings. LIMIT t means that child windows of WINDOW are never
668 \(re-)combined with WINDOW's siblings. Other values are reserved for
670 (Lisp_Object window
, Lisp_Object limit
)
674 CHECK_VALID_WINDOW (window
);
675 w
= XWINDOW (window
);
676 if (WINDOW_LEAF_P (w
))
677 error ("Combination limit is meaningful for internal windows only");
678 wset_combination_limit (w
, limit
);
682 DEFUN ("window-use-time", Fwindow_use_time
, Swindow_use_time
, 0, 1, 0,
683 doc
: /* Return the use time of window WINDOW.
684 WINDOW must be a live window and defaults to the selected one.
685 The window with the highest use time is the most recently selected
686 one. The window with the lowest use time is the least recently
690 return make_number (decode_live_window (window
)->use_time
);
693 DEFUN ("window-pixel-width", Fwindow_pixel_width
, Swindow_pixel_width
, 0, 1, 0,
694 doc
: /* Return the width of window WINDOW in pixels.
695 WINDOW must be a valid window and defaults to the selected one.
697 The return value includes the fringes and margins of WINDOW as well as
698 any vertical dividers or scroll bars belonging to WINDOW. If WINDOW is
699 an internal window, its pixel width is the width of the screen areas
700 spanned by its children. */)
703 return make_number (decode_valid_window (window
)->pixel_width
);
706 DEFUN ("window-pixel-height", Fwindow_pixel_height
, Swindow_pixel_height
, 0, 1, 0,
707 doc
: /* Return the height of window WINDOW in pixels.
708 WINDOW must be a valid window and defaults to the selected one.
710 The return value includes the mode line and header line and the bottom
711 divider, if any. If WINDOW is an internal window, its pixel height is
712 the height of the screen areas spanned by its children. */)
715 return make_number (decode_valid_window (window
)->pixel_height
);
718 DEFUN ("window-total-height", Fwindow_total_height
, Swindow_total_height
, 0, 2, 0,
719 doc
: /* Return the height of window WINDOW in lines.
720 WINDOW must be a valid window and defaults to the selected one.
722 The return value includes the heights of WINDOW's mode and header line
723 and its bottom divider, if any. If WINDOW is an internal window, the
724 total height is the height of the screen areas spanned by its children.
726 If WINDOW's pixel height is not an integral multiple of its frame's
727 character height, the number of lines occupied by WINDOW is rounded
728 internally. This is done in a way such that, if WINDOW is a parent
729 window, the sum of the total heights of all its children internally
730 equals the total height of WINDOW.
732 If the optional argument ROUND is `ceiling', return the smallest integer
733 larger than WINDOW's pixel height divided by the character height of
734 WINDOW's frame. ROUND `floor' means to return the largest integer
735 smaller than WINDOW's pixel height divided by the character height of
736 WINDOW's frame. Any other value of ROUND means to return the internal
737 total height of WINDOW. */)
738 (Lisp_Object window
, Lisp_Object round
)
740 struct window
*w
= decode_valid_window (window
);
742 if (! EQ (round
, Qfloor
) && ! EQ (round
, Qceiling
))
743 return make_number (w
->total_lines
);
746 int unit
= FRAME_LINE_HEIGHT (WINDOW_XFRAME (w
));
748 return make_number (EQ (round
, Qceiling
)
749 ? ((w
->pixel_height
+ unit
- 1) /unit
)
750 : (w
->pixel_height
/ unit
));
754 DEFUN ("window-total-width", Fwindow_total_width
, Swindow_total_width
, 0, 2, 0,
755 doc
: /* Return the total width of window WINDOW in columns.
756 WINDOW must be a valid window and defaults to the selected one.
758 The return value includes the widths of WINDOW's fringes, margins,
759 scroll bars and its right divider, if any. If WINDOW is an internal
760 window, the total width is the width of the screen areas spanned by its
763 If WINDOW's pixel width is not an integral multiple of its frame's
764 character width, the number of lines occupied by WINDOW is rounded
765 internally. This is done in a way such that, if WINDOW is a parent
766 window, the sum of the total widths of all its children internally
767 equals the total width of WINDOW.
769 If the optional argument ROUND is `ceiling', return the smallest integer
770 larger than WINDOW's pixel width divided by the character width of
771 WINDOW's frame. ROUND `floor' means to return the largest integer
772 smaller than WINDOW's pixel width divided by the character width of
773 WINDOW's frame. Any other value of ROUND means to return the internal
774 total width of WINDOW. */)
775 (Lisp_Object window
, Lisp_Object round
)
777 struct window
*w
= decode_valid_window (window
);
779 if (! EQ (round
, Qfloor
) && ! EQ (round
, Qceiling
))
780 return make_number (w
->total_cols
);
783 int unit
= FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
785 return make_number (EQ (round
, Qceiling
)
786 ? ((w
->pixel_width
+ unit
- 1) /unit
)
787 : (w
->pixel_width
/ unit
));
791 DEFUN ("window-new-total", Fwindow_new_total
, Swindow_new_total
, 0, 1, 0,
792 doc
: /* Return the new total size of window WINDOW.
793 WINDOW must be a valid window and defaults to the selected one.
795 The new total size of WINDOW is the value set by the last call of
796 `set-window-new-total' for WINDOW. If it is valid, it will be shortly
797 installed as WINDOW's total height (see `window-total-height') or total
798 width (see `window-total-width'). */)
801 return decode_valid_window (window
)->new_total
;
804 DEFUN ("window-normal-size", Fwindow_normal_size
, Swindow_normal_size
, 0, 2, 0,
805 doc
: /* Return the normal height of window WINDOW.
806 WINDOW must be a valid window and defaults to the selected one.
807 If HORIZONTAL is non-nil, return the normal width of WINDOW.
809 The normal height of a frame's root window or a window that is
810 horizontally combined (a window that has a left or right sibling) is
811 1.0. The normal height of a window that is vertically combined (has a
812 sibling above or below) is the fraction of the window's height with
813 respect to its parent. The sum of the normal heights of all windows in a
814 vertical combination equals 1.0.
816 Similarly, the normal width of a frame's root window or a window that is
817 vertically combined equals 1.0. The normal width of a window that is
818 horizontally combined is the fraction of the window's width with respect
819 to its parent. The sum of the normal widths of all windows in a
820 horizontal combination equals 1.0.
822 The normal sizes of windows are used to restore the proportional sizes
823 of windows after they have been shrunk to their minimum sizes; for
824 example when a frame is temporarily made very small and afterwards gets
825 re-enlarged to its previous size. */)
826 (Lisp_Object window
, Lisp_Object horizontal
)
828 struct window
*w
= decode_valid_window (window
);
830 return NILP (horizontal
) ? w
->normal_lines
: w
->normal_cols
;
833 DEFUN ("window-new-normal", Fwindow_new_normal
, Swindow_new_normal
, 0, 1, 0,
834 doc
: /* Return new normal size of window WINDOW.
835 WINDOW must be a valid window and defaults to the selected one.
837 The new normal size of WINDOW is the value set by the last call of
838 `set-window-new-normal' for WINDOW. If valid, it will be shortly
839 installed as WINDOW's normal size (see `window-normal-size'). */)
842 return decode_valid_window (window
)->new_normal
;
845 DEFUN ("window-new-pixel", Fwindow_new_pixel
, Swindow_new_pixel
, 0, 1, 0,
846 doc
: /* Return new pixel size of window WINDOW.
847 WINDOW must be a valid window and defaults to the selected one.
849 The new pixel size of WINDOW is the value set by the last call of
850 `set-window-new-pixel' for WINDOW. If it is valid, it will be shortly
851 installed as WINDOW's pixel height (see `window-pixel-height') or pixel
852 width (see `window-pixel-width'). */)
855 return decode_valid_window (window
)->new_pixel
;
858 DEFUN ("window-pixel-left", Fwindow_pixel_left
, Swindow_pixel_left
, 0, 1, 0,
859 doc
: /* Return left pixel edge of window WINDOW.
860 WINDOW must be a valid window and defaults to the selected one. */)
863 return make_number (decode_valid_window (window
)->pixel_left
);
866 DEFUN ("window-pixel-top", Fwindow_pixel_top
, Swindow_pixel_top
, 0, 1, 0,
867 doc
: /* Return top pixel edge of window WINDOW.
868 WINDOW must be a valid window and defaults to the selected one. */)
871 return make_number (decode_valid_window (window
)->pixel_top
);
874 DEFUN ("window-left-column", Fwindow_left_column
, Swindow_left_column
, 0, 1, 0,
875 doc
: /* Return left column of window WINDOW.
876 This is the distance, in columns, between the left edge of WINDOW and
877 the left edge of the frame's window area. For instance, the return
878 value is 0 if there is no window to the left of WINDOW.
880 WINDOW must be a valid window and defaults to the selected one. */)
883 return make_number (decode_valid_window (window
)->left_col
);
886 DEFUN ("window-top-line", Fwindow_top_line
, Swindow_top_line
, 0, 1, 0,
887 doc
: /* Return top line of window WINDOW.
888 This is the distance, in lines, between the top of WINDOW and the top
889 of the frame's window area. For instance, the return value is 0 if
890 there is no window above WINDOW.
892 WINDOW must be a valid window and defaults to the selected one. */)
895 return make_number (decode_valid_window (window
)->top_line
);
898 /* Return the number of lines/pixels of W's body. Don't count any mode
899 or header line or horizontal divider of W. Rounds down to nearest
900 integer when not working pixelwise. */
902 window_body_height (struct window
*w
, bool pixelwise
)
904 int height
= (w
->pixel_height
905 - WINDOW_HEADER_LINE_HEIGHT (w
)
906 - (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
)
907 ? WINDOW_SCROLL_BAR_AREA_HEIGHT (w
)
909 - WINDOW_MODE_LINE_HEIGHT (w
)
910 - WINDOW_BOTTOM_DIVIDER_WIDTH (w
));
912 /* Don't return a negative value. */
913 return max (pixelwise
915 : height
/ FRAME_LINE_HEIGHT (WINDOW_XFRAME (w
)),
919 /* Return the number of columns/pixels of W's body. Don't count columns
920 occupied by the scroll bar or the divider/vertical bar separating W
921 from its right sibling or margins. On window-systems don't count
922 fringes either. Round down to nearest integer when not working
925 window_body_width (struct window
*w
, bool pixelwise
)
927 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
929 int width
= (w
->pixel_width
930 - WINDOW_RIGHT_DIVIDER_WIDTH (w
)
931 - (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
932 ? WINDOW_SCROLL_BAR_AREA_WIDTH (w
)
933 : ((!FRAME_WINDOW_P (f
)
934 && !WINDOW_RIGHTMOST_P (w
)
935 && !WINDOW_RIGHT_DIVIDER_WIDTH (w
))
936 /* A vertical bar is either 1 or 0. */
938 - WINDOW_MARGINS_WIDTH (w
)
939 - (FRAME_WINDOW_P (f
)
940 ? WINDOW_FRINGES_WIDTH (w
)
943 /* Don't return a negative value. */
944 return max (pixelwise
946 : width
/ FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
)),
950 DEFUN ("window-body-height", Fwindow_body_height
, Swindow_body_height
, 0, 2, 0,
951 doc
: /* Return the height of WINDOW's text area.
952 WINDOW must be a live window and defaults to the selected one. Optional
953 argument PIXELWISE non-nil means return the height of WINDOW's text area
954 in pixels. The return value does not include the mode line or header
955 line or any horizontal divider.
957 If PIXELWISE is nil, return the largest integer smaller than WINDOW's
958 pixel height divided by the character height of WINDOW's frame. This
959 means that if a line at the bottom of the text area is only partially
960 visible, that line is not counted. */)
961 (Lisp_Object window
, Lisp_Object pixelwise
)
963 return make_number (window_body_height (decode_live_window (window
),
964 NILP (pixelwise
) ? 0 : 1));
967 DEFUN ("window-body-width", Fwindow_body_width
, Swindow_body_width
, 0, 2, 0,
968 doc
: /* Return the width of WINDOW's text area.
969 WINDOW must be a live window and defaults to the selected one. Optional
970 argument PIXELWISE non-nil means return the width in pixels. The return
971 value does not include any vertical dividers, fringes or marginal areas,
974 If PIXELWISE is nil, return the largest integer smaller than WINDOW's
975 pixel width divided by the character width of WINDOW's frame. This
976 means that if a column at the right of the text area is only partially
977 visible, that column is not counted.
979 Note that the returned value includes the column reserved for the
980 continuation glyph. */)
981 (Lisp_Object window
, Lisp_Object pixelwise
)
983 return make_number (window_body_width (decode_live_window (window
),
984 NILP (pixelwise
) ? 0 : 1));
987 DEFUN ("window-mode-line-height", Fwindow_mode_line_height
,
988 Swindow_mode_line_height
, 0, 1, 0,
989 doc
: /* Return the height in pixels of WINDOW's mode-line.
990 WINDOW must be a live window and defaults to the selected one. */)
993 return (make_number (WINDOW_MODE_LINE_HEIGHT (decode_live_window (window
))));
996 DEFUN ("window-header-line-height", Fwindow_header_line_height
,
997 Swindow_header_line_height
, 0, 1, 0,
998 doc
: /* Return the height in pixels of WINDOW's header-line.
999 WINDOW must be a live window and defaults to the selected one. */)
1000 (Lisp_Object window
)
1002 return (make_number (WINDOW_HEADER_LINE_HEIGHT (decode_live_window (window
))));
1005 DEFUN ("window-right-divider-width", Fwindow_right_divider_width
,
1006 Swindow_right_divider_width
, 0, 1, 0,
1007 doc
: /* Return the width in pixels of WINDOW's right divider.
1008 WINDOW must be a live window and defaults to the selected one. */)
1009 (Lisp_Object window
)
1011 return (make_number (WINDOW_RIGHT_DIVIDER_WIDTH (decode_live_window (window
))));
1014 DEFUN ("window-bottom-divider-width", Fwindow_bottom_divider_width
,
1015 Swindow_bottom_divider_width
, 0, 1, 0,
1016 doc
: /* Return the width in pixels of WINDOW's bottom divider.
1017 WINDOW must be a live window and defaults to the selected one. */)
1018 (Lisp_Object window
)
1020 return (make_number (WINDOW_BOTTOM_DIVIDER_WIDTH (decode_live_window (window
))));
1023 DEFUN ("window-scroll-bar-width", Fwindow_scroll_bar_width
,
1024 Swindow_scroll_bar_width
, 0, 1, 0,
1025 doc
: /* Return the width in pixels of WINDOW's vertical scrollbar.
1026 WINDOW must be a live window and defaults to the selected one. */)
1027 (Lisp_Object window
)
1029 return (make_number (WINDOW_SCROLL_BAR_AREA_WIDTH (decode_live_window (window
))));
1032 DEFUN ("window-scroll-bar-height", Fwindow_scroll_bar_height
,
1033 Swindow_scroll_bar_height
, 0, 1, 0,
1034 doc
: /* Return the height in pixels of WINDOW's horizontal scrollbar.
1035 WINDOW must be a live window and defaults to the selected one. */)
1036 (Lisp_Object window
)
1038 return (make_number (WINDOW_SCROLL_BAR_AREA_HEIGHT (decode_live_window (window
))));
1041 DEFUN ("window-hscroll", Fwindow_hscroll
, Swindow_hscroll
, 0, 1, 0,
1042 doc
: /* Return the number of columns by which WINDOW is scrolled from left margin.
1043 WINDOW must be a live window and defaults to the selected one. */)
1044 (Lisp_Object window
)
1046 return make_number (decode_live_window (window
)->hscroll
);
1049 /* Set W's horizontal scroll amount to HSCROLL clipped to a reasonable
1050 range, returning the new amount as a fixnum. */
1052 set_window_hscroll (struct window
*w
, EMACS_INT hscroll
)
1054 /* Horizontal scrolling has problems with large scroll amounts.
1055 It's too slow with long lines, and even with small lines the
1056 display can be messed up. For now, though, impose only the limits
1057 required by the internal representation: horizontal scrolling must
1058 fit in fixnum (since it's visible to Elisp) and into ptrdiff_t
1059 (since it's stored in a ptrdiff_t). */
1060 ptrdiff_t hscroll_max
= min (MOST_POSITIVE_FIXNUM
, PTRDIFF_MAX
);
1061 ptrdiff_t new_hscroll
= clip_to_bounds (0, hscroll
, hscroll_max
);
1063 /* Prevent redisplay shortcuts when changing the hscroll. */
1064 if (w
->hscroll
!= new_hscroll
)
1065 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
1067 w
->hscroll
= new_hscroll
;
1068 w
->suspend_auto_hscroll
= 1;
1070 return make_number (new_hscroll
);
1073 DEFUN ("set-window-hscroll", Fset_window_hscroll
, Sset_window_hscroll
, 2, 2, 0,
1074 doc
: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
1075 WINDOW must be a live window and defaults to the selected one.
1076 Clip the number to a reasonable value if out of range.
1077 Return the new number. NCOL should be zero or positive.
1079 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
1080 window so that the location of point moves off-window. */)
1081 (Lisp_Object window
, Lisp_Object ncol
)
1083 CHECK_NUMBER (ncol
);
1084 return set_window_hscroll (decode_live_window (window
), XINT (ncol
));
1087 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger
,
1088 Swindow_redisplay_end_trigger
, 0, 1, 0,
1089 doc
: /* Return WINDOW's redisplay end trigger value.
1090 WINDOW must be a live window and defaults to the selected one.
1091 See `set-window-redisplay-end-trigger' for more information. */)
1092 (Lisp_Object window
)
1094 return decode_live_window (window
)->redisplay_end_trigger
;
1097 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger
,
1098 Sset_window_redisplay_end_trigger
, 2, 2, 0,
1099 doc
: /* Set WINDOW's redisplay end trigger value to VALUE.
1100 WINDOW must be a live window and defaults to the selected one. VALUE
1101 should be a buffer position (typically a marker) or nil. If it is a
1102 buffer position, then if redisplay in WINDOW reaches a position beyond
1103 VALUE, the functions in `redisplay-end-trigger-functions' are called
1104 with two arguments: WINDOW, and the end trigger value. Afterwards the
1105 end-trigger value is reset to nil. */)
1106 (register Lisp_Object window
, Lisp_Object value
)
1108 wset_redisplay_end_trigger (decode_live_window (window
), value
);
1112 DEFUN ("window-edges", Fwindow_edges
, Swindow_edges
, 0, 1, 0,
1113 doc
: /* Return a list of the edge coordinates of WINDOW.
1114 WINDOW must be a valid window and defaults to the selected one.
1116 The returned list has the form (LEFT TOP RIGHT BOTTOM). TOP and BOTTOM
1117 count by lines, and LEFT and RIGHT count by columns, all relative to 0,
1118 0 at top left corner of frame.
1120 RIGHT is one more than the rightmost column occupied by WINDOW. BOTTOM
1121 is one more than the bottommost row occupied by WINDOW. The edges
1122 include the space used by WINDOW's scroll bar, display margins, fringes,
1123 header line, and/or mode line. For the edges of just the text area, use
1124 `window-inside-edges'. */)
1125 (Lisp_Object window
)
1127 register struct window
*w
= decode_valid_window (window
);
1129 return list4i (WINDOW_LEFT_EDGE_COL (w
), WINDOW_TOP_EDGE_LINE (w
),
1130 WINDOW_RIGHT_EDGE_COL (w
), WINDOW_BOTTOM_EDGE_LINE (w
));
1133 DEFUN ("window-pixel-edges", Fwindow_pixel_edges
, Swindow_pixel_edges
, 0, 1, 0,
1134 doc
: /* Return a list of the edge pixel coordinates of WINDOW.
1135 WINDOW must be a valid window and defaults to the selected one.
1137 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
1138 0, 0 at the top left corner of the frame.
1140 RIGHT is one more than the rightmost x position occupied by WINDOW.
1141 BOTTOM is one more than the bottommost y position occupied by WINDOW.
1142 The pixel edges include the space used by WINDOW's scroll bar, display
1143 margins, fringes, header line, and/or mode line. For the pixel edges
1144 of just the text area, use `window-inside-pixel-edges'. */)
1145 (Lisp_Object window
)
1147 register struct window
*w
= decode_valid_window (window
);
1149 return list4i (WINDOW_LEFT_EDGE_X (w
), WINDOW_TOP_EDGE_Y (w
),
1150 WINDOW_RIGHT_EDGE_X (w
), WINDOW_BOTTOM_EDGE_Y (w
));
1154 calc_absolute_offset (struct window
*w
, int *add_x
, int *add_y
)
1156 struct frame
*f
= XFRAME (w
->frame
);
1157 *add_y
= f
->top_pos
;
1158 #ifdef FRAME_MENUBAR_HEIGHT
1159 *add_y
+= FRAME_MENUBAR_HEIGHT (f
);
1161 #ifdef FRAME_TOOLBAR_TOP_HEIGHT
1162 *add_y
+= FRAME_TOOLBAR_TOP_HEIGHT (f
);
1163 #elif defined (FRAME_TOOLBAR_HEIGHT)
1164 *add_y
+= FRAME_TOOLBAR_HEIGHT (f
);
1166 #ifdef FRAME_NS_TITLEBAR_HEIGHT
1167 *add_y
+= FRAME_NS_TITLEBAR_HEIGHT (f
);
1169 *add_x
= f
->left_pos
;
1170 #ifdef FRAME_TOOLBAR_LEFT_WIDTH
1171 *add_x
+= FRAME_TOOLBAR_LEFT_WIDTH (f
);
1175 DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges
,
1176 Swindow_absolute_pixel_edges
, 0, 1, 0,
1177 doc
: /* Return a list of the edge pixel coordinates of WINDOW.
1178 WINDOW must be a valid window and defaults to the selected one.
1180 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
1181 0, 0 at the top left corner of the display.
1183 RIGHT is one more than the rightmost x position occupied by WINDOW.
1184 BOTTOM is one more than the bottommost y position occupied by WINDOW.
1185 The pixel edges include the space used by WINDOW's scroll bar, display
1186 margins, fringes, header line, and/or mode line. For the pixel edges
1187 of just the text area, use `window-inside-absolute-pixel-edges'. */)
1188 (Lisp_Object window
)
1190 register struct window
*w
= decode_valid_window (window
);
1193 calc_absolute_offset (w
, &add_x
, &add_y
);
1195 return list4i (WINDOW_LEFT_EDGE_X (w
) + add_x
,
1196 WINDOW_TOP_EDGE_Y (w
) + add_y
,
1197 WINDOW_RIGHT_EDGE_X (w
) + add_x
,
1198 WINDOW_BOTTOM_EDGE_Y (w
) + add_y
);
1201 DEFUN ("window-inside-edges", Fwindow_inside_edges
, Swindow_inside_edges
, 0, 1, 0,
1202 doc
: /* Return a list of the edge coordinates of WINDOW.
1203 WINDOW must be a live window and defaults to the selected one.
1205 The returned list has the form (LEFT TOP RIGHT BOTTOM). TOP and BOTTOM
1206 count by lines, and LEFT and RIGHT count by columns, all relative to 0,
1207 0 at top left corner of frame.
1209 RIGHT is one more than the rightmost column of WINDOW's text area.
1210 BOTTOM is one more than the bottommost row of WINDOW's text area. The
1211 inside edges do not include the space used by the WINDOW's scroll bar,
1212 display margins, fringes, header line, and/or mode line. */)
1213 (Lisp_Object window
)
1215 register struct window
*w
= decode_live_window (window
);
1217 return list4i ((WINDOW_BOX_LEFT_EDGE_COL (w
)
1218 + WINDOW_LEFT_MARGIN_COLS (w
)
1219 + ((WINDOW_LEFT_FRINGE_WIDTH (w
)
1220 + WINDOW_FRAME_COLUMN_WIDTH (w
) - 1)
1221 / WINDOW_FRAME_COLUMN_WIDTH (w
))),
1222 (WINDOW_TOP_EDGE_LINE (w
)
1223 + WINDOW_HEADER_LINE_LINES (w
)),
1224 (WINDOW_BOX_RIGHT_EDGE_COL (w
)
1225 - WINDOW_RIGHT_MARGIN_COLS (w
)
1226 - ((WINDOW_RIGHT_FRINGE_WIDTH (w
)
1227 + WINDOW_FRAME_COLUMN_WIDTH (w
) - 1)
1228 / WINDOW_FRAME_COLUMN_WIDTH (w
))),
1229 (WINDOW_BOTTOM_EDGE_LINE (w
)
1230 - WINDOW_MODE_LINE_LINES (w
)));
1233 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges
, Swindow_inside_pixel_edges
, 0, 1, 0,
1234 doc
: /* Return a list of the edge pixel coordinates of WINDOW's text area.
1235 WINDOW must be a live window and defaults to the selected one.
1237 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
1238 (0,0) at the top left corner of the frame's window area.
1240 RIGHT is one more than the rightmost x position of WINDOW's text area.
1241 BOTTOM is one more than the bottommost y position of WINDOW's text area.
1242 The inside edges do not include the space used by WINDOW's scroll bar,
1243 display margins, fringes, header line, and/or mode line. */)
1244 (Lisp_Object window
)
1246 register struct window
*w
= decode_live_window (window
);
1248 return list4i ((WINDOW_BOX_LEFT_EDGE_X (w
)
1249 + WINDOW_LEFT_MARGIN_WIDTH (w
)
1250 + WINDOW_LEFT_FRINGE_WIDTH (w
)),
1251 (WINDOW_TOP_EDGE_Y (w
)
1252 + WINDOW_HEADER_LINE_HEIGHT (w
)),
1253 (WINDOW_BOX_RIGHT_EDGE_X (w
)
1254 - WINDOW_RIGHT_MARGIN_WIDTH (w
)
1255 - WINDOW_RIGHT_FRINGE_WIDTH (w
)),
1256 (WINDOW_BOTTOM_EDGE_Y (w
)
1257 - WINDOW_MODE_LINE_HEIGHT (w
)));
1260 DEFUN ("window-inside-absolute-pixel-edges",
1261 Fwindow_inside_absolute_pixel_edges
,
1262 Swindow_inside_absolute_pixel_edges
, 0, 1, 0,
1263 doc
: /* Return a list of the edge pixel coordinates of WINDOW's text area.
1264 WINDOW must be a live window and defaults to the selected one.
1266 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
1267 (0,0) at the top left corner of the frame's window area.
1269 RIGHT is one more than the rightmost x position of WINDOW's text area.
1270 BOTTOM is one more than the bottommost y position of WINDOW's text area.
1271 The inside edges do not include the space used by WINDOW's scroll bar,
1272 display margins, fringes, header line, and/or mode line. */)
1273 (Lisp_Object window
)
1275 register struct window
*w
= decode_live_window (window
);
1278 calc_absolute_offset (w
, &add_x
, &add_y
);
1280 return list4i ((WINDOW_BOX_LEFT_EDGE_X (w
)
1281 + WINDOW_LEFT_MARGIN_WIDTH (w
)
1282 + WINDOW_LEFT_FRINGE_WIDTH (w
) + add_x
),
1283 (WINDOW_TOP_EDGE_Y (w
)
1284 + WINDOW_HEADER_LINE_HEIGHT (w
) + add_y
),
1285 (WINDOW_BOX_RIGHT_EDGE_X (w
)
1286 - WINDOW_RIGHT_MARGIN_WIDTH (w
)
1287 - WINDOW_RIGHT_FRINGE_WIDTH (w
) + add_x
),
1288 (WINDOW_BOTTOM_EDGE_Y (w
)
1289 - WINDOW_MODE_LINE_HEIGHT (w
) + add_y
));
1292 /* Test if the character at column X, row Y is within window W.
1293 If it is not, return ON_NOTHING;
1294 if it is on the window's vertical divider, return
1296 if it is on the window's horizontal divider, return
1298 if it is in the window's text area, return ON_TEXT;
1299 if it is on the window's modeline, return ON_MODE_LINE;
1300 if it is on the border between the window and its right sibling,
1301 return ON_VERTICAL_BORDER;
1302 if it is on a scroll bar, return ON_SCROLL_BAR;
1303 if it is on the window's top line, return ON_HEADER_LINE;
1304 if it is in left or right fringe of the window,
1305 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
1306 if it is in the marginal area to the left/right of the window,
1307 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
1309 X and Y are frame relative pixel coordinates. */
1311 static enum window_part
1312 coordinates_in_window (register struct window
*w
, int x
, int y
)
1314 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1315 enum window_part part
;
1316 int ux
= FRAME_COLUMN_WIDTH (f
);
1317 int left_x
= WINDOW_LEFT_EDGE_X (w
);
1318 int right_x
= WINDOW_RIGHT_EDGE_X (w
);
1319 int top_y
= WINDOW_TOP_EDGE_Y (w
);
1320 int bottom_y
= WINDOW_BOTTOM_EDGE_Y (w
);
1321 /* The width of the area where the vertical line can be dragged.
1322 (Between mode lines for instance. */
1323 int grabbable_width
= ux
;
1324 int lmargin_width
, rmargin_width
, text_left
, text_right
;
1326 /* Outside any interesting row or column? */
1327 if (y
< top_y
|| y
>= bottom_y
|| x
< left_x
|| x
>= right_x
)
1330 /* On the horizontal window divider (which prevails the vertical
1332 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
) > 0
1333 && y
>= (bottom_y
- WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
1335 return ON_BOTTOM_DIVIDER
;
1336 /* On vertical window divider? */
1337 else if (!WINDOW_RIGHTMOST_P (w
)
1338 && WINDOW_RIGHT_DIVIDER_WIDTH (w
) > 0
1339 && x
>= right_x
- WINDOW_RIGHT_DIVIDER_WIDTH (w
)
1341 return ON_RIGHT_DIVIDER
;
1342 /* On the horizontal scroll bar? (Including the empty space at its
1344 else if ((WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
)
1346 - WINDOW_SCROLL_BAR_AREA_HEIGHT (w
)
1347 - CURRENT_MODE_LINE_HEIGHT (w
)
1348 - WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
1350 - CURRENT_MODE_LINE_HEIGHT (w
)
1351 - WINDOW_BOTTOM_DIVIDER_WIDTH (w
))))
1352 return ON_HORIZONTAL_SCROLL_BAR
;
1353 /* On the mode or header line? */
1354 else if ((WINDOW_WANTS_MODELINE_P (w
)
1356 - CURRENT_MODE_LINE_HEIGHT (w
)
1357 - WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
1358 && y
<= bottom_y
- WINDOW_BOTTOM_DIVIDER_WIDTH (w
)
1359 && (part
= ON_MODE_LINE
))
1360 || (WINDOW_WANTS_HEADER_LINE_P (w
)
1361 && y
< top_y
+ CURRENT_HEADER_LINE_HEIGHT (w
)
1362 && (part
= ON_HEADER_LINE
)))
1364 /* If it's under/over the scroll bar portion of the mode/header
1365 line, say it's on the vertical line. That's to be able to
1366 resize windows horizontally in case we're using toolkit scroll
1367 bars. Note: If scrollbars are on the left, the window that
1368 must be eventually resized is that on the left of WINDOW. */
1369 if ((WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0)
1370 && ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
1371 && !WINDOW_LEFTMOST_P (w
)
1372 && eabs (x
- left_x
) < grabbable_width
)
1373 || (!WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
1374 && !WINDOW_RIGHTMOST_P (w
)
1375 && eabs (x
- right_x
) < grabbable_width
)))
1376 return ON_VERTICAL_BORDER
;
1381 /* In what's below, we subtract 1 when computing right_x because we
1382 want the rightmost pixel, which is given by left_pixel+width-1. */
1383 if (w
->pseudo_window_p
)
1386 right_x
= WINDOW_PIXEL_WIDTH (w
) - 1;
1390 left_x
= WINDOW_BOX_LEFT_EDGE_X (w
);
1391 right_x
= WINDOW_BOX_RIGHT_EDGE_X (w
) - 1;
1394 /* Outside any interesting column? */
1395 if (x
< left_x
|| x
> right_x
)
1396 return ON_VERTICAL_SCROLL_BAR
;
1398 lmargin_width
= window_box_width (w
, LEFT_MARGIN_AREA
);
1399 rmargin_width
= window_box_width (w
, RIGHT_MARGIN_AREA
);
1401 text_left
= window_box_left (w
, TEXT_AREA
);
1402 text_right
= text_left
+ window_box_width (w
, TEXT_AREA
);
1404 if (FRAME_WINDOW_P (f
))
1406 if (!w
->pseudo_window_p
1407 && WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
1408 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
1409 && !WINDOW_RIGHTMOST_P (w
)
1410 && (eabs (x
- right_x
) < grabbable_width
))
1411 return ON_VERTICAL_BORDER
;
1413 /* Need to say "x > right_x" rather than >=, since on character
1414 terminals, the vertical line's x coordinate is right_x. */
1415 else if (!w
->pseudo_window_p
1416 && WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
1417 && !WINDOW_RIGHTMOST_P (w
)
1418 /* Why check ux if we are not the rightmost window? Also
1419 shouldn't a pseudo window always be rightmost? */
1420 && x
> right_x
- ux
)
1421 return ON_VERTICAL_BORDER
;
1425 if (lmargin_width
> 0
1426 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1427 ? (x
>= left_x
+ WINDOW_LEFT_FRINGE_WIDTH (w
))
1428 : (x
< left_x
+ lmargin_width
)))
1429 return ON_LEFT_MARGIN
;
1431 return ON_LEFT_FRINGE
;
1434 if (x
>= text_right
)
1436 if (rmargin_width
> 0
1437 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1438 ? (x
< right_x
- WINDOW_RIGHT_FRINGE_WIDTH (w
))
1439 : (x
>= right_x
- rmargin_width
)))
1440 return ON_RIGHT_MARGIN
;
1442 return ON_RIGHT_FRINGE
;
1445 /* Everything special ruled out - must be on text area */
1449 /* Take X is the frame-relative pixel x-coordinate, and return the
1450 x-coordinate relative to part PART of window W. */
1452 window_relative_x_coord (struct window
*w
, enum window_part part
, int x
)
1454 int left_x
= (w
->pseudo_window_p
) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w
);
1459 return x
- window_box_left (w
, TEXT_AREA
);
1461 case ON_HEADER_LINE
:
1463 case ON_LEFT_FRINGE
:
1466 case ON_RIGHT_FRINGE
:
1467 return x
- left_x
- WINDOW_LEFT_FRINGE_WIDTH (w
);
1469 case ON_LEFT_MARGIN
:
1471 - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1472 ? WINDOW_LEFT_FRINGE_WIDTH (w
) : 0));
1474 case ON_RIGHT_MARGIN
:
1476 - ((w
->pseudo_window_p
)
1477 ? WINDOW_PIXEL_WIDTH (w
)
1478 : WINDOW_BOX_RIGHT_EDGE_X (w
))
1479 + window_box_width (w
, RIGHT_MARGIN_AREA
)
1480 + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1481 ? WINDOW_RIGHT_FRINGE_WIDTH (w
) : 0));
1484 /* ON_SCROLL_BAR, ON_NOTHING, and ON_VERTICAL_BORDER: */
1489 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p
,
1490 Scoordinates_in_window_p
, 2, 2, 0,
1491 doc
: /* Return non-nil if COORDINATES are in WINDOW.
1492 WINDOW must be a live window and defaults to the selected one.
1493 COORDINATES is a cons of the form (X . Y), X and Y being distances
1494 measured in characters from the upper-left corner of the frame.
1495 \(0 . 0) denotes the character in the upper left corner of the
1497 If COORDINATES are in the text portion of WINDOW,
1498 the coordinates relative to the window are returned.
1499 If they are in the bottom divider of WINDOW, `bottom-divider' is returned.
1500 If they are in the right divider of WINDOW, `right-divider' is returned.
1501 If they are in the mode line of WINDOW, `mode-line' is returned.
1502 If they are in the header line of WINDOW, `header-line' is returned.
1503 If they are in the left fringe of WINDOW, `left-fringe' is returned.
1504 If they are in the right fringe of WINDOW, `right-fringe' is returned.
1505 If they are on the border between WINDOW and its right sibling,
1506 `vertical-line' is returned.
1507 If they are in the windows's left or right marginal areas, `left-margin'\n\
1508 or `right-margin' is returned. */)
1509 (register Lisp_Object coordinates
, Lisp_Object window
)
1516 w
= decode_live_window (window
);
1517 f
= XFRAME (w
->frame
);
1518 CHECK_CONS (coordinates
);
1519 lx
= Fcar (coordinates
);
1520 ly
= Fcdr (coordinates
);
1521 CHECK_NUMBER_OR_FLOAT (lx
);
1522 CHECK_NUMBER_OR_FLOAT (ly
);
1523 x
= FRAME_PIXEL_X_FROM_CANON_X (f
, lx
) + FRAME_INTERNAL_BORDER_WIDTH (f
);
1524 y
= FRAME_PIXEL_Y_FROM_CANON_Y (f
, ly
) + FRAME_INTERNAL_BORDER_WIDTH (f
);
1526 switch (coordinates_in_window (w
, x
, y
))
1532 /* Convert X and Y to window relative pixel coordinates, and
1533 return the canonical char units. */
1534 x
-= window_box_left (w
, TEXT_AREA
);
1535 y
-= WINDOW_TOP_EDGE_Y (w
);
1536 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f
, x
),
1537 FRAME_CANON_Y_FROM_PIXEL_Y (f
, y
));
1542 case ON_VERTICAL_BORDER
:
1543 return Qvertical_line
;
1545 case ON_HEADER_LINE
:
1546 return Qheader_line
;
1548 case ON_LEFT_FRINGE
:
1549 return Qleft_fringe
;
1551 case ON_RIGHT_FRINGE
:
1552 return Qright_fringe
;
1554 case ON_LEFT_MARGIN
:
1555 return Qleft_margin
;
1557 case ON_RIGHT_MARGIN
:
1558 return Qright_margin
;
1560 case ON_VERTICAL_SCROLL_BAR
:
1561 /* Historically we are supposed to return nil in this case. */
1564 case ON_HORIZONTAL_SCROLL_BAR
:
1567 case ON_RIGHT_DIVIDER
:
1568 return Qright_divider
;
1570 case ON_BOTTOM_DIVIDER
:
1571 return Qbottom_divider
;
1579 /* Callback for foreach_window, used in window_from_coordinates.
1580 Check if window W contains coordinates specified by USER_DATA which
1581 is actually a pointer to a struct check_window_data CW.
1583 Check if window W contains coordinates *CW->x and *CW->y. If it
1584 does, return W in *CW->window, as Lisp_Object, and return in
1585 *CW->part the part of the window under coordinates *X,*Y. Return
1586 zero from this function to stop iterating over windows. */
1588 struct check_window_data
1590 Lisp_Object
*window
;
1592 enum window_part
*part
;
1596 check_window_containing (struct window
*w
, void *user_data
)
1598 struct check_window_data
*cw
= user_data
;
1599 enum window_part found
;
1602 found
= coordinates_in_window (w
, cw
->x
, cw
->y
);
1603 if (found
!= ON_NOTHING
)
1606 XSETWINDOW (*cw
->window
, w
);
1614 /* Find the window containing frame-relative pixel position X/Y and
1615 return it as a Lisp_Object.
1617 If X, Y is on one of the window's special `window_part' elements,
1618 set *PART to the id of that element.
1620 If there is no window under X, Y return nil and leave *PART
1621 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1623 This function was previously implemented with a loop cycling over
1624 windows with Fnext_window, and starting with the frame's selected
1625 window. It turned out that this doesn't work with an
1626 implementation of next_window using Vwindow_list, because
1627 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1628 tree of F when this function is called asynchronously from
1629 note_mouse_highlight. The original loop didn't terminate in this
1633 window_from_coordinates (struct frame
*f
, int x
, int y
,
1634 enum window_part
*part
, bool tool_bar_p
)
1637 struct check_window_data cw
;
1638 enum window_part dummy
;
1644 cw
.window
= &window
, cw
.x
= x
, cw
.y
= y
; cw
.part
= part
;
1645 foreach_window (f
, check_window_containing
, &cw
);
1647 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
1648 /* If not found above, see if it's in the tool bar window, if a tool
1652 && WINDOWP (f
->tool_bar_window
)
1653 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0
1654 && (coordinates_in_window (XWINDOW (f
->tool_bar_window
), x
, y
)
1658 window
= f
->tool_bar_window
;
1665 DEFUN ("window-at", Fwindow_at
, Swindow_at
, 2, 3, 0,
1666 doc
: /* Return window containing coordinates X and Y on FRAME.
1667 FRAME must be a live frame and defaults to the selected one.
1668 The top left corner of the frame is considered to be row 0,
1670 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame
)
1672 struct frame
*f
= decode_live_frame (frame
);
1674 /* Check that arguments are integers or floats. */
1675 CHECK_NUMBER_OR_FLOAT (x
);
1676 CHECK_NUMBER_OR_FLOAT (y
);
1678 return window_from_coordinates (f
,
1679 (FRAME_PIXEL_X_FROM_CANON_X (f
, x
)
1680 + FRAME_INTERNAL_BORDER_WIDTH (f
)),
1681 (FRAME_PIXEL_Y_FROM_CANON_Y (f
, y
)
1682 + FRAME_INTERNAL_BORDER_WIDTH (f
)),
1686 DEFUN ("window-point", Fwindow_point
, Swindow_point
, 0, 1, 0,
1687 doc
: /* Return current value of point in WINDOW.
1688 WINDOW must be a live window and defaults to the selected one.
1690 For a nonselected window, this is the value point would have if that
1691 window were selected.
1693 Note that, when WINDOW is selected, the value returned is the same as
1694 that returned by `point' for WINDOW's buffer. It would be more strictly
1695 correct to return the top-level value of `point', outside of any
1696 `save-excursion' forms. But that is hard to define. */)
1697 (Lisp_Object window
)
1699 register struct window
*w
= decode_live_window (window
);
1701 if (w
== XWINDOW (selected_window
))
1702 return make_number (BUF_PT (XBUFFER (w
->contents
)));
1704 return Fmarker_position (w
->pointm
);
1707 DEFUN ("window-old-point", Fwindow_old_point
, Swindow_old_point
, 0, 1, 0,
1708 doc
: /* Return old value of point in WINDOW.
1709 WINDOW must be a live window and defaults to the selected one. */)
1710 (Lisp_Object window
)
1712 return Fmarker_position (decode_live_window (window
)->old_pointm
);
1715 DEFUN ("window-start", Fwindow_start
, Swindow_start
, 0, 1, 0,
1716 doc
: /* Return position at which display currently starts in WINDOW.
1717 WINDOW must be a live window and defaults to the selected one.
1718 This is updated by redisplay or by calling `set-window-start'. */)
1719 (Lisp_Object window
)
1721 return Fmarker_position (decode_live_window (window
)->start
);
1724 /* This is text temporarily removed from the doc string below.
1726 This function returns nil if the position is not currently known.
1727 That happens when redisplay is preempted and doesn't finish.
1728 If in that case you want to compute where the end of the window would
1729 have been if redisplay had finished, do this:
1731 (goto-char (window-start window))
1732 (vertical-motion (1- (window-height window)) window)
1735 DEFUN ("window-end", Fwindow_end
, Swindow_end
, 0, 2, 0,
1736 doc
: /* Return position at which display currently ends in WINDOW.
1737 WINDOW must be a live window and defaults to the selected one.
1738 This is updated by redisplay, when it runs to completion.
1739 Simply changing the buffer text or setting `window-start'
1740 does not update this value.
1741 Return nil if there is no recorded value. (This can happen if the
1742 last redisplay of WINDOW was preempted, and did not finish.)
1743 If UPDATE is non-nil, compute the up-to-date position
1744 if it isn't already recorded. */)
1745 (Lisp_Object window
, Lisp_Object update
)
1748 struct window
*w
= decode_live_window (window
);
1757 && (windows_or_buffers_changed
1758 || !w
->window_end_valid
1760 || b
->prevent_redisplay_optimizations_p
1761 || window_outdated (w
))
1764 struct text_pos startp
;
1766 struct buffer
*old_buffer
= NULL
;
1767 void *itdata
= NULL
;
1769 /* Cannot use Fvertical_motion because that function doesn't
1770 cope with variable-height lines. */
1771 if (b
!= current_buffer
)
1773 old_buffer
= current_buffer
;
1774 set_buffer_internal (b
);
1777 /* In case W->start is out of the range, use something
1778 reasonable. This situation occurred when loading a file with
1779 `-l' containing a call to `rmail' with subsequent other
1780 commands. At the end, W->start happened to be BEG, while
1781 rmail had already narrowed the buffer. */
1782 CLIP_TEXT_POS_FROM_MARKER (startp
, w
->start
);
1784 itdata
= bidi_shelve_cache ();
1785 start_display (&it
, w
, startp
);
1786 move_it_vertically (&it
, window_box_height (w
));
1787 if (it
.current_y
< it
.last_visible_y
)
1788 move_it_past_eol (&it
);
1789 value
= make_number (IT_CHARPOS (it
));
1790 bidi_unshelve_cache (itdata
, 0);
1793 set_buffer_internal (old_buffer
);
1796 XSETINT (value
, BUF_Z (b
) - w
->window_end_pos
);
1801 DEFUN ("set-window-point", Fset_window_point
, Sset_window_point
, 2, 2, 0,
1802 doc
: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1803 WINDOW must be a live window and defaults to the selected one.
1805 (Lisp_Object window
, Lisp_Object pos
)
1807 register struct window
*w
= decode_live_window (window
);
1809 /* Type of POS is checked by Fgoto_char or set_marker_restricted ... */
1811 if (w
== XWINDOW (selected_window
))
1813 if (XBUFFER (w
->contents
) == current_buffer
)
1817 struct buffer
*old_buffer
= current_buffer
;
1819 /* ... but here we want to catch type error before buffer change. */
1820 CHECK_NUMBER_COERCE_MARKER (pos
);
1821 set_buffer_internal (XBUFFER (w
->contents
));
1823 set_buffer_internal (old_buffer
);
1828 set_marker_restricted (w
->pointm
, pos
, w
->contents
);
1829 /* We have to make sure that redisplay updates the window to show
1830 the new value of point. */
1837 DEFUN ("set-window-start", Fset_window_start
, Sset_window_start
, 2, 3, 0,
1838 doc
: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1839 WINDOW must be a live window and defaults to the selected one. Return
1840 POS. Optional third arg NOFORCE non-nil inhibits next redisplay from
1841 overriding motion of point in order to display at this exact start. */)
1842 (Lisp_Object window
, Lisp_Object pos
, Lisp_Object noforce
)
1844 register struct window
*w
= decode_live_window (window
);
1846 set_marker_restricted (w
->start
, pos
, w
->contents
);
1847 /* This is not right, but much easier than doing what is right. */
1848 w
->start_at_line_beg
= 0;
1851 w
->update_mode_line
= 1;
1853 w
->window_end_valid
= 0;
1859 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p
,
1860 Spos_visible_in_window_p
, 0, 3, 0,
1861 doc
: /* Return non-nil if position POS is currently on the frame in WINDOW.
1862 WINDOW must be a live window and defaults to the selected one.
1864 Return nil if that position is scrolled vertically out of view. If a
1865 character is only partially visible, nil is returned, unless the
1866 optional argument PARTIALLY is non-nil. If POS is only out of view
1867 because of horizontal scrolling, return non-nil. If POS is t, it
1868 specifies the position of the last visible glyph in WINDOW. POS
1869 defaults to point in WINDOW; WINDOW defaults to the selected window.
1871 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
1872 the return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
1873 where X and Y are the pixel coordinates relative to the top left corner
1874 of the window. The remaining elements are omitted if the character after
1875 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
1876 off-window at the top and bottom of the screen line ("row") containing
1877 POS, ROWH is the visible height of that row, and VPOS is the row number
1879 (Lisp_Object pos
, Lisp_Object window
, Lisp_Object partially
)
1881 register struct window
*w
;
1882 register EMACS_INT posint
;
1883 register struct buffer
*buf
;
1884 struct text_pos top
;
1885 Lisp_Object in_window
= Qnil
;
1886 int rtop
, rbot
, rowh
, vpos
, fully_p
= 1;
1889 w
= decode_live_window (window
);
1890 buf
= XBUFFER (w
->contents
);
1891 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1895 else if (!NILP (pos
))
1897 CHECK_NUMBER_COERCE_MARKER (pos
);
1898 posint
= XINT (pos
);
1900 else if (w
== XWINDOW (selected_window
))
1903 posint
= marker_position (w
->pointm
);
1905 /* If position is above window start or outside buffer boundaries,
1906 or if window start is out of range, position is not visible. */
1908 || (posint
>= CHARPOS (top
) && posint
<= BUF_ZV (buf
)))
1909 && CHARPOS (top
) >= BUF_BEGV (buf
)
1910 && CHARPOS (top
) <= BUF_ZV (buf
)
1911 && pos_visible_p (w
, posint
, &x
, &y
, &rtop
, &rbot
, &rowh
, &vpos
)
1912 && (fully_p
= !rtop
&& !rbot
, (!NILP (partially
) || fully_p
)))
1915 if (!NILP (in_window
) && !NILP (partially
))
1917 Lisp_Object part
= Qnil
;
1919 part
= list4i (rtop
, rbot
, rowh
, vpos
);
1920 in_window
= Fcons (make_number (x
),
1921 Fcons (make_number (y
), part
));
1927 DEFUN ("window-line-height", Fwindow_line_height
,
1928 Swindow_line_height
, 0, 2, 0,
1929 doc
: /* Return height in pixels of text line LINE in window WINDOW.
1930 WINDOW must be a live window and defaults to the selected one.
1932 Return height of current line if LINE is omitted or nil. Return height of
1933 header or mode line if LINE is `header-line' or `mode-line'.
1934 Otherwise, LINE is a text line number starting from 0. A negative number
1935 counts from the end of the window.
1937 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
1938 in pixels of the visible part of the line, VPOS and YPOS are the
1939 vertical position in lines and pixels of the line, relative to the top
1940 of the first text line, and OFFBOT is the number of off-window pixels at
1941 the bottom of the text line. If there are off-window pixels at the top
1942 of the (first) text line, YPOS is negative.
1944 Return nil if window display is not up-to-date. In that case, use
1945 `pos-visible-in-window-p' to obtain the information. */)
1946 (Lisp_Object line
, Lisp_Object window
)
1948 register struct window
*w
;
1949 register struct buffer
*b
;
1950 struct glyph_row
*row
, *end_row
;
1954 w
= decode_live_window (window
);
1956 if (noninteractive
|| w
->pseudo_window_p
)
1959 CHECK_BUFFER (w
->contents
);
1960 b
= XBUFFER (w
->contents
);
1962 /* Fail if current matrix is not up-to-date. */
1963 if (!w
->window_end_valid
1964 || windows_or_buffers_changed
1966 || b
->prevent_redisplay_optimizations_p
1967 || window_outdated (w
))
1973 if (i
< 0 || i
>= w
->current_matrix
->nrows
1974 || (row
= MATRIX_ROW (w
->current_matrix
, i
), !row
->enabled_p
))
1976 max_y
= window_text_bottom_y (w
);
1980 if (EQ (line
, Qheader_line
))
1982 if (!WINDOW_WANTS_HEADER_LINE_P (w
))
1984 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
1985 return row
->enabled_p
? list4i (row
->height
, 0, 0, 0) : Qnil
;
1988 if (EQ (line
, Qmode_line
))
1990 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
1991 return (row
->enabled_p
?
1992 list4i (row
->height
,
1993 0, /* not accurate */
1994 (WINDOW_HEADER_LINE_HEIGHT (w
)
1995 + window_text_bottom_y (w
)),
2000 CHECK_NUMBER (line
);
2003 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2004 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2005 max_y
= window_text_bottom_y (w
);
2008 while ((n
< 0 || i
< n
)
2009 && row
<= end_row
&& row
->enabled_p
2010 && row
->y
+ row
->height
< max_y
)
2013 if (row
> end_row
|| !row
->enabled_p
)
2025 crop
= max (0, (row
->y
+ row
->height
) - max_y
);
2026 return list4i (row
->height
+ min (0, row
->y
) - crop
, i
, row
->y
, crop
);
2029 DEFUN ("window-dedicated-p", Fwindow_dedicated_p
, Swindow_dedicated_p
,
2031 doc
: /* Return non-nil when WINDOW is dedicated to its buffer.
2032 More precisely, return the value assigned by the last call of
2033 `set-window-dedicated-p' for WINDOW. Return nil if that function was
2034 never called with WINDOW as its argument, or the value set by that
2035 function was internally reset since its last call. WINDOW must be a
2036 live window and defaults to the selected one.
2038 When a window is dedicated to its buffer, `display-buffer' will refrain
2039 from displaying another buffer in it. `get-lru-window' and
2040 `get-largest-window' treat dedicated windows specially.
2041 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
2042 `kill-buffer' can delete a dedicated window and the containing frame.
2044 Functions like `set-window-buffer' may change the buffer displayed by a
2045 window, unless that window is "strongly" dedicated to its buffer, that
2046 is the value returned by `window-dedicated-p' is t. */)
2047 (Lisp_Object window
)
2049 return decode_live_window (window
)->dedicated
;
2052 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p
,
2053 Sset_window_dedicated_p
, 2, 2, 0,
2054 doc
: /* Mark WINDOW as dedicated according to FLAG.
2055 WINDOW must be a live window and defaults to the selected one. FLAG
2056 non-nil means mark WINDOW as dedicated to its buffer. FLAG nil means
2057 mark WINDOW as non-dedicated. Return FLAG.
2059 When a window is dedicated to its buffer, `display-buffer' will refrain
2060 from displaying another buffer in it. `get-lru-window' and
2061 `get-largest-window' treat dedicated windows specially.
2062 `delete-windows-on', `replace-buffer-in-windows', `quit-window',
2063 `quit-restore-window' and `kill-buffer' can delete a dedicated window
2064 and the containing frame.
2066 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
2067 its buffer. Functions like `set-window-buffer' may change the buffer
2068 displayed by a window, unless that window is strongly dedicated to its
2069 buffer. If and when `set-window-buffer' displays another buffer in a
2070 window, it also makes sure that the window is no more dedicated. */)
2071 (Lisp_Object window
, Lisp_Object flag
)
2073 wset_dedicated (decode_live_window (window
), flag
);
2077 DEFUN ("window-prev-buffers", Fwindow_prev_buffers
, Swindow_prev_buffers
,
2079 doc
: /* Return buffers previously shown in WINDOW.
2080 WINDOW must be a live window and defaults to the selected one.
2082 The return value is a list of elements (BUFFER WINDOW-START POS),
2083 where BUFFER is a buffer, WINDOW-START is the start position of the
2084 window for that buffer, and POS is a window-specific point value. */)
2085 (Lisp_Object window
)
2087 return decode_live_window (window
)->prev_buffers
;
2090 DEFUN ("set-window-prev-buffers", Fset_window_prev_buffers
,
2091 Sset_window_prev_buffers
, 2, 2, 0,
2092 doc
: /* Set WINDOW's previous buffers to PREV-BUFFERS.
2093 WINDOW must be a live window and defaults to the selected one.
2095 PREV-BUFFERS should be a list of elements (BUFFER WINDOW-START POS),
2096 where BUFFER is a buffer, WINDOW-START is the start position of the
2097 window for that buffer, and POS is a window-specific point value. */)
2098 (Lisp_Object window
, Lisp_Object prev_buffers
)
2100 wset_prev_buffers (decode_live_window (window
), prev_buffers
);
2101 return prev_buffers
;
2104 DEFUN ("window-next-buffers", Fwindow_next_buffers
, Swindow_next_buffers
,
2106 doc
: /* Return list of buffers recently re-shown in WINDOW.
2107 WINDOW must be a live window and defaults to the selected one. */)
2108 (Lisp_Object window
)
2110 return decode_live_window (window
)->next_buffers
;
2113 DEFUN ("set-window-next-buffers", Fset_window_next_buffers
,
2114 Sset_window_next_buffers
, 2, 2, 0,
2115 doc
: /* Set WINDOW's next buffers to NEXT-BUFFERS.
2116 WINDOW must be a live window and defaults to the selected one.
2117 NEXT-BUFFERS should be a list of buffers. */)
2118 (Lisp_Object window
, Lisp_Object next_buffers
)
2120 wset_next_buffers (decode_live_window (window
), next_buffers
);
2121 return next_buffers
;
2124 DEFUN ("window-parameters", Fwindow_parameters
, Swindow_parameters
,
2126 doc
: /* Return the parameters of WINDOW and their values.
2127 WINDOW must be a valid window and defaults to the selected one. The
2128 return value is a list of elements of the form (PARAMETER . VALUE). */)
2129 (Lisp_Object window
)
2131 return Fcopy_alist (decode_valid_window (window
)->window_parameters
);
2134 DEFUN ("window-parameter", Fwindow_parameter
, Swindow_parameter
,
2136 doc
: /* Return WINDOW's value for PARAMETER.
2137 WINDOW can be any window and defaults to the selected one. */)
2138 (Lisp_Object window
, Lisp_Object parameter
)
2142 result
= Fassq (parameter
, decode_any_window (window
)->window_parameters
);
2143 return CDR_SAFE (result
);
2146 DEFUN ("set-window-parameter", Fset_window_parameter
,
2147 Sset_window_parameter
, 3, 3, 0,
2148 doc
: /* Set WINDOW's value of PARAMETER to VALUE.
2149 WINDOW can be any window and defaults to the selected one.
2151 (Lisp_Object window
, Lisp_Object parameter
, Lisp_Object value
)
2153 register struct window
*w
= decode_any_window (window
);
2154 Lisp_Object old_alist_elt
;
2156 old_alist_elt
= Fassq (parameter
, w
->window_parameters
);
2157 if (NILP (old_alist_elt
))
2158 wset_window_parameters
2159 (w
, Fcons (Fcons (parameter
, value
), w
->window_parameters
));
2161 Fsetcdr (old_alist_elt
, value
);
2165 DEFUN ("window-display-table", Fwindow_display_table
, Swindow_display_table
,
2167 doc
: /* Return the display-table that WINDOW is using.
2168 WINDOW must be a live window and defaults to the selected one. */)
2169 (Lisp_Object window
)
2171 return decode_live_window (window
)->display_table
;
2174 /* Get the display table for use on window W. This is either W's
2175 display table or W's buffer's display table. Ignore the specified
2176 tables if they are not valid; if no valid table is specified,
2179 struct Lisp_Char_Table
*
2180 window_display_table (struct window
*w
)
2182 struct Lisp_Char_Table
*dp
= NULL
;
2184 if (DISP_TABLE_P (w
->display_table
))
2185 dp
= XCHAR_TABLE (w
->display_table
);
2186 else if (BUFFERP (w
->contents
))
2188 struct buffer
*b
= XBUFFER (w
->contents
);
2190 if (DISP_TABLE_P (BVAR (b
, display_table
)))
2191 dp
= XCHAR_TABLE (BVAR (b
, display_table
));
2192 else if (DISP_TABLE_P (Vstandard_display_table
))
2193 dp
= XCHAR_TABLE (Vstandard_display_table
);
2199 DEFUN ("set-window-display-table", Fset_window_display_table
, Sset_window_display_table
, 2, 2, 0,
2200 doc
: /* Set WINDOW's display-table to TABLE.
2201 WINDOW must be a live window and defaults to the selected one. */)
2202 (register Lisp_Object window
, Lisp_Object table
)
2204 wset_display_table (decode_live_window (window
), table
);
2208 /* Record info on buffer window W is displaying
2209 when it is about to cease to display that buffer. */
2211 unshow_buffer (register struct window
*w
)
2213 Lisp_Object buf
= w
->contents
;
2214 struct buffer
*b
= XBUFFER (buf
);
2216 eassert (b
== XMARKER (w
->pointm
)->buffer
);
2219 if (w
== XWINDOW (selected_window
)
2220 || ! EQ (buf
, XWINDOW (selected_window
)->contents
))
2221 /* Do this except when the selected window's buffer
2222 is being removed from some other window. */
2224 /* last_window_start records the start position that this buffer
2225 had in the last window to be disconnected from it.
2226 Now that this statement is unconditional,
2227 it is possible for the buffer to be displayed in the
2228 selected window, while last_window_start reflects another
2229 window which was recently showing the same buffer.
2230 Some people might say that might be a good thing. Let's see. */
2231 b
->last_window_start
= marker_position (w
->start
);
2233 /* Point in the selected window's buffer
2234 is actually stored in that buffer, and the window's pointm isn't used.
2235 So don't clobber point in that buffer. */
2236 if (! EQ (buf
, XWINDOW (selected_window
)->contents
)
2237 /* Don't clobber point in current buffer either (this could be
2238 useful in connection with bug#12208).
2239 && XBUFFER (buf) != current_buffer */
2240 /* This line helps to fix Horsley's testbug.el bug. */
2241 && !(WINDOWP (BVAR (b
, last_selected_window
))
2242 && w
!= XWINDOW (BVAR (b
, last_selected_window
))
2243 && EQ (buf
, XWINDOW (BVAR (b
, last_selected_window
))->contents
)))
2244 temp_set_point_both (b
,
2245 clip_to_bounds (BUF_BEGV (b
),
2246 marker_position (w
->pointm
),
2248 clip_to_bounds (BUF_BEGV_BYTE (b
),
2249 marker_byte_position (w
->pointm
),
2252 if (WINDOWP (BVAR (b
, last_selected_window
))
2253 && w
== XWINDOW (BVAR (b
, last_selected_window
)))
2254 bset_last_selected_window (b
, Qnil
);
2257 /* Put NEW into the window structure in place of OLD. SETFLAG zero
2258 means change window structure only. Otherwise store geometry and
2259 other settings as well. */
2261 replace_window (Lisp_Object old
, Lisp_Object
new, int setflag
)
2263 register Lisp_Object tem
;
2264 register struct window
*o
= XWINDOW (old
), *n
= XWINDOW (new);
2266 /* If OLD is its frame's root window, then NEW is the new
2267 root window for that frame. */
2268 if (EQ (old
, FRAME_ROOT_WINDOW (XFRAME (o
->frame
))))
2269 fset_root_window (XFRAME (o
->frame
), new);
2273 n
->pixel_left
= o
->pixel_left
;
2274 n
->pixel_top
= o
->pixel_top
;
2275 n
->pixel_width
= o
->pixel_width
;
2276 n
->pixel_height
= o
->pixel_height
;
2277 n
->left_col
= o
->left_col
;
2278 n
->top_line
= o
->top_line
;
2279 n
->total_cols
= o
->total_cols
;
2280 n
->total_lines
= o
->total_lines
;
2281 wset_normal_cols (n
, o
->normal_cols
);
2282 wset_normal_cols (o
, make_float (1.0));
2283 wset_normal_lines (n
, o
->normal_lines
);
2284 wset_normal_lines (o
, make_float (1.0));
2285 n
->desired_matrix
= n
->current_matrix
= 0;
2287 memset (&n
->cursor
, 0, sizeof (n
->cursor
));
2288 memset (&n
->phys_cursor
, 0, sizeof (n
->phys_cursor
));
2289 n
->last_cursor_vpos
= 0;
2290 #ifdef HAVE_WINDOW_SYSTEM
2291 n
->phys_cursor_type
= NO_CURSOR
;
2292 n
->phys_cursor_width
= -1;
2294 n
->must_be_updated_p
= 0;
2295 n
->pseudo_window_p
= 0;
2296 n
->window_end_vpos
= 0;
2297 n
->window_end_pos
= 0;
2298 n
->window_end_valid
= 0;
2304 wset_prev (XWINDOW (tem
), new);
2309 wset_next (XWINDOW (tem
), new);
2312 wset_parent (n
, tem
);
2313 if (!NILP (tem
) && EQ (XWINDOW (tem
)->contents
, old
))
2314 wset_combination (XWINDOW (tem
), XWINDOW (tem
)->horizontal
, new);
2317 /* If window WINDOW and its parent window are iso-combined, merge
2318 WINDOW's children into those of its parent window and mark WINDOW as
2322 recombine_windows (Lisp_Object window
)
2324 struct window
*w
, *p
, *c
;
2325 Lisp_Object parent
, child
;
2328 w
= XWINDOW (window
);
2330 if (!NILP (parent
) && NILP (w
->combination_limit
))
2332 p
= XWINDOW (parent
);
2333 if (WINDOWP (p
->contents
) && WINDOWP (w
->contents
)
2334 && p
->horizontal
== w
->horizontal
)
2335 /* WINDOW and PARENT are both either a vertical or a horizontal
2338 horflag
= WINDOW_HORIZONTAL_COMBINATION_P (w
);
2339 child
= w
->contents
;
2340 c
= XWINDOW (child
);
2342 /* Splice WINDOW's children into its parent's children and
2343 assign new normal sizes. */
2345 wset_combination (p
, horflag
, child
);
2348 wset_prev (c
, w
->prev
);
2349 wset_next (XWINDOW (w
->prev
), child
);
2354 wset_parent (c
, parent
);
2358 (c
, make_float ((double) c
->pixel_width
2359 / (double) p
->pixel_width
));
2362 (c
, make_float ((double) c
->pixel_height
2363 / (double) p
->pixel_height
));
2367 if (!NILP (w
->next
))
2369 wset_next (c
, w
->next
);
2370 wset_prev (XWINDOW (c
->next
), child
);
2378 c
= XWINDOW (child
);
2382 /* WINDOW can be deleted now. */
2383 wset_combination (w
, 0, Qnil
);
2388 /* If WINDOW can be deleted, delete it. */
2390 delete_deletable_window (Lisp_Object window
)
2392 if (!NILP (call1 (Qwindow_deletable_p
, window
)))
2393 call1 (Qdelete_window
, window
);
2396 /***********************************************************************
2398 ***********************************************************************/
2400 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
2401 pointer. This is a callback function for foreach_window, used in
2402 the window_list function. */
2405 add_window_to_list (struct window
*w
, void *user_data
)
2407 Lisp_Object
*list
= user_data
;
2409 XSETWINDOW (window
, w
);
2410 *list
= Fcons (window
, *list
);
2415 /* Return a list of all windows, for use by next_window. If
2416 Vwindow_list is a list, return that list. Otherwise, build a new
2417 list, cache it in Vwindow_list, and return that. */
2422 if (!CONSP (Vwindow_list
))
2424 Lisp_Object tail
, frame
;
2426 Vwindow_list
= Qnil
;
2427 FOR_EACH_FRAME (tail
, frame
)
2429 Lisp_Object arglist
= Qnil
;
2431 /* We are visiting windows in canonical order, and add
2432 new windows at the front of args[1], which means we
2433 have to reverse this list at the end. */
2434 foreach_window (XFRAME (frame
), add_window_to_list
, &arglist
);
2435 arglist
= Fnreverse (arglist
);
2436 Vwindow_list
= CALLN (Fnconc
, Vwindow_list
, arglist
);
2440 return Vwindow_list
;
2444 /* Value is non-zero if WINDOW satisfies the constraints given by
2445 OWINDOW, MINIBUF and ALL_FRAMES.
2447 MINIBUF t means WINDOW may be minibuffer windows.
2448 `lambda' means WINDOW may not be a minibuffer window.
2449 a window means a specific minibuffer window
2451 ALL_FRAMES t means search all frames,
2452 nil means search just current frame,
2453 `visible' means search just visible frames on the
2455 0 means search visible and iconified frames on the
2457 a window means search the frame that window belongs to,
2458 a frame means consider windows on that frame, only. */
2461 candidate_window_p (Lisp_Object window
, Lisp_Object owindow
,
2462 Lisp_Object minibuf
, Lisp_Object all_frames
)
2464 struct window
*w
= XWINDOW (window
);
2465 struct frame
*f
= XFRAME (w
->frame
);
2466 bool candidate_p
= 1;
2468 if (!BUFFERP (w
->contents
))
2470 else if (MINI_WINDOW_P (w
)
2471 && (EQ (minibuf
, Qlambda
)
2472 || (WINDOWP (minibuf
) && !EQ (minibuf
, window
))))
2474 /* If MINIBUF is `lambda' don't consider any mini-windows.
2475 If it is a window, consider only that one. */
2478 else if (EQ (all_frames
, Qt
))
2480 else if (NILP (all_frames
))
2482 eassert (WINDOWP (owindow
));
2483 candidate_p
= EQ (w
->frame
, XWINDOW (owindow
)->frame
);
2485 else if (EQ (all_frames
, Qvisible
))
2487 candidate_p
= FRAME_VISIBLE_P (f
)
2488 && (FRAME_TERMINAL (XFRAME (w
->frame
))
2489 == FRAME_TERMINAL (XFRAME (selected_frame
)));
2492 else if (INTEGERP (all_frames
) && XINT (all_frames
) == 0)
2494 candidate_p
= (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)
2495 #ifdef HAVE_X_WINDOWS
2496 /* Yuck!! If we've just created the frame and the
2497 window-manager requested the user to place it
2498 manually, the window may still not be considered
2499 `visible'. I'd argue it should be at least
2500 something like `iconified', but don't know how to do
2502 || (FRAME_X_P (f
) && f
->output_data
.x
->asked_for_visible
2503 && !f
->output_data
.x
->has_been_visible
)
2506 && (FRAME_TERMINAL (XFRAME (w
->frame
))
2507 == FRAME_TERMINAL (XFRAME (selected_frame
)));
2509 else if (WINDOWP (all_frames
))
2510 candidate_p
= (EQ (FRAME_MINIBUF_WINDOW (f
), all_frames
)
2511 || EQ (XWINDOW (all_frames
)->frame
, w
->frame
)
2512 || EQ (XWINDOW (all_frames
)->frame
, FRAME_FOCUS_FRAME (f
)));
2513 else if (FRAMEP (all_frames
))
2514 candidate_p
= EQ (all_frames
, w
->frame
);
2520 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
2521 Fwindow_list. See candidate_window_p for the meaning of WINDOW,
2522 MINIBUF, and ALL_FRAMES. */
2525 decode_next_window_args (Lisp_Object
*window
, Lisp_Object
*minibuf
, Lisp_Object
*all_frames
)
2527 struct window
*w
= decode_live_window (*window
);
2529 XSETWINDOW (*window
, w
);
2530 /* MINIBUF nil may or may not include minibuffers. Decide if it
2532 if (NILP (*minibuf
))
2533 *minibuf
= minibuf_level
? minibuf_window
: Qlambda
;
2534 else if (!EQ (*minibuf
, Qt
))
2537 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
2538 => count none of them, or a specific minibuffer window (the
2539 active one) to count. */
2541 /* ALL_FRAMES nil doesn't specify which frames to include. */
2542 if (NILP (*all_frames
))
2544 = (!EQ (*minibuf
, Qlambda
)
2545 ? FRAME_MINIBUF_WINDOW (XFRAME (w
->frame
))
2547 else if (EQ (*all_frames
, Qvisible
))
2549 else if (EQ (*all_frames
, make_number (0)))
2551 else if (FRAMEP (*all_frames
))
2553 else if (!EQ (*all_frames
, Qt
))
2558 /* Return the next or previous window of WINDOW in cyclic ordering
2559 of windows. NEXT_P non-zero means return the next window. See the
2560 documentation string of next-window for the meaning of MINIBUF and
2564 next_window (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
, int next_p
)
2566 decode_next_window_args (&window
, &minibuf
, &all_frames
);
2568 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
2569 return the first window on the frame. */
2570 if (FRAMEP (all_frames
)
2571 && !EQ (all_frames
, XWINDOW (window
)->frame
))
2572 return Fframe_first_window (all_frames
);
2578 /* Find WINDOW in the list of all windows. */
2579 list
= Fmemq (window
, window_list ());
2581 /* Scan forward from WINDOW to the end of the window list. */
2583 for (list
= XCDR (list
); CONSP (list
); list
= XCDR (list
))
2584 if (candidate_window_p (XCAR (list
), window
, minibuf
, all_frames
))
2587 /* Scan from the start of the window list up to WINDOW. */
2589 for (list
= Vwindow_list
;
2590 CONSP (list
) && !EQ (XCAR (list
), window
);
2592 if (candidate_window_p (XCAR (list
), window
, minibuf
, all_frames
))
2596 window
= XCAR (list
);
2600 Lisp_Object candidate
, list
;
2602 /* Scan through the list of windows for candidates. If there are
2603 candidate windows in front of WINDOW, the last one of these
2604 is the one we want. If there are candidates following WINDOW
2605 in the list, again the last one of these is the one we want. */
2607 for (list
= window_list (); CONSP (list
); list
= XCDR (list
))
2609 if (EQ (XCAR (list
), window
))
2611 if (WINDOWP (candidate
))
2614 else if (candidate_window_p (XCAR (list
), window
, minibuf
,
2616 candidate
= XCAR (list
);
2619 if (WINDOWP (candidate
))
2627 DEFUN ("next-window", Fnext_window
, Snext_window
, 0, 3, 0,
2628 doc
: /* Return live window after WINDOW in the cyclic ordering of windows.
2629 WINDOW must be a live window and defaults to the selected one. The
2630 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2633 MINIBUF nil or omitted means consider the minibuffer window only if the
2634 minibuffer is active. MINIBUF t means consider the minibuffer window
2635 even if the minibuffer is not active. Any other value means do not
2636 consider the minibuffer window even if the minibuffer is active.
2638 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2639 plus the minibuffer window if specified by the MINIBUF argument. If the
2640 minibuffer counts, consider all windows on all frames that share that
2641 minibuffer too. The following non-nil values of ALL-FRAMES have special
2644 - t means consider all windows on all existing frames.
2646 - `visible' means consider all windows on all visible frames.
2648 - 0 (the number zero) means consider all windows on all visible and
2651 - A frame means consider all windows on that frame only.
2653 Anything else means consider all windows on WINDOW's frame and no
2656 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2657 `next-window' to iterate through the entire cycle of acceptable
2658 windows, eventually ending up back at the window you started with.
2659 `previous-window' traverses the same cycle, in the reverse order. */)
2660 (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2662 return next_window (window
, minibuf
, all_frames
, 1);
2666 DEFUN ("previous-window", Fprevious_window
, Sprevious_window
, 0, 3, 0,
2667 doc
: /* Return live window before WINDOW in the cyclic ordering of windows.
2668 WINDOW must be a live window and defaults to the selected one. The
2669 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2672 MINIBUF nil or omitted means consider the minibuffer window only if the
2673 minibuffer is active. MINIBUF t means consider the minibuffer window
2674 even if the minibuffer is not active. Any other value means do not
2675 consider the minibuffer window even if the minibuffer is active.
2677 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2678 plus the minibuffer window if specified by the MINIBUF argument. If the
2679 minibuffer counts, consider all windows on all frames that share that
2680 minibuffer too. The following non-nil values of ALL-FRAMES have special
2683 - t means consider all windows on all existing frames.
2685 - `visible' means consider all windows on all visible frames.
2687 - 0 (the number zero) means consider all windows on all visible and
2690 - A frame means consider all windows on that frame only.
2692 Anything else means consider all windows on WINDOW's frame and no
2695 If you use consistent values for MINIBUF and ALL-FRAMES, you can
2696 use `previous-window' to iterate through the entire cycle of
2697 acceptable windows, eventually ending up back at the window you
2698 started with. `next-window' traverses the same cycle, in the
2700 (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2702 return next_window (window
, minibuf
, all_frames
, 0);
2706 /* Return a list of windows in cyclic ordering. Arguments are like
2707 for `next-window'. */
2710 window_list_1 (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2712 Lisp_Object tail
, list
, rest
;
2714 decode_next_window_args (&window
, &minibuf
, &all_frames
);
2717 for (tail
= window_list (); CONSP (tail
); tail
= XCDR (tail
))
2718 if (candidate_window_p (XCAR (tail
), window
, minibuf
, all_frames
))
2719 list
= Fcons (XCAR (tail
), list
);
2721 /* Rotate the list to start with WINDOW. */
2722 list
= Fnreverse (list
);
2723 rest
= Fmemq (window
, list
);
2724 if (!NILP (rest
) && !EQ (rest
, list
))
2726 for (tail
= list
; !EQ (XCDR (tail
), rest
); tail
= XCDR (tail
))
2728 XSETCDR (tail
, Qnil
);
2729 list
= nconc2 (rest
, list
);
2735 DEFUN ("window-list", Fwindow_list
, Swindow_list
, 0, 3, 0,
2736 doc
: /* Return a list of windows on FRAME, starting with WINDOW.
2737 FRAME nil or omitted means use the selected frame.
2738 WINDOW nil or omitted means use the window selected within FRAME.
2739 MINIBUF t means include the minibuffer window, even if it isn't active.
2740 MINIBUF nil or omitted means include the minibuffer window only
2742 MINIBUF neither nil nor t means never include the minibuffer window. */)
2743 (Lisp_Object frame
, Lisp_Object minibuf
, Lisp_Object window
)
2746 window
= FRAMEP (frame
) ? XFRAME (frame
)->selected_window
: selected_window
;
2747 CHECK_WINDOW (window
);
2749 frame
= selected_frame
;
2751 if (!EQ (frame
, XWINDOW (window
)->frame
))
2752 error ("Window is on a different frame");
2754 return window_list_1 (window
, minibuf
, frame
);
2758 DEFUN ("window-list-1", Fwindow_list_1
, Swindow_list_1
, 0, 3, 0,
2759 doc
: /* Return a list of all live windows.
2760 WINDOW specifies the first window to list and defaults to the selected
2763 Optional argument MINIBUF nil or omitted means consider the minibuffer
2764 window only if the minibuffer is active. MINIBUF t means consider the
2765 minibuffer window even if the minibuffer is not active. Any other value
2766 means do not consider the minibuffer window even if the minibuffer is
2769 Optional argument ALL-FRAMES nil or omitted means consider all windows
2770 on WINDOW's frame, plus the minibuffer window if specified by the
2771 MINIBUF argument. If the minibuffer counts, consider all windows on all
2772 frames that share that minibuffer too. The following non-nil values of
2773 ALL-FRAMES have special meanings:
2775 - t means consider all windows on all existing frames.
2777 - `visible' means consider all windows on all visible frames.
2779 - 0 (the number zero) means consider all windows on all visible and
2782 - A frame means consider all windows on that frame only.
2784 Anything else means consider all windows on WINDOW's frame and no
2787 If WINDOW is not on the list of windows returned, some other window will
2788 be listed first but no error is signaled. */)
2789 (Lisp_Object window
, Lisp_Object minibuf
, Lisp_Object all_frames
)
2791 return window_list_1 (window
, minibuf
, all_frames
);
2794 /* Look at all windows, performing an operation specified by TYPE
2796 If FRAMES is Qt, look at all frames;
2797 Qnil, look at just the selected frame;
2798 Qvisible, look at visible frames;
2799 a frame, just look at windows on that frame.
2800 If MINI is non-zero, perform the operation on minibuffer windows too. */
2805 GET_BUFFER_WINDOW
, /* Arg is buffer */
2806 REPLACE_BUFFER_IN_WINDOWS_SAFELY
, /* Arg is buffer */
2807 REDISPLAY_BUFFER_WINDOWS
, /* Arg is buffer */
2808 CHECK_ALL_WINDOWS
/* Arg is ignored */
2812 window_loop (enum window_loop type
, Lisp_Object obj
, int mini
, Lisp_Object frames
)
2814 Lisp_Object window
, windows
, best_window
, frame_arg
;
2815 int frame_best_window_flag
= 0;
2817 struct gcpro gcpro1
;
2819 /* If we're only looping through windows on a particular frame,
2820 frame points to that frame. If we're looping through windows
2821 on all frames, frame is 0. */
2822 if (FRAMEP (frames
))
2823 f
= XFRAME (frames
);
2824 else if (NILP (frames
))
2825 f
= SELECTED_FRAME ();
2830 frame_arg
= Qlambda
;
2831 else if (EQ (frames
, make_number (0)))
2833 else if (EQ (frames
, Qvisible
))
2838 /* frame_arg is Qlambda to stick to one frame,
2839 Qvisible to consider all visible frames,
2842 /* Pick a window to start with. */
2846 window
= FRAME_SELECTED_WINDOW (f
);
2848 window
= FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2850 windows
= window_list_1 (window
, mini
? Qt
: Qnil
, frame_arg
);
2854 for (; CONSP (windows
); windows
= XCDR (windows
))
2858 window
= XCAR (windows
);
2859 w
= XWINDOW (window
);
2861 /* Note that we do not pay attention here to whether the frame
2862 is visible, since Fwindow_list skips non-visible frames if
2863 that is desired, under the control of frame_arg. */
2864 if (!MINI_WINDOW_P (w
)
2865 /* For REPLACE_BUFFER_IN_WINDOWS_SAFELY, we must always
2866 consider all windows. */
2867 || type
== REPLACE_BUFFER_IN_WINDOWS_SAFELY
2868 || (mini
&& minibuf_level
> 0))
2871 case GET_BUFFER_WINDOW
:
2872 if (EQ (w
->contents
, obj
)
2873 /* Don't find any minibuffer window except the one that
2874 is currently in use. */
2875 && (MINI_WINDOW_P (w
) ? EQ (window
, minibuf_window
) : 1))
2877 if (EQ (window
, selected_window
))
2878 /* Preferably return the selected window. */
2879 RETURN_UNGCPRO (window
);
2880 else if (EQ (XWINDOW (window
)->frame
, selected_frame
)
2881 && !frame_best_window_flag
)
2882 /* Prefer windows on the current frame (but don't
2883 choose another one if we have one already). */
2885 best_window
= window
;
2886 frame_best_window_flag
= 1;
2888 else if (NILP (best_window
))
2889 best_window
= window
;
2893 case REPLACE_BUFFER_IN_WINDOWS_SAFELY
:
2894 /* We could simply check whether the buffer shown by window
2895 is live, and show another buffer in case it isn't. */
2896 if (EQ (w
->contents
, obj
))
2898 /* Undedicate WINDOW. */
2899 wset_dedicated (w
, Qnil
);
2900 /* Make WINDOW show the buffer returned by
2901 other_buffer_safely, don't run any hooks. */
2903 (window
, other_buffer_safely (w
->contents
), 0, 0);
2904 /* If WINDOW is the selected window, make its buffer
2905 current. But do so only if the window shows the
2906 current buffer (Bug#6454). */
2907 if (EQ (window
, selected_window
)
2908 && XBUFFER (w
->contents
) == current_buffer
)
2909 Fset_buffer (w
->contents
);
2913 case REDISPLAY_BUFFER_WINDOWS
:
2914 if (EQ (w
->contents
, obj
))
2916 mark_window_display_accurate (window
, 0);
2917 w
->update_mode_line
= 1;
2918 XBUFFER (obj
)->prevent_redisplay_optimizations_p
= 1;
2919 update_mode_lines
= 27;
2920 best_window
= window
;
2924 /* Check for a leaf window that has a killed buffer
2925 or broken markers. */
2926 case CHECK_ALL_WINDOWS
:
2927 if (BUFFERP (w
->contents
))
2929 struct buffer
*b
= XBUFFER (w
->contents
);
2931 if (!BUFFER_LIVE_P (b
))
2933 if (!MARKERP (w
->start
) || XMARKER (w
->start
)->buffer
!= b
)
2935 if (!MARKERP (w
->pointm
) || XMARKER (w
->pointm
)->buffer
!= b
)
2940 case WINDOW_LOOP_UNUSED
:
2949 /* Used for debugging. Abort if any window has a dead buffer. */
2951 extern void check_all_windows (void) EXTERNALLY_VISIBLE
;
2953 check_all_windows (void)
2955 window_loop (CHECK_ALL_WINDOWS
, Qnil
, 1, Qt
);
2958 DEFUN ("get-buffer-window", Fget_buffer_window
, Sget_buffer_window
, 0, 2, 0,
2959 doc
: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2960 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to
2963 The optional argument ALL-FRAMES specifies the frames to consider:
2965 - t means consider all windows on all existing frames.
2967 - `visible' means consider all windows on all visible frames.
2969 - 0 (the number zero) means consider all windows on all visible
2970 and iconified frames.
2972 - A frame means consider all windows on that frame only.
2974 Any other value of ALL-FRAMES means consider all windows on the
2975 selected frame and no others. */)
2976 (Lisp_Object buffer_or_name
, Lisp_Object all_frames
)
2980 if (NILP (buffer_or_name
))
2981 buffer
= Fcurrent_buffer ();
2983 buffer
= Fget_buffer (buffer_or_name
);
2985 if (BUFFERP (buffer
))
2986 return window_loop (GET_BUFFER_WINDOW
, buffer
, 1, all_frames
);
2993 resize_root_window (Lisp_Object window
, Lisp_Object delta
, Lisp_Object horizontal
, Lisp_Object ignore
, Lisp_Object pixelwise
)
2995 return call5 (Qwindow_resize_root_window
, window
, delta
, horizontal
, ignore
, pixelwise
);
2998 /* Placeholder used by temacs -nw before window.el is loaded. */
2999 DEFUN ("window--sanitize-window-sizes", Fwindow__sanitize_window_sizes
,
3000 Swindow__sanitize_window_sizes
, 2, 2, 0,
3003 (Lisp_Object frame
, Lisp_Object horizontal
)
3009 sanitize_window_sizes (Lisp_Object frame
, Lisp_Object horizontal
)
3011 return call2 (Qwindow_sanitize_window_sizes
, frame
, horizontal
);
3016 window_pixel_to_total (Lisp_Object frame
, Lisp_Object horizontal
)
3018 return call2 (Qwindow_pixel_to_total
, frame
, horizontal
);
3022 DEFUN ("delete-other-windows-internal", Fdelete_other_windows_internal
,
3023 Sdelete_other_windows_internal
, 0, 2, "",
3024 doc
: /* Make WINDOW fill its frame.
3025 Only the frame WINDOW is on is affected. WINDOW must be a valid window
3026 and defaults to the selected one.
3028 Optional argument ROOT, if non-nil, must specify an internal window such
3029 that WINDOW is in its window subtree. If this is the case, replace ROOT
3030 by WINDOW and leave alone any windows not part of ROOT's subtree.
3032 When WINDOW is live try to reduce display jumps by keeping the text
3033 previously visible in WINDOW in the same place on the frame. Doing this
3034 depends on the value of (window-start WINDOW), so if calling this
3035 function in a program gives strange scrolling, make sure the
3036 window-start value is reasonable when this function is called. */)
3037 (Lisp_Object window
, Lisp_Object root
)
3039 struct window
*w
, *r
, *s
;
3041 Lisp_Object sibling
, pwindow
, swindow
IF_LINT (= Qnil
), delta
;
3042 ptrdiff_t startpos
IF_LINT (= 0), startbyte
IF_LINT (= 0);
3043 int top
IF_LINT (= 0), new_top
, resize_failed
;
3045 w
= decode_valid_window (window
);
3046 XSETWINDOW (window
, w
);
3047 f
= XFRAME (w
->frame
);
3050 /* ROOT is the frame's root window. */
3052 root
= FRAME_ROOT_WINDOW (f
);
3056 /* ROOT must be an ancestor of WINDOW. */
3058 r
= decode_valid_window (root
);
3059 pwindow
= XWINDOW (window
)->parent
;
3060 while (!NILP (pwindow
))
3061 if (EQ (pwindow
, root
))
3064 pwindow
= XWINDOW (pwindow
)->parent
;
3065 if (!EQ (pwindow
, root
))
3066 error ("Specified root is not an ancestor of specified window");
3069 if (EQ (window
, root
))
3072 /* I don't understand the "top > 0" part below. If we deal with a
3073 standalone minibuffer it would have been caught by the preceding
3075 else if (MINI_WINDOW_P (w
)) /* && top > 0) */
3076 error ("Can't expand minibuffer to full frame");
3078 if (BUFFERP (w
->contents
))
3080 startpos
= marker_position (w
->start
);
3081 startbyte
= marker_byte_position (w
->start
);
3082 top
= (WINDOW_TOP_EDGE_LINE (w
)
3083 - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w
))));
3084 /* Make sure WINDOW is the frame's selected window. */
3085 if (!EQ (window
, FRAME_SELECTED_WINDOW (f
)))
3087 if (EQ (selected_frame
, w
->frame
))
3088 Fselect_window (window
, Qnil
);
3090 fset_selected_window (f
, window
);
3095 /* See if the frame's selected window is a part of the window
3096 subtree rooted at WINDOW, by finding all the selected window's
3097 parents and comparing each one with WINDOW. If it isn't we
3098 need a new selected window for this frame. */
3099 swindow
= FRAME_SELECTED_WINDOW (f
);
3103 while (!NILP (pwindow
) && !EQ (window
, pwindow
))
3104 pwindow
= XWINDOW (pwindow
)->parent
;
3106 if (EQ (window
, pwindow
))
3107 /* If WINDOW is an ancestor of SWINDOW, then SWINDOW is ok
3108 as the new selected window. */
3111 /* Else try the previous window of SWINDOW. */
3112 swindow
= Fprevious_window (swindow
, Qlambda
, Qnil
);
3115 if (!EQ (swindow
, FRAME_SELECTED_WINDOW (f
)))
3117 if (EQ (selected_frame
, w
->frame
))
3118 Fselect_window (swindow
, Qnil
);
3120 fset_selected_window (f
, swindow
);
3125 if (!FRAME_INITIAL_P (f
))
3127 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
3129 /* We are going to free the glyph matrices of WINDOW, and with
3130 that we might lose any information about glyph rows that have
3131 some of their glyphs highlighted in mouse face. (These rows
3132 are marked with a non-zero mouse_face_p flag.) If WINDOW
3133 indeed has some glyphs highlighted in mouse face, signal to
3134 frame's up-to-date hook that mouse highlight was overwritten,
3135 so that it will arrange for redisplaying the highlight. */
3136 if (EQ (hlinfo
->mouse_face_window
, window
))
3137 reset_mouse_highlight (hlinfo
);
3139 free_window_matrices (r
);
3142 Vwindow_list
= Qnil
;
3143 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
3146 if (!WINDOW_LEAF_P (w
))
3148 /* Resize child windows vertically. */
3149 XSETINT (delta
, r
->pixel_height
- w
->pixel_height
);
3150 w
->pixel_top
= r
->pixel_top
;
3151 w
->top_line
= r
->top_line
;
3152 resize_root_window (window
, delta
, Qnil
, Qnil
, Qt
);
3153 if (window_resize_check (w
, 0))
3155 window_resize_apply (w
, 0);
3156 window_pixel_to_total (w
->frame
, Qnil
);
3160 resize_root_window (window
, delta
, Qnil
, Qt
, Qt
);
3161 if (window_resize_check (w
, 0))
3163 window_resize_apply (w
, 0);
3164 window_pixel_to_total (w
->frame
, Qnil
);
3170 /* Resize child windows horizontally. */
3173 w
->left_col
= r
->left_col
;
3174 w
->pixel_left
= r
->pixel_left
;
3175 XSETINT (delta
, r
->pixel_width
- w
->pixel_width
);
3176 resize_root_window (window
, delta
, Qt
, Qnil
, Qt
);
3177 if (window_resize_check (w
, 1))
3179 window_resize_apply (w
, 1);
3180 window_pixel_to_total (w
->frame
, Qt
);
3184 resize_root_window (window
, delta
, Qt
, Qt
, Qt
);
3185 if (window_resize_check (w
, 1))
3187 window_resize_apply (w
, 1);
3188 window_pixel_to_total (w
->frame
, Qt
);
3196 /* Play safe, if we still can ... */
3199 w
= XWINDOW (window
);
3203 /* Cleanly unlink WINDOW from window-tree. */
3204 if (!NILP (w
->prev
))
3205 /* Get SIBLING above (on the left of) WINDOW. */
3208 s
= XWINDOW (sibling
);
3209 wset_next (s
, w
->next
);
3210 if (!NILP (s
->next
))
3211 wset_prev (XWINDOW (s
->next
), sibling
);
3214 /* Get SIBLING below (on the right of) WINDOW. */
3217 s
= XWINDOW (sibling
);
3218 wset_prev (s
, Qnil
);
3219 wset_combination (XWINDOW (w
->parent
),
3220 XWINDOW (w
->parent
)->horizontal
, sibling
);
3223 /* Delete ROOT and all child windows of ROOT. */
3224 if (WINDOWP (r
->contents
))
3226 delete_all_child_windows (r
->contents
);
3227 wset_combination (r
, 0, Qnil
);
3230 replace_window (root
, window
, 1);
3232 /* This must become SWINDOW anyway ....... */
3233 if (BUFFERP (w
->contents
) && !resize_failed
)
3235 /* Try to minimize scrolling, by setting the window start to the
3236 point will cause the text at the old window start to be at the
3237 same place on the frame. But don't try to do this if the
3238 window start is outside the visible portion (as might happen
3239 when the display is not current, due to typeahead). */
3240 new_top
= WINDOW_TOP_EDGE_LINE (w
) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w
)));
3242 && startpos
>= BUF_BEGV (XBUFFER (w
->contents
))
3243 && startpos
<= BUF_ZV (XBUFFER (w
->contents
)))
3245 struct position pos
;
3246 struct buffer
*obuf
= current_buffer
;
3248 Fset_buffer (w
->contents
);
3249 /* This computation used to temporarily move point, but that
3250 can have unwanted side effects due to text properties. */
3251 pos
= *vmotion (startpos
, startbyte
, -top
, w
);
3253 set_marker_both (w
->start
, w
->contents
, pos
.bufpos
, pos
.bytepos
);
3254 w
->window_end_valid
= 0;
3255 w
->start_at_line_beg
= (pos
.bytepos
== BEGV_BYTE
3256 || FETCH_BYTE (pos
.bytepos
- 1) == '\n');
3257 /* We need to do this, so that the window-scroll-functions
3259 w
->optional_new_start
= 1;
3261 set_buffer_internal (obuf
);
3265 adjust_frame_glyphs (f
);
3268 run_window_configuration_change_hook (f
);
3275 replace_buffer_in_windows (Lisp_Object buffer
)
3277 call1 (Qreplace_buffer_in_windows
, buffer
);
3280 /* If BUFFER is shown in a window, safely replace it with some other
3281 buffer in all windows of all frames, even those on other keyboards. */
3284 replace_buffer_in_windows_safely (Lisp_Object buffer
)
3286 if (buffer_window_count (XBUFFER (buffer
)))
3288 Lisp_Object tail
, frame
;
3290 /* A single call to window_loop won't do the job because it only
3291 considers frames on the current keyboard. So loop manually over
3292 frames, and handle each one. */
3293 FOR_EACH_FRAME (tail
, frame
)
3294 window_loop (REPLACE_BUFFER_IN_WINDOWS_SAFELY
, buffer
, 1, frame
);
3298 /* The following three routines are needed for running a window's
3299 configuration change hook. */
3301 run_funs (Lisp_Object funs
)
3303 for (; CONSP (funs
); funs
= XCDR (funs
))
3304 if (!EQ (XCAR (funs
), Qt
))
3305 call0 (XCAR (funs
));
3309 select_window_norecord (Lisp_Object window
)
3311 if (WINDOW_LIVE_P (window
))
3312 Fselect_window (window
, Qt
);
3316 select_frame_norecord (Lisp_Object frame
)
3318 if (FRAME_LIVE_P (XFRAME (frame
)))
3319 Fselect_frame (frame
, Qt
);
3323 run_window_configuration_change_hook (struct frame
*f
)
3325 ptrdiff_t count
= SPECPDL_INDEX ();
3326 Lisp_Object frame
, global_wcch
3327 = Fdefault_value (Qwindow_configuration_change_hook
);
3328 XSETFRAME (frame
, f
);
3330 if (NILP (Vrun_hooks
)
3331 || !(f
->can_x_set_window_size
)
3332 || !(f
->after_make_frame
))
3335 /* Use the right buffer. Matters when running the local hooks. */
3336 if (current_buffer
!= XBUFFER (Fwindow_buffer (Qnil
)))
3338 record_unwind_current_buffer ();
3339 Fset_buffer (Fwindow_buffer (Qnil
));
3342 if (SELECTED_FRAME () != f
)
3344 record_unwind_protect (select_frame_norecord
, selected_frame
);
3345 select_frame_norecord (frame
);
3348 /* Look for buffer-local values. */
3350 Lisp_Object windows
= Fwindow_list (frame
, Qlambda
, Qnil
);
3351 for (; CONSP (windows
); windows
= XCDR (windows
))
3353 Lisp_Object window
= XCAR (windows
);
3354 Lisp_Object buffer
= Fwindow_buffer (window
);
3355 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook
,
3358 ptrdiff_t inner_count
= SPECPDL_INDEX ();
3359 record_unwind_protect (select_window_norecord
, selected_window
);
3360 select_window_norecord (window
);
3361 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook
,
3363 unbind_to (inner_count
, Qnil
);
3368 run_funs (global_wcch
);
3369 unbind_to (count
, Qnil
);
3372 DEFUN ("run-window-configuration-change-hook", Frun_window_configuration_change_hook
,
3373 Srun_window_configuration_change_hook
, 0, 1, 0,
3374 doc
: /* Run `window-configuration-change-hook' for FRAME.
3375 If FRAME is omitted or nil, it defaults to the selected frame. */)
3378 run_window_configuration_change_hook (decode_live_frame (frame
));
3382 DEFUN ("run-window-scroll-functions", Frun_window_scroll_functions
,
3383 Srun_window_scroll_functions
, 0, 1, 0,
3384 doc
: /* Run `window-scroll-functions' for WINDOW.
3385 If WINDOW is omitted or nil, it defaults to the selected window. */)
3386 (Lisp_Object window
)
3388 if (! NILP (Vwindow_scroll_functions
))
3389 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
3390 Fmarker_position (decode_live_window (window
)->start
));
3394 /* Make WINDOW display BUFFER. RUN_HOOKS_P non-zero means it's allowed
3395 to run hooks. See make_frame for a case where it's not allowed.
3396 KEEP_MARGINS_P non-zero means that the current margins, fringes, and
3397 scroll-bar settings of the window are not reset from the buffer's
3401 set_window_buffer (Lisp_Object window
, Lisp_Object buffer
,
3402 bool run_hooks_p
, bool keep_margins_p
)
3404 struct window
*w
= XWINDOW (window
);
3405 struct buffer
*b
= XBUFFER (buffer
);
3406 ptrdiff_t count
= SPECPDL_INDEX ();
3407 bool samebuf
= EQ (buffer
, w
->contents
);
3409 wset_buffer (w
, buffer
);
3411 if (EQ (window
, selected_window
))
3412 bset_last_selected_window (b
, window
);
3414 /* Let redisplay errors through. */
3415 b
->display_error_modiff
= 0;
3417 /* Update time stamps of buffer display. */
3418 if (INTEGERP (BVAR (b
, display_count
)))
3419 bset_display_count (b
, make_number (XINT (BVAR (b
, display_count
)) + 1));
3420 bset_display_time (b
, Fcurrent_time ());
3422 w
->window_end_pos
= 0;
3423 w
->window_end_vpos
= 0;
3424 w
->last_cursor_vpos
= 0;
3426 if (!(keep_margins_p
&& samebuf
))
3427 { /* If we're not actually changing the buffer, don't reset hscroll
3428 and vscroll. This case happens for example when called from
3429 change_frame_size_1, where we use a dummy call to
3430 Fset_window_buffer on the frame's selected window (and no
3431 other) just in order to run window-configuration-change-hook
3432 (no longer true since change_frame_size_1 directly calls
3433 run_window_configuration_change_hook). Resetting hscroll and
3434 vscroll here is problematic for things like image-mode and
3435 doc-view-mode since it resets the image's position whenever we
3436 resize the frame. */
3437 w
->hscroll
= w
->min_hscroll
= w
->hscroll_whole
= 0;
3438 w
->suspend_auto_hscroll
= 0;
3440 set_marker_both (w
->pointm
, buffer
, BUF_PT (b
), BUF_PT_BYTE (b
));
3441 set_marker_both (w
->old_pointm
, buffer
, BUF_PT (b
), BUF_PT_BYTE (b
));
3442 set_marker_restricted (w
->start
,
3443 make_number (b
->last_window_start
),
3445 w
->start_at_line_beg
= 0;
3448 /* Maybe we could move this into the `if' but it's not obviously safe and
3449 I doubt it's worth the trouble. */
3451 w
->update_mode_line
= true;
3453 /* We must select BUFFER to run the window-scroll-functions and to look up
3454 the buffer-local value of Vwindow_point_insertion_type. */
3455 record_unwind_current_buffer ();
3456 Fset_buffer (buffer
);
3458 XMARKER (w
->pointm
)->insertion_type
= !NILP (Vwindow_point_insertion_type
);
3459 XMARKER (w
->old_pointm
)->insertion_type
= !NILP (Vwindow_point_insertion_type
);
3461 if (!keep_margins_p
)
3463 /* Set left and right marginal area width etc. from buffer. */
3464 set_window_fringes (w
, BVAR (b
, left_fringe_width
),
3465 BVAR (b
, right_fringe_width
),
3466 BVAR (b
, fringes_outside_margins
));
3467 set_window_scroll_bars (w
, BVAR (b
, scroll_bar_width
),
3468 BVAR (b
, vertical_scroll_bar_type
),
3469 BVAR (b
, scroll_bar_height
),
3470 BVAR (b
, horizontal_scroll_bar_type
));
3471 set_window_margins (w
, BVAR (b
, left_margin_cols
),
3472 BVAR (b
, right_margin_cols
));
3473 apply_window_adjustment (w
);
3478 if (! NILP (Vwindow_scroll_functions
))
3479 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
3480 Fmarker_position (w
->start
));
3482 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w
)));
3485 unbind_to (count
, Qnil
);
3488 DEFUN ("set-window-buffer", Fset_window_buffer
, Sset_window_buffer
, 2, 3, 0,
3489 doc
: /* Make WINDOW display BUFFER-OR-NAME.
3490 WINDOW must be a live window and defaults to the selected one.
3491 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3493 Optional third argument KEEP-MARGINS non-nil means that WINDOW's current
3494 display margins, fringe widths, and scroll bar settings are preserved;
3495 the default is to reset these from the local settings for BUFFER-OR-NAME
3496 or the frame defaults. Return nil.
3498 This function throws an error when WINDOW is strongly dedicated to its
3499 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3500 already display BUFFER-OR-NAME.
3502 This function runs `window-scroll-functions' before running
3503 `window-configuration-change-hook'. */)
3504 (register Lisp_Object window
, Lisp_Object buffer_or_name
, Lisp_Object keep_margins
)
3506 register Lisp_Object tem
, buffer
;
3507 register struct window
*w
= decode_live_window (window
);
3509 XSETWINDOW (window
, w
);
3510 buffer
= Fget_buffer (buffer_or_name
);
3511 CHECK_BUFFER (buffer
);
3512 if (!BUFFER_LIVE_P (XBUFFER (buffer
)))
3513 error ("Attempt to display deleted buffer");
3517 error ("Window is deleted");
3520 if (!EQ (tem
, buffer
))
3522 if (EQ (w
->dedicated
, Qt
))
3523 /* WINDOW is strongly dedicated to its buffer, signal an
3525 error ("Window is dedicated to `%s'", SDATA (BVAR (XBUFFER (tem
), name
)));
3527 /* WINDOW is weakly dedicated to its buffer, reset
3529 wset_dedicated (w
, Qnil
);
3531 call1 (Qrecord_window_buffer
, window
);
3537 set_window_buffer (window
, buffer
, 1, !NILP (keep_margins
));
3543 display_buffer (Lisp_Object buffer
, Lisp_Object not_this_window_p
, Lisp_Object override_frame
)
3545 return call3 (Qdisplay_buffer
, buffer
, not_this_window_p
, override_frame
);
3548 DEFUN ("force-window-update", Fforce_window_update
, Sforce_window_update
,
3550 doc
: /* Force all windows to be updated on next redisplay.
3551 If optional arg OBJECT is a window, force redisplay of that window only.
3552 If OBJECT is a buffer or buffer name, force redisplay of all windows
3553 displaying that buffer. */)
3554 (Lisp_Object object
)
3558 windows_or_buffers_changed
= 29;
3559 update_mode_lines
= 28;
3563 if (WINDOWP (object
))
3565 struct window
*w
= XWINDOW (object
);
3566 mark_window_display_accurate (object
, 0);
3567 w
->update_mode_line
= 1;
3568 if (BUFFERP (w
->contents
))
3569 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
3570 update_mode_lines
= 29;
3574 if (STRINGP (object
))
3575 object
= Fget_buffer (object
);
3576 if (BUFFERP (object
) && BUFFER_LIVE_P (XBUFFER (object
))
3577 && buffer_window_count (XBUFFER (object
)))
3579 /* If buffer is live and shown in at least one window, find
3580 all windows showing this buffer and force update of them. */
3581 object
= window_loop (REDISPLAY_BUFFER_WINDOWS
, object
, 0, Qvisible
);
3582 return NILP (object
) ? Qnil
: Qt
;
3585 /* If nothing suitable was found, just return.
3586 We could signal an error, but this feature will typically be used
3587 asynchronously in timers or process sentinels, so we don't. */
3591 /* Obsolete since 24.3. */
3593 temp_output_buffer_show (register Lisp_Object buf
)
3595 register struct buffer
*old
= current_buffer
;
3596 register Lisp_Object window
;
3597 register struct window
*w
;
3599 bset_directory (XBUFFER (buf
), BVAR (current_buffer
, directory
));
3602 BUF_SAVE_MODIFF (XBUFFER (buf
)) = MODIFF
;
3606 set_buffer_internal (old
);
3608 if (!NILP (Vtemp_buffer_show_function
))
3609 call1 (Vtemp_buffer_show_function
, buf
);
3610 else if (WINDOW_LIVE_P (window
= display_buffer (buf
, Qnil
, Qnil
)))
3612 if (!EQ (XWINDOW (window
)->frame
, selected_frame
))
3613 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window
)));
3614 Vminibuf_scroll_window
= window
;
3615 w
= XWINDOW (window
);
3616 w
->hscroll
= w
->min_hscroll
= w
->hscroll_whole
= 0;
3617 w
->suspend_auto_hscroll
= 0;
3618 set_marker_restricted_both (w
->start
, buf
, BEG
, BEG
);
3619 set_marker_restricted_both (w
->pointm
, buf
, BEG
, BEG
);
3620 set_marker_restricted_both (w
->old_pointm
, buf
, BEG
, BEG
);
3622 /* Run temp-buffer-show-hook, with the chosen window selected
3623 and its buffer current. */
3625 ptrdiff_t count
= SPECPDL_INDEX ();
3626 Lisp_Object prev_window
, prev_buffer
;
3627 prev_window
= selected_window
;
3628 XSETBUFFER (prev_buffer
, old
);
3630 /* Select the window that was chosen, for running the hook.
3631 Note: Both Fselect_window and select_window_norecord may
3632 set-buffer to the buffer displayed in the window,
3633 so we need to save the current buffer. --stef */
3634 record_unwind_protect (restore_buffer
, prev_buffer
);
3635 record_unwind_protect (select_window_norecord
, prev_window
);
3636 Fselect_window (window
, Qt
);
3637 Fset_buffer (w
->contents
);
3638 run_hook (Qtemp_buffer_show_hook
);
3639 unbind_to (count
, Qnil
);
3644 /* Allocate basically initialized window. */
3646 static struct window
*
3647 allocate_window (void)
3649 return ALLOCATE_ZEROED_PSEUDOVECTOR
3650 (struct window
, current_matrix
, PVEC_WINDOW
);
3653 /* Make new window, have it replace WINDOW in window-tree, and make
3654 WINDOW its only vertical child (HORFLAG 1 means make WINDOW its only
3655 horizontal child). */
3657 make_parent_window (Lisp_Object window
, bool horflag
)
3660 register struct window
*o
, *p
;
3662 o
= XWINDOW (window
);
3663 p
= allocate_window ();
3664 memcpy ((char *) p
+ sizeof (struct vectorlike_header
),
3665 (char *) o
+ sizeof (struct vectorlike_header
),
3666 word_size
* VECSIZE (struct window
));
3667 /* P's buffer slot may change from nil to a buffer... */
3668 adjust_window_count (p
, 1);
3669 XSETWINDOW (parent
, p
);
3671 p
->sequence_number
= ++sequence_number
;
3673 replace_window (window
, parent
, 1);
3675 wset_next (o
, Qnil
);
3676 wset_prev (o
, Qnil
);
3677 wset_parent (o
, parent
);
3678 /* ...but now P becomes an internal window. */
3679 wset_start (p
, Qnil
);
3680 wset_pointm (p
, Qnil
);
3681 wset_old_pointm (p
, Qnil
);
3682 wset_buffer (p
, Qnil
);
3683 wset_combination (p
, horflag
, window
);
3684 wset_combination_limit (p
, Qnil
);
3685 wset_window_parameters (p
, Qnil
);
3688 /* Make new window from scratch. */
3693 register struct window
*w
;
3695 w
= allocate_window ();
3696 /* Initialize Lisp data. Note that allocate_window initializes all
3697 Lisp data to nil, so do it only for slots which should not be nil. */
3698 wset_normal_lines (w
, make_float (1.0));
3699 wset_normal_cols (w
, make_float (1.0));
3700 wset_new_total (w
, make_number (0));
3701 wset_new_normal (w
, make_number (0));
3702 wset_new_pixel (w
, make_number (0));
3703 wset_start (w
, Fmake_marker ());
3704 wset_pointm (w
, Fmake_marker ());
3705 wset_old_pointm (w
, Fmake_marker ());
3706 wset_vertical_scroll_bar_type (w
, Qt
);
3707 wset_horizontal_scroll_bar_type (w
, Qt
);
3708 /* These Lisp fields are marked specially so they're not set to nil by
3710 wset_prev_buffers (w
, Qnil
);
3711 wset_next_buffers (w
, Qnil
);
3713 /* Initialize non-Lisp data. Note that allocate_window zeroes out all
3714 non-Lisp data, so do it only for slots which should not be zero. */
3715 w
->nrows_scale_factor
= w
->ncols_scale_factor
= 1;
3716 w
->left_fringe_width
= w
->right_fringe_width
= -1;
3717 w
->mode_line_height
= w
->header_line_height
= -1;
3718 #ifdef HAVE_WINDOW_SYSTEM
3719 w
->phys_cursor_type
= NO_CURSOR
;
3720 w
->phys_cursor_width
= -1;
3722 w
->sequence_number
= ++sequence_number
;
3723 w
->scroll_bar_width
= -1;
3724 w
->scroll_bar_height
= -1;
3725 w
->column_number_displayed
= -1;
3726 /* Reset window_list. */
3727 Vwindow_list
= Qnil
;
3728 /* Return window. */
3729 XSETWINDOW (window
, w
);
3733 DEFUN ("set-window-new-pixel", Fset_window_new_pixel
, Sset_window_new_pixel
, 2, 3, 0,
3734 doc
: /* Set new pixel size of WINDOW to SIZE.
3735 WINDOW must be a valid window and defaults to the selected one.
3738 Optional argument ADD non-nil means add SIZE to the new pixel size of
3739 WINDOW and return the sum.
3741 The new pixel size of WINDOW, if valid, will be shortly installed as
3742 WINDOW's pixel height (see `window-pixel-height') or pixel width (see
3743 `window-pixel-width').
3745 Note: This function does not operate on any child windows of WINDOW. */)
3746 (Lisp_Object window
, Lisp_Object size
, Lisp_Object add
)
3748 struct window
*w
= decode_valid_window (window
);
3749 EMACS_INT size_min
= NILP (add
) ? 0 : - XINT (w
->new_pixel
);
3750 EMACS_INT size_max
= size_min
+ min (INT_MAX
, MOST_POSITIVE_FIXNUM
);
3752 CHECK_RANGED_INTEGER (size
, size_min
, size_max
);
3754 wset_new_pixel (w
, size
);
3756 wset_new_pixel (w
, make_number (XINT (w
->new_pixel
) + XINT (size
)));
3758 return w
->new_pixel
;
3761 DEFUN ("set-window-new-total", Fset_window_new_total
, Sset_window_new_total
, 2, 3, 0,
3762 doc
: /* Set new total size of WINDOW to SIZE.
3763 WINDOW must be a valid window and defaults to the selected one.
3766 Optional argument ADD non-nil means add SIZE to the new total size of
3767 WINDOW and return the sum.
3769 The new total size of WINDOW, if valid, will be shortly installed as
3770 WINDOW's total height (see `window-total-height') or total width (see
3771 `window-total-width').
3773 Note: This function does not operate on any child windows of WINDOW. */)
3774 (Lisp_Object window
, Lisp_Object size
, Lisp_Object add
)
3776 struct window
*w
= decode_valid_window (window
);
3778 CHECK_NUMBER (size
);
3780 wset_new_total (w
, size
);
3782 wset_new_total (w
, make_number (XINT (w
->new_total
) + XINT (size
)));
3784 return w
->new_total
;
3787 DEFUN ("set-window-new-normal", Fset_window_new_normal
, Sset_window_new_normal
, 1, 2, 0,
3788 doc
: /* Set new normal size of WINDOW to SIZE.
3789 WINDOW must be a valid window and defaults to the selected one.
3792 The new normal size of WINDOW, if valid, will be shortly installed as
3793 WINDOW's normal size (see `window-normal-size').
3795 Note: This function does not operate on any child windows of WINDOW. */)
3796 (Lisp_Object window
, Lisp_Object size
)
3798 wset_new_normal (decode_valid_window (window
), size
);
3802 /* Return 1 if setting w->pixel_height (w->pixel_width if HORFLAG is
3803 non-zero) to w->new_pixel would result in correct heights (widths)
3804 for window W and recursively all child windows of W.
3806 Note: This function does not check any of `window-fixed-size-p',
3807 `window-min-height' or `window-min-width'. It does check that window
3808 sizes do not drop below one line (two columns). */
3810 window_resize_check (struct window
*w
, bool horflag
)
3812 struct frame
*f
= XFRAME (w
->frame
);
3815 if (WINDOW_VERTICAL_COMBINATION_P (w
))
3816 /* W is a vertical combination. */
3818 c
= XWINDOW (w
->contents
);
3820 /* All child windows of W must have the same width as W. */
3824 if (XINT (c
->new_pixel
) != XINT (w
->new_pixel
)
3825 || !window_resize_check (c
, horflag
))
3828 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3834 /* The sum of the heights of the child windows of W must equal
3837 int remaining_pixels
= XINT (w
->new_pixel
);
3841 if (!window_resize_check (c
, horflag
))
3844 remaining_pixels
-= XINT (c
->new_pixel
);
3845 if (remaining_pixels
< 0)
3847 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3850 return remaining_pixels
== 0;
3853 else if (WINDOW_HORIZONTAL_COMBINATION_P (w
))
3854 /* W is a horizontal combination. */
3856 c
= XWINDOW (w
->contents
);
3858 /* The sum of the widths of the child windows of W must equal W's
3861 int remaining_pixels
= XINT (w
->new_pixel
);
3865 if (!window_resize_check (c
, horflag
))
3868 remaining_pixels
-= XINT (c
->new_pixel
);
3869 if (remaining_pixels
< 0)
3871 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3874 return remaining_pixels
== 0;
3877 /* All child windows of W must have the same height as W. */
3881 if (XINT (c
->new_pixel
) != XINT (w
->new_pixel
)
3882 || !window_resize_check (c
, horflag
))
3885 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3892 /* A leaf window. Make sure it's not too small. The following
3893 hardcodes the values of `window-safe-min-width' (2) and
3894 `window-safe-min-height' (1) which are defined in window.el. */
3895 return (XINT (w
->new_pixel
) >= (horflag
3896 ? (2 * FRAME_COLUMN_WIDTH (f
))
3897 : FRAME_LINE_HEIGHT (f
)));
3901 /* Set w->pixel_height (w->pixel_width if HORFLAG is non-zero) to
3902 w->new_pixel for window W and recursively all child windows of W.
3903 Also calculate and assign the new vertical (horizontal) pixel start
3904 positions of each of these windows.
3906 This function does not perform any error checks. Make sure you have
3907 run window_resize_check on W before applying this function. */
3909 window_resize_apply (struct window
*w
, bool horflag
)
3914 ? FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
))
3915 : FRAME_LINE_HEIGHT (WINDOW_XFRAME (w
)));
3917 /* Note: Assigning new_normal requires that the new total size of the
3918 parent window has been set *before*. */
3921 w
->pixel_width
= XFASTINT (w
->new_pixel
);
3922 w
->total_cols
= w
->pixel_width
/ unit
;
3923 if (NUMBERP (w
->new_normal
))
3924 wset_normal_cols (w
, w
->new_normal
);
3926 edge
= w
->pixel_left
;
3930 w
->pixel_height
= XFASTINT (w
->new_pixel
);
3931 w
->total_lines
= w
->pixel_height
/ unit
;
3932 if (NUMBERP (w
->new_normal
))
3933 wset_normal_lines (w
, w
->new_normal
);
3935 edge
= w
->pixel_top
;
3938 if (WINDOW_VERTICAL_COMBINATION_P (w
))
3939 /* W is a vertical combination. */
3941 c
= XWINDOW (w
->contents
);
3946 c
->pixel_left
= edge
;
3947 c
->left_col
= edge
/ unit
;
3951 c
->pixel_top
= edge
;
3952 c
->top_line
= edge
/ unit
;
3954 window_resize_apply (c
, horflag
);
3956 edge
= edge
+ c
->pixel_height
;
3958 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3961 else if (WINDOW_HORIZONTAL_COMBINATION_P (w
))
3962 /* W is a horizontal combination. */
3964 c
= XWINDOW (w
->contents
);
3969 c
->pixel_left
= edge
;
3970 c
->left_col
= edge
/ unit
;
3974 c
->pixel_top
= edge
;
3975 c
->top_line
= edge
/ unit
;
3978 window_resize_apply (c
, horflag
);
3980 edge
= edge
+ c
->pixel_width
;
3982 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
3987 w
->window_end_valid
= 0;
3991 /* Set w->total_lines (w->total_cols if HORFLAG is non-zero) to
3992 w->new_total for window W and recursively all child windows of W.
3993 Also calculate and assign the new vertical (horizontal) start
3994 positions of each of these windows. */
3996 window_resize_apply_total (struct window
*w
, bool horflag
)
4001 /* Note: Assigning new_normal requires that the new total size of the
4002 parent window has been set *before*. */
4005 w
->total_cols
= XFASTINT (w
->new_total
);
4010 w
->total_lines
= XFASTINT (w
->new_total
);
4014 if (WINDOW_VERTICAL_COMBINATION_P (w
))
4015 /* W is a vertical combination. */
4017 c
= XWINDOW (w
->contents
);
4025 window_resize_apply_total (c
, horflag
);
4027 edge
= edge
+ c
->total_lines
;
4029 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
4032 else if (WINDOW_HORIZONTAL_COMBINATION_P (w
))
4033 /* W is a horizontal combination. */
4035 c
= XWINDOW (w
->contents
);
4043 window_resize_apply_total (c
, horflag
);
4045 edge
= edge
+ c
->total_cols
;
4047 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
4052 DEFUN ("window-resize-apply", Fwindow_resize_apply
, Swindow_resize_apply
, 0, 2, 0,
4053 doc
: /* Apply requested size values for window-tree of FRAME.
4054 If FRAME is omitted or nil, it defaults to the selected frame.
4056 Optional argument HORIZONTAL omitted or nil means apply requested
4057 height values. HORIZONTAL non-nil means apply requested width values.
4059 The requested size values are those set by `set-window-new-pixel' and
4060 `set-window-new-normal'. This function checks whether the requested
4061 values sum up to a valid window layout, recursively assigns the new
4062 sizes of all child windows and calculates and assigns the new start
4063 positions of these windows.
4065 Return t if the requested values have been applied correctly, nil
4068 Note: This function does not check any of `window-fixed-size-p',
4069 `window-min-height' or `window-min-width'. All these checks have to
4070 be applied on the Elisp level. */)
4071 (Lisp_Object frame
, Lisp_Object horizontal
)
4073 struct frame
*f
= decode_live_frame (frame
);
4074 struct window
*r
= XWINDOW (FRAME_ROOT_WINDOW (f
));
4075 bool horflag
= !NILP (horizontal
);
4077 if (!window_resize_check (r
, horflag
)
4078 || (XINT (r
->new_pixel
)
4079 != (horflag
? r
->pixel_width
: r
->pixel_height
)))
4083 window_resize_apply (r
, horflag
);
4086 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
4088 adjust_frame_glyphs (f
);
4095 DEFUN ("window-resize-apply-total", Fwindow_resize_apply_total
, Swindow_resize_apply_total
, 0, 2, 0,
4096 doc
: /* Apply requested total size values for window-tree of FRAME.
4097 If FRAME is omitted or nil, it defaults to the selected frame.
4099 This function does not assign pixel or normal size values. You should
4100 have run `window-resize-apply' before running this.
4102 Optional argument HORIZONTAL omitted or nil means apply requested
4103 height values. HORIZONTAL non-nil means apply requested width
4105 (Lisp_Object frame
, Lisp_Object horizontal
)
4107 struct frame
*f
= decode_live_frame (frame
);
4108 struct window
*r
= XWINDOW (FRAME_ROOT_WINDOW (f
));
4111 /* Necessary when deleting the top-/or leftmost window. */
4113 r
->top_line
= FRAME_TOP_MARGIN (f
);
4114 window_resize_apply_total (r
, !NILP (horizontal
));
4115 /* Handle the mini window. */
4116 if (FRAME_HAS_MINIBUF_P (f
) && !FRAME_MINIBUF_ONLY_P (f
))
4118 struct window
*m
= XWINDOW (f
->minibuffer_window
);
4120 if (NILP (horizontal
))
4122 m
->top_line
= r
->top_line
+ r
->total_lines
;
4123 m
->total_lines
= XFASTINT (m
->new_total
);
4126 m
->total_cols
= XFASTINT (m
->new_total
);
4135 /* Resize frame F's windows when number of lines of F is set to SIZE.
4136 HORFLAG 1 means resize windows when number of columns of F is set to
4137 SIZE. PIXELWISE 1 means to interpret SIZE as pixels. */
4139 resize_frame_windows (struct frame
*f
, int size
, bool horflag
, bool pixelwise
)
4141 Lisp_Object root
= f
->root_window
;
4142 struct window
*r
= XWINDOW (root
);
4143 Lisp_Object mini
= f
->minibuffer_window
;
4145 /* old_size is the old size of the frame's root window. */
4146 int old_size
= horflag
? r
->total_cols
: r
->total_lines
;
4147 int old_pixel_size
= horflag
? r
->pixel_width
: r
->pixel_height
;
4148 int old_pixel_top
= r
->pixel_top
;
4149 /* new_size is the new size of the frame's root window. */
4150 int new_size
, new_pixel_size
;
4151 int unit
= horflag
? FRAME_COLUMN_WIDTH (f
) : FRAME_LINE_HEIGHT (f
);
4153 /* Don't let the size drop below one unit. This is more comforting
4154 when we are called from x_set_tool_bar_lines since the latter may
4155 have implicitly given us a zero or negative height. */
4158 /* Note: This does not include the size for internal borders
4159 since these are not part of the frame's text area. */
4160 new_pixel_size
= max (horflag
4163 - ((FRAME_HAS_MINIBUF_P (f
)
4164 && !FRAME_MINIBUF_ONLY_P (f
))
4165 ? FRAME_LINE_HEIGHT (f
) : 0)),
4167 new_size
= new_pixel_size
/ unit
;
4171 new_size
= max (horflag
4174 - ((FRAME_HAS_MINIBUF_P (f
)
4175 && !FRAME_MINIBUF_ONLY_P (f
))
4178 new_pixel_size
= new_size
* unit
;
4181 r
->top_line
= FRAME_TOP_MARGIN (f
);
4182 r
->pixel_top
= FRAME_TOP_MARGIN_HEIGHT (f
);
4184 if (new_pixel_size
== old_pixel_size
4185 && r
->pixel_top
== old_pixel_top
)
4187 else if (WINDOW_LEAF_P (r
))
4188 /* For a leaf root window just set the size. */
4191 r
->total_cols
= new_size
;
4192 r
->pixel_width
= new_pixel_size
;
4196 r
->total_lines
= new_size
;
4197 r
->pixel_height
= new_pixel_size
;
4204 XSETINT (delta
, new_pixel_size
- old_pixel_size
);
4206 XSETINT (delta
, new_size
- old_size
);
4208 /* Try a "normal" resize first. */
4209 resize_root_window (root
, delta
, horflag
? Qt
: Qnil
, Qnil
,
4210 pixelwise
? Qt
: Qnil
);
4211 if (window_resize_check (r
, horflag
)
4212 && new_pixel_size
== XINT (r
->new_pixel
))
4214 window_resize_apply (r
, horflag
);
4215 window_pixel_to_total (r
->frame
, horflag
? Qt
: Qnil
);
4219 /* Try with "reasonable" minimum sizes next. */
4220 resize_root_window (root
, delta
, horflag
? Qt
: Qnil
, Qt
,
4221 pixelwise
? Qt
: Qnil
);
4222 if (window_resize_check (r
, horflag
)
4223 && new_pixel_size
== XINT (r
->new_pixel
))
4225 window_resize_apply (r
, horflag
);
4226 window_pixel_to_total (r
->frame
, horflag
? Qt
: Qnil
);
4227 #if 0 /* Let's try without safe sizes and/or killing other windows. */
4231 /* Finally, try with "safe" minimum sizes. */
4232 resize_root_window (root
, delta
, horflag
? Qt
: Qnil
, Qsafe
,
4233 pixelwise
? Qt
: Qnil
);
4234 if (window_resize_check (r
, horflag
)
4235 && new_pixel_size
== XINT (r
->new_pixel
))
4237 window_resize_apply (r
, horflag
);
4238 window_pixel_to_total (r
->frame
, horflag
? Qt
: Qnil
);
4242 /* We lost. Delete all windows but the frame's
4244 root
= f
->selected_window
;
4245 Fdelete_other_windows_internal (root
, Qnil
);
4248 XWINDOW (root
)->total_cols
= new_size
;
4249 XWINDOW (root
)->pixel_width
= new_pixel_size
;
4253 XWINDOW (root
)->total_lines
= new_size
;
4254 XWINDOW (root
)->pixel_height
= new_pixel_size
;
4262 if (FRAME_HAS_MINIBUF_P (f
) && !FRAME_MINIBUF_ONLY_P (f
))
4267 m
->total_cols
= size
;
4268 m
->pixel_width
= new_pixel_size
;
4272 /* Are we sure we always want 1 line here? */
4274 m
->pixel_height
= FRAME_LINE_HEIGHT (f
);
4275 m
->top_line
= r
->top_line
+ r
->total_lines
;
4276 m
->pixel_top
= r
->pixel_top
+ r
->pixel_height
;
4284 DEFUN ("split-window-internal", Fsplit_window_internal
, Ssplit_window_internal
, 4, 4, 0,
4285 doc
: /* Split window OLD.
4286 Second argument PIXEL-SIZE specifies the number of pixels of the
4287 new window. In any case TOTAL-SIZE must be a positive integer.
4289 Third argument SIDE nil (or `below') specifies that the new window shall
4290 be located below WINDOW. SIDE `above' means the new window shall be
4291 located above WINDOW. In both cases PIXEL-SIZE specifies the pixel
4292 height of the new window including space reserved for the mode and/or
4295 SIDE t (or `right') specifies that the new window shall be located on
4296 the right side of WINDOW. SIDE `left' means the new window shall be
4297 located on the left of WINDOW. In both cases PIXEL-SIZE specifies the
4298 width of the new window including space reserved for fringes and the
4299 scrollbar or a divider column.
4301 Fourth argument NORMAL-SIZE specifies the normal size of the new window
4302 according to the SIDE argument.
4304 The new pixel and normal sizes of all involved windows must have been
4305 set correctly. See the code of `split-window' for how this is done. */)
4306 (Lisp_Object old
, Lisp_Object pixel_size
, Lisp_Object side
, Lisp_Object normal_size
)
4308 /* OLD (*o) is the window we have to split. (*p) is either OLD's
4309 parent window or an internal window we have to install as OLD's new
4310 parent. REFERENCE (*r) must denote a live window, or is set to OLD
4311 provided OLD is a leaf window, or to the frame's selected window.
4312 NEW (*n) is the new window created with some parameters taken from
4314 register Lisp_Object
new, frame
, reference
;
4315 register struct window
*o
, *p
, *n
, *r
, *c
;
4318 /* HORFLAG is 1 when we split side-by-side, 0 otherwise. */
4319 = EQ (side
, Qt
) || EQ (side
, Qleft
) || EQ (side
, Qright
);
4320 int combination_limit
= 0, sum
= 0;
4325 frame
= WINDOW_FRAME (o
);
4328 CHECK_NUMBER (pixel_size
);
4330 = XINT (pixel_size
) / (horflag
4331 ? FRAME_COLUMN_WIDTH (f
)
4332 : FRAME_LINE_HEIGHT (f
));
4334 /* Set combination_limit to 1 if we have to make a new parent window.
4335 We do that if either `window-combination-limit' is t, or OLD has no
4336 parent, or OLD is ortho-combined. */
4338 EQ (Vwindow_combination_limit
, Qt
)
4341 ? WINDOW_VERTICAL_COMBINATION_P (XWINDOW (o
->parent
))
4342 : WINDOW_HORIZONTAL_COMBINATION_P (XWINDOW (o
->parent
)));
4344 /* We need a live reference window to initialize some parameters. */
4345 if (WINDOW_LIVE_P (old
))
4346 /* OLD is live, use it as reference window. */
4349 /* Use the frame's selected window as reference window. */
4350 reference
= FRAME_SELECTED_WINDOW (f
);
4351 r
= XWINDOW (reference
);
4353 /* The following bugs are caught by `split-window'. */
4354 if (MINI_WINDOW_P (o
))
4355 error ("Attempt to split minibuffer window");
4356 else if (total_size
< (horflag
? 2 : 1))
4357 error ("Size of new window too small (after split)");
4358 else if (!combination_limit
&& !NILP (Vwindow_combination_resize
))
4359 /* `window-combination-resize' non-nil means try to resize OLD's siblings
4362 p
= XWINDOW (o
->parent
);
4363 /* Temporarily pretend we split the parent window. */
4365 (p
, make_number ((horflag
? p
->pixel_width
: p
->pixel_height
)
4366 - XINT (pixel_size
)));
4367 if (!window_resize_check (p
, horflag
))
4368 error ("Window sizes don't fit");
4370 /* Undo the temporary pretension. */
4371 wset_new_pixel (p
, make_number (horflag
? p
->pixel_width
: p
->pixel_height
));
4375 if (!window_resize_check (o
, horflag
))
4376 error ("Resizing old window failed");
4377 else if (XINT (pixel_size
) + XINT (o
->new_pixel
)
4378 != (horflag
? o
->pixel_width
: o
->pixel_height
))
4379 error ("Sum of sizes of old and new window don't fit");
4382 /* This is our point of no return. */
4383 if (combination_limit
)
4385 /* Save the old value of o->normal_cols/lines. It gets corrupted
4386 by make_parent_window and we need it below for assigning it to
4388 Lisp_Object new_normal
4389 = horflag
? o
->normal_cols
: o
->normal_lines
;
4391 make_parent_window (old
, horflag
);
4392 p
= XWINDOW (o
->parent
);
4393 if (EQ (Vwindow_combination_limit
, Qt
))
4394 /* Store t in the new parent's combination_limit slot to avoid
4395 that its children get merged into another window. */
4396 wset_combination_limit (p
, Qt
);
4397 /* These get applied below. */
4399 (p
, make_number (horflag
? o
->pixel_width
: o
->pixel_height
));
4401 (p
, make_number (horflag
? o
->total_cols
: o
->total_lines
));
4402 wset_new_normal (p
, new_normal
);
4405 p
= XWINDOW (o
->parent
);
4408 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
4409 new = make_window ();
4411 wset_frame (n
, frame
);
4412 wset_parent (n
, o
->parent
);
4414 if (EQ (side
, Qabove
) || EQ (side
, Qleft
))
4416 wset_prev (n
, o
->prev
);
4418 wset_combination (p
, horflag
, new);
4420 wset_next (XWINDOW (n
->prev
), new);
4426 wset_next (n
, o
->next
);
4427 if (!NILP (n
->next
))
4428 wset_prev (XWINDOW (n
->next
), new);
4433 n
->window_end_valid
= 0;
4434 n
->last_cursor_vpos
= 0;
4436 /* Get special geometry settings from reference window. */
4437 n
->left_margin_cols
= r
->left_margin_cols
;
4438 n
->right_margin_cols
= r
->right_margin_cols
;
4439 n
->left_fringe_width
= r
->left_fringe_width
;
4440 n
->right_fringe_width
= r
->right_fringe_width
;
4441 n
->fringes_outside_margins
= r
->fringes_outside_margins
;
4442 n
->scroll_bar_width
= r
->scroll_bar_width
;
4443 n
->scroll_bar_height
= r
->scroll_bar_height
;
4444 wset_vertical_scroll_bar_type (n
, r
->vertical_scroll_bar_type
);
4445 wset_horizontal_scroll_bar_type (n
, r
->horizontal_scroll_bar_type
);
4447 /* Directly assign orthogonal coordinates and sizes. */
4450 n
->pixel_top
= o
->pixel_top
;
4451 n
->top_line
= o
->top_line
;
4452 n
->pixel_height
= o
->pixel_height
;
4453 n
->total_lines
= o
->total_lines
;
4457 n
->pixel_left
= o
->pixel_left
;
4458 n
->left_col
= o
->left_col
;
4459 n
->pixel_width
= o
->pixel_width
;
4460 n
->total_cols
= o
->total_cols
;
4463 /* Iso-coordinates and sizes are assigned by window_resize_apply,
4464 get them ready here. */
4465 wset_new_pixel (n
, pixel_size
);
4466 c
= XWINDOW (p
->contents
);
4470 sum
= sum
+ XINT (c
->new_total
);
4471 c
= NILP (c
->next
) ? 0 : XWINDOW (c
->next
);
4473 wset_new_total (n
, make_number ((horflag
4477 wset_new_normal (n
, normal_size
);
4480 window_resize_apply (p
, horflag
);
4481 adjust_frame_glyphs (f
);
4482 /* Set buffer of NEW to buffer of reference window. Don't run
4484 set_window_buffer (new, r
->contents
, 0, 1);
4487 /* Maybe we should run the scroll functions in Elisp (which already
4488 runs the configuration change hook). */
4489 if (! NILP (Vwindow_scroll_functions
))
4490 run_hook_with_args_2 (Qwindow_scroll_functions
, new,
4491 Fmarker_position (n
->start
));
4497 DEFUN ("delete-window-internal", Fdelete_window_internal
, Sdelete_window_internal
, 1, 1, 0,
4498 doc
: /* Remove WINDOW from its frame.
4499 WINDOW defaults to the selected window. Return nil.
4500 Signal an error when WINDOW is the only window on its frame. */)
4501 (register Lisp_Object window
)
4503 register Lisp_Object parent
, sibling
, frame
, root
;
4504 struct window
*w
, *p
, *s
, *r
;
4506 bool horflag
, before_sibling
= 0;
4508 w
= decode_any_window (window
);
4509 XSETWINDOW (window
, w
);
4510 if (NILP (w
->contents
))
4511 /* It's a no-op to delete an already deleted window. */
4516 /* Never delete a minibuffer or frame root window. */
4517 error ("Attempt to delete minibuffer or sole ordinary window");
4518 else if (NILP (w
->prev
) && NILP (w
->next
))
4519 /* Rather bow out here, this case should be handled on the Elisp
4521 error ("Attempt to delete sole window of parent");
4523 p
= XWINDOW (parent
);
4524 horflag
= WINDOW_HORIZONTAL_COMBINATION_P (p
);
4526 frame
= WINDOW_FRAME (w
);
4529 root
= FRAME_ROOT_WINDOW (f
);
4532 /* Unlink WINDOW from window tree. */
4534 /* Get SIBLING below (on the right of) WINDOW. */
4536 /* before_sibling 1 means WINDOW is the first child of its
4537 parent and thus before the sibling. */
4540 s
= XWINDOW (sibling
);
4541 wset_prev (s
, Qnil
);
4542 wset_combination (p
, horflag
, sibling
);
4545 /* Get SIBLING above (on the left of) WINDOW. */
4548 s
= XWINDOW (sibling
);
4549 wset_next (s
, w
->next
);
4550 if (!NILP (s
->next
))
4551 wset_prev (XWINDOW (s
->next
), sibling
);
4554 if (window_resize_check (r
, horflag
)
4555 && (XINT (r
->new_pixel
)
4556 == (horflag
? r
->pixel_width
: r
->pixel_height
)))
4557 /* We can delete WINDOW now. */
4562 window_resize_apply (p
, horflag
);
4563 /* If this window is referred to by the dpyinfo's mouse
4564 highlight, invalidate that slot to be safe (Bug#9904). */
4565 if (!FRAME_INITIAL_P (f
))
4567 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
4569 if (EQ (hlinfo
->mouse_face_window
, window
))
4570 hlinfo
->mouse_face_window
= Qnil
;
4574 Vwindow_list
= Qnil
;
4575 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
4577 wset_next (w
, Qnil
); /* Don't delete w->next too. */
4578 free_window_matrices (w
);
4580 if (WINDOWP (w
->contents
))
4582 delete_all_child_windows (w
->contents
);
4583 wset_combination (w
, 0, Qnil
);
4588 unchain_marker (XMARKER (w
->pointm
));
4589 unchain_marker (XMARKER (w
->old_pointm
));
4590 unchain_marker (XMARKER (w
->start
));
4591 wset_buffer (w
, Qnil
);
4594 if (NILP (s
->prev
) && NILP (s
->next
))
4595 /* A matrjoshka where SIBLING has become the only child of
4598 /* Put SIBLING into PARENT's place. */
4599 replace_window (parent
, sibling
, 0);
4600 /* Have SIBLING inherit the following three slot values from
4601 PARENT (the combination_limit slot is not inherited). */
4602 wset_normal_cols (s
, p
->normal_cols
);
4603 wset_normal_lines (s
, p
->normal_lines
);
4604 /* Mark PARENT as deleted. */
4605 wset_combination (p
, 0, Qnil
);
4606 /* Try to merge SIBLING into its new parent. */
4607 recombine_windows (sibling
);
4610 adjust_frame_glyphs (f
);
4612 if (!WINDOW_LIVE_P (FRAME_SELECTED_WINDOW (f
)))
4613 /* We deleted the frame's selected window. */
4615 /* Use the frame's first window as fallback ... */
4616 Lisp_Object new_selected_window
= Fframe_first_window (frame
);
4617 /* ... but preferably use its most recently used window. */
4618 Lisp_Object mru_window
;
4620 /* `get-mru-window' might fail for some reason so play it safe
4621 - promote the first window _without recording it_ first. */
4622 if (EQ (FRAME_SELECTED_WINDOW (f
), selected_window
))
4623 Fselect_window (new_selected_window
, Qt
);
4625 fset_selected_window (f
, new_selected_window
);
4629 /* Now look whether `get-mru-window' gets us something. */
4630 mru_window
= call1 (Qget_mru_window
, frame
);
4631 if (WINDOW_LIVE_P (mru_window
)
4632 && EQ (XWINDOW (mru_window
)->frame
, frame
))
4633 new_selected_window
= mru_window
;
4635 /* If all ended up well, we now promote the mru window. */
4636 if (EQ (FRAME_SELECTED_WINDOW (f
), selected_window
))
4637 Fselect_window (new_selected_window
, Qnil
);
4639 fset_selected_window (f
, new_selected_window
);
4644 /* Must be run by the caller:
4645 run_window_configuration_change_hook (f); */
4648 /* We failed: Relink WINDOW into window tree. */
4652 wset_prev (s
, window
);
4653 wset_combination (p
, horflag
, window
);
4657 wset_next (s
, window
);
4658 if (!NILP (w
->next
))
4659 wset_prev (XWINDOW (w
->next
), window
);
4661 error ("Deletion failed");
4667 /***********************************************************************
4668 Resizing Mini-Windows
4669 ***********************************************************************/
4671 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we
4674 grow_mini_window (struct window
*w
, int delta
, bool pixelwise
)
4676 struct frame
*f
= XFRAME (w
->frame
);
4678 Lisp_Object root
, height
;
4679 int line_height
, pixel_height
;
4681 eassert (MINI_WINDOW_P (w
));
4682 eassert (delta
>= 0);
4686 root
= FRAME_ROOT_WINDOW (f
);
4688 height
= call3 (Qwindow_resize_root_window_vertically
,
4689 root
, make_number (- delta
), pixelwise
? Qt
: Qnil
);
4690 if (INTEGERP (height
) && window_resize_check (r
, 0))
4693 window_resize_apply (r
, 0);
4697 pixel_height
= min (-XINT (height
), INT_MAX
- w
->pixel_height
);
4698 line_height
= pixel_height
/ FRAME_LINE_HEIGHT (f
);
4702 line_height
= min (-XINT (height
),
4703 ((INT_MAX
- w
->pixel_height
)
4704 / FRAME_LINE_HEIGHT (f
)));
4705 pixel_height
= line_height
* FRAME_LINE_HEIGHT (f
);
4708 /* Grow the mini-window. */
4709 w
->pixel_top
= r
->pixel_top
+ r
->pixel_height
;
4710 w
->top_line
= r
->top_line
+ r
->total_lines
;
4711 /* Make sure the mini-window has always at least one line. */
4712 w
->pixel_height
= max (w
->pixel_height
+ pixel_height
,
4713 FRAME_LINE_HEIGHT (f
));
4714 w
->total_lines
= max (w
->total_lines
+ line_height
, 1);
4716 /* Enforce full redisplay of the frame. */
4717 /* FIXME: Shouldn't window--resize-root-window-vertically do it? */
4719 adjust_frame_glyphs (f
);
4725 /* Shrink mini-window W to one line. */
4727 shrink_mini_window (struct window
*w
, bool pixelwise
)
4729 struct frame
*f
= XFRAME (w
->frame
);
4731 Lisp_Object root
, delta
;
4732 EMACS_INT height
, unit
;
4734 eassert (MINI_WINDOW_P (w
));
4736 height
= pixelwise
? w
->pixel_height
: w
->total_lines
;
4737 unit
= pixelwise
? FRAME_LINE_HEIGHT (f
) : 1;
4740 root
= FRAME_ROOT_WINDOW (f
);
4742 delta
= call3 (Qwindow_resize_root_window_vertically
,
4743 root
, make_number (height
- unit
),
4744 pixelwise
? Qt
: Qnil
);
4745 if (INTEGERP (delta
) && window_resize_check (r
, 0))
4748 window_resize_apply (r
, 0);
4750 /* Shrink the mini-window. */
4751 w
->top_line
= r
->top_line
+ r
->total_lines
;
4753 w
->pixel_top
= r
->pixel_top
+ r
->pixel_height
;
4754 w
->pixel_height
= FRAME_LINE_HEIGHT (f
);
4755 /* Enforce full redisplay of the frame. */
4756 /* FIXME: Shouldn't window--resize-root-window-vertically do it? */
4758 adjust_frame_glyphs (f
);
4761 /* If the above failed for whatever strange reason we must make a
4762 one window frame here. The same routine will be needed when
4763 shrinking the frame (and probably when making the initial
4764 *scratch* window). For the moment leave things as they are. */
4768 DEFUN ("resize-mini-window-internal", Fresize_mini_window_internal
, Sresize_mini_window_internal
, 1, 1, 0,
4769 doc
: /* Resize minibuffer window WINDOW. */)
4770 (Lisp_Object window
)
4772 struct window
*w
= XWINDOW (window
);
4777 CHECK_WINDOW (window
);
4778 f
= XFRAME (w
->frame
);
4780 if (!EQ (FRAME_MINIBUF_WINDOW (XFRAME (w
->frame
)), window
))
4781 error ("Not a valid minibuffer window");
4782 else if (FRAME_MINIBUF_ONLY_P (f
))
4783 error ("Cannot resize a minibuffer-only frame");
4785 r
= XWINDOW (FRAME_ROOT_WINDOW (f
));
4786 height
= r
->pixel_height
+ w
->pixel_height
;
4787 if (window_resize_check (r
, 0)
4788 && XINT (w
->new_pixel
) > 0
4789 && height
== XINT (r
->new_pixel
) + XINT (w
->new_pixel
))
4792 window_resize_apply (r
, 0);
4794 w
->pixel_height
= XFASTINT (w
->new_pixel
);
4795 w
->total_lines
= w
->pixel_height
/ FRAME_LINE_HEIGHT (f
);
4796 w
->pixel_top
= r
->pixel_top
+ r
->pixel_height
;
4797 w
->top_line
= r
->top_line
+ r
->total_lines
;
4800 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
4801 adjust_frame_glyphs (f
);
4806 error ("Failed to resize minibuffer window");
4809 /* Mark window cursors off for all windows in the window tree rooted
4810 at W by setting their phys_cursor_on_p flag to zero. Called from
4811 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4812 the frame are cleared. */
4815 mark_window_cursors_off (struct window
*w
)
4819 if (WINDOWP (w
->contents
))
4820 mark_window_cursors_off (XWINDOW (w
->contents
));
4822 w
->phys_cursor_on_p
= 0;
4824 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
4829 /* Return number of lines of text (not counting mode lines) in W. */
4832 window_internal_height (struct window
*w
)
4834 int ht
= w
->total_lines
;
4836 if (!MINI_WINDOW_P (w
))
4838 if (!NILP (w
->parent
)
4839 || WINDOWP (w
->contents
)
4842 || WINDOW_WANTS_MODELINE_P (w
))
4845 if (WINDOW_WANTS_HEADER_LINE_P (w
))
4853 /************************************************************************
4855 ***********************************************************************/
4857 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4858 N screen-fulls, which is defined as the height of the window minus
4859 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4860 instead. Negative values of N mean scroll down. NOERROR non-zero
4861 means don't signal an error if we try to move over BEGV or ZV,
4865 window_scroll (Lisp_Object window
, EMACS_INT n
, bool whole
, int noerror
)
4867 ptrdiff_t count
= SPECPDL_INDEX ();
4870 n
= clip_to_bounds (INT_MIN
, n
, INT_MAX
);
4872 wset_redisplay (XWINDOW (window
));
4874 if (whole
&& Vfast_but_imprecise_scrolling
)
4875 specbind (Qfontification_functions
, Qnil
);
4877 /* If we must, use the pixel-based version which is much slower than
4878 the line-based one but can handle varying line heights. */
4879 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window
)->frame
)))
4880 window_scroll_pixel_based (window
, n
, whole
, noerror
);
4882 window_scroll_line_based (window
, n
, whole
, noerror
);
4884 unbind_to (count
, Qnil
);
4887 XWINDOW (window
)->window_end_valid
= 0;
4892 /* Implementation of window_scroll that works based on pixel line
4893 heights. See the comment of window_scroll for parameter
4897 window_scroll_pixel_based (Lisp_Object window
, int n
, bool whole
, int noerror
)
4900 struct window
*w
= XWINDOW (window
);
4901 struct text_pos start
;
4902 int this_scroll_margin
;
4903 /* True if we fiddled the window vscroll field without really scrolling. */
4905 int x
, y
, rtop
, rbot
, rowh
, vpos
;
4906 void *itdata
= NULL
;
4907 int window_total_lines
;
4908 int frame_line_height
= default_line_pixel_height (w
);
4909 bool adjust_old_pointm
= !NILP (Fequal (Fwindow_point (window
),
4910 Fwindow_old_point (window
)));
4912 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
4913 /* Scrolling a minibuffer window via scroll bar when the echo area
4914 shows long text sometimes resets the minibuffer contents behind
4916 if (CHARPOS (start
) > ZV
)
4917 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
4919 /* If PT is not visible in WINDOW, move back one half of
4920 the screen. Allow PT to be partially visible, otherwise
4921 something like (scroll-down 1) with PT in the line before
4922 the partially visible one would recenter. */
4924 if (!pos_visible_p (w
, PT
, &x
, &y
, &rtop
, &rbot
, &rowh
, &vpos
))
4926 itdata
= bidi_shelve_cache ();
4927 /* Move backward half the height of the window. Performance note:
4928 vmotion used here is about 10% faster, but would give wrong
4929 results for variable height lines. */
4930 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
4931 it
.current_y
= it
.last_visible_y
;
4932 move_it_vertically_backward (&it
, window_box_height (w
) / 2);
4934 /* The function move_iterator_vertically may move over more than
4935 the specified y-distance. If it->w is small, e.g. a
4936 mini-buffer window, we may end up in front of the window's
4937 display area. Start displaying at the start of the line
4938 containing PT in this case. */
4939 if (it
.current_y
<= 0)
4941 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
4942 move_it_vertically_backward (&it
, 0);
4946 start
= it
.current
.pos
;
4947 bidi_unshelve_cache (itdata
, 0);
4949 else if (auto_window_vscroll_p
)
4951 if (rtop
|| rbot
) /* Partially visible. */
4954 int dy
= frame_line_height
;
4955 /* In the below we divide the window box height by the
4956 frame's line height to make the result predictable when
4957 the window box is not an integral multiple of the line
4958 height. This is important to ensure we get back to the
4959 same position when scrolling up, then down. */
4961 dy
= max ((window_box_height (w
) / dy
4962 - next_screen_context_lines
) * dy
,
4968 /* Only vscroll backwards if already vscrolled forwards. */
4969 if (w
->vscroll
< 0 && rtop
> 0)
4971 px
= max (0, -w
->vscroll
- min (rtop
, -dy
));
4972 Fset_window_vscroll (window
, make_number (px
), Qt
);
4978 /* Do vscroll if already vscrolled or only display line. */
4979 if (rbot
> 0 && (w
->vscroll
< 0 || vpos
== 0))
4981 px
= max (0, -w
->vscroll
+ min (rbot
, dy
));
4982 Fset_window_vscroll (window
, make_number (px
), Qt
);
4986 /* Maybe modify window start instead of scrolling. */
4987 if (rbot
> 0 || w
->vscroll
< 0)
4991 Fset_window_vscroll (window
, make_number (0), Qt
);
4992 /* If there are other text lines above the current row,
4993 move window start to current row. Else to next row. */
4995 spos
= XINT (Fline_beginning_position (Qnil
));
4997 spos
= min (XINT (Fline_end_position (Qnil
)) + 1, ZV
);
4998 set_marker_restricted (w
->start
, make_number (spos
),
5000 w
->start_at_line_beg
= 1;
5001 w
->update_mode_line
= 1;
5002 /* Set force_start so that redisplay_window will run the
5003 window-scroll-functions. */
5009 /* Cancel previous vscroll. */
5010 Fset_window_vscroll (window
, make_number (0), Qt
);
5013 itdata
= bidi_shelve_cache ();
5014 /* If scroll_preserve_screen_position is non-nil, we try to set
5015 point in the same window line as it is now, so get that line. */
5016 if (!NILP (Vscroll_preserve_screen_position
))
5018 /* We preserve the goal pixel coordinate across consecutive
5019 calls to scroll-up, scroll-down and other commands that
5020 have the `scroll-command' property. This avoids the
5021 possibility of point becoming "stuck" on a tall line when
5022 scrolling by one line. */
5023 if (window_scroll_pixel_based_preserve_y
< 0
5024 || !SYMBOLP (KVAR (current_kboard
, Vlast_command
))
5025 || NILP (Fget (KVAR (current_kboard
, Vlast_command
), Qscroll_command
)))
5027 start_display (&it
, w
, start
);
5028 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
5029 window_scroll_pixel_based_preserve_y
= it
.current_y
;
5030 window_scroll_pixel_based_preserve_x
= it
.current_x
;
5034 window_scroll_pixel_based_preserve_y
5035 = window_scroll_pixel_based_preserve_x
= -1;
5037 /* Move iterator it from start the specified distance forward or
5038 backward. The result is the new window start. */
5039 start_display (&it
, w
, start
);
5042 ptrdiff_t start_pos
= IT_CHARPOS (it
);
5043 int dy
= frame_line_height
;
5044 /* In the below we divide the window box height by the frame's
5045 line height to make the result predictable when the window
5046 box is not an integral multiple of the line height. This is
5047 important to ensure we get back to the same position when
5048 scrolling up, then down. */
5049 dy
= max ((window_box_height (w
) / dy
- next_screen_context_lines
) * dy
,
5052 /* Note that move_it_vertically always moves the iterator to the
5053 start of a line. So, if the last line doesn't have a newline,
5054 we would end up at the start of the line ending at ZV. */
5057 move_it_vertically_backward (&it
, -dy
);
5058 /* Ensure we actually do move, e.g. in case we are currently
5059 looking at an image that is taller that the window height. */
5060 while (start_pos
== IT_CHARPOS (it
)
5061 && start_pos
> BEGV
)
5062 move_it_by_lines (&it
, -1);
5066 move_it_to (&it
, ZV
, -1, it
.current_y
+ dy
, -1,
5067 MOVE_TO_POS
| MOVE_TO_Y
);
5068 /* Ensure we actually do move, e.g. in case we are currently
5069 looking at an image that is taller that the window height. */
5070 while (start_pos
== IT_CHARPOS (it
)
5072 move_it_by_lines (&it
, 1);
5076 move_it_by_lines (&it
, n
);
5078 /* We failed if we find ZV is already on the screen (scrolling up,
5079 means there's nothing past the end), or if we can't start any
5080 earlier (scrolling down, means there's nothing past the top). */
5081 if ((n
> 0 && IT_CHARPOS (it
) == ZV
)
5082 || (n
< 0 && IT_CHARPOS (it
) == CHARPOS (start
)))
5084 if (IT_CHARPOS (it
) == ZV
)
5086 if (it
.current_y
< it
.last_visible_y
5087 && (it
.current_y
+ it
.max_ascent
+ it
.max_descent
5088 > it
.last_visible_y
))
5090 /* The last line was only partially visible, make it fully
5092 w
->vscroll
= (it
.last_visible_y
5093 - it
.current_y
+ it
.max_ascent
+ it
.max_descent
);
5094 adjust_frame_glyphs (it
.f
);
5098 bidi_unshelve_cache (itdata
, 0);
5101 else if (n
< 0) /* could happen with empty buffers */
5102 xsignal0 (Qbeginning_of_buffer
);
5104 xsignal0 (Qend_of_buffer
);
5109 if (w
->vscroll
!= 0)
5110 /* The first line was only partially visible, make it fully
5115 bidi_unshelve_cache (itdata
, 0);
5119 xsignal0 (Qbeginning_of_buffer
);
5123 /* If control gets here, then we vscrolled. */
5125 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
5127 /* Don't try to change the window start below. */
5133 ptrdiff_t pos
= IT_CHARPOS (it
);
5136 /* If in the middle of a multi-glyph character move forward to
5137 the next character. */
5138 if (in_display_vector_p (&it
))
5141 move_it_to (&it
, pos
, -1, -1, -1, MOVE_TO_POS
);
5144 /* Set the window start, and set up the window for redisplay. */
5145 set_marker_restricted_both (w
->start
, w
->contents
, IT_CHARPOS (it
),
5147 bytepos
= marker_byte_position (w
->start
);
5148 w
->start_at_line_beg
= (pos
== BEGV
|| FETCH_BYTE (bytepos
- 1) == '\n');
5149 w
->update_mode_line
= 1;
5150 /* Set force_start so that redisplay_window will run the
5151 window-scroll-functions. */
5155 /* The rest of this function uses current_y in a nonstandard way,
5156 not including the height of the header line if any. */
5157 it
.current_y
= it
.vpos
= 0;
5159 /* Move PT out of scroll margins.
5160 This code wants current_y to be zero at the window start position
5161 even if there is a header line. */
5163 = w
->total_lines
* WINDOW_FRAME_LINE_HEIGHT (w
) / frame_line_height
;
5164 this_scroll_margin
= max (0, scroll_margin
);
5166 = min (this_scroll_margin
, window_total_lines
/ 4);
5167 this_scroll_margin
*= frame_line_height
;
5171 /* We moved the window start towards ZV, so PT may be now
5172 in the scroll margin at the top. */
5173 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
5174 if (IT_CHARPOS (it
) == PT
&& it
.current_y
>= this_scroll_margin
5175 && (NILP (Vscroll_preserve_screen_position
)
5176 || EQ (Vscroll_preserve_screen_position
, Qt
)))
5177 /* We found PT at a legitimate height. Leave it alone. */
5179 else if (window_scroll_pixel_based_preserve_y
>= 0)
5181 /* If we have a header line, take account of it.
5182 This is necessary because we set it.current_y to 0, above. */
5183 move_it_to (&it
, -1,
5184 window_scroll_pixel_based_preserve_x
,
5185 window_scroll_pixel_based_preserve_y
5186 - (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0 ),
5187 -1, MOVE_TO_Y
| MOVE_TO_X
);
5188 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
5192 while (it
.current_y
< this_scroll_margin
)
5194 int prev
= it
.current_y
;
5195 move_it_by_lines (&it
, 1);
5196 if (prev
== it
.current_y
)
5199 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
5204 ptrdiff_t charpos
, bytepos
;
5207 /* Save our position, for the
5208 window_scroll_pixel_based_preserve_y case. */
5209 charpos
= IT_CHARPOS (it
);
5210 bytepos
= IT_BYTEPOS (it
);
5212 /* We moved the window start towards BEGV, so PT may be now
5213 in the scroll margin at the bottom. */
5214 move_it_to (&it
, PT
, -1,
5215 (it
.last_visible_y
- CURRENT_HEADER_LINE_HEIGHT (w
)
5216 - this_scroll_margin
- 1),
5218 MOVE_TO_POS
| MOVE_TO_Y
);
5220 /* Save our position, in case it's correct. */
5221 charpos
= IT_CHARPOS (it
);
5222 bytepos
= IT_BYTEPOS (it
);
5224 /* If PT is in the screen line at the last fully visible line,
5225 move_it_to will stop at X = 0 in that line, because the
5226 required Y coordinate is reached there. See if we can get to
5227 PT without descending lower in Y, and if we can, it means we
5228 reached PT before the scroll margin. */
5235 it_data
= bidi_shelve_cache ();
5236 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
5237 if (IT_CHARPOS (it
) == PT
&& it
.current_y
== it2
.current_y
)
5239 charpos
= IT_CHARPOS (it
);
5240 bytepos
= IT_BYTEPOS (it
);
5241 bidi_unshelve_cache (it_data
, 1);
5246 bidi_unshelve_cache (it_data
, 0);
5250 /* See if point is on a partially visible line at the end. */
5251 if (it
.what
== IT_EOB
)
5252 partial_p
= it
.current_y
+ it
.ascent
+ it
.descent
> it
.last_visible_y
;
5255 move_it_by_lines (&it
, 1);
5256 partial_p
= it
.current_y
> it
.last_visible_y
;
5259 if (charpos
== PT
&& !partial_p
5260 && (NILP (Vscroll_preserve_screen_position
)
5261 || EQ (Vscroll_preserve_screen_position
, Qt
)))
5262 /* We found PT before we found the display margin, so PT is ok. */
5264 else if (window_scroll_pixel_based_preserve_y
>= 0)
5266 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
5267 start_display (&it
, w
, start
);
5268 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
5269 here because we called start_display again and did not
5270 alter it.current_y this time. */
5271 move_it_to (&it
, -1, window_scroll_pixel_based_preserve_x
,
5272 window_scroll_pixel_based_preserve_y
, -1,
5273 MOVE_TO_Y
| MOVE_TO_X
);
5274 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
5279 /* The last line was only partially visible, so back up two
5280 lines to make sure we're on a fully visible line. */
5282 move_it_by_lines (&it
, -2);
5283 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
5286 /* No, the position we saved is OK, so use it. */
5287 SET_PT_BOTH (charpos
, bytepos
);
5290 bidi_unshelve_cache (itdata
, 0);
5292 if (adjust_old_pointm
)
5293 Fset_marker (w
->old_pointm
,
5294 ((w
== XWINDOW (selected_window
))
5295 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
5296 : Fmarker_position (w
->pointm
)),
5301 /* Implementation of window_scroll that works based on screen lines.
5302 See the comment of window_scroll for parameter descriptions. */
5305 window_scroll_line_based (Lisp_Object window
, int n
, bool whole
, int noerror
)
5307 register struct window
*w
= XWINDOW (window
);
5308 /* Fvertical_motion enters redisplay, which can trigger
5309 fontification, which in turn can modify buffer text (e.g., if the
5310 fontification functions replace escape sequences with faces, as
5311 in `grep-mode-font-lock-keywords'). So we use a marker to record
5312 the old point position, to prevent crashes in SET_PT_BOTH. */
5313 Lisp_Object opoint_marker
= Fpoint_marker ();
5314 register ptrdiff_t pos
, pos_byte
;
5315 register int ht
= window_internal_height (w
);
5316 register Lisp_Object tem
;
5319 ptrdiff_t startpos
= marker_position (w
->start
);
5320 ptrdiff_t startbyte
= marker_byte_position (w
->start
);
5321 Lisp_Object original_pos
= Qnil
;
5322 bool adjust_old_pointm
= !NILP (Fequal (Fwindow_point (window
),
5323 Fwindow_old_point (window
)));
5325 /* If scrolling screen-fulls, compute the number of lines to
5326 scroll from the window's height. */
5328 n
*= max (1, ht
- next_screen_context_lines
);
5330 if (!NILP (Vscroll_preserve_screen_position
))
5332 if (window_scroll_preserve_vpos
<= 0
5333 || !SYMBOLP (KVAR (current_kboard
, Vlast_command
))
5334 || NILP (Fget (KVAR (current_kboard
, Vlast_command
), Qscroll_command
)))
5336 struct position posit
5337 = *compute_motion (startpos
, startbyte
, 0, 0, 0,
5338 PT
, ht
, 0, -1, w
->hscroll
, 0, w
);
5340 window_scroll_preserve_vpos
= posit
.vpos
;
5341 window_scroll_preserve_hpos
= posit
.hpos
+ w
->hscroll
;
5344 original_pos
= Fcons (make_number (window_scroll_preserve_hpos
),
5345 make_number (window_scroll_preserve_vpos
));
5348 XSETFASTINT (tem
, PT
);
5349 tem
= Fpos_visible_in_window_p (tem
, window
, Qnil
);
5353 Fvertical_motion (make_number (- (ht
/ 2)), window
, Qnil
);
5355 startbyte
= PT_BYTE
;
5358 SET_PT_BOTH (startpos
, startbyte
);
5359 lose
= n
< 0 && PT
== BEGV
;
5360 Fvertical_motion (make_number (n
), window
, Qnil
);
5364 SET_PT_BOTH (marker_position (opoint_marker
),
5365 marker_byte_position (opoint_marker
));
5372 xsignal0 (Qbeginning_of_buffer
);
5377 /* Don't use a scroll margin that is negative or too large. */
5378 int this_scroll_margin
=
5379 max (0, min (scroll_margin
, w
->total_lines
/ 4));
5381 set_marker_restricted_both (w
->start
, w
->contents
, pos
, pos_byte
);
5382 w
->start_at_line_beg
= !NILP (bolp
);
5383 w
->update_mode_line
= 1;
5384 /* Set force_start so that redisplay_window will run
5385 the window-scroll-functions. */
5388 if (!NILP (Vscroll_preserve_screen_position
)
5389 && (whole
|| !EQ (Vscroll_preserve_screen_position
, Qt
)))
5391 SET_PT_BOTH (pos
, pos_byte
);
5392 Fvertical_motion (original_pos
, window
, Qnil
);
5394 /* If we scrolled forward, put point enough lines down
5395 that it is outside the scroll margin. */
5400 if (this_scroll_margin
> 0)
5402 SET_PT_BOTH (pos
, pos_byte
);
5403 Fvertical_motion (make_number (this_scroll_margin
), window
, Qnil
);
5409 if (top_margin
<= marker_position (opoint_marker
))
5410 SET_PT_BOTH (marker_position (opoint_marker
),
5411 marker_byte_position (opoint_marker
));
5412 else if (!NILP (Vscroll_preserve_screen_position
))
5414 SET_PT_BOTH (pos
, pos_byte
);
5415 Fvertical_motion (original_pos
, window
, Qnil
);
5418 SET_PT (top_margin
);
5424 /* If we scrolled backward, put point near the end of the window
5425 but not within the scroll margin. */
5426 SET_PT_BOTH (pos
, pos_byte
);
5427 tem
= Fvertical_motion (make_number (ht
- this_scroll_margin
), window
,
5429 if (XFASTINT (tem
) == ht
- this_scroll_margin
)
5432 bottom_margin
= PT
+ 1;
5434 if (bottom_margin
> marker_position (opoint_marker
))
5435 SET_PT_BOTH (marker_position (opoint_marker
),
5436 marker_byte_position (opoint_marker
));
5439 if (!NILP (Vscroll_preserve_screen_position
))
5441 SET_PT_BOTH (pos
, pos_byte
);
5442 Fvertical_motion (original_pos
, window
, Qnil
);
5445 Fvertical_motion (make_number (-1), window
, Qnil
);
5454 xsignal0 (Qend_of_buffer
);
5457 if (adjust_old_pointm
)
5458 Fset_marker (w
->old_pointm
,
5459 ((w
== XWINDOW (selected_window
))
5460 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
5461 : Fmarker_position (w
->pointm
)),
5466 /* Scroll selected_window up or down. If N is nil, scroll a
5467 screen-full which is defined as the height of the window minus
5468 next_screen_context_lines. If N is the symbol `-', scroll.
5469 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
5470 up. This is the guts of Fscroll_up and Fscroll_down. */
5473 scroll_command (Lisp_Object n
, int direction
)
5475 ptrdiff_t count
= SPECPDL_INDEX ();
5477 eassert (eabs (direction
) == 1);
5479 /* If selected window's buffer isn't current, make it current for
5480 the moment. But don't screw up if window_scroll gets an error. */
5481 if (XBUFFER (XWINDOW (selected_window
)->contents
) != current_buffer
)
5483 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
5484 Fset_buffer (XWINDOW (selected_window
)->contents
);
5488 window_scroll (selected_window
, direction
, 1, 0);
5489 else if (EQ (n
, Qminus
))
5490 window_scroll (selected_window
, -direction
, 1, 0);
5493 n
= Fprefix_numeric_value (n
);
5494 window_scroll (selected_window
, XINT (n
) * direction
, 0, 0);
5497 unbind_to (count
, Qnil
);
5500 DEFUN ("scroll-up", Fscroll_up
, Sscroll_up
, 0, 1, "^P",
5501 doc
: /* Scroll text of selected window upward ARG lines.
5502 If ARG is omitted or nil, scroll upward by a near full screen.
5503 A near full screen is `next-screen-context-lines' less than a full screen.
5504 Negative ARG means scroll downward.
5505 If ARG is the atom `-', scroll downward by nearly full screen.
5506 When calling from a program, supply as argument a number, nil, or `-'. */)
5509 scroll_command (arg
, 1);
5513 DEFUN ("scroll-down", Fscroll_down
, Sscroll_down
, 0, 1, "^P",
5514 doc
: /* Scroll text of selected window down ARG lines.
5515 If ARG is omitted or nil, scroll down by a near full screen.
5516 A near full screen is `next-screen-context-lines' less than a full screen.
5517 Negative ARG means scroll upward.
5518 If ARG is the atom `-', scroll upward by nearly full screen.
5519 When calling from a program, supply as argument a number, nil, or `-'. */)
5522 scroll_command (arg
, -1);
5526 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling
, Sother_window_for_scrolling
, 0, 0, 0,
5527 doc
: /* Return the other window for \"other window scroll\" commands.
5528 If `other-window-scroll-buffer' is non-nil, a window
5529 showing that buffer is used.
5530 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5531 specifies the window. This takes precedence over
5532 `other-window-scroll-buffer'. */)
5537 if (MINI_WINDOW_P (XWINDOW (selected_window
))
5538 && !NILP (Vminibuf_scroll_window
))
5539 window
= Vminibuf_scroll_window
;
5540 /* If buffer is specified and live, scroll that buffer. */
5541 else if (!NILP (Vother_window_scroll_buffer
)
5542 && BUFFERP (Vother_window_scroll_buffer
)
5543 && BUFFER_LIVE_P (XBUFFER (Vother_window_scroll_buffer
)))
5545 window
= Fget_buffer_window (Vother_window_scroll_buffer
, Qnil
);
5547 window
= display_buffer (Vother_window_scroll_buffer
, Qt
, Qnil
);
5551 /* Nothing specified; look for a neighboring window on the same
5553 window
= Fnext_window (selected_window
, Qnil
, Qnil
);
5555 if (EQ (window
, selected_window
))
5556 /* That didn't get us anywhere; look for a window on another
5559 window
= Fnext_window (window
, Qnil
, Qt
);
5560 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window
))))
5561 && ! EQ (window
, selected_window
));
5564 CHECK_LIVE_WINDOW (window
);
5566 if (EQ (window
, selected_window
))
5567 error ("There is no other window");
5572 DEFUN ("scroll-other-window", Fscroll_other_window
, Sscroll_other_window
, 0, 1, "P",
5573 doc
: /* Scroll next window upward ARG lines; or near full screen if no ARG.
5574 A near full screen is `next-screen-context-lines' less than a full screen.
5575 The next window is the one below the current one; or the one at the top
5576 if the current one is at the bottom. Negative ARG means scroll downward.
5577 If ARG is the atom `-', scroll downward by nearly full screen.
5578 When calling from a program, supply as argument a number, nil, or `-'.
5580 If `other-window-scroll-buffer' is non-nil, scroll the window
5581 showing that buffer, popping the buffer up if necessary.
5582 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5583 specifies the window to scroll. This takes precedence over
5584 `other-window-scroll-buffer'. */)
5589 ptrdiff_t count
= SPECPDL_INDEX ();
5591 window
= Fother_window_for_scrolling ();
5592 w
= XWINDOW (window
);
5594 /* Don't screw up if window_scroll gets an error. */
5595 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
5597 Fset_buffer (w
->contents
);
5598 SET_PT_BOTH (marker_position (w
->pointm
), marker_byte_position (w
->pointm
));
5599 SET_PT_BOTH (marker_position (w
->old_pointm
), marker_byte_position (w
->old_pointm
));
5602 window_scroll (window
, 1, 1, 1);
5603 else if (EQ (arg
, Qminus
))
5604 window_scroll (window
, -1, 1, 1);
5610 window_scroll (window
, XINT (arg
), 0, 1);
5613 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
5614 set_marker_both (w
->old_pointm
, Qnil
, PT
, PT_BYTE
);
5615 unbind_to (count
, Qnil
);
5620 DEFUN ("scroll-left", Fscroll_left
, Sscroll_left
, 0, 2, "^P\np",
5621 doc
: /* Scroll selected window display ARG columns left.
5622 Default for ARG is window width minus 2.
5623 Value is the total amount of leftward horizontal scrolling in
5624 effect after the change.
5625 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5626 lower bound for automatic scrolling, i.e. automatic scrolling
5627 will not scroll a window to a column less than the value returned
5628 by this function. This happens in an interactive call. */)
5629 (register Lisp_Object arg
, Lisp_Object set_minimum
)
5631 struct window
*w
= XWINDOW (selected_window
);
5632 EMACS_INT requested_arg
= (NILP (arg
)
5633 ? window_body_width (w
, 0) - 2
5634 : XINT (Fprefix_numeric_value (arg
)));
5635 Lisp_Object result
= set_window_hscroll (w
, w
->hscroll
+ requested_arg
);
5637 if (!NILP (set_minimum
))
5638 w
->min_hscroll
= w
->hscroll
;
5640 w
->suspend_auto_hscroll
= 1;
5645 DEFUN ("scroll-right", Fscroll_right
, Sscroll_right
, 0, 2, "^P\np",
5646 doc
: /* Scroll selected window display ARG columns right.
5647 Default for ARG is window width minus 2.
5648 Value is the total amount of leftward horizontal scrolling in
5649 effect after the change.
5650 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5651 lower bound for automatic scrolling, i.e. automatic scrolling
5652 will not scroll a window to a column less than the value returned
5653 by this function. This happens in an interactive call. */)
5654 (register Lisp_Object arg
, Lisp_Object set_minimum
)
5656 struct window
*w
= XWINDOW (selected_window
);
5657 EMACS_INT requested_arg
= (NILP (arg
)
5658 ? window_body_width (w
, 0) - 2
5659 : XINT (Fprefix_numeric_value (arg
)));
5660 Lisp_Object result
= set_window_hscroll (w
, w
->hscroll
- requested_arg
);
5662 if (!NILP (set_minimum
))
5663 w
->min_hscroll
= w
->hscroll
;
5665 w
->suspend_auto_hscroll
= 1;
5670 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window
, Sminibuffer_selected_window
, 0, 0, 0,
5671 doc
: /* Return the window which was selected when entering the minibuffer.
5672 Returns nil, if selected window is not a minibuffer window. */)
5675 if (minibuf_level
> 0
5676 && MINI_WINDOW_P (XWINDOW (selected_window
))
5677 && WINDOW_LIVE_P (minibuf_selected_window
))
5678 return minibuf_selected_window
;
5683 /* Value is the number of lines actually displayed in window W,
5684 as opposed to its height. */
5687 displayed_window_lines (struct window
*w
)
5690 struct text_pos start
;
5691 int height
= window_box_height (w
);
5692 struct buffer
*old_buffer
;
5694 void *itdata
= NULL
;
5696 if (XBUFFER (w
->contents
) != current_buffer
)
5698 old_buffer
= current_buffer
;
5699 set_buffer_internal (XBUFFER (w
->contents
));
5704 /* In case W->start is out of the accessible range, do something
5705 reasonable. This happens in Info mode when Info-scroll-down
5706 calls (recenter -1) while W->start is 1. */
5707 CLIP_TEXT_POS_FROM_MARKER (start
, w
->start
);
5709 itdata
= bidi_shelve_cache ();
5710 start_display (&it
, w
, start
);
5711 move_it_vertically (&it
, height
);
5712 bottom_y
= line_bottom_y (&it
);
5713 bidi_unshelve_cache (itdata
, 0);
5715 /* rms: On a non-window display,
5716 the value of it.vpos at the bottom of the screen
5717 seems to be 1 larger than window_box_height (w).
5718 This kludge fixes a bug whereby (move-to-window-line -1)
5719 when ZV is on the last screen line
5720 moves to the previous screen line instead of the last one. */
5721 if (! FRAME_WINDOW_P (XFRAME (w
->frame
)))
5724 /* Add in empty lines at the bottom of the window. */
5725 if (bottom_y
< height
)
5727 int uy
= FRAME_LINE_HEIGHT (it
.f
);
5728 it
.vpos
+= (height
- bottom_y
+ uy
- 1) / uy
;
5732 set_buffer_internal (old_buffer
);
5738 DEFUN ("recenter", Frecenter
, Srecenter
, 0, 1, "P",
5739 doc
: /* Center point in selected window and maybe redisplay frame.
5740 With a numeric prefix argument ARG, recenter putting point on screen line ARG
5741 relative to the selected window. If ARG is negative, it counts up from the
5742 bottom of the window. (ARG should be less than the height of the window.)
5744 If ARG is omitted or nil, then recenter with point on the middle line of
5745 the selected window; if the variable `recenter-redisplay' is non-nil,
5746 also erase the entire frame and redraw it (when `auto-resize-tool-bars'
5747 is set to `grow-only', this resets the tool-bar's height to the minimum
5748 height needed); if `recenter-redisplay' has the special value `tty',
5749 then only tty frames are redrawn.
5751 Just C-u as prefix means put point in the center of the window
5752 and redisplay normally--don't erase and redraw the frame. */)
5753 (register Lisp_Object arg
)
5755 struct window
*w
= XWINDOW (selected_window
);
5756 struct buffer
*buf
= XBUFFER (w
->contents
);
5758 ptrdiff_t charpos
, bytepos
;
5759 EMACS_INT iarg
IF_LINT (= 0);
5760 int this_scroll_margin
;
5762 if (buf
!= current_buffer
)
5763 error ("`recenter'ing a window that does not display current-buffer.");
5765 /* If redisplay is suppressed due to an error, try again. */
5766 buf
->display_error_modiff
= 0;
5770 if (!NILP (Vrecenter_redisplay
)
5771 && (!EQ (Vrecenter_redisplay
, Qtty
)
5772 || !NILP (Ftty_type (selected_frame
))))
5776 /* Invalidate pixel data calculated for all compositions. */
5777 for (i
= 0; i
< n_compositions
; i
++)
5778 composition_table
[i
]->font
= NULL
;
5779 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5780 WINDOW_XFRAME (w
)->minimize_tool_bar_window_p
= 1;
5782 Fredraw_frame (WINDOW_FRAME (w
));
5783 SET_FRAME_GARBAGED (WINDOW_XFRAME (w
));
5788 else if (CONSP (arg
)) /* Just C-u. */
5792 arg
= Fprefix_numeric_value (arg
);
5797 /* Do this after making BUF current
5798 in case scroll_margin is buffer-local. */
5800 = max (0, min (scroll_margin
, w
->total_lines
/ 4));
5802 /* Handle centering on a graphical frame specially. Such frames can
5803 have variable-height lines and centering point on the basis of
5804 line counts would lead to strange effects. */
5805 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
5811 void *itdata
= bidi_shelve_cache ();
5813 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
5814 start_display (&it
, w
, pt
);
5815 move_it_vertically_backward (&it
, window_box_height (w
) / 2);
5816 charpos
= IT_CHARPOS (it
);
5817 bytepos
= IT_BYTEPOS (it
);
5818 bidi_unshelve_cache (itdata
, 0);
5824 ptrdiff_t nlines
= min (PTRDIFF_MAX
, -iarg
);
5825 int extra_line_spacing
;
5826 int h
= window_box_height (w
);
5827 void *itdata
= bidi_shelve_cache ();
5829 iarg
= - max (-iarg
, this_scroll_margin
);
5831 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
5832 start_display (&it
, w
, pt
);
5834 /* Be sure we have the exact height of the full line containing PT. */
5835 move_it_by_lines (&it
, 0);
5837 /* The amount of pixels we have to move back is the window
5838 height minus what's displayed in the line containing PT,
5839 and the lines below. */
5842 move_it_by_lines (&it
, nlines
);
5844 if (it
.vpos
== nlines
)
5848 /* Last line has no newline. */
5849 h
-= line_bottom_y (&it
);
5853 /* Don't reserve space for extra line spacing of last line. */
5854 extra_line_spacing
= it
.max_extra_line_spacing
;
5856 /* If we can't move down NLINES lines because we hit
5857 the end of the buffer, count in some empty lines. */
5858 if (it
.vpos
< nlines
)
5861 extra_line_spacing
= it
.extra_line_spacing
;
5862 h
-= nlines
* (FRAME_LINE_HEIGHT (it
.f
) + extra_line_spacing
);
5866 bidi_unshelve_cache (itdata
, 0);
5870 /* Now find the new top line (starting position) of the window. */
5871 start_display (&it
, w
, pt
);
5873 move_it_vertically_backward (&it
, h
);
5875 /* If extra line spacing is present, we may move too far
5876 back. This causes the last line to be only partially
5877 visible (which triggers redisplay to recenter that line
5878 in the middle), so move forward.
5879 But ignore extra line spacing on last line, as it is not
5880 considered to be part of the visible height of the line.
5882 h
+= extra_line_spacing
;
5883 while (-it
.current_y
> h
)
5884 move_it_by_lines (&it
, 1);
5886 charpos
= IT_CHARPOS (it
);
5887 bytepos
= IT_BYTEPOS (it
);
5889 bidi_unshelve_cache (itdata
, 0);
5893 struct position pos
;
5895 iarg
= max (iarg
, this_scroll_margin
);
5897 pos
= *vmotion (PT
, PT_BYTE
, -iarg
, w
);
5898 charpos
= pos
.bufpos
;
5899 bytepos
= pos
.bytepos
;
5904 struct position pos
;
5905 int ht
= window_internal_height (w
);
5912 /* Don't let it get into the margin at either top or bottom. */
5913 iarg
= clip_to_bounds (this_scroll_margin
, iarg
,
5914 ht
- this_scroll_margin
- 1);
5916 pos
= *vmotion (PT
, PT_BYTE
, - iarg
, w
);
5917 charpos
= pos
.bufpos
;
5918 bytepos
= pos
.bytepos
;
5921 /* Set the new window start. */
5922 set_marker_both (w
->start
, w
->contents
, charpos
, bytepos
);
5923 w
->window_end_valid
= 0;
5925 w
->optional_new_start
= 1;
5927 w
->start_at_line_beg
= (bytepos
== BEGV_BYTE
5928 || FETCH_BYTE (bytepos
- 1) == '\n');
5935 DEFUN ("window-text-width", Fwindow_text_width
, Swindow_text_width
,
5937 doc
: /* Return the width in columns of the text display area of WINDOW.
5938 WINDOW must be a live window and defaults to the selected one.
5940 The returned width does not include dividers, scrollbars, margins,
5941 fringes, nor any partial-width columns at the right of the text
5944 Optional argument PIXELWISE non-nil, means to return the width in
5946 (Lisp_Object window
, Lisp_Object pixelwise
)
5948 struct window
*w
= decode_live_window (window
);
5950 if (NILP (pixelwise
))
5951 return make_number (window_box_width (w
, TEXT_AREA
)
5952 / FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
)));
5954 return make_number (window_box_width (w
, TEXT_AREA
));
5957 DEFUN ("window-text-height", Fwindow_text_height
, Swindow_text_height
,
5959 doc
: /* Return the height in lines of the text display area of WINDOW.
5960 WINDOW must be a live window and defaults to the selected one.
5962 The returned height does not include dividers, the mode line, any header
5963 line, nor any partial-height lines at the bottom of the text area.
5965 Optional argument PIXELWISE non-nil, means to return the height in
5967 (Lisp_Object window
, Lisp_Object pixelwise
)
5969 struct window
*w
= decode_live_window (window
);
5971 if (NILP (pixelwise
))
5972 return make_number (window_box_height (w
)
5973 / FRAME_LINE_HEIGHT (WINDOW_XFRAME (w
)));
5975 return make_number (window_box_height (w
));
5978 DEFUN ("move-to-window-line", Fmove_to_window_line
, Smove_to_window_line
,
5980 doc
: /* Position point relative to window.
5981 ARG nil means position point at center of window.
5982 Else, ARG specifies vertical position within the window;
5983 zero means top of window, negative means relative to bottom of window. */)
5986 struct window
*w
= XWINDOW (selected_window
);
5990 int this_scroll_margin
;
5993 if (!(BUFFERP (w
->contents
) && XBUFFER (w
->contents
) == current_buffer
))
5994 /* This test is needed to make sure PT/PT_BYTE make sense in w->contents
5995 when passed below to set_marker_both. */
5996 error ("move-to-window-line called from unrelated buffer");
5998 window
= selected_window
;
5999 start
= marker_position (w
->start
);
6000 if (start
< BEGV
|| start
> ZV
)
6002 int height
= window_internal_height (w
);
6003 Fvertical_motion (make_number (- (height
/ 2)), window
, Qnil
);
6004 set_marker_both (w
->start
, w
->contents
, PT
, PT_BYTE
);
6005 w
->start_at_line_beg
= !NILP (Fbolp ());
6009 Fgoto_char (w
->start
);
6011 lines
= displayed_window_lines (w
);
6014 this_scroll_margin
= max (0, min (scroll_margin
, lines
/ 4));
6018 XSETFASTINT (arg
, lines
/ 2);
6021 EMACS_INT iarg
= XINT (Fprefix_numeric_value (arg
));
6024 iarg
= iarg
+ lines
;
6026 #if 0 /* This code would prevent move-to-window-line from moving point
6027 to a place inside the scroll margins (which would cause the
6028 next redisplay to scroll). I wrote this code, but then concluded
6029 it is probably better not to install it. However, it is here
6030 inside #if 0 so as not to lose it. -- rms. */
6032 /* Don't let it get into the margin at either top or bottom. */
6033 iarg
= max (iarg
, this_scroll_margin
);
6034 iarg
= min (iarg
, lines
- this_scroll_margin
- 1);
6037 arg
= make_number (iarg
);
6040 /* Skip past a partially visible first line. */
6042 XSETINT (arg
, XINT (arg
) + 1);
6044 return Fvertical_motion (arg
, window
, Qnil
);
6049 /***********************************************************************
6050 Window Configuration
6051 ***********************************************************************/
6053 struct save_window_data
6055 struct vectorlike_header header
;
6056 Lisp_Object selected_frame
;
6057 Lisp_Object current_window
;
6058 Lisp_Object current_buffer
;
6059 Lisp_Object minibuf_scroll_window
;
6060 Lisp_Object minibuf_selected_window
;
6061 Lisp_Object root_window
;
6062 Lisp_Object focus_frame
;
6063 /* A vector, each of whose elements is a struct saved_window
6065 Lisp_Object saved_windows
;
6067 /* All fields above are traced by the GC.
6068 From `frame-cols' down, the fields are ignored by the GC. */
6069 /* We should be able to do without the following two. */
6070 int frame_cols
, frame_lines
;
6071 /* These two should get eventually replaced by their pixel
6073 int frame_menu_bar_lines
, frame_tool_bar_lines
;
6074 int frame_text_width
, frame_text_height
;
6075 /* These are currently unused. We need them as soon as we convert
6077 int frame_menu_bar_height
, frame_tool_bar_height
;
6080 /* This is saved as a Lisp_Vector. */
6083 struct vectorlike_header header
;
6085 Lisp_Object window
, buffer
, start
, pointm
, old_pointm
;
6086 Lisp_Object pixel_left
, pixel_top
, pixel_height
, pixel_width
;
6087 Lisp_Object left_col
, top_line
, total_cols
, total_lines
;
6088 Lisp_Object normal_cols
, normal_lines
;
6089 Lisp_Object hscroll
, min_hscroll
, hscroll_whole
, suspend_auto_hscroll
;
6090 Lisp_Object parent
, prev
;
6091 Lisp_Object start_at_line_beg
;
6092 Lisp_Object display_table
;
6093 Lisp_Object left_margin_cols
, right_margin_cols
;
6094 Lisp_Object left_fringe_width
, right_fringe_width
, fringes_outside_margins
;
6095 Lisp_Object scroll_bar_width
, vertical_scroll_bar_type
, dedicated
;
6096 Lisp_Object scroll_bar_height
, horizontal_scroll_bar_type
;
6097 Lisp_Object combination_limit
, window_parameters
;
6100 #define SAVED_WINDOW_N(swv,n) \
6101 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
6103 DEFUN ("window-configuration-p", Fwindow_configuration_p
, Swindow_configuration_p
, 1, 1, 0,
6104 doc
: /* Return t if OBJECT is a window-configuration object. */)
6105 (Lisp_Object object
)
6107 return WINDOW_CONFIGURATIONP (object
) ? Qt
: Qnil
;
6110 DEFUN ("window-configuration-frame", Fwindow_configuration_frame
, Swindow_configuration_frame
, 1, 1, 0,
6111 doc
: /* Return the frame that CONFIG, a window-configuration object, is about. */)
6112 (Lisp_Object config
)
6114 register struct save_window_data
*data
;
6115 struct Lisp_Vector
*saved_windows
;
6117 CHECK_WINDOW_CONFIGURATION (config
);
6119 data
= (struct save_window_data
*) XVECTOR (config
);
6120 saved_windows
= XVECTOR (data
->saved_windows
);
6121 return XWINDOW (SAVED_WINDOW_N (saved_windows
, 0)->window
)->frame
;
6124 DEFUN ("set-window-configuration", Fset_window_configuration
,
6125 Sset_window_configuration
, 1, 1, 0,
6126 doc
: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
6127 CONFIGURATION must be a value previously returned
6128 by `current-window-configuration' (which see).
6129 If CONFIGURATION was made from a frame that is now deleted,
6130 only frame-independent values can be restored. In this case,
6131 the return value is nil. Otherwise the value is t. */)
6132 (Lisp_Object configuration
)
6134 register struct save_window_data
*data
;
6135 struct Lisp_Vector
*saved_windows
;
6136 Lisp_Object new_current_buffer
;
6139 ptrdiff_t old_point
= -1;
6142 CHECK_WINDOW_CONFIGURATION (configuration
);
6144 data
= (struct save_window_data
*) XVECTOR (configuration
);
6145 saved_windows
= XVECTOR (data
->saved_windows
);
6147 new_current_buffer
= data
->current_buffer
;
6148 if (!BUFFER_LIVE_P (XBUFFER (new_current_buffer
)))
6149 new_current_buffer
= Qnil
;
6152 if (XBUFFER (new_current_buffer
) == current_buffer
)
6153 /* The code further down "preserves point" by saving here PT in
6154 old_point and then setting it later back into PT. When the
6155 current-selected-window and the final-selected-window both show
6156 the current buffer, this suffers from the problem that the
6157 current PT is the window-point of the current-selected-window,
6158 while the final PT is the point of the final-selected-window, so
6159 this copy from one PT to the other would end up moving the
6160 window-point of the final-selected-window to the window-point of
6161 the current-selected-window. So we have to be careful which
6162 point of the current-buffer we copy into old_point. */
6163 if (EQ (XWINDOW (data
->current_window
)->contents
, new_current_buffer
)
6164 && WINDOWP (selected_window
)
6165 && EQ (XWINDOW (selected_window
)->contents
, new_current_buffer
)
6166 && !EQ (selected_window
, data
->current_window
))
6167 old_point
= marker_position (XWINDOW (data
->current_window
)->pointm
);
6171 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
6172 point in new_current_buffer as of the last time this buffer was
6173 used. This can be non-deterministic since it can be changed by
6174 things like jit-lock by mere temporary selection of some random
6175 window that happens to show this buffer.
6176 So if possible we want this arbitrary choice of "which point" to
6177 be the one from the to-be-selected-window so as to prevent this
6178 window's cursor from being copied from another window. */
6179 if (EQ (XWINDOW (data
->current_window
)->contents
, new_current_buffer
)
6180 /* If current_window = selected_window, its point is in BUF_PT. */
6181 && !EQ (selected_window
, data
->current_window
))
6182 old_point
= marker_position (XWINDOW (data
->current_window
)->pointm
);
6184 old_point
= BUF_PT (XBUFFER (new_current_buffer
));
6187 frame
= XWINDOW (SAVED_WINDOW_N (saved_windows
, 0)->window
)->frame
;
6190 /* If f is a dead frame, don't bother rebuilding its window tree.
6191 However, there is other stuff we should still try to do below. */
6192 if (FRAME_LIVE_P (f
))
6195 Lisp_Object dead_windows
= Qnil
;
6196 register Lisp_Object tem
, par
, pers
;
6197 register struct window
*w
;
6198 register struct saved_window
*p
;
6199 struct window
*root_window
;
6200 struct window
**leaf_windows
;
6205 /* Don't do this within the main loop below: This may call Lisp
6206 code and is thus potentially unsafe while input is blocked. */
6207 for (k
= 0; k
< saved_windows
->header
.size
; k
++)
6209 p
= SAVED_WINDOW_N (saved_windows
, k
);
6211 w
= XWINDOW (window
);
6212 if (BUFFERP (w
->contents
)
6213 && !EQ (w
->contents
, p
->buffer
)
6214 && BUFFER_LIVE_P (XBUFFER (p
->buffer
)))
6215 /* If a window we restore gets another buffer, record the
6216 window's old buffer. */
6217 call1 (Qrecord_window_buffer
, window
);
6220 /* Disallow x_set_window_size, temporarily. */
6221 f
->can_x_set_window_size
= false;
6222 /* The mouse highlighting code could get screwed up
6223 if it runs during this. */
6226 /* "Swap out" point from the selected window's buffer
6227 into the window itself. (Normally the pointm of the selected
6228 window holds garbage.) We do this now, before
6229 restoring the window contents, and prevent it from
6230 being done later on when we select a new window. */
6231 if (! NILP (XWINDOW (selected_window
)->contents
))
6233 w
= XWINDOW (selected_window
);
6234 set_marker_both (w
->pointm
,
6236 BUF_PT (XBUFFER (w
->contents
)),
6237 BUF_PT_BYTE (XBUFFER (w
->contents
)));
6241 FRAME_WINDOW_SIZES_CHANGED (f
) = 1;
6243 /* Problem: Freeing all matrices and later allocating them again
6244 is a serious redisplay flickering problem. What we would
6245 really like to do is to free only those matrices not reused
6247 root_window
= XWINDOW (FRAME_ROOT_WINDOW (f
));
6248 int nwindows
= count_windows (root_window
);
6249 SAFE_NALLOCA (leaf_windows
, 1, nwindows
);
6250 n_leaf_windows
= get_leaf_windows (root_window
, leaf_windows
, 0);
6253 Mark all windows now on frame as "deleted".
6254 Restoring the new configuration "undeletes" any that are in it.
6256 Save their current buffers in their height fields, since we may
6257 need it later, if a buffer saved in the configuration is now
6259 delete_all_child_windows (FRAME_ROOT_WINDOW (f
));
6261 for (k
= 0; k
< saved_windows
->header
.size
; k
++)
6263 p
= SAVED_WINDOW_N (saved_windows
, k
);
6265 w
= XWINDOW (window
);
6266 wset_next (w
, Qnil
);
6268 if (!NILP (p
->parent
))
6270 (w
, SAVED_WINDOW_N (saved_windows
, XFASTINT (p
->parent
))->window
);
6272 wset_parent (w
, Qnil
);
6274 if (!NILP (p
->prev
))
6277 (w
, SAVED_WINDOW_N (saved_windows
, XFASTINT (p
->prev
))->window
);
6278 wset_next (XWINDOW (w
->prev
), p
->window
);
6282 wset_prev (w
, Qnil
);
6283 if (!NILP (w
->parent
))
6284 wset_combination (XWINDOW (w
->parent
),
6285 (XINT (p
->total_cols
)
6286 != XWINDOW (w
->parent
)->total_cols
),
6290 /* If we squirreled away the buffer, restore it now. */
6291 if (BUFFERP (w
->combination_limit
))
6292 wset_buffer (w
, w
->combination_limit
);
6293 w
->pixel_left
= XFASTINT (p
->pixel_left
);
6294 w
->pixel_top
= XFASTINT (p
->pixel_top
);
6295 w
->pixel_width
= XFASTINT (p
->pixel_width
);
6296 w
->pixel_height
= XFASTINT (p
->pixel_height
);
6297 w
->left_col
= XFASTINT (p
->left_col
);
6298 w
->top_line
= XFASTINT (p
->top_line
);
6299 w
->total_cols
= XFASTINT (p
->total_cols
);
6300 w
->total_lines
= XFASTINT (p
->total_lines
);
6301 wset_normal_cols (w
, p
->normal_cols
);
6302 wset_normal_lines (w
, p
->normal_lines
);
6303 w
->hscroll
= XFASTINT (p
->hscroll
);
6304 w
->suspend_auto_hscroll
= !NILP (p
->suspend_auto_hscroll
);
6305 w
->min_hscroll
= XFASTINT (p
->min_hscroll
);
6306 w
->hscroll_whole
= XFASTINT (p
->hscroll_whole
);
6307 wset_display_table (w
, p
->display_table
);
6308 w
->left_margin_cols
= XINT (p
->left_margin_cols
);
6309 w
->right_margin_cols
= XINT (p
->right_margin_cols
);
6310 w
->left_fringe_width
= XINT (p
->left_fringe_width
);
6311 w
->right_fringe_width
= XINT (p
->right_fringe_width
);
6312 w
->fringes_outside_margins
= !NILP (p
->fringes_outside_margins
);
6313 w
->scroll_bar_width
= XINT (p
->scroll_bar_width
);
6314 w
->scroll_bar_height
= XINT (p
->scroll_bar_height
);
6315 wset_vertical_scroll_bar_type (w
, p
->vertical_scroll_bar_type
);
6316 wset_horizontal_scroll_bar_type (w
, p
->horizontal_scroll_bar_type
);
6317 wset_dedicated (w
, p
->dedicated
);
6318 wset_combination_limit (w
, p
->combination_limit
);
6319 /* Restore any window parameters that have been saved.
6320 Parameters that have not been saved are left alone. */
6321 for (tem
= p
->window_parameters
; CONSP (tem
); tem
= XCDR (tem
))
6326 if (NILP (XCDR (pers
)))
6328 par
= Fassq (XCAR (pers
), w
->window_parameters
);
6329 if (CONSP (par
) && !NILP (XCDR (par
)))
6330 /* Reset a parameter to nil if and only if it
6331 has a non-nil association. Don't make new
6333 Fsetcdr (par
, Qnil
);
6336 /* Always restore a non-nil value. */
6337 Fset_window_parameter (window
, XCAR (pers
), XCDR (pers
));
6341 if (BUFFERP (p
->buffer
) && BUFFER_LIVE_P (XBUFFER (p
->buffer
)))
6342 /* If saved buffer is alive, install it. */
6344 wset_buffer (w
, p
->buffer
);
6345 w
->start_at_line_beg
= !NILP (p
->start_at_line_beg
);
6346 set_marker_restricted (w
->start
, p
->start
, w
->contents
);
6347 set_marker_restricted (w
->pointm
, p
->pointm
, w
->contents
);
6348 set_marker_restricted (w
->old_pointm
, p
->old_pointm
, w
->contents
);
6349 /* As documented in Fcurrent_window_configuration, don't
6350 restore the location of point in the buffer which was
6351 current when the window configuration was recorded. */
6352 if (!EQ (p
->buffer
, new_current_buffer
)
6353 && XBUFFER (p
->buffer
) == current_buffer
)
6354 Fgoto_char (w
->pointm
);
6356 else if (BUFFERP (w
->contents
) && BUFFER_LIVE_P (XBUFFER (w
->contents
)))
6357 /* Keep window's old buffer; make sure the markers are real. */
6359 /* Set window markers at start of visible range. */
6360 if (XMARKER (w
->start
)->buffer
== 0)
6361 set_marker_restricted_both (w
->start
, w
->contents
, 0, 0);
6362 if (XMARKER (w
->pointm
)->buffer
== 0)
6363 set_marker_restricted_both
6364 (w
->pointm
, w
->contents
,
6365 BUF_PT (XBUFFER (w
->contents
)),
6366 BUF_PT_BYTE (XBUFFER (w
->contents
)));
6367 if (XMARKER (w
->old_pointm
)->buffer
== 0)
6368 set_marker_restricted_both
6369 (w
->old_pointm
, w
->contents
,
6370 BUF_PT (XBUFFER (w
->contents
)),
6371 BUF_PT_BYTE (XBUFFER (w
->contents
)));
6372 w
->start_at_line_beg
= 1;
6374 else if (!NILP (w
->start
))
6375 /* Leaf window has no live buffer, get one. */
6377 /* Get the buffer via other_buffer_safely in order to
6378 avoid showing an unimportant buffer and, if necessary, to
6379 recreate *scratch* in the course (part of Juanma's bs-show
6380 scenario from March 2011). */
6381 wset_buffer (w
, other_buffer_safely (Fcurrent_buffer ()));
6382 /* This will set the markers to beginning of visible
6384 set_marker_restricted_both (w
->start
, w
->contents
, 0, 0);
6385 set_marker_restricted_both (w
->pointm
, w
->contents
, 0, 0);
6386 set_marker_restricted_both (w
->old_pointm
, w
->contents
, 0, 0);
6387 w
->start_at_line_beg
= 1;
6388 if (!NILP (w
->dedicated
))
6389 /* Record this window as dead. */
6390 dead_windows
= Fcons (window
, dead_windows
);
6391 /* Make sure window is no more dedicated. */
6392 wset_dedicated (w
, Qnil
);
6396 fset_root_window (f
, data
->root_window
);
6397 /* Arrange *not* to restore point in the buffer that was
6398 current when the window configuration was saved. */
6399 if (EQ (XWINDOW (data
->current_window
)->contents
, new_current_buffer
))
6400 set_marker_restricted (XWINDOW (data
->current_window
)->pointm
,
6401 make_number (old_point
),
6402 XWINDOW (data
->current_window
)->contents
);
6404 /* In the following call to `select-window', prevent "swapping out
6405 point" in the old selected window using the buffer that has
6406 been restored into it. We already swapped out that point from
6407 that window's old buffer.
6409 Do not record the buffer here. We do that in a separate call
6410 to select_window below. See also Bug#16207. */
6411 select_window (data
->current_window
, Qt
, 1);
6412 BVAR (XBUFFER (XWINDOW (selected_window
)->contents
),
6413 last_selected_window
)
6416 if (NILP (data
->focus_frame
)
6417 || (FRAMEP (data
->focus_frame
)
6418 && FRAME_LIVE_P (XFRAME (data
->focus_frame
))))
6419 Fredirect_frame_focus (frame
, data
->focus_frame
);
6421 /* Now, free glyph matrices in windows that were not reused. */
6422 for (i
= n
= 0; i
< n_leaf_windows
; ++i
)
6424 if (NILP (leaf_windows
[i
]->contents
))
6425 free_window_matrices (leaf_windows
[i
]);
6426 else if (EQ (leaf_windows
[i
]->contents
, new_current_buffer
))
6430 /* Allow x_set_window_size again and apply frame size changes if
6432 f
->can_x_set_window_size
= true;
6433 adjust_frame_size (f
, -1, -1, 1, 0, Qset_window_configuration
);
6435 adjust_frame_glyphs (f
);
6438 /* Scan dead buffer windows. */
6439 for (; CONSP (dead_windows
); dead_windows
= XCDR (dead_windows
))
6441 window
= XCAR (dead_windows
);
6442 if (WINDOW_LIVE_P (window
) && !EQ (window
, FRAME_ROOT_WINDOW (f
)))
6443 delete_deletable_window (window
);
6446 /* Record the selected window's buffer here. The window should
6447 already be the selected one from the call above. */
6448 select_window (data
->current_window
, Qnil
, 0);
6450 /* Fselect_window will have made f the selected frame, so we
6451 reselect the proper frame here. Fhandle_switch_frame will change the
6452 selected window too, but that doesn't make the call to
6453 Fselect_window above totally superfluous; it still sets f's
6455 if (FRAME_LIVE_P (XFRAME (data
->selected_frame
)))
6456 do_switch_frame (data
->selected_frame
, 0, 0, Qnil
);
6458 run_window_configuration_change_hook (f
);
6461 if (!NILP (new_current_buffer
))
6463 Fset_buffer (new_current_buffer
);
6464 /* If the new current buffer doesn't appear in the selected
6465 window, go to its old point (see bug#12208). */
6466 if (!EQ (XWINDOW (data
->current_window
)->contents
, new_current_buffer
))
6467 Fgoto_char (make_number (old_point
));
6470 Vminibuf_scroll_window
= data
->minibuf_scroll_window
;
6471 minibuf_selected_window
= data
->minibuf_selected_window
;
6474 return (FRAME_LIVE_P (f
) ? Qt
: Qnil
);
6479 restore_window_configuration (Lisp_Object configuration
)
6481 Fset_window_configuration (configuration
);
6485 /* If WINDOW is an internal window, recursively delete all child windows
6486 reachable via the next and contents slots of WINDOW. Otherwise setup
6487 WINDOW to not show any buffer. */
6490 delete_all_child_windows (Lisp_Object window
)
6492 register struct window
*w
;
6494 w
= XWINDOW (window
);
6496 if (!NILP (w
->next
))
6497 /* Delete WINDOW's siblings (we traverse postorderly). */
6498 delete_all_child_windows (w
->next
);
6500 if (WINDOWP (w
->contents
))
6502 delete_all_child_windows (w
->contents
);
6503 wset_combination (w
, 0, Qnil
);
6505 else if (BUFFERP (w
->contents
))
6508 unchain_marker (XMARKER (w
->pointm
));
6509 unchain_marker (XMARKER (w
->old_pointm
));
6510 unchain_marker (XMARKER (w
->start
));
6511 /* Since combination limit makes sense for an internal windows
6512 only, we use this slot to save the buffer for the sake of
6513 possible resurrection in Fset_window_configuration. */
6514 wset_combination_limit (w
, w
->contents
);
6515 wset_buffer (w
, Qnil
);
6518 Vwindow_list
= Qnil
;
6522 count_windows (register struct window
*window
)
6524 register int count
= 1;
6525 if (!NILP (window
->next
))
6526 count
+= count_windows (XWINDOW (window
->next
));
6527 if (WINDOWP (window
->contents
))
6528 count
+= count_windows (XWINDOW (window
->contents
));
6533 /* Fill vector FLAT with leaf windows under W, starting at index I.
6534 Value is last index + 1. */
6536 get_leaf_windows (struct window
*w
, struct window
**flat
, int i
)
6540 if (WINDOWP (w
->contents
))
6541 i
= get_leaf_windows (XWINDOW (w
->contents
), flat
, i
);
6545 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
6552 /* Return a pointer to the glyph W's physical cursor is on. Value is
6553 null if W's current matrix is invalid, so that no meaningful glyph
6556 get_phys_cursor_glyph (struct window
*w
)
6558 struct glyph_row
*row
;
6559 struct glyph
*glyph
;
6560 int hpos
= w
->phys_cursor
.hpos
;
6562 if (!(w
->phys_cursor
.vpos
>= 0
6563 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
))
6566 row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
);
6567 if (!row
->enabled_p
)
6572 /* When the window is hscrolled, cursor hpos can legitimately be
6573 out of bounds, but we draw the cursor at the corresponding
6574 window margin in that case. */
6575 if (!row
->reversed_p
&& hpos
< 0)
6577 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
6578 hpos
= row
->used
[TEXT_AREA
] - 1;
6581 if (0 <= hpos
&& hpos
< row
->used
[TEXT_AREA
])
6582 glyph
= row
->glyphs
[TEXT_AREA
] + hpos
;
6591 save_window_save (Lisp_Object window
, struct Lisp_Vector
*vector
, int i
)
6593 register struct saved_window
*p
;
6594 register struct window
*w
;
6595 register Lisp_Object tem
, pers
, par
;
6597 for (; !NILP (window
); window
= w
->next
)
6599 p
= SAVED_WINDOW_N (vector
, i
);
6600 w
= XWINDOW (window
);
6602 wset_temslot (w
, make_number (i
)); i
++;
6604 p
->buffer
= (WINDOW_LEAF_P (w
) ? w
->contents
: Qnil
);
6605 p
->pixel_left
= make_number (w
->pixel_left
);
6606 p
->pixel_top
= make_number (w
->pixel_top
);
6607 p
->pixel_width
= make_number (w
->pixel_width
);
6608 p
->pixel_height
= make_number (w
->pixel_height
);
6609 p
->left_col
= make_number (w
->left_col
);
6610 p
->top_line
= make_number (w
->top_line
);
6611 p
->total_cols
= make_number (w
->total_cols
);
6612 p
->total_lines
= make_number (w
->total_lines
);
6613 p
->normal_cols
= w
->normal_cols
;
6614 p
->normal_lines
= w
->normal_lines
;
6615 XSETFASTINT (p
->hscroll
, w
->hscroll
);
6616 p
->suspend_auto_hscroll
= w
->suspend_auto_hscroll
? Qt
: Qnil
;
6617 XSETFASTINT (p
->min_hscroll
, w
->min_hscroll
);
6618 XSETFASTINT (p
->hscroll_whole
, w
->hscroll_whole
);
6619 p
->display_table
= w
->display_table
;
6620 p
->left_margin_cols
= make_number (w
->left_margin_cols
);
6621 p
->right_margin_cols
= make_number (w
->right_margin_cols
);
6622 p
->left_fringe_width
= make_number (w
->left_fringe_width
);
6623 p
->right_fringe_width
= make_number (w
->right_fringe_width
);
6624 p
->fringes_outside_margins
= w
->fringes_outside_margins
? Qt
: Qnil
;
6625 p
->scroll_bar_width
= make_number (w
->scroll_bar_width
);
6626 p
->scroll_bar_height
= make_number (w
->scroll_bar_height
);
6627 p
->vertical_scroll_bar_type
= w
->vertical_scroll_bar_type
;
6628 p
->horizontal_scroll_bar_type
= w
->horizontal_scroll_bar_type
;
6629 p
->dedicated
= w
->dedicated
;
6630 p
->combination_limit
= w
->combination_limit
;
6631 p
->window_parameters
= Qnil
;
6633 if (!NILP (Vwindow_persistent_parameters
))
6635 /* Run cycle detection on Vwindow_persistent_parameters. */
6636 Lisp_Object tortoise
, hare
;
6638 hare
= tortoise
= Vwindow_persistent_parameters
;
6639 while (CONSP (hare
))
6646 tortoise
= XCDR (tortoise
);
6648 if (EQ (hare
, tortoise
))
6649 /* Reset Vwindow_persistent_parameters to Qnil. */
6651 Vwindow_persistent_parameters
= Qnil
;
6656 for (tem
= Vwindow_persistent_parameters
; CONSP (tem
);
6660 /* Save values for persistent window parameters. */
6661 if (CONSP (pers
) && !NILP (XCDR (pers
)))
6663 par
= Fassq (XCAR (pers
), w
->window_parameters
);
6665 /* If the window has no value for the parameter,
6667 p
->window_parameters
= Fcons (Fcons (XCAR (pers
), Qnil
),
6668 p
->window_parameters
);
6670 /* If the window has a value for the parameter,
6672 p
->window_parameters
= Fcons (Fcons (XCAR (par
),
6674 p
->window_parameters
);
6679 if (BUFFERP (w
->contents
))
6681 /* Save w's value of point in the window configuration. If w
6682 is the selected window, then get the value of point from
6683 the buffer; pointm is garbage in the selected window. */
6684 if (EQ (window
, selected_window
))
6685 p
->pointm
= build_marker (XBUFFER (w
->contents
),
6686 BUF_PT (XBUFFER (w
->contents
)),
6687 BUF_PT_BYTE (XBUFFER (w
->contents
)));
6689 p
->pointm
= Fcopy_marker (w
->pointm
, Qnil
);
6690 p
->old_pointm
= Fcopy_marker (w
->old_pointm
, Qnil
);
6691 XMARKER (p
->pointm
)->insertion_type
6692 = !NILP (buffer_local_value
/* Don't signal error if void. */
6693 (Qwindow_point_insertion_type
, w
->contents
));
6694 XMARKER (p
->old_pointm
)->insertion_type
6695 = !NILP (buffer_local_value
/* Don't signal error if void. */
6696 (Qwindow_point_insertion_type
, w
->contents
));
6698 p
->start
= Fcopy_marker (w
->start
, Qnil
);
6699 p
->start_at_line_beg
= w
->start_at_line_beg
? Qt
: Qnil
;
6704 p
->old_pointm
= Qnil
;
6706 p
->start_at_line_beg
= Qnil
;
6709 p
->parent
= NILP (w
->parent
) ? Qnil
: XWINDOW (w
->parent
)->temslot
;
6710 p
->prev
= NILP (w
->prev
) ? Qnil
: XWINDOW (w
->prev
)->temslot
;
6712 if (WINDOWP (w
->contents
))
6713 i
= save_window_save (w
->contents
, vector
, i
);
6719 DEFUN ("current-window-configuration", Fcurrent_window_configuration
,
6720 Scurrent_window_configuration
, 0, 1, 0,
6721 doc
: /* Return an object representing the current window configuration of FRAME.
6722 If FRAME is nil or omitted, use the selected frame.
6723 This describes the number of windows, their sizes and current buffers,
6724 and for each displayed buffer, where display starts, and the position of
6725 point. An exception is made for point in the current buffer:
6726 its value is -not- saved.
6727 This also records the currently selected frame, and FRAME's focus
6728 redirection (see `redirect-frame-focus'). The variable
6729 `window-persistent-parameters' specifies which window parameters are
6730 saved by this function. */)
6733 register Lisp_Object tem
;
6734 register int n_windows
;
6735 register struct save_window_data
*data
;
6737 struct frame
*f
= decode_live_frame (frame
);
6739 n_windows
= count_windows (XWINDOW (FRAME_ROOT_WINDOW (f
)));
6740 data
= ALLOCATE_PSEUDOVECTOR (struct save_window_data
, frame_cols
,
6741 PVEC_WINDOW_CONFIGURATION
);
6743 data
->frame_cols
= FRAME_COLS (f
);
6744 data
->frame_lines
= FRAME_LINES (f
);
6745 data
->frame_menu_bar_lines
= FRAME_MENU_BAR_LINES (f
);
6746 data
->frame_tool_bar_lines
= FRAME_TOOL_BAR_LINES (f
);
6747 data
->frame_text_width
= FRAME_TEXT_WIDTH (f
);
6748 data
->frame_text_height
= FRAME_TEXT_HEIGHT (f
);
6749 data
->frame_menu_bar_height
= FRAME_MENU_BAR_HEIGHT (f
);
6750 data
->frame_tool_bar_height
= FRAME_TOOL_BAR_HEIGHT (f
);
6751 data
->selected_frame
= selected_frame
;
6752 data
->current_window
= FRAME_SELECTED_WINDOW (f
);
6753 XSETBUFFER (data
->current_buffer
, current_buffer
);
6754 data
->minibuf_scroll_window
= minibuf_level
> 0 ? Vminibuf_scroll_window
: Qnil
;
6755 data
->minibuf_selected_window
= minibuf_level
> 0 ? minibuf_selected_window
: Qnil
;
6756 data
->root_window
= FRAME_ROOT_WINDOW (f
);
6757 data
->focus_frame
= FRAME_FOCUS_FRAME (f
);
6758 tem
= make_uninit_vector (n_windows
);
6759 data
->saved_windows
= tem
;
6760 for (i
= 0; i
< n_windows
; i
++)
6762 Fmake_vector (make_number (VECSIZE (struct saved_window
)), Qnil
));
6763 save_window_save (FRAME_ROOT_WINDOW (f
), XVECTOR (tem
), 0);
6764 XSETWINDOW_CONFIGURATION (tem
, data
);
6768 /* Called after W's margins, fringes or scroll bars was adjusted. */
6771 apply_window_adjustment (struct window
*w
)
6774 clear_glyph_matrix (w
->current_matrix
);
6775 w
->window_end_valid
= 0;
6776 windows_or_buffers_changed
= 30;
6778 adjust_frame_glyphs (XFRAME (WINDOW_FRAME (w
)));
6782 /***********************************************************************
6784 ***********************************************************************/
6786 static struct window
*
6787 set_window_margins (struct window
*w
, Lisp_Object left_width
,
6788 Lisp_Object right_width
)
6791 int unit
= WINDOW_FRAME_COLUMN_WIDTH (w
);
6793 left
= (NILP (left_width
) ? 0
6794 : (CHECK_NATNUM (left_width
), XINT (left_width
)));
6795 right
= (NILP (right_width
) ? 0
6796 : (CHECK_NATNUM (right_width
), XINT (right_width
)));
6798 if (w
->left_margin_cols
!= left
|| w
->right_margin_cols
!= right
)
6800 /* Don't change anything if new margins won't fit. */
6801 if ((WINDOW_PIXEL_WIDTH (w
)
6802 - WINDOW_FRINGES_WIDTH (w
)
6803 - WINDOW_SCROLL_BAR_AREA_WIDTH (w
)
6804 - (left
+ right
) * unit
)
6805 >= MIN_SAFE_WINDOW_PIXEL_WIDTH (w
))
6807 w
->left_margin_cols
= left
;
6808 w
->right_margin_cols
= right
;
6819 DEFUN ("set-window-margins", Fset_window_margins
, Sset_window_margins
,
6821 doc
: /* Set width of marginal areas of window WINDOW.
6822 WINDOW must be a live window and defaults to the selected one.
6824 Second arg LEFT-WIDTH specifies the number of character cells to
6825 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6826 does the same for the right marginal area. A nil width parameter
6829 Return t if any margin was actually changed and nil otherwise. */)
6830 (Lisp_Object window
, Lisp_Object left_width
, Lisp_Object right_width
)
6832 struct window
*w
= set_window_margins (decode_live_window (window
),
6833 left_width
, right_width
);
6834 return w
? (apply_window_adjustment (w
), Qt
) : Qnil
;
6838 DEFUN ("window-margins", Fwindow_margins
, Swindow_margins
,
6840 doc
: /* Get width of marginal areas of window WINDOW.
6841 WINDOW must be a live window and defaults to the selected one.
6843 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6844 If a marginal area does not exist, its width will be returned
6846 (Lisp_Object window
)
6848 struct window
*w
= decode_live_window (window
);
6849 return Fcons (w
->left_margin_cols
6850 ? make_number (w
->left_margin_cols
) : Qnil
,
6851 w
->right_margin_cols
6852 ? make_number (w
->right_margin_cols
) : Qnil
);
6857 /***********************************************************************
6859 ***********************************************************************/
6861 static struct window
*
6862 set_window_fringes (struct window
*w
, Lisp_Object left_width
,
6863 Lisp_Object right_width
, Lisp_Object outside_margins
)
6865 int left
, right
, outside
= !NILP (outside_margins
);
6867 left
= (NILP (left_width
) ? -1
6868 : (CHECK_NATNUM (left_width
), XINT (left_width
)));
6869 right
= (NILP (right_width
) ? -1
6870 : (CHECK_NATNUM (right_width
), XINT (right_width
)));
6872 /* Do nothing on a tty or if nothing to actually change. */
6873 if (FRAME_WINDOW_P (WINDOW_XFRAME (w
))
6874 && (w
->left_fringe_width
!= left
6875 || w
->right_fringe_width
!= right
6876 || w
->fringes_outside_margins
!= outside
))
6878 if (left
> 0 || right
> 0)
6880 /* Don't change anything if new fringes don't fit. */
6881 if ((WINDOW_PIXEL_WIDTH (w
)
6882 - WINDOW_MARGINS_WIDTH (w
)
6883 - WINDOW_SCROLL_BAR_AREA_WIDTH (w
)
6884 - max (left
, 0) - max (right
, 0))
6885 < MIN_SAFE_WINDOW_PIXEL_WIDTH (w
))
6889 w
->left_fringe_width
= left
;
6890 w
->right_fringe_width
= right
;
6891 w
->fringes_outside_margins
= outside
;
6899 DEFUN ("set-window-fringes", Fset_window_fringes
, Sset_window_fringes
,
6901 doc
: /* Set the fringe widths of window WINDOW.
6902 WINDOW must be a live window and defaults to the selected one.
6904 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6905 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6906 fringe width. If a fringe width arg is nil, that means to use the
6907 frame's default fringe width. Default fringe widths can be set with
6908 the command `set-fringe-style'.
6909 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6910 outside of the display margins. By default, fringes are drawn between
6911 display marginal areas and the text area.
6913 Return t if any fringe was actually changed and nil otherwise. */)
6914 (Lisp_Object window
, Lisp_Object left_width
,
6915 Lisp_Object right_width
, Lisp_Object outside_margins
)
6918 = set_window_fringes (decode_live_window (window
),
6919 left_width
, right_width
, outside_margins
);
6920 return w
? (apply_window_adjustment (w
), Qt
) : Qnil
;
6924 DEFUN ("window-fringes", Fwindow_fringes
, Swindow_fringes
,
6926 doc
: /* Get width of fringes of window WINDOW.
6927 WINDOW must be a live window and defaults to the selected one.
6929 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6930 (Lisp_Object window
)
6932 struct window
*w
= decode_live_window (window
);
6934 return list3 (make_number (WINDOW_LEFT_FRINGE_WIDTH (w
)),
6935 make_number (WINDOW_RIGHT_FRINGE_WIDTH (w
)),
6936 WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
) ? Qt
: Qnil
);
6941 /***********************************************************************
6943 ***********************************************************************/
6945 static struct window
*
6946 set_window_scroll_bars (struct window
*w
, Lisp_Object width
,
6947 Lisp_Object vertical_type
, Lisp_Object height
,
6948 Lisp_Object horizontal_type
)
6950 int iwidth
= (NILP (width
) ? -1 : (CHECK_NATNUM (width
), XINT (width
)));
6954 vertical_type
= Qnil
;
6956 if (!(NILP (vertical_type
)
6957 || EQ (vertical_type
, Qleft
)
6958 || EQ (vertical_type
, Qright
)
6959 || EQ (vertical_type
, Qt
)))
6960 error ("Invalid type of vertical scroll bar");
6962 if (w
->scroll_bar_width
!= iwidth
6963 || !EQ (w
->vertical_scroll_bar_type
, vertical_type
))
6965 /* Don't change anything if new scroll bar won't fit. */
6966 if ((WINDOW_PIXEL_WIDTH (w
)
6967 - WINDOW_MARGINS_WIDTH (w
)
6968 - WINDOW_FRINGES_WIDTH (w
)
6970 >= MIN_SAFE_WINDOW_PIXEL_WIDTH (w
))
6972 w
->scroll_bar_width
= iwidth
;
6973 wset_vertical_scroll_bar_type (w
, vertical_type
);
6978 #if USE_HORIZONTAL_SCROLL_BARS
6980 int iheight
= (NILP (height
) ? -1 : (CHECK_NATNUM (height
), XINT (height
)));
6982 if (MINI_WINDOW_P (w
) || iheight
== 0)
6983 horizontal_type
= Qnil
;
6985 if (!(NILP (horizontal_type
)
6986 || EQ (horizontal_type
, Qbottom
)
6987 || EQ (horizontal_type
, Qt
)))
6988 error ("Invalid type of horizontal scroll bar");
6990 if (w
->scroll_bar_height
!= iheight
6991 || !EQ (w
->horizontal_scroll_bar_type
, horizontal_type
))
6993 /* Don't change anything if new scroll bar won't fit. */
6994 if ((WINDOW_PIXEL_HEIGHT (w
)
6995 - WINDOW_HEADER_LINE_HEIGHT (w
)
6996 - WINDOW_MODE_LINE_HEIGHT (w
)
6998 >= MIN_SAFE_WINDOW_PIXEL_HEIGHT (w
))
7000 w
->scroll_bar_height
= iheight
;
7001 wset_horizontal_scroll_bar_type (w
, horizontal_type
);
7007 wset_horizontal_scroll_bar_type (w
, Qnil
);
7010 return changed
? w
: NULL
;
7013 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars
,
7014 Sset_window_scroll_bars
, 1, 5, 0,
7015 doc
: /* Set width and type of scroll bars of window WINDOW.
7016 WINDOW must be a live window and defaults to the selected one.
7018 Second parameter WIDTH specifies the pixel width for the vertical scroll
7019 bar. If WIDTH is nil, use the scroll-bar width of WINDOW's frame.
7020 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
7021 bar: left, right, or nil. If VERTICAL-TYPE is t, this means use the
7022 frame's scroll-bar type.
7024 Fourth parameter HEIGHT specifies the pixel height for the horizontal
7025 scroll bar. If HEIGHT is nil, use the scroll-bar height of WINDOW's
7026 frame. Fifth parameter HORIZONTAL-TYPE specifies the type of the
7027 horizontal scroll bar: nil, bottom, or t. If HORIZONTAL-TYPE is t, this
7028 means to use the frame's horizontal scroll-bar type.
7030 Return t if scroll bars were actually changed and nil otherwise. */)
7031 (Lisp_Object window
, Lisp_Object width
, Lisp_Object vertical_type
,
7032 Lisp_Object height
, Lisp_Object horizontal_type
)
7035 = set_window_scroll_bars (decode_live_window (window
),
7036 width
, vertical_type
, height
, horizontal_type
);
7037 return w
? (apply_window_adjustment (w
), Qt
) : Qnil
;
7041 DEFUN ("window-scroll-bars", Fwindow_scroll_bars
, Swindow_scroll_bars
,
7043 doc
: /* Get width and type of scroll bars of window WINDOW.
7044 WINDOW must be a live window and defaults to the selected one.
7046 Value is a list of the form (WIDTH COLUMNS VERTICAL-TYPE HEIGHT LINES
7047 HORIZONTAL-TYPE). If WIDTH or HEIGHT is nil or VERTICAL-TYPE or
7048 HORIZONTAL-TYPE is t, the window is using the frame's corresponding
7050 (Lisp_Object window
)
7052 struct window
*w
= decode_live_window (window
);
7054 return Fcons (((w
->scroll_bar_width
>= 0)
7055 ? make_number (w
->scroll_bar_width
)
7057 list5 (make_number (WINDOW_SCROLL_BAR_COLS (w
)),
7058 w
->vertical_scroll_bar_type
,
7059 ((w
->scroll_bar_height
>= 0)
7060 ? make_number (w
->scroll_bar_height
)
7062 make_number (WINDOW_SCROLL_BAR_LINES (w
)),
7063 w
->horizontal_scroll_bar_type
));
7066 /***********************************************************************
7068 ***********************************************************************/
7070 DEFUN ("window-vscroll", Fwindow_vscroll
, Swindow_vscroll
, 0, 2, 0,
7071 doc
: /* Return the amount by which WINDOW is scrolled vertically.
7072 If WINDOW is omitted or nil, it defaults to the selected window.
7073 Normally, value is a multiple of the canonical character height of WINDOW;
7074 optional second arg PIXELS-P means value is measured in pixels. */)
7075 (Lisp_Object window
, Lisp_Object pixels_p
)
7078 struct window
*w
= decode_live_window (window
);
7079 struct frame
*f
= XFRAME (w
->frame
);
7081 if (FRAME_WINDOW_P (f
))
7082 result
= (NILP (pixels_p
)
7083 ? FRAME_CANON_Y_FROM_PIXEL_Y (f
, -w
->vscroll
)
7084 : make_number (-w
->vscroll
));
7086 result
= make_number (0);
7091 DEFUN ("set-window-vscroll", Fset_window_vscroll
, Sset_window_vscroll
,
7093 doc
: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
7094 WINDOW nil means use the selected window. Normally, VSCROLL is a
7095 non-negative multiple of the canonical character height of WINDOW;
7096 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
7097 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
7098 corresponds to an integral number of pixels. The return value is the
7099 result of this rounding.
7100 If PIXELS-P is non-nil, the return value is VSCROLL. */)
7101 (Lisp_Object window
, Lisp_Object vscroll
, Lisp_Object pixels_p
)
7103 struct window
*w
= decode_live_window (window
);
7104 struct frame
*f
= XFRAME (w
->frame
);
7106 CHECK_NUMBER_OR_FLOAT (vscroll
);
7108 if (FRAME_WINDOW_P (f
))
7110 int old_dy
= w
->vscroll
;
7112 w
->vscroll
= - (NILP (pixels_p
)
7113 ? FRAME_LINE_HEIGHT (f
) * XFLOATINT (vscroll
)
7114 : XFLOATINT (vscroll
));
7115 w
->vscroll
= min (w
->vscroll
, 0);
7117 if (w
->vscroll
!= old_dy
)
7119 /* Adjust glyph matrix of the frame if the virtual display
7120 area becomes larger than before. */
7121 if (w
->vscroll
< 0 && w
->vscroll
< old_dy
)
7122 adjust_frame_glyphs (f
);
7124 /* Prevent redisplay shortcuts. */
7125 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
7129 return Fwindow_vscroll (window
, pixels_p
);
7133 /* Call FN for all leaf windows on frame F. FN is called with the
7134 first argument being a pointer to the leaf window, and with
7135 additional argument USER_DATA. Stops when FN returns 0. */
7138 foreach_window (struct frame
*f
, int (*fn
) (struct window
*, void *),
7141 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
7142 if (WINDOWP (FRAME_ROOT_WINDOW (f
)))
7143 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f
)), fn
, user_data
);
7147 /* Helper function for foreach_window. Call FN for all leaf windows
7148 reachable from W. FN is called with the first argument being a
7149 pointer to the leaf window, and with additional argument USER_DATA.
7150 Stop when FN returns 0. Value is 0 if stopped by FN. */
7153 foreach_window_1 (struct window
*w
, int (*fn
) (struct window
*, void *), void *user_data
)
7157 for (cont
= 1; w
&& cont
;)
7159 if (WINDOWP (w
->contents
))
7160 cont
= foreach_window_1 (XWINDOW (w
->contents
), fn
, user_data
);
7162 cont
= fn (w
, user_data
);
7164 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
7170 /***********************************************************************
7172 ***********************************************************************/
7174 /* Return 1 if window configurations CONFIGURATION1 and CONFIGURATION2
7175 describe the same state of affairs. This is used by Fequal.
7177 IGNORE_POSITIONS means ignore non-matching scroll positions
7180 This ignores a couple of things like the dedication status of
7181 window, combination_limit and the like. This might have to be
7185 compare_window_configurations (Lisp_Object configuration1
,
7186 Lisp_Object configuration2
,
7187 bool ignore_positions
)
7189 register struct save_window_data
*d1
, *d2
;
7190 struct Lisp_Vector
*sws1
, *sws2
;
7193 CHECK_WINDOW_CONFIGURATION (configuration1
);
7194 CHECK_WINDOW_CONFIGURATION (configuration2
);
7196 d1
= (struct save_window_data
*) XVECTOR (configuration1
);
7197 d2
= (struct save_window_data
*) XVECTOR (configuration2
);
7198 sws1
= XVECTOR (d1
->saved_windows
);
7199 sws2
= XVECTOR (d2
->saved_windows
);
7201 /* Frame settings must match. */
7202 if (d1
->frame_cols
!= d2
->frame_cols
7203 || d1
->frame_lines
!= d2
->frame_lines
7204 || d1
->frame_menu_bar_lines
!= d2
->frame_menu_bar_lines
7205 || !EQ (d1
->selected_frame
, d2
->selected_frame
)
7206 || !EQ (d1
->current_buffer
, d2
->current_buffer
)
7207 || (!ignore_positions
7208 && (!EQ (d1
->minibuf_scroll_window
, d2
->minibuf_scroll_window
)
7209 || !EQ (d1
->minibuf_selected_window
, d2
->minibuf_selected_window
)))
7210 || !EQ (d1
->focus_frame
, d2
->focus_frame
)
7211 /* Verify that the two configurations have the same number of windows. */
7212 || sws1
->header
.size
!= sws2
->header
.size
)
7215 for (i
= 0; i
< sws1
->header
.size
; i
++)
7217 struct saved_window
*sw1
, *sw2
;
7219 sw1
= SAVED_WINDOW_N (sws1
, i
);
7220 sw2
= SAVED_WINDOW_N (sws2
, i
);
7223 /* The "current" windows in the two configurations must
7224 correspond to each other. */
7225 EQ (d1
->current_window
, sw1
->window
)
7226 != EQ (d2
->current_window
, sw2
->window
)
7227 /* Windows' buffers must match. */
7228 || !EQ (sw1
->buffer
, sw2
->buffer
)
7229 || !EQ (sw1
->pixel_left
, sw2
->pixel_left
)
7230 || !EQ (sw1
->pixel_top
, sw2
->pixel_top
)
7231 || !EQ (sw1
->pixel_height
, sw2
->pixel_height
)
7232 || !EQ (sw1
->pixel_width
, sw2
->pixel_width
)
7233 || !EQ (sw1
->left_col
, sw2
->left_col
)
7234 || !EQ (sw1
->top_line
, sw2
->top_line
)
7235 || !EQ (sw1
->total_cols
, sw2
->total_cols
)
7236 || !EQ (sw1
->total_lines
, sw2
->total_lines
)
7237 || !EQ (sw1
->display_table
, sw2
->display_table
)
7238 /* The next two disjuncts check the window structure for
7240 || !EQ (sw1
->parent
, sw2
->parent
)
7241 || !EQ (sw1
->prev
, sw2
->prev
)
7242 || (!ignore_positions
7243 && (!EQ (sw1
->hscroll
, sw2
->hscroll
)
7244 || !EQ (sw1
->min_hscroll
, sw2
->min_hscroll
)
7245 || !EQ (sw1
->start_at_line_beg
, sw2
->start_at_line_beg
)
7246 || NILP (Fequal (sw1
->start
, sw2
->start
))
7247 || NILP (Fequal (sw1
->pointm
, sw2
->pointm
))))
7248 || !EQ (sw1
->left_margin_cols
, sw2
->left_margin_cols
)
7249 || !EQ (sw1
->right_margin_cols
, sw2
->right_margin_cols
)
7250 || !EQ (sw1
->left_fringe_width
, sw2
->left_fringe_width
)
7251 || !EQ (sw1
->right_fringe_width
, sw2
->right_fringe_width
)
7252 || !EQ (sw1
->fringes_outside_margins
, sw2
->fringes_outside_margins
)
7253 || !EQ (sw1
->scroll_bar_width
, sw2
->scroll_bar_width
)
7254 || !EQ (sw1
->scroll_bar_height
, sw2
->scroll_bar_height
)
7255 || !EQ (sw1
->vertical_scroll_bar_type
, sw2
->vertical_scroll_bar_type
)
7256 || !EQ (sw1
->horizontal_scroll_bar_type
, sw2
->horizontal_scroll_bar_type
))
7263 DEFUN ("compare-window-configurations", Fcompare_window_configurations
,
7264 Scompare_window_configurations
, 2, 2, 0,
7265 doc
: /* Compare two window configurations as regards the structure of windows.
7266 This function ignores details such as the values of point
7267 and scrolling positions. */)
7268 (Lisp_Object x
, Lisp_Object y
)
7270 if (compare_window_configurations (x
, y
, 1))
7276 init_window_once (void)
7278 struct frame
*f
= make_initial_frame ();
7279 XSETFRAME (selected_frame
, f
);
7280 Vterminal_frame
= selected_frame
;
7281 minibuf_window
= f
->minibuffer_window
;
7282 selected_window
= f
->selected_window
;
7288 Vwindow_list
= Qnil
;
7292 syms_of_window (void)
7294 DEFSYM (Qscroll_up
, "scroll-up");
7295 DEFSYM (Qscroll_down
, "scroll-down");
7296 DEFSYM (Qscroll_command
, "scroll-command");
7298 Fput (Qscroll_up
, Qscroll_command
, Qt
);
7299 Fput (Qscroll_down
, Qscroll_command
, Qt
);
7301 DEFSYM (Qwindow_configuration_change_hook
, "window-configuration-change-hook");
7302 DEFSYM (Qwindowp
, "windowp");
7303 DEFSYM (Qwindow_configuration_p
, "window-configuration-p");
7304 DEFSYM (Qwindow_live_p
, "window-live-p");
7305 DEFSYM (Qwindow_valid_p
, "window-valid-p");
7306 DEFSYM (Qwindow_deletable_p
, "window-deletable-p");
7307 DEFSYM (Qdelete_window
, "delete-window");
7308 DEFSYM (Qwindow_resize_root_window
, "window--resize-root-window");
7309 DEFSYM (Qwindow_resize_root_window_vertically
, "window--resize-root-window-vertically");
7310 DEFSYM (Qwindow_sanitize_window_sizes
, "window--sanitize-window-sizes");
7311 DEFSYM (Qwindow_pixel_to_total
, "window--pixel-to-total");
7312 DEFSYM (Qsafe
, "safe");
7313 DEFSYM (Qdisplay_buffer
, "display-buffer");
7314 DEFSYM (Qreplace_buffer_in_windows
, "replace-buffer-in-windows");
7315 DEFSYM (Qrecord_window_buffer
, "record-window-buffer");
7316 DEFSYM (Qget_mru_window
, "get-mru-window");
7317 DEFSYM (Qwindow_size
, "window-size");
7318 DEFSYM (Qtemp_buffer_show_hook
, "temp-buffer-show-hook");
7319 DEFSYM (Qabove
, "above");
7320 DEFSYM (Qbelow
, "below");
7321 DEFSYM (Qclone_of
, "clone-of");
7322 DEFSYM (Qfloor
, "floor");
7323 DEFSYM (Qceiling
, "ceiling");
7325 staticpro (&Vwindow_list
);
7327 minibuf_selected_window
= Qnil
;
7328 staticpro (&minibuf_selected_window
);
7330 window_scroll_pixel_based_preserve_x
= -1;
7331 window_scroll_pixel_based_preserve_y
= -1;
7332 window_scroll_preserve_hpos
= -1;
7333 window_scroll_preserve_vpos
= -1;
7335 DEFVAR_LISP ("temp-buffer-show-function", Vtemp_buffer_show_function
,
7336 doc
: /* Non-nil means call as function to display a help buffer.
7337 The function is called with one argument, the buffer to be displayed.
7338 Used by `with-output-to-temp-buffer'.
7339 If this function is used, then it must do the entire job of showing
7340 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
7341 Vtemp_buffer_show_function
= Qnil
;
7343 DEFVAR_LISP ("minibuffer-scroll-window", Vminibuf_scroll_window
,
7344 doc
: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
7345 Vminibuf_scroll_window
= Qnil
;
7347 DEFVAR_BOOL ("mode-line-in-non-selected-windows", mode_line_in_non_selected_windows
,
7348 doc
: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
7349 If the minibuffer is active, the `minibuffer-scroll-window' mode line
7350 is displayed in the `mode-line' face. */);
7351 mode_line_in_non_selected_windows
= true;
7353 DEFVAR_LISP ("other-window-scroll-buffer", Vother_window_scroll_buffer
,
7354 doc
: /* If this is a live buffer, \\[scroll-other-window] should scroll its window. */);
7355 Vother_window_scroll_buffer
= Qnil
;
7357 DEFVAR_BOOL ("auto-window-vscroll", auto_window_vscroll_p
,
7358 doc
: /* Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
7359 auto_window_vscroll_p
= true;
7361 DEFVAR_INT ("next-screen-context-lines", next_screen_context_lines
,
7362 doc
: /* Number of lines of continuity when scrolling by screenfuls. */);
7363 next_screen_context_lines
= 2;
7365 DEFVAR_LISP ("scroll-preserve-screen-position",
7366 Vscroll_preserve_screen_position
,
7367 doc
: /* Controls if scroll commands move point to keep its screen position unchanged.
7368 A value of nil means point does not keep its screen position except
7369 at the scroll margin or window boundary respectively.
7370 A value of t means point keeps its screen position if the scroll
7371 command moved it vertically out of the window, e.g. when scrolling
7373 Any other value means point always keeps its screen position.
7374 Scroll commands should have the `scroll-command' property
7375 on their symbols to be controlled by this variable. */);
7376 Vscroll_preserve_screen_position
= Qnil
;
7378 DEFVAR_LISP ("window-point-insertion-type", Vwindow_point_insertion_type
,
7379 doc
: /* Type of marker to use for `window-point'. */);
7380 Vwindow_point_insertion_type
= Qnil
;
7381 DEFSYM (Qwindow_point_insertion_type
, "window_point_insertion_type");
7383 DEFVAR_LISP ("window-configuration-change-hook",
7384 Vwindow_configuration_change_hook
,
7385 doc
: /* Functions to call when window configuration changes.
7386 The buffer-local part is run once per window, with the relevant window
7387 selected; while the global part is run only once for the modified frame,
7388 with the relevant frame selected. */);
7389 Vwindow_configuration_change_hook
= Qnil
;
7391 DEFVAR_LISP ("recenter-redisplay", Vrecenter_redisplay
,
7392 doc
: /* Non-nil means `recenter' redraws entire frame.
7393 If this option is non-nil, then the `recenter' command with a nil
7394 argument will redraw the entire frame; the special value `tty' causes
7395 the frame to be redrawn only if it is a tty frame. */);
7396 Vrecenter_redisplay
= Qtty
;
7398 DEFVAR_LISP ("window-combination-resize", Vwindow_combination_resize
,
7399 doc
: /* If t, resize window combinations proportionally.
7400 If this variable is nil, splitting a window gets the entire screen space
7401 for displaying the new window from the window to split. Deleting and
7402 resizing a window preferably resizes one adjacent window only.
7404 If this variable is t, splitting a window tries to get the space
7405 proportionally from all windows in the same combination. This also
7406 allows to split a window that is otherwise too small or of fixed size.
7407 Resizing and deleting a window proportionally resize all windows in the
7410 Other values are reserved for future use.
7412 This variable takes no effect if the variable `window-combination-limit' is
7414 Vwindow_combination_resize
= Qnil
;
7416 DEFVAR_LISP ("window-combination-limit", Vwindow_combination_limit
,
7417 doc
: /* If non-nil, splitting a window makes a new parent window.
7418 The following values are recognized:
7420 nil means splitting a window will create a new parent window only if the
7421 window has no parent window or the window shall become part of a
7422 combination orthogonal to the one it is part of.
7424 `window-size' means that splitting a window for displaying a buffer
7425 makes a new parent window provided `display-buffer' is supposed to
7426 explicitly set the window's size due to the presence of a
7427 `window-height' or `window-width' entry in the alist used by
7428 `display-buffer'. Otherwise, this value is handled like nil.
7430 `temp-buffer' means that splitting a window for displaying a temporary
7431 buffer always makes a new parent window. Otherwise, this value is
7434 `display-buffer' means that splitting a window for displaying a buffer
7435 always makes a new parent window. Since temporary buffers are
7436 displayed by the function `display-buffer', this value is stronger
7437 than `temp-buffer'. Splitting a window for other purpose makes a
7438 new parent window only if needed.
7440 t means that splitting a window always creates a new parent window. If
7441 all splits behave this way, each frame's window tree is a binary
7442 tree and every window but the frame's root window has exactly one
7445 Other values are reserved for future use. */);
7446 Vwindow_combination_limit
= Qwindow_size
;
7448 DEFVAR_LISP ("window-persistent-parameters", Vwindow_persistent_parameters
,
7449 doc
: /* Alist of persistent window parameters.
7450 This alist specifies which window parameters shall get saved by
7451 `current-window-configuration' and `window-state-get' and subsequently
7452 restored to their previous values by `set-window-configuration' and
7455 The car of each entry of this alist is the symbol specifying the
7456 parameter. The cdr is one of the following:
7458 nil means the parameter is neither saved by `window-state-get' nor by
7459 `current-window-configuration'.
7461 t means the parameter is saved by `current-window-configuration' and,
7462 provided its WRITABLE argument is nil, by `window-state-get'.
7464 The symbol `writable' means the parameter is saved unconditionally by
7465 both `current-window-configuration' and `window-state-get'. Do not use
7466 this value for parameters without read syntax (like windows or frames).
7468 Parameters not saved by `current-window-configuration' or
7469 `window-state-get' are left alone by `set-window-configuration'
7470 respectively are not installed by `window-state-put'. */);
7471 Vwindow_persistent_parameters
= list1 (Fcons (Qclone_of
, Qt
));
7473 DEFVAR_BOOL ("window-resize-pixelwise", window_resize_pixelwise
,
7474 doc
: /* Non-nil means resize windows pixelwise.
7475 This currently affects the functions: `split-window', `maximize-window',
7476 `minimize-window', `fit-window-to-buffer' and `fit-frame-to-buffer', and
7477 all functions that symmetrically resize a parent window.
7479 Note that when a frame's pixel size is not a multiple of the
7480 frame's character size, at least one window may get resized
7481 pixelwise even if this option is nil. */);
7482 window_resize_pixelwise
= false;
7484 DEFVAR_BOOL ("fast-but-imprecise-scrolling",
7485 Vfast_but_imprecise_scrolling
,
7486 doc
: /* When non-nil, accelerate scrolling operations.
7487 This comes into play when scrolling rapidly over previously
7488 unfontified buffer regions. Only those portions of the buffer which
7489 are actually going to be displayed get fontified.
7491 Note that this optimization can cause the portion of the buffer
7492 displayed after a scrolling operation to be somewhat inaccurate. */);
7493 Vfast_but_imprecise_scrolling
= false;
7495 defsubr (&Sselected_window
);
7496 defsubr (&Sminibuffer_window
);
7497 defsubr (&Swindow_minibuffer_p
);
7498 defsubr (&Swindowp
);
7499 defsubr (&Swindow_valid_p
);
7500 defsubr (&Swindow_live_p
);
7501 defsubr (&Swindow_frame
);
7502 defsubr (&Sframe_root_window
);
7503 defsubr (&Sframe_first_window
);
7504 defsubr (&Sframe_selected_window
);
7505 defsubr (&Sset_frame_selected_window
);
7506 defsubr (&Spos_visible_in_window_p
);
7507 defsubr (&Swindow_line_height
);
7508 defsubr (&Swindow_buffer
);
7509 defsubr (&Swindow_parent
);
7510 defsubr (&Swindow_top_child
);
7511 defsubr (&Swindow_left_child
);
7512 defsubr (&Swindow_next_sibling
);
7513 defsubr (&Swindow_prev_sibling
);
7514 defsubr (&Swindow_combination_limit
);
7515 defsubr (&Sset_window_combination_limit
);
7516 defsubr (&Swindow_use_time
);
7517 defsubr (&Swindow_pixel_width
);
7518 defsubr (&Swindow_pixel_height
);
7519 defsubr (&Swindow_total_width
);
7520 defsubr (&Swindow_total_height
);
7521 defsubr (&Swindow_normal_size
);
7522 defsubr (&Swindow_new_pixel
);
7523 defsubr (&Swindow_new_total
);
7524 defsubr (&Swindow_new_normal
);
7525 defsubr (&Swindow_pixel_left
);
7526 defsubr (&Swindow_pixel_top
);
7527 defsubr (&Swindow_left_column
);
7528 defsubr (&Swindow_top_line
);
7529 defsubr (&Sset_window_new_pixel
);
7530 defsubr (&Sset_window_new_total
);
7531 defsubr (&Sset_window_new_normal
);
7532 defsubr (&Swindow_resize_apply
);
7533 defsubr (&Swindow_resize_apply_total
);
7534 defsubr (&Swindow_body_height
);
7535 defsubr (&Swindow_body_width
);
7536 defsubr (&Swindow_hscroll
);
7537 defsubr (&Sset_window_hscroll
);
7538 defsubr (&Swindow_redisplay_end_trigger
);
7539 defsubr (&Sset_window_redisplay_end_trigger
);
7540 defsubr (&Swindow_edges
);
7541 defsubr (&Swindow_pixel_edges
);
7542 defsubr (&Swindow_absolute_pixel_edges
);
7543 defsubr (&Swindow_mode_line_height
);
7544 defsubr (&Swindow_header_line_height
);
7545 defsubr (&Swindow_right_divider_width
);
7546 defsubr (&Swindow_bottom_divider_width
);
7547 defsubr (&Swindow_scroll_bar_width
);
7548 defsubr (&Swindow_scroll_bar_height
);
7549 defsubr (&Swindow_inside_edges
);
7550 defsubr (&Swindow_inside_pixel_edges
);
7551 defsubr (&Swindow_inside_absolute_pixel_edges
);
7552 defsubr (&Scoordinates_in_window_p
);
7553 defsubr (&Swindow_at
);
7554 defsubr (&Swindow_point
);
7555 defsubr (&Swindow_old_point
);
7556 defsubr (&Swindow_start
);
7557 defsubr (&Swindow_end
);
7558 defsubr (&Sset_window_point
);
7559 defsubr (&Sset_window_start
);
7560 defsubr (&Swindow_dedicated_p
);
7561 defsubr (&Sset_window_dedicated_p
);
7562 defsubr (&Swindow_display_table
);
7563 defsubr (&Sset_window_display_table
);
7564 defsubr (&Snext_window
);
7565 defsubr (&Sprevious_window
);
7566 defsubr (&Swindow__sanitize_window_sizes
);
7567 defsubr (&Sget_buffer_window
);
7568 defsubr (&Sdelete_other_windows_internal
);
7569 defsubr (&Sdelete_window_internal
);
7570 defsubr (&Sresize_mini_window_internal
);
7571 defsubr (&Sset_window_buffer
);
7572 defsubr (&Srun_window_configuration_change_hook
);
7573 defsubr (&Srun_window_scroll_functions
);
7574 defsubr (&Sselect_window
);
7575 defsubr (&Sforce_window_update
);
7576 defsubr (&Ssplit_window_internal
);
7577 defsubr (&Sscroll_up
);
7578 defsubr (&Sscroll_down
);
7579 defsubr (&Sscroll_left
);
7580 defsubr (&Sscroll_right
);
7581 defsubr (&Sother_window_for_scrolling
);
7582 defsubr (&Sscroll_other_window
);
7583 defsubr (&Sminibuffer_selected_window
);
7584 defsubr (&Srecenter
);
7585 defsubr (&Swindow_text_width
);
7586 defsubr (&Swindow_text_height
);
7587 defsubr (&Smove_to_window_line
);
7588 defsubr (&Swindow_configuration_p
);
7589 defsubr (&Swindow_configuration_frame
);
7590 defsubr (&Sset_window_configuration
);
7591 defsubr (&Scurrent_window_configuration
);
7592 defsubr (&Sset_window_margins
);
7593 defsubr (&Swindow_margins
);
7594 defsubr (&Sset_window_fringes
);
7595 defsubr (&Swindow_fringes
);
7596 defsubr (&Sset_window_scroll_bars
);
7597 defsubr (&Swindow_scroll_bars
);
7598 defsubr (&Swindow_vscroll
);
7599 defsubr (&Sset_window_vscroll
);
7600 defsubr (&Scompare_window_configurations
);
7601 defsubr (&Swindow_list
);
7602 defsubr (&Swindow_list_1
);
7603 defsubr (&Swindow_prev_buffers
);
7604 defsubr (&Sset_window_prev_buffers
);
7605 defsubr (&Swindow_next_buffers
);
7606 defsubr (&Sset_window_next_buffers
);
7607 defsubr (&Swindow_parameters
);
7608 defsubr (&Swindow_parameter
);
7609 defsubr (&Sset_window_parameter
);
7613 keys_of_window (void)
7615 initial_define_key (control_x_map
, '<', "scroll-left");
7616 initial_define_key (control_x_map
, '>', "scroll-right");
7618 initial_define_key (global_map
, Ctl ('V'), "scroll-up-command");
7619 initial_define_key (meta_map
, Ctl ('V'), "scroll-other-window");
7620 initial_define_key (meta_map
, 'v', "scroll-down-command");