* admin/admin.el (make-manuals): Don't bother with txt or dvi any more.
[emacs.git] / src / window.c
blob76432f8bb6b5c9971a7a9ea81975e7971da9860b
1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985-1987, 1993-1998, 2000-2013 Free Software
4 Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
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/>. */
21 #include <config.h>
23 #define WINDOW_INLINE EXTERN_INLINE
25 #include <stdio.h>
27 #include "lisp.h"
28 #include "character.h"
29 #include "buffer.h"
30 #include "keyboard.h"
31 #include "keymap.h"
32 #include "frame.h"
33 #include "window.h"
34 #include "commands.h"
35 #include "indent.h"
36 #include "termchar.h"
37 #include "disptab.h"
38 #include "dispextern.h"
39 #include "blockinput.h"
40 #include "intervals.h"
41 #include "termhooks.h" /* For FRAME_TERMINAL. */
43 #ifdef HAVE_X_WINDOWS
44 #include "xterm.h"
45 #endif /* HAVE_X_WINDOWS */
46 #ifdef HAVE_NTGUI
47 #include "w32term.h"
48 #endif
49 #ifdef MSDOS
50 #include "msdos.h"
51 #endif
52 #ifdef HAVE_NS
53 #include "nsterm.h"
54 #endif
56 Lisp_Object Qwindowp, Qwindow_live_p;
57 static Lisp_Object Qwindow_valid_p;
58 static Lisp_Object Qwindow_configuration_p;
59 static Lisp_Object Qrecord_window_buffer;
60 static Lisp_Object Qwindow_deletable_p, Qdelete_window, Qdisplay_buffer;
61 static Lisp_Object Qreplace_buffer_in_windows, Qget_mru_window;
62 static Lisp_Object Qwindow_resize_root_window, Qwindow_resize_root_window_vertically;
63 static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
64 static Lisp_Object Qsafe, Qabove, Qbelow, Qwindow_size, Qclone_of;
66 static int displayed_window_lines (struct window *);
67 static int count_windows (struct window *);
68 static int get_leaf_windows (struct window *, struct window **, int);
69 static void window_scroll (Lisp_Object, EMACS_INT, int, int);
70 static void window_scroll_pixel_based (Lisp_Object, int, int, int);
71 static void window_scroll_line_based (Lisp_Object, int, int, int);
72 static int freeze_window_start (struct window *, void *);
73 static Lisp_Object window_list (void);
74 static int add_window_to_list (struct window *, void *);
75 static int candidate_window_p (Lisp_Object, Lisp_Object, Lisp_Object,
76 Lisp_Object);
77 static Lisp_Object next_window (Lisp_Object, Lisp_Object,
78 Lisp_Object, int);
79 static void decode_next_window_args (Lisp_Object *, Lisp_Object *,
80 Lisp_Object *);
81 static void foreach_window (struct frame *,
82 int (* fn) (struct window *, void *),
83 void *);
84 static int foreach_window_1 (struct window *,
85 int (* fn) (struct window *, void *),
86 void *);
87 static Lisp_Object window_list_1 (Lisp_Object, Lisp_Object, Lisp_Object);
88 static int window_resize_check (struct window *, bool);
89 static void window_resize_apply (struct window *, bool);
90 static Lisp_Object select_window (Lisp_Object, Lisp_Object, int);
91 static void select_window_1 (Lisp_Object, bool);
93 /* This is the window in which the terminal's cursor should
94 be left when nothing is being done with it. This must
95 always be a leaf window, and its buffer is selected by
96 the top level editing loop at the end of each command.
98 This value is always the same as
99 FRAME_SELECTED_WINDOW (selected_frame). */
100 Lisp_Object selected_window;
102 /* A list of all windows for use by next_window and Fwindow_list.
103 Functions creating or deleting windows should invalidate this cache
104 by setting it to nil. */
105 Lisp_Object Vwindow_list;
107 /* The mini-buffer window of the selected frame.
108 Note that you cannot test for mini-bufferness of an arbitrary window
109 by comparing against this; but you can test for mini-bufferness of
110 the selected window. */
111 Lisp_Object minibuf_window;
113 /* Non-nil means it is the window whose mode line should be
114 shown as the selected window when the minibuffer is selected. */
115 Lisp_Object minibuf_selected_window;
117 /* Hook run at end of temp_output_buffer_show. */
118 static Lisp_Object Qtemp_buffer_show_hook;
120 /* Nonzero after init_window_once has finished. */
121 static int window_initialized;
123 /* Hook to run when window config changes. */
124 static Lisp_Object Qwindow_configuration_change_hook;
126 /* Used by the function window_scroll_pixel_based */
127 static int window_scroll_pixel_based_preserve_x;
128 static int window_scroll_pixel_based_preserve_y;
130 /* Same for window_scroll_line_based. */
131 static EMACS_INT window_scroll_preserve_hpos;
132 static EMACS_INT window_scroll_preserve_vpos;
134 static void
135 CHECK_WINDOW_CONFIGURATION (Lisp_Object x)
137 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x);
140 /* These setters are used only in this file, so they can be private. */
141 static void
142 wset_combination_limit (struct window *w, Lisp_Object val)
144 w->combination_limit = val;
146 static void
147 wset_dedicated (struct window *w, Lisp_Object val)
149 w->dedicated = val;
151 static void
152 wset_display_table (struct window *w, Lisp_Object val)
154 w->display_table = val;
156 static void
157 wset_left_fringe_width (struct window *w, Lisp_Object val)
159 w->left_fringe_width = val;
161 static void
162 wset_left_margin_cols (struct window *w, Lisp_Object val)
164 w->left_margin_cols = val;
166 static void
167 wset_new_normal (struct window *w, Lisp_Object val)
169 w->new_normal = val;
171 static void
172 wset_new_total (struct window *w, Lisp_Object val)
174 w->new_total = val;
176 static void
177 wset_normal_cols (struct window *w, Lisp_Object val)
179 w->normal_cols = val;
181 static void
182 wset_normal_lines (struct window *w, Lisp_Object val)
184 w->normal_lines = val;
186 static void
187 wset_parent (struct window *w, Lisp_Object val)
189 w->parent = val;
191 static void
192 wset_pointm (struct window *w, Lisp_Object val)
194 w->pointm = val;
196 static void
197 wset_right_fringe_width (struct window *w, Lisp_Object val)
199 w->right_fringe_width = val;
201 static void
202 wset_right_margin_cols (struct window *w, Lisp_Object val)
204 w->right_margin_cols = val;
206 static void
207 wset_scroll_bar_width (struct window *w, Lisp_Object val)
209 w->scroll_bar_width = val;
211 static void
212 wset_start (struct window *w, Lisp_Object val)
214 w->start = val;
216 static void
217 wset_temslot (struct window *w, Lisp_Object val)
219 w->temslot = val;
221 static void
222 wset_vertical_scroll_bar_type (struct window *w, Lisp_Object val)
224 w->vertical_scroll_bar_type = val;
226 static void
227 wset_window_parameters (struct window *w, Lisp_Object val)
229 w->window_parameters = val;
231 static void
232 wset_combination (struct window *w, bool horflag, Lisp_Object val)
234 /* Since leaf windows never becomes non-leaf, there should
235 be no buffer and markers in start and pointm fields of W. */
236 eassert (!BUFFERP (w->contents) && NILP (w->start) && NILP (w->pointm));
237 w->contents = val;
238 /* When an internal window is deleted and VAL is nil, HORFLAG
239 is meaningless. */
240 if (!NILP (val))
241 w->horizontal = horflag;
244 struct window *
245 decode_live_window (register Lisp_Object window)
247 if (NILP (window))
248 return XWINDOW (selected_window);
250 CHECK_LIVE_WINDOW (window);
251 return XWINDOW (window);
254 struct window *
255 decode_any_window (register Lisp_Object window)
257 struct window *w;
259 if (NILP (window))
260 return XWINDOW (selected_window);
262 CHECK_WINDOW (window);
263 w = XWINDOW (window);
264 return w;
267 static struct window *
268 decode_valid_window (register Lisp_Object window)
270 struct window *w;
272 if (NILP (window))
273 return XWINDOW (selected_window);
275 CHECK_VALID_WINDOW (window);
276 w = XWINDOW (window);
277 return w;
280 /* Called when W's buffer slot is changed. ARG -1 means that W is about to
281 cease its buffer, and 1 means that W is about to set up the new one. */
283 static void
284 adjust_window_count (struct window *w, int arg)
286 eassert (eabs (arg) == 1);
287 if (BUFFERP (w->contents))
289 struct buffer *b = XBUFFER (w->contents);
291 if (b->base_buffer)
292 b = b->base_buffer;
293 b->window_count += arg;
294 eassert (b->window_count >= 0);
295 /* These should be recalculated by redisplay code. */
296 w->window_end_valid = 0;
297 w->base_line_pos = 0;
301 /* Set W's buffer slot to VAL and recompute number
302 of windows showing VAL if it is a buffer. */
304 void
305 wset_buffer (struct window *w, Lisp_Object val)
307 adjust_window_count (w, -1);
308 if (BUFFERP (val))
309 /* Make sure that we do not assign the buffer
310 to an internal window. */
311 eassert (MARKERP (w->start) && MARKERP (w->pointm));
312 w->contents = val;
313 adjust_window_count (w, 1);
316 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
317 doc: /* Return t if OBJECT is a window and nil otherwise. */)
318 (Lisp_Object object)
320 return WINDOWP (object) ? Qt : Qnil;
323 DEFUN ("window-valid-p", Fwindow_valid_p, Swindow_valid_p, 1, 1, 0,
324 doc: /* Return t if OBJECT is a valid window and nil otherwise.
325 A valid window is either a window that displays a buffer or an internal
326 window. Deleted windows are not live. */)
327 (Lisp_Object object)
329 return WINDOW_VALID_P (object) ? Qt : Qnil;
332 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
333 doc: /* Return t if OBJECT is a live window and nil otherwise.
334 A live window is a window that displays a buffer.
335 Internal windows and deleted windows are not live. */)
336 (Lisp_Object object)
338 return WINDOW_LIVE_P (object) ? Qt : Qnil;
341 /* Frames and windows. */
342 DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 0, 1, 0,
343 doc: /* Return the frame that window WINDOW is on.
344 WINDOW must be a valid window and defaults to the selected one. */)
345 (Lisp_Object window)
347 return decode_valid_window (window)->frame;
350 DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
351 doc: /* Return the root window of FRAME-OR-WINDOW.
352 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
353 With a frame argument, return that frame's root window.
354 With a window argument, return the root window of that window's frame. */)
355 (Lisp_Object frame_or_window)
357 Lisp_Object window;
359 if (NILP (frame_or_window))
360 window = SELECTED_FRAME ()->root_window;
361 else if (WINDOW_VALID_P (frame_or_window))
362 window = XFRAME (XWINDOW (frame_or_window)->frame)->root_window;
363 else
365 CHECK_LIVE_FRAME (frame_or_window);
366 window = XFRAME (frame_or_window)->root_window;
369 return window;
372 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
373 doc: /* Return the minibuffer window for frame FRAME.
374 If FRAME is omitted or nil, it defaults to the selected frame. */)
375 (Lisp_Object frame)
377 return FRAME_MINIBUF_WINDOW (decode_live_frame (frame));
380 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
381 Swindow_minibuffer_p, 0, 1, 0,
382 doc: /* Return non-nil if WINDOW is a minibuffer window.
383 WINDOW must be a valid window and defaults to the selected one. */)
384 (Lisp_Object window)
386 return MINI_WINDOW_P (decode_valid_window (window)) ? Qt : Qnil;
389 /* Don't move this to window.el - this must be a safe routine. */
390 DEFUN ("frame-first-window", Fframe_first_window, Sframe_first_window, 0, 1, 0,
391 doc: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
392 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
393 Else if FRAME-OR-WINDOW denotes a valid window, return the first window
394 of that window's frame. If FRAME-OR-WINDOW denotes a live frame, return
395 the first window of that frame. */)
396 (Lisp_Object frame_or_window)
398 Lisp_Object window;
400 if (NILP (frame_or_window))
401 window = SELECTED_FRAME ()->root_window;
402 else if (WINDOW_VALID_P (frame_or_window))
403 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
404 else
406 CHECK_LIVE_FRAME (frame_or_window);
407 window = XFRAME (frame_or_window)->root_window;
410 while (WINDOWP (XWINDOW (window)->contents))
411 window = XWINDOW (window)->contents;
413 return window;
416 DEFUN ("frame-selected-window", Fframe_selected_window,
417 Sframe_selected_window, 0, 1, 0,
418 doc: /* Return the selected window of FRAME-OR-WINDOW.
419 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
420 Else if FRAME-OR-WINDOW denotes a valid window, return the selected
421 window of that window's frame. If FRAME-OR-WINDOW denotes a live frame,
422 return the selected window of that frame. */)
423 (Lisp_Object frame_or_window)
425 Lisp_Object window;
427 if (NILP (frame_or_window))
428 window = SELECTED_FRAME ()->selected_window;
429 else if (WINDOW_VALID_P (frame_or_window))
430 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
431 else
433 CHECK_LIVE_FRAME (frame_or_window);
434 window = XFRAME (frame_or_window)->selected_window;
437 return window;
440 DEFUN ("set-frame-selected-window", Fset_frame_selected_window,
441 Sset_frame_selected_window, 2, 3, 0,
442 doc: /* Set selected window of FRAME to WINDOW.
443 FRAME must be a live frame and defaults to the selected one. If FRAME
444 is the selected frame, this makes WINDOW the selected window. Optional
445 argument NORECORD non-nil means to neither change the order of recently
446 selected windows nor the buffer list. WINDOW must denote a live window.
447 Return WINDOW. */)
448 (Lisp_Object frame, Lisp_Object window, Lisp_Object norecord)
450 if (NILP (frame))
451 frame = selected_frame;
453 CHECK_LIVE_FRAME (frame);
454 CHECK_LIVE_WINDOW (window);
456 if (! EQ (frame, WINDOW_FRAME (XWINDOW (window))))
457 error ("In `set-frame-selected-window', WINDOW is not on FRAME");
459 if (EQ (frame, selected_frame))
460 return Fselect_window (window, norecord);
461 else
463 fset_selected_window (XFRAME (frame), window);
464 return window;
468 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
469 doc: /* Return the selected window.
470 The selected window is the window in which the standard cursor for
471 selected windows appears and to which many commands apply. */)
472 (void)
474 return selected_window;
477 int window_select_count;
479 /* If select_window is called with inhibit_point_swap non-zero it will
480 not store point of the old selected window's buffer back into that
481 window's pointm slot. This is needed by Fset_window_configuration to
482 avoid that the display routine is called with selected_window set to
483 Qnil causing a subsequent crash. */
484 static Lisp_Object
485 select_window (Lisp_Object window, Lisp_Object norecord, int inhibit_point_swap)
487 register struct window *w;
488 struct frame *sf;
490 CHECK_LIVE_WINDOW (window);
492 w = XWINDOW (window);
493 w->frozen_window_start_p = 0;
495 /* Make the selected window's buffer current. */
496 Fset_buffer (w->contents);
498 if (EQ (window, selected_window) && !inhibit_point_swap)
499 /* `switch-to-buffer' uses (select-window (selected-window)) as a "clever"
500 way to call record_buffer from Elisp, so it's important that we call
501 record_buffer before returning here. */
502 goto record_and_return;
504 sf = SELECTED_FRAME ();
505 if (XFRAME (WINDOW_FRAME (w)) != sf)
507 fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
508 /* Use this rather than Fhandle_switch_frame
509 so that FRAME_FOCUS_FRAME is moved appropriately as we
510 move around in the state where a minibuffer in a separate
511 frame is active. */
512 Fselect_frame (WINDOW_FRAME (w), norecord);
513 /* Fselect_frame called us back so we've done all the work already. */
514 eassert (EQ (window, selected_window));
515 return window;
517 else
518 fset_selected_window (sf, window);
520 select_window_1 (window, inhibit_point_swap);
521 bset_last_selected_window (XBUFFER (w->contents), window);
522 windows_or_buffers_changed++;
524 record_and_return:
525 /* record_buffer can run QUIT, so make sure it is run only after we have
526 re-established the invariant between selected_window and selected_frame,
527 otherwise the temporary broken invariant might "escape" (bug#14161). */
528 if (NILP (norecord))
530 w->use_time = ++window_select_count;
531 record_buffer (w->contents);
534 return window;
537 /* Select window with a minimum of fuss, i.e. don't record the change anywhere
538 (not even for redisplay's benefit), and assume that the window's frame is
539 already selected. */
540 static void
541 select_window_1 (Lisp_Object window, bool inhibit_point_swap)
543 /* Store the old selected window's buffer's point in pointm of the old
544 selected window. It belongs to that window, and when the window is
545 not selected, must be in the window. */
546 if (!inhibit_point_swap)
548 struct window *ow = XWINDOW (selected_window);
549 if (BUFFERP (ow->contents))
550 set_marker_both (ow->pointm, ow->contents,
551 BUF_PT (XBUFFER (ow->contents)),
552 BUF_PT_BYTE (XBUFFER (ow->contents)));
555 selected_window = window;
557 /* Go to the point recorded in the window.
558 This is important when the buffer is in more
559 than one window. It also matters when
560 redisplay_window has altered point after scrolling,
561 because it makes the change only in the window. */
563 register ptrdiff_t new_point = marker_position (XWINDOW (window)->pointm);
564 if (new_point < BEGV)
565 SET_PT (BEGV);
566 else if (new_point > ZV)
567 SET_PT (ZV);
568 else
569 SET_PT (new_point);
573 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
574 doc: /* Select WINDOW which must be a live window.
575 Also make WINDOW's frame the selected frame and WINDOW that frame's
576 selected window. In addition, make WINDOW's buffer current and set that
577 buffer's value of `point' to the value of WINDOW's `window-point'.
578 Return WINDOW.
580 Optional second arg NORECORD non-nil means do not put this buffer at the
581 front of the buffer list and do not make this window the most recently
582 selected one.
584 Note that the main editor command loop sets the current buffer to the
585 buffer of the selected window before each command. */)
586 (register Lisp_Object window, Lisp_Object norecord)
588 return select_window (window, norecord, 0);
591 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
592 doc: /* Return the buffer displayed in window WINDOW.
593 If WINDOW is omitted or nil, it defaults to the selected window.
594 Return nil for an internal window or a deleted window. */)
595 (Lisp_Object window)
597 struct window *w = decode_any_window (window);
598 return WINDOW_LEAF_P (w) ? w->contents : Qnil;
601 DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
602 doc: /* Return the parent window of window WINDOW.
603 WINDOW must be a valid window and defaults to the selected one.
604 Return nil for a window with no parent (e.g. a root window). */)
605 (Lisp_Object window)
607 return decode_valid_window (window)->parent;
610 DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
611 doc: /* Return the topmost child window of window WINDOW.
612 WINDOW must be a valid window and defaults to the selected one.
613 Return nil if WINDOW is a live window (live windows have no children).
614 Return nil if WINDOW is an internal window whose children form a
615 horizontal combination. */)
616 (Lisp_Object window)
618 struct window *w = decode_valid_window (window);
619 return WINDOW_VERTICAL_COMBINATION_P (w) ? w->contents : Qnil;
622 DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
623 doc: /* Return the leftmost child window of window WINDOW.
624 WINDOW must be a valid window and defaults to the selected one.
625 Return nil if WINDOW is a live window (live windows have no children).
626 Return nil if WINDOW is an internal window whose children form a
627 vertical combination. */)
628 (Lisp_Object window)
630 struct window *w = decode_valid_window (window);
631 return WINDOW_HORIZONTAL_COMBINATION_P (w) ? w->contents : Qnil;
634 DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
635 doc: /* Return the next sibling window of window WINDOW.
636 WINDOW must be a valid window and defaults to the selected one.
637 Return nil if WINDOW has no next sibling. */)
638 (Lisp_Object window)
640 return decode_valid_window (window)->next;
643 DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
644 doc: /* Return the previous sibling window of window WINDOW.
645 WINDOW must be a valid window and defaults to the selected one.
646 Return nil if WINDOW has no previous sibling. */)
647 (Lisp_Object window)
649 return decode_valid_window (window)->prev;
652 DEFUN ("window-combination-limit", Fwindow_combination_limit, Swindow_combination_limit, 1, 1, 0,
653 doc: /* Return combination limit of window WINDOW.
654 WINDOW must be a valid window used in horizontal or vertical combination.
655 If the return value is nil, child windows of WINDOW can be recombined with
656 WINDOW's siblings. A return value of t means that child windows of
657 WINDOW are never \(re-)combined with WINDOW's siblings. */)
658 (Lisp_Object window)
660 struct window *w;
662 CHECK_VALID_WINDOW (window);
663 w = XWINDOW (window);
664 if (WINDOW_LEAF_P (w))
665 error ("Combination limit is meaningful for internal windows only");
666 return w->combination_limit;
669 DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
670 doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
671 WINDOW must be a valid window used in horizontal or vertical combination.
672 If LIMIT is nil, child windows of WINDOW can be recombined with WINDOW's
673 siblings. LIMIT t means that child windows of WINDOW are never
674 \(re-)combined with WINDOW's siblings. Other values are reserved for
675 future use. */)
676 (Lisp_Object window, Lisp_Object limit)
678 struct window *w;
680 CHECK_VALID_WINDOW (window);
681 w = XWINDOW (window);
682 if (WINDOW_LEAF_P (w))
683 error ("Combination limit is meaningful for internal windows only");
684 wset_combination_limit (w, limit);
685 return limit;
688 DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
689 doc: /* Return the use time of window WINDOW.
690 WINDOW must be a live window and defaults to the selected one.
691 The window with the highest use time is the most recently selected
692 one. The window with the lowest use time is the least recently
693 selected one. */)
694 (Lisp_Object window)
696 return make_number (decode_live_window (window)->use_time);
699 DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 1, 0,
700 doc: /* Return the total height, in lines, of window WINDOW.
701 WINDOW must be a valid window and defaults to the selected one.
703 The return value includes the mode line and header line, if any.
704 If WINDOW is an internal window, the total height is the height
705 of the screen areas spanned by its children.
707 On a graphical display, this total height is reported as an
708 integer multiple of the default character height. */)
709 (Lisp_Object window)
711 return make_number (decode_valid_window (window)->total_lines);
714 DEFUN ("window-total-width", Fwindow_total_width, Swindow_total_width, 0, 1, 0,
715 doc: /* Return the total width, in columns, of window WINDOW.
716 WINDOW must be a valid window and defaults to the selected one.
718 The return value includes any vertical dividers or scroll bars
719 belonging to WINDOW. If WINDOW is an internal window, the total width
720 is the width of the screen areas spanned by its children.
722 On a graphical display, this total width is reported as an
723 integer multiple of the default character width. */)
724 (Lisp_Object window)
726 return make_number (decode_valid_window (window)->total_cols);
729 DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
730 doc: /* Return the new total size of window WINDOW.
731 WINDOW must be a valid window and defaults to the selected one. */)
732 (Lisp_Object window)
734 return decode_valid_window (window)->new_total;
737 DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
738 doc: /* Return the normal height of window WINDOW.
739 WINDOW must be a valid window and defaults to the selected one.
740 If HORIZONTAL is non-nil, return the normal width of WINDOW. */)
741 (Lisp_Object window, Lisp_Object horizontal)
743 struct window *w = decode_valid_window (window);
745 return NILP (horizontal) ? w->normal_lines : w->normal_cols;
748 DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
749 doc: /* Return new normal size of window WINDOW.
750 WINDOW must be a valid window and defaults to the selected one. */)
751 (Lisp_Object window)
753 return decode_valid_window (window)->new_normal;
756 DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
757 doc: /* Return left column of window WINDOW.
758 This is the distance, in columns, between the left edge of WINDOW and
759 the left edge of the frame's window area. For instance, the return
760 value is 0 if there is no window to the left of WINDOW.
762 WINDOW must be a valid window and defaults to the selected one. */)
763 (Lisp_Object window)
765 return make_number (decode_valid_window (window)->left_col);
768 DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
769 doc: /* Return top line of window WINDOW.
770 This is the distance, in lines, between the top of WINDOW and the top
771 of the frame's window area. For instance, the return value is 0 if
772 there is no window above WINDOW.
774 WINDOW must be a valid window and defaults to the selected one. */)
775 (Lisp_Object window)
777 return make_number (decode_valid_window (window)->top_line);
780 /* Return the number of lines of W's body. Don't count any mode or
781 header line of W. */
783 static int
784 window_body_lines (struct window *w)
786 int height = w->total_lines;
788 if (!MINI_WINDOW_P (w))
790 if (WINDOW_WANTS_MODELINE_P (w))
791 --height;
792 if (WINDOW_WANTS_HEADER_LINE_P (w))
793 --height;
796 return height;
799 /* Return the number of columns of W's body. Don't count columns
800 occupied by the scroll bar or the vertical bar separating W from its
801 right sibling. On window-systems don't count fringes or display
802 margins either. */
805 window_body_cols (struct window *w)
807 struct frame *f = XFRAME (WINDOW_FRAME (w));
808 int width = w->total_cols;
810 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
811 /* Scroll bars occupy a few columns. */
812 width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
813 else if (!FRAME_WINDOW_P (f)
814 && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
815 /* The column of `|' characters separating side-by-side windows
816 occupies one column only. */
817 width -= 1;
819 /* Display margins cannot be used for normal text. */
820 width -= WINDOW_LEFT_MARGIN_COLS (w) + WINDOW_RIGHT_MARGIN_COLS (w);
822 if (FRAME_WINDOW_P (f))
823 /* On window-systems, fringes cannot be used for normal text. */
824 width -= WINDOW_FRINGE_COLS (w);
826 return width;
829 DEFUN ("window-body-height", Fwindow_body_height, Swindow_body_height, 0, 1, 0,
830 doc: /* Return the height, in lines, of WINDOW's text area.
831 WINDOW must be a live window and defaults to the selected one.
833 The returned height does not include the mode line or header line.
834 On a graphical display, the height is expressed as an integer multiple
835 of the default character height. If a line at the bottom of the text
836 area is only partially visible, that counts as a whole line; to
837 exclude partially-visible lines, use `window-text-height'. */)
838 (Lisp_Object window)
840 return make_number (window_body_lines (decode_live_window (window)));
843 DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 1, 0,
844 doc: /* Return the width, in columns, of WINDOW's text area.
845 WINDOW must be a live window and defaults to the selected one.
847 The return value does not include any vertical dividers, fringe or
848 marginal areas, or scroll bars. On a graphical display, the width is
849 expressed as an integer multiple of the default character width. */)
850 (Lisp_Object window)
852 return make_number (window_body_cols (decode_live_window (window)));
855 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
856 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
857 WINDOW must be a live window and defaults to the selected one. */)
858 (Lisp_Object window)
860 return make_number (decode_live_window (window)->hscroll);
863 /* Set W's horizontal scroll amount to HSCROLL clipped to a reasonable
864 range, returning the new amount as a fixnum. */
865 static Lisp_Object
866 set_window_hscroll (struct window *w, EMACS_INT hscroll)
868 /* Horizontal scrolling has problems with large scroll amounts.
869 It's too slow with long lines, and even with small lines the
870 display can be messed up. For now, though, impose only the limits
871 required by the internal representation: horizontal scrolling must
872 fit in fixnum (since it's visible to Elisp) and into ptrdiff_t
873 (since it's stored in a ptrdiff_t). */
874 ptrdiff_t hscroll_max = min (MOST_POSITIVE_FIXNUM, PTRDIFF_MAX);
875 ptrdiff_t new_hscroll = clip_to_bounds (0, hscroll, hscroll_max);
877 /* Prevent redisplay shortcuts when changing the hscroll. */
878 if (w->hscroll != new_hscroll)
879 XBUFFER (w->contents)->prevent_redisplay_optimizations_p = 1;
881 w->hscroll = new_hscroll;
882 return make_number (new_hscroll);
885 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
886 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
887 WINDOW must be a live window and defaults to the selected one.
888 Clip the number to a reasonable value if out of range.
889 Return the new number. NCOL should be zero or positive.
891 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
892 window so that the location of point moves off-window. */)
893 (Lisp_Object window, Lisp_Object ncol)
895 CHECK_NUMBER (ncol);
896 return set_window_hscroll (decode_live_window (window), XINT (ncol));
899 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
900 Swindow_redisplay_end_trigger, 0, 1, 0,
901 doc: /* Return WINDOW's redisplay end trigger value.
902 WINDOW must be a live window and defaults to the selected one.
903 See `set-window-redisplay-end-trigger' for more information. */)
904 (Lisp_Object window)
906 return decode_live_window (window)->redisplay_end_trigger;
909 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
910 Sset_window_redisplay_end_trigger, 2, 2, 0,
911 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
912 WINDOW must be a live window and defaults to the selected one. VALUE
913 should be a buffer position (typically a marker) or nil. If it is a
914 buffer position, then if redisplay in WINDOW reaches a position beyond
915 VALUE, the functions in `redisplay-end-trigger-functions' are called
916 with two arguments: WINDOW, and the end trigger value. Afterwards the
917 end-trigger value is reset to nil. */)
918 (register Lisp_Object window, Lisp_Object value)
920 wset_redisplay_end_trigger (decode_live_window (window), value);
921 return value;
924 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
925 doc: /* Return a list of the edge coordinates of WINDOW.
926 WINDOW must be a valid window and defaults to the selected one.
928 The returned list has the form (LEFT TOP RIGHT BOTTOM). TOP and BOTTOM
929 count by lines, and LEFT and RIGHT count by columns, all relative to 0,
930 0 at top left corner of frame.
932 RIGHT is one more than the rightmost column occupied by WINDOW. BOTTOM
933 is one more than the bottommost row occupied by WINDOW. The edges
934 include the space used by WINDOW's scroll bar, display margins, fringes,
935 header line, and/or mode line. For the edges of just the text area, use
936 `window-inside-edges'. */)
937 (Lisp_Object window)
939 register struct window *w = decode_valid_window (window);
941 return list4i (WINDOW_LEFT_EDGE_COL (w), WINDOW_TOP_EDGE_LINE (w),
942 WINDOW_RIGHT_EDGE_COL (w), WINDOW_BOTTOM_EDGE_LINE (w));
945 DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
946 doc: /* Return a list of the edge pixel coordinates of WINDOW.
947 WINDOW must be a valid window and defaults to the selected one.
949 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
950 0, 0 at the top left corner of the frame.
952 RIGHT is one more than the rightmost x position occupied by WINDOW.
953 BOTTOM is one more than the bottommost y position occupied by WINDOW.
954 The pixel edges include the space used by WINDOW's scroll bar, display
955 margins, fringes, header line, and/or mode line. For the pixel edges
956 of just the text area, use `window-inside-pixel-edges'. */)
957 (Lisp_Object window)
959 register struct window *w = decode_valid_window (window);
961 return list4i (WINDOW_LEFT_EDGE_X (w), WINDOW_TOP_EDGE_Y (w),
962 WINDOW_RIGHT_EDGE_X (w), WINDOW_BOTTOM_EDGE_Y (w));
965 static void
966 calc_absolute_offset (struct window *w, int *add_x, int *add_y)
968 struct frame *f = XFRAME (w->frame);
969 *add_y = f->top_pos;
970 #ifdef FRAME_MENUBAR_HEIGHT
971 *add_y += FRAME_MENUBAR_HEIGHT (f);
972 #endif
973 #ifdef FRAME_TOOLBAR_TOP_HEIGHT
974 *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
975 #elif FRAME_TOOLBAR_HEIGHT
976 *add_y += FRAME_TOOLBAR_HEIGHT (f);
977 #endif
978 #ifdef FRAME_NS_TITLEBAR_HEIGHT
979 *add_y += FRAME_NS_TITLEBAR_HEIGHT (f);
980 #endif
981 *add_x = f->left_pos;
982 #ifdef FRAME_TOOLBAR_LEFT_WIDTH
983 *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
984 #endif
987 DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges,
988 Swindow_absolute_pixel_edges, 0, 1, 0,
989 doc: /* Return a list of the edge pixel coordinates of WINDOW.
990 WINDOW must be a valid window and defaults to the selected one.
992 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
993 0, 0 at the top left corner of the display.
995 RIGHT is one more than the rightmost x position occupied by WINDOW.
996 BOTTOM is one more than the bottommost y position occupied by WINDOW.
997 The pixel edges include the space used by WINDOW's scroll bar, display
998 margins, fringes, header line, and/or mode line. For the pixel edges
999 of just the text area, use `window-inside-absolute-pixel-edges'. */)
1000 (Lisp_Object window)
1002 register struct window *w = decode_valid_window (window);
1003 int add_x, add_y;
1005 calc_absolute_offset (w, &add_x, &add_y);
1007 return list4i (WINDOW_LEFT_EDGE_X (w) + add_x,
1008 WINDOW_TOP_EDGE_Y (w) + add_y,
1009 WINDOW_RIGHT_EDGE_X (w) + add_x,
1010 WINDOW_BOTTOM_EDGE_Y (w) + add_y);
1013 DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
1014 doc: /* Return a list of the edge coordinates of WINDOW.
1015 WINDOW must be a live window and defaults to the selected one.
1017 The returned list has the form (LEFT TOP RIGHT BOTTOM). TOP and BOTTOM
1018 count by lines, and LEFT and RIGHT count by columns, all relative to 0,
1019 0 at top left corner of frame.
1021 RIGHT is one more than the rightmost column of WINDOW's text area.
1022 BOTTOM is one more than the bottommost row of WINDOW's text area. The
1023 inside edges do not include the space used by the WINDOW's scroll bar,
1024 display margins, fringes, header line, and/or mode line. */)
1025 (Lisp_Object window)
1027 register struct window *w = decode_live_window (window);
1029 return list4i ((WINDOW_BOX_LEFT_EDGE_COL (w)
1030 + WINDOW_LEFT_MARGIN_COLS (w)
1031 + WINDOW_LEFT_FRINGE_COLS (w)),
1032 (WINDOW_TOP_EDGE_LINE (w)
1033 + WINDOW_HEADER_LINE_LINES (w)),
1034 (WINDOW_BOX_RIGHT_EDGE_COL (w)
1035 - WINDOW_RIGHT_MARGIN_COLS (w)
1036 - WINDOW_RIGHT_FRINGE_COLS (w)),
1037 (WINDOW_BOTTOM_EDGE_LINE (w)
1038 - WINDOW_MODE_LINE_LINES (w)));
1041 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
1042 doc: /* Return a list of the edge pixel coordinates of WINDOW's text area.
1043 WINDOW must be a live window and defaults to the selected one.
1045 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
1046 (0,0) at the top left corner of the frame's window area.
1048 RIGHT is one more than the rightmost x position of WINDOW's text area.
1049 BOTTOM is one more than the bottommost y position of WINDOW's text area.
1050 The inside edges do not include the space used by WINDOW's scroll bar,
1051 display margins, fringes, header line, and/or mode line. */)
1052 (Lisp_Object window)
1054 register struct window *w = decode_live_window (window);
1056 return list4i ((WINDOW_BOX_LEFT_EDGE_X (w)
1057 + WINDOW_LEFT_MARGIN_WIDTH (w)
1058 + WINDOW_LEFT_FRINGE_WIDTH (w)),
1059 (WINDOW_TOP_EDGE_Y (w)
1060 + WINDOW_HEADER_LINE_HEIGHT (w)),
1061 (WINDOW_BOX_RIGHT_EDGE_X (w)
1062 - WINDOW_RIGHT_MARGIN_WIDTH (w)
1063 - WINDOW_RIGHT_FRINGE_WIDTH (w)),
1064 (WINDOW_BOTTOM_EDGE_Y (w)
1065 - WINDOW_MODE_LINE_HEIGHT (w)));
1068 DEFUN ("window-inside-absolute-pixel-edges",
1069 Fwindow_inside_absolute_pixel_edges,
1070 Swindow_inside_absolute_pixel_edges, 0, 1, 0,
1071 doc: /* Return a list of the edge pixel coordinates of WINDOW's text area.
1072 WINDOW must be a live window and defaults to the selected one.
1074 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
1075 (0,0) at the top left corner of the frame's window area.
1077 RIGHT is one more than the rightmost x position of WINDOW's text area.
1078 BOTTOM is one more than the bottommost y position of WINDOW's text area.
1079 The inside edges do not include the space used by WINDOW's scroll bar,
1080 display margins, fringes, header line, and/or mode line. */)
1081 (Lisp_Object window)
1083 register struct window *w = decode_live_window (window);
1084 int add_x, add_y;
1086 calc_absolute_offset (w, &add_x, &add_y);
1088 return list4i ((WINDOW_BOX_LEFT_EDGE_X (w)
1089 + WINDOW_LEFT_MARGIN_WIDTH (w)
1090 + WINDOW_LEFT_FRINGE_WIDTH (w) + add_x),
1091 (WINDOW_TOP_EDGE_Y (w)
1092 + WINDOW_HEADER_LINE_HEIGHT (w) + add_y),
1093 (WINDOW_BOX_RIGHT_EDGE_X (w)
1094 - WINDOW_RIGHT_MARGIN_WIDTH (w)
1095 - WINDOW_RIGHT_FRINGE_WIDTH (w) + add_x),
1096 (WINDOW_BOTTOM_EDGE_Y (w)
1097 - WINDOW_MODE_LINE_HEIGHT (w) + add_y));
1100 /* Test if the character at column X, row Y is within window W.
1101 If it is not, return ON_NOTHING;
1102 if it is in the window's text area, return ON_TEXT;
1103 if it is on the window's modeline, return ON_MODE_LINE;
1104 if it is on the border between the window and its right sibling,
1105 return ON_VERTICAL_BORDER.
1106 if it is on a scroll bar, return ON_SCROLL_BAR.
1107 if it is on the window's top line, return ON_HEADER_LINE;
1108 if it is in left or right fringe of the window,
1109 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
1110 if it is in the marginal area to the left/right of the window,
1111 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
1113 X and Y are frame relative pixel coordinates. */
1115 static enum window_part
1116 coordinates_in_window (register struct window *w, int x, int y)
1118 struct frame *f = XFRAME (WINDOW_FRAME (w));
1119 enum window_part part;
1120 int ux = FRAME_COLUMN_WIDTH (f);
1121 int left_x = WINDOW_LEFT_EDGE_X (w);
1122 int right_x = WINDOW_RIGHT_EDGE_X (w);
1123 int top_y = WINDOW_TOP_EDGE_Y (w);
1124 int bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
1125 /* The width of the area where the vertical line can be dragged.
1126 (Between mode lines for instance. */
1127 int grabbable_width = ux;
1128 int lmargin_width, rmargin_width, text_left, text_right;
1130 /* Outside any interesting row or column? */
1131 if (y < top_y || y >= bottom_y || x < left_x || x >= right_x)
1132 return ON_NOTHING;
1134 /* On the mode line or header line? */
1135 if ((WINDOW_WANTS_MODELINE_P (w)
1136 && y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w)
1137 && (part = ON_MODE_LINE))
1138 || (WINDOW_WANTS_HEADER_LINE_P (w)
1139 && y < top_y + CURRENT_HEADER_LINE_HEIGHT (w)
1140 && (part = ON_HEADER_LINE)))
1142 /* If it's under/over the scroll bar portion of the mode/header
1143 line, say it's on the vertical line. That's to be able to
1144 resize windows horizontally in case we're using toolkit scroll
1145 bars. Note: If scrollbars are on the left, the window that
1146 must be eventually resized is that on the left of WINDOW. */
1147 if ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
1148 && !WINDOW_LEFTMOST_P (w)
1149 && eabs (x - left_x) < grabbable_width)
1150 || (!WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
1151 && !WINDOW_RIGHTMOST_P (w)
1152 && eabs (x - right_x) < grabbable_width))
1153 return ON_VERTICAL_BORDER;
1154 else
1155 return part;
1158 /* In what's below, we subtract 1 when computing right_x because we
1159 want the rightmost pixel, which is given by left_pixel+width-1. */
1160 if (w->pseudo_window_p)
1162 left_x = 0;
1163 right_x = WINDOW_TOTAL_WIDTH (w) - 1;
1165 else
1167 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
1168 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
1171 /* Outside any interesting column? */
1172 if (x < left_x || x > right_x)
1173 return ON_SCROLL_BAR;
1175 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
1176 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
1178 text_left = window_box_left (w, TEXT_AREA);
1179 text_right = text_left + window_box_width (w, TEXT_AREA);
1181 if (FRAME_WINDOW_P (f))
1183 if (!w->pseudo_window_p
1184 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
1185 && !WINDOW_RIGHTMOST_P (w)
1186 && (eabs (x - right_x) < grabbable_width))
1187 return ON_VERTICAL_BORDER;
1189 /* Need to say "x > right_x" rather than >=, since on character
1190 terminals, the vertical line's x coordinate is right_x. */
1191 else if (!w->pseudo_window_p
1192 && !WINDOW_RIGHTMOST_P (w)
1193 && x > right_x - ux)
1194 return ON_VERTICAL_BORDER;
1196 if (x < text_left)
1198 if (lmargin_width > 0
1199 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1200 ? (x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
1201 : (x < left_x + lmargin_width)))
1202 return ON_LEFT_MARGIN;
1204 return ON_LEFT_FRINGE;
1207 if (x >= text_right)
1209 if (rmargin_width > 0
1210 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1211 ? (x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
1212 : (x >= right_x - rmargin_width)))
1213 return ON_RIGHT_MARGIN;
1215 return ON_RIGHT_FRINGE;
1218 /* Everything special ruled out - must be on text area */
1219 return ON_TEXT;
1222 /* Take X is the frame-relative pixel x-coordinate, and return the
1223 x-coordinate relative to part PART of window W. */
1225 window_relative_x_coord (struct window *w, enum window_part part, int x)
1227 int left_x = (w->pseudo_window_p) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w);
1229 switch (part)
1231 case ON_TEXT:
1232 return x - window_box_left (w, TEXT_AREA);
1234 case ON_LEFT_FRINGE:
1235 return x - left_x;
1237 case ON_RIGHT_FRINGE:
1238 return x - left_x - WINDOW_LEFT_FRINGE_WIDTH (w);
1240 case ON_LEFT_MARGIN:
1241 return (x - left_x
1242 - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1243 ? WINDOW_LEFT_FRINGE_WIDTH (w) : 0));
1245 case ON_RIGHT_MARGIN:
1246 return (x + 1
1247 - ((w->pseudo_window_p)
1248 ? WINDOW_TOTAL_WIDTH (w)
1249 : WINDOW_BOX_RIGHT_EDGE_X (w))
1250 + window_box_width (w, RIGHT_MARGIN_AREA)
1251 + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1252 ? WINDOW_RIGHT_FRINGE_WIDTH (w) : 0));
1255 /* ON_SCROLL_BAR, ON_NOTHING, and ON_VERTICAL_BORDER: */
1256 return 0;
1260 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
1261 Scoordinates_in_window_p, 2, 2, 0,
1262 doc: /* Return non-nil if COORDINATES are in WINDOW.
1263 WINDOW must be a live window and defaults to the selected one.
1264 COORDINATES is a cons of the form (X . Y), X and Y being distances
1265 measured in characters from the upper-left corner of the frame.
1266 \(0 . 0) denotes the character in the upper left corner of the
1267 frame.
1268 If COORDINATES are in the text portion of WINDOW,
1269 the coordinates relative to the window are returned.
1270 If they are in the mode line of WINDOW, `mode-line' is returned.
1271 If they are in the top mode line of WINDOW, `header-line' is returned.
1272 If they are in the left fringe of WINDOW, `left-fringe' is returned.
1273 If they are in the right fringe of WINDOW, `right-fringe' is returned.
1274 If they are on the border between WINDOW and its right sibling,
1275 `vertical-line' is returned.
1276 If they are in the windows's left or right marginal areas, `left-margin'\n\
1277 or `right-margin' is returned. */)
1278 (register Lisp_Object coordinates, Lisp_Object window)
1280 struct window *w;
1281 struct frame *f;
1282 int x, y;
1283 Lisp_Object lx, ly;
1285 w = decode_live_window (window);
1286 f = XFRAME (w->frame);
1287 CHECK_CONS (coordinates);
1288 lx = Fcar (coordinates);
1289 ly = Fcdr (coordinates);
1290 CHECK_NUMBER_OR_FLOAT (lx);
1291 CHECK_NUMBER_OR_FLOAT (ly);
1292 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
1293 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
1295 switch (coordinates_in_window (w, x, y))
1297 case ON_NOTHING:
1298 return Qnil;
1300 case ON_TEXT:
1301 /* Convert X and Y to window relative pixel coordinates, and
1302 return the canonical char units. */
1303 x -= window_box_left (w, TEXT_AREA);
1304 y -= WINDOW_TOP_EDGE_Y (w);
1305 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
1306 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
1308 case ON_MODE_LINE:
1309 return Qmode_line;
1311 case ON_VERTICAL_BORDER:
1312 return Qvertical_line;
1314 case ON_HEADER_LINE:
1315 return Qheader_line;
1317 case ON_LEFT_FRINGE:
1318 return Qleft_fringe;
1320 case ON_RIGHT_FRINGE:
1321 return Qright_fringe;
1323 case ON_LEFT_MARGIN:
1324 return Qleft_margin;
1326 case ON_RIGHT_MARGIN:
1327 return Qright_margin;
1329 case ON_SCROLL_BAR:
1330 /* Historically we are supposed to return nil in this case. */
1331 return Qnil;
1333 default:
1334 emacs_abort ();
1339 /* Callback for foreach_window, used in window_from_coordinates.
1340 Check if window W contains coordinates specified by USER_DATA which
1341 is actually a pointer to a struct check_window_data CW.
1343 Check if window W contains coordinates *CW->x and *CW->y. If it
1344 does, return W in *CW->window, as Lisp_Object, and return in
1345 *CW->part the part of the window under coordinates *X,*Y. Return
1346 zero from this function to stop iterating over windows. */
1348 struct check_window_data
1350 Lisp_Object *window;
1351 int x, y;
1352 enum window_part *part;
1355 static int
1356 check_window_containing (struct window *w, void *user_data)
1358 struct check_window_data *cw = (struct check_window_data *) user_data;
1359 enum window_part found;
1360 int continue_p = 1;
1362 found = coordinates_in_window (w, cw->x, cw->y);
1363 if (found != ON_NOTHING)
1365 *cw->part = found;
1366 XSETWINDOW (*cw->window, w);
1367 continue_p = 0;
1370 return continue_p;
1374 /* Find the window containing frame-relative pixel position X/Y and
1375 return it as a Lisp_Object.
1377 If X, Y is on one of the window's special `window_part' elements,
1378 set *PART to the id of that element.
1380 If there is no window under X, Y return nil and leave *PART
1381 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1383 This function was previously implemented with a loop cycling over
1384 windows with Fnext_window, and starting with the frame's selected
1385 window. It turned out that this doesn't work with an
1386 implementation of next_window using Vwindow_list, because
1387 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1388 tree of F when this function is called asynchronously from
1389 note_mouse_highlight. The original loop didn't terminate in this
1390 case. */
1392 Lisp_Object
1393 window_from_coordinates (struct frame *f, int x, int y,
1394 enum window_part *part, bool tool_bar_p)
1396 Lisp_Object window;
1397 struct check_window_data cw;
1398 enum window_part dummy;
1400 if (part == 0)
1401 part = &dummy;
1403 window = Qnil;
1404 cw.window = &window, cw.x = x, cw.y = y; cw.part = part;
1405 foreach_window (f, check_window_containing, &cw);
1407 /* If not found above, see if it's in the tool bar window, if a tool
1408 bar exists. */
1409 if (NILP (window)
1410 && tool_bar_p
1411 && WINDOWP (f->tool_bar_window)
1412 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1413 && (coordinates_in_window (XWINDOW (f->tool_bar_window), x, y)
1414 != ON_NOTHING))
1416 *part = ON_TEXT;
1417 window = f->tool_bar_window;
1420 return window;
1423 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1424 doc: /* Return window containing coordinates X and Y on FRAME.
1425 FRAME must be a live frame and defaults to the selected one.
1426 The top left corner of the frame is considered to be row 0,
1427 column 0. */)
1428 (Lisp_Object x, Lisp_Object y, Lisp_Object frame)
1430 struct frame *f = decode_live_frame (frame);
1432 /* Check that arguments are integers or floats. */
1433 CHECK_NUMBER_OR_FLOAT (x);
1434 CHECK_NUMBER_OR_FLOAT (y);
1436 return window_from_coordinates (f,
1437 (FRAME_PIXEL_X_FROM_CANON_X (f, x)
1438 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1439 (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
1440 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1441 0, 0);
1444 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1445 doc: /* Return current value of point in WINDOW.
1446 WINDOW must be a live window and defaults to the selected one.
1448 For a nonselected window, this is the value point would have if that
1449 window were selected.
1451 Note that, when WINDOW is selected, the value returned is the same as
1452 that returned by `point' for WINDOW's buffer. It would be more strictly
1453 correct to return the top-level value of `point', outside of any
1454 `save-excursion' forms. But that is hard to define. */)
1455 (Lisp_Object window)
1457 register struct window *w = decode_live_window (window);
1459 if (w == XWINDOW (selected_window))
1460 return make_number (BUF_PT (XBUFFER (w->contents)));
1461 else
1462 return Fmarker_position (w->pointm);
1465 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1466 doc: /* Return position at which display currently starts in WINDOW.
1467 WINDOW must be a live window and defaults to the selected one.
1468 This is updated by redisplay or by calling `set-window-start'. */)
1469 (Lisp_Object window)
1471 return Fmarker_position (decode_live_window (window)->start);
1474 /* This is text temporarily removed from the doc string below.
1476 This function returns nil if the position is not currently known.
1477 That happens when redisplay is preempted and doesn't finish.
1478 If in that case you want to compute where the end of the window would
1479 have been if redisplay had finished, do this:
1480 (save-excursion
1481 (goto-char (window-start window))
1482 (vertical-motion (1- (window-height window)) window)
1483 (point))") */
1485 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1486 doc: /* Return position at which display currently ends in WINDOW.
1487 WINDOW must be a live window and defaults to the selected one.
1488 This is updated by redisplay, when it runs to completion.
1489 Simply changing the buffer text or setting `window-start'
1490 does not update this value.
1491 Return nil if there is no recorded value. (This can happen if the
1492 last redisplay of WINDOW was preempted, and did not finish.)
1493 If UPDATE is non-nil, compute the up-to-date position
1494 if it isn't already recorded. */)
1495 (Lisp_Object window, Lisp_Object update)
1497 Lisp_Object value;
1498 struct window *w = decode_live_window (window);
1499 Lisp_Object buf;
1500 struct buffer *b;
1502 buf = w->contents;
1503 CHECK_BUFFER (buf);
1504 b = XBUFFER (buf);
1506 if (! NILP (update)
1507 && (windows_or_buffers_changed
1508 || !w->window_end_valid
1509 || b->clip_changed
1510 || b->prevent_redisplay_optimizations_p
1511 || w->last_modified < BUF_MODIFF (b)
1512 || w->last_overlay_modified < BUF_OVERLAY_MODIFF (b))
1513 && !noninteractive)
1515 struct text_pos startp;
1516 ptrdiff_t charpos = marker_position (w->start);
1517 struct it it;
1518 struct buffer *old_buffer = NULL;
1519 void *itdata = NULL;
1521 /* Cannot use Fvertical_motion because that function doesn't
1522 cope with variable-height lines. */
1523 if (b != current_buffer)
1525 old_buffer = current_buffer;
1526 set_buffer_internal (b);
1529 /* In case W->start is out of the range, use something
1530 reasonable. This situation occurred when loading a file with
1531 `-l' containing a call to `rmail' with subsequent other
1532 commands. At the end, W->start happened to be BEG, while
1533 rmail had already narrowed the buffer. */
1534 if (charpos < BEGV)
1535 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1536 else if (charpos > ZV)
1537 SET_TEXT_POS (startp, ZV, ZV_BYTE);
1538 else
1539 SET_TEXT_POS_FROM_MARKER (startp, w->start);
1541 itdata = bidi_shelve_cache ();
1542 start_display (&it, w, startp);
1543 move_it_vertically (&it, window_box_height (w));
1544 if (it.current_y < it.last_visible_y)
1545 move_it_past_eol (&it);
1546 value = make_number (IT_CHARPOS (it));
1547 bidi_unshelve_cache (itdata, 0);
1549 if (old_buffer)
1550 set_buffer_internal (old_buffer);
1552 else
1553 XSETINT (value, BUF_Z (b) - XFASTINT (w->window_end_pos));
1555 return value;
1558 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1559 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1560 WINDOW must be a live window and defaults to the selected one.
1561 Return POS. */)
1562 (Lisp_Object window, Lisp_Object pos)
1564 register struct window *w = decode_live_window (window);
1566 /* Type of POS is checked by Fgoto_char or set_marker_restricted ... */
1568 if (w == XWINDOW (selected_window))
1570 if (XBUFFER (w->contents) == current_buffer)
1571 Fgoto_char (pos);
1572 else
1574 struct buffer *old_buffer = current_buffer;
1576 /* ... but here we want to catch type error before buffer change. */
1577 CHECK_NUMBER_COERCE_MARKER (pos);
1578 set_buffer_internal (XBUFFER (w->contents));
1579 Fgoto_char (pos);
1580 set_buffer_internal (old_buffer);
1583 else
1585 set_marker_restricted (w->pointm, pos, w->contents);
1586 /* We have to make sure that redisplay updates the window to show
1587 the new value of point. */
1588 ++windows_or_buffers_changed;
1591 return pos;
1594 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1595 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1596 WINDOW must be a live window and defaults to the selected one. Return
1597 POS. Optional third arg NOFORCE non-nil inhibits next redisplay from
1598 overriding motion of point in order to display at this exact start. */)
1599 (Lisp_Object window, Lisp_Object pos, Lisp_Object noforce)
1601 register struct window *w = decode_live_window (window);
1603 set_marker_restricted (w->start, pos, w->contents);
1604 /* This is not right, but much easier than doing what is right. */
1605 w->start_at_line_beg = 0;
1606 if (NILP (noforce))
1607 w->force_start = 1;
1608 w->update_mode_line = 1;
1609 w->last_modified = 0;
1610 w->last_overlay_modified = 0;
1611 if (!EQ (window, selected_window))
1612 windows_or_buffers_changed++;
1614 return pos;
1617 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
1618 Spos_visible_in_window_p, 0, 3, 0,
1619 doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
1620 WINDOW must be a live window and defaults to the selected one.
1622 Return nil if that position is scrolled vertically out of view. If a
1623 character is only partially visible, nil is returned, unless the
1624 optional argument PARTIALLY is non-nil. If POS is only out of view
1625 because of horizontal scrolling, return non-nil. If POS is t, it
1626 specifies the position of the last visible glyph in WINDOW. POS
1627 defaults to point in WINDOW; WINDOW defaults to the selected window.
1629 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
1630 the return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
1631 where X and Y are the pixel coordinates relative to the top left corner
1632 of the window. The remaining elements are omitted if the character after
1633 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
1634 off-window at the top and bottom of the screen line ("row") containing
1635 POS, ROWH is the visible height of that row, and VPOS is the row number
1636 \(zero-based). */)
1637 (Lisp_Object pos, Lisp_Object window, Lisp_Object partially)
1639 register struct window *w;
1640 register EMACS_INT posint;
1641 register struct buffer *buf;
1642 struct text_pos top;
1643 Lisp_Object in_window = Qnil;
1644 int rtop, rbot, rowh, vpos, fully_p = 1;
1645 int x, y;
1647 w = decode_live_window (window);
1648 buf = XBUFFER (w->contents);
1649 SET_TEXT_POS_FROM_MARKER (top, w->start);
1651 if (EQ (pos, Qt))
1652 posint = -1;
1653 else if (!NILP (pos))
1655 CHECK_NUMBER_COERCE_MARKER (pos);
1656 posint = XINT (pos);
1658 else if (w == XWINDOW (selected_window))
1659 posint = PT;
1660 else
1661 posint = marker_position (w->pointm);
1663 /* If position is above window start or outside buffer boundaries,
1664 or if window start is out of range, position is not visible. */
1665 if ((EQ (pos, Qt)
1666 || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
1667 && CHARPOS (top) >= BUF_BEGV (buf)
1668 && CHARPOS (top) <= BUF_ZV (buf)
1669 && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
1670 && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
1671 in_window = Qt;
1673 if (!NILP (in_window) && !NILP (partially))
1675 Lisp_Object part = Qnil;
1676 if (!fully_p)
1677 part = list4i (rtop, rbot, rowh, vpos);
1678 in_window = Fcons (make_number (x),
1679 Fcons (make_number (y), part));
1682 return in_window;
1685 DEFUN ("window-line-height", Fwindow_line_height,
1686 Swindow_line_height, 0, 2, 0,
1687 doc: /* Return height in pixels of text line LINE in window WINDOW.
1688 WINDOW must be a live window and defaults to the selected one.
1690 Return height of current line if LINE is omitted or nil. Return height of
1691 header or mode line if LINE is `header-line' or `mode-line'.
1692 Otherwise, LINE is a text line number starting from 0. A negative number
1693 counts from the end of the window.
1695 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
1696 in pixels of the visible part of the line, VPOS and YPOS are the
1697 vertical position in lines and pixels of the line, relative to the top
1698 of the first text line, and OFFBOT is the number of off-window pixels at
1699 the bottom of the text line. If there are off-window pixels at the top
1700 of the (first) text line, YPOS is negative.
1702 Return nil if window display is not up-to-date. In that case, use
1703 `pos-visible-in-window-p' to obtain the information. */)
1704 (Lisp_Object line, Lisp_Object window)
1706 register struct window *w;
1707 register struct buffer *b;
1708 struct glyph_row *row, *end_row;
1709 int max_y, crop, i;
1710 EMACS_INT n;
1712 w = decode_live_window (window);
1714 if (noninteractive || w->pseudo_window_p)
1715 return Qnil;
1717 CHECK_BUFFER (w->contents);
1718 b = XBUFFER (w->contents);
1720 /* Fail if current matrix is not up-to-date. */
1721 if (!w->window_end_valid
1722 || windows_or_buffers_changed
1723 || b->clip_changed
1724 || b->prevent_redisplay_optimizations_p
1725 || w->last_modified < BUF_MODIFF (b)
1726 || w->last_overlay_modified < BUF_OVERLAY_MODIFF (b))
1727 return Qnil;
1729 if (NILP (line))
1731 i = w->cursor.vpos;
1732 if (i < 0 || i >= w->current_matrix->nrows
1733 || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
1734 return Qnil;
1735 max_y = window_text_bottom_y (w);
1736 goto found_row;
1739 if (EQ (line, Qheader_line))
1741 if (!WINDOW_WANTS_HEADER_LINE_P (w))
1742 return Qnil;
1743 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
1744 return row->enabled_p ? list4i (row->height, 0, 0, 0) : Qnil;
1747 if (EQ (line, Qmode_line))
1749 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
1750 return (row->enabled_p ?
1751 list4i (row->height,
1752 0, /* not accurate */
1753 (WINDOW_HEADER_LINE_HEIGHT (w)
1754 + window_text_bottom_y (w)),
1756 : Qnil);
1759 CHECK_NUMBER (line);
1760 n = XINT (line);
1762 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
1763 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
1764 max_y = window_text_bottom_y (w);
1765 i = 0;
1767 while ((n < 0 || i < n)
1768 && row <= end_row && row->enabled_p
1769 && row->y + row->height < max_y)
1770 row++, i++;
1772 if (row > end_row || !row->enabled_p)
1773 return Qnil;
1775 if (++n < 0)
1777 if (-n > i)
1778 return Qnil;
1779 row += n;
1780 i += n;
1783 found_row:
1784 crop = max (0, (row->y + row->height) - max_y);
1785 return list4i (row->height + min (0, row->y) - crop, i, row->y, crop);
1788 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1789 0, 1, 0,
1790 doc: /* Return non-nil when WINDOW is dedicated to its buffer.
1791 More precisely, return the value assigned by the last call of
1792 `set-window-dedicated-p' for WINDOW. Return nil if that function was
1793 never called with WINDOW as its argument, or the value set by that
1794 function was internally reset since its last call. WINDOW must be a
1795 live window and defaults to the selected one.
1797 When a window is dedicated to its buffer, `display-buffer' will refrain
1798 from displaying another buffer in it. `get-lru-window' and
1799 `get-largest-window' treat dedicated windows specially.
1800 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1801 `kill-buffer' can delete a dedicated window and the containing frame.
1803 Functions like `set-window-buffer' may change the buffer displayed by a
1804 window, unless that window is "strongly" dedicated to its buffer, that
1805 is the value returned by `window-dedicated-p' is t. */)
1806 (Lisp_Object window)
1808 return decode_live_window (window)->dedicated;
1811 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1812 Sset_window_dedicated_p, 2, 2, 0,
1813 doc: /* Mark WINDOW as dedicated according to FLAG.
1814 WINDOW must be a live window and defaults to the selected one. FLAG
1815 non-nil means mark WINDOW as dedicated to its buffer. FLAG nil means
1816 mark WINDOW as non-dedicated. Return FLAG.
1818 When a window is dedicated to its buffer, `display-buffer' will refrain
1819 from displaying another buffer in it. `get-lru-window' and
1820 `get-largest-window' treat dedicated windows specially.
1821 `delete-windows-on', `replace-buffer-in-windows', `quit-window',
1822 `quit-restore-window' and `kill-buffer' can delete a dedicated window
1823 and the containing frame.
1825 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
1826 its buffer. Functions like `set-window-buffer' may change the buffer
1827 displayed by a window, unless that window is strongly dedicated to its
1828 buffer. If and when `set-window-buffer' displays another buffer in a
1829 window, it also makes sure that the window is no more dedicated. */)
1830 (Lisp_Object window, Lisp_Object flag)
1832 wset_dedicated (decode_live_window (window), flag);
1833 return flag;
1836 DEFUN ("window-prev-buffers", Fwindow_prev_buffers, Swindow_prev_buffers,
1837 0, 1, 0,
1838 doc: /* Return buffers previously shown in WINDOW.
1839 WINDOW must be a live window and defaults to the selected one.
1841 The return value is a list of elements (BUFFER WINDOW-START POS),
1842 where BUFFER is a buffer, WINDOW-START is the start position of the
1843 window for that buffer, and POS is a window-specific point value. */)
1844 (Lisp_Object window)
1846 return decode_live_window (window)->prev_buffers;
1849 DEFUN ("set-window-prev-buffers", Fset_window_prev_buffers,
1850 Sset_window_prev_buffers, 2, 2, 0,
1851 doc: /* Set WINDOW's previous buffers to PREV-BUFFERS.
1852 WINDOW must be a live window and defaults to the selected one.
1854 PREV-BUFFERS should be a list of elements (BUFFER WINDOW-START POS),
1855 where BUFFER is a buffer, WINDOW-START is the start position of the
1856 window for that buffer, and POS is a window-specific point value. */)
1857 (Lisp_Object window, Lisp_Object prev_buffers)
1859 wset_prev_buffers (decode_live_window (window), prev_buffers);
1860 return prev_buffers;
1863 DEFUN ("window-next-buffers", Fwindow_next_buffers, Swindow_next_buffers,
1864 0, 1, 0,
1865 doc: /* Return list of buffers recently re-shown in WINDOW.
1866 WINDOW must be a live window and defaults to the selected one. */)
1867 (Lisp_Object window)
1869 return decode_live_window (window)->next_buffers;
1872 DEFUN ("set-window-next-buffers", Fset_window_next_buffers,
1873 Sset_window_next_buffers, 2, 2, 0,
1874 doc: /* Set WINDOW's next buffers to NEXT-BUFFERS.
1875 WINDOW must be a live window and defaults to the selected one.
1876 NEXT-BUFFERS should be a list of buffers. */)
1877 (Lisp_Object window, Lisp_Object next_buffers)
1879 wset_next_buffers (decode_live_window (window), next_buffers);
1880 return next_buffers;
1883 DEFUN ("window-parameters", Fwindow_parameters, Swindow_parameters,
1884 0, 1, 0,
1885 doc: /* Return the parameters of WINDOW and their values.
1886 WINDOW must be a valid window and defaults to the selected one. The
1887 return value is a list of elements of the form (PARAMETER . VALUE). */)
1888 (Lisp_Object window)
1890 return Fcopy_alist (decode_valid_window (window)->window_parameters);
1893 DEFUN ("window-parameter", Fwindow_parameter, Swindow_parameter,
1894 2, 2, 0,
1895 doc: /* Return WINDOW's value for PARAMETER.
1896 WINDOW can be any window and defaults to the selected one. */)
1897 (Lisp_Object window, Lisp_Object parameter)
1899 Lisp_Object result;
1901 result = Fassq (parameter, decode_any_window (window)->window_parameters);
1902 return CDR_SAFE (result);
1905 DEFUN ("set-window-parameter", Fset_window_parameter,
1906 Sset_window_parameter, 3, 3, 0,
1907 doc: /* Set WINDOW's value of PARAMETER to VALUE.
1908 WINDOW can be any window and defaults to the selected one.
1909 Return VALUE. */)
1910 (Lisp_Object window, Lisp_Object parameter, Lisp_Object value)
1912 register struct window *w = decode_any_window (window);
1913 Lisp_Object old_alist_elt;
1915 old_alist_elt = Fassq (parameter, w->window_parameters);
1916 if (NILP (old_alist_elt))
1917 wset_window_parameters
1918 (w, Fcons (Fcons (parameter, value), w->window_parameters));
1919 else
1920 Fsetcdr (old_alist_elt, value);
1921 return value;
1924 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1925 0, 1, 0,
1926 doc: /* Return the display-table that WINDOW is using.
1927 WINDOW must be a live window and defaults to the selected one. */)
1928 (Lisp_Object window)
1930 return decode_live_window (window)->display_table;
1933 /* Get the display table for use on window W. This is either W's
1934 display table or W's buffer's display table. Ignore the specified
1935 tables if they are not valid; if no valid table is specified,
1936 return 0. */
1938 struct Lisp_Char_Table *
1939 window_display_table (struct window *w)
1941 struct Lisp_Char_Table *dp = NULL;
1943 if (DISP_TABLE_P (w->display_table))
1944 dp = XCHAR_TABLE (w->display_table);
1945 else if (BUFFERP (w->contents))
1947 struct buffer *b = XBUFFER (w->contents);
1949 if (DISP_TABLE_P (BVAR (b, display_table)))
1950 dp = XCHAR_TABLE (BVAR (b, display_table));
1951 else if (DISP_TABLE_P (Vstandard_display_table))
1952 dp = XCHAR_TABLE (Vstandard_display_table);
1955 return dp;
1958 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1959 doc: /* Set WINDOW's display-table to TABLE.
1960 WINDOW must be a live window and defaults to the selected one. */)
1961 (register Lisp_Object window, Lisp_Object table)
1963 wset_display_table (decode_live_window (window), table);
1964 return table;
1967 /* Record info on buffer window W is displaying
1968 when it is about to cease to display that buffer. */
1969 static void
1970 unshow_buffer (register struct window *w)
1972 Lisp_Object buf = w->contents;
1973 struct buffer *b = XBUFFER (buf);
1975 eassert (b == XMARKER (w->pointm)->buffer);
1977 #if 0
1978 if (w == XWINDOW (selected_window)
1979 || ! EQ (buf, XWINDOW (selected_window)->contents))
1980 /* Do this except when the selected window's buffer
1981 is being removed from some other window. */
1982 #endif
1983 /* last_window_start records the start position that this buffer
1984 had in the last window to be disconnected from it.
1985 Now that this statement is unconditional,
1986 it is possible for the buffer to be displayed in the
1987 selected window, while last_window_start reflects another
1988 window which was recently showing the same buffer.
1989 Some people might say that might be a good thing. Let's see. */
1990 b->last_window_start = marker_position (w->start);
1992 /* Point in the selected window's buffer
1993 is actually stored in that buffer, and the window's pointm isn't used.
1994 So don't clobber point in that buffer. */
1995 if (! EQ (buf, XWINDOW (selected_window)->contents)
1996 /* Don't clobber point in current buffer either (this could be
1997 useful in connection with bug#12208).
1998 && XBUFFER (buf) != current_buffer */
1999 /* This line helps to fix Horsley's testbug.el bug. */
2000 && !(WINDOWP (BVAR (b, last_selected_window))
2001 && w != XWINDOW (BVAR (b, last_selected_window))
2002 && EQ (buf, XWINDOW (BVAR (b, last_selected_window))->contents)))
2003 temp_set_point_both (b,
2004 clip_to_bounds (BUF_BEGV (b),
2005 marker_position (w->pointm),
2006 BUF_ZV (b)),
2007 clip_to_bounds (BUF_BEGV_BYTE (b),
2008 marker_byte_position (w->pointm),
2009 BUF_ZV_BYTE (b)));
2011 if (WINDOWP (BVAR (b, last_selected_window))
2012 && w == XWINDOW (BVAR (b, last_selected_window)))
2013 bset_last_selected_window (b, Qnil);
2016 /* Put NEW into the window structure in place of OLD. SETFLAG zero
2017 means change window structure only. Otherwise store geometry and
2018 other settings as well. */
2019 static void
2020 replace_window (Lisp_Object old, Lisp_Object new, int setflag)
2022 register Lisp_Object tem;
2023 register struct window *o = XWINDOW (old), *n = XWINDOW (new);
2025 /* If OLD is its frame's root window, then NEW is the new
2026 root window for that frame. */
2027 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
2028 fset_root_window (XFRAME (o->frame), new);
2030 if (setflag)
2032 n->left_col = o->left_col;
2033 n->top_line = o->top_line;
2034 n->total_cols = o->total_cols;
2035 n->total_lines = o->total_lines;
2036 wset_normal_cols (n, o->normal_cols);
2037 wset_normal_cols (o, make_float (1.0));
2038 wset_normal_lines (n, o->normal_lines);
2039 wset_normal_lines (o, make_float (1.0));
2040 n->desired_matrix = n->current_matrix = 0;
2041 n->vscroll = 0;
2042 memset (&n->cursor, 0, sizeof (n->cursor));
2043 memset (&n->last_cursor, 0, sizeof (n->last_cursor));
2044 memset (&n->phys_cursor, 0, sizeof (n->phys_cursor));
2045 n->phys_cursor_type = -1;
2046 n->phys_cursor_width = -1;
2047 n->must_be_updated_p = 0;
2048 n->pseudo_window_p = 0;
2049 wset_window_end_vpos (n, make_number (0));
2050 wset_window_end_pos (n, make_number (0));
2051 n->window_end_valid = 0;
2052 n->frozen_window_start_p = 0;
2055 tem = o->next;
2056 wset_next (n, tem);
2057 if (!NILP (tem))
2058 wset_prev (XWINDOW (tem), new);
2060 tem = o->prev;
2061 wset_prev (n, tem);
2062 if (!NILP (tem))
2063 wset_next (XWINDOW (tem), new);
2065 tem = o->parent;
2066 wset_parent (n, tem);
2067 if (!NILP (tem) && EQ (XWINDOW (tem)->contents, old))
2068 wset_combination (XWINDOW (tem), XWINDOW (tem)->horizontal, new);
2071 /* If window WINDOW and its parent window are iso-combined, merge
2072 WINDOW's children into those of its parent window and mark WINDOW as
2073 deleted. */
2075 static void
2076 recombine_windows (Lisp_Object window)
2078 struct window *w, *p, *c;
2079 Lisp_Object parent, child;
2080 bool horflag;
2082 w = XWINDOW (window);
2083 parent = w->parent;
2084 if (!NILP (parent) && NILP (w->combination_limit))
2086 p = XWINDOW (parent);
2087 if (WINDOWP (p->contents) && WINDOWP (w->contents)
2088 && p->horizontal == w->horizontal)
2089 /* WINDOW and PARENT are both either a vertical or a horizontal
2090 combination. */
2092 horflag = WINDOW_HORIZONTAL_COMBINATION_P (w);
2093 child = w->contents;
2094 c = XWINDOW (child);
2096 /* Splice WINDOW's children into its parent's children and
2097 assign new normal sizes. */
2098 if (NILP (w->prev))
2099 wset_combination (p, horflag, child);
2100 else
2102 wset_prev (c, w->prev);
2103 wset_next (XWINDOW (w->prev), child);
2106 while (c)
2108 wset_parent (c, parent);
2110 if (horflag)
2111 wset_normal_cols (c,
2112 make_float ((double) c->total_cols
2113 / (double) p->total_cols));
2114 else
2115 wset_normal_lines (c,
2116 make_float ((double) c->total_lines
2117 / (double) p->total_lines));
2119 if (NILP (c->next))
2121 if (!NILP (w->next))
2123 wset_next (c, w->next);
2124 wset_prev (XWINDOW (c->next), child);
2127 c = 0;
2129 else
2131 child = c->next;
2132 c = XWINDOW (child);
2136 /* WINDOW can be deleted now. */
2137 wset_combination (w, 0, Qnil);
2142 /* If WINDOW can be deleted, delete it. */
2143 static void
2144 delete_deletable_window (Lisp_Object window)
2146 if (!NILP (call1 (Qwindow_deletable_p, window)))
2147 call1 (Qdelete_window, window);
2150 /***********************************************************************
2151 Window List
2152 ***********************************************************************/
2154 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
2155 pointer. This is a callback function for foreach_window, used in
2156 the window_list function. */
2158 static int
2159 add_window_to_list (struct window *w, void *user_data)
2161 Lisp_Object *list = (Lisp_Object *) user_data;
2162 Lisp_Object window;
2163 XSETWINDOW (window, w);
2164 *list = Fcons (window, *list);
2165 return 1;
2169 /* Return a list of all windows, for use by next_window. If
2170 Vwindow_list is a list, return that list. Otherwise, build a new
2171 list, cache it in Vwindow_list, and return that. */
2173 static Lisp_Object
2174 window_list (void)
2176 if (!CONSP (Vwindow_list))
2178 Lisp_Object tail, frame;
2180 Vwindow_list = Qnil;
2181 FOR_EACH_FRAME (tail, frame)
2183 Lisp_Object args[2];
2185 /* We are visiting windows in canonical order, and add
2186 new windows at the front of args[1], which means we
2187 have to reverse this list at the end. */
2188 args[1] = Qnil;
2189 foreach_window (XFRAME (frame), add_window_to_list, &args[1]);
2190 args[0] = Vwindow_list;
2191 args[1] = Fnreverse (args[1]);
2192 Vwindow_list = Fnconc (2, args);
2196 return Vwindow_list;
2200 /* Value is non-zero if WINDOW satisfies the constraints given by
2201 OWINDOW, MINIBUF and ALL_FRAMES.
2203 MINIBUF t means WINDOW may be minibuffer windows.
2204 `lambda' means WINDOW may not be a minibuffer window.
2205 a window means a specific minibuffer window
2207 ALL_FRAMES t means search all frames,
2208 nil means search just current frame,
2209 `visible' means search just visible frames on the
2210 current terminal,
2211 0 means search visible and iconified frames on the
2212 current terminal,
2213 a window means search the frame that window belongs to,
2214 a frame means consider windows on that frame, only. */
2216 static int
2217 candidate_window_p (Lisp_Object window, Lisp_Object owindow, Lisp_Object minibuf, Lisp_Object all_frames)
2219 struct window *w = XWINDOW (window);
2220 struct frame *f = XFRAME (w->frame);
2221 int candidate_p = 1;
2223 if (!BUFFERP (w->contents))
2224 candidate_p = 0;
2225 else if (MINI_WINDOW_P (w)
2226 && (EQ (minibuf, Qlambda)
2227 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
2229 /* If MINIBUF is `lambda' don't consider any mini-windows.
2230 If it is a window, consider only that one. */
2231 candidate_p = 0;
2233 else if (EQ (all_frames, Qt))
2234 candidate_p = 1;
2235 else if (NILP (all_frames))
2237 eassert (WINDOWP (owindow));
2238 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
2240 else if (EQ (all_frames, Qvisible))
2242 candidate_p = FRAME_VISIBLE_P (f)
2243 && (FRAME_TERMINAL (XFRAME (w->frame))
2244 == FRAME_TERMINAL (XFRAME (selected_frame)));
2247 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
2249 candidate_p = (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)
2250 #ifdef HAVE_X_WINDOWS
2251 /* Yuck!! If we've just created the frame and the
2252 window-manager requested the user to place it
2253 manually, the window may still not be considered
2254 `visible'. I'd argue it should be at least
2255 something like `iconified', but don't know how to do
2256 that yet. --Stef */
2257 || (FRAME_X_P (f) && f->output_data.x->asked_for_visible
2258 && !f->output_data.x->has_been_visible)
2259 #endif
2261 && (FRAME_TERMINAL (XFRAME (w->frame))
2262 == FRAME_TERMINAL (XFRAME (selected_frame)));
2264 else if (WINDOWP (all_frames))
2265 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
2266 || EQ (XWINDOW (all_frames)->frame, w->frame)
2267 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
2268 else if (FRAMEP (all_frames))
2269 candidate_p = EQ (all_frames, w->frame);
2271 return candidate_p;
2275 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
2276 Fwindow_list. See candidate_window_p for the meaning of WINDOW,
2277 MINIBUF, and ALL_FRAMES. */
2279 static void
2280 decode_next_window_args (Lisp_Object *window, Lisp_Object *minibuf, Lisp_Object *all_frames)
2282 struct window *w = decode_live_window (*window);
2284 XSETWINDOW (*window, w);
2285 /* MINIBUF nil may or may not include minibuffers. Decide if it
2286 does. */
2287 if (NILP (*minibuf))
2288 *minibuf = minibuf_level ? minibuf_window : Qlambda;
2289 else if (!EQ (*minibuf, Qt))
2290 *minibuf = Qlambda;
2292 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
2293 => count none of them, or a specific minibuffer window (the
2294 active one) to count. */
2296 /* ALL_FRAMES nil doesn't specify which frames to include. */
2297 if (NILP (*all_frames))
2298 *all_frames
2299 = (!EQ (*minibuf, Qlambda)
2300 ? FRAME_MINIBUF_WINDOW (XFRAME (w->frame))
2301 : Qnil);
2302 else if (EQ (*all_frames, Qvisible))
2304 else if (EQ (*all_frames, make_number (0)))
2306 else if (FRAMEP (*all_frames))
2308 else if (!EQ (*all_frames, Qt))
2309 *all_frames = Qnil;
2313 /* Return the next or previous window of WINDOW in cyclic ordering
2314 of windows. NEXT_P non-zero means return the next window. See the
2315 documentation string of next-window for the meaning of MINIBUF and
2316 ALL_FRAMES. */
2318 static Lisp_Object
2319 next_window (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames, int next_p)
2321 decode_next_window_args (&window, &minibuf, &all_frames);
2323 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
2324 return the first window on the frame. */
2325 if (FRAMEP (all_frames)
2326 && !EQ (all_frames, XWINDOW (window)->frame))
2327 return Fframe_first_window (all_frames);
2329 if (next_p)
2331 Lisp_Object list;
2333 /* Find WINDOW in the list of all windows. */
2334 list = Fmemq (window, window_list ());
2336 /* Scan forward from WINDOW to the end of the window list. */
2337 if (CONSP (list))
2338 for (list = XCDR (list); CONSP (list); list = XCDR (list))
2339 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2340 break;
2342 /* Scan from the start of the window list up to WINDOW. */
2343 if (!CONSP (list))
2344 for (list = Vwindow_list;
2345 CONSP (list) && !EQ (XCAR (list), window);
2346 list = XCDR (list))
2347 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2348 break;
2350 if (CONSP (list))
2351 window = XCAR (list);
2353 else
2355 Lisp_Object candidate, list;
2357 /* Scan through the list of windows for candidates. If there are
2358 candidate windows in front of WINDOW, the last one of these
2359 is the one we want. If there are candidates following WINDOW
2360 in the list, again the last one of these is the one we want. */
2361 candidate = Qnil;
2362 for (list = window_list (); CONSP (list); list = XCDR (list))
2364 if (EQ (XCAR (list), window))
2366 if (WINDOWP (candidate))
2367 break;
2369 else if (candidate_window_p (XCAR (list), window, minibuf,
2370 all_frames))
2371 candidate = XCAR (list);
2374 if (WINDOWP (candidate))
2375 window = candidate;
2378 return window;
2382 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
2383 doc: /* Return live window after WINDOW in the cyclic ordering of windows.
2384 WINDOW must be a live window and defaults to the selected one. The
2385 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2386 consider.
2388 MINIBUF nil or omitted means consider the minibuffer window only if the
2389 minibuffer is active. MINIBUF t means consider the minibuffer window
2390 even if the minibuffer is not active. Any other value means do not
2391 consider the minibuffer window even if the minibuffer is active.
2393 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2394 plus the minibuffer window if specified by the MINIBUF argument. If the
2395 minibuffer counts, consider all windows on all frames that share that
2396 minibuffer too. The following non-nil values of ALL-FRAMES have special
2397 meanings:
2399 - t means consider all windows on all existing frames.
2401 - `visible' means consider all windows on all visible frames.
2403 - 0 (the number zero) means consider all windows on all visible and
2404 iconified frames.
2406 - A frame means consider all windows on that frame only.
2408 Anything else means consider all windows on WINDOW's frame and no
2409 others.
2411 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2412 `next-window' to iterate through the entire cycle of acceptable
2413 windows, eventually ending up back at the window you started with.
2414 `previous-window' traverses the same cycle, in the reverse order. */)
2415 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2417 return next_window (window, minibuf, all_frames, 1);
2421 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
2422 doc: /* Return live window before WINDOW in the cyclic ordering of windows.
2423 WINDOW must be a live window and defaults to the selected one. The
2424 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2425 consider.
2427 MINIBUF nil or omitted means consider the minibuffer window only if the
2428 minibuffer is active. MINIBUF t means consider the minibuffer window
2429 even if the minibuffer is not active. Any other value means do not
2430 consider the minibuffer window even if the minibuffer is active.
2432 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2433 plus the minibuffer window if specified by the MINIBUF argument. If the
2434 minibuffer counts, consider all windows on all frames that share that
2435 minibuffer too. The following non-nil values of ALL-FRAMES have special
2436 meanings:
2438 - t means consider all windows on all existing frames.
2440 - `visible' means consider all windows on all visible frames.
2442 - 0 (the number zero) means consider all windows on all visible and
2443 iconified frames.
2445 - A frame means consider all windows on that frame only.
2447 Anything else means consider all windows on WINDOW's frame and no
2448 others.
2450 If you use consistent values for MINIBUF and ALL-FRAMES, you can
2451 use `previous-window' to iterate through the entire cycle of
2452 acceptable windows, eventually ending up back at the window you
2453 started with. `next-window' traverses the same cycle, in the
2454 reverse order. */)
2455 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2457 return next_window (window, minibuf, all_frames, 0);
2461 /* Return a list of windows in cyclic ordering. Arguments are like
2462 for `next-window'. */
2464 static Lisp_Object
2465 window_list_1 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2467 Lisp_Object tail, list, rest;
2469 decode_next_window_args (&window, &minibuf, &all_frames);
2470 list = Qnil;
2472 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
2473 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
2474 list = Fcons (XCAR (tail), list);
2476 /* Rotate the list to start with WINDOW. */
2477 list = Fnreverse (list);
2478 rest = Fmemq (window, list);
2479 if (!NILP (rest) && !EQ (rest, list))
2481 for (tail = list; !EQ (XCDR (tail), rest); tail = XCDR (tail))
2483 XSETCDR (tail, Qnil);
2484 list = nconc2 (rest, list);
2486 return list;
2490 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
2491 doc: /* Return a list of windows on FRAME, starting with WINDOW.
2492 FRAME nil or omitted means use the selected frame.
2493 WINDOW nil or omitted means use the window selected within FRAME.
2494 MINIBUF t means include the minibuffer window, even if it isn't active.
2495 MINIBUF nil or omitted means include the minibuffer window only
2496 if it's active.
2497 MINIBUF neither nil nor t means never include the minibuffer window. */)
2498 (Lisp_Object frame, Lisp_Object minibuf, Lisp_Object window)
2500 if (NILP (window))
2501 window = FRAMEP (frame) ? XFRAME (frame)->selected_window : selected_window;
2502 CHECK_WINDOW (window);
2503 if (NILP (frame))
2504 frame = selected_frame;
2506 if (!EQ (frame, XWINDOW (window)->frame))
2507 error ("Window is on a different frame");
2509 return window_list_1 (window, minibuf, frame);
2513 DEFUN ("window-list-1", Fwindow_list_1, Swindow_list_1, 0, 3, 0,
2514 doc: /* Return a list of all live windows.
2515 WINDOW specifies the first window to list and defaults to the selected
2516 window.
2518 Optional argument MINIBUF nil or omitted means consider the minibuffer
2519 window only if the minibuffer is active. MINIBUF t means consider the
2520 minibuffer window even if the minibuffer is not active. Any other value
2521 means do not consider the minibuffer window even if the minibuffer is
2522 active.
2524 Optional argument ALL-FRAMES nil or omitted means consider all windows
2525 on WINDOW's frame, plus the minibuffer window if specified by the
2526 MINIBUF argument. If the minibuffer counts, consider all windows on all
2527 frames that share that minibuffer too. The following non-nil values of
2528 ALL-FRAMES have special meanings:
2530 - t means consider all windows on all existing frames.
2532 - `visible' means consider all windows on all visible frames.
2534 - 0 (the number zero) means consider all windows on all visible and
2535 iconified frames.
2537 - A frame means consider all windows on that frame only.
2539 Anything else means consider all windows on WINDOW's frame and no
2540 others.
2542 If WINDOW is not on the list of windows returned, some other window will
2543 be listed first but no error is signaled. */)
2544 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2546 return window_list_1 (window, minibuf, all_frames);
2549 /* Look at all windows, performing an operation specified by TYPE
2550 with argument OBJ.
2551 If FRAMES is Qt, look at all frames;
2552 Qnil, look at just the selected frame;
2553 Qvisible, look at visible frames;
2554 a frame, just look at windows on that frame.
2555 If MINI is non-zero, perform the operation on minibuffer windows too. */
2557 enum window_loop
2559 WINDOW_LOOP_UNUSED,
2560 GET_BUFFER_WINDOW, /* Arg is buffer */
2561 REPLACE_BUFFER_IN_WINDOWS_SAFELY, /* Arg is buffer */
2562 REDISPLAY_BUFFER_WINDOWS, /* Arg is buffer */
2563 CHECK_ALL_WINDOWS /* Arg is ignored */
2566 static Lisp_Object
2567 window_loop (enum window_loop type, Lisp_Object obj, int mini, Lisp_Object frames)
2569 Lisp_Object window, windows, best_window, frame_arg;
2570 int frame_best_window_flag = 0;
2571 struct frame *f;
2572 struct gcpro gcpro1;
2574 /* If we're only looping through windows on a particular frame,
2575 frame points to that frame. If we're looping through windows
2576 on all frames, frame is 0. */
2577 if (FRAMEP (frames))
2578 f = XFRAME (frames);
2579 else if (NILP (frames))
2580 f = SELECTED_FRAME ();
2581 else
2582 f = NULL;
2584 if (f)
2585 frame_arg = Qlambda;
2586 else if (EQ (frames, make_number (0)))
2587 frame_arg = frames;
2588 else if (EQ (frames, Qvisible))
2589 frame_arg = frames;
2590 else
2591 frame_arg = Qt;
2593 /* frame_arg is Qlambda to stick to one frame,
2594 Qvisible to consider all visible frames,
2595 or Qt otherwise. */
2597 /* Pick a window to start with. */
2598 if (WINDOWP (obj))
2599 window = obj;
2600 else if (f)
2601 window = FRAME_SELECTED_WINDOW (f);
2602 else
2603 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2605 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
2606 GCPRO1 (windows);
2607 best_window = Qnil;
2609 for (; CONSP (windows); windows = XCDR (windows))
2611 struct window *w;
2613 window = XCAR (windows);
2614 w = XWINDOW (window);
2616 /* Note that we do not pay attention here to whether the frame
2617 is visible, since Fwindow_list skips non-visible frames if
2618 that is desired, under the control of frame_arg. */
2619 if (!MINI_WINDOW_P (w)
2620 /* For REPLACE_BUFFER_IN_WINDOWS_SAFELY, we must always
2621 consider all windows. */
2622 || type == REPLACE_BUFFER_IN_WINDOWS_SAFELY
2623 || (mini && minibuf_level > 0))
2624 switch (type)
2626 case GET_BUFFER_WINDOW:
2627 if (EQ (w->contents, obj)
2628 /* Don't find any minibuffer window except the one that
2629 is currently in use. */
2630 && (MINI_WINDOW_P (w) ? EQ (window, minibuf_window) : 1))
2632 if (EQ (window, selected_window))
2633 /* Preferably return the selected window. */
2634 RETURN_UNGCPRO (window);
2635 else if (EQ (XWINDOW (window)->frame, selected_frame)
2636 && !frame_best_window_flag)
2637 /* Prefer windows on the current frame (but don't
2638 choose another one if we have one already). */
2640 best_window = window;
2641 frame_best_window_flag = 1;
2643 else if (NILP (best_window))
2644 best_window = window;
2646 break;
2648 case REPLACE_BUFFER_IN_WINDOWS_SAFELY:
2649 /* We could simply check whether the buffer shown by window
2650 is live, and show another buffer in case it isn't. */
2651 if (EQ (w->contents, obj))
2653 /* Undedicate WINDOW. */
2654 wset_dedicated (w, Qnil);
2655 /* Make WINDOW show the buffer returned by
2656 other_buffer_safely, don't run any hooks. */
2657 set_window_buffer
2658 (window, other_buffer_safely (w->contents), 0, 0);
2659 /* If WINDOW is the selected window, make its buffer
2660 current. But do so only if the window shows the
2661 current buffer (Bug#6454). */
2662 if (EQ (window, selected_window)
2663 && XBUFFER (w->contents) == current_buffer)
2664 Fset_buffer (w->contents);
2666 break;
2668 case REDISPLAY_BUFFER_WINDOWS:
2669 if (EQ (w->contents, obj))
2671 mark_window_display_accurate (window, 0);
2672 w->update_mode_line = 1;
2673 XBUFFER (obj)->prevent_redisplay_optimizations_p = 1;
2674 ++update_mode_lines;
2675 best_window = window;
2677 break;
2679 /* Check for a leaf window that has a killed buffer
2680 or broken markers. */
2681 case CHECK_ALL_WINDOWS:
2682 if (BUFFERP (w->contents))
2684 struct buffer *b = XBUFFER (w->contents);
2686 if (!BUFFER_LIVE_P (b))
2687 emacs_abort ();
2688 if (!MARKERP (w->start) || XMARKER (w->start)->buffer != b)
2689 emacs_abort ();
2690 if (!MARKERP (w->pointm) || XMARKER (w->pointm)->buffer != b)
2691 emacs_abort ();
2693 break;
2695 case WINDOW_LOOP_UNUSED:
2696 break;
2700 UNGCPRO;
2701 return best_window;
2704 /* Used for debugging. Abort if any window has a dead buffer. */
2706 extern void check_all_windows (void) EXTERNALLY_VISIBLE;
2707 void
2708 check_all_windows (void)
2710 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2713 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 0, 2, 0,
2714 doc: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2715 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to
2716 the current buffer.
2718 The optional argument ALL-FRAMES specifies the frames to consider:
2720 - t means consider all windows on all existing frames.
2722 - `visible' means consider all windows on all visible frames.
2724 - 0 (the number zero) means consider all windows on all visible
2725 and iconified frames.
2727 - A frame means consider all windows on that frame only.
2729 Any other value of ALL-FRAMES means consider all windows on the
2730 selected frame and no others. */)
2731 (Lisp_Object buffer_or_name, Lisp_Object all_frames)
2733 Lisp_Object buffer;
2735 if (NILP (buffer_or_name))
2736 buffer = Fcurrent_buffer ();
2737 else
2738 buffer = Fget_buffer (buffer_or_name);
2740 if (BUFFERP (buffer))
2741 return window_loop (GET_BUFFER_WINDOW, buffer, 1, all_frames);
2742 else
2743 return Qnil;
2746 static Lisp_Object
2747 resize_root_window (Lisp_Object window, Lisp_Object delta, Lisp_Object horizontal, Lisp_Object ignore)
2749 return call4 (Qwindow_resize_root_window, window, delta, horizontal, ignore);
2753 DEFUN ("delete-other-windows-internal", Fdelete_other_windows_internal,
2754 Sdelete_other_windows_internal, 0, 2, "",
2755 doc: /* Make WINDOW fill its frame.
2756 Only the frame WINDOW is on is affected. WINDOW must be a valid window
2757 and defaults to the selected one.
2759 Optional argument ROOT, if non-nil, must specify an internal window such
2760 that WINDOW is in its window subtree. If this is the case, replace ROOT
2761 by WINDOW and leave alone any windows not part of ROOT's subtree.
2763 When WINDOW is live try to reduce display jumps by keeping the text
2764 previously visible in WINDOW in the same place on the frame. Doing this
2765 depends on the value of (window-start WINDOW), so if calling this
2766 function in a program gives strange scrolling, make sure the
2767 window-start value is reasonable when this function is called. */)
2768 (Lisp_Object window, Lisp_Object root)
2770 struct window *w, *r, *s;
2771 struct frame *f;
2772 Lisp_Object sibling, pwindow, swindow IF_LINT (= Qnil), delta;
2773 ptrdiff_t startpos IF_LINT (= 0), startbyte IF_LINT (= 0);
2774 int top IF_LINT (= 0), new_top, resize_failed;
2776 w = decode_valid_window (window);
2777 XSETWINDOW (window, w);
2778 f = XFRAME (w->frame);
2780 if (NILP (root))
2781 /* ROOT is the frame's root window. */
2783 root = FRAME_ROOT_WINDOW (f);
2784 r = XWINDOW (root);
2786 else
2787 /* ROOT must be an ancestor of WINDOW. */
2789 r = decode_valid_window (root);
2790 pwindow = XWINDOW (window)->parent;
2791 while (!NILP (pwindow))
2792 if (EQ (pwindow, root))
2793 break;
2794 else
2795 pwindow = XWINDOW (pwindow)->parent;
2796 if (!EQ (pwindow, root))
2797 error ("Specified root is not an ancestor of specified window");
2800 if (EQ (window, root))
2801 /* A noop. */
2802 return Qnil;
2803 /* I don't understand the "top > 0" part below. If we deal with a
2804 standalone minibuffer it would have been caught by the preceding
2805 test. */
2806 else if (MINI_WINDOW_P (w)) /* && top > 0) */
2807 error ("Can't expand minibuffer to full frame");
2809 if (BUFFERP (w->contents))
2811 startpos = marker_position (w->start);
2812 startbyte = marker_byte_position (w->start);
2813 top = WINDOW_TOP_EDGE_LINE (w)
2814 - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2815 /* Make sure WINDOW is the frame's selected window. */
2816 if (!EQ (window, FRAME_SELECTED_WINDOW (f)))
2818 if (EQ (selected_frame, w->frame))
2819 Fselect_window (window, Qnil);
2820 else
2821 fset_selected_window (f, window);
2824 else
2826 /* See if the frame's selected window is a part of the window
2827 subtree rooted at WINDOW, by finding all the selected window's
2828 parents and comparing each one with WINDOW. If it isn't we
2829 need a new selected window for this frame. */
2830 swindow = FRAME_SELECTED_WINDOW (f);
2831 while (1)
2833 pwindow = swindow;
2834 while (!NILP (pwindow) && !EQ (window, pwindow))
2835 pwindow = XWINDOW (pwindow)->parent;
2837 if (EQ (window, pwindow))
2838 /* If WINDOW is an ancestor of SWINDOW, then SWINDOW is ok
2839 as the new selected window. */
2840 break;
2841 else
2842 /* Else try the previous window of SWINDOW. */
2843 swindow = Fprevious_window (swindow, Qlambda, Qnil);
2846 if (!EQ (swindow, FRAME_SELECTED_WINDOW (f)))
2848 if (EQ (selected_frame, w->frame))
2849 Fselect_window (swindow, Qnil);
2850 else
2851 fset_selected_window (f, swindow);
2855 block_input ();
2856 if (!FRAME_INITIAL_P (f))
2858 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
2860 /* We are going to free the glyph matrices of WINDOW, and with
2861 that we might lose any information about glyph rows that have
2862 some of their glyphs highlighted in mouse face. (These rows
2863 are marked with a non-zero mouse_face_p flag.) If WINDOW
2864 indeed has some glyphs highlighted in mouse face, signal to
2865 frame's up-to-date hook that mouse highlight was overwritten,
2866 so that it will arrange for redisplaying the highlight. */
2867 if (EQ (hlinfo->mouse_face_window, window))
2869 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
2870 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
2871 hlinfo->mouse_face_window = Qnil;
2874 free_window_matrices (r);
2876 windows_or_buffers_changed++;
2877 Vwindow_list = Qnil;
2878 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
2879 resize_failed = 0;
2881 if (!WINDOW_LEAF_P (w))
2883 /* Resize child windows vertically. */
2884 XSETINT (delta, r->total_lines - w->total_lines);
2885 w->top_line = r->top_line;
2886 resize_root_window (window, delta, Qnil, Qnil);
2887 if (window_resize_check (w, 0))
2888 window_resize_apply (w, 0);
2889 else
2891 resize_root_window (window, delta, Qnil, Qt);
2892 if (window_resize_check (w, 0))
2893 window_resize_apply (w, 0);
2894 else
2895 resize_failed = 1;
2898 /* Resize child windows horizontally. */
2899 if (!resize_failed)
2901 w->left_col = r->left_col;
2902 XSETINT (delta, r->total_cols - w->total_cols);
2903 resize_root_window (window, delta, Qt, Qnil);
2904 if (window_resize_check (w, 1))
2905 window_resize_apply (w, 1);
2906 else
2908 resize_root_window (window, delta, Qt, Qt);
2909 if (window_resize_check (w, 1))
2910 window_resize_apply (w, 1);
2911 else
2912 resize_failed = 1;
2916 if (resize_failed)
2917 /* Play safe, if we still can ... */
2919 window = swindow;
2920 w = XWINDOW (window);
2924 /* Cleanly unlink WINDOW from window-tree. */
2925 if (!NILP (w->prev))
2926 /* Get SIBLING above (on the left of) WINDOW. */
2928 sibling = w->prev;
2929 s = XWINDOW (sibling);
2930 wset_next (s, w->next);
2931 if (!NILP (s->next))
2932 wset_prev (XWINDOW (s->next), sibling);
2934 else
2935 /* Get SIBLING below (on the right of) WINDOW. */
2937 sibling = w->next;
2938 s = XWINDOW (sibling);
2939 wset_prev (s, Qnil);
2940 wset_combination (XWINDOW (w->parent),
2941 XWINDOW (w->parent)->horizontal, sibling);
2944 /* Delete ROOT and all child windows of ROOT. */
2945 if (WINDOWP (r->contents))
2947 delete_all_child_windows (r->contents);
2948 wset_combination (r, 0, Qnil);
2951 replace_window (root, window, 1);
2953 /* This must become SWINDOW anyway ....... */
2954 if (BUFFERP (w->contents) && !resize_failed)
2956 /* Try to minimize scrolling, by setting the window start to the
2957 point will cause the text at the old window start to be at the
2958 same place on the frame. But don't try to do this if the
2959 window start is outside the visible portion (as might happen
2960 when the display is not current, due to typeahead). */
2961 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2962 if (new_top != top
2963 && startpos >= BUF_BEGV (XBUFFER (w->contents))
2964 && startpos <= BUF_ZV (XBUFFER (w->contents)))
2966 struct position pos;
2967 struct buffer *obuf = current_buffer;
2969 Fset_buffer (w->contents);
2970 /* This computation used to temporarily move point, but that
2971 can have unwanted side effects due to text properties. */
2972 pos = *vmotion (startpos, startbyte, -top, w);
2974 set_marker_both (w->start, w->contents, pos.bufpos, pos.bytepos);
2975 w->window_end_valid = 0;
2976 w->start_at_line_beg = (pos.bytepos == BEGV_BYTE
2977 || FETCH_BYTE (pos.bytepos - 1) == '\n');
2978 /* We need to do this, so that the window-scroll-functions
2979 get called. */
2980 w->optional_new_start = 1;
2982 set_buffer_internal (obuf);
2986 adjust_glyphs (f);
2987 unblock_input ();
2989 run_window_configuration_change_hook (f);
2991 return Qnil;
2995 void
2996 replace_buffer_in_windows (Lisp_Object buffer)
2998 call1 (Qreplace_buffer_in_windows, buffer);
3001 /* If BUFFER is shown in a window, safely replace it with some other
3002 buffer in all windows of all frames, even those on other keyboards. */
3004 void
3005 replace_buffer_in_windows_safely (Lisp_Object buffer)
3007 if (buffer_window_count (XBUFFER (buffer)))
3009 Lisp_Object tail, frame;
3011 /* A single call to window_loop won't do the job because it only
3012 considers frames on the current keyboard. So loop manually over
3013 frames, and handle each one. */
3014 FOR_EACH_FRAME (tail, frame)
3015 window_loop (REPLACE_BUFFER_IN_WINDOWS_SAFELY, buffer, 1, frame);
3019 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
3020 minimum allowable size. */
3022 void
3023 check_frame_size (FRAME_PTR frame, int *rows, int *cols)
3025 /* For height, we have to see:
3026 how many windows the frame has at minimum (one or two),
3027 and whether it has a menu bar or other special stuff at the top. */
3028 int min_height
3029 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
3030 ? MIN_SAFE_WINDOW_HEIGHT
3031 : 2 * MIN_SAFE_WINDOW_HEIGHT);
3033 if (FRAME_TOP_MARGIN (frame) > 0)
3034 min_height += FRAME_TOP_MARGIN (frame);
3036 if (*rows < min_height)
3037 *rows = min_height;
3038 if (*cols < MIN_SAFE_WINDOW_WIDTH)
3039 *cols = MIN_SAFE_WINDOW_WIDTH;
3042 /* Adjust the margins of window W if text area is too small.
3043 Return 1 if window width is ok after adjustment; 0 if window
3044 is still too narrow. */
3046 static int
3047 adjust_window_margins (struct window *w)
3049 int box_cols = (WINDOW_TOTAL_COLS (w)
3050 - WINDOW_FRINGE_COLS (w)
3051 - WINDOW_SCROLL_BAR_COLS (w));
3052 int margin_cols = (WINDOW_LEFT_MARGIN_COLS (w)
3053 + WINDOW_RIGHT_MARGIN_COLS (w));
3055 if (box_cols - margin_cols >= MIN_SAFE_WINDOW_WIDTH)
3056 return 1;
3058 if (margin_cols < 0 || box_cols < MIN_SAFE_WINDOW_WIDTH)
3059 return 0;
3061 /* Window's text area is too narrow, but reducing the window
3062 margins will fix that. */
3063 margin_cols = box_cols - MIN_SAFE_WINDOW_WIDTH;
3064 if (WINDOW_RIGHT_MARGIN_COLS (w) > 0)
3066 if (WINDOW_LEFT_MARGIN_COLS (w) > 0)
3068 wset_left_margin_cols (w, make_number (margin_cols / 2));
3069 wset_right_margin_cols (w, make_number (margin_cols / 2));
3071 else
3072 wset_right_margin_cols (w, make_number (margin_cols));
3074 else
3075 wset_left_margin_cols (w, make_number (margin_cols));
3076 return 1;
3079 /* The following three routines are needed for running a window's
3080 configuration change hook. */
3081 static void
3082 run_funs (Lisp_Object funs)
3084 for (; CONSP (funs); funs = XCDR (funs))
3085 if (!EQ (XCAR (funs), Qt))
3086 call0 (XCAR (funs));
3089 static Lisp_Object
3090 select_window_norecord (Lisp_Object window)
3092 return WINDOW_LIVE_P (window)
3093 ? Fselect_window (window, Qt) : selected_window;
3096 static Lisp_Object
3097 select_frame_norecord (Lisp_Object frame)
3099 return FRAME_LIVE_P (XFRAME (frame))
3100 ? Fselect_frame (frame, Qt) : selected_frame;
3103 void
3104 run_window_configuration_change_hook (struct frame *f)
3106 ptrdiff_t count = SPECPDL_INDEX ();
3107 Lisp_Object frame, global_wcch
3108 = Fdefault_value (Qwindow_configuration_change_hook);
3109 XSETFRAME (frame, f);
3111 if (NILP (Vrun_hooks) || !NILP (inhibit_lisp_code))
3112 return;
3114 /* Use the right buffer. Matters when running the local hooks. */
3115 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
3117 record_unwind_current_buffer ();
3118 Fset_buffer (Fwindow_buffer (Qnil));
3121 if (SELECTED_FRAME () != f)
3123 record_unwind_protect (select_frame_norecord, Fselected_frame ());
3124 select_frame_norecord (frame);
3127 /* Look for buffer-local values. */
3129 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
3130 for (; CONSP (windows); windows = XCDR (windows))
3132 Lisp_Object window = XCAR (windows);
3133 Lisp_Object buffer = Fwindow_buffer (window);
3134 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
3135 buffer)))
3137 ptrdiff_t inner_count = SPECPDL_INDEX ();
3138 record_unwind_protect (select_window_norecord, Fselected_window ());
3139 select_window_norecord (window);
3140 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
3141 buffer));
3142 unbind_to (inner_count, Qnil);
3147 run_funs (global_wcch);
3148 unbind_to (count, Qnil);
3151 DEFUN ("run-window-configuration-change-hook", Frun_window_configuration_change_hook,
3152 Srun_window_configuration_change_hook, 0, 1, 0,
3153 doc: /* Run `window-configuration-change-hook' for FRAME.
3154 If FRAME is omitted or nil, it defaults to the selected frame. */)
3155 (Lisp_Object frame)
3157 run_window_configuration_change_hook (decode_live_frame (frame));
3158 return Qnil;
3161 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
3162 means it's allowed to run hooks. See make_frame for a case where
3163 it's not allowed. KEEP_MARGINS_P non-zero means that the current
3164 margins, fringes, and scroll-bar settings of the window are not
3165 reset from the buffer's local settings. */
3167 void
3168 set_window_buffer (Lisp_Object window, Lisp_Object buffer,
3169 bool run_hooks_p, bool keep_margins_p)
3171 struct window *w = XWINDOW (window);
3172 struct buffer *b = XBUFFER (buffer);
3173 ptrdiff_t count = SPECPDL_INDEX ();
3174 int samebuf = EQ (buffer, w->contents);
3176 wset_buffer (w, buffer);
3178 if (EQ (window, selected_window))
3179 bset_last_selected_window (b, window);
3181 /* Let redisplay errors through. */
3182 b->display_error_modiff = 0;
3184 /* Update time stamps of buffer display. */
3185 if (INTEGERP (BVAR (b, display_count)))
3186 bset_display_count (b, make_number (XINT (BVAR (b, display_count)) + 1));
3187 bset_display_time (b, Fcurrent_time ());
3189 wset_window_end_pos (w, make_number (0));
3190 wset_window_end_vpos (w, make_number (0));
3191 memset (&w->last_cursor, 0, sizeof w->last_cursor);
3193 if (!(keep_margins_p && samebuf))
3194 { /* If we're not actually changing the buffer, don't reset hscroll and
3195 vscroll. This case happens for example when called from
3196 change_frame_size_1, where we use a dummy call to
3197 Fset_window_buffer on the frame's selected window (and no other)
3198 just in order to run window-configuration-change-hook.
3199 Resetting hscroll and vscroll here is problematic for things like
3200 image-mode and doc-view-mode since it resets the image's position
3201 whenever we resize the frame. */
3202 w->hscroll = w->min_hscroll = 0;
3203 w->vscroll = 0;
3204 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3205 set_marker_restricted (w->start,
3206 make_number (b->last_window_start),
3207 buffer);
3208 w->start_at_line_beg = 0;
3209 w->force_start = 0;
3210 w->last_modified = 0;
3211 w->last_overlay_modified = 0;
3213 /* Maybe we could move this into the `if' but it's not obviously safe and
3214 I doubt it's worth the trouble. */
3215 windows_or_buffers_changed++;
3217 /* We must select BUFFER for running the window-scroll-functions. */
3218 /* We can't check ! NILP (Vwindow_scroll_functions) here
3219 because that might itself be a local variable. */
3220 if (window_initialized)
3222 record_unwind_current_buffer ();
3223 Fset_buffer (buffer);
3226 XMARKER (w->pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3228 if (!keep_margins_p)
3230 /* Set left and right marginal area width etc. from buffer. */
3232 /* This may call adjust_window_margins three times, so
3233 temporarily disable window margins. */
3234 Lisp_Object save_left = w->left_margin_cols;
3235 Lisp_Object save_right = w->right_margin_cols;
3237 wset_left_margin_cols (w, Qnil);
3238 wset_right_margin_cols (w, Qnil);
3240 Fset_window_fringes (window,
3241 BVAR (b, left_fringe_width), BVAR (b, right_fringe_width),
3242 BVAR (b, fringes_outside_margins));
3244 Fset_window_scroll_bars (window,
3245 BVAR (b, scroll_bar_width),
3246 BVAR (b, vertical_scroll_bar_type), Qnil);
3248 wset_left_margin_cols (w, save_left);
3249 wset_right_margin_cols (w, save_right);
3251 Fset_window_margins (window,
3252 BVAR (b, left_margin_cols), BVAR (b, right_margin_cols));
3255 if (run_hooks_p)
3257 if (! NILP (Vwindow_scroll_functions))
3258 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3259 Fmarker_position (w->start));
3260 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3263 unbind_to (count, Qnil);
3266 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3267 doc: /* Make WINDOW display BUFFER-OR-NAME as its contents.
3268 WINDOW must be a live window and defaults to the selected one.
3269 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3271 Optional third argument KEEP-MARGINS non-nil means that WINDOW's current
3272 display margins, fringe widths, and scroll bar settings are preserved;
3273 the default is to reset these from the local settings for BUFFER-OR-NAME
3274 or the frame defaults. Return nil.
3276 This function throws an error when WINDOW is strongly dedicated to its
3277 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3278 already display BUFFER-OR-NAME.
3280 This function runs `window-scroll-functions' before running
3281 `window-configuration-change-hook'. */)
3282 (register Lisp_Object window, Lisp_Object buffer_or_name, Lisp_Object keep_margins)
3284 register Lisp_Object tem, buffer;
3285 register struct window *w = decode_live_window (window);
3287 XSETWINDOW (window, w);
3288 buffer = Fget_buffer (buffer_or_name);
3289 CHECK_BUFFER (buffer);
3290 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
3291 error ("Attempt to display deleted buffer");
3293 tem = w->contents;
3294 if (NILP (tem))
3295 error ("Window is deleted");
3296 else
3298 if (!EQ (tem, buffer))
3300 if (EQ (w->dedicated, Qt))
3301 /* WINDOW is strongly dedicated to its buffer, signal an
3302 error. */
3303 error ("Window is dedicated to `%s'", SDATA (BVAR (XBUFFER (tem), name)));
3304 else
3305 /* WINDOW is weakly dedicated to its buffer, reset
3306 dedication. */
3307 wset_dedicated (w, Qnil);
3309 call1 (Qrecord_window_buffer, window);
3312 unshow_buffer (w);
3315 set_window_buffer (window, buffer, 1, !NILP (keep_margins));
3317 return Qnil;
3320 static Lisp_Object
3321 display_buffer (Lisp_Object buffer, Lisp_Object not_this_window_p, Lisp_Object override_frame)
3323 return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame);
3326 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3327 0, 1, 0,
3328 doc: /* Force all windows to be updated on next redisplay.
3329 If optional arg OBJECT is a window, force redisplay of that window only.
3330 If OBJECT is a buffer or buffer name, force redisplay of all windows
3331 displaying that buffer. */)
3332 (Lisp_Object object)
3334 if (NILP (object))
3336 windows_or_buffers_changed++;
3337 update_mode_lines++;
3338 return Qt;
3341 if (WINDOWP (object))
3343 struct window *w = XWINDOW (object);
3344 mark_window_display_accurate (object, 0);
3345 w->update_mode_line = 1;
3346 if (BUFFERP (w->contents))
3347 XBUFFER (w->contents)->prevent_redisplay_optimizations_p = 1;
3348 ++update_mode_lines;
3349 return Qt;
3352 if (STRINGP (object))
3353 object = Fget_buffer (object);
3354 if (BUFFERP (object) && BUFFER_LIVE_P (XBUFFER (object))
3355 && buffer_window_count (XBUFFER (object)))
3357 /* If buffer is live and shown in at least one window, find
3358 all windows showing this buffer and force update of them. */
3359 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, 0, Qvisible);
3360 return NILP (object) ? Qnil : Qt;
3363 /* If nothing suitable was found, just return.
3364 We could signal an error, but this feature will typically be used
3365 asynchronously in timers or process sentinels, so we don't. */
3366 return Qnil;
3369 /* Obsolete since 24.3. */
3370 void
3371 temp_output_buffer_show (register Lisp_Object buf)
3373 register struct buffer *old = current_buffer;
3374 register Lisp_Object window;
3375 register struct window *w;
3377 bset_directory (XBUFFER (buf), BVAR (current_buffer, directory));
3379 Fset_buffer (buf);
3380 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3381 BEGV = BEG;
3382 ZV = Z;
3383 SET_PT (BEG);
3384 set_buffer_internal (old);
3386 if (!NILP (Vtemp_buffer_show_function))
3387 call1 (Vtemp_buffer_show_function, buf);
3388 else
3390 window = display_buffer (buf, Qnil, Qnil);
3392 if (!EQ (XWINDOW (window)->frame, selected_frame))
3393 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3394 Vminibuf_scroll_window = window;
3395 w = XWINDOW (window);
3396 w->hscroll = 0;
3397 w->min_hscroll = 0;
3398 set_marker_restricted_both (w->start, buf, BEG, BEG);
3399 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
3401 /* Run temp-buffer-show-hook, with the chosen window selected
3402 and its buffer current. */
3404 ptrdiff_t count = SPECPDL_INDEX ();
3405 Lisp_Object prev_window, prev_buffer;
3406 prev_window = selected_window;
3407 XSETBUFFER (prev_buffer, old);
3409 /* Select the window that was chosen, for running the hook.
3410 Note: Both Fselect_window and select_window_norecord may
3411 set-buffer to the buffer displayed in the window,
3412 so we need to save the current buffer. --stef */
3413 record_unwind_protect (Fset_buffer, prev_buffer);
3414 record_unwind_protect (select_window_norecord, prev_window);
3415 Fselect_window (window, Qt);
3416 Fset_buffer (w->contents);
3417 Frun_hooks (1, &Qtemp_buffer_show_hook);
3418 unbind_to (count, Qnil);
3423 /* Make new window, have it replace WINDOW in window-tree, and make
3424 WINDOW its only vertical child (HORFLAG 1 means make WINDOW its only
3425 horizontal child). */
3426 static void
3427 make_parent_window (Lisp_Object window, bool horflag)
3429 Lisp_Object parent;
3430 register struct window *o, *p;
3432 o = XWINDOW (window);
3433 p = allocate_window ();
3434 memcpy ((char *) p + sizeof (struct vectorlike_header),
3435 (char *) o + sizeof (struct vectorlike_header),
3436 word_size * VECSIZE (struct window));
3437 /* P's buffer slot may change from nil to a buffer... */
3438 adjust_window_count (p, 1);
3439 XSETWINDOW (parent, p);
3441 replace_window (window, parent, 1);
3443 wset_next (o, Qnil);
3444 wset_prev (o, Qnil);
3445 wset_parent (o, parent);
3446 /* ...but now P becomes an internal window. */
3447 wset_start (p, Qnil);
3448 wset_pointm (p, Qnil);
3449 wset_buffer (p, Qnil);
3450 wset_combination (p, horflag, window);
3451 wset_combination_limit (p, Qnil);
3452 wset_window_parameters (p, Qnil);
3455 /* Make new window from scratch. */
3456 Lisp_Object
3457 make_window (void)
3459 Lisp_Object window;
3460 register struct window *w;
3462 w = allocate_window ();
3463 /* Initialize Lisp data. Note that allocate_window initializes all
3464 Lisp data to nil, so do it only for slots which should not be nil. */
3465 wset_normal_lines (w, make_float (1.0));
3466 wset_normal_cols (w, make_float (1.0));
3467 wset_new_total (w, make_number (0));
3468 wset_new_normal (w, make_number (0));
3469 wset_start (w, Fmake_marker ());
3470 wset_pointm (w, Fmake_marker ());
3471 wset_vertical_scroll_bar_type (w, Qt);
3472 wset_window_end_pos (w, make_number (0));
3473 wset_window_end_vpos (w, make_number (0));
3474 /* These Lisp fields are marked specially so they're not set to nil by
3475 allocate_window. */
3476 wset_prev_buffers (w, Qnil);
3477 wset_next_buffers (w, Qnil);
3479 /* Initialize non-Lisp data. Note that allocate_window zeroes out all
3480 non-Lisp data, so do it only for slots which should not be zero. */
3481 w->nrows_scale_factor = w->ncols_scale_factor = 1;
3482 w->phys_cursor_type = -1;
3483 w->phys_cursor_width = -1;
3484 w->column_number_displayed = -1;
3486 /* Reset window_list. */
3487 Vwindow_list = Qnil;
3488 /* Return window. */
3489 XSETWINDOW (window, w);
3490 return window;
3493 DEFUN ("set-window-new-total", Fset_window_new_total, Sset_window_new_total, 2, 3, 0,
3494 doc: /* Set new total size of WINDOW to SIZE.
3495 WINDOW must be a valid window and defaults to the selected one.
3496 Return SIZE.
3498 Optional argument ADD non-nil means add SIZE to the new total size of
3499 WINDOW and return the sum.
3501 Note: This function does not operate on any child windows of WINDOW. */)
3502 (Lisp_Object window, Lisp_Object size, Lisp_Object add)
3504 struct window *w = decode_valid_window (window);
3506 CHECK_NUMBER (size);
3507 if (NILP (add))
3508 wset_new_total (w, size);
3509 else
3510 wset_new_total (w, make_number (XINT (w->new_total) + XINT (size)));
3512 return w->new_total;
3515 DEFUN ("set-window-new-normal", Fset_window_new_normal, Sset_window_new_normal, 1, 2, 0,
3516 doc: /* Set new normal size of WINDOW to SIZE.
3517 WINDOW must be a valid window and defaults to the selected one.
3518 Return SIZE.
3520 Note: This function does not operate on any child windows of WINDOW. */)
3521 (Lisp_Object window, Lisp_Object size)
3523 wset_new_normal (decode_valid_window (window), size);
3524 return size;
3527 /* Return 1 if setting w->total_lines (w->total_cols if HORFLAG is
3528 non-zero) to w->new_total would result in correct heights (widths)
3529 for window W and recursively all child windows of W.
3531 Note: This function does not check any of `window-fixed-size-p',
3532 `window-min-height' or `window-min-width'. It does check that window
3533 sizes do not drop below one line (two columns). */
3534 static int
3535 window_resize_check (struct window *w, bool horflag)
3537 struct window *c;
3539 if (WINDOW_VERTICAL_COMBINATION_P (w))
3540 /* W is a vertical combination. */
3542 c = XWINDOW (w->contents);
3543 if (horflag)
3544 /* All child windows of W must have the same width as W. */
3546 while (c)
3548 if ((XINT (c->new_total) != XINT (w->new_total))
3549 || !window_resize_check (c, horflag))
3550 return 0;
3551 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3553 return 1;
3555 else
3556 /* The sum of the heights of the child windows of W must equal
3557 W's height. */
3559 int sum_of_sizes = 0;
3560 while (c)
3562 if (!window_resize_check (c, horflag))
3563 return 0;
3564 sum_of_sizes = sum_of_sizes + XINT (c->new_total);
3565 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3567 return (sum_of_sizes == XINT (w->new_total));
3570 else if (WINDOW_HORIZONTAL_COMBINATION_P (w))
3571 /* W is a horizontal combination. */
3573 c = XWINDOW (w->contents);
3574 if (horflag)
3575 /* The sum of the widths of the child windows of W must equal W's
3576 width. */
3578 int sum_of_sizes = 0;
3579 while (c)
3581 if (!window_resize_check (c, horflag))
3582 return 0;
3583 sum_of_sizes = sum_of_sizes + XINT (c->new_total);
3584 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3586 return (sum_of_sizes == XINT (w->new_total));
3588 else
3589 /* All child windows of W must have the same height as W. */
3591 while (c)
3593 if ((XINT (c->new_total) != XINT (w->new_total))
3594 || !window_resize_check (c, horflag))
3595 return 0;
3596 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3598 return 1;
3601 else
3602 /* A leaf window. Make sure it's not too small. The following
3603 hardcodes the values of `window-safe-min-width' (2) and
3604 `window-safe-min-height' (1) which are defined in window.el. */
3605 return XINT (w->new_total) >= (horflag ? 2 : 1);
3608 /* Set w->total_lines (w->total_cols if HORIZONTAL is non-zero) to
3609 w->new_total for window W and recursively all child windows of W.
3610 Also calculate and assign the new vertical (horizontal) start
3611 positions of each of these windows.
3613 This function does not perform any error checks. Make sure you have
3614 run window_resize_check on W before applying this function. */
3615 static void
3616 window_resize_apply (struct window *w, bool horflag)
3618 struct window *c;
3619 int pos;
3621 /* Note: Assigning new_normal requires that the new total size of the
3622 parent window has been set *before*. */
3623 if (horflag)
3625 w->total_cols = XFASTINT (w->new_total);
3626 if (NUMBERP (w->new_normal))
3627 wset_normal_cols (w, w->new_normal);
3629 pos = w->left_col;
3631 else
3633 w->total_lines = XFASTINT (w->new_total);
3634 if (NUMBERP (w->new_normal))
3635 wset_normal_lines (w, w->new_normal);
3637 pos = w->top_line;
3640 if (WINDOW_VERTICAL_COMBINATION_P (w))
3641 /* W is a vertical combination. */
3643 c = XWINDOW (w->contents);
3644 while (c)
3646 if (horflag)
3647 c->left_col = pos;
3648 else
3649 c->top_line = pos;
3650 window_resize_apply (c, horflag);
3651 if (!horflag)
3652 pos = pos + c->total_lines;
3653 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3656 else if (WINDOW_HORIZONTAL_COMBINATION_P (w))
3657 /* W is a horizontal combination. */
3659 c = XWINDOW (w->contents);
3660 while (c)
3662 if (horflag)
3663 c->left_col = pos;
3664 else
3665 c->top_line = pos;
3666 window_resize_apply (c, horflag);
3667 if (horflag)
3668 pos = pos + c->total_cols;
3669 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3673 /* Clear out some redisplay caches. */
3674 w->last_modified = 0;
3675 w->last_overlay_modified = 0;
3679 DEFUN ("window-resize-apply", Fwindow_resize_apply, Swindow_resize_apply, 0, 2, 0,
3680 doc: /* Apply requested size values for window-tree of FRAME.
3681 If FRAME is omitted or nil, it defaults to the selected frame.
3683 Optional argument HORIZONTAL omitted or nil means apply requested
3684 height values. HORIZONTAL non-nil means apply requested width values.
3686 This function checks whether the requested values sum up to a valid
3687 window layout, recursively assigns the new sizes of all child windows
3688 and calculates and assigns the new start positions of these windows.
3690 Note: This function does not check any of `window-fixed-size-p',
3691 `window-min-height' or `window-min-width'. All these checks have to
3692 be applied on the Elisp level. */)
3693 (Lisp_Object frame, Lisp_Object horizontal)
3695 struct frame *f = decode_live_frame (frame);
3696 struct window *r = XWINDOW (FRAME_ROOT_WINDOW (f));
3697 bool horflag = !NILP (horizontal);
3699 if (!window_resize_check (r, horflag)
3700 || (XINT (r->new_total)
3701 != (horflag ? r->total_cols : r->total_lines)))
3702 return Qnil;
3704 block_input ();
3705 window_resize_apply (r, horflag);
3707 windows_or_buffers_changed++;
3708 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3710 adjust_glyphs (f);
3711 unblock_input ();
3713 run_window_configuration_change_hook (f);
3715 return Qt;
3719 /* Resize frame F's windows when number of lines of F is set to SIZE.
3720 HORFLAG 1 means resize windows when number of columns of F is set to
3721 SIZE.
3723 This function can delete all windows but the selected one in order to
3724 satisfy the request. The result will be meaningful if and only if
3725 F's windows have meaningful sizes when you call this. */
3726 void
3727 resize_frame_windows (struct frame *f, int size, bool horflag)
3729 Lisp_Object root = f->root_window;
3730 struct window *r = XWINDOW (root);
3731 Lisp_Object mini = f->minibuffer_window;
3732 struct window *m;
3733 /* new_size is the new size of the frame's root window. */
3734 int new_size = (horflag
3735 ? size
3736 : (size
3737 - FRAME_TOP_MARGIN (f)
3738 - ((FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
3739 ? 1 : 0)));
3741 r->top_line = FRAME_TOP_MARGIN (f);
3742 if (WINDOW_LEAF_P (r))
3743 /* For a leaf root window just set the size. */
3744 if (horflag)
3745 r->total_cols = new_size;
3746 else
3747 r->total_lines = new_size;
3748 else
3750 /* old_size is the old size of the frame's root window. */
3751 int old_size = horflag ? r->total_cols : r->total_lines;
3752 Lisp_Object delta;
3754 XSETINT (delta, new_size - old_size);
3755 /* Try a "normal" resize first. */
3756 resize_root_window (root, delta, horflag ? Qt : Qnil, Qnil);
3757 if (window_resize_check (r, horflag)
3758 && new_size == XINT (r->new_total))
3759 window_resize_apply (r, horflag);
3760 else
3762 /* Try with "reasonable" minimum sizes next. */
3763 resize_root_window (root, delta, horflag ? Qt : Qnil, Qt);
3764 if (window_resize_check (r, horflag)
3765 && new_size == XINT (r->new_total))
3766 window_resize_apply (r, horflag);
3767 else
3769 /* Finally, try with "safe" minimum sizes. */
3770 resize_root_window (root, delta, horflag ? Qt : Qnil, Qsafe);
3771 if (window_resize_check (r, horflag)
3772 && new_size == XINT (r->new_total))
3773 window_resize_apply (r, horflag);
3774 else
3776 /* We lost. Delete all windows but the frame's
3777 selected one. */
3778 root = f->selected_window;
3779 Fdelete_other_windows_internal (root, Qnil);
3780 if (horflag)
3781 XWINDOW (root)->total_cols = new_size;
3782 else
3783 XWINDOW (root)->total_lines = new_size;
3789 if (FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
3791 m = XWINDOW (mini);
3792 if (horflag)
3793 m->total_cols = size;
3794 else
3796 /* Are we sure we always want 1 line here? */
3797 m->total_lines = 1;
3798 m->top_line = r->top_line + r->total_lines;
3802 windows_or_buffers_changed++;
3806 DEFUN ("split-window-internal", Fsplit_window_internal, Ssplit_window_internal, 4, 4, 0,
3807 doc: /* Split window OLD.
3808 Second argument TOTAL-SIZE specifies the number of lines or columns of the
3809 new window. In any case TOTAL-SIZE must be a positive integer.
3811 Third argument SIDE nil (or `below') specifies that the new window shall
3812 be located below WINDOW. SIDE `above' means the new window shall be
3813 located above WINDOW. In both cases TOTAL-SIZE specifies the number of
3814 lines of the new window including space reserved for the mode and/or
3815 header line.
3817 SIDE t (or `right') specifies that the new window shall be located on
3818 the right side of WINDOW. SIDE `left' means the new window shall be
3819 located on the left of WINDOW. In both cases TOTAL-SIZE specifies the
3820 number of columns of the new window including space reserved for fringes
3821 and the scrollbar or a divider column.
3823 Fourth argument NORMAL-SIZE specifies the normal size of the new window
3824 according to the SIDE argument.
3826 The new total and normal sizes of all involved windows must have been
3827 set correctly. See the code of `split-window' for how this is done. */)
3828 (Lisp_Object old, Lisp_Object total_size, Lisp_Object side, Lisp_Object normal_size)
3830 /* OLD (*o) is the window we have to split. (*p) is either OLD's
3831 parent window or an internal window we have to install as OLD's new
3832 parent. REFERENCE (*r) must denote a live window, or is set to OLD
3833 provided OLD is a leaf window, or to the frame's selected window.
3834 NEW (*n) is the new window created with some parameters taken from
3835 REFERENCE (*r). */
3836 register Lisp_Object new, frame, reference;
3837 register struct window *o, *p, *n, *r;
3838 struct frame *f;
3839 bool horflag
3840 /* HORFLAG is 1 when we split side-by-side, 0 otherwise. */
3841 = EQ (side, Qt) || EQ (side, Qleft) || EQ (side, Qright);
3842 int combination_limit = 0;
3844 CHECK_WINDOW (old);
3845 o = XWINDOW (old);
3846 frame = WINDOW_FRAME (o);
3847 f = XFRAME (frame);
3849 CHECK_NUMBER (total_size);
3851 /* Set combination_limit to 1 if we have to make a new parent window.
3852 We do that if either `window-combination-limit' is t, or OLD has no
3853 parent, or OLD is ortho-combined. */
3854 combination_limit =
3855 EQ (Vwindow_combination_limit, Qt)
3856 || NILP (o->parent)
3857 || (horflag
3858 ? WINDOW_VERTICAL_COMBINATION_P (XWINDOW (o->parent))
3859 : WINDOW_HORIZONTAL_COMBINATION_P (XWINDOW (o->parent)));
3861 /* We need a live reference window to initialize some parameters. */
3862 if (WINDOW_LIVE_P (old))
3863 /* OLD is live, use it as reference window. */
3864 reference = old;
3865 else
3866 /* Use the frame's selected window as reference window. */
3867 reference = FRAME_SELECTED_WINDOW (f);
3868 r = XWINDOW (reference);
3870 /* The following bugs are caught by `split-window'. */
3871 if (MINI_WINDOW_P (o))
3872 error ("Attempt to split minibuffer window");
3873 else if (XINT (total_size) < (horflag ? 2 : 1))
3874 error ("Size of new window too small (after split)");
3875 else if (!combination_limit && !NILP (Vwindow_combination_resize))
3876 /* `window-combination-resize' non-nil means try to resize OLD's siblings
3877 proportionally. */
3879 p = XWINDOW (o->parent);
3880 /* Temporarily pretend we split the parent window. */
3881 wset_new_total
3882 (p, make_number ((horflag ? p->total_cols : p->total_lines)
3883 - XINT (total_size)));
3884 if (!window_resize_check (p, horflag))
3885 error ("Window sizes don't fit");
3886 else
3887 /* Undo the temporary pretension. */
3888 wset_new_total (p, make_number
3889 (horflag ? p->total_cols : p->total_lines));
3891 else
3893 if (!window_resize_check (o, horflag))
3894 error ("Resizing old window failed");
3895 else if (XINT (total_size) + XINT (o->new_total)
3896 != (horflag ? o->total_cols : o->total_lines))
3897 error ("Sum of sizes of old and new window don't fit");
3900 /* This is our point of no return. */
3901 if (combination_limit)
3903 /* Save the old value of o->normal_cols/lines. It gets corrupted
3904 by make_parent_window and we need it below for assigning it to
3905 p->new_normal. */
3906 Lisp_Object new_normal
3907 = horflag ? o->normal_cols : o->normal_lines;
3909 make_parent_window (old, horflag);
3910 p = XWINDOW (o->parent);
3911 if (EQ (Vwindow_combination_limit, Qt))
3912 /* Store t in the new parent's combination_limit slot to avoid
3913 that its children get merged into another window. */
3914 wset_combination_limit (p, Qt);
3915 /* These get applied below. */
3916 wset_new_total (p, make_number
3917 (horflag ? o->total_cols : o->total_lines));
3918 wset_new_normal (p, new_normal);
3920 else
3921 p = XWINDOW (o->parent);
3923 windows_or_buffers_changed++;
3924 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3925 new = make_window ();
3926 n = XWINDOW (new);
3927 wset_frame (n, frame);
3928 wset_parent (n, o->parent);
3930 if (EQ (side, Qabove) || EQ (side, Qleft))
3932 wset_prev (n, o->prev);
3933 if (NILP (n->prev))
3934 wset_combination (p, horflag, new);
3935 else
3936 wset_next (XWINDOW (n->prev), new);
3937 wset_next (n, old);
3938 wset_prev (o, new);
3940 else
3942 wset_next (n, o->next);
3943 if (!NILP (n->next))
3944 wset_prev (XWINDOW (n->next), new);
3945 wset_prev (n, old);
3946 wset_next (o, new);
3949 n->window_end_valid = 0;
3950 memset (&n->last_cursor, 0, sizeof n->last_cursor);
3952 /* Get special geometry settings from reference window. */
3953 wset_left_margin_cols (n, r->left_margin_cols);
3954 wset_right_margin_cols (n, r->right_margin_cols);
3955 wset_left_fringe_width (n, r->left_fringe_width);
3956 wset_right_fringe_width (n, r->right_fringe_width);
3957 n->fringes_outside_margins = r->fringes_outside_margins;
3958 wset_scroll_bar_width (n, r->scroll_bar_width);
3959 wset_vertical_scroll_bar_type (n, r->vertical_scroll_bar_type);
3961 /* Directly assign orthogonal coordinates and sizes. */
3962 if (horflag)
3964 n->top_line = o->top_line;
3965 n->total_lines = o->total_lines;
3967 else
3969 n->left_col = o->left_col;
3970 n->total_cols = o->total_cols;
3973 /* Iso-coordinates and sizes are assigned by window_resize_apply,
3974 get them ready here. */
3975 wset_new_total (n, total_size);
3976 wset_new_normal (n, normal_size);
3978 block_input ();
3979 window_resize_apply (p, horflag);
3980 adjust_glyphs (f);
3981 /* Set buffer of NEW to buffer of reference window. Don't run
3982 any hooks. */
3983 set_window_buffer (new, r->contents, 0, 1);
3984 unblock_input ();
3986 /* Maybe we should run the scroll functions in Elisp (which already
3987 runs the configuration change hook). */
3988 if (! NILP (Vwindow_scroll_functions))
3989 run_hook_with_args_2 (Qwindow_scroll_functions, new,
3990 Fmarker_position (n->start));
3991 /* Return NEW. */
3992 return new;
3996 DEFUN ("delete-window-internal", Fdelete_window_internal, Sdelete_window_internal, 1, 1, 0,
3997 doc: /* Remove WINDOW from its frame.
3998 WINDOW defaults to the selected window. Return nil.
3999 Signal an error when WINDOW is the only window on its frame. */)
4000 (register Lisp_Object window)
4002 register Lisp_Object parent, sibling, frame, root;
4003 struct window *w, *p, *s, *r;
4004 struct frame *f;
4005 bool horflag, before_sibling = 0;
4007 w = decode_any_window (window);
4008 XSETWINDOW (window, w);
4009 if (NILP (w->contents))
4010 /* It's a no-op to delete an already deleted window. */
4011 return Qnil;
4013 parent = w->parent;
4014 if (NILP (parent))
4015 /* Never delete a minibuffer or frame root window. */
4016 error ("Attempt to delete minibuffer or sole ordinary window");
4017 else if (NILP (w->prev) && NILP (w->next))
4018 /* Rather bow out here, this case should be handled on the Elisp
4019 level. */
4020 error ("Attempt to delete sole window of parent");
4022 p = XWINDOW (parent);
4023 horflag = WINDOW_HORIZONTAL_COMBINATION_P (p);
4025 frame = WINDOW_FRAME (w);
4026 f = XFRAME (frame);
4028 root = FRAME_ROOT_WINDOW (f);
4029 r = XWINDOW (root);
4031 /* Unlink WINDOW from window tree. */
4032 if (NILP (w->prev))
4033 /* Get SIBLING below (on the right of) WINDOW. */
4035 /* before_sibling 1 means WINDOW is the first child of its
4036 parent and thus before the sibling. */
4037 before_sibling = 1;
4038 sibling = w->next;
4039 s = XWINDOW (sibling);
4040 wset_prev (s, Qnil);
4041 wset_combination (p, horflag, sibling);
4043 else
4044 /* Get SIBLING above (on the left of) WINDOW. */
4046 sibling = w->prev;
4047 s = XWINDOW (sibling);
4048 wset_next (s, w->next);
4049 if (!NILP (s->next))
4050 wset_prev (XWINDOW (s->next), sibling);
4053 if (window_resize_check (r, horflag)
4054 && (XINT (r->new_total)
4055 == (horflag ? r->total_cols : r->total_lines)))
4056 /* We can delete WINDOW now. */
4059 /* Block input. */
4060 block_input ();
4061 window_resize_apply (p, horflag);
4063 /* If this window is referred to by the dpyinfo's mouse
4064 highlight, invalidate that slot to be safe (Bug#9904). */
4065 if (!FRAME_INITIAL_P (f))
4067 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
4069 if (EQ (hlinfo->mouse_face_window, window))
4070 hlinfo->mouse_face_window = Qnil;
4073 windows_or_buffers_changed++;
4074 Vwindow_list = Qnil;
4075 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4077 wset_next (w, Qnil); /* Don't delete w->next too. */
4078 free_window_matrices (w);
4080 if (WINDOWP (w->contents))
4082 delete_all_child_windows (w->contents);
4083 wset_combination (w, 0, Qnil);
4085 else
4087 unshow_buffer (w);
4088 unchain_marker (XMARKER (w->pointm));
4089 unchain_marker (XMARKER (w->start));
4090 wset_buffer (w, Qnil);
4093 if (NILP (s->prev) && NILP (s->next))
4094 /* A matrjoshka where SIBLING has become the only child of
4095 PARENT. */
4097 /* Put SIBLING into PARENT's place. */
4098 replace_window (parent, sibling, 0);
4099 /* Have SIBLING inherit the following three slot values from
4100 PARENT (the combination_limit slot is not inherited). */
4101 wset_normal_cols (s, p->normal_cols);
4102 wset_normal_lines (s, p->normal_lines);
4103 /* Mark PARENT as deleted. */
4104 wset_combination (p, 0, Qnil);
4105 /* Try to merge SIBLING into its new parent. */
4106 recombine_windows (sibling);
4109 adjust_glyphs (f);
4111 if (!WINDOW_LIVE_P (FRAME_SELECTED_WINDOW (f)))
4112 /* We deleted the frame's selected window. */
4114 /* Use the frame's first window as fallback ... */
4115 Lisp_Object new_selected_window = Fframe_first_window (frame);
4116 /* ... but preferably use its most recently used window. */
4117 Lisp_Object mru_window;
4119 /* `get-mru-window' might fail for some reason so play it safe
4120 - promote the first window _without recording it_ first. */
4121 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
4122 Fselect_window (new_selected_window, Qt);
4123 else
4124 fset_selected_window (f, new_selected_window);
4126 unblock_input ();
4128 /* Now look whether `get-mru-window' gets us something. */
4129 mru_window = call1 (Qget_mru_window, frame);
4130 if (WINDOW_LIVE_P (mru_window)
4131 && EQ (XWINDOW (mru_window)->frame, frame))
4132 new_selected_window = mru_window;
4134 /* If all ended up well, we now promote the mru window. */
4135 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
4136 Fselect_window (new_selected_window, Qnil);
4137 else
4138 fset_selected_window (f, new_selected_window);
4140 else
4141 unblock_input ();
4143 /* Must be run by the caller:
4144 run_window_configuration_change_hook (f); */
4146 else
4147 /* We failed: Relink WINDOW into window tree. */
4149 if (before_sibling)
4151 wset_prev (s, window);
4152 wset_combination (p, horflag, window);
4154 else
4156 wset_next (s, window);
4157 if (!NILP (w->next))
4158 wset_prev (XWINDOW (w->next), window);
4160 error ("Deletion failed");
4163 return Qnil;
4166 /***********************************************************************
4167 Resizing Mini-Windows
4168 ***********************************************************************/
4170 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we
4171 can. */
4172 void
4173 grow_mini_window (struct window *w, int delta)
4175 struct frame *f = XFRAME (w->frame);
4176 struct window *r;
4177 Lisp_Object root, value;
4179 eassert (MINI_WINDOW_P (w));
4180 eassert (delta >= 0);
4182 root = FRAME_ROOT_WINDOW (f);
4183 r = XWINDOW (root);
4184 value = call2 (Qwindow_resize_root_window_vertically,
4185 root, make_number (- delta));
4186 if (INTEGERP (value) && window_resize_check (r, 0))
4188 block_input ();
4189 window_resize_apply (r, 0);
4191 /* Grow the mini-window. */
4192 w->top_line = r->top_line + r->total_lines;
4193 w->total_lines -= XINT (value);
4194 w->last_modified = 0;
4195 w->last_overlay_modified = 0;
4197 windows_or_buffers_changed++;
4198 adjust_glyphs (f);
4199 unblock_input ();
4204 /* Shrink mini-window W. */
4205 void
4206 shrink_mini_window (struct window *w)
4208 struct frame *f = XFRAME (w->frame);
4209 struct window *r;
4210 Lisp_Object root, value;
4211 EMACS_INT size;
4213 eassert (MINI_WINDOW_P (w));
4215 size = w->total_lines;
4216 if (size > 1)
4218 root = FRAME_ROOT_WINDOW (f);
4219 r = XWINDOW (root);
4220 value = call2 (Qwindow_resize_root_window_vertically,
4221 root, make_number (size - 1));
4222 if (INTEGERP (value) && window_resize_check (r, 0))
4224 block_input ();
4225 window_resize_apply (r, 0);
4227 /* Shrink the mini-window. */
4228 w->top_line = r->top_line + r->total_lines;
4229 w->total_lines = 1;
4231 w->last_modified = 0;
4232 w->last_overlay_modified = 0;
4234 windows_or_buffers_changed++;
4235 adjust_glyphs (f);
4236 unblock_input ();
4238 /* If the above failed for whatever strange reason we must make a
4239 one window frame here. The same routine will be needed when
4240 shrinking the frame (and probably when making the initial
4241 *scratch* window). For the moment leave things as they are. */
4245 DEFUN ("resize-mini-window-internal", Fresize_mini_window_internal, Sresize_mini_window_internal, 1, 1, 0,
4246 doc: /* Resize minibuffer window WINDOW. */)
4247 (Lisp_Object window)
4249 struct window *w = XWINDOW (window);
4250 struct window *r;
4251 struct frame *f;
4252 int height;
4254 CHECK_WINDOW (window);
4255 f = XFRAME (w->frame);
4257 if (!EQ (FRAME_MINIBUF_WINDOW (XFRAME (w->frame)), window))
4258 error ("Not a valid minibuffer window");
4259 else if (FRAME_MINIBUF_ONLY_P (f))
4260 error ("Cannot resize a minibuffer-only frame");
4262 r = XWINDOW (FRAME_ROOT_WINDOW (f));
4263 height = r->total_lines + w->total_lines;
4264 if (window_resize_check (r, 0)
4265 && XINT (w->new_total) > 0
4266 && height == XINT (r->new_total) + XINT (w->new_total))
4268 block_input ();
4269 window_resize_apply (r, 0);
4271 w->total_lines = XFASTINT (w->new_total);
4272 w->top_line = r->top_line + r->total_lines;
4274 windows_or_buffers_changed++;
4275 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4276 adjust_glyphs (f);
4277 unblock_input ();
4279 run_window_configuration_change_hook (f);
4280 return Qt;
4282 else error ("Failed to resize minibuffer window");
4285 /* Mark window cursors off for all windows in the window tree rooted
4286 at W by setting their phys_cursor_on_p flag to zero. Called from
4287 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4288 the frame are cleared. */
4290 void
4291 mark_window_cursors_off (struct window *w)
4293 while (w)
4295 if (WINDOWP (w->contents))
4296 mark_window_cursors_off (XWINDOW (w->contents));
4297 else
4298 w->phys_cursor_on_p = 0;
4300 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4305 /* Return number of lines of text (not counting mode lines) in W. */
4308 window_internal_height (struct window *w)
4310 int ht = w->total_lines;
4312 if (!MINI_WINDOW_P (w))
4314 if (!NILP (w->parent)
4315 || WINDOWP (w->contents)
4316 || !NILP (w->next)
4317 || !NILP (w->prev)
4318 || WINDOW_WANTS_MODELINE_P (w))
4319 --ht;
4321 if (WINDOW_WANTS_HEADER_LINE_P (w))
4322 --ht;
4325 return ht;
4328 /************************************************************************
4329 Window Scrolling
4330 ***********************************************************************/
4332 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4333 N screen-fulls, which is defined as the height of the window minus
4334 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4335 instead. Negative values of N mean scroll down. NOERROR non-zero
4336 means don't signal an error if we try to move over BEGV or ZV,
4337 respectively. */
4339 static void
4340 window_scroll (Lisp_Object window, EMACS_INT n, int whole, int noerror)
4342 immediate_quit = 1;
4343 n = clip_to_bounds (INT_MIN, n, INT_MAX);
4345 /* If we must, use the pixel-based version which is much slower than
4346 the line-based one but can handle varying line heights. */
4347 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4348 window_scroll_pixel_based (window, n, whole, noerror);
4349 else
4350 window_scroll_line_based (window, n, whole, noerror);
4352 immediate_quit = 0;
4356 /* Implementation of window_scroll that works based on pixel line
4357 heights. See the comment of window_scroll for parameter
4358 descriptions. */
4360 static void
4361 window_scroll_pixel_based (Lisp_Object window, int n, int whole, int noerror)
4363 struct it it;
4364 struct window *w = XWINDOW (window);
4365 struct text_pos start;
4366 int this_scroll_margin;
4367 /* True if we fiddled the window vscroll field without really scrolling. */
4368 int vscrolled = 0;
4369 int x, y, rtop, rbot, rowh, vpos;
4370 void *itdata = NULL;
4372 SET_TEXT_POS_FROM_MARKER (start, w->start);
4373 /* Scrolling a minibuffer window via scroll bar when the echo area
4374 shows long text sometimes resets the minibuffer contents behind
4375 our backs. */
4376 if (CHARPOS (start) > ZV)
4377 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
4379 /* If PT is not visible in WINDOW, move back one half of
4380 the screen. Allow PT to be partially visible, otherwise
4381 something like (scroll-down 1) with PT in the line before
4382 the partially visible one would recenter. */
4384 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
4386 itdata = bidi_shelve_cache ();
4387 /* Move backward half the height of the window. Performance note:
4388 vmotion used here is about 10% faster, but would give wrong
4389 results for variable height lines. */
4390 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4391 it.current_y = it.last_visible_y;
4392 move_it_vertically_backward (&it, window_box_height (w) / 2);
4394 /* The function move_iterator_vertically may move over more than
4395 the specified y-distance. If it->w is small, e.g. a
4396 mini-buffer window, we may end up in front of the window's
4397 display area. This is the case when Start displaying at the
4398 start of the line containing PT in this case. */
4399 if (it.current_y <= 0)
4401 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4402 move_it_vertically_backward (&it, 0);
4403 it.current_y = 0;
4406 start = it.current.pos;
4407 bidi_unshelve_cache (itdata, 0);
4409 else if (auto_window_vscroll_p)
4411 if (rtop || rbot) /* partially visible */
4413 int px;
4414 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4415 if (whole)
4416 dy = max ((window_box_height (w)
4417 - next_screen_context_lines * dy),
4418 dy);
4419 dy *= n;
4421 if (n < 0)
4423 /* Only vscroll backwards if already vscrolled forwards. */
4424 if (w->vscroll < 0 && rtop > 0)
4426 px = max (0, -w->vscroll - min (rtop, -dy));
4427 Fset_window_vscroll (window, make_number (px), Qt);
4428 return;
4431 if (n > 0)
4433 /* Do vscroll if already vscrolled or only display line. */
4434 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
4436 px = max (0, -w->vscroll + min (rbot, dy));
4437 Fset_window_vscroll (window, make_number (px), Qt);
4438 return;
4441 /* Maybe modify window start instead of scrolling. */
4442 if (rbot > 0 || w->vscroll < 0)
4444 ptrdiff_t spos;
4446 Fset_window_vscroll (window, make_number (0), Qt);
4447 /* If there are other text lines above the current row,
4448 move window start to current row. Else to next row. */
4449 if (rbot > 0)
4450 spos = XINT (Fline_beginning_position (Qnil));
4451 else
4452 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
4453 set_marker_restricted (w->start, make_number (spos),
4454 w->contents);
4455 w->start_at_line_beg = 1;
4456 w->update_mode_line = 1;
4457 w->last_modified = 0;
4458 w->last_overlay_modified = 0;
4459 /* Set force_start so that redisplay_window will run the
4460 window-scroll-functions. */
4461 w->force_start = 1;
4462 return;
4466 /* Cancel previous vscroll. */
4467 Fset_window_vscroll (window, make_number (0), Qt);
4470 itdata = bidi_shelve_cache ();
4471 /* If scroll_preserve_screen_position is non-nil, we try to set
4472 point in the same window line as it is now, so get that line. */
4473 if (!NILP (Vscroll_preserve_screen_position))
4475 /* We preserve the goal pixel coordinate across consecutive
4476 calls to scroll-up, scroll-down and other commands that
4477 have the `scroll-command' property. This avoids the
4478 possibility of point becoming "stuck" on a tall line when
4479 scrolling by one line. */
4480 if (window_scroll_pixel_based_preserve_y < 0
4481 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4482 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4484 start_display (&it, w, start);
4485 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4486 window_scroll_pixel_based_preserve_y = it.current_y;
4487 window_scroll_pixel_based_preserve_x = it.current_x;
4490 else
4491 window_scroll_pixel_based_preserve_y
4492 = window_scroll_pixel_based_preserve_x = -1;
4494 /* Move iterator it from start the specified distance forward or
4495 backward. The result is the new window start. */
4496 start_display (&it, w, start);
4497 if (whole)
4499 ptrdiff_t start_pos = IT_CHARPOS (it);
4500 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4501 dy = max ((window_box_height (w)
4502 - next_screen_context_lines * dy),
4503 dy) * n;
4505 /* Note that move_it_vertically always moves the iterator to the
4506 start of a line. So, if the last line doesn't have a newline,
4507 we would end up at the start of the line ending at ZV. */
4508 if (dy <= 0)
4510 move_it_vertically_backward (&it, -dy);
4511 /* Ensure we actually do move, e.g. in case we are currently
4512 looking at an image that is taller that the window height. */
4513 while (start_pos == IT_CHARPOS (it)
4514 && start_pos > BEGV)
4515 move_it_by_lines (&it, -1);
4517 else if (dy > 0)
4519 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4520 MOVE_TO_POS | MOVE_TO_Y);
4521 /* Ensure we actually do move, e.g. in case we are currently
4522 looking at an image that is taller that the window height. */
4523 while (start_pos == IT_CHARPOS (it)
4524 && start_pos < ZV)
4525 move_it_by_lines (&it, 1);
4528 else
4529 move_it_by_lines (&it, n);
4531 /* We failed if we find ZV is already on the screen (scrolling up,
4532 means there's nothing past the end), or if we can't start any
4533 earlier (scrolling down, means there's nothing past the top). */
4534 if ((n > 0 && IT_CHARPOS (it) == ZV)
4535 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4537 if (IT_CHARPOS (it) == ZV)
4539 if (it.current_y < it.last_visible_y
4540 && (it.current_y + it.max_ascent + it.max_descent
4541 > it.last_visible_y))
4543 /* The last line was only partially visible, make it fully
4544 visible. */
4545 w->vscroll = (it.last_visible_y
4546 - it.current_y + it.max_ascent + it.max_descent);
4547 adjust_glyphs (it.f);
4549 else
4551 bidi_unshelve_cache (itdata, 0);
4552 if (noerror)
4553 return;
4554 else if (n < 0) /* could happen with empty buffers */
4555 xsignal0 (Qbeginning_of_buffer);
4556 else
4557 xsignal0 (Qend_of_buffer);
4560 else
4562 if (w->vscroll != 0)
4563 /* The first line was only partially visible, make it fully
4564 visible. */
4565 w->vscroll = 0;
4566 else
4568 bidi_unshelve_cache (itdata, 0);
4569 if (noerror)
4570 return;
4571 else
4572 xsignal0 (Qbeginning_of_buffer);
4576 /* If control gets here, then we vscrolled. */
4578 XBUFFER (w->contents)->prevent_redisplay_optimizations_p = 1;
4580 /* Don't try to change the window start below. */
4581 vscrolled = 1;
4584 if (! vscrolled)
4586 ptrdiff_t pos = IT_CHARPOS (it);
4587 ptrdiff_t bytepos;
4589 /* If in the middle of a multi-glyph character move forward to
4590 the next character. */
4591 if (in_display_vector_p (&it))
4593 ++pos;
4594 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
4597 /* Set the window start, and set up the window for redisplay. */
4598 set_marker_restricted_both (w->start, w->contents, IT_CHARPOS (it),
4599 IT_BYTEPOS (it));
4600 bytepos = marker_byte_position (w->start);
4601 w->start_at_line_beg = (pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n');
4602 w->update_mode_line = 1;
4603 w->last_modified = 0;
4604 w->last_overlay_modified = 0;
4605 /* Set force_start so that redisplay_window will run the
4606 window-scroll-functions. */
4607 w->force_start = 1;
4610 /* The rest of this function uses current_y in a nonstandard way,
4611 not including the height of the header line if any. */
4612 it.current_y = it.vpos = 0;
4614 /* Move PT out of scroll margins.
4615 This code wants current_y to be zero at the window start position
4616 even if there is a header line. */
4617 this_scroll_margin = max (0, scroll_margin);
4618 this_scroll_margin
4619 = min (this_scroll_margin, w->total_lines / 4);
4620 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
4622 if (n > 0)
4624 /* We moved the window start towards ZV, so PT may be now
4625 in the scroll margin at the top. */
4626 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4627 if (IT_CHARPOS (it) == PT && it.current_y >= this_scroll_margin
4628 && (NILP (Vscroll_preserve_screen_position)
4629 || EQ (Vscroll_preserve_screen_position, Qt)))
4630 /* We found PT at a legitimate height. Leave it alone. */
4632 else if (window_scroll_pixel_based_preserve_y >= 0)
4634 /* If we have a header line, take account of it.
4635 This is necessary because we set it.current_y to 0, above. */
4636 move_it_to (&it, -1,
4637 window_scroll_pixel_based_preserve_x,
4638 window_scroll_pixel_based_preserve_y
4639 - (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0 ),
4640 -1, MOVE_TO_Y | MOVE_TO_X);
4641 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4643 else
4645 while (it.current_y < this_scroll_margin)
4647 int prev = it.current_y;
4648 move_it_by_lines (&it, 1);
4649 if (prev == it.current_y)
4650 break;
4652 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4655 else if (n < 0)
4657 ptrdiff_t charpos, bytepos;
4658 int partial_p;
4660 /* Save our position, for the
4661 window_scroll_pixel_based_preserve_y case. */
4662 charpos = IT_CHARPOS (it);
4663 bytepos = IT_BYTEPOS (it);
4665 /* We moved the window start towards BEGV, so PT may be now
4666 in the scroll margin at the bottom. */
4667 move_it_to (&it, PT, -1,
4668 (it.last_visible_y - CURRENT_HEADER_LINE_HEIGHT (w)
4669 - this_scroll_margin - 1),
4671 MOVE_TO_POS | MOVE_TO_Y);
4673 /* Save our position, in case it's correct. */
4674 charpos = IT_CHARPOS (it);
4675 bytepos = IT_BYTEPOS (it);
4677 /* See if point is on a partially visible line at the end. */
4678 if (it.what == IT_EOB)
4679 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
4680 else
4682 move_it_by_lines (&it, 1);
4683 partial_p = it.current_y > it.last_visible_y;
4686 if (charpos == PT && !partial_p
4687 && (NILP (Vscroll_preserve_screen_position)
4688 || EQ (Vscroll_preserve_screen_position, Qt)))
4689 /* We found PT before we found the display margin, so PT is ok. */
4691 else if (window_scroll_pixel_based_preserve_y >= 0)
4693 SET_TEXT_POS_FROM_MARKER (start, w->start);
4694 start_display (&it, w, start);
4695 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
4696 here because we called start_display again and did not
4697 alter it.current_y this time. */
4698 move_it_to (&it, -1, window_scroll_pixel_based_preserve_x,
4699 window_scroll_pixel_based_preserve_y, -1,
4700 MOVE_TO_Y | MOVE_TO_X);
4701 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4703 else
4705 if (partial_p)
4706 /* The last line was only partially visible, so back up two
4707 lines to make sure we're on a fully visible line. */
4709 move_it_by_lines (&it, -2);
4710 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4712 else
4713 /* No, the position we saved is OK, so use it. */
4714 SET_PT_BOTH (charpos, bytepos);
4717 bidi_unshelve_cache (itdata, 0);
4721 /* Implementation of window_scroll that works based on screen lines.
4722 See the comment of window_scroll for parameter descriptions. */
4724 static void
4725 window_scroll_line_based (Lisp_Object window, int n, int whole, int noerror)
4727 register struct window *w = XWINDOW (window);
4728 /* Fvertical_motion enters redisplay, which can trigger
4729 fontification, which in turn can modify buffer text (e.g., if the
4730 fontification functions replace escape sequences with faces, as
4731 in `grep-mode-font-lock-keywords'). So we use a marker to record
4732 the old point position, to prevent crashes in SET_PT_BOTH. */
4733 Lisp_Object opoint_marker = Fpoint_marker ();
4734 register ptrdiff_t pos, pos_byte;
4735 register int ht = window_internal_height (w);
4736 register Lisp_Object tem;
4737 int lose;
4738 Lisp_Object bolp;
4739 ptrdiff_t startpos = marker_position (w->start);
4740 ptrdiff_t startbyte = marker_byte_position (w->start);
4741 Lisp_Object original_pos = Qnil;
4743 /* If scrolling screen-fulls, compute the number of lines to
4744 scroll from the window's height. */
4745 if (whole)
4746 n *= max (1, ht - next_screen_context_lines);
4748 if (!NILP (Vscroll_preserve_screen_position))
4750 if (window_scroll_preserve_vpos <= 0
4751 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4752 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4754 struct position posit
4755 = *compute_motion (startpos, startbyte, 0, 0, 0,
4756 PT, ht, 0, -1, w->hscroll, 0, w);
4757 window_scroll_preserve_vpos = posit.vpos;
4758 window_scroll_preserve_hpos = posit.hpos + w->hscroll;
4761 original_pos = Fcons (make_number (window_scroll_preserve_hpos),
4762 make_number (window_scroll_preserve_vpos));
4765 XSETFASTINT (tem, PT);
4766 tem = Fpos_visible_in_window_p (tem, window, Qnil);
4768 if (NILP (tem))
4770 Fvertical_motion (make_number (- (ht / 2)), window);
4771 startpos = PT;
4772 startbyte = PT_BYTE;
4775 SET_PT_BOTH (startpos, startbyte);
4776 lose = n < 0 && PT == BEGV;
4777 Fvertical_motion (make_number (n), window);
4778 pos = PT;
4779 pos_byte = PT_BYTE;
4780 bolp = Fbolp ();
4781 SET_PT_BOTH (marker_position (opoint_marker),
4782 marker_byte_position (opoint_marker));
4784 if (lose)
4786 if (noerror)
4787 return;
4788 else
4789 xsignal0 (Qbeginning_of_buffer);
4792 if (pos < ZV)
4794 /* Don't use a scroll margin that is negative or too large. */
4795 int this_scroll_margin =
4796 max (0, min (scroll_margin, w->total_lines / 4));
4798 set_marker_restricted_both (w->start, w->contents, pos, pos_byte);
4799 w->start_at_line_beg = !NILP (bolp);
4800 w->update_mode_line = 1;
4801 w->last_modified = 0;
4802 w->last_overlay_modified = 0;
4803 /* Set force_start so that redisplay_window will run
4804 the window-scroll-functions. */
4805 w->force_start = 1;
4807 if (!NILP (Vscroll_preserve_screen_position)
4808 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
4810 SET_PT_BOTH (pos, pos_byte);
4811 Fvertical_motion (original_pos, window);
4813 /* If we scrolled forward, put point enough lines down
4814 that it is outside the scroll margin. */
4815 else if (n > 0)
4817 int top_margin;
4819 if (this_scroll_margin > 0)
4821 SET_PT_BOTH (pos, pos_byte);
4822 Fvertical_motion (make_number (this_scroll_margin), window);
4823 top_margin = PT;
4825 else
4826 top_margin = pos;
4828 if (top_margin <= marker_position (opoint_marker))
4829 SET_PT_BOTH (marker_position (opoint_marker),
4830 marker_byte_position (opoint_marker));
4831 else if (!NILP (Vscroll_preserve_screen_position))
4833 SET_PT_BOTH (pos, pos_byte);
4834 Fvertical_motion (original_pos, window);
4836 else
4837 SET_PT (top_margin);
4839 else if (n < 0)
4841 int bottom_margin;
4843 /* If we scrolled backward, put point near the end of the window
4844 but not within the scroll margin. */
4845 SET_PT_BOTH (pos, pos_byte);
4846 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
4847 if (XFASTINT (tem) == ht - this_scroll_margin)
4848 bottom_margin = PT;
4849 else
4850 bottom_margin = PT + 1;
4852 if (bottom_margin > marker_position (opoint_marker))
4853 SET_PT_BOTH (marker_position (opoint_marker),
4854 marker_byte_position (opoint_marker));
4855 else
4857 if (!NILP (Vscroll_preserve_screen_position))
4859 SET_PT_BOTH (pos, pos_byte);
4860 Fvertical_motion (original_pos, window);
4862 else
4863 Fvertical_motion (make_number (-1), window);
4867 else
4869 if (noerror)
4870 return;
4871 else
4872 xsignal0 (Qend_of_buffer);
4877 /* Scroll selected_window up or down. If N is nil, scroll a
4878 screen-full which is defined as the height of the window minus
4879 next_screen_context_lines. If N is the symbol `-', scroll.
4880 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
4881 up. This is the guts of Fscroll_up and Fscroll_down. */
4883 static void
4884 scroll_command (Lisp_Object n, int direction)
4886 ptrdiff_t count = SPECPDL_INDEX ();
4888 eassert (eabs (direction) == 1);
4890 /* If selected window's buffer isn't current, make it current for
4891 the moment. But don't screw up if window_scroll gets an error. */
4892 if (XBUFFER (XWINDOW (selected_window)->contents) != current_buffer)
4894 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4895 Fset_buffer (XWINDOW (selected_window)->contents);
4897 /* Make redisplay consider other windows than just selected_window. */
4898 ++windows_or_buffers_changed;
4901 if (NILP (n))
4902 window_scroll (selected_window, direction, 1, 0);
4903 else if (EQ (n, Qminus))
4904 window_scroll (selected_window, -direction, 1, 0);
4905 else
4907 n = Fprefix_numeric_value (n);
4908 window_scroll (selected_window, XINT (n) * direction, 0, 0);
4911 unbind_to (count, Qnil);
4914 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
4915 doc: /* Scroll text of selected window upward ARG lines.
4916 If ARG is omitted or nil, scroll upward by a near full screen.
4917 A near full screen is `next-screen-context-lines' less than a full screen.
4918 Negative ARG means scroll downward.
4919 If ARG is the atom `-', scroll downward by nearly full screen.
4920 When calling from a program, supply as argument a number, nil, or `-'. */)
4921 (Lisp_Object arg)
4923 scroll_command (arg, 1);
4924 return Qnil;
4927 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
4928 doc: /* Scroll text of selected window down ARG lines.
4929 If ARG is omitted or nil, scroll down by a near full screen.
4930 A near full screen is `next-screen-context-lines' less than a full screen.
4931 Negative ARG means scroll upward.
4932 If ARG is the atom `-', scroll upward by nearly full screen.
4933 When calling from a program, supply as argument a number, nil, or `-'. */)
4934 (Lisp_Object arg)
4936 scroll_command (arg, -1);
4937 return Qnil;
4940 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
4941 doc: /* Return the other window for \"other window scroll\" commands.
4942 If `other-window-scroll-buffer' is non-nil, a window
4943 showing that buffer is used.
4944 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4945 specifies the window. This takes precedence over
4946 `other-window-scroll-buffer'. */)
4947 (void)
4949 Lisp_Object window;
4951 if (MINI_WINDOW_P (XWINDOW (selected_window))
4952 && !NILP (Vminibuf_scroll_window))
4953 window = Vminibuf_scroll_window;
4954 /* If buffer is specified, scroll that buffer. */
4955 else if (!NILP (Vother_window_scroll_buffer))
4957 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
4958 if (NILP (window))
4959 window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil);
4961 else
4963 /* Nothing specified; look for a neighboring window on the same
4964 frame. */
4965 window = Fnext_window (selected_window, Qnil, Qnil);
4967 if (EQ (window, selected_window))
4968 /* That didn't get us anywhere; look for a window on another
4969 visible frame. */
4971 window = Fnext_window (window, Qnil, Qt);
4972 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
4973 && ! EQ (window, selected_window));
4976 CHECK_LIVE_WINDOW (window);
4978 if (EQ (window, selected_window))
4979 error ("There is no other window");
4981 return window;
4984 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
4985 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
4986 A near full screen is `next-screen-context-lines' less than a full screen.
4987 The next window is the one below the current one; or the one at the top
4988 if the current one is at the bottom. Negative ARG means scroll downward.
4989 If ARG is the atom `-', scroll downward by nearly full screen.
4990 When calling from a program, supply as argument a number, nil, or `-'.
4992 If `other-window-scroll-buffer' is non-nil, scroll the window
4993 showing that buffer, popping the buffer up if necessary.
4994 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4995 specifies the window to scroll. This takes precedence over
4996 `other-window-scroll-buffer'. */)
4997 (Lisp_Object arg)
4999 Lisp_Object window;
5000 struct window *w;
5001 ptrdiff_t count = SPECPDL_INDEX ();
5003 window = Fother_window_for_scrolling ();
5004 w = XWINDOW (window);
5006 /* Don't screw up if window_scroll gets an error. */
5007 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5008 ++windows_or_buffers_changed;
5010 Fset_buffer (w->contents);
5011 SET_PT_BOTH (marker_position (w->pointm), marker_byte_position (w->pointm));
5013 if (NILP (arg))
5014 window_scroll (window, 1, 1, 1);
5015 else if (EQ (arg, Qminus))
5016 window_scroll (window, -1, 1, 1);
5017 else
5019 if (CONSP (arg))
5020 arg = XCAR (arg);
5021 CHECK_NUMBER (arg);
5022 window_scroll (window, XINT (arg), 0, 1);
5025 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
5026 unbind_to (count, Qnil);
5028 return Qnil;
5031 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
5032 doc: /* Scroll selected window display ARG columns left.
5033 Default for ARG is window width minus 2.
5034 Value is the total amount of leftward horizontal scrolling in
5035 effect after the change.
5036 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5037 lower bound for automatic scrolling, i.e. automatic scrolling
5038 will not scroll a window to a column less than the value returned
5039 by this function. This happens in an interactive call. */)
5040 (register Lisp_Object arg, Lisp_Object set_minimum)
5042 struct window *w = XWINDOW (selected_window);
5043 EMACS_INT requested_arg = (NILP (arg)
5044 ? window_body_cols (w) - 2
5045 : XINT (Fprefix_numeric_value (arg)));
5046 Lisp_Object result = set_window_hscroll (w, w->hscroll + requested_arg);
5048 if (!NILP (set_minimum))
5049 w->min_hscroll = w->hscroll;
5051 return result;
5054 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
5055 doc: /* Scroll selected window display ARG columns right.
5056 Default for ARG is window width minus 2.
5057 Value is the total amount of leftward horizontal scrolling in
5058 effect after the change.
5059 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5060 lower bound for automatic scrolling, i.e. automatic scrolling
5061 will not scroll a window to a column less than the value returned
5062 by this function. This happens in an interactive call. */)
5063 (register Lisp_Object arg, Lisp_Object set_minimum)
5065 struct window *w = XWINDOW (selected_window);
5066 EMACS_INT requested_arg = (NILP (arg)
5067 ? window_body_cols (w) - 2
5068 : XINT (Fprefix_numeric_value (arg)));
5069 Lisp_Object result = set_window_hscroll (w, w->hscroll - requested_arg);
5071 if (!NILP (set_minimum))
5072 w->min_hscroll = w->hscroll;
5074 return result;
5077 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
5078 doc: /* Return the window which was selected when entering the minibuffer.
5079 Returns nil, if selected window is not a minibuffer window. */)
5080 (void)
5082 if (minibuf_level > 0
5083 && MINI_WINDOW_P (XWINDOW (selected_window))
5084 && WINDOW_LIVE_P (minibuf_selected_window))
5085 return minibuf_selected_window;
5087 return Qnil;
5090 /* Value is the number of lines actually displayed in window W,
5091 as opposed to its height. */
5093 static int
5094 displayed_window_lines (struct window *w)
5096 struct it it;
5097 struct text_pos start;
5098 ptrdiff_t charpos = marker_position (w->start);
5099 int height = window_box_height (w);
5100 struct buffer *old_buffer;
5101 int bottom_y;
5102 void *itdata = NULL;
5104 if (XBUFFER (w->contents) != current_buffer)
5106 old_buffer = current_buffer;
5107 set_buffer_internal (XBUFFER (w->contents));
5109 else
5110 old_buffer = NULL;
5112 /* In case W->start is out of the accessible range, do something
5113 reasonable. This happens in Info mode when Info-scroll-down
5114 calls (recenter -1) while W->start is 1. */
5115 if (charpos < BEGV)
5116 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
5117 else if (charpos > ZV)
5118 SET_TEXT_POS (start, ZV, ZV_BYTE);
5119 else
5120 SET_TEXT_POS_FROM_MARKER (start, w->start);
5122 itdata = bidi_shelve_cache ();
5123 start_display (&it, w, start);
5124 move_it_vertically (&it, height);
5125 bottom_y = line_bottom_y (&it);
5126 bidi_unshelve_cache (itdata, 0);
5128 /* rms: On a non-window display,
5129 the value of it.vpos at the bottom of the screen
5130 seems to be 1 larger than window_box_height (w).
5131 This kludge fixes a bug whereby (move-to-window-line -1)
5132 when ZV is on the last screen line
5133 moves to the previous screen line instead of the last one. */
5134 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
5135 height++;
5137 /* Add in empty lines at the bottom of the window. */
5138 if (bottom_y < height)
5140 int uy = FRAME_LINE_HEIGHT (it.f);
5141 it.vpos += (height - bottom_y + uy - 1) / uy;
5144 if (old_buffer)
5145 set_buffer_internal (old_buffer);
5147 return it.vpos;
5151 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
5152 doc: /* Center point in selected window and maybe redisplay frame.
5153 With a numeric prefix argument ARG, recenter putting point on screen line ARG
5154 relative to the selected window. If ARG is negative, it counts up from the
5155 bottom of the window. (ARG should be less than the height of the window.)
5157 If ARG is omitted or nil, then recenter with point on the middle line of
5158 the selected window; if the variable `recenter-redisplay' is non-nil,
5159 also erase the entire frame and redraw it (when `auto-resize-tool-bars'
5160 is set to `grow-only', this resets the tool-bar's height to the minimum
5161 height needed); if `recenter-redisplay' has the special value `tty',
5162 then only tty frames are redrawn.
5164 Just C-u as prefix means put point in the center of the window
5165 and redisplay normally--don't erase and redraw the frame. */)
5166 (register Lisp_Object arg)
5168 struct window *w = XWINDOW (selected_window);
5169 struct buffer *buf = XBUFFER (w->contents);
5170 struct buffer *obuf = current_buffer;
5171 int center_p = 0;
5172 ptrdiff_t charpos, bytepos;
5173 EMACS_INT iarg IF_LINT (= 0);
5174 int this_scroll_margin;
5176 /* If redisplay is suppressed due to an error, try again. */
5177 obuf->display_error_modiff = 0;
5179 if (NILP (arg))
5181 if (!NILP (Vrecenter_redisplay)
5182 && (!EQ (Vrecenter_redisplay, Qtty)
5183 || !NILP (Ftty_type (selected_frame))))
5185 ptrdiff_t i;
5187 /* Invalidate pixel data calculated for all compositions. */
5188 for (i = 0; i < n_compositions; i++)
5189 composition_table[i]->font = NULL;
5191 WINDOW_XFRAME (w)->minimize_tool_bar_window_p = 1;
5193 Fredraw_frame (WINDOW_FRAME (w));
5194 SET_FRAME_GARBAGED (WINDOW_XFRAME (w));
5197 center_p = 1;
5199 else if (CONSP (arg)) /* Just C-u. */
5200 center_p = 1;
5201 else
5203 arg = Fprefix_numeric_value (arg);
5204 CHECK_NUMBER (arg);
5205 iarg = XINT (arg);
5208 set_buffer_internal (buf);
5210 /* Do this after making BUF current
5211 in case scroll_margin is buffer-local. */
5212 this_scroll_margin =
5213 max (0, min (scroll_margin, w->total_lines / 4));
5215 /* Handle centering on a graphical frame specially. Such frames can
5216 have variable-height lines and centering point on the basis of
5217 line counts would lead to strange effects. */
5218 if (FRAME_WINDOW_P (XFRAME (w->frame)))
5220 if (center_p)
5222 struct it it;
5223 struct text_pos pt;
5224 void *itdata = bidi_shelve_cache ();
5226 SET_TEXT_POS (pt, PT, PT_BYTE);
5227 start_display (&it, w, pt);
5228 move_it_vertically_backward (&it, window_box_height (w) / 2);
5229 charpos = IT_CHARPOS (it);
5230 bytepos = IT_BYTEPOS (it);
5231 bidi_unshelve_cache (itdata, 0);
5233 else if (iarg < 0)
5235 struct it it;
5236 struct text_pos pt;
5237 ptrdiff_t nlines = min (PTRDIFF_MAX, -iarg);
5238 int extra_line_spacing;
5239 int h = window_box_height (w);
5240 void *itdata = bidi_shelve_cache ();
5242 iarg = - max (-iarg, this_scroll_margin);
5244 SET_TEXT_POS (pt, PT, PT_BYTE);
5245 start_display (&it, w, pt);
5247 /* Be sure we have the exact height of the full line containing PT. */
5248 move_it_by_lines (&it, 0);
5250 /* The amount of pixels we have to move back is the window
5251 height minus what's displayed in the line containing PT,
5252 and the lines below. */
5253 it.current_y = 0;
5254 it.vpos = 0;
5255 move_it_by_lines (&it, nlines);
5257 if (it.vpos == nlines)
5258 h -= it.current_y;
5259 else
5261 /* Last line has no newline */
5262 h -= line_bottom_y (&it);
5263 it.vpos++;
5266 /* Don't reserve space for extra line spacing of last line. */
5267 extra_line_spacing = it.max_extra_line_spacing;
5269 /* If we can't move down NLINES lines because we hit
5270 the end of the buffer, count in some empty lines. */
5271 if (it.vpos < nlines)
5273 nlines -= it.vpos;
5274 extra_line_spacing = it.extra_line_spacing;
5275 h -= nlines * (FRAME_LINE_HEIGHT (it.f) + extra_line_spacing);
5277 if (h <= 0)
5279 bidi_unshelve_cache (itdata, 0);
5280 return Qnil;
5283 /* Now find the new top line (starting position) of the window. */
5284 start_display (&it, w, pt);
5285 it.current_y = 0;
5286 move_it_vertically_backward (&it, h);
5288 /* If extra line spacing is present, we may move too far
5289 back. This causes the last line to be only partially
5290 visible (which triggers redisplay to recenter that line
5291 in the middle), so move forward.
5292 But ignore extra line spacing on last line, as it is not
5293 considered to be part of the visible height of the line.
5295 h += extra_line_spacing;
5296 while (-it.current_y > h)
5297 move_it_by_lines (&it, 1);
5299 charpos = IT_CHARPOS (it);
5300 bytepos = IT_BYTEPOS (it);
5302 bidi_unshelve_cache (itdata, 0);
5304 else
5306 struct position pos;
5308 iarg = max (iarg, this_scroll_margin);
5310 pos = *vmotion (PT, PT_BYTE, -iarg, w);
5311 charpos = pos.bufpos;
5312 bytepos = pos.bytepos;
5315 else
5317 struct position pos;
5318 int ht = window_internal_height (w);
5320 if (center_p)
5321 iarg = ht / 2;
5322 else if (iarg < 0)
5323 iarg += ht;
5325 /* Don't let it get into the margin at either top or bottom. */
5326 iarg = clip_to_bounds (this_scroll_margin, iarg,
5327 ht - this_scroll_margin - 1);
5329 pos = *vmotion (PT, PT_BYTE, - iarg, w);
5330 charpos = pos.bufpos;
5331 bytepos = pos.bytepos;
5334 /* Set the new window start. */
5335 set_marker_both (w->start, w->contents, charpos, bytepos);
5336 w->window_end_valid = 0;
5338 w->optional_new_start = 1;
5340 w->start_at_line_beg = (bytepos == BEGV_BYTE ||
5341 FETCH_BYTE (bytepos - 1) == '\n');
5343 set_buffer_internal (obuf);
5344 return Qnil;
5347 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5348 0, 1, 0,
5349 doc: /* Return the height in lines of the text display area of WINDOW.
5350 WINDOW must be a live window and defaults to the selected one.
5352 The returned height does not include the mode line, any header line,
5353 nor any partial-height lines at the bottom of the text area. */)
5354 (Lisp_Object window)
5356 struct window *w = decode_live_window (window);
5357 int pixel_height = window_box_height (w);
5358 int line_height = pixel_height / FRAME_LINE_HEIGHT (XFRAME (w->frame));
5359 return make_number (line_height);
5364 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
5365 1, 1, "P",
5366 doc: /* Position point relative to window.
5367 ARG nil means position point at center of window.
5368 Else, ARG specifies vertical position within the window;
5369 zero means top of window, negative means relative to bottom of window. */)
5370 (Lisp_Object arg)
5372 struct window *w = XWINDOW (selected_window);
5373 int lines, start;
5374 Lisp_Object window;
5375 #if 0
5376 int this_scroll_margin;
5377 #endif
5379 if (!(BUFFERP (w->contents) && XBUFFER (w->contents) == current_buffer))
5380 /* This test is needed to make sure PT/PT_BYTE make sense in w->contents
5381 when passed below to set_marker_both. */
5382 error ("move-to-window-line called from unrelated buffer");
5384 window = selected_window;
5385 start = marker_position (w->start);
5386 if (start < BEGV || start > ZV)
5388 int height = window_internal_height (w);
5389 Fvertical_motion (make_number (- (height / 2)), window);
5390 set_marker_both (w->start, w->contents, PT, PT_BYTE);
5391 w->start_at_line_beg = !NILP (Fbolp ());
5392 w->force_start = 1;
5394 else
5395 Fgoto_char (w->start);
5397 lines = displayed_window_lines (w);
5399 #if 0
5400 this_scroll_margin = max (0, min (scroll_margin, lines / 4));
5401 #endif
5403 if (NILP (arg))
5404 XSETFASTINT (arg, lines / 2);
5405 else
5407 EMACS_INT iarg = XINT (Fprefix_numeric_value (arg));
5409 if (iarg < 0)
5410 iarg = iarg + lines;
5412 #if 0 /* This code would prevent move-to-window-line from moving point
5413 to a place inside the scroll margins (which would cause the
5414 next redisplay to scroll). I wrote this code, but then concluded
5415 it is probably better not to install it. However, it is here
5416 inside #if 0 so as not to lose it. -- rms. */
5418 /* Don't let it get into the margin at either top or bottom. */
5419 iarg = max (iarg, this_scroll_margin);
5420 iarg = min (iarg, lines - this_scroll_margin - 1);
5421 #endif
5423 arg = make_number (iarg);
5426 /* Skip past a partially visible first line. */
5427 if (w->vscroll)
5428 XSETINT (arg, XINT (arg) + 1);
5430 return Fvertical_motion (arg, window);
5435 /***********************************************************************
5436 Window Configuration
5437 ***********************************************************************/
5439 struct save_window_data
5441 struct vectorlike_header header;
5442 Lisp_Object selected_frame;
5443 Lisp_Object current_window;
5444 Lisp_Object current_buffer;
5445 Lisp_Object minibuf_scroll_window;
5446 Lisp_Object minibuf_selected_window;
5447 Lisp_Object root_window;
5448 Lisp_Object focus_frame;
5449 /* A vector, each of whose elements is a struct saved_window
5450 for one window. */
5451 Lisp_Object saved_windows;
5453 /* All fields above are traced by the GC.
5454 From `fame-cols' down, the fields are ignored by the GC. */
5456 int frame_cols, frame_lines, frame_menu_bar_lines;
5457 int frame_tool_bar_lines;
5460 /* This is saved as a Lisp_Vector */
5461 struct saved_window
5463 struct vectorlike_header header;
5465 Lisp_Object window, buffer, start, pointm, mark;
5466 Lisp_Object left_col, top_line, total_cols, total_lines;
5467 Lisp_Object normal_cols, normal_lines;
5468 Lisp_Object hscroll, min_hscroll;
5469 Lisp_Object parent, prev;
5470 Lisp_Object start_at_line_beg;
5471 Lisp_Object display_table;
5472 Lisp_Object left_margin_cols, right_margin_cols;
5473 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
5474 Lisp_Object scroll_bar_width, vertical_scroll_bar_type, dedicated;
5475 Lisp_Object combination_limit, window_parameters;
5478 #define SAVED_WINDOW_N(swv,n) \
5479 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5481 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
5482 doc: /* Return t if OBJECT is a window-configuration object. */)
5483 (Lisp_Object object)
5485 return WINDOW_CONFIGURATIONP (object) ? Qt : Qnil;
5488 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
5489 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5490 (Lisp_Object config)
5492 register struct save_window_data *data;
5493 struct Lisp_Vector *saved_windows;
5495 CHECK_WINDOW_CONFIGURATION (config);
5497 data = (struct save_window_data *) XVECTOR (config);
5498 saved_windows = XVECTOR (data->saved_windows);
5499 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5502 DEFUN ("set-window-configuration", Fset_window_configuration,
5503 Sset_window_configuration, 1, 1, 0,
5504 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5505 CONFIGURATION must be a value previously returned
5506 by `current-window-configuration' (which see).
5507 If CONFIGURATION was made from a frame that is now deleted,
5508 only frame-independent values can be restored. In this case,
5509 the return value is nil. Otherwise the value is t. */)
5510 (Lisp_Object configuration)
5512 register struct save_window_data *data;
5513 struct Lisp_Vector *saved_windows;
5514 Lisp_Object new_current_buffer;
5515 Lisp_Object frame;
5516 FRAME_PTR f;
5517 ptrdiff_t old_point = -1;
5519 CHECK_WINDOW_CONFIGURATION (configuration);
5521 data = (struct save_window_data *) XVECTOR (configuration);
5522 saved_windows = XVECTOR (data->saved_windows);
5524 new_current_buffer = data->current_buffer;
5525 if (!BUFFER_LIVE_P (XBUFFER (new_current_buffer)))
5526 new_current_buffer = Qnil;
5527 else
5529 if (XBUFFER (new_current_buffer) == current_buffer)
5530 /* The code further down "preserves point" by saving here PT in
5531 old_point and then setting it later back into PT. When the
5532 current-selected-window and the final-selected-window both show
5533 the current buffer, this suffers from the problem that the
5534 current PT is the window-point of the current-selected-window,
5535 while the final PT is the point of the final-selected-window, so
5536 this copy from one PT to the other would end up moving the
5537 window-point of the final-selected-window to the window-point of
5538 the current-selected-window. So we have to be careful which
5539 point of the current-buffer we copy into old_point. */
5540 if (EQ (XWINDOW (data->current_window)->contents, new_current_buffer)
5541 && WINDOWP (selected_window)
5542 && EQ (XWINDOW (selected_window)->contents, new_current_buffer)
5543 && !EQ (selected_window, data->current_window))
5544 old_point = marker_position (XWINDOW (data->current_window)->pointm);
5545 else
5546 old_point = PT;
5547 else
5548 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
5549 point in new_current_buffer as of the last time this buffer was
5550 used. This can be non-deterministic since it can be changed by
5551 things like jit-lock by mere temporary selection of some random
5552 window that happens to show this buffer.
5553 So if possible we want this arbitrary choice of "which point" to
5554 be the one from the to-be-selected-window so as to prevent this
5555 window's cursor from being copied from another window. */
5556 if (EQ (XWINDOW (data->current_window)->contents, new_current_buffer)
5557 /* If current_window = selected_window, its point is in BUF_PT. */
5558 && !EQ (selected_window, data->current_window))
5559 old_point = marker_position (XWINDOW (data->current_window)->pointm);
5560 else
5561 old_point = BUF_PT (XBUFFER (new_current_buffer));
5564 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5565 f = XFRAME (frame);
5567 /* If f is a dead frame, don't bother rebuilding its window tree.
5568 However, there is other stuff we should still try to do below. */
5569 if (FRAME_LIVE_P (f))
5571 Lisp_Object window;
5572 Lisp_Object dead_windows = Qnil;
5573 register Lisp_Object tem, par, pers;
5574 register struct window *w;
5575 register struct saved_window *p;
5576 struct window *root_window;
5577 struct window **leaf_windows;
5578 int n_leaf_windows;
5579 ptrdiff_t k;
5580 int i, n;
5582 /* If the frame has been resized since this window configuration was
5583 made, we change the frame to the size specified in the
5584 configuration, restore the configuration, and then resize it
5585 back. We keep track of the prevailing height in these variables. */
5586 int previous_frame_lines = FRAME_LINES (f);
5587 int previous_frame_cols = FRAME_COLS (f);
5588 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
5589 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
5591 /* Don't do this within the main loop below: This may call Lisp
5592 code and is thus potentially unsafe while input is blocked. */
5593 for (k = 0; k < saved_windows->header.size; k++)
5595 p = SAVED_WINDOW_N (saved_windows, k);
5596 window = p->window;
5597 w = XWINDOW (window);
5598 if (BUFFERP (w->contents)
5599 && !EQ (w->contents, p->buffer)
5600 && BUFFER_LIVE_P (XBUFFER (p->buffer)))
5601 /* If a window we restore gets another buffer, record the
5602 window's old buffer. */
5603 call1 (Qrecord_window_buffer, window);
5606 /* The mouse highlighting code could get screwed up
5607 if it runs during this. */
5608 block_input ();
5610 if (data->frame_lines != previous_frame_lines
5611 || data->frame_cols != previous_frame_cols)
5612 change_frame_size (f, data->frame_lines,
5613 data->frame_cols, 0, 0, 0);
5614 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5615 if (data->frame_menu_bar_lines
5616 != previous_frame_menu_bar_lines)
5617 x_set_menu_bar_lines (f, make_number (data->frame_menu_bar_lines),
5618 make_number (0));
5619 #ifdef HAVE_WINDOW_SYSTEM
5620 if (data->frame_tool_bar_lines
5621 != previous_frame_tool_bar_lines)
5622 x_set_tool_bar_lines (f, make_number (data->frame_tool_bar_lines),
5623 make_number (0));
5624 #endif
5625 #endif
5627 /* "Swap out" point from the selected window's buffer
5628 into the window itself. (Normally the pointm of the selected
5629 window holds garbage.) We do this now, before
5630 restoring the window contents, and prevent it from
5631 being done later on when we select a new window. */
5632 if (! NILP (XWINDOW (selected_window)->contents))
5634 w = XWINDOW (selected_window);
5635 set_marker_both (w->pointm,
5636 w->contents,
5637 BUF_PT (XBUFFER (w->contents)),
5638 BUF_PT_BYTE (XBUFFER (w->contents)));
5641 windows_or_buffers_changed++;
5642 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
5644 /* Problem: Freeing all matrices and later allocating them again
5645 is a serious redisplay flickering problem. What we would
5646 really like to do is to free only those matrices not reused
5647 below. */
5648 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
5649 leaf_windows = alloca (count_windows (root_window)
5650 * sizeof *leaf_windows);
5651 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
5653 /* Kludge Alert!
5654 Mark all windows now on frame as "deleted".
5655 Restoring the new configuration "undeletes" any that are in it.
5657 Save their current buffers in their height fields, since we may
5658 need it later, if a buffer saved in the configuration is now
5659 dead. */
5660 delete_all_child_windows (FRAME_ROOT_WINDOW (f));
5662 for (k = 0; k < saved_windows->header.size; k++)
5664 p = SAVED_WINDOW_N (saved_windows, k);
5665 window = p->window;
5666 w = XWINDOW (window);
5667 wset_next (w, Qnil);
5669 if (!NILP (p->parent))
5670 wset_parent
5671 (w, SAVED_WINDOW_N (saved_windows, XFASTINT (p->parent))->window);
5672 else
5673 wset_parent (w, Qnil);
5675 if (!NILP (p->prev))
5677 wset_prev
5678 (w, SAVED_WINDOW_N (saved_windows, XFASTINT (p->prev))->window);
5679 wset_next (XWINDOW (w->prev), p->window);
5681 else
5683 wset_prev (w, Qnil);
5684 if (!NILP (w->parent))
5685 wset_combination (XWINDOW (w->parent),
5686 (XINT (p->total_cols)
5687 != XWINDOW (w->parent)->total_cols),
5688 p->window);
5691 /* If we squirreled away the buffer, restore it now. */
5692 if (BUFFERP (w->combination_limit))
5693 wset_buffer (w, w->combination_limit);
5694 w->left_col = XFASTINT (p->left_col);
5695 w->top_line = XFASTINT (p->top_line);
5696 w->total_cols = XFASTINT (p->total_cols);
5697 w->total_lines = XFASTINT (p->total_lines);
5698 wset_normal_cols (w, p->normal_cols);
5699 wset_normal_lines (w, p->normal_lines);
5700 w->hscroll = XFASTINT (p->hscroll);
5701 w->min_hscroll = XFASTINT (p->min_hscroll);
5702 wset_display_table (w, p->display_table);
5703 wset_left_margin_cols (w, p->left_margin_cols);
5704 wset_right_margin_cols (w, p->right_margin_cols);
5705 wset_left_fringe_width (w, p->left_fringe_width);
5706 wset_right_fringe_width (w, p->right_fringe_width);
5707 w->fringes_outside_margins = !NILP (p->fringes_outside_margins);
5708 wset_scroll_bar_width (w, p->scroll_bar_width);
5709 wset_vertical_scroll_bar_type (w, p->vertical_scroll_bar_type);
5710 wset_dedicated (w, p->dedicated);
5711 wset_combination_limit (w, p->combination_limit);
5712 /* Restore any window parameters that have been saved.
5713 Parameters that have not been saved are left alone. */
5714 for (tem = p->window_parameters; CONSP (tem); tem = XCDR (tem))
5716 pers = XCAR (tem);
5717 if (CONSP (pers))
5719 if (NILP (XCDR (pers)))
5721 par = Fassq (XCAR (pers), w->window_parameters);
5722 if (CONSP (par) && !NILP (XCDR (par)))
5723 /* Reset a parameter to nil if and only if it
5724 has a non-nil association. Don't make new
5725 associations. */
5726 Fsetcdr (par, Qnil);
5728 else
5729 /* Always restore a non-nil value. */
5730 Fset_window_parameter (window, XCAR (pers), XCDR (pers));
5734 w->last_modified = 0;
5735 w->last_overlay_modified = 0;
5737 if (BUFFERP (p->buffer) && BUFFER_LIVE_P (XBUFFER (p->buffer)))
5738 /* If saved buffer is alive, install it. */
5740 wset_buffer (w, p->buffer);
5741 w->start_at_line_beg = !NILP (p->start_at_line_beg);
5742 set_marker_restricted (w->start, p->start, w->contents);
5743 set_marker_restricted (w->pointm, p->pointm,
5744 w->contents);
5745 Fset_marker (BVAR (XBUFFER (w->contents), mark),
5746 p->mark, w->contents);
5748 /* As documented in Fcurrent_window_configuration, don't
5749 restore the location of point in the buffer which was
5750 current when the window configuration was recorded. */
5751 if (!EQ (p->buffer, new_current_buffer)
5752 && XBUFFER (p->buffer) == current_buffer)
5753 Fgoto_char (w->pointm);
5755 else if (BUFFERP (w->contents) && BUFFER_LIVE_P (XBUFFER (w->contents)))
5756 /* Keep window's old buffer; make sure the markers are real. */
5758 /* Set window markers at start of visible range. */
5759 if (XMARKER (w->start)->buffer == 0)
5760 set_marker_restricted_both (w->start, w->contents, 0, 0);
5761 if (XMARKER (w->pointm)->buffer == 0)
5762 set_marker_restricted_both
5763 (w->pointm, w->contents,
5764 BUF_PT (XBUFFER (w->contents)),
5765 BUF_PT_BYTE (XBUFFER (w->contents)));
5766 w->start_at_line_beg = 1;
5768 else if (!NILP (w->start))
5769 /* Leaf window has no live buffer, get one. */
5771 /* Get the buffer via other_buffer_safely in order to
5772 avoid showing an unimportant buffer and, if necessary, to
5773 recreate *scratch* in the course (part of Juanma's bs-show
5774 scenario from March 2011). */
5775 wset_buffer (w, other_buffer_safely (Fcurrent_buffer ()));
5776 /* This will set the markers to beginning of visible
5777 range. */
5778 set_marker_restricted_both (w->start, w->contents, 0, 0);
5779 set_marker_restricted_both (w->pointm, w->contents, 0, 0);
5780 w->start_at_line_beg = 1;
5781 if (!NILP (w->dedicated))
5782 /* Record this window as dead. */
5783 dead_windows = Fcons (window, dead_windows);
5784 /* Make sure window is no more dedicated. */
5785 wset_dedicated (w, Qnil);
5789 fset_root_window (f, data->root_window);
5790 /* Arrange *not* to restore point in the buffer that was
5791 current when the window configuration was saved. */
5792 if (EQ (XWINDOW (data->current_window)->contents, new_current_buffer))
5793 set_marker_restricted (XWINDOW (data->current_window)->pointm,
5794 make_number (old_point),
5795 XWINDOW (data->current_window)->contents);
5797 /* In the following call to `select-window', prevent "swapping out
5798 point" in the old selected window using the buffer that has
5799 been restored into it. We already swapped out that point from
5800 that window's old buffer. */
5801 select_window (data->current_window, Qnil, 1);
5802 BVAR (XBUFFER (XWINDOW (selected_window)->contents), last_selected_window)
5803 = selected_window;
5805 if (NILP (data->focus_frame)
5806 || (FRAMEP (data->focus_frame)
5807 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
5808 Fredirect_frame_focus (frame, data->focus_frame);
5810 /* Set the screen height to the value it had before this function. */
5811 if (previous_frame_lines != FRAME_LINES (f)
5812 || previous_frame_cols != FRAME_COLS (f))
5813 change_frame_size (f, previous_frame_lines, previous_frame_cols,
5814 0, 0, 0);
5815 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5816 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
5817 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
5818 make_number (0));
5819 #ifdef HAVE_WINDOW_SYSTEM
5820 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
5821 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
5822 make_number (0));
5823 #endif
5824 #endif
5826 /* Now, free glyph matrices in windows that were not reused. */
5827 for (i = n = 0; i < n_leaf_windows; ++i)
5829 if (NILP (leaf_windows[i]->contents))
5830 free_window_matrices (leaf_windows[i]);
5831 else if (EQ (leaf_windows[i]->contents, new_current_buffer))
5832 ++n;
5835 adjust_glyphs (f);
5836 unblock_input ();
5838 /* Scan dead buffer windows. */
5839 for (; CONSP (dead_windows); dead_windows = XCDR (dead_windows))
5841 window = XCAR (dead_windows);
5842 if (WINDOW_LIVE_P (window) && !EQ (window, FRAME_ROOT_WINDOW (f)))
5843 delete_deletable_window (window);
5846 /* Fselect_window will have made f the selected frame, so we
5847 reselect the proper frame here. Fhandle_switch_frame will change the
5848 selected window too, but that doesn't make the call to
5849 Fselect_window above totally superfluous; it still sets f's
5850 selected window. */
5851 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
5852 do_switch_frame (data->selected_frame, 0, 0, Qnil);
5854 run_window_configuration_change_hook (f);
5857 if (!NILP (new_current_buffer))
5859 Fset_buffer (new_current_buffer);
5860 /* If the new current buffer doesn't appear in the selected
5861 window, go to its old point (see bug#12208). */
5862 if (!EQ (XWINDOW (data->current_window)->contents, new_current_buffer))
5863 Fgoto_char (make_number (old_point));
5866 Vminibuf_scroll_window = data->minibuf_scroll_window;
5867 minibuf_selected_window = data->minibuf_selected_window;
5869 return (FRAME_LIVE_P (f) ? Qt : Qnil);
5873 /* If WINDOW is an internal window, recursively delete all child windows
5874 reachable via the next and contents slots of WINDOW. Otherwise setup
5875 WINDOW to not show any buffer. */
5877 void
5878 delete_all_child_windows (Lisp_Object window)
5880 register struct window *w;
5882 w = XWINDOW (window);
5884 if (!NILP (w->next))
5885 /* Delete WINDOW's siblings (we traverse postorderly). */
5886 delete_all_child_windows (w->next);
5888 if (WINDOWP (w->contents))
5890 delete_all_child_windows (w->contents);
5891 wset_combination (w, 0, Qnil);
5893 else if (BUFFERP (w->contents))
5895 unshow_buffer (w);
5896 unchain_marker (XMARKER (w->pointm));
5897 unchain_marker (XMARKER (w->start));
5898 /* Since combination limit makes sense for an internal windows
5899 only, we use this slot to save the buffer for the sake of
5900 possible resurrection in Fset_window_configuration. */
5901 wset_combination_limit (w, w->contents);
5902 wset_buffer (w, Qnil);
5905 Vwindow_list = Qnil;
5908 static int
5909 count_windows (register struct window *window)
5911 register int count = 1;
5912 if (!NILP (window->next))
5913 count += count_windows (XWINDOW (window->next));
5914 if (WINDOWP (window->contents))
5915 count += count_windows (XWINDOW (window->contents));
5916 return count;
5920 /* Fill vector FLAT with leaf windows under W, starting at index I.
5921 Value is last index + 1. */
5922 static int
5923 get_leaf_windows (struct window *w, struct window **flat, int i)
5925 while (w)
5927 if (WINDOWP (w->contents))
5928 i = get_leaf_windows (XWINDOW (w->contents), flat, i);
5929 else
5930 flat[i++] = w;
5932 w = NILP (w->next) ? 0 : XWINDOW (w->next);
5935 return i;
5939 /* Return a pointer to the glyph W's physical cursor is on. Value is
5940 null if W's current matrix is invalid, so that no meaningful glyph
5941 can be returned. */
5942 struct glyph *
5943 get_phys_cursor_glyph (struct window *w)
5945 struct glyph_row *row;
5946 struct glyph *glyph;
5947 int hpos = w->phys_cursor.hpos;
5949 if (!(w->phys_cursor.vpos >= 0
5950 && w->phys_cursor.vpos < w->current_matrix->nrows))
5951 return NULL;
5953 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
5954 if (!row->enabled_p)
5955 return NULL;
5957 if (w->hscroll)
5959 /* When the window is hscrolled, cursor hpos can legitimately be
5960 out of bounds, but we draw the cursor at the corresponding
5961 window margin in that case. */
5962 if (!row->reversed_p && hpos < 0)
5963 hpos = 0;
5964 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
5965 hpos = row->used[TEXT_AREA] - 1;
5968 if (0 <= hpos && hpos < row->used[TEXT_AREA])
5969 glyph = row->glyphs[TEXT_AREA] + hpos;
5970 else
5971 glyph = NULL;
5973 return glyph;
5977 static int
5978 save_window_save (Lisp_Object window, struct Lisp_Vector *vector, int i)
5980 register struct saved_window *p;
5981 register struct window *w;
5982 register Lisp_Object tem, pers, par;
5984 for (; !NILP (window); window = w->next)
5986 p = SAVED_WINDOW_N (vector, i);
5987 w = XWINDOW (window);
5989 wset_temslot (w, make_number (i)); i++;
5990 p->window = window;
5991 p->buffer = (WINDOW_LEAF_P (w) ? w->contents : Qnil);
5992 p->left_col = make_number (w->left_col);
5993 p->top_line = make_number (w->top_line);
5994 p->total_cols = make_number (w->total_cols);
5995 p->total_lines = make_number (w->total_lines);
5996 p->normal_cols = w->normal_cols;
5997 p->normal_lines = w->normal_lines;
5998 XSETFASTINT (p->hscroll, w->hscroll);
5999 XSETFASTINT (p->min_hscroll, w->min_hscroll);
6000 p->display_table = w->display_table;
6001 p->left_margin_cols = w->left_margin_cols;
6002 p->right_margin_cols = w->right_margin_cols;
6003 p->left_fringe_width = w->left_fringe_width;
6004 p->right_fringe_width = w->right_fringe_width;
6005 p->fringes_outside_margins = w->fringes_outside_margins ? Qt : Qnil;
6006 p->scroll_bar_width = w->scroll_bar_width;
6007 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
6008 p->dedicated = w->dedicated;
6009 p->combination_limit = w->combination_limit;
6010 p->window_parameters = Qnil;
6012 if (!NILP (Vwindow_persistent_parameters))
6014 /* Run cycle detection on Vwindow_persistent_parameters. */
6015 Lisp_Object tortoise, hare;
6017 hare = tortoise = Vwindow_persistent_parameters;
6018 while (CONSP (hare))
6020 hare = XCDR (hare);
6021 if (!CONSP (hare))
6022 break;
6024 hare = XCDR (hare);
6025 tortoise = XCDR (tortoise);
6027 if (EQ (hare, tortoise))
6028 /* Reset Vwindow_persistent_parameters to Qnil. */
6030 Vwindow_persistent_parameters = Qnil;
6031 break;
6035 for (tem = Vwindow_persistent_parameters; CONSP (tem);
6036 tem = XCDR (tem))
6038 pers = XCAR (tem);
6039 /* Save values for persistent window parameters. */
6040 if (CONSP (pers) && !NILP (XCDR (pers)))
6042 par = Fassq (XCAR (pers), w->window_parameters);
6043 if (NILP (par))
6044 /* If the window has no value for the parameter,
6045 make one. */
6046 p->window_parameters = Fcons (Fcons (XCAR (pers), Qnil),
6047 p->window_parameters);
6048 else
6049 /* If the window has a value for the parameter,
6050 save it. */
6051 p->window_parameters = Fcons (Fcons (XCAR (par),
6052 XCDR (par)),
6053 p->window_parameters);
6058 if (BUFFERP (w->contents))
6060 /* Save w's value of point in the window configuration. If w
6061 is the selected window, then get the value of point from
6062 the buffer; pointm is garbage in the selected window. */
6063 if (EQ (window, selected_window))
6064 p->pointm = build_marker (XBUFFER (w->contents),
6065 BUF_PT (XBUFFER (w->contents)),
6066 BUF_PT_BYTE (XBUFFER (w->contents)));
6067 else
6068 p->pointm = Fcopy_marker (w->pointm, Qnil);
6069 XMARKER (p->pointm)->insertion_type
6070 = !NILP (Vwindow_point_insertion_type);
6072 p->start = Fcopy_marker (w->start, Qnil);
6073 p->start_at_line_beg = w->start_at_line_beg ? Qt : Qnil;
6075 tem = BVAR (XBUFFER (w->contents), mark);
6076 p->mark = Fcopy_marker (tem, Qnil);
6078 else
6080 p->pointm = Qnil;
6081 p->start = Qnil;
6082 p->mark = Qnil;
6083 p->start_at_line_beg = Qnil;
6086 if (NILP (w->parent))
6087 p->parent = Qnil;
6088 else
6089 p->parent = XWINDOW (w->parent)->temslot;
6091 if (NILP (w->prev))
6092 p->prev = Qnil;
6093 else
6094 p->prev = XWINDOW (w->prev)->temslot;
6096 if (WINDOWP (w->contents))
6097 i = save_window_save (w->contents, vector, i);
6100 return i;
6103 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
6104 Scurrent_window_configuration, 0, 1, 0,
6105 doc: /* Return an object representing the current window configuration of FRAME.
6106 If FRAME is nil or omitted, use the selected frame.
6107 This describes the number of windows, their sizes and current buffers,
6108 and for each displayed buffer, where display starts, and the positions of
6109 point and mark. An exception is made for point in the current buffer:
6110 its value is -not- saved.
6111 This also records the currently selected frame, and FRAME's focus
6112 redirection (see `redirect-frame-focus'). The variable
6113 `window-persistent-parameters' specifies which window parameters are
6114 saved by this function. */)
6115 (Lisp_Object frame)
6117 register Lisp_Object tem;
6118 register int n_windows;
6119 register struct save_window_data *data;
6120 register int i;
6121 struct frame *f = decode_live_frame (frame);
6123 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6124 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
6125 PVEC_WINDOW_CONFIGURATION);
6127 data->frame_cols = FRAME_COLS (f);
6128 data->frame_lines = FRAME_LINES (f);
6129 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6130 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6131 data->selected_frame = selected_frame;
6132 data->current_window = FRAME_SELECTED_WINDOW (f);
6133 XSETBUFFER (data->current_buffer, current_buffer);
6134 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
6135 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
6136 data->root_window = FRAME_ROOT_WINDOW (f);
6137 data->focus_frame = FRAME_FOCUS_FRAME (f);
6138 tem = make_uninit_vector (n_windows);
6139 data->saved_windows = tem;
6140 for (i = 0; i < n_windows; i++)
6141 ASET (tem, i,
6142 Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil));
6143 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
6144 XSETWINDOW_CONFIGURATION (tem, data);
6145 return (tem);
6148 /***********************************************************************
6149 Marginal Areas
6150 ***********************************************************************/
6152 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
6153 2, 3, 0,
6154 doc: /* Set width of marginal areas of window WINDOW.
6155 WINDOW must be a live window and defaults to the selected one.
6157 Second arg LEFT-WIDTH specifies the number of character cells to
6158 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6159 does the same for the right marginal area. A nil width parameter
6160 means no margin. */)
6161 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width)
6163 struct window *w = decode_live_window (window);
6165 /* Translate negative or zero widths to nil.
6166 Margins that are too wide have to be checked elsewhere. */
6168 if (!NILP (left_width))
6170 CHECK_NUMBER (left_width);
6171 if (XINT (left_width) <= 0)
6172 left_width = Qnil;
6175 if (!NILP (right_width))
6177 CHECK_NUMBER (right_width);
6178 if (XINT (right_width) <= 0)
6179 right_width = Qnil;
6182 if (!EQ (w->left_margin_cols, left_width)
6183 || !EQ (w->right_margin_cols, right_width))
6185 wset_left_margin_cols (w, left_width);
6186 wset_right_margin_cols (w, right_width);
6188 adjust_window_margins (w);
6190 ++windows_or_buffers_changed;
6191 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6194 return Qnil;
6198 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
6199 0, 1, 0,
6200 doc: /* Get width of marginal areas of window WINDOW.
6201 WINDOW must be a live window and defaults to the selected one.
6203 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6204 If a marginal area does not exist, its width will be returned
6205 as nil. */)
6206 (Lisp_Object window)
6208 struct window *w = decode_live_window (window);
6209 return Fcons (w->left_margin_cols, w->right_margin_cols);
6214 /***********************************************************************
6215 Fringes
6216 ***********************************************************************/
6218 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6219 2, 4, 0,
6220 doc: /* Set the fringe widths of window WINDOW.
6221 WINDOW must be a live window and defaults to the selected one.
6223 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6224 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6225 fringe width. If a fringe width arg is nil, that means to use the
6226 frame's default fringe width. Default fringe widths can be set with
6227 the command `set-fringe-style'.
6228 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6229 outside of the display margins. By default, fringes are drawn between
6230 display marginal areas and the text area. */)
6231 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width, Lisp_Object outside_margins)
6233 struct window *w = decode_live_window (window);
6234 int outside = !NILP (outside_margins);
6236 if (!NILP (left_width))
6237 CHECK_NATNUM (left_width);
6238 if (!NILP (right_width))
6239 CHECK_NATNUM (right_width);
6241 /* Do nothing on a tty. */
6242 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6243 && (!EQ (w->left_fringe_width, left_width)
6244 || !EQ (w->right_fringe_width, right_width)
6245 || w->fringes_outside_margins != outside))
6247 wset_left_fringe_width (w, left_width);
6248 wset_right_fringe_width (w, right_width);
6249 w->fringes_outside_margins = outside;
6251 adjust_window_margins (w);
6253 clear_glyph_matrix (w->current_matrix);
6254 w->window_end_valid = 0;
6256 ++windows_or_buffers_changed;
6257 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6260 return Qnil;
6264 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6265 0, 1, 0,
6266 doc: /* Get width of fringes of window WINDOW.
6267 WINDOW must be a live window and defaults to the selected one.
6269 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6270 (Lisp_Object window)
6272 struct window *w = decode_live_window (window);
6274 return list3 (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6275 make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6276 WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w) ? Qt : Qnil);
6281 /***********************************************************************
6282 Scroll bars
6283 ***********************************************************************/
6285 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars,
6286 Sset_window_scroll_bars, 2, 4, 0,
6287 doc: /* Set width and type of scroll bars of window WINDOW.
6288 WINDOW must be a live window and defaults to the selected one.
6290 Second parameter WIDTH specifies the pixel width for the scroll bar;
6291 this is automatically adjusted to a multiple of the frame column width.
6292 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6293 bar: left, right, or nil.
6294 If WIDTH is nil, use the frame's scroll-bar width.
6295 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6296 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6297 (Lisp_Object window, Lisp_Object width, Lisp_Object vertical_type, Lisp_Object horizontal_type)
6299 struct window *w = decode_live_window (window);
6301 if (!NILP (width))
6303 CHECK_RANGED_INTEGER (width, 0, INT_MAX);
6305 if (XINT (width) == 0)
6306 vertical_type = Qnil;
6309 if (!(NILP (vertical_type)
6310 || EQ (vertical_type, Qleft)
6311 || EQ (vertical_type, Qright)
6312 || EQ (vertical_type, Qt)))
6313 error ("Invalid type of vertical scroll bar");
6315 if (!EQ (w->scroll_bar_width, width)
6316 || !EQ (w->vertical_scroll_bar_type, vertical_type))
6318 wset_scroll_bar_width (w, width);
6319 wset_vertical_scroll_bar_type (w, vertical_type);
6321 adjust_window_margins (w);
6323 clear_glyph_matrix (w->current_matrix);
6324 w->window_end_valid = 0;
6326 ++windows_or_buffers_changed;
6327 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6330 return Qnil;
6334 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
6335 0, 1, 0,
6336 doc: /* Get width and type of scroll bars of window WINDOW.
6337 WINDOW must be a live window and defaults to the selected one.
6339 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6340 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6341 value. */)
6342 (Lisp_Object window)
6344 struct window *w = decode_live_window (window);
6346 return list4 (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6347 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6348 : WINDOW_SCROLL_BAR_AREA_WIDTH (w))),
6349 make_number (WINDOW_SCROLL_BAR_COLS (w)),
6350 w->vertical_scroll_bar_type, Qnil);
6355 /***********************************************************************
6356 Smooth scrolling
6357 ***********************************************************************/
6359 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
6360 doc: /* Return the amount by which WINDOW is scrolled vertically.
6361 If WINDOW is omitted or nil, it defaults to the selected window.
6362 Normally, value is a multiple of the canonical character height of WINDOW;
6363 optional second arg PIXELS-P means value is measured in pixels. */)
6364 (Lisp_Object window, Lisp_Object pixels_p)
6366 Lisp_Object result;
6367 struct window *w = decode_live_window (window);
6368 struct frame *f = XFRAME (w->frame);
6370 if (FRAME_WINDOW_P (f))
6371 result = (NILP (pixels_p)
6372 ? FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll)
6373 : make_number (-w->vscroll));
6374 else
6375 result = make_number (0);
6376 return result;
6380 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
6381 2, 3, 0,
6382 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
6383 WINDOW nil means use the selected window. Normally, VSCROLL is a
6384 non-negative multiple of the canonical character height of WINDOW;
6385 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
6386 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
6387 corresponds to an integral number of pixels. The return value is the
6388 result of this rounding.
6389 If PIXELS-P is non-nil, the return value is VSCROLL. */)
6390 (Lisp_Object window, Lisp_Object vscroll, Lisp_Object pixels_p)
6392 struct window *w = decode_live_window (window);
6393 struct frame *f = XFRAME (w->frame);
6395 CHECK_NUMBER_OR_FLOAT (vscroll);
6397 if (FRAME_WINDOW_P (f))
6399 int old_dy = w->vscroll;
6401 w->vscroll = - (NILP (pixels_p)
6402 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
6403 : XFLOATINT (vscroll));
6404 w->vscroll = min (w->vscroll, 0);
6406 if (w->vscroll != old_dy)
6408 /* Adjust glyph matrix of the frame if the virtual display
6409 area becomes larger than before. */
6410 if (w->vscroll < 0 && w->vscroll < old_dy)
6411 adjust_glyphs (f);
6413 /* Prevent redisplay shortcuts. */
6414 XBUFFER (w->contents)->prevent_redisplay_optimizations_p = 1;
6418 return Fwindow_vscroll (window, pixels_p);
6422 /* Call FN for all leaf windows on frame F. FN is called with the
6423 first argument being a pointer to the leaf window, and with
6424 additional argument USER_DATA. Stops when FN returns 0. */
6426 static void
6427 foreach_window (struct frame *f, int (*fn) (struct window *, void *),
6428 void *user_data)
6430 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6431 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
6432 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
6436 /* Helper function for foreach_window. Call FN for all leaf windows
6437 reachable from W. FN is called with the first argument being a
6438 pointer to the leaf window, and with additional argument USER_DATA.
6439 Stop when FN returns 0. Value is 0 if stopped by FN. */
6441 static int
6442 foreach_window_1 (struct window *w, int (*fn) (struct window *, void *), void *user_data)
6444 int cont;
6446 for (cont = 1; w && cont;)
6448 if (WINDOWP (w->contents))
6449 cont = foreach_window_1 (XWINDOW (w->contents), fn, user_data);
6450 else
6451 cont = fn (w, user_data);
6453 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6456 return cont;
6460 /* Freeze or unfreeze the window start of W unless it is a
6461 mini-window or the selected window. FREEZE_P non-null means freeze
6462 the window start. */
6464 static int
6465 freeze_window_start (struct window *w, void *freeze_p)
6467 if (MINI_WINDOW_P (w)
6468 || (WINDOWP (selected_window) /* Can be nil in corner cases. */
6469 && (w == XWINDOW (selected_window)
6470 || (MINI_WINDOW_P (XWINDOW (selected_window))
6471 && ! NILP (Vminibuf_scroll_window)
6472 && w == XWINDOW (Vminibuf_scroll_window)))))
6473 freeze_p = NULL;
6475 w->frozen_window_start_p = freeze_p != NULL;
6476 return 1;
6480 /* Freeze or unfreeze the window starts of all leaf windows on frame
6481 F, except the selected window and a mini-window. FREEZE_P non-zero
6482 means freeze the window start. */
6484 void
6485 freeze_window_starts (struct frame *f, bool freeze_p)
6487 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
6491 /***********************************************************************
6492 Initialization
6493 ***********************************************************************/
6495 /* Return 1 if window configurations CONFIGURATION1 and CONFIGURATION2
6496 describe the same state of affairs. This is used by Fequal.
6498 IGNORE_POSITIONS means ignore non-matching scroll positions
6499 and the like.
6501 This ignores a couple of things like the dedication status of
6502 window, combination_limit and the like. This might have to be
6503 fixed. */
6505 bool
6506 compare_window_configurations (Lisp_Object configuration1,
6507 Lisp_Object configuration2,
6508 bool ignore_positions)
6510 register struct save_window_data *d1, *d2;
6511 struct Lisp_Vector *sws1, *sws2;
6512 ptrdiff_t i;
6514 CHECK_WINDOW_CONFIGURATION (configuration1);
6515 CHECK_WINDOW_CONFIGURATION (configuration2);
6517 d1 = (struct save_window_data *) XVECTOR (configuration1);
6518 d2 = (struct save_window_data *) XVECTOR (configuration2);
6519 sws1 = XVECTOR (d1->saved_windows);
6520 sws2 = XVECTOR (d2->saved_windows);
6522 /* Frame settings must match. */
6523 if (d1->frame_cols != d2->frame_cols
6524 || d1->frame_lines != d2->frame_lines
6525 || d1->frame_menu_bar_lines != d2->frame_menu_bar_lines
6526 || !EQ (d1->selected_frame, d2->selected_frame)
6527 || !EQ (d1->current_buffer, d2->current_buffer)
6528 || (!ignore_positions
6529 && (!EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window)
6530 || !EQ (d1->minibuf_selected_window, d2->minibuf_selected_window)))
6531 || !EQ (d1->focus_frame, d2->focus_frame)
6532 /* Verify that the two configurations have the same number of windows. */
6533 || sws1->header.size != sws2->header.size)
6534 return 0;
6536 for (i = 0; i < sws1->header.size; i++)
6538 struct saved_window *sw1, *sw2;
6540 sw1 = SAVED_WINDOW_N (sws1, i);
6541 sw2 = SAVED_WINDOW_N (sws2, i);
6543 if (
6544 /* The "current" windows in the two configurations must
6545 correspond to each other. */
6546 EQ (d1->current_window, sw1->window)
6547 != EQ (d2->current_window, sw2->window)
6548 /* Windows' buffers must match. */
6549 || !EQ (sw1->buffer, sw2->buffer)
6550 || !EQ (sw1->left_col, sw2->left_col)
6551 || !EQ (sw1->top_line, sw2->top_line)
6552 || !EQ (sw1->total_cols, sw2->total_cols)
6553 || !EQ (sw1->total_lines, sw2->total_lines)
6554 || !EQ (sw1->display_table, sw2->display_table)
6555 /* The next two disjuncts check the window structure for
6556 equality. */
6557 || !EQ (sw1->parent, sw2->parent)
6558 || !EQ (sw1->prev, sw2->prev)
6559 || (!ignore_positions
6560 && (!EQ (sw1->hscroll, sw2->hscroll)
6561 || !EQ (sw1->min_hscroll, sw2->min_hscroll)
6562 || !EQ (sw1->start_at_line_beg, sw2->start_at_line_beg)
6563 || NILP (Fequal (sw1->start, sw2->start))
6564 || NILP (Fequal (sw1->pointm, sw2->pointm))
6565 || NILP (Fequal (sw1->mark, sw2->mark))))
6566 || !EQ (sw1->left_margin_cols, sw2->left_margin_cols)
6567 || !EQ (sw1->right_margin_cols, sw2->right_margin_cols)
6568 || !EQ (sw1->left_fringe_width, sw2->left_fringe_width)
6569 || !EQ (sw1->right_fringe_width, sw2->right_fringe_width)
6570 || !EQ (sw1->fringes_outside_margins, sw2->fringes_outside_margins)
6571 || !EQ (sw1->scroll_bar_width, sw2->scroll_bar_width)
6572 || !EQ (sw1->vertical_scroll_bar_type, sw2->vertical_scroll_bar_type))
6573 return 0;
6576 return 1;
6579 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
6580 Scompare_window_configurations, 2, 2, 0,
6581 doc: /* Compare two window configurations as regards the structure of windows.
6582 This function ignores details such as the values of point and mark
6583 and scrolling positions. */)
6584 (Lisp_Object x, Lisp_Object y)
6586 if (compare_window_configurations (x, y, 1))
6587 return Qt;
6588 return Qnil;
6591 void
6592 init_window_once (void)
6594 struct frame *f = make_initial_frame ();
6595 XSETFRAME (selected_frame, f);
6596 Vterminal_frame = selected_frame;
6597 minibuf_window = f->minibuffer_window;
6598 selected_window = f->selected_window;
6599 last_nonminibuf_frame = f;
6601 window_initialized = 1;
6604 void
6605 init_window (void)
6607 Vwindow_list = Qnil;
6610 void
6611 syms_of_window (void)
6613 DEFSYM (Qscroll_up, "scroll-up");
6614 DEFSYM (Qscroll_down, "scroll-down");
6615 DEFSYM (Qscroll_command, "scroll-command");
6617 Fput (Qscroll_up, Qscroll_command, Qt);
6618 Fput (Qscroll_down, Qscroll_command, Qt);
6620 DEFSYM (Qwindow_configuration_change_hook, "window-configuration-change-hook");
6621 DEFSYM (Qwindowp, "windowp");
6622 DEFSYM (Qwindow_configuration_p, "window-configuration-p");
6623 DEFSYM (Qwindow_live_p, "window-live-p");
6624 DEFSYM (Qwindow_valid_p, "window-valid-p");
6625 DEFSYM (Qwindow_deletable_p, "window-deletable-p");
6626 DEFSYM (Qdelete_window, "delete-window");
6627 DEFSYM (Qwindow_resize_root_window, "window--resize-root-window");
6628 DEFSYM (Qwindow_resize_root_window_vertically, "window--resize-root-window-vertically");
6629 DEFSYM (Qsafe, "safe");
6630 DEFSYM (Qdisplay_buffer, "display-buffer");
6631 DEFSYM (Qreplace_buffer_in_windows, "replace-buffer-in-windows");
6632 DEFSYM (Qrecord_window_buffer, "record-window-buffer");
6633 DEFSYM (Qget_mru_window, "get-mru-window");
6634 DEFSYM (Qwindow_size, "window-size");
6635 DEFSYM (Qtemp_buffer_show_hook, "temp-buffer-show-hook");
6636 DEFSYM (Qabove, "above");
6637 DEFSYM (Qbelow, "below");
6638 DEFSYM (Qclone_of, "clone-of");
6640 staticpro (&Vwindow_list);
6642 minibuf_selected_window = Qnil;
6643 staticpro (&minibuf_selected_window);
6645 window_scroll_pixel_based_preserve_x = -1;
6646 window_scroll_pixel_based_preserve_y = -1;
6647 window_scroll_preserve_hpos = -1;
6648 window_scroll_preserve_vpos = -1;
6650 DEFVAR_LISP ("temp-buffer-show-function", Vtemp_buffer_show_function,
6651 doc: /* Non-nil means call as function to display a help buffer.
6652 The function is called with one argument, the buffer to be displayed.
6653 Used by `with-output-to-temp-buffer'.
6654 If this function is used, then it must do the entire job of showing
6655 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
6656 Vtemp_buffer_show_function = Qnil;
6658 DEFVAR_LISP ("minibuffer-scroll-window", Vminibuf_scroll_window,
6659 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
6660 Vminibuf_scroll_window = Qnil;
6662 DEFVAR_BOOL ("mode-line-in-non-selected-windows", mode_line_in_non_selected_windows,
6663 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
6664 If the minibuffer is active, the `minibuffer-scroll-window' mode line
6665 is displayed in the `mode-line' face. */);
6666 mode_line_in_non_selected_windows = 1;
6668 DEFVAR_LISP ("other-window-scroll-buffer", Vother_window_scroll_buffer,
6669 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
6670 Vother_window_scroll_buffer = Qnil;
6672 DEFVAR_BOOL ("auto-window-vscroll", auto_window_vscroll_p,
6673 doc: /* Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
6674 auto_window_vscroll_p = 1;
6676 DEFVAR_INT ("next-screen-context-lines", next_screen_context_lines,
6677 doc: /* Number of lines of continuity when scrolling by screenfuls. */);
6678 next_screen_context_lines = 2;
6680 DEFVAR_LISP ("scroll-preserve-screen-position",
6681 Vscroll_preserve_screen_position,
6682 doc: /* Controls if scroll commands move point to keep its screen position unchanged.
6683 A value of nil means point does not keep its screen position except
6684 at the scroll margin or window boundary respectively.
6685 A value of t means point keeps its screen position if the scroll
6686 command moved it vertically out of the window, e.g. when scrolling
6687 by full screens.
6688 Any other value means point always keeps its screen position.
6689 Scroll commands should have the `scroll-command' property
6690 on their symbols to be controlled by this variable. */);
6691 Vscroll_preserve_screen_position = Qnil;
6693 DEFVAR_LISP ("window-point-insertion-type", Vwindow_point_insertion_type,
6694 doc: /* Type of marker to use for `window-point'. */);
6695 Vwindow_point_insertion_type = Qnil;
6697 DEFVAR_LISP ("window-configuration-change-hook",
6698 Vwindow_configuration_change_hook,
6699 doc: /* Functions to call when window configuration changes.
6700 The buffer-local part is run once per window, with the relevant window
6701 selected; while the global part is run only once for the modified frame,
6702 with the relevant frame selected. */);
6703 Vwindow_configuration_change_hook = Qnil;
6705 DEFVAR_LISP ("recenter-redisplay", Vrecenter_redisplay,
6706 doc: /* Non-nil means `recenter' redraws entire frame.
6707 If this option is non-nil, then the `recenter' command with a nil
6708 argument will redraw the entire frame; the special value `tty' causes
6709 the frame to be redrawn only if it is a tty frame. */);
6710 Vrecenter_redisplay = Qtty;
6712 DEFVAR_LISP ("window-combination-resize", Vwindow_combination_resize,
6713 doc: /* If t, resize window combinations proportionally.
6714 If this variable is nil, splitting a window gets the entire screen space
6715 for displaying the new window from the window to split. Deleting and
6716 resizing a window preferably resizes one adjacent window only.
6718 If this variable is t, splitting a window tries to get the space
6719 proportionally from all windows in the same combination. This also
6720 allows to split a window that is otherwise too small or of fixed size.
6721 Resizing and deleting a window proportionally resize all windows in the
6722 same combination.
6724 Other values are reserved for future use.
6726 This variable takes no effect if the variable `window-combination-limit' is
6727 non-nil. */);
6728 Vwindow_combination_resize = Qnil;
6730 DEFVAR_LISP ("window-combination-limit", Vwindow_combination_limit,
6731 doc: /* If non-nil, splitting a window makes a new parent window.
6732 The following values are recognized:
6734 nil means splitting a window will create a new parent window only if the
6735 window has no parent window or the window shall become part of a
6736 combination orthogonal to the one it is part of.
6738 `window-size' means that splitting a window for displaying a buffer
6739 makes a new parent window provided `display-buffer' is supposed to
6740 explicitly set the window's size due to the presence of a
6741 `window-height' or `window-width' entry in the alist used by
6742 `display-buffer'. Otherwise, this value is handled like nil.
6744 `temp-buffer' means that splitting a window for displaying a temporary
6745 buffer always makes a new parent window. Otherwise, this value is
6746 handled like nil.
6748 `display-buffer' means that splitting a window for displaying a buffer
6749 always makes a new parent window. Since temporary buffers are
6750 displayed by the function `display-buffer', this value is stronger
6751 than `temp-buffer'. Splitting a window for other purpose makes a
6752 new parent window only if needed.
6754 t means that splitting a window always creates a new parent window. If
6755 all splits behave this way, each frame's window tree is a binary
6756 tree and every window but the frame's root window has exactly one
6757 sibling.
6759 Other values are reserved for future use. */);
6760 Vwindow_combination_limit = Qwindow_size;
6762 DEFVAR_LISP ("window-persistent-parameters", Vwindow_persistent_parameters,
6763 doc: /* Alist of persistent window parameters.
6764 This alist specifies which window parameters shall get saved by
6765 `current-window-configuration' and `window-state-get' and subsequently
6766 restored to their previous values by `set-window-configuration' and
6767 `window-state-put'.
6769 The car of each entry of this alist is the symbol specifying the
6770 parameter. The cdr is one of the following:
6772 nil means the parameter is neither saved by `window-state-get' nor by
6773 `current-window-configuration'.
6775 t means the parameter is saved by `current-window-configuration' and,
6776 provided its WRITABLE argument is nil, by `window-state-get'.
6778 The symbol `writable' means the parameter is saved unconditionally by
6779 both `current-window-configuration' and `window-state-get'. Do not use
6780 this value for parameters without read syntax (like windows or frames).
6782 Parameters not saved by `current-window-configuration' or
6783 `window-state-get' are left alone by `set-window-configuration'
6784 respectively are not installed by `window-state-put'. */);
6785 Vwindow_persistent_parameters = list1 (Fcons (Qclone_of, Qt));
6787 defsubr (&Sselected_window);
6788 defsubr (&Sminibuffer_window);
6789 defsubr (&Swindow_minibuffer_p);
6790 defsubr (&Swindowp);
6791 defsubr (&Swindow_valid_p);
6792 defsubr (&Swindow_live_p);
6793 defsubr (&Swindow_frame);
6794 defsubr (&Sframe_root_window);
6795 defsubr (&Sframe_first_window);
6796 defsubr (&Sframe_selected_window);
6797 defsubr (&Sset_frame_selected_window);
6798 defsubr (&Spos_visible_in_window_p);
6799 defsubr (&Swindow_line_height);
6800 defsubr (&Swindow_buffer);
6801 defsubr (&Swindow_parent);
6802 defsubr (&Swindow_top_child);
6803 defsubr (&Swindow_left_child);
6804 defsubr (&Swindow_next_sibling);
6805 defsubr (&Swindow_prev_sibling);
6806 defsubr (&Swindow_combination_limit);
6807 defsubr (&Sset_window_combination_limit);
6808 defsubr (&Swindow_use_time);
6809 defsubr (&Swindow_top_line);
6810 defsubr (&Swindow_left_column);
6811 defsubr (&Swindow_total_height);
6812 defsubr (&Swindow_total_width);
6813 defsubr (&Swindow_normal_size);
6814 defsubr (&Swindow_new_total);
6815 defsubr (&Swindow_new_normal);
6816 defsubr (&Sset_window_new_total);
6817 defsubr (&Sset_window_new_normal);
6818 defsubr (&Swindow_resize_apply);
6819 defsubr (&Swindow_body_height);
6820 defsubr (&Swindow_body_width);
6821 defsubr (&Swindow_hscroll);
6822 defsubr (&Sset_window_hscroll);
6823 defsubr (&Swindow_redisplay_end_trigger);
6824 defsubr (&Sset_window_redisplay_end_trigger);
6825 defsubr (&Swindow_edges);
6826 defsubr (&Swindow_pixel_edges);
6827 defsubr (&Swindow_absolute_pixel_edges);
6828 defsubr (&Swindow_inside_edges);
6829 defsubr (&Swindow_inside_pixel_edges);
6830 defsubr (&Swindow_inside_absolute_pixel_edges);
6831 defsubr (&Scoordinates_in_window_p);
6832 defsubr (&Swindow_at);
6833 defsubr (&Swindow_point);
6834 defsubr (&Swindow_start);
6835 defsubr (&Swindow_end);
6836 defsubr (&Sset_window_point);
6837 defsubr (&Sset_window_start);
6838 defsubr (&Swindow_dedicated_p);
6839 defsubr (&Sset_window_dedicated_p);
6840 defsubr (&Swindow_display_table);
6841 defsubr (&Sset_window_display_table);
6842 defsubr (&Snext_window);
6843 defsubr (&Sprevious_window);
6844 defsubr (&Sget_buffer_window);
6845 defsubr (&Sdelete_other_windows_internal);
6846 defsubr (&Sdelete_window_internal);
6847 defsubr (&Sresize_mini_window_internal);
6848 defsubr (&Sset_window_buffer);
6849 defsubr (&Srun_window_configuration_change_hook);
6850 defsubr (&Sselect_window);
6851 defsubr (&Sforce_window_update);
6852 defsubr (&Ssplit_window_internal);
6853 defsubr (&Sscroll_up);
6854 defsubr (&Sscroll_down);
6855 defsubr (&Sscroll_left);
6856 defsubr (&Sscroll_right);
6857 defsubr (&Sother_window_for_scrolling);
6858 defsubr (&Sscroll_other_window);
6859 defsubr (&Sminibuffer_selected_window);
6860 defsubr (&Srecenter);
6861 defsubr (&Swindow_text_height);
6862 defsubr (&Smove_to_window_line);
6863 defsubr (&Swindow_configuration_p);
6864 defsubr (&Swindow_configuration_frame);
6865 defsubr (&Sset_window_configuration);
6866 defsubr (&Scurrent_window_configuration);
6867 defsubr (&Sset_window_margins);
6868 defsubr (&Swindow_margins);
6869 defsubr (&Sset_window_fringes);
6870 defsubr (&Swindow_fringes);
6871 defsubr (&Sset_window_scroll_bars);
6872 defsubr (&Swindow_scroll_bars);
6873 defsubr (&Swindow_vscroll);
6874 defsubr (&Sset_window_vscroll);
6875 defsubr (&Scompare_window_configurations);
6876 defsubr (&Swindow_list);
6877 defsubr (&Swindow_list_1);
6878 defsubr (&Swindow_prev_buffers);
6879 defsubr (&Sset_window_prev_buffers);
6880 defsubr (&Swindow_next_buffers);
6881 defsubr (&Sset_window_next_buffers);
6882 defsubr (&Swindow_parameters);
6883 defsubr (&Swindow_parameter);
6884 defsubr (&Sset_window_parameter);
6887 void
6888 keys_of_window (void)
6890 initial_define_key (control_x_map, '<', "scroll-left");
6891 initial_define_key (control_x_map, '>', "scroll-right");
6893 initial_define_key (global_map, Ctl ('V'), "scroll-up-command");
6894 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
6895 initial_define_key (meta_map, 'v', "scroll-down-command");