* eshell/esh-ext.el (eshell-external-command): Do not restrict
[emacs.git] / src / window.c
blob7965269f0e7a611c8c3c5f3f21495bd1bba8d1fc
1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985-1987, 1993-1998, 2000-2011
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <stdio.h>
23 #include <setjmp.h>
25 #include "lisp.h"
26 #include "buffer.h"
27 #include "keyboard.h"
28 #include "keymap.h"
29 #include "frame.h"
30 #include "window.h"
31 #include "commands.h"
32 #include "indent.h"
33 #include "termchar.h"
34 #include "disptab.h"
35 #include "dispextern.h"
36 #include "blockinput.h"
37 #include "intervals.h"
38 #include "termhooks.h" /* For FRAME_TERMINAL. */
40 #ifdef HAVE_X_WINDOWS
41 #include "xterm.h"
42 #endif /* HAVE_X_WINDOWS */
43 #ifdef WINDOWSNT
44 #include "w32term.h"
45 #endif
46 #ifdef MSDOS
47 #include "msdos.h"
48 #endif
49 #ifdef HAVE_NS
50 #include "nsterm.h"
51 #endif
53 Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
54 Lisp_Object Qdisplay_buffer;
55 Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
56 Lisp_Object Qwindow_size_fixed;
58 static int displayed_window_lines (struct window *);
59 static struct window *decode_window (Lisp_Object);
60 static int count_windows (struct window *);
61 static int get_leaf_windows (struct window *, struct window **, int);
62 static void window_scroll (Lisp_Object, int, int, int);
63 static void window_scroll_pixel_based (Lisp_Object, int, int, int);
64 static void window_scroll_line_based (Lisp_Object, int, int, int);
65 static int window_min_size_1 (struct window *, int, int);
66 static int window_min_size_2 (struct window *, int, int);
67 static int window_min_size (struct window *, int, int, int, int *);
68 static void size_window (Lisp_Object, int, int, int, int, int);
69 static int freeze_window_start (struct window *, void *);
70 static int window_fixed_size_p (struct window *, int, int);
71 static void enlarge_window (Lisp_Object, int, int);
72 static Lisp_Object window_list (void);
73 static int add_window_to_list (struct window *, void *);
74 static int candidate_window_p (Lisp_Object, Lisp_Object, Lisp_Object,
75 Lisp_Object);
76 static Lisp_Object next_window (Lisp_Object, Lisp_Object,
77 Lisp_Object, int);
78 static void decode_next_window_args (Lisp_Object *, Lisp_Object *,
79 Lisp_Object *);
80 static void foreach_window (struct frame *,
81 int (* fn) (struct window *, void *),
82 void *);
83 static int foreach_window_1 (struct window *,
84 int (* fn) (struct window *, void *),
85 void *);
86 static Lisp_Object window_list_1 (Lisp_Object, Lisp_Object, Lisp_Object);
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). */
97 Lisp_Object selected_window;
99 /* A list of all windows for use by next_window and Fwindow_list.
100 Functions creating or deleting windows should invalidate this cache
101 by setting it to nil. */
103 Lisp_Object Vwindow_list;
105 /* The mini-buffer window of the selected frame.
106 Note that you cannot test for mini-bufferness of an arbitrary window
107 by comparing against this; but you can test for mini-bufferness of
108 the selected window. */
110 Lisp_Object minibuf_window;
112 /* Non-nil means it is the window whose mode line should be
113 shown as the selected window when the minibuffer is selected. */
115 Lisp_Object minibuf_selected_window;
117 /* Hook run at end of temp_output_buffer_show. */
119 Lisp_Object Qtemp_buffer_show_hook;
121 /* Incremented for each window created. */
123 static int sequence_number;
125 /* Nonzero after init_window_once has finished. */
127 static int window_initialized;
129 /* Hook to run when window config changes. */
131 static Lisp_Object Qwindow_configuration_change_hook;
132 /* Incremented by 1 whenever a window is deleted. */
134 int window_deletion_count;
136 /* Used by the function window_scroll_pixel_based */
138 static int window_scroll_pixel_based_preserve_x;
139 static int window_scroll_pixel_based_preserve_y;
141 /* Same for window_scroll_line_based. */
143 static int window_scroll_preserve_hpos;
144 static int window_scroll_preserve_vpos;
146 #if 0 /* This isn't used anywhere. */
147 /* Nonzero means we can split a frame even if it is "unsplittable". */
148 static int inhibit_frame_unsplittable;
149 #endif
152 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
153 doc: /* Return t if OBJECT is a window. */)
154 (Lisp_Object object)
156 return WINDOWP (object) ? Qt : Qnil;
159 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
160 doc: /* Return t if OBJECT is a window which is currently visible. */)
161 (Lisp_Object object)
163 return WINDOW_LIVE_P (object) ? Qt : Qnil;
166 Lisp_Object
167 make_window (void)
169 Lisp_Object val;
170 register struct window *p;
172 p = allocate_window ();
173 ++sequence_number;
174 XSETFASTINT (p->sequence_number, sequence_number);
175 XSETFASTINT (p->left_col, 0);
176 XSETFASTINT (p->top_line, 0);
177 XSETFASTINT (p->total_lines, 0);
178 XSETFASTINT (p->total_cols, 0);
179 XSETFASTINT (p->hscroll, 0);
180 XSETFASTINT (p->min_hscroll, 0);
181 p->orig_top_line = p->orig_total_lines = Qnil;
182 p->start = Fmake_marker ();
183 p->pointm = Fmake_marker ();
184 XSETFASTINT (p->use_time, 0);
185 p->frame = Qnil;
186 p->display_table = Qnil;
187 p->dedicated = Qnil;
188 p->window_parameters = Qnil;
189 p->pseudo_window_p = 0;
190 memset (&p->cursor, 0, sizeof (p->cursor));
191 memset (&p->last_cursor, 0, sizeof (p->last_cursor));
192 memset (&p->phys_cursor, 0, sizeof (p->phys_cursor));
193 p->desired_matrix = p->current_matrix = 0;
194 p->nrows_scale_factor = p->ncols_scale_factor = 1;
195 p->phys_cursor_type = -1;
196 p->phys_cursor_width = -1;
197 p->must_be_updated_p = 0;
198 XSETFASTINT (p->window_end_vpos, 0);
199 XSETFASTINT (p->window_end_pos, 0);
200 p->window_end_valid = Qnil;
201 p->vscroll = 0;
202 XSETWINDOW (val, p);
203 XSETFASTINT (p->last_point, 0);
204 p->frozen_window_start_p = 0;
205 p->last_cursor_off_p = p->cursor_off_p = 0;
206 p->left_margin_cols = Qnil;
207 p->right_margin_cols = Qnil;
208 p->left_fringe_width = Qnil;
209 p->right_fringe_width = Qnil;
210 p->fringes_outside_margins = Qnil;
211 p->scroll_bar_width = Qnil;
212 p->vertical_scroll_bar_type = Qt;
213 p->resize_proportionally = Qnil;
215 Vwindow_list = Qnil;
216 return val;
219 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
220 doc: /* Return the window that the cursor now appears in and commands apply to. */)
221 (void)
223 return selected_window;
226 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
227 doc: /* Return the window used now for minibuffers.
228 If the optional argument FRAME is specified, return the minibuffer window
229 used by that frame. */)
230 (Lisp_Object frame)
232 if (NILP (frame))
233 frame = selected_frame;
234 CHECK_LIVE_FRAME (frame);
235 return FRAME_MINIBUF_WINDOW (XFRAME (frame));
238 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
239 doc: /* Return non-nil if WINDOW is a minibuffer window.
240 WINDOW defaults to the selected window. */)
241 (Lisp_Object window)
243 struct window *w = decode_window (window);
244 return MINI_WINDOW_P (w) ? Qt : Qnil;
248 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
249 Spos_visible_in_window_p, 0, 3, 0,
250 doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
251 Return nil if that position is scrolled vertically out of view.
252 If a character is only partially visible, nil is returned, unless the
253 optional argument PARTIALLY is non-nil.
254 If POS is only out of view because of horizontal scrolling, return non-nil.
255 If POS is t, it specifies the position of the last visible glyph in WINDOW.
256 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
258 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
259 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
260 where X and Y are the pixel coordinates relative to the top left corner
261 of the window. The remaining elements are omitted if the character after
262 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
263 off-window at the top and bottom of the row, ROWH is the height of the
264 display row, and VPOS is the row number (0-based) containing POS. */)
265 (Lisp_Object pos, Lisp_Object window, Lisp_Object partially)
267 register struct window *w;
268 register EMACS_INT posint;
269 register struct buffer *buf;
270 struct text_pos top;
271 Lisp_Object in_window = Qnil;
272 int rtop, rbot, rowh, vpos, fully_p = 1;
273 int x, y;
275 w = decode_window (window);
276 buf = XBUFFER (w->buffer);
277 SET_TEXT_POS_FROM_MARKER (top, w->start);
279 if (EQ (pos, Qt))
280 posint = -1;
281 else if (!NILP (pos))
283 CHECK_NUMBER_COERCE_MARKER (pos);
284 posint = XINT (pos);
286 else if (w == XWINDOW (selected_window))
287 posint = PT;
288 else
289 posint = XMARKER (w->pointm)->charpos;
291 /* If position is above window start or outside buffer boundaries,
292 or if window start is out of range, position is not visible. */
293 if ((EQ (pos, Qt)
294 || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
295 && CHARPOS (top) >= BUF_BEGV (buf)
296 && CHARPOS (top) <= BUF_ZV (buf)
297 && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
298 && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
299 in_window = Qt;
301 if (!NILP (in_window) && !NILP (partially))
303 Lisp_Object part = Qnil;
304 if (!fully_p)
305 part = list4 (make_number (rtop), make_number (rbot),
306 make_number (rowh), make_number (vpos));
307 in_window = Fcons (make_number (x),
308 Fcons (make_number (y), part));
311 return in_window;
314 DEFUN ("window-line-height", Fwindow_line_height,
315 Swindow_line_height, 0, 2, 0,
316 doc: /* Return height in pixels of text line LINE in window WINDOW.
317 If WINDOW is nil or omitted, use selected window.
319 Return height of current line if LINE is omitted or nil. Return height of
320 header or mode line if LINE is `header-line' and `mode-line'.
321 Otherwise, LINE is a text line number starting from 0. A negative number
322 counts from the end of the window.
324 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
325 in pixels of the visible part of the line, VPOS and YPOS are the
326 vertical position in lines and pixels of the line, relative to the top
327 of the first text line, and OFFBOT is the number of off-window pixels at
328 the bottom of the text line. If there are off-window pixels at the top
329 of the (first) text line, YPOS is negative.
331 Return nil if window display is not up-to-date. In that case, use
332 `pos-visible-in-window-p' to obtain the information. */)
333 (Lisp_Object line, Lisp_Object window)
335 register struct window *w;
336 register struct buffer *b;
337 struct glyph_row *row, *end_row;
338 int max_y, crop, i, n;
340 w = decode_window (window);
342 if (noninteractive
343 || w->pseudo_window_p)
344 return Qnil;
346 CHECK_BUFFER (w->buffer);
347 b = XBUFFER (w->buffer);
349 /* Fail if current matrix is not up-to-date. */
350 if (NILP (w->window_end_valid)
351 || current_buffer->clip_changed
352 || current_buffer->prevent_redisplay_optimizations_p
353 || XFASTINT (w->last_modified) < BUF_MODIFF (b)
354 || XFASTINT (w->last_overlay_modified) < BUF_OVERLAY_MODIFF (b))
355 return Qnil;
357 if (NILP (line))
359 i = w->cursor.vpos;
360 if (i < 0 || i >= w->current_matrix->nrows
361 || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
362 return Qnil;
363 max_y = window_text_bottom_y (w);
364 goto found_row;
367 if (EQ (line, Qheader_line))
369 if (!WINDOW_WANTS_HEADER_LINE_P (w))
370 return Qnil;
371 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
372 if (!row->enabled_p)
373 return Qnil;
374 return list4 (make_number (row->height),
375 make_number (0), make_number (0),
376 make_number (0));
379 if (EQ (line, Qmode_line))
381 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
382 if (!row->enabled_p)
383 return Qnil;
384 return list4 (make_number (row->height),
385 make_number (0), /* not accurate */
386 make_number (WINDOW_HEADER_LINE_HEIGHT (w)
387 + window_text_bottom_y (w)),
388 make_number (0));
391 CHECK_NUMBER (line);
392 n = XINT (line);
394 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
395 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
396 max_y = window_text_bottom_y (w);
397 i = 0;
399 while ((n < 0 || i < n)
400 && row <= end_row && row->enabled_p
401 && row->y + row->height < max_y)
402 row++, i++;
404 if (row > end_row || !row->enabled_p)
405 return Qnil;
407 if (++n < 0)
409 if (-n > i)
410 return Qnil;
411 row += n;
412 i += n;
415 found_row:
416 crop = max (0, (row->y + row->height) - max_y);
417 return list4 (make_number (row->height + min (0, row->y) - crop),
418 make_number (i),
419 make_number (row->y),
420 make_number (crop));
425 static struct window *
426 decode_window (register Lisp_Object window)
428 if (NILP (window))
429 return XWINDOW (selected_window);
431 CHECK_LIVE_WINDOW (window);
432 return XWINDOW (window);
435 static struct window *
436 decode_any_window (register Lisp_Object window)
438 if (NILP (window))
439 return XWINDOW (selected_window);
441 CHECK_WINDOW (window);
442 return XWINDOW (window);
445 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
446 doc: /* Return the buffer that WINDOW is displaying.
447 WINDOW defaults to the selected window. */)
448 (Lisp_Object window)
450 return decode_window (window)->buffer;
453 DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
454 doc: /* Return the number of lines in WINDOW.
455 WINDOW defaults to the selected window.
457 The return value includes WINDOW's mode line and header line, if any.
459 Note: The function does not take into account the value of `line-spacing'
460 when calculating the number of lines in WINDOW. */)
461 (Lisp_Object window)
463 return decode_any_window (window)->total_lines;
466 DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
467 doc: /* Return the number of display columns in WINDOW.
468 WINDOW defaults to the selected window.
470 Note: The return value is the number of columns available for text in
471 WINDOW. If you want to find out how many columns WINDOW takes up, use
472 (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))). */)
473 (Lisp_Object window)
475 return make_number (window_box_text_cols (decode_any_window (window)));
478 DEFUN ("window-full-width-p", Fwindow_full_width_p, Swindow_full_width_p, 0, 1, 0,
479 doc: /* Return t if WINDOW is as wide as its frame.
480 WINDOW defaults to the selected window. */)
481 (Lisp_Object window)
483 return WINDOW_FULL_WIDTH_P (decode_any_window (window)) ? Qt : Qnil;
486 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
487 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
488 WINDOW defaults to the selected window. */)
489 (Lisp_Object window)
491 return decode_window (window)->hscroll;
494 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
495 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
496 Return NCOL. NCOL should be zero or positive.
498 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
499 window so that the location of point moves off-window. */)
500 (Lisp_Object window, Lisp_Object ncol)
502 struct window *w = decode_window (window);
503 int hscroll;
505 CHECK_NUMBER (ncol);
506 hscroll = max (0, XINT (ncol));
508 /* Prevent redisplay shortcuts when changing the hscroll. */
509 if (XINT (w->hscroll) != hscroll)
510 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
512 w->hscroll = make_number (hscroll);
513 return ncol;
516 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
517 Swindow_redisplay_end_trigger, 0, 1, 0,
518 doc: /* Return WINDOW's redisplay end trigger value.
519 WINDOW defaults to the selected window.
520 See `set-window-redisplay-end-trigger' for more information. */)
521 (Lisp_Object window)
523 return decode_window (window)->redisplay_end_trigger;
526 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
527 Sset_window_redisplay_end_trigger, 2, 2, 0,
528 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
529 VALUE should be a buffer position (typically a marker) or nil.
530 If it is a buffer position, then if redisplay in WINDOW reaches a position
531 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
532 with two arguments: WINDOW, and the end trigger value.
533 Afterwards the end-trigger value is reset to nil. */)
534 (register Lisp_Object window, Lisp_Object value)
536 register struct window *w;
538 w = decode_window (window);
539 w->redisplay_end_trigger = value;
540 return value;
543 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
544 doc: /* Return a list of the edge coordinates of WINDOW.
545 The list has the form (LEFT TOP RIGHT BOTTOM).
546 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
547 all relative to 0, 0 at top left corner of frame.
549 RIGHT is one more than the rightmost column occupied by WINDOW.
550 BOTTOM is one more than the bottommost row occupied by WINDOW.
551 The edges include the space used by WINDOW's scroll bar, display
552 margins, fringes, header line, and/or mode line. For the edges of
553 just the text area, use `window-inside-edges'. */)
554 (Lisp_Object window)
556 register struct window *w = decode_any_window (window);
558 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
559 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
560 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
561 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
562 Qnil))));
565 DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
566 doc: /* Return a list of the edge pixel coordinates of WINDOW.
567 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
568 the top left corner of the frame.
570 RIGHT is one more than the rightmost x position occupied by WINDOW.
571 BOTTOM is one more than the bottommost y position occupied by WINDOW.
572 The pixel edges include the space used by WINDOW's scroll bar, display
573 margins, fringes, header line, and/or mode line. For the pixel edges
574 of just the text area, use `window-inside-pixel-edges'. */)
575 (Lisp_Object window)
577 register struct window *w = decode_any_window (window);
579 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
580 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
581 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
582 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
583 Qnil))));
586 static void
587 calc_absolute_offset(struct window *w, int *add_x, int *add_y)
589 struct frame *f = XFRAME (w->frame);
590 *add_y = f->top_pos;
591 #ifdef FRAME_MENUBAR_HEIGHT
592 *add_y += FRAME_MENUBAR_HEIGHT (f);
593 #endif
594 #ifdef FRAME_TOOLBAR_TOP_HEIGHT
595 *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
596 #elif FRAME_TOOLBAR_HEIGHT
597 *add_y += FRAME_TOOLBAR_HEIGHT (f);
598 #endif
599 #ifdef FRAME_NS_TITLEBAR_HEIGHT
600 *add_y += FRAME_NS_TITLEBAR_HEIGHT (f);
601 #endif
602 *add_x = f->left_pos;
603 #ifdef FRAME_TOOLBAR_LEFT_WIDTH
604 *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
605 #endif
608 DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges,
609 Swindow_absolute_pixel_edges, 0, 1, 0,
610 doc: /* Return a list of the edge pixel coordinates of WINDOW.
611 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
612 the top left corner of the display.
614 RIGHT is one more than the rightmost x position occupied by WINDOW.
615 BOTTOM is one more than the bottommost y position occupied by WINDOW.
616 The pixel edges include the space used by WINDOW's scroll bar, display
617 margins, fringes, header line, and/or mode line. For the pixel edges
618 of just the text area, use `window-inside-absolute-pixel-edges'. */)
619 (Lisp_Object window)
621 register struct window *w = decode_any_window (window);
622 int add_x, add_y;
623 calc_absolute_offset (w, &add_x, &add_y);
625 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w) + add_x),
626 Fcons (make_number (WINDOW_TOP_EDGE_Y (w) + add_y),
627 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w) + add_x),
628 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w) + add_y),
629 Qnil))));
632 DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
633 doc: /* Return a list of the edge coordinates of WINDOW.
634 The list has the form (LEFT TOP RIGHT BOTTOM).
635 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
636 all relative to 0, 0 at top left corner of frame.
638 RIGHT is one more than the rightmost column of WINDOW's text area.
639 BOTTOM is one more than the bottommost row of WINDOW's text area.
640 The inside edges do not include the space used by the WINDOW's scroll
641 bar, display margins, fringes, header line, and/or mode line. */)
642 (Lisp_Object window)
644 register struct window *w = decode_any_window (window);
646 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
647 + WINDOW_LEFT_MARGIN_COLS (w)
648 + WINDOW_LEFT_FRINGE_COLS (w)),
649 make_number (WINDOW_TOP_EDGE_LINE (w)
650 + WINDOW_HEADER_LINE_LINES (w)),
651 make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
652 - WINDOW_RIGHT_MARGIN_COLS (w)
653 - WINDOW_RIGHT_FRINGE_COLS (w)),
654 make_number (WINDOW_BOTTOM_EDGE_LINE (w)
655 - WINDOW_MODE_LINE_LINES (w)));
658 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
659 doc: /* Return a list of the edge pixel coordinates of WINDOW.
660 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
661 the top left corner of the frame.
663 RIGHT is one more than the rightmost x position of WINDOW's text area.
664 BOTTOM is one more than the bottommost y position of WINDOW's text area.
665 The inside edges do not include the space used by WINDOW's scroll bar,
666 display margins, fringes, header line, and/or mode line. */)
667 (Lisp_Object window)
669 register struct window *w = decode_any_window (window);
671 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
672 + WINDOW_LEFT_MARGIN_WIDTH (w)
673 + WINDOW_LEFT_FRINGE_WIDTH (w)),
674 make_number (WINDOW_TOP_EDGE_Y (w)
675 + WINDOW_HEADER_LINE_HEIGHT (w)),
676 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
677 - WINDOW_RIGHT_MARGIN_WIDTH (w)
678 - WINDOW_RIGHT_FRINGE_WIDTH (w)),
679 make_number (WINDOW_BOTTOM_EDGE_Y (w)
680 - WINDOW_MODE_LINE_HEIGHT (w)));
683 DEFUN ("window-inside-absolute-pixel-edges",
684 Fwindow_inside_absolute_pixel_edges,
685 Swindow_inside_absolute_pixel_edges, 0, 1, 0,
686 doc: /* Return a list of the edge pixel coordinates of WINDOW.
687 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
688 the top left corner of the display.
690 RIGHT is one more than the rightmost x position of WINDOW's text area.
691 BOTTOM is one more than the bottommost y position of WINDOW's text area.
692 The inside edges do not include the space used by WINDOW's scroll bar,
693 display margins, fringes, header line, and/or mode line. */)
694 (Lisp_Object window)
696 register struct window *w = decode_any_window (window);
697 int add_x, add_y;
698 calc_absolute_offset (w, &add_x, &add_y);
700 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
701 + WINDOW_LEFT_MARGIN_WIDTH (w)
702 + WINDOW_LEFT_FRINGE_WIDTH (w) + add_x),
703 make_number (WINDOW_TOP_EDGE_Y (w)
704 + WINDOW_HEADER_LINE_HEIGHT (w) + add_y),
705 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
706 - WINDOW_RIGHT_MARGIN_WIDTH (w)
707 - WINDOW_RIGHT_FRINGE_WIDTH (w) + add_x),
708 make_number (WINDOW_BOTTOM_EDGE_Y (w)
709 - WINDOW_MODE_LINE_HEIGHT (w) + add_y));
712 /* Test if the character at column X, row Y is within window W.
713 If it is not, return ON_NOTHING;
714 if it is in the window's text area, return ON_TEXT;
715 if it is on the window's modeline, return ON_MODE_LINE;
716 if it is on the border between the window and its right sibling,
717 return ON_VERTICAL_BORDER.
718 if it is on a scroll bar, return ON_SCROLL_BAR.
719 if it is on the window's top line, return ON_HEADER_LINE;
720 if it is in left or right fringe of the window,
721 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
722 if it is in the marginal area to the left/right of the window,
723 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
725 X and Y are frame relative pixel coordinates. */
727 static enum window_part
728 coordinates_in_window (register struct window *w, int x, int y)
730 struct frame *f = XFRAME (WINDOW_FRAME (w));
731 int left_x, right_x;
732 enum window_part part;
733 int ux = FRAME_COLUMN_WIDTH (f);
734 int x0 = WINDOW_LEFT_EDGE_X (w);
735 int x1 = WINDOW_RIGHT_EDGE_X (w);
736 /* The width of the area where the vertical line can be dragged.
737 (Between mode lines for instance. */
738 int grabbable_width = ux;
739 int lmargin_width, rmargin_width, text_left, text_right;
740 int top_y = WINDOW_TOP_EDGE_Y (w);
741 int bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
743 /* Outside any interesting row? */
744 if (y < top_y || y >= bottom_y)
745 return ON_NOTHING;
747 /* In what's below, we subtract 1 when computing right_x because we
748 want the rightmost pixel, which is given by left_pixel+width-1. */
749 if (w->pseudo_window_p)
751 left_x = 0;
752 right_x = WINDOW_TOTAL_WIDTH (w) - 1;
754 else
756 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
757 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
760 /* On the mode line or header line? If it's near the start of
761 the mode or header line of window that's has a horizontal
762 sibling, say it's on the vertical line. That's to be able
763 to resize windows horizontally in case we're using toolkit
764 scroll bars. */
766 if (WINDOW_WANTS_MODELINE_P (w)
767 && y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
769 part = ON_MODE_LINE;
771 header_vertical_border_check:
772 /* We're somewhere on the mode line. We consider the place
773 between mode lines of horizontally adjacent mode lines
774 as the vertical border. If scroll bars on the left,
775 return the right window. */
776 if ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
777 || WINDOW_RIGHTMOST_P (w))
778 && !WINDOW_LEFTMOST_P (w)
779 && eabs (x - x0) < grabbable_width)
780 return ON_VERTICAL_BORDER;
782 /* Make sure we're not at the rightmost position of a
783 mode-/header-line and there's yet another window on the
784 right. (Bug#1372) */
785 else if ((WINDOW_RIGHTMOST_P (w) || x < x1)
786 && eabs (x - x1) < grabbable_width)
787 return ON_VERTICAL_BORDER;
789 if (x < x0 || x >= x1)
790 return ON_NOTHING;
792 return part;
795 if (WINDOW_WANTS_HEADER_LINE_P (w)
796 && y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
798 part = ON_HEADER_LINE;
799 goto header_vertical_border_check;
802 if (x < x0 || x >= x1) return ON_NOTHING;
804 /* Outside any interesting column? */
805 if (x < left_x || x > right_x)
806 return ON_SCROLL_BAR;
808 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
809 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
811 text_left = window_box_left (w, TEXT_AREA);
812 text_right = text_left + window_box_width (w, TEXT_AREA);
814 if (FRAME_WINDOW_P (f))
816 if (!w->pseudo_window_p
817 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
818 && !WINDOW_RIGHTMOST_P (w)
819 && (eabs (x - right_x) < grabbable_width))
820 return ON_VERTICAL_BORDER;
822 /* Need to say "x > right_x" rather than >=, since on character
823 terminals, the vertical line's x coordinate is right_x. */
824 else if (!w->pseudo_window_p
825 && !WINDOW_RIGHTMOST_P (w)
826 && x > right_x - ux)
827 return ON_VERTICAL_BORDER;
829 if (x < text_left)
831 if (lmargin_width > 0
832 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
833 ? (x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
834 : (x < left_x + lmargin_width)))
835 return ON_LEFT_MARGIN;
837 return ON_LEFT_FRINGE;
840 if (x >= text_right)
842 if (rmargin_width > 0
843 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
844 ? (x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
845 : (x >= right_x - rmargin_width)))
846 return ON_RIGHT_MARGIN;
848 return ON_RIGHT_FRINGE;
851 /* Everything special ruled out - must be on text area */
852 return ON_TEXT;
855 /* Take X is the frame-relative pixel x-coordinate, and return the
856 x-coordinate relative to part PART of window W. */
858 window_relative_x_coord (struct window *w, enum window_part part, int x)
860 int left_x = (w->pseudo_window_p) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w);
862 switch (part)
864 case ON_TEXT:
865 return x - window_box_left (w, TEXT_AREA);
867 case ON_LEFT_FRINGE:
868 return x - left_x;
870 case ON_RIGHT_FRINGE:
871 return x - left_x - WINDOW_LEFT_FRINGE_WIDTH (w);
873 case ON_LEFT_MARGIN:
874 return (x - left_x
875 - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
876 ? WINDOW_LEFT_FRINGE_WIDTH (w) : 0));
878 case ON_RIGHT_MARGIN:
879 return (x + 1
880 - ((w->pseudo_window_p)
881 ? WINDOW_TOTAL_WIDTH (w)
882 : WINDOW_BOX_RIGHT_EDGE_X (w))
883 + window_box_width (w, RIGHT_MARGIN_AREA)
884 + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
885 ? WINDOW_RIGHT_FRINGE_WIDTH (w) : 0));
888 /* ON_SCROLL_BAR, ON_NOTHING, and ON_VERTICAL_BORDER: */
889 return 0;
893 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
894 Scoordinates_in_window_p, 2, 2, 0,
895 doc: /* Return non-nil if COORDINATES are in WINDOW.
896 COORDINATES is a cons of the form (X . Y), X and Y being distances
897 measured in characters from the upper-left corner of the frame.
898 \(0 . 0) denotes the character in the upper left corner of the
899 frame.
900 If COORDINATES are in the text portion of WINDOW,
901 the coordinates relative to the window are returned.
902 If they are in the mode line of WINDOW, `mode-line' is returned.
903 If they are in the top mode line of WINDOW, `header-line' is returned.
904 If they are in the left fringe of WINDOW, `left-fringe' is returned.
905 If they are in the right fringe of WINDOW, `right-fringe' is returned.
906 If they are on the border between WINDOW and its right sibling,
907 `vertical-line' is returned.
908 If they are in the windows's left or right marginal areas, `left-margin'\n\
909 or `right-margin' is returned. */)
910 (register Lisp_Object coordinates, Lisp_Object window)
912 struct window *w;
913 struct frame *f;
914 int x, y;
915 Lisp_Object lx, ly;
917 CHECK_WINDOW (window);
918 w = XWINDOW (window);
919 f = XFRAME (w->frame);
920 CHECK_CONS (coordinates);
921 lx = Fcar (coordinates);
922 ly = Fcdr (coordinates);
923 CHECK_NUMBER_OR_FLOAT (lx);
924 CHECK_NUMBER_OR_FLOAT (ly);
925 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
926 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
928 switch (coordinates_in_window (w, x, y))
930 case ON_NOTHING:
931 return Qnil;
933 case ON_TEXT:
934 /* Convert X and Y to window relative pixel coordinates, and
935 return the canonical char units. */
936 x -= window_box_left (w, TEXT_AREA);
937 y -= WINDOW_TOP_EDGE_Y (w);
938 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
939 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
941 case ON_MODE_LINE:
942 return Qmode_line;
944 case ON_VERTICAL_BORDER:
945 return Qvertical_line;
947 case ON_HEADER_LINE:
948 return Qheader_line;
950 case ON_LEFT_FRINGE:
951 return Qleft_fringe;
953 case ON_RIGHT_FRINGE:
954 return Qright_fringe;
956 case ON_LEFT_MARGIN:
957 return Qleft_margin;
959 case ON_RIGHT_MARGIN:
960 return Qright_margin;
962 case ON_SCROLL_BAR:
963 /* Historically we are supposed to return nil in this case. */
964 return Qnil;
966 default:
967 abort ();
972 /* Callback for foreach_window, used in window_from_coordinates.
973 Check if window W contains coordinates specified by USER_DATA which
974 is actually a pointer to a struct check_window_data CW.
976 Check if window W contains coordinates *CW->x and *CW->y. If it
977 does, return W in *CW->window, as Lisp_Object, and return in
978 *CW->part the part of the window under coordinates *X,*Y. Return
979 zero from this function to stop iterating over windows. */
981 struct check_window_data
983 Lisp_Object *window;
984 int x, y;
985 enum window_part *part;
988 static int
989 check_window_containing (struct window *w, void *user_data)
991 struct check_window_data *cw = (struct check_window_data *) user_data;
992 enum window_part found;
993 int continue_p = 1;
995 found = coordinates_in_window (w, cw->x, cw->y);
996 if (found != ON_NOTHING)
998 *cw->part = found;
999 XSETWINDOW (*cw->window, w);
1000 continue_p = 0;
1003 return continue_p;
1007 /* Find the window containing frame-relative pixel position X/Y and
1008 return it as a Lisp_Object.
1010 If X, Y is on one of the window's special `window_part' elements,
1011 set *PART to the id of that element.
1013 If there is no window under X, Y return nil and leave *PART
1014 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1016 This function was previously implemented with a loop cycling over
1017 windows with Fnext_window, and starting with the frame's selected
1018 window. It turned out that this doesn't work with an
1019 implementation of next_window using Vwindow_list, because
1020 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1021 tree of F when this function is called asynchronously from
1022 note_mouse_highlight. The original loop didn't terminate in this
1023 case. */
1025 Lisp_Object
1026 window_from_coordinates (struct frame *f, int x, int y,
1027 enum window_part *part, int tool_bar_p)
1029 Lisp_Object window;
1030 struct check_window_data cw;
1031 enum window_part dummy;
1033 if (part == 0)
1034 part = &dummy;
1036 window = Qnil;
1037 cw.window = &window, cw.x = x, cw.y = y; cw.part = part;
1038 foreach_window (f, check_window_containing, &cw);
1040 /* If not found above, see if it's in the tool bar window, if a tool
1041 bar exists. */
1042 if (NILP (window)
1043 && tool_bar_p
1044 && WINDOWP (f->tool_bar_window)
1045 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1046 && (coordinates_in_window (XWINDOW (f->tool_bar_window), x, y)
1047 != ON_NOTHING))
1049 *part = ON_TEXT;
1050 window = f->tool_bar_window;
1053 return window;
1056 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1057 doc: /* Return window containing coordinates X and Y on FRAME.
1058 If omitted, FRAME defaults to the currently selected frame.
1059 The top left corner of the frame is considered to be row 0,
1060 column 0. */)
1061 (Lisp_Object x, Lisp_Object y, Lisp_Object frame)
1063 struct frame *f;
1065 if (NILP (frame))
1066 frame = selected_frame;
1067 CHECK_LIVE_FRAME (frame);
1068 f = XFRAME (frame);
1070 /* Check that arguments are integers or floats. */
1071 CHECK_NUMBER_OR_FLOAT (x);
1072 CHECK_NUMBER_OR_FLOAT (y);
1074 return window_from_coordinates (f,
1075 (FRAME_PIXEL_X_FROM_CANON_X (f, x)
1076 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1077 (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
1078 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1079 0, 0);
1082 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1083 doc: /* Return current value of point in WINDOW.
1084 WINDOW defaults to the selected window.
1086 For a nonselected window, this is the value point would have
1087 if that window were selected.
1089 Note that, when WINDOW is the selected window and its buffer
1090 is also currently selected, the value returned is the same as (point).
1091 It would be more strictly correct to return the `top-level' value
1092 of point, outside of any save-excursion forms.
1093 But that is hard to define. */)
1094 (Lisp_Object window)
1096 register struct window *w = decode_window (window);
1098 if (w == XWINDOW (selected_window)
1099 && current_buffer == XBUFFER (w->buffer))
1100 return Fpoint ();
1101 return Fmarker_position (w->pointm);
1104 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1105 doc: /* Return position at which display currently starts in WINDOW.
1106 WINDOW defaults to the selected window.
1107 This is updated by redisplay or by calling `set-window-start'. */)
1108 (Lisp_Object window)
1110 return Fmarker_position (decode_window (window)->start);
1113 /* This is text temporarily removed from the doc string below.
1115 This function returns nil if the position is not currently known.
1116 That happens when redisplay is preempted and doesn't finish.
1117 If in that case you want to compute where the end of the window would
1118 have been if redisplay had finished, do this:
1119 (save-excursion
1120 (goto-char (window-start window))
1121 (vertical-motion (1- (window-height window)) window)
1122 (point))") */
1124 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1125 doc: /* Return position at which display currently ends in WINDOW.
1126 WINDOW defaults to the selected window.
1127 This is updated by redisplay, when it runs to completion.
1128 Simply changing the buffer text or setting `window-start'
1129 does not update this value.
1130 Return nil if there is no recorded value. \(This can happen if the
1131 last redisplay of WINDOW was preempted, and did not finish.)
1132 If UPDATE is non-nil, compute the up-to-date position
1133 if it isn't already recorded. */)
1134 (Lisp_Object window, Lisp_Object update)
1136 Lisp_Object value;
1137 struct window *w = decode_window (window);
1138 Lisp_Object buf;
1139 struct buffer *b;
1141 buf = w->buffer;
1142 CHECK_BUFFER (buf);
1143 b = XBUFFER (buf);
1145 #if 0 /* This change broke some things. We should make it later. */
1146 /* If we don't know the end position, return nil.
1147 The user can compute it with vertical-motion if he wants to.
1148 It would be nicer to do it automatically,
1149 but that's so slow that it would probably bother people. */
1150 if (NILP (w->window_end_valid))
1151 return Qnil;
1152 #endif
1154 if (! NILP (update)
1155 && ! (! NILP (w->window_end_valid)
1156 && XFASTINT (w->last_modified) >= BUF_MODIFF (b)
1157 && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (b))
1158 && !noninteractive)
1160 struct text_pos startp;
1161 struct it it;
1162 struct buffer *old_buffer = NULL;
1164 /* Cannot use Fvertical_motion because that function doesn't
1165 cope with variable-height lines. */
1166 if (b != current_buffer)
1168 old_buffer = current_buffer;
1169 set_buffer_internal (b);
1172 /* In case W->start is out of the range, use something
1173 reasonable. This situation occurred when loading a file with
1174 `-l' containing a call to `rmail' with subsequent other
1175 commands. At the end, W->start happened to be BEG, while
1176 rmail had already narrowed the buffer. */
1177 if (XMARKER (w->start)->charpos < BEGV)
1178 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1179 else if (XMARKER (w->start)->charpos > ZV)
1180 SET_TEXT_POS (startp, ZV, ZV_BYTE);
1181 else
1182 SET_TEXT_POS_FROM_MARKER (startp, w->start);
1184 start_display (&it, w, startp);
1185 move_it_vertically (&it, window_box_height (w));
1186 if (it.current_y < it.last_visible_y)
1187 move_it_past_eol (&it);
1188 value = make_number (IT_CHARPOS (it));
1190 if (old_buffer)
1191 set_buffer_internal (old_buffer);
1193 else
1194 XSETINT (value, BUF_Z (b) - XFASTINT (w->window_end_pos));
1196 return value;
1199 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1200 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1201 Return POS. */)
1202 (Lisp_Object window, Lisp_Object pos)
1204 register struct window *w = decode_window (window);
1206 CHECK_NUMBER_COERCE_MARKER (pos);
1207 if (w == XWINDOW (selected_window)
1208 && XBUFFER (w->buffer) == current_buffer)
1209 Fgoto_char (pos);
1210 else
1211 set_marker_restricted (w->pointm, pos, w->buffer);
1213 /* We have to make sure that redisplay updates the window to show
1214 the new value of point. */
1215 if (!EQ (window, selected_window))
1216 ++windows_or_buffers_changed;
1218 return pos;
1221 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1222 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1223 WINDOW defaults to the selected window. Return POS.
1224 Optional third arg NOFORCE non-nil inhibits next redisplay from
1225 overriding motion of point in order to display at this exact start. */)
1226 (Lisp_Object window, Lisp_Object pos, Lisp_Object noforce)
1228 register struct window *w = decode_window (window);
1230 CHECK_NUMBER_COERCE_MARKER (pos);
1231 set_marker_restricted (w->start, pos, w->buffer);
1232 /* this is not right, but much easier than doing what is right. */
1233 w->start_at_line_beg = Qnil;
1234 if (NILP (noforce))
1235 w->force_start = Qt;
1236 w->update_mode_line = Qt;
1237 XSETFASTINT (w->last_modified, 0);
1238 XSETFASTINT (w->last_overlay_modified, 0);
1239 if (!EQ (window, selected_window))
1240 windows_or_buffers_changed++;
1242 return pos;
1246 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1247 0, 1, 0,
1248 doc: /* Return non-nil when WINDOW is dedicated to its buffer.
1249 More precisely, return the value assigned by the last call of
1250 `set-window-dedicated-p' for WINDOW. Return nil if that function was
1251 never called with WINDOW as its argument, or the value set by that
1252 function was internally reset since its last call. WINDOW defaults to
1253 the selected window.
1255 When a window is dedicated to its buffer, `display-buffer' will refrain
1256 from displaying another buffer in it. `get-lru-window' and
1257 `get-largest-window' treat dedicated windows specially.
1258 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1259 `kill-buffer' can delete a dedicated window and the containing frame.
1261 Functions like `set-window-buffer' may change the buffer displayed by a
1262 window, unless that window is "strongly" dedicated to its buffer, that
1263 is the value returned by `window-dedicated-p' is t. */)
1264 (Lisp_Object window)
1266 return decode_window (window)->dedicated;
1269 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1270 Sset_window_dedicated_p, 2, 2, 0,
1271 doc: /* Mark WINDOW as dedicated according to FLAG.
1272 WINDOW defaults to the selected window. FLAG non-nil means mark WINDOW
1273 as dedicated to its buffer. FLAG nil means mark WINDOW as non-dedicated.
1274 Return FLAG.
1276 When a window is dedicated to its buffer, `display-buffer' will refrain
1277 from displaying another buffer in it. `get-lru-window' and
1278 `get-largest-window' treat dedicated windows specially.
1279 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1280 `kill-buffer' can delete a dedicated window and the containing
1281 frame.
1283 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
1284 its buffer. Functions like `set-window-buffer' may change the buffer
1285 displayed by a window, unless that window is strongly dedicated to its
1286 buffer. If and when `set-window-buffer' displays another buffer in a
1287 window, it also makes sure that the window is not marked as dedicated. */)
1288 (Lisp_Object window, Lisp_Object flag)
1290 register struct window *w = decode_window (window);
1292 w->dedicated = flag;
1293 return w->dedicated;
1297 DEFUN ("window-parameters", Fwindow_parameters, Swindow_parameters,
1298 0, 1, 0,
1299 doc: /* Return the parameters of WINDOW and their values.
1300 WINDOW defaults to the selected window. The return value is a list of
1301 elements of the form (PARAMETER . VALUE). */)
1302 (Lisp_Object window)
1304 return Fcopy_alist (decode_window (window)->window_parameters);
1307 DEFUN ("window-parameter", Fwindow_parameter, Swindow_parameter,
1308 2, 2, 0,
1309 doc: /* Return WINDOW's value for PARAMETER.
1310 WINDOW defaults to the selected window. */)
1311 (Lisp_Object window, Lisp_Object parameter)
1313 Lisp_Object result;
1315 result = Fassq (parameter, decode_window (window)->window_parameters);
1316 return CDR_SAFE (result);
1319 DEFUN ("set-window-parameter", Fset_window_parameter,
1320 Sset_window_parameter, 3, 3, 0,
1321 doc: /* Set WINDOW's value of PARAMETER to VALUE.
1322 WINDOW defaults to the selected window. Return VALUE. */)
1323 (Lisp_Object window, Lisp_Object parameter, Lisp_Object value)
1325 register struct window *w = decode_window (window);
1326 Lisp_Object old_alist_elt;
1328 old_alist_elt = Fassq (parameter, w->window_parameters);
1329 if (NILP (old_alist_elt))
1330 w->window_parameters = Fcons (Fcons (parameter, value), w->window_parameters);
1331 else
1332 Fsetcdr (old_alist_elt, value);
1333 return value;
1337 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1338 0, 1, 0,
1339 doc: /* Return the display-table that WINDOW is using.
1340 WINDOW defaults to the selected window. */)
1341 (Lisp_Object window)
1343 return decode_window (window)->display_table;
1346 /* Get the display table for use on window W. This is either W's
1347 display table or W's buffer's display table. Ignore the specified
1348 tables if they are not valid; if no valid table is specified,
1349 return 0. */
1351 struct Lisp_Char_Table *
1352 window_display_table (struct window *w)
1354 struct Lisp_Char_Table *dp = NULL;
1356 if (DISP_TABLE_P (w->display_table))
1357 dp = XCHAR_TABLE (w->display_table);
1358 else if (BUFFERP (w->buffer))
1360 struct buffer *b = XBUFFER (w->buffer);
1362 if (DISP_TABLE_P (BVAR (b, display_table)))
1363 dp = XCHAR_TABLE (BVAR (b, display_table));
1364 else if (DISP_TABLE_P (Vstandard_display_table))
1365 dp = XCHAR_TABLE (Vstandard_display_table);
1368 return dp;
1371 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1372 doc: /* Set WINDOW's display-table to TABLE. */)
1373 (register Lisp_Object window, Lisp_Object table)
1375 register struct window *w;
1377 w = decode_window (window);
1378 w->display_table = table;
1379 return table;
1382 static void delete_window (Lisp_Object);
1384 /* Record info on buffer window w is displaying
1385 when it is about to cease to display that buffer. */
1386 static void
1387 unshow_buffer (register struct window *w)
1389 Lisp_Object buf;
1390 struct buffer *b;
1392 buf = w->buffer;
1393 b = XBUFFER (buf);
1394 if (b != XMARKER (w->pointm)->buffer)
1395 abort ();
1397 #if 0
1398 if (w == XWINDOW (selected_window)
1399 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1400 /* Do this except when the selected window's buffer
1401 is being removed from some other window. */
1402 #endif
1403 /* last_window_start records the start position that this buffer
1404 had in the last window to be disconnected from it.
1405 Now that this statement is unconditional,
1406 it is possible for the buffer to be displayed in the
1407 selected window, while last_window_start reflects another
1408 window which was recently showing the same buffer.
1409 Some people might say that might be a good thing. Let's see. */
1410 b->last_window_start = marker_position (w->start);
1412 /* Point in the selected window's buffer
1413 is actually stored in that buffer, and the window's pointm isn't used.
1414 So don't clobber point in that buffer. */
1415 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1416 /* This line helps to fix Horsley's testbug.el bug. */
1417 && !(WINDOWP (BVAR (b, last_selected_window))
1418 && w != XWINDOW (BVAR (b, last_selected_window))
1419 && EQ (buf, XWINDOW (BVAR (b, last_selected_window))->buffer)))
1420 temp_set_point_both (b,
1421 clip_to_bounds (BUF_BEGV (b),
1422 XMARKER (w->pointm)->charpos,
1423 BUF_ZV (b)),
1424 clip_to_bounds (BUF_BEGV_BYTE (b),
1425 marker_byte_position (w->pointm),
1426 BUF_ZV_BYTE (b)));
1428 if (WINDOWP (BVAR (b, last_selected_window))
1429 && w == XWINDOW (BVAR (b, last_selected_window)))
1430 BVAR (b, last_selected_window) = Qnil;
1433 /* Put replacement into the window structure in place of old. */
1434 static void
1435 replace_window (Lisp_Object old, Lisp_Object replacement)
1437 register Lisp_Object tem;
1438 register struct window *o = XWINDOW (old), *p = XWINDOW (replacement);
1440 /* If OLD is its frame's root_window, then replacement is the new
1441 root_window for that frame. */
1443 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1444 FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement;
1446 p->left_col = o->left_col;
1447 p->top_line = o->top_line;
1448 p->total_cols = o->total_cols;
1449 p->total_lines = o->total_lines;
1450 p->desired_matrix = p->current_matrix = 0;
1451 p->vscroll = 0;
1452 memset (&p->cursor, 0, sizeof (p->cursor));
1453 memset (&p->last_cursor, 0, sizeof (p->last_cursor));
1454 memset (&p->phys_cursor, 0, sizeof (p->phys_cursor));
1455 p->phys_cursor_type = -1;
1456 p->phys_cursor_width = -1;
1457 p->must_be_updated_p = 0;
1458 p->pseudo_window_p = 0;
1459 XSETFASTINT (p->window_end_vpos, 0);
1460 XSETFASTINT (p->window_end_pos, 0);
1461 p->window_end_valid = Qnil;
1462 p->frozen_window_start_p = 0;
1463 p->orig_top_line = p->orig_total_lines = Qnil;
1465 p->next = tem = o->next;
1466 if (!NILP (tem))
1467 XWINDOW (tem)->prev = replacement;
1469 p->prev = tem = o->prev;
1470 if (!NILP (tem))
1471 XWINDOW (tem)->next = replacement;
1473 p->parent = tem = o->parent;
1474 if (!NILP (tem))
1476 if (EQ (XWINDOW (tem)->vchild, old))
1477 XWINDOW (tem)->vchild = replacement;
1478 if (EQ (XWINDOW (tem)->hchild, old))
1479 XWINDOW (tem)->hchild = replacement;
1482 /*** Here, if replacement is a vertical combination
1483 and so is its new parent, we should make replacement's
1484 children be children of that parent instead. ***/
1487 DEFUN ("delete-window", Fdelete_window, Sdelete_window, 0, 1, "",
1488 doc: /* Remove WINDOW from its frame.
1489 WINDOW defaults to the selected window. Return nil.
1490 Signal an error when WINDOW is the only window on its frame. */)
1491 (register Lisp_Object window)
1493 struct frame *f;
1494 if (NILP (window))
1495 window = selected_window;
1496 else
1497 CHECK_LIVE_WINDOW (window);
1499 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
1500 delete_window (window);
1502 run_window_configuration_change_hook (f);
1504 return Qnil;
1507 static void
1508 delete_window (register Lisp_Object window)
1510 register Lisp_Object tem, parent, sib;
1511 register struct window *p;
1512 register struct window *par;
1513 struct frame *f;
1515 /* Because this function is called by other C code on non-leaf
1516 windows, the CHECK_LIVE_WINDOW macro would choke inappropriately,
1517 so we can't decode_window here. */
1518 CHECK_WINDOW (window);
1519 p = XWINDOW (window);
1521 /* It's a no-op to delete an already-deleted window. */
1522 if (NILP (p->buffer)
1523 && NILP (p->hchild)
1524 && NILP (p->vchild))
1525 return;
1527 parent = p->parent;
1528 if (NILP (parent))
1529 error ("Attempt to delete minibuffer or sole ordinary window");
1530 par = XWINDOW (parent);
1532 windows_or_buffers_changed++;
1533 Vwindow_list = Qnil;
1534 f = XFRAME (WINDOW_FRAME (p));
1535 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
1537 /* Are we trying to delete any frame's selected window? */
1539 Lisp_Object swindow, pwindow;
1541 /* See if the frame's selected window is either WINDOW
1542 or any subwindow of it, by finding all that window's parents
1543 and comparing each one with WINDOW. */
1544 swindow = FRAME_SELECTED_WINDOW (f);
1546 while (1)
1548 pwindow = swindow;
1549 while (!NILP (pwindow))
1551 if (EQ (window, pwindow))
1552 break;
1553 pwindow = XWINDOW (pwindow)->parent;
1556 /* If the window being deleted is not a parent of SWINDOW,
1557 then SWINDOW is ok as the new selected window. */
1558 if (!EQ (window, pwindow))
1559 break;
1560 /* Otherwise, try another window for SWINDOW. */
1561 swindow = Fnext_window (swindow, Qlambda, Qnil);
1563 /* If we get back to the frame's selected window,
1564 it means there was no acceptable alternative,
1565 so we cannot delete. */
1566 if (EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1567 error ("Cannot delete window");
1570 /* If we need to change SWINDOW, do it. */
1571 if (! EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1573 /* If we're about to delete the selected window on the
1574 selected frame, then we should use Fselect_window to select
1575 the new window. On the other hand, if we're about to
1576 delete the selected window on any other frame, we shouldn't do
1577 anything but set the frame's selected_window slot. */
1578 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
1579 Fselect_window (swindow, Qnil);
1580 else
1581 FRAME_SELECTED_WINDOW (f) = swindow;
1585 /* Now we know we can delete this one. */
1586 window_deletion_count++;
1588 tem = p->buffer;
1589 /* tem is null for dummy parent windows
1590 (which have inferiors but not any contents themselves) */
1591 if (!NILP (tem))
1593 unshow_buffer (p);
1594 unchain_marker (XMARKER (p->pointm));
1595 unchain_marker (XMARKER (p->start));
1598 /* Free window glyph matrices. It is sure that they are allocated
1599 again when ADJUST_GLYPHS is called. Block input so that expose
1600 events and other events that access glyph matrices are not
1601 processed while we are changing them. */
1602 BLOCK_INPUT;
1603 free_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)));
1605 tem = p->next;
1606 if (!NILP (tem))
1607 XWINDOW (tem)->prev = p->prev;
1609 tem = p->prev;
1610 if (!NILP (tem))
1611 XWINDOW (tem)->next = p->next;
1613 if (EQ (window, par->hchild))
1614 par->hchild = p->next;
1615 if (EQ (window, par->vchild))
1616 par->vchild = p->next;
1618 /* Find one of our siblings to give our space to. */
1619 sib = p->prev;
1620 if (NILP (sib))
1622 /* If p gives its space to its next sibling, that sibling needs
1623 to have its top/left side pulled back to where p's is.
1624 set_window_{height,width} will re-position the sibling's
1625 children. */
1626 sib = p->next;
1627 XWINDOW (sib)->top_line = p->top_line;
1628 XWINDOW (sib)->left_col = p->left_col;
1631 /* Stretch that sibling. */
1632 if (!NILP (par->vchild))
1633 set_window_height (sib,
1634 XFASTINT (XWINDOW (sib)->total_lines) + XFASTINT (p->total_lines),
1636 if (!NILP (par->hchild))
1637 set_window_width (sib,
1638 XFASTINT (XWINDOW (sib)->total_cols) + XFASTINT (p->total_cols),
1641 /* If parent now has only one child,
1642 put the child into the parent's place. */
1643 tem = par->hchild;
1644 if (NILP (tem))
1645 tem = par->vchild;
1646 if (NILP (XWINDOW (tem)->next)) {
1647 replace_window (parent, tem);
1648 par = XWINDOW (tem);
1651 /* Since we may be deleting combination windows, we must make sure that
1652 not only p but all its children have been marked as deleted. */
1653 if (! NILP (p->hchild))
1654 delete_all_subwindows (XWINDOW (p->hchild));
1655 else if (! NILP (p->vchild))
1656 delete_all_subwindows (XWINDOW (p->vchild));
1658 /* Mark this window as deleted. */
1659 p->buffer = p->hchild = p->vchild = Qnil;
1661 if (! NILP (par->parent))
1662 par = XWINDOW (par->parent);
1664 /* Check if we have a v/hchild with a v/hchild. In that case remove
1665 one of them. */
1667 if (! NILP (par->vchild) && ! NILP (XWINDOW (par->vchild)->vchild))
1669 p = XWINDOW (par->vchild);
1670 par->vchild = p->vchild;
1671 tem = p->vchild;
1673 else if (! NILP (par->hchild) && ! NILP (XWINDOW (par->hchild)->hchild))
1675 p = XWINDOW (par->hchild);
1676 par->hchild = p->hchild;
1677 tem = p->hchild;
1679 else
1680 p = 0;
1682 if (p)
1684 while (! NILP (tem)) {
1685 XWINDOW (tem)->parent = p->parent;
1686 if (NILP (XWINDOW (tem)->next))
1687 break;
1688 tem = XWINDOW (tem)->next;
1690 if (! NILP (tem)) {
1691 /* The next of the v/hchild we are removing is now the next of the
1692 last child for the v/hchild:
1693 Before v/hchild -> v/hchild -> next1 -> next2
1695 -> next3
1696 After: v/hchild -> next1 -> next2 -> next3
1698 XWINDOW (tem)->next = p->next;
1699 if (! NILP (p->next))
1700 XWINDOW (p->next)->prev = tem;
1702 p->next = p->prev = p->vchild = p->hchild = p->buffer = Qnil;
1706 /* Adjust glyph matrices. */
1707 adjust_glyphs (f);
1708 UNBLOCK_INPUT;
1713 /***********************************************************************
1714 Window List
1715 ***********************************************************************/
1717 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1718 pointer. This is a callback function for foreach_window, used in
1719 function window_list. */
1721 static int
1722 add_window_to_list (struct window *w, void *user_data)
1724 Lisp_Object *list = (Lisp_Object *) user_data;
1725 Lisp_Object window;
1726 XSETWINDOW (window, w);
1727 *list = Fcons (window, *list);
1728 return 1;
1732 /* Return a list of all windows, for use by next_window. If
1733 Vwindow_list is a list, return that list. Otherwise, build a new
1734 list, cache it in Vwindow_list, and return that. */
1736 static Lisp_Object
1737 window_list (void)
1739 if (!CONSP (Vwindow_list))
1741 Lisp_Object tail;
1743 Vwindow_list = Qnil;
1744 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1746 Lisp_Object args[2];
1748 /* We are visiting windows in canonical order, and add
1749 new windows at the front of args[1], which means we
1750 have to reverse this list at the end. */
1751 args[1] = Qnil;
1752 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
1753 args[0] = Vwindow_list;
1754 args[1] = Fnreverse (args[1]);
1755 Vwindow_list = Fnconc (2, args);
1759 return Vwindow_list;
1763 /* Value is non-zero if WINDOW satisfies the constraints given by
1764 OWINDOW, MINIBUF and ALL_FRAMES.
1766 MINIBUF t means WINDOW may be minibuffer windows.
1767 `lambda' means WINDOW may not be a minibuffer window.
1768 a window means a specific minibuffer window
1770 ALL_FRAMES t means search all frames,
1771 nil means search just current frame,
1772 `visible' means search just visible frames,
1773 0 means search visible and iconified frames,
1774 a window means search the frame that window belongs to,
1775 a frame means consider windows on that frame, only. */
1777 static int
1778 candidate_window_p (Lisp_Object window, Lisp_Object owindow, Lisp_Object minibuf, Lisp_Object all_frames)
1780 struct window *w = XWINDOW (window);
1781 struct frame *f = XFRAME (w->frame);
1782 int candidate_p = 1;
1784 if (!BUFFERP (w->buffer))
1785 candidate_p = 0;
1786 else if (MINI_WINDOW_P (w)
1787 && (EQ (minibuf, Qlambda)
1788 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
1790 /* If MINIBUF is `lambda' don't consider any mini-windows.
1791 If it is a window, consider only that one. */
1792 candidate_p = 0;
1794 else if (EQ (all_frames, Qt))
1795 candidate_p = 1;
1796 else if (NILP (all_frames))
1798 xassert (WINDOWP (owindow));
1799 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
1801 else if (EQ (all_frames, Qvisible))
1803 FRAME_SAMPLE_VISIBILITY (f);
1804 candidate_p = FRAME_VISIBLE_P (f)
1805 && (FRAME_TERMINAL (XFRAME (w->frame))
1806 == FRAME_TERMINAL (XFRAME (selected_frame)));
1809 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
1811 FRAME_SAMPLE_VISIBILITY (f);
1812 candidate_p = (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)
1813 #ifdef HAVE_X_WINDOWS
1814 /* Yuck!! If we've just created the frame and the
1815 window-manager requested the user to place it
1816 manually, the window may still not be considered
1817 `visible'. I'd argue it should be at least
1818 something like `iconified', but don't know how to do
1819 that yet. --Stef */
1820 || (FRAME_X_P (f) && f->output_data.x->asked_for_visible
1821 && !f->output_data.x->has_been_visible)
1822 #endif
1824 && (FRAME_TERMINAL (XFRAME (w->frame))
1825 == FRAME_TERMINAL (XFRAME (selected_frame)));
1827 else if (WINDOWP (all_frames))
1828 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
1829 || EQ (XWINDOW (all_frames)->frame, w->frame)
1830 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
1831 else if (FRAMEP (all_frames))
1832 candidate_p = EQ (all_frames, w->frame);
1834 return candidate_p;
1838 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
1839 Fwindow_list. See there for the meaning of WINDOW, MINIBUF, and
1840 ALL_FRAMES. */
1842 static void
1843 decode_next_window_args (Lisp_Object *window, Lisp_Object *minibuf, Lisp_Object *all_frames)
1845 if (NILP (*window))
1846 *window = selected_window;
1847 else
1848 CHECK_LIVE_WINDOW (*window);
1850 /* MINIBUF nil may or may not include minibuffers. Decide if it
1851 does. */
1852 if (NILP (*minibuf))
1853 *minibuf = minibuf_level ? minibuf_window : Qlambda;
1854 else if (!EQ (*minibuf, Qt))
1855 *minibuf = Qlambda;
1857 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
1858 => count none of them, or a specific minibuffer window (the
1859 active one) to count. */
1861 /* ALL_FRAMES nil doesn't specify which frames to include. */
1862 if (NILP (*all_frames))
1863 *all_frames = (!EQ (*minibuf, Qlambda)
1864 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
1865 : Qnil);
1866 else if (EQ (*all_frames, Qvisible))
1868 else if (EQ (*all_frames, make_number (0)))
1870 else if (FRAMEP (*all_frames))
1872 else if (!EQ (*all_frames, Qt))
1873 *all_frames = Qnil;
1875 /* Now *ALL_FRAMES is t meaning search all frames, nil meaning
1876 search just current frame, `visible' meaning search just visible
1877 frames, 0 meaning search visible and iconified frames, or a
1878 window, meaning search the frame that window belongs to, or a
1879 frame, meaning consider windows on that frame, only. */
1883 /* Return the next or previous window of WINDOW in cyclic ordering
1884 of windows. NEXT_P non-zero means return the next window. See the
1885 documentation string of next-window for the meaning of MINIBUF and
1886 ALL_FRAMES. */
1888 static Lisp_Object
1889 next_window (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames, int next_p)
1891 decode_next_window_args (&window, &minibuf, &all_frames);
1893 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
1894 return the first window on the frame. */
1895 if (FRAMEP (all_frames)
1896 && !EQ (all_frames, XWINDOW (window)->frame))
1897 return Fframe_first_window (all_frames);
1899 if (next_p)
1901 Lisp_Object list;
1903 /* Find WINDOW in the list of all windows. */
1904 list = Fmemq (window, window_list ());
1906 /* Scan forward from WINDOW to the end of the window list. */
1907 if (CONSP (list))
1908 for (list = XCDR (list); CONSP (list); list = XCDR (list))
1909 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1910 break;
1912 /* Scan from the start of the window list up to WINDOW. */
1913 if (!CONSP (list))
1914 for (list = Vwindow_list;
1915 CONSP (list) && !EQ (XCAR (list), window);
1916 list = XCDR (list))
1917 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1918 break;
1920 if (CONSP (list))
1921 window = XCAR (list);
1923 else
1925 Lisp_Object candidate, list;
1927 /* Scan through the list of windows for candidates. If there are
1928 candidate windows in front of WINDOW, the last one of these
1929 is the one we want. If there are candidates following WINDOW
1930 in the list, again the last one of these is the one we want. */
1931 candidate = Qnil;
1932 for (list = window_list (); CONSP (list); list = XCDR (list))
1934 if (EQ (XCAR (list), window))
1936 if (WINDOWP (candidate))
1937 break;
1939 else if (candidate_window_p (XCAR (list), window, minibuf,
1940 all_frames))
1941 candidate = XCAR (list);
1944 if (WINDOWP (candidate))
1945 window = candidate;
1948 return window;
1952 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
1953 doc: /* Return window following WINDOW in cyclic ordering of windows.
1954 WINDOW defaults to the selected window. The optional arguments
1955 MINIBUF and ALL-FRAMES specify the set of windows to consider.
1957 MINIBUF t means consider the minibuffer window even if the
1958 minibuffer is not active. MINIBUF nil or omitted means consider
1959 the minibuffer window only if the minibuffer is active. Any
1960 other value means do not consider the minibuffer window even if
1961 the minibuffer is active.
1963 Several frames may share a single minibuffer; if the minibuffer
1964 is active, all windows on all frames that share that minibuffer
1965 are considered too. Therefore, if you are using a separate
1966 minibuffer frame and the minibuffer is active and MINIBUF says it
1967 counts, `next-window' considers the windows in the frame from
1968 which you entered the minibuffer, as well as the minibuffer
1969 window.
1971 ALL-FRAMES nil or omitted means consider all windows on WINDOW's
1972 frame, plus the minibuffer window if specified by the MINIBUF
1973 argument, see above. If the minibuffer counts, consider all
1974 windows on all frames that share that minibuffer too.
1975 ALL-FRAMES t means consider all windows on all existing frames.
1976 ALL-FRAMES `visible' means consider all windows on all visible
1977 frames.
1978 ALL-FRAMES 0 means consider all windows on all visible and
1979 iconified frames.
1980 ALL-FRAMES a frame means consider all windows on that frame only.
1981 Anything else means consider all windows on WINDOW's frame and no
1982 others.
1984 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
1985 `next-window' to iterate through the entire cycle of acceptable
1986 windows, eventually ending up back at the window you started with.
1987 `previous-window' traverses the same cycle, in the reverse order. */)
1988 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
1990 return next_window (window, minibuf, all_frames, 1);
1994 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
1995 doc: /* Return window preceding WINDOW in cyclic ordering of windows.
1996 WINDOW defaults to the selected window. The optional arguments
1997 MINIBUF and ALL-FRAMES specify the set of windows to consider.
1998 For the precise meaning of these arguments see `next-window'.
2000 If you use consistent values for MINIBUF and ALL-FRAMES, you can
2001 use `previous-window' to iterate through the entire cycle of
2002 acceptable windows, eventually ending up back at the window you
2003 started with. `next-window' traverses the same cycle, in the
2004 reverse order. */)
2005 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2007 return next_window (window, minibuf, all_frames, 0);
2011 DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p",
2012 doc: /* Select another window in cyclic ordering of windows.
2013 COUNT specifies the number of windows to skip, starting with the
2014 selected window, before making the selection. If COUNT is
2015 positive, skip COUNT windows forwards. If COUNT is negative,
2016 skip -COUNT windows backwards. COUNT zero means do not skip any
2017 window, so select the selected window. In an interactive call,
2018 COUNT is the numeric prefix argument. Return nil.
2020 This function uses `next-window' for finding the window to select.
2021 The argument ALL-FRAMES has the same meaning as in `next-window',
2022 but the MINIBUF argument of `next-window' is always effectively
2023 nil. */)
2024 (Lisp_Object count, Lisp_Object all_frames)
2026 Lisp_Object window;
2027 int i;
2029 CHECK_NUMBER (count);
2030 window = selected_window;
2032 for (i = XINT (count); i > 0; --i)
2033 window = Fnext_window (window, Qnil, all_frames);
2034 for (; i < 0; ++i)
2035 window = Fprevious_window (window, Qnil, all_frames);
2037 Fselect_window (window, Qnil);
2038 return Qnil;
2042 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
2043 doc: /* Return a list of windows on FRAME, starting with WINDOW.
2044 FRAME nil or omitted means use the selected frame.
2045 WINDOW nil or omitted means use the selected window.
2046 MINIBUF t means include the minibuffer window, even if it isn't active.
2047 MINIBUF nil or omitted means include the minibuffer window only
2048 if it's active.
2049 MINIBUF neither nil nor t means never include the minibuffer window. */)
2050 (Lisp_Object frame, Lisp_Object minibuf, Lisp_Object window)
2052 if (NILP (window))
2053 window = FRAMEP (frame) ? XFRAME (frame)->selected_window : selected_window;
2054 CHECK_WINDOW (window);
2055 if (NILP (frame))
2056 frame = selected_frame;
2058 if (!EQ (frame, XWINDOW (window)->frame))
2059 error ("Window is on a different frame");
2061 return window_list_1 (window, minibuf, frame);
2065 /* Return a list of windows in cyclic ordering. Arguments are like
2066 for `next-window'. */
2068 static Lisp_Object
2069 window_list_1 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2071 Lisp_Object tail, list, rest;
2073 decode_next_window_args (&window, &minibuf, &all_frames);
2074 list = Qnil;
2076 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
2077 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
2078 list = Fcons (XCAR (tail), list);
2080 /* Rotate the list to start with WINDOW. */
2081 list = Fnreverse (list);
2082 rest = Fmemq (window, list);
2083 if (!NILP (rest) && !EQ (rest, list))
2085 for (tail = list; !EQ (XCDR (tail), rest); tail = XCDR (tail))
2087 XSETCDR (tail, Qnil);
2088 list = nconc2 (rest, list);
2090 return list;
2095 /* Look at all windows, performing an operation specified by TYPE
2096 with argument OBJ.
2097 If FRAMES is Qt, look at all frames;
2098 Qnil, look at just the selected frame;
2099 Qvisible, look at visible frames;
2100 a frame, just look at windows on that frame.
2101 If MINI is non-zero, perform the operation on minibuffer windows too. */
2103 enum window_loop
2105 WINDOW_LOOP_UNUSED,
2106 GET_BUFFER_WINDOW, /* Arg is buffer */
2107 GET_LRU_WINDOW, /* Arg is t for full-width windows only */
2108 DELETE_OTHER_WINDOWS, /* Arg is window not to delete */
2109 DELETE_BUFFER_WINDOWS, /* Arg is buffer */
2110 GET_LARGEST_WINDOW,
2111 UNSHOW_BUFFER, /* Arg is buffer */
2112 REDISPLAY_BUFFER_WINDOWS, /* Arg is buffer */
2113 CHECK_ALL_WINDOWS
2116 static Lisp_Object
2117 window_loop (enum window_loop type, Lisp_Object obj, int mini, Lisp_Object frames)
2119 Lisp_Object window, windows, best_window, frame_arg;
2120 struct frame *f;
2121 struct gcpro gcpro1;
2123 /* If we're only looping through windows on a particular frame,
2124 frame points to that frame. If we're looping through windows
2125 on all frames, frame is 0. */
2126 if (FRAMEP (frames))
2127 f = XFRAME (frames);
2128 else if (NILP (frames))
2129 f = SELECTED_FRAME ();
2130 else
2131 f = NULL;
2133 if (f)
2134 frame_arg = Qlambda;
2135 else if (EQ (frames, make_number (0)))
2136 frame_arg = frames;
2137 else if (EQ (frames, Qvisible))
2138 frame_arg = frames;
2139 else
2140 frame_arg = Qt;
2142 /* frame_arg is Qlambda to stick to one frame,
2143 Qvisible to consider all visible frames,
2144 or Qt otherwise. */
2146 /* Pick a window to start with. */
2147 if (WINDOWP (obj))
2148 window = obj;
2149 else if (f)
2150 window = FRAME_SELECTED_WINDOW (f);
2151 else
2152 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2154 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
2155 GCPRO1 (windows);
2156 best_window = Qnil;
2158 for (; CONSP (windows); windows = XCDR (windows))
2160 struct window *w;
2162 window = XCAR (windows);
2163 w = XWINDOW (window);
2165 /* Note that we do not pay attention here to whether the frame
2166 is visible, since Fwindow_list skips non-visible frames if
2167 that is desired, under the control of frame_arg. */
2168 if (!MINI_WINDOW_P (w)
2169 /* For UNSHOW_BUFFER, we must always consider all windows. */
2170 || type == UNSHOW_BUFFER
2171 || (mini && minibuf_level > 0))
2172 switch (type)
2174 case GET_BUFFER_WINDOW:
2175 if (EQ (w->buffer, obj)
2176 /* Don't find any minibuffer window
2177 except the one that is currently in use. */
2178 && (MINI_WINDOW_P (w)
2179 ? EQ (window, minibuf_window)
2180 : 1))
2182 if (NILP (best_window))
2183 best_window = window;
2184 else if (EQ (window, selected_window))
2185 /* Prefer to return selected-window. */
2186 RETURN_UNGCPRO (window);
2187 else if (EQ (Fwindow_frame (window), selected_frame))
2188 /* Prefer windows on the current frame. */
2189 best_window = window;
2191 break;
2193 case GET_LRU_WINDOW:
2194 /* `obj' is an integer encoding a bitvector.
2195 `obj & 1' means consider only full-width windows.
2196 `obj & 2' means consider also dedicated windows. */
2197 if (((XINT (obj) & 1) && !WINDOW_FULL_WIDTH_P (w))
2198 || (!(XINT (obj) & 2) && !NILP (w->dedicated))
2199 /* Minibuffer windows are always ignored. */
2200 || MINI_WINDOW_P (w))
2201 break;
2202 if (NILP (best_window)
2203 || (XFASTINT (XWINDOW (best_window)->use_time)
2204 > XFASTINT (w->use_time)))
2205 best_window = window;
2206 break;
2208 case DELETE_OTHER_WINDOWS:
2209 if (!EQ (window, obj))
2210 Fdelete_window (window);
2211 break;
2213 case DELETE_BUFFER_WINDOWS:
2214 if (EQ (w->buffer, obj))
2216 struct frame *f = XFRAME (WINDOW_FRAME (w));
2218 /* If this window is dedicated, and in a frame of its own,
2219 kill the frame. */
2220 if (EQ (window, FRAME_ROOT_WINDOW (f))
2221 && !NILP (w->dedicated)
2222 && other_visible_frames (f))
2224 /* Skip the other windows on this frame.
2225 There might be one, the minibuffer! */
2226 while (CONSP (XCDR (windows))
2227 && EQ (XWINDOW (XCAR (windows))->frame,
2228 XWINDOW (XCAR (XCDR (windows)))->frame))
2229 windows = XCDR (windows);
2231 /* Now we can safely delete the frame. */
2232 delete_frame (w->frame, Qnil);
2234 else if (NILP (w->parent))
2236 /* If we're deleting the buffer displayed in the
2237 only window on the frame, find a new buffer to
2238 display there. */
2239 Lisp_Object buffer;
2240 buffer = Fother_buffer (obj, Qnil, w->frame);
2241 /* Reset dedicated state of window. */
2242 w->dedicated = Qnil;
2243 Fset_window_buffer (window, buffer, Qnil);
2244 if (EQ (window, selected_window))
2245 Fset_buffer (w->buffer);
2247 else
2248 Fdelete_window (window);
2250 break;
2252 case GET_LARGEST_WINDOW:
2253 { /* nil `obj' means to ignore dedicated windows. */
2254 /* Ignore dedicated windows and minibuffers. */
2255 if (MINI_WINDOW_P (w) || (NILP (obj) && !NILP (w->dedicated)))
2256 break;
2258 if (NILP (best_window))
2259 best_window = window;
2260 else
2262 struct window *b = XWINDOW (best_window);
2263 if (XFASTINT (w->total_lines) * XFASTINT (w->total_cols)
2264 > XFASTINT (b->total_lines) * XFASTINT (b->total_cols))
2265 best_window = window;
2268 break;
2270 case UNSHOW_BUFFER:
2271 if (EQ (w->buffer, obj))
2273 Lisp_Object buffer;
2274 struct frame *f = XFRAME (w->frame);
2276 /* Find another buffer to show in this window. */
2277 buffer = Fother_buffer (obj, Qnil, w->frame);
2279 /* If this window is dedicated, and in a frame of its own,
2280 kill the frame. */
2281 if (EQ (window, FRAME_ROOT_WINDOW (f))
2282 && !NILP (w->dedicated)
2283 && other_visible_frames (f))
2285 /* Skip the other windows on this frame.
2286 There might be one, the minibuffer! */
2287 while (CONSP (XCDR (windows))
2288 && EQ (XWINDOW (XCAR (windows))->frame,
2289 XWINDOW (XCAR (XCDR (windows)))->frame))
2290 windows = XCDR (windows);
2292 /* Now we can safely delete the frame. */
2293 delete_frame (w->frame, Qnil);
2295 else if (!NILP (w->dedicated) && !NILP (w->parent))
2297 Lisp_Object window;
2298 XSETWINDOW (window, w);
2299 /* If this window is dedicated and not the only window
2300 in its frame, then kill it. */
2301 Fdelete_window (window);
2303 else
2305 /* Otherwise show a different buffer in the window. */
2306 w->dedicated = Qnil;
2307 Fset_window_buffer (window, buffer, Qnil);
2308 if (EQ (window, selected_window))
2309 Fset_buffer (w->buffer);
2312 break;
2314 case REDISPLAY_BUFFER_WINDOWS:
2315 if (EQ (w->buffer, obj))
2317 mark_window_display_accurate (window, 0);
2318 w->update_mode_line = Qt;
2319 XBUFFER (obj)->prevent_redisplay_optimizations_p = 1;
2320 ++update_mode_lines;
2321 best_window = window;
2323 break;
2325 /* Check for a window that has a killed buffer. */
2326 case CHECK_ALL_WINDOWS:
2327 if (! NILP (w->buffer)
2328 && NILP (BVAR (XBUFFER (w->buffer), name)))
2329 abort ();
2330 break;
2332 case WINDOW_LOOP_UNUSED:
2333 break;
2337 UNGCPRO;
2338 return best_window;
2341 /* Used for debugging. Abort if any window has a dead buffer. */
2343 void
2344 check_all_windows (void)
2346 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2349 DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
2350 doc: /* Return WINDOW's use time.
2351 WINDOW defaults to the selected window. The window with the highest use
2352 time is the most recently selected one. The window with the lowest use
2353 time is the least recently selected one. */)
2354 (Lisp_Object window)
2356 return decode_window (window)->use_time;
2359 DEFUN ("get-lru-window", Fget_lru_window, Sget_lru_window, 0, 2, 0,
2360 doc: /* Return the window least recently selected or used for display.
2361 \(LRU means Least Recently Used.)
2363 Return a full-width window if possible.
2364 A minibuffer window is never a candidate.
2365 A dedicated window is never a candidate, unless DEDICATED is non-nil,
2366 so if all windows are dedicated, the value is nil.
2367 If optional argument FRAME is `visible', search all visible frames.
2368 If FRAME is 0, search all visible and iconified frames.
2369 If FRAME is t, search all frames.
2370 If FRAME is nil, search only the selected frame.
2371 If FRAME is a frame, search only that frame. */)
2372 (Lisp_Object frame, Lisp_Object dedicated)
2374 register Lisp_Object w;
2375 /* First try for a window that is full-width */
2376 w = window_loop (GET_LRU_WINDOW,
2377 NILP (dedicated) ? make_number (1) : make_number (3),
2378 0, frame);
2379 if (!NILP (w) && !EQ (w, selected_window))
2380 return w;
2381 /* If none of them, try the rest */
2382 return window_loop (GET_LRU_WINDOW,
2383 NILP (dedicated) ? make_number (0) : make_number (2),
2384 0, frame);
2387 DEFUN ("get-largest-window", Fget_largest_window, Sget_largest_window, 0, 2, 0,
2388 doc: /* Return the largest window in area.
2389 A minibuffer window is never a candidate.
2390 A dedicated window is never a candidate unless DEDICATED is non-nil,
2391 so if all windows are dedicated, the value is nil.
2392 If optional argument FRAME is `visible', search all visible frames.
2393 If FRAME is 0, search all visible and iconified frames.
2394 If FRAME is t, search all frames.
2395 If FRAME is nil, search only the selected frame.
2396 If FRAME is a frame, search only that frame. */)
2397 (Lisp_Object frame, Lisp_Object dedicated)
2399 return window_loop (GET_LARGEST_WINDOW, dedicated, 0,
2400 frame);
2403 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 0, 2, 0,
2404 doc: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2405 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to the
2406 current buffer.
2407 If optional argument FRAME is `visible', search all visible frames.
2408 If optional argument FRAME is 0, search all visible and iconified frames.
2409 If FRAME is t, search all frames.
2410 If FRAME is nil, search only the selected frame.
2411 If FRAME is a frame, search only that frame. */)
2412 (Lisp_Object buffer_or_name, Lisp_Object frame)
2414 Lisp_Object buffer;
2416 if (NILP (buffer_or_name))
2417 buffer = Fcurrent_buffer ();
2418 else
2419 buffer = Fget_buffer (buffer_or_name);
2421 if (BUFFERP (buffer))
2422 return window_loop (GET_BUFFER_WINDOW, buffer, 1, frame);
2423 else
2424 return Qnil;
2427 DEFUN ("delete-other-windows", Fdelete_other_windows, Sdelete_other_windows,
2428 0, 1, "",
2429 doc: /* Make WINDOW (or the selected window) fill its frame.
2430 Only the frame WINDOW is on is affected.
2431 This function tries to reduce display jumps by keeping the text
2432 previously visible in WINDOW in the same place on the frame. Doing this
2433 depends on the value of (window-start WINDOW), so if calling this
2434 function in a program gives strange scrolling, make sure the
2435 window-start value is reasonable when this function is called. */)
2436 (Lisp_Object window)
2438 struct window *w;
2439 EMACS_INT startpos;
2440 int top, new_top;
2442 if (NILP (window))
2443 window = selected_window;
2444 else
2445 CHECK_LIVE_WINDOW (window);
2446 w = XWINDOW (window);
2448 startpos = marker_position (w->start);
2449 top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2451 if (MINI_WINDOW_P (w) && top > 0)
2452 error ("Can't expand minibuffer to full frame");
2454 window_loop (DELETE_OTHER_WINDOWS, window, 0, WINDOW_FRAME (w));
2456 /* Try to minimize scrolling, by setting the window start to the point
2457 will cause the text at the old window start to be at the same place
2458 on the frame. But don't try to do this if the window start is
2459 outside the visible portion (as might happen when the display is
2460 not current, due to typeahead). */
2461 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2462 if (new_top != top
2463 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2464 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2466 struct position pos;
2467 struct buffer *obuf = current_buffer;
2469 Fset_buffer (w->buffer);
2470 /* This computation used to temporarily move point, but that can
2471 have unwanted side effects due to text properties. */
2472 pos = *vmotion (startpos, -top, w);
2474 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2475 w->window_end_valid = Qnil;
2476 w->start_at_line_beg = ((pos.bytepos == BEGV_BYTE
2477 || FETCH_BYTE (pos.bytepos - 1) == '\n') ? Qt
2478 : Qnil);
2479 /* We need to do this, so that the window-scroll-functions
2480 get called. */
2481 w->optional_new_start = Qt;
2483 set_buffer_internal (obuf);
2486 return Qnil;
2489 DEFUN ("delete-windows-on", Fdelete_windows_on, Sdelete_windows_on,
2490 0, 2, "bDelete windows on (buffer): ",
2491 doc: /* Delete all windows showing BUFFER-OR-NAME.
2492 BUFFER-OR-NAME may be a buffer or the name of an existing buffer and
2493 defaults to the current buffer.
2495 Optional second argument FRAME controls which frames are affected.
2496 If optional argument FRAME is `visible', search all visible frames.
2497 If FRAME is 0, search all visible and iconified frames.
2498 If FRAME is nil, search all frames.
2499 If FRAME is t, search only the selected frame.
2500 If FRAME is a frame, search only that frame.
2501 When a window showing BUFFER-OR-NAME is dedicated and the only window of
2502 its frame, that frame is deleted when there are other frames left. */)
2503 (Lisp_Object buffer_or_name, Lisp_Object frame)
2505 Lisp_Object buffer;
2507 /* FRAME uses t and nil to mean the opposite of what window_loop
2508 expects. */
2509 if (NILP (frame))
2510 frame = Qt;
2511 else if (EQ (frame, Qt))
2512 frame = Qnil;
2514 if (NILP (buffer_or_name))
2515 buffer = Fcurrent_buffer ();
2516 else
2518 buffer = Fget_buffer (buffer_or_name);
2519 CHECK_BUFFER (buffer);
2522 window_loop (DELETE_BUFFER_WINDOWS, buffer, 0, frame);
2524 return Qnil;
2527 DEFUN ("replace-buffer-in-windows", Freplace_buffer_in_windows,
2528 Sreplace_buffer_in_windows,
2529 0, 1, "bReplace buffer in windows: ",
2530 doc: /* Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2531 BUFFER-OR-NAME may be a buffer or the name of an existing buffer and
2532 defaults to the current buffer.
2534 When a window showing BUFFER-OR-NAME is dedicated that window is
2535 deleted. If that window is the only window on its frame, that frame is
2536 deleted too when there are other frames left. If there are no other
2537 frames left, some other buffer is displayed in that window. */)
2538 (Lisp_Object buffer_or_name)
2540 Lisp_Object buffer;
2542 if (NILP (buffer_or_name))
2543 buffer = Fcurrent_buffer ();
2544 else
2546 buffer = Fget_buffer (buffer_or_name);
2547 CHECK_BUFFER (buffer);
2550 window_loop (UNSHOW_BUFFER, buffer, 0, Qt);
2552 return Qnil;
2555 /* Replace BUFFER with some other buffer in all windows
2556 of all frames, even those on other keyboards. */
2558 void
2559 replace_buffer_in_all_windows (Lisp_Object buffer)
2561 Lisp_Object tail, frame;
2563 /* A single call to window_loop won't do the job
2564 because it only considers frames on the current keyboard.
2565 So loop manually over frames, and handle each one. */
2566 FOR_EACH_FRAME (tail, frame)
2567 window_loop (UNSHOW_BUFFER, buffer, 1, frame);
2570 /* Set the height of WINDOW and all its inferiors. */
2572 /* The smallest acceptable dimensions for a window. Anything smaller
2573 might crash Emacs. */
2575 #define MIN_SAFE_WINDOW_WIDTH (2)
2576 #define MIN_SAFE_WINDOW_HEIGHT (1)
2578 /* For wp non-zero the total number of columns of window w. Otherwise
2579 the total number of lines of w. */
2581 #define WINDOW_TOTAL_SIZE(w, wp) \
2582 (wp ? WINDOW_TOTAL_COLS (w) : WINDOW_TOTAL_LINES (w))
2584 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2585 minimum allowable size. */
2587 void
2588 check_frame_size (FRAME_PTR frame, int *rows, int *cols)
2590 /* For height, we have to see:
2591 how many windows the frame has at minimum (one or two),
2592 and whether it has a menu bar or other special stuff at the top. */
2593 int min_height
2594 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
2595 ? MIN_SAFE_WINDOW_HEIGHT
2596 : 2 * MIN_SAFE_WINDOW_HEIGHT);
2598 if (FRAME_TOP_MARGIN (frame) > 0)
2599 min_height += FRAME_TOP_MARGIN (frame);
2601 if (*rows < min_height)
2602 *rows = min_height;
2603 if (*cols < MIN_SAFE_WINDOW_WIDTH)
2604 *cols = MIN_SAFE_WINDOW_WIDTH;
2607 /* Value is non-zero if window W is fixed-size. WIDTH_P non-zero means
2608 check if W's width can be changed, otherwise check W's height.
2609 CHECK_SIBLINGS_P non-zero means check resizablity of WINDOW's
2610 siblings, too. If none of the siblings is resizable, WINDOW isn't
2611 either. */
2613 static int
2614 window_fixed_size_p (struct window *w, int width_p, int check_siblings_p)
2616 int fixed_p;
2617 struct window *c;
2619 if (!NILP (w->hchild))
2621 c = XWINDOW (w->hchild);
2623 if (width_p)
2625 /* A horizontal combination is fixed-width if all of if its
2626 children are. */
2627 while (c && window_fixed_size_p (c, width_p, 0))
2628 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2629 fixed_p = c == NULL;
2631 else
2633 /* A horizontal combination is fixed-height if one of if its
2634 children is. */
2635 while (c && !window_fixed_size_p (c, width_p, 0))
2636 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2637 fixed_p = c != NULL;
2640 else if (!NILP (w->vchild))
2642 c = XWINDOW (w->vchild);
2644 if (width_p)
2646 /* A vertical combination is fixed-width if one of if its
2647 children is. */
2648 while (c && !window_fixed_size_p (c, width_p, 0))
2649 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2650 fixed_p = c != NULL;
2652 else
2654 /* A vertical combination is fixed-height if all of if its
2655 children are. */
2656 while (c && window_fixed_size_p (c, width_p, 0))
2657 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2658 fixed_p = c == NULL;
2661 else if (BUFFERP (w->buffer))
2663 struct buffer *old = current_buffer;
2664 Lisp_Object val;
2666 current_buffer = XBUFFER (w->buffer);
2667 val = find_symbol_value (Qwindow_size_fixed);
2668 current_buffer = old;
2670 fixed_p = 0;
2671 if (!EQ (val, Qunbound))
2673 fixed_p = !NILP (val);
2675 if (fixed_p
2676 && ((EQ (val, Qheight) && width_p)
2677 || (EQ (val, Qwidth) && !width_p)))
2678 fixed_p = 0;
2681 /* Can't tell if this one is resizable without looking at
2682 siblings. If all siblings are fixed-size this one is too. */
2683 if (!fixed_p && check_siblings_p && WINDOWP (w->parent))
2685 Lisp_Object child;
2687 for (child = w->prev; WINDOWP (child); child = XWINDOW (child)->prev)
2688 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2689 break;
2691 if (NILP (child))
2692 for (child = w->next; WINDOWP (child); child = XWINDOW (child)->next)
2693 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2694 break;
2696 if (NILP (child))
2697 fixed_p = 1;
2700 else
2701 fixed_p = 1;
2703 return fixed_p;
2706 /* Return minimum size of leaf window W. WIDTH_P non-zero means return
2707 the minimum width of W, WIDTH_P zero means return the minimum height
2708 of W. SAFE_P non-zero means ignore window-min-height|width but just
2709 return values that won't crash Emacs and don't hide components like
2710 fringes, scrollbars, or modelines. If WIDTH_P is zero and W is the
2711 minibuffer window, always return 1. */
2713 static int
2714 window_min_size_2 (struct window *w, int width_p, int safe_p)
2716 /* We should consider buffer-local values of window_min_height and
2717 window_min_width here. */
2718 if (width_p)
2720 int safe_size = (MIN_SAFE_WINDOW_WIDTH
2721 + WINDOW_FRINGE_COLS (w)
2722 + WINDOW_SCROLL_BAR_COLS (w));
2724 return safe_p ? safe_size : max (window_min_width, safe_size);
2726 else if (MINI_WINDOW_P (w))
2727 return 1;
2728 else
2730 int safe_size = (MIN_SAFE_WINDOW_HEIGHT
2731 + ((BUFFERP (w->buffer)
2732 && !NILP (BVAR (XBUFFER (w->buffer), mode_line_format)))
2733 ? 1 : 0));
2735 return safe_p ? safe_size : max (window_min_height, safe_size);
2739 /* Return minimum size of window W, not taking fixed-width windows into
2740 account. WIDTH_P non-zero means return the minimum width, otherwise
2741 return the minimum height. SAFE_P non-zero means ignore
2742 window-min-height|width but just return values that won't crash Emacs
2743 and don't hide components like fringes, scrollbars, or modelines. If
2744 W is a combination window, compute the minimum size from the minimum
2745 sizes of W's children. */
2747 static int
2748 window_min_size_1 (struct window *w, int width_p, int safe_p)
2750 struct window *c;
2751 int size;
2753 if (!NILP (w->hchild))
2755 /* W is a horizontal combination. */
2756 c = XWINDOW (w->hchild);
2757 size = 0;
2759 if (width_p)
2761 /* The minimum width of a horizontal combination is the sum of
2762 the minimum widths of its children. */
2763 while (c)
2765 size += window_min_size_1 (c, 1, safe_p);
2766 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2769 else
2771 /* The minimum height of a horizontal combination is the
2772 maximum of the minimum heights of its children. */
2773 while (c)
2775 size = max (window_min_size_1 (c, 0, safe_p), size);
2776 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2780 else if (!NILP (w->vchild))
2782 /* W is a vertical combination. */
2783 c = XWINDOW (w->vchild);
2784 size = 0;
2786 if (width_p)
2788 /* The minimum width of a vertical combination is the maximum
2789 of the minimum widths of its children. */
2790 while (c)
2792 size = max (window_min_size_1 (c, 1, safe_p), size);
2793 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2796 else
2798 /* The minimum height of a vertical combination is the sum of
2799 the minimum height of its children. */
2800 while (c)
2802 size += window_min_size_1 (c, 0, safe_p);
2803 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2807 else
2808 /* W is a leaf window. */
2809 size = window_min_size_2 (w, width_p, safe_p);
2811 return size;
2814 /* Return the minimum size of window W, taking fixed-size windows into
2815 account. WIDTH_P non-zero means return the minimum width, otherwise
2816 return the minimum height. SAFE_P non-zero means ignore
2817 window-min-height|width but just return values that won't crash Emacs
2818 and don't hide components like fringes, scrollbars, or modelines.
2819 IGNORE_FIXED_P non-zero means ignore if W is fixed-size. Set *FIXED
2820 to 1 if W is fixed-size unless FIXED is null. */
2822 static int
2823 window_min_size (struct window *w, int width_p, int safe_p, int ignore_fixed_p, int *fixed)
2825 int size, fixed_p;
2827 if (ignore_fixed_p)
2828 fixed_p = 0;
2829 else
2830 fixed_p = window_fixed_size_p (w, width_p, 1);
2832 if (fixed)
2833 *fixed = fixed_p;
2835 if (fixed_p)
2836 size = WINDOW_TOTAL_SIZE (w, width_p);
2837 else
2838 size = window_min_size_1 (w, width_p, safe_p);
2840 return size;
2844 /* Adjust the margins of window W if text area is too small.
2845 Return 1 if window width is ok after adjustment; 0 if window
2846 is still too narrow. */
2848 static int
2849 adjust_window_margins (struct window *w)
2851 int box_cols = (WINDOW_TOTAL_COLS (w)
2852 - WINDOW_FRINGE_COLS (w)
2853 - WINDOW_SCROLL_BAR_COLS (w));
2854 int margin_cols = (WINDOW_LEFT_MARGIN_COLS (w)
2855 + WINDOW_RIGHT_MARGIN_COLS (w));
2857 if (box_cols - margin_cols >= MIN_SAFE_WINDOW_WIDTH)
2858 return 1;
2860 if (margin_cols < 0 || box_cols < MIN_SAFE_WINDOW_WIDTH)
2861 return 0;
2863 /* Window's text area is too narrow, but reducing the window
2864 margins will fix that. */
2865 margin_cols = box_cols - MIN_SAFE_WINDOW_WIDTH;
2866 if (WINDOW_RIGHT_MARGIN_COLS (w) > 0)
2868 if (WINDOW_LEFT_MARGIN_COLS (w) > 0)
2869 w->left_margin_cols = w->right_margin_cols
2870 = make_number (margin_cols/2);
2871 else
2872 w->right_margin_cols = make_number (margin_cols);
2874 else
2875 w->left_margin_cols = make_number (margin_cols);
2876 return 1;
2879 /* Calculate new sizes for windows in the list FORWARD when their
2880 compound size goes from TOTAL to SIZE. TOTAL must be greater than
2881 SIZE. The number of windows in FORWARD is NCHILDREN, and the number
2882 that can shrink is SHRINKABLE. Fixed-size windows may be shrunk if
2883 and only if RESIZE_FIXED_P is non-zero. WIDTH_P non-zero means
2884 shrink columns, otherwise shrink lines.
2886 SAFE_P zero means windows may be sized down to window-min-height
2887 lines (window-min-window columns for WIDTH_P non-zero). SAFE_P
2888 non-zero means windows may be sized down to their minimum safe sizes
2889 taking into account the space needed to display modelines, fringes,
2890 and scrollbars.
2892 This function returns an allocated array of new sizes that the caller
2893 must free. A size -1 means the window is fixed and RESIZE_FIXED_P is
2894 zero. A size zero means the window shall be deleted. Array index 0
2895 refers to the first window in FORWARD, 1 to the second, and so on.
2897 This function resizes windows proportionally to their size. It also
2898 tries to preserve smaller windows by resizing larger windows before
2899 resizing any window to zero. If resize_proportionally is non-nil for
2900 a specific window, it will attempt to strictly resize that window
2901 proportionally, even at the expense of deleting smaller windows. */
2902 static int *
2903 shrink_windows (int total, int size, int nchildren, int shrinkable,
2904 int resize_fixed_p, Lisp_Object forward, int width_p, int safe_p)
2906 int available_resize = 0;
2907 int *new_sizes, *min_sizes;
2908 struct window *c;
2909 Lisp_Object child;
2910 int smallest = total;
2911 int total_removed = 0;
2912 int total_shrink = total - size;
2913 int i;
2915 new_sizes = xmalloc (sizeof (*new_sizes) * nchildren);
2916 min_sizes = xmalloc (sizeof (*min_sizes) * nchildren);
2918 for (i = 0, child = forward; !NILP (child); child = c->next, ++i)
2920 int child_size;
2922 c = XWINDOW (child);
2923 child_size = WINDOW_TOTAL_SIZE (c, width_p);
2925 if (!resize_fixed_p && window_fixed_size_p (c, width_p, 0))
2926 new_sizes[i] = -1;
2927 else
2929 new_sizes[i] = child_size;
2930 min_sizes[i] = window_min_size_1 (c, width_p, safe_p);
2931 if (child_size > min_sizes[i]
2932 && NILP (c->resize_proportionally))
2933 available_resize += child_size - min_sizes[i];
2936 /* We might need to shrink some windows to zero. Find the smallest
2937 windows and set them to 0 until we can fulfil the new size. */
2939 while (shrinkable > 1 && size + available_resize < total)
2941 for (i = 0; i < nchildren; ++i)
2942 if (new_sizes[i] > 0 && smallest > new_sizes[i])
2943 smallest = new_sizes[i];
2945 for (i = 0; i < nchildren; ++i)
2946 if (new_sizes[i] == smallest)
2948 /* Resize this window down to zero. */
2949 new_sizes[i] = 0;
2950 if (smallest > min_sizes[i])
2951 available_resize -= smallest - min_sizes[i];
2952 available_resize += smallest;
2953 --shrinkable;
2954 total_removed += smallest;
2956 /* We don't know what the smallest is now. */
2957 smallest = total;
2959 /* Out of for, just remove one window at the time and
2960 check again if we have enough space. */
2961 break;
2965 /* Now, calculate the new sizes. Try to shrink each window
2966 proportional to its size. */
2967 for (i = 0; i < nchildren; ++i)
2969 if (new_sizes[i] > min_sizes[i])
2971 int to_shrink = total_shrink * new_sizes[i] / total;
2973 if (new_sizes[i] - to_shrink < min_sizes[i])
2974 to_shrink = new_sizes[i] - min_sizes[i];
2975 new_sizes[i] -= to_shrink;
2976 total_removed += to_shrink;
2980 /* Any reminder due to rounding, we just subtract from windows
2981 that are left and still can be shrunk. */
2982 while (total_shrink > total_removed)
2984 int nonzero_sizes = 0;
2985 int nonzero_idx = -1;
2987 for (i = 0; i < nchildren; ++i)
2988 if (new_sizes[i] > 0)
2990 ++nonzero_sizes;
2991 nonzero_idx = i;
2994 for (i = 0; i < nchildren; ++i)
2995 if (new_sizes[i] > min_sizes[i])
2997 --new_sizes[i];
2998 ++total_removed;
3000 /* Out of for, just shrink one window at the time and
3001 check again if we have enough space. */
3002 break;
3005 /* Special case, only one window left. */
3006 if (nonzero_sizes == 1)
3007 break;
3010 /* Any surplus due to rounding, we add to windows that are left. */
3011 while (total_shrink < total_removed)
3013 for (i = 0; i < nchildren; ++i)
3015 if (new_sizes[i] != 0 && total_shrink < total_removed)
3017 ++new_sizes[i];
3018 --total_removed;
3019 break;
3024 xfree (min_sizes);
3026 return new_sizes;
3029 /* Set WINDOW's height or width to SIZE. WIDTH_P non-zero means set
3030 WINDOW's width. Resize WINDOW's children, if any, so that they keep
3031 their proportionate size relative to WINDOW.
3033 If FIRST_ONLY is 1, change only the first of WINDOW's children when
3034 they are in series. If LAST_ONLY is 1, change only the last of
3035 WINDOW's children when they are in series.
3037 Propagate WINDOW's top or left edge position to children. Delete
3038 windows that become too small unless NODELETE_P is 1. When
3039 NODELETE_P equals 2 do not honor settings for window-min-height and
3040 window-min-width when resizing windows but use safe defaults instead.
3041 This should give better behavior when resizing frames. */
3043 static void
3044 size_window (Lisp_Object window, int size, int width_p, int nodelete_p, int first_only, int last_only)
3046 struct window *w = XWINDOW (window);
3047 struct window *c;
3048 Lisp_Object child, *forward, *sideward;
3049 int old_size = WINDOW_TOTAL_SIZE (w, width_p);
3051 size = max (0, size);
3053 /* Delete WINDOW if it's too small. */
3054 if (nodelete_p != 1 && !NILP (w->parent)
3055 && size < window_min_size_1 (w, width_p, nodelete_p == 2))
3057 delete_window (window);
3058 return;
3061 /* Set redisplay hints. */
3062 w->last_modified = make_number (0);
3063 w->last_overlay_modified = make_number (0);
3064 windows_or_buffers_changed++;
3065 FRAME_WINDOW_SIZES_CHANGED (XFRAME (w->frame)) = 1;
3067 if (width_p)
3069 sideward = &w->vchild;
3070 forward = &w->hchild;
3071 w->total_cols = make_number (size);
3072 adjust_window_margins (w);
3074 else
3076 sideward = &w->hchild;
3077 forward = &w->vchild;
3078 w->total_lines = make_number (size);
3079 w->orig_total_lines = Qnil;
3082 if (!NILP (*sideward))
3084 /* We have a chain of parallel siblings whose size should all change. */
3085 for (child = *sideward; !NILP (child); child = c->next)
3087 c = XWINDOW (child);
3088 if (width_p)
3089 c->left_col = w->left_col;
3090 else
3091 c->top_line = w->top_line;
3092 size_window (child, size, width_p, nodelete_p,
3093 first_only, last_only);
3096 else if (!NILP (*forward) && last_only)
3098 /* Change the last in a series of siblings. */
3099 Lisp_Object last_child;
3100 int child_size;
3102 for (child = *forward; !NILP (child); child = c->next)
3104 c = XWINDOW (child);
3105 last_child = child;
3108 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3109 size_window (last_child, size - old_size + child_size,
3110 width_p, nodelete_p, first_only, last_only);
3112 else if (!NILP (*forward) && first_only)
3114 /* Change the first in a series of siblings. */
3115 int child_size;
3117 child = *forward;
3118 c = XWINDOW (child);
3120 if (width_p)
3121 c->left_col = w->left_col;
3122 else
3123 c->top_line = w->top_line;
3125 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3126 size_window (child, size - old_size + child_size,
3127 width_p, nodelete_p, first_only, last_only);
3129 else if (!NILP (*forward))
3131 int fixed_size, each, extra, n;
3132 int resize_fixed_p, nfixed;
3133 int last_pos, first_pos, nchildren, total;
3134 int *new_sizes = NULL;
3136 /* Determine the fixed-size portion of this window, and the
3137 number of child windows. */
3138 fixed_size = nchildren = nfixed = total = 0;
3139 for (child = *forward; !NILP (child); child = c->next, ++nchildren)
3141 int child_size;
3143 c = XWINDOW (child);
3144 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3145 total += child_size;
3147 if (window_fixed_size_p (c, width_p, 0))
3149 fixed_size += child_size;
3150 ++nfixed;
3154 /* If the new size is smaller than fixed_size, or if there
3155 aren't any resizable windows, allow resizing fixed-size
3156 windows. */
3157 resize_fixed_p = nfixed == nchildren || size < fixed_size;
3159 /* Compute how many lines/columns to add/remove to each child. The
3160 value of extra takes care of rounding errors. */
3161 n = resize_fixed_p ? nchildren : nchildren - nfixed;
3162 if (size < total && n > 1)
3163 new_sizes = shrink_windows (total, size, nchildren, n,
3164 resize_fixed_p, *forward, width_p,
3165 nodelete_p == 2);
3166 else
3168 each = (size - total) / n;
3169 extra = (size - total) - n * each;
3172 /* Compute new children heights and edge positions. */
3173 first_pos = width_p ? XINT (w->left_col) : XINT (w->top_line);
3174 last_pos = first_pos;
3175 for (n = 0, child = *forward; !NILP (child); child = c->next, ++n)
3177 int new_size, old_size;
3179 c = XWINDOW (child);
3180 old_size = WINDOW_TOTAL_SIZE (c, width_p);
3181 new_size = old_size;
3183 /* The top or left edge position of this child equals the
3184 bottom or right edge of its predecessor. */
3185 if (width_p)
3186 c->left_col = make_number (last_pos);
3187 else
3188 c->top_line = make_number (last_pos);
3190 /* If this child can be resized, do it. */
3191 if (resize_fixed_p || !window_fixed_size_p (c, width_p, 0))
3193 new_size = new_sizes ? new_sizes[n] : old_size + each + extra;
3194 extra = 0;
3197 /* Set new size. Note that size_window also propagates
3198 edge positions to children, so it's not a no-op if we
3199 didn't change the child's size. */
3200 size_window (child, new_size, width_p, 1, first_only, last_only);
3202 /* Remember the bottom/right edge position of this child; it
3203 will be used to set the top/left edge of the next child. */
3204 last_pos += new_size;
3207 xfree (new_sizes);
3209 /* We should have covered the parent exactly with child windows. */
3210 xassert (size == last_pos - first_pos);
3212 /* Now delete any children that became too small. */
3213 if (nodelete_p != 1)
3214 for (child = *forward; !NILP (child); child = c->next)
3216 int child_size;
3218 c = XWINDOW (child);
3219 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3220 size_window (child, child_size, width_p, nodelete_p,
3221 first_only, last_only);
3226 /* Set WINDOW's height to HEIGHT, and recursively change the height of
3227 WINDOW's children. NODELETE zero means windows that have become
3228 smaller than window-min-height in the process may be deleted.
3229 NODELETE 1 means never delete windows that become too small in the
3230 process. (The caller should check later and do so if appropriate.)
3231 NODELETE 2 means delete only windows that have become too small to be
3232 displayed correctly. */
3234 void
3235 set_window_height (Lisp_Object window, int height, int nodelete)
3237 size_window (window, height, 0, nodelete, 0, 0);
3240 /* Set WINDOW's width to WIDTH, and recursively change the width of
3241 WINDOW's children. NODELETE zero means windows that have become
3242 smaller than window-min-width in the process may be deleted.
3243 NODELETE 1 means never delete windows that become too small in the
3244 process. (The caller should check later and do so if appropriate.)
3245 NODELETE 2 means delete only windows that have become too small to be
3246 displayed correctly. */
3248 void
3249 set_window_width (Lisp_Object window, int width, int nodelete)
3251 size_window (window, width, 1, nodelete, 0, 0);
3254 /* Change window heights in windows rooted in WINDOW by N lines. */
3256 void
3257 change_window_heights (Lisp_Object window, int n)
3259 struct window *w = XWINDOW (window);
3261 XSETFASTINT (w->top_line, XFASTINT (w->top_line) + n);
3262 XSETFASTINT (w->total_lines, XFASTINT (w->total_lines) - n);
3264 if (INTEGERP (w->orig_top_line))
3265 XSETFASTINT (w->orig_top_line, XFASTINT (w->orig_top_line) + n);
3266 if (INTEGERP (w->orig_total_lines))
3267 XSETFASTINT (w->orig_total_lines, XFASTINT (w->orig_total_lines) - n);
3269 /* Handle just the top child in a vertical split. */
3270 if (!NILP (w->vchild))
3271 change_window_heights (w->vchild, n);
3273 /* Adjust all children in a horizontal split. */
3274 for (window = w->hchild; !NILP (window); window = w->next)
3276 w = XWINDOW (window);
3277 change_window_heights (window, n);
3282 int window_select_count;
3284 EXFUN (Fset_window_fringes, 4);
3285 EXFUN (Fset_window_scroll_bars, 4);
3287 static void
3288 run_funs (Lisp_Object funs)
3290 for (; CONSP (funs); funs = XCDR (funs))
3291 if (!EQ (XCAR (funs), Qt))
3292 call0 (XCAR (funs));
3295 static Lisp_Object select_window_norecord (Lisp_Object window);
3296 static Lisp_Object select_frame_norecord (Lisp_Object frame);
3298 void
3299 run_window_configuration_change_hook (struct frame *f)
3301 int count = SPECPDL_INDEX ();
3302 Lisp_Object frame, global_wcch
3303 = Fdefault_value (Qwindow_configuration_change_hook);
3304 XSETFRAME (frame, f);
3306 if (NILP (Vrun_hooks))
3307 return;
3309 if (SELECTED_FRAME () != f)
3311 record_unwind_protect (select_frame_norecord, Fselected_frame ());
3312 Fselect_frame (frame, Qt);
3315 /* Use the right buffer. Matters when running the local hooks. */
3316 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
3318 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3319 Fset_buffer (Fwindow_buffer (Qnil));
3322 /* Look for buffer-local values. */
3324 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
3325 for (; CONSP (windows); windows = XCDR (windows))
3327 Lisp_Object window = XCAR (windows);
3328 Lisp_Object buffer = Fwindow_buffer (window);
3329 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
3330 buffer)))
3332 int count = SPECPDL_INDEX ();
3333 record_unwind_protect (select_window_norecord, Fselected_window ());
3334 select_window_norecord (window);
3335 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
3336 buffer));
3337 unbind_to (count, Qnil);
3342 run_funs (global_wcch);
3343 unbind_to (count, Qnil);
3346 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
3347 means it's allowed to run hooks. See make_frame for a case where
3348 it's not allowed. KEEP_MARGINS_P non-zero means that the current
3349 margins, fringes, and scroll-bar settings of the window are not
3350 reset from the buffer's local settings. */
3352 void
3353 set_window_buffer (Lisp_Object window, Lisp_Object buffer, int run_hooks_p, int keep_margins_p)
3355 struct window *w = XWINDOW (window);
3356 struct buffer *b = XBUFFER (buffer);
3357 int count = SPECPDL_INDEX ();
3358 int samebuf = EQ (buffer, w->buffer);
3360 w->buffer = buffer;
3362 if (EQ (window, selected_window))
3363 BVAR (b, last_selected_window) = window;
3365 /* Let redisplay errors through. */
3366 b->display_error_modiff = 0;
3368 /* Update time stamps of buffer display. */
3369 if (INTEGERP (BVAR (b, display_count)))
3370 XSETINT (BVAR (b, display_count), XINT (BVAR (b, display_count)) + 1);
3371 BVAR (b, display_time) = Fcurrent_time ();
3373 XSETFASTINT (w->window_end_pos, 0);
3374 XSETFASTINT (w->window_end_vpos, 0);
3375 memset (&w->last_cursor, 0, sizeof w->last_cursor);
3376 w->window_end_valid = Qnil;
3377 if (!(keep_margins_p && samebuf))
3378 { /* If we're not actually changing the buffer, don't reset hscroll and
3379 vscroll. This case happens for example when called from
3380 change_frame_size_1, where we use a dummy call to
3381 Fset_window_buffer on the frame's selected window (and no other)
3382 just in order to run window-configuration-change-hook.
3383 Resetting hscroll and vscroll here is problematic for things like
3384 image-mode and doc-view-mode since it resets the image's position
3385 whenever we resize the frame. */
3386 w->hscroll = w->min_hscroll = make_number (0);
3387 w->vscroll = 0;
3388 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3389 set_marker_restricted (w->start,
3390 make_number (b->last_window_start),
3391 buffer);
3392 w->start_at_line_beg = Qnil;
3393 w->force_start = Qnil;
3394 XSETFASTINT (w->last_modified, 0);
3395 XSETFASTINT (w->last_overlay_modified, 0);
3397 /* Maybe we could move this into the `if' but it's not obviously safe and
3398 I doubt it's worth the trouble. */
3399 windows_or_buffers_changed++;
3401 /* We must select BUFFER for running the window-scroll-functions. */
3402 /* We can't check ! NILP (Vwindow_scroll_functions) here
3403 because that might itself be a local variable. */
3404 if (window_initialized)
3406 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3407 Fset_buffer (buffer);
3410 XMARKER (w->pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3412 if (!keep_margins_p)
3414 /* Set left and right marginal area width etc. from buffer. */
3416 /* This may call adjust_window_margins three times, so
3417 temporarily disable window margins. */
3418 Lisp_Object save_left = w->left_margin_cols;
3419 Lisp_Object save_right = w->right_margin_cols;
3421 w->left_margin_cols = w->right_margin_cols = Qnil;
3423 Fset_window_fringes (window,
3424 BVAR (b, left_fringe_width), BVAR (b, right_fringe_width),
3425 BVAR (b, fringes_outside_margins));
3427 Fset_window_scroll_bars (window,
3428 BVAR (b, scroll_bar_width),
3429 BVAR (b, vertical_scroll_bar_type), Qnil);
3431 w->left_margin_cols = save_left;
3432 w->right_margin_cols = save_right;
3434 Fset_window_margins (window,
3435 BVAR (b, left_margin_cols), BVAR (b, right_margin_cols));
3438 if (run_hooks_p)
3440 if (! NILP (Vwindow_scroll_functions))
3441 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3442 Fmarker_position (w->start));
3443 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3446 unbind_to (count, Qnil);
3450 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3451 doc: /* Make WINDOW display BUFFER-OR-NAME as its contents.
3452 WINDOW defaults to the selected window. BUFFER-OR-NAME must be a buffer
3453 or the name of an existing buffer. Optional third argument KEEP-MARGINS
3454 non-nil means that WINDOW's current display margins, fringe widths, and
3455 scroll bar settings are preserved; the default is to reset these from
3456 the local settings for BUFFER-OR-NAME or the frame defaults. Return nil.
3458 This function throws an error when WINDOW is strongly dedicated to its
3459 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3460 already display BUFFER-OR-NAME.
3462 This function runs `window-scroll-functions' before running
3463 `window-configuration-change-hook'. */)
3464 (register Lisp_Object window, Lisp_Object buffer_or_name, Lisp_Object keep_margins)
3466 register Lisp_Object tem, buffer;
3467 register struct window *w = decode_window (window);
3469 XSETWINDOW (window, w);
3470 buffer = Fget_buffer (buffer_or_name);
3471 CHECK_BUFFER (buffer);
3472 if (NILP (BVAR (XBUFFER (buffer), name)))
3473 error ("Attempt to display deleted buffer");
3475 tem = w->buffer;
3476 if (NILP (tem))
3477 error ("Window is deleted");
3478 else if (!EQ (tem, Qt))
3479 /* w->buffer is t when the window is first being set up. */
3481 if (EQ (tem, buffer))
3482 return Qnil;
3483 else if (EQ (w->dedicated, Qt))
3484 error ("Window is dedicated to `%s'", SDATA (BVAR (XBUFFER (tem), name)));
3485 else
3486 w->dedicated = Qnil;
3488 unshow_buffer (w);
3491 set_window_buffer (window, buffer, 1, !NILP (keep_margins));
3492 return Qnil;
3495 /* If select_window is called with inhibit_point_swap non-zero it will
3496 not store point of the old selected window's buffer back into that
3497 window's pointm slot. This is needed by Fset_window_configuration to
3498 avoid that the display routine is called with selected_window set to
3499 Qnil causing a subsequent crash. */
3501 static Lisp_Object
3502 select_window (Lisp_Object window, Lisp_Object norecord, int inhibit_point_swap)
3504 register struct window *w;
3505 register struct window *ow;
3506 struct frame *sf;
3508 CHECK_LIVE_WINDOW (window);
3510 w = XWINDOW (window);
3511 w->frozen_window_start_p = 0;
3513 if (NILP (norecord))
3515 ++window_select_count;
3516 XSETFASTINT (w->use_time, window_select_count);
3517 record_buffer (w->buffer);
3520 if (EQ (window, selected_window) && !inhibit_point_swap)
3521 return window;
3523 sf = SELECTED_FRAME ();
3524 if (XFRAME (WINDOW_FRAME (w)) != sf)
3526 XFRAME (WINDOW_FRAME (w))->selected_window = window;
3527 /* Use this rather than Fhandle_switch_frame
3528 so that FRAME_FOCUS_FRAME is moved appropriately as we
3529 move around in the state where a minibuffer in a separate
3530 frame is active. */
3531 Fselect_frame (WINDOW_FRAME (w), norecord);
3532 /* Fselect_frame called us back so we've done all the work already. */
3533 eassert (EQ (window, selected_window));
3534 return window;
3536 else
3537 sf->selected_window = window;
3539 /* Store the current buffer's actual point into the
3540 old selected window. It belongs to that window,
3541 and when the window is not selected, must be in the window. */
3542 if (!inhibit_point_swap)
3544 ow = XWINDOW (selected_window);
3545 if (! NILP (ow->buffer))
3546 set_marker_both (ow->pointm, ow->buffer,
3547 BUF_PT (XBUFFER (ow->buffer)),
3548 BUF_PT_BYTE (XBUFFER (ow->buffer)));
3551 selected_window = window;
3553 Fset_buffer (w->buffer);
3555 BVAR (XBUFFER (w->buffer), last_selected_window) = window;
3557 /* Go to the point recorded in the window.
3558 This is important when the buffer is in more
3559 than one window. It also matters when
3560 redisplay_window has altered point after scrolling,
3561 because it makes the change only in the window. */
3563 register EMACS_INT new_point = marker_position (w->pointm);
3564 if (new_point < BEGV)
3565 SET_PT (BEGV);
3566 else if (new_point > ZV)
3567 SET_PT (ZV);
3568 else
3569 SET_PT (new_point);
3572 windows_or_buffers_changed++;
3573 return window;
3577 /* Note that selected_window can be nil when this is called from
3578 Fset_window_configuration. */
3580 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
3581 doc: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
3582 If WINDOW is not already selected, make WINDOW's buffer current
3583 and make WINDOW the frame's selected window. Return WINDOW.
3584 Optional second arg NORECORD non-nil means do not put this buffer
3585 at the front of the list of recently selected ones and do not
3586 make this window the most recently selected one.
3588 Note that the main editor command loop selects the buffer of the
3589 selected window before each command. */)
3590 (register Lisp_Object window, Lisp_Object norecord)
3592 return select_window (window, norecord, 0);
3595 static Lisp_Object
3596 select_window_norecord (Lisp_Object window)
3598 return WINDOW_LIVE_P (window)
3599 ? Fselect_window (window, Qt) : selected_window;
3602 static Lisp_Object
3603 select_frame_norecord (Lisp_Object frame)
3605 return FRAME_LIVE_P (XFRAME (frame))
3606 ? Fselect_frame (frame, Qt) : selected_frame;
3609 Lisp_Object
3610 display_buffer (Lisp_Object buffer, Lisp_Object not_this_window_p, Lisp_Object override_frame)
3612 return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame);
3615 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3616 0, 1, 0,
3617 doc: /* Force all windows to be updated on next redisplay.
3618 If optional arg OBJECT is a window, force redisplay of that window only.
3619 If OBJECT is a buffer or buffer name, force redisplay of all windows
3620 displaying that buffer. */)
3621 (Lisp_Object object)
3623 if (NILP (object))
3625 windows_or_buffers_changed++;
3626 update_mode_lines++;
3627 return Qt;
3630 if (WINDOWP (object))
3632 struct window *w = XWINDOW (object);
3633 mark_window_display_accurate (object, 0);
3634 w->update_mode_line = Qt;
3635 if (BUFFERP (w->buffer))
3636 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
3637 ++update_mode_lines;
3638 return Qt;
3641 if (STRINGP (object))
3642 object = Fget_buffer (object);
3643 if (BUFFERP (object) && !NILP (BVAR (XBUFFER (object), name)))
3645 /* Walk all windows looking for buffer, and force update
3646 of each of those windows. */
3648 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, 0, Qvisible);
3649 return NILP (object) ? Qnil : Qt;
3652 /* If nothing suitable was found, just return.
3653 We could signal an error, but this feature will typically be used
3654 asynchronously in timers or process sentinels, so we don't. */
3655 return Qnil;
3659 void
3660 temp_output_buffer_show (register Lisp_Object buf)
3662 register struct buffer *old = current_buffer;
3663 register Lisp_Object window;
3664 register struct window *w;
3666 BVAR (XBUFFER (buf), directory) = BVAR (current_buffer, directory);
3668 Fset_buffer (buf);
3669 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3670 BEGV = BEG;
3671 ZV = Z;
3672 SET_PT (BEG);
3673 #if 0 /* rms: there should be no reason for this. */
3674 XBUFFER (buf)->prevent_redisplay_optimizations_p = 1;
3675 #endif
3676 set_buffer_internal (old);
3678 if (!NILP (Vtemp_buffer_show_function))
3679 call1 (Vtemp_buffer_show_function, buf);
3680 else
3682 window = display_buffer (buf, Qnil, Qnil);
3684 if (!EQ (XWINDOW (window)->frame, selected_frame))
3685 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3686 Vminibuf_scroll_window = window;
3687 w = XWINDOW (window);
3688 XSETFASTINT (w->hscroll, 0);
3689 XSETFASTINT (w->min_hscroll, 0);
3690 set_marker_restricted_both (w->start, buf, BEG, BEG);
3691 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
3693 /* Run temp-buffer-show-hook, with the chosen window selected
3694 and its buffer current. */
3696 if (!NILP (Vrun_hooks)
3697 && !NILP (Fboundp (Qtemp_buffer_show_hook))
3698 && !NILP (Fsymbol_value (Qtemp_buffer_show_hook)))
3700 int count = SPECPDL_INDEX ();
3701 Lisp_Object prev_window, prev_buffer;
3702 prev_window = selected_window;
3703 XSETBUFFER (prev_buffer, old);
3705 /* Select the window that was chosen, for running the hook.
3706 Note: Both Fselect_window and select_window_norecord may
3707 set-buffer to the buffer displayed in the window,
3708 so we need to save the current buffer. --stef */
3709 record_unwind_protect (Fset_buffer, prev_buffer);
3710 record_unwind_protect (select_window_norecord, prev_window);
3711 Fselect_window (window, Qt);
3712 Fset_buffer (w->buffer);
3713 call1 (Vrun_hooks, Qtemp_buffer_show_hook);
3714 unbind_to (count, Qnil);
3719 static void
3720 make_dummy_parent (Lisp_Object window)
3722 Lisp_Object new;
3723 register struct window *o, *p;
3724 int i;
3726 o = XWINDOW (window);
3727 p = allocate_window ();
3728 for (i = 0; i < VECSIZE (struct window); ++i)
3729 ((struct Lisp_Vector *) p)->contents[i]
3730 = ((struct Lisp_Vector *)o)->contents[i];
3731 XSETWINDOW (new, p);
3733 ++sequence_number;
3734 XSETFASTINT (p->sequence_number, sequence_number);
3736 /* Put new into window structure in place of window */
3737 replace_window (window, new);
3739 o->next = Qnil;
3740 o->prev = Qnil;
3741 o->vchild = Qnil;
3742 o->hchild = Qnil;
3743 o->parent = new;
3745 p->start = Qnil;
3746 p->pointm = Qnil;
3747 p->buffer = Qnil;
3750 DEFUN ("split-window", Fsplit_window, Ssplit_window, 0, 3, "",
3751 doc: /* Split WINDOW, putting SIZE lines in the first of the pair.
3752 WINDOW defaults to selected one and SIZE to half its size.
3753 If optional third arg HORIZONTAL is non-nil, split side by side and put
3754 SIZE columns in the first of the pair. In that case, SIZE includes that
3755 window's scroll bar, or the divider column to its right.
3756 Interactively, all arguments are nil.
3757 Returns the newly created window (which is the lower or rightmost one).
3758 The upper or leftmost window is the original one, and remains selected
3759 if it was selected before.
3761 See Info node `(elisp)Splitting Windows' for more details and examples. */)
3762 (Lisp_Object window, Lisp_Object size, Lisp_Object horizontal)
3764 register Lisp_Object new;
3765 register struct window *o, *p;
3766 FRAME_PTR fo;
3767 register int size_int;
3769 if (NILP (window))
3770 window = selected_window;
3771 else
3772 CHECK_LIVE_WINDOW (window);
3774 o = XWINDOW (window);
3775 fo = XFRAME (WINDOW_FRAME (o));
3777 if (NILP (size))
3779 if (!NILP (horizontal))
3780 /* Calculate the size of the left-hand window, by dividing
3781 the usable space in columns by two.
3782 We round up, since the left-hand window may include
3783 a dividing line, while the right-hand may not. */
3784 size_int = (XFASTINT (o->total_cols) + 1) >> 1;
3785 else
3786 size_int = XFASTINT (o->total_lines) >> 1;
3788 else
3790 CHECK_NUMBER (size);
3791 size_int = XINT (size);
3794 if (MINI_WINDOW_P (o))
3795 error ("Attempt to split minibuffer window");
3796 else if (window_fixed_size_p (o, !NILP (horizontal), 0))
3797 error ("Attempt to split fixed-size window");
3799 if (NILP (horizontal))
3801 int window_safe_height = window_min_size_2 (o, 0, 0);
3803 if (size_int < window_safe_height)
3804 error ("Window height %d too small (after splitting)", size_int);
3805 if (size_int + window_safe_height > XFASTINT (o->total_lines))
3806 error ("Window height %d too small (after splitting)",
3807 XFASTINT (o->total_lines) - size_int);
3808 if (NILP (o->parent)
3809 || NILP (XWINDOW (o->parent)->vchild))
3811 make_dummy_parent (window);
3812 new = o->parent;
3813 XWINDOW (new)->vchild = window;
3816 else
3818 int window_safe_width = window_min_size_2 (o, 1, 0);
3820 if (size_int < window_safe_width)
3821 error ("Window width %d too small (after splitting)", size_int);
3822 if (size_int + window_safe_width > XFASTINT (o->total_cols))
3823 error ("Window width %d too small (after splitting)",
3824 XFASTINT (o->total_cols) - size_int);
3825 if (NILP (o->parent)
3826 || NILP (XWINDOW (o->parent)->hchild))
3828 make_dummy_parent (window);
3829 new = o->parent;
3830 XWINDOW (new)->hchild = window;
3834 /* Now we know that window's parent is a vertical combination
3835 if we are dividing vertically, or a horizontal combination
3836 if we are making side-by-side windows */
3838 windows_or_buffers_changed++;
3839 FRAME_WINDOW_SIZES_CHANGED (fo) = 1;
3840 new = make_window ();
3841 p = XWINDOW (new);
3843 p->frame = o->frame;
3844 p->next = o->next;
3845 if (!NILP (p->next))
3846 XWINDOW (p->next)->prev = new;
3847 p->prev = window;
3848 o->next = new;
3849 p->parent = o->parent;
3850 p->buffer = Qt;
3851 p->window_end_valid = Qnil;
3852 memset (&p->last_cursor, 0, sizeof p->last_cursor);
3854 /* Duplicate special geometry settings. */
3856 p->left_margin_cols = o->left_margin_cols;
3857 p->right_margin_cols = o->right_margin_cols;
3858 p->left_fringe_width = o->left_fringe_width;
3859 p->right_fringe_width = o->right_fringe_width;
3860 p->fringes_outside_margins = o->fringes_outside_margins;
3861 p->scroll_bar_width = o->scroll_bar_width;
3862 p->vertical_scroll_bar_type = o->vertical_scroll_bar_type;
3864 /* Apportion the available frame space among the two new windows */
3866 if (!NILP (horizontal))
3868 p->total_lines = o->total_lines;
3869 p->top_line = o->top_line;
3870 XSETFASTINT (p->total_cols, XFASTINT (o->total_cols) - size_int);
3871 XSETFASTINT (o->total_cols, size_int);
3872 XSETFASTINT (p->left_col, XFASTINT (o->left_col) + size_int);
3873 adjust_window_margins (p);
3874 adjust_window_margins (o);
3876 else
3878 p->left_col = o->left_col;
3879 p->total_cols = o->total_cols;
3880 XSETFASTINT (p->total_lines, XFASTINT (o->total_lines) - size_int);
3881 XSETFASTINT (o->total_lines, size_int);
3882 XSETFASTINT (p->top_line, XFASTINT (o->top_line) + size_int);
3885 /* Adjust glyph matrices. */
3886 adjust_glyphs (fo);
3888 Fset_window_buffer (new, o->buffer, Qt);
3889 return new;
3892 DEFUN ("enlarge-window", Fenlarge_window, Senlarge_window, 1, 2, "p",
3893 doc: /* Make selected window SIZE lines taller.
3894 Interactively, if no argument is given, make the selected window one
3895 line taller. If optional argument HORIZONTAL is non-nil, make selected
3896 window wider by SIZE columns. If SIZE is negative, shrink the window by
3897 -SIZE lines or columns. Return nil.
3899 This function can delete windows if they get too small. The size of
3900 fixed size windows is not altered by this function. */)
3901 (Lisp_Object size, Lisp_Object horizontal)
3903 CHECK_NUMBER (size);
3904 enlarge_window (selected_window, XINT (size), !NILP (horizontal));
3906 run_window_configuration_change_hook (SELECTED_FRAME ());
3908 return Qnil;
3911 DEFUN ("shrink-window", Fshrink_window, Sshrink_window, 1, 2, "p",
3912 doc: /* Make selected window SIZE lines smaller.
3913 Interactively, if no argument is given, make the selected window one
3914 line smaller. If optional argument HORIZONTAL is non-nil, make the
3915 window narrower by SIZE columns. If SIZE is negative, enlarge selected
3916 window by -SIZE lines or columns. Return nil.
3918 This function can delete windows if they get too small. The size of
3919 fixed size windows is not altered by this function. */)
3920 (Lisp_Object size, Lisp_Object horizontal)
3922 CHECK_NUMBER (size);
3923 enlarge_window (selected_window, -XINT (size), !NILP (horizontal));
3925 run_window_configuration_change_hook (SELECTED_FRAME ());
3927 return Qnil;
3930 static int
3931 window_height (Lisp_Object window)
3933 register struct window *p = XWINDOW (window);
3934 return WINDOW_TOTAL_LINES (p);
3937 static int
3938 window_width (Lisp_Object window)
3940 register struct window *p = XWINDOW (window);
3941 return WINDOW_TOTAL_COLS (p);
3945 #define CURBEG(w) \
3946 *(horiz_flag ? &(XWINDOW (w)->left_col) : &(XWINDOW (w)->top_line))
3948 #define CURSIZE(w) \
3949 *(horiz_flag ? &(XWINDOW (w)->total_cols) : &(XWINDOW (w)->total_lines))
3952 /* Enlarge WINDOW by DELTA. HORIZ_FLAG nonzero means enlarge it
3953 horizontally; zero means do it vertically.
3955 Siblings of the selected window are resized to fulfill the size
3956 request. If they become too small in the process, they may be
3957 deleted. */
3959 static void
3960 enlarge_window (Lisp_Object window, int delta, int horiz_flag)
3962 Lisp_Object parent, next, prev;
3963 struct window *p;
3964 Lisp_Object *sizep;
3965 int maximum;
3966 int (*sizefun) (Lisp_Object)
3967 = horiz_flag ? window_width : window_height;
3968 void (*setsizefun) (Lisp_Object, int, int)
3969 = (horiz_flag ? set_window_width : set_window_height);
3971 /* Give up if this window cannot be resized. */
3972 if (window_fixed_size_p (XWINDOW (window), horiz_flag, 1))
3973 error ("Window is not resizable");
3975 /* Find the parent of the selected window. */
3976 while (1)
3978 p = XWINDOW (window);
3979 parent = p->parent;
3981 if (NILP (parent))
3983 if (horiz_flag)
3984 error ("No other window to side of this one");
3985 break;
3988 if (horiz_flag
3989 ? !NILP (XWINDOW (parent)->hchild)
3990 : !NILP (XWINDOW (parent)->vchild))
3991 break;
3993 window = parent;
3996 sizep = &CURSIZE (window);
3999 register int maxdelta;
4001 /* Compute the maximum size increment this window can have. */
4003 maxdelta = (!NILP (parent) ? (*sizefun) (parent) - XINT (*sizep)
4004 /* This is a main window followed by a minibuffer. */
4005 : !NILP (p->next) ? ((*sizefun) (p->next)
4006 - window_min_size (XWINDOW (p->next),
4007 horiz_flag, 0, 0, 0))
4008 /* This is a minibuffer following a main window. */
4009 : !NILP (p->prev) ? ((*sizefun) (p->prev)
4010 - window_min_size (XWINDOW (p->prev),
4011 horiz_flag, 0, 0, 0))
4012 /* This is a frame with only one window, a minibuffer-only
4013 or a minibufferless frame. */
4014 : (delta = 0));
4016 if (delta > maxdelta)
4017 /* This case traps trying to make the minibuffer
4018 the full frame, or make the only window aside from the
4019 minibuffer the full frame. */
4020 delta = maxdelta;
4023 if (XINT (*sizep) + delta < window_min_size (XWINDOW (window),
4024 horiz_flag, 0, 0, 0))
4026 delete_window (window);
4027 return;
4030 if (delta == 0)
4031 return;
4033 /* Find the total we can get from other siblings without deleting them. */
4034 maximum = 0;
4035 for (next = p->next; WINDOWP (next); next = XWINDOW (next)->next)
4036 maximum += (*sizefun) (next) - window_min_size (XWINDOW (next),
4037 horiz_flag, 0, 0, 0);
4038 for (prev = p->prev; WINDOWP (prev); prev = XWINDOW (prev)->prev)
4039 maximum += (*sizefun) (prev) - window_min_size (XWINDOW (prev),
4040 horiz_flag, 0, 0, 0);
4042 /* If we can get it all from them without deleting them, do so. */
4043 if (delta <= maximum)
4045 Lisp_Object first_unaffected;
4046 Lisp_Object first_affected;
4047 int fixed_p;
4049 next = p->next;
4050 prev = p->prev;
4051 first_affected = window;
4052 /* Look at one sibling at a time,
4053 moving away from this window in both directions alternately,
4054 and take as much as we can get without deleting that sibling. */
4055 while (delta != 0
4056 && (!NILP (next) || !NILP (prev)))
4058 if (! NILP (next))
4060 int this_one = ((*sizefun) (next)
4061 - window_min_size (XWINDOW (next), horiz_flag,
4062 0, 0, &fixed_p));
4063 if (!fixed_p)
4065 if (this_one > delta)
4066 this_one = delta;
4068 (*setsizefun) (next, (*sizefun) (next) - this_one, 0);
4069 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
4071 delta -= this_one;
4074 next = XWINDOW (next)->next;
4077 if (delta == 0)
4078 break;
4080 if (! NILP (prev))
4082 int this_one = ((*sizefun) (prev)
4083 - window_min_size (XWINDOW (prev), horiz_flag,
4084 0, 0, &fixed_p));
4085 if (!fixed_p)
4087 if (this_one > delta)
4088 this_one = delta;
4090 first_affected = prev;
4092 (*setsizefun) (prev, (*sizefun) (prev) - this_one, 0);
4093 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
4095 delta -= this_one;
4098 prev = XWINDOW (prev)->prev;
4102 xassert (delta == 0);
4104 /* Now recalculate the edge positions of all the windows affected,
4105 based on the new sizes. */
4106 first_unaffected = next;
4107 prev = first_affected;
4108 for (next = XWINDOW (prev)->next; ! EQ (next, first_unaffected);
4109 prev = next, next = XWINDOW (next)->next)
4111 XSETINT (CURBEG (next), XINT (CURBEG (prev)) + (*sizefun) (prev));
4112 /* This does not change size of NEXT,
4113 but it propagates the new top edge to its children */
4114 (*setsizefun) (next, (*sizefun) (next), 0);
4117 else
4119 register int delta1;
4120 register int opht = (*sizefun) (parent);
4122 if (opht <= XINT (*sizep) + delta)
4124 /* If trying to grow this window to or beyond size of the parent,
4125 just delete all the sibling windows. */
4126 Lisp_Object start, tem, next;
4128 start = XWINDOW (parent)->vchild;
4129 if (NILP (start))
4130 start = XWINDOW (parent)->hchild;
4132 /* Delete any siblings that come after WINDOW. */
4133 tem = XWINDOW (window)->next;
4134 while (! NILP (tem))
4136 next = XWINDOW (tem)->next;
4137 delete_window (tem);
4138 tem = next;
4141 /* Delete any siblings that come after WINDOW.
4142 Note that if START is not WINDOW, then WINDOW still
4143 has siblings, so WINDOW has not yet replaced its parent. */
4144 tem = start;
4145 while (! EQ (tem, window))
4147 next = XWINDOW (tem)->next;
4148 delete_window (tem);
4149 tem = next;
4152 else
4154 /* Otherwise, make delta1 just right so that if we add
4155 delta1 lines to this window and to the parent, and then
4156 shrink the parent back to its original size, the new
4157 proportional size of this window will increase by delta.
4159 The function size_window will compute the new height h'
4160 of the window from delta1 as:
4162 e = delta1/n
4163 x = delta1 - delta1/n * n for the 1st resizable child
4164 h' = h + e + x
4166 where n is the number of children that can be resized.
4167 We can ignore x by choosing a delta1 that is a multiple of
4168 n. We want the height of this window to come out as
4170 h' = h + delta
4172 So, delta1 must be
4174 h + e = h + delta
4175 delta1/n = delta
4176 delta1 = n * delta.
4178 The number of children n equals the number of resizable
4179 children of this window + 1 because we know window itself
4180 is resizable (otherwise we would have signaled an error).
4182 This reasoning is not correct when other windows become too
4183 small and shrink_windows refuses to delete them. Below we
4184 use resize_proportionally to work around this problem. */
4186 struct window *w = XWINDOW (window);
4187 Lisp_Object s;
4188 int n = 1;
4190 for (s = w->next; WINDOWP (s); s = XWINDOW (s)->next)
4191 if (!window_fixed_size_p (XWINDOW (s), horiz_flag, 0))
4192 ++n;
4193 for (s = w->prev; WINDOWP (s); s = XWINDOW (s)->prev)
4194 if (!window_fixed_size_p (XWINDOW (s), horiz_flag, 0))
4195 ++n;
4197 delta1 = n * delta;
4199 /* Add delta1 lines or columns to this window, and to the parent,
4200 keeping things consistent while not affecting siblings. */
4201 XSETINT (CURSIZE (parent), opht + delta1);
4202 (*setsizefun) (window, XINT (*sizep) + delta1, 0);
4204 /* Squeeze out delta1 lines or columns from our parent,
4205 shrinking this window and siblings proportionately. This
4206 brings parent back to correct size. Delta1 was calculated
4207 so this makes this window the desired size, taking it all
4208 out of the siblings.
4210 Temporarily set resize_proportionally to Qt to assure that,
4211 if necessary, shrink_windows deletes smaller windows rather
4212 than shrink this window. */
4213 w->resize_proportionally = Qt;
4214 (*setsizefun) (parent, opht, 0);
4215 w->resize_proportionally = Qnil;
4219 XSETFASTINT (p->last_modified, 0);
4220 XSETFASTINT (p->last_overlay_modified, 0);
4222 /* Adjust glyph matrices. */
4223 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4227 /* Adjust the size of WINDOW by DELTA, moving only its trailing edge.
4228 HORIZ_FLAG nonzero means adjust the width, moving the right edge.
4229 zero means adjust the height, moving the bottom edge.
4231 Following siblings of the selected window are resized to fulfill
4232 the size request. If they become too small in the process, they
4233 are not deleted; instead, we signal an error. */
4235 static void
4236 adjust_window_trailing_edge (Lisp_Object window, int delta, int horiz_flag)
4238 Lisp_Object parent, child;
4239 struct window *p;
4240 Lisp_Object old_config = Fcurrent_window_configuration (Qnil);
4241 int delcount = window_deletion_count;
4243 CHECK_WINDOW (window);
4245 /* Give up if this window cannot be resized. */
4246 if (window_fixed_size_p (XWINDOW (window), horiz_flag, 1))
4247 error ("Window is not resizable");
4249 while (1)
4251 Lisp_Object first_parallel = Qnil;
4253 if (NILP (window))
4255 /* This happens if WINDOW on the previous iteration was
4256 at top level of the window tree. */
4257 Fset_window_configuration (old_config);
4258 error ("Specified window edge is fixed");
4261 p = XWINDOW (window);
4262 parent = p->parent;
4264 /* See if this level has windows in parallel in the specified
4265 direction. If so, set FIRST_PARALLEL to the first one. */
4266 if (horiz_flag)
4268 if (! NILP (parent) && !NILP (XWINDOW (parent)->vchild))
4269 first_parallel = XWINDOW (parent)->vchild;
4270 else if (NILP (parent) && !NILP (p->next))
4272 /* Handle the vertical chain of main window and minibuffer
4273 which has no parent. */
4274 first_parallel = window;
4275 while (! NILP (XWINDOW (first_parallel)->prev))
4276 first_parallel = XWINDOW (first_parallel)->prev;
4279 else
4281 if (! NILP (parent) && !NILP (XWINDOW (parent)->hchild))
4282 first_parallel = XWINDOW (parent)->hchild;
4285 /* If this level's succession is in the desired dimension,
4286 and this window is the last one, and there is no higher level,
4287 its trailing edge is fixed. */
4288 if (NILP (XWINDOW (window)->next) && NILP (first_parallel)
4289 && NILP (parent))
4291 Fset_window_configuration (old_config);
4292 error ("Specified window edge is fixed");
4295 /* Don't make this window too small. */
4296 if (XINT (CURSIZE (window)) + delta
4297 < window_min_size_2 (XWINDOW (window), horiz_flag, 0))
4299 Fset_window_configuration (old_config);
4300 error ("Cannot adjust window size as specified");
4303 /* Clear out some redisplay caches. */
4304 XSETFASTINT (p->last_modified, 0);
4305 XSETFASTINT (p->last_overlay_modified, 0);
4307 /* Adjust this window's edge. */
4308 XSETINT (CURSIZE (window),
4309 XINT (CURSIZE (window)) + delta);
4311 /* If this window has following siblings in the desired dimension,
4312 make them smaller, and exit the loop.
4314 (If we reach the top of the tree and can never do this,
4315 we will fail and report an error, above.) */
4316 if (NILP (first_parallel))
4318 if (!NILP (p->next))
4320 /* This may happen for the minibuffer. In that case
4321 the window_deletion_count check below does not work. */
4322 if (XINT (CURSIZE (p->next)) - delta <= 0)
4324 Fset_window_configuration (old_config);
4325 error ("Cannot adjust window size as specified");
4328 XSETINT (CURBEG (p->next),
4329 XINT (CURBEG (p->next)) + delta);
4330 size_window (p->next, XINT (CURSIZE (p->next)) - delta,
4331 horiz_flag, 0, 1, 0);
4332 break;
4335 else
4336 /* Here we have a chain of parallel siblings, in the other dimension.
4337 Change the size of the other siblings. */
4338 for (child = first_parallel;
4339 ! NILP (child);
4340 child = XWINDOW (child)->next)
4341 if (! EQ (child, window))
4342 size_window (child, XINT (CURSIZE (child)) + delta,
4343 horiz_flag, 0, 0, 1);
4345 window = parent;
4348 /* If we made a window so small it got deleted,
4349 we failed. Report failure. */
4350 if (delcount != window_deletion_count)
4352 Fset_window_configuration (old_config);
4353 error ("Cannot adjust window size as specified");
4356 /* Adjust glyph matrices. */
4357 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4360 #undef CURBEG
4361 #undef CURSIZE
4363 DEFUN ("adjust-window-trailing-edge", Fadjust_window_trailing_edge,
4364 Sadjust_window_trailing_edge, 3, 3, 0,
4365 doc: /* Adjust the bottom or right edge of WINDOW by DELTA.
4366 If HORIZONTAL is non-nil, that means adjust the width, moving the right edge.
4367 Otherwise, adjust the height, moving the bottom edge.
4369 Following siblings of the selected window are resized to fulfill
4370 the size request. If they become too small in the process, they
4371 are not deleted; instead, we signal an error. */)
4372 (Lisp_Object window, Lisp_Object delta, Lisp_Object horizontal)
4374 CHECK_NUMBER (delta);
4375 if (NILP (window))
4376 window = selected_window;
4377 adjust_window_trailing_edge (window, XINT (delta), !NILP (horizontal));
4379 run_window_configuration_change_hook
4380 (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4382 return Qnil;
4387 /***********************************************************************
4388 Resizing Mini-Windows
4389 ***********************************************************************/
4391 static void shrink_window_lowest_first (struct window *, int);
4393 enum save_restore_action
4395 CHECK_ORIG_SIZES,
4396 SAVE_ORIG_SIZES,
4397 RESTORE_ORIG_SIZES
4400 static int save_restore_orig_size (struct window *,
4401 enum save_restore_action);
4403 /* Shrink windows rooted in window W to HEIGHT. Take the space needed
4404 from lowest windows first. */
4406 static void
4407 shrink_window_lowest_first (struct window *w, int height)
4409 struct window *c;
4410 Lisp_Object child;
4411 int old_height;
4413 xassert (!MINI_WINDOW_P (w));
4415 /* Set redisplay hints. */
4416 XSETFASTINT (w->last_modified, 0);
4417 XSETFASTINT (w->last_overlay_modified, 0);
4418 windows_or_buffers_changed++;
4419 FRAME_WINDOW_SIZES_CHANGED (XFRAME (WINDOW_FRAME (w))) = 1;
4421 old_height = XFASTINT (w->total_lines);
4422 XSETFASTINT (w->total_lines, height);
4424 if (!NILP (w->hchild))
4426 for (child = w->hchild; !NILP (child); child = c->next)
4428 c = XWINDOW (child);
4429 c->top_line = w->top_line;
4430 shrink_window_lowest_first (c, height);
4433 else if (!NILP (w->vchild))
4435 Lisp_Object last_child;
4436 int delta = old_height - height;
4437 int last_top;
4439 last_child = Qnil;
4441 /* Find the last child. We are taking space from lowest windows
4442 first, so we iterate over children from the last child
4443 backwards. */
4444 for (child = w->vchild; WINDOWP (child); child = XWINDOW (child)->next)
4445 last_child = child;
4447 /* Size children down to their safe heights. */
4448 for (child = last_child; delta && !NILP (child); child = c->prev)
4450 int this_one;
4452 c = XWINDOW (child);
4453 this_one = XFASTINT (c->total_lines) - window_min_size_1 (c, 0, 1);
4455 if (this_one > delta)
4456 this_one = delta;
4458 shrink_window_lowest_first (c, XFASTINT (c->total_lines) - this_one);
4459 delta -= this_one;
4462 /* Compute new positions. */
4463 last_top = XINT (w->top_line);
4464 for (child = w->vchild; !NILP (child); child = c->next)
4466 c = XWINDOW (child);
4467 c->top_line = make_number (last_top);
4468 shrink_window_lowest_first (c, XFASTINT (c->total_lines));
4469 last_top += XFASTINT (c->total_lines);
4475 /* Save, restore, or check positions and sizes in the window tree
4476 rooted at W. ACTION says what to do.
4478 If ACTION is CHECK_ORIG_SIZES, check if orig_top_line and
4479 orig_total_lines members are valid for all windows in the window
4480 tree. Value is non-zero if they are valid.
4482 If ACTION is SAVE_ORIG_SIZES, save members top and height in
4483 orig_top_line and orig_total_lines for all windows in the tree.
4485 If ACTION is RESTORE_ORIG_SIZES, restore top and height from values
4486 stored in orig_top_line and orig_total_lines for all windows. */
4488 static int
4489 save_restore_orig_size (struct window *w, enum save_restore_action action)
4491 int success_p = 1;
4493 while (w)
4495 if (!NILP (w->hchild))
4497 if (!save_restore_orig_size (XWINDOW (w->hchild), action))
4498 success_p = 0;
4500 else if (!NILP (w->vchild))
4502 if (!save_restore_orig_size (XWINDOW (w->vchild), action))
4503 success_p = 0;
4506 switch (action)
4508 case CHECK_ORIG_SIZES:
4509 if (!INTEGERP (w->orig_top_line) || !INTEGERP (w->orig_total_lines))
4510 return 0;
4511 break;
4513 case SAVE_ORIG_SIZES:
4514 w->orig_top_line = w->top_line;
4515 w->orig_total_lines = w->total_lines;
4516 XSETFASTINT (w->last_modified, 0);
4517 XSETFASTINT (w->last_overlay_modified, 0);
4518 break;
4520 case RESTORE_ORIG_SIZES:
4521 xassert (INTEGERP (w->orig_top_line) && INTEGERP (w->orig_total_lines));
4522 w->top_line = w->orig_top_line;
4523 w->total_lines = w->orig_total_lines;
4524 w->orig_total_lines = w->orig_top_line = Qnil;
4525 XSETFASTINT (w->last_modified, 0);
4526 XSETFASTINT (w->last_overlay_modified, 0);
4527 break;
4529 default:
4530 abort ();
4533 w = NILP (w->next) ? NULL : XWINDOW (w->next);
4536 return success_p;
4540 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we can
4541 without deleting other windows. */
4543 void
4544 grow_mini_window (struct window *w, int delta)
4546 struct frame *f = XFRAME (w->frame);
4547 struct window *root;
4549 xassert (MINI_WINDOW_P (w));
4550 /* Commenting out the following assertion goes against the stated interface
4551 of the function, but it currently does not seem to do anything useful.
4552 See discussion of this issue in the thread for bug#4534.
4553 xassert (delta >= 0); */
4555 /* Compute how much we can enlarge the mini-window without deleting
4556 other windows. */
4557 root = XWINDOW (FRAME_ROOT_WINDOW (f));
4558 if (delta > 0)
4560 int min_height = window_min_size (root, 0, 0, 0, 0);
4561 if (XFASTINT (root->total_lines) - delta < min_height)
4562 /* Note that the root window may already be smaller than
4563 min_height. */
4564 delta = max (0, XFASTINT (root->total_lines) - min_height);
4567 if (delta)
4569 /* Save original window sizes and positions, if not already done. */
4570 if (!save_restore_orig_size (root, CHECK_ORIG_SIZES))
4571 save_restore_orig_size (root, SAVE_ORIG_SIZES);
4573 /* Shrink other windows. */
4574 shrink_window_lowest_first (root, XFASTINT (root->total_lines) - delta);
4576 /* Grow the mini-window. */
4577 w->top_line = make_number (XFASTINT (root->top_line) + XFASTINT (root->total_lines));
4578 w->total_lines = make_number (XFASTINT (w->total_lines) + delta);
4579 XSETFASTINT (w->last_modified, 0);
4580 XSETFASTINT (w->last_overlay_modified, 0);
4582 adjust_glyphs (f);
4587 /* Shrink mini-window W. If there is recorded info about window sizes
4588 before a call to grow_mini_window, restore recorded window sizes.
4589 Otherwise, if the mini-window is higher than 1 line, resize it to 1
4590 line. */
4592 void
4593 shrink_mini_window (struct window *w)
4595 struct frame *f = XFRAME (w->frame);
4596 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
4598 if (save_restore_orig_size (root, CHECK_ORIG_SIZES))
4600 save_restore_orig_size (root, RESTORE_ORIG_SIZES);
4601 adjust_glyphs (f);
4602 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4603 windows_or_buffers_changed = 1;
4605 else if (XFASTINT (w->total_lines) > 1)
4607 /* Distribute the additional lines of the mini-window
4608 among the other windows. */
4609 Lisp_Object window;
4610 XSETWINDOW (window, w);
4611 enlarge_window (window, 1 - XFASTINT (w->total_lines), 0);
4617 /* Mark window cursors off for all windows in the window tree rooted
4618 at W by setting their phys_cursor_on_p flag to zero. Called from
4619 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4620 the frame are cleared. */
4622 void
4623 mark_window_cursors_off (struct window *w)
4625 while (w)
4627 if (!NILP (w->hchild))
4628 mark_window_cursors_off (XWINDOW (w->hchild));
4629 else if (!NILP (w->vchild))
4630 mark_window_cursors_off (XWINDOW (w->vchild));
4631 else
4632 w->phys_cursor_on_p = 0;
4634 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4639 /* Return number of lines of text (not counting mode lines) in W. */
4642 window_internal_height (struct window *w)
4644 int ht = XFASTINT (w->total_lines);
4646 if (!MINI_WINDOW_P (w))
4648 if (!NILP (w->parent)
4649 || !NILP (w->vchild)
4650 || !NILP (w->hchild)
4651 || !NILP (w->next)
4652 || !NILP (w->prev)
4653 || WINDOW_WANTS_MODELINE_P (w))
4654 --ht;
4656 if (WINDOW_WANTS_HEADER_LINE_P (w))
4657 --ht;
4660 return ht;
4664 /* Return the number of columns in W.
4665 Don't count columns occupied by scroll bars or the vertical bar
4666 separating W from the sibling to its right. */
4669 window_box_text_cols (struct window *w)
4671 struct frame *f = XFRAME (WINDOW_FRAME (w));
4672 int width = XINT (w->total_cols);
4674 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
4675 /* Scroll bars occupy a few columns. */
4676 width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
4677 else if (!FRAME_WINDOW_P (f)
4678 && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
4679 /* The column of `|' characters separating side-by-side windows
4680 occupies one column only. */
4681 width -= 1;
4683 if (FRAME_WINDOW_P (f))
4684 /* On window-systems, fringes and display margins cannot be
4685 used for normal text. */
4686 width -= (WINDOW_FRINGE_COLS (w)
4687 + WINDOW_LEFT_MARGIN_COLS (w)
4688 + WINDOW_RIGHT_MARGIN_COLS (w));
4690 return width;
4694 /************************************************************************
4695 Window Scrolling
4696 ***********************************************************************/
4698 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4699 N screen-fulls, which is defined as the height of the window minus
4700 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4701 instead. Negative values of N mean scroll down. NOERROR non-zero
4702 means don't signal an error if we try to move over BEGV or ZV,
4703 respectively. */
4705 static void
4706 window_scroll (Lisp_Object window, int n, int whole, int noerror)
4708 immediate_quit = 1;
4710 /* If we must, use the pixel-based version which is much slower than
4711 the line-based one but can handle varying line heights. */
4712 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4713 window_scroll_pixel_based (window, n, whole, noerror);
4714 else
4715 window_scroll_line_based (window, n, whole, noerror);
4717 immediate_quit = 0;
4721 /* Implementation of window_scroll that works based on pixel line
4722 heights. See the comment of window_scroll for parameter
4723 descriptions. */
4725 static void
4726 window_scroll_pixel_based (Lisp_Object window, int n, int whole, int noerror)
4728 struct it it;
4729 struct window *w = XWINDOW (window);
4730 struct text_pos start;
4731 int this_scroll_margin;
4732 /* True if we fiddled the window vscroll field without really scrolling. */
4733 int vscrolled = 0;
4734 int x, y, rtop, rbot, rowh, vpos;
4736 SET_TEXT_POS_FROM_MARKER (start, w->start);
4738 /* If PT is not visible in WINDOW, move back one half of
4739 the screen. Allow PT to be partially visible, otherwise
4740 something like (scroll-down 1) with PT in the line before
4741 the partially visible one would recenter. */
4743 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
4745 /* Move backward half the height of the window. Performance note:
4746 vmotion used here is about 10% faster, but would give wrong
4747 results for variable height lines. */
4748 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4749 it.current_y = it.last_visible_y;
4750 move_it_vertically_backward (&it, window_box_height (w) / 2);
4752 /* The function move_iterator_vertically may move over more than
4753 the specified y-distance. If it->w is small, e.g. a
4754 mini-buffer window, we may end up in front of the window's
4755 display area. This is the case when Start displaying at the
4756 start of the line containing PT in this case. */
4757 if (it.current_y <= 0)
4759 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4760 move_it_vertically_backward (&it, 0);
4761 it.current_y = 0;
4764 start = it.current.pos;
4766 else if (auto_window_vscroll_p)
4768 if (rtop || rbot) /* partially visible */
4770 int px;
4771 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4772 if (whole)
4773 dy = max ((window_box_height (w)
4774 - next_screen_context_lines * dy),
4775 dy);
4776 dy *= n;
4778 if (n < 0)
4780 /* Only vscroll backwards if already vscrolled forwards. */
4781 if (w->vscroll < 0 && rtop > 0)
4783 px = max (0, -w->vscroll - min (rtop, -dy));
4784 Fset_window_vscroll (window, make_number (px), Qt);
4785 return;
4788 if (n > 0)
4790 /* Do vscroll if already vscrolled or only display line. */
4791 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
4793 px = max (0, -w->vscroll + min (rbot, dy));
4794 Fset_window_vscroll (window, make_number (px), Qt);
4795 return;
4798 /* Maybe modify window start instead of scrolling. */
4799 if (rbot > 0 || w->vscroll < 0)
4801 EMACS_INT spos;
4803 Fset_window_vscroll (window, make_number (0), Qt);
4804 /* If there are other text lines above the current row,
4805 move window start to current row. Else to next row. */
4806 if (rbot > 0)
4807 spos = XINT (Fline_beginning_position (Qnil));
4808 else
4809 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
4810 set_marker_restricted (w->start, make_number (spos),
4811 w->buffer);
4812 w->start_at_line_beg = Qt;
4813 w->update_mode_line = Qt;
4814 XSETFASTINT (w->last_modified, 0);
4815 XSETFASTINT (w->last_overlay_modified, 0);
4816 /* Set force_start so that redisplay_window will run the
4817 window-scroll-functions. */
4818 w->force_start = Qt;
4819 return;
4823 /* Cancel previous vscroll. */
4824 Fset_window_vscroll (window, make_number (0), Qt);
4827 /* If scroll_preserve_screen_position is non-nil, we try to set
4828 point in the same window line as it is now, so get that line. */
4829 if (!NILP (Vscroll_preserve_screen_position))
4831 /* We preserve the goal pixel coordinate across consecutive
4832 calls to scroll-up, scroll-down and other commands that
4833 have the `scroll-command' property. This avoids the
4834 possibility of point becoming "stuck" on a tall line when
4835 scrolling by one line. */
4836 if (window_scroll_pixel_based_preserve_y < 0
4837 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4838 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4840 start_display (&it, w, start);
4841 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4842 window_scroll_pixel_based_preserve_y = it.current_y;
4843 window_scroll_pixel_based_preserve_x = it.current_x;
4846 else
4847 window_scroll_pixel_based_preserve_y
4848 = window_scroll_pixel_based_preserve_x = -1;
4850 /* Move iterator it from start the specified distance forward or
4851 backward. The result is the new window start. */
4852 start_display (&it, w, start);
4853 if (whole)
4855 EMACS_INT start_pos = IT_CHARPOS (it);
4856 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4857 dy = max ((window_box_height (w)
4858 - next_screen_context_lines * dy),
4859 dy) * n;
4861 /* Note that move_it_vertically always moves the iterator to the
4862 start of a line. So, if the last line doesn't have a newline,
4863 we would end up at the start of the line ending at ZV. */
4864 if (dy <= 0)
4866 move_it_vertically_backward (&it, -dy);
4867 /* Ensure we actually do move, e.g. in case we are currently
4868 looking at an image that is taller that the window height. */
4869 while (start_pos == IT_CHARPOS (it)
4870 && start_pos > BEGV)
4871 move_it_by_lines (&it, -1, 1);
4873 else if (dy > 0)
4875 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4876 MOVE_TO_POS | MOVE_TO_Y);
4877 /* Ensure we actually do move, e.g. in case we are currently
4878 looking at an image that is taller that the window height. */
4879 while (start_pos == IT_CHARPOS (it)
4880 && start_pos < ZV)
4881 move_it_by_lines (&it, 1, 1);
4884 else
4885 move_it_by_lines (&it, n, 1);
4887 /* We failed if we find ZV is already on the screen (scrolling up,
4888 means there's nothing past the end), or if we can't start any
4889 earlier (scrolling down, means there's nothing past the top). */
4890 if ((n > 0 && IT_CHARPOS (it) == ZV)
4891 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4893 if (IT_CHARPOS (it) == ZV)
4895 if (it.current_y < it.last_visible_y
4896 && (it.current_y + it.max_ascent + it.max_descent
4897 > it.last_visible_y))
4899 /* The last line was only partially visible, make it fully
4900 visible. */
4901 w->vscroll = (it.last_visible_y
4902 - it.current_y + it.max_ascent + it.max_descent);
4903 adjust_glyphs (it.f);
4905 else if (noerror)
4906 return;
4907 else if (n < 0) /* could happen with empty buffers */
4908 xsignal0 (Qbeginning_of_buffer);
4909 else
4910 xsignal0 (Qend_of_buffer);
4912 else
4914 if (w->vscroll != 0)
4915 /* The first line was only partially visible, make it fully
4916 visible. */
4917 w->vscroll = 0;
4918 else if (noerror)
4919 return;
4920 else
4921 xsignal0 (Qbeginning_of_buffer);
4924 /* If control gets here, then we vscrolled. */
4926 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
4928 /* Don't try to change the window start below. */
4929 vscrolled = 1;
4932 if (! vscrolled)
4934 EMACS_INT pos = IT_CHARPOS (it);
4935 EMACS_INT bytepos;
4937 /* If in the middle of a multi-glyph character move forward to
4938 the next character. */
4939 if (in_display_vector_p (&it))
4941 ++pos;
4942 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
4945 /* Set the window start, and set up the window for redisplay. */
4946 set_marker_restricted (w->start, make_number (pos),
4947 w->buffer);
4948 bytepos = XMARKER (w->start)->bytepos;
4949 w->start_at_line_beg = ((pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n')
4950 ? Qt : Qnil);
4951 w->update_mode_line = Qt;
4952 XSETFASTINT (w->last_modified, 0);
4953 XSETFASTINT (w->last_overlay_modified, 0);
4954 /* Set force_start so that redisplay_window will run the
4955 window-scroll-functions. */
4956 w->force_start = Qt;
4959 /* The rest of this function uses current_y in a nonstandard way,
4960 not including the height of the header line if any. */
4961 it.current_y = it.vpos = 0;
4963 /* Move PT out of scroll margins.
4964 This code wants current_y to be zero at the window start position
4965 even if there is a header line. */
4966 this_scroll_margin = max (0, scroll_margin);
4967 this_scroll_margin = min (this_scroll_margin, XFASTINT (w->total_lines) / 4);
4968 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
4970 if (n > 0)
4972 /* We moved the window start towards ZV, so PT may be now
4973 in the scroll margin at the top. */
4974 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4975 if (IT_CHARPOS (it) == PT && it.current_y >= this_scroll_margin
4976 && (NILP (Vscroll_preserve_screen_position)
4977 || EQ (Vscroll_preserve_screen_position, Qt)))
4978 /* We found PT at a legitimate height. Leave it alone. */
4980 else if (window_scroll_pixel_based_preserve_y >= 0)
4982 /* If we have a header line, take account of it.
4983 This is necessary because we set it.current_y to 0, above. */
4984 move_it_to (&it, -1,
4985 window_scroll_pixel_based_preserve_x,
4986 window_scroll_pixel_based_preserve_y
4987 - (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0 ),
4988 -1, MOVE_TO_Y | MOVE_TO_X);
4989 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4991 else
4993 while (it.current_y < this_scroll_margin)
4995 int prev = it.current_y;
4996 move_it_by_lines (&it, 1, 1);
4997 if (prev == it.current_y)
4998 break;
5000 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5003 else if (n < 0)
5005 EMACS_INT charpos, bytepos;
5006 int partial_p;
5008 /* Save our position, for the
5009 window_scroll_pixel_based_preserve_y case. */
5010 charpos = IT_CHARPOS (it);
5011 bytepos = IT_BYTEPOS (it);
5013 /* We moved the window start towards BEGV, so PT may be now
5014 in the scroll margin at the bottom. */
5015 move_it_to (&it, PT, -1,
5016 (it.last_visible_y - CURRENT_HEADER_LINE_HEIGHT (w)
5017 - this_scroll_margin - 1),
5019 MOVE_TO_POS | MOVE_TO_Y);
5021 /* Save our position, in case it's correct. */
5022 charpos = IT_CHARPOS (it);
5023 bytepos = IT_BYTEPOS (it);
5025 /* See if point is on a partially visible line at the end. */
5026 if (it.what == IT_EOB)
5027 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
5028 else
5030 move_it_by_lines (&it, 1, 1);
5031 partial_p = it.current_y > it.last_visible_y;
5034 if (charpos == PT && !partial_p
5035 && (NILP (Vscroll_preserve_screen_position)
5036 || EQ (Vscroll_preserve_screen_position, Qt)))
5037 /* We found PT before we found the display margin, so PT is ok. */
5039 else if (window_scroll_pixel_based_preserve_y >= 0)
5041 SET_TEXT_POS_FROM_MARKER (start, w->start);
5042 start_display (&it, w, start);
5043 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
5044 here because we called start_display again and did not
5045 alter it.current_y this time. */
5046 move_it_to (&it, -1, window_scroll_pixel_based_preserve_x,
5047 window_scroll_pixel_based_preserve_y, -1,
5048 MOVE_TO_Y | MOVE_TO_X);
5049 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5051 else
5053 if (partial_p)
5054 /* The last line was only partially visible, so back up two
5055 lines to make sure we're on a fully visible line. */
5057 move_it_by_lines (&it, -2, 0);
5058 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5060 else
5061 /* No, the position we saved is OK, so use it. */
5062 SET_PT_BOTH (charpos, bytepos);
5068 /* Implementation of window_scroll that works based on screen lines.
5069 See the comment of window_scroll for parameter descriptions. */
5071 static void
5072 window_scroll_line_based (Lisp_Object window, int n, int whole, int noerror)
5074 register struct window *w = XWINDOW (window);
5075 register EMACS_INT opoint = PT, opoint_byte = PT_BYTE;
5076 register EMACS_INT pos, pos_byte;
5077 register int ht = window_internal_height (w);
5078 register Lisp_Object tem;
5079 int lose;
5080 Lisp_Object bolp;
5081 EMACS_INT startpos;
5082 Lisp_Object original_pos = Qnil;
5084 /* If scrolling screen-fulls, compute the number of lines to
5085 scroll from the window's height. */
5086 if (whole)
5087 n *= max (1, ht - next_screen_context_lines);
5089 startpos = marker_position (w->start);
5091 if (!NILP (Vscroll_preserve_screen_position))
5093 if (window_scroll_preserve_vpos <= 0
5094 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
5095 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
5097 struct position posit
5098 = *compute_motion (startpos, 0, 0, 0,
5099 PT, ht, 0,
5100 -1, XINT (w->hscroll),
5101 0, w);
5102 window_scroll_preserve_vpos = posit.vpos;
5103 window_scroll_preserve_hpos = posit.hpos + XINT (w->hscroll);
5106 original_pos = Fcons (make_number (window_scroll_preserve_hpos),
5107 make_number (window_scroll_preserve_vpos));
5110 XSETFASTINT (tem, PT);
5111 tem = Fpos_visible_in_window_p (tem, window, Qnil);
5113 if (NILP (tem))
5115 Fvertical_motion (make_number (- (ht / 2)), window);
5116 startpos = PT;
5119 SET_PT (startpos);
5120 lose = n < 0 && PT == BEGV;
5121 Fvertical_motion (make_number (n), window);
5122 pos = PT;
5123 pos_byte = PT_BYTE;
5124 bolp = Fbolp ();
5125 SET_PT_BOTH (opoint, opoint_byte);
5127 if (lose)
5129 if (noerror)
5130 return;
5131 else
5132 xsignal0 (Qbeginning_of_buffer);
5135 if (pos < ZV)
5137 int this_scroll_margin = scroll_margin;
5139 /* Don't use a scroll margin that is negative or too large. */
5140 if (this_scroll_margin < 0)
5141 this_scroll_margin = 0;
5143 if (XINT (w->total_lines) < 4 * scroll_margin)
5144 this_scroll_margin = XINT (w->total_lines) / 4;
5146 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
5147 w->start_at_line_beg = bolp;
5148 w->update_mode_line = Qt;
5149 XSETFASTINT (w->last_modified, 0);
5150 XSETFASTINT (w->last_overlay_modified, 0);
5151 /* Set force_start so that redisplay_window will run
5152 the window-scroll-functions. */
5153 w->force_start = Qt;
5155 if (!NILP (Vscroll_preserve_screen_position)
5156 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
5158 SET_PT_BOTH (pos, pos_byte);
5159 Fvertical_motion (original_pos, window);
5161 /* If we scrolled forward, put point enough lines down
5162 that it is outside the scroll margin. */
5163 else if (n > 0)
5165 int top_margin;
5167 if (this_scroll_margin > 0)
5169 SET_PT_BOTH (pos, pos_byte);
5170 Fvertical_motion (make_number (this_scroll_margin), window);
5171 top_margin = PT;
5173 else
5174 top_margin = pos;
5176 if (top_margin <= opoint)
5177 SET_PT_BOTH (opoint, opoint_byte);
5178 else if (!NILP (Vscroll_preserve_screen_position))
5180 SET_PT_BOTH (pos, pos_byte);
5181 Fvertical_motion (original_pos, window);
5183 else
5184 SET_PT (top_margin);
5186 else if (n < 0)
5188 int bottom_margin;
5190 /* If we scrolled backward, put point near the end of the window
5191 but not within the scroll margin. */
5192 SET_PT_BOTH (pos, pos_byte);
5193 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
5194 if (XFASTINT (tem) == ht - this_scroll_margin)
5195 bottom_margin = PT;
5196 else
5197 bottom_margin = PT + 1;
5199 if (bottom_margin > opoint)
5200 SET_PT_BOTH (opoint, opoint_byte);
5201 else
5203 if (!NILP (Vscroll_preserve_screen_position))
5205 SET_PT_BOTH (pos, pos_byte);
5206 Fvertical_motion (original_pos, window);
5208 else
5209 Fvertical_motion (make_number (-1), window);
5213 else
5215 if (noerror)
5216 return;
5217 else
5218 xsignal0 (Qend_of_buffer);
5223 /* Scroll selected_window up or down. If N is nil, scroll a
5224 screen-full which is defined as the height of the window minus
5225 next_screen_context_lines. If N is the symbol `-', scroll.
5226 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
5227 up. This is the guts of Fscroll_up and Fscroll_down. */
5229 static void
5230 scroll_command (Lisp_Object n, int direction)
5232 int count = SPECPDL_INDEX ();
5234 xassert (eabs (direction) == 1);
5236 /* If selected window's buffer isn't current, make it current for
5237 the moment. But don't screw up if window_scroll gets an error. */
5238 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
5240 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5241 Fset_buffer (XWINDOW (selected_window)->buffer);
5243 /* Make redisplay consider other windows than just selected_window. */
5244 ++windows_or_buffers_changed;
5247 if (NILP (n))
5248 window_scroll (selected_window, direction, 1, 0);
5249 else if (EQ (n, Qminus))
5250 window_scroll (selected_window, -direction, 1, 0);
5251 else
5253 n = Fprefix_numeric_value (n);
5254 window_scroll (selected_window, XINT (n) * direction, 0, 0);
5257 unbind_to (count, Qnil);
5260 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
5261 doc: /* Scroll text of selected window upward ARG lines.
5262 If ARG is omitted or nil, scroll upward by a near full screen.
5263 A near full screen is `next-screen-context-lines' less than a full screen.
5264 Negative ARG means scroll downward.
5265 If ARG is the atom `-', scroll downward by nearly full screen.
5266 When calling from a program, supply as argument a number, nil, or `-'. */)
5267 (Lisp_Object arg)
5269 scroll_command (arg, 1);
5270 return Qnil;
5273 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
5274 doc: /* Scroll text of selected window down ARG lines.
5275 If ARG is omitted or nil, scroll down by a near full screen.
5276 A near full screen is `next-screen-context-lines' less than a full screen.
5277 Negative ARG means scroll upward.
5278 If ARG is the atom `-', scroll upward by nearly full screen.
5279 When calling from a program, supply as argument a number, nil, or `-'. */)
5280 (Lisp_Object arg)
5282 scroll_command (arg, -1);
5283 return Qnil;
5286 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
5287 doc: /* Return the other window for \"other window scroll\" commands.
5288 If `other-window-scroll-buffer' is non-nil, a window
5289 showing that buffer is used.
5290 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5291 specifies the window. This takes precedence over
5292 `other-window-scroll-buffer'. */)
5293 (void)
5295 Lisp_Object window;
5297 if (MINI_WINDOW_P (XWINDOW (selected_window))
5298 && !NILP (Vminibuf_scroll_window))
5299 window = Vminibuf_scroll_window;
5300 /* If buffer is specified, scroll that buffer. */
5301 else if (!NILP (Vother_window_scroll_buffer))
5303 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
5304 if (NILP (window))
5305 window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil);
5307 else
5309 /* Nothing specified; look for a neighboring window on the same
5310 frame. */
5311 window = Fnext_window (selected_window, Qnil, Qnil);
5313 if (EQ (window, selected_window))
5314 /* That didn't get us anywhere; look for a window on another
5315 visible frame. */
5317 window = Fnext_window (window, Qnil, Qt);
5318 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
5319 && ! EQ (window, selected_window));
5322 CHECK_LIVE_WINDOW (window);
5324 if (EQ (window, selected_window))
5325 error ("There is no other window");
5327 return window;
5330 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
5331 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
5332 A near full screen is `next-screen-context-lines' less than a full screen.
5333 The next window is the one below the current one; or the one at the top
5334 if the current one is at the bottom. Negative ARG means scroll downward.
5335 If ARG is the atom `-', scroll downward by nearly full screen.
5336 When calling from a program, supply as argument a number, nil, or `-'.
5338 If `other-window-scroll-buffer' is non-nil, scroll the window
5339 showing that buffer, popping the buffer up if necessary.
5340 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5341 specifies the window to scroll. This takes precedence over
5342 `other-window-scroll-buffer'. */)
5343 (Lisp_Object arg)
5345 Lisp_Object window;
5346 struct window *w;
5347 int count = SPECPDL_INDEX ();
5349 window = Fother_window_for_scrolling ();
5350 w = XWINDOW (window);
5352 /* Don't screw up if window_scroll gets an error. */
5353 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5354 ++windows_or_buffers_changed;
5356 Fset_buffer (w->buffer);
5357 SET_PT (marker_position (w->pointm));
5359 if (NILP (arg))
5360 window_scroll (window, 1, 1, 1);
5361 else if (EQ (arg, Qminus))
5362 window_scroll (window, -1, 1, 1);
5363 else
5365 if (CONSP (arg))
5366 arg = Fcar (arg);
5367 CHECK_NUMBER (arg);
5368 window_scroll (window, XINT (arg), 0, 1);
5371 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
5372 unbind_to (count, Qnil);
5374 return Qnil;
5377 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
5378 doc: /* Scroll selected window display ARG columns left.
5379 Default for ARG is window width minus 2.
5380 Value is the total amount of leftward horizontal scrolling in
5381 effect after the change.
5382 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5383 lower bound for automatic scrolling, i.e. automatic scrolling
5384 will not scroll a window to a column less than the value returned
5385 by this function. This happens in an interactive call. */)
5386 (register Lisp_Object arg, Lisp_Object set_minimum)
5388 Lisp_Object result;
5389 int hscroll;
5390 struct window *w = XWINDOW (selected_window);
5392 if (NILP (arg))
5393 XSETFASTINT (arg, window_box_text_cols (w) - 2);
5394 else
5395 arg = Fprefix_numeric_value (arg);
5397 hscroll = XINT (w->hscroll) + XINT (arg);
5398 result = Fset_window_hscroll (selected_window, make_number (hscroll));
5400 if (!NILP (set_minimum))
5401 w->min_hscroll = w->hscroll;
5403 return result;
5406 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
5407 doc: /* Scroll selected window display ARG columns right.
5408 Default for ARG is window width minus 2.
5409 Value is the total amount of leftward horizontal scrolling in
5410 effect after the change.
5411 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5412 lower bound for automatic scrolling, i.e. automatic scrolling
5413 will not scroll a window to a column less than the value returned
5414 by this function. This happens in an interactive call. */)
5415 (register Lisp_Object arg, Lisp_Object set_minimum)
5417 Lisp_Object result;
5418 int hscroll;
5419 struct window *w = XWINDOW (selected_window);
5421 if (NILP (arg))
5422 XSETFASTINT (arg, window_box_text_cols (w) - 2);
5423 else
5424 arg = Fprefix_numeric_value (arg);
5426 hscroll = XINT (w->hscroll) - XINT (arg);
5427 result = Fset_window_hscroll (selected_window, make_number (hscroll));
5429 if (!NILP (set_minimum))
5430 w->min_hscroll = w->hscroll;
5432 return result;
5435 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
5436 doc: /* Return the window which was selected when entering the minibuffer.
5437 Returns nil, if selected window is not a minibuffer window. */)
5438 (void)
5440 if (minibuf_level > 0
5441 && MINI_WINDOW_P (XWINDOW (selected_window))
5442 && WINDOW_LIVE_P (minibuf_selected_window))
5443 return minibuf_selected_window;
5445 return Qnil;
5448 /* Value is the number of lines actually displayed in window W,
5449 as opposed to its height. */
5451 static int
5452 displayed_window_lines (struct window *w)
5454 struct it it;
5455 struct text_pos start;
5456 int height = window_box_height (w);
5457 struct buffer *old_buffer;
5458 int bottom_y;
5460 if (XBUFFER (w->buffer) != current_buffer)
5462 old_buffer = current_buffer;
5463 set_buffer_internal (XBUFFER (w->buffer));
5465 else
5466 old_buffer = NULL;
5468 /* In case W->start is out of the accessible range, do something
5469 reasonable. This happens in Info mode when Info-scroll-down
5470 calls (recenter -1) while W->start is 1. */
5471 if (XMARKER (w->start)->charpos < BEGV)
5472 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
5473 else if (XMARKER (w->start)->charpos > ZV)
5474 SET_TEXT_POS (start, ZV, ZV_BYTE);
5475 else
5476 SET_TEXT_POS_FROM_MARKER (start, w->start);
5478 start_display (&it, w, start);
5479 move_it_vertically (&it, height);
5480 bottom_y = line_bottom_y (&it);
5482 /* rms: On a non-window display,
5483 the value of it.vpos at the bottom of the screen
5484 seems to be 1 larger than window_box_height (w).
5485 This kludge fixes a bug whereby (move-to-window-line -1)
5486 when ZV is on the last screen line
5487 moves to the previous screen line instead of the last one. */
5488 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
5489 height++;
5491 /* Add in empty lines at the bottom of the window. */
5492 if (bottom_y < height)
5494 int uy = FRAME_LINE_HEIGHT (it.f);
5495 it.vpos += (height - bottom_y + uy - 1) / uy;
5498 if (old_buffer)
5499 set_buffer_internal (old_buffer);
5501 return it.vpos;
5505 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
5506 doc: /* Center point in selected window and maybe redisplay frame.
5507 With prefix argument ARG, recenter putting point on screen line ARG
5508 relative to the selected window. If ARG is negative, it counts up from the
5509 bottom of the window. (ARG should be less than the height of the window.)
5511 If ARG is omitted or nil, then recenter with point on the middle line of
5512 the selected window; if the variable `recenter-redisplay' is non-nil,
5513 also erase the entire frame and redraw it (when `auto-resize-tool-bars'
5514 is set to `grow-only', this resets the tool-bar's height to the minimum
5515 height needed); if `recenter-redisplay' has the special value `tty',
5516 then only tty frame are redrawn.
5518 Just C-u as prefix means put point in the center of the window
5519 and redisplay normally--don't erase and redraw the frame. */)
5520 (register Lisp_Object arg)
5522 struct window *w = XWINDOW (selected_window);
5523 struct buffer *buf = XBUFFER (w->buffer);
5524 struct buffer *obuf = current_buffer;
5525 int center_p = 0;
5526 EMACS_INT charpos, bytepos;
5527 int iarg;
5528 int this_scroll_margin;
5530 /* If redisplay is suppressed due to an error, try again. */
5531 obuf->display_error_modiff = 0;
5533 if (NILP (arg))
5535 if (!NILP (Vrecenter_redisplay)
5536 && (!EQ (Vrecenter_redisplay, Qtty)
5537 || !NILP (Ftty_type (selected_frame))))
5539 int i;
5541 /* Invalidate pixel data calculated for all compositions. */
5542 for (i = 0; i < n_compositions; i++)
5543 composition_table[i]->font = NULL;
5545 WINDOW_XFRAME (w)->minimize_tool_bar_window_p = 1;
5547 Fredraw_frame (WINDOW_FRAME (w));
5548 SET_FRAME_GARBAGED (WINDOW_XFRAME (w));
5551 center_p = 1;
5553 else if (CONSP (arg)) /* Just C-u. */
5554 center_p = 1;
5555 else
5557 arg = Fprefix_numeric_value (arg);
5558 CHECK_NUMBER (arg);
5559 iarg = XINT (arg);
5562 set_buffer_internal (buf);
5564 /* Do this after making BUF current
5565 in case scroll_margin is buffer-local. */
5566 this_scroll_margin = max (0, scroll_margin);
5567 this_scroll_margin = min (this_scroll_margin,
5568 XFASTINT (w->total_lines) / 4);
5570 /* Handle centering on a graphical frame specially. Such frames can
5571 have variable-height lines and centering point on the basis of
5572 line counts would lead to strange effects. */
5573 if (FRAME_WINDOW_P (XFRAME (w->frame)))
5575 if (center_p)
5577 struct it it;
5578 struct text_pos pt;
5580 SET_TEXT_POS (pt, PT, PT_BYTE);
5581 start_display (&it, w, pt);
5582 move_it_vertically_backward (&it, window_box_height (w) / 2);
5583 charpos = IT_CHARPOS (it);
5584 bytepos = IT_BYTEPOS (it);
5586 else if (iarg < 0)
5588 struct it it;
5589 struct text_pos pt;
5590 int nlines = -iarg;
5591 int extra_line_spacing;
5592 int h = window_box_height (w);
5594 iarg = - max (-iarg, this_scroll_margin);
5596 SET_TEXT_POS (pt, PT, PT_BYTE);
5597 start_display (&it, w, pt);
5599 /* Be sure we have the exact height of the full line containing PT. */
5600 move_it_by_lines (&it, 0, 1);
5602 /* The amount of pixels we have to move back is the window
5603 height minus what's displayed in the line containing PT,
5604 and the lines below. */
5605 it.current_y = 0;
5606 it.vpos = 0;
5607 move_it_by_lines (&it, nlines, 1);
5609 if (it.vpos == nlines)
5610 h -= it.current_y;
5611 else
5613 /* Last line has no newline */
5614 h -= line_bottom_y (&it);
5615 it.vpos++;
5618 /* Don't reserve space for extra line spacing of last line. */
5619 extra_line_spacing = it.max_extra_line_spacing;
5621 /* If we can't move down NLINES lines because we hit
5622 the end of the buffer, count in some empty lines. */
5623 if (it.vpos < nlines)
5625 nlines -= it.vpos;
5626 extra_line_spacing = it.extra_line_spacing;
5627 h -= nlines * (FRAME_LINE_HEIGHT (it.f) + extra_line_spacing);
5629 if (h <= 0)
5630 return Qnil;
5632 /* Now find the new top line (starting position) of the window. */
5633 start_display (&it, w, pt);
5634 it.current_y = 0;
5635 move_it_vertically_backward (&it, h);
5637 /* If extra line spacing is present, we may move too far
5638 back. This causes the last line to be only partially
5639 visible (which triggers redisplay to recenter that line
5640 in the middle), so move forward.
5641 But ignore extra line spacing on last line, as it is not
5642 considered to be part of the visible height of the line.
5644 h += extra_line_spacing;
5645 while (-it.current_y > h)
5646 move_it_by_lines (&it, 1, 1);
5648 charpos = IT_CHARPOS (it);
5649 bytepos = IT_BYTEPOS (it);
5651 else
5653 struct position pos;
5655 iarg = max (iarg, this_scroll_margin);
5657 pos = *vmotion (PT, -iarg, w);
5658 charpos = pos.bufpos;
5659 bytepos = pos.bytepos;
5662 else
5664 struct position pos;
5665 int ht = window_internal_height (w);
5667 if (center_p)
5668 iarg = ht / 2;
5669 else if (iarg < 0)
5670 iarg += ht;
5672 /* Don't let it get into the margin at either top or bottom. */
5673 iarg = max (iarg, this_scroll_margin);
5674 iarg = min (iarg, ht - this_scroll_margin - 1);
5676 pos = *vmotion (PT, - iarg, w);
5677 charpos = pos.bufpos;
5678 bytepos = pos.bytepos;
5681 /* Set the new window start. */
5682 set_marker_both (w->start, w->buffer, charpos, bytepos);
5683 w->window_end_valid = Qnil;
5685 w->optional_new_start = Qt;
5687 if (bytepos == BEGV_BYTE || FETCH_BYTE (bytepos - 1) == '\n')
5688 w->start_at_line_beg = Qt;
5689 else
5690 w->start_at_line_beg = Qnil;
5692 set_buffer_internal (obuf);
5693 return Qnil;
5697 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5698 0, 1, 0,
5699 doc: /* Return the height in lines of the text display area of WINDOW.
5700 WINDOW defaults to the selected window.
5702 The return value does not include the mode line, any header line, nor
5703 any partial-height lines in the text display area. */)
5704 (Lisp_Object window)
5706 struct window *w = decode_window (window);
5707 int pixel_height = window_box_height (w);
5708 int line_height = pixel_height / FRAME_LINE_HEIGHT (XFRAME (w->frame));
5709 return make_number (line_height);
5714 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
5715 1, 1, "P",
5716 doc: /* Position point relative to window.
5717 With no argument, position point at center of window.
5718 An argument specifies vertical position within the window;
5719 zero means top of window, negative means relative to bottom of window. */)
5720 (Lisp_Object arg)
5722 struct window *w = XWINDOW (selected_window);
5723 int lines, start;
5724 Lisp_Object window;
5725 #if 0
5726 int this_scroll_margin;
5727 #endif
5729 if (!(BUFFERP (w->buffer)
5730 && XBUFFER (w->buffer) == current_buffer))
5731 /* This test is needed to make sure PT/PT_BYTE make sense in w->buffer
5732 when passed below to set_marker_both. */
5733 error ("move-to-window-line called from unrelated buffer");
5735 window = selected_window;
5736 start = marker_position (w->start);
5737 if (start < BEGV || start > ZV)
5739 int height = window_internal_height (w);
5740 Fvertical_motion (make_number (- (height / 2)), window);
5741 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
5742 w->start_at_line_beg = Fbolp ();
5743 w->force_start = Qt;
5745 else
5746 Fgoto_char (w->start);
5748 lines = displayed_window_lines (w);
5750 #if 0
5751 this_scroll_margin = max (0, scroll_margin);
5752 this_scroll_margin = min (this_scroll_margin, lines / 4);
5753 #endif
5755 if (NILP (arg))
5756 XSETFASTINT (arg, lines / 2);
5757 else
5759 int iarg = XINT (Fprefix_numeric_value (arg));
5761 if (iarg < 0)
5762 iarg = iarg + lines;
5764 #if 0 /* This code would prevent move-to-window-line from moving point
5765 to a place inside the scroll margins (which would cause the
5766 next redisplay to scroll). I wrote this code, but then concluded
5767 it is probably better not to install it. However, it is here
5768 inside #if 0 so as not to lose it. -- rms. */
5770 /* Don't let it get into the margin at either top or bottom. */
5771 iarg = max (iarg, this_scroll_margin);
5772 iarg = min (iarg, lines - this_scroll_margin - 1);
5773 #endif
5775 arg = make_number (iarg);
5778 /* Skip past a partially visible first line. */
5779 if (w->vscroll)
5780 XSETINT (arg, XINT (arg) + 1);
5782 return Fvertical_motion (arg, window);
5787 /***********************************************************************
5788 Window Configuration
5789 ***********************************************************************/
5791 struct save_window_data
5793 EMACS_UINT size;
5794 struct Lisp_Vector *next_from_Lisp_Vector_struct;
5795 Lisp_Object selected_frame;
5796 Lisp_Object current_window;
5797 Lisp_Object current_buffer;
5798 Lisp_Object minibuf_scroll_window;
5799 Lisp_Object minibuf_selected_window;
5800 Lisp_Object root_window;
5801 Lisp_Object focus_frame;
5802 /* A vector, each of whose elements is a struct saved_window
5803 for one window. */
5804 Lisp_Object saved_windows;
5806 /* All fields above are traced by the GC.
5807 From `fame-cols' down, the fields are ignored by the GC. */
5809 int frame_cols, frame_lines, frame_menu_bar_lines;
5810 int frame_tool_bar_lines;
5813 /* This is saved as a Lisp_Vector */
5814 struct saved_window
5816 /* these first two must agree with struct Lisp_Vector in lisp.h */
5817 EMACS_UINT size;
5818 struct Lisp_Vector *next_from_Lisp_Vector_struct;
5820 Lisp_Object window;
5821 Lisp_Object buffer, start, pointm, mark;
5822 Lisp_Object left_col, top_line, total_cols, total_lines;
5823 Lisp_Object hscroll, min_hscroll;
5824 Lisp_Object parent, prev;
5825 Lisp_Object start_at_line_beg;
5826 Lisp_Object display_table;
5827 Lisp_Object orig_top_line, orig_total_lines;
5828 Lisp_Object left_margin_cols, right_margin_cols;
5829 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
5830 Lisp_Object scroll_bar_width, vertical_scroll_bar_type;
5831 Lisp_Object dedicated, resize_proportionally;
5834 #define SAVED_WINDOW_N(swv,n) \
5835 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5837 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
5838 doc: /* Return t if OBJECT is a window-configuration object. */)
5839 (Lisp_Object object)
5841 return WINDOW_CONFIGURATIONP (object) ? Qt : Qnil;
5844 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
5845 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5846 (Lisp_Object config)
5848 register struct save_window_data *data;
5849 struct Lisp_Vector *saved_windows;
5851 CHECK_WINDOW_CONFIGURATION (config);
5853 data = (struct save_window_data *) XVECTOR (config);
5854 saved_windows = XVECTOR (data->saved_windows);
5855 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5858 DEFUN ("set-window-configuration", Fset_window_configuration,
5859 Sset_window_configuration, 1, 1, 0,
5860 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5861 CONFIGURATION must be a value previously returned
5862 by `current-window-configuration' (which see).
5863 If CONFIGURATION was made from a frame that is now deleted,
5864 only frame-independent values can be restored. In this case,
5865 the return value is nil. Otherwise the value is t. */)
5866 (Lisp_Object configuration)
5868 register struct save_window_data *data;
5869 struct Lisp_Vector *saved_windows;
5870 Lisp_Object new_current_buffer;
5871 Lisp_Object frame;
5872 FRAME_PTR f;
5873 EMACS_INT old_point = -1;
5875 CHECK_WINDOW_CONFIGURATION (configuration);
5877 data = (struct save_window_data *) XVECTOR (configuration);
5878 saved_windows = XVECTOR (data->saved_windows);
5880 new_current_buffer = data->current_buffer;
5881 if (NILP (BVAR (XBUFFER (new_current_buffer), name)))
5882 new_current_buffer = Qnil;
5883 else
5885 if (XBUFFER (new_current_buffer) == current_buffer)
5886 /* The code further down "preserves point" by saving here PT in
5887 old_point and then setting it later back into PT. When the
5888 current-selected-window and the final-selected-window both show
5889 the current buffer, this suffers from the problem that the
5890 current PT is the window-point of the current-selected-window,
5891 while the final PT is the point of the final-selected-window, so
5892 this copy from one PT to the other would end up moving the
5893 window-point of the final-selected-window to the window-point of
5894 the current-selected-window. So we have to be careful which
5895 point of the current-buffer we copy into old_point. */
5896 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5897 && WINDOWP (selected_window)
5898 && EQ (XWINDOW (selected_window)->buffer, new_current_buffer)
5899 && !EQ (selected_window, data->current_window))
5900 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5901 else
5902 old_point = PT;
5903 else
5904 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
5905 point in new_current_buffer as of the last time this buffer was
5906 used. This can be non-deterministic since it can be changed by
5907 things like jit-lock by mere temporary selection of some random
5908 window that happens to show this buffer.
5909 So if possible we want this arbitrary choice of "which point" to
5910 be the one from the to-be-selected-window so as to prevent this
5911 window's cursor from being copied from another window. */
5912 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5913 /* If current_window = selected_window, its point is in BUF_PT. */
5914 && !EQ (selected_window, data->current_window))
5915 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5916 else
5917 old_point = BUF_PT (XBUFFER (new_current_buffer));
5920 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5921 f = XFRAME (frame);
5923 /* If f is a dead frame, don't bother rebuilding its window tree.
5924 However, there is other stuff we should still try to do below. */
5925 if (FRAME_LIVE_P (f))
5927 register struct window *w;
5928 register struct saved_window *p;
5929 struct window *root_window;
5930 struct window **leaf_windows;
5931 int n_leaf_windows;
5932 int k, i, n;
5934 /* If the frame has been resized since this window configuration was
5935 made, we change the frame to the size specified in the
5936 configuration, restore the configuration, and then resize it
5937 back. We keep track of the prevailing height in these variables. */
5938 int previous_frame_lines = FRAME_LINES (f);
5939 int previous_frame_cols = FRAME_COLS (f);
5940 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
5941 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
5943 /* The mouse highlighting code could get screwed up
5944 if it runs during this. */
5945 BLOCK_INPUT;
5947 if (data->frame_lines != previous_frame_lines
5948 || data->frame_cols != previous_frame_cols)
5949 change_frame_size (f, data->frame_lines,
5950 data->frame_cols, 0, 0, 0);
5951 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5952 if (data->frame_menu_bar_lines
5953 != previous_frame_menu_bar_lines)
5954 x_set_menu_bar_lines (f, make_number (data->frame_menu_bar_lines),
5955 make_number (0));
5956 #ifdef HAVE_WINDOW_SYSTEM
5957 if (data->frame_tool_bar_lines
5958 != previous_frame_tool_bar_lines)
5959 x_set_tool_bar_lines (f, make_number (data->frame_tool_bar_lines),
5960 make_number (0));
5961 #endif
5962 #endif
5964 /* "Swap out" point from the selected window's buffer
5965 into the window itself. (Normally the pointm of the selected
5966 window holds garbage.) We do this now, before
5967 restoring the window contents, and prevent it from
5968 being done later on when we select a new window. */
5969 if (! NILP (XWINDOW (selected_window)->buffer))
5971 w = XWINDOW (selected_window);
5972 set_marker_both (w->pointm,
5973 w->buffer,
5974 BUF_PT (XBUFFER (w->buffer)),
5975 BUF_PT_BYTE (XBUFFER (w->buffer)));
5978 windows_or_buffers_changed++;
5979 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
5981 /* Problem: Freeing all matrices and later allocating them again
5982 is a serious redisplay flickering problem. What we would
5983 really like to do is to free only those matrices not reused
5984 below. */
5985 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
5986 leaf_windows
5987 = (struct window **) alloca (count_windows (root_window)
5988 * sizeof (struct window *));
5989 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
5991 /* Kludge Alert!
5992 Mark all windows now on frame as "deleted".
5993 Restoring the new configuration "undeletes" any that are in it.
5995 Save their current buffers in their height fields, since we may
5996 need it later, if a buffer saved in the configuration is now
5997 dead. */
5998 delete_all_subwindows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6000 for (k = 0; k < saved_windows->size; k++)
6002 p = SAVED_WINDOW_N (saved_windows, k);
6003 w = XWINDOW (p->window);
6004 w->next = Qnil;
6006 if (!NILP (p->parent))
6007 w->parent = SAVED_WINDOW_N (saved_windows,
6008 XFASTINT (p->parent))->window;
6009 else
6010 w->parent = Qnil;
6012 if (!NILP (p->prev))
6014 w->prev = SAVED_WINDOW_N (saved_windows,
6015 XFASTINT (p->prev))->window;
6016 XWINDOW (w->prev)->next = p->window;
6018 else
6020 w->prev = Qnil;
6021 if (!NILP (w->parent))
6023 if (EQ (p->total_cols, XWINDOW (w->parent)->total_cols))
6025 XWINDOW (w->parent)->vchild = p->window;
6026 XWINDOW (w->parent)->hchild = Qnil;
6028 else
6030 XWINDOW (w->parent)->hchild = p->window;
6031 XWINDOW (w->parent)->vchild = Qnil;
6036 /* If we squirreled away the buffer in the window's height,
6037 restore it now. */
6038 if (BUFFERP (w->total_lines))
6039 w->buffer = w->total_lines;
6040 w->left_col = p->left_col;
6041 w->top_line = p->top_line;
6042 w->total_cols = p->total_cols;
6043 w->total_lines = p->total_lines;
6044 w->hscroll = p->hscroll;
6045 w->min_hscroll = p->min_hscroll;
6046 w->display_table = p->display_table;
6047 w->orig_top_line = p->orig_top_line;
6048 w->orig_total_lines = p->orig_total_lines;
6049 w->left_margin_cols = p->left_margin_cols;
6050 w->right_margin_cols = p->right_margin_cols;
6051 w->left_fringe_width = p->left_fringe_width;
6052 w->right_fringe_width = p->right_fringe_width;
6053 w->fringes_outside_margins = p->fringes_outside_margins;
6054 w->scroll_bar_width = p->scroll_bar_width;
6055 w->vertical_scroll_bar_type = p->vertical_scroll_bar_type;
6056 w->dedicated = p->dedicated;
6057 w->resize_proportionally = p->resize_proportionally;
6058 XSETFASTINT (w->last_modified, 0);
6059 XSETFASTINT (w->last_overlay_modified, 0);
6061 /* Reinstall the saved buffer and pointers into it. */
6062 if (NILP (p->buffer))
6063 w->buffer = p->buffer;
6064 else
6066 if (!NILP (BVAR (XBUFFER (p->buffer), name)))
6067 /* If saved buffer is alive, install it. */
6069 w->buffer = p->buffer;
6070 w->start_at_line_beg = p->start_at_line_beg;
6071 set_marker_restricted (w->start, p->start, w->buffer);
6072 set_marker_restricted (w->pointm, p->pointm, w->buffer);
6073 Fset_marker (BVAR (XBUFFER (w->buffer), mark),
6074 p->mark, w->buffer);
6076 /* As documented in Fcurrent_window_configuration, don't
6077 restore the location of point in the buffer which was
6078 current when the window configuration was recorded. */
6079 if (!EQ (p->buffer, new_current_buffer)
6080 && XBUFFER (p->buffer) == current_buffer)
6081 Fgoto_char (w->pointm);
6083 else if (NILP (w->buffer) || NILP (BVAR (XBUFFER (w->buffer), name)))
6084 /* Else unless window has a live buffer, get one. */
6086 w->buffer = Fcdr (Fcar (Vbuffer_alist));
6087 /* This will set the markers to beginning of visible
6088 range. */
6089 set_marker_restricted (w->start, make_number (0), w->buffer);
6090 set_marker_restricted (w->pointm, make_number (0),w->buffer);
6091 w->start_at_line_beg = Qt;
6093 else
6094 /* Keeping window's old buffer; make sure the markers
6095 are real. */
6097 /* Set window markers at start of visible range. */
6098 if (XMARKER (w->start)->buffer == 0)
6099 set_marker_restricted (w->start, make_number (0),
6100 w->buffer);
6101 if (XMARKER (w->pointm)->buffer == 0)
6102 set_marker_restricted_both (w->pointm, w->buffer,
6103 BUF_PT (XBUFFER (w->buffer)),
6104 BUF_PT_BYTE (XBUFFER (w->buffer)));
6105 w->start_at_line_beg = Qt;
6110 FRAME_ROOT_WINDOW (f) = data->root_window;
6112 /* Arrange *not* to restore point in the buffer that was
6113 current when the window configuration was saved. */
6114 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
6115 set_marker_restricted (XWINDOW (data->current_window)->pointm,
6116 make_number (old_point),
6117 XWINDOW (data->current_window)->buffer);
6119 /* In the following call to `select-window, prevent "swapping
6120 out point" in the old selected window using the buffer that
6121 has been restored into it. We already swapped out that point
6122 from that window's old buffer. */
6123 select_window (data->current_window, Qnil, 1);
6124 BVAR (XBUFFER (XWINDOW (selected_window)->buffer), last_selected_window)
6125 = selected_window;
6127 if (NILP (data->focus_frame)
6128 || (FRAMEP (data->focus_frame)
6129 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
6130 Fredirect_frame_focus (frame, data->focus_frame);
6132 /* Set the screen height to the value it had before this function. */
6133 if (previous_frame_lines != FRAME_LINES (f)
6134 || previous_frame_cols != FRAME_COLS (f))
6135 change_frame_size (f, previous_frame_lines, previous_frame_cols,
6136 0, 0, 0);
6137 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
6138 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
6139 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
6140 make_number (0));
6141 #ifdef HAVE_WINDOW_SYSTEM
6142 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
6143 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
6144 make_number (0));
6145 #endif
6146 #endif
6148 /* Now, free glyph matrices in windows that were not reused. */
6149 for (i = n = 0; i < n_leaf_windows; ++i)
6151 if (NILP (leaf_windows[i]->buffer))
6153 /* Assert it's not reused as a combination. */
6154 xassert (NILP (leaf_windows[i]->hchild)
6155 && NILP (leaf_windows[i]->vchild));
6156 free_window_matrices (leaf_windows[i]);
6158 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
6159 ++n;
6162 adjust_glyphs (f);
6164 UNBLOCK_INPUT;
6166 /* Fselect_window will have made f the selected frame, so we
6167 reselect the proper frame here. Fhandle_switch_frame will change the
6168 selected window too, but that doesn't make the call to
6169 Fselect_window above totally superfluous; it still sets f's
6170 selected window. */
6171 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
6172 do_switch_frame (data->selected_frame, 0, 0, Qnil);
6174 run_window_configuration_change_hook (f);
6177 if (!NILP (new_current_buffer))
6178 Fset_buffer (new_current_buffer);
6180 Vminibuf_scroll_window = data->minibuf_scroll_window;
6181 minibuf_selected_window = data->minibuf_selected_window;
6183 return (FRAME_LIVE_P (f) ? Qt : Qnil);
6186 /* Mark all windows now on frame as deleted
6187 by setting their buffers to nil. */
6189 void
6190 delete_all_subwindows (register struct window *w)
6192 if (!NILP (w->next))
6193 delete_all_subwindows (XWINDOW (w->next));
6194 if (!NILP (w->vchild))
6195 delete_all_subwindows (XWINDOW (w->vchild));
6196 if (!NILP (w->hchild))
6197 delete_all_subwindows (XWINDOW (w->hchild));
6199 w->total_lines = w->buffer; /* See Fset_window_configuration for excuse. */
6201 if (!NILP (w->buffer))
6202 unshow_buffer (w);
6204 /* We set all three of these fields to nil, to make sure that we can
6205 distinguish this dead window from any live window. Live leaf
6206 windows will have buffer set, and combination windows will have
6207 vchild or hchild set. */
6208 w->buffer = Qnil;
6209 w->vchild = Qnil;
6210 w->hchild = Qnil;
6212 Vwindow_list = Qnil;
6215 static int
6216 count_windows (register struct window *window)
6218 register int count = 1;
6219 if (!NILP (window->next))
6220 count += count_windows (XWINDOW (window->next));
6221 if (!NILP (window->vchild))
6222 count += count_windows (XWINDOW (window->vchild));
6223 if (!NILP (window->hchild))
6224 count += count_windows (XWINDOW (window->hchild));
6225 return count;
6229 /* Fill vector FLAT with leaf windows under W, starting at index I.
6230 Value is last index + 1. */
6232 static int
6233 get_leaf_windows (struct window *w, struct window **flat, int i)
6235 while (w)
6237 if (!NILP (w->hchild))
6238 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
6239 else if (!NILP (w->vchild))
6240 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
6241 else
6242 flat[i++] = w;
6244 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6247 return i;
6251 /* Return a pointer to the glyph W's physical cursor is on. Value is
6252 null if W's current matrix is invalid, so that no meaningfull glyph
6253 can be returned. */
6255 struct glyph *
6256 get_phys_cursor_glyph (struct window *w)
6258 struct glyph_row *row;
6259 struct glyph *glyph;
6261 if (w->phys_cursor.vpos >= 0
6262 && w->phys_cursor.vpos < w->current_matrix->nrows
6263 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
6264 row->enabled_p)
6265 && row->used[TEXT_AREA] > w->phys_cursor.hpos)
6266 glyph = row->glyphs[TEXT_AREA] + w->phys_cursor.hpos;
6267 else
6268 glyph = NULL;
6270 return glyph;
6274 static int
6275 save_window_save (Lisp_Object window, struct Lisp_Vector *vector, int i)
6277 register struct saved_window *p;
6278 register struct window *w;
6279 register Lisp_Object tem;
6281 for (;!NILP (window); window = w->next)
6283 p = SAVED_WINDOW_N (vector, i);
6284 w = XWINDOW (window);
6286 XSETFASTINT (w->temslot, i); i++;
6287 p->window = window;
6288 p->buffer = w->buffer;
6289 p->left_col = w->left_col;
6290 p->top_line = w->top_line;
6291 p->total_cols = w->total_cols;
6292 p->total_lines = w->total_lines;
6293 p->hscroll = w->hscroll;
6294 p->min_hscroll = w->min_hscroll;
6295 p->display_table = w->display_table;
6296 p->orig_top_line = w->orig_top_line;
6297 p->orig_total_lines = w->orig_total_lines;
6298 p->left_margin_cols = w->left_margin_cols;
6299 p->right_margin_cols = w->right_margin_cols;
6300 p->left_fringe_width = w->left_fringe_width;
6301 p->right_fringe_width = w->right_fringe_width;
6302 p->fringes_outside_margins = w->fringes_outside_margins;
6303 p->scroll_bar_width = w->scroll_bar_width;
6304 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
6305 p->dedicated = w->dedicated;
6306 p->resize_proportionally = w->resize_proportionally;
6307 if (!NILP (w->buffer))
6309 /* Save w's value of point in the window configuration.
6310 If w is the selected window, then get the value of point
6311 from the buffer; pointm is garbage in the selected window. */
6312 if (EQ (window, selected_window))
6314 p->pointm = Fmake_marker ();
6315 set_marker_both (p->pointm, w->buffer,
6316 BUF_PT (XBUFFER (w->buffer)),
6317 BUF_PT_BYTE (XBUFFER (w->buffer)));
6319 else
6320 p->pointm = Fcopy_marker (w->pointm, Qnil);
6322 p->start = Fcopy_marker (w->start, Qnil);
6323 p->start_at_line_beg = w->start_at_line_beg;
6325 tem = BVAR (XBUFFER (w->buffer), mark);
6326 p->mark = Fcopy_marker (tem, Qnil);
6328 else
6330 p->pointm = Qnil;
6331 p->start = Qnil;
6332 p->mark = Qnil;
6333 p->start_at_line_beg = Qnil;
6336 if (NILP (w->parent))
6337 p->parent = Qnil;
6338 else
6339 p->parent = XWINDOW (w->parent)->temslot;
6341 if (NILP (w->prev))
6342 p->prev = Qnil;
6343 else
6344 p->prev = XWINDOW (w->prev)->temslot;
6346 if (!NILP (w->vchild))
6347 i = save_window_save (w->vchild, vector, i);
6348 if (!NILP (w->hchild))
6349 i = save_window_save (w->hchild, vector, i);
6352 return i;
6355 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
6356 Scurrent_window_configuration, 0, 1, 0,
6357 doc: /* Return an object representing the current window configuration of FRAME.
6358 If FRAME is nil or omitted, use the selected frame.
6359 This describes the number of windows, their sizes and current buffers,
6360 and for each displayed buffer, where display starts, and the positions of
6361 point and mark. An exception is made for point in the current buffer:
6362 its value is -not- saved.
6363 This also records the currently selected frame, and FRAME's focus
6364 redirection (see `redirect-frame-focus'). */)
6365 (Lisp_Object frame)
6367 register Lisp_Object tem;
6368 register int n_windows;
6369 register struct save_window_data *data;
6370 register int i;
6371 FRAME_PTR f;
6373 if (NILP (frame))
6374 frame = selected_frame;
6375 CHECK_LIVE_FRAME (frame);
6376 f = XFRAME (frame);
6378 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6379 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
6380 PVEC_WINDOW_CONFIGURATION);
6382 data->frame_cols = FRAME_COLS (f);
6383 data->frame_lines = FRAME_LINES (f);
6384 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6385 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6386 data->selected_frame = selected_frame;
6387 data->current_window = FRAME_SELECTED_WINDOW (f);
6388 XSETBUFFER (data->current_buffer, current_buffer);
6389 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
6390 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
6391 data->root_window = FRAME_ROOT_WINDOW (f);
6392 data->focus_frame = FRAME_FOCUS_FRAME (f);
6393 tem = Fmake_vector (make_number (n_windows), Qnil);
6394 data->saved_windows = tem;
6395 for (i = 0; i < n_windows; i++)
6396 XVECTOR (tem)->contents[i]
6397 = Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil);
6398 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
6399 XSETWINDOW_CONFIGURATION (tem, data);
6400 return (tem);
6403 DEFUN ("save-window-excursion", Fsave_window_excursion, Ssave_window_excursion,
6404 0, UNEVALLED, 0,
6405 doc: /* Execute BODY, preserving window sizes and contents.
6406 Return the value of the last form in BODY.
6407 Restore which buffer appears in which window, where display starts,
6408 and the value of point and mark for each window.
6409 Also restore the choice of selected window.
6410 Also restore which buffer is current.
6411 Does not restore the value of point in current buffer.
6412 usage: (save-window-excursion BODY...) */)
6413 (Lisp_Object args)
6415 register Lisp_Object val;
6416 register int count = SPECPDL_INDEX ();
6418 record_unwind_protect (Fset_window_configuration,
6419 Fcurrent_window_configuration (Qnil));
6420 val = Fprogn (args);
6421 return unbind_to (count, val);
6426 /***********************************************************************
6427 Window Split Tree
6428 ***********************************************************************/
6430 static Lisp_Object
6431 window_tree (struct window *w)
6433 Lisp_Object tail = Qnil;
6434 Lisp_Object result = Qnil;
6436 while (w)
6438 Lisp_Object wn;
6440 XSETWINDOW (wn, w);
6441 if (!NILP (w->hchild))
6442 wn = Fcons (Qnil, Fcons (Fwindow_edges (wn),
6443 window_tree (XWINDOW (w->hchild))));
6444 else if (!NILP (w->vchild))
6445 wn = Fcons (Qt, Fcons (Fwindow_edges (wn),
6446 window_tree (XWINDOW (w->vchild))));
6448 if (NILP (result))
6450 result = tail = Fcons (wn, Qnil);
6452 else
6454 XSETCDR (tail, Fcons (wn, Qnil));
6455 tail = XCDR (tail);
6458 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6461 return result;
6466 DEFUN ("window-tree", Fwindow_tree, Swindow_tree,
6467 0, 1, 0,
6468 doc: /* Return the window tree for frame FRAME.
6470 The return value is a list of the form (ROOT MINI), where ROOT
6471 represents the window tree of the frame's root window, and MINI
6472 is the frame's minibuffer window.
6474 If the root window is not split, ROOT is the root window itself.
6475 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil for a
6476 horizontal split, and t for a vertical split, EDGES gives the combined
6477 size and position of the subwindows in the split, and the rest of the
6478 elements are the subwindows in the split. Each of the subwindows may
6479 again be a window or a list representing a window split, and so on.
6480 EDGES is a list \(LEFT TOP RIGHT BOTTOM) as returned by `window-edges'.
6482 If FRAME is nil or omitted, return information on the currently
6483 selected frame. */)
6484 (Lisp_Object frame)
6486 FRAME_PTR f;
6488 if (NILP (frame))
6489 frame = selected_frame;
6491 CHECK_FRAME (frame);
6492 f = XFRAME (frame);
6494 if (!FRAME_LIVE_P (f))
6495 return Qnil;
6497 return window_tree (XWINDOW (FRAME_ROOT_WINDOW (f)));
6501 /***********************************************************************
6502 Marginal Areas
6503 ***********************************************************************/
6505 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
6506 2, 3, 0,
6507 doc: /* Set width of marginal areas of window WINDOW.
6508 If WINDOW is nil, set margins of the currently selected window.
6509 Second arg LEFT-WIDTH specifies the number of character cells to
6510 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6511 does the same for the right marginal area. A nil width parameter
6512 means no margin. */)
6513 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width)
6515 struct window *w = decode_window (window);
6517 /* Translate negative or zero widths to nil.
6518 Margins that are too wide have to be checked elsewhere. */
6520 if (!NILP (left_width))
6522 CHECK_NUMBER (left_width);
6523 if (XINT (left_width) <= 0)
6524 left_width = Qnil;
6527 if (!NILP (right_width))
6529 CHECK_NUMBER (right_width);
6530 if (XINT (right_width) <= 0)
6531 right_width = Qnil;
6534 if (!EQ (w->left_margin_cols, left_width)
6535 || !EQ (w->right_margin_cols, right_width))
6537 w->left_margin_cols = left_width;
6538 w->right_margin_cols = right_width;
6540 adjust_window_margins (w);
6542 ++windows_or_buffers_changed;
6543 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6546 return Qnil;
6550 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
6551 0, 1, 0,
6552 doc: /* Get width of marginal areas of window WINDOW.
6553 If WINDOW is omitted or nil, use the currently selected window.
6554 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6555 If a marginal area does not exist, its width will be returned
6556 as nil. */)
6557 (Lisp_Object window)
6559 struct window *w = decode_window (window);
6560 return Fcons (w->left_margin_cols, w->right_margin_cols);
6565 /***********************************************************************
6566 Fringes
6567 ***********************************************************************/
6569 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6570 2, 4, 0,
6571 doc: /* Set the fringe widths of window WINDOW.
6572 If WINDOW is nil, set the fringe widths of the currently selected
6573 window.
6574 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6575 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6576 fringe width. If a fringe width arg is nil, that means to use the
6577 frame's default fringe width. Default fringe widths can be set with
6578 the command `set-fringe-style'.
6579 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6580 outside of the display margins. By default, fringes are drawn between
6581 display marginal areas and the text area. */)
6582 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width, Lisp_Object outside_margins)
6584 struct window *w = decode_window (window);
6586 if (!NILP (left_width))
6587 CHECK_NATNUM (left_width);
6588 if (!NILP (right_width))
6589 CHECK_NATNUM (right_width);
6591 /* Do nothing on a tty. */
6592 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6593 && (!EQ (w->left_fringe_width, left_width)
6594 || !EQ (w->right_fringe_width, right_width)
6595 || !EQ (w->fringes_outside_margins, outside_margins)))
6597 w->left_fringe_width = left_width;
6598 w->right_fringe_width = right_width;
6599 w->fringes_outside_margins = outside_margins;
6601 adjust_window_margins (w);
6603 clear_glyph_matrix (w->current_matrix);
6604 w->window_end_valid = Qnil;
6606 ++windows_or_buffers_changed;
6607 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6610 return Qnil;
6614 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6615 0, 1, 0,
6616 doc: /* Get width of fringes of window WINDOW.
6617 If WINDOW is omitted or nil, use the currently selected window.
6618 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6619 (Lisp_Object window)
6621 struct window *w = decode_window (window);
6623 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6624 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6625 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6626 ? Qt : Qnil), Qnil)));
6631 /***********************************************************************
6632 Scroll bars
6633 ***********************************************************************/
6635 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars, Sset_window_scroll_bars,
6636 2, 4, 0,
6637 doc: /* Set width and type of scroll bars of window WINDOW.
6638 If window is nil, set scroll bars of the currently selected window.
6639 Second parameter WIDTH specifies the pixel width for the scroll bar;
6640 this is automatically adjusted to a multiple of the frame column width.
6641 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6642 bar: left, right, or nil.
6643 If WIDTH is nil, use the frame's scroll-bar width.
6644 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6645 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6646 (Lisp_Object window, Lisp_Object width, Lisp_Object vertical_type, Lisp_Object horizontal_type)
6648 struct window *w = decode_window (window);
6650 if (!NILP (width))
6652 CHECK_NATNUM (width);
6654 if (XINT (width) == 0)
6655 vertical_type = Qnil;
6658 if (!(NILP (vertical_type)
6659 || EQ (vertical_type, Qleft)
6660 || EQ (vertical_type, Qright)
6661 || EQ (vertical_type, Qt)))
6662 error ("Invalid type of vertical scroll bar");
6664 if (!EQ (w->scroll_bar_width, width)
6665 || !EQ (w->vertical_scroll_bar_type, vertical_type))
6667 w->scroll_bar_width = width;
6668 w->vertical_scroll_bar_type = vertical_type;
6670 adjust_window_margins (w);
6672 clear_glyph_matrix (w->current_matrix);
6673 w->window_end_valid = Qnil;
6675 ++windows_or_buffers_changed;
6676 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6679 return Qnil;
6683 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
6684 0, 1, 0,
6685 doc: /* Get width and type of scroll bars of window WINDOW.
6686 If WINDOW is omitted or nil, use the currently selected window.
6687 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6688 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6689 value. */)
6690 (Lisp_Object window)
6692 struct window *w = decode_window (window);
6693 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6694 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6695 : WINDOW_SCROLL_BAR_AREA_WIDTH (w))),
6696 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w)),
6697 Fcons (w->vertical_scroll_bar_type,
6698 Fcons (Qnil, Qnil))));
6703 /***********************************************************************
6704 Smooth scrolling
6705 ***********************************************************************/
6707 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
6708 doc: /* Return the amount by which WINDOW is scrolled vertically.
6709 Use the selected window if WINDOW is nil or omitted.
6710 Normally, value is a multiple of the canonical character height of WINDOW;
6711 optional second arg PIXELS-P means value is measured in pixels. */)
6712 (Lisp_Object window, Lisp_Object pixels_p)
6714 Lisp_Object result;
6715 struct frame *f;
6716 struct window *w;
6718 if (NILP (window))
6719 window = selected_window;
6720 else
6721 CHECK_WINDOW (window);
6722 w = XWINDOW (window);
6723 f = XFRAME (w->frame);
6725 if (FRAME_WINDOW_P (f))
6726 result = (NILP (pixels_p)
6727 ? FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll)
6728 : make_number (-w->vscroll));
6729 else
6730 result = make_number (0);
6731 return result;
6735 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
6736 2, 3, 0,
6737 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
6738 WINDOW nil means use the selected window. Normally, VSCROLL is a
6739 non-negative multiple of the canonical character height of WINDOW;
6740 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
6741 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
6742 corresponds to an integral number of pixels. The return value is the
6743 result of this rounding.
6744 If PIXELS-P is non-nil, the return value is VSCROLL. */)
6745 (Lisp_Object window, Lisp_Object vscroll, Lisp_Object pixels_p)
6747 struct window *w;
6748 struct frame *f;
6750 if (NILP (window))
6751 window = selected_window;
6752 else
6753 CHECK_WINDOW (window);
6754 CHECK_NUMBER_OR_FLOAT (vscroll);
6756 w = XWINDOW (window);
6757 f = XFRAME (w->frame);
6759 if (FRAME_WINDOW_P (f))
6761 int old_dy = w->vscroll;
6763 w->vscroll = - (NILP (pixels_p)
6764 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
6765 : XFLOATINT (vscroll));
6766 w->vscroll = min (w->vscroll, 0);
6768 if (w->vscroll != old_dy)
6770 /* Adjust glyph matrix of the frame if the virtual display
6771 area becomes larger than before. */
6772 if (w->vscroll < 0 && w->vscroll < old_dy)
6773 adjust_glyphs (f);
6775 /* Prevent redisplay shortcuts. */
6776 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
6780 return Fwindow_vscroll (window, pixels_p);
6784 /* Call FN for all leaf windows on frame F. FN is called with the
6785 first argument being a pointer to the leaf window, and with
6786 additional argument USER_DATA. Stops when FN returns 0. */
6788 static void
6789 foreach_window (struct frame *f, int (*fn) (struct window *, void *),
6790 void *user_data)
6792 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6793 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
6794 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
6798 /* Helper function for foreach_window. Call FN for all leaf windows
6799 reachable from W. FN is called with the first argument being a
6800 pointer to the leaf window, and with additional argument USER_DATA.
6801 Stop when FN returns 0. Value is 0 if stopped by FN. */
6803 static int
6804 foreach_window_1 (struct window *w, int (*fn) (struct window *, void *), void *user_data)
6806 int cont;
6808 for (cont = 1; w && cont;)
6810 if (!NILP (w->hchild))
6811 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
6812 else if (!NILP (w->vchild))
6813 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
6814 else
6815 cont = fn (w, user_data);
6817 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6820 return cont;
6824 /* Freeze or unfreeze the window start of W unless it is a
6825 mini-window or the selected window. FREEZE_P non-null means freeze
6826 the window start. */
6828 static int
6829 freeze_window_start (struct window *w, void *freeze_p)
6831 if (MINI_WINDOW_P (w)
6832 || (WINDOWP (selected_window) /* Can be nil in corner cases. */
6833 && (w == XWINDOW (selected_window)
6834 || (MINI_WINDOW_P (XWINDOW (selected_window))
6835 && ! NILP (Vminibuf_scroll_window)
6836 && w == XWINDOW (Vminibuf_scroll_window)))))
6837 freeze_p = NULL;
6839 w->frozen_window_start_p = freeze_p != NULL;
6840 return 1;
6844 /* Freeze or unfreeze the window starts of all leaf windows on frame
6845 F, except the selected window and a mini-window. FREEZE_P non-zero
6846 means freeze the window start. */
6848 void
6849 freeze_window_starts (struct frame *f, int freeze_p)
6851 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
6855 /***********************************************************************
6856 Initialization
6857 ***********************************************************************/
6859 /* Return 1 if window configurations C1 and C2
6860 describe the same state of affairs. This is used by Fequal. */
6863 compare_window_configurations (Lisp_Object c1, Lisp_Object c2, int ignore_positions)
6865 register struct save_window_data *d1, *d2;
6866 struct Lisp_Vector *sw1, *sw2;
6867 int i;
6869 CHECK_WINDOW_CONFIGURATION (c1);
6870 CHECK_WINDOW_CONFIGURATION (c2);
6872 d1 = (struct save_window_data *) XVECTOR (c1);
6873 d2 = (struct save_window_data *) XVECTOR (c2);
6874 sw1 = XVECTOR (d1->saved_windows);
6875 sw2 = XVECTOR (d2->saved_windows);
6877 if (d1->frame_cols != d2->frame_cols)
6878 return 0;
6879 if (d1->frame_lines != d2->frame_lines)
6880 return 0;
6881 if (d1->frame_menu_bar_lines != d2->frame_menu_bar_lines)
6882 return 0;
6883 if (! EQ (d1->selected_frame, d2->selected_frame))
6884 return 0;
6885 /* Don't compare the current_window field directly.
6886 Instead see w1_is_current and w2_is_current, below. */
6887 if (! EQ (d1->current_buffer, d2->current_buffer))
6888 return 0;
6889 if (! ignore_positions)
6891 if (! EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window))
6892 return 0;
6893 if (! EQ (d1->minibuf_selected_window, d2->minibuf_selected_window))
6894 return 0;
6896 /* Don't compare the root_window field.
6897 We don't require the two configurations
6898 to use the same window object,
6899 and the two root windows must be equivalent
6900 if everything else compares equal. */
6901 if (! EQ (d1->focus_frame, d2->focus_frame))
6902 return 0;
6904 /* Verify that the two confis have the same number of windows. */
6905 if (sw1->size != sw2->size)
6906 return 0;
6908 for (i = 0; i < sw1->size; i++)
6910 struct saved_window *p1, *p2;
6911 int w1_is_current, w2_is_current;
6913 p1 = SAVED_WINDOW_N (sw1, i);
6914 p2 = SAVED_WINDOW_N (sw2, i);
6916 /* Verify that the current windows in the two
6917 configurations correspond to each other. */
6918 w1_is_current = EQ (d1->current_window, p1->window);
6919 w2_is_current = EQ (d2->current_window, p2->window);
6921 if (w1_is_current != w2_is_current)
6922 return 0;
6924 /* Verify that the corresponding windows do match. */
6925 if (! EQ (p1->buffer, p2->buffer))
6926 return 0;
6927 if (! EQ (p1->left_col, p2->left_col))
6928 return 0;
6929 if (! EQ (p1->top_line, p2->top_line))
6930 return 0;
6931 if (! EQ (p1->total_cols, p2->total_cols))
6932 return 0;
6933 if (! EQ (p1->total_lines, p2->total_lines))
6934 return 0;
6935 if (! EQ (p1->display_table, p2->display_table))
6936 return 0;
6937 if (! EQ (p1->parent, p2->parent))
6938 return 0;
6939 if (! EQ (p1->prev, p2->prev))
6940 return 0;
6941 if (! ignore_positions)
6943 if (! EQ (p1->hscroll, p2->hscroll))
6944 return 0;
6945 if (!EQ (p1->min_hscroll, p2->min_hscroll))
6946 return 0;
6947 if (! EQ (p1->start_at_line_beg, p2->start_at_line_beg))
6948 return 0;
6949 if (NILP (Fequal (p1->start, p2->start)))
6950 return 0;
6951 if (NILP (Fequal (p1->pointm, p2->pointm)))
6952 return 0;
6953 if (NILP (Fequal (p1->mark, p2->mark)))
6954 return 0;
6956 if (! EQ (p1->left_margin_cols, p2->left_margin_cols))
6957 return 0;
6958 if (! EQ (p1->right_margin_cols, p2->right_margin_cols))
6959 return 0;
6960 if (! EQ (p1->left_fringe_width, p2->left_fringe_width))
6961 return 0;
6962 if (! EQ (p1->right_fringe_width, p2->right_fringe_width))
6963 return 0;
6964 if (! EQ (p1->fringes_outside_margins, p2->fringes_outside_margins))
6965 return 0;
6966 if (! EQ (p1->scroll_bar_width, p2->scroll_bar_width))
6967 return 0;
6968 if (! EQ (p1->vertical_scroll_bar_type, p2->vertical_scroll_bar_type))
6969 return 0;
6972 return 1;
6975 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
6976 Scompare_window_configurations, 2, 2, 0,
6977 doc: /* Compare two window configurations as regards the structure of windows.
6978 This function ignores details such as the values of point and mark
6979 and scrolling positions. */)
6980 (Lisp_Object x, Lisp_Object y)
6982 if (compare_window_configurations (x, y, 1))
6983 return Qt;
6984 return Qnil;
6987 void
6988 init_window_once (void)
6990 struct frame *f = make_initial_frame ();
6991 XSETFRAME (selected_frame, f);
6992 Vterminal_frame = selected_frame;
6993 minibuf_window = f->minibuffer_window;
6994 selected_window = f->selected_window;
6995 last_nonminibuf_frame = f;
6997 window_initialized = 1;
7000 void
7001 init_window (void)
7003 Vwindow_list = Qnil;
7006 void
7007 syms_of_window (void)
7009 Qscroll_up = intern_c_string ("scroll-up");
7010 staticpro (&Qscroll_up);
7012 Qscroll_down = intern_c_string ("scroll-down");
7013 staticpro (&Qscroll_down);
7015 Qscroll_command = intern_c_string ("scroll-command");
7016 staticpro (&Qscroll_command);
7018 Fput (Qscroll_up, Qscroll_command, Qt);
7019 Fput (Qscroll_down, Qscroll_command, Qt);
7021 Qwindow_size_fixed = intern_c_string ("window-size-fixed");
7022 staticpro (&Qwindow_size_fixed);
7023 Fset (Qwindow_size_fixed, Qnil);
7025 staticpro (&Qwindow_configuration_change_hook);
7026 Qwindow_configuration_change_hook
7027 = intern_c_string ("window-configuration-change-hook");
7029 Qwindowp = intern_c_string ("windowp");
7030 staticpro (&Qwindowp);
7032 Qwindow_configuration_p = intern_c_string ("window-configuration-p");
7033 staticpro (&Qwindow_configuration_p);
7035 Qwindow_live_p = intern_c_string ("window-live-p");
7036 staticpro (&Qwindow_live_p);
7038 Qdisplay_buffer = intern_c_string ("display-buffer");
7039 staticpro (&Qdisplay_buffer);
7041 Qtemp_buffer_show_hook = intern_c_string ("temp-buffer-show-hook");
7042 staticpro (&Qtemp_buffer_show_hook);
7044 staticpro (&Vwindow_list);
7046 minibuf_selected_window = Qnil;
7047 staticpro (&minibuf_selected_window);
7049 window_scroll_pixel_based_preserve_x = -1;
7050 window_scroll_pixel_based_preserve_y = -1;
7051 window_scroll_preserve_hpos = -1;
7052 window_scroll_preserve_vpos = -1;
7054 DEFVAR_LISP ("temp-buffer-show-function", Vtemp_buffer_show_function,
7055 doc: /* Non-nil means call as function to display a help buffer.
7056 The function is called with one argument, the buffer to be displayed.
7057 Used by `with-output-to-temp-buffer'.
7058 If this function is used, then it must do the entire job of showing
7059 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
7060 Vtemp_buffer_show_function = Qnil;
7062 DEFVAR_LISP ("minibuffer-scroll-window", Vminibuf_scroll_window,
7063 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
7064 Vminibuf_scroll_window = Qnil;
7066 DEFVAR_BOOL ("mode-line-in-non-selected-windows", mode_line_in_non_selected_windows,
7067 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
7068 If the minibuffer is active, the `minibuffer-scroll-window' mode line
7069 is displayed in the `mode-line' face. */);
7070 mode_line_in_non_selected_windows = 1;
7072 DEFVAR_LISP ("other-window-scroll-buffer", Vother_window_scroll_buffer,
7073 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
7074 Vother_window_scroll_buffer = Qnil;
7076 DEFVAR_BOOL ("auto-window-vscroll", auto_window_vscroll_p,
7077 doc: /* *Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
7078 auto_window_vscroll_p = 1;
7080 DEFVAR_INT ("next-screen-context-lines", next_screen_context_lines,
7081 doc: /* *Number of lines of continuity when scrolling by screenfuls. */);
7082 next_screen_context_lines = 2;
7084 DEFVAR_INT ("window-min-height", window_min_height,
7085 doc: /* Allow deleting windows less than this tall.
7086 The value is measured in line units. If a window wants a modeline it
7087 is counted as one line.
7089 Emacs honors settings of this variable when enlarging or shrinking
7090 windows vertically. A value less than 1 is invalid. */);
7091 window_min_height = 4;
7093 DEFVAR_INT ("window-min-width", window_min_width,
7094 doc: /* Allow deleting windows less than this wide.
7095 The value is measured in characters and includes any fringes or
7096 the scrollbar.
7098 Emacs honors settings of this variable when enlarging or shrinking
7099 windows horizontally. A value less than 2 is invalid. */);
7100 window_min_width = 10;
7102 DEFVAR_LISP ("scroll-preserve-screen-position",
7103 Vscroll_preserve_screen_position,
7104 doc: /* *Controls if scroll commands move point to keep its screen position unchanged.
7105 A value of nil means point does not keep its screen position except
7106 at the scroll margin or window boundary respectively.
7107 A value of t means point keeps its screen position if the scroll
7108 command moved it vertically out of the window, e.g. when scrolling
7109 by full screens.
7110 Any other value means point always keeps its screen position.
7111 Scroll commands should have the `scroll-command' property
7112 on their symbols to be controlled by this variable. */);
7113 Vscroll_preserve_screen_position = Qnil;
7115 DEFVAR_LISP ("window-point-insertion-type", Vwindow_point_insertion_type,
7116 doc: /* Type of marker to use for `window-point'. */);
7117 Vwindow_point_insertion_type = Qnil;
7119 DEFVAR_LISP ("window-configuration-change-hook",
7120 Vwindow_configuration_change_hook,
7121 doc: /* Functions to call when window configuration changes.
7122 The buffer-local part is run once per window, with the relevant window
7123 selected; while the global part is run only once for the modified frame,
7124 with the relevant frame selected. */);
7125 Vwindow_configuration_change_hook = Qnil;
7127 DEFVAR_LISP ("recenter-redisplay", Vrecenter_redisplay,
7128 doc: /* If non-nil, then the `recenter' command with a nil argument
7129 will redraw the entire frame; the special value `tty' causes the
7130 frame to be redrawn only if it is a tty frame. */);
7131 Vrecenter_redisplay = Qtty;
7134 defsubr (&Sselected_window);
7135 defsubr (&Sminibuffer_window);
7136 defsubr (&Swindow_minibuffer_p);
7137 defsubr (&Swindowp);
7138 defsubr (&Swindow_live_p);
7139 defsubr (&Spos_visible_in_window_p);
7140 defsubr (&Swindow_line_height);
7141 defsubr (&Swindow_buffer);
7142 defsubr (&Swindow_height);
7143 defsubr (&Swindow_width);
7144 defsubr (&Swindow_full_width_p);
7145 defsubr (&Swindow_hscroll);
7146 defsubr (&Sset_window_hscroll);
7147 defsubr (&Swindow_redisplay_end_trigger);
7148 defsubr (&Sset_window_redisplay_end_trigger);
7149 defsubr (&Swindow_edges);
7150 defsubr (&Swindow_pixel_edges);
7151 defsubr (&Swindow_absolute_pixel_edges);
7152 defsubr (&Swindow_inside_edges);
7153 defsubr (&Swindow_inside_pixel_edges);
7154 defsubr (&Swindow_inside_absolute_pixel_edges);
7155 defsubr (&Scoordinates_in_window_p);
7156 defsubr (&Swindow_at);
7157 defsubr (&Swindow_point);
7158 defsubr (&Swindow_start);
7159 defsubr (&Swindow_end);
7160 defsubr (&Sset_window_point);
7161 defsubr (&Sset_window_start);
7162 defsubr (&Swindow_dedicated_p);
7163 defsubr (&Sset_window_dedicated_p);
7164 defsubr (&Swindow_display_table);
7165 defsubr (&Sset_window_display_table);
7166 defsubr (&Snext_window);
7167 defsubr (&Sprevious_window);
7168 defsubr (&Sother_window);
7169 defsubr (&Sget_lru_window);
7170 defsubr (&Swindow_use_time);
7171 defsubr (&Sget_largest_window);
7172 defsubr (&Sget_buffer_window);
7173 defsubr (&Sdelete_other_windows);
7174 defsubr (&Sdelete_windows_on);
7175 defsubr (&Sreplace_buffer_in_windows);
7176 defsubr (&Sdelete_window);
7177 defsubr (&Sset_window_buffer);
7178 defsubr (&Sselect_window);
7179 defsubr (&Sforce_window_update);
7180 defsubr (&Ssplit_window);
7181 defsubr (&Senlarge_window);
7182 defsubr (&Sshrink_window);
7183 defsubr (&Sadjust_window_trailing_edge);
7184 defsubr (&Sscroll_up);
7185 defsubr (&Sscroll_down);
7186 defsubr (&Sscroll_left);
7187 defsubr (&Sscroll_right);
7188 defsubr (&Sother_window_for_scrolling);
7189 defsubr (&Sscroll_other_window);
7190 defsubr (&Sminibuffer_selected_window);
7191 defsubr (&Srecenter);
7192 defsubr (&Swindow_text_height);
7193 defsubr (&Smove_to_window_line);
7194 defsubr (&Swindow_configuration_p);
7195 defsubr (&Swindow_configuration_frame);
7196 defsubr (&Sset_window_configuration);
7197 defsubr (&Scurrent_window_configuration);
7198 defsubr (&Ssave_window_excursion);
7199 defsubr (&Swindow_tree);
7200 defsubr (&Sset_window_margins);
7201 defsubr (&Swindow_margins);
7202 defsubr (&Sset_window_fringes);
7203 defsubr (&Swindow_fringes);
7204 defsubr (&Sset_window_scroll_bars);
7205 defsubr (&Swindow_scroll_bars);
7206 defsubr (&Swindow_vscroll);
7207 defsubr (&Sset_window_vscroll);
7208 defsubr (&Scompare_window_configurations);
7209 defsubr (&Swindow_list);
7210 defsubr (&Swindow_parameters);
7211 defsubr (&Swindow_parameter);
7212 defsubr (&Sset_window_parameter);
7216 void
7217 keys_of_window (void)
7219 initial_define_key (control_x_map, '1', "delete-other-windows");
7220 initial_define_key (control_x_map, '2', "split-window");
7221 initial_define_key (control_x_map, '0', "delete-window");
7222 initial_define_key (control_x_map, 'o', "other-window");
7223 initial_define_key (control_x_map, '^', "enlarge-window");
7224 initial_define_key (control_x_map, '<', "scroll-left");
7225 initial_define_key (control_x_map, '>', "scroll-right");
7227 initial_define_key (global_map, Ctl ('V'), "scroll-up-command");
7228 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
7229 initial_define_key (meta_map, 'v', "scroll-down-command");