Improve doc strings for completion styles.
[emacs.git] / src / window.c
blobba06779846ac94ed7d344de1c4492466db63748b
1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985-1987, 1993-1998, 2000-2011
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <stdio.h>
23 #include <setjmp.h>
25 #include "lisp.h"
26 #include "buffer.h"
27 #include "keyboard.h"
28 #include "keymap.h"
29 #include "frame.h"
30 #include "window.h"
31 #include "commands.h"
32 #include "indent.h"
33 #include "termchar.h"
34 #include "disptab.h"
35 #include "dispextern.h"
36 #include "blockinput.h"
37 #include "intervals.h"
38 #include "termhooks.h" /* For FRAME_TERMINAL. */
40 #ifdef HAVE_X_WINDOWS
41 #include "xterm.h"
42 #endif /* HAVE_X_WINDOWS */
43 #ifdef WINDOWSNT
44 #include "w32term.h"
45 #endif
46 #ifdef MSDOS
47 #include "msdos.h"
48 #endif
49 #ifdef HAVE_NS
50 #include "nsterm.h"
51 #endif
53 Lisp_Object Qwindowp, Qwindow_live_p;
54 static Lisp_Object Qwindow_configuration_p, Qrecord_window_buffer;
55 static Lisp_Object Qwindow_deletable_p, Qdelete_window, Qdisplay_buffer;
56 static Lisp_Object Qreplace_buffer_in_windows, Qget_mru_window;
57 static Lisp_Object Qwindow_resize_root_window, Qwindow_resize_root_window_vertically;
58 static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
59 static Lisp_Object Qsafe, Qabove, Qbelow;
60 static Lisp_Object Qauto_buffer_name;
62 static int displayed_window_lines (struct window *);
63 static struct window *decode_window (Lisp_Object);
64 static int count_windows (struct window *);
65 static int get_leaf_windows (struct window *, struct window **, int);
66 static void window_scroll (Lisp_Object, int, int, int);
67 static void window_scroll_pixel_based (Lisp_Object, int, int, int);
68 static void window_scroll_line_based (Lisp_Object, int, int, int);
69 static int freeze_window_start (struct window *, void *);
70 static Lisp_Object window_list (void);
71 static int add_window_to_list (struct window *, void *);
72 static int candidate_window_p (Lisp_Object, Lisp_Object, Lisp_Object,
73 Lisp_Object);
74 static Lisp_Object next_window (Lisp_Object, Lisp_Object,
75 Lisp_Object, int);
76 static void decode_next_window_args (Lisp_Object *, Lisp_Object *,
77 Lisp_Object *);
78 static void foreach_window (struct frame *,
79 int (* fn) (struct window *, void *),
80 void *);
81 static int foreach_window_1 (struct window *,
82 int (* fn) (struct window *, void *),
83 void *);
84 static Lisp_Object window_list_1 (Lisp_Object, Lisp_Object, Lisp_Object);
85 static int window_resize_check (struct window *, int);
86 static void window_resize_apply (struct window *, int);
87 static Lisp_Object select_window (Lisp_Object, Lisp_Object, int);
89 /* This is the window in which the terminal's cursor should
90 be left when nothing is being done with it. This must
91 always be a leaf window, and its buffer is selected by
92 the top level editing loop at the end of each command.
94 This value is always the same as
95 FRAME_SELECTED_WINDOW (selected_frame). */
96 Lisp_Object selected_window;
98 /* A list of all windows for use by next_window and Fwindow_list.
99 Functions creating or deleting windows should invalidate this cache
100 by setting it to nil. */
101 Lisp_Object Vwindow_list;
103 /* The mini-buffer window of the selected frame.
104 Note that you cannot test for mini-bufferness of an arbitrary window
105 by comparing against this; but you can test for mini-bufferness of
106 the selected window. */
107 Lisp_Object minibuf_window;
109 /* Non-nil means it is the window whose mode line should be
110 shown as the selected window when the minibuffer is selected. */
111 Lisp_Object minibuf_selected_window;
113 /* Hook run at end of temp_output_buffer_show. */
114 static Lisp_Object Qtemp_buffer_show_hook;
116 /* Incremented for each window created. */
117 static int sequence_number;
119 /* Nonzero after init_window_once has finished. */
120 static int window_initialized;
122 /* Hook to run when window config changes. */
123 static Lisp_Object Qwindow_configuration_change_hook;
125 /* Used by the function window_scroll_pixel_based */
126 static int window_scroll_pixel_based_preserve_x;
127 static int window_scroll_pixel_based_preserve_y;
129 /* Same for window_scroll_line_based. */
130 static int window_scroll_preserve_hpos;
131 static int window_scroll_preserve_vpos;
133 static struct window *
134 decode_window (register Lisp_Object window)
136 if (NILP (window))
137 return XWINDOW (selected_window);
139 CHECK_LIVE_WINDOW (window);
140 return XWINDOW (window);
143 static struct window *
144 decode_any_window (register Lisp_Object window)
146 if (NILP (window))
147 return XWINDOW (selected_window);
149 CHECK_WINDOW (window);
150 return XWINDOW (window);
153 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
154 doc: /* Return t if OBJECT is a window and nil otherwise. */)
155 (Lisp_Object object)
157 return WINDOWP (object) ? Qt : Qnil;
160 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
161 doc: /* Return t if OBJECT is a live window and nil otherwise.
162 A live window is a window that displays a buffer. */)
163 (Lisp_Object object)
165 return WINDOW_LIVE_P (object) ? Qt : Qnil;
168 /* Frames and windows. */
169 DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 1, 1, 0,
170 doc: /* Return the frame that window WINDOW is on.
171 WINDOW can be any window and defaults to the selected one. */)
172 (Lisp_Object window)
174 return decode_any_window (window)->frame;
177 DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
178 doc: /* Return the root window of FRAME_OR_WINDOW.
179 If omitted, FRAME_OR_WINDOW defaults to the currently selected frame.
180 Else if FRAME_OR_WINDOW denotes any window, return the root window of
181 that window's frame. If FRAME_OR_WINDOW denotes a live frame, return
182 the root window of that frame. */)
183 (Lisp_Object frame_or_window)
185 Lisp_Object window;
187 if (NILP (frame_or_window))
188 window = SELECTED_FRAME ()->root_window;
189 else if (WINDOWP (frame_or_window))
190 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
191 else
193 CHECK_LIVE_FRAME (frame_or_window);
194 window = XFRAME (frame_or_window)->root_window;
197 return window;
200 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
201 doc: /* Return the window used now for minibuffers.
202 If the optional argument FRAME is specified, return the minibuffer window
203 used by that frame. */)
204 (Lisp_Object frame)
206 if (NILP (frame))
207 frame = selected_frame;
208 CHECK_LIVE_FRAME (frame);
209 return FRAME_MINIBUF_WINDOW (XFRAME (frame));
212 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
213 Swindow_minibuffer_p, 0, 1, 0,
214 doc: /* Return non-nil if WINDOW is a minibuffer window.
215 WINDOW can be any window and defaults to the selected one. */)
216 (Lisp_Object window)
218 return MINI_WINDOW_P (decode_any_window (window)) ? Qt : Qnil;
221 /* Don't move this to window.el - this must be a safe routine. */
222 DEFUN ("frame-first-window", Fframe_first_window, Sframe_first_window, 0, 1, 0,
223 doc: /* Return the topmost, leftmost live window on FRAME_OR_WINDOW.
224 If omitted, FRAME_OR_WINDOW defaults to the currently selected frame.
225 Else if FRAME_OR_WINDOW denotes any window, return the first window of
226 that window's frame. If FRAME_OR_WINDOW denotes a live frame, return
227 the first window of that frame. */)
228 (Lisp_Object frame_or_window)
230 Lisp_Object window;
232 if (NILP (frame_or_window))
233 window = SELECTED_FRAME ()->root_window;
234 else if (WINDOWP (frame_or_window))
235 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
236 else
238 CHECK_LIVE_FRAME (frame_or_window);
239 window = XFRAME (frame_or_window)->root_window;
242 while (NILP (XWINDOW (window)->buffer))
244 if (! NILP (XWINDOW (window)->hchild))
245 window = XWINDOW (window)->hchild;
246 else if (! NILP (XWINDOW (window)->vchild))
247 window = XWINDOW (window)->vchild;
248 else
249 abort ();
252 return window;
255 DEFUN ("frame-selected-window", Fframe_selected_window,
256 Sframe_selected_window, 0, 1, 0,
257 doc: /* Return the selected window of FRAME_OR_WINDOW.
258 If omitted, FRAME_OR_WINDOW defaults to the currently selected frame.
259 Else if FRAME_OR_WINDOW denotes any window, return the selected window
260 of that window's frame. If FRAME_OR_WINDOW denotes a live frame, return
261 the selected window of that frame. */)
262 (Lisp_Object frame_or_window)
264 Lisp_Object window;
266 if (NILP (frame_or_window))
267 window = SELECTED_FRAME ()->selected_window;
268 else if (WINDOWP (frame_or_window))
269 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
270 else
272 CHECK_LIVE_FRAME (frame_or_window);
273 window = XFRAME (frame_or_window)->selected_window;
276 return window;
279 DEFUN ("set-frame-selected-window", Fset_frame_selected_window,
280 Sset_frame_selected_window, 2, 3, 0,
281 doc: /* Set selected window of FRAME to WINDOW.
282 FRAME must be a live frame and defaults to the selected one. If FRAME
283 is the selected frame, this makes WINDOW the selected window. Optional
284 argument NORECORD non-nil means to neither change the order of recently
285 selected windows nor the buffer list. WINDOW must denote a live window.
286 Return WINDOW. */)
287 (Lisp_Object frame, Lisp_Object window, Lisp_Object norecord)
289 if (NILP (frame))
290 frame = selected_frame;
292 CHECK_LIVE_FRAME (frame);
293 CHECK_LIVE_WINDOW (window);
295 if (! EQ (frame, WINDOW_FRAME (XWINDOW (window))))
296 error ("In `set-frame-selected-window', WINDOW is not on FRAME");
298 if (EQ (frame, selected_frame))
299 return Fselect_window (window, norecord);
300 else
301 return XFRAME (frame)->selected_window = window;
304 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
305 doc: /* Return the selected window.
306 The selected window is the window in which the standard cursor for
307 selected windows appears and to which many commands apply. */)
308 (void)
310 return selected_window;
313 int window_select_count;
315 /* If select_window is called with inhibit_point_swap non-zero it will
316 not store point of the old selected window's buffer back into that
317 window's pointm slot. This is needed by Fset_window_configuration to
318 avoid that the display routine is called with selected_window set to
319 Qnil causing a subsequent crash. */
320 static Lisp_Object
321 select_window (Lisp_Object window, Lisp_Object norecord, int inhibit_point_swap)
323 register struct window *w;
324 register struct window *ow;
325 struct frame *sf;
327 CHECK_LIVE_WINDOW (window);
329 w = XWINDOW (window);
330 w->frozen_window_start_p = 0;
332 if (NILP (norecord))
334 ++window_select_count;
335 XSETFASTINT (w->use_time, window_select_count);
336 record_buffer (w->buffer);
339 if (EQ (window, selected_window) && !inhibit_point_swap)
340 return window;
342 sf = SELECTED_FRAME ();
343 if (XFRAME (WINDOW_FRAME (w)) != sf)
345 XFRAME (WINDOW_FRAME (w))->selected_window = window;
346 /* Use this rather than Fhandle_switch_frame
347 so that FRAME_FOCUS_FRAME is moved appropriately as we
348 move around in the state where a minibuffer in a separate
349 frame is active. */
350 Fselect_frame (WINDOW_FRAME (w), norecord);
351 /* Fselect_frame called us back so we've done all the work already. */
352 eassert (EQ (window, selected_window));
353 return window;
355 else
356 sf->selected_window = window;
358 /* Store the current buffer's actual point into the
359 old selected window. It belongs to that window,
360 and when the window is not selected, must be in the window. */
361 if (!inhibit_point_swap)
363 ow = XWINDOW (selected_window);
364 if (! NILP (ow->buffer))
365 set_marker_both (ow->pointm, ow->buffer,
366 BUF_PT (XBUFFER (ow->buffer)),
367 BUF_PT_BYTE (XBUFFER (ow->buffer)));
370 selected_window = window;
372 Fset_buffer (w->buffer);
374 BVAR (XBUFFER (w->buffer), last_selected_window) = window;
376 /* Go to the point recorded in the window.
377 This is important when the buffer is in more
378 than one window. It also matters when
379 redisplay_window has altered point after scrolling,
380 because it makes the change only in the window. */
382 register EMACS_INT new_point = marker_position (w->pointm);
383 if (new_point < BEGV)
384 SET_PT (BEGV);
385 else if (new_point > ZV)
386 SET_PT (ZV);
387 else
388 SET_PT (new_point);
391 windows_or_buffers_changed++;
392 return window;
395 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
396 doc: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
397 Also make WINDOW's buffer current and make WINDOW the frame's selected
398 window. Return WINDOW.
400 Optional second arg NORECORD non-nil means do not put this buffer at the
401 front of the buffer list and do not make this window the most recently
402 selected one.
404 Note that the main editor command loop sets the current buffer to the
405 buffer of the selected window before each command. */)
406 (register Lisp_Object window, Lisp_Object norecord)
408 return select_window (window, norecord, 0);
411 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
412 doc: /* Return the buffer that WINDOW is displaying.
413 WINDOW can be any window and defaults to the selected one.
414 If WINDOW is an internal window return nil. */)
415 (Lisp_Object window)
417 return decode_any_window (window)->buffer;
420 DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
421 doc: /* Return WINDOW's parent window.
422 WINDOW can be any window and defaults to the selected one.
423 Return nil if WINDOW has no parent. */)
424 (Lisp_Object window)
426 return decode_any_window (window)->parent;
429 DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
430 doc: /* Return WINDOW's topmost child window.
431 WINDOW can be any window and defaults to the selected one.
432 Return nil if WINDOW is not a vertical combination. */)
433 (Lisp_Object window)
435 return decode_any_window (window)->vchild;
438 DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
439 doc: /* Return WINDOW's leftmost child window.
440 WINDOW can be any window and defaults to the selected one.
441 Return nil if WINDOW is not a horizontal combination. */)
442 (Lisp_Object window)
444 return decode_any_window (window)->hchild;
447 DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
448 doc: /* Return WINDOW's next sibling window.
449 WINDOW can be any window and defaults to the selected one.
450 Return nil if WINDOW has no next sibling. */)
451 (Lisp_Object window)
453 return decode_any_window (window)->next;
456 DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
457 doc: /* Return WINDOW's previous sibling window.
458 WINDOW can be any window and defaults to the selected one.
459 Return nil if WINDOW has no previous sibling. */)
460 (Lisp_Object window)
462 return decode_any_window (window)->prev;
465 DEFUN ("window-splits", Fwindow_splits, Swindow_splits, 0, 1, 0,
466 doc: /* Return splits status for WINDOW.
467 WINDOW can be any window and defaults to the selected one.
469 If the value returned by this function is nil and WINDOW is resized, the
470 corresponding space is preferably taken from (or given to) WINDOW's
471 right sibling. When WINDOW is deleted, its space is given to its left
472 sibling.
474 If the value returned by this function is non-nil, resizing and deleting
475 WINDOW may resize all windows in the same combination. */)
476 (Lisp_Object window)
478 return decode_any_window (window)->splits;
481 DEFUN ("set-window-splits", Fset_window_splits, Sset_window_splits, 2, 2, 0,
482 doc: /* Set splits status of WINDOW to STATUS.
483 WINDOW can be any window and defaults to the selected one. Return
484 STATUS.
486 If STATUS is nil and WINDOW is later resized, the corresponding space is
487 preferably taken from (or given to) WINDOW's right sibling. When WINDOW
488 is deleted, its space is given to its left sibling.
490 If STATUS is non-nil, resizing and deleting WINDOW may resize all
491 windows in the same combination. */)
492 (Lisp_Object window, Lisp_Object status)
494 register struct window *w = decode_any_window (window);
496 w->splits = status;
498 return w->splits;
501 DEFUN ("window-nest", Fwindow_nest, Swindow_nest, 0, 1, 0,
502 doc: /* Return nest status of WINDOW.
503 WINDOW can be any window and defaults to the selected one.
505 If the return value is nil, subwindows of WINDOW can be recombined with
506 WINDOW's siblings. A return value of non-nil means that subwindows of
507 WINDOW are never \(re-)combined with WINDOW's siblings. */)
508 (Lisp_Object window)
510 return decode_any_window (window)->nest;
513 DEFUN ("set-window-nest", Fset_window_nest, Sset_window_nest, 2, 2, 0,
514 doc: /* Set nest status of WINDOW to STATUS.
515 WINDOW can be any window and defaults to the selected one. Return
516 STATUS.
518 If STATUS is nil, subwindows of WINDOW can be recombined with WINDOW's
519 siblings. STATUS non-nil means that subwindows of WINDOW are never
520 \(re-)combined with WINDOW's siblings. */)
521 (Lisp_Object window, Lisp_Object status)
523 register struct window *w = decode_any_window (window);
525 w->nest = status;
527 return w->nest;
530 DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
531 doc: /* Return WINDOW's use time.
532 WINDOW defaults to the selected window. The window with the highest use
533 time is the most recently selected one. The window with the lowest use
534 time is the least recently selected one. */)
535 (Lisp_Object window)
537 return decode_window (window)->use_time;
540 DEFUN ("window-total-size", Fwindow_total_size, Swindow_total_size, 0, 2, 0,
541 doc: /* Return the total number of lines of WINDOW.
542 WINDOW can be any window and defaults to the selected one. The return
543 value includes WINDOW's mode line and header line, if any. If WINDOW
544 is internal, the return value is the sum of the total number of lines
545 of WINDOW's child windows if these are vertically combined and the
546 height of WINDOW's first child otherwise.
548 Optional argument HORIZONTAL non-nil means return the total number of
549 columns of WINDOW. In this case the return value includes any vertical
550 dividers or scrollbars of WINDOW. If WINDOW is internal, the return
551 value is the sum of the total number of columns of WINDOW's child
552 windows if they are horizontally combined and the width of WINDOW's
553 first child otherwise. */)
554 (Lisp_Object window, Lisp_Object horizontal)
556 if (NILP (horizontal))
557 return decode_any_window (window)->total_lines;
558 else
559 return decode_any_window (window)->total_cols;
562 DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
563 doc: /* Return new total size of WINDOW.
564 WINDOW defaults to the selected window. */)
565 (Lisp_Object window)
567 return decode_any_window (window)->new_total;
570 DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
571 doc: /* Return normal height of WINDOW.
572 WINDOW can be any window and defaults to the selected one. Optional
573 argument HORIZONTAL non-nil means return normal width of WINDOW. */)
574 (Lisp_Object window, Lisp_Object horizontal)
576 if (NILP (horizontal))
577 return decode_any_window (window)->normal_lines;
578 else
579 return decode_any_window (window)->normal_cols;
582 DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
583 doc: /* Return new normal size of WINDOW.
584 WINDOW can be any window and defaults to the selected one. */)
585 (Lisp_Object window)
587 return decode_any_window (window)->new_normal;
590 DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
591 doc: /* Return left column of WINDOW.
592 WINDOW can be any window and defaults to the selected one. */)
593 (Lisp_Object window)
595 return decode_any_window (window)->left_col;
598 DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
599 doc: /* Return top line of WINDOW.
600 WINDOW can be any window and defaults to the selected one. */)
601 (Lisp_Object window)
603 return decode_any_window (window)->top_line;
606 /* Return the number of lines of W's body. Don't count any mode or
607 header line of W. */
609 static int
610 window_body_lines (struct window *w)
612 int height = XFASTINT (w->total_lines);
614 if (!MINI_WINDOW_P (w))
616 if (WINDOW_WANTS_MODELINE_P (w))
617 --height;
618 if (WINDOW_WANTS_HEADER_LINE_P (w))
619 --height;
622 return height;
625 /* Return the number of columns of W's body. Don't count columns
626 occupied by the scroll bar or the vertical bar separating W from its
627 right sibling. On window-systems don't count fringes or display
628 margins either. */
631 window_body_cols (struct window *w)
633 struct frame *f = XFRAME (WINDOW_FRAME (w));
634 int width = XINT (w->total_cols);
636 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
637 /* Scroll bars occupy a few columns. */
638 width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
639 else if (!FRAME_WINDOW_P (f)
640 && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
641 /* The column of `|' characters separating side-by-side windows
642 occupies one column only. */
643 width -= 1;
645 if (FRAME_WINDOW_P (f))
646 /* On window-systems, fringes and display margins cannot be
647 used for normal text. */
648 width -= (WINDOW_FRINGE_COLS (w)
649 + WINDOW_LEFT_MARGIN_COLS (w)
650 + WINDOW_RIGHT_MARGIN_COLS (w));
652 return width;
655 DEFUN ("window-body-size", Fwindow_body_size, Swindow_body_size, 0, 2, 0,
656 doc: /* Return the number of lines of WINDOW's body.
657 WINDOW must be a live window and defaults to the selected one. The
658 return value does not include WINDOW's mode line and header line, if
659 any.
661 Optional argument HORIZONTAL non-nil means return the number of columns
662 of WINDOW's body. In this case, the return value does not include any
663 vertical dividers or scroll bars owned by WINDOW. On a window-system
664 the return value does not include the number of columns used for
665 WINDOW's fringes or display margins either. */)
666 (Lisp_Object window, Lisp_Object horizontal)
668 struct window *w = decode_any_window (window);
670 if (NILP (horizontal))
671 return make_number (window_body_lines (w));
672 else
673 return make_number (window_body_cols (w));
676 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
677 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
678 WINDOW must be a live window and defaults to the selected one. */)
679 (Lisp_Object window)
681 return decode_window (window)->hscroll;
684 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
685 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
686 If WINDOW is nil, the selected window is used.
687 Return NCOL. NCOL should be zero or positive.
689 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
690 window so that the location of point moves off-window. */)
691 (Lisp_Object window, Lisp_Object ncol)
693 struct window *w = decode_window (window);
694 int hscroll;
696 CHECK_NUMBER (ncol);
697 hscroll = max (0, XINT (ncol));
699 /* Prevent redisplay shortcuts when changing the hscroll. */
700 if (XINT (w->hscroll) != hscroll)
701 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
703 w->hscroll = make_number (hscroll);
704 return ncol;
707 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
708 Swindow_redisplay_end_trigger, 0, 1, 0,
709 doc: /* Return WINDOW's redisplay end trigger value.
710 WINDOW defaults to the selected window.
711 See `set-window-redisplay-end-trigger' for more information. */)
712 (Lisp_Object window)
714 return decode_window (window)->redisplay_end_trigger;
717 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
718 Sset_window_redisplay_end_trigger, 2, 2, 0,
719 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
720 VALUE should be a buffer position (typically a marker) or nil.
721 If it is a buffer position, then if redisplay in WINDOW reaches a position
722 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
723 with two arguments: WINDOW, and the end trigger value.
724 Afterwards the end-trigger value is reset to nil. */)
725 (register Lisp_Object window, Lisp_Object value)
727 register struct window *w;
729 w = decode_window (window);
730 w->redisplay_end_trigger = value;
731 return value;
734 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
735 doc: /* Return a list of the edge coordinates of WINDOW.
736 The list has the form (LEFT TOP RIGHT BOTTOM).
737 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
738 all relative to 0, 0 at top left corner of frame.
740 RIGHT is one more than the rightmost column occupied by WINDOW.
741 BOTTOM is one more than the bottommost row occupied by WINDOW.
742 The edges include the space used by WINDOW's scroll bar, display
743 margins, fringes, header line, and/or mode line. For the edges of
744 just the text area, use `window-inside-edges'. */)
745 (Lisp_Object window)
747 register struct window *w = decode_any_window (window);
749 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
750 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
751 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
752 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
753 Qnil))));
756 DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
757 doc: /* Return a list of the edge pixel coordinates of WINDOW.
758 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
759 the top left corner of the frame.
761 RIGHT is one more than the rightmost x position occupied by WINDOW.
762 BOTTOM is one more than the bottommost y position occupied by WINDOW.
763 The pixel edges include the space used by WINDOW's scroll bar, display
764 margins, fringes, header line, and/or mode line. For the pixel edges
765 of just the text area, use `window-inside-pixel-edges'. */)
766 (Lisp_Object window)
768 register struct window *w = decode_any_window (window);
770 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
771 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
772 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
773 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
774 Qnil))));
777 static void
778 calc_absolute_offset (struct window *w, int *add_x, int *add_y)
780 struct frame *f = XFRAME (w->frame);
781 *add_y = f->top_pos;
782 #ifdef FRAME_MENUBAR_HEIGHT
783 *add_y += FRAME_MENUBAR_HEIGHT (f);
784 #endif
785 #ifdef FRAME_TOOLBAR_TOP_HEIGHT
786 *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
787 #elif FRAME_TOOLBAR_HEIGHT
788 *add_y += FRAME_TOOLBAR_HEIGHT (f);
789 #endif
790 #ifdef FRAME_NS_TITLEBAR_HEIGHT
791 *add_y += FRAME_NS_TITLEBAR_HEIGHT (f);
792 #endif
793 *add_x = f->left_pos;
794 #ifdef FRAME_TOOLBAR_LEFT_WIDTH
795 *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
796 #endif
799 DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges,
800 Swindow_absolute_pixel_edges, 0, 1, 0,
801 doc: /* Return a list of the edge pixel coordinates of WINDOW.
802 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
803 the top left corner of the display.
805 RIGHT is one more than the rightmost x position occupied by WINDOW.
806 BOTTOM is one more than the bottommost y position occupied by WINDOW.
807 The pixel edges include the space used by WINDOW's scroll bar, display
808 margins, fringes, header line, and/or mode line. For the pixel edges
809 of just the text area, use `window-inside-absolute-pixel-edges'. */)
810 (Lisp_Object window)
812 register struct window *w = decode_any_window (window);
813 int add_x, add_y;
814 calc_absolute_offset (w, &add_x, &add_y);
816 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w) + add_x),
817 Fcons (make_number (WINDOW_TOP_EDGE_Y (w) + add_y),
818 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w) + add_x),
819 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w) + add_y),
820 Qnil))));
823 DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
824 doc: /* Return a list of the edge coordinates of WINDOW.
825 The list has the form (LEFT TOP RIGHT BOTTOM).
826 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
827 all relative to 0, 0 at top left corner of frame.
829 RIGHT is one more than the rightmost column of WINDOW's text area.
830 BOTTOM is one more than the bottommost row of WINDOW's text area.
831 The inside edges do not include the space used by the WINDOW's scroll
832 bar, display margins, fringes, header line, and/or mode line. */)
833 (Lisp_Object window)
835 register struct window *w = decode_any_window (window);
837 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
838 + WINDOW_LEFT_MARGIN_COLS (w)
839 + WINDOW_LEFT_FRINGE_COLS (w)),
840 make_number (WINDOW_TOP_EDGE_LINE (w)
841 + WINDOW_HEADER_LINE_LINES (w)),
842 make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
843 - WINDOW_RIGHT_MARGIN_COLS (w)
844 - WINDOW_RIGHT_FRINGE_COLS (w)),
845 make_number (WINDOW_BOTTOM_EDGE_LINE (w)
846 - WINDOW_MODE_LINE_LINES (w)));
849 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
850 doc: /* Return a list of the edge pixel coordinates of WINDOW.
851 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
852 the top left corner of the frame.
854 RIGHT is one more than the rightmost x position of WINDOW's text area.
855 BOTTOM is one more than the bottommost y position of WINDOW's text area.
856 The inside edges do not include the space used by WINDOW's scroll bar,
857 display margins, fringes, header line, and/or mode line. */)
858 (Lisp_Object window)
860 register struct window *w = decode_any_window (window);
862 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
863 + WINDOW_LEFT_MARGIN_WIDTH (w)
864 + WINDOW_LEFT_FRINGE_WIDTH (w)),
865 make_number (WINDOW_TOP_EDGE_Y (w)
866 + WINDOW_HEADER_LINE_HEIGHT (w)),
867 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
868 - WINDOW_RIGHT_MARGIN_WIDTH (w)
869 - WINDOW_RIGHT_FRINGE_WIDTH (w)),
870 make_number (WINDOW_BOTTOM_EDGE_Y (w)
871 - WINDOW_MODE_LINE_HEIGHT (w)));
874 DEFUN ("window-inside-absolute-pixel-edges",
875 Fwindow_inside_absolute_pixel_edges,
876 Swindow_inside_absolute_pixel_edges, 0, 1, 0,
877 doc: /* Return a list of the edge pixel coordinates of WINDOW.
878 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
879 the top left corner of the display.
881 RIGHT is one more than the rightmost x position of WINDOW's text area.
882 BOTTOM is one more than the bottommost y position of WINDOW's text area.
883 The inside edges do not include the space used by WINDOW's scroll bar,
884 display margins, fringes, header line, and/or mode line. */)
885 (Lisp_Object window)
887 register struct window *w = decode_any_window (window);
888 int add_x, add_y;
889 calc_absolute_offset (w, &add_x, &add_y);
891 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
892 + WINDOW_LEFT_MARGIN_WIDTH (w)
893 + WINDOW_LEFT_FRINGE_WIDTH (w) + add_x),
894 make_number (WINDOW_TOP_EDGE_Y (w)
895 + WINDOW_HEADER_LINE_HEIGHT (w) + add_y),
896 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
897 - WINDOW_RIGHT_MARGIN_WIDTH (w)
898 - WINDOW_RIGHT_FRINGE_WIDTH (w) + add_x),
899 make_number (WINDOW_BOTTOM_EDGE_Y (w)
900 - WINDOW_MODE_LINE_HEIGHT (w) + add_y));
903 /* Test if the character at column X, row Y is within window W.
904 If it is not, return ON_NOTHING;
905 if it is in the window's text area, return ON_TEXT;
906 if it is on the window's modeline, return ON_MODE_LINE;
907 if it is on the border between the window and its right sibling,
908 return ON_VERTICAL_BORDER.
909 if it is on a scroll bar, return ON_SCROLL_BAR.
910 if it is on the window's top line, return ON_HEADER_LINE;
911 if it is in left or right fringe of the window,
912 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
913 if it is in the marginal area to the left/right of the window,
914 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
916 X and Y are frame relative pixel coordinates. */
918 static enum window_part
919 coordinates_in_window (register struct window *w, int x, int y)
921 struct frame *f = XFRAME (WINDOW_FRAME (w));
922 int left_x, right_x;
923 enum window_part part;
924 int ux = FRAME_COLUMN_WIDTH (f);
925 int x0 = WINDOW_LEFT_EDGE_X (w);
926 int x1 = WINDOW_RIGHT_EDGE_X (w);
927 /* The width of the area where the vertical line can be dragged.
928 (Between mode lines for instance. */
929 int grabbable_width = ux;
930 int lmargin_width, rmargin_width, text_left, text_right;
931 int top_y = WINDOW_TOP_EDGE_Y (w);
932 int bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
934 /* Outside any interesting row? */
935 if (y < top_y || y >= bottom_y)
936 return ON_NOTHING;
938 /* In what's below, we subtract 1 when computing right_x because we
939 want the rightmost pixel, which is given by left_pixel+width-1. */
940 if (w->pseudo_window_p)
942 left_x = 0;
943 right_x = WINDOW_TOTAL_WIDTH (w) - 1;
945 else
947 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
948 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
951 /* On the mode line or header line? If it's near the start of
952 the mode or header line of window that's has a horizontal
953 sibling, say it's on the vertical line. That's to be able
954 to resize windows horizontally in case we're using toolkit
955 scroll bars. */
957 if (WINDOW_WANTS_MODELINE_P (w)
958 && y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
960 part = ON_MODE_LINE;
962 header_vertical_border_check:
963 /* We're somewhere on the mode line. We consider the place
964 between mode lines of horizontally adjacent mode lines
965 as the vertical border. If scroll bars on the left,
966 return the right window. */
967 if ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
968 || WINDOW_RIGHTMOST_P (w))
969 && !WINDOW_LEFTMOST_P (w)
970 && eabs (x - x0) < grabbable_width)
971 return ON_VERTICAL_BORDER;
973 /* Make sure we're not at the rightmost position of a
974 mode-/header-line and there's yet another window on the
975 right. (Bug#1372) */
976 else if ((WINDOW_RIGHTMOST_P (w) || x < x1)
977 && eabs (x - x1) < grabbable_width)
978 return ON_VERTICAL_BORDER;
980 if (x < x0 || x >= x1)
981 return ON_NOTHING;
983 return part;
986 if (WINDOW_WANTS_HEADER_LINE_P (w)
987 && y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
989 part = ON_HEADER_LINE;
990 goto header_vertical_border_check;
993 if (x < x0 || x >= x1) return ON_NOTHING;
995 /* Outside any interesting column? */
996 if (x < left_x || x > right_x)
997 return ON_SCROLL_BAR;
999 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
1000 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
1002 text_left = window_box_left (w, TEXT_AREA);
1003 text_right = text_left + window_box_width (w, TEXT_AREA);
1005 if (FRAME_WINDOW_P (f))
1007 if (!w->pseudo_window_p
1008 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
1009 && !WINDOW_RIGHTMOST_P (w)
1010 && (eabs (x - right_x) < grabbable_width))
1011 return ON_VERTICAL_BORDER;
1013 /* Need to say "x > right_x" rather than >=, since on character
1014 terminals, the vertical line's x coordinate is right_x. */
1015 else if (!w->pseudo_window_p
1016 && !WINDOW_RIGHTMOST_P (w)
1017 && x > right_x - ux)
1018 return ON_VERTICAL_BORDER;
1020 if (x < text_left)
1022 if (lmargin_width > 0
1023 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1024 ? (x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
1025 : (x < left_x + lmargin_width)))
1026 return ON_LEFT_MARGIN;
1028 return ON_LEFT_FRINGE;
1031 if (x >= text_right)
1033 if (rmargin_width > 0
1034 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1035 ? (x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
1036 : (x >= right_x - rmargin_width)))
1037 return ON_RIGHT_MARGIN;
1039 return ON_RIGHT_FRINGE;
1042 /* Everything special ruled out - must be on text area */
1043 return ON_TEXT;
1046 /* Take X is the frame-relative pixel x-coordinate, and return the
1047 x-coordinate relative to part PART of window W. */
1049 window_relative_x_coord (struct window *w, enum window_part part, int x)
1051 int left_x = (w->pseudo_window_p) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w);
1053 switch (part)
1055 case ON_TEXT:
1056 return x - window_box_left (w, TEXT_AREA);
1058 case ON_LEFT_FRINGE:
1059 return x - left_x;
1061 case ON_RIGHT_FRINGE:
1062 return x - left_x - WINDOW_LEFT_FRINGE_WIDTH (w);
1064 case ON_LEFT_MARGIN:
1065 return (x - left_x
1066 - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1067 ? WINDOW_LEFT_FRINGE_WIDTH (w) : 0));
1069 case ON_RIGHT_MARGIN:
1070 return (x + 1
1071 - ((w->pseudo_window_p)
1072 ? WINDOW_TOTAL_WIDTH (w)
1073 : WINDOW_BOX_RIGHT_EDGE_X (w))
1074 + window_box_width (w, RIGHT_MARGIN_AREA)
1075 + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1076 ? WINDOW_RIGHT_FRINGE_WIDTH (w) : 0));
1079 /* ON_SCROLL_BAR, ON_NOTHING, and ON_VERTICAL_BORDER: */
1080 return 0;
1084 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
1085 Scoordinates_in_window_p, 2, 2, 0,
1086 doc: /* Return non-nil if COORDINATES are in WINDOW.
1087 COORDINATES is a cons of the form (X . Y), X and Y being distances
1088 measured in characters from the upper-left corner of the frame.
1089 \(0 . 0) denotes the character in the upper left corner of the
1090 frame.
1091 If COORDINATES are in the text portion of WINDOW,
1092 the coordinates relative to the window are returned.
1093 If they are in the mode line of WINDOW, `mode-line' is returned.
1094 If they are in the top mode line of WINDOW, `header-line' is returned.
1095 If they are in the left fringe of WINDOW, `left-fringe' is returned.
1096 If they are in the right fringe of WINDOW, `right-fringe' is returned.
1097 If they are on the border between WINDOW and its right sibling,
1098 `vertical-line' is returned.
1099 If they are in the windows's left or right marginal areas, `left-margin'\n\
1100 or `right-margin' is returned. */)
1101 (register Lisp_Object coordinates, Lisp_Object window)
1103 struct window *w;
1104 struct frame *f;
1105 int x, y;
1106 Lisp_Object lx, ly;
1108 CHECK_WINDOW (window);
1109 w = XWINDOW (window);
1110 f = XFRAME (w->frame);
1111 CHECK_CONS (coordinates);
1112 lx = Fcar (coordinates);
1113 ly = Fcdr (coordinates);
1114 CHECK_NUMBER_OR_FLOAT (lx);
1115 CHECK_NUMBER_OR_FLOAT (ly);
1116 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
1117 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
1119 switch (coordinates_in_window (w, x, y))
1121 case ON_NOTHING:
1122 return Qnil;
1124 case ON_TEXT:
1125 /* Convert X and Y to window relative pixel coordinates, and
1126 return the canonical char units. */
1127 x -= window_box_left (w, TEXT_AREA);
1128 y -= WINDOW_TOP_EDGE_Y (w);
1129 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
1130 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
1132 case ON_MODE_LINE:
1133 return Qmode_line;
1135 case ON_VERTICAL_BORDER:
1136 return Qvertical_line;
1138 case ON_HEADER_LINE:
1139 return Qheader_line;
1141 case ON_LEFT_FRINGE:
1142 return Qleft_fringe;
1144 case ON_RIGHT_FRINGE:
1145 return Qright_fringe;
1147 case ON_LEFT_MARGIN:
1148 return Qleft_margin;
1150 case ON_RIGHT_MARGIN:
1151 return Qright_margin;
1153 case ON_SCROLL_BAR:
1154 /* Historically we are supposed to return nil in this case. */
1155 return Qnil;
1157 default:
1158 abort ();
1163 /* Callback for foreach_window, used in window_from_coordinates.
1164 Check if window W contains coordinates specified by USER_DATA which
1165 is actually a pointer to a struct check_window_data CW.
1167 Check if window W contains coordinates *CW->x and *CW->y. If it
1168 does, return W in *CW->window, as Lisp_Object, and return in
1169 *CW->part the part of the window under coordinates *X,*Y. Return
1170 zero from this function to stop iterating over windows. */
1172 struct check_window_data
1174 Lisp_Object *window;
1175 int x, y;
1176 enum window_part *part;
1179 static int
1180 check_window_containing (struct window *w, void *user_data)
1182 struct check_window_data *cw = (struct check_window_data *) user_data;
1183 enum window_part found;
1184 int continue_p = 1;
1186 found = coordinates_in_window (w, cw->x, cw->y);
1187 if (found != ON_NOTHING)
1189 *cw->part = found;
1190 XSETWINDOW (*cw->window, w);
1191 continue_p = 0;
1194 return continue_p;
1198 /* Find the window containing frame-relative pixel position X/Y and
1199 return it as a Lisp_Object.
1201 If X, Y is on one of the window's special `window_part' elements,
1202 set *PART to the id of that element.
1204 If there is no window under X, Y return nil and leave *PART
1205 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1207 This function was previously implemented with a loop cycling over
1208 windows with Fnext_window, and starting with the frame's selected
1209 window. It turned out that this doesn't work with an
1210 implementation of next_window using Vwindow_list, because
1211 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1212 tree of F when this function is called asynchronously from
1213 note_mouse_highlight. The original loop didn't terminate in this
1214 case. */
1216 Lisp_Object
1217 window_from_coordinates (struct frame *f, int x, int y,
1218 enum window_part *part, int tool_bar_p)
1220 Lisp_Object window;
1221 struct check_window_data cw;
1222 enum window_part dummy;
1224 if (part == 0)
1225 part = &dummy;
1227 window = Qnil;
1228 cw.window = &window, cw.x = x, cw.y = y; cw.part = part;
1229 foreach_window (f, check_window_containing, &cw);
1231 /* If not found above, see if it's in the tool bar window, if a tool
1232 bar exists. */
1233 if (NILP (window)
1234 && tool_bar_p
1235 && WINDOWP (f->tool_bar_window)
1236 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1237 && (coordinates_in_window (XWINDOW (f->tool_bar_window), x, y)
1238 != ON_NOTHING))
1240 *part = ON_TEXT;
1241 window = f->tool_bar_window;
1244 return window;
1247 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1248 doc: /* Return window containing coordinates X and Y on FRAME.
1249 FRAME must be a live frame and defaults to the selected one.
1250 The top left corner of the frame is considered to be row 0,
1251 column 0. */)
1252 (Lisp_Object x, Lisp_Object y, Lisp_Object frame)
1254 struct frame *f;
1256 if (NILP (frame))
1257 frame = selected_frame;
1258 CHECK_LIVE_FRAME (frame);
1259 f = XFRAME (frame);
1261 /* Check that arguments are integers or floats. */
1262 CHECK_NUMBER_OR_FLOAT (x);
1263 CHECK_NUMBER_OR_FLOAT (y);
1265 return window_from_coordinates (f,
1266 (FRAME_PIXEL_X_FROM_CANON_X (f, x)
1267 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1268 (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
1269 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1270 0, 0);
1273 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1274 doc: /* Return current value of point in WINDOW.
1275 WINDOW must be a live window and defaults to the selected one.
1277 For a nonselected window, this is the value point would have
1278 if that window were selected.
1280 Note that, when WINDOW is the selected window and its buffer
1281 is also currently selected, the value returned is the same as (point).
1282 It would be more strictly correct to return the `top-level' value
1283 of point, outside of any save-excursion forms.
1284 But that is hard to define. */)
1285 (Lisp_Object window)
1287 register struct window *w = decode_window (window);
1289 if (w == XWINDOW (selected_window)
1290 && current_buffer == XBUFFER (w->buffer))
1291 return Fpoint ();
1292 return Fmarker_position (w->pointm);
1295 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1296 doc: /* Return position at which display currently starts in WINDOW.
1297 WINDOW must be a live window and defaults to the selected one.
1298 This is updated by redisplay or by calling `set-window-start'. */)
1299 (Lisp_Object window)
1301 return Fmarker_position (decode_window (window)->start);
1304 /* This is text temporarily removed from the doc string below.
1306 This function returns nil if the position is not currently known.
1307 That happens when redisplay is preempted and doesn't finish.
1308 If in that case you want to compute where the end of the window would
1309 have been if redisplay had finished, do this:
1310 (save-excursion
1311 (goto-char (window-start window))
1312 (vertical-motion (1- (window-height window)) window)
1313 (point))") */
1315 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1316 doc: /* Return position at which display currently ends in WINDOW.
1317 WINDOW must be a live window and defaults to the selected one.
1318 This is updated by redisplay, when it runs to completion.
1319 Simply changing the buffer text or setting `window-start'
1320 does not update this value.
1321 Return nil if there is no recorded value. \(This can happen if the
1322 last redisplay of WINDOW was preempted, and did not finish.)
1323 If UPDATE is non-nil, compute the up-to-date position
1324 if it isn't already recorded. */)
1325 (Lisp_Object window, Lisp_Object update)
1327 Lisp_Object value;
1328 struct window *w = decode_window (window);
1329 Lisp_Object buf;
1330 struct buffer *b;
1332 buf = w->buffer;
1333 CHECK_BUFFER (buf);
1334 b = XBUFFER (buf);
1336 #if 0 /* This change broke some things. We should make it later. */
1337 /* If we don't know the end position, return nil.
1338 The user can compute it with vertical-motion if he wants to.
1339 It would be nicer to do it automatically,
1340 but that's so slow that it would probably bother people. */
1341 if (NILP (w->window_end_valid))
1342 return Qnil;
1343 #endif
1345 if (! NILP (update)
1346 && ! (! NILP (w->window_end_valid)
1347 && XFASTINT (w->last_modified) >= BUF_MODIFF (b)
1348 && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (b))
1349 && !noninteractive)
1351 struct text_pos startp;
1352 struct it it;
1353 struct buffer *old_buffer = NULL;
1354 void *itdata = NULL;
1356 /* Cannot use Fvertical_motion because that function doesn't
1357 cope with variable-height lines. */
1358 if (b != current_buffer)
1360 old_buffer = current_buffer;
1361 set_buffer_internal (b);
1364 /* In case W->start is out of the range, use something
1365 reasonable. This situation occurred when loading a file with
1366 `-l' containing a call to `rmail' with subsequent other
1367 commands. At the end, W->start happened to be BEG, while
1368 rmail had already narrowed the buffer. */
1369 if (XMARKER (w->start)->charpos < BEGV)
1370 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1371 else if (XMARKER (w->start)->charpos > ZV)
1372 SET_TEXT_POS (startp, ZV, ZV_BYTE);
1373 else
1374 SET_TEXT_POS_FROM_MARKER (startp, w->start);
1376 itdata = bidi_shelve_cache ();
1377 start_display (&it, w, startp);
1378 move_it_vertically (&it, window_box_height (w));
1379 if (it.current_y < it.last_visible_y)
1380 move_it_past_eol (&it);
1381 value = make_number (IT_CHARPOS (it));
1382 bidi_unshelve_cache (itdata, 0);
1384 if (old_buffer)
1385 set_buffer_internal (old_buffer);
1387 else
1388 XSETINT (value, BUF_Z (b) - XFASTINT (w->window_end_pos));
1390 return value;
1393 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1394 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1395 Return POS. */)
1396 (Lisp_Object window, Lisp_Object pos)
1398 register struct window *w = decode_window (window);
1400 CHECK_NUMBER_COERCE_MARKER (pos);
1401 if (w == XWINDOW (selected_window)
1402 && XBUFFER (w->buffer) == current_buffer)
1403 Fgoto_char (pos);
1404 else
1405 set_marker_restricted (w->pointm, pos, w->buffer);
1407 /* We have to make sure that redisplay updates the window to show
1408 the new value of point. */
1409 if (!EQ (window, selected_window))
1410 ++windows_or_buffers_changed;
1412 return pos;
1415 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1416 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1417 If WINDOW is nil, the selected window is used. Return POS.
1418 Optional third arg NOFORCE non-nil inhibits next redisplay from
1419 overriding motion of point in order to display at this exact start. */)
1420 (Lisp_Object window, Lisp_Object pos, Lisp_Object noforce)
1422 register struct window *w = decode_window (window);
1424 CHECK_NUMBER_COERCE_MARKER (pos);
1425 set_marker_restricted (w->start, pos, w->buffer);
1426 /* this is not right, but much easier than doing what is right. */
1427 w->start_at_line_beg = Qnil;
1428 if (NILP (noforce))
1429 w->force_start = Qt;
1430 w->update_mode_line = Qt;
1431 XSETFASTINT (w->last_modified, 0);
1432 XSETFASTINT (w->last_overlay_modified, 0);
1433 if (!EQ (window, selected_window))
1434 windows_or_buffers_changed++;
1436 return pos;
1439 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
1440 Spos_visible_in_window_p, 0, 3, 0,
1441 doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
1442 Return nil if that position is scrolled vertically out of view.
1443 If a character is only partially visible, nil is returned, unless the
1444 optional argument PARTIALLY is non-nil.
1445 If POS is only out of view because of horizontal scrolling, return non-nil.
1446 If POS is t, it specifies the position of the last visible glyph in WINDOW.
1447 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
1449 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
1450 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
1451 where X and Y are the pixel coordinates relative to the top left corner
1452 of the window. The remaining elements are omitted if the character after
1453 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
1454 off-window at the top and bottom of the row, ROWH is the height of the
1455 display row, and VPOS is the row number (0-based) containing POS. */)
1456 (Lisp_Object pos, Lisp_Object window, Lisp_Object partially)
1458 register struct window *w;
1459 register EMACS_INT posint;
1460 register struct buffer *buf;
1461 struct text_pos top;
1462 Lisp_Object in_window = Qnil;
1463 int rtop, rbot, rowh, vpos, fully_p = 1;
1464 int x, y;
1466 w = decode_window (window);
1467 buf = XBUFFER (w->buffer);
1468 SET_TEXT_POS_FROM_MARKER (top, w->start);
1470 if (EQ (pos, Qt))
1471 posint = -1;
1472 else if (!NILP (pos))
1474 CHECK_NUMBER_COERCE_MARKER (pos);
1475 posint = XINT (pos);
1477 else if (w == XWINDOW (selected_window))
1478 posint = PT;
1479 else
1480 posint = XMARKER (w->pointm)->charpos;
1482 /* If position is above window start or outside buffer boundaries,
1483 or if window start is out of range, position is not visible. */
1484 if ((EQ (pos, Qt)
1485 || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
1486 && CHARPOS (top) >= BUF_BEGV (buf)
1487 && CHARPOS (top) <= BUF_ZV (buf)
1488 && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
1489 && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
1490 in_window = Qt;
1492 if (!NILP (in_window) && !NILP (partially))
1494 Lisp_Object part = Qnil;
1495 if (!fully_p)
1496 part = list4 (make_number (rtop), make_number (rbot),
1497 make_number (rowh), make_number (vpos));
1498 in_window = Fcons (make_number (x),
1499 Fcons (make_number (y), part));
1502 return in_window;
1505 DEFUN ("window-line-height", Fwindow_line_height,
1506 Swindow_line_height, 0, 2, 0,
1507 doc: /* Return height in pixels of text line LINE in window WINDOW.
1508 WINDOW defaults to the selected window.
1510 Return height of current line if LINE is omitted or nil. Return height of
1511 header or mode line if LINE is `header-line' or `mode-line'.
1512 Otherwise, LINE is a text line number starting from 0. A negative number
1513 counts from the end of the window.
1515 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
1516 in pixels of the visible part of the line, VPOS and YPOS are the
1517 vertical position in lines and pixels of the line, relative to the top
1518 of the first text line, and OFFBOT is the number of off-window pixels at
1519 the bottom of the text line. If there are off-window pixels at the top
1520 of the (first) text line, YPOS is negative.
1522 Return nil if window display is not up-to-date. In that case, use
1523 `pos-visible-in-window-p' to obtain the information. */)
1524 (Lisp_Object line, Lisp_Object window)
1526 register struct window *w;
1527 register struct buffer *b;
1528 struct glyph_row *row, *end_row;
1529 int max_y, crop, i, n;
1531 w = decode_window (window);
1533 if (noninteractive || w->pseudo_window_p)
1534 return Qnil;
1536 CHECK_BUFFER (w->buffer);
1537 b = XBUFFER (w->buffer);
1539 /* Fail if current matrix is not up-to-date. */
1540 if (NILP (w->window_end_valid)
1541 || current_buffer->clip_changed
1542 || current_buffer->prevent_redisplay_optimizations_p
1543 || XFASTINT (w->last_modified) < BUF_MODIFF (b)
1544 || XFASTINT (w->last_overlay_modified) < BUF_OVERLAY_MODIFF (b))
1545 return Qnil;
1547 if (NILP (line))
1549 i = w->cursor.vpos;
1550 if (i < 0 || i >= w->current_matrix->nrows
1551 || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
1552 return Qnil;
1553 max_y = window_text_bottom_y (w);
1554 goto found_row;
1557 if (EQ (line, Qheader_line))
1559 if (!WINDOW_WANTS_HEADER_LINE_P (w))
1560 return Qnil;
1561 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
1562 if (!row->enabled_p)
1563 return Qnil;
1564 return list4 (make_number (row->height),
1565 make_number (0), make_number (0),
1566 make_number (0));
1569 if (EQ (line, Qmode_line))
1571 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
1572 if (!row->enabled_p)
1573 return Qnil;
1574 return list4 (make_number (row->height),
1575 make_number (0), /* not accurate */
1576 make_number (WINDOW_HEADER_LINE_HEIGHT (w)
1577 + window_text_bottom_y (w)),
1578 make_number (0));
1581 CHECK_NUMBER (line);
1582 n = XINT (line);
1584 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
1585 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
1586 max_y = window_text_bottom_y (w);
1587 i = 0;
1589 while ((n < 0 || i < n)
1590 && row <= end_row && row->enabled_p
1591 && row->y + row->height < max_y)
1592 row++, i++;
1594 if (row > end_row || !row->enabled_p)
1595 return Qnil;
1597 if (++n < 0)
1599 if (-n > i)
1600 return Qnil;
1601 row += n;
1602 i += n;
1605 found_row:
1606 crop = max (0, (row->y + row->height) - max_y);
1607 return list4 (make_number (row->height + min (0, row->y) - crop),
1608 make_number (i),
1609 make_number (row->y),
1610 make_number (crop));
1613 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1614 0, 1, 0,
1615 doc: /* Return non-nil when WINDOW is dedicated to its buffer.
1616 More precisely, return the value assigned by the last call of
1617 `set-window-dedicated-p' for WINDOW. Return nil if that function was
1618 never called with WINDOW as its argument, or the value set by that
1619 function was internally reset since its last call. WINDOW defaults to
1620 the selected window.
1622 When a window is dedicated to its buffer, `display-buffer' will refrain
1623 from displaying another buffer in it. `get-lru-window' and
1624 `get-largest-window' treat dedicated windows specially.
1625 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1626 `kill-buffer' can delete a dedicated window and the containing frame.
1628 Functions like `set-window-buffer' may change the buffer displayed by a
1629 window, unless that window is "strongly" dedicated to its buffer, that
1630 is the value returned by `window-dedicated-p' is t. */)
1631 (Lisp_Object window)
1633 return decode_window (window)->dedicated;
1636 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1637 Sset_window_dedicated_p, 2, 2, 0,
1638 doc: /* Mark WINDOW as dedicated according to FLAG.
1639 WINDOW must be a live window and defaults to the selected one. FLAG
1640 non-nil means mark WINDOW as dedicated to its buffer. FLAG nil means
1641 mark WINDOW as non-dedicated. Return FLAG.
1643 When a window is dedicated to its buffer, `display-buffer' will refrain
1644 from displaying another buffer in it. `get-lru-window' and
1645 `get-largest-window' treat dedicated windows specially.
1646 `delete-windows-on', `replace-buffer-in-windows', `quit-window',
1647 `quit-restore-window' and `kill-buffer' can delete a dedicated window
1648 and the containing frame.
1650 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
1651 its buffer. Functions like `set-window-buffer' may change the buffer
1652 displayed by a window, unless that window is strongly dedicated to its
1653 buffer. If and when `set-window-buffer' displays another buffer in a
1654 window, it also makes sure that the window is no more dedicated. */)
1655 (Lisp_Object window, Lisp_Object flag)
1657 register struct window *w = decode_window (window);
1659 w->dedicated = flag;
1660 return w->dedicated;
1663 DEFUN ("window-prev-buffers", Fwindow_prev_buffers, Swindow_prev_buffers,
1664 0, 1, 0,
1665 doc: /* Return buffers previously shown in WINDOW.
1666 WINDOW must be a live window and defaults to the selected one.
1668 The return value is a list of elements (BUFFER WINDOW-START POS),
1669 where BUFFER is a buffer, WINDOW-START is the start position of the
1670 window for that buffer, and POS is a window-specific point value. */)
1671 (Lisp_Object window)
1673 return decode_window (window)->prev_buffers;
1676 DEFUN ("set-window-prev-buffers", Fset_window_prev_buffers,
1677 Sset_window_prev_buffers, 2, 2, 0,
1678 doc: /* Set WINDOW's previous buffers to PREV-BUFFERS.
1679 WINDOW must be a live window and defaults to the selected one.
1681 PREV-BUFFERS should be a list of elements (BUFFER WINDOW-START POS),
1682 where BUFFER is a buffer, WINDOW-START is the start position of the
1683 window for that buffer, and POS is a window-specific point value. */)
1684 (Lisp_Object window, Lisp_Object prev_buffers)
1686 return decode_window (window)->prev_buffers = prev_buffers;
1689 DEFUN ("window-next-buffers", Fwindow_next_buffers, Swindow_next_buffers,
1690 0, 1, 0,
1691 doc: /* Return list of buffers recently re-shown in WINDOW.
1692 WINDOW must be a live window and defaults to the selected one. */)
1693 (Lisp_Object window)
1695 return decode_window (window)->next_buffers;
1698 DEFUN ("set-window-next-buffers", Fset_window_next_buffers,
1699 Sset_window_next_buffers, 2, 2, 0,
1700 doc: /* Set WINDOW's next buffers to NEXT-BUFFERS.
1701 WINDOW must be a live window and defaults to the selected one.
1702 NEXT-BUFFERS should be a list of buffers. */)
1703 (Lisp_Object window, Lisp_Object next_buffers)
1705 return decode_window (window)->next_buffers = next_buffers;
1708 DEFUN ("window-parameters", Fwindow_parameters, Swindow_parameters,
1709 0, 1, 0,
1710 doc: /* Return the parameters of WINDOW and their values.
1711 WINDOW defaults to the selected window. The return value is a list of
1712 elements of the form (PARAMETER . VALUE). */)
1713 (Lisp_Object window)
1715 return Fcopy_alist (decode_any_window (window)->window_parameters);
1718 DEFUN ("window-parameter", Fwindow_parameter, Swindow_parameter,
1719 2, 2, 0,
1720 doc: /* Return WINDOW's value for PARAMETER.
1721 WINDOW defaults to the selected window. */)
1722 (Lisp_Object window, Lisp_Object parameter)
1724 Lisp_Object result;
1726 result = Fassq (parameter, decode_any_window (window)->window_parameters);
1727 return CDR_SAFE (result);
1730 DEFUN ("set-window-parameter", Fset_window_parameter,
1731 Sset_window_parameter, 3, 3, 0,
1732 doc: /* Set WINDOW's value of PARAMETER to VALUE.
1733 WINDOW defaults to the selected window. Return VALUE. */)
1734 (Lisp_Object window, Lisp_Object parameter, Lisp_Object value)
1736 register struct window *w = decode_any_window (window);
1737 Lisp_Object old_alist_elt;
1739 old_alist_elt = Fassq (parameter, w->window_parameters);
1740 if (NILP (old_alist_elt))
1741 w->window_parameters = Fcons (Fcons (parameter, value), w->window_parameters);
1742 else
1743 Fsetcdr (old_alist_elt, value);
1744 return value;
1747 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1748 0, 1, 0,
1749 doc: /* Return the display-table that WINDOW is using.
1750 WINDOW defaults to the selected window. */)
1751 (Lisp_Object window)
1753 return decode_window (window)->display_table;
1756 /* Get the display table for use on window W. This is either W's
1757 display table or W's buffer's display table. Ignore the specified
1758 tables if they are not valid; if no valid table is specified,
1759 return 0. */
1761 struct Lisp_Char_Table *
1762 window_display_table (struct window *w)
1764 struct Lisp_Char_Table *dp = NULL;
1766 if (DISP_TABLE_P (w->display_table))
1767 dp = XCHAR_TABLE (w->display_table);
1768 else if (BUFFERP (w->buffer))
1770 struct buffer *b = XBUFFER (w->buffer);
1772 if (DISP_TABLE_P (BVAR (b, display_table)))
1773 dp = XCHAR_TABLE (BVAR (b, display_table));
1774 else if (DISP_TABLE_P (Vstandard_display_table))
1775 dp = XCHAR_TABLE (Vstandard_display_table);
1778 return dp;
1781 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1782 doc: /* Set WINDOW's display-table to TABLE. */)
1783 (register Lisp_Object window, Lisp_Object table)
1785 register struct window *w;
1787 w = decode_window (window);
1788 w->display_table = table;
1789 return table;
1792 /* Record info on buffer window W is displaying
1793 when it is about to cease to display that buffer. */
1794 static void
1795 unshow_buffer (register struct window *w)
1797 Lisp_Object buf;
1798 struct buffer *b;
1800 buf = w->buffer;
1801 b = XBUFFER (buf);
1802 if (b != XMARKER (w->pointm)->buffer)
1803 abort ();
1805 #if 0
1806 if (w == XWINDOW (selected_window)
1807 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1808 /* Do this except when the selected window's buffer
1809 is being removed from some other window. */
1810 #endif
1811 /* last_window_start records the start position that this buffer
1812 had in the last window to be disconnected from it.
1813 Now that this statement is unconditional,
1814 it is possible for the buffer to be displayed in the
1815 selected window, while last_window_start reflects another
1816 window which was recently showing the same buffer.
1817 Some people might say that might be a good thing. Let's see. */
1818 b->last_window_start = marker_position (w->start);
1820 /* Point in the selected window's buffer
1821 is actually stored in that buffer, and the window's pointm isn't used.
1822 So don't clobber point in that buffer. */
1823 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1824 /* This line helps to fix Horsley's testbug.el bug. */
1825 && !(WINDOWP (BVAR (b, last_selected_window))
1826 && w != XWINDOW (BVAR (b, last_selected_window))
1827 && EQ (buf, XWINDOW (BVAR (b, last_selected_window))->buffer)))
1828 temp_set_point_both (b,
1829 clip_to_bounds (BUF_BEGV (b),
1830 XMARKER (w->pointm)->charpos,
1831 BUF_ZV (b)),
1832 clip_to_bounds (BUF_BEGV_BYTE (b),
1833 marker_byte_position (w->pointm),
1834 BUF_ZV_BYTE (b)));
1836 if (WINDOWP (BVAR (b, last_selected_window))
1837 && w == XWINDOW (BVAR (b, last_selected_window)))
1838 BVAR (b, last_selected_window) = Qnil;
1841 /* Put NEW into the window structure in place of OLD. SETFLAG zero
1842 means change window structure only. Otherwise store geometry and
1843 other settings as well. */
1844 static void
1845 replace_window (Lisp_Object old, Lisp_Object new, int setflag)
1847 register Lisp_Object tem;
1848 register struct window *o = XWINDOW (old), *n = XWINDOW (new);
1850 /* If OLD is its frame's root window, then NEW is the new
1851 root window for that frame. */
1852 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1853 FRAME_ROOT_WINDOW (XFRAME (o->frame)) = new;
1855 if (setflag)
1857 n->left_col = o->left_col;
1858 n->top_line = o->top_line;
1859 n->total_cols = o->total_cols;
1860 n->total_lines = o->total_lines;
1861 n->normal_cols = o->normal_cols;
1862 o->normal_cols = make_float (1.0);
1863 n->normal_lines = o->normal_lines;
1864 o->normal_lines = make_float (1.0);
1865 n->desired_matrix = n->current_matrix = 0;
1866 n->vscroll = 0;
1867 memset (&n->cursor, 0, sizeof (n->cursor));
1868 memset (&n->last_cursor, 0, sizeof (n->last_cursor));
1869 memset (&n->phys_cursor, 0, sizeof (n->phys_cursor));
1870 n->phys_cursor_type = -1;
1871 n->phys_cursor_width = -1;
1872 n->must_be_updated_p = 0;
1873 n->pseudo_window_p = 0;
1874 XSETFASTINT (n->window_end_vpos, 0);
1875 XSETFASTINT (n->window_end_pos, 0);
1876 n->window_end_valid = Qnil;
1877 n->frozen_window_start_p = 0;
1880 n->next = tem = o->next;
1881 if (!NILP (tem))
1882 XWINDOW (tem)->prev = new;
1884 n->prev = tem = o->prev;
1885 if (!NILP (tem))
1886 XWINDOW (tem)->next = new;
1888 n->parent = tem = o->parent;
1889 if (!NILP (tem))
1891 if (EQ (XWINDOW (tem)->vchild, old))
1892 XWINDOW (tem)->vchild = new;
1893 if (EQ (XWINDOW (tem)->hchild, old))
1894 XWINDOW (tem)->hchild = new;
1898 /* If window WINDOW and its parent window are iso-combined, merge
1899 WINDOW's children into those of its parent window and mark WINDOW as
1900 deleted. */
1902 static void
1903 recombine_windows (Lisp_Object window)
1905 struct window *w, *p, *c;
1906 Lisp_Object parent, child;
1907 int horflag;
1909 w = XWINDOW (window);
1910 parent = w->parent;
1911 if (!NILP (parent) && NILP (w->nest))
1913 p = XWINDOW (parent);
1914 if (((!NILP (p->vchild) && !NILP (w->vchild))
1915 || (!NILP (p->hchild) && !NILP (w->hchild))))
1916 /* WINDOW and PARENT are both either a vertical or a horizontal
1917 combination. */
1919 horflag = NILP (w->vchild);
1920 child = horflag ? w->hchild : w->vchild;
1921 c = XWINDOW (child);
1923 /* Splice WINDOW's children into its parent's children and
1924 assign new normal sizes. */
1925 if (NILP (w->prev))
1926 if (horflag)
1927 p->hchild = child;
1928 else
1929 p->vchild = child;
1930 else
1932 c->prev = w->prev;
1933 XWINDOW (w->prev)->next = child;
1936 while (c)
1938 c->parent = parent;
1940 if (horflag)
1941 c->normal_cols
1942 = make_float (XFLOATINT (c->total_cols)
1943 / XFLOATINT (p->total_cols));
1944 else
1945 c->normal_lines
1946 = make_float (XFLOATINT (c->total_lines)
1947 / XFLOATINT (p->total_lines));
1949 if (NILP (c->next))
1951 if (!NILP (w->next))
1953 c->next = w->next;
1954 XWINDOW (c->next)->prev = child;
1957 c = 0;
1959 else
1961 child = c->next;
1962 c = XWINDOW (child);
1966 /* WINDOW can be deleted now. */
1967 w->vchild = w->hchild = Qnil;
1972 /* If WINDOW can be deleted, delete it. */
1973 static void
1974 delete_deletable_window (Lisp_Object window)
1976 if (!NILP (call1 (Qwindow_deletable_p, window)))
1977 call1 (Qdelete_window, window);
1980 /***********************************************************************
1981 Window List
1982 ***********************************************************************/
1984 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1985 pointer. This is a callback function for foreach_window, used in
1986 the window_list function. */
1988 static int
1989 add_window_to_list (struct window *w, void *user_data)
1991 Lisp_Object *list = (Lisp_Object *) user_data;
1992 Lisp_Object window;
1993 XSETWINDOW (window, w);
1994 *list = Fcons (window, *list);
1995 return 1;
1999 /* Return a list of all windows, for use by next_window. If
2000 Vwindow_list is a list, return that list. Otherwise, build a new
2001 list, cache it in Vwindow_list, and return that. */
2003 static Lisp_Object
2004 window_list (void)
2006 if (!CONSP (Vwindow_list))
2008 Lisp_Object tail;
2010 Vwindow_list = Qnil;
2011 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
2013 Lisp_Object args[2];
2015 /* We are visiting windows in canonical order, and add
2016 new windows at the front of args[1], which means we
2017 have to reverse this list at the end. */
2018 args[1] = Qnil;
2019 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
2020 args[0] = Vwindow_list;
2021 args[1] = Fnreverse (args[1]);
2022 Vwindow_list = Fnconc (2, args);
2026 return Vwindow_list;
2030 /* Value is non-zero if WINDOW satisfies the constraints given by
2031 OWINDOW, MINIBUF and ALL_FRAMES.
2033 MINIBUF t means WINDOW may be minibuffer windows.
2034 `lambda' means WINDOW may not be a minibuffer window.
2035 a window means a specific minibuffer window
2037 ALL_FRAMES t means search all frames,
2038 nil means search just current frame,
2039 `visible' means search just visible frames on the
2040 current terminal,
2041 0 means search visible and iconified frames on the
2042 current terminal,
2043 a window means search the frame that window belongs to,
2044 a frame means consider windows on that frame, only. */
2046 static int
2047 candidate_window_p (Lisp_Object window, Lisp_Object owindow, Lisp_Object minibuf, Lisp_Object all_frames)
2049 struct window *w = XWINDOW (window);
2050 struct frame *f = XFRAME (w->frame);
2051 int candidate_p = 1;
2053 if (!BUFFERP (w->buffer))
2054 candidate_p = 0;
2055 else if (MINI_WINDOW_P (w)
2056 && (EQ (minibuf, Qlambda)
2057 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
2059 /* If MINIBUF is `lambda' don't consider any mini-windows.
2060 If it is a window, consider only that one. */
2061 candidate_p = 0;
2063 else if (EQ (all_frames, Qt))
2064 candidate_p = 1;
2065 else if (NILP (all_frames))
2067 xassert (WINDOWP (owindow));
2068 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
2070 else if (EQ (all_frames, Qvisible))
2072 FRAME_SAMPLE_VISIBILITY (f);
2073 candidate_p = FRAME_VISIBLE_P (f)
2074 && (FRAME_TERMINAL (XFRAME (w->frame))
2075 == FRAME_TERMINAL (XFRAME (selected_frame)));
2078 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
2080 FRAME_SAMPLE_VISIBILITY (f);
2081 candidate_p = (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)
2082 #ifdef HAVE_X_WINDOWS
2083 /* Yuck!! If we've just created the frame and the
2084 window-manager requested the user to place it
2085 manually, the window may still not be considered
2086 `visible'. I'd argue it should be at least
2087 something like `iconified', but don't know how to do
2088 that yet. --Stef */
2089 || (FRAME_X_P (f) && f->output_data.x->asked_for_visible
2090 && !f->output_data.x->has_been_visible)
2091 #endif
2093 && (FRAME_TERMINAL (XFRAME (w->frame))
2094 == FRAME_TERMINAL (XFRAME (selected_frame)));
2096 else if (WINDOWP (all_frames))
2097 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
2098 || EQ (XWINDOW (all_frames)->frame, w->frame)
2099 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
2100 else if (FRAMEP (all_frames))
2101 candidate_p = EQ (all_frames, w->frame);
2103 return candidate_p;
2107 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
2108 Fwindow_list. See candidate_window_p for the meaning of WINDOW,
2109 MINIBUF, and ALL_FRAMES. */
2111 static void
2112 decode_next_window_args (Lisp_Object *window, Lisp_Object *minibuf, Lisp_Object *all_frames)
2114 if (NILP (*window))
2115 *window = selected_window;
2116 else
2117 CHECK_LIVE_WINDOW (*window);
2119 /* MINIBUF nil may or may not include minibuffers. Decide if it
2120 does. */
2121 if (NILP (*minibuf))
2122 *minibuf = minibuf_level ? minibuf_window : Qlambda;
2123 else if (!EQ (*minibuf, Qt))
2124 *minibuf = Qlambda;
2126 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
2127 => count none of them, or a specific minibuffer window (the
2128 active one) to count. */
2130 /* ALL_FRAMES nil doesn't specify which frames to include. */
2131 if (NILP (*all_frames))
2132 *all_frames = (!EQ (*minibuf, Qlambda)
2133 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
2134 : Qnil);
2135 else if (EQ (*all_frames, Qvisible))
2137 else if (EQ (*all_frames, make_number (0)))
2139 else if (FRAMEP (*all_frames))
2141 else if (!EQ (*all_frames, Qt))
2142 *all_frames = Qnil;
2146 /* Return the next or previous window of WINDOW in cyclic ordering
2147 of windows. NEXT_P non-zero means return the next window. See the
2148 documentation string of next-window for the meaning of MINIBUF and
2149 ALL_FRAMES. */
2151 static Lisp_Object
2152 next_window (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames, int next_p)
2154 decode_next_window_args (&window, &minibuf, &all_frames);
2156 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
2157 return the first window on the frame. */
2158 if (FRAMEP (all_frames)
2159 && !EQ (all_frames, XWINDOW (window)->frame))
2160 return Fframe_first_window (all_frames);
2162 if (next_p)
2164 Lisp_Object list;
2166 /* Find WINDOW in the list of all windows. */
2167 list = Fmemq (window, window_list ());
2169 /* Scan forward from WINDOW to the end of the window list. */
2170 if (CONSP (list))
2171 for (list = XCDR (list); CONSP (list); list = XCDR (list))
2172 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2173 break;
2175 /* Scan from the start of the window list up to WINDOW. */
2176 if (!CONSP (list))
2177 for (list = Vwindow_list;
2178 CONSP (list) && !EQ (XCAR (list), window);
2179 list = XCDR (list))
2180 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2181 break;
2183 if (CONSP (list))
2184 window = XCAR (list);
2186 else
2188 Lisp_Object candidate, list;
2190 /* Scan through the list of windows for candidates. If there are
2191 candidate windows in front of WINDOW, the last one of these
2192 is the one we want. If there are candidates following WINDOW
2193 in the list, again the last one of these is the one we want. */
2194 candidate = Qnil;
2195 for (list = window_list (); CONSP (list); list = XCDR (list))
2197 if (EQ (XCAR (list), window))
2199 if (WINDOWP (candidate))
2200 break;
2202 else if (candidate_window_p (XCAR (list), window, minibuf,
2203 all_frames))
2204 candidate = XCAR (list);
2207 if (WINDOWP (candidate))
2208 window = candidate;
2211 return window;
2215 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
2216 doc: /* Return window following WINDOW in cyclic ordering of windows.
2217 WINDOW must be a live window and defaults to the selected one. The
2218 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2219 consider.
2221 MINIBUF nil or omitted means consider the minibuffer window only if the
2222 minibuffer is active. MINIBUF t means consider the minibuffer window
2223 even if the minibuffer is not active. Any other value means do not
2224 consider the minibuffer window even if the minibuffer is active.
2226 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2227 plus the minibuffer window if specified by the MINIBUF argument. If the
2228 minibuffer counts, consider all windows on all frames that share that
2229 minibuffer too. The following non-nil values of ALL-FRAMES have special
2230 meanings:
2232 - t means consider all windows on all existing frames.
2234 - `visible' means consider all windows on all visible frames.
2236 - 0 (the number zero) means consider all windows on all visible and
2237 iconified frames.
2239 - A frame means consider all windows on that frame only.
2241 Anything else means consider all windows on WINDOW's frame and no
2242 others.
2244 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2245 `next-window' to iterate through the entire cycle of acceptable
2246 windows, eventually ending up back at the window you started with.
2247 `previous-window' traverses the same cycle, in the reverse order. */)
2248 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2250 return next_window (window, minibuf, all_frames, 1);
2254 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
2255 doc: /* Return window preceding WINDOW in cyclic ordering of windows.
2256 WINDOW must be a live window and defaults to the selected one. The
2257 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2258 consider.
2260 MINIBUF nil or omitted means consider the minibuffer window only if the
2261 minibuffer is active. MINIBUF t means consider the minibuffer window
2262 even if the minibuffer is not active. Any other value means do not
2263 consider the minibuffer window even if the minibuffer is active.
2265 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2266 plus the minibuffer window if specified by the MINIBUF argument. If the
2267 minibuffer counts, consider all windows on all frames that share that
2268 minibuffer too. The following non-nil values of ALL-FRAMES have special
2269 meanings:
2271 - t means consider all windows on all existing frames.
2273 - `visible' means consider all windows on all visible frames.
2275 - 0 (the number zero) means consider all windows on all visible and
2276 iconified frames.
2278 - A frame means consider all windows on that frame only.
2280 Anything else means consider all windows on WINDOW's frame and no
2281 others.
2283 If you use consistent values for MINIBUF and ALL-FRAMES, you can
2284 use `previous-window' to iterate through the entire cycle of
2285 acceptable windows, eventually ending up back at the window you
2286 started with. `next-window' traverses the same cycle, in the
2287 reverse order. */)
2288 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2290 return next_window (window, minibuf, all_frames, 0);
2294 /* Return a list of windows in cyclic ordering. Arguments are like
2295 for `next-window'. */
2297 static Lisp_Object
2298 window_list_1 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2300 Lisp_Object tail, list, rest;
2302 decode_next_window_args (&window, &minibuf, &all_frames);
2303 list = Qnil;
2305 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
2306 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
2307 list = Fcons (XCAR (tail), list);
2309 /* Rotate the list to start with WINDOW. */
2310 list = Fnreverse (list);
2311 rest = Fmemq (window, list);
2312 if (!NILP (rest) && !EQ (rest, list))
2314 for (tail = list; !EQ (XCDR (tail), rest); tail = XCDR (tail))
2316 XSETCDR (tail, Qnil);
2317 list = nconc2 (rest, list);
2319 return list;
2323 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
2324 doc: /* Return a list of windows on FRAME, starting with WINDOW.
2325 FRAME nil or omitted means use the selected frame.
2326 WINDOW nil or omitted means use the selected window.
2327 MINIBUF t means include the minibuffer window, even if it isn't active.
2328 MINIBUF nil or omitted means include the minibuffer window only
2329 if it's active.
2330 MINIBUF neither nil nor t means never include the minibuffer window. */)
2331 (Lisp_Object frame, Lisp_Object minibuf, Lisp_Object window)
2333 if (NILP (window))
2334 window = FRAMEP (frame) ? XFRAME (frame)->selected_window : selected_window;
2335 CHECK_WINDOW (window);
2336 if (NILP (frame))
2337 frame = selected_frame;
2339 if (!EQ (frame, XWINDOW (window)->frame))
2340 error ("Window is on a different frame");
2342 return window_list_1 (window, minibuf, frame);
2346 DEFUN ("window-list-1", Fwindow_list_1, Swindow_list_1, 0, 3, 0,
2347 doc: /* Return a list of all live windows.
2348 WINDOW specifies the first window to list and defaults to the selected
2349 window.
2351 Optional argument MINIBUF nil or omitted means consider the minibuffer
2352 window only if the minibuffer is active. MINIBUF t means consider the
2353 minibuffer window even if the minibuffer is not active. Any other value
2354 means do not consider the minibuffer window even if the minibuffer is
2355 active.
2357 Optional argument ALL-FRAMES nil or omitted means consider all windows
2358 on WINDOW's frame, plus the minibuffer window if specified by the
2359 MINIBUF argument. If the minibuffer counts, consider all windows on all
2360 frames that share that minibuffer too. The following non-nil values of
2361 ALL-FRAMES have special meanings:
2363 - t means consider all windows on all existing frames.
2365 - `visible' means consider all windows on all visible frames.
2367 - 0 (the number zero) means consider all windows on all visible and
2368 iconified frames.
2370 - A frame means consider all windows on that frame only.
2372 Anything else means consider all windows on WINDOW's frame and no
2373 others.
2375 If WINDOW is not on the list of windows returned, some other window will
2376 be listed first but no error is signalled. */)
2377 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2379 return window_list_1 (window, minibuf, all_frames);
2382 /* Look at all windows, performing an operation specified by TYPE
2383 with argument OBJ.
2384 If FRAMES is Qt, look at all frames;
2385 Qnil, look at just the selected frame;
2386 Qvisible, look at visible frames;
2387 a frame, just look at windows on that frame.
2388 If MINI is non-zero, perform the operation on minibuffer windows too. */
2390 enum window_loop
2392 WINDOW_LOOP_UNUSED,
2393 GET_BUFFER_WINDOW, /* Arg is buffer */
2394 REPLACE_BUFFER_IN_WINDOWS_SAFELY, /* Arg is buffer */
2395 REDISPLAY_BUFFER_WINDOWS, /* Arg is buffer */
2396 CHECK_ALL_WINDOWS
2399 static Lisp_Object
2400 window_loop (enum window_loop type, Lisp_Object obj, int mini, Lisp_Object frames)
2402 Lisp_Object window, windows, best_window, frame_arg;
2403 int frame_best_window_flag = 0;
2404 struct frame *f;
2405 struct gcpro gcpro1;
2407 /* If we're only looping through windows on a particular frame,
2408 frame points to that frame. If we're looping through windows
2409 on all frames, frame is 0. */
2410 if (FRAMEP (frames))
2411 f = XFRAME (frames);
2412 else if (NILP (frames))
2413 f = SELECTED_FRAME ();
2414 else
2415 f = NULL;
2417 if (f)
2418 frame_arg = Qlambda;
2419 else if (EQ (frames, make_number (0)))
2420 frame_arg = frames;
2421 else if (EQ (frames, Qvisible))
2422 frame_arg = frames;
2423 else
2424 frame_arg = Qt;
2426 /* frame_arg is Qlambda to stick to one frame,
2427 Qvisible to consider all visible frames,
2428 or Qt otherwise. */
2430 /* Pick a window to start with. */
2431 if (WINDOWP (obj))
2432 window = obj;
2433 else if (f)
2434 window = FRAME_SELECTED_WINDOW (f);
2435 else
2436 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2438 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
2439 GCPRO1 (windows);
2440 best_window = Qnil;
2442 for (; CONSP (windows); windows = XCDR (windows))
2444 struct window *w;
2446 window = XCAR (windows);
2447 w = XWINDOW (window);
2449 /* Note that we do not pay attention here to whether the frame
2450 is visible, since Fwindow_list skips non-visible frames if
2451 that is desired, under the control of frame_arg. */
2452 if (!MINI_WINDOW_P (w)
2453 /* For REPLACE_BUFFER_IN_WINDOWS_SAFELY, we must always
2454 consider all windows. */
2455 || type == REPLACE_BUFFER_IN_WINDOWS_SAFELY
2456 || (mini && minibuf_level > 0))
2457 switch (type)
2459 case GET_BUFFER_WINDOW:
2460 if (EQ (w->buffer, obj)
2461 /* Don't find any minibuffer window except the one that
2462 is currently in use. */
2463 && (MINI_WINDOW_P (w) ? EQ (window, minibuf_window) : 1))
2465 if (EQ (window, selected_window))
2466 /* Preferably return the selected window. */
2467 RETURN_UNGCPRO (window);
2468 else if (EQ (XWINDOW (window)->frame, selected_frame)
2469 && !frame_best_window_flag)
2470 /* Prefer windows on the current frame (but don't
2471 choose another one if we have one already). */
2473 best_window = window;
2474 frame_best_window_flag = 1;
2476 else if (NILP (best_window))
2477 best_window = window;
2479 break;
2481 case REPLACE_BUFFER_IN_WINDOWS_SAFELY:
2482 /* We could simply check whether the buffer shown by window
2483 is live, and show another buffer in case it isn't. */
2484 if (EQ (w->buffer, obj))
2486 /* Undedicate WINDOW. */
2487 w->dedicated = Qnil;
2488 /* Make WINDOW show the buffer returned by
2489 other_buffer_safely, don't run any hooks. */
2490 set_window_buffer
2491 (window, other_buffer_safely (w->buffer), 0, 0);
2492 /* If WINDOW is the selected window, make its buffer
2493 current. But do so only if the window shows the
2494 current buffer (Bug#6454). */
2495 if (EQ (window, selected_window)
2496 && XBUFFER (w->buffer) == current_buffer)
2497 Fset_buffer (w->buffer);
2499 break;
2501 case REDISPLAY_BUFFER_WINDOWS:
2502 if (EQ (w->buffer, obj))
2504 mark_window_display_accurate (window, 0);
2505 w->update_mode_line = Qt;
2506 XBUFFER (obj)->prevent_redisplay_optimizations_p = 1;
2507 ++update_mode_lines;
2508 best_window = window;
2510 break;
2512 /* Check for a window that has a killed buffer. */
2513 case CHECK_ALL_WINDOWS:
2514 if (! NILP (w->buffer)
2515 && NILP (BVAR (XBUFFER (w->buffer), name)))
2516 abort ();
2517 break;
2519 case WINDOW_LOOP_UNUSED:
2520 break;
2524 UNGCPRO;
2525 return best_window;
2528 /* Used for debugging. Abort if any window has a dead buffer. */
2530 extern void check_all_windows (void) EXTERNALLY_VISIBLE;
2531 void
2532 check_all_windows (void)
2534 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2537 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 0, 2, 0,
2538 doc: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2539 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to
2540 the current buffer.
2542 The optional argument ALL-FRAMES specifies the frames to consider:
2544 - t means consider all windows on all existing frames.
2546 - `visible' means consider all windows on all visible frames.
2548 - 0 (the number zero) means consider all windows on all visible
2549 and iconified frames.
2551 - A frame means consider all windows on that frame only.
2553 Any other value of ALL-FRAMES means consider all windows on the
2554 selected frame and no others. */)
2555 (Lisp_Object buffer_or_name, Lisp_Object all_frames)
2557 Lisp_Object buffer;
2559 if (NILP (buffer_or_name))
2560 buffer = Fcurrent_buffer ();
2561 else
2562 buffer = Fget_buffer (buffer_or_name);
2564 if (BUFFERP (buffer))
2565 return window_loop (GET_BUFFER_WINDOW, buffer, 1, all_frames);
2566 else
2567 return Qnil;
2570 static Lisp_Object
2571 resize_root_window (Lisp_Object window, Lisp_Object delta, Lisp_Object horizontal, Lisp_Object ignore)
2573 return call4 (Qwindow_resize_root_window, window, delta, horizontal, ignore);
2577 DEFUN ("delete-other-windows-internal", Fdelete_other_windows_internal,
2578 Sdelete_other_windows_internal, 0, 2, "",
2579 doc: /* Make WINDOW fill its frame.
2580 Only the frame WINDOW is on is affected. WINDOW may be any window and
2581 defaults to the selected one.
2583 Optional argument ROOT, if non-nil, must specify an internal window
2584 containing WINDOW as a subwindow. If this is the case, replace ROOT by
2585 WINDOW and leave alone any windows not contained in ROOT.
2587 When WINDOW is live try to reduce display jumps by keeping the text
2588 previously visible in WINDOW in the same place on the frame. Doing this
2589 depends on the value of (window-start WINDOW), so if calling this
2590 function in a program gives strange scrolling, make sure the
2591 window-start value is reasonable when this function is called. */)
2592 (Lisp_Object window, Lisp_Object root)
2594 struct window *w, *r, *s;
2595 struct frame *f;
2596 Lisp_Object sibling, pwindow, swindow IF_LINT (= Qnil), delta;
2597 EMACS_INT startpos IF_LINT (= 0);
2598 int top IF_LINT (= 0), new_top, resize_failed;
2600 w = decode_any_window (window);
2601 XSETWINDOW (window, w);
2602 f = XFRAME (w->frame);
2604 if (NILP (root))
2605 /* ROOT is the frame's root window. */
2607 root = FRAME_ROOT_WINDOW (f);
2608 r = XWINDOW (root);
2610 else
2611 /* ROOT must be an ancestor of WINDOW. */
2613 r = decode_any_window (root);
2614 pwindow = XWINDOW (window)->parent;
2615 while (!NILP (pwindow))
2616 if (EQ (pwindow, root))
2617 break;
2618 else
2619 pwindow = XWINDOW (pwindow)->parent;
2620 if (!EQ (pwindow, root))
2621 error ("Specified root is not an ancestor of specified window");
2624 if (EQ (window, root))
2625 /* A noop. */
2626 return Qnil;
2627 /* I don't understand the "top > 0" part below. If we deal with a
2628 standalone minibuffer it would have been caught by the preceding
2629 test. */
2630 else if (MINI_WINDOW_P (w)) /* && top > 0) */
2631 error ("Can't expand minibuffer to full frame");
2633 if (!NILP (w->buffer))
2635 startpos = marker_position (w->start);
2636 top = WINDOW_TOP_EDGE_LINE (w)
2637 - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2638 /* Make sure WINDOW is the frame's selected window. */
2639 if (!EQ (window, FRAME_SELECTED_WINDOW (f)))
2641 if (EQ (selected_frame, w->frame))
2642 Fselect_window (window, Qnil);
2643 else
2644 FRAME_SELECTED_WINDOW (f) = window;
2647 else
2649 /* See if the frame's selected window is a subwindow of WINDOW, by
2650 finding all the selected window's parents and comparing each
2651 one with WINDOW. If it isn't we need a new selected window for
2652 this frame. */
2653 swindow = FRAME_SELECTED_WINDOW (f);
2654 while (1)
2656 pwindow = swindow;
2657 while (!NILP (pwindow) && !EQ (window, pwindow))
2658 pwindow = XWINDOW (pwindow)->parent;
2660 if (EQ (window, pwindow))
2661 /* If WINDOW is an ancestor of SWINDOW, then SWINDOW is ok
2662 as the new selected window. */
2663 break;
2664 else
2665 /* Else try the previous window of SWINDOW. */
2666 swindow = Fprevious_window (swindow, Qlambda, Qnil);
2669 if (!EQ (swindow, FRAME_SELECTED_WINDOW (f)))
2671 if (EQ (selected_frame, w->frame))
2672 Fselect_window (swindow, Qnil);
2673 else
2674 FRAME_SELECTED_WINDOW (f) = swindow;
2678 BLOCK_INPUT;
2679 free_window_matrices (r);
2681 windows_or_buffers_changed++;
2682 Vwindow_list = Qnil;
2683 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
2684 resize_failed = 0;
2686 if (NILP (w->buffer))
2688 /* Resize subwindows vertically. */
2689 XSETINT (delta, XINT (r->total_lines) - XINT (w->total_lines));
2690 w->top_line = r->top_line;
2691 resize_root_window (window, delta, Qnil, Qnil);
2692 if (window_resize_check (w, 0))
2693 window_resize_apply (w, 0);
2694 else
2696 resize_root_window (window, delta, Qnil, Qt);
2697 if (window_resize_check (w, 0))
2698 window_resize_apply (w, 0);
2699 else
2700 resize_failed = 1;
2703 /* Resize subwindows horizontally. */
2704 if (!resize_failed)
2706 w->left_col = r->left_col;
2707 XSETINT (delta, XINT (r->total_cols) - XINT (w->total_cols));
2708 w->left_col = r->left_col;
2709 resize_root_window (window, delta, Qt, Qnil);
2710 if (window_resize_check (w, 1))
2711 window_resize_apply (w, 1);
2712 else
2714 resize_root_window (window, delta, Qt, Qt);
2715 if (window_resize_check (w, 1))
2716 window_resize_apply (w, 1);
2717 else
2718 resize_failed = 1;
2722 if (resize_failed)
2723 /* Play safe, if we still can ... */
2725 window = swindow;
2726 w = XWINDOW (window);
2730 /* Cleanly unlink WINDOW from window-tree. */
2731 if (!NILP (w->prev))
2732 /* Get SIBLING above (on the left of) WINDOW. */
2734 sibling = w->prev;
2735 s = XWINDOW (sibling);
2736 s->next = w->next;
2737 if (!NILP (s->next))
2738 XWINDOW (s->next)->prev = sibling;
2740 else
2741 /* Get SIBLING below (on the right of) WINDOW. */
2743 sibling = w->next;
2744 s = XWINDOW (sibling);
2745 s->prev = Qnil;
2746 if (!NILP (XWINDOW (w->parent)->vchild))
2747 XWINDOW (w->parent)->vchild = sibling;
2748 else
2749 XWINDOW (w->parent)->hchild = sibling;
2752 /* Delete ROOT and all subwindows of ROOT. */
2753 if (!NILP (r->vchild))
2755 delete_all_subwindows (r->vchild);
2756 r->vchild = Qnil;
2758 else if (!NILP (r->hchild))
2760 delete_all_subwindows (r->hchild);
2761 r->hchild = Qnil;
2764 replace_window (root, window, 1);
2766 /* Reset WINDOW's splits status. */
2767 w->splits = Qnil;
2769 /* This must become SWINDOW anyway ....... */
2770 if (!NILP (w->buffer) && !resize_failed)
2772 /* Try to minimize scrolling, by setting the window start to the
2773 point will cause the text at the old window start to be at the
2774 same place on the frame. But don't try to do this if the
2775 window start is outside the visible portion (as might happen
2776 when the display is not current, due to typeahead). */
2777 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2778 if (new_top != top
2779 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2780 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2782 struct position pos;
2783 struct buffer *obuf = current_buffer;
2785 Fset_buffer (w->buffer);
2786 /* This computation used to temporarily move point, but that
2787 can have unwanted side effects due to text properties. */
2788 pos = *vmotion (startpos, -top, w);
2790 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2791 w->window_end_valid = Qnil;
2792 w->start_at_line_beg = ((pos.bytepos == BEGV_BYTE
2793 || FETCH_BYTE (pos.bytepos - 1) == '\n') ? Qt
2794 : Qnil);
2795 /* We need to do this, so that the window-scroll-functions
2796 get called. */
2797 w->optional_new_start = Qt;
2799 set_buffer_internal (obuf);
2803 adjust_glyphs (f);
2804 UNBLOCK_INPUT;
2806 run_window_configuration_change_hook (f);
2808 return Qnil;
2812 void
2813 replace_buffer_in_windows (Lisp_Object buffer)
2815 call1 (Qreplace_buffer_in_windows, buffer);
2819 /* Safely replace BUFFER with some other buffer in all windows of all
2820 frames, even those on other keyboards. */
2822 void
2823 replace_buffer_in_windows_safely (Lisp_Object buffer)
2825 Lisp_Object tail, frame;
2827 /* A single call to window_loop won't do the job because it only
2828 considers frames on the current keyboard. So loop manually over
2829 frames, and handle each one. */
2830 FOR_EACH_FRAME (tail, frame)
2831 window_loop (REPLACE_BUFFER_IN_WINDOWS_SAFELY, buffer, 1, frame);
2834 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2835 minimum allowable size. */
2837 void
2838 check_frame_size (FRAME_PTR frame, int *rows, int *cols)
2840 /* For height, we have to see:
2841 how many windows the frame has at minimum (one or two),
2842 and whether it has a menu bar or other special stuff at the top. */
2843 int min_height
2844 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
2845 ? MIN_SAFE_WINDOW_HEIGHT
2846 : 2 * MIN_SAFE_WINDOW_HEIGHT);
2848 if (FRAME_TOP_MARGIN (frame) > 0)
2849 min_height += FRAME_TOP_MARGIN (frame);
2851 if (*rows < min_height)
2852 *rows = min_height;
2853 if (*cols < MIN_SAFE_WINDOW_WIDTH)
2854 *cols = MIN_SAFE_WINDOW_WIDTH;
2857 /* Adjust the margins of window W if text area is too small.
2858 Return 1 if window width is ok after adjustment; 0 if window
2859 is still too narrow. */
2861 static int
2862 adjust_window_margins (struct window *w)
2864 int box_cols = (WINDOW_TOTAL_COLS (w)
2865 - WINDOW_FRINGE_COLS (w)
2866 - WINDOW_SCROLL_BAR_COLS (w));
2867 int margin_cols = (WINDOW_LEFT_MARGIN_COLS (w)
2868 + WINDOW_RIGHT_MARGIN_COLS (w));
2870 if (box_cols - margin_cols >= MIN_SAFE_WINDOW_WIDTH)
2871 return 1;
2873 if (margin_cols < 0 || box_cols < MIN_SAFE_WINDOW_WIDTH)
2874 return 0;
2876 /* Window's text area is too narrow, but reducing the window
2877 margins will fix that. */
2878 margin_cols = box_cols - MIN_SAFE_WINDOW_WIDTH;
2879 if (WINDOW_RIGHT_MARGIN_COLS (w) > 0)
2881 if (WINDOW_LEFT_MARGIN_COLS (w) > 0)
2882 w->left_margin_cols = w->right_margin_cols
2883 = make_number (margin_cols/2);
2884 else
2885 w->right_margin_cols = make_number (margin_cols);
2887 else
2888 w->left_margin_cols = make_number (margin_cols);
2889 return 1;
2892 static Lisp_Object Fset_window_margins (Lisp_Object, Lisp_Object, Lisp_Object);
2893 static Lisp_Object Fset_window_fringes (Lisp_Object, Lisp_Object, Lisp_Object,
2894 Lisp_Object);
2895 static Lisp_Object Fset_window_scroll_bars (Lisp_Object, Lisp_Object,
2896 Lisp_Object, Lisp_Object);
2897 static Lisp_Object Fset_window_vscroll (Lisp_Object, Lisp_Object, Lisp_Object);
2899 /* The following three routines are needed for running a window's
2900 configuration change hook. */
2901 static void
2902 run_funs (Lisp_Object funs)
2904 for (; CONSP (funs); funs = XCDR (funs))
2905 if (!EQ (XCAR (funs), Qt))
2906 call0 (XCAR (funs));
2909 static Lisp_Object
2910 select_window_norecord (Lisp_Object window)
2912 return WINDOW_LIVE_P (window)
2913 ? Fselect_window (window, Qt) : selected_window;
2916 static Lisp_Object
2917 select_frame_norecord (Lisp_Object frame)
2919 return FRAME_LIVE_P (XFRAME (frame))
2920 ? Fselect_frame (frame, Qt) : selected_frame;
2923 void
2924 run_window_configuration_change_hook (struct frame *f)
2926 int count = SPECPDL_INDEX ();
2927 Lisp_Object frame, global_wcch
2928 = Fdefault_value (Qwindow_configuration_change_hook);
2929 XSETFRAME (frame, f);
2931 if (NILP (Vrun_hooks))
2932 return;
2934 /* Use the right buffer. Matters when running the local hooks. */
2935 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
2937 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
2938 Fset_buffer (Fwindow_buffer (Qnil));
2941 if (SELECTED_FRAME () != f)
2943 record_unwind_protect (select_frame_norecord, Fselected_frame ());
2944 select_frame_norecord (frame);
2947 /* Look for buffer-local values. */
2949 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
2950 for (; CONSP (windows); windows = XCDR (windows))
2952 Lisp_Object window = XCAR (windows);
2953 Lisp_Object buffer = Fwindow_buffer (window);
2954 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
2955 buffer)))
2957 int inner_count = SPECPDL_INDEX ();
2958 record_unwind_protect (select_window_norecord, Fselected_window ());
2959 select_window_norecord (window);
2960 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
2961 buffer));
2962 unbind_to (inner_count, Qnil);
2967 run_funs (global_wcch);
2968 unbind_to (count, Qnil);
2971 DEFUN ("run-window-configuration-change-hook", Frun_window_configuration_change_hook,
2972 Srun_window_configuration_change_hook, 1, 1, 0,
2973 doc: /* Run `window-configuration-change-hook' for FRAME. */)
2974 (Lisp_Object frame)
2976 CHECK_LIVE_FRAME (frame);
2977 run_window_configuration_change_hook (XFRAME (frame));
2978 return Qnil;
2981 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
2982 means it's allowed to run hooks. See make_frame for a case where
2983 it's not allowed. KEEP_MARGINS_P non-zero means that the current
2984 margins, fringes, and scroll-bar settings of the window are not
2985 reset from the buffer's local settings. */
2987 void
2988 set_window_buffer (Lisp_Object window, Lisp_Object buffer, int run_hooks_p, int keep_margins_p)
2990 struct window *w = XWINDOW (window);
2991 struct buffer *b = XBUFFER (buffer);
2992 int count = SPECPDL_INDEX ();
2993 int samebuf = EQ (buffer, w->buffer);
2995 w->buffer = buffer;
2997 if (EQ (window, selected_window))
2998 BVAR (b, last_selected_window) = window;
3000 /* Let redisplay errors through. */
3001 b->display_error_modiff = 0;
3003 /* Update time stamps of buffer display. */
3004 if (INTEGERP (BVAR (b, display_count)))
3005 XSETINT (BVAR (b, display_count), XINT (BVAR (b, display_count)) + 1);
3006 BVAR (b, display_time) = Fcurrent_time ();
3008 XSETFASTINT (w->window_end_pos, 0);
3009 XSETFASTINT (w->window_end_vpos, 0);
3010 memset (&w->last_cursor, 0, sizeof w->last_cursor);
3011 w->window_end_valid = Qnil;
3012 if (!(keep_margins_p && samebuf))
3013 { /* If we're not actually changing the buffer, don't reset hscroll and
3014 vscroll. This case happens for example when called from
3015 change_frame_size_1, where we use a dummy call to
3016 Fset_window_buffer on the frame's selected window (and no other)
3017 just in order to run window-configuration-change-hook.
3018 Resetting hscroll and vscroll here is problematic for things like
3019 image-mode and doc-view-mode since it resets the image's position
3020 whenever we resize the frame. */
3021 w->hscroll = w->min_hscroll = make_number (0);
3022 w->vscroll = 0;
3023 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3024 set_marker_restricted (w->start,
3025 make_number (b->last_window_start),
3026 buffer);
3027 w->start_at_line_beg = Qnil;
3028 w->force_start = Qnil;
3029 XSETFASTINT (w->last_modified, 0);
3030 XSETFASTINT (w->last_overlay_modified, 0);
3032 /* Maybe we could move this into the `if' but it's not obviously safe and
3033 I doubt it's worth the trouble. */
3034 windows_or_buffers_changed++;
3036 /* We must select BUFFER for running the window-scroll-functions. */
3037 /* We can't check ! NILP (Vwindow_scroll_functions) here
3038 because that might itself be a local variable. */
3039 if (window_initialized)
3041 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3042 Fset_buffer (buffer);
3045 XMARKER (w->pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3047 if (!keep_margins_p)
3049 /* Set left and right marginal area width etc. from buffer. */
3051 /* This may call adjust_window_margins three times, so
3052 temporarily disable window margins. */
3053 Lisp_Object save_left = w->left_margin_cols;
3054 Lisp_Object save_right = w->right_margin_cols;
3056 w->left_margin_cols = w->right_margin_cols = Qnil;
3058 Fset_window_fringes (window,
3059 BVAR (b, left_fringe_width), BVAR (b, right_fringe_width),
3060 BVAR (b, fringes_outside_margins));
3062 Fset_window_scroll_bars (window,
3063 BVAR (b, scroll_bar_width),
3064 BVAR (b, vertical_scroll_bar_type), Qnil);
3066 w->left_margin_cols = save_left;
3067 w->right_margin_cols = save_right;
3069 Fset_window_margins (window,
3070 BVAR (b, left_margin_cols), BVAR (b, right_margin_cols));
3073 if (run_hooks_p)
3075 if (! NILP (Vwindow_scroll_functions))
3076 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3077 Fmarker_position (w->start));
3078 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3081 unbind_to (count, Qnil);
3084 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3085 doc: /* Make WINDOW display BUFFER-OR-NAME as its contents.
3086 WINDOW has to be a live window and defaults to the selected one.
3087 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3089 Optional third argument KEEP-MARGINS non-nil means that WINDOW's current
3090 display margins, fringe widths, and scroll bar settings are preserved;
3091 the default is to reset these from the local settings for BUFFER-OR-NAME
3092 or the frame defaults. Return nil.
3094 This function throws an error when WINDOW is strongly dedicated to its
3095 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3096 already display BUFFER-OR-NAME.
3098 This function runs `window-scroll-functions' before running
3099 `window-configuration-change-hook'. */)
3100 (register Lisp_Object window, Lisp_Object buffer_or_name, Lisp_Object keep_margins)
3102 register Lisp_Object tem, buffer;
3103 register struct window *w = decode_window (window);
3105 XSETWINDOW (window, w);
3106 buffer = Fget_buffer (buffer_or_name);
3107 CHECK_BUFFER (buffer);
3108 if (NILP (BVAR (XBUFFER (buffer), name)))
3109 error ("Attempt to display deleted buffer");
3111 tem = w->buffer;
3112 if (NILP (tem))
3113 error ("Window is deleted");
3114 else if (!EQ (tem, Qt))
3115 /* w->buffer is t when the window is first being set up. */
3117 if (!EQ (tem, buffer))
3119 if (EQ (w->dedicated, Qt))
3120 /* WINDOW is strongly dedicated to its buffer, signal an
3121 error. */
3122 error ("Window is dedicated to `%s'", SDATA (BVAR (XBUFFER (tem), name)));
3123 else
3124 /* WINDOW is weakly dedicated to its buffer, reset
3125 dedicatedness. */
3126 w->dedicated = Qnil;
3128 call1 (Qrecord_window_buffer, window);
3131 unshow_buffer (w);
3134 set_window_buffer (window, buffer, 1, !NILP (keep_margins));
3136 return Qnil;
3139 static Lisp_Object
3140 display_buffer (Lisp_Object buffer, Lisp_Object not_this_window_p, Lisp_Object override_frame)
3142 return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame);
3145 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3146 0, 1, 0,
3147 doc: /* Force all windows to be updated on next redisplay.
3148 If optional arg OBJECT is a window, force redisplay of that window only.
3149 If OBJECT is a buffer or buffer name, force redisplay of all windows
3150 displaying that buffer. */)
3151 (Lisp_Object object)
3153 if (NILP (object))
3155 windows_or_buffers_changed++;
3156 update_mode_lines++;
3157 return Qt;
3160 if (WINDOWP (object))
3162 struct window *w = XWINDOW (object);
3163 mark_window_display_accurate (object, 0);
3164 w->update_mode_line = Qt;
3165 if (BUFFERP (w->buffer))
3166 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
3167 ++update_mode_lines;
3168 return Qt;
3171 if (STRINGP (object))
3172 object = Fget_buffer (object);
3173 if (BUFFERP (object) && !NILP (BVAR (XBUFFER (object), name)))
3175 /* Walk all windows looking for buffer, and force update
3176 of each of those windows. */
3178 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, 0, Qvisible);
3179 return NILP (object) ? Qnil : Qt;
3182 /* If nothing suitable was found, just return.
3183 We could signal an error, but this feature will typically be used
3184 asynchronously in timers or process sentinels, so we don't. */
3185 return Qnil;
3189 void
3190 temp_output_buffer_show (register Lisp_Object buf)
3192 register struct buffer *old = current_buffer;
3193 register Lisp_Object window;
3194 register struct window *w;
3196 BVAR (XBUFFER (buf), directory) = BVAR (current_buffer, directory);
3198 Fset_buffer (buf);
3199 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3200 BEGV = BEG;
3201 ZV = Z;
3202 SET_PT (BEG);
3203 set_buffer_internal (old);
3205 if (!NILP (Vtemp_buffer_show_function))
3206 call1 (Vtemp_buffer_show_function, buf);
3207 else
3209 window = display_buffer (buf, Vtemp_buffer_show_specifiers, Qnil);
3210 /* Reset Vtemp_buffer_show_specifiers immediately so it won't
3211 affect subsequent calls. */
3212 Vtemp_buffer_show_specifiers = Qnil;
3214 if (!EQ (XWINDOW (window)->frame, selected_frame))
3215 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3216 Vminibuf_scroll_window = window;
3217 w = XWINDOW (window);
3218 XSETFASTINT (w->hscroll, 0);
3219 XSETFASTINT (w->min_hscroll, 0);
3220 set_marker_restricted_both (w->start, buf, BEG, BEG);
3221 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
3223 /* Run temp-buffer-show-hook, with the chosen window selected
3224 and its buffer current. */
3226 int count = SPECPDL_INDEX ();
3227 Lisp_Object prev_window, prev_buffer;
3228 prev_window = selected_window;
3229 XSETBUFFER (prev_buffer, old);
3231 /* Select the window that was chosen, for running the hook.
3232 Note: Both Fselect_window and select_window_norecord may
3233 set-buffer to the buffer displayed in the window,
3234 so we need to save the current buffer. --stef */
3235 record_unwind_protect (Fset_buffer, prev_buffer);
3236 record_unwind_protect (select_window_norecord, prev_window);
3237 Fselect_window (window, Qt);
3238 Fset_buffer (w->buffer);
3239 Frun_hooks (1, &Qtemp_buffer_show_hook);
3240 unbind_to (count, Qnil);
3245 DEFUN ("internal-temp-output-buffer-show",
3246 Ftemp_output_buffer_show, Stemp_output_buffer_show,
3247 1, 1, 0,
3248 doc: /* Internal function for `with-output-to-temp-buffer''. */)
3249 (Lisp_Object buf)
3251 temp_output_buffer_show (buf);
3252 return Qnil;
3255 /* Make new window, have it replace WINDOW in window-tree, and make
3256 WINDOW its only vertical child (HORFLAG 1 means make WINDOW its only
3257 horizontal child). */
3258 static void
3259 make_parent_window (Lisp_Object window, int horflag)
3261 Lisp_Object parent;
3262 register struct window *o, *p;
3263 int i;
3265 o = XWINDOW (window);
3266 p = allocate_window ();
3267 for (i = 0; i < VECSIZE (struct window); ++i)
3268 ((struct Lisp_Vector *) p)->contents[i]
3269 = ((struct Lisp_Vector *) o)->contents[i];
3270 XSETWINDOW (parent, p);
3272 ++sequence_number;
3273 XSETFASTINT (p->sequence_number, sequence_number);
3275 replace_window (window, parent, 1);
3277 o->next = Qnil;
3278 o->prev = Qnil;
3279 o->parent = parent;
3281 p->hchild = horflag ? window : Qnil;
3282 p->vchild = horflag ? Qnil : window;
3283 p->start = Qnil;
3284 p->pointm = Qnil;
3285 p->buffer = Qnil;
3286 p->splits = Qnil;
3287 p->nest = Qnil;
3288 p->window_parameters = Qnil;
3291 /* Make new window from scratch. */
3292 Lisp_Object
3293 make_window (void)
3295 Lisp_Object window;
3296 register struct window *w;
3298 w = allocate_window ();
3299 /* Initialize all Lisp data. */
3300 w->frame = w->mini_p = Qnil;
3301 w->next = w->prev = w->hchild = w->vchild = w->parent = Qnil;
3302 XSETFASTINT (w->left_col, 0);
3303 XSETFASTINT (w->top_line, 0);
3304 XSETFASTINT (w->total_lines, 0);
3305 XSETFASTINT (w->total_cols, 0);
3306 w->normal_lines = make_float (1.0);
3307 w->normal_cols = make_float (1.0);
3308 XSETFASTINT (w->new_total, 0);
3309 XSETFASTINT (w->new_normal, 0);
3310 w->buffer = Qnil;
3311 w->start = Fmake_marker ();
3312 w->pointm = Fmake_marker ();
3313 w->force_start = w->optional_new_start = Qnil;
3314 XSETFASTINT (w->hscroll, 0);
3315 XSETFASTINT (w->min_hscroll, 0);
3316 XSETFASTINT (w->use_time, 0);
3317 ++sequence_number;
3318 XSETFASTINT (w->sequence_number, sequence_number);
3319 w->temslot = w->last_modified = w->last_overlay_modified = Qnil;
3320 XSETFASTINT (w->last_point, 0);
3321 w->last_had_star = w->vertical_scroll_bar = Qnil;
3322 w->left_margin_cols = w->right_margin_cols = Qnil;
3323 w->left_fringe_width = w->right_fringe_width = Qnil;
3324 w->fringes_outside_margins = Qnil;
3325 w->scroll_bar_width = Qnil;
3326 w->vertical_scroll_bar_type = Qt;
3327 w->last_mark_x = w->last_mark_y = Qnil;
3328 XSETFASTINT (w->window_end_pos, 0);
3329 XSETFASTINT (w->window_end_vpos, 0);
3330 w->window_end_valid = w->update_mode_line = Qnil;
3331 w->start_at_line_beg = w->display_table = w->dedicated = Qnil;
3332 w->base_line_number = w->base_line_pos = w->region_showing = Qnil;
3333 w->column_number_displayed = w->redisplay_end_trigger = Qnil;
3334 w->splits = w->nest = w->window_parameters = Qnil;
3335 w->prev_buffers = w->next_buffers = Qnil;
3336 /* Initialize non-Lisp data. */
3337 w->desired_matrix = w->current_matrix = 0;
3338 w->nrows_scale_factor = w->ncols_scale_factor = 1;
3339 memset (&w->cursor, 0, sizeof (w->cursor));
3340 memset (&w->last_cursor, 0, sizeof (w->last_cursor));
3341 memset (&w->phys_cursor, 0, sizeof (w->phys_cursor));
3342 w->phys_cursor_type = -1;
3343 w->phys_cursor_width = -1;
3344 w->last_cursor_off_p = w->cursor_off_p = 0;
3345 w->must_be_updated_p = 0;
3346 w->pseudo_window_p = 0;
3347 w->frozen_window_start_p = 0;
3348 w->vscroll = 0;
3349 /* Reset window_list. */
3350 Vwindow_list = Qnil;
3351 /* Return window. */
3352 XSETWINDOW (window, w);
3353 return window;
3356 DEFUN ("set-window-new-total", Fset_window_new_total, Sset_window_new_total, 2, 3, 0,
3357 doc: /* Set new total size of WINDOW to SIZE.
3358 Return SIZE.
3360 Optional argument ADD non-nil means add SIZE to the new total size of
3361 WINDOW and return the sum.
3363 Note: This function does not operate on any subwindows of WINDOW. */)
3364 (Lisp_Object window, Lisp_Object size, Lisp_Object add)
3366 struct window *w = decode_any_window (window);
3368 CHECK_NUMBER (size);
3369 if (NILP (add))
3370 XSETINT (w->new_total, XINT (size));
3371 else
3372 XSETINT (w->new_total, XINT (w->new_total) + XINT (size));
3374 return w->new_total;
3377 DEFUN ("set-window-new-normal", Fset_window_new_normal, Sset_window_new_normal, 1, 2, 0,
3378 doc: /* Set new normal size of WINDOW to SIZE.
3379 Return SIZE.
3381 Note: This function does not operate on any subwindows of WINDOW. */)
3382 (Lisp_Object window, Lisp_Object size)
3384 struct window *w = decode_any_window (window);
3386 w->new_normal = size;
3387 return w->new_normal;
3390 /* Return 1 if setting w->total_lines (w->total_cols if HORFLAG is
3391 non-zero) to w->new_total would result in correct heights (widths)
3392 for window W and recursively all subwindows of W.
3394 Note: This function does not check any of `window-fixed-size-p',
3395 `window-min-height' or `window-min-width'. It does check that window
3396 sizes do not drop below one line (two columns). */
3397 static int
3398 window_resize_check (struct window *w, int horflag)
3400 struct window *c;
3402 if (!NILP (w->vchild))
3403 /* W is a vertical combination. */
3405 c = XWINDOW (w->vchild);
3406 if (horflag)
3407 /* All subwindows of W must have the same width as W. */
3409 while (c)
3411 if ((XINT (c->new_total) != XINT (w->new_total))
3412 || !window_resize_check (c, horflag))
3413 return 0;
3414 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3416 return 1;
3418 else
3419 /* The sum of the heights of the subwindows of W must equal W's
3420 height. */
3422 int sum_of_sizes = 0;
3423 while (c)
3425 if (!window_resize_check (c, horflag))
3426 return 0;
3427 sum_of_sizes = sum_of_sizes + XINT (c->new_total);
3428 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3430 return (sum_of_sizes == XINT (w->new_total));
3433 else if (!NILP (w->hchild))
3434 /* W is a horizontal combination. */
3436 c = XWINDOW (w->hchild);
3437 if (horflag)
3438 /* The sum of the widths of the subwindows of W must equal W's
3439 width. */
3441 int sum_of_sizes = 0;
3442 while (c)
3444 if (!window_resize_check (c, horflag))
3445 return 0;
3446 sum_of_sizes = sum_of_sizes + XINT (c->new_total);
3447 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3449 return (sum_of_sizes == XINT (w->new_total));
3451 else
3452 /* All subwindows of W must have the same height as W. */
3454 while (c)
3456 if ((XINT (c->new_total) != XINT (w->new_total))
3457 || !window_resize_check (c, horflag))
3458 return 0;
3459 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3461 return 1;
3464 else
3465 /* A leaf window. Make sure it's not too small. The following
3466 hardcodes the values of `window-safe-min-width' (2) and
3467 `window-safe-min-height' (1) which are defined in window.el. */
3468 return XINT (w->new_total) >= (horflag ? 2 : 1);
3471 /* Set w->total_lines (w->total_cols if HORIZONTAL is non-zero) to
3472 w->new_total for window W and recursively all subwindows of W. Also
3473 calculate and assign the new vertical (horizontal) start positions of
3474 each of these windows.
3476 This function does not perform any error checks. Make sure you have
3477 run window_resize_check on W before applying this function. */
3478 static void
3479 window_resize_apply (struct window *w, int horflag)
3481 struct window *c;
3482 int pos;
3484 /* Note: Assigning new_normal requires that the new total size of the
3485 parent window has been set *before*. */
3486 if (horflag)
3488 w->total_cols = w->new_total;
3489 if (NUMBERP (w->new_normal))
3490 w->normal_cols = w->new_normal;
3492 pos = XINT (w->left_col);
3494 else
3496 w->total_lines = w->new_total;
3497 if (NUMBERP (w->new_normal))
3498 w->normal_lines = w->new_normal;
3500 pos = XINT (w->top_line);
3503 if (!NILP (w->vchild))
3504 /* W is a vertical combination. */
3506 c = XWINDOW (w->vchild);
3507 while (c)
3509 if (horflag)
3510 XSETFASTINT (c->left_col, pos);
3511 else
3512 XSETFASTINT (c->top_line, pos);
3513 window_resize_apply (c, horflag);
3514 if (!horflag)
3515 pos = pos + XINT (c->total_lines);
3516 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3519 else if (!NILP (w->hchild))
3520 /* W is a horizontal combination. */
3522 c = XWINDOW (w->hchild);
3523 while (c)
3525 if (horflag)
3526 XSETFASTINT (c->left_col, pos);
3527 else
3528 XSETFASTINT (c->top_line, pos);
3529 window_resize_apply (c, horflag);
3530 if (horflag)
3531 pos = pos + XINT (c->total_cols);
3532 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3536 /* Clear out some redisplay caches. */
3537 XSETFASTINT (w->last_modified, 0);
3538 XSETFASTINT (w->last_overlay_modified, 0);
3542 DEFUN ("window-resize-apply", Fwindow_resize_apply, Swindow_resize_apply, 1, 2, 0,
3543 doc: /* Apply requested size values for window-tree of FRAME.
3544 Optional argument HORIZONTAL omitted or nil means apply requested height
3545 values. HORIZONTAL non-nil means apply requested width values.
3547 This function checks whether the requested values sum up to a valid
3548 window layout, recursively assigns the new sizes of all subwindows and
3549 calculates and assigns the new start positions of these windows.
3551 Note: This function does not check any of `window-fixed-size-p',
3552 `window-min-height' or `window-min-width'. All these checks have to
3553 be applied on the Elisp level. */)
3554 (Lisp_Object frame, Lisp_Object horizontal)
3556 struct frame *f;
3557 struct window *r;
3558 int horflag = !NILP (horizontal);
3560 if (NILP (frame))
3561 frame = selected_frame;
3562 CHECK_LIVE_FRAME (frame);
3564 f = XFRAME (frame);
3565 r = XWINDOW (FRAME_ROOT_WINDOW (f));
3567 if (!window_resize_check (r, horflag)
3568 || ! EQ (r->new_total, (horflag ? r->total_cols : r->total_lines)))
3569 return Qnil;
3571 BLOCK_INPUT;
3572 window_resize_apply (r, horflag);
3574 windows_or_buffers_changed++;
3575 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3577 adjust_glyphs (f);
3578 UNBLOCK_INPUT;
3580 run_window_configuration_change_hook (f);
3582 return Qt;
3586 /* Resize frame F's windows when number of lines of F is set to SIZE.
3587 HORFLAG 1 means resize windows when number of columns of F is set to
3588 SIZE.
3590 This function can delete all windows but the selected one in order to
3591 satisfy the request. The result will be meaningful if and only if
3592 F's windows have meaningful sizes when you call this. */
3593 void
3594 resize_frame_windows (struct frame *f, int size, int horflag)
3596 Lisp_Object root = f->root_window;
3597 struct window *r = XWINDOW (root);
3598 Lisp_Object mini = f->minibuffer_window;
3599 struct window *m;
3600 /* new_size is the new size of the frame's root window. */
3601 int new_size = (horflag
3602 ? size
3603 : (size
3604 - FRAME_TOP_MARGIN (f)
3605 - ((FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
3606 ? 1 : 0)));
3608 XSETFASTINT (r->top_line, FRAME_TOP_MARGIN (f));
3609 if (NILP (r->vchild) && NILP (r->hchild))
3610 /* For a leaf root window just set the size. */
3611 if (horflag)
3612 XSETFASTINT (r->total_cols, new_size);
3613 else
3614 XSETFASTINT (r->total_lines, new_size);
3615 else
3617 /* old_size is the old size of the frame's root window. */
3618 int old_size = XFASTINT (horflag ? r->total_cols : r->total_lines);
3619 Lisp_Object delta;
3621 XSETINT (delta, new_size - old_size);
3622 /* Try a "normal" resize first. */
3623 resize_root_window (root, delta, horflag ? Qt : Qnil, Qnil);
3624 if (window_resize_check (r, horflag) && new_size == XINT (r->new_total))
3625 window_resize_apply (r, horflag);
3626 else
3628 /* Try with "reasonable" minimum sizes next. */
3629 resize_root_window (root, delta, horflag ? Qt : Qnil, Qt);
3630 if (window_resize_check (r, horflag)
3631 && new_size == XINT (r->new_total))
3632 window_resize_apply (r, horflag);
3633 else
3635 /* Finally, try with "safe" minimum sizes. */
3636 resize_root_window (root, delta, horflag ? Qt : Qnil, Qsafe);
3637 if (window_resize_check (r, horflag)
3638 && new_size == XINT (r->new_total))
3639 window_resize_apply (r, horflag);
3640 else
3642 /* We lost. Delete all windows but the frame's
3643 selected one. */
3644 root = f->selected_window;
3645 Fdelete_other_windows_internal (root, Qnil);
3646 if (horflag)
3647 XSETFASTINT (XWINDOW (root)->total_cols, new_size);
3648 else
3649 XSETFASTINT (XWINDOW (root)->total_lines, new_size);
3655 if (FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
3657 m = XWINDOW (mini);
3658 if (horflag)
3659 XSETFASTINT (m->total_cols, size);
3660 else
3662 /* Are we sure we always want 1 line here? */
3663 XSETFASTINT (m->total_lines, 1);
3664 XSETFASTINT (m->top_line, XINT (r->top_line) + XINT (r->total_lines));
3670 DEFUN ("split-window-internal", Fsplit_window_internal, Ssplit_window_internal, 4, 4, 0,
3671 doc: /* Split window OLD.
3672 Second argument TOTAL-SIZE specifies the number of lines or columns of the
3673 new window. In any case TOTAL-SIZE must be a positive integer.
3675 Third argument SIDE nil (or `below') specifies that the new window shall
3676 be located below WINDOW. SIDE `above' means the new window shall be
3677 located above WINDOW. In both cases TOTAL-SIZE specifies the number of
3678 lines of the new window including space reserved for the mode and/or
3679 header line.
3681 SIDE t (or `right') specifies that the new window shall be located on
3682 the right side of WINDOW. SIDE `left' means the new window shall be
3683 located on the left of WINDOW. In both cases TOTAL-SIZE specifies the
3684 number of columns of the new window including space reserved for fringes
3685 and the scrollbar or a divider column.
3687 Fourth argument NORMAL-SIZE specifies the normal size of the new window
3688 according to the SIDE argument.
3690 The new total and normal sizes of all involved windows must have been
3691 set correctly. See the code of `split-window' for how this is done. */)
3692 (Lisp_Object old, Lisp_Object total_size, Lisp_Object side, Lisp_Object normal_size)
3694 /* OLD (*o) is the window we have to split. (*p) is either OLD's
3695 parent window or an internal window we have to install as OLD's new
3696 parent. REFERENCE (*r) must denote a live window, or is set to OLD
3697 provided OLD is a leaf window, or to the frame's selected window.
3698 NEW (*n) is the new window created with some parameters taken from
3699 REFERENCE (*r). */
3700 register Lisp_Object new, frame, reference;
3701 register struct window *o, *p, *n, *r;
3702 struct frame *f;
3703 int horflag
3704 /* HORFLAG is 1 when we split side-by-side, 0 otherwise. */
3705 = EQ (side, Qt) || EQ (side, Qleft) || EQ (side, Qright);
3706 int do_nest = 0;
3708 CHECK_WINDOW (old);
3709 o = XWINDOW (old);
3710 frame = WINDOW_FRAME (o);
3711 f = XFRAME (frame);
3713 CHECK_NUMBER (total_size);
3715 /* Set do_nest to 1 if we have to make a new parent window. We do
3716 that if either `window-nest' is non-nil, or OLD has no parent, or
3717 OLD is ortho-combined. */
3718 do_nest =
3719 !NILP (Vwindow_nest)
3720 || NILP (o->parent)
3721 || NILP (horflag
3722 ? (XWINDOW (o->parent)->hchild)
3723 : (XWINDOW (o->parent)->vchild));
3725 /* We need a live reference window to initialize some parameters. */
3726 if (WINDOW_LIVE_P (old))
3727 /* OLD is live, use it as reference window. */
3728 reference = old;
3729 else
3730 /* Use the frame's selected window as reference window. */
3731 reference = FRAME_SELECTED_WINDOW (f);
3732 r = XWINDOW (reference);
3734 /* The following bugs are caught by `split-window'. */
3735 if (MINI_WINDOW_P (o))
3736 error ("Attempt to split minibuffer window");
3737 else if (XINT (total_size) < (horflag ? 2 : 1))
3738 error ("Size of new window too small (after split)");
3739 else if (!do_nest && !NILP (Vwindow_splits))
3740 /* `window-splits' non-nil means try to resize OLD's siblings
3741 proportionally. */
3743 p = XWINDOW (o->parent);
3744 /* Temporarily pretend we split the parent window. */
3745 XSETINT (p->new_total,
3746 XINT (horflag ? p->total_cols : p->total_lines)
3747 - XINT (total_size));
3748 if (!window_resize_check (p, horflag))
3749 error ("Window sizes don't fit");
3750 else
3751 /* Undo the temporary pretension. */
3752 p->new_total = horflag ? p->total_cols : p->total_lines;
3754 else
3756 if (!window_resize_check (o, horflag))
3757 error ("Resizing old window failed");
3758 else if (XINT (total_size) + XINT (o->new_total)
3759 != XINT (horflag ? o->total_cols : o->total_lines))
3760 error ("Sum of sizes of old and new window don't fit");
3763 /* This is our point of no return. */
3764 if (do_nest)
3766 /* Save the old value of o->normal_cols/lines. It gets corrupted
3767 by make_parent_window and we need it below for assigning it to
3768 p->new_normal. */
3769 Lisp_Object new_normal = horflag ? o->normal_cols : o->normal_lines;
3771 make_parent_window (old, horflag);
3772 p = XWINDOW (o->parent);
3773 /* Store value of `window-nest' in new parent's nest slot. */
3774 p->nest = Vwindow_nest;
3775 /* Have PARENT inherit splits slot value from OLD. */
3776 p->splits = o->splits;
3777 /* Store value of `window-splits' in OLD's splits slot. */
3778 o->splits = Vwindow_splits;
3779 /* These get applied below. */
3780 p->new_total = horflag ? o->total_cols : o->total_lines;
3781 p->new_normal = new_normal;
3783 else
3784 p = XWINDOW (o->parent);
3786 windows_or_buffers_changed++;
3787 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3788 new = make_window ();
3789 n = XWINDOW (new);
3790 n->frame = frame;
3791 n->parent = o->parent;
3792 n->vchild = n->hchild = Qnil;
3794 if (EQ (side, Qabove) || EQ (side, Qleft))
3796 n->prev = o->prev;
3797 if (NILP (n->prev))
3798 if (horflag)
3799 p->hchild = new;
3800 else
3801 p->vchild = new;
3802 else
3803 XWINDOW (n->prev)->next = new;
3804 n->next = old;
3805 o->prev = new;
3807 else
3809 n->next = o->next;
3810 if (!NILP (n->next))
3811 XWINDOW (n->next)->prev = new;
3812 n->prev = old;
3813 o->next = new;
3816 n->buffer = Qt;
3817 n->window_end_valid = Qnil;
3818 memset (&n->last_cursor, 0, sizeof n->last_cursor);
3820 /* Get special geometry settings from reference window. */
3821 n->left_margin_cols = r->left_margin_cols;
3822 n->right_margin_cols = r->right_margin_cols;
3823 n->left_fringe_width = r->left_fringe_width;
3824 n->right_fringe_width = r->right_fringe_width;
3825 n->fringes_outside_margins = r->fringes_outside_margins;
3826 n->scroll_bar_width = r->scroll_bar_width;
3827 n->vertical_scroll_bar_type = r->vertical_scroll_bar_type;
3829 /* Store `window-splits' in NEW's splits slot. */
3830 n->splits = Vwindow_splits;
3832 /* Directly assign orthogonal coordinates and sizes. */
3833 if (horflag)
3835 n->top_line = o->top_line;
3836 n->total_lines = o->total_lines;
3838 else
3840 n->left_col = o->left_col;
3841 n->total_cols = o->total_cols;
3844 /* Iso-coordinates and sizes are assigned by window_resize_apply,
3845 get them ready here. */
3846 n->new_total = total_size;
3847 n->new_normal = normal_size;
3849 BLOCK_INPUT;
3850 window_resize_apply (p, horflag);
3851 adjust_glyphs (f);
3852 /* Set buffer of NEW to buffer of reference window. Don't run
3853 any hooks. */
3854 set_window_buffer (new, r->buffer, 0, 1);
3855 UNBLOCK_INPUT;
3857 /* Maybe we should run the scroll functions in Elisp (which already
3858 runs the configuration change hook). */
3859 if (! NILP (Vwindow_scroll_functions))
3860 run_hook_with_args_2 (Qwindow_scroll_functions, new,
3861 Fmarker_position (n->start));
3862 /* Return NEW. */
3863 return new;
3867 DEFUN ("delete-window-internal", Fdelete_window_internal, Sdelete_window_internal, 1, 1, 0,
3868 doc: /* Remove WINDOW from its frame.
3869 WINDOW defaults to the selected window. Return nil. Signal an error
3870 when WINDOW is the only window on its frame. */)
3871 (register Lisp_Object window)
3873 register Lisp_Object parent, sibling, frame, root;
3874 struct window *w, *p, *s, *r;
3875 struct frame *f;
3876 int horflag;
3877 int before_sibling = 0;
3879 w = decode_any_window (window);
3880 XSETWINDOW (window, w);
3881 if (NILP (w->buffer) && NILP (w->hchild) && NILP (w->vchild))
3882 /* It's a no-op to delete an already deleted window. */
3883 return Qnil;
3885 parent = w->parent;
3886 if (NILP (parent))
3887 /* Never delete a minibuffer or frame root window. */
3888 error ("Attempt to delete minibuffer or sole ordinary window");
3889 else if (NILP (w->prev) && NILP (w->next))
3890 /* Rather bow out here, this case should be handled on the Elisp
3891 level. */
3892 error ("Attempt to delete sole window of parent");
3894 p = XWINDOW (parent);
3895 horflag = NILP (p->vchild);
3897 frame = WINDOW_FRAME (w);
3898 f = XFRAME (frame);
3900 root = FRAME_ROOT_WINDOW (f);
3901 r = XWINDOW (root);
3903 /* Unlink WINDOW from window tree. */
3904 if (NILP (w->prev))
3905 /* Get SIBLING below (on the right of) WINDOW. */
3907 /* before_sibling 1 means WINDOW is the first child of its
3908 parent and thus before the sibling. */
3909 before_sibling = 1;
3910 sibling = w->next;
3911 s = XWINDOW (sibling);
3912 s->prev = Qnil;
3913 if (horflag)
3914 p->hchild = sibling;
3915 else
3916 p->vchild = sibling;
3918 else
3919 /* Get SIBLING above (on the left of) WINDOW. */
3921 sibling = w->prev;
3922 s = XWINDOW (sibling);
3923 s->next = w->next;
3924 if (!NILP (s->next))
3925 XWINDOW (s->next)->prev = sibling;
3928 if (window_resize_check (r, horflag)
3929 && EQ (r->new_total, (horflag ? r->total_cols : r->total_lines)))
3930 /* We can delete WINDOW now. */
3932 /* Block input. */
3933 BLOCK_INPUT;
3934 window_resize_apply (p, horflag);
3936 windows_or_buffers_changed++;
3937 Vwindow_list = Qnil;
3938 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3940 w->next = Qnil; /* Don't delete w->next too. */
3941 free_window_matrices (w);
3943 if (!NILP (w->vchild))
3945 delete_all_subwindows (w->vchild);
3946 w->vchild = Qnil;
3948 else if (!NILP (w->hchild))
3950 delete_all_subwindows (w->hchild);
3951 w->hchild = Qnil;
3953 else if (!NILP (w->buffer))
3955 unshow_buffer (w);
3956 unchain_marker (XMARKER (w->pointm));
3957 unchain_marker (XMARKER (w->start));
3958 w->buffer = Qnil;
3961 if (NILP (s->prev) && NILP (s->next))
3962 /* A matrjoshka where SIBLING has become the only child of
3963 PARENT. */
3965 /* Put SIBLING into PARENT's place. */
3966 replace_window (parent, sibling, 0);
3967 /* Have SIBLING inherit the following three slot values from
3968 PARENT (the nest slot is not inherited). */
3969 s->normal_cols = p->normal_cols;
3970 s->normal_lines = p->normal_lines;
3971 s->splits = p->splits;
3972 /* Mark PARENT as deleted. */
3973 p->vchild = p->hchild = Qnil;
3974 /* Try to merge SIBLING into its new parent. */
3975 recombine_windows (sibling);
3978 adjust_glyphs (f);
3980 if (!WINDOW_LIVE_P (FRAME_SELECTED_WINDOW (f)))
3981 /* We deleted the frame's selected window. */
3983 /* Use the frame's first window as fallback ... */
3984 Lisp_Object new_selected_window = Fframe_first_window (frame);
3985 /* ... but preferably use its most recently used window. */
3986 Lisp_Object mru_window;
3988 /* `get-mru-window' might fail for some reason so play it safe
3989 - promote the first window _without recording it_ first. */
3990 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
3991 Fselect_window (new_selected_window, Qt);
3992 else
3993 FRAME_SELECTED_WINDOW (f) = new_selected_window;
3995 UNBLOCK_INPUT;
3997 /* Now look whether `get-mru-window' gets us something. */
3998 mru_window = call1 (Qget_mru_window, frame);
3999 if (WINDOW_LIVE_P (mru_window)
4000 && EQ (XWINDOW (mru_window)->frame, frame))
4001 new_selected_window = mru_window;
4003 /* If all ended up well, we now promote the mru window. */
4004 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
4005 Fselect_window (new_selected_window, Qnil);
4006 else
4007 FRAME_SELECTED_WINDOW (f) = new_selected_window;
4009 else
4010 UNBLOCK_INPUT;
4012 /* Must be run by the caller:
4013 run_window_configuration_change_hook (f); */
4015 else
4016 /* We failed: Relink WINDOW into window tree. */
4018 if (before_sibling)
4020 s->prev = window;
4021 if (horflag)
4022 p->hchild = window;
4023 else
4024 p->vchild = window;
4026 else
4028 s->next = window;
4029 if (!NILP (w->next))
4030 XWINDOW (w->next)->prev = window;
4032 error ("Deletion failed");
4035 return Qnil;
4038 /***********************************************************************
4039 Resizing Mini-Windows
4040 ***********************************************************************/
4042 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we
4043 can. */
4044 void
4045 grow_mini_window (struct window *w, int delta)
4047 struct frame *f = XFRAME (w->frame);
4048 struct window *r;
4049 Lisp_Object root, value;
4051 xassert (MINI_WINDOW_P (w));
4052 xassert (delta >= 0);
4054 root = FRAME_ROOT_WINDOW (f);
4055 r = XWINDOW (root);
4056 value = call2 (Qwindow_resize_root_window_vertically,
4057 root, make_number (- delta));
4058 if (INTEGERP (value) && window_resize_check (r, 0))
4060 BLOCK_INPUT;
4061 window_resize_apply (r, 0);
4063 /* Grow the mini-window. */
4064 XSETFASTINT (w->top_line, XFASTINT (r->top_line) + XFASTINT (r->total_lines));
4065 XSETFASTINT (w->total_lines, XFASTINT (w->total_lines) - XINT (value));
4066 XSETFASTINT (w->last_modified, 0);
4067 XSETFASTINT (w->last_overlay_modified, 0);
4069 adjust_glyphs (f);
4070 UNBLOCK_INPUT;
4075 /* Shrink mini-window W. */
4076 void
4077 shrink_mini_window (struct window *w)
4079 struct frame *f = XFRAME (w->frame);
4080 struct window *r;
4081 Lisp_Object root, value;
4082 EMACS_INT size;
4084 xassert (MINI_WINDOW_P (w));
4086 size = XINT (w->total_lines);
4087 if (size > 1)
4089 root = FRAME_ROOT_WINDOW (f);
4090 r = XWINDOW (root);
4091 value = call2 (Qwindow_resize_root_window_vertically,
4092 root, make_number (size - 1));
4093 if (INTEGERP (value) && window_resize_check (r, 0))
4095 BLOCK_INPUT;
4096 window_resize_apply (r, 0);
4098 /* Shrink the mini-window. */
4099 XSETFASTINT (w->top_line, XFASTINT (r->top_line) + XFASTINT (r->total_lines));
4100 XSETFASTINT (w->total_lines, 1);
4102 XSETFASTINT (w->last_modified, 0);
4103 XSETFASTINT (w->last_overlay_modified, 0);
4105 adjust_glyphs (f);
4106 UNBLOCK_INPUT;
4108 /* If the above failed for whatever strange reason we must make a
4109 one window frame here. The same routine will be needed when
4110 shrinking the frame (and probably when making the initial
4111 *scratch* window). For the moment leave things as they are. */
4115 DEFUN ("resize-mini-window-internal", Fresize_mini_window_internal, Sresize_mini_window_internal, 1, 1, 0,
4116 doc: /* Resize minibuffer window WINDOW. */)
4117 (Lisp_Object window)
4119 struct window *w = XWINDOW (window);
4120 struct window *r;
4121 struct frame *f;
4122 int height;
4124 CHECK_WINDOW (window);
4125 f = XFRAME (w->frame);
4127 if (!EQ (FRAME_MINIBUF_WINDOW (XFRAME (w->frame)), window))
4128 error ("Not a valid minibuffer window");
4129 else if (FRAME_MINIBUF_ONLY_P (f))
4130 error ("Cannot resize a minibuffer-only frame");
4132 r = XWINDOW (FRAME_ROOT_WINDOW (f));
4133 height = XINT (r->total_lines) + XINT (w->total_lines);
4134 if (window_resize_check (r, 0)
4135 && XINT (w->new_total) > 0
4136 && height == XINT (r->new_total) + XINT (w->new_total))
4138 BLOCK_INPUT;
4139 window_resize_apply (r, 0);
4141 w->total_lines = w->new_total;
4142 XSETFASTINT (w->top_line, XINT (r->top_line) + XINT (r->total_lines));
4144 windows_or_buffers_changed++;
4145 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4146 adjust_glyphs (f);
4147 UNBLOCK_INPUT;
4149 run_window_configuration_change_hook (f);
4150 return Qt;
4152 else error ("Failed to resize minibuffer window");
4155 /* Mark window cursors off for all windows in the window tree rooted
4156 at W by setting their phys_cursor_on_p flag to zero. Called from
4157 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4158 the frame are cleared. */
4160 void
4161 mark_window_cursors_off (struct window *w)
4163 while (w)
4165 if (!NILP (w->hchild))
4166 mark_window_cursors_off (XWINDOW (w->hchild));
4167 else if (!NILP (w->vchild))
4168 mark_window_cursors_off (XWINDOW (w->vchild));
4169 else
4170 w->phys_cursor_on_p = 0;
4172 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4177 /* Return number of lines of text (not counting mode lines) in W. */
4180 window_internal_height (struct window *w)
4182 int ht = XFASTINT (w->total_lines);
4184 if (!MINI_WINDOW_P (w))
4186 if (!NILP (w->parent)
4187 || !NILP (w->vchild)
4188 || !NILP (w->hchild)
4189 || !NILP (w->next)
4190 || !NILP (w->prev)
4191 || WINDOW_WANTS_MODELINE_P (w))
4192 --ht;
4194 if (WINDOW_WANTS_HEADER_LINE_P (w))
4195 --ht;
4198 return ht;
4201 /************************************************************************
4202 Window Scrolling
4203 ***********************************************************************/
4205 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4206 N screen-fulls, which is defined as the height of the window minus
4207 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4208 instead. Negative values of N mean scroll down. NOERROR non-zero
4209 means don't signal an error if we try to move over BEGV or ZV,
4210 respectively. */
4212 static void
4213 window_scroll (Lisp_Object window, int n, int whole, int noerror)
4215 immediate_quit = 1;
4217 /* If we must, use the pixel-based version which is much slower than
4218 the line-based one but can handle varying line heights. */
4219 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4220 window_scroll_pixel_based (window, n, whole, noerror);
4221 else
4222 window_scroll_line_based (window, n, whole, noerror);
4224 immediate_quit = 0;
4228 /* Implementation of window_scroll that works based on pixel line
4229 heights. See the comment of window_scroll for parameter
4230 descriptions. */
4232 static void
4233 window_scroll_pixel_based (Lisp_Object window, int n, int whole, int noerror)
4235 struct it it;
4236 struct window *w = XWINDOW (window);
4237 struct text_pos start;
4238 int this_scroll_margin;
4239 /* True if we fiddled the window vscroll field without really scrolling. */
4240 int vscrolled = 0;
4241 int x, y, rtop, rbot, rowh, vpos;
4242 void *itdata = NULL;
4244 SET_TEXT_POS_FROM_MARKER (start, w->start);
4246 /* If PT is not visible in WINDOW, move back one half of
4247 the screen. Allow PT to be partially visible, otherwise
4248 something like (scroll-down 1) with PT in the line before
4249 the partially visible one would recenter. */
4251 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
4253 itdata = bidi_shelve_cache ();
4254 /* Move backward half the height of the window. Performance note:
4255 vmotion used here is about 10% faster, but would give wrong
4256 results for variable height lines. */
4257 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4258 it.current_y = it.last_visible_y;
4259 move_it_vertically_backward (&it, window_box_height (w) / 2);
4261 /* The function move_iterator_vertically may move over more than
4262 the specified y-distance. If it->w is small, e.g. a
4263 mini-buffer window, we may end up in front of the window's
4264 display area. This is the case when Start displaying at the
4265 start of the line containing PT in this case. */
4266 if (it.current_y <= 0)
4268 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4269 move_it_vertically_backward (&it, 0);
4270 it.current_y = 0;
4273 start = it.current.pos;
4274 bidi_unshelve_cache (itdata, 0);
4276 else if (auto_window_vscroll_p)
4278 if (rtop || rbot) /* partially visible */
4280 int px;
4281 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4282 if (whole)
4283 dy = max ((window_box_height (w)
4284 - next_screen_context_lines * dy),
4285 dy);
4286 dy *= n;
4288 if (n < 0)
4290 /* Only vscroll backwards if already vscrolled forwards. */
4291 if (w->vscroll < 0 && rtop > 0)
4293 px = max (0, -w->vscroll - min (rtop, -dy));
4294 Fset_window_vscroll (window, make_number (px), Qt);
4295 return;
4298 if (n > 0)
4300 /* Do vscroll if already vscrolled or only display line. */
4301 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
4303 px = max (0, -w->vscroll + min (rbot, dy));
4304 Fset_window_vscroll (window, make_number (px), Qt);
4305 return;
4308 /* Maybe modify window start instead of scrolling. */
4309 if (rbot > 0 || w->vscroll < 0)
4311 EMACS_INT spos;
4313 Fset_window_vscroll (window, make_number (0), Qt);
4314 /* If there are other text lines above the current row,
4315 move window start to current row. Else to next row. */
4316 if (rbot > 0)
4317 spos = XINT (Fline_beginning_position (Qnil));
4318 else
4319 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
4320 set_marker_restricted (w->start, make_number (spos),
4321 w->buffer);
4322 w->start_at_line_beg = Qt;
4323 w->update_mode_line = Qt;
4324 XSETFASTINT (w->last_modified, 0);
4325 XSETFASTINT (w->last_overlay_modified, 0);
4326 /* Set force_start so that redisplay_window will run the
4327 window-scroll-functions. */
4328 w->force_start = Qt;
4329 return;
4333 /* Cancel previous vscroll. */
4334 Fset_window_vscroll (window, make_number (0), Qt);
4337 itdata = bidi_shelve_cache ();
4338 /* If scroll_preserve_screen_position is non-nil, we try to set
4339 point in the same window line as it is now, so get that line. */
4340 if (!NILP (Vscroll_preserve_screen_position))
4342 /* We preserve the goal pixel coordinate across consecutive
4343 calls to scroll-up, scroll-down and other commands that
4344 have the `scroll-command' property. This avoids the
4345 possibility of point becoming "stuck" on a tall line when
4346 scrolling by one line. */
4347 if (window_scroll_pixel_based_preserve_y < 0
4348 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4349 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4351 start_display (&it, w, start);
4352 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4353 window_scroll_pixel_based_preserve_y = it.current_y;
4354 window_scroll_pixel_based_preserve_x = it.current_x;
4357 else
4358 window_scroll_pixel_based_preserve_y
4359 = window_scroll_pixel_based_preserve_x = -1;
4361 /* Move iterator it from start the specified distance forward or
4362 backward. The result is the new window start. */
4363 start_display (&it, w, start);
4364 if (whole)
4366 EMACS_INT start_pos = IT_CHARPOS (it);
4367 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4368 dy = max ((window_box_height (w)
4369 - next_screen_context_lines * dy),
4370 dy) * n;
4372 /* Note that move_it_vertically always moves the iterator to the
4373 start of a line. So, if the last line doesn't have a newline,
4374 we would end up at the start of the line ending at ZV. */
4375 if (dy <= 0)
4377 move_it_vertically_backward (&it, -dy);
4378 /* Ensure we actually do move, e.g. in case we are currently
4379 looking at an image that is taller that the window height. */
4380 while (start_pos == IT_CHARPOS (it)
4381 && start_pos > BEGV)
4382 move_it_by_lines (&it, -1);
4384 else if (dy > 0)
4386 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4387 MOVE_TO_POS | MOVE_TO_Y);
4388 /* Ensure we actually do move, e.g. in case we are currently
4389 looking at an image that is taller that the window height. */
4390 while (start_pos == IT_CHARPOS (it)
4391 && start_pos < ZV)
4392 move_it_by_lines (&it, 1);
4395 else
4396 move_it_by_lines (&it, n);
4398 /* We failed if we find ZV is already on the screen (scrolling up,
4399 means there's nothing past the end), or if we can't start any
4400 earlier (scrolling down, means there's nothing past the top). */
4401 if ((n > 0 && IT_CHARPOS (it) == ZV)
4402 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4404 if (IT_CHARPOS (it) == ZV)
4406 if (it.current_y < it.last_visible_y
4407 && (it.current_y + it.max_ascent + it.max_descent
4408 > it.last_visible_y))
4410 /* The last line was only partially visible, make it fully
4411 visible. */
4412 w->vscroll = (it.last_visible_y
4413 - it.current_y + it.max_ascent + it.max_descent);
4414 adjust_glyphs (it.f);
4416 else
4418 bidi_unshelve_cache (itdata, 0);
4419 if (noerror)
4420 return;
4421 else if (n < 0) /* could happen with empty buffers */
4422 xsignal0 (Qbeginning_of_buffer);
4423 else
4424 xsignal0 (Qend_of_buffer);
4427 else
4429 if (w->vscroll != 0)
4430 /* The first line was only partially visible, make it fully
4431 visible. */
4432 w->vscroll = 0;
4433 else
4435 bidi_unshelve_cache (itdata, 0);
4436 if (noerror)
4437 return;
4438 else
4439 xsignal0 (Qbeginning_of_buffer);
4443 /* If control gets here, then we vscrolled. */
4445 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
4447 /* Don't try to change the window start below. */
4448 vscrolled = 1;
4451 if (! vscrolled)
4453 EMACS_INT pos = IT_CHARPOS (it);
4454 EMACS_INT bytepos;
4456 /* If in the middle of a multi-glyph character move forward to
4457 the next character. */
4458 if (in_display_vector_p (&it))
4460 ++pos;
4461 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
4464 /* Set the window start, and set up the window for redisplay. */
4465 set_marker_restricted (w->start, make_number (pos),
4466 w->buffer);
4467 bytepos = XMARKER (w->start)->bytepos;
4468 w->start_at_line_beg = ((pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n')
4469 ? Qt : Qnil);
4470 w->update_mode_line = Qt;
4471 XSETFASTINT (w->last_modified, 0);
4472 XSETFASTINT (w->last_overlay_modified, 0);
4473 /* Set force_start so that redisplay_window will run the
4474 window-scroll-functions. */
4475 w->force_start = Qt;
4478 /* The rest of this function uses current_y in a nonstandard way,
4479 not including the height of the header line if any. */
4480 it.current_y = it.vpos = 0;
4482 /* Move PT out of scroll margins.
4483 This code wants current_y to be zero at the window start position
4484 even if there is a header line. */
4485 this_scroll_margin = max (0, scroll_margin);
4486 this_scroll_margin = min (this_scroll_margin, XFASTINT (w->total_lines) / 4);
4487 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
4489 if (n > 0)
4491 /* We moved the window start towards ZV, so PT may be now
4492 in the scroll margin at the top. */
4493 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4494 if (IT_CHARPOS (it) == PT && it.current_y >= this_scroll_margin
4495 && (NILP (Vscroll_preserve_screen_position)
4496 || EQ (Vscroll_preserve_screen_position, Qt)))
4497 /* We found PT at a legitimate height. Leave it alone. */
4499 else if (window_scroll_pixel_based_preserve_y >= 0)
4501 /* If we have a header line, take account of it.
4502 This is necessary because we set it.current_y to 0, above. */
4503 move_it_to (&it, -1,
4504 window_scroll_pixel_based_preserve_x,
4505 window_scroll_pixel_based_preserve_y
4506 - (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0 ),
4507 -1, MOVE_TO_Y | MOVE_TO_X);
4508 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4510 else
4512 while (it.current_y < this_scroll_margin)
4514 int prev = it.current_y;
4515 move_it_by_lines (&it, 1);
4516 if (prev == it.current_y)
4517 break;
4519 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4522 else if (n < 0)
4524 EMACS_INT charpos, bytepos;
4525 int partial_p;
4527 /* Save our position, for the
4528 window_scroll_pixel_based_preserve_y case. */
4529 charpos = IT_CHARPOS (it);
4530 bytepos = IT_BYTEPOS (it);
4532 /* We moved the window start towards BEGV, so PT may be now
4533 in the scroll margin at the bottom. */
4534 move_it_to (&it, PT, -1,
4535 (it.last_visible_y - CURRENT_HEADER_LINE_HEIGHT (w)
4536 - this_scroll_margin - 1),
4538 MOVE_TO_POS | MOVE_TO_Y);
4540 /* Save our position, in case it's correct. */
4541 charpos = IT_CHARPOS (it);
4542 bytepos = IT_BYTEPOS (it);
4544 /* See if point is on a partially visible line at the end. */
4545 if (it.what == IT_EOB)
4546 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
4547 else
4549 move_it_by_lines (&it, 1);
4550 partial_p = it.current_y > it.last_visible_y;
4553 if (charpos == PT && !partial_p
4554 && (NILP (Vscroll_preserve_screen_position)
4555 || EQ (Vscroll_preserve_screen_position, Qt)))
4556 /* We found PT before we found the display margin, so PT is ok. */
4558 else if (window_scroll_pixel_based_preserve_y >= 0)
4560 SET_TEXT_POS_FROM_MARKER (start, w->start);
4561 start_display (&it, w, start);
4562 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
4563 here because we called start_display again and did not
4564 alter it.current_y this time. */
4565 move_it_to (&it, -1, window_scroll_pixel_based_preserve_x,
4566 window_scroll_pixel_based_preserve_y, -1,
4567 MOVE_TO_Y | MOVE_TO_X);
4568 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4570 else
4572 if (partial_p)
4573 /* The last line was only partially visible, so back up two
4574 lines to make sure we're on a fully visible line. */
4576 move_it_by_lines (&it, -2);
4577 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4579 else
4580 /* No, the position we saved is OK, so use it. */
4581 SET_PT_BOTH (charpos, bytepos);
4584 bidi_unshelve_cache (itdata, 0);
4588 /* Implementation of window_scroll that works based on screen lines.
4589 See the comment of window_scroll for parameter descriptions. */
4591 static void
4592 window_scroll_line_based (Lisp_Object window, int n, int whole, int noerror)
4594 register struct window *w = XWINDOW (window);
4595 /* Fvertical_motion enters redisplay, which can trigger
4596 fontification, which in turn can modify buffer text (e.g., if the
4597 fontification functions replace escape sequences with faces, as
4598 in `grep-mode-font-lock-keywords'). So we use a marker to record
4599 the old point position, to prevent crashes in SET_PT_BOTH. */
4600 Lisp_Object opoint_marker = Fpoint_marker ();
4601 register EMACS_INT pos, pos_byte;
4602 register int ht = window_internal_height (w);
4603 register Lisp_Object tem;
4604 int lose;
4605 Lisp_Object bolp;
4606 EMACS_INT startpos;
4607 Lisp_Object original_pos = Qnil;
4609 /* If scrolling screen-fulls, compute the number of lines to
4610 scroll from the window's height. */
4611 if (whole)
4612 n *= max (1, ht - next_screen_context_lines);
4614 startpos = marker_position (w->start);
4616 if (!NILP (Vscroll_preserve_screen_position))
4618 if (window_scroll_preserve_vpos <= 0
4619 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4620 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4622 struct position posit
4623 = *compute_motion (startpos, 0, 0, 0,
4624 PT, ht, 0,
4625 -1, XINT (w->hscroll),
4626 0, w);
4627 window_scroll_preserve_vpos = posit.vpos;
4628 window_scroll_preserve_hpos = posit.hpos + XINT (w->hscroll);
4631 original_pos = Fcons (make_number (window_scroll_preserve_hpos),
4632 make_number (window_scroll_preserve_vpos));
4635 XSETFASTINT (tem, PT);
4636 tem = Fpos_visible_in_window_p (tem, window, Qnil);
4638 if (NILP (tem))
4640 Fvertical_motion (make_number (- (ht / 2)), window);
4641 startpos = PT;
4644 SET_PT (startpos);
4645 lose = n < 0 && PT == BEGV;
4646 Fvertical_motion (make_number (n), window);
4647 pos = PT;
4648 pos_byte = PT_BYTE;
4649 bolp = Fbolp ();
4650 SET_PT_BOTH (marker_position (opoint_marker),
4651 marker_byte_position (opoint_marker));
4653 if (lose)
4655 if (noerror)
4656 return;
4657 else
4658 xsignal0 (Qbeginning_of_buffer);
4661 if (pos < ZV)
4663 /* Don't use a scroll margin that is negative or too large. */
4664 int this_scroll_margin =
4665 max (0, min (scroll_margin, XINT (w->total_lines) / 4));
4667 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
4668 w->start_at_line_beg = bolp;
4669 w->update_mode_line = Qt;
4670 XSETFASTINT (w->last_modified, 0);
4671 XSETFASTINT (w->last_overlay_modified, 0);
4672 /* Set force_start so that redisplay_window will run
4673 the window-scroll-functions. */
4674 w->force_start = Qt;
4676 if (!NILP (Vscroll_preserve_screen_position)
4677 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
4679 SET_PT_BOTH (pos, pos_byte);
4680 Fvertical_motion (original_pos, window);
4682 /* If we scrolled forward, put point enough lines down
4683 that it is outside the scroll margin. */
4684 else if (n > 0)
4686 int top_margin;
4688 if (this_scroll_margin > 0)
4690 SET_PT_BOTH (pos, pos_byte);
4691 Fvertical_motion (make_number (this_scroll_margin), window);
4692 top_margin = PT;
4694 else
4695 top_margin = pos;
4697 if (top_margin <= marker_position (opoint_marker))
4698 SET_PT_BOTH (marker_position (opoint_marker),
4699 marker_byte_position (opoint_marker));
4700 else if (!NILP (Vscroll_preserve_screen_position))
4702 SET_PT_BOTH (pos, pos_byte);
4703 Fvertical_motion (original_pos, window);
4705 else
4706 SET_PT (top_margin);
4708 else if (n < 0)
4710 int bottom_margin;
4712 /* If we scrolled backward, put point near the end of the window
4713 but not within the scroll margin. */
4714 SET_PT_BOTH (pos, pos_byte);
4715 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
4716 if (XFASTINT (tem) == ht - this_scroll_margin)
4717 bottom_margin = PT;
4718 else
4719 bottom_margin = PT + 1;
4721 if (bottom_margin > marker_position (opoint_marker))
4722 SET_PT_BOTH (marker_position (opoint_marker),
4723 marker_byte_position (opoint_marker));
4724 else
4726 if (!NILP (Vscroll_preserve_screen_position))
4728 SET_PT_BOTH (pos, pos_byte);
4729 Fvertical_motion (original_pos, window);
4731 else
4732 Fvertical_motion (make_number (-1), window);
4736 else
4738 if (noerror)
4739 return;
4740 else
4741 xsignal0 (Qend_of_buffer);
4746 /* Scroll selected_window up or down. If N is nil, scroll a
4747 screen-full which is defined as the height of the window minus
4748 next_screen_context_lines. If N is the symbol `-', scroll.
4749 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
4750 up. This is the guts of Fscroll_up and Fscroll_down. */
4752 static void
4753 scroll_command (Lisp_Object n, int direction)
4755 int count = SPECPDL_INDEX ();
4757 xassert (eabs (direction) == 1);
4759 /* If selected window's buffer isn't current, make it current for
4760 the moment. But don't screw up if window_scroll gets an error. */
4761 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
4763 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4764 Fset_buffer (XWINDOW (selected_window)->buffer);
4766 /* Make redisplay consider other windows than just selected_window. */
4767 ++windows_or_buffers_changed;
4770 if (NILP (n))
4771 window_scroll (selected_window, direction, 1, 0);
4772 else if (EQ (n, Qminus))
4773 window_scroll (selected_window, -direction, 1, 0);
4774 else
4776 n = Fprefix_numeric_value (n);
4777 window_scroll (selected_window, XINT (n) * direction, 0, 0);
4780 unbind_to (count, Qnil);
4783 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
4784 doc: /* Scroll text of selected window upward ARG lines.
4785 If ARG is omitted or nil, scroll upward by a near full screen.
4786 A near full screen is `next-screen-context-lines' less than a full screen.
4787 Negative ARG means scroll downward.
4788 If ARG is the atom `-', scroll downward by nearly full screen.
4789 When calling from a program, supply as argument a number, nil, or `-'. */)
4790 (Lisp_Object arg)
4792 scroll_command (arg, 1);
4793 return Qnil;
4796 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
4797 doc: /* Scroll text of selected window down ARG lines.
4798 If ARG is omitted or nil, scroll down by a near full screen.
4799 A near full screen is `next-screen-context-lines' less than a full screen.
4800 Negative ARG means scroll upward.
4801 If ARG is the atom `-', scroll upward by nearly full screen.
4802 When calling from a program, supply as argument a number, nil, or `-'. */)
4803 (Lisp_Object arg)
4805 scroll_command (arg, -1);
4806 return Qnil;
4809 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
4810 doc: /* Return the other window for \"other window scroll\" commands.
4811 If `other-window-scroll-buffer' is non-nil, a window
4812 showing that buffer is used.
4813 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4814 specifies the window. This takes precedence over
4815 `other-window-scroll-buffer'. */)
4816 (void)
4818 Lisp_Object window;
4820 if (MINI_WINDOW_P (XWINDOW (selected_window))
4821 && !NILP (Vminibuf_scroll_window))
4822 window = Vminibuf_scroll_window;
4823 /* If buffer is specified, scroll that buffer. */
4824 else if (!NILP (Vother_window_scroll_buffer))
4826 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
4827 if (NILP (window))
4828 window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil);
4830 else
4832 /* Nothing specified; look for a neighboring window on the same
4833 frame. */
4834 window = Fnext_window (selected_window, Qnil, Qnil);
4836 if (EQ (window, selected_window))
4837 /* That didn't get us anywhere; look for a window on another
4838 visible frame. */
4840 window = Fnext_window (window, Qnil, Qt);
4841 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
4842 && ! EQ (window, selected_window));
4845 CHECK_LIVE_WINDOW (window);
4847 if (EQ (window, selected_window))
4848 error ("There is no other window");
4850 return window;
4853 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
4854 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
4855 A near full screen is `next-screen-context-lines' less than a full screen.
4856 The next window is the one below the current one; or the one at the top
4857 if the current one is at the bottom. Negative ARG means scroll downward.
4858 If ARG is the atom `-', scroll downward by nearly full screen.
4859 When calling from a program, supply as argument a number, nil, or `-'.
4861 If `other-window-scroll-buffer' is non-nil, scroll the window
4862 showing that buffer, popping the buffer up if necessary.
4863 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4864 specifies the window to scroll. This takes precedence over
4865 `other-window-scroll-buffer'. */)
4866 (Lisp_Object arg)
4868 Lisp_Object window;
4869 struct window *w;
4870 int count = SPECPDL_INDEX ();
4872 window = Fother_window_for_scrolling ();
4873 w = XWINDOW (window);
4875 /* Don't screw up if window_scroll gets an error. */
4876 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4877 ++windows_or_buffers_changed;
4879 Fset_buffer (w->buffer);
4880 SET_PT (marker_position (w->pointm));
4882 if (NILP (arg))
4883 window_scroll (window, 1, 1, 1);
4884 else if (EQ (arg, Qminus))
4885 window_scroll (window, -1, 1, 1);
4886 else
4888 if (CONSP (arg))
4889 arg = Fcar (arg);
4890 CHECK_NUMBER (arg);
4891 window_scroll (window, XINT (arg), 0, 1);
4894 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
4895 unbind_to (count, Qnil);
4897 return Qnil;
4900 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
4901 doc: /* Scroll selected window display ARG columns left.
4902 Default for ARG is window width minus 2.
4903 Value is the total amount of leftward horizontal scrolling in
4904 effect after the change.
4905 If SET-MINIMUM is non-nil, the new scroll amount becomes the
4906 lower bound for automatic scrolling, i.e. automatic scrolling
4907 will not scroll a window to a column less than the value returned
4908 by this function. This happens in an interactive call. */)
4909 (register Lisp_Object arg, Lisp_Object set_minimum)
4911 Lisp_Object result;
4912 int hscroll;
4913 struct window *w = XWINDOW (selected_window);
4915 if (NILP (arg))
4916 XSETFASTINT (arg, window_body_cols (w) - 2);
4917 else
4918 arg = Fprefix_numeric_value (arg);
4920 hscroll = XINT (w->hscroll) + XINT (arg);
4921 result = Fset_window_hscroll (selected_window, make_number (hscroll));
4923 if (!NILP (set_minimum))
4924 w->min_hscroll = w->hscroll;
4926 return result;
4929 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
4930 doc: /* Scroll selected window display ARG columns right.
4931 Default for ARG is window width minus 2.
4932 Value is the total amount of leftward horizontal scrolling in
4933 effect after the change.
4934 If SET-MINIMUM is non-nil, the new scroll amount becomes the
4935 lower bound for automatic scrolling, i.e. automatic scrolling
4936 will not scroll a window to a column less than the value returned
4937 by this function. This happens in an interactive call. */)
4938 (register Lisp_Object arg, Lisp_Object set_minimum)
4940 Lisp_Object result;
4941 int hscroll;
4942 struct window *w = XWINDOW (selected_window);
4944 if (NILP (arg))
4945 XSETFASTINT (arg, window_body_cols (w) - 2);
4946 else
4947 arg = Fprefix_numeric_value (arg);
4949 hscroll = XINT (w->hscroll) - XINT (arg);
4950 result = Fset_window_hscroll (selected_window, make_number (hscroll));
4952 if (!NILP (set_minimum))
4953 w->min_hscroll = w->hscroll;
4955 return result;
4958 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
4959 doc: /* Return the window which was selected when entering the minibuffer.
4960 Returns nil, if selected window is not a minibuffer window. */)
4961 (void)
4963 if (minibuf_level > 0
4964 && MINI_WINDOW_P (XWINDOW (selected_window))
4965 && WINDOW_LIVE_P (minibuf_selected_window))
4966 return minibuf_selected_window;
4968 return Qnil;
4971 /* Value is the number of lines actually displayed in window W,
4972 as opposed to its height. */
4974 static int
4975 displayed_window_lines (struct window *w)
4977 struct it it;
4978 struct text_pos start;
4979 int height = window_box_height (w);
4980 struct buffer *old_buffer;
4981 int bottom_y;
4982 void *itdata = NULL;
4984 if (XBUFFER (w->buffer) != current_buffer)
4986 old_buffer = current_buffer;
4987 set_buffer_internal (XBUFFER (w->buffer));
4989 else
4990 old_buffer = NULL;
4992 /* In case W->start is out of the accessible range, do something
4993 reasonable. This happens in Info mode when Info-scroll-down
4994 calls (recenter -1) while W->start is 1. */
4995 if (XMARKER (w->start)->charpos < BEGV)
4996 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
4997 else if (XMARKER (w->start)->charpos > ZV)
4998 SET_TEXT_POS (start, ZV, ZV_BYTE);
4999 else
5000 SET_TEXT_POS_FROM_MARKER (start, w->start);
5002 itdata = bidi_shelve_cache ();
5003 start_display (&it, w, start);
5004 move_it_vertically (&it, height);
5005 bottom_y = line_bottom_y (&it);
5006 bidi_unshelve_cache (itdata, 0);
5008 /* rms: On a non-window display,
5009 the value of it.vpos at the bottom of the screen
5010 seems to be 1 larger than window_box_height (w).
5011 This kludge fixes a bug whereby (move-to-window-line -1)
5012 when ZV is on the last screen line
5013 moves to the previous screen line instead of the last one. */
5014 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
5015 height++;
5017 /* Add in empty lines at the bottom of the window. */
5018 if (bottom_y < height)
5020 int uy = FRAME_LINE_HEIGHT (it.f);
5021 it.vpos += (height - bottom_y + uy - 1) / uy;
5024 if (old_buffer)
5025 set_buffer_internal (old_buffer);
5027 return it.vpos;
5031 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
5032 doc: /* Center point in selected window and maybe redisplay frame.
5033 With prefix argument ARG, recenter putting point on screen line ARG
5034 relative to the selected window. If ARG is negative, it counts up from the
5035 bottom of the window. (ARG should be less than the height of the window.)
5037 If ARG is omitted or nil, then recenter with point on the middle line of
5038 the selected window; if the variable `recenter-redisplay' is non-nil,
5039 also erase the entire frame and redraw it (when `auto-resize-tool-bars'
5040 is set to `grow-only', this resets the tool-bar's height to the minimum
5041 height needed); if `recenter-redisplay' has the special value `tty',
5042 then only tty frame are redrawn.
5044 Just C-u as prefix means put point in the center of the window
5045 and redisplay normally--don't erase and redraw the frame. */)
5046 (register Lisp_Object arg)
5048 struct window *w = XWINDOW (selected_window);
5049 struct buffer *buf = XBUFFER (w->buffer);
5050 struct buffer *obuf = current_buffer;
5051 int center_p = 0;
5052 EMACS_INT charpos, bytepos;
5053 EMACS_INT iarg IF_LINT (= 0);
5054 int this_scroll_margin;
5056 /* If redisplay is suppressed due to an error, try again. */
5057 obuf->display_error_modiff = 0;
5059 if (NILP (arg))
5061 if (!NILP (Vrecenter_redisplay)
5062 && (!EQ (Vrecenter_redisplay, Qtty)
5063 || !NILP (Ftty_type (selected_frame))))
5065 ptrdiff_t i;
5067 /* Invalidate pixel data calculated for all compositions. */
5068 for (i = 0; i < n_compositions; i++)
5069 composition_table[i]->font = NULL;
5071 WINDOW_XFRAME (w)->minimize_tool_bar_window_p = 1;
5073 Fredraw_frame (WINDOW_FRAME (w));
5074 SET_FRAME_GARBAGED (WINDOW_XFRAME (w));
5077 center_p = 1;
5079 else if (CONSP (arg)) /* Just C-u. */
5080 center_p = 1;
5081 else
5083 arg = Fprefix_numeric_value (arg);
5084 CHECK_NUMBER (arg);
5085 iarg = XINT (arg);
5088 set_buffer_internal (buf);
5090 /* Do this after making BUF current
5091 in case scroll_margin is buffer-local. */
5092 this_scroll_margin =
5093 max (0, min (scroll_margin, XFASTINT (w->total_lines) / 4));
5095 /* Handle centering on a graphical frame specially. Such frames can
5096 have variable-height lines and centering point on the basis of
5097 line counts would lead to strange effects. */
5098 if (FRAME_WINDOW_P (XFRAME (w->frame)))
5100 if (center_p)
5102 struct it it;
5103 struct text_pos pt;
5104 void *itdata = bidi_shelve_cache ();
5106 SET_TEXT_POS (pt, PT, PT_BYTE);
5107 start_display (&it, w, pt);
5108 move_it_vertically_backward (&it, window_box_height (w) / 2);
5109 charpos = IT_CHARPOS (it);
5110 bytepos = IT_BYTEPOS (it);
5111 bidi_unshelve_cache (itdata, 0);
5113 else if (iarg < 0)
5115 struct it it;
5116 struct text_pos pt;
5117 int nlines = min (INT_MAX, -iarg);
5118 int extra_line_spacing;
5119 int h = window_box_height (w);
5120 void *itdata = bidi_shelve_cache ();
5122 iarg = - max (-iarg, this_scroll_margin);
5124 SET_TEXT_POS (pt, PT, PT_BYTE);
5125 start_display (&it, w, pt);
5127 /* Be sure we have the exact height of the full line containing PT. */
5128 move_it_by_lines (&it, 0);
5130 /* The amount of pixels we have to move back is the window
5131 height minus what's displayed in the line containing PT,
5132 and the lines below. */
5133 it.current_y = 0;
5134 it.vpos = 0;
5135 move_it_by_lines (&it, nlines);
5137 if (it.vpos == nlines)
5138 h -= it.current_y;
5139 else
5141 /* Last line has no newline */
5142 h -= line_bottom_y (&it);
5143 it.vpos++;
5146 /* Don't reserve space for extra line spacing of last line. */
5147 extra_line_spacing = it.max_extra_line_spacing;
5149 /* If we can't move down NLINES lines because we hit
5150 the end of the buffer, count in some empty lines. */
5151 if (it.vpos < nlines)
5153 nlines -= it.vpos;
5154 extra_line_spacing = it.extra_line_spacing;
5155 h -= nlines * (FRAME_LINE_HEIGHT (it.f) + extra_line_spacing);
5157 if (h <= 0)
5159 bidi_unshelve_cache (itdata, 0);
5160 return Qnil;
5163 /* Now find the new top line (starting position) of the window. */
5164 start_display (&it, w, pt);
5165 it.current_y = 0;
5166 move_it_vertically_backward (&it, h);
5168 /* If extra line spacing is present, we may move too far
5169 back. This causes the last line to be only partially
5170 visible (which triggers redisplay to recenter that line
5171 in the middle), so move forward.
5172 But ignore extra line spacing on last line, as it is not
5173 considered to be part of the visible height of the line.
5175 h += extra_line_spacing;
5176 while (-it.current_y > h)
5177 move_it_by_lines (&it, 1);
5179 charpos = IT_CHARPOS (it);
5180 bytepos = IT_BYTEPOS (it);
5182 bidi_unshelve_cache (itdata, 0);
5184 else
5186 struct position pos;
5188 iarg = max (iarg, this_scroll_margin);
5190 pos = *vmotion (PT, -iarg, w);
5191 charpos = pos.bufpos;
5192 bytepos = pos.bytepos;
5195 else
5197 struct position pos;
5198 int ht = window_internal_height (w);
5200 if (center_p)
5201 iarg = ht / 2;
5202 else if (iarg < 0)
5203 iarg += ht;
5205 /* Don't let it get into the margin at either top or bottom. */
5206 iarg = max (iarg, this_scroll_margin);
5207 iarg = min (iarg, ht - this_scroll_margin - 1);
5209 pos = *vmotion (PT, - iarg, w);
5210 charpos = pos.bufpos;
5211 bytepos = pos.bytepos;
5214 /* Set the new window start. */
5215 set_marker_both (w->start, w->buffer, charpos, bytepos);
5216 w->window_end_valid = Qnil;
5218 w->optional_new_start = Qt;
5220 if (bytepos == BEGV_BYTE || FETCH_BYTE (bytepos - 1) == '\n')
5221 w->start_at_line_beg = Qt;
5222 else
5223 w->start_at_line_beg = Qnil;
5225 set_buffer_internal (obuf);
5226 return Qnil;
5229 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5230 0, 1, 0,
5231 doc: /* Return the height in lines of the text display area of WINDOW.
5232 WINDOW defaults to the selected window.
5234 The return value does not include the mode line, any header line, nor
5235 any partial-height lines in the text display area. */)
5236 (Lisp_Object window)
5238 struct window *w = decode_window (window);
5239 int pixel_height = window_box_height (w);
5240 int line_height = pixel_height / FRAME_LINE_HEIGHT (XFRAME (w->frame));
5241 return make_number (line_height);
5246 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
5247 1, 1, "P",
5248 doc: /* Position point relative to window.
5249 With no argument, position point at center of window.
5250 An argument specifies vertical position within the window;
5251 zero means top of window, negative means relative to bottom of window. */)
5252 (Lisp_Object arg)
5254 struct window *w = XWINDOW (selected_window);
5255 int lines, start;
5256 Lisp_Object window;
5257 #if 0
5258 int this_scroll_margin;
5259 #endif
5261 if (!(BUFFERP (w->buffer)
5262 && XBUFFER (w->buffer) == current_buffer))
5263 /* This test is needed to make sure PT/PT_BYTE make sense in w->buffer
5264 when passed below to set_marker_both. */
5265 error ("move-to-window-line called from unrelated buffer");
5267 window = selected_window;
5268 start = marker_position (w->start);
5269 if (start < BEGV || start > ZV)
5271 int height = window_internal_height (w);
5272 Fvertical_motion (make_number (- (height / 2)), window);
5273 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
5274 w->start_at_line_beg = Fbolp ();
5275 w->force_start = Qt;
5277 else
5278 Fgoto_char (w->start);
5280 lines = displayed_window_lines (w);
5282 #if 0
5283 this_scroll_margin = max (0, min (scroll_margin, lines / 4));
5284 #endif
5286 if (NILP (arg))
5287 XSETFASTINT (arg, lines / 2);
5288 else
5290 EMACS_INT iarg = XINT (Fprefix_numeric_value (arg));
5292 if (iarg < 0)
5293 iarg = iarg + lines;
5295 #if 0 /* This code would prevent move-to-window-line from moving point
5296 to a place inside the scroll margins (which would cause the
5297 next redisplay to scroll). I wrote this code, but then concluded
5298 it is probably better not to install it. However, it is here
5299 inside #if 0 so as not to lose it. -- rms. */
5301 /* Don't let it get into the margin at either top or bottom. */
5302 iarg = max (iarg, this_scroll_margin);
5303 iarg = min (iarg, lines - this_scroll_margin - 1);
5304 #endif
5306 arg = make_number (iarg);
5309 /* Skip past a partially visible first line. */
5310 if (w->vscroll)
5311 XSETINT (arg, XINT (arg) + 1);
5313 return Fvertical_motion (arg, window);
5318 /***********************************************************************
5319 Window Configuration
5320 ***********************************************************************/
5322 struct save_window_data
5324 struct vectorlike_header header;
5325 Lisp_Object selected_frame;
5326 Lisp_Object current_window;
5327 Lisp_Object current_buffer;
5328 Lisp_Object minibuf_scroll_window;
5329 Lisp_Object minibuf_selected_window;
5330 Lisp_Object root_window;
5331 Lisp_Object focus_frame;
5332 /* A vector, each of whose elements is a struct saved_window
5333 for one window. */
5334 Lisp_Object saved_windows;
5336 /* All fields above are traced by the GC.
5337 From `fame-cols' down, the fields are ignored by the GC. */
5339 int frame_cols, frame_lines, frame_menu_bar_lines;
5340 int frame_tool_bar_lines;
5343 /* This is saved as a Lisp_Vector */
5344 struct saved_window
5346 struct vectorlike_header header;
5348 Lisp_Object window, buffer, start, pointm, mark;
5349 Lisp_Object left_col, top_line, total_cols, total_lines;
5350 Lisp_Object normal_cols, normal_lines;
5351 Lisp_Object hscroll, min_hscroll;
5352 Lisp_Object parent, prev;
5353 Lisp_Object start_at_line_beg;
5354 Lisp_Object display_table;
5355 Lisp_Object left_margin_cols, right_margin_cols;
5356 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
5357 Lisp_Object scroll_bar_width, vertical_scroll_bar_type, dedicated;
5358 Lisp_Object splits, nest, window_parameters;
5361 #define SAVED_WINDOW_N(swv,n) \
5362 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5364 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
5365 doc: /* Return t if OBJECT is a window-configuration object. */)
5366 (Lisp_Object object)
5368 return WINDOW_CONFIGURATIONP (object) ? Qt : Qnil;
5371 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
5372 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5373 (Lisp_Object config)
5375 register struct save_window_data *data;
5376 struct Lisp_Vector *saved_windows;
5378 CHECK_WINDOW_CONFIGURATION (config);
5380 data = (struct save_window_data *) XVECTOR (config);
5381 saved_windows = XVECTOR (data->saved_windows);
5382 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5385 DEFUN ("set-window-configuration", Fset_window_configuration,
5386 Sset_window_configuration, 1, 1, 0,
5387 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5388 CONFIGURATION must be a value previously returned
5389 by `current-window-configuration' (which see).
5390 If CONFIGURATION was made from a frame that is now deleted,
5391 only frame-independent values can be restored. In this case,
5392 the return value is nil. Otherwise the value is t. */)
5393 (Lisp_Object configuration)
5395 register struct save_window_data *data;
5396 struct Lisp_Vector *saved_windows;
5397 Lisp_Object new_current_buffer;
5398 Lisp_Object frame;
5399 Lisp_Object auto_buffer_name;
5400 FRAME_PTR f;
5401 EMACS_INT old_point = -1;
5403 CHECK_WINDOW_CONFIGURATION (configuration);
5405 data = (struct save_window_data *) XVECTOR (configuration);
5406 saved_windows = XVECTOR (data->saved_windows);
5408 new_current_buffer = data->current_buffer;
5409 if (NILP (BVAR (XBUFFER (new_current_buffer), name)))
5410 new_current_buffer = Qnil;
5411 else
5413 if (XBUFFER (new_current_buffer) == current_buffer)
5414 /* The code further down "preserves point" by saving here PT in
5415 old_point and then setting it later back into PT. When the
5416 current-selected-window and the final-selected-window both show
5417 the current buffer, this suffers from the problem that the
5418 current PT is the window-point of the current-selected-window,
5419 while the final PT is the point of the final-selected-window, so
5420 this copy from one PT to the other would end up moving the
5421 window-point of the final-selected-window to the window-point of
5422 the current-selected-window. So we have to be careful which
5423 point of the current-buffer we copy into old_point. */
5424 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5425 && WINDOWP (selected_window)
5426 && EQ (XWINDOW (selected_window)->buffer, new_current_buffer)
5427 && !EQ (selected_window, data->current_window))
5428 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5429 else
5430 old_point = PT;
5431 else
5432 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
5433 point in new_current_buffer as of the last time this buffer was
5434 used. This can be non-deterministic since it can be changed by
5435 things like jit-lock by mere temporary selection of some random
5436 window that happens to show this buffer.
5437 So if possible we want this arbitrary choice of "which point" to
5438 be the one from the to-be-selected-window so as to prevent this
5439 window's cursor from being copied from another window. */
5440 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5441 /* If current_window = selected_window, its point is in BUF_PT. */
5442 && !EQ (selected_window, data->current_window))
5443 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5444 else
5445 old_point = BUF_PT (XBUFFER (new_current_buffer));
5448 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5449 f = XFRAME (frame);
5451 /* If f is a dead frame, don't bother rebuilding its window tree.
5452 However, there is other stuff we should still try to do below. */
5453 if (FRAME_LIVE_P (f))
5455 Lisp_Object window;
5456 Lisp_Object dead_windows = Qnil;
5457 register struct window *w;
5458 register struct saved_window *p;
5459 struct window *root_window;
5460 struct window **leaf_windows;
5461 int n_leaf_windows;
5462 ptrdiff_t k;
5463 int i, n;
5465 /* If the frame has been resized since this window configuration was
5466 made, we change the frame to the size specified in the
5467 configuration, restore the configuration, and then resize it
5468 back. We keep track of the prevailing height in these variables. */
5469 int previous_frame_lines = FRAME_LINES (f);
5470 int previous_frame_cols = FRAME_COLS (f);
5471 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
5472 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
5474 /* The mouse highlighting code could get screwed up
5475 if it runs during this. */
5476 BLOCK_INPUT;
5478 if (data->frame_lines != previous_frame_lines
5479 || data->frame_cols != previous_frame_cols)
5480 change_frame_size (f, data->frame_lines,
5481 data->frame_cols, 0, 0, 0);
5482 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5483 if (data->frame_menu_bar_lines
5484 != previous_frame_menu_bar_lines)
5485 x_set_menu_bar_lines (f, make_number (data->frame_menu_bar_lines),
5486 make_number (0));
5487 #ifdef HAVE_WINDOW_SYSTEM
5488 if (data->frame_tool_bar_lines
5489 != previous_frame_tool_bar_lines)
5490 x_set_tool_bar_lines (f, make_number (data->frame_tool_bar_lines),
5491 make_number (0));
5492 #endif
5493 #endif
5495 /* "Swap out" point from the selected window's buffer
5496 into the window itself. (Normally the pointm of the selected
5497 window holds garbage.) We do this now, before
5498 restoring the window contents, and prevent it from
5499 being done later on when we select a new window. */
5500 if (! NILP (XWINDOW (selected_window)->buffer))
5502 w = XWINDOW (selected_window);
5503 set_marker_both (w->pointm,
5504 w->buffer,
5505 BUF_PT (XBUFFER (w->buffer)),
5506 BUF_PT_BYTE (XBUFFER (w->buffer)));
5509 windows_or_buffers_changed++;
5510 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
5512 /* Problem: Freeing all matrices and later allocating them again
5513 is a serious redisplay flickering problem. What we would
5514 really like to do is to free only those matrices not reused
5515 below. */
5516 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
5517 leaf_windows
5518 = (struct window **) alloca (count_windows (root_window)
5519 * sizeof (struct window *));
5520 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
5522 /* Kludge Alert!
5523 Mark all windows now on frame as "deleted".
5524 Restoring the new configuration "undeletes" any that are in it.
5526 Save their current buffers in their height fields, since we may
5527 need it later, if a buffer saved in the configuration is now
5528 dead. */
5529 delete_all_subwindows (FRAME_ROOT_WINDOW (f));
5531 for (k = 0; k < saved_windows->header.size; k++)
5533 p = SAVED_WINDOW_N (saved_windows, k);
5534 window = p->window;
5535 w = XWINDOW (window);
5536 w->next = Qnil;
5538 if (!NILP (p->parent))
5539 w->parent = SAVED_WINDOW_N (saved_windows,
5540 XFASTINT (p->parent))->window;
5541 else
5542 w->parent = Qnil;
5544 if (!NILP (p->prev))
5546 w->prev = SAVED_WINDOW_N (saved_windows,
5547 XFASTINT (p->prev))->window;
5548 XWINDOW (w->prev)->next = p->window;
5550 else
5552 w->prev = Qnil;
5553 if (!NILP (w->parent))
5555 if (EQ (p->total_cols, XWINDOW (w->parent)->total_cols))
5557 XWINDOW (w->parent)->vchild = p->window;
5558 XWINDOW (w->parent)->hchild = Qnil;
5560 else
5562 XWINDOW (w->parent)->hchild = p->window;
5563 XWINDOW (w->parent)->vchild = Qnil;
5568 /* If we squirreled away the buffer in the window's height,
5569 restore it now. */
5570 if (BUFFERP (w->total_lines))
5571 w->buffer = w->total_lines;
5572 w->left_col = p->left_col;
5573 w->top_line = p->top_line;
5574 w->total_cols = p->total_cols;
5575 w->total_lines = p->total_lines;
5576 w->normal_cols = p->normal_cols;
5577 w->normal_lines = p->normal_lines;
5578 w->hscroll = p->hscroll;
5579 w->min_hscroll = p->min_hscroll;
5580 w->display_table = p->display_table;
5581 w->left_margin_cols = p->left_margin_cols;
5582 w->right_margin_cols = p->right_margin_cols;
5583 w->left_fringe_width = p->left_fringe_width;
5584 w->right_fringe_width = p->right_fringe_width;
5585 w->fringes_outside_margins = p->fringes_outside_margins;
5586 w->scroll_bar_width = p->scroll_bar_width;
5587 w->vertical_scroll_bar_type = p->vertical_scroll_bar_type;
5588 w->dedicated = p->dedicated;
5589 w->splits = p->splits;
5590 w->nest = p->nest;
5591 w->window_parameters = p->window_parameters;
5592 XSETFASTINT (w->last_modified, 0);
5593 XSETFASTINT (w->last_overlay_modified, 0);
5595 /* Reinstall the saved buffer and pointers into it. */
5596 if (NILP (p->buffer))
5597 /* An internal window. */
5598 w->buffer = p->buffer;
5599 else if (!NILP (BVAR (XBUFFER (p->buffer), name)))
5600 /* If saved buffer is alive, install it. */
5602 w->buffer = p->buffer;
5603 w->start_at_line_beg = p->start_at_line_beg;
5604 set_marker_restricted (w->start, p->start, w->buffer);
5605 set_marker_restricted (w->pointm, p->pointm, w->buffer);
5606 Fset_marker (BVAR (XBUFFER (w->buffer), mark),
5607 p->mark, w->buffer);
5609 /* As documented in Fcurrent_window_configuration, don't
5610 restore the location of point in the buffer which was
5611 current when the window configuration was recorded. */
5612 if (!EQ (p->buffer, new_current_buffer)
5613 && XBUFFER (p->buffer) == current_buffer)
5614 Fgoto_char (w->pointm);
5616 else if (!NILP (w->buffer) && !NILP (BVAR (XBUFFER (w->buffer), name)))
5617 /* Keep window's old buffer; make sure the markers are
5618 real. */
5620 /* Set window markers at start of visible range. */
5621 if (XMARKER (w->start)->buffer == 0)
5622 set_marker_restricted (w->start, make_number (0),
5623 w->buffer);
5624 if (XMARKER (w->pointm)->buffer == 0)
5625 set_marker_restricted_both (w->pointm, w->buffer,
5626 BUF_PT (XBUFFER (w->buffer)),
5627 BUF_PT_BYTE (XBUFFER (w->buffer)));
5628 w->start_at_line_beg = Qt;
5630 else if (STRINGP (auto_buffer_name =
5631 Fwindow_parameter (window, Qauto_buffer_name))
5632 && SCHARS (auto_buffer_name) != 0
5633 && !NILP (w->buffer = Fget_buffer_create (auto_buffer_name)))
5635 set_marker_restricted (w->start, make_number (0), w->buffer);
5636 set_marker_restricted (w->pointm, make_number (0), w->buffer);
5637 w->start_at_line_beg = Qt;
5639 else
5640 /* Window has no live buffer, get one. */
5642 /* Get the buffer via other_buffer_safely in order to
5643 avoid showing an unimportant buffer and, if necessary, to
5644 recreate *scratch* in the course (part of Juanma's bs-show
5645 scenario from March 2011). */
5646 w->buffer = other_buffer_safely (Fcurrent_buffer ());
5647 /* This will set the markers to beginning of visible
5648 range. */
5649 set_marker_restricted (w->start, make_number (0), w->buffer);
5650 set_marker_restricted (w->pointm, make_number (0), w->buffer);
5651 w->start_at_line_beg = Qt;
5652 if (!NILP (w->dedicated))
5653 /* Record this window as dead. */
5654 dead_windows = Fcons (window, dead_windows);
5655 /* Make sure window is no more dedicated. */
5656 w->dedicated = Qnil;
5660 FRAME_ROOT_WINDOW (f) = data->root_window;
5661 /* Arrange *not* to restore point in the buffer that was
5662 current when the window configuration was saved. */
5663 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
5664 set_marker_restricted (XWINDOW (data->current_window)->pointm,
5665 make_number (old_point),
5666 XWINDOW (data->current_window)->buffer);
5668 /* In the following call to `select-window', prevent "swapping out
5669 point" in the old selected window using the buffer that has
5670 been restored into it. We already swapped out that point from
5671 that window's old buffer. */
5672 select_window (data->current_window, Qnil, 1);
5673 BVAR (XBUFFER (XWINDOW (selected_window)->buffer), last_selected_window)
5674 = selected_window;
5676 if (NILP (data->focus_frame)
5677 || (FRAMEP (data->focus_frame)
5678 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
5679 Fredirect_frame_focus (frame, data->focus_frame);
5681 /* Set the screen height to the value it had before this function. */
5682 if (previous_frame_lines != FRAME_LINES (f)
5683 || previous_frame_cols != FRAME_COLS (f))
5684 change_frame_size (f, previous_frame_lines, previous_frame_cols,
5685 0, 0, 0);
5686 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5687 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
5688 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
5689 make_number (0));
5690 #ifdef HAVE_WINDOW_SYSTEM
5691 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
5692 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
5693 make_number (0));
5694 #endif
5695 #endif
5697 /* Now, free glyph matrices in windows that were not reused. */
5698 for (i = n = 0; i < n_leaf_windows; ++i)
5700 if (NILP (leaf_windows[i]->buffer))
5702 /* Assert it's not reused as a combination. */
5703 xassert (NILP (leaf_windows[i]->hchild)
5704 && NILP (leaf_windows[i]->vchild));
5705 free_window_matrices (leaf_windows[i]);
5707 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
5708 ++n;
5711 adjust_glyphs (f);
5712 UNBLOCK_INPUT;
5714 /* Scan dead buffer windows. */
5715 for (; CONSP (dead_windows); dead_windows = XCDR (dead_windows))
5717 window = XCAR (dead_windows);
5718 if (WINDOW_LIVE_P (window) && !EQ (window, FRAME_ROOT_WINDOW (f)))
5719 delete_deletable_window (window);
5722 /* Fselect_window will have made f the selected frame, so we
5723 reselect the proper frame here. Fhandle_switch_frame will change the
5724 selected window too, but that doesn't make the call to
5725 Fselect_window above totally superfluous; it still sets f's
5726 selected window. */
5727 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
5728 do_switch_frame (data->selected_frame, 0, 0, Qnil);
5730 run_window_configuration_change_hook (f);
5733 if (!NILP (new_current_buffer))
5734 Fset_buffer (new_current_buffer);
5736 Vminibuf_scroll_window = data->minibuf_scroll_window;
5737 minibuf_selected_window = data->minibuf_selected_window;
5739 return (FRAME_LIVE_P (f) ? Qt : Qnil);
5743 /* Delete all subwindows reachable via the next, vchild, and hchild
5744 slots of WINDOW. */
5745 void
5746 delete_all_subwindows (Lisp_Object window)
5748 register struct window *w;
5750 w = XWINDOW (window);
5752 if (!NILP (w->next))
5753 /* Delete WINDOW's siblings (we traverse postorderly). */
5754 delete_all_subwindows (w->next);
5756 w->total_lines = w->buffer; /* See Fset_window_configuration for excuse. */
5758 if (!NILP (w->vchild))
5760 delete_all_subwindows (w->vchild);
5761 w->vchild = Qnil;
5763 else if (!NILP (w->hchild))
5765 delete_all_subwindows (w->hchild);
5766 w->hchild = Qnil;
5768 else if (!NILP (w->buffer))
5770 unshow_buffer (w);
5771 unchain_marker (XMARKER (w->pointm));
5772 unchain_marker (XMARKER (w->start));
5773 w->buffer = Qnil;
5776 Vwindow_list = Qnil;
5779 static int
5780 count_windows (register struct window *window)
5782 register int count = 1;
5783 if (!NILP (window->next))
5784 count += count_windows (XWINDOW (window->next));
5785 if (!NILP (window->vchild))
5786 count += count_windows (XWINDOW (window->vchild));
5787 if (!NILP (window->hchild))
5788 count += count_windows (XWINDOW (window->hchild));
5789 return count;
5793 /* Fill vector FLAT with leaf windows under W, starting at index I.
5794 Value is last index + 1. */
5795 static int
5796 get_leaf_windows (struct window *w, struct window **flat, int i)
5798 while (w)
5800 if (!NILP (w->hchild))
5801 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
5802 else if (!NILP (w->vchild))
5803 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
5804 else
5805 flat[i++] = w;
5807 w = NILP (w->next) ? 0 : XWINDOW (w->next);
5810 return i;
5814 /* Return a pointer to the glyph W's physical cursor is on. Value is
5815 null if W's current matrix is invalid, so that no meaningfull glyph
5816 can be returned. */
5817 struct glyph *
5818 get_phys_cursor_glyph (struct window *w)
5820 struct glyph_row *row;
5821 struct glyph *glyph;
5823 if (w->phys_cursor.vpos >= 0
5824 && w->phys_cursor.vpos < w->current_matrix->nrows
5825 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
5826 row->enabled_p)
5827 && row->used[TEXT_AREA] > w->phys_cursor.hpos)
5828 glyph = row->glyphs[TEXT_AREA] + w->phys_cursor.hpos;
5829 else
5830 glyph = NULL;
5832 return glyph;
5836 static int
5837 save_window_save (Lisp_Object window, struct Lisp_Vector *vector, int i)
5839 register struct saved_window *p;
5840 register struct window *w;
5841 register Lisp_Object tem;
5843 for (;!NILP (window); window = w->next)
5845 p = SAVED_WINDOW_N (vector, i);
5846 w = XWINDOW (window);
5848 XSETFASTINT (w->temslot, i); i++;
5849 p->window = window;
5850 p->buffer = w->buffer;
5851 p->left_col = w->left_col;
5852 p->top_line = w->top_line;
5853 p->total_cols = w->total_cols;
5854 p->total_lines = w->total_lines;
5855 p->normal_cols = w->normal_cols;
5856 p->normal_lines = w->normal_lines;
5857 p->hscroll = w->hscroll;
5858 p->min_hscroll = w->min_hscroll;
5859 p->display_table = w->display_table;
5860 p->left_margin_cols = w->left_margin_cols;
5861 p->right_margin_cols = w->right_margin_cols;
5862 p->left_fringe_width = w->left_fringe_width;
5863 p->right_fringe_width = w->right_fringe_width;
5864 p->fringes_outside_margins = w->fringes_outside_margins;
5865 p->scroll_bar_width = w->scroll_bar_width;
5866 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
5867 p->dedicated = w->dedicated;
5868 p->splits = w->splits;
5869 p->nest = w->nest;
5870 p->window_parameters = w->window_parameters;
5871 if (!NILP (w->buffer))
5873 /* Save w's value of point in the window configuration.
5874 If w is the selected window, then get the value of point
5875 from the buffer; pointm is garbage in the selected window. */
5876 if (EQ (window, selected_window))
5878 p->pointm = Fmake_marker ();
5879 set_marker_both (p->pointm, w->buffer,
5880 BUF_PT (XBUFFER (w->buffer)),
5881 BUF_PT_BYTE (XBUFFER (w->buffer)));
5883 else
5884 p->pointm = Fcopy_marker (w->pointm, Qnil);
5886 p->start = Fcopy_marker (w->start, Qnil);
5887 p->start_at_line_beg = w->start_at_line_beg;
5889 tem = BVAR (XBUFFER (w->buffer), mark);
5890 p->mark = Fcopy_marker (tem, Qnil);
5892 else
5894 p->pointm = Qnil;
5895 p->start = Qnil;
5896 p->mark = Qnil;
5897 p->start_at_line_beg = Qnil;
5900 if (NILP (w->parent))
5901 p->parent = Qnil;
5902 else
5903 p->parent = XWINDOW (w->parent)->temslot;
5905 if (NILP (w->prev))
5906 p->prev = Qnil;
5907 else
5908 p->prev = XWINDOW (w->prev)->temslot;
5910 if (!NILP (w->vchild))
5911 i = save_window_save (w->vchild, vector, i);
5912 if (!NILP (w->hchild))
5913 i = save_window_save (w->hchild, vector, i);
5916 return i;
5919 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
5920 Scurrent_window_configuration, 0, 1, 0,
5921 doc: /* Return an object representing the current window configuration of FRAME.
5922 If FRAME is nil or omitted, use the selected frame.
5923 This describes the number of windows, their sizes and current buffers,
5924 and for each displayed buffer, where display starts, and the positions of
5925 point and mark. An exception is made for point in the current buffer:
5926 its value is -not- saved.
5927 This also records the currently selected frame, and FRAME's focus
5928 redirection (see `redirect-frame-focus'). */)
5929 (Lisp_Object frame)
5931 register Lisp_Object tem;
5932 register int n_windows;
5933 register struct save_window_data *data;
5934 register int i;
5935 FRAME_PTR f;
5937 if (NILP (frame))
5938 frame = selected_frame;
5939 CHECK_LIVE_FRAME (frame);
5940 f = XFRAME (frame);
5942 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
5943 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
5944 PVEC_WINDOW_CONFIGURATION);
5946 data->frame_cols = FRAME_COLS (f);
5947 data->frame_lines = FRAME_LINES (f);
5948 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
5949 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
5950 data->selected_frame = selected_frame;
5951 data->current_window = FRAME_SELECTED_WINDOW (f);
5952 XSETBUFFER (data->current_buffer, current_buffer);
5953 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
5954 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
5955 data->root_window = FRAME_ROOT_WINDOW (f);
5956 data->focus_frame = FRAME_FOCUS_FRAME (f);
5957 tem = Fmake_vector (make_number (n_windows), Qnil);
5958 data->saved_windows = tem;
5959 for (i = 0; i < n_windows; i++)
5960 XVECTOR (tem)->contents[i]
5961 = Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil);
5962 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
5963 XSETWINDOW_CONFIGURATION (tem, data);
5964 return (tem);
5967 /***********************************************************************
5968 Marginal Areas
5969 ***********************************************************************/
5971 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
5972 2, 3, 0,
5973 doc: /* Set width of marginal areas of window WINDOW.
5974 If WINDOW is nil, set margins of the currently selected window.
5975 Second arg LEFT-WIDTH specifies the number of character cells to
5976 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
5977 does the same for the right marginal area. A nil width parameter
5978 means no margin. */)
5979 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width)
5981 struct window *w = decode_window (window);
5983 /* Translate negative or zero widths to nil.
5984 Margins that are too wide have to be checked elsewhere. */
5986 if (!NILP (left_width))
5988 CHECK_NUMBER (left_width);
5989 if (XINT (left_width) <= 0)
5990 left_width = Qnil;
5993 if (!NILP (right_width))
5995 CHECK_NUMBER (right_width);
5996 if (XINT (right_width) <= 0)
5997 right_width = Qnil;
6000 if (!EQ (w->left_margin_cols, left_width)
6001 || !EQ (w->right_margin_cols, right_width))
6003 w->left_margin_cols = left_width;
6004 w->right_margin_cols = right_width;
6006 adjust_window_margins (w);
6008 ++windows_or_buffers_changed;
6009 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6012 return Qnil;
6016 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
6017 0, 1, 0,
6018 doc: /* Get width of marginal areas of window WINDOW.
6019 If WINDOW is omitted or nil, use the currently selected window.
6020 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6021 If a marginal area does not exist, its width will be returned
6022 as nil. */)
6023 (Lisp_Object window)
6025 struct window *w = decode_window (window);
6026 return Fcons (w->left_margin_cols, w->right_margin_cols);
6031 /***********************************************************************
6032 Fringes
6033 ***********************************************************************/
6035 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6036 2, 4, 0,
6037 doc: /* Set the fringe widths of window WINDOW.
6038 If WINDOW is nil, set the fringe widths of the currently selected
6039 window.
6040 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6041 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6042 fringe width. If a fringe width arg is nil, that means to use the
6043 frame's default fringe width. Default fringe widths can be set with
6044 the command `set-fringe-style'.
6045 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6046 outside of the display margins. By default, fringes are drawn between
6047 display marginal areas and the text area. */)
6048 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width, Lisp_Object outside_margins)
6050 struct window *w = decode_window (window);
6052 if (!NILP (left_width))
6053 CHECK_NATNUM (left_width);
6054 if (!NILP (right_width))
6055 CHECK_NATNUM (right_width);
6057 /* Do nothing on a tty. */
6058 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6059 && (!EQ (w->left_fringe_width, left_width)
6060 || !EQ (w->right_fringe_width, right_width)
6061 || !EQ (w->fringes_outside_margins, outside_margins)))
6063 w->left_fringe_width = left_width;
6064 w->right_fringe_width = right_width;
6065 w->fringes_outside_margins = outside_margins;
6067 adjust_window_margins (w);
6069 clear_glyph_matrix (w->current_matrix);
6070 w->window_end_valid = Qnil;
6072 ++windows_or_buffers_changed;
6073 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6076 return Qnil;
6080 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6081 0, 1, 0,
6082 doc: /* Get width of fringes of window WINDOW.
6083 If WINDOW is omitted or nil, use the currently selected window.
6084 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6085 (Lisp_Object window)
6087 struct window *w = decode_window (window);
6089 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6090 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6091 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6092 ? Qt : Qnil), Qnil)));
6097 /***********************************************************************
6098 Scroll bars
6099 ***********************************************************************/
6101 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars,
6102 Sset_window_scroll_bars, 2, 4, 0,
6103 doc: /* Set width and type of scroll bars of window WINDOW.
6104 If window is nil, set scroll bars of the currently selected window.
6105 Second parameter WIDTH specifies the pixel width for the scroll bar;
6106 this is automatically adjusted to a multiple of the frame column width.
6107 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6108 bar: left, right, or nil.
6109 If WIDTH is nil, use the frame's scroll-bar width.
6110 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6111 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6112 (Lisp_Object window, Lisp_Object width, Lisp_Object vertical_type, Lisp_Object horizontal_type)
6114 struct window *w = decode_window (window);
6116 if (!NILP (width))
6118 CHECK_NATNUM (width);
6120 if (XINT (width) == 0)
6121 vertical_type = Qnil;
6124 if (!(NILP (vertical_type)
6125 || EQ (vertical_type, Qleft)
6126 || EQ (vertical_type, Qright)
6127 || EQ (vertical_type, Qt)))
6128 error ("Invalid type of vertical scroll bar");
6130 if (!EQ (w->scroll_bar_width, width)
6131 || !EQ (w->vertical_scroll_bar_type, vertical_type))
6133 w->scroll_bar_width = width;
6134 w->vertical_scroll_bar_type = vertical_type;
6136 adjust_window_margins (w);
6138 clear_glyph_matrix (w->current_matrix);
6139 w->window_end_valid = Qnil;
6141 ++windows_or_buffers_changed;
6142 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6145 return Qnil;
6149 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
6150 0, 1, 0,
6151 doc: /* Get width and type of scroll bars of window WINDOW.
6152 If WINDOW is omitted or nil, use the currently selected window.
6153 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6154 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6155 value. */)
6156 (Lisp_Object window)
6158 struct window *w = decode_window (window);
6159 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6160 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6161 : WINDOW_SCROLL_BAR_AREA_WIDTH (w))),
6162 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w)),
6163 Fcons (w->vertical_scroll_bar_type,
6164 Fcons (Qnil, Qnil))));
6169 /***********************************************************************
6170 Smooth scrolling
6171 ***********************************************************************/
6173 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
6174 doc: /* Return the amount by which WINDOW is scrolled vertically.
6175 Use the selected window if WINDOW is nil or omitted.
6176 Normally, value is a multiple of the canonical character height of WINDOW;
6177 optional second arg PIXELS-P means value is measured in pixels. */)
6178 (Lisp_Object window, Lisp_Object pixels_p)
6180 Lisp_Object result;
6181 struct frame *f;
6182 struct window *w;
6184 if (NILP (window))
6185 window = selected_window;
6186 else
6187 CHECK_WINDOW (window);
6188 w = XWINDOW (window);
6189 f = XFRAME (w->frame);
6191 if (FRAME_WINDOW_P (f))
6192 result = (NILP (pixels_p)
6193 ? FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll)
6194 : make_number (-w->vscroll));
6195 else
6196 result = make_number (0);
6197 return result;
6201 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
6202 2, 3, 0,
6203 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
6204 WINDOW nil means use the selected window. Normally, VSCROLL is a
6205 non-negative multiple of the canonical character height of WINDOW;
6206 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
6207 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
6208 corresponds to an integral number of pixels. The return value is the
6209 result of this rounding.
6210 If PIXELS-P is non-nil, the return value is VSCROLL. */)
6211 (Lisp_Object window, Lisp_Object vscroll, Lisp_Object pixels_p)
6213 struct window *w;
6214 struct frame *f;
6216 if (NILP (window))
6217 window = selected_window;
6218 else
6219 CHECK_WINDOW (window);
6220 CHECK_NUMBER_OR_FLOAT (vscroll);
6222 w = XWINDOW (window);
6223 f = XFRAME (w->frame);
6225 if (FRAME_WINDOW_P (f))
6227 int old_dy = w->vscroll;
6229 w->vscroll = - (NILP (pixels_p)
6230 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
6231 : XFLOATINT (vscroll));
6232 w->vscroll = min (w->vscroll, 0);
6234 if (w->vscroll != old_dy)
6236 /* Adjust glyph matrix of the frame if the virtual display
6237 area becomes larger than before. */
6238 if (w->vscroll < 0 && w->vscroll < old_dy)
6239 adjust_glyphs (f);
6241 /* Prevent redisplay shortcuts. */
6242 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
6246 return Fwindow_vscroll (window, pixels_p);
6250 /* Call FN for all leaf windows on frame F. FN is called with the
6251 first argument being a pointer to the leaf window, and with
6252 additional argument USER_DATA. Stops when FN returns 0. */
6254 static void
6255 foreach_window (struct frame *f, int (*fn) (struct window *, void *),
6256 void *user_data)
6258 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6259 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
6260 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
6264 /* Helper function for foreach_window. Call FN for all leaf windows
6265 reachable from W. FN is called with the first argument being a
6266 pointer to the leaf window, and with additional argument USER_DATA.
6267 Stop when FN returns 0. Value is 0 if stopped by FN. */
6269 static int
6270 foreach_window_1 (struct window *w, int (*fn) (struct window *, void *), void *user_data)
6272 int cont;
6274 for (cont = 1; w && cont;)
6276 if (!NILP (w->hchild))
6277 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
6278 else if (!NILP (w->vchild))
6279 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
6280 else
6281 cont = fn (w, user_data);
6283 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6286 return cont;
6290 /* Freeze or unfreeze the window start of W unless it is a
6291 mini-window or the selected window. FREEZE_P non-null means freeze
6292 the window start. */
6294 static int
6295 freeze_window_start (struct window *w, void *freeze_p)
6297 if (MINI_WINDOW_P (w)
6298 || (WINDOWP (selected_window) /* Can be nil in corner cases. */
6299 && (w == XWINDOW (selected_window)
6300 || (MINI_WINDOW_P (XWINDOW (selected_window))
6301 && ! NILP (Vminibuf_scroll_window)
6302 && w == XWINDOW (Vminibuf_scroll_window)))))
6303 freeze_p = NULL;
6305 w->frozen_window_start_p = freeze_p != NULL;
6306 return 1;
6310 /* Freeze or unfreeze the window starts of all leaf windows on frame
6311 F, except the selected window and a mini-window. FREEZE_P non-zero
6312 means freeze the window start. */
6314 void
6315 freeze_window_starts (struct frame *f, int freeze_p)
6317 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
6321 /***********************************************************************
6322 Initialization
6323 ***********************************************************************/
6325 /* Return 1 if window configurations CONFIGURATION1 and CONFIGURATION2
6326 describe the same state of affairs. This is used by Fequal.
6328 ignore_positions non-zero means ignore non-matching scroll positions
6329 and the like.
6331 This ignores a couple of things like the dedicatedness status of
6332 window, splits, nest and the like. This might have to be fixed. */
6335 compare_window_configurations (Lisp_Object configuration1, Lisp_Object configuration2, int ignore_positions)
6337 register struct save_window_data *d1, *d2;
6338 struct Lisp_Vector *sws1, *sws2;
6339 ptrdiff_t i;
6341 CHECK_WINDOW_CONFIGURATION (configuration1);
6342 CHECK_WINDOW_CONFIGURATION (configuration2);
6344 d1 = (struct save_window_data *) XVECTOR (configuration1);
6345 d2 = (struct save_window_data *) XVECTOR (configuration2);
6346 sws1 = XVECTOR (d1->saved_windows);
6347 sws2 = XVECTOR (d2->saved_windows);
6349 /* Frame settings must match. */
6350 if (d1->frame_cols != d2->frame_cols
6351 || d1->frame_lines != d2->frame_lines
6352 || d1->frame_menu_bar_lines != d2->frame_menu_bar_lines
6353 || !EQ (d1->selected_frame, d2->selected_frame)
6354 || !EQ (d1->current_buffer, d2->current_buffer)
6355 || (!ignore_positions
6356 && (!EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window)
6357 || !EQ (d1->minibuf_selected_window, d2->minibuf_selected_window)))
6358 || !EQ (d1->focus_frame, d2->focus_frame)
6359 /* Verify that the two configurations have the same number of windows. */
6360 || sws1->header.size != sws2->header.size)
6361 return 0;
6363 for (i = 0; i < sws1->header.size; i++)
6365 struct saved_window *sw1, *sw2;
6367 sw1 = SAVED_WINDOW_N (sws1, i);
6368 sw2 = SAVED_WINDOW_N (sws2, i);
6370 if (
6371 /* The "current" windows in the two configurations must
6372 correspond to each other. */
6373 EQ (d1->current_window, sw1->window)
6374 != EQ (d2->current_window, sw2->window)
6375 /* Windows' buffers must match. */
6376 || !EQ (sw1->buffer, sw2->buffer)
6377 || !EQ (sw1->left_col, sw2->left_col)
6378 || !EQ (sw1->top_line, sw2->top_line)
6379 || !EQ (sw1->total_cols, sw2->total_cols)
6380 || !EQ (sw1->total_lines, sw2->total_lines)
6381 || !EQ (sw1->display_table, sw2->display_table)
6382 /* The next two disjuncts check the window structure for
6383 equality. */
6384 || !EQ (sw1->parent, sw2->parent)
6385 || !EQ (sw1->prev, sw2->prev)
6386 || (!ignore_positions
6387 && (!EQ (sw1->hscroll, sw2->hscroll)
6388 || !EQ (sw1->min_hscroll, sw2->min_hscroll)
6389 || !EQ (sw1->start_at_line_beg, sw2->start_at_line_beg)
6390 || NILP (Fequal (sw1->start, sw2->start))
6391 || NILP (Fequal (sw1->pointm, sw2->pointm))
6392 || NILP (Fequal (sw1->mark, sw2->mark))))
6393 || !EQ (sw1->left_margin_cols, sw2->left_margin_cols)
6394 || !EQ (sw1->right_margin_cols, sw2->right_margin_cols)
6395 || !EQ (sw1->left_fringe_width, sw2->left_fringe_width)
6396 || !EQ (sw1->right_fringe_width, sw2->right_fringe_width)
6397 || !EQ (sw1->fringes_outside_margins, sw2->fringes_outside_margins)
6398 || !EQ (sw1->scroll_bar_width, sw2->scroll_bar_width)
6399 || !EQ (sw1->vertical_scroll_bar_type, sw2->vertical_scroll_bar_type))
6400 return 0;
6403 return 1;
6406 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
6407 Scompare_window_configurations, 2, 2, 0,
6408 doc: /* Compare two window configurations as regards the structure of windows.
6409 This function ignores details such as the values of point and mark
6410 and scrolling positions. */)
6411 (Lisp_Object x, Lisp_Object y)
6413 if (compare_window_configurations (x, y, 1))
6414 return Qt;
6415 return Qnil;
6418 void
6419 init_window_once (void)
6421 struct frame *f = make_initial_frame ();
6422 XSETFRAME (selected_frame, f);
6423 Vterminal_frame = selected_frame;
6424 minibuf_window = f->minibuffer_window;
6425 selected_window = f->selected_window;
6426 last_nonminibuf_frame = f;
6428 window_initialized = 1;
6431 void
6432 init_window (void)
6434 Vwindow_list = Qnil;
6437 void
6438 syms_of_window (void)
6440 DEFSYM (Qscroll_up, "scroll-up");
6441 DEFSYM (Qscroll_down, "scroll-down");
6442 DEFSYM (Qscroll_command, "scroll-command");
6444 Fput (Qscroll_up, Qscroll_command, Qt);
6445 Fput (Qscroll_down, Qscroll_command, Qt);
6447 DEFSYM (Qwindow_configuration_change_hook, "window-configuration-change-hook");
6448 DEFSYM (Qwindowp, "windowp");
6449 DEFSYM (Qwindow_configuration_p, "window-configuration-p");
6450 DEFSYM (Qwindow_live_p, "window-live-p");
6451 DEFSYM (Qwindow_deletable_p, "window-deletable-p");
6452 DEFSYM (Qdelete_window, "delete-window");
6453 DEFSYM (Qwindow_resize_root_window, "window--resize-root-window");
6454 DEFSYM (Qwindow_resize_root_window_vertically, "window--resize-root-window-vertically");
6455 DEFSYM (Qsafe, "safe");
6456 DEFSYM (Qdisplay_buffer, "display-buffer");
6457 DEFSYM (Qreplace_buffer_in_windows, "replace-buffer-in-windows");
6458 DEFSYM (Qrecord_window_buffer, "record-window-buffer");
6459 DEFSYM (Qget_mru_window, "get-mru-window");
6460 DEFSYM (Qtemp_buffer_show_hook, "temp-buffer-show-hook");
6461 DEFSYM (Qabove, "above");
6462 DEFSYM (Qbelow, "below");
6463 DEFSYM (Qauto_buffer_name, "auto-buffer-name");
6465 staticpro (&Vwindow_list);
6467 minibuf_selected_window = Qnil;
6468 staticpro (&minibuf_selected_window);
6470 window_scroll_pixel_based_preserve_x = -1;
6471 window_scroll_pixel_based_preserve_y = -1;
6472 window_scroll_preserve_hpos = -1;
6473 window_scroll_preserve_vpos = -1;
6475 DEFVAR_LISP ("temp-buffer-show-function", Vtemp_buffer_show_function,
6476 doc: /* Non-nil means call as function to display a help buffer.
6477 The function is called with one argument, the buffer to be displayed.
6478 Used by `with-output-to-temp-buffer'.
6479 If this function is used, then it must do the entire job of showing
6480 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
6481 Vtemp_buffer_show_function = Qnil;
6483 DEFVAR_LISP ("temp-buffer-show-specifiers", Vtemp_buffer_show_specifiers,
6484 doc: /* Buffer display specifiers used by `with-output-to-temp-buffer'.
6485 These specifiers are passed by `with-output-to-temp-buffer' as second
6486 argument to `display-buffer'. Applications should only let-bind this
6487 around a call to `with-output-to-temp-buffer'.
6489 For a description of buffer display specifiers see the variable
6490 `display-buffer-alist'. */);
6491 Vtemp_buffer_show_specifiers = Qnil;
6493 DEFVAR_LISP ("minibuffer-scroll-window", Vminibuf_scroll_window,
6494 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
6495 Vminibuf_scroll_window = Qnil;
6497 DEFVAR_BOOL ("mode-line-in-non-selected-windows", mode_line_in_non_selected_windows,
6498 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
6499 If the minibuffer is active, the `minibuffer-scroll-window' mode line
6500 is displayed in the `mode-line' face. */);
6501 mode_line_in_non_selected_windows = 1;
6503 DEFVAR_LISP ("other-window-scroll-buffer", Vother_window_scroll_buffer,
6504 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
6505 Vother_window_scroll_buffer = Qnil;
6507 DEFVAR_BOOL ("auto-window-vscroll", auto_window_vscroll_p,
6508 doc: /* Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
6509 auto_window_vscroll_p = 1;
6511 DEFVAR_INT ("next-screen-context-lines", next_screen_context_lines,
6512 doc: /* Number of lines of continuity when scrolling by screenfuls. */);
6513 next_screen_context_lines = 2;
6515 DEFVAR_LISP ("scroll-preserve-screen-position",
6516 Vscroll_preserve_screen_position,
6517 doc: /* Controls if scroll commands move point to keep its screen position unchanged.
6518 A value of nil means point does not keep its screen position except
6519 at the scroll margin or window boundary respectively.
6520 A value of t means point keeps its screen position if the scroll
6521 command moved it vertically out of the window, e.g. when scrolling
6522 by full screens.
6523 Any other value means point always keeps its screen position.
6524 Scroll commands should have the `scroll-command' property
6525 on their symbols to be controlled by this variable. */);
6526 Vscroll_preserve_screen_position = Qnil;
6528 DEFVAR_LISP ("window-point-insertion-type", Vwindow_point_insertion_type,
6529 doc: /* Type of marker to use for `window-point'. */);
6530 Vwindow_point_insertion_type = Qnil;
6532 DEFVAR_LISP ("window-configuration-change-hook",
6533 Vwindow_configuration_change_hook,
6534 doc: /* Functions to call when window configuration changes.
6535 The buffer-local part is run once per window, with the relevant window
6536 selected; while the global part is run only once for the modified frame,
6537 with the relevant frame selected. */);
6538 Vwindow_configuration_change_hook = Qnil;
6540 DEFVAR_LISP ("recenter-redisplay", Vrecenter_redisplay,
6541 doc: /* If non-nil, then the `recenter' command with a nil argument
6542 will redraw the entire frame; the special value `tty' causes the
6543 frame to be redrawn only if it is a tty frame. */);
6544 Vrecenter_redisplay = Qtty;
6546 DEFVAR_LISP ("window-splits", Vwindow_splits,
6547 doc: /* Non-nil means splitting windows is handled specially.
6548 If this variable is nil, splitting a window gets the entire screen space
6549 for displaying the new window from the window to split. If this
6550 variable is non-nil, splitting a window may resize all windows in the
6551 same combination. This also allows to split a window that is otherwise
6552 too small or of fixed size.
6554 The value of this variable is also assigned to the split status of the
6555 new window and, provided the old and new window form a new combination,
6556 to the window that was split as well. The split status of a window can
6557 be retrieved with the function `window-splits' and altered by the
6558 function `set-window-splits'.
6560 If the value of the variable `window-nest' is non-nil, the space for the
6561 new window is exclusively taken from the window that shall be split, but
6562 the split status of the window that is split as well as that of the new
6563 window are still set to the value of this variable. */);
6564 Vwindow_splits = Qnil;
6566 DEFVAR_LISP ("window-nest", Vwindow_nest,
6567 doc: /* Non-nil means splitting a window makes a new parent window.
6568 If this variable is nil, splitting a window will create a new parent
6569 window only if the window has no parent window or the window shall
6570 become a combination orthogonal to the one it it is part of.
6572 If this variable is non-nil, splitting a window always creates a new
6573 parent window. If all splits behave this way, each frame's window tree
6574 is a binary tree and every window but the frame's root window has
6575 exactly one sibling.
6577 The value of this variable is also assigned to the nest status of the
6578 new parent window. The nest status of a window can be retrieved via the
6579 function `window-nest' and altered by the function `set-window-nest'. */);
6580 Vwindow_nest = Qnil;
6582 defsubr (&Sselected_window);
6583 defsubr (&Sminibuffer_window);
6584 defsubr (&Swindow_minibuffer_p);
6585 defsubr (&Swindowp);
6586 defsubr (&Swindow_live_p);
6587 defsubr (&Swindow_frame);
6588 defsubr (&Sframe_root_window);
6589 defsubr (&Sframe_first_window);
6590 defsubr (&Sframe_selected_window);
6591 defsubr (&Sset_frame_selected_window);
6592 defsubr (&Spos_visible_in_window_p);
6593 defsubr (&Swindow_line_height);
6594 defsubr (&Swindow_buffer);
6595 defsubr (&Swindow_parent);
6596 defsubr (&Swindow_top_child);
6597 defsubr (&Swindow_left_child);
6598 defsubr (&Swindow_next_sibling);
6599 defsubr (&Swindow_prev_sibling);
6600 defsubr (&Swindow_splits);
6601 defsubr (&Sset_window_splits);
6602 defsubr (&Swindow_nest);
6603 defsubr (&Sset_window_nest);
6604 defsubr (&Swindow_use_time);
6605 defsubr (&Swindow_top_line);
6606 defsubr (&Swindow_left_column);
6607 defsubr (&Swindow_total_size);
6608 defsubr (&Swindow_normal_size);
6609 defsubr (&Swindow_new_total);
6610 defsubr (&Swindow_new_normal);
6611 defsubr (&Sset_window_new_total);
6612 defsubr (&Sset_window_new_normal);
6613 defsubr (&Swindow_resize_apply);
6614 defsubr (&Swindow_body_size);
6615 defsubr (&Swindow_hscroll);
6616 defsubr (&Sset_window_hscroll);
6617 defsubr (&Swindow_redisplay_end_trigger);
6618 defsubr (&Sset_window_redisplay_end_trigger);
6619 defsubr (&Swindow_edges);
6620 defsubr (&Swindow_pixel_edges);
6621 defsubr (&Swindow_absolute_pixel_edges);
6622 defsubr (&Swindow_inside_edges);
6623 defsubr (&Swindow_inside_pixel_edges);
6624 defsubr (&Swindow_inside_absolute_pixel_edges);
6625 defsubr (&Scoordinates_in_window_p);
6626 defsubr (&Swindow_at);
6627 defsubr (&Swindow_point);
6628 defsubr (&Swindow_start);
6629 defsubr (&Swindow_end);
6630 defsubr (&Sset_window_point);
6631 defsubr (&Sset_window_start);
6632 defsubr (&Swindow_dedicated_p);
6633 defsubr (&Sset_window_dedicated_p);
6634 defsubr (&Swindow_display_table);
6635 defsubr (&Sset_window_display_table);
6636 defsubr (&Snext_window);
6637 defsubr (&Sprevious_window);
6638 defsubr (&Sget_buffer_window);
6639 defsubr (&Sdelete_other_windows_internal);
6640 defsubr (&Sdelete_window_internal);
6641 defsubr (&Sresize_mini_window_internal);
6642 defsubr (&Sset_window_buffer);
6643 defsubr (&Srun_window_configuration_change_hook);
6644 defsubr (&Sselect_window);
6645 defsubr (&Sforce_window_update);
6646 defsubr (&Stemp_output_buffer_show);
6647 defsubr (&Ssplit_window_internal);
6648 defsubr (&Sscroll_up);
6649 defsubr (&Sscroll_down);
6650 defsubr (&Sscroll_left);
6651 defsubr (&Sscroll_right);
6652 defsubr (&Sother_window_for_scrolling);
6653 defsubr (&Sscroll_other_window);
6654 defsubr (&Sminibuffer_selected_window);
6655 defsubr (&Srecenter);
6656 defsubr (&Swindow_text_height);
6657 defsubr (&Smove_to_window_line);
6658 defsubr (&Swindow_configuration_p);
6659 defsubr (&Swindow_configuration_frame);
6660 defsubr (&Sset_window_configuration);
6661 defsubr (&Scurrent_window_configuration);
6662 defsubr (&Sset_window_margins);
6663 defsubr (&Swindow_margins);
6664 defsubr (&Sset_window_fringes);
6665 defsubr (&Swindow_fringes);
6666 defsubr (&Sset_window_scroll_bars);
6667 defsubr (&Swindow_scroll_bars);
6668 defsubr (&Swindow_vscroll);
6669 defsubr (&Sset_window_vscroll);
6670 defsubr (&Scompare_window_configurations);
6671 defsubr (&Swindow_list);
6672 defsubr (&Swindow_list_1);
6673 defsubr (&Swindow_prev_buffers);
6674 defsubr (&Sset_window_prev_buffers);
6675 defsubr (&Swindow_next_buffers);
6676 defsubr (&Sset_window_next_buffers);
6677 defsubr (&Swindow_parameters);
6678 defsubr (&Swindow_parameter);
6679 defsubr (&Sset_window_parameter);
6682 void
6683 keys_of_window (void)
6685 initial_define_key (control_x_map, '<', "scroll-left");
6686 initial_define_key (control_x_map, '>', "scroll-right");
6688 initial_define_key (global_map, Ctl ('V'), "scroll-up-command");
6689 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
6690 initial_define_key (meta_map, 'v', "scroll-down-command");