* net/tramp-sh.el (tramp-find-shell): Apply workaround also for
[emacs.git] / src / window.c
blobbc9f31e03e8c4906d03c09f647fa7972ca61ce34
1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985-1987, 1993-1998, 2000-2011
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <stdio.h>
23 #include <setjmp.h>
25 #include "lisp.h"
26 #include "buffer.h"
27 #include "keyboard.h"
28 #include "keymap.h"
29 #include "frame.h"
30 #include "window.h"
31 #include "commands.h"
32 #include "indent.h"
33 #include "termchar.h"
34 #include "disptab.h"
35 #include "dispextern.h"
36 #include "blockinput.h"
37 #include "intervals.h"
38 #include "termhooks.h" /* For FRAME_TERMINAL. */
40 #ifdef HAVE_X_WINDOWS
41 #include "xterm.h"
42 #endif /* HAVE_X_WINDOWS */
43 #ifdef WINDOWSNT
44 #include "w32term.h"
45 #endif
46 #ifdef MSDOS
47 #include "msdos.h"
48 #endif
49 #ifdef HAVE_NS
50 #include "nsterm.h"
51 #endif
53 Lisp_Object Qwindowp, Qwindow_live_p;
54 static Lisp_Object Qwindow_configuration_p;
55 static Lisp_Object Qdisplay_buffer;
56 static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
57 static 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 static 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 static 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,
240 Swindow_minibuffer_p, 0, 1, 0,
241 doc: /* Return non-nil if WINDOW is a minibuffer window.
242 WINDOW defaults to the selected window. */)
243 (Lisp_Object window)
245 struct window *w = decode_window (window);
246 return MINI_WINDOW_P (w) ? Qt : Qnil;
250 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
251 Spos_visible_in_window_p, 0, 3, 0,
252 doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
253 Return nil if that position is scrolled vertically out of view.
254 If a character is only partially visible, nil is returned, unless the
255 optional argument PARTIALLY is non-nil.
256 If POS is only out of view because of horizontal scrolling, return non-nil.
257 If POS is t, it specifies the position of the last visible glyph in WINDOW.
258 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
260 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
261 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
262 where X and Y are the pixel coordinates relative to the top left corner
263 of the window. The remaining elements are omitted if the character after
264 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
265 off-window at the top and bottom of the row, ROWH is the height of the
266 display row, and VPOS is the row number (0-based) containing POS. */)
267 (Lisp_Object pos, Lisp_Object window, Lisp_Object partially)
269 register struct window *w;
270 register EMACS_INT posint;
271 register struct buffer *buf;
272 struct text_pos top;
273 Lisp_Object in_window = Qnil;
274 int rtop, rbot, rowh, vpos, fully_p = 1;
275 int x, y;
277 w = decode_window (window);
278 buf = XBUFFER (w->buffer);
279 SET_TEXT_POS_FROM_MARKER (top, w->start);
281 if (EQ (pos, Qt))
282 posint = -1;
283 else if (!NILP (pos))
285 CHECK_NUMBER_COERCE_MARKER (pos);
286 posint = XINT (pos);
288 else if (w == XWINDOW (selected_window))
289 posint = PT;
290 else
291 posint = XMARKER (w->pointm)->charpos;
293 /* If position is above window start or outside buffer boundaries,
294 or if window start is out of range, position is not visible. */
295 if ((EQ (pos, Qt)
296 || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
297 && CHARPOS (top) >= BUF_BEGV (buf)
298 && CHARPOS (top) <= BUF_ZV (buf)
299 && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
300 && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
301 in_window = Qt;
303 if (!NILP (in_window) && !NILP (partially))
305 Lisp_Object part = Qnil;
306 if (!fully_p)
307 part = list4 (make_number (rtop), make_number (rbot),
308 make_number (rowh), make_number (vpos));
309 in_window = Fcons (make_number (x),
310 Fcons (make_number (y), part));
313 return in_window;
316 DEFUN ("window-line-height", Fwindow_line_height,
317 Swindow_line_height, 0, 2, 0,
318 doc: /* Return height in pixels of text line LINE in window WINDOW.
319 If WINDOW is nil or omitted, use selected window.
321 Return height of current line if LINE is omitted or nil. Return height of
322 header or mode line if LINE is `header-line' and `mode-line'.
323 Otherwise, LINE is a text line number starting from 0. A negative number
324 counts from the end of the window.
326 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
327 in pixels of the visible part of the line, VPOS and YPOS are the
328 vertical position in lines and pixels of the line, relative to the top
329 of the first text line, and OFFBOT is the number of off-window pixels at
330 the bottom of the text line. If there are off-window pixels at the top
331 of the (first) text line, YPOS is negative.
333 Return nil if window display is not up-to-date. In that case, use
334 `pos-visible-in-window-p' to obtain the information. */)
335 (Lisp_Object line, Lisp_Object window)
337 register struct window *w;
338 register struct buffer *b;
339 struct glyph_row *row, *end_row;
340 int max_y, crop, i, n;
342 w = decode_window (window);
344 if (noninteractive
345 || w->pseudo_window_p)
346 return Qnil;
348 CHECK_BUFFER (w->buffer);
349 b = XBUFFER (w->buffer);
351 /* Fail if current matrix is not up-to-date. */
352 if (NILP (w->window_end_valid)
353 || current_buffer->clip_changed
354 || current_buffer->prevent_redisplay_optimizations_p
355 || XFASTINT (w->last_modified) < BUF_MODIFF (b)
356 || XFASTINT (w->last_overlay_modified) < BUF_OVERLAY_MODIFF (b))
357 return Qnil;
359 if (NILP (line))
361 i = w->cursor.vpos;
362 if (i < 0 || i >= w->current_matrix->nrows
363 || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
364 return Qnil;
365 max_y = window_text_bottom_y (w);
366 goto found_row;
369 if (EQ (line, Qheader_line))
371 if (!WINDOW_WANTS_HEADER_LINE_P (w))
372 return Qnil;
373 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
374 if (!row->enabled_p)
375 return Qnil;
376 return list4 (make_number (row->height),
377 make_number (0), make_number (0),
378 make_number (0));
381 if (EQ (line, Qmode_line))
383 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
384 if (!row->enabled_p)
385 return Qnil;
386 return list4 (make_number (row->height),
387 make_number (0), /* not accurate */
388 make_number (WINDOW_HEADER_LINE_HEIGHT (w)
389 + window_text_bottom_y (w)),
390 make_number (0));
393 CHECK_NUMBER (line);
394 n = XINT (line);
396 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
397 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
398 max_y = window_text_bottom_y (w);
399 i = 0;
401 while ((n < 0 || i < n)
402 && row <= end_row && row->enabled_p
403 && row->y + row->height < max_y)
404 row++, i++;
406 if (row > end_row || !row->enabled_p)
407 return Qnil;
409 if (++n < 0)
411 if (-n > i)
412 return Qnil;
413 row += n;
414 i += n;
417 found_row:
418 crop = max (0, (row->y + row->height) - max_y);
419 return list4 (make_number (row->height + min (0, row->y) - crop),
420 make_number (i),
421 make_number (row->y),
422 make_number (crop));
427 static struct window *
428 decode_window (register Lisp_Object window)
430 if (NILP (window))
431 return XWINDOW (selected_window);
433 CHECK_LIVE_WINDOW (window);
434 return XWINDOW (window);
437 static struct window *
438 decode_any_window (register Lisp_Object window)
440 if (NILP (window))
441 return XWINDOW (selected_window);
443 CHECK_WINDOW (window);
444 return XWINDOW (window);
447 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
448 doc: /* Return the buffer that WINDOW is displaying.
449 WINDOW defaults to the selected window. */)
450 (Lisp_Object window)
452 return decode_window (window)->buffer;
455 DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
456 doc: /* Return the number of lines in WINDOW.
457 WINDOW defaults to the selected window.
459 The return value includes WINDOW's mode line and header line, if any.
461 Note: The function does not take into account the value of `line-spacing'
462 when calculating the number of lines in WINDOW. */)
463 (Lisp_Object window)
465 return decode_any_window (window)->total_lines;
468 DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
469 doc: /* Return the number of display columns in WINDOW.
470 WINDOW defaults to the selected window.
472 Note: The return value is the number of columns available for text in
473 WINDOW. If you want to find out how many columns WINDOW takes up, use
474 (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))). */)
475 (Lisp_Object window)
477 return make_number (window_box_text_cols (decode_any_window (window)));
480 DEFUN ("window-full-width-p", Fwindow_full_width_p, Swindow_full_width_p, 0, 1, 0,
481 doc: /* Return t if WINDOW is as wide as its frame.
482 WINDOW defaults to the selected window. */)
483 (Lisp_Object window)
485 return WINDOW_FULL_WIDTH_P (decode_any_window (window)) ? Qt : Qnil;
488 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
489 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
490 WINDOW defaults to the selected window. */)
491 (Lisp_Object window)
493 return decode_window (window)->hscroll;
496 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
497 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
498 Return NCOL. NCOL should be zero or positive.
500 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
501 window so that the location of point moves off-window. */)
502 (Lisp_Object window, Lisp_Object ncol)
504 struct window *w = decode_window (window);
505 int hscroll;
507 CHECK_NUMBER (ncol);
508 hscroll = max (0, XINT (ncol));
510 /* Prevent redisplay shortcuts when changing the hscroll. */
511 if (XINT (w->hscroll) != hscroll)
512 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
514 w->hscroll = make_number (hscroll);
515 return ncol;
518 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
519 Swindow_redisplay_end_trigger, 0, 1, 0,
520 doc: /* Return WINDOW's redisplay end trigger value.
521 WINDOW defaults to the selected window.
522 See `set-window-redisplay-end-trigger' for more information. */)
523 (Lisp_Object window)
525 return decode_window (window)->redisplay_end_trigger;
528 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
529 Sset_window_redisplay_end_trigger, 2, 2, 0,
530 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
531 VALUE should be a buffer position (typically a marker) or nil.
532 If it is a buffer position, then if redisplay in WINDOW reaches a position
533 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
534 with two arguments: WINDOW, and the end trigger value.
535 Afterwards the end-trigger value is reset to nil. */)
536 (register Lisp_Object window, Lisp_Object value)
538 register struct window *w;
540 w = decode_window (window);
541 w->redisplay_end_trigger = value;
542 return value;
545 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
546 doc: /* Return a list of the edge coordinates of WINDOW.
547 The list has the form (LEFT TOP RIGHT BOTTOM).
548 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
549 all relative to 0, 0 at top left corner of frame.
551 RIGHT is one more than the rightmost column occupied by WINDOW.
552 BOTTOM is one more than the bottommost row occupied by WINDOW.
553 The edges include the space used by WINDOW's scroll bar, display
554 margins, fringes, header line, and/or mode line. For the edges of
555 just the text area, use `window-inside-edges'. */)
556 (Lisp_Object window)
558 register struct window *w = decode_any_window (window);
560 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
561 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
562 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
563 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
564 Qnil))));
567 DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
568 doc: /* Return a list of the edge pixel coordinates of WINDOW.
569 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
570 the top left corner of the frame.
572 RIGHT is one more than the rightmost x position occupied by WINDOW.
573 BOTTOM is one more than the bottommost y position occupied by WINDOW.
574 The pixel edges include the space used by WINDOW's scroll bar, display
575 margins, fringes, header line, and/or mode line. For the pixel edges
576 of just the text area, use `window-inside-pixel-edges'. */)
577 (Lisp_Object window)
579 register struct window *w = decode_any_window (window);
581 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
582 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
583 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
584 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
585 Qnil))));
588 static void
589 calc_absolute_offset(struct window *w, int *add_x, int *add_y)
591 struct frame *f = XFRAME (w->frame);
592 *add_y = f->top_pos;
593 #ifdef FRAME_MENUBAR_HEIGHT
594 *add_y += FRAME_MENUBAR_HEIGHT (f);
595 #endif
596 #ifdef FRAME_TOOLBAR_TOP_HEIGHT
597 *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
598 #elif FRAME_TOOLBAR_HEIGHT
599 *add_y += FRAME_TOOLBAR_HEIGHT (f);
600 #endif
601 #ifdef FRAME_NS_TITLEBAR_HEIGHT
602 *add_y += FRAME_NS_TITLEBAR_HEIGHT (f);
603 #endif
604 *add_x = f->left_pos;
605 #ifdef FRAME_TOOLBAR_LEFT_WIDTH
606 *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
607 #endif
610 DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges,
611 Swindow_absolute_pixel_edges, 0, 1, 0,
612 doc: /* Return a list of the edge pixel coordinates of WINDOW.
613 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
614 the top left corner of the display.
616 RIGHT is one more than the rightmost x position occupied by WINDOW.
617 BOTTOM is one more than the bottommost y position occupied by WINDOW.
618 The pixel edges include the space used by WINDOW's scroll bar, display
619 margins, fringes, header line, and/or mode line. For the pixel edges
620 of just the text area, use `window-inside-absolute-pixel-edges'. */)
621 (Lisp_Object window)
623 register struct window *w = decode_any_window (window);
624 int add_x, add_y;
625 calc_absolute_offset (w, &add_x, &add_y);
627 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w) + add_x),
628 Fcons (make_number (WINDOW_TOP_EDGE_Y (w) + add_y),
629 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w) + add_x),
630 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w) + add_y),
631 Qnil))));
634 DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
635 doc: /* Return a list of the edge coordinates of WINDOW.
636 The list has the form (LEFT TOP RIGHT BOTTOM).
637 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
638 all relative to 0, 0 at top left corner of frame.
640 RIGHT is one more than the rightmost column of WINDOW's text area.
641 BOTTOM is one more than the bottommost row of WINDOW's text area.
642 The inside edges do not include the space used by the WINDOW's scroll
643 bar, display margins, fringes, header line, and/or mode line. */)
644 (Lisp_Object window)
646 register struct window *w = decode_any_window (window);
648 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
649 + WINDOW_LEFT_MARGIN_COLS (w)
650 + WINDOW_LEFT_FRINGE_COLS (w)),
651 make_number (WINDOW_TOP_EDGE_LINE (w)
652 + WINDOW_HEADER_LINE_LINES (w)),
653 make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
654 - WINDOW_RIGHT_MARGIN_COLS (w)
655 - WINDOW_RIGHT_FRINGE_COLS (w)),
656 make_number (WINDOW_BOTTOM_EDGE_LINE (w)
657 - WINDOW_MODE_LINE_LINES (w)));
660 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
661 doc: /* Return a list of the edge pixel coordinates of WINDOW.
662 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
663 the top left corner of the frame.
665 RIGHT is one more than the rightmost x position of WINDOW's text area.
666 BOTTOM is one more than the bottommost y position of WINDOW's text area.
667 The inside edges do not include the space used by WINDOW's scroll bar,
668 display margins, fringes, header line, and/or mode line. */)
669 (Lisp_Object window)
671 register struct window *w = decode_any_window (window);
673 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
674 + WINDOW_LEFT_MARGIN_WIDTH (w)
675 + WINDOW_LEFT_FRINGE_WIDTH (w)),
676 make_number (WINDOW_TOP_EDGE_Y (w)
677 + WINDOW_HEADER_LINE_HEIGHT (w)),
678 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
679 - WINDOW_RIGHT_MARGIN_WIDTH (w)
680 - WINDOW_RIGHT_FRINGE_WIDTH (w)),
681 make_number (WINDOW_BOTTOM_EDGE_Y (w)
682 - WINDOW_MODE_LINE_HEIGHT (w)));
685 DEFUN ("window-inside-absolute-pixel-edges",
686 Fwindow_inside_absolute_pixel_edges,
687 Swindow_inside_absolute_pixel_edges, 0, 1, 0,
688 doc: /* Return a list of the edge pixel coordinates of WINDOW.
689 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
690 the top left corner of the display.
692 RIGHT is one more than the rightmost x position of WINDOW's text area.
693 BOTTOM is one more than the bottommost y position of WINDOW's text area.
694 The inside edges do not include the space used by WINDOW's scroll bar,
695 display margins, fringes, header line, and/or mode line. */)
696 (Lisp_Object window)
698 register struct window *w = decode_any_window (window);
699 int add_x, add_y;
700 calc_absolute_offset (w, &add_x, &add_y);
702 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
703 + WINDOW_LEFT_MARGIN_WIDTH (w)
704 + WINDOW_LEFT_FRINGE_WIDTH (w) + add_x),
705 make_number (WINDOW_TOP_EDGE_Y (w)
706 + WINDOW_HEADER_LINE_HEIGHT (w) + add_y),
707 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
708 - WINDOW_RIGHT_MARGIN_WIDTH (w)
709 - WINDOW_RIGHT_FRINGE_WIDTH (w) + add_x),
710 make_number (WINDOW_BOTTOM_EDGE_Y (w)
711 - WINDOW_MODE_LINE_HEIGHT (w) + add_y));
714 /* Test if the character at column X, row Y is within window W.
715 If it is not, return ON_NOTHING;
716 if it is in the window's text area, return ON_TEXT;
717 if it is on the window's modeline, return ON_MODE_LINE;
718 if it is on the border between the window and its right sibling,
719 return ON_VERTICAL_BORDER.
720 if it is on a scroll bar, return ON_SCROLL_BAR.
721 if it is on the window's top line, return ON_HEADER_LINE;
722 if it is in left or right fringe of the window,
723 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
724 if it is in the marginal area to the left/right of the window,
725 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
727 X and Y are frame relative pixel coordinates. */
729 static enum window_part
730 coordinates_in_window (register struct window *w, int x, int y)
732 struct frame *f = XFRAME (WINDOW_FRAME (w));
733 int left_x, right_x;
734 enum window_part part;
735 int ux = FRAME_COLUMN_WIDTH (f);
736 int x0 = WINDOW_LEFT_EDGE_X (w);
737 int x1 = WINDOW_RIGHT_EDGE_X (w);
738 /* The width of the area where the vertical line can be dragged.
739 (Between mode lines for instance. */
740 int grabbable_width = ux;
741 int lmargin_width, rmargin_width, text_left, text_right;
742 int top_y = WINDOW_TOP_EDGE_Y (w);
743 int bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
745 /* Outside any interesting row? */
746 if (y < top_y || y >= bottom_y)
747 return ON_NOTHING;
749 /* In what's below, we subtract 1 when computing right_x because we
750 want the rightmost pixel, which is given by left_pixel+width-1. */
751 if (w->pseudo_window_p)
753 left_x = 0;
754 right_x = WINDOW_TOTAL_WIDTH (w) - 1;
756 else
758 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
759 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
762 /* On the mode line or header line? If it's near the start of
763 the mode or header line of window that's has a horizontal
764 sibling, say it's on the vertical line. That's to be able
765 to resize windows horizontally in case we're using toolkit
766 scroll bars. */
768 if (WINDOW_WANTS_MODELINE_P (w)
769 && y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
771 part = ON_MODE_LINE;
773 header_vertical_border_check:
774 /* We're somewhere on the mode line. We consider the place
775 between mode lines of horizontally adjacent mode lines
776 as the vertical border. If scroll bars on the left,
777 return the right window. */
778 if ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
779 || WINDOW_RIGHTMOST_P (w))
780 && !WINDOW_LEFTMOST_P (w)
781 && eabs (x - x0) < grabbable_width)
782 return ON_VERTICAL_BORDER;
784 /* Make sure we're not at the rightmost position of a
785 mode-/header-line and there's yet another window on the
786 right. (Bug#1372) */
787 else if ((WINDOW_RIGHTMOST_P (w) || x < x1)
788 && eabs (x - x1) < grabbable_width)
789 return ON_VERTICAL_BORDER;
791 if (x < x0 || x >= x1)
792 return ON_NOTHING;
794 return part;
797 if (WINDOW_WANTS_HEADER_LINE_P (w)
798 && y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
800 part = ON_HEADER_LINE;
801 goto header_vertical_border_check;
804 if (x < x0 || x >= x1) return ON_NOTHING;
806 /* Outside any interesting column? */
807 if (x < left_x || x > right_x)
808 return ON_SCROLL_BAR;
810 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
811 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
813 text_left = window_box_left (w, TEXT_AREA);
814 text_right = text_left + window_box_width (w, TEXT_AREA);
816 if (FRAME_WINDOW_P (f))
818 if (!w->pseudo_window_p
819 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
820 && !WINDOW_RIGHTMOST_P (w)
821 && (eabs (x - right_x) < grabbable_width))
822 return ON_VERTICAL_BORDER;
824 /* Need to say "x > right_x" rather than >=, since on character
825 terminals, the vertical line's x coordinate is right_x. */
826 else if (!w->pseudo_window_p
827 && !WINDOW_RIGHTMOST_P (w)
828 && x > right_x - ux)
829 return ON_VERTICAL_BORDER;
831 if (x < text_left)
833 if (lmargin_width > 0
834 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
835 ? (x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
836 : (x < left_x + lmargin_width)))
837 return ON_LEFT_MARGIN;
839 return ON_LEFT_FRINGE;
842 if (x >= text_right)
844 if (rmargin_width > 0
845 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
846 ? (x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
847 : (x >= right_x - rmargin_width)))
848 return ON_RIGHT_MARGIN;
850 return ON_RIGHT_FRINGE;
853 /* Everything special ruled out - must be on text area */
854 return ON_TEXT;
857 /* Take X is the frame-relative pixel x-coordinate, and return the
858 x-coordinate relative to part PART of window W. */
860 window_relative_x_coord (struct window *w, enum window_part part, int x)
862 int left_x = (w->pseudo_window_p) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w);
864 switch (part)
866 case ON_TEXT:
867 return x - window_box_left (w, TEXT_AREA);
869 case ON_LEFT_FRINGE:
870 return x - left_x;
872 case ON_RIGHT_FRINGE:
873 return x - left_x - WINDOW_LEFT_FRINGE_WIDTH (w);
875 case ON_LEFT_MARGIN:
876 return (x - left_x
877 - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
878 ? WINDOW_LEFT_FRINGE_WIDTH (w) : 0));
880 case ON_RIGHT_MARGIN:
881 return (x + 1
882 - ((w->pseudo_window_p)
883 ? WINDOW_TOTAL_WIDTH (w)
884 : WINDOW_BOX_RIGHT_EDGE_X (w))
885 + window_box_width (w, RIGHT_MARGIN_AREA)
886 + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
887 ? WINDOW_RIGHT_FRINGE_WIDTH (w) : 0));
890 /* ON_SCROLL_BAR, ON_NOTHING, and ON_VERTICAL_BORDER: */
891 return 0;
895 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
896 Scoordinates_in_window_p, 2, 2, 0,
897 doc: /* Return non-nil if COORDINATES are in WINDOW.
898 COORDINATES is a cons of the form (X . Y), X and Y being distances
899 measured in characters from the upper-left corner of the frame.
900 \(0 . 0) denotes the character in the upper left corner of the
901 frame.
902 If COORDINATES are in the text portion of WINDOW,
903 the coordinates relative to the window are returned.
904 If they are in the mode line of WINDOW, `mode-line' is returned.
905 If they are in the top mode line of WINDOW, `header-line' is returned.
906 If they are in the left fringe of WINDOW, `left-fringe' is returned.
907 If they are in the right fringe of WINDOW, `right-fringe' is returned.
908 If they are on the border between WINDOW and its right sibling,
909 `vertical-line' is returned.
910 If they are in the windows's left or right marginal areas, `left-margin'\n\
911 or `right-margin' is returned. */)
912 (register Lisp_Object coordinates, Lisp_Object window)
914 struct window *w;
915 struct frame *f;
916 int x, y;
917 Lisp_Object lx, ly;
919 CHECK_WINDOW (window);
920 w = XWINDOW (window);
921 f = XFRAME (w->frame);
922 CHECK_CONS (coordinates);
923 lx = Fcar (coordinates);
924 ly = Fcdr (coordinates);
925 CHECK_NUMBER_OR_FLOAT (lx);
926 CHECK_NUMBER_OR_FLOAT (ly);
927 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
928 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
930 switch (coordinates_in_window (w, x, y))
932 case ON_NOTHING:
933 return Qnil;
935 case ON_TEXT:
936 /* Convert X and Y to window relative pixel coordinates, and
937 return the canonical char units. */
938 x -= window_box_left (w, TEXT_AREA);
939 y -= WINDOW_TOP_EDGE_Y (w);
940 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
941 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
943 case ON_MODE_LINE:
944 return Qmode_line;
946 case ON_VERTICAL_BORDER:
947 return Qvertical_line;
949 case ON_HEADER_LINE:
950 return Qheader_line;
952 case ON_LEFT_FRINGE:
953 return Qleft_fringe;
955 case ON_RIGHT_FRINGE:
956 return Qright_fringe;
958 case ON_LEFT_MARGIN:
959 return Qleft_margin;
961 case ON_RIGHT_MARGIN:
962 return Qright_margin;
964 case ON_SCROLL_BAR:
965 /* Historically we are supposed to return nil in this case. */
966 return Qnil;
968 default:
969 abort ();
974 /* Callback for foreach_window, used in window_from_coordinates.
975 Check if window W contains coordinates specified by USER_DATA which
976 is actually a pointer to a struct check_window_data CW.
978 Check if window W contains coordinates *CW->x and *CW->y. If it
979 does, return W in *CW->window, as Lisp_Object, and return in
980 *CW->part the part of the window under coordinates *X,*Y. Return
981 zero from this function to stop iterating over windows. */
983 struct check_window_data
985 Lisp_Object *window;
986 int x, y;
987 enum window_part *part;
990 static int
991 check_window_containing (struct window *w, void *user_data)
993 struct check_window_data *cw = (struct check_window_data *) user_data;
994 enum window_part found;
995 int continue_p = 1;
997 found = coordinates_in_window (w, cw->x, cw->y);
998 if (found != ON_NOTHING)
1000 *cw->part = found;
1001 XSETWINDOW (*cw->window, w);
1002 continue_p = 0;
1005 return continue_p;
1009 /* Find the window containing frame-relative pixel position X/Y and
1010 return it as a Lisp_Object.
1012 If X, Y is on one of the window's special `window_part' elements,
1013 set *PART to the id of that element.
1015 If there is no window under X, Y return nil and leave *PART
1016 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1018 This function was previously implemented with a loop cycling over
1019 windows with Fnext_window, and starting with the frame's selected
1020 window. It turned out that this doesn't work with an
1021 implementation of next_window using Vwindow_list, because
1022 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1023 tree of F when this function is called asynchronously from
1024 note_mouse_highlight. The original loop didn't terminate in this
1025 case. */
1027 Lisp_Object
1028 window_from_coordinates (struct frame *f, int x, int y,
1029 enum window_part *part, int tool_bar_p)
1031 Lisp_Object window;
1032 struct check_window_data cw;
1033 enum window_part dummy;
1035 if (part == 0)
1036 part = &dummy;
1038 window = Qnil;
1039 cw.window = &window, cw.x = x, cw.y = y; cw.part = part;
1040 foreach_window (f, check_window_containing, &cw);
1042 /* If not found above, see if it's in the tool bar window, if a tool
1043 bar exists. */
1044 if (NILP (window)
1045 && tool_bar_p
1046 && WINDOWP (f->tool_bar_window)
1047 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1048 && (coordinates_in_window (XWINDOW (f->tool_bar_window), x, y)
1049 != ON_NOTHING))
1051 *part = ON_TEXT;
1052 window = f->tool_bar_window;
1055 return window;
1058 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1059 doc: /* Return window containing coordinates X and Y on FRAME.
1060 If omitted, FRAME defaults to the currently selected frame.
1061 The top left corner of the frame is considered to be row 0,
1062 column 0. */)
1063 (Lisp_Object x, Lisp_Object y, Lisp_Object frame)
1065 struct frame *f;
1067 if (NILP (frame))
1068 frame = selected_frame;
1069 CHECK_LIVE_FRAME (frame);
1070 f = XFRAME (frame);
1072 /* Check that arguments are integers or floats. */
1073 CHECK_NUMBER_OR_FLOAT (x);
1074 CHECK_NUMBER_OR_FLOAT (y);
1076 return window_from_coordinates (f,
1077 (FRAME_PIXEL_X_FROM_CANON_X (f, x)
1078 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1079 (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
1080 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1081 0, 0);
1084 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1085 doc: /* Return current value of point in WINDOW.
1086 WINDOW defaults to the selected window.
1088 For a nonselected window, this is the value point would have
1089 if that window were selected.
1091 Note that, when WINDOW is the selected window and its buffer
1092 is also currently selected, the value returned is the same as (point).
1093 It would be more strictly correct to return the `top-level' value
1094 of point, outside of any save-excursion forms.
1095 But that is hard to define. */)
1096 (Lisp_Object window)
1098 register struct window *w = decode_window (window);
1100 if (w == XWINDOW (selected_window)
1101 && current_buffer == XBUFFER (w->buffer))
1102 return Fpoint ();
1103 return Fmarker_position (w->pointm);
1106 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1107 doc: /* Return position at which display currently starts in WINDOW.
1108 WINDOW defaults to the selected window.
1109 This is updated by redisplay or by calling `set-window-start'. */)
1110 (Lisp_Object window)
1112 return Fmarker_position (decode_window (window)->start);
1115 /* This is text temporarily removed from the doc string below.
1117 This function returns nil if the position is not currently known.
1118 That happens when redisplay is preempted and doesn't finish.
1119 If in that case you want to compute where the end of the window would
1120 have been if redisplay had finished, do this:
1121 (save-excursion
1122 (goto-char (window-start window))
1123 (vertical-motion (1- (window-height window)) window)
1124 (point))") */
1126 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1127 doc: /* Return position at which display currently ends in WINDOW.
1128 WINDOW defaults to the selected window.
1129 This is updated by redisplay, when it runs to completion.
1130 Simply changing the buffer text or setting `window-start'
1131 does not update this value.
1132 Return nil if there is no recorded value. \(This can happen if the
1133 last redisplay of WINDOW was preempted, and did not finish.)
1134 If UPDATE is non-nil, compute the up-to-date position
1135 if it isn't already recorded. */)
1136 (Lisp_Object window, Lisp_Object update)
1138 Lisp_Object value;
1139 struct window *w = decode_window (window);
1140 Lisp_Object buf;
1141 struct buffer *b;
1143 buf = w->buffer;
1144 CHECK_BUFFER (buf);
1145 b = XBUFFER (buf);
1147 #if 0 /* This change broke some things. We should make it later. */
1148 /* If we don't know the end position, return nil.
1149 The user can compute it with vertical-motion if he wants to.
1150 It would be nicer to do it automatically,
1151 but that's so slow that it would probably bother people. */
1152 if (NILP (w->window_end_valid))
1153 return Qnil;
1154 #endif
1156 if (! NILP (update)
1157 && ! (! NILP (w->window_end_valid)
1158 && XFASTINT (w->last_modified) >= BUF_MODIFF (b)
1159 && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (b))
1160 && !noninteractive)
1162 struct text_pos startp;
1163 struct it it;
1164 struct buffer *old_buffer = NULL;
1166 /* Cannot use Fvertical_motion because that function doesn't
1167 cope with variable-height lines. */
1168 if (b != current_buffer)
1170 old_buffer = current_buffer;
1171 set_buffer_internal (b);
1174 /* In case W->start is out of the range, use something
1175 reasonable. This situation occurred when loading a file with
1176 `-l' containing a call to `rmail' with subsequent other
1177 commands. At the end, W->start happened to be BEG, while
1178 rmail had already narrowed the buffer. */
1179 if (XMARKER (w->start)->charpos < BEGV)
1180 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1181 else if (XMARKER (w->start)->charpos > ZV)
1182 SET_TEXT_POS (startp, ZV, ZV_BYTE);
1183 else
1184 SET_TEXT_POS_FROM_MARKER (startp, w->start);
1186 start_display (&it, w, startp);
1187 move_it_vertically (&it, window_box_height (w));
1188 if (it.current_y < it.last_visible_y)
1189 move_it_past_eol (&it);
1190 value = make_number (IT_CHARPOS (it));
1192 if (old_buffer)
1193 set_buffer_internal (old_buffer);
1195 else
1196 XSETINT (value, BUF_Z (b) - XFASTINT (w->window_end_pos));
1198 return value;
1201 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1202 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1203 Return POS. */)
1204 (Lisp_Object window, Lisp_Object pos)
1206 register struct window *w = decode_window (window);
1208 CHECK_NUMBER_COERCE_MARKER (pos);
1209 if (w == XWINDOW (selected_window)
1210 && XBUFFER (w->buffer) == current_buffer)
1211 Fgoto_char (pos);
1212 else
1213 set_marker_restricted (w->pointm, pos, w->buffer);
1215 /* We have to make sure that redisplay updates the window to show
1216 the new value of point. */
1217 if (!EQ (window, selected_window))
1218 ++windows_or_buffers_changed;
1220 return pos;
1223 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1224 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1225 WINDOW defaults to the selected window. Return POS.
1226 Optional third arg NOFORCE non-nil inhibits next redisplay from
1227 overriding motion of point in order to display at this exact start. */)
1228 (Lisp_Object window, Lisp_Object pos, Lisp_Object noforce)
1230 register struct window *w = decode_window (window);
1232 CHECK_NUMBER_COERCE_MARKER (pos);
1233 set_marker_restricted (w->start, pos, w->buffer);
1234 /* this is not right, but much easier than doing what is right. */
1235 w->start_at_line_beg = Qnil;
1236 if (NILP (noforce))
1237 w->force_start = Qt;
1238 w->update_mode_line = Qt;
1239 XSETFASTINT (w->last_modified, 0);
1240 XSETFASTINT (w->last_overlay_modified, 0);
1241 if (!EQ (window, selected_window))
1242 windows_or_buffers_changed++;
1244 return pos;
1248 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1249 0, 1, 0,
1250 doc: /* Return non-nil when WINDOW is dedicated to its buffer.
1251 More precisely, return the value assigned by the last call of
1252 `set-window-dedicated-p' for WINDOW. Return nil if that function was
1253 never called with WINDOW as its argument, or the value set by that
1254 function was internally reset since its last call. WINDOW defaults to
1255 the selected window.
1257 When a window is dedicated to its buffer, `display-buffer' will refrain
1258 from displaying another buffer in it. `get-lru-window' and
1259 `get-largest-window' treat dedicated windows specially.
1260 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1261 `kill-buffer' can delete a dedicated window and the containing frame.
1263 Functions like `set-window-buffer' may change the buffer displayed by a
1264 window, unless that window is "strongly" dedicated to its buffer, that
1265 is the value returned by `window-dedicated-p' is t. */)
1266 (Lisp_Object window)
1268 return decode_window (window)->dedicated;
1271 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1272 Sset_window_dedicated_p, 2, 2, 0,
1273 doc: /* Mark WINDOW as dedicated according to FLAG.
1274 WINDOW defaults to the selected window. FLAG non-nil means mark WINDOW
1275 as dedicated to its buffer. FLAG nil means mark WINDOW as non-dedicated.
1276 Return FLAG.
1278 When a window is dedicated to its buffer, `display-buffer' will refrain
1279 from displaying another buffer in it. `get-lru-window' and
1280 `get-largest-window' treat dedicated windows specially.
1281 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1282 `kill-buffer' can delete a dedicated window and the containing
1283 frame.
1285 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
1286 its buffer. Functions like `set-window-buffer' may change the buffer
1287 displayed by a window, unless that window is strongly dedicated to its
1288 buffer. If and when `set-window-buffer' displays another buffer in a
1289 window, it also makes sure that the window is not marked as dedicated. */)
1290 (Lisp_Object window, Lisp_Object flag)
1292 register struct window *w = decode_window (window);
1294 w->dedicated = flag;
1295 return w->dedicated;
1299 DEFUN ("window-parameters", Fwindow_parameters, Swindow_parameters,
1300 0, 1, 0,
1301 doc: /* Return the parameters of WINDOW and their values.
1302 WINDOW defaults to the selected window. The return value is a list of
1303 elements of the form (PARAMETER . VALUE). */)
1304 (Lisp_Object window)
1306 return Fcopy_alist (decode_window (window)->window_parameters);
1309 DEFUN ("window-parameter", Fwindow_parameter, Swindow_parameter,
1310 2, 2, 0,
1311 doc: /* Return WINDOW's value for PARAMETER.
1312 WINDOW defaults to the selected window. */)
1313 (Lisp_Object window, Lisp_Object parameter)
1315 Lisp_Object result;
1317 result = Fassq (parameter, decode_window (window)->window_parameters);
1318 return CDR_SAFE (result);
1321 DEFUN ("set-window-parameter", Fset_window_parameter,
1322 Sset_window_parameter, 3, 3, 0,
1323 doc: /* Set WINDOW's value of PARAMETER to VALUE.
1324 WINDOW defaults to the selected window. Return VALUE. */)
1325 (Lisp_Object window, Lisp_Object parameter, Lisp_Object value)
1327 register struct window *w = decode_window (window);
1328 Lisp_Object old_alist_elt;
1330 old_alist_elt = Fassq (parameter, w->window_parameters);
1331 if (NILP (old_alist_elt))
1332 w->window_parameters = Fcons (Fcons (parameter, value), w->window_parameters);
1333 else
1334 Fsetcdr (old_alist_elt, value);
1335 return value;
1339 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1340 0, 1, 0,
1341 doc: /* Return the display-table that WINDOW is using.
1342 WINDOW defaults to the selected window. */)
1343 (Lisp_Object window)
1345 return decode_window (window)->display_table;
1348 /* Get the display table for use on window W. This is either W's
1349 display table or W's buffer's display table. Ignore the specified
1350 tables if they are not valid; if no valid table is specified,
1351 return 0. */
1353 struct Lisp_Char_Table *
1354 window_display_table (struct window *w)
1356 struct Lisp_Char_Table *dp = NULL;
1358 if (DISP_TABLE_P (w->display_table))
1359 dp = XCHAR_TABLE (w->display_table);
1360 else if (BUFFERP (w->buffer))
1362 struct buffer *b = XBUFFER (w->buffer);
1364 if (DISP_TABLE_P (BVAR (b, display_table)))
1365 dp = XCHAR_TABLE (BVAR (b, display_table));
1366 else if (DISP_TABLE_P (Vstandard_display_table))
1367 dp = XCHAR_TABLE (Vstandard_display_table);
1370 return dp;
1373 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1374 doc: /* Set WINDOW's display-table to TABLE. */)
1375 (register Lisp_Object window, Lisp_Object table)
1377 register struct window *w;
1379 w = decode_window (window);
1380 w->display_table = table;
1381 return table;
1384 static void delete_window (Lisp_Object);
1386 /* Record info on buffer window w is displaying
1387 when it is about to cease to display that buffer. */
1388 static void
1389 unshow_buffer (register struct window *w)
1391 Lisp_Object buf;
1392 struct buffer *b;
1394 buf = w->buffer;
1395 b = XBUFFER (buf);
1396 if (b != XMARKER (w->pointm)->buffer)
1397 abort ();
1399 #if 0
1400 if (w == XWINDOW (selected_window)
1401 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1402 /* Do this except when the selected window's buffer
1403 is being removed from some other window. */
1404 #endif
1405 /* last_window_start records the start position that this buffer
1406 had in the last window to be disconnected from it.
1407 Now that this statement is unconditional,
1408 it is possible for the buffer to be displayed in the
1409 selected window, while last_window_start reflects another
1410 window which was recently showing the same buffer.
1411 Some people might say that might be a good thing. Let's see. */
1412 b->last_window_start = marker_position (w->start);
1414 /* Point in the selected window's buffer
1415 is actually stored in that buffer, and the window's pointm isn't used.
1416 So don't clobber point in that buffer. */
1417 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1418 /* This line helps to fix Horsley's testbug.el bug. */
1419 && !(WINDOWP (BVAR (b, last_selected_window))
1420 && w != XWINDOW (BVAR (b, last_selected_window))
1421 && EQ (buf, XWINDOW (BVAR (b, last_selected_window))->buffer)))
1422 temp_set_point_both (b,
1423 clip_to_bounds (BUF_BEGV (b),
1424 XMARKER (w->pointm)->charpos,
1425 BUF_ZV (b)),
1426 clip_to_bounds (BUF_BEGV_BYTE (b),
1427 marker_byte_position (w->pointm),
1428 BUF_ZV_BYTE (b)));
1430 if (WINDOWP (BVAR (b, last_selected_window))
1431 && w == XWINDOW (BVAR (b, last_selected_window)))
1432 BVAR (b, last_selected_window) = Qnil;
1435 /* Put replacement into the window structure in place of old. */
1436 static void
1437 replace_window (Lisp_Object old, Lisp_Object replacement)
1439 register Lisp_Object tem;
1440 register struct window *o = XWINDOW (old), *p = XWINDOW (replacement);
1442 /* If OLD is its frame's root_window, then replacement is the new
1443 root_window for that frame. */
1445 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1446 FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement;
1448 p->left_col = o->left_col;
1449 p->top_line = o->top_line;
1450 p->total_cols = o->total_cols;
1451 p->total_lines = o->total_lines;
1452 p->desired_matrix = p->current_matrix = 0;
1453 p->vscroll = 0;
1454 memset (&p->cursor, 0, sizeof (p->cursor));
1455 memset (&p->last_cursor, 0, sizeof (p->last_cursor));
1456 memset (&p->phys_cursor, 0, sizeof (p->phys_cursor));
1457 p->phys_cursor_type = -1;
1458 p->phys_cursor_width = -1;
1459 p->must_be_updated_p = 0;
1460 p->pseudo_window_p = 0;
1461 XSETFASTINT (p->window_end_vpos, 0);
1462 XSETFASTINT (p->window_end_pos, 0);
1463 p->window_end_valid = Qnil;
1464 p->frozen_window_start_p = 0;
1465 p->orig_top_line = p->orig_total_lines = Qnil;
1467 p->next = tem = o->next;
1468 if (!NILP (tem))
1469 XWINDOW (tem)->prev = replacement;
1471 p->prev = tem = o->prev;
1472 if (!NILP (tem))
1473 XWINDOW (tem)->next = replacement;
1475 p->parent = tem = o->parent;
1476 if (!NILP (tem))
1478 if (EQ (XWINDOW (tem)->vchild, old))
1479 XWINDOW (tem)->vchild = replacement;
1480 if (EQ (XWINDOW (tem)->hchild, old))
1481 XWINDOW (tem)->hchild = replacement;
1484 /*** Here, if replacement is a vertical combination
1485 and so is its new parent, we should make replacement's
1486 children be children of that parent instead. ***/
1489 DEFUN ("delete-window", Fdelete_window, Sdelete_window, 0, 1, "",
1490 doc: /* Remove WINDOW from its frame.
1491 WINDOW defaults to the selected window. Return nil.
1492 Signal an error when WINDOW is the only window on its frame. */)
1493 (register Lisp_Object window)
1495 struct frame *f;
1496 if (NILP (window))
1497 window = selected_window;
1498 else
1499 CHECK_LIVE_WINDOW (window);
1501 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
1502 delete_window (window);
1504 run_window_configuration_change_hook (f);
1506 return Qnil;
1509 static void
1510 delete_window (register Lisp_Object window)
1512 register Lisp_Object tem, parent, sib;
1513 register struct window *p;
1514 register struct window *par;
1515 struct frame *f;
1517 /* Because this function is called by other C code on non-leaf
1518 windows, the CHECK_LIVE_WINDOW macro would choke inappropriately,
1519 so we can't decode_window here. */
1520 CHECK_WINDOW (window);
1521 p = XWINDOW (window);
1523 /* It's a no-op to delete an already-deleted window. */
1524 if (NILP (p->buffer)
1525 && NILP (p->hchild)
1526 && NILP (p->vchild))
1527 return;
1529 parent = p->parent;
1530 if (NILP (parent))
1531 error ("Attempt to delete minibuffer or sole ordinary window");
1532 par = XWINDOW (parent);
1534 windows_or_buffers_changed++;
1535 Vwindow_list = Qnil;
1536 f = XFRAME (WINDOW_FRAME (p));
1537 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
1539 /* Are we trying to delete any frame's selected window? */
1541 Lisp_Object swindow, pwindow;
1543 /* See if the frame's selected window is either WINDOW
1544 or any subwindow of it, by finding all that window's parents
1545 and comparing each one with WINDOW. */
1546 swindow = FRAME_SELECTED_WINDOW (f);
1548 while (1)
1550 pwindow = swindow;
1551 while (!NILP (pwindow))
1553 if (EQ (window, pwindow))
1554 break;
1555 pwindow = XWINDOW (pwindow)->parent;
1558 /* If the window being deleted is not a parent of SWINDOW,
1559 then SWINDOW is ok as the new selected window. */
1560 if (!EQ (window, pwindow))
1561 break;
1562 /* Otherwise, try another window for SWINDOW. */
1563 swindow = Fnext_window (swindow, Qlambda, Qnil);
1565 /* If we get back to the frame's selected window,
1566 it means there was no acceptable alternative,
1567 so we cannot delete. */
1568 if (EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1569 error ("Cannot delete window");
1572 /* If we need to change SWINDOW, do it. */
1573 if (! EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1575 /* If we're about to delete the selected window on the
1576 selected frame, then we should use Fselect_window to select
1577 the new window. On the other hand, if we're about to
1578 delete the selected window on any other frame, we shouldn't do
1579 anything but set the frame's selected_window slot. */
1580 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
1581 Fselect_window (swindow, Qnil);
1582 else
1583 FRAME_SELECTED_WINDOW (f) = swindow;
1587 /* Now we know we can delete this one. */
1588 window_deletion_count++;
1590 tem = p->buffer;
1591 /* tem is null for dummy parent windows
1592 (which have inferiors but not any contents themselves) */
1593 if (!NILP (tem))
1595 unshow_buffer (p);
1596 unchain_marker (XMARKER (p->pointm));
1597 unchain_marker (XMARKER (p->start));
1600 /* Free window glyph matrices. It is sure that they are allocated
1601 again when ADJUST_GLYPHS is called. Block input so that expose
1602 events and other events that access glyph matrices are not
1603 processed while we are changing them. */
1604 BLOCK_INPUT;
1605 free_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)));
1607 tem = p->next;
1608 if (!NILP (tem))
1609 XWINDOW (tem)->prev = p->prev;
1611 tem = p->prev;
1612 if (!NILP (tem))
1613 XWINDOW (tem)->next = p->next;
1615 if (EQ (window, par->hchild))
1616 par->hchild = p->next;
1617 if (EQ (window, par->vchild))
1618 par->vchild = p->next;
1620 /* Find one of our siblings to give our space to. */
1621 sib = p->prev;
1622 if (NILP (sib))
1624 /* If p gives its space to its next sibling, that sibling needs
1625 to have its top/left side pulled back to where p's is.
1626 set_window_{height,width} will re-position the sibling's
1627 children. */
1628 sib = p->next;
1629 XWINDOW (sib)->top_line = p->top_line;
1630 XWINDOW (sib)->left_col = p->left_col;
1633 /* Stretch that sibling. */
1634 if (!NILP (par->vchild))
1635 set_window_height (sib,
1636 XFASTINT (XWINDOW (sib)->total_lines) + XFASTINT (p->total_lines),
1638 if (!NILP (par->hchild))
1639 set_window_width (sib,
1640 XFASTINT (XWINDOW (sib)->total_cols) + XFASTINT (p->total_cols),
1643 /* If parent now has only one child,
1644 put the child into the parent's place. */
1645 tem = par->hchild;
1646 if (NILP (tem))
1647 tem = par->vchild;
1648 if (NILP (XWINDOW (tem)->next)) {
1649 replace_window (parent, tem);
1650 par = XWINDOW (tem);
1653 /* Since we may be deleting combination windows, we must make sure that
1654 not only p but all its children have been marked as deleted. */
1655 if (! NILP (p->hchild))
1656 delete_all_subwindows (XWINDOW (p->hchild));
1657 else if (! NILP (p->vchild))
1658 delete_all_subwindows (XWINDOW (p->vchild));
1660 /* Mark this window as deleted. */
1661 p->buffer = p->hchild = p->vchild = Qnil;
1663 if (! NILP (par->parent))
1664 par = XWINDOW (par->parent);
1666 /* Check if we have a v/hchild with a v/hchild. In that case remove
1667 one of them. */
1669 if (! NILP (par->vchild) && ! NILP (XWINDOW (par->vchild)->vchild))
1671 p = XWINDOW (par->vchild);
1672 par->vchild = p->vchild;
1673 tem = p->vchild;
1675 else if (! NILP (par->hchild) && ! NILP (XWINDOW (par->hchild)->hchild))
1677 p = XWINDOW (par->hchild);
1678 par->hchild = p->hchild;
1679 tem = p->hchild;
1681 else
1682 p = 0;
1684 if (p)
1686 while (! NILP (tem)) {
1687 XWINDOW (tem)->parent = p->parent;
1688 if (NILP (XWINDOW (tem)->next))
1689 break;
1690 tem = XWINDOW (tem)->next;
1692 if (! NILP (tem)) {
1693 /* The next of the v/hchild we are removing is now the next of the
1694 last child for the v/hchild:
1695 Before v/hchild -> v/hchild -> next1 -> next2
1697 -> next3
1698 After: v/hchild -> next1 -> next2 -> next3
1700 XWINDOW (tem)->next = p->next;
1701 if (! NILP (p->next))
1702 XWINDOW (p->next)->prev = tem;
1704 p->next = p->prev = p->vchild = p->hchild = p->buffer = Qnil;
1708 /* Adjust glyph matrices. */
1709 adjust_glyphs (f);
1710 UNBLOCK_INPUT;
1715 /***********************************************************************
1716 Window List
1717 ***********************************************************************/
1719 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1720 pointer. This is a callback function for foreach_window, used in
1721 function window_list. */
1723 static int
1724 add_window_to_list (struct window *w, void *user_data)
1726 Lisp_Object *list = (Lisp_Object *) user_data;
1727 Lisp_Object window;
1728 XSETWINDOW (window, w);
1729 *list = Fcons (window, *list);
1730 return 1;
1734 /* Return a list of all windows, for use by next_window. If
1735 Vwindow_list is a list, return that list. Otherwise, build a new
1736 list, cache it in Vwindow_list, and return that. */
1738 static Lisp_Object
1739 window_list (void)
1741 if (!CONSP (Vwindow_list))
1743 Lisp_Object tail;
1745 Vwindow_list = Qnil;
1746 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1748 Lisp_Object args[2];
1750 /* We are visiting windows in canonical order, and add
1751 new windows at the front of args[1], which means we
1752 have to reverse this list at the end. */
1753 args[1] = Qnil;
1754 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
1755 args[0] = Vwindow_list;
1756 args[1] = Fnreverse (args[1]);
1757 Vwindow_list = Fnconc (2, args);
1761 return Vwindow_list;
1765 /* Value is non-zero if WINDOW satisfies the constraints given by
1766 OWINDOW, MINIBUF and ALL_FRAMES.
1768 MINIBUF t means WINDOW may be minibuffer windows.
1769 `lambda' means WINDOW may not be a minibuffer window.
1770 a window means a specific minibuffer window
1772 ALL_FRAMES t means search all frames,
1773 nil means search just current frame,
1774 `visible' means search just visible frames on the
1775 current terminal,
1776 0 means search visible and iconified frames on the
1777 current terminal,
1778 a window means search the frame that window belongs to,
1779 a frame means consider windows on that frame, only. */
1781 static int
1782 candidate_window_p (Lisp_Object window, Lisp_Object owindow, Lisp_Object minibuf, Lisp_Object all_frames)
1784 struct window *w = XWINDOW (window);
1785 struct frame *f = XFRAME (w->frame);
1786 int candidate_p = 1;
1788 if (!BUFFERP (w->buffer))
1789 candidate_p = 0;
1790 else if (MINI_WINDOW_P (w)
1791 && (EQ (minibuf, Qlambda)
1792 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
1794 /* If MINIBUF is `lambda' don't consider any mini-windows.
1795 If it is a window, consider only that one. */
1796 candidate_p = 0;
1798 else if (EQ (all_frames, Qt))
1799 candidate_p = 1;
1800 else if (NILP (all_frames))
1802 xassert (WINDOWP (owindow));
1803 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
1805 else if (EQ (all_frames, Qvisible))
1807 FRAME_SAMPLE_VISIBILITY (f);
1808 candidate_p = FRAME_VISIBLE_P (f)
1809 && (FRAME_TERMINAL (XFRAME (w->frame))
1810 == FRAME_TERMINAL (XFRAME (selected_frame)));
1813 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
1815 FRAME_SAMPLE_VISIBILITY (f);
1816 candidate_p = (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)
1817 #ifdef HAVE_X_WINDOWS
1818 /* Yuck!! If we've just created the frame and the
1819 window-manager requested the user to place it
1820 manually, the window may still not be considered
1821 `visible'. I'd argue it should be at least
1822 something like `iconified', but don't know how to do
1823 that yet. --Stef */
1824 || (FRAME_X_P (f) && f->output_data.x->asked_for_visible
1825 && !f->output_data.x->has_been_visible)
1826 #endif
1828 && (FRAME_TERMINAL (XFRAME (w->frame))
1829 == FRAME_TERMINAL (XFRAME (selected_frame)));
1831 else if (WINDOWP (all_frames))
1832 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
1833 || EQ (XWINDOW (all_frames)->frame, w->frame)
1834 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
1835 else if (FRAMEP (all_frames))
1836 candidate_p = EQ (all_frames, w->frame);
1838 return candidate_p;
1842 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
1843 Fwindow_list. See candidate_window_p for the meaning of WINDOW,
1844 MINIBUF, and ALL_FRAMES. */
1846 static void
1847 decode_next_window_args (Lisp_Object *window, Lisp_Object *minibuf, Lisp_Object *all_frames)
1849 if (NILP (*window))
1850 *window = selected_window;
1851 else
1852 CHECK_LIVE_WINDOW (*window);
1854 /* MINIBUF nil may or may not include minibuffers. Decide if it
1855 does. */
1856 if (NILP (*minibuf))
1857 *minibuf = minibuf_level ? minibuf_window : Qlambda;
1858 else if (!EQ (*minibuf, Qt))
1859 *minibuf = Qlambda;
1861 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
1862 => count none of them, or a specific minibuffer window (the
1863 active one) to count. */
1865 /* ALL_FRAMES nil doesn't specify which frames to include. */
1866 if (NILP (*all_frames))
1867 *all_frames = (!EQ (*minibuf, Qlambda)
1868 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
1869 : Qnil);
1870 else if (EQ (*all_frames, Qvisible))
1872 else if (EQ (*all_frames, make_number (0)))
1874 else if (FRAMEP (*all_frames))
1876 else if (!EQ (*all_frames, Qt))
1877 *all_frames = Qnil;
1881 /* Return the next or previous window of WINDOW in cyclic ordering
1882 of windows. NEXT_P non-zero means return the next window. See the
1883 documentation string of next-window for the meaning of MINIBUF and
1884 ALL_FRAMES. */
1886 static Lisp_Object
1887 next_window (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames, int next_p)
1889 decode_next_window_args (&window, &minibuf, &all_frames);
1891 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
1892 return the first window on the frame. */
1893 if (FRAMEP (all_frames)
1894 && !EQ (all_frames, XWINDOW (window)->frame))
1895 return Fframe_first_window (all_frames);
1897 if (next_p)
1899 Lisp_Object list;
1901 /* Find WINDOW in the list of all windows. */
1902 list = Fmemq (window, window_list ());
1904 /* Scan forward from WINDOW to the end of the window list. */
1905 if (CONSP (list))
1906 for (list = XCDR (list); CONSP (list); list = XCDR (list))
1907 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1908 break;
1910 /* Scan from the start of the window list up to WINDOW. */
1911 if (!CONSP (list))
1912 for (list = Vwindow_list;
1913 CONSP (list) && !EQ (XCAR (list), window);
1914 list = XCDR (list))
1915 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1916 break;
1918 if (CONSP (list))
1919 window = XCAR (list);
1921 else
1923 Lisp_Object candidate, list;
1925 /* Scan through the list of windows for candidates. If there are
1926 candidate windows in front of WINDOW, the last one of these
1927 is the one we want. If there are candidates following WINDOW
1928 in the list, again the last one of these is the one we want. */
1929 candidate = Qnil;
1930 for (list = window_list (); CONSP (list); list = XCDR (list))
1932 if (EQ (XCAR (list), window))
1934 if (WINDOWP (candidate))
1935 break;
1937 else if (candidate_window_p (XCAR (list), window, minibuf,
1938 all_frames))
1939 candidate = XCAR (list);
1942 if (WINDOWP (candidate))
1943 window = candidate;
1946 return window;
1950 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
1951 doc: /* Return window following WINDOW in cyclic ordering of windows.
1952 WINDOW defaults to the selected window. The optional arguments
1953 MINIBUF and ALL-FRAMES specify the set of windows to consider.
1955 MINIBUF t means consider the minibuffer window even if the
1956 minibuffer is not active. MINIBUF nil or omitted means consider
1957 the minibuffer window only if the minibuffer is active. Any
1958 other value means do not consider the minibuffer window even if
1959 the minibuffer is active.
1961 Several frames may share a single minibuffer; if the minibuffer
1962 is active, all windows on all frames that share that minibuffer
1963 are considered too. Therefore, if you are using a separate
1964 minibuffer frame and the minibuffer is active and MINIBUF says it
1965 counts, `next-window' considers the windows in the frame from
1966 which you entered the minibuffer, as well as the minibuffer
1967 window.
1969 ALL-FRAMES nil or omitted means consider all windows on WINDOW's
1970 frame, plus the minibuffer window if specified by the MINIBUF
1971 argument, see above. If the minibuffer counts, consider all
1972 windows on all frames that share that minibuffer too.
1973 ALL-FRAMES t means consider all windows on all existing frames.
1974 ALL-FRAMES `visible' means consider all windows on all visible
1975 frames on the current terminal.
1976 ALL-FRAMES 0 means consider all windows on all visible and
1977 iconified frames on the current terminal.
1978 ALL-FRAMES a frame means consider all windows on that frame only.
1979 Anything else means consider all windows on WINDOW's frame and no
1980 others.
1982 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
1983 `next-window' to iterate through the entire cycle of acceptable
1984 windows, eventually ending up back at the window you started with.
1985 `previous-window' traverses the same cycle, in the reverse order. */)
1986 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
1988 return next_window (window, minibuf, all_frames, 1);
1992 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
1993 doc: /* Return window preceding WINDOW in cyclic ordering of windows.
1994 WINDOW defaults to the selected window. The optional arguments
1995 MINIBUF and ALL-FRAMES specify the set of windows to consider.
1996 For the precise meaning of these arguments see `next-window'.
1998 If you use consistent values for MINIBUF and ALL-FRAMES, you can
1999 use `previous-window' to iterate through the entire cycle of
2000 acceptable windows, eventually ending up back at the window you
2001 started with. `next-window' traverses the same cycle, in the
2002 reverse order. */)
2003 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2005 return next_window (window, minibuf, all_frames, 0);
2009 DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p",
2010 doc: /* Select another window in cyclic ordering of windows.
2011 COUNT specifies the number of windows to skip, starting with the
2012 selected window, before making the selection. If COUNT is
2013 positive, skip COUNT windows forwards. If COUNT is negative,
2014 skip -COUNT windows backwards. COUNT zero means do not skip any
2015 window, so select the selected window. In an interactive call,
2016 COUNT is the numeric prefix argument. Return nil.
2018 This function uses `next-window' for finding the window to select.
2019 The argument ALL-FRAMES has the same meaning as in `next-window',
2020 but the MINIBUF argument of `next-window' is always effectively
2021 nil. */)
2022 (Lisp_Object count, Lisp_Object all_frames)
2024 Lisp_Object window;
2025 int i;
2027 CHECK_NUMBER (count);
2028 window = selected_window;
2030 for (i = XINT (count); i > 0; --i)
2031 window = Fnext_window (window, Qnil, all_frames);
2032 for (; i < 0; ++i)
2033 window = Fprevious_window (window, Qnil, all_frames);
2035 Fselect_window (window, Qnil);
2036 return Qnil;
2040 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
2041 doc: /* Return a list of windows on FRAME, starting with WINDOW.
2042 FRAME nil or omitted means use the selected frame.
2043 WINDOW nil or omitted means use the selected window.
2044 MINIBUF t means include the minibuffer window, even if it isn't active.
2045 MINIBUF nil or omitted means include the minibuffer window only
2046 if it's active.
2047 MINIBUF neither nil nor t means never include the minibuffer window. */)
2048 (Lisp_Object frame, Lisp_Object minibuf, Lisp_Object window)
2050 if (NILP (window))
2051 window = FRAMEP (frame) ? XFRAME (frame)->selected_window : selected_window;
2052 CHECK_WINDOW (window);
2053 if (NILP (frame))
2054 frame = selected_frame;
2056 if (!EQ (frame, XWINDOW (window)->frame))
2057 error ("Window is on a different frame");
2059 return window_list_1 (window, minibuf, frame);
2063 /* Return a list of windows in cyclic ordering. Arguments are like
2064 for `next-window'. */
2066 static Lisp_Object
2067 window_list_1 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2069 Lisp_Object tail, list, rest;
2071 decode_next_window_args (&window, &minibuf, &all_frames);
2072 list = Qnil;
2074 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
2075 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
2076 list = Fcons (XCAR (tail), list);
2078 /* Rotate the list to start with WINDOW. */
2079 list = Fnreverse (list);
2080 rest = Fmemq (window, list);
2081 if (!NILP (rest) && !EQ (rest, list))
2083 for (tail = list; !EQ (XCDR (tail), rest); tail = XCDR (tail))
2085 XSETCDR (tail, Qnil);
2086 list = nconc2 (rest, list);
2088 return list;
2093 /* Look at all windows, performing an operation specified by TYPE
2094 with argument OBJ.
2095 If FRAMES is Qt, look at all frames;
2096 Qnil, look at just the selected frame;
2097 Qvisible, look at visible frames;
2098 a frame, just look at windows on that frame.
2099 If MINI is non-zero, perform the operation on minibuffer windows too. */
2101 enum window_loop
2103 WINDOW_LOOP_UNUSED,
2104 GET_BUFFER_WINDOW, /* Arg is buffer */
2105 GET_LRU_WINDOW, /* Arg is t for full-width windows only */
2106 DELETE_OTHER_WINDOWS, /* Arg is window not to delete */
2107 DELETE_BUFFER_WINDOWS, /* Arg is buffer */
2108 GET_LARGEST_WINDOW,
2109 UNSHOW_BUFFER, /* Arg is buffer */
2110 REDISPLAY_BUFFER_WINDOWS, /* Arg is buffer */
2111 CHECK_ALL_WINDOWS
2114 static Lisp_Object
2115 window_loop (enum window_loop type, Lisp_Object obj, int mini, Lisp_Object frames)
2117 Lisp_Object window, windows, best_window, frame_arg;
2118 struct frame *f;
2119 struct gcpro gcpro1;
2121 /* If we're only looping through windows on a particular frame,
2122 frame points to that frame. If we're looping through windows
2123 on all frames, frame is 0. */
2124 if (FRAMEP (frames))
2125 f = XFRAME (frames);
2126 else if (NILP (frames))
2127 f = SELECTED_FRAME ();
2128 else
2129 f = NULL;
2131 if (f)
2132 frame_arg = Qlambda;
2133 else if (EQ (frames, make_number (0)))
2134 frame_arg = frames;
2135 else if (EQ (frames, Qvisible))
2136 frame_arg = frames;
2137 else
2138 frame_arg = Qt;
2140 /* frame_arg is Qlambda to stick to one frame,
2141 Qvisible to consider all visible frames,
2142 or Qt otherwise. */
2144 /* Pick a window to start with. */
2145 if (WINDOWP (obj))
2146 window = obj;
2147 else if (f)
2148 window = FRAME_SELECTED_WINDOW (f);
2149 else
2150 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2152 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
2153 GCPRO1 (windows);
2154 best_window = Qnil;
2156 for (; CONSP (windows); windows = XCDR (windows))
2158 struct window *w;
2160 window = XCAR (windows);
2161 w = XWINDOW (window);
2163 /* Note that we do not pay attention here to whether the frame
2164 is visible, since Fwindow_list skips non-visible frames if
2165 that is desired, under the control of frame_arg. */
2166 if (!MINI_WINDOW_P (w)
2167 /* For UNSHOW_BUFFER, we must always consider all windows. */
2168 || type == UNSHOW_BUFFER
2169 || (mini && minibuf_level > 0))
2170 switch (type)
2172 case GET_BUFFER_WINDOW:
2173 if (EQ (w->buffer, obj)
2174 /* Don't find any minibuffer window
2175 except the one that is currently in use. */
2176 && (MINI_WINDOW_P (w)
2177 ? EQ (window, minibuf_window)
2178 : 1))
2180 if (NILP (best_window))
2181 best_window = window;
2182 else if (EQ (window, selected_window))
2183 /* Prefer to return selected-window. */
2184 RETURN_UNGCPRO (window);
2185 else if (EQ (Fwindow_frame (window), selected_frame))
2186 /* Prefer windows on the current frame. */
2187 best_window = window;
2189 break;
2191 case GET_LRU_WINDOW:
2192 /* `obj' is an integer encoding a bitvector.
2193 `obj & 1' means consider only full-width windows.
2194 `obj & 2' means consider also dedicated windows. */
2195 if (((XINT (obj) & 1) && !WINDOW_FULL_WIDTH_P (w))
2196 || (!(XINT (obj) & 2) && !NILP (w->dedicated))
2197 /* Minibuffer windows are always ignored. */
2198 || MINI_WINDOW_P (w))
2199 break;
2200 if (NILP (best_window)
2201 || (XFASTINT (XWINDOW (best_window)->use_time)
2202 > XFASTINT (w->use_time)))
2203 best_window = window;
2204 break;
2206 case DELETE_OTHER_WINDOWS:
2207 if (!EQ (window, obj))
2208 Fdelete_window (window);
2209 break;
2211 case DELETE_BUFFER_WINDOWS:
2212 if (EQ (w->buffer, obj))
2214 struct frame *fr = XFRAME (WINDOW_FRAME (w));
2216 /* If this window is dedicated, and in a frame of its own,
2217 kill the frame. */
2218 if (EQ (window, FRAME_ROOT_WINDOW (fr))
2219 && !NILP (w->dedicated)
2220 && other_visible_frames (fr))
2222 /* Skip the other windows on this frame.
2223 There might be one, the minibuffer! */
2224 while (CONSP (XCDR (windows))
2225 && EQ (XWINDOW (XCAR (windows))->frame,
2226 XWINDOW (XCAR (XCDR (windows)))->frame))
2227 windows = XCDR (windows);
2229 /* Now we can safely delete the frame. */
2230 delete_frame (w->frame, Qnil);
2232 else if (NILP (w->parent))
2234 /* If we're deleting the buffer displayed in the
2235 only window on the frame, find a new buffer to
2236 display there. */
2237 Lisp_Object buffer;
2238 buffer = Fother_buffer (obj, Qnil, w->frame);
2239 /* Reset dedicated state of window. */
2240 w->dedicated = Qnil;
2241 Fset_window_buffer (window, buffer, Qnil);
2242 if (EQ (window, selected_window))
2243 Fset_buffer (w->buffer);
2245 else
2246 Fdelete_window (window);
2248 break;
2250 case GET_LARGEST_WINDOW:
2251 { /* nil `obj' means to ignore dedicated windows. */
2252 /* Ignore dedicated windows and minibuffers. */
2253 if (MINI_WINDOW_P (w) || (NILP (obj) && !NILP (w->dedicated)))
2254 break;
2256 if (NILP (best_window))
2257 best_window = window;
2258 else
2260 struct window *b = XWINDOW (best_window);
2261 if (XFASTINT (w->total_lines) * XFASTINT (w->total_cols)
2262 > XFASTINT (b->total_lines) * XFASTINT (b->total_cols))
2263 best_window = window;
2266 break;
2268 case UNSHOW_BUFFER:
2269 if (EQ (w->buffer, obj))
2271 Lisp_Object buffer;
2272 struct frame *fr = XFRAME (w->frame);
2274 /* Find another buffer to show in this window. */
2275 buffer = Fother_buffer (obj, Qnil, w->frame);
2277 /* If this window is dedicated, and in a frame of its own,
2278 kill the frame. */
2279 if (EQ (window, FRAME_ROOT_WINDOW (fr))
2280 && !NILP (w->dedicated)
2281 && other_visible_frames (fr))
2283 /* Skip the other windows on this frame.
2284 There might be one, the minibuffer! */
2285 while (CONSP (XCDR (windows))
2286 && EQ (XWINDOW (XCAR (windows))->frame,
2287 XWINDOW (XCAR (XCDR (windows)))->frame))
2288 windows = XCDR (windows);
2290 /* Now we can safely delete the frame. */
2291 delete_frame (w->frame, Qnil);
2293 else if (!NILP (w->dedicated) && !NILP (w->parent))
2295 Lisp_Object window_to_delete;
2296 XSETWINDOW (window_to_delete, w);
2297 /* If this window is dedicated and not the only window
2298 in its frame, then kill it. */
2299 Fdelete_window (window_to_delete);
2301 else
2303 /* Otherwise show a different buffer in the window. */
2304 w->dedicated = Qnil;
2305 Fset_window_buffer (window, buffer, Qnil);
2306 if (EQ (window, selected_window))
2307 Fset_buffer (w->buffer);
2310 break;
2312 case REDISPLAY_BUFFER_WINDOWS:
2313 if (EQ (w->buffer, obj))
2315 mark_window_display_accurate (window, 0);
2316 w->update_mode_line = Qt;
2317 XBUFFER (obj)->prevent_redisplay_optimizations_p = 1;
2318 ++update_mode_lines;
2319 best_window = window;
2321 break;
2323 /* Check for a window that has a killed buffer. */
2324 case CHECK_ALL_WINDOWS:
2325 if (! NILP (w->buffer)
2326 && NILP (BVAR (XBUFFER (w->buffer), name)))
2327 abort ();
2328 break;
2330 case WINDOW_LOOP_UNUSED:
2331 break;
2335 UNGCPRO;
2336 return best_window;
2339 /* Used for debugging. Abort if any window has a dead buffer. */
2341 extern void check_all_windows (void) EXTERNALLY_VISIBLE;
2342 void
2343 check_all_windows (void)
2345 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2348 DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
2349 doc: /* Return WINDOW's use time.
2350 WINDOW defaults to the selected window. The window with the highest use
2351 time is the most recently selected one. The window with the lowest use
2352 time is the least recently selected one. */)
2353 (Lisp_Object window)
2355 return decode_window (window)->use_time;
2358 DEFUN ("get-lru-window", Fget_lru_window, Sget_lru_window, 0, 2, 0,
2359 doc: /* Return the window least recently selected or used for display.
2360 \(LRU means Least Recently Used.)
2362 Return a full-width window if possible.
2363 A minibuffer window is never a candidate.
2364 A dedicated window is never a candidate, unless DEDICATED is non-nil,
2365 so if all windows are dedicated, the value is nil.
2366 If optional argument FRAME is `visible', search all visible frames.
2367 If FRAME is 0, search all visible and iconified frames.
2368 If FRAME is t, search all frames.
2369 If FRAME is nil, search only the selected frame.
2370 If FRAME is a frame, search only that frame. */)
2371 (Lisp_Object frame, Lisp_Object dedicated)
2373 register Lisp_Object w;
2374 /* First try for a window that is full-width */
2375 w = window_loop (GET_LRU_WINDOW,
2376 NILP (dedicated) ? make_number (1) : make_number (3),
2377 0, frame);
2378 if (!NILP (w) && !EQ (w, selected_window))
2379 return w;
2380 /* If none of them, try the rest */
2381 return window_loop (GET_LRU_WINDOW,
2382 NILP (dedicated) ? make_number (0) : make_number (2),
2383 0, frame);
2386 DEFUN ("get-largest-window", Fget_largest_window, Sget_largest_window, 0, 2, 0,
2387 doc: /* Return the largest window in area.
2388 A minibuffer window is never a candidate.
2389 A dedicated window is never a candidate unless DEDICATED is non-nil,
2390 so if all windows are dedicated, the value is nil.
2391 If optional argument FRAME is `visible', search all visible frames.
2392 If FRAME is 0, search all visible and iconified frames.
2393 If FRAME is t, search all frames.
2394 If FRAME is nil, search only the selected frame.
2395 If FRAME is a frame, search only that frame. */)
2396 (Lisp_Object frame, Lisp_Object dedicated)
2398 return window_loop (GET_LARGEST_WINDOW, dedicated, 0,
2399 frame);
2402 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 0, 2, 0,
2403 doc: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2404 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to the
2405 current buffer.
2406 If optional argument FRAME is `visible', search all visible frames.
2407 If optional argument FRAME is 0, search all visible and iconified frames.
2408 If FRAME is t, search all frames.
2409 If FRAME is nil, search only the selected frame.
2410 If FRAME is a frame, search only that frame. */)
2411 (Lisp_Object buffer_or_name, Lisp_Object frame)
2413 Lisp_Object buffer;
2415 if (NILP (buffer_or_name))
2416 buffer = Fcurrent_buffer ();
2417 else
2418 buffer = Fget_buffer (buffer_or_name);
2420 if (BUFFERP (buffer))
2421 return window_loop (GET_BUFFER_WINDOW, buffer, 1, frame);
2422 else
2423 return Qnil;
2426 DEFUN ("delete-other-windows", Fdelete_other_windows, Sdelete_other_windows,
2427 0, 1, "",
2428 doc: /* Make WINDOW (or the selected window) fill its frame.
2429 Only the frame WINDOW is on is affected.
2430 This function tries to reduce display jumps by keeping the text
2431 previously visible in WINDOW in the same place on the frame. Doing this
2432 depends on the value of (window-start WINDOW), so if calling this
2433 function in a program gives strange scrolling, make sure the
2434 window-start value is reasonable when this function is called. */)
2435 (Lisp_Object window)
2437 struct window *w;
2438 EMACS_INT startpos;
2439 int top, new_top;
2441 if (NILP (window))
2442 window = selected_window;
2443 else
2444 CHECK_LIVE_WINDOW (window);
2445 w = XWINDOW (window);
2447 startpos = marker_position (w->start);
2448 top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2450 if (MINI_WINDOW_P (w) && top > 0)
2451 error ("Can't expand minibuffer to full frame");
2453 window_loop (DELETE_OTHER_WINDOWS, window, 0, WINDOW_FRAME (w));
2455 /* Try to minimize scrolling, by setting the window start to the point
2456 will cause the text at the old window start to be at the same place
2457 on the frame. But don't try to do this if the window start is
2458 outside the visible portion (as might happen when the display is
2459 not current, due to typeahead). */
2460 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2461 if (new_top != top
2462 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2463 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2465 struct position pos;
2466 struct buffer *obuf = current_buffer;
2468 Fset_buffer (w->buffer);
2469 /* This computation used to temporarily move point, but that can
2470 have unwanted side effects due to text properties. */
2471 pos = *vmotion (startpos, -top, w);
2473 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2474 w->window_end_valid = Qnil;
2475 w->start_at_line_beg = ((pos.bytepos == BEGV_BYTE
2476 || FETCH_BYTE (pos.bytepos - 1) == '\n') ? Qt
2477 : Qnil);
2478 /* We need to do this, so that the window-scroll-functions
2479 get called. */
2480 w->optional_new_start = Qt;
2482 set_buffer_internal (obuf);
2485 return Qnil;
2488 DEFUN ("delete-windows-on", Fdelete_windows_on, Sdelete_windows_on,
2489 0, 2, "bDelete windows on (buffer): ",
2490 doc: /* Delete all windows showing BUFFER-OR-NAME.
2491 BUFFER-OR-NAME may be a buffer or the name of an existing buffer and
2492 defaults to the current buffer.
2494 Optional second argument FRAME controls which frames are affected.
2495 If optional argument FRAME is `visible', search all visible frames.
2496 If FRAME is 0, search all visible and iconified frames.
2497 If FRAME is nil, search all frames.
2498 If FRAME is t, search only the selected frame.
2499 If FRAME is a frame, search only that frame.
2500 When a window showing BUFFER-OR-NAME is dedicated and the only window of
2501 its frame, that frame is deleted when there are other frames left. */)
2502 (Lisp_Object buffer_or_name, Lisp_Object frame)
2504 Lisp_Object buffer;
2506 /* FRAME uses t and nil to mean the opposite of what window_loop
2507 expects. */
2508 if (NILP (frame))
2509 frame = Qt;
2510 else if (EQ (frame, Qt))
2511 frame = Qnil;
2513 if (NILP (buffer_or_name))
2514 buffer = Fcurrent_buffer ();
2515 else
2517 buffer = Fget_buffer (buffer_or_name);
2518 CHECK_BUFFER (buffer);
2521 window_loop (DELETE_BUFFER_WINDOWS, buffer, 0, frame);
2523 return Qnil;
2526 DEFUN ("replace-buffer-in-windows", Freplace_buffer_in_windows,
2527 Sreplace_buffer_in_windows,
2528 0, 1, "bReplace buffer in windows: ",
2529 doc: /* Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2530 BUFFER-OR-NAME may be a buffer or the name of an existing buffer and
2531 defaults to the current buffer.
2533 When a window showing BUFFER-OR-NAME is dedicated that window is
2534 deleted. If that window is the only window on its frame, that frame is
2535 deleted too when there are other frames left. If there are no other
2536 frames left, some other buffer is displayed in that window. */)
2537 (Lisp_Object buffer_or_name)
2539 Lisp_Object buffer;
2541 if (NILP (buffer_or_name))
2542 buffer = Fcurrent_buffer ();
2543 else
2545 buffer = Fget_buffer (buffer_or_name);
2546 CHECK_BUFFER (buffer);
2549 window_loop (UNSHOW_BUFFER, buffer, 0, Qt);
2551 return Qnil;
2554 /* Replace BUFFER with some other buffer in all windows
2555 of all frames, even those on other keyboards. */
2557 void
2558 replace_buffer_in_all_windows (Lisp_Object buffer)
2560 Lisp_Object tail, frame;
2562 /* A single call to window_loop won't do the job
2563 because it only considers frames on the current keyboard.
2564 So loop manually over frames, and handle each one. */
2565 FOR_EACH_FRAME (tail, frame)
2566 window_loop (UNSHOW_BUFFER, buffer, 1, frame);
2569 /* Set the height of WINDOW and all its inferiors. */
2571 /* The smallest acceptable dimensions for a window. Anything smaller
2572 might crash Emacs. */
2574 #define MIN_SAFE_WINDOW_WIDTH (2)
2575 #define MIN_SAFE_WINDOW_HEIGHT (1)
2577 /* For wp non-zero the total number of columns of window w. Otherwise
2578 the total number of lines of w. */
2580 #define WINDOW_TOTAL_SIZE(w, wp) \
2581 (wp ? WINDOW_TOTAL_COLS (w) : WINDOW_TOTAL_LINES (w))
2583 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2584 minimum allowable size. */
2586 void
2587 check_frame_size (FRAME_PTR frame, int *rows, int *cols)
2589 /* For height, we have to see:
2590 how many windows the frame has at minimum (one or two),
2591 and whether it has a menu bar or other special stuff at the top. */
2592 int min_height
2593 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
2594 ? MIN_SAFE_WINDOW_HEIGHT
2595 : 2 * MIN_SAFE_WINDOW_HEIGHT);
2597 if (FRAME_TOP_MARGIN (frame) > 0)
2598 min_height += FRAME_TOP_MARGIN (frame);
2600 if (*rows < min_height)
2601 *rows = min_height;
2602 if (*cols < MIN_SAFE_WINDOW_WIDTH)
2603 *cols = MIN_SAFE_WINDOW_WIDTH;
2606 /* Value is non-zero if window W is fixed-size. WIDTH_P non-zero means
2607 check if W's width can be changed, otherwise check W's height.
2608 CHECK_SIBLINGS_P non-zero means check resizablity of WINDOW's
2609 siblings, too. If none of the siblings is resizable, WINDOW isn't
2610 either. */
2612 static int
2613 window_fixed_size_p (struct window *w, int width_p, int check_siblings_p)
2615 int fixed_p;
2616 struct window *c;
2618 if (!NILP (w->hchild))
2620 c = XWINDOW (w->hchild);
2622 if (width_p)
2624 /* A horizontal combination is fixed-width if all of if its
2625 children are. */
2626 while (c && window_fixed_size_p (c, width_p, 0))
2627 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2628 fixed_p = c == NULL;
2630 else
2632 /* A horizontal combination is fixed-height if one of if its
2633 children is. */
2634 while (c && !window_fixed_size_p (c, width_p, 0))
2635 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2636 fixed_p = c != NULL;
2639 else if (!NILP (w->vchild))
2641 c = XWINDOW (w->vchild);
2643 if (width_p)
2645 /* A vertical combination is fixed-width if one of if its
2646 children is. */
2647 while (c && !window_fixed_size_p (c, width_p, 0))
2648 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2649 fixed_p = c != NULL;
2651 else
2653 /* A vertical combination is fixed-height if all of if its
2654 children are. */
2655 while (c && window_fixed_size_p (c, width_p, 0))
2656 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2657 fixed_p = c == NULL;
2660 else if (BUFFERP (w->buffer))
2662 struct buffer *old = current_buffer;
2663 Lisp_Object val;
2665 current_buffer = XBUFFER (w->buffer);
2666 val = find_symbol_value (Qwindow_size_fixed);
2667 current_buffer = old;
2669 fixed_p = 0;
2670 if (!EQ (val, Qunbound))
2672 fixed_p = !NILP (val);
2674 if (fixed_p
2675 && ((EQ (val, Qheight) && width_p)
2676 || (EQ (val, Qwidth) && !width_p)))
2677 fixed_p = 0;
2680 /* Can't tell if this one is resizable without looking at
2681 siblings. If all siblings are fixed-size this one is too. */
2682 if (!fixed_p && check_siblings_p && WINDOWP (w->parent))
2684 Lisp_Object child;
2686 for (child = w->prev; WINDOWP (child); child = XWINDOW (child)->prev)
2687 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2688 break;
2690 if (NILP (child))
2691 for (child = w->next; WINDOWP (child); child = XWINDOW (child)->next)
2692 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2693 break;
2695 if (NILP (child))
2696 fixed_p = 1;
2699 else
2700 fixed_p = 1;
2702 return fixed_p;
2705 /* Return minimum size of leaf window W. WIDTH_P non-zero means return
2706 the minimum width of W, WIDTH_P zero means return the minimum height
2707 of W. SAFE_P non-zero means ignore window-min-height|width but just
2708 return values that won't crash Emacs and don't hide components like
2709 fringes, scrollbars, or modelines. If WIDTH_P is zero and W is the
2710 minibuffer window, always return 1. */
2712 static int
2713 window_min_size_2 (struct window *w, int width_p, int safe_p)
2715 /* We should consider buffer-local values of window_min_height and
2716 window_min_width here. */
2717 if (width_p)
2719 int safe_size = (MIN_SAFE_WINDOW_WIDTH
2720 + WINDOW_FRINGE_COLS (w)
2721 + WINDOW_SCROLL_BAR_COLS (w));
2723 return safe_p ? safe_size : max (window_min_width, safe_size);
2725 else if (MINI_WINDOW_P (w))
2726 return 1;
2727 else
2729 int safe_size = (MIN_SAFE_WINDOW_HEIGHT
2730 + ((BUFFERP (w->buffer)
2731 && !NILP (BVAR (XBUFFER (w->buffer), mode_line_format)))
2732 ? 1 : 0));
2734 return safe_p ? safe_size : max (window_min_height, safe_size);
2738 /* Return minimum size of window W, not taking fixed-width windows into
2739 account. WIDTH_P non-zero means return the minimum width, otherwise
2740 return the minimum height. SAFE_P non-zero means ignore
2741 window-min-height|width but just return values that won't crash Emacs
2742 and don't hide components like fringes, scrollbars, or modelines. If
2743 W is a combination window, compute the minimum size from the minimum
2744 sizes of W's children. */
2746 static int
2747 window_min_size_1 (struct window *w, int width_p, int safe_p)
2749 struct window *c;
2750 int size;
2752 if (!NILP (w->hchild))
2754 /* W is a horizontal combination. */
2755 c = XWINDOW (w->hchild);
2756 size = 0;
2758 if (width_p)
2760 /* The minimum width of a horizontal combination is the sum of
2761 the minimum widths of its children. */
2762 while (c)
2764 size += window_min_size_1 (c, 1, safe_p);
2765 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2768 else
2770 /* The minimum height of a horizontal combination is the
2771 maximum of the minimum heights of its children. */
2772 while (c)
2774 size = max (window_min_size_1 (c, 0, safe_p), size);
2775 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2779 else if (!NILP (w->vchild))
2781 /* W is a vertical combination. */
2782 c = XWINDOW (w->vchild);
2783 size = 0;
2785 if (width_p)
2787 /* The minimum width of a vertical combination is the maximum
2788 of the minimum widths of its children. */
2789 while (c)
2791 size = max (window_min_size_1 (c, 1, safe_p), size);
2792 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2795 else
2797 /* The minimum height of a vertical combination is the sum of
2798 the minimum height of its children. */
2799 while (c)
2801 size += window_min_size_1 (c, 0, safe_p);
2802 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2806 else
2807 /* W is a leaf window. */
2808 size = window_min_size_2 (w, width_p, safe_p);
2810 return size;
2813 /* Return the minimum size of window W, taking fixed-size windows into
2814 account. WIDTH_P non-zero means return the minimum width, otherwise
2815 return the minimum height. SAFE_P non-zero means ignore
2816 window-min-height|width but just return values that won't crash Emacs
2817 and don't hide components like fringes, scrollbars, or modelines.
2818 IGNORE_FIXED_P non-zero means ignore if W is fixed-size. Set *FIXED
2819 to 1 if W is fixed-size unless FIXED is null. */
2821 static int
2822 window_min_size (struct window *w, int width_p, int safe_p, int ignore_fixed_p, int *fixed)
2824 int size, fixed_p;
2826 if (ignore_fixed_p)
2827 fixed_p = 0;
2828 else
2829 fixed_p = window_fixed_size_p (w, width_p, 1);
2831 if (fixed)
2832 *fixed = fixed_p;
2834 if (fixed_p)
2835 size = WINDOW_TOTAL_SIZE (w, width_p);
2836 else
2837 size = window_min_size_1 (w, width_p, safe_p);
2839 return size;
2843 /* Adjust the margins of window W if text area is too small.
2844 Return 1 if window width is ok after adjustment; 0 if window
2845 is still too narrow. */
2847 static int
2848 adjust_window_margins (struct window *w)
2850 int box_cols = (WINDOW_TOTAL_COLS (w)
2851 - WINDOW_FRINGE_COLS (w)
2852 - WINDOW_SCROLL_BAR_COLS (w));
2853 int margin_cols = (WINDOW_LEFT_MARGIN_COLS (w)
2854 + WINDOW_RIGHT_MARGIN_COLS (w));
2856 if (box_cols - margin_cols >= MIN_SAFE_WINDOW_WIDTH)
2857 return 1;
2859 if (margin_cols < 0 || box_cols < MIN_SAFE_WINDOW_WIDTH)
2860 return 0;
2862 /* Window's text area is too narrow, but reducing the window
2863 margins will fix that. */
2864 margin_cols = box_cols - MIN_SAFE_WINDOW_WIDTH;
2865 if (WINDOW_RIGHT_MARGIN_COLS (w) > 0)
2867 if (WINDOW_LEFT_MARGIN_COLS (w) > 0)
2868 w->left_margin_cols = w->right_margin_cols
2869 = make_number (margin_cols/2);
2870 else
2871 w->right_margin_cols = make_number (margin_cols);
2873 else
2874 w->left_margin_cols = make_number (margin_cols);
2875 return 1;
2878 /* Calculate new sizes for windows in the list FORWARD when their
2879 compound size goes from TOTAL to SIZE. TOTAL must be greater than
2880 SIZE. The number of windows in FORWARD is NCHILDREN, and the number
2881 that can shrink is SHRINKABLE. Fixed-size windows may be shrunk if
2882 and only if RESIZE_FIXED_P is non-zero. WIDTH_P non-zero means
2883 shrink columns, otherwise shrink lines.
2885 SAFE_P zero means windows may be sized down to window-min-height
2886 lines (window-min-window columns for WIDTH_P non-zero). SAFE_P
2887 non-zero means windows may be sized down to their minimum safe sizes
2888 taking into account the space needed to display modelines, fringes,
2889 and scrollbars.
2891 This function returns an allocated array of new sizes that the caller
2892 must free. A size -1 means the window is fixed and RESIZE_FIXED_P is
2893 zero. A size zero means the window shall be deleted. Array index 0
2894 refers to the first window in FORWARD, 1 to the second, and so on.
2896 This function resizes windows proportionally to their size. It also
2897 tries to preserve smaller windows by resizing larger windows before
2898 resizing any window to zero. If resize_proportionally is non-nil for
2899 a specific window, it will attempt to strictly resize that window
2900 proportionally, even at the expense of deleting smaller windows. */
2901 static int *
2902 shrink_windows (int total, int size, int nchildren, int shrinkable,
2903 int resize_fixed_p, Lisp_Object forward, int width_p, int safe_p)
2905 int available_resize = 0;
2906 int *new_sizes, *min_sizes;
2907 struct window *c;
2908 Lisp_Object child;
2909 int smallest = total;
2910 int total_removed = 0;
2911 int total_shrink = total - size;
2912 int i;
2914 new_sizes = xmalloc (sizeof (*new_sizes) * nchildren);
2915 min_sizes = xmalloc (sizeof (*min_sizes) * nchildren);
2917 for (i = 0, child = forward; !NILP (child); child = c->next, ++i)
2919 int child_size;
2921 c = XWINDOW (child);
2922 child_size = WINDOW_TOTAL_SIZE (c, width_p);
2924 if (!resize_fixed_p && window_fixed_size_p (c, width_p, 0))
2925 new_sizes[i] = -1;
2926 else
2928 new_sizes[i] = child_size;
2929 min_sizes[i] = window_min_size_1 (c, width_p, safe_p);
2930 if (child_size > min_sizes[i]
2931 && NILP (c->resize_proportionally))
2932 available_resize += child_size - min_sizes[i];
2935 /* We might need to shrink some windows to zero. Find the smallest
2936 windows and set them to 0 until we can fulfil the new size. */
2938 while (shrinkable > 1 && size + available_resize < total)
2940 for (i = 0; i < nchildren; ++i)
2941 if (new_sizes[i] > 0 && smallest > new_sizes[i])
2942 smallest = new_sizes[i];
2944 for (i = 0; i < nchildren; ++i)
2945 if (new_sizes[i] == smallest)
2947 /* Resize this window down to zero. */
2948 new_sizes[i] = 0;
2949 if (smallest > min_sizes[i])
2950 available_resize -= smallest - min_sizes[i];
2951 available_resize += smallest;
2952 --shrinkable;
2953 total_removed += smallest;
2955 /* We don't know what the smallest is now. */
2956 smallest = total;
2958 /* Out of for, just remove one window at the time and
2959 check again if we have enough space. */
2960 break;
2964 /* Now, calculate the new sizes. Try to shrink each window
2965 proportional to its size. */
2966 for (i = 0; i < nchildren; ++i)
2968 if (new_sizes[i] > min_sizes[i])
2970 int to_shrink = total_shrink * new_sizes[i] / total;
2972 if (new_sizes[i] - to_shrink < min_sizes[i])
2973 to_shrink = new_sizes[i] - min_sizes[i];
2974 new_sizes[i] -= to_shrink;
2975 total_removed += to_shrink;
2979 /* Any reminder due to rounding, we just subtract from windows
2980 that are left and still can be shrunk. */
2981 while (total_shrink > total_removed)
2983 int nonzero_sizes = 0;
2985 for (i = 0; i < nchildren; ++i)
2986 if (new_sizes[i] > 0)
2987 ++nonzero_sizes;
2989 for (i = 0; i < nchildren; ++i)
2990 if (new_sizes[i] > min_sizes[i])
2992 --new_sizes[i];
2993 ++total_removed;
2995 /* Out of for, just shrink one window at the time and
2996 check again if we have enough space. */
2997 break;
3000 /* Special case, only one window left. */
3001 if (nonzero_sizes == 1)
3002 break;
3005 /* Any surplus due to rounding, we add to windows that are left. */
3006 while (total_shrink < total_removed)
3008 for (i = 0; i < nchildren; ++i)
3010 if (new_sizes[i] != 0 && total_shrink < total_removed)
3012 ++new_sizes[i];
3013 --total_removed;
3014 break;
3019 xfree (min_sizes);
3021 return new_sizes;
3024 /* Set WINDOW's height or width to SIZE. WIDTH_P non-zero means set
3025 WINDOW's width. Resize WINDOW's children, if any, so that they keep
3026 their proportionate size relative to WINDOW.
3028 If FIRST_ONLY is 1, change only the first of WINDOW's children when
3029 they are in series. If LAST_ONLY is 1, change only the last of
3030 WINDOW's children when they are in series.
3032 Propagate WINDOW's top or left edge position to children. Delete
3033 windows that become too small unless NODELETE_P is 1. When
3034 NODELETE_P equals 2 do not honor settings for window-min-height and
3035 window-min-width when resizing windows but use safe defaults instead.
3036 This should give better behavior when resizing frames. */
3038 static void
3039 size_window (Lisp_Object window, int size, int width_p, int nodelete_p, int first_only, int last_only)
3041 struct window *w = XWINDOW (window);
3042 struct window *c;
3043 Lisp_Object child, *forward, *sideward;
3044 int old_size = WINDOW_TOTAL_SIZE (w, width_p);
3046 size = max (0, size);
3048 /* Delete WINDOW if it's too small. */
3049 if (nodelete_p != 1 && !NILP (w->parent)
3050 && size < window_min_size_1 (w, width_p, nodelete_p == 2))
3052 delete_window (window);
3053 return;
3056 /* Set redisplay hints. */
3057 w->last_modified = make_number (0);
3058 w->last_overlay_modified = make_number (0);
3059 windows_or_buffers_changed++;
3060 FRAME_WINDOW_SIZES_CHANGED (XFRAME (w->frame)) = 1;
3062 if (width_p)
3064 sideward = &w->vchild;
3065 forward = &w->hchild;
3066 w->total_cols = make_number (size);
3067 adjust_window_margins (w);
3069 else
3071 sideward = &w->hchild;
3072 forward = &w->vchild;
3073 w->total_lines = make_number (size);
3074 w->orig_total_lines = Qnil;
3077 if (!NILP (*sideward))
3079 /* We have a chain of parallel siblings whose size should all change. */
3080 for (child = *sideward; !NILP (child); child = c->next)
3082 c = XWINDOW (child);
3083 if (width_p)
3084 c->left_col = w->left_col;
3085 else
3086 c->top_line = w->top_line;
3087 size_window (child, size, width_p, nodelete_p,
3088 first_only, last_only);
3091 else if (!NILP (*forward) && last_only)
3093 /* Change the last in a series of siblings. */
3094 Lisp_Object last_child;
3095 int child_size;
3097 child = *forward;
3100 c = XWINDOW (child);
3101 last_child = child;
3102 child = c->next;
3104 while (!NILP (child));
3106 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3107 size_window (last_child, size - old_size + child_size,
3108 width_p, nodelete_p, first_only, last_only);
3110 else if (!NILP (*forward) && first_only)
3112 /* Change the first in a series of siblings. */
3113 int child_size;
3115 child = *forward;
3116 c = XWINDOW (child);
3118 if (width_p)
3119 c->left_col = w->left_col;
3120 else
3121 c->top_line = w->top_line;
3123 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3124 size_window (child, size - old_size + child_size,
3125 width_p, nodelete_p, first_only, last_only);
3127 else if (!NILP (*forward))
3129 int fixed_size, each IF_LINT (= 0), extra IF_LINT (= 0), n;
3130 int resize_fixed_p, nfixed;
3131 int last_pos, first_pos, nchildren, total;
3132 int *new_sizes = NULL;
3134 /* Determine the fixed-size portion of this window, and the
3135 number of child windows. */
3136 fixed_size = nchildren = nfixed = total = 0;
3137 for (child = *forward; !NILP (child); child = c->next, ++nchildren)
3139 int child_size;
3141 c = XWINDOW (child);
3142 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3143 total += child_size;
3145 if (window_fixed_size_p (c, width_p, 0))
3147 fixed_size += child_size;
3148 ++nfixed;
3152 /* If the new size is smaller than fixed_size, or if there
3153 aren't any resizable windows, allow resizing fixed-size
3154 windows. */
3155 resize_fixed_p = nfixed == nchildren || size < fixed_size;
3157 /* Compute how many lines/columns to add/remove to each child. The
3158 value of extra takes care of rounding errors. */
3159 n = resize_fixed_p ? nchildren : nchildren - nfixed;
3160 if (size < total && n > 1)
3161 new_sizes = shrink_windows (total, size, nchildren, n,
3162 resize_fixed_p, *forward, width_p,
3163 nodelete_p == 2);
3164 else
3166 each = (size - total) / n;
3167 extra = (size - total) - n * each;
3170 /* Compute new children heights and edge positions. */
3171 first_pos = width_p ? XINT (w->left_col) : XINT (w->top_line);
3172 last_pos = first_pos;
3173 for (n = 0, child = *forward; !NILP (child); child = c->next, ++n)
3175 int new_child_size, old_child_size;
3177 c = XWINDOW (child);
3178 old_child_size = WINDOW_TOTAL_SIZE (c, width_p);
3179 new_child_size = old_child_size;
3181 /* The top or left edge position of this child equals the
3182 bottom or right edge of its predecessor. */
3183 if (width_p)
3184 c->left_col = make_number (last_pos);
3185 else
3186 c->top_line = make_number (last_pos);
3188 /* If this child can be resized, do it. */
3189 if (resize_fixed_p || !window_fixed_size_p (c, width_p, 0))
3191 new_child_size =
3192 new_sizes ? new_sizes[n] : old_child_size + each + extra;
3193 extra = 0;
3196 /* Set new size. Note that size_window also propagates
3197 edge positions to children, so it's not a no-op if we
3198 didn't change the child's size. */
3199 size_window (child, new_child_size, width_p, 1,
3200 first_only, last_only);
3202 /* Remember the bottom/right edge position of this child; it
3203 will be used to set the top/left edge of the next child. */
3204 last_pos += new_child_size;
3207 xfree (new_sizes);
3209 /* We should have covered the parent exactly with child windows. */
3210 xassert (size == last_pos - first_pos);
3212 /* Now delete any children that became too small. */
3213 if (nodelete_p != 1)
3214 for (child = *forward; !NILP (child); child = c->next)
3216 int child_size;
3218 c = XWINDOW (child);
3219 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3220 size_window (child, child_size, width_p, nodelete_p,
3221 first_only, last_only);
3226 /* Set WINDOW's height to HEIGHT, and recursively change the height of
3227 WINDOW's children. NODELETE zero means windows that have become
3228 smaller than window-min-height in the process may be deleted.
3229 NODELETE 1 means never delete windows that become too small in the
3230 process. (The caller should check later and do so if appropriate.)
3231 NODELETE 2 means delete only windows that have become too small to be
3232 displayed correctly. */
3234 void
3235 set_window_height (Lisp_Object window, int height, int nodelete)
3237 size_window (window, height, 0, nodelete, 0, 0);
3240 /* Set WINDOW's width to WIDTH, and recursively change the width of
3241 WINDOW's children. NODELETE zero means windows that have become
3242 smaller than window-min-width in the process may be deleted.
3243 NODELETE 1 means never delete windows that become too small in the
3244 process. (The caller should check later and do so if appropriate.)
3245 NODELETE 2 means delete only windows that have become too small to be
3246 displayed correctly. */
3248 void
3249 set_window_width (Lisp_Object window, int width, int nodelete)
3251 size_window (window, width, 1, nodelete, 0, 0);
3254 /* Change window heights in windows rooted in WINDOW by N lines. */
3256 void
3257 change_window_heights (Lisp_Object window, int n)
3259 struct window *w = XWINDOW (window);
3261 XSETFASTINT (w->top_line, XFASTINT (w->top_line) + n);
3262 XSETFASTINT (w->total_lines, XFASTINT (w->total_lines) - n);
3264 if (INTEGERP (w->orig_top_line))
3265 XSETFASTINT (w->orig_top_line, XFASTINT (w->orig_top_line) + n);
3266 if (INTEGERP (w->orig_total_lines))
3267 XSETFASTINT (w->orig_total_lines, XFASTINT (w->orig_total_lines) - n);
3269 /* Handle just the top child in a vertical split. */
3270 if (!NILP (w->vchild))
3271 change_window_heights (w->vchild, n);
3273 /* Adjust all children in a horizontal split. */
3274 for (window = w->hchild; !NILP (window); window = w->next)
3276 w = XWINDOW (window);
3277 change_window_heights (window, n);
3282 int window_select_count;
3284 static Lisp_Object Fset_window_margins (Lisp_Object, Lisp_Object, Lisp_Object);
3285 static Lisp_Object Fset_window_fringes (Lisp_Object, Lisp_Object, Lisp_Object,
3286 Lisp_Object);
3287 static Lisp_Object Fset_window_scroll_bars (Lisp_Object, Lisp_Object,
3288 Lisp_Object, Lisp_Object);
3289 static Lisp_Object Fset_window_vscroll (Lisp_Object, Lisp_Object, Lisp_Object);
3291 static void
3292 run_funs (Lisp_Object funs)
3294 for (; CONSP (funs); funs = XCDR (funs))
3295 if (!EQ (XCAR (funs), Qt))
3296 call0 (XCAR (funs));
3299 static Lisp_Object select_window_norecord (Lisp_Object window);
3300 static Lisp_Object select_frame_norecord (Lisp_Object frame);
3302 void
3303 run_window_configuration_change_hook (struct frame *f)
3305 int count = SPECPDL_INDEX ();
3306 Lisp_Object frame, global_wcch
3307 = Fdefault_value (Qwindow_configuration_change_hook);
3308 XSETFRAME (frame, f);
3310 if (NILP (Vrun_hooks))
3311 return;
3313 if (SELECTED_FRAME () != f)
3315 record_unwind_protect (select_frame_norecord, Fselected_frame ());
3316 Fselect_frame (frame, Qt);
3319 /* Use the right buffer. Matters when running the local hooks. */
3320 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
3322 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3323 Fset_buffer (Fwindow_buffer (Qnil));
3326 /* Look for buffer-local values. */
3328 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
3329 for (; CONSP (windows); windows = XCDR (windows))
3331 Lisp_Object window = XCAR (windows);
3332 Lisp_Object buffer = Fwindow_buffer (window);
3333 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
3334 buffer)))
3336 int count1 = SPECPDL_INDEX ();
3337 record_unwind_protect (select_window_norecord, Fselected_window ());
3338 select_window_norecord (window);
3339 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
3340 buffer));
3341 unbind_to (count1, Qnil);
3346 run_funs (global_wcch);
3347 unbind_to (count, Qnil);
3350 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
3351 means it's allowed to run hooks. See make_frame for a case where
3352 it's not allowed. KEEP_MARGINS_P non-zero means that the current
3353 margins, fringes, and scroll-bar settings of the window are not
3354 reset from the buffer's local settings. */
3356 void
3357 set_window_buffer (Lisp_Object window, Lisp_Object buffer, int run_hooks_p, int keep_margins_p)
3359 struct window *w = XWINDOW (window);
3360 struct buffer *b = XBUFFER (buffer);
3361 int count = SPECPDL_INDEX ();
3362 int samebuf = EQ (buffer, w->buffer);
3364 w->buffer = buffer;
3366 if (EQ (window, selected_window))
3367 BVAR (b, last_selected_window) = window;
3369 /* Let redisplay errors through. */
3370 b->display_error_modiff = 0;
3372 /* Update time stamps of buffer display. */
3373 if (INTEGERP (BVAR (b, display_count)))
3374 XSETINT (BVAR (b, display_count), XINT (BVAR (b, display_count)) + 1);
3375 BVAR (b, display_time) = Fcurrent_time ();
3377 XSETFASTINT (w->window_end_pos, 0);
3378 XSETFASTINT (w->window_end_vpos, 0);
3379 memset (&w->last_cursor, 0, sizeof w->last_cursor);
3380 w->window_end_valid = Qnil;
3381 if (!(keep_margins_p && samebuf))
3382 { /* If we're not actually changing the buffer, don't reset hscroll and
3383 vscroll. This case happens for example when called from
3384 change_frame_size_1, where we use a dummy call to
3385 Fset_window_buffer on the frame's selected window (and no other)
3386 just in order to run window-configuration-change-hook.
3387 Resetting hscroll and vscroll here is problematic for things like
3388 image-mode and doc-view-mode since it resets the image's position
3389 whenever we resize the frame. */
3390 w->hscroll = w->min_hscroll = make_number (0);
3391 w->vscroll = 0;
3392 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3393 set_marker_restricted (w->start,
3394 make_number (b->last_window_start),
3395 buffer);
3396 w->start_at_line_beg = Qnil;
3397 w->force_start = Qnil;
3398 XSETFASTINT (w->last_modified, 0);
3399 XSETFASTINT (w->last_overlay_modified, 0);
3401 /* Maybe we could move this into the `if' but it's not obviously safe and
3402 I doubt it's worth the trouble. */
3403 windows_or_buffers_changed++;
3405 /* We must select BUFFER for running the window-scroll-functions. */
3406 /* We can't check ! NILP (Vwindow_scroll_functions) here
3407 because that might itself be a local variable. */
3408 if (window_initialized)
3410 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3411 Fset_buffer (buffer);
3414 XMARKER (w->pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3416 if (!keep_margins_p)
3418 /* Set left and right marginal area width etc. from buffer. */
3420 /* This may call adjust_window_margins three times, so
3421 temporarily disable window margins. */
3422 Lisp_Object save_left = w->left_margin_cols;
3423 Lisp_Object save_right = w->right_margin_cols;
3425 w->left_margin_cols = w->right_margin_cols = Qnil;
3427 Fset_window_fringes (window,
3428 BVAR (b, left_fringe_width), BVAR (b, right_fringe_width),
3429 BVAR (b, fringes_outside_margins));
3431 Fset_window_scroll_bars (window,
3432 BVAR (b, scroll_bar_width),
3433 BVAR (b, vertical_scroll_bar_type), Qnil);
3435 w->left_margin_cols = save_left;
3436 w->right_margin_cols = save_right;
3438 Fset_window_margins (window,
3439 BVAR (b, left_margin_cols), BVAR (b, right_margin_cols));
3442 if (run_hooks_p)
3444 if (! NILP (Vwindow_scroll_functions))
3445 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3446 Fmarker_position (w->start));
3447 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3450 unbind_to (count, Qnil);
3454 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3455 doc: /* Make WINDOW display BUFFER-OR-NAME as its contents.
3456 WINDOW defaults to the selected window. BUFFER-OR-NAME must be a buffer
3457 or the name of an existing buffer. Optional third argument KEEP-MARGINS
3458 non-nil means that WINDOW's current display margins, fringe widths, and
3459 scroll bar settings are preserved; the default is to reset these from
3460 the local settings for BUFFER-OR-NAME or the frame defaults. Return nil.
3462 This function throws an error when WINDOW is strongly dedicated to its
3463 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3464 already display BUFFER-OR-NAME.
3466 This function runs `window-scroll-functions' before running
3467 `window-configuration-change-hook'. */)
3468 (register Lisp_Object window, Lisp_Object buffer_or_name, Lisp_Object keep_margins)
3470 register Lisp_Object tem, buffer;
3471 register struct window *w = decode_window (window);
3473 XSETWINDOW (window, w);
3474 buffer = Fget_buffer (buffer_or_name);
3475 CHECK_BUFFER (buffer);
3476 if (NILP (BVAR (XBUFFER (buffer), name)))
3477 error ("Attempt to display deleted buffer");
3479 tem = w->buffer;
3480 if (NILP (tem))
3481 error ("Window is deleted");
3482 else if (!EQ (tem, Qt))
3483 /* w->buffer is t when the window is first being set up. */
3485 if (EQ (tem, buffer))
3486 return Qnil;
3487 else if (EQ (w->dedicated, Qt))
3488 error ("Window is dedicated to `%s'", SDATA (BVAR (XBUFFER (tem), name)));
3489 else
3490 w->dedicated = Qnil;
3492 unshow_buffer (w);
3495 set_window_buffer (window, buffer, 1, !NILP (keep_margins));
3496 return Qnil;
3499 /* If select_window is called with inhibit_point_swap non-zero it will
3500 not store point of the old selected window's buffer back into that
3501 window's pointm slot. This is needed by Fset_window_configuration to
3502 avoid that the display routine is called with selected_window set to
3503 Qnil causing a subsequent crash. */
3505 static Lisp_Object
3506 select_window (Lisp_Object window, Lisp_Object norecord, int inhibit_point_swap)
3508 register struct window *w;
3509 register struct window *ow;
3510 struct frame *sf;
3512 CHECK_LIVE_WINDOW (window);
3514 w = XWINDOW (window);
3515 w->frozen_window_start_p = 0;
3517 if (NILP (norecord))
3519 ++window_select_count;
3520 XSETFASTINT (w->use_time, window_select_count);
3521 record_buffer (w->buffer);
3524 if (EQ (window, selected_window) && !inhibit_point_swap)
3525 return window;
3527 sf = SELECTED_FRAME ();
3528 if (XFRAME (WINDOW_FRAME (w)) != sf)
3530 XFRAME (WINDOW_FRAME (w))->selected_window = window;
3531 /* Use this rather than Fhandle_switch_frame
3532 so that FRAME_FOCUS_FRAME is moved appropriately as we
3533 move around in the state where a minibuffer in a separate
3534 frame is active. */
3535 Fselect_frame (WINDOW_FRAME (w), norecord);
3536 /* Fselect_frame called us back so we've done all the work already. */
3537 eassert (EQ (window, selected_window));
3538 return window;
3540 else
3541 sf->selected_window = window;
3543 /* Store the current buffer's actual point into the
3544 old selected window. It belongs to that window,
3545 and when the window is not selected, must be in the window. */
3546 if (!inhibit_point_swap)
3548 ow = XWINDOW (selected_window);
3549 if (! NILP (ow->buffer))
3550 set_marker_both (ow->pointm, ow->buffer,
3551 BUF_PT (XBUFFER (ow->buffer)),
3552 BUF_PT_BYTE (XBUFFER (ow->buffer)));
3555 selected_window = window;
3557 Fset_buffer (w->buffer);
3559 BVAR (XBUFFER (w->buffer), last_selected_window) = window;
3561 /* Go to the point recorded in the window.
3562 This is important when the buffer is in more
3563 than one window. It also matters when
3564 redisplay_window has altered point after scrolling,
3565 because it makes the change only in the window. */
3567 register EMACS_INT new_point = marker_position (w->pointm);
3568 if (new_point < BEGV)
3569 SET_PT (BEGV);
3570 else if (new_point > ZV)
3571 SET_PT (ZV);
3572 else
3573 SET_PT (new_point);
3576 windows_or_buffers_changed++;
3577 return window;
3581 /* Note that selected_window can be nil when this is called from
3582 Fset_window_configuration. */
3584 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
3585 doc: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
3586 If WINDOW is not already selected, make WINDOW's buffer current
3587 and make WINDOW the frame's selected window. Return WINDOW.
3588 Optional second arg NORECORD non-nil means do not put this buffer
3589 at the front of the list of recently selected ones and do not
3590 make this window the most recently selected one.
3592 Note that the main editor command loop selects the buffer of the
3593 selected window before each command. */)
3594 (register Lisp_Object window, Lisp_Object norecord)
3596 return select_window (window, norecord, 0);
3599 static Lisp_Object
3600 select_window_norecord (Lisp_Object window)
3602 return WINDOW_LIVE_P (window)
3603 ? Fselect_window (window, Qt) : selected_window;
3606 static Lisp_Object
3607 select_frame_norecord (Lisp_Object frame)
3609 return FRAME_LIVE_P (XFRAME (frame))
3610 ? Fselect_frame (frame, Qt) : selected_frame;
3613 static Lisp_Object
3614 display_buffer (Lisp_Object buffer, Lisp_Object not_this_window_p, Lisp_Object override_frame)
3616 return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame);
3619 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3620 0, 1, 0,
3621 doc: /* Force all windows to be updated on next redisplay.
3622 If optional arg OBJECT is a window, force redisplay of that window only.
3623 If OBJECT is a buffer or buffer name, force redisplay of all windows
3624 displaying that buffer. */)
3625 (Lisp_Object object)
3627 if (NILP (object))
3629 windows_or_buffers_changed++;
3630 update_mode_lines++;
3631 return Qt;
3634 if (WINDOWP (object))
3636 struct window *w = XWINDOW (object);
3637 mark_window_display_accurate (object, 0);
3638 w->update_mode_line = Qt;
3639 if (BUFFERP (w->buffer))
3640 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
3641 ++update_mode_lines;
3642 return Qt;
3645 if (STRINGP (object))
3646 object = Fget_buffer (object);
3647 if (BUFFERP (object) && !NILP (BVAR (XBUFFER (object), name)))
3649 /* Walk all windows looking for buffer, and force update
3650 of each of those windows. */
3652 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, 0, Qvisible);
3653 return NILP (object) ? Qnil : Qt;
3656 /* If nothing suitable was found, just return.
3657 We could signal an error, but this feature will typically be used
3658 asynchronously in timers or process sentinels, so we don't. */
3659 return Qnil;
3663 void
3664 temp_output_buffer_show (register Lisp_Object buf)
3666 register struct buffer *old = current_buffer;
3667 register Lisp_Object window;
3668 register struct window *w;
3670 BVAR (XBUFFER (buf), directory) = BVAR (current_buffer, directory);
3672 Fset_buffer (buf);
3673 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3674 BEGV = BEG;
3675 ZV = Z;
3676 SET_PT (BEG);
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 int count = SPECPDL_INDEX ();
3698 Lisp_Object prev_window, prev_buffer;
3699 prev_window = selected_window;
3700 XSETBUFFER (prev_buffer, old);
3702 /* Select the window that was chosen, for running the hook.
3703 Note: Both Fselect_window and select_window_norecord may
3704 set-buffer to the buffer displayed in the window,
3705 so we need to save the current buffer. --stef */
3706 record_unwind_protect (Fset_buffer, prev_buffer);
3707 record_unwind_protect (select_window_norecord, prev_window);
3708 Fselect_window (window, Qt);
3709 Fset_buffer (w->buffer);
3710 Frun_hooks (1, &Qtemp_buffer_show_hook);
3711 unbind_to (count, Qnil);
3716 DEFUN ("internal-temp-output-buffer-show",
3717 Ftemp_output_buffer_show, Stemp_output_buffer_show,
3718 1, 1, 0,
3719 doc: /* Internal function for `with-output-to-temp-buffer''. */)
3720 (Lisp_Object buf)
3722 temp_output_buffer_show (buf);
3723 return Qnil;
3726 static void
3727 make_dummy_parent (Lisp_Object window)
3729 Lisp_Object new;
3730 register struct window *o, *p;
3731 int i;
3733 o = XWINDOW (window);
3734 p = allocate_window ();
3735 for (i = 0; i < VECSIZE (struct window); ++i)
3736 ((struct Lisp_Vector *) p)->contents[i]
3737 = ((struct Lisp_Vector *)o)->contents[i];
3738 XSETWINDOW (new, p);
3740 ++sequence_number;
3741 XSETFASTINT (p->sequence_number, sequence_number);
3743 /* Put new into window structure in place of window */
3744 replace_window (window, new);
3746 o->next = Qnil;
3747 o->prev = Qnil;
3748 o->vchild = Qnil;
3749 o->hchild = Qnil;
3750 o->parent = new;
3752 p->start = Qnil;
3753 p->pointm = Qnil;
3754 p->buffer = Qnil;
3757 DEFUN ("split-window", Fsplit_window, Ssplit_window, 0, 3, "",
3758 doc: /* Split WINDOW, putting SIZE lines in the first of the pair.
3759 WINDOW defaults to selected one and SIZE to half its size.
3760 If optional third arg HORIZONTAL is non-nil, split side by side and put
3761 SIZE columns in the first of the pair. In that case, SIZE includes that
3762 window's scroll bar, or the divider column to its right.
3763 Interactively, all arguments are nil.
3764 Returns the newly created window (which is the lower or rightmost one).
3765 The upper or leftmost window is the original one, and remains selected
3766 if it was selected before.
3768 See Info node `(elisp)Splitting Windows' for more details and examples. */)
3769 (Lisp_Object window, Lisp_Object size, Lisp_Object horizontal)
3771 register Lisp_Object new;
3772 register struct window *o, *p;
3773 FRAME_PTR fo;
3774 register int size_int;
3776 if (NILP (window))
3777 window = selected_window;
3778 else
3779 CHECK_LIVE_WINDOW (window);
3781 o = XWINDOW (window);
3782 fo = XFRAME (WINDOW_FRAME (o));
3784 if (NILP (size))
3786 if (!NILP (horizontal))
3787 /* Calculate the size of the left-hand window, by dividing
3788 the usable space in columns by two.
3789 We round up, since the left-hand window may include
3790 a dividing line, while the right-hand may not. */
3791 size_int = (XFASTINT (o->total_cols) + 1) >> 1;
3792 else
3793 size_int = XFASTINT (o->total_lines) >> 1;
3795 else
3797 CHECK_NUMBER (size);
3798 size_int = XINT (size);
3801 if (MINI_WINDOW_P (o))
3802 error ("Attempt to split minibuffer window");
3803 else if (window_fixed_size_p (o, !NILP (horizontal), 0))
3804 error ("Attempt to split fixed-size window");
3806 if (NILP (horizontal))
3808 int window_safe_height = window_min_size_2 (o, 0, 0);
3810 if (size_int < window_safe_height)
3811 error ("Window height %d too small (after splitting)", size_int);
3812 if (size_int + window_safe_height > XFASTINT (o->total_lines))
3813 error ("Window height %d too small (after splitting)",
3814 (int) (XFASTINT (o->total_lines) - size_int));
3815 if (NILP (o->parent)
3816 || NILP (XWINDOW (o->parent)->vchild))
3818 make_dummy_parent (window);
3819 new = o->parent;
3820 XWINDOW (new)->vchild = window;
3823 else
3825 int window_safe_width = window_min_size_2 (o, 1, 0);
3827 if (size_int < window_safe_width)
3828 error ("Window width %d too small (after splitting)", size_int);
3829 if (size_int + window_safe_width > XFASTINT (o->total_cols))
3830 error ("Window width %d too small (after splitting)",
3831 (int) (XFASTINT (o->total_cols) - size_int));
3832 if (NILP (o->parent)
3833 || NILP (XWINDOW (o->parent)->hchild))
3835 make_dummy_parent (window);
3836 new = o->parent;
3837 XWINDOW (new)->hchild = window;
3841 /* Now we know that window's parent is a vertical combination
3842 if we are dividing vertically, or a horizontal combination
3843 if we are making side-by-side windows */
3845 windows_or_buffers_changed++;
3846 FRAME_WINDOW_SIZES_CHANGED (fo) = 1;
3847 new = make_window ();
3848 p = XWINDOW (new);
3850 p->frame = o->frame;
3851 p->next = o->next;
3852 if (!NILP (p->next))
3853 XWINDOW (p->next)->prev = new;
3854 p->prev = window;
3855 o->next = new;
3856 p->parent = o->parent;
3857 p->buffer = Qt;
3858 p->window_end_valid = Qnil;
3859 memset (&p->last_cursor, 0, sizeof p->last_cursor);
3861 /* Duplicate special geometry settings. */
3863 p->left_margin_cols = o->left_margin_cols;
3864 p->right_margin_cols = o->right_margin_cols;
3865 p->left_fringe_width = o->left_fringe_width;
3866 p->right_fringe_width = o->right_fringe_width;
3867 p->fringes_outside_margins = o->fringes_outside_margins;
3868 p->scroll_bar_width = o->scroll_bar_width;
3869 p->vertical_scroll_bar_type = o->vertical_scroll_bar_type;
3871 /* Apportion the available frame space among the two new windows */
3873 if (!NILP (horizontal))
3875 p->total_lines = o->total_lines;
3876 p->top_line = o->top_line;
3877 XSETFASTINT (p->total_cols, XFASTINT (o->total_cols) - size_int);
3878 XSETFASTINT (o->total_cols, size_int);
3879 XSETFASTINT (p->left_col, XFASTINT (o->left_col) + size_int);
3880 adjust_window_margins (p);
3881 adjust_window_margins (o);
3883 else
3885 p->left_col = o->left_col;
3886 p->total_cols = o->total_cols;
3887 XSETFASTINT (p->total_lines, XFASTINT (o->total_lines) - size_int);
3888 XSETFASTINT (o->total_lines, size_int);
3889 XSETFASTINT (p->top_line, XFASTINT (o->top_line) + size_int);
3892 /* Adjust glyph matrices. */
3893 adjust_glyphs (fo);
3895 Fset_window_buffer (new, o->buffer, Qt);
3896 return new;
3899 DEFUN ("enlarge-window", Fenlarge_window, Senlarge_window, 1, 2, "p",
3900 doc: /* Make selected window SIZE lines taller.
3901 Interactively, if no argument is given, make the selected window one
3902 line taller. If optional argument HORIZONTAL is non-nil, make selected
3903 window wider by SIZE columns. If SIZE is negative, shrink the window by
3904 -SIZE lines or columns. Return nil.
3906 This function can delete windows if they get too small. The size of
3907 fixed size windows is not altered by this function. */)
3908 (Lisp_Object size, Lisp_Object horizontal)
3910 CHECK_NUMBER (size);
3911 enlarge_window (selected_window, XINT (size), !NILP (horizontal));
3913 run_window_configuration_change_hook (SELECTED_FRAME ());
3915 return Qnil;
3918 DEFUN ("shrink-window", Fshrink_window, Sshrink_window, 1, 2, "p",
3919 doc: /* Make selected window SIZE lines smaller.
3920 Interactively, if no argument is given, make the selected window one
3921 line smaller. If optional argument HORIZONTAL is non-nil, make the
3922 window narrower by SIZE columns. If SIZE is negative, enlarge selected
3923 window by -SIZE lines or columns. Return nil.
3925 This function can delete windows if they get too small. The size of
3926 fixed size windows is not altered by this function. */)
3927 (Lisp_Object size, Lisp_Object horizontal)
3929 CHECK_NUMBER (size);
3930 enlarge_window (selected_window, -XINT (size), !NILP (horizontal));
3932 run_window_configuration_change_hook (SELECTED_FRAME ());
3934 return Qnil;
3937 static int
3938 window_height (Lisp_Object window)
3940 register struct window *p = XWINDOW (window);
3941 return WINDOW_TOTAL_LINES (p);
3944 static int
3945 window_width (Lisp_Object window)
3947 register struct window *p = XWINDOW (window);
3948 return WINDOW_TOTAL_COLS (p);
3952 #define CURBEG(w) \
3953 *(horiz_flag ? &(XWINDOW (w)->left_col) : &(XWINDOW (w)->top_line))
3955 #define CURSIZE(w) \
3956 *(horiz_flag ? &(XWINDOW (w)->total_cols) : &(XWINDOW (w)->total_lines))
3959 /* Enlarge WINDOW by DELTA. HORIZ_FLAG nonzero means enlarge it
3960 horizontally; zero means do it vertically.
3962 Siblings of the selected window are resized to fulfill the size
3963 request. If they become too small in the process, they may be
3964 deleted. */
3966 static void
3967 enlarge_window (Lisp_Object window, int delta, int horiz_flag)
3969 Lisp_Object parent, next, prev;
3970 struct window *p;
3971 Lisp_Object *sizep;
3972 int maximum;
3973 int (*sizefun) (Lisp_Object)
3974 = horiz_flag ? window_width : window_height;
3975 void (*setsizefun) (Lisp_Object, int, int)
3976 = (horiz_flag ? set_window_width : set_window_height);
3978 /* Give up if this window cannot be resized. */
3979 if (window_fixed_size_p (XWINDOW (window), horiz_flag, 1))
3980 error ("Window is not resizable");
3982 /* Find the parent of the selected window. */
3983 while (1)
3985 p = XWINDOW (window);
3986 parent = p->parent;
3988 if (NILP (parent))
3990 if (horiz_flag)
3991 error ("No other window to side of this one");
3992 break;
3995 if (horiz_flag
3996 ? !NILP (XWINDOW (parent)->hchild)
3997 : !NILP (XWINDOW (parent)->vchild))
3998 break;
4000 window = parent;
4003 sizep = &CURSIZE (window);
4006 register int maxdelta;
4008 /* Compute the maximum size increment this window can have. */
4010 maxdelta = (!NILP (parent) ? (*sizefun) (parent) - XINT (*sizep)
4011 /* This is a main window followed by a minibuffer. */
4012 : !NILP (p->next) ? ((*sizefun) (p->next)
4013 - window_min_size (XWINDOW (p->next),
4014 horiz_flag, 0, 0, 0))
4015 /* This is a minibuffer following a main window. */
4016 : !NILP (p->prev) ? ((*sizefun) (p->prev)
4017 - window_min_size (XWINDOW (p->prev),
4018 horiz_flag, 0, 0, 0))
4019 /* This is a frame with only one window, a minibuffer-only
4020 or a minibufferless frame. */
4021 : (delta = 0));
4023 if (delta > maxdelta)
4024 /* This case traps trying to make the minibuffer
4025 the full frame, or make the only window aside from the
4026 minibuffer the full frame. */
4027 delta = maxdelta;
4030 if (XINT (*sizep) + delta < window_min_size (XWINDOW (window),
4031 horiz_flag, 0, 0, 0))
4033 delete_window (window);
4034 return;
4037 if (delta == 0)
4038 return;
4040 /* Find the total we can get from other siblings without deleting them. */
4041 maximum = 0;
4042 for (next = p->next; WINDOWP (next); next = XWINDOW (next)->next)
4043 maximum += (*sizefun) (next) - window_min_size (XWINDOW (next),
4044 horiz_flag, 0, 0, 0);
4045 for (prev = p->prev; WINDOWP (prev); prev = XWINDOW (prev)->prev)
4046 maximum += (*sizefun) (prev) - window_min_size (XWINDOW (prev),
4047 horiz_flag, 0, 0, 0);
4049 /* If we can get it all from them without deleting them, do so. */
4050 if (delta <= maximum)
4052 Lisp_Object first_unaffected;
4053 Lisp_Object first_affected;
4054 int fixed_p;
4056 next = p->next;
4057 prev = p->prev;
4058 first_affected = window;
4059 /* Look at one sibling at a time,
4060 moving away from this window in both directions alternately,
4061 and take as much as we can get without deleting that sibling. */
4062 while (delta != 0
4063 && (!NILP (next) || !NILP (prev)))
4065 if (! NILP (next))
4067 int this_one = ((*sizefun) (next)
4068 - window_min_size (XWINDOW (next), horiz_flag,
4069 0, 0, &fixed_p));
4070 if (!fixed_p)
4072 if (this_one > delta)
4073 this_one = delta;
4075 (*setsizefun) (next, (*sizefun) (next) - this_one, 0);
4076 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
4078 delta -= this_one;
4081 next = XWINDOW (next)->next;
4084 if (delta == 0)
4085 break;
4087 if (! NILP (prev))
4089 int this_one = ((*sizefun) (prev)
4090 - window_min_size (XWINDOW (prev), horiz_flag,
4091 0, 0, &fixed_p));
4092 if (!fixed_p)
4094 if (this_one > delta)
4095 this_one = delta;
4097 first_affected = prev;
4099 (*setsizefun) (prev, (*sizefun) (prev) - this_one, 0);
4100 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
4102 delta -= this_one;
4105 prev = XWINDOW (prev)->prev;
4109 xassert (delta == 0);
4111 /* Now recalculate the edge positions of all the windows affected,
4112 based on the new sizes. */
4113 first_unaffected = next;
4114 prev = first_affected;
4115 for (next = XWINDOW (prev)->next; ! EQ (next, first_unaffected);
4116 prev = next, next = XWINDOW (next)->next)
4118 XSETINT (CURBEG (next), XINT (CURBEG (prev)) + (*sizefun) (prev));
4119 /* This does not change size of NEXT,
4120 but it propagates the new top edge to its children */
4121 (*setsizefun) (next, (*sizefun) (next), 0);
4124 else
4126 register int delta1;
4127 register int opht = (*sizefun) (parent);
4129 if (opht <= XINT (*sizep) + delta)
4131 /* If trying to grow this window to or beyond size of the parent,
4132 just delete all the sibling windows. */
4133 Lisp_Object start, tem;
4135 start = XWINDOW (parent)->vchild;
4136 if (NILP (start))
4137 start = XWINDOW (parent)->hchild;
4139 /* Delete any siblings that come after WINDOW. */
4140 tem = XWINDOW (window)->next;
4141 while (! NILP (tem))
4143 Lisp_Object next1 = XWINDOW (tem)->next;
4144 delete_window (tem);
4145 tem = next1;
4148 /* Delete any siblings that come after WINDOW.
4149 Note that if START is not WINDOW, then WINDOW still
4150 has siblings, so WINDOW has not yet replaced its parent. */
4151 tem = start;
4152 while (! EQ (tem, window))
4154 Lisp_Object next1 = XWINDOW (tem)->next;
4155 delete_window (tem);
4156 tem = next1;
4159 else
4161 /* Otherwise, make delta1 just right so that if we add
4162 delta1 lines to this window and to the parent, and then
4163 shrink the parent back to its original size, the new
4164 proportional size of this window will increase by delta.
4166 The function size_window will compute the new height h'
4167 of the window from delta1 as:
4169 e = delta1/n
4170 x = delta1 - delta1/n * n for the 1st resizable child
4171 h' = h + e + x
4173 where n is the number of children that can be resized.
4174 We can ignore x by choosing a delta1 that is a multiple of
4175 n. We want the height of this window to come out as
4177 h' = h + delta
4179 So, delta1 must be
4181 h + e = h + delta
4182 delta1/n = delta
4183 delta1 = n * delta.
4185 The number of children n equals the number of resizable
4186 children of this window + 1 because we know window itself
4187 is resizable (otherwise we would have signaled an error).
4189 This reasoning is not correct when other windows become too
4190 small and shrink_windows refuses to delete them. Below we
4191 use resize_proportionally to work around this problem. */
4193 struct window *w = XWINDOW (window);
4194 Lisp_Object s;
4195 int n = 1;
4197 for (s = w->next; WINDOWP (s); s = XWINDOW (s)->next)
4198 if (!window_fixed_size_p (XWINDOW (s), horiz_flag, 0))
4199 ++n;
4200 for (s = w->prev; WINDOWP (s); s = XWINDOW (s)->prev)
4201 if (!window_fixed_size_p (XWINDOW (s), horiz_flag, 0))
4202 ++n;
4204 delta1 = n * delta;
4206 /* Add delta1 lines or columns to this window, and to the parent,
4207 keeping things consistent while not affecting siblings. */
4208 XSETINT (CURSIZE (parent), opht + delta1);
4209 (*setsizefun) (window, XINT (*sizep) + delta1, 0);
4211 /* Squeeze out delta1 lines or columns from our parent,
4212 shrinking this window and siblings proportionately. This
4213 brings parent back to correct size. Delta1 was calculated
4214 so this makes this window the desired size, taking it all
4215 out of the siblings.
4217 Temporarily set resize_proportionally to Qt to assure that,
4218 if necessary, shrink_windows deletes smaller windows rather
4219 than shrink this window. */
4220 w->resize_proportionally = Qt;
4221 (*setsizefun) (parent, opht, 0);
4222 w->resize_proportionally = Qnil;
4226 XSETFASTINT (p->last_modified, 0);
4227 XSETFASTINT (p->last_overlay_modified, 0);
4229 /* Adjust glyph matrices. */
4230 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4234 /* Adjust the size of WINDOW by DELTA, moving only its trailing edge.
4235 HORIZ_FLAG nonzero means adjust the width, moving the right edge.
4236 zero means adjust the height, moving the bottom edge.
4238 Following siblings of the selected window are resized to fulfill
4239 the size request. If they become too small in the process, they
4240 are not deleted; instead, we signal an error. */
4242 static void
4243 adjust_window_trailing_edge (Lisp_Object window, int delta, int horiz_flag)
4245 Lisp_Object parent, child;
4246 struct window *p;
4247 Lisp_Object old_config = Fcurrent_window_configuration (Qnil);
4248 int delcount = window_deletion_count;
4250 CHECK_WINDOW (window);
4252 /* Give up if this window cannot be resized. */
4253 if (window_fixed_size_p (XWINDOW (window), horiz_flag, 1))
4254 error ("Window is not resizable");
4256 while (1)
4258 Lisp_Object first_parallel = Qnil;
4260 if (NILP (window))
4262 /* This happens if WINDOW on the previous iteration was
4263 at top level of the window tree. */
4264 Fset_window_configuration (old_config);
4265 error ("Specified window edge is fixed");
4268 p = XWINDOW (window);
4269 parent = p->parent;
4271 /* See if this level has windows in parallel in the specified
4272 direction. If so, set FIRST_PARALLEL to the first one. */
4273 if (horiz_flag)
4275 if (! NILP (parent) && !NILP (XWINDOW (parent)->vchild))
4276 first_parallel = XWINDOW (parent)->vchild;
4277 else if (NILP (parent) && !NILP (p->next))
4279 /* Handle the vertical chain of main window and minibuffer
4280 which has no parent. */
4281 first_parallel = window;
4282 while (! NILP (XWINDOW (first_parallel)->prev))
4283 first_parallel = XWINDOW (first_parallel)->prev;
4286 else
4288 if (! NILP (parent) && !NILP (XWINDOW (parent)->hchild))
4289 first_parallel = XWINDOW (parent)->hchild;
4292 /* If this level's succession is in the desired dimension,
4293 and this window is the last one, and there is no higher level,
4294 its trailing edge is fixed. */
4295 if (NILP (XWINDOW (window)->next) && NILP (first_parallel)
4296 && NILP (parent))
4298 Fset_window_configuration (old_config);
4299 error ("Specified window edge is fixed");
4302 /* Don't make this window too small. */
4303 if (XINT (CURSIZE (window)) + delta
4304 < window_min_size_2 (XWINDOW (window), horiz_flag, 0))
4306 Fset_window_configuration (old_config);
4307 error ("Cannot adjust window size as specified");
4310 /* Clear out some redisplay caches. */
4311 XSETFASTINT (p->last_modified, 0);
4312 XSETFASTINT (p->last_overlay_modified, 0);
4314 /* Adjust this window's edge. */
4315 XSETINT (CURSIZE (window),
4316 XINT (CURSIZE (window)) + delta);
4318 /* If this window has following siblings in the desired dimension,
4319 make them smaller, and exit the loop.
4321 (If we reach the top of the tree and can never do this,
4322 we will fail and report an error, above.) */
4323 if (NILP (first_parallel))
4325 if (!NILP (p->next))
4327 /* This may happen for the minibuffer. In that case
4328 the window_deletion_count check below does not work. */
4329 if (XINT (CURSIZE (p->next)) - delta <= 0)
4331 Fset_window_configuration (old_config);
4332 error ("Cannot adjust window size as specified");
4335 XSETINT (CURBEG (p->next),
4336 XINT (CURBEG (p->next)) + delta);
4337 size_window (p->next, XINT (CURSIZE (p->next)) - delta,
4338 horiz_flag, 0, 1, 0);
4339 break;
4342 else
4343 /* Here we have a chain of parallel siblings, in the other dimension.
4344 Change the size of the other siblings. */
4345 for (child = first_parallel;
4346 ! NILP (child);
4347 child = XWINDOW (child)->next)
4348 if (! EQ (child, window))
4349 size_window (child, XINT (CURSIZE (child)) + delta,
4350 horiz_flag, 0, 0, 1);
4352 window = parent;
4355 /* If we made a window so small it got deleted,
4356 we failed. Report failure. */
4357 if (delcount != window_deletion_count)
4359 Fset_window_configuration (old_config);
4360 error ("Cannot adjust window size as specified");
4363 /* Adjust glyph matrices. */
4364 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4367 #undef CURBEG
4368 #undef CURSIZE
4370 DEFUN ("adjust-window-trailing-edge", Fadjust_window_trailing_edge,
4371 Sadjust_window_trailing_edge, 3, 3, 0,
4372 doc: /* Adjust the bottom or right edge of WINDOW by DELTA.
4373 If HORIZONTAL is non-nil, that means adjust the width, moving the right edge.
4374 Otherwise, adjust the height, moving the bottom edge.
4376 Following siblings of the selected window are resized to fulfill
4377 the size request. If they become too small in the process, they
4378 are not deleted; instead, we signal an error. */)
4379 (Lisp_Object window, Lisp_Object delta, Lisp_Object horizontal)
4381 CHECK_NUMBER (delta);
4382 if (NILP (window))
4383 window = selected_window;
4384 adjust_window_trailing_edge (window, XINT (delta), !NILP (horizontal));
4386 run_window_configuration_change_hook
4387 (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4389 return Qnil;
4394 /***********************************************************************
4395 Resizing Mini-Windows
4396 ***********************************************************************/
4398 static void shrink_window_lowest_first (struct window *, int);
4400 enum save_restore_action
4402 CHECK_ORIG_SIZES,
4403 SAVE_ORIG_SIZES,
4404 RESTORE_ORIG_SIZES
4407 static int save_restore_orig_size (struct window *,
4408 enum save_restore_action);
4410 /* Shrink windows rooted in window W to HEIGHT. Take the space needed
4411 from lowest windows first. */
4413 static void
4414 shrink_window_lowest_first (struct window *w, int height)
4416 struct window *c;
4417 Lisp_Object child;
4418 int old_height;
4420 xassert (!MINI_WINDOW_P (w));
4422 /* Set redisplay hints. */
4423 XSETFASTINT (w->last_modified, 0);
4424 XSETFASTINT (w->last_overlay_modified, 0);
4425 windows_or_buffers_changed++;
4426 FRAME_WINDOW_SIZES_CHANGED (XFRAME (WINDOW_FRAME (w))) = 1;
4428 old_height = XFASTINT (w->total_lines);
4429 XSETFASTINT (w->total_lines, height);
4431 if (!NILP (w->hchild))
4433 for (child = w->hchild; !NILP (child); child = c->next)
4435 c = XWINDOW (child);
4436 c->top_line = w->top_line;
4437 shrink_window_lowest_first (c, height);
4440 else if (!NILP (w->vchild))
4442 Lisp_Object last_child;
4443 int delta = old_height - height;
4444 int last_top;
4446 last_child = Qnil;
4448 /* Find the last child. We are taking space from lowest windows
4449 first, so we iterate over children from the last child
4450 backwards. */
4451 for (child = w->vchild; WINDOWP (child); child = XWINDOW (child)->next)
4452 last_child = child;
4454 /* Size children down to their safe heights. */
4455 for (child = last_child; delta && !NILP (child); child = c->prev)
4457 int this_one;
4459 c = XWINDOW (child);
4460 this_one = XFASTINT (c->total_lines) - window_min_size_1 (c, 0, 1);
4462 if (this_one > delta)
4463 this_one = delta;
4465 shrink_window_lowest_first (c, XFASTINT (c->total_lines) - this_one);
4466 delta -= this_one;
4469 /* Compute new positions. */
4470 last_top = XINT (w->top_line);
4471 for (child = w->vchild; !NILP (child); child = c->next)
4473 c = XWINDOW (child);
4474 c->top_line = make_number (last_top);
4475 shrink_window_lowest_first (c, XFASTINT (c->total_lines));
4476 last_top += XFASTINT (c->total_lines);
4482 /* Save, restore, or check positions and sizes in the window tree
4483 rooted at W. ACTION says what to do.
4485 If ACTION is CHECK_ORIG_SIZES, check if orig_top_line and
4486 orig_total_lines members are valid for all windows in the window
4487 tree. Value is non-zero if they are valid.
4489 If ACTION is SAVE_ORIG_SIZES, save members top and height in
4490 orig_top_line and orig_total_lines for all windows in the tree.
4492 If ACTION is RESTORE_ORIG_SIZES, restore top and height from values
4493 stored in orig_top_line and orig_total_lines for all windows. */
4495 static int
4496 save_restore_orig_size (struct window *w, enum save_restore_action action)
4498 int success_p = 1;
4500 while (w)
4502 if (!NILP (w->hchild))
4504 if (!save_restore_orig_size (XWINDOW (w->hchild), action))
4505 success_p = 0;
4507 else if (!NILP (w->vchild))
4509 if (!save_restore_orig_size (XWINDOW (w->vchild), action))
4510 success_p = 0;
4513 switch (action)
4515 case CHECK_ORIG_SIZES:
4516 if (!INTEGERP (w->orig_top_line) || !INTEGERP (w->orig_total_lines))
4517 return 0;
4518 break;
4520 case SAVE_ORIG_SIZES:
4521 w->orig_top_line = w->top_line;
4522 w->orig_total_lines = w->total_lines;
4523 XSETFASTINT (w->last_modified, 0);
4524 XSETFASTINT (w->last_overlay_modified, 0);
4525 break;
4527 case RESTORE_ORIG_SIZES:
4528 xassert (INTEGERP (w->orig_top_line) && INTEGERP (w->orig_total_lines));
4529 w->top_line = w->orig_top_line;
4530 w->total_lines = w->orig_total_lines;
4531 w->orig_total_lines = w->orig_top_line = Qnil;
4532 XSETFASTINT (w->last_modified, 0);
4533 XSETFASTINT (w->last_overlay_modified, 0);
4534 break;
4536 default:
4537 abort ();
4540 w = NILP (w->next) ? NULL : XWINDOW (w->next);
4543 return success_p;
4547 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we can
4548 without deleting other windows. */
4550 void
4551 grow_mini_window (struct window *w, int delta)
4553 struct frame *f = XFRAME (w->frame);
4554 struct window *root;
4556 xassert (MINI_WINDOW_P (w));
4557 /* Commenting out the following assertion goes against the stated interface
4558 of the function, but it currently does not seem to do anything useful.
4559 See discussion of this issue in the thread for bug#4534.
4560 xassert (delta >= 0); */
4562 /* Compute how much we can enlarge the mini-window without deleting
4563 other windows. */
4564 root = XWINDOW (FRAME_ROOT_WINDOW (f));
4565 if (delta > 0)
4567 int min_height = window_min_size (root, 0, 0, 0, 0);
4568 if (XFASTINT (root->total_lines) - delta < min_height)
4569 /* Note that the root window may already be smaller than
4570 min_height. */
4571 delta = max (0, XFASTINT (root->total_lines) - min_height);
4574 if (delta)
4576 /* Save original window sizes and positions, if not already done. */
4577 if (!save_restore_orig_size (root, CHECK_ORIG_SIZES))
4578 save_restore_orig_size (root, SAVE_ORIG_SIZES);
4580 /* Shrink other windows. */
4581 shrink_window_lowest_first (root, XFASTINT (root->total_lines) - delta);
4583 /* Grow the mini-window. */
4584 w->top_line = make_number (XFASTINT (root->top_line) + XFASTINT (root->total_lines));
4585 w->total_lines = make_number (XFASTINT (w->total_lines) + delta);
4586 XSETFASTINT (w->last_modified, 0);
4587 XSETFASTINT (w->last_overlay_modified, 0);
4589 adjust_glyphs (f);
4594 /* Shrink mini-window W. If there is recorded info about window sizes
4595 before a call to grow_mini_window, restore recorded window sizes.
4596 Otherwise, if the mini-window is higher than 1 line, resize it to 1
4597 line. */
4599 void
4600 shrink_mini_window (struct window *w)
4602 struct frame *f = XFRAME (w->frame);
4603 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
4605 if (save_restore_orig_size (root, CHECK_ORIG_SIZES))
4607 save_restore_orig_size (root, RESTORE_ORIG_SIZES);
4608 adjust_glyphs (f);
4609 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4610 windows_or_buffers_changed = 1;
4612 else if (XFASTINT (w->total_lines) > 1)
4614 /* Distribute the additional lines of the mini-window
4615 among the other windows. */
4616 Lisp_Object window;
4617 XSETWINDOW (window, w);
4618 enlarge_window (window, 1 - XFASTINT (w->total_lines), 0);
4624 /* Mark window cursors off for all windows in the window tree rooted
4625 at W by setting their phys_cursor_on_p flag to zero. Called from
4626 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4627 the frame are cleared. */
4629 void
4630 mark_window_cursors_off (struct window *w)
4632 while (w)
4634 if (!NILP (w->hchild))
4635 mark_window_cursors_off (XWINDOW (w->hchild));
4636 else if (!NILP (w->vchild))
4637 mark_window_cursors_off (XWINDOW (w->vchild));
4638 else
4639 w->phys_cursor_on_p = 0;
4641 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4646 /* Return number of lines of text (not counting mode lines) in W. */
4649 window_internal_height (struct window *w)
4651 int ht = XFASTINT (w->total_lines);
4653 if (!MINI_WINDOW_P (w))
4655 if (!NILP (w->parent)
4656 || !NILP (w->vchild)
4657 || !NILP (w->hchild)
4658 || !NILP (w->next)
4659 || !NILP (w->prev)
4660 || WINDOW_WANTS_MODELINE_P (w))
4661 --ht;
4663 if (WINDOW_WANTS_HEADER_LINE_P (w))
4664 --ht;
4667 return ht;
4671 /* Return the number of columns in W.
4672 Don't count columns occupied by scroll bars or the vertical bar
4673 separating W from the sibling to its right. */
4676 window_box_text_cols (struct window *w)
4678 struct frame *f = XFRAME (WINDOW_FRAME (w));
4679 int width = XINT (w->total_cols);
4681 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
4682 /* Scroll bars occupy a few columns. */
4683 width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
4684 else if (!FRAME_WINDOW_P (f)
4685 && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
4686 /* The column of `|' characters separating side-by-side windows
4687 occupies one column only. */
4688 width -= 1;
4690 if (FRAME_WINDOW_P (f))
4691 /* On window-systems, fringes and display margins cannot be
4692 used for normal text. */
4693 width -= (WINDOW_FRINGE_COLS (w)
4694 + WINDOW_LEFT_MARGIN_COLS (w)
4695 + WINDOW_RIGHT_MARGIN_COLS (w));
4697 return width;
4701 /************************************************************************
4702 Window Scrolling
4703 ***********************************************************************/
4705 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4706 N screen-fulls, which is defined as the height of the window minus
4707 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4708 instead. Negative values of N mean scroll down. NOERROR non-zero
4709 means don't signal an error if we try to move over BEGV or ZV,
4710 respectively. */
4712 static void
4713 window_scroll (Lisp_Object window, int n, int whole, int noerror)
4715 immediate_quit = 1;
4717 /* If we must, use the pixel-based version which is much slower than
4718 the line-based one but can handle varying line heights. */
4719 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4720 window_scroll_pixel_based (window, n, whole, noerror);
4721 else
4722 window_scroll_line_based (window, n, whole, noerror);
4724 immediate_quit = 0;
4728 /* Implementation of window_scroll that works based on pixel line
4729 heights. See the comment of window_scroll for parameter
4730 descriptions. */
4732 static void
4733 window_scroll_pixel_based (Lisp_Object window, int n, int whole, int noerror)
4735 struct it it;
4736 struct window *w = XWINDOW (window);
4737 struct text_pos start;
4738 int this_scroll_margin;
4739 /* True if we fiddled the window vscroll field without really scrolling. */
4740 int vscrolled = 0;
4741 int x, y, rtop, rbot, rowh, vpos;
4743 SET_TEXT_POS_FROM_MARKER (start, w->start);
4745 /* If PT is not visible in WINDOW, move back one half of
4746 the screen. Allow PT to be partially visible, otherwise
4747 something like (scroll-down 1) with PT in the line before
4748 the partially visible one would recenter. */
4750 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
4752 /* Move backward half the height of the window. Performance note:
4753 vmotion used here is about 10% faster, but would give wrong
4754 results for variable height lines. */
4755 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4756 it.current_y = it.last_visible_y;
4757 move_it_vertically_backward (&it, window_box_height (w) / 2);
4759 /* The function move_iterator_vertically may move over more than
4760 the specified y-distance. If it->w is small, e.g. a
4761 mini-buffer window, we may end up in front of the window's
4762 display area. This is the case when Start displaying at the
4763 start of the line containing PT in this case. */
4764 if (it.current_y <= 0)
4766 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4767 move_it_vertically_backward (&it, 0);
4768 it.current_y = 0;
4771 start = it.current.pos;
4773 else if (auto_window_vscroll_p)
4775 if (rtop || rbot) /* partially visible */
4777 int px;
4778 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4779 if (whole)
4780 dy = max ((window_box_height (w)
4781 - next_screen_context_lines * dy),
4782 dy);
4783 dy *= n;
4785 if (n < 0)
4787 /* Only vscroll backwards if already vscrolled forwards. */
4788 if (w->vscroll < 0 && rtop > 0)
4790 px = max (0, -w->vscroll - min (rtop, -dy));
4791 Fset_window_vscroll (window, make_number (px), Qt);
4792 return;
4795 if (n > 0)
4797 /* Do vscroll if already vscrolled or only display line. */
4798 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
4800 px = max (0, -w->vscroll + min (rbot, dy));
4801 Fset_window_vscroll (window, make_number (px), Qt);
4802 return;
4805 /* Maybe modify window start instead of scrolling. */
4806 if (rbot > 0 || w->vscroll < 0)
4808 EMACS_INT spos;
4810 Fset_window_vscroll (window, make_number (0), Qt);
4811 /* If there are other text lines above the current row,
4812 move window start to current row. Else to next row. */
4813 if (rbot > 0)
4814 spos = XINT (Fline_beginning_position (Qnil));
4815 else
4816 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
4817 set_marker_restricted (w->start, make_number (spos),
4818 w->buffer);
4819 w->start_at_line_beg = Qt;
4820 w->update_mode_line = Qt;
4821 XSETFASTINT (w->last_modified, 0);
4822 XSETFASTINT (w->last_overlay_modified, 0);
4823 /* Set force_start so that redisplay_window will run the
4824 window-scroll-functions. */
4825 w->force_start = Qt;
4826 return;
4830 /* Cancel previous vscroll. */
4831 Fset_window_vscroll (window, make_number (0), Qt);
4834 /* If scroll_preserve_screen_position is non-nil, we try to set
4835 point in the same window line as it is now, so get that line. */
4836 if (!NILP (Vscroll_preserve_screen_position))
4838 /* We preserve the goal pixel coordinate across consecutive
4839 calls to scroll-up, scroll-down and other commands that
4840 have the `scroll-command' property. This avoids the
4841 possibility of point becoming "stuck" on a tall line when
4842 scrolling by one line. */
4843 if (window_scroll_pixel_based_preserve_y < 0
4844 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4845 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4847 start_display (&it, w, start);
4848 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4849 window_scroll_pixel_based_preserve_y = it.current_y;
4850 window_scroll_pixel_based_preserve_x = it.current_x;
4853 else
4854 window_scroll_pixel_based_preserve_y
4855 = window_scroll_pixel_based_preserve_x = -1;
4857 /* Move iterator it from start the specified distance forward or
4858 backward. The result is the new window start. */
4859 start_display (&it, w, start);
4860 if (whole)
4862 EMACS_INT start_pos = IT_CHARPOS (it);
4863 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4864 dy = max ((window_box_height (w)
4865 - next_screen_context_lines * dy),
4866 dy) * n;
4868 /* Note that move_it_vertically always moves the iterator to the
4869 start of a line. So, if the last line doesn't have a newline,
4870 we would end up at the start of the line ending at ZV. */
4871 if (dy <= 0)
4873 move_it_vertically_backward (&it, -dy);
4874 /* Ensure we actually do move, e.g. in case we are currently
4875 looking at an image that is taller that the window height. */
4876 while (start_pos == IT_CHARPOS (it)
4877 && start_pos > BEGV)
4878 move_it_by_lines (&it, -1);
4880 else if (dy > 0)
4882 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4883 MOVE_TO_POS | MOVE_TO_Y);
4884 /* Ensure we actually do move, e.g. in case we are currently
4885 looking at an image that is taller that the window height. */
4886 while (start_pos == IT_CHARPOS (it)
4887 && start_pos < ZV)
4888 move_it_by_lines (&it, 1);
4891 else
4892 move_it_by_lines (&it, n);
4894 /* We failed if we find ZV is already on the screen (scrolling up,
4895 means there's nothing past the end), or if we can't start any
4896 earlier (scrolling down, means there's nothing past the top). */
4897 if ((n > 0 && IT_CHARPOS (it) == ZV)
4898 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4900 if (IT_CHARPOS (it) == ZV)
4902 if (it.current_y < it.last_visible_y
4903 && (it.current_y + it.max_ascent + it.max_descent
4904 > it.last_visible_y))
4906 /* The last line was only partially visible, make it fully
4907 visible. */
4908 w->vscroll = (it.last_visible_y
4909 - it.current_y + it.max_ascent + it.max_descent);
4910 adjust_glyphs (it.f);
4912 else if (noerror)
4913 return;
4914 else if (n < 0) /* could happen with empty buffers */
4915 xsignal0 (Qbeginning_of_buffer);
4916 else
4917 xsignal0 (Qend_of_buffer);
4919 else
4921 if (w->vscroll != 0)
4922 /* The first line was only partially visible, make it fully
4923 visible. */
4924 w->vscroll = 0;
4925 else if (noerror)
4926 return;
4927 else
4928 xsignal0 (Qbeginning_of_buffer);
4931 /* If control gets here, then we vscrolled. */
4933 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
4935 /* Don't try to change the window start below. */
4936 vscrolled = 1;
4939 if (! vscrolled)
4941 EMACS_INT pos = IT_CHARPOS (it);
4942 EMACS_INT bytepos;
4944 /* If in the middle of a multi-glyph character move forward to
4945 the next character. */
4946 if (in_display_vector_p (&it))
4948 ++pos;
4949 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
4952 /* Set the window start, and set up the window for redisplay. */
4953 set_marker_restricted (w->start, make_number (pos),
4954 w->buffer);
4955 bytepos = XMARKER (w->start)->bytepos;
4956 w->start_at_line_beg = ((pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n')
4957 ? Qt : Qnil);
4958 w->update_mode_line = Qt;
4959 XSETFASTINT (w->last_modified, 0);
4960 XSETFASTINT (w->last_overlay_modified, 0);
4961 /* Set force_start so that redisplay_window will run the
4962 window-scroll-functions. */
4963 w->force_start = Qt;
4966 /* The rest of this function uses current_y in a nonstandard way,
4967 not including the height of the header line if any. */
4968 it.current_y = it.vpos = 0;
4970 /* Move PT out of scroll margins.
4971 This code wants current_y to be zero at the window start position
4972 even if there is a header line. */
4973 this_scroll_margin = max (0, scroll_margin);
4974 this_scroll_margin = min (this_scroll_margin, XFASTINT (w->total_lines) / 4);
4975 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
4977 if (n > 0)
4979 /* We moved the window start towards ZV, so PT may be now
4980 in the scroll margin at the top. */
4981 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4982 if (IT_CHARPOS (it) == PT && it.current_y >= this_scroll_margin
4983 && (NILP (Vscroll_preserve_screen_position)
4984 || EQ (Vscroll_preserve_screen_position, Qt)))
4985 /* We found PT at a legitimate height. Leave it alone. */
4987 else if (window_scroll_pixel_based_preserve_y >= 0)
4989 /* If we have a header line, take account of it.
4990 This is necessary because we set it.current_y to 0, above. */
4991 move_it_to (&it, -1,
4992 window_scroll_pixel_based_preserve_x,
4993 window_scroll_pixel_based_preserve_y
4994 - (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0 ),
4995 -1, MOVE_TO_Y | MOVE_TO_X);
4996 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4998 else
5000 while (it.current_y < this_scroll_margin)
5002 int prev = it.current_y;
5003 move_it_by_lines (&it, 1);
5004 if (prev == it.current_y)
5005 break;
5007 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5010 else if (n < 0)
5012 EMACS_INT charpos, bytepos;
5013 int partial_p;
5015 /* Save our position, for the
5016 window_scroll_pixel_based_preserve_y case. */
5017 charpos = IT_CHARPOS (it);
5018 bytepos = IT_BYTEPOS (it);
5020 /* We moved the window start towards BEGV, so PT may be now
5021 in the scroll margin at the bottom. */
5022 move_it_to (&it, PT, -1,
5023 (it.last_visible_y - CURRENT_HEADER_LINE_HEIGHT (w)
5024 - this_scroll_margin - 1),
5026 MOVE_TO_POS | MOVE_TO_Y);
5028 /* Save our position, in case it's correct. */
5029 charpos = IT_CHARPOS (it);
5030 bytepos = IT_BYTEPOS (it);
5032 /* See if point is on a partially visible line at the end. */
5033 if (it.what == IT_EOB)
5034 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
5035 else
5037 move_it_by_lines (&it, 1);
5038 partial_p = it.current_y > it.last_visible_y;
5041 if (charpos == PT && !partial_p
5042 && (NILP (Vscroll_preserve_screen_position)
5043 || EQ (Vscroll_preserve_screen_position, Qt)))
5044 /* We found PT before we found the display margin, so PT is ok. */
5046 else if (window_scroll_pixel_based_preserve_y >= 0)
5048 SET_TEXT_POS_FROM_MARKER (start, w->start);
5049 start_display (&it, w, start);
5050 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
5051 here because we called start_display again and did not
5052 alter it.current_y this time. */
5053 move_it_to (&it, -1, window_scroll_pixel_based_preserve_x,
5054 window_scroll_pixel_based_preserve_y, -1,
5055 MOVE_TO_Y | MOVE_TO_X);
5056 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5058 else
5060 if (partial_p)
5061 /* The last line was only partially visible, so back up two
5062 lines to make sure we're on a fully visible line. */
5064 move_it_by_lines (&it, -2);
5065 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5067 else
5068 /* No, the position we saved is OK, so use it. */
5069 SET_PT_BOTH (charpos, bytepos);
5075 /* Implementation of window_scroll that works based on screen lines.
5076 See the comment of window_scroll for parameter descriptions. */
5078 static void
5079 window_scroll_line_based (Lisp_Object window, int n, int whole, int noerror)
5081 register struct window *w = XWINDOW (window);
5082 /* Fvertical_motion enters redisplay, which can trigger
5083 fontification, which in turn can modify buffer text (e.g., if the
5084 fontification functions replace escape sequences with faces, as
5085 in `grep-mode-font-lock-keywords'). So we use a marker to record
5086 the old point position, to prevent crashes in SET_PT_BOTH. */
5087 Lisp_Object opoint_marker = Fpoint_marker ();
5088 register EMACS_INT pos, pos_byte;
5089 register int ht = window_internal_height (w);
5090 register Lisp_Object tem;
5091 int lose;
5092 Lisp_Object bolp;
5093 EMACS_INT startpos;
5094 Lisp_Object original_pos = Qnil;
5096 /* If scrolling screen-fulls, compute the number of lines to
5097 scroll from the window's height. */
5098 if (whole)
5099 n *= max (1, ht - next_screen_context_lines);
5101 startpos = marker_position (w->start);
5103 if (!NILP (Vscroll_preserve_screen_position))
5105 if (window_scroll_preserve_vpos <= 0
5106 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
5107 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
5109 struct position posit
5110 = *compute_motion (startpos, 0, 0, 0,
5111 PT, ht, 0,
5112 -1, XINT (w->hscroll),
5113 0, w);
5114 window_scroll_preserve_vpos = posit.vpos;
5115 window_scroll_preserve_hpos = posit.hpos + XINT (w->hscroll);
5118 original_pos = Fcons (make_number (window_scroll_preserve_hpos),
5119 make_number (window_scroll_preserve_vpos));
5122 XSETFASTINT (tem, PT);
5123 tem = Fpos_visible_in_window_p (tem, window, Qnil);
5125 if (NILP (tem))
5127 Fvertical_motion (make_number (- (ht / 2)), window);
5128 startpos = PT;
5131 SET_PT (startpos);
5132 lose = n < 0 && PT == BEGV;
5133 Fvertical_motion (make_number (n), window);
5134 pos = PT;
5135 pos_byte = PT_BYTE;
5136 bolp = Fbolp ();
5137 SET_PT_BOTH (marker_position (opoint_marker),
5138 marker_byte_position (opoint_marker));
5140 if (lose)
5142 if (noerror)
5143 return;
5144 else
5145 xsignal0 (Qbeginning_of_buffer);
5148 if (pos < ZV)
5150 int this_scroll_margin = scroll_margin;
5152 /* Don't use a scroll margin that is negative or too large. */
5153 if (this_scroll_margin < 0)
5154 this_scroll_margin = 0;
5156 if (XINT (w->total_lines) < 4 * scroll_margin)
5157 this_scroll_margin = XINT (w->total_lines) / 4;
5159 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
5160 w->start_at_line_beg = bolp;
5161 w->update_mode_line = Qt;
5162 XSETFASTINT (w->last_modified, 0);
5163 XSETFASTINT (w->last_overlay_modified, 0);
5164 /* Set force_start so that redisplay_window will run
5165 the window-scroll-functions. */
5166 w->force_start = Qt;
5168 if (!NILP (Vscroll_preserve_screen_position)
5169 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
5171 SET_PT_BOTH (pos, pos_byte);
5172 Fvertical_motion (original_pos, window);
5174 /* If we scrolled forward, put point enough lines down
5175 that it is outside the scroll margin. */
5176 else if (n > 0)
5178 int top_margin;
5180 if (this_scroll_margin > 0)
5182 SET_PT_BOTH (pos, pos_byte);
5183 Fvertical_motion (make_number (this_scroll_margin), window);
5184 top_margin = PT;
5186 else
5187 top_margin = pos;
5189 if (top_margin <= marker_position (opoint_marker))
5190 SET_PT_BOTH (marker_position (opoint_marker),
5191 marker_byte_position (opoint_marker));
5192 else if (!NILP (Vscroll_preserve_screen_position))
5194 SET_PT_BOTH (pos, pos_byte);
5195 Fvertical_motion (original_pos, window);
5197 else
5198 SET_PT (top_margin);
5200 else if (n < 0)
5202 int bottom_margin;
5204 /* If we scrolled backward, put point near the end of the window
5205 but not within the scroll margin. */
5206 SET_PT_BOTH (pos, pos_byte);
5207 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
5208 if (XFASTINT (tem) == ht - this_scroll_margin)
5209 bottom_margin = PT;
5210 else
5211 bottom_margin = PT + 1;
5213 if (bottom_margin > marker_position (opoint_marker))
5214 SET_PT_BOTH (marker_position (opoint_marker),
5215 marker_byte_position (opoint_marker));
5216 else
5218 if (!NILP (Vscroll_preserve_screen_position))
5220 SET_PT_BOTH (pos, pos_byte);
5221 Fvertical_motion (original_pos, window);
5223 else
5224 Fvertical_motion (make_number (-1), window);
5228 else
5230 if (noerror)
5231 return;
5232 else
5233 xsignal0 (Qend_of_buffer);
5238 /* Scroll selected_window up or down. If N is nil, scroll a
5239 screen-full which is defined as the height of the window minus
5240 next_screen_context_lines. If N is the symbol `-', scroll.
5241 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
5242 up. This is the guts of Fscroll_up and Fscroll_down. */
5244 static void
5245 scroll_command (Lisp_Object n, int direction)
5247 int count = SPECPDL_INDEX ();
5249 xassert (eabs (direction) == 1);
5251 /* If selected window's buffer isn't current, make it current for
5252 the moment. But don't screw up if window_scroll gets an error. */
5253 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
5255 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5256 Fset_buffer (XWINDOW (selected_window)->buffer);
5258 /* Make redisplay consider other windows than just selected_window. */
5259 ++windows_or_buffers_changed;
5262 if (NILP (n))
5263 window_scroll (selected_window, direction, 1, 0);
5264 else if (EQ (n, Qminus))
5265 window_scroll (selected_window, -direction, 1, 0);
5266 else
5268 n = Fprefix_numeric_value (n);
5269 window_scroll (selected_window, XINT (n) * direction, 0, 0);
5272 unbind_to (count, Qnil);
5275 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
5276 doc: /* Scroll text of selected window upward ARG lines.
5277 If ARG is omitted or nil, scroll upward by a near full screen.
5278 A near full screen is `next-screen-context-lines' less than a full screen.
5279 Negative ARG means scroll downward.
5280 If ARG is the atom `-', scroll downward by nearly full screen.
5281 When calling from a program, supply as argument a number, nil, or `-'. */)
5282 (Lisp_Object arg)
5284 scroll_command (arg, 1);
5285 return Qnil;
5288 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
5289 doc: /* Scroll text of selected window down ARG lines.
5290 If ARG is omitted or nil, scroll down by a near full screen.
5291 A near full screen is `next-screen-context-lines' less than a full screen.
5292 Negative ARG means scroll upward.
5293 If ARG is the atom `-', scroll upward by nearly full screen.
5294 When calling from a program, supply as argument a number, nil, or `-'. */)
5295 (Lisp_Object arg)
5297 scroll_command (arg, -1);
5298 return Qnil;
5301 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
5302 doc: /* Return the other window for \"other window scroll\" commands.
5303 If `other-window-scroll-buffer' is non-nil, a window
5304 showing that buffer is used.
5305 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5306 specifies the window. This takes precedence over
5307 `other-window-scroll-buffer'. */)
5308 (void)
5310 Lisp_Object window;
5312 if (MINI_WINDOW_P (XWINDOW (selected_window))
5313 && !NILP (Vminibuf_scroll_window))
5314 window = Vminibuf_scroll_window;
5315 /* If buffer is specified, scroll that buffer. */
5316 else if (!NILP (Vother_window_scroll_buffer))
5318 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
5319 if (NILP (window))
5320 window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil);
5322 else
5324 /* Nothing specified; look for a neighboring window on the same
5325 frame. */
5326 window = Fnext_window (selected_window, Qnil, Qnil);
5328 if (EQ (window, selected_window))
5329 /* That didn't get us anywhere; look for a window on another
5330 visible frame. */
5332 window = Fnext_window (window, Qnil, Qt);
5333 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
5334 && ! EQ (window, selected_window));
5337 CHECK_LIVE_WINDOW (window);
5339 if (EQ (window, selected_window))
5340 error ("There is no other window");
5342 return window;
5345 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
5346 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
5347 A near full screen is `next-screen-context-lines' less than a full screen.
5348 The next window is the one below the current one; or the one at the top
5349 if the current one is at the bottom. Negative ARG means scroll downward.
5350 If ARG is the atom `-', scroll downward by nearly full screen.
5351 When calling from a program, supply as argument a number, nil, or `-'.
5353 If `other-window-scroll-buffer' is non-nil, scroll the window
5354 showing that buffer, popping the buffer up if necessary.
5355 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5356 specifies the window to scroll. This takes precedence over
5357 `other-window-scroll-buffer'. */)
5358 (Lisp_Object arg)
5360 Lisp_Object window;
5361 struct window *w;
5362 int count = SPECPDL_INDEX ();
5364 window = Fother_window_for_scrolling ();
5365 w = XWINDOW (window);
5367 /* Don't screw up if window_scroll gets an error. */
5368 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5369 ++windows_or_buffers_changed;
5371 Fset_buffer (w->buffer);
5372 SET_PT (marker_position (w->pointm));
5374 if (NILP (arg))
5375 window_scroll (window, 1, 1, 1);
5376 else if (EQ (arg, Qminus))
5377 window_scroll (window, -1, 1, 1);
5378 else
5380 if (CONSP (arg))
5381 arg = Fcar (arg);
5382 CHECK_NUMBER (arg);
5383 window_scroll (window, XINT (arg), 0, 1);
5386 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
5387 unbind_to (count, Qnil);
5389 return Qnil;
5392 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
5393 doc: /* Scroll selected window display ARG columns left.
5394 Default for ARG is window width minus 2.
5395 Value is the total amount of leftward horizontal scrolling in
5396 effect after the change.
5397 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5398 lower bound for automatic scrolling, i.e. automatic scrolling
5399 will not scroll a window to a column less than the value returned
5400 by this function. This happens in an interactive call. */)
5401 (register Lisp_Object arg, Lisp_Object set_minimum)
5403 Lisp_Object result;
5404 int hscroll;
5405 struct window *w = XWINDOW (selected_window);
5407 if (NILP (arg))
5408 XSETFASTINT (arg, window_box_text_cols (w) - 2);
5409 else
5410 arg = Fprefix_numeric_value (arg);
5412 hscroll = XINT (w->hscroll) + XINT (arg);
5413 result = Fset_window_hscroll (selected_window, make_number (hscroll));
5415 if (!NILP (set_minimum))
5416 w->min_hscroll = w->hscroll;
5418 return result;
5421 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
5422 doc: /* Scroll selected window display ARG columns right.
5423 Default for ARG is window width minus 2.
5424 Value is the total amount of leftward horizontal scrolling in
5425 effect after the change.
5426 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5427 lower bound for automatic scrolling, i.e. automatic scrolling
5428 will not scroll a window to a column less than the value returned
5429 by this function. This happens in an interactive call. */)
5430 (register Lisp_Object arg, Lisp_Object set_minimum)
5432 Lisp_Object result;
5433 int hscroll;
5434 struct window *w = XWINDOW (selected_window);
5436 if (NILP (arg))
5437 XSETFASTINT (arg, window_box_text_cols (w) - 2);
5438 else
5439 arg = Fprefix_numeric_value (arg);
5441 hscroll = XINT (w->hscroll) - XINT (arg);
5442 result = Fset_window_hscroll (selected_window, make_number (hscroll));
5444 if (!NILP (set_minimum))
5445 w->min_hscroll = w->hscroll;
5447 return result;
5450 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
5451 doc: /* Return the window which was selected when entering the minibuffer.
5452 Returns nil, if selected window is not a minibuffer window. */)
5453 (void)
5455 if (minibuf_level > 0
5456 && MINI_WINDOW_P (XWINDOW (selected_window))
5457 && WINDOW_LIVE_P (minibuf_selected_window))
5458 return minibuf_selected_window;
5460 return Qnil;
5463 /* Value is the number of lines actually displayed in window W,
5464 as opposed to its height. */
5466 static int
5467 displayed_window_lines (struct window *w)
5469 struct it it;
5470 struct text_pos start;
5471 int height = window_box_height (w);
5472 struct buffer *old_buffer;
5473 int bottom_y;
5475 if (XBUFFER (w->buffer) != current_buffer)
5477 old_buffer = current_buffer;
5478 set_buffer_internal (XBUFFER (w->buffer));
5480 else
5481 old_buffer = NULL;
5483 /* In case W->start is out of the accessible range, do something
5484 reasonable. This happens in Info mode when Info-scroll-down
5485 calls (recenter -1) while W->start is 1. */
5486 if (XMARKER (w->start)->charpos < BEGV)
5487 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
5488 else if (XMARKER (w->start)->charpos > ZV)
5489 SET_TEXT_POS (start, ZV, ZV_BYTE);
5490 else
5491 SET_TEXT_POS_FROM_MARKER (start, w->start);
5493 start_display (&it, w, start);
5494 move_it_vertically (&it, height);
5495 bottom_y = line_bottom_y (&it);
5497 /* rms: On a non-window display,
5498 the value of it.vpos at the bottom of the screen
5499 seems to be 1 larger than window_box_height (w).
5500 This kludge fixes a bug whereby (move-to-window-line -1)
5501 when ZV is on the last screen line
5502 moves to the previous screen line instead of the last one. */
5503 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
5504 height++;
5506 /* Add in empty lines at the bottom of the window. */
5507 if (bottom_y < height)
5509 int uy = FRAME_LINE_HEIGHT (it.f);
5510 it.vpos += (height - bottom_y + uy - 1) / uy;
5513 if (old_buffer)
5514 set_buffer_internal (old_buffer);
5516 return it.vpos;
5520 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
5521 doc: /* Center point in selected window and maybe redisplay frame.
5522 With prefix argument ARG, recenter putting point on screen line ARG
5523 relative to the selected window. If ARG is negative, it counts up from the
5524 bottom of the window. (ARG should be less than the height of the window.)
5526 If ARG is omitted or nil, then recenter with point on the middle line of
5527 the selected window; if the variable `recenter-redisplay' is non-nil,
5528 also erase the entire frame and redraw it (when `auto-resize-tool-bars'
5529 is set to `grow-only', this resets the tool-bar's height to the minimum
5530 height needed); if `recenter-redisplay' has the special value `tty',
5531 then only tty frame are redrawn.
5533 Just C-u as prefix means put point in the center of the window
5534 and redisplay normally--don't erase and redraw the frame. */)
5535 (register Lisp_Object arg)
5537 struct window *w = XWINDOW (selected_window);
5538 struct buffer *buf = XBUFFER (w->buffer);
5539 struct buffer *obuf = current_buffer;
5540 int center_p = 0;
5541 EMACS_INT charpos, bytepos;
5542 int iarg IF_LINT (= 0);
5543 int this_scroll_margin;
5545 /* If redisplay is suppressed due to an error, try again. */
5546 obuf->display_error_modiff = 0;
5548 if (NILP (arg))
5550 if (!NILP (Vrecenter_redisplay)
5551 && (!EQ (Vrecenter_redisplay, Qtty)
5552 || !NILP (Ftty_type (selected_frame))))
5554 int i;
5556 /* Invalidate pixel data calculated for all compositions. */
5557 for (i = 0; i < n_compositions; i++)
5558 composition_table[i]->font = NULL;
5560 WINDOW_XFRAME (w)->minimize_tool_bar_window_p = 1;
5562 Fredraw_frame (WINDOW_FRAME (w));
5563 SET_FRAME_GARBAGED (WINDOW_XFRAME (w));
5566 center_p = 1;
5568 else if (CONSP (arg)) /* Just C-u. */
5569 center_p = 1;
5570 else
5572 arg = Fprefix_numeric_value (arg);
5573 CHECK_NUMBER (arg);
5574 iarg = XINT (arg);
5577 set_buffer_internal (buf);
5579 /* Do this after making BUF current
5580 in case scroll_margin is buffer-local. */
5581 this_scroll_margin = max (0, scroll_margin);
5582 this_scroll_margin = min (this_scroll_margin,
5583 XFASTINT (w->total_lines) / 4);
5585 /* Handle centering on a graphical frame specially. Such frames can
5586 have variable-height lines and centering point on the basis of
5587 line counts would lead to strange effects. */
5588 if (FRAME_WINDOW_P (XFRAME (w->frame)))
5590 if (center_p)
5592 struct it it;
5593 struct text_pos pt;
5595 SET_TEXT_POS (pt, PT, PT_BYTE);
5596 start_display (&it, w, pt);
5597 move_it_vertically_backward (&it, window_box_height (w) / 2);
5598 charpos = IT_CHARPOS (it);
5599 bytepos = IT_BYTEPOS (it);
5601 else if (iarg < 0)
5603 struct it it;
5604 struct text_pos pt;
5605 int nlines = -iarg;
5606 int extra_line_spacing;
5607 int h = window_box_height (w);
5609 iarg = - max (-iarg, this_scroll_margin);
5611 SET_TEXT_POS (pt, PT, PT_BYTE);
5612 start_display (&it, w, pt);
5614 /* Be sure we have the exact height of the full line containing PT. */
5615 move_it_by_lines (&it, 0);
5617 /* The amount of pixels we have to move back is the window
5618 height minus what's displayed in the line containing PT,
5619 and the lines below. */
5620 it.current_y = 0;
5621 it.vpos = 0;
5622 move_it_by_lines (&it, nlines);
5624 if (it.vpos == nlines)
5625 h -= it.current_y;
5626 else
5628 /* Last line has no newline */
5629 h -= line_bottom_y (&it);
5630 it.vpos++;
5633 /* Don't reserve space for extra line spacing of last line. */
5634 extra_line_spacing = it.max_extra_line_spacing;
5636 /* If we can't move down NLINES lines because we hit
5637 the end of the buffer, count in some empty lines. */
5638 if (it.vpos < nlines)
5640 nlines -= it.vpos;
5641 extra_line_spacing = it.extra_line_spacing;
5642 h -= nlines * (FRAME_LINE_HEIGHT (it.f) + extra_line_spacing);
5644 if (h <= 0)
5645 return Qnil;
5647 /* Now find the new top line (starting position) of the window. */
5648 start_display (&it, w, pt);
5649 it.current_y = 0;
5650 move_it_vertically_backward (&it, h);
5652 /* If extra line spacing is present, we may move too far
5653 back. This causes the last line to be only partially
5654 visible (which triggers redisplay to recenter that line
5655 in the middle), so move forward.
5656 But ignore extra line spacing on last line, as it is not
5657 considered to be part of the visible height of the line.
5659 h += extra_line_spacing;
5660 while (-it.current_y > h)
5661 move_it_by_lines (&it, 1);
5663 charpos = IT_CHARPOS (it);
5664 bytepos = IT_BYTEPOS (it);
5666 else
5668 struct position pos;
5670 iarg = max (iarg, this_scroll_margin);
5672 pos = *vmotion (PT, -iarg, w);
5673 charpos = pos.bufpos;
5674 bytepos = pos.bytepos;
5677 else
5679 struct position pos;
5680 int ht = window_internal_height (w);
5682 if (center_p)
5683 iarg = ht / 2;
5684 else if (iarg < 0)
5685 iarg += ht;
5687 /* Don't let it get into the margin at either top or bottom. */
5688 iarg = max (iarg, this_scroll_margin);
5689 iarg = min (iarg, ht - this_scroll_margin - 1);
5691 pos = *vmotion (PT, - iarg, w);
5692 charpos = pos.bufpos;
5693 bytepos = pos.bytepos;
5696 /* Set the new window start. */
5697 set_marker_both (w->start, w->buffer, charpos, bytepos);
5698 w->window_end_valid = Qnil;
5700 w->optional_new_start = Qt;
5702 if (bytepos == BEGV_BYTE || FETCH_BYTE (bytepos - 1) == '\n')
5703 w->start_at_line_beg = Qt;
5704 else
5705 w->start_at_line_beg = Qnil;
5707 set_buffer_internal (obuf);
5708 return Qnil;
5712 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5713 0, 1, 0,
5714 doc: /* Return the height in lines of the text display area of WINDOW.
5715 WINDOW defaults to the selected window.
5717 The return value does not include the mode line, any header line, nor
5718 any partial-height lines in the text display area. */)
5719 (Lisp_Object window)
5721 struct window *w = decode_window (window);
5722 int pixel_height = window_box_height (w);
5723 int line_height = pixel_height / FRAME_LINE_HEIGHT (XFRAME (w->frame));
5724 return make_number (line_height);
5729 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
5730 1, 1, "P",
5731 doc: /* Position point relative to window.
5732 With no argument, position point at center of window.
5733 An argument specifies vertical position within the window;
5734 zero means top of window, negative means relative to bottom of window. */)
5735 (Lisp_Object arg)
5737 struct window *w = XWINDOW (selected_window);
5738 int lines, start;
5739 Lisp_Object window;
5740 #if 0
5741 int this_scroll_margin;
5742 #endif
5744 if (!(BUFFERP (w->buffer)
5745 && XBUFFER (w->buffer) == current_buffer))
5746 /* This test is needed to make sure PT/PT_BYTE make sense in w->buffer
5747 when passed below to set_marker_both. */
5748 error ("move-to-window-line called from unrelated buffer");
5750 window = selected_window;
5751 start = marker_position (w->start);
5752 if (start < BEGV || start > ZV)
5754 int height = window_internal_height (w);
5755 Fvertical_motion (make_number (- (height / 2)), window);
5756 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
5757 w->start_at_line_beg = Fbolp ();
5758 w->force_start = Qt;
5760 else
5761 Fgoto_char (w->start);
5763 lines = displayed_window_lines (w);
5765 #if 0
5766 this_scroll_margin = max (0, scroll_margin);
5767 this_scroll_margin = min (this_scroll_margin, lines / 4);
5768 #endif
5770 if (NILP (arg))
5771 XSETFASTINT (arg, lines / 2);
5772 else
5774 int iarg = XINT (Fprefix_numeric_value (arg));
5776 if (iarg < 0)
5777 iarg = iarg + lines;
5779 #if 0 /* This code would prevent move-to-window-line from moving point
5780 to a place inside the scroll margins (which would cause the
5781 next redisplay to scroll). I wrote this code, but then concluded
5782 it is probably better not to install it. However, it is here
5783 inside #if 0 so as not to lose it. -- rms. */
5785 /* Don't let it get into the margin at either top or bottom. */
5786 iarg = max (iarg, this_scroll_margin);
5787 iarg = min (iarg, lines - this_scroll_margin - 1);
5788 #endif
5790 arg = make_number (iarg);
5793 /* Skip past a partially visible first line. */
5794 if (w->vscroll)
5795 XSETINT (arg, XINT (arg) + 1);
5797 return Fvertical_motion (arg, window);
5802 /***********************************************************************
5803 Window Configuration
5804 ***********************************************************************/
5806 struct save_window_data
5808 struct vectorlike_header header;
5809 Lisp_Object selected_frame;
5810 Lisp_Object current_window;
5811 Lisp_Object current_buffer;
5812 Lisp_Object minibuf_scroll_window;
5813 Lisp_Object minibuf_selected_window;
5814 Lisp_Object root_window;
5815 Lisp_Object focus_frame;
5816 /* A vector, each of whose elements is a struct saved_window
5817 for one window. */
5818 Lisp_Object saved_windows;
5820 /* All fields above are traced by the GC.
5821 From `fame-cols' down, the fields are ignored by the GC. */
5823 int frame_cols, frame_lines, frame_menu_bar_lines;
5824 int frame_tool_bar_lines;
5827 /* This is saved as a Lisp_Vector */
5828 struct saved_window
5830 struct vectorlike_header header;
5831 Lisp_Object window;
5832 Lisp_Object buffer, start, pointm, mark;
5833 Lisp_Object left_col, top_line, total_cols, total_lines;
5834 Lisp_Object hscroll, min_hscroll;
5835 Lisp_Object parent, prev;
5836 Lisp_Object start_at_line_beg;
5837 Lisp_Object display_table;
5838 Lisp_Object orig_top_line, orig_total_lines;
5839 Lisp_Object left_margin_cols, right_margin_cols;
5840 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
5841 Lisp_Object scroll_bar_width, vertical_scroll_bar_type;
5842 Lisp_Object dedicated, resize_proportionally;
5845 #define SAVED_WINDOW_N(swv,n) \
5846 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5848 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
5849 doc: /* Return t if OBJECT is a window-configuration object. */)
5850 (Lisp_Object object)
5852 return WINDOW_CONFIGURATIONP (object) ? Qt : Qnil;
5855 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
5856 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5857 (Lisp_Object config)
5859 register struct save_window_data *data;
5860 struct Lisp_Vector *saved_windows;
5862 CHECK_WINDOW_CONFIGURATION (config);
5864 data = (struct save_window_data *) XVECTOR (config);
5865 saved_windows = XVECTOR (data->saved_windows);
5866 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5869 DEFUN ("set-window-configuration", Fset_window_configuration,
5870 Sset_window_configuration, 1, 1, 0,
5871 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5872 CONFIGURATION must be a value previously returned
5873 by `current-window-configuration' (which see).
5874 If CONFIGURATION was made from a frame that is now deleted,
5875 only frame-independent values can be restored. In this case,
5876 the return value is nil. Otherwise the value is t. */)
5877 (Lisp_Object configuration)
5879 register struct save_window_data *data;
5880 struct Lisp_Vector *saved_windows;
5881 Lisp_Object new_current_buffer;
5882 Lisp_Object frame;
5883 FRAME_PTR f;
5884 EMACS_INT old_point = -1;
5886 CHECK_WINDOW_CONFIGURATION (configuration);
5888 data = (struct save_window_data *) XVECTOR (configuration);
5889 saved_windows = XVECTOR (data->saved_windows);
5891 new_current_buffer = data->current_buffer;
5892 if (NILP (BVAR (XBUFFER (new_current_buffer), name)))
5893 new_current_buffer = Qnil;
5894 else
5896 if (XBUFFER (new_current_buffer) == current_buffer)
5897 /* The code further down "preserves point" by saving here PT in
5898 old_point and then setting it later back into PT. When the
5899 current-selected-window and the final-selected-window both show
5900 the current buffer, this suffers from the problem that the
5901 current PT is the window-point of the current-selected-window,
5902 while the final PT is the point of the final-selected-window, so
5903 this copy from one PT to the other would end up moving the
5904 window-point of the final-selected-window to the window-point of
5905 the current-selected-window. So we have to be careful which
5906 point of the current-buffer we copy into old_point. */
5907 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5908 && WINDOWP (selected_window)
5909 && EQ (XWINDOW (selected_window)->buffer, new_current_buffer)
5910 && !EQ (selected_window, data->current_window))
5911 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5912 else
5913 old_point = PT;
5914 else
5915 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
5916 point in new_current_buffer as of the last time this buffer was
5917 used. This can be non-deterministic since it can be changed by
5918 things like jit-lock by mere temporary selection of some random
5919 window that happens to show this buffer.
5920 So if possible we want this arbitrary choice of "which point" to
5921 be the one from the to-be-selected-window so as to prevent this
5922 window's cursor from being copied from another window. */
5923 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5924 /* If current_window = selected_window, its point is in BUF_PT. */
5925 && !EQ (selected_window, data->current_window))
5926 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5927 else
5928 old_point = BUF_PT (XBUFFER (new_current_buffer));
5931 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5932 f = XFRAME (frame);
5934 /* If f is a dead frame, don't bother rebuilding its window tree.
5935 However, there is other stuff we should still try to do below. */
5936 if (FRAME_LIVE_P (f))
5938 register struct window *w;
5939 register struct saved_window *p;
5940 struct window *root_window;
5941 struct window **leaf_windows;
5942 int n_leaf_windows;
5943 int k, i, n;
5945 /* If the frame has been resized since this window configuration was
5946 made, we change the frame to the size specified in the
5947 configuration, restore the configuration, and then resize it
5948 back. We keep track of the prevailing height in these variables. */
5949 int previous_frame_lines = FRAME_LINES (f);
5950 int previous_frame_cols = FRAME_COLS (f);
5951 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
5952 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
5954 /* The mouse highlighting code could get screwed up
5955 if it runs during this. */
5956 BLOCK_INPUT;
5958 if (data->frame_lines != previous_frame_lines
5959 || data->frame_cols != previous_frame_cols)
5960 change_frame_size (f, data->frame_lines,
5961 data->frame_cols, 0, 0, 0);
5962 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5963 if (data->frame_menu_bar_lines
5964 != previous_frame_menu_bar_lines)
5965 x_set_menu_bar_lines (f, make_number (data->frame_menu_bar_lines),
5966 make_number (0));
5967 #ifdef HAVE_WINDOW_SYSTEM
5968 if (data->frame_tool_bar_lines
5969 != previous_frame_tool_bar_lines)
5970 x_set_tool_bar_lines (f, make_number (data->frame_tool_bar_lines),
5971 make_number (0));
5972 #endif
5973 #endif
5975 /* "Swap out" point from the selected window's buffer
5976 into the window itself. (Normally the pointm of the selected
5977 window holds garbage.) We do this now, before
5978 restoring the window contents, and prevent it from
5979 being done later on when we select a new window. */
5980 if (! NILP (XWINDOW (selected_window)->buffer))
5982 w = XWINDOW (selected_window);
5983 set_marker_both (w->pointm,
5984 w->buffer,
5985 BUF_PT (XBUFFER (w->buffer)),
5986 BUF_PT_BYTE (XBUFFER (w->buffer)));
5989 windows_or_buffers_changed++;
5990 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
5992 /* Problem: Freeing all matrices and later allocating them again
5993 is a serious redisplay flickering problem. What we would
5994 really like to do is to free only those matrices not reused
5995 below. */
5996 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
5997 leaf_windows
5998 = (struct window **) alloca (count_windows (root_window)
5999 * sizeof (struct window *));
6000 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
6002 /* Kludge Alert!
6003 Mark all windows now on frame as "deleted".
6004 Restoring the new configuration "undeletes" any that are in it.
6006 Save their current buffers in their height fields, since we may
6007 need it later, if a buffer saved in the configuration is now
6008 dead. */
6009 delete_all_subwindows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6011 for (k = 0; k < saved_windows->header.size; k++)
6013 p = SAVED_WINDOW_N (saved_windows, k);
6014 w = XWINDOW (p->window);
6015 w->next = Qnil;
6017 if (!NILP (p->parent))
6018 w->parent = SAVED_WINDOW_N (saved_windows,
6019 XFASTINT (p->parent))->window;
6020 else
6021 w->parent = Qnil;
6023 if (!NILP (p->prev))
6025 w->prev = SAVED_WINDOW_N (saved_windows,
6026 XFASTINT (p->prev))->window;
6027 XWINDOW (w->prev)->next = p->window;
6029 else
6031 w->prev = Qnil;
6032 if (!NILP (w->parent))
6034 if (EQ (p->total_cols, XWINDOW (w->parent)->total_cols))
6036 XWINDOW (w->parent)->vchild = p->window;
6037 XWINDOW (w->parent)->hchild = Qnil;
6039 else
6041 XWINDOW (w->parent)->hchild = p->window;
6042 XWINDOW (w->parent)->vchild = Qnil;
6047 /* If we squirreled away the buffer in the window's height,
6048 restore it now. */
6049 if (BUFFERP (w->total_lines))
6050 w->buffer = w->total_lines;
6051 w->left_col = p->left_col;
6052 w->top_line = p->top_line;
6053 w->total_cols = p->total_cols;
6054 w->total_lines = p->total_lines;
6055 w->hscroll = p->hscroll;
6056 w->min_hscroll = p->min_hscroll;
6057 w->display_table = p->display_table;
6058 w->orig_top_line = p->orig_top_line;
6059 w->orig_total_lines = p->orig_total_lines;
6060 w->left_margin_cols = p->left_margin_cols;
6061 w->right_margin_cols = p->right_margin_cols;
6062 w->left_fringe_width = p->left_fringe_width;
6063 w->right_fringe_width = p->right_fringe_width;
6064 w->fringes_outside_margins = p->fringes_outside_margins;
6065 w->scroll_bar_width = p->scroll_bar_width;
6066 w->vertical_scroll_bar_type = p->vertical_scroll_bar_type;
6067 w->dedicated = p->dedicated;
6068 w->resize_proportionally = p->resize_proportionally;
6069 XSETFASTINT (w->last_modified, 0);
6070 XSETFASTINT (w->last_overlay_modified, 0);
6072 /* Reinstall the saved buffer and pointers into it. */
6073 if (NILP (p->buffer))
6074 w->buffer = p->buffer;
6075 else
6077 if (!NILP (BVAR (XBUFFER (p->buffer), name)))
6078 /* If saved buffer is alive, install it. */
6080 w->buffer = p->buffer;
6081 w->start_at_line_beg = p->start_at_line_beg;
6082 set_marker_restricted (w->start, p->start, w->buffer);
6083 set_marker_restricted (w->pointm, p->pointm, w->buffer);
6084 Fset_marker (BVAR (XBUFFER (w->buffer), mark),
6085 p->mark, w->buffer);
6087 /* As documented in Fcurrent_window_configuration, don't
6088 restore the location of point in the buffer which was
6089 current when the window configuration was recorded. */
6090 if (!EQ (p->buffer, new_current_buffer)
6091 && XBUFFER (p->buffer) == current_buffer)
6092 Fgoto_char (w->pointm);
6094 else if (NILP (w->buffer) || NILP (BVAR (XBUFFER (w->buffer), name)))
6095 /* Else unless window has a live buffer, get one. */
6097 w->buffer = Fcdr (Fcar (Vbuffer_alist));
6098 /* This will set the markers to beginning of visible
6099 range. */
6100 set_marker_restricted (w->start, make_number (0), w->buffer);
6101 set_marker_restricted (w->pointm, make_number (0),w->buffer);
6102 w->start_at_line_beg = Qt;
6104 else
6105 /* Keeping window's old buffer; make sure the markers
6106 are real. */
6108 /* Set window markers at start of visible range. */
6109 if (XMARKER (w->start)->buffer == 0)
6110 set_marker_restricted (w->start, make_number (0),
6111 w->buffer);
6112 if (XMARKER (w->pointm)->buffer == 0)
6113 set_marker_restricted_both (w->pointm, w->buffer,
6114 BUF_PT (XBUFFER (w->buffer)),
6115 BUF_PT_BYTE (XBUFFER (w->buffer)));
6116 w->start_at_line_beg = Qt;
6121 FRAME_ROOT_WINDOW (f) = data->root_window;
6123 /* Arrange *not* to restore point in the buffer that was
6124 current when the window configuration was saved. */
6125 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
6126 set_marker_restricted (XWINDOW (data->current_window)->pointm,
6127 make_number (old_point),
6128 XWINDOW (data->current_window)->buffer);
6130 /* In the following call to `select-window, prevent "swapping
6131 out point" in the old selected window using the buffer that
6132 has been restored into it. We already swapped out that point
6133 from that window's old buffer. */
6134 select_window (data->current_window, Qnil, 1);
6135 BVAR (XBUFFER (XWINDOW (selected_window)->buffer), last_selected_window)
6136 = selected_window;
6138 if (NILP (data->focus_frame)
6139 || (FRAMEP (data->focus_frame)
6140 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
6141 Fredirect_frame_focus (frame, data->focus_frame);
6143 /* Set the screen height to the value it had before this function. */
6144 if (previous_frame_lines != FRAME_LINES (f)
6145 || previous_frame_cols != FRAME_COLS (f))
6146 change_frame_size (f, previous_frame_lines, previous_frame_cols,
6147 0, 0, 0);
6148 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
6149 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
6150 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
6151 make_number (0));
6152 #ifdef HAVE_WINDOW_SYSTEM
6153 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
6154 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
6155 make_number (0));
6156 #endif
6157 #endif
6159 /* Now, free glyph matrices in windows that were not reused. */
6160 for (i = n = 0; i < n_leaf_windows; ++i)
6162 if (NILP (leaf_windows[i]->buffer))
6164 /* Assert it's not reused as a combination. */
6165 xassert (NILP (leaf_windows[i]->hchild)
6166 && NILP (leaf_windows[i]->vchild));
6167 free_window_matrices (leaf_windows[i]);
6169 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
6170 ++n;
6173 adjust_glyphs (f);
6175 UNBLOCK_INPUT;
6177 /* Fselect_window will have made f the selected frame, so we
6178 reselect the proper frame here. Fhandle_switch_frame will change the
6179 selected window too, but that doesn't make the call to
6180 Fselect_window above totally superfluous; it still sets f's
6181 selected window. */
6182 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
6183 do_switch_frame (data->selected_frame, 0, 0, Qnil);
6185 run_window_configuration_change_hook (f);
6188 if (!NILP (new_current_buffer))
6189 Fset_buffer (new_current_buffer);
6191 Vminibuf_scroll_window = data->minibuf_scroll_window;
6192 minibuf_selected_window = data->minibuf_selected_window;
6194 return (FRAME_LIVE_P (f) ? Qt : Qnil);
6197 /* Mark all windows now on frame as deleted
6198 by setting their buffers to nil. */
6200 void
6201 delete_all_subwindows (register struct window *w)
6203 if (!NILP (w->next))
6204 delete_all_subwindows (XWINDOW (w->next));
6205 if (!NILP (w->vchild))
6206 delete_all_subwindows (XWINDOW (w->vchild));
6207 if (!NILP (w->hchild))
6208 delete_all_subwindows (XWINDOW (w->hchild));
6210 w->total_lines = w->buffer; /* See Fset_window_configuration for excuse. */
6212 if (!NILP (w->buffer))
6213 unshow_buffer (w);
6215 /* We set all three of these fields to nil, to make sure that we can
6216 distinguish this dead window from any live window. Live leaf
6217 windows will have buffer set, and combination windows will have
6218 vchild or hchild set. */
6219 w->buffer = Qnil;
6220 w->vchild = Qnil;
6221 w->hchild = Qnil;
6223 Vwindow_list = Qnil;
6226 static int
6227 count_windows (register struct window *window)
6229 register int count = 1;
6230 if (!NILP (window->next))
6231 count += count_windows (XWINDOW (window->next));
6232 if (!NILP (window->vchild))
6233 count += count_windows (XWINDOW (window->vchild));
6234 if (!NILP (window->hchild))
6235 count += count_windows (XWINDOW (window->hchild));
6236 return count;
6240 /* Fill vector FLAT with leaf windows under W, starting at index I.
6241 Value is last index + 1. */
6243 static int
6244 get_leaf_windows (struct window *w, struct window **flat, int i)
6246 while (w)
6248 if (!NILP (w->hchild))
6249 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
6250 else if (!NILP (w->vchild))
6251 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
6252 else
6253 flat[i++] = w;
6255 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6258 return i;
6262 /* Return a pointer to the glyph W's physical cursor is on. Value is
6263 null if W's current matrix is invalid, so that no meaningfull glyph
6264 can be returned. */
6266 struct glyph *
6267 get_phys_cursor_glyph (struct window *w)
6269 struct glyph_row *row;
6270 struct glyph *glyph;
6272 if (w->phys_cursor.vpos >= 0
6273 && w->phys_cursor.vpos < w->current_matrix->nrows
6274 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
6275 row->enabled_p)
6276 && row->used[TEXT_AREA] > w->phys_cursor.hpos)
6277 glyph = row->glyphs[TEXT_AREA] + w->phys_cursor.hpos;
6278 else
6279 glyph = NULL;
6281 return glyph;
6285 static int
6286 save_window_save (Lisp_Object window, struct Lisp_Vector *vector, int i)
6288 register struct saved_window *p;
6289 register struct window *w;
6290 register Lisp_Object tem;
6292 for (;!NILP (window); window = w->next)
6294 p = SAVED_WINDOW_N (vector, i);
6295 w = XWINDOW (window);
6297 XSETFASTINT (w->temslot, i); i++;
6298 p->window = window;
6299 p->buffer = w->buffer;
6300 p->left_col = w->left_col;
6301 p->top_line = w->top_line;
6302 p->total_cols = w->total_cols;
6303 p->total_lines = w->total_lines;
6304 p->hscroll = w->hscroll;
6305 p->min_hscroll = w->min_hscroll;
6306 p->display_table = w->display_table;
6307 p->orig_top_line = w->orig_top_line;
6308 p->orig_total_lines = w->orig_total_lines;
6309 p->left_margin_cols = w->left_margin_cols;
6310 p->right_margin_cols = w->right_margin_cols;
6311 p->left_fringe_width = w->left_fringe_width;
6312 p->right_fringe_width = w->right_fringe_width;
6313 p->fringes_outside_margins = w->fringes_outside_margins;
6314 p->scroll_bar_width = w->scroll_bar_width;
6315 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
6316 p->dedicated = w->dedicated;
6317 p->resize_proportionally = w->resize_proportionally;
6318 if (!NILP (w->buffer))
6320 /* Save w's value of point in the window configuration.
6321 If w is the selected window, then get the value of point
6322 from the buffer; pointm is garbage in the selected window. */
6323 if (EQ (window, selected_window))
6325 p->pointm = Fmake_marker ();
6326 set_marker_both (p->pointm, w->buffer,
6327 BUF_PT (XBUFFER (w->buffer)),
6328 BUF_PT_BYTE (XBUFFER (w->buffer)));
6330 else
6331 p->pointm = Fcopy_marker (w->pointm, Qnil);
6333 p->start = Fcopy_marker (w->start, Qnil);
6334 p->start_at_line_beg = w->start_at_line_beg;
6336 tem = BVAR (XBUFFER (w->buffer), mark);
6337 p->mark = Fcopy_marker (tem, Qnil);
6339 else
6341 p->pointm = Qnil;
6342 p->start = Qnil;
6343 p->mark = Qnil;
6344 p->start_at_line_beg = Qnil;
6347 if (NILP (w->parent))
6348 p->parent = Qnil;
6349 else
6350 p->parent = XWINDOW (w->parent)->temslot;
6352 if (NILP (w->prev))
6353 p->prev = Qnil;
6354 else
6355 p->prev = XWINDOW (w->prev)->temslot;
6357 if (!NILP (w->vchild))
6358 i = save_window_save (w->vchild, vector, i);
6359 if (!NILP (w->hchild))
6360 i = save_window_save (w->hchild, vector, i);
6363 return i;
6366 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
6367 Scurrent_window_configuration, 0, 1, 0,
6368 doc: /* Return an object representing the current window configuration of FRAME.
6369 If FRAME is nil or omitted, use the selected frame.
6370 This describes the number of windows, their sizes and current buffers,
6371 and for each displayed buffer, where display starts, and the positions of
6372 point and mark. An exception is made for point in the current buffer:
6373 its value is -not- saved.
6374 This also records the currently selected frame, and FRAME's focus
6375 redirection (see `redirect-frame-focus'). */)
6376 (Lisp_Object frame)
6378 register Lisp_Object tem;
6379 register int n_windows;
6380 register struct save_window_data *data;
6381 register int i;
6382 FRAME_PTR f;
6384 if (NILP (frame))
6385 frame = selected_frame;
6386 CHECK_LIVE_FRAME (frame);
6387 f = XFRAME (frame);
6389 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6390 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
6391 PVEC_WINDOW_CONFIGURATION);
6393 data->frame_cols = FRAME_COLS (f);
6394 data->frame_lines = FRAME_LINES (f);
6395 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6396 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6397 data->selected_frame = selected_frame;
6398 data->current_window = FRAME_SELECTED_WINDOW (f);
6399 XSETBUFFER (data->current_buffer, current_buffer);
6400 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
6401 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
6402 data->root_window = FRAME_ROOT_WINDOW (f);
6403 data->focus_frame = FRAME_FOCUS_FRAME (f);
6404 tem = Fmake_vector (make_number (n_windows), Qnil);
6405 data->saved_windows = tem;
6406 for (i = 0; i < n_windows; i++)
6407 XVECTOR (tem)->contents[i]
6408 = Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil);
6409 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
6410 XSETWINDOW_CONFIGURATION (tem, data);
6411 return (tem);
6415 /***********************************************************************
6416 Window Split Tree
6417 ***********************************************************************/
6419 static Lisp_Object
6420 window_tree (struct window *w)
6422 Lisp_Object tail = Qnil;
6423 Lisp_Object result = Qnil;
6425 while (w)
6427 Lisp_Object wn;
6429 XSETWINDOW (wn, w);
6430 if (!NILP (w->hchild))
6431 wn = Fcons (Qnil, Fcons (Fwindow_edges (wn),
6432 window_tree (XWINDOW (w->hchild))));
6433 else if (!NILP (w->vchild))
6434 wn = Fcons (Qt, Fcons (Fwindow_edges (wn),
6435 window_tree (XWINDOW (w->vchild))));
6437 if (NILP (result))
6439 result = tail = Fcons (wn, Qnil);
6441 else
6443 XSETCDR (tail, Fcons (wn, Qnil));
6444 tail = XCDR (tail);
6447 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6450 return result;
6455 DEFUN ("window-tree", Fwindow_tree, Swindow_tree,
6456 0, 1, 0,
6457 doc: /* Return the window tree for frame FRAME.
6459 The return value is a list of the form (ROOT MINI), where ROOT
6460 represents the window tree of the frame's root window, and MINI
6461 is the frame's minibuffer window.
6463 If the root window is not split, ROOT is the root window itself.
6464 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil for a
6465 horizontal split, and t for a vertical split, EDGES gives the combined
6466 size and position of the subwindows in the split, and the rest of the
6467 elements are the subwindows in the split. Each of the subwindows may
6468 again be a window or a list representing a window split, and so on.
6469 EDGES is a list \(LEFT TOP RIGHT BOTTOM) as returned by `window-edges'.
6471 If FRAME is nil or omitted, return information on the currently
6472 selected frame. */)
6473 (Lisp_Object frame)
6475 FRAME_PTR f;
6477 if (NILP (frame))
6478 frame = selected_frame;
6480 CHECK_FRAME (frame);
6481 f = XFRAME (frame);
6483 if (!FRAME_LIVE_P (f))
6484 return Qnil;
6486 return window_tree (XWINDOW (FRAME_ROOT_WINDOW (f)));
6490 /***********************************************************************
6491 Marginal Areas
6492 ***********************************************************************/
6494 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
6495 2, 3, 0,
6496 doc: /* Set width of marginal areas of window WINDOW.
6497 If WINDOW is nil, set margins of the currently selected window.
6498 Second arg LEFT-WIDTH specifies the number of character cells to
6499 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6500 does the same for the right marginal area. A nil width parameter
6501 means no margin. */)
6502 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width)
6504 struct window *w = decode_window (window);
6506 /* Translate negative or zero widths to nil.
6507 Margins that are too wide have to be checked elsewhere. */
6509 if (!NILP (left_width))
6511 CHECK_NUMBER (left_width);
6512 if (XINT (left_width) <= 0)
6513 left_width = Qnil;
6516 if (!NILP (right_width))
6518 CHECK_NUMBER (right_width);
6519 if (XINT (right_width) <= 0)
6520 right_width = Qnil;
6523 if (!EQ (w->left_margin_cols, left_width)
6524 || !EQ (w->right_margin_cols, right_width))
6526 w->left_margin_cols = left_width;
6527 w->right_margin_cols = right_width;
6529 adjust_window_margins (w);
6531 ++windows_or_buffers_changed;
6532 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6535 return Qnil;
6539 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
6540 0, 1, 0,
6541 doc: /* Get width of marginal areas of window WINDOW.
6542 If WINDOW is omitted or nil, use the currently selected window.
6543 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6544 If a marginal area does not exist, its width will be returned
6545 as nil. */)
6546 (Lisp_Object window)
6548 struct window *w = decode_window (window);
6549 return Fcons (w->left_margin_cols, w->right_margin_cols);
6554 /***********************************************************************
6555 Fringes
6556 ***********************************************************************/
6558 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6559 2, 4, 0,
6560 doc: /* Set the fringe widths of window WINDOW.
6561 If WINDOW is nil, set the fringe widths of the currently selected
6562 window.
6563 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6564 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6565 fringe width. If a fringe width arg is nil, that means to use the
6566 frame's default fringe width. Default fringe widths can be set with
6567 the command `set-fringe-style'.
6568 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6569 outside of the display margins. By default, fringes are drawn between
6570 display marginal areas and the text area. */)
6571 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width, Lisp_Object outside_margins)
6573 struct window *w = decode_window (window);
6575 if (!NILP (left_width))
6576 CHECK_NATNUM (left_width);
6577 if (!NILP (right_width))
6578 CHECK_NATNUM (right_width);
6580 /* Do nothing on a tty. */
6581 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6582 && (!EQ (w->left_fringe_width, left_width)
6583 || !EQ (w->right_fringe_width, right_width)
6584 || !EQ (w->fringes_outside_margins, outside_margins)))
6586 w->left_fringe_width = left_width;
6587 w->right_fringe_width = right_width;
6588 w->fringes_outside_margins = outside_margins;
6590 adjust_window_margins (w);
6592 clear_glyph_matrix (w->current_matrix);
6593 w->window_end_valid = Qnil;
6595 ++windows_or_buffers_changed;
6596 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6599 return Qnil;
6603 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6604 0, 1, 0,
6605 doc: /* Get width of fringes of window WINDOW.
6606 If WINDOW is omitted or nil, use the currently selected window.
6607 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6608 (Lisp_Object window)
6610 struct window *w = decode_window (window);
6612 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6613 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6614 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6615 ? Qt : Qnil), Qnil)));
6620 /***********************************************************************
6621 Scroll bars
6622 ***********************************************************************/
6624 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars,
6625 Sset_window_scroll_bars, 2, 4, 0,
6626 doc: /* Set width and type of scroll bars of window WINDOW.
6627 If window is nil, set scroll bars of the currently selected window.
6628 Second parameter WIDTH specifies the pixel width for the scroll bar;
6629 this is automatically adjusted to a multiple of the frame column width.
6630 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6631 bar: left, right, or nil.
6632 If WIDTH is nil, use the frame's scroll-bar width.
6633 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6634 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6635 (Lisp_Object window, Lisp_Object width, Lisp_Object vertical_type, Lisp_Object horizontal_type)
6637 struct window *w = decode_window (window);
6639 if (!NILP (width))
6641 CHECK_NATNUM (width);
6643 if (XINT (width) == 0)
6644 vertical_type = Qnil;
6647 if (!(NILP (vertical_type)
6648 || EQ (vertical_type, Qleft)
6649 || EQ (vertical_type, Qright)
6650 || EQ (vertical_type, Qt)))
6651 error ("Invalid type of vertical scroll bar");
6653 if (!EQ (w->scroll_bar_width, width)
6654 || !EQ (w->vertical_scroll_bar_type, vertical_type))
6656 w->scroll_bar_width = width;
6657 w->vertical_scroll_bar_type = vertical_type;
6659 adjust_window_margins (w);
6661 clear_glyph_matrix (w->current_matrix);
6662 w->window_end_valid = Qnil;
6664 ++windows_or_buffers_changed;
6665 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6668 return Qnil;
6672 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
6673 0, 1, 0,
6674 doc: /* Get width and type of scroll bars of window WINDOW.
6675 If WINDOW is omitted or nil, use the currently selected window.
6676 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6677 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6678 value. */)
6679 (Lisp_Object window)
6681 struct window *w = decode_window (window);
6682 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6683 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6684 : WINDOW_SCROLL_BAR_AREA_WIDTH (w))),
6685 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w)),
6686 Fcons (w->vertical_scroll_bar_type,
6687 Fcons (Qnil, Qnil))));
6692 /***********************************************************************
6693 Smooth scrolling
6694 ***********************************************************************/
6696 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
6697 doc: /* Return the amount by which WINDOW is scrolled vertically.
6698 Use the selected window if WINDOW is nil or omitted.
6699 Normally, value is a multiple of the canonical character height of WINDOW;
6700 optional second arg PIXELS-P means value is measured in pixels. */)
6701 (Lisp_Object window, Lisp_Object pixels_p)
6703 Lisp_Object result;
6704 struct frame *f;
6705 struct window *w;
6707 if (NILP (window))
6708 window = selected_window;
6709 else
6710 CHECK_WINDOW (window);
6711 w = XWINDOW (window);
6712 f = XFRAME (w->frame);
6714 if (FRAME_WINDOW_P (f))
6715 result = (NILP (pixels_p)
6716 ? FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll)
6717 : make_number (-w->vscroll));
6718 else
6719 result = make_number (0);
6720 return result;
6724 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
6725 2, 3, 0,
6726 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
6727 WINDOW nil means use the selected window. Normally, VSCROLL is a
6728 non-negative multiple of the canonical character height of WINDOW;
6729 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
6730 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
6731 corresponds to an integral number of pixels. The return value is the
6732 result of this rounding.
6733 If PIXELS-P is non-nil, the return value is VSCROLL. */)
6734 (Lisp_Object window, Lisp_Object vscroll, Lisp_Object pixels_p)
6736 struct window *w;
6737 struct frame *f;
6739 if (NILP (window))
6740 window = selected_window;
6741 else
6742 CHECK_WINDOW (window);
6743 CHECK_NUMBER_OR_FLOAT (vscroll);
6745 w = XWINDOW (window);
6746 f = XFRAME (w->frame);
6748 if (FRAME_WINDOW_P (f))
6750 int old_dy = w->vscroll;
6752 w->vscroll = - (NILP (pixels_p)
6753 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
6754 : XFLOATINT (vscroll));
6755 w->vscroll = min (w->vscroll, 0);
6757 if (w->vscroll != old_dy)
6759 /* Adjust glyph matrix of the frame if the virtual display
6760 area becomes larger than before. */
6761 if (w->vscroll < 0 && w->vscroll < old_dy)
6762 adjust_glyphs (f);
6764 /* Prevent redisplay shortcuts. */
6765 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
6769 return Fwindow_vscroll (window, pixels_p);
6773 /* Call FN for all leaf windows on frame F. FN is called with the
6774 first argument being a pointer to the leaf window, and with
6775 additional argument USER_DATA. Stops when FN returns 0. */
6777 static void
6778 foreach_window (struct frame *f, int (*fn) (struct window *, void *),
6779 void *user_data)
6781 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6782 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
6783 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
6787 /* Helper function for foreach_window. Call FN for all leaf windows
6788 reachable from W. FN is called with the first argument being a
6789 pointer to the leaf window, and with additional argument USER_DATA.
6790 Stop when FN returns 0. Value is 0 if stopped by FN. */
6792 static int
6793 foreach_window_1 (struct window *w, int (*fn) (struct window *, void *), void *user_data)
6795 int cont;
6797 for (cont = 1; w && cont;)
6799 if (!NILP (w->hchild))
6800 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
6801 else if (!NILP (w->vchild))
6802 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
6803 else
6804 cont = fn (w, user_data);
6806 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6809 return cont;
6813 /* Freeze or unfreeze the window start of W unless it is a
6814 mini-window or the selected window. FREEZE_P non-null means freeze
6815 the window start. */
6817 static int
6818 freeze_window_start (struct window *w, void *freeze_p)
6820 if (MINI_WINDOW_P (w)
6821 || (WINDOWP (selected_window) /* Can be nil in corner cases. */
6822 && (w == XWINDOW (selected_window)
6823 || (MINI_WINDOW_P (XWINDOW (selected_window))
6824 && ! NILP (Vminibuf_scroll_window)
6825 && w == XWINDOW (Vminibuf_scroll_window)))))
6826 freeze_p = NULL;
6828 w->frozen_window_start_p = freeze_p != NULL;
6829 return 1;
6833 /* Freeze or unfreeze the window starts of all leaf windows on frame
6834 F, except the selected window and a mini-window. FREEZE_P non-zero
6835 means freeze the window start. */
6837 void
6838 freeze_window_starts (struct frame *f, int freeze_p)
6840 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
6844 /***********************************************************************
6845 Initialization
6846 ***********************************************************************/
6848 /* Return 1 if window configurations C1 and C2
6849 describe the same state of affairs. This is used by Fequal. */
6852 compare_window_configurations (Lisp_Object c1, Lisp_Object c2, int ignore_positions)
6854 register struct save_window_data *d1, *d2;
6855 struct Lisp_Vector *sw1, *sw2;
6856 int i;
6858 CHECK_WINDOW_CONFIGURATION (c1);
6859 CHECK_WINDOW_CONFIGURATION (c2);
6861 d1 = (struct save_window_data *) XVECTOR (c1);
6862 d2 = (struct save_window_data *) XVECTOR (c2);
6863 sw1 = XVECTOR (d1->saved_windows);
6864 sw2 = XVECTOR (d2->saved_windows);
6866 if (d1->frame_cols != d2->frame_cols)
6867 return 0;
6868 if (d1->frame_lines != d2->frame_lines)
6869 return 0;
6870 if (d1->frame_menu_bar_lines != d2->frame_menu_bar_lines)
6871 return 0;
6872 if (! EQ (d1->selected_frame, d2->selected_frame))
6873 return 0;
6874 /* Don't compare the current_window field directly.
6875 Instead see w1_is_current and w2_is_current, below. */
6876 if (! EQ (d1->current_buffer, d2->current_buffer))
6877 return 0;
6878 if (! ignore_positions)
6880 if (! EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window))
6881 return 0;
6882 if (! EQ (d1->minibuf_selected_window, d2->minibuf_selected_window))
6883 return 0;
6885 /* Don't compare the root_window field.
6886 We don't require the two configurations
6887 to use the same window object,
6888 and the two root windows must be equivalent
6889 if everything else compares equal. */
6890 if (! EQ (d1->focus_frame, d2->focus_frame))
6891 return 0;
6893 /* Verify that the two confis have the same number of windows. */
6894 if (sw1->header.size != sw2->header.size)
6895 return 0;
6897 for (i = 0; i < sw1->header.size; i++)
6899 struct saved_window *p1, *p2;
6900 int w1_is_current, w2_is_current;
6902 p1 = SAVED_WINDOW_N (sw1, i);
6903 p2 = SAVED_WINDOW_N (sw2, i);
6905 /* Verify that the current windows in the two
6906 configurations correspond to each other. */
6907 w1_is_current = EQ (d1->current_window, p1->window);
6908 w2_is_current = EQ (d2->current_window, p2->window);
6910 if (w1_is_current != w2_is_current)
6911 return 0;
6913 /* Verify that the corresponding windows do match. */
6914 if (! EQ (p1->buffer, p2->buffer))
6915 return 0;
6916 if (! EQ (p1->left_col, p2->left_col))
6917 return 0;
6918 if (! EQ (p1->top_line, p2->top_line))
6919 return 0;
6920 if (! EQ (p1->total_cols, p2->total_cols))
6921 return 0;
6922 if (! EQ (p1->total_lines, p2->total_lines))
6923 return 0;
6924 if (! EQ (p1->display_table, p2->display_table))
6925 return 0;
6926 if (! EQ (p1->parent, p2->parent))
6927 return 0;
6928 if (! EQ (p1->prev, p2->prev))
6929 return 0;
6930 if (! ignore_positions)
6932 if (! EQ (p1->hscroll, p2->hscroll))
6933 return 0;
6934 if (!EQ (p1->min_hscroll, p2->min_hscroll))
6935 return 0;
6936 if (! EQ (p1->start_at_line_beg, p2->start_at_line_beg))
6937 return 0;
6938 if (NILP (Fequal (p1->start, p2->start)))
6939 return 0;
6940 if (NILP (Fequal (p1->pointm, p2->pointm)))
6941 return 0;
6942 if (NILP (Fequal (p1->mark, p2->mark)))
6943 return 0;
6945 if (! EQ (p1->left_margin_cols, p2->left_margin_cols))
6946 return 0;
6947 if (! EQ (p1->right_margin_cols, p2->right_margin_cols))
6948 return 0;
6949 if (! EQ (p1->left_fringe_width, p2->left_fringe_width))
6950 return 0;
6951 if (! EQ (p1->right_fringe_width, p2->right_fringe_width))
6952 return 0;
6953 if (! EQ (p1->fringes_outside_margins, p2->fringes_outside_margins))
6954 return 0;
6955 if (! EQ (p1->scroll_bar_width, p2->scroll_bar_width))
6956 return 0;
6957 if (! EQ (p1->vertical_scroll_bar_type, p2->vertical_scroll_bar_type))
6958 return 0;
6961 return 1;
6964 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
6965 Scompare_window_configurations, 2, 2, 0,
6966 doc: /* Compare two window configurations as regards the structure of windows.
6967 This function ignores details such as the values of point and mark
6968 and scrolling positions. */)
6969 (Lisp_Object x, Lisp_Object y)
6971 if (compare_window_configurations (x, y, 1))
6972 return Qt;
6973 return Qnil;
6976 void
6977 init_window_once (void)
6979 struct frame *f = make_initial_frame ();
6980 XSETFRAME (selected_frame, f);
6981 Vterminal_frame = selected_frame;
6982 minibuf_window = f->minibuffer_window;
6983 selected_window = f->selected_window;
6984 last_nonminibuf_frame = f;
6986 window_initialized = 1;
6989 void
6990 init_window (void)
6992 Vwindow_list = Qnil;
6995 void
6996 syms_of_window (void)
6998 Qscroll_up = intern_c_string ("scroll-up");
6999 staticpro (&Qscroll_up);
7001 Qscroll_down = intern_c_string ("scroll-down");
7002 staticpro (&Qscroll_down);
7004 Qscroll_command = intern_c_string ("scroll-command");
7005 staticpro (&Qscroll_command);
7007 Fput (Qscroll_up, Qscroll_command, Qt);
7008 Fput (Qscroll_down, Qscroll_command, Qt);
7010 Qwindow_size_fixed = intern_c_string ("window-size-fixed");
7011 staticpro (&Qwindow_size_fixed);
7012 Fset (Qwindow_size_fixed, Qnil);
7014 staticpro (&Qwindow_configuration_change_hook);
7015 Qwindow_configuration_change_hook
7016 = intern_c_string ("window-configuration-change-hook");
7018 Qwindowp = intern_c_string ("windowp");
7019 staticpro (&Qwindowp);
7021 Qwindow_configuration_p = intern_c_string ("window-configuration-p");
7022 staticpro (&Qwindow_configuration_p);
7024 Qwindow_live_p = intern_c_string ("window-live-p");
7025 staticpro (&Qwindow_live_p);
7027 Qdisplay_buffer = intern_c_string ("display-buffer");
7028 staticpro (&Qdisplay_buffer);
7030 Qtemp_buffer_show_hook = intern_c_string ("temp-buffer-show-hook");
7031 staticpro (&Qtemp_buffer_show_hook);
7033 staticpro (&Vwindow_list);
7035 minibuf_selected_window = Qnil;
7036 staticpro (&minibuf_selected_window);
7038 window_scroll_pixel_based_preserve_x = -1;
7039 window_scroll_pixel_based_preserve_y = -1;
7040 window_scroll_preserve_hpos = -1;
7041 window_scroll_preserve_vpos = -1;
7043 DEFVAR_LISP ("temp-buffer-show-function", Vtemp_buffer_show_function,
7044 doc: /* Non-nil means call as function to display a help buffer.
7045 The function is called with one argument, the buffer to be displayed.
7046 Used by `with-output-to-temp-buffer'.
7047 If this function is used, then it must do the entire job of showing
7048 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
7049 Vtemp_buffer_show_function = Qnil;
7051 DEFVAR_LISP ("minibuffer-scroll-window", Vminibuf_scroll_window,
7052 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
7053 Vminibuf_scroll_window = Qnil;
7055 DEFVAR_BOOL ("mode-line-in-non-selected-windows", mode_line_in_non_selected_windows,
7056 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
7057 If the minibuffer is active, the `minibuffer-scroll-window' mode line
7058 is displayed in the `mode-line' face. */);
7059 mode_line_in_non_selected_windows = 1;
7061 DEFVAR_LISP ("other-window-scroll-buffer", Vother_window_scroll_buffer,
7062 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
7063 Vother_window_scroll_buffer = Qnil;
7065 DEFVAR_BOOL ("auto-window-vscroll", auto_window_vscroll_p,
7066 doc: /* *Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
7067 auto_window_vscroll_p = 1;
7069 DEFVAR_INT ("next-screen-context-lines", next_screen_context_lines,
7070 doc: /* *Number of lines of continuity when scrolling by screenfuls. */);
7071 next_screen_context_lines = 2;
7073 DEFVAR_INT ("window-min-height", window_min_height,
7074 doc: /* Allow deleting windows less than this tall.
7075 The value is measured in line units. If a window wants a modeline it
7076 is counted as one line.
7078 Emacs honors settings of this variable when enlarging or shrinking
7079 windows vertically. A value less than 1 is invalid. */);
7080 window_min_height = 4;
7082 DEFVAR_INT ("window-min-width", window_min_width,
7083 doc: /* Allow deleting windows less than this wide.
7084 The value is measured in characters and includes any fringes or
7085 the scrollbar.
7087 Emacs honors settings of this variable when enlarging or shrinking
7088 windows horizontally. A value less than 2 is invalid. */);
7089 window_min_width = 10;
7091 DEFVAR_LISP ("scroll-preserve-screen-position",
7092 Vscroll_preserve_screen_position,
7093 doc: /* *Controls if scroll commands move point to keep its screen position unchanged.
7094 A value of nil means point does not keep its screen position except
7095 at the scroll margin or window boundary respectively.
7096 A value of t means point keeps its screen position if the scroll
7097 command moved it vertically out of the window, e.g. when scrolling
7098 by full screens.
7099 Any other value means point always keeps its screen position.
7100 Scroll commands should have the `scroll-command' property
7101 on their symbols to be controlled by this variable. */);
7102 Vscroll_preserve_screen_position = Qnil;
7104 DEFVAR_LISP ("window-point-insertion-type", Vwindow_point_insertion_type,
7105 doc: /* Type of marker to use for `window-point'. */);
7106 Vwindow_point_insertion_type = Qnil;
7108 DEFVAR_LISP ("window-configuration-change-hook",
7109 Vwindow_configuration_change_hook,
7110 doc: /* Functions to call when window configuration changes.
7111 The buffer-local part is run once per window, with the relevant window
7112 selected; while the global part is run only once for the modified frame,
7113 with the relevant frame selected. */);
7114 Vwindow_configuration_change_hook = Qnil;
7116 DEFVAR_LISP ("recenter-redisplay", Vrecenter_redisplay,
7117 doc: /* If non-nil, then the `recenter' command with a nil argument
7118 will redraw the entire frame; the special value `tty' causes the
7119 frame to be redrawn only if it is a tty frame. */);
7120 Vrecenter_redisplay = Qtty;
7123 defsubr (&Sselected_window);
7124 defsubr (&Sminibuffer_window);
7125 defsubr (&Swindow_minibuffer_p);
7126 defsubr (&Swindowp);
7127 defsubr (&Swindow_live_p);
7128 defsubr (&Spos_visible_in_window_p);
7129 defsubr (&Swindow_line_height);
7130 defsubr (&Swindow_buffer);
7131 defsubr (&Swindow_height);
7132 defsubr (&Swindow_width);
7133 defsubr (&Swindow_full_width_p);
7134 defsubr (&Swindow_hscroll);
7135 defsubr (&Sset_window_hscroll);
7136 defsubr (&Swindow_redisplay_end_trigger);
7137 defsubr (&Sset_window_redisplay_end_trigger);
7138 defsubr (&Swindow_edges);
7139 defsubr (&Swindow_pixel_edges);
7140 defsubr (&Swindow_absolute_pixel_edges);
7141 defsubr (&Swindow_inside_edges);
7142 defsubr (&Swindow_inside_pixel_edges);
7143 defsubr (&Swindow_inside_absolute_pixel_edges);
7144 defsubr (&Scoordinates_in_window_p);
7145 defsubr (&Swindow_at);
7146 defsubr (&Swindow_point);
7147 defsubr (&Swindow_start);
7148 defsubr (&Swindow_end);
7149 defsubr (&Sset_window_point);
7150 defsubr (&Sset_window_start);
7151 defsubr (&Swindow_dedicated_p);
7152 defsubr (&Sset_window_dedicated_p);
7153 defsubr (&Swindow_display_table);
7154 defsubr (&Sset_window_display_table);
7155 defsubr (&Snext_window);
7156 defsubr (&Sprevious_window);
7157 defsubr (&Sother_window);
7158 defsubr (&Sget_lru_window);
7159 defsubr (&Swindow_use_time);
7160 defsubr (&Sget_largest_window);
7161 defsubr (&Sget_buffer_window);
7162 defsubr (&Sdelete_other_windows);
7163 defsubr (&Sdelete_windows_on);
7164 defsubr (&Sreplace_buffer_in_windows);
7165 defsubr (&Sdelete_window);
7166 defsubr (&Sset_window_buffer);
7167 defsubr (&Sselect_window);
7168 defsubr (&Sforce_window_update);
7169 defsubr (&Stemp_output_buffer_show);
7170 defsubr (&Ssplit_window);
7171 defsubr (&Senlarge_window);
7172 defsubr (&Sshrink_window);
7173 defsubr (&Sadjust_window_trailing_edge);
7174 defsubr (&Sscroll_up);
7175 defsubr (&Sscroll_down);
7176 defsubr (&Sscroll_left);
7177 defsubr (&Sscroll_right);
7178 defsubr (&Sother_window_for_scrolling);
7179 defsubr (&Sscroll_other_window);
7180 defsubr (&Sminibuffer_selected_window);
7181 defsubr (&Srecenter);
7182 defsubr (&Swindow_text_height);
7183 defsubr (&Smove_to_window_line);
7184 defsubr (&Swindow_configuration_p);
7185 defsubr (&Swindow_configuration_frame);
7186 defsubr (&Sset_window_configuration);
7187 defsubr (&Scurrent_window_configuration);
7188 defsubr (&Swindow_tree);
7189 defsubr (&Sset_window_margins);
7190 defsubr (&Swindow_margins);
7191 defsubr (&Sset_window_fringes);
7192 defsubr (&Swindow_fringes);
7193 defsubr (&Sset_window_scroll_bars);
7194 defsubr (&Swindow_scroll_bars);
7195 defsubr (&Swindow_vscroll);
7196 defsubr (&Sset_window_vscroll);
7197 defsubr (&Scompare_window_configurations);
7198 defsubr (&Swindow_list);
7199 defsubr (&Swindow_parameters);
7200 defsubr (&Swindow_parameter);
7201 defsubr (&Sset_window_parameter);
7205 void
7206 keys_of_window (void)
7208 initial_define_key (control_x_map, '1', "delete-other-windows");
7209 initial_define_key (control_x_map, '2', "split-window");
7210 initial_define_key (control_x_map, '0', "delete-window");
7211 initial_define_key (control_x_map, 'o', "other-window");
7212 initial_define_key (control_x_map, '^', "enlarge-window");
7213 initial_define_key (control_x_map, '<', "scroll-left");
7214 initial_define_key (control_x_map, '>', "scroll-right");
7216 initial_define_key (global_map, Ctl ('V'), "scroll-up-command");
7217 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
7218 initial_define_key (meta_map, 'v', "scroll-down-command");