Merge from emacs-23
[emacs.git] / src / window.c
blob2feaa2755172a44cabab25a0df6b7f837da62a21
1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 2000,
4 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
5 Free Software Foundation, Inc.
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <stdio.h>
24 #include <setjmp.h>
26 #include "lisp.h"
27 #include "buffer.h"
28 #include "keyboard.h"
29 #include "keymap.h"
30 #include "frame.h"
31 #include "window.h"
32 #include "commands.h"
33 #include "indent.h"
34 #include "termchar.h"
35 #include "disptab.h"
36 #include "dispextern.h"
37 #include "blockinput.h"
38 #include "intervals.h"
39 #include "termhooks.h" /* For FRAME_TERMINAL. */
41 #ifdef HAVE_X_WINDOWS
42 #include "xterm.h"
43 #endif /* HAVE_X_WINDOWS */
44 #ifdef WINDOWSNT
45 #include "w32term.h"
46 #endif
47 #ifdef MSDOS
48 #include "msdos.h"
49 #endif
50 #ifdef HAVE_NS
51 #include "nsterm.h"
52 #endif
54 Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
55 Lisp_Object Qdisplay_buffer;
56 Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
57 Lisp_Object Qwindow_size_fixed;
59 static int displayed_window_lines (struct window *);
60 static struct window *decode_window (Lisp_Object);
61 static int count_windows (struct window *);
62 static int get_leaf_windows (struct window *, struct window **, int);
63 static void window_scroll (Lisp_Object, int, int, int);
64 static void window_scroll_pixel_based (Lisp_Object, int, int, int);
65 static void window_scroll_line_based (Lisp_Object, int, int, int);
66 static int window_min_size_1 (struct window *, int, int);
67 static int window_min_size_2 (struct window *, int, int);
68 static int window_min_size (struct window *, int, int, int, int *);
69 static void size_window (Lisp_Object, int, int, int, int, int);
70 static int freeze_window_start (struct window *, void *);
71 static int window_fixed_size_p (struct window *, int, int);
72 static void enlarge_window (Lisp_Object, int, int);
73 static Lisp_Object window_list (void);
74 static int add_window_to_list (struct window *, void *);
75 static int candidate_window_p (Lisp_Object, Lisp_Object, Lisp_Object,
76 Lisp_Object);
77 static Lisp_Object next_window (Lisp_Object, Lisp_Object,
78 Lisp_Object, int);
79 static void decode_next_window_args (Lisp_Object *, Lisp_Object *,
80 Lisp_Object *);
81 static void foreach_window (struct frame *,
82 int (* fn) (struct window *, void *),
83 void *);
84 static int foreach_window_1 (struct window *,
85 int (* fn) (struct window *, void *),
86 void *);
87 static Lisp_Object window_list_1 (Lisp_Object, Lisp_Object, Lisp_Object);
88 static Lisp_Object select_window (Lisp_Object, Lisp_Object, int);
90 /* This is the window in which the terminal's cursor should
91 be left when nothing is being done with it. This must
92 always be a leaf window, and its buffer is selected by
93 the top level editing loop at the end of each command.
95 This value is always the same as
96 FRAME_SELECTED_WINDOW (selected_frame). */
98 Lisp_Object selected_window;
100 /* A list of all windows for use by next_window and Fwindow_list.
101 Functions creating or deleting windows should invalidate this cache
102 by setting it to nil. */
104 Lisp_Object Vwindow_list;
106 /* The mini-buffer window of the selected frame.
107 Note that you cannot test for mini-bufferness of an arbitrary window
108 by comparing against this; but you can test for mini-bufferness of
109 the selected window. */
111 Lisp_Object minibuf_window;
113 /* Non-nil means it is the window whose mode line should be
114 shown as the selected window when the minibuffer is selected. */
116 Lisp_Object minibuf_selected_window;
118 /* Hook run at end of temp_output_buffer_show. */
120 Lisp_Object Qtemp_buffer_show_hook;
122 /* Incremented for each window created. */
124 static int sequence_number;
126 /* Nonzero after init_window_once has finished. */
128 static int window_initialized;
130 /* Hook to run when window config changes. */
132 static Lisp_Object Qwindow_configuration_change_hook;
133 /* Incremented by 1 whenever a window is deleted. */
135 int window_deletion_count;
137 /* Used by the function window_scroll_pixel_based */
139 static int window_scroll_pixel_based_preserve_x;
140 static int window_scroll_pixel_based_preserve_y;
142 /* Same for window_scroll_line_based. */
144 static int window_scroll_preserve_hpos;
145 static int window_scroll_preserve_vpos;
147 #if 0 /* This isn't used anywhere. */
148 /* Nonzero means we can split a frame even if it is "unsplittable". */
149 static int inhibit_frame_unsplittable;
150 #endif
153 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
154 doc: /* Return t if OBJECT is a window. */)
155 (Lisp_Object object)
157 return WINDOWP (object) ? Qt : Qnil;
160 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
161 doc: /* Return t if OBJECT is a window which is currently visible. */)
162 (Lisp_Object object)
164 return WINDOW_LIVE_P (object) ? Qt : Qnil;
167 Lisp_Object
168 make_window (void)
170 Lisp_Object val;
171 register struct window *p;
173 p = allocate_window ();
174 ++sequence_number;
175 XSETFASTINT (p->sequence_number, sequence_number);
176 XSETFASTINT (p->left_col, 0);
177 XSETFASTINT (p->top_line, 0);
178 XSETFASTINT (p->total_lines, 0);
179 XSETFASTINT (p->total_cols, 0);
180 XSETFASTINT (p->hscroll, 0);
181 XSETFASTINT (p->min_hscroll, 0);
182 p->orig_top_line = p->orig_total_lines = Qnil;
183 p->start = Fmake_marker ();
184 p->pointm = Fmake_marker ();
185 XSETFASTINT (p->use_time, 0);
186 p->frame = Qnil;
187 p->display_table = Qnil;
188 p->dedicated = Qnil;
189 p->window_parameters = Qnil;
190 p->pseudo_window_p = 0;
191 memset (&p->cursor, 0, sizeof (p->cursor));
192 memset (&p->last_cursor, 0, sizeof (p->last_cursor));
193 memset (&p->phys_cursor, 0, sizeof (p->phys_cursor));
194 p->desired_matrix = p->current_matrix = 0;
195 p->nrows_scale_factor = p->ncols_scale_factor = 1;
196 p->phys_cursor_type = -1;
197 p->phys_cursor_width = -1;
198 p->must_be_updated_p = 0;
199 XSETFASTINT (p->window_end_vpos, 0);
200 XSETFASTINT (p->window_end_pos, 0);
201 p->window_end_valid = Qnil;
202 p->vscroll = 0;
203 XSETWINDOW (val, p);
204 XSETFASTINT (p->last_point, 0);
205 p->frozen_window_start_p = 0;
206 p->last_cursor_off_p = p->cursor_off_p = 0;
207 p->left_margin_cols = Qnil;
208 p->right_margin_cols = Qnil;
209 p->left_fringe_width = Qnil;
210 p->right_fringe_width = Qnil;
211 p->fringes_outside_margins = Qnil;
212 p->scroll_bar_width = Qnil;
213 p->vertical_scroll_bar_type = Qt;
214 p->resize_proportionally = Qnil;
216 Vwindow_list = Qnil;
217 return val;
220 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
221 doc: /* Return the window that the cursor now appears in and commands apply to. */)
222 (void)
224 return selected_window;
227 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
228 doc: /* Return the window used now for minibuffers.
229 If the optional argument FRAME is specified, return the minibuffer window
230 used by that frame. */)
231 (Lisp_Object frame)
233 if (NILP (frame))
234 frame = selected_frame;
235 CHECK_LIVE_FRAME (frame);
236 return FRAME_MINIBUF_WINDOW (XFRAME (frame));
239 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
240 doc: /* Return non-nil if WINDOW is a minibuffer window.
241 WINDOW defaults to the selected window. */)
242 (Lisp_Object window)
244 struct window *w = decode_window (window);
245 return MINI_WINDOW_P (w) ? Qt : Qnil;
249 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
250 Spos_visible_in_window_p, 0, 3, 0,
251 doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
252 Return nil if that position is scrolled vertically out of view.
253 If a character is only partially visible, nil is returned, unless the
254 optional argument PARTIALLY is non-nil.
255 If POS is only out of view because of horizontal scrolling, return non-nil.
256 If POS is t, it specifies the position of the last visible glyph in WINDOW.
257 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
259 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
260 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
261 where X and Y are the pixel coordinates relative to the top left corner
262 of the window. The remaining elements are omitted if the character after
263 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
264 off-window at the top and bottom of the row, ROWH is the height of the
265 display row, and VPOS is the row number (0-based) containing POS. */)
266 (Lisp_Object pos, Lisp_Object window, Lisp_Object partially)
268 register struct window *w;
269 register EMACS_INT posint;
270 register struct buffer *buf;
271 struct text_pos top;
272 Lisp_Object in_window = Qnil;
273 int rtop, rbot, rowh, vpos, fully_p = 1;
274 int x, y;
276 w = decode_window (window);
277 buf = XBUFFER (w->buffer);
278 SET_TEXT_POS_FROM_MARKER (top, w->start);
280 if (EQ (pos, Qt))
281 posint = -1;
282 else if (!NILP (pos))
284 CHECK_NUMBER_COERCE_MARKER (pos);
285 posint = XINT (pos);
287 else if (w == XWINDOW (selected_window))
288 posint = PT;
289 else
290 posint = XMARKER (w->pointm)->charpos;
292 /* If position is above window start or outside buffer boundaries,
293 or if window start is out of range, position is not visible. */
294 if ((EQ (pos, Qt)
295 || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
296 && CHARPOS (top) >= BUF_BEGV (buf)
297 && CHARPOS (top) <= BUF_ZV (buf)
298 && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
299 && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
300 in_window = Qt;
302 if (!NILP (in_window) && !NILP (partially))
304 Lisp_Object part = Qnil;
305 if (!fully_p)
306 part = list4 (make_number (rtop), make_number (rbot),
307 make_number (rowh), make_number (vpos));
308 in_window = Fcons (make_number (x),
309 Fcons (make_number (y), part));
312 return in_window;
315 DEFUN ("window-line-height", Fwindow_line_height,
316 Swindow_line_height, 0, 2, 0,
317 doc: /* Return height in pixels of text line LINE in window WINDOW.
318 If WINDOW is nil or omitted, use selected window.
320 Return height of current line if LINE is omitted or nil. Return height of
321 header or mode line if LINE is `header-line' and `mode-line'.
322 Otherwise, LINE is a text line number starting from 0. A negative number
323 counts from the end of the window.
325 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
326 in pixels of the visible part of the line, VPOS and YPOS are the
327 vertical position in lines and pixels of the line, relative to the top
328 of the first text line, and OFFBOT is the number of off-window pixels at
329 the bottom of the text line. If there are off-window pixels at the top
330 of the (first) text line, YPOS is negative.
332 Return nil if window display is not up-to-date. In that case, use
333 `pos-visible-in-window-p' to obtain the information. */)
334 (Lisp_Object line, Lisp_Object window)
336 register struct window *w;
337 register struct buffer *b;
338 struct glyph_row *row, *end_row;
339 int max_y, crop, i, n;
341 w = decode_window (window);
343 if (noninteractive
344 || w->pseudo_window_p)
345 return Qnil;
347 CHECK_BUFFER (w->buffer);
348 b = XBUFFER (w->buffer);
350 /* Fail if current matrix is not up-to-date. */
351 if (NILP (w->window_end_valid)
352 || current_buffer->clip_changed
353 || current_buffer->prevent_redisplay_optimizations_p
354 || XFASTINT (w->last_modified) < BUF_MODIFF (b)
355 || XFASTINT (w->last_overlay_modified) < BUF_OVERLAY_MODIFF (b))
356 return Qnil;
358 if (NILP (line))
360 i = w->cursor.vpos;
361 if (i < 0 || i >= w->current_matrix->nrows
362 || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
363 return Qnil;
364 max_y = window_text_bottom_y (w);
365 goto found_row;
368 if (EQ (line, Qheader_line))
370 if (!WINDOW_WANTS_HEADER_LINE_P (w))
371 return Qnil;
372 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
373 if (!row->enabled_p)
374 return Qnil;
375 return list4 (make_number (row->height),
376 make_number (0), make_number (0),
377 make_number (0));
380 if (EQ (line, Qmode_line))
382 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
383 if (!row->enabled_p)
384 return Qnil;
385 return list4 (make_number (row->height),
386 make_number (0), /* not accurate */
387 make_number (WINDOW_HEADER_LINE_HEIGHT (w)
388 + window_text_bottom_y (w)),
389 make_number (0));
392 CHECK_NUMBER (line);
393 n = XINT (line);
395 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
396 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
397 max_y = window_text_bottom_y (w);
398 i = 0;
400 while ((n < 0 || i < n)
401 && row <= end_row && row->enabled_p
402 && row->y + row->height < max_y)
403 row++, i++;
405 if (row > end_row || !row->enabled_p)
406 return Qnil;
408 if (++n < 0)
410 if (-n > i)
411 return Qnil;
412 row += n;
413 i += n;
416 found_row:
417 crop = max (0, (row->y + row->height) - max_y);
418 return list4 (make_number (row->height + min (0, row->y) - crop),
419 make_number (i),
420 make_number (row->y),
421 make_number (crop));
426 static struct window *
427 decode_window (register Lisp_Object window)
429 if (NILP (window))
430 return XWINDOW (selected_window);
432 CHECK_LIVE_WINDOW (window);
433 return XWINDOW (window);
436 static struct window *
437 decode_any_window (register Lisp_Object window)
439 if (NILP (window))
440 return XWINDOW (selected_window);
442 CHECK_WINDOW (window);
443 return XWINDOW (window);
446 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
447 doc: /* Return the buffer that WINDOW is displaying.
448 WINDOW defaults to the selected window. */)
449 (Lisp_Object window)
451 return decode_window (window)->buffer;
454 DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
455 doc: /* Return the number of lines in WINDOW.
456 WINDOW defaults to the selected window.
458 The return value includes WINDOW's mode line and header line, if any.
460 Note: The function does not take into account the value of `line-spacing'
461 when calculating the number of lines in WINDOW. */)
462 (Lisp_Object window)
464 return decode_any_window (window)->total_lines;
467 DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
468 doc: /* Return the number of display columns in WINDOW.
469 WINDOW defaults to the selected window.
471 Note: The return value is the number of columns available for text in
472 WINDOW. If you want to find out how many columns WINDOW takes up, use
473 (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))). */)
474 (Lisp_Object window)
476 return make_number (window_box_text_cols (decode_any_window (window)));
479 DEFUN ("window-full-width-p", Fwindow_full_width_p, Swindow_full_width_p, 0, 1, 0,
480 doc: /* Return t if WINDOW is as wide as its frame.
481 WINDOW defaults to the selected window. */)
482 (Lisp_Object window)
484 return WINDOW_FULL_WIDTH_P (decode_any_window (window)) ? Qt : Qnil;
487 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
488 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
489 WINDOW defaults to the selected window. */)
490 (Lisp_Object window)
492 return decode_window (window)->hscroll;
495 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
496 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
497 Return NCOL. NCOL should be zero or positive.
499 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
500 window so that the location of point moves off-window. */)
501 (Lisp_Object window, Lisp_Object ncol)
503 struct window *w = decode_window (window);
504 int hscroll;
506 CHECK_NUMBER (ncol);
507 hscroll = max (0, XINT (ncol));
509 /* Prevent redisplay shortcuts when changing the hscroll. */
510 if (XINT (w->hscroll) != hscroll)
511 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
513 w->hscroll = make_number (hscroll);
514 return ncol;
517 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
518 Swindow_redisplay_end_trigger, 0, 1, 0,
519 doc: /* Return WINDOW's redisplay end trigger value.
520 WINDOW defaults to the selected window.
521 See `set-window-redisplay-end-trigger' for more information. */)
522 (Lisp_Object window)
524 return decode_window (window)->redisplay_end_trigger;
527 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
528 Sset_window_redisplay_end_trigger, 2, 2, 0,
529 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
530 VALUE should be a buffer position (typically a marker) or nil.
531 If it is a buffer position, then if redisplay in WINDOW reaches a position
532 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
533 with two arguments: WINDOW, and the end trigger value.
534 Afterwards the end-trigger value is reset to nil. */)
535 (register Lisp_Object window, Lisp_Object value)
537 register struct window *w;
539 w = decode_window (window);
540 w->redisplay_end_trigger = value;
541 return value;
544 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
545 doc: /* Return a list of the edge coordinates of WINDOW.
546 The list has the form (LEFT TOP RIGHT BOTTOM).
547 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
548 all relative to 0, 0 at top left corner of frame.
550 RIGHT is one more than the rightmost column occupied by WINDOW.
551 BOTTOM is one more than the bottommost row occupied by WINDOW.
552 The edges include the space used by WINDOW's scroll bar, display
553 margins, fringes, header line, and/or mode line. For the edges of
554 just the text area, use `window-inside-edges'. */)
555 (Lisp_Object window)
557 register struct window *w = decode_any_window (window);
559 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
560 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
561 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
562 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
563 Qnil))));
566 DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
567 doc: /* Return a list of the edge pixel coordinates of WINDOW.
568 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
569 the top left corner of the frame.
571 RIGHT is one more than the rightmost x position occupied by WINDOW.
572 BOTTOM is one more than the bottommost y position occupied by WINDOW.
573 The pixel edges include the space used by WINDOW's scroll bar, display
574 margins, fringes, header line, and/or mode line. For the pixel edges
575 of just the text area, use `window-inside-pixel-edges'. */)
576 (Lisp_Object window)
578 register struct window *w = decode_any_window (window);
580 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
581 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
582 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
583 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
584 Qnil))));
587 static void
588 calc_absolute_offset(struct window *w, int *add_x, int *add_y)
590 struct frame *f = XFRAME (w->frame);
591 *add_y = f->top_pos;
592 #ifdef FRAME_MENUBAR_HEIGHT
593 *add_y += FRAME_MENUBAR_HEIGHT (f);
594 #endif
595 #ifdef FRAME_TOOLBAR_TOP_HEIGHT
596 *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
597 #elif FRAME_TOOLBAR_HEIGHT
598 *add_y += FRAME_TOOLBAR_HEIGHT (f);
599 #endif
600 #ifdef FRAME_NS_TITLEBAR_HEIGHT
601 *add_y += FRAME_NS_TITLEBAR_HEIGHT (f);
602 #endif
603 *add_x = f->left_pos;
604 #ifdef FRAME_TOOLBAR_LEFT_WIDTH
605 *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
606 #endif
609 DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges,
610 Swindow_absolute_pixel_edges, 0, 1, 0,
611 doc: /* Return a list of the edge pixel coordinates of WINDOW.
612 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
613 the top left corner of the display.
615 RIGHT is one more than the rightmost x position occupied by WINDOW.
616 BOTTOM is one more than the bottommost y position occupied by WINDOW.
617 The pixel edges include the space used by WINDOW's scroll bar, display
618 margins, fringes, header line, and/or mode line. For the pixel edges
619 of just the text area, use `window-inside-absolute-pixel-edges'. */)
620 (Lisp_Object window)
622 register struct window *w = decode_any_window (window);
623 int add_x, add_y;
624 calc_absolute_offset (w, &add_x, &add_y);
626 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w) + add_x),
627 Fcons (make_number (WINDOW_TOP_EDGE_Y (w) + add_y),
628 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w) + add_x),
629 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w) + add_y),
630 Qnil))));
633 DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
634 doc: /* Return a list of the edge coordinates of WINDOW.
635 The list has the form (LEFT TOP RIGHT BOTTOM).
636 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
637 all relative to 0, 0 at top left corner of frame.
639 RIGHT is one more than the rightmost column of WINDOW's text area.
640 BOTTOM is one more than the bottommost row of WINDOW's text area.
641 The inside edges do not include the space used by the WINDOW's scroll
642 bar, display margins, fringes, header line, and/or mode line. */)
643 (Lisp_Object window)
645 register struct window *w = decode_any_window (window);
647 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
648 + WINDOW_LEFT_MARGIN_COLS (w)
649 + WINDOW_LEFT_FRINGE_COLS (w)),
650 make_number (WINDOW_TOP_EDGE_LINE (w)
651 + WINDOW_HEADER_LINE_LINES (w)),
652 make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
653 - WINDOW_RIGHT_MARGIN_COLS (w)
654 - WINDOW_RIGHT_FRINGE_COLS (w)),
655 make_number (WINDOW_BOTTOM_EDGE_LINE (w)
656 - WINDOW_MODE_LINE_LINES (w)));
659 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
660 doc: /* Return a list of the edge pixel coordinates of WINDOW.
661 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
662 the top left corner of the frame.
664 RIGHT is one more than the rightmost x position of WINDOW's text area.
665 BOTTOM is one more than the bottommost y position of WINDOW's text area.
666 The inside edges do not include the space used by WINDOW's scroll bar,
667 display margins, fringes, header line, and/or mode line. */)
668 (Lisp_Object window)
670 register struct window *w = decode_any_window (window);
672 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
673 + WINDOW_LEFT_MARGIN_WIDTH (w)
674 + WINDOW_LEFT_FRINGE_WIDTH (w)),
675 make_number (WINDOW_TOP_EDGE_Y (w)
676 + WINDOW_HEADER_LINE_HEIGHT (w)),
677 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
678 - WINDOW_RIGHT_MARGIN_WIDTH (w)
679 - WINDOW_RIGHT_FRINGE_WIDTH (w)),
680 make_number (WINDOW_BOTTOM_EDGE_Y (w)
681 - WINDOW_MODE_LINE_HEIGHT (w)));
684 DEFUN ("window-inside-absolute-pixel-edges",
685 Fwindow_inside_absolute_pixel_edges,
686 Swindow_inside_absolute_pixel_edges, 0, 1, 0,
687 doc: /* Return a list of the edge pixel coordinates of WINDOW.
688 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
689 the top left corner of the display.
691 RIGHT is one more than the rightmost x position of WINDOW's text area.
692 BOTTOM is one more than the bottommost y position of WINDOW's text area.
693 The inside edges do not include the space used by WINDOW's scroll bar,
694 display margins, fringes, header line, and/or mode line. */)
695 (Lisp_Object window)
697 register struct window *w = decode_any_window (window);
698 int add_x, add_y;
699 calc_absolute_offset (w, &add_x, &add_y);
701 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
702 + WINDOW_LEFT_MARGIN_WIDTH (w)
703 + WINDOW_LEFT_FRINGE_WIDTH (w) + add_x),
704 make_number (WINDOW_TOP_EDGE_Y (w)
705 + WINDOW_HEADER_LINE_HEIGHT (w) + add_y),
706 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
707 - WINDOW_RIGHT_MARGIN_WIDTH (w)
708 - WINDOW_RIGHT_FRINGE_WIDTH (w) + add_x),
709 make_number (WINDOW_BOTTOM_EDGE_Y (w)
710 - WINDOW_MODE_LINE_HEIGHT (w) + add_y));
713 /* Test if the character at column X, row Y is within window W.
714 If it is not, return ON_NOTHING;
715 if it is in the window's text area, return ON_TEXT;
716 if it is on the window's modeline, return ON_MODE_LINE;
717 if it is on the border between the window and its right sibling,
718 return ON_VERTICAL_BORDER.
719 if it is on a scroll bar, return ON_SCROLL_BAR.
720 if it is on the window's top line, return ON_HEADER_LINE;
721 if it is in left or right fringe of the window,
722 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
723 if it is in the marginal area to the left/right of the window,
724 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
726 X and Y are frame relative pixel coordinates. */
728 static enum window_part
729 coordinates_in_window (register struct window *w, int x, int y)
731 struct frame *f = XFRAME (WINDOW_FRAME (w));
732 int left_x, right_x;
733 enum window_part part;
734 int ux = FRAME_COLUMN_WIDTH (f);
735 int x0 = WINDOW_LEFT_EDGE_X (w);
736 int x1 = WINDOW_RIGHT_EDGE_X (w);
737 /* The width of the area where the vertical line can be dragged.
738 (Between mode lines for instance. */
739 int grabbable_width = ux;
740 int lmargin_width, rmargin_width, text_left, text_right;
741 int top_y = WINDOW_TOP_EDGE_Y (w);
742 int bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
744 /* Outside any interesting row? */
745 if (y < top_y || y >= bottom_y)
746 return ON_NOTHING;
748 /* In what's below, we subtract 1 when computing right_x because we
749 want the rightmost pixel, which is given by left_pixel+width-1. */
750 if (w->pseudo_window_p)
752 left_x = 0;
753 right_x = WINDOW_TOTAL_WIDTH (w) - 1;
755 else
757 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
758 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
761 /* On the mode line or header line? If it's near the start of
762 the mode or header line of window that's has a horizontal
763 sibling, say it's on the vertical line. That's to be able
764 to resize windows horizontally in case we're using toolkit
765 scroll bars. */
767 if (WINDOW_WANTS_MODELINE_P (w)
768 && y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
770 part = ON_MODE_LINE;
772 header_vertical_border_check:
773 /* We're somewhere on the mode line. We consider the place
774 between mode lines of horizontally adjacent mode lines
775 as the vertical border. If scroll bars on the left,
776 return the right window. */
777 if ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
778 || WINDOW_RIGHTMOST_P (w))
779 && !WINDOW_LEFTMOST_P (w)
780 && eabs (x - x0) < grabbable_width)
781 return ON_VERTICAL_BORDER;
783 /* Make sure we're not at the rightmost position of a
784 mode-/header-line and there's yet another window on the
785 right. (Bug#1372) */
786 else if ((WINDOW_RIGHTMOST_P (w) || x < x1)
787 && eabs (x - x1) < grabbable_width)
788 return ON_VERTICAL_BORDER;
790 if (x < x0 || x >= x1)
791 return ON_NOTHING;
793 return part;
796 if (WINDOW_WANTS_HEADER_LINE_P (w)
797 && y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
799 part = ON_HEADER_LINE;
800 goto header_vertical_border_check;
803 if (x < x0 || x >= x1) return ON_NOTHING;
805 /* Outside any interesting column? */
806 if (x < left_x || x > right_x)
807 return ON_SCROLL_BAR;
809 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
810 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
812 text_left = window_box_left (w, TEXT_AREA);
813 text_right = text_left + window_box_width (w, TEXT_AREA);
815 if (FRAME_WINDOW_P (f))
817 if (!w->pseudo_window_p
818 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
819 && !WINDOW_RIGHTMOST_P (w)
820 && (eabs (x - right_x) < grabbable_width))
821 return ON_VERTICAL_BORDER;
823 /* Need to say "x > right_x" rather than >=, since on character
824 terminals, the vertical line's x coordinate is right_x. */
825 else if (!w->pseudo_window_p
826 && !WINDOW_RIGHTMOST_P (w)
827 && x > right_x - ux)
828 return ON_VERTICAL_BORDER;
830 if (x < text_left)
832 if (lmargin_width > 0
833 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
834 ? (x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
835 : (x < left_x + lmargin_width)))
836 return ON_LEFT_MARGIN;
838 return ON_LEFT_FRINGE;
841 if (x >= text_right)
843 if (rmargin_width > 0
844 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
845 ? (x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
846 : (x >= right_x - rmargin_width)))
847 return ON_RIGHT_MARGIN;
849 return ON_RIGHT_FRINGE;
852 /* Everything special ruled out - must be on text area */
853 return ON_TEXT;
856 /* Take X is the frame-relative pixel x-coordinate, and return the
857 x-coordinate relative to part PART of window W. */
859 window_relative_x_coord (struct window *w, enum window_part part, int x)
861 int left_x = (w->pseudo_window_p) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w);
863 switch (part)
865 case ON_TEXT:
866 return x - window_box_left (w, TEXT_AREA);
868 case ON_LEFT_FRINGE:
869 return x - left_x;
871 case ON_RIGHT_FRINGE:
872 return x - left_x - WINDOW_LEFT_FRINGE_WIDTH (w);
874 case ON_LEFT_MARGIN:
875 return (x - left_x
876 - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
877 ? WINDOW_LEFT_FRINGE_WIDTH (w) : 0));
879 case ON_RIGHT_MARGIN:
880 return (x + 1
881 - ((w->pseudo_window_p)
882 ? WINDOW_TOTAL_WIDTH (w)
883 : WINDOW_BOX_RIGHT_EDGE_X (w))
884 + window_box_width (w, RIGHT_MARGIN_AREA)
885 + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
886 ? WINDOW_RIGHT_FRINGE_WIDTH (w) : 0));
889 /* ON_SCROLL_BAR, ON_NOTHING, and ON_VERTICAL_BORDER: */
890 return 0;
894 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
895 Scoordinates_in_window_p, 2, 2, 0,
896 doc: /* Return non-nil if COORDINATES are in WINDOW.
897 COORDINATES is a cons of the form (X . Y), X and Y being distances
898 measured in characters from the upper-left corner of the frame.
899 \(0 . 0) denotes the character in the upper left corner of the
900 frame.
901 If COORDINATES are in the text portion of WINDOW,
902 the coordinates relative to the window are returned.
903 If they are in the mode line of WINDOW, `mode-line' is returned.
904 If they are in the top mode line of WINDOW, `header-line' is returned.
905 If they are in the left fringe of WINDOW, `left-fringe' is returned.
906 If they are in the right fringe of WINDOW, `right-fringe' is returned.
907 If they are on the border between WINDOW and its right sibling,
908 `vertical-line' is returned.
909 If they are in the windows's left or right marginal areas, `left-margin'\n\
910 or `right-margin' is returned. */)
911 (register Lisp_Object coordinates, Lisp_Object window)
913 struct window *w;
914 struct frame *f;
915 int x, y;
916 Lisp_Object lx, ly;
918 CHECK_WINDOW (window);
919 w = XWINDOW (window);
920 f = XFRAME (w->frame);
921 CHECK_CONS (coordinates);
922 lx = Fcar (coordinates);
923 ly = Fcdr (coordinates);
924 CHECK_NUMBER_OR_FLOAT (lx);
925 CHECK_NUMBER_OR_FLOAT (ly);
926 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
927 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
929 switch (coordinates_in_window (w, x, y))
931 case ON_NOTHING:
932 return Qnil;
934 case ON_TEXT:
935 /* Convert X and Y to window relative pixel coordinates, and
936 return the canonical char units. */
937 x -= window_box_left (w, TEXT_AREA);
938 y -= WINDOW_TOP_EDGE_Y (w);
939 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
940 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
942 case ON_MODE_LINE:
943 return Qmode_line;
945 case ON_VERTICAL_BORDER:
946 return Qvertical_line;
948 case ON_HEADER_LINE:
949 return Qheader_line;
951 case ON_LEFT_FRINGE:
952 return Qleft_fringe;
954 case ON_RIGHT_FRINGE:
955 return Qright_fringe;
957 case ON_LEFT_MARGIN:
958 return Qleft_margin;
960 case ON_RIGHT_MARGIN:
961 return Qright_margin;
963 case ON_SCROLL_BAR:
964 /* Historically we are supposed to return nil in this case. */
965 return Qnil;
967 default:
968 abort ();
973 /* Callback for foreach_window, used in window_from_coordinates.
974 Check if window W contains coordinates specified by USER_DATA which
975 is actually a pointer to a struct check_window_data CW.
977 Check if window W contains coordinates *CW->x and *CW->y. If it
978 does, return W in *CW->window, as Lisp_Object, and return in
979 *CW->part the part of the window under coordinates *X,*Y. Return
980 zero from this function to stop iterating over windows. */
982 struct check_window_data
984 Lisp_Object *window;
985 int x, y;
986 enum window_part *part;
989 static int
990 check_window_containing (struct window *w, void *user_data)
992 struct check_window_data *cw = (struct check_window_data *) user_data;
993 enum window_part found;
994 int continue_p = 1;
996 found = coordinates_in_window (w, cw->x, cw->y);
997 if (found != ON_NOTHING)
999 *cw->part = found;
1000 XSETWINDOW (*cw->window, w);
1001 continue_p = 0;
1004 return continue_p;
1008 /* Find the window containing frame-relative pixel position X/Y and
1009 return it as a Lisp_Object.
1011 If X, Y is on one of the window's special `window_part' elements,
1012 set *PART to the id of that element.
1014 If there is no window under X, Y return nil and leave *PART
1015 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1017 This function was previously implemented with a loop cycling over
1018 windows with Fnext_window, and starting with the frame's selected
1019 window. It turned out that this doesn't work with an
1020 implementation of next_window using Vwindow_list, because
1021 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1022 tree of F when this function is called asynchronously from
1023 note_mouse_highlight. The original loop didn't terminate in this
1024 case. */
1026 Lisp_Object
1027 window_from_coordinates (struct frame *f, int x, int y,
1028 enum window_part *part, int tool_bar_p)
1030 Lisp_Object window;
1031 struct check_window_data cw;
1032 enum window_part dummy;
1034 if (part == 0)
1035 part = &dummy;
1037 window = Qnil;
1038 cw.window = &window, cw.x = x, cw.y = y; cw.part = part;
1039 foreach_window (f, check_window_containing, &cw);
1041 /* If not found above, see if it's in the tool bar window, if a tool
1042 bar exists. */
1043 if (NILP (window)
1044 && tool_bar_p
1045 && WINDOWP (f->tool_bar_window)
1046 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1047 && (coordinates_in_window (XWINDOW (f->tool_bar_window), x, y)
1048 != ON_NOTHING))
1050 *part = ON_TEXT;
1051 window = f->tool_bar_window;
1054 return window;
1057 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1058 doc: /* Return window containing coordinates X and Y on FRAME.
1059 If omitted, FRAME defaults to the currently selected frame.
1060 The top left corner of the frame is considered to be row 0,
1061 column 0. */)
1062 (Lisp_Object x, Lisp_Object y, Lisp_Object frame)
1064 struct frame *f;
1066 if (NILP (frame))
1067 frame = selected_frame;
1068 CHECK_LIVE_FRAME (frame);
1069 f = XFRAME (frame);
1071 /* Check that arguments are integers or floats. */
1072 CHECK_NUMBER_OR_FLOAT (x);
1073 CHECK_NUMBER_OR_FLOAT (y);
1075 return window_from_coordinates (f,
1076 (FRAME_PIXEL_X_FROM_CANON_X (f, x)
1077 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1078 (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
1079 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1080 0, 0);
1083 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1084 doc: /* Return current value of point in WINDOW.
1085 WINDOW defaults to the selected window.
1087 For a nonselected window, this is the value point would have
1088 if that window were selected.
1090 Note that, when WINDOW is the selected window and its buffer
1091 is also currently selected, the value returned is the same as (point).
1092 It would be more strictly correct to return the `top-level' value
1093 of point, outside of any save-excursion forms.
1094 But that is hard to define. */)
1095 (Lisp_Object window)
1097 register struct window *w = decode_window (window);
1099 if (w == XWINDOW (selected_window)
1100 && current_buffer == XBUFFER (w->buffer))
1101 return Fpoint ();
1102 return Fmarker_position (w->pointm);
1105 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1106 doc: /* Return position at which display currently starts in WINDOW.
1107 WINDOW defaults to the selected window.
1108 This is updated by redisplay or by calling `set-window-start'. */)
1109 (Lisp_Object window)
1111 return Fmarker_position (decode_window (window)->start);
1114 /* This is text temporarily removed from the doc string below.
1116 This function returns nil if the position is not currently known.
1117 That happens when redisplay is preempted and doesn't finish.
1118 If in that case you want to compute where the end of the window would
1119 have been if redisplay had finished, do this:
1120 (save-excursion
1121 (goto-char (window-start window))
1122 (vertical-motion (1- (window-height window)) window)
1123 (point))") */
1125 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1126 doc: /* Return position at which display currently ends in WINDOW.
1127 WINDOW defaults to the selected window.
1128 This is updated by redisplay, when it runs to completion.
1129 Simply changing the buffer text or setting `window-start'
1130 does not update this value.
1131 Return nil if there is no recorded value. \(This can happen if the
1132 last redisplay of WINDOW was preempted, and did not finish.)
1133 If UPDATE is non-nil, compute the up-to-date position
1134 if it isn't already recorded. */)
1135 (Lisp_Object window, Lisp_Object update)
1137 Lisp_Object value;
1138 struct window *w = decode_window (window);
1139 Lisp_Object buf;
1140 struct buffer *b;
1142 buf = w->buffer;
1143 CHECK_BUFFER (buf);
1144 b = XBUFFER (buf);
1146 #if 0 /* This change broke some things. We should make it later. */
1147 /* If we don't know the end position, return nil.
1148 The user can compute it with vertical-motion if he wants to.
1149 It would be nicer to do it automatically,
1150 but that's so slow that it would probably bother people. */
1151 if (NILP (w->window_end_valid))
1152 return Qnil;
1153 #endif
1155 if (! NILP (update)
1156 && ! (! NILP (w->window_end_valid)
1157 && XFASTINT (w->last_modified) >= BUF_MODIFF (b)
1158 && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (b))
1159 && !noninteractive)
1161 struct text_pos startp;
1162 struct it it;
1163 struct buffer *old_buffer = NULL;
1165 /* Cannot use Fvertical_motion because that function doesn't
1166 cope with variable-height lines. */
1167 if (b != current_buffer)
1169 old_buffer = current_buffer;
1170 set_buffer_internal (b);
1173 /* In case W->start is out of the range, use something
1174 reasonable. This situation occurred when loading a file with
1175 `-l' containing a call to `rmail' with subsequent other
1176 commands. At the end, W->start happened to be BEG, while
1177 rmail had already narrowed the buffer. */
1178 if (XMARKER (w->start)->charpos < BEGV)
1179 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1180 else if (XMARKER (w->start)->charpos > ZV)
1181 SET_TEXT_POS (startp, ZV, ZV_BYTE);
1182 else
1183 SET_TEXT_POS_FROM_MARKER (startp, w->start);
1185 start_display (&it, w, startp);
1186 move_it_vertically (&it, window_box_height (w));
1187 if (it.current_y < it.last_visible_y)
1188 move_it_past_eol (&it);
1189 value = make_number (IT_CHARPOS (it));
1191 if (old_buffer)
1192 set_buffer_internal (old_buffer);
1194 else
1195 XSETINT (value, BUF_Z (b) - XFASTINT (w->window_end_pos));
1197 return value;
1200 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1201 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1202 Return POS. */)
1203 (Lisp_Object window, Lisp_Object pos)
1205 register struct window *w = decode_window (window);
1207 CHECK_NUMBER_COERCE_MARKER (pos);
1208 if (w == XWINDOW (selected_window)
1209 && XBUFFER (w->buffer) == current_buffer)
1210 Fgoto_char (pos);
1211 else
1212 set_marker_restricted (w->pointm, pos, w->buffer);
1214 /* We have to make sure that redisplay updates the window to show
1215 the new value of point. */
1216 if (!EQ (window, selected_window))
1217 ++windows_or_buffers_changed;
1219 return pos;
1222 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1223 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1224 WINDOW defaults to the selected window. Return POS.
1225 Optional third arg NOFORCE non-nil inhibits next redisplay from
1226 overriding motion of point in order to display at this exact start. */)
1227 (Lisp_Object window, Lisp_Object pos, Lisp_Object noforce)
1229 register struct window *w = decode_window (window);
1231 CHECK_NUMBER_COERCE_MARKER (pos);
1232 set_marker_restricted (w->start, pos, w->buffer);
1233 /* this is not right, but much easier than doing what is right. */
1234 w->start_at_line_beg = Qnil;
1235 if (NILP (noforce))
1236 w->force_start = Qt;
1237 w->update_mode_line = Qt;
1238 XSETFASTINT (w->last_modified, 0);
1239 XSETFASTINT (w->last_overlay_modified, 0);
1240 if (!EQ (window, selected_window))
1241 windows_or_buffers_changed++;
1243 return pos;
1247 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1248 0, 1, 0,
1249 doc: /* Return non-nil when WINDOW is dedicated to its buffer.
1250 More precisely, return the value assigned by the last call of
1251 `set-window-dedicated-p' for WINDOW. Return nil if that function was
1252 never called with WINDOW as its argument, or the value set by that
1253 function was internally reset since its last call. WINDOW defaults to
1254 the selected window.
1256 When a window is dedicated to its buffer, `display-buffer' will refrain
1257 from displaying another buffer in it. `get-lru-window' and
1258 `get-largest-window' treat dedicated windows specially.
1259 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1260 `kill-buffer' can delete a dedicated window and the containing frame.
1262 Functions like `set-window-buffer' may change the buffer displayed by a
1263 window, unless that window is "strongly" dedicated to its buffer, that
1264 is the value returned by `window-dedicated-p' is t. */)
1265 (Lisp_Object window)
1267 return decode_window (window)->dedicated;
1270 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1271 Sset_window_dedicated_p, 2, 2, 0,
1272 doc: /* Mark WINDOW as dedicated according to FLAG.
1273 WINDOW defaults to the selected window. FLAG non-nil means mark WINDOW
1274 as dedicated to its buffer. FLAG nil means mark WINDOW as non-dedicated.
1275 Return FLAG.
1277 When a window is dedicated to its buffer, `display-buffer' will refrain
1278 from displaying another buffer in it. `get-lru-window' and
1279 `get-largest-window' treat dedicated windows specially.
1280 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1281 `kill-buffer' can delete a dedicated window and the containing
1282 frame.
1284 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
1285 its buffer. Functions like `set-window-buffer' may change the buffer
1286 displayed by a window, unless that window is strongly dedicated to its
1287 buffer. If and when `set-window-buffer' displays another buffer in a
1288 window, it also makes sure that the window is not marked as dedicated. */)
1289 (Lisp_Object window, Lisp_Object flag)
1291 register struct window *w = decode_window (window);
1293 w->dedicated = flag;
1294 return w->dedicated;
1298 DEFUN ("window-parameters", Fwindow_parameters, Swindow_parameters,
1299 0, 1, 0,
1300 doc: /* Return the parameters of WINDOW and their values.
1301 WINDOW defaults to the selected window. The return value is a list of
1302 elements of the form (PARAMETER . VALUE). */)
1303 (Lisp_Object window)
1305 return Fcopy_alist (decode_window (window)->window_parameters);
1308 DEFUN ("window-parameter", Fwindow_parameter, Swindow_parameter,
1309 2, 2, 0,
1310 doc: /* Return WINDOW's value for PARAMETER.
1311 WINDOW defaults to the selected window. */)
1312 (Lisp_Object window, Lisp_Object parameter)
1314 Lisp_Object result;
1316 result = Fassq (parameter, decode_window (window)->window_parameters);
1317 return CDR_SAFE (result);
1320 DEFUN ("set-window-parameter", Fset_window_parameter,
1321 Sset_window_parameter, 3, 3, 0,
1322 doc: /* Set WINDOW's value of PARAMETER to VALUE.
1323 WINDOW defaults to the selected window. Return VALUE. */)
1324 (Lisp_Object window, Lisp_Object parameter, Lisp_Object value)
1326 register struct window *w = decode_window (window);
1327 Lisp_Object old_alist_elt;
1329 old_alist_elt = Fassq (parameter, w->window_parameters);
1330 if (NILP (old_alist_elt))
1331 w->window_parameters = Fcons (Fcons (parameter, value), w->window_parameters);
1332 else
1333 Fsetcdr (old_alist_elt, value);
1334 return value;
1338 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1339 0, 1, 0,
1340 doc: /* Return the display-table that WINDOW is using.
1341 WINDOW defaults to the selected window. */)
1342 (Lisp_Object window)
1344 return decode_window (window)->display_table;
1347 /* Get the display table for use on window W. This is either W's
1348 display table or W's buffer's display table. Ignore the specified
1349 tables if they are not valid; if no valid table is specified,
1350 return 0. */
1352 struct Lisp_Char_Table *
1353 window_display_table (struct window *w)
1355 struct Lisp_Char_Table *dp = NULL;
1357 if (DISP_TABLE_P (w->display_table))
1358 dp = XCHAR_TABLE (w->display_table);
1359 else if (BUFFERP (w->buffer))
1361 struct buffer *b = XBUFFER (w->buffer);
1363 if (DISP_TABLE_P (b->display_table))
1364 dp = XCHAR_TABLE (b->display_table);
1365 else if (DISP_TABLE_P (Vstandard_display_table))
1366 dp = XCHAR_TABLE (Vstandard_display_table);
1369 return dp;
1372 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1373 doc: /* Set WINDOW's display-table to TABLE. */)
1374 (register Lisp_Object window, Lisp_Object table)
1376 register struct window *w;
1378 w = decode_window (window);
1379 w->display_table = table;
1380 return table;
1383 static void delete_window (Lisp_Object);
1385 /* Record info on buffer window w is displaying
1386 when it is about to cease to display that buffer. */
1387 static void
1388 unshow_buffer (register struct window *w)
1390 Lisp_Object buf;
1391 struct buffer *b;
1393 buf = w->buffer;
1394 b = XBUFFER (buf);
1395 if (b != XMARKER (w->pointm)->buffer)
1396 abort ();
1398 #if 0
1399 if (w == XWINDOW (selected_window)
1400 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1401 /* Do this except when the selected window's buffer
1402 is being removed from some other window. */
1403 #endif
1404 /* last_window_start records the start position that this buffer
1405 had in the last window to be disconnected from it.
1406 Now that this statement is unconditional,
1407 it is possible for the buffer to be displayed in the
1408 selected window, while last_window_start reflects another
1409 window which was recently showing the same buffer.
1410 Some people might say that might be a good thing. Let's see. */
1411 b->last_window_start = marker_position (w->start);
1413 /* Point in the selected window's buffer
1414 is actually stored in that buffer, and the window's pointm isn't used.
1415 So don't clobber point in that buffer. */
1416 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1417 /* This line helps to fix Horsley's testbug.el bug. */
1418 && !(WINDOWP (b->last_selected_window)
1419 && w != XWINDOW (b->last_selected_window)
1420 && EQ (buf, XWINDOW (b->last_selected_window)->buffer)))
1421 temp_set_point_both (b,
1422 clip_to_bounds (BUF_BEGV (b),
1423 XMARKER (w->pointm)->charpos,
1424 BUF_ZV (b)),
1425 clip_to_bounds (BUF_BEGV_BYTE (b),
1426 marker_byte_position (w->pointm),
1427 BUF_ZV_BYTE (b)));
1429 if (WINDOWP (b->last_selected_window)
1430 && w == XWINDOW (b->last_selected_window))
1431 b->last_selected_window = Qnil;
1434 /* Put replacement into the window structure in place of old. */
1435 static void
1436 replace_window (Lisp_Object old, Lisp_Object replacement)
1438 register Lisp_Object tem;
1439 register struct window *o = XWINDOW (old), *p = XWINDOW (replacement);
1441 /* If OLD is its frame's root_window, then replacement is the new
1442 root_window for that frame. */
1444 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1445 FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement;
1447 p->left_col = o->left_col;
1448 p->top_line = o->top_line;
1449 p->total_cols = o->total_cols;
1450 p->total_lines = o->total_lines;
1451 p->desired_matrix = p->current_matrix = 0;
1452 p->vscroll = 0;
1453 memset (&p->cursor, 0, sizeof (p->cursor));
1454 memset (&p->last_cursor, 0, sizeof (p->last_cursor));
1455 memset (&p->phys_cursor, 0, sizeof (p->phys_cursor));
1456 p->phys_cursor_type = -1;
1457 p->phys_cursor_width = -1;
1458 p->must_be_updated_p = 0;
1459 p->pseudo_window_p = 0;
1460 XSETFASTINT (p->window_end_vpos, 0);
1461 XSETFASTINT (p->window_end_pos, 0);
1462 p->window_end_valid = Qnil;
1463 p->frozen_window_start_p = 0;
1464 p->orig_top_line = p->orig_total_lines = Qnil;
1466 p->next = tem = o->next;
1467 if (!NILP (tem))
1468 XWINDOW (tem)->prev = replacement;
1470 p->prev = tem = o->prev;
1471 if (!NILP (tem))
1472 XWINDOW (tem)->next = replacement;
1474 p->parent = tem = o->parent;
1475 if (!NILP (tem))
1477 if (EQ (XWINDOW (tem)->vchild, old))
1478 XWINDOW (tem)->vchild = replacement;
1479 if (EQ (XWINDOW (tem)->hchild, old))
1480 XWINDOW (tem)->hchild = replacement;
1483 /*** Here, if replacement is a vertical combination
1484 and so is its new parent, we should make replacement's
1485 children be children of that parent instead. ***/
1488 DEFUN ("delete-window", Fdelete_window, Sdelete_window, 0, 1, "",
1489 doc: /* Remove WINDOW from its frame.
1490 WINDOW defaults to the selected window. Return nil.
1491 Signal an error when WINDOW is the only window on its frame. */)
1492 (register Lisp_Object window)
1494 struct frame *f;
1495 if (NILP (window))
1496 window = selected_window;
1497 else
1498 CHECK_LIVE_WINDOW (window);
1500 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
1501 delete_window (window);
1503 run_window_configuration_change_hook (f);
1505 return Qnil;
1508 static void
1509 delete_window (register Lisp_Object window)
1511 register Lisp_Object tem, parent, sib;
1512 register struct window *p;
1513 register struct window *par;
1514 struct frame *f;
1516 /* Because this function is called by other C code on non-leaf
1517 windows, the CHECK_LIVE_WINDOW macro would choke inappropriately,
1518 so we can't decode_window here. */
1519 CHECK_WINDOW (window);
1520 p = XWINDOW (window);
1522 /* It's a no-op to delete an already-deleted window. */
1523 if (NILP (p->buffer)
1524 && NILP (p->hchild)
1525 && NILP (p->vchild))
1526 return;
1528 parent = p->parent;
1529 if (NILP (parent))
1530 error ("Attempt to delete minibuffer or sole ordinary window");
1531 par = XWINDOW (parent);
1533 windows_or_buffers_changed++;
1534 Vwindow_list = Qnil;
1535 f = XFRAME (WINDOW_FRAME (p));
1536 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
1538 /* Are we trying to delete any frame's selected window? */
1540 Lisp_Object swindow, pwindow;
1542 /* See if the frame's selected window is either WINDOW
1543 or any subwindow of it, by finding all that window's parents
1544 and comparing each one with WINDOW. */
1545 swindow = FRAME_SELECTED_WINDOW (f);
1547 while (1)
1549 pwindow = swindow;
1550 while (!NILP (pwindow))
1552 if (EQ (window, pwindow))
1553 break;
1554 pwindow = XWINDOW (pwindow)->parent;
1557 /* If the window being deleted is not a parent of SWINDOW,
1558 then SWINDOW is ok as the new selected window. */
1559 if (!EQ (window, pwindow))
1560 break;
1561 /* Otherwise, try another window for SWINDOW. */
1562 swindow = Fnext_window (swindow, Qlambda, Qnil);
1564 /* If we get back to the frame's selected window,
1565 it means there was no acceptable alternative,
1566 so we cannot delete. */
1567 if (EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1568 error ("Cannot delete window");
1571 /* If we need to change SWINDOW, do it. */
1572 if (! EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1574 /* If we're about to delete the selected window on the
1575 selected frame, then we should use Fselect_window to select
1576 the new window. On the other hand, if we're about to
1577 delete the selected window on any other frame, we shouldn't do
1578 anything but set the frame's selected_window slot. */
1579 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
1580 Fselect_window (swindow, Qnil);
1581 else
1582 FRAME_SELECTED_WINDOW (f) = swindow;
1586 /* Now we know we can delete this one. */
1587 window_deletion_count++;
1589 tem = p->buffer;
1590 /* tem is null for dummy parent windows
1591 (which have inferiors but not any contents themselves) */
1592 if (!NILP (tem))
1594 unshow_buffer (p);
1595 unchain_marker (XMARKER (p->pointm));
1596 unchain_marker (XMARKER (p->start));
1599 /* Free window glyph matrices. It is sure that they are allocated
1600 again when ADJUST_GLYPHS is called. Block input so that expose
1601 events and other events that access glyph matrices are not
1602 processed while we are changing them. */
1603 BLOCK_INPUT;
1604 free_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)));
1606 tem = p->next;
1607 if (!NILP (tem))
1608 XWINDOW (tem)->prev = p->prev;
1610 tem = p->prev;
1611 if (!NILP (tem))
1612 XWINDOW (tem)->next = p->next;
1614 if (EQ (window, par->hchild))
1615 par->hchild = p->next;
1616 if (EQ (window, par->vchild))
1617 par->vchild = p->next;
1619 /* Find one of our siblings to give our space to. */
1620 sib = p->prev;
1621 if (NILP (sib))
1623 /* If p gives its space to its next sibling, that sibling needs
1624 to have its top/left side pulled back to where p's is.
1625 set_window_{height,width} will re-position the sibling's
1626 children. */
1627 sib = p->next;
1628 XWINDOW (sib)->top_line = p->top_line;
1629 XWINDOW (sib)->left_col = p->left_col;
1632 /* Stretch that sibling. */
1633 if (!NILP (par->vchild))
1634 set_window_height (sib,
1635 XFASTINT (XWINDOW (sib)->total_lines) + XFASTINT (p->total_lines),
1637 if (!NILP (par->hchild))
1638 set_window_width (sib,
1639 XFASTINT (XWINDOW (sib)->total_cols) + XFASTINT (p->total_cols),
1642 /* If parent now has only one child,
1643 put the child into the parent's place. */
1644 tem = par->hchild;
1645 if (NILP (tem))
1646 tem = par->vchild;
1647 if (NILP (XWINDOW (tem)->next)) {
1648 replace_window (parent, tem);
1649 par = XWINDOW (tem);
1652 /* Since we may be deleting combination windows, we must make sure that
1653 not only p but all its children have been marked as deleted. */
1654 if (! NILP (p->hchild))
1655 delete_all_subwindows (XWINDOW (p->hchild));
1656 else if (! NILP (p->vchild))
1657 delete_all_subwindows (XWINDOW (p->vchild));
1659 /* Mark this window as deleted. */
1660 p->buffer = p->hchild = p->vchild = Qnil;
1662 if (! NILP (par->parent))
1663 par = XWINDOW (par->parent);
1665 /* Check if we have a v/hchild with a v/hchild. In that case remove
1666 one of them. */
1668 if (! NILP (par->vchild) && ! NILP (XWINDOW (par->vchild)->vchild))
1670 p = XWINDOW (par->vchild);
1671 par->vchild = p->vchild;
1672 tem = p->vchild;
1674 else if (! NILP (par->hchild) && ! NILP (XWINDOW (par->hchild)->hchild))
1676 p = XWINDOW (par->hchild);
1677 par->hchild = p->hchild;
1678 tem = p->hchild;
1680 else
1681 p = 0;
1683 if (p)
1685 while (! NILP (tem)) {
1686 XWINDOW (tem)->parent = p->parent;
1687 if (NILP (XWINDOW (tem)->next))
1688 break;
1689 tem = XWINDOW (tem)->next;
1691 if (! NILP (tem)) {
1692 /* The next of the v/hchild we are removing is now the next of the
1693 last child for the v/hchild:
1694 Before v/hchild -> v/hchild -> next1 -> next2
1696 -> next3
1697 After: v/hchild -> next1 -> next2 -> next3
1699 XWINDOW (tem)->next = p->next;
1700 if (! NILP (p->next))
1701 XWINDOW (p->next)->prev = tem;
1703 p->next = p->prev = p->vchild = p->hchild = p->buffer = Qnil;
1707 /* Adjust glyph matrices. */
1708 adjust_glyphs (f);
1709 UNBLOCK_INPUT;
1714 /***********************************************************************
1715 Window List
1716 ***********************************************************************/
1718 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1719 pointer. This is a callback function for foreach_window, used in
1720 function window_list. */
1722 static int
1723 add_window_to_list (struct window *w, void *user_data)
1725 Lisp_Object *list = (Lisp_Object *) user_data;
1726 Lisp_Object window;
1727 XSETWINDOW (window, w);
1728 *list = Fcons (window, *list);
1729 return 1;
1733 /* Return a list of all windows, for use by next_window. If
1734 Vwindow_list is a list, return that list. Otherwise, build a new
1735 list, cache it in Vwindow_list, and return that. */
1737 static Lisp_Object
1738 window_list (void)
1740 if (!CONSP (Vwindow_list))
1742 Lisp_Object tail;
1744 Vwindow_list = Qnil;
1745 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1747 Lisp_Object args[2];
1749 /* We are visiting windows in canonical order, and add
1750 new windows at the front of args[1], which means we
1751 have to reverse this list at the end. */
1752 args[1] = Qnil;
1753 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
1754 args[0] = Vwindow_list;
1755 args[1] = Fnreverse (args[1]);
1756 Vwindow_list = Fnconc (2, args);
1760 return Vwindow_list;
1764 /* Value is non-zero if WINDOW satisfies the constraints given by
1765 OWINDOW, MINIBUF and ALL_FRAMES.
1767 MINIBUF t means WINDOW may be minibuffer windows.
1768 `lambda' means WINDOW may not be a minibuffer window.
1769 a window means a specific minibuffer window
1771 ALL_FRAMES t means search all frames,
1772 nil means search just current frame,
1773 `visible' means search just visible frames,
1774 0 means search visible and iconified frames,
1775 a window means search the frame that window belongs to,
1776 a frame means consider windows on that frame, only. */
1778 static int
1779 candidate_window_p (Lisp_Object window, Lisp_Object owindow, Lisp_Object minibuf, Lisp_Object all_frames)
1781 struct window *w = XWINDOW (window);
1782 struct frame *f = XFRAME (w->frame);
1783 int candidate_p = 1;
1785 if (!BUFFERP (w->buffer))
1786 candidate_p = 0;
1787 else if (MINI_WINDOW_P (w)
1788 && (EQ (minibuf, Qlambda)
1789 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
1791 /* If MINIBUF is `lambda' don't consider any mini-windows.
1792 If it is a window, consider only that one. */
1793 candidate_p = 0;
1795 else if (EQ (all_frames, Qt))
1796 candidate_p = 1;
1797 else if (NILP (all_frames))
1799 xassert (WINDOWP (owindow));
1800 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
1802 else if (EQ (all_frames, Qvisible))
1804 FRAME_SAMPLE_VISIBILITY (f);
1805 candidate_p = FRAME_VISIBLE_P (f)
1806 && (FRAME_TERMINAL (XFRAME (w->frame))
1807 == FRAME_TERMINAL (XFRAME (selected_frame)));
1810 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
1812 FRAME_SAMPLE_VISIBILITY (f);
1813 candidate_p = (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)
1814 #ifdef HAVE_X_WINDOWS
1815 /* Yuck!! If we've just created the frame and the
1816 window-manager requested the user to place it
1817 manually, the window may still not be considered
1818 `visible'. I'd argue it should be at least
1819 something like `iconified', but don't know how to do
1820 that yet. --Stef */
1821 || (FRAME_X_P (f) && f->output_data.x->asked_for_visible
1822 && !f->output_data.x->has_been_visible)
1823 #endif
1825 && (FRAME_TERMINAL (XFRAME (w->frame))
1826 == FRAME_TERMINAL (XFRAME (selected_frame)));
1828 else if (WINDOWP (all_frames))
1829 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
1830 || EQ (XWINDOW (all_frames)->frame, w->frame)
1831 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
1832 else if (FRAMEP (all_frames))
1833 candidate_p = EQ (all_frames, w->frame);
1835 return candidate_p;
1839 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
1840 Fwindow_list. See there for the meaning of WINDOW, MINIBUF, and
1841 ALL_FRAMES. */
1843 static void
1844 decode_next_window_args (Lisp_Object *window, Lisp_Object *minibuf, Lisp_Object *all_frames)
1846 if (NILP (*window))
1847 *window = selected_window;
1848 else
1849 CHECK_LIVE_WINDOW (*window);
1851 /* MINIBUF nil may or may not include minibuffers. Decide if it
1852 does. */
1853 if (NILP (*minibuf))
1854 *minibuf = minibuf_level ? minibuf_window : Qlambda;
1855 else if (!EQ (*minibuf, Qt))
1856 *minibuf = Qlambda;
1858 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
1859 => count none of them, or a specific minibuffer window (the
1860 active one) to count. */
1862 /* ALL_FRAMES nil doesn't specify which frames to include. */
1863 if (NILP (*all_frames))
1864 *all_frames = (!EQ (*minibuf, Qlambda)
1865 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
1866 : Qnil);
1867 else if (EQ (*all_frames, Qvisible))
1869 else if (EQ (*all_frames, make_number (0)))
1871 else if (FRAMEP (*all_frames))
1873 else if (!EQ (*all_frames, Qt))
1874 *all_frames = Qnil;
1876 /* Now *ALL_FRAMES is t meaning search all frames, nil meaning
1877 search just current frame, `visible' meaning search just visible
1878 frames, 0 meaning search visible and iconified frames, or a
1879 window, meaning search the frame that window belongs to, or a
1880 frame, meaning consider windows on that frame, only. */
1884 /* Return the next or previous window of WINDOW in cyclic ordering
1885 of windows. NEXT_P non-zero means return the next window. See the
1886 documentation string of next-window for the meaning of MINIBUF and
1887 ALL_FRAMES. */
1889 static Lisp_Object
1890 next_window (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames, int next_p)
1892 decode_next_window_args (&window, &minibuf, &all_frames);
1894 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
1895 return the first window on the frame. */
1896 if (FRAMEP (all_frames)
1897 && !EQ (all_frames, XWINDOW (window)->frame))
1898 return Fframe_first_window (all_frames);
1900 if (next_p)
1902 Lisp_Object list;
1904 /* Find WINDOW in the list of all windows. */
1905 list = Fmemq (window, window_list ());
1907 /* Scan forward from WINDOW to the end of the window list. */
1908 if (CONSP (list))
1909 for (list = XCDR (list); CONSP (list); list = XCDR (list))
1910 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1911 break;
1913 /* Scan from the start of the window list up to WINDOW. */
1914 if (!CONSP (list))
1915 for (list = Vwindow_list;
1916 CONSP (list) && !EQ (XCAR (list), window);
1917 list = XCDR (list))
1918 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1919 break;
1921 if (CONSP (list))
1922 window = XCAR (list);
1924 else
1926 Lisp_Object candidate, list;
1928 /* Scan through the list of windows for candidates. If there are
1929 candidate windows in front of WINDOW, the last one of these
1930 is the one we want. If there are candidates following WINDOW
1931 in the list, again the last one of these is the one we want. */
1932 candidate = Qnil;
1933 for (list = window_list (); CONSP (list); list = XCDR (list))
1935 if (EQ (XCAR (list), window))
1937 if (WINDOWP (candidate))
1938 break;
1940 else if (candidate_window_p (XCAR (list), window, minibuf,
1941 all_frames))
1942 candidate = XCAR (list);
1945 if (WINDOWP (candidate))
1946 window = candidate;
1949 return window;
1953 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
1954 doc: /* Return window following WINDOW in cyclic ordering of windows.
1955 WINDOW defaults to the selected window. The optional arguments
1956 MINIBUF and ALL-FRAMES specify the set of windows to consider.
1958 MINIBUF t means consider the minibuffer window even if the
1959 minibuffer is not active. MINIBUF nil or omitted means consider
1960 the minibuffer window only if the minibuffer is active. Any
1961 other value means do not consider the minibuffer window even if
1962 the minibuffer is active.
1964 Several frames may share a single minibuffer; if the minibuffer
1965 is active, all windows on all frames that share that minibuffer
1966 are considered too. Therefore, if you are using a separate
1967 minibuffer frame and the minibuffer is active and MINIBUF says it
1968 counts, `next-window' considers the windows in the frame from
1969 which you entered the minibuffer, as well as the minibuffer
1970 window.
1972 ALL-FRAMES nil or omitted means consider all windows on WINDOW's
1973 frame, plus the minibuffer window if specified by the MINIBUF
1974 argument, see above. If the minibuffer counts, consider all
1975 windows on all frames that share that minibuffer too.
1976 ALL-FRAMES t means consider all windows on all existing frames.
1977 ALL-FRAMES `visible' means consider all windows on all visible
1978 frames.
1979 ALL-FRAMES 0 means consider all windows on all visible and
1980 iconified frames.
1981 ALL-FRAMES a frame means consider all windows on that frame only.
1982 Anything else means consider all windows on WINDOW's frame and no
1983 others.
1985 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
1986 `next-window' to iterate through the entire cycle of acceptable
1987 windows, eventually ending up back at the window you started with.
1988 `previous-window' traverses the same cycle, in the reverse order. */)
1989 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
1991 return next_window (window, minibuf, all_frames, 1);
1995 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
1996 doc: /* Return window preceding WINDOW in cyclic ordering of windows.
1997 WINDOW defaults to the selected window. The optional arguments
1998 MINIBUF and ALL-FRAMES specify the set of windows to consider.
1999 For the precise meaning of these arguments see `next-window'.
2001 If you use consistent values for MINIBUF and ALL-FRAMES, you can
2002 use `previous-window' to iterate through the entire cycle of
2003 acceptable windows, eventually ending up back at the window you
2004 started with. `next-window' traverses the same cycle, in the
2005 reverse order. */)
2006 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2008 return next_window (window, minibuf, all_frames, 0);
2012 DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p",
2013 doc: /* Select another window in cyclic ordering of windows.
2014 COUNT specifies the number of windows to skip, starting with the
2015 selected window, before making the selection. If COUNT is
2016 positive, skip COUNT windows forwards. If COUNT is negative,
2017 skip -COUNT windows backwards. COUNT zero means do not skip any
2018 window, so select the selected window. In an interactive call,
2019 COUNT is the numeric prefix argument. Return nil.
2021 This function uses `next-window' for finding the window to select.
2022 The argument ALL-FRAMES has the same meaning as in `next-window',
2023 but the MINIBUF argument of `next-window' is always effectively
2024 nil. */)
2025 (Lisp_Object count, Lisp_Object all_frames)
2027 Lisp_Object window;
2028 int i;
2030 CHECK_NUMBER (count);
2031 window = selected_window;
2033 for (i = XINT (count); i > 0; --i)
2034 window = Fnext_window (window, Qnil, all_frames);
2035 for (; i < 0; ++i)
2036 window = Fprevious_window (window, Qnil, all_frames);
2038 Fselect_window (window, Qnil);
2039 return Qnil;
2043 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
2044 doc: /* Return a list of windows on FRAME, starting with WINDOW.
2045 FRAME nil or omitted means use the selected frame.
2046 WINDOW nil or omitted means use the selected window.
2047 MINIBUF t means include the minibuffer window, even if it isn't active.
2048 MINIBUF nil or omitted means include the minibuffer window only
2049 if it's active.
2050 MINIBUF neither nil nor t means never include the minibuffer window. */)
2051 (Lisp_Object frame, Lisp_Object minibuf, Lisp_Object window)
2053 if (NILP (window))
2054 window = FRAMEP (frame) ? XFRAME (frame)->selected_window : selected_window;
2055 CHECK_WINDOW (window);
2056 if (NILP (frame))
2057 frame = selected_frame;
2059 if (!EQ (frame, XWINDOW (window)->frame))
2060 error ("Window is on a different frame");
2062 return window_list_1 (window, minibuf, frame);
2066 /* Return a list of windows in cyclic ordering. Arguments are like
2067 for `next-window'. */
2069 static Lisp_Object
2070 window_list_1 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2072 Lisp_Object tail, list, rest;
2074 decode_next_window_args (&window, &minibuf, &all_frames);
2075 list = Qnil;
2077 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
2078 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
2079 list = Fcons (XCAR (tail), list);
2081 /* Rotate the list to start with WINDOW. */
2082 list = Fnreverse (list);
2083 rest = Fmemq (window, list);
2084 if (!NILP (rest) && !EQ (rest, list))
2086 for (tail = list; !EQ (XCDR (tail), rest); tail = XCDR (tail))
2088 XSETCDR (tail, Qnil);
2089 list = nconc2 (rest, list);
2091 return list;
2096 /* Look at all windows, performing an operation specified by TYPE
2097 with argument OBJ.
2098 If FRAMES is Qt, look at all frames;
2099 Qnil, look at just the selected frame;
2100 Qvisible, look at visible frames;
2101 a frame, just look at windows on that frame.
2102 If MINI is non-zero, perform the operation on minibuffer windows too. */
2104 enum window_loop
2106 WINDOW_LOOP_UNUSED,
2107 GET_BUFFER_WINDOW, /* Arg is buffer */
2108 GET_LRU_WINDOW, /* Arg is t for full-width windows only */
2109 DELETE_OTHER_WINDOWS, /* Arg is window not to delete */
2110 DELETE_BUFFER_WINDOWS, /* Arg is buffer */
2111 GET_LARGEST_WINDOW,
2112 UNSHOW_BUFFER, /* Arg is buffer */
2113 REDISPLAY_BUFFER_WINDOWS, /* Arg is buffer */
2114 CHECK_ALL_WINDOWS
2117 static Lisp_Object
2118 window_loop (enum window_loop type, Lisp_Object obj, int mini, Lisp_Object frames)
2120 Lisp_Object window, windows, best_window, frame_arg;
2121 struct frame *f;
2122 struct gcpro gcpro1;
2124 /* If we're only looping through windows on a particular frame,
2125 frame points to that frame. If we're looping through windows
2126 on all frames, frame is 0. */
2127 if (FRAMEP (frames))
2128 f = XFRAME (frames);
2129 else if (NILP (frames))
2130 f = SELECTED_FRAME ();
2131 else
2132 f = NULL;
2134 if (f)
2135 frame_arg = Qlambda;
2136 else if (EQ (frames, make_number (0)))
2137 frame_arg = frames;
2138 else if (EQ (frames, Qvisible))
2139 frame_arg = frames;
2140 else
2141 frame_arg = Qt;
2143 /* frame_arg is Qlambda to stick to one frame,
2144 Qvisible to consider all visible frames,
2145 or Qt otherwise. */
2147 /* Pick a window to start with. */
2148 if (WINDOWP (obj))
2149 window = obj;
2150 else if (f)
2151 window = FRAME_SELECTED_WINDOW (f);
2152 else
2153 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2155 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
2156 GCPRO1 (windows);
2157 best_window = Qnil;
2159 for (; CONSP (windows); windows = XCDR (windows))
2161 struct window *w;
2163 window = XCAR (windows);
2164 w = XWINDOW (window);
2166 /* Note that we do not pay attention here to whether the frame
2167 is visible, since Fwindow_list skips non-visible frames if
2168 that is desired, under the control of frame_arg. */
2169 if (!MINI_WINDOW_P (w)
2170 /* For UNSHOW_BUFFER, we must always consider all windows. */
2171 || type == UNSHOW_BUFFER
2172 || (mini && minibuf_level > 0))
2173 switch (type)
2175 case GET_BUFFER_WINDOW:
2176 if (EQ (w->buffer, obj)
2177 /* Don't find any minibuffer window
2178 except the one that is currently in use. */
2179 && (MINI_WINDOW_P (w)
2180 ? EQ (window, minibuf_window)
2181 : 1))
2183 if (NILP (best_window))
2184 best_window = window;
2185 else if (EQ (window, selected_window))
2186 /* Prefer to return selected-window. */
2187 RETURN_UNGCPRO (window);
2188 else if (EQ (Fwindow_frame (window), selected_frame))
2189 /* Prefer windows on the current frame. */
2190 best_window = window;
2192 break;
2194 case GET_LRU_WINDOW:
2195 /* `obj' is an integer encoding a bitvector.
2196 `obj & 1' means consider only full-width windows.
2197 `obj & 2' means consider also dedicated windows. */
2198 if (((XINT (obj) & 1) && !WINDOW_FULL_WIDTH_P (w))
2199 || (!(XINT (obj) & 2) && !NILP (w->dedicated))
2200 /* Minibuffer windows are always ignored. */
2201 || MINI_WINDOW_P (w))
2202 break;
2203 if (NILP (best_window)
2204 || (XFASTINT (XWINDOW (best_window)->use_time)
2205 > XFASTINT (w->use_time)))
2206 best_window = window;
2207 break;
2209 case DELETE_OTHER_WINDOWS:
2210 if (!EQ (window, obj))
2211 Fdelete_window (window);
2212 break;
2214 case DELETE_BUFFER_WINDOWS:
2215 if (EQ (w->buffer, obj))
2217 struct frame *f = XFRAME (WINDOW_FRAME (w));
2219 /* If this window is dedicated, and in a frame of its own,
2220 kill the frame. */
2221 if (EQ (window, FRAME_ROOT_WINDOW (f))
2222 && !NILP (w->dedicated)
2223 && other_visible_frames (f))
2225 /* Skip the other windows on this frame.
2226 There might be one, the minibuffer! */
2227 while (CONSP (XCDR (windows))
2228 && EQ (XWINDOW (XCAR (windows))->frame,
2229 XWINDOW (XCAR (XCDR (windows)))->frame))
2230 windows = XCDR (windows);
2232 /* Now we can safely delete the frame. */
2233 delete_frame (w->frame, Qnil);
2235 else if (NILP (w->parent))
2237 /* If we're deleting the buffer displayed in the
2238 only window on the frame, find a new buffer to
2239 display there. */
2240 Lisp_Object buffer;
2241 buffer = Fother_buffer (obj, Qnil, w->frame);
2242 /* Reset dedicated state of window. */
2243 w->dedicated = Qnil;
2244 Fset_window_buffer (window, buffer, Qnil);
2245 if (EQ (window, selected_window))
2246 Fset_buffer (w->buffer);
2248 else
2249 Fdelete_window (window);
2251 break;
2253 case GET_LARGEST_WINDOW:
2254 { /* nil `obj' means to ignore dedicated windows. */
2255 /* Ignore dedicated windows and minibuffers. */
2256 if (MINI_WINDOW_P (w) || (NILP (obj) && !NILP (w->dedicated)))
2257 break;
2259 if (NILP (best_window))
2260 best_window = window;
2261 else
2263 struct window *b = XWINDOW (best_window);
2264 if (XFASTINT (w->total_lines) * XFASTINT (w->total_cols)
2265 > XFASTINT (b->total_lines) * XFASTINT (b->total_cols))
2266 best_window = window;
2269 break;
2271 case UNSHOW_BUFFER:
2272 if (EQ (w->buffer, obj))
2274 Lisp_Object buffer;
2275 struct frame *f = XFRAME (w->frame);
2277 /* Find another buffer to show in this window. */
2278 buffer = Fother_buffer (obj, Qnil, w->frame);
2280 /* If this window is dedicated, and in a frame of its own,
2281 kill the frame. */
2282 if (EQ (window, FRAME_ROOT_WINDOW (f))
2283 && !NILP (w->dedicated)
2284 && other_visible_frames (f))
2286 /* Skip the other windows on this frame.
2287 There might be one, the minibuffer! */
2288 while (CONSP (XCDR (windows))
2289 && EQ (XWINDOW (XCAR (windows))->frame,
2290 XWINDOW (XCAR (XCDR (windows)))->frame))
2291 windows = XCDR (windows);
2293 /* Now we can safely delete the frame. */
2294 delete_frame (w->frame, Qnil);
2296 else if (!NILP (w->dedicated) && !NILP (w->parent))
2298 Lisp_Object window;
2299 XSETWINDOW (window, w);
2300 /* If this window is dedicated and not the only window
2301 in its frame, then kill it. */
2302 Fdelete_window (window);
2304 else
2306 /* Otherwise show a different buffer in the window. */
2307 w->dedicated = Qnil;
2308 Fset_window_buffer (window, buffer, Qnil);
2309 if (EQ (window, selected_window))
2310 Fset_buffer (w->buffer);
2313 break;
2315 case REDISPLAY_BUFFER_WINDOWS:
2316 if (EQ (w->buffer, obj))
2318 mark_window_display_accurate (window, 0);
2319 w->update_mode_line = Qt;
2320 XBUFFER (obj)->prevent_redisplay_optimizations_p = 1;
2321 ++update_mode_lines;
2322 best_window = window;
2324 break;
2326 /* Check for a window that has a killed buffer. */
2327 case CHECK_ALL_WINDOWS:
2328 if (! NILP (w->buffer)
2329 && NILP (XBUFFER (w->buffer)->name))
2330 abort ();
2331 break;
2333 case WINDOW_LOOP_UNUSED:
2334 break;
2338 UNGCPRO;
2339 return best_window;
2342 /* Used for debugging. Abort if any window has a dead buffer. */
2344 void
2345 check_all_windows (void)
2347 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2350 DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
2351 doc: /* Return WINDOW's use time.
2352 WINDOW defaults to the selected window. The window with the highest use
2353 time is the most recently selected one. The window with the lowest use
2354 time is the least recently selected one. */)
2355 (Lisp_Object window)
2357 return decode_window (window)->use_time;
2360 DEFUN ("get-lru-window", Fget_lru_window, Sget_lru_window, 0, 2, 0,
2361 doc: /* Return the window least recently selected or used for display.
2362 \(LRU means Least Recently Used.)
2364 Return a full-width window if possible.
2365 A minibuffer window is never a candidate.
2366 A dedicated window is never a candidate, unless DEDICATED is non-nil,
2367 so if all windows are dedicated, the value is nil.
2368 If optional argument FRAME is `visible', search all visible frames.
2369 If FRAME is 0, search all visible and iconified frames.
2370 If FRAME is t, search all frames.
2371 If FRAME is nil, search only the selected frame.
2372 If FRAME is a frame, search only that frame. */)
2373 (Lisp_Object frame, Lisp_Object dedicated)
2375 register Lisp_Object w;
2376 /* First try for a window that is full-width */
2377 w = window_loop (GET_LRU_WINDOW,
2378 NILP (dedicated) ? make_number (1) : make_number (3),
2379 0, frame);
2380 if (!NILP (w) && !EQ (w, selected_window))
2381 return w;
2382 /* If none of them, try the rest */
2383 return window_loop (GET_LRU_WINDOW,
2384 NILP (dedicated) ? make_number (0) : make_number (2),
2385 0, frame);
2388 DEFUN ("get-largest-window", Fget_largest_window, Sget_largest_window, 0, 2, 0,
2389 doc: /* Return the largest window in area.
2390 A minibuffer window is never a candidate.
2391 A dedicated window is never a candidate unless DEDICATED is non-nil,
2392 so if all windows are dedicated, the value is nil.
2393 If optional argument FRAME is `visible', search all visible frames.
2394 If FRAME is 0, search all visible and iconified frames.
2395 If FRAME is t, search all frames.
2396 If FRAME is nil, search only the selected frame.
2397 If FRAME is a frame, search only that frame. */)
2398 (Lisp_Object frame, Lisp_Object dedicated)
2400 return window_loop (GET_LARGEST_WINDOW, dedicated, 0,
2401 frame);
2404 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 0, 2, 0,
2405 doc: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2406 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to the
2407 current buffer.
2408 If optional argument FRAME is `visible', search all visible frames.
2409 If optional argument FRAME is 0, search all visible and iconified frames.
2410 If FRAME is t, search all frames.
2411 If FRAME is nil, search only the selected frame.
2412 If FRAME is a frame, search only that frame. */)
2413 (Lisp_Object buffer_or_name, Lisp_Object frame)
2415 Lisp_Object buffer;
2417 if (NILP (buffer_or_name))
2418 buffer = Fcurrent_buffer ();
2419 else
2420 buffer = Fget_buffer (buffer_or_name);
2422 if (BUFFERP (buffer))
2423 return window_loop (GET_BUFFER_WINDOW, buffer, 1, frame);
2424 else
2425 return Qnil;
2428 DEFUN ("delete-other-windows", Fdelete_other_windows, Sdelete_other_windows,
2429 0, 1, "",
2430 doc: /* Make WINDOW (or the selected window) fill its frame.
2431 Only the frame WINDOW is on is affected.
2432 This function tries to reduce display jumps by keeping the text
2433 previously visible in WINDOW in the same place on the frame. Doing this
2434 depends on the value of (window-start WINDOW), so if calling this
2435 function in a program gives strange scrolling, make sure the
2436 window-start value is reasonable when this function is called. */)
2437 (Lisp_Object window)
2439 struct window *w;
2440 EMACS_INT startpos;
2441 int top, new_top;
2443 if (NILP (window))
2444 window = selected_window;
2445 else
2446 CHECK_LIVE_WINDOW (window);
2447 w = XWINDOW (window);
2449 startpos = marker_position (w->start);
2450 top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2452 if (MINI_WINDOW_P (w) && top > 0)
2453 error ("Can't expand minibuffer to full frame");
2455 window_loop (DELETE_OTHER_WINDOWS, window, 0, WINDOW_FRAME (w));
2457 /* Try to minimize scrolling, by setting the window start to the point
2458 will cause the text at the old window start to be at the same place
2459 on the frame. But don't try to do this if the window start is
2460 outside the visible portion (as might happen when the display is
2461 not current, due to typeahead). */
2462 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2463 if (new_top != top
2464 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2465 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2467 struct position pos;
2468 struct buffer *obuf = current_buffer;
2470 Fset_buffer (w->buffer);
2471 /* This computation used to temporarily move point, but that can
2472 have unwanted side effects due to text properties. */
2473 pos = *vmotion (startpos, -top, w);
2475 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2476 w->window_end_valid = Qnil;
2477 w->start_at_line_beg = ((pos.bytepos == BEGV_BYTE
2478 || FETCH_BYTE (pos.bytepos - 1) == '\n') ? Qt
2479 : Qnil);
2480 /* We need to do this, so that the window-scroll-functions
2481 get called. */
2482 w->optional_new_start = Qt;
2484 set_buffer_internal (obuf);
2487 return Qnil;
2490 DEFUN ("delete-windows-on", Fdelete_windows_on, Sdelete_windows_on,
2491 0, 2, "bDelete windows on (buffer): ",
2492 doc: /* Delete all windows showing BUFFER-OR-NAME.
2493 BUFFER-OR-NAME may be a buffer or the name of an existing buffer and
2494 defaults to the current buffer.
2496 Optional second argument FRAME controls which frames are affected.
2497 If optional argument FRAME is `visible', search all visible frames.
2498 If FRAME is 0, search all visible and iconified frames.
2499 If FRAME is nil, search all frames.
2500 If FRAME is t, search only the selected frame.
2501 If FRAME is a frame, search only that frame.
2502 When a window showing BUFFER-OR-NAME is dedicated and the only window of
2503 its frame, that frame is deleted when there are other frames left. */)
2504 (Lisp_Object buffer_or_name, Lisp_Object frame)
2506 Lisp_Object buffer;
2508 /* FRAME uses t and nil to mean the opposite of what window_loop
2509 expects. */
2510 if (NILP (frame))
2511 frame = Qt;
2512 else if (EQ (frame, Qt))
2513 frame = Qnil;
2515 if (NILP (buffer_or_name))
2516 buffer = Fcurrent_buffer ();
2517 else
2519 buffer = Fget_buffer (buffer_or_name);
2520 CHECK_BUFFER (buffer);
2523 window_loop (DELETE_BUFFER_WINDOWS, buffer, 0, frame);
2525 return Qnil;
2528 DEFUN ("replace-buffer-in-windows", Freplace_buffer_in_windows,
2529 Sreplace_buffer_in_windows,
2530 0, 1, "bReplace buffer in windows: ",
2531 doc: /* Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2532 BUFFER-OR-NAME may be a buffer or the name of an existing buffer and
2533 defaults to the current buffer.
2535 When a window showing BUFFER-OR-NAME is dedicated that window is
2536 deleted. If that window is the only window on its frame, that frame is
2537 deleted too when there are other frames left. If there are no other
2538 frames left, some other buffer is displayed in that window. */)
2539 (Lisp_Object buffer_or_name)
2541 Lisp_Object buffer;
2543 if (NILP (buffer_or_name))
2544 buffer = Fcurrent_buffer ();
2545 else
2547 buffer = Fget_buffer (buffer_or_name);
2548 CHECK_BUFFER (buffer);
2551 window_loop (UNSHOW_BUFFER, buffer, 0, Qt);
2553 return Qnil;
2556 /* Replace BUFFER with some other buffer in all windows
2557 of all frames, even those on other keyboards. */
2559 void
2560 replace_buffer_in_all_windows (Lisp_Object buffer)
2562 Lisp_Object tail, frame;
2564 /* A single call to window_loop won't do the job
2565 because it only considers frames on the current keyboard.
2566 So loop manually over frames, and handle each one. */
2567 FOR_EACH_FRAME (tail, frame)
2568 window_loop (UNSHOW_BUFFER, buffer, 1, frame);
2571 /* Set the height of WINDOW and all its inferiors. */
2573 /* The smallest acceptable dimensions for a window. Anything smaller
2574 might crash Emacs. */
2576 #define MIN_SAFE_WINDOW_WIDTH (2)
2577 #define MIN_SAFE_WINDOW_HEIGHT (1)
2579 /* For wp non-zero the total number of columns of window w. Otherwise
2580 the total number of lines of w. */
2582 #define WINDOW_TOTAL_SIZE(w, wp) \
2583 (wp ? WINDOW_TOTAL_COLS (w) : WINDOW_TOTAL_LINES (w))
2585 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2586 minimum allowable size. */
2588 void
2589 check_frame_size (FRAME_PTR frame, int *rows, int *cols)
2591 /* For height, we have to see:
2592 how many windows the frame has at minimum (one or two),
2593 and whether it has a menu bar or other special stuff at the top. */
2594 int min_height
2595 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
2596 ? MIN_SAFE_WINDOW_HEIGHT
2597 : 2 * MIN_SAFE_WINDOW_HEIGHT);
2599 if (FRAME_TOP_MARGIN (frame) > 0)
2600 min_height += FRAME_TOP_MARGIN (frame);
2602 if (*rows < min_height)
2603 *rows = min_height;
2604 if (*cols < MIN_SAFE_WINDOW_WIDTH)
2605 *cols = MIN_SAFE_WINDOW_WIDTH;
2608 /* Value is non-zero if window W is fixed-size. WIDTH_P non-zero means
2609 check if W's width can be changed, otherwise check W's height.
2610 CHECK_SIBLINGS_P non-zero means check resizablity of WINDOW's
2611 siblings, too. If none of the siblings is resizable, WINDOW isn't
2612 either. */
2614 static int
2615 window_fixed_size_p (struct window *w, int width_p, int check_siblings_p)
2617 int fixed_p;
2618 struct window *c;
2620 if (!NILP (w->hchild))
2622 c = XWINDOW (w->hchild);
2624 if (width_p)
2626 /* A horizontal combination is fixed-width if all of if its
2627 children are. */
2628 while (c && window_fixed_size_p (c, width_p, 0))
2629 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2630 fixed_p = c == NULL;
2632 else
2634 /* A horizontal combination is fixed-height if one of if its
2635 children is. */
2636 while (c && !window_fixed_size_p (c, width_p, 0))
2637 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2638 fixed_p = c != NULL;
2641 else if (!NILP (w->vchild))
2643 c = XWINDOW (w->vchild);
2645 if (width_p)
2647 /* A vertical combination is fixed-width if one of if its
2648 children is. */
2649 while (c && !window_fixed_size_p (c, width_p, 0))
2650 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2651 fixed_p = c != NULL;
2653 else
2655 /* A vertical combination is fixed-height if all of if its
2656 children are. */
2657 while (c && window_fixed_size_p (c, width_p, 0))
2658 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2659 fixed_p = c == NULL;
2662 else if (BUFFERP (w->buffer))
2664 struct buffer *old = current_buffer;
2665 Lisp_Object val;
2667 current_buffer = XBUFFER (w->buffer);
2668 val = find_symbol_value (Qwindow_size_fixed);
2669 current_buffer = old;
2671 fixed_p = 0;
2672 if (!EQ (val, Qunbound))
2674 fixed_p = !NILP (val);
2676 if (fixed_p
2677 && ((EQ (val, Qheight) && width_p)
2678 || (EQ (val, Qwidth) && !width_p)))
2679 fixed_p = 0;
2682 /* Can't tell if this one is resizable without looking at
2683 siblings. If all siblings are fixed-size this one is too. */
2684 if (!fixed_p && check_siblings_p && WINDOWP (w->parent))
2686 Lisp_Object child;
2688 for (child = w->prev; WINDOWP (child); child = XWINDOW (child)->prev)
2689 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2690 break;
2692 if (NILP (child))
2693 for (child = w->next; WINDOWP (child); child = XWINDOW (child)->next)
2694 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2695 break;
2697 if (NILP (child))
2698 fixed_p = 1;
2701 else
2702 fixed_p = 1;
2704 return fixed_p;
2707 /* Return minimum size of leaf window W. WIDTH_P non-zero means return
2708 the minimum width of W, WIDTH_P zero means return the minimum height
2709 of W. SAFE_P non-zero means ignore window-min-height|width but just
2710 return values that won't crash Emacs and don't hide components like
2711 fringes, scrollbars, or modelines. If WIDTH_P is zero and W is the
2712 minibuffer window, always return 1. */
2714 static int
2715 window_min_size_2 (struct window *w, int width_p, int safe_p)
2717 /* We should consider buffer-local values of window_min_height and
2718 window_min_width here. */
2719 if (width_p)
2721 int safe_size = (MIN_SAFE_WINDOW_WIDTH
2722 + WINDOW_FRINGE_COLS (w)
2723 + WINDOW_SCROLL_BAR_COLS (w));
2725 return safe_p ? safe_size : max (window_min_width, safe_size);
2727 else if (MINI_WINDOW_P (w))
2728 return 1;
2729 else
2731 int safe_size = (MIN_SAFE_WINDOW_HEIGHT
2732 + ((BUFFERP (w->buffer)
2733 && !NILP (XBUFFER (w->buffer)->mode_line_format))
2734 ? 1 : 0));
2736 return safe_p ? safe_size : max (window_min_height, safe_size);
2740 /* Return minimum size of window W, not taking fixed-width windows into
2741 account. WIDTH_P non-zero means return the minimum width, otherwise
2742 return the minimum height. SAFE_P non-zero means ignore
2743 window-min-height|width but just return values that won't crash Emacs
2744 and don't hide components like fringes, scrollbars, or modelines. If
2745 W is a combination window, compute the minimum size from the minimum
2746 sizes of W's children. */
2748 static int
2749 window_min_size_1 (struct window *w, int width_p, int safe_p)
2751 struct window *c;
2752 int size;
2754 if (!NILP (w->hchild))
2756 /* W is a horizontal combination. */
2757 c = XWINDOW (w->hchild);
2758 size = 0;
2760 if (width_p)
2762 /* The minimum width of a horizontal combination is the sum of
2763 the minimum widths of its children. */
2764 while (c)
2766 size += window_min_size_1 (c, 1, safe_p);
2767 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2770 else
2772 /* The minimum height of a horizontal combination is the
2773 maximum of the minimum heights of its children. */
2774 while (c)
2776 size = max (window_min_size_1 (c, 0, safe_p), size);
2777 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2781 else if (!NILP (w->vchild))
2783 /* W is a vertical combination. */
2784 c = XWINDOW (w->vchild);
2785 size = 0;
2787 if (width_p)
2789 /* The minimum width of a vertical combination is the maximum
2790 of the minimum widths of its children. */
2791 while (c)
2793 size = max (window_min_size_1 (c, 1, safe_p), size);
2794 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2797 else
2799 /* The minimum height of a vertical combination is the sum of
2800 the minimum height of its children. */
2801 while (c)
2803 size += window_min_size_1 (c, 0, safe_p);
2804 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2808 else
2809 /* W is a leaf window. */
2810 size = window_min_size_2 (w, width_p, safe_p);
2812 return size;
2815 /* Return the minimum size of window W, taking fixed-size windows into
2816 account. WIDTH_P non-zero means return the minimum width, otherwise
2817 return the minimum height. SAFE_P non-zero means ignore
2818 window-min-height|width but just return values that won't crash Emacs
2819 and don't hide components like fringes, scrollbars, or modelines.
2820 IGNORE_FIXED_P non-zero means ignore if W is fixed-size. Set *FIXED
2821 to 1 if W is fixed-size unless FIXED is null. */
2823 static int
2824 window_min_size (struct window *w, int width_p, int safe_p, int ignore_fixed_p, int *fixed)
2826 int size, fixed_p;
2828 if (ignore_fixed_p)
2829 fixed_p = 0;
2830 else
2831 fixed_p = window_fixed_size_p (w, width_p, 1);
2833 if (fixed)
2834 *fixed = fixed_p;
2836 if (fixed_p)
2837 size = WINDOW_TOTAL_SIZE (w, width_p);
2838 else
2839 size = window_min_size_1 (w, width_p, safe_p);
2841 return size;
2845 /* Adjust the margins of window W if text area is too small.
2846 Return 1 if window width is ok after adjustment; 0 if window
2847 is still too narrow. */
2849 static int
2850 adjust_window_margins (struct window *w)
2852 int box_cols = (WINDOW_TOTAL_COLS (w)
2853 - WINDOW_FRINGE_COLS (w)
2854 - WINDOW_SCROLL_BAR_COLS (w));
2855 int margin_cols = (WINDOW_LEFT_MARGIN_COLS (w)
2856 + WINDOW_RIGHT_MARGIN_COLS (w));
2858 if (box_cols - margin_cols >= MIN_SAFE_WINDOW_WIDTH)
2859 return 1;
2861 if (margin_cols < 0 || box_cols < MIN_SAFE_WINDOW_WIDTH)
2862 return 0;
2864 /* Window's text area is too narrow, but reducing the window
2865 margins will fix that. */
2866 margin_cols = box_cols - MIN_SAFE_WINDOW_WIDTH;
2867 if (WINDOW_RIGHT_MARGIN_COLS (w) > 0)
2869 if (WINDOW_LEFT_MARGIN_COLS (w) > 0)
2870 w->left_margin_cols = w->right_margin_cols
2871 = make_number (margin_cols/2);
2872 else
2873 w->right_margin_cols = make_number (margin_cols);
2875 else
2876 w->left_margin_cols = make_number (margin_cols);
2877 return 1;
2880 /* Calculate new sizes for windows in the list FORWARD when their
2881 compound size goes from TOTAL to SIZE. TOTAL must be greater than
2882 SIZE. The number of windows in FORWARD is NCHILDREN, and the number
2883 that can shrink is SHRINKABLE. Fixed-size windows may be shrunk if
2884 and only if RESIZE_FIXED_P is non-zero. WIDTH_P non-zero means
2885 shrink columns, otherwise shrink lines.
2887 SAFE_P zero means windows may be sized down to window-min-height
2888 lines (window-min-window columns for WIDTH_P non-zero). SAFE_P
2889 non-zero means windows may be sized down to their minimum safe sizes
2890 taking into account the space needed to display modelines, fringes,
2891 and scrollbars.
2893 This function returns an allocated array of new sizes that the caller
2894 must free. A size -1 means the window is fixed and RESIZE_FIXED_P is
2895 zero. A size zero means the window shall be deleted. Array index 0
2896 refers to the first window in FORWARD, 1 to the second, and so on.
2898 This function resizes windows proportionally to their size. It also
2899 tries to preserve smaller windows by resizing larger windows before
2900 resizing any window to zero. If resize_proportionally is non-nil for
2901 a specific window, it will attempt to strictly resize that window
2902 proportionally, even at the expense of deleting smaller windows. */
2903 static int *
2904 shrink_windows (int total, int size, int nchildren, int shrinkable,
2905 int resize_fixed_p, Lisp_Object forward, int width_p, int safe_p)
2907 int available_resize = 0;
2908 int *new_sizes, *min_sizes;
2909 struct window *c;
2910 Lisp_Object child;
2911 int smallest = total;
2912 int total_removed = 0;
2913 int total_shrink = total - size;
2914 int i;
2916 new_sizes = xmalloc (sizeof (*new_sizes) * nchildren);
2917 min_sizes = xmalloc (sizeof (*min_sizes) * nchildren);
2919 for (i = 0, child = forward; !NILP (child); child = c->next, ++i)
2921 int child_size;
2923 c = XWINDOW (child);
2924 child_size = WINDOW_TOTAL_SIZE (c, width_p);
2926 if (!resize_fixed_p && window_fixed_size_p (c, width_p, 0))
2927 new_sizes[i] = -1;
2928 else
2930 new_sizes[i] = child_size;
2931 min_sizes[i] = window_min_size_1 (c, width_p, safe_p);
2932 if (child_size > min_sizes[i]
2933 && NILP (c->resize_proportionally))
2934 available_resize += child_size - min_sizes[i];
2937 /* We might need to shrink some windows to zero. Find the smallest
2938 windows and set them to 0 until we can fulfil the new size. */
2940 while (shrinkable > 1 && size + available_resize < total)
2942 for (i = 0; i < nchildren; ++i)
2943 if (new_sizes[i] > 0 && smallest > new_sizes[i])
2944 smallest = new_sizes[i];
2946 for (i = 0; i < nchildren; ++i)
2947 if (new_sizes[i] == smallest)
2949 /* Resize this window down to zero. */
2950 new_sizes[i] = 0;
2951 if (smallest > min_sizes[i])
2952 available_resize -= smallest - min_sizes[i];
2953 available_resize += smallest;
2954 --shrinkable;
2955 total_removed += smallest;
2957 /* We don't know what the smallest is now. */
2958 smallest = total;
2960 /* Out of for, just remove one window at the time and
2961 check again if we have enough space. */
2962 break;
2966 /* Now, calculate the new sizes. Try to shrink each window
2967 proportional to its size. */
2968 for (i = 0; i < nchildren; ++i)
2970 if (new_sizes[i] > min_sizes[i])
2972 int to_shrink = total_shrink * new_sizes[i] / total;
2974 if (new_sizes[i] - to_shrink < min_sizes[i])
2975 to_shrink = new_sizes[i] - min_sizes[i];
2976 new_sizes[i] -= to_shrink;
2977 total_removed += to_shrink;
2981 /* Any reminder due to rounding, we just subtract from windows
2982 that are left and still can be shrunk. */
2983 while (total_shrink > total_removed)
2985 int nonzero_sizes = 0;
2986 int nonzero_idx = -1;
2988 for (i = 0; i < nchildren; ++i)
2989 if (new_sizes[i] > 0)
2991 ++nonzero_sizes;
2992 nonzero_idx = i;
2995 for (i = 0; i < nchildren; ++i)
2996 if (new_sizes[i] > min_sizes[i])
2998 --new_sizes[i];
2999 ++total_removed;
3001 /* Out of for, just shrink one window at the time and
3002 check again if we have enough space. */
3003 break;
3006 /* Special case, only one window left. */
3007 if (nonzero_sizes == 1)
3008 break;
3011 /* Any surplus due to rounding, we add to windows that are left. */
3012 while (total_shrink < total_removed)
3014 for (i = 0; i < nchildren; ++i)
3016 if (new_sizes[i] != 0 && total_shrink < total_removed)
3018 ++new_sizes[i];
3019 --total_removed;
3020 break;
3025 xfree (min_sizes);
3027 return new_sizes;
3030 /* Set WINDOW's height or width to SIZE. WIDTH_P non-zero means set
3031 WINDOW's width. Resize WINDOW's children, if any, so that they keep
3032 their proportionate size relative to WINDOW.
3034 If FIRST_ONLY is 1, change only the first of WINDOW's children when
3035 they are in series. If LAST_ONLY is 1, change only the last of
3036 WINDOW's children when they are in series.
3038 Propagate WINDOW's top or left edge position to children. Delete
3039 windows that become too small unless NODELETE_P is 1. When
3040 NODELETE_P equals 2 do not honor settings for window-min-height and
3041 window-min-width when resizing windows but use safe defaults instead.
3042 This should give better behavior when resizing frames. */
3044 static void
3045 size_window (Lisp_Object window, int size, int width_p, int nodelete_p, int first_only, int last_only)
3047 struct window *w = XWINDOW (window);
3048 struct window *c;
3049 Lisp_Object child, *forward, *sideward;
3050 int old_size = WINDOW_TOTAL_SIZE (w, width_p);
3052 size = max (0, size);
3054 /* Delete WINDOW if it's too small. */
3055 if (nodelete_p != 1 && !NILP (w->parent)
3056 && size < window_min_size_1 (w, width_p, nodelete_p == 2))
3058 delete_window (window);
3059 return;
3062 /* Set redisplay hints. */
3063 w->last_modified = make_number (0);
3064 w->last_overlay_modified = make_number (0);
3065 windows_or_buffers_changed++;
3066 FRAME_WINDOW_SIZES_CHANGED (XFRAME (w->frame)) = 1;
3068 if (width_p)
3070 sideward = &w->vchild;
3071 forward = &w->hchild;
3072 w->total_cols = make_number (size);
3073 adjust_window_margins (w);
3075 else
3077 sideward = &w->hchild;
3078 forward = &w->vchild;
3079 w->total_lines = make_number (size);
3080 w->orig_total_lines = Qnil;
3083 if (!NILP (*sideward))
3085 /* We have a chain of parallel siblings whose size should all change. */
3086 for (child = *sideward; !NILP (child); child = c->next)
3088 c = XWINDOW (child);
3089 if (width_p)
3090 c->left_col = w->left_col;
3091 else
3092 c->top_line = w->top_line;
3093 size_window (child, size, width_p, nodelete_p,
3094 first_only, last_only);
3097 else if (!NILP (*forward) && last_only)
3099 /* Change the last in a series of siblings. */
3100 Lisp_Object last_child;
3101 int child_size;
3103 for (child = *forward; !NILP (child); child = c->next)
3105 c = XWINDOW (child);
3106 last_child = child;
3109 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3110 size_window (last_child, size - old_size + child_size,
3111 width_p, nodelete_p, first_only, last_only);
3113 else if (!NILP (*forward) && first_only)
3115 /* Change the first in a series of siblings. */
3116 int child_size;
3118 child = *forward;
3119 c = XWINDOW (child);
3121 if (width_p)
3122 c->left_col = w->left_col;
3123 else
3124 c->top_line = w->top_line;
3126 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3127 size_window (child, size - old_size + child_size,
3128 width_p, nodelete_p, first_only, last_only);
3130 else if (!NILP (*forward))
3132 int fixed_size, each, extra, n;
3133 int resize_fixed_p, nfixed;
3134 int last_pos, first_pos, nchildren, total;
3135 int *new_sizes = NULL;
3137 /* Determine the fixed-size portion of this window, and the
3138 number of child windows. */
3139 fixed_size = nchildren = nfixed = total = 0;
3140 for (child = *forward; !NILP (child); child = c->next, ++nchildren)
3142 int child_size;
3144 c = XWINDOW (child);
3145 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3146 total += child_size;
3148 if (window_fixed_size_p (c, width_p, 0))
3150 fixed_size += child_size;
3151 ++nfixed;
3155 /* If the new size is smaller than fixed_size, or if there
3156 aren't any resizable windows, allow resizing fixed-size
3157 windows. */
3158 resize_fixed_p = nfixed == nchildren || size < fixed_size;
3160 /* Compute how many lines/columns to add/remove to each child. The
3161 value of extra takes care of rounding errors. */
3162 n = resize_fixed_p ? nchildren : nchildren - nfixed;
3163 if (size < total && n > 1)
3164 new_sizes = shrink_windows (total, size, nchildren, n,
3165 resize_fixed_p, *forward, width_p,
3166 nodelete_p == 2);
3167 else
3169 each = (size - total) / n;
3170 extra = (size - total) - n * each;
3173 /* Compute new children heights and edge positions. */
3174 first_pos = width_p ? XINT (w->left_col) : XINT (w->top_line);
3175 last_pos = first_pos;
3176 for (n = 0, child = *forward; !NILP (child); child = c->next, ++n)
3178 int new_size, old_size;
3180 c = XWINDOW (child);
3181 old_size = WINDOW_TOTAL_SIZE (c, width_p);
3182 new_size = old_size;
3184 /* The top or left edge position of this child equals the
3185 bottom or right edge of its predecessor. */
3186 if (width_p)
3187 c->left_col = make_number (last_pos);
3188 else
3189 c->top_line = make_number (last_pos);
3191 /* If this child can be resized, do it. */
3192 if (resize_fixed_p || !window_fixed_size_p (c, width_p, 0))
3194 new_size = new_sizes ? new_sizes[n] : old_size + each + extra;
3195 extra = 0;
3198 /* Set new size. Note that size_window also propagates
3199 edge positions to children, so it's not a no-op if we
3200 didn't change the child's size. */
3201 size_window (child, new_size, width_p, 1, first_only, last_only);
3203 /* Remember the bottom/right edge position of this child; it
3204 will be used to set the top/left edge of the next child. */
3205 last_pos += new_size;
3208 xfree (new_sizes);
3210 /* We should have covered the parent exactly with child windows. */
3211 xassert (size == last_pos - first_pos);
3213 /* Now delete any children that became too small. */
3214 if (nodelete_p != 1)
3215 for (child = *forward; !NILP (child); child = c->next)
3217 int child_size;
3219 c = XWINDOW (child);
3220 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3221 size_window (child, child_size, width_p, nodelete_p,
3222 first_only, last_only);
3227 /* Set WINDOW's height to HEIGHT, and recursively change the height of
3228 WINDOW's children. NODELETE zero means windows that have become
3229 smaller than window-min-height in the process may be deleted.
3230 NODELETE 1 means never delete windows that become too small in the
3231 process. (The caller should check later and do so if appropriate.)
3232 NODELETE 2 means delete only windows that have become too small to be
3233 displayed correctly. */
3235 void
3236 set_window_height (Lisp_Object window, int height, int nodelete)
3238 size_window (window, height, 0, nodelete, 0, 0);
3241 /* Set WINDOW's width to WIDTH, and recursively change the width of
3242 WINDOW's children. NODELETE zero means windows that have become
3243 smaller than window-min-width in the process may be deleted.
3244 NODELETE 1 means never delete windows that become too small in the
3245 process. (The caller should check later and do so if appropriate.)
3246 NODELETE 2 means delete only windows that have become too small to be
3247 displayed correctly. */
3249 void
3250 set_window_width (Lisp_Object window, int width, int nodelete)
3252 size_window (window, width, 1, nodelete, 0, 0);
3255 /* Change window heights in windows rooted in WINDOW by N lines. */
3257 void
3258 change_window_heights (Lisp_Object window, int n)
3260 struct window *w = XWINDOW (window);
3262 XSETFASTINT (w->top_line, XFASTINT (w->top_line) + n);
3263 XSETFASTINT (w->total_lines, XFASTINT (w->total_lines) - n);
3265 if (INTEGERP (w->orig_top_line))
3266 XSETFASTINT (w->orig_top_line, XFASTINT (w->orig_top_line) + n);
3267 if (INTEGERP (w->orig_total_lines))
3268 XSETFASTINT (w->orig_total_lines, XFASTINT (w->orig_total_lines) - n);
3270 /* Handle just the top child in a vertical split. */
3271 if (!NILP (w->vchild))
3272 change_window_heights (w->vchild, n);
3274 /* Adjust all children in a horizontal split. */
3275 for (window = w->hchild; !NILP (window); window = w->next)
3277 w = XWINDOW (window);
3278 change_window_heights (window, n);
3283 int window_select_count;
3285 EXFUN (Fset_window_fringes, 4);
3286 EXFUN (Fset_window_scroll_bars, 4);
3288 static void
3289 run_funs (Lisp_Object funs)
3291 for (; CONSP (funs); funs = XCDR (funs))
3292 if (!EQ (XCAR (funs), Qt))
3293 call0 (XCAR (funs));
3296 static Lisp_Object select_window_norecord (Lisp_Object window);
3297 static Lisp_Object select_frame_norecord (Lisp_Object frame);
3299 void
3300 run_window_configuration_change_hook (struct frame *f)
3302 int count = SPECPDL_INDEX ();
3303 Lisp_Object frame, global_wcch
3304 = Fdefault_value (Qwindow_configuration_change_hook);
3305 XSETFRAME (frame, f);
3307 if (NILP (Vrun_hooks))
3308 return;
3310 if (SELECTED_FRAME () != f)
3312 record_unwind_protect (select_frame_norecord, Fselected_frame ());
3313 Fselect_frame (frame, Qt);
3316 /* Use the right buffer. Matters when running the local hooks. */
3317 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
3319 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3320 Fset_buffer (Fwindow_buffer (Qnil));
3323 /* Look for buffer-local values. */
3325 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
3326 for (; CONSP (windows); windows = XCDR (windows))
3328 Lisp_Object window = XCAR (windows);
3329 Lisp_Object buffer = Fwindow_buffer (window);
3330 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
3331 buffer)))
3333 int count = SPECPDL_INDEX ();
3334 record_unwind_protect (select_window_norecord, Fselected_window ());
3335 select_window_norecord (window);
3336 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
3337 buffer));
3338 unbind_to (count, Qnil);
3343 run_funs (global_wcch);
3344 unbind_to (count, Qnil);
3347 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
3348 means it's allowed to run hooks. See make_frame for a case where
3349 it's not allowed. KEEP_MARGINS_P non-zero means that the current
3350 margins, fringes, and scroll-bar settings of the window are not
3351 reset from the buffer's local settings. */
3353 void
3354 set_window_buffer (Lisp_Object window, Lisp_Object buffer, int run_hooks_p, int keep_margins_p)
3356 struct window *w = XWINDOW (window);
3357 struct buffer *b = XBUFFER (buffer);
3358 int count = SPECPDL_INDEX ();
3359 int samebuf = EQ (buffer, w->buffer);
3361 w->buffer = buffer;
3363 if (EQ (window, selected_window))
3364 b->last_selected_window = window;
3366 /* Let redisplay errors through. */
3367 b->display_error_modiff = 0;
3369 /* Update time stamps of buffer display. */
3370 if (INTEGERP (b->display_count))
3371 XSETINT (b->display_count, XINT (b->display_count) + 1);
3372 b->display_time = Fcurrent_time ();
3374 XSETFASTINT (w->window_end_pos, 0);
3375 XSETFASTINT (w->window_end_vpos, 0);
3376 memset (&w->last_cursor, 0, sizeof w->last_cursor);
3377 w->window_end_valid = Qnil;
3378 if (!(keep_margins_p && samebuf))
3379 { /* If we're not actually changing the buffer, don't reset hscroll and
3380 vscroll. This case happens for example when called from
3381 change_frame_size_1, where we use a dummy call to
3382 Fset_window_buffer on the frame's selected window (and no other)
3383 just in order to run window-configuration-change-hook.
3384 Resetting hscroll and vscroll here is problematic for things like
3385 image-mode and doc-view-mode since it resets the image's position
3386 whenever we resize the frame. */
3387 w->hscroll = w->min_hscroll = make_number (0);
3388 w->vscroll = 0;
3389 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3390 set_marker_restricted (w->start,
3391 make_number (b->last_window_start),
3392 buffer);
3393 w->start_at_line_beg = Qnil;
3394 w->force_start = Qnil;
3395 XSETFASTINT (w->last_modified, 0);
3396 XSETFASTINT (w->last_overlay_modified, 0);
3398 /* Maybe we could move this into the `if' but it's not obviously safe and
3399 I doubt it's worth the trouble. */
3400 windows_or_buffers_changed++;
3402 /* We must select BUFFER for running the window-scroll-functions. */
3403 /* We can't check ! NILP (Vwindow_scroll_functions) here
3404 because that might itself be a local variable. */
3405 if (window_initialized)
3407 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3408 Fset_buffer (buffer);
3411 XMARKER (w->pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3413 if (!keep_margins_p)
3415 /* Set left and right marginal area width etc. from buffer. */
3417 /* This may call adjust_window_margins three times, so
3418 temporarily disable window margins. */
3419 Lisp_Object save_left = w->left_margin_cols;
3420 Lisp_Object save_right = w->right_margin_cols;
3422 w->left_margin_cols = w->right_margin_cols = Qnil;
3424 Fset_window_fringes (window,
3425 b->left_fringe_width, b->right_fringe_width,
3426 b->fringes_outside_margins);
3428 Fset_window_scroll_bars (window,
3429 b->scroll_bar_width,
3430 b->vertical_scroll_bar_type, Qnil);
3432 w->left_margin_cols = save_left;
3433 w->right_margin_cols = save_right;
3435 Fset_window_margins (window,
3436 b->left_margin_cols, b->right_margin_cols);
3439 if (run_hooks_p)
3441 if (! NILP (Vwindow_scroll_functions))
3442 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3443 Fmarker_position (w->start));
3444 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3447 unbind_to (count, Qnil);
3451 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3452 doc: /* Make WINDOW display BUFFER-OR-NAME as its contents.
3453 WINDOW defaults to the selected window. BUFFER-OR-NAME must be a buffer
3454 or the name of an existing buffer. Optional third argument KEEP-MARGINS
3455 non-nil means that WINDOW's current display margins, fringe widths, and
3456 scroll bar settings are preserved; the default is to reset these from
3457 the local settings for BUFFER-OR-NAME or the frame defaults. Return nil.
3459 This function throws an error when WINDOW is strongly dedicated to its
3460 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3461 already display BUFFER-OR-NAME.
3463 This function runs `window-scroll-functions' before running
3464 `window-configuration-change-hook'. */)
3465 (register Lisp_Object window, Lisp_Object buffer_or_name, Lisp_Object keep_margins)
3467 register Lisp_Object tem, buffer;
3468 register struct window *w = decode_window (window);
3470 XSETWINDOW (window, w);
3471 buffer = Fget_buffer (buffer_or_name);
3472 CHECK_BUFFER (buffer);
3473 if (NILP (XBUFFER (buffer)->name))
3474 error ("Attempt to display deleted buffer");
3476 tem = w->buffer;
3477 if (NILP (tem))
3478 error ("Window is deleted");
3479 else if (!EQ (tem, Qt))
3480 /* w->buffer is t when the window is first being set up. */
3482 if (EQ (tem, buffer))
3483 return Qnil;
3484 else if (EQ (w->dedicated, Qt))
3485 error ("Window is dedicated to `%s'", SDATA (XBUFFER (tem)->name));
3486 else
3487 w->dedicated = Qnil;
3489 unshow_buffer (w);
3492 set_window_buffer (window, buffer, 1, !NILP (keep_margins));
3493 return Qnil;
3496 /* If select_window is called with inhibit_point_swap non-zero it will
3497 not store point of the old selected window's buffer back into that
3498 window's pointm slot. This is needed by Fset_window_configuration to
3499 avoid that the display routine is called with selected_window set to
3500 Qnil causing a subsequent crash. */
3502 static Lisp_Object
3503 select_window (Lisp_Object window, Lisp_Object norecord, int inhibit_point_swap)
3505 register struct window *w;
3506 register struct window *ow;
3507 struct frame *sf;
3509 CHECK_LIVE_WINDOW (window);
3511 w = XWINDOW (window);
3512 w->frozen_window_start_p = 0;
3514 if (NILP (norecord))
3516 ++window_select_count;
3517 XSETFASTINT (w->use_time, window_select_count);
3518 record_buffer (w->buffer);
3521 if (EQ (window, selected_window))
3522 return window;
3524 sf = SELECTED_FRAME ();
3525 if (XFRAME (WINDOW_FRAME (w)) != sf)
3527 XFRAME (WINDOW_FRAME (w))->selected_window = window;
3528 /* Use this rather than Fhandle_switch_frame
3529 so that FRAME_FOCUS_FRAME is moved appropriately as we
3530 move around in the state where a minibuffer in a separate
3531 frame is active. */
3532 Fselect_frame (WINDOW_FRAME (w), norecord);
3533 /* Fselect_frame called us back so we've done all the work already. */
3534 eassert (EQ (window, selected_window));
3535 return window;
3537 else
3538 sf->selected_window = window;
3540 /* Store the current buffer's actual point into the
3541 old selected window. It belongs to that window,
3542 and when the window is not selected, must be in the window. */
3543 if (!inhibit_point_swap)
3545 ow = XWINDOW (selected_window);
3546 if (! NILP (ow->buffer))
3547 set_marker_both (ow->pointm, ow->buffer,
3548 BUF_PT (XBUFFER (ow->buffer)),
3549 BUF_PT_BYTE (XBUFFER (ow->buffer)));
3552 selected_window = window;
3554 Fset_buffer (w->buffer);
3556 XBUFFER (w->buffer)->last_selected_window = window;
3558 /* Go to the point recorded in the window.
3559 This is important when the buffer is in more
3560 than one window. It also matters when
3561 redisplay_window has altered point after scrolling,
3562 because it makes the change only in the window. */
3564 register EMACS_INT new_point = marker_position (w->pointm);
3565 if (new_point < BEGV)
3566 SET_PT (BEGV);
3567 else if (new_point > ZV)
3568 SET_PT (ZV);
3569 else
3570 SET_PT (new_point);
3573 windows_or_buffers_changed++;
3574 return window;
3578 /* Note that selected_window can be nil when this is called from
3579 Fset_window_configuration. */
3581 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
3582 doc: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
3583 If WINDOW is not already selected, make WINDOW's buffer current
3584 and make WINDOW the frame's selected window. Return WINDOW.
3585 Optional second arg NORECORD non-nil means do not put this buffer
3586 at the front of the list of recently selected ones and do not
3587 make this window the most recently selected one.
3589 Note that the main editor command loop selects the buffer of the
3590 selected window before each command. */)
3591 (register Lisp_Object window, Lisp_Object norecord)
3593 select_window (window, norecord, 0);
3596 static Lisp_Object
3597 select_window_norecord (Lisp_Object window)
3599 return WINDOW_LIVE_P (window)
3600 ? Fselect_window (window, Qt) : selected_window;
3603 static Lisp_Object
3604 select_frame_norecord (Lisp_Object frame)
3606 return FRAME_LIVE_P (XFRAME (frame))
3607 ? Fselect_frame (frame, Qt) : selected_frame;
3610 Lisp_Object
3611 display_buffer (Lisp_Object buffer, Lisp_Object not_this_window_p, Lisp_Object override_frame)
3613 return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame);
3616 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3617 0, 1, 0,
3618 doc: /* Force all windows to be updated on next redisplay.
3619 If optional arg OBJECT is a window, force redisplay of that window only.
3620 If OBJECT is a buffer or buffer name, force redisplay of all windows
3621 displaying that buffer. */)
3622 (Lisp_Object object)
3624 if (NILP (object))
3626 windows_or_buffers_changed++;
3627 update_mode_lines++;
3628 return Qt;
3631 if (WINDOWP (object))
3633 struct window *w = XWINDOW (object);
3634 mark_window_display_accurate (object, 0);
3635 w->update_mode_line = Qt;
3636 if (BUFFERP (w->buffer))
3637 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
3638 ++update_mode_lines;
3639 return Qt;
3642 if (STRINGP (object))
3643 object = Fget_buffer (object);
3644 if (BUFFERP (object) && !NILP (XBUFFER (object)->name))
3646 /* Walk all windows looking for buffer, and force update
3647 of each of those windows. */
3649 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, 0, Qvisible);
3650 return NILP (object) ? Qnil : Qt;
3653 /* If nothing suitable was found, just return.
3654 We could signal an error, but this feature will typically be used
3655 asynchronously in timers or process sentinels, so we don't. */
3656 return Qnil;
3660 void
3661 temp_output_buffer_show (register Lisp_Object buf)
3663 register struct buffer *old = current_buffer;
3664 register Lisp_Object window;
3665 register struct window *w;
3667 XBUFFER (buf)->directory = current_buffer->directory;
3669 Fset_buffer (buf);
3670 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3671 BEGV = BEG;
3672 ZV = Z;
3673 SET_PT (BEG);
3674 #if 0 /* rms: there should be no reason for this. */
3675 XBUFFER (buf)->prevent_redisplay_optimizations_p = 1;
3676 #endif
3677 set_buffer_internal (old);
3679 if (!NILP (Vtemp_buffer_show_function))
3680 call1 (Vtemp_buffer_show_function, buf);
3681 else
3683 window = display_buffer (buf, Qnil, Qnil);
3685 if (!EQ (XWINDOW (window)->frame, selected_frame))
3686 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3687 Vminibuf_scroll_window = window;
3688 w = XWINDOW (window);
3689 XSETFASTINT (w->hscroll, 0);
3690 XSETFASTINT (w->min_hscroll, 0);
3691 set_marker_restricted_both (w->start, buf, BEG, BEG);
3692 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
3694 /* Run temp-buffer-show-hook, with the chosen window selected
3695 and its buffer current. */
3697 if (!NILP (Vrun_hooks)
3698 && !NILP (Fboundp (Qtemp_buffer_show_hook))
3699 && !NILP (Fsymbol_value (Qtemp_buffer_show_hook)))
3701 int count = SPECPDL_INDEX ();
3702 Lisp_Object prev_window, prev_buffer;
3703 prev_window = selected_window;
3704 XSETBUFFER (prev_buffer, old);
3706 /* Select the window that was chosen, for running the hook.
3707 Note: Both Fselect_window and select_window_norecord may
3708 set-buffer to the buffer displayed in the window,
3709 so we need to save the current buffer. --stef */
3710 record_unwind_protect (Fset_buffer, prev_buffer);
3711 record_unwind_protect (select_window_norecord, prev_window);
3712 Fselect_window (window, Qt);
3713 Fset_buffer (w->buffer);
3714 call1 (Vrun_hooks, Qtemp_buffer_show_hook);
3715 unbind_to (count, Qnil);
3720 static void
3721 make_dummy_parent (Lisp_Object window)
3723 Lisp_Object new;
3724 register struct window *o, *p;
3725 int i;
3727 o = XWINDOW (window);
3728 p = allocate_window ();
3729 for (i = 0; i < VECSIZE (struct window); ++i)
3730 ((struct Lisp_Vector *) p)->contents[i]
3731 = ((struct Lisp_Vector *)o)->contents[i];
3732 XSETWINDOW (new, p);
3734 ++sequence_number;
3735 XSETFASTINT (p->sequence_number, sequence_number);
3737 /* Put new into window structure in place of window */
3738 replace_window (window, new);
3740 o->next = Qnil;
3741 o->prev = Qnil;
3742 o->vchild = Qnil;
3743 o->hchild = Qnil;
3744 o->parent = new;
3746 p->start = Qnil;
3747 p->pointm = Qnil;
3748 p->buffer = Qnil;
3751 DEFUN ("split-window", Fsplit_window, Ssplit_window, 0, 3, "",
3752 doc: /* Split WINDOW, putting SIZE lines in the first of the pair.
3753 WINDOW defaults to selected one and SIZE to half its size.
3754 If optional third arg HORIZONTAL is non-nil, split side by side and put
3755 SIZE columns in the first of the pair. In that case, SIZE includes that
3756 window's scroll bar, or the divider column to its right.
3757 Interactively, all arguments are nil.
3758 Returns the newly created window (which is the lower or rightmost one).
3759 The upper or leftmost window is the original one, and remains selected
3760 if it was selected before.
3762 See Info node `(elisp)Splitting Windows' for more details and examples. */)
3763 (Lisp_Object window, Lisp_Object size, Lisp_Object horizontal)
3765 register Lisp_Object new;
3766 register struct window *o, *p;
3767 FRAME_PTR fo;
3768 register int size_int;
3770 if (NILP (window))
3771 window = selected_window;
3772 else
3773 CHECK_LIVE_WINDOW (window);
3775 o = XWINDOW (window);
3776 fo = XFRAME (WINDOW_FRAME (o));
3778 if (NILP (size))
3780 if (!NILP (horizontal))
3781 /* Calculate the size of the left-hand window, by dividing
3782 the usable space in columns by two.
3783 We round up, since the left-hand window may include
3784 a dividing line, while the right-hand may not. */
3785 size_int = (XFASTINT (o->total_cols) + 1) >> 1;
3786 else
3787 size_int = XFASTINT (o->total_lines) >> 1;
3789 else
3791 CHECK_NUMBER (size);
3792 size_int = XINT (size);
3795 if (MINI_WINDOW_P (o))
3796 error ("Attempt to split minibuffer window");
3797 else if (window_fixed_size_p (o, !NILP (horizontal), 0))
3798 error ("Attempt to split fixed-size window");
3800 if (NILP (horizontal))
3802 int window_safe_height = window_min_size_2 (o, 0, 0);
3804 if (size_int < window_safe_height)
3805 error ("Window height %d too small (after splitting)", size_int);
3806 if (size_int + window_safe_height > XFASTINT (o->total_lines))
3807 error ("Window height %d too small (after splitting)",
3808 XFASTINT (o->total_lines) - size_int);
3809 if (NILP (o->parent)
3810 || NILP (XWINDOW (o->parent)->vchild))
3812 make_dummy_parent (window);
3813 new = o->parent;
3814 XWINDOW (new)->vchild = window;
3817 else
3819 int window_safe_width = window_min_size_2 (o, 1, 0);
3821 if (size_int < window_safe_width)
3822 error ("Window width %d too small (after splitting)", size_int);
3823 if (size_int + window_safe_width > XFASTINT (o->total_cols))
3824 error ("Window width %d too small (after splitting)",
3825 XFASTINT (o->total_cols) - size_int);
3826 if (NILP (o->parent)
3827 || NILP (XWINDOW (o->parent)->hchild))
3829 make_dummy_parent (window);
3830 new = o->parent;
3831 XWINDOW (new)->hchild = window;
3835 /* Now we know that window's parent is a vertical combination
3836 if we are dividing vertically, or a horizontal combination
3837 if we are making side-by-side windows */
3839 windows_or_buffers_changed++;
3840 FRAME_WINDOW_SIZES_CHANGED (fo) = 1;
3841 new = make_window ();
3842 p = XWINDOW (new);
3844 p->frame = o->frame;
3845 p->next = o->next;
3846 if (!NILP (p->next))
3847 XWINDOW (p->next)->prev = new;
3848 p->prev = window;
3849 o->next = new;
3850 p->parent = o->parent;
3851 p->buffer = Qt;
3852 p->window_end_valid = Qnil;
3853 memset (&p->last_cursor, 0, sizeof p->last_cursor);
3855 /* Duplicate special geometry settings. */
3857 p->left_margin_cols = o->left_margin_cols;
3858 p->right_margin_cols = o->right_margin_cols;
3859 p->left_fringe_width = o->left_fringe_width;
3860 p->right_fringe_width = o->right_fringe_width;
3861 p->fringes_outside_margins = o->fringes_outside_margins;
3862 p->scroll_bar_width = o->scroll_bar_width;
3863 p->vertical_scroll_bar_type = o->vertical_scroll_bar_type;
3865 /* Apportion the available frame space among the two new windows */
3867 if (!NILP (horizontal))
3869 p->total_lines = o->total_lines;
3870 p->top_line = o->top_line;
3871 XSETFASTINT (p->total_cols, XFASTINT (o->total_cols) - size_int);
3872 XSETFASTINT (o->total_cols, size_int);
3873 XSETFASTINT (p->left_col, XFASTINT (o->left_col) + size_int);
3874 adjust_window_margins (p);
3875 adjust_window_margins (o);
3877 else
3879 p->left_col = o->left_col;
3880 p->total_cols = o->total_cols;
3881 XSETFASTINT (p->total_lines, XFASTINT (o->total_lines) - size_int);
3882 XSETFASTINT (o->total_lines, size_int);
3883 XSETFASTINT (p->top_line, XFASTINT (o->top_line) + size_int);
3886 /* Adjust glyph matrices. */
3887 adjust_glyphs (fo);
3889 Fset_window_buffer (new, o->buffer, Qt);
3890 return new;
3893 DEFUN ("enlarge-window", Fenlarge_window, Senlarge_window, 1, 2, "p",
3894 doc: /* Make selected window SIZE lines taller.
3895 Interactively, if no argument is given, make the selected window one
3896 line taller. If optional argument HORIZONTAL is non-nil, make selected
3897 window wider by SIZE columns. If SIZE is negative, shrink the window by
3898 -SIZE lines or columns. Return nil.
3900 This function can delete windows if they get too small. The size of
3901 fixed size windows is not altered by this function. */)
3902 (Lisp_Object size, Lisp_Object horizontal)
3904 CHECK_NUMBER (size);
3905 enlarge_window (selected_window, XINT (size), !NILP (horizontal));
3907 run_window_configuration_change_hook (SELECTED_FRAME ());
3909 return Qnil;
3912 DEFUN ("shrink-window", Fshrink_window, Sshrink_window, 1, 2, "p",
3913 doc: /* Make selected window SIZE lines smaller.
3914 Interactively, if no argument is given, make the selected window one
3915 line smaller. If optional argument HORIZONTAL is non-nil, make the
3916 window narrower by SIZE columns. If SIZE is negative, enlarge selected
3917 window by -SIZE lines or columns. Return nil.
3919 This function can delete windows if they get too small. The size of
3920 fixed size windows is not altered by this function. */)
3921 (Lisp_Object size, Lisp_Object horizontal)
3923 CHECK_NUMBER (size);
3924 enlarge_window (selected_window, -XINT (size), !NILP (horizontal));
3926 run_window_configuration_change_hook (SELECTED_FRAME ());
3928 return Qnil;
3931 static int
3932 window_height (Lisp_Object window)
3934 register struct window *p = XWINDOW (window);
3935 return WINDOW_TOTAL_LINES (p);
3938 static int
3939 window_width (Lisp_Object window)
3941 register struct window *p = XWINDOW (window);
3942 return WINDOW_TOTAL_COLS (p);
3946 #define CURBEG(w) \
3947 *(horiz_flag ? &(XWINDOW (w)->left_col) : &(XWINDOW (w)->top_line))
3949 #define CURSIZE(w) \
3950 *(horiz_flag ? &(XWINDOW (w)->total_cols) : &(XWINDOW (w)->total_lines))
3953 /* Enlarge WINDOW by DELTA. HORIZ_FLAG nonzero means enlarge it
3954 horizontally; zero means do it vertically.
3956 Siblings of the selected window are resized to fulfill the size
3957 request. If they become too small in the process, they may be
3958 deleted. */
3960 static void
3961 enlarge_window (Lisp_Object window, int delta, int horiz_flag)
3963 Lisp_Object parent, next, prev;
3964 struct window *p;
3965 Lisp_Object *sizep;
3966 int maximum;
3967 int (*sizefun) (Lisp_Object)
3968 = horiz_flag ? window_width : window_height;
3969 void (*setsizefun) (Lisp_Object, int, int)
3970 = (horiz_flag ? set_window_width : set_window_height);
3972 /* Give up if this window cannot be resized. */
3973 if (window_fixed_size_p (XWINDOW (window), horiz_flag, 1))
3974 error ("Window is not resizable");
3976 /* Find the parent of the selected window. */
3977 while (1)
3979 p = XWINDOW (window);
3980 parent = p->parent;
3982 if (NILP (parent))
3984 if (horiz_flag)
3985 error ("No other window to side of this one");
3986 break;
3989 if (horiz_flag
3990 ? !NILP (XWINDOW (parent)->hchild)
3991 : !NILP (XWINDOW (parent)->vchild))
3992 break;
3994 window = parent;
3997 sizep = &CURSIZE (window);
4000 register int maxdelta;
4002 /* Compute the maximum size increment this window can have. */
4004 maxdelta = (!NILP (parent) ? (*sizefun) (parent) - XINT (*sizep)
4005 /* This is a main window followed by a minibuffer. */
4006 : !NILP (p->next) ? ((*sizefun) (p->next)
4007 - window_min_size (XWINDOW (p->next),
4008 horiz_flag, 0, 0, 0))
4009 /* This is a minibuffer following a main window. */
4010 : !NILP (p->prev) ? ((*sizefun) (p->prev)
4011 - window_min_size (XWINDOW (p->prev),
4012 horiz_flag, 0, 0, 0))
4013 /* This is a frame with only one window, a minibuffer-only
4014 or a minibufferless frame. */
4015 : (delta = 0));
4017 if (delta > maxdelta)
4018 /* This case traps trying to make the minibuffer
4019 the full frame, or make the only window aside from the
4020 minibuffer the full frame. */
4021 delta = maxdelta;
4024 if (XINT (*sizep) + delta < window_min_size (XWINDOW (window),
4025 horiz_flag, 0, 0, 0))
4027 delete_window (window);
4028 return;
4031 if (delta == 0)
4032 return;
4034 /* Find the total we can get from other siblings without deleting them. */
4035 maximum = 0;
4036 for (next = p->next; WINDOWP (next); next = XWINDOW (next)->next)
4037 maximum += (*sizefun) (next) - window_min_size (XWINDOW (next),
4038 horiz_flag, 0, 0, 0);
4039 for (prev = p->prev; WINDOWP (prev); prev = XWINDOW (prev)->prev)
4040 maximum += (*sizefun) (prev) - window_min_size (XWINDOW (prev),
4041 horiz_flag, 0, 0, 0);
4043 /* If we can get it all from them without deleting them, do so. */
4044 if (delta <= maximum)
4046 Lisp_Object first_unaffected;
4047 Lisp_Object first_affected;
4048 int fixed_p;
4050 next = p->next;
4051 prev = p->prev;
4052 first_affected = window;
4053 /* Look at one sibling at a time,
4054 moving away from this window in both directions alternately,
4055 and take as much as we can get without deleting that sibling. */
4056 while (delta != 0
4057 && (!NILP (next) || !NILP (prev)))
4059 if (! NILP (next))
4061 int this_one = ((*sizefun) (next)
4062 - window_min_size (XWINDOW (next), horiz_flag,
4063 0, 0, &fixed_p));
4064 if (!fixed_p)
4066 if (this_one > delta)
4067 this_one = delta;
4069 (*setsizefun) (next, (*sizefun) (next) - this_one, 0);
4070 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
4072 delta -= this_one;
4075 next = XWINDOW (next)->next;
4078 if (delta == 0)
4079 break;
4081 if (! NILP (prev))
4083 int this_one = ((*sizefun) (prev)
4084 - window_min_size (XWINDOW (prev), horiz_flag,
4085 0, 0, &fixed_p));
4086 if (!fixed_p)
4088 if (this_one > delta)
4089 this_one = delta;
4091 first_affected = prev;
4093 (*setsizefun) (prev, (*sizefun) (prev) - this_one, 0);
4094 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
4096 delta -= this_one;
4099 prev = XWINDOW (prev)->prev;
4103 xassert (delta == 0);
4105 /* Now recalculate the edge positions of all the windows affected,
4106 based on the new sizes. */
4107 first_unaffected = next;
4108 prev = first_affected;
4109 for (next = XWINDOW (prev)->next; ! EQ (next, first_unaffected);
4110 prev = next, next = XWINDOW (next)->next)
4112 XSETINT (CURBEG (next), XINT (CURBEG (prev)) + (*sizefun) (prev));
4113 /* This does not change size of NEXT,
4114 but it propagates the new top edge to its children */
4115 (*setsizefun) (next, (*sizefun) (next), 0);
4118 else
4120 register int delta1;
4121 register int opht = (*sizefun) (parent);
4123 if (opht <= XINT (*sizep) + delta)
4125 /* If trying to grow this window to or beyond size of the parent,
4126 just delete all the sibling windows. */
4127 Lisp_Object start, tem, next;
4129 start = XWINDOW (parent)->vchild;
4130 if (NILP (start))
4131 start = XWINDOW (parent)->hchild;
4133 /* Delete any siblings that come after WINDOW. */
4134 tem = XWINDOW (window)->next;
4135 while (! NILP (tem))
4137 next = XWINDOW (tem)->next;
4138 delete_window (tem);
4139 tem = next;
4142 /* Delete any siblings that come after WINDOW.
4143 Note that if START is not WINDOW, then WINDOW still
4144 has siblings, so WINDOW has not yet replaced its parent. */
4145 tem = start;
4146 while (! EQ (tem, window))
4148 next = XWINDOW (tem)->next;
4149 delete_window (tem);
4150 tem = next;
4153 else
4155 /* Otherwise, make delta1 just right so that if we add
4156 delta1 lines to this window and to the parent, and then
4157 shrink the parent back to its original size, the new
4158 proportional size of this window will increase by delta.
4160 The function size_window will compute the new height h'
4161 of the window from delta1 as:
4163 e = delta1/n
4164 x = delta1 - delta1/n * n for the 1st resizable child
4165 h' = h + e + x
4167 where n is the number of children that can be resized.
4168 We can ignore x by choosing a delta1 that is a multiple of
4169 n. We want the height of this window to come out as
4171 h' = h + delta
4173 So, delta1 must be
4175 h + e = h + delta
4176 delta1/n = delta
4177 delta1 = n * delta.
4179 The number of children n equals the number of resizable
4180 children of this window + 1 because we know window itself
4181 is resizable (otherwise we would have signaled an error).
4183 This reasoning is not correct when other windows become too
4184 small and shrink_windows refuses to delete them. Below we
4185 use resize_proportionally to work around this problem. */
4187 struct window *w = XWINDOW (window);
4188 Lisp_Object s;
4189 int n = 1;
4191 for (s = w->next; WINDOWP (s); s = XWINDOW (s)->next)
4192 if (!window_fixed_size_p (XWINDOW (s), horiz_flag, 0))
4193 ++n;
4194 for (s = w->prev; WINDOWP (s); s = XWINDOW (s)->prev)
4195 if (!window_fixed_size_p (XWINDOW (s), horiz_flag, 0))
4196 ++n;
4198 delta1 = n * delta;
4200 /* Add delta1 lines or columns to this window, and to the parent,
4201 keeping things consistent while not affecting siblings. */
4202 XSETINT (CURSIZE (parent), opht + delta1);
4203 (*setsizefun) (window, XINT (*sizep) + delta1, 0);
4205 /* Squeeze out delta1 lines or columns from our parent,
4206 shrinking this window and siblings proportionately. This
4207 brings parent back to correct size. Delta1 was calculated
4208 so this makes this window the desired size, taking it all
4209 out of the siblings.
4211 Temporarily set resize_proportionally to Qt to assure that,
4212 if necessary, shrink_windows deletes smaller windows rather
4213 than shrink this window. */
4214 w->resize_proportionally = Qt;
4215 (*setsizefun) (parent, opht, 0);
4216 w->resize_proportionally = Qnil;
4220 XSETFASTINT (p->last_modified, 0);
4221 XSETFASTINT (p->last_overlay_modified, 0);
4223 /* Adjust glyph matrices. */
4224 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4228 /* Adjust the size of WINDOW by DELTA, moving only its trailing edge.
4229 HORIZ_FLAG nonzero means adjust the width, moving the right edge.
4230 zero means adjust the height, moving the bottom edge.
4232 Following siblings of the selected window are resized to fulfill
4233 the size request. If they become too small in the process, they
4234 are not deleted; instead, we signal an error. */
4236 static void
4237 adjust_window_trailing_edge (Lisp_Object window, int delta, int horiz_flag)
4239 Lisp_Object parent, child;
4240 struct window *p;
4241 Lisp_Object old_config = Fcurrent_window_configuration (Qnil);
4242 int delcount = window_deletion_count;
4244 CHECK_WINDOW (window);
4246 /* Give up if this window cannot be resized. */
4247 if (window_fixed_size_p (XWINDOW (window), horiz_flag, 1))
4248 error ("Window is not resizable");
4250 while (1)
4252 Lisp_Object first_parallel = Qnil;
4254 if (NILP (window))
4256 /* This happens if WINDOW on the previous iteration was
4257 at top level of the window tree. */
4258 Fset_window_configuration (old_config);
4259 error ("Specified window edge is fixed");
4262 p = XWINDOW (window);
4263 parent = p->parent;
4265 /* See if this level has windows in parallel in the specified
4266 direction. If so, set FIRST_PARALLEL to the first one. */
4267 if (horiz_flag)
4269 if (! NILP (parent) && !NILP (XWINDOW (parent)->vchild))
4270 first_parallel = XWINDOW (parent)->vchild;
4271 else if (NILP (parent) && !NILP (p->next))
4273 /* Handle the vertical chain of main window and minibuffer
4274 which has no parent. */
4275 first_parallel = window;
4276 while (! NILP (XWINDOW (first_parallel)->prev))
4277 first_parallel = XWINDOW (first_parallel)->prev;
4280 else
4282 if (! NILP (parent) && !NILP (XWINDOW (parent)->hchild))
4283 first_parallel = XWINDOW (parent)->hchild;
4286 /* If this level's succession is in the desired dimension,
4287 and this window is the last one, and there is no higher level,
4288 its trailing edge is fixed. */
4289 if (NILP (XWINDOW (window)->next) && NILP (first_parallel)
4290 && NILP (parent))
4292 Fset_window_configuration (old_config);
4293 error ("Specified window edge is fixed");
4296 /* Don't make this window too small. */
4297 if (XINT (CURSIZE (window)) + delta
4298 < window_min_size_2 (XWINDOW (window), horiz_flag, 0))
4300 Fset_window_configuration (old_config);
4301 error ("Cannot adjust window size as specified");
4304 /* Clear out some redisplay caches. */
4305 XSETFASTINT (p->last_modified, 0);
4306 XSETFASTINT (p->last_overlay_modified, 0);
4308 /* Adjust this window's edge. */
4309 XSETINT (CURSIZE (window),
4310 XINT (CURSIZE (window)) + delta);
4312 /* If this window has following siblings in the desired dimension,
4313 make them smaller, and exit the loop.
4315 (If we reach the top of the tree and can never do this,
4316 we will fail and report an error, above.) */
4317 if (NILP (first_parallel))
4319 if (!NILP (p->next))
4321 /* This may happen for the minibuffer. In that case
4322 the window_deletion_count check below does not work. */
4323 if (XINT (CURSIZE (p->next)) - delta <= 0)
4325 Fset_window_configuration (old_config);
4326 error ("Cannot adjust window size as specified");
4329 XSETINT (CURBEG (p->next),
4330 XINT (CURBEG (p->next)) + delta);
4331 size_window (p->next, XINT (CURSIZE (p->next)) - delta,
4332 horiz_flag, 0, 1, 0);
4333 break;
4336 else
4337 /* Here we have a chain of parallel siblings, in the other dimension.
4338 Change the size of the other siblings. */
4339 for (child = first_parallel;
4340 ! NILP (child);
4341 child = XWINDOW (child)->next)
4342 if (! EQ (child, window))
4343 size_window (child, XINT (CURSIZE (child)) + delta,
4344 horiz_flag, 0, 0, 1);
4346 window = parent;
4349 /* If we made a window so small it got deleted,
4350 we failed. Report failure. */
4351 if (delcount != window_deletion_count)
4353 Fset_window_configuration (old_config);
4354 error ("Cannot adjust window size as specified");
4357 /* Adjust glyph matrices. */
4358 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4361 #undef CURBEG
4362 #undef CURSIZE
4364 DEFUN ("adjust-window-trailing-edge", Fadjust_window_trailing_edge,
4365 Sadjust_window_trailing_edge, 3, 3, 0,
4366 doc: /* Adjust the bottom or right edge of WINDOW by DELTA.
4367 If HORIZONTAL is non-nil, that means adjust the width, moving the right edge.
4368 Otherwise, adjust the height, moving the bottom edge.
4370 Following siblings of the selected window are resized to fulfill
4371 the size request. If they become too small in the process, they
4372 are not deleted; instead, we signal an error. */)
4373 (Lisp_Object window, Lisp_Object delta, Lisp_Object horizontal)
4375 CHECK_NUMBER (delta);
4376 if (NILP (window))
4377 window = selected_window;
4378 adjust_window_trailing_edge (window, XINT (delta), !NILP (horizontal));
4380 run_window_configuration_change_hook
4381 (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4383 return Qnil;
4388 /***********************************************************************
4389 Resizing Mini-Windows
4390 ***********************************************************************/
4392 static void shrink_window_lowest_first (struct window *, int);
4394 enum save_restore_action
4396 CHECK_ORIG_SIZES,
4397 SAVE_ORIG_SIZES,
4398 RESTORE_ORIG_SIZES
4401 static int save_restore_orig_size (struct window *,
4402 enum save_restore_action);
4404 /* Shrink windows rooted in window W to HEIGHT. Take the space needed
4405 from lowest windows first. */
4407 static void
4408 shrink_window_lowest_first (struct window *w, int height)
4410 struct window *c;
4411 Lisp_Object child;
4412 int old_height;
4414 xassert (!MINI_WINDOW_P (w));
4416 /* Set redisplay hints. */
4417 XSETFASTINT (w->last_modified, 0);
4418 XSETFASTINT (w->last_overlay_modified, 0);
4419 windows_or_buffers_changed++;
4420 FRAME_WINDOW_SIZES_CHANGED (XFRAME (WINDOW_FRAME (w))) = 1;
4422 old_height = XFASTINT (w->total_lines);
4423 XSETFASTINT (w->total_lines, height);
4425 if (!NILP (w->hchild))
4427 for (child = w->hchild; !NILP (child); child = c->next)
4429 c = XWINDOW (child);
4430 c->top_line = w->top_line;
4431 shrink_window_lowest_first (c, height);
4434 else if (!NILP (w->vchild))
4436 Lisp_Object last_child;
4437 int delta = old_height - height;
4438 int last_top;
4440 last_child = Qnil;
4442 /* Find the last child. We are taking space from lowest windows
4443 first, so we iterate over children from the last child
4444 backwards. */
4445 for (child = w->vchild; WINDOWP (child); child = XWINDOW (child)->next)
4446 last_child = child;
4448 /* Size children down to their safe heights. */
4449 for (child = last_child; delta && !NILP (child); child = c->prev)
4451 int this_one;
4453 c = XWINDOW (child);
4454 this_one = XFASTINT (c->total_lines) - window_min_size_1 (c, 0, 1);
4456 if (this_one > delta)
4457 this_one = delta;
4459 shrink_window_lowest_first (c, XFASTINT (c->total_lines) - this_one);
4460 delta -= this_one;
4463 /* Compute new positions. */
4464 last_top = XINT (w->top_line);
4465 for (child = w->vchild; !NILP (child); child = c->next)
4467 c = XWINDOW (child);
4468 c->top_line = make_number (last_top);
4469 shrink_window_lowest_first (c, XFASTINT (c->total_lines));
4470 last_top += XFASTINT (c->total_lines);
4476 /* Save, restore, or check positions and sizes in the window tree
4477 rooted at W. ACTION says what to do.
4479 If ACTION is CHECK_ORIG_SIZES, check if orig_top_line and
4480 orig_total_lines members are valid for all windows in the window
4481 tree. Value is non-zero if they are valid.
4483 If ACTION is SAVE_ORIG_SIZES, save members top and height in
4484 orig_top_line and orig_total_lines for all windows in the tree.
4486 If ACTION is RESTORE_ORIG_SIZES, restore top and height from values
4487 stored in orig_top_line and orig_total_lines for all windows. */
4489 static int
4490 save_restore_orig_size (struct window *w, enum save_restore_action action)
4492 int success_p = 1;
4494 while (w)
4496 if (!NILP (w->hchild))
4498 if (!save_restore_orig_size (XWINDOW (w->hchild), action))
4499 success_p = 0;
4501 else if (!NILP (w->vchild))
4503 if (!save_restore_orig_size (XWINDOW (w->vchild), action))
4504 success_p = 0;
4507 switch (action)
4509 case CHECK_ORIG_SIZES:
4510 if (!INTEGERP (w->orig_top_line) || !INTEGERP (w->orig_total_lines))
4511 return 0;
4512 break;
4514 case SAVE_ORIG_SIZES:
4515 w->orig_top_line = w->top_line;
4516 w->orig_total_lines = w->total_lines;
4517 XSETFASTINT (w->last_modified, 0);
4518 XSETFASTINT (w->last_overlay_modified, 0);
4519 break;
4521 case RESTORE_ORIG_SIZES:
4522 xassert (INTEGERP (w->orig_top_line) && INTEGERP (w->orig_total_lines));
4523 w->top_line = w->orig_top_line;
4524 w->total_lines = w->orig_total_lines;
4525 w->orig_total_lines = w->orig_top_line = Qnil;
4526 XSETFASTINT (w->last_modified, 0);
4527 XSETFASTINT (w->last_overlay_modified, 0);
4528 break;
4530 default:
4531 abort ();
4534 w = NILP (w->next) ? NULL : XWINDOW (w->next);
4537 return success_p;
4541 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we can
4542 without deleting other windows. */
4544 void
4545 grow_mini_window (struct window *w, int delta)
4547 struct frame *f = XFRAME (w->frame);
4548 struct window *root;
4550 xassert (MINI_WINDOW_P (w));
4551 /* Commenting out the following assertion goes against the stated interface
4552 of the function, but it currently does not seem to do anything useful.
4553 See discussion of this issue in the thread for bug#4534.
4554 xassert (delta >= 0); */
4556 /* Compute how much we can enlarge the mini-window without deleting
4557 other windows. */
4558 root = XWINDOW (FRAME_ROOT_WINDOW (f));
4559 if (delta > 0)
4561 int min_height = window_min_size (root, 0, 0, 0, 0);
4562 if (XFASTINT (root->total_lines) - delta < min_height)
4563 /* Note that the root window may already be smaller than
4564 min_height. */
4565 delta = max (0, XFASTINT (root->total_lines) - min_height);
4568 if (delta)
4570 /* Save original window sizes and positions, if not already done. */
4571 if (!save_restore_orig_size (root, CHECK_ORIG_SIZES))
4572 save_restore_orig_size (root, SAVE_ORIG_SIZES);
4574 /* Shrink other windows. */
4575 shrink_window_lowest_first (root, XFASTINT (root->total_lines) - delta);
4577 /* Grow the mini-window. */
4578 w->top_line = make_number (XFASTINT (root->top_line) + XFASTINT (root->total_lines));
4579 w->total_lines = make_number (XFASTINT (w->total_lines) + delta);
4580 XSETFASTINT (w->last_modified, 0);
4581 XSETFASTINT (w->last_overlay_modified, 0);
4583 adjust_glyphs (f);
4588 /* Shrink mini-window W. If there is recorded info about window sizes
4589 before a call to grow_mini_window, restore recorded window sizes.
4590 Otherwise, if the mini-window is higher than 1 line, resize it to 1
4591 line. */
4593 void
4594 shrink_mini_window (struct window *w)
4596 struct frame *f = XFRAME (w->frame);
4597 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
4599 if (save_restore_orig_size (root, CHECK_ORIG_SIZES))
4601 save_restore_orig_size (root, RESTORE_ORIG_SIZES);
4602 adjust_glyphs (f);
4603 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4604 windows_or_buffers_changed = 1;
4606 else if (XFASTINT (w->total_lines) > 1)
4608 /* Distribute the additional lines of the mini-window
4609 among the other windows. */
4610 Lisp_Object window;
4611 XSETWINDOW (window, w);
4612 enlarge_window (window, 1 - XFASTINT (w->total_lines), 0);
4618 /* Mark window cursors off for all windows in the window tree rooted
4619 at W by setting their phys_cursor_on_p flag to zero. Called from
4620 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4621 the frame are cleared. */
4623 void
4624 mark_window_cursors_off (struct window *w)
4626 while (w)
4628 if (!NILP (w->hchild))
4629 mark_window_cursors_off (XWINDOW (w->hchild));
4630 else if (!NILP (w->vchild))
4631 mark_window_cursors_off (XWINDOW (w->vchild));
4632 else
4633 w->phys_cursor_on_p = 0;
4635 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4640 /* Return number of lines of text (not counting mode lines) in W. */
4643 window_internal_height (struct window *w)
4645 int ht = XFASTINT (w->total_lines);
4647 if (!MINI_WINDOW_P (w))
4649 if (!NILP (w->parent)
4650 || !NILP (w->vchild)
4651 || !NILP (w->hchild)
4652 || !NILP (w->next)
4653 || !NILP (w->prev)
4654 || WINDOW_WANTS_MODELINE_P (w))
4655 --ht;
4657 if (WINDOW_WANTS_HEADER_LINE_P (w))
4658 --ht;
4661 return ht;
4665 /* Return the number of columns in W.
4666 Don't count columns occupied by scroll bars or the vertical bar
4667 separating W from the sibling to its right. */
4670 window_box_text_cols (struct window *w)
4672 struct frame *f = XFRAME (WINDOW_FRAME (w));
4673 int width = XINT (w->total_cols);
4675 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
4676 /* Scroll bars occupy a few columns. */
4677 width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
4678 else if (!FRAME_WINDOW_P (f)
4679 && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
4680 /* The column of `|' characters separating side-by-side windows
4681 occupies one column only. */
4682 width -= 1;
4684 if (FRAME_WINDOW_P (f))
4685 /* On window-systems, fringes and display margins cannot be
4686 used for normal text. */
4687 width -= (WINDOW_FRINGE_COLS (w)
4688 + WINDOW_LEFT_MARGIN_COLS (w)
4689 + WINDOW_RIGHT_MARGIN_COLS (w));
4691 return width;
4695 /************************************************************************
4696 Window Scrolling
4697 ***********************************************************************/
4699 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4700 N screen-fulls, which is defined as the height of the window minus
4701 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4702 instead. Negative values of N mean scroll down. NOERROR non-zero
4703 means don't signal an error if we try to move over BEGV or ZV,
4704 respectively. */
4706 static void
4707 window_scroll (Lisp_Object window, int n, int whole, int noerror)
4709 immediate_quit = 1;
4711 /* If we must, use the pixel-based version which is much slower than
4712 the line-based one but can handle varying line heights. */
4713 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4714 window_scroll_pixel_based (window, n, whole, noerror);
4715 else
4716 window_scroll_line_based (window, n, whole, noerror);
4718 immediate_quit = 0;
4722 /* Implementation of window_scroll that works based on pixel line
4723 heights. See the comment of window_scroll for parameter
4724 descriptions. */
4726 static void
4727 window_scroll_pixel_based (Lisp_Object window, int n, int whole, int noerror)
4729 struct it it;
4730 struct window *w = XWINDOW (window);
4731 struct text_pos start;
4732 int this_scroll_margin;
4733 /* True if we fiddled the window vscroll field without really scrolling. */
4734 int vscrolled = 0;
4735 int x, y, rtop, rbot, rowh, vpos;
4737 SET_TEXT_POS_FROM_MARKER (start, w->start);
4739 /* If PT is not visible in WINDOW, move back one half of
4740 the screen. Allow PT to be partially visible, otherwise
4741 something like (scroll-down 1) with PT in the line before
4742 the partially visible one would recenter. */
4744 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
4746 /* Move backward half the height of the window. Performance note:
4747 vmotion used here is about 10% faster, but would give wrong
4748 results for variable height lines. */
4749 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4750 it.current_y = it.last_visible_y;
4751 move_it_vertically_backward (&it, window_box_height (w) / 2);
4753 /* The function move_iterator_vertically may move over more than
4754 the specified y-distance. If it->w is small, e.g. a
4755 mini-buffer window, we may end up in front of the window's
4756 display area. This is the case when Start displaying at the
4757 start of the line containing PT in this case. */
4758 if (it.current_y <= 0)
4760 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4761 move_it_vertically_backward (&it, 0);
4762 it.current_y = 0;
4765 start = it.current.pos;
4767 else if (auto_window_vscroll_p)
4769 if (rtop || rbot) /* partially visible */
4771 int px;
4772 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4773 if (whole)
4774 dy = max ((window_box_height (w)
4775 - next_screen_context_lines * dy),
4776 dy);
4777 dy *= n;
4779 if (n < 0)
4781 /* Only vscroll backwards if already vscrolled forwards. */
4782 if (w->vscroll < 0 && rtop > 0)
4784 px = max (0, -w->vscroll - min (rtop, -dy));
4785 Fset_window_vscroll (window, make_number (px), Qt);
4786 return;
4789 if (n > 0)
4791 /* Do vscroll if already vscrolled or only display line. */
4792 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
4794 px = max (0, -w->vscroll + min (rbot, dy));
4795 Fset_window_vscroll (window, make_number (px), Qt);
4796 return;
4799 /* Maybe modify window start instead of scrolling. */
4800 if (rbot > 0 || w->vscroll < 0)
4802 EMACS_INT spos;
4804 Fset_window_vscroll (window, make_number (0), Qt);
4805 /* If there are other text lines above the current row,
4806 move window start to current row. Else to next row. */
4807 if (rbot > 0)
4808 spos = XINT (Fline_beginning_position (Qnil));
4809 else
4810 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
4811 set_marker_restricted (w->start, make_number (spos),
4812 w->buffer);
4813 w->start_at_line_beg = Qt;
4814 w->update_mode_line = Qt;
4815 XSETFASTINT (w->last_modified, 0);
4816 XSETFASTINT (w->last_overlay_modified, 0);
4817 /* Set force_start so that redisplay_window will run the
4818 window-scroll-functions. */
4819 w->force_start = Qt;
4820 return;
4824 /* Cancel previous vscroll. */
4825 Fset_window_vscroll (window, make_number (0), Qt);
4828 /* If scroll_preserve_screen_position is non-nil, we try to set
4829 point in the same window line as it is now, so get that line. */
4830 if (!NILP (Vscroll_preserve_screen_position))
4832 /* We preserve the goal pixel coordinate across consecutive
4833 calls to scroll-up, scroll-down and other commands that
4834 have the `scroll-command' property. This avoids the
4835 possibility of point becoming "stuck" on a tall line when
4836 scrolling by one line. */
4837 if (window_scroll_pixel_based_preserve_y < 0
4838 || !SYMBOLP (current_kboard->Vlast_command)
4839 || NILP (Fget (current_kboard->Vlast_command, Qscroll_command)))
4841 start_display (&it, w, start);
4842 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4843 window_scroll_pixel_based_preserve_y = it.current_y;
4844 window_scroll_pixel_based_preserve_x = it.current_x;
4847 else
4848 window_scroll_pixel_based_preserve_y
4849 = window_scroll_pixel_based_preserve_x = -1;
4851 /* Move iterator it from start the specified distance forward or
4852 backward. The result is the new window start. */
4853 start_display (&it, w, start);
4854 if (whole)
4856 EMACS_INT start_pos = IT_CHARPOS (it);
4857 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4858 dy = max ((window_box_height (w)
4859 - next_screen_context_lines * dy),
4860 dy) * n;
4862 /* Note that move_it_vertically always moves the iterator to the
4863 start of a line. So, if the last line doesn't have a newline,
4864 we would end up at the start of the line ending at ZV. */
4865 if (dy <= 0)
4867 move_it_vertically_backward (&it, -dy);
4868 /* Ensure we actually do move, e.g. in case we are currently
4869 looking at an image that is taller that the window height. */
4870 while (start_pos == IT_CHARPOS (it)
4871 && start_pos > BEGV)
4872 move_it_by_lines (&it, -1, 1);
4874 else if (dy > 0)
4876 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4877 MOVE_TO_POS | MOVE_TO_Y);
4878 /* Ensure we actually do move, e.g. in case we are currently
4879 looking at an image that is taller that the window height. */
4880 while (start_pos == IT_CHARPOS (it)
4881 && start_pos < ZV)
4882 move_it_by_lines (&it, 1, 1);
4885 else
4886 move_it_by_lines (&it, n, 1);
4888 /* We failed if we find ZV is already on the screen (scrolling up,
4889 means there's nothing past the end), or if we can't start any
4890 earlier (scrolling down, means there's nothing past the top). */
4891 if ((n > 0 && IT_CHARPOS (it) == ZV)
4892 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4894 if (IT_CHARPOS (it) == ZV)
4896 if (it.current_y < it.last_visible_y
4897 && (it.current_y + it.max_ascent + it.max_descent
4898 > it.last_visible_y))
4900 /* The last line was only partially visible, make it fully
4901 visible. */
4902 w->vscroll = (it.last_visible_y
4903 - it.current_y + it.max_ascent + it.max_descent);
4904 adjust_glyphs (it.f);
4906 else if (noerror)
4907 return;
4908 else if (n < 0) /* could happen with empty buffers */
4909 xsignal0 (Qbeginning_of_buffer);
4910 else
4911 xsignal0 (Qend_of_buffer);
4913 else
4915 if (w->vscroll != 0)
4916 /* The first line was only partially visible, make it fully
4917 visible. */
4918 w->vscroll = 0;
4919 else if (noerror)
4920 return;
4921 else
4922 xsignal0 (Qbeginning_of_buffer);
4925 /* If control gets here, then we vscrolled. */
4927 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
4929 /* Don't try to change the window start below. */
4930 vscrolled = 1;
4933 if (! vscrolled)
4935 EMACS_INT pos = IT_CHARPOS (it);
4936 EMACS_INT bytepos;
4938 /* If in the middle of a multi-glyph character move forward to
4939 the next character. */
4940 if (in_display_vector_p (&it))
4942 ++pos;
4943 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
4946 /* Set the window start, and set up the window for redisplay. */
4947 set_marker_restricted (w->start, make_number (pos),
4948 w->buffer);
4949 bytepos = XMARKER (w->start)->bytepos;
4950 w->start_at_line_beg = ((pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n')
4951 ? Qt : Qnil);
4952 w->update_mode_line = Qt;
4953 XSETFASTINT (w->last_modified, 0);
4954 XSETFASTINT (w->last_overlay_modified, 0);
4955 /* Set force_start so that redisplay_window will run the
4956 window-scroll-functions. */
4957 w->force_start = Qt;
4960 /* The rest of this function uses current_y in a nonstandard way,
4961 not including the height of the header line if any. */
4962 it.current_y = it.vpos = 0;
4964 /* Move PT out of scroll margins.
4965 This code wants current_y to be zero at the window start position
4966 even if there is a header line. */
4967 this_scroll_margin = max (0, scroll_margin);
4968 this_scroll_margin = min (this_scroll_margin, XFASTINT (w->total_lines) / 4);
4969 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
4971 if (n > 0)
4973 /* We moved the window start towards ZV, so PT may be now
4974 in the scroll margin at the top. */
4975 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4976 if (IT_CHARPOS (it) == PT && it.current_y >= this_scroll_margin
4977 && (NILP (Vscroll_preserve_screen_position)
4978 || EQ (Vscroll_preserve_screen_position, Qt)))
4979 /* We found PT at a legitimate height. Leave it alone. */
4981 else if (window_scroll_pixel_based_preserve_y >= 0)
4983 /* If we have a header line, take account of it.
4984 This is necessary because we set it.current_y to 0, above. */
4985 move_it_to (&it, -1,
4986 window_scroll_pixel_based_preserve_x,
4987 window_scroll_pixel_based_preserve_y
4988 - (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0 ),
4989 -1, MOVE_TO_Y | MOVE_TO_X);
4990 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4992 else
4994 while (it.current_y < this_scroll_margin)
4996 int prev = it.current_y;
4997 move_it_by_lines (&it, 1, 1);
4998 if (prev == it.current_y)
4999 break;
5001 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5004 else if (n < 0)
5006 EMACS_INT charpos, bytepos;
5007 int partial_p;
5009 /* Save our position, for the
5010 window_scroll_pixel_based_preserve_y case. */
5011 charpos = IT_CHARPOS (it);
5012 bytepos = IT_BYTEPOS (it);
5014 /* We moved the window start towards BEGV, so PT may be now
5015 in the scroll margin at the bottom. */
5016 move_it_to (&it, PT, -1,
5017 (it.last_visible_y - CURRENT_HEADER_LINE_HEIGHT (w)
5018 - this_scroll_margin - 1),
5020 MOVE_TO_POS | MOVE_TO_Y);
5022 /* Save our position, in case it's correct. */
5023 charpos = IT_CHARPOS (it);
5024 bytepos = IT_BYTEPOS (it);
5026 /* See if point is on a partially visible line at the end. */
5027 if (it.what == IT_EOB)
5028 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
5029 else
5031 move_it_by_lines (&it, 1, 1);
5032 partial_p = it.current_y > it.last_visible_y;
5035 if (charpos == PT && !partial_p
5036 && (NILP (Vscroll_preserve_screen_position)
5037 || EQ (Vscroll_preserve_screen_position, Qt)))
5038 /* We found PT before we found the display margin, so PT is ok. */
5040 else if (window_scroll_pixel_based_preserve_y >= 0)
5042 SET_TEXT_POS_FROM_MARKER (start, w->start);
5043 start_display (&it, w, start);
5044 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
5045 here because we called start_display again and did not
5046 alter it.current_y this time. */
5047 move_it_to (&it, -1, window_scroll_pixel_based_preserve_x,
5048 window_scroll_pixel_based_preserve_y, -1,
5049 MOVE_TO_Y | MOVE_TO_X);
5050 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5052 else
5054 if (partial_p)
5055 /* The last line was only partially visible, so back up two
5056 lines to make sure we're on a fully visible line. */
5058 move_it_by_lines (&it, -2, 0);
5059 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5061 else
5062 /* No, the position we saved is OK, so use it. */
5063 SET_PT_BOTH (charpos, bytepos);
5069 /* Implementation of window_scroll that works based on screen lines.
5070 See the comment of window_scroll for parameter descriptions. */
5072 static void
5073 window_scroll_line_based (Lisp_Object window, int n, int whole, int noerror)
5075 register struct window *w = XWINDOW (window);
5076 register EMACS_INT opoint = PT, opoint_byte = PT_BYTE;
5077 register EMACS_INT pos, pos_byte;
5078 register int ht = window_internal_height (w);
5079 register Lisp_Object tem;
5080 int lose;
5081 Lisp_Object bolp;
5082 EMACS_INT startpos;
5083 Lisp_Object original_pos = Qnil;
5085 /* If scrolling screen-fulls, compute the number of lines to
5086 scroll from the window's height. */
5087 if (whole)
5088 n *= max (1, ht - next_screen_context_lines);
5090 startpos = marker_position (w->start);
5092 if (!NILP (Vscroll_preserve_screen_position))
5094 if (window_scroll_preserve_vpos <= 0
5095 || !SYMBOLP (current_kboard->Vlast_command)
5096 || NILP (Fget (current_kboard->Vlast_command, Qscroll_command)))
5098 struct position posit
5099 = *compute_motion (startpos, 0, 0, 0,
5100 PT, ht, 0,
5101 -1, XINT (w->hscroll),
5102 0, w);
5103 window_scroll_preserve_vpos = posit.vpos;
5104 window_scroll_preserve_hpos = posit.hpos + XINT (w->hscroll);
5107 original_pos = Fcons (make_number (window_scroll_preserve_hpos),
5108 make_number (window_scroll_preserve_vpos));
5111 XSETFASTINT (tem, PT);
5112 tem = Fpos_visible_in_window_p (tem, window, Qnil);
5114 if (NILP (tem))
5116 Fvertical_motion (make_number (- (ht / 2)), window);
5117 startpos = PT;
5120 SET_PT (startpos);
5121 lose = n < 0 && PT == BEGV;
5122 Fvertical_motion (make_number (n), window);
5123 pos = PT;
5124 pos_byte = PT_BYTE;
5125 bolp = Fbolp ();
5126 SET_PT_BOTH (opoint, opoint_byte);
5128 if (lose)
5130 if (noerror)
5131 return;
5132 else
5133 xsignal0 (Qbeginning_of_buffer);
5136 if (pos < ZV)
5138 int this_scroll_margin = scroll_margin;
5140 /* Don't use a scroll margin that is negative or too large. */
5141 if (this_scroll_margin < 0)
5142 this_scroll_margin = 0;
5144 if (XINT (w->total_lines) < 4 * scroll_margin)
5145 this_scroll_margin = XINT (w->total_lines) / 4;
5147 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
5148 w->start_at_line_beg = bolp;
5149 w->update_mode_line = Qt;
5150 XSETFASTINT (w->last_modified, 0);
5151 XSETFASTINT (w->last_overlay_modified, 0);
5152 /* Set force_start so that redisplay_window will run
5153 the window-scroll-functions. */
5154 w->force_start = Qt;
5156 if (!NILP (Vscroll_preserve_screen_position)
5157 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
5159 SET_PT_BOTH (pos, pos_byte);
5160 Fvertical_motion (original_pos, window);
5162 /* If we scrolled forward, put point enough lines down
5163 that it is outside the scroll margin. */
5164 else if (n > 0)
5166 int top_margin;
5168 if (this_scroll_margin > 0)
5170 SET_PT_BOTH (pos, pos_byte);
5171 Fvertical_motion (make_number (this_scroll_margin), window);
5172 top_margin = PT;
5174 else
5175 top_margin = pos;
5177 if (top_margin <= opoint)
5178 SET_PT_BOTH (opoint, opoint_byte);
5179 else if (!NILP (Vscroll_preserve_screen_position))
5181 SET_PT_BOTH (pos, pos_byte);
5182 Fvertical_motion (original_pos, window);
5184 else
5185 SET_PT (top_margin);
5187 else if (n < 0)
5189 int bottom_margin;
5191 /* If we scrolled backward, put point near the end of the window
5192 but not within the scroll margin. */
5193 SET_PT_BOTH (pos, pos_byte);
5194 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
5195 if (XFASTINT (tem) == ht - this_scroll_margin)
5196 bottom_margin = PT;
5197 else
5198 bottom_margin = PT + 1;
5200 if (bottom_margin > opoint)
5201 SET_PT_BOTH (opoint, opoint_byte);
5202 else
5204 if (!NILP (Vscroll_preserve_screen_position))
5206 SET_PT_BOTH (pos, pos_byte);
5207 Fvertical_motion (original_pos, window);
5209 else
5210 Fvertical_motion (make_number (-1), window);
5214 else
5216 if (noerror)
5217 return;
5218 else
5219 xsignal0 (Qend_of_buffer);
5224 /* Scroll selected_window up or down. If N is nil, scroll a
5225 screen-full which is defined as the height of the window minus
5226 next_screen_context_lines. If N is the symbol `-', scroll.
5227 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
5228 up. This is the guts of Fscroll_up and Fscroll_down. */
5230 static void
5231 scroll_command (Lisp_Object n, int direction)
5233 int count = SPECPDL_INDEX ();
5235 xassert (eabs (direction) == 1);
5237 /* If selected window's buffer isn't current, make it current for
5238 the moment. But don't screw up if window_scroll gets an error. */
5239 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
5241 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5242 Fset_buffer (XWINDOW (selected_window)->buffer);
5244 /* Make redisplay consider other windows than just selected_window. */
5245 ++windows_or_buffers_changed;
5248 if (NILP (n))
5249 window_scroll (selected_window, direction, 1, 0);
5250 else if (EQ (n, Qminus))
5251 window_scroll (selected_window, -direction, 1, 0);
5252 else
5254 n = Fprefix_numeric_value (n);
5255 window_scroll (selected_window, XINT (n) * direction, 0, 0);
5258 unbind_to (count, Qnil);
5261 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
5262 doc: /* Scroll text of selected window upward ARG lines.
5263 If ARG is omitted or nil, scroll upward by a near full screen.
5264 A near full screen is `next-screen-context-lines' less than a full screen.
5265 Negative ARG means scroll downward.
5266 If ARG is the atom `-', scroll downward by nearly full screen.
5267 When calling from a program, supply as argument a number, nil, or `-'. */)
5268 (Lisp_Object arg)
5270 scroll_command (arg, 1);
5271 return Qnil;
5274 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
5275 doc: /* Scroll text of selected window down ARG lines.
5276 If ARG is omitted or nil, scroll down by a near full screen.
5277 A near full screen is `next-screen-context-lines' less than a full screen.
5278 Negative ARG means scroll upward.
5279 If ARG is the atom `-', scroll upward by nearly full screen.
5280 When calling from a program, supply as argument a number, nil, or `-'. */)
5281 (Lisp_Object arg)
5283 scroll_command (arg, -1);
5284 return Qnil;
5287 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
5288 doc: /* Return the other window for \"other window scroll\" commands.
5289 If `other-window-scroll-buffer' is non-nil, a window
5290 showing that buffer is used.
5291 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5292 specifies the window. This takes precedence over
5293 `other-window-scroll-buffer'. */)
5294 (void)
5296 Lisp_Object window;
5298 if (MINI_WINDOW_P (XWINDOW (selected_window))
5299 && !NILP (Vminibuf_scroll_window))
5300 window = Vminibuf_scroll_window;
5301 /* If buffer is specified, scroll that buffer. */
5302 else if (!NILP (Vother_window_scroll_buffer))
5304 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
5305 if (NILP (window))
5306 window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil);
5308 else
5310 /* Nothing specified; look for a neighboring window on the same
5311 frame. */
5312 window = Fnext_window (selected_window, Qnil, Qnil);
5314 if (EQ (window, selected_window))
5315 /* That didn't get us anywhere; look for a window on another
5316 visible frame. */
5318 window = Fnext_window (window, Qnil, Qt);
5319 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
5320 && ! EQ (window, selected_window));
5323 CHECK_LIVE_WINDOW (window);
5325 if (EQ (window, selected_window))
5326 error ("There is no other window");
5328 return window;
5331 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
5332 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
5333 A near full screen is `next-screen-context-lines' less than a full screen.
5334 The next window is the one below the current one; or the one at the top
5335 if the current one is at the bottom. Negative ARG means scroll downward.
5336 If ARG is the atom `-', scroll downward by nearly full screen.
5337 When calling from a program, supply as argument a number, nil, or `-'.
5339 If `other-window-scroll-buffer' is non-nil, scroll the window
5340 showing that buffer, popping the buffer up if necessary.
5341 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5342 specifies the window to scroll. This takes precedence over
5343 `other-window-scroll-buffer'. */)
5344 (Lisp_Object arg)
5346 Lisp_Object window;
5347 struct window *w;
5348 int count = SPECPDL_INDEX ();
5350 window = Fother_window_for_scrolling ();
5351 w = XWINDOW (window);
5353 /* Don't screw up if window_scroll gets an error. */
5354 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5355 ++windows_or_buffers_changed;
5357 Fset_buffer (w->buffer);
5358 SET_PT (marker_position (w->pointm));
5360 if (NILP (arg))
5361 window_scroll (window, 1, 1, 1);
5362 else if (EQ (arg, Qminus))
5363 window_scroll (window, -1, 1, 1);
5364 else
5366 if (CONSP (arg))
5367 arg = Fcar (arg);
5368 CHECK_NUMBER (arg);
5369 window_scroll (window, XINT (arg), 0, 1);
5372 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
5373 unbind_to (count, Qnil);
5375 return Qnil;
5378 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
5379 doc: /* Scroll selected window display ARG columns left.
5380 Default for ARG is window width minus 2.
5381 Value is the total amount of leftward horizontal scrolling in
5382 effect after the change.
5383 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5384 lower bound for automatic scrolling, i.e. automatic scrolling
5385 will not scroll a window to a column less than the value returned
5386 by this function. This happens in an interactive call. */)
5387 (register Lisp_Object arg, Lisp_Object set_minimum)
5389 Lisp_Object result;
5390 int hscroll;
5391 struct window *w = XWINDOW (selected_window);
5393 if (NILP (arg))
5394 XSETFASTINT (arg, window_box_text_cols (w) - 2);
5395 else
5396 arg = Fprefix_numeric_value (arg);
5398 hscroll = XINT (w->hscroll) + XINT (arg);
5399 result = Fset_window_hscroll (selected_window, make_number (hscroll));
5401 if (!NILP (set_minimum))
5402 w->min_hscroll = w->hscroll;
5404 return result;
5407 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
5408 doc: /* Scroll selected window display ARG columns right.
5409 Default for ARG is window width minus 2.
5410 Value is the total amount of leftward horizontal scrolling in
5411 effect after the change.
5412 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5413 lower bound for automatic scrolling, i.e. automatic scrolling
5414 will not scroll a window to a column less than the value returned
5415 by this function. This happens in an interactive call. */)
5416 (register Lisp_Object arg, Lisp_Object set_minimum)
5418 Lisp_Object result;
5419 int hscroll;
5420 struct window *w = XWINDOW (selected_window);
5422 if (NILP (arg))
5423 XSETFASTINT (arg, window_box_text_cols (w) - 2);
5424 else
5425 arg = Fprefix_numeric_value (arg);
5427 hscroll = XINT (w->hscroll) - XINT (arg);
5428 result = Fset_window_hscroll (selected_window, make_number (hscroll));
5430 if (!NILP (set_minimum))
5431 w->min_hscroll = w->hscroll;
5433 return result;
5436 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
5437 doc: /* Return the window which was selected when entering the minibuffer.
5438 Returns nil, if selected window is not a minibuffer window. */)
5439 (void)
5441 if (minibuf_level > 0
5442 && MINI_WINDOW_P (XWINDOW (selected_window))
5443 && WINDOW_LIVE_P (minibuf_selected_window))
5444 return minibuf_selected_window;
5446 return Qnil;
5449 /* Value is the number of lines actually displayed in window W,
5450 as opposed to its height. */
5452 static int
5453 displayed_window_lines (struct window *w)
5455 struct it it;
5456 struct text_pos start;
5457 int height = window_box_height (w);
5458 struct buffer *old_buffer;
5459 int bottom_y;
5461 if (XBUFFER (w->buffer) != current_buffer)
5463 old_buffer = current_buffer;
5464 set_buffer_internal (XBUFFER (w->buffer));
5466 else
5467 old_buffer = NULL;
5469 /* In case W->start is out of the accessible range, do something
5470 reasonable. This happens in Info mode when Info-scroll-down
5471 calls (recenter -1) while W->start is 1. */
5472 if (XMARKER (w->start)->charpos < BEGV)
5473 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
5474 else if (XMARKER (w->start)->charpos > ZV)
5475 SET_TEXT_POS (start, ZV, ZV_BYTE);
5476 else
5477 SET_TEXT_POS_FROM_MARKER (start, w->start);
5479 start_display (&it, w, start);
5480 move_it_vertically (&it, height);
5481 bottom_y = line_bottom_y (&it);
5483 /* rms: On a non-window display,
5484 the value of it.vpos at the bottom of the screen
5485 seems to be 1 larger than window_box_height (w).
5486 This kludge fixes a bug whereby (move-to-window-line -1)
5487 when ZV is on the last screen line
5488 moves to the previous screen line instead of the last one. */
5489 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
5490 height++;
5492 /* Add in empty lines at the bottom of the window. */
5493 if (bottom_y < height)
5495 int uy = FRAME_LINE_HEIGHT (it.f);
5496 it.vpos += (height - bottom_y + uy - 1) / uy;
5499 if (old_buffer)
5500 set_buffer_internal (old_buffer);
5502 return it.vpos;
5506 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
5507 doc: /* Center point in selected window and maybe redisplay frame.
5508 With prefix argument ARG, recenter putting point on screen line ARG
5509 relative to the selected window. If ARG is negative, it counts up from the
5510 bottom of the window. (ARG should be less than the height of the window.)
5512 If ARG is omitted or nil, then recenter with point on the middle line of
5513 the selected window; if the variable `recenter-redisplay' is non-nil,
5514 also erase the entire frame and redraw it (when `auto-resize-tool-bars'
5515 is set to `grow-only', this resets the tool-bar's height to the minimum
5516 height needed); if `recenter-redisplay' has the special value `tty',
5517 then only tty frame are redrawn.
5519 Just C-u as prefix means put point in the center of the window
5520 and redisplay normally--don't erase and redraw the frame. */)
5521 (register Lisp_Object arg)
5523 struct window *w = XWINDOW (selected_window);
5524 struct buffer *buf = XBUFFER (w->buffer);
5525 struct buffer *obuf = current_buffer;
5526 int center_p = 0;
5527 EMACS_INT charpos, bytepos;
5528 int iarg;
5529 int this_scroll_margin;
5531 /* If redisplay is suppressed due to an error, try again. */
5532 obuf->display_error_modiff = 0;
5534 if (NILP (arg))
5536 if (!NILP (Vrecenter_redisplay)
5537 && (!EQ (Vrecenter_redisplay, Qtty)
5538 || !NILP (Ftty_type (selected_frame))))
5540 int i;
5542 /* Invalidate pixel data calculated for all compositions. */
5543 for (i = 0; i < n_compositions; i++)
5544 composition_table[i]->font = NULL;
5546 WINDOW_XFRAME (w)->minimize_tool_bar_window_p = 1;
5548 Fredraw_frame (WINDOW_FRAME (w));
5549 SET_FRAME_GARBAGED (WINDOW_XFRAME (w));
5552 center_p = 1;
5554 else if (CONSP (arg)) /* Just C-u. */
5555 center_p = 1;
5556 else
5558 arg = Fprefix_numeric_value (arg);
5559 CHECK_NUMBER (arg);
5560 iarg = XINT (arg);
5563 set_buffer_internal (buf);
5565 /* Do this after making BUF current
5566 in case scroll_margin is buffer-local. */
5567 this_scroll_margin = max (0, scroll_margin);
5568 this_scroll_margin = min (this_scroll_margin,
5569 XFASTINT (w->total_lines) / 4);
5571 /* Handle centering on a graphical frame specially. Such frames can
5572 have variable-height lines and centering point on the basis of
5573 line counts would lead to strange effects. */
5574 if (FRAME_WINDOW_P (XFRAME (w->frame)))
5576 if (center_p)
5578 struct it it;
5579 struct text_pos pt;
5581 SET_TEXT_POS (pt, PT, PT_BYTE);
5582 start_display (&it, w, pt);
5583 move_it_vertically_backward (&it, window_box_height (w) / 2);
5584 charpos = IT_CHARPOS (it);
5585 bytepos = IT_BYTEPOS (it);
5587 else if (iarg < 0)
5589 struct it it;
5590 struct text_pos pt;
5591 int nlines = -iarg;
5592 int extra_line_spacing;
5593 int h = window_box_height (w);
5595 iarg = - max (-iarg, this_scroll_margin);
5597 SET_TEXT_POS (pt, PT, PT_BYTE);
5598 start_display (&it, w, pt);
5600 /* Be sure we have the exact height of the full line containing PT. */
5601 move_it_by_lines (&it, 0, 1);
5603 /* The amount of pixels we have to move back is the window
5604 height minus what's displayed in the line containing PT,
5605 and the lines below. */
5606 it.current_y = 0;
5607 it.vpos = 0;
5608 move_it_by_lines (&it, nlines, 1);
5610 if (it.vpos == nlines)
5611 h -= it.current_y;
5612 else
5614 /* Last line has no newline */
5615 h -= line_bottom_y (&it);
5616 it.vpos++;
5619 /* Don't reserve space for extra line spacing of last line. */
5620 extra_line_spacing = it.max_extra_line_spacing;
5622 /* If we can't move down NLINES lines because we hit
5623 the end of the buffer, count in some empty lines. */
5624 if (it.vpos < nlines)
5626 nlines -= it.vpos;
5627 extra_line_spacing = it.extra_line_spacing;
5628 h -= nlines * (FRAME_LINE_HEIGHT (it.f) + extra_line_spacing);
5630 if (h <= 0)
5631 return Qnil;
5633 /* Now find the new top line (starting position) of the window. */
5634 start_display (&it, w, pt);
5635 it.current_y = 0;
5636 move_it_vertically_backward (&it, h);
5638 /* If extra line spacing is present, we may move too far
5639 back. This causes the last line to be only partially
5640 visible (which triggers redisplay to recenter that line
5641 in the middle), so move forward.
5642 But ignore extra line spacing on last line, as it is not
5643 considered to be part of the visible height of the line.
5645 h += extra_line_spacing;
5646 while (-it.current_y > h)
5647 move_it_by_lines (&it, 1, 1);
5649 charpos = IT_CHARPOS (it);
5650 bytepos = IT_BYTEPOS (it);
5652 else
5654 struct position pos;
5656 iarg = max (iarg, this_scroll_margin);
5658 pos = *vmotion (PT, -iarg, w);
5659 charpos = pos.bufpos;
5660 bytepos = pos.bytepos;
5663 else
5665 struct position pos;
5666 int ht = window_internal_height (w);
5668 if (center_p)
5669 iarg = ht / 2;
5670 else if (iarg < 0)
5671 iarg += ht;
5673 /* Don't let it get into the margin at either top or bottom. */
5674 iarg = max (iarg, this_scroll_margin);
5675 iarg = min (iarg, ht - this_scroll_margin - 1);
5677 pos = *vmotion (PT, - iarg, w);
5678 charpos = pos.bufpos;
5679 bytepos = pos.bytepos;
5682 /* Set the new window start. */
5683 set_marker_both (w->start, w->buffer, charpos, bytepos);
5684 w->window_end_valid = Qnil;
5686 w->optional_new_start = Qt;
5688 if (bytepos == BEGV_BYTE || FETCH_BYTE (bytepos - 1) == '\n')
5689 w->start_at_line_beg = Qt;
5690 else
5691 w->start_at_line_beg = Qnil;
5693 set_buffer_internal (obuf);
5694 return Qnil;
5698 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5699 0, 1, 0,
5700 doc: /* Return the height in lines of the text display area of WINDOW.
5701 WINDOW defaults to the selected window.
5703 The return value does not include the mode line, any header line, nor
5704 any partial-height lines in the text display area. */)
5705 (Lisp_Object window)
5707 struct window *w = decode_window (window);
5708 int pixel_height = window_box_height (w);
5709 int line_height = pixel_height / FRAME_LINE_HEIGHT (XFRAME (w->frame));
5710 return make_number (line_height);
5715 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
5716 1, 1, "P",
5717 doc: /* Position point relative to window.
5718 With no argument, position point at center of window.
5719 An argument specifies vertical position within the window;
5720 zero means top of window, negative means relative to bottom of window. */)
5721 (Lisp_Object arg)
5723 struct window *w = XWINDOW (selected_window);
5724 int lines, start;
5725 Lisp_Object window;
5726 #if 0
5727 int this_scroll_margin;
5728 #endif
5730 if (!(BUFFERP (w->buffer)
5731 && XBUFFER (w->buffer) == current_buffer))
5732 /* This test is needed to make sure PT/PT_BYTE make sense in w->buffer
5733 when passed below to set_marker_both. */
5734 error ("move-to-window-line called from unrelated buffer");
5736 window = selected_window;
5737 start = marker_position (w->start);
5738 if (start < BEGV || start > ZV)
5740 int height = window_internal_height (w);
5741 Fvertical_motion (make_number (- (height / 2)), window);
5742 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
5743 w->start_at_line_beg = Fbolp ();
5744 w->force_start = Qt;
5746 else
5747 Fgoto_char (w->start);
5749 lines = displayed_window_lines (w);
5751 #if 0
5752 this_scroll_margin = max (0, scroll_margin);
5753 this_scroll_margin = min (this_scroll_margin, lines / 4);
5754 #endif
5756 if (NILP (arg))
5757 XSETFASTINT (arg, lines / 2);
5758 else
5760 int iarg = XINT (Fprefix_numeric_value (arg));
5762 if (iarg < 0)
5763 iarg = iarg + lines;
5765 #if 0 /* This code would prevent move-to-window-line from moving point
5766 to a place inside the scroll margins (which would cause the
5767 next redisplay to scroll). I wrote this code, but then concluded
5768 it is probably better not to install it. However, it is here
5769 inside #if 0 so as not to lose it. -- rms. */
5771 /* Don't let it get into the margin at either top or bottom. */
5772 iarg = max (iarg, this_scroll_margin);
5773 iarg = min (iarg, lines - this_scroll_margin - 1);
5774 #endif
5776 arg = make_number (iarg);
5779 /* Skip past a partially visible first line. */
5780 if (w->vscroll)
5781 XSETINT (arg, XINT (arg) + 1);
5783 return Fvertical_motion (arg, window);
5788 /***********************************************************************
5789 Window Configuration
5790 ***********************************************************************/
5792 struct save_window_data
5794 EMACS_UINT size;
5795 struct Lisp_Vector *next_from_Lisp_Vector_struct;
5796 Lisp_Object selected_frame;
5797 Lisp_Object current_window;
5798 Lisp_Object current_buffer;
5799 Lisp_Object minibuf_scroll_window;
5800 Lisp_Object minibuf_selected_window;
5801 Lisp_Object root_window;
5802 Lisp_Object focus_frame;
5803 /* A vector, each of whose elements is a struct saved_window
5804 for one window. */
5805 Lisp_Object saved_windows;
5807 /* All fields above are traced by the GC.
5808 From `fame-cols' down, the fields are ignored by the GC. */
5810 int frame_cols, frame_lines, frame_menu_bar_lines;
5811 int frame_tool_bar_lines;
5814 /* This is saved as a Lisp_Vector */
5815 struct saved_window
5817 /* these first two must agree with struct Lisp_Vector in lisp.h */
5818 EMACS_UINT size;
5819 struct Lisp_Vector *next_from_Lisp_Vector_struct;
5821 Lisp_Object window;
5822 Lisp_Object buffer, start, pointm, mark;
5823 Lisp_Object left_col, top_line, total_cols, total_lines;
5824 Lisp_Object hscroll, min_hscroll;
5825 Lisp_Object parent, prev;
5826 Lisp_Object start_at_line_beg;
5827 Lisp_Object display_table;
5828 Lisp_Object orig_top_line, orig_total_lines;
5829 Lisp_Object left_margin_cols, right_margin_cols;
5830 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
5831 Lisp_Object scroll_bar_width, vertical_scroll_bar_type;
5832 Lisp_Object dedicated, resize_proportionally;
5835 #define SAVED_WINDOW_N(swv,n) \
5836 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5838 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
5839 doc: /* Return t if OBJECT is a window-configuration object. */)
5840 (Lisp_Object object)
5842 return WINDOW_CONFIGURATIONP (object) ? Qt : Qnil;
5845 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
5846 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5847 (Lisp_Object config)
5849 register struct save_window_data *data;
5850 struct Lisp_Vector *saved_windows;
5852 CHECK_WINDOW_CONFIGURATION (config);
5854 data = (struct save_window_data *) XVECTOR (config);
5855 saved_windows = XVECTOR (data->saved_windows);
5856 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5859 DEFUN ("set-window-configuration", Fset_window_configuration,
5860 Sset_window_configuration, 1, 1, 0,
5861 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5862 CONFIGURATION must be a value previously returned
5863 by `current-window-configuration' (which see).
5864 If CONFIGURATION was made from a frame that is now deleted,
5865 only frame-independent values can be restored. In this case,
5866 the return value is nil. Otherwise the value is t. */)
5867 (Lisp_Object configuration)
5869 register struct save_window_data *data;
5870 struct Lisp_Vector *saved_windows;
5871 Lisp_Object new_current_buffer;
5872 Lisp_Object frame;
5873 FRAME_PTR f;
5874 EMACS_INT old_point = -1;
5876 CHECK_WINDOW_CONFIGURATION (configuration);
5878 data = (struct save_window_data *) XVECTOR (configuration);
5879 saved_windows = XVECTOR (data->saved_windows);
5881 new_current_buffer = data->current_buffer;
5882 if (NILP (XBUFFER (new_current_buffer)->name))
5883 new_current_buffer = Qnil;
5884 else
5886 if (XBUFFER (new_current_buffer) == current_buffer)
5887 /* The code further down "preserves point" by saving here PT in
5888 old_point and then setting it later back into PT. When the
5889 current-selected-window and the final-selected-window both show
5890 the current buffer, this suffers from the problem that the
5891 current PT is the window-point of the current-selected-window,
5892 while the final PT is the point of the final-selected-window, so
5893 this copy from one PT to the other would end up moving the
5894 window-point of the final-selected-window to the window-point of
5895 the current-selected-window. So we have to be careful which
5896 point of the current-buffer we copy into old_point. */
5897 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5898 && WINDOWP (selected_window)
5899 && EQ (XWINDOW (selected_window)->buffer, new_current_buffer)
5900 && !EQ (selected_window, data->current_window))
5901 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5902 else
5903 old_point = PT;
5904 else
5905 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
5906 point in new_current_buffer as of the last time this buffer was
5907 used. This can be non-deterministic since it can be changed by
5908 things like jit-lock by mere temporary selection of some random
5909 window that happens to show this buffer.
5910 So if possible we want this arbitrary choice of "which point" to
5911 be the one from the to-be-selected-window so as to prevent this
5912 window's cursor from being copied from another window. */
5913 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5914 /* If current_window = selected_window, its point is in BUF_PT. */
5915 && !EQ (selected_window, data->current_window))
5916 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5917 else
5918 old_point = BUF_PT (XBUFFER (new_current_buffer));
5921 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5922 f = XFRAME (frame);
5924 /* If f is a dead frame, don't bother rebuilding its window tree.
5925 However, there is other stuff we should still try to do below. */
5926 if (FRAME_LIVE_P (f))
5928 register struct window *w;
5929 register struct saved_window *p;
5930 struct window *root_window;
5931 struct window **leaf_windows;
5932 int n_leaf_windows;
5933 int k, i, n;
5935 /* If the frame has been resized since this window configuration was
5936 made, we change the frame to the size specified in the
5937 configuration, restore the configuration, and then resize it
5938 back. We keep track of the prevailing height in these variables. */
5939 int previous_frame_lines = FRAME_LINES (f);
5940 int previous_frame_cols = FRAME_COLS (f);
5941 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
5942 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
5944 /* The mouse highlighting code could get screwed up
5945 if it runs during this. */
5946 BLOCK_INPUT;
5948 if (data->frame_lines != previous_frame_lines
5949 || data->frame_cols != previous_frame_cols)
5950 change_frame_size (f, data->frame_lines,
5951 data->frame_cols, 0, 0, 0);
5952 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5953 if (data->frame_menu_bar_lines
5954 != previous_frame_menu_bar_lines)
5955 x_set_menu_bar_lines (f, make_number (data->frame_menu_bar_lines),
5956 make_number (0));
5957 #ifdef HAVE_WINDOW_SYSTEM
5958 if (data->frame_tool_bar_lines
5959 != previous_frame_tool_bar_lines)
5960 x_set_tool_bar_lines (f, make_number (data->frame_tool_bar_lines),
5961 make_number (0));
5962 #endif
5963 #endif
5965 /* "Swap out" point from the selected window's buffer
5966 into the window itself. (Normally the pointm of the selected
5967 window holds garbage.) We do this now, before
5968 restoring the window contents, and prevent it from
5969 being done later on when we select a new window. */
5970 if (! NILP (XWINDOW (selected_window)->buffer))
5972 w = XWINDOW (selected_window);
5973 set_marker_both (w->pointm,
5974 w->buffer,
5975 BUF_PT (XBUFFER (w->buffer)),
5976 BUF_PT_BYTE (XBUFFER (w->buffer)));
5979 windows_or_buffers_changed++;
5980 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
5982 /* Problem: Freeing all matrices and later allocating them again
5983 is a serious redisplay flickering problem. What we would
5984 really like to do is to free only those matrices not reused
5985 below. */
5986 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
5987 leaf_windows
5988 = (struct window **) alloca (count_windows (root_window)
5989 * sizeof (struct window *));
5990 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
5992 /* Kludge Alert!
5993 Mark all windows now on frame as "deleted".
5994 Restoring the new configuration "undeletes" any that are in it.
5996 Save their current buffers in their height fields, since we may
5997 need it later, if a buffer saved in the configuration is now
5998 dead. */
5999 delete_all_subwindows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6001 for (k = 0; k < saved_windows->size; k++)
6003 p = SAVED_WINDOW_N (saved_windows, k);
6004 w = XWINDOW (p->window);
6005 w->next = Qnil;
6007 if (!NILP (p->parent))
6008 w->parent = SAVED_WINDOW_N (saved_windows,
6009 XFASTINT (p->parent))->window;
6010 else
6011 w->parent = Qnil;
6013 if (!NILP (p->prev))
6015 w->prev = SAVED_WINDOW_N (saved_windows,
6016 XFASTINT (p->prev))->window;
6017 XWINDOW (w->prev)->next = p->window;
6019 else
6021 w->prev = Qnil;
6022 if (!NILP (w->parent))
6024 if (EQ (p->total_cols, XWINDOW (w->parent)->total_cols))
6026 XWINDOW (w->parent)->vchild = p->window;
6027 XWINDOW (w->parent)->hchild = Qnil;
6029 else
6031 XWINDOW (w->parent)->hchild = p->window;
6032 XWINDOW (w->parent)->vchild = Qnil;
6037 /* If we squirreled away the buffer in the window's height,
6038 restore it now. */
6039 if (BUFFERP (w->total_lines))
6040 w->buffer = w->total_lines;
6041 w->left_col = p->left_col;
6042 w->top_line = p->top_line;
6043 w->total_cols = p->total_cols;
6044 w->total_lines = p->total_lines;
6045 w->hscroll = p->hscroll;
6046 w->min_hscroll = p->min_hscroll;
6047 w->display_table = p->display_table;
6048 w->orig_top_line = p->orig_top_line;
6049 w->orig_total_lines = p->orig_total_lines;
6050 w->left_margin_cols = p->left_margin_cols;
6051 w->right_margin_cols = p->right_margin_cols;
6052 w->left_fringe_width = p->left_fringe_width;
6053 w->right_fringe_width = p->right_fringe_width;
6054 w->fringes_outside_margins = p->fringes_outside_margins;
6055 w->scroll_bar_width = p->scroll_bar_width;
6056 w->vertical_scroll_bar_type = p->vertical_scroll_bar_type;
6057 w->dedicated = p->dedicated;
6058 w->resize_proportionally = p->resize_proportionally;
6059 XSETFASTINT (w->last_modified, 0);
6060 XSETFASTINT (w->last_overlay_modified, 0);
6062 /* Reinstall the saved buffer and pointers into it. */
6063 if (NILP (p->buffer))
6064 w->buffer = p->buffer;
6065 else
6067 if (!NILP (XBUFFER (p->buffer)->name))
6068 /* If saved buffer is alive, install it. */
6070 w->buffer = p->buffer;
6071 w->start_at_line_beg = p->start_at_line_beg;
6072 set_marker_restricted (w->start, p->start, w->buffer);
6073 set_marker_restricted (w->pointm, p->pointm, w->buffer);
6074 Fset_marker (XBUFFER (w->buffer)->mark,
6075 p->mark, w->buffer);
6077 /* As documented in Fcurrent_window_configuration, don't
6078 restore the location of point in the buffer which was
6079 current when the window configuration was recorded. */
6080 if (!EQ (p->buffer, new_current_buffer)
6081 && XBUFFER (p->buffer) == current_buffer)
6082 Fgoto_char (w->pointm);
6084 else if (NILP (w->buffer) || NILP (XBUFFER (w->buffer)->name))
6085 /* Else unless window has a live buffer, get one. */
6087 w->buffer = Fcdr (Fcar (Vbuffer_alist));
6088 /* This will set the markers to beginning of visible
6089 range. */
6090 set_marker_restricted (w->start, make_number (0), w->buffer);
6091 set_marker_restricted (w->pointm, make_number (0),w->buffer);
6092 w->start_at_line_beg = Qt;
6094 else
6095 /* Keeping window's old buffer; make sure the markers
6096 are real. */
6098 /* Set window markers at start of visible range. */
6099 if (XMARKER (w->start)->buffer == 0)
6100 set_marker_restricted (w->start, make_number (0),
6101 w->buffer);
6102 if (XMARKER (w->pointm)->buffer == 0)
6103 set_marker_restricted_both (w->pointm, w->buffer,
6104 BUF_PT (XBUFFER (w->buffer)),
6105 BUF_PT_BYTE (XBUFFER (w->buffer)));
6106 w->start_at_line_beg = Qt;
6111 FRAME_ROOT_WINDOW (f) = data->root_window;
6113 /* Arrange *not* to restore point in the buffer that was
6114 current when the window configuration was saved. */
6115 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
6116 set_marker_restricted (XWINDOW (data->current_window)->pointm,
6117 make_number (old_point),
6118 XWINDOW (data->current_window)->buffer);
6120 /* In the following call to `select-window, prevent "swapping
6121 out point" in the old selected window using the buffer that
6122 has been restored into it. We already swapped out that point
6123 from that window's old buffer. */
6124 select_window (data->current_window, Qnil, 1);
6125 XBUFFER (XWINDOW (selected_window)->buffer)->last_selected_window
6126 = selected_window;
6128 if (NILP (data->focus_frame)
6129 || (FRAMEP (data->focus_frame)
6130 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
6131 Fredirect_frame_focus (frame, data->focus_frame);
6133 /* Set the screen height to the value it had before this function. */
6134 if (previous_frame_lines != FRAME_LINES (f)
6135 || previous_frame_cols != FRAME_COLS (f))
6136 change_frame_size (f, previous_frame_lines, previous_frame_cols,
6137 0, 0, 0);
6138 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
6139 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
6140 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
6141 make_number (0));
6142 #ifdef HAVE_WINDOW_SYSTEM
6143 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
6144 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
6145 make_number (0));
6146 #endif
6147 #endif
6149 /* Now, free glyph matrices in windows that were not reused. */
6150 for (i = n = 0; i < n_leaf_windows; ++i)
6152 if (NILP (leaf_windows[i]->buffer))
6154 /* Assert it's not reused as a combination. */
6155 xassert (NILP (leaf_windows[i]->hchild)
6156 && NILP (leaf_windows[i]->vchild));
6157 free_window_matrices (leaf_windows[i]);
6159 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
6160 ++n;
6163 adjust_glyphs (f);
6165 UNBLOCK_INPUT;
6167 /* Fselect_window will have made f the selected frame, so we
6168 reselect the proper frame here. Fhandle_switch_frame will change the
6169 selected window too, but that doesn't make the call to
6170 Fselect_window above totally superfluous; it still sets f's
6171 selected window. */
6172 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
6173 do_switch_frame (data->selected_frame, 0, 0, Qnil);
6175 run_window_configuration_change_hook (f);
6178 if (!NILP (new_current_buffer))
6179 Fset_buffer (new_current_buffer);
6181 Vminibuf_scroll_window = data->minibuf_scroll_window;
6182 minibuf_selected_window = data->minibuf_selected_window;
6184 return (FRAME_LIVE_P (f) ? Qt : Qnil);
6187 /* Mark all windows now on frame as deleted
6188 by setting their buffers to nil. */
6190 void
6191 delete_all_subwindows (register struct window *w)
6193 if (!NILP (w->next))
6194 delete_all_subwindows (XWINDOW (w->next));
6195 if (!NILP (w->vchild))
6196 delete_all_subwindows (XWINDOW (w->vchild));
6197 if (!NILP (w->hchild))
6198 delete_all_subwindows (XWINDOW (w->hchild));
6200 w->total_lines = w->buffer; /* See Fset_window_configuration for excuse. */
6202 if (!NILP (w->buffer))
6203 unshow_buffer (w);
6205 /* We set all three of these fields to nil, to make sure that we can
6206 distinguish this dead window from any live window. Live leaf
6207 windows will have buffer set, and combination windows will have
6208 vchild or hchild set. */
6209 w->buffer = Qnil;
6210 w->vchild = Qnil;
6211 w->hchild = Qnil;
6213 Vwindow_list = Qnil;
6216 static int
6217 count_windows (register struct window *window)
6219 register int count = 1;
6220 if (!NILP (window->next))
6221 count += count_windows (XWINDOW (window->next));
6222 if (!NILP (window->vchild))
6223 count += count_windows (XWINDOW (window->vchild));
6224 if (!NILP (window->hchild))
6225 count += count_windows (XWINDOW (window->hchild));
6226 return count;
6230 /* Fill vector FLAT with leaf windows under W, starting at index I.
6231 Value is last index + 1. */
6233 static int
6234 get_leaf_windows (struct window *w, struct window **flat, int i)
6236 while (w)
6238 if (!NILP (w->hchild))
6239 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
6240 else if (!NILP (w->vchild))
6241 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
6242 else
6243 flat[i++] = w;
6245 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6248 return i;
6252 /* Return a pointer to the glyph W's physical cursor is on. Value is
6253 null if W's current matrix is invalid, so that no meaningfull glyph
6254 can be returned. */
6256 struct glyph *
6257 get_phys_cursor_glyph (struct window *w)
6259 struct glyph_row *row;
6260 struct glyph *glyph;
6262 if (w->phys_cursor.vpos >= 0
6263 && w->phys_cursor.vpos < w->current_matrix->nrows
6264 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
6265 row->enabled_p)
6266 && row->used[TEXT_AREA] > w->phys_cursor.hpos)
6267 glyph = row->glyphs[TEXT_AREA] + w->phys_cursor.hpos;
6268 else
6269 glyph = NULL;
6271 return glyph;
6275 static int
6276 save_window_save (Lisp_Object window, struct Lisp_Vector *vector, int i)
6278 register struct saved_window *p;
6279 register struct window *w;
6280 register Lisp_Object tem;
6282 for (;!NILP (window); window = w->next)
6284 p = SAVED_WINDOW_N (vector, i);
6285 w = XWINDOW (window);
6287 XSETFASTINT (w->temslot, i); i++;
6288 p->window = window;
6289 p->buffer = w->buffer;
6290 p->left_col = w->left_col;
6291 p->top_line = w->top_line;
6292 p->total_cols = w->total_cols;
6293 p->total_lines = w->total_lines;
6294 p->hscroll = w->hscroll;
6295 p->min_hscroll = w->min_hscroll;
6296 p->display_table = w->display_table;
6297 p->orig_top_line = w->orig_top_line;
6298 p->orig_total_lines = w->orig_total_lines;
6299 p->left_margin_cols = w->left_margin_cols;
6300 p->right_margin_cols = w->right_margin_cols;
6301 p->left_fringe_width = w->left_fringe_width;
6302 p->right_fringe_width = w->right_fringe_width;
6303 p->fringes_outside_margins = w->fringes_outside_margins;
6304 p->scroll_bar_width = w->scroll_bar_width;
6305 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
6306 p->dedicated = w->dedicated;
6307 p->resize_proportionally = w->resize_proportionally;
6308 if (!NILP (w->buffer))
6310 /* Save w's value of point in the window configuration.
6311 If w is the selected window, then get the value of point
6312 from the buffer; pointm is garbage in the selected window. */
6313 if (EQ (window, selected_window))
6315 p->pointm = Fmake_marker ();
6316 set_marker_both (p->pointm, w->buffer,
6317 BUF_PT (XBUFFER (w->buffer)),
6318 BUF_PT_BYTE (XBUFFER (w->buffer)));
6320 else
6321 p->pointm = Fcopy_marker (w->pointm, Qnil);
6323 p->start = Fcopy_marker (w->start, Qnil);
6324 p->start_at_line_beg = w->start_at_line_beg;
6326 tem = XBUFFER (w->buffer)->mark;
6327 p->mark = Fcopy_marker (tem, Qnil);
6329 else
6331 p->pointm = Qnil;
6332 p->start = Qnil;
6333 p->mark = Qnil;
6334 p->start_at_line_beg = Qnil;
6337 if (NILP (w->parent))
6338 p->parent = Qnil;
6339 else
6340 p->parent = XWINDOW (w->parent)->temslot;
6342 if (NILP (w->prev))
6343 p->prev = Qnil;
6344 else
6345 p->prev = XWINDOW (w->prev)->temslot;
6347 if (!NILP (w->vchild))
6348 i = save_window_save (w->vchild, vector, i);
6349 if (!NILP (w->hchild))
6350 i = save_window_save (w->hchild, vector, i);
6353 return i;
6356 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
6357 Scurrent_window_configuration, 0, 1, 0,
6358 doc: /* Return an object representing the current window configuration of FRAME.
6359 If FRAME is nil or omitted, use the selected frame.
6360 This describes the number of windows, their sizes and current buffers,
6361 and for each displayed buffer, where display starts, and the positions of
6362 point and mark. An exception is made for point in the current buffer:
6363 its value is -not- saved.
6364 This also records the currently selected frame, and FRAME's focus
6365 redirection (see `redirect-frame-focus'). */)
6366 (Lisp_Object frame)
6368 register Lisp_Object tem;
6369 register int n_windows;
6370 register struct save_window_data *data;
6371 register int i;
6372 FRAME_PTR f;
6374 if (NILP (frame))
6375 frame = selected_frame;
6376 CHECK_LIVE_FRAME (frame);
6377 f = XFRAME (frame);
6379 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6380 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
6381 PVEC_WINDOW_CONFIGURATION);
6383 data->frame_cols = FRAME_COLS (f);
6384 data->frame_lines = FRAME_LINES (f);
6385 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6386 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6387 data->selected_frame = selected_frame;
6388 data->current_window = FRAME_SELECTED_WINDOW (f);
6389 XSETBUFFER (data->current_buffer, current_buffer);
6390 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
6391 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
6392 data->root_window = FRAME_ROOT_WINDOW (f);
6393 data->focus_frame = FRAME_FOCUS_FRAME (f);
6394 tem = Fmake_vector (make_number (n_windows), Qnil);
6395 data->saved_windows = tem;
6396 for (i = 0; i < n_windows; i++)
6397 XVECTOR (tem)->contents[i]
6398 = Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil);
6399 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
6400 XSETWINDOW_CONFIGURATION (tem, data);
6401 return (tem);
6404 DEFUN ("save-window-excursion", Fsave_window_excursion, Ssave_window_excursion,
6405 0, UNEVALLED, 0,
6406 doc: /* Execute BODY, preserving window sizes and contents.
6407 Return the value of the last form in BODY.
6408 Restore which buffer appears in which window, where display starts,
6409 and the value of point and mark for each window.
6410 Also restore the choice of selected window.
6411 Also restore which buffer is current.
6412 Does not restore the value of point in current buffer.
6413 usage: (save-window-excursion BODY...) */)
6414 (Lisp_Object args)
6416 register Lisp_Object val;
6417 register int count = SPECPDL_INDEX ();
6419 record_unwind_protect (Fset_window_configuration,
6420 Fcurrent_window_configuration (Qnil));
6421 val = Fprogn (args);
6422 return unbind_to (count, val);
6427 /***********************************************************************
6428 Window Split Tree
6429 ***********************************************************************/
6431 static Lisp_Object
6432 window_tree (struct window *w)
6434 Lisp_Object tail = Qnil;
6435 Lisp_Object result = Qnil;
6437 while (w)
6439 Lisp_Object wn;
6441 XSETWINDOW (wn, w);
6442 if (!NILP (w->hchild))
6443 wn = Fcons (Qnil, Fcons (Fwindow_edges (wn),
6444 window_tree (XWINDOW (w->hchild))));
6445 else if (!NILP (w->vchild))
6446 wn = Fcons (Qt, Fcons (Fwindow_edges (wn),
6447 window_tree (XWINDOW (w->vchild))));
6449 if (NILP (result))
6451 result = tail = Fcons (wn, Qnil);
6453 else
6455 XSETCDR (tail, Fcons (wn, Qnil));
6456 tail = XCDR (tail);
6459 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6462 return result;
6467 DEFUN ("window-tree", Fwindow_tree, Swindow_tree,
6468 0, 1, 0,
6469 doc: /* Return the window tree for frame FRAME.
6471 The return value is a list of the form (ROOT MINI), where ROOT
6472 represents the window tree of the frame's root window, and MINI
6473 is the frame's minibuffer window.
6475 If the root window is not split, ROOT is the root window itself.
6476 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil for a
6477 horizontal split, and t for a vertical split, EDGES gives the combined
6478 size and position of the subwindows in the split, and the rest of the
6479 elements are the subwindows in the split. Each of the subwindows may
6480 again be a window or a list representing a window split, and so on.
6481 EDGES is a list \(LEFT TOP RIGHT BOTTOM) as returned by `window-edges'.
6483 If FRAME is nil or omitted, return information on the currently
6484 selected frame. */)
6485 (Lisp_Object frame)
6487 FRAME_PTR f;
6489 if (NILP (frame))
6490 frame = selected_frame;
6492 CHECK_FRAME (frame);
6493 f = XFRAME (frame);
6495 if (!FRAME_LIVE_P (f))
6496 return Qnil;
6498 return window_tree (XWINDOW (FRAME_ROOT_WINDOW (f)));
6502 /***********************************************************************
6503 Marginal Areas
6504 ***********************************************************************/
6506 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
6507 2, 3, 0,
6508 doc: /* Set width of marginal areas of window WINDOW.
6509 If WINDOW is nil, set margins of the currently selected window.
6510 Second arg LEFT-WIDTH specifies the number of character cells to
6511 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6512 does the same for the right marginal area. A nil width parameter
6513 means no margin. */)
6514 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width)
6516 struct window *w = decode_window (window);
6518 /* Translate negative or zero widths to nil.
6519 Margins that are too wide have to be checked elsewhere. */
6521 if (!NILP (left_width))
6523 CHECK_NUMBER (left_width);
6524 if (XINT (left_width) <= 0)
6525 left_width = Qnil;
6528 if (!NILP (right_width))
6530 CHECK_NUMBER (right_width);
6531 if (XINT (right_width) <= 0)
6532 right_width = Qnil;
6535 if (!EQ (w->left_margin_cols, left_width)
6536 || !EQ (w->right_margin_cols, right_width))
6538 w->left_margin_cols = left_width;
6539 w->right_margin_cols = right_width;
6541 adjust_window_margins (w);
6543 ++windows_or_buffers_changed;
6544 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6547 return Qnil;
6551 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
6552 0, 1, 0,
6553 doc: /* Get width of marginal areas of window WINDOW.
6554 If WINDOW is omitted or nil, use the currently selected window.
6555 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6556 If a marginal area does not exist, its width will be returned
6557 as nil. */)
6558 (Lisp_Object window)
6560 struct window *w = decode_window (window);
6561 return Fcons (w->left_margin_cols, w->right_margin_cols);
6566 /***********************************************************************
6567 Fringes
6568 ***********************************************************************/
6570 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6571 2, 4, 0,
6572 doc: /* Set the fringe widths of window WINDOW.
6573 If WINDOW is nil, set the fringe widths of the currently selected
6574 window.
6575 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6576 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6577 fringe width. If a fringe width arg is nil, that means to use the
6578 frame's default fringe width. Default fringe widths can be set with
6579 the command `set-fringe-style'.
6580 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6581 outside of the display margins. By default, fringes are drawn between
6582 display marginal areas and the text area. */)
6583 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width, Lisp_Object outside_margins)
6585 struct window *w = decode_window (window);
6587 if (!NILP (left_width))
6588 CHECK_NATNUM (left_width);
6589 if (!NILP (right_width))
6590 CHECK_NATNUM (right_width);
6592 /* Do nothing on a tty. */
6593 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6594 && (!EQ (w->left_fringe_width, left_width)
6595 || !EQ (w->right_fringe_width, right_width)
6596 || !EQ (w->fringes_outside_margins, outside_margins)))
6598 w->left_fringe_width = left_width;
6599 w->right_fringe_width = right_width;
6600 w->fringes_outside_margins = outside_margins;
6602 adjust_window_margins (w);
6604 clear_glyph_matrix (w->current_matrix);
6605 w->window_end_valid = Qnil;
6607 ++windows_or_buffers_changed;
6608 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6611 return Qnil;
6615 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6616 0, 1, 0,
6617 doc: /* Get width of fringes of window WINDOW.
6618 If WINDOW is omitted or nil, use the currently selected window.
6619 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6620 (Lisp_Object window)
6622 struct window *w = decode_window (window);
6624 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6625 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6626 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6627 ? Qt : Qnil), Qnil)));
6632 /***********************************************************************
6633 Scroll bars
6634 ***********************************************************************/
6636 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars, Sset_window_scroll_bars,
6637 2, 4, 0,
6638 doc: /* Set width and type of scroll bars of window WINDOW.
6639 If window is nil, set scroll bars of the currently selected window.
6640 Second parameter WIDTH specifies the pixel width for the scroll bar;
6641 this is automatically adjusted to a multiple of the frame column width.
6642 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6643 bar: left, right, or nil.
6644 If WIDTH is nil, use the frame's scroll-bar width.
6645 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6646 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6647 (Lisp_Object window, Lisp_Object width, Lisp_Object vertical_type, Lisp_Object horizontal_type)
6649 struct window *w = decode_window (window);
6651 if (!NILP (width))
6653 CHECK_NATNUM (width);
6655 if (XINT (width) == 0)
6656 vertical_type = Qnil;
6659 if (!(NILP (vertical_type)
6660 || EQ (vertical_type, Qleft)
6661 || EQ (vertical_type, Qright)
6662 || EQ (vertical_type, Qt)))
6663 error ("Invalid type of vertical scroll bar");
6665 if (!EQ (w->scroll_bar_width, width)
6666 || !EQ (w->vertical_scroll_bar_type, vertical_type))
6668 w->scroll_bar_width = width;
6669 w->vertical_scroll_bar_type = vertical_type;
6671 adjust_window_margins (w);
6673 clear_glyph_matrix (w->current_matrix);
6674 w->window_end_valid = Qnil;
6676 ++windows_or_buffers_changed;
6677 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6680 return Qnil;
6684 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
6685 0, 1, 0,
6686 doc: /* Get width and type of scroll bars of window WINDOW.
6687 If WINDOW is omitted or nil, use the currently selected window.
6688 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6689 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6690 value. */)
6691 (Lisp_Object window)
6693 struct window *w = decode_window (window);
6694 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6695 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6696 : WINDOW_SCROLL_BAR_AREA_WIDTH (w))),
6697 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w)),
6698 Fcons (w->vertical_scroll_bar_type,
6699 Fcons (Qnil, Qnil))));
6704 /***********************************************************************
6705 Smooth scrolling
6706 ***********************************************************************/
6708 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
6709 doc: /* Return the amount by which WINDOW is scrolled vertically.
6710 Use the selected window if WINDOW is nil or omitted.
6711 Normally, value is a multiple of the canonical character height of WINDOW;
6712 optional second arg PIXELS-P means value is measured in pixels. */)
6713 (Lisp_Object window, Lisp_Object pixels_p)
6715 Lisp_Object result;
6716 struct frame *f;
6717 struct window *w;
6719 if (NILP (window))
6720 window = selected_window;
6721 else
6722 CHECK_WINDOW (window);
6723 w = XWINDOW (window);
6724 f = XFRAME (w->frame);
6726 if (FRAME_WINDOW_P (f))
6727 result = (NILP (pixels_p)
6728 ? FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll)
6729 : make_number (-w->vscroll));
6730 else
6731 result = make_number (0);
6732 return result;
6736 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
6737 2, 3, 0,
6738 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
6739 WINDOW nil means use the selected window. Normally, VSCROLL is a
6740 non-negative multiple of the canonical character height of WINDOW;
6741 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
6742 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
6743 corresponds to an integral number of pixels. The return value is the
6744 result of this rounding.
6745 If PIXELS-P is non-nil, the return value is VSCROLL. */)
6746 (Lisp_Object window, Lisp_Object vscroll, Lisp_Object pixels_p)
6748 struct window *w;
6749 struct frame *f;
6751 if (NILP (window))
6752 window = selected_window;
6753 else
6754 CHECK_WINDOW (window);
6755 CHECK_NUMBER_OR_FLOAT (vscroll);
6757 w = XWINDOW (window);
6758 f = XFRAME (w->frame);
6760 if (FRAME_WINDOW_P (f))
6762 int old_dy = w->vscroll;
6764 w->vscroll = - (NILP (pixels_p)
6765 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
6766 : XFLOATINT (vscroll));
6767 w->vscroll = min (w->vscroll, 0);
6769 if (w->vscroll != old_dy)
6771 /* Adjust glyph matrix of the frame if the virtual display
6772 area becomes larger than before. */
6773 if (w->vscroll < 0 && w->vscroll < old_dy)
6774 adjust_glyphs (f);
6776 /* Prevent redisplay shortcuts. */
6777 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
6781 return Fwindow_vscroll (window, pixels_p);
6785 /* Call FN for all leaf windows on frame F. FN is called with the
6786 first argument being a pointer to the leaf window, and with
6787 additional argument USER_DATA. Stops when FN returns 0. */
6789 static void
6790 foreach_window (struct frame *f, int (*fn) (struct window *, void *),
6791 void *user_data)
6793 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6794 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
6795 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
6799 /* Helper function for foreach_window. Call FN for all leaf windows
6800 reachable from W. FN is called with the first argument being a
6801 pointer to the leaf window, and with additional argument USER_DATA.
6802 Stop when FN returns 0. Value is 0 if stopped by FN. */
6804 static int
6805 foreach_window_1 (struct window *w, int (*fn) (struct window *, void *), void *user_data)
6807 int cont;
6809 for (cont = 1; w && cont;)
6811 if (!NILP (w->hchild))
6812 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
6813 else if (!NILP (w->vchild))
6814 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
6815 else
6816 cont = fn (w, user_data);
6818 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6821 return cont;
6825 /* Freeze or unfreeze the window start of W unless it is a
6826 mini-window or the selected window. FREEZE_P non-null means freeze
6827 the window start. */
6829 static int
6830 freeze_window_start (struct window *w, void *freeze_p)
6832 if (MINI_WINDOW_P (w)
6833 || (WINDOWP (selected_window) /* Can be nil in corner cases. */
6834 && (w == XWINDOW (selected_window)
6835 || (MINI_WINDOW_P (XWINDOW (selected_window))
6836 && ! NILP (Vminibuf_scroll_window)
6837 && w == XWINDOW (Vminibuf_scroll_window)))))
6838 freeze_p = NULL;
6840 w->frozen_window_start_p = freeze_p != NULL;
6841 return 1;
6845 /* Freeze or unfreeze the window starts of all leaf windows on frame
6846 F, except the selected window and a mini-window. FREEZE_P non-zero
6847 means freeze the window start. */
6849 void
6850 freeze_window_starts (struct frame *f, int freeze_p)
6852 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
6856 /***********************************************************************
6857 Initialization
6858 ***********************************************************************/
6860 /* Return 1 if window configurations C1 and C2
6861 describe the same state of affairs. This is used by Fequal. */
6864 compare_window_configurations (Lisp_Object c1, Lisp_Object c2, int ignore_positions)
6866 register struct save_window_data *d1, *d2;
6867 struct Lisp_Vector *sw1, *sw2;
6868 int i;
6870 CHECK_WINDOW_CONFIGURATION (c1);
6871 CHECK_WINDOW_CONFIGURATION (c2);
6873 d1 = (struct save_window_data *) XVECTOR (c1);
6874 d2 = (struct save_window_data *) XVECTOR (c2);
6875 sw1 = XVECTOR (d1->saved_windows);
6876 sw2 = XVECTOR (d2->saved_windows);
6878 if (d1->frame_cols != d2->frame_cols)
6879 return 0;
6880 if (d1->frame_lines != d2->frame_lines)
6881 return 0;
6882 if (d1->frame_menu_bar_lines != d2->frame_menu_bar_lines)
6883 return 0;
6884 if (! EQ (d1->selected_frame, d2->selected_frame))
6885 return 0;
6886 /* Don't compare the current_window field directly.
6887 Instead see w1_is_current and w2_is_current, below. */
6888 if (! EQ (d1->current_buffer, d2->current_buffer))
6889 return 0;
6890 if (! ignore_positions)
6892 if (! EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window))
6893 return 0;
6894 if (! EQ (d1->minibuf_selected_window, d2->minibuf_selected_window))
6895 return 0;
6897 /* Don't compare the root_window field.
6898 We don't require the two configurations
6899 to use the same window object,
6900 and the two root windows must be equivalent
6901 if everything else compares equal. */
6902 if (! EQ (d1->focus_frame, d2->focus_frame))
6903 return 0;
6905 /* Verify that the two confis have the same number of windows. */
6906 if (sw1->size != sw2->size)
6907 return 0;
6909 for (i = 0; i < sw1->size; i++)
6911 struct saved_window *p1, *p2;
6912 int w1_is_current, w2_is_current;
6914 p1 = SAVED_WINDOW_N (sw1, i);
6915 p2 = SAVED_WINDOW_N (sw2, i);
6917 /* Verify that the current windows in the two
6918 configurations correspond to each other. */
6919 w1_is_current = EQ (d1->current_window, p1->window);
6920 w2_is_current = EQ (d2->current_window, p2->window);
6922 if (w1_is_current != w2_is_current)
6923 return 0;
6925 /* Verify that the corresponding windows do match. */
6926 if (! EQ (p1->buffer, p2->buffer))
6927 return 0;
6928 if (! EQ (p1->left_col, p2->left_col))
6929 return 0;
6930 if (! EQ (p1->top_line, p2->top_line))
6931 return 0;
6932 if (! EQ (p1->total_cols, p2->total_cols))
6933 return 0;
6934 if (! EQ (p1->total_lines, p2->total_lines))
6935 return 0;
6936 if (! EQ (p1->display_table, p2->display_table))
6937 return 0;
6938 if (! EQ (p1->parent, p2->parent))
6939 return 0;
6940 if (! EQ (p1->prev, p2->prev))
6941 return 0;
6942 if (! ignore_positions)
6944 if (! EQ (p1->hscroll, p2->hscroll))
6945 return 0;
6946 if (!EQ (p1->min_hscroll, p2->min_hscroll))
6947 return 0;
6948 if (! EQ (p1->start_at_line_beg, p2->start_at_line_beg))
6949 return 0;
6950 if (NILP (Fequal (p1->start, p2->start)))
6951 return 0;
6952 if (NILP (Fequal (p1->pointm, p2->pointm)))
6953 return 0;
6954 if (NILP (Fequal (p1->mark, p2->mark)))
6955 return 0;
6957 if (! EQ (p1->left_margin_cols, p2->left_margin_cols))
6958 return 0;
6959 if (! EQ (p1->right_margin_cols, p2->right_margin_cols))
6960 return 0;
6961 if (! EQ (p1->left_fringe_width, p2->left_fringe_width))
6962 return 0;
6963 if (! EQ (p1->right_fringe_width, p2->right_fringe_width))
6964 return 0;
6965 if (! EQ (p1->fringes_outside_margins, p2->fringes_outside_margins))
6966 return 0;
6967 if (! EQ (p1->scroll_bar_width, p2->scroll_bar_width))
6968 return 0;
6969 if (! EQ (p1->vertical_scroll_bar_type, p2->vertical_scroll_bar_type))
6970 return 0;
6973 return 1;
6976 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
6977 Scompare_window_configurations, 2, 2, 0,
6978 doc: /* Compare two window configurations as regards the structure of windows.
6979 This function ignores details such as the values of point and mark
6980 and scrolling positions. */)
6981 (Lisp_Object x, Lisp_Object y)
6983 if (compare_window_configurations (x, y, 1))
6984 return Qt;
6985 return Qnil;
6988 void
6989 init_window_once (void)
6991 struct frame *f = make_initial_frame ();
6992 XSETFRAME (selected_frame, f);
6993 Vterminal_frame = selected_frame;
6994 minibuf_window = f->minibuffer_window;
6995 selected_window = f->selected_window;
6996 last_nonminibuf_frame = f;
6998 window_initialized = 1;
7001 void
7002 init_window (void)
7004 Vwindow_list = Qnil;
7007 void
7008 syms_of_window (void)
7010 Qscroll_up = intern_c_string ("scroll-up");
7011 staticpro (&Qscroll_up);
7013 Qscroll_down = intern_c_string ("scroll-down");
7014 staticpro (&Qscroll_down);
7016 Qscroll_command = intern_c_string ("scroll-command");
7017 staticpro (&Qscroll_command);
7019 Fput (Qscroll_up, Qscroll_command, Qt);
7020 Fput (Qscroll_down, Qscroll_command, Qt);
7022 Qwindow_size_fixed = intern_c_string ("window-size-fixed");
7023 staticpro (&Qwindow_size_fixed);
7024 Fset (Qwindow_size_fixed, Qnil);
7026 staticpro (&Qwindow_configuration_change_hook);
7027 Qwindow_configuration_change_hook
7028 = intern_c_string ("window-configuration-change-hook");
7030 Qwindowp = intern_c_string ("windowp");
7031 staticpro (&Qwindowp);
7033 Qwindow_configuration_p = intern_c_string ("window-configuration-p");
7034 staticpro (&Qwindow_configuration_p);
7036 Qwindow_live_p = intern_c_string ("window-live-p");
7037 staticpro (&Qwindow_live_p);
7039 Qdisplay_buffer = intern_c_string ("display-buffer");
7040 staticpro (&Qdisplay_buffer);
7042 Qtemp_buffer_show_hook = intern_c_string ("temp-buffer-show-hook");
7043 staticpro (&Qtemp_buffer_show_hook);
7045 staticpro (&Vwindow_list);
7047 minibuf_selected_window = Qnil;
7048 staticpro (&minibuf_selected_window);
7050 window_scroll_pixel_based_preserve_x = -1;
7051 window_scroll_pixel_based_preserve_y = -1;
7052 window_scroll_preserve_hpos = -1;
7053 window_scroll_preserve_vpos = -1;
7055 DEFVAR_LISP ("temp-buffer-show-function", Vtemp_buffer_show_function,
7056 doc: /* Non-nil means call as function to display a help buffer.
7057 The function is called with one argument, the buffer to be displayed.
7058 Used by `with-output-to-temp-buffer'.
7059 If this function is used, then it must do the entire job of showing
7060 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
7061 Vtemp_buffer_show_function = Qnil;
7063 DEFVAR_LISP ("minibuffer-scroll-window", Vminibuf_scroll_window,
7064 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
7065 Vminibuf_scroll_window = Qnil;
7067 DEFVAR_BOOL ("mode-line-in-non-selected-windows", mode_line_in_non_selected_windows,
7068 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
7069 If the minibuffer is active, the `minibuffer-scroll-window' mode line
7070 is displayed in the `mode-line' face. */);
7071 mode_line_in_non_selected_windows = 1;
7073 DEFVAR_LISP ("other-window-scroll-buffer", Vother_window_scroll_buffer,
7074 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
7075 Vother_window_scroll_buffer = Qnil;
7077 DEFVAR_BOOL ("auto-window-vscroll", auto_window_vscroll_p,
7078 doc: /* *Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
7079 auto_window_vscroll_p = 1;
7081 DEFVAR_INT ("next-screen-context-lines", next_screen_context_lines,
7082 doc: /* *Number of lines of continuity when scrolling by screenfuls. */);
7083 next_screen_context_lines = 2;
7085 DEFVAR_INT ("window-min-height", window_min_height,
7086 doc: /* Allow deleting windows less than this tall.
7087 The value is measured in line units. If a window wants a modeline it
7088 is counted as one line.
7090 Emacs honors settings of this variable when enlarging or shrinking
7091 windows vertically. A value less than 1 is invalid. */);
7092 window_min_height = 4;
7094 DEFVAR_INT ("window-min-width", window_min_width,
7095 doc: /* Allow deleting windows less than this wide.
7096 The value is measured in characters and includes any fringes or
7097 the scrollbar.
7099 Emacs honors settings of this variable when enlarging or shrinking
7100 windows horizontally. A value less than 2 is invalid. */);
7101 window_min_width = 10;
7103 DEFVAR_LISP ("scroll-preserve-screen-position",
7104 Vscroll_preserve_screen_position,
7105 doc: /* *Controls if scroll commands move point to keep its screen position unchanged.
7106 A value of nil means point does not keep its screen position except
7107 at the scroll margin or window boundary respectively.
7108 A value of t means point keeps its screen position if the scroll
7109 command moved it vertically out of the window, e.g. when scrolling
7110 by full screens.
7111 Any other value means point always keeps its screen position.
7112 Scroll commands should have the `scroll-command' property
7113 on their symbols to be controlled by this variable. */);
7114 Vscroll_preserve_screen_position = Qnil;
7116 DEFVAR_LISP ("window-point-insertion-type", Vwindow_point_insertion_type,
7117 doc: /* Type of marker to use for `window-point'. */);
7118 Vwindow_point_insertion_type = Qnil;
7120 DEFVAR_LISP ("window-configuration-change-hook",
7121 Vwindow_configuration_change_hook,
7122 doc: /* Functions to call when window configuration changes.
7123 The buffer-local part is run once per window, with the relevant window
7124 selected; while the global part is run only once for the modified frame,
7125 with the relevant frame selected. */);
7126 Vwindow_configuration_change_hook = Qnil;
7128 DEFVAR_LISP ("recenter-redisplay", Vrecenter_redisplay,
7129 doc: /* If non-nil, then the `recenter' command with a nil argument
7130 will redraw the entire frame; the special value `tty' causes the
7131 frame to be redrawn only if it is a tty frame. */);
7132 Vrecenter_redisplay = Qtty;
7135 defsubr (&Sselected_window);
7136 defsubr (&Sminibuffer_window);
7137 defsubr (&Swindow_minibuffer_p);
7138 defsubr (&Swindowp);
7139 defsubr (&Swindow_live_p);
7140 defsubr (&Spos_visible_in_window_p);
7141 defsubr (&Swindow_line_height);
7142 defsubr (&Swindow_buffer);
7143 defsubr (&Swindow_height);
7144 defsubr (&Swindow_width);
7145 defsubr (&Swindow_full_width_p);
7146 defsubr (&Swindow_hscroll);
7147 defsubr (&Sset_window_hscroll);
7148 defsubr (&Swindow_redisplay_end_trigger);
7149 defsubr (&Sset_window_redisplay_end_trigger);
7150 defsubr (&Swindow_edges);
7151 defsubr (&Swindow_pixel_edges);
7152 defsubr (&Swindow_absolute_pixel_edges);
7153 defsubr (&Swindow_inside_edges);
7154 defsubr (&Swindow_inside_pixel_edges);
7155 defsubr (&Swindow_inside_absolute_pixel_edges);
7156 defsubr (&Scoordinates_in_window_p);
7157 defsubr (&Swindow_at);
7158 defsubr (&Swindow_point);
7159 defsubr (&Swindow_start);
7160 defsubr (&Swindow_end);
7161 defsubr (&Sset_window_point);
7162 defsubr (&Sset_window_start);
7163 defsubr (&Swindow_dedicated_p);
7164 defsubr (&Sset_window_dedicated_p);
7165 defsubr (&Swindow_display_table);
7166 defsubr (&Sset_window_display_table);
7167 defsubr (&Snext_window);
7168 defsubr (&Sprevious_window);
7169 defsubr (&Sother_window);
7170 defsubr (&Sget_lru_window);
7171 defsubr (&Swindow_use_time);
7172 defsubr (&Sget_largest_window);
7173 defsubr (&Sget_buffer_window);
7174 defsubr (&Sdelete_other_windows);
7175 defsubr (&Sdelete_windows_on);
7176 defsubr (&Sreplace_buffer_in_windows);
7177 defsubr (&Sdelete_window);
7178 defsubr (&Sset_window_buffer);
7179 defsubr (&Sselect_window);
7180 defsubr (&Sforce_window_update);
7181 defsubr (&Ssplit_window);
7182 defsubr (&Senlarge_window);
7183 defsubr (&Sshrink_window);
7184 defsubr (&Sadjust_window_trailing_edge);
7185 defsubr (&Sscroll_up);
7186 defsubr (&Sscroll_down);
7187 defsubr (&Sscroll_left);
7188 defsubr (&Sscroll_right);
7189 defsubr (&Sother_window_for_scrolling);
7190 defsubr (&Sscroll_other_window);
7191 defsubr (&Sminibuffer_selected_window);
7192 defsubr (&Srecenter);
7193 defsubr (&Swindow_text_height);
7194 defsubr (&Smove_to_window_line);
7195 defsubr (&Swindow_configuration_p);
7196 defsubr (&Swindow_configuration_frame);
7197 defsubr (&Sset_window_configuration);
7198 defsubr (&Scurrent_window_configuration);
7199 defsubr (&Ssave_window_excursion);
7200 defsubr (&Swindow_tree);
7201 defsubr (&Sset_window_margins);
7202 defsubr (&Swindow_margins);
7203 defsubr (&Sset_window_fringes);
7204 defsubr (&Swindow_fringes);
7205 defsubr (&Sset_window_scroll_bars);
7206 defsubr (&Swindow_scroll_bars);
7207 defsubr (&Swindow_vscroll);
7208 defsubr (&Sset_window_vscroll);
7209 defsubr (&Scompare_window_configurations);
7210 defsubr (&Swindow_list);
7211 defsubr (&Swindow_parameters);
7212 defsubr (&Swindow_parameter);
7213 defsubr (&Sset_window_parameter);
7217 void
7218 keys_of_window (void)
7220 initial_define_key (control_x_map, '1', "delete-other-windows");
7221 initial_define_key (control_x_map, '2', "split-window");
7222 initial_define_key (control_x_map, '0', "delete-window");
7223 initial_define_key (control_x_map, 'o', "other-window");
7224 initial_define_key (control_x_map, '^', "enlarge-window");
7225 initial_define_key (control_x_map, '<', "scroll-left");
7226 initial_define_key (control_x_map, '>', "scroll-right");
7228 initial_define_key (global_map, Ctl ('V'), "scroll-up-command");
7229 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
7230 initial_define_key (meta_map, 'v', "scroll-down-command");