More small edits for doc/lispref/windows.texi
[emacs.git] / src / window.c
blobaf7968f9edf519545f447b8b583fbc03c4a1fb60
1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985-1987, 1993-1998, 2000-2012
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, Qclone_of;
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 Internal windows and deleted windows are not live. */)
164 (Lisp_Object object)
166 return WINDOW_LIVE_P (object) ? Qt : Qnil;
169 /* Frames and windows. */
170 DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 1, 1, 0,
171 doc: /* Return the frame that window WINDOW is on.
172 If WINDOW is omitted or nil, it defaults to the selected window. */)
173 (Lisp_Object window)
175 return decode_any_window (window)->frame;
178 DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
179 doc: /* Return the root window of FRAME-OR-WINDOW.
180 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
181 With a frame argument, return that frame's root window.
182 With a window argument, return the root window of that window's 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 minibuffer window for frame FRAME.
202 If FRAME is omitted or nil, it defaults to the selected frame. */)
203 (Lisp_Object frame)
205 if (NILP (frame))
206 frame = selected_frame;
207 CHECK_LIVE_FRAME (frame);
208 return FRAME_MINIBUF_WINDOW (XFRAME (frame));
211 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
212 Swindow_minibuffer_p, 0, 1, 0,
213 doc: /* Return non-nil if WINDOW is a minibuffer window.
214 If WINDOW is omitted or nil, it defaults to the selected window. */)
215 (Lisp_Object window)
217 return MINI_WINDOW_P (decode_any_window (window)) ? Qt : Qnil;
220 /* Don't move this to window.el - this must be a safe routine. */
221 DEFUN ("frame-first-window", Fframe_first_window, Sframe_first_window, 0, 1, 0,
222 doc: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
223 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
224 Else if FRAME-OR-WINDOW denotes any window, return the first window of
225 that window's frame. If FRAME-OR-WINDOW denotes a live frame, return
226 the first window of that frame. */)
227 (Lisp_Object frame_or_window)
229 Lisp_Object window;
231 if (NILP (frame_or_window))
232 window = SELECTED_FRAME ()->root_window;
233 else if (WINDOWP (frame_or_window))
234 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
235 else
237 CHECK_LIVE_FRAME (frame_or_window);
238 window = XFRAME (frame_or_window)->root_window;
241 while (NILP (XWINDOW (window)->buffer))
243 if (! NILP (XWINDOW (window)->hchild))
244 window = XWINDOW (window)->hchild;
245 else if (! NILP (XWINDOW (window)->vchild))
246 window = XWINDOW (window)->vchild;
247 else
248 abort ();
251 return window;
254 DEFUN ("frame-selected-window", Fframe_selected_window,
255 Sframe_selected_window, 0, 1, 0,
256 doc: /* Return the selected window of FRAME-OR-WINDOW.
257 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
258 Else if FRAME-OR-WINDOW denotes any window, return the selected window
259 of that window's frame. If FRAME-OR-WINDOW denotes a live frame, return
260 the selected window of that frame. */)
261 (Lisp_Object frame_or_window)
263 Lisp_Object window;
265 if (NILP (frame_or_window))
266 window = SELECTED_FRAME ()->selected_window;
267 else if (WINDOWP (frame_or_window))
268 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
269 else
271 CHECK_LIVE_FRAME (frame_or_window);
272 window = XFRAME (frame_or_window)->selected_window;
275 return window;
278 DEFUN ("set-frame-selected-window", Fset_frame_selected_window,
279 Sset_frame_selected_window, 2, 3, 0,
280 doc: /* Set selected window of FRAME to WINDOW.
281 FRAME must be a live frame and defaults to the selected one. If FRAME
282 is the selected frame, this makes WINDOW the selected window. Optional
283 argument NORECORD non-nil means to neither change the order of recently
284 selected windows nor the buffer list. WINDOW must denote a live window.
285 Return WINDOW. */)
286 (Lisp_Object frame, Lisp_Object window, Lisp_Object norecord)
288 if (NILP (frame))
289 frame = selected_frame;
291 CHECK_LIVE_FRAME (frame);
292 CHECK_LIVE_WINDOW (window);
294 if (! EQ (frame, WINDOW_FRAME (XWINDOW (window))))
295 error ("In `set-frame-selected-window', WINDOW is not on FRAME");
297 if (EQ (frame, selected_frame))
298 return Fselect_window (window, norecord);
299 else
300 return XFRAME (frame)->selected_window = window;
303 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
304 doc: /* Return the selected window.
305 The selected window is the window in which the standard cursor for
306 selected windows appears and to which many commands apply. */)
307 (void)
309 return selected_window;
312 int window_select_count;
314 /* If select_window is called with inhibit_point_swap non-zero it will
315 not store point of the old selected window's buffer back into that
316 window's pointm slot. This is needed by Fset_window_configuration to
317 avoid that the display routine is called with selected_window set to
318 Qnil causing a subsequent crash. */
319 static Lisp_Object
320 select_window (Lisp_Object window, Lisp_Object norecord, int inhibit_point_swap)
322 register struct window *w;
323 register struct window *ow;
324 struct frame *sf;
326 CHECK_LIVE_WINDOW (window);
328 w = XWINDOW (window);
329 w->frozen_window_start_p = 0;
331 if (NILP (norecord))
333 ++window_select_count;
334 XSETFASTINT (w->use_time, window_select_count);
335 record_buffer (w->buffer);
338 if (EQ (window, selected_window) && !inhibit_point_swap)
339 return window;
341 sf = SELECTED_FRAME ();
342 if (XFRAME (WINDOW_FRAME (w)) != sf)
344 XFRAME (WINDOW_FRAME (w))->selected_window = window;
345 /* Use this rather than Fhandle_switch_frame
346 so that FRAME_FOCUS_FRAME is moved appropriately as we
347 move around in the state where a minibuffer in a separate
348 frame is active. */
349 Fselect_frame (WINDOW_FRAME (w), norecord);
350 /* Fselect_frame called us back so we've done all the work already. */
351 eassert (EQ (window, selected_window));
352 return window;
354 else
355 sf->selected_window = window;
357 /* Store the current buffer's actual point into the
358 old selected window. It belongs to that window,
359 and when the window is not selected, must be in the window. */
360 if (!inhibit_point_swap)
362 ow = XWINDOW (selected_window);
363 if (! NILP (ow->buffer))
364 set_marker_both (ow->pointm, ow->buffer,
365 BUF_PT (XBUFFER (ow->buffer)),
366 BUF_PT_BYTE (XBUFFER (ow->buffer)));
369 selected_window = window;
371 Fset_buffer (w->buffer);
373 BVAR (XBUFFER (w->buffer), last_selected_window) = window;
375 /* Go to the point recorded in the window.
376 This is important when the buffer is in more
377 than one window. It also matters when
378 redisplay_window has altered point after scrolling,
379 because it makes the change only in the window. */
381 register EMACS_INT new_point = marker_position (w->pointm);
382 if (new_point < BEGV)
383 SET_PT (BEGV);
384 else if (new_point > ZV)
385 SET_PT (ZV);
386 else
387 SET_PT (new_point);
390 windows_or_buffers_changed++;
391 return window;
394 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
395 doc: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
396 Also make WINDOW's buffer current and make WINDOW the frame's selected
397 window. Return WINDOW.
399 Optional second arg NORECORD non-nil means do not put this buffer at the
400 front of the buffer list and do not make this window the most recently
401 selected one.
403 Note that the main editor command loop sets the current buffer to the
404 buffer of the selected window before each command. */)
405 (register Lisp_Object window, Lisp_Object norecord)
407 return select_window (window, norecord, 0);
410 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
411 doc: /* Return the buffer displayed in window WINDOW.
412 If WINDOW is omitted or nil, it defaults to the selected window.
413 Return nil for an internal window or a deleted window. */)
414 (Lisp_Object window)
416 return decode_any_window (window)->buffer;
419 DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
420 doc: /* Return the parent window of window WINDOW.
421 If WINDOW is omitted or nil, it defaults to the selected window.
422 Return nil for a window with no parent (e.g. a root window). */)
423 (Lisp_Object window)
425 return decode_any_window (window)->parent;
428 DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 1, 1, 0,
429 doc: /* Return the topmost child window of window WINDOW.
430 Return nil if WINDOW is a live window (live windows have no children).
431 Return nil if WINDOW is an internal window whose children form a
432 horizontal combination. */)
433 (Lisp_Object window)
435 CHECK_WINDOW (window);
436 return decode_any_window (window)->vchild;
439 DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 1, 1, 0,
440 doc: /* Return the leftmost child window of window WINDOW.
441 Return nil if WINDOW is a live window (live windows have no children).
442 Return nil if WINDOW is an internal window whose children form a
443 vertical combination. */)
444 (Lisp_Object window)
446 CHECK_WINDOW (window);
447 return decode_any_window (window)->hchild;
450 DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
451 doc: /* Return the next sibling window of window WINDOW.
452 If WINDOW is omitted or nil, it defaults to the selected window.
453 Return nil if WINDOW has no next sibling. */)
454 (Lisp_Object window)
456 return decode_any_window (window)->next;
459 DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
460 doc: /* Return the previous sibling window of window WINDOW.
461 If WINDOW is omitted or nil, it defaults to the selected window.
462 Return nil if WINDOW has no previous sibling. */)
463 (Lisp_Object window)
465 return decode_any_window (window)->prev;
468 DEFUN ("window-combination-limit", Fwindow_combination_limit, Swindow_combination_limit, 1, 1, 0,
469 doc: /* Return combination limit of window WINDOW.
470 If the return value is nil, child windows of WINDOW can be recombined with
471 WINDOW's siblings. A return value of t means that child windows of
472 WINDOW are never \(re-)combined with WINDOW's siblings. */)
473 (Lisp_Object window)
475 return decode_any_window (window)->combination_limit;
478 DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
479 doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
480 If LIMIT is nil, child windows of WINDOW can be recombined with
481 WINDOW's siblings. LIMIT t means that child windows of WINDOW are
482 never \(re-)combined with WINDOW's siblings. Other values are reserved
483 for future use. */)
484 (Lisp_Object window, Lisp_Object limit)
486 register struct window *w = decode_any_window (window);
488 w->combination_limit = limit;
490 return w->combination_limit;
493 DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
494 doc: /* Return the use time of window WINDOW.
495 If WINDOW is omitted or nil, it defaults to the selected window.
496 The window with the highest use time is the most recently selected
497 one. The window with the lowest use time is the least recently
498 selected one. */)
499 (Lisp_Object window)
501 return decode_window (window)->use_time;
504 DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 1, 0,
505 doc: /* Return the total height, in lines, of window WINDOW.
506 If WINDOW is omitted or nil, it defaults to the selected window.
508 The return value includes the mode line and header line, if any.
509 If WINDOW is an internal window, the total height is the height
510 of the screen areas spanned by its children.
512 On a graphical display, this total height is reported as an
513 integer multiple of the default character height. */)
514 (Lisp_Object window)
516 return decode_any_window (window)->total_lines;
519 DEFUN ("window-total-width", Fwindow_total_width, Swindow_total_width, 0, 1, 0,
520 doc: /* Return the total width, in columns, of window WINDOW.
521 If WINDOW is omitted or nil, it defaults to the selected window.
523 The return value includes any vertical dividers or scroll bars
524 belonging to WINDOW. If WINDOW is an internal window, the total width
525 is the width of the screen areas spanned by its children.
527 On a graphical display, this total width is reported as an
528 integer multiple of the default character width. */)
529 (Lisp_Object window)
531 return decode_any_window (window)->total_cols;
534 DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
535 doc: /* Return the new total size of window WINDOW.
536 If WINDOW is omitted or nil, it defaults to the selected window. */)
537 (Lisp_Object window)
539 return decode_any_window (window)->new_total;
542 DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
543 doc: /* Return the normal height of window WINDOW.
544 If WINDOW is omitted or nil, it defaults to the selected window.
545 If HORIZONTAL is non-nil, return the normal width of WINDOW. */)
546 (Lisp_Object window, Lisp_Object horizontal)
548 if (NILP (horizontal))
549 return decode_any_window (window)->normal_lines;
550 else
551 return decode_any_window (window)->normal_cols;
554 DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
555 doc: /* Return new normal size of window WINDOW.
556 If WINDOW is omitted or nil, it defaults to the selected window. */)
557 (Lisp_Object window)
559 return decode_any_window (window)->new_normal;
562 DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
563 doc: /* Return left column of window WINDOW.
564 This is the distance, in columns, between the left edge of WINDOW and
565 the left edge of the frame's window area. For instance, the return
566 value is 0 if there is no window to the left of WINDOW.
568 If WINDOW is omitted or nil, it defaults to the selected window. */)
569 (Lisp_Object window)
571 return decode_any_window (window)->left_col;
574 DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
575 doc: /* Return top line of window WINDOW.
576 This is the distance, in lines, between the top of WINDOW and the top
577 of the frame's window area. For instance, the return value is 0 if
578 there is no window above WINDOW.
580 If WINDOW is omitted or nil, it defaults to the selected window. */)
581 (Lisp_Object window)
583 return decode_any_window (window)->top_line;
586 /* Return the number of lines of W's body. Don't count any mode or
587 header line of W. */
589 static int
590 window_body_lines (struct window *w)
592 int height = XFASTINT (w->total_lines);
594 if (!MINI_WINDOW_P (w))
596 if (WINDOW_WANTS_MODELINE_P (w))
597 --height;
598 if (WINDOW_WANTS_HEADER_LINE_P (w))
599 --height;
602 return height;
605 /* Return the number of columns of W's body. Don't count columns
606 occupied by the scroll bar or the vertical bar separating W from its
607 right sibling. On window-systems don't count fringes or display
608 margins either. */
611 window_body_cols (struct window *w)
613 struct frame *f = XFRAME (WINDOW_FRAME (w));
614 int width = XINT (w->total_cols);
616 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
617 /* Scroll bars occupy a few columns. */
618 width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
619 else if (!FRAME_WINDOW_P (f)
620 && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
621 /* The column of `|' characters separating side-by-side windows
622 occupies one column only. */
623 width -= 1;
625 if (FRAME_WINDOW_P (f))
626 /* On window-systems, fringes and display margins cannot be
627 used for normal text. */
628 width -= (WINDOW_FRINGE_COLS (w)
629 + WINDOW_LEFT_MARGIN_COLS (w)
630 + WINDOW_RIGHT_MARGIN_COLS (w));
632 return width;
635 DEFUN ("window-body-height", Fwindow_body_height, Swindow_body_height, 0, 1, 0,
636 doc: /* Return the height, in lines, of WINDOW's text area.
637 If WINDOW is omitted or nil, it defaults to the selected window.
638 Signal an error if the window is not live.
640 The returned height does not include the mode line or header line.
641 On a graphical display, the height is expressed as an integer multiple
642 of the default character height. If a line at the bottom of the text
643 area is only partially visible, that counts as a whole line; to
644 exclude partially-visible lines, use `window-text-height'. */)
645 (Lisp_Object window)
647 struct window *w = decode_window (window);
648 return make_number (window_body_lines (w));
651 DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 1, 0,
652 doc: /* Return the width, in columns, of WINDOW's text area.
653 If WINDOW is omitted or nil, it defaults to the selected window.
654 Signal an error if the window is not live.
656 The return value does not include any vertical dividers, fringe or
657 marginal areas, or scroll bars. On a graphical display, the width is
658 expressed as an integer multiple of the default character width. */)
659 (Lisp_Object window)
661 struct window *w = decode_window (window);
662 return make_number (window_body_cols (w));
665 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
666 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
667 WINDOW must be a live window and defaults to the selected one. */)
668 (Lisp_Object window)
670 return decode_window (window)->hscroll;
673 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
674 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
675 If WINDOW is nil, the selected window is used.
676 Return NCOL. NCOL should be zero or positive.
678 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
679 window so that the location of point moves off-window. */)
680 (Lisp_Object window, Lisp_Object ncol)
682 struct window *w = decode_window (window);
683 int hscroll;
685 CHECK_NUMBER (ncol);
686 hscroll = max (0, XINT (ncol));
688 /* Prevent redisplay shortcuts when changing the hscroll. */
689 if (XINT (w->hscroll) != hscroll)
690 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
692 w->hscroll = make_number (hscroll);
693 return ncol;
696 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
697 Swindow_redisplay_end_trigger, 0, 1, 0,
698 doc: /* Return WINDOW's redisplay end trigger value.
699 WINDOW defaults to the selected window.
700 See `set-window-redisplay-end-trigger' for more information. */)
701 (Lisp_Object window)
703 return decode_window (window)->redisplay_end_trigger;
706 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
707 Sset_window_redisplay_end_trigger, 2, 2, 0,
708 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
709 VALUE should be a buffer position (typically a marker) or nil.
710 If it is a buffer position, then if redisplay in WINDOW reaches a position
711 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
712 with two arguments: WINDOW, and the end trigger value.
713 Afterwards the end-trigger value is reset to nil. */)
714 (register Lisp_Object window, Lisp_Object value)
716 register struct window *w;
718 w = decode_window (window);
719 w->redisplay_end_trigger = value;
720 return value;
723 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
724 doc: /* Return a list of the edge coordinates of WINDOW.
725 The list has the form (LEFT TOP RIGHT BOTTOM).
726 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
727 all relative to 0, 0 at top left corner of frame.
729 RIGHT is one more than the rightmost column occupied by WINDOW.
730 BOTTOM is one more than the bottommost row occupied by WINDOW.
731 The edges include the space used by WINDOW's scroll bar, display
732 margins, fringes, header line, and/or mode line. For the edges of
733 just the text area, use `window-inside-edges'. */)
734 (Lisp_Object window)
736 register struct window *w = decode_any_window (window);
738 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
739 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
740 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
741 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
742 Qnil))));
745 DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
746 doc: /* Return a list of the edge pixel coordinates of WINDOW.
747 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
748 the top left corner of the frame.
750 RIGHT is one more than the rightmost x position occupied by WINDOW.
751 BOTTOM is one more than the bottommost y position occupied by WINDOW.
752 The pixel edges include the space used by WINDOW's scroll bar, display
753 margins, fringes, header line, and/or mode line. For the pixel edges
754 of just the text area, use `window-inside-pixel-edges'. */)
755 (Lisp_Object window)
757 register struct window *w = decode_any_window (window);
759 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
760 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
761 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
762 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
763 Qnil))));
766 static void
767 calc_absolute_offset (struct window *w, int *add_x, int *add_y)
769 struct frame *f = XFRAME (w->frame);
770 *add_y = f->top_pos;
771 #ifdef FRAME_MENUBAR_HEIGHT
772 *add_y += FRAME_MENUBAR_HEIGHT (f);
773 #endif
774 #ifdef FRAME_TOOLBAR_TOP_HEIGHT
775 *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
776 #elif FRAME_TOOLBAR_HEIGHT
777 *add_y += FRAME_TOOLBAR_HEIGHT (f);
778 #endif
779 #ifdef FRAME_NS_TITLEBAR_HEIGHT
780 *add_y += FRAME_NS_TITLEBAR_HEIGHT (f);
781 #endif
782 *add_x = f->left_pos;
783 #ifdef FRAME_TOOLBAR_LEFT_WIDTH
784 *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
785 #endif
788 DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges,
789 Swindow_absolute_pixel_edges, 0, 1, 0,
790 doc: /* Return a list of the edge pixel coordinates of WINDOW.
791 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
792 the top left corner of the display.
794 RIGHT is one more than the rightmost x position occupied by WINDOW.
795 BOTTOM is one more than the bottommost y position occupied by WINDOW.
796 The pixel edges include the space used by WINDOW's scroll bar, display
797 margins, fringes, header line, and/or mode line. For the pixel edges
798 of just the text area, use `window-inside-absolute-pixel-edges'. */)
799 (Lisp_Object window)
801 register struct window *w = decode_any_window (window);
802 int add_x, add_y;
803 calc_absolute_offset (w, &add_x, &add_y);
805 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w) + add_x),
806 Fcons (make_number (WINDOW_TOP_EDGE_Y (w) + add_y),
807 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w) + add_x),
808 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w) + add_y),
809 Qnil))));
812 DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
813 doc: /* Return a list of the edge coordinates of WINDOW.
814 The list has the form (LEFT TOP RIGHT BOTTOM).
815 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
816 all relative to 0, 0 at top left corner of frame.
818 RIGHT is one more than the rightmost column of WINDOW's text area.
819 BOTTOM is one more than the bottommost row of WINDOW's text area.
820 The inside edges do not include the space used by the WINDOW's scroll
821 bar, display margins, fringes, header line, and/or mode line. */)
822 (Lisp_Object window)
824 register struct window *w = decode_window (window);
826 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
827 + WINDOW_LEFT_MARGIN_COLS (w)
828 + WINDOW_LEFT_FRINGE_COLS (w)),
829 make_number (WINDOW_TOP_EDGE_LINE (w)
830 + WINDOW_HEADER_LINE_LINES (w)),
831 make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
832 - WINDOW_RIGHT_MARGIN_COLS (w)
833 - WINDOW_RIGHT_FRINGE_COLS (w)),
834 make_number (WINDOW_BOTTOM_EDGE_LINE (w)
835 - WINDOW_MODE_LINE_LINES (w)));
838 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
839 doc: /* Return a list of the edge pixel coordinates of WINDOW's text area.
840 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to (0,0)
841 at the top left corner of the frame's window area.
843 RIGHT is one more than the rightmost x position of WINDOW's text area.
844 BOTTOM is one more than the bottommost y position of WINDOW's text area.
845 The inside edges do not include the space used by WINDOW's scroll bar,
846 display margins, fringes, header line, and/or mode line. */)
847 (Lisp_Object window)
849 register struct window *w = decode_window (window);
851 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
852 + WINDOW_LEFT_MARGIN_WIDTH (w)
853 + WINDOW_LEFT_FRINGE_WIDTH (w)),
854 make_number (WINDOW_TOP_EDGE_Y (w)
855 + WINDOW_HEADER_LINE_HEIGHT (w)),
856 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
857 - WINDOW_RIGHT_MARGIN_WIDTH (w)
858 - WINDOW_RIGHT_FRINGE_WIDTH (w)),
859 make_number (WINDOW_BOTTOM_EDGE_Y (w)
860 - WINDOW_MODE_LINE_HEIGHT (w)));
863 DEFUN ("window-inside-absolute-pixel-edges",
864 Fwindow_inside_absolute_pixel_edges,
865 Swindow_inside_absolute_pixel_edges, 0, 1, 0,
866 doc: /* Return a list of the edge pixel coordinates of WINDOW's text area.
867 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to (0,0)
868 at the top left corner of the frame's window area.
870 RIGHT is one more than the rightmost x position of WINDOW's text area.
871 BOTTOM is one more than the bottommost y position of WINDOW's text area.
872 The inside edges do not include the space used by WINDOW's scroll bar,
873 display margins, fringes, header line, and/or mode line. */)
874 (Lisp_Object window)
876 register struct window *w = decode_window (window);
877 int add_x, add_y;
878 calc_absolute_offset (w, &add_x, &add_y);
880 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
881 + WINDOW_LEFT_MARGIN_WIDTH (w)
882 + WINDOW_LEFT_FRINGE_WIDTH (w) + add_x),
883 make_number (WINDOW_TOP_EDGE_Y (w)
884 + WINDOW_HEADER_LINE_HEIGHT (w) + add_y),
885 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
886 - WINDOW_RIGHT_MARGIN_WIDTH (w)
887 - WINDOW_RIGHT_FRINGE_WIDTH (w) + add_x),
888 make_number (WINDOW_BOTTOM_EDGE_Y (w)
889 - WINDOW_MODE_LINE_HEIGHT (w) + add_y));
892 /* Test if the character at column X, row Y is within window W.
893 If it is not, return ON_NOTHING;
894 if it is in the window's text area, return ON_TEXT;
895 if it is on the window's modeline, return ON_MODE_LINE;
896 if it is on the border between the window and its right sibling,
897 return ON_VERTICAL_BORDER.
898 if it is on a scroll bar, return ON_SCROLL_BAR.
899 if it is on the window's top line, return ON_HEADER_LINE;
900 if it is in left or right fringe of the window,
901 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
902 if it is in the marginal area to the left/right of the window,
903 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
905 X and Y are frame relative pixel coordinates. */
907 static enum window_part
908 coordinates_in_window (register struct window *w, int x, int y)
910 struct frame *f = XFRAME (WINDOW_FRAME (w));
911 enum window_part part;
912 int ux = FRAME_COLUMN_WIDTH (f);
913 int left_x = WINDOW_LEFT_EDGE_X (w);
914 int right_x = WINDOW_RIGHT_EDGE_X (w);
915 int top_y = WINDOW_TOP_EDGE_Y (w);
916 int bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
917 /* The width of the area where the vertical line can be dragged.
918 (Between mode lines for instance. */
919 int grabbable_width = ux;
920 int lmargin_width, rmargin_width, text_left, text_right;
922 /* Outside any interesting row or column? */
923 if (y < top_y || y >= bottom_y || x < left_x || x >= right_x)
924 return ON_NOTHING;
926 /* On the mode line or header line? */
927 if ((WINDOW_WANTS_MODELINE_P (w)
928 && y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w)
929 && (part = ON_MODE_LINE))
930 || (WINDOW_WANTS_HEADER_LINE_P (w)
931 && y < top_y + CURRENT_HEADER_LINE_HEIGHT (w)
932 && (part = ON_HEADER_LINE)))
934 /* If it's under/over the scroll bar portion of the mode/header
935 line, say it's on the vertical line. That's to be able to
936 resize windows horizontally in case we're using toolkit scroll
937 bars. Note: If scrollbars are on the left, the window that
938 must be eventually resized is that on the left of WINDOW. */
939 if ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
940 && !WINDOW_LEFTMOST_P (w)
941 && eabs (x - left_x) < grabbable_width)
942 || (!WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
943 && !WINDOW_RIGHTMOST_P (w)
944 && eabs (x - right_x) < grabbable_width))
945 return ON_VERTICAL_BORDER;
946 else
947 return part;
950 /* In what's below, we subtract 1 when computing right_x because we
951 want the rightmost pixel, which is given by left_pixel+width-1. */
952 if (w->pseudo_window_p)
954 left_x = 0;
955 right_x = WINDOW_TOTAL_WIDTH (w) - 1;
957 else
959 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
960 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
963 /* Outside any interesting column? */
964 if (x < left_x || x > right_x)
965 return ON_SCROLL_BAR;
967 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
968 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
970 text_left = window_box_left (w, TEXT_AREA);
971 text_right = text_left + window_box_width (w, TEXT_AREA);
973 if (FRAME_WINDOW_P (f))
975 if (!w->pseudo_window_p
976 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
977 && !WINDOW_RIGHTMOST_P (w)
978 && (eabs (x - right_x) < grabbable_width))
979 return ON_VERTICAL_BORDER;
981 /* Need to say "x > right_x" rather than >=, since on character
982 terminals, the vertical line's x coordinate is right_x. */
983 else if (!w->pseudo_window_p
984 && !WINDOW_RIGHTMOST_P (w)
985 && x > right_x - ux)
986 return ON_VERTICAL_BORDER;
988 if (x < text_left)
990 if (lmargin_width > 0
991 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
992 ? (x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
993 : (x < left_x + lmargin_width)))
994 return ON_LEFT_MARGIN;
996 return ON_LEFT_FRINGE;
999 if (x >= text_right)
1001 if (rmargin_width > 0
1002 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1003 ? (x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
1004 : (x >= right_x - rmargin_width)))
1005 return ON_RIGHT_MARGIN;
1007 return ON_RIGHT_FRINGE;
1010 /* Everything special ruled out - must be on text area */
1011 return ON_TEXT;
1014 /* Take X is the frame-relative pixel x-coordinate, and return the
1015 x-coordinate relative to part PART of window W. */
1017 window_relative_x_coord (struct window *w, enum window_part part, int x)
1019 int left_x = (w->pseudo_window_p) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w);
1021 switch (part)
1023 case ON_TEXT:
1024 return x - window_box_left (w, TEXT_AREA);
1026 case ON_LEFT_FRINGE:
1027 return x - left_x;
1029 case ON_RIGHT_FRINGE:
1030 return x - left_x - WINDOW_LEFT_FRINGE_WIDTH (w);
1032 case ON_LEFT_MARGIN:
1033 return (x - left_x
1034 - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1035 ? WINDOW_LEFT_FRINGE_WIDTH (w) : 0));
1037 case ON_RIGHT_MARGIN:
1038 return (x + 1
1039 - ((w->pseudo_window_p)
1040 ? WINDOW_TOTAL_WIDTH (w)
1041 : WINDOW_BOX_RIGHT_EDGE_X (w))
1042 + window_box_width (w, RIGHT_MARGIN_AREA)
1043 + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1044 ? WINDOW_RIGHT_FRINGE_WIDTH (w) : 0));
1047 /* ON_SCROLL_BAR, ON_NOTHING, and ON_VERTICAL_BORDER: */
1048 return 0;
1052 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
1053 Scoordinates_in_window_p, 2, 2, 0,
1054 doc: /* Return non-nil if COORDINATES are in WINDOW.
1055 WINDOW must be a live window.
1056 COORDINATES is a cons of the form (X . Y), X and Y being distances
1057 measured in characters from the upper-left corner of the frame.
1058 \(0 . 0) denotes the character in the upper left corner of the
1059 frame.
1060 If COORDINATES are in the text portion of WINDOW,
1061 the coordinates relative to the window are returned.
1062 If they are in the mode line of WINDOW, `mode-line' is returned.
1063 If they are in the top mode line of WINDOW, `header-line' is returned.
1064 If they are in the left fringe of WINDOW, `left-fringe' is returned.
1065 If they are in the right fringe of WINDOW, `right-fringe' is returned.
1066 If they are on the border between WINDOW and its right sibling,
1067 `vertical-line' is returned.
1068 If they are in the windows's left or right marginal areas, `left-margin'\n\
1069 or `right-margin' is returned. */)
1070 (register Lisp_Object coordinates, Lisp_Object window)
1072 struct window *w;
1073 struct frame *f;
1074 int x, y;
1075 Lisp_Object lx, ly;
1077 CHECK_LIVE_WINDOW (window);
1078 w = XWINDOW (window);
1079 f = XFRAME (w->frame);
1080 CHECK_CONS (coordinates);
1081 lx = Fcar (coordinates);
1082 ly = Fcdr (coordinates);
1083 CHECK_NUMBER_OR_FLOAT (lx);
1084 CHECK_NUMBER_OR_FLOAT (ly);
1085 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
1086 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
1088 switch (coordinates_in_window (w, x, y))
1090 case ON_NOTHING:
1091 return Qnil;
1093 case ON_TEXT:
1094 /* Convert X and Y to window relative pixel coordinates, and
1095 return the canonical char units. */
1096 x -= window_box_left (w, TEXT_AREA);
1097 y -= WINDOW_TOP_EDGE_Y (w);
1098 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
1099 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
1101 case ON_MODE_LINE:
1102 return Qmode_line;
1104 case ON_VERTICAL_BORDER:
1105 return Qvertical_line;
1107 case ON_HEADER_LINE:
1108 return Qheader_line;
1110 case ON_LEFT_FRINGE:
1111 return Qleft_fringe;
1113 case ON_RIGHT_FRINGE:
1114 return Qright_fringe;
1116 case ON_LEFT_MARGIN:
1117 return Qleft_margin;
1119 case ON_RIGHT_MARGIN:
1120 return Qright_margin;
1122 case ON_SCROLL_BAR:
1123 /* Historically we are supposed to return nil in this case. */
1124 return Qnil;
1126 default:
1127 abort ();
1132 /* Callback for foreach_window, used in window_from_coordinates.
1133 Check if window W contains coordinates specified by USER_DATA which
1134 is actually a pointer to a struct check_window_data CW.
1136 Check if window W contains coordinates *CW->x and *CW->y. If it
1137 does, return W in *CW->window, as Lisp_Object, and return in
1138 *CW->part the part of the window under coordinates *X,*Y. Return
1139 zero from this function to stop iterating over windows. */
1141 struct check_window_data
1143 Lisp_Object *window;
1144 int x, y;
1145 enum window_part *part;
1148 static int
1149 check_window_containing (struct window *w, void *user_data)
1151 struct check_window_data *cw = (struct check_window_data *) user_data;
1152 enum window_part found;
1153 int continue_p = 1;
1155 found = coordinates_in_window (w, cw->x, cw->y);
1156 if (found != ON_NOTHING)
1158 *cw->part = found;
1159 XSETWINDOW (*cw->window, w);
1160 continue_p = 0;
1163 return continue_p;
1167 /* Find the window containing frame-relative pixel position X/Y and
1168 return it as a Lisp_Object.
1170 If X, Y is on one of the window's special `window_part' elements,
1171 set *PART to the id of that element.
1173 If there is no window under X, Y return nil and leave *PART
1174 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1176 This function was previously implemented with a loop cycling over
1177 windows with Fnext_window, and starting with the frame's selected
1178 window. It turned out that this doesn't work with an
1179 implementation of next_window using Vwindow_list, because
1180 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1181 tree of F when this function is called asynchronously from
1182 note_mouse_highlight. The original loop didn't terminate in this
1183 case. */
1185 Lisp_Object
1186 window_from_coordinates (struct frame *f, int x, int y,
1187 enum window_part *part, int tool_bar_p)
1189 Lisp_Object window;
1190 struct check_window_data cw;
1191 enum window_part dummy;
1193 if (part == 0)
1194 part = &dummy;
1196 window = Qnil;
1197 cw.window = &window, cw.x = x, cw.y = y; cw.part = part;
1198 foreach_window (f, check_window_containing, &cw);
1200 /* If not found above, see if it's in the tool bar window, if a tool
1201 bar exists. */
1202 if (NILP (window)
1203 && tool_bar_p
1204 && WINDOWP (f->tool_bar_window)
1205 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1206 && (coordinates_in_window (XWINDOW (f->tool_bar_window), x, y)
1207 != ON_NOTHING))
1209 *part = ON_TEXT;
1210 window = f->tool_bar_window;
1213 return window;
1216 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1217 doc: /* Return window containing coordinates X and Y on FRAME.
1218 FRAME must be a live frame and defaults to the selected one.
1219 The top left corner of the frame is considered to be row 0,
1220 column 0. */)
1221 (Lisp_Object x, Lisp_Object y, Lisp_Object frame)
1223 struct frame *f;
1225 if (NILP (frame))
1226 frame = selected_frame;
1227 CHECK_LIVE_FRAME (frame);
1228 f = XFRAME (frame);
1230 /* Check that arguments are integers or floats. */
1231 CHECK_NUMBER_OR_FLOAT (x);
1232 CHECK_NUMBER_OR_FLOAT (y);
1234 return window_from_coordinates (f,
1235 (FRAME_PIXEL_X_FROM_CANON_X (f, x)
1236 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1237 (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
1238 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1239 0, 0);
1242 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1243 doc: /* Return current value of point in WINDOW.
1244 WINDOW must be a live window and defaults to the selected one.
1246 For a nonselected window, this is the value point would have
1247 if that window were selected.
1249 Note that, when WINDOW is the selected window and its buffer
1250 is also currently selected, the value returned is the same as (point).
1251 It would be more strictly correct to return the `top-level' value
1252 of point, outside of any save-excursion forms.
1253 But that is hard to define. */)
1254 (Lisp_Object window)
1256 register struct window *w = decode_window (window);
1258 if (w == XWINDOW (selected_window)
1259 && current_buffer == XBUFFER (w->buffer))
1260 return Fpoint ();
1261 return Fmarker_position (w->pointm);
1264 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1265 doc: /* Return position at which display currently starts in WINDOW.
1266 WINDOW must be a live window and defaults to the selected one.
1267 This is updated by redisplay or by calling `set-window-start'. */)
1268 (Lisp_Object window)
1270 return Fmarker_position (decode_window (window)->start);
1273 /* This is text temporarily removed from the doc string below.
1275 This function returns nil if the position is not currently known.
1276 That happens when redisplay is preempted and doesn't finish.
1277 If in that case you want to compute where the end of the window would
1278 have been if redisplay had finished, do this:
1279 (save-excursion
1280 (goto-char (window-start window))
1281 (vertical-motion (1- (window-height window)) window)
1282 (point))") */
1284 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1285 doc: /* Return position at which display currently ends in WINDOW.
1286 WINDOW must be a live window and defaults to the selected one.
1287 This is updated by redisplay, when it runs to completion.
1288 Simply changing the buffer text or setting `window-start'
1289 does not update this value.
1290 Return nil if there is no recorded value. (This can happen if the
1291 last redisplay of WINDOW was preempted, and did not finish.)
1292 If UPDATE is non-nil, compute the up-to-date position
1293 if it isn't already recorded. */)
1294 (Lisp_Object window, Lisp_Object update)
1296 Lisp_Object value;
1297 struct window *w = decode_window (window);
1298 Lisp_Object buf;
1299 struct buffer *b;
1301 buf = w->buffer;
1302 CHECK_BUFFER (buf);
1303 b = XBUFFER (buf);
1305 #if 0 /* This change broke some things. We should make it later. */
1306 /* If we don't know the end position, return nil.
1307 The user can compute it with vertical-motion if he wants to.
1308 It would be nicer to do it automatically,
1309 but that's so slow that it would probably bother people. */
1310 if (NILP (w->window_end_valid))
1311 return Qnil;
1312 #endif
1314 if (! NILP (update)
1315 && ! (! NILP (w->window_end_valid)
1316 && XFASTINT (w->last_modified) >= BUF_MODIFF (b)
1317 && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (b))
1318 && !noninteractive)
1320 struct text_pos startp;
1321 struct it it;
1322 struct buffer *old_buffer = NULL;
1323 void *itdata = NULL;
1325 /* Cannot use Fvertical_motion because that function doesn't
1326 cope with variable-height lines. */
1327 if (b != current_buffer)
1329 old_buffer = current_buffer;
1330 set_buffer_internal (b);
1333 /* In case W->start is out of the range, use something
1334 reasonable. This situation occurred when loading a file with
1335 `-l' containing a call to `rmail' with subsequent other
1336 commands. At the end, W->start happened to be BEG, while
1337 rmail had already narrowed the buffer. */
1338 if (XMARKER (w->start)->charpos < BEGV)
1339 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1340 else if (XMARKER (w->start)->charpos > ZV)
1341 SET_TEXT_POS (startp, ZV, ZV_BYTE);
1342 else
1343 SET_TEXT_POS_FROM_MARKER (startp, w->start);
1345 itdata = bidi_shelve_cache ();
1346 start_display (&it, w, startp);
1347 move_it_vertically (&it, window_box_height (w));
1348 if (it.current_y < it.last_visible_y)
1349 move_it_past_eol (&it);
1350 value = make_number (IT_CHARPOS (it));
1351 bidi_unshelve_cache (itdata, 0);
1353 if (old_buffer)
1354 set_buffer_internal (old_buffer);
1356 else
1357 XSETINT (value, BUF_Z (b) - XFASTINT (w->window_end_pos));
1359 return value;
1362 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1363 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1364 Return POS. */)
1365 (Lisp_Object window, Lisp_Object pos)
1367 register struct window *w = decode_window (window);
1369 CHECK_NUMBER_COERCE_MARKER (pos);
1370 if (w == XWINDOW (selected_window)
1371 && XBUFFER (w->buffer) == current_buffer)
1372 Fgoto_char (pos);
1373 else
1374 set_marker_restricted (w->pointm, pos, w->buffer);
1376 /* We have to make sure that redisplay updates the window to show
1377 the new value of point. */
1378 if (!EQ (window, selected_window))
1379 ++windows_or_buffers_changed;
1381 return pos;
1384 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1385 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1386 If WINDOW is nil, the selected window is used. Return POS.
1387 Optional third arg NOFORCE non-nil inhibits next redisplay from
1388 overriding motion of point in order to display at this exact start. */)
1389 (Lisp_Object window, Lisp_Object pos, Lisp_Object noforce)
1391 register struct window *w = decode_window (window);
1393 CHECK_NUMBER_COERCE_MARKER (pos);
1394 set_marker_restricted (w->start, pos, w->buffer);
1395 /* this is not right, but much easier than doing what is right. */
1396 w->start_at_line_beg = Qnil;
1397 if (NILP (noforce))
1398 w->force_start = Qt;
1399 w->update_mode_line = Qt;
1400 XSETFASTINT (w->last_modified, 0);
1401 XSETFASTINT (w->last_overlay_modified, 0);
1402 if (!EQ (window, selected_window))
1403 windows_or_buffers_changed++;
1405 return pos;
1408 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
1409 Spos_visible_in_window_p, 0, 3, 0,
1410 doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
1411 Return nil if that position is scrolled vertically out of view.
1412 If a character is only partially visible, nil is returned, unless the
1413 optional argument PARTIALLY is non-nil.
1414 If POS is only out of view because of horizontal scrolling, return non-nil.
1415 If POS is t, it specifies the position of the last visible glyph in WINDOW.
1416 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
1418 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
1419 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
1420 where X and Y are the pixel coordinates relative to the top left corner
1421 of the window. The remaining elements are omitted if the character after
1422 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
1423 off-window at the top and bottom of the row, ROWH is the height of the
1424 display row, and VPOS is the row number (0-based) containing POS. */)
1425 (Lisp_Object pos, Lisp_Object window, Lisp_Object partially)
1427 register struct window *w;
1428 register EMACS_INT posint;
1429 register struct buffer *buf;
1430 struct text_pos top;
1431 Lisp_Object in_window = Qnil;
1432 int rtop, rbot, rowh, vpos, fully_p = 1;
1433 int x, y;
1435 w = decode_window (window);
1436 buf = XBUFFER (w->buffer);
1437 SET_TEXT_POS_FROM_MARKER (top, w->start);
1439 if (EQ (pos, Qt))
1440 posint = -1;
1441 else if (!NILP (pos))
1443 CHECK_NUMBER_COERCE_MARKER (pos);
1444 posint = XINT (pos);
1446 else if (w == XWINDOW (selected_window))
1447 posint = PT;
1448 else
1449 posint = XMARKER (w->pointm)->charpos;
1451 /* If position is above window start or outside buffer boundaries,
1452 or if window start is out of range, position is not visible. */
1453 if ((EQ (pos, Qt)
1454 || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
1455 && CHARPOS (top) >= BUF_BEGV (buf)
1456 && CHARPOS (top) <= BUF_ZV (buf)
1457 && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
1458 && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
1459 in_window = Qt;
1461 if (!NILP (in_window) && !NILP (partially))
1463 Lisp_Object part = Qnil;
1464 if (!fully_p)
1465 part = list4 (make_number (rtop), make_number (rbot),
1466 make_number (rowh), make_number (vpos));
1467 in_window = Fcons (make_number (x),
1468 Fcons (make_number (y), part));
1471 return in_window;
1474 DEFUN ("window-line-height", Fwindow_line_height,
1475 Swindow_line_height, 0, 2, 0,
1476 doc: /* Return height in pixels of text line LINE in window WINDOW.
1477 WINDOW defaults to the selected window.
1479 Return height of current line if LINE is omitted or nil. Return height of
1480 header or mode line if LINE is `header-line' or `mode-line'.
1481 Otherwise, LINE is a text line number starting from 0. A negative number
1482 counts from the end of the window.
1484 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
1485 in pixels of the visible part of the line, VPOS and YPOS are the
1486 vertical position in lines and pixels of the line, relative to the top
1487 of the first text line, and OFFBOT is the number of off-window pixels at
1488 the bottom of the text line. If there are off-window pixels at the top
1489 of the (first) text line, YPOS is negative.
1491 Return nil if window display is not up-to-date. In that case, use
1492 `pos-visible-in-window-p' to obtain the information. */)
1493 (Lisp_Object line, Lisp_Object window)
1495 register struct window *w;
1496 register struct buffer *b;
1497 struct glyph_row *row, *end_row;
1498 int max_y, crop, i, n;
1500 w = decode_window (window);
1502 if (noninteractive || w->pseudo_window_p)
1503 return Qnil;
1505 CHECK_BUFFER (w->buffer);
1506 b = XBUFFER (w->buffer);
1508 /* Fail if current matrix is not up-to-date. */
1509 if (NILP (w->window_end_valid)
1510 || current_buffer->clip_changed
1511 || current_buffer->prevent_redisplay_optimizations_p
1512 || XFASTINT (w->last_modified) < BUF_MODIFF (b)
1513 || XFASTINT (w->last_overlay_modified) < BUF_OVERLAY_MODIFF (b))
1514 return Qnil;
1516 if (NILP (line))
1518 i = w->cursor.vpos;
1519 if (i < 0 || i >= w->current_matrix->nrows
1520 || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
1521 return Qnil;
1522 max_y = window_text_bottom_y (w);
1523 goto found_row;
1526 if (EQ (line, Qheader_line))
1528 if (!WINDOW_WANTS_HEADER_LINE_P (w))
1529 return Qnil;
1530 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
1531 if (!row->enabled_p)
1532 return Qnil;
1533 return list4 (make_number (row->height),
1534 make_number (0), make_number (0),
1535 make_number (0));
1538 if (EQ (line, Qmode_line))
1540 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
1541 if (!row->enabled_p)
1542 return Qnil;
1543 return list4 (make_number (row->height),
1544 make_number (0), /* not accurate */
1545 make_number (WINDOW_HEADER_LINE_HEIGHT (w)
1546 + window_text_bottom_y (w)),
1547 make_number (0));
1550 CHECK_NUMBER (line);
1551 n = XINT (line);
1553 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
1554 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
1555 max_y = window_text_bottom_y (w);
1556 i = 0;
1558 while ((n < 0 || i < n)
1559 && row <= end_row && row->enabled_p
1560 && row->y + row->height < max_y)
1561 row++, i++;
1563 if (row > end_row || !row->enabled_p)
1564 return Qnil;
1566 if (++n < 0)
1568 if (-n > i)
1569 return Qnil;
1570 row += n;
1571 i += n;
1574 found_row:
1575 crop = max (0, (row->y + row->height) - max_y);
1576 return list4 (make_number (row->height + min (0, row->y) - crop),
1577 make_number (i),
1578 make_number (row->y),
1579 make_number (crop));
1582 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1583 0, 1, 0,
1584 doc: /* Return non-nil when WINDOW is dedicated to its buffer.
1585 More precisely, return the value assigned by the last call of
1586 `set-window-dedicated-p' for WINDOW. Return nil if that function was
1587 never called with WINDOW as its argument, or the value set by that
1588 function was internally reset since its last call. WINDOW defaults to
1589 the selected window.
1591 When a window is dedicated to its buffer, `display-buffer' will refrain
1592 from displaying another buffer in it. `get-lru-window' and
1593 `get-largest-window' treat dedicated windows specially.
1594 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1595 `kill-buffer' can delete a dedicated window and the containing frame.
1597 Functions like `set-window-buffer' may change the buffer displayed by a
1598 window, unless that window is "strongly" dedicated to its buffer, that
1599 is the value returned by `window-dedicated-p' is t. */)
1600 (Lisp_Object window)
1602 return decode_window (window)->dedicated;
1605 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1606 Sset_window_dedicated_p, 2, 2, 0,
1607 doc: /* Mark WINDOW as dedicated according to FLAG.
1608 WINDOW must be a live window and defaults to the selected one. FLAG
1609 non-nil means mark WINDOW as dedicated to its buffer. FLAG nil means
1610 mark WINDOW as non-dedicated. Return FLAG.
1612 When a window is dedicated to its buffer, `display-buffer' will refrain
1613 from displaying another buffer in it. `get-lru-window' and
1614 `get-largest-window' treat dedicated windows specially.
1615 `delete-windows-on', `replace-buffer-in-windows', `quit-window',
1616 `quit-restore-window' and `kill-buffer' can delete a dedicated window
1617 and the containing frame.
1619 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
1620 its buffer. Functions like `set-window-buffer' may change the buffer
1621 displayed by a window, unless that window is strongly dedicated to its
1622 buffer. If and when `set-window-buffer' displays another buffer in a
1623 window, it also makes sure that the window is no more dedicated. */)
1624 (Lisp_Object window, Lisp_Object flag)
1626 register struct window *w = decode_window (window);
1628 w->dedicated = flag;
1629 return w->dedicated;
1632 DEFUN ("window-prev-buffers", Fwindow_prev_buffers, Swindow_prev_buffers,
1633 0, 1, 0,
1634 doc: /* Return buffers previously shown in WINDOW.
1635 WINDOW must be a live window and defaults to the selected one.
1637 The return value is a list of elements (BUFFER WINDOW-START POS),
1638 where BUFFER is a buffer, WINDOW-START is the start position of the
1639 window for that buffer, and POS is a window-specific point value. */)
1640 (Lisp_Object window)
1642 return decode_window (window)->prev_buffers;
1645 DEFUN ("set-window-prev-buffers", Fset_window_prev_buffers,
1646 Sset_window_prev_buffers, 2, 2, 0,
1647 doc: /* Set WINDOW's previous buffers to PREV-BUFFERS.
1648 WINDOW must be a live window and defaults to the selected one.
1650 PREV-BUFFERS should be a list of elements (BUFFER WINDOW-START POS),
1651 where BUFFER is a buffer, WINDOW-START is the start position of the
1652 window for that buffer, and POS is a window-specific point value. */)
1653 (Lisp_Object window, Lisp_Object prev_buffers)
1655 return decode_window (window)->prev_buffers = prev_buffers;
1658 DEFUN ("window-next-buffers", Fwindow_next_buffers, Swindow_next_buffers,
1659 0, 1, 0,
1660 doc: /* Return list of buffers recently re-shown in WINDOW.
1661 WINDOW must be a live window and defaults to the selected one. */)
1662 (Lisp_Object window)
1664 return decode_window (window)->next_buffers;
1667 DEFUN ("set-window-next-buffers", Fset_window_next_buffers,
1668 Sset_window_next_buffers, 2, 2, 0,
1669 doc: /* Set WINDOW's next buffers to NEXT-BUFFERS.
1670 WINDOW must be a live window and defaults to the selected one.
1671 NEXT-BUFFERS should be a list of buffers. */)
1672 (Lisp_Object window, Lisp_Object next_buffers)
1674 return decode_window (window)->next_buffers = next_buffers;
1677 DEFUN ("window-parameters", Fwindow_parameters, Swindow_parameters,
1678 0, 1, 0,
1679 doc: /* Return the parameters of WINDOW and their values.
1680 WINDOW defaults to the selected window. The return value is a list of
1681 elements of the form (PARAMETER . VALUE). */)
1682 (Lisp_Object window)
1684 return Fcopy_alist (decode_any_window (window)->window_parameters);
1687 DEFUN ("window-parameter", Fwindow_parameter, Swindow_parameter,
1688 2, 2, 0,
1689 doc: /* Return WINDOW's value for PARAMETER.
1690 WINDOW defaults to the selected window. */)
1691 (Lisp_Object window, Lisp_Object parameter)
1693 Lisp_Object result;
1695 result = Fassq (parameter, decode_any_window (window)->window_parameters);
1696 return CDR_SAFE (result);
1699 DEFUN ("set-window-parameter", Fset_window_parameter,
1700 Sset_window_parameter, 3, 3, 0,
1701 doc: /* Set WINDOW's value of PARAMETER to VALUE.
1702 WINDOW defaults to the selected window. Return VALUE. */)
1703 (Lisp_Object window, Lisp_Object parameter, Lisp_Object value)
1705 register struct window *w = decode_any_window (window);
1706 Lisp_Object old_alist_elt;
1708 old_alist_elt = Fassq (parameter, w->window_parameters);
1709 if (NILP (old_alist_elt))
1710 w->window_parameters = Fcons (Fcons (parameter, value), w->window_parameters);
1711 else
1712 Fsetcdr (old_alist_elt, value);
1713 return value;
1716 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1717 0, 1, 0,
1718 doc: /* Return the display-table that WINDOW is using.
1719 WINDOW defaults to the selected window. */)
1720 (Lisp_Object window)
1722 return decode_window (window)->display_table;
1725 /* Get the display table for use on window W. This is either W's
1726 display table or W's buffer's display table. Ignore the specified
1727 tables if they are not valid; if no valid table is specified,
1728 return 0. */
1730 struct Lisp_Char_Table *
1731 window_display_table (struct window *w)
1733 struct Lisp_Char_Table *dp = NULL;
1735 if (DISP_TABLE_P (w->display_table))
1736 dp = XCHAR_TABLE (w->display_table);
1737 else if (BUFFERP (w->buffer))
1739 struct buffer *b = XBUFFER (w->buffer);
1741 if (DISP_TABLE_P (BVAR (b, display_table)))
1742 dp = XCHAR_TABLE (BVAR (b, display_table));
1743 else if (DISP_TABLE_P (Vstandard_display_table))
1744 dp = XCHAR_TABLE (Vstandard_display_table);
1747 return dp;
1750 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1751 doc: /* Set WINDOW's display-table to TABLE. */)
1752 (register Lisp_Object window, Lisp_Object table)
1754 register struct window *w;
1756 w = decode_window (window);
1757 w->display_table = table;
1758 return table;
1761 /* Record info on buffer window W is displaying
1762 when it is about to cease to display that buffer. */
1763 static void
1764 unshow_buffer (register struct window *w)
1766 Lisp_Object buf;
1767 struct buffer *b;
1769 buf = w->buffer;
1770 b = XBUFFER (buf);
1771 if (b != XMARKER (w->pointm)->buffer)
1772 abort ();
1774 #if 0
1775 if (w == XWINDOW (selected_window)
1776 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1777 /* Do this except when the selected window's buffer
1778 is being removed from some other window. */
1779 #endif
1780 /* last_window_start records the start position that this buffer
1781 had in the last window to be disconnected from it.
1782 Now that this statement is unconditional,
1783 it is possible for the buffer to be displayed in the
1784 selected window, while last_window_start reflects another
1785 window which was recently showing the same buffer.
1786 Some people might say that might be a good thing. Let's see. */
1787 b->last_window_start = marker_position (w->start);
1789 /* Point in the selected window's buffer
1790 is actually stored in that buffer, and the window's pointm isn't used.
1791 So don't clobber point in that buffer. */
1792 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1793 /* This line helps to fix Horsley's testbug.el bug. */
1794 && !(WINDOWP (BVAR (b, last_selected_window))
1795 && w != XWINDOW (BVAR (b, last_selected_window))
1796 && EQ (buf, XWINDOW (BVAR (b, last_selected_window))->buffer)))
1797 temp_set_point_both (b,
1798 clip_to_bounds (BUF_BEGV (b),
1799 XMARKER (w->pointm)->charpos,
1800 BUF_ZV (b)),
1801 clip_to_bounds (BUF_BEGV_BYTE (b),
1802 marker_byte_position (w->pointm),
1803 BUF_ZV_BYTE (b)));
1805 if (WINDOWP (BVAR (b, last_selected_window))
1806 && w == XWINDOW (BVAR (b, last_selected_window)))
1807 BVAR (b, last_selected_window) = Qnil;
1810 /* Put NEW into the window structure in place of OLD. SETFLAG zero
1811 means change window structure only. Otherwise store geometry and
1812 other settings as well. */
1813 static void
1814 replace_window (Lisp_Object old, Lisp_Object new, int setflag)
1816 register Lisp_Object tem;
1817 register struct window *o = XWINDOW (old), *n = XWINDOW (new);
1819 /* If OLD is its frame's root window, then NEW is the new
1820 root window for that frame. */
1821 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1822 FRAME_ROOT_WINDOW (XFRAME (o->frame)) = new;
1824 if (setflag)
1826 n->left_col = o->left_col;
1827 n->top_line = o->top_line;
1828 n->total_cols = o->total_cols;
1829 n->total_lines = o->total_lines;
1830 n->normal_cols = o->normal_cols;
1831 o->normal_cols = make_float (1.0);
1832 n->normal_lines = o->normal_lines;
1833 o->normal_lines = make_float (1.0);
1834 n->desired_matrix = n->current_matrix = 0;
1835 n->vscroll = 0;
1836 memset (&n->cursor, 0, sizeof (n->cursor));
1837 memset (&n->last_cursor, 0, sizeof (n->last_cursor));
1838 memset (&n->phys_cursor, 0, sizeof (n->phys_cursor));
1839 n->phys_cursor_type = -1;
1840 n->phys_cursor_width = -1;
1841 n->must_be_updated_p = 0;
1842 n->pseudo_window_p = 0;
1843 XSETFASTINT (n->window_end_vpos, 0);
1844 XSETFASTINT (n->window_end_pos, 0);
1845 n->window_end_valid = Qnil;
1846 n->frozen_window_start_p = 0;
1849 n->next = tem = o->next;
1850 if (!NILP (tem))
1851 XWINDOW (tem)->prev = new;
1853 n->prev = tem = o->prev;
1854 if (!NILP (tem))
1855 XWINDOW (tem)->next = new;
1857 n->parent = tem = o->parent;
1858 if (!NILP (tem))
1860 if (EQ (XWINDOW (tem)->vchild, old))
1861 XWINDOW (tem)->vchild = new;
1862 if (EQ (XWINDOW (tem)->hchild, old))
1863 XWINDOW (tem)->hchild = new;
1867 /* If window WINDOW and its parent window are iso-combined, merge
1868 WINDOW's children into those of its parent window and mark WINDOW as
1869 deleted. */
1871 static void
1872 recombine_windows (Lisp_Object window)
1874 struct window *w, *p, *c;
1875 Lisp_Object parent, child;
1876 int horflag;
1878 w = XWINDOW (window);
1879 parent = w->parent;
1880 if (!NILP (parent) && NILP (w->combination_limit))
1882 p = XWINDOW (parent);
1883 if (((!NILP (p->vchild) && !NILP (w->vchild))
1884 || (!NILP (p->hchild) && !NILP (w->hchild))))
1885 /* WINDOW and PARENT are both either a vertical or a horizontal
1886 combination. */
1888 horflag = NILP (w->vchild);
1889 child = horflag ? w->hchild : w->vchild;
1890 c = XWINDOW (child);
1892 /* Splice WINDOW's children into its parent's children and
1893 assign new normal sizes. */
1894 if (NILP (w->prev))
1895 if (horflag)
1896 p->hchild = child;
1897 else
1898 p->vchild = child;
1899 else
1901 c->prev = w->prev;
1902 XWINDOW (w->prev)->next = child;
1905 while (c)
1907 c->parent = parent;
1909 if (horflag)
1910 c->normal_cols
1911 = make_float (XFLOATINT (c->total_cols)
1912 / XFLOATINT (p->total_cols));
1913 else
1914 c->normal_lines
1915 = make_float (XFLOATINT (c->total_lines)
1916 / XFLOATINT (p->total_lines));
1918 if (NILP (c->next))
1920 if (!NILP (w->next))
1922 c->next = w->next;
1923 XWINDOW (c->next)->prev = child;
1926 c = 0;
1928 else
1930 child = c->next;
1931 c = XWINDOW (child);
1935 /* WINDOW can be deleted now. */
1936 w->vchild = w->hchild = Qnil;
1941 /* If WINDOW can be deleted, delete it. */
1942 static void
1943 delete_deletable_window (Lisp_Object window)
1945 if (!NILP (call1 (Qwindow_deletable_p, window)))
1946 call1 (Qdelete_window, window);
1949 /***********************************************************************
1950 Window List
1951 ***********************************************************************/
1953 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1954 pointer. This is a callback function for foreach_window, used in
1955 the window_list function. */
1957 static int
1958 add_window_to_list (struct window *w, void *user_data)
1960 Lisp_Object *list = (Lisp_Object *) user_data;
1961 Lisp_Object window;
1962 XSETWINDOW (window, w);
1963 *list = Fcons (window, *list);
1964 return 1;
1968 /* Return a list of all windows, for use by next_window. If
1969 Vwindow_list is a list, return that list. Otherwise, build a new
1970 list, cache it in Vwindow_list, and return that. */
1972 static Lisp_Object
1973 window_list (void)
1975 if (!CONSP (Vwindow_list))
1977 Lisp_Object tail;
1979 Vwindow_list = Qnil;
1980 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1982 Lisp_Object args[2];
1984 /* We are visiting windows in canonical order, and add
1985 new windows at the front of args[1], which means we
1986 have to reverse this list at the end. */
1987 args[1] = Qnil;
1988 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
1989 args[0] = Vwindow_list;
1990 args[1] = Fnreverse (args[1]);
1991 Vwindow_list = Fnconc (2, args);
1995 return Vwindow_list;
1999 /* Value is non-zero if WINDOW satisfies the constraints given by
2000 OWINDOW, MINIBUF and ALL_FRAMES.
2002 MINIBUF t means WINDOW may be minibuffer windows.
2003 `lambda' means WINDOW may not be a minibuffer window.
2004 a window means a specific minibuffer window
2006 ALL_FRAMES t means search all frames,
2007 nil means search just current frame,
2008 `visible' means search just visible frames on the
2009 current terminal,
2010 0 means search visible and iconified frames on the
2011 current terminal,
2012 a window means search the frame that window belongs to,
2013 a frame means consider windows on that frame, only. */
2015 static int
2016 candidate_window_p (Lisp_Object window, Lisp_Object owindow, Lisp_Object minibuf, Lisp_Object all_frames)
2018 struct window *w = XWINDOW (window);
2019 struct frame *f = XFRAME (w->frame);
2020 int candidate_p = 1;
2022 if (!BUFFERP (w->buffer))
2023 candidate_p = 0;
2024 else if (MINI_WINDOW_P (w)
2025 && (EQ (minibuf, Qlambda)
2026 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
2028 /* If MINIBUF is `lambda' don't consider any mini-windows.
2029 If it is a window, consider only that one. */
2030 candidate_p = 0;
2032 else if (EQ (all_frames, Qt))
2033 candidate_p = 1;
2034 else if (NILP (all_frames))
2036 xassert (WINDOWP (owindow));
2037 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
2039 else if (EQ (all_frames, Qvisible))
2041 FRAME_SAMPLE_VISIBILITY (f);
2042 candidate_p = FRAME_VISIBLE_P (f)
2043 && (FRAME_TERMINAL (XFRAME (w->frame))
2044 == FRAME_TERMINAL (XFRAME (selected_frame)));
2047 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
2049 FRAME_SAMPLE_VISIBILITY (f);
2050 candidate_p = (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)
2051 #ifdef HAVE_X_WINDOWS
2052 /* Yuck!! If we've just created the frame and the
2053 window-manager requested the user to place it
2054 manually, the window may still not be considered
2055 `visible'. I'd argue it should be at least
2056 something like `iconified', but don't know how to do
2057 that yet. --Stef */
2058 || (FRAME_X_P (f) && f->output_data.x->asked_for_visible
2059 && !f->output_data.x->has_been_visible)
2060 #endif
2062 && (FRAME_TERMINAL (XFRAME (w->frame))
2063 == FRAME_TERMINAL (XFRAME (selected_frame)));
2065 else if (WINDOWP (all_frames))
2066 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
2067 || EQ (XWINDOW (all_frames)->frame, w->frame)
2068 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
2069 else if (FRAMEP (all_frames))
2070 candidate_p = EQ (all_frames, w->frame);
2072 return candidate_p;
2076 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
2077 Fwindow_list. See candidate_window_p for the meaning of WINDOW,
2078 MINIBUF, and ALL_FRAMES. */
2080 static void
2081 decode_next_window_args (Lisp_Object *window, Lisp_Object *minibuf, Lisp_Object *all_frames)
2083 if (NILP (*window))
2084 *window = selected_window;
2085 else
2086 CHECK_LIVE_WINDOW (*window);
2088 /* MINIBUF nil may or may not include minibuffers. Decide if it
2089 does. */
2090 if (NILP (*minibuf))
2091 *minibuf = minibuf_level ? minibuf_window : Qlambda;
2092 else if (!EQ (*minibuf, Qt))
2093 *minibuf = Qlambda;
2095 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
2096 => count none of them, or a specific minibuffer window (the
2097 active one) to count. */
2099 /* ALL_FRAMES nil doesn't specify which frames to include. */
2100 if (NILP (*all_frames))
2101 *all_frames = (!EQ (*minibuf, Qlambda)
2102 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
2103 : Qnil);
2104 else if (EQ (*all_frames, Qvisible))
2106 else if (EQ (*all_frames, make_number (0)))
2108 else if (FRAMEP (*all_frames))
2110 else if (!EQ (*all_frames, Qt))
2111 *all_frames = Qnil;
2115 /* Return the next or previous window of WINDOW in cyclic ordering
2116 of windows. NEXT_P non-zero means return the next window. See the
2117 documentation string of next-window for the meaning of MINIBUF and
2118 ALL_FRAMES. */
2120 static Lisp_Object
2121 next_window (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames, int next_p)
2123 decode_next_window_args (&window, &minibuf, &all_frames);
2125 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
2126 return the first window on the frame. */
2127 if (FRAMEP (all_frames)
2128 && !EQ (all_frames, XWINDOW (window)->frame))
2129 return Fframe_first_window (all_frames);
2131 if (next_p)
2133 Lisp_Object list;
2135 /* Find WINDOW in the list of all windows. */
2136 list = Fmemq (window, window_list ());
2138 /* Scan forward from WINDOW to the end of the window list. */
2139 if (CONSP (list))
2140 for (list = XCDR (list); CONSP (list); list = XCDR (list))
2141 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2142 break;
2144 /* Scan from the start of the window list up to WINDOW. */
2145 if (!CONSP (list))
2146 for (list = Vwindow_list;
2147 CONSP (list) && !EQ (XCAR (list), window);
2148 list = XCDR (list))
2149 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2150 break;
2152 if (CONSP (list))
2153 window = XCAR (list);
2155 else
2157 Lisp_Object candidate, list;
2159 /* Scan through the list of windows for candidates. If there are
2160 candidate windows in front of WINDOW, the last one of these
2161 is the one we want. If there are candidates following WINDOW
2162 in the list, again the last one of these is the one we want. */
2163 candidate = Qnil;
2164 for (list = window_list (); CONSP (list); list = XCDR (list))
2166 if (EQ (XCAR (list), window))
2168 if (WINDOWP (candidate))
2169 break;
2171 else if (candidate_window_p (XCAR (list), window, minibuf,
2172 all_frames))
2173 candidate = XCAR (list);
2176 if (WINDOWP (candidate))
2177 window = candidate;
2180 return window;
2184 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
2185 doc: /* Return live window after WINDOW in the cyclic ordering of windows.
2186 WINDOW must be a live window and defaults to the selected one. The
2187 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2188 consider.
2190 MINIBUF nil or omitted means consider the minibuffer window only if the
2191 minibuffer is active. MINIBUF t means consider the minibuffer window
2192 even if the minibuffer is not active. Any other value means do not
2193 consider the minibuffer window even if the minibuffer is active.
2195 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2196 plus the minibuffer window if specified by the MINIBUF argument. If the
2197 minibuffer counts, consider all windows on all frames that share that
2198 minibuffer too. The following non-nil values of ALL-FRAMES have special
2199 meanings:
2201 - t means consider all windows on all existing frames.
2203 - `visible' means consider all windows on all visible frames.
2205 - 0 (the number zero) means consider all windows on all visible and
2206 iconified frames.
2208 - A frame means consider all windows on that frame only.
2210 Anything else means consider all windows on WINDOW's frame and no
2211 others.
2213 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2214 `next-window' to iterate through the entire cycle of acceptable
2215 windows, eventually ending up back at the window you started with.
2216 `previous-window' traverses the same cycle, in the reverse order. */)
2217 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2219 return next_window (window, minibuf, all_frames, 1);
2223 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
2224 doc: /* Return live window before WINDOW in the cyclic ordering of windows.
2225 WINDOW must be a live window and defaults to the selected one. The
2226 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2227 consider.
2229 MINIBUF nil or omitted means consider the minibuffer window only if the
2230 minibuffer is active. MINIBUF t means consider the minibuffer window
2231 even if the minibuffer is not active. Any other value means do not
2232 consider the minibuffer window even if the minibuffer is active.
2234 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2235 plus the minibuffer window if specified by the MINIBUF argument. If the
2236 minibuffer counts, consider all windows on all frames that share that
2237 minibuffer too. The following non-nil values of ALL-FRAMES have special
2238 meanings:
2240 - t means consider all windows on all existing frames.
2242 - `visible' means consider all windows on all visible frames.
2244 - 0 (the number zero) means consider all windows on all visible and
2245 iconified frames.
2247 - A frame means consider all windows on that frame only.
2249 Anything else means consider all windows on WINDOW's frame and no
2250 others.
2252 If you use consistent values for MINIBUF and ALL-FRAMES, you can
2253 use `previous-window' to iterate through the entire cycle of
2254 acceptable windows, eventually ending up back at the window you
2255 started with. `next-window' traverses the same cycle, in the
2256 reverse order. */)
2257 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2259 return next_window (window, minibuf, all_frames, 0);
2263 /* Return a list of windows in cyclic ordering. Arguments are like
2264 for `next-window'. */
2266 static Lisp_Object
2267 window_list_1 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2269 Lisp_Object tail, list, rest;
2271 decode_next_window_args (&window, &minibuf, &all_frames);
2272 list = Qnil;
2274 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
2275 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
2276 list = Fcons (XCAR (tail), list);
2278 /* Rotate the list to start with WINDOW. */
2279 list = Fnreverse (list);
2280 rest = Fmemq (window, list);
2281 if (!NILP (rest) && !EQ (rest, list))
2283 for (tail = list; !EQ (XCDR (tail), rest); tail = XCDR (tail))
2285 XSETCDR (tail, Qnil);
2286 list = nconc2 (rest, list);
2288 return list;
2292 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
2293 doc: /* Return a list of windows on FRAME, starting with WINDOW.
2294 FRAME nil or omitted means use the selected frame.
2295 WINDOW nil or omitted means use the window selected within FRAME.
2296 MINIBUF t means include the minibuffer window, even if it isn't active.
2297 MINIBUF nil or omitted means include the minibuffer window only
2298 if it's active.
2299 MINIBUF neither nil nor t means never include the minibuffer window. */)
2300 (Lisp_Object frame, Lisp_Object minibuf, Lisp_Object window)
2302 if (NILP (window))
2303 window = FRAMEP (frame) ? XFRAME (frame)->selected_window : selected_window;
2304 CHECK_WINDOW (window);
2305 if (NILP (frame))
2306 frame = selected_frame;
2308 if (!EQ (frame, XWINDOW (window)->frame))
2309 error ("Window is on a different frame");
2311 return window_list_1 (window, minibuf, frame);
2315 DEFUN ("window-list-1", Fwindow_list_1, Swindow_list_1, 0, 3, 0,
2316 doc: /* Return a list of all live windows.
2317 WINDOW specifies the first window to list and defaults to the selected
2318 window.
2320 Optional argument MINIBUF nil or omitted means consider the minibuffer
2321 window only if the minibuffer is active. MINIBUF t means consider the
2322 minibuffer window even if the minibuffer is not active. Any other value
2323 means do not consider the minibuffer window even if the minibuffer is
2324 active.
2326 Optional argument ALL-FRAMES nil or omitted means consider all windows
2327 on WINDOW's frame, plus the minibuffer window if specified by the
2328 MINIBUF argument. If the minibuffer counts, consider all windows on all
2329 frames that share that minibuffer too. The following non-nil values of
2330 ALL-FRAMES have special meanings:
2332 - t means consider all windows on all existing frames.
2334 - `visible' means consider all windows on all visible frames.
2336 - 0 (the number zero) means consider all windows on all visible and
2337 iconified frames.
2339 - A frame means consider all windows on that frame only.
2341 Anything else means consider all windows on WINDOW's frame and no
2342 others.
2344 If WINDOW is not on the list of windows returned, some other window will
2345 be listed first but no error is signaled. */)
2346 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2348 return window_list_1 (window, minibuf, all_frames);
2351 /* Look at all windows, performing an operation specified by TYPE
2352 with argument OBJ.
2353 If FRAMES is Qt, look at all frames;
2354 Qnil, look at just the selected frame;
2355 Qvisible, look at visible frames;
2356 a frame, just look at windows on that frame.
2357 If MINI is non-zero, perform the operation on minibuffer windows too. */
2359 enum window_loop
2361 WINDOW_LOOP_UNUSED,
2362 GET_BUFFER_WINDOW, /* Arg is buffer */
2363 REPLACE_BUFFER_IN_WINDOWS_SAFELY, /* Arg is buffer */
2364 REDISPLAY_BUFFER_WINDOWS, /* Arg is buffer */
2365 CHECK_ALL_WINDOWS
2368 static Lisp_Object
2369 window_loop (enum window_loop type, Lisp_Object obj, int mini, Lisp_Object frames)
2371 Lisp_Object window, windows, best_window, frame_arg;
2372 int frame_best_window_flag = 0;
2373 struct frame *f;
2374 struct gcpro gcpro1;
2376 /* If we're only looping through windows on a particular frame,
2377 frame points to that frame. If we're looping through windows
2378 on all frames, frame is 0. */
2379 if (FRAMEP (frames))
2380 f = XFRAME (frames);
2381 else if (NILP (frames))
2382 f = SELECTED_FRAME ();
2383 else
2384 f = NULL;
2386 if (f)
2387 frame_arg = Qlambda;
2388 else if (EQ (frames, make_number (0)))
2389 frame_arg = frames;
2390 else if (EQ (frames, Qvisible))
2391 frame_arg = frames;
2392 else
2393 frame_arg = Qt;
2395 /* frame_arg is Qlambda to stick to one frame,
2396 Qvisible to consider all visible frames,
2397 or Qt otherwise. */
2399 /* Pick a window to start with. */
2400 if (WINDOWP (obj))
2401 window = obj;
2402 else if (f)
2403 window = FRAME_SELECTED_WINDOW (f);
2404 else
2405 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2407 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
2408 GCPRO1 (windows);
2409 best_window = Qnil;
2411 for (; CONSP (windows); windows = XCDR (windows))
2413 struct window *w;
2415 window = XCAR (windows);
2416 w = XWINDOW (window);
2418 /* Note that we do not pay attention here to whether the frame
2419 is visible, since Fwindow_list skips non-visible frames if
2420 that is desired, under the control of frame_arg. */
2421 if (!MINI_WINDOW_P (w)
2422 /* For REPLACE_BUFFER_IN_WINDOWS_SAFELY, we must always
2423 consider all windows. */
2424 || type == REPLACE_BUFFER_IN_WINDOWS_SAFELY
2425 || (mini && minibuf_level > 0))
2426 switch (type)
2428 case GET_BUFFER_WINDOW:
2429 if (EQ (w->buffer, obj)
2430 /* Don't find any minibuffer window except the one that
2431 is currently in use. */
2432 && (MINI_WINDOW_P (w) ? EQ (window, minibuf_window) : 1))
2434 if (EQ (window, selected_window))
2435 /* Preferably return the selected window. */
2436 RETURN_UNGCPRO (window);
2437 else if (EQ (XWINDOW (window)->frame, selected_frame)
2438 && !frame_best_window_flag)
2439 /* Prefer windows on the current frame (but don't
2440 choose another one if we have one already). */
2442 best_window = window;
2443 frame_best_window_flag = 1;
2445 else if (NILP (best_window))
2446 best_window = window;
2448 break;
2450 case REPLACE_BUFFER_IN_WINDOWS_SAFELY:
2451 /* We could simply check whether the buffer shown by window
2452 is live, and show another buffer in case it isn't. */
2453 if (EQ (w->buffer, obj))
2455 /* Undedicate WINDOW. */
2456 w->dedicated = Qnil;
2457 /* Make WINDOW show the buffer returned by
2458 other_buffer_safely, don't run any hooks. */
2459 set_window_buffer
2460 (window, other_buffer_safely (w->buffer), 0, 0);
2461 /* If WINDOW is the selected window, make its buffer
2462 current. But do so only if the window shows the
2463 current buffer (Bug#6454). */
2464 if (EQ (window, selected_window)
2465 && XBUFFER (w->buffer) == current_buffer)
2466 Fset_buffer (w->buffer);
2468 break;
2470 case REDISPLAY_BUFFER_WINDOWS:
2471 if (EQ (w->buffer, obj))
2473 mark_window_display_accurate (window, 0);
2474 w->update_mode_line = Qt;
2475 XBUFFER (obj)->prevent_redisplay_optimizations_p = 1;
2476 ++update_mode_lines;
2477 best_window = window;
2479 break;
2481 /* Check for a window that has a killed buffer. */
2482 case CHECK_ALL_WINDOWS:
2483 if (! NILP (w->buffer)
2484 && NILP (BVAR (XBUFFER (w->buffer), name)))
2485 abort ();
2486 break;
2488 case WINDOW_LOOP_UNUSED:
2489 break;
2493 UNGCPRO;
2494 return best_window;
2497 /* Used for debugging. Abort if any window has a dead buffer. */
2499 extern void check_all_windows (void) EXTERNALLY_VISIBLE;
2500 void
2501 check_all_windows (void)
2503 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2506 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 0, 2, 0,
2507 doc: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2508 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to
2509 the current buffer.
2511 The optional argument ALL-FRAMES specifies the frames to consider:
2513 - t means consider all windows on all existing frames.
2515 - `visible' means consider all windows on all visible frames.
2517 - 0 (the number zero) means consider all windows on all visible
2518 and iconified frames.
2520 - A frame means consider all windows on that frame only.
2522 Any other value of ALL-FRAMES means consider all windows on the
2523 selected frame and no others. */)
2524 (Lisp_Object buffer_or_name, Lisp_Object all_frames)
2526 Lisp_Object buffer;
2528 if (NILP (buffer_or_name))
2529 buffer = Fcurrent_buffer ();
2530 else
2531 buffer = Fget_buffer (buffer_or_name);
2533 if (BUFFERP (buffer))
2534 return window_loop (GET_BUFFER_WINDOW, buffer, 1, all_frames);
2535 else
2536 return Qnil;
2539 static Lisp_Object
2540 resize_root_window (Lisp_Object window, Lisp_Object delta, Lisp_Object horizontal, Lisp_Object ignore)
2542 return call4 (Qwindow_resize_root_window, window, delta, horizontal, ignore);
2546 DEFUN ("delete-other-windows-internal", Fdelete_other_windows_internal,
2547 Sdelete_other_windows_internal, 0, 2, "",
2548 doc: /* Make WINDOW fill its frame.
2549 Only the frame WINDOW is on is affected. WINDOW may be any window and
2550 defaults to the selected one.
2552 Optional argument ROOT, if non-nil, must specify an internal window such
2553 that WINDOW is in its window subtree. If this is the case, replace ROOT
2554 by WINDOW and leave alone any windows not part of ROOT's subtree.
2556 When WINDOW is live try to reduce display jumps by keeping the text
2557 previously visible in WINDOW in the same place on the frame. Doing this
2558 depends on the value of (window-start WINDOW), so if calling this
2559 function in a program gives strange scrolling, make sure the
2560 window-start value is reasonable when this function is called. */)
2561 (Lisp_Object window, Lisp_Object root)
2563 struct window *w, *r, *s;
2564 struct frame *f;
2565 Lisp_Object sibling, pwindow, swindow IF_LINT (= Qnil), delta;
2566 EMACS_INT startpos IF_LINT (= 0);
2567 int top IF_LINT (= 0), new_top, resize_failed;
2568 Mouse_HLInfo *hlinfo;
2570 w = decode_any_window (window);
2571 XSETWINDOW (window, w);
2572 f = XFRAME (w->frame);
2574 if (NILP (root))
2575 /* ROOT is the frame's root window. */
2577 root = FRAME_ROOT_WINDOW (f);
2578 r = XWINDOW (root);
2580 else
2581 /* ROOT must be an ancestor of WINDOW. */
2583 r = decode_any_window (root);
2584 pwindow = XWINDOW (window)->parent;
2585 while (!NILP (pwindow))
2586 if (EQ (pwindow, root))
2587 break;
2588 else
2589 pwindow = XWINDOW (pwindow)->parent;
2590 if (!EQ (pwindow, root))
2591 error ("Specified root is not an ancestor of specified window");
2594 if (EQ (window, root))
2595 /* A noop. */
2596 return Qnil;
2597 /* I don't understand the "top > 0" part below. If we deal with a
2598 standalone minibuffer it would have been caught by the preceding
2599 test. */
2600 else if (MINI_WINDOW_P (w)) /* && top > 0) */
2601 error ("Can't expand minibuffer to full frame");
2603 if (!NILP (w->buffer))
2605 startpos = marker_position (w->start);
2606 top = WINDOW_TOP_EDGE_LINE (w)
2607 - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2608 /* Make sure WINDOW is the frame's selected window. */
2609 if (!EQ (window, FRAME_SELECTED_WINDOW (f)))
2611 if (EQ (selected_frame, w->frame))
2612 Fselect_window (window, Qnil);
2613 else
2614 FRAME_SELECTED_WINDOW (f) = window;
2617 else
2619 /* See if the frame's selected window is a part of the window
2620 subtree rooted at WINDOW, by finding all the selected window's
2621 parents and comparing each one with WINDOW. If it isn't we
2622 need a new selected window for this frame. */
2623 swindow = FRAME_SELECTED_WINDOW (f);
2624 while (1)
2626 pwindow = swindow;
2627 while (!NILP (pwindow) && !EQ (window, pwindow))
2628 pwindow = XWINDOW (pwindow)->parent;
2630 if (EQ (window, pwindow))
2631 /* If WINDOW is an ancestor of SWINDOW, then SWINDOW is ok
2632 as the new selected window. */
2633 break;
2634 else
2635 /* Else try the previous window of SWINDOW. */
2636 swindow = Fprevious_window (swindow, Qlambda, Qnil);
2639 if (!EQ (swindow, FRAME_SELECTED_WINDOW (f)))
2641 if (EQ (selected_frame, w->frame))
2642 Fselect_window (swindow, Qnil);
2643 else
2644 FRAME_SELECTED_WINDOW (f) = swindow;
2648 BLOCK_INPUT;
2649 hlinfo = MOUSE_HL_INFO (f);
2650 /* We are going to free the glyph matrices of WINDOW, and with that
2651 we might lose any information about glyph rows that have some of
2652 their glyphs highlighted in mouse face. (These rows are marked
2653 with a non-zero mouse_face_p flag.) If WINDOW indeed has some
2654 glyphs highlighted in mouse face, signal to frame's up-to-date
2655 hook that mouse highlight was overwritten, so that it will
2656 arrange for redisplaying the highlight. */
2657 if (EQ (hlinfo->mouse_face_window, window))
2659 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
2660 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
2661 hlinfo->mouse_face_window = Qnil;
2663 free_window_matrices (r);
2665 windows_or_buffers_changed++;
2666 Vwindow_list = Qnil;
2667 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
2668 resize_failed = 0;
2670 if (NILP (w->buffer))
2672 /* Resize child windows vertically. */
2673 XSETINT (delta, XINT (r->total_lines) - XINT (w->total_lines));
2674 w->top_line = r->top_line;
2675 resize_root_window (window, delta, Qnil, Qnil);
2676 if (window_resize_check (w, 0))
2677 window_resize_apply (w, 0);
2678 else
2680 resize_root_window (window, delta, Qnil, Qt);
2681 if (window_resize_check (w, 0))
2682 window_resize_apply (w, 0);
2683 else
2684 resize_failed = 1;
2687 /* Resize child windows horizontally. */
2688 if (!resize_failed)
2690 w->left_col = r->left_col;
2691 XSETINT (delta, XINT (r->total_cols) - XINT (w->total_cols));
2692 w->left_col = r->left_col;
2693 resize_root_window (window, delta, Qt, Qnil);
2694 if (window_resize_check (w, 1))
2695 window_resize_apply (w, 1);
2696 else
2698 resize_root_window (window, delta, Qt, Qt);
2699 if (window_resize_check (w, 1))
2700 window_resize_apply (w, 1);
2701 else
2702 resize_failed = 1;
2706 if (resize_failed)
2707 /* Play safe, if we still can ... */
2709 window = swindow;
2710 w = XWINDOW (window);
2714 /* Cleanly unlink WINDOW from window-tree. */
2715 if (!NILP (w->prev))
2716 /* Get SIBLING above (on the left of) WINDOW. */
2718 sibling = w->prev;
2719 s = XWINDOW (sibling);
2720 s->next = w->next;
2721 if (!NILP (s->next))
2722 XWINDOW (s->next)->prev = sibling;
2724 else
2725 /* Get SIBLING below (on the right of) WINDOW. */
2727 sibling = w->next;
2728 s = XWINDOW (sibling);
2729 s->prev = Qnil;
2730 if (!NILP (XWINDOW (w->parent)->vchild))
2731 XWINDOW (w->parent)->vchild = sibling;
2732 else
2733 XWINDOW (w->parent)->hchild = sibling;
2736 /* Delete ROOT and all child windows of ROOT. */
2737 if (!NILP (r->vchild))
2739 delete_all_child_windows (r->vchild);
2740 r->vchild = Qnil;
2742 else if (!NILP (r->hchild))
2744 delete_all_child_windows (r->hchild);
2745 r->hchild = Qnil;
2748 replace_window (root, window, 1);
2750 /* This must become SWINDOW anyway ....... */
2751 if (!NILP (w->buffer) && !resize_failed)
2753 /* Try to minimize scrolling, by setting the window start to the
2754 point will cause the text at the old window start to be at the
2755 same place on the frame. But don't try to do this if the
2756 window start is outside the visible portion (as might happen
2757 when the display is not current, due to typeahead). */
2758 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2759 if (new_top != top
2760 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2761 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2763 struct position pos;
2764 struct buffer *obuf = current_buffer;
2766 Fset_buffer (w->buffer);
2767 /* This computation used to temporarily move point, but that
2768 can have unwanted side effects due to text properties. */
2769 pos = *vmotion (startpos, -top, w);
2771 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2772 w->window_end_valid = Qnil;
2773 w->start_at_line_beg = ((pos.bytepos == BEGV_BYTE
2774 || FETCH_BYTE (pos.bytepos - 1) == '\n') ? Qt
2775 : Qnil);
2776 /* We need to do this, so that the window-scroll-functions
2777 get called. */
2778 w->optional_new_start = Qt;
2780 set_buffer_internal (obuf);
2784 adjust_glyphs (f);
2785 UNBLOCK_INPUT;
2787 run_window_configuration_change_hook (f);
2789 return Qnil;
2793 void
2794 replace_buffer_in_windows (Lisp_Object buffer)
2796 call1 (Qreplace_buffer_in_windows, buffer);
2800 /* Safely replace BUFFER with some other buffer in all windows of all
2801 frames, even those on other keyboards. */
2803 void
2804 replace_buffer_in_windows_safely (Lisp_Object buffer)
2806 Lisp_Object tail, frame;
2808 /* A single call to window_loop won't do the job because it only
2809 considers frames on the current keyboard. So loop manually over
2810 frames, and handle each one. */
2811 FOR_EACH_FRAME (tail, frame)
2812 window_loop (REPLACE_BUFFER_IN_WINDOWS_SAFELY, buffer, 1, frame);
2815 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2816 minimum allowable size. */
2818 void
2819 check_frame_size (FRAME_PTR frame, int *rows, int *cols)
2821 /* For height, we have to see:
2822 how many windows the frame has at minimum (one or two),
2823 and whether it has a menu bar or other special stuff at the top. */
2824 int min_height
2825 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
2826 ? MIN_SAFE_WINDOW_HEIGHT
2827 : 2 * MIN_SAFE_WINDOW_HEIGHT);
2829 if (FRAME_TOP_MARGIN (frame) > 0)
2830 min_height += FRAME_TOP_MARGIN (frame);
2832 if (*rows < min_height)
2833 *rows = min_height;
2834 if (*cols < MIN_SAFE_WINDOW_WIDTH)
2835 *cols = MIN_SAFE_WINDOW_WIDTH;
2838 /* Adjust the margins of window W if text area is too small.
2839 Return 1 if window width is ok after adjustment; 0 if window
2840 is still too narrow. */
2842 static int
2843 adjust_window_margins (struct window *w)
2845 int box_cols = (WINDOW_TOTAL_COLS (w)
2846 - WINDOW_FRINGE_COLS (w)
2847 - WINDOW_SCROLL_BAR_COLS (w));
2848 int margin_cols = (WINDOW_LEFT_MARGIN_COLS (w)
2849 + WINDOW_RIGHT_MARGIN_COLS (w));
2851 if (box_cols - margin_cols >= MIN_SAFE_WINDOW_WIDTH)
2852 return 1;
2854 if (margin_cols < 0 || box_cols < MIN_SAFE_WINDOW_WIDTH)
2855 return 0;
2857 /* Window's text area is too narrow, but reducing the window
2858 margins will fix that. */
2859 margin_cols = box_cols - MIN_SAFE_WINDOW_WIDTH;
2860 if (WINDOW_RIGHT_MARGIN_COLS (w) > 0)
2862 if (WINDOW_LEFT_MARGIN_COLS (w) > 0)
2863 w->left_margin_cols = w->right_margin_cols
2864 = make_number (margin_cols/2);
2865 else
2866 w->right_margin_cols = make_number (margin_cols);
2868 else
2869 w->left_margin_cols = make_number (margin_cols);
2870 return 1;
2873 static Lisp_Object Fset_window_margins (Lisp_Object, Lisp_Object, Lisp_Object);
2874 static Lisp_Object Fset_window_fringes (Lisp_Object, Lisp_Object, Lisp_Object,
2875 Lisp_Object);
2876 static Lisp_Object Fset_window_scroll_bars (Lisp_Object, Lisp_Object,
2877 Lisp_Object, Lisp_Object);
2878 static Lisp_Object Fset_window_vscroll (Lisp_Object, Lisp_Object, Lisp_Object);
2880 /* The following three routines are needed for running a window's
2881 configuration change hook. */
2882 static void
2883 run_funs (Lisp_Object funs)
2885 for (; CONSP (funs); funs = XCDR (funs))
2886 if (!EQ (XCAR (funs), Qt))
2887 call0 (XCAR (funs));
2890 static Lisp_Object
2891 select_window_norecord (Lisp_Object window)
2893 return WINDOW_LIVE_P (window)
2894 ? Fselect_window (window, Qt) : selected_window;
2897 static Lisp_Object
2898 select_frame_norecord (Lisp_Object frame)
2900 return FRAME_LIVE_P (XFRAME (frame))
2901 ? Fselect_frame (frame, Qt) : selected_frame;
2904 void
2905 run_window_configuration_change_hook (struct frame *f)
2907 int count = SPECPDL_INDEX ();
2908 Lisp_Object frame, global_wcch
2909 = Fdefault_value (Qwindow_configuration_change_hook);
2910 XSETFRAME (frame, f);
2912 if (NILP (Vrun_hooks) || !NILP (inhibit_lisp_code))
2913 return;
2915 /* Use the right buffer. Matters when running the local hooks. */
2916 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
2918 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
2919 Fset_buffer (Fwindow_buffer (Qnil));
2922 if (SELECTED_FRAME () != f)
2924 record_unwind_protect (select_frame_norecord, Fselected_frame ());
2925 select_frame_norecord (frame);
2928 /* Look for buffer-local values. */
2930 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
2931 for (; CONSP (windows); windows = XCDR (windows))
2933 Lisp_Object window = XCAR (windows);
2934 Lisp_Object buffer = Fwindow_buffer (window);
2935 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
2936 buffer)))
2938 int inner_count = SPECPDL_INDEX ();
2939 record_unwind_protect (select_window_norecord, Fselected_window ());
2940 select_window_norecord (window);
2941 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
2942 buffer));
2943 unbind_to (inner_count, Qnil);
2948 run_funs (global_wcch);
2949 unbind_to (count, Qnil);
2952 DEFUN ("run-window-configuration-change-hook", Frun_window_configuration_change_hook,
2953 Srun_window_configuration_change_hook, 1, 1, 0,
2954 doc: /* Run `window-configuration-change-hook' for FRAME. */)
2955 (Lisp_Object frame)
2957 CHECK_LIVE_FRAME (frame);
2958 run_window_configuration_change_hook (XFRAME (frame));
2959 return Qnil;
2962 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
2963 means it's allowed to run hooks. See make_frame for a case where
2964 it's not allowed. KEEP_MARGINS_P non-zero means that the current
2965 margins, fringes, and scroll-bar settings of the window are not
2966 reset from the buffer's local settings. */
2968 void
2969 set_window_buffer (Lisp_Object window, Lisp_Object buffer, int run_hooks_p, int keep_margins_p)
2971 struct window *w = XWINDOW (window);
2972 struct buffer *b = XBUFFER (buffer);
2973 int count = SPECPDL_INDEX ();
2974 int samebuf = EQ (buffer, w->buffer);
2976 w->buffer = buffer;
2978 if (EQ (window, selected_window))
2979 BVAR (b, last_selected_window) = window;
2981 /* Let redisplay errors through. */
2982 b->display_error_modiff = 0;
2984 /* Update time stamps of buffer display. */
2985 if (INTEGERP (BVAR (b, display_count)))
2986 XSETINT (BVAR (b, display_count), XINT (BVAR (b, display_count)) + 1);
2987 BVAR (b, display_time) = Fcurrent_time ();
2989 XSETFASTINT (w->window_end_pos, 0);
2990 XSETFASTINT (w->window_end_vpos, 0);
2991 memset (&w->last_cursor, 0, sizeof w->last_cursor);
2992 w->window_end_valid = Qnil;
2993 if (!(keep_margins_p && samebuf))
2994 { /* If we're not actually changing the buffer, don't reset hscroll and
2995 vscroll. This case happens for example when called from
2996 change_frame_size_1, where we use a dummy call to
2997 Fset_window_buffer on the frame's selected window (and no other)
2998 just in order to run window-configuration-change-hook.
2999 Resetting hscroll and vscroll here is problematic for things like
3000 image-mode and doc-view-mode since it resets the image's position
3001 whenever we resize the frame. */
3002 w->hscroll = w->min_hscroll = make_number (0);
3003 w->vscroll = 0;
3004 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3005 set_marker_restricted (w->start,
3006 make_number (b->last_window_start),
3007 buffer);
3008 w->start_at_line_beg = Qnil;
3009 w->force_start = Qnil;
3010 XSETFASTINT (w->last_modified, 0);
3011 XSETFASTINT (w->last_overlay_modified, 0);
3013 /* Maybe we could move this into the `if' but it's not obviously safe and
3014 I doubt it's worth the trouble. */
3015 windows_or_buffers_changed++;
3017 /* We must select BUFFER for running the window-scroll-functions. */
3018 /* We can't check ! NILP (Vwindow_scroll_functions) here
3019 because that might itself be a local variable. */
3020 if (window_initialized)
3022 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3023 Fset_buffer (buffer);
3026 XMARKER (w->pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3028 if (!keep_margins_p)
3030 /* Set left and right marginal area width etc. from buffer. */
3032 /* This may call adjust_window_margins three times, so
3033 temporarily disable window margins. */
3034 Lisp_Object save_left = w->left_margin_cols;
3035 Lisp_Object save_right = w->right_margin_cols;
3037 w->left_margin_cols = w->right_margin_cols = Qnil;
3039 Fset_window_fringes (window,
3040 BVAR (b, left_fringe_width), BVAR (b, right_fringe_width),
3041 BVAR (b, fringes_outside_margins));
3043 Fset_window_scroll_bars (window,
3044 BVAR (b, scroll_bar_width),
3045 BVAR (b, vertical_scroll_bar_type), Qnil);
3047 w->left_margin_cols = save_left;
3048 w->right_margin_cols = save_right;
3050 Fset_window_margins (window,
3051 BVAR (b, left_margin_cols), BVAR (b, right_margin_cols));
3054 if (run_hooks_p)
3056 if (! NILP (Vwindow_scroll_functions))
3057 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3058 Fmarker_position (w->start));
3059 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3062 unbind_to (count, Qnil);
3065 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3066 doc: /* Make WINDOW display BUFFER-OR-NAME as its contents.
3067 WINDOW has to be a live window and defaults to the selected one.
3068 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3070 Optional third argument KEEP-MARGINS non-nil means that WINDOW's current
3071 display margins, fringe widths, and scroll bar settings are preserved;
3072 the default is to reset these from the local settings for BUFFER-OR-NAME
3073 or the frame defaults. Return nil.
3075 This function throws an error when WINDOW is strongly dedicated to its
3076 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3077 already display BUFFER-OR-NAME.
3079 This function runs `window-scroll-functions' before running
3080 `window-configuration-change-hook'. */)
3081 (register Lisp_Object window, Lisp_Object buffer_or_name, Lisp_Object keep_margins)
3083 register Lisp_Object tem, buffer;
3084 register struct window *w = decode_window (window);
3086 XSETWINDOW (window, w);
3087 buffer = Fget_buffer (buffer_or_name);
3088 CHECK_BUFFER (buffer);
3089 if (NILP (BVAR (XBUFFER (buffer), name)))
3090 error ("Attempt to display deleted buffer");
3092 tem = w->buffer;
3093 if (NILP (tem))
3094 error ("Window is deleted");
3095 else if (!EQ (tem, Qt))
3096 /* w->buffer is t when the window is first being set up. */
3098 if (!EQ (tem, buffer))
3100 if (EQ (w->dedicated, Qt))
3101 /* WINDOW is strongly dedicated to its buffer, signal an
3102 error. */
3103 error ("Window is dedicated to `%s'", SDATA (BVAR (XBUFFER (tem), name)));
3104 else
3105 /* WINDOW is weakly dedicated to its buffer, reset
3106 dedication. */
3107 w->dedicated = Qnil;
3109 call1 (Qrecord_window_buffer, window);
3112 unshow_buffer (w);
3115 set_window_buffer (window, buffer, 1, !NILP (keep_margins));
3117 return Qnil;
3120 static Lisp_Object
3121 display_buffer (Lisp_Object buffer, Lisp_Object not_this_window_p, Lisp_Object override_frame)
3123 return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame);
3126 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3127 0, 1, 0,
3128 doc: /* Force all windows to be updated on next redisplay.
3129 If optional arg OBJECT is a window, force redisplay of that window only.
3130 If OBJECT is a buffer or buffer name, force redisplay of all windows
3131 displaying that buffer. */)
3132 (Lisp_Object object)
3134 if (NILP (object))
3136 windows_or_buffers_changed++;
3137 update_mode_lines++;
3138 return Qt;
3141 if (WINDOWP (object))
3143 struct window *w = XWINDOW (object);
3144 mark_window_display_accurate (object, 0);
3145 w->update_mode_line = Qt;
3146 if (BUFFERP (w->buffer))
3147 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
3148 ++update_mode_lines;
3149 return Qt;
3152 if (STRINGP (object))
3153 object = Fget_buffer (object);
3154 if (BUFFERP (object) && !NILP (BVAR (XBUFFER (object), name)))
3156 /* Walk all windows looking for buffer, and force update
3157 of each of those windows. */
3159 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, 0, Qvisible);
3160 return NILP (object) ? Qnil : Qt;
3163 /* If nothing suitable was found, just return.
3164 We could signal an error, but this feature will typically be used
3165 asynchronously in timers or process sentinels, so we don't. */
3166 return Qnil;
3170 void
3171 temp_output_buffer_show (register Lisp_Object buf)
3173 register struct buffer *old = current_buffer;
3174 register Lisp_Object window;
3175 register struct window *w;
3177 BVAR (XBUFFER (buf), directory) = BVAR (current_buffer, directory);
3179 Fset_buffer (buf);
3180 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3181 BEGV = BEG;
3182 ZV = Z;
3183 SET_PT (BEG);
3184 set_buffer_internal (old);
3186 if (!NILP (Vtemp_buffer_show_function))
3187 call1 (Vtemp_buffer_show_function, buf);
3188 else
3190 window = display_buffer (buf, Qnil, Qnil);
3192 if (!EQ (XWINDOW (window)->frame, selected_frame))
3193 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3194 Vminibuf_scroll_window = window;
3195 w = XWINDOW (window);
3196 XSETFASTINT (w->hscroll, 0);
3197 XSETFASTINT (w->min_hscroll, 0);
3198 set_marker_restricted_both (w->start, buf, BEG, BEG);
3199 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
3201 /* Run temp-buffer-show-hook, with the chosen window selected
3202 and its buffer current. */
3204 int count = SPECPDL_INDEX ();
3205 Lisp_Object prev_window, prev_buffer;
3206 prev_window = selected_window;
3207 XSETBUFFER (prev_buffer, old);
3209 /* Select the window that was chosen, for running the hook.
3210 Note: Both Fselect_window and select_window_norecord may
3211 set-buffer to the buffer displayed in the window,
3212 so we need to save the current buffer. --stef */
3213 record_unwind_protect (Fset_buffer, prev_buffer);
3214 record_unwind_protect (select_window_norecord, prev_window);
3215 Fselect_window (window, Qt);
3216 Fset_buffer (w->buffer);
3217 Frun_hooks (1, &Qtemp_buffer_show_hook);
3218 unbind_to (count, Qnil);
3223 DEFUN ("internal-temp-output-buffer-show",
3224 Ftemp_output_buffer_show, Stemp_output_buffer_show,
3225 1, 1, 0,
3226 doc: /* Internal function for `with-output-to-temp-buffer'. */)
3227 (Lisp_Object buf)
3229 temp_output_buffer_show (buf);
3230 return Qnil;
3233 /* Make new window, have it replace WINDOW in window-tree, and make
3234 WINDOW its only vertical child (HORFLAG 1 means make WINDOW its only
3235 horizontal child). */
3236 static void
3237 make_parent_window (Lisp_Object window, int horflag)
3239 Lisp_Object parent;
3240 register struct window *o, *p;
3241 int i;
3243 o = XWINDOW (window);
3244 p = allocate_window ();
3245 for (i = 0; i < VECSIZE (struct window); ++i)
3246 ((struct Lisp_Vector *) p)->contents[i]
3247 = ((struct Lisp_Vector *) o)->contents[i];
3248 XSETWINDOW (parent, p);
3250 ++sequence_number;
3251 XSETFASTINT (p->sequence_number, sequence_number);
3253 replace_window (window, parent, 1);
3255 o->next = Qnil;
3256 o->prev = Qnil;
3257 o->parent = parent;
3259 p->hchild = horflag ? window : Qnil;
3260 p->vchild = horflag ? Qnil : window;
3261 p->start = Qnil;
3262 p->pointm = Qnil;
3263 p->buffer = Qnil;
3264 p->combination_limit = Qnil;
3265 p->window_parameters = Qnil;
3268 /* Make new window from scratch. */
3269 Lisp_Object
3270 make_window (void)
3272 Lisp_Object window;
3273 register struct window *w;
3275 w = allocate_window ();
3276 /* Initialize all Lisp data. */
3277 w->frame = w->mini_p = Qnil;
3278 w->next = w->prev = w->hchild = w->vchild = w->parent = Qnil;
3279 XSETFASTINT (w->left_col, 0);
3280 XSETFASTINT (w->top_line, 0);
3281 XSETFASTINT (w->total_lines, 0);
3282 XSETFASTINT (w->total_cols, 0);
3283 w->normal_lines = make_float (1.0);
3284 w->normal_cols = make_float (1.0);
3285 XSETFASTINT (w->new_total, 0);
3286 XSETFASTINT (w->new_normal, 0);
3287 w->buffer = Qnil;
3288 w->start = Fmake_marker ();
3289 w->pointm = Fmake_marker ();
3290 w->force_start = w->optional_new_start = Qnil;
3291 XSETFASTINT (w->hscroll, 0);
3292 XSETFASTINT (w->min_hscroll, 0);
3293 XSETFASTINT (w->use_time, 0);
3294 ++sequence_number;
3295 XSETFASTINT (w->sequence_number, sequence_number);
3296 w->temslot = w->last_modified = w->last_overlay_modified = Qnil;
3297 XSETFASTINT (w->last_point, 0);
3298 w->last_had_star = w->vertical_scroll_bar = Qnil;
3299 w->left_margin_cols = w->right_margin_cols = Qnil;
3300 w->left_fringe_width = w->right_fringe_width = Qnil;
3301 w->fringes_outside_margins = Qnil;
3302 w->scroll_bar_width = Qnil;
3303 w->vertical_scroll_bar_type = Qt;
3304 w->last_mark_x = w->last_mark_y = Qnil;
3305 XSETFASTINT (w->window_end_pos, 0);
3306 XSETFASTINT (w->window_end_vpos, 0);
3307 w->window_end_valid = w->update_mode_line = Qnil;
3308 w->start_at_line_beg = w->display_table = w->dedicated = Qnil;
3309 w->base_line_number = w->base_line_pos = w->region_showing = Qnil;
3310 w->column_number_displayed = w->redisplay_end_trigger = Qnil;
3311 w->combination_limit = w->window_parameters = Qnil;
3312 w->prev_buffers = w->next_buffers = Qnil;
3313 /* Initialize non-Lisp data. */
3314 w->desired_matrix = w->current_matrix = 0;
3315 w->nrows_scale_factor = w->ncols_scale_factor = 1;
3316 memset (&w->cursor, 0, sizeof (w->cursor));
3317 memset (&w->last_cursor, 0, sizeof (w->last_cursor));
3318 memset (&w->phys_cursor, 0, sizeof (w->phys_cursor));
3319 w->phys_cursor_type = -1;
3320 w->phys_cursor_width = -1;
3321 w->phys_cursor_on_p = 0;
3322 w->last_cursor_off_p = w->cursor_off_p = 0;
3323 w->must_be_updated_p = 0;
3324 w->pseudo_window_p = 0;
3325 w->frozen_window_start_p = 0;
3326 w->vscroll = 0;
3327 /* Reset window_list. */
3328 Vwindow_list = Qnil;
3329 /* Return window. */
3330 XSETWINDOW (window, w);
3331 return window;
3334 DEFUN ("set-window-new-total", Fset_window_new_total, Sset_window_new_total, 2, 3, 0,
3335 doc: /* Set new total size of WINDOW to SIZE.
3336 Return SIZE.
3338 Optional argument ADD non-nil means add SIZE to the new total size of
3339 WINDOW and return the sum.
3341 Note: This function does not operate on any child windows of WINDOW. */)
3342 (Lisp_Object window, Lisp_Object size, Lisp_Object add)
3344 struct window *w = decode_any_window (window);
3346 CHECK_NUMBER (size);
3347 if (NILP (add))
3348 XSETINT (w->new_total, XINT (size));
3349 else
3350 XSETINT (w->new_total, XINT (w->new_total) + XINT (size));
3352 return w->new_total;
3355 DEFUN ("set-window-new-normal", Fset_window_new_normal, Sset_window_new_normal, 1, 2, 0,
3356 doc: /* Set new normal size of WINDOW to SIZE.
3357 Return SIZE.
3359 Note: This function does not operate on any child windows of WINDOW. */)
3360 (Lisp_Object window, Lisp_Object size)
3362 struct window *w = decode_any_window (window);
3364 w->new_normal = size;
3365 return w->new_normal;
3368 /* Return 1 if setting w->total_lines (w->total_cols if HORFLAG is
3369 non-zero) to w->new_total would result in correct heights (widths)
3370 for window W and recursively all child windows of W.
3372 Note: This function does not check any of `window-fixed-size-p',
3373 `window-min-height' or `window-min-width'. It does check that window
3374 sizes do not drop below one line (two columns). */
3375 static int
3376 window_resize_check (struct window *w, int horflag)
3378 struct window *c;
3380 if (!NILP (w->vchild))
3381 /* W is a vertical combination. */
3383 c = XWINDOW (w->vchild);
3384 if (horflag)
3385 /* All child windows of W must have the same width as W. */
3387 while (c)
3389 if ((XINT (c->new_total) != XINT (w->new_total))
3390 || !window_resize_check (c, horflag))
3391 return 0;
3392 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3394 return 1;
3396 else
3397 /* The sum of the heights of the child windows of W must equal
3398 W's height. */
3400 int sum_of_sizes = 0;
3401 while (c)
3403 if (!window_resize_check (c, horflag))
3404 return 0;
3405 sum_of_sizes = sum_of_sizes + XINT (c->new_total);
3406 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3408 return (sum_of_sizes == XINT (w->new_total));
3411 else if (!NILP (w->hchild))
3412 /* W is a horizontal combination. */
3414 c = XWINDOW (w->hchild);
3415 if (horflag)
3416 /* The sum of the widths of the child windows of W must equal W's
3417 width. */
3419 int sum_of_sizes = 0;
3420 while (c)
3422 if (!window_resize_check (c, horflag))
3423 return 0;
3424 sum_of_sizes = sum_of_sizes + XINT (c->new_total);
3425 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3427 return (sum_of_sizes == XINT (w->new_total));
3429 else
3430 /* All child windows of W must have the same height as W. */
3432 while (c)
3434 if ((XINT (c->new_total) != XINT (w->new_total))
3435 || !window_resize_check (c, horflag))
3436 return 0;
3437 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3439 return 1;
3442 else
3443 /* A leaf window. Make sure it's not too small. The following
3444 hardcodes the values of `window-safe-min-width' (2) and
3445 `window-safe-min-height' (1) which are defined in window.el. */
3446 return XINT (w->new_total) >= (horflag ? 2 : 1);
3449 /* Set w->total_lines (w->total_cols if HORIZONTAL is non-zero) to
3450 w->new_total for window W and recursively all child windows of W.
3451 Also calculate and assign the new vertical (horizontal) start
3452 positions of each of these windows.
3454 This function does not perform any error checks. Make sure you have
3455 run window_resize_check on W before applying this function. */
3456 static void
3457 window_resize_apply (struct window *w, int horflag)
3459 struct window *c;
3460 int pos;
3462 /* Note: Assigning new_normal requires that the new total size of the
3463 parent window has been set *before*. */
3464 if (horflag)
3466 w->total_cols = w->new_total;
3467 if (NUMBERP (w->new_normal))
3468 w->normal_cols = w->new_normal;
3470 pos = XINT (w->left_col);
3472 else
3474 w->total_lines = w->new_total;
3475 if (NUMBERP (w->new_normal))
3476 w->normal_lines = w->new_normal;
3478 pos = XINT (w->top_line);
3481 if (!NILP (w->vchild))
3482 /* W is a vertical combination. */
3484 c = XWINDOW (w->vchild);
3485 while (c)
3487 if (horflag)
3488 XSETFASTINT (c->left_col, pos);
3489 else
3490 XSETFASTINT (c->top_line, pos);
3491 window_resize_apply (c, horflag);
3492 if (!horflag)
3493 pos = pos + XINT (c->total_lines);
3494 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3497 else if (!NILP (w->hchild))
3498 /* W is a horizontal combination. */
3500 c = XWINDOW (w->hchild);
3501 while (c)
3503 if (horflag)
3504 XSETFASTINT (c->left_col, pos);
3505 else
3506 XSETFASTINT (c->top_line, pos);
3507 window_resize_apply (c, horflag);
3508 if (horflag)
3509 pos = pos + XINT (c->total_cols);
3510 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3514 /* Clear out some redisplay caches. */
3515 XSETFASTINT (w->last_modified, 0);
3516 XSETFASTINT (w->last_overlay_modified, 0);
3520 DEFUN ("window-resize-apply", Fwindow_resize_apply, Swindow_resize_apply, 1, 2, 0,
3521 doc: /* Apply requested size values for window-tree of FRAME.
3522 Optional argument HORIZONTAL omitted or nil means apply requested height
3523 values. HORIZONTAL non-nil means apply requested width values.
3525 This function checks whether the requested values sum up to a valid
3526 window layout, recursively assigns the new sizes of all child windows
3527 and calculates and assigns the new start positions of these windows.
3529 Note: This function does not check any of `window-fixed-size-p',
3530 `window-min-height' or `window-min-width'. All these checks have to
3531 be applied on the Elisp level. */)
3532 (Lisp_Object frame, Lisp_Object horizontal)
3534 struct frame *f;
3535 struct window *r;
3536 int horflag = !NILP (horizontal);
3538 if (NILP (frame))
3539 frame = selected_frame;
3540 CHECK_LIVE_FRAME (frame);
3542 f = XFRAME (frame);
3543 r = XWINDOW (FRAME_ROOT_WINDOW (f));
3545 if (!window_resize_check (r, horflag)
3546 || ! EQ (r->new_total, (horflag ? r->total_cols : r->total_lines)))
3547 return Qnil;
3549 BLOCK_INPUT;
3550 window_resize_apply (r, horflag);
3552 windows_or_buffers_changed++;
3553 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3555 adjust_glyphs (f);
3556 UNBLOCK_INPUT;
3558 run_window_configuration_change_hook (f);
3560 return Qt;
3564 /* Resize frame F's windows when number of lines of F is set to SIZE.
3565 HORFLAG 1 means resize windows when number of columns of F is set to
3566 SIZE.
3568 This function can delete all windows but the selected one in order to
3569 satisfy the request. The result will be meaningful if and only if
3570 F's windows have meaningful sizes when you call this. */
3571 void
3572 resize_frame_windows (struct frame *f, int size, int horflag)
3574 Lisp_Object root = f->root_window;
3575 struct window *r = XWINDOW (root);
3576 Lisp_Object mini = f->minibuffer_window;
3577 struct window *m;
3578 /* new_size is the new size of the frame's root window. */
3579 int new_size = (horflag
3580 ? size
3581 : (size
3582 - FRAME_TOP_MARGIN (f)
3583 - ((FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
3584 ? 1 : 0)));
3586 XSETFASTINT (r->top_line, FRAME_TOP_MARGIN (f));
3587 if (NILP (r->vchild) && NILP (r->hchild))
3588 /* For a leaf root window just set the size. */
3589 if (horflag)
3590 XSETFASTINT (r->total_cols, new_size);
3591 else
3592 XSETFASTINT (r->total_lines, new_size);
3593 else
3595 /* old_size is the old size of the frame's root window. */
3596 int old_size = XFASTINT (horflag ? r->total_cols : r->total_lines);
3597 Lisp_Object delta;
3599 XSETINT (delta, new_size - old_size);
3600 /* Try a "normal" resize first. */
3601 resize_root_window (root, delta, horflag ? Qt : Qnil, Qnil);
3602 if (window_resize_check (r, horflag) && new_size == XINT (r->new_total))
3603 window_resize_apply (r, horflag);
3604 else
3606 /* Try with "reasonable" minimum sizes next. */
3607 resize_root_window (root, delta, horflag ? Qt : Qnil, Qt);
3608 if (window_resize_check (r, horflag)
3609 && new_size == XINT (r->new_total))
3610 window_resize_apply (r, horflag);
3611 else
3613 /* Finally, try with "safe" minimum sizes. */
3614 resize_root_window (root, delta, horflag ? Qt : Qnil, Qsafe);
3615 if (window_resize_check (r, horflag)
3616 && new_size == XINT (r->new_total))
3617 window_resize_apply (r, horflag);
3618 else
3620 /* We lost. Delete all windows but the frame's
3621 selected one. */
3622 root = f->selected_window;
3623 Fdelete_other_windows_internal (root, Qnil);
3624 if (horflag)
3625 XSETFASTINT (XWINDOW (root)->total_cols, new_size);
3626 else
3627 XSETFASTINT (XWINDOW (root)->total_lines, new_size);
3633 if (FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
3635 m = XWINDOW (mini);
3636 if (horflag)
3637 XSETFASTINT (m->total_cols, size);
3638 else
3640 /* Are we sure we always want 1 line here? */
3641 XSETFASTINT (m->total_lines, 1);
3642 XSETFASTINT (m->top_line, XINT (r->top_line) + XINT (r->total_lines));
3648 DEFUN ("split-window-internal", Fsplit_window_internal, Ssplit_window_internal, 4, 4, 0,
3649 doc: /* Split window OLD.
3650 Second argument TOTAL-SIZE specifies the number of lines or columns of the
3651 new window. In any case TOTAL-SIZE must be a positive integer.
3653 Third argument SIDE nil (or `below') specifies that the new window shall
3654 be located below WINDOW. SIDE `above' means the new window shall be
3655 located above WINDOW. In both cases TOTAL-SIZE specifies the number of
3656 lines of the new window including space reserved for the mode and/or
3657 header line.
3659 SIDE t (or `right') specifies that the new window shall be located on
3660 the right side of WINDOW. SIDE `left' means the new window shall be
3661 located on the left of WINDOW. In both cases TOTAL-SIZE specifies the
3662 number of columns of the new window including space reserved for fringes
3663 and the scrollbar or a divider column.
3665 Fourth argument NORMAL-SIZE specifies the normal size of the new window
3666 according to the SIDE argument.
3668 The new total and normal sizes of all involved windows must have been
3669 set correctly. See the code of `split-window' for how this is done. */)
3670 (Lisp_Object old, Lisp_Object total_size, Lisp_Object side, Lisp_Object normal_size)
3672 /* OLD (*o) is the window we have to split. (*p) is either OLD's
3673 parent window or an internal window we have to install as OLD's new
3674 parent. REFERENCE (*r) must denote a live window, or is set to OLD
3675 provided OLD is a leaf window, or to the frame's selected window.
3676 NEW (*n) is the new window created with some parameters taken from
3677 REFERENCE (*r). */
3678 register Lisp_Object new, frame, reference;
3679 register struct window *o, *p, *n, *r;
3680 struct frame *f;
3681 int horflag
3682 /* HORFLAG is 1 when we split side-by-side, 0 otherwise. */
3683 = EQ (side, Qt) || EQ (side, Qleft) || EQ (side, Qright);
3684 int combination_limit = 0;
3686 CHECK_WINDOW (old);
3687 o = XWINDOW (old);
3688 frame = WINDOW_FRAME (o);
3689 f = XFRAME (frame);
3691 CHECK_NUMBER (total_size);
3693 /* Set combination_limit to 1 if we have to make a new parent window.
3694 We do that if either `window-combination-limit' is t, or OLD has no
3695 parent, or OLD is ortho-combined. */
3696 combination_limit =
3697 !NILP (Vwindow_combination_limit)
3698 || NILP (o->parent)
3699 || NILP (horflag
3700 ? (XWINDOW (o->parent)->hchild)
3701 : (XWINDOW (o->parent)->vchild));
3703 /* We need a live reference window to initialize some parameters. */
3704 if (WINDOW_LIVE_P (old))
3705 /* OLD is live, use it as reference window. */
3706 reference = old;
3707 else
3708 /* Use the frame's selected window as reference window. */
3709 reference = FRAME_SELECTED_WINDOW (f);
3710 r = XWINDOW (reference);
3712 /* The following bugs are caught by `split-window'. */
3713 if (MINI_WINDOW_P (o))
3714 error ("Attempt to split minibuffer window");
3715 else if (XINT (total_size) < (horflag ? 2 : 1))
3716 error ("Size of new window too small (after split)");
3717 else if (!combination_limit && !NILP (Vwindow_combination_resize))
3718 /* `window-combination-resize' non-nil means try to resize OLD's siblings
3719 proportionally. */
3721 p = XWINDOW (o->parent);
3722 /* Temporarily pretend we split the parent window. */
3723 XSETINT (p->new_total,
3724 XINT (horflag ? p->total_cols : p->total_lines)
3725 - XINT (total_size));
3726 if (!window_resize_check (p, horflag))
3727 error ("Window sizes don't fit");
3728 else
3729 /* Undo the temporary pretension. */
3730 p->new_total = horflag ? p->total_cols : p->total_lines;
3732 else
3734 if (!window_resize_check (o, horflag))
3735 error ("Resizing old window failed");
3736 else if (XINT (total_size) + XINT (o->new_total)
3737 != XINT (horflag ? o->total_cols : o->total_lines))
3738 error ("Sum of sizes of old and new window don't fit");
3741 /* This is our point of no return. */
3742 if (combination_limit)
3744 /* Save the old value of o->normal_cols/lines. It gets corrupted
3745 by make_parent_window and we need it below for assigning it to
3746 p->new_normal. */
3747 Lisp_Object new_normal = horflag ? o->normal_cols : o->normal_lines;
3749 make_parent_window (old, horflag);
3750 p = XWINDOW (o->parent);
3751 /* Store value of `window-combination-limit' in new parent's
3752 combination_limit slot. */
3753 p->combination_limit = Vwindow_combination_limit;
3754 /* These get applied below. */
3755 p->new_total = horflag ? o->total_cols : o->total_lines;
3756 p->new_normal = new_normal;
3758 else
3759 p = XWINDOW (o->parent);
3761 windows_or_buffers_changed++;
3762 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3763 new = make_window ();
3764 n = XWINDOW (new);
3765 n->frame = frame;
3766 n->parent = o->parent;
3767 n->vchild = n->hchild = Qnil;
3769 if (EQ (side, Qabove) || EQ (side, Qleft))
3771 n->prev = o->prev;
3772 if (NILP (n->prev))
3773 if (horflag)
3774 p->hchild = new;
3775 else
3776 p->vchild = new;
3777 else
3778 XWINDOW (n->prev)->next = new;
3779 n->next = old;
3780 o->prev = new;
3782 else
3784 n->next = o->next;
3785 if (!NILP (n->next))
3786 XWINDOW (n->next)->prev = new;
3787 n->prev = old;
3788 o->next = new;
3791 n->buffer = Qt;
3792 n->window_end_valid = Qnil;
3793 memset (&n->last_cursor, 0, sizeof n->last_cursor);
3795 /* Get special geometry settings from reference window. */
3796 n->left_margin_cols = r->left_margin_cols;
3797 n->right_margin_cols = r->right_margin_cols;
3798 n->left_fringe_width = r->left_fringe_width;
3799 n->right_fringe_width = r->right_fringe_width;
3800 n->fringes_outside_margins = r->fringes_outside_margins;
3801 n->scroll_bar_width = r->scroll_bar_width;
3802 n->vertical_scroll_bar_type = r->vertical_scroll_bar_type;
3804 /* Directly assign orthogonal coordinates and sizes. */
3805 if (horflag)
3807 n->top_line = o->top_line;
3808 n->total_lines = o->total_lines;
3810 else
3812 n->left_col = o->left_col;
3813 n->total_cols = o->total_cols;
3816 /* Iso-coordinates and sizes are assigned by window_resize_apply,
3817 get them ready here. */
3818 n->new_total = total_size;
3819 n->new_normal = normal_size;
3821 BLOCK_INPUT;
3822 window_resize_apply (p, horflag);
3823 adjust_glyphs (f);
3824 /* Set buffer of NEW to buffer of reference window. Don't run
3825 any hooks. */
3826 set_window_buffer (new, r->buffer, 0, 1);
3827 UNBLOCK_INPUT;
3829 /* Maybe we should run the scroll functions in Elisp (which already
3830 runs the configuration change hook). */
3831 if (! NILP (Vwindow_scroll_functions))
3832 run_hook_with_args_2 (Qwindow_scroll_functions, new,
3833 Fmarker_position (n->start));
3834 /* Return NEW. */
3835 return new;
3839 DEFUN ("delete-window-internal", Fdelete_window_internal, Sdelete_window_internal, 1, 1, 0,
3840 doc: /* Remove WINDOW from its frame.
3841 WINDOW defaults to the selected window. Return nil.
3842 Signal an error when WINDOW is the only window on its frame. */)
3843 (register Lisp_Object window)
3845 register Lisp_Object parent, sibling, frame, root;
3846 struct window *w, *p, *s, *r;
3847 struct frame *f;
3848 int horflag;
3849 int before_sibling = 0;
3851 w = decode_any_window (window);
3852 XSETWINDOW (window, w);
3853 if (NILP (w->buffer) && NILP (w->hchild) && NILP (w->vchild))
3854 /* It's a no-op to delete an already deleted window. */
3855 return Qnil;
3857 parent = w->parent;
3858 if (NILP (parent))
3859 /* Never delete a minibuffer or frame root window. */
3860 error ("Attempt to delete minibuffer or sole ordinary window");
3861 else if (NILP (w->prev) && NILP (w->next))
3862 /* Rather bow out here, this case should be handled on the Elisp
3863 level. */
3864 error ("Attempt to delete sole window of parent");
3866 p = XWINDOW (parent);
3867 horflag = NILP (p->vchild);
3869 frame = WINDOW_FRAME (w);
3870 f = XFRAME (frame);
3872 root = FRAME_ROOT_WINDOW (f);
3873 r = XWINDOW (root);
3875 /* Unlink WINDOW from window tree. */
3876 if (NILP (w->prev))
3877 /* Get SIBLING below (on the right of) WINDOW. */
3879 /* before_sibling 1 means WINDOW is the first child of its
3880 parent and thus before the sibling. */
3881 before_sibling = 1;
3882 sibling = w->next;
3883 s = XWINDOW (sibling);
3884 s->prev = Qnil;
3885 if (horflag)
3886 p->hchild = sibling;
3887 else
3888 p->vchild = sibling;
3890 else
3891 /* Get SIBLING above (on the left of) WINDOW. */
3893 sibling = w->prev;
3894 s = XWINDOW (sibling);
3895 s->next = w->next;
3896 if (!NILP (s->next))
3897 XWINDOW (s->next)->prev = sibling;
3900 if (window_resize_check (r, horflag)
3901 && EQ (r->new_total, (horflag ? r->total_cols : r->total_lines)))
3902 /* We can delete WINDOW now. */
3904 Mouse_HLInfo *hlinfo;
3906 /* Block input. */
3907 BLOCK_INPUT;
3908 window_resize_apply (p, horflag);
3910 /* If this window is referred to by the dpyinfo's mouse
3911 highlight, invalidate that slot to be safe (Bug#9904). */
3912 hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
3913 if (EQ (hlinfo->mouse_face_window, window))
3914 hlinfo->mouse_face_window = Qnil;
3916 windows_or_buffers_changed++;
3917 Vwindow_list = Qnil;
3918 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3920 w->next = Qnil; /* Don't delete w->next too. */
3921 free_window_matrices (w);
3923 if (!NILP (w->vchild))
3925 delete_all_child_windows (w->vchild);
3926 w->vchild = Qnil;
3928 else if (!NILP (w->hchild))
3930 delete_all_child_windows (w->hchild);
3931 w->hchild = Qnil;
3933 else if (!NILP (w->buffer))
3935 unshow_buffer (w);
3936 unchain_marker (XMARKER (w->pointm));
3937 unchain_marker (XMARKER (w->start));
3938 w->buffer = Qnil;
3941 if (NILP (s->prev) && NILP (s->next))
3942 /* A matrjoshka where SIBLING has become the only child of
3943 PARENT. */
3945 /* Put SIBLING into PARENT's place. */
3946 replace_window (parent, sibling, 0);
3947 /* Have SIBLING inherit the following three slot values from
3948 PARENT (the combination_limit slot is not inherited). */
3949 s->normal_cols = p->normal_cols;
3950 s->normal_lines = p->normal_lines;
3951 /* Mark PARENT as deleted. */
3952 p->vchild = p->hchild = Qnil;
3953 /* Try to merge SIBLING into its new parent. */
3954 recombine_windows (sibling);
3957 adjust_glyphs (f);
3959 if (!WINDOW_LIVE_P (FRAME_SELECTED_WINDOW (f)))
3960 /* We deleted the frame's selected window. */
3962 /* Use the frame's first window as fallback ... */
3963 Lisp_Object new_selected_window = Fframe_first_window (frame);
3964 /* ... but preferably use its most recently used window. */
3965 Lisp_Object mru_window;
3967 /* `get-mru-window' might fail for some reason so play it safe
3968 - promote the first window _without recording it_ first. */
3969 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
3970 Fselect_window (new_selected_window, Qt);
3971 else
3972 FRAME_SELECTED_WINDOW (f) = new_selected_window;
3974 UNBLOCK_INPUT;
3976 /* Now look whether `get-mru-window' gets us something. */
3977 mru_window = call1 (Qget_mru_window, frame);
3978 if (WINDOW_LIVE_P (mru_window)
3979 && EQ (XWINDOW (mru_window)->frame, frame))
3980 new_selected_window = mru_window;
3982 /* If all ended up well, we now promote the mru window. */
3983 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
3984 Fselect_window (new_selected_window, Qnil);
3985 else
3986 FRAME_SELECTED_WINDOW (f) = new_selected_window;
3988 else
3989 UNBLOCK_INPUT;
3991 /* Must be run by the caller:
3992 run_window_configuration_change_hook (f); */
3994 else
3995 /* We failed: Relink WINDOW into window tree. */
3997 if (before_sibling)
3999 s->prev = window;
4000 if (horflag)
4001 p->hchild = window;
4002 else
4003 p->vchild = window;
4005 else
4007 s->next = window;
4008 if (!NILP (w->next))
4009 XWINDOW (w->next)->prev = window;
4011 error ("Deletion failed");
4014 return Qnil;
4017 /***********************************************************************
4018 Resizing Mini-Windows
4019 ***********************************************************************/
4021 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we
4022 can. */
4023 void
4024 grow_mini_window (struct window *w, int delta)
4026 struct frame *f = XFRAME (w->frame);
4027 struct window *r;
4028 Lisp_Object root, value;
4030 xassert (MINI_WINDOW_P (w));
4031 xassert (delta >= 0);
4033 root = FRAME_ROOT_WINDOW (f);
4034 r = XWINDOW (root);
4035 value = call2 (Qwindow_resize_root_window_vertically,
4036 root, make_number (- delta));
4037 if (INTEGERP (value) && window_resize_check (r, 0))
4039 BLOCK_INPUT;
4040 window_resize_apply (r, 0);
4042 /* Grow the mini-window. */
4043 XSETFASTINT (w->top_line, XFASTINT (r->top_line) + XFASTINT (r->total_lines));
4044 XSETFASTINT (w->total_lines, XFASTINT (w->total_lines) - XINT (value));
4045 XSETFASTINT (w->last_modified, 0);
4046 XSETFASTINT (w->last_overlay_modified, 0);
4048 adjust_glyphs (f);
4049 UNBLOCK_INPUT;
4054 /* Shrink mini-window W. */
4055 void
4056 shrink_mini_window (struct window *w)
4058 struct frame *f = XFRAME (w->frame);
4059 struct window *r;
4060 Lisp_Object root, value;
4061 EMACS_INT size;
4063 xassert (MINI_WINDOW_P (w));
4065 size = XINT (w->total_lines);
4066 if (size > 1)
4068 root = FRAME_ROOT_WINDOW (f);
4069 r = XWINDOW (root);
4070 value = call2 (Qwindow_resize_root_window_vertically,
4071 root, make_number (size - 1));
4072 if (INTEGERP (value) && window_resize_check (r, 0))
4074 BLOCK_INPUT;
4075 window_resize_apply (r, 0);
4077 /* Shrink the mini-window. */
4078 XSETFASTINT (w->top_line, XFASTINT (r->top_line) + XFASTINT (r->total_lines));
4079 XSETFASTINT (w->total_lines, 1);
4081 XSETFASTINT (w->last_modified, 0);
4082 XSETFASTINT (w->last_overlay_modified, 0);
4084 adjust_glyphs (f);
4085 UNBLOCK_INPUT;
4087 /* If the above failed for whatever strange reason we must make a
4088 one window frame here. The same routine will be needed when
4089 shrinking the frame (and probably when making the initial
4090 *scratch* window). For the moment leave things as they are. */
4094 DEFUN ("resize-mini-window-internal", Fresize_mini_window_internal, Sresize_mini_window_internal, 1, 1, 0,
4095 doc: /* Resize minibuffer window WINDOW. */)
4096 (Lisp_Object window)
4098 struct window *w = XWINDOW (window);
4099 struct window *r;
4100 struct frame *f;
4101 int height;
4103 CHECK_WINDOW (window);
4104 f = XFRAME (w->frame);
4106 if (!EQ (FRAME_MINIBUF_WINDOW (XFRAME (w->frame)), window))
4107 error ("Not a valid minibuffer window");
4108 else if (FRAME_MINIBUF_ONLY_P (f))
4109 error ("Cannot resize a minibuffer-only frame");
4111 r = XWINDOW (FRAME_ROOT_WINDOW (f));
4112 height = XINT (r->total_lines) + XINT (w->total_lines);
4113 if (window_resize_check (r, 0)
4114 && XINT (w->new_total) > 0
4115 && height == XINT (r->new_total) + XINT (w->new_total))
4117 BLOCK_INPUT;
4118 window_resize_apply (r, 0);
4120 w->total_lines = w->new_total;
4121 XSETFASTINT (w->top_line, XINT (r->top_line) + XINT (r->total_lines));
4123 windows_or_buffers_changed++;
4124 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4125 adjust_glyphs (f);
4126 UNBLOCK_INPUT;
4128 run_window_configuration_change_hook (f);
4129 return Qt;
4131 else error ("Failed to resize minibuffer window");
4134 /* Mark window cursors off for all windows in the window tree rooted
4135 at W by setting their phys_cursor_on_p flag to zero. Called from
4136 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4137 the frame are cleared. */
4139 void
4140 mark_window_cursors_off (struct window *w)
4142 while (w)
4144 if (!NILP (w->hchild))
4145 mark_window_cursors_off (XWINDOW (w->hchild));
4146 else if (!NILP (w->vchild))
4147 mark_window_cursors_off (XWINDOW (w->vchild));
4148 else
4149 w->phys_cursor_on_p = 0;
4151 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4156 /* Return number of lines of text (not counting mode lines) in W. */
4159 window_internal_height (struct window *w)
4161 int ht = XFASTINT (w->total_lines);
4163 if (!MINI_WINDOW_P (w))
4165 if (!NILP (w->parent)
4166 || !NILP (w->vchild)
4167 || !NILP (w->hchild)
4168 || !NILP (w->next)
4169 || !NILP (w->prev)
4170 || WINDOW_WANTS_MODELINE_P (w))
4171 --ht;
4173 if (WINDOW_WANTS_HEADER_LINE_P (w))
4174 --ht;
4177 return ht;
4180 /************************************************************************
4181 Window Scrolling
4182 ***********************************************************************/
4184 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4185 N screen-fulls, which is defined as the height of the window minus
4186 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4187 instead. Negative values of N mean scroll down. NOERROR non-zero
4188 means don't signal an error if we try to move over BEGV or ZV,
4189 respectively. */
4191 static void
4192 window_scroll (Lisp_Object window, int n, int whole, int noerror)
4194 immediate_quit = 1;
4196 /* If we must, use the pixel-based version which is much slower than
4197 the line-based one but can handle varying line heights. */
4198 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4199 window_scroll_pixel_based (window, n, whole, noerror);
4200 else
4201 window_scroll_line_based (window, n, whole, noerror);
4203 immediate_quit = 0;
4207 /* Implementation of window_scroll that works based on pixel line
4208 heights. See the comment of window_scroll for parameter
4209 descriptions. */
4211 static void
4212 window_scroll_pixel_based (Lisp_Object window, int n, int whole, int noerror)
4214 struct it it;
4215 struct window *w = XWINDOW (window);
4216 struct text_pos start;
4217 int this_scroll_margin;
4218 /* True if we fiddled the window vscroll field without really scrolling. */
4219 int vscrolled = 0;
4220 int x, y, rtop, rbot, rowh, vpos;
4221 void *itdata = NULL;
4223 SET_TEXT_POS_FROM_MARKER (start, w->start);
4225 /* If PT is not visible in WINDOW, move back one half of
4226 the screen. Allow PT to be partially visible, otherwise
4227 something like (scroll-down 1) with PT in the line before
4228 the partially visible one would recenter. */
4230 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
4232 itdata = bidi_shelve_cache ();
4233 /* Move backward half the height of the window. Performance note:
4234 vmotion used here is about 10% faster, but would give wrong
4235 results for variable height lines. */
4236 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4237 it.current_y = it.last_visible_y;
4238 move_it_vertically_backward (&it, window_box_height (w) / 2);
4240 /* The function move_iterator_vertically may move over more than
4241 the specified y-distance. If it->w is small, e.g. a
4242 mini-buffer window, we may end up in front of the window's
4243 display area. This is the case when Start displaying at the
4244 start of the line containing PT in this case. */
4245 if (it.current_y <= 0)
4247 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4248 move_it_vertically_backward (&it, 0);
4249 it.current_y = 0;
4252 start = it.current.pos;
4253 bidi_unshelve_cache (itdata, 0);
4255 else if (auto_window_vscroll_p)
4257 if (rtop || rbot) /* partially visible */
4259 int px;
4260 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4261 if (whole)
4262 dy = max ((window_box_height (w)
4263 - next_screen_context_lines * dy),
4264 dy);
4265 dy *= n;
4267 if (n < 0)
4269 /* Only vscroll backwards if already vscrolled forwards. */
4270 if (w->vscroll < 0 && rtop > 0)
4272 px = max (0, -w->vscroll - min (rtop, -dy));
4273 Fset_window_vscroll (window, make_number (px), Qt);
4274 return;
4277 if (n > 0)
4279 /* Do vscroll if already vscrolled or only display line. */
4280 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
4282 px = max (0, -w->vscroll + min (rbot, dy));
4283 Fset_window_vscroll (window, make_number (px), Qt);
4284 return;
4287 /* Maybe modify window start instead of scrolling. */
4288 if (rbot > 0 || w->vscroll < 0)
4290 EMACS_INT spos;
4292 Fset_window_vscroll (window, make_number (0), Qt);
4293 /* If there are other text lines above the current row,
4294 move window start to current row. Else to next row. */
4295 if (rbot > 0)
4296 spos = XINT (Fline_beginning_position (Qnil));
4297 else
4298 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
4299 set_marker_restricted (w->start, make_number (spos),
4300 w->buffer);
4301 w->start_at_line_beg = Qt;
4302 w->update_mode_line = Qt;
4303 XSETFASTINT (w->last_modified, 0);
4304 XSETFASTINT (w->last_overlay_modified, 0);
4305 /* Set force_start so that redisplay_window will run the
4306 window-scroll-functions. */
4307 w->force_start = Qt;
4308 return;
4312 /* Cancel previous vscroll. */
4313 Fset_window_vscroll (window, make_number (0), Qt);
4316 itdata = bidi_shelve_cache ();
4317 /* If scroll_preserve_screen_position is non-nil, we try to set
4318 point in the same window line as it is now, so get that line. */
4319 if (!NILP (Vscroll_preserve_screen_position))
4321 /* We preserve the goal pixel coordinate across consecutive
4322 calls to scroll-up, scroll-down and other commands that
4323 have the `scroll-command' property. This avoids the
4324 possibility of point becoming "stuck" on a tall line when
4325 scrolling by one line. */
4326 if (window_scroll_pixel_based_preserve_y < 0
4327 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4328 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4330 start_display (&it, w, start);
4331 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4332 window_scroll_pixel_based_preserve_y = it.current_y;
4333 window_scroll_pixel_based_preserve_x = it.current_x;
4336 else
4337 window_scroll_pixel_based_preserve_y
4338 = window_scroll_pixel_based_preserve_x = -1;
4340 /* Move iterator it from start the specified distance forward or
4341 backward. The result is the new window start. */
4342 start_display (&it, w, start);
4343 if (whole)
4345 EMACS_INT start_pos = IT_CHARPOS (it);
4346 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4347 dy = max ((window_box_height (w)
4348 - next_screen_context_lines * dy),
4349 dy) * n;
4351 /* Note that move_it_vertically always moves the iterator to the
4352 start of a line. So, if the last line doesn't have a newline,
4353 we would end up at the start of the line ending at ZV. */
4354 if (dy <= 0)
4356 move_it_vertically_backward (&it, -dy);
4357 /* Ensure we actually do move, e.g. in case we are currently
4358 looking at an image that is taller that the window height. */
4359 while (start_pos == IT_CHARPOS (it)
4360 && start_pos > BEGV)
4361 move_it_by_lines (&it, -1);
4363 else if (dy > 0)
4365 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4366 MOVE_TO_POS | MOVE_TO_Y);
4367 /* Ensure we actually do move, e.g. in case we are currently
4368 looking at an image that is taller that the window height. */
4369 while (start_pos == IT_CHARPOS (it)
4370 && start_pos < ZV)
4371 move_it_by_lines (&it, 1);
4374 else
4375 move_it_by_lines (&it, n);
4377 /* We failed if we find ZV is already on the screen (scrolling up,
4378 means there's nothing past the end), or if we can't start any
4379 earlier (scrolling down, means there's nothing past the top). */
4380 if ((n > 0 && IT_CHARPOS (it) == ZV)
4381 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4383 if (IT_CHARPOS (it) == ZV)
4385 if (it.current_y < it.last_visible_y
4386 && (it.current_y + it.max_ascent + it.max_descent
4387 > it.last_visible_y))
4389 /* The last line was only partially visible, make it fully
4390 visible. */
4391 w->vscroll = (it.last_visible_y
4392 - it.current_y + it.max_ascent + it.max_descent);
4393 adjust_glyphs (it.f);
4395 else
4397 bidi_unshelve_cache (itdata, 0);
4398 if (noerror)
4399 return;
4400 else if (n < 0) /* could happen with empty buffers */
4401 xsignal0 (Qbeginning_of_buffer);
4402 else
4403 xsignal0 (Qend_of_buffer);
4406 else
4408 if (w->vscroll != 0)
4409 /* The first line was only partially visible, make it fully
4410 visible. */
4411 w->vscroll = 0;
4412 else
4414 bidi_unshelve_cache (itdata, 0);
4415 if (noerror)
4416 return;
4417 else
4418 xsignal0 (Qbeginning_of_buffer);
4422 /* If control gets here, then we vscrolled. */
4424 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
4426 /* Don't try to change the window start below. */
4427 vscrolled = 1;
4430 if (! vscrolled)
4432 EMACS_INT pos = IT_CHARPOS (it);
4433 EMACS_INT bytepos;
4435 /* If in the middle of a multi-glyph character move forward to
4436 the next character. */
4437 if (in_display_vector_p (&it))
4439 ++pos;
4440 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
4443 /* Set the window start, and set up the window for redisplay. */
4444 set_marker_restricted (w->start, make_number (pos),
4445 w->buffer);
4446 bytepos = XMARKER (w->start)->bytepos;
4447 w->start_at_line_beg = ((pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n')
4448 ? Qt : Qnil);
4449 w->update_mode_line = Qt;
4450 XSETFASTINT (w->last_modified, 0);
4451 XSETFASTINT (w->last_overlay_modified, 0);
4452 /* Set force_start so that redisplay_window will run the
4453 window-scroll-functions. */
4454 w->force_start = Qt;
4457 /* The rest of this function uses current_y in a nonstandard way,
4458 not including the height of the header line if any. */
4459 it.current_y = it.vpos = 0;
4461 /* Move PT out of scroll margins.
4462 This code wants current_y to be zero at the window start position
4463 even if there is a header line. */
4464 this_scroll_margin = max (0, scroll_margin);
4465 this_scroll_margin = min (this_scroll_margin, XFASTINT (w->total_lines) / 4);
4466 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
4468 if (n > 0)
4470 /* We moved the window start towards ZV, so PT may be now
4471 in the scroll margin at the top. */
4472 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4473 if (IT_CHARPOS (it) == PT && it.current_y >= this_scroll_margin
4474 && (NILP (Vscroll_preserve_screen_position)
4475 || EQ (Vscroll_preserve_screen_position, Qt)))
4476 /* We found PT at a legitimate height. Leave it alone. */
4478 else if (window_scroll_pixel_based_preserve_y >= 0)
4480 /* If we have a header line, take account of it.
4481 This is necessary because we set it.current_y to 0, above. */
4482 move_it_to (&it, -1,
4483 window_scroll_pixel_based_preserve_x,
4484 window_scroll_pixel_based_preserve_y
4485 - (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0 ),
4486 -1, MOVE_TO_Y | MOVE_TO_X);
4487 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4489 else
4491 while (it.current_y < this_scroll_margin)
4493 int prev = it.current_y;
4494 move_it_by_lines (&it, 1);
4495 if (prev == it.current_y)
4496 break;
4498 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4501 else if (n < 0)
4503 EMACS_INT charpos, bytepos;
4504 int partial_p;
4506 /* Save our position, for the
4507 window_scroll_pixel_based_preserve_y case. */
4508 charpos = IT_CHARPOS (it);
4509 bytepos = IT_BYTEPOS (it);
4511 /* We moved the window start towards BEGV, so PT may be now
4512 in the scroll margin at the bottom. */
4513 move_it_to (&it, PT, -1,
4514 (it.last_visible_y - CURRENT_HEADER_LINE_HEIGHT (w)
4515 - this_scroll_margin - 1),
4517 MOVE_TO_POS | MOVE_TO_Y);
4519 /* Save our position, in case it's correct. */
4520 charpos = IT_CHARPOS (it);
4521 bytepos = IT_BYTEPOS (it);
4523 /* See if point is on a partially visible line at the end. */
4524 if (it.what == IT_EOB)
4525 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
4526 else
4528 move_it_by_lines (&it, 1);
4529 partial_p = it.current_y > it.last_visible_y;
4532 if (charpos == PT && !partial_p
4533 && (NILP (Vscroll_preserve_screen_position)
4534 || EQ (Vscroll_preserve_screen_position, Qt)))
4535 /* We found PT before we found the display margin, so PT is ok. */
4537 else if (window_scroll_pixel_based_preserve_y >= 0)
4539 SET_TEXT_POS_FROM_MARKER (start, w->start);
4540 start_display (&it, w, start);
4541 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
4542 here because we called start_display again and did not
4543 alter it.current_y this time. */
4544 move_it_to (&it, -1, window_scroll_pixel_based_preserve_x,
4545 window_scroll_pixel_based_preserve_y, -1,
4546 MOVE_TO_Y | MOVE_TO_X);
4547 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4549 else
4551 if (partial_p)
4552 /* The last line was only partially visible, so back up two
4553 lines to make sure we're on a fully visible line. */
4555 move_it_by_lines (&it, -2);
4556 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4558 else
4559 /* No, the position we saved is OK, so use it. */
4560 SET_PT_BOTH (charpos, bytepos);
4563 bidi_unshelve_cache (itdata, 0);
4567 /* Implementation of window_scroll that works based on screen lines.
4568 See the comment of window_scroll for parameter descriptions. */
4570 static void
4571 window_scroll_line_based (Lisp_Object window, int n, int whole, int noerror)
4573 register struct window *w = XWINDOW (window);
4574 /* Fvertical_motion enters redisplay, which can trigger
4575 fontification, which in turn can modify buffer text (e.g., if the
4576 fontification functions replace escape sequences with faces, as
4577 in `grep-mode-font-lock-keywords'). So we use a marker to record
4578 the old point position, to prevent crashes in SET_PT_BOTH. */
4579 Lisp_Object opoint_marker = Fpoint_marker ();
4580 register EMACS_INT pos, pos_byte;
4581 register int ht = window_internal_height (w);
4582 register Lisp_Object tem;
4583 int lose;
4584 Lisp_Object bolp;
4585 EMACS_INT startpos;
4586 Lisp_Object original_pos = Qnil;
4588 /* If scrolling screen-fulls, compute the number of lines to
4589 scroll from the window's height. */
4590 if (whole)
4591 n *= max (1, ht - next_screen_context_lines);
4593 startpos = marker_position (w->start);
4595 if (!NILP (Vscroll_preserve_screen_position))
4597 if (window_scroll_preserve_vpos <= 0
4598 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4599 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4601 struct position posit
4602 = *compute_motion (startpos, 0, 0, 0,
4603 PT, ht, 0,
4604 -1, XINT (w->hscroll),
4605 0, w);
4606 window_scroll_preserve_vpos = posit.vpos;
4607 window_scroll_preserve_hpos = posit.hpos + XINT (w->hscroll);
4610 original_pos = Fcons (make_number (window_scroll_preserve_hpos),
4611 make_number (window_scroll_preserve_vpos));
4614 XSETFASTINT (tem, PT);
4615 tem = Fpos_visible_in_window_p (tem, window, Qnil);
4617 if (NILP (tem))
4619 Fvertical_motion (make_number (- (ht / 2)), window);
4620 startpos = PT;
4623 SET_PT (startpos);
4624 lose = n < 0 && PT == BEGV;
4625 Fvertical_motion (make_number (n), window);
4626 pos = PT;
4627 pos_byte = PT_BYTE;
4628 bolp = Fbolp ();
4629 SET_PT_BOTH (marker_position (opoint_marker),
4630 marker_byte_position (opoint_marker));
4632 if (lose)
4634 if (noerror)
4635 return;
4636 else
4637 xsignal0 (Qbeginning_of_buffer);
4640 if (pos < ZV)
4642 /* Don't use a scroll margin that is negative or too large. */
4643 int this_scroll_margin =
4644 max (0, min (scroll_margin, XINT (w->total_lines) / 4));
4646 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
4647 w->start_at_line_beg = bolp;
4648 w->update_mode_line = Qt;
4649 XSETFASTINT (w->last_modified, 0);
4650 XSETFASTINT (w->last_overlay_modified, 0);
4651 /* Set force_start so that redisplay_window will run
4652 the window-scroll-functions. */
4653 w->force_start = Qt;
4655 if (!NILP (Vscroll_preserve_screen_position)
4656 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
4658 SET_PT_BOTH (pos, pos_byte);
4659 Fvertical_motion (original_pos, window);
4661 /* If we scrolled forward, put point enough lines down
4662 that it is outside the scroll margin. */
4663 else if (n > 0)
4665 int top_margin;
4667 if (this_scroll_margin > 0)
4669 SET_PT_BOTH (pos, pos_byte);
4670 Fvertical_motion (make_number (this_scroll_margin), window);
4671 top_margin = PT;
4673 else
4674 top_margin = pos;
4676 if (top_margin <= marker_position (opoint_marker))
4677 SET_PT_BOTH (marker_position (opoint_marker),
4678 marker_byte_position (opoint_marker));
4679 else if (!NILP (Vscroll_preserve_screen_position))
4681 SET_PT_BOTH (pos, pos_byte);
4682 Fvertical_motion (original_pos, window);
4684 else
4685 SET_PT (top_margin);
4687 else if (n < 0)
4689 int bottom_margin;
4691 /* If we scrolled backward, put point near the end of the window
4692 but not within the scroll margin. */
4693 SET_PT_BOTH (pos, pos_byte);
4694 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
4695 if (XFASTINT (tem) == ht - this_scroll_margin)
4696 bottom_margin = PT;
4697 else
4698 bottom_margin = PT + 1;
4700 if (bottom_margin > marker_position (opoint_marker))
4701 SET_PT_BOTH (marker_position (opoint_marker),
4702 marker_byte_position (opoint_marker));
4703 else
4705 if (!NILP (Vscroll_preserve_screen_position))
4707 SET_PT_BOTH (pos, pos_byte);
4708 Fvertical_motion (original_pos, window);
4710 else
4711 Fvertical_motion (make_number (-1), window);
4715 else
4717 if (noerror)
4718 return;
4719 else
4720 xsignal0 (Qend_of_buffer);
4725 /* Scroll selected_window up or down. If N is nil, scroll a
4726 screen-full which is defined as the height of the window minus
4727 next_screen_context_lines. If N is the symbol `-', scroll.
4728 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
4729 up. This is the guts of Fscroll_up and Fscroll_down. */
4731 static void
4732 scroll_command (Lisp_Object n, int direction)
4734 int count = SPECPDL_INDEX ();
4736 xassert (eabs (direction) == 1);
4738 /* If selected window's buffer isn't current, make it current for
4739 the moment. But don't screw up if window_scroll gets an error. */
4740 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
4742 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4743 Fset_buffer (XWINDOW (selected_window)->buffer);
4745 /* Make redisplay consider other windows than just selected_window. */
4746 ++windows_or_buffers_changed;
4749 if (NILP (n))
4750 window_scroll (selected_window, direction, 1, 0);
4751 else if (EQ (n, Qminus))
4752 window_scroll (selected_window, -direction, 1, 0);
4753 else
4755 n = Fprefix_numeric_value (n);
4756 window_scroll (selected_window, XINT (n) * direction, 0, 0);
4759 unbind_to (count, Qnil);
4762 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
4763 doc: /* Scroll text of selected window upward ARG lines.
4764 If ARG is omitted or nil, scroll upward by a near full screen.
4765 A near full screen is `next-screen-context-lines' less than a full screen.
4766 Negative ARG means scroll downward.
4767 If ARG is the atom `-', scroll downward by nearly full screen.
4768 When calling from a program, supply as argument a number, nil, or `-'. */)
4769 (Lisp_Object arg)
4771 scroll_command (arg, 1);
4772 return Qnil;
4775 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
4776 doc: /* Scroll text of selected window down ARG lines.
4777 If ARG is omitted or nil, scroll down by a near full screen.
4778 A near full screen is `next-screen-context-lines' less than a full screen.
4779 Negative ARG means scroll upward.
4780 If ARG is the atom `-', scroll upward by nearly full screen.
4781 When calling from a program, supply as argument a number, nil, or `-'. */)
4782 (Lisp_Object arg)
4784 scroll_command (arg, -1);
4785 return Qnil;
4788 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
4789 doc: /* Return the other window for \"other window scroll\" commands.
4790 If `other-window-scroll-buffer' is non-nil, a window
4791 showing that buffer is used.
4792 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4793 specifies the window. This takes precedence over
4794 `other-window-scroll-buffer'. */)
4795 (void)
4797 Lisp_Object window;
4799 if (MINI_WINDOW_P (XWINDOW (selected_window))
4800 && !NILP (Vminibuf_scroll_window))
4801 window = Vminibuf_scroll_window;
4802 /* If buffer is specified, scroll that buffer. */
4803 else if (!NILP (Vother_window_scroll_buffer))
4805 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
4806 if (NILP (window))
4807 window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil);
4809 else
4811 /* Nothing specified; look for a neighboring window on the same
4812 frame. */
4813 window = Fnext_window (selected_window, Qnil, Qnil);
4815 if (EQ (window, selected_window))
4816 /* That didn't get us anywhere; look for a window on another
4817 visible frame. */
4819 window = Fnext_window (window, Qnil, Qt);
4820 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
4821 && ! EQ (window, selected_window));
4824 CHECK_LIVE_WINDOW (window);
4826 if (EQ (window, selected_window))
4827 error ("There is no other window");
4829 return window;
4832 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
4833 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
4834 A near full screen is `next-screen-context-lines' less than a full screen.
4835 The next window is the one below the current one; or the one at the top
4836 if the current one is at the bottom. Negative ARG means scroll downward.
4837 If ARG is the atom `-', scroll downward by nearly full screen.
4838 When calling from a program, supply as argument a number, nil, or `-'.
4840 If `other-window-scroll-buffer' is non-nil, scroll the window
4841 showing that buffer, popping the buffer up if necessary.
4842 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4843 specifies the window to scroll. This takes precedence over
4844 `other-window-scroll-buffer'. */)
4845 (Lisp_Object arg)
4847 Lisp_Object window;
4848 struct window *w;
4849 int count = SPECPDL_INDEX ();
4851 window = Fother_window_for_scrolling ();
4852 w = XWINDOW (window);
4854 /* Don't screw up if window_scroll gets an error. */
4855 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4856 ++windows_or_buffers_changed;
4858 Fset_buffer (w->buffer);
4859 SET_PT (marker_position (w->pointm));
4861 if (NILP (arg))
4862 window_scroll (window, 1, 1, 1);
4863 else if (EQ (arg, Qminus))
4864 window_scroll (window, -1, 1, 1);
4865 else
4867 if (CONSP (arg))
4868 arg = Fcar (arg);
4869 CHECK_NUMBER (arg);
4870 window_scroll (window, XINT (arg), 0, 1);
4873 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
4874 unbind_to (count, Qnil);
4876 return Qnil;
4879 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
4880 doc: /* Scroll selected window display ARG columns left.
4881 Default for ARG is window width minus 2.
4882 Value is the total amount of leftward horizontal scrolling in
4883 effect after the change.
4884 If SET-MINIMUM is non-nil, the new scroll amount becomes the
4885 lower bound for automatic scrolling, i.e. automatic scrolling
4886 will not scroll a window to a column less than the value returned
4887 by this function. This happens in an interactive call. */)
4888 (register Lisp_Object arg, Lisp_Object set_minimum)
4890 Lisp_Object result;
4891 int hscroll;
4892 struct window *w = XWINDOW (selected_window);
4894 if (NILP (arg))
4895 XSETFASTINT (arg, window_body_cols (w) - 2);
4896 else
4897 arg = Fprefix_numeric_value (arg);
4899 hscroll = XINT (w->hscroll) + XINT (arg);
4900 result = Fset_window_hscroll (selected_window, make_number (hscroll));
4902 if (!NILP (set_minimum))
4903 w->min_hscroll = w->hscroll;
4905 return result;
4908 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
4909 doc: /* Scroll selected window display ARG columns right.
4910 Default for ARG is window width minus 2.
4911 Value is the total amount of leftward horizontal scrolling in
4912 effect after the change.
4913 If SET-MINIMUM is non-nil, the new scroll amount becomes the
4914 lower bound for automatic scrolling, i.e. automatic scrolling
4915 will not scroll a window to a column less than the value returned
4916 by this function. This happens in an interactive call. */)
4917 (register Lisp_Object arg, Lisp_Object set_minimum)
4919 Lisp_Object result;
4920 int hscroll;
4921 struct window *w = XWINDOW (selected_window);
4923 if (NILP (arg))
4924 XSETFASTINT (arg, window_body_cols (w) - 2);
4925 else
4926 arg = Fprefix_numeric_value (arg);
4928 hscroll = XINT (w->hscroll) - XINT (arg);
4929 result = Fset_window_hscroll (selected_window, make_number (hscroll));
4931 if (!NILP (set_minimum))
4932 w->min_hscroll = w->hscroll;
4934 return result;
4937 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
4938 doc: /* Return the window which was selected when entering the minibuffer.
4939 Returns nil, if selected window is not a minibuffer window. */)
4940 (void)
4942 if (minibuf_level > 0
4943 && MINI_WINDOW_P (XWINDOW (selected_window))
4944 && WINDOW_LIVE_P (minibuf_selected_window))
4945 return minibuf_selected_window;
4947 return Qnil;
4950 /* Value is the number of lines actually displayed in window W,
4951 as opposed to its height. */
4953 static int
4954 displayed_window_lines (struct window *w)
4956 struct it it;
4957 struct text_pos start;
4958 int height = window_box_height (w);
4959 struct buffer *old_buffer;
4960 int bottom_y;
4961 void *itdata = NULL;
4963 if (XBUFFER (w->buffer) != current_buffer)
4965 old_buffer = current_buffer;
4966 set_buffer_internal (XBUFFER (w->buffer));
4968 else
4969 old_buffer = NULL;
4971 /* In case W->start is out of the accessible range, do something
4972 reasonable. This happens in Info mode when Info-scroll-down
4973 calls (recenter -1) while W->start is 1. */
4974 if (XMARKER (w->start)->charpos < BEGV)
4975 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
4976 else if (XMARKER (w->start)->charpos > ZV)
4977 SET_TEXT_POS (start, ZV, ZV_BYTE);
4978 else
4979 SET_TEXT_POS_FROM_MARKER (start, w->start);
4981 itdata = bidi_shelve_cache ();
4982 start_display (&it, w, start);
4983 move_it_vertically (&it, height);
4984 bottom_y = line_bottom_y (&it);
4985 bidi_unshelve_cache (itdata, 0);
4987 /* rms: On a non-window display,
4988 the value of it.vpos at the bottom of the screen
4989 seems to be 1 larger than window_box_height (w).
4990 This kludge fixes a bug whereby (move-to-window-line -1)
4991 when ZV is on the last screen line
4992 moves to the previous screen line instead of the last one. */
4993 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
4994 height++;
4996 /* Add in empty lines at the bottom of the window. */
4997 if (bottom_y < height)
4999 int uy = FRAME_LINE_HEIGHT (it.f);
5000 it.vpos += (height - bottom_y + uy - 1) / uy;
5003 if (old_buffer)
5004 set_buffer_internal (old_buffer);
5006 return it.vpos;
5010 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
5011 doc: /* Center point in selected window and maybe redisplay frame.
5012 With prefix argument ARG, recenter putting point on screen line ARG
5013 relative to the selected window. If ARG is negative, it counts up from the
5014 bottom of the window. (ARG should be less than the height of the window.)
5016 If ARG is omitted or nil, then recenter with point on the middle line of
5017 the selected window; if the variable `recenter-redisplay' is non-nil,
5018 also erase the entire frame and redraw it (when `auto-resize-tool-bars'
5019 is set to `grow-only', this resets the tool-bar's height to the minimum
5020 height needed); if `recenter-redisplay' has the special value `tty',
5021 then only tty frames are redrawn.
5023 Just C-u as prefix means put point in the center of the window
5024 and redisplay normally--don't erase and redraw the frame. */)
5025 (register Lisp_Object arg)
5027 struct window *w = XWINDOW (selected_window);
5028 struct buffer *buf = XBUFFER (w->buffer);
5029 struct buffer *obuf = current_buffer;
5030 int center_p = 0;
5031 EMACS_INT charpos, bytepos;
5032 EMACS_INT iarg IF_LINT (= 0);
5033 int this_scroll_margin;
5035 /* If redisplay is suppressed due to an error, try again. */
5036 obuf->display_error_modiff = 0;
5038 if (NILP (arg))
5040 if (!NILP (Vrecenter_redisplay)
5041 && (!EQ (Vrecenter_redisplay, Qtty)
5042 || !NILP (Ftty_type (selected_frame))))
5044 ptrdiff_t i;
5046 /* Invalidate pixel data calculated for all compositions. */
5047 for (i = 0; i < n_compositions; i++)
5048 composition_table[i]->font = NULL;
5050 WINDOW_XFRAME (w)->minimize_tool_bar_window_p = 1;
5052 Fredraw_frame (WINDOW_FRAME (w));
5053 SET_FRAME_GARBAGED (WINDOW_XFRAME (w));
5056 center_p = 1;
5058 else if (CONSP (arg)) /* Just C-u. */
5059 center_p = 1;
5060 else
5062 arg = Fprefix_numeric_value (arg);
5063 CHECK_NUMBER (arg);
5064 iarg = XINT (arg);
5067 set_buffer_internal (buf);
5069 /* Do this after making BUF current
5070 in case scroll_margin is buffer-local. */
5071 this_scroll_margin =
5072 max (0, min (scroll_margin, XFASTINT (w->total_lines) / 4));
5074 /* Handle centering on a graphical frame specially. Such frames can
5075 have variable-height lines and centering point on the basis of
5076 line counts would lead to strange effects. */
5077 if (FRAME_WINDOW_P (XFRAME (w->frame)))
5079 if (center_p)
5081 struct it it;
5082 struct text_pos pt;
5083 void *itdata = bidi_shelve_cache ();
5085 SET_TEXT_POS (pt, PT, PT_BYTE);
5086 start_display (&it, w, pt);
5087 move_it_vertically_backward (&it, window_box_height (w) / 2);
5088 charpos = IT_CHARPOS (it);
5089 bytepos = IT_BYTEPOS (it);
5090 bidi_unshelve_cache (itdata, 0);
5092 else if (iarg < 0)
5094 struct it it;
5095 struct text_pos pt;
5096 int nlines = min (INT_MAX, -iarg);
5097 int extra_line_spacing;
5098 int h = window_box_height (w);
5099 void *itdata = bidi_shelve_cache ();
5101 iarg = - max (-iarg, this_scroll_margin);
5103 SET_TEXT_POS (pt, PT, PT_BYTE);
5104 start_display (&it, w, pt);
5106 /* Be sure we have the exact height of the full line containing PT. */
5107 move_it_by_lines (&it, 0);
5109 /* The amount of pixels we have to move back is the window
5110 height minus what's displayed in the line containing PT,
5111 and the lines below. */
5112 it.current_y = 0;
5113 it.vpos = 0;
5114 move_it_by_lines (&it, nlines);
5116 if (it.vpos == nlines)
5117 h -= it.current_y;
5118 else
5120 /* Last line has no newline */
5121 h -= line_bottom_y (&it);
5122 it.vpos++;
5125 /* Don't reserve space for extra line spacing of last line. */
5126 extra_line_spacing = it.max_extra_line_spacing;
5128 /* If we can't move down NLINES lines because we hit
5129 the end of the buffer, count in some empty lines. */
5130 if (it.vpos < nlines)
5132 nlines -= it.vpos;
5133 extra_line_spacing = it.extra_line_spacing;
5134 h -= nlines * (FRAME_LINE_HEIGHT (it.f) + extra_line_spacing);
5136 if (h <= 0)
5138 bidi_unshelve_cache (itdata, 0);
5139 return Qnil;
5142 /* Now find the new top line (starting position) of the window. */
5143 start_display (&it, w, pt);
5144 it.current_y = 0;
5145 move_it_vertically_backward (&it, h);
5147 /* If extra line spacing is present, we may move too far
5148 back. This causes the last line to be only partially
5149 visible (which triggers redisplay to recenter that line
5150 in the middle), so move forward.
5151 But ignore extra line spacing on last line, as it is not
5152 considered to be part of the visible height of the line.
5154 h += extra_line_spacing;
5155 while (-it.current_y > h)
5156 move_it_by_lines (&it, 1);
5158 charpos = IT_CHARPOS (it);
5159 bytepos = IT_BYTEPOS (it);
5161 bidi_unshelve_cache (itdata, 0);
5163 else
5165 struct position pos;
5167 iarg = max (iarg, this_scroll_margin);
5169 pos = *vmotion (PT, -iarg, w);
5170 charpos = pos.bufpos;
5171 bytepos = pos.bytepos;
5174 else
5176 struct position pos;
5177 int ht = window_internal_height (w);
5179 if (center_p)
5180 iarg = ht / 2;
5181 else if (iarg < 0)
5182 iarg += ht;
5184 /* Don't let it get into the margin at either top or bottom. */
5185 iarg = max (iarg, this_scroll_margin);
5186 iarg = min (iarg, ht - this_scroll_margin - 1);
5188 pos = *vmotion (PT, - iarg, w);
5189 charpos = pos.bufpos;
5190 bytepos = pos.bytepos;
5193 /* Set the new window start. */
5194 set_marker_both (w->start, w->buffer, charpos, bytepos);
5195 w->window_end_valid = Qnil;
5197 w->optional_new_start = Qt;
5199 if (bytepos == BEGV_BYTE || FETCH_BYTE (bytepos - 1) == '\n')
5200 w->start_at_line_beg = Qt;
5201 else
5202 w->start_at_line_beg = Qnil;
5204 set_buffer_internal (obuf);
5205 return Qnil;
5208 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5209 0, 1, 0,
5210 doc: /* Return the height in lines of the text display area of WINDOW.
5211 If WINDOW is omitted or nil, it defaults to the selected window.
5213 The returned height does not include the mode line, any header line,
5214 nor any partial-height lines at the bottom of the text area. */)
5215 (Lisp_Object window)
5217 struct window *w = decode_window (window);
5218 int pixel_height = window_box_height (w);
5219 int line_height = pixel_height / FRAME_LINE_HEIGHT (XFRAME (w->frame));
5220 return make_number (line_height);
5225 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
5226 1, 1, "P",
5227 doc: /* Position point relative to window.
5228 ARG nil means position point at center of window.
5229 Else, ARG specifies vertical position within the window;
5230 zero means top of window, negative means relative to bottom of window. */)
5231 (Lisp_Object arg)
5233 struct window *w = XWINDOW (selected_window);
5234 int lines, start;
5235 Lisp_Object window;
5236 #if 0
5237 int this_scroll_margin;
5238 #endif
5240 if (!(BUFFERP (w->buffer)
5241 && XBUFFER (w->buffer) == current_buffer))
5242 /* This test is needed to make sure PT/PT_BYTE make sense in w->buffer
5243 when passed below to set_marker_both. */
5244 error ("move-to-window-line called from unrelated buffer");
5246 window = selected_window;
5247 start = marker_position (w->start);
5248 if (start < BEGV || start > ZV)
5250 int height = window_internal_height (w);
5251 Fvertical_motion (make_number (- (height / 2)), window);
5252 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
5253 w->start_at_line_beg = Fbolp ();
5254 w->force_start = Qt;
5256 else
5257 Fgoto_char (w->start);
5259 lines = displayed_window_lines (w);
5261 #if 0
5262 this_scroll_margin = max (0, min (scroll_margin, lines / 4));
5263 #endif
5265 if (NILP (arg))
5266 XSETFASTINT (arg, lines / 2);
5267 else
5269 EMACS_INT iarg = XINT (Fprefix_numeric_value (arg));
5271 if (iarg < 0)
5272 iarg = iarg + lines;
5274 #if 0 /* This code would prevent move-to-window-line from moving point
5275 to a place inside the scroll margins (which would cause the
5276 next redisplay to scroll). I wrote this code, but then concluded
5277 it is probably better not to install it. However, it is here
5278 inside #if 0 so as not to lose it. -- rms. */
5280 /* Don't let it get into the margin at either top or bottom. */
5281 iarg = max (iarg, this_scroll_margin);
5282 iarg = min (iarg, lines - this_scroll_margin - 1);
5283 #endif
5285 arg = make_number (iarg);
5288 /* Skip past a partially visible first line. */
5289 if (w->vscroll)
5290 XSETINT (arg, XINT (arg) + 1);
5292 return Fvertical_motion (arg, window);
5297 /***********************************************************************
5298 Window Configuration
5299 ***********************************************************************/
5301 struct save_window_data
5303 struct vectorlike_header header;
5304 Lisp_Object selected_frame;
5305 Lisp_Object current_window;
5306 Lisp_Object current_buffer;
5307 Lisp_Object minibuf_scroll_window;
5308 Lisp_Object minibuf_selected_window;
5309 Lisp_Object root_window;
5310 Lisp_Object focus_frame;
5311 /* A vector, each of whose elements is a struct saved_window
5312 for one window. */
5313 Lisp_Object saved_windows;
5315 /* All fields above are traced by the GC.
5316 From `fame-cols' down, the fields are ignored by the GC. */
5318 int frame_cols, frame_lines, frame_menu_bar_lines;
5319 int frame_tool_bar_lines;
5322 /* This is saved as a Lisp_Vector */
5323 struct saved_window
5325 struct vectorlike_header header;
5327 Lisp_Object window, buffer, start, pointm, mark;
5328 Lisp_Object left_col, top_line, total_cols, total_lines;
5329 Lisp_Object normal_cols, normal_lines;
5330 Lisp_Object hscroll, min_hscroll;
5331 Lisp_Object parent, prev;
5332 Lisp_Object start_at_line_beg;
5333 Lisp_Object display_table;
5334 Lisp_Object left_margin_cols, right_margin_cols;
5335 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
5336 Lisp_Object scroll_bar_width, vertical_scroll_bar_type, dedicated;
5337 Lisp_Object combination_limit, window_parameters;
5340 #define SAVED_WINDOW_N(swv,n) \
5341 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5343 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
5344 doc: /* Return t if OBJECT is a window-configuration object. */)
5345 (Lisp_Object object)
5347 return WINDOW_CONFIGURATIONP (object) ? Qt : Qnil;
5350 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
5351 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5352 (Lisp_Object config)
5354 register struct save_window_data *data;
5355 struct Lisp_Vector *saved_windows;
5357 CHECK_WINDOW_CONFIGURATION (config);
5359 data = (struct save_window_data *) XVECTOR (config);
5360 saved_windows = XVECTOR (data->saved_windows);
5361 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5364 DEFUN ("set-window-configuration", Fset_window_configuration,
5365 Sset_window_configuration, 1, 1, 0,
5366 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5367 CONFIGURATION must be a value previously returned
5368 by `current-window-configuration' (which see).
5369 If CONFIGURATION was made from a frame that is now deleted,
5370 only frame-independent values can be restored. In this case,
5371 the return value is nil. Otherwise the value is t. */)
5372 (Lisp_Object configuration)
5374 register struct save_window_data *data;
5375 struct Lisp_Vector *saved_windows;
5376 Lisp_Object new_current_buffer;
5377 Lisp_Object frame;
5378 Lisp_Object auto_buffer_name;
5379 FRAME_PTR f;
5380 EMACS_INT old_point = -1;
5382 CHECK_WINDOW_CONFIGURATION (configuration);
5384 data = (struct save_window_data *) XVECTOR (configuration);
5385 saved_windows = XVECTOR (data->saved_windows);
5387 new_current_buffer = data->current_buffer;
5388 if (NILP (BVAR (XBUFFER (new_current_buffer), name)))
5389 new_current_buffer = Qnil;
5390 else
5392 if (XBUFFER (new_current_buffer) == current_buffer)
5393 /* The code further down "preserves point" by saving here PT in
5394 old_point and then setting it later back into PT. When the
5395 current-selected-window and the final-selected-window both show
5396 the current buffer, this suffers from the problem that the
5397 current PT is the window-point of the current-selected-window,
5398 while the final PT is the point of the final-selected-window, so
5399 this copy from one PT to the other would end up moving the
5400 window-point of the final-selected-window to the window-point of
5401 the current-selected-window. So we have to be careful which
5402 point of the current-buffer we copy into old_point. */
5403 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5404 && WINDOWP (selected_window)
5405 && EQ (XWINDOW (selected_window)->buffer, new_current_buffer)
5406 && !EQ (selected_window, data->current_window))
5407 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5408 else
5409 old_point = PT;
5410 else
5411 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
5412 point in new_current_buffer as of the last time this buffer was
5413 used. This can be non-deterministic since it can be changed by
5414 things like jit-lock by mere temporary selection of some random
5415 window that happens to show this buffer.
5416 So if possible we want this arbitrary choice of "which point" to
5417 be the one from the to-be-selected-window so as to prevent this
5418 window's cursor from being copied from another window. */
5419 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5420 /* If current_window = selected_window, its point is in BUF_PT. */
5421 && !EQ (selected_window, data->current_window))
5422 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5423 else
5424 old_point = BUF_PT (XBUFFER (new_current_buffer));
5427 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5428 f = XFRAME (frame);
5430 /* If f is a dead frame, don't bother rebuilding its window tree.
5431 However, there is other stuff we should still try to do below. */
5432 if (FRAME_LIVE_P (f))
5434 Lisp_Object window;
5435 Lisp_Object dead_windows = Qnil;
5436 register Lisp_Object tem, par, pers;
5437 register struct window *w;
5438 register struct saved_window *p;
5439 struct window *root_window;
5440 struct window **leaf_windows;
5441 int n_leaf_windows;
5442 ptrdiff_t k;
5443 int i, n;
5445 /* If the frame has been resized since this window configuration was
5446 made, we change the frame to the size specified in the
5447 configuration, restore the configuration, and then resize it
5448 back. We keep track of the prevailing height in these variables. */
5449 int previous_frame_lines = FRAME_LINES (f);
5450 int previous_frame_cols = FRAME_COLS (f);
5451 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
5452 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
5454 /* The mouse highlighting code could get screwed up
5455 if it runs during this. */
5456 BLOCK_INPUT;
5458 if (data->frame_lines != previous_frame_lines
5459 || data->frame_cols != previous_frame_cols)
5460 change_frame_size (f, data->frame_lines,
5461 data->frame_cols, 0, 0, 0);
5462 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5463 if (data->frame_menu_bar_lines
5464 != previous_frame_menu_bar_lines)
5465 x_set_menu_bar_lines (f, make_number (data->frame_menu_bar_lines),
5466 make_number (0));
5467 #ifdef HAVE_WINDOW_SYSTEM
5468 if (data->frame_tool_bar_lines
5469 != previous_frame_tool_bar_lines)
5470 x_set_tool_bar_lines (f, make_number (data->frame_tool_bar_lines),
5471 make_number (0));
5472 #endif
5473 #endif
5475 /* "Swap out" point from the selected window's buffer
5476 into the window itself. (Normally the pointm of the selected
5477 window holds garbage.) We do this now, before
5478 restoring the window contents, and prevent it from
5479 being done later on when we select a new window. */
5480 if (! NILP (XWINDOW (selected_window)->buffer))
5482 w = XWINDOW (selected_window);
5483 set_marker_both (w->pointm,
5484 w->buffer,
5485 BUF_PT (XBUFFER (w->buffer)),
5486 BUF_PT_BYTE (XBUFFER (w->buffer)));
5489 windows_or_buffers_changed++;
5490 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
5492 /* Problem: Freeing all matrices and later allocating them again
5493 is a serious redisplay flickering problem. What we would
5494 really like to do is to free only those matrices not reused
5495 below. */
5496 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
5497 leaf_windows
5498 = (struct window **) alloca (count_windows (root_window)
5499 * sizeof (struct window *));
5500 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
5502 /* Kludge Alert!
5503 Mark all windows now on frame as "deleted".
5504 Restoring the new configuration "undeletes" any that are in it.
5506 Save their current buffers in their height fields, since we may
5507 need it later, if a buffer saved in the configuration is now
5508 dead. */
5509 delete_all_child_windows (FRAME_ROOT_WINDOW (f));
5511 for (k = 0; k < saved_windows->header.size; k++)
5513 p = SAVED_WINDOW_N (saved_windows, k);
5514 window = p->window;
5515 w = XWINDOW (window);
5516 w->next = Qnil;
5518 if (!NILP (p->parent))
5519 w->parent = SAVED_WINDOW_N (saved_windows,
5520 XFASTINT (p->parent))->window;
5521 else
5522 w->parent = Qnil;
5524 if (!NILP (p->prev))
5526 w->prev = SAVED_WINDOW_N (saved_windows,
5527 XFASTINT (p->prev))->window;
5528 XWINDOW (w->prev)->next = p->window;
5530 else
5532 w->prev = Qnil;
5533 if (!NILP (w->parent))
5535 if (EQ (p->total_cols, XWINDOW (w->parent)->total_cols))
5537 XWINDOW (w->parent)->vchild = p->window;
5538 XWINDOW (w->parent)->hchild = Qnil;
5540 else
5542 XWINDOW (w->parent)->hchild = p->window;
5543 XWINDOW (w->parent)->vchild = Qnil;
5548 /* If we squirreled away the buffer in the window's height,
5549 restore it now. */
5550 if (BUFFERP (w->total_lines))
5551 w->buffer = w->total_lines;
5552 w->left_col = p->left_col;
5553 w->top_line = p->top_line;
5554 w->total_cols = p->total_cols;
5555 w->total_lines = p->total_lines;
5556 w->normal_cols = p->normal_cols;
5557 w->normal_lines = p->normal_lines;
5558 w->hscroll = p->hscroll;
5559 w->min_hscroll = p->min_hscroll;
5560 w->display_table = p->display_table;
5561 w->left_margin_cols = p->left_margin_cols;
5562 w->right_margin_cols = p->right_margin_cols;
5563 w->left_fringe_width = p->left_fringe_width;
5564 w->right_fringe_width = p->right_fringe_width;
5565 w->fringes_outside_margins = p->fringes_outside_margins;
5566 w->scroll_bar_width = p->scroll_bar_width;
5567 w->vertical_scroll_bar_type = p->vertical_scroll_bar_type;
5568 w->dedicated = p->dedicated;
5569 w->combination_limit = p->combination_limit;
5570 /* Restore any window parameters that have been saved.
5571 Parameters that have not been saved are left alone. */
5572 for (tem = p->window_parameters; CONSP (tem); tem = XCDR (tem))
5574 pers = XCAR (tem);
5575 if (CONSP (pers))
5577 if (NILP (XCDR (pers)))
5579 par = Fassq (XCAR (pers), w->window_parameters);
5580 if (CONSP (par) && !NILP (XCDR (par)))
5581 /* Reset a parameter to nil if and only if it
5582 has a non-nil association. Don't make new
5583 associations. */
5584 Fsetcdr (par, Qnil);
5586 else
5587 /* Always restore a non-nil value. */
5588 Fset_window_parameter (window, XCAR (pers), XCDR (pers));
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 /* Recursively delete all child windows reachable via the next, vchild,
5744 and hchild slots of WINDOW. */
5745 void
5746 delete_all_child_windows (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_child_windows (w->next);
5756 w->total_lines = w->buffer; /* See Fset_window_configuration for excuse. */
5758 if (!NILP (w->vchild))
5760 delete_all_child_windows (w->vchild);
5761 w->vchild = Qnil;
5763 else if (!NILP (w->hchild))
5765 delete_all_child_windows (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 meaningful 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;
5822 int hpos = w->phys_cursor.hpos;
5824 if (!(w->phys_cursor.vpos >= 0
5825 && w->phys_cursor.vpos < w->current_matrix->nrows))
5826 return NULL;
5828 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
5829 if (!row->enabled_p)
5830 return NULL;
5832 if (XINT (w->hscroll))
5834 /* When the window is hscrolled, cursor hpos can legitimately be
5835 out of bounds, but we draw the cursor at the corresponding
5836 window margin in that case. */
5837 if (!row->reversed_p && hpos < 0)
5838 hpos = 0;
5839 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
5840 hpos = row->used[TEXT_AREA] - 1;
5843 if (row->used[TEXT_AREA] > hpos
5844 && 0 <= hpos)
5845 glyph = row->glyphs[TEXT_AREA] + hpos;
5846 else
5847 glyph = NULL;
5849 return glyph;
5853 static int
5854 save_window_save (Lisp_Object window, struct Lisp_Vector *vector, int i)
5856 register struct saved_window *p;
5857 register struct window *w;
5858 register Lisp_Object tem, pers, par;
5860 for (;!NILP (window); window = w->next)
5862 p = SAVED_WINDOW_N (vector, i);
5863 w = XWINDOW (window);
5865 XSETFASTINT (w->temslot, i); i++;
5866 p->window = window;
5867 p->buffer = w->buffer;
5868 p->left_col = w->left_col;
5869 p->top_line = w->top_line;
5870 p->total_cols = w->total_cols;
5871 p->total_lines = w->total_lines;
5872 p->normal_cols = w->normal_cols;
5873 p->normal_lines = w->normal_lines;
5874 p->hscroll = w->hscroll;
5875 p->min_hscroll = w->min_hscroll;
5876 p->display_table = w->display_table;
5877 p->left_margin_cols = w->left_margin_cols;
5878 p->right_margin_cols = w->right_margin_cols;
5879 p->left_fringe_width = w->left_fringe_width;
5880 p->right_fringe_width = w->right_fringe_width;
5881 p->fringes_outside_margins = w->fringes_outside_margins;
5882 p->scroll_bar_width = w->scroll_bar_width;
5883 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
5884 p->dedicated = w->dedicated;
5885 p->combination_limit = w->combination_limit;
5886 p->window_parameters = Qnil;
5888 if (!NILP (Vwindow_persistent_parameters))
5890 /* Run cycle detection on Vwindow_persistent_parameters. */
5891 Lisp_Object tortoise, hare;
5893 hare = tortoise = Vwindow_persistent_parameters;
5894 while (CONSP (hare))
5896 hare = XCDR (hare);
5897 if (!CONSP (hare))
5898 break;
5900 hare = XCDR (hare);
5901 tortoise = XCDR (tortoise);
5903 if (EQ (hare, tortoise))
5904 /* Reset Vwindow_persistent_parameters to Qnil. */
5906 Vwindow_persistent_parameters = Qnil;
5907 break;
5911 for (tem = Vwindow_persistent_parameters; CONSP (tem);
5912 tem = XCDR (tem))
5914 pers = XCAR (tem);
5915 /* Save values for persistent window parameters. */
5916 if (CONSP (pers) && !NILP (XCDR (pers)))
5918 par = Fassq (XCAR (pers), w->window_parameters);
5919 if (NILP (par))
5920 /* If the window has no value for the parameter,
5921 make one. */
5922 p->window_parameters = Fcons (Fcons (XCAR (pers), Qnil),
5923 p->window_parameters);
5924 else
5925 /* If the window has a value for the parameter,
5926 save it. */
5927 p->window_parameters = Fcons (Fcons (XCAR (par),
5928 XCDR (par)),
5929 p->window_parameters);
5934 if (!NILP (w->buffer))
5936 /* Save w's value of point in the window configuration. If w
5937 is the selected window, then get the value of point from
5938 the buffer; pointm is garbage in the selected window. */
5939 if (EQ (window, selected_window))
5941 p->pointm = Fmake_marker ();
5942 set_marker_both (p->pointm, w->buffer,
5943 BUF_PT (XBUFFER (w->buffer)),
5944 BUF_PT_BYTE (XBUFFER (w->buffer)));
5946 else
5947 p->pointm = Fcopy_marker (w->pointm, Qnil);
5949 p->start = Fcopy_marker (w->start, Qnil);
5950 p->start_at_line_beg = w->start_at_line_beg;
5952 tem = BVAR (XBUFFER (w->buffer), mark);
5953 p->mark = Fcopy_marker (tem, Qnil);
5955 else
5957 p->pointm = Qnil;
5958 p->start = Qnil;
5959 p->mark = Qnil;
5960 p->start_at_line_beg = Qnil;
5963 if (NILP (w->parent))
5964 p->parent = Qnil;
5965 else
5966 p->parent = XWINDOW (w->parent)->temslot;
5968 if (NILP (w->prev))
5969 p->prev = Qnil;
5970 else
5971 p->prev = XWINDOW (w->prev)->temslot;
5973 if (!NILP (w->vchild))
5974 i = save_window_save (w->vchild, vector, i);
5975 if (!NILP (w->hchild))
5976 i = save_window_save (w->hchild, vector, i);
5979 return i;
5982 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
5983 Scurrent_window_configuration, 0, 1, 0,
5984 doc: /* Return an object representing the current window configuration of FRAME.
5985 If FRAME is nil or omitted, use the selected frame.
5986 This describes the number of windows, their sizes and current buffers,
5987 and for each displayed buffer, where display starts, and the positions of
5988 point and mark. An exception is made for point in the current buffer:
5989 its value is -not- saved.
5990 This also records the currently selected frame, and FRAME's focus
5991 redirection (see `redirect-frame-focus'). The variable
5992 `window-persistent-parameters' specifies which window parameters are
5993 saved by this function. */)
5994 (Lisp_Object frame)
5996 register Lisp_Object tem;
5997 register int n_windows;
5998 register struct save_window_data *data;
5999 register int i;
6000 FRAME_PTR f;
6002 if (NILP (frame))
6003 frame = selected_frame;
6004 CHECK_LIVE_FRAME (frame);
6005 f = XFRAME (frame);
6007 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6008 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
6009 PVEC_WINDOW_CONFIGURATION);
6011 data->frame_cols = FRAME_COLS (f);
6012 data->frame_lines = FRAME_LINES (f);
6013 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6014 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6015 data->selected_frame = selected_frame;
6016 data->current_window = FRAME_SELECTED_WINDOW (f);
6017 XSETBUFFER (data->current_buffer, current_buffer);
6018 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
6019 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
6020 data->root_window = FRAME_ROOT_WINDOW (f);
6021 data->focus_frame = FRAME_FOCUS_FRAME (f);
6022 tem = Fmake_vector (make_number (n_windows), Qnil);
6023 data->saved_windows = tem;
6024 for (i = 0; i < n_windows; i++)
6025 XVECTOR (tem)->contents[i]
6026 = Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil);
6027 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
6028 XSETWINDOW_CONFIGURATION (tem, data);
6029 return (tem);
6032 /***********************************************************************
6033 Marginal Areas
6034 ***********************************************************************/
6036 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
6037 2, 3, 0,
6038 doc: /* Set width of marginal areas of window WINDOW.
6039 If WINDOW is nil, set margins of the currently selected window.
6040 Second arg LEFT-WIDTH specifies the number of character cells to
6041 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6042 does the same for the right marginal area. A nil width parameter
6043 means no margin. */)
6044 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width)
6046 struct window *w = decode_window (window);
6048 /* Translate negative or zero widths to nil.
6049 Margins that are too wide have to be checked elsewhere. */
6051 if (!NILP (left_width))
6053 CHECK_NUMBER (left_width);
6054 if (XINT (left_width) <= 0)
6055 left_width = Qnil;
6058 if (!NILP (right_width))
6060 CHECK_NUMBER (right_width);
6061 if (XINT (right_width) <= 0)
6062 right_width = Qnil;
6065 if (!EQ (w->left_margin_cols, left_width)
6066 || !EQ (w->right_margin_cols, right_width))
6068 w->left_margin_cols = left_width;
6069 w->right_margin_cols = right_width;
6071 adjust_window_margins (w);
6073 ++windows_or_buffers_changed;
6074 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6077 return Qnil;
6081 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
6082 0, 1, 0,
6083 doc: /* Get width of marginal areas of window WINDOW.
6084 If WINDOW is omitted or nil, it defaults to the selected window.
6085 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6086 If a marginal area does not exist, its width will be returned
6087 as nil. */)
6088 (Lisp_Object window)
6090 struct window *w = decode_window (window);
6091 return Fcons (w->left_margin_cols, w->right_margin_cols);
6096 /***********************************************************************
6097 Fringes
6098 ***********************************************************************/
6100 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6101 2, 4, 0,
6102 doc: /* Set the fringe widths of window WINDOW.
6103 If WINDOW is nil, set the fringe widths of the currently selected
6104 window.
6105 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6106 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6107 fringe width. If a fringe width arg is nil, that means to use the
6108 frame's default fringe width. Default fringe widths can be set with
6109 the command `set-fringe-style'.
6110 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6111 outside of the display margins. By default, fringes are drawn between
6112 display marginal areas and the text area. */)
6113 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width, Lisp_Object outside_margins)
6115 struct window *w = decode_window (window);
6117 if (!NILP (left_width))
6118 CHECK_NATNUM (left_width);
6119 if (!NILP (right_width))
6120 CHECK_NATNUM (right_width);
6122 /* Do nothing on a tty. */
6123 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6124 && (!EQ (w->left_fringe_width, left_width)
6125 || !EQ (w->right_fringe_width, right_width)
6126 || !EQ (w->fringes_outside_margins, outside_margins)))
6128 w->left_fringe_width = left_width;
6129 w->right_fringe_width = right_width;
6130 w->fringes_outside_margins = outside_margins;
6132 adjust_window_margins (w);
6134 clear_glyph_matrix (w->current_matrix);
6135 w->window_end_valid = Qnil;
6137 ++windows_or_buffers_changed;
6138 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6141 return Qnil;
6145 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6146 0, 1, 0,
6147 doc: /* Get width of fringes of window WINDOW.
6148 If WINDOW is omitted or nil, it defaults to the selected window.
6149 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6150 (Lisp_Object window)
6152 struct window *w = decode_window (window);
6154 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6155 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6156 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6157 ? Qt : Qnil), Qnil)));
6162 /***********************************************************************
6163 Scroll bars
6164 ***********************************************************************/
6166 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars,
6167 Sset_window_scroll_bars, 2, 4, 0,
6168 doc: /* Set width and type of scroll bars of window WINDOW.
6169 If window is nil, set scroll bars of the currently selected window.
6170 Second parameter WIDTH specifies the pixel width for the scroll bar;
6171 this is automatically adjusted to a multiple of the frame column width.
6172 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6173 bar: left, right, or nil.
6174 If WIDTH is nil, use the frame's scroll-bar width.
6175 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6176 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6177 (Lisp_Object window, Lisp_Object width, Lisp_Object vertical_type, Lisp_Object horizontal_type)
6179 struct window *w = decode_window (window);
6181 if (!NILP (width))
6183 CHECK_NATNUM (width);
6185 if (XINT (width) == 0)
6186 vertical_type = Qnil;
6189 if (!(NILP (vertical_type)
6190 || EQ (vertical_type, Qleft)
6191 || EQ (vertical_type, Qright)
6192 || EQ (vertical_type, Qt)))
6193 error ("Invalid type of vertical scroll bar");
6195 if (!EQ (w->scroll_bar_width, width)
6196 || !EQ (w->vertical_scroll_bar_type, vertical_type))
6198 w->scroll_bar_width = width;
6199 w->vertical_scroll_bar_type = vertical_type;
6201 adjust_window_margins (w);
6203 clear_glyph_matrix (w->current_matrix);
6204 w->window_end_valid = Qnil;
6206 ++windows_or_buffers_changed;
6207 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6210 return Qnil;
6214 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
6215 0, 1, 0,
6216 doc: /* Get width and type of scroll bars of window WINDOW.
6217 If WINDOW is omitted or nil, it defaults to the selected window.
6218 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6219 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6220 value. */)
6221 (Lisp_Object window)
6223 struct window *w = decode_window (window);
6224 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6225 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6226 : WINDOW_SCROLL_BAR_AREA_WIDTH (w))),
6227 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w)),
6228 Fcons (w->vertical_scroll_bar_type,
6229 Fcons (Qnil, Qnil))));
6234 /***********************************************************************
6235 Smooth scrolling
6236 ***********************************************************************/
6238 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
6239 doc: /* Return the amount by which WINDOW is scrolled vertically.
6240 If WINDOW is omitted or nil, it defaults to the selected window.
6241 Normally, value is a multiple of the canonical character height of WINDOW;
6242 optional second arg PIXELS-P means value is measured in pixels. */)
6243 (Lisp_Object window, Lisp_Object pixels_p)
6245 Lisp_Object result;
6246 struct frame *f;
6247 struct window *w;
6249 if (NILP (window))
6250 window = selected_window;
6251 else
6252 CHECK_WINDOW (window);
6253 w = XWINDOW (window);
6254 f = XFRAME (w->frame);
6256 if (FRAME_WINDOW_P (f))
6257 result = (NILP (pixels_p)
6258 ? FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll)
6259 : make_number (-w->vscroll));
6260 else
6261 result = make_number (0);
6262 return result;
6266 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
6267 2, 3, 0,
6268 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
6269 WINDOW nil means use the selected window. Normally, VSCROLL is a
6270 non-negative multiple of the canonical character height of WINDOW;
6271 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
6272 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
6273 corresponds to an integral number of pixels. The return value is the
6274 result of this rounding.
6275 If PIXELS-P is non-nil, the return value is VSCROLL. */)
6276 (Lisp_Object window, Lisp_Object vscroll, Lisp_Object pixels_p)
6278 struct window *w;
6279 struct frame *f;
6281 if (NILP (window))
6282 window = selected_window;
6283 else
6284 CHECK_WINDOW (window);
6285 CHECK_NUMBER_OR_FLOAT (vscroll);
6287 w = XWINDOW (window);
6288 f = XFRAME (w->frame);
6290 if (FRAME_WINDOW_P (f))
6292 int old_dy = w->vscroll;
6294 w->vscroll = - (NILP (pixels_p)
6295 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
6296 : XFLOATINT (vscroll));
6297 w->vscroll = min (w->vscroll, 0);
6299 if (w->vscroll != old_dy)
6301 /* Adjust glyph matrix of the frame if the virtual display
6302 area becomes larger than before. */
6303 if (w->vscroll < 0 && w->vscroll < old_dy)
6304 adjust_glyphs (f);
6306 /* Prevent redisplay shortcuts. */
6307 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
6311 return Fwindow_vscroll (window, pixels_p);
6315 /* Call FN for all leaf windows on frame F. FN is called with the
6316 first argument being a pointer to the leaf window, and with
6317 additional argument USER_DATA. Stops when FN returns 0. */
6319 static void
6320 foreach_window (struct frame *f, int (*fn) (struct window *, void *),
6321 void *user_data)
6323 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6324 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
6325 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
6329 /* Helper function for foreach_window. Call FN for all leaf windows
6330 reachable from W. FN is called with the first argument being a
6331 pointer to the leaf window, and with additional argument USER_DATA.
6332 Stop when FN returns 0. Value is 0 if stopped by FN. */
6334 static int
6335 foreach_window_1 (struct window *w, int (*fn) (struct window *, void *), void *user_data)
6337 int cont;
6339 for (cont = 1; w && cont;)
6341 if (!NILP (w->hchild))
6342 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
6343 else if (!NILP (w->vchild))
6344 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
6345 else
6346 cont = fn (w, user_data);
6348 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6351 return cont;
6355 /* Freeze or unfreeze the window start of W unless it is a
6356 mini-window or the selected window. FREEZE_P non-null means freeze
6357 the window start. */
6359 static int
6360 freeze_window_start (struct window *w, void *freeze_p)
6362 if (MINI_WINDOW_P (w)
6363 || (WINDOWP (selected_window) /* Can be nil in corner cases. */
6364 && (w == XWINDOW (selected_window)
6365 || (MINI_WINDOW_P (XWINDOW (selected_window))
6366 && ! NILP (Vminibuf_scroll_window)
6367 && w == XWINDOW (Vminibuf_scroll_window)))))
6368 freeze_p = NULL;
6370 w->frozen_window_start_p = freeze_p != NULL;
6371 return 1;
6375 /* Freeze or unfreeze the window starts of all leaf windows on frame
6376 F, except the selected window and a mini-window. FREEZE_P non-zero
6377 means freeze the window start. */
6379 void
6380 freeze_window_starts (struct frame *f, int freeze_p)
6382 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
6386 /***********************************************************************
6387 Initialization
6388 ***********************************************************************/
6390 /* Return 1 if window configurations CONFIGURATION1 and CONFIGURATION2
6391 describe the same state of affairs. This is used by Fequal.
6393 ignore_positions non-zero means ignore non-matching scroll positions
6394 and the like.
6396 This ignores a couple of things like the dedication status of
6397 window, combination_limit and the like. This might have to be
6398 fixed. */
6401 compare_window_configurations (Lisp_Object configuration1, Lisp_Object configuration2, int ignore_positions)
6403 register struct save_window_data *d1, *d2;
6404 struct Lisp_Vector *sws1, *sws2;
6405 ptrdiff_t i;
6407 CHECK_WINDOW_CONFIGURATION (configuration1);
6408 CHECK_WINDOW_CONFIGURATION (configuration2);
6410 d1 = (struct save_window_data *) XVECTOR (configuration1);
6411 d2 = (struct save_window_data *) XVECTOR (configuration2);
6412 sws1 = XVECTOR (d1->saved_windows);
6413 sws2 = XVECTOR (d2->saved_windows);
6415 /* Frame settings must match. */
6416 if (d1->frame_cols != d2->frame_cols
6417 || d1->frame_lines != d2->frame_lines
6418 || d1->frame_menu_bar_lines != d2->frame_menu_bar_lines
6419 || !EQ (d1->selected_frame, d2->selected_frame)
6420 || !EQ (d1->current_buffer, d2->current_buffer)
6421 || (!ignore_positions
6422 && (!EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window)
6423 || !EQ (d1->minibuf_selected_window, d2->minibuf_selected_window)))
6424 || !EQ (d1->focus_frame, d2->focus_frame)
6425 /* Verify that the two configurations have the same number of windows. */
6426 || sws1->header.size != sws2->header.size)
6427 return 0;
6429 for (i = 0; i < sws1->header.size; i++)
6431 struct saved_window *sw1, *sw2;
6433 sw1 = SAVED_WINDOW_N (sws1, i);
6434 sw2 = SAVED_WINDOW_N (sws2, i);
6436 if (
6437 /* The "current" windows in the two configurations must
6438 correspond to each other. */
6439 EQ (d1->current_window, sw1->window)
6440 != EQ (d2->current_window, sw2->window)
6441 /* Windows' buffers must match. */
6442 || !EQ (sw1->buffer, sw2->buffer)
6443 || !EQ (sw1->left_col, sw2->left_col)
6444 || !EQ (sw1->top_line, sw2->top_line)
6445 || !EQ (sw1->total_cols, sw2->total_cols)
6446 || !EQ (sw1->total_lines, sw2->total_lines)
6447 || !EQ (sw1->display_table, sw2->display_table)
6448 /* The next two disjuncts check the window structure for
6449 equality. */
6450 || !EQ (sw1->parent, sw2->parent)
6451 || !EQ (sw1->prev, sw2->prev)
6452 || (!ignore_positions
6453 && (!EQ (sw1->hscroll, sw2->hscroll)
6454 || !EQ (sw1->min_hscroll, sw2->min_hscroll)
6455 || !EQ (sw1->start_at_line_beg, sw2->start_at_line_beg)
6456 || NILP (Fequal (sw1->start, sw2->start))
6457 || NILP (Fequal (sw1->pointm, sw2->pointm))
6458 || NILP (Fequal (sw1->mark, sw2->mark))))
6459 || !EQ (sw1->left_margin_cols, sw2->left_margin_cols)
6460 || !EQ (sw1->right_margin_cols, sw2->right_margin_cols)
6461 || !EQ (sw1->left_fringe_width, sw2->left_fringe_width)
6462 || !EQ (sw1->right_fringe_width, sw2->right_fringe_width)
6463 || !EQ (sw1->fringes_outside_margins, sw2->fringes_outside_margins)
6464 || !EQ (sw1->scroll_bar_width, sw2->scroll_bar_width)
6465 || !EQ (sw1->vertical_scroll_bar_type, sw2->vertical_scroll_bar_type))
6466 return 0;
6469 return 1;
6472 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
6473 Scompare_window_configurations, 2, 2, 0,
6474 doc: /* Compare two window configurations as regards the structure of windows.
6475 This function ignores details such as the values of point and mark
6476 and scrolling positions. */)
6477 (Lisp_Object x, Lisp_Object y)
6479 if (compare_window_configurations (x, y, 1))
6480 return Qt;
6481 return Qnil;
6484 void
6485 init_window_once (void)
6487 struct frame *f = make_initial_frame ();
6488 XSETFRAME (selected_frame, f);
6489 Vterminal_frame = selected_frame;
6490 minibuf_window = f->minibuffer_window;
6491 selected_window = f->selected_window;
6492 last_nonminibuf_frame = f;
6494 window_initialized = 1;
6497 void
6498 init_window (void)
6500 Vwindow_list = Qnil;
6503 void
6504 syms_of_window (void)
6506 DEFSYM (Qscroll_up, "scroll-up");
6507 DEFSYM (Qscroll_down, "scroll-down");
6508 DEFSYM (Qscroll_command, "scroll-command");
6510 Fput (Qscroll_up, Qscroll_command, Qt);
6511 Fput (Qscroll_down, Qscroll_command, Qt);
6513 DEFSYM (Qwindow_configuration_change_hook, "window-configuration-change-hook");
6514 DEFSYM (Qwindowp, "windowp");
6515 DEFSYM (Qwindow_configuration_p, "window-configuration-p");
6516 DEFSYM (Qwindow_live_p, "window-live-p");
6517 DEFSYM (Qwindow_deletable_p, "window-deletable-p");
6518 DEFSYM (Qdelete_window, "delete-window");
6519 DEFSYM (Qwindow_resize_root_window, "window--resize-root-window");
6520 DEFSYM (Qwindow_resize_root_window_vertically, "window--resize-root-window-vertically");
6521 DEFSYM (Qsafe, "safe");
6522 DEFSYM (Qdisplay_buffer, "display-buffer");
6523 DEFSYM (Qreplace_buffer_in_windows, "replace-buffer-in-windows");
6524 DEFSYM (Qrecord_window_buffer, "record-window-buffer");
6525 DEFSYM (Qget_mru_window, "get-mru-window");
6526 DEFSYM (Qtemp_buffer_show_hook, "temp-buffer-show-hook");
6527 DEFSYM (Qabove, "above");
6528 DEFSYM (Qbelow, "below");
6529 DEFSYM (Qauto_buffer_name, "auto-buffer-name");
6530 DEFSYM (Qclone_of, "clone-of");
6532 staticpro (&Vwindow_list);
6534 minibuf_selected_window = Qnil;
6535 staticpro (&minibuf_selected_window);
6537 window_scroll_pixel_based_preserve_x = -1;
6538 window_scroll_pixel_based_preserve_y = -1;
6539 window_scroll_preserve_hpos = -1;
6540 window_scroll_preserve_vpos = -1;
6542 DEFVAR_LISP ("temp-buffer-show-function", Vtemp_buffer_show_function,
6543 doc: /* Non-nil means call as function to display a help buffer.
6544 The function is called with one argument, the buffer to be displayed.
6545 Used by `with-output-to-temp-buffer'.
6546 If this function is used, then it must do the entire job of showing
6547 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
6548 Vtemp_buffer_show_function = Qnil;
6550 DEFVAR_LISP ("minibuffer-scroll-window", Vminibuf_scroll_window,
6551 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
6552 Vminibuf_scroll_window = Qnil;
6554 DEFVAR_BOOL ("mode-line-in-non-selected-windows", mode_line_in_non_selected_windows,
6555 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
6556 If the minibuffer is active, the `minibuffer-scroll-window' mode line
6557 is displayed in the `mode-line' face. */);
6558 mode_line_in_non_selected_windows = 1;
6560 DEFVAR_LISP ("other-window-scroll-buffer", Vother_window_scroll_buffer,
6561 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
6562 Vother_window_scroll_buffer = Qnil;
6564 DEFVAR_BOOL ("auto-window-vscroll", auto_window_vscroll_p,
6565 doc: /* Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
6566 auto_window_vscroll_p = 1;
6568 DEFVAR_INT ("next-screen-context-lines", next_screen_context_lines,
6569 doc: /* Number of lines of continuity when scrolling by screenfuls. */);
6570 next_screen_context_lines = 2;
6572 DEFVAR_LISP ("scroll-preserve-screen-position",
6573 Vscroll_preserve_screen_position,
6574 doc: /* Controls if scroll commands move point to keep its screen position unchanged.
6575 A value of nil means point does not keep its screen position except
6576 at the scroll margin or window boundary respectively.
6577 A value of t means point keeps its screen position if the scroll
6578 command moved it vertically out of the window, e.g. when scrolling
6579 by full screens.
6580 Any other value means point always keeps its screen position.
6581 Scroll commands should have the `scroll-command' property
6582 on their symbols to be controlled by this variable. */);
6583 Vscroll_preserve_screen_position = Qnil;
6585 DEFVAR_LISP ("window-point-insertion-type", Vwindow_point_insertion_type,
6586 doc: /* Type of marker to use for `window-point'. */);
6587 Vwindow_point_insertion_type = Qnil;
6589 DEFVAR_LISP ("window-configuration-change-hook",
6590 Vwindow_configuration_change_hook,
6591 doc: /* Functions to call when window configuration changes.
6592 The buffer-local part is run once per window, with the relevant window
6593 selected; while the global part is run only once for the modified frame,
6594 with the relevant frame selected. */);
6595 Vwindow_configuration_change_hook = Qnil;
6597 DEFVAR_LISP ("recenter-redisplay", Vrecenter_redisplay,
6598 doc: /* Non-nil means `recenter' redraws entire frame.
6599 If this option is non-nil, then the `recenter' command with a nil
6600 argument will redraw the entire frame; the special value `tty' causes
6601 the frame to be redrawn only if it is a tty frame. */);
6602 Vrecenter_redisplay = Qtty;
6604 DEFVAR_LISP ("window-combination-resize", Vwindow_combination_resize,
6605 doc: /* If t, resize window combinations proportionally.
6606 If this variable is nil, splitting a window gets the entire screen space
6607 for displaying the new window from the window to split. Deleting and
6608 resizing a window preferably resizes one adjacent window only.
6610 If this variable is t, splitting a window tries to get the space
6611 proportionally from all windows in the same combination. This also
6612 allows to split a window that is otherwise too small or of fixed size.
6613 Resizing and deleting a window proportionally resize all windows in the
6614 same combination.
6616 Other values are reserved for future use.
6618 This variable takes no effect if `window-combination-limit' is non-nil. */);
6619 Vwindow_combination_resize = Qnil;
6621 DEFVAR_LISP ("window-combination-limit", Vwindow_combination_limit,
6622 doc: /* If t, splitting a window makes a new parent window.
6623 If this variable is nil, splitting a window will create a new parent
6624 window only if the window has no parent window or the window shall
6625 become a combination orthogonal to the one it is part of.
6627 If this variable is t, splitting a window always creates a new parent
6628 window. If all splits behave this way, each frame's window tree is a
6629 binary tree and every window but the frame's root window has exactly one
6630 sibling.
6632 Other values are reserved for future use.
6634 The value of this variable is also assigned to the combination limit of
6635 the new parent window. The combination limit of a window can be
6636 retrieved via the function `window-combination-limit' and altered by the
6637 function `set-window-combination-limit'. */);
6638 Vwindow_combination_limit = Qnil;
6640 DEFVAR_LISP ("window-persistent-parameters", Vwindow_persistent_parameters,
6641 doc: /* Alist of persistent window parameters.
6642 This alist specifies which window parameters shall get saved by
6643 `current-window-configuration' and `window-state-get' and subsequently
6644 restored to their previous values by `set-window-configuration' and
6645 `window-state-put'.
6647 The car of each entry of this alist is the symbol specifying the
6648 parameter. The cdr is one of the following:
6650 nil means the parameter is neither saved by `window-state-get' nor by
6651 `current-window-configuration'.
6653 t means the parameter is saved by `current-window-configuration' and,
6654 provided its WRITABLE argument is nil, by `window-state-get'.
6656 The symbol `writable' means the parameter is saved unconditionally by
6657 both `current-window-configuration' and `window-state-get'. Do not use
6658 this value for parameters without read syntax (like windows or frames).
6660 Parameters not saved by `current-window-configuration' or
6661 `window-state-get' are left alone by `set-window-configuration'
6662 respectively are not installed by `window-state-put'. */);
6663 Vwindow_persistent_parameters = list1 (Fcons (Qclone_of, Qt));
6665 defsubr (&Sselected_window);
6666 defsubr (&Sminibuffer_window);
6667 defsubr (&Swindow_minibuffer_p);
6668 defsubr (&Swindowp);
6669 defsubr (&Swindow_live_p);
6670 defsubr (&Swindow_frame);
6671 defsubr (&Sframe_root_window);
6672 defsubr (&Sframe_first_window);
6673 defsubr (&Sframe_selected_window);
6674 defsubr (&Sset_frame_selected_window);
6675 defsubr (&Spos_visible_in_window_p);
6676 defsubr (&Swindow_line_height);
6677 defsubr (&Swindow_buffer);
6678 defsubr (&Swindow_parent);
6679 defsubr (&Swindow_top_child);
6680 defsubr (&Swindow_left_child);
6681 defsubr (&Swindow_next_sibling);
6682 defsubr (&Swindow_prev_sibling);
6683 defsubr (&Swindow_combination_limit);
6684 defsubr (&Sset_window_combination_limit);
6685 defsubr (&Swindow_use_time);
6686 defsubr (&Swindow_top_line);
6687 defsubr (&Swindow_left_column);
6688 defsubr (&Swindow_total_height);
6689 defsubr (&Swindow_total_width);
6690 defsubr (&Swindow_normal_size);
6691 defsubr (&Swindow_new_total);
6692 defsubr (&Swindow_new_normal);
6693 defsubr (&Sset_window_new_total);
6694 defsubr (&Sset_window_new_normal);
6695 defsubr (&Swindow_resize_apply);
6696 defsubr (&Swindow_body_height);
6697 defsubr (&Swindow_body_width);
6698 defsubr (&Swindow_hscroll);
6699 defsubr (&Sset_window_hscroll);
6700 defsubr (&Swindow_redisplay_end_trigger);
6701 defsubr (&Sset_window_redisplay_end_trigger);
6702 defsubr (&Swindow_edges);
6703 defsubr (&Swindow_pixel_edges);
6704 defsubr (&Swindow_absolute_pixel_edges);
6705 defsubr (&Swindow_inside_edges);
6706 defsubr (&Swindow_inside_pixel_edges);
6707 defsubr (&Swindow_inside_absolute_pixel_edges);
6708 defsubr (&Scoordinates_in_window_p);
6709 defsubr (&Swindow_at);
6710 defsubr (&Swindow_point);
6711 defsubr (&Swindow_start);
6712 defsubr (&Swindow_end);
6713 defsubr (&Sset_window_point);
6714 defsubr (&Sset_window_start);
6715 defsubr (&Swindow_dedicated_p);
6716 defsubr (&Sset_window_dedicated_p);
6717 defsubr (&Swindow_display_table);
6718 defsubr (&Sset_window_display_table);
6719 defsubr (&Snext_window);
6720 defsubr (&Sprevious_window);
6721 defsubr (&Sget_buffer_window);
6722 defsubr (&Sdelete_other_windows_internal);
6723 defsubr (&Sdelete_window_internal);
6724 defsubr (&Sresize_mini_window_internal);
6725 defsubr (&Sset_window_buffer);
6726 defsubr (&Srun_window_configuration_change_hook);
6727 defsubr (&Sselect_window);
6728 defsubr (&Sforce_window_update);
6729 defsubr (&Stemp_output_buffer_show);
6730 defsubr (&Ssplit_window_internal);
6731 defsubr (&Sscroll_up);
6732 defsubr (&Sscroll_down);
6733 defsubr (&Sscroll_left);
6734 defsubr (&Sscroll_right);
6735 defsubr (&Sother_window_for_scrolling);
6736 defsubr (&Sscroll_other_window);
6737 defsubr (&Sminibuffer_selected_window);
6738 defsubr (&Srecenter);
6739 defsubr (&Swindow_text_height);
6740 defsubr (&Smove_to_window_line);
6741 defsubr (&Swindow_configuration_p);
6742 defsubr (&Swindow_configuration_frame);
6743 defsubr (&Sset_window_configuration);
6744 defsubr (&Scurrent_window_configuration);
6745 defsubr (&Sset_window_margins);
6746 defsubr (&Swindow_margins);
6747 defsubr (&Sset_window_fringes);
6748 defsubr (&Swindow_fringes);
6749 defsubr (&Sset_window_scroll_bars);
6750 defsubr (&Swindow_scroll_bars);
6751 defsubr (&Swindow_vscroll);
6752 defsubr (&Sset_window_vscroll);
6753 defsubr (&Scompare_window_configurations);
6754 defsubr (&Swindow_list);
6755 defsubr (&Swindow_list_1);
6756 defsubr (&Swindow_prev_buffers);
6757 defsubr (&Sset_window_prev_buffers);
6758 defsubr (&Swindow_next_buffers);
6759 defsubr (&Sset_window_next_buffers);
6760 defsubr (&Swindow_parameters);
6761 defsubr (&Swindow_parameter);
6762 defsubr (&Sset_window_parameter);
6765 void
6766 keys_of_window (void)
6768 initial_define_key (control_x_map, '<', "scroll-left");
6769 initial_define_key (control_x_map, '>', "scroll-right");
6771 initial_define_key (global_map, Ctl ('V'), "scroll-up-command");
6772 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
6773 initial_define_key (meta_map, 'v', "scroll-down-command");